wrangler 4.34.0 → 4.36.0

package/wrangler-dist/cli.d.ts

@@ -9,6 +9,7 @@ import Protocol from 'devtools-protocol/types/protocol-mapping';
 import { ContainerNormalizedConfig } from '@cloudflare/containers-shared';
 import { IncomingRequestCfProperties } from '@cloudflare/workers-types/experimental';
 import { URLSearchParams } from 'node:url';
+import Cloudflare from 'cloudflare';
 
 /**
  * The `Environment` interface declares all the configuration fields that
@@ -45,6 +46,35 @@ type CloudchamberConfig = {
     memory?: string;
     ipv4?: boolean;
 };
+type UnsafeBinding = {
+    /**
+     * The name of the binding provided to the Worker
+     */
+    name: string;
+    /**
+     * The 'type' of the unsafe binding.
+     */
+    type: string;
+    dev?: {
+        plugin: {
+            /**
+             * Package is the bare specifier of the package that exposes plugins to integrate into Miniflare via a named `plugins` export.
+             * @example "@cloudflare/my-external-miniflare-plugin"
+             */
+            package: string;
+            /**
+             * Plugin is the name of the plugin exposed by the package.
+             * @example "MY_UNSAFE_PLUGIN"
+             */
+            name: string;
+        };
+        /**
+         * Optional mapping of unsafe bindings names to options provided for the plugin.
+         */
+        options?: Record<string, unknown>;
+    };
+    [key: string]: unknown;
+};
 /**
  * Configuration for a container application
  */
@@ -517,8 +547,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-remote-bindings`) */
-    experimental_remote?: boolean;
+    /** Whether the Workflow should be remote or not */
+    remote?: boolean;
 };
 /**
  * The `EnvironmentNonInheritable` interface declares all the configuration fields for an environment
@@ -619,8 +649,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-remote-bindings`) */
-        experimental_remote?: boolean;
+        /** Whether the KV namespace should be remote or not */
+        remote?: boolean;
     }[];
     /**
      * These specify bindings to send email from inside your Worker.
@@ -640,6 +670,8 @@ interface EnvironmentNonInheritable {
         destination_address?: string;
         /** If this binding should be restricted to a set of verified addresses */
         allowed_destination_addresses?: string[];
+        /** Whether the binding should be remote or not */
+        remote?: boolean;
     }[];
     /**
      * Specifies Queues that are bound to this Worker environment.
@@ -661,8 +693,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-remote-bindings`) */
-            experimental_remote?: boolean;
+            /** Whether the Queue producer should be remote or not */
+            remote?: boolean;
         }[];
         /** Consumer configuration */
         consumers?: {
@@ -706,8 +738,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-remote-bindings`) */
-        experimental_remote?: boolean;
+        /** Whether the R2 bucket should be remote or not */
+        remote?: boolean;
     }[];
     /**
      * Specifies D1 databases that are bound to this Worker environment.
@@ -735,8 +767,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-remote-bindings`) */
-        experimental_remote?: boolean;
+        /** Whether the D1 database should be remote or not */
+        remote?: boolean;
     }[];
     /**
      * Specifies Vectorize indexes that are bound to this Worker environment.
@@ -754,8 +786,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-remote-bindings`) */
-        experimental_remote?: boolean;
+        /** Whether the Vectorize index should be remote or not */
+        remote?: boolean;
     }[];
     /**
      * Specifies Hyperdrive configs that are bound to this Worker environment.
@@ -807,8 +839,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-remote-bindings`) */
-        experimental_remote?: boolean;
+        /** Whether the service binding should be remote or not */
+        remote?: boolean;
     }[] | undefined;
     /**
      * Specifies analytics engine datasets that are bound to this Worker environment.
@@ -840,8 +872,8 @@ interface EnvironmentNonInheritable {
      */
     browser: {
         binding: string;
-        /** Whether the Browser binding should be remote or not (only available under `--x-remote-bindings`) */
-        experimental_remote?: boolean;
+        /** Whether the Browser binding should be remote or not */
+        remote?: boolean;
     } | undefined;
     /**
      * Binding to the AI project.
@@ -857,8 +889,8 @@ interface EnvironmentNonInheritable {
     ai: {
         binding: string;
         staging?: boolean;
-        /** Whether the AI binding should be remote or not (only available under `--x-remote-bindings`) */
-        experimental_remote?: boolean;
+        /** Whether the AI binding should be remote or not */
+        remote?: boolean;
     } | undefined;
     /**
      * Binding to Cloudflare Images
@@ -873,8 +905,8 @@ interface EnvironmentNonInheritable {
      */
     images: {
         binding: string;
-        /** Whether the Images binding should be remote or not (only available under `--x-remote-bindings`) */
-        experimental_remote?: boolean;
+        /** Whether the Images binding should be remote or not */
+        remote?: boolean;
     } | undefined;
     /**
      * Binding to the Worker Version's metadata
@@ -897,11 +929,7 @@ interface EnvironmentNonInheritable {
          * can be used to implement bindings for features that haven't released and aren't supported
          * directly by wrangler or miniflare.
          */
