docusaurus-theme-openapi-docs 2.0.0-beta.2 → 2.0.0-beta.4

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

@@ -0,0 +1,165 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+import React, { useEffect } from "react";
+
+import { usePrismTheme } from "@docusaurus/theme-common";
+import { translate } from "@docusaurus/Translate";
+import Container from "@theme/ApiDemoPanel/ApiCodeBlock/Container";
+import CopyButton from "@theme/ApiDemoPanel/ApiCodeBlock/CopyButton";
+import ExitButton from "@theme/ApiDemoPanel/ApiCodeBlock/ExitButton";
+import Line from "@theme/ApiDemoPanel/ApiCodeBlock/Line";
+import clsx from "clsx";
+import Highlight, { defaultProps } from "prism-react-renderer";
+import Modal from "react-modal";
+
+export default function ExpandButton({
+  code,
+  className,
+  language,
+  showLineNumbers,
+  blockClassName,
+  title,
+  lineClassNames,
+}) {
+  const prismTheme = usePrismTheme();
+
+  function openModal() {
+    setIsOpen(true);
+  }
+
+  function closeModal() {
+    setIsOpen(false);
+  }
+
+  const [modalIsOpen, setIsOpen] = React.useState(false);
+
+  useEffect(() => {
+    Modal.setAppElement("body");
+  });
+
+  return (
+    <>
+      <button
+        type="button"
+        aria-label={
+          modalIsOpen
+            ? translate({
+                id: "theme.CodeBlock.expanded",
+                message: "Expanded",
+                description: "The expanded button label on code blocks",
+              })
+            : translate({
+                id: "theme.CodeBlock.expandButtonAriaLabel",
+                message: "Expand code to fullscreen",
+                description: "The ARIA label for expand code blocks button",
+              })
+        }
+        title={translate({
+          id: "theme.CodeBlock.expand",
+          message: "Expand",
+          description: "The expand button label on code blocks",
+        })}
+        className={clsx(
+          "clean-btn",
+          className,
+          "openapi-explorer__code-block-expand-btn",
+          modalIsOpen && "openapi-explorer__code-block-expand-btn--copied"
+        )}
+        onClick={openModal}
+      >
+        <span
+          className="openapi-explorer__code-block-expand-btn-icons"
+          aria-hidden="true"
+        >
+          <svg
+            className="openapi-explorer__code-block-expand-btn-icon"
+            viewBox="0 0 448 512"
+          >
+            <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" />
+          </svg>
+          <svg
+            className="openapi-explorer__code-block-expand-btn-icon--success"
+            viewBox="0 0 24 24"
+          >
+            <path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z" />
+          </svg>
+        </span>
+      </button>
+      <Modal
+        className="openapi-explorer__expand-modal-content"
+        overlayClassName="openapi-explorer__expand-modal-overlay"
+        isOpen={modalIsOpen}
+        onRequestClose={closeModal}
+        contentLabel="Code Snippet"
+      >
+        <Container
+          as="div"
+          className={clsx(
+            "openapi-explorer__code-block-container",
+            language &&
+              !blockClassName.includes(`language-${language}`) &&
+              `language-${language}`
+          )}
+        >
+          {title && (
+            <div className="openapi-explorer__code-block-title">{title}</div>
+          )}
+          <div className="openapi-explorer__code-block-content">
+            <Highlight
+              {...defaultProps}
+              theme={prismTheme}
+              code={code}
+              language={language ?? "text"}
+            >
+              {({ className, tokens, getLineProps, getTokenProps }) => (
+                <pre
+                  /* eslint-disable-next-line jsx-a11y/no-noninteractive-tabindex */
+                  tabIndex={0}
+                  className={clsx(
+                    className,
+                    "openapi-explorer__code-block",
+                    "thin-scrollbar"
+                  )}
+                >
+                  <code
+                    className={clsx(
+                      "openapi-explorer__code-block-lines",
+                      showLineNumbers &&
+                        "openapi-explorer__code-block-lines-numbers"
+                    )}
+                  >
+                    {tokens.map((line, i) => (
+                      <Line
+                        key={i}
+                        line={line}
+                        getLineProps={getLineProps}
+                        getTokenProps={getTokenProps}
+                        classNames={lineClassNames[i]}
+                        showLineNumbers={showLineNumbers}
+                      />
+                    ))}
+                  </code>
+                </pre>
+              )}
+            </Highlight>
+            <div className="openapi-explorer__code-block-btn-group">
+              <CopyButton
+                className="openapi-explorer__code-block-code-btn"
+                code={code}
+              />
+              <ExitButton
+                className="openapi-dmeo__code-block-code-btn"
+                handler={closeModal}
+              />
+            </div>
+          </div>
+        </Container>
+      </Modal>
+    </>
+  );
+}

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

