docusaurus-plugin-openapi-docs 1.0.1 → 1.0.4

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/createContactInfo.d.ts

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

package/lib/markdown/createContactInfo.js

@@ -0,0 +1,49 @@
+"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.createContactInfo = void 0;
+const utils_1 = require("./utils");
+function createContactInfo(contact) {
+    if (!contact || !Object.keys(contact).length)
+        return "";
+    const { name, url, email } = contact;
+    return (0, utils_1.create)("div", {
+        style: {
+            display: "flex",
+            flexDirection: "column",
+            marginBottom: "var(--ifm-paragraph-margin-bottom)",
+        },
+        children: [
+            (0, utils_1.create)("h3", {
+                style: {
+                    marginBottom: "0.25rem",
+                },
+                children: "Contact",
+            }),
+            (0, utils_1.create)("span", {
+                children: [
+                    (0, utils_1.guard)(name, () => `${name}: `),
+                    (0, utils_1.guard)(email, () => (0, utils_1.create)("a", {
+                        href: `mailto:${email}`,
+                        children: `${email}`,
+                    })),
+                ],
+            }),
+            (0, utils_1.guard)(url, () => (0, utils_1.create)("span", {
+                children: [
+                    "URL: ",
+                    (0, utils_1.create)("a", {
+                        href: `${url}`,
+                        children: `${url}`,
+                    }),
+                ],
+            })),
+        ],
+    });
+}
+exports.createContactInfo = createContactInfo;

package/lib/markdown/createLicense.d.ts

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

package/lib/markdown/createLicense.js

@@ -0,0 +1,33 @@
+"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.createLicense = void 0;
+const utils_1 = require("./utils");
+function createLicense(license) {
+    if (!license || !Object.keys(license).length)
+        return "";
+    const { name, url } = license;
+    return (0, utils_1.create)("div", {
+        style: {
+            marginBottom: "var(--ifm-paragraph-margin-bottom)",
+        },
+        children: [
+            (0, utils_1.create)("h3", {
+                style: {
+                    marginBottom: "0.25rem",
+                },
+                children: "License",
+            }),
+            (0, utils_1.guard)(url, () => (0, utils_1.create)("a", {
+                href: url,
+                children: name !== null && name !== void 0 ? name : url,
+            })),
+        ],
+    });
+}
+exports.createLicense = createLicense;

package/lib/markdown/createParamsDetails.js

@@ -19,6 +19,8 @@ function createParamsDetails({ parameters, type }) {
         return undefined;
     }
     return (0, createDetails_1.createDetails)({
+        "data-collapsed": false,
+        open: true,
         style: { marginBottom: "1rem" },
         children: [
             (0, createDetailsSummary_1.createDetailsSummary)({

package/lib/markdown/createSchemaDetails.js

@@ -185,7 +185,10 @@ function createRowsRoot({ schema }) {
     });
 }
 function createSchemaDetails({ title, body, ...rest }) {
-    if (body === undefined || body.content === undefined) {
+    if (body === undefined ||
+        body.content === undefined ||
+        Object.keys(body).length === 0 ||
+        Object.keys(body.content).length === 0) {
         return undefined;
     }
     // TODO:
@@ -203,6 +206,8 @@ function createSchemaDetails({ title, body, ...rest }) {
         }
     }
     return (0, createDetails_1.createDetails)({
+        "data-collapsed": false,
+        open: true,
         ...rest,
         children: [
             (0, createDetailsSummary_1.createDetailsSummary)({

package/lib/markdown/createStatusCodes.js

@@ -20,7 +20,7 @@ function createStatusCodes({ responses }) {
     }
     return (0, utils_1.create)("div", {
         children: [
-            (0, utils_1.create)("Tabs", {
+            (0, utils_1.create)("ApiTabs", {
                 children: codes.map((code) => {
                     return (0, utils_1.create)("TabItem", {
                         label: code,

package/lib/markdown/createTermsOfService.d.ts

@@ -0,0 +1 @@
+export declare function createTermsOfService(termsOfService: string | undefined): string;

package/lib/markdown/createTermsOfService.js

@@ -0,0 +1,32 @@
+"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.createTermsOfService = void 0;
+const utils_1 = require("./utils");
+function createTermsOfService(termsOfService) {
+    if (!termsOfService)
+        return "";
+    return (0, utils_1.create)("div", {
+        style: {
+            marginBottom: "var(--ifm-paragraph-margin-bottom)",
+        },
+        children: [
+            (0, utils_1.create)("h3", {
+                style: {
+                    marginBottom: "0.25rem",
+                },
+                children: "Terms of Service",
+            }),
+            (0, utils_1.create)("a", {
+                href: `${termsOfService}`,
+                children: termsOfService,
+            }),
+        ],
+    });
+}
+exports.createTermsOfService = createTermsOfService;

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 }, }: 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,20 +6,24 @@
  * 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");
+const createLicense_1 = require("./createLicense");
 const createParamsDetails_1 = require("./createParamsDetails");
 const createRequestBodyDetails_1 = require("./createRequestBodyDetails");
 const createStatusCodes_1 = require("./createStatusCodes");
+const createTermsOfService_1 = require("./createTermsOfService");
 const createVersionBadge_1 = require("./createVersionBadge");
 const utils_1 = require("./utils");
 function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, parameters, requestBody, responses, }, }) {
     return (0, utils_1.render)([
         `import ParamsItem from "@theme/ParamsItem";\n`,
         `import SchemaItem from "@theme/SchemaItem"\n`,
-        `import Tabs from "@theme/Tabs";\n`,
+        `import ApiTabs from "@theme/ApiTabs";\n`,
         `import TabItem from "@theme/TabItem";\n\n`,
         `## ${(0, lodash_1.escape)(title)}\n\n`,
         (0, createDeprecationNotice_1.createDeprecationNotice)({ deprecated, description: deprecatedDescription }),
@@ -33,11 +37,21 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
     ]);
 }
 exports.createApiPageMD = createApiPageMD;
-function createInfoPageMD({ info: { title, version, description }, }) {
+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\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,11 +1,12 @@
-import { ApiMetadata } from "../types";
-import { OpenApiObjectWithRef } from "./types";
+import { ApiMetadata, SidebarOptions } from "../types";
+import { OpenApiObjectWithRef, TagObject } from "./types";
 interface OpenApiFiles {
     source: string;
     sourceDirName: string;
     data: OpenApiObjectWithRef;
 }
 export declare function readOpenapiFiles(openapiPath: string, _options: {}): Promise<OpenApiFiles[]>;
-export declare function processOpenapiFiles(files: OpenApiFiles[]): Promise<ApiMetadata[]>;
-export declare function processOpenapiFile(openapiDataWithRefs: OpenApiObjectWithRef): Promise<ApiMetadata[]>;
+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 {};