docusaurus-theme-openapi-docs 0.0.0-1000

package/lib/theme/ApiExplorer/ApiCodeBlock/Content/String.js

@@ -0,0 +1,153 @@
+"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 = CodeBlockString;
+const react_1 = __importDefault(require("react"));
+const theme_common_1 = require("@docusaurus/theme-common");
+const internal_1 = require("@docusaurus/theme-common/internal");
+const Container_1 = __importDefault(
+  require("@theme/ApiExplorer/ApiCodeBlock/Container")
+);
+const CopyButton_1 = __importDefault(
+  require("@theme/ApiExplorer/ApiCodeBlock/CopyButton")
+);
+const ExpandButton_1 = __importDefault(
+  require("@theme/ApiExplorer/ApiCodeBlock/ExpandButton")
+);
+const Line_1 = __importDefault(require("@theme/ApiExplorer/ApiCodeBlock/Line"));
+const WordWrapButton_1 = __importDefault(
+  require("@theme/ApiExplorer/ApiCodeBlock/WordWrapButton")
+);
+const clsx_1 = __importDefault(require("clsx"));
+const prism_react_renderer_1 = require("prism-react-renderer");
+function CodeBlockString({
+  children,
+  className: blockClassName = "",
+  metastring,
+  title: titleProp,
+  showLineNumbers: showLineNumbersProp,
+  language: languageProp,
+}) {
+  const {
+    prism: { defaultLanguage, magicComments },
+  } = (0, theme_common_1.useThemeConfig)();
+  const language =
+    languageProp ??
+    (0, internal_1.parseLanguage)(blockClassName) ??
+    defaultLanguage;
+  const prismTheme = (0, theme_common_1.usePrismTheme)();
+  const wordWrap = (0, internal_1.useCodeWordWrap)();
+  // We still parse the metastring in case we want to support more syntax in the
+  // future. Note that MDX doesn't strip quotes when parsing metastring:
+  // "title=\"xyz\"" => title: "\"xyz\""
+  const title = (0, internal_1.parseCodeBlockTitle)(metastring) || titleProp;
+  const { lineClassNames, code } = (0, internal_1.parseLines)(children, {
+    metastring,
+    language,
+    magicComments,
+  });
+  const showLineNumbers =
+    showLineNumbersProp ?? (0, internal_1.containsLineNumbers)(metastring);
+  return react_1.default.createElement(
+    Container_1.default,
+    {
+      as: "div",
+      className: (0, clsx_1.default)(
+        blockClassName,
+        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,
+              ref: wordWrap.codeBlockRef,
+              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-numbering"
+                ),
+              },
+              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" },
+        (wordWrap.isEnabled || wordWrap.isCodeScrollable) &&
+          react_1.default.createElement(WordWrapButton_1.default, {
+            className: "openapi-explorer__code-block-code-btn",
+            onClick: () => wordWrap.toggle(),
+            isEnabled: wordWrap.isEnabled,
+          }),
+        react_1.default.createElement(CopyButton_1.default, {
+          className: "openapi-explorer__code-block-code-btn",
+          code: code,
+        }),
+        react_1.default.createElement(ExpandButton_1.default, {
+          className: (0, clsx_1.default)(
+            "openapi-explorer__code-block-code-btn",
+            "openapi-explorer__expand-btn"
+          ),
+          code: code,
+          language: language ?? "text",
+          showLineNumbers: showLineNumbers,
+          blockClassName: blockClassName,
+          title: title,
+          lineClassNames: lineClassNames,
+        })
+      )
+    )
+  );
+}

package/lib/theme/ApiExplorer/ApiCodeBlock/Content/_Content.scss

@@ -0,0 +1,91 @@
+.openapi-explorer__code-block-content {
+  height: 100%;
+  position: relative;
+  /* rtl:ignore */
+  direction: ltr;
+  border-radius: inherit;
+}
+
+.openapi-explorer__code-block-title {
+  border-bottom: 1px solid var(--ifm-color-emphasis-300);
+  font-size: var(--ifm-code-font-size);
+  font-weight: 500;
+  padding: 0.75rem var(--ifm-pre-padding);
+  border-top-left-radius: inherit;
+  border-top-right-radius: inherit;
+}
+
+.openapi-explorer__code-block {
+  height: 100%;
+  border-radius: var(--ifm-global-radius);
+  --ifm-pre-background: var(--prism-background-color);
+  margin: 0;
+  padding: 0;
+}
+
+.openapi-explorer__code-block-title
+  + .openapi-explorer__code-block-content
+  .openapi-explorer__code-block {
+  border-top-left-radius: 0;
+  border-top-right-radius: 0;
+}
+
+.openapi-explorer__code-block-standalone {
+  padding: 0;
+}
+
+.openapi-explorer__code-block-lines {
+  font: inherit;
+  /* rtl:ignore */
+  float: left;
+  min-width: 100%;
+  padding: var(--ifm-pre-padding);
+}
+
+.openapi-explorer__code-block-lines-numbering {
+  // This causes max-height to unset
+  // display: table;
+  padding: var(--ifm-pre-padding) 0;
+}
+
+@media print {
+  .openapi-explorer__code-block-lines {
+    white-space: pre-wrap;
+  }
+}
+
+.openapi-explorer__code-block-btn-group {
+  display: flex;
+  column-gap: 0.2rem;
+  position: absolute;
+  right: calc(var(--ifm-pre-padding) / 2);
+  top: calc(var(--ifm-pre-padding) / 2);
+}
+
+.openapi-explorer__code-block-btn-group button {
+  display: flex;
+  align-items: center;
+  background: var(--prism-background-color);
+  color: var(--prism-color);
+  border: 1px solid var(--ifm-color-emphasis-300);
+  border-radius: var(--ifm-global-radius);
+  padding: 0.4rem;
+  line-height: 0;
+  transition: opacity 200ms ease-in-out;
+  opacity: 0;
+}
+
+.openapi-explorer__code-block-btn-group button:focus-visible,
+.openapi-explorer__code-block-btn-group button:hover {
+  opacity: 1 !important;
+}
+
+.theme-code-block:hover .openapi-explorer__code-block-btn-group button {
+  opacity: 0.4;
+}
+
+@media screen and (max-width: 996px) {
+  .openapi-explorer__expand-btn {
+    display: none !important;
+  }
+}

