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

package/lib/theme/ApiExplorer/SecuritySchemes/index.d.ts

@@ -1,3 +1,3 @@
-/// <reference types="react" />
-declare function SecuritySchemes(props: any): JSX.Element | null;
+import React from "react";
+declare function SecuritySchemes(props: any): React.JSX.Element | null;
 export default SecuritySchemes;

package/lib/theme/ApiExplorer/Server/index.d.ts

@@ -1,3 +1,3 @@
-/// <reference types="react" />
-declare function Server(): JSX.Element | null;
+import React from "react";
+declare function Server(): React.JSX.Element | null;
 export default Server;

package/lib/theme/ApiExplorer/buildPostmanRequest.d.ts

@@ -2,7 +2,7 @@ import sdk from "@paloaltonetworks/postman-collection";
 import { AuthState } from "@theme/ApiExplorer/Authorization/slice";
 import { Body } from "@theme/ApiExplorer/Body/slice";
 import { ParameterObject, ServerObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
-declare type Param = {
+type Param = {
     value?: string | string[];
 } & ParameterObject;
 interface Options {

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

@@ -1,7 +1,7 @@
-/// <reference types="react" />
+import React from "react";
 import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
 declare function ApiExplorer({ item, infoPath, }: {
     item: NonNullable<ApiItem>;
     infoPath: string;
-}): JSX.Element;
+}): React.JSX.Element;
 export default ApiExplorer;

package/lib/theme/ApiExplorer/index.js

@@ -28,7 +28,7 @@ function ApiExplorer({ item, infoPath }) {
     item.method !== "event" &&
       react_1.default.createElement(CodeSnippets_1.default, {
         postman: postman,
-        codeSamples: item["x-code-samples"] ?? [],
+        codeSamples: item["x-codeSamples"] ?? [],
       }),
     react_1.default.createElement(Request_1.default, { item: item }),
     react_1.default.createElement(Response_1.default, { item: item })

package/lib/theme/ApiExplorer/storage-utils.d.ts

@@ -1,4 +1,4 @@
 export declare function hashArray(arr: string[]): string;
-declare type Persistance = false | "localStorage" | "sessionStorage" | undefined;
+type Persistance = false | "localStorage" | "sessionStorage" | undefined;
 export declare function createStorage(persistance: Persistance): Storage;
 export {};

package/lib/theme/ApiItem/index.js

@@ -18,6 +18,7 @@ const ExecutionEnvironment_1 = __importDefault(
   require("@docusaurus/ExecutionEnvironment")
 );
 const theme_common_1 = require("@docusaurus/theme-common");
+const internal_1 = require("@docusaurus/theme-common/internal");
 const useDocusaurusContext_1 = __importDefault(
   require("@docusaurus/useDocusaurusContext")
 );
@@ -29,17 +30,18 @@ const Metadata_1 = __importDefault(require("@theme/DocItem/Metadata"));
 const clsx_1 = __importDefault(require("clsx"));
 const react_redux_1 = require("react-redux");
 const store_1 = require("./store");
-const { DocProvider } = require("@docusaurus/theme-common/internal");
 let ApiExplorer = (_) => react_1.default.createElement("div", null);
 if (ExecutionEnvironment_1.default.canUseDOM) {
   ApiExplorer = require("@theme/ApiExplorer").default;
 }
+// @ts-ignore
 function ApiItem(props) {
   const docHtmlClassName = `docs-doc-id-${props.content.metadata.id}`;
   const MDXComponent = props.content;
   const { frontMatter } = MDXComponent;
   const { info_path: infoPath } = frontMatter;
   let { api } = frontMatter;
+  const { schema } = frontMatter;
   // decompress and parse
   if (api) {
     api = JSON.parse(
@@ -118,7 +120,7 @@ function ApiItem(props) {
   }
   if (api) {
     return react_1.default.createElement(
-      DocProvider,
+      internal_1.DocProvider,
       { content: props.content },
       react_1.default.createElement(
         theme_common_1.HtmlClassNameProvider,
@@ -163,10 +165,33 @@ function ApiItem(props) {
         )
       )
     );
+  } else if (schema) {
+    return react_1.default.createElement(
+      internal_1.DocProvider,
+      { content: props.content },
+      react_1.default.createElement(
+        theme_common_1.HtmlClassNameProvider,
+        { className: docHtmlClassName },
+        react_1.default.createElement(Metadata_1.default, null),
+        react_1.default.createElement(
+          Layout_1.default,
+          null,
+          react_1.default.createElement(
+            "div",
+            { className: (0, clsx_1.default)("row", "theme-api-markdown") },
+            react_1.default.createElement(
+              "div",
+              { className: "col col--12" },
+              react_1.default.createElement(MDXComponent, null)
+            )
+          )
+        )
+      )
+    );
   }
   // Non-API docs
   return react_1.default.createElement(
-    DocProvider,
+    internal_1.DocProvider,
     { content: props.content },
     react_1.default.createElement(
       theme_common_1.HtmlClassNameProvider,

package/lib/theme/ApiItem/store.d.ts

@@ -7,8 +7,8 @@ declare const rootReducer: import("redux").Reducer<import("redux").CombinedState
     params: unknown;
     auth: unknown;
 }>, import("redux").Action<any>>;
-export declare type RootState = ReturnType<typeof rootReducer>;
-export declare const createStoreWithState: (preloadedState: RootState, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").CombinedState<{
+export type RootState = ReturnType<typeof rootReducer>;
+export declare const createStoreWithState: (preloadedState: RootState, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").EmptyObject & {
     accept: unknown;
     contentType: unknown;
     response: unknown;
@@ -16,7 +16,7 @@ export declare const createStoreWithState: (preloadedState: RootState, middlewar
     body: unknown;
     params: unknown;
     auth: unknown;
-}>, import("redux").Action<any>, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
+}, import("redux").Action<any>, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
     accept: unknown;
     contentType: unknown;
     response: unknown;
@@ -25,7 +25,7 @@ export declare const createStoreWithState: (preloadedState: RootState, middlewar
     params: unknown;
     auth: unknown;
 }>, import("redux").AnyAction, undefined>, ...any[]]>>;
-export declare const createStoreWithoutState: (preloadedState: {}, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").CombinedState<{
+export declare const createStoreWithoutState: (preloadedState: {}, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").EmptyObject & {
     accept: unknown;
     contentType: unknown;
     response: unknown;
@@ -33,7 +33,7 @@ export declare const createStoreWithoutState: (preloadedState: {}, middlewares:
     body: unknown;
     params: unknown;
     auth: unknown;
-}>, import("redux").Action<any>, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
+}, import("redux").Action<any>, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
     accept: unknown;
     contentType: unknown;
     response: unknown;
@@ -42,5 +42,5 @@ export declare const createStoreWithoutState: (preloadedState: {}, middlewares:
     params: unknown;
     auth: unknown;
 }>, import("redux").AnyAction, undefined>, ...any[]]>>;
-export declare type AppDispatch = ReturnType<typeof createStoreWithState>["dispatch"];
+export type AppDispatch = ReturnType<typeof createStoreWithState>["dispatch"];
 export {};

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

@@ -1,2 +1,2 @@
-/// <reference types="react" />
-export default function ApiLogo(props: any): JSX.Element | undefined;
+import React from "react";
+export default function ApiLogo(props: any): React.JSX.Element | undefined;

package/lib/theme/ApiTabs/_ApiTabs.scss

@@ -10,7 +10,9 @@
 }
 
 .openapi-tabs__response-header {
-  margin-bottom: 0;
+  &.openapi-tabs__heading {
+    margin-bottom: 0;
+  }
 }
 
 .openapi-tabs__response-code-item {

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

@@ -0,0 +1,7 @@
+import React from "react";
+import { TabProps } from "@docusaurus/theme-common/internal";
+export interface TabListProps extends TabProps {
+    label: string;
+    id: string;
+}
+export default function ApiTabs(props: TabListProps): React.JSX.Element;

package/lib/theme/ApiTabs/index.js

@@ -1,25 +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, useRef, useState, useEffect } from "react";
-
-import {
-  useScrollPositionBlocker,
-  useTabs,
-} from "@docusaurus/theme-common/internal";
-import useIsBrowser from "@docusaurus/useIsBrowser";
-import Heading from "@theme/Heading";
-import clsx from "clsx";
-
-function TabList({ className, block, selectedValue, selectValue, tabValues }) {
+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 Heading_1 = __importDefault(require("@theme/Heading"));
+const clsx_1 = __importDefault(require("clsx"));
+function TabList({
+  className,
+  block,
+  selectedValue,
+  selectValue,
+  tabValues,
+  label = "Responses",
+  id = "responses",
+}) {
   const tabRefs = [];
-  const { blockElementScrollPositionUntilNextRender } =
-    useScrollPositionBlocker();
-
+  const { blockElementScrollPositionUntilNextRender } = (0,
+  internal_1.useScrollPositionBlocker)();
   const handleTabChange = (event) => {
     const newTab = event.currentTarget;
     const newTabIndex = tabRefs.indexOf(newTab);
@@ -29,7 +81,6 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
       selectValue(newTabValue);
     }
   };
-
   const handleKeydown = (event) => {
     let focusElement = null;
     switch (event.key) {
@@ -52,141 +103,154 @@ 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__response-header-section">
-      <Heading as="h2" id="responses" className="openapi-tabs__response-header">
-        Responses
-      </Heading>
-      <div className="openapi-tabs__response-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__response-header-section" },
+    react_1.default.createElement(
+      Heading_1.default,
+      {
+        as: "h2",
+        id: id,
+        className: "openapi-tabs__heading openapi-tabs__response-header",
+      },
+      label
+    ),
+    react_1.default.createElement(
+      "div",
+      { className: "openapi-tabs__response-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__response-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__response-code-item",
                 attributes?.className,
                 parseInt(value) >= 400
                   ? "danger"
                   : parseInt(value) >= 200 && parseInt(value) < 300
-                  ? "success"
-                  : "info",
+                    ? "success"
+                    : "info",
                 {
                   active: selectedValue === value,
                 }
-              )}
-            >
-              {label ?? value}
-            </li>
-          ))}
-        </ul>
-        {showTabArrows && (
-          <button
-            className="openapi-tabs__arrow right"
-            onClick={handleRightClick}
-          />
-        )}
-      </div>
-    </div>
+              ),
+            },
+            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 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="openapi-tabs__container">
-      <TabList {...props} {...tabs} />
-      <TabContent {...props} {...tabs} />
-    </div>
+  const tabs = (0, internal_1.useTabs)(props);
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-tabs__container" },
+    react_1.default.createElement(TabList, { ...props, ...tabs }),
+    react_1.default.createElement(TabContent, { ...props, ...tabs })
   );
 }
-export default function ApiTabs(props) {
-  const isBrowser = useIsBrowser();
-  return (
-    <TabsComponent
+function ApiTabs(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 = ApiTabs;

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

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