@vitejs/plugin-rsc 0.4.25 → 0.4.27

package/README.md

@@ -168,6 +168,11 @@ export default async function handler(request: Request): Promise<Response> {
     },
   })
 }
+
+// add `import.meta.hot.accept` to handle server module change efficiently
+if (import.meta.hot) {
+  import.meta.hot.accept()
+}
 ```
 
 - [`entry.ssr.tsx`](./examples/starter/src/framework/entry.ssr.tsx)
@@ -355,6 +360,8 @@ import.meta.hot.on('rsc:update', async () => {
 
 ### `@vitejs/plugin-rsc`
 
+- Type: `rsc: (options?: RscPluginOptions) => Plugin[]`;
+
 ```js
 import rsc from '@vitejs/plugin-rsc'
 import { defineConfig } from 'vite'
@@ -390,8 +397,15 @@ export default defineConfig({
       // for example, to obtain a key through environment variable during runtime.
       // cf. https://nextjs.org/docs/app/guides/data-security#overwriting-encryption-keys-advanced
       defineEncryptionKey: 'process.env.MY_ENCRYPTION_KEY',
+
+      // see `RscPluginOptions` for full options ...
     }),
   ],
+  // the same options can be also specified via top-level `rsc` property.
+  // this allows other plugin to set options via `config` hook.
+  rsc: {
+    // ...
+  },
 })
 ```
 
@@ -477,6 +491,57 @@ export function Page() {
 
 See https://github.com/vitejs/vite-plugin-react/pull/524 for how to install the package for React [canary](https://react.dev/community/versioning-policy#canary-channel) and [experimental](https://react.dev/community/versioning-policy#all-release-channels) usages.
 
+## Using `@vitejs/plugin-rsc` as a framework package's `dependencies`
+
+By default, `@vitejs/plugin-rsc` is expected to be used as `peerDependencies` similar to `react` and `react-dom`. When `@vitejs/plugin-rsc` is not available at the project root (e.g., in `node_modules/@vitejs/plugin-rsc`), you will see warnings like:
+
+```sh
+Failed to resolve dependency: @vitejs/plugin-rsc/vendor/react-server-dom/client.browser, present in client 'optimizeDeps.include'
+```
+
+This can be fixed by updating `optimizeDeps.include` to reference `@vitejs/plugin-rsc` through your framework package. For example, you can add the following plugin:
+
+```js
+// package name is "my-rsc-framework"
+export default function myRscFrameworkPlugin() {
+  return {
+    name: 'my-rsc-framework:config',
+    configEnvironment(_name, config) {
+      if (config.optimizeDeps?.include) {
+        config.optimizeDeps.include = config.optimizeDeps.include.map(
+          (entry) => {
+            if (entry.startsWith('@vitejs/plugin-rsc')) {
+              entry = `my-rsc-framework > ${entry}`
+            }
+            return entry
+          },
+        )
+      }
+    },
+  }
+}
+```
+
+## Typescript
+
+Types for global API are defined in `@vitejs/plugin-rsc/types`. For example, you can add it to `tsconfig.json` to have types for `import.meta.viteRsc` APIs:
+
+```json
+{
+  "compilerOptions": {
+    "types": ["vite/client", "@vitejs/plugin-rsc/types"]
+  }
+}
+```
+
+```ts
+import.meta.viteRsc.loadModule
+//                  ^^^^^^^^^^
+// <T>(environmentName: string, entryName: string) => Promise<T>
+```
+
+See also [Vite documentation](https://vite.dev/guide/api-hmr.html#intellisense-for-typescript) for `vite/client` types.
+
 ## Credits
 
 This project builds on fundamental techniques and insights from pioneering Vite RSC implementations.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { RscPluginOptions, vitePluginRsc } from "./plugin-YtSjJn3Y.js";
+import { RscPluginOptions, vitePluginRsc } from "./plugin-Be24jgQb.js";
 import MagicString from "magic-string";
 import { Program } from "estree";
 

package/dist/index.js

@@ -1,6 +1,6 @@
 import "./dist-DiJnRA1C.js";
 import "./plugin-CZbI4rhS.js";
-import { transformHoistInlineDirective, vitePluginRsc } from "./plugin--LiSJGtB.js";
+import { transformHoistInlineDirective, vitePluginRsc } from "./plugin-CtdHIozK.js";
 import "./encryption-utils-BDwwcMVT.js";
 import "./rpc-tGuLT8PD.js";
 import "./shared-BWHxNw3Q.js";

package/dist/{plugin-YtSjJn3Y.d.ts → plugin-Be24jgQb.d.ts}

@@ -88,7 +88,7 @@ type RscPluginOptions = {
   /**
   * use `Plugin.buildApp` hook (introduced on Vite 7) instead of `builder.buildApp` configuration
   * for better composability with other plugins.
-  * @default false
+  * @default true since Vite 7
   */
   useBuildAppHook?: boolean;
   /**
@@ -106,10 +106,13 @@ type RscPluginOptions = {
   *
   * This function allows you to group multiple client components into
   * custom chunks instead of having each module in its own chunk.
+  * By default, client chunks are grouped by `meta.serverChunk`.
   */
   clientChunks?: (meta: {
     /** client reference module id */
     id: string;
+    /** normalized client reference module id */
+    normalizedId: string;
     /** server chunk which includes a corresponding client reference proxy module */
     serverChunk: string;
   }) => string | undefined;
@@ -148,4 +151,4 @@ declare function transformRscCssExport(options: {
   output: MagicString;
 } | undefined>;
 //#endregion
-export { AssetDeps, AssetsManifest, ResolvedAssetDeps, ResolvedAssetsManifest, RscPluginOptions, transformRscCssExport, vitePluginRsc, vitePluginRscMinimal };
+export { AssetDeps, AssetsManifest, ResolvedAssetDeps, ResolvedAssetsManifest, type RscPluginManager, RscPluginOptions, transformRscCssExport, vitePluginRsc, vitePluginRscMinimal };

package/dist/{plugin--LiSJGtB.js → plugin-CtdHIozK.js}

@@ -519,6 +519,21 @@ function hashString(v) {
 
 //#endregion
 //#region src/plugins/scan.ts
+function scanBuildStripPlugin({ manager }) {
+	return {
+		name: "rsc:scan-strip",
+		apply: "build",
+		enforce: "post",
+		async transform(code, _id, _options) {
+			if (!manager.isScanBuild) return;
+			const output = await transformScanBuildStrip(code);
+			return {
+				code: output,
+				map: { mappings: "" }
+			};
+		}
+	};
+}
 const importGlobRE = /\bimport\.meta\.glob(?:<\w+>)?\s*\(/g;
 async function transformScanBuildStrip(code) {
 	const [imports] = esModuleLexer.parse(code);
@@ -734,6 +749,7 @@ function vitePluginRsc(rscPluginOptions = {}) {
 		{
 			name: "rsc",
 			async config(config, env) {
+				if (config.rsc) Object.assign(rscPluginOptions, vite.mergeConfig(config.rsc, rscPluginOptions));
 				const result = await crawlFrameworkPkgs({
 					root: process.cwd(),
 					isBuild: env.command === "build",
@@ -752,7 +768,7 @@ function vitePluginRsc(rscPluginOptions = {}) {
 					...result.ssr.noExternal.sort()
 				];
 				return {
-					appType: "custom",
+					appType: config.appType ?? "custom",
 					define: { "import.meta.env.__vite_rsc_build__": JSON.stringify(env.command === "build") },
 					environments: {
 						client: {
@@ -810,11 +826,18 @@ function vitePluginRsc(rscPluginOptions = {}) {
 					builder: {
 						sharedPlugins: true,
 						sharedConfigBuild: true,
-						buildApp: rscPluginOptions.useBuildAppHook ? void 0 : buildApp
+						async buildApp(builder) {
+							if (!rscPluginOptions.useBuildAppHook) await buildApp(builder);
+						}
 					}
 				};
 			},
-			buildApp: rscPluginOptions.useBuildAppHook ? buildApp : void 0,
+			configResolved() {
+				if (Number(vite.version.split(".")[0]) >= 7) rscPluginOptions.useBuildAppHook ??= true;
+			},
+			buildApp: { async handler(builder) {
+				if (rscPluginOptions.useBuildAppHook) await buildApp(builder);
+			} },
 			configureServer(server) {
 				globalThis.__viteRscDevServer = server;
 				const oldSend = server.environments.client.hot.send;
@@ -845,6 +868,7 @@ function vitePluginRsc(rscPluginOptions = {}) {
 							const resolved = await environment.pluginContainer.resolveId(source);
 							assert(resolved, `[vite-rsc] failed to resolve server handler '${source}'`);
 							const mod = await environment.runner.import(resolved.id);
+							req.url = req.originalUrl ?? req.url;
 							await createRequestListener(mod.default)(req, res);
 						} catch (e) {
 							next(e);
@@ -873,6 +897,7 @@ function vitePluginRsc(rscPluginOptions = {}) {
 				return () => {
 					server.middlewares.use(async (req, res, next) => {
 						try {
+							req.url = req.originalUrl ?? req.url;
 							await handler(req, res);
 						} catch (e) {
 							next(e);
@@ -1164,34 +1189,25 @@ import.meta.hot.on("rsc:update", () => {
 `;
 			return code;
 		}),
