docusaurus-plugin-openapi-docs 0.0.0-736 → 0.0.0-738

package/lib/markdown/createStatusCodes.js

@@ -275,7 +275,7 @@ function createStatusCodes({ label, id, responses }) {
                                     responseHeaders &&
                                         (0, createDetails_1.createDetails)({
                                             className: "openapi-markdown__details",
-                                            "data-collaposed": true,
+                                            "data-collapsed": true,
                                             open: false,
                                             style: { textAlign: "left", marginBottom: "1rem" },
                                             children: [

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

@@ -534,7 +534,7 @@ exports.setSecuritySchemePrefix = setSecuritySchemePrefix;
 const shortenHTTPVerb = (verb) => ({
     delete: "del",
     options: "opts",
-})[verb] || verb;
+}[verb] || verb);
 exports.shortenHTTPVerb = shortenHTTPVerb;
 function isRedocExtension(key) {
     const redocExtensions = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-736",
+  "version": "0.0.0-738",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "ac63a892a690324697897289720d42d4bd3989fa"
+  "gitHead": "4c48921ed3b574960f207d9f5ce8f9de6feab169"
 }

package/src/index.ts

@@ -41,7 +41,7 @@ export function isURL(str: string): boolean {
 export function getDocsPluginConfig(
   presetsPlugins: any[],
   plugin: string,
-  pluginId: string,
+  pluginId: string
 ): Object | undefined {
   // eslint-disable-next-line array-callback-return
   const filteredConfig = presetsPlugins.filter((data) => {
@@ -90,7 +90,7 @@ function getPluginInstances(plugins: any[]): any {
 
 export default function pluginOpenAPIDocs(
   context: LoadContext,
-  options: PluginOptions,
+  options: PluginOptions
 ): Plugin<LoadedContent> {
   const {
     config,
@@ -106,7 +106,7 @@ export default function pluginOpenAPIDocs(
   let docData: any = getDocsPluginConfig(
     presetsPlugins,
     docsPlugin,
-    docsPluginId,
+    docsPluginId
   );
   let docRouteBasePath = docData ? docData.routeBasePath : undefined;
   let docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
@@ -141,7 +141,7 @@ export default function pluginOpenAPIDocs(
       const [loadedApi, tags, tagGroups] = await processOpenapiFiles(
         openapiFiles,
         options,
-        sidebarOptions!,
+        sidebarOptions!
       );
       if (!fs.existsSync(outputDir)) {
         try {
@@ -150,7 +150,7 @@ export default function pluginOpenAPIDocs(
         } catch (err) {
           console.error(
             chalk.red(`Failed to create "${outputDir}"`),
-            chalk.yellow(err),
+            chalk.yellow(err)
           );
         }
       }
@@ -163,7 +163,7 @@ export default function pluginOpenAPIDocs(
           loadedApi,
           tags,
           docPath,
-          tagGroups,
+          tagGroups
         );
 
         const sidebarSliceTemplate = `module.exports = {{{slice}}};`;
@@ -176,12 +176,12 @@ export default function pluginOpenAPIDocs(
           try {
             fs.writeFileSync(`${outputDir}/sidebar.js`, view, "utf8");
             console.log(
-              chalk.green(`Successfully created "${outputDir}/sidebar.js"`),
+              chalk.green(`Successfully created "${outputDir}/sidebar.js"`)
             );
           } catch (err) {
             console.error(
               chalk.red(`Failed to write "${outputDir}/sidebar.js"`),
-              chalk.yellow(err),
+              chalk.yellow(err)
             );
           }
         }
@@ -295,7 +295,7 @@ custom_edit_url: null
             info: InfoPageMetadata;
             tag: TagPageMetadata;
             schema: SchemaPageMetadata;
-          }[key],
+          }[key]
         ) => string;
       } = {
         api: apiPageGenerator,
@@ -345,19 +345,19 @@ custom_edit_url: null
               // kebabCase(arg) returns 0-length string when arg is undefined
               if (item.id.length === 0) {
                 throw Error(
-                  "Operation must have summary or operationId defined",
+                  "Operation must have summary or operationId defined"
                 );
               }
               fs.writeFileSync(`${outputDir}/${item.id}.api.mdx`, view, "utf8");
               console.log(
                 chalk.green(
-                  `Successfully created "${outputDir}/${item.id}.api.mdx"`,
-                ),
+                  `Successfully created "${outputDir}/${item.id}.api.mdx"`
+                )
               );
             } catch (err) {
               console.error(
                 chalk.red(`Failed to write "${outputDir}/${item.id}.api.mdx"`),
-                chalk.yellow(err),
+                chalk.yellow(err)
               );
             }
           }
@@ -371,22 +371,22 @@ custom_edit_url: null
                 ? fs.writeFileSync(
                     `${outputDir}/${item.id}.info.mdx`,
                     utils,
-                    "utf8",
+                    "utf8"
                   )
                 : fs.writeFileSync(
                     `${outputDir}/${item.id}.info.mdx`,
                     view,
-                    "utf8",
+                    "utf8"
                   );
               console.log(
                 chalk.green(
-                  `Successfully created "${outputDir}/${item.id}.info.mdx"`,
-                ),
+                  `Successfully created "${outputDir}/${item.id}.info.mdx"`
+                )
               );
             } catch (err) {
               console.error(
                 chalk.red(`Failed to write "${outputDir}/${item.id}.info.mdx"`),
-                chalk.yellow(err),
+                chalk.yellow(err)
               );
             }
           }
@@ -398,17 +398,17 @@ custom_edit_url: null
               fs.writeFileSync(
                 `${outputDir}/${item.id}.tag.mdx`,
                 tagUtils,
-                "utf8",
+                "utf8"
               );
               console.log(
                 chalk.green(
-                  `Successfully created "${outputDir}/${item.id}.tag.mdx"`,
-                ),
+                  `Successfully created "${outputDir}/${item.id}.tag.mdx"`
+                )
               );
             } catch (err) {
               console.error(
                 chalk.red(`Failed to write "${outputDir}/${item.id}.tag.mdx"`),
-                chalk.yellow(err),
+                chalk.yellow(err)
               );
             }
           }
