docusaurus-plugin-openapi-docs 0.0.0-1000

package/lib/markdown/createArrayBracket.d.ts

@@ -0,0 +1,2 @@
+export declare function createOpeningArrayBracket(): string;
+export declare function createClosingArrayBracket(): string;

package/lib/markdown/createArrayBracket.js

@@ -0,0 +1,36 @@
+"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.createOpeningArrayBracket = createOpeningArrayBracket;
+exports.createClosingArrayBracket = createClosingArrayBracket;
+const utils_1 = require("./utils");
+function createOpeningArrayBracket() {
+    return (0, utils_1.create)("li", {
+        children: (0, utils_1.create)("div", {
+            style: {
+                fontSize: "var(--ifm-code-font-size)",
+                opacity: "0.6",
+                marginLeft: "-.5rem",
+                paddingBottom: ".5rem",
+            },
+            children: ["Array ["],
+        }),
+    });
+}
+function createClosingArrayBracket() {
+    return (0, utils_1.create)("li", {
+        children: (0, utils_1.create)("div", {
+            style: {
+                fontSize: "var(--ifm-code-font-size)",
+                opacity: "0.6",
+                marginLeft: "-.5rem",
+            },
+            children: ["]"],
+        }),
+    });
+}

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,171 @@
+"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 = createAuthentication;
+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, openIdConnectUrl } = 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: `OAuth Flow (${flowType}):` }),
+                        (0, utils_1.create)("td", {
+                            children: [
+                                (0, utils_1.guard)(tokenUrl, () => (0, utils_1.create)("div", { children: `Token URL: ${tokenUrl}` })),
+                                (0, utils_1.guard)(authorizationUrl, () => (0, utils_1.create)("div", {
+                                    children: `Authorization URL: ${authorizationUrl}`,
+                                })),
+                                (0, utils_1.guard)(refreshUrl, () => (0, utils_1.create)("div", { 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.guard)(bearerFormat, () => (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(),
+                                ],
+                            }),
+                        }),
+                    ],
+                });
+            case "openIdConnect":
+                return (0, utils_1.create)("div", {
+                    children: [
+                        (0, utils_1.create)("table", {
+                            children: (0, utils_1.create)("tbody", {
+                                children: [
+                                    createSecuritySchemeTypeRow(),
+                                    (0, utils_1.guard)(openIdConnectUrl, () => (0, utils_1.create)("tr", {
+                                        children: [
+                                            (0, utils_1.create)("th", { children: "OpenID Connect URL:" }),
+                                            (0, utils_1.create)("td", { children: openIdConnectUrl }),
+                                        ],
+                                    })),
+                                ],
+                            }),
+                        }),
+                    ],
+                });
+            default:
+                return "";
+        }
+    };
+    const formatTabLabel = (key, type, scheme) => {
+        const formattedLabel = key
+            .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 = type === "oauth2";
+        const isApiKey = type === "apiKey";
+        const isHttpBasic = type === "http" && scheme === "basic";
+        const isHttpBearer = type === "http" && scheme === "bearer";
+        const isOpenId = type === "openIdConnect";
+        if (isOAuth)
+            return `OAuth 2.0: ${key}`;
+        if (isApiKey)
+            return `API Key: ${key}`;
+        if (isHttpBasic)
+            return "HTTP: Basic Auth";
+        if (isHttpBearer)
+            return "HTTP: Bearer Auth";
+        if (isOpenId)
+            return `OpenID Connect: ${key}`;
+        return formattedLabel;
+    };
+    return (0, utils_1.create)("div", {
+        children: [
+            (0, utils_1.create)("Heading", {
+                children: "Authentication",
+                id: "authentication",
+                as: "h2",
+                className: "openapi-tabs__heading",
+            }, { inline: true }),
+            (0, utils_1.create)("SchemaTabs", {
+                className: "openapi-tabs__security-schemes",
+                children: Object.entries(securitySchemes).map(([schemeKey, schemeObj]) => (0, utils_1.create)("TabItem", {
+                    label: formatTabLabel(schemeKey, schemeObj.type, schemeObj.scheme),
+                    value: `${schemeKey}`,
+                    children: [
+                        (0, createDescription_1.createDescription)(schemeObj.description),
+                        createAuthenticationTable(schemeObj),
+                    ],
+                })),
+            }),
+        ],
+        style: { marginBottom: "2rem" },
+    });
+}

package/lib/markdown/createAuthorization.d.ts

@@ -0,0 +1 @@
+export declare function createAuthorization(infoPath: string): string[] | undefined;

package/lib/markdown/createAuthorization.js

