fumadocs-openapi 6.0.0 → 6.0.2

package/dist/build-routes.d.ts

@@ -0,0 +1,15 @@
+import { type Document } from './types';
+import type { NoReference } from './utils/schema';
+import type { OperationItem, WebhookItem } from './server/api-page';
+export declare const methodKeys: readonly ["get", "post", "patch", "delete", "head", "put"];
+type Result = {
+    webhooks: (WebhookItem & {
+        tags?: string[];
+    })[];
+    operations: (OperationItem & {
+        tags?: string[];
+    })[];
+};
+export declare function getAPIPageItems(document: NoReference<Document>): Result;
+export {};
+//# sourceMappingURL=build-routes.d.ts.map

package/dist/build-routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-routes.d.ts","sourceRoot":"","sources":["../src/build-routes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGpE,eAAO,MAAM,UAAU,4DAOb,CAAC;AAEX,KAAK,MAAM,GAAG;IACZ,QAAQ,EAAE,CAAC,WAAW,GAAG;QAAE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,EAAE,CAAC;IAChD,UAAU,EAAE,CAAC,aAAa,GAAG;QAC3B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC,EAAE,CAAC;CACN,CAAC;AAEF,wBAAgB,eAAe,CAAC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,MAAM,CAgCvE"}

package/dist/build-routes.js

@@ -0,0 +1,38 @@
+export const methodKeys = [
+    'get',
+    'post',
+    'patch',
+    'delete',
+    'head',
+    'put',
+];
+export function getAPIPageItems(document) {
+    const result = { webhooks: [], operations: [] };
+    for (const [path, pathItem] of Object.entries(document.paths ?? {})) {
+        if (!pathItem)
+            continue;
+        for (const methodKey of methodKeys) {
+            if (!pathItem[methodKey])
+                continue;
+            result.operations.push({
+                method: methodKey,
+                path,
+                tags: pathItem[methodKey]?.tags,
+            });
+        }
+    }
+    for (const [name, pathItem] of Object.entries(document.webhooks ?? {})) {
+        if (!pathItem)
+            continue;
+        for (const methodKey of methodKeys) {
+            if (!pathItem[methodKey])
+                continue;
+            result.webhooks.push({
+                method: methodKey,
+                name,
+                tags: pathItem[methodKey]?.tags,
+            });
+        }
+    }
+    return result;
+}

package/dist/generate-file.d.ts

@@ -0,0 +1,38 @@
+import { type GenerateOptions } from './generate';
+export interface Config extends GenerateOptions {
+    /**
+     * Schema files
+     */
+    input: string[] | string;
+    /**
+     * Output directory
+     */
+    output: string;
+    /**
+     * tag: Generate a page for each tag
+     * file: Generate a page for each schema
+     * operation: Generate a page for each API endpoint/operation
+     *
+     * @defaultValue 'operation'
+     */
+    per?: 'tag' | 'file' | 'operation';
+    /**
+     * Specify name for output file
+     */
+    name?: (type: 'file' | 'tag', name: string) => string;
+    /**
+     * Group output using folders (Only works on `operation` mode)
+     *
+     * @deprecated Use `groupBy` instead
+     * @defaultValue false
+     */
+    groupByFolder?: boolean;
+    /**
+     * Group output using folders (Only works on `operation` mode)
+     *
+     * @defaultValue 'none'
+     */
+    groupBy?: 'tag' | 'route' | 'none';
+}
+export declare function generateFiles(options: Config): Promise<void>;
+//# sourceMappingURL=generate-file.d.ts.map

package/dist/generate-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-file.d.ts","sourceRoot":"","sources":["../src/generate-file.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,KAAK,eAAe,EAErB,MAAM,YAAY,CAAC;AAGpB,MAAM,WAAW,MAAO,SAAQ,eAAe;IAC7C;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,WAAW,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAEtD;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;CACpC;AAED,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA4HlE"}

package/dist/generate-file.js