@@ -420,12 +420,12 @@ custom_edit_url: null
               try {
                 fs.mkdirSync(`${outputDir}/schemas`, { recursive: true });
                 console.log(
-                  chalk.green(`Successfully created "${outputDir}/schemas"`),
+                  chalk.green(`Successfully created "${outputDir}/schemas"`)
                 );
               } catch (err) {
                 console.error(
                   chalk.red(`Failed to create "${outputDir}/schemas"`),
-                  chalk.yellow(err),
+                  chalk.yellow(err)
                 );
               }
             }
@@ -439,19 +439,19 @@ custom_edit_url: null
               fs.writeFileSync(
                 `${outputDir}/schemas/${item.id}.schema.mdx`,
                 schemaView,
-                "utf8",
+                "utf8"
               );
               console.log(
                 chalk.green(
-                  `Successfully created "${outputDir}/${item.id}.schema.mdx"`,
-                ),
+                  `Successfully created "${outputDir}/${item.id}.schema.mdx"`
+                )
               );
             } catch (err) {
               console.error(
                 chalk.red(
-                  `Failed to write "${outputDir}/${item.id}.schema.mdx"`,
+                  `Failed to write "${outputDir}/${item.id}.schema.mdx"`
                 ),
-                chalk.yellow(err),
+                chalk.yellow(err)
               );
             }
           }
@@ -486,12 +486,12 @@ custom_edit_url: null
         if (err) {
           console.error(
             chalk.red(`Cleanup failed for "${apiDir}/${mdx}"`),
-            chalk.yellow(err),
+            chalk.yellow(err)
           );
         } else {
           console.log(chalk.green(`Cleanup succeeded for "${apiDir}/${mdx}"`));
         }
-      }),
+      })
     );
 
     schemaMdxFiles.map((mdx) =>
@@ -499,14 +499,14 @@ custom_edit_url: null
         if (err) {
           console.error(
             chalk.red(`Cleanup failed for "${apiDir}/schemas/${mdx}"`),
-            chalk.yellow(err),
+            chalk.yellow(err)
           );
         } else {
           console.log(
-            chalk.green(`Cleanup succeeded for "${apiDir}/schemas/${mdx}"`),
+            chalk.green(`Cleanup succeeded for "${apiDir}/schemas/${mdx}"`)
           );
         }
-      }),
+      })
     );
 
     sidebarFile.map((sidebar) =>
@@ -514,14 +514,14 @@ custom_edit_url: null
         if (err) {
           console.error(
             chalk.red(`Cleanup failed for "${apiDir}/${sidebar}"`),
-            chalk.yellow(err),
+            chalk.yellow(err)
           );
         } else {
           console.log(
-            chalk.green(`Cleanup succeeded for "${apiDir}/${sidebar}"`),
+            chalk.green(`Cleanup succeeded for "${apiDir}/${sidebar}"`)
           );
         }
-      }),
+      })
     );
   }
 
