@camunda8/docusaurus-theme-openapi-docs 4.5.1

package/lib/theme/SchemaItem/_SchemaItem.scss

@@ -0,0 +1,89 @@
+.openapi-schema__container {
+  &:hover {
+    .openapi-schema__property {
+      color: var(--ifm-color-primary);
+    }
+  }
+}
+
+.openapi-schema__list-item {
+  list-style: none;
+  position: relative;
+  margin: 0 !important;
+  padding: 5px 0 5px 1rem;
+  border-left: thin solid var(--openapi-tree-line-color) !important;
+
+  // Horizontal line styling for schema properties
+  &::before {
+    position: absolute;
+    top: 10px;
+    left: 0;
+    width: 0.7rem;
+    /* width of horizontal line */
+    height: 0.5rem;
+    /* vertical position of line */
+    vertical-align: top;
+    border-bottom: thin solid var(--openapi-tree-line-color);
+    content: "";
+    display: inline-block;
+  }
+}
+
+.openapi-schema__name {
+  opacity: 0.6;
+  padding-left: 0.3rem;
+}
+
+.openapi-schema__required {
+  display: inline-flex;
+  align-items: center;
+  font-size: 10.5px;
+  font-weight: bold;
+  text-transform: uppercase;
+  color: var(--openapi-required);
+  margin-left: 1%;
+  background-color: transparent;
+}
+
+.openapi-schema__deprecated {
+  display: flex;
+  align-items: center;
+  font-size: 10.5px;
+  font-weight: bold;
+  text-transform: uppercase;
+  color: var(--openapi-deprecated);
+  margin-left: 1%;
+  background-color: transparent;
+}
+
+.openapi-schema__nullable {
+  display: flex;
+  align-items: center;
+  font-size: 10.5px;
+  font-weight: bold;
+  text-transform: uppercase;
+  color: var(--openapi-nullable);
+  margin-left: 1%;
+  background-color: transparent;
+}
+
+.openapi-schema__strikethrough {
+  text-decoration: line-through;
+}
+
+.openapi-schema__property {
+  margin-top: 1.25px;
+  font-family: var(--ifm-font-family-monospace);
+  transition: 300ms;
+}
+
+.openapi-schema__divider {
+  flex-grow: 1;
+  border-bottom: thin solid var(--ifm-toc-border-color);
+  margin: 10px;
+}
+
+.openapi-schema__container {
+  display: flex;
+  align-items: center;
+}

package/lib/theme/SchemaItem/index.d.ts

@@ -0,0 +1,12 @@
+import React, { ReactNode } from "react";
+export interface Props {
+    children?: ReactNode;
+    collapsible?: boolean;
+    name?: string;
+    qualifierMessage?: string | undefined;
+    required?: boolean;
+    schemaName?: string;
+    schema?: any;
+    discriminator?: boolean;
+}
+export default function SchemaItem(props: Props): React.JSX.Element;

package/lib/theme/SchemaItem/index.js