@@ -0,0 +1,118 @@
+import { mkdir, writeFile } from 'node:fs/promises';
+import { dirname, join, parse } from 'node:path';
+import fg from 'fast-glob';
+import { generatePages, } from './generate';
+import { generateAll, generateTags } from './generate';
+export async function generateFiles(options) {
+    const { input, output, name: nameFn, per = 'operation', groupBy = 'none', cwd = process.cwd(), } = options;
+    const outputDir = join(cwd, output);
+    const urlInputs = [];
+    const fileInputs = [];
+    for (const v of typeof input === 'string' ? [input] : input) {
+        if (isUrl(v)) {
+            urlInputs.push(v);
+        }
+        else {
+            fileInputs.push(v);
+        }
+    }
+    const resolvedInputs = [
+        ...(await fg.glob(fileInputs, { cwd, absolute: false })),
+        ...urlInputs,
+    ];
+    function getOutputPaths(result) {
+        let file;
+        if (result.pathItem.summary) {
+            file = getFilename(result.pathItem.summary);
+        }
+        else if (result.type === 'operation') {
+            file = result.operation.operationId
+                ? getFilename(result.operation.operationId)
+                : join(getOutputPathFromRoute(result.item.path), result.item.method.toLowerCase());
+        }
+        else {
+            file = getFilename(result.item.name);
+        }
+        const outPaths = [];
+        if (groupBy === 'tag') {
+            const tags = result.operation.tags;
+            if (tags && tags.length > 0) {
+                for (const tag of tags) {
+                    outPaths.push(join(outputDir, getFilename(tag), `${file}.mdx`));
+                }
+            }
+            else {
+                outPaths.push(result.type === 'operation'
+                    ? join(outputDir, `${file}.mdx`)
+                    : join(outputDir, 'webhooks', `${file}.mdx`));
+            }
+        }
+        if (groupBy === 'route' || groupBy === 'none') {
+            outPaths.push(join(outputDir, `${file}.mdx`));
+        }
+        return outPaths;
+    }
+    async function generateFromDocument(pathOrUrl) {
+        if (per === 'file') {
+            let filename = isUrl(pathOrUrl) ? 'index' : parse(pathOrUrl).name;
+            if (nameFn)
+                filename = nameFn('file', filename);
+            const outPath = join(outputDir, `${filename}.mdx`);
+            const result = await generateAll(pathOrUrl, options);
+            await write(outPath, result);
+            console.log(`Generated: ${outPath}`);
+        }
+        if (per === 'operation') {
+            const metaFiles = new Set();
+            const results = await generatePages(pathOrUrl, options);
+            for (const result of results) {
+                const meta = JSON.stringify({
+                    title: result.pathItem.summary,
+                }, null, 2);
+                for (const outPath of getOutputPaths(result)) {
+                    await write(outPath, result.content);
+                    console.log(`Generated: ${outPath}`);
+                    if (groupBy === 'route') {
+                        const metaFile = join(dirname(outPath), 'meta.json');
+                        if (!result.pathItem.summary || metaFiles.has(metaFile))
+                            continue;
+                        metaFiles.add(metaFile);
+                        await write(metaFile, meta);
+                        console.log(`Generated Meta: ${metaFile}`);
+                    }
+                }
+            }
+        }
+        if (per === 'tag') {
+            const results = await generateTags(pathOrUrl, options);
+            for (const result of results) {
+                let tagName = result.tag;
+                tagName = nameFn?.('tag', tagName) ?? getFilename(tagName);
+                const outPath = join(outputDir, `${tagName}.mdx`);
+                await write(outPath, result.content);
+                console.log(`Generated: ${outPath}`);
+            }
+        }
+    }
+    await Promise.all(resolvedInputs.map(generateFromDocument));
+}
+function isUrl(input) {
+    return input.startsWith('https://') || input.startsWith('http://');
+}
+function getOutputPathFromRoute(path) {
+    return (path
+        .replaceAll('.', '/')
+        .split('/')
+        .filter((v) => !v.startsWith('{') && !v.endsWith('}'))
+        .at(-1) ?? '');
+}
+function getFilename(s) {
+    return s
+        .replace(/[A-Z]/g, (match, idx) => idx === 0 ? match : `-${match.toLowerCase()}`)
+        .replace(/\s+/g, '-')
+        .toLowerCase();
+}
+async function write(path, content) {
+    await mkdir(dirname(path), { recursive: true });
+    await writeFile(path, content);
+}