@@ -540,12 +540,12 @@ custom_edit_url: null
     try {
       fs.writeFileSync(`${outputDir}/versions.json`, versionsJson, "utf8");
       console.log(
-        chalk.green(`Successfully created "${outputDir}/versions.json"`),
+        chalk.green(`Successfully created "${outputDir}/versions.json"`)
       );
     } catch (err) {
       console.error(
         chalk.red(`Failed to write "${outputDir}/versions.json"`),
-        chalk.yellow(err),
+        chalk.yellow(err)
       );
     }
   }
@@ -556,11 +556,11 @@ custom_edit_url: null
         if (err) {
           console.error(
             chalk.red(`Cleanup failed for "${outputDir}/versions.json"`),
-            chalk.yellow(err),
+            chalk.yellow(err)
           );
         } else {
           console.log(
-            chalk.green(`Cleanup succeeded for "${outputDir}/versions.json"`),
+            chalk.green(`Cleanup succeeded for "${outputDir}/versions.json"`)
           );
         }
       });
@@ -574,7 +574,7 @@ custom_edit_url: null
       cli
         .command(`gen-api-docs`)
         .description(
-          `Generates OpenAPI docs in MDX file format and sidebar.js (if enabled).`,
+          `Generates OpenAPI docs in MDX file format and sidebar.js (if enabled).`
         )
         .usage("<id>")
         .arguments("<id>")
@@ -592,7 +592,7 @@ custom_edit_url: null
               targetDocsPluginId = pluginConfig.docsPluginId;
             } catch {
               console.error(
-                chalk.red(`OpenAPI docs plugin ID '${pluginId}' not found.`),
+                chalk.red(`OpenAPI docs plugin ID '${pluginId}' not found.`)
               );
               return;
             }
@@ -600,8 +600,8 @@ custom_edit_url: null
             if (pluginInstances.length > 1) {
               console.error(
                 chalk.red(
-                  "OpenAPI docs plugin ID must be specified when more than one plugin instance exists.",
-                ),
+                  "OpenAPI docs plugin ID must be specified when more than one plugin instance exists."
+                )
               );
               return;
             }
@@ -612,8 +612,8 @@ custom_edit_url: null
             if (targetConfig[id]) {
               console.error(
                 chalk.red(
-                  "Can't use id 'all' for OpenAPI docs configuration key.",
-                ),
+                  "Can't use id 'all' for OpenAPI docs configuration key."
+                )
               );
             } else {
               Object.keys(targetConfig).forEach(async function (key) {
@@ -622,7 +622,7 @@ custom_edit_url: null
             }
           } else if (!targetConfig[id]) {
             console.error(
-              chalk.red(`ID '${id}' does not exist in OpenAPI docs config.`),
+              chalk.red(`ID '${id}' does not exist in OpenAPI docs config.`)
             );
           } else {
             await generateApiDocs(targetConfig[id], targetDocsPluginId);
@@ -632,7 +632,7 @@ custom_edit_url: null
       cli
         .command(`gen-api-docs:version`)
         .description(
-          `Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.js (if enabled).`,
+          `Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.js (if enabled).`
         )
         .usage("<id:version>")
         .arguments("<id:version>")
@@ -650,7 +650,7 @@ custom_edit_url: null
               targetDocsPluginId = pluginConfig.docsPluginId;
             } catch {
               console.error(
-                chalk.red(`OpenAPI docs plugin ID '${pluginId}' not found.`),
+                chalk.red(`OpenAPI docs plugin ID '${pluginId}' not found.`)
               );
               return;
             }
@@ -658,8 +658,8 @@ custom_edit_url: null
             if (pluginInstances.length > 1) {
               console.error(
                 chalk.red(
-                  "OpenAPI docs plugin ID must be specified when more than one plugin instance exists.",
-                ),
+                  "OpenAPI docs plugin ID must be specified when more than one plugin instance exists."
+                )
               );
               return;
             }
