fumadocs-openapi 10.0.11 → 10.1.0

package/dist/ui/contexts/operation.js

@@ -1,48 +0,0 @@
-'use client';
-import { jsx as _jsx } from "react/jsx-runtime";
-import { createContext, use, useMemo, useRef, useState, } from 'react';
-const OperationContext = createContext(null);
-export function OperationProvider({ route, examples, defaultExampleId, children, }) {
-    const [example, setExample] = useState(() => defaultExampleId ?? examples.at(0)?.id);
-    const listeners = useRef([]);
-    return (_jsx(OperationContext, { value: useMemo(() => ({
-            example,
-            route,
-            setExample: (newKey) => {
-                const example = examples.find((example) => example.id === newKey);
-                if (!example)
-                    return;
-                setExample(newKey);
-                for (const listener of listeners.current) {
-                    listener(example.data, example.encoded);
-                }
-            },
-            examples,
-            setExampleData: (data, encoded) => {
-                for (const item of examples) {
-                    if (item.id === example) {
-                        // persistent changes
-                        item.data = data;
-                        item.encoded = encoded;
-                        break;
-                    }
-                }
-                for (const listener of listeners.current) {
-                    listener(data, encoded);
-                }
-            },
-            removeListener: (listener) => {
-                listeners.current = listeners.current.filter((item) => item !== listener);
-            },
-            addListener: (listener) => {
-                // initial call to listeners to ensure their data is the latest
-                // this is necessary to avoid race conditions between `useEffect()`
-                const active = examples.find((item) => item.id === example);
-                listener(active.data, active.encoded);
-                listeners.current.push(listener);
-            },
-        }), [example, route, examples]), children: children }));
-}
-export function useOperationContext() {
-    return use(OperationContext);
-}

package/dist/ui/contexts/operation.lazy.d.ts

@@ -1,2 +0,0 @@
-export declare const OperationProviderLazy: typeof import("./operation.js").OperationProvider;
-//# sourceMappingURL=operation.lazy.d.ts.map

package/dist/ui/contexts/operation.lazy.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"operation.lazy.d.ts","sourceRoot":"","sources":["../../../src/ui/contexts/operation.lazy.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,qBAAqB,gDAEjC,CAAC"}

package/dist/ui/contexts/operation.lazy.js

@@ -1,3 +0,0 @@
-'use client';
-import { wrapLazy } from '../../utils/lazy.js';
-export const OperationProviderLazy = wrapLazy(() => import('./operation.js').then((mod) => ({ default: mod.OperationProvider })));

package/dist/ui/operation/example-panel/client.d.ts

@@ -1,4 +0,0 @@
-import type { CodeUsageGenerator } from './index.js';
-export declare function APIExampleSelector(): import("react/jsx-runtime").JSX.Element | null;
-export declare function APIExampleUsageTab(sample: CodeUsageGenerator): import("react/jsx-runtime").JSX.Element | null;
-//# sourceMappingURL=client.d.ts.map

package/dist/ui/operation/example-panel/client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/ui/operation/example-panel/client.tsx"],"names":[],"mappings":"AAqBA,OAAO,KAAK,EAAkB,kBAAkB,EAAE,MAAM,GAAG,CAAC;AAE5D,wBAAgB,kBAAkB,mDAkCjC;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,kBAAkB,kDAkD5D"}

package/dist/ui/operation/example-panel/index.d.ts

@@ -1,58 +0,0 @@
-import type { MethodInformation, RenderContext, ResponseObject } from '../../../types.js';
-import type { ReactNode } from 'react';
-import { type NoReference } from '../../../utils/schema.js';
-import type { RawRequestData, RequestData, SampleGenerator } from '../../../requests/types.js';
-/**
- * Generate code example for given programming language
- */
-export interface CodeUsageGenerator<T = unknown> {
-    id: string;
-    lang: string;
-    label?: string;
-    /**
-     * either:
-     * - code
-     * - a function imported from a file with "use client" directive
-     * - false (disabled)
-     */
-    source?: string | SampleGenerator<T> | false;
-    /**
-     * Pass extra context to client-side source generator
-     */
-    serverContext?: T;
-}
-export interface APIExampleItem {
-    id: string;
-    name: string;
-    description?: string;
-    data: RawRequestData;
-    encoded: RequestData;
-}
-export interface ResponseTab {
-    /**
-     * HTTP response code
-     */
-    code: string;
-    response: NoReference<ResponseObject>;
-    /**
-     * media type of response
-     */
-    mediaType: string | null;
-    examples?: {
-        /**
-         * generated/defined example data
-         */
-        sample: unknown;
-        label: string;
-        /**
-         * description (in Markdown)
-         */
-        description?: string;
-    }[];
-}
-export declare function getAPIExamples(path: string, method: MethodInformation, ctx: RenderContext): APIExampleItem[];
-export declare function APIExample({ method, ctx, }: {
-    method: MethodInformation;
-    ctx: RenderContext;
-}): Promise<import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | (string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined)>;
-//# sourceMappingURL=index.d.ts.map

