wrangler 4.20.1 → 4.20.3

package/wrangler-dist/cli.d.ts

@@ -1,4 +1,4 @@
-import { Json, Request, Response as Response$1, DispatchFetch, WorkerOptions, NodeJSCompatMode, Miniflare, MiniflareOptions, Mutex, ModuleRule, MixedModeConnectionString } from 'miniflare';
+import { Json, Request, Response as Response$1, DispatchFetch, WorkerOptions, NodeJSCompatMode, Miniflare, MiniflareOptions, Mutex, ModuleRule, RemoteProxyConnectionString } from 'miniflare';
 import * as undici from 'undici';
 import { RequestInfo, RequestInit, Response, FormData } from 'undici';
 import { RouterConfig, AssetConfig } from '@cloudflare/workers-shared';
@@ -66,7 +66,7 @@ type ContainerApp = {
     image_vars?: Record<string, string>;
     class_name: string;
     /** The scheduling policy of the application, default is regional */
-    scheduling_policy?: "regional" | "moon";
+    scheduling_policy?: "regional" | "moon" | "default";
     configuration: {
         image: string;
         labels?: {
@@ -427,8 +427,8 @@ type WorkflowBinding = {
     class_name: string;
     /** The script where the Workflow is defined (if it's external to this Worker) */
     script_name?: string;
-    /** Whether the Workflow should be remote or not (only available under `--x-mixed-mode`) */
-    remote?: boolean;
+    /** Whether the Workflow should be remote or not (only available under `--x-remote-bindings`) */
+    experimental_remote?: boolean;
 };
 /**
  * The `EnvironmentNonInheritable` interface declares all the configuration fields for an environment
@@ -500,6 +500,9 @@ interface EnvironmentNonInheritable {
     /**
      * Container related configuration
      *
+     * NOTE: This field is not automatically inherited from the top level environment,
+     * and so must be specified in every named environment.
+     *
      * @default []
      * @nonInheritable
      */
@@ -526,8 +529,8 @@ interface EnvironmentNonInheritable {
         id?: string;
         /** The ID of the KV namespace used during `wrangler dev` */
         preview_id?: string;
-        /** Whether the KV namespace should be remote or not (only available under `--x-mixed-mode`) */
-        remote?: boolean;
+        /** Whether the KV namespace should be remote or not (only available under `--x-remote-bindings`) */
+        experimental_remote?: boolean;
     }[];
     /**
      * These specify bindings to send email from inside your Worker.
@@ -568,8 +571,8 @@ interface EnvironmentNonInheritable {
             queue: string;
             /** The number of seconds to wait before delivering a message */
             delivery_delay?: number;
-            /** Whether the Queue producer should be remote or not (only available under `--x-mixed-mode`) */
-            remote?: boolean;
+            /** Whether the Queue producer should be remote or not (only available under `--x-remote-bindings`) */
+            experimental_remote?: boolean;
         }[];
         /** Consumer configuration */
         consumers?: {
@@ -613,8 +616,8 @@ interface EnvironmentNonInheritable {
         preview_bucket_name?: string;
         /** The jurisdiction that the bucket exists in. Default if not present. */
         jurisdiction?: string;
-        /** Whether the R2 bucket should be remote or not (only available under `--x-mixed-mode`) */
-        remote?: boolean;
+        /** Whether the R2 bucket should be remote or not (only available under `--x-remote-bindings`) */
+        experimental_remote?: boolean;
     }[];
     /**
      * Specifies D1 databases that are bound to this Worker environment.
@@ -642,8 +645,8 @@ interface EnvironmentNonInheritable {
         migrations_dir?: string;
         /** Internal use only. */
         database_internal_env?: string;
-        /** Whether the D1 database should be remote or not (only available under `--x-mixed-mode`) */
-        remote?: boolean;
+        /** Whether the D1 database should be remote or not (only available under `--x-remote-bindings`) */
+        experimental_remote?: boolean;
     }[];
     /**
      * Specifies Vectorize indexes that are bound to this Worker environment.
@@ -661,8 +664,8 @@ interface EnvironmentNonInheritable {
         binding: string;
         /** The name of the index. */
         index_name: string;
-        /** Whether the Vectorize index should be remote or not (only available under `--x-mixed-mode`) */
-        remote?: boolean;
+        /** Whether the Vectorize index should be remote or not (only available under `--x-remote-bindings`) */
+        experimental_remote?: boolean;
     }[];
     /**
      * Specifies Hyperdrive configs that are bound to this Worker environment.
@@ -705,8 +708,8 @@ interface EnvironmentNonInheritable {
         entrypoint?: string;
         /** Optional properties that will be made available to the service via ctx.props. */
         props?: Record<string, unknown>;
-        /** Whether the service binding should be remote or not (only available under `--x-mixed-mode`) */
-        remote?: boolean;
+        /** Whether the service binding should be remote or not (only available under `--x-remote-bindings`) */
+        experimental_remote?: boolean;
     }[] | undefined;
     /**
      * Specifies analytics engine datasets that are bound to this Worker environment.
@@ -738,8 +741,8 @@ interface EnvironmentNonInheritable {
      */
     browser: {
         binding: string;
-        /** Whether the Browser binding should be remote or not (only available under `--x-mixed-mode`) */
-        remote?: boolean;
+        /** Whether the Browser binding should be remote or not (only available under `--x-remote-bindings`) */
+        experimental_remote?: boolean;
     } | undefined;
     /**
      * Binding to the AI project.
@@ -755,8 +758,8 @@ interface EnvironmentNonInheritable {
     ai: {
         binding: string;
         staging?: boolean;
-        /** Whether the AI binding should be remote or not (only available under `--x-mixed-mode`) */
-        remote?: boolean;
+        /** Whether the AI binding should be remote or not (only available under `--x-remote-bindings`) */
+        experimental_remote?: boolean;
     } | undefined;
     /**
      * Binding to Cloudflare Images
@@ -771,8 +774,8 @@ interface EnvironmentNonInheritable {
      */
     images: {
         binding: string;
-        /** Whether the Images binding should be remote or not (only available under `--x-mixed-mode`) */
-        remote?: boolean;
+        /** Whether the Images binding should be remote or not (only available under `--x-remote-bindings`) */
+        experimental_remote?: boolean;
     } | undefined;
     /**
      * Binding to the Worker Version's metadata
@@ -836,8 +839,8 @@ interface EnvironmentNonInheritable {
         binding: string;
         /** The uuid of the uploaded mTLS certificate */
         certificate_id: string;
