docusaurus-theme-openapi-docs 0.0.0-619 → 0.0.0-685

package/lib/types.d.ts

@@ -0,0 +1,157 @@
+import type { FrontMatterTag } from "@docusaurus/utils";
+import type { JSONSchema4, JSONSchema6, JSONSchema7 } from "json-schema";
+export interface ThemeConfig {
+    api?: {
+        proxy?: string;
+        authPersistance?: false | "localStorage" | "sessionStorage";
+    };
+}
+interface Map<T> {
+    [key: string]: T;
+}
+export declare type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
+export declare type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
+    type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
+    allOf?: SchemaObject[];
+    oneOf?: SchemaObject[];
+    anyOf?: SchemaObject[];
+    not?: SchemaObject;
+    items?: SchemaObject;
+    properties?: Map<SchemaObject>;
+    additionalProperties?: boolean | SchemaObject;
+    nullable?: boolean;
+    discriminator?: DiscriminatorObject;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    xml?: XMLObject;
+    externalDocs?: ExternalDocumentationObject;
+    example?: any;
+    deprecated?: boolean;
+};
+export interface DiscriminatorObject {
+    propertyName: string;
+    mapping?: Map<string>;
+}
+export interface XMLObject {
+    name?: string;
+    namespace?: string;
+    prefix?: string;
+    attribute?: boolean;
+    wrapped?: boolean;
+}
+export interface ExternalDocumentationObject {
+    description?: string;
+    url: string;
+}
+export declare type FileChange = {
+    author?: string;
+    /** Date can be any
+     * [parsable date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).
+     */
+    date?: Date | string;
+};
+export declare type DocFrontMatter = {
+    /**
+     * The last part of the doc ID (will be refactored in the future to be the
+     * full ID instead)
+     * @see {@link DocMetadata.id}
+     */
+    id?: string;
+    /**
+     * Will override the default title collected from h1 heading.
+     * @see {@link DocMetadata.title}
+     */
+    title?: string;
+    /**
+     * Front matter tags, unnormalized.
+     * @see {@link DocMetadata.tags}
+     */
+    tags?: FrontMatterTag[];
+    /**
+     * If there isn't a Markdown h1 heading (which, if there is, we don't
+     * remove), this front matter will cause the front matter title to not be
+     * displayed in the doc page.
+     */
+    hide_title?: boolean;
+    /** Hide the TOC on the right. */
+    hide_table_of_contents?: boolean;
+    /** Used in the head meta. */
+    keywords?: string[];
+    /** Used in the head meta. Should use `assets.image` in priority. */
+    image?: string;
+    /**
+     * Will override the default excerpt.
+     * @see {@link DocMetadata.description}
+     */
+    description?: string;
+    /**
+     * Custom slug appended after /<baseUrl>/<routeBasePath>/<versionPath>
+     * @see {@link DocMetadata.slug}
+     */
+    slug?: string;
+    /** Customizes the sidebar label for this doc. Will default to its title. */
+    sidebar_label?: string;
+    /**
+     * Controls the position of a doc inside the generated sidebar slice when
+     * using autogenerated sidebar items.
+     *
+     * @see https://docusaurus.io/docs/sidebar#autogenerated-sidebar-metadata
+     */
+    sidebar_position?: number;
+    /**
+     * Gives the corresponding sidebar label a special class name when using
+     * autogenerated sidebars.
+     */
+    sidebar_class_name?: string;
+    /**
+     * Will be propagated to the final sidebars data structure. Useful if you
+     * have swizzled sidebar-related code or simply querying doc data through
+     * sidebars.
+     */
+    sidebar_custom_props?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Changes the sidebar association of the current doc. Use `null` to make
+     * the current doc not associated to any sidebar.
+     */
+    displayed_sidebar?: string | null;
+    /**
+     * Customizes the pagination label for this doc. Will default to the sidebar
+     * label.
+     */
+    pagination_label?: string;
+    /** Overrides the default URL computed for this doc. */
+    custom_edit_url?: string | null;
+    /**
+     * Whether number prefix parsing is disabled on this doc.
+     * @see https://docusaurus.io/docs/sidebar#using-number-prefixes
+     */
+    parse_number_prefixes?: boolean;
+    /**
+     * Minimum TOC heading level. Must be between 2 and 6 and lower or equal to
+     * the max value.
+     */
+    toc_min_heading_level?: number;
+    /** Maximum TOC heading level. Must be between 2 and 6. */
+    toc_max_heading_level?: number;
+    /**
+     * The ID of the documentation you want the "Next" pagination to link to.
+     * Use `null` to disable showing "Next" for this page.
+     * @see {@link DocMetadata.next}
+     */
+    pagination_next?: string | null;
+    /**
+     * The ID of the documentation you want the "Previous" pagination to link
+     * to. Use `null` to disable showing "Previous" for this page.
+     * @see {@link DocMetadata.prev}
+     */
+    pagination_prev?: string | null;
+    /** Should this doc be excluded from production builds? */
+    draft?: boolean;
+    /** Allows overriding the last updated author and/or date. */
+    last_update?: FileChange;
+    /** Provides OpenAPI Docs with a reference path to their respective Info Doc */
+    info_path?: string;
+};
+export {};

package/lib/types.js

