feat: RSC Router APIs (#13700)

Co-authored-by: Jacob Ebey <[email protected]>
Co-authored-by: Matt Brophy <[email protected]>
Co-authored-by: Mark Dalgleish <[email protected]>
Co-authored-by: Hiroshi Ogawa <[email protected]>

Author: 4 people

.changeset/late-lobsters-check.md

@@ -0,0 +1,7 @@
+---
+"react-router": minor
+---
+
+Add unstable RSC support
+
+For more information, see the [RSC documentation](https://reactrouter.com/start/rsc/installation).

.eslintignore

@@ -6,6 +6,15 @@ examples/**/dist/
 worker-configuration.d.ts
 /playground/
 /playground-local/
+integration/helpers/**/dist/
+integration/helpers/**/build/
+playwright-report/
+test-results/
+build.utils.d.ts
+.wrangler/
+.tmp/
+.react-router/
+.react-router-parcel/
 packages/**/dist/
 packages/react-router-dom/server.d.ts
 packages/react-router-dom/server.js

.github/workflows/integration-full.yml

@@ -40,7 +40,7 @@ jobs:
     uses: ./.github/workflows/shared-integration.yml
     with:
       os: "windows-latest"
-      node_version: "[20, 22]"
+      node_version: "[22]"
       browser: '["msedge"]'
 
   integration-macos:

.github/workflows/integration-pr-windows-macos.yml

@@ -32,7 +32,7 @@ jobs:
       os: "windows-latest"
       node_version: "[22]"
       browser: '["msedge"]'
-      timeout: 60
+      timeout: 120
 
   integration-webkit:
     name: "👀 Integration Test"

.gitignore

@@ -27,6 +27,7 @@ node_modules/
 
 .wireit
 .eslintcache
+.parcel-cache
 .tmp
 tsup.config.bundled_*.mjs
 build.utils.d.ts

.nvmrc

@@ -1 +1 @@
-20
+22

contributors.yml

@@ -132,6 +132,7 @@
 - hampelm
 - harshmangalam
 - hernanif1
+- hi-ogawa
 - HK-SHAO
 - holynewbie
 - hongji00

docs/api/rsc/RSCHydratedRouter.md

@@ -0,0 +1,25 @@
+---
+title: RSCHydratedRouter
+---
+
+# RSCHydratedRouter
+
+[MODES: data]
+
+## Summary
+
+Hydrates a server rendered `RSCPayload` in the browser.
+
+## Props
+
+### createFromReadableStream
+
+Your `react-server-dom-xyz/client`'s `createFromReadableStream` function, used to decode payloads from the server.
+
+### payload
+
+The decoded `RSCPayload` to hydrate.
+
+### routeDiscovery
+
+`eager` or `lazy` - Determines if links are eagerly discovered, or delayed until clicked.

docs/api/rsc/RSCStaticRouter.md

@@ -0,0 +1,17 @@
+---
+title: RSCStaticRouter
+---
+
+# RSCStaticRouter
+
+[MODES: data]
+
+## Summary
+
+Pre-renders an `RSCPayload` to HTML. Usually used in `routeRSCServerRequest`'s `renderHTML` callback.
+
+## Props
+
+### getPayload
+
+A function that starts decoding of the `RSCPayload`. Usually passed through from `routeRSCServerRequest`'s `renderHTML`.

docs/api/rsc/createCallServer.md

@@ -0,0 +1,21 @@
+---
+title: createCallServer
+---
+
+# createCallServer
+
+[MODES: data]
+
+## Summary
+
+Create a React `callServer` implementation for React Router.
+
+## Options
+
+### createFromReadableStream
+
+Your `react-server-dom-xyz/client`'s `createFromReadableStream`. Used to decode payloads from the server.
+
+### encodeReply
+
+Your `react-server-dom-xyz/client`'s `encodeReply`. Used when sending payloads to the server.