fumadocs-openapi 9.4.1 → 9.5.1

package/dist/generate-file.d.ts

@@ -1,67 +1,23 @@
-import { type GenerateOptions, type GeneratePageOutput, type GenerateTagOutput } from './generate.js';
+import { type PagesToTextOptions } from './utils/pages/to-text.js';
 import { type ProcessedDocument } from './utils/process-document.js';
 import type { OpenAPIServer } from './server/index.js';
-interface GenerateFileOutput {
-    /**
-     * The original schema file path/url from `input`
-     */
-    pathOrUrl: string;
-    content: string;
-}
+import { type SchemaToPagesOptions } from './utils/schema-to-pages.js';
 export interface OutputFile {
     path: string;
     content: string;
 }
-interface OperationConfig extends BaseConfig {
-    /**
-     * Generate a page for each API endpoint/operation (default).
-     */
-    per?: 'operation';
-    /**
-     * Group output using folders (Only works on `operation` mode)
-     * - tag: `{tag}/{file}`
-     * - route: `{endpoint}/{method}` (it will ignore the `name` option)
-     * - none: `{file}` (default)
-     *
-     * @defaultValue 'none'
-     */
-    groupBy?: 'tag' | 'route' | 'none';
-    /**
-     * Specify name for output file
-     */
-    name?: ((output: GeneratePageOutput, document: ProcessedDocument['dereferenced']) => string) | BaseName;
-}
-interface TagConfig extends BaseConfig {
-    /**
-     * Generate a page for each tag.
-     */
-    per: 'tag';
-    /**
-     * Specify name for output file
-     */
-    name?: ((output: GenerateTagOutput, document: ProcessedDocument['dereferenced']) => string) | BaseName;
-}
-interface FileConfig extends BaseConfig {
-    /**
-     * Generate a page for each schema file.
-     */
-    per: 'file';
+interface IndexConfig {
+    items: IndexItem[] | ((ctx: HookContext) => IndexItem[]);
     /**
-     * Specify name for output file
+     * Generate URLs for cards
      */
-    name?: ((output: GenerateFileOutput, document: ProcessedDocument['dereferenced']) => string) | BaseName;
-}
-export type Config = FileConfig | TagConfig | OperationConfig;
-interface BaseName {
-    /**
-     * The version of algorithm used to generate file paths.
-     *
-     * v1: Fumadocs OpenAPI v8
-     * v2: Fumadocs OpenAPI v9
-     *
-     * @defaultValue v2
-     */
-    algorithm?: 'v2' | 'v1';
+    url: ((filePath: string) => string) | {
+        baseUrl: string;
+        /**
+         * Base content directory
+         */
+        contentDir: string;
+    };
 }
 interface IndexItem {
     path: string;
@@ -74,12 +30,8 @@ interface IndexItem {
      */
     only?: (string | OutputFile)[];
 }
-interface HookContext {
-    files: OutputFile[];
-    readonly generated: Record<string, OutputFile[]>;
-    readonly documents: Record<string, ProcessedDocument>;
-}
-interface BaseConfig extends GenerateOptions {
+interface GenerateFilesConfig extends PagesToTextOptions {
+    cwd?: string;
     /**
      * Schema files, or the OpenAPI server object
      */
@@ -88,34 +40,22 @@ interface BaseConfig extends GenerateOptions {
      * Output directory
      */
     output: string;
-    /**
-     * Custom function to convert names into file names.
-     *
-     * By default, it only escapes whitespaces and upper case (English) characters
-     */
-    slugify?: (name: string) => string;
     /**
      * Generate index files with cards linking to generated pages.
      */
-    index?: {
-        items: IndexItem[] | ((ctx: HookContext) => IndexItem[]);
-        /**
-         * Generate URLs for cards
-         */
-        url: ((filePath: string) => string) | {
-            baseUrl: string;
-            /**
-             * Base content directory
-             */
-            contentDir: string;
-        };
-    };
+    index?: IndexConfig;
     /**
      * Can add/change/remove output files before writing to file system
      **/
     beforeWrite?: (this: HookContext, files: OutputFile[]) => void | Promise<void>;
 }
+export type Config = SchemaToPagesOptions & GenerateFilesConfig;
+interface HookContext {
+    files: OutputFile[];
+    readonly generated: Record<string, OutputFile[]>;
+    readonly documents: Record<string, ProcessedDocument>;
+}
 export declare function generateFiles(options: Config): Promise<void>;
-export declare function generateFilesOnly(options: Config): Promise<OutputFile[]>;
+export declare function generateFilesOnly(options: SchemaToPagesOptions & Omit<GenerateFilesConfig, 'output'>): Promise<OutputFile[]>;
 export {};
 //# sourceMappingURL=generate-file.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"generate-file.d.ts","sourceRoot":"","sources":["../src/generate-file.ts"],"names":[],"mappings":"AAGA,OAAO,EAGL,KAAK,eAAe,EACpB,KAAK,kBAAkB,EAEvB,KAAK,iBAAiB,EAEvB,MAAM,YAAY,CAAC;AACpB,OAAO,EAEL,KAAK,iBAAiB,EACvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAI9C,UAAU,kBAAkB;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,eAAgB,SAAQ,UAAU;IAC1C;;OAEG;IACH,GAAG,CAAC,EAAE,WAAW,CAAC;IAElB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EACD,CAAC,CACC,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,iBAAiB,CAAC,cAAc,CAAC,KACxC,MAAM,CAAC,GACZ,QAAQ,CAAC;CACd;AAED,UAAU,SAAU,SAAQ,UAAU;IACpC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EACD,CAAC,CACC,MAAM,EAAE,iBAAiB,EACzB,QAAQ,EAAE,iBAAiB,CAAC,cAAc,CAAC,KACxC,MAAM,CAAC,GACZ,QAAQ,CAAC;CACd;AAED,UAAU,UAAW,SAAQ,UAAU;IACrC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,CAAC,EACD,CAAC,CACC,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,iBAAiB,CAAC,cAAc,CAAC,KACxC,MAAM,CAAC,GACZ,QAAQ,CAAC;CACd;AAED,MAAM,MAAM,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,eAAe,CAAC;AAE9D,UAAU,QAAQ;IAChB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;CACzB;AAED,UAAU,SAAS;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,UAAU,CAAC,EAAE,CAAC;CAChC;AAED,UAAU,WAAW;IACnB,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;IACjD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;CACvD;AAED,UAAU,UAAW,SAAQ,eAAe;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,aAAa,CAAC;IAEzC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAEnC;;OAEG;IACH,KAAK,CAAC,EAAE;QACN,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,WAAW,KAAK,SAAS,EAAE,CAAC,CAAC;QAEzD;;WAEG;QACH,GAAG,EACC,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC,GAC9B;YACE,OAAO,EAAE,MAAM,CAAC;YAChB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB,CAAC;KACP,CAAC;IAEF;;QAEI;IACJ,WAAW,CAAC,EAAE,CACZ,IAAI,EAAE,WAAW,EACjB,KAAK,EAAE,UAAU,EAAE,KAChB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAUlE;AAED,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,UAAU,EAAE,CAAC,CA2DvB"}
+{"version":3,"file":"generate-file.d.ts","sourceRoot":"","sources":["../src/generate-file.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,KAAK,kBAAkB,EAExB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAEL,KAAK,iBAAiB,EACvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAG9C,OAAO,EAGL,KAAK,oBAAoB,EAC1B,MAAM,yBAAyB,CAAC;AAEjC,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,WAAW;IACnB,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,WAAW,KAAK,SAAS,EAAE,CAAC,CAAC;IAEzD;;OAEG;IACH,GAAG,EACC,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC,GAC9B;QACE,OAAO,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;CACP;AAED,UAAU,SAAS;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,UAAU,CAAC,EAAE,CAAC;CAChC;AAED,UAAU,mBAAoB,SAAQ,kBAAkB;IACtD,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,aAAa,CAAC;IAEzC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IAEpB;;QAEI;IACJ,WAAW,CAAC,EAAE,CACZ,IAAI,EAAE,WAAW,EACjB,KAAK,EAAE,UAAU,EAAE,KAChB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED,MAAM,MAAM,MAAM,GAAG,oBAAoB,GAAG,mBAAmB,CAAC;AAEhE,UAAU,WAAW;IACnB,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;IACjD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;CACvD;AAED,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAclE;AAED,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,GAClE,OAAO,CAAC,UAAU,EAAE,CAAC,CAkEvB"}

package/dist/generate-file.js

@@ -1,16 +1,20 @@
 import { mkdir, writeFile } from 'node:fs/promises';
 import * as path from 'node:path';
 import { glob } from 'tinyglobby';
-import { generateAll, generateDocument, generatePages, generateTags, } from './generate.js';
+import { generateDocument, toText, } from './utils/pages/to-text.js';
 import { processDocumentCached, } from './utils/process-document.js';
 import { createGetUrl, getSlugs } from 'fumadocs-core/source';
 import matter from 'gray-matter';
+import { isUrl, schemaToPages, } from './utils/schema-to-pages.js';
 export async function generateFiles(options) {
     const files = await generateFilesOnly(options);
+    const { output, cwd = process.cwd() } = options;
+    const baseDir = path.join(cwd, output);
     await Promise.all(files.map(async (file) => {
-        await mkdir(path.dirname(file.path), { recursive: true });
-        await writeFile(file.path, file.content);
-        console.log(`Generated: ${file.path}`);
+        const filePath = path.join(baseDir, file.path);
+        await mkdir(path.dirname(filePath), { recursive: true });
+        await writeFile(filePath, file.content);
+        console.log(`Generated: ${filePath}`);
     }));
 }
 export async function generateFilesOnly(options) {
@@ -49,7 +53,10 @@ export async function generateFilesOnly(options) {
         throw new Error('No input files found.');
     }
     for (const [id, schema] of entries) {
-        const result = generateFromDocument(id, schema, options);
+        const result = schemaToPages(id, schema, options).map((page) => ({
+            path: page.path,
+            content: toText(page, schema, options),
+        }));
         files.push(...result);
         generated[id] = result;
     }
@@ -59,140 +66,17 @@ export async function generateFilesOnly(options) {
         documents: schemas,
     };
     if (options.index) {
-        writeIndexFiles(context, options);
+        writeIndexFiles(context, options.index, options);
     }
     await beforeWrite?.call(context, context.files);
     return context.files;
 }
-function generateFromDocument(schemaId, processed, options) {
-    const files = [];
-    const { dereferenced } = processed;
-    const { output, cwd = process.cwd(), slugify = defaultSlugify } = options;
-    const outputDir = path.join(cwd, output);
-    let nameFn;
-    if (!options.name || typeof options.name !== 'function') {
-        const algorithm = options.name?.algorithm;
-        nameFn = (out, doc) => defaultNameFn(schemaId, out, doc, options, algorithm);
-    }
-    else {
-        nameFn = options.name;
-    }
-    function getOutputPaths(groupBy = 'none', result) {
-        if (groupBy === 'route') {
-            return [
-                path.join(getOutputPathFromRoute(result.type === 'operation' ? result.item.path : result.item.name), `${result.item.method.toLowerCase()}.mdx`),
-            ];
-        }
-        const file = nameFn(result, dereferenced);
-        if (groupBy === 'tag') {
-            let tags = result.type === 'operation'
-                ? dereferenced.paths[result.item.path][result.item.method].tags
-                : dereferenced.webhooks[result.item.name][result.item.method].tags;
-            if (!tags || tags.length === 0) {
-                console.warn('When `groupBy` is set to `tag`, make sure a `tags` is defined for every operation schema.');
-                tags = ['unknown'];
-            }
-            return tags.map((tag) => path.join(slugify(tag), `${file}.mdx`));
-        }
-        return [`${file}.mdx`];
-    }
-    if (options.per === 'file') {
-        const result = generateAll(schemaId, processed, options);
-        const filename = nameFn({
-            pathOrUrl: schemaId,
-            content: result,
-        }, dereferenced);
-        files.push({
-            path: path.join(outputDir, `${filename}.mdx`),
-            content: result,
-        });
-        return files;
-    }
-    if (options.per === 'tag') {
-        const results = generateTags(schemaId, processed, options);
-        for (const result of results) {
-            const filename = nameFn(result, dereferenced);
-            files.push({
-                path: path.join(outputDir, `${filename}.mdx`),
-                content: result.content,
-            });
-        }
-        return files;
-    }
-    const results = generatePages(schemaId, processed, options);
-    const mapping = new Map();
-    for (const result of results) {
-        for (const outputPath of getOutputPaths(options.groupBy, result)) {
-            mapping.set(outputPath, result);
-        }
-    }
-    for (const [key, output] of mapping.entries()) {
-        let outputPath = key;
-        // v1 will remove nested directories
-        if (typeof options.name === 'object' && options.name.algorithm === 'v1') {
-            const isSharedDir = Array.from(mapping.keys()).some((item) => item !== outputPath &&
-                path.dirname(item) === path.dirname(outputPath));
-            if (!isSharedDir && path.dirname(outputPath) !== '.') {
-                outputPath = path.join(path.dirname(outputPath) + '.mdx');
-            }
-        }
-        files.push({
-            path: path.join(outputDir, outputPath),
-            content: output.content,
-        });
-    }
-    return files;
-}
-function defaultNameFn(schemaId, output, document, options, algorithm = 'v2') {
-    const { slugify = defaultSlugify } = options;
-    if (options.per === 'tag') {
-        const result = output;
-        return slugify(result.tag);
-    }
-    if (options.per === 'file') {
-        return isUrl(schemaId)
-            ? 'index'
-            : path.basename(schemaId, path.extname(schemaId));
-    }
-    const result = output;
-    if (result.type === 'operation') {
-        const operation = document.paths[result.item.path][result.item.method];
-        if (algorithm === 'v2' && operation.operationId) {
-            return operation.operationId;
-        }
-        return path.join(getOutputPathFromRoute(result.item.path), result.item.method.toLowerCase());
-    }
-    const hook = document.webhooks[result.item.name][result.item.method];
-    if (algorithm === 'v2' && hook.operationId) {
-        return hook.operationId;
-    }
-    return slugify(result.item.name);
-}
-function isUrl(input) {
-    return input.startsWith('https://') || input.startsWith('http://');
-}
-function getOutputPathFromRoute(path) {
-    return (path
-        .toLowerCase()
-        .replaceAll('.', '-')
-        .split('/')
-        .map((v) => {
-        if (v.startsWith('{') && v.endsWith('}'))
-            return v.slice(1, -1);
-        return v;
-    })
-        .join('/') ?? '');
-}
-function writeIndexFiles(context, options) {
-    const { index, output, cwd = process.cwd() } = options;
-    if (!index)
-        return;
-    const { items, url } = index;
+function writeIndexFiles(context, options, generateOptions) {
+    const { items, url } = options;
     let urlFn;
     if (typeof url === 'object') {
         const getUrl = createGetUrl(url.baseUrl);
-        const contentDir = path.resolve(cwd, url.contentDir);
-        urlFn = (file) => getUrl(getSlugs(path.relative(contentDir, file)));
+        urlFn = (file) => getUrl(getSlugs(path.relative(url.contentDir, file)));
     }
     else {
         urlFn = url;
@@ -231,17 +115,12 @@ function writeIndexFiles(context, options) {
         return generateDocument({
             title: index.title ?? 'Overview',
             description: index.description,
-        }, content.join('\n'), options);
+        }, content.join('\n'), generateOptions);
     }
-    const outputDir = path.join(cwd, output);
     for (const item of typeof items === 'function' ? items(context) : items) {
-        const outPath = path.join(outputDir, path.extname(item.path).length === 0 ? `${item.path}.mdx` : item.path);
         context.files.push({
-            path: outPath,
+            path: path.extname(item.path).length === 0 ? `${item.path}.mdx` : item.path,
             content: fileContent(item),
         });
     }
 }
-function defaultSlugify(s) {
-    return s.replace(/\s+/g, '-').toLowerCase();
-}

package/dist/render/api-page.js

@@ -1,7 +1,7 @@
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import Slugger from 'github-slugger';
 import { Operation } from '../render/operation/index.js';
-import { createMethod } from '../server/create-method.js';
+import { createMethod } from '../utils/schema.js';
 import { createRenders } from '../render/renderer.js';
 import { processDocumentCached, } from '../utils/process-document.js';
 import { defaultAdapters } from '../media/adapter.js';

package/dist/render/operation/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/render/operation/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,YAAY,EAAkB,MAAM,OAAO,CAAC;AACpE,OAAO,KAAK,EAEV,iBAAiB,EACjB,aAAa,EAEd,MAAM,SAAS,CAAC;AAcjB,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAY1D,MAAM,WAAW,UAAU,CAAC,CAAC,GAAG,OAAO;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB;AASD,wBAAgB,SAAS,CAAC,EACxB,IAAkB,EAClB,IAAI,EACJ,MAAM,EACN,GAAG,EACH,OAAO,EACP,YAAgB,GACjB,EAAE;IACD,IAAI,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,iBAAiB,CAAC;IAC1B,GAAG,EAAE,aAAa,CAAC;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GAAG,YAAY,CAiNf"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/render/operation/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,YAAY,EAAkB,MAAM,OAAO,CAAC;AACpE,OAAO,KAAK,EAEV,iBAAiB,EACjB,aAAa,EAEd,MAAM,SAAS,CAAC;AAajB,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAY1D,MAAM,WAAW,UAAU,CAAC,CAAC,GAAG,OAAO;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB;AASD,wBAAgB,SAAS,CAAC,EACxB,IAAkB,EAClB,IAAI,EACJ,MAAM,EACN,GAAG,EACH,OAAO,EACP,YAAgB,GACjB,EAAE;IACD,IAAI,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,iBAAiB,CAAC;IAC1B,GAAG,EAAE,aAAa,CAAC;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GAAG,YAAY,CAiNf"}

package/dist/render/operation/index.js

@@ -1,10 +1,10 @@
 import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
 import { Fragment } from 'react';
+import { createMethod } from '../../utils/schema.js';
 import { idToTitle } from '../../utils/id-to-title.js';
 import { Markdown } from '../markdown.js';
 import { heading } from '../heading.js';
 import { Schema } from '../schema.js';
-import { createMethod } from '../../server/create-method.js';
 import { methodKeys } from '../../build-routes.js';
 import { APIExample, APIExampleProvider, getAPIExamples, } from '../../render/operation/api-example.js';
 import { MethodLabel } from '../../ui/components/method-label.js';

package/dist/server/source-api.d.ts

@@ -1,9 +1,34 @@
 import type * as PageTree from 'fumadocs-core/page-tree';
-import type { LoaderPlugin, PageFile, PageTreeTransformer } from 'fumadocs-core/source';
+import { LoaderPlugin, MetaData, PageData, PageFile, PageTreeTransformer, Source } from 'fumadocs-core/source';
+import type { OpenAPIServer } from '../server/create.js';
+import type { SchemaToPagesOptions } from '../utils/schema-to-pages.js';
+import { ApiPageProps } from '../render/api-page.js';
+declare module 'fumadocs-core/source' {
+    interface PageData {
+        /**
+         * Added by Fumadocs OpenAPI
+         */
+        _openapi?: {
+            method?: string;
+        };
+    }
+}
 /**
  * Fumadocs Source API integration, pass this to `plugins` array in `loader()`.
  */
 export declare function openapiPlugin(): LoaderPlugin;
+interface OpenAPIPageData extends PageData {
+    getAPIPageProps: () => ApiPageProps;
+}
+/**
+ * Generate virtual pages for Fumadocs Source API
+ */
+export declare function openapiSource(from: OpenAPIServer, options?: SchemaToPagesOptions & {
+    baseDir?: string;
+}): Promise<Source<{
+    metaData: MetaData;
+    pageData: OpenAPIPageData;
+}>>;
 /**
  * Source API Integration, add this to page tree builder options.
  *
@@ -14,4 +39,5 @@ export declare const attachFile: (node: PageTree.Item, file: PageFile | undefine
  * @deprecated use `openapiPlugin()`
  */
 export declare function transformerOpenAPI(): PageTreeTransformer;
+export {};
 //# sourceMappingURL=source-api.d.ts.map

package/dist/server/source-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"source-api.d.ts","sourceRoot":"","sources":["../../src/server/source-api.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EACV,YAAY,EACZ,QAAQ,EACR,mBAAmB,EACpB,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,wBAAgB,aAAa,IAAI,YAAY,CAkC5C;AAED;;;;GAIG;AACH,eAAO,MAAM,UAAU,GACrB,MAAM,QAAQ,CAAC,IAAI,EACnB,MAAM,QAAQ,GAAG,SAAS,KACzB,QAAQ,CAAC,IA4BX,CAAC;AAEF;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,mBAAmB,CAExD"}
+{"version":3,"file":"source-api.d.ts","sourceRoot":"","sources":["../../src/server/source-api.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AACzD,OAAO,EACL,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,mBAAmB,EACnB,MAAM,EAEP,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,QAAQ,sBAAsB,CAAC;IACpC,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE;YACT,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB,CAAC;KACH;CACF;AAED;;GAEG;AACH,wBAAgB,aAAa,IAAI,YAAY,CAgC5C;AAED,UAAU,eAAgB,SAAQ,QAAQ;IACxC,eAAe,EAAE,MAAM,YAAY,CAAC;CACrC;AAED;;GAEG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,aAAa,EACnB,OAAO,GAAE,oBAAoB,GAAG;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;CACb,GACL,OAAO,CACR,MAAM,CAAC;IACL,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,eAAe,CAAC;CAC3B,CAAC,CACH,CA8BA;AAED;;;;GAIG;AACH,eAAO,MAAM,UAAU,GACrB,MAAM,QAAQ,CAAC,IAAI,EACnB,MAAM,QAAQ,GAAG,SAAS,KACzB,QAAQ,CAAC,IA4BX,CAAC;AAEF;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,mBAAmB,CAExD"}

package/dist/server/source-api.js

@@ -5,6 +5,8 @@ import { MethodLabel } from '../ui/components/method-label.js';
  */
 export function openapiPlugin() {
     return {
+        name: 'fumadocs:openapi',
+        enforce: 'pre',
         transformPageTree: {
             file(node, filePath) {
                 if (!filePath)
@@ -15,8 +17,7 @@ export function openapiPlugin() {
                 const data = file.data;
                 let method;
                 if ('_openapi' in data && typeof data._openapi === 'object') {
-                    const meta = data._openapi;
-                    method = meta.method;
+                    method = data._openapi.method;
                 }
                 if (method) {
                     node.name = (_jsxs(_Fragment, { children: [node.name, ' ', _jsx(MethodLabel, { className: "ms-auto text-xs text-nowrap", children: method })] }));
@@ -26,6 +27,34 @@ export function openapiPlugin() {
         },
     };
 }
+/**
+ * Generate virtual pages for Fumadocs Source API
+ */
+export async function openapiSource(from, options = {}) {
+    const { baseDir = '' } = options;
+    const { serverToPages } = await import('../utils/schema-to-pages.js');
+    const { toBody } = await import('../utils/pages/to-body.js');
+    const files = [];
+    const entries = await serverToPages(from, options);
+    for (const entry of Object.values(entries).flat()) {
+        files.push({
+            type: 'page',
+            path: `${baseDir}/${entry.path}`,
+            data: {
+                ...entry.info,
+                getAPIPageProps: () => toBody(from, entry),
+                _openapi: {
+                    method: entry.type === 'operation' || entry.type === 'webhook'
+                        ? entry.item.method
+                        : undefined,
+                },
+            },
+        });
+    }
+    return {
+        files,
+    };
+}
 /**
  * Source API Integration, add this to page tree builder options.
  *

package/dist/utils/pages/to-body.d.ts

@@ -0,0 +1,5 @@
+import type { OutputEntry } from '../../utils/schema-to-pages.js';
+import type { ApiPageProps } from '../../render/api-page.js';
+import type { OpenAPIServer } from '../../server/index.js';
+export declare function toBody(server: OpenAPIServer, entry: OutputEntry): ApiPageProps;
+//# sourceMappingURL=to-body.d.ts.map

package/dist/utils/pages/to-body.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-body.d.ts","sourceRoot":"","sources":["../../../src/utils/pages/to-body.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,wBAAgB,MAAM,CACpB,MAAM,EAAE,aAAa,EACrB,KAAK,EAAE,WAAW,GACjB,YAAY,CAoBd"}

package/dist/utils/pages/to-body.js

@@ -0,0 +1,20 @@
+export function toBody(server, entry) {
+    if (entry.type === 'operation')
+        return server.getAPIPageProps({
+            hasHead: false,
+            document: entry.schemaId,
+            operations: [entry.item],
+        });
+    if (entry.type === 'webhook')
+        return server.getAPIPageProps({
+            hasHead: false,
+            document: entry.schemaId,
+            webhooks: [entry.item],
+        });
+    return server.getAPIPageProps({
+        hasHead: true,
+        document: entry.schemaId,
+        operations: entry.operations,
+        webhooks: entry.webhooks,
+    });
+}

package/dist/utils/pages/to-text.d.ts

@@ -0,0 +1,46 @@
+import type { ProcessedDocument } from '../../utils/process-document.js';
+import type { TagObject } from '../../types.js';
+import type { OutputEntry } from '../../utils/schema-to-pages.js';
+export interface PagesToTextOptions {
+    /**
+     * 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.
+     *
+     * We recommend but don't enable it by default because some OpenAPI schemas have invalid description that breaks MDX syntax.
+     *
+     * @defaultValue false
+     */
+    includeDescription?: boolean;
+    /**
+     * Add a comment to the top of generated files indicating they are auto-generated.
+     * - `true`: Adds a standardized comment
+     * - `false`: No comment is added
+     * - `string`: Adds the provided custom comment
+     *
+     * @defaultValue true
+     */
+    addGeneratedComment?: boolean | string;
+}
+export declare function toText(entry: OutputEntry, processed: ProcessedDocument, options?: PagesToTextOptions): string;
+export declare function generateDocument(frontmatter: unknown, content: string, options: PagesToTextOptions): string;
+export type DocumentContext = {
+    type: 'tag';
+    tag: TagObject | undefined;
+} | {
+    type: 'operation';
+} | {
+    type: 'file';
+};
+//# sourceMappingURL=to-text.d.ts.map

package/dist/utils/pages/to-text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-text.d.ts","sourceRoot":"","sources":["../../../src/utils/pages/to-text.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAGlE,OAAO,KAAK,EAAY,SAAS,EAAE,MAAM,SAAS,CAAC;AAKnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAE3D,MAAM,WAAW,kBAAkB;IACjC;;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;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CACxC;AAED,wBAAgB,MAAM,CACpB,KAAK,EAAE,WAAW,EAClB,SAAS,EAAE,iBAAiB,EAC5B,OAAO,GAAE,kBAAuB,UAuEjC;AAED,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,OAAO,EACpB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,kBAAkB,GAC1B,MAAM,CA+BR;AAOD,MAAM,MAAM,eAAe,GACvB;IACE,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,SAAS,GAAG,SAAS,CAAC;CAC5B,GACD;IACE,IAAI,EAAE,WAAW,CAAC;CACnB,GACD;IACE,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/{generate.js → utils/pages/to-text.js}

@@ -1,102 +1,53 @@
-import { getAPIPageItems } from './build-routes.js';
-import { idToTitle } from './utils/id-to-title.js';
+import { idToTitle } from '../../utils/id-to-title.js';
 import { dump } from 'js-yaml';
 import Slugger from 'github-slugger';
-import { removeUndefined } from './utils/remove-undefined.js';
-export function generateAll(schemaId, processed, options = {}) {
-    const { dereferenced } = processed;
-    const items = getAPIPageItems(dereferenced);
-    return generatePage(schemaId, processed, {
-        operations: items.operations,
-        webhooks: items.webhooks,
-        hasHead: true,
-    }, {
-        ...options,
-        title: dereferenced.info.title,
-        description: dereferenced.info.description,
-    }, {
-        type: 'file',
-    });
-}
-export function generatePages(schemaId, processed, options = {}) {
-    const { dereferenced } = processed;
-    const items = getAPIPageItems(dereferenced);
-    const result = [];
-    for (const item of items.operations) {
-        const pathItem = dereferenced.paths?.[item.path];
-        if (!pathItem)
-            continue;
-        const operation = pathItem[item.method];
-        if (!operation)
-            continue;
-        result.push({
-            type: 'operation',
-            item,
-            content: generatePage(schemaId, processed, {
-                operations: [item],
+import { removeUndefined } from '../../utils/remove-undefined.js';
+export function toText(entry, processed, options = {}) {
+    switch (entry.type) {
+        case 'operation':
+            return generatePage(entry.schemaId, processed, {
+                operations: [entry.item],
                 hasHead: false,
             }, {
                 ...options,
-                title: operation.summary ??
-                    pathItem.summary ??
-                    idToTitle(operation.operationId ?? 'unknown'),
-                description: operation.description ?? pathItem.description,
+                ...entry.info,
             }, {
                 type: 'operation',
-            }),
-        });
-    }
-    for (const item of items.webhooks) {
-        const pathItem = dereferenced.webhooks?.[item.name];
-        if (!pathItem)
-            continue;
-        const operation = pathItem[item.method];
-        if (!operation)
-            continue;
-        result.push({
-            type: 'webhook',
-            item,
-            content: generatePage(schemaId, processed, {
-                webhooks: [item],
-                hasHead: false,
+            });
+        case 'schema':
+            return generatePage(entry.schemaId, processed, {
+                operations: entry.operations,
+                webhooks: entry.webhooks,
+                hasHead: true,
             }, {
                 ...options,
-                title: operation.summary ?? pathItem.summary ?? idToTitle(item.name),
-                description: operation.description ?? pathItem.description,
+                ...entry.info,
             }, {
-                type: 'operation',
-            }),
-        });
-    }
-    return result;
-}
-export function generateTags(schemaId, processed, options = {}) {
-    const { dereferenced } = processed;
-    if (!dereferenced.tags)
-        return [];
-    const items = getAPIPageItems(dereferenced);
-    return dereferenced.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: generatePage(schemaId, processed, {
-                operations,
-                webhooks,
+                type: 'file',
+            });
+        case 'tag':
+            return generatePage(entry.schemaId, processed, {
+                operations: entry.operations,
+                webhooks: entry.webhooks,
                 hasHead: true,
             }, {
                 ...options,
-                title: displayName,
-                description: tag?.description,
+                ...entry.info,
             }, {
                 type: 'tag',
-                tag,
-            }),
-        };
-    });
+                tag: entry.rawTag,
+            });
+        case 'webhook':
+            return generatePage(entry.schemaId, processed, {
+                webhooks: [entry.item],
+                hasHead: false,
+            }, {
+                ...options,
+                ...entry.info,
+            }, {
+                type: 'operation',
+            });
+    }
 }
 export function generateDocument(frontmatter, content, options) {
     const { addGeneratedComment = true, imports } = options;

package/dist/utils/schema-to-pages.d.ts

@@ -0,0 +1,97 @@
+import { type ProcessedDocument } from '../utils/process-document.js';
+import type { OpenAPIServer } from '../server/index.js';
+import type { OperationItem, WebhookItem } from '../render/api-page.js';
+import type { TagObject } from '../types.js';
+interface BaseEntry {
+    path: string;
+    schemaId: string;
+    info: {
+        title: string;
+        description?: string;
+    };
+}
+export interface OutputOperationEntry extends BaseEntry {
+    type: 'operation';
+    item: OperationItem;
+}
+export interface OutputWebhookEntry extends BaseEntry {
+    type: 'webhook';
+    item: WebhookItem;
+}
+export interface OutputTagEntry extends BaseEntry {
+    type: 'tag';
+    tag: string;
+    rawTag: TagObject;
+    operations: OperationItem[];
+    webhooks: WebhookItem[];
+}
+export interface OutputSchemaEntry extends BaseEntry {
+    type: 'schema';
+    operations: OperationItem[];
+    webhooks: WebhookItem[];
+}
+export type OutputEntry = OutputTagEntry | OutputOperationEntry | OutputWebhookEntry | OutputSchemaEntry;
+interface OperationConfig extends BaseConfig {
+    /**
+     * Generate a page for each API endpoint/operation (default).
+     */
+    per?: 'operation';
+    /**
+     * Group output using folders (Only works on `operation` mode)
+     * - tag: `{tag}/{file}`
+     * - route: `{endpoint}/{method}` (it will ignore the `name` option)
+     * - none: `{file}` (default)
+     *
+     * @defaultValue 'none'
+     */
+    groupBy?: 'tag' | 'route' | 'none';
+    /**
+     * Specify name for output file
+     */
+    name?: NameFn<OutputOperationEntry | OutputWebhookEntry>;
+}
+interface TagConfig extends BaseConfig {
+    /**
+     * Generate a page for each tag.
+     */
+    per: 'tag';
+    /**
+     * Specify name for output file
+     */
+    name?: NameFn<OutputTagEntry>;
+}
+interface SchemaConfig extends BaseConfig {
+    /**
+     * Generate a page for each schema file.
+     */
+    per: 'file';
+    /**
+     * Specify name for output file
+     */
+    name?: NameFn<OutputSchemaEntry>;
+}
+export type SchemaToPagesOptions = SchemaConfig | TagConfig | OperationConfig;
+type NameFn<Entry> = ((output: Entry, document: ProcessedDocument['dereferenced']) => string) | {
+    /**
+     * The version of algorithm used to generate file paths.
+     *
+     * v1: Fumadocs OpenAPI v8
+     * v2: Fumadocs OpenAPI v9
+     *
+     * @defaultValue v2
+     */
+    algorithm?: 'v2' | 'v1';
+};
+interface BaseConfig {
+    /**
+     * Custom function to convert names into file names.
+     *
+     * By default, it only escapes whitespaces and upper case (English) characters
+     */
+    slugify?: (name: string) => string;
+}
+export declare function serverToPages(server: OpenAPIServer, options: SchemaToPagesOptions): Promise<Record<string, OutputEntry[]>>;
+export declare function schemaToPages(schemaId: string, processed: ProcessedDocument, options: SchemaToPagesOptions): OutputEntry[];
+export declare function isUrl(schemaId: string): boolean;
+export {};
+//# sourceMappingURL=schema-to-pages.d.ts.map

package/dist/utils/schema-to-pages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-to-pages.d.ts","sourceRoot":"","sources":["../../src/utils/schema-to-pages.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGpE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAGzC,UAAU,SAAS;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED,MAAM,WAAW,oBAAqB,SAAQ,SAAS;IACrD,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,kBAAmB,SAAQ,SAAS;IACnD,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,SAAS,CAAC;IAClB,UAAU,EAAE,aAAa,EAAE,CAAC;IAC5B,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IAClD,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,EAAE,aAAa,EAAE,CAAC;IAC5B,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,MAAM,MAAM,WAAW,GACnB,cAAc,GACd,oBAAoB,GACpB,kBAAkB,GAClB,iBAAiB,CAAC;AAEtB,UAAU,eAAgB,SAAQ,UAAU;IAC1C;;OAEG;IACH,GAAG,CAAC,EAAE,WAAW,CAAC;IAElB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,kBAAkB,CAAC,CAAC;CAC1D;AAED,UAAU,SAAU,SAAQ,UAAU;IACpC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;CAC/B;AAED,UAAU,YAAa,SAAQ,UAAU;IACvC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC;CAClC;AAED,MAAM,MAAM,oBAAoB,GAAG,YAAY,GAAG,SAAS,GAAG,eAAe,CAAC;AAE9E,KAAK,MAAM,CAAC,KAAK,IACb,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,iBAAiB,CAAC,cAAc,CAAC,KAAK,MAAM,CAAC,GACxE;IACE;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;CACzB,CAAC;AAEN,UAAU,UAAU;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CACpC;AAED,wBAAsB,aAAa,CACjC,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,CAcxC;AAED,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,iBAAiB,EAC5B,OAAO,EAAE,oBAAoB,GAC5B,WAAW,EAAE,CAoJf;AA2CD,wBAAgB,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAE/C"}

package/dist/utils/schema-to-pages.js

@@ -0,0 +1,167 @@
+import * as path from 'node:path';
+import { idToTitle } from '../utils/id-to-title.js';
+import { getAPIPageItems } from '../build-routes.js';
+import { getTagDisplayName } from '../utils/schema.js';
+export async function serverToPages(server, options) {
+    const schemas = await server.getSchemas();
+    const generated = {};
+    const entries = Object.entries(schemas);
+    if (entries.length === 0) {
+        throw new Error('No input files found.');
+    }
+    for (const [id, schema] of entries) {
+        generated[id] = schemaToPages(id, schema, options);
+    }
+    return generated;
+}
+export function schemaToPages(schemaId, processed, options) {
+    const files = [];
+    const { dereferenced } = processed;
+    const { slugify = defaultSlugify } = options;
+    let nameFn;
+    if (!options.name || typeof options.name !== 'function') {
+        const algorithm = options.name?.algorithm;
+        nameFn = (out, doc) => defaultNameFn(schemaId, out, doc, options, algorithm);
+    }
+    else {
+        nameFn = options.name;
+    }
+    function getOutputPaths(groupBy = 'none', entry) {
+        if (groupBy === 'route') {
+            return [
+                path.join(getOutputPathFromRoute(entry.type === 'operation' ? entry.item.path : entry.item.name), `${entry.item.method.toLowerCase()}.mdx`),
+            ];
+        }
+        const file = nameFn(entry, dereferenced);
+        if (groupBy === 'tag') {
+            let tags = entry.type === 'operation'
+                ? dereferenced.paths[entry.item.path][entry.item.method].tags
+                : dereferenced.webhooks[entry.item.name][entry.item.method].tags;
+            if (!tags || tags.length === 0) {
+                console.warn('When `groupBy` is set to `tag`, make sure a `tags` is defined for every operation schema.');
+                tags = ['unknown'];
+            }
+            return tags.map((tag) => path.join(slugify(tag), `${file}.mdx`));
+        }
+        return [`${file}.mdx`];
+    }
+    if (options.per === 'file') {
+        const items = getAPIPageItems(dereferenced);
+        const entry = {
+            type: 'schema',
+            schemaId,
+            path: '',
+            info: {
+                title: dereferenced.info.title,
+                description: dereferenced.info.description,
+            },
+            ...items,
+        };
+        entry.path = nameFn(entry, dereferenced) + '.mdx';
+        files.push(entry);
+        return files;
+    }
+    if (options.per === 'tag') {
+        const items = getAPIPageItems(dereferenced);
+        const tags = dereferenced.tags ?? [];
+        for (const tag of tags) {
+            const entry = {
+                type: 'tag',
+                path: '',
+                schemaId,
+                info: {
+                    title: getTagDisplayName(tag),
+                    description: tag.description,
+                },
+                webhooks: items.webhooks.filter((webhook) => webhook.tags?.includes(tag.name)),
+                operations: items.operations.filter((op) => op.tags?.includes(tag.name)),
+                tag: tag.name,
+                rawTag: tag,
+            };
+            entry.path = nameFn(entry, dereferenced) + '.mdx';
+            files.push(entry);
+        }
+        return files;
+    }
+    const results = getAPIPageItems(dereferenced);
+    for (const op of results.operations) {
+        const pathItem = dereferenced.paths[op.path];
+        const operation = pathItem[op.method];
+        const entry = {
+            type: 'operation',
+            schemaId,
+            item: op,
+            path: '',
+            info: {
+                title: operation.summary ??
+                    pathItem.summary ??
+                    idToTitle(operation.operationId ?? 'unknown'),
+                description: operation.description ?? pathItem.description,
+            },
+        };
+        for (const outputPath of getOutputPaths(options.groupBy, entry)) {
+            files.push({ ...entry, path: outputPath });
+        }
+    }
+    for (const webhook of results.webhooks) {
+        const pathItem = dereferenced.webhooks[webhook.name];
+        const operation = pathItem[webhook.method];
+        const entry = {
+            type: 'webhook',
+            schemaId,
+            info: {
+                title: operation.summary ?? pathItem.summary ?? idToTitle(webhook.name),
+                description: operation.description ?? pathItem.description,
+            },
+            item: webhook,
+            path: '',
+        };
+        for (const outputPath of getOutputPaths(options.groupBy, entry)) {
+            files.push({ ...entry, path: outputPath });
+        }
+    }
+    return files;
+}
+function defaultNameFn(schemaId, result, document, options, algorithm = 'v2') {
+    const { slugify = defaultSlugify } = options;
+    if (result.type === 'tag') {
+        return slugify(result.tag);
+    }
+    if (result.type === 'schema') {
+        return isUrl(schemaId)
+            ? 'index'
+            : path.basename(schemaId, path.extname(schemaId));
+    }
+    if (result.type === 'operation') {
+        const operation = document.paths[result.item.path][result.item.method];
+        if (algorithm === 'v2' && operation.operationId) {
+            return operation.operationId;
+        }
+        return path.join(getOutputPathFromRoute(result.item.path), result.item.method.toLowerCase());
+    }
+    const hook = document.webhooks[result.item.name][result.item.method];
+    if (algorithm === 'v2' && hook.operationId) {
+        return hook.operationId;
+    }
+    return slugify(result.item.name);
+}
+export function isUrl(schemaId) {
+    return schemaId.startsWith('https://') || schemaId.startsWith('http://');
+}
+function getOutputPathFromRoute(path) {
+    return path
+        .toLowerCase()
+        .replaceAll('.', '-')
+        .split('/')
+        .flatMap((v) => {
+        if (v.startsWith('{') && v.endsWith('}'))
+            return v.slice(1, -1);
+        if (v.length === 0)
+            return [];
+        return v;
+    })
+        .join('/');
+}
+function defaultSlugify(s) {
+    return s.replace(/\s+/g, '-').toLowerCase();
+}

package/dist/utils/schema.d.ts

@@ -1,5 +1,5 @@
 import type { JSONSchema } from 'json-schema-typed/draft-2020-12';
-import type { ReferenceObject } from '../types.js';
+import type { MethodInformation, OperationObject, PathItemObject, ReferenceObject, TagObject } from '../types.js';
 export 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;
@@ -9,5 +9,10 @@ type NoReferenceJSONSchema<T> = T extends (infer I)[] ? NoReference<I>[] : T ext
 export type ParsedSchema = JSONSchema;
 export type ResolvedSchema = NoReferenceJSONSchema<ParsedSchema>;
 export declare function getPreferredType<B extends Record<string, unknown>>(body: B): keyof B | undefined;
+export declare function getTagDisplayName(tag: TagObject): string;
+/**
+ * Summarize method endpoint information
+ */
+export declare function createMethod(method: string, path: NoReference<PathItemObject>, operation: NoReference<OperationObject>): MethodInformation;
 export {};
 //# sourceMappingURL=schema.d.ts.map

package/dist/utils/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/utils/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAC9C,WAAW,CAAC,CAAC,CAAC,EAAE,GAChB,CAAC,SAAS,eAAe,GACvB,OAAO,CAAC,CAAC,EAAE,eAAe,CAAC,GAC3B,CAAC,SAAS,MAAM,GACd;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC,GACD,CAAC,CAAC;AAEV,KAAK,qBAAqB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACjD,WAAW,CAAC,CAAC,CAAC,EAAE,GAChB,CAAC,SAAS;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GACzB,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,GACf,CAAC,CAAC;AAER,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC;AACtC,MAAM,MAAM,cAAc,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAC;AAEjE,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChE,IAAI,EAAE,CAAC,GACN,MAAM,CAAC,GAAG,SAAS,CAIrB"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/utils/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,eAAe,EACf,SAAS,EACV,MAAM,SAAS,CAAC;AAGjB,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAC9C,WAAW,CAAC,CAAC,CAAC,EAAE,GAChB,CAAC,SAAS,eAAe,GACvB,OAAO,CAAC,CAAC,EAAE,eAAe,CAAC,GAC3B,CAAC,SAAS,MAAM,GACd;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC,GACD,CAAC,CAAC;AAEV,KAAK,qBAAqB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACjD,WAAW,CAAC,CAAC,CAAC,EAAE,GAChB,CAAC,SAAS;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GACzB,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,GACf,CAAC,CAAC;AAER,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC;AACtC,MAAM,MAAM,cAAc,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAC;AAEjE,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChE,IAAI,EAAE,CAAC,GACN,MAAM,CAAC,GAAG,SAAS,CAIrB;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM,CAIxD;AAED;;GAEG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,WAAW,CAAC,cAAc,CAAC,EACjC,SAAS,EAAE,WAAW,CAAC,eAAe,CAAC,GACtC,iBAAiB,CAQnB"}

package/dist/utils/schema.js

@@ -1,5 +1,23 @@
+import { idToTitle } from '../utils/id-to-title.js';
 export function getPreferredType(body) {
     if ('application/json' in body)
         return 'application/json';
     return Object.keys(body)[0];
 }
+export function getTagDisplayName(tag) {
+    return 'x-displayName' in tag && typeof tag['x-displayName'] === 'string'
+        ? tag['x-displayName']
+        : idToTitle(tag.name);
+}
+/**
+ * Summarize method endpoint information
+ */
+export function createMethod(method, path, operation) {
+    return {
+        description: path.description,
+        summary: path.summary,
+        ...operation,
+        parameters: [...(operation.parameters ?? []), ...(path.parameters ?? [])],
+        method: method.toUpperCase(),
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "9.4.1",
+  "version": "9.5.1",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",
@@ -50,8 +50,8 @@
     "@radix-ui/react-dialog": "^1.1.15",
     "@radix-ui/react-select": "^2.2.6",
     "@radix-ui/react-slot": "^1.2.3",
-    "@scalar/json-magic": "^0.5.2",
-    "@scalar/openapi-parser": "0.21.2",
+    "@scalar/json-magic": "^0.6.0",
+    "@scalar/openapi-parser": "0.22.1",
     "ajv": "^8.17.1",
     "class-variance-authority": "^0.7.1",
     "github-slugger": "^2.0.0",
@@ -60,16 +60,16 @@
     "js-yaml": "^4.1.0",
     "next-themes": "^0.4.6",
     "openapi-sampler": "^1.6.1",
-    "react-hook-form": "^7.63.0",
+    "react-hook-form": "^7.64.0",
     "remark": "^15.0.1",
     "remark-rehype": "^11.1.2",
     "tinyglobby": "^0.2.15",
     "xml-js": "^1.6.11",
-    "fumadocs-core": "15.8.3",
-    "fumadocs-ui": "15.8.3"
+    "fumadocs-ui": "15.8.5",
+    "fumadocs-core": "15.8.5"
   },
   "devDependencies": {
-    "@scalar/api-client-react": "^1.3.42",
+    "@scalar/api-client-react": "^1.3.44",
     "@types/js-yaml": "^4.0.9",
     "@types/node": "24.6.2",
     "@types/openapi-sampler": "^1.0.3",

package/dist/generate.d.ts

@@ -1,69 +0,0 @@
-import type { OperationItem, WebhookItem } from './render/api-page.js';
-import type { ProcessedDocument } from './utils/process-document.js';
-import type { TagObject } from './types.js';
-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.
-     *
-     * We recommend but don't enable it by default because some OpenAPI schemas have invalid description that breaks MDX syntax.
-     *
-     * @defaultValue false
-     */
-    includeDescription?: boolean;
-    /**
-     * Add a comment to the top of generated files indicating they are auto-generated.
-     * - `true`: Adds a standardized comment
-     * - `false`: No comment is added
-     * - `string`: Adds the provided custom comment
-     *
-     * @defaultValue true
-     */
-    addGeneratedComment?: boolean | string;
-    cwd?: string;
-    /**
-     * Inline the entire OpenAPI document into the MDX file.
-     *
-     * @deprecated Use the new `input` API on `createOpenAPI()` instead.
-     * @defaultValue false
-     */
-    inlineDocument?: boolean;
-}
-export interface GenerateTagOutput {
-    tag: string;
-    content: string;
-}
-export type GeneratePageOutput = {
-    type: 'operation';
-    item: OperationItem;
-    content: string;
-} | {
-    type: 'webhook';
-    item: WebhookItem;
-    content: string;
-};
-export declare function generateAll(schemaId: string, processed: ProcessedDocument, options?: GenerateOptions): string;
-export declare function generatePages(schemaId: string, processed: ProcessedDocument, options?: GenerateOptions): GeneratePageOutput[];
-export declare function generateTags(schemaId: string, processed: ProcessedDocument, options?: GenerateOptions): GenerateTagOutput[];
-export declare function generateDocument(frontmatter: unknown, content: string, options: Pick<GenerateOptions, 'addGeneratedComment' | 'imports'>): string;
-export type DocumentContext = {
-    type: 'tag';
-    tag: TagObject | undefined;
-} | {
-    type: 'operation';
-} | {
-    type: 'file';
-};
-//# sourceMappingURL=generate.d.ts.map

package/dist/generate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAEV,aAAa,EACb,WAAW,EACZ,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAGlE,OAAO,KAAK,EAAY,SAAS,EAAE,MAAM,SAAS,CAAC;AAMnD,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;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAEvC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;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,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEN,wBAAgB,WAAW,CACzB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,iBAAiB,EAC5B,OAAO,GAAE,eAAoB,GAC5B,MAAM,CAqBR;AAED,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,iBAAiB,EAC5B,OAAO,GAAE,eAAoB,GAC5B,kBAAkB,EAAE,CAiEtB;AAED,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,iBAAiB,EAC5B,OAAO,GAAE,eAAoB,GAC5B,iBAAiB,EAAE,CAwCrB;AAED,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,OAAO,EACpB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,IAAI,CAAC,eAAe,EAAE,qBAAqB,GAAG,SAAS,CAAC,GAChE,MAAM,CA+BR;AAOD,MAAM,MAAM,eAAe,GACvB;IACE,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,SAAS,GAAG,SAAS,CAAC;CAC5B,GACD;IACE,IAAI,EAAE,WAAW,CAAC;CACnB,GACD;IACE,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/server/create-method.d.ts

@@ -1,7 +0,0 @@
-import type { MethodInformation, OperationObject, PathItemObject } from '../types.js';
-import type { NoReference } from '../utils/schema.js';
-/**
- * Summarize method endpoint information
- */
-export declare function createMethod(method: string, path: NoReference<PathItemObject>, operation: NoReference<OperationObject>): MethodInformation;
-//# sourceMappingURL=create-method.d.ts.map

package/dist/server/create-method.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"create-method.d.ts","sourceRoot":"","sources":["../../src/server/create-method.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,cAAc,EACf,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD;;GAEG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,WAAW,CAAC,cAAc,CAAC,EACjC,SAAS,EAAE,WAAW,CAAC,eAAe,CAAC,GACtC,iBAAiB,CAQnB"}

package/dist/server/create-method.js

@@ -1,12 +0,0 @@
-/**
- * Summarize method endpoint information
- */
-export function createMethod(method, path, operation) {
-    return {
-        description: path.description,
-        summary: path.summary,
-        ...operation,
-        parameters: [...(operation.parameters ?? []), ...(path.parameters ?? [])],
-        method: method.toUpperCase(),
-    };
-}