fumadocs-openapi 11.4.2 → 12.0.0

package/css/generated/shared.css

@@ -1 +1 @@
-@source inline("--- --fd-docs-row-1 -mode -ms-2 @4xl:flex-row @4xl:items-start @4xl:sticky @4xl:top-[calc(var(--fd-docs-row-1,2rem)+1rem)] @4xl:w-[400px] @container @default @defaultValue @deprecated @fuma-translate/react @fumari/json-schema-ts @fumari/stf @param @private @scalar/api-client-react @see @typescript-eslint/no-explicit-any a access access_token active adapter adapters addListener against all allFlows allow already alt an anchorSegments and animate-spin apiExample apiKey apiPlayground application/javascript application/json application/x-javascript application/x-www-form-urlencoded application/xml apply are array as assume async at auth-specific authCodeQuery authCtx authNode authSchemes authorization authorizationCode authorization_code authorize autoComplete avoid await backward badgeVariants base baseDir basic be because before between bg-fd-card bg-fd-muted bg-fd-primary/10 bg-fd-secondary binary blob blue body bodyMediaType bodyNode boolean border border-b border-current border-s border-t border-y break-all buffer built-in bundled but button buttonVariants by byteLength bytes cache cached cachedDocFiles call callback callbacks callbacksNode can cannot case catch changes charset check children class-variance-authority className client clientAuth clientAuthMethods clientCredentials clientId clientSecret client_auth client_credentials client_error client_id client_secret cloned cn code codeProps codeUsages codeblock codegen codegens collapsible color com compatibility compiler component components conditions configuration const content contentType contentTypes context cookie cookies core could createClientAPIPage createCodeUsageGeneratorRegistry createContext createOpenAPIPageBase createProxy credentials css csv ctx current currentValue custom customization cva dark dark:text-blue-400 dark:text-green-400 dark:text-orange-400 dark:text-red-400 dark:text-yellow-400 data data-[open]:border-b-0 data-type default defaultAdapters defaultExampleId defaultItem defaultMdxComponents defaultOpen defaultShikiFactory defaultValue defaultValues default_processMarkdown definitions deprecated depth dereferenceBundledDocument dereferenceShallow dereferenced description descriptionNode development deviceAuthorization dialog didn disable disableCache disabled display displayNames div do doc docCache docFilesCache docRoot docs document documents domain downloaded dynamicSource e each else empty:hidden enabled encodeRequestData encoded endpoint enforce engine ensure entire entries entry error eslint-disable eslint-disable-next-line example exampleId exampleRequests examples export exported extends fallback false fast-content-type-parse fd-page-tree-item-name fetch fetcher field fieldName fields file filePath files fine first first:border-t-0 flex flex-1 flex-col flex-col-reverse flex-row flex-wrap flow flows folder folderStyle font-medium font-mono font-normal font-semibold for form formData format found from fs full fumadocs-core/source fumadocs-core/toc fumadocs-openapi/ui fumadocs-ui/mdx fumadocs:openapi fumadocs_openapi_requests fumadocs_openapi_responses function gap-0.5 gap-1 gap-1.5 gap-2 gap-2.5 gap-24 gap-3 gap-4 gap-6 gap-x-4 gap-x-6 gap-y-1 gap-y-4 gen generate generateTypeScriptDefinitions generated generated/defined generators get getAPIPageProps getClientAPIPageProps getExampleRequests getOpenAPIPageProps getPreferredType getRaw getSchema getSchemas getWatchPaths github-dark github-light given grant_type green grid grid-cols-[auto_1fr] group group-data-[panel-open]:rotate-180 groupId h1 handling hasHead hash hast-util-to-jsx-runtime headNode header headers headingLevel highlighter hook hover:bg-fd-accent hover:text-fd-accent-foreground href html htmlFor http icon id idToTitle idx if ignore img implicit import imports in in-document info initAuthInputs initial inline-flex input inputs instanceof instances instead insteawd interface internal into is isLoading isMediaTypeSupported isRequired issues it item items items-center items-start js json json-schema-typed justify-between kept key keyof label labelVariants lang last:border-b-0 last:mb-0 latest layout lazy length let light line-through list list-disc list-inside listed listener listeners load loadDocument loaderPlugin localStorage lucide-react make map max-age may mb-1 mb-2 md mdxComponents me-auto media mediaAdapters mediaType merged message meta metaData method methodKeys mime min-w-0 modify mounted ms-auto mt-0! mt-10 mt-2 mt-3 multipart/form-data multiple must my-0! my-1.5 my-4 name name! named necessary need never new newKey no-cache node:fs node:path not not-last:pb-0 not-prose note null number oauth2 obj object of off omit on onChange onClick onCopy onOpenChange onSubmit onValueChange one only open openApiData openIdConnect openapi openapiMeta openid operation operationDescription operationId operations options or orange origin other out outline output overflow-auto overflow-hidden p p-1 p-2 p-3 packages page page-level pageData pages panelVariants param paramTypeKeys parameter parameterLabel parameterNode parameters params parent parsed parsedState parts party pass password path pathItem pathnameFromRequest payload pb-2 pe-3 persist persisted persistent place placeholder playground playgrounds please plugins pre prefix preloadOpenAPIPage preloaded prevent primary processed processor prop properties props prose-no-margin provider proxy proxyForwardCookie proxyUrl ps-2 ps-4.5 pt-1 pt-2 pt-2.5 px-1 px-2 px-3 py-0.5 py-1 py-1.5 py-2 query race raw react react-hooks/exhaustive-deps react/jsx-runtime readOnly readonly record red redirect_uri reference refs registerDefault registry rehype-react relativePath remark remark-rehype remarkGfm remarkRehype removeListener render renderAPIExampleLayout renderAPIExampleUsageTabs renderOperationLayout renderPageLayout renderParameterField renderRequestTabs renderRequestTabsDefault renderResponseTabs renderResponseTabsDefault renderWebhookLayout renderer replace request request-body requestData requestInit requestTimeout requestUrl requests required requirement requirementId requirements res reset resolvable resolve resolveMediaAdapter resolveServerUrl resolvedInput resolvedTheme resolves response response-body responseNode responseOfType responseTabs response_type responses rest result return returned returning root rounded-2xl rounded-lg rounded-md rounded-xl route s safeParse same sample satisfies scalar scan schema schemaId schemaUI schemaUIShared scheme schemeId schemes scope scopes search secondary seconds secret securities security securityEntries securityId securitySchemes segments segs select selector separator server server-to-server server-url serverSchema servers services set setClientAuth setData setExample setExampleData setIsJson setIsMounted setMounted setObjectUrl setOpen setRequirementId setSecurityId setServer setServerVariables setStore setToken setType setValue shadow-md shadow-sm shiki shikiOptions showDescription showExample showResponseSchema showTitle shrink-0 side signal single size size-3.5 size-4 slot slots sm so source spec specify spread src state staticSource status statusInfo statuses stf stfSync still storageKey storageKeys store stored string stringifyFieldKey structuredData styles submit summary supported sure switch t tab tabs testQuery text text-[0.8125rem] text-blue-600 text-fd-card-foreground text-fd-foreground text-fd-muted-foreground text-fd-primary text-fd-secondary-foreground text-green-500 text-green-600 text-nowrap text-orange-600 text-red-400 text-red-500 text-red-600 text-sm text-start text-xs text-yellow-600 text/css text/csv text/html text/plain the their them themes this throw timeout timerRef tips title to toJsxRuntime toStaticData toc token tokenInfo token_type transform transformAuthInputs transformPageTree transition-colors tree true truncate try ts type typeof types typescript unchanged under unexpected unknown unlisted update updated updatedSchemeId updating url usage usageTabs usages use useAnchorId useApiClient useAuth useCopyButton useMemo useOnChange useOperationContext useQuery useRef useRenderContext useServerContext useState useStatusInfo useStf useStorageKey useTheme useTranslations used username using utf-8 v value values variable variables variant variants via virtual void w-14 w-fit w-full warn we webhook webhookCallbacks webhooks when whitespace-pre-wrap will with without won wrapping writeOnly x-codeSamples x-exclusiveCodeSample x-selectedCodeSample xml yellow you your");
+@source inline("!isDefined *:data-[collapsible=true]:order-last *:min-w-0 --- --accordion-panel-height --anchor-width --available-height --available-width --collapsible-panel-height --fd-docs-row-1 --min-height --spacing --transform-origin -mode -ms-2 -mx-3 -translate-x-1/2 -translate-y-1/2 @4xl:flex-row @4xl:items-start @4xl:sticky @4xl:top-[calc(var(--fd-docs-row-1,2rem)+1rem)] @4xl:w-[400px] @container @default @fuma-translate/react @fumadocs/json-schema @fumari/stf @md:grid-cols-2 @param @private @returns @scalar/api-client-react @see @typescript-eslint/no-explicit-any [&[hidden]:not([hidden='until-found'])]:hidden [&_svg]:size-3.5 a absolute accept access access_token accordion actual adapter adapters additionalProperties again against alias align allFlows allOf allow already alt always an anchor anchorIdStartsWith anchorSegments and animate-spin anyFields anyOf apiExample apiKey apiPlayground applicable application/javascript application/json application/x-javascript application/x-www-form-urlencoded application/xml apply are aria-label arkdown array as asSchema async at auth auth-specific authCodeQuery authNode authSchemes authorization authorizationCode authorization_code authorize authorizes autoComplete avoid await back backdrop-blur-lg backdrop-blur-sm badgeVariants base baseDir basic be because before behavior belong bg-black/30 bg-fd-background/50 bg-fd-card bg-fd-muted bg-fd-popover bg-fd-popover/60 bg-fd-primary bg-fd-primary/10 bg-fd-secondary binary blob block blocks blue body bodyMediaType bodyNode boolean border border-b border-current border-fd-primary/20 border-s border-t border-y bottom break-all buffer built-in bundled but button buttonVariants by byteLength bytes cache cached cachedDocFiles callbacks callbacksNode can cannot case catch center change charset check children class-variance-authority className cleanup client clientAuth clientAuthMethods clientCredentials clientHeight clientId clientSecret client_auth client_credentials client_error client_id client_secret cloned closed cn code codeProps codeUsages codeblock col-span-full collapsible color compiler components configuration const content contentType contentTypes cookie cookies copying core could createContext createOpenAPIPageBase createProxy credentials css csv ctx current currentValue custom customise customization cva dark dark:text-blue-400 dark:text-green-400 dark:text-orange-400 dark:text-red-400 dark:text-yellow-400 data data-[closed]:animate-fd-popover-out data-[disabled]:opacity-50 data-[disabled]:pointer-events-none data-[highlighted]:bg-fd-accent data-[highlighted]:text-fd-accent-foreground data-[open]:animate-fd-popover-in data-[open]:border-b-0 data-[popup-open]:text-fd-accent-foreground data-closed:animate-fd-dialog-out data-closed:animate-fd-fade-out data-collapsible data-ending-style:h-0 data-ending-style:opacity-0 data-object-search-input data-open:animate-fd-dialog-in data-open:animate-fd-fade-in data-placeholder:text-fd-muted-foreground data-starting-style:h-0 data-starting-style:opacity-0 data-type dataEngine decoded default defaultMdxComponents defaultOpen defaultShikiFactory defaultShikiOptions defaultValue defaultValues defaults deferredValue define definitions delete deprecated depth dereference dereferenced description descriptionNode development deviceAuthorization dialog didn disable disableCache disabled disabled:cursor-not-allowed disabled:opacity-50 display displayNames div do doc docCache docFilesCache docRoot docs document documents domain downloaded drives duplicated duration-200 dynamic dynamicSource e eading ease-out element else empty empty:hidden enabled encode encodeRequestData encoded end end-2 endpoint enforce engine ensure entries entry enum error eslint-disable eslint-disable-next-line example exampleId examples export exported extends fallback false fast-content-type-parse fd-page-tree-item-name fd-scroll-container fetch fetcher field fieldData fieldLabelVariants fieldName fields file filePath files filtered fine first first:border-t-0 firstItemRef fixed flex flex-1 flex-col flex-col-reverse flex-row flex-wrap flow flows focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-fd-ring focus-within:[&_svg]:text-fd-primary focus-within:ring-2 focus-within:ring-fd-ring focus:outline-none focus:ring focus:ring-fd-ring folder folderStyle font-medium font-mono font-normal font-semibold for form formData format from fs full fumadocs-core/source fumadocs-core/toc fumadocs-ui/mdx fumadocs:openapi fumadocs_openapi_requests fumadocs_openapi_responses function gap-0.5 gap-1 gap-1.5 gap-2 gap-2.5 gap-24 gap-3 gap-4 gap-6 gap-x-4 gap-x-6 gap-y-1 gap-y-4 generate generateDefault generateSchemaUI generated get getOpenAPIPageProps getSchema getSchemas getWatchPaths ghost github-dark github-light given go grant_type gray green grid grid-cols-1 grid-cols-[auto_1fr] group group-data-[panel-open]/accordion:rotate-90 group-data-[panel-open]:rotate-180 group/accordion groupId h-(--accordion-panel-height) h-(--collapsible-panel-height) h-10 h-9 h-[240px] h-px h1 hash hast-util-to-jsx-runtime headNode header headers heading headingLevel headless hidden hiddenProperties highlighted highlighter holding hook hover:bg-fd-accent hover:text-fd-accent-foreground hover:underline how html htmlFor http i icon icon-sm icon-xs id idx if ignore img implicit import imports in in-popover index indexItemMatch info infoTags init initial inline-flex input inputs inset-0 inside installed instanceof instead integer interface internal into invalid is isDefined isDuplicated isDynamic isLazy isLoading isNumber isRequired issues it item items items-center items-start its j js json json-schema-typed justify-between justify-center key keyed keyof kind label labelClassName lang last last:border-b-0 last:mb-0 lazy leading-none leave left-1/2 length let light like line-through link links list list-disc list-inside listed load loadDocument loaderPlugin localStorage location lucide-react map mapValues marker:text-fd-muted-foreground matching max-age max-h-(--available-height) max-h-[460px] max-w-(--available-width) max-w-[98vw] max-w-full max-w-lg may mb-1 mb-2 mb-auto md mdxComponents me-auto media mediaType member merge mergeRefs message meta metaData method mime min-h-(--min-height,200px) min-w-0 min-w-[240px] min-w-[calc(var(--anchor-width)+--spacing(2))] modify mounted ms-auto mt-0! mt-10 mt-2 mt-3 multipart/form-data multiple must mx-1 my-0! my-1 my-1.5 my-2 my-2! my-4 name name! named namespace navigating navigation need needs nested never new no no-cache node node:fs node:path not not-last:pb-0 not-prose note null number oauth2 object objectSearchOverrides objectSet objects of off omit on onChange onClick onCopy onKeyDown onOpenChange onScrollEnd onSubmit onValueChange one oneOf ones only opacity-80 open openApiData openIdConnect openapi openapiMeta opened opens operation options or orange order-last origin origin-(--transform-origin) other out outline outline-none output over overflow-auto overflow-hidden overflow-x-auto overflow-y-auto overflow-y-hidden p-1 p-1.5 p-2 p-3 p-4 packages page pageData pages panelVariants param parameter parameterLabel parameterNode parameters params parent parentPathIndex parents parsed parsedState part parts party pass password path pathIndex pathItem pathName pathnameFromRequest pattern patternProperties payload pb-0 pb-2 pe-2 pe-3 peer-disabled:cursor-not-allowed peer-disabled:opacity-70 persist persisted picked place placeholder placeholder:text-fd-muted-foreground playground playgrounds please plugins popover popoverRef positions pre preloadOpenAPIPage preloaded preventScroll previous primitive processor properties property props prose prose-no-margin prose-sm proxy proxyForwardCookie proxyUrl ps-1 ps-2 ps-3 ps-4.5 ps-6 pt-0 pt-1 pt-2 pt-2.5 px px-1 px-2 px-3 px-4 py-0 py-0.5 py-1 py-1.5 py-2 py-4 query querySelector quiet raw rawSearch re-triggering react react-hooks/exhaustive-deps react/jsx-runtime read readOnly readonly record red redirect_uri ref reference refs regenerated rehype-react relativePath remark remark-rehype remarkGfm remarkRehype remove removeItem removing render renderBodyField renderCodeblock renderMarkdown renderParameterField renderPopoverTrigger renderTrigger rendered renderers renders replace represents request request-body requestBody requestData requestInit requestTimeout requestUrl requests required requirement requirements res reset resize-none resolve resolveMediaAdapter resolveUrl resolved resolvedInput resolvedTheme response response-body responseNode responseTabs response_type responses rest restored result return returning returns role root rootId roots rotate-90 rounded-2xl rounded-lg rounded-md rounded-sm rounded-xl route s-highlight safeParse same satisfies scalar scan schema schemaId schemaPropKeys schemaUI scheme schemeId schemes scope scopes scroll scroll-m-20 scrollTop scrollTops search secondary seconds secret section sections security segments segs select select-none selected selectedType selections selector sends sep separator server server-to-server serverSchema services set setClientAuth setError setInfo setIsJson setIsMounted setMounted setNextName setObjectUrl setOpen setPath setSearch setSelected setServerVariables setShow setStore setToken setType setValue shadow-lg shadow-md shadow-sm shared shiki shikiOptions show showDescription showExample showResponseSchema showSelect showTitle showing shrink-0 side sideOffset signal single size size-3.5 size-4 skipNonRequired skipReadOnly slot slotType slots sm sm:flex-row sm:gap-2 sm:justify-end sm:text-start smooth so source specify src stable start state staticSource status statusInfo step stf stfSync sticky still storageKey store stored string stringify stringifyFieldKey structuredData styles submit such supported svg switch t tab tabDepth tabValues tabs tag target testQuery text text-[0.8125rem] text-blue-600 text-center text-end text-fd-card-foreground text-fd-foreground text-fd-muted-foreground text-fd-muted-foreground/70 text-fd-popover-foreground text-fd-primary text-fd-primary-foreground text-fd-secondary-foreground text-green-500 text-green-600 text-lg text-nowrap text-orange-400 text-orange-600 text-red-400 text-red-400/80 text-red-500 text-red-600 text-sm text-start text-xs text-yellow-600 text/css text/csv text/html text/plain that the their them themes they this through throw timeout timerRef tips title to toJsxRuntime toStaticData toc token tokenInfo tokenUrl token_type toolbar top top-0 top-1/2 top-10 top-2 tracking-tight transform transformPageTree transition-[height,opacity] transition-[height] transition-colors transition-transform translations tree trigger true truncate try ts type typeVariants typeof types unchanged undefined under underline unexpected union unionField unions unknown unlisted unselected up update updateInfo updated updatedSchemeId updating url usageTabs use useAnchorId useApiClient useComponents useCopyButton useFieldValue useListener useMemo useNamespace useObject useOnChange useOpenAPI useOperation usePlaygroundAuth useQuery useRef useRenderContext useResponseExamples useServer useState useStatusInfo useStf useTheme useTranslations useTypeScriptDefinitions used username using utf-8 v value valueSchema values variable variables variant variants via view virtual void w-0 w-14 w-[600px] w-fit w-full warn was we webhook webhooks when where whitespace-pre-wrap will with without won wrap-break-word wrapping write writeOnly x-exclusiveCodeSample x-playground-lazy xml yellow you your z-20 z-50");

