Update typedoc to include react-router/dom exports

package.json

@@ -88,7 +88,7 @@
     "remark-parse": "^10.0.1",
     "remark-stringify": "^10.0.2",
     "semver": "^7.5.4",
-    "typedoc": "^0.26.11",
+    "typedoc": "^0.28.7",
     "typescript": "^5.4.5",
     "unified": "^10.1.2",
     "unist-util-remove": "^3.1.0",

packages/react-router-architect/typedoc.mjs

@@ -0,0 +1,9 @@
+import { blockTags } from "../../typedoc.mjs";
+
+/** @type {Partial<import('typedoc').TypeDocOptions>} */
+const config = {
+  entryPoints: ["./index.ts"],
+  blockTags,
+};
+
+export default config;

packages/react-router-cloudflare/typedoc.mjs

@@ -0,0 +1,9 @@
+import { blockTags } from "../../typedoc.mjs";
+
+/** @type {Partial<import('typedoc').TypeDocOptions>} */
+const config = {
+  entryPoints: ["./index.ts"],
+  blockTags,
+};
+
+export default config;

packages/react-router-dev/typedoc.mjs

@@ -0,0 +1,15 @@
+import { blockTags } from "../../typedoc.mjs";
+
+/** @type {Partial<import('typedoc').TypeDocOptions>} */
+const config = {
+  entryPoints: [
+    "./index.ts",
+    "./config.ts",
+    "./routes.ts",
+    "./vite.ts",
+    "./vite/cloudflare.ts",
+  ],
+  blockTags,
+};
+
+export default config;

packages/react-router-express/typedoc.mjs

@@ -0,0 +1,9 @@
+import { blockTags } from "../../typedoc.mjs";
+
+/** @type {Partial<import('typedoc').TypeDocOptions>} */
+const config = {
+  entryPoints: ["./index.ts"],
+  blockTags,
+};
+
+export default config;

packages/react-router-fs-routes/typedoc.mjs

@@ -0,0 +1,9 @@
+import { blockTags } from "../../typedoc.mjs";
+
+/** @type {Partial<import('typedoc').TypeDocOptions>} */
+const config = {
+  entryPoints: ["./index.ts"],
+  blockTags,
+};
+
+export default config;

packages/react-router-node/typedoc.mjs

@@ -0,0 +1,9 @@
+import { blockTags } from "../../typedoc.mjs";
+
+/** @type {Partial<import('typedoc').TypeDocOptions>} */
+const config = {
+  entryPoints: ["./index.ts"],
+  blockTags,
+};
+
+export default config;

packages/react-router-remix-routes-option-adapter/typedoc.mjs

@@ -0,0 +1,9 @@
+import { blockTags } from "../../typedoc.mjs";
+
+/** @type {Partial<import('typedoc').TypeDocOptions>} */
+const config = {
+  entryPoints: ["./index.ts"],
+  blockTags,
+};
+
+export default config;

packages/react-router-serve/typedoc.mjs

@@ -0,0 +1,9 @@
+import { blockTags } from "../../typedoc.mjs";
+
+/** @type {Partial<import('typedoc').TypeDocOptions>} */
+const config = {
+  entryPoints: ["./cli.ts"],
+  blockTags,
+};
+
+export default config;

packages/react-router/dom-export.ts

@@ -1,3 +1,7 @@
+/**
+ * @module dom
+ */
+
 "use client";
 
 export type { RouterProviderProps } from "./lib/dom-export/dom-router-provider";

packages/react-router/index.ts

@@ -1,3 +1,8 @@
+/**
+ * @module index
+ * @mergeModuleWith react-router
+ */
+
 "use client";
 
 // Expose old @remix-run/router API

packages/react-router/lib/components.tsx

@@ -266,7 +266,7 @@ export interface RouterProviderProps {
  * Render the UI for the given {@link DataRouter}. This component should
  * typically be at the top of an app's element tree.
  *
- * @example
+ * ```tsx
  * import { createBrowserRouter } from "react-router";
  * import { RouterProvider } from "react-router/dom";
  * import { createRoot } from "react-dom/client";
@@ -275,6 +275,14 @@ export interface RouterProviderProps {
  * createRoot(document.getElementById("root")).render(
  *   <RouterProvider router={router} />
  * );
+ * ```
+ *
+ * <docs-info>Please note that this component is exported both from `react-router` and
+ * `react-router/dom` with the only difference being that the latter automatically
+ * wires up the `react-dom` `flushSync` implementation. You _almost always_ want
+ * to use the version from `react-router/dom` unless you're running in a non-DOM
+ * environment.</docs-info>
+ *
  *
  * @public
  * @category Data Routers

packages/react-router/lib/dom-export/dom-router-provider.tsx

@@ -4,12 +4,8 @@ import * as ReactDOM from "react-dom";
 import type { RouterProviderProps as BaseRouterProviderProps } from "react-router";
 import { RouterProvider as BaseRouterProvider } from "react-router";
 
-// FIXME: We now have two `RouterProviderProps` type, one in `react-router` and
-//  one in `react-router/dom`.
 export type RouterProviderProps = Omit<BaseRouterProviderProps, "flushSync">;
 
-// FIXME: We now have two `RouterProvider` components, one in `react-router` and
-//  one in `react-router/dom`.
 export function RouterProvider(props: Omit<RouterProviderProps, "flushSync">) {
   return <BaseRouterProvider flushSync={ReactDOM.flushSync} {...props} />;
 }

packages/react-router/lib/dom-export/hydrated-router.tsx

@@ -217,15 +217,12 @@ function createHydratedRouter({
 export interface HydratedRouterProps {
   /**
    * Context object to be passed through to {@link createBrowserRouter} and made
-   * available to
-   * [`clientAction`](../../start/framework/route-module#clientAction)/[`clientLoader`](../../start/framework/route-module#clientLoader)
+   * available to [`clientAction`](../../start/framework/route-module#clientAction)/[`clientLoader`](../../start/framework/route-module#clientLoader)
    * functions
    */
   unstable_getContext?: RouterInit["unstable_getContext"];
 }
 
-// TODO: Reference `HydratedRouterProps` in the `HydratedRouter` JSDoc
-//  @param {HydratedRouterProps.unstable_getContext} props.unstable_getContext n/a
 /**
  * Framework-mode router component to be used to hydrate a router from a
  * {@link ServerRouter}. See [`entry.client.tsx`](../framework-conventions/entry.client.tsx).
@@ -234,10 +231,7 @@ export interface HydratedRouterProps {
  * @category Framework Routers
  * @mode framework
  * @param props Props
- * @param props.unstable_getContext Context object to be passed through to
- * {@link createBrowserRouter} and made available to
- * [`clientAction`](../../start/framework/route-module#clientAction)/[`clientLoader`](../../start/framework/route-module#clientLoader)
- * functions
+ * @param {dom.HydratedRouterProps.unstable_getContext} props.unstable_getContext n/a
  * @returns A React element that represents the hydrated application.
  */
 export function HydratedRouter(props: HydratedRouterProps) {

packages/react-router/typedoc.mjs

@@ -0,0 +1,18 @@
+import { blockTags } from "../../typedoc.mjs";
+
+/** @type {Partial<import('typedoc').TypeDocOptions>} */
+const config = {
+  entryPoints: ["./index.ts", "./dom-export.ts"],
+  categoryOrder: [
+    "Components",
+    "Hooks",
+    "Data Routers",
+    "Component Routers",
+    "Utils",
+    "Types",
+    "*",
+  ],
+  blockTags,
+};
+
+export default config;