@@ -690,8 +690,8 @@ custom_edit_url: null
             if (versions[id]) {
               console.error(
                 chalk.red(
-                  "Can't use id 'all' for OpenAPI docs versions configuration key.",
-                ),
+                  "Can't use id 'all' for OpenAPI docs versions configuration key."
+                )
               );
             } else {
               await generateVersions(mergedVersions, parentConfig.outputDir);
@@ -707,8 +707,8 @@ custom_edit_url: null
           } else if (!versions[versionId]) {
             console.error(
               chalk.red(
-                `Version ID '${versionId}' does not exist in OpenAPI docs versions config.`,
-              ),
+                `Version ID '${versionId}' does not exist in OpenAPI docs versions config.`
+              )
             );
           } else {
             const versionConfig = versions[versionId];
@@ -724,7 +724,7 @@ custom_edit_url: null
       cli
         .command(`clean-api-docs`)
         .description(
-          `Clears the generated OpenAPI docs MDX files and sidebar.js (if enabled).`,
+          `Clears the generated OpenAPI docs MDX files and sidebar.js (if enabled).`
         )
         .usage("<id>")
         .arguments("<id>")
@@ -740,7 +740,7 @@ custom_edit_url: null
               targetConfig = pluginConfig.config ?? {};
             } catch {
               console.error(
-                chalk.red(`OpenAPI docs plugin ID '${pluginId}' not found.`),
+                chalk.red(`OpenAPI docs plugin ID '${pluginId}' not found.`)
               );
               return;
             }
@@ -748,8 +748,8 @@ custom_edit_url: null
             if (pluginInstances.length > 1) {
               console.error(
                 chalk.red(
-                  "OpenAPI docs plugin ID must be specified when more than one plugin instance exists.",
-                ),
+                  "OpenAPI docs plugin ID must be specified when more than one plugin instance exists."
+                )
               );
               return;
             }
@@ -759,8 +759,8 @@ custom_edit_url: null
             if (targetConfig[id]) {
               console.error(
                 chalk.red(
-                  "Can't use id 'all' for OpenAPI docs configuration key.",
-                ),
+                  "Can't use id 'all' for OpenAPI docs configuration key."
+                )
               );
             } else {
               Object.keys(targetConfig).forEach(async function (key) {
@@ -775,7 +775,7 @@ custom_edit_url: null
       cli
         .command(`clean-api-docs:version`)
         .description(
-          `Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.js (if enabled).`,
+          `Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.js (if enabled).`
         )
         .usage("<id:version>")
         .arguments("<id:version>")
@@ -791,7 +791,7 @@ custom_edit_url: null
               targetConfig = pluginConfig.config ?? {};
             } catch {
               console.error(
-                chalk.red(`OpenAPI docs plugin ID '${pluginId}' not found.`),
+                chalk.red(`OpenAPI docs plugin ID '${pluginId}' not found.`)
               );
               return;
             }
@@ -799,8 +799,8 @@ custom_edit_url: null
             if (pluginInstances.length > 1) {
               console.error(
                 chalk.red(
-                  "OpenAPI docs plugin ID must be specified when more than one plugin instance exists.",
-                ),
+                  "OpenAPI docs plugin ID must be specified when more than one plugin instance exists."
+                )
               );
               return;
             }
@@ -815,7 +815,7 @@ custom_edit_url: null
           if (versionId === "all") {
             if (versions[id]) {
               chalk.red(
-                "Can't use id 'all' for OpenAPI docs versions configuration key.",
+                "Can't use id 'all' for OpenAPI docs versions configuration key."
               );
             } else {
               await cleanVersions(parentConfig.outputDir);

package/src/markdown/createAuthentication.ts

@@ -35,20 +35,20 @@ export function createAuthentication(securitySchemes: SecuritySchemeObject) {
             create("td", {
               children: [
                 guard(tokenUrl, () =>
-                  create("p", { children: `Token URL: ${tokenUrl}` }),
+                  create("p", { children: `Token URL: ${tokenUrl}` })
                 ),
                 guard(authorizationUrl, () =>
                   create("p", {
                     children: `Authorization URL: ${authorizationUrl}`,
-                  }),
+                  })
                 ),
                 guard(refreshUrl, () =>
-                  create("p", { children: `Refresh URL: ${refreshUrl}` }),
+                  create("p", { children: `Refresh URL: ${refreshUrl}` })
                 ),
                 create("span", { children: "Scopes:" }),
                 create("ul", {
                   children: Object.entries(scopes).map(([scope, description]) =>
-                    create("li", { children: `${scope}: ${description}` }),
+                    create("li", { children: `${scope}: ${description}` })
                   ),
                 }),
               ],
@@ -98,7 +98,7 @@ export function createAuthentication(securitySchemes: SecuritySchemeObject) {
                         create("th", { children: "Bearer format:" }),
                         create("td", { children: bearerFormat }),
                       ],
-                    }),
+                    })
                   ),
                 ],
               }),
