fumadocs-openapi 6.3.0 → 7.0.0-beta.0

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

@@ -0,0 +1,5 @@
+'use client';
+import dynamic from 'next/dynamic';
+export const CodeExampleProvider = dynamic(() => import('./code-example.js').then((mod) => mod.CodeExampleProvider));
+export const CodeExample = dynamic(() => import('./code-example.js').then((mod) => mod.CodeExample));
+export const CodeExampleSelector = dynamic(() => import('./code-example.js').then((mod) => mod.CodeExampleSelector));

package/dist/ui/server-select.d.ts

@@ -1,3 +1,8 @@
+import { type SelectedServer } from '../ui/contexts/api.js';
 import type { HTMLAttributes } from 'react';
-export default function ServerSelect(props: HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element | null;
+export default function ServerSelect({ server, onServerChanged, onVariablesChanged, ...props }: HTMLAttributes<HTMLDivElement> & {
+    server: SelectedServer | null;
+    onServerChanged: (value: string) => void;
+    onVariablesChanged: (value: Record<string, string>) => void;
+}): import("react/jsx-runtime").JSX.Element | null;
 //# sourceMappingURL=server-select.d.ts.map

package/dist/ui/server-select.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server-select.d.ts","sourceRoot":"","sources":["../../src/ui/server-select.tsx"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAG5C,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,KAAK,EAAE,cAAc,CAAC,cAAc,CAAC,kDA6EzE"}
+{"version":3,"file":"server-select.d.ts","sourceRoot":"","sources":["../../src/ui/server-select.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,cAAc,EAAiB,MAAM,mBAAmB,CAAC;AASvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAG5C,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,EACnC,MAAM,EACN,eAAe,EACf,kBAAkB,EAClB,GAAG,KAAK,EACT,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG;IAClC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAC9B,eAAe,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,kBAAkB,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;CAC7D,kDA4EA"}

package/dist/ui/server-select.js

@@ -1,25 +1,24 @@
 'use client';
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { useApiContext, useServerSelectContext } from '../ui/contexts/api.js';
+import { useApiContext } from '../ui/contexts/api.js';
 import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue, } from '../ui/components/select.js';
 import { Input, labelVariants } from '../ui/components/input.js';
 import { cn } from 'fumadocs-ui/components/api';
