@camunda8/docusaurus-theme-openapi-docs 4.5.1

package/src/theme/ApiExplorer/ParamOptions/index.tsx

@@ -0,0 +1,154 @@
+/* ============================================================================
+ * 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, { useState } from "react";
+
+import { translate } from "@docusaurus/Translate";
+import FormItem from "@theme/ApiExplorer/FormItem";
+import ParamArrayFormItem from "@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem";
+import ParamBooleanFormItem from "@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem";
+import ParamMultiSelectFormItem from "@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem";
+import ParamSelectFormItem from "@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem";
+import ParamTextFormItem from "@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem";
+import { useTypedSelector } from "@theme/ApiItem/hooks";
+import { OPENAPI_PARAM_OPTIONS } from "@theme/translationIds";
+
+import { Param } from "./slice";
+
+export interface ParamProps {
+  param: Param;
+}
+
+function ParamOption({ param }: ParamProps) {
+  if (param.schema?.type === "array" && param.schema.items?.enum) {
+    return <ParamMultiSelectFormItem param={param} />;
+  }
+
+  if (param.schema?.type === "array") {
+    return <ParamArrayFormItem param={param} />;
+  }
+
+  if (param.schema?.enum) {
+    return <ParamSelectFormItem param={param} />;
+  }
+
+  if (param.schema?.type === "boolean") {
+    return <ParamBooleanFormItem param={param} />;
+  }
+
+  // integer, number, string, int32, int64, float, double, object, byte, binary,
+  // date-time, date, password
+  return <ParamTextFormItem param={param} />;
+}
+
+function ParamOptionWrapper({ param }: ParamProps) {
+  return (
+    <FormItem label={param.name} type={param.in} required={param.required}>
+      <ParamOption param={param} />
+    </FormItem>
+  );
+}
+
+function ParamOptions() {
+  const [showOptional, setShowOptional] = useState(false);
+
+  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 allParams = [
+    ...pathParams,
+    ...queryParams,
+    ...cookieParams,
+    ...headerParams,
+  ];
+
+  const requiredParams = allParams.filter((p) => p.required);
+  const optionalParams = allParams.filter((p) => !p.required);
+
+  return (
+    <>
+      {/* Required Parameters */}
+      {requiredParams.map((param) => (
+        <ParamOptionWrapper key={`${param.in}-${param.name}`} param={param} />
+      ))}
+
+      {/* Optional Parameters */}
+      {optionalParams.length > 0 && (
+        <>
+          <button
+            type="button"
+            className="openapi-explorer__show-more-btn"
+            onClick={() => setShowOptional((prev) => !prev)}
+          >
+            <span
+              style={{
+                width: "1.5em",
+                display: "inline-block",
+                textAlign: "center",
+              }}
+            >
+              <span
+                className={
+                  showOptional
+                    ? "openapi-explorer__plus-btn--expanded"
+                    : "openapi-explorer__plus-btn"
+                }
+              >
+                <div>
+                  <svg
+                    style={{
+                      fill: "currentColor",
+                      width: "10px",
+                      height: "10px",
+                    }}
+                    height="16"
+                    viewBox="0 0 16 16"
+                    width="16"
+                    xmlns="http://www.w3.org/2000/svg"
+                  >
+                    <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"
+                    ></path>
+                  </svg>
+                </div>
+              </span>
+            </span>
+            {showOptional
+              ? translate({
+                  id: OPENAPI_PARAM_OPTIONS.HIDE_OPTIONAL,
+                  message: "Hide optional parameters",
+                })
+              : translate({
+                  id: OPENAPI_PARAM_OPTIONS.SHOW_OPTIONAL,
+                  message: "Show optional parameters",
+                })}
+          </button>
+
+          <div
+            className={
+              showOptional
+                ? "openapi-explorer__show-options"
+                : "openapi-explorer__hide-options"
+            }
+          >
+            {optionalParams.map((param) => (
+              <ParamOptionWrapper
+                key={`${param.in}-${param.name}`}
+                param={param}
+              />
+            ))}
+          </div>
+        </>
+      )}
+    </>
+  );
+}
+
+export default ParamOptions;

