@cloudflare/workers-types 4.20260506.1 → 4.20260508.1

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

@@ -13647,28 +13647,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>>(
@@ -13677,7 +13665,7 @@ declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15179,6 +15167,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;
   /**
@@ -15194,9 +15203,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-10-31/index.ts

@@ -13618,28 +13618,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>>(
@@ -13648,7 +13636,7 @@ export declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15131,6 +15119,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;
   /**
@@ -15146,9 +15155,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-11-30/index.d.ts

@@ -13652,28 +13652,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>>(
@@ -13682,7 +13670,7 @@ declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15184,6 +15172,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;
   /**
@@ -15199,9 +15208,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-11-30/index.ts

@@ -13623,28 +13623,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>>(
@@ -13653,7 +13641,7 @@ export declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15136,6 +15124,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;
   /**
@@ -15151,9 +15160,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/2023-03-01/index.d.ts

@@ -13658,28 +13658,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>>(
@@ -13688,7 +13676,7 @@ declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15190,6 +15178,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;
   /**
@@ -15205,9 +15214,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/2023-03-01/index.ts

@@ -13629,28 +13629,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>>(
@@ -13659,7 +13647,7 @@ export declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15142,6 +15130,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;
   /**
@@ -15157,9 +15166,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/2023-07-01/index.d.ts

@@ -13658,28 +13658,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>>(
@@ -13688,7 +13676,7 @@ declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15190,6 +15178,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;
   /**
@@ -15205,9 +15214,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/2023-07-01/index.ts

@@ -13629,28 +13629,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>>(
@@ -13659,7 +13647,7 @@ export declare namespace CloudflareWorkersModule {
         type: string;
         timeout?: WorkflowTimeoutDuration | number;
       },
-    ): StepPromise<WorkflowStepEvent<T>>;
+    ): Promise<WorkflowStepEvent<T>>;
   }
   export type WorkflowInstanceStatus =
     | "queued"
@@ -15142,6 +15130,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;
   /**
@@ -15157,9 +15166,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.
    */