@upstash/workflow 0.2.13 → 0.2.14

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-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 { HTTPMethods, State, FlowControl, PublishRequest, Client as Client$1, QstashError } from '@upstash/qstash';
+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
@@ -428,19 +536,14 @@ declare class Client {
      * @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
-     */
-    trigger({ url, body, headers, workflowRunId, retries, flowControl, delay, }: {
-        url: string;
-        body?: unknown;
-        headers?: Record<string, string>;
-        workflowRunId?: string;
-        retries?: number;
-        flowControl?: FlowControl;
-        delay?: PublishRequest["delay"];
-    }): Promise<{
+     * @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.
      *
@@ -504,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.js

@@ -103,7 +103,7 @@ var WORKFLOW_PROTOCOL_VERSION_HEADER = "Upstash-Workflow-Sdk-Version";
 var DEFAULT_CONTENT_TYPE = "application/json";
 var NO_CONCURRENCY = 1;
 var DEFAULT_RETRIES = 3;
-var VERSION = "v0.2.13";
+var VERSION = "v0.2.14";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -611,59 +611,72 @@ var StepTypes = [
 
 // src/workflow-requests.ts
 var import_qstash3 = require("@upstash/qstash");
-var triggerFirstInvocation = async ({
-  workflowContext,
-  useJSONContent,
-  telemetry,
-  debug,
-  invokeCount,
-  delay
-}) => {
-  const { headers } = getHeaders({
-    initHeaderValue: "true",
-    workflowConfig: {
-      workflowRunId: workflowContext.workflowRunId,
-      workflowUrl: workflowContext.url,
-      failureUrl: workflowContext.failureUrl,
-      retries: workflowContext.retries,
-      telemetry,
-      flowControl: workflowContext.flowControl,
-      useJSONContent: useJSONContent ?? false
-    },
-    invokeCount: invokeCount ?? 0,
-    userHeaders: workflowContext.headers
-  });
-  if (workflowContext.headers.get("content-type")) {
-    headers["content-type"] = workflowContext.headers.get("content-type");
-  }
-  if (useJSONContent) {
-    headers["content-type"] = "application/json";
-  }
-  try {
-    const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
-    const result = await workflowContext.qstashClient.publish({
-      headers,
-      method: "POST",
-      body,
-      url: workflowContext.url,
-      delay
-    });
-    if (result.deduplicated) {
-      await debug?.log("WARN", "SUBMIT_FIRST_INVOCATION", {
-        message: `Workflow run ${workflowContext.workflowRunId} already exists. A new one isn't created.`,
+var triggerFirstInvocation = async (params) => {
+  const firstInvocationParams = Array.isArray(params) ? params : [params];
+  const workflowContextClient = firstInvocationParams[0].workflowContext.qstashClient;
+  const invocationBatch = firstInvocationParams.map(
+    ({ workflowContext, useJSONContent, telemetry, invokeCount, delay }) => {
+      const { headers } = getHeaders({
+        initHeaderValue: "true",
+        workflowConfig: {
+          workflowRunId: workflowContext.workflowRunId,
+          workflowUrl: workflowContext.url,
+          failureUrl: workflowContext.failureUrl,
+          retries: workflowContext.retries,
+          telemetry,
+          flowControl: workflowContext.flowControl,
+          useJSONContent: useJSONContent ?? false
+        },
+        invokeCount: invokeCount ?? 0,
+        userHeaders: workflowContext.headers
+      });
+      if (workflowContext.headers.get("content-type")) {
+        headers["content-type"] = workflowContext.headers.get("content-type");
+      }
+      if (useJSONContent) {
+        headers["content-type"] = "application/json";
+      }
+      const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
+      return {
         headers,
-        requestPayload: workflowContext.requestPayload,
+        method: "POST",
+        body,
         url: workflowContext.url,
-        messageId: result.messageId
-      });
+        delay
+      };
+    }
+  );
+  try {
+    const results = await workflowContextClient.batch(invocationBatch);
+    const invocationStatuses = [];
+    for (let i = 0; i < results.length; i++) {
+      const result = results[i];
+      const invocationParams = firstInvocationParams[i];
+      if (result.deduplicated) {
+        await invocationParams.debug?.log("WARN", "SUBMIT_FIRST_INVOCATION", {
+          message: `Workflow run ${invocationParams.workflowContext.workflowRunId} already exists. A new one isn't created.`,
+          headers: invocationBatch[i].headers,
+          requestPayload: invocationParams.workflowContext.requestPayload,
+          url: invocationParams.workflowContext.url,
+          messageId: result.messageId
+        });
+        invocationStatuses.push("workflow-run-already-exists");
+      } else {
+        await invocationParams.debug?.log("SUBMIT", "SUBMIT_FIRST_INVOCATION", {
+          headers: invocationBatch[i].headers,
+          requestPayload: invocationParams.workflowContext.requestPayload,
+          url: invocationParams.workflowContext.url,
+          messageId: result.messageId
+        });
+        invocationStatuses.push("success");
+      }
+    }
+    const hasAnyDeduplicated = invocationStatuses.some(
+      (status) => status === "workflow-run-already-exists"
+    );
+    if (hasAnyDeduplicated) {
       return ok("workflow-run-already-exists");
     } else {
-      await debug?.log("SUBMIT", "SUBMIT_FIRST_INVOCATION", {
-        headers,
-        requestPayload: workflowContext.requestPayload,
-        url: workflowContext.url,
-        messageId: result.messageId
-      });
       return ok("success");
     }
   } catch (error) {
@@ -1153,7 +1166,7 @@ var LazyCallStep = class _LazyCallStep extends BaseLazyStep {
       return { header, status, body };
     }
   }
-  static applicationHeaders = /* @__PURE__ */ new Set([
+  static applicationContentTypes = [
     "application/json",
     "application/xml",
     "application/javascript",
@@ -1162,12 +1175,12 @@ var LazyCallStep = class _LazyCallStep extends BaseLazyStep {
     "application/ld+json",
     "application/rss+xml",
     "application/atom+xml"
-  ]);
+  ];
   static isText = (contentTypeHeader) => {
     if (!contentTypeHeader) {
       return false;
     }
-    if (_LazyCallStep.applicationHeaders.has(contentTypeHeader)) {
+    if (_LazyCallStep.applicationContentTypes.some((type) => contentTypeHeader.includes(type))) {
       return true;
     }
     if (contentTypeHeader.startsWith("text/")) {
@@ -3557,70 +3570,39 @@ var Client4 = class {
   async getWaiters({ eventId }) {
     return await makeGetWaitersRequest(this.client.http, eventId);
   }
-  /**
-   * Trigger new workflow run and returns the workflow run id
-   *
-   * ```ts
-   * const { workflowRunId } = 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
-   * });
-   *
-   * console.log(workflowRunId)
-   * // wfr_my-workflow
-   * ```
-   *
-   * @param url URL of the workflow
-   * @param body body to start the workflow with
-   * @param headers headers to use in the request
-   * @param workflowRunId optional workflow run id to use. mind that
-   *   you should pass different workflow run ids for different runs.
-   *   The final workflowRunId will be `wfr_${workflowRunId}`, in
-   *   other words: the workflow run id you pass will be prefixed
-   *   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.
-   * @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
-   */
-  async trigger({
-    url,
-    body,
-    headers,
-    workflowRunId,
-    retries,
-    flowControl,
-    delay
-  }) {
-    const finalWorkflowRunId = getWorkflowRunId(workflowRunId);
-    const context = new WorkflowContext({
-      qstashClient: this.client,
-      // @ts-expect-error headers type mismatch
-      headers: new Headers(headers ?? {}),
-      initialPayload: body,
-      steps: [],
-      url,
-      workflowRunId: finalWorkflowRunId,
-      retries,
-      telemetry: void 0,
-      // can't know workflow telemetry here
-      flowControl
-    });
-    const result = await triggerFirstInvocation({
-      workflowContext: context,
-      telemetry: void 0,
-      // can't know workflow telemetry here
-      delay
+  async trigger(params) {
+    const isBatchInput = Array.isArray(params);
+    const options = isBatchInput ? params : [params];
+    const invocations = options.map((option) => {
+      const failureUrl = option.useFailureFunction ? option.url : option.failureUrl;
+      const finalWorkflowRunId = getWorkflowRunId(option.workflowRunId);
+      const context = new WorkflowContext({
+        qstashClient: this.client,
+        // @ts-expect-error headers type mismatch
+        headers: new Headers(option.headers ?? {}),
+        initialPayload: option.body,
+        steps: [],
+        url: option.url,
+        workflowRunId: finalWorkflowRunId,
+        retries: option.retries,
+        telemetry: void 0,
+        // can't know workflow telemetry here
+        flowControl: option.flowControl,
+        failureUrl
+      });
+      return {
+        workflowContext: context,
+        telemetry: void 0,
+        // can't know workflow telemetry here
+        delay: option.delay
+      };
     });
+    const result = await triggerFirstInvocation(invocations);
+    const workflowRunIds = invocations.map(
+      (invocation) => invocation.workflowContext.workflowRunId
+    );
     if (result.isOk()) {
-      return { workflowRunId: finalWorkflowRunId };
+      return isBatchInput ? workflowRunIds.map((id) => ({ workflowRunId: id })) : { workflowRunId: workflowRunIds[0] };
     } else {
       throw result.error;
     }

package/index.mjs

@@ -10,7 +10,7 @@ import {
   makeNotifyRequest,
   serve,
   triggerFirstInvocation
-} from "./chunk-XVNSBBDC.mjs";
+} from "./chunk-RMS2NQ3K.mjs";
 
 // src/client/index.ts
 import { Client as QStashClient } from "@upstash/qstash";
@@ -140,70 +140,39 @@ var Client = class {
   async getWaiters({ eventId }) {
     return await makeGetWaitersRequest(this.client.http, eventId);
   }
-  /**
-   * Trigger new workflow run and returns the workflow run id
-   *
-   * ```ts
-   * const { workflowRunId } = 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
-   * });
-   *
-   * console.log(workflowRunId)
-   * // wfr_my-workflow
-   * ```
-   *
-   * @param url URL of the workflow
-   * @param body body to start the workflow with
-   * @param headers headers to use in the request
-   * @param workflowRunId optional workflow run id to use. mind that
-   *   you should pass different workflow run ids for different runs.
-   *   The final workflowRunId will be `wfr_${workflowRunId}`, in
-   *   other words: the workflow run id you pass will be prefixed
-   *   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.
-   * @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
-   */
-  async trigger({
-    url,
-    body,
-    headers,
-    workflowRunId,
-    retries,
-    flowControl,
-    delay
-  }) {
-    const finalWorkflowRunId = getWorkflowRunId(workflowRunId);
-    const context = new WorkflowContext({
-      qstashClient: this.client,
-      // @ts-expect-error headers type mismatch
-      headers: new Headers(headers ?? {}),
-      initialPayload: body,
-      steps: [],
-      url,
-      workflowRunId: finalWorkflowRunId,
-      retries,
-      telemetry: void 0,
-      // can't know workflow telemetry here
-      flowControl
-    });
-    const result = await triggerFirstInvocation({
-      workflowContext: context,
-      telemetry: void 0,
-      // can't know workflow telemetry here
-      delay
+  async trigger(params) {
+    const isBatchInput = Array.isArray(params);
+    const options = isBatchInput ? params : [params];
+    const invocations = options.map((option) => {
+      const failureUrl = option.useFailureFunction ? option.url : option.failureUrl;
+      const finalWorkflowRunId = getWorkflowRunId(option.workflowRunId);
+      const context = new WorkflowContext({
+        qstashClient: this.client,
+        // @ts-expect-error headers type mismatch
+        headers: new Headers(option.headers ?? {}),
+        initialPayload: option.body,
+        steps: [],
+        url: option.url,
+        workflowRunId: finalWorkflowRunId,
+        retries: option.retries,
+        telemetry: void 0,
+        // can't know workflow telemetry here
+        flowControl: option.flowControl,
+        failureUrl
+      });
+      return {
+        workflowContext: context,
+        telemetry: void 0,
+        // can't know workflow telemetry here
+        delay: option.delay
+      };
     });
+    const result = await triggerFirstInvocation(invocations);
+    const workflowRunIds = invocations.map(
+      (invocation) => invocation.workflowContext.workflowRunId
+    );
     if (result.isOk()) {
-      return { workflowRunId: finalWorkflowRunId };
+      return isBatchInput ? workflowRunIds.map((id) => ({ workflowRunId: id })) : { workflowRunId: workflowRunIds[0] };
     } else {
       throw result.error;
     }