@camunda8/docusaurus-theme-openapi-docs 4.5.1

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

@@ -0,0 +1,261 @@
+/* ============================================================================
+ * 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, { cloneElement, ReactElement, useEffect, useRef } from "react";
+
+import {
+  sanitizeTabsChildren,
+  type TabProps,
+  useScrollPositionBlocker,
+  useTabs,
+} from "@docusaurus/theme-common/internal";
+import { TabItemProps } from "@docusaurus/theme-common/lib/utils/tabsUtils";
+import useIsBrowser from "@docusaurus/useIsBrowser";
+import clsx from "clsx";
+
+import { Language } from "../CodeSnippets/code-snippets-types";
+
+export interface Props {
+  action: {
+    [key: string]: React.Dispatch<any>;
+  };
+  currentLanguage?: Language;
+  languageSet: Language[];
+  includeVariant?: boolean;
+}
+
+export interface CodeTabsProps extends Props, TabProps {
+  includeSample?: boolean;
+}
+
+function TabList({
+  action,
+  currentLanguage,
+  languageSet,
+  includeVariant,
+  includeSample,
+  className,
+  block,
+  selectedValue,
+  selectValue,
+  tabValues,
+}: CodeTabsProps & ReturnType<typeof useTabs>) {
+  const tabRefs = useRef<(HTMLLIElement | null)[]>([]);
+  const tabsScrollContainerRef = useRef<any>(null);
+  const { blockElementScrollPositionUntilNextRender } =
+    useScrollPositionBlocker();
+
+  useEffect(() => {
+    const activeTab = tabRefs.current.find(
+      (tab) => tab?.getAttribute("aria-selected") === "true"
+    );
+
+    if (activeTab && tabsScrollContainerRef.current) {
+      const container = tabsScrollContainerRef.current;
+      const containerRect = container.getBoundingClientRect();
+      const activeTabRect = activeTab.getBoundingClientRect();
+
+      // Calculate the distance to scroll to align active tab to the left
+      const glowOffset = 3;
+      const scrollOffset =
+        activeTabRect.left -
+        containerRect.left +
+        container.scrollLeft -
+        glowOffset;
+
+      // Check if the active tab is not already at the left position
+
+      if (Math.abs(scrollOffset - container.scrollLeft) > 4) {
+        // Adjust the scroll of the container
+        container.scrollLeft = scrollOffset;
+      }
+    }
+  }, []);
+
+  const handleTabChange = (
+    event:
+      | React.FocusEvent<HTMLLIElement>
+      | React.MouseEvent<HTMLLIElement>
+      | React.KeyboardEvent<HTMLLIElement>
+  ) => {
+    const newTab = event.currentTarget;
+    const newTabIndex = tabRefs.current.indexOf(newTab);
+    const newTabValue = tabValues[newTabIndex]!.value;
+
+    if (newTabValue !== selectedValue) {
+      blockElementScrollPositionUntilNextRender(newTab);
+      selectValue(newTabValue);
+    }
+
+    if (action) {
+      let newLanguage: Language;
+      if (currentLanguage && includeVariant && includeSample) {
+        // Combined mode: samples and variants in one tab group
+        newLanguage = languageSet.filter(
+          (lang: Language) => lang.language === currentLanguage.language
+        )[0];
+        if (newLanguage.samples?.includes(newTabValue)) {
+          newLanguage.sample = newTabValue;
+          action.setSelectedSample(newTabValue);
+        } else {
+          newLanguage.variant = newTabValue;
+          action.setSelectedVariant(newTabValue.toLowerCase());
+        }
+      } else if (currentLanguage && includeVariant) {
+        newLanguage = languageSet.filter(
+          (lang: Language) => lang.language === currentLanguage.language
+        )[0];
+        newLanguage.variant = newTabValue;
+        action.setSelectedVariant(newTabValue.toLowerCase());
+      } else if (currentLanguage && includeSample) {
+        newLanguage = languageSet.filter(
+          (lang: Language) => lang.language === currentLanguage.language
+        )[0];
+        newLanguage.sample = newTabValue;
+        action.setSelectedSample(newTabValue);
+      } else {
+        newLanguage = languageSet.filter(
+          (lang: Language) => lang.language === newTabValue
+        )[0];
+        action.setSelectedVariant(newLanguage.variants[0].toLowerCase());
+        action.setSelectedSample(newLanguage.sample);
+      }
+      action.setLanguage(newLanguage);
+    }
+  };
+
+  const handleKeydown = (event: React.KeyboardEvent<HTMLLIElement>) => {
+    let focusElement: HTMLLIElement | null = null;
+
+    switch (event.key) {
+      case "Enter": {
+        handleTabChange(event);
+        break;
+      }
+      case "ArrowRight": {
+        const nextTab = tabRefs.current.indexOf(event.currentTarget) + 1;
+        focusElement = tabRefs.current[nextTab] ?? tabRefs.current[0]!;
+        break;
+      }
+      case "ArrowLeft": {
+        const prevTab = tabRefs.current.indexOf(event.currentTarget) - 1;
+        focusElement =
+          tabRefs.current[prevTab] ??
+          tabRefs.current[tabRefs.current.length - 1]!;
+        break;
+      }
+      default:
+        break;
+    }
+
+    focusElement?.focus();
+  };
+
+  return (
+    <ul
+      role="tablist"
+      aria-orientation="horizontal"
+      className={clsx(
+        "tabs",
+        "openapi-tabs__code-list-container",
+        {
+          "tabs--block": block,
+        },
+        className
+      )}
+      ref={tabsScrollContainerRef}
+    >
+      {tabValues.map(({ value, label, attributes }) => (
+        <li
+          // TODO extract TabListItem
+          role="tab"
+          tabIndex={selectedValue === value ? 0 : -1}
+          aria-selected={selectedValue === value}
+          key={value}
+          ref={(tabControl) => {
+            if (tabControl) {
+              tabRefs.current.push(tabControl);
+            }
+          }}
+          onKeyDown={handleKeydown}
+          onClick={handleTabChange}
+          {...attributes}
+          className={clsx(
+            "tabs__item",
+            "openapi-tabs__code-item",
+            attributes?.className as string,
+            {
+              active: selectedValue === value,
+            }
+          )}
+        >
+          <span>{label ?? value}</span>
+        </li>
+      ))}
+    </ul>
+  );
+}
+
+function TabContent({
+  lazy,
+  children,
+  selectedValue,
+}: CodeTabsProps & ReturnType<typeof useTabs>): React.JSX.Element | null {
+  const childTabs = (Array.isArray(children) ? children : [children]).filter(
+    Boolean
+  ) as ReactElement<TabItemProps>[];
+  if (lazy) {
+    const selectedTabItem = childTabs.find(
+      (tabItem) => tabItem.props.value === selectedValue
+    );
+    if (!selectedTabItem) {
+      // fail-safe or fail-fast? not sure what's best here
+      return null;
+    }
+    return cloneElement(selectedTabItem, { className: "margin-top--md" });
+  }
+  return (
+    <div className="margin-top--md openapi-tabs__code-content">
+      {childTabs.map((tabItem, i) =>
+        cloneElement(tabItem, {
+          key: i,
+          hidden: tabItem.props.value !== selectedValue,
+        })
+      )}
+    </div>
+  );
+}
+
+function TabsComponent(props: CodeTabsProps & Props): React.JSX.Element {
+  const tabs = useTabs(props);
+  const { className } = props;
+
+  return (
+    <div
+      className={clsx("tabs-container openapi-tabs__code-container", className)}
+    >
+      <TabList {...props} {...tabs} />
+      <TabContent {...props} {...tabs} />
+    </div>
+  );
+}
+
+export default function CodeTabs(
+  props: CodeTabsProps & Props
+): React.JSX.Element {
+  const isBrowser = useIsBrowser();
+  return (
+    <TabsComponent
+      // Remount tabs after hydration
+      // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
+      key={String(isBrowser)}
+      {...props}
+    >
+      {sanitizeTabsChildren(props.children)}
+    </TabsComponent>
+  );
+}

package/src/theme/ApiExplorer/ContentType/index.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 FormItem from "@theme/ApiExplorer/FormItem";
+import FormSelect from "@theme/ApiExplorer/FormSelect";
+import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
+
+import { setContentType } from "./slice";
+
+function ContentType() {
+  const value = useTypedSelector((state: any) => state.contentType.value);
+  const options = useTypedSelector((state: any) => state.contentType.options);
+  const dispatch = useTypedDispatch();
+
+  if (options.length <= 1) {
+    return null;
+  }
+
+  return (
+    <FormItem label="Content-Type">
+      <FormSelect
+        value={value}
+        options={options}
+        onChange={(e: React.ChangeEvent<HTMLSelectElement>) =>
+          dispatch(setContentType(e.target.value))
+        }
+      />
+    </FormItem>
+  );
+}
+
+export default ContentType;

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

@@ -0,0 +1,29 @@
+/* ============================================================================
+ * 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";
+
+export interface State {
+  value: string;
+  options: string[];
+}
+
+const initialState: State = {} as any;
+
+export const slice = createSlice({
+  name: "contentType",
+  initialState,
+  reducers: {
+    setContentType: (state, action: PayloadAction<string>) => {
+      state.value = action.payload;
+    },
+  },
+});
+
+export const { setContentType } = slice.actions;
+
+export default slice.reducer;

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

@@ -0,0 +1,47 @@
+/* ============================================================================
+ * 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 fileSaver from "file-saver";
+
+const saveFile = (url: string) => {
+  let fileName;
+  if (url.endsWith("json") || url.endsWith("yaml") || url.endsWith("yml")) {
+    fileName = url.substring(url.lastIndexOf("/") + 1);
+  }
+  fileSaver.saveAs(url, fileName ? fileName : "openapi.txt");
+};
+
+function Export({ url, proxy }: any) {
+  return (
+    <div
+      style={{ float: "right" }}
+      className="dropdown dropdown--hoverable dropdown--right"
+    >
+      <button className="export-button button button--sm button--secondary">
+        Export
+      </button>
+      <ul className="export-dropdown dropdown__menu">
+        <li>
+          <a
+            onClick={(e) => {
+              e.preventDefault();
+              saveFile(`${url}`);
+            }}
+            className="dropdown__link"
+            href={`${url}`}
+          >
+            OpenAPI Spec
+          </a>
+        </li>
+      </ul>
+    </div>
+  );
+}
+
+export default Export;

package/src/theme/ApiExplorer/FloatingButton/_FloatingButton.scss

@@ -0,0 +1,27 @@
+.openapi-explorer__floating-btn {
+  position: relative;
+
+  button {
+    position: relative;
+    background: var(--ifm-color-emphasis-900);
+    border: none;
+    border-radius: var(--ifm-global-radius);
+    color: var(--ifm-color-emphasis-100);
+    cursor: pointer;
+    padding: 0.4rem 0.5rem;
+    opacity: 0;
+    visibility: hidden;
+    transition:
+      opacity 0.2s ease-in-out,
+      visibility 0.2s ease-in-out,
+      bottom 0.2s ease-in-out;
+    position: absolute;
+    right: calc(var(--ifm-pre-padding) / 2);
+  }
+}
+.openapi-explorer__floating-btn:hover button,
+.openapi-explorer__floating-btn:focus-visible button,
+.openapi-explorer__floating-btn button:focus-visible {
+  visibility: visible;
+  opacity: 1;
+}

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

@@ -0,0 +1,29 @@
+/* ============================================================================
+ * 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";
+
+export interface Props {
+  label?: string;
+  onClick?: React.MouseEventHandler<HTMLButtonElement>;
+  children?: React.ReactNode;
+}
+
+function FloatingButton({ label, onClick, children }: Props) {
+  return (
+    <div tabIndex={0} className="openapi-explorer__floating-btn">
+      {label && (
+        <button tabIndex={0} onClick={onClick}>
+          {label}
+        </button>
+      )}
+      {children}
+    </div>
+  );
+}
+
+export default FloatingButton;

package/src/theme/ApiExplorer/FormFileUpload/_FormFileUpload.scss

@@ -0,0 +1,74 @@
+.openapi-explorer__dropzone {
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  cursor: pointer;
+  border: 2px dashed var(--openapi-monaco-border-color);
+  background-color: var(--openapi-input-background);
+
+  width: 100%;
+  border-radius: 4px;
+  padding: var(--ifm-pre-padding);
+  font-size: var(--ifm-code-font-size);
+
+  &:hover {
+    border: 2px dashed var(--ifm-color-primary);
+    background:
+      linear-gradient(
+        var(--openapi-dropzone-hover-shim),
+        var(--openapi-dropzone-hover-shim)
+      ),
+      linear-gradient(var(--ifm-color-primary), var(--ifm-color-primary));
+
+    .openapi-explorer__dropzone-content {
+      color: var(--ifm-pre-color);
+    }
+  }
+}
+
+.openapi-explorer__dropzone-hover {
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  cursor: pointer;
+  border: 2px dashed var(--openapi-monaco-border-color);
+  background-color: var(--openapi-input-background);
+  width: 100%;
+  border-radius: 4px;
+  padding: var(--ifm-pre-padding);
+  font-size: var(--ifm-code-font-size);
+  border: 2px dashed var(--ifm-color-primary);
+
+  background:
+    linear-gradient(
+      var(--openapi-dropzone-hover-shim),
+      var(--openapi-dropzone-hover-shim)
+    ),
+    linear-gradient(var(--ifm-color-primary), var(--ifm-color-primary));
+
+  .openapi-explorer__dropzone-content {
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    flex-wrap: wrap;
+    margin: var(--ifm-pre-padding) 0;
+    color: var(--ifm-pre-color);
+  }
+
+  .openapi-explorer__file-name {
+    margin: 0 calc(var(--ifm-pre-padding) * 1.5);
+    white-space: nowrap;
+    overflow: hidden;
+    text-overflow: ellipsis;
+    flex: 1;
+  }
+}
+
+.openapi-explorer__dropzone-content {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  flex-wrap: wrap;
+  margin: var(--ifm-pre-padding) 0;
+  color: var(--openapi-dropzone-color);
+}

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

@@ -0,0 +1,124 @@
+/* ============================================================================
+ * 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 FloatingButton from "@theme/ApiExplorer/FloatingButton";
+import { OPENAPI_FORM_FILE_UPLOAD } from "@theme/translationIds";
+import MagicDropzone from "react-magic-dropzone";
+
+type PreviewFile = { preview: string } & File;
+
+interface RenderPreviewProps {
+  file: PreviewFile;
+}
+
+function RenderPreview({ file }: RenderPreviewProps) {
+  switch (file.type) {
+    case "image/png":
+    case "image/jpeg":
+    case "image/jpg":
+    case "image/svg+xml":
+      return (
+        <img
+          style={{
+            borderRadius: "4px",
+          }}
+          src={file.preview}
+          alt=""
+        />
+      );
+    default:
+      return (
+        <div
+          style={{
+            display: "flex",
+            alignItems: "center",
+            minWidth: 0,
+          }}
+        >
+          <svg viewBox="0 0 100 120" style={{ width: "50px", height: "60px" }}>
+            <path
+              fillRule="evenodd"
+              fill="#b3beca"
+              d="M100.000,39.790 L100.000,105.000 C100.000,113.284 93.284,120.000 85.000,120.000 L15.000,120.000 C6.716,120.000 -0.000,113.284 -0.000,105.000 L-0.000,15.000 C-0.000,6.716 6.716,-0.000 15.000,-0.000 L60.210,-0.000 L100.000,39.790 Z"
+            />
+            <path
+              fillRule="evenodd"
+              fill="#90a1b1"
+              transform="translate(60, 0)"
+              d="M0.210,-0.000 L40.000,39.790 L40.000,40.000 L15.000,40.000 C6.716,40.000 0.000,33.284 0.000,25.000 L0.000,-0.000 L0.210,-0.000 Z"
+            />
+          </svg>
+          <div className="openapi-explorer__file-name">{file.name}</div>
+        </div>
+      );
+  }
+}
+
+export interface Props {
+  placeholder: string;
+  onChange?(file?: File): any;
+}
+
+function FormFileUpload({ placeholder, onChange }: Props) {
+  const [hover, setHover] = useState(false);
+  const [file, setFile] = useState<PreviewFile>();
+
+  function setAndNotifyFile(file?: PreviewFile) {
+    setFile(file);
+    onChange?.(file);
+  }
+
+  function handleDrop(accepted: PreviewFile[]) {
+    const [file] = accepted;
+    setAndNotifyFile(file);
+    setHover(false);
+  }
+
+  return (
+    <FloatingButton>
+      <MagicDropzone
+        className={
+          hover
+            ? "openapi-explorer__dropzone-hover"
+            : "openapi-explorer__dropzone"
+        }
+        onDrop={handleDrop}
+        onDragEnter={() => setHover(true)}
+        onDragLeave={() => setHover(false)}
+        multiple={false}
+        style={{ marginTop: "calc(var(--ifm-pre-padding) / 2)" }}
+      >
+        {file ? (
+          <>
+            <button
+              style={{ marginTop: "calc(var(--ifm-pre-padding) / 2)" }}
+              onClick={(e) => {
+                e.stopPropagation();
+                setAndNotifyFile(undefined);
+              }}
+            >
+              {translate({
+                id: OPENAPI_FORM_FILE_UPLOAD.CLEAR_BUTTON,
+                message: "Clear",
+              })}
+            </button>
+            <RenderPreview file={file} />
+          </>
+        ) : (
+          <div className="openapi-explorer__dropzone-content">
+            {placeholder}
+          </div>
+        )}
+      </MagicDropzone>
+    </FloatingButton>
+  );
+}
+
+export default FormFileUpload;

package/src/theme/ApiExplorer/FormItem/_FormItem.scss

@@ -0,0 +1,21 @@
+.openapi-explorer__form-item {
+  padding: var(--openapi-explorer-padding-input);
+  font-size: var(--openapi-explorer-font-size-input);
+
+  &:first-child {
+    margin-top: 0;
+  }
+
+  .required {
+    color: var(--openapi-required);
+  }
+}
+
+.openapi-explorer__form-item-body-container {
+  padding: 0;
+}
+
+.openapi-explorer__form-item-label {
+  font-family: var(--ifm-font-family-monospace);
+  font-weight: bold;
+}

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

@@ -0,0 +1,40 @@
+/* ============================================================================
+ * 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 { OPENAPI_SCHEMA_ITEM } from "@theme/translationIds";
+
+import clsx from "clsx";
+
+export interface Props {
+  label?: string;
+  type?: string;
+  required?: boolean | undefined;
+  children?: React.ReactNode;
+  className?: string;
+}
+
+function FormItem({ label, type, required, children, className }: Props) {
+  return (
+    <div className={clsx("openapi-explorer__form-item", className)}>
+      {label && (
+        <label className="openapi-explorer__form-item-label">{label}</label>
+      )}
+      {type && <span style={{ opacity: 0.6 }}> — {type}</span>}
+      {required && (
+        <span className="openapi-schema__required">
+          {translate({ id: OPENAPI_SCHEMA_ITEM.REQUIRED, message: "required" })}
+        </span>
+      )}
+      <div>{children}</div>
+    </div>
+  );
+}
+
+export default FormItem;