docusaurus-plugin-openapi-docs 4.7.0 → 5.0.0

package/lib/openapi/utils/utils/openapi.js

@@ -22,8 +22,6 @@ exports.getSerializedValue = getSerializedValue;
 exports.langFromMime = langFromMime;
 exports.isNamedDefinition = isNamedDefinition;
 exports.getDefinitionName = getDefinitionName;
-exports.humanizeNumberRange = humanizeNumberRange;
-exports.humanizeConstraints = humanizeConstraints;
 exports.sortByRequired = sortByRequired;
 exports.sortByField = sortByField;
 exports.mergeParams = mergeParams;
@@ -366,86 +364,6 @@ function getDefinitionName(pointer) {
     const [name] = ((_a = pointer === null || pointer === void 0 ? void 0 : pointer.match(DEFINITION_NAME_REGEX)) === null || _a === void 0 ? void 0 : _a.reverse()) || [];
     return name;
 }
-function humanizeMultipleOfConstraint(multipleOf) {
-    if (multipleOf === undefined) {
-        return;
-    }
-    const strigifiedMultipleOf = multipleOf.toString(10);
-    if (!/^0\.0*1$/.test(strigifiedMultipleOf)) {
-        return `multiple of ${strigifiedMultipleOf}`;
-    }
-    return `decimal places <= ${strigifiedMultipleOf.split(".")[1].length}`;
-}
-function humanizeRangeConstraint(description, min, max) {
-    let stringRange;
-    if (min !== undefined && max !== undefined) {
-        if (min === max) {
-            stringRange = `= ${min} ${description}`;
-        }
-        else {
-            stringRange = `[ ${min} .. ${max} ] ${description}`;
-        }
-    }
-    else if (max !== undefined) {
-        stringRange = `<= ${max} ${description}`;
-    }
-    else if (min !== undefined) {
-        if (min === 1) {
-            stringRange = "non-empty";
-        }
-        else {
-            stringRange = `>= ${min} ${description}`;
-        }
-    }
-    return stringRange;
-}
-function humanizeNumberRange(schema) {
-    var _a, _b;
-    const minimum = typeof schema.exclusiveMinimum === "number"
-        ? Math.min(schema.exclusiveMinimum, (_a = schema.minimum) !== null && _a !== void 0 ? _a : Infinity)
-        : schema.minimum;
-    const maximum = typeof schema.exclusiveMaximum === "number"
-        ? Math.max(schema.exclusiveMaximum, (_b = schema.maximum) !== null && _b !== void 0 ? _b : -Infinity)
-        : schema.maximum;
-    const exclusiveMinimum = typeof schema.exclusiveMinimum === "number" || schema.exclusiveMinimum;
-    const exclusiveMaximum = typeof schema.exclusiveMaximum === "number" || schema.exclusiveMaximum;
-    if (minimum !== undefined && maximum !== undefined) {
-        return `${exclusiveMinimum ? "( " : "[ "}${minimum} .. ${maximum}${exclusiveMaximum ? " )" : " ]"}`;
-    }
-    else if (maximum !== undefined) {
-        return `${exclusiveMaximum ? "< " : "<= "}${maximum}`;
-    }
-    else if (minimum !== undefined) {
-        return `${exclusiveMinimum ? "> " : ">= "}${minimum}`;
-    }
-}
-function humanizeConstraints(schema) {
-    const res = [];
-    const stringRange = humanizeRangeConstraint("characters", schema.minLength, schema.maxLength);
-    if (stringRange !== undefined) {
-        res.push(stringRange);
-    }
-    const arrayRange = humanizeRangeConstraint("items", schema.minItems, schema.maxItems);
-    if (arrayRange !== undefined) {
-        res.push(arrayRange);
-    }
-    const propertiesRange = humanizeRangeConstraint("properties", schema.minProperties, schema.maxProperties);
-    if (propertiesRange !== undefined) {
-        res.push(propertiesRange);
-    }
-    const multipleOfConstraint = humanizeMultipleOfConstraint(schema.multipleOf);
-    if (multipleOfConstraint !== undefined) {
-        res.push(multipleOfConstraint);
-    }
-    const numberRange = humanizeNumberRange(schema);
-    if (numberRange !== undefined) {
-        res.push(numberRange);
-    }
-    if (schema.uniqueItems) {
-        res.push("unique");
-    }
-    return res;
-}
 function sortByRequired(fields, order = []) {
     const unrequiredFields = [];
     const orderedFields = [];

package/lib/sidebars/index.js

@@ -45,7 +45,7 @@ const createDocItem = (item, { sidebarOptions: { customProps }, basePath }) => {
         className: className ? className : undefined,
     };
 };
