react-router 8.4.0 → 8.5.0

package/dist/production/lib/rsc/browser.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -14,12 +14,12 @@ import { ErrorResponseImpl, createContext, resolvePath } from "../router/utils.j
 import { validateNavigationTarget } from "../router/navigation.js";
 import { createRouter, hasInvalidProtocol, isMutationMethod } from "../router/router.js";
 import { RSCRouterContext } from "../context.js";
-import { RouterProvider } from "../components.js";
 import { createRequestInit } from "../dom/ssr/data.js";
 import { getSingleFetchDataStrategyImpl, singleFetchUrl, stripIndexParam } from "../dom/ssr/single-fetch.js";
 import { noActionDefinedError, shouldHydrateRouteLoader } from "../dom/ssr/routes.js";
 import { getPathsWithAncestors, handleClientVersionMismatch } from "../dom/ssr/fog-of-war.js";
 import { FrameworkContext, setIsHydrated } from "../dom/ssr/components.js";
+import { RouterProvider } from "../components.js";
 import { RSCRouterGlobalErrorBoundary } from "./errorBoundaries.js";
 import { populateRSCRouteModules } from "./route-modules.js";
 import { getHydrationData } from "../dom/ssr/hydration.js";

package/dist/production/lib/rsc/errorBoundaries.js

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

package/dist/production/lib/rsc/html-stream/browser.js

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

package/dist/production/lib/rsc/html-stream/server.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -21,11 +21,31 @@ function injectRSCPayload(rscStream, { nonce } = {}) {
 	let rscReader = null;
 	let buffered = [];
 	let timeout = null;
+	async function stop(reason) {
+		cancelled = true;
+		if (timeout) {
+			clearTimeout(timeout);
+			timeout = null;
+		}
+		buffered.length = 0;
+		resolveFlightDataPromise();
+		if (rscReader && rscStream.locked) await rscReader.cancel(reason).catch(() => {});
+		else await rscStream.cancel(reason).catch(() => {});
+	}
+	function tryEnqueue(controller, chunk) {
+		try {
+			controller.enqueue(chunk);
+			return true;
+		} catch (error) {
+			stop(error);
+			return false;
+		}
+	}
 	function flushBufferedChunks(controller) {
 		for (let chunk of buffered) {
 			let buf = decoder.decode(chunk, { stream: true });
 			if (buf.endsWith(trailer)) buf = buf.slice(0, -14);
-			controller.enqueue(encoder.encode(buf));
+			if (!tryEnqueue(controller, encoder.encode(buf))) return;
 		}
 		buffered.length = 0;
 		timeout = null;
@@ -50,18 +70,10 @@ function injectRSCPayload(rscStream, { nonce } = {}) {
 				clearTimeout(timeout);
 				flushBufferedChunks(controller);
 			}
-			controller.enqueue(encoder.encode("</body></html>"));
+			tryEnqueue(controller, encoder.encode("</body></html>"));
 		},
 		async cancel(reason) {
-			cancelled = true;
-			if (timeout) {
-				clearTimeout(timeout);
-				timeout = null;
-			}
-			buffered.length = 0;
-			if (rscReader) await rscReader.cancel(reason).catch(() => {});
-			else await rscStream.cancel(reason).catch(() => {});
-			resolveFlightDataPromise();
+			await stop(reason);
 		}
 	});
 }

package/dist/production/lib/rsc/route-modules.js

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

package/dist/production/lib/rsc/server.rsc.d.ts

@@ -1,6 +1,6 @@
 
 import { Location } from "../router/history.js";
-import { ActionFunction, LoaderFunction, Params, RouterContextProvider, ShouldRevalidateFunction } from "../router/utils.js";
+import { ActionFunction, LoaderFunction, MiddlewareFunction, Params, RouterContextProvider, ShouldRevalidateFunction } from "../router/utils.js";
 import { ClientActionFunction, ClientLoaderFunction, HeadersFunction, LinksFunction, MetaFunction } from "../dom/ssr/routeModules.js";
 import * as React$1 from "react";
 import { ReactFormState } from "react-dom/client";
