fumadocs-openapi 9.5.0 → 9.6.0

package/dist/render/schema/server.d.ts

@@ -0,0 +1,43 @@
+import { type ReactNode } from 'react';
+import type { ResolvedSchema } from '../../utils/schema.js';
+import type { RenderContext } from '../../types.js';
+export interface FieldBase {
+    description?: ReactNode;
+    infoTags?: ReactNode[];
+    typeName: string;
+    aliasName: string;
+    deprecated?: boolean;
+    writeOnly?: boolean;
+    readOnly?: boolean;
+}
+export type SchemaData = FieldBase & ({
+    type: 'primitive';
+} | {
+    type: 'object';
+    props: {
+        name: string;
+        $type: string;
+        required: boolean;
+    }[];
+} | {
+    type: 'array';
+    item: {
+        $type: string;
+    };
+} | {
+    type: 'or';
+    items: {
+        name: string;
+        $type: string;
+    }[];
+});
+export interface SchemaUIOptions {
+    root: ResolvedSchema;
+    ctx: RenderContext;
+}
+export interface SchemaUIData {
+    $root: string;
+    refs: Record<string, SchemaData>;
+}
+export declare function generateSchemaUI({ ctx, root }: SchemaUIOptions): SchemaUIData;
+//# sourceMappingURL=server.d.ts.map

package/dist/render/schema/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/render/schema/server.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAK7C,MAAM,WAAW,SAAS;IACxB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC;IAEvB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAElB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,UAAU,GAAG,SAAS,GAChC,CACI;IACE,IAAI,EAAE,WAAW,CAAC;CACnB,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,OAAO,CAAC;KACnB,EAAE,CAAC;CACL,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,GACD;IACE,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL,CACJ,CAAC;AAEJ,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,cAAc,CAAC;IACrB,GAAG,EAAE,aAAa,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;CAClC;AAED,wBAAgB,gBAAgB,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,eAAe,GAAG,YAAY,CAoP7E"}

package/dist/render/schema/server.js

