fumadocs-openapi 10.6.5 → 10.6.7

package/css/generated/shared.css

@@ -45,6 +45,7 @@
 @source inline("allFlows");
 @source inline("allOf");
 @source inline("already");
+@source inline("alt");
 @source inline("and");
 @source inline("animate-spin");
 @source inline("another");
@@ -54,8 +55,11 @@
 @source inline("apiExample");
 @source inline("apiKey");
 @source inline("apiPlayground");
+@source inline("application/javascript");
 @source inline("application/json");
+@source inline("application/x-javascript");
 @source inline("application/x-www-form-urlencoded");
+@source inline("application/xml");
 @source inline("apply");
 @source inline("aria-label");
 @source inline("array");
@@ -65,7 +69,8 @@
 @source inline("auth-specific");
 @source inline("authBasicTokenExample");
 @source inline("authBearerTokenExample");
-@source inline("authCodeCallback");
+@source inline("authCodeQuery");
+@source inline("authCtx");
 @source inline("authNode");
 @source inline("authSchemes");
 @source inline("authScope");
@@ -95,6 +100,7 @@
 @source inline("bg-fd-primary/10");
 @source inline("bg-fd-secondary");
 @source inline("binary");
+@source inline("blob");
 @source inline("blue");
 @source inline("body");
 @source inline("bodyMediaType");
@@ -104,17 +110,21 @@
 @source inline("border");
 @source inline("border-b");
 @source inline("border-current");
+@source inline("border-fd-border");
 @source inline("border-fd-primary/20");
+@source inline("border-s");
 @source inline("border-t");
 @source inline("border-x");
 @source inline("border-y");
 @source inline("both");
 @source inline("boundary");
+@source inline("buffer");
 @source inline("bundled");
 @source inline("but");
 @source inline("button");
 @source inline("buttonVariants");
 @source inline("by");
+@source inline("byteLength");
 @source inline("cache");
 @source inline("cached");
 @source inline("call");
@@ -127,6 +137,7 @@
 @source inline("causes");
 @source inline("change");
 @source inline("changes");
+@source inline("charset");
 @source inline("check");
 @source inline("child");
 @source inline("children");
@@ -140,6 +151,7 @@
 @source inline("clientId");
 @source inline("clientSecret");
 @source inline("client_credentials");
+@source inline("client_error");
 @source inline("client_id");
 @source inline("client_secret");
 @source inline("cloned");
@@ -176,6 +188,7 @@
 @source inline("createRehypeCode");
 @source inline("credentials");
 @source inline("css");
+@source inline("csv");
 @source inline("ctx");
 @source inline("current");
 @source inline("currentRef");
@@ -211,6 +224,7 @@
 @source inline("defaultExampleId");
 @source inline("defaultItem");
 @source inline("defaultMdxComponents");
+@source inline("defaultOpen");
 @source inline("defaultShikiFactory");
 @source inline("defaultValue");
 @source inline("defaultValues");
@@ -275,12 +289,13 @@
 @source inline("export");
 @source inline("extends");
 @source inline("factory");
+@source inline("fall");
 @source inline("fallback");
 @source inline("false");
+@source inline("fast-content-type-parse");
 @source inline("fetch");
 @source inline("fetchOptions");
 @source inline("fetcher");
-@source inline("fetchingToken");
 @source inline("field");
 @source inline("fieldData");
 @source inline("fieldLabelVariants");
@@ -303,6 +318,7 @@
 @source inline("flex-col-reverse");
 @source inline("flex-row");
 @source inline("flex-wrap");
+@source inline("flow");
 @source inline("flows");
 @source inline("focus-visible:outline-none");
 @source inline("focus-visible:ring-1");
@@ -361,7 +377,6 @@
 @source inline("getExampleRequests");
 @source inline("getSchema");
 @source inline("getSchemaId");
-@source inline("getStatusInfo");
 @source inline("ghost");
 @source inline("github-dark");
 @source inline("github-light");
@@ -382,7 +397,9 @@
 @source inline("h-[240px]");
 @source inline("h-px");
 @source inline("h1");
+@source inline("handling");
 @source inline("hasHead");
