Add sendEvent on Workflows instance (#3872)

* WOR-603: Add sendEvent on Workflows instance

* Generated schemas

---------

Co-authored-by: André Cruz <[email protected]>

Author: sidharthachatterjee

src/cloudflare/internal/workflows-api.ts

@@ -77,6 +77,20 @@ class InstanceImpl implements WorkflowInstance {
     });
     return result;
   }
+
+  public async sendEvent({
+    type,
+    payload,
+  }: {
+    type: string;
+    payload: unknown;
+  }): Promise<void> {
+    await callFetcher(this.fetcher, '/send-event', {
+      type,
+      payload,
+      id: this.id,
+    });
+  }
 }
 
 class WorkflowImpl {

src/cloudflare/internal/workflows.d.ts

@@ -109,4 +109,15 @@ declare abstract class WorkflowInstance {
    * Returns the current status of the instance.
    */
   public status(): Promise<InstanceStatus>;
+
+  /**
+   * Send an event to this instance.
+   */
+  public sendEvent({
+    type,
+    payload,
+  }: {
+    type: string;
+    payload: unknown;
+  }): Promise<void>;
 }

types/defines/workflows.d.ts

@@ -1,4 +1,4 @@
-declare module "cloudflare:workflows" {
+declare module 'cloudflare:workflows' {
   /**
    * NonRetryableError allows for a user to throw a fatal error
    * that makes a Workflow instance fail immediately without triggering a retry
@@ -49,15 +49,15 @@ interface WorkflowInstanceCreateOptions<PARAMS = unknown> {
 
 type InstanceStatus = {
   status:
-    | "queued" // means that instance is waiting to be started (see concurrency limits)
-    | "running"
-    | "paused"
-    | "errored"
-    | "terminated" // user terminated the instance while it was running
-    | "complete"
-    | "waiting" // instance is hibernating and waiting for sleep or event to finish
-    | "waitingForPause" // instance is finishing the current work to pause
-    | "unknown";
+    | 'queued' // means that instance is waiting to be started (see concurrency limits)
+    | 'running'
+    | 'paused'
+    | 'errored'
+    | 'terminated' // user terminated the instance while it was running
+    | 'complete'
+    | 'waiting' // instance is hibernating and waiting for sleep or event to finish
+    | 'waitingForPause' // instance is finishing the current work to pause
+    | 'unknown';
   error?: string;
   output?: object;
 };
@@ -94,4 +94,15 @@ declare abstract class WorkflowInstance {
    * Returns the current status of the instance.
    */
   public status(): Promise<InstanceStatus>;
+
+  /**
+   * Send an event to this instance.
+   */
+  public sendEvent({
+    type,
+    payload,
+  }: {
+    type: string;
+    payload: unknown;
+  }): Promise<void>;
 }

types/generated-snapshot/2021-11-03/index.d.ts

@@ -6986,4 +6986,14 @@ declare abstract class WorkflowInstance {
    * Returns the current status of the instance.
    */
   public status(): Promise<InstanceStatus>;
+  /**
+   * Send an event to this instance.
+   */
+  public sendEvent({
+    type,
+    payload,
+  }: {
+    type: string;
+    payload: unknown;
+  }): Promise<void>;
 }

types/generated-snapshot/2021-11-03/index.ts

@@ -6841,4 +6841,14 @@ export declare abstract class WorkflowInstance {
    * Returns the current status of the instance.
    */
   public status(): Promise<InstanceStatus>;
+  /**
+   * Send an event to this instance.
+   */
+  public sendEvent({
+    type,
+    payload,
+  }: {
+    type: string;
+    payload: unknown;
+  }): Promise<void>;
 }

types/generated-snapshot/2022-01-31/index.d.ts

@@ -7012,4 +7012,14 @@ declare abstract class WorkflowInstance {
    * Returns the current status of the instance.
    */
   public status(): Promise<InstanceStatus>;
+  /**
+   * Send an event to this instance.
+   */
+  public sendEvent({
+    type,
+    payload,
+  }: {
+    type: string;
+    payload: unknown;
+  }): Promise<void>;
 }

types/generated-snapshot/2022-01-31/index.ts

@@ -6867,4 +6867,14 @@ export declare abstract class WorkflowInstance {
    * Returns the current status of the instance.
    */
   public status(): Promise<InstanceStatus>;
+  /**
+   * Send an event to this instance.
+   */
+  public sendEvent({
+    type,
+    payload,
+  }: {
+    type: string;
+    payload: unknown;
+  }): Promise<void>;
 }

types/generated-snapshot/2022-03-21/index.d.ts

@@ -7038,4 +7038,14 @@ declare abstract class WorkflowInstance {
    * Returns the current status of the instance.
    */
   public status(): Promise<InstanceStatus>;
+  /**
+   * Send an event to this instance.
+   */
+  public sendEvent({
+    type,
+    payload,
+  }: {
+    type: string;
+    payload: unknown;
+  }): Promise<void>;
 }

types/generated-snapshot/2022-03-21/index.ts

@@ -6893,4 +6893,14 @@ export declare abstract class WorkflowInstance {
    * Returns the current status of the instance.
    */
   public status(): Promise<InstanceStatus>;
+  /**
+   * Send an event to this instance.
+   */
+  public sendEvent({
+    type,
+    payload,
+  }: {
+    type: string;
+    payload: unknown;
+  }): Promise<void>;
 }

types/generated-snapshot/2022-08-04/index.d.ts

@@ -7039,4 +7039,14 @@ declare abstract class WorkflowInstance {
    * Returns the current status of the instance.
    */
   public status(): Promise<InstanceStatus>;
+  /**
+   * Send an event to this instance.
+   */
+  public sendEvent({
+    type,
+    payload,
+  }: {
+    type: string;
+    payload: unknown;
+  }): Promise<void>;
 }