react-router 8.4.0 → 8.5.0

package/dist/development/lib/dom/ssr/components.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -10,11 +10,11 @@
  */
 import { useIsRSCRouterContext } from "../../context.js";
 import { useDataRouterContext, useDataRouterData, useDataRouterState, useLocation } from "../../hooks.js";
-import { warnOnce } from "../../server-runtime/warnings.js";
 import invariant from "./invariant.js";
 import { getKeyedLinksForMatches, getKeyedPrefetchLinks, getModuleLinkHrefs, getNewMatchesForLinks, isPageLinkDescriptor } from "./links.js";
 import { escapeHtml } from "./markup.js";
 import { singleFetchUrl } from "./single-fetch.js";
+import { warnOnce } from "../../server-runtime/warnings.js";
 import { getPartialManifest, isFogOfWarEnabled } from "./fog-of-war.js";
 import * as React$1 from "react";
 //#region lib/dom/ssr/components.tsx
@@ -234,19 +234,21 @@ function useKeyedPrefetchLinks(matches) {
 }
 function RSCPrefetchPageLinksImpl({ page, matches: nextMatches, ...linkProps }) {
 	let location = useLocation();
+	let { unstable_apiServerOrigin } = useFrameworkContext();
 	let dataHrefs = React$1.useMemo(() => {
 		if (page === location.pathname + location.search + location.hash) return [];
-		let url = singleFetchUrl(page, "rsc");
+		let url = singleFetchUrl(page, "rsc", unstable_apiServerOrigin);
 		let hasSomeRoutesWithShouldRevalidate = false;
 		let targetRoutes = [];
 		for (let match of nextMatches) if (typeof match.route.shouldRevalidate === "function") hasSomeRoutesWithShouldRevalidate = true;
 		else targetRoutes.push(match.route.id);
 		if (hasSomeRoutesWithShouldRevalidate && targetRoutes.length > 0) url.searchParams.set("_routes", targetRoutes.join(","));
-		return [url.pathname + url.search];
+		return [unstable_apiServerOrigin ? url.toString() : url.pathname + url.search];
 	}, [
 		page,
 		location,
-		nextMatches
+		nextMatches,
+		unstable_apiServerOrigin
 	]);
 	return /* @__PURE__ */ React$1.createElement(React$1.Fragment, null, dataHrefs.map((href) => /* @__PURE__ */ React$1.createElement("link", {
 		key: href,
@@ -258,7 +260,7 @@ function RSCPrefetchPageLinksImpl({ page, matches: nextMatches, ...linkProps })
 }
 function PrefetchPageLinksImpl({ page, matches: nextMatches, ...linkProps }) {
 	let location = useLocation();
-	let { manifest, routeModules } = useFrameworkContext();
+	let { manifest, routeModules, unstable_apiServerOrigin } = useFrameworkContext();
 	let { matches } = useDataRouterState("PrefetchPageLinks");
 	let { loaderData } = useDataRouterData("PrefetchPageLinks");
 	let newMatchesForData = React$1.useMemo(() => getNewMatchesForLinks(page, nextMatches, matches, manifest, location, "data"), [
@@ -287,9 +289,9 @@ function PrefetchPageLinksImpl({ page, matches: nextMatches, ...linkProps }) {
 			else routesParams.add(m.route.id);
 		});
 		if (routesParams.size === 0) return [];
-		let url = singleFetchUrl(page, "data");
+		let url = singleFetchUrl(page, "data", unstable_apiServerOrigin);
 		if (foundOptOutRoute && routesParams.size > 0) url.searchParams.set("_routes", nextMatches.filter((m) => routesParams.has(m.route.id)).map((m) => m.route.id).join(","));
-		return [url.pathname + url.search];
+		return [unstable_apiServerOrigin ? url.toString() : url.pathname + url.search];
 	}, [
 		loaderData,
 		location,
@@ -297,7 +299,8 @@ function PrefetchPageLinksImpl({ page, matches: nextMatches, ...linkProps }) {
 		newMatchesForData,
 		nextMatches,
 		page,
-		routeModules
+		routeModules,
+		unstable_apiServerOrigin
 	]);
 	let moduleHrefs = React$1.useMemo(() => getModuleLinkHrefs(newMatchesForAssets, manifest), [newMatchesForAssets, manifest]);
 	let keyedPrefetchLinks = useKeyedPrefetchLinks(newMatchesForAssets);

package/dist/development/lib/dom/ssr/data.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/entry.d.ts

@@ -1,8 +1,9 @@
 
 import { DataRouteObject, RouteBranch, RouteManifest } from "../../router/utils.js";
 import { StaticHandlerContext } from "../../router/router.js";
-import { RouteModules } from "./routeModules.js";
 import { EntryRoute } from "./routes.js";
+import { RouteModules } from "./routeModules.js";
+import { DiscoveryState, RouteDiscoveryRuntime } from "./route-discovery.js";
 import { ServerBuild } from "../../server-runtime/build.js";
 
 //#region lib/dom/ssr/entry.d.ts
@@ -11,6 +12,8 @@ type SerializedError = {
   stack?: string;
 };
 interface FrameworkContextObject {
+  routeDiscoveryRuntime?: RouteDiscoveryRuntime;
+  routeDiscoveryState?: DiscoveryState;
   manifest: AssetsManifest;
   routeModules: RouteModules;
   criticalCss?: CriticalCss;
@@ -18,6 +21,8 @@ interface FrameworkContextObject {
   future: FutureConfig;
   ssr: boolean;
   isSpaMode: boolean;
+  unstable_apiOnly?: boolean;
+  unstable_apiServerOrigin?: string;
   routeDiscovery: ServerBuild["routeDiscovery"];
   nonce?: string;
   serializeError?(error: Error): SerializedError;
@@ -41,7 +46,9 @@ interface EntryContext extends FrameworkContextObject {
   staticHandlerContext: StaticHandlerContext;
   serverHandoffStream?: ReadableStream<Uint8Array>;
 }
-type FutureConfig = Record<string, never>;
+interface FutureConfig {
+  unstable_customRouteDiscovery?: boolean;
+}
 type CriticalCss = string | {
   rel: "stylesheet";
   href: string;

package/dist/development/lib/dom/ssr/errorBoundaries.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/fallback.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/fog-of-war.d.ts

@@ -2,11 +2,12 @@
 import { PatchRoutesOnNavigationFunction } from "../../router/utils.js";
 import { Router } from "../../router/router.js";
 import { RouteModules } from "./routeModules.js";
+import { RouterFetch } from "./single-fetch.js";
 import { AssetsManifest } from "./entry.js";
 import { ServerBuild } from "../../server-runtime/build.js";
 
 //#region lib/dom/ssr/fog-of-war.d.ts
-declare function getPatchRoutesOnNavigationFunction(getRouter: () => Router, manifest: AssetsManifest, routeModules: RouteModules, ssr: boolean, routeDiscovery: ServerBuild["routeDiscovery"], isSpaMode: boolean, basename: string | undefined): PatchRoutesOnNavigationFunction | undefined;
-declare function useFogOFWarDiscovery(router: Router, manifest: AssetsManifest, routeModules: RouteModules, ssr: boolean, routeDiscovery: ServerBuild["routeDiscovery"], isSpaMode: boolean): void;
+declare function getPatchRoutesOnNavigationFunction(getRouter: () => Router, manifest: AssetsManifest, routeModules: RouteModules, ssr: boolean, routeDiscovery: ServerBuild["routeDiscovery"], isSpaMode: boolean, basename: string | undefined, fetchImplementation?: RouterFetch, serverOrigin?: string, isApiOnly?: boolean): PatchRoutesOnNavigationFunction | undefined;
+declare function useFogOFWarDiscovery(router: Router, manifest: AssetsManifest, routeModules: RouteModules, ssr: boolean, routeDiscovery: ServerBuild["routeDiscovery"], isSpaMode: boolean, fetchImplementation?: RouterFetch, serverOrigin?: string, isApiOnly?: boolean): void;
 //#endregion
 export { getPatchRoutesOnNavigationFunction, useFogOFWarDiscovery };

package/dist/development/lib/dom/ssr/fog-of-war.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -27,7 +27,7 @@ function getPathsWithAncestors(paths) {
 	return Array.from(result);
 }
 function isFogOfWarEnabled(routeDiscovery, ssr) {
-	return routeDiscovery.mode === "lazy" && ssr === true;
+	return routeDiscovery.mode === "lazy" && ssr;
 }
 function getPartialManifest({ sri, ...manifest }, router) {
 	let routeIds = new Set(router.state.matches.map((m) => m.route.id));
@@ -49,15 +49,15 @@ function getPartialManifest({ sri, ...manifest }, router) {
 		sri: sri ? true : void 0
 	};
 }
-function getPatchRoutesOnNavigationFunction(getRouter, manifest, routeModules, ssr, routeDiscovery, isSpaMode, basename) {
+function getPatchRoutesOnNavigationFunction(getRouter, manifest, routeModules, ssr, routeDiscovery, isSpaMode, basename, fetchImplementation = (request) => fetch(request), serverOrigin, isApiOnly = false) {
 	if (!isFogOfWarEnabled(routeDiscovery, ssr)) return;
 	return async ({ path, patch, signal, fetcherKey }) => {
 		if (discoveredPaths.has(path)) return;
 		let { state } = getRouter();
-		await fetchAndApplyManifestPatches([path], fetcherKey ? window.location.href : createPath(state.navigation.location || state.location), manifest, routeModules, ssr, isSpaMode, basename, routeDiscovery.manifestPath, patch, signal);
+		await fetchAndApplyManifestPatches([path], fetcherKey ? window.location.href : createPath(state.navigation.location || state.location), manifest, routeModules, ssr, isSpaMode, basename, routeDiscovery.manifestPath, patch, signal, fetchImplementation, serverOrigin, isApiOnly);
 	};
 }
-function useFogOFWarDiscovery(router, manifest, routeModules, ssr, routeDiscovery, isSpaMode) {
+function useFogOFWarDiscovery(router, manifest, routeModules, ssr, routeDiscovery, isSpaMode, fetchImplementation = (request) => fetch(request), serverOrigin, isApiOnly = false) {
 	React$1.useEffect(() => {
 		if (!isFogOfWarEnabled(routeDiscovery, ssr) || window.navigator?.connection?.saveData === true) return;
 		function registerElement(el) {
@@ -77,7 +77,7 @@ function useFogOFWarDiscovery(router, manifest, routeModules, ssr, routeDiscover
 			});
 			if (lazyPaths.length === 0) return;
 			try {
-				await fetchAndApplyManifestPatches(lazyPaths, null, manifest, routeModules, ssr, isSpaMode, router.basename, routeDiscovery.manifestPath, router.patchRoutes);
+				await fetchAndApplyManifestPatches(lazyPaths, null, manifest, routeModules, ssr, isSpaMode, router.basename, routeDiscovery.manifestPath, router.patchRoutes, void 0, fetchImplementation, serverOrigin, isApiOnly);
 			} catch (e) {
 				console.error("Failed to fetch manifest patches", e);
 			}
@@ -102,7 +102,10 @@ function useFogOFWarDiscovery(router, manifest, routeModules, ssr, routeDiscover
 		manifest,
 		routeModules,
 		router,
-		routeDiscovery
+		routeDiscovery,
+		fetchImplementation,
+		serverOrigin,
+		isApiOnly
 	]);
 }
 function getManifestPath(_manifestPath, basename) {
@@ -154,12 +157,12 @@ async function handleClientVersionMismatch(needsReload, version, errorReloadPath
 	}
 	return reloadPromise;
 }
-async function fetchAndApplyManifestPatches(paths, errorReloadPath, manifest, routeModules, ssr, isSpaMode, basename, manifestPath, patchRoutes, signal) {
+async function fetchAndApplyManifestPatches(paths, errorReloadPath, manifest, routeModules, ssr, isSpaMode, basename, manifestPath, patchRoutes, signal, fetchImplementation = (request) => fetch(request), serverOrigin, isApiOnly = false) {
 	paths = getPathsWithAncestors(paths);
 	const searchParams = new URLSearchParams();
 	searchParams.set("paths", paths.sort().join(","));
 	searchParams.set("version", manifest.version);
-	let url = new URL(getManifestPath(manifestPath, basename), window.location.origin);
+	let url = new URL(getManifestPath(manifestPath, basename), serverOrigin ?? window.location.origin);
 	url.search = searchParams.toString();
 	if (url.toString().length > 7680) {
 		nextPaths.clear();
@@ -167,7 +170,7 @@ async function fetchAndApplyManifestPatches(paths, errorReloadPath, manifest, ro
 	}
 	let serverPatches;
 	try {
-		let res = await fetch(url, { signal });
+		let res = await fetchImplementation(new Request(url, { signal }), { type: "manifest" });
 		if (!res.ok) throw new Error(`${res.status} ${res.statusText}`);
 		if (await handleClientVersionMismatch(res.status === 204 && res.headers.has("X-Remix-Reload-Document"), manifest.version, errorReloadPath)) return;
 		serverPatches = await res.json();
@@ -187,7 +190,7 @@ async function fetchAndApplyManifestPatches(paths, errorReloadPath, manifest, ro
 	Object.values(patches).forEach((patch) => {
 		if (patch && (!patch.parentId || !patches[patch.parentId])) parentIds.add(patch.parentId);
 	});
-	parentIds.forEach((parentId) => patchRoutes(parentId || null, createClientRoutes(patches, routeModules, null, ssr, isSpaMode, parentId)));
+	parentIds.forEach((parentId) => patchRoutes(parentId || null, createClientRoutes(patches, routeModules, null, ssr, isSpaMode, parentId, void 0, void 0, isApiOnly)));
 }
 function addToFifoQueue(path, queue) {
 	if (queue.size >= discoveredPathsMaxSize) {

package/dist/development/lib/dom/ssr/hydration.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/invariant.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/links.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/markup.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.0
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/route-discovery.d.ts

@@ -0,0 +1,120 @@
+
+import { PatchRoutesOnNavigationFunction, RouteObject } from "../../router/utils.js";
+import { Router } from "../../router/router.js";
+import { ClientOnErrorFunction } from "../../components.js";
+import { RouteModules } from "./routeModules.js";
+import { RouterFetch } from "./single-fetch.js";
+import { WindowReactRouterContext } from "../global.js";
+import { AssetsManifest } from "./entry.js";
+
+//#region lib/dom/ssr/route-discovery.d.ts
+/** A discovery response from a different build. */
+type ManifestMismatchEvent = {
+  source: "eager" | "navigation" | "fetcher" | "imperative";
+  version: string;
+  reloadUrl: string | null;
+  loadAllRoutes(): Promise<void>;
+  stopPropagation(): void; /** Run built-in recovery for this source, at most once per mismatch event. */
+  defaultBehavior(): Promise<void>;
+};
+/** The result of imperative route discovery. */
+type DiscoveryResult = {
+  type: "success";
+} | {
+  type: "version-mismatch";
+} | {
+  type: "aborted";
+};
+/** Options for {@link unstable_useRouteDiscovery}. */
+type RouteDiscoveryOptions = {
+  onManifestMismatch?: (event: ManifestMismatchEvent) => void | Promise<void>;
+};
+type Registration = {
+  current: RouteDiscoveryOptions;
+};
+type DiscoveryState = "partial" | "loading" | "complete";
+type RouteDiscoverySsrInfo = {
+  manifest: AssetsManifest;
+  routeModules: RouteModules;
+  router: Router | undefined;
+  context: Pick<WindowReactRouterContext, "ssr" | "routeDiscovery" | "isSpaMode" | "basename" | "unstable_apiServerOrigin" | "unstable_apiOnly">;
+};
+declare class RouteDiscoveryRuntime {
+  private ssrInfo;
+  readonly enabled: boolean;
+  readonly discoveredPaths: Set<string>;
+  readonly nextPaths: Set<string>;
+  state: DiscoveryState;
+  ready: boolean;
+  private registrations;
+  private listeners;
+  private fullLoadErrorListeners;
+  private fullLoad?;
+  private loadedManifest?;
+  private mismatch?;
+  private fetchImplementation;
+  private loadManifest;
+  onError?: ClientOnErrorFunction;
+  constructor(ssrInfo: RouteDiscoverySsrInfo, {
+    fetch: fetchImplementation,
+    loadManifest
+  }?: {
+    fetch?: RouterFetch;
+    loadManifest?: () => Promise<AssetsManifest>;
+  });
+  private get router();
+  private loadManifestAsset;
+  subscribe: (listener: () => void) => () => void;
+  private update;
+  markReady: () => void;
+  register(registration: Registration): () => void;
+  private isComplete;
+  loadAllRoutes: () => Promise<void>;
+  reportError(error: unknown): void;
+  private dispatchMismatch;
+  private requestUrl;
+  discoverRoutes: (paths: string[], options?: {
+    signal?: AbortSignal;
+  }) => Promise<DiscoveryResult>;
+  discover(paths: string[], source: ManifestMismatchEvent["source"], reloadUrl: string | null, signal?: AbortSignal, patch?: (routeId: string | null, children: RouteObject[], unstable_allowElementMutations?: boolean) => void): Promise<DiscoveryResult>;
+}
+/**
+ * Control lazy route discovery in Framework Mode with `future.unstable_customRouteDiscovery`
+ * enabled. This allows you to imperatively discover routes as well as add custom behavior
+ * when a manifest version mismatch is detected.  Calling `loadAllRoutes` will load the entire
+ * route manifest for the current (potentially stale) client version - this requires that prior
+ * client artifacts are still available on your CDN _and_ you have not made breaking changes to
+ * the API contracts of your loaders and actions.
+ *
+ * See the [Route Discovery guide](../../how-to/route-discovery) for more information and examples.
+ *
+ * @example
+ * let { state, discoverRoutes, loadAllRoutes } = unstable_useRouteDiscovery({
+ *   onManifestMismatch: async (event) => {
+ *     // Eagerly load the complete route tree for this client without requiring a hard reload
+ *     await event.loadAllRoutes();
+ *   },
+ * });
+ *
+ * // Eagerly discover specific routes
+ * discoverRoutes(["/a", "/b"]);
+ *
+ * @name unstable_useRouteDiscovery
+ * @public
+ * @category Hooks
+ * @mode framework
+ * @param options An awaited manifest-mismatch handler.
+ * @returns The client version, full-manifest loading state, and discovery operations.
+ */
+declare function useRouteDiscovery(options?: RouteDiscoveryOptions): {
+  version: string;
+  state: DiscoveryState;
+  loadAllRoutes: () => Promise<void>;
+  discoverRoutes: (paths: string[], options?: {
+    signal?: AbortSignal;
+  }) => Promise<DiscoveryResult>;
+};
+declare function getCustomPatchRoutesOnNavigationFunction(getRouter: () => Router, runtime: RouteDiscoveryRuntime): PatchRoutesOnNavigationFunction | undefined;
+declare function useCustomRouteDiscovery(runtime: RouteDiscoveryRuntime, onError?: ClientOnErrorFunction): "partial" | "loading" | "complete";
+//#endregion
+export { DiscoveryResult, DiscoveryState, ManifestMismatchEvent, RouteDiscoveryOptions, RouteDiscoveryRuntime, getCustomPatchRoutesOnNavigationFunction, useCustomRouteDiscovery, useRouteDiscovery };