docusaurus-theme-openapi-docs 4.3.1 → 4.3.2

package/lib/theme/OperationTabs/index.js

@@ -39,22 +39,35 @@ var __setModuleDefault =
       });
 var __importStar =
   (this && this.__importStar) ||
-  function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null)
-      for (var k in mod)
-        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
-          __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-  };
+  (function () {
+    var ownKeys = function (o) {
+      ownKeys =
+        Object.getOwnPropertyNames ||
+        function (o) {
+          var ar = [];
+          for (var k in o)
+            if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+          return ar;
+        };
+      return ownKeys(o);
+    };
+    return function (mod) {
+      if (mod && mod.__esModule) return mod;
+      var result = {};
+      if (mod != null)
+        for (var k = ownKeys(mod), i = 0; i < k.length; i++)
+          if (k[i] !== "default") __createBinding(result, mod, k[i]);
+      __setModuleDefault(result, mod);
+      return result;
+    };
+  })();
 var __importDefault =
   (this && this.__importDefault) ||
   function (mod) {
     return mod && mod.__esModule ? mod : { default: mod };
   };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = OperationTabs;
 const react_1 = __importStar(require("react"));
 const internal_1 = require("@docusaurus/theme-common/internal");
 const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
@@ -154,7 +167,9 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
               tabIndex: selectedValue === value ? 0 : -1,
               "aria-selected": selectedValue === value,
               key: value,
-              ref: (tabControl) => tabRefs.push(tabControl),
+              ref: (tabControl) => {
+                tabRefs.push(tabControl);
+              },
               onKeyDown: handleKeydown,
               onFocus: handleTabChange,
               onClick: (e) => handleTabChange(e),
@@ -231,4 +246,3 @@ function OperationTabs(props) {
     (0, internal_1.sanitizeTabsChildren)(props.children)
   );
 }
-exports.default = OperationTabs;

package/lib/theme/ParamsDetails/index.js

@@ -5,57 +5,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
-var __createBinding =
-  (this && this.__createBinding) ||
-  (Object.create
-    ? function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        var desc = Object.getOwnPropertyDescriptor(m, k);
-        if (
-          !desc ||
-          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
-        ) {
-          desc = {
-            enumerable: true,
-            get: function () {
-              return m[k];
-            },
-          };
-        }
-        Object.defineProperty(o, k2, desc);
-      }
-    : function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        o[k2] = m[k];
-      });
-var __setModuleDefault =
-  (this && this.__setModuleDefault) ||
-  (Object.create
-    ? function (o, v) {
-        Object.defineProperty(o, "default", { enumerable: true, value: v });
-      }
-    : function (o, v) {
-        o["default"] = v;
-      });
-var __importStar =
-  (this && this.__importStar) ||
-  function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null)
-      for (var k in mod)
-        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
-          __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-  };
 var __importDefault =
   (this && this.__importDefault) ||
   function (mod) {
     return mod && mod.__esModule ? mod : { default: mod };
   };
 Object.defineProperty(exports, "__esModule", { value: true });
-const react_1 = __importStar(require("react"));
+const react_1 = __importDefault(require("react"));
 const BrowserOnly_1 = __importDefault(require("@docusaurus/BrowserOnly"));
 const Details_1 = __importDefault(require("@theme/Details"));
 const ParamsItem_1 = __importDefault(require("@theme/ParamsItem"));
@@ -120,14 +76,9 @@ const ParamsDetails = (props) => {
       }),
     },
     () => {
-      const LazyComponent = react_1.default.lazy(() =>
-        Promise.resolve({ default: ParamsDetailsComponent })
-      );
-      return react_1.default.createElement(
-        react_1.Suspense,
-        { fallback: null },
-        react_1.default.createElement(LazyComponent, { ...props })
-      );
+      return react_1.default.createElement(ParamsDetailsComponent, {
+        ...props,
+      });
     }
   );
 };

package/lib/theme/RequestSchema/index.js

