docusaurus-theme-openapi-docs 0.0.0-1000

package/lib/theme/ApiExplorer/ApiCodeBlock/ExpandButton/index.js

@@ -0,0 +1,248 @@
+"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 = ExpandButton;
+const react_1 = __importStar(require("react"));
+const theme_common_1 = require("@docusaurus/theme-common");
+const Translate_1 = require("@docusaurus/Translate");
+const Container_1 = __importDefault(
+  require("@theme/ApiExplorer/ApiCodeBlock/Container")
+);
+const CopyButton_1 = __importDefault(
+  require("@theme/ApiExplorer/ApiCodeBlock/CopyButton")
+);
+const ExitButton_1 = __importDefault(
+  require("@theme/ApiExplorer/ApiCodeBlock/ExitButton")
+);
+const Line_1 = __importDefault(require("@theme/ApiExplorer/ApiCodeBlock/Line"));
+const clsx_1 = __importDefault(require("clsx"));
+const prism_react_renderer_1 = require("prism-react-renderer");
+const react_modal_1 = __importDefault(require("react-modal"));
+function ExpandButton({
+  code,
+  className,
+  language,
+  showLineNumbers,
+  blockClassName,
+  title,
+  lineClassNames,
+}) {
+  const [isModalOpen, setIsModalOpen] = (0, react_1.useState)(false);
+  const prismTheme = (0, theme_common_1.usePrismTheme)();
+  (0, react_1.useEffect)(() => {
+    react_modal_1.default.setAppElement("body");
+  }, []);
+  return react_1.default.createElement(
+    react_1.default.Fragment,
+    null,
+    react_1.default.createElement(
+      "button",
+      {
+        type: "button",
+        "aria-label": isModalOpen
+          ? (0, Translate_1.translate)({
+              id: "theme.CodeBlock.expanded",
+              message: "Expanded",
+              description: "The expanded button label on code blocks",
+            })
+          : (0, Translate_1.translate)({
+              id: "theme.CodeBlock.expandButtonAriaLabel",
+              message: "Expand code to fullscreen",
+              description: "The ARIA label for expand code blocks button",
+            }),
+        title: (0, Translate_1.translate)({
+          id: "theme.CodeBlock.expand",
+          message: "Expand",
+          description: "The expand button label on code blocks",
+        }),
+        className: (0, clsx_1.default)(
+          "clean-btn",
+          className,
+          "openapi-explorer__code-block-expand-btn",
+          isModalOpen && "openapi-explorer__code-block-expand-btn--copied"
+        ),
+        onClick: () => setIsModalOpen(true),
+      },
+      react_1.default.createElement(
+        "span",
+        {
+          className: "openapi-explorer__code-block-expand-btn-icons",
+          "aria-hidden": "true",
+        },
+        react_1.default.createElement(
+          "svg",
+          {
+            className: "openapi-explorer__code-block-expand-btn-icon",
+            viewBox: "0 0 448 512",
+          },
+          react_1.default.createElement("path", {
+            d: "M32 32C14.3 32 0 46.3 0 64v96c0 17.7 14.3 32 32 32s32-14.3 32-32V96h64c17.7 0 32-14.3 32-32s-14.3-32-32-32H32zM64 352c0-17.7-14.3-32-32-32s-32 14.3-32 32v96c0 17.7 14.3 32 32 32h96c17.7 0 32-14.3 32-32s-14.3-32-32-32H64V352zM320 32c-17.7 0-32 14.3-32 32s14.3 32 32 32h64v64c0 17.7 14.3 32 32 32s32-14.3 32-32V64c0-17.7-14.3-32-32-32H320zM448 352c0-17.7-14.3-32-32-32s-32 14.3-32 32v64H320c-17.7 0-32 14.3-32 32s14.3 32 32 32h96c17.7 0 32-14.3 32-32V352z",
+          })
+        ),
+        react_1.default.createElement(
+          "svg",
+          {
+            className: "openapi-explorer__code-block-expand-btn-icon--success",
+            viewBox: "0 0 24 24",
+          },
+          react_1.default.createElement("path", {
+            d: "M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z",
+          })
+        )
+      )
+    ),
+    react_1.default.createElement(
+      react_modal_1.default,
+      {
+        className: "openapi-explorer__expand-modal-content",
+        overlayClassName: "openapi-explorer__expand-modal-overlay",
+        isOpen: isModalOpen,
+        onRequestClose: () => setIsModalOpen(false),
+        contentLabel: "Code Snippet",
+      },
+      react_1.default.createElement(
+        Container_1.default,
+        {
+          as: "div",
+          className: (0, clsx_1.default)(
+            "openapi-explorer__code-block-container",
+            language &&
+              !blockClassName.includes(`language-${language}`) &&
+              `language-${language}`
+          ),
+        },
+        title &&
+          react_1.default.createElement(
+            "div",
+            { className: "openapi-explorer__code-block-title" },
+            title
+          ),
+        react_1.default.createElement(
+          "div",
+          { className: "openapi-explorer__code-block-content" },
+          react_1.default.createElement(
+            prism_react_renderer_1.Highlight,
+            // {...defaultProps}
+            {
+              // {...defaultProps}
+              theme: prismTheme,
+              code: code,
+              language: language ?? "text",
+            },
+            ({ className, tokens, getLineProps, getTokenProps }) =>
+              react_1.default.createElement(
+                "pre",
+                {
+                  /* eslint-disable-next-line jsx-a11y/no-noninteractive-tabindex */
+                  tabIndex: 0,
+                  className: (0, clsx_1.default)(
+                    className,
+                    "openapi-explorer__code-block",
+                    "thin-scrollbar"
+                  ),
+                },
+                react_1.default.createElement(
+                  "code",
+                  {
+                    className: (0, clsx_1.default)(
+                      "openapi-explorer__code-block-lines",
+                      showLineNumbers &&
+                        "openapi-explorer__code-block-lines-numbers"
+                    ),
+                  },
+                  tokens.map((line, i) =>
+                    react_1.default.createElement(Line_1.default, {
+                      key: i,
+                      line: line,
+                      getLineProps: getLineProps,
+                      getTokenProps: getTokenProps,
+                      classNames: lineClassNames[i],
+                      showLineNumbers: showLineNumbers,
+                    })
+                  )
+                )
+              )
+          ),
+          react_1.default.createElement(
+            "div",
+            { className: "openapi-explorer__code-block-btn-group" },
+            react_1.default.createElement(CopyButton_1.default, {
+              className: "openapi-explorer__code-block-code-btn",
+              code: code,
+            }),
+            react_1.default.createElement(ExitButton_1.default, {
+              className: "openapi-explorer__code-block-code-btn",
+              handler: () => setIsModalOpen(false),
+            })
+          )
+        )
+      )
+    )
+  );
+}

