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

package/lib/theme/ApiExplorer/CodeTabs/_CodeTabs.scss

@@ -18,12 +18,14 @@
     background-color: var(--ifm-pre-background);
     border-radius: var(--ifm-global-radius);
     border: 1px solid var(--openapi-explorer-border-color);
-    box-shadow: 0 2px 3px hsla(222, 8%, 43%, 0.1),
+    box-shadow:
+      0 2px 3px hsla(222, 8%, 43%, 0.1),
       0 8px 16px -10px hsla(222, 8%, 43%, 0.2);
     transition: 300ms;
 
     &:hover {
-      box-shadow: 0 0 0 2px rgba(38, 53, 61, 0.15),
+      box-shadow:
+        0 0 0 2px rgba(38, 53, 61, 0.15),
         0 2px 3px hsla(222, 8%, 43%, 0.15),
         0 16px 16px -10px hsla(222, 8%, 43%, 0.2);
     }

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

@@ -0,0 +1,15 @@
+import React from "react";
+import { type TabProps } from "@docusaurus/theme-common/internal";
+import { Language } from "@theme/ApiExplorer/CodeSnippets";
+export interface Props {
+    action: {
+        [key: string]: React.Dispatch<any>;
+    };
+    currentLanguage: Language;
+    languageSet: Language[];
+    includeVariant: boolean;
+}
+export interface CodeTabsProps extends Props, TabProps {
+    includeSample?: boolean;
+}
+export default function CodeTabs(props: CodeTabsProps & Props): React.JSX.Element;

package/lib/theme/ApiExplorer/CodeTabs/index.js

@@ -1,19 +1,64 @@
+"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 } 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({
   action,
   currentLanguage,
@@ -27,19 +72,16 @@ function TabList({
   tabValues,
 }) {
   const tabRefs = [];
-  const { blockElementScrollPositionUntilNextRender } =
-    useScrollPositionBlocker();
-
+  const { blockElementScrollPositionUntilNextRender } = (0,
+  internal_1.useScrollPositionBlocker)();
   const handleTabChange = (event) => {
     const newTab = event.currentTarget;
     const newTabIndex = tabRefs.indexOf(newTab);
     const newTabValue = tabValues[newTabIndex].value;
-
     if (newTabValue !== selectedValue) {
       blockElementScrollPositionUntilNextRender(newTab);
       selectValue(newTabValue);
     }
-
     if (action) {
       let newLanguage;
       if (currentLanguage && includeVariant) {
@@ -61,11 +103,9 @@ function TabList({
         action.setSelectedVariant(newLanguage.variant.toLowerCase());
         action.setSelectedSample(newLanguage.sample);
       }
-
       action.setLanguage(newLanguage);
     }
   };
-
   const handleKeydown = (event) => {
     let focusElement = null;
     switch (event.key) {
@@ -88,96 +128,102 @@ function TabList({
     }
     focusElement?.focus();
   };
-
-  return (
-    <ul
-      role="tablist"
-      aria-orientation="horizontal"
-      className={clsx(
+  return react_1.default.createElement(
+    "ul",
+    {
+      role: "tablist",
+      "aria-orientation": "horizontal",
+      className: (0, clsx_1.default)(
         "tabs",
         "openapi-tabs__code-list-container",
         {
           "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__code-item",
             attributes?.className,
             {
               active: selectedValue === value,
             }
-          )}
-        >
-          <span>{label ?? value}</span>
-        </li>
-      ))}
-    </ul>
+          ),
+        },
+        react_1.default.createElement("span", null, label ?? value)
+      )
+    )
   );
 }
-
 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 openapi-tabs__code-content">
-      {children.map((tabItem, i) =>
-        cloneElement(tabItem, {
-          key: i,
-          hidden: tabItem.props.value !== selectedValue,
-        })
-      )}
-    </div>
+  return react_1.default.createElement(
+    "div",
+    { className: "margin-top--md openapi-tabs__code-content" },
+    childTabs.map((tabItem, i) =>
+      (0, react_1.cloneElement)(tabItem, {
+        key: i,
+        hidden: tabItem.props.value !== selectedValue,
+      })
+    )
   );
 }