package/dist/generate.d.ts

@@ -0,0 +1,48 @@
+import { type DocumentContext } from './utils/generate-document';
+import type { OperationObject, PathItemObject } from './types';
+import type { NoReference } from './utils/schema';
+import type { OperationItem, WebhookItem } from './server/api-page';
+import { type DocumentInput } from './utils/process-document';
+export interface GenerateOptions {
+    /**
+     * Additional imports of your MDX components.
+     */
+    imports?: {
+        names: string[];
+        from: string;
+    }[];
+    /**
+     * Customise frontmatter.
+     *
+     * A `full: true` property will be added by default.
+     */
+    frontmatter?: (title: string, description: string | undefined, context: DocumentContext) => Record<string, unknown>;
+    /**
+     * Add description to document body
+     *
+     * @defaultValue false
+     */
+    includeDescription?: boolean;
+    cwd?: string;
+}
+export interface GenerateTagOutput {
+    tag: string;
+    content: string;
+}
+export type GeneratePageOutput = {
+    type: 'operation';
+    pathItem: NoReference<PathItemObject>;
+    operation: NoReference<OperationObject>;
+    item: OperationItem;
+    content: string;
+} | {
+    type: 'webhook';
+    pathItem: NoReference<PathItemObject>;
+    operation: NoReference<OperationObject>;
+    item: WebhookItem;
+    content: string;
+};
+export declare function generateAll(pathOrDocument: DocumentInput, options?: GenerateOptions): Promise<string>;
+export declare function generatePages(pathOrDocument: DocumentInput, options?: GenerateOptions): Promise<GeneratePageOutput[]>;
+export declare function generateTags(pathOrDocument: DocumentInput, options?: GenerateOptions): Promise<GenerateTagOutput[]>;
+//# sourceMappingURL=generate.d.ts.map

package/dist/generate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,eAAe,EAErB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAC/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,KAAK,aAAa,EAAmB,MAAM,0BAA0B,CAAC;AAE/E,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAC;IAEJ;;;;OAIG;IACH,WAAW,CAAC,EAAE,CACZ,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,GAAG,SAAS,EAC/B,OAAO,EAAE,eAAe,KACrB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE7B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,kBAAkB,GAC1B;IACE,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;IACtC,SAAS,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC;IAExC,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;IACtC,SAAS,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC;IAExC,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAgBN,wBAAsB,WAAW,CAC/B,cAAc,EAAE,aAAa,EAC7B,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,MAAM,CAAC,CAoBjB;AAED,wBAAsB,aAAa,CACjC,cAAc,EAAE,aAAa,EAC7B,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAiE/B;AAED,wBAAsB,YAAY,CAChC,cAAc,EAAE,aAAa,EAC7B,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAsC9B"}

package/dist/generate.js

