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

package/src/theme/DiscriminatorTabs/{index.js → index.tsx}

@@ -5,31 +5,55 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { cloneElement, useRef, useEffect, useState } from "react";
+import React, {
+  cloneElement,
+  useRef,
+  useEffect,
+  useState,
+  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 clsx from "clsx";
 import flatten from "lodash/flatten";
 
-function TabList({ className, block, selectedValue, selectValue, tabValues }) {
-  const tabRefs = [];
+function TabList({
+  className,
+  block,
+  selectedValue,
+  selectValue,
+  tabValues,
+}: TabProps & 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);
       selectValue(newTabValue);
     }
   };
-  const handleKeydown = (event) => {
+
+  const handleKeydown = (event: React.KeyboardEvent<HTMLLIElement>) => {
     let focusElement = null;
+
     switch (event.key) {
       case "Enter": {
         handleTabChange(event);
@@ -37,28 +61,29 @@ 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) {
         requestAnimationFrame(() => {
-          if (entry.target.offsetWidth < entry.target.scrollWidth) {
+          if (entry.target.clientWidth < entry.target.scrollWidth) {
             setShowTabArrows(true);
           } else {
             setShowTabArrows(false);
@@ -67,7 +92,7 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
       }
     });
 
-    resizeObserver.observe(tabItemListContainerRef.current);
+    resizeObserver.observe(tabItemListContainerRef.current!);
 
     return () => {
       resizeObserver.disconnect();
@@ -75,11 +100,11 @@ 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 (
@@ -118,7 +143,7 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
               className={clsx(
                 "tabs__item",
                 "openapi-tabs__discriminator-item",
-                attributes?.className,
+                attributes?.className as string,
                 {
                   active: selectedValue === value,
                 }
@@ -140,12 +165,18 @@ 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];
-  const flattenedChildren = flatten(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>[];
+  const flattenedChildTabs = flatten(childTabs);
   if (lazy) {
-    const selectedTabItem = flattenedChildren.find(
+    const selectedTabItem = flattenedChildTabs.find(
       (tabItem) => tabItem.props.value === selectedValue
     );
     if (!selectedTabItem) {
@@ -156,7 +187,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,
@@ -165,7 +196,7 @@ function TabContent({ lazy, children, selectedValue }) {
     </div>
   );
 }
-function TabsComponent(props) {
+function TabsComponent(props: TabProps): React.JSX.Element {
   const tabs = useTabs(props);
   return (
     <div className="openapi-tabs__container">
@@ -174,7 +205,7 @@ function TabsComponent(props) {
     </div>
   );
 }
-export default function DiscriminatorTabs(props) {
+export default function DiscriminatorTabs(props: TabProps): React.JSX.Element {
   const isBrowser = useIsBrowser();
   return (
     <TabsComponent
@@ -182,6 +213,8 @@ export default function DiscriminatorTabs(props) {
       // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
       key={String(isBrowser)}
       {...props}
-    />
+    >
+      {sanitizeTabsChildren(props.children)}
+    </TabsComponent>
   );
 }

package/src/theme/MimeTabs/{index.js → index.tsx}

@@ -5,18 +5,32 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { cloneElement, useEffect, useState, useRef } from "react";
+import React, {
+  cloneElement,
+  useEffect,
+  useState,
+  useRef,
+  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 { setAccept } from "@theme/ApiExplorer/Accept/slice";
+import setAccept from "@theme/ApiExplorer/Accept/slice";
 import { setContentType } from "@theme/ApiExplorer/ContentType/slice";
 import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
+import { RootState } from "@theme/ApiItem/store";
 import clsx from "clsx";
 
+export interface Props {
+  schemaType: any;
+}
+
 function TabList({
   className,
   block,
@@ -24,8 +38,8 @@ function TabList({
   selectValue,
   tabValues,
   schemaType,
-}) {
-  const tabRefs = [];
+}: Props & TabProps & ReturnType<typeof useTabs>): React.JSX.Element {
+  const tabRefs: (HTMLLIElement | null)[] = [];
   const { blockElementScrollPositionUntilNextRender } =
     useScrollPositionBlocker();
 
@@ -34,8 +48,12 @@ function TabList({
   const isRequestSchema = schemaType?.toLowerCase() === "request";
 
   const [selectedValue, setSelectedValue] = useState(selectedValueProp);
-  const contentTypeVal = useTypedSelector((state) => state.contentType.value);
-  const acceptTypeVal = useTypedSelector((state) => state.accept.value);
+  const contentTypeVal = useTypedSelector(
+    (state: RootState) => state.contentType.value
+  );
+  const acceptTypeVal = useTypedSelector(
+    (state: RootState) => state.accept.value
+  );
 
   useEffect(() => {
     if (tabRefs.length > 1) {
@@ -48,7 +66,12 @@ function TabList({
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [contentTypeVal, acceptTypeVal]);
 
-  const handleTabChange = (event) => {
+  const handleTabChange = (
+    event:
+      | React.FocusEvent<HTMLLIElement>
+      | React.MouseEvent<HTMLLIElement>
+      | React.KeyboardEvent<HTMLLIElement>
+  ) => {
     event.preventDefault();
     const newTab = event.currentTarget;
     const newTabIndex = tabRefs.indexOf(newTab);
@@ -65,8 +88,9 @@ function TabList({
     }
   };
 
-  const handleKeydown = (event) => {
-    let focusElement = null;
+  const handleKeydown = (event: React.KeyboardEvent<HTMLLIElement>) => {
+    let focusElement: HTMLLIElement | null = null;
+
     switch (event.key) {
       case "Enter": {
         handleTabChange(event);
@@ -74,28 +98,29 @@ 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();
   };
 
-  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) {
         requestAnimationFrame(() => {
-          if (entry.target.offsetWidth < entry.target.scrollWidth) {
+          if (entry.target.clientWidth < entry.target.scrollWidth) {
             setShowTabArrows(true);
           } else {
             setShowTabArrows(false);
@@ -104,7 +129,7 @@ function TabList({
       }
     });
 
-    resizeObserver.observe(tabItemListContainerRef.current);
+    resizeObserver.observe(tabItemListContainerRef.current!);
 
     return () => {
       resizeObserver.disconnect();
@@ -112,11 +137,11 @@ function TabList({
   }, []);
 
   const handleRightClick = () => {
-    tabItemListContainerRef.current.scrollLeft += 90;
+    tabItemListContainerRef.current!.scrollLeft += 90;
   };
 
   const handleLeftClick = () => {
-    tabItemListContainerRef.current.scrollLeft -= 90;
+    tabItemListContainerRef.current!.scrollLeft -= 90;
   };
 
   return (
@@ -156,7 +181,7 @@ function TabList({
                 className={clsx(
                   "tabs__item",
                   "openapi-tabs__mime-item",
-                  attributes?.className,
+                  attributes?.className as string,
                   {
                     active: selectedValue === value,
                   }
@@ -177,11 +202,16 @@ function TabList({
     </div>
   );
 }
-function TabContent({ lazy, children, selectedValue }) {
-  // eslint-disable-next-line no-param-reassign
-  children = Array.isArray(children) ? children : [children];
+function TabContent({
+  lazy,
+  children,
+  selectedValue,
+}: Props & TabProps & ReturnType<typeof useTabs>) {
+  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) {
@@ -192,7 +222,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,
@@ -201,7 +231,7 @@ function TabContent({ lazy, children, selectedValue }) {
     </div>
   );
 }
-function TabsComponent(props) {
+function TabsComponent(props: Props & TabProps): React.JSX.Element {
   const tabs = useTabs(props);
   return (
     <div className="tabs-container">
@@ -210,7 +240,7 @@ function TabsComponent(props) {
     </div>
   );
 }
-export default function MimeTabs(props) {
+export default function MimeTabs(props: Props & TabProps) {
   const isBrowser = useIsBrowser();
   return (
     <TabsComponent
@@ -218,6 +248,8 @@ export default function MimeTabs(props) {
       // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
       key={String(isBrowser)}
       {...props}
-    />
+    >
+      {sanitizeTabsChildren(props.children)}
+    </TabsComponent>
   );
 }

package/src/theme/OperationTabs/_OperationTabs.scss

@@ -8,10 +8,13 @@
 .openapi-tabs__operation-container {
   display: flex;
   align-items: center;
-  margin-top: 1rem;
   overflow: hidden;
 }
 
+.openapi-tabs__operation-header {
+  margin-bottom: 0;
+}
+
 .openapi-tabs__operation-item {
   display: flex;
   align-items: center;

package/src/theme/OperationTabs/{index.js → index.tsx}

@@ -5,34 +5,54 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { cloneElement, useEffect, useState, useRef } from "react";
+import React, {
+  cloneElement,
+  useEffect,
+  useState,
+  useRef,
+  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 clsx from "clsx";
 
-function TabList({ className, block, selectedValue, selectValue, tabValues }) {
-  const tabRefs = [];
+function TabList({
+  className,
+  block,
+  selectedValue,
+  selectValue,
+  tabValues,
+}: TabProps & ReturnType<typeof useTabs>) {
+  const tabRefs: (HTMLLIElement | null)[] = [];
   const { blockElementScrollPositionUntilNextRender } =
     useScrollPositionBlocker();
 
-  const handleTabChange = (event) => {
-    event.preventDefault();
+  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;
-    // custom
+
     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);
@@ -40,28 +60,29 @@ 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) {
         requestAnimationFrame(() => {
-          if (entry.target.offsetWidth < entry.target.scrollWidth) {
+          if (entry.target.clientWidth < entry.target.scrollWidth) {
             setShowTabArrows(true);
           } else {
             setShowTabArrows(false);
@@ -70,7 +91,7 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
       }
     });
 
-    resizeObserver.observe(tabItemListContainerRef.current);
+    resizeObserver.observe(tabItemListContainerRef.current!);
 
     return () => {
       resizeObserver.disconnect();
@@ -78,11 +99,11 @@ 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 (
@@ -110,6 +131,7 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
           {tabValues.map(({ value, label, attributes }) => {
             return (
               <li
+                // TODO extract TabListItem
                 role="tab"
                 tabIndex={selectedValue === value ? 0 : -1}
                 aria-selected={selectedValue === value}
@@ -122,7 +144,7 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
                 className={clsx(
                   "tabs__item",
                   "openapi-tabs__operation-item",
-                  attributes?.className,
+                  attributes?.className as string,
                   {
                     active: selectedValue === value,
                   }
@@ -143,11 +165,16 @@ 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) {
@@ -158,7 +185,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,
@@ -167,7 +194,7 @@ function TabContent({ lazy, children, selectedValue }) {
     </div>
   );
 }
-function TabsComponent(props) {
+function TabsComponent(props: TabProps): React.JSX.Element {
   const tabs = useTabs(props);
   return (
     <div className="tabs-container">
@@ -176,7 +203,7 @@ function TabsComponent(props) {
     </div>
   );
 }
-export default function OperationTabs(props) {
+export default function OperationTabs(props: TabProps): React.JSX.Element {
   const isBrowser = useIsBrowser();
   return (
     <TabsComponent
@@ -184,6 +211,8 @@ export default function OperationTabs(props) {
       // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
       key={String(isBrowser)}
       {...props}
-    />
+    >
+      {sanitizeTabsChildren(props.children)}
+    </TabsComponent>
   );
 }

package/src/theme/ParamsItem/{index.js → index.tsx}

@@ -12,23 +12,39 @@ import SchemaTabs from "@theme/SchemaTabs";
 import TabItem from "@theme/TabItem";
 /* 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 {
-  getQualifierMessage,
-  getSchemaName,
-} from "docusaurus-theme-openapi-docs/lib/markdown/schema";
-/* eslint-disable import/no-extraneous-dependencies*/
-import {
-  guard,
-  toString,
-} from "docusaurus-theme-openapi-docs/lib/markdown/utils";
 import ReactMarkdown from "react-markdown";
 import rehypeRaw from "rehype-raw";
 
+import { createDescription } from "../../markdown/createDescription";
+import { getQualifierMessage, getSchemaName } from "../../markdown/schema";
+import { guard, toString } from "../../markdown/utils";
+
+interface Map<T> {
+  [key: string]: T;
+}
+
+export interface ExampleObject {
+  summary?: string;
+  description?: string;
+  value?: any;
+  externalValue?: string;
+}
+
+export interface Props {
+  param: {
+    description: string;
+    example: any;
+    examples: Map<ExampleObject>;
+    name: string;
+    required: boolean;
+    deprecated: boolean;
+    schema: any;
+  };
+}
+
 function ParamsItem({
   param: { description, example, examples, name, required, schema, deprecated },
-}) {
+}: Props) {
   if (!schema || !schema?.type) {
     schema = { type: "any" };
   }
@@ -79,8 +95,8 @@ function ParamsItem({
     schema && schema.items
       ? schema.items.default
       : schema
-      ? schema.default
-      : undefined,
+        ? schema.default
+        : undefined,
     (value) => (
       <div>
         <ReactMarkdown children={`**Default value:** \`${value}\``} />
@@ -102,6 +118,7 @@ function ParamsItem({
         <strong>Examples:</strong>
         <SchemaTabs>
           {exampleEntries.map(([exampleName, exampleProperties]) => (
+            // @ts-ignore
             <TabItem value={exampleName} label={exampleName}>
               {exampleProperties.summary && <p>{exampleProperties.summary}</p>}
               {exampleProperties.description && (

package/src/theme/ResponseSamples/{index.js → index.tsx}

@@ -8,8 +8,17 @@
 import React from "react";
 
 import CodeBlock from "@theme/CodeBlock";
+import { Language } from "prism-react-renderer";
 
-function ResponseSamples({ responseExample, language }) {
+export interface Props {
+  readonly responseExample: string;
+  readonly language: Language;
+}
+
+function ResponseSamples({
+  responseExample,
+  language,
+}: Props): React.JSX.Element {
   return (
     <div className="openapi-code__response-samples-container">
       <CodeBlock language={language ? language : "json"}>