miniflare 0.0.0-ecef68635 → 0.0.0-eec2a7074

package/README.md

@@ -214,6 +214,20 @@ Options for an individual Worker/"nanoservice". All bindings are accessible on
 the global scope in service-worker format Workers, or via the 2nd `env`
 parameter in module format Workers.
 
+### `interface WorkflowOptions`
+
+- `name: string`
+
+  The name of the Workflow.
+
+- `className: string`
+
+  The name of the class exported from the Worker that implements the `WorkflowEntrypoint`.
+
+- `scriptName?`: string
+
+  The name of the script that includes the `WorkflowEntrypoint`. This is optional because it defaults to the current script if not set.
+
 #### Core
 
 - `name?: string`
@@ -585,6 +599,11 @@ parameter in module format Workers.
 - `assetOptions?: { html_handling?: HTMLHandlingOptions, not_found_handling?: NotFoundHandlingOptions}`
   Configuration for file-based asset routing - see [docs](https://developers.cloudflare.com/workers/static-assets/routing/#routing-configuration) for options
 
+#### Workflows
+
+- `workflows?: WorkflowOptions[]`
+  Configuration for one or more Workflows in your project.
+
 #### Analytics Engine, Sending Email, Vectorize and Workers for Platforms
 
 _Not yet supported_
@@ -725,6 +744,10 @@ Options shared between all Workers/"nanoservices".
 
   Where to persist data stored in D1 databases. See docs for `Persistence`.
 
+- `workflowsPersist?: Persistence`
+
+Where to persist data stored in Workflows. See docs for `Persistence`.
+
 #### Analytics Engine, Browser Rendering, Sending Email, Vectorize, Workers AI and Workers for Platforms
 
 _Not yet supported_

package/dist/src/index.d.ts

@@ -3129,22 +3129,39 @@ export declare const PLUGINS: {
     queueName: string;
     deliveryDelay?: number | undefined;
     }>>, z.ZodArray<z.ZodString, "many">, z.ZodRecord<z.ZodString, z.ZodString>]>>;
-    queueConsumers: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodObject<{
+    queueConsumers: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodObject<{
     maxBatchSize: z.ZodOptional<z.ZodNumber>;
     maxBatchTimeout: z.ZodOptional<z.ZodNumber>;
     maxRetires: z.ZodOptional<z.ZodNumber>;
+    maxRetries: z.ZodOptional<z.ZodNumber>;
     deadLetterQueue: z.ZodOptional<z.ZodString>;
     retryDelay: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
     maxBatchSize?: number | undefined;
     maxBatchTimeout?: number | undefined;
     maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
     deadLetterQueue?: string | undefined;
     retryDelay?: number | undefined;
     }, {
     maxBatchSize?: number | undefined;
     maxBatchTimeout?: number | undefined;
     maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
+    deadLetterQueue?: string | undefined;
+    retryDelay?: number | undefined;
+    }>, Omit<{
+    maxBatchSize?: number | undefined;
+    maxBatchTimeout?: number | undefined;
+    maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
+    deadLetterQueue?: string | undefined;
+    retryDelay?: number | undefined;
+    }, "maxRetires">, {
+    maxBatchSize?: number | undefined;
+    maxBatchTimeout?: number | undefined;
+    maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
     deadLetterQueue?: string | undefined;
     retryDelay?: number | undefined;
     }>>, z.ZodArray<z.ZodString, "many">]>>;
@@ -3153,13 +3170,14 @@ export declare const PLUGINS: {
     queueName: string;
     deliveryDelay?: number | undefined;
     }> | undefined;
-    queueConsumers?: string[] | Record<string, {
+    queueConsumers?: string[] | Record<string, Omit<{
     maxBatchSize?: number | undefined;
     maxBatchTimeout?: number | undefined;
     maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
     deadLetterQueue?: string | undefined;
     retryDelay?: number | undefined;
-    }> | undefined;
+    }, "maxRetires">> | undefined;
     }, {
     queueProducers?: string[] | Record<string, string> | Record<string, {
     queueName: string;
@@ -3169,6 +3187,7 @@ export declare const PLUGINS: {
     maxBatchSize?: number | undefined;
     maxBatchTimeout?: number | undefined;
     maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
     deadLetterQueue?: string | undefined;
     retryDelay?: number | undefined;
     }> | undefined;
@@ -3303,6 +3322,39 @@ export declare const PLUGINS: {
     } | undefined;
     } | undefined;
     }>>;