-export default function ServerSelect(props) {
+export default function ServerSelect({ server, onServerChanged, onVariablesChanged, ...props }) {
     const { servers } = useApiContext();
-    const { server, setServer, setServerVariables } = useServerSelectContext();
     if (servers.length <= 1)
         return null;
     const schema = server
         ? servers.find((item) => item.url === server.url)
-        : undefined;
-    return (_jsxs("div", { ...props, className: cn('flex flex-col gap-4', props.className), children: [_jsxs(Select, { value: server?.url, onValueChange: setServer, children: [_jsx(SelectTrigger, { className: "h-auto break-all", children: _jsx(SelectValue, {}) }), _jsx(SelectContent, { children: servers.map((item) => (_jsxs(SelectItem, { value: item.url, children: [item.url, _jsx("p", { className: "text-start text-fd-muted-foreground", children: item.description })] }, item.url))) })] }), Object.entries(schema?.variables ?? {}).map(([key, variable]) => {
+        : null;
+    return (_jsxs("div", { ...props, className: cn('flex flex-col gap-4', props.className), children: [_jsxs(Select, { value: server?.url, onValueChange: onServerChanged, children: [_jsx(SelectTrigger, { className: "h-auto break-all", children: _jsx(SelectValue, {}) }), _jsx(SelectContent, { children: servers.map((item) => (_jsxs(SelectItem, { value: item.url, children: [item.url, _jsx("p", { className: "text-start text-fd-muted-foreground", children: item.description })] }, item.url))) })] }), Object.entries(schema?.variables ?? {}).map(([key, variable]) => {
                 if (!server)
                     return;
                 const id = `fd_server_select_${key}`;
-                return (_jsxs("fieldset", { className: "flex flex-col gap-1", children: [_jsx("label", { className: cn(labelVariants()), htmlFor: id, children: key }), _jsx("p", { className: "text-xs text-fd-muted-foreground empty:hidden", children: variable.description }), variable.enum ? (_jsxs(Select, { value: server.variables[key], onValueChange: (v) => setServerVariables({
+                return (_jsxs("fieldset", { className: "flex flex-col gap-1", children: [_jsx("label", { className: cn(labelVariants()), htmlFor: id, children: key }), _jsx("p", { className: "text-xs text-fd-muted-foreground empty:hidden", children: variable.description }), variable.enum ? (_jsxs(Select, { value: server.variables[key], onValueChange: (v) => onVariablesChanged({
                                 ...server?.variables,
                                 [key]: v,
-                            }), children: [_jsx(SelectTrigger, { id: id, children: _jsx(SelectValue, {}) }), _jsx(SelectContent, { children: variable.enum.map((value) => (_jsx(SelectItem, { value: value, children: value }, value))) })] })) : (_jsx(Input, { id: id, value: server.variables[key], onChange: (e) => setServerVariables({
+                            }), children: [_jsx(SelectTrigger, { id: id, children: _jsx(SelectValue, {}) }), _jsx(SelectContent, { children: variable.enum.map((value) => (_jsx(SelectItem, { value: value, children: value }, value))) })] })) : (_jsx(Input, { id: id, value: server.variables[key], onChange: (e) => onVariablesChanged({
                                 ...server?.variables,
                                 [key]: e.target.value,
                             }) }))] }, key));

package/dist/utils/get-pathname-from-input.d.ts

@@ -0,0 +1,2 @@
+export declare function getPathnameFromInput(url: string, path: Record<string, unknown>, query: Record<string, unknown>): string;
+//# sourceMappingURL=get-pathname-from-input.d.ts.map

package/dist/utils/get-pathname-from-input.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-pathname-from-input.d.ts","sourceRoot":"","sources":["../../src/utils/get-pathname-from-input.ts"],"names":[],"mappings":"AAAA,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,MAAM,CAkBR"}

package/dist/utils/get-pathname-from-input.js

@@ -0,0 +1,15 @@
+export function getPathnameFromInput(url, path, query) {
+    let pathname = url;
+    for (const key in path) {
+        const paramValue = path[key];
+        if (typeof paramValue === 'string' && paramValue.length > 0)
+            pathname = pathname.replace(`{${key}}`, paramValue);
+    }
+    const searchParams = new URLSearchParams();
+    for (const key in query) {
+        const paramValue = query[key];
+        if (typeof paramValue === 'string' && paramValue.length > 0)
+            searchParams.append(key, paramValue);
+    }
+    return searchParams.size > 0 ? `${pathname}?${searchParams}` : pathname;
+}

package/dist/utils/get-typescript-schema.d.ts

@@ -1,4 +1,3 @@
-import type { EndpointSample } from '../utils/generate-sample.js';
-import { DereferenceMap } from '../types.js';
-export declare function getTypescriptSchema(endpoint: EndpointSample, code: string, dereferenceMap: DereferenceMap): Promise<string | undefined>;
+import type { DereferenceMap } from '../types.js';
+export declare function getTypescriptSchema(schema: object, dereferenceMap: DereferenceMap): Promise<string | undefined>;
 //# sourceMappingURL=get-typescript-schema.d.ts.map

package/dist/utils/get-typescript-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-typescript-schema.d.ts","sourceRoot":"","sources":["../../src/utils/get-typescript-schema.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,wBAAsB,mBAAmB,CACvC,QAAQ,EAAE,cAAc,EACxB,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAmB7B"}
+{"version":3,"file":"get-typescript-schema.d.ts","sourceRoot":"","sources":["../../src/utils/get-typescript-schema.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAgB7B"}

package/dist/utils/get-typescript-schema.js

@@ -1,18 +1,15 @@
 import { compile } from '@fumari/json-schema-to-typescript';
-export async function getTypescriptSchema(endpoint, code, dereferenceMap) {
-    if (code in endpoint.responses) {
-        return compile(
-        // re-running on the same schema results in error
-        // because it uses `defineProperty` to define internal references
-        // we clone the schema to fix this problem
-        // @ts-expect-error any types
-        endpoint.responses[code].schema, 'Response', {
-            $refOptions: false,
-            schemaToId: dereferenceMap,
-            bannerComment: '',
-            additionalProperties: false,
-            format: true,
-            enableConstEnums: false,
-        });
-    }
+export async function getTypescriptSchema(schema, dereferenceMap) {
+    return compile(
+    // re-running on the same schema results in error
+    // because it uses `defineProperty` to define internal references
+    // we clone the schema to fix this problem
+    schema, 'Response', {
+        $refOptions: false,
+        schemaToId: dereferenceMap,
+        bannerComment: '',
+        additionalProperties: false,
+        format: true,
+        enableConstEnums: false,
+    });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "6.3.0",
+  "version": "7.0.0-beta.0",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",
@@ -62,16 +62,16 @@
     "remark-rehype": "^11.1.1",
     "shiki": "^3.1.0",
     "xml-js": "^1.6.11",
-    "fumadocs-core": "15.0.15",
-    "fumadocs-ui": "15.0.15"
+    "fumadocs-ui": "15.0.15",
+    "fumadocs-core": "15.0.15"
   },
   "devDependencies": {
-    "@scalar/api-client-react": "^1.1.33",
+    "@scalar/api-client-react": "^1.1.35",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "22.13.8",
+    "@types/node": "22.13.9",
     "@types/openapi-sampler": "^1.0.3",
     "@types/react": "^19.0.10",
-    "next": "15.2.0",
+    "next": "15.2.1",
     "openapi-types": "^12.1.3",
     "tailwindcss": "^4.0.9",
     "tsc-alias": "^1.8.11",

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

@@ -1 +0,0 @@
-{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../src/render/operation.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,YAAY,EAAkB,MAAM,OAAO,CAAC;AACpE,OAAO,EAAkB,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9E,OAAO,KAAK,EAEV,iBAAiB,EAEjB,aAAa,EAEd,MAAM,SAAS,CAAC;AAYjB,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EACF,MAAM,GACN,CAAC,CAAC,QAAQ,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC,GACtE,KAAK,CAAC;CACX;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,CAkLf"}

package/dist/ui/sample-select.d.ts

@@ -1,4 +0,0 @@
-import type { SampleProps, SamplesProps } from '../render/renderer.js';
-export declare function Samples({ items, defaultValue, children, }: SamplesProps): import("react/jsx-runtime").JSX.Element;
-export declare function Sample({ value, children }: SampleProps): import("react").ReactNode;
-//# sourceMappingURL=sample-select.d.ts.map

package/dist/ui/sample-select.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sample-select.d.ts","sourceRoot":"","sources":["../../src/ui/sample-select.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAWnE,wBAAgB,OAAO,CAAC,EACtB,KAAK,EACL,YAA6B,EAC7B,QAAQ,GACT,EAAE,YAAY,2CA0Bd;AAWD,wBAAgB,MAAM,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,WAAW,6BAKtD"}

package/dist/ui/sample-select.js

@@ -1,19 +0,0 @@
-import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
-import { createContext, use, useState } from 'react';
-import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue, } from '../ui/components/select.js';
-const ActiveSampleContext = createContext('');
-export function Samples({ items, defaultValue = items[0].value, children, }) {
-    const [value, setValue] = useState('');
-    const active = value === '' ? defaultValue : value;
-    const defaultItem = items.find((item) => item.value === defaultValue);
-    return (_jsxs(_Fragment, { children: [_jsxs(Select, { value: value, onValueChange: setValue, children: [_jsx(SelectTrigger, { className: "not-prose mb-2", children: _jsx(SelectValue, { placeholder: defaultItem ? _jsx(SelectDisplay, { ...defaultItem }) : null }) }), _jsx(SelectContent, { children: items.map((item) => (_jsx(SelectItem, { value: item.value, children: _jsx(SelectDisplay, { ...item }) }, item.value))) })] }), _jsx(ActiveSampleContext, { value: active, children: children })] }));
-}
-function SelectDisplay(item) {
-    return (_jsxs(_Fragment, { children: [_jsx("span", { className: "font-medium text-sm", children: item.title }), _jsx("span", { className: "text-fd-muted-foreground", children: item.description })] }));
-}
-export function Sample({ value, children }) {
-    const active = use(ActiveSampleContext);
-    if (value !== active)
-        return;
-    return children;
-}

package/dist/utils/generate-sample.d.ts

@@ -1,40 +0,0 @@
-import type { MethodInformation, RenderContext } from '../types.js';
-import { type ParsedSchema, type NoReference } from '../utils/schema.js';
-import type { OpenAPIV3_1 } from 'openapi-types';
-export type Samples = {
-    [key in '_default' | (string & {})]?: {
-        value?: unknown;
-        description?: string;
-        summary?: string;
-        externalValue?: string;
-    };
-};
-/**
- * Sample info of endpoint
- */
-export interface EndpointSample {
-    /**
-     * Request URL, including path and query parameters
-     */
-    url: string;
-    method: string;
-    body?: {
-        schema: ParsedSchema;
-        mediaType: string;
-        samples: Samples;
-    };
-    responses: Record<string, ResponseSample>;
-    parameters: ParameterSample[];
-}
-interface ResponseSample {
-    mediaType: string;
-    samples: Samples;
-    schema: ParsedSchema;
-}
-interface ParameterSample extends NoReference<OpenAPIV3_1.ParameterObject> {
-    sample: unknown;
-    isAuthOnly: boolean;
-}
-export declare function generateSample(path: string, method: MethodInformation, { baseUrl, schema: { document } }: RenderContext): EndpointSample;
-export {};
-//# sourceMappingURL=generate-sample.d.ts.map

package/dist/utils/generate-sample.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate-sample.d.ts","sourceRoot":"","sources":["../../src/utils/generate-sample.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAChE,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,WAAW,EACjB,MAAM,gBAAgB,CAAC;AAExB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,MAAM,MAAM,OAAO,GAAG;KACnB,GAAG,IAAI,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE;QACpC,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE;QACL,MAAM,EAAE,YAAY,CAAC;QACrB,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;IACF,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC1C,UAAU,EAAE,eAAe,EAAE,CAAC;CAC/B;AAED,UAAU,cAAc;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;CACtB;AAED,UAAU,eAAgB,SAAQ,WAAW,CAAC,WAAW,CAAC,eAAe,CAAC;IACxE,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,iBAAiB,EACzB,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,aAAa,GAC/C,cAAc,CA0HhB"}

package/dist/utils/generate-sample.js

@@ -1,109 +0,0 @@
-import { sample } from 'openapi-sampler';
-import { getPreferredType, } from '../utils/schema.js';
-import { getSecurities, getSecurityPrefix } from '../utils/get-security.js';
-export function generateSample(path, method, { baseUrl, schema: { document } }) {
-    const params = [];
-    const responses = {};
-    for (const param of method.parameters ?? []) {
-        let schema = param.schema, value;
-        if (!schema && param.content) {
-            const key = getPreferredType(param.content);
-            const content = key ? param.content[key] : undefined;
-            if (!content)
-                throw new Error(`Cannot find parameter schema for ${param.name} in ${path} ${method.method}`);
-            schema = content.schema;
-            value = content.example ?? param.example ?? sample(schema);
-        }
-        else {
-            value = param.example ?? sample(schema);
-        }
-        if (schema?.type && param.schema?.type === value) {
-            // if no example is defined make sure its visible that there is still a placeholder, equal to auth <token>
-            value = `<${value}>`;
-        }
-        params.push({
-            ...param,
-            sample: value,
-            isAuthOnly: false,
-        });
-    }
-    const requirements = method.security ?? document.security;
-    if (requirements && requirements.length > 0) {
-        for (const security of getSecurities(requirements[0], document)) {
-            const prefix = getSecurityPrefix(security);
-            params.push({
-                name: security.type === 'apiKey' ? security.name : 'Authorization',
-                schema: {
-                    type: 'string',
-                },
-                sample: prefix ? `${prefix} <token>` : '<token>',
-                in: 'header',
-                isAuthOnly: true,
-            });
-        }
-    }
-    let bodyOutput;
-    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`);
-        const schema = (type ? body[type].schema : undefined) ?? {};
-        bodyOutput = {
-            schema,
-            mediaType: type,
-            samples: body[type].examples
-                ? body[type].examples
-                : {
-                    _default: {
-                        value: body[type].example ?? generateBody(method.method, schema),
-                    },
-                },
-        };
-    }
-    for (const [code, response] of Object.entries(method.responses ?? {})) {
-        const content = response.content;
-        if (!content)
-            continue;
-        const mediaType = getPreferredType(content);
-        if (!mediaType)
-            continue;
-        const responseSchema = content[mediaType].schema;
-        if (!responseSchema)
-            continue;
-        const examples = content[mediaType].examples ?? content.examples;
-        const example = content[mediaType].example ?? content.example;
-        responses[code] = {
-            mediaType,
-            samples: examples
-                ? examples
-                : {
-                    _default: example ?? generateBody(method.method, responseSchema),
-                },
-            schema: responseSchema,
-        };
-    }
-    let pathWithParameters = path;
-    const queryParams = new URLSearchParams();
-    for (const param of params) {
-        if (param.in === 'query')
-            queryParams.append(param.name, String(param.sample));
-        if (param.in === 'path')
-            pathWithParameters = pathWithParameters.replace(`{${param.name}}`, String(param.sample));
-    }
-    if (queryParams.size > 0)
-        pathWithParameters = `${pathWithParameters}?${queryParams.toString()}`;
-    return {
-        url: `${baseUrl}${pathWithParameters}`,
-        body: bodyOutput,
-        responses,
-        method: method.method,
-        parameters: params,
-    };
-}
-function generateBody(method, schema) {
-    return sample(schema, {
-        skipReadOnly: method !== 'GET',
-        skipWriteOnly: method === 'GET',
-    });
-}