docusaurus-theme-openapi-docs 0.0.0-1000

package/lib/theme/ApiTabs/_ApiTabs.scss

@@ -0,0 +1,142 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+.openapi-tabs__container {
+  margin-left: -1px;
+}
+
+.openapi-tabs__response-header {
+  &.openapi-tabs__heading {
+    margin-bottom: 0;
+  }
+}
+
+.openapi-tabs__response-code-item {
+  border: 1px solid transparent;
+  margin-top: 0 !important;
+  margin-right: 0.5rem;
+  padding: 0.35rem 0.85rem;
+  border-radius: var(--ifm-global-radius);
+  font-weight: var(--ifm-font-weight-bold);
+  font-size: 12px;
+  transition: 300ms;
+  color: var(--ifm-font-color-secondary);
+
+  &.success.active {
+    background-color: var(--ifm-color-success);
+    color: var(--ifm-color-white);
+  }
+
+  &.danger.active {
+    background-color: var(--ifm-color-danger);
+    color: var(--ifm-color-white);
+  }
+
+  &.info.active {
+    background-color: var(--ifm-color-info);
+    color: var(--ifm-color-white);
+  }
+
+  &.active,
+  &:hover {
+    opacity: 1;
+  }
+
+  &:hover:not(.active) {
+    background-color: transparent;
+    border: 1px solid var(--ifm-toc-border-color);
+  }
+}
+
+.openapi-tabs__response-code-item:not(.active) {
+  opacity: 0.65;
+}
+
+.openapi-tabs__response-code-item:hover {
+  opacity: 1;
+}
+
+.openapi-tabs__response-code-item:last-child {
+  margin-right: 0 !important;
+}
+
+/* Open API Response Code Tabs */
+.openapi-tabs__response-header-section {
+  border-top: 1px solid var(--ifm-toc-border-color);
+  margin-top: 2rem;
+  padding-top: 2rem;
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+}
+
+.openapi-tabs__response-container {
+  display: flex;
+  align-items: center;
+  max-width: 390px;
+  padding-left: 1rem;
+  overflow: hidden;
+}
+
+.openapi-tabs__response-list-container {
+  padding: 0 0.25rem;
+  overflow-y: hidden;
+  overflow-x: scroll;
+  scroll-behavior: smooth;
+  scrollbar-width: none;
+}
+
+.openapi-tabs__response-list-container::-webkit-scrollbar {
+  display: none;
+}
+
+/* Response Code Tabs - Colored Dots */
+.openapi-tabs__response-dot {
+  width: 12.5px;
+  height: 12.5px;
+  margin-right: 5px;
+  border-radius: 50%;
+}
+
+.openapi-tabs__response-schema-container {
+  max-width: 600px;
+}
+
+/* Tab Arrows */
+.openapi-tabs__arrow {
+  content: "";
+  height: 1.25rem;
+  width: 1.25rem;
+  border: none;
+  min-width: 1.25rem;
+  background: var(--ifm-menu-link-sublist-icon) 50% / 2rem 2rem;
+  filter: var(--ifm-menu-link-sublist-icon-filter);
+
+  &:hover {
+    cursor: pointer;
+  }
+
+  &.left {
+    transform: rotate(270deg);
+  }
+
+  &.right {
+    transform: rotate(90deg);
+  }
+}
+
+@media screen and (max-width: 500px) {
+  .openapi-tabs__response-header-section {
+    flex-direction: column;
+    align-items: flex-start;
+  }
+
+  .openapi-tabs__response-container {
+    width: 100%;
+    margin-top: var(--ifm-spacing-vertical);
+    padding: 0;
+  }
+}

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

@@ -0,0 +1,7 @@
+import React from "react";
+import { TabProps } from "@docusaurus/theme-common/internal";
+export interface TabListProps extends TabProps {
+    label: string;
+    id: string;
+}
+export default function ApiTabs(props: TabListProps): React.JSX.Element;

package/lib/theme/ApiTabs/index.js

