docusaurus-plugin-openapi-docs 1.1.8 → 1.1.11

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 getDocsData(dataArray: any[], filter: string): Object | undefined;
+export declare function getDocsPluginConfig(presetsPlugins: any[], 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

@@ -9,7 +9,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDocsData = exports.isURL = void 0;
+exports.getDocsPluginConfig = exports.isURL = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
@@ -23,36 +23,44 @@ function isURL(str) {
     return /^(https?:)\/\//m.test(str);
 }
 exports.isURL = isURL;
-function getDocsData(dataArray, filter) {
+function getDocsPluginConfig(presetsPlugins, pluginId) {
     // eslint-disable-next-line array-callback-return
-    const filteredData = dataArray.filter((data) => {
-        if (data[0] === filter) {
+    const filteredConfig = presetsPlugins.filter((data) => {
+        if (data[0] === pluginId) {
             return data[1];
         }
         // Search plugin-content-docs instances
         if (data[0] === "@docusaurus/plugin-content-docs") {
-            const pluginId = data[1].id ? data[1].id : "default";
-            if (pluginId === filter) {
+            const configPluginId = data[1].id ? data[1].id : "default";
+            if (configPluginId === pluginId) {
                 return data[1];
             }
         }
     })[0];
-    if (filteredData) {
+    if (filteredConfig) {
         // Search presets, e.g. "classic"
-        if (filteredData[0] === filter) {
-            return filteredData[1].docs;
+        if (filteredConfig[0] === pluginId) {
+            return filteredConfig[1].docs;
         }
         // Search plugin-content-docs instances
-        if (filteredData[0] === "@docusaurus/plugin-content-docs") {
-            const pluginId = filteredData[1].id ? filteredData[1].id : "default";
-            if (pluginId === filter) {
-                return filteredData[1];
+        if (filteredConfig[0] === "@docusaurus/plugin-content-docs") {
+            const configPluginId = filteredConfig[1].id
+                ? filteredConfig[1].id
+                : "default";
+            if (configPluginId === pluginId) {
+                return filteredConfig[1];
             }
         }
     }
     return;
 }
-exports.getDocsData = getDocsData;
+exports.getDocsPluginConfig = getDocsPluginConfig;
+function getPluginConfig(plugins, pluginId) {
+    return plugins.filter((data) => data[1].id === pluginId)[0][1];
+}
+function getPluginInstances(plugins) {
+    return plugins.filter((data) => data[0] === "docusaurus-plugin-openapi-docs");
+}
 function pluginOpenAPIDocs(context, options) {
     const { config, docsPluginId } = options;
     const { siteDir, siteConfig } = context;
@@ -60,7 +68,7 @@ function pluginOpenAPIDocs(context, options) {
     const presets = siteConfig.presets;
     const plugins = siteConfig.plugins;
     const presetsPlugins = presets.concat(plugins);
-    const docData = getDocsData(presetsPlugins, docsPluginId);
+    const docData = getDocsPluginConfig(presetsPlugins, docsPluginId);
     const docRouteBasePath = docData ? docData.routeBasePath : undefined;
     const docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
     async function generateApiDocs(options) {
@@ -83,9 +91,7 @@ function pluginOpenAPIDocs(context, options) {
             // TODO: figure out better way to set default
             if (Object.keys(sidebarOptions !== null && sidebarOptions !== void 0 ? sidebarOptions : {}).length > 0) {
                 const sidebarSlice = (0, sidebars_1.default)(sidebarOptions, options, loadedApi, tags, docPath);
-                const sidebarSliceTemplate = template
-                    ? fs_1.default.readFileSync(template).toString()
-                    : `module.exports = {{{slice}}};`;
+                const sidebarSliceTemplate = `module.exports = {{{slice}}};`;
                 const view = (0, mustache_1.render)(sidebarSliceTemplate, {
                     slice: JSON.stringify(sidebarSlice),
                 });
@@ -129,12 +135,11 @@ info_path: {{{infoPath}}}
 
 {{{markdown}}}
       `;
-            const infoMdTemplate = template
-                ? fs_1.default.readFileSync(template).toString()
-                : `---
+            const infoMdTemplate = `---
 id: {{{id}}}
 sidebar_label: {{{title}}}
 hide_title: true
+custom_edit_url: null
 ---
 
 {{{markdown}}}
@@ -146,12 +151,11 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
 <DocCardList items={useCurrentSidebarCategory().items}/>
 \`\`\`
       `;
-            const tagMdTemplate = template
-                ? fs_1.default.readFileSync(template).toString()
-                : `---
+            const tagMdTemplate = `---
 id: {{{id}}}
 title: {{{description}}}
 description: {{{description}}}
+custom_edit_url: null
 ---
 
 {{{markdown}}}
@@ -296,22 +300,45 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                 .description(`Generates OpenAPI docs in MDX file format and sidebar.js (if enabled).`)
                 .usage("<id>")
                 .arguments("<id>")
-                .action(async (id) => {
+                .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+                .action(async (id, instance) => {
+                var _a;
+                const options = instance.opts();
+                const pluginId = options.pluginId;
+                const pluginInstances = getPluginInstances(plugins);
+                let targetConfig;
+                if (pluginId) {
+                    try {
+                        const pluginConfig = getPluginConfig(plugins, pluginId);
+                        targetConfig = (_a = pluginConfig.config) !== null && _a !== void 0 ? _a : {};
+                    }
+                    catch {
+                        console.error(chalk_1.default.red(`OpenAPI docs plugin ID '${pluginId}' not found.`));
+                        return;
+                    }
+                }
+                else {
+                    if (pluginInstances.length > 1) {
+                        console.error(chalk_1.default.red("OpenAPI docs plugin ID must be specified when more than one plugin instance exists."));
+                        return;
+                    }
+                    targetConfig = config;
+                }
                 if (id === "all") {
-                    if (config[id]) {
+                    if (targetConfig[id]) {
                         console.error(chalk_1.default.red("Can't use id 'all' for OpenAPI docs configuration key."));
                     }
                     else {
-                        Object.keys(config).forEach(async function (key) {
-                            await generateApiDocs(config[key]);
+                        Object.keys(targetConfig).forEach(async function (key) {
+                            await generateApiDocs(targetConfig[key]);
                         });
                     }
                 }
-                else if (!config[id]) {
+                else if (!targetConfig[id]) {
                     console.error(chalk_1.default.red(`ID '${id}' does not exist in OpenAPI docs config.`));
                 }
                 else {
-                    await generateApiDocs(config[id]);
+                    await generateApiDocs(targetConfig[id]);
                 }
             });
             cli
@@ -319,15 +346,38 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                 .description(`Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.js (if enabled).`)
                 .usage("<id:version>")
                 .arguments("<id:version>")
-                .action(async (id) => {
+                .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+                .action(async (id, instance) => {
+                var _a;
+                const options = instance.opts();
+                const pluginId = options.pluginId;
+                const pluginInstances = getPluginInstances(plugins);
+                let targetConfig;
+                if (pluginId) {
+                    try {
+                        const pluginConfig = getPluginConfig(plugins, pluginId);
+                        targetConfig = (_a = pluginConfig.config) !== null && _a !== void 0 ? _a : {};
+                    }
+                    catch {
+                        console.error(chalk_1.default.red(`OpenAPI docs plugin ID '${pluginId}' not found.`));
+                        return;
+                    }
+                }
+                else {
+                    if (pluginInstances.length > 1) {
+                        console.error(chalk_1.default.red("OpenAPI docs plugin ID must be specified when more than one plugin instance exists."));
+                        return;
+                    }
+                    targetConfig = config;
+                }
                 const [parentId, versionId] = id.split(":");
-                const parentConfig = Object.assign({}, config[parentId]);
+                const parentConfig = Object.assign({}, targetConfig[parentId]);
                 const version = parentConfig.version;
                 const label = parentConfig.label;
                 const baseUrl = parentConfig.baseUrl;
                 let parentVersion = {};
                 parentVersion[version] = { label: label, baseUrl: baseUrl };
-                const { versions } = config[parentId];
+                const { versions } = targetConfig[parentId];
                 const mergedVersions = Object.assign(parentVersion, versions);
                 // Prepare for merge
                 delete parentConfig.versions;
@@ -369,19 +419,42 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                 .description(`Clears the generated OpenAPI docs MDX files and sidebar.js (if enabled).`)
                 .usage("<id>")
                 .arguments("<id>")
-                .action(async (id) => {
+                .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+                .action(async (id, instance) => {
+                var _a;
+                const options = instance.opts();
+                const pluginId = options.pluginId;
+                const pluginInstances = getPluginInstances(plugins);
+                let targetConfig;
+                if (pluginId) {
+                    try {
+                        const pluginConfig = getPluginConfig(plugins, pluginId);
+                        targetConfig = (_a = pluginConfig.config) !== null && _a !== void 0 ? _a : {};
+                    }
+                    catch {
+                        console.error(chalk_1.default.red(`OpenAPI docs plugin ID '${pluginId}' not found.`));
+                        return;
+                    }
+                }
+                else {
+                    if (pluginInstances.length > 1) {
+                        console.error(chalk_1.default.red("OpenAPI docs plugin ID must be specified when more than one plugin instance exists."));
+                        return;
+                    }
+                    targetConfig = config;
+                }
                 if (id === "all") {
-                    if (config[id]) {
+                    if (targetConfig[id]) {
                         console.error(chalk_1.default.red("Can't use id 'all' for OpenAPI docs configuration key."));
                     }
                     else {
-                        Object.keys(config).forEach(async function (key) {
-                            await cleanApiDocs(config[key]);
+                        Object.keys(targetConfig).forEach(async function (key) {
+                            await cleanApiDocs(targetConfig[key]);
                         });
                     }
                 }
                 else {
-                    await cleanApiDocs(config[id]);
+                    await cleanApiDocs(targetConfig[id]);
                 }
             });
             cli
@@ -389,10 +462,33 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                 .description(`Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.js (if enabled).`)
                 .usage("<id:version>")
                 .arguments("<id:version>")
-                .action(async (id) => {
+                .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+                .action(async (id, instance) => {
+                var _a;
+                const options = instance.opts();
+                const pluginId = options.pluginId;
+                const pluginInstances = getPluginInstances(plugins);
+                let targetConfig;
+                if (pluginId) {
+                    try {
+                        const pluginConfig = getPluginConfig(plugins, pluginId);
+                        targetConfig = (_a = pluginConfig.config) !== null && _a !== void 0 ? _a : {};
+                    }
+                    catch {
+                        console.error(chalk_1.default.red(`OpenAPI docs plugin ID '${pluginId}' not found.`));
+                        return;
+                    }
+                }
+                else {
+                    if (pluginInstances.length > 1) {
+                        console.error(chalk_1.default.red("OpenAPI docs plugin ID must be specified when more than one plugin instance exists."));
+                        return;
+                    }
+                    targetConfig = config;
+                }
                 const [parentId, versionId] = id.split(":");
-                const { versions } = config[parentId];
-                const parentConfig = Object.assign({}, config[parentId]);
+                const { versions } = targetConfig[parentId];
+                const parentConfig = Object.assign({}, targetConfig[parentId]);
                 delete parentConfig.versions;
                 if (versionId === "all") {
                     if (versions[id]) {

package/lib/markdown/createRequestSchema.js

@@ -25,6 +25,7 @@ function mergeAllOf(allOf) {
             example: function () {
                 return true;
             },
+            ignoreAdditionalProperties: true,
         },
     });
     const required = allOf.reduce((acc, cur) => {
@@ -235,90 +236,100 @@ function createItems(schema) {
 /**
  * For handling discriminators that do not map to a same-level property
  */
-function createDiscriminator(schema) {
-    var _a;
-    const discriminator = schema.discriminator;
-    const propertyName = discriminator === null || discriminator === void 0 ? void 0 : discriminator.propertyName;
-    const propertyType = "string"; // should always be string
-    const mapping = discriminator === null || discriminator === void 0 ? void 0 : discriminator.mapping;
-    // Explicit mapping is required since we can't support implicit
-    if (mapping === undefined) {
-        return undefined;
-    }
-    // Attempt to get the property description we want to display
-    // TODO: how to make it predictable when handling allOf
-    let propertyDescription;
-    const firstMappingSchema = mapping[Object.keys(mapping)[0]];
-    if (firstMappingSchema.properties !== undefined) {
-        propertyDescription =
-            firstMappingSchema.properties[propertyName].description;
-    }
-    if (firstMappingSchema.allOf !== undefined) {
-        const { mergedSchemas } = mergeAllOf(firstMappingSchema.allOf);
-        if (mergedSchemas.properties !== undefined) {
-            propertyDescription =
-                (_a = mergedSchemas.properties[propertyName]) === null || _a === void 0 ? void 0 : _a.description;
-        }
-    }
-    if (propertyDescription === undefined) {
-        if (schema.properties !== undefined &&
-            schema.properties[propertyName] !== undefined) {
-            propertyDescription = schema.properties[propertyName].description;
-        }
-    }
-    return (0, utils_1.create)("div", {
-        className: "discriminatorItem",
-        children: (0, utils_1.create)("div", {
-            children: [
-                (0, utils_1.create)("strong", {
-                    style: { paddingLeft: "1rem" },
-                    children: propertyName,
-                }),
-                (0, utils_1.guard)(propertyType, (name) => (0, utils_1.create)("span", {
-                    style: { opacity: "0.6" },
-                    children: ` ${propertyType}`,
-                })),
-                (0, utils_1.guard)((0, schema_1.getQualifierMessage)(schema.discriminator), (message) => (0, utils_1.create)("div", {
-                    style: {
-                        paddingLeft: "1rem",
-                    },
-                    children: (0, createDescription_1.createDescription)(message),
-                })),
-                (0, utils_1.guard)(propertyDescription, (description) => (0, utils_1.create)("div", {
-                    style: {
-                        paddingLeft: "1rem",
-                    },
-                    children: (0, createDescription_1.createDescription)(description),
-                })),
-                (0, utils_1.create)("DiscriminatorTabs", {
-                    children: Object.keys(mapping).map((key, index) => {
-                        if (mapping[key].allOf !== undefined) {
-                            const { mergedSchemas } = mergeAllOf(mapping[key].allOf);
-                            // Cleanup duplicate property from mapping schema
-                            delete mergedSchemas.properties[propertyName];
-                            mapping[key] = mergedSchemas;
-                        }
-                        if (mapping[key].properties !== undefined) {
-                            // Cleanup duplicate property from mapping schema
-                            delete mapping[key].properties[propertyName];
-                        }
-                        const label = key;
-                        return (0, utils_1.create)("TabItem", {
-                            label: label,
-                            value: `${index}-item-discriminator`,
-                            children: [
-                                (0, utils_1.create)("div", {
-                                    style: { marginLeft: "-4px" },
-                                    children: createNodes(mapping[key]),
-                                }),
-                            ],
-                        });
-                    }),
-                }),
-            ],
-        }),
-    });
-}
+// function createDiscriminator(schema: SchemaObject) {
+//   const discriminator = schema.discriminator;
+//   const propertyName = discriminator?.propertyName;
+//   const propertyType = "string"; // should always be string
+//   const mapping: any = discriminator?.mapping;
+//   // Explicit mapping is required since we can't support implicit
+//   if (mapping === undefined) {
+//     return undefined;
+//   }
+//   // Attempt to get the property description we want to display
+//   // TODO: how to make it predictable when handling allOf
+//   let propertyDescription;
+//   const firstMappingSchema = mapping[Object.keys(mapping)[0]];
+//   if (firstMappingSchema.properties !== undefined) {
+//     propertyDescription =
+//       firstMappingSchema.properties![propertyName!].description;
+//   }
+//   if (firstMappingSchema.allOf !== undefined) {
+//     const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
+//       firstMappingSchema.allOf
+//     );
+//     if (mergedSchemas.properties !== undefined) {
+//       propertyDescription =
+//         mergedSchemas.properties[propertyName!]?.description;
+//     }
+//   }
+//   if (propertyDescription === undefined) {
+//     if (
+//       schema.properties !== undefined &&
+//       schema.properties![propertyName!] !== undefined
+//     ) {
+//       propertyDescription = schema.properties![propertyName!].description;
+//     }
+//   }
+//   return create("div", {
+//     className: "discriminatorItem",
+//     children: create("div", {
+//       children: [
+//         create("strong", {
+//           style: { paddingLeft: "1rem" },
+//           children: propertyName,
+//         }),
+//         guard(propertyType, (name) =>
+//           create("span", {
+//             style: { opacity: "0.6" },
+//             children: ` ${propertyType}`,
+//           })
+//         ),
+//         guard(getQualifierMessage(schema.discriminator as any), (message) =>
+//           create("div", {
+//             style: {
+//               paddingLeft: "1rem",
+//             },
+//             children: createDescription(message),
+//           })
+//         ),
+//         guard(propertyDescription, (description) =>
+//           create("div", {
+//             style: {
+//               paddingLeft: "1rem",
+//             },
+//             children: createDescription(description),
+//           })
+//         ),
+//         create("DiscriminatorTabs", {
+//           children: Object.keys(mapping!).map((key, index) => {
+//             if (mapping[key].allOf !== undefined) {
+//               const { mergedSchemas }: { mergedSchemas: SchemaObject } =
+//                 mergeAllOf(mapping[key].allOf);
+//               // Cleanup duplicate property from mapping schema
+//               delete mergedSchemas.properties![propertyName!];
+//               mapping[key] = mergedSchemas;
+//             }
+//             if (mapping[key].properties !== undefined) {
+//               // Cleanup duplicate property from mapping schema
+//               delete mapping[key].properties![propertyName!];
+//             }
+//             const label = key;
+//             return create("TabItem", {
+//               label: label,
+//               value: `${index}-item-discriminator`,
+//               children: [
+//                 create("div", {
+//                   style: { marginLeft: "-4px" },
+//                   children: createNodes(mapping[key]),
+//                 }),
+//               ],
+//             });
+//           }),
+//         }),
+//       ],
+//     }),
+//   });
+// }
 function createDetailsNode(name, schemaName, schema, required) {
     return (0, utils_1.create)("SchemaItem", {
         collapsible: true,
@@ -333,7 +344,9 @@ function createDetailsNode(name, schemaName, schema, required) {
                                 style: { opacity: "0.6" },
                                 children: ` ${schemaName}`,
                             }),
-                            (0, utils_1.guard)(schema.required && schema.required === true, () => [
+                            (0, utils_1.guard)(Array.isArray(required)
+                                ? required.includes(name)
+                                : required === true, () => [
                                 (0, utils_1.create)("strong", {
                                     style: {
                                         fontSize: "var(--ifm-code-font-size)",
@@ -493,9 +506,9 @@ function createEdges({ name, schema, required, discriminator, }) {
  * Creates a hierarchical level of a schema tree. Nodes produce edges that can branch into sub-nodes with edges, recursively.
  */
 function createNodes(schema) {
-    if (schema.discriminator !== undefined) {
-        return createDiscriminator(schema);
-    }
+    // if (schema.discriminator !== undefined) {
+    //   return createDiscriminator(schema);
+    // }
     if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
         return createAnyOneOf(schema);
     }

package/lib/markdown/createResponseSchema.d.ts

@@ -1,4 +1,11 @@
-import { MediaTypeObject } from "../openapi/types";
+import { MediaTypeObject, SchemaObject } from "../openapi/types";
+/**
+ * Returns a merged representation of allOf array of schemas.
+ */
+export declare function mergeAllOf(allOf: SchemaObject[]): {
+    mergedSchemas: any;
+    required: any;
+};
 interface Props {
     style?: any;
     title: string;