fumadocs-openapi 10.8.5 → 10.9.0

package/dist/server/create.d.ts

@@ -1,40 +0,0 @@
-import { InlineCodeUsageGenerator } from "../requests/generators/index.js";
-import { createProxy } from "./proxy.js";
-import { ProcessedDocument } from "../utils/document/process.js";
-import { Document } from "../types.js";
-
-//#region src/server/create.d.ts
-/**
- * schema id -> file path, URL, or downloaded schema object
- */
-type SchemaMap = Record<string, string | Document>;
-type ProcessedSchemaMap = Record<string, ProcessedDocument>;
-interface OpenAPIOptions {
-  /**
-   * Schema files, can be:
-   * - URL
-   * - file path
-   * - a function returning records of downloaded schemas.
-   */
-  input?: string[] | (() => SchemaMap | Promise<SchemaMap>);
-  disableCache?: boolean;
-  /**
-   * The url of proxy to avoid CORS issues
-   */
-  proxyUrl?: string;
-}
-interface OpenAPIServer {
-  createProxy: typeof createProxy;
-  getSchemas: () => Promise<ProcessedSchemaMap>;
-  getSchema: (document: string) => Promise<ProcessedDocument>;
-  /** @private internal API */
-  _getWatchPaths: () => string[];
-  readonly options: OpenAPIOptions;
-}
-declare function createOpenAPI(options?: OpenAPIOptions): OpenAPIServer;
-/**
- * @deprecated
- */
-declare function createCodeSample<T>(options: InlineCodeUsageGenerator<T>): InlineCodeUsageGenerator<T>;
-//#endregion
-export { OpenAPIOptions, OpenAPIServer, createCodeSample, createOpenAPI };

package/dist/server/create.js

@@ -1,42 +0,0 @@
-import { createProxy } from "./proxy.js";
-import { processDocument } from "../utils/document/process.js";
-import fs from "node:fs";
-//#region src/server/create.ts
-function createOpenAPI(options = {}) {
-	const { input = [], disableCache = false } = options;
-	let schemas;
-	async function getSchemas() {
-		if (Array.isArray(input)) {
-			const entries = await Promise.all(input.map(async (item) => [item, await processDocument(item)]));
-			return Object.fromEntries(entries);
-		} else {
-			const entries = await Promise.all(Object.entries(await input()).map(async ([k, v]) => [k, await processDocument(v)]));
-			return Object.fromEntries(entries);
-		}
-	}
-	return {
-		options,
-		createProxy,
-		_getWatchPaths() {
-			return (Array.isArray(input) ? input : Object.keys(input)).filter((key) => !URL.canParse(key) && fs.existsSync(key));
-		},
-		async getSchema(document) {
-			const schemas = await this.getSchemas();
-			if (document in schemas) return schemas[document];
-			console.warn(`[Fumadocs OpenAPI] the document "${document}" is not listed in the input array, this may not be expected.`);
-			return processDocument(document);
-		},
-		async getSchemas() {
-			if (disableCache) return getSchemas();
-			return schemas ??= getSchemas();
-		}
-	};
-}
-/**
-* @deprecated
-*/
-function createCodeSample(options) {
-	return options;
-}
-//#endregion
-export { createCodeSample, createOpenAPI };

package/dist/server/source-api.d.ts

@@ -1,55 +0,0 @@
-import { OpenAPIServer } from "./create.js";
-import { ApiPageProps } from "../ui/api-page.js";
-import { SchemaToPagesOptions } from "../utils/pages/preset-auto.js";
-import { ClientApiPageProps } from "../ui/create-client.js";
-import { DereferencedDocument } from "../utils/document/dereference.js";
-import { LoaderPlugin, MetaData, PageData, PageTreeTransformer, Source } from "fumadocs-core/source";
-import { StructuredData } from "fumadocs-core/mdx-plugins";
-import { TOCItemType } from "fumadocs-core/toc";
-
-//#region src/server/source-api.d.ts
-declare module 'fumadocs-core/source' {
-  interface PageData {
-    /**
-     * Added by Fumadocs OpenAPI
-     */
-    _openapi?: InternalOpenAPIMeta;
-  }
-}
-interface InternalOpenAPIMeta {
-  method?: string;
-  webhook?: boolean;
-  deprecated?: boolean;
-}
-/**
- * Fumadocs Source API integration, pass this to `plugins` array in `loader()`.
- */
-declare function openapiPlugin(): LoaderPlugin;
-interface OpenAPIPageData extends PageData {
-  getAPIPageProps: () => ApiPageProps;
-  getSchema: () => {
-    id: string;
-  } & DereferencedDocument;
-  getClientAPIPageProps: () => Promise<ClientApiPageProps>;
-  structuredData: StructuredData;
-  toc: TOCItemType[];
-}
-type OpenAPISourceOptions = SchemaToPagesOptions & {
-  baseDir?: string; /** Generate `meta.json` files */
-  meta?: boolean | {
-    folderStyle?: 'folder' | 'separator';
-  };
-};
-/**
- * Generate virtual pages for Fumadocs Source API
- */
-declare function openapiSource(server: OpenAPIServer, options?: OpenAPISourceOptions): Promise<Source<{
-  metaData: MetaData;
-  pageData: OpenAPIPageData;
-}>>;
-/**
- * @deprecated use `openapiPlugin()`
- */
-declare function transformerOpenAPI(): PageTreeTransformer;
-//#endregion
-export { InternalOpenAPIMeta, OpenAPIPageData, OpenAPISourceOptions, openapiPlugin, openapiSource, transformerOpenAPI };