-        bindings?: {
-            name: string;
-            type: string;
-            [key: string]: unknown;
-        }[];
+        bindings?: UnsafeBinding[];
         /**
          * Arbitrary key/value pairs that will be included in the uploaded metadata.  Values specified
          * here will always be applied to metadata last, so can add new or override existing fields.
@@ -938,8 +966,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-remote-bindings`) */
-        experimental_remote?: boolean;
+        /** Whether the mtls fetcher should be remote or not */
+        remote?: boolean;
     }[];
     /**
      * Specifies a list of Tail Workers that are bound to this Worker environment
@@ -969,8 +997,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-remote-bindings`) */
-        experimental_remote?: boolean;
+        /** Whether the Dispatch Namespace should be remote or not */
+        remote?: boolean;
     }[];
     /**
      * Specifies list of Pipelines bound to this Worker environment
@@ -1019,6 +1047,28 @@ interface EnvironmentNonInheritable {
         /** Whether the timer is enabled */
         enable_timer?: boolean;
     }[];
+    /**
+     * Specifies rate limit bindings that are bound to this Worker environment.
+     *
+     * NOTE: This field is not automatically inherited from the top level environment,
+     * and so must be specified in every named environment.
+     *
+     * @default []
+     * @nonInheritable
+     */
+    ratelimits: {
+        /** The binding name used to refer to the rate limiter in the Worker. */
+        name: string;
+        /** The namespace ID for this rate limiter. */
+        namespace_id: string;
+        /** Simple rate limiting configuration. */
+        simple: {
+            /** The maximum number of requests allowed in the time period. */
+            limit: number;
+            /** The time period in seconds (10 for ten seconds, 60 for one minute). */
+            period: 10 | 60;
+        };
+    }[];
 }
 /**
  * The raw environment configuration that we read from the config file.
@@ -1084,6 +1134,35 @@ interface Observability {
         head_sampling_rate?: number;
         /** Set to false to disable invocation logs */
         invocation_logs?: boolean;
