wrangler 3.91.0 → 3.93.0

package/wrangler-dist/cli.d.ts

@@ -79,23 +79,36 @@ 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 = {
     /** Absolute path to assets directory */
-    directory: string;
+    directory?: string;
+    /** Name of `env` binding property in the User Worker. */
     binding?: string;
+    /** How to handle HTML requests. */
     html_handling?: "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash" | "none";
+    /** How to handle requests that do not match an asset. */
     not_found_handling?: "single-page-application" | "404-page" | "none";
+    /**
+     * If true, then respond to requests that match an asset with that asset directly.
+     * If false, route every request to the User Worker, whether or not it matches an asset.
+     * */
+    experimental_serve_directly?: boolean;
 };
 
-declare type AssetsOptions = Pick<Assets, "directory" | "binding"> & {
+declare type AssetsOptions = {
+    directory: string;
+    binding?: string;
     routingConfig: RoutingConfig;
     assetConfig: AssetConfig;
 };
@@ -449,8 +462,8 @@ declare type CfCapnp = {
 
 declare interface CfD1Database {
     binding: string;
-    database_id: string;
-    database_name: string;
+    database_id?: string | typeof INHERIT_SYMBOL;
+    database_name?: string;
     preview_database_id?: string;
     database_internal_env?: string;
     migrations_table?: string;
@@ -488,7 +501,7 @@ declare interface CfHyperdrive {
  */
 declare interface CfKvNamespace {
     binding: string;
-    id: string;
+    id?: string | typeof INHERIT_SYMBOL;
 }
 
 declare interface CfLogfwdrBinding {
@@ -564,7 +577,7 @@ declare interface CfQueue {
 
 declare interface CfR2Bucket {
     binding: string;
-    bucket_name: string;
+    bucket_name?: string | typeof INHERIT_SYMBOL;
     jurisdiction?: string;
 }
 
@@ -759,29 +772,6 @@ declare type CloudchamberConfig = {
     ipv4?: boolean;
 };
 
-/**
- * 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 a Wrangler configuration file,
- * and optionally augment with arguments passed directly to wrangler.
- *
- * For more information about the configuration object, see the
- * documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration
- *
- * Notes:
- *
- * - 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 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 class ConfigController extends Controller<ConfigControllerEventMap> {
     #private;
     latestInput?: StartDevWorkerInput;
@@ -1006,14 +996,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 +1011,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 +1024,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;
@@ -1044,6 +1034,30 @@ declare function deploy({ directory, accountId, projectName, branch, skipCaching
     } | undefined;
 }>;
 
+declare interface DeprecatedConfigFields {
+    /**
+     * The project "type". A holdover from Wrangler v1.x.
+     * Valid values were "webpack", "javascript", and "rust".
+     *
+     * @deprecated DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.
+     * @breaking
+     */
+    type?: "webpack" | "javascript" | "rust";
+    /**
+     * Path to the webpack config to use when building your worker.
+     * A holdover from Wrangler v1.x, used with `type: "webpack"`.
+     *
+     * @deprecated DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.
+     * @breaking
+     */
+    webpack_config?: string;
+    /**
+     * Configuration only used by a standalone use of the miniflare binary.
+     * @deprecated
+     */
+    miniflare?: unknown;
+}
+
 /**
  * Deprecated upload configuration.
  */
@@ -1491,6 +1505,39 @@ declare type Entry = {
 declare interface Environment extends EnvironmentInheritable, EnvironmentNonInheritable {
 }
 
+/**
+ * The environment configuration properties that have been deprecated.
+ */
+declare interface EnvironmentDeprecated {
+    /**
+     * The zone ID of the zone you want to deploy to. You can find this
+     * in your domain page on the dashboard.
+     *
+     * @deprecated This is unnecessary since we can deduce this from routes directly.
+     */
+    zone_id?: string;
+    /**
+     * Legacy way of defining KVNamespaces that is no longer supported.
+     *
+     * @deprecated DO NOT USE. This was a legacy bug from Wrangler v1, that we do not want to support.
+     */
+    "kv-namespaces"?: string;
+    /**
+     * A list of services that your Worker should be bound to.
+     *
+     * @default `[]`
+     * @deprecated DO NOT USE. We'd added this to test the new service binding system, but the proper way to test experimental features is to use `unsafe.bindings` configuration.
+     */
+    experimental_services?: {
+        /** The binding name used to refer to the Service */
+        name: string;
+        /** The name of the Service being bound */
+        service: string;
+        /** The Service's environment */
+        environment: string;
+    }[];
+}
+
 /**
  * The `EnvironmentInheritable` interface declares all the configuration fields for an environment
  * that can be inherited (and overridden) from the top-level environment.
@@ -1777,6 +1824,24 @@ declare interface EnvironmentInheritable {
     observability: Observability | undefined;
 }
 
+declare interface EnvironmentMap {
+    /**
+     * The `env` section defines overrides for the configuration for different environments.
+     *
+     * All environment fields can be specified at the top level of the config indicating the default environment settings.
+     *
+     * - Some fields are inherited and overridable in each environment.
+     * - But some are not inherited and must be explicitly specified in every environment, if they are specified at the top level.
+     *
+     * For more information, see the documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration#environments
+     *
+     * @default {}
+     */
+    env?: {
+        [envName: string]: Unstable_RawEnvironment;
+    };
+}
+
 /**
  * The `EnvironmentNonInheritable` interface declares all the configuration fields for an environment
  * that cannot be inherited from the top-level environment, and must be defined specifically.
@@ -1857,7 +1922,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;
     }[];
@@ -1932,7 +1997,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. */
@@ -1951,9 +2016,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'). */
@@ -2159,7 +2224,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", {
@@ -2649,6 +2714,11 @@ declare type HttpTerminator = {
  */
 declare type IncomingHttpHeaders = Record<string, string | string[] | undefined>;
 
+/**
+ * A symbol to inherit a binding from the deployed worker.
+ */
+declare const INHERIT_SYMBOL: unique symbol;
+
 declare type InspectorProxyWorkerIncomingWebSocketMessage = {
     type: ReloadStartEvent["type"];
 } | {
@@ -2929,13 +2999,23 @@ declare interface MultiCacheQueryOptions extends CacheQueryOptions {
 
 declare type NameOmit<T> = Omit<T, "name">;
 
+declare type NormalizeAndValidateConfigArgs = {
+    name?: string;
+    env?: string;
+    "legacy-env"?: boolean;
+    "dispatch-namespace"?: string;
+    remote?: boolean;
+    localProtocol?: string;
+    upstreamProtocol?: string;
+};
+
 declare interface Observability {
     /** If observability is enabled for this Worker */
-    enabled: boolean;
+    enabled?: boolean;
     /** The sampling rate */
     head_sampling_rate?: number;
     logs?: {
-        enabled: boolean;
+        enabled?: boolean;
         /** The sampling rate */
         head_sampling_rate?: number;
         /** Set to false to disable invocation logs */
@@ -2954,17 +3034,6 @@ declare interface PagesConfigFields {
     pages_build_output_dir?: string;
 }
 
-declare interface PagesConfigFields {
-    /**
-     * The directory of static assets to serve.
-     *
-     * 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.
-     */
-    pages_build_output_dir?: string;
-}
-
 declare interface PagesDeployOptions {
     /**
      * Path to static assets to deploy to Pages
@@ -25577,10 +25646,12 @@ declare type ProxyWorkerOutgoingRequestBody = {
     args: Parameters<typeof console.debug>;
 };
 
-declare type QueueConsumer = NonNullable<Config["queues"]["consumers"]>[number];
+declare type QueueConsumer = NonNullable<Unstable_Config["queues"]["consumers"]>[number];
 
 declare type RawDevConfig = Partial<DevConfig>;
 
+declare type ReadConfigCommandArgs = NormalizeAndValidateConfigArgs;
+
 declare type ReadyEvent = {
     type: "ready";
     proxyWorker: Miniflare;
@@ -26006,7 +26077,7 @@ declare interface StartDevWorkerInput {
         jsxFactory?: string;
         jsxFragment?: string;
         tsconfig?: string;
-        nodejsCompatMode?: Hook<NodeJSCompatMode, [Config]>;
+        nodejsCompatMode?: Hook<NodeJSCompatMode, [Unstable_Config]>;
         moduleRoot?: string;
     };
     /** Options applying to the worker's development preview environment. */
@@ -26020,7 +26091,7 @@ declare interface StartDevWorkerInput {
         /** Whether the worker runs on the edge or locally. */
         remote?: boolean;
         /** Cloudflare Account credentials. Can be provided upfront or as a function which will be called only when required. */
-        auth?: AsyncHook<CfAccount, [Pick<Config, "account_id">]>;
+        auth?: AsyncHook<CfAccount, [Pick<Unstable_Config, "account_id">]>;
         /** Whether local storage (KV, Durable Objects, R2, D1, etc) is persisted. You can also specify the directory to persist data to. */
         persist?: string;
         /** Controls which logs are logged 🤙. */
@@ -26047,14 +26118,16 @@ 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]>;
-        legacyAssets?: Hook<Config["legacy_assets"], [Config]>;
+        site?: Hook<Unstable_Config["site"], [Unstable_Config]>;
+        legacyAssets?: Hook<Unstable_Config["legacy_assets"], [Unstable_Config]>;
         enableServiceEnvironments?: boolean;
     };
     unsafe?: Omit<CfUnsafe, "bindings">;
@@ -26075,8 +26148,8 @@ declare type StartDevWorkerOptions = Omit<StartDevWorkerInput, "assets"> & {
         processEntrypoint: boolean;
     };
     legacy: StartDevWorkerInput["legacy"] & {
-        legacyAssets?: Config["legacy_assets"];
-        site?: Config["site"];
+        legacyAssets?: Unstable_Config["legacy_assets"];
+        site?: Unstable_Config["site"];
     };
     dev: StartDevWorkerInput["dev"] & {
         persist: string;
@@ -26084,6 +26157,7 @@ declare type StartDevWorkerOptions = Omit<StartDevWorkerInput, "assets"> & {
     };
     entrypoint: string;
     assets?: AssetsOptions;
+    name: string;
 };
 
 /** A faster version of `request`. */
@@ -26255,10 +26329,39 @@ declare namespace undici {
     }
 }
 
+export declare interface Unstable_ASSETSBindingsOptions {
+    log: Logger;
+    proxyPort?: number;
+    directory?: 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 a Wrangler configuration file,
+ * and optionally augment with arguments passed directly to wrangler.
+ *
+ * For more information about the configuration object, see the
+ * documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration
+ *
+ * Notes:
+ *
+ * - 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 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).
+ */
+export declare type Unstable_Config = ConfigFields<DevConfig> & PagesConfigFields & Environment;
+
 /**
  *  unstable_dev starts a wrangler dev server, and returns a promise that resolves with utility functions to interact with it.
  */
-export declare function unstable_dev(script: string, options?: UnstableDevOptions, apiOptions?: unknown): Promise<UnstableDevWorker>;
+export declare function unstable_dev(script: string, options?: Unstable_DevOptions, apiOptions?: unknown): Promise<Unstable_DevWorker>;
 
 export declare class unstable_DevEnv extends EventEmitter_2 {
     config: ConfigController;
@@ -26276,37 +26379,7 @@ export declare class unstable_DevEnv extends EventEmitter_2 {
     emitErrorEvent(ev: ErrorEvent): void;
 }
 
-export declare const unstable_generateASSETSBinding: (opts: UnstableASSETSBindingsOptions) => (request: Request_3) => Promise<Response_3>;
-
-export declare function unstable_getMiniflareWorkerOptions(configPath: string, env?: string): {
-    workerOptions: SourcelessWorkerOptions;
-    define: Record<string, string>;
-    main?: string;
-};
-
-export declare const unstable_pages: {
-    deploy: typeof deploy;
-};
-
-/**
- * Split an SQLQuery into an array of statements
- */
-export declare function unstable_splitSqlQuery(sql: string): string[];
-
-export declare function unstable_startWorker(options: StartDevWorkerInput): Promise<Worker>;
-
-export declare const unstable_startWorkerRegistryServer: (port: number) => Promise<{
-    server: Server<IncomingMessage, ServerResponse>;
-    terminator: HttpTerminator;
-}>;
-
-export declare interface UnstableASSETSBindingsOptions {
-    log: Logger;
-    proxyPort?: number;
-    directory?: string;
-}
-
-export declare interface UnstableDevOptions {
+export declare interface Unstable_DevOptions {
     config?: string;
     env?: string;
     ip?: string;
@@ -26329,7 +26402,7 @@ export declare interface UnstableDevOptions {
     vars?: Record<string, string | Json>;
     kv?: {
         binding: string;
-        id: string;
+        id?: string;
         preview_id?: string;
     }[];
     durableObjects?: {
@@ -26346,7 +26419,7 @@ export declare interface UnstableDevOptions {
     }[];
     r2?: {
         binding: string;
-        bucket_name: string;
+        bucket_name?: string;
         preview_bucket_name?: string;
     }[];
     ai?: {
@@ -26381,7 +26454,7 @@ export declare interface UnstableDevOptions {
     };
 }
 
-export declare interface UnstableDevWorker {
+export declare interface Unstable_DevWorker {
     port: number;
     address: string;
     stop: () => Promise<void>;
@@ -26389,6 +26462,60 @@ export declare interface UnstableDevWorker {
     waitUntilExit: () => Promise<void>;
 }
 
+export declare const unstable_generateASSETSBinding: (opts: Unstable_ASSETSBindingsOptions) => (request: Request_3) => Promise<Response_3>;
+
+export declare function unstable_getMiniflareWorkerOptions(configPath: string, env?: string): Unstable_MiniflareWorkerOptions;
+
+export declare function unstable_getMiniflareWorkerOptions(config: Unstable_Config): Unstable_MiniflareWorkerOptions;
+
+export declare interface Unstable_MiniflareWorkerOptions {
+    workerOptions: SourcelessWorkerOptions;
+    define: Record<string, string>;
+    main?: string;
+}
+
+export declare const unstable_pages: {
+    deploy: typeof deploy;
+};
+
+export declare type Unstable_RawConfig = Partial<ConfigFields<RawDevConfig>> & PagesConfigFields & Unstable_RawEnvironment & DeprecatedConfigFields & EnvironmentMap & {
+    $schema?: string;
+};
+
+/**
+ * The raw environment configuration that we read from the config file.
+ *
+ * All the properties are optional, and will be replaced with defaults in the configuration that
+ * is used in the rest of the codebase.
+ */
+export declare type Unstable_RawEnvironment = Partial<Environment> & EnvironmentDeprecated;
+
+/**
+ * Get the Wrangler configuration; read it from the give `configPath` if available.
+ */
+export declare function unstable_readConfig(configPath: string | undefined, args: ReadConfigCommandArgs, options: {
+    requirePagesConfig: true;
+}): Omit<Unstable_Config, "pages_build_output_dir"> & {
+    pages_build_output_dir: string;
+};
+
+export declare function unstable_readConfig(configPath: string | undefined, args: ReadConfigCommandArgs, options?: {
+    requirePagesConfig?: boolean;
+    hideWarnings?: boolean;
+}): Unstable_Config;
+
+/**
+ * Split an SQLQuery into an array of statements
+ */
+export declare function unstable_splitSqlQuery(sql: string): string[];
+
+export declare function unstable_startWorker(options: StartDevWorkerInput): Promise<Worker>;
+
+export declare const unstable_startWorkerRegistryServer: (port: number) => Promise<{
+    server: Server<IncomingMessage, ServerResponse>;
+    terminator: HttpTerminator;
+}>;
+
 /** Upgrade to a different protocol. */
 declare function upgrade(
 url: string | URL_2 | UrlObject,