@cloudflare/vite-plugin 2.0.0-beta.v.10 → 2.0.0-beta.v.12

package/README.md

@@ -18,40 +18,6 @@ export default defineConfig({
 
 Full documentation can be found [here](https://developers.cloudflare.com/workers/vite-plugin/).
 
-## Programmatic configuration
-
-The `config` option accepts a customizer with the signature
-`(loadedConfig: ParsedInputConfigWithWorker) => ParsedInputConfigWithWorker`. It receives the parsed
-`cloudflare.config.ts` configuration, or a default Worker configuration when no
-file exists, and can customize account settings, Containers, and the entry Worker.
-The loaded and returned configurations must include a Worker, even for assets-only projects.
-
-Return a new configuration object, spreading any existing fields you want to
-preserve. Nested objects and arrays are replaced rather than merged:
-
-```ts
-import { cloudflare } from "@cloudflare/vite-plugin";
-
-cloudflare({
-  config(loadedConfig) {
-    return {
-      ...loadedConfig,
-      worker: {
-        ...loadedConfig.worker,
-        env: {
-          ...loadedConfig.worker.env,
-          FRAMEWORK_NAME: { type: "text", value: "my-framework" },
-        },
-      },
-    };
-  },
-});
-```
-
-The customized configuration is recorded in the build output. Preview and
-deployment from that output use the recorded configuration. Generated types
-continue to describe `cloudflare.config.ts`.
-
 ## Features
 
 - Uses the Vite [Environment API](https://vite.dev/guide/api-environment) to integrate Vite with the Workers runtime

package/dist/index.d.mts

@@ -5,9 +5,11 @@ import { CompatDate } from "@cloudflare/workers-utils";
 //#region src/plugin-config.d.ts
 
 /** Parsed configuration with the entry Worker required by the Vite plugin. */
-type ParsedInputConfigWithWorker = Omit<ParsedInputConfig, "worker"> & {
+type CloudflareConfig = Omit<ParsedInputConfig, "worker"> & {
   worker: ParsedInputWorkerConfig;
 };
+/** @deprecated Use `CloudflareConfig` instead. */
+type ParsedInputConfigWithWorker = CloudflareConfig;
 type PersistState = boolean | {
   path: string;
 };
@@ -77,7 +79,7 @@ interface PluginConfig extends EntryWorkerOptions {
    * 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;
+  config?: (loadedConfig: CloudflareConfig) => CloudflareConfig;
   auxiliaryWorkers?: AuxiliaryWorkerOptions[];
   /** Configuration for a dedicated prerender Worker. */
   prerenderWorker?: PrerenderWorkerOptions;
@@ -120,4 +122,4 @@ declare function getLocalWorkerdCompatibilityDate(_options?: {
  */
 declare function cloudflare(pluginConfig?: PluginConfig): vite.Plugin[];
 //#endregion
-export { type ParsedInputConfigWithWorker, type PluginConfig, type WorkerConfig, cloudflare, getLocalWorkerdCompatibilityDate };
+export { type CloudflareConfig, type ParsedInputConfigWithWorker, type PluginConfig, type WorkerConfig, cloudflare, getLocalWorkerdCompatibilityDate };