@upstash/workflow 0.2.12 → 0.2.14

package/hono.mjs

@@ -2,7 +2,7 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-4GTHIL7S.mjs";
+} from "./chunk-RMS2NQ3K.mjs";
 
 // platforms/hono.ts
 var telemetry = {
@@ -11,7 +11,7 @@ var telemetry = {
 };
 var serve = (routeFunction, options) => {
   const handler = async (context) => {
-    const environment = context.env;
+    const environment = context.env ? context.env : typeof process === "undefined" ? {} : process.env;
     const request = context.req.raw;
     const { handler: serveHandler } = serveBase(routeFunction, telemetry, {
       // when hono is used without cf workers, it sends a DebugHTTPServer

package/index.d.mts

@@ -1,6 +1,6 @@
-import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, T as Telemetry, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter, c as Step } from './types-D1W0VOpy.mjs';
-export { A as AsyncStepFunction, C as CallResponse, r as CallSettings, D as Duration, l as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, t as InvokableWorkflow, s as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, u as LogLevel, p as NotifyStepResponse, P as ParallelCallState, k as PublicServeOptions, m as RequiredExceptFields, j as StepFunction, h as StepTypes, i as SyncStepFunction, q as WaitEventOptions, n as WaitRequest, o as WaitStepResponse, f as WorkflowClient, e as WorkflowContext, w as WorkflowLogger, v as WorkflowLoggerOptions, g as WorkflowReceiver, d as WorkflowTool } from './types-D1W0VOpy.mjs';
-import { HTTPMethods, State, FlowControl, Client as Client$1, QstashError } from '@upstash/qstash';
+import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, T as Telemetry, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter, c as Step } from './types-C1WIgVLA.mjs';
+export { A as AsyncStepFunction, C as CallResponse, r as CallSettings, D as Duration, l as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, t as InvokableWorkflow, s as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, u as LogLevel, p as NotifyStepResponse, P as ParallelCallState, k as PublicServeOptions, m as RequiredExceptFields, j as StepFunction, h as StepTypes, i as SyncStepFunction, q as WaitEventOptions, n as WaitRequest, o as WaitStepResponse, f as WorkflowClient, e as WorkflowContext, w as WorkflowLogger, v as WorkflowLoggerOptions, g as WorkflowReceiver, d as WorkflowTool } from './types-C1WIgVLA.mjs';
+import { FlowControl, PublishRequest, HTTPMethods, State, Client as Client$1, QstashError } from '@upstash/qstash';
 import 'zod';
 import 'ai';
 import '@ai-sdk/openai';
@@ -78,6 +78,10 @@ type BaseStepLog = {
      * headers
      */
     headers: Record<string, string[]>;
+    /**
+     * retries
+     */
+    retries: number;
 };
 type CallUrlGroup = {
     /**
@@ -184,6 +188,19 @@ type StepLogGroup = {
     steps: {
         messageId: string;
         state: "STEP_PROGRESS" | "STEP_RETRY" | "STEP_FAILED" | "STEP_CANCELED";
+        /**
+         * retries
+         */
+        retries: number;
+        /**
+         * errors which occured in the step
+         */
+        errors?: {
+            error: string;
+            headers: Record<string, string[]>;
+            status: number;
+            time: number;
+        }[];
     }[];
     /**
      * Log which belongs to the next step
@@ -215,6 +232,9 @@ type FailureFunctionLog = {
      * Response body of the step which caused the workflow to fail
      */
     failResponse: string;
+    /**
+     * @deprecated use dlqId field of the workflow run itself
+     */
     dlqId: string;
 };
 type WorkflowRunLog = {
@@ -281,11 +301,73 @@ type WorkflowRunLog = {
          */
         workflowRunCreatedAt: number;
     };
+    /**
+     * If the workflow run has failed, id of the run in DLQ
+     */
+    dlqId?: string;
 };
 type WorkflowRunLogs = {
     cursor: string;
     runs: WorkflowRunLog[];
 };
+type TriggerOptions = {
+    /**
+     * URL of the workflow to trigger
+     */
+    url: string;
+    /**
+     * Body to send to the workflow
+     */
+    body?: unknown;
+    /**
+     * Headers to send to the workflow
+     */
+    headers?: Record<string, string>;
+    /**
+     * Workflow run id to use for the workflow run.
+     * If not provided, a random workflow run id will be generated.
+     */
+    workflowRunId?: string;
+    /**
+     * Number of retries to perform if the request fails.
+     *
+     * @default 3
+     */
+    retries?: number;
+    /**
+     * Flow control to use for the workflow run.
+     * If not provided, no flow control will be used.
+     */
+    flowControl?: FlowControl;
+    /**
+     * Delay to apply before triggering the workflow.
+     */
+    delay?: PublishRequest["delay"];
+} & ({
+    /**
+     * URL to call if the first request to the workflow endpoint fails
+     */
+    failureUrl?: never;
+    /**
+     * Whether the workflow endpoint has a failure function
+     * defined to be invoked if the first request fails.
+     *
+     * If true, the failureUrl will be ignored.
+     */
+    useFailureFunction?: true;
+} | {
+    /**
+     * URL to call if the first request to the workflow endpoint fails
+     */
+    failureUrl?: string;
+    /**
+     * Whether the workflow endpoint has a failure function
+     * defined to be invoked if the first request fails.
+     *
+     * If true, the failureUrl will be ignored.
+     */
+    useFailureFunction?: never;
+});
 
 type ClientConfig = ConstructorParameters<typeof Client$1>[0];
 /**
@@ -398,8 +480,9 @@ declare class Client {
         eventId: string;
     }): Promise<Required<Waiter>[]>;
     /**
-     * Trigger new workflow run and returns the workflow run id
+     * Trigger new workflow run and returns the workflow run id or an array of workflow run ids
      *
+     * trigger a single workflow run:
      * ```ts
      * const { workflowRunId } = await client.trigger({
      *   url: "https://workflow-endpoint.com",
@@ -412,6 +495,31 @@ declare class Client {
      * console.log(workflowRunId)
      * // wfr_my-workflow
      * ```
+     * trigger multiple workflow runs:
+     * ```ts
+     * const result = await client.trigger([
+     *   {
+     *   url: "https://workflow-endpoint.com",
+     *   body: "hello there!",         // Optional body
+     *   headers: { ... },             // Optional headers
+     *   workflowRunId: "my-workflow", // Optional workflow run ID
+     *   retries: 3                    // Optional retries for the initial request
+     * },
+     *   {
+     *   url: "https://workflow-endpoint-2.com",
+     *   body: "hello world!",           // Optional body
+     *   headers: { ... },               // Optional headers
+     *   workflowRunId: "my-workflow-2", // Optional workflow run ID
+     *   retries: 5                      // Optional retries for the initial request
+     * },
+     * ]);
+     *
+     * console.log(result)
+     * // [
+     * //   { workflowRunId: "wfr_my-workflow" },
+     * //   { workflowRunId: "wfr_my-workflow-2" },
+     * // ]
+     * ```
      *
      * @param url URL of the workflow
      * @param body body to start the workflow with
@@ -423,18 +531,19 @@ declare class Client {
      *   with `wfr_`.
      * @param retries retry to use in the initial request. in the rest of
      *   the workflow, `retries` option of the `serve` will be used.
-     * @returns workflow run id
-     */
-    trigger({ url, body, headers, workflowRunId, retries, flowControl, }: {
-        url: string;
-        body?: unknown;
-        headers?: Record<string, string>;
-        workflowRunId?: string;
-        retries?: number;
-        flowControl?: FlowControl;
-    }): Promise<{
+     * @param flowControl Settings for controlling the number of active requests
+     *   and number of requests per second with the same key.
+     * @param delay Delay for the workflow run. This is used to delay the
+     *   execution of the workflow run. The delay is in seconds or can be passed
+     *   as a string with a time unit (e.g. "1h", "30m", "15s").
+     * @returns workflow run id or an array of workflow run ids
+     */
+    trigger(params: TriggerOptions): Promise<{
         workflowRunId: string;
     }>;
+    trigger(params: TriggerOptions[]): Promise<{
+        workflowRunId: string;
+    }[]>;
     /**
      * Fetches logs for workflow runs.
      *
@@ -498,4 +607,4 @@ declare class WorkflowAbort extends Error {
     constructor(stepName: string, stepInfo?: Step, cancelWorkflow?: boolean);
 }
 
-export { Client, ExclusiveValidationOptions, NotifyResponse, RawStep, RouteFunction, Step, type StepLog, StepType, Telemetry, Waiter, WorkflowAbort, WorkflowError, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, serve };
+export { Client, ExclusiveValidationOptions, NotifyResponse, RawStep, RouteFunction, Step, type StepLog, StepType, Telemetry, type TriggerOptions, Waiter, WorkflowAbort, WorkflowError, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, serve };

package/index.d.ts

@@ -1,6 +1,6 @@
-import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, T as Telemetry, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter, c as Step } from './types-D1W0VOpy.js';
-export { A as AsyncStepFunction, C as CallResponse, r as CallSettings, D as Duration, l as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, t as InvokableWorkflow, s as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, u as LogLevel, p as NotifyStepResponse, P as ParallelCallState, k as PublicServeOptions, m as RequiredExceptFields, j as StepFunction, h as StepTypes, i as SyncStepFunction, q as WaitEventOptions, n as WaitRequest, o as WaitStepResponse, f as WorkflowClient, e as WorkflowContext, w as WorkflowLogger, v as WorkflowLoggerOptions, g as WorkflowReceiver, d as WorkflowTool } from './types-D1W0VOpy.js';
-import { HTTPMethods, State, FlowControl, Client as Client$1, QstashError } from '@upstash/qstash';
+import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, T as Telemetry, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter, c as Step } from './types-C1WIgVLA.js';
+export { A as AsyncStepFunction, C as CallResponse, r as CallSettings, D as Duration, l as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, t as InvokableWorkflow, s as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, u as LogLevel, p as NotifyStepResponse, P as ParallelCallState, k as PublicServeOptions, m as RequiredExceptFields, j as StepFunction, h as StepTypes, i as SyncStepFunction, q as WaitEventOptions, n as WaitRequest, o as WaitStepResponse, f as WorkflowClient, e as WorkflowContext, w as WorkflowLogger, v as WorkflowLoggerOptions, g as WorkflowReceiver, d as WorkflowTool } from './types-C1WIgVLA.js';
+import { FlowControl, PublishRequest, HTTPMethods, State, Client as Client$1, QstashError } from '@upstash/qstash';
 import 'zod';
 import 'ai';
 import '@ai-sdk/openai';
@@ -78,6 +78,10 @@ type BaseStepLog = {
      * headers
      */
     headers: Record<string, string[]>;
+    /**
+     * retries
+     */
+    retries: number;
 };
 type CallUrlGroup = {
     /**
@@ -184,6 +188,19 @@ type StepLogGroup = {
     steps: {
         messageId: string;
         state: "STEP_PROGRESS" | "STEP_RETRY" | "STEP_FAILED" | "STEP_CANCELED";
+        /**
+         * retries
+         */
+        retries: number;
+        /**
+         * errors which occured in the step
+         */
+        errors?: {
+            error: string;
+            headers: Record<string, string[]>;
+            status: number;
+            time: number;
+        }[];
     }[];
     /**
      * Log which belongs to the next step
@@ -215,6 +232,9 @@ type FailureFunctionLog = {
      * Response body of the step which caused the workflow to fail
      */
     failResponse: string;
+    /**
+     * @deprecated use dlqId field of the workflow run itself
+     */
     dlqId: string;
 };
 type WorkflowRunLog = {
@@ -281,11 +301,73 @@ type WorkflowRunLog = {
          */
         workflowRunCreatedAt: number;
     };
+    /**
+     * If the workflow run has failed, id of the run in DLQ
+     */
+    dlqId?: string;
 };
 type WorkflowRunLogs = {
     cursor: string;
     runs: WorkflowRunLog[];
 };
+type TriggerOptions = {
+    /**
+     * URL of the workflow to trigger
+     */
+    url: string;
+    /**
+     * Body to send to the workflow
+     */
+    body?: unknown;
+    /**
+     * Headers to send to the workflow
+     */
+    headers?: Record<string, string>;
+    /**
+     * Workflow run id to use for the workflow run.
+     * If not provided, a random workflow run id will be generated.
+     */
+    workflowRunId?: string;
+    /**
+     * Number of retries to perform if the request fails.
+     *
+     * @default 3
+     */
+    retries?: number;
+    /**
+     * Flow control to use for the workflow run.
+     * If not provided, no flow control will be used.
+     */
+    flowControl?: FlowControl;
+    /**
+     * Delay to apply before triggering the workflow.
+     */
+    delay?: PublishRequest["delay"];
+} & ({
+    /**
+     * URL to call if the first request to the workflow endpoint fails
+     */
+    failureUrl?: never;
+    /**
+     * Whether the workflow endpoint has a failure function
+     * defined to be invoked if the first request fails.
+     *
+     * If true, the failureUrl will be ignored.
+     */
+    useFailureFunction?: true;
+} | {
+    /**
+     * URL to call if the first request to the workflow endpoint fails
+     */
+    failureUrl?: string;
+    /**
+     * Whether the workflow endpoint has a failure function
+     * defined to be invoked if the first request fails.
+     *
+     * If true, the failureUrl will be ignored.
+     */
+    useFailureFunction?: never;
+});
 
 type ClientConfig = ConstructorParameters<typeof Client$1>[0];
 /**
@@ -398,8 +480,9 @@ declare class Client {
         eventId: string;
     }): Promise<Required<Waiter>[]>;
     /**
-     * Trigger new workflow run and returns the workflow run id
+     * Trigger new workflow run and returns the workflow run id or an array of workflow run ids
      *
+     * trigger a single workflow run:
      * ```ts
      * const { workflowRunId } = await client.trigger({
      *   url: "https://workflow-endpoint.com",
@@ -412,6 +495,31 @@ declare class Client {
      * console.log(workflowRunId)
      * // wfr_my-workflow
      * ```
+     * trigger multiple workflow runs:
+     * ```ts
+     * const result = await client.trigger([
+     *   {
+     *   url: "https://workflow-endpoint.com",
+     *   body: "hello there!",         // Optional body
+     *   headers: { ... },             // Optional headers
+     *   workflowRunId: "my-workflow", // Optional workflow run ID
+     *   retries: 3                    // Optional retries for the initial request
+     * },
+     *   {
+     *   url: "https://workflow-endpoint-2.com",
+     *   body: "hello world!",           // Optional body
+     *   headers: { ... },               // Optional headers
+     *   workflowRunId: "my-workflow-2", // Optional workflow run ID
+     *   retries: 5                      // Optional retries for the initial request
+     * },
+     * ]);
+     *
+     * console.log(result)
+     * // [
+     * //   { workflowRunId: "wfr_my-workflow" },
+     * //   { workflowRunId: "wfr_my-workflow-2" },
+     * // ]
+     * ```
      *
      * @param url URL of the workflow
      * @param body body to start the workflow with
@@ -423,18 +531,19 @@ declare class Client {
      *   with `wfr_`.
      * @param retries retry to use in the initial request. in the rest of
      *   the workflow, `retries` option of the `serve` will be used.
-     * @returns workflow run id
-     */
-    trigger({ url, body, headers, workflowRunId, retries, flowControl, }: {
-        url: string;
-        body?: unknown;
-        headers?: Record<string, string>;
-        workflowRunId?: string;
-        retries?: number;
-        flowControl?: FlowControl;
-    }): Promise<{
+     * @param flowControl Settings for controlling the number of active requests
+     *   and number of requests per second with the same key.
+     * @param delay Delay for the workflow run. This is used to delay the
+     *   execution of the workflow run. The delay is in seconds or can be passed
+     *   as a string with a time unit (e.g. "1h", "30m", "15s").
+     * @returns workflow run id or an array of workflow run ids
+     */
+    trigger(params: TriggerOptions): Promise<{
         workflowRunId: string;
     }>;
+    trigger(params: TriggerOptions[]): Promise<{
+        workflowRunId: string;
+    }[]>;
     /**
      * Fetches logs for workflow runs.
      *
@@ -498,4 +607,4 @@ declare class WorkflowAbort extends Error {
     constructor(stepName: string, stepInfo?: Step, cancelWorkflow?: boolean);
 }
 
-export { Client, ExclusiveValidationOptions, NotifyResponse, RawStep, RouteFunction, Step, type StepLog, StepType, Telemetry, Waiter, WorkflowAbort, WorkflowError, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, serve };
+export { Client, ExclusiveValidationOptions, NotifyResponse, RawStep, RouteFunction, Step, type StepLog, StepType, Telemetry, type TriggerOptions, Waiter, WorkflowAbort, WorkflowError, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, serve };