fumadocs-openapi 10.6.4 → 10.6.6

package/css/generated/shared.css

@@ -65,7 +65,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");
@@ -105,6 +106,7 @@
 @source inline("border-b");
 @source inline("border-current");
 @source inline("border-fd-primary/20");
+@source inline("border-s");
 @source inline("border-t");
 @source inline("border-x");
 @source inline("border-y");
@@ -211,6 +213,7 @@
 @source inline("defaultExampleId");
 @source inline("defaultItem");
 @source inline("defaultMdxComponents");
+@source inline("defaultOpen");
 @source inline("defaultShikiFactory");
 @source inline("defaultValue");
 @source inline("defaultValues");
@@ -218,7 +221,9 @@
 @source inline("definitions");
 @source inline("deprecated");
 @source inline("depth");
+@source inline("dereference");
 @source inline("dereferenceDocument");
+@source inline("dereferenceSwallow");
 @source inline("dereferenced");
 @source inline("description");
 @source inline("descriptionNode");
@@ -263,7 +268,6 @@
 @source inline("error");
 @source inline("eslint-disable");
 @source inline("eslint-disable-next-line");
-@source inline("eslint-plugin-react-hooks/rules-of-hooks");
 @source inline("example");
 @source inline("exampleId");
 @source inline("exampleRequests");
@@ -279,7 +283,6 @@
 @source inline("fetch");
 @source inline("fetchOptions");
 @source inline("fetcher");
-@source inline("fetchingToken");
 @source inline("field");
 @source inline("fieldData");
 @source inline("fieldLabelVariants");
@@ -302,6 +305,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");
@@ -381,7 +385,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");
@@ -417,7 +423,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");
@@ -481,7 +487,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]");
@@ -489,6 +494,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");
@@ -573,6 +579,7 @@
 @source inline("openapi");
 @source inline("openapi-sampler");
 @source inline("openapi-types");
+@source inline("openid");
 @source inline("operation");
 @source inline("operationId");
 @source inline("operations");
@@ -581,7 +588,6 @@
 @source inline("orange");
 @source inline("order-last");
 @source inline("origin");
-@source inline("original");
 @source inline("other");
 @source inline("out");
 @source inline("outline");
@@ -590,7 +596,6 @@
 @source inline("overflow-hidden");
 @source inline("overrides");
 @source inline("overview");
-@source inline("oxlint-disable-next-line");
 @source inline("p-1");
 @source inline("p-1.5");
 @source inline("p-2");
@@ -598,6 +603,7 @@
 @source inline("p-4");
 @source inline("packages");
 @source inline("page");
+@source inline("page-level");
 @source inline("pageData");
 @source inline("pages");
 @source inline("param");
@@ -629,6 +635,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 +664,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 +744,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 +767,7 @@
 @source inline("result");
 @source inline("return");
 @source inline("returned");
+@source inline("role");
 @source inline("root");
 @source inline("rotate-90");
 @source inline("rounded-lg");
@@ -773,6 +785,7 @@
 @source inline("schemaExample");
 @source inline("schemaFormat");
 @source inline("schemaHideArray");
+@source inline("schemaId");
 @source inline("schemaItems");
 @source inline("schemaLength");
 @source inline("schemaMatch");
@@ -785,6 +798,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");
@@ -824,11 +839,13 @@
 @source inline("setNextName");
 @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,6 +883,7 @@
 @source inline("sm:justify-end");
 @source inline("sm:text-start");
 @source inline("so");
+@source inline("source");
 @source inline("spec");
 @source inline("specify");
 @source inline("state");
@@ -881,6 +899,7 @@
 @source inline("statuses");
 @source inline("step");
 @source inline("stf");
+@source inline("stfSync");
 @source inline("sticky");
 @source inline("storageKey");
 @source inline("storageKeyPrefix");
@@ -897,6 +916,7 @@
 @source inline("summary");
 @source inline("support");
 @source inline("supported");
+@source inline("svg");
 @source inline("switch");
 @source inline("t");
 @source inline("tab");
@@ -950,6 +970,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 +979,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 +1001,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 +1017,7 @@
 @source inline("use");
 @source inline("useApiClientModal");
 @source inline("useApiContext");