@@ -131,7 +131,7 @@ export function createAuthentication(securitySchemes: SecuritySchemeObject) {
                         create("th", { children: "OpenID Connect URL:" }),
                         create("td", { children: openIdConnectUrl }),
                       ],
-                    }),
+                    })
                   ),
                 ],
               }),
@@ -180,14 +180,14 @@ export function createAuthentication(securitySchemes: SecuritySchemeObject) {
               label: formatTabLabel(
                 schemeKey,
                 schemeObj.type,
-                schemeObj.scheme,
+                schemeObj.scheme
               ),
               value: `${schemeKey}`,
               children: [
                 createDescription(schemeObj.description),
                 createAuthenticationTable(schemeObj),
               ],
-            }),
+            })
         ),
       }),
     ],

package/src/markdown/createContactInfo.ts

@@ -32,7 +32,7 @@ export function createContactInfo(contact: ContactObject) {
             create("a", {
               href: `mailto:${email}`,
               children: `${email}`,
-            }),
+            })
           ),
         ],
       }),
@@ -45,7 +45,7 @@ export function createContactInfo(contact: ContactObject) {
               children: `${url}`,
             }),
           ],
-        }),
+        })
       ),
     ],
   });

package/src/markdown/createDeprecationNotice.ts

@@ -25,6 +25,6 @@ export function createDeprecationNotice({
       children:
         description ??
         "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
-    }),
+    })
   );
 }

package/src/markdown/createLicense.ts

@@ -27,7 +27,7 @@ export function createLicense(license: LicenseObject) {
         create("a", {
           href: url,
           children: name ?? url,
-        }),
+        })
       ),
     ],
   });

package/src/markdown/createLogo.ts

@@ -10,7 +10,7 @@ import { LogoObject } from "../openapi/types";
 
 export function createLogo(
   logo: LogoObject | undefined,
-  darkLogo: LogoObject | undefined,
+  darkLogo: LogoObject | undefined
 ) {
   return guard(logo || darkLogo, () => [
     create("ApiLogo", {

package/src/markdown/createParamsDetails.ts

@@ -47,7 +47,7 @@ export function createParamsDetails({ parameters, type }: Props) {
               create("ParamsItem", {
                 className: "paramsItem",
                 param: param,
-              }),
+              })
             ),
           }),
         ],

package/src/markdown/createRequestSchema.ts

@@ -132,7 +132,7 @@ export function createRequestSchema({ title, body, ...rest }: Props) {
                     create("span", {
                       style: { opacity: "0.6" },
                       children: ` array`,
-                    }),
+                    })
                   ),
                   guard(body.required, () => [
                     create("strong", {

package/src/markdown/createResponseSchema.ts

@@ -92,7 +92,7 @@ export function createResponseSchema({ title, body, ...rest }: Props) {
                                     className: "openapi-schema__required",
                                     children: "required",
                                   }),
-                                ],
+                                ]
                               ),
                             ],
                           }),

package/src/markdown/createSchema.test.ts

@@ -50,8 +50,8 @@ describe("createNodes", () => {
     };
     expect(
       createNodes(schema, "request").map((md: any) =>
-        prettier.format(md, { parser: "babel" }),
-      ),
+        prettier.format(md, { parser: "babel" })
+      )
     ).toMatchSnapshot();
   });
 });