fumadocs-openapi 12.0.0 → 12.0.1

package/dist/packages/shared-api/dist/components/playground/inputs.js

@@ -9,8 +9,8 @@ import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
 import { useArray, useDataEngine, useFieldValue, useObject } from "@fumari/stf";
 import { stringifyFieldKey } from "@fumari/stf/lib/utils";
 import { useTranslations } from "@fuma-translate/react";
-import { ChevronRight, Plus, Trash2, X } from "lucide-react";
 import { cva } from "class-variance-authority";
+import { ChevronRight, Plus, Trash2, X } from "lucide-react";
 import { buttonVariants } from "fumadocs-ui/components/ui/button";
 //#region ../shared-api/dist/components/playground/inputs.js
 const fieldLabelVariants = cva("w-full inline-flex items-center gap-0.5");

package/dist/packages/shared-api/dist/components/schema/client.js

@@ -6,8 +6,8 @@ import { mergeRefs } from "../../utils/merge-refs.js";
 import { Fragment, Suspense, createContext, use, useCallback, useDeferredValue, useEffect, useMemo, useRef, useState } from "react";
 import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
 import { useTranslations } from "@fuma-translate/react";
-import { CheckIcon, FilterIcon, LinkIcon } from "lucide-react";
 import { cva } from "class-variance-authority";
+import { CheckIcon, FilterIcon, LinkIcon } from "lucide-react";
 import { buttonVariants } from "fumadocs-ui/components/ui/button";
 import { useCopyButton } from "fumadocs-ui/utils/use-copy-button";
 //#region ../shared-api/dist/components/schema/client.js

package/dist/playground/auth.d.ts

@@ -1,7 +1,26 @@
-import { SecuritySchemeObject } from "../types.js";
+import { OAuth2SecurityScheme, OperationObject, SecuritySchemeObject } from "../types.js";
 import { ReactNode } from "react";
-import { FieldKey } from "@fumari/stf";
+import { DataEngine, FieldKey } from "@fumari/stf";
 //#region src/playground/auth.d.ts