+        /**
+         * If logs should be persisted to the Cloudflare observability platform where they can be queried in the dashboard.
+         *
+         * @default true
+         */
+        persist?: boolean;
+        /**
+         * What destinations logs emitted from the Worker should be sent to.
+         *
+         * @default []
+         */
+        destinations?: string[];
+    };
+    traces?: {
+        enabled?: boolean;
+        /** The sampling rate */
+        head_sampling_rate?: number;
+        /**
+         * If traces should be persisted to the Cloudflare observability platform where they can be queried in the dashboard.
+         *
+         * @default true
+         */
+        persist?: boolean;
+        /**
+         * What destinations traces emitted from the Worker should be sent to.
+         *
+         * @default []
+         */
+        destinations?: string[];
     };
 }
 type DockerConfiguration = {
@@ -1157,7 +1236,7 @@ interface CfModule {
 interface CfKvNamespace {
     binding: string;
     id?: string | typeof INHERIT_SYMBOL;
-    experimental_remote?: boolean;
+    remote?: boolean;
     raw?: boolean;
 }
 /**
@@ -1165,7 +1244,7 @@ interface CfKvNamespace {
  */
 type CfSendEmailBindings = {
     name: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
 } & ({
     destination_address?: string;
 } | {
@@ -1177,7 +1256,7 @@ type CfSendEmailBindings = {
 interface CfAIBinding {
     binding: string;
     staging?: boolean;
-    experimental_remote?: boolean;
+    remote?: boolean;
     raw?: boolean;
 }
 /**
@@ -1194,21 +1273,21 @@ interface CfWorkflow {
     class_name: string;
     binding: string;
     script_name?: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
     raw?: boolean;
 }
 interface CfQueue {
     binding: string;
     queue_name: string;
     delivery_delay?: number;
-    experimental_remote?: boolean;
+    remote?: boolean;
     raw?: boolean;
 }
 interface CfR2Bucket {
     binding: string;
     bucket_name?: string | typeof INHERIT_SYMBOL;
     jurisdiction?: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
     raw?: boolean;
 }
 interface CfD1Database {
@@ -1219,14 +1298,14 @@ interface CfD1Database {
     database_internal_env?: string;
     migrations_table?: string;
     migrations_dir?: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
     raw?: boolean;
 }
 interface CfVectorize {
     binding: string;
     index_name: string;
     raw?: boolean;
-    experimental_remote?: boolean;
+    remote?: boolean;
 }
 interface CfSecretsStoreSecrets {
     binding: string;
@@ -1237,6 +1316,14 @@ interface CfHelloWorld {
     binding: string;
     enable_timer?: boolean;
 }
+interface CfRateLimit {
+    name: string;
+    namespace_id: string;
+    simple: {
+        limit: number;
+        period: 10 | 60;
+    };
+}
 interface CfHyperdrive {
     binding: string;
     id: string;
@@ -1248,7 +1335,7 @@ interface CfService {
     environment?: string;
     entrypoint?: string;
     props?: Record<string, unknown>;
-    experimental_remote?: boolean;
+    remote?: boolean;
 }
 interface CfAnalyticsEngineDataset {
     binding: string;
@@ -1262,12 +1349,12 @@ interface CfDispatchNamespace {
         environment?: string;
         parameters?: string[];
     };
-    experimental_remote?: boolean;
+    remote?: boolean;
 }
 interface CfMTlsCertificate {
     binding: string;
     certificate_id: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
 }
 interface CfLogfwdrBinding {
     name: string;
@@ -1276,11 +1363,29 @@ interface CfLogfwdrBinding {
 interface CfPipeline {
     binding: string;
     pipeline: string;
-    experimental_remote?: boolean;
+    remote?: boolean;
 }
 interface CfUnsafeBinding {
     name: string;
     type: string;
+    dev?: {
+        plugin: {
+            /**
+             * Package is the bare specifier of the package that exposes plugins to integrate into Miniflare via a named `plugins` export.
+             * @example "@cloudflare/my-external-miniflare-plugin"
+             */
+            package: string;
+            /**
+             * Plugin is the name of the plugin exposed by the package.
+             * @example "my-unsafe-plugin"
+             */
+            name: string;
+        };
+        /**
+         * dev-only options to pass to the plugin.
+         */
+        options?: Record<string, unknown>;
+    };
 }
 type CfUnsafeMetadata = Record<string, unknown>;
 type CfCapnp = {
@@ -1597,6 +1702,7 @@ type ReadConfigCommandArgs = NormalizeAndValidateConfigArgs & {
 };
 type ReadConfigOptions = ResolveConfigPathOptions & {
     hideWarnings?: boolean;
+    preserveOriginalMain?: boolean;
 };
 type ConfigBindingOptions = Pick<Config, "ai" | "browser" | "d1_databases" | "dispatch_namespaces" | "durable_objects" | "queues" | "r2_buckets" | "services" | "kv_namespaces" | "mtls_certificates" | "vectorize" | "workflows">;
 /**
@@ -2067,7 +2173,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 experimental_remote: true (remote mode) and remote: false (local mode). */
+        /** The local address to reach your worker. Applies to remote: true (remote mode) and remote: false (local mode). */
         server?: {
             hostname?: string;
             port?: number;
@@ -2228,7 +2334,9 @@ type Binding = {
     type: "logfwdr";
 } & NameOmit<CfLogfwdrBinding>) | ({
     type: "unsafe_hello_world";
-} & BindingOmit<CfHelloWorld>) | {
+} & BindingOmit<CfHelloWorld>) | ({
+    type: "ratelimit";
+} & NameOmit<CfRateLimit>) | {
     type: `unsafe_${string}`;
 } | {
     type: "assets";
@@ -2651,7 +2759,6 @@ type StartRemoteProxySessionOptions = {
     complianceRegion?: Config["compliance_region"];
 };
 declare function startRemoteProxySession(bindings: StartDevWorkerInput["bindings"], options?: StartRemoteProxySessionOptions): Promise<RemoteProxySession>;
-declare function pickRemoteBindings(bindings: Record<string, Binding>): Record<string, Binding>;
 type WranglerConfigObject = {
     /** The path to the wrangler config file */
     path: string;
@@ -2712,7 +2819,10 @@ declare class Logger {
     log: (...args: unknown[]) => void;
     warn: (...args: unknown[]) => void;
     error: (...args: unknown[]) => void;
-    table<Keys extends string>(data: TableRow<Keys>[]): void;
+    table<Keys extends string>(data: TableRow<Keys>[], options?: {
+        wordWrap: boolean;
+        head?: Keys[];
+    }): void;
     console<M extends Exclude<keyof Console, "Console">>(method: M, ...args: Parameters<Console[M]>): void;
     get once(): {
         info: (...args: unknown[]) => void;
@@ -2768,6 +2878,7 @@ type Teams =
 	| "Product: KV"
 	| "Product: R2"
 	| "Product: R2 Data Catalog"
+	| "Product: R2 SQL"
 	| "Product: D1"
 	| "Product: Queues"
 	| "Product: AI"
@@ -2776,7 +2887,8 @@ type Teams =
 	| "Product: Vectorize"
 	| "Product: Workflows"
 	| "Product: Cloudchamber"
-	| "Product: SSL";
+	| "Product: SSL"
+	| "Product: WVPC";
 
 type StringKeyOf<T> = Extract<keyof T, string>;
 type DeepFlatten<T> = T extends object ? {
@@ -2825,6 +2937,10 @@ type HandlerContext = {
         UserError: typeof UserError;
         FatalError: typeof FatalError;
     };
+    /**
+     * API SDK
+     */
+    sdk: Cloudflare;
 };
 type CommandDefinition<NamedArgDefs extends NamedArgDefinitions = NamedArgDefinitions> = {
     /**
@@ -2995,6 +3111,7 @@ declare function createCLIParser(argv: string[]): {
             readonly describe: "Experimental: Enable Remote Bindings";
             readonly type: "boolean";
             readonly hidden: true;
+            readonly default: true;
             readonly alias: readonly ["x-remote-bindings"];
         };
         readonly "experimental-provision": {
@@ -3024,4 +3141,4 @@ interface Unstable_ASSETSBindingsOptions {
 }
 declare const generateASSETSBinding: (opts: Unstable_ASSETSBindingsOptions) => (request: Request) => Promise<Response$1>;
 
-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, experimental_getWranglerCommands, 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, getVarsForDev as unstable_getVarsForDev, unstable_pages, readConfig as unstable_readConfig, splitSqlQuery as unstable_splitSqlQuery, startWorker as unstable_startWorker };
+export { type Binding, type ConfigBindingOptions as Experimental_ConfigBindingOptions, type GetPlatformProxyOptions, type PlatformProxy, type RemoteProxySession, type SourcelessWorkerOptions, type StartRemoteProxySessionOptions, type Unstable_ASSETSBindingsOptions, type Config as Unstable_Config, type Unstable_DevOptions, type Unstable_DevWorker, type Unstable_MiniflareWorkerOptions, type RawConfig as Unstable_RawConfig, type RawEnvironment as Unstable_RawEnvironment, experimental_getWranglerCommands, experimental_patchConfig, experimental_readRawConfig, getPlatformProxy, maybeStartOrUpdateRemoteProxySession, startRemoteProxySession, DevEnv as unstable_DevEnv, convertConfigBindingsToStartWorkerBindings as unstable_convertConfigBindingsToStartWorkerBindings, unstable_dev, generateASSETSBinding as unstable_generateASSETSBinding, unstable_getMiniflareWorkerOptions, getVarsForDev as unstable_getVarsForDev, unstable_pages, readConfig as unstable_readConfig, splitSqlQuery as unstable_splitSqlQuery, startWorker as unstable_startWorker };