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

package/lib/theme/SchemaTabs/_SchemaTabs.scss

@@ -5,30 +5,37 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+.openapi-tabs__schema-container {
+  margin-top: 1rem;
+}
+
 .openapi-tabs__schema-item {
   display: flex;
   align-items: center;
   justify-content: center;
-  height: 1.8rem;
+  padding: 0.35rem 0.7rem;
+  border: 1px solid transparent;
   margin-top: 0 !important;
   margin-right: 0.5rem;
-  border: 1px solid var(--ifm-color-primary);
-  border-radius: var(--ifm-global-radius);
-  color: var(--ifm-color-primary);
-  font-size: 12px;
-}
+  font-weight: var(--ifm-font-weight-bold);
+  font-family: var(--ifm-font-family-monospace);
+  font-size: 10px;
+  white-space: nowrap;
+  transition: 300ms;
 
-.openapi-tabs__schema-item:not(.active) {
-  opacity: 0.65;
-}
+  &:hover {
+    background-color: transparent;
+    border: 1px solid var(--ifm-toc-border-color);
+  }
 
-.openapi-tabs__schema-item:hover {
-  opacity: 1;
-  background-color: var(--ifm-color-emphasis-100);
-}
+  &.active {
+    border: 1px solid var(--ifm-color-primary);
+    color: var(--ifm-color-primary);
+  }
 
-.openapi-tabs__schema-item:last-child {
-  margin-right: 0 !important;
+  &:last-child {
+    margin-right: 0 !important;
+  }
 }
 
 .openapi-tabs__schema-list-container {
@@ -49,9 +56,8 @@
   white-space: nowrap;
 }
 
