docusaurus-plugin-openapi-docs 4.0.0 → 4.1.0

package/lib/options.js

@@ -8,12 +8,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OptionsSchema = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
+const sidebarGenerators = utils_validation_1.Joi.object({
+    createDocItem: utils_validation_1.Joi.function(),
+});
 const sidebarOptions = utils_validation_1.Joi.object({
     groupPathsBy: utils_validation_1.Joi.string().valid("tag", "tagGroup"),
     categoryLinkSource: utils_validation_1.Joi.string().valid("tag", "info", "auto"),
     customProps: utils_validation_1.Joi.object(),
     sidebarCollapsible: utils_validation_1.Joi.boolean(),
     sidebarCollapsed: utils_validation_1.Joi.boolean(),
+    sidebarGenerators: sidebarGenerators,
 });
 const markdownGenerators = utils_validation_1.Joi.object({
     createApiPageMD: utils_validation_1.Joi.function(),

package/lib/sidebars/index.js

@@ -23,11 +23,33 @@ function isInfoItem(item) {
 function isSchemaItem(item) {
     return item.type === "schema";
 }
+const createDocItem = (item, { sidebarOptions: { customProps }, basePath }) => {
+    var _a, _b;
+    const sidebar_label = item.frontMatter.sidebar_label;
+    const title = item.title;
+    const id = item.type === "schema" ? `schemas/${item.id}` : item.id;
+    const className = item.type === "api"
+        ? (0, clsx_1.default)({
+            "menu__list-item--deprecated": item.api.deprecated,
+            "api-method": !!item.api.method,
+        }, item.api.method)
+        : (0, clsx_1.default)({
+            "menu__list-item--deprecated": item.schema.deprecated,
+        }, "schema");
+    return {
+        type: "doc",
+        id: basePath === "" || undefined ? `${id}` : `${basePath}/${id}`,
+        label: (_b = (_a = sidebar_label) !== null && _a !== void 0 ? _a : title) !== null && _b !== void 0 ? _b : id,
+        customProps: customProps,
+        className: className ? className : undefined,
+    };
+};
 function groupByTags(items, sidebarOptions, options, tags, docPath) {
+    var _a, _b;
     let { outputDir, label, showSchemas } = options;
     // Remove trailing slash before proceeding
     outputDir = outputDir.replace(/\/$/, "");
-    const { sidebarCollapsed, sidebarCollapsible, customProps, categoryLinkSource, } = sidebarOptions;
+    const { sidebarCollapsed, sidebarCollapsible, categoryLinkSource } = sidebarOptions;
     const apiItems = items.filter(isApiItem);
     const infoItems = items.filter(isInfoItem);
     const schemaItems = items.filter(isSchemaItem);
@@ -61,27 +83,11 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
     const basePath = docPath
         ? outputDir.split(docPath)[1].replace(/^\/+/g, "")
         : outputDir.slice(outputDir.indexOf("/", 1)).replace(/^\/+/g, "");
-    function createDocItem(item) {
-        var _a, _b;
-        const sidebar_label = item.frontMatter.sidebar_label;
-        const title = item.title;
-        const id = item.type === "schema" ? `schemas/${item.id}` : item.id;
-        const className = item.type === "api"
-            ? (0, clsx_1.default)({
-                "menu__list-item--deprecated": item.api.deprecated,
-                "api-method": !!item.api.method,
-            }, item.api.method)
-            : (0, clsx_1.default)({
-                "menu__list-item--deprecated": item.schema.deprecated,
-            }, "schema");
-        return {
-            type: "doc",
-            id: basePath === "" || undefined ? `${id}` : `${basePath}/${id}`,
-            label: (_b = (_a = sidebar_label) !== null && _a !== void 0 ? _a : title) !== null && _b !== void 0 ? _b : id,
-            customProps: customProps,
-            className: className ? className : undefined,
-        };
-    }
+    const createDocItemFnContext = {
+        sidebarOptions,
+        basePath,
+    };
+    const createDocItemFn = (_b = (_a = sidebarOptions.sidebarGenerators) === null || _a === void 0 ? void 0 : _a.createDocItem) !== null && _b !== void 0 ? _b : createDocItem;
     let rootIntroDoc = undefined;
     if (infoItems.length === 1) {
         const infoItem = infoItems[0];
@@ -139,14 +145,14 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
             link: linkConfig,
             collapsible: sidebarCollapsible,
             collapsed: sidebarCollapsed,
-            items: [...taggedSchemaItems, ...taggedApiItems].map(createDocItem),
+            items: [...taggedSchemaItems, ...taggedApiItems].map((item) => createDocItemFn(item, createDocItemFnContext)),
         };
     })
         .filter((item) => item.items.length > 0); // Filter out any categories with no items.
     // Handle items with no tag
     const untaggedItems = apiItems
         .filter(({ api }) => api.tags === undefined || api.tags.length === 0)
-        .map(createDocItem);
+        .map((item) => createDocItemFn(item, createDocItemFnContext));
     let untagged = [];
     if (untaggedItems.length > 0) {
         untagged = [
@@ -157,7 +163,7 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
                 collapsed: sidebarCollapsed,
                 items: apiItems
                     .filter(({ api }) => api.tags === undefined || api.tags.length === 0)
-                    .map(createDocItem),
+                    .map((item) => createDocItemFn(item, createDocItemFnContext)),
             },
         ];
     }
@@ -171,7 +177,7 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
                 collapsed: sidebarCollapsed,
                 items: schemaItems
                     .filter(({ schema }) => !schema["x-tags"])
-                    .map(createDocItem),
+                    .map((item) => createDocItemFn(item, createDocItemFnContext)),
             },
         ];
     }

