fumadocs-openapi 9.7.2 → 10.0.0

package/dist/ui/contexts/api.d.ts

@@ -1,22 +1,22 @@
-import { type ReactNode } from 'react';
-import type { RenderContext, ServerObject } from '../../types.js';
+import { type ReactNode, type RefObject } from 'react';
+import type { RenderContext } from '../../types.js';
 import { type MediaAdapter } from '../../requests/media/adapter.js';
-import type { NoReference } from '../../utils/schema.js';
-export interface ApiProviderProps extends Omit<ApiContextType, 'mediaAdapters'> {
+type InheritFromContext = Pick<Required<RenderContext>, 'servers' | 'client'> & Pick<RenderContext, 'shikiOptions'>;
+export interface ApiProviderProps extends InheritFromContext {
     /**
      * Base URL for API requests
      */
     defaultBaseUrl?: string;
-    children?: ReactNode;
-    mediaAdapters?: Record<string, MediaAdapter>;
 }
 export interface SelectedServer {
     url: string;
     variables: Record<string, string>;
 }
-interface ApiContextType {
-    servers: NoReference<ServerObject>[];
-    shikiOptions: RenderContext['shikiOptions'];
+interface ApiContextType extends InheritFromContext {
+    /**
+     * ref to selected API server (to query)
+     */
+    serverRef: RefObject<SelectedServer | null>;
     mediaAdapters: Record<string, MediaAdapter>;
 }
 interface ServerSelectType {
@@ -26,6 +26,8 @@ interface ServerSelectType {
 }
 export declare function useApiContext(): ApiContextType;
 export declare function useServerSelectContext(): ServerSelectType;
-export declare function ApiProvider({ defaultBaseUrl, children, servers, mediaAdapters, shikiOptions, }: ApiProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function ApiProvider({ defaultBaseUrl, children, servers, shikiOptions, client, }: ApiProviderProps & {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
 export {};
 //# sourceMappingURL=api.d.ts.map

package/dist/ui/contexts/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/ui/contexts/api.tsx"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,SAAS,EAKf,MAAM,OAAO,CAAC;AACf,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC3D,OAAO,EAAmB,KAAK,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC9E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD,MAAM,WAAW,gBACf,SAAQ,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC;IAC7C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,UAAU,cAAc;IACtB,OAAO,EAAE,WAAW,CAAC,YAAY,CAAC,EAAE,CAAC;IACrC,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAC5C,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CAC7C;AAED,UAAU,gBAAgB;IACxB,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAC9B,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,kBAAkB,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;CAC7D;AAKD,wBAAgB,aAAa,IAAI,cAAc,CAK9C;AAED,wBAAgB,sBAAsB,IAAI,gBAAgB,CAKzD;AAED,wBAAgB,WAAW,CAAC,EAC1B,cAAc,EACd,QAAQ,EACR,OAAO,EACP,aAAa,EACb,YAAY,GACb,EAAE,gBAAgB,2CA2ElB"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/ui/contexts/api.tsx"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,SAAS,EACd,KAAK,SAAS,EAMf,MAAM,OAAO,CAAC;AACf,OAAO,KAAK,EAAE,aAAa,EAAgB,MAAM,SAAS,CAAC;AAC3D,OAAO,EAAmB,KAAK,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAI9E,KAAK,kBAAkB,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC,GAC3E,IAAI,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;AAEtC,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB;IAC1D;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,UAAU,cAAe,SAAQ,kBAAkB;IACjD;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAE5C,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CAC7C;AAED,UAAU,gBAAgB;IACxB,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAC9B,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,kBAAkB,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;CAC7D;AAKD,wBAAgB,aAAa,IAAI,cAAc,CAK9C;AAED,wBAAgB,sBAAsB,IAAI,gBAAgB,CAKzD;AAED,wBAAgB,WAAW,CAAC,EAC1B,cAAc,EACd,QAAQ,EACR,OAAO,EACP,YAAY,EACZ,MAAM,GACP,EAAE,gBAAgB,GAAG;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,2CAwB5C"}

package/dist/ui/contexts/api.js

@@ -1,26 +1,42 @@
 'use client';
 import { jsx as _jsx } from "react/jsx-runtime";
-import { createContext, useContext, useEffect, useMemo, useState, } from 'react';
+import { createContext, use, useEffect, useMemo, useRef, useState, } from 'react';
 import { defaultAdapters } from '../../requests/media/adapter.js';
+import { useStorageKey } from '../client/storage-key.js';
 const ApiContext = createContext(null);
 const ServerSelectContext = createContext(null);
 export function useApiContext() {
-    const ctx = useContext(ApiContext);
+    const ctx = use(ApiContext);
     if (!ctx)
         throw new Error('Component must be used under <ApiProvider />');
     return ctx;
 }
 export function useServerSelectContext() {
-    const ctx = useContext(ServerSelectContext);
+    const ctx = use(ServerSelectContext);
     if (!ctx)
         throw new Error('Component must be used under <ApiProvider />');
     return ctx;
 }
-export function ApiProvider({ defaultBaseUrl, children, servers, mediaAdapters, shikiOptions, }) {
+export function ApiProvider({ defaultBaseUrl, children, servers, shikiOptions, client, }) {
+    const serverRef = useRef(null);
+    return (_jsx(ApiContext, { value: useMemo(() => ({
+            serverRef,
+            shikiOptions,
+            client,
+            mediaAdapters: {
+                ...defaultAdapters,
+                ...client.mediaAdapters,
+            },
+            servers,
+        }), [servers, client, shikiOptions]), children: _jsx(ServerSelectProvider, { defaultBaseUrl: defaultBaseUrl, children: children }) }));
+}
+function ServerSelectProvider({ defaultBaseUrl, children, }) {
+    const { servers, serverRef } = useApiContext();
+    const storageKeys = useStorageKey();
     const [server, setServer] = useState(() => {
         const defaultItem = defaultBaseUrl
             ? servers.find((item) => item.url === defaultBaseUrl)
-            : servers.at(0);
+            : servers[0];
         return defaultItem
             ? {
                 url: defaultItem.url,
@@ -28,8 +44,9 @@ export function ApiProvider({ defaultBaseUrl, children, servers, mediaAdapters,
             }
             : null;
     });
+    serverRef.current = server;
     useEffect(() => {
-        const cached = localStorage.getItem('apiBaseUrl');
+        const cached = localStorage.getItem(storageKeys.of('server-url'));
         if (!cached)
             return;
         try {
@@ -41,38 +58,37 @@ export function ApiProvider({ defaultBaseUrl, children, servers, mediaAdapters,
         catch {
             // ignore
         }
-    }, []);
-    return (_jsx(ApiContext.Provider, { value: useMemo(() => ({
-            shikiOptions,
-            mediaAdapters: {
-                ...defaultAdapters,
-                ...mediaAdapters,
+    }, [storageKeys]);
+    return (_jsx(ServerSelectContext, { value: useMemo(() => ({
+            server,
+            setServerVariables(variables) {
+                setServer((prev) => {
+                    if (!prev)
+                        return null;
+                    const updated = { ...prev, variables };
+                    localStorage.setItem(storageKeys.of('server-url'), JSON.stringify(updated));
+                    return updated;
+                });
             },
-            servers,
-        }), [mediaAdapters, servers, shikiOptions]), children: _jsx(ServerSelectContext.Provider, { value: useMemo(() => ({
-                server,
-                setServerVariables(variables) {
-                    setServer((prev) => {
-                        if (!prev)
-                            return null;
-                        const updated = { ...prev, variables };
-                        localStorage.setItem('apiBaseUrl', JSON.stringify(updated));
-                        return updated;
-                    });
-                },
-                setServer(value) {
-                    const obj = servers.find((item) => item.url === value);
-                    if (!obj)
-                        return;
-                    const result = {
-                        url: value,
-                        variables: getDefaultValues(obj),
-                    };
-                    localStorage.setItem('apiBaseUrl', JSON.stringify(result));
-                    setServer(result);
-                },
-            }), [server, servers]), children: children }) }));
+            setServer(value) {
+                const obj = servers.find((item) => item.url === value);
+                if (!obj)
+                    return;
+                const result = {
+                    url: value,
+                    variables: getDefaultValues(obj),
+                };
+                localStorage.setItem(storageKeys.of('server-url'), JSON.stringify(result));
+                setServer(result);
+            },
+        }), [server, servers, storageKeys]), children: children }));
 }
 function getDefaultValues(server) {
-    return Object.fromEntries(Object.entries(server.variables ?? {}).map(([k, v]) => [k, v.default]));
+    const out = {};
+    if (!server.variables)
+        return out;
+    for (const [k, v] of Object.entries(server.variables)) {
+        out[k] = v.default;
+    }
+    return out;
 }

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

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

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

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

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

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

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

@@ -0,0 +1,20 @@
+import { type ReactNode } from 'react';
+import type { APIExampleItem } from '../../ui/operation/example-panel/index.js';
+import type { RawRequestData, RequestData } from '../../requests/types.js';
+export type ExampleUpdateListener = (data: RawRequestData, encoded: RequestData) => void;
+export declare function OperationProvider({ route, examples, defaultExampleId, children, }: {
+    route: string;
+    examples: APIExampleItem[];
+    defaultExampleId?: string;
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function useOperationContext(): {
+    route: string;
+    examples: APIExampleItem[];
+    example: string | undefined;
+    setExample: (id: string) => void;
+    setExampleData: (data: RawRequestData, encoded: RequestData) => void;
+    addListener: (listener: ExampleUpdateListener) => void;
+    removeListener: (listener: ExampleUpdateListener) => void;
+};
+//# sourceMappingURL=operation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../src/ui/contexts/operation.tsx"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,SAAS,EAKf,MAAM,OAAO,CAAC;AACf,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpE,MAAM,MAAM,qBAAqB,GAAG,CAClC,IAAI,EAAE,cAAc,EACpB,OAAO,EAAE,WAAW,KACjB,IAAI,CAAC;AAaV,wBAAgB,iBAAiB,CAAC,EAChC,KAAK,EACL,QAAQ,EACR,gBAAgB,EAChB,QAAQ,GACT,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,SAAS,CAAC;CACrB,2CAwDA;AAED,wBAAgB,mBAAmB;WA9E1B,MAAM;cACH,cAAc,EAAE;aACjB,MAAM,GAAG,SAAS;gBACf,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI;oBAChB,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,WAAW,KAAK,IAAI;iBAEvD,CAAC,QAAQ,EAAE,qBAAqB,KAAK,IAAI;oBACtC,CAAC,QAAQ,EAAE,qBAAqB,KAAK,IAAI;EAyE1D"}

package/dist/ui/contexts/operation.js

@@ -0,0 +1,48 @@
+'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

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

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

@@ -0,0 +1 @@
+{"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

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

package/dist/ui/index.d.ts

@@ -1,9 +1,2 @@
-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 APIExample(props: HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
-export { Property, ObjectCollapsible } from '../render/schema/ui.js';
-export { APIPage, type ApiPageProps } from '../render/api-page.js';
+export * from '../ui/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,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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ui/index.tsx"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/dist/ui/index.js

@@ -1,26 +1 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-import { ApiProvider } from '../ui/lazy.js';
-import { cn } from 'fumadocs-ui/utils/cn';
-export function Root({ children, className, ctx, ...props }) {
-    const mediaAdapters = {};
-    for (const k in ctx.mediaAdapters) {
-        const adapter = ctx.mediaAdapters[k];
-        if (adapter.client)
-            mediaAdapters[k] = adapter.client;
-    }
-    return (_jsx("div", { className: cn('flex flex-col gap-24 text-sm', className), ...props, children: _jsx(ApiProvider, { mediaAdapters: mediaAdapters, servers: ctx.servers, shikiOptions: ctx.shikiOptions, children: children }) }));
-}
-export function APIInfo({ className, ...props }) {
-    return (_jsx("div", { className: cn('min-w-0 flex-1', className), ...props, children: props.children }));
-}
-export function API({ children, ...props }) {
-    return (_jsx("div", { ...props, className: cn('flex flex-col gap-x-6 gap-y-4 xl:flex-row xl:items-start', props.className), style: {
-            '--fd-api-info-top': 'calc(12px + var(--fd-nav-height) + var(--fd-banner-height) + var(--fd-tocnav-height, 0px))',
-            ...props.style,
-        }, children: 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 { Property, ObjectCollapsible } from '../render/schema/ui.js';
-export { APIPage } from '../render/api-page.js';
+export * from '../ui/api-page.js';

package/dist/ui/{select-tabs.d.ts → operation/client.d.ts}

@@ -1,5 +1,8 @@
 import { type ComponentProps, type ReactNode } from 'react';
-import { SelectTrigger } from '../ui/components/select.js';
+import { SelectTrigger } from '../../ui/components/select.js';
+export declare function CopyResponseTypeScript({ code }: {
+    code: string;
+}): import("react/jsx-runtime").JSX.Element;
 export declare function SelectTabs({ defaultValue, children, }: {
     defaultValue?: string;
     children: ReactNode;
@@ -10,4 +13,4 @@ export declare function SelectTab({ value, ...props }: ComponentProps<'div'> & {
 export declare function SelectTabTrigger({ items, ...props }: ComponentProps<typeof SelectTrigger> & {
     items: string[];
 }): import("react/jsx-runtime").JSX.Element;
-//# sourceMappingURL=select-tabs.d.ts.map
+//# sourceMappingURL=client.d.ts.map

package/dist/ui/operation/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/ui/operation/client.tsx"],"names":[],"mappings":"AAMA,OAAO,EACL,KAAK,cAAc,EAEnB,KAAK,SAAS,EAIf,MAAM,OAAO,CAAC;AACf,OAAO,EAIL,aAAa,EAEd,MAAM,wBAAwB,CAAC;AAEhC,wBAAgB,sBAAsB,CAAC,EAAE,IAAI,EAAE,EAAE;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,2CAgChE;AAOD,wBAAgB,UAAU,CAAC,EACzB,YAAY,EACZ,QAAQ,GACT,EAAE;IACD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,SAAS,CAAC;CACrB,2CAQA;AAED,wBAAgB,SAAS,CAAC,EACxB,KAAK,EACL,GAAG,KAAK,EACT,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG;IACzB,KAAK,EAAE,MAAM,CAAC;CACf,uDAKA;AAED,wBAAgB,gBAAgB,CAAC,EAC/B,KAAK,EACL,GAAG,KAAK,EACT,EAAE,cAAc,CAAC,OAAO,aAAa,CAAC,GAAG;IAAE,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,2CAoB5D"}

package/dist/ui/{client.js → operation/client.js}

@@ -3,7 +3,9 @@ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { useCopyButton } from 'fumadocs-ui/utils/use-copy-button';
 import { buttonVariants } from 'fumadocs-ui/components/ui/button';
 import { cn } from 'fumadocs-ui/utils/cn';
-import { Check, Copy } from '../icons.js';
+import { Check, Copy } from '../../icons.js';
+import { createContext, use, useMemo, useState, } from 'react';
+import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue, } from '../../ui/components/select.js';
 export function CopyResponseTypeScript({ code }) {
     const [isChecked, onCopy] = useCopyButton(() => {
         void navigator.clipboard.writeText(code);
@@ -14,3 +16,18 @@ export function CopyResponseTypeScript({ code }) {
                     size: 'sm',
                 })), children: [isChecked ? (_jsx(Check, { className: "size-3.5" })) : (_jsx(Copy, { className: "size-3.5" })), "Copy"] })] }));
 }
+const Context = createContext(null);
+export function SelectTabs({ defaultValue, children, }) {
+    const [type, setType] = useState(defaultValue ?? null);
+    return (_jsx(Context, { value: useMemo(() => ({ type, setType }), [type]), children: children }));
+}
+export function SelectTab({ value, ...props }) {
+    const ctx = use(Context);
+    if (value !== ctx?.type)
+        return;
+    return _jsx("div", { ...props, children: props.children });
+}
+export function SelectTabTrigger({ items, ...props }) {
+    const { type, setType } = use(Context);
+    return (_jsxs(Select, { value: type ?? '', onValueChange: setType, children: [_jsx(SelectTrigger, { ...props, className: cn('not-prose w-fit', props.className), children: _jsx(SelectValue, {}) }), _jsx(SelectContent, { children: items.map((type) => (_jsx(SelectItem, { value: type, children: type }, type))) })] }));
+}

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

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1 @@
+{"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/client.js

@@ -0,0 +1,50 @@
+'use client';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { useApiContext, useServerSelectContext } from '../../../ui/contexts/api.js';
+import { useOperationContext, } from '../../../ui/contexts/operation.js';
+import { joinURL, withBase, resolveServerUrl, resolveRequestData, } from '../../../utils/url.js';
+import { Select, SelectTrigger, SelectValue, SelectContent, SelectItem, } from '../../../ui/components/select.js';
+import { DynamicCodeBlock } from 'fumadocs-ui/components/dynamic-codeblock';
+import { useState, useEffect, useMemo } from 'react';
+export function APIExampleSelector() {
+    const { example: key, setExample: setKey, examples } = useOperationContext();
+    const { APIExampleSelector: Override } = useApiContext().client.operation ?? {};
+    if (Override) {
+        return _jsx(Override, { items: examples, value: key, onValueChange: setKey });
+    }
+    function renderItem(item) {
+        return (_jsxs("div", { children: [_jsx("span", { className: "font-medium text-sm", children: item.name }), _jsx("span", { className: "text-fd-muted-foreground", children: item.description })] }));
+    }
+    if (examples.length === 1)
+        return null;
+    const selected = examples.find((item) => item.id === key);
+    return (_jsxs(Select, { value: key, onValueChange: setKey, children: [_jsx(SelectTrigger, { className: "not-prose mb-2", children: selected && _jsx(SelectValue, { asChild: true, children: renderItem(selected) }) }), _jsx(SelectContent, { children: examples.map((item) => (_jsx(SelectItem, { value: item.id, children: renderItem(item) }, item.id))) })] }));
+}
+export function APIExampleUsageTab(sample) {
+    const { shikiOptions, mediaAdapters } = useApiContext();
+    const { examples, example: selectedExampleId, route, addListener, removeListener, } = useOperationContext();
+    const { server } = useServerSelectContext();
+    const [data, setData] = useState(() => examples.find((example) => example.id === selectedExampleId)?.encoded);
+    useEffect(() => {
+        const listener = (_, encoded) => setData(encoded);
+        addListener(listener);
+        return () => {
+            removeListener(listener);
+        };
+    }, [addListener, removeListener]);
+    const code = useMemo(() => {
+        if (!sample.source || !data)
+            return;
+        if (typeof sample.source === 'string')
+            return sample.source;
+        return sample.source(joinURL(withBase(server ? resolveServerUrl(server.url, server.variables) : '/', typeof window !== 'undefined'
+            ? window.location.origin
+            : 'https://loading'), resolveRequestData(route, data)), data, {
+            server: sample.serverContext,
+            mediaAdapters,
+        });
+    }, [mediaAdapters, sample, server, route, data]);
+    if (!code || !sample)
+        return null;
+    return (_jsx(DynamicCodeBlock, { lang: sample.lang, code: code, options: shikiOptions }));
+}

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

@@ -0,0 +1,58 @@
+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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,140 @@
+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) }));
+}