-.openapi-tabs__schema-container {
+.openapi-tabs__schema-tabs-container {
   width: 100%;
-  margin-top: 1rem;
   display: flex;
   align-items: center;
   overflow: hidden;

package/lib/theme/SchemaTabs/index.js

@@ -81,60 +81,56 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
   };
 
   return (
-    <div className="tabs__container">
-      <div className="openapi-tabs__schema-container">
-        {showTabArrows && (
-          <button
-            className="openapi-tabs__arrow left"
-            onClick={handleLeftClick}
-          />
-        )}
-        <ul
-          ref={tabItemListContainerRef}
-          role="tablist"
-          aria-orientation="horizontal"
-          className={clsx(
-            "openapi-tabs__schema-list-container",
-            "tabs",
-            {
-              "tabs--block": block,
-            },
-            className
-          )}
-        >
-          {tabValues.map(({ value, label, attributes }) => (
-            <li
-              // TODO extract TabListItem
-              role="tab"
-              tabIndex={selectedValue === value ? 0 : -1}
-              aria-selected={selectedValue === value}
-              key={value}
-              ref={(tabControl) => tabRefs.push(tabControl)}
-              onKeyDown={handleKeydown}
-              onClick={handleTabChange}
-              {...attributes}
-              className={clsx(
-                "tabs__item",
-                "openapi-tabs__schema-item",
-                attributes?.className,
-                {
-                  active: selectedValue === value,
-                }
-              )}
-            >
-              <span className="openapi-tabs__schema-label">
-                {label ?? value}
-              </span>
-            </li>
-          ))}
-        </ul>
-        {showTabArrows && (
-          <button
-            className="openapi-tabs__arrow right"
-            onClick={handleRightClick}
-          />
+    <div className="openapi-tabs__schema-tabs-container">
+      {showTabArrows && (
+        <button
+          className="openapi-tabs__arrow left"
+          onClick={handleLeftClick}
+        />
+      )}
+      <ul
+        ref={tabItemListContainerRef}
+        role="tablist"
+        aria-orientation="horizontal"
+        className={clsx(
+          "openapi-tabs__schema-list-container",
+          "tabs",
+          {
+            "tabs--block": block,
+          },
+          className
         )}
-      </div>
+      >
+        {tabValues.map(({ value, label, attributes }) => (
+          <li
+            // TODO extract TabListItem
+            role="tab"
+            tabIndex={selectedValue === value ? 0 : -1}
+            aria-selected={selectedValue === value}
+            key={value}
+            ref={(tabControl) => tabRefs.push(tabControl)}
+            onKeyDown={handleKeydown}
+            onClick={handleTabChange}
+            {...attributes}
+            className={clsx(
+              "tabs__item",
+              "openapi-tabs__schema-item",
+              attributes?.className,
+              {
+                active: selectedValue === value,
+              }
+            )}
+          >
+            <span className="openapi-tabs__schema-label">{label ?? value}</span>
+          </li>
+        ))}
+      </ul>
+      {showTabArrows && (
+        <button
+          className="openapi-tabs__arrow right"
+          onClick={handleRightClick}
+        />
+      )}
     </div>
   );
 }
@@ -167,7 +163,7 @@ function TabContent({ lazy, children, selectedValue }) {
 function TabsComponent(props) {
   const tabs = useTabs(props);
   return (
-    <div className="tabs-container">
+    <div className="openapi-tabs__schema-container">
       <TabList {...props} {...tabs} />
       <TabContent {...props} {...tabs} />
     </div>

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";
@@ -44,10 +54,37 @@
   --openapi-input-border: var(--ifm-color-primary);
   --openapi-input-background: var(--openapi-card-background-color);
   --openapi-tree-line-color: var(--ifm-toc-border-color);
+  --openapi-code-tab-border-color: var(--ifm-toc-border-color);
+  --openapi-code-tab-border-color-python: #ffdb50;
+  --openapi-code-tab-border-color-bash: var(--ifm-color-danger);
+  --openapi-code-tab-border-color-go: var(--ifm-color-info);
+  --openapi-code-tab-border-color-js: var(--ifm-color-warning);
+  --openapi-code-tab-border-color-ruby: var(--ifm-color-danger);
+  --openapi-code-tab-border-color-csharp: #9b4f96;
+  --openapi-code-tab-border-color-nodejs: var(--ifm-color-success);
+  --openapi-code-tab-border-color-php: #6181b6;
+  --openapi-code-tab-border-color-java: #0374bd;
+  --openapi-code-tab-border-color-powershell: #00adef;
+  --openapi-code-tab-shadow-color-python: rgba(255, 219, 80, 0.25);
+  --openapi-code-tab-shadow-color-bash: rgba(250, 56, 62, 0.25);
+  --openapi-code-tab-shadow-color-go: rgba(84, 199, 236, 0.25);
+  --openapi-code-tab-shadow-color-js: rgba(255, 186, 0, 0.25);
+  --openapi-code-tab-shadow-color-ruby: rgba(250, 56, 62, 0.25);
+  --openapi-code-tab-shadow-color-csharp: rgba(155, 79, 150, 0.25);
+  --opeanpi-code-tab-shadow-color-nodejs: rgba(0, 164, 0, 0.25);
+  --openapi-code-tab-shadow-color-php: rgba(97, 129, 182, 0.25);
+  --openapi-code-tab-shadow-color-java: rgba(3, 116, 189, 0.25);
+  --opeanpi-code-tab-shadow-color-powershell: rgba(3, 116, 189, 0.25);
+  --openapi-demo-font-size-input: 12px;
+  --openapi-demo-font-size-code: 12px;
+  --openapi-demo-padding-input: 0.5rem;
+  --openapi-demo-border-color: var(--ifm-toc-border-color);
+  --openapi-demo-caret-bg: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="16px" height="16px" viewBox="0 0 24 24"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path></svg>');
 }
 
 [data-theme="dark"] {
   --openapi-card-background-color: var(--ifm-color-gray-900) !important;
+  --openapi-demo-caret-bg: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="16px" height="16px" viewBox="0 0 24 24" fill="white"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path></svg>') !important;
 }
 
 .docs-wrapper {
@@ -114,10 +151,10 @@
 }
 
 .openapi__heading {
-  font-size: var(--ifm-h1-font-size);
+  font-size: 2rem;
+  margin-bottom: 0.5rem !important;
 }
 
-.openapi-demo__code-block code {
-  max-height: 500px;
-  overflow: auto;
+.openapi-left-panel__container {
+  border-right: thin solid var(--ifm-toc-border-color);
 }

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": "2.0.0-beta.2",
+  "version": "2.0.0-beta.3",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -24,46 +24,38 @@
   "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.3.0",
-    "@docusaurus/types": "^2.3.0",
-    "@types/concurrently": "^6.3.0",
+    "@docusaurus/types": ">=2.3.0 <2.5.0",
     "@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.3.0",
-    "@mdx-js/react": "^1.6.21",
+    "@docusaurus/theme-common": ">=2.3.0 <2.5.0",
+    "@hookform/error-message": "^2.0.1",
+    "@nextui-org/react": "^1.0.0-beta.12",
     "@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": "^2.0.0-beta.2",
+    "docusaurus-plugin-openapi-docs": "^2.0.0-beta.3",
     "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",
     "webpack": "^5.61.0",
@@ -76,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "ba8fd77e6b9e90e0bca5e169fbc1c71ac50f44e0"
+  "gitHead": "f02561b29cdee2dfa56ccf0ea1a63f9324d8044c"
 }

package/src/index.ts

@@ -16,12 +16,16 @@ export default function docusaurusThemeOpenAPI(): Plugin<void> {
     name: "docusaurus-theme-openapi",
 
     getClientModules() {
-      const modules = [require.resolve("./theme/styles.scss")];
+      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() {
@@ -29,47 +33,34 @@ export default function docusaurusThemeOpenAPI(): Plugin<void> {
     },
 
     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;
-      const isProd = process.env.NODE_ENV === "production";
+      // 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()],
-        module: {
-          rules: [
-            {
-              test: /\.s[ca]ss$/,
-              oneOf: [
-                {
-                  test: /\.module\.s[ca]ss$/,
-                  use: [
-                    ...getStyleLoaders(isServer, {
-                      modules: {
-                        localIdentName: isProd
-                          ? `[local]_[hash:base64:4]`
-                          : `[local]_[path][name]`,
-                        exportOnlyLocals: isServer,
-                      },
-                      importLoaders: 2,
-                      sourceMap: !isProd,
-                    }),
-                    {
-                      loader: require.resolve("sass-loader"),
-                      options: {},
-                    },
-                  ],
-                },
-                {
-                  use: [
-                    ...getStyleLoaders(isServer, {}),
-                    {
-                      loader: require.resolve("sass-loader"),
-                      options: {},
-                    },
-                  ],
-                },
-              ],
-            },
-          ],
-        },
       };
     },
   };

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

@@ -0,0 +1,7 @@
+.openapi-demo__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/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>
+  );
+}