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

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-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
+        className="openapi-demo__expand-modal-content"
+        overlayClassName="openapi-demo__expand-modal-overlay"
+        isOpen={modalIsOpen}
+        onRequestClose={closeModal}
+        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/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/Authorization/auth-types.d.ts

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

package/lib/theme/ApiDemoPanel/Authorization/auth-types.js

@@ -1,16 +1,12 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getAuthDataKeys = getAuthDataKeys;
 /* ============================================================================
  * 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 = void 0;
 function getAuthDataKeys(security) {
   // Bearer Auth
   if (security.type === "http" && security.scheme === "bearer") {
@@ -19,17 +15,15 @@ function getAuthDataKeys(security) {
   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 [];
-}
+}
+exports.getAuthDataKeys = getAuthDataKeys;

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

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

package/lib/theme/ApiDemoPanel/Authorization/index.js

@@ -1,107 +1,157 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _react = _interopRequireDefault(require("react"));
-var _FormItem = _interopRequireDefault(require("@theme/ApiDemoPanel/FormItem"));
-var _FormSelect = _interopRequireDefault(require("@theme/ApiDemoPanel/FormSelect"));
-var _FormTextInput = _interopRequireDefault(require("@theme/ApiDemoPanel/FormTextInput"));
-var _hooks = require("@theme/ApiItem/hooks");
-var _slice = require("./slice");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /* ============================================================================
  * 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/ApiDemoPanel/FormItem"));
+const FormSelect_1 = __importDefault(require("@theme/ApiDemoPanel/FormSelect"));
+const FormTextInput_1 = __importDefault(
+  require("@theme/ApiDemoPanel/FormTextInput")
+);
+const hooks_1 = require("@theme/ApiItem/hooks");
+const slice_1 = require("./slice");
 function Authorization() {
-  const data = (0, _hooks.useTypedSelector)(state => state.auth.data);
-  const options = (0, _hooks.useTypedSelector)(state => state.auth.options);
-  const selected = (0, _hooks.useTypedSelector)(state => state.auth.selected);
-  const dispatch = (0, _hooks.useTypedDispatch)();
+  const data = (0, hooks_1.useTypedSelector)((state) => state.auth.data);
+  const options = (0, hooks_1.useTypedSelector)((state) => state.auth.options);
+  const selected = (0, hooks_1.useTypedSelector)(
+    (state) => state.auth.selected
+  );
+  const dispatch = (0, hooks_1.useTypedDispatch)();
   if (selected === undefined) {
     return null;
   }
   const selectedAuth = options[selected];
   const optionKeys = Object.keys(options);
-  return <div>
-      {optionKeys.length > 1 && <_FormItem.default label="Security Scheme">
-          <_FormSelect.default options={optionKeys} value={selected} onChange={e => {
-        dispatch((0, _slice.setSelectedAuth)(e.target.value));
-      }} />
-        </_FormItem.default>}
-      {selectedAuth.map(a => {
+  return react_1.default.createElement(
+    "div",
+    null,
+    optionKeys.length > 1 &&
+      react_1.default.createElement(
+        FormItem_1.default,
+        { label: "Security Scheme" },
+        react_1.default.createElement(FormSelect_1.default, {
+          options: optionKeys,
+          value: selected,
+          onChange: (e) => {
+            dispatch((0, slice_1.setSelectedAuth)(e.target.value));
+          },
+        })
+      ),
+    selectedAuth.map((a) => {
       if (a.type === "http" && a.scheme === "bearer") {
-        var _data$a$key$token;
-        return <_FormItem.default label="Bearer Token" key={a.key + "-bearer"}>
-              <_FormTextInput.default placeholder="Bearer Token" value={(_data$a$key$token = data[a.key].token) !== null && _data$a$key$token !== void 0 ? _data$a$key$token : ""} onChange={e => {
-            const value = e.target.value;
-            dispatch((0, _slice.setAuthData)({
-              scheme: a.key,
-              key: "token",
-              value: value ? value : undefined
-            }));
-          }} />
-            </_FormItem.default>;
+        return react_1.default.createElement(
+          FormItem_1.default,
+          { label: "Bearer Token", key: a.key + "-bearer" },
+          react_1.default.createElement(FormTextInput_1.default, {
+            placeholder: "Bearer Token",
+            value: data[a.key].token ?? "",
+            onChange: (e) => {
+              const value = e.target.value;
+              dispatch(
+                (0, slice_1.setAuthData)({
+                  scheme: a.key,
+                  key: "token",
+                  value: value ? value : undefined,
+                })
+              );
+            },
+          })
+        );
       }
       if (a.type === "oauth2") {
-        var _data$a$key$token2;
-        return <_FormItem.default label="Bearer Token" key={a.key + "-oauth2"}>
-              <_FormTextInput.default placeholder="Bearer Token" value={(_data$a$key$token2 = data[a.key].token) !== null && _data$a$key$token2 !== void 0 ? _data$a$key$token2 : ""} onChange={e => {
-            const value = e.target.value;
-            dispatch((0, _slice.setAuthData)({
-              scheme: a.key,
-              key: "token",
-              value: value ? value : undefined
-            }));
-          }} />
-            </_FormItem.default>;
+        return react_1.default.createElement(
+          FormItem_1.default,
+          { label: "Bearer Token", key: a.key + "-oauth2" },
+          react_1.default.createElement(FormTextInput_1.default, {
+            placeholder: "Bearer Token",
+            value: data[a.key].token ?? "",
+            onChange: (e) => {
+              const value = e.target.value;
+              dispatch(
+                (0, slice_1.setAuthData)({
+                  scheme: a.key,
+                  key: "token",
+                  value: value ? value : undefined,
+                })
+              );
+            },
+          })
+        );
       }
       if (a.type === "http" && a.scheme === "basic") {
-        var _data$a$key$username, _data$a$key$password;
-        return <_react.default.Fragment key={a.key + "-basic"}>
-              <_FormItem.default label="Username">
-                <_FormTextInput.default placeholder="Username" value={(_data$a$key$username = data[a.key].username) !== null && _data$a$key$username !== void 0 ? _data$a$key$username : ""} onChange={e => {
-              const value = e.target.value;
-              dispatch((0, _slice.setAuthData)({
-                scheme: a.key,
-                key: "username",
-                value: value ? value : undefined
-              }));
-            }} />
-              </_FormItem.default>
-              <_FormItem.default label="Password">
-                <_FormTextInput.default placeholder="Password" password value={(_data$a$key$password = data[a.key].password) !== null && _data$a$key$password !== void 0 ? _data$a$key$password : ""} onChange={e => {
-              const value = e.target.value;
-              dispatch((0, _slice.setAuthData)({
-                scheme: a.key,
-                key: "password",
-                value: value ? value : undefined
-              }));
-            }} />
-              </_FormItem.default>
-            </_react.default.Fragment>;
+        return react_1.default.createElement(
+          react_1.default.Fragment,
+          { key: a.key + "-basic" },
+          react_1.default.createElement(
+            FormItem_1.default,
+            { label: "Username" },
+            react_1.default.createElement(FormTextInput_1.default, {
+              placeholder: "Username",
+              value: data[a.key].username ?? "",
+              onChange: (e) => {
+                const value = e.target.value;
+                dispatch(
+                  (0, slice_1.setAuthData)({
+                    scheme: a.key,
+                    key: "username",
+                    value: value ? value : undefined,
+                  })
+                );
+              },
+            })
+          ),
+          react_1.default.createElement(
+            FormItem_1.default,
+            { label: "Password" },
+            react_1.default.createElement(FormTextInput_1.default, {
+              placeholder: "Password",
+              password: true,
+              value: data[a.key].password ?? "",
+              onChange: (e) => {
+                const value = e.target.value;
+                dispatch(
+                  (0, slice_1.setAuthData)({
+                    scheme: a.key,
+                    key: "password",
+                    value: value ? value : undefined,
+                  })
+                );
+              },
+            })
+          )
+        );
       }
       if (a.type === "apiKey") {
-        var _data$a$key$apiKey;
-        return <_FormItem.default label={`${a.key}`} key={a.key + "-apikey"}>
-              <_FormTextInput.default placeholder={`${a.key}`} value={(_data$a$key$apiKey = data[a.key].apiKey) !== null && _data$a$key$apiKey !== void 0 ? _data$a$key$apiKey : ""} onChange={e => {
-            const value = e.target.value;
-            dispatch((0, _slice.setAuthData)({
-              scheme: a.key,
-              key: "apiKey",
-              value: value ? value : undefined
-            }));
-          }} />
-            </_FormItem.default>;
+        return react_1.default.createElement(
+          FormItem_1.default,
+          { label: `${a.key}`, key: a.key + "-apikey" },
+          react_1.default.createElement(FormTextInput_1.default, {
+            placeholder: `${a.key}`,
+            value: data[a.key].apiKey ?? "",
+            onChange: (e) => {
+              const value = e.target.value;
+              dispatch(
+                (0, slice_1.setAuthData)({
+                  scheme: a.key,
+                  key: "apiKey",
+                  value: value ? value : undefined,
+                })
+              );
+            },
+          })
+        );
       }
       return null;
-    })}
-    </div>;
+    })
+  );
 }
-var _default = Authorization;
-exports.default = _default;
+exports.default = Authorization;