docusaurus-theme-openapi-docs 0.0.0-1083 → 0.0.0-1085

package/lib/theme/ApiExplorer/Authorization/slice.js

@@ -40,7 +40,9 @@ const auth_types_1 = require("./auth-types");
 // BearerAuth                -> { token: xxx }
 // BasicAuth                 -> { username: xxx, password: xxx }
 function createAuth({ security, securitySchemes, options: opts }) {
-  const storage = (0, storage_utils_1.createStorage)("sessionStorage");
+  const storage = (0, storage_utils_1.createStorage)(
+    opts?.authPersistence ?? "sessionStorage"
+  );
   let data = {};
   let options = {};
   for (const option of security ?? []) {

package/lib/theme/ApiExplorer/Body/FileArrayFormBodyItem/index.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+interface FileArrayFormItemProps {
+    id: string;
+    description: string | undefined;
+}
+export default function FileArrayFormBodyItem({ id, description, }: FileArrayFormItemProps): React.JSX.Element;
+export {};

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

@@ -0,0 +1,126 @@
+"use strict";
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * 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) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = FileArrayFormBodyItem;
+const react_1 = __importStar(require("react"));
+const FormFileUpload_1 = __importDefault(
+  require("@theme/ApiExplorer/FormFileUpload")
+);
+const hooks_1 = require("@theme/ApiItem/hooks");
+const slice_1 = require("../slice");
+function FileArrayFormBodyItem({ id, description }) {
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  const [fileItems, setFileItems] = (0, react_1.useState)(
+    new Map([[0, undefined]])
+  );
+  const handleFileChange = (index, file) => {
+    const newItems = new Map(fileItems);
+    if (file === undefined) {
+      newItems.delete(index);
+      setFileItems(newItems);
+      dispatch(
+        (0, slice_1.setFileArrayFormBody)({
+          key: id,
+          value: [...newItems.values()].filter((item) => item !== undefined),
+        })
+      );
+      return;
+    }
+    let maxIndex = 0;
+    newItems.keys().forEach((item) => {
+      maxIndex = item > maxIndex ? item : maxIndex;
+    });
+    newItems.set(index, {
+      src: `/path/to/${file.name}`,
+      content: file,
+    });
+    newItems.set(index + 1, undefined);
+    setFileItems(newItems);
+    dispatch(
+      (0, slice_1.setFileArrayFormBody)({
+        key: id,
+        value: [...newItems.values()].filter((item) => item !== undefined),
+      })
+    );
+  };
+  return react_1.default.createElement(
+    "div",
+    null,
+    [...fileItems.keys()].map((index) =>
+      react_1.default.createElement(
+        "div",
+        { key: index },
+        react_1.default.createElement(FormFileUpload_1.default, {
+          placeholder: description || id,
+          onChange: (file) => handleFileChange(index, file),
+        })
+      )
+    )
+  );
+}

package/lib/theme/ApiExplorer/Body/FormBodyItem/index.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import { SchemaObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
+interface FormBodyItemProps {
+    schemaObject: SchemaObject;
+    id: string;
+    schema: SchemaObject;
+}
+export default function FormBodyItem({ schemaObject, id, schema, }: FormBodyItemProps): React.JSX.Element;
+export {};

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

@@ -0,0 +1,110 @@
+"use strict";
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = FormBodyItem;
+const react_1 = __importDefault(require("react"));
+const FormFileUpload_1 = __importDefault(
+  require("@theme/ApiExplorer/FormFileUpload")
+);
+const FormSelect_1 = __importDefault(require("@theme/ApiExplorer/FormSelect"));
+const FormTextInput_1 = __importDefault(
+  require("@theme/ApiExplorer/FormTextInput")
+);
+const LiveEditor_1 = __importDefault(require("@theme/ApiExplorer/LiveEditor"));
+const hooks_1 = require("@theme/ApiItem/hooks");
+const slice_1 = require("../slice");
+const FileArrayFormBodyItem_1 = __importDefault(
+  require("../FileArrayFormBodyItem")
+);
+function FormBodyItem({ schemaObject, id, schema }) {
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  if (
+    schemaObject.type === "array" &&
+    schemaObject.items?.format === "binary"
+  ) {
+    return react_1.default.createElement(FileArrayFormBodyItem_1.default, {
+      id: id,
+      description: schemaObject.description,
+    });
+  }
+  if (schemaObject.format === "binary") {
+    return react_1.default.createElement(FormFileUpload_1.default, {
+      placeholder: schemaObject.description || id,
+      onChange: (file) => {
+        if (file === undefined) {
+          dispatch((0, slice_1.clearFormBodyKey)(id));
+          return;
+        }
+        dispatch(
+          (0, slice_1.setFileFormBody)({
+            key: id,
+            value: {
+              src: `/path/to/${file.name}`,
+              content: file,
+            },
+          })
+        );
+      },
+    });
+  }
+  if (
+    schemaObject.type === "object" &&
+    (schemaObject.example || schemaObject.examples)
+  ) {
+    const objectExample = JSON.stringify(
+      schemaObject.example ?? schemaObject.examples[0],
+      null,
+      2
+    );
+    return react_1.default.createElement(
+      LiveEditor_1.default,
+      {
+        action: (code) =>
+          dispatch((0, slice_1.setStringFormBody)({ key: id, value: code })),
+      },
+      objectExample
+    );
+  }
+  if (
+    schemaObject.enum &&
+    schemaObject.enum.every((value) => typeof value === "string")
+  ) {
+    return react_1.default.createElement(FormSelect_1.default, {
+      options: ["---", ...schemaObject.enum],
+      onChange: (e) => {
+        const val = e.target.value;
+        if (val === "---") {
+          dispatch((0, slice_1.clearFormBodyKey)(id));
+        } else {
+          dispatch(
+            (0, slice_1.setStringFormBody)({
+              key: id,
+              value: val,
+            })
+          );
+        }
+      },
+    });
+  }
+  // TODO: support all the other types.
+  return react_1.default.createElement(FormTextInput_1.default, {
+    paramName: id,
+    isRequired: Array.isArray(schema.required) && schema.required.includes(id),
+    placeholder: schemaObject.description || id,
+    onChange: (e) => {
+      dispatch(
+        (0, slice_1.setStringFormBody)({ key: id, value: e.target.value })
+      );
+    },
+  });
+}

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

@@ -18,10 +18,6 @@ const FormFileUpload_1 = __importDefault(
   require("@theme/ApiExplorer/FormFileUpload")
 );
 const FormItem_1 = __importDefault(require("@theme/ApiExplorer/FormItem"));
-const FormSelect_1 = __importDefault(require("@theme/ApiExplorer/FormSelect"));
-const FormTextInput_1 = __importDefault(
-  require("@theme/ApiExplorer/FormTextInput")
-);
 const LiveEditor_1 = __importDefault(require("@theme/ApiExplorer/LiveEditor"));
 const hooks_1 = require("@theme/ApiItem/hooks");
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
@@ -30,6 +26,7 @@ const TabItem_1 = __importDefault(require("@theme/TabItem"));
 const translationIds_1 = require("@theme/translationIds");
 const xml_formatter_1 = __importDefault(require("xml-formatter"));
 const slice_1 = require("./slice");
+const FormBodyItem_1 = __importDefault(require("./FormBodyItem"));
 function BodyWrap({
   requestBodyMetadata,
   jsonRequestBodyExample,
@@ -118,94 +115,22 @@ function Body({
     return react_1.default.createElement(
       FormItem_1.default,
       { className: "openapi-explorer__form-item-body-container" },
-      react_1.default.createElement(
-        "div",
-        null,
-        Object.entries(schema.properties ?? {}).map(([key, val]) => {
-          if (val.format === "binary") {
-            return react_1.default.createElement(
-              FormItem_1.default,
-              {
-                key: key,
-                label: key,
-                required:
-                  Array.isArray(schema.required) &&
-                  schema.required.includes(key),
-              },
-              react_1.default.createElement(FormFileUpload_1.default, {
-                placeholder: val.description || key,
-                onChange: (file) => {
-                  if (file === undefined) {
-                    dispatch((0, slice_1.clearFormBodyKey)(key));
-                    return;
-                  }
-                  dispatch(
-                    (0, slice_1.setFileFormBody)({
-                      key: key,
-                      value: {
-                        src: `/path/to/${file.name}`,
-                        content: file,
-                      },
-                    })
-                  );
-                },
-              })
-            );
-          }
-          if (val.enum) {
-            return react_1.default.createElement(
-              FormItem_1.default,
-              {
-                key: key,
-                label: key,
-                required:
-                  Array.isArray(schema.required) &&
-                  schema.required.includes(key),
-              },
-              react_1.default.createElement(FormSelect_1.default, {
-                options: ["---", ...val.enum],
-                onChange: (e) => {
-                  const val = e.target.value;
-                  if (val === "---") {
-                    dispatch((0, slice_1.clearFormBodyKey)(key));
-                  } else {
-                    dispatch(
-                      (0, slice_1.setStringFormBody)({
-                        key: key,
-                        value: val,
-                      })
-                    );
-                  }
-                },
-              })
-            );
-          }
-          // TODO: support all the other types.
-          return react_1.default.createElement(
-            FormItem_1.default,
-            {
-              key: key,
-              label: key,
-              required:
-                Array.isArray(schema.required) && schema.required.includes(key),
-            },
-            react_1.default.createElement(FormTextInput_1.default, {
-              paramName: key,
-              isRequired:
-                Array.isArray(schema.required) && schema.required.includes(key),
-              placeholder: val.description || key,
-              onChange: (e) => {
-                dispatch(
-                  (0, slice_1.setStringFormBody)({
-                    key: key,
-                    value: e.target.value,
-                  })
-                );
-              },
-            })
-          );
-        })
-      )
+      Object.entries(schema.properties ?? {}).map(([key, val]) => {
+        return react_1.default.createElement(
+          FormItem_1.default,
+          {
+            key: key,
+            label: key,
+            required:
+              Array.isArray(schema.required) && schema.required.includes(key),
+          },
+          react_1.default.createElement(FormBodyItem_1.default, {
+            schemaObject: val,
+            id: key,
+            schema: schema,
+          })
+        );
+      })
     );
   }
   let language = "plaintext";
@@ -343,7 +268,11 @@ function Body({
           },
           react_1.default.createElement(
             LiveEditor_1.default,
-            { action: dispatch, language: language, required: required },
+            {
+              action: (code) => dispatch((0, slice_1.setStringRawBody)(code)),
+              language: language,
+              required: required,
+            },
             defaultBody
           )
         ),
@@ -359,7 +288,11 @@ function Body({
           exampleBody &&
             react_1.default.createElement(
               LiveEditor_1.default,
-              { action: dispatch, language: language, required: required },
+              {
+                action: (code) => dispatch((0, slice_1.setStringRawBody)(code)),
+                language: language,
+                required: required,
+              },
               exampleBody
             )
         )
@@ -385,7 +318,11 @@ function Body({
           },
           react_1.default.createElement(
             LiveEditor_1.default,
-            { action: dispatch, language: language, required: required },
+            {
+              action: (code) => dispatch((0, slice_1.setStringRawBody)(code)),
+              language: language,
+              required: required,
+            },
             defaultBody
           )
         ),
@@ -408,7 +345,11 @@ function Body({
               example.body &&
                 react_1.default.createElement(
                   LiveEditor_1.default,
-                  { action: dispatch, language: language },
+                  {
+                    action: (code) =>
+                      dispatch((0, slice_1.setStringRawBody)(code)),
+                    language: language,
+                  },
                   example.body
                 )
             )
@@ -422,7 +363,11 @@ function Body({
     null,
     react_1.default.createElement(
       LiveEditor_1.default,
-      { action: dispatch, language: language, required: required },
+      {
+        action: (code) => dispatch((0, slice_1.setStringRawBody)(code)),
+        language: language,
+        required: required,
+      },
       defaultBody
     )
   );

package/lib/theme/ApiExplorer/Body/slice.d.ts

@@ -6,11 +6,18 @@ export interface FileContent {
         content: Blob;
     };
 }
+export interface FileArrayContent {
+    type: "file[]";
+    value: {
+        src: string;
+        content: Blob;
+    }[];
+}
 export interface StringContent {
     type: "string";
     value?: string;
 }
-export type Content = FileContent | StringContent | undefined;
+export type Content = FileContent | FileArrayContent | StringContent | undefined;
 export interface FormBody {
     type: "form";
     content: {
@@ -67,6 +74,21 @@ export declare const slice: import("@reduxjs/toolkit").Slice<FormBody | RawBody
             };
         };
     };
+    setFileArrayFormBody: (state: import("immer").WritableDraft<FormBody> | import("immer").WritableDraft<RawBody> | import("immer").WritableDraft<EmptyBody>, action: PayloadAction<{
+        key: string;
+        value: FileArrayContent["value"];
+    }>) => import("immer").WritableDraft<FormBody> | {
+        type: "form";
+        content: {
+            [x: string]: {
+                type: "file[]";
+                value: {
+                    src: string;
+                    content: Blob;
+                }[];
+            };
+        };
+    };
 }, "body", "body", import("@reduxjs/toolkit").SliceSelectors<FormBody | RawBody | EmptyBody>>;
 export declare const clearRawBody: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"body/clearRawBody">, setStringRawBody: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "body/setStringRawBody">, setFileRawBody: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     src: string;
@@ -77,6 +99,9 @@ export declare const clearRawBody: import("@reduxjs/toolkit").ActionCreatorWitho
 }, "body/setStringFormBody">, setFileFormBody: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     key: string;
     value: FileContent["value"];
-}, "body/setFileFormBody">;
+}, "body/setFileFormBody">, setFileArrayFormBody: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    key: string;
+    value: FileArrayContent["value"];
+}, "body/setFileArrayFormBody">;
 declare const _default: import("redux").Reducer<FormBody | RawBody | EmptyBody>;
 export default _default;

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

@@ -7,7 +7,8 @@
  * ========================================================================== */
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setFileFormBody =
+exports.setFileArrayFormBody =
+  exports.setFileFormBody =
   exports.setStringFormBody =
   exports.clearFormBodyKey =
   exports.setFileRawBody =
@@ -85,6 +86,24 @@ exports.slice = (0, toolkit_1.createSlice)({
       };
       return state;
     },
+    setFileArrayFormBody: (state, action) => {
+      if (state?.type !== "form") {
+        return {
+          type: "form",
+          content: {
+            [action.payload.key]: {
+              type: "file[]",
+              value: action.payload.value,
+            },
+          },
+        };
+      }
+      state.content[action.payload.key] = {
+        type: "file[]",
+        value: action.payload.value,
+      };
+      return state;
+    },
   },
 });
 ((_a = exports.slice.actions),
@@ -93,5 +112,6 @@ exports.slice = (0, toolkit_1.createSlice)({
   (exports.setFileRawBody = _a.setFileRawBody),
   (exports.clearFormBodyKey = _a.clearFormBodyKey),
   (exports.setStringFormBody = _a.setStringFormBody),
-  (exports.setFileFormBody = _a.setFileFormBody));
+  (exports.setFileFormBody = _a.setFileFormBody),
+  (exports.setFileArrayFormBody = _a.setFileArrayFormBody));
 exports.default = exports.slice.reducer;

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

@@ -72,7 +72,6 @@ const theme_common_1 = require("@docusaurus/theme-common");
 const Translate_1 = require("@docusaurus/Translate");
 const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
 const error_message_1 = require("@hookform/error-message");
-const slice_1 = require("@theme/ApiExplorer/Body/slice");
 const translationIds_1 = require("@theme/translationIds");
 const clsx_1 = __importDefault(require("clsx"));
 const react_hook_form_1 = require("react-hook-form");
@@ -112,8 +111,8 @@ function App({
   const prismTheme = (0, theme_common_1.usePrismTheme)();
   const [code, setCode] = react_1.default.useState(children.replace(/\n$/, ""));
   (0, react_1.useEffect)(() => {
-    action((0, slice_1.setStringRawBody)(code));
-  }, [action, code]);
+    action(code);
+  }, [code]);
   const {
     control,
     formState: { errors },

package/lib/theme/ApiExplorer/buildPostmanRequest.js

@@ -331,7 +331,11 @@ function setBody(clonedPostman, body) {
   switch (clonedPostman.body.mode) {
     case "raw": {
       // check file even though it should already be set from above
-      if (body.type !== "raw" || body.content?.type === "file") {
+      if (
+        body.type !== "raw" ||
+        body.content?.type === "file" ||
+        body.content?.type === "file[]"
+      ) {
         clonedPostman.body = undefined;
         return;
       }
@@ -346,15 +350,23 @@ function setBody(clonedPostman, body) {
         clonedPostman.body.raw = `${body.content?.value}`;
         return;
       }
-      const params = Object.entries(body.content)
+      const params = [];
+      Object.entries(body.content)
         .filter((entry) => !!entry[1])
-        .map(([key, content]) => {
+        .forEach(([key, content]) => {
           if (content.type === "file") {
-            return new sdk.FormParam({ key: key, ...content });
+            params.push(new sdk.FormParam({ key: key, ...content }));
+          } else if (content.type === "file[]") {
+            content.value.forEach((file) =>
+              params.push(new sdk.FormParam({ key, value: file }))
+            );
+          } else {
+            params.push(new sdk.FormParam({ key: key, value: content.value }));
           }
-          return new sdk.FormParam({ key: key, value: content.value });
         });
-      clonedPostman.body.formdata?.assimilate(params, false);
+      params.forEach((param) => {
+        clonedPostman.body?.formdata?.add(param);
+      });
       return;
     }
     case "urlencoded": {
@@ -368,7 +380,11 @@ function setBody(clonedPostman, body) {
       const params = Object.entries(body.content)
         .filter((entry) => !!entry[1])
         .map(([key, content]) => {
-          if (content.type !== "file" && content.value) {
+          if (
+            content.type !== "file" &&
+            content.type !== "file[]" &&
+            content.value
+          ) {
             return new sdk.QueryParam({ key: key, value: content.value });
           }
           return undefined;

package/lib/theme/ApiExplorer/{persistanceMiddleware.d.ts → persistenceMiddleware.d.ts}

@@ -1,6 +1,6 @@
-import { Middleware } from "@reduxjs/toolkit";
-import { ThemeConfig } from "docusaurus-theme-openapi-docs/src/types";
-export declare function createPersistanceMiddleware(options: ThemeConfig["api"]): Middleware<{}, {
+import type { Middleware } from "@reduxjs/toolkit";
+import type { ThemeConfig } from "docusaurus-theme-openapi-docs/src/types";
+export declare function createPersistenceMiddleware(options: ThemeConfig["api"]): Middleware<{}, {
     accept: import("./Accept/slice").State;
     contentType: import("./ContentType/slice").State;
     response: import("./Response/slice").State;