fumadocs-openapi 9.0.16 → 9.0.17

package/dist/generate-file.d.ts

@@ -67,6 +67,12 @@ interface BaseConfig extends GenerateOptions {
      * Output directory
      */
     output: string;
+    /**
+     * Custom function to convert names into file names.
+     *
+     * By default, it only escapes whitespaces and upper case (English) characters
+     */
+    slugify?: (name: string) => string;
 }
 export declare function generateFiles(options: Config): Promise<void>;
 export {};

package/dist/generate-file.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate-file.d.ts","sourceRoot":"","sources":["../src/generate-file.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,kBAAkB,EAEvB,KAAK,iBAAiB,EAEvB,MAAM,YAAY,CAAC;AACpB,OAAO,EAGL,KAAK,iBAAiB,EACvB,MAAM,0BAA0B,CAAC;AAElC,UAAU,kBAAkB;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,eAAgB,SAAQ,UAAU;IAC1C;;OAEG;IACH,GAAG,CAAC,EAAE,WAAW,CAAC;IAElB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EACD,CAAC,CACC,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,iBAAiB,CAAC,UAAU,CAAC,KACpC,MAAM,CAAC,GACZ,QAAQ,CAAC;CACd;AAED,UAAU,SAAU,SAAQ,UAAU;IACpC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EACD,CAAC,CACC,MAAM,EAAE,iBAAiB,EACzB,QAAQ,EAAE,iBAAiB,CAAC,UAAU,CAAC,KACpC,MAAM,CAAC,GACZ,QAAQ,CAAC;CACd;AAED,UAAU,UAAW,SAAQ,UAAU;IACrC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,CAAC,EACD,CAAC,CACC,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,iBAAiB,CAAC,UAAU,CAAC,KACpC,MAAM,CAAC,GACZ,QAAQ,CAAC;CACd;AAED,MAAM,MAAM,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,eAAe,CAAC;AAE9D,UAAU,QAAQ;IAChB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;CACzB;AAED,UAAU,UAAW,SAAQ,eAAe;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA6BlE"}
+{"version":3,"file":"generate-file.d.ts","sourceRoot":"","sources":["../src/generate-file.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,kBAAkB,EAEvB,KAAK,iBAAiB,EAEvB,MAAM,YAAY,CAAC;AACpB,OAAO,EAGL,KAAK,iBAAiB,EACvB,MAAM,0BAA0B,CAAC;AAElC,UAAU,kBAAkB;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,eAAgB,SAAQ,UAAU;IAC1C;;OAEG;IACH,GAAG,CAAC,EAAE,WAAW,CAAC;IAElB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EACD,CAAC,CACC,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,iBAAiB,CAAC,UAAU,CAAC,KACpC,MAAM,CAAC,GACZ,QAAQ,CAAC;CACd;AAED,UAAU,SAAU,SAAQ,UAAU;IACpC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EACD,CAAC,CACC,MAAM,EAAE,iBAAiB,EACzB,QAAQ,EAAE,iBAAiB,CAAC,UAAU,CAAC,KACpC,MAAM,CAAC,GACZ,QAAQ,CAAC;CACd;AAED,UAAU,UAAW,SAAQ,UAAU;IACrC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,CAAC,EACD,CAAC,CACC,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,iBAAiB,CAAC,UAAU,CAAC,KACpC,MAAM,CAAC,GACZ,QAAQ,CAAC;CACd;AAED,MAAM,MAAM,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,eAAe,CAAC;AAE9D,UAAU,QAAQ;IAChB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;CACzB;AAED,UAAU,UAAW,SAAQ,eAAe;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CACpC;AAED,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA6BlE"}

package/dist/generate-file.js

@@ -26,14 +26,14 @@ export async function generateFiles(options) {
     await Promise.all(resolvedInputs.map((input) => generateFromDocument(input, options)));
 }
 async function generateFromDocument(pathOrUrl, options) {
-    const { output, cwd = process.cwd() } = options;
+    const { output, cwd = process.cwd(), slugify = defaultSlugify } = options;
     let nameFn;
     if (!options.name || typeof options.name !== 'function') {
         const { algorithm = 'v2' } = options.name ?? {};
         nameFn = (output, document) => {
             if (options.per === 'tag') {
                 const result = output;
-                return getFilename(result.tag);
+                return slugify(result.tag);
             }
             if (options.per === 'file') {
                 return isUrl(pathOrUrl)
@@ -52,7 +52,7 @@ async function generateFromDocument(pathOrUrl, options) {
             if (algorithm === 'v2' && hook.operationId) {
                 return hook.operationId;
             }
-            return getFilename(result.item.name);
+            return slugify(result.item.name);
         };
     }
     else {
@@ -81,7 +81,7 @@ async function generateFromDocument(pathOrUrl, options) {
                 console.warn('When `groupBy` is set to `tag`, make sure a `tags` is defined for every operation schema.');
                 tags = ['unknown'];
             }
-            return tags.map((tag) => path.join(getFilename(tag), `${file}.mdx`));
+            return tags.map((tag) => path.join(slugify(tag), `${file}.mdx`));
         }
         return [`${file}.mdx`];
     }
@@ -142,7 +142,7 @@ function getOutputPathFromRoute(path) {
     })
         .join('/') ?? '');
 }
-function getFilename(s) {
+function defaultSlugify(s) {
     return s.replace(/\s+/g, '-').toLowerCase();
 }
 async function dereference(pathOrDocument, options) {

package/dist/render/schema.js

@@ -45,7 +45,7 @@ export function Schema({ name, schema, required = false, readOnly = false, write
     }
     function propertyInfo(schema) {
         const fields = [];
-        if (schema.default) {
+        if (schema.default !== undefined) {
             fields.push({
                 key: 'Default',
                 value: JSON.stringify(schema.default),
@@ -195,17 +195,17 @@ function isComplexType(schema) {
 }
 function getRange(value, min, exclusiveMin, max, exclusiveMax) {
     const out = [];
-    if (min) {
+    if (min !== undefined) {
         out.push(`${min} <=`);
     }
-    else if (exclusiveMin) {
+    else if (exclusiveMin !== undefined) {
         out.push(`${exclusiveMin} <`);
     }
     out.push(value);
-    if (max) {
+    if (max !== undefined) {
         out.push(`<= ${max}`);
     }
-    else if (exclusiveMax) {
+    else if (exclusiveMax !== undefined) {
         out.push(`< ${exclusiveMax}`);
     }
     if (out.length > 1)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "9.0.16",
+  "version": "9.0.17",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",
@@ -78,8 +78,8 @@
     "openapi-types": "^12.1.3",
     "tailwindcss": "^4.1.11",
     "tsc-alias": "^1.8.16",
-    "eslint-config-custom": "0.0.0",
-    "tsconfig": "0.0.0"
+    "tsconfig": "0.0.0",
+    "eslint-config-custom": "0.0.0"
   },
   "peerDependencies": {
     "@scalar/api-client-react": "*",