wrangler 3.59.0 → 3.60.1

package/wrangler-dist/cli.d.ts

@@ -14,7 +14,7 @@ import type { MessagePort as MessagePort_2 } from 'worker_threads';
 import type { Metafile } from 'esbuild';
 import { Miniflare } from 'miniflare';
 import type { MiniflareOptions } from 'miniflare';
-import type { ModuleRule as ModuleRule_2 } from 'miniflare';
+import type { ModuleRule } from 'miniflare';
 import { Mutex } from 'miniflare';
 import { Readable } from 'stream';
 import { ReadableStream } from 'stream/web';
@@ -290,10 +290,11 @@ declare type BundleCompleteEvent = {
 };
 
 declare class BundlerController extends Controller<BundlerControllerEventMap> {
-    onConfigUpdate(_: ConfigUpdateEvent): void;
+    #private;
+    onConfigUpdate(event: ConfigUpdateEvent): void;
     teardown(): Promise<void>;
-    emitBundleStartEvent(data: BundleStartEvent): void;
-    emitBundleCompletetEvent(data: BundleCompleteEvent): void;
+    emitBundleStartEvent(config: StartDevWorkerOptions): void;
+    emitBundleCompleteEvent(config: StartDevWorkerOptions, bundle: EsbuildBundle): void;
 }
 
 declare type BundlerControllerEventMap = ControllerEventMap & {
@@ -398,11 +399,36 @@ declare interface CfAccount {
     accountId: string;
 }
 
+/**
+ * A binding to the AI project
+ */
+declare interface CfAIBinding {
+    binding: string;
+    staging?: boolean;
+}
+
 declare interface CfAnalyticsEngineDataset {
     binding: string;
     dataset?: string;
 }
 
+/**
+ * A binding to a browser
+ */
+declare interface CfBrowserBinding {
+    binding: string;
+}
+
+declare type CfCapnp = {
+    base_path?: never;
+    source_schemas?: never;
+    compiled_schema: string;
+} | {
+    base_path: string;
+    source_schemas: string[];
+    compiled_schema?: never;
+};
+
 declare interface CfConstellation {
     binding: string;
     project_id: string;
@@ -418,6 +444,13 @@ declare interface CfD1Database {
     migrations_dir?: string;
 }
 
+/**
+ * A binding to a data blob (in service-worker format)
+ */
+declare interface CfDataBlobBindings {
+    [key: string]: string | Uint8Array;
+}
+
 declare interface CfDispatchNamespace {
     binding: string;
     namespace: string;
@@ -438,6 +471,19 @@ declare interface CfDurableObject {
     environment?: string;
 }
 
+declare interface CfDurableObjectMigrations {
+    old_tag?: string;
+    new_tag: string;
+    steps: {
+        new_classes?: string[];
+        renamed_classes?: {
+            from: string;
+            to: string;
+        }[];
+        deleted_classes?: string[];
+    }[];
+}
+
 declare interface CfHyperdrive {
     binding: string;
     id: string;
@@ -452,6 +498,10 @@ declare interface CfKvNamespace {
     id: string;
 }
 
+declare interface CfLogfwdr {
+    bindings: CfLogfwdrBinding[];
+}
+
 declare interface CfLogfwdrBinding {
     name: string;
     destination: string;
@@ -488,6 +538,12 @@ declare interface CfModule {
      * }
      */
     content: string | Buffer;
+    /**
+     * An optional sourcemap for this module if it's of a ESM or CJS type, this will only be present
+     * if we're deploying with sourcemaps enabled. Since we copy extra modules that aren't bundled
+     * we need to also copy the relevant sourcemaps into the final out directory.
+     */
+    sourceMap?: CfWorkerSourceMap;
     /**
      * The module type.
      *
@@ -506,6 +562,10 @@ declare interface CfMTlsCertificate {
     certificate_id: string;
 }
 
+declare interface CfPlacement {
+    mode: "smart";
+}
+
 declare interface CfQueue {
     binding: string;
     queue_name: string;
@@ -539,11 +599,149 @@ declare interface CfService {
     entrypoint?: string;
 }
 
+declare interface CfTailConsumer {
+    service: string;
+    environment?: string;
+}
+
+/**
+ * A binding to a text blob (in service-worker format)
+ */
+declare interface CfTextBlobBindings {
+    [key: string]: string;
+}
+
+declare interface CfUnsafe {
+    bindings: CfUnsafeBinding[] | undefined;
+    metadata: CfUnsafeMetadata | undefined;
+    capnp: CfCapnp | undefined;
+}
+
+declare interface CfUnsafeBinding {
+    name: string;
+    type: string;
+}
+
+declare type CfUnsafeMetadata = Record<string, unknown>;
+
+declare interface CfUserLimits {
+    cpu_ms?: number;
+}
+
+/**
+ * A map of variable names to values.
+ */
+declare interface CfVars {
+    [key: string]: string | Json;
+}
+
 declare interface CfVectorize {
     binding: string;
     index_name: string;
 }
 
+/**
+ * A binding to the Worker Version's metadata
+ */
+declare interface CfVersionMetadataBinding {
+    binding: string;
+}
+
+/**
+ * A binding to a wasm module (in service-worker format)
+ */
+declare interface CfWasmModuleBindings {
+    [key: string]: string | Uint8Array;
+}
+
+/**
+ * Options for creating a `CfWorker`.
+ */
+declare interface CfWorkerInit {
+    /**
+     * The name of the worker.
+     */
+    name: string | undefined;
+    /**
+     * The entrypoint module.
+     */
+    main: CfModule;
+    /**
+     * The list of additional modules.
+     */
+    modules: CfModule[] | undefined;
+    /**
+     * The list of source maps to include on upload.
+     */
+    sourceMaps: CfWorkerSourceMap[] | undefined;
+    /**
+     * All the bindings
+     */
+    bindings: {
+        vars: CfVars | undefined;
+        kv_namespaces: CfKvNamespace[] | undefined;
+        send_email: CfSendEmailBindings[] | undefined;
+        wasm_modules: CfWasmModuleBindings | undefined;
+        text_blobs: CfTextBlobBindings | undefined;
+        browser: CfBrowserBinding | undefined;
+        ai: CfAIBinding | undefined;
+        version_metadata: CfVersionMetadataBinding | undefined;
+        data_blobs: CfDataBlobBindings | undefined;
+        durable_objects: {
+            bindings: CfDurableObject[];
+        } | undefined;
+        queues: CfQueue[] | undefined;
+        r2_buckets: CfR2Bucket[] | undefined;
+        d1_databases: CfD1Database[] | undefined;
+        vectorize: CfVectorize[] | undefined;
+        constellation: CfConstellation[] | undefined;
+        hyperdrive: CfHyperdrive[] | undefined;
+        services: CfService[] | undefined;
+        analytics_engine_datasets: CfAnalyticsEngineDataset[] | undefined;
+        dispatch_namespaces: CfDispatchNamespace[] | undefined;
+        mtls_certificates: CfMTlsCertificate[] | undefined;
+        logfwdr: CfLogfwdr | undefined;
+        unsafe: CfUnsafe | undefined;
+    };
+    migrations: CfDurableObjectMigrations | undefined;
+    compatibility_date: string | undefined;
+    compatibility_flags: string[] | undefined;
+    usage_model: "bundled" | "unbound" | undefined;
+    keepVars: boolean | undefined;
+    keepSecrets: boolean | undefined;
+    logpush: boolean | undefined;
+    placement: CfPlacement | undefined;
+    tail_consumers: CfTailConsumer[] | undefined;
+    limits: CfUserLimits | undefined;
+    annotations?: Record<string, string | undefined>;
+}
+
+declare interface CfWorkerSourceMap {
+    /**
+     * The name of the source map.
+     *
+     * @example
+     * 'out.js.map'
+     */
+    name: string;
+    /**
+     * The content of the source map, which is a JSON object described by the v3
+     * spec.
+     *
+     * @example
+     * {
+     *   "version" : 3,
+     *   "file": "out.js",
+     *   "sourceRoot": "",
+     *   "sources": ["foo.js", "bar.js"],
+     *   "sourcesContent": [null, null],
+     *   "names": ["src", "maps", "are", "fun"],
+     *   "mappings": "A,AAAB;;ABCDE;"
+     * }
+     */
+    content: string | Buffer;
+}
+
 /**
  * A basic HTTP/1.1 client, mapped on top a single TCP/TLS connection. Pipelining is disabled by default.
  */
@@ -892,7 +1090,7 @@ attributes?: { name?: string, domain?: string }
  * NOTE: You will need the `CLOUDFLARE_API_KEY` environment
  * variable set
  */
-declare function deploy({ directory, accountId, projectName, branch, skipCaching, commitMessage, commitHash, commitDirty, functionsDirectory: customFunctionsDirectory, bundle, args, }: PagesDeployOptions): Promise<{
+declare function deploy({ directory, accountId, projectName, branch, skipCaching, commitMessage, commitHash, commitDirty, functionsDirectory: customFunctionsDirectory, bundle, sourceMaps, args, }: PagesDeployOptions): Promise<{
     url: string;
     id: string;
     environment: "production" | "preview";
@@ -955,30 +1153,6 @@ 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.
  */
@@ -1416,39 +1590,6 @@ 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.
@@ -1700,24 +1841,6 @@ declare interface EnvironmentInheritable {
     } | 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]: 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.
@@ -2093,6 +2216,9 @@ declare interface EnvironmentNonInheritable {
 declare type ErrorEvent = BaseErrorEvent<"ConfigController" | "BundlerController" | "LocalRuntimeController" | "RemoteRuntimeController" | "ProxyWorker" | "InspectorProxyWorker"> | BaseErrorEvent<"ProxyController", {
     config?: StartDevWorkerOptions;
     bundle?: Bundle;
+}> | BaseErrorEvent<"BundlerController", {
+    config?: StartDevWorkerOptions;
+    filePath?: string;
 }>;
 
 declare namespace Errors {
@@ -2601,7 +2727,7 @@ declare interface Interceptable extends Dispatcher {
 
 declare class Logger {
     constructor();
-    loggerLevel: "none" | "error" | "warn" | "info" | "log" | "debug";
+    loggerLevel: "error" | "none" | "warn" | "info" | "log" | "debug";
     columns: number;
     debug: (...args: unknown[]) => void;
     debugWithSanitization: (label: string, ...args: unknown[]) => void;
@@ -2818,16 +2944,19 @@ declare class MockScope<TData extends object = object> {
     times(repeatTimes: number): MockScope<TData>;
 }
 
-declare interface ModuleRule {
-    type: "ESModule" | "CommonJS" | "NodeJsCompatModule" | "CompiledWasm" | "Text" | "Data";
-    include?: string[];
-    fallthrough?: boolean;
-}
-
 declare interface MultiCacheQueryOptions extends CacheQueryOptions {
     cacheName?: string
 }
 
+/**
+ * Wrangler can provide Node.js compatibility in a number of different modes:
+ * - "legacy" - this mode adds compile-time polyfills that are not well maintained and cannot work with workerd runtime builtins.
+ * - "v1" - this mode tells the workerd runtime to enable some Node.js builtin libraries (accessible only via `node:...` imports) but no globals.
+ * - "v2" - this mode tells the workerd runtime to enable more Node.js builtin libraries (accessible both with and without the `node:` prefix)
+ *   and also some Node.js globals such as `Buffer`; it also turns on additional compile-time polyfills for those that are not provided by the runtime.
+ */
+declare type NodeJSCompatMode = "legacy" | "v1" | "v2" | null;
+
 declare interface PagesConfigFields {
     /**
      * The directory of static assets to serve.
@@ -2896,6 +3025,10 @@ declare interface PagesDeployOptions {
      * Default: true
      */
     bundle?: boolean;
+    /**
+     * Whether to upload any server-side sourcemaps with this deployment
+     */
+    sourceMaps: boolean;
     /**
      * Command line args passed to the `pages deploy` cmd
      */
@@ -23311,7 +23444,7 @@ declare type ProxyControllerEventMap = ControllerEventMap & {
 declare type ProxyData = {
     userWorkerUrl: UrlOriginParts;
     userWorkerInspectorUrl: UrlOriginAndPathnameParts;
-    userWorkerInnerUrlOverrides: Partial<UrlOriginParts>;
+    userWorkerInnerUrlOverrides?: Partial<UrlOriginParts>;
     headers: Record<string, string>;
     liveReload?: boolean;
     proxyLogsToController?: boolean;
@@ -23339,20 +23472,8 @@ declare type ProxyWorkerOutgoingRequestBody = {
 
 declare type QueueConsumer = NonNullable<Config["queues"]["consumers"]>[number];
 
-declare type RawConfig = Partial<ConfigFields<RawDevConfig>> & PagesConfigFields & RawEnvironment & DeprecatedConfigFields & EnvironmentMap & {
-    $schema?: string;
-};
-
 declare type RawDevConfig = Partial<DevConfig>;
 
-/**
- * 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.
- */
-declare type RawEnvironment = Partial<Environment> & EnvironmentDeprecated;
-
 declare type ReadyEvent = {
     type: "ready";
     proxyWorker: Miniflare;
@@ -23684,7 +23805,7 @@ declare function setGlobalOrigin(origin: string | URL | undefined): void;
 declare type SimpleRoute = string;
 
 export declare type SourcelessWorkerOptions = Omit<WorkerOptions, "script" | "scriptPath" | "modules" | "modulesRoot"> & {
-    modulesRules?: ModuleRule_2[];
+    modulesRules?: ModuleRule[];
 };
 
 /**
@@ -23718,9 +23839,7 @@ declare interface StartDevWorkerOptions {
      */
     script: File_2<string>;
     /** The configuration of the worker. */
-    config?: File_2<string | RawConfig> & {
-        env?: string;
-    };
+    config?: File_2<Config>;
     /** The compatibility date for the workerd runtime. */
     compatibilityDate?: string;
     /** The compatibility flags for the workerd runtime. */
@@ -23735,25 +23854,49 @@ declare interface StartDevWorkerOptions {
         include?: string[];
         exclude?: string[];
     };
+    /** Service environments. Providing support for existing workers with this property. Don't use this for new workers. */
+    env?: string;
+    /** Wrangler environments, defaults to true. */
+    legacyEnv?: boolean;
+    /**
+     * Whether Wrangler should send usage metrics to Cloudflare for this project.
+     *
+     * When defined this will override any user settings.
+     * Otherwise, Wrangler will use the user's preference.
+     */
+    sendMetrics?: boolean;
+    usageModel?: "bundled" | "unbound";
+    _bindings?: CfWorkerInit["bindings"];
+    _entry?: Entry;
+    _projectRoot?: string;
+    _serveAssetsFromWorker?: boolean;
+    _assets?: Config["assets"];
+    _processEntrypoint?: boolean;
+    _additionalModules?: CfModule[];
     /** Options applying to the worker's build step. Applies to deploy and dev. */
     build?: {
         /** Whether the worker and its dependencies are bundled. Defaults to true. */
         bundle?: boolean;
+        findAdditionalModules?: boolean;
         /** Specifies types of modules matched by globs. */
-        moduleRules?: ModuleRule[];
-        /** Replace global identifiers with constant expressions, e.g. ['debug=true','version="1.0.0"'] or { debug: 'true', version: '"1.0.0"' }. Only takes effect if bundle: true. */
-        define: string[] | Record<string, string>;
+        moduleRules?: Rule[];
+        /** Replace global identifiers with constant expressions, e.g. { debug: 'true', version: '"1.0.0"' }. Only takes effect if bundle: true. */
+        define?: Record<string, string>;
         /** Whether the bundled worker is minified. Only takes effect if bundle: true. */
-        minify: boolean;
+        minify?: boolean;
         /** Options controlling a custom build step. */
         custom: {
             /** Custom shell command to run before bundling. Runs even if bundle. */
-            command: string;
+            command?: string;
             /** The cwd to run the command in. */
             workingDirectory?: string;
             /** Filepath(s) to watch for changes. Upon changes, the command will be rerun. */
             watch?: string | string[];
         };
+        jsxFactory?: string;
+        jsxFragment?: string;
+        tsconfig?: string;
+        nodejsCompatMode?: NodeJSCompatMode;
     };
     /** Options applying to the worker's development preview environment. */
     dev?: {
@@ -23786,7 +23929,7 @@ declare interface StartDevWorkerOptions {
             httpsCertPath?: string;
         };
         /** Controls what request.url looks like inside the worker. */
-        urlOverrides?: {
+        origin?: {
             hostname?: string;
             secure?: boolean;
         };
@@ -23796,6 +23939,7 @@ declare interface StartDevWorkerOptions {
         mockFetch?: undici.MockAgent;
         /** Gets a fetcher to a specific worker, used for multi-worker development */
         getRegisteredWorker?(name: string): WorkerDefinition | undefined;
+        testScheduled?: boolean;
     };
 }
 
@@ -24072,7 +24216,6 @@ export declare interface UnstableDevOptions {
     inspect?: boolean;
     local?: boolean;
     accountId?: string;
-    updateCheck?: boolean;
     experimental?: {
         processEntrypoint?: boolean;
         additionalModules?: CfModule[];
@@ -24086,6 +24229,7 @@ export declare interface UnstableDevOptions {
         testMode?: boolean;
         testScheduled?: boolean;
         watch?: boolean;
+        devEnv?: boolean;
     };
 }