docusaurus-plugin-openapi-docs 0.0.0-610 → 0.0.0-611

package/lib/index.js

@@ -76,7 +76,8 @@ function pluginOpenAPIDocs(context, options) {
     let docRouteBasePath = docData ? docData.routeBasePath : undefined;
     let docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
     async function generateApiDocs(options, pluginId) {
-        let { specPath, outputDir, template, downloadUrl, sidebarOptions } = options;
+        var _a, _b, _c;
+        let { specPath, outputDir, template, markdownGenerators, downloadUrl, sidebarOptions, } = options;
         // Remove trailing slash before proceeding
         outputDir = outputDir.replace(/\/$/, "");
         // Override docPath if pluginId provided
@@ -193,6 +194,9 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
 <DocCardList items={useCurrentSidebarCategory().items}/>
 \`\`\`
       `;
+            const apiPageGenerator = (_a = markdownGenerators === null || markdownGenerators === void 0 ? void 0 : markdownGenerators.createApiPageMD) !== null && _a !== void 0 ? _a : markdown_1.createApiPageMD;
+            const infoPageGenerator = (_b = markdownGenerators === null || markdownGenerators === void 0 ? void 0 : markdownGenerators.createInfoPageMD) !== null && _b !== void 0 ? _b : markdown_1.createInfoPageMD;
+            const tagPageGenerator = (_c = markdownGenerators === null || markdownGenerators === void 0 ? void 0 : markdownGenerators.createTagPageMD) !== null && _c !== void 0 ? _c : markdown_1.createTagPageMD;
             loadedApi.map(async (item) => {
                 if (item.type === "info") {
                     if (downloadUrl && isURL(downloadUrl)) {
@@ -200,10 +204,10 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                     }
                 }
                 const markdown = item.type === "api"
-                    ? (0, markdown_1.createApiPageMD)(item)
+                    ? apiPageGenerator(item)
                     : item.type === "info"
-                        ? (0, markdown_1.createInfoPageMD)(item)
-                        : (0, markdown_1.createTagPageMD)(item);
+                        ? infoPageGenerator(item)
+                        : tagPageGenerator(item);
                 item.markdown = markdown;
                 if (item.type === "api") {
                     item.json = JSON.stringify(item.api);

package/lib/options.js

@@ -16,6 +16,11 @@ const sidebarOptions = utils_validation_1.Joi.object({
     sidebarCollapsible: utils_validation_1.Joi.boolean(),
     sidebarCollapsed: utils_validation_1.Joi.boolean(),
 });
+const markdownGenerators = utils_validation_1.Joi.object({
+    createApiPageMD: utils_validation_1.Joi.function(),
+    createInfoPageMD: utils_validation_1.Joi.function(),
+    createTagPageMD: utils_validation_1.Joi.function(),
+});
 exports.OptionsSchema = utils_validation_1.Joi.object({
     id: utils_validation_1.Joi.string().required(),
     docsPluginId: utils_validation_1.Joi.string().required(),
@@ -29,6 +34,7 @@ exports.OptionsSchema = utils_validation_1.Joi.object({
         hideSendButton: utils_validation_1.Joi.boolean(),
         showExtensions: utils_validation_1.Joi.boolean(),
         sidebarOptions: sidebarOptions,
+        markdownGenerators: markdownGenerators,
         version: utils_validation_1.Joi.string().when("versions", {
             is: utils_validation_1.Joi.exist(),
             then: utils_validation_1.Joi.required(),

package/lib/types.d.ts

@@ -23,6 +23,12 @@ export interface APIOptions {
         [key: string]: APIVersionOptions;
     };
     proxy?: string;
+    markdownGenerators?: MarkdownGenerator;
+}
+export interface MarkdownGenerator {
+    createApiPageMD?: (pageData: ApiPageMetadata) => string;
+    createInfoPageMD?: (pageData: InfoPageMetadata) => string;
+    createTagPageMD?: (pageData: TagPageMetadata) => string;
 }
 export interface SidebarOptions {
     groupPathsBy?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-610",
+  "version": "0.0.0-611",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "e1bfc00030919d78230eb2309bc491a039b465dc"
+  "gitHead": "1b35ad875493d06bd7028ceac72c963ecea21c25"
 }

package/src/index.ts

@@ -91,8 +91,14 @@ export default function pluginOpenAPIDocs(
   let docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
 
   async function generateApiDocs(options: APIOptions, pluginId: any) {
-    let { specPath, outputDir, template, downloadUrl, sidebarOptions } =
-      options;
+    let {
+      specPath,
+      outputDir,
+      template,
+      markdownGenerators,
+      downloadUrl,
+      sidebarOptions,
+    } = options;
 
     // Remove trailing slash before proceeding
     outputDir = outputDir.replace(/\/$/, "");
@@ -237,6 +243,13 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
 \`\`\`
       `;
 
+      const apiPageGenerator =
+        markdownGenerators?.createApiPageMD ?? createApiPageMD;
+      const infoPageGenerator =
+        markdownGenerators?.createInfoPageMD ?? createInfoPageMD;
+      const tagPageGenerator =
+        markdownGenerators?.createTagPageMD ?? createTagPageMD;
+
       loadedApi.map(async (item) => {
         if (item.type === "info") {
           if (downloadUrl && isURL(downloadUrl)) {
@@ -245,10 +258,10 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
         }
         const markdown =
           item.type === "api"
-            ? createApiPageMD(item)
+            ? apiPageGenerator(item)
             : item.type === "info"
-            ? createInfoPageMD(item)
-            : createTagPageMD(item);
+            ? infoPageGenerator(item)
+            : tagPageGenerator(item);
         item.markdown = markdown;
         if (item.type === "api") {
           item.json = JSON.stringify(item.api);

package/src/options.ts

@@ -16,6 +16,12 @@ const sidebarOptions = Joi.object({
   sidebarCollapsed: Joi.boolean(),
 });
 
+const markdownGenerators = Joi.object({
+  createApiPageMD: Joi.function(),
+  createInfoPageMD: Joi.function(),
+  createTagPageMD: Joi.function(),
+});
+
 export const OptionsSchema = Joi.object({
   id: Joi.string().required(),
   docsPluginId: Joi.string().required(),
@@ -31,6 +37,7 @@ export const OptionsSchema = Joi.object({
         hideSendButton: Joi.boolean(),
         showExtensions: Joi.boolean(),
         sidebarOptions: sidebarOptions,
+        markdownGenerators: markdownGenerators,
         version: Joi.string().when("versions", {
           is: Joi.exist(),
           then: Joi.required(),

package/src/types.ts

@@ -43,6 +43,13 @@ export interface APIOptions {
     [key: string]: APIVersionOptions;
   };
   proxy?: string;
+  markdownGenerators?: MarkdownGenerator;
+}
+
+export interface MarkdownGenerator {
+  createApiPageMD?: (pageData: ApiPageMetadata) => string;
+  createInfoPageMD?: (pageData: InfoPageMetadata) => string;
+  createTagPageMD?: (pageData: TagPageMetadata) => string;
 }
 
 export interface SidebarOptions {