package/src/theme/ApiExplorer/ParamOptions/slice.ts

@@ -0,0 +1,37 @@
+/* ============================================================================
+ * 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 { createSlice, 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[];
+}
+
+const initialState: State = {} as any;
+
+export const slice = createSlice({
+  name: "params",
+  initialState,
+  reducers: {
+    setParam: (state, action: PayloadAction<Param>) => {
+      const newParam = action.payload;
+      const paramGroup = state[action.payload.in];
+      const index = paramGroup.findIndex((p) => p.name === newParam.name);
+      paramGroup[index] = newParam;
+    },
+  },
+});
+
+export const { setParam } = slice.actions;
+
+export default slice.reducer;

package/src/theme/ApiExplorer/Request/_Request.scss

@@ -0,0 +1,129 @@
+.openapi-explorer__request-form {
+  background-color: var(--ifm-pre-background);
+  border-radius: var(--openapi-card-border-radius);
+  border: 1px solid var(--openapi-explorer-border-color);
+  box-shadow:
+    0 2px 3px hsla(222, 8%, 43%, 0.1),
+    0 8px 16px -10px hsla(222, 8%, 43%, 0.2);
+  color: var(--ifm-pre-color);
+  line-height: var(--ifm-pre-line-height);
+  margin-bottom: var(--ifm-spacing-vertical);
+  margin-top: 0;
+  overflow: auto;
+  transition: 300ms;
+
+  /* hack for view calculation when monaco is hidden */
+  position: relative;
+
+  &:empty {
+    display: none;
+  }
+
+  &:hover {
+    box-shadow:
+      0 0 0 2px rgba(38, 53, 61, 0.15),
+      0 2px 3px hsla(222, 8%, 43%, 0.15),
+      0 16px 16px -10px hsla(222, 8%, 43%, 0.2);
+  }
+
+  .required {
+    font-size: var(--ifm-code-font-size);
+    color: var(--openapi-required);
+
+    &.request-body {
+      padding-left: 0.25rem;
+    }
+  }
+}
+
+.openapi-explorer__request-header-container {
+  display: flex;
+  justify-content: space-between;
+  border-bottom: 1px solid var(--openapi-explorer-border-color);
+  margin: 0;
+  padding: 0.75rem var(--ifm-pre-padding);
+  text-transform: uppercase;
+  font-size: 12px;
+  font-weight: bold;
+}
+
+.openapi-explorer__expand-details-btn {
+  &:hover {
+    cursor: pointer;
+  }
+}
+
+.openapi-explorer__details-outer-container {
+  padding: 1rem;
+}
+
+.openapi-explorer__details-container[open] {
+  .openapi-explorer__details-summary::before {
+    transform: rotate(180deg);
+    margin-top: 0.25rem;
+  }
+}
+
+.openapi-explorer__details-summary {
+  display: inline-flex;
+  align-items: center;
+  padding: 0.35rem 0;
+  font-size: 14px;
+  list-style: none;
+
+  &:hover {
+    cursor: pointer;
+  }
+
+  &::-webkit-details-marker {
+    display: none;
+  }
+
+  &::before {
+    margin-right: 0.25rem;
+    margin-bottom: 0.25rem;
+    margin-top: 0.25rem;
+    background-image: var(--openapi-explorer-caret-bg);
+    border: none !important;
+    transform: rotate(90deg);
+    content: "";
+    height: 1rem;
+    width: 1rem;
+  }
+}
+
+.openapi-explorer__request-btn {
+  border: none;
+  border-radius: var(--ifm-global-radius);
+  padding: 0.5rem 1rem;
+  margin-top: 1rem;
+  background-color: var(--ifm-color-primary-light);
+  text-transform: uppercase;
+  font-weight: bold;
+  font-size: 12px;
+  color: white;
+  cursor: pointer;
+  transition: 300ms;
+
+  &:hover {
+    background-color: var(--ifm-color-primary-lightest);
+  }
+
+  &:active {
+    background-color: var(--ifm-color-primary-light);
+  }
+}
+
+.openapi-security__summary-container {
+  background: var(--ifm-pre-background);
+  border-radius: var(--ifm-pre-border-radius);
+}
+
+// Prevent auto zoom on mobile iOS devices when focusing on input elmenents
+@media screen and (-webkit-min-device-pixel-ratio: 0) and (max-device-width: 1024px) {
+  .prism-code,
+  select,
+  input {
+    font-size: 1rem;
+  }
+}