@@ -19,6 +19,7 @@ type RSCRouteConfigEntryBase = {
   links?: LinksFunction;
   loader?: LoaderFunction;
   meta?: MetaFunction;
+  middleware?: MiddlewareFunction<any>[];
   shouldRevalidate?: ShouldRevalidateFunction;
 };
 type RSCRouteConfigEntry = RSCRouteConfigEntryBase & {
@@ -204,7 +205,7 @@ declare function matchRSCServerRequest({
   onError,
   request,
   routes,
-  generateResponse
+  generateResponse: encodeResponse
 }: {
   allowedActionOrigins?: string[];
   createTemporaryReferenceSet: () => unknown;

package/dist/production/lib/rsc/server.ssr.js

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

package/dist/production/lib/server-runtime/build.d.ts

@@ -19,7 +19,21 @@ interface ServerBuild {
   publicPath: string;
   assetsBuildDirectory: string;
   future: FutureConfig;
+  /**
+   * Whether runtime server requests are supported, including API-only builds.
+   */
   ssr: boolean;
+  /**
+   * The origin to use for server requests in API-only mode.
+   * @internal
+   */
+  unstable_apiServerOrigin?: string;
+  /**
+   * Whether production document rendering is disabled while data and route
+   * discovery requests remain supported.
+   * @internal
+   */
+  unstable_apiOnly?: boolean;
   unstable_getCriticalCss?: (args: {
     pathname: string;
   }) => OptionalCriticalCss | Promise<OptionalCriticalCss>;

package/dist/production/lib/server-runtime/cookies.js

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

package/dist/production/lib/server-runtime/crypto.js

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

package/dist/production/lib/server-runtime/data.js

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

package/dist/production/lib/server-runtime/dev.js

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

package/dist/production/lib/server-runtime/entry.js

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

package/dist/production/lib/server-runtime/errors.js

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

package/dist/production/lib/server-runtime/headers.js

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

package/dist/production/lib/server-runtime/invariant.js

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

package/dist/production/lib/server-runtime/mode.js

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

package/dist/production/lib/server-runtime/routeMatching.js

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

package/dist/production/lib/server-runtime/routes.d.ts

@@ -1,7 +1,7 @@
 
 import { RouteManifest } from "../router/utils.js";
-import { ServerRouteModule } from "../dom/ssr/routeModules.js";
 import { Route } from "../dom/ssr/routes.js";
+import { ServerRouteModule } from "../dom/ssr/routeModules.js";
 
 //#region lib/server-runtime/routes.d.ts
 type ServerRouteManifest = RouteManifest<Omit<ServerRoute, "children">>;

package/dist/production/lib/server-runtime/routes.js

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

package/dist/production/lib/server-runtime/server.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.4.0
+ * react-router v8.5.0
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -58,7 +58,7 @@ function derive(build, mode) {
 		let normalizedPath = getNormalizedPath(request);
 		let normalizedPathname = normalizedPath.pathname;
 		let isSpaMode = getBuildTimeHeader(request, "X-React-Router-SPA-Mode") === "yes";
-		if (!build.ssr) {
+		if (!build.ssr || build.unstable_apiOnly) {
 			let decodedPath = decodeURI(normalizedPathname);
 			if (build.basename && build.basename !== "/") {
 				let strippedPath = stripBasename(decodedPath, build.basename);
@@ -76,7 +76,7 @@ function derive(build, mode) {
 				decodedPath = strippedPath;
 			}
 			if (build.prerender.length === 0) isSpaMode = true;
-			else if (!build.prerender.some((p) => removeTrailingSlash(p) === removeTrailingSlash(decodedPath))) if (requestUrl.pathname.endsWith(".data")) {
+			else if (!build.prerender.some((p) => removeTrailingSlash(p) === removeTrailingSlash(decodedPath))) if (requestUrl.pathname.endsWith(".data") && !build.unstable_apiOnly) {
 				errorHandler(new ErrorResponseImpl(404, "Not Found", `Refusing to SSR the path \`${decodedPath}\` because \`ssr:false\` is set and the path is not included in the \`prerender\` config, so in production the path will be a 404.`), {
 					context: loadContext,
 					params,
@@ -95,6 +95,10 @@ function derive(build, mode) {
 			handleError(e);
 			return new Response("Unknown Server Error", { status: 500 });
 		}
+		if (build.unstable_apiOnly && serverMode !== "development" && !requestUrl.pathname.endsWith(".data") && getBuildTimeHeader(request, "X-React-Router-SPA-Mode") !== "yes" && getBuildTimeHeader(request, "X-React-Router-Prerender") !== "yes") return new Response(null, {
+			status: 404,
+			statusText: "Not Found"
+		});
 		let matches = matchServerRoutes(build.routes, staticHandler, normalizedPathname);
 		if (matches && matches.length > 0) Object.assign(params, matches[0].params);
 		if (requestHandlerInstrumentations?.length) loadContext.set(instrumentationResultMetaContext, {
@@ -252,7 +256,9 @@ async function handleDocumentRequest(serverMode, build, staticHandler, request,
 			future: build.future,
 			routeDiscovery: build.routeDiscovery,
 			ssr: build.ssr,
-			isSpaMode
+			isSpaMode,
+			unstable_apiOnly: build.unstable_apiOnly,
+			unstable_apiServerOrigin: build.unstable_apiServerOrigin
 		};
 		let entryContext = {
 			manifest: build.assets,
@@ -270,6 +276,8 @@ async function handleDocumentRequest(serverMode, build, staticHandler, request,
 			ssr: build.ssr,
 			routeDiscovery: build.routeDiscovery,
 			isSpaMode,
+			unstable_apiOnly: build.unstable_apiOnly,
+			unstable_apiServerOrigin: build.unstable_apiServerOrigin,
 			serializeError: (err) => serializeError(err, serverMode)
 		};
 		let handleDocumentRequestFunction = build.entry.module.default;

package/dist/production/lib/server-runtime/serverHandoff.d.ts

@@ -0,0 +1,17 @@
+
+import { CriticalCss, FutureConfig } from "../dom/ssr/entry.js";
+import { ServerBuild } from "./build.js";
+
+//#region lib/server-runtime/serverHandoff.d.ts
+type ServerHandoff = {
+  criticalCss?: CriticalCss;
+  basename: string | undefined;
+  future: FutureConfig;
+  ssr: boolean;
+  isSpaMode: boolean;
+  unstable_apiOnly?: boolean;
+  unstable_apiServerOrigin?: string;
+  routeDiscovery: ServerBuild["routeDiscovery"];
+};
+//#endregion
+export { ServerHandoff };

package/dist/production/lib/server-runtime/serverHandoff.js

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

package/dist/production/lib/server-runtime/sessions/cookieStorage.js

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

package/dist/production/lib/server-runtime/sessions/memoryStorage.js

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

package/dist/production/lib/server-runtime/sessions.js

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

package/dist/production/lib/server-runtime/single-fetch.js

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

package/dist/production/lib/server-runtime/urls.js

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

package/dist/production/lib/server-runtime/warnings.js

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

package/dist/production/lib/types/internal.js

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

package/dist/production/lib/types/route-data.d.ts

@@ -1,10 +1,10 @@
 
 import { DataWithResponseInit, RouterContextProvider } from "../router/utils.js";
+import { ClientActionFunctionArgs, ClientLoaderFunctionArgs } from "../dom/ssr/routeModules.js";
+import { Serializable } from "../server-runtime/single-fetch.js";
 import { Equal, Func, IsAny } from "./utils.js";
 import { RouteModule } from "./route-module.js";
 import { unstable_SerializesTo } from "./serializes-to.js";
-import { Serializable } from "../server-runtime/single-fetch.js";
-import { ClientActionFunctionArgs, ClientLoaderFunctionArgs } from "../dom/ssr/routeModules.js";
 
 //#region lib/types/route-data.d.ts
 type Serialize<T> = T extends unstable_SerializesTo<infer To> ? To : T extends Serializable ? T : T extends ((...args: any[]) => unknown) ? undefined : T extends Promise<infer U> ? Promise<Serialize<U>> : T extends Map<infer K, infer V> ? Map<Serialize<K>, Serialize<V>> : T extends ReadonlyMap<infer K, infer V> ? ReadonlyMap<Serialize<K>, Serialize<V>> : T extends Set<infer U> ? Set<Serialize<U>> : T extends ReadonlySet<infer U> ? ReadonlySet<Serialize<U>> : T extends [] ? [] : T extends readonly [infer F, ...infer R] ? [Serialize<F>, ...Serialize<R>] : T extends Array<infer U> ? Array<Serialize<U>> : T extends readonly unknown[] ? readonly Serialize<T[number]>[] : T extends Record<any, any> ? { [K in keyof T]: Serialize<T[K]> } : undefined;

package/dist/production/lib/types/route-module-annotations.d.ts

@@ -2,10 +2,10 @@
 import { Location } from "../router/history.js";
 import { DataStrategyResult, MiddlewareNextFunction } from "../router/utils.js";
 import { LinkDescriptor } from "../router/links.js";
+import { MetaDescriptor } from "../dom/ssr/routeModules.js";
 import { Func, Pretty } from "./utils.js";
 import { RouteModule } from "./route-module.js";
 import { ClientDataFunctionArgs, GetLoaderData, ServerDataFrom, ServerDataFunctionArgs } from "./route-data.js";
-import { MetaDescriptor } from "../dom/ssr/routeModules.js";
 
 //#region lib/types/route-module-annotations.d.ts
 type MaybePromise<T> = T | Promise<T>;

package/dist/production/route-pattern.js

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

package/dist/production/vendor/turbo-stream-v2/flatten.js

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

package/dist/production/vendor/turbo-stream-v2/turbo-stream.js

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

package/dist/production/vendor/turbo-stream-v2/unflatten.js

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

package/dist/production/vendor/turbo-stream-v2/utils.js

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

package/docs/explanation/lazy-route-discovery.md

@@ -76,3 +76,7 @@ When using lazy route discovery, ensure your deployment setup handles manifest r
 - **Route Handling** - Ensure `/__manifest` requests reach your React Router handler
 - **CDN Caching** - If using CDN/edge caching, include `version` and `paths` query parameters in your cache key for the manifest endpoint
 - **Multiple Applications** - Use a custom `manifestPath` if running multiple React Router applications on the same domain
+
+## Application-Controlled Discovery
+
+Use the experimental `unstable_useRouteDiscovery` hook to discover selected destinations, complete the route tree after startup, or control manifest-mismatch recovery. See [Application-Controlled Route Discovery](../how-to/route-discovery).

package/docs/explanation/sessions-and-cookies.md

@@ -59,28 +59,130 @@ The input/output to a session storage object are HTTP cookies. `getSession()` re
 
 You'll use methods to get access to sessions in your `loader` and `action` functions.
 
-After retrieving a session with `getSession`, the returned session object has a handful of methods and properties:
+### Session API
+
+After retrieving a session with `getSession()`, the returned session object has a handful of methods and properties:
 
 ```tsx
 export async function action({
   request,
-}: ActionFunctionArgs) {
+}: Route.ActionArgs) {
   const session = await getSession(
     request.headers.get("Cookie"),
   );
+
   session.get("foo");
   session.has("bar");
   // etc.
+
+  return redirect("/", {
+    headers: {
+      "Set-Cookie": await commitSession(session),
+    },
+  });
 }
 ```
 
-See the [Session API][session-api] for all methods available on the session object.
+<docs-warning>Every time you modify session data, you must `commitSession()` or your changes will be lost. When using cookie session storage, you must also send the `Set-Cookie` header it returns in your response.</docs-warning>
+
+See the [Session API][session-api] for all methods and properties available on the session object.
+
+#### `session.has(key)`
+
+Returns `true` if the session has a value (or an unread flash value) for the given `key`. This does not consume flash values.
+
+```ts
+session.has("userId");
+```
+
+#### `session.set(key, value)`
+
+Sets a session value for use in subsequent requests:
+
+```ts
+session.set("userId", "1234");
+```
+
+#### `session.flash(key, value)`
+
+Sets a session value that is only valid until the next `session.get()` for that key. After that, it's gone. Most useful for "flash messages" and server-side form validation messages:
+
+```ts
+session.flash(
+  "globalMessage",
+  "Project successfully archived",
+);
+```
+
+A flash value is typically set in an `action` before a redirect, then read in the `loader` of the page being redirected to:
+
+```tsx filename=app/routes/projects.tsx
+export async function action({
+  request,
+}: Route.ActionArgs) {
+  const session = await getSession(
+    request.headers.get("Cookie"),
+  );
+  // ...archive the project
+  session.flash(
+    "globalMessage",
+    "Project successfully archived",
+  );
+  return redirect("/projects", {
+    headers: {
+      "Set-Cookie": await commitSession(session),
+    },
+  });
+}
+
+export async function loader({
+  request,
+}: Route.LoaderArgs) {
+  const session = await getSession(
+    request.headers.get("Cookie"),
+  );
+  // Reading a flash value removes it from the session
+  const message = session.get("globalMessage");
+
+  return data(
+    { message },
+    {
+      headers: {
+        // Commit the session so the flash value is removed
+        "Set-Cookie": await commitSession(session),
+      },
+    },
+  );
+}
+```
+
+Flash values are read with `session.get()` using the same key they were set with. Reading a flash value removes it from the session, so you must still `commitSession()` after reading it; otherwise the flash value will be read again on the next request.
+
+Avoid using the same key for both `session.set()` and `session.flash()`. `session.get()` returns the regular value first, so the flash value would never be read or removed.
+
+You can type flash values separately from regular session values with the second generic on your session storage, like the `SessionFlashData` type in [Using Sessions](#using-sessions).
+
+#### `session.get(key)`
+
+Accesses a session value from a previous request:
+
+```ts
+session.get("name");
+```
+
+#### `session.unset(key)`
+
+Removes a value from the session. This does not remove pending flash values; those are only removed when read with `session.get()`.
+
+```ts
+session.unset("name");
+```
 
 ### Login form example
 
 A login form might look something like this:
 
-```tsx filename=app/routes/login.tsx lines=[4-7,12-14,16,22,25,33-35,46,51,56,61]
+```tsx filename=app/routes/login.tsx lines=[4-7,12-14,16,22-23,26,35-37,48-49,54,59,64]
 import { data, redirect } from "react-router";
 import type { Route } from "./+types/login";
 
@@ -102,6 +204,7 @@ export async function loader({
   }
 
   return data(
+    // Read and unset the flash message set by the route action.
     { error: session.get("error") },
     {
       headers: {
@@ -127,6 +230,7 @@ export async function action({
   );
 
   if (userId == null) {
+    // Set a single-use flash message to be read by the route loader.
     session.flash("error", "Invalid username/password");
 
     // Redirect back to the login page with errors.