docusaurus-theme-openapi-docs 4.5.0 → 4.6.0

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/CodeSnippets/index.d.ts

@@ -5,6 +5,7 @@ export declare const languageSet: Language[];
 export interface Props {
     postman: sdk.Request;
     codeSamples: CodeSample[];
+    maskCredentials?: boolean;
 }
-declare function CodeSnippets({ postman, codeSamples }: Props): React.JSX.Element | null;
+declare function CodeSnippets({ postman, codeSamples, maskCredentials: propMaskCredentials, }: Props): React.JSX.Element | null;
 export default CodeSnippets;

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

@@ -93,7 +93,11 @@ function CodeTab({ children, hidden, className }) {
     children
   );
 }
-function CodeSnippets({ postman, codeSamples }) {
+function CodeSnippets({
+  postman,
+  codeSamples,
+  maskCredentials: propMaskCredentials,
+}) {
   const { siteConfig } = (0, useDocusaurusContext_1.default)();
   const contentType = (0, hooks_1.useTypedSelector)(
     (state) => state.contentType.value
@@ -114,29 +118,36 @@ function CodeSnippets({ postman, codeSamples }) {
     (state) => state.params.header
   );
   const auth = (0, hooks_1.useTypedSelector)((state) => state.auth);
-  const clonedAuth = (0, cloneDeep_1.default)(auth);
-  let placeholder;
-  function cleanCredentials(obj) {
-    for (const key in obj) {
-      if (typeof obj[key] === "object" && obj[key] !== null) {
-        // use name as placeholder if exists
-        const comboAuthId = Object.keys(obj).join(" and ");
-        const authOptions =
-          clonedAuth?.options?.[key] ?? clonedAuth?.options?.[comboAuthId];
-        placeholder = authOptions?.[0]?.name;
-        obj[key] = cleanCredentials(obj[key]);
-      } else {
-        obj[key] = `<${placeholder ?? key}>`;
-      }
-    }
-    return obj;
-  }
-  // scrub credentials from code snippets
-  const cleanedAuth = {
-    ...clonedAuth,
-    data: cleanCredentials(clonedAuth.data),
-  };
-  // Create a Postman request object using cleanedAuth
+  // Check if credential masking is enabled (default: true)
+  const maskCredentials = propMaskCredentials ?? true;
+  // Clone Auth if maskCredentials is not false
+  const cleanedAuth = maskCredentials
+    ? (() => {
+        const clonedAuth = (0, cloneDeep_1.default)(auth);
+        let placeholder;
+        function cleanCredentials(obj) {
+          for (const key in obj) {
+            if (typeof obj[key] === "object" && obj[key] !== null) {
+              // use name as placeholder if exists
+              const comboAuthId = Object.keys(obj).join(" and ");
+              const authOptions =
+                clonedAuth?.options?.[key] ??
+                clonedAuth?.options?.[comboAuthId];
+              placeholder = authOptions?.find((opt) => opt.key === key)?.name;
+              obj[key] = cleanCredentials(obj[key]);
+            } else {
+              obj[key] = `<${placeholder ?? key}>`;
+            }
+          }
+          return obj;
+        }
+        return {
+          ...clonedAuth,
+          data: cleanCredentials(clonedAuth.data),
+        };
+      })()
+    : auth;
+  // Create a Postman request object using cleanedAuth or original auth
   const cleanedPostmanRequest = (0, buildPostmanRequest_1.default)(postman, {
     queryParams,
     pathParams,
@@ -314,7 +325,7 @@ function CodeSnippets({ postman, codeSamples }) {
                   setSelectedSample: setSelectedSample,
                 },
                 includeSample: true,
-                currentLanguage: lang.language,
+                currentLanguage: lang,
                 defaultValue: selectedSample,
                 languageSet: mergedLangs,
                 lazy: true,
@@ -353,7 +364,7 @@ function CodeSnippets({ postman, codeSamples }) {
                 setSelectedVariant: setSelectedVariant,
               },
               includeVariant: true,
-              currentLanguage: lang.language,
+              currentLanguage: lang,
               defaultValue: selectedVariant,
               languageSet: mergedLangs,
               lazy: true,

package/lib/theme/ApiExplorer/CodeTabs/_CodeTabs.scss

@@ -197,7 +197,11 @@ body[class="ReactModal__Body--open"] {
   }
 
   &.active {
-    box-shadow: 0 0 0 3px var(--openapi-code-tab-shadow-color-curl);
+    box-shadow: 0 0 0 3px
+      var(
+        --openapi-code-tab-shadow-color-curl,
+        var(--openapi-code-tab-shadow-color-bash)
+      );
     border-color: var(--ifm-color-danger);
   }
 }

package/lib/theme/ApiExplorer/CodeTabs/index.d.ts

@@ -1,13 +1,13 @@
 import React from "react";
 import { type TabProps } from "@docusaurus/theme-common/internal";
-import { Language } from "@theme/ApiExplorer/CodeSnippets";
+import { Language } from "../CodeSnippets/code-snippets-types";
 export interface Props {
     action: {
         [key: string]: React.Dispatch<any>;
     };
-    currentLanguage: Language;
+    currentLanguage?: Language;
     languageSet: Language[];
-    includeVariant: boolean;
+    includeVariant?: boolean;
 }
 export interface CodeTabsProps extends Props, TabProps {
     includeSample?: boolean;

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

@@ -122,13 +122,13 @@ function TabList({
       let newLanguage;
       if (currentLanguage && includeVariant) {
         newLanguage = languageSet.filter(
-          (lang) => lang.language === currentLanguage
+          (lang) => lang.language === currentLanguage.language
         )[0];
         newLanguage.variant = newTabValue;
         action.setSelectedVariant(newTabValue.toLowerCase());
       } else if (currentLanguage && includeSample) {
         newLanguage = languageSet.filter(
-          (lang) => lang.language === currentLanguage
+          (lang) => lang.language === currentLanguage.language
         )[0];
         newLanguage.sample = newTabValue;
         action.setSelectedSample(newTabValue);

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

@@ -4,8 +4,11 @@ export interface State {
     options: string[];
 }
 export declare const slice: import("@reduxjs/toolkit").Slice<State, {
-    setContentType: (state: import("immer/dist/internal").WritableDraft<State>, action: PayloadAction<string>) => void;
-}, "contentType">;
+    setContentType: (state: {
+        value: string;
+        options: string[];
+    }, action: PayloadAction<string>) => void;
+}, "contentType", "contentType", import("@reduxjs/toolkit").SliceSelectors<State>>;
 export declare const setContentType: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "contentType/setContentType">;
 declare const _default: import("redux").Reducer<State>;
 export default _default;

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

@@ -68,9 +68,11 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importStar(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
 const FloatingButton_1 = __importDefault(
   require("@theme/ApiExplorer/FloatingButton")
 );
+const translationIds_1 = require("@theme/translationIds");
 const react_magic_dropzone_1 = __importDefault(require("react-magic-dropzone"));
 function RenderPreview({ file }) {
   switch (file.type) {
@@ -158,7 +160,10 @@ function FormFileUpload({ placeholder, onChange }) {
                   setAndNotifyFile(undefined);
                 },
               },
-              "Clear"
+              (0, Translate_1.translate)({
+                id: translationIds_1.OPENAPI_FORM_FILE_UPLOAD.CLEAR_BUTTON,
+                message: "Clear",
+              })
             ),
             react_1.default.createElement(RenderPreview, { file: file })
           )

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

@@ -12,6 +12,8 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
+const translationIds_1 = require("@theme/translationIds");
 const clsx_1 = __importDefault(require("clsx"));
 function FormItem({ label, type, required, children, className }) {
   return react_1.default.createElement(
@@ -36,7 +38,10 @@ function FormItem({ label, type, required, children, className }) {
       react_1.default.createElement(
         "span",
         { className: "openapi-schema__required" },
-        "required"
+        (0, Translate_1.translate)({
+          id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
+          message: "required",
+        })
       ),
     react_1.default.createElement("div", null, children)
   );

package/lib/theme/ApiExplorer/FormTextInput/index.d.ts

@@ -4,6 +4,8 @@ export interface Props {
     placeholder?: string;
     password?: boolean;
     onChange?: React.ChangeEventHandler<HTMLInputElement>;
+    paramName?: string;
+    isRequired?: boolean;
 }
 declare function FormTextInput({ isRequired, value, placeholder, password, onChange, paramName, }: Props): React.JSX.Element;
 export default FormTextInput;

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

@@ -13,7 +13,9 @@ var __importDefault =
 Object.defineProperty(exports, "__esModule", { value: true });
 // @ts-nocheck
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
 const error_message_1 = require("@hookform/error-message");
+const translationIds_1 = require("@theme/translationIds");
 const clsx_1 = __importDefault(require("clsx"));
 const react_hook_form_1 = require("react-hook-form");
 function FormTextInput({
@@ -36,7 +38,12 @@ function FormTextInput({
     paramName
       ? react_1.default.createElement("input", {
           ...register(paramName, {
-            required: isRequired ? "This field is required" : false,
+            required: isRequired
+              ? (0, Translate_1.translate)({
+                  id: translationIds_1.OPENAPI_FORM.FIELD_REQUIRED,
+                  message: "This field is required",
+                })
+              : false,
           }),
           className: (0, clsx_1.default)("openapi-explorer__form-item-input", {
             error: showErrorMessage,

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

@@ -69,9 +69,10 @@ var __importDefault =
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importStar(require("react"));
 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");
 const react_live_1 = require("react-live");
@@ -110,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 },
@@ -140,7 +141,13 @@ function App({
       react_1.default.createElement(react_hook_form_1.Controller, {
         control: control,
         rules: {
-          required: isRequired && !code ? "This field is required" : false,
+          required:
+            isRequired && !code
+              ? (0, Translate_1.translate)({
+                  id: translationIds_1.OPENAPI_FORM.FIELD_REQUIRED,
+                  message: "This field is required",
+                })
+              : false,
         },
         name: "requestBody",
         render: ({ field: { onChange, name } }) =>

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

@@ -69,6 +69,7 @@ var __importDefault =
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = ParamArrayFormItem;
 const react_1 = __importStar(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
 const error_message_1 = require("@hookform/error-message");
 const toolkit_1 = require("@reduxjs/toolkit");
 const FormSelect_1 = __importDefault(require("@theme/ApiExplorer/FormSelect"));
@@ -77,6 +78,7 @@ const FormTextInput_1 = __importDefault(
 );
 const slice_1 = require("@theme/ApiExplorer/ParamOptions/slice");
 const hooks_1 = require("@theme/ApiItem/hooks");
+const translationIds_1 = require("@theme/translationIds");
 const react_hook_form_1 = require("react-hook-form");
 function ArrayItem({ param, onChange, initialValue }) {
   const [value, setValue] = (0, react_1.useState)(initialValue || "");
@@ -126,14 +128,15 @@ function ParamArrayFormItem({ param }) {
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [items]);
   (0, react_1.useEffect)(() => {
-    if (param.schema?.example?.length > 0) {
-      const examplesWithIds = param.schema.example.map((item) => ({
+    const example = param.schema?.example;
+    if (Array.isArray(example) && example.length > 0) {
+      const examplesWithIds = example.map((item) => ({
         id: (0, toolkit_1.nanoid)(),
         value: item.toString(),
       }));
       setItems(examplesWithIds);
     }
-  }, [param.schema.example, param.schema.length]);
+  }, [param.schema?.example]);
   function handleDeleteItem(itemToDelete) {
     return () => {
       const newItems = items.filter((i) => i.id !== itemToDelete.id);
@@ -157,9 +160,16 @@ function ParamArrayFormItem({ param }) {
     null,
     react_1.default.createElement(react_hook_form_1.Controller, {
       control: control,
-      rules: { required: param.required ? "This field is required" : false },
+      rules: {
+        required: param.required
+          ? (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_FORM.FIELD_REQUIRED,
+              message: "This field is required",
+            })
+          : false,
+      },
       name: "paramArray",
-      render: ({ field: { onChange, name } }) =>
+      render: ({ field: { onChange } }) =>
         react_1.default.createElement(
           react_1.default.Fragment,
           null,

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

@@ -13,10 +13,12 @@ var __importDefault =
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = ParamBooleanFormItem;
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
 const error_message_1 = require("@hookform/error-message");
 const FormSelect_1 = __importDefault(require("@theme/ApiExplorer/FormSelect"));
 const slice_1 = require("@theme/ApiExplorer/ParamOptions/slice");
 const hooks_1 = require("@theme/ApiItem/hooks");
+const translationIds_1 = require("@theme/translationIds");
 const react_hook_form_1 = require("react-hook-form");
 function ParamBooleanFormItem({ param }) {
   const dispatch = (0, hooks_1.useTypedDispatch)();
@@ -30,11 +32,17 @@ function ParamBooleanFormItem({ param }) {
     null,
     react_1.default.createElement(react_hook_form_1.Controller, {
       control: control,
-      rules: { required: param.required ? "This field is required" : false },
+      rules: {
+        required: param.required
+          ? (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_FORM.FIELD_REQUIRED,
+              message: "This field is required",
+            })
+          : false,
+      },
       name: "paramBoolean",
-      render: ({ field: { onChange, name } }) =>
+      render: ({ field: { onChange } }) =>
         react_1.default.createElement(FormSelect_1.default, {
-          name: name,
           options: ["---", "true", "false"],
           onChange: (e) => {
             const val = e.target.value;

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

@@ -13,12 +13,14 @@ var __importDefault =
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = ParamMultiSelectFormItem;
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
 const error_message_1 = require("@hookform/error-message");
 const FormMultiSelect_1 = __importDefault(
   require("@theme/ApiExplorer/FormMultiSelect")
 );
 const slice_1 = require("@theme/ApiExplorer/ParamOptions/slice");
 const hooks_1 = require("@theme/ApiItem/hooks");
+const translationIds_1 = require("@theme/translationIds");
 const react_hook_form_1 = require("react-hook-form");
 function ParamMultiSelectFormItem({ param }) {
   const {
@@ -64,14 +66,20 @@ function ParamMultiSelectFormItem({ param }) {
     null,
     react_1.default.createElement(react_hook_form_1.Controller, {
       control: control,
-      rules: { required: param.required ? "This field is required" : false },
+      rules: {
+        required: param.required
+          ? (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_FORM.FIELD_REQUIRED,
+              message: "This field is required",
+            })
+          : false,
+      },
       name: "paramMultiSelect",
-      render: ({ field: { onChange, name } }) =>
+      render: ({ field: { onChange } }) =>
         react_1.default.createElement(FormMultiSelect_1.default, {
           options: options,
-          name: name,
           onChange: (e) => handleChange(e, onChange),
-          showErrors: showErrorMessage,
+          showErrors: !!showErrorMessage,
         }),
     }),
     showErrorMessage &&

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

@@ -13,10 +13,12 @@ var __importDefault =
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = ParamSelectFormItem;
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
 const error_message_1 = require("@hookform/error-message");
 const FormSelect_1 = __importDefault(require("@theme/ApiExplorer/FormSelect"));
 const slice_1 = require("@theme/ApiExplorer/ParamOptions/slice");
 const hooks_1 = require("@theme/ApiItem/hooks");
+const translationIds_1 = require("@theme/translationIds");
 const react_hook_form_1 = require("react-hook-form");
 function ParamSelectFormItem({ param }) {
   const {
@@ -31,9 +33,16 @@ function ParamSelectFormItem({ param }) {
     null,
     react_1.default.createElement(react_hook_form_1.Controller, {
       control: control,
-      rules: { required: param.required ? "This field is required" : false },
+      rules: {
+        required: param.required
+          ? (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_FORM.FIELD_REQUIRED,
+              message: "This field is required",
+            })
+          : false,
+      },
       name: "paramSelect",
-      render: ({ field: { onChange, name } }) =>
+      render: ({ field: { onChange } }) =>
         react_1.default.createElement(FormSelect_1.default, {
           options: ["---", ...options],
           onChange: (e) => {

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

@@ -68,6 +68,7 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importStar(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
 const FormItem_1 = __importDefault(require("@theme/ApiExplorer/FormItem"));
 const ParamArrayFormItem_1 = __importDefault(
   require("@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem")
@@ -85,6 +86,7 @@ const ParamTextFormItem_1 = __importDefault(
   require("@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem")
 );
 const hooks_1 = require("@theme/ApiItem/hooks");
+const translationIds_1 = require("@theme/translationIds");
 function ParamOption({ param }) {
   if (param.schema?.type === "array" && param.schema.items?.enum) {
     return react_1.default.createElement(ParamMultiSelectFormItem_1.default, {
@@ -201,7 +203,15 @@ function ParamOptions() {
               )
             )
           ),
-          showOptional ? "Hide optional parameters" : "Show optional parameters"
+          showOptional
+            ? (0, Translate_1.translate)({
+                id: translationIds_1.OPENAPI_PARAM_OPTIONS.HIDE_OPTIONAL,
+                message: "Hide optional parameters",
+              })
+            : (0, Translate_1.translate)({
+                id: translationIds_1.OPENAPI_PARAM_OPTIONS.SHOW_OPTIONAL,
+                message: "Show optional parameters",
+              })
         ),
         react_1.default.createElement(
           "div",

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

@@ -1,4 +1,3 @@
-import { PayloadAction } from "@reduxjs/toolkit";
 import { ParameterObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
 export type Param = ParameterObject & {
     value?: string[] | string;
@@ -9,9 +8,6 @@ export interface State {
     header: Param[];
     cookie: Param[];
 }
-export declare const slice: import("@reduxjs/toolkit").Slice<State, {
-    setParam: (state: import("immer/dist/internal").WritableDraft<State>, action: PayloadAction<Param>) => void;
-}, "params">;
 export declare const setParam: import("@reduxjs/toolkit").ActionCreatorWithPayload<Param, "params/setParam">;
 declare const _default: import("redux").Reducer<State>;
 export default _default;

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

@@ -6,10 +6,10 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setParam = exports.slice = void 0;
+exports.setParam = void 0;
 const toolkit_1 = require("@reduxjs/toolkit");
 const initialState = {};
-exports.slice = (0, toolkit_1.createSlice)({
+const slice = (0, toolkit_1.createSlice)({
   name: "params",
   initialState,
   reducers: {
@@ -21,5 +21,5 @@ exports.slice = (0, toolkit_1.createSlice)({
     },
   },
 });
-exports.setParam = exports.slice.actions.setParam;
-exports.default = exports.slice.reducer;
+exports.setParam = slice.actions.setParam;
+exports.default = slice.reducer;