@upstash/workflow 0.1.0 → 0.1.1-canary-2

package/{types-CfN1Epuj.d.mts → types-CoXaNrxX.d.mts}

@@ -375,7 +375,40 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * @returns call result (parsed as JSON if possible)
      */
     call<TResult = unknown, TBody = unknown>(stepName: string, url: string, method: HTTPMethods, body?: TBody, headers?: Record<string, string>): Promise<TResult>;
+    /**
+     * 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`.
+     */
     waitForEvent(stepName: string, eventId: string, timeout: string | number): Promise<WaitStepResponse>;
+    notify(stepName: string, eventId: string, eventData: unknown): Promise<NotifyStepResponse>;
     /**
      * Adds steps to the executor. Needed so that it can be overwritten in
      * DisabledWorkflowContext.
@@ -428,7 +461,7 @@ type WaitFields = {
 };
 type NotifyFields = {
     notifyEventId?: string;
-    notifyBody?: string;
+    eventData?: string;
 };
 type Step<TResult = unknown, TBody = unknown> = {
     /**
@@ -582,10 +615,6 @@ type FailureFunctionPayload = {
  * Makes all fields except the ones selected required
  */
 type RequiredExceptFields<T, K extends keyof T> = Omit<Required<T>, K> & Partial<Pick<T, K>>;
-type WaitResult<TResult = unknown> = {
-    result: TResult;
-    timeout: boolean;
-};
 type Waiter = {
     url: string;
     deadline: number;
@@ -597,7 +626,6 @@ type Waiter = {
 type NotifyResponse = {
     waiter: Waiter;
     messageId: string;
-    deduplicated: boolean;
     error: string;
 };
 type WaitRequest = {
@@ -609,8 +637,29 @@ type WaitRequest = {
     step: Step;
 };
 type WaitStepResponse = {
+    /**
+     * whether the wait for event step timed out. false if
+     * the step is notified
+     */
     timeout: boolean;
-    notifyBody: unknown;
+    /**
+     * body passed in notify request
+     */
+    eventData: unknown;
+};
+type NotifyStepResponse = {
+    /**
+     * notified event id
+     */
+    eventId: string;
+    /**
+     * event data sent with notify
+     */
+    eventData: unknown;
+    /**
+     * response from notify
+     */
+    notifyResponse: NotifyResponse[];
 };
 
-export { type AsyncStepFunction as A, type FinishCondition as F, type LogLevel as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type Step as S, type WorkflowServeOptions as W, WorkflowContext as a, type WorkflowClient as b, type WorkflowReceiver as c, StepTypes as d, type StepType as e, type RawStep as f, type SyncStepFunction as g, type StepFunction as h, type FailureFunctionPayload as i, type RequiredExceptFields as j, type WaitResult as k, type Waiter as l, type WaitRequest as m, type WaitStepResponse as n, type WorkflowLoggerOptions as o, WorkflowLogger as p };
+export { type AsyncStepFunction as A, type FinishCondition as F, type LogLevel as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type Step as S, type WorkflowServeOptions as W, type Waiter as a, WorkflowContext as b, type WorkflowClient as c, type WorkflowReceiver as d, StepTypes as e, type StepType as f, type RawStep as g, type SyncStepFunction as h, type StepFunction as i, type FailureFunctionPayload as j, type RequiredExceptFields as k, type WaitRequest as l, type WaitStepResponse as m, type NotifyStepResponse as n, type WorkflowLoggerOptions as o, WorkflowLogger as p };

package/{types-CfN1Epuj.d.ts → types-CoXaNrxX.d.ts}

@@ -375,7 +375,40 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * @returns call result (parsed as JSON if possible)
      */
     call<TResult = unknown, TBody = unknown>(stepName: string, url: string, method: HTTPMethods, body?: TBody, headers?: Record<string, string>): Promise<TResult>;
+    /**
+     * 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`.
+     */
     waitForEvent(stepName: string, eventId: string, timeout: string | number): Promise<WaitStepResponse>;
+    notify(stepName: string, eventId: string, eventData: unknown): Promise<NotifyStepResponse>;
     /**
      * Adds steps to the executor. Needed so that it can be overwritten in
      * DisabledWorkflowContext.
@@ -428,7 +461,7 @@ type WaitFields = {
 };
 type NotifyFields = {
     notifyEventId?: string;
-    notifyBody?: string;
+    eventData?: string;
 };
 type Step<TResult = unknown, TBody = unknown> = {
     /**
@@ -582,10 +615,6 @@ type FailureFunctionPayload = {
  * Makes all fields except the ones selected required
  */
 type RequiredExceptFields<T, K extends keyof T> = Omit<Required<T>, K> & Partial<Pick<T, K>>;
-type WaitResult<TResult = unknown> = {
-    result: TResult;
-    timeout: boolean;
-};
 type Waiter = {
     url: string;
     deadline: number;
@@ -597,7 +626,6 @@ type Waiter = {
 type NotifyResponse = {
     waiter: Waiter;
     messageId: string;
-    deduplicated: boolean;
     error: string;
 };
 type WaitRequest = {
@@ -609,8 +637,29 @@ type WaitRequest = {
     step: Step;
 };
 type WaitStepResponse = {
+    /**
+     * whether the wait for event step timed out. false if
+     * the step is notified
+     */
     timeout: boolean;
-    notifyBody: unknown;
+    /**
+     * body passed in notify request
+     */
+    eventData: unknown;
+};
+type NotifyStepResponse = {
+    /**
+     * notified event id
+     */
+    eventId: string;
+    /**
+     * event data sent with notify
+     */
+    eventData: unknown;
+    /**
+     * response from notify
+     */
+    notifyResponse: NotifyResponse[];
 };
 
-export { type AsyncStepFunction as A, type FinishCondition as F, type LogLevel as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type Step as S, type WorkflowServeOptions as W, WorkflowContext as a, type WorkflowClient as b, type WorkflowReceiver as c, StepTypes as d, type StepType as e, type RawStep as f, type SyncStepFunction as g, type StepFunction as h, type FailureFunctionPayload as i, type RequiredExceptFields as j, type WaitResult as k, type Waiter as l, type WaitRequest as m, type WaitStepResponse as n, type WorkflowLoggerOptions as o, WorkflowLogger as p };
+export { type AsyncStepFunction as A, type FinishCondition as F, type LogLevel as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type Step as S, type WorkflowServeOptions as W, type Waiter as a, WorkflowContext as b, type WorkflowClient as c, type WorkflowReceiver as d, StepTypes as e, type StepType as f, type RawStep as g, type SyncStepFunction as h, type StepFunction as i, type FailureFunctionPayload as j, type RequiredExceptFields as k, type WaitRequest as l, type WaitStepResponse as m, type NotifyStepResponse as n, type WorkflowLoggerOptions as o, WorkflowLogger as p };