@@ -5,57 +5,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
-var __createBinding =
-  (this && this.__createBinding) ||
-  (Object.create
-    ? function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        var desc = Object.getOwnPropertyDescriptor(m, k);
-        if (
-          !desc ||
-          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
-        ) {
-          desc = {
-            enumerable: true,
-            get: function () {
-              return m[k];
-            },
-          };
-        }
-        Object.defineProperty(o, k2, desc);
-      }
-    : function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        o[k2] = m[k];
-      });
-var __setModuleDefault =
-  (this && this.__setModuleDefault) ||
-  (Object.create
-    ? function (o, v) {
-        Object.defineProperty(o, "default", { enumerable: true, value: v });
-      }
-    : function (o, v) {
-        o["default"] = v;
-      });
-var __importStar =
-  (this && this.__importStar) ||
-  function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null)
-      for (var k in mod)
-        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
-          __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-  };
 var __importDefault =
   (this && this.__importDefault) ||
   function (mod) {
     return mod && mod.__esModule ? mod : { default: mod };
   };
 Object.defineProperty(exports, "__esModule", { value: true });
-const react_1 = __importStar(require("react"));
+const react_1 = __importDefault(require("react"));
 const BrowserOnly_1 = __importDefault(require("@docusaurus/BrowserOnly"));
 const Details_1 = __importDefault(require("@theme/Details"));
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
@@ -229,14 +185,9 @@ const RequestSchema = (props) => {
       }),
     },
     () => {
-      const LazyComponent = react_1.default.lazy(() =>
-        Promise.resolve({ default: RequestSchemaComponent })
-      );
-      return react_1.default.createElement(
-        react_1.Suspense,
-        { fallback: null },
-        react_1.default.createElement(LazyComponent, { ...props })
-      );
+      return react_1.default.createElement(RequestSchemaComponent, {
+        ...props,
+      });
     }
   );
 };

package/lib/theme/ResponseExamples/index.js

@@ -14,8 +14,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExampleFromSchema =
   exports.ResponseExample =
   exports.ResponseExamples =
-  exports.json2xml =
     void 0;
+exports.json2xml = json2xml;
 const react_1 = __importDefault(require("react"));
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const ResponseSamples_1 = __importDefault(require("@theme/ResponseSamples"));
@@ -58,7 +58,6 @@ function json2xml(o, tab) {
   for (const m3 in o) xml += toXml(o[m3], m3, "");
   return tab ? xml.replace(/\t/g, tab) : xml.replace(/\t|\n/g, "");
 }
-exports.json2xml = json2xml;
 const ResponseExamples = ({ responseExamples, mimeType }) => {
   let language = "shell";
   if (mimeType.endsWith("json")) language = "json";

package/lib/theme/ResponseSchema/index.js

@@ -5,57 +5,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
-var __createBinding =
-  (this && this.__createBinding) ||
-  (Object.create
-    ? function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        var desc = Object.getOwnPropertyDescriptor(m, k);
-        if (
-          !desc ||
-          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
-        ) {
-          desc = {
-            enumerable: true,
-            get: function () {
-              return m[k];
-            },
-          };
-        }
-        Object.defineProperty(o, k2, desc);
-      }
-    : function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        o[k2] = m[k];
-      });
-var __setModuleDefault =
-  (this && this.__setModuleDefault) ||
-  (Object.create
-    ? function (o, v) {
-        Object.defineProperty(o, "default", { enumerable: true, value: v });
-      }
-    : function (o, v) {
-        o["default"] = v;
-      });
-var __importStar =
-  (this && this.__importStar) ||
-  function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null)
-      for (var k in mod)
-        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
-          __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-  };
 var __importDefault =
   (this && this.__importDefault) ||
   function (mod) {
     return mod && mod.__esModule ? mod : { default: mod };
   };
 Object.defineProperty(exports, "__esModule", { value: true });
-const react_1 = __importStar(require("react"));
+const react_1 = __importDefault(require("react"));
 const BrowserOnly_1 = __importDefault(require("@docusaurus/BrowserOnly"));
 const Details_1 = __importDefault(require("@theme/Details"));
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
@@ -194,14 +150,9 @@ const ResponseSchema = (props) => {
       }),
     },
     () => {
-      const LazyComponent = react_1.default.lazy(() =>
-        Promise.resolve({ default: ResponseSchemaComponent })
-      );
-      return react_1.default.createElement(
-        react_1.Suspense,
-        { fallback: null },
-        react_1.default.createElement(LazyComponent, { ...props })
-      );
+      return react_1.default.createElement(ResponseSchemaComponent, {
+        ...props,
+      });
     }
   );
 };