@@ -0,0 +1,206 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { FormatFlags, schemaToString } from '../../utils/schema-to-string.js';
+import { Markdown } from '../../render/markdown.js';
+import { combineSchema } from '../../utils/combine-schema.js';
+export function generateSchemaUI({ ctx, root }) {
+    const refs = {};
+    const { content: { showExampleInFields = false } = {} } = ctx;
+    function generateInfoTags(schema) {
+        const fields = [];
+        function field(key, value) {
+            return (_jsxs("div", { className: "bg-fd-secondary border rounded-lg text-xs p-1.5 shadow-md", children: [_jsx("span", { className: "font-medium me-2", children: key }), _jsx("code", { className: "text-fd-muted-foreground", children: value })] }));
+        }
+        if (schema.default !== undefined) {
+            fields.push(field('Default', JSON.stringify(schema.default)));
+        }
+        if (schema.pattern) {
+            fields.push(field('Match', schema.pattern));
+        }
+        if (schema.format) {
+            fields.push(field('Format', schema.format));
+        }
+        if (schema.multipleOf) {
+            fields.push(field('Multiple Of', schema.multipleOf));
+        }
+        let range = getRange('value', schema.minimum, schema.exclusiveMinimum, schema.maximum, schema.exclusiveMaximum);
+        if (range)
+            fields.push(field('Range', range));
+        range = getRange('length', schema.minLength, undefined, schema.maxLength, undefined);
+        if (range)
+            fields.push(field('Length', range));
+        range = getRange('properties', schema.minProperties, undefined, schema.maxProperties, undefined);
+        if (range)
+            fields.push(field('Properties', range));
+        range = getRange('items', schema.minItems, undefined, schema.maxItems, undefined);
+        if (range)
+            fields.push(field('Items', range));
+        if (schema.enum) {
+            fields.push(field('Value in', schema.enum.map((value) => JSON.stringify(value)).join(' | ')));
+        }
+        if (showExampleInFields && schema.examples) {
+            for (const example of schema.examples) {
+                fields.push(field('Example', JSON.stringify(example, null, 2)));
+            }
+        }
+        return fields;
+    }
+    let _counter = 0;
+    const autoIds = new WeakMap();
+    function getSchemaId(schema) {
+        if (typeof schema === 'boolean')
+            return String(schema);
+        const raw = ctx.schema.getRawRef(schema);
+        if (raw)
+            return raw;
+        const prev = autoIds.get(schema);
+        if (prev)
+            return prev;
+        const generated = `__${_counter++}`;
+        autoIds.set(schema, generated);
+        return generated;
+    }
+    function base(schema) {
+        if (typeof schema === 'boolean') {
+            const name = schema ? 'any' : 'never';
+            return {
+                typeName: name,
+                aliasName: name,
+            };
+        }
+        return {
+            description: schema.description && _jsx(Markdown, { text: schema.description }),
+            infoTags: generateInfoTags(schema),
+            typeName: schemaToString(schema, ctx.schema),
+            aliasName: schemaToString(schema, ctx.schema, FormatFlags.UseAlias),
+            deprecated: schema.deprecated,
+            readOnly: schema.readOnly,
+            writeOnly: schema.writeOnly,
+        };
+    }
+    function scanRefs(id, schema) {
+        if (id in refs)
+            return;
+        if (typeof schema === 'boolean') {
+            refs[id] = {
+                type: 'primitive',
+                ...base(schema),
+            };
+            return;
+        }
+        if (Array.isArray(schema.type)) {
+            const out = {
+                type: 'or',
+                items: [],
+                ...base(schema),
+            };
+            refs[id] = out;
+            for (const type of schema.type) {
+                const item = {
+                    ...schema,
+                    type,
+                };
+                const key = `${id}_type:${type}`;
+                scanRefs(key, item);
+                out.items.push({
+                    name: type,
+                    $type: key,
+                });
+            }
+            return;
+        }
+        if (schema.oneOf) {
+            const out = {
+                type: 'or',
+                items: [],
+                ...base(schema),
+            };
+            refs[id] = out;
+            for (const item of schema.oneOf) {
+                const $type = getSchemaId(item);
+                scanRefs($type, item);
+                out.items.push({
+                    name: schemaToString(item, ctx.schema, FormatFlags.UseAlias),
+                    $type,
+                });
+            }
+            return;
+        }
+        const of = schema.allOf ?? schema.anyOf;
+        if (of) {
+            const combined = combineSchema(of);
+            scanRefs(id, combined);
+            return;
+        }
+        if (schema.type === 'object') {
+            const out = {
+                type: 'object',
+                props: [],
+                ...base(schema),
+            };
+            refs[id] = out;
+            const props = Object.entries(schema.properties ?? {});
+            if (schema.patternProperties)
+                props.push(...Object.entries(schema.patternProperties));
+            for (const [key, prop] of props) {
+                const $type = getSchemaId(prop);
+                scanRefs($type, prop);
+                out.props.push({
+                    $type,
+                    name: key,
+                    required: schema.required?.includes(key) ?? false,
+                });
+            }
+            if (schema.additionalProperties) {
+                const $type = getSchemaId(schema.additionalProperties);
+                scanRefs($type, schema.additionalProperties);
+                out.props.push({
+                    $type,
+                    name: '[key: string]',
+                    required: false,
+                });
+            }
+            return;
+        }
+        if (schema.type === 'array') {
+            const items = schema.items ?? true;
+            const $type = getSchemaId(items);
+            refs[id] = {
+                type: 'array',
+                item: {
+                    $type,
+                },
+                ...base(schema),
+            };
+            scanRefs($type, items);
+            return;
+        }
+        refs[id] = {
+            type: 'primitive',
+            ...base(schema),
+        };
+    }
+    const $root = getSchemaId(root);
+    scanRefs($root, root);
+    return {
+        refs,
+        $root,
+    };
+}
+function getRange(value, min, exclusiveMin, max, exclusiveMax) {
+    const out = [];
+    if (min !== undefined) {
+        out.push(`${min} <=`);
+    }
+    else if (exclusiveMin !== undefined) {
+        out.push(`${exclusiveMin} <`);
+    }
+    out.push(value);
+    if (max !== undefined) {
+        out.push(`<= ${max}`);
+    }
+    else if (exclusiveMax !== undefined) {
+        out.push(`< ${exclusiveMax}`);
+    }
+    if (out.length > 1)
+        return out.join(' ');
+}

