@upstash/workflow 1.3.2 → 1.4.0-rc

package/hono.mjs

@@ -2,14 +2,16 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-ICDNN4UW.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";
+    state: FailureFunctionState;
     /**
      * Headers received from the step which caused the workflow to fail
      */
@@ -538,14 +544,21 @@ declare const serveBase: <TInitialPayload = unknown, TRequest extends Request =
  */
 declare const serve: <TInitialPayload = unknown, TRequest extends Request = Request, TResponse extends Response = Response, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: WorkflowServeOptions<TInitialPayload, TResult>) => ReturnType<typeof serveBase<TInitialPayload, TRequest, TResponse, TResult>>;
 
-type RequireAtLeastOne<T> = {
+type RequireAtLeastOne<T> = T & {
     [K in keyof T]-?: Required<Pick<T, K>>;
 }[keyof T];
-/** Shared filter fields accepted by every qstash & workflow endpoint. */
+/**
+ * Shared filter fields accepted by every qstash & workflow endpoint.
+ *
+ * Most fields support multi-value filtering: pass an array to match a record
+ * whose value equals any of the given values (OR semantics). Separate filters
+ * are combined with AND semantics.
+ */
 type UniversalFilterFields = {
     fromDate?: Date | number;
     toDate?: Date | number;
-    callerIp?: string;
+    /** Filter by the IP address of the publisher. Supports multiple values. */
+    callerIp?: string | string[];
     /**
      * Filter by label.
      *
@@ -554,32 +567,52 @@ type UniversalFilterFields = {
      * filtering by `[label_1, label_2]` returns both.
      */
     label?: string | string[];
-    flowControlKey?: string;
+    /** Filter by Flow Control Key. Supports multiple values. */
+    flowControlKey?: string | string[];
 };
 /** Workflow-specific filter fields for DLQ and bulk endpoints. */
 type WorkflowFilterFields = {
-    workflowUrl?: string;
+    /** Filter by workflow URL. Supports multiple values. */
+    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"];
     messageId?: string;
 };
+/**
+ * Filter by the host/path of the workflow URL.
+ *
+ * Supported by the cancel and logs endpoints (the DLQ endpoint rejects these).
+ * Each supports multiple values: pass an array to match any value.
+ */
+type HostPathFilterFields = {
+    /** Filter by the host of the workflow URL. Supports multiple values. */
+    host?: string | string[];
+    /** Filter by the path of the workflow URL. Supports multiple values. */
+    path?: string | string[];
+};
 type DLQActionFilterFields = UniversalFilterFields & WorkflowFilterFields;
 /** Cancel filter: exact URL match. Cannot combine with `workflowUrlStartingWith`. */
-type CancelFilterWithExactUrl = UniversalFilterFields & {
-    workflowUrl: string;
+type CancelFilterWithExactUrl = UniversalFilterFields & HostPathFilterFields & {
+    /** Filter by exact workflow URL. Supports multiple values. */
+    workflowUrl: string | string[];
     workflowUrlStartingWith?: never;
 };
 /** Cancel filter: URL prefix match. Cannot combine with `workflowUrl`. */
-type CancelFilterWithPrefixUrl = UniversalFilterFields & {
-    workflowUrlStartingWith: string;
+type CancelFilterWithPrefixUrl = UniversalFilterFields & HostPathFilterFields & {
+    /** Filter by workflow URL prefix. Supports multiple values. */
+    workflowUrlStartingWith: string | string[];
     workflowUrl?: never;
 };
 /** Cancel filter: no URL. Requires at least one other filter field. */
-type CancelFilterWithoutUrl = RequireAtLeastOne<UniversalFilterFields> & {
+type CancelFilterWithoutUrl = RequireAtLeastOne<UniversalFilterFields & HostPathFilterFields> & {
     workflowUrl?: never;
     workflowUrlStartingWith?: never;
 };
@@ -650,14 +683,14 @@ type WorkflowRunCancelFilters = {
     workflowRunIds?: never;
     filter?: never;
 } & WorkflowCancelCount);
-type WorkflowLogsListFilters = UniversalFilterFields & Pick<WorkflowFilterFields, "workflowUrl" | "workflowRunId" | "workflowCreatedAt"> & WorkflowLogsFilterFields;
+type WorkflowLogsListFilters = UniversalFilterFields & Pick<WorkflowFilterFields, "workflowUrl" | "workflowRunId" | "workflowCreatedAt"> & HostPathFilterFields & WorkflowLogsFilterFields;
 
 type ResumeRestartOptions = {
     flowControl?: FlowControl;
     retries?: number;
 };
 type FailureCallbackInfo = {
-    state?: "CALLBACK_FAIL" | "CALLBACK_SUCCESS" | "CALLBACK_INPROGRESS";
+    state?: FailureFunctionState;
     responseStatus?: number;
     responseBody?: string;
     responseHeaders?: Record<string, string[]>;
@@ -811,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.
      *
@@ -863,6 +905,11 @@ declare class Client {
      * - With other filters: `cancel({ filter: { label: "my-label" } })`
      * - To target all: `cancel({ all: true })`
      *
+     * Filters support multiple values: pass an array to match a run whose value
+     * equals any of the given values (OR logic). Separate filters are combined with
+     * AND logic. For example:
+     * `cancel({ filter: { workflowUrl: ["https://a.com", "https://b.com"] } })`
+     *
      * Cancels up to `count` workflow runs per call (defaults to 100).
      *
      * ```ts
@@ -1043,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";
+    state: FailureFunctionState;
     /**
      * Headers received from the step which caused the workflow to fail
      */
@@ -538,14 +544,21 @@ declare const serveBase: <TInitialPayload = unknown, TRequest extends Request =
  */
 declare const serve: <TInitialPayload = unknown, TRequest extends Request = Request, TResponse extends Response = Response, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: WorkflowServeOptions<TInitialPayload, TResult>) => ReturnType<typeof serveBase<TInitialPayload, TRequest, TResponse, TResult>>;
 
-type RequireAtLeastOne<T> = {
+type RequireAtLeastOne<T> = T & {
     [K in keyof T]-?: Required<Pick<T, K>>;
 }[keyof T];
-/** Shared filter fields accepted by every qstash & workflow endpoint. */
+/**
+ * Shared filter fields accepted by every qstash & workflow endpoint.
+ *
+ * Most fields support multi-value filtering: pass an array to match a record
+ * whose value equals any of the given values (OR semantics). Separate filters
+ * are combined with AND semantics.
+ */
 type UniversalFilterFields = {
     fromDate?: Date | number;
     toDate?: Date | number;
-    callerIp?: string;
+    /** Filter by the IP address of the publisher. Supports multiple values. */
+    callerIp?: string | string[];
     /**
      * Filter by label.
      *
@@ -554,32 +567,52 @@ type UniversalFilterFields = {
      * filtering by `[label_1, label_2]` returns both.
      */
     label?: string | string[];
-    flowControlKey?: string;
+    /** Filter by Flow Control Key. Supports multiple values. */
+    flowControlKey?: string | string[];
 };
 /** Workflow-specific filter fields for DLQ and bulk endpoints. */
 type WorkflowFilterFields = {
-    workflowUrl?: string;
+    /** Filter by workflow URL. Supports multiple values. */
+    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"];
     messageId?: string;
 };
+/**
+ * Filter by the host/path of the workflow URL.
+ *
+ * Supported by the cancel and logs endpoints (the DLQ endpoint rejects these).
+ * Each supports multiple values: pass an array to match any value.
+ */
+type HostPathFilterFields = {
+    /** Filter by the host of the workflow URL. Supports multiple values. */
+    host?: string | string[];
+    /** Filter by the path of the workflow URL. Supports multiple values. */
+    path?: string | string[];
+};
 type DLQActionFilterFields = UniversalFilterFields & WorkflowFilterFields;
 /** Cancel filter: exact URL match. Cannot combine with `workflowUrlStartingWith`. */
-type CancelFilterWithExactUrl = UniversalFilterFields & {
-    workflowUrl: string;
+type CancelFilterWithExactUrl = UniversalFilterFields & HostPathFilterFields & {
+    /** Filter by exact workflow URL. Supports multiple values. */
+    workflowUrl: string | string[];
     workflowUrlStartingWith?: never;
 };
 /** Cancel filter: URL prefix match. Cannot combine with `workflowUrl`. */
-type CancelFilterWithPrefixUrl = UniversalFilterFields & {
-    workflowUrlStartingWith: string;
+type CancelFilterWithPrefixUrl = UniversalFilterFields & HostPathFilterFields & {
+    /** Filter by workflow URL prefix. Supports multiple values. */
+    workflowUrlStartingWith: string | string[];
     workflowUrl?: never;
 };
 /** Cancel filter: no URL. Requires at least one other filter field. */
-type CancelFilterWithoutUrl = RequireAtLeastOne<UniversalFilterFields> & {
+type CancelFilterWithoutUrl = RequireAtLeastOne<UniversalFilterFields & HostPathFilterFields> & {
     workflowUrl?: never;
     workflowUrlStartingWith?: never;
 };
@@ -650,14 +683,14 @@ type WorkflowRunCancelFilters = {
     workflowRunIds?: never;
     filter?: never;
 } & WorkflowCancelCount);
-type WorkflowLogsListFilters = UniversalFilterFields & Pick<WorkflowFilterFields, "workflowUrl" | "workflowRunId" | "workflowCreatedAt"> & WorkflowLogsFilterFields;
+type WorkflowLogsListFilters = UniversalFilterFields & Pick<WorkflowFilterFields, "workflowUrl" | "workflowRunId" | "workflowCreatedAt"> & HostPathFilterFields & WorkflowLogsFilterFields;
 
 type ResumeRestartOptions = {
     flowControl?: FlowControl;
     retries?: number;
 };
 type FailureCallbackInfo = {
-    state?: "CALLBACK_FAIL" | "CALLBACK_SUCCESS" | "CALLBACK_INPROGRESS";
+    state?: FailureFunctionState;
     responseStatus?: number;
     responseBody?: string;
     responseHeaders?: Record<string, string[]>;
@@ -811,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.
      *
@@ -863,6 +905,11 @@ declare class Client {
      * - With other filters: `cancel({ filter: { label: "my-label" } })`
      * - To target all: `cancel({ all: true })`
      *
+     * Filters support multiple values: pass an array to match a run whose value
+     * equals any of the given values (OR logic). Separate filters are combined with
+     * AND logic. For example:
+     * `cancel({ filter: { workflowUrl: ["https://a.com", "https://b.com"] } })`
+     *
      * Cancels up to `count` workflow runs per call (defaults to 100).
      *
      * ```ts
@@ -1043,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 };