+@source inline("hash");
 @source inline("hast");
 @source inline("hast-util-to-jsx-runtime");
 @source inline("headNode");
@@ -418,7 +435,7 @@
 @source inline("infer");
 @source inline("info");
 @source inline("infoTags");
-@source inline("initAuthValues");
+@source inline("initAuthInputs");
 @source inline("initial");
 @source inline("initialPath");
 @source inline("inline-flex");
@@ -449,6 +466,7 @@
 @source inline("items-end");
 @source inline("items-start");
 @source inline("j");
+@source inline("js");
 @source inline("json");
 @source inline("json-schema-typed");
 @source inline("justify-between");
@@ -482,7 +500,6 @@
 @source inline("localStorage");
 @source inline("lucide-react");
 @source inline("map");
-@source inline("mapInputs");
 @source inline("max");
 @source inline("max-age");
 @source inline("max-h-[460px]");
@@ -490,6 +507,7 @@
 @source inline("max-w-full");
 @source inline("max-w-lg");
 @source inline("may");
+@source inline("mb-1");
 @source inline("mb-2");
 @source inline("mb-4");
 @source inline("md");
@@ -505,6 +523,7 @@
 @source inline("metaData");
 @source inline("method");
 @source inline("migrated");
+@source inline("mime");
 @source inline("min");
 @source inline("min-h-(--initial-height,0)");
 @source inline("min-w-0");
@@ -574,6 +593,7 @@
 @source inline("openapi");
 @source inline("openapi-sampler");
 @source inline("openapi-types");
+@source inline("openid");
 @source inline("operation");
 @source inline("operationId");
 @source inline("operations");
@@ -582,7 +602,6 @@
 @source inline("orange");
 @source inline("order-last");
 @source inline("origin");
-@source inline("original");
 @source inline("other");
 @source inline("out");
 @source inline("outline");
@@ -598,8 +617,10 @@
 @source inline("p-4");
 @source inline("packages");
 @source inline("page");
+@source inline("page-level");
 @source inline("pageData");
 @source inline("pages");
+@source inline("panelVariants");
 @source inline("param");
 @source inline("paramTypeKeys");
 @source inline("parameter");
@@ -629,6 +650,7 @@
 @source inline("peer-disabled:opacity-70");
 @source inline("perhaps");
 @source inline("persist");
+@source inline("persisted");
 @source inline("persistent");
 @source inline("pickExample");
 @source inline("pickSchema");
@@ -657,6 +679,7 @@
 @source inline("property");
 @source inline("props");
 @source inline("prose-no-margin");
+@source inline("provider");
 @source inline("proxy");
 @source inline("proxyForwardCookie");
 @source inline("proxyUrl");
@@ -736,6 +759,9 @@
 @source inline("requestUrl");
 @source inline("requests");
 @source inline("required");
+@source inline("requirement");
+@source inline("requirementId");
+@source inline("requirements");
 @source inline("res");
 @source inline("reset");
 @source inline("resize-none");
@@ -756,6 +782,7 @@
 @source inline("result");
 @source inline("return");
 @source inline("returned");
+@source inline("role");
 @source inline("root");
 @source inline("rotate-90");
 @source inline("rounded-lg");
@@ -764,6 +791,7 @@
 @source inline("rounded-xl");
 @source inline("route");
 @source inline("s");
+@source inline("safeParse");
 @source inline("same");
 @source inline("sample");
 @source inline("sampleKey");
@@ -773,6 +801,7 @@
 @source inline("schemaExample");
 @source inline("schemaFormat");
 @source inline("schemaHideArray");
+@source inline("schemaId");
 @source inline("schemaItems");
 @source inline("schemaLength");
 @source inline("schemaMatch");
@@ -785,6 +814,8 @@
 @source inline("schemaValueIn");
 @source inline("schemas");
 @source inline("scheme");
+@source inline("schemeId");
+@source inline("schemes");
 @source inline("scope");
 @source inline("scopes");
 @source inline("scroll");
@@ -822,13 +853,16 @@
 @source inline("setIsMounted");
 @source inline("setMounted");
 @source inline("setNextName");
+@source inline("setObjectUrl");
 @source inline("setOpen");
 @source inline("setPath");