package/dist/server/source-api.js

@@ -1,149 +0,0 @@
-import { toStaticData } from "../utils/pages/to-static-data.js";
-import { MethodLabel } from "../ui/components/method-label.js";
-import path from "node:path";
-import { PathUtils } from "fumadocs-core/source";
-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()`.
-*/
-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.deprecated) node.name = /* @__PURE__ */ jsx("span", {
-				className: "fd-page-tree-item-name line-through",
-				children: node.name
-			});
-			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
-*/
-async function openapiSource(server, options = {}) {
-	const { baseDir = "", meta = false } = options;
-	const { createAutoPreset } = await import("../utils/pages/preset-auto.js");
-	const { fromServer } = await import("../utils/pages/builder.js");
-	const files = [];
-	const entries = await fromServer(server, createAutoPreset(options));
-	for (const [schemaId, list] of Object.entries(entries)) {
-		const processed = await server.getSchema(schemaId);
-		function onEntry(entry) {
-			const props = getProps(entry);
-			files.push({
-				type: "page",
-				path: `${baseDir}/${entry.path}`,
-				data: {
-					...entry.info,
-					getAPIPageProps() {
-						return props;
-					},
-					async getClientAPIPageProps() {
-						return {
-							payload: {
-								bundled: processed.bundled,
-								proxyUrl: server.options.proxyUrl
-							},
-							...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",
-						deprecated: entry.info.deprecated
-					}
-				}
-			});
-		}
-		function onEntries(entries, parent) {
-			if (!meta) {
-				for (const entry of entries) if (entry.type === "group") onEntries(entry.entries, entry);
-				else onEntry(entry);
-				return;
-			}
-			const { folderStyle = "folder" } = meta === true ? {} : meta;
-			const pages = [];
-			for (const entry of entries) {
-				const relativePath = PathUtils.slash(parent ? path.relative(parent.path, entry.path) : entry.path);
-				if (entry.type === "group") {
-					onEntries(entry.entries, entry);
-					if (folderStyle === "folder") pages.push(relativePath);
-					else pages.push(`---${entry.info.title}---`, `...${relativePath}`);
-				} else {
-					onEntry(entry);
-					pages.push(relativePath.slice(0, -PathUtils.extname(entry.path).length));
-				}
-			}
-			if (pages.length === 0) return;
-			files.push({
-				type: "meta",
-				path: path.join(baseDir, parent?.path ?? "", "meta.json"),
-				data: {
-					title: parent?.info.title,
-					description: parent?.info.description,
-					pages
-				}
-			});
-		}
-		onEntries(list);
-	}
-	return { files };
-}
-function getProps(entry) {
-	if (entry.type === "operation") return {
-		document: entry.schemaId,
-		operations: [entry.item],
-		showDescription: true
-	};
-	if (entry.type === "webhook") return {
-		document: entry.schemaId,
-		webhooks: [entry.item],
-		showDescription: true
-	};
-	return {
-		showTitle: true,
-		showDescription: true,
-		document: entry.schemaId,
-		operations: entry.operations,
-		webhooks: entry.webhooks
-	};
-}
-/**
-* @deprecated use `openapiPlugin()`
-*/
-function transformerOpenAPI() {
-	return openapiPlugin().transformPageTree;
-}
-//#endregion
-export { openapiPlugin, openapiSource, transformerOpenAPI };