wrangler 2.19.0 → 3.0.0

package/wrangler-dist/cli.d.ts

@@ -137,6 +137,41 @@ declare namespace buildConnector {
     }
 }
 
+/**
+ * An imported module.
+ */
+declare interface CfModule {
+    /**
+     * The module name.
+     *
+     * @example
+     * './src/index.js'
+     */
+    name: string;
+    /**
+     * The module content, usually JavaScript or WASM code.
+     *
+     * @example
+     * export default {
+     *   async fetch(request) {
+     *     return new Response('Ok')
+     *   }
+     * }
+     */
+    content: string | Buffer;
+    /**
+     * The module type.
+     *
+     * If absent, will default to the main module's type.
+     */
+    type?: CfModuleType;
+}
+
+/**
+ * A module type.
+ */
+declare type CfModuleType = "esm" | "commonjs" | "compiled-wasm" | "text" | "buffer";
+
 /** A basic HTTP/1.1 client, mapped on top a single TCP/TLS connection. Pipelining is disabled by default. */
 declare class Client extends Dispatcher {
     constructor(url: string | URL_2, options?: Client.Options);
@@ -208,6 +243,74 @@ declare type CustomDomainRoute = {
 
 export declare function deleteMTlsCertificate(accountId: string, certificateId: string): Promise<unknown>;
 
+/**
+ * Publish a directory to an account/project.
+ * 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, }: PagesDeployOptions): Promise<{
+    environment: "production" | "preview";
+    id: string;
+    project_id: string;
+    url: string;
+    project_name: string;
+    build_config: {
+        build_command: string;
+        destination_dir: string;
+        root_dir: string;
+        web_analytics_tag?: string | undefined;
+        web_analytics_token?: string | undefined;
+        fast_builds?: boolean | undefined;
+    };
+    created_on: string;
+    production_branch: string;
+    deployment_trigger: {
+        type: string;
+        metadata: {
+            branch: string;
+            commit_hash: string;
+            commit_message: string;
+        };
+    };
+    latest_stage: {
+        name: "build" | "deploy" | "queued" | "initialize" | "clone_repo";
+        status: "active" | "idle" | "canceled" | "success" | "failure" | "skipped";
+        started_on: string | null;
+        ended_on: string | null;
+    };
+    stages: {
+        name: "build" | "deploy" | "queued" | "initialize" | "clone_repo";
+        status: "active" | "idle" | "canceled" | "success" | "failure" | "skipped";
+        started_on: string | null;
+        ended_on: string | null;
+    }[];
+    aliases: string[];
+    modified_on: string;
+    short_id: string;
+    build_image_major_version: number;
+    kv_namespaces?: any;
+    source?: {
+        type: "github" | "gitlab";
+        config: {
+            owner: string;
+            repo_name: string;
+            production_branch?: string | undefined;
+            pr_comments_enabled?: boolean | undefined;
+            deployments_enabled?: boolean | undefined;
+            production_deployments_enabled?: boolean | undefined;
+            preview_deployment_setting?: "none" | "all" | "custom" | undefined;
+            preview_branch_includes?: string[] | undefined;
+            preview_branch_excludes?: string[] | undefined;
+        };
+    } | undefined;
+    env_vars?: any;
+    durable_object_namespaces?: any;
+    is_skipped?: boolean | undefined;
+    files?: {
+        [x: string]: string | undefined;
+    } | undefined;
+}>;
+
 /**
  * Deprecated upload configuration.
  */
@@ -464,6 +567,15 @@ declare namespace Dispatcher {
     }
 }
 
+declare interface DispatchNamespaceOutbound {
+    /** Name of the service handling the outbound requests */
+    service: string;
+    /** (Optional) Name of the environment handling the outbound requests. */
+    environment?: string;
+    /** (Optional) List of parameter names, for sending context from your dispatch worker to the outbound handler */
+    parameters?: string[];
+}
+
 declare type DurableObjectBindings = {
     /** The name of the binding used to refer to the Durable Object */
     name: string;
@@ -639,7 +751,7 @@ declare interface EnvironmentInheritable {
         upload?: DeprecatedUpload;
     };
     /**
-     * Skip internal build steps and directly publish script
+     * Skip internal build steps and directly deploy script
      * @inheritable
      */
     no_bundle: boolean | undefined;
@@ -667,6 +779,8 @@ declare interface EnvironmentInheritable {
         binding: string;
         /** The namespace to bind to. */
         namespace: string;
+        /** Details about the outbound worker which will handle outbound requests from your namespace */
+        outbound?: DispatchNamespaceOutbound;
     }[];
     /**
      *	Designates this worker as an internal-only "first-party" worker.
@@ -707,6 +821,14 @@ declare interface EnvironmentInheritable {
      * @inheritable
      */
     logpush: boolean | undefined;
+    /**
+     * Specify how the worker should be located to minimize round-trip time.
+     *
+     * More details: https://developers.cloudflare.com/workers/platform/smart-placement/
+     */
+    placement: {
+        mode: "off" | "smart";
+    } | undefined;
 }
 
 /**
@@ -867,6 +989,21 @@ declare interface EnvironmentNonInheritable {
         /** Internal use only. */
         database_internal_env?: string;
     }[];
