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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-740",
+  "version": "0.0.0-751",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -28,27 +28,28 @@
     "watch": "concurrently --names \"lib,lib-next,tsc\" --kill-others \"yarn babel:lib --watch\" \"yarn babel:lib-next --watch\" \"yarn tsc --watch\""
   },
   "devDependencies": {
-    "@docusaurus/types": ">=2.4.1 <=2.4.3",
+    "@docusaurus/types": "^3.0.1",
     "@types/crypto-js": "^4.1.0",
     "@types/file-saver": "^2.0.5",
     "@types/lodash": "^4.14.176",
-    "concurrently": "^5.2.0"
+    "concurrently": "^5.2.0",
+    "eslint-plugin-prettier": "^5.0.1"
   },
   "dependencies": {
-    "@docusaurus/theme-common": ">=2.4.1 <=2.4.3",
+    "@docusaurus/theme-common": "^3.0.1",
     "@hookform/error-message": "^2.0.1",
     "@reduxjs/toolkit": "^1.7.1",
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.1.0",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi-docs": "0.0.0-740",
+    "docusaurus-plugin-openapi-docs": "0.0.0-751",
     "docusaurus-plugin-sass": "^0.2.3",
     "file-saver": "^2.0.5",
     "lodash": "^4.17.20",
     "node-polyfill-webpack-plugin": "^2.0.1",
     "postman-code-generators": "^1.10.1",
     "postman-collection": "^4.4.0",
-    "prism-react-renderer": "^1.3.5",
+    "prism-react-renderer": "^2.3.0",
     "react-hook-form": "^7.43.8",
     "react-live": "^4.0.0",
     "react-magic-dropzone": "^1.0.1",
@@ -68,5 +69,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "ffc1156c334baa55d6abe7a181caae853556f2b0"
+  "gitHead": "87427f0ab49405d1aef03436e5c5babc9641dd45"
 }

package/src/markdown/utils.ts

@@ -5,7 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-export type Children = string | undefined | (string | undefined)[];
+import { ReactNode } from "react";
+
+export type Children = ReactNode | string | undefined | (string | undefined)[];
 
 export type Props = Record<string, any> & { children?: Children };
 
