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

package/lib/theme/OperationTabs/index.js

@@ -1,36 +1,77 @@
+"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, useEffect, useState, useRef } from "react";
-
-import {
-  useScrollPositionBlocker,
-  useTabs,
-} from "@docusaurus/theme-common/internal";
-import useIsBrowser from "@docusaurus/useIsBrowser";
-import clsx from "clsx";
-
+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"));
 function TabList({ className, block, selectedValue, selectValue, tabValues }) {
   const tabRefs = [];
-  const { blockElementScrollPositionUntilNextRender } =
-    useScrollPositionBlocker();
-
+  const { blockElementScrollPositionUntilNextRender } = (0,
+  internal_1.useScrollPositionBlocker)();
   const handleTabChange = (event) => {
-    event.preventDefault();
     const newTab = event.currentTarget;
     const newTabIndex = tabRefs.indexOf(newTab);
     const newTabValue = tabValues[newTabIndex].value;
-    // custom
     if (newTabValue !== selectedValue) {
       blockElementScrollPositionUntilNextRender(newTab);
       selectValue(newTabValue);
     }
   };
-
   const handleKeydown = (event) => {
     let focusElement = null;
     switch (event.key) {
@@ -53,15 +94,13 @@ 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) {
         requestAnimationFrame(() => {
-          if (entry.target.offsetWidth < entry.target.scrollWidth) {
+          if (entry.target.clientWidth < entry.target.scrollWidth) {
             setShowTabArrows(true);
           } else {
             setShowTabArrows(false);
@@ -69,121 +108,127 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
         });
       }
     });
-
     resizeObserver.observe(tabItemListContainerRef.current);
-
     return () => {
       resizeObserver.disconnect();
     };
   }, []);
-
   const handleRightClick = () => {
     tabItemListContainerRef.current.scrollLeft += 90;
   };
-
   const handleLeftClick = () => {
     tabItemListContainerRef.current.scrollLeft -= 90;
   };