-		{
-			name: "rsc:inject-async-local-storage",
-			transform: { handler(code) {
-				if ((this.environment.name === "ssr" || this.environment.name === "rsc") && code.includes("typeof AsyncLocalStorage") && code.includes("new AsyncLocalStorage()") && !code.includes("__viteRscAyncHooks")) return (this.environment.mode === "build" && !isRolldownVite ? `const __viteRscAyncHooks = require("node:async_hooks");` : `import * as __viteRscAyncHooks from "node:async_hooks";`) + `globalThis.AsyncLocalStorage = __viteRscAyncHooks.AsyncLocalStorage;` + code;
-			} }
-		},
 		...vitePluginRscMinimal(rscPluginOptions, manager),
 		...vitePluginFindSourceMapURL(),
 		...vitePluginRscCss(rscPluginOptions, manager),
-		...rscPluginOptions.validateImports !== false ? [validateImportPlugin()] : [],
+		{
+			...validateImportPlugin(),
+			apply: () => rscPluginOptions.validateImports !== false
+		},
 		scanBuildStripPlugin({ manager }),
-		...cjsModuleRunnerPlugin()
+		...cjsModuleRunnerPlugin(),
+		...globalAsyncLocalStoragePlugin()
 	];
 }
-function scanBuildStripPlugin({ manager }) {
-	return {
-		name: "rsc:scan-strip",
-		apply: "build",
-		enforce: "post",
-		async transform(code, _id, _options) {
-			if (!manager.isScanBuild) return;
-			const output = await transformScanBuildStrip(code);
-			return {
-				code: output,
-				map: { mappings: "" }
-			};
-		}
-	};
+function globalAsyncLocalStoragePlugin() {
+	return [{
+		name: "rsc:inject-async-local-storage",
+		transform: { handler(code) {
+			if ((this.environment.name === "ssr" || this.environment.name === "rsc") && code.includes("typeof AsyncLocalStorage") && code.includes("new AsyncLocalStorage()") && !code.includes("__viteRscAsyncHooks")) return (this.environment.mode === "build" && !isRolldownVite ? `const __viteRscAsyncHooks = require("node:async_hooks");` : `import * as __viteRscAsyncHooks from "node:async_hooks";`) + `globalThis.AsyncLocalStorage = __viteRscAsyncHooks.AsyncLocalStorage;` + code;
+		} }
+	}];
 }
 function vitePluginUseClient(useClientPluginOptions, manager) {
 	const packageSources = /* @__PURE__ */ new Map();
@@ -1293,8 +1309,9 @@ function vitePluginUseClient(useClientPluginOptions, manager) {
 					for (const meta of Object.values(manager.clientReferenceMetaMap)) {
 						let name = useClientPluginOptions.clientChunks?.({
 							id: meta.importId,
+							normalizedId: manager.toRelativeId(meta.importId),
 							serverChunk: meta.serverChunk
-						}) ?? manager.toRelativeId(meta.importId);
+						}) ?? meta.serverChunk;
 						name = cleanUrl(name.replaceAll("..", "__"));
 						const group = manager.clientReferenceGroups[name] ??= [];
 						group.push(meta);

package/dist/plugin.d.ts

@@ -1,2 +1,2 @@
-import { AssetDeps, AssetsManifest, ResolvedAssetDeps, ResolvedAssetsManifest, RscPluginOptions, transformRscCssExport, vitePluginRsc, vitePluginRscMinimal } from "./plugin-YtSjJn3Y.js";
-export { AssetDeps, AssetsManifest, ResolvedAssetDeps, ResolvedAssetsManifest, RscPluginOptions, vitePluginRsc as default, transformRscCssExport, vitePluginRscMinimal };
+import { AssetDeps, AssetsManifest, ResolvedAssetDeps, ResolvedAssetsManifest, RscPluginManager, RscPluginOptions, transformRscCssExport, vitePluginRsc, vitePluginRscMinimal } from "./plugin-Be24jgQb.js";
+export { AssetDeps, AssetsManifest, ResolvedAssetDeps, ResolvedAssetsManifest, RscPluginManager, RscPluginOptions, vitePluginRsc as default, transformRscCssExport, vitePluginRscMinimal };

package/dist/plugin.js

@@ -1,6 +1,6 @@
 import "./dist-DiJnRA1C.js";
 import "./plugin-CZbI4rhS.js";
-import { transformRscCssExport, vitePluginRsc, vitePluginRscMinimal } from "./plugin--LiSJGtB.js";
+import { transformRscCssExport, vitePluginRsc, vitePluginRscMinimal } from "./plugin-CtdHIozK.js";
 import "./encryption-utils-BDwwcMVT.js";
 import "./rpc-tGuLT8PD.js";
 import "./shared-BWHxNw3Q.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vitejs/plugin-rsc",
-  "version": "0.4.25",
+  "version": "0.4.27",
   "description": "React Server Components (RSC) support for Vite.",
   "keywords": [
     "vite",
@@ -52,8 +52,8 @@
     "@tsconfig/strictest": "^2.0.5",
     "@types/estree": "^1.0.8",
     "@types/node": "^22.18.0",
-    "@types/react": "^19.1.11",
-    "@types/react-dom": "^19.1.8",
+    "@types/react": "^19.1.12",
+    "@types/react-dom": "^19.1.9",
     "@vitejs/plugin-react": "workspace:*",
     "react": "^19.1.1",
     "react-dom": "^19.1.1",

package/types/index.d.ts

@@ -16,4 +16,11 @@ declare global {
   }
 }
 
+declare module 'vite' {
+  interface UserConfig {
+    /** Options for `@vitejs/plugin-rsc` */
+    rsc?: import('@vitejs/plugin-rsc').RscPluginOptions
+  }
+}
+
 export {}