@cloudflare/workers-types 4.20260506.1 → 4.20260508.1

package/2021-11-03/index.d.ts

@@ -13550,28 +13550,16 @@ declare namespace CloudflareWorkersModule {
     attempt: number;
     config: WorkflowStepConfig;
   };
-  export interface RollbackContext<T> {
-    error: Error;
-    output: NonNullable<T> | undefined;
-    stepName: string;
-  }
-  export interface StepPromise<T> extends Promise<T> {
-    rollback(fn: (ctx: RollbackContext<T>) => Promise<void>): StepPromise<T>;
-    rollback(
-      config: WorkflowStepConfig,
-      fn: (ctx: RollbackContext<T>) => Promise<void>,
-    ): StepPromise<T>;
-  }
   export abstract class WorkflowStep {
     do<T extends Rpc.Serializable<T>>(
       name: string,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     do<T extends Rpc.Serializable<T>>(
       name: string,
       config: WorkflowStepConfig,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     sleep: (name: string, duration: WorkflowSleepDuration) => Promise<void>;
     sleepUntil: (name: string, timestamp: Date | number) => Promise<void>;
     waitForEvent<T extends Rpc.Serializable<T>>(
@@ -13580,7 +13568,7 @@ declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15082,6 +15070,27 @@ interface WorkflowError {
   code?: number;
   message: string;
 }
+interface WorkflowInstanceRestartOptions {
+  /**
+   * Restart from a specific step. If omitted, the instance restarts from the beginning.
+   * The step must exist in the instance's execution history.
+   */
+  from?: {
+    /**
+     * The step name as defined in your workflow code.
+     */
+    name: string;
+    /**
+     * 1-indexed occurrence of this step name. Use when the same step name appears multiple times (e.g. in a loop).
+     * @default 1
+     */
+    count?: number;
+    /**
+     * Step type filter. Use when different step types share the same name.
+     */
+    type?: "do" | "sleep" | "waitForEvent";
+  };
+}
 declare abstract class WorkflowInstance {
   public id: string;
   /**
@@ -15097,9 +15106,11 @@ declare abstract class WorkflowInstance {
    */
   public terminate(): Promise<void>;
   /**
-   * Restart the instance.
+   * Restart the instance. Optionally restart from a specific step, preserving
+   * cached results for all steps before it.
+   * @param options Options for the restart, including an optional step to restart from.
    */
-  public restart(): Promise<void>;
+  public restart(options?: WorkflowInstanceRestartOptions): Promise<void>;
   /**
    * Returns the current status of the instance.
    */

package/2021-11-03/index.ts

@@ -13521,28 +13521,16 @@ export declare namespace CloudflareWorkersModule {
     attempt: number;
     config: WorkflowStepConfig;
   };
-  export interface RollbackContext<T> {
-    error: Error;
-    output: NonNullable<T> | undefined;
-    stepName: string;
-  }
-  export interface StepPromise<T> extends Promise<T> {
-    rollback(fn: (ctx: RollbackContext<T>) => Promise<void>): StepPromise<T>;
-    rollback(
-      config: WorkflowStepConfig,
-      fn: (ctx: RollbackContext<T>) => Promise<void>,
-    ): StepPromise<T>;
-  }
   export abstract class WorkflowStep {
     do<T extends Rpc.Serializable<T>>(
       name: string,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     do<T extends Rpc.Serializable<T>>(
       name: string,
       config: WorkflowStepConfig,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     sleep: (name: string, duration: WorkflowSleepDuration) => Promise<void>;
     sleepUntil: (name: string, timestamp: Date | number) => Promise<void>;
     waitForEvent<T extends Rpc.Serializable<T>>(
@@ -13551,7 +13539,7 @@ export declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15034,6 +15022,27 @@ export interface WorkflowError {
   code?: number;
   message: string;
 }
+export interface WorkflowInstanceRestartOptions {
+  /**
+   * Restart from a specific step. If omitted, the instance restarts from the beginning.
+   * The step must exist in the instance's execution history.
+   */
+  from?: {
+    /**
+     * The step name as defined in your workflow code.
+     */
+    name: string;
+    /**
+     * 1-indexed occurrence of this step name. Use when the same step name appears multiple times (e.g. in a loop).
+     * @default 1
+     */
+    count?: number;
+    /**
+     * Step type filter. Use when different step types share the same name.
+     */
+    type?: "do" | "sleep" | "waitForEvent";
+  };
+}
 export declare abstract class WorkflowInstance {
   public id: string;
   /**
@@ -15049,9 +15058,11 @@ export declare abstract class WorkflowInstance {
    */
   public terminate(): Promise<void>;
   /**
-   * Restart the instance.
+   * Restart the instance. Optionally restart from a specific step, preserving
+   * cached results for all steps before it.
+   * @param options Options for the restart, including an optional step to restart from.
    */
-  public restart(): Promise<void>;
+  public restart(options?: WorkflowInstanceRestartOptions): Promise<void>;
   /**
    * Returns the current status of the instance.
    */

package/2022-01-31/index.d.ts

@@ -13617,28 +13617,16 @@ declare namespace CloudflareWorkersModule {
     attempt: number;
     config: WorkflowStepConfig;
   };
-  export interface RollbackContext<T> {
-    error: Error;
-    output: NonNullable<T> | undefined;
-    stepName: string;
-  }
-  export interface StepPromise<T> extends Promise<T> {
-    rollback(fn: (ctx: RollbackContext<T>) => Promise<void>): StepPromise<T>;
-    rollback(
-      config: WorkflowStepConfig,
-      fn: (ctx: RollbackContext<T>) => Promise<void>,
-    ): StepPromise<T>;
-  }
   export abstract class WorkflowStep {
     do<T extends Rpc.Serializable<T>>(
       name: string,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     do<T extends Rpc.Serializable<T>>(
       name: string,
       config: WorkflowStepConfig,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     sleep: (name: string, duration: WorkflowSleepDuration) => Promise<void>;
     sleepUntil: (name: string, timestamp: Date | number) => Promise<void>;
     waitForEvent<T extends Rpc.Serializable<T>>(
@@ -13647,7 +13635,7 @@ declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15149,6 +15137,27 @@ interface WorkflowError {
   code?: number;
   message: string;
 }
+interface WorkflowInstanceRestartOptions {
+  /**
+   * Restart from a specific step. If omitted, the instance restarts from the beginning.
+   * The step must exist in the instance's execution history.
+   */
+  from?: {
+    /**
+     * The step name as defined in your workflow code.
+     */
+    name: string;
+    /**
+     * 1-indexed occurrence of this step name. Use when the same step name appears multiple times (e.g. in a loop).
+     * @default 1
+     */
+    count?: number;
+    /**
+     * Step type filter. Use when different step types share the same name.
+     */
+    type?: "do" | "sleep" | "waitForEvent";
+  };
+}
 declare abstract class WorkflowInstance {
   public id: string;
   /**
@@ -15164,9 +15173,11 @@ declare abstract class WorkflowInstance {
    */
   public terminate(): Promise<void>;
   /**
-   * Restart the instance.
+   * Restart the instance. Optionally restart from a specific step, preserving
+   * cached results for all steps before it.
+   * @param options Options for the restart, including an optional step to restart from.
    */
-  public restart(): Promise<void>;
+  public restart(options?: WorkflowInstanceRestartOptions): Promise<void>;
   /**
    * Returns the current status of the instance.
    */

package/2022-01-31/index.ts

@@ -13588,28 +13588,16 @@ export declare namespace CloudflareWorkersModule {
     attempt: number;
     config: WorkflowStepConfig;
   };
-  export interface RollbackContext<T> {
-    error: Error;
-    output: NonNullable<T> | undefined;
-    stepName: string;
-  }
-  export interface StepPromise<T> extends Promise<T> {
-    rollback(fn: (ctx: RollbackContext<T>) => Promise<void>): StepPromise<T>;
-    rollback(
-      config: WorkflowStepConfig,
-      fn: (ctx: RollbackContext<T>) => Promise<void>,
-    ): StepPromise<T>;
-  }
   export abstract class WorkflowStep {
     do<T extends Rpc.Serializable<T>>(
       name: string,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     do<T extends Rpc.Serializable<T>>(
       name: string,
       config: WorkflowStepConfig,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     sleep: (name: string, duration: WorkflowSleepDuration) => Promise<void>;
     sleepUntil: (name: string, timestamp: Date | number) => Promise<void>;
     waitForEvent<T extends Rpc.Serializable<T>>(
@@ -13618,7 +13606,7 @@ export declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15101,6 +15089,27 @@ export interface WorkflowError {
   code?: number;
   message: string;
 }
+export interface WorkflowInstanceRestartOptions {
+  /**
+   * Restart from a specific step. If omitted, the instance restarts from the beginning.
+   * The step must exist in the instance's execution history.
+   */
+  from?: {
+    /**
+     * The step name as defined in your workflow code.
+     */
+    name: string;
+    /**
+     * 1-indexed occurrence of this step name. Use when the same step name appears multiple times (e.g. in a loop).
+     * @default 1
+     */
+    count?: number;
+    /**
+     * Step type filter. Use when different step types share the same name.
+     */
+    type?: "do" | "sleep" | "waitForEvent";
+  };
+}
 export declare abstract class WorkflowInstance {
   public id: string;
   /**
@@ -15116,9 +15125,11 @@ export declare abstract class WorkflowInstance {
    */
   public terminate(): Promise<void>;
   /**
-   * Restart the instance.
+   * Restart the instance. Optionally restart from a specific step, preserving
+   * cached results for all steps before it.
+   * @param options Options for the restart, including an optional step to restart from.
    */
-  public restart(): Promise<void>;
+  public restart(options?: WorkflowInstanceRestartOptions): Promise<void>;
   /**
    * Returns the current status of the instance.
    */

package/2022-03-21/index.d.ts

@@ -13626,28 +13626,16 @@ declare namespace CloudflareWorkersModule {
     attempt: number;
     config: WorkflowStepConfig;
   };
-  export interface RollbackContext<T> {
-    error: Error;
-    output: NonNullable<T> | undefined;
-    stepName: string;
-  }
-  export interface StepPromise<T> extends Promise<T> {
-    rollback(fn: (ctx: RollbackContext<T>) => Promise<void>): StepPromise<T>;
-    rollback(
-      config: WorkflowStepConfig,
-      fn: (ctx: RollbackContext<T>) => Promise<void>,
-    ): StepPromise<T>;
-  }
   export abstract class WorkflowStep {
     do<T extends Rpc.Serializable<T>>(
       name: string,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     do<T extends Rpc.Serializable<T>>(
       name: string,
       config: WorkflowStepConfig,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     sleep: (name: string, duration: WorkflowSleepDuration) => Promise<void>;
     sleepUntil: (name: string, timestamp: Date | number) => Promise<void>;
     waitForEvent<T extends Rpc.Serializable<T>>(
@@ -13656,7 +13644,7 @@ declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15158,6 +15146,27 @@ interface WorkflowError {
   code?: number;
   message: string;
 }
+interface WorkflowInstanceRestartOptions {
+  /**
+   * Restart from a specific step. If omitted, the instance restarts from the beginning.
+   * The step must exist in the instance's execution history.
+   */
+  from?: {
+    /**
+     * The step name as defined in your workflow code.
+     */
+    name: string;
+    /**
+     * 1-indexed occurrence of this step name. Use when the same step name appears multiple times (e.g. in a loop).
+     * @default 1
+     */
+    count?: number;
+    /**
+     * Step type filter. Use when different step types share the same name.
+     */
+    type?: "do" | "sleep" | "waitForEvent";
+  };
+}
 declare abstract class WorkflowInstance {
   public id: string;
   /**
@@ -15173,9 +15182,11 @@ declare abstract class WorkflowInstance {
    */
   public terminate(): Promise<void>;
   /**
-   * Restart the instance.
+   * Restart the instance. Optionally restart from a specific step, preserving
+   * cached results for all steps before it.
+   * @param options Options for the restart, including an optional step to restart from.
    */
-  public restart(): Promise<void>;
+  public restart(options?: WorkflowInstanceRestartOptions): Promise<void>;
   /**
    * Returns the current status of the instance.
    */

package/2022-03-21/index.ts

@@ -13597,28 +13597,16 @@ export declare namespace CloudflareWorkersModule {
     attempt: number;
     config: WorkflowStepConfig;
   };
-  export interface RollbackContext<T> {
-    error: Error;
-    output: NonNullable<T> | undefined;
-    stepName: string;
-  }
-  export interface StepPromise<T> extends Promise<T> {
-    rollback(fn: (ctx: RollbackContext<T>) => Promise<void>): StepPromise<T>;
-    rollback(
-      config: WorkflowStepConfig,
-      fn: (ctx: RollbackContext<T>) => Promise<void>,
-    ): StepPromise<T>;
-  }
   export abstract class WorkflowStep {
     do<T extends Rpc.Serializable<T>>(
       name: string,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     do<T extends Rpc.Serializable<T>>(
       name: string,
       config: WorkflowStepConfig,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     sleep: (name: string, duration: WorkflowSleepDuration) => Promise<void>;
     sleepUntil: (name: string, timestamp: Date | number) => Promise<void>;
     waitForEvent<T extends Rpc.Serializable<T>>(
@@ -13627,7 +13615,7 @@ export declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15110,6 +15098,27 @@ export interface WorkflowError {
   code?: number;
   message: string;
 }
+export interface WorkflowInstanceRestartOptions {
+  /**
+   * Restart from a specific step. If omitted, the instance restarts from the beginning.
+   * The step must exist in the instance's execution history.
+   */
+  from?: {
+    /**
+     * The step name as defined in your workflow code.
+     */
+    name: string;
+    /**
+     * 1-indexed occurrence of this step name. Use when the same step name appears multiple times (e.g. in a loop).
+     * @default 1
+     */
+    count?: number;
+    /**
+     * Step type filter. Use when different step types share the same name.
+     */
+    type?: "do" | "sleep" | "waitForEvent";
+  };
+}
 export declare abstract class WorkflowInstance {
   public id: string;
   /**
@@ -15125,9 +15134,11 @@ export declare abstract class WorkflowInstance {
    */
   public terminate(): Promise<void>;
   /**
-   * Restart the instance.
+   * Restart the instance. Optionally restart from a specific step, preserving
+   * cached results for all steps before it.
+   * @param options Options for the restart, including an optional step to restart from.
    */
-  public restart(): Promise<void>;
+  public restart(options?: WorkflowInstanceRestartOptions): Promise<void>;
   /**
    * Returns the current status of the instance.
    */

package/2022-08-04/index.d.ts

@@ -13627,28 +13627,16 @@ declare namespace CloudflareWorkersModule {
     attempt: number;
     config: WorkflowStepConfig;
   };
-  export interface RollbackContext<T> {
-    error: Error;
-    output: NonNullable<T> | undefined;
-    stepName: string;
-  }
-  export interface StepPromise<T> extends Promise<T> {
-    rollback(fn: (ctx: RollbackContext<T>) => Promise<void>): StepPromise<T>;
-    rollback(
-      config: WorkflowStepConfig,
-      fn: (ctx: RollbackContext<T>) => Promise<void>,
-    ): StepPromise<T>;
-  }
   export abstract class WorkflowStep {
     do<T extends Rpc.Serializable<T>>(
       name: string,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     do<T extends Rpc.Serializable<T>>(
       name: string,
       config: WorkflowStepConfig,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     sleep: (name: string, duration: WorkflowSleepDuration) => Promise<void>;
     sleepUntil: (name: string, timestamp: Date | number) => Promise<void>;
     waitForEvent<T extends Rpc.Serializable<T>>(
@@ -13657,7 +13645,7 @@ declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15159,6 +15147,27 @@ interface WorkflowError {
   code?: number;
   message: string;
 }
+interface WorkflowInstanceRestartOptions {
+  /**
+   * Restart from a specific step. If omitted, the instance restarts from the beginning.
+   * The step must exist in the instance's execution history.
+   */
+  from?: {
+    /**
+     * The step name as defined in your workflow code.
+     */
+    name: string;
+    /**
+     * 1-indexed occurrence of this step name. Use when the same step name appears multiple times (e.g. in a loop).
+     * @default 1
+     */
+    count?: number;
+    /**
+     * Step type filter. Use when different step types share the same name.
+     */
+    type?: "do" | "sleep" | "waitForEvent";
+  };
+}
 declare abstract class WorkflowInstance {
   public id: string;
   /**
@@ -15174,9 +15183,11 @@ declare abstract class WorkflowInstance {
    */
   public terminate(): Promise<void>;
   /**
-   * Restart the instance.
+   * Restart the instance. Optionally restart from a specific step, preserving
+   * cached results for all steps before it.
+   * @param options Options for the restart, including an optional step to restart from.
    */
-  public restart(): Promise<void>;
+  public restart(options?: WorkflowInstanceRestartOptions): Promise<void>;
   /**
    * Returns the current status of the instance.
    */

package/2022-08-04/index.ts

@@ -13598,28 +13598,16 @@ export declare namespace CloudflareWorkersModule {
     attempt: number;
     config: WorkflowStepConfig;
   };
-  export interface RollbackContext<T> {
-    error: Error;
-    output: NonNullable<T> | undefined;
-    stepName: string;
-  }
-  export interface StepPromise<T> extends Promise<T> {
-    rollback(fn: (ctx: RollbackContext<T>) => Promise<void>): StepPromise<T>;
-    rollback(
-      config: WorkflowStepConfig,
-      fn: (ctx: RollbackContext<T>) => Promise<void>,
-    ): StepPromise<T>;
-  }
   export abstract class WorkflowStep {
     do<T extends Rpc.Serializable<T>>(
       name: string,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     do<T extends Rpc.Serializable<T>>(
       name: string,
       config: WorkflowStepConfig,
       callback: (ctx: WorkflowStepContext) => Promise<T>,
-    ): StepPromise<T>;
+    ): Promise<T>;
     sleep: (name: string, duration: WorkflowSleepDuration) => Promise<void>;
     sleepUntil: (name: string, timestamp: Date | number) => Promise<void>;
     waitForEvent<T extends Rpc.Serializable<T>>(
@@ -13628,7 +13616,7 @@ export declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15111,6 +15099,27 @@ export interface WorkflowError {
   code?: number;
   message: string;
 }
+export interface WorkflowInstanceRestartOptions {
+  /**
+   * Restart from a specific step. If omitted, the instance restarts from the beginning.
+   * The step must exist in the instance's execution history.
+   */
+  from?: {
+    /**
+     * The step name as defined in your workflow code.
+     */
+    name: string;
+    /**
+     * 1-indexed occurrence of this step name. Use when the same step name appears multiple times (e.g. in a loop).
+     * @default 1
+     */
+    count?: number;
+    /**
+     * Step type filter. Use when different step types share the same name.
+     */
+    type?: "do" | "sleep" | "waitForEvent";
+  };
+}
 export declare abstract class WorkflowInstance {
   public id: string;
   /**
@@ -15126,9 +15135,11 @@ export declare abstract class WorkflowInstance {
    */
   public terminate(): Promise<void>;
   /**
-   * Restart the instance.
+   * Restart the instance. Optionally restart from a specific step, preserving
+   * cached results for all steps before it.
+   * @param options Options for the restart, including an optional step to restart from.
    */
-  public restart(): Promise<void>;
+  public restart(options?: WorkflowInstanceRestartOptions): Promise<void>;
   /**
    * Returns the current status of the instance.
    */