wrangler 0.0.0-e351afcf → 0.0.0-e3990bbf

package/wrangler-dist/cli.d.ts

@@ -5,11 +5,12 @@ import { ConnectionOptions } from 'tls';
 import { Duplex } from 'stream';
 import { EventEmitter } from 'events';
 import { IpcNetConnectOpts } from 'net';
+import type { Json } from 'miniflare';
 import { Readable } from 'stream';
-import { ReadableStream } from 'stream/web';
-import { Socket } from 'net';
+import { ReadableStream as ReadableStream_2 } from 'stream/web';
+import { Socket as Socket_2 } from 'net';
 import { TcpNetConnectOpts } from 'net';
-import { TlsOptions } from 'tls';
+import { TlsOptions as TlsOptions_2 } from 'tls';
 import { TLSSocket } from 'tls';
 import { URL as URL_2 } from 'url';
 import { URLSearchParams as URLSearchParams_2 } from 'url';
@@ -22,11 +23,11 @@ declare interface BlobPropertyBag {
     endings?: 'native' | 'transparent'
 }
 
-declare type BodyInit =
+declare type BodyInit_2 =
 | ArrayBuffer
 | AsyncIterable<Uint8Array>
 | Blob_2
-| FormData
+| FormData_2
 | Iterable<Uint8Array>
 | NodeJS.ArrayBufferView
 | URLSearchParams_2
@@ -34,12 +35,12 @@ declare type BodyInit =
 | string
 
 declare interface BodyMixin {
-    readonly body: ReadableStream | null
+    readonly body: ReadableStream_2 | null
     readonly bodyUsed: boolean
 
     readonly arrayBuffer: () => Promise<ArrayBuffer>
     readonly blob: () => Promise<Blob_2>
-    readonly formData: () => Promise<FormData>
+    readonly formData: () => Promise<FormData_2>
     readonly json: () => Promise<unknown>
     readonly text: () => Promise<string>
 }
@@ -120,16 +121,16 @@ declare namespace buildConnector {
         port: string
         servername?: string
         localAddress?: string | null
-        httpSocket?: Socket
+        httpSocket?: Socket_2
     }
 
     type Callback = (...args: CallbackArgs) => void
