fumadocs-openapi 10.2.2 → 10.2.3

package/dist/server/source-api.js

@@ -1,81 +1,88 @@
-import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
-import { MethodLabel } from '../ui/components/method-label.js';
+import { MethodLabel } from "../ui/components/method-label.js";
+import { Fragment, jsx, jsxs } from "react/jsx-runtime";
+
+//#region src/server/source-api.tsx
 /**
- * Fumadocs Source API integration, pass this to `plugins` array in `loader()`.
- */
-export function openapiPlugin() {
-    return {
-        name: 'fumadocs:openapi',
-        enforce: 'pre',
-        transformPageTree: {
-            file(node, filePath) {
-                if (!filePath)
-                    return node;
-                const file = this.storage.read(filePath);
-                if (!file || file.format !== 'page')
-                    return node;
-                const openApiData = file.data._openapi;
-                if (!openApiData || typeof openApiData !== 'object')
-                    return node;
-                if (openApiData.webhook) {
-                    node.name = (_jsxs(_Fragment, { children: [node.name, ' ', _jsx("span", { className: "ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono", children: "Webhook" })] }));
-                }
-                else if (openApiData.method) {
-                    node.name = (_jsxs(_Fragment, { children: [node.name, ' ', _jsx(MethodLabel, { className: "ms-auto text-xs text-nowrap", children: openApiData.method })] }));
-                }
-                return node;
-            },
-        },
-    };
+* Fumadocs Source API integration, pass this to `plugins` array in `loader()`.
+*/
+function openapiPlugin() {
+	return {
+		name: "fumadocs:openapi",
+		enforce: "pre",
+		transformPageTree: { file(node, filePath) {
+			if (!filePath) return node;
+			const file = this.storage.read(filePath);
+			if (!file || file.format !== "page") return node;
+			const openApiData = file.data._openapi;
+			if (!openApiData || typeof openApiData !== "object") return node;
+			if (openApiData.webhook) node.name = /* @__PURE__ */ jsxs(Fragment, { children: [
+				node.name,
+				" ",
+				/* @__PURE__ */ jsx("span", {
+					className: "ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono",
+					children: "Webhook"
+				})
+			] });
+			else if (openApiData.method) node.name = /* @__PURE__ */ jsxs(Fragment, { children: [
+				node.name,
+				" ",
+				/* @__PURE__ */ jsx(MethodLabel, {
+					className: "ms-auto text-xs text-nowrap",
+					children: openApiData.method
+				})
+			] });
+			return node;
+		} }
+	};
 }
 /**
- * Generate virtual pages for Fumadocs Source API
- */
-export async function openapiSource(server, options = {}) {
-    const { baseDir = '' } = options;
-    const { createAutoPreset } = await import('../utils/pages/preset-auto.js');
-    const { fromServer } = await import('../utils/pages/builder.js');
-    const { toBody } = await import('../utils/pages/to-body.js');
-    const { toStaticData } = await import('../utils/pages/to-static-data.js');
-    const files = [];
-    const entries = await fromServer(server, createAutoPreset(options));
-    for (const [schemaId, list] of Object.entries(entries)) {
-        const processed = await server.getSchema(schemaId);
-        for (const entry of list) {
-            const props = toBody(entry);
-            props.showDescription ?? (props.showDescription = true);
-            files.push({
-                type: 'page',
-                path: `${baseDir}/${entry.path}`,
-                data: {
-                    ...entry.info,
-                    getAPIPageProps() {
-                        return props;
-                    },
-                    getSchema() {
-                        return {
-                            id: schemaId,
-                            ...processed,
-                        };
-                    },
-                    ...toStaticData(props, processed.dereferenced),
-                    _openapi: {
-                        method: entry.type === 'operation' || entry.type === 'webhook'
-                            ? entry.item.method
-                            : undefined,
-                        webhook: entry.type === 'webhook',
-                    },
-                },
-            });
-        }
-    }
-    return {
-        files,
-    };
+* Generate virtual pages for Fumadocs Source API
+*/
+async function openapiSource(server, options = {}) {
+	const { baseDir = "" } = options;
+	const { createAutoPreset } = await import("../utils/pages/preset-auto.js");
+	const { fromServer } = await import("../utils/pages/builder.js");
+	const { toBody } = await import("../utils/pages/to-body.js");
+	const { toStaticData } = await import("../utils/pages/to-static-data.js");
+	const files = [];
+	const entries = await fromServer(server, createAutoPreset(options));
+	for (const [schemaId, list] of Object.entries(entries)) {
+		const processed = await server.getSchema(schemaId);
+		for (const entry of list) {
+			const props = toBody(entry);
+			props.showDescription ??= true;
+			files.push({
+				type: "page",
+				path: `${baseDir}/${entry.path}`,
+				data: {
+					...entry.info,
+					getAPIPageProps() {
+						return props;
+					},
+					getSchema() {
+						return {
+							id: schemaId,
+							...processed
+						};
+					},
+					...toStaticData(props, processed.dereferenced),
+					_openapi: {
+						method: entry.type === "operation" || entry.type === "webhook" ? entry.item.method : void 0,
+						webhook: entry.type === "webhook"
+					}
+				}
+			});
+		}
+	}
+	return { files };
 }
 /**
- * @deprecated use `openapiPlugin()`
- */
-export function transformerOpenAPI() {
-    return openapiPlugin().transformPageTree;
+* @deprecated use `openapiPlugin()`
+*/
+function transformerOpenAPI() {
+	return openapiPlugin().transformPageTree;
 }
+
+//#endregion
+export { openapiPlugin, openapiSource, transformerOpenAPI };
+//# sourceMappingURL=source-api.js.map

package/dist/server/source-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"source-api.js","names":["files: VirtualFile<{\n    pageData: OpenAPIPageData;\n    metaData: never;\n  }>[]"],"sources":["../../src/server/source-api.tsx"],"sourcesContent":["import { MethodLabel } from '@/ui/components/method-label';\nimport type {\n  LoaderPlugin,\n  PageData,\n  PageTreeTransformer,\n  Source,\n  VirtualFile,\n} from 'fumadocs-core/source';\nimport type { OpenAPIServer } from '@/server/create';\nimport type { SchemaToPagesOptions } from '@/utils/pages/preset-auto';\nimport type { ApiPageProps } from '@/ui/api-page';\nimport type { StructuredData } from 'fumadocs-core/mdx-plugins';\nimport type { TOCItemType } from 'fumadocs-core/toc';\nimport type { ProcessedDocument } from '@/utils/process-document';\n\ndeclare module 'fumadocs-core/source' {\n  export interface PageData {\n    /**\n     * Added by Fumadocs OpenAPI\n     */\n    _openapi?: InternalOpenAPIMeta;\n  }\n}\n\nexport interface InternalOpenAPIMeta {\n  method?: string;\n  webhook?: boolean;\n}\n\n/**\n * Fumadocs Source API integration, pass this to `plugins` array in `loader()`.\n */\nexport function openapiPlugin(): LoaderPlugin {\n  return {\n    name: 'fumadocs:openapi',\n    enforce: 'pre',\n    transformPageTree: {\n      file(node, filePath) {\n        if (!filePath) return node;\n        const file = this.storage.read(filePath);\n        if (!file || file.format !== 'page') return node;\n\n        const openApiData = file.data._openapi;\n        if (!openApiData || typeof openApiData !== 'object') return node;\n\n        if (openApiData.webhook) {\n          node.name = (\n            <>\n              {node.name}{' '}\n              <span className=\"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono\">\n                Webhook\n              </span>\n            </>\n          );\n        } else if (openApiData.method) {\n          node.name = (\n            <>\n              {node.name}{' '}\n              <MethodLabel className=\"ms-auto text-xs text-nowrap\">\n                {openApiData.method}\n              </MethodLabel>\n            </>\n          );\n        }\n\n        return node;\n      },\n    },\n  };\n}\n\ninterface OpenAPIPageData extends PageData {\n  getAPIPageProps: () => ApiPageProps;\n  getSchema: () => { id: string } & ProcessedDocument;\n  structuredData: StructuredData;\n  toc: TOCItemType[];\n}\n\n/**\n * Generate virtual pages for Fumadocs Source API\n */\nexport async function openapiSource(\n  server: OpenAPIServer,\n  options: SchemaToPagesOptions & {\n    baseDir?: string;\n  } = {},\n): Promise<\n  Source<{\n    metaData: never;\n    pageData: OpenAPIPageData;\n  }>\n> {\n  const { baseDir = '' } = options;\n  const { createAutoPreset } = await import('@/utils/pages/preset-auto');\n  const { fromServer } = await import('@/utils/pages/builder');\n  const { toBody } = await import('@/utils/pages/to-body');\n  const { toStaticData } = await import('@/utils/pages/to-static-data');\n  const files: VirtualFile<{\n    pageData: OpenAPIPageData;\n    metaData: never;\n  }>[] = [];\n\n  const entries = await fromServer(server, createAutoPreset(options));\n  for (const [schemaId, list] of Object.entries(entries)) {\n    const processed = await server.getSchema(schemaId);\n    for (const entry of list) {\n      const props = toBody(entry);\n      props.showDescription ??= true;\n\n      files.push({\n        type: 'page',\n        path: `${baseDir}/${entry.path}`,\n        data: {\n          ...entry.info,\n          getAPIPageProps() {\n            return props;\n          },\n          getSchema() {\n            return {\n              id: schemaId,\n              ...processed,\n            };\n          },\n          ...toStaticData(props, processed.dereferenced),\n          _openapi: {\n            method:\n              entry.type === 'operation' || entry.type === 'webhook'\n                ? entry.item.method\n                : undefined,\n            webhook: entry.type === 'webhook',\n          },\n        },\n      });\n    }\n  }\n\n  return {\n    files,\n  };\n}\n\n/**\n * @deprecated use `openapiPlugin()`\n */\nexport function transformerOpenAPI(): PageTreeTransformer {\n  return openapiPlugin().transformPageTree!;\n}\n"],"mappings":";;;;;;;AAgCA,SAAgB,gBAA8B;AAC5C,QAAO;EACL,MAAM;EACN,SAAS;EACT,mBAAmB,EACjB,KAAK,MAAM,UAAU;AACnB,OAAI,CAAC,SAAU,QAAO;GACtB,MAAM,OAAO,KAAK,QAAQ,KAAK,SAAS;AACxC,OAAI,CAAC,QAAQ,KAAK,WAAW,OAAQ,QAAO;GAE5C,MAAM,cAAc,KAAK,KAAK;AAC9B,OAAI,CAAC,eAAe,OAAO,gBAAgB,SAAU,QAAO;AAE5D,OAAI,YAAY,QACd,MAAK,OACH;IACG,KAAK;IAAM;IACZ,oBAAC;KAAK,WAAU;eAA8E;MAEvF;OACN;YAEI,YAAY,OACrB,MAAK,OACH;IACG,KAAK;IAAM;IACZ,oBAAC;KAAY,WAAU;eACpB,YAAY;MACD;OACb;AAIP,UAAO;KAEV;EACF;;;;;AAaH,eAAsB,cACpB,QACA,UAEI,EAAE,EAMN;CACA,MAAM,EAAE,UAAU,OAAO;CACzB,MAAM,EAAE,qBAAqB,MAAM,OAAO;CAC1C,MAAM,EAAE,eAAe,MAAM,OAAO;CACpC,MAAM,EAAE,WAAW,MAAM,OAAO;CAChC,MAAM,EAAE,iBAAiB,MAAM,OAAO;CACtC,MAAMA,QAGC,EAAE;CAET,MAAM,UAAU,MAAM,WAAW,QAAQ,iBAAiB,QAAQ,CAAC;AACnE,MAAK,MAAM,CAAC,UAAU,SAAS,OAAO,QAAQ,QAAQ,EAAE;EACtD,MAAM,YAAY,MAAM,OAAO,UAAU,SAAS;AAClD,OAAK,MAAM,SAAS,MAAM;GACxB,MAAM,QAAQ,OAAO,MAAM;AAC3B,SAAM,oBAAoB;AAE1B,SAAM,KAAK;IACT,MAAM;IACN,MAAM,GAAG,QAAQ,GAAG,MAAM;IAC1B,MAAM;KACJ,GAAG,MAAM;KACT,kBAAkB;AAChB,aAAO;;KAET,YAAY;AACV,aAAO;OACL,IAAI;OACJ,GAAG;OACJ;;KAEH,GAAG,aAAa,OAAO,UAAU,aAAa;KAC9C,UAAU;MACR,QACE,MAAM,SAAS,eAAe,MAAM,SAAS,YACzC,MAAM,KAAK,SACX;MACN,SAAS,MAAM,SAAS;MACzB;KACF;IACF,CAAC;;;AAIN,QAAO,EACL,OACD;;;;;AAMH,SAAgB,qBAA0C;AACxD,QAAO,eAAe,CAAC"}

package/dist/types.d.ts

@@ -1,39 +1,44 @@
-import type { OpenAPIV3_1 as V3_1 } from 'openapi-types';
-import type { default as Slugger } from 'github-slugger';
-import type { NoReference } from './utils/schema.js';
-import type { ProcessedDocument } from './utils/process-document.js';
-import type { MediaAdapter } from './requests/media/adapter.js';
-import type { OpenAPIOptions } from './server/index.js';
-import type { CreateAPIPageOptions } from './ui/api-page.js';
-import type { CodeUsageGenerator } from './ui/operation/usage-tabs/index.js';
-import type { HTMLAttributes, ReactNode } from 'react';
-export type Document = V3_1.Document;
-export type OperationObject = V3_1.OperationObject;
-export type ParameterObject = V3_1.ParameterObject;
-export type SecuritySchemeObject = V3_1.SecuritySchemeObject;
-export type ReferenceObject = V3_1.ReferenceObject;
-export type PathItemObject = V3_1.PathItemObject;
-export type TagObject = V3_1.TagObject;
-export type ServerObject = V3_1.ServerObject;
-export type CallbackObject = V3_1.CallbackObject;
-export type ServerVariableObject = V3_1.ServerVariableObject;
-export type ResponseObject = V3_1.ResponseObject;
-export type MethodInformation = NoReference<OperationObject> & {
-    method: string;
-    'x-codeSamples'?: Omit<CodeUsageGenerator, 'id'>[];
-    'x-selectedCodeSample'?: string;
-    'x-exclusiveCodeSample'?: string;
+import { NoReference } from "./utils/schema.js";
+import { MediaAdapter } from "./requests/media/adapter.js";
+import { CodeUsageGenerator } from "./ui/operation/usage-tabs/index.js";
+import { OpenAPIOptions } from "./server/create.js";
+import { CreateAPIPageOptions } from "./ui/api-page.js";
+import "./server/index.js";
+import { ProcessedDocument } from "./utils/process-document.js";
+import Slugger from "github-slugger";
+import { HTMLAttributes, ReactNode } from "react";
+import { OpenAPIV3_1 } from "openapi-types";
+
+//#region src/types.d.ts
+type Document = OpenAPIV3_1.Document;
+type OperationObject = OpenAPIV3_1.OperationObject;
+type ParameterObject = OpenAPIV3_1.ParameterObject;
+type SecuritySchemeObject = OpenAPIV3_1.SecuritySchemeObject;
+type ReferenceObject = OpenAPIV3_1.ReferenceObject;
+type PathItemObject = OpenAPIV3_1.PathItemObject;
+type TagObject = OpenAPIV3_1.TagObject;
+type ServerObject = OpenAPIV3_1.ServerObject;
+type CallbackObject = OpenAPIV3_1.CallbackObject;
+type ServerVariableObject = OpenAPIV3_1.ServerVariableObject;
+type ResponseObject = OpenAPIV3_1.ResponseObject;
+type MethodInformation = NoReference<OperationObject> & {
+  method: string;
+  'x-codeSamples'?: Omit<CodeUsageGenerator, 'id'>[];
+  'x-selectedCodeSample'?: string;
+  'x-exclusiveCodeSample'?: string;
 };
-export interface RenderContext extends Pick<OpenAPIOptions, 'proxyUrl'>, CreateAPIPageOptions {
-    servers: NoReference<ServerObject>[];
-    slugger: Slugger;
-    /**
-     * dereferenced schema
-     */
-    schema: ProcessedDocument;
-    mediaAdapters: Record<string, MediaAdapter>;
-    renderHeading: (depth: number, text: string, props?: HTMLAttributes<HTMLHeadingElement>) => ReactNode;
-    renderMarkdown: (text: string) => ReactNode;
-    renderCodeBlock: (lang: string, code: string) => ReactNode;
+interface RenderContext extends Pick<OpenAPIOptions, 'proxyUrl'>, CreateAPIPageOptions {
+  servers: NoReference<ServerObject>[];
+  slugger: Slugger;
+  /**
+   * dereferenced schema
+   */
+  schema: ProcessedDocument;
+  mediaAdapters: Record<string, MediaAdapter>;
+  renderHeading: (depth: number, text: string, props?: HTMLAttributes<HTMLHeadingElement>) => ReactNode;
+  renderMarkdown: (text: string) => ReactNode;
+  renderCodeBlock: (lang: string, code: string) => ReactNode;
 }
+//#endregion
+export { CallbackObject, Document, MethodInformation, OperationObject, ParameterObject, PathItemObject, ReferenceObject, RenderContext, ResponseObject, SecuritySchemeObject, ServerObject, ServerVariableObject, TagObject };
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,IAAI,IAAI,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,KAAK,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEvD,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;AACrC,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;AACnD,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;AACnD,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,CAAC;AAC7D,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;AACnD,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;AACjD,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;AACvC,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;AAC7C,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;AACjD,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,CAAC;AAC7D,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;AAEjD,MAAM,MAAM,iBAAiB,GAAG,WAAW,CAAC,eAAe,CAAC,GAAG;IAC7D,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,EAAE,CAAC;IACnD,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC,CAAC;AAEF,MAAM,WAAW,aACf,SAAQ,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,EAAE,oBAAoB;IAC9D,OAAO,EAAE,WAAW,CAAC,YAAY,CAAC,EAAE,CAAC;IACrC,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAE5C,aAAa,EAAE,CACb,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,cAAc,CAAC,kBAAkB,CAAC,KACvC,SAAS,CAAC;IACf,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,SAAS,CAAC;IAC5C,eAAe,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,SAAS,CAAC;CAC5D"}
+{"version":3,"file":"types.d.ts","names":[],"sources":["../src/types.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;;KAUY,QAAA,GAAW,WAAA,CAAK;KAChB,eAAA,GAAkB,WAAA,CAAK;KACvB,eAAA,GAAkB,WAAA,CAAK;AAFvB,KAGA,oBAAA,GAAuB,WAAA,CAAK,oBAHJ;AACxB,KAGA,eAAA,GAAkB,WAAA,CAAK,eAHA;AACvB,KAGA,cAAA,GAAiB,WAAA,CAAK,cAHC;AACvB,KAGA,SAAA,GAAY,WAAA,CAAK,SAHG;AACpB,KAGA,YAAA,GAAe,WAAA,CAAK,YAHF;AAClB,KAGA,cAAA,GAAiB,WAAA,CAAK,cAHA;AACtB,KAGA,oBAAA,GAAuB,WAAA,CAAK,oBAHF;AAC1B,KAGA,cAAA,GAAiB,WAAA,CAAK,cAHF;AACpB,KAIA,iBAAA,GAAoB,WAJH,CAIe,eAJV,CAAc,GAAA;EACpC,MAAA,EAAA,MAAA;EACA,eAAA,CAAA,EAIQ,IAJM,CAID,kBAJS,EAAA,IAAA,CAAA,EAAA;EAEtB,sBAAiB,CAAA,EAAA,MAAA;EAAe,uBAAA,CAAA,EAAA,MAAA;CAAZ;AAEP,UAKR,aAAA,SAAsB,IALd,CAKmB,cALnB,EAAA,UAAA,CAAA,EAKgD,oBALhD,CAAA;EAAL,OAAA,EAMT,WANS,CAMG,YANH,CAAA,EAAA;EAAI,OAAA,EAOb,OAPa;EAKP;;;EACN,MAAA,EAMD,iBANC;EACA,aAAA,EAOM,MAPN,CAAA,MAAA,EAOqB,YAPrB,CAAA;EAKD,aAAA,EAAA,CAAA,KAAA,EAAA,MAAA,EAAA,IAAA,EAAA,MAAA,EAAA,KAAA,CAAA,EAOE,cAPF,CAOiB,kBAPjB,CAAA,EAAA,GAQH,SARG;EAEsB,cAAA,EAAA,CAAA,IAAA,EAAA,MAAA,EAAA,GAOI,SAPJ;EAAf,eAAA,EAAA,CAAA,IAAA,EAAA,MAAA,EAAA,IAAA,EAAA,MAAA,EAAA,GAQkC,SARlC"}

package/dist/ui/api-page.d.ts

@@ -1,153 +1,157 @@
-import type { MethodInformation, RenderContext } from '../types.js';
-import { type NoReference } from '../utils/schema.js';
-import type { OpenAPIV3_1 } from 'openapi-types';
-import type { ProcessedDocument } from '../utils/process-document.js';
-import { MediaAdapter } from '../requests/media/adapter.js';
-import type { FC, ReactNode } from 'react';
-import { type HighlightOptionsCommon, type HighlightOptionsThemes } from 'fumadocs-core/highlight';
-import type { OpenAPIServer } from '../server/index.js';
-import type { APIPageClientOptions } from './client/index.js';
-import type { CodeUsageGenerator } from './operation/usage-tabs/index.js';
-import type { SchemaUIOptions } from './schema/index.js';
-import type { ResponseTab } from './operation/response-tabs.js';
-import type { ExampleRequestItem } from './operation/request-tabs.js';
+import { NoReference } from "../utils/schema.js";
+import { MediaAdapter } from "../requests/media/adapter.js";
+import { CodeUsageGenerator } from "./operation/usage-tabs/index.js";
+import { OpenAPIServer } from "../server/create.js";
+import { ExampleRequestItem } from "./operation/request-tabs.js";
+import { APIPageClientOptions } from "./client/index.js";
+import { SchemaUIOptions } from "./schema/index.js";
+import { ResponseTab } from "./operation/response-tabs.js";
+import "../server/index.js";
+import { MethodInformation, RenderContext } from "../types.js";
+import { ProcessedDocument } from "../utils/process-document.js";
+import { FC, ReactNode } from "react";
+import { HighlightOptionsCommon, HighlightOptionsThemes } from "fumadocs-core/highlight";
+import { OpenAPIV3_1 } from "openapi-types";
+
+//#region src/ui/api-page.d.ts
 type Awaitable<T> = T | Promise<T>;
-export interface CreateAPIPageOptions {
+interface CreateAPIPageOptions {
+  /**
+   * Generate TypeScript definitions from response schema.
+   *
+   * Pass `false` to disable it.
+   *
+   * @param method - the operation object
+   * @param statusCode - status code
+   */
+  generateTypeScriptSchema?: ((method: NoReference<MethodInformation>, statusCode: string) => Awaitable<string>) | false;
+  /**
+   * Generate example code usage for endpoints.
+   */
+  generateCodeSamples?: (method: MethodInformation) => Awaitable<CodeUsageGenerator[]>;
+  shikiOptions?: Omit<HighlightOptionsCommon, 'lang' | 'components'> & HighlightOptionsThemes;
+  /**
+   * Show full response schema instead of only example response & Typescript definitions.
+   *
+   * @default true
+   */
+  showResponseSchema?: boolean;
+  /**
+   * Support other media types (for server-side generation).
+   */
+  mediaAdapters?: Record<string, MediaAdapter>;
+  /**
+   * Customise page content
+   */
+  content?: {
+    renderResponseTabs?: (tabs: ResponseTab[], ctx: RenderContext) => Awaitable<ReactNode>;
+    renderRequestTabs?: (items: ExampleRequestItem[], ctx: RenderContext & {
+      route: string;
+      operation: NoReference<MethodInformation>;
+    }) => Awaitable<ReactNode>;
+    renderAPIExampleLayout?: (slots: {
+      selector: ReactNode;
+      usageTabs: ReactNode;
+      responseTabs: ReactNode;
+    }, ctx: RenderContext) => Awaitable<ReactNode>;
     /**
-     * Generate TypeScript definitions from response schema.
-     *
-     * Pass `false` to disable it.
-     *
-     * @param method - the operation object
-     * @param statusCode - status code
+     * @param generators - codegens for API example usages
      */
-    generateTypeScriptSchema?: ((method: NoReference<MethodInformation>, statusCode: string) => Awaitable<string>) | false;
+    renderAPIExampleUsageTabs?: (generators: CodeUsageGenerator[], ctx: RenderContext) => Awaitable<ReactNode>;
     /**
-     * Generate example code usage for endpoints.
+     * renderer of the entire page's layout (containing all operations & webhooks UI)
      */
-    generateCodeSamples?: (method: MethodInformation) => Awaitable<CodeUsageGenerator[]>;
-    shikiOptions?: Omit<HighlightOptionsCommon, 'lang' | 'components'> & HighlightOptionsThemes;
+    renderPageLayout?: (slots: {
+      operations?: {
+        item: OperationItem;
+        children: ReactNode;
+      }[];
+      webhooks?: {
+        item: WebhookItem;
+        children: ReactNode;
+      }[];
+    }, ctx: RenderContext) => Awaitable<ReactNode>;
+    renderOperationLayout?: (slots: {
+      header: ReactNode;
+      description: ReactNode;
+      apiExample: ReactNode;
+      apiPlayground: ReactNode;
+      authSchemes: ReactNode;
+      paremeters: ReactNode;
+      body: ReactNode;
+      responses: ReactNode;
+      callbacks: ReactNode;
+    }, ctx: RenderContext, method: NoReference<MethodInformation>) => Awaitable<ReactNode>;
+    renderWebhookLayout?: (slots: {
+      header: ReactNode;
+      description: ReactNode;
+      authSchemes: ReactNode;
+      paremeters: ReactNode;
+      body: ReactNode;
+      requests: ReactNode;
+      responses: ReactNode;
+      callbacks: ReactNode;
+    }) => Awaitable<ReactNode>;
+  };
+  /**
+   * Info UI for JSON schemas
+   */
+  schemaUI?: {
+    render?: (options: SchemaUIOptions, ctx: RenderContext) => Awaitable<ReactNode>;
     /**
-     * Show full response schema instead of only example response & Typescript definitions.
+     * Show examples under the generated content of JSON schemas.
      *
-     * @default true
-     */
-    showResponseSchema?: boolean;
-    /**
-     * Support other media types (for server-side generation).
+     * @defaultValue false
      */
-    mediaAdapters?: Record<string, MediaAdapter>;
+    showExample?: boolean;
+  };
+  /**
+   * Customise API playground
+   */
+  playground?: {
     /**
-     * Customise page content
+     * @defaultValue true
      */
-    content?: {
-        renderResponseTabs?: (tabs: ResponseTab[], ctx: RenderContext) => Awaitable<ReactNode>;
-        renderRequestTabs?: (items: ExampleRequestItem[], ctx: RenderContext & {
-            route: string;
-            operation: NoReference<MethodInformation>;
-        }) => Awaitable<ReactNode>;
-        renderAPIExampleLayout?: (slots: {
-            selector: ReactNode;
-            usageTabs: ReactNode;
-            responseTabs: ReactNode;
-        }, ctx: RenderContext) => Awaitable<ReactNode>;
-        /**
-         * @param generators - codegens for API example usages
-         */
-        renderAPIExampleUsageTabs?: (generators: CodeUsageGenerator[], ctx: RenderContext) => Awaitable<ReactNode>;
-        /**
-         * renderer of the entire page's layout (containing all operations & webhooks UI)
-         */
-        renderPageLayout?: (slots: {
-            operations?: {
-                item: OperationItem;
-                children: ReactNode;
-            }[];
-            webhooks?: {
-                item: WebhookItem;
-                children: ReactNode;
-            }[];
-        }, ctx: RenderContext) => Awaitable<ReactNode>;
-        renderOperationLayout?: (slots: {
-            header: ReactNode;
-            description: ReactNode;
-            apiExample: ReactNode;
-            apiPlayground: ReactNode;
-            authSchemes: ReactNode;
-            paremeters: ReactNode;
-            body: ReactNode;
-            responses: ReactNode;
-            callbacks: ReactNode;
-        }, ctx: RenderContext, method: NoReference<MethodInformation>) => Awaitable<ReactNode>;
-        renderWebhookLayout?: (slots: {
-            header: ReactNode;
-            description: ReactNode;
-            authSchemes: ReactNode;
-            paremeters: ReactNode;
-            body: ReactNode;
-            requests: ReactNode;
-            responses: ReactNode;
-            callbacks: ReactNode;
-        }) => Awaitable<ReactNode>;
-    };
+    enabled?: boolean;
     /**
-     * Info UI for JSON schemas
+     * replace the server-side renderer
      */
-    schemaUI?: {
-        render?: (options: SchemaUIOptions, ctx: RenderContext) => Awaitable<ReactNode>;
-        /**
-         * Show examples under the generated content of JSON schemas.
-         *
-         * @defaultValue false
-         */
-        showExample?: boolean;
-    };
-    /**
-     * Customise API playground
-     */
-    playground?: {
-        /**
-         * @defaultValue true
-         */
-        enabled?: boolean;
-        /**
-         * replace the server-side renderer
-         */
-        render?: (props: {
-            path: string;
-            method: MethodInformation;
-            ctx: RenderContext;
-        }) => Awaitable<ReactNode>;
-    };
-    client?: APIPageClientOptions;
+    render?: (props: {
+      path: string;
+      method: MethodInformation;
+      ctx: RenderContext;
+    }) => Awaitable<ReactNode>;
+  };
+  client?: APIPageClientOptions;
 }
-export interface ApiPageProps {
-    document: Promise<ProcessedDocument> | string | ProcessedDocument;
-    showTitle?: boolean;
-    showDescription?: boolean;
-    /**
-     * An array of operations
-     */
-    operations?: OperationItem[];
-    webhooks?: WebhookItem[];
+interface ApiPageProps {
+  document: Promise<ProcessedDocument> | string | ProcessedDocument;
+  showTitle?: boolean;
+  showDescription?: boolean;
+  /**
+   * An array of operations
+   */
+  operations?: OperationItem[];
+  webhooks?: WebhookItem[];
 }
-export interface WebhookItem {
-    /**
-     * webhook name in `webhooks`
-     */
-    name: string;
-    method: OpenAPIV3_1.HttpMethods;
+interface WebhookItem {
+  /**
+   * webhook name in `webhooks`
+   */
+  name: string;
+  method: OpenAPIV3_1.HttpMethods;
 }
-export interface OperationItem {
-    /**
-     * the path of operation in `paths`
-     */
-    path: string;
-    /**
-     * the HTTP method of operation
-     */
-    method: OpenAPIV3_1.HttpMethods;
+interface OperationItem {
+  /**
+   * the path of operation in `paths`
+   */
+  path: string;
+  /**
+   * the HTTP method of operation
+   */
+  method: OpenAPIV3_1.HttpMethods;
 }
-export declare function createAPIPage(server: OpenAPIServer, options?: CreateAPIPageOptions): FC<ApiPageProps>;
-export {};
+declare function createAPIPage(server: OpenAPIServer, options?: CreateAPIPageOptions): FC<ApiPageProps>;
+//#endregion
+export { ApiPageProps, CreateAPIPageOptions, OperationItem, WebhookItem, createAPIPage };
 //# sourceMappingURL=api-page.d.ts.map

package/dist/ui/api-page.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-page.d.ts","sourceRoot":"","sources":["../../src/ui/api-page.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAChE,OAAO,EAAgB,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAmB,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,EAEL,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC5B,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAcjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAEnE,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAEnC,MAAM,WAAW,oBAAoB;IACnC;;;;;;;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,CACpB,MAAM,EAAE,iBAAiB,KACtB,SAAS,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAErC,YAAY,CAAC,EAAE,IAAI,CAAC,sBAAsB,EAAE,MAAM,GAAG,YAAY,CAAC,GAChE,sBAAsB,CAAC;IAEzB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAE7C;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,kBAAkB,CAAC,EAAE,CACnB,IAAI,EAAE,WAAW,EAAE,EACnB,GAAG,EAAE,aAAa,KACf,SAAS,CAAC,SAAS,CAAC,CAAC;QAE1B,iBAAiB,CAAC,EAAE,CAClB,KAAK,EAAE,kBAAkB,EAAE,EAC3B,GAAG,EAAE,aAAa,GAAG;YACnB,KAAK,EAAE,MAAM,CAAC;YACd,SAAS,EAAE,WAAW,CAAC,iBAAiB,CAAC,CAAC;SAC3C,KACE,SAAS,CAAC,SAAS,CAAC,CAAC;QAE1B,sBAAsB,CAAC,EAAE,CACvB,KAAK,EAAE;YACL,QAAQ,EAAE,SAAS,CAAC;YACpB,SAAS,EAAE,SAAS,CAAC;YACrB,YAAY,EAAE,SAAS,CAAC;SACzB,EACD,GAAG,EAAE,aAAa,KACf,SAAS,CAAC,SAAS,CAAC,CAAC;QAE1B;;WAEG;QACH,yBAAyB,CAAC,EAAE,CAC1B,UAAU,EAAE,kBAAkB,EAAE,EAChC,GAAG,EAAE,aAAa,KACf,SAAS,CAAC,SAAS,CAAC,CAAC;QAE1B;;WAEG;QACH,gBAAgB,CAAC,EAAE,CACjB,KAAK,EAAE;YACL,UAAU,CAAC,EAAE;gBACX,IAAI,EAAE,aAAa,CAAC;gBACpB,QAAQ,EAAE,SAAS,CAAC;aACrB,EAAE,CAAC;YACJ,QAAQ,CAAC,EAAE;gBACT,IAAI,EAAE,WAAW,CAAC;gBAClB,QAAQ,EAAE,SAAS,CAAC;aACrB,EAAE,CAAC;SACL,EACD,GAAG,EAAE,aAAa,KACf,SAAS,CAAC,SAAS,CAAC,CAAC;QAE1B,qBAAqB,CAAC,EAAE,CACtB,KAAK,EAAE;YACL,MAAM,EAAE,SAAS,CAAC;YAClB,WAAW,EAAE,SAAS,CAAC;YACvB,UAAU,EAAE,SAAS,CAAC;YACtB,aAAa,EAAE,SAAS,CAAC;YAEzB,WAAW,EAAE,SAAS,CAAC;YACvB,UAAU,EAAE,SAAS,CAAC;YACtB,IAAI,EAAE,SAAS,CAAC;YAChB,SAAS,EAAE,SAAS,CAAC;YACrB,SAAS,EAAE,SAAS,CAAC;SACtB,EACD,GAAG,EAAE,aAAa,EAClB,MAAM,EAAE,WAAW,CAAC,iBAAiB,CAAC,KACnC,SAAS,CAAC,SAAS,CAAC,CAAC;QAE1B,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE;YAC5B,MAAM,EAAE,SAAS,CAAC;YAClB,WAAW,EAAE,SAAS,CAAC;YACvB,WAAW,EAAE,SAAS,CAAC;YACvB,UAAU,EAAE,SAAS,CAAC;YACtB,IAAI,EAAE,SAAS,CAAC;YAChB,QAAQ,EAAE,SAAS,CAAC;YACpB,SAAS,EAAE,SAAS,CAAC;YACrB,SAAS,EAAE,SAAS,CAAC;SACtB,KAAK,SAAS,CAAC,SAAS,CAAC,CAAC;KAC5B,CAAC;IAEF;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT,MAAM,CAAC,EAAE,CACP,OAAO,EAAE,eAAe,EACxB,GAAG,EAAE,aAAa,KACf,SAAS,CAAC,SAAS,CAAC,CAAC;QAE1B;;;;WAIG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,CAAC;IAEF;;OAEG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB;;WAEG;QACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE;YACf,IAAI,EAAE,MAAM,CAAC;YACb,MAAM,EAAE,iBAAiB,CAAC;YAC1B,GAAG,EAAE,aAAa,CAAC;SACpB,KAAK,SAAS,CAAC,SAAS,CAAC,CAAC;KAC5B,CAAC;IAEF,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC/B;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,MAAM,GAAG,iBAAiB,CAAC;IAClE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;IAE7B,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC,WAAW,CAAC;CACjC;AAED,wBAAgB,aAAa,CAC3B,MAAM,EAAE,aAAa,EACrB,OAAO,GAAE,oBAAyB,GACjC,EAAE,CAAC,YAAY,CAAC,CAoFlB"}
+{"version":3,"file":"api-page.d.ts","names":[],"sources":["../../src/ui/api-page.tsx"],"sourcesContent":[],"mappings":";;;;;;;;;;;;;;;;KA+BK,eAAe,IAAI,QAAQ;UAEf,oBAAA;;AAJkD;;;;;AAInE;;EAUgB,wBAAA,CAAA,EAAA,CAAA,CAAA,MAAA,EAAA,WAAA,CAAY,iBAAZ,CAAA,EAAA,UAAA,EAAA,MAAA,EAAA,GAAuD,SAAvD,CAAA,MAAA,CAAA,CAAA,GAAA,KAAA;EAAuD;;;EAMhB,mBAAA,CAAA,EAAA,CAAA,MAAA,EAAtB,iBAAsB,EAAA,GAAA,SAAA,CAAU,kBAAV,EAAA,CAAA;EAEjC,YAAA,CAAA,EAAL,IAAK,CAAA,sBAAA,EAAA,MAAA,GAAA,YAAA,CAAA,GAAiD,sBAAjD;EAAL;;;;;EAkBmC,kBAAA,CAAA,EAAA,OAAA;EAA4B;;;EAIrE,aAAA,CAAA,EAVO,MAUP,CAAA,MAAA,EAVsB,YAUtB,CAAA;EAEoB;;;EAEtB,OAAA,CAAA,EAAA;IAIS,kBAAA,CAAA,EAAA,CAAA,IAAA,EAZc,WAYd,EAAA,EAAA,GAAA,EAZkC,aAYlC,EAAA,GAZoD,SAYpD,CAZ8D,SAY9D,CAAA;IACC,iBAAA,CAAA,EAAA,CAAA,KAAA,EAVN,kBAUM,EAAA,EAAA,GAAA,EATR,aASQ,GAAA;MACG,KAAA,EAAA,MAAA;MAEX,SAAA,EAVQ,WAUR,CAVoB,iBAUpB,CAAA;IACQ,CAAA,EAAA,GATV,SASU,CATA,SASA,CAAA;IAAV,sBAAA,CAAA,EAAA,CAAA,KAAA,EAAA;MAMS,QAAA,EAXA,SAWA;MACP,SAAA,EAXQ,SAWR;MACQ,YAAA,EAXG,SAWH;IAAV,CAAA,EAAA,GAAA,EATE,aASF,EAAA,GARA,SAQA,CARU,SAQV,CAAA;IAQO;;;IAKI,yBAAA,CAAA,EAAA,CAAA,UAAA,EAfF,kBAeE,EAAA,EAAA,GAAA,EAdT,aAcS,EAAA,GAbX,SAaW,CAbD,SAaC,CAAA;IAGT;;;IAKK,gBAAA,CAAA,EAAA,CAAA,KAAA,EAAA;MACK,UAAA,CAAA,EAAA;QACD,IAAA,EAfJ,aAeI;QACG,QAAA,EAfH,SAeG;MAEF,CAAA,EAAA;MACD,QAAA,CAAA,EAAA;QACN,IAAA,EAhBE,WAgBF;QACK,QAAA,EAhBC,SAgBD;MACA,CAAA,EAAA;IAER,CAAA,EAAA,GAAA,EAhBA,aAgBA,EAAA,GAfF,SAeE,CAfQ,SAeR,CAAA;IACe,qBAAA,CAAA,EAAA,CAAA,KAAA,EAAA;MAAZ,MAAA,EAZE,SAYF;MACK,WAAA,EAZE,SAYF;MAAV,UAAA,EAXW,SAWX;MAGK,aAAA,EAbS,SAaT;MACK,WAAA,EAZE,SAYF;MACA,UAAA,EAZC,SAYD;MACD,IAAA,EAZJ,SAYI;MACN,SAAA,EAZO,SAYP;MACI,SAAA,EAZG,SAYH;IACC,CAAA,EAAA,GAAA,EAXN,aAWM,EAAA,MAAA,EAVH,WAUG,CAVS,iBAUT,CAAA,EAAA,GATR,SASQ,CATE,SASF,CAAA;IACA,mBAAA,CAAA,EAAA,CAAA,KAAA,EAAA;MACG,MAAA,EARN,SAQM;MAAV,WAAA,EAPS,SAOT;MAOa,WAAA,EAbJ,SAaI;MAAsB,UAAA,EAZ3B,SAY2B;MAA4B,IAAA,EAX7D,SAW6D;MAAV,QAAA,EAV/C,SAU+C;MAuBjD,SAAA,EAhCG,SAgCH;MACH,SAAA,EAhCM,SAgCN;IACS,CAAA,EAAA,GAhCV,SAgCU,CAhCA,SAgCA,CAAA;EAAV,CAAA;EAGC;;AAGX;EACoB,QAAA,CAAA,EAAA;IAAR,MAAA,CAAA,EAAA,CAAA,OAAA,EAhCW,eAgCX,EAAA,GAAA,EAhCiC,aAgCjC,EAAA,GAhCmD,SAgCnD,CAhC6D,SAgC7D,CAAA;IAAsC;;;;AAYlD;IAQiB,WAAA,CAAa,EAAA,OAAA;EAWd,CAAA;EACN;;;EAEP,UAAA,CAAA,EAAA;IAAE;;;;;;;;;cA3CS;WACH;UACD,UAAU;;WAGT;;UAGM,YAAA;YACL,QAAQ,8BAA8B;;;;;;eAOnC;aAEF;;UAGI,WAAA;;;;;UAKP,WAAA,CAAY;;UAGL,aAAA;;;;;;;;UAQP,WAAA,CAAY;;iBAGN,aAAA,SACN,yBACC,uBACR,GAAG"}