@@ -0,0 +1,314 @@
+"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 = SchemaItem;
+const react_1 = __importDefault(require("react"));
+const Markdown_1 = __importDefault(require("@theme/Markdown"));
+const clsx_1 = __importDefault(require("clsx"));
+const Translate_1 = require("@docusaurus/Translate");
+const translationIds_1 = require("@theme/translationIds");
+const utils_1 = require("../../markdown/utils");
+const transformEnumDescriptions = (enumDescriptions) => {
+  if (enumDescriptions) {
+    return Object.entries(enumDescriptions);
+  }
+  return [];
+};
+const getEnumDescriptionMarkdown = (enumDescriptions) => {
+  if (enumDescriptions?.length) {
+    const enumValue = (0, Translate_1.translate)({
+      id: translationIds_1.OPENAPI_SCHEMA_ITEM.ENUM_VALUE,
+      message: "Enum Value",
+    });
+    const description = (0, Translate_1.translate)({
+      id: translationIds_1.OPENAPI_SCHEMA_ITEM.ENUM_DESCRIPTION,
+      message: "Description",
+    });
+    return `| ${enumValue} | ${description} |
+| ---- | ----- |
+${enumDescriptions
+  .map((desc) => {
+    return `| ${desc[0]} | ${desc[1]} | `.replaceAll("\n", "<br/>");
+  })
+  .join("\n")}
+    `;
+  }
+  return "";
+};
+function SchemaItem(props) {
+  const {
+    children: collapsibleSchemaContent,
+    collapsible,
+    name,
+    qualifierMessage,
+    required,
+    schemaName,
+    schema,
+  } = props;
+  let deprecated;
+  let schemaDescription;
+  let defaultValue;
+  let example;
+  let nullable;
+  let enumDescriptions = [];
+  let constValue;
+  if (schema) {
+    deprecated = schema.deprecated;
+    schemaDescription = schema.description;
+    enumDescriptions = transformEnumDescriptions(schema["x-enumDescriptions"]);
+    defaultValue = schema.default;
+    example = schema.example;
+    nullable =
+      schema.nullable ||
+      (Array.isArray(schema.type) && schema.type.includes("null")); // support JSON Schema nullable
+    constValue = schema.const;
+  }
+  const renderRequired = (0, utils_1.guard)(
+    Array.isArray(required) ? required.includes(name) : required,
+    () =>
+      react_1.default.createElement(
+        "span",
+        { className: "openapi-schema__required" },
+        (0, Translate_1.translate)({
+          id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
+          message: "required",
+        })
+      )
+  );
+  const renderDeprecated = (0, utils_1.guard)(deprecated, () =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__deprecated" },
+      (0, Translate_1.translate)({
+        id: translationIds_1.OPENAPI_SCHEMA_ITEM.DEPRECATED,
+        message: "deprecated",
+      })
+    )
+  );
+  const renderNullable = (0, utils_1.guard)(nullable, () =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__nullable" },
+      (0, Translate_1.translate)({
+        id: translationIds_1.OPENAPI_SCHEMA_ITEM.NULLABLE,
+        message: "nullable",
+      })
+    )
+  );
+  const renderEnumDescriptions = (0, utils_1.guard)(
+    getEnumDescriptionMarkdown(enumDescriptions),
+    (value) => {
+      return react_1.default.createElement(
+        "div",
+        { style: { marginTop: ".5rem" } },
+        react_1.default.createElement(Markdown_1.default, null, value)
+      );
+    }
+  );
+  const renderSchemaDescription = (0, utils_1.guard)(
+    schemaDescription,
+    (description) =>
+      react_1.default.createElement(
+        react_1.default.Fragment,
+        null,
+        react_1.default.createElement(Markdown_1.default, null, description)
+      )
+  );
+  const renderQualifierMessage = (0, utils_1.guard)(
+    qualifierMessage,
+    (message) =>
+      react_1.default.createElement(
+        react_1.default.Fragment,
+        null,
+        react_1.default.createElement(Markdown_1.default, null, message)
+      )
+  );
+  function renderDefaultValue() {
+    if (defaultValue !== undefined) {
+      if (typeof defaultValue === "string") {
+        return react_1.default.createElement(
+          "div",
+          null,
+          react_1.default.createElement(
+            "strong",
+            null,
+            (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_SCHEMA_ITEM.DEFAULT_VALUE,
+              message: "Default value:",
+            }),
+            " "
+          ),
+          react_1.default.createElement(
+            "span",
+            null,
+            react_1.default.createElement("code", null, defaultValue)
+          )
+        );
+      }
+      return react_1.default.createElement(
+        "div",
+        null,
+        react_1.default.createElement(
+          "strong",
+          null,
+          (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_SCHEMA_ITEM.DEFAULT_VALUE,
+            message: "Default value:",
+          }),
+          " "
+        ),
+        react_1.default.createElement(
+          "span",
+          null,
+          react_1.default.createElement(
+            "code",
+            null,
+            JSON.stringify(defaultValue)
+          )
+        )
+      );
+    }
+    return undefined;
+  }
+  function renderExample() {
+    if (example !== undefined) {
+      if (typeof example === "string") {
+        return react_1.default.createElement(
+          "div",
+          null,
+          react_1.default.createElement(
+            "strong",
+            null,
+            (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_SCHEMA_ITEM.EXAMPLE,
+              message: "Example:",
+            }),
+            " "
+          ),
+          react_1.default.createElement(
+            "span",
+            null,
+            react_1.default.createElement("code", null, example)
+          )
+        );
+      }
+      return react_1.default.createElement(
+        "div",
+        null,
+        react_1.default.createElement(
+          "strong",
+          null,
+          (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_SCHEMA_ITEM.EXAMPLE,
+            message: "Example:",
+          }),
+          " "
+        ),
+        react_1.default.createElement(
+          "span",
+          null,
+          react_1.default.createElement("code", null, JSON.stringify(example))
+        )
+      );
+    }
+    return undefined;
+  }
+  function renderConstValue() {
+    if (constValue !== undefined) {
+      if (typeof constValue === "string") {
+        return react_1.default.createElement(
+          "div",
+          null,
+          react_1.default.createElement(
+            "strong",
+            null,
+            (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_SCHEMA_ITEM.CONSTANT_VALUE,
+              message: "Constant value:",
+            }),
+            " "
+          ),
+          react_1.default.createElement(
+            "span",
+            null,
+            react_1.default.createElement("code", null, constValue)
+          )
+        );
+      }
+      return react_1.default.createElement(
+        "div",
+        null,
+        react_1.default.createElement(
+          "strong",
+          null,
+          (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_SCHEMA_ITEM.CONSTANT_VALUE,
+            message: "Constant value:",
+          }),
+          " "
+        ),
+        react_1.default.createElement(
+          "span",
+          null,
+          react_1.default.createElement(
+            "code",
+            null,
+            JSON.stringify(constValue)
+          )
+        )
+      );
+    }
+    return undefined;
+  }
+  const schemaContent = react_1.default.createElement(
+    "div",
+    null,
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__container" },
+      react_1.default.createElement(
+        "strong",
+        {
+          className: (0, clsx_1.default)("openapi-schema__property", {
+            "openapi-schema__strikethrough": deprecated,
+          }),
+        },
+        name
+      ),
+      react_1.default.createElement(
+        "span",
+        { className: "openapi-schema__name" },
+        Array.isArray(schemaName) ? schemaName.join(" | ") : schemaName
+      ),
+      (nullable || required || deprecated) &&
+        react_1.default.createElement("span", {
+          className: "openapi-schema__divider",
+        }),
+      renderNullable,
+      renderRequired,
+      renderDeprecated
+    ),
+    renderSchemaDescription,
+    renderEnumDescriptions,
+    renderQualifierMessage,
+    renderConstValue(),
+    renderDefaultValue(),
+    renderExample(),
+    collapsibleSchemaContent ?? collapsibleSchemaContent
+  );
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-schema__list-item" },
+    collapsible ? collapsibleSchemaContent : schemaContent
+  );
+}