package/lib/theme/ApiExplorer/ApiCodeBlock/CopyButton/_CopyButton.scss

@@ -0,0 +1,44 @@
+.theme-code-block:hover {
+  .openapi-explorer__code-block-copy-btn--copied {
+    opacity: 1 !important;
+  }
+}
+
+.openapi-explorer__code-block-copy-btn-icons {
+  position: relative;
+  width: 1.125rem;
+  height: 1.125rem;
+}
+
+.openapi-explorer__code-block-copy-btn-icon,
+.openapi-explorer__code-block-copy-btn-icon--success {
+  position: absolute;
+  top: 0;
+  left: 0;
+  fill: currentColor;
+  opacity: inherit;
+  width: inherit;
+  height: inherit;
+  transition: all 0.15s ease;
+}
+
+.openapi-explorer__code-block-copy-btn-icon--success {
+  top: 50%;
+  left: 50%;
+  transform: translate(-50%, -50%) scale(0.33);
+  opacity: 0;
+  color: #00d600;
+}
+
+.openapi-explorer__code-block-copy-btn--copied {
+  .openapi-explorer__code-block-copy-btn-icon {
+    transform: scale(0.33);
+    opacity: 0;
+  }
+
+  .openapi-explorer__code-block-copy-btn-icon--success {
+    transform: translate(-50%, -50%) scale(1);
+    opacity: 1;
+    transition-delay: 0.075s;
+  }
+}

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

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

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

@@ -0,0 +1,147 @@
+"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 = CopyButton;
+const react_1 = __importStar(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
+const clsx_1 = __importDefault(require("clsx"));
+const copy_text_to_clipboard_1 = __importDefault(
+  require("copy-text-to-clipboard")
+);
+function CopyButton({ code, className }) {
+  const [isCopied, setIsCopied] = (0, react_1.useState)(false);
+  const copyTimeout = (0, react_1.useRef)(undefined);
+  const handleCopyCode = (0, react_1.useCallback)(() => {
+    (0, copy_text_to_clipboard_1.default)(code);
+    setIsCopied(true);
+    copyTimeout.current = window.setTimeout(() => {
+      setIsCopied(false);
+    }, 1000);
+  }, [code]);
+  (0, react_1.useEffect)(
+    () => () => window.clearTimeout(copyTimeout.current),
+    []
+  );
+  return react_1.default.createElement(
+    "button",
+    {
+      type: "button",
+      "aria-label": isCopied
+        ? (0, Translate_1.translate)({
+            id: "theme.CodeBlock.copied",
+            message: "Copied",
+            description: "The copied button label on code blocks",
+          })
+        : (0, Translate_1.translate)({
+            id: "theme.CodeBlock.copyButtonAriaLabel",
+            message: "Copy code to clipboard",
+            description: "The ARIA label for copy code blocks button",
+          }),
+      title: (0, Translate_1.translate)({
+        id: "theme.CodeBlock.copy",
+        message: "Copy",
+        description: "The copy button label on code blocks",
+      }),
+      className: (0, clsx_1.default)(
+        "clean-btn",
+        className,
+        "openapi-explorer__code-block-copy-btn",
+        isCopied && "openapi-explorer__code-block-copy-btn--copied"
+      ),
+      onClick: handleCopyCode,
+    },
+    react_1.default.createElement(
+      "span",
+      {
+        className: "openapi-explorer__code-block-copy-btn-icons",
+        "aria-hidden": "true",
+      },
+      react_1.default.createElement(
+        "svg",
+        {
+          className: "openapi-explorer__code-block-copy-btn-icon",
+          viewBox: "0 0 24 24",
+        },
+        react_1.default.createElement("path", {
+          d: "M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z",
+        })
+      ),
+      react_1.default.createElement(
+        "svg",
+        {
+          className: "openapi-explorer__code-block-copy-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",
+        })
+      )
+    )
+  );
+}

