@camunda8/docusaurus-theme-openapi-docs 4.5.1

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

@@ -0,0 +1,97 @@
+"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 = 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 {
+    control,
+    formState: { errors },
+  } = (0, react_hook_form_1.useFormContext)();
+  const showErrorMessage = errors?.paramMultiSelect;
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  const options = param.schema?.items?.enum ?? [];
+  const pathParams = (0, hooks_1.useTypedSelector)(
+    (state) => state.params.path
+  );
+  const queryParams = (0, hooks_1.useTypedSelector)(
+    (state) => state.params.query
+  );
+  const cookieParams = (0, hooks_1.useTypedSelector)(
+    (state) => state.params.cookie
+  );
+  const headerParams = (0, hooks_1.useTypedSelector)(
+    (state) => state.params.header
+  );
+  const paramTypeToWatch = pathParams.length
+    ? pathParams
+    : queryParams.length
+      ? queryParams
+      : cookieParams.length
+        ? cookieParams
+        : headerParams;
+  const handleChange = (e, onChange) => {
+    const values = Array.prototype.filter
+      .call(e.target.options, (o) => o.selected)
+      .map((o) => o.value);
+    dispatch(
+      (0, slice_1.setParam)({
+        ...param,
+        value: values.length > 0 ? values : undefined,
+      })
+    );
+    onChange(paramTypeToWatch);
+  };
+  return react_1.default.createElement(
+    react_1.default.Fragment,
+    null,
+    react_1.default.createElement(react_hook_form_1.Controller, {
+      control: control,
+      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 } }) =>
+        react_1.default.createElement(FormMultiSelect_1.default, {
+          options: options,
+          onChange: (e) => handleChange(e, onChange),
+          showErrors: !!showErrorMessage,
+        }),
+    }),
+    showErrorMessage &&
+      react_1.default.createElement(error_message_1.ErrorMessage, {
+        errors: errors,
+        name: "paramMultiSelect",
+        render: ({ message }) =>
+          react_1.default.createElement(
+            "div",
+            { className: "openapi-explorer__input-error" },
+            message
+          ),
+      })
+  );
+}

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
+export interface ParamProps {
+    param: Param;
+}
+export default function ParamSelectFormItem({ param }: ParamProps): React.JSX.Element;

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

@@ -0,0 +1,72 @@
+"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 = 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 {
+    control,
+    formState: { errors },
+  } = (0, react_hook_form_1.useFormContext)();
+  const showErrorMessage = errors?.paramSelect;
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  const options = param.schema?.enum ?? [];
+  return react_1.default.createElement(
+    react_1.default.Fragment,
+    null,
+    react_1.default.createElement(react_hook_form_1.Controller, {
+      control: control,
+      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 } }) =>
+        react_1.default.createElement(FormSelect_1.default, {
+          options: ["---", ...options],
+          onChange: (e) => {
+            const val = e.target.value;
+            dispatch(
+              (0, slice_1.setParam)({
+                ...param,
+                value: val === "---" ? undefined : val,
+              })
+            );
+            onChange(val);
+          },
+        }),
+    }),
+    showErrorMessage &&
+      react_1.default.createElement(error_message_1.ErrorMessage, {
+        errors: errors,
+        name: "paramSelect",
+        render: ({ message }) =>
+          react_1.default.createElement(
+            "div",
+            { className: "openapi-explorer__input-error" },
+            message
+          ),
+      })
+  );
+}

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
+export interface ParamProps {
+    param: Param;
+}
+export default function ParamTextFormItem({ param }: ParamProps): React.JSX.Element;

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