+@source inline("useAuth");
 @source inline("useCopyButton");
 @source inline("useFieldValue");
 @source inline("useForm");
@@ -999,6 +1025,7 @@
 @source inline("useMemo");
 @source inline("useNamespace");
 @source inline("useObject");
+@source inline("useOnChange");
 @source inline("useOperationContext");
 @source inline("useQuery");
 @source inline("useRef");

package/dist/_openapi/types.d.ts

@@ -877,5 +877,4 @@ type IJsonSchema = {
   $ref?: string;
 };
 //#endregion
-export { OpenAPIV3, OpenAPIV3_2 };
-//# sourceMappingURL=types.d.ts.map
+export { OpenAPIV3, OpenAPIV3_2 };

package/dist/generate-file.d.ts

@@ -78,5 +78,4 @@ interface BeforeWriteContext {
 declare function generateFiles(options: Config): Promise<void>;
 declare function generateFilesOnly(options: DistributiveOmit<Config, 'output'>): Promise<OutputFile[]>;
 //#endregion
-export { Config, OutputFile, generateFiles, generateFilesOnly };
-//# sourceMappingURL=generate-file.d.ts.map
+export { Config, OutputFile, generateFiles, generateFilesOnly };

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({
@@ -133,5 +134,3 @@ function writeIndexFiles(context, options) {
 }
 //#endregion
 export { generateFiles, generateFilesOnly };
-
-//# sourceMappingURL=generate-file.js.map

package/dist/i18n.d.ts

@@ -76,6 +76,7 @@ declare const defaultTranslations: {
   usernameField: string;
   passwordField: string;
   fetchingToken: string;
+  fetchTokenError: string;
   serverUrl: string;
   serverUrlDescription: string;
   serverUrlFieldPlaceholder: string;
@@ -96,5 +97,4 @@ declare const defaultTranslations: {
 type Translations = typeof defaultTranslations;
 declare function defineI18nOpenAPI<Languages extends string>(config: I18nUIConfig<Languages>, translations: Partial<Record<NoInfer<Languages>, Partial<Translations>>>): I18nUIConfig<Languages>;
 //#endregion
-export { Translations, defaultTranslations, defineI18nOpenAPI };
-//# sourceMappingURL=i18n.d.ts.map
+export { Translations, defaultTranslations, defineI18nOpenAPI };

package/dist/i18n.js

@@ -75,6 +75,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",
@@ -109,5 +110,3 @@ function defineI18nOpenAPI(config, translations) {
 }
 //#endregion
 export { defaultTranslations, defineI18nOpenAPI };
-
-//# sourceMappingURL=i18n.js.map

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,6 +1,5 @@
 import { BrowserFetcherOptions, FetchResult } from "./fetcher.js";
 import { SchemaScope } from "./schema.js";
-import { ProcessedDocument } from "../utils/document/process.js";
 import { Document, HttpMethods, ParameterObject } from "../types.js";
 import { ParsedSchema, SecurityEntry } from "../utils/schema/index.js";
 import { ComponentProps, FC, ReactNode } from "react";
@@ -20,12 +19,8 @@ interface PlaygroundClientProps extends ComponentProps<'form'>, SchemaScope {
   route: string;
   method: HttpMethods;
   securities: SecurityEntry[][];
-  /** the OpenAPI document */
-  doc: {
-    bundled: Document;
-  } | {
-    processed: ProcessedDocument;
-  };
+  /** the OpenAPI document (not dereferenced) */
+  doc: Document;
   proxyUrl?: string;
 }
 interface ResultDisplayProps extends ComponentProps<'div'> {
@@ -85,8 +80,9 @@ 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;
 }
@@ -109,5 +105,4 @@ declare const Custom: {
   };
 };
 //#endregion
-export { AuthField, CollapsiblePanelProps, Custom, DefaultCollapsiblePanel, DefaultResultDisplay, FormValues, PlaygroundClientOptions, PlaygroundClientProps, ResultDisplayProps, PlaygroundClient as default };
-//# sourceMappingURL=client.d.ts.map
+export { AuthField, CollapsiblePanelProps, Custom, DefaultCollapsiblePanel, DefaultResultDisplay, FormValues, PlaygroundClientOptions, PlaygroundClientProps, ResultDisplayProps, PlaygroundClient as default };