fumadocs-openapi 5.3.2 → 5.4.1

package/dist/index.d.ts

@@ -49,7 +49,9 @@ interface APIPlaygroundProps {
     route: string;
     method: string;
     bodyType: 'json' | 'form-data';
-    authorization?: PrimitiveRequestField;
+    authorization?: PrimitiveRequestField & {
+        authType: string;
+    };
     path?: PrimitiveRequestField[];
     query?: PrimitiveRequestField[];
     header?: PrimitiveRequestField[];
@@ -221,6 +223,12 @@ interface GenerateOptions {
      * A `full: true` property will be added by default.
      */
     frontmatter?: (title: string, description: string | undefined, context: DocumentContext) => Record<string, unknown>;
+    /**
+     * Add description to document body
+     *
+     * @defaultValue false
+     */
+    includeDescription?: boolean;
     cwd?: string;
 }
 interface GenerateTagOutput {

package/dist/index.js

@@ -79,7 +79,7 @@ function idToTitle(id) {
 }
 
 function generateDocument(options) {
-    const { frontmatter } = options;
+    const { frontmatter, includeDescription = false } = options;
     const out = [];
     const extend = frontmatter?.(options.title, options.description, options.context);
     let meta;
@@ -106,6 +106,7 @@ function generateDocument(options) {
     if (imports) {
         out.push(imports);
     }
+    if (options.description && includeDescription) out.push(options.description);
     out.push(pageContent(options.page));
     return out.join('\n\n');
 }

package/dist/server/index.d.ts

@@ -50,7 +50,9 @@ interface APIPlaygroundProps {
     route: string;
     method: string;
     bodyType: 'json' | 'form-data';
-    authorization?: PrimitiveRequestField;
+    authorization?: PrimitiveRequestField & {
+        authType: string;
+    };
     path?: PrimitiveRequestField[];
     query?: PrimitiveRequestField[];
     header?: PrimitiveRequestField[];

package/dist/server/index.js

@@ -317,6 +317,7 @@ function getAuthorizationField(method, ctx) {
     return {
         type: 'string',
         name: 'Authorization',
+        authType: scheme.type,
         defaultValue: scheme.type === 'oauth2' || scheme.type === 'http' && scheme.scheme === 'bearer' ? 'Bearer' : 'Basic',
         isRequired: security.every((requirements)=>Object.keys(requirements).length > 0),
         description: 'The Authorization access token'

package/dist/ui/{client-client-CgPBB3ii.js → client-client-BUlxkJAI.js}

@@ -64,7 +64,7 @@ function useSchemaContext() {
     return ctx;
 }
 
-const APIPlayground = dynamic(()=>import('./playground-client-CthJtmMz.js').then((mod)=>mod.APIPlayground));
+const APIPlayground = dynamic(()=>import('./playground-client-CB0L6vUj.js').then((mod)=>mod.APIPlayground));
 function Root({ children, baseUrl, className, ...props }) {
     return /*#__PURE__*/ jsx("div", {
         className: cn('flex flex-col gap-24 text-sm text-fd-muted-foreground', className),

package/dist/ui/index.d.ts

@@ -49,7 +49,9 @@ interface APIPlaygroundProps {
     route: string;
     method: string;
     bodyType: 'json' | 'form-data';
-    authorization?: PrimitiveRequestField;
+    authorization?: PrimitiveRequestField & {
+        authType: string;
+    };
     path?: PrimitiveRequestField[];
     query?: PrimitiveRequestField[];
     header?: PrimitiveRequestField[];

package/dist/ui/index.js

@@ -3,8 +3,8 @@ import { cn } from 'fumadocs-ui/components/api';
 import { Fragment } from 'react';
 import { Accordions, Accordion } from 'fumadocs-ui/components/accordion';
 import { cva } from 'class-variance-authority';
-import { C as CopyRouteButton } from './client-client-CgPBB3ii.js';
-export { A as APIPlayground, R as Root, u as useSchemaContext } from './client-client-CgPBB3ii.js';
+import { C as CopyRouteButton } from './client-client-BUlxkJAI.js';
+export { A as APIPlayground, R as Root, u as useSchemaContext } from './client-client-BUlxkJAI.js';
 
 const badgeVariants = cva('rounded border px-1.5 py-1 text-xs font-medium leading-[12px]', {
     variants: {
@@ -92,10 +92,10 @@ function API({ className, children, ...props }) {
 }
 function Property({ name, type, required, deprecated, children }) {
     return /*#__PURE__*/ jsxs("div", {
-        className: "mb-4 flex flex-col rounded-lg border bg-fd-card p-3 prose-no-margin",
+        className: "mb-4 rounded-lg border bg-fd-card p-3 prose-no-margin",
         children: [
             /*#__PURE__*/ jsxs("h4", {
-                className: "inline-flex items-center gap-4",
+                className: "flex flex-row items-center gap-4",
                 children: [
                     /*#__PURE__*/ jsx("code", {
                         children: name

package/dist/ui/{playground-client-CthJtmMz.js → playground-client-CB0L6vUj.js}

@@ -1,12 +1,12 @@
 'use client';
 import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 import * as React from 'react';
-import { forwardRef, useId, createContext, useContext, useState, useCallback, useLayoutEffect, useRef, useMemo } from 'react';
+import { forwardRef, useId, createContext, useContext, useState, useCallback, useLayoutEffect, useRef, useEffect, useMemo } from 'react';
 import { FormProvider, Controller, useFormContext, useFieldArray, useForm, useWatch } from 'react-hook-form';
 import useSWRImmutable from 'swr/immutable';
 import { Accordions, Accordion } from 'fumadocs-ui/components/accordion';
 import { cn, buttonVariants } from 'fumadocs-ui/components/api';
-import { u as useSchemaContext, a as useApiContext, S as SchemaContext } from './client-client-CgPBB3ii.js';
+import { u as useSchemaContext, a as useApiContext, S as SchemaContext } from './client-client-BUlxkJAI.js';
 import { Slot } from '@radix-ui/react-slot';
 import { cva } from 'class-variance-authority';
 import { CircleCheckIcon, CircleXIcon, ChevronDown, ChevronUp, Check, Trash2, Plus } from 'lucide-react';
@@ -905,6 +905,20 @@ function APIPlayground({ route, method = 'GET', bodyType, authorization, path =
     }, {
         shouldRetryOnError: false
     });
+    useEffect(()=>{
+        if (!authorization) return;
+        const key = `__fumadocs_authorization_${authorization.authType}`;
+        const cached = localStorage.getItem(key);
+        if (cached) form.setValue('authorization', cached);
+        const subscription = form.watch((value, { name })=>{
+            if (name !== 'authorization' || !value.authorization) return;
+            localStorage.setItem(key, value.authorization);
+        });
+        return ()=>{
+            subscription.unsubscribe();
+        };
+    // eslint-disable-next-line react-hooks/exhaustive-deps -- mounted only once
+    }, []);
     const onSubmit = form.handleSubmit((value)=>{
         setInput(value);
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "5.3.2",
+  "version": "5.4.1",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",