@upstash/workflow 0.1.0 → 0.1.1-canary-2

package/{chunk-JDMP6KKR.mjs → chunk-BPN5JBNG.mjs}

@@ -1084,6 +1084,23 @@ var sortSteps = (steps) => {
   return steps.toSorted((step, stepOther) => getStepId(step) - getStepId(stepOther));
 };
 
+// src/client/utils.ts
+var makeNotifyRequest = async (requester, eventId, eventData) => {
+  const result = await requester.request({
+    path: ["v2", "notify", eventId],
+    method: "POST",
+    body: typeof eventData === "string" ? eventData : JSON.stringify(eventData)
+  });
+  return result;
+};
+var makeGetWaitersRequest = async (requester, eventId) => {
+  const result = await requester.request({
+    path: ["v2", "waiters", eventId],
+    method: "GET"
+  });
+  return result;
+};
+
 // src/context/steps.ts
 var BaseLazyStep = class {
   stepName;
@@ -1242,6 +1259,19 @@ var LazyWaitForEventStep = class extends BaseLazyStep {
     });
   }
 };
+var LazyNotifyStep = class extends LazyFunctionStep {
+  stepType = "Notify";
+  constructor(stepName, eventId, eventData, requester) {
+    super(stepName, async () => {
+      const notifyResponse = await makeNotifyRequest(requester, eventId, eventData);
+      return {
+        eventId,
+        eventData,
+        notifyResponse
+      };
+    });
+  }
+};
 
 // src/context/context.ts
 var WorkflowContext = class {
@@ -1488,6 +1518,38 @@ var WorkflowContext = class {
       return result;
     }
   }
+  /**
+   * Makes the workflow run wait until a notify request is sent or until the
+   * timeout ends
+   *
+   * ```ts
+   * const { eventData, timeout } = await context.waitForEvent(
+   *   "wait for event step",
+   *   "my-event-id",
+   *   100 // timeout after 100 seconds
+   * );
+   * ```
+   *
+   * To notify a waiting workflow run, you can use the notify method:
+   *
+   * ```ts
+   * import { Client } from "@upstash/workflow";
+   *
+   * const client = new Client({ token: });
+   *
+   * await client.notify({
+   *   eventId: "my-event-id",
+   *   eventData: "eventData"
+   * })
+   * ```
+   *
+   * @param stepName
+   * @param eventId event id to wake up the waiting workflow run
+   * @param timeout timeout duration in seconds
+   * @returns wait response as `{ timeout: boolean, eventData: unknown }`.
+   *   timeout is true if the wait times out, if notified it is false. eventData
+   *   is the value passed to `client.notify`.
+   */
   async waitForEvent(stepName, eventId, timeout) {
     const result = await this.addStep(
       new LazyWaitForEventStep(
@@ -1496,7 +1558,27 @@ var WorkflowContext = class {
         typeof timeout === "string" ? timeout : `${timeout}s`
       )
     );
-    return result;
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
+  }
+  async notify(stepName, eventId, eventData) {
+    const result = await this.addStep(
+      new LazyNotifyStep(stepName, eventId, eventData, this.qstashClient.http)
+    );
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
   }
   /**
    * Adds steps to the executor. Needed so that it can be overwritten in
@@ -1597,7 +1679,7 @@ var parsePayload = (rawPayload) => {
     const step = JSON.parse(decodeBase64(rawStep.body));
     if (step.waitEventId) {
       const newOut = {
-        notifyBody: step.out,
+        eventData: step.out,
         timeout: step.waitTimeout ?? false
       };
       step.out = newOut;
@@ -1957,7 +2039,7 @@ import { Client as QStashClient } from "@upstash/qstash";
 var Client3 = class {
   client;
   constructor(clientConfig) {
-    if (!clientConfig.baseUrl || !clientConfig.token) {
+    if (!clientConfig.token) {
       console.warn("[Upstash Workflow] url or the token is not set. client will not work.");
     }
     this.client = new QStashClient(clientConfig);
@@ -1980,18 +2062,21 @@ var Client3 = class {
    * Notify a workflow run waiting for an event
    *
    * @param eventId event id to notify
-   * @param notifyData data to provide to the workflow
+   * @param eventData data to provide to the workflow
    */
   async notify({
     eventId,
-    notifyBody
+    eventData
   }) {
-    const result = await this.client.http.request({
-      path: ["v2", "notify", eventId],
-      method: "POST",
-      body: notifyBody
-    });
-    return result;
+    return await makeNotifyRequest(this.client.http, eventId, eventData);
+  }
+  /**
+   * Check waiters of an event
+   *
+   * @param eventId event id to check
+   */
+  async getWaiters({ eventId }) {
+    return await makeGetWaitersRequest(this.client.http, eventId);
   }
 };
 

