fumadocs-openapi 9.0.17 → 9.1.0

package/dist/utils/get-typescript-schema.js

@@ -1,11 +1,16 @@
 import { compile } from '@fumari/json-schema-to-typescript';
 export async function getTypescriptSchema(schema, dereferenceMap) {
-    const cloned = structuredClone({ schema, dereferenceMap });
-    return compile(cloned.schema, 'Response', {
-        $refOptions: false,
-        schemaToId: cloned.dereferenceMap,
-        bannerComment: '',
-        additionalProperties: false,
-        enableConstEnums: false,
-    });
+    try {
+        const cloned = structuredClone({ schema, dereferenceMap });
+        return await compile(cloned.schema, 'Response', {
+            $refOptions: false,
+            schemaToId: cloned.dereferenceMap,
+            bannerComment: '',
+            additionalProperties: false,
+            enableConstEnums: false,
+        });
+    }
+    catch (e) {
+        console.warn('Failed to generate typescript schema:', e);
+    }
 }

package/dist/utils/process-document.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"process-document.d.ts","sourceRoot":"","sources":["../../src/utils/process-document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAK5D,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,WAAW,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;AAE/E,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAChC,cAAc,EAAE,cAAc,CAAC;IAC/B,UAAU,EAAE,QAAQ,CAAC;CACtB,CAAC;AAIF;;GAEG;AACH,wBAAsB,eAAe,CACnC,KAAK,EAAE,aAAa,EACpB,YAAY,UAAQ,GACnB,OAAO,CAAC,iBAAiB,CAAC,CAoC5B"}
+{"version":3,"file":"process-document.d.ts","sourceRoot":"","sources":["../../src/utils/process-document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAI5D,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,WAAW,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;AAE/E,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAChC,cAAc,EAAE,cAAc,CAAC;IAC/B,UAAU,EAAE,QAAQ,CAAC;CACtB,CAAC;AAIF;;GAEG;AACH,wBAAsB,eAAe,CACnC,KAAK,EAAE,aAAa,EACpB,YAAY,UAAQ,GACnB,OAAO,CAAC,iBAAiB,CAAC,CA+B5B"}

package/dist/utils/process-document.js

@@ -1,6 +1,5 @@
-import { dereference, load, upgrade } from '@scalar/openapi-parser';
-import { fetchUrls } from '@scalar/openapi-parser/plugins/fetch-urls';
-import { readFiles } from '@scalar/openapi-parser/plugins/read-files';
+import { bundle, dereference, upgrade } from '@scalar/openapi-parser';
+import { fetchUrls, readFiles } from '@scalar/openapi-parser/plugins';
 const cache = new Map();
 /**
  * process & reference input document to a Fumadocs OpenAPI compatible format
@@ -10,15 +9,13 @@ export async function processDocument(input, disableCache = false) {
     if (cached)
         return cached;
     const dereferenceMap = new Map();
-    const loaded = await load(input, {
-        plugins: [readFiles(), fetchUrls()],
+    let document = await bundle(input, {
+        plugins: [fetchUrls(), readFiles()],
+        treeShake: false,
     });
-    if (loaded.errors && loaded.errors.length > 0) {
-        throw new Error(loaded.errors.map((err) => `${err.code}: ${err.message}`).join('\n'));
-    }
     // upgrade
-    loaded.specification = upgrade(loaded.specification).specification;
-    const { schema: dereferenced } = await dereference(loaded.filesystem, {
+    document = upgrade(document).specification;
+    const { schema: dereferenced } = await dereference(document, {
         onDereference({ ref, schema }) {
             dereferenceMap.set(schema, ref);
         },
@@ -26,7 +23,7 @@ export async function processDocument(input, disableCache = false) {
     const processed = {
         document: dereferenced,
         dereferenceMap,
-        downloaded: loaded.specification,
+        downloaded: document,
     };
     if (!disableCache && typeof input === 'string') {
         cache.set(input, processed);

package/dist/utils/schema-to-string.d.ts

@@ -1,3 +1,4 @@
 import { type ResolvedSchema } from '../utils/schema.js';
-export declare function schemaToString(schema: ResolvedSchema, isRoot?: boolean): string;
+import type { ProcessedDocument } from '../utils/process-document.js';
+export declare function schemaToString(value: ResolvedSchema, ctx?: ProcessedDocument): string;
 //# sourceMappingURL=schema-to-string.d.ts.map

package/dist/utils/schema-to-string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema-to-string.d.ts","sourceRoot":"","sources":["../../src/utils/schema-to-string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAExE,wBAAgB,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,UAAO,GAAG,MAAM,CA0D5E"}
+{"version":3,"file":"schema-to-string.d.ts","sourceRoot":"","sources":["../../src/utils/schema-to-string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAElE,wBAAgB,cAAc,CAC5B,KAAK,EAAE,cAAc,EACrB,GAAG,CAAC,EAAE,iBAAiB,GACtB,MAAM,CA8DR"}

package/dist/utils/schema-to-string.js

@@ -1,50 +1,58 @@
-export function schemaToString(schema, isRoot = true) {
-    if (schema === true)
-        return 'any';
-    else if (schema === false)
-        return 'never';
-    if (isNullable(schema) && isRoot) {
-        const type = schemaToString(schema, false);
-        // null if schema only contains `nullable`
-        return type === 'unknown' ? 'null' : `${type} | null`;
+export function schemaToString(value, ctx) {
+    function run(schema, isRoot) {
+        if (schema === true)
+            return 'any';
+        else if (schema === false)
+            return 'never';
+        if (isNullable(schema) && isRoot) {
+            const type = run(schema, false);
+            // null if schema only contains `nullable`
+            return type === 'unknown' ? 'null' : `${type} | null`;
+        }
+        if (schema.title)
+            return schema.title;
+        const referenceName = ctx?.dereferenceMap.get(schema);
+        if (referenceName)
+            return referenceName.split('/').at(-1);
+        if (Array.isArray(schema.type)) {
+            return schema.type
+                .map((type, _, originalType) => {
+                schema.type = type;
+                const str = run(schema, false);
+                schema.type = originalType;
+                return str;
+            })
+                .filter((v) => v !== 'unknown' && v !== 'null')
+                .join(' | ');
+        }
+        if (schema.type === 'array')
+            return `array<${schema.items ? run(schema.items, true) : 'unknown'}>`;
+        if (schema.oneOf) {
+            return schema.oneOf
+                .map((one) => run(one, false))
+                .filter((v) => v !== 'unknown' && v !== 'null')
+                .join(' | ');
+        }
+        const combinedOf = schema.anyOf ?? schema.allOf;
+        if (combinedOf) {
+            return combinedOf
+                .map((one) => run(one, false))
+                .filter((v) => v !== 'unknown' && v !== 'null')
+                .join(' & ');
+        }
+        if (schema.not)
+            return `not ${run(schema.not, false)}`;
+        if (schema.type === 'string' && schema.format === 'binary')
+            return 'file';
+        if (schema.type && Array.isArray(schema.type)) {
+            return schema.type.filter((v) => v !== 'null').join(' | ');
+        }
+        if (schema.type) {
+            return schema.type;
+        }
+        return 'unknown';
     }
-    if (schema.title)
-        return schema.title;
-    if (Array.isArray(schema.type)) {
-        return schema.type
-            .map((type) => schemaToString({
-            ...schema,
-            type,
-        }, false))
-            .filter((v) => v !== 'unknown' && v !== 'null')
-            .join(' | ');
-    }
-    if (schema.type === 'array')
-        return `array<${schema.items ? schemaToString(schema.items) : 'unknown'}>`;
-    if (schema.oneOf) {
-        return schema.oneOf
-            .map((one) => schemaToString(one, false))
-            .filter((v) => v !== 'unknown' && v !== 'null')
-            .join(' | ');
-    }
-    const combinedOf = schema.anyOf ?? schema.allOf;
-    if (combinedOf) {
-        return combinedOf
-            .map((one) => schemaToString(one, false))
-            .filter((v) => v !== 'unknown' && v !== 'null')
-            .join(' & ');
-    }
-    if (schema.not)
-        return `not ${schemaToString(schema.not, false)}`;
-    if (schema.type === 'string' && schema.format === 'binary')
-        return 'file';
-    if (schema.type && Array.isArray(schema.type)) {
-        return schema.type.filter((v) => v !== 'null').join(' | ');
-    }
-    if (schema.type) {
-        return schema.type;
-    }
-    return 'unknown';
+    return run(value, true);
 }
 function isNullable(schema) {
     if (typeof schema === 'boolean')

package/dist/utils/url.js

@@ -26,26 +26,24 @@ export function resolveServerUrl(template, variables) {
 }
 export function resolveRequestData(pathname, { path, query }) {
     for (const key in path) {
-        if (path[key] === '')
-            continue;
-        if (Array.isArray(path[key])) {
-            pathname = pathname.replace(`{${key}}`, path[key].join('/'));
+        const param = path[key];
+        if (Array.isArray(param.value)) {
+            pathname = pathname.replace(`{${key}}`, param.value.join('/'));
         }
         else {
-            pathname = pathname.replace(`{${key}}`, String(path[key]));
+            pathname = pathname.replace(`{${key}}`, param.value);
         }
     }
     const searchParams = new URLSearchParams();
     for (const key in query) {
-        if (Array.isArray(query[key])) {
-            for (const value of query[key]) {
-                if (!query[key])
-                    continue;
-                searchParams.append(key, String(value));
+        const param = query[key];
+        if (Array.isArray(param.value)) {
+            for (const item of param.value) {
+                searchParams.append(key, item);
             }
         }
-        else if (query[key] && query[key] !== '') {
-            searchParams.set(key, String(query[key]));
+        else {
+            searchParams.append(key, param.value);
         }
     }
     return searchParams.size > 0 ? `${pathname}?${searchParams}` : pathname;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "9.0.17",
+  "version": "9.1.0",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",
@@ -64,8 +64,8 @@
     "shiki": "^3.7.0",
     "tinyglobby": "^0.2.14",
     "xml-js": "^1.6.11",
-    "fumadocs-core": "15.6.1",
-    "fumadocs-ui": "15.6.1"
+    "fumadocs-core": "15.6.2",
+    "fumadocs-ui": "15.6.2"
   },
   "devDependencies": {
     "@scalar/api-client-react": "^1.3.18",
@@ -78,8 +78,8 @@
     "openapi-types": "^12.1.3",
     "tailwindcss": "^4.1.11",
     "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": "*",