fix(rsc): rename "server" APIs to use "RSC"

markdalgleish · markdalgleish · commit 14b5858e8675 · 2025-06-26T12:31:25.000+10:00
diff --git a/docs/api/rsc/RSCHydratedRouter.md b/docs/api/rsc/RSCHydratedRouter.md
@@ -8,7 +8,7 @@ title: RSCHydratedRouter
 
 ## Summary
 
-Hydrates a server rendered `ServerPayload` in the browser.
+Hydrates a server rendered `RSCPayload` in the browser.
 
 ## Props
 
@@ -18,7 +18,7 @@ Your `react-server-dom-xyz/client`'s `createFromReadableStream` function, used t
 
 ### payload
 
-The decoded ServerPayload to hydrate.
+The decoded `RSCPayload` to hydrate.
 
 ### routeDiscovery
 
diff --git a/docs/api/rsc/RSCStaticRouter.md b/docs/api/rsc/RSCStaticRouter.md
@@ -8,10 +8,10 @@ title: RSCStaticRouter
 
 ## Summary
 
-Pre-renders a `ServerPayload` to HTML. Usually used in `routeRSCServerRequest`'s `renderHTML` callback.
+Pre-renders an `RSCPayload` to HTML. Usually used in `routeRSCServerRequest`'s `renderHTML` callback.
 
 ## Props
 
 ### getPayload
 
-A function that starts decoding of the ServerPayload. Usually passed through from `routeRSCServerRequest`'s `renderHTML`.
+A function that starts decoding of the `RSCPayload`. Usually passed through from `routeRSCServerRequest`'s `renderHTML`.
diff --git a/docs/api/rsc/getRSCStream.md b/docs/api/rsc/getRSCStream.md
@@ -1,8 +1,8 @@
 ---
-title: getServerStream
+title: getRSCStream
 ---
 
-# getServerStream
+# getRSCStream
 
 [MODES: data]
 
diff --git a/docs/api/rsc/matchRSCServerRequest.md b/docs/api/rsc/matchRSCServerRequest.md
@@ -8,7 +8,7 @@ title: matchRSCServerRequest
 
 ## Summary
 
-Matches the given routes to a Request and returns a RSC Response encoding a `ServerPayload` for consumption by a RSC enabled client router.
+Matches the given routes to a Request and returns a RSC Response encoding an `RSCPayload` for consumption by a RSC enabled client router.
 
 ## Options
 
@@ -26,7 +26,7 @@ A function responsible for decoding form state for progressively enhanceable for
 
 ### generateResponse
 
-A function responsible for using your `renderToReadableStream` to generate a Response encoding the `ServerPayload`.
+A function responsible for using your `renderToReadableStream` to generate a Response encoding the `RSCPayload`.
 
 ### loadServerAction
 
diff --git a/docs/api/rsc/routeRSCServerRequest.md b/docs/api/rsc/routeRSCServerRequest.md
@@ -18,11 +18,11 @@ Your `react-server-dom-xyz/client`'s `createFromReadableStream` function, used t
 
 ### fetchServer
 
-A function that forwards a `Request` to the RSC handler and returns a `Promise<Response>` containing a serialized `ServerPayload`.
+A function that forwards a `Request` to the RSC handler and returns a `Promise<Response>` containing a serialized `RSCPayload`.
 
 ### renderHTML
 
-A function that renders the `ServerPayload` to HTML, usually using a `<RSCStaticRouter>`.
+A function that renders the `RSCPayload` to HTML, usually using a `<RSCStaticRouter>`.
 
 ### request
 
