docusaurus-theme-openapi-docs 0.0.0-1240 → 0.0.0-1247

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.js

@@ -5,6 +5,62 @@
  * 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 () {
+    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) {
@@ -12,7 +68,7 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = ParamBooleanFormItem;
-const react_1 = __importDefault(require("react"));
+const react_1 = __importStar(require("react"));
 const Translate_1 = require("@docusaurus/Translate");
 const error_message_1 = require("@hookform/error-message");
 const FormSelect_1 = __importDefault(require("@theme/ApiExplorer/FormSelect"));
@@ -25,8 +81,23 @@ function ParamBooleanFormItem({ param, label, type, required }) {
   const {
     control,
     formState: { errors },
+    setValue,
   } = (0, react_hook_form_1.useFormContext)();
   const showErrorMessage = errors?.paramBoolean;
+  (0, react_1.useEffect)(() => {
+    if (param.value === undefined) return;
+    const initial =
+      typeof param.value === "boolean" ? String(param.value) : param.value;
+    if (initial === "true" || initial === "false") {
+      setValue("paramBoolean", initial);
+      // Boolean defaults arrive in redux as actual booleans; normalize to the
+      // string form the rest of the form uses.
+      if (typeof param.value === "boolean") {
+        dispatch((0, slice_1.setParam)({ ...param, value: initial }));
+      }
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
   return react_1.default.createElement(
     react_1.default.Fragment,
     null,
@@ -41,11 +112,12 @@ function ParamBooleanFormItem({ param, label, type, required }) {
           : false,
       },
       name: "paramBoolean",
-      render: ({ field: { onChange } }) =>
+      render: ({ field: { onChange, value } }) =>
         react_1.default.createElement(FormSelect_1.default, {
           label: label,
           type: type,
           required: required,
+          value: value ?? "---",
           options: ["---", "true", "false"],
           onChange: (e) => {
             const val = e.target.value;

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem.js

@@ -5,6 +5,62 @@
  * 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 () {
+    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) {
@@ -12,7 +68,7 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = ParamSelectFormItem;
-const react_1 = __importDefault(require("react"));
+const react_1 = __importStar(require("react"));
 const Translate_1 = require("@docusaurus/Translate");
 const error_message_1 = require("@hookform/error-message");
 const FormSelect_1 = __importDefault(require("@theme/ApiExplorer/FormSelect"));
@@ -25,10 +81,17 @@ function ParamSelectFormItem({ param, label, type, required }) {
   const {
     control,
     formState: { errors },
+    setValue,
   } = (0, react_hook_form_1.useFormContext)();
   const showErrorMessage = errors?.paramSelect;
   const dispatch = (0, hooks_1.useTypedDispatch)();
   const options = (0, ParamOptions_1.getSchemaEnum)(param.schema) ?? [];
+  (0, react_1.useEffect)(() => {
+    if (typeof param.value === "string" && options.includes(param.value)) {
+      setValue("paramSelect", param.value);
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
   return react_1.default.createElement(
     react_1.default.Fragment,
     null,
@@ -43,11 +106,12 @@ function ParamSelectFormItem({ param, label, type, required }) {
           : false,
       },
       name: "paramSelect",
-      render: ({ field: { onChange } }) =>
+      render: ({ field: { onChange, value } }) =>
         react_1.default.createElement(FormSelect_1.default, {
           label: label,
           type: type,
           required: required,
+          value: value ?? "---",
           options: ["---", ...options],
           onChange: (e) => {
             const val = e.target.value;

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem.js

@@ -5,6 +5,62 @@
  * 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 () {
+    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) {
@@ -12,14 +68,22 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = ParamTextFormItem;
-const react_1 = __importDefault(require("react"));
+const react_1 = __importStar(require("react"));
 const FormTextInput_1 = __importDefault(
   require("@theme/ApiExplorer/FormTextInput")
 );
 const slice_1 = require("@theme/ApiExplorer/ParamOptions/slice");
 const hooks_1 = require("@theme/ApiItem/hooks");
+const react_hook_form_1 = require("react-hook-form");
 function ParamTextFormItem({ param, label, type, required }) {
   const dispatch = (0, hooks_1.useTypedDispatch)();
+  const { setValue } = (0, react_hook_form_1.useFormContext)();
+  (0, react_1.useEffect)(() => {
+    if (param.value !== undefined && !Array.isArray(param.value)) {
+      setValue(param.name, param.value);
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
   return react_1.default.createElement(FormTextInput_1.default, {
     label: label,
     type: type,

package/lib/theme/ApiItem/index.js

@@ -29,6 +29,7 @@ const storage_utils_1 = require("@theme/ApiExplorer/storage-utils");
 const Layout_1 = __importDefault(require("@theme/ApiItem/Layout"));
 const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
 const Metadata_1 = __importDefault(require("@theme/DocItem/Metadata"));
+const SchemaExpansion_1 = require("@theme/SchemaExpansion");
 const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
 const clsx_1 = __importDefault(require("clsx"));
 const pako_1 = require("pako");
@@ -100,7 +101,10 @@ function ApiItem(props) {
     api?.parameters?.forEach((param) => {
       const paramType = param.in;
       const paramsArray = params[paramType];
-      paramsArray?.push(param);
+      const defaultValue = param.schema?.default;
+      const initialized =
+        defaultValue !== undefined ? { ...param, value: defaultValue } : param;
+      paramsArray?.push(initialized);
     });
     const auth = (0, slice_1.createAuth)({
       security: api?.security,
@@ -154,30 +158,34 @@ function ApiItem(props) {
             react_redux_1.Provider,
             { store: store2 },
             react_1.default.createElement(
-              "div",
-              { className: (0, clsx_1.default)("row", "theme-api-markdown") },
-              react_1.default.createElement(
-                "div",
-                { className: "col col--7 openapi-left-panel__container" },
-                react_1.default.createElement(MDXComponent, null)
-              ),
+              SchemaExpansion_1.SchemaExpansionProvider,
+              null,
               react_1.default.createElement(
                 "div",
-                { className: "col col--5 openapi-right-panel__container" },
+                { className: (0, clsx_1.default)("row", "theme-api-markdown") },
+                react_1.default.createElement(
+                  "div",
+                  { className: "col col--7 openapi-left-panel__container" },
+                  react_1.default.createElement(MDXComponent, null)
+                ),
                 react_1.default.createElement(
-                  BrowserOnly_1.default,
-                  {
-                    fallback: react_1.default.createElement(
-                      SkeletonLoader_1.default,
-                      { size: "lg" }
-                    ),
-                  },
-                  () => {
-                    return react_1.default.createElement(ApiExplorer, {
-                      item: api,
-                      infoPath: infoPath,
-                    });
-                  }
+                  "div",
+                  { className: "col col--5 openapi-right-panel__container" },
+                  react_1.default.createElement(
+                    BrowserOnly_1.default,
+                    {
+                      fallback: react_1.default.createElement(
+                        SkeletonLoader_1.default,
+                        { size: "lg" }
+                      ),
+                    },
+                    () => {
+                      return react_1.default.createElement(ApiExplorer, {
+                        item: api,
+                        infoPath: infoPath,
+                      });
+                    }
+                  )
                 )
               )
             )
@@ -197,20 +205,26 @@ function ApiItem(props) {
           Layout_1.default,
           null,
           react_1.default.createElement(
-            "div",
-            { className: (0, clsx_1.default)("row", "theme-api-markdown") },
-            react_1.default.createElement(
-              "div",
-              { className: "col col--7 openapi-left-panel__container schema" },
-              react_1.default.createElement(MDXComponent, null)
-            ),
+            SchemaExpansion_1.SchemaExpansionProvider,
+            null,
             react_1.default.createElement(
               "div",
-              { className: "col col--5 openapi-right-panel__container" },
+              { className: (0, clsx_1.default)("row", "theme-api-markdown") },
+              react_1.default.createElement(
+                "div",
+                {
+                  className: "col col--7 openapi-left-panel__container schema",
+                },
+                react_1.default.createElement(MDXComponent, null)
+              ),
               react_1.default.createElement(
-                CodeBlock_1.default,
-                { language: "json", title: `${frontMatter.title}` },
-                JSON.stringify(sample, null, 2)
+                "div",
+                { className: "col col--5 openapi-right-panel__container" },
+                react_1.default.createElement(
+                  CodeBlock_1.default,
+                  { language: "json", title: `${frontMatter.title}` },
+                  JSON.stringify(sample, null, 2)
+                )
               )
             )
           )

package/lib/theme/RequestSchema/index.js

@@ -19,6 +19,7 @@ const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const MimeTabs_1 = __importDefault(require("@theme/MimeTabs")); // Assume these components exist
 const ResponseExamples_1 = require("@theme/ResponseExamples");
 const Schema_1 = __importDefault(require("@theme/Schema"));
+const SchemaExpansion_1 = __importDefault(require("@theme/SchemaExpansion"));
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
 const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
@@ -71,32 +72,35 @@ const RequestSchemaComponent = ({ title, body, style }) => {
                       open: true,
                       style: style,
                       summary: react_1.default.createElement(
-                        react_1.default.Fragment,
-                        null,
+                        "summary",
+                        {
+                          className:
+                            "openapi-markdown__details-summary--with-control",
+                        },
                         react_1.default.createElement(
-                          "summary",
-                          null,
-                          react_1.default.createElement(
-                            "h3",
-                            {
-                              className:
-                                "openapi-markdown__details-summary-header-body",
-                            },
-                            (0, Translate_1.translate)({
-                              id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
-                              message: title,
-                            }),
-                            body.required === true &&
-                              react_1.default.createElement(
-                                "span",
-                                { className: "openapi-schema__required" },
-                                (0, Translate_1.translate)({
-                                  id: translationIds_1.OPENAPI_SCHEMA_ITEM
-                                    .REQUIRED,
-                                  message: "required",
-                                })
-                              )
-                          )
+                          "h3",
+                          {
+                            className:
+                              "openapi-markdown__details-summary-header-body",
+                          },
+                          (0, Translate_1.translate)({
+                            id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
+                            message: title,
+                          }),
+                          body.required === true &&
+                            react_1.default.createElement(
+                              "span",
+                              { className: "openapi-schema__required" },
+                              (0, Translate_1.translate)({
+                                id: translationIds_1.OPENAPI_SCHEMA_ITEM
+                                  .REQUIRED,
+                                message: "required",
+                              })
+                            )
+                        ),
+                        react_1.default.createElement(
+                          SchemaExpansion_1.default,
+                          null
                         )
                       ),
                     },
@@ -179,38 +183,36 @@ const RequestSchemaComponent = ({ title, body, style }) => {
               open: true,
               style: style,
               summary: react_1.default.createElement(
-                react_1.default.Fragment,
-                null,
+                "summary",
+                {
+                  className: "openapi-markdown__details-summary--with-control",
+                },
                 react_1.default.createElement(
-                  "summary",
-                  null,
-                  react_1.default.createElement(
-                    "h3",
-                    {
-                      className:
-                        "openapi-markdown__details-summary-header-body",
-                    },
-                    (0, Translate_1.translate)({
-                      id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
-                      message: title,
-                    }),
-                    firstBody.type === "array" &&
-                      react_1.default.createElement(
-                        "span",
-                        { style: { opacity: "0.6" } },
-                        " array"
-                      ),
-                    body.required &&
-                      react_1.default.createElement(
-                        "strong",
-                        { className: "openapi-schema__required" },
-                        (0, Translate_1.translate)({
-                          id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
-                          message: "required",
-                        })
-                      )
-                  )
-                )
+                  "h3",
+                  {
+                    className: "openapi-markdown__details-summary-header-body",
+                  },
+                  (0, Translate_1.translate)({
+                    id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
+                    message: title,
+                  }),
+                  firstBody.type === "array" &&
+                    react_1.default.createElement(
+                      "span",
+                      { style: { opacity: "0.6" } },
+                      " array"
+                    ),
+                  body.required &&
+                    react_1.default.createElement(
+                      "strong",
+                      { className: "openapi-schema__required" },
+                      (0, Translate_1.translate)({
+                        id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
+                        message: "required",
+                      })
+                    )
+                ),
+                react_1.default.createElement(SchemaExpansion_1.default, null)
               ),
             },
             react_1.default.createElement(

package/lib/theme/ResponseSchema/index.js

@@ -19,6 +19,7 @@ const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const MimeTabs_1 = __importDefault(require("@theme/MimeTabs")); // Assume these components exist
 const ResponseExamples_1 = require("@theme/ResponseExamples");
 const Schema_1 = __importDefault(require("@theme/Schema"));
+const SchemaExpansion_1 = __importDefault(require("@theme/SchemaExpansion"));
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
 const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
@@ -83,29 +84,31 @@ const ResponseSchemaComponent = ({ title, body, style }) => {
                     open: true,
                     style: style,
                     summary: react_1.default.createElement(
-                      react_1.default.Fragment,
-                      null,
+                      "summary",
+                      {
+                        className:
+                          "openapi-markdown__details-summary--with-control",
+                      },
                       react_1.default.createElement(
-                        "summary",
-                        null,
-                        react_1.default.createElement(
-                          "strong",
-                          {
-                            className:
-                              "openapi-markdown__details-summary-response",
-                          },
-                          title,
-                          body.required === true &&
-                            react_1.default.createElement(
-                              "span",
-                              { className: "openapi-schema__required" },
-                              (0, Translate_1.translate)({
-                                id: translationIds_1.OPENAPI_SCHEMA_ITEM
-                                  .REQUIRED,
-                                message: "required",
-                              })
-                            )
-                        )
+                        "strong",
+                        {
+                          className:
+                            "openapi-markdown__details-summary-response",
+                        },
+                        title,
+                        body.required === true &&
+                          react_1.default.createElement(
+                            "span",
+                            { className: "openapi-schema__required" },
+                            (0, Translate_1.translate)({
+                              id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
+                              message: "required",
+                            })
+                          )
+                      ),
+                      react_1.default.createElement(
+                        SchemaExpansion_1.default,
+                        null
                       )
                     ),
                   },

package/lib/theme/Schema/index.js

@@ -77,6 +77,7 @@ const DiscriminatorTabs_1 = __importDefault(
   require("@theme/DiscriminatorTabs")
 );
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
+const SchemaExpansion_1 = require("@theme/SchemaExpansion");
 const SchemaItem_1 = __importDefault(require("@theme/SchemaItem"));
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
@@ -644,13 +645,18 @@ const SchemaNodeDetails = ({
   schemaType,
   schemaPath,
 }) => {
+  const depth = (0, SchemaExpansion_1.useSchemaDepth)();
+  const { level } = (0, SchemaExpansion_1.useSchemaExpansion)();
+  const defaultOpen = depth < level;
   return react_1.default.createElement(
     SchemaItem_1.default,
     { collapsible: true },
     react_1.default.createElement(
       Details_1.default,
       {
+        key: `level-${level}`,
         className: "openapi-markdown__details",
+        open: defaultOpen,
         summary: react_1.default.createElement(Summary, {
           name: name,
           schemaName: schemaName,
@@ -669,11 +675,15 @@ const SchemaNodeDetails = ({
           react_1.default.createElement(MarkdownWrapper, {
             text: (0, schema_1.getQualifierMessage)(schema),
           }),
-        react_1.default.createElement(SchemaNode, {
-          schema: schema,
-          schemaType: schemaType,
-          schemaPath: schemaPath,
-        })
+        react_1.default.createElement(
+          SchemaExpansion_1.SchemaDepthProvider,
+          { depth: depth + 1 },
+          react_1.default.createElement(SchemaNode, {
+            schema: schema,
+            schemaType: schemaType,
+            schemaPath: schemaPath,
+          })
+        )
       )
     )
   );