docusaurus-theme-openapi-docs 3.0.0-beta.1 → 3.0.0-beta.10

package/lib/theme/SchemaTabs/index.js

@@ -1,24 +1,69 @@
+"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.
  * ========================================================================== */
-
-import React, { cloneElement, useRef, useEffect, useState } from "react";
-
-import {
-  useScrollPositionBlocker,
-  useTabs,
-} from "@docusaurus/theme-common/internal";
-import useIsBrowser from "@docusaurus/useIsBrowser";
-import clsx from "clsx";
-import flatten from "lodash/flatten";
-
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __setModuleDefault =
+  (this && this.__setModuleDefault) ||
+  (Object.create
+    ? function (o, v) {
+        Object.defineProperty(o, "default", { enumerable: true, value: v });
+      }
+    : function (o, v) {
+        o["default"] = v;
+      });
+var __importStar =
+  (this && this.__importStar) ||
+  function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null)
+      for (var k in mod)
+        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
+          __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+  };
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importStar(require("react"));
+const internal_1 = require("@docusaurus/theme-common/internal");
+const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
+const clsx_1 = __importDefault(require("clsx"));
+const flatten_1 = __importDefault(require("lodash/flatten"));
 function TabList({ className, block, selectedValue, selectValue, tabValues }) {
   const tabRefs = [];
-  const { blockElementScrollPositionUntilNextRender } =
-    useScrollPositionBlocker();
+  const { blockElementScrollPositionUntilNextRender } = (0,
+  internal_1.useScrollPositionBlocker)();
   const handleTabChange = (event) => {
     const newTab = event.currentTarget;
     const newTabIndex = tabRefs.indexOf(newTab);
@@ -50,133 +95,141 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
     }
     focusElement?.focus();
   };