package/dist/ui/operation/example-panel/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/ui/operation/example-panel/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAChF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EAAoB,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAGpE,OAAO,KAAK,EACV,cAAc,EACd,WAAW,EACX,eAAe,EAChB,MAAM,kBAAkB,CAAC;AAmB1B;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,OAAO;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,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;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,QAAQ,CAAC,EAAE;QACT;;WAEG;QACH,MAAM,EAAE,OAAO,CAAC;QAEhB,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,EAAE,CAAC;CACL;AAED,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,iBAAiB,EACzB,GAAG,EAAE,aAAa,GACjB,cAAc,EAAE,CA0ClB;AAED,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EACN,GAAG,GACJ,EAAE;IACD,MAAM,EAAE,iBAAiB,CAAC;IAC1B,GAAG,EAAE,aAAa,CAAC;CACpB,wUAmEA"}

package/dist/ui/operation/example-panel/index.js

@@ -1,140 +0,0 @@
-import { jsxs as _jsxs, jsx as _jsx, Fragment as _Fragment } from "react/jsx-runtime";
-import { getPreferredType } from '../../../utils/schema.js';
-import { getRequestData } from '../../../ui/operation/get-request-data.js';
-import { sample } from 'openapi-sampler';
-import { defaultSamples } from '../../../requests/generators/index.js';
-import { encodeRequestData } from '../../../requests/media/encode.js';
-import { AccordionContent, AccordionHeader, AccordionItem, Accordions, AccordionTrigger, } from '../../../ui/components/accordion.js';
-import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
-import { CodeBlockTab, CodeBlockTabs, CodeBlockTabsList, CodeBlockTabsTrigger, } from 'fumadocs-ui/components/codeblock';
-import { APIExampleSelectorLazy, APIExampleUsageTabLazy } from './lazy.js';
-export function getAPIExamples(path, method, ctx) {
-    const media = method.requestBody
-        ? getPreferredType(method.requestBody.content)
-        : null;
-    const bodyOfType = media ? method.requestBody?.content[media] : null;
-    if (bodyOfType?.examples) {
-        const result = [];
-        for (const [key, value] of Object.entries(bodyOfType.examples)) {
-            const data = getRequestData(path, method, key, ctx);
-            result.push({
-                id: key,
-                name: value.summary ?? key,
-                description: value.description,
-                data,
-                encoded: encodeRequestData(data, ctx.mediaAdapters, method.parameters ?? []),
-            });
-        }
-        if (result.length > 0)
-            return result;
-    }
-    const data = getRequestData(path, method, null, ctx);
-    return [
-        {
-            id: '_default',
-            name: 'Default',
-            description: bodyOfType?.schema?.description,
-            data,
-            encoded: encodeRequestData(data, ctx.mediaAdapters, method.parameters ?? []),
-        },
-    ];
-}
-export async function APIExample({ method, ctx, }) {
-    let { renderAPIExampleUsageTabs, renderAPIExampleLayout } = ctx.content ?? {};
-    renderAPIExampleLayout ?? (renderAPIExampleLayout = (slots) => {
-        return (_jsxs("div", { className: "prose-no-margin md:sticky md:top-(--fd-api-info-top) xl:w-[400px]", children: [slots.selector, slots.usageTabs, slots.responseTabs] }));
-    });
-    renderAPIExampleUsageTabs ?? (renderAPIExampleUsageTabs = (generators) => {
-        if (generators.length === 0)
-            return null;
-        return (_jsxs(CodeBlockTabs, { groupId: "fumadocs_openapi_requests", defaultValue: generators[0].id, children: [_jsx(CodeBlockTabsList, { children: generators.map((item) => (_jsx(CodeBlockTabsTrigger, { value: item.id, children: item.label ?? item.lang }, item.id))) }), generators.map((item) => (_jsx(CodeBlockTab, { value: item.id, children: _jsx(APIExampleUsageTabLazy, { ...item }) }, item.id)))] }));
-    });
-    let generators = [...defaultSamples];
-    if (ctx.generateCodeSamples) {
-        generators.push(...(await ctx.generateCodeSamples(method)));
-    }
-    if (method['x-codeSamples']) {
-        for (const sample of method['x-codeSamples']) {
-            generators.push('id' in sample && typeof sample.id === 'string'
-                ? sample
-                : {
-                    id: sample.lang,
-                    ...sample,
-                });
-        }
-    }
-    generators = dedupe(generators);
-    return renderAPIExampleLayout({
-        selector: method['x-exclusiveCodeSample'] ? null : (_jsx(APIExampleSelectorLazy, {})),
-        usageTabs: await renderAPIExampleUsageTabs(generators, ctx),
-        responseTabs: _jsx(ResponseTabs, { operation: method, ctx: ctx }),
-    }, ctx);
-}
-/**
- * Remove duplicated ids
- */
-function dedupe(samples) {
-    const set = new Set();
-    const out = [];
-    for (let i = samples.length - 1; i >= 0; i--) {
-        const item = samples[i];
-        if (set.has(item.id))
-            continue;
-        set.add(item.id);
-        if (item.source !== false)
-            out.unshift(item);
-    }
-    return out;
-}
-function ResponseTabs({ operation, ctx, }) {
-    if (!operation.responses)
-        return null;
-    const tabs = [];
-    for (const [code, response] of Object.entries(operation.responses)) {
-        const media = response.content ? getPreferredType(response.content) : null;
-        const responseOfType = media ? response.content?.[media] : null;
-        const tab = {
-            code,
-            response,
-            mediaType: media,
-        };
-        if (responseOfType?.examples) {
-            tab.examples ?? (tab.examples = []);
-            for (const [key, sample] of Object.entries(responseOfType.examples)) {
-                const title = sample?.summary ?? `Example ${key}`;
-                tab.examples.push({
-                    label: title,
-                    sample: sample.value,
-                    description: sample?.description,
-                });
-            }
-        }
-        else if (responseOfType?.example || responseOfType?.schema) {
-            tab.examples ?? (tab.examples = []);
-            tab.examples.push({
-                label: 'Example',
-                sample: responseOfType.example ?? sample(responseOfType.schema),
-            });
-        }
-        tabs.push(tab);
-    }
-    const { renderResponseTabs = renderResponseTabsDefault } = ctx.content ?? {};
-    return renderResponseTabs(tabs, ctx);
-}
-function renderResponseTabsDefault(tabs, ctx) {
-    async function renderResponse(tab) {
-        const { examples = [] } = tab;
-        let slot = 'Empty';
-        if (examples.length > 1) {
-            slot = (_jsx(Accordions, { type: "single", className: "pt-2", defaultValue: examples[0].label, children: examples.map((example, i) => (_jsxs(AccordionItem, { value: example.label, children: [_jsx(AccordionHeader, { children: _jsx(AccordionTrigger, { children: example.label }) }), _jsxs(AccordionContent, { className: "prose-no-margin", children: [example.description && ctx.renderMarkdown(example.description), ctx.renderCodeBlock('json', JSON.stringify(example.sample, null, 2))] })] }, i))) }));
-        }
-        else if (examples.length === 1) {
-            const example = examples[0];
-            slot = (_jsxs(_Fragment, { children: [example.description && ctx.renderMarkdown(example.description), ctx.renderCodeBlock('json', JSON.stringify(example.sample, null, 2))] }));
-        }
-        return _jsx(Tab, { value: tab.code, children: slot });
-    }
-    if (tabs.length === 0)
-        return null;
-    return (_jsx(Tabs, { groupId: "fumadocs_openapi_responses", items: tabs.map((tab) => tab.code), children: tabs.map(renderResponse) }));
-}

