docusaurus-theme-openapi-docs 0.0.0-beta.644 → 0.0.0-beta.645

package/src/theme/ApiDemoPanel/ApiCodeBlock/CopyButton/index.js

@@ -0,0 +1,74 @@
+/* ============================================================================
+ * 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, { useCallback, useState, useRef, useEffect } from "react";
+
+import { translate } from "@docusaurus/Translate";
+import clsx from "clsx";
+// @ts-expect-error: TODO, we need to make theme-classic have type: module
+import copy from "copy-text-to-clipboard";
+
+export default function CopyButton({ code, className }) {
+  const [isCopied, setIsCopied] = useState(false);
+  const copyTimeout = useRef(undefined);
+  const handleCopyCode = useCallback(() => {
+    copy(code);
+    setIsCopied(true);
+    copyTimeout.current = window.setTimeout(() => {
+      setIsCopied(false);
+    }, 1000);
+  }, [code]);
+  useEffect(() => () => window.clearTimeout(copyTimeout.current), []);
+  return (
+    <button
+      type="button"
+      aria-label={
+        isCopied
+          ? translate({
+              id: "theme.CodeBlock.copied",
+              message: "Copied",
+              description: "The copied button label on code blocks",
+            })
+          : translate({
+              id: "theme.CodeBlock.copyButtonAriaLabel",
+              message: "Copy code to clipboard",
+              description: "The ARIA label for copy code blocks button",
+            })
+      }
+      title={translate({
+        id: "theme.CodeBlock.copy",
+        message: "Copy",
+        description: "The copy button label on code blocks",
+      })}
+      className={clsx(
+        "clean-btn",
+        className,
+        "openapi-demo__code-block-copy-btn",
+        isCopied && "openapi-demo__code-block-copy-btn--copied"
+      )}
+      onClick={handleCopyCode}
+    >
+      <span
+        className="openapi-demo__code-block-copy-btn-icons"
+        aria-hidden="true"
+      >
+        <svg
+          className="openapi-demo__code-block-copy-btn-icon"
+          viewBox="0 0 24 24"
+        >
+          <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" />
+        </svg>
+        <svg
+          className="openapi-demo__code-block-copy-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>
+  );
+}

package/src/theme/ApiDemoPanel/ApiCodeBlock/ExitButton/_ExitButton.scss

@@ -0,0 +1,16 @@
+.openapi-demo__code-block-exit-btn-icons {
+  position: relative;
+  width: 1.125rem;
+  height: 1.125rem;
+}
+
+.openapi-demo__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/src/theme/ApiDemoPanel/ApiCodeBlock/ExitButton/index.js

@@ -0,0 +1,47 @@
+/* ============================================================================
+ * 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 { translate } from "@docusaurus/Translate";
+import clsx from "clsx";
+
+export default function ExitButton({ className, handler }) {
+  return (
+    <button
+      type="button"
+      aria-label={translate({
+        id: "theme.CodeBlock.exitButtonAriaLabel",
+        message: "Exit expanded view",
+        description: "The ARIA label for exit expanded view button",
+      })}
+      title={translate({
+        id: "theme.CodeBlock.copy",
+        message: "Copy",
+        description: "The exit button label on code blocks",
+      })}
+      className={clsx(
+        "clean-btn",
+        "openapi-demo__code-block-exit-btn",
+        className
+      )}
+      onClick={handler}
+    >
+      <span
+        className="openapi-demo__code-block-exit-btn-icons"
+        aria-hidden="true"
+      >
+        <svg
+          className="openapi-demo__code-block-exit-btn-icon"
+          viewBox="0 0 384 512"
+        >
+          <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" />
+        </svg>
+      </span>
+    </button>
+  );
+}

package/src/theme/ApiDemoPanel/ApiCodeBlock/ExpandButton/_ExpandButton.scss

@@ -0,0 +1,42 @@
+.theme-code-block:hover .openapi-demo__code-block-expand-btn--copied {
+  opacity: 1 !important;
+}
+
+.openapi-demo__code-block-expand-btn-icons {
+  position: relative;
+  width: 1.125rem;
+  height: 1.125rem;
+}
+
+.openapi-demo__code-block-expand-btn-icon,
+.openapi-demo__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-demo__code-block-expand-btn-icon--success {
+  top: 50%;
+  left: 50%;
+  transform: translate(-50%, -50%) scale(0.33);
+  opacity: 0;
+  color: #00d600;
+}
+
+.openapi-demo__code-block-expand-btn--copied
+  .openapi-demo__code-block-expand-btn-icon {
+  transform: scale(0.33);
+  opacity: 0;
+}
+
+.openapi-demo__code-block-expand-btn--copied
+  .openapi-demo__code-block-expand-btn-icon--success {
+  transform: translate(-50%, -50%) scale(1);
+  opacity: 1;
+  transition-delay: 0.075s;
+}

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

@@ -0,0 +1,180 @@
+/* ============================================================================
+ * 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);
+
+  const customStyles = {
+    overlay: { backgroundColor: "rgba(0, 0, 0, 0.9)", zIndex: "201" },
+    content: {
+      top: "50%",
+      left: "50%",
+      right: "auto",
+      bottom: "auto",
+      padding: "none",
+      border: "thin solid var(--ifm-toc-border-color)",
+      borderRadius: "var(--ifm-global-radius)",
+      transform: "translate(-50%, -50%)",
+      maxWidth: "95%",
+      width: "min-content",
+      overflow: "auto",
+    },
+  };
+  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-demo__code-block-expand-btn",
+          modalIsOpen && "openapi-demo__code-block-expand-btn--copied"
+        )}
+        onClick={openModal}
+      >
+        <span
+          className="openapi-demo__code-block-expand-btn-icons"
+          aria-hidden="true"
+        >
+          <svg
+            className="openapi-demo__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-demo__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
+        isOpen={modalIsOpen}
+        onRequestClose={closeModal}
+        style={customStyles}
+        contentLabel="Code Snippet"
+      >
+        <Container
+          as="div"
+          className={clsx(
+            "openapi-demo__code-block-container",
+            language &&
+              !blockClassName.includes(`language-${language}`) &&
+              `language-${language}`
+          )}
+        >
+          {title && (
+            <div className="openapi-demo__code-block-title">{title}</div>
+          )}
+          <div className="openapi-demo__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-demo__code-block",
+                    "thin-scrollbar"
+                  )}
+                >
+                  <code
+                    className={clsx(
+                      "openapi-demo__code-block-lines",
+                      showLineNumbers &&
+                        "openapi-demo__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-demo__code-block-btn-group">
+              <CopyButton
+                className="openapi-demo__code-block-code-btn"
+                code={code}
+              />
+              <ExitButton
+                className="openapi-dmeo__code-block-code-btn"
+                handler={closeModal}
+              />
+            </div>
+          </div>
+        </Container>
+      </Modal>
+    </>
+  );
+}

package/src/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-demo__code-block-code-line {
+  display: table-row;
+  counter-increment: line-count;
+}
+
+.openapi-demo__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-demo__code-block-code-line-number::before {
+  content: counter(line-count);
+  opacity: 0.4;
+}
+
+:global(.theme-code-block-highlighted-line)
+  .openapi-demo__code-block-code-line-number::before {
+  opacity: 0.8;
+}
+
+.openapi-demo__code-block-code-line-number {
+  padding-right: var(--ifm-pre-padding);
+}

package/src/theme/ApiDemoPanel/ApiCodeBlock/Line/index.js

@@ -0,0 +1,47 @@
+/* ============================================================================
+ * 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 clsx from "clsx";
+
+export default function CodeBlockLine({
+  line,
+  classNames,
+  showLineNumbers,
+  getLineProps,
+  getTokenProps,
+}) {
+  if (line.length === 1 && line[0].content === "\n") {
+    line[0].content = "";
+  }
+  const lineProps = getLineProps({
+    line,
+    className: clsx(
+      classNames,
+      showLineNumbers && "openapi-demo__code-block-code-line"
+    ),
+  });
+  const lineTokens = line.map((token, key) => (
+    <span key={key} {...getTokenProps({ token, key })} />
+  ));
+  return (
+    <span {...lineProps}>
+      {showLineNumbers ? (
+        <>
+          <span className="openapi-demo__code-block-code-line-number" />
+          <span className="openapi-demo__code-block-code-line-content">
+            {lineTokens}
+          </span>
+        </>
+      ) : (
+        lineTokens
+      )}
+      <br />
+    </span>
+  );
+}

package/src/theme/ApiDemoPanel/ApiCodeBlock/WordWrapButton/_WordWrapButton.scss

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

package/src/theme/ApiDemoPanel/ApiCodeBlock/WordWrapButton/index.js

@@ -0,0 +1,44 @@
+/* ============================================================================
+ * 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 { translate } from "@docusaurus/Translate";
+import clsx from "clsx";
+
+export default function WordWrapButton({ className, onClick, isEnabled }) {
+  const title = translate({
+    id: "theme.CodeBlock.wordWrapToggle",
+    message: "Toggle word wrap",
+    description:
+      "The title attribute for toggle word wrapping button of code block lines",
+  });
+  return (
+    <button
+      type="button"
+      onClick={onClick}
+      className={clsx(
+        "clean-btn",
+        className,
+        isEnabled && "openapi-demo__code-block-word-wrap-btn--enabled"
+      )}
+      aria-label={title}
+      title={title}
+    >
+      <svg
+        className="openapi-demo__code-block-word-wrap-btn-icon"
+        viewBox="0 0 24 24"
+        aria-hidden="true"
+      >
+        <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"
+        />
+      </svg>
+    </button>
+  );
+}

package/src/theme/ApiDemoPanel/ApiCodeBlock/index.js

@@ -0,0 +1,40 @@
+/* ============================================================================
+ * 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, { isValidElement } from "react";
+
+import useIsBrowser from "@docusaurus/useIsBrowser";
+import ElementContent from "@theme/ApiDemoPanel/ApiCodeBlock/Content/Element";
+import StringContent from "@theme/ApiDemoPanel/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.Children.toArray(children).some((el) => isValidElement(el))) {
+    return children;
+  }
+  // The children is now guaranteed to be one/more plain strings
+  return Array.isArray(children) ? children.join("") : children;
+}
+export default 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 = useIsBrowser();
+  const children = maybeStringifyChildren(rawChildren);
+  const CodeBlockComp =
+    typeof children === "string" ? StringContent : ElementContent;
+  return (
+    <CodeBlockComp key={String(isBrowser)} {...props}>
+      {children}
+    </CodeBlockComp>
+  );
+}

package/src/theme/ApiDemoPanel/CodeTabs/_CodeTabs.scss

@@ -10,6 +10,10 @@
   --bash-border-radius: 20px;
 }
 
+.openapi-tabs__code-container {
+  margin-bottom: 1rem;
+}
+
 .openapi-tabs__code-list-container {
   display: flex;
   justify-content: flex-start;
@@ -21,7 +25,13 @@
 }
 
 .openapi-demo__code-block code {
-  max-height: 500px;
+  max-height: 200px;
+}
+
+body[class="ReactModal__Body--open"] {
+  .openapi-demo__code-block code {
+    max-height: 600px;
+  }
 }
 
 .openapi-tabs__code-item {
@@ -215,3 +225,11 @@
     justify-content: space-around;
   }
 }
+
+.ReactModal__Body--open {
+  overflow: hidden !important;
+}
+
+.openapi-modal--open {
+  background-color: rgba(0, 0, 0, 0.7) !important;
+}

package/src/theme/ApiDemoPanel/CodeTabs/index.js

@@ -136,7 +136,7 @@ function TabContent({ lazy, children, selectedValue }) {
 function TabsComponent(props) {
   const tabs = useTabs(props);
   return (
-    <div className="tabs-container">
+    <div className="tabs-container openapi-tabs__code-container">
       <TabList {...props} {...tabs} />
       <TabContent {...props} {...tabs} />
     </div>

package/src/theme/ApiDemoPanel/Curl/index.tsx

@@ -10,10 +10,10 @@ import React, { useState, useEffect } from "react";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import codegen from "@paloaltonetworks/postman-code-generators";
 import sdk from "@paloaltonetworks/postman-collection";
+import ApiCodeBlock from "@theme/ApiDemoPanel/ApiCodeBlock";
 import buildPostmanRequest from "@theme/ApiDemoPanel/buildPostmanRequest";
 import CodeTabs from "@theme/ApiDemoPanel/CodeTabs";
 import { useTypedSelector } from "@theme/ApiItem/hooks";
-import CodeBlock from "@theme/CodeBlock";
 import merge from "lodash/merge";
 
 export interface Language {
@@ -285,13 +285,15 @@ function Curl({ postman, codeSamples }: Props) {
                 className: `openapi-tabs__code-item--${lang.logoClass}`,
               }}
             >
-              <CodeBlock
+              {/* @ts-ignore */}
+              <ApiCodeBlock
                 language={lang.highlight}
                 className="openapi-demo__code-block"
                 title={`${lang.language} / ${lang.variant}`}