-        /** Whether the mtls fetcher should be remote or not (only available under `--x-mixed-mode`) */
-        remote?: boolean;
+        /** Whether the mtls fetcher should be remote or not (only available under `--x-remote-bindings`) */
+        experimental_remote?: boolean;
     }[];
     /**
      * Specifies a list of Tail Workers that are bound to this Worker environment
@@ -867,8 +870,8 @@ interface EnvironmentNonInheritable {
         namespace: string;
         /** Details about the outbound Worker which will handle outbound requests from your namespace */
         outbound?: DispatchNamespaceOutbound;
-        /** Whether the Dispatch Namespace should be remote or not (only available under `--x-mixed-mode`) */
-        remote?: boolean;
+        /** Whether the Dispatch Namespace should be remote or not (only available under `--x-remote-bindings`) */
+        experimental_remote?: boolean;
     }[];
     /**
      * Specifies list of Pipelines bound to this Worker environment
@@ -984,6 +987,13 @@ interface Observability {
         invocation_logs?: boolean;
     };
 }
+type DockerConfiguration = {
+    /** Socket used by miniflare to communicate with Docker */
+    socketPath: string;
+};
+type ContainerEngine = {
+    localDocker: DockerConfiguration;
+} | string;
 
 /**
  * This is the static type definition for the configuration object.
@@ -1189,6 +1199,11 @@ interface DevConfig {
      * @default true
      */
     enable_containers: boolean;