package/dist/ui/operation/example-panel/lazy.d.ts

@@ -1,3 +0,0 @@
-export declare const APIExampleSelectorLazy: typeof import("./client.js").APIExampleSelector;
-export declare const APIExampleUsageTabLazy: typeof import("./client.js").APIExampleUsageTab;
-//# sourceMappingURL=lazy.d.ts.map

package/dist/ui/operation/example-panel/lazy.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"lazy.d.ts","sourceRoot":"","sources":["../../../../src/ui/operation/example-panel/lazy.tsx"],"names":[],"mappings":"AAGA,eAAO,MAAM,sBAAsB,8CAElC,CAAC;AAEF,eAAO,MAAM,sBAAsB,8CAElC,CAAC"}

package/dist/ui/operation/example-panel/lazy.js

@@ -1,4 +0,0 @@
-'use client';
-import { wrapLazy } from '../../../utils/lazy.js';
-export const APIExampleSelectorLazy = wrapLazy(() => import('./client.js').then((mod) => ({ default: mod.APIExampleSelector })));
-export const APIExampleUsageTabLazy = wrapLazy(() => import('./client.js').then((mod) => ({ default: mod.APIExampleUsageTab })));

package/dist/ui/operation/get-request-data.d.ts

@@ -1,4 +0,0 @@
-import type { MethodInformation, RenderContext } from '../../types.js';
-import type { RawRequestData } from '../../requests/types.js';
-export declare function getRequestData(path: string, method: MethodInformation, sampleKey: string | null, _ctx: RenderContext): RawRequestData;
-//# sourceMappingURL=get-request-data.d.ts.map