@@ -0,0 +1,38 @@
+"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 = ParamTextFormItem;
+const react_1 = __importDefault(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");
+function ParamTextFormItem({ param }) {
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  return react_1.default.createElement(FormTextInput_1.default, {
+    isRequired: param.required,
+    paramName: param.name,
+    placeholder: param.description || param.name,
+    onChange: (e) =>
+      dispatch(
+        (0, slice_1.setParam)({
+          ...param,
+          value:
+            param.in === "path" || param.in === "query"
+              ? e.target.value.replace(/\s/g, "%20")
+              : e.target.value,
+        })
+      ),
+  });
+}

package/lib/theme/ApiExplorer/ParamOptions/_ParamOptions.scss

@@ -0,0 +1,123 @@
+.openapi-explorer__plus-btn--expanded {
+  transition: transform 0.2s ease;
+  display: inline-block;
+  transform: rotate(0deg);
+  transform-origin: center;
+  margin-right: 6px;
+  transform: rotate(45deg);
+}
+
+.openapi-explorer__show-more-btn {
+  width: 100%;
+  -webkit-appearance: none;
+  -moz-appearance: none;
+  appearance: none;
+  margin-left: 0.25rem;
+  margin-bottom: 0.5rem;
+  padding: 0;
+  cursor: pointer;
+  font-size: var(--openapi-explorer-font-size-input);
+  user-select: none;
+  white-space: nowrap;
+  border: 0px solid transparent;
+  display: block;
+  background-color: transparent;
+  color: var(--ifm-color-primary);
+  text-align: left;
+
+  &:hover {
+    color: var(--ifm-color-primary-hover);
+  }
+
+  &:first-child {
+    margin-top: 0;
+  }
+}
+
+.openapi-explorer__delete-btn {
+  -webkit-appearance: none;
+  -moz-appearance: none;
+  appearance: none;
+
+  cursor: pointer;
+  font-size: calc(0.875rem * var(--ifm-button-size-multiplier));
+  font-weight: normal;
+  line-height: 1.5;
+
+  transition-property: color, background, border-color, box-shadow;
+  transition-duration:
+    100ms, 100ms, 100ms, var(--ifm-button-transition-duration);
+  transition-timing-function: cubic-bezier(0.08, 0.52, 0.52, 1);
+
+  -webkit-user-select: none;
+  user-select: none;
+  white-space: nowrap;
+
+  display: flex;
+
+  align-items: center;
+  justify-content: center;
+
+  padding: 0 12px;
+
+  margin-top: calc(var(--ifm-pre-padding) / 2);
+  background-color: var(--openapi-input-background);
+  border: none;
+  outline: none;
+  color: var(--ifm-pre-color);
+  border-radius: 4px;
+  margin-left: 4px;
+
+  &:focus {
+    outline: 0;
+  }
+
+  &:active {
+    box-shadow: inset 0px 0px 0px 2px var(--openapi-input-border);
+  }
+}
+
+.openapi-explorer__thin-btn {
+  -webkit-appearance: none;
+  -moz-appearance: none;
+  cursor: pointer;
+  font-weight: bold;
+  padding: 0.5rem 1rem;
+  font-size: 12px;
+  transition-property: color, background, border-color, box-shadow;
+  transition-duration:
+    100ms, 100ms, 100ms, var(--ifm-button-transition-duration);
+  transition-timing-function: cubic-bezier(0.08, 0.52, 0.52, 1);
+  user-select: none;
+  white-space: nowrap;
+  background-color: transparent;
+  color: var(--openapi-input-border);
+  border: 1px solid var(--openapi-input-border);
+  border-radius: var(--ifm-pre-border-radius);
+  margin-top: calc(var(--ifm-pre-padding) / 2);
+  text-transform: uppercase;
+
+  &:hover {
+    color: var(--openapi-inverse-color);
+    background-color: var(--openapi-input-border);
+  }
+
+  &:focus {
+    outline: 0;
+  }
+
+  &:active {
+    box-shadow:
+      inset 0 0 0 1px var(--openapi-input-border),
+      inset 0 0 0 2px var(--openapi-inverse-color);
+  }
+}
+
+.openapi-explorer__show-options {
+  visibility: visible;
+}
+
+.openapi-explorer__hide-options {
+  display: none;
+  visibility: hidden;
+}

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

@@ -0,0 +1,7 @@
+import React from "react";
+import { Param } from "./slice";
+export interface ParamProps {
+    param: Param;
+}
+declare function ParamOptions(): React.JSX.Element;
+export default ParamOptions;

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

@@ -0,0 +1,233 @@
+"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 });
+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")
+);
+const ParamBooleanFormItem_1 = __importDefault(
+  require("@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem")
+);
+const ParamMultiSelectFormItem_1 = __importDefault(
+  require("@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem")
+);
+const ParamSelectFormItem_1 = __importDefault(
+  require("@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem")
+);
+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, {
+      param: param,
+    });
+  }
+  if (param.schema?.type === "array") {
+    return react_1.default.createElement(ParamArrayFormItem_1.default, {
+      param: param,
+    });
+  }
+  if (param.schema?.enum) {
+    return react_1.default.createElement(ParamSelectFormItem_1.default, {
+      param: param,
+    });
+  }
+  if (param.schema?.type === "boolean") {
+    return react_1.default.createElement(ParamBooleanFormItem_1.default, {
+      param: param,
+    });
+  }
+  // integer, number, string, int32, int64, float, double, object, byte, binary,
+  // date-time, date, password
+  return react_1.default.createElement(ParamTextFormItem_1.default, {
+    param: param,
+  });
+}
+function ParamOptionWrapper({ param }) {
+  return react_1.default.createElement(
+    FormItem_1.default,
+    { label: param.name, type: param.in, required: param.required },
+    react_1.default.createElement(ParamOption, { param: param })
+  );
+}
+function ParamOptions() {
+  const [showOptional, setShowOptional] = (0, react_1.useState)(false);
+  const pathParams = (0, hooks_1.useTypedSelector)(
+    (state) => state.params.path
+  );
+  const queryParams = (0, hooks_1.useTypedSelector)(
+    (state) => state.params.query
+  );
+  const cookieParams = (0, hooks_1.useTypedSelector)(
+    (state) => state.params.cookie
+  );
+  const headerParams = (0, hooks_1.useTypedSelector)(
+    (state) => state.params.header
+  );
+  const allParams = [
+    ...pathParams,
+    ...queryParams,
+    ...cookieParams,
+    ...headerParams,
+  ];
+  const requiredParams = allParams.filter((p) => p.required);
+  const optionalParams = allParams.filter((p) => !p.required);
+  return react_1.default.createElement(
+    react_1.default.Fragment,
+    null,
+    requiredParams.map((param) =>
+      react_1.default.createElement(ParamOptionWrapper, {
+        key: `${param.in}-${param.name}`,
+        param: param,
+      })
+    ),
+    optionalParams.length > 0 &&
+      react_1.default.createElement(
+        react_1.default.Fragment,
+        null,
+        react_1.default.createElement(
+          "button",
+          {
+            type: "button",
+            className: "openapi-explorer__show-more-btn",
+            onClick: () => setShowOptional((prev) => !prev),
+          },
+          react_1.default.createElement(
+            "span",
+            {
+              style: {
+                width: "1.5em",
+                display: "inline-block",
+                textAlign: "center",
+              },
+            },
+            react_1.default.createElement(
+              "span",
+              {
+                className: showOptional
+                  ? "openapi-explorer__plus-btn--expanded"
+                  : "openapi-explorer__plus-btn",
+              },
+              react_1.default.createElement(
+                "div",
+                null,
+                react_1.default.createElement(
+                  "svg",
+                  {
+                    style: {
+                      fill: "currentColor",
+                      width: "10px",
+                      height: "10px",
+                    },
+                    height: "16",
+                    viewBox: "0 0 16 16",
+                    width: "16",
+                    xmlns: "http://www.w3.org/2000/svg",
+                  },
+                  react_1.default.createElement("path", {
+                    d: "M9 7h6a1 1 0 0 1 0 2H9v6a1 1 0 0 1-2 0V9H1a1 1 0 1 1 0-2h6V1a1 1 0 1 1 2 0z",
+                    fillRule: "evenodd",
+                  })
+                )
+              )
+            )
+          ),
+          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",
+          {
+            className: showOptional
+              ? "openapi-explorer__show-options"
+              : "openapi-explorer__hide-options",
+          },
+          optionalParams.map((param) =>
+            react_1.default.createElement(ParamOptionWrapper, {
+              key: `${param.in}-${param.name}`,
+              param: param,
+            })
+          )
+        )
+      )
+  );
+}
+exports.default = ParamOptions;

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

@@ -0,0 +1,17 @@
+import { PayloadAction } from "@reduxjs/toolkit";
+import { ParameterObject } from "@camunda8/docusaurus-plugin-openapi-docs/src/openapi/types";
+export type Param = ParameterObject & {
+    value?: string[] | string;
+};
+export interface State {
+    path: Param[];
+    query: Param[];
+    header: Param[];
+    cookie: Param[];
+}
+export declare const slice: import("@reduxjs/toolkit").Slice<State, {
+    setParam: (state: import("immer").WritableDraft<State>, action: PayloadAction<Param>) => void;
+}, "params", "params", import("@reduxjs/toolkit").SliceSelectors<State>>;
+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

@@ -0,0 +1,25 @@
+"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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setParam = exports.slice = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const initialState = {};
+exports.slice = (0, toolkit_1.createSlice)({
+  name: "params",
+  initialState,
+  reducers: {
+    setParam: (state, action) => {
+      const newParam = action.payload;
+      const paramGroup = state[action.payload.in];
+      const index = paramGroup.findIndex((p) => p.name === newParam.name);
+      paramGroup[index] = newParam;
+    },
+  },
+});
+exports.setParam = exports.slice.actions.setParam;
+exports.default = exports.slice.reducer;