+@source inline("setRequirementId");
 @source inline("setSearch");
 @source inline("setSecurityId");
 @source inline("setServer");
 @source inline("setServerVariables");
 @source inline("setShow");
+@source inline("setStore");
 @source inline("setToken");
 @source inline("setTruncated");
 @source inline("setType");
@@ -866,8 +900,10 @@
 @source inline("sm:justify-end");
 @source inline("sm:text-start");
 @source inline("so");
+@source inline("source");
 @source inline("spec");
 @source inline("specify");
+@source inline("src");
 @source inline("state");
 @source inline("status");
 @source inline("statusBadRequest");
@@ -881,6 +917,7 @@
 @source inline("statuses");
 @source inline("step");
 @source inline("stf");
+@source inline("stfSync");
 @source inline("sticky");
 @source inline("storageKey");
 @source inline("storageKeyPrefix");
@@ -897,6 +934,7 @@
 @source inline("summary");
 @source inline("support");
 @source inline("supported");
+@source inline("svg");
 @source inline("switch");
 @source inline("t");
 @source inline("tab");
@@ -929,13 +967,17 @@
 @source inline("text-start");
 @source inline("text-xs");
 @source inline("text-yellow-600");
+@source inline("text/css");
+@source inline("text/csv");
 @source inline("text/html");
+@source inline("text/plain");
 @source inline("that");
 @source inline("the");
 @source inline("their");
 @source inline("theme");
 @source inline("themes");
 @source inline("this");
+@source inline("through");
 @source inline("throw");
 @source inline("timeout");
 @source inline("timerRef");
@@ -950,6 +992,7 @@
 @source inline("toStaticData");
 @source inline("toc");
 @source inline("token");
+@source inline("tokenInfo");
 @source inline("token_type");
 @source inline("toolbar");
 @source inline("top-0");
@@ -958,6 +1001,7 @@
 @source inline("top-2");
 @source inline("tracking-tight");
 @source inline("transform");
+@source inline("transformAuthInputs");
 @source inline("transformPageTree");
 @source inline("transition-colors");
 @source inline("transition-transform");
@@ -979,11 +1023,14 @@
 @source inline("undefined");
 @source inline("under");
 @source inline("underline");
+@source inline("unexpected");
 @source inline("union");
 @source inline("unionField");
 @source inline("unknown");
+@source inline("update");
 @source inline("updateInfo");
 @source inline("updated");
+@source inline("updatedSchemeId");
 @source inline("updating");
 @source inline("url");
 @source inline("usage");
@@ -992,6 +1039,7 @@
 @source inline("use");
 @source inline("useApiClientModal");
 @source inline("useApiContext");
+@source inline("useAuth");
 @source inline("useCopyButton");
 @source inline("useFieldValue");
 @source inline("useForm");
@@ -999,12 +1047,14 @@
 @source inline("useMemo");
 @source inline("useNamespace");
 @source inline("useObject");
+@source inline("useOnChange");
 @source inline("useOperationContext");
 @source inline("useQuery");
 @source inline("useRef");
 @source inline("useResolvedSchema");
 @source inline("useServerContext");
 @source inline("useState");
+@source inline("useStatusInfo");
 @source inline("useStf");
 @source inline("useStorageKey");
 @source inline("useTheme");
@@ -1013,6 +1063,7 @@
 @source inline("used");
 @source inline("username");
 @source inline("using");
+@source inline("utf-8");
 @source inline("valid");
 @source inline("validateFormats");
 @source inline("validateSchema");
@@ -1042,6 +1093,7 @@
 @source inline("window");
 @source inline("with");
 @source inline("withBase");
+@source inline("withReplacements");
 @source inline("without");
 @source inline("wrap");
 @source inline("wrap-break-word");
@@ -1055,6 +1107,7 @@
 @source inline("x-exclusiveCodeSample");
 @source inline("x-playground-lazy");
 @source inline("x-selectedCodeSample");
+@source inline("xml");
 @source inline("yellow");
 @source inline("you");
 @source inline("your");

package/dist/generate-file.js