-function groupByTags(items, sidebarOptions, options, tags, docPath) {
+function groupByTags(items, sidebarOptions, options, tags, docPath, tagGroupKey) {
     var _a, _b;
     let { outputDir, label, showSchemas } = options;
     // Remove trailing slash before proceeding
@@ -83,9 +83,8 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
     }
     // Extract base path from outputDir, handling cases where docPath may not be in outputDir
     const getBasePathFromOutput = (output, doc) => {
-        var _a, _b;
-        if (doc && output.includes(doc)) {
-            return (_b = (_a = output.split(doc)[1]) === null || _a === void 0 ? void 0 : _a.replace(/^\/+/g, "")) !== null && _b !== void 0 ? _b : "";
+        if (doc && output.startsWith(doc + "/")) {
+            return output.substring((doc + "/").length);
         }
         const slashIndex = output.indexOf("/", 1);
         return slashIndex === -1
@@ -102,9 +101,11 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
     if (infoItems.length === 1) {
         const infoItem = infoItems[0];
         const id = infoItem.id;
+        const docId = basePath === "" || undefined ? `${id}` : `${basePath}/${id}`;
         rootIntroDoc = {
             type: "doc",
-            id: basePath === "" || undefined ? `${id}` : `${basePath}/${id}`,
+            id: docId,
+            ...(tagGroupKey && { key: (0, lodash_1.kebabCase)(`${tagGroupKey}-${docId}`) }),
         };
     }
     const tagged = apiTags
@@ -146,13 +147,27 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
         }
         const taggedApiItems = apiItems.filter((item) => { var _a; return !!((_a = item.api.tags) === null || _a === void 0 ? void 0 : _a.includes(tag)); });
         const taggedSchemaItems = schemaItems.filter((item) => { var _a; return !!((_a = item.schema["x-tags"]) === null || _a === void 0 ? void 0 : _a.includes(tag)); });
+        const categoryLabel = (_a = tagObject === null || tagObject === void 0 ? void 0 : tagObject["x-displayName"]) !== null && _a !== void 0 ? _a : tag;
+        const categoryKey = tagGroupKey
+            ? (0, lodash_1.kebabCase)(`${tagGroupKey}-${categoryLabel}`)
+            : undefined;
         return {
             type: "category",
-            label: (_a = tagObject === null || tagObject === void 0 ? void 0 : tagObject["x-displayName"]) !== null && _a !== void 0 ? _a : tag,
+            label: categoryLabel,
+            ...(categoryKey && { key: categoryKey }),
             link: linkConfig,
             collapsible: sidebarCollapsible,
             collapsed: sidebarCollapsed,
-            items: [...taggedSchemaItems, ...taggedApiItems].map((item) => createDocItemFn(item, createDocItemFnContext)),
+            items: [...taggedSchemaItems, ...taggedApiItems].map((item) => {
+                const docItem = createDocItemFn(item, createDocItemFnContext);
+                if (tagGroupKey && docItem.type === "doc") {
+                    return {
+                        ...docItem,
+                        key: (0, lodash_1.kebabCase)(`${tagGroupKey}-${tag}-${docItem.id}`),
+                    };
+                }
+                return docItem;
+            }),
         };
     })
         .filter((item) => item.items.length > 0); // Filter out any categories with no items.
@@ -208,12 +223,13 @@ function generateSidebarSlice(sidebarOptions, options, api, tags, docPath, tagGr
                     filteredTags.push(tag);
                 }
             });
