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

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-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/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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/lib/theme/ApiDemoPanel/Curl/index.js

@@ -63,12 +63,14 @@ const useDocusaurusContext_1 = __importDefault(
 const postman_code_generators_1 = __importDefault(
   require("@paloaltonetworks/postman-code-generators")
 );
+const ApiCodeBlock_1 = __importDefault(
+  require("@theme/ApiDemoPanel/ApiCodeBlock")
+);
 const buildPostmanRequest_1 = __importDefault(
   require("@theme/ApiDemoPanel/buildPostmanRequest")
 );
 const CodeTabs_1 = __importDefault(require("@theme/ApiDemoPanel/CodeTabs"));
 const hooks_1 = require("@theme/ApiItem/hooks");
-const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
 const merge_1 = __importDefault(require("lodash/merge"));
 exports.languageSet = [
   {
@@ -319,11 +321,12 @@ function Curl({ postman, codeSamples }) {
             },
           },
           react_1.default.createElement(
-            CodeBlock_1.default,
+            ApiCodeBlock_1.default,
             {
               language: lang.highlight,
               className: "openapi-demo__code-block",
               title: `${lang.language} / ${lang.variant}`,
+              showLineNumbers: true,
             },
             codeText
           )

package/lib/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/lib/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/lib/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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-beta.644",
+  "version": "0.0.0-beta.645",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -47,13 +47,15 @@
     "@reduxjs/toolkit": "^1.7.1",
     "buffer": "^6.0.3",
     "clsx": "^1.1.1",
+    "copy-text-to-clipboard": "^3.1.0",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi-docs": "0.0.0-beta.644",
+    "docusaurus-plugin-openapi-docs": "0.0.0-beta.645",
     "docusaurus-plugin-sass": "^0.2.3",
     "file-saver": "^2.0.5",
     "immer": "^9.0.7",
     "lodash": "^4.17.20",
     "node-polyfill-webpack-plugin": "^2.0.1",
+    "prism-react-renderer": "^1.3.5",
     "process": "^0.11.10",
     "react-live": "^3.1.1",
     "react-magic-dropzone": "^1.0.1",
@@ -73,5 +75,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "82e67409b8afa0f1d4deaeb77b87b0b5b67e6a9c"
+  "gitHead": "66986dbe5010aa8fec65f1425a82ab3ac9357a7d"
 }

package/src/theme/ApiDemoPanel/ApiCodeBlock/Container/_Container.scss

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

package/src/theme/ApiDemoPanel/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-demo__code-block-container",
+        props.className,
+        ThemeClassNames.common.codeBlock
+      )}
+    />
+  );
+}

package/src/theme/ApiDemoPanel/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/ApiDemoPanel/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-demo__code-block-standalone",
+        "thin-scrollbar",
+        className
+      )}
+    >
+      <code className="openapi-demo__code-block-lines">{children}</code>
+    </Container>
+  );
+}

package/src/theme/ApiDemoPanel/ApiCodeBlock/Content/String.js

@@ -0,0 +1,131 @@
+/* ============================================================================
+ * 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/ApiDemoPanel/ApiCodeBlock/Container";
+import CopyButton from "@theme/ApiDemoPanel/ApiCodeBlock/CopyButton";
+import ExpandButton from "@theme/ApiDemoPanel/ApiCodeBlock/ExpandButton";
+import Line from "@theme/ApiDemoPanel/ApiCodeBlock/Line";
+import WordWrapButton from "@theme/ApiDemoPanel/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-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}
+              ref={wordWrap.codeBlockRef}
+              className={clsx(
+                className,
+                "openapi-demo__code-block",
+                "thin-scrollbar"
+              )}
+            >
+              <code
+                className={clsx(
+                  "openapi-demo__code-block-lines",
+                  showLineNumbers && "openapi-demo__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-demo__code-block-btn-group">
+          {(wordWrap.isEnabled || wordWrap.isCodeScrollable) && (
+            <WordWrapButton
+              className="openapi-demo__code-block-code-btn"
+              onClick={() => wordWrap.toggle()}
+              isEnabled={wordWrap.isEnabled}
+            />
+          )}
+          <CopyButton
+            className="openapi-demo__code-block-code-btn"
+            code={code}
+          />
+          <ExpandButton
+            className={clsx(
+              "openapi-demo__code-block-code-btn",
+              "openapi-demo__expand-btn"
+            )}
+            code={code}
+            language={language}
+            showLineNumbers={showLineNumbers}
+            blockClassName={blockClassName}
+            title={title}
+            lineClassNames={lineClassNames}
+            wordWrap={wordWrap}
+          />
+        </div>
+      </div>
+    </Container>
+  );
+}

package/src/theme/ApiDemoPanel/ApiCodeBlock/Content/_Content.scss

@@ -0,0 +1,88 @@
+.openapi-demo__code-block-content {
+  position: relative;
+  /* rtl:ignore */
+  direction: ltr;
+  border-radius: inherit;
+}
+
+.openapi-demo__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-demo__code-block {
+  --ifm-pre-background: var(--prism-background-color);
+  margin: 0;
+  padding: 0;
+}
+
+.openapi-demo__code-block-title
+  + .openapi-demo__code-block-content
+  .openapi-demo__code-block {
+  border-top-left-radius: 0;
+  border-top-right-radius: 0;
+}
+
+.openapi-demo__code-block-standalone {
+  padding: 0;
+}
+
+.openapi-demo__code-block-lines {
+  font: inherit;
+  /* rtl:ignore */
+  float: left;
+  min-width: 100%;
+  padding: var(--ifm-pre-padding);
+}
+
+.openapi-demo__code-block-lines-numbering {
+  // This causes max-height to unset
+  // display: table;
+  padding: var(--ifm-pre-padding) 0;
+}
+
+@media print {
+  .openapi-demo__code-block-lines {
+    white-space: pre-wrap;
+  }
+}
+
+.openapi-demo__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-demo__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-demo__code-block-btn-group button:focus-visible,
+.openapi-demo__code-block-btn-group button:hover {
+  opacity: 1 !important;
+}
+
+.theme-code-block:hover .openapi-demo__code-block-btn-group button {
+  opacity: 0.4;
+}
+
+@media screen and (max-width: 996px) {
+  .openapi-demo__expand-btn {
+    display: none !important;
+  }
+}

package/src/theme/ApiDemoPanel/ApiCodeBlock/CopyButton/_CopyButton.scss

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