package/dist/ui/operation/get-request-data.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-request-data.d.ts","sourceRoot":"","sources":["../../../src/ui/operation/get-request-data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAIhE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,MAAM,GAAG,IAAI,EACxB,IAAI,EAAE,aAAa,GAClB,cAAc,CAwEhB"}

package/dist/ui/operation/get-request-data.js

@@ -1,70 +0,0 @@
-import { getPreferredType } from '../../utils/schema.js';
-import { sample } from 'openapi-sampler';
-export function getRequestData(path, method, sampleKey, _ctx) {
-    const result = {
-        path: {},
-        cookie: {},
-        header: {},
-        query: {},
-        method: method.method,
-    };
-    for (const param of method.parameters ?? []) {
-        let schema = param.schema;
-        let value;
-        if (!schema && param.content) {
-            const type = getPreferredType(param.content);
-            const content = type ? param.content[type] : undefined;
-            if (!content || !content.schema)
-                throw new Error(`Cannot find parameter schema for ${param.name} in ${path} ${method.method}`);
-            schema = content.schema;
-            value = content.example ?? param.example;
-        }
-        else {
-            value = param.example;
-        }
-        if (param.required) {
-            value ?? (value = sample(schema));
-        }
-        else if (value === undefined) {
-            continue;
-        }
-        switch (param.in) {
-            case 'cookie':
-                result.cookie[param.name] = value;
-                break;
-            case 'header':
-                result.header[param.name] = value;
-                break;
-            case 'query':
-                result.query[param.name] = value;
-                break;
-            default:
-                result.path[param.name] = value;
-        }
-    }
-    if (method.requestBody) {
-        const body = method.requestBody.content;
-        const type = getPreferredType(body);
-        if (!type)
-            throw new Error(`Cannot find body schema for ${path} ${method.method}: missing media type`);
-        result.bodyMediaType = type;
-        const bodyOfType = body[type];
-        if (bodyOfType.examples && sampleKey) {
-            result.body = bodyOfType.examples[sampleKey].value;
-        }
-        else if (bodyOfType.example) {
-            result.body = bodyOfType.example;
-        }
-        else {
-            result.body = generateBody(method.method, (bodyOfType?.schema ?? {}));
-        }
-    }
-    return result;
-}
-function generateBody(method, schema) {
-    return sample(schema, {
-        skipReadOnly: method !== 'GET',
-        skipWriteOnly: method === 'GET',
-        skipNonRequired: true,
-    });
-}

package/dist/utils/combine-schema.d.ts

@@ -1,6 +0,0 @@
-import { type ParsedSchema } from '../utils/schema.js';
-/**
- * Combine multiple object schemas into one
- */
-export declare function combineSchema(schema: ParsedSchema[]): ParsedSchema;
-//# sourceMappingURL=combine-schema.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"combine-schema.d.ts","sourceRoot":"","sources":["../../src/utils/combine-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,YAAY,CAuDlE"}

package/dist/utils/combine-schema.js

@@ -1,51 +0,0 @@
-/**
- * Combine multiple object schemas into one
- */
-export function combineSchema(schema) {
-    let result = {};
-    const types = new Set();
-    const title = new Set();
-    function add(s) {
-        if (typeof s === 'boolean') {
-            result = s;
-            return;
-        }
-        if (typeof result === 'boolean')
-            return;
-        if (s.title)
-            title.add(s.title);
-        if (s.type) {
-            for (const v of Array.isArray(s.type) ? s.type : [s.type]) {
-                types.add(v);
-            }
-        }
-        for (const key of ['oneOf', 'required', 'enum']) {
-            if (!s[key])
-                continue;
-            result[key] = [...s[key], ...(result[key] ?? [])];
-        }
-        for (const key of ['properties', 'patternProperties']) {
-            if (!s[key])
-                continue;
-            result[key] ?? (result[key] = {});
-            Object.assign(result[key], s[key]);
-        }
-        if (s.additionalProperties === true) {
-            result.additionalProperties = true;
-        }
-        else if (s.additionalProperties &&
-            typeof result.additionalProperties !== 'boolean') {
-            result.additionalProperties ?? (result.additionalProperties = {});
-            Object.assign(result.additionalProperties, s.additionalProperties);
-        }
-        (s.allOf ?? s.anyOf)?.forEach(add);
-    }
-    schema.forEach(add);
-    if (title.size > 0)
-        result.title = Array.from(title).join(' & ');
-    if (types.size > 0) {
-        const typeArr = Array.from(types.values());
-        result.type = typeArr.length === 1 ? typeArr[0] : typeArr;
-    }
-    return result;
-}