rsbuild-plugin-cloudflare 0.0.1 → 0.0.3

package/README.md

@@ -1,5 +1,7 @@
 # `rsbuild-plugin-cloudflare`
 
+[![npm](https://img.shields.io/npm/v/rsbuild-plugin-cloudflare)](https://www.npmjs.com/package/rsbuild-plugin-cloudflare)
+
 An experimental [Rsbuild](https://rsbuild.rs) plugin for Cloudflare Workers. It
 runs your Workers in workerd during `rsbuild dev` and `rsbuild preview`, and
 builds them, with your client assets, during `rsbuild build` into a Cloudflare
@@ -53,7 +55,10 @@ To change how a Worker is built, configure its environment in Rsbuild's
 precedence, apart from `source.entry`, `output.target` and `output.module`,
 which the plugin always sets so that the Worker runs in workerd, and
 `output.distPath.root`, which it sets to the Worker's Build Output location, as
-the Vite plugin does.
+the Vite plugin does. The Worker's entry keeps the
+[layer](https://rspack.rs/config/entry#entrydescriptionlayer) of the entries
+that it replaces, if they're all in the same one (e.g. TanStack Start's server
+entry, with React Server Components).
 
 ```ts
 export default defineConfig({
@@ -106,6 +111,12 @@ Rsbuild (e.g. one created from TanStack's Rsbuild template) on Workers:
    });
    ```
 
+   If the app has its own
+   [server entry](https://tanstack.com/start/latest/docs/framework/react/guide/server-entry-point)
+   (e.g. `src/server.ts`), make that the entrypoint instead (e.g.
+   `entrypoint: "./src/server.ts"`). The Worker runs its entrypoint, so with
+   TanStack Start's it would bypass the app's.
+
 3. Add `cloudflare()` before `tanstackStart()`, with `rsbuildEnvironment.name`
    set to TanStack Start's server environment, `ssr`. This is required: without
    it, the plugin builds the entrypoint in its own `cloudflare` environment,
@@ -158,6 +169,12 @@ const getGreeting = createServerFn().handler(() => env.GREETING);
 See [`packages/e2e/fixtures/tanstack-start`](https://github.com/james-elicx/rsbuild-plugin-cloudflare/tree/main/packages/e2e/fixtures/tanstack-start) for
 a complete app.
 
+[React Server Components](https://tanstack.com/start/latest/docs/framework/react/guide/server-components)
+run in the Worker too, once they're enabled with `rsc: { enabled: true }` in
+`tanstackStart()`'s options. TanStack Start resolves `react-server-dom-rspack`
+from the app's root, so add it as a dependency. See
+[`packages/e2e/fixtures/tanstack-start-rsc`](https://github.com/james-elicx/rsbuild-plugin-cloudflare/tree/main/packages/e2e/fixtures/tanstack-start-rsc).
+
 ## Differences from the Vite plugin
 
 The plugin replaces Vite's module runner with Rsbuild's bundles, so behaviour

package/dist/index.d.mts

@@ -1,8 +1,12 @@
-import { InputWorkerConfig, ParsedInputWorkerConfig } from "@cloudflare/config";
+import { InputWorkerConfig, ParsedInputConfig, ParsedInputWorkerConfig } from "@cloudflare/config";
 import { RsbuildPlugin } from "@rsbuild/core";
 
 //#region ../../workers-sdk/packages/vite-plugin-cloudflare/src/plugin-config.d.ts
 
+/** Parsed configuration with the entry Worker required by the Vite plugin. */
+type ParsedInputConfigWithWorker = Omit<ParsedInputConfig, "worker"> & {
+  worker: ParsedInputWorkerConfig;
+};
 type PersistState = boolean | {
   path: string;
 };
@@ -25,7 +29,6 @@ interface BaseWorkerOptions {
  */
 type DevOnly = boolean | (() => boolean);
 interface EntryWorkerOptions extends BaseWorkerOptions {
-  config?: EntryWorkerConfigCustomizer;
   /**
    * Whether the entry Worker should be omitted from the production build.
    * Can be a boolean or a function that returns a boolean. The function is
@@ -63,11 +66,17 @@ interface Experimental {
   /** Experimental support for handling the _headers and _redirects files during Vite dev mode. */
   headersAndRedirectsDevModeSupport?: boolean;
 }
-type EntryWorkerConfigCustomizer = Partial<ParsedInputWorkerConfig> | ((config: ParsedInputWorkerConfig) => Partial<ParsedInputWorkerConfig> | void);
 type WorkerConfigProvider = InputWorkerConfig | ((options: {
   entryWorkerConfig: ParsedInputWorkerConfig;
 }) => InputWorkerConfig);
 interface PluginConfig$1 extends EntryWorkerOptions {
+  /**
+   * Customize the loaded configuration before development or building.
+   * The loaded configuration always includes an entry Worker.
+   * Return a new configuration object including an entry Worker, copying any settings to preserve.
+   * Preview uses the configuration recorded in the build output.
+   */
+  config?: (loadedConfig: ParsedInputConfigWithWorker) => ParsedInputConfigWithWorker;
   auxiliaryWorkers?: AuxiliaryWorkerOptions[];
   /** Configuration for a dedicated prerender Worker. */
   prerenderWorker?: PrerenderWorkerOptions;