docusaurus-theme-openapi-docs 3.0.0-beta.3 → 3.0.0-beta.5

package/src/theme/OperationTabs/_OperationTabs.scss

@@ -0,0 +1,68 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+.openapi-tabs__operation-container {
+  display: flex;
+  align-items: center;
+  margin-top: 1rem;
+  overflow: hidden;
+}
+
+.openapi-tabs__operation-item {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  padding: 0.35rem 0.7rem;
+  border: 1px solid transparent;
+  margin-top: 0 !important;
+  margin-right: 0.5rem;
+  font-weight: var(--ifm-font-weight-bold);
+  font-size: 12px;
+  white-space: nowrap;
+  transition: 300ms;
+
+  &:hover {
+    background-color: transparent;
+    border: 1px solid var(--ifm-toc-border-color);
+  }
+
+  &.active {
+    border: 1px solid var(--ifm-tabs-color-active-border);
+    color: var(--ifm-tabs-color-active);
+  }
+
+  &:last-child {
+    margin-right: 0 !important;
+  }
+}
+
+.openapi-tabs__operation-list-container {
+  overflow-y: hidden;
+  overflow-x: scroll;
+  scroll-behavior: smooth;
+
+  &::-webkit-scrollbar {
+    display: none;
+  }
+}
+
+.openapi-tabs__operation-schema-container {
+  max-width: 600px;
+}
+
+@media screen and (max-width: 500px) {
+  .operationTabsTopSection {
+    flex-direction: column;
+    align-items: flex-start;
+  }
+
+  .operationTabsContainer {
+    width: 100%;
+    margin-top: var(--ifm-spacing-vertical);
+    padding: 0;
+  }
+}

package/src/theme/OperationTabs/index.tsx