package/cloudflare.d.mts

@@ -1,4 +1,4 @@
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-CfN1Epuj.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.mjs';
 import '@upstash/qstash';
 
 type WorkflowBindings = {

package/cloudflare.d.ts

@@ -1,4 +1,4 @@
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-CfN1Epuj.js';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.js';
 import '@upstash/qstash';
 
 type WorkflowBindings = {

package/cloudflare.js

@@ -1110,6 +1110,16 @@ var sortSteps = (steps) => {
   return steps.toSorted((step, stepOther) => getStepId(step) - getStepId(stepOther));
 };
 
+// src/client/utils.ts
+var makeNotifyRequest = async (requester, eventId, eventData) => {
+  const result = await requester.request({
+    path: ["v2", "notify", eventId],
+    method: "POST",
+    body: typeof eventData === "string" ? eventData : JSON.stringify(eventData)
+  });
+  return result;
+};
+
 // src/context/steps.ts
 var BaseLazyStep = class {
   stepName;
@@ -1268,6 +1278,19 @@ var LazyWaitForEventStep = class extends BaseLazyStep {
     });
   }
 };
+var LazyNotifyStep = class extends LazyFunctionStep {
+  stepType = "Notify";
+  constructor(stepName, eventId, eventData, requester) {
+    super(stepName, async () => {
+      const notifyResponse = await makeNotifyRequest(requester, eventId, eventData);
+      return {
+        eventId,
+        eventData,
+        notifyResponse
+      };
+    });
+  }
+};
 
 // src/context/context.ts
 var WorkflowContext = class {
@@ -1514,6 +1537,38 @@ var WorkflowContext = class {
       return result;
     }
   }