+export type OAuthFlowType = keyof NonNullable<OAuth2SecurityScheme['flows']>;
+export interface OAuthFlowInput {
+  /** name of the security scheme */
+  schemeId: string;
+  scopes: string[];
+  clientId: string;
+  clientSecret: string;
+  username: string;
+  password: string;
+  /** where the password flow sends the client credentials */
+  clientAuth: 'body' | 'header';
+}
+/**
+ * Run an OAuth flow and resolve its token.
+ *
+ * `implicit` and `authorizationCode` leave the page instead: the token is picked up on return,
+ * in `usePlaygroundAuth().store`.
+ */
+export declare function requestOAuthToken(scheme: OAuth2SecurityScheme, type: OAuthFlowType, { schemeId, scopes, clientId, clientSecret, username, password, clientAuth }: OAuthFlowInput): Promise<string | undefined>;
 /** scheme name -> token info */
 type TokenStore = Record<string, TokenInfo | undefined>;
 type TokenInfo = {
@@ -22,6 +41,12 @@ interface AuthContextType {
   error?: unknown;
 }
 export declare function usePlaygroundAuth(): AuthContextType;
+export interface AuthRequirement {
+  /** id of the security scheme */
+  id: string;
+  scopes: string[];
+  scheme: SecuritySchemeObject;
+}
 export interface AuthField {
   schemeId: string;
   scheme: SecuritySchemeObject;
@@ -34,4 +59,27 @@ export interface AuthField {
   /** encode the value into request data, like the header of Basic auth */
   mapOutput?: (value: unknown) => unknown;
 }
+export interface AuthFields {
+  /** the security requirements of the operation, one of them authorizes the request */
+  requirements: AuthRequirement[][];
+  /** index of the selected requirement, `-1` when the operation needs no authorization */
+  selected: number;
+  select: (index: number) => void;
+  /** the fields of the selected requirement */
+  fields: AuthField[];
+  /** encode the auth fields of form values into request data */
+  mapValues: <T>(values: T) => T;
+  /** write the persisted values into the form, returns a cleanup removing them */
+  init: () => () => void;
+}
+export interface AuthFieldsOptions {
+  /** the operation to authorize, defaults to the security of the document */
+  operation?: OperationObject;
+  /** customise the generated fields, like their default values */
+  transform?: (fields: AuthField[]) => AuthField[];
+}
+/**
+ * The auth fields of an API playground: the values it persists, and the request data they encode into.
+ */
+export declare function useAuthFields(engine: DataEngine, { operation, transform }?: AuthFieldsOptions): AuthFields;
 //#endregion

package/dist/playground/index.d.ts

@@ -1,3 +1,3 @@
 import { BrowserFetcherOptions, FetchErrorResult, FetchResponseResult, FetchResult, Fetcher, createBrowserFetcher } from "./fetcher.js";
-import { usePlaygroundAuth } from "./auth.js";
-export { type BrowserFetcherOptions, type FetchErrorResult, type FetchResponseResult, type FetchResult, type Fetcher, createBrowserFetcher, usePlaygroundAuth };
+import { AuthField, AuthRequirement, OAuthFlowType, requestOAuthToken, useAuthFields, usePlaygroundAuth } from "./auth.js";
+export { type AuthField, type AuthRequirement, type BrowserFetcherOptions, type FetchErrorResult, type FetchResponseResult, type FetchResult, type Fetcher, type OAuthFlowType, createBrowserFetcher, requestOAuthToken, useAuthFields, usePlaygroundAuth };

package/dist/playground/index.js

@@ -1,3 +1,3 @@
-import { usePlaygroundAuth } from "./auth.js";
+import { requestOAuthToken, useAuthFields, usePlaygroundAuth } from "./auth.js";
 import { createBrowserFetcher } from "./fetcher.js";
-export { createBrowserFetcher, usePlaygroundAuth };
+export { createBrowserFetcher, requestOAuthToken, useAuthFields, usePlaygroundAuth };

package/dist/server/index.js

@@ -1,9 +1,9 @@
 import { fromSchema, getPageProps } from "../utils/pages/builder.js";
 import { toStaticData } from "../utils/pages/to-static-data.js";
 import { createAutoPreset } from "../utils/pages/preset-auto.js";
-import { MethodLabel } from "../ui/components/method-label.js";
 import { createProxy } from "./proxy.js";
 import { loadDocument } from "../utils/document/load.js";
+import { MethodLabel } from "../ui/components/method-label.js";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import path from "node:path";
 import { PathUtils } from "fumadocs-core/source";

package/dist/ui/operation/index.js

@@ -1,12 +1,12 @@
 "use client";
 import { useOpenAPI, useRenderContext, useTypeScriptDefinitions } from "../../utils/create-page.js";
 import { OperationProvider, useOperation } from "../../operation.js";
+import { Badge } from "../../packages/shared-api/dist/components/badge.js";
+import { MethodLabel } from "../components/method-label.js";
 import { AnchorSection } from "../../packages/shared-api/dist/auto-anchor/client.js";
 import { AccordionContent, AccordionHeader, AccordionItem, AccordionTrigger, Accordions } from "../../packages/shared-api/dist/components/accordion.js";
 import { Markdown } from "../components/markdown.js";
 import { UsageTabs } from "./usage-tabs.js";
-import { Badge } from "../../packages/shared-api/dist/components/badge.js";
-import { MethodLabel } from "../components/method-label.js";
 import { SchemaUI } from "../components/schema.js";
 import { RequestTabs } from "./request-tabs.js";
 import { cn } from "../../utils/cn.js";

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

@@ -1,10 +1,10 @@
 "use client";
 import { useRenderContext } from "../../utils/create-page.js";
 import { useExampleRequests, useOperation } from "../../operation.js";
+import { MethodLabel } from "../components/method-label.js";
 import { AccordionContent, AccordionHeader, AccordionItem, AccordionTrigger, Accordions } from "../../packages/shared-api/dist/components/accordion.js";
 import { Markdown } from "../components/markdown.js";
 import { ClientCodeBlock } from "../components/codeblock.js";
-import { MethodLabel } from "../components/method-label.js";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import { useTranslations } from "@fuma-translate/react";
 import { Tabs, TabsContent, TabsList, TabsTrigger } from "fumadocs-ui/components/tabs";

package/dist/ui/playground/client.js

@@ -6,8 +6,8 @@ import { useServer } from "../../utils/use-server.js";
 import { useOpenAPI } from "../../utils/create-page.js";
 import { encodeRequestData } from "../../requests/media/encode.js";
 import { useExampleRequests, useOperation } from "../../operation.js";
-import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "../../packages/shared-api/dist/components/select.js";
 import { MethodLabel } from "../components/method-label.js";
+import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "../../packages/shared-api/dist/components/select.js";
 import { cn } from "../../utils/cn.js";
 import { Collapsible, CollapsibleContent, CollapsibleTrigger } from "../../packages/shared-api/dist/components/collapsible.js";
 import { DefaultResultDisplay } from "./components/result-display.js";
@@ -76,7 +76,7 @@ function PlaygroundClient({ writeOnly, readOnly, transformAuthInputs, fetchOptio
 		transform: transformAuthInputs
 	});
 	const testQuery = useQuery(async (input) => {
-		const fetcher = await import("../../playground/fetcher.js").then((mod) => mod.createBrowserFetcher(mediaAdapters, {
+		const fetcher = await import("../../playground/index.js").then((mod) => mod.createBrowserFetcher(mediaAdapters, {
 			proxyUrl,
 			...fetchOptions
 		}));

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

@@ -7,8 +7,8 @@ import { Collapsible, CollapsibleContent, CollapsibleTrigger } from "../../../pa
 import { Fragment, useEffect, useMemo, useState } from "react";
 import { jsx, jsxs } from "react/jsx-runtime";
 import { useTranslations } from "@fuma-translate/react";
-import { ChevronDown, CircleX, SignpostIcon } from "lucide-react";
 import { cva } from "class-variance-authority";
+import { ChevronDown, CircleX, SignpostIcon } from "lucide-react";
 import { buttonVariants } from "fumadocs-ui/components/ui/button";
 //#region src/ui/playground/components/result-display.tsx
 var import_fast_content_type_parse = require_fast_content_type_parse();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "12.0.0",
+  "version": "12.0.1",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "Docs",
@@ -77,7 +77,7 @@
     "@types/react": "^19.3.0",
     "@types/react-dom": "^19.3.0",
     "fast-content-type-parse": "^4.0.0",
-    "fuma-cli": "^0.1.1",
+    "fuma-cli": "^0.3.1",
     "fumadocs-core": "16.15.12",
     "fumadocs-ui": "npm:@fumadocs/base-ui@16.15.12",
     "json-schema-typed": "^8.0.2",