package/src/theme/ApiExplorer/Request/index.tsx

@@ -0,0 +1,352 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+// @ts-nocheck
+import React, { useState } from "react";
+
+import { useDoc } from "@docusaurus/plugin-content-docs/client";
+import { translate } from "@docusaurus/Translate";
+import Accept from "@theme/ApiExplorer/Accept";
+import Authorization from "@theme/ApiExplorer/Authorization";
+import Body from "@theme/ApiExplorer/Body";
+import buildPostmanRequest from "@theme/ApiExplorer/buildPostmanRequest";
+import ContentType from "@theme/ApiExplorer/ContentType";
+import ParamOptions from "@theme/ApiExplorer/ParamOptions";
+import {
+  setResponse,
+  setCode,
+  clearCode,
+  setHeaders,
+  clearHeaders,
+} from "@theme/ApiExplorer/Response/slice";
+import Server from "@theme/ApiExplorer/Server";
+import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
+import { OPENAPI_REQUEST } from "@theme/translationIds";
+import { ParameterObject } from "@camunda8/docusaurus-plugin-openapi-docs/src/openapi/types";
+import { ApiItem } from "@camunda8/docusaurus-plugin-openapi-docs/src/types";
+import * as sdk from "postman-collection";
+import { FormProvider, useForm } from "react-hook-form";
+
+import makeRequest from "./makeRequest";
+
+function Request({ item }: { item: ApiItem }) {
+  const postman = new sdk.Request(item.postman);
+  const metadata = useDoc();
+  const { proxy, hide_send_button: hideSendButton } = metadata.frontMatter;
+
+  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 contentType = useTypedSelector((state: any) => state.contentType.value);
+  const headerParams = useTypedSelector((state: any) => state.params.header);
+  const body = useTypedSelector((state: any) => state.body);
+  const accept = useTypedSelector((state: any) => state.accept.value);
+  const acceptOptions = useTypedDispatch((state: any) => state.accept.options);
+  const authSelected = useTypedSelector((state: any) => state.auth.selected);
+  const server = useTypedSelector((state: any) => state.server.value);
+  const serverOptions = useTypedSelector((state: any) => state.server.options);
+  const auth = useTypedSelector((state: any) => state.auth);
+  const dispatch = useTypedDispatch();
+
+  const [expandAccept, setExpandAccept] = useState(true);
+  const [expandAuth, setExpandAuth] = useState(true);
+  const [expandBody, setExpandBody] = useState(true);
+  const [expandParams, setExpandParams] = useState(true);
+  const [expandServer, setExpandServer] = useState(true);
+
+  const allParams = [
+    ...pathParams,
+    ...queryParams,
+    ...cookieParams,
+    ...headerParams,
+  ];
+
+  const postmanRequest = buildPostmanRequest(postman, {
+    queryParams,
+    pathParams,
+    cookieParams,
+    contentType,
+    accept,
+    headerParams,
+    body,
+    server,
+    auth,
+  });
+
+  const delay = (ms: number) =>
+    new Promise((resolve) => setTimeout(resolve, ms));
+
+  const paramsObject = {
+    path: [] as ParameterObject[],
+    query: [] as ParameterObject[],
+    header: [] as ParameterObject[],
+    cookie: [] as ParameterObject[],
+  };
+
+  item.parameters?.forEach(
+    (param: { in: "path" | "query" | "header" | "cookie" }) => {
+      const paramType = param.in;
+      const paramsArray: ParameterObject[] = paramsObject[paramType];
+      paramsArray.push(param as ParameterObject);
+    }
+  );
+
+  const methods = useForm({ shouldFocusError: false });
+
+  const handleEventStream = async (res) => {
+    res.headers && dispatch(setHeaders(Object.fromEntries(res.headers)));
+    dispatch(setCode(res.status));
+
+    const reader = res.body.getReader();
+    const decoder = new TextDecoder();
+    let result = "";
+    while (true) {
+      const { done, value } = await reader.read();
+      if (done) break;
+      result += decoder.decode(value, { stream: true });
+      dispatch(setResponse(result));
+    }
+  };
+
+  const handleResponse = async (res) => {
+    dispatch(setResponse(await res.text()));
+    dispatch(setCode(res.status));
+    res.headers && dispatch(setHeaders(Object.fromEntries(res.headers)));
+  };
+
+  const onSubmit = async (data) => {
+    dispatch(
+      setResponse(
+        translate({
+          id: OPENAPI_REQUEST.FETCHING_MESSAGE,
+          message: "Fetching...",
+        })
+      )
+    );
+    try {
+      await delay(1200);
+      const res = await makeRequest(postmanRequest, proxy, body);
+      if (res.headers.get("content-type")?.includes("text/event-stream")) {
+        await handleEventStream(res);
+      } else {
+        await handleResponse(res);
+      }
+    } catch (e) {
+      console.log(e);
+      dispatch(
+        setResponse(
+          translate({
+            id: OPENAPI_REQUEST.CONNECTION_FAILED,
+            message: "Connection failed",
+          })
+        )
+      );
+      dispatch(clearCode());
+      dispatch(clearHeaders());
+    }
+  };
+
+  const showServerOptions = serverOptions.length > 0;
+  const showAcceptOptions = acceptOptions.length > 1;
+  const showRequestBody = contentType !== undefined;
+  const showRequestButton = item.servers && !hideSendButton;
+  const showAuth = authSelected !== undefined;
+  const showParams = allParams.length > 0;
+  const requestBodyRequired = item.requestBody?.required;
+
+  if (
+    !showAcceptOptions &&
+    !showAuth &&
+    !showParams &&
+    !showRequestBody &&
+    !showServerOptions
+  ) {
+    return null;
+  }
+
+  const expandAllDetails = () => {
+    setExpandAccept(true);
+    setExpandAuth(true);
+    setExpandBody(true);
+    setExpandParams(true);
+    setExpandServer(true);
+  };
+
+  const collapseAllDetails = () => {
+    setExpandAccept(false);
+    setExpandAuth(false);
+    setExpandBody(false);
+    setExpandParams(false);
+    setExpandServer(false);
+  };
+
+  const allDetailsExpanded =
+    expandParams && expandBody && expandServer && expandAuth && expandAccept;
+
+  return (
+    <FormProvider {...methods}>
+      <form
+        className="openapi-explorer__request-form"
+        onSubmit={methods.handleSubmit(onSubmit)}
+      >
+        <div className="openapi-explorer__request-header-container">
+          <span className="openapi-explorer__request-title">
+            {translate({
+              id: OPENAPI_REQUEST.REQUEST_TITLE,
+              message: "Request",
+            })}
+          </span>
+          {allDetailsExpanded ? (
+            <span
+              className="openapi-explorer__expand-details-btn"
+              onClick={collapseAllDetails}
+            >
+              {translate({
+                id: OPENAPI_REQUEST.COLLAPSE_ALL,
+                message: "Collapse all",
+              })}
+            </span>
+          ) : (
+            <span
+              className="openapi-explorer__expand-details-btn"
+              onClick={expandAllDetails}
+            >
+              {translate({
+                id: OPENAPI_REQUEST.EXPAND_ALL,
+                message: "Expand all",
+              })}
+            </span>
+          )}
+        </div>
+        <div className="openapi-explorer__details-outer-container">
+          {showServerOptions && item.method !== "event" && (
+            <details
+              open={expandServer}
+              className="openapi-explorer__details-container"
+            >
+              <summary
+                className="openapi-explorer__details-summary"
+                onClick={(e) => {
+                  e.preventDefault();
+                  setExpandServer(!expandServer);
+                }}
+              >
+                {translate({
+                  id: OPENAPI_REQUEST.BASE_URL_TITLE,
+                  message: "Base URL",
+                })}
+              </summary>
+              <Server />
+            </details>
+          )}
+          {showAuth && (
+            <details
+              open={expandAuth}
+              className="openapi-explorer__details-container"
+            >
+              <summary
+                className="openapi-explorer__details-summary"
+                onClick={(e) => {
+                  e.preventDefault();
+                  setExpandAuth(!expandAuth);
+                }}
+              >
+                {translate({ id: OPENAPI_REQUEST.AUTH_TITLE, message: "Auth" })}
+              </summary>
+              <Authorization />
+            </details>
+          )}
+          {showParams && (
+            <details
+              open={
+                expandParams || Object.keys(methods.formState.errors).length
+              }
+              className="openapi-explorer__details-container"
+            >
+              <summary
+                className="openapi-explorer__details-summary"
+                onClick={(e) => {
+                  e.preventDefault();
+                  setExpandParams(!expandParams);
+                }}
+              >
+                {translate({
+                  id: OPENAPI_REQUEST.PARAMETERS_TITLE,
+                  message: "Parameters",
+                })}
+              </summary>
+              <ParamOptions />
+            </details>
+          )}
+          {showRequestBody && (
+            <details
+              open={expandBody}
+              className="openapi-explorer__details-container"
+            >
+              <summary
+                className="openapi-explorer__details-summary"
+                onClick={(e) => {
+                  e.preventDefault();
+                  setExpandBody(!expandBody);
+                }}
+              >
+                {translate({ id: OPENAPI_REQUEST.BODY_TITLE, message: "Body" })}
+                {requestBodyRequired && (
+                  <span className="openapi-schema__required">
+                    &nbsp;
+                    {translate({
+                      id: OPENAPI_REQUEST.REQUIRED_LABEL,
+                      message: "required",
+                    })}
+                  </span>
+                )}
+              </summary>
+              <>
+                <ContentType />
+                <Body
+                  jsonRequestBodyExample={item.jsonRequestBodyExample}
+                  requestBodyMetadata={item.requestBody}
+                  required={requestBodyRequired}
+                />
+              </>
+            </details>
+          )}
+          {showAcceptOptions && (
+            <details
+              open={expandAccept}
+              className="openapi-explorer__details-container"
+            >
+              <summary
+                className="openapi-explorer__details-summary"
+                onClick={(e) => {
+                  e.preventDefault();
+                  setExpandAccept(!expandAccept);
+                }}
+              >
+                {translate({
+                  id: OPENAPI_REQUEST.ACCEPT_TITLE,
+                  message: "Accept",
+                })}
+              </summary>
+              <Accept />
+            </details>
+          )}
+          {showRequestButton && item.method !== "event" && (
+            <button className="openapi-explorer__request-btn" type="submit">
+              {translate({
+                id: OPENAPI_REQUEST.SEND_BUTTON,
+                message: "Send API Request",
+              })}
+            </button>
+          )}
+        </div>
+      </form>
+    </FormProvider>
+  );
+}
+
+export default Request;