wrangler 0.0.0-e0efb6f17 → 0.0.0-e101451a2

package/wrangler-dist/cli.d.ts

@@ -221,6 +221,8 @@ declare type Assets = {
      * If false, then respond to requests that match an asset with that asset directly.
      * */
     run_worker_first?: boolean;
+    /** Deprecated; Inverse of run_worker_first. Should use run_worker_first instead */
+    experimental_serve_directly?: boolean;
 };
 
 declare type AssetsOptions = {
@@ -323,6 +325,16 @@ declare type Binding = {
 
 declare type BindingOmit<T> = Omit<T, "binding">;
 
+/**
+ * Result of the `getBindingsProxy` utility
+ */
+export declare type BindingsProxy<Bindings = Record<string, unknown>, CfProperties extends Record<string, unknown> = IncomingRequestCfProperties> = Omit<PlatformProxy<Bindings, CfProperties>, "env"> & {
+    /**
+     * Object containing the various proxies
+     */
+    bindings: Bindings;
+};
+
 declare interface BlobPropertyBag {
     type?: string
     endings?: 'native' | 'transparent'
@@ -972,6 +984,20 @@ declare interface ConfigFields<Dev extends RawDevConfig> {
          */
         exclude?: string[];
     } | undefined;
+    /**
+     * Old behaviour of serving a folder of static assets with your Worker,
+     * without any additional code.
+     * This can either be a string, or an object with additional config
+     * fields.
+     * Will be deprecated in the near future in favor of `assets`.
+     */
+    legacy_assets: {
+        bucket: string;
+        include: string[];
+        exclude: string[];
+        browser_TTL: number | undefined;
+        serve_single_page_app: boolean;
+    } | string | undefined;
     /**
      * A list of wasm modules that your worker should be bound to. This is
      * the "legacy" way of binding to a wasm module. ES module workers should
@@ -1038,8 +1064,6 @@ options?: { dispatcher?: Dispatcher } & Omit<Dispatcher.ConnectOptions, 'origin'
 declare type ContainerApp = {
     name: string;
     instances: number;
-    image?: string;
-    class_name: string;
     scheduling_policy?: "regional" | "moon";
     configuration: {
         image: string;
@@ -1152,6 +1176,7 @@ declare function deploy({ directory, accountId, projectName, branch, skipCaching
         build_image_major_version: number;
         kv_namespaces?: any;
         source?: {
+            type: "github" | "gitlab";
             config: {
                 owner: string;
                 repo_name: string;
@@ -1163,7 +1188,6 @@ declare function deploy({ directory, accountId, projectName, branch, skipCaching
                 preview_branch_includes?: string[] | undefined;
                 preview_branch_excludes?: string[] | undefined;
             };
-            type: "github" | "gitlab";
         } | undefined;
         env_vars?: any;
         durable_object_namespaces?: any;
@@ -1175,6 +1199,61 @@ declare function deploy({ directory, accountId, projectName, branch, skipCaching
     formData: FormData_2;
 }>;
 
+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.
+ */
+declare interface DeprecatedUpload {
+    /**
+     * The format of the Worker script.
+     *
+     * @deprecated We infer the format automatically now.
+     */
+    format?: "modules" | "service-worker";
+    /**
+     * The directory you wish to upload your Worker from,
+     * relative to the Wrangler configuration file.
+     *
+     * Defaults to the directory containing the Wrangler configuration file.
+     *
+     * @deprecated
+     */
+    dir?: string;
+    /**
+     * The path to the Worker script, relative to `upload.dir`.
+     *
+     * @deprecated This will be replaced by a command line argument.
+     */
+    main?: string;
+    /**
+     * @deprecated This is now defined at the top level `rules` field.
+     */
+    rules?: Environment["rules"];
+}
+
 declare interface DevConfig {
     /**
      * IP address for the local dev server to listen on,
@@ -1570,6 +1649,8 @@ declare type Entry = {
     file: string;
     /** A worker's directory. Usually where the Wrangler configuration file is located */
     projectRoot: string;
+    /** The path to the config file, if it exists. */
+    configPath: string | undefined;
     /** Is this a module worker or a service worker? */
     format: CfScriptFormat;
     /** The directory that contains all of a `--no-bundle` worker's modules. Usually `${directory}/src`. Defaults to path.dirname(file) */
@@ -1591,6 +1672,39 @@ 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.
@@ -1736,12 +1850,26 @@ declare interface EnvironmentInheritable {
      *
      * More details here https://developers.cloudflare.com/workers/platform/cron-triggers
      *
-     * @default {crons:[]}
+     * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#triggers
+     *
+     * @default {crons: undefined}
      * @inheritable
      */
     triggers: {
-        crons: string[];
+        crons: string[] | undefined;
     };
+    /**
+     * Specifies the Usage Model for your Worker. There are two options -
+     * [bundled](https://developers.cloudflare.com/workers/platform/limits#bundled-usage-model) and
+     * [unbound](https://developers.cloudflare.com/workers/platform/limits#unbound-usage-model).
+     * For newly created Workers, if the Usage Model is omitted
+     * it will be set to the [default Usage Model set on the account](https://dash.cloudflare.com/?account=workers/default-usage-model).
+     * For existing Workers, if the Usage Model is omitted, it will be
+     * set to the Usage Model configured in the dashboard for that Worker.
+     *
+     * @inheritable
+     */
+    usage_model: "bundled" | "unbound" | undefined;
     /**
      * Specify limits for runtime behavior.
      * Only supported for the "standard" Usage Model
@@ -1773,6 +1901,11 @@ declare interface EnvironmentInheritable {
         cwd?: string;
         /** The directory to watch for changes while using wrangler dev, defaults to the current working directory */
         watch_dir?: string | string[];
+        /**
+         * Deprecated field previously used to configure the build and upload of the script.
+         * @deprecated
+         */
+        upload?: DeprecatedUpload;
     };
     /**
      * Skip internal build steps and directly deploy script
@@ -1784,12 +1917,24 @@ declare interface EnvironmentInheritable {
      * @inheritable
      */
     minify: boolean | undefined;
+    /**
+     * Add polyfills for node builtin modules and globals
+     * @inheritable
+     */
+    node_compat: boolean | undefined;
     /**
      * Designates this Worker as an internal-only "first-party" Worker.
      *
      * @inheritable
      */
     first_party_worker: boolean | undefined;
+    /**
+     * TODO: remove this as it has been deprecated.
+     *
+     * This is just here for now because the `route` commands use it.
+     * So we need to include it in this type so it is available.
+     */
+    zone_id?: string;
     /**
      * List of bindings that you will send to logfwdr
      *
@@ -1930,11 +2075,19 @@ declare interface EnvironmentNonInheritable {
     cloudchamber: CloudchamberConfig;
     /**
      * Container related configuration
-     *
-     * @default []
-     * @nonInheritable
      */
-    containers?: ContainerApp[];
+    containers: {
+        /**
+         * Container app configuration
+         *
+         * NOTE: This field is not automatically inherited from the top level environment,
+         * and so must be specified in every named environment.
+         *
+         * @default {}
+         * @nonInheritable
+         */
+        app: ContainerApp[];
+    };
     /**
      * These specify any Workers KV Namespaces you want to
      * access from inside your Worker.
@@ -2473,6 +2626,7 @@ declare type EventTarget_2 = typeof globalThis extends { EventTarget: infer T }
 declare class ExecutionContext {
     waitUntil(promise: Promise<any>): void;
     passThroughOnException(): void;
+    props: any;
 }
 
 export declare const experimental_patchConfig: (configPath: string, patch: Unstable_RawConfig, isArrayInsertion?: boolean) => string;
@@ -2662,6 +2816,20 @@ declare class FormData_2 {
  */
 declare type FormDataEntryValue = string | File
 
+/**
+ * By reading from a Wrangler configuration file this function generates proxy binding objects that can be
+ * used to simulate the interaction with bindings during local development in a Node.js environment
+ *
+ * @deprecated use `getPlatformProxy` instead
+ *
+ * @param options The various options that can tweak this function's behavior
+ * @returns An Object containing the generated proxies alongside other related utilities
+ */
+export declare function getBindingsProxy<Bindings = Record<string, unknown>, CfProperties extends Record<string, unknown> = IncomingRequestCfProperties>(options?: GetBindingsProxyOptions): Promise<BindingsProxy<Bindings, CfProperties>>;
+
+/** Options for the `getBindingsProxy` utility */
+export declare type GetBindingsProxyOptions = GetPlatformProxyOptions;
+
 declare function getCookies (headers: Headers_2): Record<string, string>
 
 declare function getGlobalDispatcher(): Dispatcher;
@@ -26071,7 +26239,6 @@ declare interface StartDevWorkerInput {
     /**
      * The javascript or typescript entry-point of the worker.
      * This is the `main` property of a Wrangler configuration file.
-     * You can specify a file path or provide the contents directly.
      */
     entrypoint?: string;
     /** The configuration of the worker. */
@@ -26172,6 +26339,7 @@ declare interface StartDevWorkerInput {
     };
     legacy?: {
         site?: Hook<Unstable_Config["site"], [Unstable_Config]>;
+        legacyAssets?: Hook<Unstable_Config["legacy_assets"], [Unstable_Config]>;
         enableServiceEnvironments?: boolean;
     };
     unsafe?: Omit<CfUnsafe, "bindings">;
@@ -26192,6 +26360,7 @@ declare type StartDevWorkerOptions = Omit<StartDevWorkerInput, "assets"> & {
         processEntrypoint: boolean;
     };
     legacy: StartDevWorkerInput["legacy"] & {
+        legacyAssets?: Unstable_Config["legacy_assets"];
         site?: Unstable_Config["site"];
     };
     dev: StartDevWorkerInput["dev"] & {
@@ -26433,9 +26602,11 @@ export declare interface Unstable_DevOptions {
     httpsKeyPath?: string;
     httpsCertPath?: string;
     assets?: string;
+    legacyAssets?: string;
     site?: string;
     siteInclude?: string[];
     siteExclude?: string[];
+    nodeCompat?: boolean;
     compatibilityDate?: string;
     compatibilityFlags?: string[];
     persist?: boolean;
@@ -26506,13 +26677,9 @@ export declare interface Unstable_DevWorker {
 
 export declare const unstable_generateASSETSBinding: (opts: Unstable_ASSETSBindingsOptions) => (request: Request_3) => Promise<Response_3>;
 
-export declare function unstable_getMiniflareWorkerOptions(configPath: string, env?: string, options?: {
-    imagesLocalMode: boolean;
-}): Unstable_MiniflareWorkerOptions;
+export declare function unstable_getMiniflareWorkerOptions(configPath: string, env?: string): Unstable_MiniflareWorkerOptions;
 
-export declare function unstable_getMiniflareWorkerOptions(config: Unstable_Config, env?: string, options?: {
-    imagesLocalMode: boolean;
-}): Unstable_MiniflareWorkerOptions;
+export declare function unstable_getMiniflareWorkerOptions(config: Unstable_Config, env?: string): Unstable_MiniflareWorkerOptions;
 
 export declare interface Unstable_MiniflareWorkerOptions {
     workerOptions: SourcelessWorkerOptions;
@@ -26525,7 +26692,7 @@ export declare const unstable_pages: {
     deploy: typeof deploy;
 };
 
-export declare type Unstable_RawConfig = Partial<ConfigFields<RawDevConfig>> & PagesConfigFields & Unstable_RawEnvironment & EnvironmentMap & {
+export declare type Unstable_RawConfig = Partial<ConfigFields<RawDevConfig>> & PagesConfigFields & Unstable_RawEnvironment & DeprecatedConfigFields & EnvironmentMap & {
     $schema?: string;
 };
 
@@ -26535,7 +26702,7 @@ export declare type Unstable_RawConfig = Partial<ConfigFields<RawDevConfig>> & P
  * All the properties are optional, and will be replaced with defaults in the configuration that
  * is used in the rest of the codebase.
  */
-export declare type Unstable_RawEnvironment = Partial<Environment>;
+export declare type Unstable_RawEnvironment = Partial<Environment> & EnvironmentDeprecated;
 
 /**
  * Get the Wrangler configuration; read it from the give `configPath` if available.