-    type CallbackArgs = [null, Socket | TLSSocket] | [Error, null]
+    type CallbackArgs = [null, Socket_2 | TLSSocket] | [Error, null]
 
     type connector = connectorAsync | connectorSync
 
     interface connectorSync {
-        (options: buildConnector.Options): Socket | TLSSocket
+        (options: buildConnector.Options): Socket_2 | TLSSocket
     }
 
     interface connectorAsync {
@@ -137,6 +138,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);
@@ -169,7 +205,7 @@ declare namespace Client {
         /** If `true`, an error is thrown when the request content-length header doesn't match the length of the request body. Default: `true`. */
         strictContentLength?: boolean;
         /** @deprecated use the connect option instead */
-        tls?: TlsOptions | null;
+        tls?: TlsOptions_2 | null;
         /** */
         maxRequestsPerClient?: number;
         /** Max response body size in bytes, -1 is disabled */
@@ -208,6 +244,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<{
+    url: string;
+    environment: "production" | "preview";
+    id: 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" | "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.
  */
@@ -326,7 +430,7 @@ declare namespace Dispatcher {
         path: string;
         method: HttpMethod;
         /** Default: `null` */
-        body?: string | Buffer | Uint8Array | Readable | null | FormData;
+        body?: string | Buffer | Uint8Array | Readable | null | FormData_2;
         /** Default: `null` */
         headers?: IncomingHttpHeaders | string[] | null;
         /** Query string params to be embedded in the request URL. Default: `null` */
@@ -464,6 +568,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 +752,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 +780,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.
@@ -680,15 +795,12 @@ declare interface EnvironmentInheritable {
      */
     zone_id?: string;
     /**
-     * Specify a compiled capnp schema to use
-     * Then add a binding per field in the top level message that you will send to logfwdr
+     * List of bindings that you will send to logfwdr
      *
-     * @default `{schema:undefined,bindings:[]}`
+     * @default `{bindings:[]}`
      * @inheritable
      */
     logfwdr: {
-        /** capnp schema filename */
-        schema: string | undefined;
         bindings: {
             /** The binding name used to refer to logfwdr */
             name: string;
@@ -707,6 +819,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;
 }
 
 /**
@@ -736,9 +856,7 @@ declare interface EnvironmentNonInheritable {
      * @default `{}`
      * @nonInheritable
      */
-    vars: {
-        [key: string]: unknown;
-    };
+    vars: Record<string, string | Json>;
     /**
      * A list of durable objects that your worker should be bound to.
      *
@@ -841,6 +959,8 @@ declare interface EnvironmentNonInheritable {
         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. */
+        jurisdiction?: string;
     }[];
     /**
      * Specifies D1 databases that are bound to this Worker environment.
@@ -867,6 +987,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 +1034,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.
      *
@@ -925,6 +1066,18 @@ declare interface EnvironmentNonInheritable {
         metadata?: {
             [key: string]: string;
         };
+        /**
+         * Used for internal capnp uploads for the Workers runtime
+         */
+        capnp?: {
+            base_path: string;
+            source_schemas: string[];
+            compiled_schema?: never;
+        } | {
+            base_path?: never;
+            source_schemas?: never;
+            compiled_schema: string;
+        };
     };
     mtls_certificates: {
         /** The binding name used to refer to the certificate in the worker */
@@ -932,6 +1085,7 @@ declare interface EnvironmentNonInheritable {
         /** The uuid of the uploaded mTLS certificate */
         certificate_id: string;
     }[];
+    tail_consumers?: TailConsumer[];
 }
 
 declare namespace Errors {
@@ -1049,7 +1203,7 @@ declare namespace Errors {
     }
 }
 
-declare class File extends Blob_2 {
+declare class File_2 extends Blob_2 {
     /**
      * Creates a new File instance.
      *
@@ -1082,7 +1236,7 @@ declare interface FilePropertyBag extends BlobPropertyBag {
 /**
  * Provides a way to easily construct a set of key/value pairs representing form fields and their values, which can then be easily sent using fetch().
  */
-declare class FormData {
+declare class FormData_2 {
     /**
      * Appends a new value onto an existing key inside a FormData object,
      * or adds the key if it does not already exist.
@@ -1147,7 +1301,7 @@ declare class FormData {
      * Executes given callback function for each field of the FormData instance
      */
     forEach: (
-    callbackfn: (value: FormDataEntryValue, key: string, iterable: FormData) => void,
+    callbackfn: (value: FormDataEntryValue, key: string, iterable: FormData_2) => void,
     thisArg?: unknown
     ) => void
 
@@ -1180,7 +1334,7 @@ declare class FormData {
 /**
  * A `string` or `File` that represents a single value from a set of `FormData` key-value pairs.
  */
-declare type FormDataEntryValue = string | File
+declare type FormDataEntryValue = string | File_2
 
 /**
  *  fetches an mTLS certificate from the account mTLS certificate store by ID
@@ -1192,8 +1346,8 @@ export declare function getMTlsCertificate(accountId: string, id: string): Promi
  */
 export declare function getMTlsCertificateByName(accountId: string, name: string): Promise<MTlsCertificateResponse>;
 
-declare class Headers implements SpecIterable<[string, string]> {
-    constructor (init?: HeadersInit)
+declare class Headers_2 implements SpecIterable<[string, string]> {
+    constructor (init?: HeadersInit_2)
     readonly append: (name: string, value: string) => void
     readonly delete: (name: string) => void
     readonly get: (name: string) => string | null
@@ -1201,7 +1355,7 @@ declare class Headers implements SpecIterable<[string, string]> {
     readonly set: (name: string, value: string) => void
     readonly getSetCookie: () => string[]
     readonly forEach: (
-    callbackfn: (value: string, key: string, iterable: Headers) => void,
+    callbackfn: (value: string, key: string, iterable: Headers_2) => void,
     thisArg?: unknown
     ) => void
 
@@ -1211,7 +1365,7 @@ declare class Headers implements SpecIterable<[string, string]> {
     readonly [Symbol.iterator]: () => SpecIterator<[string, string]>
 }
 
-declare type HeadersInit = string[][] | Record<string, string | ReadonlyArray<string>> | Headers
+declare type HeadersInit_2 = string[][] | Record<string, string | ReadonlyArray<string>> | Headers_2
 
 /**
  * The header type declaration of `undici`.
@@ -1263,9 +1417,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;
     /**
@@ -1311,74 +1465,6 @@ declare interface PagesPublishOptions {
     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'
@@ -1390,13 +1476,13 @@ declare type ReferrerPolicy =
 | 'strict-origin-when-cross-origin'
 | 'unsafe-url';
 
-declare class Request implements BodyMixin {
-    constructor (input: RequestInfo, init?: RequestInit)
+declare class Request_2 implements BodyMixin {
+    constructor (input: RequestInfo_2, init?: RequestInit_2)
 
     readonly cache: RequestCache
     readonly credentials: RequestCredentials
     readonly destination: RequestDestination
-    readonly headers: Headers
+    readonly headers: Headers_2
     readonly integrity: string
     readonly method: string
     readonly mode: RequestMode
@@ -1408,16 +1494,16 @@ declare class Request implements BodyMixin {
     readonly signal: AbortSignal
     readonly duplex: RequestDuplex
 
-    readonly body: ReadableStream | null
+    readonly body: ReadableStream_2 | null
     readonly bodyUsed: boolean
 
     readonly arrayBuffer: () => Promise<ArrayBuffer>
     readonly blob: () => Promise<Blob_2>
-    readonly formData: () => Promise<FormData>
+    readonly formData: () => Promise<FormData_2>
     readonly json: () => Promise<unknown>
     readonly text: () => Promise<string>
 
-    readonly clone: () => Request
+    readonly clone: () => Request_2
 }
 
 declare type RequestCache =
@@ -1452,13 +1538,13 @@ declare type RequestDestination =
 
 declare type RequestDuplex = 'half'
 
-declare type RequestInfo = string | URL_2 | Request
+declare type RequestInfo_2 = string | URL_2 | Request_2
 
-declare interface RequestInit {
+declare interface RequestInit_2 {
     method?: string
     keepalive?: boolean
-    headers?: HeadersInit
-    body?: BodyInit
+    headers?: HeadersInit_2
+    body?: BodyInit_2
     redirect?: RequestRedirect
     integrity?: string
     signal?: AbortSignal
@@ -1475,10 +1561,10 @@ declare type RequestMode = 'cors' | 'navigate' | 'no-cors' | 'same-origin'
 
 declare type RequestRedirect = 'error' | 'follow' | 'manual'
 
-declare class Response implements BodyMixin {
-    constructor (body?: BodyInit, init?: ResponseInit)
+declare class Response_2 implements BodyMixin {
+    constructor (body?: BodyInit_2, init?: ResponseInit_2)
 
-    readonly headers: Headers
+    readonly headers: Headers_2
     readonly ok: boolean
     readonly status: number
     readonly statusText: string
@@ -1486,26 +1572,26 @@ declare class Response implements BodyMixin {
     readonly url: string
     readonly redirected: boolean
 
-    readonly body: ReadableStream | null
+    readonly body: ReadableStream_2 | null
     readonly bodyUsed: boolean
 
     readonly arrayBuffer: () => Promise<ArrayBuffer>
     readonly blob: () => Promise<Blob_2>
-    readonly formData: () => Promise<FormData>
+    readonly formData: () => Promise<FormData_2>
     readonly json: () => Promise<unknown>
     readonly text: () => Promise<string>
 
-    readonly clone: () => Response
+    readonly clone: () => Response_2
 
-    static error (): Response
-    static json(data: any, init?: ResponseInit): Response
-    static redirect (url: string | URL_2, status: ResponseRedirectStatus): Response
+    static error (): Response_2
+    static json(data: any, init?: ResponseInit_2): Response_2
+    static redirect (url: string | URL_2, status: ResponseRedirectStatus): Response_2
 }
 
-declare interface ResponseInit {
+declare interface ResponseInit_2 {
     readonly status?: number
     readonly statusText?: string
-    readonly headers?: HeadersInit
+    readonly headers?: HeadersInit_2
 }
 
 declare type ResponseRedirectStatus = 301 | 302 | 303 | 307 | 308
@@ -1543,13 +1629,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 {
@@ -1569,9 +1662,7 @@ export declare interface UnstableDevOptions {
     compatibilityFlags?: string[];
     persist?: boolean;
     persistTo?: string;
-    vars?: {
-        [key: string]: unknown;
-    };
+    vars?: Record<string, string | Json>;
     kv?: {
         binding: string;
         id: string;
@@ -1588,7 +1679,6 @@ export declare interface UnstableDevOptions {
         bucket_name: string;
         preview_bucket_name?: string;
     }[];
-    processEntrypoint?: boolean;
     moduleRoot?: string;
     rules?: Rule[];
     logLevel?: "none" | "info" | "error" | "log" | "warn" | "debug";
@@ -1596,12 +1686,12 @@ export declare interface UnstableDevOptions {
     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;
@@ -1615,7 +1705,7 @@ export declare interface UnstableDevWorker {
     port: number;
     address: string;
     stop: () => Promise<void>;
-    fetch: (input?: RequestInfo, init?: RequestInit) => Promise<Response>;
+    fetch: (input?: RequestInfo_2, init?: RequestInit_2) => Promise<Response_2>;
     waitUntilExit: () => Promise<void>;
 }