-
-  const tabItemListContainerRef = useRef(null);
-  const [showTabArrows, setShowTabArrows] = useState(false);
-
-  useEffect(() => {
+  const tabItemListContainerRef = (0, react_1.useRef)(null);
+  const [showTabArrows, setShowTabArrows] = (0, react_1.useState)(false);
+  (0, react_1.useEffect)(() => {
     const resizeObserver = new ResizeObserver((entries) => {
       for (let entry of entries) {
-        if (entry.target.offsetWidth < entry.target.scrollWidth) {
-          setShowTabArrows(true);
-        } else {
-          setShowTabArrows(false);
-        }
+        requestAnimationFrame(() => {
+          if (entry.target.clientWidth < entry.target.scrollWidth) {
+            setShowTabArrows(true);
+          } else {
+            setShowTabArrows(false);
+          }
+        });
       }
     });
-
     resizeObserver.observe(tabItemListContainerRef.current);
-
     return () => {
       resizeObserver.disconnect();
     };
   }, []);
-
   const handleRightClick = () => {
     tabItemListContainerRef.current.scrollLeft += 90;
   };
-
   const handleLeftClick = () => {
     tabItemListContainerRef.current.scrollLeft -= 90;
   };
-
-  return (
-    <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(
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-tabs__schema-tabs-container" },
+    showTabArrows &&
+      react_1.default.createElement("button", {
+        className: "openapi-tabs__arrow left",
+        onClick: handleLeftClick,
+      }),
+    react_1.default.createElement(
+      "ul",
+      {
+        ref: tabItemListContainerRef,
+        role: "tablist",
+        "aria-orientation": "horizontal",
+        className: (0, clsx_1.default)(
           "openapi-tabs__schema-list-container",
           "tabs",
           {
             "tabs--block": block,
           },
           className
-        )}
-      >
-        {tabValues.map(({ value, label, attributes }) => (
-          <li
+        ),
+      },
+      tabValues.map(({ value, label, attributes }) =>
+        react_1.default.createElement(
+          "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(
+            role: "tab",
+            tabIndex: selectedValue === value ? 0 : -1,
+            "aria-selected": selectedValue === value,
+            key: value,
+            ref: (tabControl) => tabRefs.push(tabControl),
+            onKeyDown: handleKeydown,
+            onClick: handleTabChange,
+            ...attributes,
+            className: (0, clsx_1.default)(
               "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>
+            ),
+          },
+          react_1.default.createElement(
+            "span",
+            { className: "openapi-tabs__schema-label" },
+            label ?? value
+          )
+        )
+      )
+    ),
+    showTabArrows &&
+      react_1.default.createElement("button", {
+        className: "openapi-tabs__arrow right",
+        onClick: handleRightClick,
+      })
   );
 }
 function TabContent({ lazy, children, selectedValue }) {
-  // eslint-disable-next-line no-param-reassign
-  children = Array.isArray(children) ? children : [children];
-  const flattenedChildren = flatten(children);
-
+  const childTabs = (Array.isArray(children) ? children : [children]).filter(
+    Boolean
+  );
+  const flattenedChildTabs = (0, flatten_1.default)(childTabs);
   if (lazy) {
-    const selectedTabItem = flattenedChildren.find(
+    const selectedTabItem = flattenedChildTabs.find(
       (tabItem) => tabItem.props.value === selectedValue
     );
     if (!selectedTabItem) {
       // fail-safe or fail-fast? not sure what's best here
       return null;
     }
-    return cloneElement(selectedTabItem, { className: "margin-top--md" });
+    return (0, react_1.cloneElement)(selectedTabItem, {
+      className: "margin-top--md",
+    });
   }
-  return (
-    <div className="margin-top--md">
-      {children.map((tabItem, i) =>
-        cloneElement(tabItem, {
-          key: i,
-          hidden: tabItem.props.value !== selectedValue,
-        })
-      )}
-    </div>
+  return react_1.default.createElement(
+    "div",
+    { className: "margin-top--md" },
+    childTabs.map((tabItem, i) =>
+      (0, react_1.cloneElement)(tabItem, {
+        key: i,
+        hidden: tabItem.props.value !== selectedValue,
+      })
+    )
   );
 }
 function TabsComponent(props) {
-  const tabs = useTabs(props);
-  return (
-    <div className="openapi-tabs__schema-container">
-      <TabList {...props} {...tabs} />
-      <TabContent {...props} {...tabs} />
-    </div>
+  const tabs = (0, internal_1.useTabs)(props);
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-tabs__schema-container" },
+    react_1.default.createElement(TabList, { ...props, ...tabs }),
+    react_1.default.createElement(TabContent, { ...props, ...tabs })
   );
 }
-export default function SchemaTabs(props) {
-  const isBrowser = useIsBrowser();
-  return (
-    <TabsComponent
+function SchemaTabs(props) {
+  const isBrowser = (0, useIsBrowser_1.default)();
+  return react_1.default.createElement(
+    TabsComponent,
+    // Remount tabs after hydration
+    // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
+    {
       // Remount tabs after hydration
       // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
-      key={String(isBrowser)}
-      {...props}
-    />
+      key: String(isBrowser),
+      ...props,
+    },
+    (0, internal_1.sanitizeTabsChildren)(props.children)
   );
 }
+exports.default = SchemaTabs;

package/lib/theme/styles.scss

@@ -36,6 +36,7 @@
 @use "./DiscriminatorTabs/DiscriminatorTabs";
 @use "./MimeTabs/MimeTabs";
 @use "./SchemaTabs/SchemaTabs";
+@use "./OperationTabs/OperationTabs";
 /* Code Samples */
 @use "./ResponseSamples/ResponseSamples";
 /* Markdown Styling */
@@ -158,3 +159,7 @@
 .openapi-left-panel__container {
   border-right: thin solid var(--ifm-toc-border-color);
 }
+
+.openapi-tabs__heading {
+  margin-bottom: 1rem;
+}

package/lib/types.d.ts

@@ -9,8 +9,8 @@ export interface ThemeConfig {
 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"> & {
+export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
+export type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
     type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
     allOf?: SchemaObject[];
     oneOf?: SchemaObject[];
@@ -43,14 +43,14 @@ export interface ExternalDocumentationObject {
     description?: string;
     url: string;
 }
-export declare type FileChange = {
+export 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 = {
+export type DocFrontMatter = {
     /**
      * The last part of the doc ID (will be refactored in the future to be the
      * full ID instead)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.10",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -28,14 +28,15 @@
     "watch": "concurrently --names \"lib,lib-next,tsc\" --kill-others \"yarn babel:lib --watch\" \"yarn babel:lib-next --watch\" \"yarn tsc --watch\""
   },
   "devDependencies": {
-    "@docusaurus/types": "^3.0.0",
+    "@docusaurus/types": "^3.0.1",
     "@types/crypto-js": "^4.1.0",
     "@types/file-saver": "^2.0.5",
     "@types/lodash": "^4.14.176",
-    "concurrently": "^5.2.0"
+    "concurrently": "^5.2.0",
+    "eslint-plugin-prettier": "^5.0.1"
   },
   "dependencies": {
-    "@docusaurus/theme-common": "^3.0.0",
+    "@docusaurus/theme-common": "^3.0.1",
     "@hookform/error-message": "^2.0.1",
     "@paloaltonetworks/postman-code-generators": "1.1.15-patch.2",
     "@paloaltonetworks/postman-collection": "^4.1.0",
@@ -43,12 +44,12 @@
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.1.0",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi-docs": "^3.0.0-beta.1",
+    "docusaurus-plugin-openapi-docs": "^3.0.0-beta.10",
     "docusaurus-plugin-sass": "^0.2.3",
     "file-saver": "^2.0.5",
     "lodash": "^4.17.20",
     "node-polyfill-webpack-plugin": "^2.0.1",
-    "prism-react-renderer": "^2.1.0",
+    "prism-react-renderer": "^2.3.0",
     "react-hook-form": "^7.43.8",
     "react-live": "^4.0.0",
     "react-magic-dropzone": "^1.0.1",
@@ -68,5 +69,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "9641610aae936a5d9193f43068a2fdd337da0416"
+  "gitHead": "82d70be14358052625d00e637b1eeba52a14b706"
 }

package/src/markdown/utils.test.ts

@@ -0,0 +1,49 @@
+/* ============================================================================
+ * 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 { guard } from "./utils";
+
+describe("guard", () => {
+  it("should guard empty strings", () => {
+    const actual = guard("", (_) => {
+      throw new Error("Should not be called");
+    });
+    expect(actual).toBe("");
+  });
+
+  it("should guard undefined", () => {
+    const actual = guard(undefined, (value) => {
+      throw new Error("Should not be called");
+    });
+    expect(actual).toBe("");
+  });
+
+  it("should guard false booleans", () => {
+    const actual = guard(false, (value) => `${value}`);
+    expect(actual).toBe("");
+  });
+
+  it("should not guard strings", () => {
+    const actual = guard("hello", (value) => value);
+    expect(actual).toBe("hello");
+  });
+
+  it("should not guard numbers", () => {
+    const actual = guard(1, (value) => `${value}`);
+    expect(actual).toBe("1");
+  });
+
+  it("should not guard numbers equals to 0", () => {
+    const actual = guard(0, (value) => `${value}`);
+    expect(actual).toBe("0");
+  });
+
+  it("should not guard true booleans", () => {
+    const actual = guard(true, (value) => `${value}`);
+    expect(actual).toBe("true");
+  });
+});

package/src/markdown/utils.ts

@@ -5,7 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-export type Children = string | undefined | (string | undefined)[];
+import { ReactNode } from "react";
+
+export type Children = ReactNode | string | undefined | (string | undefined)[];
 
 export type Props = Record<string, any> & { children?: Children };
 
@@ -24,7 +26,7 @@ export function guard<T>(
   value: T | undefined | string,
   cb: (value: T) => Children
 ): string {
-  if (!!value) {
+  if (!!value || value === 0) {
     const children = cb(value as T);
     return render(children);
   }
@@ -35,7 +37,7 @@ export function render(children: Children): string {
   if (Array.isArray(children)) {
     return children.filter((c) => c !== undefined).join("");
   }
-  return children ?? "";
+  return (children as string) ?? "";
 }
 
 export function toString(value: any): string | undefined {

package/src/theme/ApiDemoPanel/ApiCodeBlock/ExpandButton/{index.js → index.tsx}

@@ -9,14 +9,28 @@ 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";
+// @ts-ignore
+import Container from "@theme/ApiExplorer/ApiCodeBlock/Container";
+// @ts-ignore
+import CopyButton from "@theme/ApiExplorer/ApiCodeBlock/CopyButton";
+// @ts-ignore
+import ExitButton from "@theme/ApiExplorer/ApiCodeBlock/ExitButton";
+// @ts-ignore
+import Line from "@theme/ApiExplorer/ApiCodeBlock/Line";
 import clsx from "clsx";
-import Highlight, { defaultProps } from "prism-react-renderer";
+import { Highlight, type Language } from "prism-react-renderer";
 import Modal from "react-modal";
 
+interface Props {
+  code: string;
+  className: string;
+  language: Language;
+  showLineNumbers: boolean;
+  blockClassName: string;
+  title: string;
+  lineClassNames: string[];
+}
+
 export default function ExpandButton({
   code,
   className,
@@ -25,7 +39,7 @@ export default function ExpandButton({
   blockClassName,
   title,
   lineClassNames,
-}) {
+}: Props): React.JSX.Element {
   const prismTheme = usePrismTheme();
 
   function openModal() {
@@ -111,7 +125,6 @@ export default function ExpandButton({
           )}
           <div className="openapi-explorer__code-block-content">
             <Highlight
-              {...defaultProps}
               theme={prismTheme}
               code={code}
               language={language ?? "text"}
@@ -139,7 +152,7 @@ export default function ExpandButton({
                         line={line}
                         getLineProps={getLineProps}
                         getTokenProps={getTokenProps}
-                        classNames={lineClassNames[i]}
+                        classNames={lineClassNames}
                         showLineNumbers={showLineNumbers}
                       />
                     ))}

package/src/theme/ApiExplorer/ApiCodeBlock/Container/{index.js → index.tsx}

@@ -5,19 +5,22 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React from "react";
+import React, { ComponentProps } 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 }) {
+export default function CodeBlockContainer<T extends "div" | "pre">({
+  as: As,
+  ...props
+}: { as: T } & ComponentProps<T>): React.JSX.Element {
   const prismTheme = usePrismTheme();
   const prismCssVariables = getPrismCssVariables(prismTheme);
   return (
     <As
       // Polymorphic components are hard to type, without `oneOf` generics
-      {...props}
+      {...(props as any)}
       style={prismCssVariables}
       className={clsx(
         "openapi-explorer__code-block-container",

package/src/theme/ApiExplorer/ApiCodeBlock/Content/{Element.js → Element.tsx}

@@ -8,12 +8,16 @@
 import React from "react";
 
 import Container from "@theme/ApiExplorer/ApiCodeBlock/Container";
+import type { Props } from "@theme/CodeBlock/Content/Element";
 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 }) {
+export default function CodeBlockJSX({
+  children,
+  className,
+}: Props): React.JSX.Element {
   return (
     <Container
       as="pre"

package/src/theme/ApiExplorer/ApiCodeBlock/Content/{String.js → String.tsx}

@@ -20,8 +20,9 @@ import CopyButton from "@theme/ApiExplorer/ApiCodeBlock/CopyButton";
 import ExpandButton from "@theme/ApiExplorer/ApiCodeBlock/ExpandButton";
 import Line from "@theme/ApiExplorer/ApiCodeBlock/Line";
 import WordWrapButton from "@theme/ApiExplorer/ApiCodeBlock/WordWrapButton";
+import type { Props } from "@theme/CodeBlock/Content/String";
 import clsx from "clsx";
-import { Highlight } from "prism-react-renderer";
+import { Highlight, Language } from "prism-react-renderer";
 
 export default function CodeBlockString({
   children,
@@ -30,7 +31,7 @@ export default function CodeBlockString({
   title: titleProp,
   showLineNumbers: showLineNumbersProp,
   language: languageProp,
-}) {
+}: Props): React.JSX.Element {
   const {
     prism: { defaultLanguage, magicComments },
   } = useThemeConfig();
@@ -120,12 +121,11 @@ export default function CodeBlockString({
               "openapi-explorer__expand-btn"
             )}
             code={code}
-            language={language}
+            language={(language ?? "text") as Language}
             showLineNumbers={showLineNumbers}
             blockClassName={blockClassName}
             title={title}
             lineClassNames={lineClassNames}
-            wordWrap={wordWrap}
           />
         </div>
       </div>

package/src/theme/ApiExplorer/ApiCodeBlock/CopyButton/{index.js → index.tsx}

@@ -7,14 +7,17 @@
 
 import React, { useCallback, useState, useRef, useEffect } from "react";
 
+import { CopyButtonProps } from "@docusaurus/theme-common/internal";
 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 }) {
+export default function CopyButton({
+  code,
+  className,
+}: CopyButtonProps): React.JSX.Element {
   const [isCopied, setIsCopied] = useState(false);
-  const copyTimeout = useRef(undefined);
+  const copyTimeout = useRef<number | undefined>(undefined);
   const handleCopyCode = useCallback(() => {
     copy(code);
     setIsCopied(true);
@@ -22,7 +25,9 @@ export default function CopyButton({ code, className }) {
       setIsCopied(false);
     }, 1000);
   }, [code]);
+
   useEffect(() => () => window.clearTimeout(copyTimeout.current), []);
+
   return (
     <button
       type="button"

package/src/theme/ApiExplorer/ApiCodeBlock/ExitButton/{index.js → index.tsx}

@@ -10,7 +10,15 @@ import React from "react";
 import { translate } from "@docusaurus/Translate";
 import clsx from "clsx";
 
-export default function ExitButton({ className, handler }) {
+export interface Props {
+  readonly className: string;
+  readonly handler: () => void;
+}
+
+export default function ExitButton({
+  className,
+  handler,
+}: Props): React.JSX.Element {
   return (
     <button
       type="button"