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

package/src/theme/ApiExplorer/CodeTabs/{index.js → index.tsx}

@@ -5,34 +5,57 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { cloneElement } from "react";
+import React, { cloneElement, ReactElement } from "react";
 
 import {
+  sanitizeTabsChildren,
+  type TabProps,
   useScrollPositionBlocker,
   useTabs,
 } from "@docusaurus/theme-common/internal";
+import { TabItemProps } from "@docusaurus/theme-common/lib/utils/tabsUtils";
 import useIsBrowser from "@docusaurus/useIsBrowser";
-import { languageSet } from "@theme/ApiExplorer/CodeSnippets";
+import { Language } from "@theme/ApiExplorer/CodeSnippets";
 import clsx from "clsx";
 
+export interface Props {
+  action: {
+    [key: string]: React.Dispatch<any>;
+  };
+  currentLanguage: Language;
+  languageSet: Language[];
+  includeVariant: boolean;
+}
+
+export interface CodeTabsProps extends Props, TabProps {
+  includeSample?: boolean;
+}
+
 function TabList({
   action,
   currentLanguage,
+  languageSet,
   includeVariant,
+  includeSample,
   className,
   block,
   selectedValue,
   selectValue,
   tabValues,
-}) {
-  const tabRefs = [];
+}: CodeTabsProps & ReturnType<typeof useTabs>) {
+  const tabRefs: (HTMLLIElement | null)[] = [];
   const { blockElementScrollPositionUntilNextRender } =
     useScrollPositionBlocker();
 
-  const handleTabChange = (event) => {
+  const handleTabChange = (
+    event:
+      | React.FocusEvent<HTMLLIElement>
+      | React.MouseEvent<HTMLLIElement>
+      | React.KeyboardEvent<HTMLLIElement>
+  ) => {
     const newTab = event.currentTarget;
     const newTabIndex = tabRefs.indexOf(newTab);
-    const newTabValue = tabValues[newTabIndex].value;
+    const newTabValue = tabValues[newTabIndex]!.value;
 
     if (newTabValue !== selectedValue) {
       blockElementScrollPositionUntilNextRender(newTab);
@@ -40,25 +63,33 @@ function TabList({
     }
 
     if (action) {
-      let newLanguage;
+      let newLanguage: Language;
       if (currentLanguage && includeVariant) {
         newLanguage = languageSet.filter(
-          (lang) => lang.language === currentLanguage
+          (lang: Language) => lang.language === currentLanguage
         )[0];
         newLanguage.variant = newTabValue;
         action.setSelectedVariant(newTabValue.toLowerCase());
+      } else if (currentLanguage && includeSample) {
+        newLanguage = languageSet.filter(
+          (lang: Language) => lang.language === currentLanguage
+        )[0];
+        newLanguage.sample = newTabValue;
+        action.setSelectedSample(newTabValue);
       } else {
         newLanguage = languageSet.filter(
-          (lang) => lang.language === newTabValue
+          (lang: Language) => lang.language === newTabValue
         )[0];
         action.setSelectedVariant(newLanguage.variant.toLowerCase());
+        action.setSelectedSample(newLanguage.sample);
       }
       action.setLanguage(newLanguage);
     }
   };
 
-  const handleKeydown = (event) => {
-    let focusElement = null;
+  const handleKeydown = (event: React.KeyboardEvent<HTMLLIElement>) => {
+    let focusElement: HTMLLIElement | null = null;
+
     switch (event.key) {
       case "Enter": {
         handleTabChange(event);
@@ -66,17 +97,18 @@ function TabList({
       }
       case "ArrowRight": {
         const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
-        focusElement = tabRefs[nextTab] ?? tabRefs[0];
+        focusElement = tabRefs[nextTab] ?? tabRefs[0]!;
         break;
       }
       case "ArrowLeft": {
         const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
-        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1];
+        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1]!;
         break;
       }
       default:
         break;
     }
+
     focusElement?.focus();
   };
 
@@ -107,7 +139,7 @@ function TabList({
           className={clsx(
             "tabs__item",
             "openapi-tabs__code-item",
-            attributes?.className,
+            attributes?.className as string,
             {
               active: selectedValue === value,
             }
@@ -120,11 +152,16 @@ function TabList({
   );
 }
 
-function TabContent({ lazy, children, selectedValue }) {
-  // eslint-disable-next-line no-param-reassign
-  children = Array.isArray(children) ? children : [children];
+function TabContent({
+  lazy,
+  children,
+  selectedValue,
+}: CodeTabsProps & ReturnType<typeof useTabs>): React.JSX.Element | null {
+  const childTabs = (Array.isArray(children) ? children : [children]).filter(
+    Boolean
+  ) as ReactElement<TabItemProps>[];
   if (lazy) {
-    const selectedTabItem = children.find(
+    const selectedTabItem = childTabs.find(
       (tabItem) => tabItem.props.value === selectedValue
     );
     if (!selectedTabItem) {
@@ -135,7 +172,7 @@ function TabContent({ lazy, children, selectedValue }) {
   }
   return (
     <div className="margin-top--md openapi-tabs__code-content">
-      {children.map((tabItem, i) =>
+      {childTabs.map((tabItem, i) =>
         cloneElement(tabItem, {
           key: i,
           hidden: tabItem.props.value !== selectedValue,
@@ -145,15 +182,13 @@ function TabContent({ lazy, children, selectedValue }) {
   );
 }
 
-function TabsComponent(props) {
+function TabsComponent(props: CodeTabsProps & Props): React.JSX.Element {
   const tabs = useTabs(props);
   const { className } = props;
 
   return (
     <div
-      className={clsx("tabs-container openapi-tabs__code-container", {
-        [className]: className,
-      })}
+      className={clsx("tabs-container openapi-tabs__code-container", className)}
     >
       <TabList {...props} {...tabs} />
       <TabContent {...props} {...tabs} />
@@ -161,7 +196,9 @@ function TabsComponent(props) {
   );
 }
 
-export default function CodeTabs(props) {
+export default function CodeTabs(
+  props: CodeTabsProps & Props
+): React.JSX.Element {
   const isBrowser = useIsBrowser();
   return (
     <TabsComponent
@@ -169,6 +206,8 @@ export default function CodeTabs(props) {
       // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
       key={String(isBrowser)}
       {...props}
-    />
+    >
+      {sanitizeTabsChildren(props.children)}
+    </TabsComponent>
   );
 }

package/src/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/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.tsx

@@ -37,10 +37,10 @@ export default function ParamMultiSelectFormItem({ param }: ParamProps) {
   const paramTypeToWatch = pathParams.length
     ? pathParams
     : queryParams.length
-    ? queryParams
-    : cookieParams.length
-    ? cookieParams
-    : headerParams;
+      ? queryParams
+      : cookieParams.length
+        ? cookieParams
+        : headerParams;
 
   const handleChange = (e: any, onChange: any) => {
     const values = Array.prototype.filter

package/src/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/src/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/src/theme/ApiExplorer/Request/makeRequest.ts

@@ -161,6 +161,10 @@ async function makeRequest(
             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;
@@ -189,11 +193,62 @@ async function makeRequest(
     finalUrl = normalizedProxy + request.url.toString();
   }
 
-  return await fetchWithtimeout(finalUrl, requestOptions).then(
-    (response: any) => {
-      return response;
+  return fetchWithtimeout(finalUrl, requestOptions).then((response: any) => {
+    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: any) => {
+          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;
+  });
 }
 
 export default makeRequest;

package/src/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/src/theme/ApiExplorer/Response/index.tsx

@@ -52,8 +52,8 @@ function Response({ item }: { item: NonNullable<ApiItem> }) {
       (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;

package/src/theme/ApiExplorer/index.tsx

@@ -27,7 +27,7 @@ function ApiExplorer({
       {item.method !== "event" && (
         <CodeSnippets
           postman={postman}
-          codeSamples={(item as any)["x-code-samples"] ?? []}
+          codeSamples={(item as any)["x-codeSamples"] ?? []}
         />
       )}
       <Request item={item} />

package/src/theme/ApiItem/index.tsx

@@ -12,6 +12,7 @@ import React from "react";
 import BrowserOnly from "@docusaurus/BrowserOnly";
 import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
 import { HtmlClassNameProvider } from "@docusaurus/theme-common";
+import { DocProvider } from "@docusaurus/theme-common/internal";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import useIsBrowser from "@docusaurus/useIsBrowser";
 import { createAuth } from "@theme/ApiExplorer/Authorization/slice";
@@ -23,7 +24,6 @@ import clsx from "clsx";
 import { ServerObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
 import { ParameterObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
 import type { ApiItem as ApiItemType } from "docusaurus-plugin-openapi-docs/src/types";
-/* eslint-disable import/no-extraneous-dependencies*/
 import type {
   DocFrontMatter,
   ThemeConfig,
@@ -32,8 +32,6 @@ import { Provider } from "react-redux";
 
 import { createStoreWithoutState, createStoreWithState } from "./store";
 
-const { DocProvider } = require("@docusaurus/theme-common/internal");
-
 let ApiExplorer = (_: { item: any; infoPath: any }) => <div />;
 
 if (ExecutionEnvironment.canUseDOM) {
@@ -44,12 +42,18 @@ interface ApiFrontMatter extends DocFrontMatter {
   readonly api?: ApiItemType;
 }
 
+interface SchemaFrontMatter extends DocFrontMatter {
+  readonly schema?: boolean;
+}
+
+// @ts-ignore
 export default function ApiItem(props: Props): JSX.Element {
   const docHtmlClassName = `docs-doc-id-${props.content.metadata.id}`;
   const MDXComponent = props.content;
   const { frontMatter } = MDXComponent;
   const { info_path: infoPath } = frontMatter as DocFrontMatter;
   let { api } = frontMatter as ApiFrontMatter;
+  const { schema } = frontMatter as SchemaFrontMatter;
   // decompress and parse
   if (api) {
     api = JSON.parse(
@@ -159,6 +163,21 @@ export default function ApiItem(props: Props): JSX.Element {
         </HtmlClassNameProvider>
       </DocProvider>
     );
+  } else if (schema) {
+    return (
+      <DocProvider content={props.content}>
+        <HtmlClassNameProvider className={docHtmlClassName}>
+          <DocItemMetadata />
+          <DocItemLayout>
+            <div className={clsx("row", "theme-api-markdown")}>
+              <div className="col col--12">
+                <MDXComponent />
+              </div>
+            </div>
+          </DocItemLayout>
+        </HtmlClassNameProvider>
+      </DocProvider>
+    );
   }
 
   // Non-API docs

package/src/theme/ApiLogo/index.tsx

@@ -11,7 +11,7 @@ import { useColorMode } from "@docusaurus/theme-common";
 import useBaseUrl from "@docusaurus/useBaseUrl";
 import ThemedImage from "@theme/ThemedImage";
 
-export default function ApiLogo(props: any): JSX.Element | undefined {
+export default function ApiLogo(props: any): React.JSX.Element | undefined {
   const { colorMode } = useColorMode();
   const { logo, darkLogo } = props;
   const altText = () => {

package/src/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/src/theme/ApiTabs/{index.js → index.tsx}

@@ -5,33 +5,62 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { cloneElement, useRef, useState, useEffect } from "react";
+import React, {
+  cloneElement,
+  useRef,
+  useState,
+  useEffect,
+  ReactElement,
+} from "react";
 
 import {
+  sanitizeTabsChildren,
+  TabProps,
   useScrollPositionBlocker,
   useTabs,
 } from "@docusaurus/theme-common/internal";
+import { TabItemProps } from "@docusaurus/theme-common/lib/utils/tabsUtils";
 import useIsBrowser from "@docusaurus/useIsBrowser";
 import Heading from "@theme/Heading";
 import clsx from "clsx";
 
-function TabList({ className, block, selectedValue, selectValue, tabValues }) {
-  const tabRefs = [];
+export interface TabListProps extends TabProps {
+  label: string;
+  id: string;
+}
+
+function TabList({
+  className,
+  block,
+  selectedValue,
+  selectValue,
+  tabValues,
+  label = "Responses",
+  id = "responses",
+}: TabListProps & ReturnType<typeof useTabs>) {
+  const tabRefs: (HTMLLIElement | null)[] = [];
   const { blockElementScrollPositionUntilNextRender } =
     useScrollPositionBlocker();
 
-  const handleTabChange = (event) => {
+  const handleTabChange = (
+    event:
+      | React.FocusEvent<HTMLLIElement>
+      | React.MouseEvent<HTMLLIElement>
+      | React.KeyboardEvent<HTMLLIElement>
+  ) => {
     const newTab = event.currentTarget;
     const newTabIndex = tabRefs.indexOf(newTab);
     const newTabValue = tabValues[newTabIndex].value;
+
     if (newTabValue !== selectedValue) {
       blockElementScrollPositionUntilNextRender(newTab);
       selectValue(newTabValue);
     }
   };
 
-  const handleKeydown = (event) => {
-    let focusElement = null;
+  const handleKeydown = (event: React.KeyboardEvent<HTMLLIElement>) => {
+    let focusElement: HTMLLIElement | null = null;
+
     switch (event.key) {
       case "Enter": {
         handleTabChange(event);
@@ -39,35 +68,38 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
       }
       case "ArrowRight": {
         const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
-        focusElement = tabRefs[nextTab] ?? tabRefs[0];
+        focusElement = tabRefs[nextTab] ?? tabRefs[0]!;
         break;
       }
       case "ArrowLeft": {
         const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
-        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1];
+        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1]!;
         break;
       }
       default:
         break;
     }
+
     focusElement?.focus();
   };
 
-  const tabItemListContainerRef = useRef(null);
-  const [showTabArrows, setShowTabArrows] = useState(false);
+  const tabItemListContainerRef = useRef<HTMLUListElement>(null);
+  const [showTabArrows, setShowTabArrows] = useState<boolean>(false);
 
   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);
+    resizeObserver.observe(tabItemListContainerRef.current!);
 
     return () => {
       resizeObserver.disconnect();
@@ -75,17 +107,21 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
   }, []);
 
   const handleRightClick = () => {
-    tabItemListContainerRef.current.scrollLeft += 90;
+    tabItemListContainerRef.current!.scrollLeft += 90;
   };
 
   const handleLeftClick = () => {
-    tabItemListContainerRef.current.scrollLeft -= 90;
+    tabItemListContainerRef.current!.scrollLeft -= 90;
   };
 
   return (
     <div className="openapi-tabs__response-header-section">
-      <Heading as="h2" id="responses" className="openapi-tabs__response-header">
-        Responses
+      <Heading
+        as="h2"
+        id={id}
+        className="openapi-tabs__heading openapi-tabs__response-header"
+      >
+        {label}
       </Heading>
       <div className="openapi-tabs__response-container">
         {showTabArrows && (
@@ -121,12 +157,12 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
               className={clsx(
                 "tabs__item",
                 "openapi-tabs__response-code-item",
-                attributes?.className,
+                attributes?.className as string,
                 parseInt(value) >= 400
                   ? "danger"
                   : parseInt(value) >= 200 && parseInt(value) < 300
-                  ? "success"
-                  : "info",
+                    ? "success"
+                    : "info",
                 {
                   active: selectedValue === value,
                 }
@@ -146,11 +182,17 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
     </div>
   );
 }
-function TabContent({ lazy, children, selectedValue }) {
-  // eslint-disable-next-line no-param-reassign
-  children = Array.isArray(children) ? children : [children];
+
+function TabContent({
+  lazy,
+  children,
+  selectedValue,
+}: TabProps & ReturnType<typeof useTabs>): React.JSX.Element | null {
+  const childTabs = (Array.isArray(children) ? children : [children]).filter(
+    Boolean
+  ) as ReactElement<TabItemProps>[];
   if (lazy) {
-    const selectedTabItem = children.find(
+    const selectedTabItem = childTabs.find(
       (tabItem) => tabItem.props.value === selectedValue
     );
     if (!selectedTabItem) {
@@ -161,7 +203,7 @@ function TabContent({ lazy, children, selectedValue }) {
   }
   return (
     <div className="margin-top--md">
-      {children.map((tabItem, i) =>
+      {childTabs.map((tabItem, i) =>
         cloneElement(tabItem, {
           key: i,
           hidden: tabItem.props.value !== selectedValue,
@@ -170,7 +212,7 @@ function TabContent({ lazy, children, selectedValue }) {
     </div>
   );
 }
-function TabsComponent(props) {
+function TabsComponent(props: TabListProps): React.JSX.Element {
   const tabs = useTabs(props);
   return (
     <div className="openapi-tabs__container">
@@ -179,7 +221,7 @@ function TabsComponent(props) {
     </div>
   );
 }
-export default function ApiTabs(props) {
+export default function ApiTabs(props: TabListProps): React.JSX.Element {
   const isBrowser = useIsBrowser();
   return (
     <TabsComponent
@@ -187,6 +229,8 @@ export default function ApiTabs(props) {
       // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
       key={String(isBrowser)}
       {...props}
-    />
+    >
+      {sanitizeTabsChildren(props.children)}
+    </TabsComponent>
   );
 }