docusaurus-plugin-openapi-docs 3.0.0-beta.8 → 3.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "3.0.0-beta.8",
+  "version": "3.0.0",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -41,8 +41,6 @@
     "@docusaurus/plugin-content-docs": "^3.0.1",
     "@docusaurus/utils": "^3.0.1",
     "@docusaurus/utils-validation": "^3.0.1",
-    "@paloaltonetworks/openapi-to-postmanv2": "3.1.0-hotfix.1",
-    "@paloaltonetworks/postman-collection": "^4.1.0",
     "@redocly/openapi-core": "^1.10.5",
     "chalk": "^4.1.2",
     "clsx": "^1.1.1",
@@ -52,6 +50,8 @@
     "json5": "^2.2.3",
     "lodash": "^4.17.20",
     "mustache": "^4.2.0",
+    "openapi-to-postmanv2": "^4.21.0",
+    "postman-collection": "^4.4.0",
     "slugify": "^1.6.5",
     "swagger2openapi": "^7.0.8",
     "xml-formatter": "^2.6.1"
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "5877a91dbf3a6f75d4b13258fe5d1f578dd35637"
+  "gitHead": "d03859d67953de59558a3fa84e7cc690941dbd69"
 }

package/src/index.ts

@@ -41,6 +41,7 @@ export function isURL(str: string): boolean {
 
 export function getDocsPluginConfig(
   presetsPlugins: any[],
+  plugin: string,
   pluginId: string
 ): Object | undefined {
   // eslint-disable-next-line array-callback-return
@@ -52,10 +53,7 @@ export function getDocsPluginConfig(
       }
 
       // Search plugin-content-docs instances
-      if (
-        typeof data[0] === "string" &&
-        data[0] === "@docusaurus/plugin-content-docs"
-      ) {
+      if (typeof data[0] === "string" && data[0] === plugin) {
         const configPluginId = data[1].id ? data[1].id : "default";
         if (configPluginId === pluginId) {
           return data[1];
@@ -71,7 +69,7 @@ export function getDocsPluginConfig(
     }
 
     // Search plugin-content-docs instances
-    if (filteredConfig[0] === "@docusaurus/plugin-content-docs") {
+    if (filteredConfig[0] === plugin) {
       const configPluginId = filteredConfig[1].id
         ? filteredConfig[1].id
         : "default";
@@ -95,14 +93,22 @@ export default function pluginOpenAPIDocs(
   context: LoadContext,
   options: PluginOptions
 ): Plugin<LoadedContent> {
-  const { config, docsPluginId } = options;
+  const {
+    config,
+    docsPlugin = "@docusaurus/plugin-content-docs",
+    docsPluginId,
+  } = options;
   const { siteDir, siteConfig } = context;
 
   // Get routeBasePath and path from plugin-content-docs or preset
   const presets: any = siteConfig.presets;
   const plugins: any = siteConfig.plugins;
   const presetsPlugins = presets.concat(plugins);
-  let docData: any = getDocsPluginConfig(presetsPlugins, docsPluginId);
+  let docData: any = getDocsPluginConfig(
+    presetsPlugins,
+    docsPlugin,
+    docsPluginId
+  );
   let docRouteBasePath = docData ? docData.routeBasePath : undefined;
   let docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
 
@@ -114,6 +120,7 @@ export default function pluginOpenAPIDocs(
       markdownGenerators,
       downloadUrl,
       sidebarOptions,
+      disableCompression,
     } = options;
 
     // Remove trailing slash before proceeding
@@ -121,7 +128,7 @@ export default function pluginOpenAPIDocs(
 
     // Override docPath if pluginId provided
     if (pluginId) {
-      docData = getDocsPluginConfig(presetsPlugins, pluginId);
+      docData = getDocsPluginConfig(presetsPlugins, docsPlugin, pluginId);
       docRouteBasePath = docData ? docData.routeBasePath : undefined;
       docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
     }
@@ -305,7 +312,7 @@ custom_edit_url: null
 
       loadedApi.map(async (item) => {
         if (item.type === "info") {
-          if (downloadUrl && isURL(downloadUrl)) {
+          if (downloadUrl) {
             item.downloadUrl = downloadUrl;
           }
         }
@@ -319,9 +326,11 @@ custom_edit_url: null
           // const deserialize = (s: any) => {
           //   return zlib.inflateSync(Buffer.from(s, "base64")).toString();
           // };
-          item.json = zlib
-            .deflateSync(JSON.stringify(item.api))
-            .toString("base64");
+          disableCompression === true
+            ? (item.json = JSON.stringify(item.api))
+            : (item.json = zlib
+                .deflateSync(JSON.stringify(item.api))
+                .toString("base64"));
           let infoBasePath = `${outputDir}/${item.infoId}`;
           if (docRouteBasePath) {
             infoBasePath = `${docRouteBasePath}/${outputDir
@@ -470,11 +479,7 @@ custom_edit_url: null
       cwd: path.resolve(apiDir),
       deep: 1,
     });
-    const schemaMdxFiles = await Globby(["*.schema.mdx"], {
-      cwd: path.resolve(apiDir, "schemas"),
-      deep: 1,
-    });
-    const sidebarFile = await Globby(["sidebar.js"], {
+    const sidebarFile = await Globby(["sidebar.js", "sidebar.ts"], {
       cwd: path.resolve(apiDir),
       deep: 1,
     });
@@ -491,20 +496,17 @@ custom_edit_url: null
       })
     );
 
-    schemaMdxFiles.map((mdx) =>
-      fs.unlink(`${apiDir}/schemas/${mdx}`, (err) => {
-        if (err) {
-          console.error(
-            chalk.red(`Cleanup failed for "${apiDir}/schemas/${mdx}"`),
-            chalk.yellow(err)
-          );
-        } else {
-          console.log(
-            chalk.green(`Cleanup succeeded for "${apiDir}/schemas/${mdx}"`)
-          );
-        }
-      })
-    );
+    try {
+      fs.rmSync(`${apiDir}/schemas`, { recursive: true });
+      console.log(chalk.green(`Cleanup succeeded for "${apiDir}/schemas"`));
+    } catch (err: any) {
+      if (err.code !== "ENOENT") {
+        console.error(
+          chalk.red(`Cleanup failed for "${apiDir}/schemas"`),
+          chalk.yellow(err)
+        );
+      }
+    }
 
     sidebarFile.map((sidebar) =>
       fs.unlink(`${apiDir}/${sidebar}`, (err) => {
@@ -529,6 +531,7 @@ custom_edit_url: null
         version: version,
         label: metadata.label,
         baseUrl: metadata.baseUrl,
+        downloadUrl: metadata.downloadUrl,
       });
     }
 
@@ -683,6 +686,7 @@ custom_edit_url: null
           delete parentConfig.version;
           delete parentConfig.label;
           delete parentConfig.baseUrl;
+          delete parentConfig.downloadUrl;
 
           // TODO: handle when no versions are defined by version command is passed
           if (versionId === "all") {

package/src/markdown/__snapshots__/createSchema.test.ts.snap

@@ -1,5 +1,226 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`createNodes additionalProperties should handle additionalProperties: {"allOf": [Array]} 1`] = `
+Array [
+  "<SchemaItem collapsible={true} className={\\"schemaItem\\"}>
+  <details style={{}} className={\\"openapi-markdown__details\\"}>
+    <summary style={{}}>
+      <span className={\\"openapi-schema__container\\"}>
+        <strong className={\\"openapi-schema__property\\"}>property name*</strong>
+        <span className={\\"openapi-schema__name\\"}>object</span>
+      </span>
+    </summary>
+    <div style={{ marginLeft: \\"1rem\\" }}>
+      <div>
+        <span className={\\"badge badge--info\\"}>oneOf</span>
+        <SchemaTabs>
+          <TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
+            <SchemaItem
+              collapsible={false}
+              name={\\"type\\"}
+              required={true}
+              schemaName={\\"string\\"}
+              qualifierMessage={\\"**Possible values:** [\`nose\`]\\"}
+              schema={{ type: \\"string\\", enum: [\\"nose\\"] }}
+            ></SchemaItem>
+          </TabItem>
+          <TabItem label={\\"MOD2\\"} value={\\"1-item-properties\\"}>
+            <SchemaItem
+              collapsible={false}
+              name={\\"type\\"}
+              required={true}
+              schemaName={\\"string\\"}
+              qualifierMessage={\\"**Possible values:** [\`mouth\`]\\"}
+              schema={{ type: \\"string\\", enum: [\\"mouth\\"] }}
+            ></SchemaItem>
+          </TabItem>
+          <TabItem label={\\"MOD3\\"} value={\\"2-item-properties\\"}>
+            <SchemaItem
+              collapsible={false}
+              name={\\"type\\"}
+              required={true}
+              schemaName={\\"string\\"}
+              qualifierMessage={\\"**Possible values:** [\`eyes\`]\\"}
+              schema={{ type: \\"string\\", enum: [\\"eyes\\"] }}
+            ></SchemaItem>
+            <SchemaItem
+              collapsible={false}
+              name={\\"default\\"}
+              required={false}
+              schemaName={\\"string\\"}
+              qualifierMessage={undefined}
+              schema={{ type: \\"string\\" }}
+            ></SchemaItem>
+          </TabItem>
+        </SchemaTabs>
+      </div>
+      <SchemaItem
+        collapsible={false}
+        name={\\"description\\"}
+        required={true}
+        schemaName={\\"string\\"}
+        qualifierMessage={undefined}
+        schema={{
+          type: \\"string\\",
+          description: \\"Description of the body part.\\",
+        }}
+      ></SchemaItem>
+    </div>
+  </details>
+</SchemaItem>;
+",
+]
+`;
+
+exports[`createNodes additionalProperties should handle additionalProperties: {"items": [Object], "type": "array"} 1`] = `
+Array [
+  "<SchemaItem collapsible={true} className={\\"schemaItem\\"}>
+  <details style={{}} className={\\"openapi-markdown__details\\"}>
+    <summary style={{}}>
+      <span className={\\"openapi-schema__container\\"}>
+        <strong className={\\"openapi-schema__property\\"}>property name*</strong>
+        <span className={\\"openapi-schema__name\\"}>object[]</span>
+      </span>
+    </summary>
+    <div style={{ marginLeft: \\"1rem\\" }}>
+      <li>
+        <div
+          style={{
+            fontSize: \\"var(--ifm-code-font-size)\\",
+            opacity: \\"0.6\\",
+            marginLeft: \\"-.5rem\\",
+            paddingBottom: \\".5rem\\",
+          }}
+        >
+          Array [
+        </div>
+      </li>
+      <SchemaItem
+        collapsible={false}
+        name={\\"a\\"}
+        required={false}
+        schemaName={\\"\\"}
+        qualifierMessage={undefined}
+        schema={\\"string\\"}
+      ></SchemaItem>
+      <SchemaItem
+        collapsible={false}
+        name={\\"b\\"}
+        required={false}
+        schemaName={\\"\\"}
+        qualifierMessage={undefined}
+        schema={\\"number\\"}
+      ></SchemaItem>
+      <li>
+        <div
+          style={{
+            fontSize: \\"var(--ifm-code-font-size)\\",
+            opacity: \\"0.6\\",
+            marginLeft: \\"-.5rem\\",
+          }}
+        >
+          ]
+        </div>
+      </li>
+    </div>
+  </details>
+</SchemaItem>;
+",
+]
+`;
+
+exports[`createNodes additionalProperties should handle additionalProperties: {"type": "boolean"} 1`] = `
+Array [
+  "<SchemaItem
+  name={\\"property name*\\"}
+  required={false}
+  schemaName={\\"boolean\\"}
+  qualifierMessage={undefined}
+  schema={{ type: \\"boolean\\" }}
+  collapsible={false}
+  discriminator={false}
+></SchemaItem>;
+",
+]
+`;
+
+exports[`createNodes additionalProperties should handle additionalProperties: {"type": "integer"} 1`] = `
+Array [
+  "<SchemaItem
+  name={\\"property name*\\"}
+  required={false}
+  schemaName={\\"integer\\"}
+  qualifierMessage={undefined}
+  schema={{ type: \\"integer\\" }}
+  collapsible={false}
+  discriminator={false}
+></SchemaItem>;
+",
+]
+`;
+
+exports[`createNodes additionalProperties should handle additionalProperties: {"type": "number"} 1`] = `
+Array [
+  "<SchemaItem
+  name={\\"property name*\\"}
+  required={false}
+  schemaName={\\"number\\"}
+  qualifierMessage={undefined}
+  schema={{ type: \\"number\\" }}
+  collapsible={false}
+  discriminator={false}
+></SchemaItem>;
+",
+]
+`;
+
+exports[`createNodes additionalProperties should handle additionalProperties: {"type": "string"} 1`] = `
+Array [
+  "<SchemaItem
+  name={\\"property name*\\"}
+  required={false}
+  schemaName={\\"string\\"}
+  qualifierMessage={undefined}
+  schema={{ type: \\"string\\" }}
+  collapsible={false}
+  discriminator={false}
+></SchemaItem>;
+",
+]
+`;
+
+exports[`createNodes additionalProperties should handle additionalProperties: {} 1`] = `
+Array [
+  "<SchemaItem
+  name={\\"property name*\\"}
+  required={false}
+  schemaName={\\"any\\"}
+  qualifierMessage={undefined}
+  schema={{ type: \\"object\\", additionalProperties: {} }}
+  collapsible={false}
+  discriminator={false}
+></SchemaItem>;
+",
+]
+`;
+
+exports[`createNodes additionalProperties should handle additionalProperties: false 1`] = `Array []`;
+
+exports[`createNodes additionalProperties should handle additionalProperties: true 1`] = `
+Array [
+  "<SchemaItem
+  name={\\"property name*\\"}
+  required={false}
+  schemaName={\\"any\\"}
+  qualifierMessage={undefined}
+  schema={{ type: \\"object\\", additionalProperties: true }}
+  collapsible={false}
+  discriminator={false}
+></SchemaItem>;
+",
+]
+`;
+
 exports[`createNodes should create readable MODs for oneOf primitive properties 1`] = `
 Array [
   "<SchemaItem collapsible={true} className={\\"schemaItem\\"}>

package/src/markdown/createRequestSchema.ts

@@ -108,12 +108,6 @@ export function createRequestSchema({ title, body, ...rest }: Props) {
     return undefined;
   }
 
-  // we don't show the table if there is no properties to show
-  if (firstBody.properties !== undefined) {
-    if (Object.keys(firstBody.properties).length === 0) {
-      return undefined;
-    }
-  }
   return create("MimeTabs", {
     className: "openapi-tabs__mime",
     children: [

package/src/markdown/createResponseSchema.ts

@@ -60,12 +60,6 @@ export function createResponseSchema({ title, body, ...rest }: Props) {
           return undefined;
         }
 
-        if (firstBody?.properties !== undefined) {
-          if (Object.keys(firstBody?.properties).length === 0) {
-            return undefined;
-          }
-        }
-
         return create("TabItem", {
           label: `${mimeType}`,
           value: `${mimeType}`,

package/src/markdown/createSchema.test.ts

@@ -13,6 +13,7 @@ import { SchemaObject } from "../openapi/types";
 describe("createNodes", () => {
   it("should create readable MODs for oneOf primitive properties", async () => {
     const schema: SchemaObject = {
+      "x-tags": ["clown"],
       type: "object",
       properties: {
         oneOfProperty: {
@@ -55,4 +56,91 @@ describe("createNodes", () => {
       )
     ).toMatchSnapshot();
   });
+
+  describe("additionalProperties", () => {
+    it.each([
+      [
+        {
+          allOf: [
+            {
+              oneOf: [
+                {
+                  type: "object",
+                  properties: {
+                    type: {
+                      type: "string",
+                      enum: ["nose"],
+                    },
+                  },
+                  required: ["type"],
+                },
+                {
+                  type: "object",
+                  properties: {
+                    type: {
+                      type: "string",
+                      enum: ["mouth"],
+                    },
+                  },
+                  required: ["type"],
+                },
+                {
+                  type: "object",
+                  properties: {
+                    type: {
+                      type: "string",
+                      enum: ["eyes"],
+                    },
+                    default: {
+                      type: "string",
+                    },
+                  },
+                  required: ["type"],
+                },
+              ],
+            },
+            {
+              type: "object",
+              properties: {
+                description: {
+                  type: "string",
+                  description: "Description of the body part.",
+                },
+              },
+              required: ["description"],
+            },
+          ],
+        },
+      ],
+      [
+        {
+          type: "array",
+          items: { type: "object", properties: { a: "string", b: "number" } },
+        },
+      ],
+      [{ type: "string" }],
+      [{ type: "number" }],
+      [{ type: "integer" }],
+      [{ type: "boolean" }],
+      [false],
+      [true],
+      [{}],
+    ] as [SchemaObject["additionalProperties"]][])(
+      "should handle additionalProperties: %p",
+      async (additionalProperties) => {
+        const schema: SchemaObject = {
+          type: "object",
+          additionalProperties,
+        };
+
+        expect(
+          await Promise.all(
+            createNodes(schema, "request").map(
+              async (md: any) => await prettier.format(md, { parser: "babel" })
+            )
+          )
+        ).toMatchSnapshot();
+      }
+    );
+  });
 });