docusaurus-plugin-openapi-docs 0.0.0-beta.722 → 0.0.0-beta.727

package/lib/index.js

@@ -78,7 +78,7 @@ function pluginOpenAPIDocs(context, options) {
     let docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
     async function generateApiDocs(options, pluginId) {
         var _a, _b, _c, _d;
-        let { specPath, outputDir, template, markdownGenerators, downloadUrl, sidebarOptions, } = options;
+        let { specPath, outputDir, template, markdownGenerators, downloadUrl, sidebarOptions, disableCompression, } = options;
         // Remove trailing slash before proceeding
         outputDir = outputDir.replace(/\/$/, "");
         // Override docPath if pluginId provided
@@ -235,9 +235,11 @@ custom_edit_url: null
                     // const deserialize = (s: any) => {
                     //   return zlib.inflateSync(Buffer.from(s, "base64")).toString();
                     // };
-                    item.json = zlib_1.default
-                        .deflateSync(JSON.stringify(item.api))
-                        .toString("base64");
+                    disableCompression === true
+                        ? (item.json = JSON.stringify(item.api))
+                        : (item.json = zlib_1.default
+                            .deflateSync(JSON.stringify(item.api))
+                            .toString("base64"));
                     let infoBasePath = `${outputDir}/${item.infoId}`;
                     if (docRouteBasePath) {
                         infoBasePath = `${docRouteBasePath}/${outputDir
@@ -333,11 +335,7 @@ custom_edit_url: null
             cwd: path_1.default.resolve(apiDir),
             deep: 1,
         });
-        const schemaMdxFiles = await (0, utils_1.Globby)(["*.schema.mdx"], {
-            cwd: path_1.default.resolve(apiDir, "schemas"),
-            deep: 1,
-        });
-        const sidebarFile = await (0, utils_1.Globby)(["sidebar.js"], {
+        const sidebarFile = await (0, utils_1.Globby)(["sidebar.js", "sidebar.ts"], {
             cwd: path_1.default.resolve(apiDir),
             deep: 1,
         });
@@ -349,14 +347,15 @@ custom_edit_url: null
                 console.log(chalk_1.default.green(`Cleanup succeeded for "${apiDir}/${mdx}"`));
             }
         }));
-        schemaMdxFiles.map((mdx) => fs_1.default.unlink(`${apiDir}/schemas/${mdx}`, (err) => {
-            if (err) {
-                console.error(chalk_1.default.red(`Cleanup failed for "${apiDir}/schemas/${mdx}"`), chalk_1.default.yellow(err));
-            }
-            else {
-                console.log(chalk_1.default.green(`Cleanup succeeded for "${apiDir}/schemas/${mdx}"`));
+        try {
+            fs_1.default.rmSync(`${apiDir}/schemas`, { recursive: true });
+            console.log(chalk_1.default.green(`Cleanup succeeded for "${apiDir}/schemas"`));
+        }
+        catch (err) {
+            if (err.code !== "ENOENT") {
+                console.error(chalk_1.default.red(`Cleanup failed for "${apiDir}/schemas"`), chalk_1.default.yellow(err));
             }
-        }));
+        }
         sidebarFile.map((sidebar) => fs_1.default.unlink(`${apiDir}/${sidebar}`, (err) => {
             if (err) {
                 console.error(chalk_1.default.red(`Cleanup failed for "${apiDir}/${sidebar}"`), chalk_1.default.yellow(err));

package/lib/options.js

@@ -36,6 +36,7 @@ exports.OptionsSchema = utils_validation_1.Joi.object({
         sidebarOptions: sidebarOptions,
         markdownGenerators: markdownGenerators,
         showSchemas: utils_validation_1.Joi.boolean(),
+        disableCompression: utils_validation_1.Joi.boolean(),
         version: utils_validation_1.Joi.string().when("versions", {
             is: utils_validation_1.Joi.exist(),
             then: utils_validation_1.Joi.required(),

package/lib/types.d.ts

@@ -26,6 +26,7 @@ export interface APIOptions {
     proxy?: string;
     markdownGenerators?: MarkdownGenerator;
     showSchemas?: boolean;
+    disableCompression?: boolean;
 }
 export interface MarkdownGenerator {
     createApiPageMD?: (pageData: ApiPageMetadata) => string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-beta.722",
+  "version": "0.0.0-beta.727",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "cae8c487b81918ef2cab2c7338deaae407b4dc2b"
+  "gitHead": "3269c28557138d879701d00fe96c054c708155cc"
 }

package/src/index.ts

@@ -120,6 +120,7 @@ export default function pluginOpenAPIDocs(
       markdownGenerators,
       downloadUrl,
       sidebarOptions,
+      disableCompression,
     } = options;
 
     // Remove trailing slash before proceeding
@@ -325,9 +326,11 @@ custom_edit_url: null
           // const deserialize = (s: any) => {
           //   return zlib.inflateSync(Buffer.from(s, "base64")).toString();
           // };
-          item.json = zlib
-            .deflateSync(JSON.stringify(item.api))
-            .toString("base64");
+          disableCompression === true
+            ? (item.json = JSON.stringify(item.api))
+            : (item.json = zlib
+                .deflateSync(JSON.stringify(item.api))
+                .toString("base64"));
           let infoBasePath = `${outputDir}/${item.infoId}`;
           if (docRouteBasePath) {
             infoBasePath = `${docRouteBasePath}/${outputDir
@@ -476,11 +479,7 @@ custom_edit_url: null
       cwd: path.resolve(apiDir),
       deep: 1,
     });
-    const schemaMdxFiles = await Globby(["*.schema.mdx"], {
-      cwd: path.resolve(apiDir, "schemas"),
-      deep: 1,
-    });
-    const sidebarFile = await Globby(["sidebar.js"], {
+    const sidebarFile = await Globby(["sidebar.js", "sidebar.ts"], {
       cwd: path.resolve(apiDir),
       deep: 1,
     });
@@ -497,20 +496,17 @@ custom_edit_url: null
       })
     );
 
-    schemaMdxFiles.map((mdx) =>
-      fs.unlink(`${apiDir}/schemas/${mdx}`, (err) => {
-        if (err) {
-          console.error(
-            chalk.red(`Cleanup failed for "${apiDir}/schemas/${mdx}"`),
-            chalk.yellow(err)
-          );
-        } else {
-          console.log(
-            chalk.green(`Cleanup succeeded for "${apiDir}/schemas/${mdx}"`)
-          );
-        }
-      })
-    );
+    try {
+      fs.rmSync(`${apiDir}/schemas`, { recursive: true });
+      console.log(chalk.green(`Cleanup succeeded for "${apiDir}/schemas"`));
+    } catch (err: any) {
+      if (err.code !== "ENOENT") {
+        console.error(
+          chalk.red(`Cleanup failed for "${apiDir}/schemas"`),
+          chalk.yellow(err)
+        );
+      }
+    }
 
     sidebarFile.map((sidebar) =>
       fs.unlink(`${apiDir}/${sidebar}`, (err) => {

package/src/options.ts

@@ -39,6 +39,7 @@ export const OptionsSchema = Joi.object({
         sidebarOptions: sidebarOptions,
         markdownGenerators: markdownGenerators,
         showSchemas: Joi.boolean(),
+        disableCompression: Joi.boolean(),
         version: Joi.string().when("versions", {
           is: Joi.exist(),
           then: Joi.required(),

package/src/types.ts

@@ -47,6 +47,7 @@ export interface APIOptions {
   proxy?: string;
   markdownGenerators?: MarkdownGenerator;
   showSchemas?: boolean;
+  disableCompression?: boolean;
 }
 
 export interface MarkdownGenerator {