fumadocs-openapi 9.4.0 → 9.5.0

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.0",
+  "version": "9.5.0",
   "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,26 +60,26 @@
     "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.2",
-    "fumadocs-ui": "15.8.2"
+    "fumadocs-core": "15.8.4",
+    "fumadocs-ui": "15.8.4"
   },
   "devDependencies": {
-    "@scalar/api-client-react": "^1.3.41",
+    "@scalar/api-client-react": "^1.3.44",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "24.5.2",
+    "@types/node": "24.6.2",
     "@types/openapi-sampler": "^1.0.3",
-    "@types/react": "^19.1.14",
+    "@types/react": "^19.2.0",
     "json-schema-typed": "^8.0.1",
     "openapi-types": "^12.1.3",
-    "tailwindcss": "^4.1.13",
+    "tailwindcss": "^4.1.14",
     "tsc-alias": "^1.8.16",
-    "tsconfig": "0.0.0",
-    "eslint-config-custom": "0.0.0"
+    "eslint-config-custom": "0.0.0",
+    "tsconfig": "0.0.0"
   },
   "peerDependencies": {
     "@scalar/api-client-react": "*",

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(),
-    };
-}