miniflare 3.0.2 → 3.20230710.0

package/README.md

@@ -5,8 +5,7 @@
 [`workerd`](https://github.com/cloudflare/workerd).
 
 > :warning: Miniflare 3 is API-only, and does not expose a CLI. Use Wrangler
-> with `wrangler dev --experimental-local` to develop your Workers locally with
-> Miniflare 3.
+> with `wrangler dev` to develop your Workers locally with Miniflare 3.
 
 ## Quick Start
 
@@ -173,6 +172,27 @@ level will be logged.
   Creates a new logger that logs nothing to the `console`, and always `throw`s
   `message`s logged at the `ERROR` level.
 
+### `interface QueueConsumerOptions`
+
+- `maxBatchSize?: number`
+
+  Maximum number of messages allowed in each batch. Defaults to `5`.
+
+- `maxBatchTimeout?: number`
+
+  Maximum number of seconds to wait for a full batch. If a message is sent, and
+  this timeout elapses, a partial batch will be dispatched. Defaults to `1`.
+
+- `maxRetries?: number`
+
+  Maximum number of times to retry dispatching a message, if handling it throws,
+  or it is explicitly retried. Defaults to `2`.
+
+- `deadLetterQueue?: string`
+
+  Name of another Queue to send a message on if it fails processing after
+  `maxRetries`. If this isn't specified, failed messages will be discarded.
+
 ### `interface WorkerOptions`
 
 Options for an individual Worker/"nanoservice". All bindings are accessible on
@@ -295,6 +315,13 @@ parameter in module format Workers.
     handler. This allows you to access data and functions defined in Node.js
     from your Worker.
 
+- `routes?: string[]`
+
+  Array of route patterns for this Worker. These follow the same
+  [routing rules](https://developers.cloudflare.com/workers/platform/triggers/routes/#matching-behavior)
+  as deployed Workers. If no routes match, Miniflare will fallback to the Worker
+  defined first.
+
 #### Cache
 
 - `cache?: boolean`
@@ -366,7 +393,25 @@ parameter in module format Workers.
   ID with different binding names. If a `string[]` of binding names is
   specified, the binding name and database ID are assumed to be the same.
 
-#### Analytics Engine and Queues
+#### Queues
+
+> :warning: Queues are only supported with Node.js 18 or above.
+
+- `queueProducers?: Record<string, string> | string[]`
+
+  Record mapping binding name to queue names to inject as `WorkerQueue` bindings
+  into this Worker. Different Workers may bind to the same queue name with
+  different binding names. If a `string[]` of binding names is specified, the
+  binding name and queue name are assumed to be the same.
+
+- `queueConsumers?: Record<string, QueueConsumerOptions> | string[]`
+
+  Record mapping queue name to consumer options. Messages enqueued on the
+  corresponding queues will be dispatched to this Worker. Note each queue can
+  have at most one consumer. If a `string[]` of queue names is specified,
+  default consumer options will be used.
+
+#### Analytics Engine
 
 _Not yet supported_
 
@@ -387,6 +432,45 @@ Options shared between all Workers/"nanoservices".
   specified port is in use, Miniflare throws an error, rather than attempting to
   find a free port.
 
+- `https?: boolean`
+
+  If `true`, start an HTTPS server using a pre-generated self-signed certificate
+  for `localhost`. Note this certificate is not valid for any other hostnames or
+  IP addresses. If you need to access the HTTPS server from another device,
+  you'll need to generate your own certificate and use the other `https*`
+  options below.
+
+  ```shell
+  $ openssl req -newkey rsa:2048 -nodes -keyout key.pem -x509 -days 365 -out cert.pem
+  ```
+
+  ```js
+  new Miniflare({
+    httpsKeyPath: "key.pem",
+    httpsCertPath: "cert.pem",
+  });
+  ```
+
+- `httpsKey?: string`
+
+  When one of `httpsCert` or `httpCertPath` is also specified, starts an HTTPS
+  server using the value of this option as the PEM encoded private key.
+
+- `httpsKeyPath?: string`
+
+  When one of `httpsCert` or `httpCertPath` is also specified, starts an HTTPS
+  server using the PEM encoded private key stored at this file path.
+
+- `httpsCert?: string`
+
+  When one of `httpsKey` or `httpsKeyPath` is also specified, starts an HTTPS
+  server using the value of this option as the PEM encoded certificate chain.
+
+- `httpsCertPath?: string`
+
+  When one of `httpsKey` or `httpsKeyPath` is also specified, starts an HTTPS
+  server using the PEM encoded certificate chain stored at this file path.
+
 - `inspectorPort?: number`
 
   Port that `workerd` should start a DevTools inspector server on. Visit
@@ -404,6 +488,13 @@ Options shared between all Workers/"nanoservices".
   Logger implementation for Miniflare's errors, warnings and informative
   messages.
 
+- `upstream?: string`
+
+  URL to use as the origin for incoming requests. If specified, all incoming
+  `request.url`s will be rewritten to start with this string. This is especially
+  useful when testing Workers that act as a proxy, and not as origins
+  themselves.
+
 - `cf?: boolean | string | Record<string, any>`
 
   Controls the object returned from incoming `Request`'s `cf` property.
@@ -431,8 +522,7 @@ Options shared between all Workers/"nanoservices".
 
 - `durableObjectsPersist?: Persistence`
 
-  _Not yet supported_, Miniflare will throw if this is truthy and Durable Object
-  bindings are specified.
+  Where to persist data stored in Durable Objects. See docs for `Persistence`.
 
 - `kvPersist?: Persistence`
 
@@ -446,7 +536,7 @@ Options shared between all Workers/"nanoservices".
 
   Where to persist data stored in D1 databases. See docs for `Persistence`.
 
-#### Analytics Engine and Queues
+#### Analytics Engine
 
 _Not yet supported_
 

package/dist/src/index.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 
 import type { Abortable } from 'events';
+import { Agent } from 'undici';
 import { BodyInit } from 'undici';
 import { CacheGateway as CacheGateway_2 } from './cache';
 import { D1Gateway as D1Gateway_2 } from './d1';
@@ -51,11 +52,14 @@ import { compatibilityDate as supportedCompatibilityDate } from 'workerd';
 import { Timers as Timers_2 } from '../shared';
 import { TlsOptions_Version as TlsOptions_Version_2 } from '../../runtime';
 import { TlsOptions_Version as TlsOptions_Version_3 } from '../index';
+import { Transform } from 'stream';
 import { TransformStream } from 'stream/web';
 import { URLSearchParams as URLSearchParams_2 } from 'url';
 import { WritableStream } from 'stream/web';
 import { z } from 'zod';
 
+export declare const allowUnauthorizedAgent: Agent;
+
 export declare type Awaitable<T> = T | Promise<T>;
 
 export declare const BASE64_REGEXP: RegExp;
@@ -151,6 +155,8 @@ export declare interface Config {
     extension?: Extension[];
 }
 
+export declare function configureEntrySocket(coreOpts: z.infer<typeof CORE_PLUGIN.sharedOptions>): Promise<Socket>;
+
 export declare const CORE_PLUGIN: Plugin<typeof CoreOptionsSchema, typeof CoreSharedOptionsSchema>;
 
 export declare const CORE_PLUGIN_NAME = "core";
@@ -414,9 +420,9 @@ export declare const CoreOptionsSchema: z.ZodIntersection<z.ZodUnion<[z.ZodObjec
 }, "strip", z.ZodTypeAny, {
     name?: string | undefined;
     compatibilityDate?: string | undefined;
-    bindings?: Record<string, Json_2> | undefined;
     compatibilityFlags?: string[] | undefined;
     routes?: string[] | undefined;
+    bindings?: Record<string, Json_2> | undefined;
     wasmBindings?: Record<string, string> | undefined;
     textBlobBindings?: Record<string, string> | undefined;
     dataBlobBindings?: Record<string, string> | undefined;
@@ -448,9 +454,9 @@ export declare const CoreOptionsSchema: z.ZodIntersection<z.ZodUnion<[z.ZodObjec
 }, {
     name?: string | undefined;
     compatibilityDate?: string | undefined;
-    bindings?: Record<string, Json_2> | undefined;
     compatibilityFlags?: string[] | undefined;
     routes?: string[] | undefined;
+    bindings?: Record<string, Json_2> | undefined;
     wasmBindings?: Record<string, string> | undefined;
     textBlobBindings?: Record<string, string> | undefined;
     dataBlobBindings?: Record<string, string> | undefined;
@@ -484,6 +490,11 @@ export declare const CoreOptionsSchema: z.ZodIntersection<z.ZodUnion<[z.ZodObjec
 export declare const CoreSharedOptionsSchema: z.ZodObject<{
     host: z.ZodOptional<z.ZodString>;
     port: z.ZodOptional<z.ZodNumber>;
+    https: z.ZodOptional<z.ZodBoolean>;
+    httpsKey: z.ZodOptional<z.ZodString>;
+    httpsKeyPath: z.ZodOptional<z.ZodString>;
+    httpsCert: z.ZodOptional<z.ZodString>;
+    httpsCertPath: z.ZodOptional<z.ZodString>;
     inspectorPort: z.ZodOptional<z.ZodNumber>;
     verbose: z.ZodOptional<z.ZodBoolean>;
     log: z.ZodOptional<z.ZodType<Log, z.ZodTypeDef, Log>>;
@@ -497,6 +508,11 @@ export declare const CoreSharedOptionsSchema: z.ZodObject<{
     cf?: string | boolean | Record<string, any> | undefined;
     inspectorPort?: number | undefined;
     verbose?: boolean | undefined;
+    https?: boolean | undefined;
+    httpsKey?: string | undefined;
+    httpsKeyPath?: string | undefined;
+    httpsCert?: string | undefined;
+    httpsCertPath?: string | undefined;
     log?: Log | undefined;
     timers?: Timers<unknown> | undefined;
     upstream?: string | undefined;
@@ -507,6 +523,11 @@ export declare const CoreSharedOptionsSchema: z.ZodObject<{
     cf?: string | boolean | Record<string, any> | undefined;
     inspectorPort?: number | undefined;
     verbose?: boolean | undefined;
+    https?: boolean | undefined;
+    httpsKey?: string | undefined;
+    httpsKeyPath?: string | undefined;
+    httpsCert?: string | undefined;
+    httpsCertPath?: string | undefined;
     log?: Log | undefined;
     timers?: Timers<unknown> | undefined;
     upstream?: string | undefined;
@@ -1228,7 +1249,7 @@ export declare type Plugin<Options extends z.ZodType, SharedOptions extends z.Zo
     router: RouterConstructor<Gateway>;
 });
 
-export declare const PLUGIN_ENTRIES: ["kv" | "cache" | "core" | "do" | "d1" | "queues" | "r2", ValueOf<{
+export declare const PLUGIN_ENTRIES: ["core" | "kv" | "cache" | "do" | "d1" | "queues" | "r2", ValueOf<{
     core: Plugin_2<z.ZodIntersection<z.ZodUnion<[z.ZodObject<{
     modules: z.ZodArray<z.ZodObject<{
     type: z.ZodUnion<[z.ZodLiteral<"ESModule">, z.ZodLiteral<"CommonJS">, z.ZodLiteral<"Text">, z.ZodLiteral<"Data">, z.ZodLiteral<"CompiledWasm">]>;
@@ -1468,9 +1489,9 @@ export declare const PLUGIN_ENTRIES: ["kv" | "cache" | "core" | "do" | "d1" | "q
     }, "strip", z.ZodTypeAny, {
     name?: string | undefined;
     compatibilityDate?: string | undefined;
-    bindings?: Record<string, Json_3> | undefined;
     compatibilityFlags?: string[] | undefined;
     routes?: string[] | undefined;
+    bindings?: Record<string, Json_3> | undefined;
     wasmBindings?: Record<string, string> | undefined;
     textBlobBindings?: Record<string, string> | undefined;
     dataBlobBindings?: Record<string, string> | undefined;
@@ -1502,9 +1523,9 @@ export declare const PLUGIN_ENTRIES: ["kv" | "cache" | "core" | "do" | "d1" | "q
     }, {
     name?: string | undefined;
     compatibilityDate?: string | undefined;
-    bindings?: Record<string, Json_3> | undefined;
     compatibilityFlags?: string[] | undefined;
     routes?: string[] | undefined;
+    bindings?: Record<string, Json_3> | undefined;
     wasmBindings?: Record<string, string> | undefined;
     textBlobBindings?: Record<string, string> | undefined;
     dataBlobBindings?: Record<string, string> | undefined;
@@ -1536,6 +1557,11 @@ export declare const PLUGIN_ENTRIES: ["kv" | "cache" | "core" | "do" | "d1" | "q
     }>>, z.ZodObject<{
     host: z.ZodOptional<z.ZodString>;
     port: z.ZodOptional<z.ZodNumber>;
+    https: z.ZodOptional<z.ZodBoolean>;
+    httpsKey: z.ZodOptional<z.ZodString>;
+    httpsKeyPath: z.ZodOptional<z.ZodString>;
+    httpsCert: z.ZodOptional<z.ZodString>;
+    httpsCertPath: z.ZodOptional<z.ZodString>;
     inspectorPort: z.ZodOptional<z.ZodNumber>;
     verbose: z.ZodOptional<z.ZodBoolean>;
     log: z.ZodOptional<z.ZodType<Log_2, z.ZodTypeDef, Log_2>>;
@@ -1549,6 +1575,11 @@ export declare const PLUGIN_ENTRIES: ["kv" | "cache" | "core" | "do" | "d1" | "q
     cf?: string | boolean | Record<string, any> | undefined;
     inspectorPort?: number | undefined;
     verbose?: boolean | undefined;
+    https?: boolean | undefined;
+    httpsKey?: string | undefined;
+    httpsKeyPath?: string | undefined;
+    httpsCert?: string | undefined;
+    httpsCertPath?: string | undefined;
     log?: Log_2 | undefined;
     timers?: Timers_2<unknown> | undefined;
     upstream?: string | undefined;
@@ -1559,6 +1590,11 @@ export declare const PLUGIN_ENTRIES: ["kv" | "cache" | "core" | "do" | "d1" | "q
     cf?: string | boolean | Record<string, any> | undefined;
     inspectorPort?: number | undefined;
     verbose?: boolean | undefined;
+    https?: boolean | undefined;
+    httpsKey?: string | undefined;
+    httpsKeyPath?: string | undefined;
+    httpsCert?: string | undefined;
+    httpsCertPath?: string | undefined;
     log?: Log_2 | undefined;
     timers?: Timers_2<unknown> | undefined;
     upstream?: string | undefined;
@@ -1946,9 +1982,9 @@ export declare const PLUGINS: {
     }, "strip", z.ZodTypeAny, {
     name?: string | undefined;
     compatibilityDate?: string | undefined;
-    bindings?: Record<string, Json_3> | undefined;
     compatibilityFlags?: string[] | undefined;
     routes?: string[] | undefined;
+    bindings?: Record<string, Json_3> | undefined;
     wasmBindings?: Record<string, string> | undefined;
     textBlobBindings?: Record<string, string> | undefined;
     dataBlobBindings?: Record<string, string> | undefined;
@@ -1980,9 +2016,9 @@ export declare const PLUGINS: {
     }, {
     name?: string | undefined;
     compatibilityDate?: string | undefined;
-    bindings?: Record<string, Json_3> | undefined;
     compatibilityFlags?: string[] | undefined;
     routes?: string[] | undefined;
+    bindings?: Record<string, Json_3> | undefined;
     wasmBindings?: Record<string, string> | undefined;
     textBlobBindings?: Record<string, string> | undefined;
     dataBlobBindings?: Record<string, string> | undefined;
@@ -2014,6 +2050,11 @@ export declare const PLUGINS: {
     }>>, z.ZodObject<{
     host: z.ZodOptional<z.ZodString>;
     port: z.ZodOptional<z.ZodNumber>;
+    https: z.ZodOptional<z.ZodBoolean>;
+    httpsKey: z.ZodOptional<z.ZodString>;
+    httpsKeyPath: z.ZodOptional<z.ZodString>;
+    httpsCert: z.ZodOptional<z.ZodString>;
+    httpsCertPath: z.ZodOptional<z.ZodString>;
     inspectorPort: z.ZodOptional<z.ZodNumber>;
     verbose: z.ZodOptional<z.ZodBoolean>;
     log: z.ZodOptional<z.ZodType<Log_2, z.ZodTypeDef, Log_2>>;
@@ -2027,6 +2068,11 @@ export declare const PLUGINS: {
     cf?: string | boolean | Record<string, any> | undefined;
     inspectorPort?: number | undefined;
     verbose?: boolean | undefined;
+    https?: boolean | undefined;
+    httpsKey?: string | undefined;
+    httpsKeyPath?: string | undefined;
+    httpsCert?: string | undefined;
+    httpsCertPath?: string | undefined;
     log?: Log_2 | undefined;
     timers?: Timers_2<unknown> | undefined;
     upstream?: string | undefined;
@@ -2037,6 +2083,11 @@ export declare const PLUGINS: {
     cf?: string | boolean | Record<string, any> | undefined;
     inspectorPort?: number | undefined;
     verbose?: boolean | undefined;
+    https?: boolean | undefined;
+    httpsKey?: string | undefined;
+    httpsKeyPath?: string | undefined;
+    httpsCert?: string | undefined;
+    httpsCertPath?: string | undefined;
     log?: Log_2 | undefined;
     timers?: Timers_2<unknown> | undefined;
     upstream?: string | undefined;
@@ -4410,6 +4461,8 @@ export declare enum TlsOptions_Version {
     TLS1DOT3 = 5
 }
 
+export declare function _transformsForContentEncoding(encoding?: string): Transform[];
+
 export declare type TypedDatabase = Omit<Database, "prepare"> & {
     prepare<Params = unknown[], SingleResult = unknown>(source: string): Params extends any[] ? TypedStatement<Params, SingleResult> : TypedStatement<[Params], SingleResult>;
 };