package/lib/theme/SchemaTabs/_SchemaTabs.scss

@@ -0,0 +1,61 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+.openapi-tabs__schema-item {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  padding: 0.35rem 0.7rem;
+  border: 1px solid transparent;
+  margin-top: 0 !important;
+  margin-right: 0.5rem;
+  font-weight: var(--ifm-font-weight-bold);
+  font-family: var(--ifm-font-family-monospace);
+  font-size: 10px;
+  white-space: nowrap;
+  transition: 300ms;
+
+  &:hover {
+    background-color: transparent;
+    border: 1px solid var(--ifm-toc-border-color);
+  }
+
+  &.active {
+    border: 1px solid var(--ifm-color-primary);
+    color: var(--ifm-color-primary);
+  }
+
+  &:last-child {
+    margin-right: 0 !important;
+  }
+}
+
+.openapi-tabs__schema-list-container {
+  overflow-y: hidden;
+  overflow-x: scroll;
+  scroll-behavior: smooth;
+  scrollbar-width: none;
+
+  &::-webkit-scrollbar {
+    display: none;
+  }
+
+  &.active {
+    background-color: var(--ifm-color-emphasis-100);
+  }
+}
+
+.openapi-tabs__schema-label {
+  white-space: nowrap;
+}
+
+.openapi-tabs__schema-tabs-container {
+  width: 100%;
+  display: flex;
+  align-items: center;
+  overflow: hidden;
+}

package/lib/theme/SchemaTabs/index.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { TabProps } from "@docusaurus/theme-common/internal";
+export default function SchemaTabs(props: TabProps): React.JSX.Element;