@@ -1,3 +1,4 @@
+import { doubleQuote } from "./requests/string-utils.js";
 import { generateDocument, toText } from "./utils/pages/to-text.js";
 import { createAutoPreset } from "./utils/pages/preset-auto.js";
 import { fromSchema } from "./utils/pages/builder.js";
@@ -115,8 +116,8 @@ function writeIndexFiles(context, options) {
 		}
 		for (const entry of outputEntries) {
 			if (entry.type === "group") continue;
-			const descriptionAttr = entry.info.description ? `description=${JSON.stringify(entry.info.description)} ` : "";
-			content.push(`<Card href="${urlFn(entry.path)}" title=${JSON.stringify(entry.info.title)} ${descriptionAttr}/>`);
+			const descriptionAttr = entry.info.description ? `description=${doubleQuote(entry.info.description)} ` : "";
+			content.push(`<Card href="${urlFn(entry.path)}" title=${doubleQuote(entry.info.title)} ${descriptionAttr}/>`);
 		}
 		content.push("</Cards>");
 		return generateDocument({

package/dist/i18n.d.ts

@@ -57,7 +57,8 @@ declare const defaultTranslations: {
   statusInternalServerError: string;
   statusSuccessful: string;
   statusError: string;
-  statusNoDescription: string;
+  statusClientError: string;
+  statusBinaryBody: string;
   obtainAccessToken: string;
   resourceOwnerPassword: string;
   resourceOwnerPasswordDesc: string;
@@ -76,6 +77,7 @@ declare const defaultTranslations: {
   usernameField: string;
   passwordField: string;
   fetchingToken: string;
+  fetchTokenError: string;
   serverUrl: string;
   serverUrlDescription: string;
   serverUrlFieldPlaceholder: string;

package/dist/i18n.js

@@ -56,7 +56,8 @@ const defaultTranslations = {
 	statusInternalServerError: "Internal Server Error",
 	statusSuccessful: "Successful",
 	statusError: "Error",
-	statusNoDescription: "No Description",
+	statusClientError: "Client Error",
+	statusBinaryBody: "Binary response body, {length} bytes",
 	obtainAccessToken: "Obtain the access token for API.",
 	resourceOwnerPassword: "Resource Owner Password Flow",
 	resourceOwnerPasswordDesc: "Authenticate using username and password.",
@@ -75,6 +76,7 @@ const defaultTranslations = {
 	usernameField: "Username",
 	passwordField: "Password",
 	fetchingToken: "Fetching token...",
+	fetchTokenError: "Failed to fetch token",
 	serverUrl: "Server URL",
 	serverUrlDescription: "The base URL of your API endpoint.",
 	serverUrlFieldPlaceholder: "Enter Value",

package/dist/playground/auth.js

@@ -0,0 +1,92 @@
+"use client";
+import { useApiContext } from "../ui/contexts/api.js";
+import { useQuery } from "../utils/use-query.js";
+import { createContext, use, useEffect, useMemo, useState } from "react";
+import { jsx } from "react/jsx-runtime";
+//#region src/playground/auth.tsx
+const AuthContext = createContext(null);
+function useAuth() {
+	const ctx = use(AuthContext);
+	if (!ctx) throw new Error("must use this component under <AuthProvider />");
+	return ctx;
+}
+function AuthProvider({ children }) {
+	const { schemes } = useApiContext();
+	const [store, setStore] = useState({});
+	const authCodeQuery = useQuery(async (code, state) => {
+		const scheme = schemes[state.scheme];
+		if (!scheme || scheme.type !== "oauth2") return;
+		const value = scheme.flows?.authorizationCode;
+		if (!value) return;
+		const res = await fetch(value.tokenUrl, {
+			method: "POST",
+			headers: { "Content-Type": "application/x-www-form-urlencoded" },
+			body: new URLSearchParams({
+				grant_type: "authorization_code",
+				code,
+				redirect_uri: state.redirect_uri,
+				client_id: state.client_id,
+				client_secret: state.client_secret
+			})
+		});
+		if (!res.ok) throw new Error(await res.text());
+		const { access_token, token_type = "Bearer" } = await res.json();
+		const info = {
+			type: "authorization_code",
+			...state,
+			token: `${token_type} ${access_token}`
+		};
+		setStore((s) => ({
+			...s,
+			[state.scheme]: info
+		}));
+	});
+	useEffect(() => {
+		function onQuery() {
+			const query = new URLSearchParams(window.location.search);
+			const state = query.get("state");
+			const code = query.get("code");
+			if (!state || !code) return;
+			const parsedState = JSON.parse(state);
+			authCodeQuery.start(code, parsedState);
+			window.history.replaceState(null, "", window.location.pathname);
+		}
+		function onHash() {
+			const hash = new URLSearchParams(window.location.hash.slice(1));
+			const state = hash.get("state");
+			const token = hash.get("access_token");
+			const type = hash.get("token_type") ?? "Bearer";
+			if (!state || !token) return;
+			const parsedState = JSON.parse(state);
+			const scheme = schemes[parsedState.scheme];
+			if (!scheme || scheme.type !== "oauth2" || !scheme.flows?.implicit) return;
+			const info = {
+				type: "implicit",
+				client_id: parsedState.client_id,
+				token: `${type} ${token}`
+			};
+			setStore((s) => ({
+				...s,
+				[parsedState.scheme]: info
+			}));
+			window.history.replaceState(null, "", window.location.pathname);
+		}
+		if (window.location.search.length > 0) onQuery();
+		if (window.location.hash.length > 1) onHash();
+	}, []);
+	return /* @__PURE__ */ jsx(AuthContext, {
+		value: useMemo(() => ({
+			store,
+			updatedSchemeId: Object.keys(store)[0] ?? null,
+			isLoading: authCodeQuery.isLoading,
+			error: authCodeQuery.error
+		}), [
+			store,
+			authCodeQuery.isLoading,
+			authCodeQuery.error
+		]),
+		children
+	});
+}
+//#endregion
+export { AuthProvider, useAuth };

package/dist/playground/client.d.ts

@@ -1,4 +1,5 @@
-import { BrowserFetcherOptions, FetchResult } from "./fetcher.js";
+import { BrowserFetcherOptions } from "./fetcher.js";
+import { DefaultResultDisplay, ResultDisplayProps } from "./components/result-display.js";
 import { SchemaScope } from "./schema.js";
 import { Document, HttpMethods, ParameterObject } from "../types.js";
 import { ParsedSchema, SecurityEntry } from "../utils/schema/index.js";
@@ -23,10 +24,6 @@ interface PlaygroundClientProps extends ComponentProps<'form'>, SchemaScope {
   doc: Document;
   proxyUrl?: string;
 }
-interface ResultDisplayProps extends ComponentProps<'div'> {
-  data: FetchResult;
-  reset: () => void;
-}
 interface CollapsiblePanelProps extends Omit<ComponentProps<typeof Collapsible>, 'title'> {
   'data-type': 'authorization' | 'body' | ParamType;
   title: ReactNode;
@@ -80,16 +77,12 @@ declare const ParamTypes: readonly ["path", "header", "cookie", "query"];
 type ParamType = (typeof ParamTypes)[number];
 interface AuthField {
   fieldName: FieldKey;
+  schemeId: string;
+  storageKey: string;
   defaultValue: unknown;
-  original?: SecurityEntry;
   children: ReactNode;
   mapOutput?: (values: unknown) => unknown;
 }
-declare function DefaultResultDisplay({
-  data,
-  reset,
-  ...rest
-}: ResultDisplayProps): _$react_jsx_runtime0.JSX.Element;
 declare function DefaultCollapsiblePanel({
   title,
   children,
@@ -104,4 +97,4 @@ declare const Custom: {
   };
 };
 //#endregion
-export { AuthField, CollapsiblePanelProps, Custom, DefaultCollapsiblePanel, DefaultResultDisplay, FormValues, PlaygroundClientOptions, PlaygroundClientProps, ResultDisplayProps, PlaygroundClient as default };
+export { AuthField, CollapsiblePanelProps, Custom, DefaultCollapsiblePanel, DefaultResultDisplay, FormValues, PlaygroundClientOptions, PlaygroundClientProps, type ResultDisplayProps, PlaygroundClient as default };