fumadocs-openapi 10.8.2 → 10.8.3

package/css/generated/shared.css

@@ -294,6 +294,7 @@
 @source inline("fallback");
 @source inline("false");
 @source inline("fast-content-type-parse");
+@source inline("fd-page-tree-item-name");
 @source inline("fetch");
 @source inline("fetchOptions");
 @source inline("fetcher");
@@ -536,6 +537,7 @@
 @source inline("mounted");
 @source inline("ms-2");
 @source inline("ms-auto");
+@source inline("mt-0!");
 @source inline("mt-10");
 @source inline("mt-2");
 @source inline("mt-4");
@@ -1081,6 +1083,7 @@
 @source inline("w-[600px]");
 @source inline("w-fit");
 @source inline("w-full");
+@source inline("warn");
 @source inline("we");
 @source inline("webhook");
 @source inline("webhooks");
@@ -1088,7 +1091,6 @@
 @source inline("whitespace-pre-wrap");
 @source inline("width");
 @source inline("will");
-@source inline("window");
 @source inline("with");
 @source inline("withBase");
 @source inline("withReplacements");

package/dist/playground/client.d.ts

@@ -23,6 +23,7 @@ interface PlaygroundClientProps extends ComponentProps<'form'>, SchemaScope {
   /** the OpenAPI document (not dereferenced) */
   doc: Document;
   proxyUrl?: string;
+  deprecated?: boolean;
 }
 interface CollapsiblePanelProps extends Omit<ComponentProps<typeof Collapsible>, 'title'> {
   'data-type': 'authorization' | 'body' | ParamType;
@@ -71,6 +72,7 @@ declare function PlaygroundClient({
   proxyUrl,
   writeOnly,
   readOnly,
+  deprecated,
   ...rest
 }: PlaygroundClientProps): _$react_jsx_runtime0.JSX.Element;
 declare const ParamTypes: readonly ["path", "header", "cookie", "query"];

package/dist/playground/client.js

@@ -1,15 +1,15 @@
 "use client";
 import { joinURL, resolveRequestData, resolveServerUrl, withBase } from "../utils/url.js";
 import { getPreferredType } from "../utils/schema/index.js";
-import { dereferenceSwallow } from "../utils/schema/dereference.js";
-import { cn } from "../utils/cn.js";
-import { MethodLabel } from "../ui/components/method-label.js";
 import { useStorageKey } from "../ui/client/storage-key.js";
 import { useApiContext, useServerContext } from "../ui/contexts/api.js";
 import { useTranslations } from "../ui/client/i18n.js";
+import { cn } from "../utils/cn.js";
 import { DefaultResultDisplay } from "./components/result-display.js";
+import { MethodLabel } from "../ui/components/method-label.js";
 import { useQuery } from "../utils/use-query.js";
 import { encodeRequestData } from "../requests/media/encode.js";
+import { dereferenceSwallow } from "../utils/schema/dereference.js";
 import { SchemaProvider, anyFields, useResolvedSchema } from "./schema.js";
 import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "../ui/components/select.js";
 import { labelVariants } from "../ui/components/input.js";
@@ -28,7 +28,7 @@ import { StfProvider, useDataEngine, useFieldValue, useListener, useStf } from "
 import { arrayStartsWith, objectGet, objectSet, stringifyFieldKey } from "@fumari/stf/lib/utils";
 import { useOnChange } from "fumadocs-core/utils/use-on-change";
 //#region src/playground/client.tsx
-function PlaygroundClient({ route, method, securities, doc, proxyUrl, writeOnly, readOnly, ...rest }) {
+function PlaygroundClient({ route, method, securities, doc, proxyUrl, writeOnly, readOnly, deprecated, ...rest }) {
 	const t = useTranslations();
 	const { parameters, body } = useMemo(() => {
 		const operation = doc.paths[route][method];
@@ -130,7 +130,7 @@ function PlaygroundClient({ route, method, securities, doc, proxyUrl, writeOnly,
 							/* @__PURE__ */ jsx(MethodLabel, { children: method }),
 							/* @__PURE__ */ jsx(Route, {
 								route,
-								className: "flex-1"
+								className: cn("flex-1", deprecated && "line-through")
 							}),
 							/* @__PURE__ */ jsx("button", {
 								type: "submit",

package/dist/playground/components/inputs.js

@@ -1,14 +1,14 @@
 "use client";
-import { cn } from "../../utils/cn.js";
 import { useTranslations } from "../../ui/client/i18n.js";
+import { cn } from "../../utils/cn.js";
 import { anyFields, useFieldInfo, useResolvedSchema, useSchemaScope, useSchemaUtils } from "../schema.js";
 import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "../../ui/components/select.js";
 import { Input, labelVariants } from "../../ui/components/input.js";
 import { useState } from "react";
 import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
-import { cva } from "class-variance-authority";
 import { ChevronRight, Plus, Trash2, X } from "lucide-react";
 import { buttonVariants } from "fumadocs-ui/components/ui/button";
+import { cva } from "class-variance-authority";
 import { useArray, useDataEngine, useFieldValue, useObject } from "@fumari/stf";
 import { stringifyFieldKey } from "@fumari/stf/lib/utils";
 //#region src/playground/components/inputs.tsx

package/dist/playground/components/oauth-dialog.js

@@ -1,6 +1,6 @@
-import { cn } from "../../utils/cn.js";
 import { useApiContext } from "../../ui/contexts/api.js";
 import { useTranslations } from "../../ui/client/i18n.js";
+import { cn } from "../../utils/cn.js";
 import { useQuery } from "../../utils/use-query.js";
 import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "../../ui/components/select.js";
 import { Input, labelVariants } from "../../ui/components/input.js";

package/dist/playground/components/result-display.js

@@ -1,14 +1,14 @@
 "use client";
-import { cn } from "../../utils/cn.js";
 import { useTranslations, withReplacements } from "../../ui/client/i18n.js";
 import { useStatusInfo } from "../status-info.js";
+import { cn } from "../../utils/cn.js";
 import { ClientCodeBlock } from "../../ui/components/codeblock.js";
 import { require_fast_content_type_parse } from "../../node_modules/.pnpm/fast-content-type-parse@3.0.0/node_modules/fast-content-type-parse/index.js";
 import { useEffect, useMemo, useState } from "react";
 import { jsx, jsxs } from "react/jsx-runtime";
-import { cva } from "class-variance-authority";
 import { CircleX } from "lucide-react";
 import { buttonVariants } from "fumadocs-ui/components/ui/button";
+import { cva } from "class-variance-authority";
 //#region src/playground/components/result-display.tsx
 var import_fast_content_type_parse = require_fast_content_type_parse();
 const panelVariants = cva("flex flex-col gap-2 mt-2 px-3 py-2 border-y bg-fd-secondary text-fd-secondary-foreground");

package/dist/playground/components/server-select.js

@@ -1,8 +1,8 @@
 "use client";
 import { resolveServerUrl, withBase } from "../../utils/url.js";
-import { cn } from "../../utils/cn.js";
 import { useServerContext } from "../../ui/contexts/api.js";
 import { useTranslations } from "../../ui/client/i18n.js";
+import { cn } from "../../utils/cn.js";
 import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "../../ui/components/select.js";
 import { Input, labelVariants } from "../../ui/components/input.js";
 import { Dialog, DialogContent, DialogDescription, DialogHeader, DialogTitle, DialogTrigger } from "../../ui/components/dialog.js";

package/dist/playground/schema.js

@@ -1,7 +1,7 @@
-import { dereferenceSwallow } from "../utils/schema/dereference.js";
 import { mergeAllOf } from "../utils/schema/merge.js";
 import { sample } from "../utils/schema/sample.js";
 import { schemaToString } from "../utils/schema/to-string.js";
+import { dereferenceSwallow } from "../utils/schema/dereference.js";
 import { createContext, use, useMemo } from "react";
 import { jsx } from "react/jsx-runtime";
 import { Ajv2020 } from "ajv/dist/2020.js";

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

@@ -19,6 +19,7 @@ declare module 'fumadocs-core/source' {
 interface InternalOpenAPIMeta {
   method?: string;
   webhook?: boolean;
+  deprecated?: boolean;
 }
 /**
  * Fumadocs Source API integration, pass this to `plugins` array in `loader()`.

package/dist/server/source-api.js

@@ -17,6 +17,10 @@ function openapiPlugin() {
 			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,
 				" ",
@@ -76,7 +80,8 @@ async function openapiSource(server, options = {}) {
 					...toStaticData(props, processed.dereferenced),
 					_openapi: {
 						method: entry.type === "operation" || entry.type === "webhook" ? entry.item.method : void 0,
-						webhook: entry.type === "webhook"
+						webhook: entry.type === "webhook",
+						deprecated: entry.info.deprecated
 					}
 				}
 			});

package/dist/ui/base.js

@@ -1,7 +1,7 @@
 import { parseSecurities } from "../utils/schema/index.js";
-import { encodeInternalRef } from "../utils/schema/ref.js";
 import { defaultAdapters } from "../requests/media/adapter.js";
 import { ClientCodeBlockProvider } from "./components/codeblock.js";
+import { encodeInternalRef } from "../utils/schema/ref.js";
 import { APIPage } from "./api-page.js";
 import { pickSchema } from "../utils/schema/pick.js";
 import { PlaygroundAuthProvider } from "./client/boundary.lazy.js";
@@ -54,7 +54,8 @@ function createAPIPage(server, options) {
 			])),
 			proxyUrl: ctx.proxyUrl,
 			writeOnly: true,
-			readOnly: false
+			readOnly: false,
+			deprecated: method.deprecated
 		});
 	}
 	return async function APIPageWrapper({ document, ...props }) {

package/dist/ui/components/dialog.js

@@ -1,6 +1,6 @@
 "use client";
-import { cn } from "../../utils/cn.js";
 import { useTranslations } from "../client/i18n.js";
+import { cn } from "../../utils/cn.js";
 import * as React from "react";
 import { jsx, jsxs } from "react/jsx-runtime";
 import { X } from "lucide-react";

package/dist/ui/create-client.js

@@ -1,8 +1,8 @@
 import { parseSecurities } from "../utils/schema/index.js";
-import { dereferenceDocument } from "../utils/document/dereference.js";
 import { defaultAdapters } from "../requests/media/adapter.js";
 import { ClientCodeBlock, ClientCodeBlockProvider } from "./components/codeblock.js";
 import { AuthProvider } from "../playground/auth.js";
+import { dereferenceDocument } from "../utils/document/dereference.js";
 import { APIPage } from "./api-page.js";
 import { boundary_exports } from "./client/boundary.js";
 import { slug } from "github-slugger";
@@ -64,7 +64,8 @@ function createClientAPIPage({ shiki = defaultShikiFactory, shikiOptions = { the
 			doc: ctx.schema.bundled,
 			proxyUrl: ctx.proxyUrl,
 			writeOnly: true,
-			readOnly: false
+			readOnly: false,
+			deprecated: method.deprecated
 		});
 	}
 	function renderPlaygroundProviderDefault({ children }) {

package/dist/ui/operation/client.js

@@ -1,6 +1,6 @@
 "use client";
-import { cn } from "../../utils/cn.js";
 import { useTranslations } from "../client/i18n.js";
+import { cn } from "../../utils/cn.js";
 import { createContext, use, useMemo, useRef, useState } from "react";
 import { jsx, jsxs } from "react/jsx-runtime";
 import { Check, Copy } from "lucide-react";

package/dist/ui/operation/index.js

@@ -1,10 +1,10 @@
 import { idToTitle } from "../../utils/id-to-title.js";
 import { createMethod, methodKeys } from "../../utils/schema/index.js";
-import { cn } from "../../utils/cn.js";
-import { Badge, MethodLabel } from "../components/method-label.js";
 import { isMediaTypeSupported } from "../../requests/media/resolve-adapter.js";
 import "../../requests/media/adapter.js";
 import { I18nLabel } from "../client/i18n.js";
+import { cn } from "../../utils/cn.js";
+import { Badge, MethodLabel } from "../components/method-label.js";
 import { CopyTypeScriptPanel, OperationProvider } from "./client.js";
 import { Schema } from "../schema/index.js";
 import { AccordionContent, AccordionHeader, AccordionItem, AccordionTrigger, Accordions } from "../components/accordion.js";
@@ -14,6 +14,7 @@ import { getExampleRequests } from "./get-example-requests.js";
 import { SelectTab, SelectTabTrigger, SelectTabs } from "../components/select-tab.js";
 import { Fragment, use, useMemo } from "react";
 import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
+import { Callout } from "fumadocs-ui/components/callout";
 //#region src/ui/operation/index.tsx
 const paramTypeKeys = [
 	"path",
@@ -37,9 +38,20 @@ function Operation({ type = "operation", path, method, ctx, showTitle, showDescr
 	]);
 	if (showTitle) {
 		const title = method.summary || (method.operationId ? idToTitle(method.operationId) : path);
-		headNode = ctx.renderHeading(headingLevel, title);
+		headNode = /* @__PURE__ */ jsxs("div", {
+			className: "flex gap-2 items-center justify-between",
+			children: [ctx.renderHeading(headingLevel, title, { className: "my-0!" }), method.deprecated && /* @__PURE__ */ jsx(Badge, {
+				color: "yellow",
+				className: "text-xs not-prose",
+				children: /* @__PURE__ */ jsx(I18nLabel, { label: "deprecated" })
+			})]
+		});
 		headingLevel++;
-	}
+	} else if (method.deprecated) headNode = /* @__PURE__ */ jsx(Callout, {
+		type: "warn",
+		title: /* @__PURE__ */ jsx(I18nLabel, { label: "deprecated" }),
+		className: "mt-0!"
+	});
 	const contentTypes = body?.content ? Object.entries(body.content) : null;
 	if (body && contentTypes && contentTypes.length > 0) {
 		const items = contentTypes.map(([key]) => ({
@@ -237,7 +249,7 @@ function Operation({ type = "operation", path, method, ctx, showTitle, showDescr
 					className: "text-xs",
 					children: method.method
 				}), /* @__PURE__ */ jsx("code", {
-					className: "flex-1 overflow-auto text-nowrap text-[0.8125rem] text-fd-muted-foreground",
+					className: cn("flex-1 overflow-auto text-nowrap text-[0.8125rem] text-fd-muted-foreground", method.deprecated && "line-through"),
 					children: path
 				})]
 			}),

package/dist/ui/operation/request-tabs.js

@@ -1,6 +1,6 @@
 import { resolveRequestData } from "../../utils/url.js";
-import { MethodLabel } from "../components/method-label.js";
 import { I18nLabel } from "../client/i18n.js";
+import { MethodLabel } from "../components/method-label.js";
 import { AccordionContent, AccordionHeader, AccordionItem, AccordionTrigger, Accordions } from "../components/accordion.js";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import { Tabs, TabsContent, TabsList, TabsTrigger } from "fumadocs-ui/components/tabs";

package/dist/ui/operation/usage-tabs/client.js

@@ -46,17 +46,19 @@ function UsageTab({ id, lang, _client }) {
 	const { examples, example: selectedExampleId, route, addListener, removeListener } = useOperationContext();
 	const { server } = useServerContext();
 	const codegen = codeUsages.get(id);
+	const [mounted, setMounted] = useState(false);
 	const [data, setData] = useState(() => examples.find((example) => example.id === selectedExampleId)?.encoded);
 	useEffect(() => {
 		const listener = (_, encoded) => setData(encoded);
 		addListener(listener);
+		setMounted(true);
 		return () => {
 			removeListener(listener);
 		};
 	}, [addListener, removeListener]);
 	const code = useMemo(() => {
 		if (!data) return;
-		const url = joinURL(server && typeof window !== "undefined" ? withBase(resolveServerUrl(server.url, server.variables), window.location.origin) : "https://example.com", resolveRequestData(route, data));
+		const url = joinURL(server && mounted ? withBase(resolveServerUrl(server.url, server.variables), window.location.origin) : "https://example.com", resolveRequestData(route, data));
 		if (_client) {
 			const { generate, serverContext } = _client;
 			if (typeof generate === "string") return generate;
@@ -74,6 +76,7 @@ function UsageTab({ id, lang, _client }) {
 		data,
 		server,
 		route,
+		mounted,
 		_client,
 		codegen,
 		mediaAdapters

package/dist/ui/schema/client.js

@@ -1,12 +1,12 @@
 "use client";
+import { useTranslations } from "../client/i18n.js";
 import { cn } from "../../utils/cn.js";
 import { Badge } from "../components/method-label.js";
-import { useTranslations } from "../client/i18n.js";
 import { Fragment, Suspense, createContext, use, useCallback, useDeferredValue, useEffect, useLayoutEffect, useMemo, useRef, useState } from "react";
 import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
-import { cva } from "class-variance-authority";
 import { ChevronDown, FilterIcon } from "lucide-react";
 import { buttonVariants } from "fumadocs-ui/components/ui/button";
+import { cva } from "class-variance-authority";
 import { Collapsible, CollapsibleContent, CollapsibleTrigger } from "fumadocs-ui/components/ui/collapsible";
 import { Tabs, TabsContent, TabsList, TabsTrigger } from "fumadocs-ui/components/tabs";
 import { Popover, PopoverContent, PopoverTrigger } from "fumadocs-ui/components/ui/popover";

package/dist/utils/pages/builder.d.ts

@@ -11,6 +11,7 @@ interface BaseEntry {
   info: {
     title: string;
     description?: string;
+    deprecated?: boolean;
   };
 }
 interface OperationOutput extends BaseEntry {

package/dist/utils/pages/preset-auto.js

@@ -162,7 +162,8 @@ function createAutoPreset(options) {
 				item: op,
 				info: {
 					title: displayName,
-					description: operation.description ?? pathItem.description
+					description: operation.description ?? pathItem.description,
+					deprecated: operation.deprecated
 				}
 			});
 		}
@@ -173,7 +174,8 @@ function createAutoPreset(options) {
 				schemaId: builder.id,
 				info: {
 					title: displayName,
-					description: operation.description ?? pathItem.description
+					description: operation.description ?? pathItem.description,
+					deprecated: operation.deprecated
 				},
 				item: webhook
 			});

package/dist/utils/pages/to-text.d.ts

@@ -34,7 +34,7 @@ interface PagesToTextOptions {
 }
 type DocumentContext = {
   type: 'tag';
-  tag: TagObject | undefined;
+  tag: TagObject;
 } | {
   type: 'operation';
 } | {

package/dist/utils/pages/to-text.js

@@ -5,25 +5,13 @@ import { dump } from "js-yaml";
 //#region src/utils/pages/to-text.ts
 function toText(entry, processed, options = {}) {
 	switch (entry.type) {
-		case "operation": return generatePage(entry.schemaId, processed, { operations: [entry.item] }, {
-			...options,
-			...entry.info
-		}, { type: "operation" });
+		case "operation": return generatePage(entry.schemaId, processed, { operations: [entry.item] }, options, entry);
 		case "page": return generatePage(entry.schemaId, processed, {
 			operations: entry.operations,
 			webhooks: entry.webhooks,
 			showTitle: true
-		}, {
-			...options,
-			...entry.info
-		}, entry.tag ? {
-			type: "tag",
-			tag: entry.tag
-		} : { type: "file" });
-		case "webhook": return generatePage(entry.schemaId, processed, { webhooks: [entry.item] }, {
-			...options,
-			...entry.info
-		}, { type: "operation" });
+		}, options, entry);
+		case "webhook": return generatePage(entry.schemaId, processed, { webhooks: [entry.item] }, options, entry);
 	}
 }
 function generateDocument(frontmatter, content, options) {
@@ -41,26 +29,33 @@ function generateDocument(frontmatter, content, options) {
 	out.push(content);
 	return out.join("\n\n");
 }
-function generatePage(schemaId, processed, pageProps, options, context) {
+function generatePage(schemaId, processed, pageProps, options, entry) {
 	const { frontmatter, includeDescription = false } = options;
-	const extend = frontmatter?.(options.title, options.description, context);
+	const extend = frontmatter?.(entry.info.title, entry.info.description, entry.type === "page" ? entry.tag ? {
+		type: "tag",
+		tag: entry.tag
+	} : { type: "file" } : { type: "operation" });
 	const page = {
 		...pageProps,
 		document: schemaId
 	};
 	let meta;
-	if (page.operations?.length === 1) meta = { method: page.operations[0].method.toUpperCase() };
+	if (page.operations?.length === 1) meta = {
+		method: page.operations[0].method.toUpperCase(),
+		deprecated: entry.info.deprecated
+	};
 	else if (page.webhooks?.length === 1) meta = {
 		method: page.webhooks[0].method.toUpperCase(),
-		webhook: true
+		webhook: true,
+		deprecated: entry.info.deprecated
 	};
 	const data = toStaticData(page, processed.dereferenced);
 	const content = [];
-	if (options.description && includeDescription) content.push(options.description);
+	if (entry.info.description && includeDescription) content.push(entry.info.description);
 	content.push(pageContent(page));
 	return generateDocument({
-		title: options.title,
-		description: !includeDescription ? options.description : void 0,
+		title: entry.info.title,
+		description: !includeDescription ? entry.info.description : void 0,
 		full: true,
 		...extend,
 		_openapi: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "10.8.2",
+  "version": "10.8.3",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "Docs",
@@ -55,7 +55,7 @@
     "remark": "^15.0.1",
     "remark-rehype": "^11.1.2",
     "shiki": "^4.0.2",
-    "tailwind-merge": "^3.5.0",
+    "tailwind-merge": "^3.6.0",
     "xml-js": "^1.6.11",
     "@fumari/stf": "1.0.5"
   },
@@ -72,8 +72,8 @@
     "json-schema-typed": "^8.0.2",
     "tailwindcss": "^4.3.0",
     "tsdown": "0.22.0",
-    "fumadocs-core": "16.8.9",
-    "fumadocs-ui": "16.8.9",
+    "fumadocs-core": "16.8.11",
+    "fumadocs-ui": "16.8.11",
     "tsconfig": "0.0.0"
   },
   "peerDependencies": {