wrangler 3.90.0 → 3.92.0

package/wrangler-dist/cli.d.ts

@@ -79,12 +79,15 @@ declare type AssetConfig = z.infer<typeof AssetConfigSchema>;
 declare const AssetConfigSchema: z.ZodObject<{
     html_handling: z.ZodOptional<z.ZodEnum<["auto-trailing-slash", "force-trailing-slash", "drop-trailing-slash", "none"]>>;
     not_found_handling: z.ZodOptional<z.ZodEnum<["single-page-application", "404-page", "none"]>>;
+    serve_directly: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
     not_found_handling?: "none" | "single-page-application" | "404-page";
+    serve_directly?: boolean;
 }, {
     html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
     not_found_handling?: "none" | "single-page-application" | "404-page";
+    serve_directly?: boolean;
 }>;
 
 declare type Assets = {
@@ -93,6 +96,7 @@ declare type Assets = {
     binding?: string;
     html_handling?: "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash" | "none";
     not_found_handling?: "single-page-application" | "404-page" | "none";
+    experimental_serve_directly?: boolean;
 };
 
 declare type AssetsOptions = Pick<Assets, "directory" | "binding"> & {
@@ -449,8 +453,8 @@ declare type CfCapnp = {
 
 declare interface CfD1Database {
     binding: string;
-    database_id: string;
-    database_name: string;
+    database_id?: string;
+    database_name?: string;
     preview_database_id?: string;
     database_internal_env?: string;
     migrations_table?: string;
@@ -488,7 +492,7 @@ declare interface CfHyperdrive {
  */
 declare interface CfKvNamespace {
     binding: string;
-    id: string;
+    id?: string;
 }
 
 declare interface CfLogfwdrBinding {
@@ -564,7 +568,7 @@ declare interface CfQueue {
 
 declare interface CfR2Bucket {
     binding: string;
-    bucket_name: string;
+    bucket_name?: string;
     jurisdiction?: string;
 }
 
@@ -759,10 +763,17 @@ declare type CloudchamberConfig = {
     ipv4?: boolean;
 };
 
+declare interface ComputedConfigFields {
+    /** Path to the configuration file (e.g. wrangler.toml/json), if one was provided. */
+    configPath: string | undefined;
+    /** A worker's directory. Usually where the Wrangler configuration file is located */
+    projectRoot: string;
+}
+
 /**
  * This is the static type definition for the configuration object.
  *
- * It reflects a normalized and validated version of the configuration that you can write in wrangler.toml,
+ * It reflects a normalized and validated version of the configuration that you can write in a Wrangler configuration file,
  * and optionally augment with arguments passed directly to wrangler.
  *
  * For more information about the configuration object, see the
@@ -773,14 +784,14 @@ declare type CloudchamberConfig = {
  * - Fields that are only specified in `ConfigFields` and not `Environment` can only appear
  * in the top level config and should not appear in any environments.
  * - Fields that are specified in `PagesConfigFields` are only relevant for Pages projects
- * - All top level fields in config and environments are optional in the wrangler.toml file.
+ * - All top level fields in config and environments are optional in the Wrangler configuration file.
  *
  * Legend for the annotations:
  *
  * - `@breaking`: the deprecation/optionality is a breaking change from Wrangler v1.
  * - `@todo`: there's more work to be done (with details attached).
  */
-declare type Config = ConfigFields<DevConfig> & PagesConfigFields & Environment;
+declare type Config = ComputedConfigFields & ConfigFields<DevConfig> & PagesConfigFields & Environment;
 
 declare class ConfigController extends Controller<ConfigControllerEventMap> {
     #private;
@@ -797,7 +808,6 @@ declare type ConfigControllerEventMap = ControllerEventMap & {
 };
 
 declare interface ConfigFields<Dev extends RawDevConfig> {
-    configPath: string | undefined;
     /**
      * A boolean to enable "legacy" style wrangler environments (from Wrangler v1).
      * These have been superseded by Services, but there may be projects that won't
@@ -826,7 +836,7 @@ declare interface ConfigFields<Dev extends RawDevConfig> {
         /**
          * The directory containing your static assets.
          *
-         * It must be a path relative to your wrangler.toml file.
+         * It must be a path relative to your Wrangler configuration file.
          * Example: bucket = "./public"
          *
          * If there is a `site` field then it must contain this `bucket` field.
@@ -904,7 +914,7 @@ declare interface ConfigFields<Dev extends RawDevConfig> {
         [key: string]: string;
     } | undefined;
     /**
-     * By default, wrangler.toml is the source of truth for your environment configuration, like a terraform file.
+     * By default, the Wrangler configuration file is the source of truth for your environment configuration, like a terraform file.
      *
      * If you change your vars in the dashboard, wrangler *will* override/delete them on its next deploy.
      *
@@ -1006,14 +1016,14 @@ declare function deploy({ directory, accountId, projectName, branch, skipCaching
         type: string;
     };
     latest_stage: {
+        status: "active" | "idle" | "canceled" | "success" | "failure" | "skipped";
         name: "queued" | "build" | "deploy" | "initialize" | "clone_repo";
-        status: "active" | "idle" | "success" | "canceled" | "failure" | "skipped";
         started_on: string | null;
         ended_on: string | null;
     };
     stages: {
+        status: "active" | "idle" | "canceled" | "success" | "failure" | "skipped";
         name: "queued" | "build" | "deploy" | "initialize" | "clone_repo";
-        status: "active" | "idle" | "success" | "canceled" | "failure" | "skipped";
         started_on: string | null;
         ended_on: string | null;
     }[];
@@ -1021,8 +1031,8 @@ declare function deploy({ directory, accountId, projectName, branch, skipCaching
     modified_on: string;
     short_id: string;
     build_image_major_version: number;
+    kv_namespaces?: any;
     source?: {
-        type: "github" | "gitlab";
         config: {
             owner: string;
             repo_name: string;
@@ -1034,8 +1044,8 @@ declare function deploy({ directory, accountId, projectName, branch, skipCaching
             preview_branch_includes?: string[] | undefined;
             preview_branch_excludes?: string[] | undefined;
         };
+        type: "github" | "gitlab";
     } | undefined;
-    kv_namespaces?: any;
     env_vars?: any;
     durable_object_namespaces?: any;
     is_skipped?: boolean | undefined;
@@ -1056,9 +1066,9 @@ declare interface DeprecatedUpload {
     format?: "modules" | "service-worker";
     /**
      * The directory you wish to upload your Worker from,
-     * relative to the wrangler.toml file.
+     * relative to the Wrangler configuration file.
      *
-     * Defaults to the directory containing the wrangler.toml file.
+     * Defaults to the directory containing the Wrangler configuration file.
      *
      * @deprecated
      */
@@ -1468,8 +1478,6 @@ declare interface EnablePagesAssetsServiceBindingOptions {
 declare type Entry = {
     /** A worker's entrypoint */
     file: string;
-    /** A worker's directory. Usually where the wrangler.toml file is located */
-    projectRoot: string;
     /** Is this a module worker or a service worker? */
     format: CfScriptFormat;
     /** The directory that contains all of a `--no-bundle` worker's modules. Usually `${directory}/src`. Defaults to path.dirname(file) */
@@ -1572,6 +1580,14 @@ declare interface EnvironmentInheritable {
      * @inheritable
      */
     workers_dev: boolean | undefined;
+    /**
+     * Whether we use <version>-<name>.<subdomain>.workers.dev to
+     * serve Preview URLs for your Worker.
+     *
+     * @default `true`
+     * @inheritable
+     */
+    preview_urls: boolean | undefined;
     /**
      * A list of routes that your Worker should be published to.
      * Only one of `routes` or `route` is required.
@@ -1849,7 +1865,7 @@ declare interface EnvironmentNonInheritable {
         /** The binding name used to refer to the KV Namespace */
         binding: string;
         /** The ID of the KV namespace */
-        id: string;
+        id?: string;
         /** The ID of the KV namespace used during `wrangler dev` */
         preview_id?: string;
     }[];
@@ -1924,7 +1940,7 @@ declare interface EnvironmentNonInheritable {
         /** The binding name used to refer to the R2 bucket in the Worker. */
         binding: string;
         /** The name of this R2 bucket at the edge. */
-        bucket_name: string;
+        bucket_name?: string;
         /** The preview name of this R2 bucket at the edge. */
         preview_bucket_name?: string;
         /** The jurisdiction that the bucket exists in. Default if not present. */
@@ -1943,9 +1959,9 @@ declare interface EnvironmentNonInheritable {
         /** The binding name used to refer to the D1 database in the Worker. */
         binding: string;
         /** The name of this D1 database. */
-        database_name: string;
+        database_name?: string;
         /** The UUID of this D1 database (not required). */
-        database_id: string;
+        database_id?: string;
         /** The UUID of this D1 database for Wrangler Dev (if specified). */
         preview_database_id?: string;
         /** The name of the migrations table for this D1 database (defaults to 'd1_migrations'). */
@@ -2151,7 +2167,7 @@ declare interface EnvironmentNonInheritable {
     }[];
 }
 
-declare type ErrorEvent = BaseErrorEvent<"ConfigController" | "BundlerController" | "LocalRuntimeController" | "RemoteRuntimeController" | "ProxyWorker" | "InspectorProxyWorker"> | BaseErrorEvent<"ProxyController", {
+declare type ErrorEvent = BaseErrorEvent<"ConfigController" | "BundlerController" | "LocalRuntimeController" | "RemoteRuntimeController" | "ProxyWorker" | "InspectorProxyWorker" | "MultiworkerRuntimeController"> | BaseErrorEvent<"ProxyController", {
     config?: StartDevWorkerOptions;
     bundle?: Bundle;
 }> | BaseErrorEvent<"BundlerController", {
@@ -2540,7 +2556,7 @@ declare class FormData_2 {
 declare type FormDataEntryValue = string | File
 
 /**
- * By reading from a `wrangler.toml` file this function generates proxy binding objects that can be
+ * By reading from a Wrangler configuration file this function generates proxy binding objects that can be
  * used to simulate the interaction with bindings during local development in a Node.js environment
  *
  * @deprecated use `getPlatformProxy` instead
@@ -2560,7 +2576,7 @@ declare function getGlobalDispatcher(): Dispatcher;
 declare function getGlobalOrigin(): URL | undefined;
 
 /**
- * By reading from a `wrangler.toml` file this function generates proxy objects that can be
+ * By reading from a Wrangler configuration file this function generates proxy objects that can be
  * used to simulate the interaction with the Cloudflare platform during local development
  * in a Node.js environment
  *
@@ -2580,19 +2596,12 @@ export declare type GetPlatformProxyOptions = {
     /**
      * The path to the config file to use.
      * If no path is specified the default behavior is to search from the
-     * current directory up the filesystem for a `wrangler.toml` to use.
+     * current directory up the filesystem for a Wrangler configuration file to use.
      *
      * Note: this field is optional but if a path is specified it must
      *       point to a valid file on the filesystem
      */
     configPath?: string;
-    /**
-     * Flag to indicate the utility to read a json config file (`wrangler.json`/`wrangler.jsonc`)
-     * instead of the toml one (`wrangler.toml`)
-     *
-     * Note: this feature is experimental
-     */
-    experimentalJsonConfig?: boolean;
     /**
      * Indicates if and where to persist the bindings data, if not present or `true` it defaults to the same location
      * used by wrangler v3: `.wrangler/state/v3` (so that the same data can be easily used by the caller and wrangler).
@@ -2946,18 +2955,7 @@ declare interface PagesConfigFields {
     /**
      * The directory of static assets to serve.
      *
-     * The presence of this field in `wrangler.toml` indicates a Pages project,
-     * and will prompt the handling of the configuration file according to the
-     * Pages-specific validation rules.
-     */
-    pages_build_output_dir?: string;
-}
-
-declare interface PagesConfigFields {
-    /**
-     * The directory of static assets to serve.
-     *
-     * The presence of this field in `wrangler.toml` indicates a Pages project,
+     * The presence of this field in a Wrangler configuration file indicates a Pages project,
      * and will prompt the handling of the configuration file according to the
      * Pages-specific validation rules.
      */
@@ -25870,10 +25868,13 @@ declare type RoutingConfig = z.infer<typeof RoutingConfigSchema>;
 
 declare const RoutingConfigSchema: z.ZodObject<{
     has_user_worker: z.ZodOptional<z.ZodBoolean>;
+    invoke_user_worker_ahead_of_assets: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     has_user_worker?: boolean;
+    invoke_user_worker_ahead_of_assets?: boolean;
 }, {
     has_user_worker?: boolean;
+    invoke_user_worker_ahead_of_assets?: boolean;
 }>;
 
 /**
@@ -25952,7 +25953,7 @@ declare interface StartDevWorkerInput {
     name?: string;
     /**
      * The javascript or typescript entry-point of the worker.
-     * This is the `main` property of a wrangler.toml.
+     * This is the `main` property of a Wrangler configuration file.
      * You can specify a file path or provide the contents directly.
      */
     entrypoint?: string;
@@ -26043,10 +26044,12 @@ declare interface StartDevWorkerInput {
         /** An undici MockAgent to declaratively mock fetch calls to particular resources. */
         mockFetch?: undici.MockAgent;
         /** Describes the registry of other Workers running locally */
-        registry?: WorkerRegistry;
+        registry?: WorkerRegistry | null;
         testScheduled?: boolean;
         /** Whether to use Vectorize mixed mode -- the worker is run locally but accesses to Vectorize are made remotely */
         bindVectorizeToProd?: boolean;
+        /** Treat this as the primary worker in a multiworker setup (i.e. the first Worker in Miniflare's options) */
+        multiworkerPrimary?: boolean;
     };
     legacy?: {
         site?: Hook<Config["site"], [Config]>;
@@ -26058,7 +26061,7 @@ declare interface StartDevWorkerInput {
 }
 
 declare type StartDevWorkerOptions = Omit<StartDevWorkerInput, "assets"> & {
-    /** A worker's directory. Usually where the wrangler.toml file is located */
+    /** A worker's directory. Usually where the Wrangler configuration file is located */
     projectRoot: string;
     build: StartDevWorkerInput["build"] & {
         nodejsCompatMode: NodeJSCompatMode;
@@ -26080,6 +26083,7 @@ declare type StartDevWorkerOptions = Omit<StartDevWorkerInput, "assets"> & {
     };
     entrypoint: string;
     assets?: AssetsOptions;
+    name: string;
 };
 
 /** A faster version of `request`. */
@@ -26325,7 +26329,7 @@ export declare interface UnstableDevOptions {
     vars?: Record<string, string | Json>;
     kv?: {
         binding: string;
-        id: string;
+        id?: string;
         preview_id?: string;
     }[];
     durableObjects?: {
@@ -26342,7 +26346,7 @@ export declare interface UnstableDevOptions {
     }[];
     r2?: {
         binding: string;
-        bucket_name: string;
+        bucket_name?: string;
         preview_bucket_name?: string;
     }[];
     ai?: {