docusaurus-plugin-openapi-docs 0.0.0-714 → 0.0.0-716

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

@@ -24,7 +24,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
@@ -33,8 +33,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];
@@ -48,7 +47,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";
@@ -67,13 +66,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) {
@@ -83,7 +82,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;
         }

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-714",
+  "version": "0.0.0-716",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "d007916b573cab1c60fc8eb644f8fe0bd30cb6a1"
+  "gitHead": "6dffc46fae6136e559fa23a941f3df596614ded3"
 }

package/src/index.ts

@@ -40,6 +40,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
@@ -51,10 +52,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];
@@ -70,7 +68,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";
@@ -94,14 +92,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;
 
@@ -120,7 +126,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;
     }

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;