docusaurus-plugin-openapi-docs 1.0.2 → 1.0.3

package/README.md

@@ -80,7 +80,7 @@ Here is an example of properly configuring your `docusaurus.config.js` file for
             specPath: "examples/petstore.yaml", // Path to designated spec file
             outputDir: "api/petstore", // Output directory for generated .mdx docs
             sidebarOptions: {
-              groupPathsBy: "tags",
+              groupPathsBy: "tag",
             },
           },
           burgers: {
@@ -112,7 +112,7 @@ Here is an example of properly configuring your `docusaurus.config.js` file for
 
 | Name                 | Type      | Default | Description                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 | -------------------- | --------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `groupPathsBy`       | `string`  | `null`  | Organize and group sidebar slice by specified option. Note: Currently, `groupPathsBy` only contains support for grouping by "tags".                                                                                                                                                                                                                                                                                                                  |
+| `groupPathsBy`       | `string`  | `null`  | Organize and group sidebar slice by specified option. Note: Currently, `groupPathsBy` only contains support for grouping by `tag`.                                                                                                                                                                                                                                                                                                                   |
 | `categoryLinkSource` | `string`  | `null`  | Defines what source to use for rendering category link pages when grouping paths by tag. <br/></br>The supported options are as follows: <br/></br> `tag`: Sets the category link config type to `generated-index` and uses the tag description as the link config description. <br/><br/>`info`: Sets the category link config type to `doc` and renders the `info` section as the category link (recommended only for multi/micro-spec scenarios). |
 | `sidebarCollapsible` | `boolean` | `true`  | Whether sidebar categories are collapsible by default.                                                                                                                                                                                                                                                                                                                                                                                               |
 | `sidebarCollapsed`   | `boolean` | `true`  | Whether sidebar categories are collapsed by default.                                                                                                                                                                                                                                                                                                                                                                                                 |

package/lib/index.d.ts

@@ -1,3 +1,4 @@
 import type { LoadContext, Plugin } from "@docusaurus/types";
 import type { PluginOptions, LoadedContent } from "./types";
+export declare function isURL(str: string): boolean;
 export default function pluginOpenAPI(context: LoadContext, options: PluginOptions): Plugin<LoadedContent>;

package/lib/index.js

@@ -9,6 +9,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isURL = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
@@ -17,15 +18,21 @@ const mustache_1 = require("mustache");
 const markdown_1 = require("./markdown");
 const openapi_1 = require("./openapi");
 const sidebars_1 = __importDefault(require("./sidebars"));
+function isURL(str) {
+    return /^(https?:)\/\//m.test(str);
+}
+exports.isURL = isURL;
 function pluginOpenAPI(context, options) {
     let { config } = options;
     let { siteDir } = context;
     async function generateApiDocs(options) {
         let { specPath, outputDir, template, sidebarOptions } = options;
-        const contentPath = path_1.default.resolve(siteDir, specPath);
+        const contentPath = isURL(specPath)
+            ? specPath
+            : path_1.default.resolve(siteDir, specPath);
         try {
             const openapiFiles = await (0, openapi_1.readOpenapiFiles)(contentPath, {});
-            const [loadedApi, tags] = await (0, openapi_1.processOpenapiFiles)(openapiFiles);
+            const [loadedApi, tags] = await (0, openapi_1.processOpenapiFiles)(openapiFiles, sidebarOptions);
             if (!fs_1.default.existsSync(outputDir)) {
                 try {
                     fs_1.default.mkdirSync(outputDir, { recursive: true });
@@ -78,6 +85,9 @@ api: {{{json}}}
 {{#api.method}}
 sidebar_class_name: "{{{api.method}}} api-method"
 {{/api.method}}
+{{#infoPath}}
+info_path: {{{infoPath}}}
+{{/infoPath}}
 ---
 
 {{{markdown}}}
@@ -96,17 +106,42 @@ hide_title: true
 import DocCardList from '@theme/DocCardList';
 import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
 
+<DocCardList items={useCurrentSidebarCategory().items}/>
+\`\`\`
+      `;
+            const tagMdTemplate = template
+                ? fs_1.default.readFileSync(template).toString()
+                : `---
+id: {{{id}}}
+title: {{{description}}}
+description: {{{description}}}
+---
+
+{{{markdown}}}
+
+\`\`\`mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
 <DocCardList items={useCurrentSidebarCategory().items}/>
 \`\`\`
       `;
             loadedApi.map(async (item) => {
-                const markdown = item.type === "api" ? (0, markdown_1.createApiPageMD)(item) : (0, markdown_1.createInfoPageMD)(item);
+                const markdown = item.type === "api"
+                    ? (0, markdown_1.createApiPageMD)(item)
+                    : item.type === "info"
+                        ? (0, markdown_1.createInfoPageMD)(item)
+                        : (0, markdown_1.createTagPageMD)(item);
                 item.markdown = markdown;
                 if (item.type === "api") {
                     item.json = JSON.stringify(item.api);
+                    if (item.infoId)
+                        item.infoPath = `${outputDir}/${item.infoId}`;
                 }
                 const view = (0, mustache_1.render)(mdTemplate, item);
                 const utils = (0, mustache_1.render)(infoMdTemplate, item);
+                // eslint-disable-next-line testing-library/render-result-naming-convention
+                const tagUtils = (0, mustache_1.render)(tagMdTemplate, item);
                 if (item.type === "api") {
                     if (!fs_1.default.existsSync(`${outputDir}/${item.id}.api.mdx`)) {
                         try {
@@ -132,6 +167,17 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                         }
                     }
                 }
+                if (item.type === "tag") {
+                    if (!fs_1.default.existsSync(`${outputDir}/${item.id}.tag.mdx`)) {
+                        try {
+                            fs_1.default.writeFileSync(`${outputDir}/${item.id}.tag.mdx`, tagUtils, "utf8");
+                            console.log(chalk_1.default.green(`Successfully created "${outputDir}/${item.id}.tag.mdx"`));
+                        }
+                        catch (err) {
+                            console.error(chalk_1.default.red(`Failed to write "${outputDir}/${item.id}.tag.mdx"`), chalk_1.default.yellow(err));
+                        }
+                    }
+                }
                 return;
             });
             return;
@@ -144,7 +190,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
     async function cleanApiDocs(options) {
         const { outputDir } = options;
         const apiDir = path_1.default.join(siteDir, outputDir);
-        const apiMdxFiles = await (0, utils_1.Globby)(["*.api.mdx", "*.info.mdx"], {
+        const apiMdxFiles = await (0, utils_1.Globby)(["*.api.mdx", "*.info.mdx", "*.tag.mdx"], {
             cwd: path_1.default.resolve(apiDir),
         });
         const sidebarFile = await (0, utils_1.Globby)(["sidebar.js"], {

package/lib/markdown/createAuthentication.d.ts

@@ -0,0 +1,2 @@
+import { SecuritySchemeObject } from "../openapi/types";
+export declare function createAuthentication(securitySchemes: SecuritySchemeObject): string;

package/lib/markdown/createAuthentication.js

@@ -0,0 +1,139 @@
+"use strict";
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAuthentication = void 0;
+const createDescription_1 = require("./createDescription");
+const utils_1 = require("./utils");
+function createAuthentication(securitySchemes) {
+    if (!securitySchemes || !Object.keys(securitySchemes).length)
+        return "";
+    const createAuthenticationTable = (securityScheme) => {
+        const { bearerFormat, flows, name, scheme, type } = securityScheme;
+        const createSecuritySchemeTypeRow = () => (0, utils_1.create)("tr", {
+            children: [
+                (0, utils_1.create)("th", { children: "Security Scheme Type:" }),
+                (0, utils_1.create)("td", { children: type }),
+            ],
+        });
+        const createOAuthFlowRows = () => {
+            const flowRows = Object.entries(flows).map(([flowType, flowObj]) => {
+                const { authorizationUrl, tokenUrl, refreshUrl, scopes } = flowObj;
+                return (0, utils_1.create)("tr", {
+                    children: [
+                        (0, utils_1.create)("th", { children: `${flowType} OAuth Flow:` }),
+                        (0, utils_1.create)("td", {
+                            children: [
+                                (0, utils_1.guard)(tokenUrl, () => (0, utils_1.create)("p", { children: `Token URL: ${tokenUrl}` })),
+                                (0, utils_1.guard)(authorizationUrl, () => (0, utils_1.create)("p", {
+                                    children: `Authorization URL: ${authorizationUrl}`,
+                                })),
+                                (0, utils_1.guard)(refreshUrl, () => (0, utils_1.create)("p", { children: `Refresh URL: ${refreshUrl}` })),
+                                (0, utils_1.create)("span", { children: "Scopes:" }),
+                                (0, utils_1.create)("ul", {
+                                    children: Object.entries(scopes).map(([scope, description]) => (0, utils_1.create)("li", { children: `${scope}: ${description}` })),
+                                }),
+                            ],
+                        }),
+                    ],
+                });
+            });
+            return flowRows.join("");
+        };
+        switch (type) {
+            case "apiKey":
+                return (0, utils_1.create)("div", {
+                    children: [
+                        (0, utils_1.create)("table", {
+                            children: (0, utils_1.create)("tbody", {
+                                children: [
+                                    createSecuritySchemeTypeRow(),
+                                    (0, utils_1.create)("tr", {
+                                        children: [
+                                            (0, utils_1.create)("th", { children: "Header parameter name:" }),
+                                            (0, utils_1.create)("td", { children: name }),
+                                        ],
+                                    }),
+                                ],
+                            }),
+                        }),
+                    ],
+                });
+            case "http":
+                return (0, utils_1.create)("div", {
+                    children: [
+                        (0, utils_1.create)("table", {
+                            children: (0, utils_1.create)("tbody", {
+                                children: [
+                                    createSecuritySchemeTypeRow(),
+                                    (0, utils_1.create)("tr", {
+                                        children: [
+                                            (0, utils_1.create)("th", { children: "HTTP Authorization Scheme:" }),
+                                            (0, utils_1.create)("td", { children: scheme }),
+                                        ],
+                                    }),
+                                    (0, utils_1.create)("tr", {
+                                        children: [
+                                            (0, utils_1.create)("th", { children: "Bearer format:" }),
+                                            (0, utils_1.create)("td", { children: bearerFormat }),
+                                        ],
+                                    }),
+                                ],
+                            }),
+                        }),
+                    ],
+                });
+            case "oauth2":
+                return (0, utils_1.create)("div", {
+                    children: [
+                        (0, utils_1.create)("table", {
+                            children: (0, utils_1.create)("tbody", {
+                                children: [
+                                    createSecuritySchemeTypeRow(),
+                                    createOAuthFlowRows(),
+                                ],
+                            }),
+                        }),
+                    ],
+                });
+            default:
+                return "";
+        }
+    };
+    const formatTabLabel = (str) => {
+        const formattedLabel = str
+            .replace(/(_|-)/g, " ")
+            .trim()
+            .replace(/\w\S*/g, (str) => str.charAt(0).toUpperCase() + str.substr(1))
+            .replace(/([a-z])([A-Z])/g, "$1 $2")
+            .replace(/([A-Z])([A-Z][a-z])/g, "$1 $2");
+        const isOAuth = formattedLabel.toLowerCase().includes("oauth2");
+        const isApiKey = formattedLabel.toLowerCase().includes("api");
+        return isOAuth ? "OAuth 2.0" : isApiKey ? "API Key" : formattedLabel;
+    };
+    return (0, utils_1.create)("div", {
+        children: [
+            (0, utils_1.create)("h2", {
+                children: "Authentication",
+                id: "authentication",
+                style: { marginBottom: "1rem" },
+            }),
+            (0, utils_1.create)("Tabs", {
+                children: Object.entries(securitySchemes).map(([schemeType, schemeObj]) => (0, utils_1.create)("TabItem", {
+                    label: formatTabLabel(schemeType),
+                    value: `${schemeType}`,
+                    children: [
+                        (0, createDescription_1.createDescription)(schemeObj.description),
+                        createAuthenticationTable(schemeObj),
+                    ],
+                })),
+            }),
+        ],
+        style: { marginBottom: "2rem" },
+    });
+}
+exports.createAuthentication = createAuthentication;

package/lib/markdown/index.d.ts

@@ -1,3 +1,4 @@
-import { ApiPageMetadata, InfoPageMetadata } from "../types";
+import { ApiPageMetadata, InfoPageMetadata, TagPageMetadata } from "../types";
 export declare function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, parameters, requestBody, responses, }, }: ApiPageMetadata): string;
-export declare function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService }, }: InfoPageMetadata): string;
+export declare function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService }, securitySchemes, }: InfoPageMetadata): string;
+export declare function createTagPageMD({ tag: { description } }: TagPageMetadata): string;

package/lib/markdown/index.js

@@ -6,8 +6,9 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createInfoPageMD = exports.createApiPageMD = void 0;
+exports.createTagPageMD = exports.createInfoPageMD = exports.createApiPageMD = void 0;
 const lodash_1 = require("lodash");
+const createAuthentication_1 = require("./createAuthentication");
 const createContactInfo_1 = require("./createContactInfo");
 const createDeprecationNotice_1 = require("./createDeprecationNotice");
 const createDescription_1 = require("./createDescription");
@@ -36,14 +37,21 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
     ]);
 }
 exports.createApiPageMD = createApiPageMD;
-function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService }, }) {
+function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService }, securitySchemes, }) {
     return (0, utils_1.render)([
+        `import Tabs from "@theme/Tabs";\n`,
+        `import TabItem from "@theme/TabItem";\n`,
         (0, createVersionBadge_1.createVersionBadge)(version),
         `# ${(0, lodash_1.escape)(title)}\n\n`,
         (0, createDescription_1.createDescription)(description),
+        (0, createAuthentication_1.createAuthentication)(securitySchemes),
         (0, createContactInfo_1.createContactInfo)(contact),
         (0, createTermsOfService_1.createTermsOfService)(termsOfService),
         (0, createLicense_1.createLicense)(license),
     ]);
 }
 exports.createInfoPageMD = createInfoPageMD;
