docusaurus-theme-openapi-docs 0.0.0-740 → 0.0.0-750

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

@@ -0,0 +1,8 @@
+import React from "react";
+import { Language } from "prism-react-renderer";
+export interface Props {
+    readonly responseExample: string;
+    readonly language: Language;
+}
+declare function ResponseSamples({ responseExample, language, }: Props): React.JSX.Element;
+export default ResponseSamples;

package/lib/theme/ResponseSamples/index.js

@@ -1,22 +1,27 @@
+"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";
-
+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"));
 function ResponseSamples({ responseExample, language }) {
-  return (
-    <div className="openapi-code__response-samples-container">
-      <CodeBlock language={language ? language : "json"}>
-        {responseExample}
-      </CodeBlock>
-    </div>
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-code__response-samples-container" },
+    react_1.default.createElement(
+      CodeBlock_1.default,
+      { language: language ? language : "json" },
+      responseExample
+    )
   );
 }
-
-export default ResponseSamples;
+exports.default = ResponseSamples;

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

@@ -0,0 +1,12 @@
+import React, { ReactNode } from "react";
+export interface Props {
+    children: ReactNode;
+    collapsible: boolean;
+    name: string;
+    qualifierMessage: string | undefined;
+    required: boolean;
+    schemaName: string;
+    schema: any;
+    discriminator: boolean;
+}
+export default function SchemaItem({ children: collapsibleSchemaContent, collapsible, name, qualifierMessage, required, schemaName, schema, }: Props): React.JSX.Element;

package/lib/theme/SchemaItem/index.js

@@ -1,21 +1,23 @@
+"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";
-/* 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 { guard } from "docusaurus-theme-openapi-docs/lib/markdown/utils";
-import ReactMarkdown from "react-markdown";
-import rehypeRaw from "rehype-raw";
-
+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 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 utils_1 = require("../../markdown/utils");
 function SchemaItem({
   children: collapsibleSchemaContent,
   collapsible,
@@ -35,86 +37,119 @@ function SchemaItem({
     defaultValue = schema.default;
     nullable = schema.nullable;
   }
-
-  const renderRequired = guard(
+  const renderRequired = (0, utils_1.guard)(
     Array.isArray(required) ? required.includes(name) : required,
-    () => <span className="openapi-schema__required">required</span>
+    () =>
+      react_1.default.createElement(
+        "span",
+        { className: "openapi-schema__required" },
+        "required"
+      )
   );
-
-  const renderDeprecated = guard(deprecated, () => (
-    <span className="openapi-schema__deprecated">deprecated</span>
-  ));
-
-  const renderNullable = guard(nullable, () => (
-    <span className="openapi-schema__nullable">nullable</span>
-  ));
-
-  const renderSchemaDescription = guard(schemaDescription, (description) => (
-    <div>
-      <ReactMarkdown
-        children={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>
-            );
+  const renderDeprecated = (0, utils_1.guard)(deprecated, () =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__deprecated" },
+      "deprecated"
+    )
+  );
+  const renderNullable = (0, utils_1.guard)(nullable, () =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__nullable" },
+      "nullable"
+    )
+  );
+  const renderSchemaDescription = (0, utils_1.guard)(
+    schemaDescription,
+    (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 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 renderQualifierMessage = guard(qualifierMessage, (message) => (
-    <div>
-      <ReactMarkdown
-        children={createDescription(message)}
-        rehypePlugins={[rehypeRaw]}
-      />
-    </div>
-  ));
-
-  const renderDefaultValue = guard(defaultValue, (value) => (
-    <div className="">
-      <ReactMarkdown children={`**Default value:** \`${value}\``} />
-    </div>
-  ));
-
-  const schemaContent = (
-    <div>
-      <span className="openapi-schema__container">
-        <strong
-          className={clsx("openapi-schema__property", {
+          rehypePlugins: [rehype_raw_1.default],
+        })
+      )
+  );
+  const renderQualifierMessage = (0, utils_1.guard)(
+    qualifierMessage,
+    (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 renderDefaultValue = (0, utils_1.guard)(defaultValue, (value) =>
+    react_1.default.createElement(
+      "div",
+      { className: "" },
+      react_1.default.createElement(react_markdown_1.default, {
+        children: `**Default value:** \`${value}\``,
+      })
+    )
+  );
+  const schemaContent = react_1.default.createElement(
+    "div",
+    null,
+    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>
-        <span className="openapi-schema__name"> {schemaName}</span>
-        {(nullable || required || deprecated) && (
-          <span className="openapi-schema__divider"></span>
-        )}
-        {renderNullable}
-        {renderRequired}
-        {renderDeprecated}
-      </span>
-      {renderQualifierMessage}
-      {renderDefaultValue}
-      {renderSchemaDescription}
-      {collapsibleSchemaContent ?? collapsibleSchemaContent}
-    </div>
+          }),
+        },
+        name
+      ),
+      react_1.default.createElement(
+        "span",
+        { className: "openapi-schema__name" },
+        " ",
+        schemaName
+      ),
+      (nullable || required || deprecated) &&
+        react_1.default.createElement("span", {
+          className: "openapi-schema__divider",
+        }),
+      renderNullable,
+      renderRequired,
+      renderDeprecated
+    ),
+    renderQualifierMessage,
+    renderDefaultValue,
+    renderSchemaDescription,
+    collapsibleSchemaContent ?? collapsibleSchemaContent
   );
-
-  return (
-    <div className="openapi-schema__list-item">
-      {collapsible ? collapsibleSchemaContent : schemaContent}
-    </div>
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-schema__list-item" },
+    collapsible ? collapsibleSchemaContent : schemaContent
   );
 }
-
-export default SchemaItem;
+exports.default = SchemaItem;

package/lib/theme/SchemaTabs/_SchemaTabs.scss

@@ -5,10 +5,6 @@
  * 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;

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

@@ -0,0 +1,3 @@
+import React from "react";
+import { TabProps } from "@docusaurus/theme-common/internal";
+export default function SchemaTabs(props: TabProps): React.JSX.Element;

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,15 +95,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);
@@ -66,121 +109,133 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
         });
       }
     });
-
     resizeObserver.observe(tabItemListContainerRef.current);
-
     return () => {
       resizeObserver.disconnect();
     };
   }, []);
-
   const handleRightClick = (e) => {
     e.preventDefault();
-    tabItemListContainerRef.current.scrollLeft += 90;
+    if (tabItemListContainerRef.current) {
+      tabItemListContainerRef.current.scrollLeft += 90;
+    }
   };
-
   const handleLeftClick = (e) => {
     e.preventDefault();
-    tabItemListContainerRef.current.scrollLeft -= 90;
+    if (tabItemListContainerRef.current) {
+      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

@@ -159,3 +159,7 @@
 .openapi-left-panel__container {
   border-right: thin solid var(--ifm-toc-border-color);
 }
+
+.openapi-tabs__heading {
+  margin-bottom: 1rem;
+}