@@ -1 +1,8 @@
-"use strict";
+"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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-619",
+  "version": "0.0.0-685",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -24,55 +24,49 @@
   "types": "src/theme-openapi.d.ts",
   "main": "lib/index.js",
   "scripts": {
-    "build": "tsc --noEmit && yarn babel:lib && yarn babel:lib-next && yarn format:lib-next",
-    "watch": "concurrently --names \"lib,lib-next,tsc\" --kill-others \"yarn babel:lib --watch\" \"yarn babel:lib-next --watch\" \"yarn tsc --watch\"",
-    "babel:lib": "cross-env BABEL_ENV=lib babel src -d lib --extensions \".tsx,.ts\" --ignore \"**/*.d.ts\" --copy-files",
-    "babel:lib-next": "cross-env BABEL_ENV=lib-next babel src -d lib-next --extensions \".tsx,.ts\" --ignore \"**/*.d.ts\" --copy-files",
-    "format:lib-next": "prettier --config ../../.prettierrc.json --write \"lib-next/**/*.{js,ts,jsx,tsc}\""
+    "build": "tsc --build && node ../../scripts/copyUntypedFiles.mjs && prettier --config ../../.prettierrc.json --write \"lib/theme/**/*.js\"",
+    "watch": "concurrently --names \"lib,lib-next,tsc\" --kill-others \"yarn babel:lib --watch\" \"yarn babel:lib-next --watch\" \"yarn tsc --watch\""
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": ">=2.0.1 <2.3.0",
-    "@docusaurus/types": ">=2.0.1 <2.3.0",
-    "@types/concurrently": "^6.3.0",
+    "@docusaurus/types": ">=2.4.1 <=2.4.3",
     "@types/crypto-js": "^4.1.0",
     "@types/file-saver": "^2.0.5",
-    "@types/fs-extra": "^9.0.13",
     "@types/lodash": "^4.14.176",
-    "@types/mdx-js__react": "^1.5.4",
-    "@types/rtlcss": "^3.1.1",
     "concurrently": "^5.2.0"
   },
   "dependencies": {
-    "@docusaurus/theme-common": ">=2.0.1 <2.3.0",
-    "@mdx-js/react": "^1.6.21",
+    "@docusaurus/theme-common": ">=2.4.1 <=2.4.3",
+    "@hookform/error-message": "^2.0.1",
     "@paloaltonetworks/postman-code-generators": "1.1.15-patch.2",
     "@paloaltonetworks/postman-collection": "^4.1.0",
     "@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-619",
+    "docusaurus-plugin-openapi-docs": "0.0.0-685",
+    "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",
-    "process": "^0.11.10",
-    "react-live": "^3.1.1",
+    "prism-react-renderer": "^1.3.5",
+    "react-hook-form": "^7.43.8",
+    "react-live": "^4.0.0",
     "react-magic-dropzone": "^1.0.1",
     "react-markdown": "^8.0.1",
     "react-modal": "^3.15.1",
     "react-redux": "^7.2.0",
-    "redux-devtools-extension": "^2.13.8",
     "rehype-raw": "^6.1.1",
+    "sass": "^1.58.1",
+    "sass-loader": "^13.3.2",
     "webpack": "^5.61.0",
     "xml-formatter": "^2.6.1"
   },
   "peerDependencies": {
-    "react": "^16.8.4 || ^17.0.0",
-    "react-dom": "^16.8.4 || ^17.0.0"
+    "react": "^16.8.4 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.8.4 || ^17.0.0 || ^18.0.0"
   },
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "1612ad3eee17e99fa5bad3bd2be5bf4cb079a5a2"
+  "gitHead": "be2a2cae3e2ce07d438c2159207caf2f87f2ba3c"
 }

package/src/index.ts

@@ -16,19 +16,49 @@ export default function docusaurusThemeOpenAPI(): Plugin<void> {
     name: "docusaurus-theme-openapi",
 
     getClientModules() {
-      const modules = [require.resolve("./theme/styles.css")];
+      const modules = [
+        require.resolve(
+          path.join(__dirname, "..", "lib", "theme", "styles.scss")
+        ),
+      ];
       return modules;
     },
 
     getThemePath() {
-      return path.join(__dirname, "..", "lib-next", "theme");
+      return path.join(__dirname, "..", "lib", "theme");
     },
 
     getTypeScriptThemePath() {
       return path.resolve(__dirname, "..", "src", "theme");
     },
 
-    configureWebpack() {
+    configureWebpack(_, isServer, utils) {
+      const rules: any = _.module?.rules ?? [];
+      const sassLoaderRule = rules.filter((r: any) => {
+        return String(r.test) === String(/\.s[ca]ss$/);
+      });
+      const { getStyleLoaders } = utils;
+      // Avoid conflicts with docusaurus-plugin-sass
+      if (sassLoaderRule.length === 0) {
+        return {
+          plugins: [new NodePolyfillPlugin()],
+          module: {
+            rules: [
+              {
+                test: /\.s[ac]ss$/,
+                include: path.resolve(__dirname, "..", "lib", "theme"),
+                use: [
+                  ...getStyleLoaders(isServer, {}),
+                  {
+                    loader: require.resolve("sass-loader"),
+                    options: {},
+                  },
+                ],
+              },
+            ],
+          },
+        };
+      }
       return {
         plugins: [new NodePolyfillPlugin()],
       };

package/src/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/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-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/src/theme/{ApiDemoPanel → ApiExplorer}/Accept/index.tsx

@@ -7,8 +7,8 @@
 
 import React from "react";
 
-import FormItem from "@theme/ApiDemoPanel/FormItem";
-import FormSelect from "@theme/ApiDemoPanel/FormSelect";
+import FormItem from "@theme/ApiExplorer/FormItem";
+import FormSelect from "@theme/ApiExplorer/FormSelect";
 import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
 
 import { setAccept } from "./slice";

package/src/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/src/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/src/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>
+  );
+}