+function createTagPageMD({ tag: { description } }) {
+    return (0, utils_1.render)([(0, createDescription_1.createDescription)(description)]);
+}
+exports.createTagPageMD = createTagPageMD;

package/lib/openapi/createExample.js

@@ -5,8 +5,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sampleFromSchema = void 0;
+const chalk_1 = __importDefault(require("chalk"));
 const primitives = {
     string: {
         default: () => "string",
@@ -31,64 +35,70 @@ const primitives = {
     array: {},
 };
 const sampleFromSchema = (schema = {}) => {
-    let { type, example, allOf, properties, items } = schema;
-    if (example !== undefined) {
-        return example;
-    }
-    if (allOf) {
-        // TODO: We are just assuming it will always be an object for now
-        let obj = {
-            type: "object",
-            properties: {},
-            required: [], // NOTE: We shouldn't need to worry about required
-        };
-        for (let item of allOf) {
-            if (item.properties) {
-                obj.properties = {
-                    ...obj.properties,
-                    ...item.properties,
-                };
-            }
-        }
-        return (0, exports.sampleFromSchema)(obj);
-    }
-    if (!type) {
-        if (properties) {
-            type = "object";
+    try {
+        let { type, example, allOf, properties, items } = schema;
+        if (example !== undefined) {
+            return example;
         }
-        else if (items) {
-            type = "array";
+        if (allOf) {
+            // TODO: We are just assuming it will always be an object for now
+            let obj = {
+                type: "object",
+                properties: {},
+                required: [], // NOTE: We shouldn't need to worry about required
+            };
+            for (let item of allOf) {
+                if (item.properties) {
+                    obj.properties = {
+                        ...obj.properties,
+                        ...item.properties,
+                    };
+                }
+            }
+            return (0, exports.sampleFromSchema)(obj);
         }
-        else {
-            return;
+        if (!type) {
+            if (properties) {
+                type = "object";
+            }
+            else if (items) {
+                type = "array";
+            }
+            else {
+                return;
+            }
         }
-    }
-    if (type === "object") {
-        let obj = {};
-        for (let [name, prop] of Object.entries(properties !== null && properties !== void 0 ? properties : {})) {
-            if (prop.deprecated) {
-                continue;
+        if (type === "object") {
+            let obj = {};
+            for (let [name, prop] of Object.entries(properties !== null && properties !== void 0 ? properties : {})) {
+                if (prop.deprecated) {
+                    continue;
+                }
+                obj[name] = (0, exports.sampleFromSchema)(prop);
             }
-            obj[name] = (0, exports.sampleFromSchema)(prop);
+            return obj;
         }
-        return obj;
-    }
-    if (type === "array") {
-        if (Array.isArray(items === null || items === void 0 ? void 0 : items.anyOf)) {
-            return items === null || items === void 0 ? void 0 : items.anyOf.map((item) => (0, exports.sampleFromSchema)(item));
+        if (type === "array") {
+            if (Array.isArray(items === null || items === void 0 ? void 0 : items.anyOf)) {
+                return items === null || items === void 0 ? void 0 : items.anyOf.map((item) => (0, exports.sampleFromSchema)(item));
+            }
+            if (Array.isArray(items === null || items === void 0 ? void 0 : items.oneOf)) {
+                return items === null || items === void 0 ? void 0 : items.oneOf.map((item) => (0, exports.sampleFromSchema)(item));
+            }
+            return [(0, exports.sampleFromSchema)(items)];
         }
-        if (Array.isArray(items === null || items === void 0 ? void 0 : items.oneOf)) {
-            return items === null || items === void 0 ? void 0 : items.oneOf.map((item) => (0, exports.sampleFromSchema)(item));
+        if (schema.enum) {
+            if (schema.default) {
+                return schema.default;
+            }
+            return normalizeArray(schema.enum)[0];
         }
-        return [(0, exports.sampleFromSchema)(items)];
+        return primitive(schema);
     }
-    if (schema.enum) {
-        if (schema.default) {
-            return schema.default;
-        }
-        return normalizeArray(schema.enum)[0];
+    catch (err) {
+        console.error(chalk_1.default.yellow("WARNING: failed to create example from schema object:", err));
+        return;
     }
-    return primitive(schema);
 };
 exports.sampleFromSchema = sampleFromSchema;
 function primitive(schema = {}) {

package/lib/openapi/openapi.d.ts

@@ -1,4 +1,4 @@
-import { ApiMetadata } from "../types";
+import { ApiMetadata, SidebarOptions } from "../types";
 import { OpenApiObjectWithRef, TagObject } from "./types";
 interface OpenApiFiles {
     source: string;
@@ -6,7 +6,7 @@ interface OpenApiFiles {
     data: OpenApiObjectWithRef;
 }
 export declare function readOpenapiFiles(openapiPath: string, _options: {}): Promise<OpenApiFiles[]>;
-export declare function processOpenapiFiles(files: OpenApiFiles[]): Promise<[ApiMetadata[], TagObject[]]>;
-export declare function processOpenapiFile(openapiDataWithRefs: OpenApiObjectWithRef): Promise<[ApiMetadata[], TagObject[]]>;
+export declare function processOpenapiFiles(files: OpenApiFiles[], sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[]]>;
+export declare function processOpenapiFile(openapiDataWithRefs: OpenApiObjectWithRef, sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[]]>;
 export declare function getTagDisplayName(tagName: string, tags: TagObject[]): string;
 export {};