import http from 'node:http'; import type { ILogger } from '../interfaces/logger.interface.js'; /** What `oprimp docs:studio` itself takes. Not `DocsStudioOptions` — that * name belongs to the studio in `@opra/api-ui`, and these are the command's * own concerns: where to load a document from, which port to listen on, * where to write the log. */ export interface DocsStudioCommandOptions { /** Which bundle to edit. Defaults to the document's own `defaultLanguage`. */ lang?: string; port?: number; /** Scope to render, for a document that exposes more than one. */ scope?: string; logger?: ILogger; } /** * Serves `@opra/api-ui`'s documentation studio on loopback. * * The studio itself lives in `api-ui` (`DocsStudio`), which is where the page * it renders already lived. What is here is the part `api-ui` deliberately * does not have: a process, a server, and a document — `DocsStudio` only * answers requests somebody hands it, and inside an application that * somebody is the application. * * Which is the point of the command. An adapter's `enableStudio` needs an * application that runs: its database, its configuration, a write route in * its own router. This needs none of that — a module path and a port — so a * package that is only types has a way to document itself, and a team that * will not ship a write endpoint at all still has a way to write. * * Bound to 127.0.0.1 and started by hand: a command you run in a terminal * cannot be left on by accident. */ export declare function startDocsStudio(moduleRef: string, options: DocsStudioCommandOptions): Promise;