+    workflows: Plugin<z.ZodObject<{
+    workflows: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+    name: z.ZodString;
+    className: z.ZodString;
+    scriptName: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+    name: string;
+    className: string;
+    scriptName?: string | undefined;
+    }, {
+    name: string;
+    className: string;
+    scriptName?: string | undefined;
+    }>>>;
+    }, "strip", z.ZodTypeAny, {
+    workflows?: Record<string, {
+    name: string;
+    className: string;
+    scriptName?: string | undefined;
+    }> | undefined;
+    }, {
+    workflows?: Record<string, {
+    name: string;
+    className: string;
+    scriptName?: string | undefined;
+    }> | undefined;
+    }>, z.ZodObject<{
+    workflowsPersist: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodString, z.ZodEffects<z.ZodString, string, string>]>>;
+    }, "strip", z.ZodTypeAny, {
+    workflowsPersist?: string | boolean | undefined;
+    }, {
+    workflowsPersist?: string | boolean | undefined;
+    }>>;
 };
 
 export declare type Plugins = typeof PLUGINS;
@@ -3366,44 +3418,78 @@ export declare const QueueBindings: {
 
 export declare type QueueConsumer = z.infer<typeof QueueConsumerSchema>;
 
-export declare const QueueConsumerOptionsSchema: z.ZodObject<{
+export declare const QueueConsumerOptionsSchema: z.ZodEffects<z.ZodObject<{
     maxBatchSize: z.ZodOptional<z.ZodNumber>;
     maxBatchTimeout: z.ZodOptional<z.ZodNumber>;
     maxRetires: z.ZodOptional<z.ZodNumber>;
+    maxRetries: z.ZodOptional<z.ZodNumber>;
     deadLetterQueue: z.ZodOptional<z.ZodString>;
     retryDelay: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     maxBatchSize?: number | undefined;
     maxBatchTimeout?: number | undefined;
     maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
     deadLetterQueue?: string | undefined;
     retryDelay?: number | undefined;
 }, {
     maxBatchSize?: number | undefined;
     maxBatchTimeout?: number | undefined;
     maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
+    deadLetterQueue?: string | undefined;
+    retryDelay?: number | undefined;
+}>, Omit<{
+    maxBatchSize?: number | undefined;
+    maxBatchTimeout?: number | undefined;
+    maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
+    deadLetterQueue?: string | undefined;
+    retryDelay?: number | undefined;
+}, "maxRetires">, {
+    maxBatchSize?: number | undefined;
+    maxBatchTimeout?: number | undefined;
+    maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
     deadLetterQueue?: string | undefined;
     retryDelay?: number | undefined;
 }>;
 
 export declare type QueueConsumers = Map<string, z.infer<typeof QueueConsumerSchema>>;
 
-export declare const QueueConsumerSchema: z.ZodIntersection<z.ZodObject<{
+export declare const QueueConsumerSchema: z.ZodIntersection<z.ZodEffects<z.ZodObject<{
     maxBatchSize: z.ZodOptional<z.ZodNumber>;
     maxBatchTimeout: z.ZodOptional<z.ZodNumber>;
     maxRetires: z.ZodOptional<z.ZodNumber>;
+    maxRetries: z.ZodOptional<z.ZodNumber>;
     deadLetterQueue: z.ZodOptional<z.ZodString>;
     retryDelay: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     maxBatchSize?: number | undefined;
     maxBatchTimeout?: number | undefined;
     maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
     deadLetterQueue?: string | undefined;
     retryDelay?: number | undefined;
 }, {
     maxBatchSize?: number | undefined;
     maxBatchTimeout?: number | undefined;
     maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
+    deadLetterQueue?: string | undefined;
+    retryDelay?: number | undefined;
+}>, Omit<{
+    maxBatchSize?: number | undefined;
+    maxBatchTimeout?: number | undefined;
+    maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
+    deadLetterQueue?: string | undefined;
+    retryDelay?: number | undefined;
+}, "maxRetires">, {
+    maxBatchSize?: number | undefined;
+    maxBatchTimeout?: number | undefined;
+    maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
     deadLetterQueue?: string | undefined;
     retryDelay?: number | undefined;
 }>, z.ZodObject<{
@@ -3414,22 +3500,39 @@ export declare const QueueConsumerSchema: z.ZodIntersection<z.ZodObject<{
     workerName: string;
 }>>;
 
-export declare const QueueConsumersSchema: z.ZodRecord<z.ZodString, z.ZodIntersection<z.ZodObject<{
+export declare const QueueConsumersSchema: z.ZodRecord<z.ZodString, z.ZodIntersection<z.ZodEffects<z.ZodObject<{
     maxBatchSize: z.ZodOptional<z.ZodNumber>;
     maxBatchTimeout: z.ZodOptional<z.ZodNumber>;
     maxRetires: z.ZodOptional<z.ZodNumber>;
+    maxRetries: z.ZodOptional<z.ZodNumber>;
     deadLetterQueue: z.ZodOptional<z.ZodString>;
     retryDelay: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     maxBatchSize?: number | undefined;
     maxBatchTimeout?: number | undefined;
     maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
     deadLetterQueue?: string | undefined;
     retryDelay?: number | undefined;
 }, {
     maxBatchSize?: number | undefined;
     maxBatchTimeout?: number | undefined;
     maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
+    deadLetterQueue?: string | undefined;
+    retryDelay?: number | undefined;
+}>, Omit<{
+    maxBatchSize?: number | undefined;
+    maxBatchTimeout?: number | undefined;
+    maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
+    deadLetterQueue?: string | undefined;
+    retryDelay?: number | undefined;
+}, "maxRetires">, {
+    maxBatchSize?: number | undefined;
+    maxBatchTimeout?: number | undefined;
+    maxRetires?: number | undefined;
+    maxRetries?: number | undefined;
     deadLetterQueue?: string | undefined;
     retryDelay?: number | undefined;
 }>, z.ZodObject<{
@@ -3579,22 +3682,39 @@ export declare const QueuesOptionsSchema: z.ZodObject<{
         queueName: string;
         deliveryDelay?: number | undefined;
     }>>, z.ZodArray<z.ZodString, "many">, z.ZodRecord<z.ZodString, z.ZodString>]>>;
-    queueConsumers: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodObject<{
+    queueConsumers: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodObject<{
         maxBatchSize: z.ZodOptional<z.ZodNumber>;
         maxBatchTimeout: z.ZodOptional<z.ZodNumber>;
         maxRetires: z.ZodOptional<z.ZodNumber>;
+        maxRetries: z.ZodOptional<z.ZodNumber>;
         deadLetterQueue: z.ZodOptional<z.ZodString>;
         retryDelay: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         maxBatchSize?: number | undefined;
         maxBatchTimeout?: number | undefined;
         maxRetires?: number | undefined;
+        maxRetries?: number | undefined;
         deadLetterQueue?: string | undefined;
         retryDelay?: number | undefined;
     }, {
         maxBatchSize?: number | undefined;
         maxBatchTimeout?: number | undefined;
         maxRetires?: number | undefined;
+        maxRetries?: number | undefined;
+        deadLetterQueue?: string | undefined;
+        retryDelay?: number | undefined;
+    }>, Omit<{
+        maxBatchSize?: number | undefined;
+        maxBatchTimeout?: number | undefined;
+        maxRetires?: number | undefined;
+        maxRetries?: number | undefined;
+        deadLetterQueue?: string | undefined;
+        retryDelay?: number | undefined;
+    }, "maxRetires">, {
+        maxBatchSize?: number | undefined;
+        maxBatchTimeout?: number | undefined;
+        maxRetires?: number | undefined;
+        maxRetries?: number | undefined;
         deadLetterQueue?: string | undefined;
         retryDelay?: number | undefined;
     }>>, z.ZodArray<z.ZodString, "many">]>>;
@@ -3603,13 +3723,14 @@ export declare const QueuesOptionsSchema: z.ZodObject<{
         queueName: string;
         deliveryDelay?: number | undefined;
     }> | undefined;
-    queueConsumers?: string[] | Record<string, {
+    queueConsumers?: string[] | Record<string, Omit<{
         maxBatchSize?: number | undefined;
         maxBatchTimeout?: number | undefined;
         maxRetires?: number | undefined;
+        maxRetries?: number | undefined;
         deadLetterQueue?: string | undefined;
         retryDelay?: number | undefined;
-    }> | undefined;
+    }, "maxRetires">> | undefined;
 }, {
     queueProducers?: string[] | Record<string, string> | Record<string, {
         queueName: string;
@@ -3619,6 +3740,7 @@ export declare const QueuesOptionsSchema: z.ZodObject<{
         maxBatchSize?: number | undefined;
         maxBatchTimeout?: number | undefined;
         maxRetires?: number | undefined;
+        maxRetries?: number | undefined;
         deadLetterQueue?: string | undefined;
         retryDelay?: number | undefined;
     }> | undefined;
@@ -3852,7 +3974,7 @@ export declare const SharedHeaders: {
     readonly LOG_LEVEL: "MF-Log-Level";
 };
 
-export declare type SharedOptions = z.input<typeof CORE_PLUGIN.sharedOptions> & z.input<typeof CACHE_PLUGIN.sharedOptions> & z.input<typeof D1_PLUGIN.sharedOptions> & z.input<typeof DURABLE_OBJECTS_PLUGIN.sharedOptions> & z.input<typeof KV_PLUGIN.sharedOptions> & z.input<typeof R2_PLUGIN.sharedOptions>;
+export declare type SharedOptions = z.input<typeof CORE_PLUGIN.sharedOptions> & z.input<typeof CACHE_PLUGIN.sharedOptions> & z.input<typeof D1_PLUGIN.sharedOptions> & z.input<typeof DURABLE_OBJECTS_PLUGIN.sharedOptions> & z.input<typeof KV_PLUGIN.sharedOptions> & z.input<typeof R2_PLUGIN.sharedOptions> & z.input<typeof WORKFLOWS_PLUGIN.sharedOptions>;
 
 export declare const SiteBindings: {
     readonly KV_NAMESPACE_SITE: "__STATIC_CONTENT";
@@ -4299,7 +4421,7 @@ export declare type Worker_Module = {
     pythonRequirement?: string;
 });
 
-export declare type WorkerOptions = z.input<typeof CORE_PLUGIN.options> & z.input<typeof CACHE_PLUGIN.options> & z.input<typeof D1_PLUGIN.options> & z.input<typeof DURABLE_OBJECTS_PLUGIN.options> & z.input<typeof KV_PLUGIN.options> & z.input<typeof QUEUES_PLUGIN.options> & z.input<typeof R2_PLUGIN.options> & z.input<typeof HYPERDRIVE_PLUGIN.options> & z.input<typeof RATELIMIT_PLUGIN.options> & z.input<typeof ASSETS_PLUGIN.options>;
+export declare type WorkerOptions = z.input<typeof CORE_PLUGIN.options> & z.input<typeof CACHE_PLUGIN.options> & z.input<typeof D1_PLUGIN.options> & z.input<typeof DURABLE_OBJECTS_PLUGIN.options> & z.input<typeof KV_PLUGIN.options> & z.input<typeof QUEUES_PLUGIN.options> & z.input<typeof R2_PLUGIN.options> & z.input<typeof HYPERDRIVE_PLUGIN.options> & z.input<typeof RATELIMIT_PLUGIN.options> & z.input<typeof ASSETS_PLUGIN.options> & z.input<typeof WORKFLOWS_PLUGIN.options>;
 
 export declare interface WorkerRoute {
     target: string;
@@ -4312,6 +4434,48 @@ export declare interface WorkerRoute {
     allowPathSuffix: boolean;
 }
 
+export declare const WORKFLOWS_PLUGIN: Plugin<typeof WorkflowsOptionsSchema, typeof WorkflowsSharedOptionsSchema>;
+
+export declare const WORKFLOWS_PLUGIN_NAME = "workflows";
+
+export declare const WORKFLOWS_STORAGE_SERVICE_NAME = "workflows:storage";
+
+export declare const WorkflowsOptionsSchema: z.ZodObject<{
+    workflows: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        name: z.ZodString;
+        className: z.ZodString;
+        scriptName: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        className: string;
+        scriptName?: string | undefined;
+    }, {
+        name: string;
+        className: string;
+        scriptName?: string | undefined;
+    }>>>;
+}, "strip", z.ZodTypeAny, {
+    workflows?: Record<string, {
+        name: string;
+        className: string;
+        scriptName?: string | undefined;
+    }> | undefined;
+}, {
+    workflows?: Record<string, {
+        name: string;
+        className: string;
+        scriptName?: string | undefined;
+    }> | undefined;
+}>;
+
+export declare const WorkflowsSharedOptionsSchema: z.ZodObject<{
+    workflowsPersist: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodString, z.ZodEffects<z.ZodString, string, string>]>>;
+}, "strip", z.ZodTypeAny, {
+    workflowsPersist?: string | boolean | undefined;
+}, {
+    workflowsPersist?: string | boolean | undefined;
+}>;
+
 export declare type WrappedBindingNames = Set<string>;
 
 export declare function zAwaitable<T extends z.ZodTypeAny>(type: T): z.ZodUnion<[T, z.ZodPromise<T>]>;