@@ -0,0 +1,15 @@
+"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.createAuthorization = createAuthorization;
+const utils_1 = require("./utils");
+function createAuthorization(infoPath) {
+    if (!infoPath)
+        return undefined;
+    return [(0, utils_1.create)("SecuritySchemes", { infoPath: infoPath }), "\n\n"];
+}

package/lib/markdown/createCallbackMethodEndpoint.d.ts

@@ -0,0 +1 @@
+export declare function createCallbackMethodEndpoint(method: String, path: String): string[];

package/lib/markdown/createCallbackMethodEndpoint.js

@@ -0,0 +1,20 @@
+"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.createCallbackMethodEndpoint = createCallbackMethodEndpoint;
+const utils_1 = require("./utils");
+function createCallbackMethodEndpoint(method, path) {
+    return [
+        (0, utils_1.create)("MethodEndpoint", {
+            method: method,
+            path: path,
+            context: "callback",
+        }),
+        "\n\n",
+    ];
+}

package/lib/markdown/createCallbacks.d.ts

@@ -0,0 +1,6 @@
+import { ApiItem } from "../types";
+interface Props {
+    callbacks: ApiItem["callbacks"];
+}
+export declare function createCallbacks({ callbacks }: Props): string | undefined;
+export {};

package/lib/markdown/createCallbacks.js

@@ -0,0 +1,77 @@
+"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.createCallbacks = createCallbacks;
+const createCallbackMethodEndpoint_1 = require("./createCallbackMethodEndpoint");
+const createDescription_1 = require("./createDescription");
+const createRequestBodyDetails_1 = require("./createRequestBodyDetails");
+const createStatusCodes_1 = require("./createStatusCodes");
+const utils_1 = require("./utils");
+function createCallbacks({ callbacks }) {
+    if (callbacks === undefined) {
+        return undefined;
+    }
+    const callbacksNames = Object.keys(callbacks);
+    if (callbacksNames.length === 0) {
+        return undefined;
+    }
+    return (0, utils_1.create)("div", {
+        children: [
+            (0, utils_1.create)("div", {
+                className: "openapi__divider",
+            }),
+            (0, utils_1.create)("Heading", {
+                children: "Callbacks",
+                id: "callbacks",
+                as: "h2",
+                className: "openapi-tabs__heading",
+            }, { inline: true }),
+            (0, utils_1.create)("OperationTabs", {
+                className: "openapi-tabs__operation",
+                children: callbacksNames.flatMap((name) => {
+                    const path = Object.keys(callbacks[name])[0];
+                    const methods = new Map([
+                        ["delete", callbacks[name][path].delete],
+                        ["get", callbacks[name][path].get],
+                        ["head", callbacks[name][path].head],
+                        ["options", callbacks[name][path].options],
+                        ["patch", callbacks[name][path].patch],
+                        ["post", callbacks[name][path].post],
+                        ["put", callbacks[name][path].put],
+                        ["trace", callbacks[name][path].trace],
+                    ]);
+                    return Array.from(methods).flatMap(([method, operationObject]) => {
+                        if (!operationObject)
+                            return [];
+                        const { description, requestBody, responses } = operationObject;
+                        return [
+                            (0, utils_1.create)("TabItem", {
+                                label: `${method.toUpperCase()} ${name}`,
+                                value: `${method}-${name}`,
+                                children: [
+                                    (0, createCallbackMethodEndpoint_1.createCallbackMethodEndpoint)(method, path),
+                                    // TODO: add `deprecation notice` when markdown support is added
+                                    (0, createDescription_1.createDescription)(description),
+                                    (0, createRequestBodyDetails_1.createRequestBodyDetails)({
+                                        title: "Body",
+                                        body: requestBody,
+                                    }),
+                                    (0, createStatusCodes_1.createStatusCodes)({
+                                        id: "callbacks-responses",
+                                        label: "Callbacks Responses",
+                                        responses,
+                                    }),
+                                ],
+                            }),
+                        ];
+                    });
+                }),
+            }),
+        ],
+    });
+}

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,39 @@
+"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 = createContactInfo;
+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, () => `[${email}](mailto:${email})`),
+                ],
+            }),
+            (0, utils_1.guard)(url, () => (0, utils_1.create)("span", {
+                children: ["URL: ", `[${url}](${url})`],
+            })),
+        ],
+    });
+}

package/lib/markdown/createDeprecationNotice.d.ts

@@ -0,0 +1,6 @@
+interface DeprecationNoticeProps {
+    deprecated?: boolean;
+    description?: string;
+}
+export declare function createDeprecationNotice({ deprecated, description, }: DeprecationNoticeProps): string;
+export {};

package/lib/markdown/createDeprecationNotice.js