@@ -0,0 +1,129 @@
+import { resolve } from 'node:path';
+import { getAPIPageItems } from './build-routes';
+import { generateDocument, } from './utils/generate-document';
+import { idToTitle } from './utils/id-to-title';
+import { processDocument } from './utils/process-document';
+async function dereference(pathOrDocument, options) {
+    return await processDocument(
+    // resolve paths
+    typeof pathOrDocument === 'string' &&
+        !pathOrDocument.startsWith('http://') &&
+        !pathOrDocument.startsWith('https://')
+        ? resolve(options.cwd ?? process.cwd(), pathOrDocument)
+        : pathOrDocument).then((res) => res.document);
+}
+export async function generateAll(pathOrDocument, options = {}) {
+    const document = await dereference(pathOrDocument, options);
+    const items = getAPIPageItems(document);
+    return generateDocument({
+        ...options,
+        dereferenced: document,
+        title: document.info.title,
+        description: document.info.description,
+        page: {
+            operations: items.operations,
+            webhooks: items.webhooks,
+            hasHead: true,
+            document: pathOrDocument,
+        },
+        context: {
+            type: 'file',
+        },
+    });
+}
+export async function generatePages(pathOrDocument, options = {}) {
+    const document = await dereference(pathOrDocument, options);
+    const items = getAPIPageItems(document);
+    const result = [];
+    for (const item of items.operations) {
+        const pathItem = document.paths?.[item.path];
+        if (!pathItem)
+            continue;
+        const operation = pathItem[item.method];
+        if (!operation)
+            continue;
+        result.push({
+            type: 'operation',
+            pathItem,
+            operation,
+            item,
+            content: generateDocument({
+                ...options,
+                page: {
+                    operations: [item],
+                    hasHead: false,
+                    document: pathOrDocument,
+                },
+                dereferenced: document,
+                title: operation.summary ??
+                    pathItem.summary ??
+                    idToTitle(operation.operationId ?? 'unknown'),
+                description: operation.description ?? pathItem.description,
+                context: {
+                    type: 'operation',
+                },
+            }),
+        });
+    }
+    for (const item of items.webhooks) {
+        const pathItem = document.webhooks?.[item.name];
+        if (!pathItem)
+            continue;
+        const operation = pathItem[item.method];
+        if (!operation)
+            continue;
+        result.push({
+            type: 'webhook',
+            pathItem,
+            operation,
+            item,
+            content: generateDocument({
+                ...options,
+                page: {
+                    webhooks: [item],
+                    hasHead: false,
+                    document: pathOrDocument,
+                },
+                dereferenced: document,
+                title: operation.summary ?? pathItem.summary ?? idToTitle(item.name),
+                description: operation.description ?? pathItem.description,
+                context: {
+                    type: 'operation',
+                },
+            }),
+        });
+    }
+    return result;
+}
+export async function generateTags(pathOrDocument, options = {}) {
+    const document = await dereference(pathOrDocument, options);
+    if (!document.tags)
+        return [];
+    const items = getAPIPageItems(document);
+    return document.tags.map((tag) => {
+        const webhooks = items.webhooks.filter((v) => v.tags && v.tags.includes(tag.name));
+        const operations = items.operations.filter((v) => v.tags && v.tags.includes(tag.name));
+        const displayName = tag && 'x-displayName' in tag && typeof tag['x-displayName'] === 'string'
+            ? tag['x-displayName']
+            : idToTitle(tag.name);
+        return {
+            tag: tag.name,
+            content: generateDocument({
+                ...options,
+                page: {
+                    document: pathOrDocument,
+                    operations,
+                    webhooks,
+                    hasHead: true,
+                },
+                dereferenced: document,
+                title: displayName,
+                description: tag?.description,
+                context: {
+                    type: 'tag',
+                    tag,
+                },
+            }),
+        };
+    });
+}

package/dist/index.d.ts