package/lib/types.d.ts

@@ -1,3 +1,4 @@
+import { SidebarItemDoc } from "@docusaurus/plugin-content-docs/src/sidebars/types";
 import type Request from "postman-collection";
 import { InfoObject, OperationObject, SchemaObject, SecuritySchemeObject, TagObject } from "./openapi/types";
 export type { PropSidebarItemCategory, SidebarItemLink, PropSidebar, PropSidebarItem, } from "@docusaurus/plugin-content-docs-types";
@@ -34,6 +35,13 @@ export interface MarkdownGenerator {
     createTagPageMD?: (pageData: TagPageMetadata) => string;
     createSchemaPageMD?: (pageData: SchemaPageMetadata) => string;
 }
+export type ApiDocItemGenerator = (item: ApiPageMetadata | SchemaPageMetadata, context: {
+    sidebarOptions: SidebarOptions;
+    basePath: string;
+}) => SidebarItemDoc;
+export interface SidebarGenerators {
+    createDocItem?: ApiDocItemGenerator;
+}
 export interface SidebarOptions {
     groupPathsBy?: string;
     categoryLinkSource?: "info" | "tag" | "auto";
@@ -42,6 +50,7 @@ export interface SidebarOptions {
     };
     sidebarCollapsible?: boolean;
     sidebarCollapsed?: boolean;
+    sidebarGenerators?: SidebarGenerators;
 }
 export interface APIVersionOptions {
     specPath: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -28,7 +28,7 @@
     "watch": "tsc --watch"
   },
   "devDependencies": {
-    "@docusaurus/types": "^3.0.1",
+    "@docusaurus/types": "^3.5.0",
     "@types/fs-extra": "^9.0.13",
     "@types/json-pointer": "^1.0.31",
     "@types/json-schema": "^7.0.9",
@@ -38,9 +38,9 @@
   },
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^11.5.4",
-    "@docusaurus/plugin-content-docs": "^3.0.1",
-    "@docusaurus/utils": "^3.0.1",
-    "@docusaurus/utils-validation": "^3.0.1",
+    "@docusaurus/plugin-content-docs": "^3.5.0",
+    "@docusaurus/utils": "^3.5.0",
+    "@docusaurus/utils-validation": "^3.5.0",
     "@redocly/openapi-core": "^1.10.5",
     "chalk": "^4.1.2",
     "clsx": "^1.1.1",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "79d74177cfd54d2750dde1e15c6ea166f9ca4be9"
+  "gitHead": "4e771d309f6defe395449b26cc3c65814d72cbcc"
 }