+    /**
+     * Either the Docker unix socket i.e. `unix:/var/run/docker.sock` or a full configuration.
+     * Note that windows is only supported via WSL at the moment
+     */
+    container_engine: ContainerEngine | undefined;
 }
 type RawDevConfig = Partial<DevConfig>;
 interface EnvironmentMap {
@@ -1223,6 +1238,7 @@ type NormalizeAndValidateConfigArgs = {
     upstreamProtocol?: string;
     script?: string;
     enableContainers?: boolean;
+    containerEngine?: ContainerEngine;
 };
 
 type ReadConfigCommandArgs = NormalizeAndValidateConfigArgs & {
@@ -1232,7 +1248,7 @@ type ReadConfigCommandArgs = NormalizeAndValidateConfigArgs & {
 type ReadConfigOptions = ResolveConfigPathOptions & {
     hideWarnings?: boolean;
     experimental?: {
-        mixedModeEnabled?: boolean;
+        remoteBindingsEnabled?: boolean;
     };
 };
 type ConfigBindingOptions = Pick<Config, "ai" | "browser" | "d1_databases" | "dispatch_namespaces" | "durable_objects" | "queues" | "r2_buckets" | "services" | "kv_namespaces" | "mtls_certificates" | "vectorize" | "workflows">;
@@ -1309,7 +1325,7 @@ interface CfModule {
 interface CfKvNamespace {
     binding: string;
     id?: string | typeof INHERIT_SYMBOL;
-    remote?: boolean;
+    experimental_remote?: boolean;
     raw?: boolean;
 }
 /**
@@ -1336,21 +1352,21 @@ interface CfWorkflow {
     class_name: string;
     binding: string;
     script_name?: string;
-    remote?: boolean;
+    experimental_remote?: boolean;
     raw?: boolean;
 }
 interface CfQueue {
     binding: string;
     queue_name: string;
     delivery_delay?: number;
-    remote?: boolean;
+    experimental_remote?: boolean;
     raw?: boolean;
 }
 interface CfR2Bucket {
     binding: string;
     bucket_name?: string | typeof INHERIT_SYMBOL;
     jurisdiction?: string;
-    remote?: boolean;
+    experimental_remote?: boolean;
     raw?: boolean;
 }
 interface CfD1Database {
@@ -1361,14 +1377,14 @@ interface CfD1Database {
     database_internal_env?: string;
     migrations_table?: string;
     migrations_dir?: string;
-    remote?: boolean;
+    experimental_remote?: boolean;
     raw?: boolean;
 }
 interface CfVectorize {
     binding: string;
     index_name: string;
     raw?: boolean;
-    remote?: boolean;
+    experimental_remote?: boolean;
 }
 interface CfSecretsStoreSecrets {
     binding: string;
@@ -1390,7 +1406,7 @@ interface CfService {
     environment?: string;
     entrypoint?: string;
     props?: Record<string, unknown>;
-    remote?: boolean;
+    experimental_remote?: boolean;
 }
 interface CfAnalyticsEngineDataset {
     binding: string;
@@ -1404,12 +1420,12 @@ interface CfDispatchNamespace {
         environment?: string;
         parameters?: string[];
     };
-    remote?: boolean;
+    experimental_remote?: boolean;
 }
 interface CfMTlsCertificate {
     binding: string;
     certificate_id: string;
-    remote?: boolean;
+    experimental_remote?: boolean;
 }
 interface CfLogfwdrBinding {
     name: string;
@@ -1549,6 +1565,7 @@ interface Unstable_DevOptions {
         enableIpc?: boolean;
         enableContainers?: boolean;
         dockerPath?: string;
+        containerEngine?: string;
     };
 }
 interface Unstable_DevWorker {
@@ -1908,7 +1925,7 @@ interface StartDevWorkerInput {
         watch?: boolean;
         /** Whether a script tag is inserted on text/html responses which will reload the page upon file changes. Defaults to false. */
         liveReload?: boolean;
-        /** The local address to reach your worker. Applies to remote: true (remote mode) and remote: false (local mode). */
+        /** The local address to reach your worker. Applies to experimental_remote: true (remote mode) and remote: false (local mode). */
         server?: {
             hostname?: string;
             port?: number;
@@ -1934,12 +1951,14 @@ interface StartDevWorkerInput {
         imagesLocalMode?: boolean;
         /** Treat this as the primary worker in a multiworker setup (i.e. the first Worker in Miniflare's options) */
         multiworkerPrimary?: boolean;
-        /** Whether the experimental mixed mode feature should be enabled */
-        experimentalMixedMode?: boolean;
+        /** Whether the experimental remote bindings feature should be enabled */
+        experimentalRemoteBindings?: boolean;
         /** Whether to build and connect to containers during local dev. Requires Docker daemon to be running. Defaults to true. */
         enableContainers?: boolean;
         /** Path to the docker executable. Defaults to 'docker' */
         dockerPath?: string;
+        /** Options for the container engine */
+        containerEngine?: ContainerEngine;
     };
     legacy?: {
         site?: Hook<Config["site"], [Config]>;
@@ -2400,53 +2419,53 @@ interface Unstable_MiniflareWorkerOptions {
 }
 declare function unstable_getMiniflareWorkerOptions(configPath: string, env?: string, options?: {
     imagesLocalMode?: boolean;
-    mixedModeConnectionString?: MixedModeConnectionString;
-    mixedModeEnabled?: boolean;
+    remoteProxyConnectionString?: RemoteProxyConnectionString;
+    remoteBindingsEnabled?: boolean;
     overrides?: {
         assets?: Partial<AssetsOptions>;
     };
 }): Unstable_MiniflareWorkerOptions;
 declare function unstable_getMiniflareWorkerOptions(config: Config, env?: string, options?: {
     imagesLocalMode?: boolean;
-    mixedModeConnectionString?: MixedModeConnectionString;
-    mixedModeEnabled?: boolean;
+    remoteProxyConnectionString?: RemoteProxyConnectionString;
+    remoteBindingsEnabled?: boolean;
     overrides?: {
         assets?: Partial<AssetsOptions>;
     };
 }): Unstable_MiniflareWorkerOptions;
 
-type MixedModeSession = Pick<Worker, "ready" | "dispose"> & {
+type RemoteProxySession = Pick<Worker, "ready" | "dispose"> & {
     updateBindings: (bindings: StartDevWorkerInput["bindings"]) => Promise<void>;
-    mixedModeConnectionString: MixedModeConnectionString;
+    remoteProxyConnectionString: RemoteProxyConnectionString;
 };
-type StartMixedModeSessionOptions = {
+type StartRemoteProxySessionOptions = {
     workerName?: string;
     auth?: NonNullable<StartDevWorkerInput["dev"]>["auth"];
     /** If running in a non-public compliance region, set this here. */
     complianceRegion?: Config["compliance_region"];
 };
-declare function startMixedModeSession(bindings: StartDevWorkerInput["bindings"], options?: StartMixedModeSessionOptions): Promise<MixedModeSession>;
+declare function startRemoteProxySession(bindings: StartDevWorkerInput["bindings"], options?: StartRemoteProxySessionOptions): Promise<RemoteProxySession>;
 declare function pickRemoteBindings(bindings: Record<string, Binding>): Record<string, Binding>;
 /**
- * Utility for potentially starting or updating a mixed mode session.
+ * Utility for potentially starting or updating a remote proxy session.
  *
- * It uses an internal map for storing existing mixed mode session indexed by worker names. If no worker name is provided
- * the mixed mode session won't be retrieved nor saved to/from the internal map.
+ * It uses an internal map for storing existing remote proxy session indexed by worker names. If no worker name is provided
+ * the remote proxy session won't be retrieved nor saved to/from the internal map.
  *
  * @param configPathOrWorkerConfig either a file path to a wrangler configuration file or an object containing the name of
  *                                 the target worker alongside its bindings.
- * @param preExistingMixedModeSessionData the data of a pre-existing mixed mode session if there was one null otherwise
- * @returns null if no existing mixed mode session was provided and one should not be created (because the worker is not
- *          defining any remote bindings), the data associated to the created/updated mixed mode session otherwise.
+ * @param preExistingRemoteProxySessionData the data of a pre-existing remote proxy session if there was one null otherwise
+ * @returns null if no existing remote proxy session was provided and one should not be created (because the worker is not
+ *          defining any remote bindings), the data associated to the created/updated remote proxy session otherwise.
  */
-declare function maybeStartOrUpdateMixedModeSession(configPathOrWorkerConfig: string | {
+declare function maybeStartOrUpdateRemoteProxySession(configPathOrWorkerConfig: string | {
     name?: string;
     bindings: NonNullable<StartDevWorkerInput["bindings"]>;
-}, preExistingMixedModeSessionData: {
-    session: MixedModeSession;
+}, preExistingRemoteProxySessionData: {
+    session: RemoteProxySession;
     remoteBindings: Record<string, Binding>;
 } | null): Promise<{
-    session: MixedModeSession;
+    session: RemoteProxySession;
     remoteBindings: Record<string, Binding>;
 } | null>;
 
@@ -2505,4 +2524,4 @@ interface Unstable_ASSETSBindingsOptions {
 }
 declare const generateASSETSBinding: (opts: Unstable_ASSETSBindingsOptions) => (request: Request) => Promise<Response$1>;
 
-export { type ConfigBindingOptions as Experimental_ConfigBindingOptions, type MixedModeSession as Experimental_MixedModeSession, type GetPlatformProxyOptions, type PlatformProxy, type SourcelessWorkerOptions, type Unstable_ASSETSBindingsOptions, type Binding as Unstable_Binding, type Config as Unstable_Config, type Unstable_DevOptions, type Unstable_DevWorker, type Unstable_MiniflareWorkerOptions, type RawConfig as Unstable_RawConfig, type RawEnvironment as Unstable_RawEnvironment, type StartMixedModeSessionOptions as experimental_StartMixedModeSessionOptions, maybeStartOrUpdateMixedModeSession as experimental_maybeStartOrUpdateMixedModeSession, experimental_patchConfig, pickRemoteBindings as experimental_pickRemoteBindings, experimental_readRawConfig, startMixedModeSession as experimental_startMixedModeSession, getPlatformProxy, DevEnv as unstable_DevEnv, convertConfigBindingsToStartWorkerBindings as unstable_convertConfigBindingsToStartWorkerBindings, unstable_dev, generateASSETSBinding as unstable_generateASSETSBinding, unstable_getMiniflareWorkerOptions, unstable_pages, readConfig as unstable_readConfig, splitSqlQuery as unstable_splitSqlQuery, startWorker as unstable_startWorker };
+export { type ConfigBindingOptions as Experimental_ConfigBindingOptions, type RemoteProxySession as Experimental_RemoteProxySession, type GetPlatformProxyOptions, type PlatformProxy, type SourcelessWorkerOptions, type Unstable_ASSETSBindingsOptions, type Binding as Unstable_Binding, type Config as Unstable_Config, type Unstable_DevOptions, type Unstable_DevWorker, type Unstable_MiniflareWorkerOptions, type RawConfig as Unstable_RawConfig, type RawEnvironment as Unstable_RawEnvironment, type StartRemoteProxySessionOptions as experimental_StartRemoteProxySessionOptions, maybeStartOrUpdateRemoteProxySession as experimental_maybeStartOrUpdateRemoteProxySession, experimental_patchConfig, pickRemoteBindings as experimental_pickRemoteBindings, experimental_readRawConfig, startRemoteProxySession as experimental_startRemoteProxySession, getPlatformProxy, DevEnv as unstable_DevEnv, convertConfigBindingsToStartWorkerBindings as unstable_convertConfigBindingsToStartWorkerBindings, unstable_dev, generateASSETSBinding as unstable_generateASSETSBinding, unstable_getMiniflareWorkerOptions, unstable_pages, readConfig as unstable_readConfig, splitSqlQuery as unstable_splitSqlQuery, startWorker as unstable_startWorker };