fumadocs-openapi 8.1.3 → 8.1.4

package/dist/utils/combine-schema.js

@@ -2,17 +2,23 @@
  * Combine multiple object schemas into one
  */
 export function combineSchema(schema) {
-    const result = {
+    let result = {
         type: undefined,
     };
     function add(s) {
+        if (typeof s === 'boolean') {
+            result = s;
+            return;
+        }
+        if (typeof result === 'boolean')
+            return;
         if (s.type) {
             result.type ?? (result.type = []);
             if (!Array.isArray(result.type)) {
                 result.type = [result.type];
             }
             for (const v of Array.isArray(s.type) ? s.type : [s.type]) {
-                if (!result.type.includes(v)) {
+                if (Array.isArray(result.type) && !result.type.includes(v)) {
                     result.type.push(v);
                 }
             }
@@ -21,6 +27,10 @@ export function combineSchema(schema) {
             result.properties ?? (result.properties = {});
             Object.assign(result.properties, s.properties);
         }
+        if (s.patternProperties) {
+            result.patternProperties ?? (result.patternProperties = {});
+            Object.assign(result.patternProperties, s.patternProperties);
+        }
         if (s.additionalProperties === true) {
             result.additionalProperties = true;
         }

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"schema-to-string.d.ts","sourceRoot":"","sources":["../../src/utils/schema-to-string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEjE,wBAAgB,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,UAAO,GAAG,MAAM,CAuE5E"}

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

@@ -0,0 +1,62 @@
+import { isNullable } from '../utils/schema.js';
+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`;
+    }
+    if (schema.title)
+        return schema.title;
+    if (Array.isArray(schema.type)) {
+        return schema.type
+            .map((type) => schemaToString({
+            ...schema,
+            type,
+        }, false))
+            .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')
+            .join(' | ');
+    }
+    if (schema.allOf) {
+        return schema.allOf
+            .map((one) => schemaToString(one, false))
+            .filter((v) => v !== 'unknown')
+            .join(' & ');
+    }
+    if (schema.not)
+        return `not ${schemaToString(schema.not, false)}`;
+    if (schema.anyOf) {
+        const union = schema.anyOf
+            .map((one) => schemaToString(one, false))
+            .filter((v) => v !== 'unknown');
+        if (union.length > 1) {
+            return `Any properties in ${union.join(',')}`;
+        }
+        else if (union.length === 1) {
+            return union[0];
+        }
+    }
+    if (schema.type === 'string' && schema.format === 'binary')
+        return 'file';
+    if (schema.type && Array.isArray(schema.type)) {
+        const nonNullTypes = schema.type.filter((v) => v !== 'null');
+        if (nonNullTypes.length > 0)
+            return nonNullTypes.join(' | ');
+    }
+    else if (schema.type && schema.type !== 'null') {
+        return schema.type;
+    }
+    if (typeof schema.type === 'string')
+        return schema.type;
+    return 'unknown';
+}

package/dist/utils/schema.d.ts

@@ -1,9 +1,14 @@
-import type { ReferenceObject } from '../types.js';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import { type JSONSchema } from 'json-schema-typed/draft-2020-12';
+import { ReferenceObject } from '../types.js';
 export type NoReference<T> = T extends (infer I)[] ? NoReference<I>[] : T extends ReferenceObject ? Exclude<T, ReferenceObject> : T extends object ? {
     [K in keyof T]: NoReference<T[K]>;
 } : T;
-export type ParsedSchema = OpenAPIV3_1.SchemaObject;
+type NoReferenceJSONSchema<T> = T extends (infer I)[] ? NoReference<I>[] : T extends {
+    $ref?: string;
+} ? Omit<T, '$ref'> : T;
+export type ParsedSchema = JSONSchema;
+export type ResolvedSchema = NoReferenceJSONSchema<ParsedSchema>;
 export declare function getPreferredType<B extends Record<string, unknown>>(body: B): keyof B | undefined;
-export declare function isNullable(schema: NoReference<ParsedSchema>, includeOneOf?: boolean): boolean;
+export declare function isNullable(schema: ParsedSchema, includeOneOf?: boolean): boolean;
+export {};
 //# sourceMappingURL=schema.d.ts.map

package/dist/utils/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/utils/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAC9C,WAAW,CAAC,CAAC,CAAC,EAAE,GAChB,CAAC,SAAS,eAAe,GACvB,OAAO,CAAC,CAAC,EAAE,eAAe,CAAC,GAC3B,CAAC,SAAS,MAAM,GACd;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC,GACD,CAAC,CAAC;AAEV,MAAM,MAAM,YAAY,GAAG,WAAW,CAAC,YAAY,CAAC;AAEpD,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChE,IAAI,EAAE,CAAC,GACN,MAAM,CAAC,GAAG,SAAS,CAIrB;AAED,wBAAgB,UAAU,CACxB,MAAM,EAAE,WAAW,CAAC,YAAY,CAAC,EACjC,YAAY,UAAO,GAClB,OAAO,CAQT"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/utils/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAC9C,WAAW,CAAC,CAAC,CAAC,EAAE,GAChB,CAAC,SAAS,eAAe,GACvB,OAAO,CAAC,CAAC,EAAE,eAAe,CAAC,GAC3B,CAAC,SAAS,MAAM,GACd;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC,GACD,CAAC,CAAC;AAEV,KAAK,qBAAqB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACjD,WAAW,CAAC,CAAC,CAAC,EAAE,GAChB,CAAC,SAAS;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GACzB,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,GACf,CAAC,CAAC;AAER,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC;AACtC,MAAM,MAAM,cAAc,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAC;AAEjE,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChE,IAAI,EAAE,CAAC,GACN,MAAM,CAAC,GAAG,SAAS,CAIrB;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,UAAO,GAAG,OAAO,CAU7E"}

package/dist/utils/schema.js

@@ -4,6 +4,8 @@ export function getPreferredType(body) {
     return Object.keys(body)[0];
 }
 export function isNullable(schema, includeOneOf = true) {
+    if (typeof schema === 'boolean')
+        return false;
     if (Array.isArray(schema.type) && schema.type.includes('null'))
         return true;
     if (includeOneOf && (schema.anyOf || schema.oneOf)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "8.1.3",
+  "version": "8.1.4",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",
@@ -50,7 +50,7 @@
     "@radix-ui/react-select": "^2.2.2",
     "@radix-ui/react-slot": "^1.2.0",
     "@scalar/openapi-parser": "0.10.16",
-    "ajv-draft-04": "^1.0.0",
+    "ajv": "^8.17.1",
     "class-variance-authority": "^0.7.1",
     "fast-glob": "^3.3.3",
     "github-slugger": "^2.0.0",
@@ -67,14 +67,15 @@
     "fumadocs-ui": "15.2.12"
   },
   "devDependencies": {
-    "@scalar/api-client-react": "^1.2.26",
+    "@scalar/api-client-react": "^1.2.28",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "22.15.2",
+    "@types/node": "22.15.3",
     "@types/openapi-sampler": "^1.0.3",
     "@types/react": "^19.1.2",
+    "json-schema-typed": "^8.0.1",
     "next": "15.3.1",
     "openapi-types": "^12.1.3",
-    "tailwindcss": "^4.1.4",
+    "tailwindcss": "^4.1.5",
     "tsc-alias": "^1.8.15",
     "eslint-config-custom": "0.0.0",
     "tsconfig": "0.0.0"

package/dist/playground/resolve.d.ts

@@ -1,6 +0,0 @@
-import { type ReferenceSchema, type RequestSchema } from '../playground/index.js';
-/**
- * Resolve reference
- */
-export declare function resolve(schema: RequestSchema | ReferenceSchema | string, references: Record<string, RequestSchema>): RequestSchema;
-//# sourceMappingURL=resolve.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../../src/playground/resolve.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAE9E;;GAEG;AACH,wBAAgB,OAAO,CACrB,MAAM,EAAE,aAAa,GAAG,eAAe,GAAG,MAAM,EAChD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GACxC,aAAa,CASf"}

package/dist/playground/resolve.js

@@ -1,14 +0,0 @@
-/**
- * Resolve reference
- */
-export function resolve(schema, references) {
-    if (typeof schema === 'string')
-        return references[schema];
-    if (schema.type !== 'ref')
-        return schema;
-    return {
-        ...references[schema.schema],
-        description: schema.description,
-        isRequired: schema.isRequired,
-    };
-}