@@ -1,274 +1,4 @@
-import { OpenAPIV3_1, OpenAPIV3 } from 'openapi-types';
-import Slugger from 'github-slugger';
-import { ComponentType, ReactNode } from 'react';
-import { CodeToHastOptionsCommon, CodeOptionsThemes, BuiltinTheme } from 'shiki';
-
-type NoReference<T> = T extends (infer I)[] ? NoReference<I>[] : T extends ReferenceObject ? Exclude<T, ReferenceObject> : T extends object ? {
-    [K in keyof T]: NoReference<T[K]>;
-} : T;
-type ParsedSchema = OpenAPIV3_1.SchemaObject;
-
-interface ResponsesProps {
-    items: string[];
-    children: ReactNode;
-}
-interface ResponseProps {
-    value: string;
-    children: ReactNode;
-}
-interface APIInfoProps {
-    method: string;
-    route: string;
-    head: ReactNode;
-    children: ReactNode;
-}
-interface PropertyProps {
-    name: string;
-    type: string;
-    required?: boolean;
-    deprecated?: boolean;
-    children?: ReactNode;
-}
-interface ObjectCollapsibleProps {
-    name: string;
-    children: ReactNode;
-}
-interface RequestProps {
-    language: string;
-    name: string;
-    code: string;
-}
-interface ResponseTypeProps {
-    lang: string;
-    code: string;
-    label: string;
-}
-interface RootProps {
-    baseUrl?: string;
-    servers: ServerObject[];
-    children: ReactNode;
-}
-interface Renderer {
-    Root: ComponentType<RootProps>;
-    API: ComponentType<{
-        children: ReactNode;
-    }>;
-    APIInfo: ComponentType<APIInfoProps>;
-    APIExample: ComponentType<{
-        children: ReactNode;
-    }>;
-    Responses: ComponentType<ResponsesProps>;
-    Response: ComponentType<ResponseProps>;
-    Requests: ComponentType<{
-        items: string[];
-        children: ReactNode;
-    }>;
-    Request: ComponentType<RequestProps>;
-    ResponseTypes: ComponentType<{
-        children: ReactNode;
-    }>;
-    ResponseType: ComponentType<ResponseTypeProps>;
-    /**
-     * Collapsible to show object schemas
-     */
-    ObjectCollapsible: ComponentType<ObjectCollapsibleProps>;
-    Property: ComponentType<PropertyProps>;
-    APIPlayground: ComponentType<{
-        path: string;
-        method: MethodInformation;
-        ctx: RenderContext;
-    }>;
-}
-
-/**
- * Sample info of endpoint
- */
-interface EndpointSample {
-    /**
-     * Request URL, including path and query parameters
-     */
-    url: string;
-    method: string;
-    body?: {
-        schema: ParsedSchema;
-        mediaType: string;
-        sample: unknown;
-    };
-    responses: Record<string, ResponseSample>;
-    parameters: ParameterSample[];
-}
-interface ResponseSample {
-    mediaType: string;
-    sample: unknown;
-    schema: ParsedSchema;
-}
-interface ParameterSample {
-    name: string;
-    in: string;
-    schema: ParsedSchema;
-    sample: unknown;
-}
-
-interface CodeSample {
-    lang: string;
-    label: string;
-    source: string | ((endpoint: EndpointSample) => string | undefined) | false;
-}
-
-type DocumentInput = string | OpenAPIV3_1.Document | OpenAPIV3.Document;
-type ProcessedDocument = {
-    document: NoReference<Document>;
-    dereferenceMap: DereferenceMap;
-    downloaded: Document;
-};
-
-type Document = OpenAPIV3_1.Document;
-type OperationObject = OpenAPIV3_1.OperationObject;
-type ParameterObject = OpenAPIV3_1.ParameterObject;
-type SecurityRequirementObject = OpenAPIV3_1.SecurityRequirementObject;
-type SecuritySchemeObject = OpenAPIV3_1.SecuritySchemeObject;
-type ReferenceObject = OpenAPIV3_1.ReferenceObject;
-type PathItemObject = OpenAPIV3_1.PathItemObject;
-type TagObject = OpenAPIV3_1.TagObject;
-type ServerObject = NoReference<OpenAPIV3_1.ServerObject>;
-type CallbackObject = NoReference<OpenAPIV3_1.CallbackObject>;
-type MethodInformation = NoReference<OperationObject> & {
-    method: string;
-};
-type Awaitable<T> = T | Promise<T>;
-/**
- * Dereferenced value and its original `$ref` value
- */
-type DereferenceMap = Map<unknown, string>;
-interface RenderContext {
-    /**
-     * The url of proxy to avoid CORS issues
-     */
-    proxyUrl?: string;
-    renderer: Renderer;
-    baseUrl: string;
-    servers: ServerObject[];
-    slugger: Slugger;
-    /**
-     * dereferenced schema
-     */
-    schema: ProcessedDocument;
-    /**
-     * Generate TypeScript definitions from response schema.
-     *
-     * Pass `false` to disable it.
-     *
-     * @param endpoint - the API endpoint
-     * @param code - status code
-     */
-    generateTypeScriptSchema?: ((endpoint: EndpointSample, code: string) => Awaitable<string>) | false;
-    /**
-     * Generate code samples for endpoint.
-     */
-    generateCodeSamples?: (endpoint: EndpointSample) => Awaitable<CodeSample[]>;
-    shikiOptions?: Omit<CodeToHastOptionsCommon, 'lang'> & CodeOptionsThemes<BuiltinTheme>;
-    /**
-     * Show full response schema instead of only example response & Typescript definitions
-     */
-    showResponseSchema?: boolean;
-}
-
-interface WebhookItem {
-    name: string;
-    method: OpenAPIV3_1.HttpMethods;
-}
-interface OperationItem {
-    path: string;
-    method: OpenAPIV3_1.HttpMethods;
-}
-
-type DocumentContext = {
-    type: 'tag';
-    tag: TagObject | undefined;
-} | {
-    type: 'operation';
-} | {
-    type: 'file';
-};
-
-interface GenerateOptions {
-    /**
-     * Additional imports of your MDX components.
-     */
-    imports?: {
-        names: string[];
-        from: string;
-    }[];
-    /**
-     * Customise frontmatter.
-     *
-     * A `full: true` property will be added by default.
-     */
-    frontmatter?: (title: string, description: string | undefined, context: DocumentContext) => Record<string, unknown>;
-    /**
-     * Add description to document body
-     *
-     * @defaultValue false
-     */
-    includeDescription?: boolean;
-    cwd?: string;
-}
-interface GenerateTagOutput {
-    tag: string;
-    content: string;
-}
-type GeneratePageOutput = {
-    type: 'operation';
-    pathItem: NoReference<PathItemObject>;
-    operation: NoReference<OperationObject>;
-    item: OperationItem;
-    content: string;
-} | {
-    type: 'webhook';
-    pathItem: NoReference<PathItemObject>;
-    operation: NoReference<OperationObject>;
-    item: WebhookItem;
-    content: string;
-};
-declare function generateAll(pathOrDocument: DocumentInput, options?: GenerateOptions): Promise<string>;
-declare function generatePages(pathOrDocument: DocumentInput, options?: GenerateOptions): Promise<GeneratePageOutput[]>;
-declare function generateTags(pathOrDocument: DocumentInput, options?: GenerateOptions): Promise<GenerateTagOutput[]>;
-
-interface Config extends GenerateOptions {
-    /**
-     * Schema files
-     */
-    input: string[] | string;
-    /**
-     * Output directory
-     */
-    output: string;
-    /**
-     * tag: Generate a page for each tag
-     * file: Generate a page for each schema
-     * operation: Generate a page for each API endpoint/operation
-     *
-     * @defaultValue 'operation'
-     */
-    per?: 'tag' | 'file' | 'operation';
-    /**
-     * Specify name for output file
-     */
-    name?: (type: 'file' | 'tag', name: string) => string;
-    /**
-     * Group output using folders (Only works on `operation` mode)
-     *
-     * @deprecated Use `groupBy` instead
-     * @defaultValue false
-     */
-    groupByFolder?: boolean;
-    /**
-     * Group output using folders (Only works on `operation` mode)
-     *
-     * @defaultValue 'none'
-     */
-    groupBy?: 'tag' | 'route' | 'none';
-}
-declare function generateFiles(options: Config): Promise<void>;
-
-export { type CallbackObject, type Config, type DereferenceMap, type Document, type GenerateOptions, type GeneratePageOutput, type GenerateTagOutput, type MethodInformation, type OperationObject, type ParameterObject, type PathItemObject, type ReferenceObject, type RenderContext, type SecurityRequirementObject, type SecuritySchemeObject, type ServerObject, type TagObject, generateAll, generateFiles, generatePages, generateTags };
+export * from './generate';
+export * from './generate-file';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC"}