package/lib/theme/ApiExplorer/ApiCodeBlock/Line/_Line.scss

@@ -0,0 +1,34 @@
+/* Intentionally has zero specificity, so that to be able to override
+the background in custom CSS file due bug https://github.com/facebook/docusaurus/issues/3678 */
+:where(:root) {
+  --docusaurus-highlighted-code-line-bg: rgb(72 77 91);
+}
+
+:where([data-theme="dark"]) {
+  --docusaurus-highlighted-code-line-bg: rgb(100 100 100);
+}
+
+.openapi-explorer__code-block-code-line {
+  display: table-row;
+  counter-increment: line-count;
+}
+
+.openapi-explorer__code-block-code-line-number {
+  display: table-cell;
+  text-align: right;
+  width: 1%;
+  position: sticky;
+  left: 0;
+  padding: 0 var(--ifm-pre-padding);
+  background: var(--ifm-pre-background);
+  overflow-wrap: normal;
+}
+
+.openapi-explorer__code-block-code-line-number::before {
+  content: counter(line-count);
+  opacity: 0.4;
+}
+
+.openapi-explorer__code-block-code-line-number {
+  padding-right: var(--ifm-pre-padding);
+}

package/lib/theme/ApiExplorer/ApiCodeBlock/Line/index.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { LineProps } from "@docusaurus/theme-common/internal";
+export default function CodeBlockLine({ line, classNames, showLineNumbers, getLineProps, getTokenProps, }: LineProps): React.JSX.Element;

package/lib/theme/ApiExplorer/ApiCodeBlock/Line/index.js

@@ -0,0 +1,59 @@
+"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 = CodeBlockLine;
+const react_1 = __importDefault(require("react"));
+const clsx_1 = __importDefault(require("clsx"));
+function CodeBlockLine({
+  line,
+  classNames,
+  showLineNumbers,
+  getLineProps,
+  getTokenProps,
+}) {
+  if (line.length === 1 && line[0].content === "\n") {
+    line[0].content = "";
+  }
+  const lineProps = getLineProps({
+    line,
+    className: (0, clsx_1.default)(
+      classNames,
+      showLineNumbers && "openapi-explorer__code-block-code-line"
+    ),
+  });
+  const lineTokens = line.map((token, key) =>
+    react_1.default.createElement("span", {
+      key: key,
+      ...getTokenProps({ token, key }),
+    })
+  );
+  return react_1.default.createElement(
+    "span",
+    { ...lineProps },
+    showLineNumbers
+      ? react_1.default.createElement(
+          react_1.default.Fragment,
+          null,
+          react_1.default.createElement("span", {
+            className: "openapi-explorer__code-block-code-line-number",
+          }),
+          react_1.default.createElement(
+            "span",
+            { className: "openapi-explorer__code-block-code-line-content" },
+            lineTokens
+          )
+        )
+      : lineTokens,
+    react_1.default.createElement("br", null)
+  );
+}