package/css/preset.css

@@ -1,2 +1 @@
 @import './generated/shared.css';
-@import '@fumadocs/api-docs/css/preset.css';

package/dist/_virtual/_rolldown/runtime.js

@@ -6,6 +6,15 @@ var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __commonJSMin = (cb, mod) => () => (mod || (cb((mod = { exports: {} }).exports, mod), cb = null), mod.exports);
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
 var __copyProps = (to, from, except, desc) => {
 	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
 		key = keys[i];
@@ -21,4 +30,4 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 	enumerable: true
 }) : target, mod));
 //#endregion
-export { __commonJSMin, __toESM };
+export { __commonJSMin, __exportAll, __toESM };

package/dist/generate-file.d.ts

@@ -1,8 +1,8 @@
+import { DistributiveOmit } from "./types.js";
 import { OutputEntry } from "./utils/pages/builder.js";
 import { SchemaToPagesOptions } from "./utils/pages/preset-auto.js";
-import { OpenAPIServer } from "./server/index.js";
-import { DistributiveOmit } from "./types.js";
 import { PagesToTextOptions } from "./utils/pages/to-text.js";
+import { OpenAPIServer } from "./server/index.js";
 //#region src/generate-file.d.ts
 export interface OutputFile {
   path: string;

package/dist/generate-file.js

@@ -1,5 +1,5 @@
-import { fromSchema } from "./utils/pages/builder.js";
 import { doubleQuote } from "./requests/string-utils.js";
+import { fromSchema } from "./utils/pages/builder.js";
 import { generateDocument, toText } from "./utils/pages/to-text.js";
 import { createAutoPreset } from "./utils/pages/preset-auto.js";
 import { mkdir, writeFile } from "node:fs/promises";

package/dist/i18n.d.ts

@@ -1,10 +1,8 @@
-import { Translations } from "./.translations/index.js";
-import { Translations as Translations$1 } from "@fumadocs/api-docs/i18n";
+import { Translations as Translations$1 } from "./.translations/index.js";
+import { Translations as Translations$2 } from "./packages/shared-api/dist/.translations/index.js";
+import "./packages/shared-api/dist/i18n.js";
 import { TranslationExtension } from "fumadocs-core/i18n";
-import { I18nUIConfig } from "fumadocs-ui/i18n";
 //#region src/i18n.d.ts
-export declare function openapiTranslations(): TranslationExtension<keyof Translations | keyof Translations$1>;
-/** @deprecated use `i18n.translations()` & `openapiTranslations()` instead */
-export declare function defineI18nOpenAPI<Languages extends string>(config: I18nUIConfig<Languages>, translations: Partial<Record<NoInfer<Languages>, Partial<Translations>>>): I18nUIConfig<Languages>;
-//#endregion
-export type { Translations };
+export type Translations = Translations$1 & Translations$2;
+export declare function openapiTranslations(): TranslationExtension<keyof Translations>;
+//#endregion

package/dist/i18n.js

@@ -1,23 +1,8 @@
 import keys_default from "./.translations/keys.js";
-import { apiDocsTranslations } from "@fumadocs/api-docs/i18n";
+import { apiDocsTranslations } from "./packages/shared-api/dist/i18n.js";
 //#region src/i18n.ts
 function openapiTranslations() {
 	return { keys: [...apiDocsTranslations().keys, ...keys_default] };
 }
-/** @deprecated use `i18n.translations()` & `openapiTranslations()` instead */
-function defineI18nOpenAPI(config, translations) {
-	return {
-		...config,
-		provider(locale = config.defaultLanguage) {
-			const out = config.provider(locale);
-			const data = translations[locale];
-			if (data) out.translations = {
-				...out.translations,
-				...data
-			};
-			return out;
-		}
-	};
-}
 //#endregion
-export { defineI18nOpenAPI, openapiTranslations };
+export { openapiTranslations };

package/dist/index.browser.d.ts

@@ -0,0 +1,13 @@
+import { OpenAPI, OpenAPIV2, OpenAPIV3, OpenAPIV3_1, OpenAPIV3_2 } from "./types/openapi.js";
+import { MediaAdapter } from "./requests/media/adapter.js";
+import { Awaitable, CallbackObject, DistributiveOmit, Document, ExampleObject, HttpMethods, MediaTypeObject, OAuth2SecurityScheme, OperationObject, ParameterObject, PathItemObject, ReferenceObject, RequestBodyObject, ResponseObject, SecuritySchemeObject, ServerObject, ServerVariableObject, TagObject } from "./types.js";
+import { GeneratedPageProps, OperationItem, OperationOutput, OutputEntry, OutputGroup, PageOutput, PagesBuilder, PagesBuilderConfig, WebhookItem, WebhookOutput } from "./utils/pages/builder.js";
+import { CodeBlockProps } from "./packages/shared-api/dist/components/defaults.js";
+import { APIPlaygroundProps, CreateOpenAPIRendererOptions, GenerateTypeScriptDefinitionsContext, OpenAPIComponents, OpenAPIRenderOptions, OpenAPIRuntime, OpenAPIRuntimeOptions, OperationPlaygroundOptions, PageLayoutProps, RenderContext, createOpenAPIBaseRenderer, createOpenAPIRenderer, useComponents, useOpenAPI, useRenderContext, useTypeScriptDefinitions } from "./utils/create-page.js";
+import { SelectedServer, useServer } from "./utils/use-server.js";
+import { SchemaToPagesOptions } from "./utils/pages/preset-auto.js";
+//#region src/index.browser.d.ts
+export declare function generateFiles(): Promise<void>;
+export declare function generateFilesOnly(): Promise<never>;
+//#endregion
+export { APIPlaygroundProps, type Awaitable, type CallbackObject, type CodeBlockProps, CreateOpenAPIRendererOptions, type DistributiveOmit, type Document, type ExampleObject, GenerateTypeScriptDefinitionsContext, type GeneratedPageProps, type HttpMethods, type MediaAdapter, type MediaTypeObject, type OAuth2SecurityScheme, type OpenAPI, OpenAPIComponents, OpenAPIRenderOptions, OpenAPIRuntime, OpenAPIRuntimeOptions, type OpenAPIV2, type OpenAPIV3, type OpenAPIV3_1, type OpenAPIV3_2, type OperationItem, type OperationObject, type OperationOutput, OperationPlaygroundOptions, type OutputEntry, type OutputGroup, PageLayoutProps, type PageOutput, type PagesBuilder, type PagesBuilderConfig, type ParameterObject, type PathItemObject, type ReferenceObject, RenderContext, type RequestBodyObject, type ResponseObject, type SchemaToPagesOptions, type SecuritySchemeObject, type SelectedServer, type ServerObject, type ServerVariableObject, type TagObject, type WebhookItem, type WebhookOutput, createOpenAPIBaseRenderer, createOpenAPIRenderer, useComponents, useOpenAPI, useRenderContext, useServer, useTypeScriptDefinitions };

package/dist/index.browser.js

@@ -0,0 +1,11 @@
+import { useServer } from "./utils/use-server.js";
+import { createOpenAPIBaseRenderer, createOpenAPIRenderer, useComponents, useOpenAPI, useRenderContext, useTypeScriptDefinitions } from "./utils/create-page.js";
+//#region src/index.browser.ts
+async function generateFiles() {
+	throw new Error("`generateFiles` is only available on Node.js.");
+}
+async function generateFilesOnly() {
+	throw new Error("`generateFilesOnly` is only available on Node.js.");
+}
+//#endregion
+export { createOpenAPIBaseRenderer, createOpenAPIRenderer, generateFiles, generateFilesOnly, useComponents, useOpenAPI, useRenderContext, useServer, useTypeScriptDefinitions };

package/dist/index.d.ts

@@ -1,7 +1,10 @@
 import { OpenAPI, OpenAPIV2, OpenAPIV3, OpenAPIV3_1, OpenAPIV3_2 } from "./types/openapi.js";
 import { MediaAdapter } from "./requests/media/adapter.js";
+import { Awaitable, CallbackObject, DistributiveOmit, Document, ExampleObject, HttpMethods, MediaTypeObject, OAuth2SecurityScheme, OperationObject, ParameterObject, PathItemObject, ReferenceObject, RequestBodyObject, ResponseObject, SecuritySchemeObject, ServerObject, ServerVariableObject, TagObject } from "./types.js";
 import { GeneratedPageProps, OperationItem, OperationOutput, OutputEntry, OutputGroup, PageOutput, PagesBuilder, PagesBuilderConfig, WebhookItem, WebhookOutput } from "./utils/pages/builder.js";
+import { CodeBlockProps } from "./packages/shared-api/dist/components/defaults.js";
+import { APIPlaygroundProps, CreateOpenAPIRendererOptions, GenerateTypeScriptDefinitionsContext, OpenAPIComponents, OpenAPIRenderOptions, OpenAPIRuntime, OpenAPIRuntimeOptions, OperationPlaygroundOptions, PageLayoutProps, RenderContext, createOpenAPIBaseRenderer, createOpenAPIRenderer, useComponents, useOpenAPI, useRenderContext, useTypeScriptDefinitions } from "./utils/create-page.js";
+import { SelectedServer, useServer } from "./utils/use-server.js";
 import { SchemaToPagesOptions } from "./utils/pages/preset-auto.js";
-import { Awaitable, CallbackObject, DistributiveOmit, Document, ExampleObject, HttpMethods, MediaTypeObject, OAuth2SecurityScheme, OperationObject, ParameterObject, PathItemObject, ReferenceObject, RenderContext, RequestBodyObject, ResponseObject, SecuritySchemeObject, ServerObject, ServerVariableObject, TagObject } from "./types.js";
 import { Config, OutputFile, generateFiles, generateFilesOnly } from "./generate-file.js";
-export { type Awaitable, type CallbackObject, Config, type DistributiveOmit, type Document, type ExampleObject, type GeneratedPageProps, type HttpMethods, type MediaAdapter, type MediaTypeObject, type OAuth2SecurityScheme, type OpenAPI, type OpenAPIV2, type OpenAPIV3, type OpenAPIV3_1, type OpenAPIV3_2, type OperationItem, type OperationObject, type OperationOutput, type OutputEntry, OutputFile, type OutputGroup, type PageOutput, type PagesBuilder, type PagesBuilderConfig, type ParameterObject, type PathItemObject, type ReferenceObject, type RenderContext, type RequestBodyObject, type ResponseObject, type SchemaToPagesOptions, type SecuritySchemeObject, type ServerObject, type ServerVariableObject, type TagObject, type WebhookItem, type WebhookOutput, generateFiles, generateFilesOnly };
+export { APIPlaygroundProps, type Awaitable, type CallbackObject, type CodeBlockProps, Config, CreateOpenAPIRendererOptions, type DistributiveOmit, type Document, type ExampleObject, GenerateTypeScriptDefinitionsContext, type GeneratedPageProps, type HttpMethods, type MediaAdapter, type MediaTypeObject, type OAuth2SecurityScheme, type OpenAPI, OpenAPIComponents, OpenAPIRenderOptions, OpenAPIRuntime, OpenAPIRuntimeOptions, type OpenAPIV2, type OpenAPIV3, type OpenAPIV3_1, type OpenAPIV3_2, type OperationItem, type OperationObject, type OperationOutput, OperationPlaygroundOptions, type OutputEntry, OutputFile, type OutputGroup, PageLayoutProps, type PageOutput, type PagesBuilder, type PagesBuilderConfig, type ParameterObject, type PathItemObject, type ReferenceObject, RenderContext, type RequestBodyObject, type ResponseObject, type SchemaToPagesOptions, type SecuritySchemeObject, type SelectedServer, type ServerObject, type ServerVariableObject, type TagObject, type WebhookItem, type WebhookOutput, createOpenAPIBaseRenderer, createOpenAPIRenderer, generateFiles, generateFilesOnly, useComponents, useOpenAPI, useRenderContext, useServer, useTypeScriptDefinitions };

package/dist/index.js

@@ -1,2 +1,4 @@
+import { useServer } from "./utils/use-server.js";
+import { createOpenAPIBaseRenderer, createOpenAPIRenderer, useComponents, useOpenAPI, useRenderContext, useTypeScriptDefinitions } from "./utils/create-page.js";
 import { generateFiles, generateFilesOnly } from "./generate-file.js";
-export { generateFiles, generateFilesOnly };
+export { createOpenAPIBaseRenderer, createOpenAPIRenderer, generateFiles, generateFilesOnly, useComponents, useOpenAPI, useRenderContext, useServer, useTypeScriptDefinitions };

package/dist/operation.d.ts

@@ -0,0 +1,133 @@
+import { RawRequestData, RequestData } from "./requests/types.js";
+import { CodeUsageGeneratorRegistry } from "./requests/generators/index.js";
+import { HttpMethods, MediaTypeObject, OperationObject, ParameterObject, PathItemObject, ResponseObject, SecuritySchemeObject } from "./types.js";
+import { ReactNode } from "react";
+//#region src/operation.d.ts
+export interface OperationParameters {
+  in: 'path' | 'query' | 'header' | 'cookie';
+  items: ParameterObject[];
+}
+export interface OperationSecurity {
+  key: string;
+  scopes: string[];
+  /** `undefined` when the document doesn't define the scheme */
+  scheme?: SecuritySchemeObject;
+}
+export interface OperationResponse {
+  status: string;
+  response: ResponseObject;
+  /** media types of the response, resolved */
+  content: Record<string, MediaTypeObject>;
+}
+export interface OperationCallback {
+  name: string;
+  path: string;
+  method: HttpMethods;
+  pathItem: PathItemObject;
+  operation: OperationObject;
+}
+/** the operation and its resolved details, all read-only */
+export interface OperationInfo {
+  type: 'operation' | 'webhook';
+  path: string;
+  method: HttpMethods;
+  operation: OperationObject;
+  pathItem: PathItemObject;
+  title: string;
+  description?: string;
+  /** resolved request body with its media types, `undefined` when it has none */
+  requestBody?: {
+    description?: string;
+    required?: boolean;
+    content: Record<string, MediaTypeObject>;
+  };
+  /** resolved parameters grouped by location, empty groups omitted */
+  parameters: OperationParameters[];
+  /** alternative security requirements, always empty for webhooks */
+  security: OperationSecurity[][];
+  responses: OperationResponse[];
+  /** callbacks flattened into webhook operations */
+  callbacks: OperationCallback[];
+  /** code usage generators, including the inline code samples of operation */
+  codeUsages: CodeUsageGeneratorRegistry;
+}
+export interface ExampleRequest {
+  id: string;
+  name: string;
+  description?: string;
+  data: RawRequestData;
+  encoded: RequestData;
+  /** pathname of the request, with path parameters and query encoded */
+  pathname: string;
+}
+export interface ResponseExample {
+  /**
+   * generated/defined example data
+   */
+  sample: unknown;
+  label: ReactNode;
+  /**
+   * description (in Markdown)
+   */
+  description?: string;
+}
+export interface ResponseTab {
+  /**
+   * HTTP response code
+   */
+  code: string;
+  response: ResponseObject;
+  /**
+   * media type of response
+   */
+  mediaType: string | null;
+  examples?: ResponseExample[];
+}
+/** props of the component rendering an operation or webhook of a page */
+export interface PageOperationProps {
+  type: 'operation' | 'webhook';
+  path: string;
+  method: HttpMethods;
+  operation: OperationObject;
+  pathItem: PathItemObject;
+  showTitle?: boolean;
+  showDescription?: boolean;
+}
+export interface OperationProviderProps {
+  /** @defaultValue 'operation' */
+  type?: 'operation' | 'webhook';
+  path: string;
+  method: HttpMethods;
+  operation: OperationObject;
+  pathItem: PathItemObject;
+  children: ReactNode;
+}
+export declare function OperationProvider({ type, path, method, operation, pathItem, children }: OperationProviderProps): import("react").JSX.Element;
+export declare function useOperation(): OperationInfo;
+/**
+ * Example requests of the operation, and the selected one.
+ *
+ * It doesn't follow the updates of items, use `useExampleRequest()` for the data of selected one.
+ */
+export declare function useExampleRequests(): {
+  items: ExampleRequest[];
+  selected: string | undefined;
+  select: (id: string) => void;
+  /** update the data of selected example */
+  update: (data: RawRequestData) => void;
+};
+/**
+ * Data of the selected example request, following its updates.
+ */
+export declare function useExampleRequest(): RawRequestData | undefined;
+/**
+ * Generate the code usage of the selected example request with the generator `id`.
+ *
+ * @returns `undefined` when the generator or the example is unavailable
+ */
+export declare function useCodeUsage(id: string): string | undefined;
+/**
+ * Responses of the operation, with example values of their preferred media type.
+ */
+export declare function useResponseExamples(): ResponseTab[];
+//#endregion

package/dist/operation.js

@@ -0,0 +1,296 @@
+"use client";
+import { isMediaTypeSupported } from "./requests/media/resolve-adapter.js";
+import { createCodeUsageGeneratorRegistry, pathnameFromRequest } from "./requests/generators/index.js";
+import { joinURL } from "./packages/shared-api/dist/utils/url.js";
+import { ServerProvider, useServer } from "./utils/use-server.js";
+import { useOpenAPI } from "./utils/create-page.js";
+import { idToTitle } from "./packages/shared-api/dist/utils/id-to-title.js";
+import { getPreferredType, methodKeys } from "./utils/schema.js";
+import { encodeRequestData } from "./requests/media/encode.js";
+import { getExampleRequests } from "./utils/get-example-requests.js";
+import { createContext, use, useMemo, useSyncExternalStore } from "react";
+import { getRaw } from "@scalar/json-magic/magic-proxy";
+import { sample } from "@fumadocs/json-schema";
+import { jsx } from "react/jsx-runtime";
+import { useTranslations } from "@fuma-translate/react";
+//#region src/operation.tsx
+const OperationContext = createContext(null);
+const parameterLocations = [
+	"path",
+	"query",
+	"header",
+	"cookie"
+];
+function OperationProvider({ type = "operation", path, method, operation, pathItem, children }) {
+	const runtime = useOpenAPI();
+	const state = useMemo(() => {
+		const { dereferenced, resolve } = runtime.doc;
+		const body = resolve(operation.requestBody);
+		let requestBody;
+		if (body?.content && Object.keys(body.content).length > 0) {
+			const content = {};
+			for (const [mediaType, item] of Object.entries(body.content)) {
+				if (!isMediaTypeSupported(mediaType, runtime.mediaAdapters)) throw new Error(`Media type ${mediaType} is not supported (in ${path})`);
+				content[mediaType] = resolve(item);
+			}
+			requestBody = {
+				description: body.description,
+				required: body.required,
+				content
+			};
+		}
+		const resolvedParameters = [];
+		const groups = {};
+		const keys = /* @__PURE__ */ new Set();
+		for (const list of [operation.parameters, pathItem.parameters]) for (const item of list ?? []) {
+			const param = resolve(item);
+			const key = `${param.in}:${param.name}`;
+			if (keys.has(key)) continue;
+			keys.add(key);
+			resolvedParameters.push(param);
+			(groups[param.in] ??= []).push(param);
+		}
+		const parameters = [];
+		for (const location of parameterLocations) {
+			const items = groups[location];
+			if (items) parameters.push({
+				in: location,
+				items
+			});
+		}
+		const security = [];
+		if (type === "operation") {
+			const schemes = dereferenced.components?.securitySchemes;
+			for (const requirement of operation.security ?? dereferenced.security ?? []) {
+				const entries = Object.entries(requirement);
+				if (entries.length === 0) continue;
+				security.push(entries.map(([key, scopes]) => ({
+					key,
+					scopes,
+					scheme: resolve(schemes?.[key])
+				})));
+			}
+		}
+		const responses = [];
+		for (const [status, item] of Object.entries(operation.responses ?? {})) {
+			const response = resolve(item);
+			const content = {};
+			for (const [mediaType, media] of Object.entries(response.content ?? {})) content[mediaType] = resolve(media);
+			responses.push({
+				status,
+				response,
+				content
+			});
+		}
+		const callbacks = [];
+		for (const [name, item] of Object.entries(operation.callbacks ?? {})) for (const [callbackPath, rawPathItem] of Object.entries(resolve(item))) {
+			const callback = resolve(rawPathItem);
+			for (const callbackMethod of methodKeys) {
+				const callbackOperation = callback[callbackMethod];
+				if (!callbackOperation) continue;
+				callbacks.push({
+					name,
+					path: callbackPath,
+					method: callbackMethod,
+					pathItem: callback,
+					operation: callbackOperation
+				});
+			}
+		}
+		const codeUsages = createCodeUsageGeneratorRegistry(runtime.codeUsages);
+		if (type === "operation") {
+			for (const gen of runtime.generateCodeSamples?.({
+				path,
+				operation,
+				method,
+				pathItem
+			}) ?? []) codeUsages.addInline(gen);
+			for (const inline of operation["x-codeSamples"] ?? []) codeUsages.addInline(inline);
+		}
+		const examples = getExampleRequests({
+			path,
+			method,
+			operation,
+			parameters: resolvedParameters,
+			mediaAdapters: runtime.mediaAdapters
+		});
+		for (const item of examples) item.pathname = pathnameFromRequest(path, item.encoded);
+		return {
+			info: {
+				type,
+				path,
+				method,
+				operation,
+				pathItem,
+				title: operation.summary || pathItem.summary || (operation.operationId ? idToTitle(operation.operationId) : path),
+				description: operation.description ?? pathItem.description,
+				requestBody,
+				parameters,
+				security,
+				responses,
+				callbacks,
+				codeUsages
+			},
+			parameters: resolvedParameters,
+			examples,
+			...createExampleStore(examples, operation["x-exclusiveCodeSample"] ?? operation["x-selectedCodeSample"] ?? examples[0]?.id, path, (data) => encodeRequestData(data, runtime.mediaAdapters, resolvedParameters))
+		};
+	}, [
+		runtime,
+		type,
+		path,
+		method,
+		operation,
+		pathItem
+	]);
+	const content = /* @__PURE__ */ jsx(OperationContext, {
+		value: state,
+		children
+	});
+	const servers = operation.servers ?? pathItem.servers;
+	if (!servers) return content;
+	return /* @__PURE__ */ jsx(ServerProvider, {
+		servers,
+		storageKeyPrefix: runtime.storageKeyPrefix,
+		children: content
+	});
+}
+/** an external store, so selecting examples doesn't re-render the entire operation */
+function createExampleStore(examples, selected, path, encode) {
+	const listeners = /* @__PURE__ */ new Set();
+	function notify(item) {
+		for (const listener of listeners) listener(item);
+	}
+	return {
+		getExample: () => selected,
+		setExample(id) {
+			const item = examples.find((item) => item.id === id);
+			if (!item) return;
+			selected = id;
+			notify(item);
+		},
+		update(data, encoded = encode(data)) {
+			const item = examples.find((item) => item.id === selected);
+			if (!item) return;
+			item.data = data;
+			item.encoded = encoded;
+			item.pathname = pathnameFromRequest(path, encoded);
+			notify(item);
+		},
+		subscribe(listener) {
+			listeners.add(listener);
+			return () => {
+				listeners.delete(listener);
+			};
+		}
+	};
+}
+function useOperationState() {
+	const ctx = use(OperationContext);
+	if (!ctx) throw new Error("Component must be used under <OperationProvider />");
+	return ctx;
+}
+function useOperation() {
+	return useOperationState().info;
+}
+/**
+* Example requests of the operation, and the selected one.
+*
+* It doesn't follow the updates of items, use `useExampleRequest()` for the data of selected one.
+*/
+function useExampleRequests() {
+	const { examples, getExample, setExample, update, subscribe } = useOperationState();
+	return {
+		items: examples,
+		selected: useSyncExternalStore(subscribe, getExample, getExample),
+		select: setExample,
+		update
+	};
+}
+function useSelectedExample() {
+	const { examples, getExample, subscribe } = useOperationState();
+	const getSnapshot = () => examples.find((item) => item.id === getExample())?.encoded;
+	const encoded = useSyncExternalStore(subscribe, getSnapshot, getSnapshot);
+	return examples.find((item) => item.encoded === encoded);
+}
+/**
+* Data of the selected example request, following its updates.
+*/
+function useExampleRequest() {
+	return useSelectedExample()?.data;
+}
+/**
+* Generate the code usage of the selected example request with the generator `id`.
+*
+* @returns `undefined` when the generator or the example is unavailable
+*/
+function useCodeUsage(id) {
+	const { mediaAdapters } = useOpenAPI();
+	const { info } = useOperationState();
+	const { server, resolveUrl } = useServer();
+	const codegen = info.codeUsages.get(id);
+	const { encoded, pathname } = useSelectedExample() ?? {};
+	return useMemo(() => {
+		if (!encoded || !pathname || !codegen) return;
+		return codegen.generate({
+			...encoded,
+			url: server ? resolveUrl(pathname) : joinURL("https://example.com", pathname)
+		}, {
+			mediaAdapters,
+			custom: null
+		});
+	}, [
+		encoded,
+		pathname,
+		server,
+		resolveUrl,
+		codegen,
+		mediaAdapters
+	]);
+}
+/**
+* Responses of the operation, with example values of their preferred media type.
+*/
+function useResponseExamples() {
+	const { responses } = useOperation();
+	const { resolve } = useOpenAPI().doc;
+	const t = useTranslations({ note: "operation page" });
+	return useMemo(() => {
+		const tabs = [];
+		for (const { status: code, response, content } of responses) {
+			const media = getPreferredType(content) ?? null;
+			const responseOfType = media ? content[media] : null;
+			const tab = {
+				code,
+				response,
+				mediaType: media
+			};
+			if (responseOfType?.examples) {
+				tab.examples = [];
+				for (const [key, item] of Object.entries(responseOfType.examples)) {
+					const example = resolve(item);
+					tab.examples.push({
+						label: example.summary ?? t("Example {key}", { variables: { key } }),
+						sample: getRaw(example.value),
+						description: example.description
+					});
+				}
+			} else if (responseOfType?.example !== void 0) tab.examples = [{
+				label: t("Example"),
+				sample: getRaw(responseOfType.example)
+			}];
+			else if (responseOfType?.schema) tab.examples = [{
+				label: t("Example"),
+				sample: sample(responseOfType.schema)
+			}];
+			tabs.push(tab);
+		}
+		return tabs;
+	}, [
+		responses,
+		resolve,
+		t
+	]);
+}
+//#endregion
+export { OperationProvider, useCodeUsage, useExampleRequest, useExampleRequests, useOperation, useResponseExamples };

package/dist/packages/shared-api/dist/.translations/index.d.ts

@@ -0,0 +1,29 @@
+//#region ../shared-api/dist/.translations/index.d.ts
+//#region src/.translations/index.d.ts
+export type Translations = {
+  "Default(schema UI)": string;
+  "Deprecated(schema UI)": string;
+  "Enter Property Name(playground)": string;
+  "Enter value(playground)": string;
+  "Example(schema UI)": string;
+  "Filter Properties(schema UI)": string;
+  "Format(schema UI)": string;
+  "Items(schema UI)": string;
+  "Length(schema UI)": string;
+  "Match(schema UI)": string;
+  "Multiple Of(schema UI)": string;
+  "New Item(playground)": string;
+  "New(playground)": string;
+  "No property matching(schema UI)": string;
+  "Properties(schema UI)": string;
+  "Range(schema UI)": string;
+  "Remove Item(playground)(aria-label)": string;
+  "Select(playground)": string;
+  "Selected(playground)": string;
+  "Show Property(playground)": string;
+  "Unset(playground)": string;
+  "Upload(playground)": string;
+  "Value in(schema UI)": string;
+};
+//#endregion
+//#endregion