@@ -0,0 +1,46 @@
+/* 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);
+}
+
+.theme-code-block-highlighted-line {
+  background-color: var(--docusaurus-highlighted-code-line-bg);
+  display: block;
+  margin: 0 calc(-1 * var(--ifm-pre-padding));
+  padding: 0 var(--ifm-pre-padding);
+}
+
+.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;
+}
+
+:global(.theme-code-block-highlighted-line)
+  .openapi-explorer__code-block-code-line-number::before {
+  opacity: 0.8;
+}
+
+.openapi-explorer__code-block-code-line-number {
+  padding-right: var(--ifm-pre-padding);
+}

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

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare function Accept(): JSX.Element | null;
+export default Accept;

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

@@ -0,0 +1,38 @@
+"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 Accept() {
+  const value = (0, hooks_1.useTypedSelector)((state) => state.accept.value);
+  const options = (0, hooks_1.useTypedSelector)(
+    (state) => state.accept.options
+  );
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  if (options.length <= 1) {
+    return null;
+  }
+  return react_1.default.createElement(
+    FormItem_1.default,
+    { label: "Accept" },
+    react_1.default.createElement(FormSelect_1.default, {
+      value: value,
+      options: options,
+      onChange: (e) => dispatch((0, slice_1.setAccept)(e.target.value)),
+    })
+  );
+}
+exports.default = Accept;

package/lib/theme/ApiExplorer/Accept/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, {
+    setAccept: (state: import("immer/dist/internal").WritableDraft<State>, action: PayloadAction<string>) => void;
+}, "accept">;
+export declare const setAccept: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "accept/setAccept">;
+declare const _default: import("redux").Reducer<State, import("redux").AnyAction>;
+export default _default;

package/{lib-next/theme/ApiDemoPanel → lib/theme/ApiExplorer}/Accept/slice.js

@@ -1,13 +1,15 @@
+"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.
  * ========================================================================== */
-
-import { createSlice } from "@reduxjs/toolkit";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setAccept = exports.slice = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
 const initialState = {};