package/lib/theme/ApiExplorer/ApiCodeBlock/WordWrapButton/_WordWrapButton.scss

@@ -0,0 +1,10 @@
+.openapi-explorer__code-block-word-wrap-btn-icon {
+  width: 1.2rem;
+  height: 1.2rem;
+}
+
+.openapi-explorer__code-block-word-wrap-btn--enabled {
+  .openapi-explorer__code-block-word-wrap-btn-icon {
+    color: var(--ifm-color-primary);
+  }
+}

package/lib/theme/ApiExplorer/ApiCodeBlock/WordWrapButton/index.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+export interface Props {
+    readonly className?: string;
+    readonly onClick: React.MouseEventHandler;
+    readonly isEnabled: boolean;
+}
+export default function WordWrapButton({ className, onClick, isEnabled, }: Props): React.JSX.Element | null;

package/lib/theme/ApiExplorer/ApiCodeBlock/WordWrapButton/index.js

@@ -0,0 +1,51 @@
+"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 = WordWrapButton;
+const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
+const clsx_1 = __importDefault(require("clsx"));
+function WordWrapButton({ className, onClick, isEnabled }) {
+  const title = (0, Translate_1.translate)({
+    id: "theme.CodeBlock.wordWrapToggle",
+    message: "Toggle word wrap",
+    description:
+      "The title attribute for toggle word wrapping button of code block lines",
+  });
+  return react_1.default.createElement(
+    "button",
+    {
+      type: "button",
+      onClick: onClick,
+      className: (0, clsx_1.default)(
+        "clean-btn",
+        className,
+        isEnabled && "openapi-explorer__code-block-word-wrap-btn--enabled"
+      ),
+      "aria-label": title,
+      title: title,
+    },
+    react_1.default.createElement(
+      "svg",
+      {
+        className: "openapi-explorer__code-block-word-wrap-btn-icon",
+        viewBox: "0 0 24 24",
+        "aria-hidden": "true",
+      },
+      react_1.default.createElement("path", {
+        fill: "currentColor",
+        d: "M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z",
+      })
+    )
+  );
+}

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

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

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

@@ -0,0 +1,110 @@
+"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 = ApiCodeBlock;
+const react_1 = __importStar(require("react"));
+const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
+const Element_1 = __importDefault(
+  require("@theme/ApiExplorer/ApiCodeBlock/Content/Element")
+);
+const String_1 = __importDefault(
+  require("@theme/ApiExplorer/ApiCodeBlock/Content/String")
+);
+/**
+ * Best attempt to make the children a plain string so it is copyable. If there
+ * are react elements, we will not be able to copy the content, and it will
+ * return `children` as-is; otherwise, it concatenates the string children
+ * together.
+ */
+function maybeStringifyChildren(children) {
+  if (
+    react_1.default.Children.toArray(children).some((el) =>
+      (0, react_1.isValidElement)(el)
+    )
+  ) {
+    return children;
+  }
+  // The children is now guaranteed to be one/more plain strings
+  return Array.isArray(children) ? children.join("") : children;
+}
+function ApiCodeBlock({ children: rawChildren, ...props }) {
+  // The Prism theme on SSR is always the default theme but the site theme can
+  // be in a different mode. React hydration doesn't update DOM styles that come
+  // from SSR. Hence force a re-render after mounting to apply the current
+  // relevant styles.
+  const isBrowser = (0, useIsBrowser_1.default)();
+  const children = maybeStringifyChildren(rawChildren);
+  const CodeBlockComp =
+    typeof children === "string" ? String_1.default : Element_1.default;
+  return react_1.default.createElement(
+    CodeBlockComp,
+    { key: String(isBrowser), ...props },
+    children
+  );
+}

package/lib/theme/ApiExplorer/Authorization/auth-types.d.ts

@@ -0,0 +1,3 @@
+export declare function getAuthDataKeys(security: {
+    [key: string]: any;
+}): string[];

package/lib/theme/ApiExplorer/Authorization/auth-types.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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAuthDataKeys = getAuthDataKeys;
+function getAuthDataKeys(security) {
+  // Bearer Auth
+  if (security.type === "http" && security.scheme === "bearer") {
+    return ["token"];
+  }
+  if (security.type === "oauth2") {
+    return ["token"];
+  }
+  // Basic Auth
+  if (security.type === "http" && security.scheme === "basic") {
+    return ["username", "password"];
+  }
+  // API Auth
+  if (security.type === "apiKey") {
+    return ["apiKey"];
+  }
+  // none
+  return [];
+}

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

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