@upstash/workflow 1.3.3 → 1.4.0-rc

package/hono.mjs

@@ -2,14 +2,16 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-WEQGCISK.mjs";
+} from "./chunk-UH6O5IJY.mjs";
 
 // platforms/hono.ts
+import { startDevServer } from "@upstash/qstash";
 var telemetry = {
   sdk: SDK_TELEMETRY,
   framework: "hono"
 };
 var serve = (routeFunction, options) => {
+  void startDevServer();
   const handler = async (context) => {
     const environment = context.env ? context.env : typeof process === "undefined" ? {} : process.env;
     const request = context.req.raw;

package/index.d.mts

@@ -1,7 +1,8 @@
-import { S as StepType, R as RawStep, W as WorkflowMiddleware, a as WorkflowClient, b as WorkflowReceiver, c as RouteFunction, d as WorkflowServeOptions, T as Telemetry, N as NotifyResponse, e as Waiter } from './types-CekOpKvz.mjs';
-export { A as AsyncStepFunction, C as CallResponse, f as CallSettings, D as DetailedFinishCondition, g as Duration, E as ExclusiveValidationOptions, F as FailureFunctionPayload, h as FinishCondition, H as HeaderParams, I as InvokableWorkflow, i as InvokeStepResponse, j as InvokeWorkflowRequest, L as LazyInvokeStepParams, k as NotifyStepResponse, P as ParallelCallState, Q as QStashClientExtraConfig, l as RequiredExceptFields, m as Step, n as StepFunction, o as StepTypes, p as SyncStepFunction, q as WaitEventOptions, r as WaitRequest, s as WaitStepResponse, t as WorkflowAbort, u as WorkflowContext, v as WorkflowError, w as WorkflowNonRetryableError, x as WorkflowRetryAfterError } from './types-CekOpKvz.mjs';
+import { S as StepType, R as RawStep, W as WorkflowMiddleware, a as WorkflowClient, b as WorkflowReceiver, c as RouteFunction, d as WorkflowServeOptions, T as Telemetry, N as NotifyResponse, e as Waiter } from './types-ffLPVG5_.mjs';
+export { A as AsyncStepFunction, C as CallResponse, f as CallSettings, D as DetailedFinishCondition, g as Duration, E as ExclusiveValidationOptions, F as FailureFunctionPayload, h as FinishCondition, H as HeaderParams, I as InvokableWorkflow, i as InvokeStepResponse, j as InvokeWorkflowRequest, L as LazyInvokeStepParams, k as NotifyStepResponse, P as ParallelCallState, Q as QStashClientExtraConfig, l as RequiredExceptFields, m as Step, n as StepFunction, o as StepSettings, p as StepTypes, q as SyncStepFunction, r as WaitEventOptions, s as WaitRequest, t as WaitStepResponse, u as WorkflowAbort, v as WorkflowContext, w as WorkflowError, x as WorkflowNonRetryableError, y as WorkflowRetryAfterError } from './types-ffLPVG5_.mjs';
 import { FlowControl, PublishRequest, HTTPMethods, Client as Client$1 } from '@upstash/qstash';
 import 'zod';
+import 'neverthrow';
 
 type BaseStepLog = {
     /**
@@ -209,6 +210,11 @@ type StepLogGroup = {
      */
     type: "next";
 };
+/**
+ * State of the failure function (`failureUrl`/`failureFunction`) call of a
+ * failed workflow run.
+ */
+type FailureFunctionState = "CALLBACK_INPROGRESS" | "CALLBACK_SUCCESS" | "CALLBACK_FAIL" | "CALLBACK_CANCELED";
 type FailureFunctionLog = {
     /**
      * messageId of the message published for handling the failure
@@ -221,7 +227,7 @@ type FailureFunctionLog = {
     /**
      * State of the message published for failure
      */
-    state: "CALLBACK_INPROGRESS" | "CALLBACK_SUCCESS" | "CALLBACK_FAIL" | "CALLBACK_CANCELED";
+    state: FailureFunctionState;
     /**
      * Headers received from the step which caused the workflow to fail
      */
@@ -570,7 +576,11 @@ type WorkflowFilterFields = {
     workflowUrl?: string | string[];
     workflowRunId?: string;
     workflowCreatedAt?: number;
-    failureFunctionState?: string;
+    /**
+     * Filter by the state of the failure function call. Supports multiple values:
+     * pass an array to match runs in any of the given states (OR semantics).
+     */
+    failureFunctionState?: FailureFunctionState | FailureFunctionState[];
 };
 type WorkflowLogsFilterFields = {
     state?: WorkflowRunLog["workflowState"];
@@ -680,7 +690,7 @@ type ResumeRestartOptions = {
     retries?: number;
 };
 type FailureCallbackInfo = {
-    state?: "CALLBACK_FAIL" | "CALLBACK_SUCCESS" | "CALLBACK_INPROGRESS" | "CALLBACK_CANCELED";
+    state?: FailureFunctionState;
     responseStatus?: number;
     responseBody?: string;
     responseHeaders?: Record<string, string[]>;
@@ -834,6 +844,15 @@ declare class DLQ {
     retryFailureFunction({ dlqId }: Pick<DLQResumeRestartOptions<string>, "dlqId">): Promise<DLQResumeRestartResponse & {
         error?: string;
     }>;
+    /**
+     * Cancel the in-progress failure function (failureUrl/failureFunction) call
+     * of a workflow run.
+     *
+     * Fails if the run has no failure function call in progress.
+     *
+     * @param dlqId - The ID of the DLQ message whose failure function call will be canceled
+     */
+    cancelFailureFunction({ dlqId }: Pick<DLQResumeRestartOptions<string>, "dlqId">): Promise<void>;
     /**
      * Delete DLQ messages.
      *
@@ -1071,4 +1090,4 @@ declare class Client {
     get dlq(): DLQ;
 }
 
-export { Client, type DLQResumeRestartOptions, type DLQResumeRestartResponse, NotifyResponse, RawStep, RouteFunction, type StepError, type StepLog, StepType, Telemetry, type TriggerOptions, Waiter, WorkflowClient, WorkflowMiddleware, WorkflowReceiver, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, loggingMiddleware, serve };
+export { Client, type DLQResumeRestartOptions, type DLQResumeRestartResponse, type FailureFunctionState, NotifyResponse, RawStep, RouteFunction, type StepError, type StepLog, StepType, Telemetry, type TriggerOptions, Waiter, WorkflowClient, WorkflowMiddleware, WorkflowReceiver, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, loggingMiddleware, serve };

package/index.d.ts

@@ -1,7 +1,8 @@
-import { S as StepType, R as RawStep, W as WorkflowMiddleware, a as WorkflowClient, b as WorkflowReceiver, c as RouteFunction, d as WorkflowServeOptions, T as Telemetry, N as NotifyResponse, e as Waiter } from './types-CekOpKvz.js';
-export { A as AsyncStepFunction, C as CallResponse, f as CallSettings, D as DetailedFinishCondition, g as Duration, E as ExclusiveValidationOptions, F as FailureFunctionPayload, h as FinishCondition, H as HeaderParams, I as InvokableWorkflow, i as InvokeStepResponse, j as InvokeWorkflowRequest, L as LazyInvokeStepParams, k as NotifyStepResponse, P as ParallelCallState, Q as QStashClientExtraConfig, l as RequiredExceptFields, m as Step, n as StepFunction, o as StepTypes, p as SyncStepFunction, q as WaitEventOptions, r as WaitRequest, s as WaitStepResponse, t as WorkflowAbort, u as WorkflowContext, v as WorkflowError, w as WorkflowNonRetryableError, x as WorkflowRetryAfterError } from './types-CekOpKvz.js';
+import { S as StepType, R as RawStep, W as WorkflowMiddleware, a as WorkflowClient, b as WorkflowReceiver, c as RouteFunction, d as WorkflowServeOptions, T as Telemetry, N as NotifyResponse, e as Waiter } from './types-ffLPVG5_.js';
+export { A as AsyncStepFunction, C as CallResponse, f as CallSettings, D as DetailedFinishCondition, g as Duration, E as ExclusiveValidationOptions, F as FailureFunctionPayload, h as FinishCondition, H as HeaderParams, I as InvokableWorkflow, i as InvokeStepResponse, j as InvokeWorkflowRequest, L as LazyInvokeStepParams, k as NotifyStepResponse, P as ParallelCallState, Q as QStashClientExtraConfig, l as RequiredExceptFields, m as Step, n as StepFunction, o as StepSettings, p as StepTypes, q as SyncStepFunction, r as WaitEventOptions, s as WaitRequest, t as WaitStepResponse, u as WorkflowAbort, v as WorkflowContext, w as WorkflowError, x as WorkflowNonRetryableError, y as WorkflowRetryAfterError } from './types-ffLPVG5_.js';
 import { FlowControl, PublishRequest, HTTPMethods, Client as Client$1 } from '@upstash/qstash';
 import 'zod';
+import 'neverthrow';
 
 type BaseStepLog = {
     /**
@@ -209,6 +210,11 @@ type StepLogGroup = {
      */
     type: "next";
 };
+/**
+ * State of the failure function (`failureUrl`/`failureFunction`) call of a
+ * failed workflow run.
+ */
+type FailureFunctionState = "CALLBACK_INPROGRESS" | "CALLBACK_SUCCESS" | "CALLBACK_FAIL" | "CALLBACK_CANCELED";
 type FailureFunctionLog = {
     /**
      * messageId of the message published for handling the failure
@@ -221,7 +227,7 @@ type FailureFunctionLog = {
     /**
      * State of the message published for failure
      */
-    state: "CALLBACK_INPROGRESS" | "CALLBACK_SUCCESS" | "CALLBACK_FAIL" | "CALLBACK_CANCELED";
+    state: FailureFunctionState;
     /**
      * Headers received from the step which caused the workflow to fail
      */
@@ -570,7 +576,11 @@ type WorkflowFilterFields = {
     workflowUrl?: string | string[];
     workflowRunId?: string;
     workflowCreatedAt?: number;
-    failureFunctionState?: string;
+    /**
+     * Filter by the state of the failure function call. Supports multiple values:
+     * pass an array to match runs in any of the given states (OR semantics).
+     */
+    failureFunctionState?: FailureFunctionState | FailureFunctionState[];
 };
 type WorkflowLogsFilterFields = {
     state?: WorkflowRunLog["workflowState"];
@@ -680,7 +690,7 @@ type ResumeRestartOptions = {
     retries?: number;
 };
 type FailureCallbackInfo = {
-    state?: "CALLBACK_FAIL" | "CALLBACK_SUCCESS" | "CALLBACK_INPROGRESS" | "CALLBACK_CANCELED";
+    state?: FailureFunctionState;
     responseStatus?: number;
     responseBody?: string;
     responseHeaders?: Record<string, string[]>;
@@ -834,6 +844,15 @@ declare class DLQ {
     retryFailureFunction({ dlqId }: Pick<DLQResumeRestartOptions<string>, "dlqId">): Promise<DLQResumeRestartResponse & {
         error?: string;
     }>;
+    /**
+     * Cancel the in-progress failure function (failureUrl/failureFunction) call
+     * of a workflow run.
+     *
+     * Fails if the run has no failure function call in progress.
+     *
+     * @param dlqId - The ID of the DLQ message whose failure function call will be canceled
+     */
+    cancelFailureFunction({ dlqId }: Pick<DLQResumeRestartOptions<string>, "dlqId">): Promise<void>;
     /**
      * Delete DLQ messages.
      *
@@ -1071,4 +1090,4 @@ declare class Client {
     get dlq(): DLQ;
 }
 
-export { Client, type DLQResumeRestartOptions, type DLQResumeRestartResponse, NotifyResponse, RawStep, RouteFunction, type StepError, type StepLog, StepType, Telemetry, type TriggerOptions, Waiter, WorkflowClient, WorkflowMiddleware, WorkflowReceiver, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, loggingMiddleware, serve };
+export { Client, type DLQResumeRestartOptions, type DLQResumeRestartResponse, type FailureFunctionState, NotifyResponse, RawStep, RouteFunction, type StepError, type StepLog, StepType, Telemetry, type TriggerOptions, Waiter, WorkflowClient, WorkflowMiddleware, WorkflowReceiver, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, loggingMiddleware, serve };