@@ -0,0 +1,270 @@
+"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 });
+exports.default = ApiTabs;
+const react_1 = __importStar(require("react"));
+const internal_1 = require("@docusaurus/theme-common/internal");
+const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
+const Heading_1 = __importDefault(require("@theme/Heading"));
+const clsx_1 = __importDefault(require("clsx"));
+function TabList({
+  className,
+  block,
+  selectedValue,
+  selectValue,
+  tabValues,
+  label = "Responses",
+  id = "responses",
+}) {
+  const tabRefs = [];
+  const { blockElementScrollPositionUntilNextRender } = (0,
+  internal_1.useScrollPositionBlocker)();
+  const handleTabChange = (event) => {
+    const newTab = event.currentTarget;
+    const newTabIndex = tabRefs.indexOf(newTab);
+    const newTabValue = tabValues[newTabIndex].value;
+    if (newTabValue !== selectedValue) {
+      blockElementScrollPositionUntilNextRender(newTab);
+      selectValue(newTabValue);
+    }
+  };
+  const handleKeydown = (event) => {
+    let focusElement = null;
+    switch (event.key) {
+      case "Enter": {
+        handleTabChange(event);
+        break;
+      }
+      case "ArrowRight": {
+        const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
+        focusElement = tabRefs[nextTab] ?? tabRefs[0];
+        break;
+      }
+      case "ArrowLeft": {
+        const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
+        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1];
+        break;
+      }
+      default:
+        break;
+    }
+    focusElement?.focus();
+  };
+  const tabItemListContainerRef = (0, react_1.useRef)(null);
+  const [showTabArrows, setShowTabArrows] = (0, react_1.useState)(false);
+  (0, react_1.useEffect)(() => {
+    const resizeObserver = new ResizeObserver((entries) => {
+      for (let entry of entries) {
+        requestAnimationFrame(() => {
+          if (entry.target.clientWidth < entry.target.scrollWidth) {
+            setShowTabArrows(true);
+          } else {
+            setShowTabArrows(false);
+          }
+        });
+      }
+    });
+    resizeObserver.observe(tabItemListContainerRef.current);
+    return () => {
+      resizeObserver.disconnect();
+    };
+  }, []);
+  const handleRightClick = () => {
+    tabItemListContainerRef.current.scrollLeft += 90;
+  };
+  const handleLeftClick = () => {
+    tabItemListContainerRef.current.scrollLeft -= 90;
+  };
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-tabs__response-header-section" },
+    react_1.default.createElement(
+      Heading_1.default,
+      {
+        as: "h2",
+        id: id,
+        className: "openapi-tabs__heading openapi-tabs__response-header",
+      },
+      label
+    ),
+    react_1.default.createElement(
+      "div",
+      { className: "openapi-tabs__response-container" },
+      showTabArrows &&
+        react_1.default.createElement("button", {
+          className: "openapi-tabs__arrow left",
+          onClick: handleLeftClick,
+        }),
+      react_1.default.createElement(
+        "ul",
+        {
+          ref: tabItemListContainerRef,
+          role: "tablist",
+          "aria-orientation": "horizontal",
+          className: (0, clsx_1.default)(
+            "openapi-tabs__response-list-container",
+            "tabs",
+            {
+              "tabs--block": block,
+            },
+            className
+          ),
+        },
+        tabValues.map(({ value, label, attributes }) =>
+          react_1.default.createElement(
+            "li",
+            {
+              // TODO extract TabListItem
+              role: "tab",
+              tabIndex: selectedValue === value ? 0 : -1,
+              "aria-selected": selectedValue === value,
+              key: value,
+              ref: (tabControl) => {
+                tabRefs.push(tabControl);
+              },
+              onKeyDown: handleKeydown,
+              onClick: handleTabChange,
+              ...attributes,
+              className: (0, clsx_1.default)(
+                "tabs__item",
+                "openapi-tabs__response-code-item",
+                attributes?.className,
+                parseInt(value) >= 400
+                  ? "danger"
+                  : parseInt(value) >= 200 && parseInt(value) < 300
+                    ? "success"
+                    : "info",
+                {
+                  active: selectedValue === value,
+                }
+              ),
+            },
+            label ?? value
+          )
+        )
+      ),
+      showTabArrows &&
+        react_1.default.createElement("button", {
+          className: "openapi-tabs__arrow right",
+          onClick: handleRightClick,
+        })
+    )
+  );
+}
+function TabContent({ lazy, children, selectedValue }) {
+  const childTabs = (Array.isArray(children) ? children : [children]).filter(
+    Boolean
+  );
+  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 (0, react_1.cloneElement)(selectedTabItem, {
+      className: "margin-top--md",
+    });
+  }
+  return react_1.default.createElement(
+    "div",
+    { className: "margin-top--md" },
+    childTabs.map((tabItem, i) =>
+      (0, react_1.cloneElement)(tabItem, {
+        key: i,
+        hidden: tabItem.props.value !== selectedValue,
+      })
+    )
+  );
+}
+function TabsComponent(props) {
+  const tabs = (0, internal_1.useTabs)(props);
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-tabs__container" },
+    react_1.default.createElement(TabList, { ...props, ...tabs }),
+    react_1.default.createElement(TabContent, { ...props, ...tabs })
+  );
+}
+function ApiTabs(props) {
+  const isBrowser = (0, useIsBrowser_1.default)();
+  return react_1.default.createElement(
+    TabsComponent,
+    // Remount tabs after hydration
+    // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
+    {
+      // Remount tabs after hydration
+      // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
+      key: String(isBrowser),
+      ...props,
+    },
+    (0, internal_1.sanitizeTabsChildren)(props.children)
+  );
+}

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

