@camunda8/docusaurus-theme-openapi-docs 4.5.1

package/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.tsx

@@ -0,0 +1,185 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+import React, { useEffect, useState } from "react";
+
+import { translate } from "@docusaurus/Translate";
+import { ErrorMessage } from "@hookform/error-message";
+import { nanoid } from "@reduxjs/toolkit";
+import FormSelect from "@theme/ApiExplorer/FormSelect";
+import FormTextInput from "@theme/ApiExplorer/FormTextInput";
+import { Param, setParam } from "@theme/ApiExplorer/ParamOptions/slice";
+import { useTypedDispatch } from "@theme/ApiItem/hooks";
+import { OPENAPI_FORM } from "@theme/translationIds";
+import { Controller, useFormContext } from "react-hook-form";
+
+export interface ParamProps {
+  param: Param;
+}
+
+function ArrayItem({
+  param,
+  onChange,
+  initialValue,
+}: ParamProps & { onChange(value?: string): any; initialValue?: string }) {
+  const [value, setValue] = useState(initialValue || "");
+
+  if (param.schema?.items?.type === "boolean") {
+    return (
+      <FormSelect
+        options={["---", "true", "false"]}
+        onChange={(e: React.ChangeEvent<HTMLSelectElement>) => {
+          const val = e.target.value;
+          onChange(val === "---" ? undefined : val);
+        }}
+      />
+    );
+  }
+
+  return (
+    <FormTextInput
+      placeholder={param.description || param.name}
+      value={value}
+      onChange={(e: React.ChangeEvent<HTMLInputElement>) => {
+        setValue(e.target.value);
+        onChange(e.target.value);
+      }}
+    />
+  );
+}
+
+export default function ParamArrayFormItem({ param }: ParamProps) {
+  const [items, setItems] = useState<{ id: string; value?: string }[]>([]);
+  const dispatch = useTypedDispatch();
+
+  const {
+    control,
+    formState: { errors },
+  } = useFormContext();
+
+  const showErrorMessage = errors?.paramArray?.message;
+
+  function handleAddItem(e: any) {
+    e.preventDefault(); // prevent form from submitting
+    setItems((i) => [
+      ...i,
+      {
+        id: nanoid(),
+      },
+    ]);
+  }
+
+  useEffect(() => {
+    const values = items
+      .map((item) => item.value)
+      .filter((item): item is string => !!item);
+
+    dispatch(
+      setParam({
+        ...param,
+        value: values.length > 0 ? values : undefined,
+      })
+    );
+
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [items]);
+
+  useEffect(() => {
+    const example = param.schema?.example;
+    if (Array.isArray(example) && example.length > 0) {
+      const examplesWithIds = example.map((item: any) => ({
+        id: nanoid(),
+        value: item.toString(),
+      }));
+
+      setItems(examplesWithIds);
+    }
+  }, [param.schema?.example]);
+
+  function handleDeleteItem(itemToDelete: { id: string }) {
+    return () => {
+      const newItems = items.filter((i) => i.id !== itemToDelete.id);
+      setItems(newItems);
+    };
+  }
+
+  function handleChangeItem(itemToUpdate: { id: string }, onChange: any) {
+    return (value: string) => {
+      const newItems = items.map((i) => {
+        if (i.id === itemToUpdate.id) {
+          return { ...i, value: value };
+        }
+        return i;
+      });
+      setItems(newItems);
+      onChange(newItems);
+    };
+  }
+
+  return (
+    <>
+      <Controller
+        control={control}
+        rules={{
+          required: param.required
+            ? translate({
+                id: OPENAPI_FORM.FIELD_REQUIRED,
+                message: "This field is required",
+              })
+            : false,
+        }}
+        name="paramArray"
+        render={({ field: { onChange } }) => (
+          <>
+            {items.map((item) => (
+              <div key={item.id} style={{ display: "flex" }}>
+                <ArrayItem
+                  param={param}
+                  onChange={handleChangeItem(item, onChange)}
+                  initialValue={item.value}
+                />
+                <button
+                  className="openapi-explorer__delete-btn"
+                  onClick={handleDeleteItem(item)}
+                >
+                  <svg
+                    focusable="false"
+                    preserveAspectRatio="xMidYMid meet"
+                    xmlns="http://www.w3.org/2000/svg"
+                    fill="currentColor"
+                    width="16"
+                    height="16"
+                    viewBox="0 0 32 32"
+                    aria-hidden="true"
+                  >
+                    <path d="M24 9.4L22.6 8 16 14.6 9.4 8 8 9.4 14.6 16 8 22.6 9.4 24 16 17.4 22.6 24 24 22.6 17.4 16 24 9.4z"></path>
+                    <title>Delete</title>
+                  </svg>
+                </button>
+              </div>
+            ))}
+            <button
+              className="openapi-explorer__thin-btn"
+              onClick={handleAddItem}
+            >
+              Add item
+            </button>
+          </>
+        )}
+      />
+      {showErrorMessage && (
+        <ErrorMessage
+          errors={errors}
+          name="paramArray"
+          render={({ message }) => (
+            <div className="openapi-explorer__input-error">{message}</div>
+          )}
+        />
+      )}
+    </>
+  );
+}

package/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.tsx

@@ -0,0 +1,72 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+import React from "react";
+
+import { translate } from "@docusaurus/Translate";
+import { ErrorMessage } from "@hookform/error-message";
+import FormSelect from "@theme/ApiExplorer/FormSelect";
+import { Param, setParam } from "@theme/ApiExplorer/ParamOptions/slice";
+import { useTypedDispatch } from "@theme/ApiItem/hooks";
+import { OPENAPI_FORM } from "@theme/translationIds";
+import { Controller, useFormContext } from "react-hook-form";
+
+export interface ParamProps {
+  param: Param;
+}
+
+export default function ParamBooleanFormItem({ param }: ParamProps) {
+  const dispatch = useTypedDispatch();
+
+  const {
+    control,
+    formState: { errors },
+  } = useFormContext();
+
+  const showErrorMessage = errors?.paramBoolean;
+
+  return (
+    <>
+      <Controller
+        control={control}
+        rules={{
+          required: param.required
+            ? translate({
+                id: OPENAPI_FORM.FIELD_REQUIRED,
+                message: "This field is required",
+              })
+            : false,
+        }}
+        name="paramBoolean"
+        render={({ field: { onChange } }) => (
+          <FormSelect
+            options={["---", "true", "false"]}
+            onChange={(e: React.ChangeEvent<HTMLSelectElement>) => {
+              const val = e.target.value;
+              dispatch(
+                setParam({
+                  ...param,
+                  value: val === "---" ? undefined : val,
+                })
+              );
+              onChange(val);
+            }}
+          />
+        )}
+      />
+      {showErrorMessage && (
+        <ErrorMessage
+          errors={errors}
+          name="paramBoolean"
+          render={({ message }) => (
+            <div className="openapi-explorer__input-error">{message}</div>
+          )}
+        />
+      )}
+    </>
+  );
+}

package/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.tsx

@@ -0,0 +1,94 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+import React from "react";
+
+import { translate } from "@docusaurus/Translate";
+import { ErrorMessage } from "@hookform/error-message";
+import FormMultiSelect from "@theme/ApiExplorer/FormMultiSelect";
+import { Param, setParam } from "@theme/ApiExplorer/ParamOptions/slice";
+import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
+import { OPENAPI_FORM } from "@theme/translationIds";
+import { Controller, useFormContext } from "react-hook-form";
+
+export interface ParamProps {
+  param: Param;
+}
+
+export default function ParamMultiSelectFormItem({ param }: ParamProps) {
+  const {
+    control,
+    formState: { errors },
+  } = useFormContext();
+
+  const showErrorMessage = errors?.paramMultiSelect;
+
+  const dispatch = useTypedDispatch();
+
+  const options = param.schema?.items?.enum ?? [];
+
+  const pathParams = useTypedSelector((state: any) => state.params.path);
+  const queryParams = useTypedSelector((state: any) => state.params.query);
+  const cookieParams = useTypedSelector((state: any) => state.params.cookie);
+  const headerParams = useTypedSelector((state: any) => state.params.header);
+
+  const paramTypeToWatch = pathParams.length
+    ? pathParams
+    : queryParams.length
+      ? queryParams
+      : cookieParams.length
+        ? cookieParams
+        : headerParams;
+
+  const handleChange = (e: any, onChange: any) => {
+    const values = Array.prototype.filter
+      .call(e.target.options, (o) => o.selected)
+      .map((o) => o.value);
+
+    dispatch(
+      setParam({
+        ...param,
+        value: values.length > 0 ? values : undefined,
+      })
+    );
+
+    onChange(paramTypeToWatch);
+  };
+
+  return (
+    <>
+      <Controller
+        control={control}
+        rules={{
+          required: param.required
+            ? translate({
+                id: OPENAPI_FORM.FIELD_REQUIRED,
+                message: "This field is required",
+              })
+            : false,
+        }}
+        name="paramMultiSelect"
+        render={({ field: { onChange } }) => (
+          <FormMultiSelect
+            options={options as string[]}
+            onChange={(e: any) => handleChange(e, onChange)}
+            showErrors={!!showErrorMessage}
+          />
+        )}
+      />
+      {showErrorMessage && (
+        <ErrorMessage
+          errors={errors}
+          name="paramMultiSelect"
+          render={({ message }) => (
+            <div className="openapi-explorer__input-error">{message}</div>
+          )}
+        />
+      )}
+    </>
+  );
+}

package/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem.tsx

@@ -0,0 +1,74 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+import React from "react";
+
+import { translate } from "@docusaurus/Translate";
+import { ErrorMessage } from "@hookform/error-message";
+import FormSelect from "@theme/ApiExplorer/FormSelect";
+import { Param, setParam } from "@theme/ApiExplorer/ParamOptions/slice";
+import { useTypedDispatch } from "@theme/ApiItem/hooks";
+import { OPENAPI_FORM } from "@theme/translationIds";
+import { Controller, useFormContext } from "react-hook-form";
+
+export interface ParamProps {
+  param: Param;
+}
+
+export default function ParamSelectFormItem({ param }: ParamProps) {
+  const {
+    control,
+    formState: { errors },
+  } = useFormContext();
+
+  const showErrorMessage = errors?.paramSelect;
+
+  const dispatch = useTypedDispatch();
+
+  const options = param.schema?.enum ?? [];
+
+  return (
+    <>
+      <Controller
+        control={control}
+        rules={{
+          required: param.required
+            ? translate({
+                id: OPENAPI_FORM.FIELD_REQUIRED,
+                message: "This field is required",
+              })
+            : false,
+        }}
+        name="paramSelect"
+        render={({ field: { onChange } }) => (
+          <FormSelect
+            options={["---", ...(options as string[])]}
+            onChange={(e: React.ChangeEvent<HTMLSelectElement>) => {
+              const val = e.target.value;
+              dispatch(
+                setParam({
+                  ...param,
+                  value: val === "---" ? undefined : val,
+                })
+              );
+              onChange(val);
+            }}
+          />
+        )}
+      />
+      {showErrorMessage && (
+        <ErrorMessage
+          errors={errors}
+          name="paramSelect"
+          render={({ message }) => (
+            <div className="openapi-explorer__input-error">{message}</div>
+          )}
+        />
+      )}
+    </>
+  );
+}

package/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem.tsx

@@ -0,0 +1,38 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+import React from "react";
+
+import FormTextInput from "@theme/ApiExplorer/FormTextInput";
+import { Param, setParam } from "@theme/ApiExplorer/ParamOptions/slice";
+import { useTypedDispatch } from "@theme/ApiItem/hooks";
+
+export interface ParamProps {
+  param: Param;
+}
+
+export default function ParamTextFormItem({ param }: ParamProps) {
+  const dispatch = useTypedDispatch();
+  return (
+    <FormTextInput
+      isRequired={param.required}
+      paramName={param.name}
+      placeholder={param.description || param.name}
+      onChange={(e: React.ChangeEvent<HTMLInputElement>) =>
+        dispatch(
+          setParam({
+            ...param,
+            value:
+              param.in === "path" || param.in === "query"
+                ? e.target.value.replace(/\s/g, "%20")
+                : e.target.value,
+          })
+        )
+      }
+    />
+  );
+}

package/src/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;
+}