+                showLineNumbers={true}
               >
                 {codeText}
-              </CodeBlock>
+              </ApiCodeBlock>
             </CodeTab>
           );
         })}

package/src/theme/ParamsItem/index.js

@@ -123,7 +123,7 @@ function ParamsItem({
       <span className="openapi-schema__container">
         <strong>{name}</strong>
         {renderSchemaName}
-        {required && <span class="openapi-schema__divider"></span>}
+        {required && <span className="openapi-schema__divider"></span>}
         {renderSchemaRequired}
       </span>
       {renderSchema}

package/src/theme/SchemaItem/index.js

@@ -101,7 +101,7 @@ function SchemaItem({
         </strong>
         <span className="openapi-schema__name"> {schemaName}</span>
         {(nullable || required || deprecated) && (
-          <span class="openapi-schema__divider"></span>
+          <span className="openapi-schema__divider"></span>
         )}
         {renderNullable}
         {!deprecated && renderRequired}

package/src/theme/styles.scss

@@ -18,6 +18,16 @@
 @use "./ApiDemoPanel/Request/Request";
 @use "./ApiDemoPanel/Response/Response";
 @use "./ApiDemoPanel/Server/Server";
+
+/* Api Demo Panel / ApiCodeBlock */
+@use "./ApiDemoPanel/ApiCodeBlock/Container/Container";
+@use "./ApiDemoPanel/ApiCodeBlock/Content/Content";
+@use "./ApiDemoPanel/ApiCodeBlock/CopyButton/CopyButton";
+@use "./ApiDemoPanel/ApiCodeBlock/ExitButton/ExitButton";
+@use "./ApiDemoPanel/ApiCodeBlock/ExpandButton/ExpandButton";
+@use "./ApiDemoPanel/ApiCodeBlock/Line/Line";
+@use "./ApiDemoPanel/ApiCodeBlock/WordWrapButton/WordWrapButton";
+
 /* Schema Styling */
 @use "./ParamsItem/ParamsItem";
 @use "./SchemaItem/SchemaItem";

package/src/theme-openapi.d.ts

@@ -225,6 +225,10 @@ declare module "@theme/ApiDemoPanel/Server" {
   export default function Server(): JSX.Element;
 }
 
+declare module "@theme/ApiDemoPanel/ApiCodeBlock" {
+  export default function ApiCodeBlock(): JSX.Element;
+}
+
 declare module "@theme/ApiDemoPanel/Server/slice" {
   export default server as Reducer<State, AnyAction>;
 }