@@ -0,0 +1,20 @@
+"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.createDeprecationNotice = createDeprecationNotice;
+const utils_1 = require("./utils");
+function createAdmonition({ children }) {
+    return `:::caution deprecated\n\n${(0, utils_1.render)(children)}\n\n:::`;
+}
+function createDeprecationNotice({ deprecated, description, }) {
+    return (0, utils_1.guard)(deprecated, () => createAdmonition({
+        children: description && description.length > 0
+            ? (0, utils_1.clean)(description)
+            : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
+    }));
+}

package/lib/markdown/createDescription.d.ts

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

package/lib/markdown/createDescription.js

@@ -0,0 +1,13 @@
+"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.createDescription = createDescription;
+const utils_1 = require("./utils");
+function createDescription(description) {
+    return `\n\n${(0, utils_1.clean)(description)}\n\n`;
+}

package/lib/markdown/createDetails.d.ts

@@ -0,0 +1,2 @@
+import { Props } from "./utils";
+export declare function createDetails({ children, style, ...rest }: Props): string;

package/lib/markdown/createDetails.js

@@ -0,0 +1,17 @@
+"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.createDetails = createDetails;
+const utils_1 = require("./utils");
+function createDetails({ children, style, ...rest }) {
+    return (0, utils_1.create)("details", {
+        style: { ...style },
+        ...rest,
+        children,
+    });
+}

package/lib/markdown/createDetailsSummary.d.ts

@@ -0,0 +1,2 @@
+import { Props } from "./utils";
+export declare function createDetailsSummary({ children, style, ...rest }: Props): string;

package/lib/markdown/createDetailsSummary.js

@@ -0,0 +1,17 @@
+"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.createDetailsSummary = createDetailsSummary;
+const utils_1 = require("./utils");
+function createDetailsSummary({ children, style, ...rest }) {
+    return (0, utils_1.create)("summary", {
+        style: { ...style },
+        ...rest,
+        children,
+    });
+}

package/lib/markdown/createDownload.d.ts

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

package/lib/markdown/createDownload.js

@@ -0,0 +1,16 @@
+"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.createDownload = createDownload;
+const utils_1 = require("./utils");
+function createDownload(url) {
+    return (0, utils_1.guard)(url, (url) => [
+        (0, utils_1.create)("Export", { url: url, proxy: undefined }),
+        `\n\n`,
+    ]);
+}

package/lib/markdown/createHeading.d.ts

@@ -0,0 +1 @@
+export declare function createHeading(heading: string): string[];

package/lib/markdown/createHeading.js

@@ -0,0 +1,20 @@
+"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.createHeading = createHeading;
+const utils_1 = require("./utils");
+function createHeading(heading) {
+    return [
+        (0, utils_1.create)("Heading", {
+            children: (0, utils_1.clean)(heading),
+            as: "h1",
+            className: "openapi__heading",
+        }, { inline: true }),
+        `\n\n`,
+    ];
+}

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,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.createLicense = createLicense;
+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,
+            })),
+        ],
+    });
+}

package/lib/markdown/createLogo.d.ts

@@ -0,0 +1,2 @@
+import { LogoObject } from "../openapi/types";
+export declare function createLogo(logo: LogoObject | undefined, darkLogo: LogoObject | undefined): string;

package/lib/markdown/createLogo.js

@@ -0,0 +1,18 @@
+"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.createLogo = createLogo;
+const utils_1 = require("./utils");
+function createLogo(logo, darkLogo) {
+    return (0, utils_1.guard)(logo || darkLogo, () => [
+        (0, utils_1.create)("ApiLogo", {
+            logo: logo,
+            darkLogo: darkLogo,
+        }),
+    ]);
+}

package/lib/markdown/createMethodEndpoint.d.ts

@@ -0,0 +1 @@
+export declare function createMethodEndpoint(method: String, path: String): string[];

package/lib/markdown/createMethodEndpoint.js

@@ -0,0 +1,20 @@
+"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.createMethodEndpoint = createMethodEndpoint;
+const utils_1 = require("./utils");
+function createMethodEndpoint(method, path) {
+    return [
+        (0, utils_1.create)("MethodEndpoint", {
+            method: method,
+            path: path,
+            context: "endpoint",
+        }),
+        "\n\n",
+    ];
+}

package/lib/markdown/createParamsDetails.d.ts

@@ -0,0 +1,6 @@
+import { ApiItem } from "../types";
+interface Props {
+    parameters: ApiItem["parameters"];
+}
+export declare function createParamsDetails({ parameters }: Props): string[];
+export {};

package/lib/markdown/createParamsDetails.js

@@ -0,0 +1,18 @@
+"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.createParamsDetails = createParamsDetails;
+const utils_1 = require("./utils");
+function createParamsDetails({ parameters }) {
+    return [
+        (0, utils_1.create)("ParamsDetails", {
+            parameters: parameters,
+        }),
+        "\n\n",
+    ];
+}