-
 function TabsComponent(props) {
-  const tabs = useTabs(props);
+  const tabs = (0, internal_1.useTabs)(props);
   const { className } = props;
-
-  return (
-    <div
-      className={clsx("tabs-container openapi-tabs__code-container", {
-        [className]: className,
-      })}
-    >
-      <TabList {...props} {...tabs} />
-      <TabContent {...props} {...tabs} />
-    </div>
+  return react_1.default.createElement(
+    "div",
+    {
+      className: (0, clsx_1.default)(
+        "tabs-container openapi-tabs__code-container",
+        className
+      ),
+    },
+    react_1.default.createElement(TabList, { ...props, ...tabs }),
+    react_1.default.createElement(TabContent, { ...props, ...tabs })
   );
 }
-
-export default function CodeTabs(props) {
-  const isBrowser = useIsBrowser();
-  return (
-    <TabsComponent
+function CodeTabs(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 = CodeTabs;

package/lib/theme/ApiExplorer/FloatingButton/_FloatingButton.scss

@@ -11,7 +11,9 @@
     padding: 0.4rem 0.5rem;
     opacity: 0;
     visibility: hidden;
-    transition: opacity 0.2s ease-in-out, visibility 0.2s ease-in-out,
+    transition:
+      opacity 0.2s ease-in-out,
+      visibility 0.2s ease-in-out,
       bottom 0.2s ease-in-out;
     position: absolute;
     right: calc(var(--ifm-pre-padding) / 2);

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.js

@@ -42,10 +42,10 @@ function ParamMultiSelectFormItem({ param }) {
   const paramTypeToWatch = pathParams.length
     ? pathParams
     : queryParams.length
-    ? queryParams
-    : cookieParams.length
-    ? cookieParams
-    : headerParams;
+      ? queryParams
+      : cookieParams.length
+        ? cookieParams
+        : headerParams;
   const handleChange = (e, onChange) => {
     const values = Array.prototype.filter
       .call(e.target.options, (o) => o.selected)

package/lib/theme/ApiExplorer/ParamOptions/_ParamOptions.scss

@@ -107,7 +107,8 @@
   }
 
   &:active {
-    box-shadow: inset 0 0 0 1px var(--openapi-input-border),
+    box-shadow:
+      inset 0 0 0 1px var(--openapi-input-border),
       inset 0 0 0 2px var(--openapi-inverse-color);
   }
 }

package/lib/theme/ApiExplorer/Request/_Request.scss

@@ -2,7 +2,8 @@
   background-color: var(--ifm-pre-background);
   border-radius: var(--openapi-card-border-radius);
   border: 1px solid var(--openapi-explorer-border-color);
-  box-shadow: 0 2px 3px hsla(222, 8%, 43%, 0.1),
+  box-shadow:
+    0 2px 3px hsla(222, 8%, 43%, 0.1),
     0 8px 16px -10px hsla(222, 8%, 43%, 0.2);
   color: var(--ifm-pre-color);
   line-height: var(--ifm-pre-line-height);
@@ -19,7 +20,8 @@
   }
 
   &:hover {
-    box-shadow: 0 0 0 2px rgba(38, 53, 61, 0.15),
+    box-shadow:
+      0 0 0 2px rgba(38, 53, 61, 0.15),
       0 2px 3px hsla(222, 8%, 43%, 0.15),
       0 16px 16px -10px hsla(222, 8%, 43%, 0.2);
   }
@@ -112,10 +114,6 @@
   }
 }
 
-.openapi-security__summary-container {
-  background: var(--ifm-pre-background);
-}
-
 // Prevent auto zoom on mobile iOS devices when focusing on input elmenents
 @media screen and (-webkit-min-device-pixel-ratio: 0) and (max-device-width: 1024px) {
   .prism-code,

package/lib/theme/ApiExplorer/Response/_Response.scss

@@ -2,7 +2,8 @@
   background-color: var(--ifm-pre-background);
   border-radius: var(--openapi-card-border-radius);
   border: 1px solid var(--openapi-explorer-border-color);
-  box-shadow: 0 2px 3px hsla(222, 8%, 43%, 0.1),
+  box-shadow:
+    0 2px 3px hsla(222, 8%, 43%, 0.1),
     0 8px 16px -10px hsla(222, 8%, 43%, 0.2);
   color: var(--ifm-pre-color);
   line-height: var(--ifm-pre-line-height);
@@ -12,7 +13,8 @@
   transition: 300ms;
 
   &:hover {
-    box-shadow: 0 0 0 2px rgba(38, 53, 61, 0.15),
+    box-shadow:
+      0 0 0 2px rgba(38, 53, 61, 0.15),
       0 2px 3px hsla(222, 8%, 43%, 0.15),
       0 16px 16px -10px hsla(222, 8%, 43%, 0.2);
   }

package/lib/theme/ApiExplorer/Response/index.js

@@ -58,8 +58,8 @@ function Response({ item }) {
       (parseInt(code) >= 400
         ? "openapi-response__dot--danger"
         : parseInt(code) >= 200 && parseInt(code) < 300
-        ? "openapi-response__dot--success"
-        : "openapi-response__dot--info");
+          ? "openapi-response__dot--success"
+          : "openapi-response__dot--info");
   if (!item.servers || hideSendButton) {
     return null;
   }
@@ -101,7 +101,10 @@ function Response({ item }) {
       "div",
       {
         style: {
-          backgroundColor: prismTheme.plain.backgroundColor,
+          backgroundColor:
+            code && prettyResponse !== "Fetching..."
+              ? prismTheme.plain.backgroundColor
+              : "transparent",
           paddingLeft: "1rem",
           paddingTop: "1rem",
           ...((prettyResponse === "Fetching..." || !code) && {
@@ -165,25 +168,25 @@ function Response({ item }) {
             )
           )
         : prettyResponse === "Fetching..."
-        ? react_1.default.createElement(
-            "div",
-            { className: "openapi-explorer__loading-container" },
-            react_1.default.createElement(
+          ? react_1.default.createElement(
               "div",
-              { className: "openapi-response__lds-ring" },
-              react_1.default.createElement("div", null),
-              react_1.default.createElement("div", null),
-              react_1.default.createElement("div", null),
-              react_1.default.createElement("div", null)
+              { className: "openapi-explorer__loading-container" },
+              react_1.default.createElement(
+                "div",
+                { className: "openapi-response__lds-ring" },
+                react_1.default.createElement("div", null),
+                react_1.default.createElement("div", null),
+                react_1.default.createElement("div", null),
+                react_1.default.createElement("div", null)
+              )
+            )
+          : react_1.default.createElement(
+              "p",
+              { className: "openapi-explorer__response-placeholder-message" },
+              "Click the ",
+              react_1.default.createElement("code", null, "Send API Request"),
+              " button above and see the response here!"
             )
-          )
-        : react_1.default.createElement(
-            "p",
-            { className: "openapi-explorer__response-placeholder-message" },
-            "Click the ",
-            react_1.default.createElement("code", null, "Send API Request"),
-            " button above and see the response here!"
-          )
     )
   );
 }

package/lib/theme/ApiExplorer/index.js

@@ -18,15 +18,11 @@ const CodeSnippets_1 = __importDefault(
 const Request_1 = __importDefault(require("@theme/ApiExplorer/Request"));
 const Response_1 = __importDefault(require("@theme/ApiExplorer/Response"));
 const postman_collection_1 = __importDefault(require("postman-collection"));
-const SecuritySchemes_1 = __importDefault(require("./SecuritySchemes"));
 function ApiExplorer({ item, infoPath }) {
   const postman = new postman_collection_1.default.Request(item.postman);
   return react_1.default.createElement(
     react_1.default.Fragment,
     null,
-    react_1.default.createElement(SecuritySchemes_1.default, {
-      infoPath: infoPath,
-    }),
     item.method !== "event" &&
       react_1.default.createElement(CodeSnippets_1.default, {
         postman: postman,

package/lib/theme/ApiExplorer/persistanceMiddleware.js

@@ -32,12 +32,12 @@ function createPersistanceMiddleware(options) {
       }
     }
     // TODO: determine way to rehydrate without flashing
-    // if (action.type === "contentType/setContentType") {
-    //   storage.setItem("contentType", action.payload);
-    // }
-    // if (action.type === "accept/setAccept") {
-    //   storage.setItem("accept", action.payload);
-    // }
+    if (action.type === "contentType/setContentType") {
+      storage.setItem("contentType", action.payload);
+    }
+    if (action.type === "accept/setAccept") {
+      storage.setItem("accept", action.payload);
+    }
     if (action.type === "server/setServer") {
       storage.setItem("server", action.payload);
     }

package/lib/theme/ApiItem/Layout/index.js

@@ -22,6 +22,7 @@ const Desktop_1 = __importDefault(require("@theme/DocItem/TOC/Desktop"));
 const Mobile_1 = __importDefault(require("@theme/DocItem/TOC/Mobile"));
 const DocVersionBadge_1 = __importDefault(require("@theme/DocVersionBadge"));
 const DocVersionBanner_1 = __importDefault(require("@theme/DocVersionBanner"));
+const Unlisted_1 = __importDefault(require("@theme/Unlisted"));
 const clsx_1 = __importDefault(require("clsx"));
 const styles_module_css_1 = __importDefault(require("./styles.module.css"));
 /**
@@ -48,6 +49,7 @@ function useDocTOC() {
 function DocItemLayout({ children }) {
   const docTOC = useDocTOC();
   const {
+    metadata: { unlisted },
     frontMatter: { api },
   } = (0, internal_1.useDoc)();
   return react_1.default.createElement(
@@ -61,6 +63,7 @@ function DocItemLayout({ children }) {
           !docTOC.hidden && styles_module_css_1.default.docItemCol
         ),
       },
+      unlisted && react_1.default.createElement(Unlisted_1.default, null),
       react_1.default.createElement(DocVersionBanner_1.default, null),
       react_1.default.createElement(
         "div",

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,13 +30,13 @@ 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.unversionedId}`;
+  const docHtmlClassName = `docs-doc-id-${props.content.metadata.id}`;
   const MDXComponent = props.content;
   const { frontMatter } = MDXComponent;
   const { info_path: infoPath } = frontMatter;
@@ -121,7 +122,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,
@@ -168,7 +169,7 @@ function ApiItem(props) {
     );
   } else if (schema) {
     return react_1.default.createElement(
-      DocProvider,
+      internal_1.DocProvider,
       { content: props.content },
       react_1.default.createElement(
         theme_common_1.HtmlClassNameProvider,
@@ -192,7 +193,7 @@ function ApiItem(props) {
   }
   // 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/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;