docusaurus-plugin-openapi-docs 0.0.0-1000

package/lib/markdown/utils.js

@@ -0,0 +1,68 @@
+"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.codeBlock = exports.curlyBrackets = exports.codeFence = exports.greaterThan = exports.lessThan = void 0;
+exports.create = create;
+exports.guard = guard;
+exports.render = render;
+exports.clean = clean;
+function create(tag, props, options = {}) {
+    const { children, ...rest } = props;
+    let propString = "";
+    for (const [key, value] of Object.entries(rest)) {
+        propString += `\n  ${key}={${JSON.stringify(value)}}`;
+    }
+    let indentedChildren = render(children).replace(/^/gm, "  ");
+    if (options.inline) {
+        propString += `\n  children={${JSON.stringify(children)}}`;
+        indentedChildren = "";
+    }
+    propString += propString ? "\n" : "";
+    indentedChildren += indentedChildren ? "\n" : "";
+    return `<${tag}${propString}>\n${indentedChildren}</${tag}>`;
+}
+function guard(value, cb) {
+    if (!!value || value === 0) {
+        const children = cb(value);
+        return render(children);
+    }
+    return "";
+}
+function render(children) {
+    if (Array.isArray(children)) {
+        const filteredChildren = children.filter((c) => c !== undefined);
+        return filteredChildren
+            .map((i) => (Array.isArray(i) ? i.join("") : i))
+            .join("");
+    }
+    return children !== null && children !== void 0 ? children : "";
+}
+// Regex to selectively URL-encode '>' and '<' chars
+exports.lessThan = /<=?(?!(=|button|\s?\/button|code|\s?\/code|details|\s?\/details|summary|\s?\/summary|hr|\s?\/hr|br|\s?\/br|span|\s?\/span|strong|\s?\/strong|small|\s?\/small|table|\s?\/table|thead|\s?\/thead|tbody|\s?\/tbody|td|\s?\/td|tr|\s?\/tr|th|\s?\/th|h1|\s?\/h1|h2|\s?\/h2|h3|\s?\/h3|h4|\s?\/h4|h5|\s?\/h5|h6|\s?\/h6|title|\s?\/title|p|\s?\/p|em|\s?\/em|b|\s?\/b|i|\s?\/i|u|\s?\/u|strike|\s?\/strike|bold|\s?\/bold|a|\s?\/a|table|\s?\/table|li|\s?\/li|ol|\s?\/ol|ul|\s?\/ul|img|\s?\/img|svg|\s?\/svg|div|\s?\/div|center|\s?\/center))/gu;
+exports.greaterThan = /(?<!(button|code|details|summary|hr|br|span|strong|small|table|thead|tbody|td|tr|th|h1|h2|h3|h4|h5|h6|title|p|em|b|i|u|strike|bold|a|li|ol|ul|img|svg|div|center|\/|\s|"|'))>/gu;
+exports.codeFence = /`{1,3}[\s\S]*?`{1,3}/g;
+exports.curlyBrackets = /([{}])/g;
+exports.codeBlock = /(^```.*[\s\S]*?```$|`[^`].+?`)/gm;
+function clean(value) {
+    if (!value) {
+        return "";
+    }
+    let sections = value.split(exports.codeBlock);
+    for (let sectionIndex in sections) {
+        if (!sections[sectionIndex].startsWith("`")) {
+            sections[sectionIndex] = sections[sectionIndex]
+                .replace(exports.lessThan, "&lt;")
+                .replace(exports.greaterThan, "&gt;")
+                .replace(exports.codeFence, function (match) {
+                return match.replace(/\\>/g, ">");
+            })
+                .replace(exports.curlyBrackets, "\\$1");
+        }
+    }
+    return sections.join("");
+}

package/lib/openapi/createRequestExample.d.ts

@@ -0,0 +1,2 @@
+import { SchemaObject } from "./types";
+export declare const sampleRequestFromSchema: (schema?: SchemaObject) => any;

package/lib/openapi/createRequestExample.js