+            const tagGroupKey = (0, lodash_1.kebabCase)(tagGroup.name);
             const groupCategory = {
                 type: "category",
                 label: tagGroup.name,
                 collapsible: true,
                 collapsed: true,
-                items: groupByTags(api, sidebarOptions, options, [filteredTags], docPath),
+                items: groupByTags(api, sidebarOptions, options, [filteredTags], docPath, tagGroupKey),
             };
             if (options.showSchemas) {
                 // For the first tagGroup, save the generated "Schemas" category for later.

package/lib/sidebars/index.test.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.
+ * ========================================================================== */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = __importDefault(require("./index"));
+describe("generateSidebarSlice", () => {
+    describe("tagGroup with overlapping tags", () => {
+        const mockApiItems = [
+            {
+                type: "api",
+                id: "get-books",
+                unversionedId: "get-books",
+                title: "Get Books",
+                description: "",
+                source: "",
+                sourceDirName: "",
+                permalink: "/get-books",
+                frontMatter: {},
+                api: {
+                    method: "get",
+                    path: "/books",
+                    tags: ["Books", "Deprecated"],
+                    jsonRequestBodyExample: "",
+                    info: { title: "Test API", version: "1.0.0" },
+                },
+            },
+        ];
+        const mockTags = [
+            [
+                { name: "Books", description: "Book operations" },
+                { name: "Deprecated", description: "Deprecated endpoints" },
+            ],
+        ];
+        const mockTagGroups = [
+            { name: "Library", tags: ["Books"] },
+            { name: "Deprecation", tags: ["Deprecated"] },
+        ];
+        function collectKeys(obj) {
+            const keys = [];
+            JSON.stringify(obj, (k, v) => {
+                if (k === "key" && typeof v === "string") {
+                    keys.push(v);
+                }
+                return v;
+            });
+            return keys;
+        }
+        it("should generate unique keys for items appearing in multiple tagGroups", () => {
+            const result = (0, index_1.default)({ groupPathsBy: "tagGroup" }, { outputDir: "docs/test", specPath: "" }, mockApiItems, mockTags, "", mockTagGroups);
+            const keys = collectKeys(result);
+            expect(keys.length).toBeGreaterThan(0);
+            expect(new Set(keys).size).toBe(keys.length);
+        });
+        it("should include tagGroup name in keys to differentiate same items", () => {
+            const result = (0, index_1.default)({ groupPathsBy: "tagGroup" }, { outputDir: "docs/test", specPath: "" }, mockApiItems, mockTags, "", mockTagGroups);
+            const keys = collectKeys(result);
+            expect(keys.filter((k) => k.includes("library")).length).toBeGreaterThan(0);
+            expect(keys.filter((k) => k.includes("deprecation")).length).toBeGreaterThan(0);
+        });
+    });
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "4.7.0",
+  "version": "5.0.0",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -28,10 +28,10 @@
     "watch": "tsc --watch"
   },
   "devDependencies": {
-    "@docusaurus/plugin-content-docs": "^3.5.0",
-    "@docusaurus/types": "^3.5.0",
-    "@docusaurus/utils": "^3.5.0",
-    "@docusaurus/utils-validation": "^3.5.0",
+    "@docusaurus/plugin-content-docs": "^3.10.0",
+    "@docusaurus/types": "^3.10.0",
+    "@docusaurus/utils": "^3.10.0",
+    "@docusaurus/utils-validation": "^3.10.0",
     "@types/fs-extra": "^11.0.4",
     "@types/json-pointer": "^1.0.34",
     "@types/json-schema": "^7.0.15",
@@ -40,30 +40,30 @@
     "eslint-plugin-prettier": "^5.5.1"
   },
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^11.5.4",
-    "@redocly/openapi-core": "^1.34.3",
+    "@apidevtools/json-schema-ref-parser": "^15.3.3",
+    "@redocly/openapi-core": "^2.25.2",
     "allof-merge": "^0.6.6",
-    "chalk": "^4.1.2",
+    "chalk": "^5.6.2",
     "clsx": "^2.1.1",
     "fs-extra": "^11.3.0",
     "json-pointer": "^0.6.2",
     "json5": "^2.2.3",
     "lodash": "^4.17.21",
     "mustache": "^4.2.0",
-    "openapi-to-postmanv2": "^5.0.0",
+    "openapi-to-postmanv2": "^6.0.0",
     "postman-collection": "^5.0.2",
     "slugify": "^1.6.6",
     "swagger2openapi": "^7.0.8",
     "xml-formatter": "^3.6.6"
   },
   "peerDependencies": {
-    "@docusaurus/plugin-content-docs": "^3.5.0",
-    "@docusaurus/utils": "^3.5.0",
-    "@docusaurus/utils-validation": "^3.5.0",
+    "@docusaurus/plugin-content-docs": "^3.10.0",
+    "@docusaurus/utils": "^3.10.0",
+    "@docusaurus/utils-validation": "^3.10.0",
     "react": "^16.8.4 || ^17.0.0 || ^18.0.0 || ^19.0.0"
   },
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "f5829b8e478b0ee76344ba31edd67efdfea18990"
+  "gitHead": "516bd48c628fb16b7fe90d8f996168ab75ce5562"
 }

package/src/index.ts

@@ -764,7 +764,7 @@ custom_edit_url: null
           let targetDocsPluginId: any;
           if (pluginId) {
             try {
-              const pluginConfig = getPluginConfig(plugins, pluginId);
+              const pluginConfig = getPluginConfig(pluginInstances, pluginId);
               targetConfig = pluginConfig.config ?? {};
               targetDocsPluginId = pluginConfig.docsPluginId;
             } catch {
@@ -835,7 +835,7 @@ custom_edit_url: null
           let targetDocsPluginId: any;
           if (pluginId) {
             try {
-              const pluginConfig = getPluginConfig(plugins, pluginId);
+              const pluginConfig = getPluginConfig(pluginInstances, pluginId);
               targetConfig = pluginConfig.config ?? {};
               targetDocsPluginId = pluginConfig.docsPluginId;
             } catch {
@@ -933,7 +933,7 @@ custom_edit_url: null
           let targetConfig: any;
           if (pluginId) {
             try {
-              const pluginConfig = getPluginConfig(plugins, pluginId);
+              const pluginConfig = getPluginConfig(pluginInstances, pluginId);
               targetConfig = pluginConfig.config ?? {};
             } catch {
               console.error(
@@ -992,7 +992,7 @@ custom_edit_url: null
           let targetConfig: any;
           if (pluginId) {
             try {
-              const pluginConfig = getPluginConfig(plugins, pluginId);
+              const pluginConfig = getPluginConfig(pluginInstances, pluginId);
               targetConfig = pluginConfig.config ?? {};
             } catch {
               console.error(