-export const slice = createSlice({
+exports.slice = (0, toolkit_1.createSlice)({
   name: "accept",
   initialState,
   reducers: {
@@ -16,5 +18,5 @@ export const slice = createSlice({
     },
   },
 });
-export const { setAccept } = slice.actions;
-export default slice.reducer;
+exports.setAccept = exports.slice.actions.setAccept;
+exports.default = exports.slice.reducer;

package/lib/theme/ApiExplorer/ApiCodeBlock/Container/_Container.scss

@@ -0,0 +1,7 @@
+.openapi-explorer__code-block-container {
+  height: 100%;
+  background: var(--prism-background-color);
+  color: var(--prism-color);
+  margin-bottom: unset;
+  box-shadow: var(--ifm-global-shadow-lw);
+}

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

@@ -0,0 +1,29 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+import React from "react";
+
+import { ThemeClassNames, usePrismTheme } from "@docusaurus/theme-common";
+import { getPrismCssVariables } from "@docusaurus/theme-common/internal";
+import clsx from "clsx";
+
+export default function CodeBlockContainer({ as: As, ...props }) {
+  const prismTheme = usePrismTheme();
+  const prismCssVariables = getPrismCssVariables(prismTheme);
+  return (
+    <As
+      // Polymorphic components are hard to type, without `oneOf` generics
+      {...props}
+      style={prismCssVariables}
+      className={clsx(
+        "openapi-explorer__code-block-container",
+        props.className,
+        ThemeClassNames.common.codeBlock
+      )}
+    />
+  );
+}

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

@@ -0,0 +1,30 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+import React from "react";
+
+import Container from "@theme/ApiExplorer/ApiCodeBlock/Container";
+import clsx from "clsx";
+
+// <pre> tags in markdown map to CodeBlocks. They may contain JSX children. When
+// the children is not a simple string, we just return a styled block without
+// actually highlighting.
+export default function CodeBlockJSX({ children, className }) {
+  return (
+    <Container
+      as="pre"
+      tabIndex={0}
+      className={clsx(
+        "openapi-explorer__code-block-standalone",
+        "thin-scrollbar",
+        className
+      )}
+    >
+      <code className="openapi-explorer__code-block-lines">{children}</code>
+    </Container>
+  );
+}

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

@@ -0,0 +1,134 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+import React from "react";
+
+import { useThemeConfig, usePrismTheme } from "@docusaurus/theme-common";
+import {
+  parseCodeBlockTitle,
+  parseLanguage,
+  parseLines,
+  containsLineNumbers,
+  useCodeWordWrap,
+} from "@docusaurus/theme-common/internal";
+import Container from "@theme/ApiExplorer/ApiCodeBlock/Container";
+import CopyButton from "@theme/ApiExplorer/ApiCodeBlock/CopyButton";
+import ExpandButton from "@theme/ApiExplorer/ApiCodeBlock/ExpandButton";
+import Line from "@theme/ApiExplorer/ApiCodeBlock/Line";
+import WordWrapButton from "@theme/ApiExplorer/ApiCodeBlock/WordWrapButton";
+import clsx from "clsx";
+import Highlight, { defaultProps } from "prism-react-renderer";
+
+export default function CodeBlockString({
+  children,
+  className: blockClassName = "",
+  metastring,
+  title: titleProp,
+  showLineNumbers: showLineNumbersProp,
+  language: languageProp,
+}) {
+  const {
+    prism: { defaultLanguage, magicComments },
+  } = useThemeConfig();
+  const language =
+    languageProp ?? parseLanguage(blockClassName) ?? defaultLanguage;
+  const prismTheme = usePrismTheme();
+  const wordWrap = 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 = parseCodeBlockTitle(metastring) || titleProp;
+  const { lineClassNames, code } = parseLines(children, {
+    metastring,
+    language,
+    magicComments,
+  });
+  const showLineNumbers =
+    showLineNumbersProp ?? containsLineNumbers(metastring);
+
+  return (
+    <Container
+      as="div"
+      className={clsx(
+        blockClassName,
+        language &&
+          !blockClassName.includes(`language-${language}`) &&
+          `language-${language}`
+      )}
+    >
+      {title && (
+        <div className="openapi-explorer__code-block-title">{title}</div>
+      )}
+      <div className="openapi-explorer__code-block-content">
+        <Highlight
+          {...defaultProps}
+          theme={prismTheme}
+          code={code}
+          language={language ?? "text"}
+        >
+          {({ className, tokens, getLineProps, getTokenProps }) => (
+            <pre
+              /* eslint-disable-next-line jsx-a11y/no-noninteractive-tabindex */
+              tabIndex={0}
+              ref={wordWrap.codeBlockRef}
+              className={clsx(
+                className,
+                "openapi-explorer__code-block",
+                "thin-scrollbar"
+              )}
+            >
+              <code
+                className={clsx(
+                  "openapi-explorer__code-block-lines",
+                  showLineNumbers &&
+                    "openapi-explorer__code-block-lines-numbering"
+                )}
+              >
+                {tokens.map((line, i) => (
+                  <Line
+                    key={i}
+                    line={line}
+                    getLineProps={getLineProps}
+                    getTokenProps={getTokenProps}
+                    classNames={lineClassNames[i]}
+                    showLineNumbers={showLineNumbers}
+                  />
+                ))}
+              </code>
+            </pre>
+          )}
+        </Highlight>
+        <div className="openapi-explorer__code-block-btn-group">
+          {(wordWrap.isEnabled || wordWrap.isCodeScrollable) && (
+            <WordWrapButton
+              className="openapi-explorer__code-block-code-btn"
+              onClick={() => wordWrap.toggle()}
+              isEnabled={wordWrap.isEnabled}
+            />
+          )}
+          <CopyButton
+            className="openapi-explorer__code-block-code-btn"
+            code={code}
+          />
+          <ExpandButton
+            className={clsx(
+              "openapi-explorer__code-block-code-btn",
+              "openapi-explorer__expand-btn"
+            )}
+            code={code}
+            language={language}
+            showLineNumbers={showLineNumbers}
+            blockClassName={blockClassName}
+            title={title}
+            lineClassNames={lineClassNames}
+            wordWrap={wordWrap}
+          />
+        </div>
+      </div>
+    </Container>
+  );
+}

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;
+  }
+}