@@ -0,0 +1,191 @@
+"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.
+ * ========================================================================== */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sampleRequestFromSchema = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const merge_1 = __importDefault(require("lodash/merge"));
+const createSchema_1 = require("../markdown/createSchema");
+const primitives = {
+    string: {
+        default: () => "string",
+        email: () => "user@example.com",
+        date: () => "2024-07-29",
+        "date-time": () => "2024-07-29T15:51:28.071Z",
+        uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+        hostname: () => "example.com",
+        ipv4: () => "198.51.100.42",
+        ipv6: () => "2001:0db8:5b96:0000:0000:426f:8e17:642a",
+    },
+    number: {
+        default: () => 0,
+        float: () => 0.0,
+    },
+    integer: {
+        default: () => 0,
+    },
+    boolean: {
+        default: (schema) => typeof schema.default === "boolean" ? schema.default : true,
+    },
+    object: {},
+    array: {},
+};
+function sampleRequestFromProp(name, prop, obj) {
+    // Handle resolved circular props
+    if (typeof prop === "object" && Object.keys(prop).length === 0) {
+        obj[name] = prop;
+        return obj;
+    }
+    // TODO: handle discriminators
+    if (prop.oneOf) {
+        obj[name] = (0, exports.sampleRequestFromSchema)(prop.oneOf[0]);
+    }
+    else if (prop.anyOf) {
+        obj[name] = (0, exports.sampleRequestFromSchema)(prop.anyOf[0]);
+    }
+    else if (prop.allOf) {
+        const mergedSchemas = (0, createSchema_1.mergeAllOf)(prop);
+        sampleRequestFromProp(name, mergedSchemas, obj);
+    }
+    else {
+        obj[name] = (0, exports.sampleRequestFromSchema)(prop);
+    }
+    return obj;
+}
+const sampleRequestFromSchema = (schema = {}) => {
+    try {
+        // deep copy schema before processing
+        let schemaCopy = JSON.parse(JSON.stringify(schema));
+        let { type, example, allOf, properties, items, oneOf, anyOf } = schemaCopy;
+        if (example !== undefined) {
+            return example;
+        }
+        if (oneOf) {
+            if (properties) {
+                const combinedSchemas = (0, merge_1.default)(schemaCopy, oneOf[0]);
+                delete combinedSchemas.oneOf;
+                return (0, exports.sampleRequestFromSchema)(combinedSchemas);
+            }
+            // Just go with first schema
+            return (0, exports.sampleRequestFromSchema)(oneOf[0]);
+        }
+        if (anyOf) {
+            if (properties) {
+                const combinedSchemas = (0, merge_1.default)(schemaCopy, anyOf[0]);
+                delete combinedSchemas.anyOf;
+                return (0, exports.sampleRequestFromSchema)(combinedSchemas);
+            }
+            // Just go with first schema
+            return (0, exports.sampleRequestFromSchema)(anyOf[0]);
+        }
+        if (allOf) {
+            const mergedSchemas = (0, createSchema_1.mergeAllOf)(schemaCopy);
+            if (mergedSchemas.properties) {
+                for (const [key, value] of Object.entries(mergedSchemas.properties)) {
+                    if ((value.readOnly && value.readOnly === true) || value.deprecated) {
+                        delete mergedSchemas.properties[key];
+                    }
+                }
+            }
+            if (properties) {
+                const combinedSchemas = (0, merge_1.default)(schemaCopy, mergedSchemas);
+                delete combinedSchemas.allOf;
+                return (0, exports.sampleRequestFromSchema)(combinedSchemas);
+            }
+            return (0, exports.sampleRequestFromSchema)(mergedSchemas);
+        }
+        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.properties) {
+                    for (const [key, value] of Object.entries(prop.properties)) {
+                        if ((value.readOnly && value.readOnly === true) ||
+                            value.deprecated) {
+                            delete prop.properties[key];
+                        }
+                    }
+                }
+                if (prop.items && prop.items.properties) {
+                    for (const [key, value] of Object.entries(prop.items.properties)) {
+                        if ((value.readOnly && value.readOnly === true) ||
+                            value.deprecated) {
+                            delete prop.items.properties[key];
+                        }
+                    }
+                }
+                if (prop.readOnly && prop.readOnly === true) {
+                    continue;
+                }
+                if (prop.deprecated) {
+                    continue;
+                }
+                // Resolve schema from prop recursively
+                obj = sampleRequestFromProp(name, prop, 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.sampleRequestFromSchema)(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.sampleRequestFromSchema)(item));
+            }
+            return normalizeArray((0, exports.sampleRequestFromSchema)(items));
+        }
+        if (schemaCopy.enum) {
+            if (schemaCopy.default) {
+                return schemaCopy.default;
+            }
+            return normalizeArray(schemaCopy.enum)[0];
+        }
+        if ((schema.readOnly && schema.readOnly === true) ||
+            schemaCopy.deprecated) {
+            return undefined;
+        }
+        return primitive(schemaCopy);
+    }
+    catch (err) {
+        console.error(chalk_1.default.yellow("WARNING: failed to create example from schema object:", err));
+        return;
+    }
+};
+exports.sampleRequestFromSchema = sampleRequestFromSchema;
+function primitive(schema = {}) {
+    let { type, format } = schema;
+    if (type === undefined) {
+        return;
+    }
+    let fn = schema.default ? () => schema.default : primitives[type].default;
+    if (format !== undefined) {
+        fn = primitives[type][format] || fn;
+    }
+    if (fn) {
+        return fn(schema);
+    }
+    return "Unknown Type: " + schema.type;
+}
+function normalizeArray(arr) {
+    if (Array.isArray(arr)) {
+        return arr;
+    }
+    return [arr];
+}