+  /**
+   * Makes the workflow run wait until a notify request is sent or until the
+   * timeout ends
+   *
+   * ```ts
+   * const { eventData, timeout } = await context.waitForEvent(
+   *   "wait for event step",
+   *   "my-event-id",
+   *   100 // timeout after 100 seconds
+   * );
+   * ```
+   *
+   * To notify a waiting workflow run, you can use the notify method:
+   *
+   * ```ts
+   * import { Client } from "@upstash/workflow";
+   *
+   * const client = new Client({ token: });
+   *
+   * await client.notify({
+   *   eventId: "my-event-id",
+   *   eventData: "eventData"
+   * })
+   * ```
+   *
+   * @param stepName
+   * @param eventId event id to wake up the waiting workflow run
+   * @param timeout timeout duration in seconds
+   * @returns wait response as `{ timeout: boolean, eventData: unknown }`.
+   *   timeout is true if the wait times out, if notified it is false. eventData
+   *   is the value passed to `client.notify`.
+   */
   async waitForEvent(stepName, eventId, timeout) {
     const result = await this.addStep(
       new LazyWaitForEventStep(
@@ -1522,7 +1577,27 @@ var WorkflowContext = class {
         typeof timeout === "string" ? timeout : `${timeout}s`
       )
     );
-    return result;
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
+  }
+  async notify(stepName, eventId, eventData) {
+    const result = await this.addStep(
+      new LazyNotifyStep(stepName, eventId, eventData, this.qstashClient.http)
+    );
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
   }
   /**
    * Adds steps to the executor. Needed so that it can be overwritten in
@@ -1623,7 +1698,7 @@ var parsePayload = (rawPayload) => {
     const step = JSON.parse(decodeBase64(rawStep.body));
     if (step.waitEventId) {
       const newOut = {
-        notifyBody: step.out,
+        eventData: step.out,
         timeout: step.waitTimeout ?? false
       };
       step.out = newOut;

package/cloudflare.mjs

@@ -1,6 +1,6 @@
 import {
   serve
-} from "./chunk-JDMP6KKR.mjs";
+} from "./chunk-BPN5JBNG.mjs";
 
 // platforms/cloudflare.ts
 var getArgs = (args) => {

package/h3.d.mts

@@ -1,5 +1,5 @@
 import * as h3 from 'h3';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-CfN1Epuj.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.mjs';
 import '@upstash/qstash';
 
 declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish">) => h3.EventHandler<h3.EventHandlerRequest, Promise<Response | {

package/h3.d.ts

@@ -1,5 +1,5 @@
 import * as h3 from 'h3';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-CfN1Epuj.js';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.js';
 import '@upstash/qstash';
 
 declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish">) => h3.EventHandler<h3.EventHandlerRequest, Promise<Response | {

package/h3.js

@@ -1419,6 +1419,16 @@ var sortSteps = (steps) => {
   return steps.toSorted((step, stepOther) => getStepId(step) - getStepId(stepOther));
 };
 
+// src/client/utils.ts
+var makeNotifyRequest = async (requester, eventId, eventData) => {
+  const result = await requester.request({
+    path: ["v2", "notify", eventId],
+    method: "POST",
+    body: typeof eventData === "string" ? eventData : JSON.stringify(eventData)
+  });
+  return result;
+};
+
 // src/context/steps.ts
 var BaseLazyStep = class {
   stepName;
@@ -1577,6 +1587,19 @@ var LazyWaitForEventStep = class extends BaseLazyStep {
     });
   }
 };
+var LazyNotifyStep = class extends LazyFunctionStep {
+  stepType = "Notify";
+  constructor(stepName, eventId, eventData, requester) {
+    super(stepName, async () => {
+      const notifyResponse = await makeNotifyRequest(requester, eventId, eventData);
+      return {
+        eventId,
+        eventData,
+        notifyResponse
+      };
+    });
+  }
+};
 
 // src/context/context.ts
 var WorkflowContext = class {
@@ -1823,6 +1846,38 @@ var WorkflowContext = class {
       return result;
     }
   }
+  /**
+   * Makes the workflow run wait until a notify request is sent or until the
+   * timeout ends
+   *
+   * ```ts
+   * const { eventData, timeout } = await context.waitForEvent(
+   *   "wait for event step",
+   *   "my-event-id",
+   *   100 // timeout after 100 seconds
+   * );
+   * ```
+   *
+   * To notify a waiting workflow run, you can use the notify method:
+   *
+   * ```ts
+   * import { Client } from "@upstash/workflow";
+   *
+   * const client = new Client({ token: });
+   *
+   * await client.notify({
+   *   eventId: "my-event-id",
+   *   eventData: "eventData"
+   * })
+   * ```
+   *
+   * @param stepName
+   * @param eventId event id to wake up the waiting workflow run
+   * @param timeout timeout duration in seconds
+   * @returns wait response as `{ timeout: boolean, eventData: unknown }`.
+   *   timeout is true if the wait times out, if notified it is false. eventData
+   *   is the value passed to `client.notify`.
+   */
   async waitForEvent(stepName, eventId, timeout) {
     const result = await this.addStep(
       new LazyWaitForEventStep(
@@ -1831,7 +1886,27 @@ var WorkflowContext = class {
         typeof timeout === "string" ? timeout : `${timeout}s`
       )
     );
-    return result;
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
+  }
+  async notify(stepName, eventId, eventData) {
+    const result = await this.addStep(
+      new LazyNotifyStep(stepName, eventId, eventData, this.qstashClient.http)
+    );
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
   }
   /**
    * Adds steps to the executor. Needed so that it can be overwritten in
@@ -1932,7 +2007,7 @@ var parsePayload = (rawPayload) => {
     const step = JSON.parse(decodeBase64(rawStep.body));
     if (step.waitEventId) {
       const newOut = {
-        notifyBody: step.out,
+        eventData: step.out,
         timeout: step.waitTimeout ?? false
       };
       step.out = newOut;

package/h3.mjs

@@ -1,6 +1,6 @@
 import {
   serve
-} from "./chunk-JDMP6KKR.mjs";
+} from "./chunk-BPN5JBNG.mjs";
 
 // node_modules/defu/dist/defu.mjs
 function isPlainObject(value) {

package/hono.d.mts

@@ -1,5 +1,5 @@
 import { Context } from 'hono';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-CfN1Epuj.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.mjs';
 import '@upstash/qstash';
 
 type WorkflowBindings = {

package/hono.d.ts

@@ -1,5 +1,5 @@
 import { Context } from 'hono';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-CfN1Epuj.js';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.js';
 import '@upstash/qstash';
 
 type WorkflowBindings = {

package/hono.js

@@ -1110,6 +1110,16 @@ var sortSteps = (steps) => {
   return steps.toSorted((step, stepOther) => getStepId(step) - getStepId(stepOther));
 };
 
+// src/client/utils.ts
+var makeNotifyRequest = async (requester, eventId, eventData) => {
+  const result = await requester.request({
+    path: ["v2", "notify", eventId],
+    method: "POST",
+    body: typeof eventData === "string" ? eventData : JSON.stringify(eventData)
+  });
+  return result;
+};
+
 // src/context/steps.ts
 var BaseLazyStep = class {
   stepName;
@@ -1268,6 +1278,19 @@ var LazyWaitForEventStep = class extends BaseLazyStep {
     });
   }
 };
+var LazyNotifyStep = class extends LazyFunctionStep {
+  stepType = "Notify";
+  constructor(stepName, eventId, eventData, requester) {
+    super(stepName, async () => {
+      const notifyResponse = await makeNotifyRequest(requester, eventId, eventData);
+      return {
+        eventId,
+        eventData,
+        notifyResponse
+      };
+    });
+  }
+};
 
 // src/context/context.ts
 var WorkflowContext = class {
@@ -1514,6 +1537,38 @@ var WorkflowContext = class {
       return result;
     }
   }
+  /**
+   * Makes the workflow run wait until a notify request is sent or until the
+   * timeout ends
+   *
+   * ```ts
+   * const { eventData, timeout } = await context.waitForEvent(
+   *   "wait for event step",
+   *   "my-event-id",
+   *   100 // timeout after 100 seconds
+   * );
+   * ```
+   *
+   * To notify a waiting workflow run, you can use the notify method:
+   *
+   * ```ts
+   * import { Client } from "@upstash/workflow";
+   *
+   * const client = new Client({ token: });
+   *
+   * await client.notify({
+   *   eventId: "my-event-id",
+   *   eventData: "eventData"
+   * })
+   * ```
+   *
+   * @param stepName
+   * @param eventId event id to wake up the waiting workflow run
+   * @param timeout timeout duration in seconds
+   * @returns wait response as `{ timeout: boolean, eventData: unknown }`.
+   *   timeout is true if the wait times out, if notified it is false. eventData
+   *   is the value passed to `client.notify`.
+   */
   async waitForEvent(stepName, eventId, timeout) {
     const result = await this.addStep(
       new LazyWaitForEventStep(
@@ -1522,7 +1577,27 @@ var WorkflowContext = class {
         typeof timeout === "string" ? timeout : `${timeout}s`
       )
     );
-    return result;
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
+  }
+  async notify(stepName, eventId, eventData) {
+    const result = await this.addStep(
+      new LazyNotifyStep(stepName, eventId, eventData, this.qstashClient.http)
+    );
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
   }
   /**
    * Adds steps to the executor. Needed so that it can be overwritten in
@@ -1623,7 +1698,7 @@ var parsePayload = (rawPayload) => {
     const step = JSON.parse(decodeBase64(rawStep.body));
     if (step.waitEventId) {
       const newOut = {
-        notifyBody: step.out,
+        eventData: step.out,
         timeout: step.waitTimeout ?? false
       };
       step.out = newOut;

package/hono.mjs

@@ -1,6 +1,6 @@
 import {
   serve
-} from "./chunk-JDMP6KKR.mjs";
+} from "./chunk-BPN5JBNG.mjs";
 
 // platforms/hono.ts
 var serve2 = (routeFunction, options) => {

package/index.d.mts

@@ -1,5 +1,5 @@
-import { R as RouteFunction, W as WorkflowServeOptions, N as NotifyResponse, S as Step } from './types-CfN1Epuj.mjs';
-export { A as AsyncStepFunction, i as FailureFunctionPayload, F as FinishCondition, L as LogLevel, P as ParallelCallState, f as RawStep, j as RequiredExceptFields, h as StepFunction, e as StepType, d as StepTypes, g as SyncStepFunction, m as WaitRequest, k as WaitResult, n as WaitStepResponse, l as Waiter, b as WorkflowClient, a as WorkflowContext, p as WorkflowLogger, o as WorkflowLoggerOptions, c as WorkflowReceiver } from './types-CfN1Epuj.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions, N as NotifyResponse, a as Waiter, S as Step } from './types-CoXaNrxX.mjs';
+export { A as AsyncStepFunction, j as FailureFunctionPayload, F as FinishCondition, L as LogLevel, n as NotifyStepResponse, P as ParallelCallState, g as RawStep, k as RequiredExceptFields, i as StepFunction, f as StepType, e as StepTypes, h as SyncStepFunction, l as WaitRequest, m as WaitStepResponse, c as WorkflowClient, b as WorkflowContext, p as WorkflowLogger, o as WorkflowLoggerOptions, d as WorkflowReceiver } from './types-CoXaNrxX.mjs';
 import { Client as Client$1, QstashError } from '@upstash/qstash';
 
 /**
@@ -31,12 +31,20 @@ declare class Client {
      * Notify a workflow run waiting for an event
      *
      * @param eventId event id to notify
-     * @param notifyData data to provide to the workflow
+     * @param eventData data to provide to the workflow
      */
-    notify({ eventId, notifyBody, }: {
+    notify({ eventId, eventData, }: {
         eventId: string;
-        notifyBody?: string;
+        eventData?: unknown;
     }): Promise<NotifyResponse[]>;
+    /**
+     * Check waiters of an event
+     *
+     * @param eventId event id to check
+     */
+    getWaiters({ eventId }: {
+        eventId: string;
+    }): Promise<Waiter[]>;
 }
 
 /**
@@ -54,4 +62,4 @@ declare class QStashWorkflowAbort extends Error {
     constructor(stepName: string, stepInfo?: Step);
 }
 
-export { Client, NotifyResponse, QStashWorkflowAbort, QStashWorkflowError, RouteFunction, Step, WorkflowServeOptions, serve };
+export { Client, NotifyResponse, QStashWorkflowAbort, QStashWorkflowError, RouteFunction, Step, Waiter, WorkflowServeOptions, serve };

package/index.d.ts

@@ -1,5 +1,5 @@
-import { R as RouteFunction, W as WorkflowServeOptions, N as NotifyResponse, S as Step } from './types-CfN1Epuj.js';
-export { A as AsyncStepFunction, i as FailureFunctionPayload, F as FinishCondition, L as LogLevel, P as ParallelCallState, f as RawStep, j as RequiredExceptFields, h as StepFunction, e as StepType, d as StepTypes, g as SyncStepFunction, m as WaitRequest, k as WaitResult, n as WaitStepResponse, l as Waiter, b as WorkflowClient, a as WorkflowContext, p as WorkflowLogger, o as WorkflowLoggerOptions, c as WorkflowReceiver } from './types-CfN1Epuj.js';
+import { R as RouteFunction, W as WorkflowServeOptions, N as NotifyResponse, a as Waiter, S as Step } from './types-CoXaNrxX.js';
+export { A as AsyncStepFunction, j as FailureFunctionPayload, F as FinishCondition, L as LogLevel, n as NotifyStepResponse, P as ParallelCallState, g as RawStep, k as RequiredExceptFields, i as StepFunction, f as StepType, e as StepTypes, h as SyncStepFunction, l as WaitRequest, m as WaitStepResponse, c as WorkflowClient, b as WorkflowContext, p as WorkflowLogger, o as WorkflowLoggerOptions, d as WorkflowReceiver } from './types-CoXaNrxX.js';
 import { Client as Client$1, QstashError } from '@upstash/qstash';
 
 /**
@@ -31,12 +31,20 @@ declare class Client {
      * Notify a workflow run waiting for an event
      *
      * @param eventId event id to notify
-     * @param notifyData data to provide to the workflow
+     * @param eventData data to provide to the workflow
      */
-    notify({ eventId, notifyBody, }: {
+    notify({ eventId, eventData, }: {
         eventId: string;
-        notifyBody?: string;
+        eventData?: unknown;
     }): Promise<NotifyResponse[]>;
+    /**
+     * Check waiters of an event
+     *
+     * @param eventId event id to check
+     */
+    getWaiters({ eventId }: {
+        eventId: string;
+    }): Promise<Waiter[]>;
 }
 
 /**
@@ -54,4 +62,4 @@ declare class QStashWorkflowAbort extends Error {
     constructor(stepName: string, stepInfo?: Step);
 }
 
-export { Client, NotifyResponse, QStashWorkflowAbort, QStashWorkflowError, RouteFunction, Step, WorkflowServeOptions, serve };
+export { Client, NotifyResponse, QStashWorkflowAbort, QStashWorkflowError, RouteFunction, Step, Waiter, WorkflowServeOptions, serve };