+    /**
+     * Specifies Constellation projects 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
+     */
+    constellation: {
+        /** The binding name used to refer to the project in the worker. */
+        binding: string;
+        /** The id of the project. */
+        project_id: string;
+    }[];
     /**
      * Specifies service bindings (worker-to-worker) that are bound to this Worker environment.
      *
@@ -899,6 +1036,12 @@ declare interface EnvironmentNonInheritable {
         /** The name of this dataset to write to. */
         dataset?: string;
     }[];
+    /**
+     * A browser that will be usable from the worker.
+     */
+    browser: {
+        binding: string;
+    } | undefined;
     /**
      * "Unsafe" tables for features that aren't directly supported by wrangler.
      *
@@ -932,6 +1075,7 @@ declare interface EnvironmentNonInheritable {
         /** The uuid of the uploaded mTLS certificate */
         certificate_id: string;
     }[];
+    tail_consumers?: TailConsumer[];
 }
 
 declare namespace Errors {
@@ -1263,9 +1407,9 @@ declare interface MTlsCertificateUploadDetails {
     name?: string;
 }
 
-declare interface PagesPublishOptions {
+declare interface PagesDeployOptions {
     /**
-     * Path to static assets to publish to Pages
+     * Path to static assets to deploy to Pages
      */
     directory: string;
     /**
@@ -1306,79 +1450,11 @@ declare interface PagesPublishOptions {
     functionsDirectory?: string;
     /**
      * Whether to run bundling on `_worker.js` before deploying.
-     * Default: false
+     * Default: true
      */
     bundle?: boolean;
 }
 
-/**
- * Publish a directory to an account/project.
- * NOTE: You will need the `CLOUDFLARE_API_KEY` environment
- * variable set
- */
-declare function publish({ directory, accountId, projectName, branch, skipCaching, commitMessage, commitHash, commitDirty, functionsDirectory: customFunctionsDirectory, bundle, }: PagesPublishOptions): Promise<{
-    environment: "production" | "preview";
-    id: string;
-    url: string;
-    project_id: string;
-    project_name: string;
-    build_config: {
-        build_command: string;
-        destination_dir: string;
-        root_dir: string;
-        web_analytics_tag?: string | undefined;
-        web_analytics_token?: string | undefined;
-        fast_builds?: boolean | undefined;
-    };
-    created_on: string;
-    production_branch: string;
-    deployment_trigger: {
-        type: string;
-        metadata: {
-            branch: string;
-            commit_hash: string;
-            commit_message: string;
-        };
-    };
-    latest_stage: {
-        name: "build" | "queued" | "initialize" | "clone_repo" | "deploy";
-        status: "active" | "canceled" | "success" | "idle" | "failure" | "skipped";
-        started_on: string | null;
-        ended_on: string | null;
-    };
-    stages: {
-        name: "build" | "queued" | "initialize" | "clone_repo" | "deploy";
-        status: "active" | "canceled" | "success" | "idle" | "failure" | "skipped";
-        started_on: string | null;
-        ended_on: string | null;
-    }[];
-    aliases: string[];
-    modified_on: string;
-    short_id: string;
-    build_image_major_version: number;
-    kv_namespaces?: any;
-    source?: {
-        type: "github" | "gitlab";
-        config: {
-            owner: string;
-            repo_name: string;
-            production_branch?: string | undefined;
-            pr_comments_enabled?: boolean | undefined;
-            deployments_enabled?: boolean | undefined;
-            production_deployments_enabled?: boolean | undefined;
-            preview_deployment_setting?: "none" | "all" | "custom" | undefined;
-            preview_branch_includes?: string[] | undefined;
-            preview_branch_excludes?: string[] | undefined;
-        };
-    } | undefined;
-    env_vars?: any;
-    durable_object_namespaces?: any;
-    is_skipped?: boolean | undefined;
-    files?: {
-        [x: string]: string | undefined;
-    } | undefined;
-}>;
-
 declare type ReferrerPolicy =
 | ''
 | 'no-referrer'
@@ -1543,13 +1619,20 @@ declare interface SpecIterator<T, TReturn = any, TNext = undefined> {
     next(...args: [] | [TNext]): IteratorResult<T, TReturn>;
 }
 
+declare type TailConsumer = {
+    /** The name of the service tail events will be forwarded to. */
+    service: string;
+    /** (Optional) The environt of the service. */
+    environment?: string;
+};
+
 /**
  *  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 const unstable_pages: {
-    publish: typeof publish;
+    deploy: typeof deploy;
 };
 
 export declare interface UnstableDevOptions {
@@ -1588,17 +1671,19 @@ export declare interface UnstableDevOptions {
         bucket_name: string;
         preview_bucket_name?: string;
     }[];
+    moduleRoot?: string;
+    rules?: Rule[];
     logLevel?: "none" | "info" | "error" | "log" | "warn" | "debug";
     inspect?: boolean;
     local?: boolean;
     accountId?: string;
     experimental?: {
+        processEntrypoint?: boolean;
+        additionalModules?: CfModule[];
         d1Databases?: Environment["d1_databases"];
         disableExperimentalWarning?: boolean;
         disableDevRegistry?: boolean;
         enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
-        experimentalLocal?: boolean;
-        experimentalLocalRemoteKv?: boolean;
         forceLocal?: boolean;
         liveReload?: boolean;
         showInteractiveDevSession?: boolean;