docusaurus-theme-openapi-docs 0.0.0-1000

package/lib/theme/ApiExplorer/CodeTabs/index.js

@@ -0,0 +1,271 @@
+"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 = CodeTabs;
+const react_1 = __importStar(require("react"));
+const internal_1 = require("@docusaurus/theme-common/internal");
+const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
+const clsx_1 = __importDefault(require("clsx"));
+function TabList({
+  action,
+  currentLanguage,
+  languageSet,
+  includeVariant,
+  includeSample,
+  className,
+  block,
+  selectedValue,
+  selectValue,
+  tabValues,
+}) {
+  const tabRefs = (0, react_1.useRef)([]);
+  const tabsScrollContainerRef = (0, react_1.useRef)(null);
+  const { blockElementScrollPositionUntilNextRender } = (0,
+  internal_1.useScrollPositionBlocker)();
+  (0, react_1.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) => {
+    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;
+      if (currentLanguage && includeVariant) {
+        newLanguage = languageSet.filter(
+          (lang) => lang.language === currentLanguage
+        )[0];
+        newLanguage.variant = newTabValue;
+        action.setSelectedVariant(newTabValue.toLowerCase());
+      } else if (currentLanguage && includeSample) {
+        newLanguage = languageSet.filter(
+          (lang) => lang.language === currentLanguage
+        )[0];
+        newLanguage.sample = newTabValue;
+        action.setSelectedSample(newTabValue);
+      } else {
+        newLanguage = languageSet.filter(
+          (lang) => lang.language === newTabValue
+        )[0];
+        action.setSelectedVariant(newLanguage.variants[0].toLowerCase());
+        action.setSelectedSample(newLanguage.sample);
+      }
+      action.setLanguage(newLanguage);
+    }
+  };
+  const handleKeydown = (event) => {
+    let focusElement = 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 react_1.default.createElement(
+    "ul",
+    {
+      role: "tablist",
+      "aria-orientation": "horizontal",
+      className: (0, clsx_1.default)(
+        "tabs",
+        "openapi-tabs__code-list-container",
+        {
+          "tabs--block": block,
+        },
+        className
+      ),
+      ref: tabsScrollContainerRef,
+    },
+    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) => {
+            if (tabControl) {
+              tabRefs.current.push(tabControl);
+            }
+          },
+          onKeyDown: handleKeydown,
+          onClick: handleTabChange,
+          ...attributes,
+          className: (0, clsx_1.default)(
+            "tabs__item",
+            "openapi-tabs__code-item",
+            attributes?.className,
+            {
+              active: selectedValue === value,
+            }
+          ),
+        },
+        react_1.default.createElement("span", null, label ?? value)
+      )
+    )
+  );
+}
+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 openapi-tabs__code-content" },
+    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);
+  const { className } = props;
+  return react_1.default.createElement(
+    "div",
+    {
+      className: (0, clsx_1.default)(
+        "tabs-container openapi-tabs__code-container",
+        className
+      ),
+    },
+    react_1.default.createElement(TabList, { ...props, ...tabs }),
+    react_1.default.createElement(TabContent, { ...props, ...tabs })
+  );
+}
+function CodeTabs(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/ApiExplorer/ContentType/index.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+declare function ContentType(): React.JSX.Element | null;
+export default ContentType;

package/lib/theme/ApiExplorer/ContentType/index.js

@@ -0,0 +1,40 @@
+"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 });
+const react_1 = __importDefault(require("react"));
+const FormItem_1 = __importDefault(require("@theme/ApiExplorer/FormItem"));
+const FormSelect_1 = __importDefault(require("@theme/ApiExplorer/FormSelect"));
+const hooks_1 = require("@theme/ApiItem/hooks");
+const slice_1 = require("./slice");
+function ContentType() {
+  const value = (0, hooks_1.useTypedSelector)(
+    (state) => state.contentType.value
+  );
+  const options = (0, hooks_1.useTypedSelector)(
+    (state) => state.contentType.options
+  );
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  if (options.length <= 1) {
+    return null;
+  }
+  return react_1.default.createElement(
+    FormItem_1.default,
+    { label: "Content-Type" },
+    react_1.default.createElement(FormSelect_1.default, {
+      value: value,
+      options: options,
+      onChange: (e) => dispatch((0, slice_1.setContentType)(e.target.value)),
+    })
+  );
+}
+exports.default = ContentType;

package/lib/theme/ApiExplorer/ContentType/slice.d.ts

@@ -0,0 +1,11 @@
+import { PayloadAction } from "@reduxjs/toolkit";
+export interface State {
+    value: string;
+    options: string[];
+}
+export declare const slice: import("@reduxjs/toolkit").Slice<State, {
+    setContentType: (state: import("immer/dist/internal").WritableDraft<State>, action: PayloadAction<string>) => void;
+}, "contentType">;
+export declare const setContentType: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "contentType/setContentType">;
+declare const _default: import("redux").Reducer<State>;
+export default _default;

package/lib/theme/ApiExplorer/ContentType/slice.js

@@ -0,0 +1,22 @@
+"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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setContentType = exports.slice = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const initialState = {};
+exports.slice = (0, toolkit_1.createSlice)({
+  name: "contentType",
+  initialState,
+  reducers: {
+    setContentType: (state, action) => {
+      state.value = action.payload;
+    },
+  },
+});
+exports.setContentType = exports.slice.actions.setContentType;
+exports.default = exports.slice.reducer;

package/lib/theme/ApiExplorer/Export/index.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+declare function Export({ url, proxy }: any): React.JSX.Element;
+export default Export;

package/lib/theme/ApiExplorer/Export/index.js

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

package/lib/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/lib/theme/ApiExplorer/FloatingButton/index.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+export interface Props {
+    label?: string;
+    onClick?: React.MouseEventHandler<HTMLButtonElement>;
+    children?: React.ReactNode;
+}
+declare function FloatingButton({ label, onClick, children }: Props): React.JSX.Element;
+export default FloatingButton;

package/lib/theme/ApiExplorer/FloatingButton/index.js

@@ -0,0 +1,28 @@
+"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 });
+const react_1 = __importDefault(require("react"));
+function FloatingButton({ label, onClick, children }) {
+  return react_1.default.createElement(
+    "div",
+    { tabIndex: 0, className: "openapi-explorer__floating-btn" },
+    label &&
+      react_1.default.createElement(
+        "button",
+        { tabIndex: 0, onClick: onClick },
+        label
+      ),
+    children
+  );
+}
+exports.default = FloatingButton;

package/lib/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/lib/theme/ApiExplorer/FormFileUpload/index.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+export interface Props {
+    placeholder: string;
+    onChange?(file?: File): any;
+}
+declare function FormFileUpload({ placeholder, onChange }: Props): React.JSX.Element;
+export default FormFileUpload;