@upstash/workflow 0.2.22-rc → 0.2.23-rc

package/tanstack.mjs

@@ -2,7 +2,7 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-CAQSUCHB.mjs";
+} from "./chunk-KAGTWBLF.mjs";
 
 // platforms/tanstack.ts
 var telemetry = {

package/{types-Q3dM0UlR.d.ts → types-BD06btU6.d.mts}

@@ -38,6 +38,14 @@ declare class WorkflowNonRetryableError extends WorkflowAbort {
      */
     constructor(message?: string);
 }
+declare class WorkflowRetryAfterError extends WorkflowAbort {
+    retryAfter: number | Duration;
+    /**
+     * @param retryAfter time in seconds after which the workflow should be retried
+     * @param message error message to be displayed
+     */
+    constructor(message: string, retryAfter: number | Duration);
+}
 
 declare const LOG_LEVELS: readonly ["DEBUG", "INFO", "SUBMIT", "WARN", "ERROR"];
 type LogLevel = (typeof LOG_LEVELS)[number];
@@ -89,7 +97,8 @@ declare abstract class BaseLazyStep<TResult = unknown> {
     readonly stepName: string;
     abstract readonly stepType: StepType;
     protected abstract readonly allowUndefinedOut: boolean;
-    constructor(stepName: string);
+    protected readonly context: WorkflowContext;
+    constructor(context: WorkflowContext, stepName: string);
     /**
      * plan step to submit when step will run parallel with other
      * steps (parallel call state `first`)
@@ -112,11 +121,12 @@ declare abstract class BaseLazyStep<TResult = unknown> {
      *
      * will be called when returning the steps to the context from auto executor
      *
-     * @param out field of the step
+     * @param step step
      * @returns parsed out field
      */
-    parseOut(out: unknown): TResult;
-    protected safeParseOut(out: string): TResult;
+    parseOut(step: Step): TResult;
+    protected safeParseOut(out: string, step: Step): TResult;
+    protected handleUndefinedOut(step: Step): TResult;
     protected static tryParsing(stepOut: unknown): any;
     getBody({ step }: GetBodyParams): string;
     getHeaders({ context, telemetry, invokeCount, step }: GetHeaderParams): HeadersResponse;
@@ -124,6 +134,17 @@ declare abstract class BaseLazyStep<TResult = unknown> {
         messageId: string;
     }[]>;
 }
+type Webhook = {
+    webhookUrl: string;
+    eventId: string;
+};
+type WaitForWebhookResponse = {
+    timeout: false;
+    request: Request;
+} | {
+    timeout: true;
+    request: undefined;
+};
 
 declare class AutoExecutor {
     private context;
@@ -1096,6 +1117,8 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      */
     notify(stepName: string, eventId: string, eventData: unknown): Promise<NotifyStepResponse>;
     invoke<TInitialPayload, TResult>(stepName: string, settings: LazyInvokeStepParams<TInitialPayload, TResult>): Promise<InvokeStepResponse<TResult>>;
+    createWebhook(stepName: string): Promise<Webhook>;
+    waitForWebhook(stepName: string, webhook: Webhook, timeout: Duration): Promise<WaitForWebhookResponse>;
     /**
      * Cancel the current workflow run
      *
@@ -1132,7 +1155,7 @@ type WorkflowClient = {
 type WorkflowReceiver = {
     verify: InstanceType<typeof Receiver>["verify"];
 };
-declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify", "Invoke"];
+declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify", "Invoke", "CreateWebhook", "WaitForWebhook"];
 type StepType = (typeof StepTypes)[number];
 type ThirdPartyCallFields<TBody = unknown> = {
     /**
@@ -1223,6 +1246,9 @@ type DetailedFinishCondition = {
 } | {
     condition: "non-retryable-error";
     result: WorkflowNonRetryableError;
+} | {
+    condition: "retry-after-error";
+    result: WorkflowRetryAfterError;
 } | {
     condition: "failure-callback";
     result: string | void;
@@ -1628,4 +1654,4 @@ type InvokableWorkflow<TInitialPayload, TResult> = {
     workflowId?: string;
 };
 
-export { type AsyncStepFunction as A, type WorkflowLoggerOptions as B, type CallResponse as C, type DetailedFinishCondition as D, type ExclusiveValidationOptions as E, type FinishCondition as F, WorkflowLogger as G, type HeaderParams as H, type InvokeWorkflowRequest as I, type LazyInvokeStepParams as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, WorkflowError as c, WorkflowAbort as d, WorkflowNonRetryableError as e, WorkflowTool as f, WorkflowContext as g, type WorkflowClient as h, type WorkflowReceiver as i, StepTypes as j, type Step as k, type SyncStepFunction as l, type StepFunction as m, type PublicServeOptions as n, type FailureFunctionPayload as o, type RequiredExceptFields as p, type WaitRequest as q, type WaitStepResponse as r, type NotifyStepResponse as s, type Duration as t, type WaitEventOptions as u, type StringifyBody as v, type CallSettings as w, type InvokeStepResponse as x, type InvokableWorkflow as y, type LogLevel as z };
+export { type AsyncStepFunction as A, type LogLevel as B, type CallResponse as C, type DetailedFinishCondition as D, type ExclusiveValidationOptions as E, type FinishCondition as F, type WorkflowLoggerOptions as G, type HeaderParams as H, type InvokeWorkflowRequest as I, WorkflowLogger as J, type LazyInvokeStepParams as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, WorkflowError as c, WorkflowAbort as d, WorkflowNonRetryableError as e, WorkflowRetryAfterError as f, WorkflowTool as g, WorkflowContext as h, type WorkflowClient as i, type WorkflowReceiver as j, StepTypes as k, type Step as l, type SyncStepFunction as m, type StepFunction as n, type PublicServeOptions as o, type FailureFunctionPayload as p, type RequiredExceptFields as q, type WaitRequest as r, type WaitStepResponse as s, type NotifyStepResponse as t, type Duration as u, type WaitEventOptions as v, type StringifyBody as w, type CallSettings as x, type InvokeStepResponse as y, type InvokableWorkflow as z };

package/{types-Q3dM0UlR.d.mts → types-BD06btU6.d.ts}

@@ -38,6 +38,14 @@ declare class WorkflowNonRetryableError extends WorkflowAbort {
      */
     constructor(message?: string);
 }
+declare class WorkflowRetryAfterError extends WorkflowAbort {
+    retryAfter: number | Duration;
+    /**
+     * @param retryAfter time in seconds after which the workflow should be retried
+     * @param message error message to be displayed
+     */
+    constructor(message: string, retryAfter: number | Duration);
+}
 
 declare const LOG_LEVELS: readonly ["DEBUG", "INFO", "SUBMIT", "WARN", "ERROR"];
 type LogLevel = (typeof LOG_LEVELS)[number];
@@ -89,7 +97,8 @@ declare abstract class BaseLazyStep<TResult = unknown> {
     readonly stepName: string;
     abstract readonly stepType: StepType;
     protected abstract readonly allowUndefinedOut: boolean;
-    constructor(stepName: string);
+    protected readonly context: WorkflowContext;
+    constructor(context: WorkflowContext, stepName: string);
     /**
      * plan step to submit when step will run parallel with other
      * steps (parallel call state `first`)
@@ -112,11 +121,12 @@ declare abstract class BaseLazyStep<TResult = unknown> {
      *
      * will be called when returning the steps to the context from auto executor
      *
-     * @param out field of the step
+     * @param step step
      * @returns parsed out field
      */
-    parseOut(out: unknown): TResult;
-    protected safeParseOut(out: string): TResult;
+    parseOut(step: Step): TResult;
+    protected safeParseOut(out: string, step: Step): TResult;
+    protected handleUndefinedOut(step: Step): TResult;
     protected static tryParsing(stepOut: unknown): any;
     getBody({ step }: GetBodyParams): string;
     getHeaders({ context, telemetry, invokeCount, step }: GetHeaderParams): HeadersResponse;
@@ -124,6 +134,17 @@ declare abstract class BaseLazyStep<TResult = unknown> {
         messageId: string;
     }[]>;
 }
+type Webhook = {
+    webhookUrl: string;
+    eventId: string;
+};
+type WaitForWebhookResponse = {
+    timeout: false;
+    request: Request;
+} | {
+    timeout: true;
+    request: undefined;
+};
 
 declare class AutoExecutor {
     private context;
@@ -1096,6 +1117,8 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      */
     notify(stepName: string, eventId: string, eventData: unknown): Promise<NotifyStepResponse>;
     invoke<TInitialPayload, TResult>(stepName: string, settings: LazyInvokeStepParams<TInitialPayload, TResult>): Promise<InvokeStepResponse<TResult>>;
+    createWebhook(stepName: string): Promise<Webhook>;
+    waitForWebhook(stepName: string, webhook: Webhook, timeout: Duration): Promise<WaitForWebhookResponse>;
     /**
      * Cancel the current workflow run
      *
@@ -1132,7 +1155,7 @@ type WorkflowClient = {
 type WorkflowReceiver = {
     verify: InstanceType<typeof Receiver>["verify"];
 };
-declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify", "Invoke"];
+declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify", "Invoke", "CreateWebhook", "WaitForWebhook"];
 type StepType = (typeof StepTypes)[number];
 type ThirdPartyCallFields<TBody = unknown> = {
     /**
@@ -1223,6 +1246,9 @@ type DetailedFinishCondition = {
 } | {
     condition: "non-retryable-error";
     result: WorkflowNonRetryableError;
+} | {
+    condition: "retry-after-error";
+    result: WorkflowRetryAfterError;
 } | {
     condition: "failure-callback";
     result: string | void;
@@ -1628,4 +1654,4 @@ type InvokableWorkflow<TInitialPayload, TResult> = {
     workflowId?: string;
 };
 
-export { type AsyncStepFunction as A, type WorkflowLoggerOptions as B, type CallResponse as C, type DetailedFinishCondition as D, type ExclusiveValidationOptions as E, type FinishCondition as F, WorkflowLogger as G, type HeaderParams as H, type InvokeWorkflowRequest as I, type LazyInvokeStepParams as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, WorkflowError as c, WorkflowAbort as d, WorkflowNonRetryableError as e, WorkflowTool as f, WorkflowContext as g, type WorkflowClient as h, type WorkflowReceiver as i, StepTypes as j, type Step as k, type SyncStepFunction as l, type StepFunction as m, type PublicServeOptions as n, type FailureFunctionPayload as o, type RequiredExceptFields as p, type WaitRequest as q, type WaitStepResponse as r, type NotifyStepResponse as s, type Duration as t, type WaitEventOptions as u, type StringifyBody as v, type CallSettings as w, type InvokeStepResponse as x, type InvokableWorkflow as y, type LogLevel as z };
+export { type AsyncStepFunction as A, type LogLevel as B, type CallResponse as C, type DetailedFinishCondition as D, type ExclusiveValidationOptions as E, type FinishCondition as F, type WorkflowLoggerOptions as G, type HeaderParams as H, type InvokeWorkflowRequest as I, WorkflowLogger as J, type LazyInvokeStepParams as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, WorkflowError as c, WorkflowAbort as d, WorkflowNonRetryableError as e, WorkflowRetryAfterError as f, WorkflowTool as g, WorkflowContext as h, type WorkflowClient as i, type WorkflowReceiver as j, StepTypes as k, type Step as l, type SyncStepFunction as m, type StepFunction as n, type PublicServeOptions as o, type FailureFunctionPayload as p, type RequiredExceptFields as q, type WaitRequest as r, type WaitStepResponse as s, type NotifyStepResponse as t, type Duration as u, type WaitEventOptions as v, type StringifyBody as w, type CallSettings as x, type InvokeStepResponse as y, type InvokableWorkflow as z };