diff --git a/docs/start/rsc/installation.md b/docs/start/rsc/installation.md
@@ -184,9 +184,9 @@ Create a `src/browser.tsx` file that will act as the entrypoint for hydration.
 import { startTransition, StrictMode } from "react";
 import { hydrateRoot } from "react-dom/client";
 import {
-  type unstable_ServerPayload as ServerPayload,
+  type unstable_RSCPayload as RSCPayload,
   unstable_createCallServer as createCallServer,
-  unstable_getServerStream as getServerStream,
+  unstable_getRSCStream as getRSCStream,
   unstable_RSCHydratedRouter as RSCHydratedRouter,
 } from "react-router";
 import {
@@ -205,8 +205,8 @@ setServerCallback(
 );
 
 // Get and decode the initial server payload
-createFromReadableStream(getServerStream()).then(
-  (payload: ServerPayload) => {
+createFromReadableStream(getRSCStream()).then(
+  (payload: RSCPayload) => {
     startTransition(async () => {
       hydrateRoot(
         document,
@@ -231,7 +231,7 @@ Create a `src/routes/routes.ts` file that will define our routes with dynamic im
 ```ts nonumber
 "use server-entry";
 
-import type { unstable_ServerRouteObject as ServerRouteObject } from "react-router";
+import type { unstable_RSCRouteConfig as RSCRouteConfig } from "react-router";
 
 import "../browser";
 
@@ -254,7 +254,7 @@ export function routes() {
         },
       ],
     },
-  ] satisfies ServerRouteObject[];
+  ] satisfies RSCRouteConfig;
 }
 ```
 
diff --git a/integration/helpers/rsc-parcel/src/browser.tsx b/integration/helpers/rsc-parcel/src/browser.tsx
@@ -2,10 +2,10 @@
 
 import { startTransition, StrictMode } from "react";
 import { hydrateRoot } from "react-dom/client";
-import type { unstable_ServerPayload as ServerPayload } from "react-router";
+import type { unstable_RSCPayload as RSCPayload } from "react-router";
 import {
   unstable_createCallServer as createCallServer,
-  unstable_getServerStream as getServerStream,
+  unstable_getRSCStream as getRSCStream,
   unstable_RSCHydratedRouter as RSCHydratedRouter,
 } from "react-router";
 import {
@@ -24,7 +24,7 @@ setServerCallback(
 );
 
 // Get and decode the initial server payload
-createFromReadableStream(getServerStream()).then((payload: ServerPayload) => {
+createFromReadableStream(getRSCStream()).then((payload: RSCPayload) => {
   // @ts-expect-error - on 18 types, requires 19.
   startTransition(async () => {
     const formState =
diff --git a/integration/helpers/rsc-parcel/src/routes.ts b/integration/helpers/rsc-parcel/src/routes.ts
@@ -1,4 +1,4 @@
-import type { unstable_ServerRouteObject as ServerRouteObject } from "react-router";
+import type { unstable_RSCRouteConfig as RSCRouteConfig } from "react-router";
 
 export const routes = [
   {
@@ -13,4 +13,4 @@ export const routes = [
       },
     ],
   },
-] satisfies ServerRouteObject[];
+] satisfies RSCRouteConfig;
diff --git a/integration/helpers/rsc-vite/src/entry.browser.tsx b/integration/helpers/rsc-vite/src/entry.browser.tsx
@@ -7,10 +7,10 @@ import {
 } from "@hiogawa/vite-rsc/browser";
 import {
   unstable_createCallServer as createCallServer,
-  unstable_getServerStream as getServerStream,
+  unstable_getRSCStream as getRSCStream,
   unstable_RSCHydratedRouter as RSCHydratedRouter,
 } from "react-router";
-import type { unstable_ServerPayload as ServerPayload } from "react-router";
+import type { unstable_RSCPayload as RSCPayload } from "react-router";
 
 setServerCallback(
   createCallServer({
@@ -19,7 +19,7 @@ setServerCallback(
   })
 );
 
-createFromReadableStream<ServerPayload>(getServerStream()).then((payload) => {
+createFromReadableStream<RSCPayload>(getRSCStream()).then((payload) => {
   startTransition(() => {
     hydrateRoot(
       document,
diff --git a/integration/helpers/rsc-vite/src/routes.ts b/integration/helpers/rsc-vite/src/routes.ts
@@ -1,4 +1,4 @@
-import type { unstable_ServerRouteObject as ServerRouteObject } from "react-router";
+import type { unstable_RSCRouteConfig as RSCRouteConfig } from "react-router";
 
 export const routes = [
   {
@@ -13,4 +13,4 @@ export const routes = [
       },
     ],
   },
-] satisfies ServerRouteObject[];
+] satisfies RSCRouteConfig;
diff --git a/integration/rsc/rsc-test.ts b/integration/rsc/rsc-test.ts
@@ -209,7 +209,7 @@ implementations.forEach((implementation) => {
           port,
           files: {
             "src/routes.ts": js`
-              import type { unstable_ServerRouteObject as ServerRouteObject } from "react-router";
+              import type { unstable_RSCRouteConfig as RSCRouteConfig } from "react-router";
 
               export const routes = [
                 {
@@ -229,7 +229,7 @@ implementations.forEach((implementation) => {
                     },
                   ],
                 },
-              ] satisfies ServerRouteObject[];
+              ] satisfies RSCRouteConfig;
             `,
             "src/routes/home.tsx": js`
               import { Link } from "react-router";
@@ -340,7 +340,7 @@ implementations.forEach((implementation) => {
           port,
           files: {
             "src/routes.ts": js`
-              import type { unstable_ServerRouteObject as ServerRouteObject } from "react-router";
+              import type { unstable_RSCRouteConfig as RSCRouteConfig } from "react-router";
 
               export const routes = [
                 {
@@ -360,7 +360,7 @@ implementations.forEach((implementation) => {
                     },
                   ],
                 },
-              ] satisfies ServerRouteObject[];
+              ] satisfies RSCRouteConfig;
             `,
             "src/routes/home.tsx": js`
               import { Link } from "react-router";
@@ -473,7 +473,7 @@ implementations.forEach((implementation) => {
           port,
           files: {
             "src/routes.ts": js`
-              import type { unstable_ServerRouteObject as ServerRouteObject } from "react-router";
+              import type { unstable_RSCRouteConfig as RSCRouteConfig } from "react-router";
 
               export const routes = [
                 {
@@ -493,7 +493,7 @@ implementations.forEach((implementation) => {
                   path: "resource",
                   lazy: () => import("./routes/resource"),
                 },
-              ] satisfies ServerRouteObject[];
+              ] satisfies RSCRouteConfig;
             `,
             "src/routes/resource.tsx": js`
               export function loader() {
diff --git a/packages/react-router/index-react-server.ts b/packages/react-router/index-react-server.ts
@@ -7,13 +7,14 @@ export type {
   DecodeFormStateFunction as unstable_DecodeFormStateFunction,
   DecodeReplyFunction as unstable_DecodeReplyFunction,
   LoadServerActionFunction as unstable_LoadServerActionFunction,
-  ServerManifestPayload as unstable_ServerManifestPayload,
-  ServerMatch as unstable_ServerMatch,
-  ServerPayload as unstable_ServerPayload,
-  ServerRenderPayload as unstable_ServerRenderPayload,
-  RenderedRoute as ServerRouteManifest,
-  ServerRouteMatch as unstable_ServerRouteMatch,
-  ServerRouteObject as unstable_ServerRouteObject,
+  RSCManifestPayload as unstable_RSCManifestPayload,
+  RSCMatch as unstable_RSCMatch,
+  RSCPayload as unstable_RSCPayload,
+  RSCRenderPayload as unstable_RSCRenderPayload,
+  RSCRouteManifest as unstable_RSCRouteManifest,
+  RSCRouteMatch as unstable_RSCRouteMatch,
+  RSCRouteConfigEntry as unstable_RSCRouteConfigEntry,
+  RSCRouteConfig as unstable_RSCRouteConfig,
 } from "./lib/rsc/server.rsc";
 
 // RSC implementation of agnostic APIs
diff --git a/packages/react-router/index.ts b/packages/react-router/index.ts
@@ -292,7 +292,7 @@ export {
   routeRSCServerRequest as unstable_routeRSCServerRequest,
   RSCStaticRouter as unstable_RSCStaticRouter,
 } from "./lib/rsc/server.ssr";
-export { getServerStream as unstable_getServerStream } from "./lib/rsc/html-stream/browser";
+export { getRSCStream as unstable_getRSCStream } from "./lib/rsc/html-stream/browser";
 export { RSCDefaultRootErrorBoundary as UNSAFE_RSCDefaultRootErrorBoundary } from "./lib/rsc/errorBoundaries";
 
 // Re-export of RSC types
@@ -305,13 +305,14 @@ export type {
   DecodeFormStateFunction as unstable_DecodeFormStateFunction,
   DecodeReplyFunction as unstable_DecodeReplyFunction,
   LoadServerActionFunction as unstable_LoadServerActionFunction,
-  ServerManifestPayload as unstable_ServerManifestPayload,
-  ServerMatch as unstable_ServerMatch,
-  ServerPayload as unstable_ServerPayload,
-  ServerRenderPayload as unstable_ServerRenderPayload,
-  RenderedRoute as ServerRouteManifest,
-  ServerRouteMatch as unstable_ServerRouteMatch,
-  ServerRouteObject as unstable_ServerRouteObject,
+  RSCManifestPayload as unstable_RSCManifestPayload,
+  RSCMatch as unstable_RSCMatch,
+  RSCPayload as unstable_RSCPayload,
+  RSCRenderPayload as unstable_RSCRenderPayload,
+  RSCRouteManifest as unstable_RSCRouteManifest,
+  RSCRouteMatch as unstable_RSCRouteMatch,
+  RSCRouteConfigEntry as unstable_RSCRouteConfigEntry,
+  RSCRouteConfig as unstable_RSCRouteConfig,
 } from "./lib/rsc/server.rsc";
 
 ///////////////////////////////////////////////////////////////////////////////
diff --git a/packages/react-router/lib/rsc/browser.tsx b/packages/react-router/lib/rsc/browser.tsx
@@ -13,9 +13,9 @@ import { createBrowserHistory, invariant } from "../router/history";
 import type { Router as DataRouter } from "../router/router";
 import { createRouter, isMutationMethod } from "../router/router";
 import type {
-  ServerPayload,
-  RenderedRoute,
-  ServerRenderPayload,
+  RSCPayload,
+  RSCRouteManifest,
+  RSCRenderPayload,
   CreateFromReadableStreamFunction,
 } from "./server.rsc";
 import type {
@@ -80,7 +80,7 @@ export function createCallServer({
     }
     const payload = (await createFromReadableStream(
       response.body
-    )) as ServerPayload;
+    )) as RSCPayload;
 
     if (payload.type === "redirect") {
       if (payload.reload) {
@@ -118,7 +118,7 @@ export function createCallServer({
             return;
           }
 
-          let lastMatch: RenderedRoute | undefined;
+          let lastMatch: RSCRouteManifest | undefined;
           for (const match of rerender.matches) {
             window.__router.patchRoutes(
               lastMatch?.id ?? null,
@@ -158,15 +158,15 @@ function createRouterFromPayload({
   createFromReadableStream,
   payload,
 }: {
-  payload: ServerPayload;
+  payload: RSCPayload;
   createFromReadableStream: CreateFromReadableStreamFunction;
   fetchImplementation: (request: Request) => Promise<Response>;
 }) {
   if (window.__router) return window.__router;
 
   if (payload.type !== "render") throw new Error("Invalid payload type");
 
-  let patches = new Map<string, RenderedRoute[]>();
+  let patches = new Map<string, RSCRouteManifest[]>();
   payload.patches?.forEach((patch) => {
     invariant(patch.parentId, "Invalid patch parentId");
     if (!patches.has(patch.parentId)) {
@@ -255,7 +255,7 @@ function createRouterFromPayload({
   return window.__router;
 }
 
-const renderedRoutesContext = unstable_createContext<RenderedRoute[]>();
+const renderedRoutesContext = unstable_createContext<RSCRouteManifest[]>();
 
 export function getRSCSingleFetchDataStrategy(
   getRouter: () => DataRouter,
@@ -321,7 +321,7 @@ export function getRSCSingleFetchDataStrategy(
       // with the same ID. This is currently happening in `clientLoader` cases
       // where we're calling `fetchAndDecode` multiple times. This may be a
       // sign of a logical error in how we're handling client loader routes.
-      const renderedRoutesById = new Map<string, RenderedRoute[]>();
+      const renderedRoutesById = new Map<string, RSCRouteManifest[]>();
       for (const route of context.get(renderedRoutesContext)) {
         if (!renderedRoutesById.has(route.id)) {
           renderedRoutesById.set(route.id, []);
@@ -375,9 +375,7 @@ function getFetchAndDecodeViaRSC(
     invariant(res.body, "No response body to decode");
 
     try {
-      const payload = (await createFromReadableStream(
-        res.body
-      )) as ServerPayload;
+      const payload = (await createFromReadableStream(res.body)) as RSCPayload;
       if (payload.type === "redirect") {
         return {
           status: res.status,
@@ -438,7 +436,7 @@ export function RSCHydratedRouter({
 }: {
   createFromReadableStream: CreateFromReadableStreamFunction;
   fetch?: (request: Request) => Promise<Response>;
-  payload: ServerPayload;
+  payload: RSCPayload;
   routeDiscovery?: "eager" | "lazy";
 }) {
   if (payload.type !== "render") throw new Error("Invalid payload type");
@@ -590,8 +588,8 @@ type DataRouteObjectWithManifestInfo = DataRouteObject & {
 };
 
 function createRouteFromServerManifest(
-  match: RenderedRoute,
-  payload?: ServerRenderPayload
+  match: RSCRouteManifest,
+  payload?: RSCRenderPayload
 ): DataRouteObjectWithManifestInfo {
   let hasInitialData = payload && match.id in payload.loaderData;
   let initialData = payload?.loaderData[match.id];
@@ -757,9 +755,7 @@ async function fetchAndApplyManifestPatches(
     throw new Error("Unable to fetch new route matches from the server");
   }
 
-  let payload = (await createFromReadableStream(
-    response.body
-  )) as ServerPayload;
+  let payload = (await createFromReadableStream(response.body)) as RSCPayload;
   if (payload.type !== "manifest") {
     throw new Error("Failed to patch routes");
   }
diff --git a/packages/react-router/lib/rsc/html-stream/browser.ts b/packages/react-router/lib/rsc/html-stream/browser.ts
diff --git a/packages/react-router/lib/rsc/server.rsc.ts b/packages/react-router/lib/rsc/server.rsc.ts
diff --git a/packages/react-router/lib/rsc/server.ssr.tsx b/packages/react-router/lib/rsc/server.ssr.tsx
diff --git a/playground/rsc-parcel/src/entry.browser.tsx b/playground/rsc-parcel/src/entry.browser.tsx
diff --git a/playground/rsc-parcel/src/routes.ts b/playground/rsc-parcel/src/routes.ts
diff --git a/playground/rsc-vite/src/entry.browser.tsx b/playground/rsc-vite/src/entry.browser.tsx
diff --git a/playground/rsc-vite/src/routes.ts b/playground/rsc-vite/src/routes.ts