package/lib/theme/ApiExplorer/ApiCodeBlock/ExitButton/_ExitButton.scss

@@ -0,0 +1,16 @@
+.openapi-explorer__code-block-exit-btn-icons {
+  position: relative;
+  width: 1.125rem;
+  height: 1.125rem;
+}
+
+.openapi-explorer__code-block-exit-btn-icon {
+  position: absolute;
+  top: 0;
+  left: 0;
+  fill: currentColor;
+  opacity: inherit;
+  width: inherit;
+  height: inherit;
+  transition: all 0.15s ease;
+}

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

@@ -0,0 +1,6 @@
+import React from "react";
+export interface Props {
+    readonly className: string;
+    readonly handler: () => void;
+}
+export default function ExitButton({ className, handler, }: Props): React.JSX.Element;

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

@@ -0,0 +1,58 @@
+"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 = ExitButton;
+const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
+const clsx_1 = __importDefault(require("clsx"));
+function ExitButton({ className, handler }) {
+  return react_1.default.createElement(
+    "button",
+    {
+      type: "button",
+      "aria-label": (0, Translate_1.translate)({
+        id: "theme.CodeBlock.exitButtonAriaLabel",
+        message: "Exit expanded view",
+        description: "The ARIA label for exit expanded view button",
+      }),
+      title: (0, Translate_1.translate)({
+        id: "theme.CodeBlock.copy",
+        message: "Copy",
+        description: "The exit button label on code blocks",
+      }),
+      className: (0, clsx_1.default)(
+        "clean-btn",
+        "openapi-explorer__code-block-exit-btn",
+        className
+      ),
+      onClick: handler,
+    },
+    react_1.default.createElement(
+      "span",
+      {
+        className: "openapi-explorer__code-block-exit-btn-icons",
+        "aria-hidden": "true",
+      },
+      react_1.default.createElement(
+        "svg",
+        {
+          className: "openapi-explorer__code-block-exit-btn-icon",
+          viewBox: "0 0 384 512",
+        },
+        react_1.default.createElement("path", {
+          d: "M342.6 150.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0L192 210.7 86.6 105.4c-12.5-12.5-32.8-12.5-45.3 0s-12.5 32.8 0 45.3L146.7 256 41.4 361.4c-12.5 12.5-12.5 32.8 0 45.3s32.8 12.5 45.3 0L192 301.3 297.4 406.6c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L237.3 256 342.6 150.6z",
+        })
+      )
+    )
+  );
+}

package/lib/theme/ApiExplorer/ApiCodeBlock/ExpandButton/_ExpandButton.scss

@@ -0,0 +1,62 @@
+.openapi-explorer__expand-modal-content {
+  padding: none;
+  border: thin solid var(--ifm-toc-border-color);
+  border-radius: var(--ifm-global-radius);
+  max-width: 95%;
+  width: 65vw;
+  height: 65vh;
+  overflow: auto;
+}
+
+.openapi-explorer__expand-modal-overlay {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  position: fixed;
+  inset: 0px;
+  background-color: rgba(0, 0, 0, 0.9);
+  z-index: 201;
+}
+
+.theme-code-block:hover .openapi-explorer__code-block-expand-btn--copied {
+  opacity: 1 !important;
+}
+
+.openapi-explorer__code-block-expand-btn-icons {
+  position: relative;
+  width: 1.125rem;
+  height: 1.125rem;
+}
+
+.openapi-explorer__code-block-expand-btn-icon,
+.openapi-explorer__code-block-expand-btn-icon--success {
+  position: absolute;
+  top: 0;
+  left: 0;
+  fill: currentColor;
+  opacity: inherit;
+  width: inherit;
+  height: inherit;
+  transition: all 0.15s ease;
+}
+
+.openapi-explorer__code-block-expand-btn-icon--success {
+  top: 50%;
+  left: 50%;
+  transform: translate(-50%, -50%) scale(0.33);
+  opacity: 0;
+  color: #00d600;
+}
+
+.openapi-explorer__code-block-expand-btn--copied
+  .openapi-explorer__code-block-expand-btn-icon {
+  transform: scale(0.33);
+  opacity: 0;
+}
+
+.openapi-explorer__code-block-expand-btn--copied
+  .openapi-explorer__code-block-expand-btn-icon--success {
+  transform: translate(-50%, -50%) scale(1);
+  opacity: 1;
+  transition-delay: 0.075s;
+}

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

@@ -0,0 +1,14 @@
+import React from "react";
+import { Language } from "prism-react-renderer";
+export interface Props {
+    readonly code: string;
+    readonly className: string;
+    readonly language: Language;
+    readonly showLineNumbers: boolean;
+    readonly blockClassName: string;
+    readonly title: string | undefined;
+    readonly lineClassNames: {
+        [lineIndex: number]: string[];
+    };
+}
+export default function ExpandButton({ code, className, language, showLineNumbers, blockClassName, title, lineClassNames, }: Props): React.JSX.Element;