package/lib/theme/SchemaItem/index.js

@@ -11,6 +11,7 @@ var __importDefault =
     return mod && mod.__esModule ? mod : { default: mod };
   };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = SchemaItem;
 const react_1 = __importDefault(require("react"));
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const clsx_1 = __importDefault(require("clsx"));
@@ -56,7 +57,9 @@ function SchemaItem(props) {
     enumDescriptions = transformEnumDescriptions(schema["x-enumDescriptions"]);
     defaultValue = schema.default;
     example = schema.example;
-    nullable = schema.nullable;
+    nullable =
+      schema.nullable ||
+      (Array.isArray(schema.type) && schema.type.includes("null")); // support JSON Schema nullable
   }
   const renderRequired = (0, utils_1.guard)(
     Array.isArray(required) ? required.includes(name) : required,
@@ -208,4 +211,3 @@ function SchemaItem(props) {
     collapsible ? collapsibleSchemaContent : schemaContent
   );
 }
-exports.default = SchemaItem;

package/lib/theme/SchemaTabs/index.js

@@ -39,22 +39,35 @@ var __setModuleDefault =
       });
 var __importStar =
   (this && this.__importStar) ||
-  function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null)
-      for (var k in mod)
-        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
-          __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-  };
+  (function () {
+    var ownKeys = function (o) {
+      ownKeys =
+        Object.getOwnPropertyNames ||
+        function (o) {
+          var ar = [];
+          for (var k in o)
+            if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+          return ar;
+        };
+      return ownKeys(o);
+    };
+    return function (mod) {
+      if (mod && mod.__esModule) return mod;
+      var result = {};
+      if (mod != null)
+        for (var k = ownKeys(mod), i = 0; i < k.length; i++)
+          if (k[i] !== "default") __createBinding(result, mod, k[i]);
+      __setModuleDefault(result, mod);
+      return result;
+    };
+  })();
 var __importDefault =
   (this && this.__importDefault) ||
   function (mod) {
     return mod && mod.__esModule ? mod : { default: mod };
   };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = SchemaTabs;
 const react_1 = __importStar(require("react"));
 const internal_1 = require("@docusaurus/theme-common/internal");
 const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
@@ -158,7 +171,9 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
             tabIndex: selectedValue === value ? 0 : -1,
             "aria-selected": selectedValue === value,
             key: value,
-            ref: (tabControl) => tabRefs.push(tabControl),
+            ref: (tabControl) => {
+              tabRefs.push(tabControl);
+            },
             onKeyDown: handleKeydown,
             onClick: handleTabChange,
             ...attributes,
@@ -238,4 +253,3 @@ function SchemaTabs(props) {
     (0, internal_1.sanitizeTabsChildren)(props.children)
   );
 }
-exports.default = SchemaTabs;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "4.3.1",
+  "version": "4.3.2",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -34,7 +34,7 @@
     "@types/file-saver": "^2.0.5",
     "@types/lodash": "^4.14.176",
     "concurrently": "^5.2.0",
-    "docusaurus-plugin-openapi-docs": "^4.3.1",
+    "docusaurus-plugin-openapi-docs": "^4.3.2",
     "docusaurus-plugin-sass": "^0.2.3",
     "eslint-plugin-prettier": "^5.0.1"
   },
@@ -69,11 +69,11 @@
     "@docusaurus/theme-common": "^3.5.0",
     "docusaurus-plugin-openapi-docs": "^4.0.0",
     "docusaurus-plugin-sass": "^0.2.3",
-    "react": "^16.8.4 || ^17.0.0 || ^18.0.0",
-    "react-dom": "^16.8.4 || ^17.0.0 || ^18.0.0"
+    "react": "^16.8.4 || ^17.0.0 || ^18.0.0 || ^19.0.0",
+    "react-dom": "^16.8.4 || ^17.0.0 || ^18.0.0 || ^19.0.0"
   },
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "78bfd444c557f94a67344d6276025f4958a921bd"
+  "gitHead": "7f194ce5f563daf13e79cd50babe9139b363cdd0"
 }

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

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { useState, useEffect } from "react";
+import React, { useState, useEffect, type JSX } from "react";
 
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import ApiCodeBlock from "@theme/ApiExplorer/ApiCodeBlock";

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

