fumadocs-openapi 9.0.1 → 9.0.2

package/dist/playground/client.js

@@ -65,7 +65,7 @@ export default function Client({ route, method = 'GET', authorization, parameter
             const value = _value;
             if (authorization && value.authorization) {
                 authInfo.saveInfo(value.authorization);
-                writeAuthHeader(authorization, value.authorization, value.header, value.query, value.cookie);
+                writeAuthInfo(authorization, value.authorization, value.header, value.query, value.cookie);
             }
             requestData.saveData(toRequestData(method, body?.mediaType, value));
         });
@@ -85,38 +85,61 @@ function FormBody({ authorization, parameters = [], fields = {}, body, }) {
     const params = useMemo(() => {
         return paramTypes.map((param) => parameters.filter((v) => v.in === param));
     }, [parameters]);
-    function renderAuth() {
+    const auth = useMemo(() => {
         if (!authorization)
-            return null;
-        const schema = authorization.type === 'http' && authorization.scheme === 'basic'
-            ? {
-                type: 'object',
-                required: ['username', 'password'],
-                properties: {
-                    username: {
-                        type: 'string',
-                    },
-                    password: {
-                        type: 'string',
+            return;
+        if (authorization.type === 'http' && authorization.scheme === 'basic') {
+            return {
+                in: 'header',
+                field: {
+                    type: 'object',
+                    required: ['username', 'password'],
+                    description: authorization.description,
+                    properties: {
+                        username: {
+                            type: 'string',
+                        },
+                        password: {
+                            type: 'string',
+                        },
                     },
                 },
-            }
-            : {
-                type: 'string',
-                description: 'The Authorization access token',
             };
+        }
+        else if (authorization.type === 'http' ||
+            authorization.type === 'oauth2') {
+            return {
+                in: 'header',
+                field: {
+                    type: 'string',
+                    description: authorization.description ?? `The Authorization access token.`,
+                },
+            };
+        }
+        else if (authorization.type === 'apiKey') {
+            return {
+                in: authorization.in,
+                field: {
+                    type: 'string',
+                    description: authorization.description ?? 'The API key.',
+                },
+            };
+        }
+        // TODO: handle OpenID connect
+    }, [authorization]);
+    function renderAuth() {
+        if (!auth)
+            return null;
         if (fields?.auth)
-            return renderCustomField('authorization', schema, fields.auth);
-        return (_jsx(FieldSet, { fieldName: "authorization", name: "Authorization", field: schema, isRequired: true }));
+            return renderCustomField('authorization', auth.field, fields.auth);
+        return (_jsx(FieldSet, { fieldName: "authorization", name: "Authorization", field: auth.field, isRequired: true }));
     }
     return (_jsxs(_Fragment, { children: [params.map((param, i) => {
                 const name = paramNames[i];
                 const type = paramTypes[i];
-                if (type !== 'header' && param.length === 0)
-                    return;
-                if (type === 'header' && !authorization && param.length === 0)
+                if ((!auth || type !== auth.in) && param.length === 0)
                     return;
-                return (_jsxs(CollapsiblePanel, { title: name, children: [type === 'header' ? renderAuth() : null, param.map((field) => {
+                return (_jsxs(CollapsiblePanel, { title: name, children: [auth && type === auth.in ? renderAuth() : null, param.map((field) => {
                             const fieldName = `${type}.${field.name}`;
                             if (fields?.parameter) {
                                 return renderCustomField(fieldName, field.schema, fields.parameter, field.name);
@@ -209,7 +232,7 @@ function usePersistentAuthInfo(authorization) {
 function CollapsiblePanel({ title, children, ...props }) {
     return (_jsxs(Collapsible, { ...props, className: "border-b last:border-b-0", children: [_jsxs(CollapsibleTrigger, { className: "group w-full flex items-center gap-2 p-3 text-sm font-medium", children: [title, _jsx(ChevronDown, { className: "ms-auto size-3.5 text-fd-muted-foreground group-data-[state=open]:rotate-180" })] }), _jsx(CollapsibleContent, { children: _jsx("div", { className: "flex flex-col gap-3 p-3 pt-1", children: children }) })] }));
 }
-function writeAuthHeader(authorization, input, header, query, cookie) {
+function writeAuthInfo(authorization, input, header, query, cookie) {
     if (authorization.type === 'apiKey') {
         if (authorization.in === 'header') {
             header[authorization.name] = input;

package/dist/playground/fetcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetcher.d.ts","sourceRoot":"","sources":["../../src/playground/fetcher.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/B,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;CACvE;AAED,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GACrC,OAAO,CAyFT"}
+{"version":3,"file":"fetcher.d.ts","sourceRoot":"","sources":["../../src/playground/fetcher.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/B,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;CACvE;AAED,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GACrC,OAAO,CAkGT"}

package/dist/playground/fetcher.js

@@ -13,23 +13,6 @@ export function createBrowserFetcher(adapters) {
             const proxyUrl = options.proxyUrl
                 ? new URL(options.proxyUrl, window.location.origin)
                 : null;
-            if (typeof document !== 'undefined') {
-                for (const key in options.cookie) {
-                    const value = options.cookie[key];
-                    if (!value)
-                        continue;
-                    document.cookie = [
-                        `${key}=${value}`,
-                        'HttpOnly',
-                        proxyUrl &&
-                            proxyUrl.origin !== window.location.origin &&
-                            `domain=${proxyUrl.host}`,
-                        'path=/',
-                    ]
-                        .filter(Boolean)
-                        .join(';');
-                }
-            }
             let url = getPathnameFromInput(route, options.path, options.query);
             if (proxyUrl) {
                 proxyUrl.searchParams.append('url', url);
@@ -46,6 +29,29 @@ export function createBrowserFetcher(adapters) {
                     };
                 body = await adapter.encode(options);
             }
+            // cookies
+            for (const key in options.cookie) {
+                const value = options.cookie[key];
+                if (!value)
+                    continue;
+                const cookie = {
+                    [key]: value,
+                    domain: proxyUrl && proxyUrl.origin !== window.location.origin
+                        ? `domain=${proxyUrl.host}`
+                        : undefined,
+                    path: '/',
+                    'max-age': 30,
+                };
+                let str = '';
+                for (const [key, value] of Object.entries(cookie)) {
+                    if (value) {
+                        if (str.length > 0)
+                            str += '; ';
+                        str += `${key}=${value}`;
+                    }
+                }
+                document.cookie = str;
+            }
             return fetch(url, {
                 method: options.method,
                 cache: 'no-cache',

package/dist/playground/index.js

@@ -81,7 +81,7 @@ function getAuthorizationField(method, { schema: { document } }) {
             item = requirements;
     }
     if (!item) {
-        console.warn(`Cannot find suitable security scheme for API Playground from ${JSON.stringify(security, null, 2)}. Only schemes with one requirement are allowed.`);
+        console.warn(`Cannot find suitable security scheme for API Playground from ${JSON.stringify(security, null, 2)}. Only schemes with one requirement are allowed at the moment.`);
         return;
     }
     const scheme = getSecurities(item, document)[0];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "9.0.1",
+  "version": "9.0.2",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",
@@ -63,8 +63,8 @@
     "shiki": "^3.4.2",
     "tinyglobby": "^0.2.13",
     "xml-js": "^1.6.11",
-    "fumadocs-core": "15.4.0",
-    "fumadocs-ui": "15.4.0"
+    "fumadocs-core": "15.4.1",
+    "fumadocs-ui": "15.4.1"
   },
   "devDependencies": {
     "@scalar/api-client-react": "^1.3.3",
@@ -77,8 +77,8 @@
     "openapi-types": "^12.1.3",
     "tailwindcss": "^4.1.7",
     "tsc-alias": "^1.8.16",
-    "tsconfig": "0.0.0",
-    "eslint-config-custom": "0.0.0"
+    "eslint-config-custom": "0.0.0",
+    "tsconfig": "0.0.0"
   },
   "peerDependencies": {
     "@scalar/api-client-react": "*",