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

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

@@ -1,24 +1,70 @@
+"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 { languageSet } from "@theme/ApiExplorer/CodeSnippets";
-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,
+  languageSet,
   includeVariant,
+  includeSample,
   className,
   block,
   selectedValue,
@@ -26,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) {
@@ -47,16 +90,22 @@ function TabList({
         )[0];
         newLanguage.variant = newTabValue;
         action.setSelectedVariant(newTabValue.toLowerCase());
+      } else if (currentLanguage && includeSample) {
+        newLanguage = languageSet.filter(
+          (lang) => lang.language === currentLanguage
+        )[0];
+        newLanguage.sample = newTabValue;
+        action.setSelectedSample(newTabValue);
       } else {
         newLanguage = languageSet.filter(
           (lang) => lang.language === newTabValue
         )[0];
         action.setSelectedVariant(newLanguage.variant.toLowerCase());
+        action.setSelectedSample(newLanguage.sample);
       }
       action.setLanguage(newLanguage);
     }
   };
-
   const handleKeydown = (event) => {
     let focusElement = null;
     switch (event.key) {
@@ -79,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/ContentType/index.d.ts

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

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

@@ -1,3 +1,3 @@
-/// <reference types="react" />
-declare function Export({ url, proxy }: any): JSX.Element;
+import React from "react";
+declare function Export({ url, proxy }: any): React.JSX.Element;
 export default Export;

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/FloatingButton/index.d.ts

@@ -4,5 +4,5 @@ export interface Props {
     onClick?: React.MouseEventHandler<HTMLButtonElement>;
     children?: React.ReactNode;
 }
-declare function FloatingButton({ label, onClick, children }: Props): JSX.Element;
+declare function FloatingButton({ label, onClick, children }: Props): React.JSX.Element;
 export default FloatingButton;

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

@@ -1,7 +1,7 @@
-/// <reference types="react" />
+import React from "react";
 export interface Props {
     placeholder: string;
     onChange?(file?: File): any;
 }
-declare function FormFileUpload({ placeholder, onChange }: Props): JSX.Element;
+declare function FormFileUpload({ placeholder, onChange }: Props): React.JSX.Element;
 export default FormFileUpload;

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

@@ -6,5 +6,5 @@ export interface Props {
     children?: React.ReactNode;
     className?: string;
 }
-declare function FormItem({ label, type, required, children, className }: Props): JSX.Element;
+declare function FormItem({ label, type, required, children, className }: Props): React.JSX.Element;
 export default FormItem;

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

@@ -5,5 +5,5 @@ export interface Props {
     onChange?: React.ChangeEventHandler<HTMLSelectElement>;
     showErrors?: boolean;
 }
-declare function FormMultiSelect({ value, options, onChange, showErrors }: Props): JSX.Element | null;
+declare function FormMultiSelect({ value, options, onChange, showErrors }: Props): React.JSX.Element | null;
 export default FormMultiSelect;

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

@@ -4,5 +4,5 @@ export interface Props {
     options?: string[];
     onChange?: React.ChangeEventHandler<HTMLSelectElement>;
 }
-declare function FormSelect({ value, options, onChange }: Props): JSX.Element | null;
+declare function FormSelect({ value, options, onChange }: Props): React.JSX.Element | null;
 export default FormSelect;

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

@@ -5,5 +5,5 @@ export interface Props {
     password?: boolean;
     onChange?: React.ChangeEventHandler<HTMLInputElement>;
 }
-declare function FormTextInput({ isRequired, value, placeholder, password, onChange, paramName, }: Props): JSX.Element;
+declare function FormTextInput({ isRequired, value, placeholder, password, onChange, paramName, }: Props): React.JSX.Element;
 export default FormTextInput;

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

@@ -1,7 +1,7 @@
-/// <reference types="react" />
+import React from "react";
 export interface Props {
     method: string;
     path: string;
 }
-declare function MethodEndpoint({ method, path }: Props): JSX.Element;
+declare function MethodEndpoint({ method, path }: Props): React.JSX.Element;
 export default MethodEndpoint;

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
+import React from "react";
 import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
 export interface ParamProps {
     param: Param;
 }
-export default function ParamArrayFormItem({ param }: ParamProps): JSX.Element;
+export default function ParamArrayFormItem({ param }: ParamProps): React.JSX.Element;

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
+import React from "react";
 import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
 export interface ParamProps {
     param: Param;
 }
-export default function ParamBooleanFormItem({ param }: ParamProps): JSX.Element;
+export default function ParamBooleanFormItem({ param }: ParamProps): React.JSX.Element;

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
+import React from "react";
 import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
 export interface ParamProps {
     param: Param;
 }
-export default function ParamMultiSelectFormItem({ param }: ParamProps): JSX.Element;
+export default function ParamMultiSelectFormItem({ param }: ParamProps): React.JSX.Element;

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/ParamFormItems/ParamSelectFormItem.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
+import React from "react";
 import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
 export interface ParamProps {
     param: Param;
 }
-export default function ParamSelectFormItem({ param }: ParamProps): JSX.Element;
+export default function ParamSelectFormItem({ param }: ParamProps): React.JSX.Element;

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
+import React from "react";
 import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
 export interface ParamProps {
     param: Param;
 }
-export default function ParamTextFormItem({ param }: ParamProps): JSX.Element;
+export default function ParamTextFormItem({ param }: ParamProps): React.JSX.Element;

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/ParamOptions/index.d.ts

@@ -1,7 +1,7 @@
-/// <reference types="react" />
+import React from "react";
 import { Param } from "./slice";
 export interface ParamProps {
     param: Param;
 }
-declare function ParamOptions(): JSX.Element;
+declare function ParamOptions(): React.JSX.Element;
 export default ParamOptions;

package/lib/theme/ApiExplorer/ParamOptions/slice.d.ts

@@ -1,6 +1,6 @@
 import { PayloadAction } from "@reduxjs/toolkit";
 import { ParameterObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
-export declare type Param = ParameterObject & {
+export type Param = ParameterObject & {
     value?: string[] | string;
 };
 export interface State {

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);
   }

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

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

package/lib/theme/ApiExplorer/Request/makeRequest.js

@@ -141,6 +141,10 @@ async function makeRequest(request, proxy, _body) {
             if (data.key && data.value.content) {
               myBody.append(data.key, data.value.content);
             }
+            // handle generic key-value payload
+            if (data.key && typeof data.value === "string") {
+              myBody.append(data.key, data.value);
+            }
           }
         }
         break;
@@ -166,7 +170,52 @@ async function makeRequest(request, proxy, _body) {
     let normalizedProxy = proxy.replace(/\/$/, "") + "/";
     finalUrl = normalizedProxy + request.url.toString();
   }
-  return await fetchWithtimeout(finalUrl, requestOptions).then((response) => {
+  return fetchWithtimeout(finalUrl, requestOptions).then((response) => {
+    const contentType = response.headers.get("content-type");
+    let fileExtension = "";
+    if (contentType) {
+      if (contentType.includes("application/pdf")) {
+        fileExtension = ".pdf";
+      } else if (contentType.includes("image/jpeg")) {
+        fileExtension = ".jpg";
+      } else if (contentType.includes("image/png")) {
+        fileExtension = ".png";
+      } else if (contentType.includes("image/gif")) {
+        fileExtension = ".gif";
+      } else if (contentType.includes("image/webp")) {
+        fileExtension = ".webp";
+      } else if (contentType.includes("video/mpeg")) {
+        fileExtension = ".mpeg";
+      } else if (contentType.includes("video/mp4")) {
+        fileExtension = ".mp4";
+      } else if (contentType.includes("audio/mpeg")) {
+        fileExtension = ".mp3";
+      } else if (contentType.includes("audio/ogg")) {
+        fileExtension = ".ogg";
+      } else if (contentType.includes("application/octet-stream")) {
+        fileExtension = ".bin";
+      } else if (contentType.includes("application/zip")) {
+        fileExtension = ".zip";
+      }
+      if (fileExtension) {
+        return response.blob().then((blob) => {
+          const url = window.URL.createObjectURL(blob);
+          const link = document.createElement("a");
+          link.href = url;
+          // Now the file name includes the extension
+          link.setAttribute("download", `file${fileExtension}`);
+          // These two lines are necessary to make the link click in Firefox
+          link.style.display = "none";
+          document.body.appendChild(link);
+          link.click();
+          // After link is clicked, it's safe to remove it.
+          setTimeout(() => document.body.removeChild(link), 0);
+          return response;
+        });
+      } else {
+        return response;
+      }
+    }
     return response;
   });
 }

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.d.ts

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

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;
   }
@@ -165,25 +165,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!"
-          )
     )
   );
 }