rsbuild-plugin-react-router 0.6.5 → 0.6.6

package/README.md

@@ -465,6 +465,29 @@ and every configured bundle are
 evaluated and published as one generation; one failing bundle keeps the whole
 previous generation active.
 
+### Sharing `createContext()` instances with a custom server
+
+React Router middleware contexts are matched by identity, so a custom server's
+`getLoadContext` must use the same `createContext()` instance the routes import.
+With a bundled server build that instance lives inside the build. Re-export it
+from `app/entry.server.tsx` and read it from `build.entry.module`:
+
+```ts
+// app/entry.server.tsx
+export { valueContext } from './context';
+```
+
+```js
+// server.js
+getLoadContext: async () => {
+  const { valueContext } = (await build()).entry.module;
+  return new RouterContextProvider([[valueContext, 'value']]);
+},
+```
+
+This works in development through `loadReactRouterServerBuild` and in
+production through `resolveReactRouterServerBuild`.
+
 `resolveReactRouterServerBuild` accepts an imported production server module,
 normalizes ESM and CommonJS namespace shapes, resolves supported asynchronous
 build exports, and validates the result before it reaches React Router.

package/dist/index.cjs

@@ -14691,7 +14691,11 @@ export {
     'react-router-serve-config',
     "bootstrap-scripts",
     'server-manifest'
-], createReactRouterRscResolveAliases = (rootPath)=>({
+], createReactRouterRscResolveAliases = (rootPath, options = {})=>({
+        ...options.entrySsrPath ? {
+            'virtual:react-router/unstable_rsc/entry-ssr': options.entrySsrPath,
+            'virtual/react-router/unstable_rsc/entry-ssr': options.entrySsrPath
+        } : {},
         ...Object.fromEntries(RSC_VIRTUAL_ALIAS_IDS.flatMap((id)=>{
             let moduleId = `virtual/react-router/unstable_rsc/${id}`, modulePath = (0, external_pathe_namespaceObject.resolve)(rootPath, getVirtualModuleFilePath(moduleId));
             return [
@@ -15559,7 +15563,7 @@ export {
             'react-router/dom$': reactRouterDomPath
         } : {}
     };
-}, createRscModePlan = async ({ allowedActionOriginsForBuild, api, appDirectory, basename, buildDirectory, customServer, finalEntryRscClientPath, finalEntryRscPath, isBuild, outputClientPath, pluginName, prerenderConfig, routeConfig, routeDiscovery, routes, rootRouteFile, serverBuildFile, splitRouteModules, ssr })=>{
+}, createRscModePlan = async ({ allowedActionOriginsForBuild, api, appDirectory, basename, buildDirectory, customServer, finalEntryRscClientPath, finalEntryRscPath, finalEntryRscSsrPath, isBuild, outputClientPath, pluginName, prerenderConfig, routeConfig, routeDiscovery, routes, rootRouteFile, serverBuildFile, splitRouteModules, ssr })=>{
     let rscServerEntryName = (serverBuildFile || 'index.js').replace(/\.js$/, '');
     return {
         kind: 'rsc',
@@ -15605,7 +15609,9 @@ export {
                     (0, external_pathe_namespaceObject.resolve)(rootPath, 'node_modules'),
                     'node_modules'
                 ],
-                alias: createReactRouterRscResolveAliases(rootPath)
+                alias: createReactRouterRscResolveAliases(rootPath, {
+                    entrySsrPath: finalEntryRscSsrPath
+                })
             }),
         server: customServer ? void 0 : {
             setup: createReactRouterRscDevServerSetup({
@@ -15964,6 +15970,7 @@ export {
                 buildDirectory,
                 finalEntryRscClientPath,
                 finalEntryRscPath,
+                finalEntryRscSsrPath,
                 outputClientPath,
                 pluginName: PLUGIN_NAME,
                 serverBuildFile

package/dist/index.js

@@ -9500,7 +9500,7 @@ export function EnsureClientRouteModuleForHMR___() { return ___EnsureClientRoute
         routesByServerBundleId,
         serverBundleEntries: serverBuildPlan.serverBundleEntries
     };
-}, RSC_LAYERS = rspack.experiments.rsc.Layers, createRscModePlan = async ({ allowedActionOriginsForBuild, api, appDirectory, basename, buildDirectory, customServer, finalEntryRscClientPath, finalEntryRscPath, isBuild, outputClientPath, pluginName, prerenderConfig, routeConfig, routeDiscovery, routes, rootRouteFile, serverBuildFile, splitRouteModules, ssr })=>{
+}, RSC_LAYERS = rspack.experiments.rsc.Layers, createRscModePlan = async ({ allowedActionOriginsForBuild, api, appDirectory, basename, buildDirectory, customServer, finalEntryRscClientPath, finalEntryRscPath, finalEntryRscSsrPath, isBuild, outputClientPath, pluginName, prerenderConfig, routeConfig, routeDiscovery, routes, rootRouteFile, serverBuildFile, splitRouteModules, ssr })=>{
     let rscServerEntryName = (serverBuildFile || 'index.js').replace(/\.js$/, '');
     return {
         kind: 'rsc',
@@ -9679,22 +9679,28 @@ export {
                     external_pathe_resolve(rootPath, 'node_modules'),
                     'node_modules'
                 ],
-                alias: {
-                    ...Object.fromEntries(RSC_VIRTUAL_ALIAS_IDS.flatMap((id)=>{
-                        let moduleId = `virtual/react-router/unstable_rsc/${id}`, modulePath = external_pathe_resolve(rootPath, getVirtualModuleFilePath(moduleId));
-                        return [
-                            [
-                                `virtual:react-router/unstable_rsc/${id}`,
-                                modulePath
-                            ],
-                            [
-                                moduleId,
-                                modulePath
-                            ]
-                        ];
-                    })),
-                    'react-router/internal/react-server-client': external_pathe_resolve(rootPath, getVirtualModuleFilePath('virtual/react-router/rsc-internal-client'))
-                }
+                alias: ((rootPath, options = {})=>({
+                        ...options.entrySsrPath ? {
+                            'virtual:react-router/unstable_rsc/entry-ssr': options.entrySsrPath,
+                            'virtual/react-router/unstable_rsc/entry-ssr': options.entrySsrPath
+                        } : {},
+                        ...Object.fromEntries(RSC_VIRTUAL_ALIAS_IDS.flatMap((id)=>{
+                            let moduleId = `virtual/react-router/unstable_rsc/${id}`, modulePath = external_pathe_resolve(rootPath, getVirtualModuleFilePath(moduleId));
+                            return [
+                                [
+                                    `virtual:react-router/unstable_rsc/${id}`,
+                                    modulePath
+                                ],
+                                [
+                                    moduleId,
+                                    modulePath
+                                ]
+                            ];
+                        })),
+                        'react-router/internal/react-server-client': external_pathe_resolve(rootPath, getVirtualModuleFilePath('virtual/react-router/rsc-internal-client'))
+                    }))(rootPath, {
+                    entrySsrPath: finalEntryRscSsrPath
+                })
             }),
         server: customServer ? void 0 : {
             setup: function({ entryName, pluginName }) {
@@ -10501,6 +10507,7 @@ export {
                 buildDirectory,
                 finalEntryRscClientPath,
                 finalEntryRscPath,
+                finalEntryRscSsrPath,
                 outputClientPath,
                 pluginName: PLUGIN_NAME,
                 serverBuildFile

package/dist/mode-plan.d.ts

@@ -69,6 +69,7 @@ type CreateRscModePlanOptions = ModePlanContext & {
     buildDirectory: string;
     finalEntryRscClientPath: string;
     finalEntryRscPath: string;
+    finalEntryRscSsrPath: string;
     outputClientPath: string;
     pluginName: string;
     serverBuildFile: string | undefined;

package/dist/rsc-virtual-modules.d.ts

@@ -14,6 +14,8 @@ type RscVirtualModulesOptions = {
     routes: Record<string, Route>;
     ssr: boolean;
 };
-export declare const createReactRouterRscResolveAliases: (rootPath: string) => Record<string, string>;
+export declare const createReactRouterRscResolveAliases: (rootPath: string, options?: {
+    entrySsrPath?: string;
+}) => Record<string, string>;
 export declare const createReactRouterRscVirtualModules: ({ allowedActionOrigins, appDirectory, basename, buildDirectory, isBuild, jsDistPath, outputClientPath, publicPath, routeDiscovery, routes, ssr, }: RscVirtualModulesOptions) => Record<string, string>;
 export {};

package/dist/templates/entry.rsc.js

@@ -5,9 +5,9 @@ import route_discovery from "virtual/react-router/unstable_rsc/route-discovery";
 import basename from "virtual/react-router/unstable_rsc/basename";
 import allowed_action_origins from "virtual/react-router/unstable_rsc/allowed-action-origins";
 import client_version from "virtual/react-router/unstable_rsc/client-version";
-import server_manifest from "virtual/react-router/unstable_rsc/server-manifest";
+import { generateHTML } from "virtual/react-router/unstable_rsc/entry-ssr";
 import bootstrap_scripts from "virtual/react-router/unstable_rsc/bootstrap-scripts";
-import { generateHTML } from "./entry.rsc.ssr.js";
+import server_manifest from "virtual/react-router/unstable_rsc/server-manifest";
 function fetchServer(request, requestContext) {
     return unstable_matchRSCServerRequest({
         allowedActionOrigins: allowed_action_origins,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rsbuild-plugin-react-router",
-  "version": "0.6.5",
+  "version": "0.6.6",
   "description": "React Router plugin for Rsbuild",
   "repository": {
     "type": "git",

package/src/index.ts

@@ -585,6 +585,7 @@ export const pluginReactRouter = (
           buildDirectory,
           finalEntryRscClientPath,
           finalEntryRscPath,
+          finalEntryRscSsrPath,
           outputClientPath,
           pluginName: PLUGIN_NAME,
           serverBuildFile,

package/src/mode-plan.ts

@@ -104,6 +104,7 @@ type CreateRscModePlanOptions = ModePlanContext & {
   buildDirectory: string;
   finalEntryRscClientPath: string;
   finalEntryRscPath: string;
+  finalEntryRscSsrPath: string;
   outputClientPath: string;
   pluginName: string;
   serverBuildFile: string | undefined;
@@ -133,6 +134,7 @@ const createRscModePlan = async ({
   customServer,
   finalEntryRscClientPath,
   finalEntryRscPath,
+  finalEntryRscSsrPath,
   isBuild,
   outputClientPath,
   pluginName,
@@ -197,7 +199,9 @@ const createRscModePlan = async ({
       }),
     createResolveConfig: (rootPath: string) => ({
       modules: [resolve(rootPath, 'node_modules'), 'node_modules'],
-      alias: createReactRouterRscResolveAliases(rootPath),
+      alias: createReactRouterRscResolveAliases(rootPath, {
+        entrySsrPath: finalEntryRscSsrPath,
+      }),
     }),
     server: !customServer
       ? {

package/src/rsc-runtime.d.ts

@@ -99,6 +99,17 @@ declare module 'virtual/react-router/unstable_rsc/react-router-serve-config' {
 
 declare module 'virtual/react-router/unstable_rsc/inject-hmr-runtime' {}
 
+declare module 'virtual/react-router/unstable_rsc/entry-ssr' {
+  export function generateHTML(
+    request: Request,
+    serverResponse: Response,
+    options?: {
+      bootstrapScripts?: string[];
+      bootstrapModules?: string[];
+    }
+  ): Promise<Response>;
+}
+
 declare module 'virtual/react-router/unstable_rsc/bootstrap-scripts' {
   const bootstrapScripts: string[];
   export default bootstrapScripts;

package/src/rsc-virtual-modules.ts

@@ -39,8 +39,18 @@ type RscVirtualModulesOptions = {
 };
 
 export const createReactRouterRscResolveAliases = (
-  rootPath: string
+  rootPath: string,
+  options: { entrySsrPath?: string } = {}
 ): Record<string, string> => ({
+  // The RSC entry template imports the SSR entry through this alias so a
+  // user-provided `app/entry.ssr.tsx` replaces the template inside the SSR
+  // layer instead of leaving the template to be compiled as server code.
+  ...(options.entrySsrPath
+    ? {
+        'virtual:react-router/unstable_rsc/entry-ssr': options.entrySsrPath,
+        'virtual/react-router/unstable_rsc/entry-ssr': options.entrySsrPath,
+      }
+    : {}),
   ...Object.fromEntries(
     RSC_VIRTUAL_ALIAS_IDS.flatMap(id => {
       const moduleId = `virtual/react-router/unstable_rsc/${id}`;

package/src/templates/entry.rsc.tsx

@@ -19,7 +19,7 @@ import clientVersion from 'virtual/react-router/unstable_rsc/client-version';
 import unstable_reactRouterServeConfig from 'virtual/react-router/unstable_rsc/react-router-serve-config';
 import bootstrapScripts from 'virtual/react-router/unstable_rsc/bootstrap-scripts';
 import getServerManifest from 'virtual/react-router/unstable_rsc/server-manifest';
-import { generateHTML } from './entry.rsc.ssr.js';
+import { generateHTML } from 'virtual/react-router/unstable_rsc/entry-ssr';
 
 export { unstable_reactRouterServeConfig };