docusaurus-theme-openapi-docs 4.3.4 → 4.3.6

package/lib/index.js

@@ -11,7 +11,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = docusaurusThemeOpenAPI;
 const path_1 = __importDefault(require("path"));
-const NodePolyfillPlugin = require("node-polyfill-webpack-plugin");
 function docusaurusThemeOpenAPI() {
     return {
         name: "docusaurus-theme-openapi",
@@ -36,7 +35,17 @@ function docusaurusThemeOpenAPI() {
             // Avoid conflicts with docusaurus-plugin-sass
             if (sassLoaderRule.length === 0) {
                 return {
-                    plugins: [new NodePolyfillPlugin()],
+                    resolve: {
+                        fallback: {
+                            buffer: require.resolve("buffer/"),
+                        },
+                    },
+                    plugins: [
+                        new utils.currentBundler.instance.ProvidePlugin({
+                            process: require.resolve("process/browser"),
+                            Buffer: ["buffer", "Buffer"],
+                        }),
+                    ],
                     module: {
                         rules: [
                             {
@@ -55,7 +64,17 @@ function docusaurusThemeOpenAPI() {
                 };
             }
             return {
-                plugins: [new NodePolyfillPlugin()],
+                resolve: {
+                    fallback: {
+                        buffer: require.resolve("buffer/"),
+                    },
+                },
+                plugins: [
+                    new utils.currentBundler.instance.ProvidePlugin({
+                        process: require.resolve("process/browser"),
+                        Buffer: ["buffer", "Buffer"],
+                    }),
+                ],
             };
         },
     };

package/lib/markdown/schema.js

@@ -88,8 +88,8 @@ function getQualifierMessage(schema) {
         }
         qualifierGroups.push(lengthQualifier);
     }
-    if (schema.minimum ||
-        schema.maximum ||
+    if (schema.minimum != null ||
+        schema.maximum != null ||
         typeof schema.exclusiveMinimum === "number" ||
         typeof schema.exclusiveMaximum === "number") {
         let minmaxQualifier = "";
@@ -98,19 +98,19 @@ function getQualifierMessage(schema) {
         if (typeof schema.exclusiveMinimum === "number") {
             minimum = `\`> ${schema.exclusiveMinimum}\``;
         }
-        else if (schema.minimum && !schema.exclusiveMinimum) {
+        else if (schema.minimum != null && !schema.exclusiveMinimum) {
             minimum = `\`>= ${schema.minimum}\``;
         }
-        else if (schema.minimum && schema.exclusiveMinimum === true) {
+        else if (schema.minimum != null && schema.exclusiveMinimum === true) {
             minimum = `\`> ${schema.minimum}\``;
         }
         if (typeof schema.exclusiveMaximum === "number") {
             maximum = `\`< ${schema.exclusiveMaximum}\``;
         }
-        else if (schema.maximum && !schema.exclusiveMaximum) {
+        else if (schema.maximum != null && !schema.exclusiveMaximum) {
             maximum = `\`<= ${schema.maximum}\``;
         }
-        else if (schema.maximum && schema.exclusiveMaximum === true) {
+        else if (schema.maximum != null && schema.exclusiveMaximum === true) {
             maximum = `\`< ${schema.maximum}\``;
         }
         if (minimum && !maximum) {

package/lib/theme/ApiExplorer/Body/index.js

@@ -215,9 +215,16 @@ function Body({
     }
     if (examples) {
       for (const [key, example] of Object.entries(examples)) {
+        let body = example.value;
+        try {
+          // If the value is already valid JSON we shouldn't double encode the value
+          JSON.parse(example.value);
+        } catch (e) {
+          body = JSON.stringify(example.value, null, 2);
+        }
         examplesBodies.push({
           label: key,
-          body: JSON.stringify(example.value, null, 2),
+          body,
           summary: example.summary,
         });
       }

package/lib/theme/ApiExplorer/Response/index.js

@@ -12,7 +12,6 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
-// @ts-ignore
 const client_1 = require("@docusaurus/plugin-content-docs/client");
 const theme_common_1 = require("@docusaurus/theme-common");
 const ApiCodeBlock_1 = __importDefault(

package/lib/theme/ApiItem/index.js

@@ -12,7 +12,6 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = ApiItem;
-const zlib_1 = __importDefault(require("zlib"));
 const react_1 = __importDefault(require("react"));
 const BrowserOnly_1 = __importDefault(require("@docusaurus/BrowserOnly"));
 const ExecutionEnvironment_1 = __importDefault(
@@ -31,12 +30,22 @@ const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
 const Metadata_1 = __importDefault(require("@theme/DocItem/Metadata"));
 const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
 const clsx_1 = __importDefault(require("clsx"));
+const pako_1 = require("pako");
 const react_redux_1 = require("react-redux");
 const store_1 = require("./store");
 let ApiExplorer = (_) => react_1.default.createElement("div", null);
 if (ExecutionEnvironment_1.default.canUseDOM) {
   ApiExplorer = require("@theme/ApiExplorer").default;
 }
+function base64ToUint8Array(base64) {
+  const binary = atob(base64);
+  const len = binary.length;
+  const bytes = new Uint8Array(len);
+  for (let i = 0; i < len; i++) {
+    bytes[i] = binary.charCodeAt(i);
+  }
+  return bytes;
+}
 // @ts-ignore
 function ApiItem(props) {
   const docHtmlClassName = `docs-doc-id-${props.content.metadata.id}`;
@@ -50,7 +59,7 @@ function ApiItem(props) {
   if (api) {
     try {
       api = JSON.parse(
-        zlib_1.default.inflateSync(Buffer.from(api, "base64")).toString()
+        new TextDecoder().decode((0, pako_1.ungzip)(base64ToUint8Array(api)))
       );
     } catch {}
   }

package/lib/theme/DiscriminatorTabs/index.js

@@ -238,6 +238,8 @@ function TabsComponent(props) {
 }
 function DiscriminatorTabs(props) {
   const isBrowser = (0, useIsBrowser_1.default)();
+  if (!props.length)
+    return react_1.default.createElement(react_1.default.Fragment, null);
   return react_1.default.createElement(
     TabsComponent,
     // Remount tabs after hydration

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "4.3.4",
+  "version": "4.3.6",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -28,13 +28,15 @@
     "watch": "concurrently --names \"lib,lib-next,tsc\" --kill-others \"yarn babel:lib --watch\" \"yarn babel:lib-next --watch\" \"yarn tsc --watch\""
   },
   "devDependencies": {
+    "@docusaurus/theme-classic": "^3.5.0",
     "@docusaurus/theme-common": "^3.5.0",
     "@docusaurus/types": "^3.5.0",
     "@types/crypto-js": "^4.1.0",
     "@types/file-saver": "^2.0.5",
     "@types/lodash": "^4.14.176",
+    "@types/pako": "^2.0.3",
     "concurrently": "^5.2.0",
-    "docusaurus-plugin-openapi-docs": "^4.3.3",
+    "docusaurus-plugin-openapi-docs": "^4.3.6",
     "docusaurus-plugin-sass": "^0.2.3",
     "eslint-plugin-prettier": "^5.0.1"
   },
@@ -42,15 +44,17 @@
     "@hookform/error-message": "^2.0.1",
     "@reduxjs/toolkit": "^1.7.1",
     "allof-merge": "^0.6.6",
+    "buffer": "^6.0.3",
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.1.0",
     "crypto-js": "^4.1.1",
     "file-saver": "^2.0.5",
     "lodash": "^4.17.20",
-    "node-polyfill-webpack-plugin": "^3.0.0",
+    "pako": "^2.1.0",
     "postman-code-generators": "^1.10.1",
     "postman-collection": "^4.4.0",
     "prism-react-renderer": "^2.3.0",
+    "process": "^0.11.10",
     "react-hook-form": "^7.43.8",
     "react-live": "^4.0.0",
     "react-magic-dropzone": "^1.0.1",
@@ -62,7 +66,7 @@
     "sass": "^1.80.4",
     "sass-loader": "^16.0.2",
     "unist-util-visit": "^5.0.0",
-    "webpack": "^5.61.0",
+    "url": "^0.11.1",
     "xml-formatter": "^2.6.1"
   },
   "peerDependencies": {
@@ -75,5 +79,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "97d0fc7e9ed0f18f0cf02b8de3bc502b0cd52c34"
+  "gitHead": "852aca183dfbda7e28ba961d74fb639736be76a3"
 }

package/src/index.ts

@@ -9,8 +9,6 @@ import path from "path";
 
 import type { Plugin } from "@docusaurus/types";
 
-const NodePolyfillPlugin = require("node-polyfill-webpack-plugin");
-
 export default function docusaurusThemeOpenAPI(): Plugin<void> {
   return {
     name: "docusaurus-theme-openapi",
@@ -41,7 +39,17 @@ export default function docusaurusThemeOpenAPI(): Plugin<void> {
       // Avoid conflicts with docusaurus-plugin-sass
       if (sassLoaderRule.length === 0) {
         return {
-          plugins: [new NodePolyfillPlugin()],
+          resolve: {
+            fallback: {
+              buffer: require.resolve("buffer/"),
+            },
+          },
+          plugins: [
+            new utils.currentBundler.instance.ProvidePlugin({
+              process: require.resolve("process/browser"),
+              Buffer: ["buffer", "Buffer"],
+            }),
+          ],
           module: {
             rules: [
               {
@@ -60,7 +68,17 @@ export default function docusaurusThemeOpenAPI(): Plugin<void> {
         };
       }
       return {
-        plugins: [new NodePolyfillPlugin()],
+        resolve: {
+          fallback: {
+            buffer: require.resolve("buffer/"),
+          },
+        },
+        plugins: [
+          new utils.currentBundler.instance.ProvidePlugin({
+            process: require.resolve("process/browser"),
+            Buffer: ["buffer", "Buffer"],
+          }),
+        ],
       };
     },
   };

package/src/markdown/schema.ts

@@ -112,8 +112,8 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
   }
 
   if (
-    schema.minimum ||
-    schema.maximum ||
+    schema.minimum != null ||
+    schema.maximum != null ||
     typeof schema.exclusiveMinimum === "number" ||
     typeof schema.exclusiveMaximum === "number"
   ) {
@@ -122,16 +122,16 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
     let maximum;
     if (typeof schema.exclusiveMinimum === "number") {
       minimum = `\`> ${schema.exclusiveMinimum}\``;
-    } else if (schema.minimum && !schema.exclusiveMinimum) {
+    } else if (schema.minimum != null && !schema.exclusiveMinimum) {
       minimum = `\`>= ${schema.minimum}\``;
-    } else if (schema.minimum && schema.exclusiveMinimum === true) {
+    } else if (schema.minimum != null && schema.exclusiveMinimum === true) {
       minimum = `\`> ${schema.minimum}\``;
     }
     if (typeof schema.exclusiveMaximum === "number") {
       maximum = `\`< ${schema.exclusiveMaximum}\``;
-    } else if (schema.maximum && !schema.exclusiveMaximum) {
+    } else if (schema.maximum != null && !schema.exclusiveMaximum) {
       maximum = `\`<= ${schema.maximum}\``;
-    } else if (schema.maximum && schema.exclusiveMaximum === true) {
+    } else if (schema.maximum != null && schema.exclusiveMaximum === true) {
       maximum = `\`< ${schema.maximum}\``;
     }
 

package/src/theme/ApiExplorer/Body/index.tsx

@@ -233,9 +233,18 @@ function Body({
     }
     if (examples) {
       for (const [key, example] of Object.entries(examples)) {
+        let body = example.value;
+        try {
+          // If the value is already valid JSON we shouldn't double encode the value
+          JSON.parse(example.value);
+        }
+        catch (e) {
+          body = JSON.stringify(example.value, null, 2);
+        }
+
         examplesBodies.push({
           label: key,
-          body: JSON.stringify(example.value, null, 2),
+          body,
           summary: example.summary,
         });
       }

package/src/theme/ApiExplorer/Response/index.tsx

@@ -7,7 +7,6 @@
 
 import React from "react";
 
-// @ts-ignore
 import { useDoc } from "@docusaurus/plugin-content-docs/client";
 import { usePrismTheme } from "@docusaurus/theme-common";
 import ApiCodeBlock from "@theme/ApiExplorer/ApiCodeBlock";

package/src/theme/ApiItem/index.tsx

@@ -5,8 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import zlib from "zlib";
-
 import React from "react";
 
 import BrowserOnly from "@docusaurus/BrowserOnly";
@@ -23,13 +21,16 @@ import type { Props } from "@theme/DocItem";
 import DocItemMetadata from "@theme/DocItem/Metadata";
 import SkeletonLoader from "@theme/SkeletonLoader";
 import clsx from "clsx";
-import { ServerObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
-import { ParameterObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
+import {
+  ParameterObject,
+  ServerObject,
+} from "docusaurus-plugin-openapi-docs/src/openapi/types";
 import type { ApiItem as ApiItemType } from "docusaurus-plugin-openapi-docs/src/types";
 import type {
   DocFrontMatter,
   ThemeConfig,
 } from "docusaurus-theme-openapi-docs/src/types";
+import { ungzip } from "pako";
 import { Provider } from "react-redux";
 
 import { createStoreWithoutState, createStoreWithState } from "./store";
@@ -52,6 +53,16 @@ interface SampleFrontMatter extends DocFrontMatter {
   readonly sample?: any;
 }
 
+function base64ToUint8Array(base64: string) {
+  const binary = atob(base64);
+  const len = binary.length;
+  const bytes = new Uint8Array(len);
+  for (let i = 0; i < len; i++) {
+    bytes[i] = binary.charCodeAt(i);
+  }
+  return bytes;
+}
+
 // @ts-ignore
 export default function ApiItem(props: Props): JSX.Element {
   const docHtmlClassName = `docs-doc-id-${props.content.metadata.id}`;
@@ -65,7 +76,7 @@ export default function ApiItem(props: Props): JSX.Element {
   if (api) {
     try {
       api = JSON.parse(
-        zlib.inflateSync(Buffer.from(api as any, "base64") as any).toString()
+        new TextDecoder().decode(ungzip(base64ToUint8Array(api as any)))
       );
     } catch {}
   }

package/src/theme/DiscriminatorTabs/index.tsx

@@ -209,6 +209,9 @@ function TabsComponent(props: TabProps): React.JSX.Element {
 }
 export default function DiscriminatorTabs(props: TabProps): React.JSX.Element {
   const isBrowser = useIsBrowser();
+
+  if (!props.length) return <React.Fragment />;
+
   return (
     <TabsComponent
       // Remount tabs after hydration

package/src/theme-classic.d.ts

@@ -21,7 +21,9 @@ declare module "@docusaurus/theme-common/internal" {
   import { Props as ILineProps } from "@theme/CodeBlock/Line";
   import { PrismTheme } from "prism-react-renderer";
 
-  export interface TabProps extends ITabsProps {}
+  export interface TabProps extends ITabsProps {
+    length?: number;
+  }
 
   export interface CopyButtonProps extends ICopyButtonProps {}
   export interface LineProps extends ILineProps {}