package/dist/render/schema/ui.d.ts

@@ -0,0 +1,16 @@
+import type { ReactNode } from 'react';
+export declare function ObjectCollapsible(props: {
+    name: string;
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export interface PropertyProps {
+    name: ReactNode;
+    type: ReactNode;
+    required?: boolean;
+    deprecated?: boolean;
+    nested?: boolean;
+    children?: ReactNode;
+    className?: string;
+}
+export declare function Property({ name, type, required, deprecated, nested, ...props }: PropertyProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=ui.d.ts.map

package/dist/render/schema/ui.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../../src/render/schema/ui.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAWvC,wBAAgB,iBAAiB,CAAC,KAAK,EAAE;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,CAAC;CACrB,2CAiBA;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,wBAAgB,QAAQ,CAAC,EACvB,IAAI,EACJ,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,MAAc,EACd,GAAG,KAAK,EACT,EAAE,aAAa,2CAoCf"}

package/dist/render/schema/ui.js

@@ -0,0 +1,14 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Collapsible, CollapsibleContent, CollapsibleTrigger, } from 'fumadocs-ui/components/ui/collapsible';
+import { cn } from 'fumadocs-ui/utils/cn';
+import { buttonVariants } from 'fumadocs-ui/components/ui/button';
+import { ChevronDown } from 'fumadocs-ui/internal/icons';
+import { Badge } from '../../ui/components/method-label.js';
+export function ObjectCollapsible(props) {
+    return (_jsxs(Collapsible, { className: "my-2", ...props, children: [_jsxs(CollapsibleTrigger, { className: cn(buttonVariants({ color: 'secondary', size: 'sm' }), 'group px-3 py-2 data-[state=open]:rounded-b-none'), children: [props.name, _jsx(ChevronDown, { className: "size-4 text-fd-muted-foreground group-data-[state=open]:rotate-180" })] }), _jsx(CollapsibleContent, { className: "-mt-px *:bg-fd-card", children: props.children })] }));
+}
+export function Property({ name, type, required, deprecated, nested = false, ...props }) {
+    return (_jsxs("div", { className: cn('text-sm border-t', nested
+            ? 'p-3 border-x bg-fd-card last:rounded-b-xl first:rounded-tr-xl last:border-b'
+            : 'py-4 first:border-t-0', props.className), children: [_jsxs("div", { className: "flex flex-wrap items-center gap-3 not-prose", children: [_jsxs("span", { className: "font-medium font-mono text-fd-primary", children: [name, required === false && (_jsx("span", { className: "text-fd-muted-foreground", children: "?" }))] }), typeof type === 'string' ? (_jsx("span", { className: "text-sm font-mono text-fd-muted-foreground", children: type })) : (type), deprecated && (_jsx(Badge, { color: "yellow", className: "ms-auto text-xs", children: "Deprecated" }))] }), _jsx("div", { className: "prose-no-margin pt-2.5 empty:hidden", children: props.children })] }));
+}

package/dist/server/create.d.ts

@@ -47,6 +47,17 @@ export interface SharedOpenAPIOptions {
      */
     showResponseSchema?: boolean;
     mediaAdapters?: Record<string, MediaAdapter>;
+    /**
+     * Customise page content
+     */
+    content?: {
+        /**
+         * Show examples under the generated content of JSON schemas.
+         *
+         * @defaultValue false
+         */
+        showExampleInFields?: boolean;
+    };
 }
 export interface OpenAPIOptions extends SharedOpenAPIOptions {
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../src/server/create.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EACV,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAGL,KAAK,iBAAiB,EACvB,MAAM,0BAA0B,CAAC;AAElC,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AACnC;;GAEG;AACH,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAC3E,KAAK,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAE5D,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE7B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;OAOG;IACH,wBAAwB,CAAC,EACrB,CAAC,CACC,MAAM,EAAE,WAAW,CAAC,iBAAiB,CAAC,EACtC,UAAU,EAAE,MAAM,KACf,SAAS,CAAC,MAAM,CAAC,CAAC,GACvB,KAAK,CAAC;IAEV;;OAEG;IACH,mBAAmB,CAAC,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,SAAS,CAAC,UAAU,EAAE,CAAC,CAAC;IAE7E,YAAY,CAAC,EAAE,IAAI,CAAC,sBAAsB,EAAE,MAAM,GAAG,YAAY,CAAC,GAChE,sBAAsB,CAAC;IAEzB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,cAAe,SAAQ,oBAAoB;IAC1D;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAE9C,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,YAAY,CAAC;IACtD,WAAW,EAAE,OAAO,WAAW,CAAC;IAChC,UAAU,EAAE,MAAM,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAC/C;AAED,wBAAgB,aAAa,CAAC,OAAO,GAAE,cAAmB,GAAG,aAAa,CA4CzE;AAED,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,CAEtE"}
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../src/server/create.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EACV,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAGL,KAAK,iBAAiB,EACvB,MAAM,0BAA0B,CAAC;AAElC,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AACnC;;GAEG;AACH,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAC3E,KAAK,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAE5D,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE7B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;OAOG;IACH,wBAAwB,CAAC,EACrB,CAAC,CACC,MAAM,EAAE,WAAW,CAAC,iBAAiB,CAAC,EACtC,UAAU,EAAE,MAAM,KACf,SAAS,CAAC,MAAM,CAAC,CAAC,GACvB,KAAK,CAAC;IAEV;;OAEG;IACH,mBAAmB,CAAC,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,SAAS,CAAC,UAAU,EAAE,CAAC,CAAC;IAE7E,YAAY,CAAC,EAAE,IAAI,CAAC,sBAAsB,EAAE,MAAM,GAAG,YAAY,CAAC,GAChE,sBAAsB,CAAC;IAEzB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAE7C;;OAEG;IACH,OAAO,CAAC,EAAE;QACR;;;;WAIG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;KAC/B,CAAC;CACH;AAED,MAAM,WAAW,cAAe,SAAQ,oBAAoB;IAC1D;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAE9C,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,YAAY,CAAC;IACtD,WAAW,EAAE,OAAO,WAAW,CAAC;IAChC,UAAU,EAAE,MAAM,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAC/C;AAED,wBAAgB,aAAa,CAAC,OAAO,GAAE,cAAmB,GAAG,aAAa,CA4CzE;AAED,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,CAEtE"}

package/dist/ui/components/method-label.d.ts

@@ -1,7 +1,7 @@
 import { type VariantProps } from 'class-variance-authority';
 import type { HTMLAttributes } from 'react';
 export declare const badgeVariants: (props?: ({
-    color?: "green" | "yellow" | "red" | "blue" | "orange" | null | undefined;
+    color?: "red" | "green" | "yellow" | "blue" | "orange" | null | undefined;
 } & import("class-variance-authority/types").ClassProp) | undefined) => string;
 export declare function Badge({ className, color, ...props }: Omit<HTMLAttributes<HTMLSpanElement>, 'color'> & VariantProps<typeof badgeVariants>): import("react/jsx-runtime").JSX.Element;
 export declare function MethodLabel({ children, ...props }: Omit<HTMLAttributes<HTMLSpanElement>, 'children'> & {

package/dist/ui/contexts/code-example.d.ts

@@ -14,7 +14,10 @@ export declare function CodeExampleProvider({ route, examples, initialKey, child
 }): import("react/jsx-runtime").JSX.Element;
 export declare function CodeExample(sample: CodeSample): import("react/jsx-runtime").JSX.Element | null;
 export declare function CodeExampleSelector({ items }: SamplesProps): import("react/jsx-runtime").JSX.Element;
-export declare function useRequestInitialData(): RawRequestData;
+export declare function useRequestInitialData(): {
+    key: string;
+    data: RawRequestData;
+};
 export declare function useRequestDataUpdater(): {
     setData: (data: RawRequestData, encoded: RequestData) => void;
 };

package/dist/ui/contexts/code-example.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"code-example.d.ts","sourceRoot":"","sources":["../../../src/ui/contexts/code-example.tsx"],"names":[],"mappings":"AACA,OAAO,EAGL,KAAK,SAAS,EAMf,MAAM,OAAO,CAAC;AAGf,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AActD,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAmBtE,wBAAgB,mBAAmB,CAAC,EAClC,KAAK,EACL,QAAQ,EACR,UAAU,EACV,QAAQ,GACT,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,cAAc,CAAC;QACrB,OAAO,EAAE,WAAW,CAAC;KACtB,EAAE,CAAC;IACJ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,SAAS,CAAC;CACrB,2CA6DA;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,UAAU,kDA2C7C;AAED,wBAAgB,mBAAmB,CAAC,EAAE,KAAK,EAAE,EAAE,YAAY,2CAoB1D;AAgBD,wBAAgB,qBAAqB,mBAIpC;AAED,wBAAgB,qBAAqB;oBA1KnB,cAAc,WAAW,WAAW,KAAK,IAAI;EA6K9D"}
+{"version":3,"file":"code-example.d.ts","sourceRoot":"","sources":["../../../src/ui/contexts/code-example.tsx"],"names":[],"mappings":"AACA,OAAO,EAGL,KAAK,SAAS,EAMf,MAAM,OAAO,CAAC;AAGf,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AActD,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAmBtE,wBAAgB,mBAAmB,CAAC,EAClC,KAAK,EACL,QAAQ,EACR,UAAU,EACV,QAAQ,GACT,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,cAAc,CAAC;QACrB,OAAO,EAAE,WAAW,CAAC;KACtB,EAAE,CAAC;IACJ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,SAAS,CAAC;CACrB,2CA6DA;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,UAAU,kDA2C7C;AAED,wBAAgB,mBAAmB,CAAC,EAAE,KAAK,EAAE,EAAE,YAAY,2CAoB1D;AAgBD,wBAAgB,qBAAqB;;;EAIpC;AAED,wBAAgB,qBAAqB;oBA1KnB,cAAc,WAAW,WAAW,KAAK,IAAI;EA6K9D"}

package/dist/ui/contexts/code-example.js

@@ -89,7 +89,7 @@ function SelectDisplay({ item, ...props }) {
 }
 export function useRequestInitialData() {
     const { getExample, key } = useContext(CodeExampleContext);
-    return getExample(key).data;
+    return { key, data: getExample(key).data };
 }
 export function useRequestDataUpdater() {
     const { setData } = useContext(CodeExampleContext);

package/dist/ui/index.d.ts

@@ -1,13 +1,9 @@
-import { type HTMLAttributes, type ReactNode } from 'react';
-import type { PropertyProps, RootProps } from '../render/renderer.js';
+import type { HTMLAttributes } from 'react';
+import type { RootProps } from '../render/renderer.js';
 export declare function Root({ children, className, ctx, ...props }: RootProps & HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
 export declare function APIInfo({ className, ...props }: HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
 export declare function API({ children, ...props }: HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
-export declare function Property({ name, type, required, deprecated, nested, ...props }: PropertyProps): import("react/jsx-runtime").JSX.Element;
 export declare function APIExample(props: HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
-export declare function ObjectCollapsible(props: {
-    name: string;
-    children: ReactNode;
-}): import("react/jsx-runtime").JSX.Element;
+export { Property, ObjectCollapsible } from '../render/schema/ui.js';
 export { APIPage, type ApiPageProps } from '../render/api-page.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/ui/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ui/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAE5D,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAYlE,wBAAgB,IAAI,CAAC,EACnB,QAAQ,EACR,SAAS,EACT,GAAG,EACH,GAAG,KAAK,EACT,EAAE,SAAS,GAAG,cAAc,CAAC,cAAc,CAAC,2CAmB5C;AAED,wBAAgB,OAAO,CAAC,EACtB,SAAS,EACT,GAAG,KAAK,EACT,EAAE,cAAc,CAAC,cAAc,CAAC,2CAMhC;AAED,wBAAgB,GAAG,CAAC,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAE,EAAE,cAAc,CAAC,cAAc,CAAC,2CAmBzE;AAED,wBAAgB,QAAQ,CAAC,EACvB,IAAI,EACJ,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,MAAM,EACN,GAAG,KAAK,EACT,EAAE,aAAa,2CA+Bf;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,cAAc,CAAC,cAAc,CAAC,2CAY/D;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,CAAC;CACrB,2CAiBA;AAED,OAAO,EAAE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ui/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAKnD,wBAAgB,IAAI,CAAC,EACnB,QAAQ,EACR,SAAS,EACT,GAAG,EACH,GAAG,KAAK,EACT,EAAE,SAAS,GAAG,cAAc,CAAC,cAAc,CAAC,2CAmB5C;AAED,wBAAgB,OAAO,CAAC,EACtB,SAAS,EACT,GAAG,KAAK,EACT,EAAE,cAAc,CAAC,cAAc,CAAC,2CAMhC;AAED,wBAAgB,GAAG,CAAC,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAE,EAAE,cAAc,CAAC,cAAc,CAAC,2CAmBzE;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,cAAc,CAAC,cAAc,CAAC,2CAY/D;AAED,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/ui/index.js

@@ -1,10 +1,6 @@
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { Badge } from '../ui/components/method-label.js';
-import { Collapsible, CollapsibleContent, CollapsibleTrigger, } from 'fumadocs-ui/components/ui/collapsible';
-import { ChevronDown } from '../icons.js';
+import { jsx as _jsx } from "react/jsx-runtime";
 import { ApiProvider } from '../ui/lazy.js';
 import { cn } from 'fumadocs-ui/utils/cn';
-import { buttonVariants } from 'fumadocs-ui/components/ui/button';
 export function Root({ children, className, ctx, ...props }) {
     const mediaAdapters = {};
     for (const k in ctx.mediaAdapters) {
@@ -23,15 +19,8 @@ export function API({ children, ...props }) {
             ...props.style,
         }, children: children }));
 }
-export function Property({ name, type, required, deprecated, nested, ...props }) {
-    return (_jsxs("div", { className: cn('text-sm border-t', nested
-            ? 'p-3 border-x bg-fd-card last:rounded-b-xl first:rounded-tr-xl last:border-b'
-            : 'py-4 first:border-t-0'), children: [_jsxs("div", { className: "flex flex-wrap items-center gap-2 not-prose", children: [_jsxs("span", { className: "font-medium font-mono text-fd-primary", children: [name, required === false && (_jsx("span", { className: "text-fd-muted-foreground", children: "?" }))] }), _jsx("span", { className: "me-auto text-xs font-mono text-fd-muted-foreground", children: type }), deprecated && (_jsx(Badge, { color: "yellow", className: "text-xs", children: "Deprecated" }))] }), _jsx("div", { className: "prose-no-margin pt-2.5 empty:hidden", children: props.children })] }));
-}
 export function APIExample(props) {
     return (_jsx("div", { ...props, className: cn('prose-no-margin md:sticky md:top-(--fd-api-info-top) xl:w-[400px]', props.className), children: props.children }));
 }
-export function ObjectCollapsible(props) {
-    return (_jsxs(Collapsible, { className: "my-2", ...props, children: [_jsxs(CollapsibleTrigger, { className: cn(buttonVariants({ color: 'secondary', size: 'sm' }), 'group px-3 py-2 data-[state=open]:rounded-b-none'), children: [props.name, _jsx(ChevronDown, { className: "size-4 text-fd-muted-foreground group-data-[state=open]:rotate-180" })] }), _jsx(CollapsibleContent, { className: "-mt-px *:bg-fd-card", children: props.children })] }));
-}
+export { Property, ObjectCollapsible } from '../render/schema/ui.js';
 export { APIPage } from '../render/api-page.js';

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

@@ -1,4 +1,8 @@
 import { type ResolvedSchema } from '../utils/schema.js';
 import type { ProcessedDocument } from '../utils/process-document.js';
-export declare function schemaToString(value: ResolvedSchema, ctx?: ProcessedDocument): string;
+export declare enum FormatFlags {
+    None = 0,
+    UseAlias = 1
+}
+export declare function schemaToString(value: ResolvedSchema, ctx?: ProcessedDocument, flags?: FormatFlags): string;
 //# sourceMappingURL=schema-to-string.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"schema-to-string.d.ts","sourceRoot":"","sources":["../../src/utils/schema-to-string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAElE,wBAAgB,cAAc,CAC5B,KAAK,EAAE,cAAc,EACrB,GAAG,CAAC,EAAE,iBAAiB,GACtB,MAAM,CAmER"}
+{"version":3,"file":"schema-to-string.d.ts","sourceRoot":"","sources":["../../src/utils/schema-to-string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAElE,oBAAY,WAAW;IACrB,IAAI,IAAI;IACR,QAAQ,IAAS;CAClB;AAED,wBAAgB,cAAc,CAC5B,KAAK,EAAE,cAAc,EACrB,GAAG,CAAC,EAAE,iBAAiB,EACvB,KAAK,GAAE,WAA8B,GACpC,MAAM,CAwER"}

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

@@ -1,9 +1,14 @@
-export function schemaToString(value, ctx) {
-    function union(union, sep) {
+export var FormatFlags;
+(function (FormatFlags) {
+    FormatFlags[FormatFlags["None"] = 0] = "None";
+    FormatFlags[FormatFlags["UseAlias"] = 1] = "UseAlias";
+})(FormatFlags || (FormatFlags = {}));
+export function schemaToString(value, ctx, flags = FormatFlags.None) {
+    function union(union, sep, flags) {
         const members = new Set();
         let nullable = false;
         for (const item of union) {
-            const result = run(item);
+            const result = run(item, flags | FormatFlags.UseAlias);
             if (result === 'null') {
                 nullable = true;
             }
@@ -14,39 +19,35 @@ export function schemaToString(value, ctx) {
         const result = Array.from(members).join(sep);
         return nullable ? `${result} | null` : result;
     }
-    function run(schema) {
+    function run(schema, flags) {
         if (schema === true)
             return 'any';
         else if (schema === false)
             return 'never';
-        if (schema.title)
-            return schema.title;
-        const rawRef = ctx?.getRawRef(schema);
-        if (rawRef)
-            return rawRef.split('/').at(-1);
+        if ((flags & FormatFlags.UseAlias) === FormatFlags.UseAlias) {
+            if (schema.title)
+                return schema.title;
+            const ref = ctx?.getRawRef(schema);
+            if (ref)
+                return ref.split('/').at(-1);
+        }
         if (Array.isArray(schema.type)) {
-            const members = new Set();
-            const types = schema.type;
-            for (const type of types) {
-                schema.type = type;
-                const str = run(schema);
-                schema.type = types;
-                if (str !== 'unknown')
-                    members.add(str);
-            }
-            return Array.from(members).join(' | ');
+            return union(schema.type.map((type) => ({
+                ...schema,
+                type,
+            })), ' | ', flags);
         }
         if (schema.type === 'array')
-            return `array<${schema.items ? run(schema.items) : 'unknown'}>`;
+            return `array<${schema.items ? run(schema.items, flags | FormatFlags.UseAlias) : 'unknown'}>`;
         if (schema.oneOf) {
-            return union(schema.oneOf, ' | ');
+            return union(schema.oneOf, ' | ', flags);
         }
         const combinedOf = schema.anyOf ?? schema.allOf;
         if (combinedOf) {
-            return union(combinedOf, ' & ');
+            return union(combinedOf, ' & ', flags);
         }
         if (schema.not)
-            return `not ${run(schema.not)}`;
+            return `not ${run(schema.not, flags)}`;
         if (schema.type === 'string' && schema.format === 'binary')
             return 'file';
         if (schema.type && Array.isArray(schema.type)) {
@@ -57,5 +58,5 @@ export function schemaToString(value, ctx) {
         }
         return 'unknown';
     }
-    return run(value);
+    return run(value, flags);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "9.5.0",
+  "version": "9.6.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.6.0",
-    "@scalar/openapi-parser": "0.22.1",
+    "@scalar/json-magic": "^0.6.1",
+    "@scalar/openapi-parser": "0.22.3",
     "ajv": "^8.17.1",
     "class-variance-authority": "^0.7.1",
     "github-slugger": "^2.0.0",
@@ -59,24 +59,24 @@
     "hast-util-to-jsx-runtime": "^2.3.6",
     "js-yaml": "^4.1.0",
     "next-themes": "^0.4.6",
-    "openapi-sampler": "^1.6.1",
-    "react-hook-form": "^7.64.0",
+    "openapi-sampler": "^1.6.2",
+    "react-hook-form": "^7.65.0",
     "remark": "^15.0.1",
     "remark-rehype": "^11.1.2",
     "tinyglobby": "^0.2.15",
     "xml-js": "^1.6.11",
-    "fumadocs-core": "15.8.4",
-    "fumadocs-ui": "15.8.4"
+    "fumadocs-core": "16.0.0",
+    "fumadocs-ui": "16.0.0"
   },
   "devDependencies": {
-    "@scalar/api-client-react": "^1.3.44",
+    "@scalar/api-client-react": "^1.3.46",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "24.6.2",
+    "@types/node": "24.9.1",
     "@types/openapi-sampler": "^1.0.3",
-    "@types/react": "^19.2.0",
+    "@types/react": "^19.2.2",
     "json-schema-typed": "^8.0.1",
     "openapi-types": "^12.1.3",
-    "tailwindcss": "^4.1.14",
+    "tailwindcss": "^4.1.15",
     "tsc-alias": "^1.8.16",
     "eslint-config-custom": "0.0.0",
     "tsconfig": "0.0.0"

package/dist/render/schema.d.ts

@@ -1,13 +0,0 @@
-import { type ReactNode } from 'react';
-import type { ResolvedSchema } from '../utils/schema.js';
-import type { RenderContext } from '../types.js';
-export declare function Schema({ name, schema, required, readOnly, writeOnly, as, ctx: renderContext, }: {
-    name: string;
-    required?: boolean;
-    schema: ResolvedSchema;
-    as?: 'property' | 'body';
-    readOnly?: boolean;
-    writeOnly?: boolean;
-    ctx: RenderContext;
-}): ReactNode;
-//# sourceMappingURL=schema.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/render/schema.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAe7C,wBAAgB,MAAM,CAAC,EACrB,IAAI,EACJ,MAAM,EACN,QAAgB,EAChB,QAAgB,EAChB,SAAiB,EACjB,EAAe,EACf,GAAG,EAAE,aAAa,GACnB,EAAE;IACD,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,cAAc,CAAC;IACvB,EAAE,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,EAAE,aAAa,CAAC;CACpB,GAAG,SAAS,CA4UZ"}