Introduce support for Docusaurus 3.5.0+ (#919)

* upgrade to docusaurus 3.5.2

* refactor imports and add plugin-content-docs declaration

* add module mapper for neotraverse/legacy

Author: sserrata

demo/package.json

@@ -21,9 +21,9 @@
     "re-gen": "yarn clean-all && yarn gen-all"
   },
   "dependencies": {
-    "@docusaurus/core": "3.4.0",
-    "@docusaurus/plugin-google-gtag": "3.4.0",
-    "@docusaurus/preset-classic": "3.4.0",
+    "@docusaurus/core": "3.5.2",
+    "@docusaurus/plugin-google-gtag": "3.5.2",
+    "@docusaurus/preset-classic": "3.5.2",
     "clsx": "^1.1.1",
     "docusaurus-plugin-openapi-docs": "^3.0.2",
     "docusaurus-theme-openapi-docs": "^3.0.2",

jest.config.js

@@ -12,4 +12,8 @@ module.exports = {
     "<rootDir>/packages/docusaurus-plugin-openapi-docs/src",
     "<rootDir>/packages/docusaurus-theme-openapi-docs/src",
   ],
+  moduleNameMapper: {
+    "^neotraverse/legacy$":
+      "<rootDir>/node_modules/neotraverse/dist/legacy/legacy.cjs",
+  },
 };

packages/docusaurus-theme-openapi-docs/src/plugin-content-docs.d.ts

@@ -0,0 +1,18 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+/// <reference types="@docusaurus/theme-classic" />
+
+declare module "@docusaurus/plugin-content-docs/client" {
+  export function DocProvider({
+    children,
+    content,
+  }: {
+    children: ReactNode;
+    content: PropDocContent;
+  });
+}

packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Request/index.tsx

@@ -8,7 +8,7 @@
 // @ts-nocheck
 import React, { useState } from "react";
 
-import { useDoc } from "@docusaurus/theme-common/internal";
+import { useDoc } from "@docusaurus/plugin-content-docs/client";
 import Accept from "@theme/ApiExplorer/Accept";
 import Authorization from "@theme/ApiExplorer/Authorization";
 import Body from "@theme/ApiExplorer/Body";
@@ -31,7 +31,7 @@ import { FormProvider, useForm } from "react-hook-form";
 
 import makeRequest from "./makeRequest";
 
-function Request({ item }: { item: NonNullable<ApiItem> }) {
+function Request({ item }: { item: ApiItem }) {
   const postman = new sdk.Request(item.postman);
   const metadata = useDoc();
   const { proxy, hide_send_button: hideSendButton } = metadata.frontMatter;

packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Response/index.tsx

@@ -7,8 +7,9 @@
 
 import React from "react";
 
+// @ts-ignore
+import { useDoc } from "@docusaurus/plugin-content-docs/client";
 import { usePrismTheme } from "@docusaurus/theme-common";
-import { useDoc } from "@docusaurus/theme-common/internal";
 import ApiCodeBlock from "@theme/ApiExplorer/ApiCodeBlock";
 import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
 import SchemaTabs from "@theme/SchemaTabs";
@@ -38,7 +39,7 @@ function formatXml(xml: string) {
   return formatted.substring(1, formatted.length - 3);
 }
 
-function Response({ item }: { item: NonNullable<ApiItem> }) {
+function Response({ item }: { item: ApiItem }) {
   const metadata = useDoc();
   const hideSendButton = metadata.frontMatter.hide_send_button;
   const prismTheme = usePrismTheme();

packages/docusaurus-theme-openapi-docs/src/theme/ApiItem/Layout/index.tsx

@@ -11,14 +11,14 @@ import React from "react";
 
 import BrowserOnly from "@docusaurus/BrowserOnly";
 import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
+import { DocProvider } from "@docusaurus/plugin-content-docs/client";
 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";
 import { createPersistanceMiddleware } from "@theme/ApiExplorer/persistanceMiddleware";
-import DocItemLayout from "@theme/ApiItem/Layout";
 import type { Props } from "@theme/DocItem";
+import DocItemLayout from "@theme/DocItem/Layout";
 import DocItemMetadata from "@theme/DocItem/Metadata";
 import clsx from "clsx";
 import { ServerObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";