package/lib/openapi/createResponseExample.d.ts

@@ -0,0 +1,2 @@
+import { SchemaObject } from "./types";
+export declare const sampleResponseFromSchema: (schema?: SchemaObject) => any;

package/lib/openapi/createResponseExample.js

@@ -0,0 +1,192 @@
+"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.
+ * ========================================================================== */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sampleResponseFromSchema = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const merge_1 = __importDefault(require("lodash/merge"));
+const createSchema_1 = require("../markdown/createSchema");
+const primitives = {
+    string: {
+        default: () => "string",
+        email: () => "user@example.com",
+        date: () => "2024-07-29",
+        "date-time": () => "2024-07-29T15:51:28.071Z",
+        uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+        hostname: () => "example.com",
+        ipv4: () => "198.51.100.42",
+        ipv6: () => "2001:0db8:5b96:0000:0000:426f:8e17:642a",
+    },
+    number: {
+        default: () => 0,
+        float: () => 0.0,
+    },
+    integer: {
+        default: () => 0,
+    },
+    boolean: {
+        default: (schema) => typeof schema.default === "boolean" ? schema.default : true,
+    },
+    object: {},
+    array: {},
+};
+function sampleResponseFromProp(name, prop, obj) {
+    // Handle resolved circular props
+    if (typeof prop === "object" && Object.keys(prop).length === 0) {
+        obj[name] = prop;
+        return obj;
+    }
+    // TODO: handle discriminators
+    if (prop.oneOf) {
+        obj[name] = (0, exports.sampleResponseFromSchema)(prop.oneOf[0]);
+    }
+    else if (prop.anyOf) {
+        obj[name] = (0, exports.sampleResponseFromSchema)(prop.anyOf[0]);
+    }
+    else if (prop.allOf) {
+        const mergedSchemas = (0, createSchema_1.mergeAllOf)(prop);
+        sampleResponseFromProp(name, mergedSchemas, obj);
+    }
+    else {
+        obj[name] = (0, exports.sampleResponseFromSchema)(prop);
+    }
+    return obj;
+}
+const sampleResponseFromSchema = (schema = {}) => {
+    try {
+        // deep copy schema before processing
+        let schemaCopy = JSON.parse(JSON.stringify(schema));
+        let { type, example, allOf, properties, items, oneOf, anyOf } = schemaCopy;
+        if (example !== undefined) {
+            return example;
+        }
+        if (allOf) {
+            const mergedSchemas = (0, createSchema_1.mergeAllOf)(schemaCopy);
+            if (mergedSchemas.properties) {
+                for (const [key, value] of Object.entries(mergedSchemas.properties)) {
+                    if ((value.writeOnly && value.writeOnly === true) ||
+                        value.deprecated) {
+                        delete mergedSchemas.properties[key];
+                    }
+                }
+            }
+            if (properties) {
+                const combinedSchemas = (0, merge_1.default)(schemaCopy, mergedSchemas);
+                delete combinedSchemas.allOf;
+                return (0, exports.sampleResponseFromSchema)(combinedSchemas);
+            }
+            return (0, exports.sampleResponseFromSchema)(mergedSchemas);
+        }
+        if (oneOf) {
+            if (properties) {
+                const combinedSchemas = (0, merge_1.default)(schemaCopy, oneOf[0]);
+                delete combinedSchemas.oneOf;
+                return (0, exports.sampleResponseFromSchema)(combinedSchemas);
+            }
+            // Just go with first schema
+            return (0, exports.sampleResponseFromSchema)(oneOf[0]);
+        }
+        if (anyOf) {
+            if (properties) {
+                const combinedSchemas = (0, merge_1.default)(schemaCopy, anyOf[0]);
+                delete combinedSchemas.anyOf;
+                return (0, exports.sampleResponseFromSchema)(combinedSchemas);
+            }
+            // Just go with first schema
+            return (0, exports.sampleResponseFromSchema)(anyOf[0]);
+        }
+        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.properties) {
+                    for (const [key, value] of Object.entries(prop.properties)) {
+                        if ((value.writeOnly && value.writeOnly === true) ||
+                            value.deprecated) {
+                            delete prop.properties[key];
+                        }
+                    }
+                }
+                if (prop.items && prop.items.properties) {
+                    for (const [key, value] of Object.entries(prop.items.properties)) {
+                        if ((value.writeOnly && value.writeOnly === true) ||
+                            value.deprecated) {
+                            delete prop.items.properties[key];
+                        }
+                    }
+                }
+                if (prop.writeOnly && prop.writeOnly === true) {
+                    continue;
+                }
+                if (prop.deprecated) {
+                    continue;
+                }
+                // Resolve schema from prop recursively
+                obj = sampleResponseFromProp(name, prop, 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.sampleResponseFromSchema)(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.sampleResponseFromSchema)(item));
+            }
+            return [(0, exports.sampleResponseFromSchema)(items)];
+        }
+        if (schemaCopy.enum) {
+            if (schemaCopy.default) {
+                return schemaCopy.default;
+            }
+            return normalizeArray(schemaCopy.enum)[0];
+        }
+        if ((schemaCopy.writeOnly && schemaCopy.writeOnly === true) ||
+            schemaCopy.deprecated) {
+            return undefined;
+        }
+        return primitive(schemaCopy);
+    }
+    catch (err) {
+        console.error(chalk_1.default.yellow("WARNING: failed to create example from schema object:", err));
+        return;
+    }
+};
+exports.sampleResponseFromSchema = sampleResponseFromSchema;
+function primitive(schema = {}) {
+    let { type, format } = schema;
+    if (type === undefined) {
+        return;
+    }
+    let fn = schema.default ? () => schema.default : primitives[type].default;
+    if (format !== undefined) {
+        fn = primitives[type][format] || fn;
+    }
+    if (fn) {
+        return fn(schema);
+    }
+    return "Unknown Type: " + schema.type;
+}
+function normalizeArray(arr) {
+    if (Array.isArray(arr)) {
+        return arr;
+    }
+    return [arr];
+}