@@ -44,7 +44,7 @@ function TabList({
   tabValues,
 }: CodeTabsProps & ReturnType<typeof useTabs>) {
   const tabRefs = useRef<(HTMLLIElement | null)[]>([]);
-  const tabsScrollContainerRef = useRef<any>();
+  const tabsScrollContainerRef = useRef<any>(null);
   const { blockElementScrollPositionUntilNextRender } =
     useScrollPositionBlocker();
 
@@ -163,7 +163,11 @@ function TabList({
           tabIndex={selectedValue === value ? 0 : -1}
           aria-selected={selectedValue === value}
           key={value}
-          ref={(tabControl) => tabRefs.current.push(tabControl)}
+          ref={(tabControl) => {
+            if (tabControl) {
+              tabRefs.current.push(tabControl);
+            }
+          }}
           onKeyDown={handleKeydown}
           onClick={handleTabChange}
           {...attributes}

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

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { useEffect, useState } from "react";
+import React, { type JSX, useEffect, useState } from "react";
 
 import { usePrismTheme } from "@docusaurus/theme-common";
 import useIsBrowser from "@docusaurus/useIsBrowser";
@@ -51,7 +51,7 @@ function App({
   ...props
 }: any): JSX.Element {
   const prismTheme = usePrismTheme();
-  const [code, setCode] = React.useState(children);
+  const [code, setCode] = React.useState(children.replace(/\n$/, ""));
 
   useEffect(() => {
     action(setStringRawBody(code));
@@ -76,7 +76,7 @@ function App({
       })}
     >
       <LiveProvider
-        code={children.replace(/\n$/, "")}
+        code={code}
         transformCode={transformCode ?? ((code) => `${code};`)}
         theme={prismTheme}
         language={language}
@@ -84,7 +84,9 @@ function App({
       >
         <Controller
           control={control}
-          rules={{ required: isRequired ? "This field is required" : false }}
+          rules={{
+            required: isRequired && !code ? "This field is required" : false,
+          }}
           name="requestBody"
           render={({ field: { onChange, name } }) => (
             <LiveComponent

package/src/theme/ApiItem/Layout/index.tsx

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React from "react";
+import React, { type JSX } from "react";
 
 import { useDoc } from "@docusaurus/plugin-content-docs/client";
 import { useWindowSize } from "@docusaurus/theme-common";

package/src/theme/ApiItem/index.tsx

@@ -65,7 +65,7 @@ export default function ApiItem(props: Props): JSX.Element {
   if (api) {
     try {
       api = JSON.parse(
-        zlib.inflateSync(Buffer.from(api as any, "base64")).toString()
+        zlib.inflateSync(Buffer.from(api as any, "base64") as any).toString()
       );
     } catch {}
   }

package/src/theme/ApiTabs/index.tsx

@@ -150,7 +150,9 @@ function TabList({
               tabIndex={selectedValue === value ? 0 : -1}
               aria-selected={selectedValue === value}
               key={value}
-              ref={(tabControl) => tabRefs.push(tabControl)}
+              ref={(tabControl) => {
+                tabRefs.push(tabControl);
+              }}
               onKeyDown={handleKeydown}
               onClick={handleTabChange}
               {...attributes}

package/src/theme/DiscriminatorTabs/index.tsx

@@ -136,7 +136,9 @@ function TabList({
               tabIndex={selectedValue === value ? 0 : -1}
               aria-selected={selectedValue === value}
               key={value}
-              ref={(tabControl) => tabRefs.push(tabControl)}
+              ref={(tabControl) => {
+                tabRefs.push(tabControl);
+              }}
               onKeyDown={handleKeydown}
               onClick={handleTabChange}
               {...attributes}

package/src/theme/MimeTabs/index.tsx

@@ -173,7 +173,9 @@ function TabList({
                 tabIndex={selectedValue === value ? 0 : -1}
                 aria-selected={selectedValue === value}
                 key={value}
-                ref={(tabControl) => tabRefs.push(tabControl)}
+                ref={(tabControl) => {
+                  tabRefs.push(tabControl);
+                }}
                 onKeyDown={handleKeydown}
                 onFocus={handleTabChange}
                 onClick={(e) => handleTabChange(e)}

package/src/theme/OperationTabs/index.tsx

@@ -136,7 +136,9 @@ function TabList({
                 tabIndex={selectedValue === value ? 0 : -1}
                 aria-selected={selectedValue === value}
                 key={value}
-                ref={(tabControl) => tabRefs.push(tabControl)}
+                ref={(tabControl) => {
+                  tabRefs.push(tabControl);
+                }}
                 onKeyDown={handleKeydown}
                 onFocus={handleTabChange}
                 onClick={(e) => handleTabChange(e)}

package/src/theme/ParamsDetails/index.tsx

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { Suspense } from "react";
+import React from "react";
 
 import BrowserOnly from "@docusaurus/BrowserOnly";
 import Details from "@theme/Details";
@@ -72,14 +72,7 @@ const ParamsDetails: React.FC<Props> = (props) => {
   return (
     <BrowserOnly fallback={<SkeletonLoader size="sm" />}>
       {() => {
-        const LazyComponent = React.lazy(() =>
-          Promise.resolve({ default: ParamsDetailsComponent })
-        );
-        return (
-          <Suspense fallback={null}>
-            <LazyComponent {...props} />
-          </Suspense>
-        );
+        return <ParamsDetailsComponent {...props} />;
       }}
     </BrowserOnly>
   );

package/src/theme/RequestSchema/index.tsx

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { Suspense } from "react";
+import React from "react";
 
 import BrowserOnly from "@docusaurus/BrowserOnly";
 import Details from "@theme/Details";
@@ -148,14 +148,7 @@ const RequestSchema: React.FC<Props> = (props) => {
   return (
     <BrowserOnly fallback={<SkeletonLoader size="sm" />}>
       {() => {
-        const LazyComponent = React.lazy(() =>
-          Promise.resolve({ default: RequestSchemaComponent })
-        );
-        return (
-          <Suspense fallback={null}>
-            <LazyComponent {...props} />
-          </Suspense>
-        );
+        return <RequestSchemaComponent {...props} />;
       }}
     </BrowserOnly>
   );

package/src/theme/ResponseSchema/index.tsx

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { Suspense } from "react";
+import React from "react";
 
 import BrowserOnly from "@docusaurus/BrowserOnly";
 import Details from "@theme/Details";
@@ -135,14 +135,7 @@ const ResponseSchema: React.FC<Props> = (props) => {
   return (
     <BrowserOnly fallback={<SkeletonLoader size="md" />}>
       {() => {
-        const LazyComponent = React.lazy(() =>
-          Promise.resolve({ default: ResponseSchemaComponent })
-        );
-        return (
-          <Suspense fallback={null}>
-            <LazyComponent {...props} />
-          </Suspense>
-        );
+        return <ResponseSchemaComponent {...props} />;
       }}
     </BrowserOnly>
   );

package/src/theme/SchemaItem/index.tsx

@@ -72,7 +72,9 @@ export default function SchemaItem(props: Props) {
     enumDescriptions = transformEnumDescriptions(schema["x-enumDescriptions"]);
     defaultValue = schema.default;
     example = schema.example;
-    nullable = schema.nullable;
+    nullable =
+      schema.nullable ||
+      (Array.isArray(schema.type) && schema.type.includes("null")); // support JSON Schema nullable
   }
 
   const renderRequired = guard(

package/src/theme/SchemaTabs/index.tsx

@@ -142,7 +142,9 @@ function TabList({
             tabIndex={selectedValue === value ? 0 : -1}
             aria-selected={selectedValue === value}
             key={value}
-            ref={(tabControl) => tabRefs.push(tabControl)}
+            ref={(tabControl) => {
+              tabRefs.push(tabControl);
+            }}
             onKeyDown={handleKeydown}
             onClick={handleTabChange}
             {...attributes}