@@ -0,0 +1,216 @@
+/* ============================================================================
+ * 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,
+  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,
+}: TabProps & ReturnType<typeof useTabs>) {
+  const tabRefs: (HTMLLIElement | null)[] = [];
+  const { blockElementScrollPositionUntilNextRender } =
+    useScrollPositionBlocker();
+
+  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: React.KeyboardEvent<HTMLLIElement>) => {
+    let focusElement: HTMLLIElement | null = null;
+
+    switch (event.key) {
+      case "Enter": {
+        handleTabChange(event);
+        break;
+      }
+      case "ArrowRight": {
+        const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
+        focusElement = tabRefs[nextTab] ?? tabRefs[0]!;
+        break;
+      }
+      case "ArrowLeft": {
+        const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
+        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1]!;
+        break;
+      }
+      default:
+        break;
+    }
+
+    focusElement?.focus();
+  };
+
+  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.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="tabs__container">
+      <div className="openapi-tabs__operation-container">
+        {showTabArrows && (
+          <button
+            className={clsx("openapi-tabs__arrow", "left")}
+            onClick={handleLeftClick}
+          />
+        )}
+        <ul
+          ref={tabItemListContainerRef}
+          role="tablist"
+          aria-orientation="horizontal"
+          className={clsx(
+            "openapi-tabs__operation-list-container",
+            "tabs",
+            {
+              "tabs--block": block,
+            },
+            className
+          )}
+        >
+          {tabValues.map(({ value, label, attributes }) => {
+            return (
+              <li
+                // TODO extract TabListItem
+                role="tab"
+                tabIndex={selectedValue === value ? 0 : -1}
+                aria-selected={selectedValue === value}
+                key={value}
+                ref={(tabControl) => tabRefs.push(tabControl)}
+                onKeyDown={handleKeydown}
+                onFocus={handleTabChange}
+                onClick={(e) => handleTabChange(e)}
+                {...attributes}
+                className={clsx(
+                  "tabs__item",
+                  "openapi-tabs__operation-item",
+                  attributes?.className as string,
+                  {
+                    active: selectedValue === value,
+                  }
+                )}
+              >
+                {label ?? value}
+              </li>
+            );
+          })}
+        </ul>
+        {showTabArrows && (
+          <button
+            className={clsx("openapi-tabs__arrow", "right")}
+            onClick={handleRightClick}
+          />
+        )}
+      </div>
+    </div>
+  );
+}
+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 = 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 (
+    <div className="margin-top--md">
+      {childTabs.map((tabItem, i) =>
+        cloneElement(tabItem, {
+          key: i,
+          hidden: tabItem.props.value !== selectedValue,
+        })
+      )}
+    </div>
+  );
+}
+function TabsComponent(props: TabProps): React.JSX.Element {
+  const tabs = useTabs(props);
+  return (
+    <div className="tabs-container">
+      <TabList {...props} {...tabs} />
+      <TabContent {...props} {...tabs} />
+    </div>
+  );
+}
+export default function OperationTabs(props: TabProps): React.JSX.Element {
+  const isBrowser = useIsBrowser();
+  return (
+    <TabsComponent
+      // Remount tabs after hydration
+      // 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}

@@ -10,24 +10,38 @@ import React from "react";
 import CodeBlock from "@theme/CodeBlock";
 import SchemaTabs from "@theme/SchemaTabs";
 import TabItem from "@theme/TabItem";
-/* eslint-disable import/no-extraneous-dependencies*/
-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;
+    schema: any;
+  };
+}
+
 function ParamsItem({
   param: { description, example, examples, name, required, schema },
-}) {
+}: Props) {
   if (!schema || !schema?.type) {
     schema = { type: "any" };
   }
@@ -97,6 +111,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"}>

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

@@ -5,18 +5,29 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React from "react";
+import React, { ReactNode } from "react";
 
 import CodeBlock from "@theme/CodeBlock";
-/* 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 { guard } from "docusaurus-theme-openapi-docs/lib/markdown/utils";
 import ReactMarkdown from "react-markdown";
 import rehypeRaw from "rehype-raw";
 
-function SchemaItem({
+import { createDescription } from "../../markdown/createDescription";
+import { guard } from "../../markdown/utils";
+
+export interface Props {
+  children: ReactNode;
+  collapsible: boolean;
+  name: string;
+  qualifierMessage: string | undefined;
+  required: boolean;
+  schemaName: string;
+  // TODO should probably be typed
+  schema: any;
+  discriminator: boolean;
+}
+
+export default function SchemaItem({
   children: collapsibleSchemaContent,
   collapsible,
   name,
@@ -24,7 +35,7 @@ function SchemaItem({
   required,
   schemaName,
   schema,
-}) {
+}: Props) {
   let deprecated;
   let schemaDescription;
   let defaultValue;
@@ -119,5 +130,3 @@ function SchemaItem({
     </div>
   );
 }
-
-export default SchemaItem;

package/src/theme/SchemaTabs/{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;
+
     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);
@@ -37,27 +61,28 @@ 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) {
+        if (entry.target.clientWidth < entry.target.scrollWidth) {
           setShowTabArrows(true);
         } else {
           setShowTabArrows(false);
@@ -65,7 +90,7 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
       }
     });
 
-    resizeObserver.observe(tabItemListContainerRef.current);
+    resizeObserver.observe(tabItemListContainerRef.current!);
 
     return () => {
       resizeObserver.disconnect();
@@ -73,11 +98,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 (
@@ -115,7 +140,7 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
             className={clsx(
               "tabs__item",
               "openapi-tabs__schema-item",
-              attributes?.className,
+              attributes?.className as string,
               {
                 active: selectedValue === value,
               }
@@ -134,13 +159,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];
-  const flattenedChildren = flatten(children);
-
+function TabContent({
+  lazy,
+  children,
+  selectedValue,
+}: TabProps & ReturnType<typeof useTabs>) {
+  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) {
@@ -151,7 +180,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,
@@ -160,7 +189,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__schema-container">
@@ -169,7 +198,7 @@ function TabsComponent(props) {
     </div>
   );
 }
-export default function SchemaTabs(props) {
+export default function SchemaTabs(props: TabProps): React.JSX.Element {
   const isBrowser = useIsBrowser();
   return (
     <TabsComponent
@@ -177,6 +206,8 @@ export default function SchemaTabs(props) {
       // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
       key={String(isBrowser)}
       {...props}
-    />
+    >
+      {sanitizeTabsChildren(props.children)}
+    </TabsComponent>
   );
 }

package/src/theme/styles.scss

@@ -36,6 +36,7 @@
 @use "./DiscriminatorTabs/DiscriminatorTabs";
 @use "./MimeTabs/MimeTabs";
 @use "./SchemaTabs/SchemaTabs";
+@use "./OperationTabs/OperationTabs";
 /* Code Samples */
 @use "./ResponseSamples/ResponseSamples";
 /* Markdown Styling */

package/src/theme-classic.d.ts

@@ -8,6 +8,73 @@
 /// <reference types="@docusaurus/theme-classic" />
 
 declare module "@docusaurus/theme-common/internal" {
-  function useDoc(): any;
-  export const { useDoc };
+  import { CSSProperties, ReactNode, RefObject } from "react";
+
+  import type { PropDocContent } from "@docusaurus/plugin-content-docs";
+  import { MagicCommentConfig } from "@docusaurus/theme-common/lib/utils/codeBlockUtils";
+  import {
+    TabsProps as ITabsProps,
+    TabValue,
+  } from "@docusaurus/theme-common/lib/utils/tabsUtils";
+  import { Props as ICodeBlockProps } from "@theme/CodeBlock";
+  import { Props as ICopyButtonProps } from "@theme/CodeBlock/CopyButton";
+  import { Props as ILineProps } from "@theme/CodeBlock/Line";
+  import { PrismTheme } from "prism-react-renderer";
+
+  export interface TabProps extends ITabsProps {}
+
+  export interface CopyButtonProps extends ICopyButtonProps {}
+  export interface LineProps extends ILineProps {}
+  export interface CodeBlockProps extends ICodeBlockProps {}
+
+  export function useDoc();
+
+  export function usePrismTheme(): PrismTheme;
+
+  export function sanitizeTabsChildren(children: TabProps["children"]);
+
+  export function getPrismCssVariables(prismTheme: PrismTheme): CSSProperties;
+
+  export function parseCodeBlockTitle(metastring?: string): string;
+
+  export function parseLanguage(className: string): string | undefined;
+
+  export function containsLineNumbers(metastring?: string): boolean;
+
+  export function useScrollPositionBlocker(): {
+    blockElementScrollPositionUntilNextRender: (el: HTMLElement) => void;
+  };
+
+  export function DocProvider({
+    children,
+    content,
+  }: {
+    children: ReactNode;
+    content: PropDocContent;
+  });
+
+  export function useTabs(props: TabProps): {
+    selectedValue: string;
+    selectValue: (value: string) => void;
+    tabValues: readonly TabValue[];
+  };
+
+  export function parseLines(
+    content: string,
+    options: {
+      metastring: string | undefined;
+      language: string | undefined;
+      magicComments: MagicCommentConfig[];
+    }
+  ): {
+    lineClassNames: { [lineIndex: number]: string[] };
+    code: string;
+  };
+
+  export function useCodeWordWrap(): {
+    readonly codeBlockRef: RefObject<HTMLPreElement>;
+    readonly isEnabled: boolean;
+    readonly isCodeScrollable: boolean;
+    readonly toggle: () => void;
+  };
 }

package/src/theme-openapi.d.ts

@@ -65,6 +65,10 @@ declare module "@theme/SchemaTabs" {
   export default function SchemaTabs(props: any): JSX.Element;
 }
 
+declare module "@theme/Markdown" {
+  export default function Markdown(props: any): JSX.Element;
+}
+
 declare module "@theme/ApiExplorer/Accept" {
   export default function Accept(): JSX.Element;
 }