@@ -35,7 +37,7 @@ export function render(children: Children): string {
   if (Array.isArray(children)) {
     return children.filter((c) => c !== undefined).join("");
   }
-  return children ?? "";
+  return (children as string) ?? "";
 }
 
 export function toString(value: any): string | undefined {

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

@@ -5,19 +5,22 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React from "react";
+import React, { ComponentProps } from "react";
 
 import { ThemeClassNames, usePrismTheme } from "@docusaurus/theme-common";
 import { getPrismCssVariables } from "@docusaurus/theme-common/internal";
 import clsx from "clsx";
 
-export default function CodeBlockContainer({ as: As, ...props }) {
+export default function CodeBlockContainer<T extends "div" | "pre">({
+  as: As,
+  ...props
+}: { as: T } & ComponentProps<T>): React.JSX.Element {
   const prismTheme = usePrismTheme();
   const prismCssVariables = getPrismCssVariables(prismTheme);
   return (
     <As
       // Polymorphic components are hard to type, without `oneOf` generics
-      {...props}
+      {...(props as any)}
       style={prismCssVariables}
       className={clsx(
         "openapi-explorer__code-block-container",

package/src/theme/ApiExplorer/ApiCodeBlock/Content/{Element.js → Element.tsx}

@@ -8,12 +8,16 @@
 import React from "react";
 
 import Container from "@theme/ApiExplorer/ApiCodeBlock/Container";
+import type { Props } from "@theme/CodeBlock/Content/Element";
 import clsx from "clsx";
 
 // <pre> tags in markdown map to CodeBlocks. They may contain JSX children. When
 // the children is not a simple string, we just return a styled block without
 // actually highlighting.
-export default function CodeBlockJSX({ children, className }) {
+export default function CodeBlockJSX({
+  children,
+  className,
+}: Props): React.JSX.Element {
   return (
     <Container
       as="pre"

package/src/theme/ApiExplorer/ApiCodeBlock/Content/{String.js → String.tsx}

@@ -20,8 +20,9 @@ import CopyButton from "@theme/ApiExplorer/ApiCodeBlock/CopyButton";
 import ExpandButton from "@theme/ApiExplorer/ApiCodeBlock/ExpandButton";
 import Line from "@theme/ApiExplorer/ApiCodeBlock/Line";
 import WordWrapButton from "@theme/ApiExplorer/ApiCodeBlock/WordWrapButton";
+import type { Props } from "@theme/CodeBlock/Content/String";
 import clsx from "clsx";
-import Highlight, { defaultProps } from "prism-react-renderer";
+import { Highlight, Language } from "prism-react-renderer";
 
 export default function CodeBlockString({
   children,
@@ -30,7 +31,7 @@ export default function CodeBlockString({
   title: titleProp,
   showLineNumbers: showLineNumbersProp,
   language: languageProp,
-}) {
+}: Props): React.JSX.Element {
   const {
     prism: { defaultLanguage, magicComments },
   } = useThemeConfig();
@@ -65,7 +66,7 @@ export default function CodeBlockString({
       )}
       <div className="openapi-explorer__code-block-content">
         <Highlight
-          {...defaultProps}
+          // {...defaultProps}
           theme={prismTheme}
           code={code}
           language={language ?? "text"}
@@ -120,12 +121,11 @@ export default function CodeBlockString({
               "openapi-explorer__expand-btn"
             )}
             code={code}
-            language={language}
+            language={(language ?? "text") as Language}
             showLineNumbers={showLineNumbers}
             blockClassName={blockClassName}
             title={title}
             lineClassNames={lineClassNames}
-            wordWrap={wordWrap}
           />
         </div>
       </div>

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

@@ -7,14 +7,17 @@
 
 import React, { useCallback, useState, useRef, useEffect } from "react";
 
+import { CopyButtonProps } from "@docusaurus/theme-common/internal";
 import { translate } from "@docusaurus/Translate";
 import clsx from "clsx";
-// @ts-expect-error: TODO, we need to make theme-classic have type: module
 import copy from "copy-text-to-clipboard";
 
-export default function CopyButton({ code, className }) {
+export default function CopyButton({
+  code,
+  className,
+}: CopyButtonProps): React.JSX.Element {
   const [isCopied, setIsCopied] = useState(false);
-  const copyTimeout = useRef(undefined);
+  const copyTimeout = useRef<number | undefined>(undefined);
   const handleCopyCode = useCallback(() => {
     copy(code);
     setIsCopied(true);
@@ -22,7 +25,9 @@ export default function CopyButton({ code, className }) {
       setIsCopied(false);
     }, 1000);
   }, [code]);
+
   useEffect(() => () => window.clearTimeout(copyTimeout.current), []);
+
   return (
     <button
       type="button"

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

@@ -10,7 +10,15 @@ import React from "react";
 import { translate } from "@docusaurus/Translate";
 import clsx from "clsx";
 
-export default function ExitButton({ className, handler }) {
+export interface Props {
+  readonly className: string;
+  readonly handler: () => void;
+}
+
+export default function ExitButton({
+  className,
+  handler,
+}: Props): React.JSX.Element {
   return (
     <button
       type="button"

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

@@ -14,9 +14,19 @@ import CopyButton from "@theme/ApiExplorer/ApiCodeBlock/CopyButton";
 import ExitButton from "@theme/ApiExplorer/ApiCodeBlock/ExitButton";
 import Line from "@theme/ApiExplorer/ApiCodeBlock/Line";
 import clsx from "clsx";
-import Highlight, { defaultProps } from "prism-react-renderer";
+import { Highlight, Language } from "prism-react-renderer";
 import Modal from "react-modal";
 
+export interface Props {
+  readonly code: string;
+  readonly className: string;
+  readonly language: Language;
+  readonly showLineNumbers: boolean;
+  readonly blockClassName: string;
+  readonly title: string | undefined;
+  readonly lineClassNames: { [lineIndex: number]: string[] };
+}
+
 export default function ExpandButton({
   code,
   className,
@@ -25,7 +35,7 @@ export default function ExpandButton({
   blockClassName,
   title,
   lineClassNames,
-}) {
+}: Props): React.JSX.Element {
   const [isModalOpen, setIsModalOpen] = useState(false);
   const prismTheme = usePrismTheme();
 
@@ -102,7 +112,7 @@ export default function ExpandButton({
           )}
           <div className="openapi-explorer__code-block-content">
             <Highlight
-              {...defaultProps}
+              // {...defaultProps}
               theme={prismTheme}
               code={code}
               language={language ?? "text"}

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

@@ -7,6 +7,7 @@
 
 import React from "react";
 
+import { LineProps } from "@docusaurus/theme-common/internal";
 import clsx from "clsx";
 
 export default function CodeBlockLine({
@@ -15,7 +16,7 @@ export default function CodeBlockLine({
   showLineNumbers,
   getLineProps,
   getTokenProps,
-}) {
+}: LineProps): React.JSX.Element {
   if (line.length === 1 && line[0].content === "\n") {
     line[0].content = "";
   }

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

@@ -10,7 +10,17 @@ import React from "react";
 import { translate } from "@docusaurus/Translate";
 import clsx from "clsx";
 
-export default function WordWrapButton({ className, onClick, isEnabled }) {
+export interface Props {
+  readonly className?: string;
+  readonly onClick: React.MouseEventHandler;
+  readonly isEnabled: boolean;
+}
+
+export default function WordWrapButton({
+  className,
+  onClick,
+  isEnabled,
+}: Props): React.JSX.Element | null {
   const title = translate({
     id: "theme.CodeBlock.wordWrapToggle",
     message: "Toggle word wrap",

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

@@ -5,25 +5,30 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { isValidElement } from "react";
+import React, { isValidElement, ReactNode } from "react";
 
+import { CodeBlockProps } from "@docusaurus/theme-common/internal";
 import useIsBrowser from "@docusaurus/useIsBrowser";
 import ElementContent from "@theme/ApiExplorer/ApiCodeBlock/Content/Element";
 import StringContent from "@theme/ApiExplorer/ApiCodeBlock/Content/String";
+
 /**
  * Best attempt to make the children a plain string so it is copyable. If there
  * are react elements, we will not be able to copy the content, and it will
  * return `children` as-is; otherwise, it concatenates the string children
  * together.
  */
-function maybeStringifyChildren(children) {
+function maybeStringifyChildren(children: ReactNode): ReactNode {
   if (React.Children.toArray(children).some((el) => isValidElement(el))) {
     return children;
   }
   // The children is now guaranteed to be one/more plain strings
-  return Array.isArray(children) ? children.join("") : children;
+  return Array.isArray(children) ? children.join("") : (children as string);
 }
-export default function ApiCodeBlock({ children: rawChildren, ...props }) {
+export default function ApiCodeBlock({
+  children: rawChildren,
+  ...props
+}: CodeBlockProps) {
   // The Prism theme on SSR is always the default theme but the site theme can
   // be in a different mode. React hydration doesn't update DOM styles that come
   // from SSR. Hence force a re-render after mounting to apply the current
@@ -34,7 +39,7 @@ export default function ApiCodeBlock({ children: rawChildren, ...props }) {
     typeof children === "string" ? StringContent : ElementContent;
   return (
     <CodeBlockComp key={String(isBrowser)} {...props}>
-      {children}
+      {children as string}
     </CodeBlockComp>
   );
 }

package/src/theme/ApiExplorer/CodeSnippets/index.tsx

@@ -172,9 +172,9 @@ function CodeSnippets({ postman, codeSamples }: Props) {
 
   // User-defined languages array
   // Can override languageSet, change order of langs, override options and variants
-  const userDefinedLanguageSet = siteConfig?.themeConfig?.languageTabs as
-    | Language[]
-    | undefined;
+  const userDefinedLanguageSet =
+    (siteConfig?.themeConfig?.languageTabs as Language[] | undefined) ??
+    languageSet;
 
   // Filter languageSet by user-defined langs
   const filteredLanguageSet = languageSet.filter((ls) => {
@@ -189,8 +189,6 @@ function CodeSnippets({ postman, codeSamples }: Props) {
     codeSamples
   );
 
-  console.log("merged", mergedLangs);
-
   // Read defaultLang from localStorage
   const defaultLang: Language[] = mergedLangs.filter(
     (lang) =>