@adonis-agora/agent/dist/src/genui/kit/docs.d.ts

Governed, durable-backed AI agent (chat + tool-calling + governance) for AdonisJS — part of the Agora ecosystem.

import type { SandboxKitComponentDoc } from '../sandbox-kit.js';
import { type SandboxKitFiles, type SandboxKitSourceOptions } from './files.js';
export interface GenerateSandboxKitDocsOptions extends SandboxKitSourceOptions {
    /** The project root. Default `process.cwd()`. */
    root?: string;
    /** The tsconfig the kit compiles under. Default: the nearest to the kit's first file. */
    tsconfig?: string;
    /** Already resolved files (skips `components`). */
    files?: SandboxKitFiles;
    /** Most components documented (a whole package can export hundreds). Default 120. */
    maxComponents?: number;
    /**
     * The TypeScript module to read the types with. Default: the project's own `typescript` — one with
     * the JavaScript compiler API (5.x/6.x; TypeScript 7's native compiler has none).
     */
    typescript?: unknown;
}
/**
 * The docs of every component the kit exports, in declaration order. A component is an export named
 * in PascalCase whose type is callable with one props argument and returns JSX (function components,
 * `forwardRef`, `memo`).
 */
export declare function generateSandboxKitDocs(options?: GenerateSandboxKitDocsOptions): Promise<SandboxKitComponentDoc[]>;
//# sourceMappingURL=docs.d.ts.map