@upstash/workflow 0.2.7 → 0.2.8-rc-invoke

package/{types-Cuqlx2Cr.d.ts → types-C7Y7WUQd.d.ts}

@@ -33,6 +33,11 @@ declare abstract class BaseLazyStep<TResult = unknown> {
      */
     abstract getResultStep(concurrent: number, stepId: number): Promise<Step<TResult>>;
 }
+type LazyInvokeStepParams<TInitiaPayload, TResult> = {
+    workflow: Pick<InvokableWorkflow<TInitiaPayload, TResult, unknown[]>, "callback" | "workflowId">;
+    body: TInitiaPayload;
+    workflowRunId?: string;
+} & Pick<CallSettings, "retries" | "headers">;
 
 declare const LOG_LEVELS: readonly ["DEBUG", "INFO", "SUBMIT", "WARN", "ERROR"];
 type LogLevel = (typeof LOG_LEVELS)[number];
@@ -917,6 +922,11 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * @returns notify response which has event id, event data and list of waiters which were notified
      */
     notify(stepName: string, eventId: string, eventData: unknown): Promise<NotifyStepResponse>;
+    invoke<TInitialPayload, TResult>(stepName: string, settings: LazyInvokeStepParams<TInitialPayload, TResult>): Promise<{
+        body: any;
+        isCanceled?: boolean;
+        isFailed?: boolean;
+    }>;
     /**
      * Cancel the current workflow run
      *
@@ -952,7 +962,7 @@ type WorkflowClient = {
 type WorkflowReceiver = {
     verify: InstanceType<typeof Receiver>["verify"];
 };
-declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify"];
+declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify", "Invoke"];
 type StepType = (typeof StepTypes)[number];
 type ThirdPartyCallFields<TBody = unknown> = {
     /**
@@ -1035,7 +1045,7 @@ type SyncStepFunction<TResult> = () => TResult;
 type AsyncStepFunction<TResult> = () => Promise<TResult>;
 type StepFunction<TResult> = AsyncStepFunction<TResult> | SyncStepFunction<TResult>;
 type ParallelCallState = "first" | "partial" | "discard" | "last";
-type RouteFunction<TInitialPayload> = (context: WorkflowContext<TInitialPayload>) => Promise<void>;
+type RouteFunction<TInitialPayload, TResult = unknown> = (context: WorkflowContext<TInitialPayload>) => Promise<TResult>;
 type FinishCondition = "success" | "duplicate-step" | "fromCallback" | "auth-fail" | "failure-callback" | "workflow-already-ended";
 type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload = unknown> = ValidationOptions<TInitialPayload> & {
     /**
@@ -1312,5 +1322,23 @@ type HeaderParams = {
      */
     callTimeout?: never;
 });
+type InvokeWorkflowRequest = {
+    workflowUrl: string;
+    workflowRunId: string;
+    headers: Record<string, string[]>;
+    step: Step;
+    body: string;
+};
+type InvokeStepResponse<TBody> = {
+    body: TBody;
+    isCanceled?: boolean;
+    isFailed?: boolean;
+};
+type InvokeCallback<TInitiaPayload, TResult> = (settings: LazyInvokeStepParams<TInitiaPayload, TResult>, invokeStep: Step, context: WorkflowContext) => Promise<TResult>;
+type InvokableWorkflow<TInitialPayload, TResult, THandlerParams extends unknown[]> = {
+    handler: (...args: THandlerParams) => any;
+    callback: InvokeCallback<TInitialPayload, TResult>;
+    workflowId?: string;
+};
 
-export { type AsyncStepFunction as A, type CallResponse as C, type Duration as D, type ExclusiveValidationOptions as E, type FinishCondition as F, type HeaderParams as H, type LogLevel as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type Step as S, type Telemetry as T, 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 PublicServeOptions as j, type FailureFunctionPayload as k, type RequiredExceptFields as l, type WaitRequest as m, type WaitStepResponse as n, type NotifyStepResponse as o, type WaitEventOptions as p, type CallSettings as q, type WorkflowLoggerOptions as r, WorkflowLogger as s };
+export { type AsyncStepFunction as A, type CallResponse as C, type Duration as D, type ExclusiveValidationOptions as E, type FinishCondition as F, type HeaderParams as H, type InvokeWorkflowRequest as I, type LogLevel as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type Step as S, type Telemetry as T, 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 PublicServeOptions as j, type FailureFunctionPayload as k, type RequiredExceptFields as l, type WaitRequest as m, type WaitStepResponse as n, type NotifyStepResponse as o, type WaitEventOptions as p, type CallSettings as q, type InvokeStepResponse as r, type InvokeCallback as s, type InvokableWorkflow as t, type WorkflowLoggerOptions as u, WorkflowLogger as v };