package/lib/openapi/index.d.ts

@@ -0,0 +1 @@
+export { readOpenapiFiles, processOpenapiFiles } from "./openapi";

package/lib/openapi/index.js

@@ -0,0 +1,12 @@
+"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.processOpenapiFiles = exports.readOpenapiFiles = void 0;
+var openapi_1 = require("./openapi");
+Object.defineProperty(exports, "readOpenapiFiles", { enumerable: true, get: function () { return openapi_1.readOpenapiFiles; } });
+Object.defineProperty(exports, "processOpenapiFiles", { enumerable: true, get: function () { return openapi_1.processOpenapiFiles; } });

package/lib/openapi/openapi.d.ts

@@ -0,0 +1,12 @@
+import { OpenApiObject, TagGroupObject, TagObject } from "./types";
+import { ApiMetadata, APIOptions, SidebarOptions } from "../types";
+interface OpenApiFiles {
+    source: string;
+    sourceDirName: string;
+    data: OpenApiObject;
+}
+export declare function readOpenapiFiles(openapiPath: string): Promise<OpenApiFiles[]>;
+export declare function processOpenapiFiles(files: OpenApiFiles[], options: APIOptions, sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[][], TagGroupObject[]]>;
+export declare function processOpenapiFile(openapiData: OpenApiObject, options: APIOptions, sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[], TagGroupObject[]]>;
+export declare function getTagDisplayName(tagName: string, tags: TagObject[]): string;
+export {};