@@ -0,0 +1,3 @@
+import React from "react";
+export declare const OpeningArrayBracket: () => React.JSX.Element;
+export declare const ClosingArrayBracket: () => React.JSX.Element;

package/lib/theme/ArrayBrackets/index.js

@@ -0,0 +1,50 @@
+"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.ClosingArrayBracket = exports.OpeningArrayBracket = void 0;
+const react_1 = __importDefault(require("react"));
+const OpeningArrayBracket = () =>
+  react_1.default.createElement(
+    "li",
+    null,
+    react_1.default.createElement(
+      "div",
+      {
+        style: {
+          fontSize: "var(--ifm-code-font-size)",
+          opacity: 0.6,
+          marginLeft: "-.5rem",
+          paddingBottom: ".5rem",
+        },
+      },
+      "Array ["
+    )
+  );
+exports.OpeningArrayBracket = OpeningArrayBracket;
+const ClosingArrayBracket = () =>
+  react_1.default.createElement(
+    "li",
+    null,
+    react_1.default.createElement(
+      "div",
+      {
+        style: {
+          fontSize: "var(--ifm-code-font-size)",
+          opacity: 0.6,
+          marginLeft: "-.5rem",
+        },
+      },
+      "]"
+    )
+  );
+exports.ClosingArrayBracket = ClosingArrayBracket;

package/lib/theme/DiscriminatorTabs/_DiscriminatorTabs.scss

@@ -0,0 +1,98 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+.openapi-tabs__discriminator-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-size: 10px;
+  font-family: var(--ifm-font-family-monospace);
+  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;
+  }
+}
+
+/* Open API Discriminator Tabs */
+.openapi-tabs__discriminator-top-section {
+  margin-top: 1rem;
+  margin-left: 0.9rem;
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+}
+
+.openapi-tabs__discriminator-top-section + hr {
+  display: none;
+}
+
+.openapi-tabs__discriminator-container {
+  display: flex;
+  align-items: center;
+  max-width: 600px;
+  padding-left: 3px;
+  overflow: hidden;
+}
+
+.openapi-tabs__discriminator-list-container {
+  padding: 0 0.25rem;
+  overflow-y: hidden;
+  overflow-x: scroll;
+  scroll-behavior: smooth;
+  scrollbar-width: none;
+}
+
+.openapi-tabs__discriminator-list-container::-webkit-scrollbar {
+  display: none;
+}
+
+.openapi-tabs__discriminator-tab-label {
+  white-space: nowrap;
+}
+
+.openapi-discriminator__item {
+  list-style: none;
+  position: relative;
+  margin: 0 !important;
+  padding: 5px 0 5px 0 !important;
+  border-left: thin solid var(--openapi-tree-line-color) !important;
+}
+
+.openapi-discriminator__name {
+  padding-left: 1rem;
+}
+
+@media screen and (max-width: 500px) {
+  .openapi-tabs__discriminator-top-section {
+    flex-direction: column;
+    align-items: flex-start;
+  }
+
+  .openapi-tabs__discriminator-container {
+    width: 100%;
+  }
+
+  .openapi-tabs__discriminator-item {
+    height: 100%;
+  }
+}

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

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