-
-  return (
-    <div className="tabs__container">
-      <div className="openapi-tabs__operation-container">
-        {showTabArrows && (
-          <button
-            className={clsx("openapi-tabs__arrow", "left")}
-            onClick={handleLeftClick}
-          />
-        )}
-        <ul
-          ref={tabItemListContainerRef}
-          role="tablist"
-          aria-orientation="horizontal"
-          className={clsx(
+  return react_1.default.createElement(
+    "div",
+    { className: "tabs__container" },
+    react_1.default.createElement(
+      "div",
+      { className: "openapi-tabs__operation-container" },
+      showTabArrows &&
+        react_1.default.createElement("button", {
+          className: (0, clsx_1.default)("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__operation-list-container",
             "tabs",
             {
               "tabs--block": block,
             },
             className
-          )}
-        >
-          {tabValues.map(({ value, label, attributes }) => {
-            return (
-              <li
-                role="tab"
-                tabIndex={selectedValue === value ? 0 : -1}
-                aria-selected={selectedValue === value}
-                key={value}
-                ref={(tabControl) => tabRefs.push(tabControl)}
-                onKeyDown={handleKeydown}
-                onFocus={handleTabChange}
-                onClick={(e) => handleTabChange(e)}
-                {...attributes}
-                className={clsx(
-                  "tabs__item",
-                  "openapi-tabs__operation-item",
-                  attributes?.className,
-                  {
-                    active: selectedValue === value,
-                  }
-                )}
-              >
-                {label ?? value}
-              </li>
-            );
-          })}
-        </ul>
-        {showTabArrows && (
-          <button
-            className={clsx("openapi-tabs__arrow", "right")}
-            onClick={handleRightClick}
-          />
-        )}
-      </div>
-    </div>
+          ),
+        },
+        tabValues.map(({ value, label, attributes }) => {
+          return 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,
+              onFocus: handleTabChange,
+              onClick: (e) => handleTabChange(e),
+              ...attributes,
+              className: (0, clsx_1.default)(
+                "tabs__item",
+                "openapi-tabs__operation-item",
+                attributes?.className,
+                {
+                  active: selectedValue === value,
+                }
+              ),
+            },
+            label ?? value
+          );
+        })
+      ),
+      showTabArrows &&
+        react_1.default.createElement("button", {
+          className: (0, clsx_1.default)("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 childTabs = (Array.isArray(children) ? children : [children]).filter(
+    Boolean
+  );
   if (lazy) {
-    const selectedTabItem = children.find(
+    const selectedTabItem = childTabs.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="tabs-container">
-      <TabList {...props} {...tabs} />
-      <TabContent {...props} {...tabs} />
-    </div>
+  const tabs = (0, internal_1.useTabs)(props);
+  return react_1.default.createElement(
+    "div",
+    { className: "tabs-container" },
+    react_1.default.createElement(TabList, { ...props, ...tabs }),
+    react_1.default.createElement(TabContent, { ...props, ...tabs })
   );
 }
-export default function OperationTabs(props) {
-  const isBrowser = useIsBrowser();
-  return (
-    <TabsComponent
+function OperationTabs(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 = OperationTabs;

package/lib/theme/ParamsItem/index.d.ts

@@ -0,0 +1,23 @@
+import React from "react";
+interface Map<T> {
+    [key: string]: T;
+}
+export interface ExampleObject {
+    summary?: string;
+    description?: string;
+    value?: any;
+    externalValue?: string;
+}
+export interface Props {
+    param: {
+        description: string;
+        example: any;
+        examples: Map<ExampleObject>;
+        name: string;
+        required: boolean;
+        deprecated: boolean;
+        schema: any;
+    };
+}
+declare function ParamsItem({ param: { description, example, examples, name, required, schema, deprecated }, }: Props): React.JSX.Element;
+export default ParamsItem;

package/lib/theme/ParamsItem/index.js

@@ -1,150 +1,195 @@
+"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 from "react";
-
-import CodeBlock from "@theme/CodeBlock";
-import SchemaTabs from "@theme/SchemaTabs";
-import TabItem from "@theme/TabItem";
+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 CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
+const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
+const TabItem_1 = __importDefault(require("@theme/TabItem"));
 /* eslint-disable import/no-extraneous-dependencies*/
-import clsx from "clsx";
-import { createDescription } from "docusaurus-theme-openapi-docs/lib/markdown/createDescription";
-/* eslint-disable import/no-extraneous-dependencies*/
-import {
-  getQualifierMessage,
-  getSchemaName,
-} from "docusaurus-theme-openapi-docs/lib/markdown/schema";
-/* eslint-disable import/no-extraneous-dependencies*/
-import {
-  guard,
-  toString,
-} from "docusaurus-theme-openapi-docs/lib/markdown/utils";
-import ReactMarkdown from "react-markdown";
-import rehypeRaw from "rehype-raw";
-
+const clsx_1 = __importDefault(require("clsx"));
+const react_markdown_1 = __importDefault(require("react-markdown"));
+const rehype_raw_1 = __importDefault(require("rehype-raw"));
+const createDescription_1 = require("../../markdown/createDescription");
+const schema_1 = require("../../markdown/schema");
+const utils_1 = require("../../markdown/utils");
 function ParamsItem({
   param: { description, example, examples, name, required, schema, deprecated },
 }) {
   if (!schema || !schema?.type) {
     schema = { type: "any" };
   }
-
-  const renderSchemaName = guard(schema, (schema) => (
-    <span className="openapi-schema__type"> {getSchemaName(schema)}</span>
-  ));
-
-  const renderSchemaRequired = guard(required, () => (
-    <span className="openapi-schema__required">required</span>
-  ));
-
-  const renderDeprecated = guard(deprecated, () => (
-    <span className="openapi-schema__deprecated">deprecated</span>
-  ));
-
-  const renderSchema = guard(getQualifierMessage(schema), (message) => (
-    <div>
-      <ReactMarkdown
-        children={createDescription(message)}
-        rehypePlugins={[rehypeRaw]}
-      />
-    </div>
-  ));
-
-  const renderDescription = guard(description, (description) => (
-    <div>
-      <ReactMarkdown
-        children={createDescription(description)}
-        components={{
+  const renderSchemaName = (0, utils_1.guard)(schema, (schema) =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__type" },
+      " ",
+      (0, schema_1.getSchemaName)(schema)
+    )
+  );
+  const renderSchemaRequired = (0, utils_1.guard)(required, () =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__required" },
+      "required"
+    )
+  );
+  const renderDeprecated = (0, utils_1.guard)(deprecated, () =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__deprecated" },
+      "deprecated"
+    )
+  );
+  const renderSchema = (0, utils_1.guard)(
+    (0, schema_1.getQualifierMessage)(schema),
+    (message) =>
+      react_1.default.createElement(
+        "div",
+        null,
+        react_1.default.createElement(react_markdown_1.default, {
+          children: (0, createDescription_1.createDescription)(message),
+          rehypePlugins: [rehype_raw_1.default],
+        })
+      )
+  );
+  const renderDescription = (0, utils_1.guard)(description, (description) =>
+    react_1.default.createElement(
+      "div",
+      null,
+      react_1.default.createElement(react_markdown_1.default, {
+        children: (0, createDescription_1.createDescription)(description),
+        components: {
           pre: "div",
           code({ node, inline, className, children, ...props }) {
             const match = /language-(\w+)/.exec(className || "");
-            if (inline) return <code>{children}</code>;
-            return !inline && match ? (
-              <CodeBlock className={className}>{children}</CodeBlock>
-            ) : (
-              <CodeBlock>{children}</CodeBlock>
-            );
+            if (inline)
+              return react_1.default.createElement("code", null, children);
+            return !inline && match
+              ? react_1.default.createElement(
+                  CodeBlock_1.default,
+                  { className: className },
+                  children
+                )
+              : react_1.default.createElement(
+                  CodeBlock_1.default,
+                  null,
+                  children
+                );
           },
-        }}
-        rehypePlugins={[rehypeRaw]}
-      />
-    </div>
-  ));
-
-  const renderDefaultValue = guard(
+        },
+        rehypePlugins: [rehype_raw_1.default],
+      })
+    )
+  );
+  const renderDefaultValue = (0, utils_1.guard)(
     schema && schema.items
       ? schema.items.default
       : schema
-      ? schema.default
-      : undefined,
-    (value) => (
-      <div>
-        <ReactMarkdown children={`**Default value:** \`${value}\``} />
-      </div>
-    )
+        ? schema.default
+        : undefined,
+    (value) =>
+      react_1.default.createElement(
+        "div",
+        null,
+        react_1.default.createElement(react_markdown_1.default, {
+          children: `**Default value:** \`${value}\``,
+        })
+      )
+  );
+  const renderExample = (0, utils_1.guard)(
+    (0, utils_1.toString)(example),
+    (example) =>
+      react_1.default.createElement(
+        "div",
+        null,
+        react_1.default.createElement("strong", null, "Example: "),
+        example
+      )
   );
-
-  const renderExample = guard(toString(example), (example) => (
-    <div>
-      <strong>Example: </strong>
-      {example}
-    </div>
-  ));
-
-  const renderExamples = guard(examples, (examples) => {
+  const renderExamples = (0, utils_1.guard)(examples, (examples) => {
     const exampleEntries = Object.entries(examples);
-    return (
-      <>
-        <strong>Examples:</strong>
-        <SchemaTabs>
-          {exampleEntries.map(([exampleName, exampleProperties]) => (
-            <TabItem value={exampleName} label={exampleName}>
-              {exampleProperties.summary && <p>{exampleProperties.summary}</p>}
-              {exampleProperties.description && (
-                <p>
-                  <strong>Description: </strong>
-                  <span>{exampleProperties.description}</span>
-                </p>
-              )}
-              <p>
-                <strong>Example: </strong>
-                <code>{exampleProperties.value}</code>
-              </p>
-            </TabItem>
-          ))}
-        </SchemaTabs>
-      </>
+    return react_1.default.createElement(
+      react_1.default.Fragment,
+      null,
+      react_1.default.createElement("strong", null, "Examples:"),
+      react_1.default.createElement(
+        SchemaTabs_1.default,
+        null,
+        exampleEntries.map(([exampleName, exampleProperties]) =>
+          // @ts-ignore
+          react_1.default.createElement(
+            TabItem_1.default,
+            { value: exampleName, label: exampleName },
+            exampleProperties.summary &&
+              react_1.default.createElement(
+                "p",
+                null,
+                exampleProperties.summary
+              ),
+            exampleProperties.description &&
+              react_1.default.createElement(
+                "p",
+                null,
+                react_1.default.createElement("strong", null, "Description: "),
+                react_1.default.createElement(
+                  "span",
+                  null,
+                  exampleProperties.description
+                )
+              ),
+            react_1.default.createElement(
+              "p",
+              null,
+              react_1.default.createElement("strong", null, "Example: "),
+              react_1.default.createElement(
+                "code",
+                null,
+                exampleProperties.value
+              )
+            )
+          )
+        )
+      )
     );
   });
-
-  return (
-    <div className="openapi-params__list-item">
-      <span className="openapi-schema__container">
-        <strong
-          className={clsx("openapi-schema__property", {
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-params__list-item" },
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__container" },
+      react_1.default.createElement(
+        "strong",
+        {
+          className: (0, clsx_1.default)("openapi-schema__property", {
             "openapi-schema__strikethrough": deprecated,
-          })}
-        >
-          {name}
-        </strong>
-        {renderSchemaName}
-        {(required || deprecated) && (
-          <span className="openapi-schema__divider"></span>
-        )}
-        {renderSchemaRequired}
-        {renderDeprecated}
-      </span>
-      {renderSchema}
-      {renderDefaultValue}
-      {renderDescription}
-      {renderExample}
-      {renderExamples}
-    </div>
+          }),
+        },
+        name
+      ),
+      renderSchemaName,
+      (required || deprecated) &&
+        react_1.default.createElement("span", {
+          className: "openapi-schema__divider",
+        }),
+      renderSchemaRequired,
+      renderDeprecated
+    ),
+    renderSchema,
+    renderDefaultValue,
+    renderDescription,
+    renderExample,
+    renderExamples
   );
 }
-
-export default ParamsItem;
+exports.default = ParamsItem;