docusaurus-plugin-openapi-docs 0.0.0-beta.721 → 0.0.0-beta.724

package/lib/index.d.ts

@@ -1,7 +1,7 @@
 import type { LoadContext, Plugin } from "@docusaurus/types";
 import type { PluginOptions, LoadedContent } from "./types";
 export declare function isURL(str: string): boolean;
-export declare function getDocsPluginConfig(presetsPlugins: any[], pluginId: string): Object | undefined;
+export declare function getDocsPluginConfig(presetsPlugins: any[], plugin: string, pluginId: string): Object | undefined;
 declare function pluginOpenAPIDocs(context: LoadContext, options: PluginOptions): Plugin<LoadedContent>;
 declare namespace pluginOpenAPIDocs {
     var validateOptions: ({ options, validate }: any) => any;

package/lib/index.js

@@ -25,7 +25,7 @@ function isURL(str) {
     return /^(https?:)\/\//m.test(str);
 }
 exports.isURL = isURL;
-function getDocsPluginConfig(presetsPlugins, pluginId) {
+function getDocsPluginConfig(presetsPlugins, plugin, pluginId) {
     // eslint-disable-next-line array-callback-return
     const filteredConfig = presetsPlugins.filter((data) => {
         // Search presets
@@ -34,8 +34,7 @@ function getDocsPluginConfig(presetsPlugins, pluginId) {
                 return data[1];
             }
             // Search plugin-content-docs instances
-            if (typeof data[0] === "string" &&
-                data[0] === "@docusaurus/plugin-content-docs") {
+            if (typeof data[0] === "string" && data[0] === plugin) {
                 const configPluginId = data[1].id ? data[1].id : "default";
                 if (configPluginId === pluginId) {
                     return data[1];
@@ -49,7 +48,7 @@ function getDocsPluginConfig(presetsPlugins, pluginId) {
             return filteredConfig[1].docs;
         }
         // Search plugin-content-docs instances
-        if (filteredConfig[0] === "@docusaurus/plugin-content-docs") {
+        if (filteredConfig[0] === plugin) {
             const configPluginId = filteredConfig[1].id
                 ? filteredConfig[1].id
                 : "default";
@@ -68,13 +67,13 @@ function getPluginInstances(plugins) {
     return plugins.filter((data) => data[0] === "docusaurus-plugin-openapi-docs");
 }
 function pluginOpenAPIDocs(context, options) {
-    const { config, docsPluginId } = options;
+    const { config, docsPlugin = "@docusaurus/plugin-content-docs", docsPluginId, } = options;
     const { siteDir, siteConfig } = context;
     // Get routeBasePath and path from plugin-content-docs or preset
     const presets = siteConfig.presets;
     const plugins = siteConfig.plugins;
     const presetsPlugins = presets.concat(plugins);
-    let docData = getDocsPluginConfig(presetsPlugins, docsPluginId);
+    let docData = getDocsPluginConfig(presetsPlugins, docsPlugin, docsPluginId);
     let docRouteBasePath = docData ? docData.routeBasePath : undefined;
     let docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
     async function generateApiDocs(options, pluginId) {
@@ -84,7 +83,7 @@ function pluginOpenAPIDocs(context, options) {
         outputDir = outputDir.replace(/\/$/, "");
         // Override docPath if pluginId provided
         if (pluginId) {
-            docData = getDocsPluginConfig(presetsPlugins, pluginId);
+            docData = getDocsPluginConfig(presetsPlugins, docsPlugin, pluginId);
             docRouteBasePath = docData ? docData.routeBasePath : undefined;
             docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
         }
@@ -334,11 +333,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,
         });
@@ -350,14 +345,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

@@ -22,6 +22,7 @@ const markdownGenerators = utils_validation_1.Joi.object({
 });
 exports.OptionsSchema = utils_validation_1.Joi.object({
     id: utils_validation_1.Joi.string().required(),
+    docsPlugin: utils_validation_1.Joi.string(),
     docsPluginId: utils_validation_1.Joi.string().required(),
     config: utils_validation_1.Joi.object()
         .pattern(/^/, utils_validation_1.Joi.object({

package/lib/types.d.ts

@@ -3,6 +3,7 @@ import { InfoObject, OperationObject, SchemaObject, SecuritySchemeObject, TagObj
 export type { PropSidebarItemCategory, SidebarItemLink, PropSidebar, PropSidebarItem, } from "@docusaurus/plugin-content-docs-types";
 export interface PluginOptions {
     id?: string;
+    docsPlugin?: string;
     docsPluginId: string;
     config: {
         [key: string]: APIOptions;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-beta.721",
+  "version": "0.0.0-beta.724",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "ea83d443a8a5427c7dc1f8acd2f6703f2af695f2"
+  "gitHead": "76903beba80972a5bcd88c74a33dc5e4bbbaa631"
 }

package/src/index.ts

@@ -41,6 +41,7 @@ export function isURL(str: string): boolean {
 
 export function getDocsPluginConfig(
   presetsPlugins: any[],
+  plugin: string,
   pluginId: string
 ): Object | undefined {
   // eslint-disable-next-line array-callback-return
@@ -52,10 +53,7 @@ export function getDocsPluginConfig(
       }
 
       // Search plugin-content-docs instances
-      if (
-        typeof data[0] === "string" &&
-        data[0] === "@docusaurus/plugin-content-docs"
-      ) {
+      if (typeof data[0] === "string" && data[0] === plugin) {
         const configPluginId = data[1].id ? data[1].id : "default";
         if (configPluginId === pluginId) {
           return data[1];
@@ -71,7 +69,7 @@ export function getDocsPluginConfig(
     }
 
     // Search plugin-content-docs instances
-    if (filteredConfig[0] === "@docusaurus/plugin-content-docs") {
+    if (filteredConfig[0] === plugin) {
       const configPluginId = filteredConfig[1].id
         ? filteredConfig[1].id
         : "default";
@@ -95,14 +93,22 @@ export default function pluginOpenAPIDocs(
   context: LoadContext,
   options: PluginOptions
 ): Plugin<LoadedContent> {
-  const { config, docsPluginId } = options;
+  const {
+    config,
+    docsPlugin = "@docusaurus/plugin-content-docs",
+    docsPluginId,
+  } = options;
   const { siteDir, siteConfig } = context;
 
   // Get routeBasePath and path from plugin-content-docs or preset
   const presets: any = siteConfig.presets;
   const plugins: any = siteConfig.plugins;
   const presetsPlugins = presets.concat(plugins);
-  let docData: any = getDocsPluginConfig(presetsPlugins, docsPluginId);
+  let docData: any = getDocsPluginConfig(
+    presetsPlugins,
+    docsPlugin,
+    docsPluginId
+  );
   let docRouteBasePath = docData ? docData.routeBasePath : undefined;
   let docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
 
@@ -121,7 +127,7 @@ export default function pluginOpenAPIDocs(
 
     // Override docPath if pluginId provided
     if (pluginId) {
-      docData = getDocsPluginConfig(presetsPlugins, pluginId);
+      docData = getDocsPluginConfig(presetsPlugins, docsPlugin, pluginId);
       docRouteBasePath = docData ? docData.routeBasePath : undefined;
       docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
     }
@@ -470,11 +476,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,
     });
@@ -491,20 +493,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

@@ -23,6 +23,7 @@ const markdownGenerators = Joi.object({
 
 export const OptionsSchema = Joi.object({
   id: Joi.string().required(),
+  docsPlugin: Joi.string(),
   docsPluginId: Joi.string().required(),
   config: Joi.object()
     .pattern(

package/src/types.ts

@@ -23,6 +23,7 @@ export type {
 } from "@docusaurus/plugin-content-docs-types";
 export interface PluginOptions {
   id?: string;
+  docsPlugin?: string;
   docsPluginId: string;
   config: {
     [key: string]: APIOptions;