@upstash/workflow 0.2.17 → 0.2.18

package/h3.js

@@ -398,12 +398,13 @@ var WORKFLOW_URL_HEADER = "Upstash-Workflow-Url";
 var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
 var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
 var WORKFLOW_INVOKE_COUNT_HEADER = "Upstash-Workflow-Invoke-Count";
+var WORKFLOW_LABEL_HEADER = "Upstash-Label";
 var WORKFLOW_PROTOCOL_VERSION = "1";
 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.17";
+var VERSION = "v0.2.18";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -947,6 +948,9 @@ var triggerFirstInvocation = async (params) => {
       if (useJSONContent) {
         headers["content-type"] = "application/json";
       }
+      if (workflowContext.label) {
+        headers[WORKFLOW_LABEL_HEADER] = workflowContext.label;
+      }
       const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
       return {
         headers,
@@ -1047,10 +1051,11 @@ var recreateUserHeaders = (headers) => {
   const pairs = headers.entries();
   for (const [header, value] of pairs) {
     const headerLowerCase = header.toLowerCase();
-    if (!headerLowerCase.startsWith("upstash-workflow-") && // https://vercel.com/docs/edge-network/headers/request-headers#x-vercel-id
+    const isUserHeader = !headerLowerCase.startsWith("upstash-workflow-") && // https://vercel.com/docs/edge-network/headers/request-headers#x-vercel-id
     !headerLowerCase.startsWith("x-vercel-") && !headerLowerCase.startsWith("x-forwarded-") && // https://blog.cloudflare.com/preventing-request-loops-using-cdn-loop/
     headerLowerCase !== "cf-connecting-ip" && headerLowerCase !== "cdn-loop" && headerLowerCase !== "cf-ew-via" && headerLowerCase !== "cf-ray" && // For Render https://render.com
-    headerLowerCase !== "render-proxy-ttl") {
+    headerLowerCase !== "render-proxy-ttl" || headerLowerCase === WORKFLOW_LABEL_HEADER.toLocaleLowerCase();
+    if (isUserHeader) {
       filteredHeaders.append(header, value);
     }
   }
@@ -3080,6 +3085,22 @@ var WorkflowContext = class {
    * and number of requests per second with the same key.
    */
   flowControl;
+  /**
+   * Label to apply to the workflow run.
+   *
+   * Can be used to filter the workflow run logs.
+   *
+   * Can be set by passing a `label` parameter when triggering the workflow
+   * with `client.trigger`:
+   *
+   * ```ts
+   * await client.trigger({
+   *   url: "https://workflow-endpoint.com",
+   *   label: "my-label"
+   * });
+   * ```
+   */
+  label;
   constructor({
     qstashClient,
     workflowRunId,
@@ -3094,7 +3115,8 @@ var WorkflowContext = class {
     retryDelay,
     telemetry: telemetry2,
     invokeCount,
-    flowControl
+    flowControl,
+    label
   }) {
     this.qstashClient = qstashClient;
     this.workflowRunId = workflowRunId;
@@ -3107,6 +3129,7 @@ var WorkflowContext = class {
     this.retries = retries ?? DEFAULT_RETRIES;
     this.retryDelay = retryDelay;
     this.flowControl = flowControl;
+    this.label = label;
     this.executor = new AutoExecutor(this, this.steps, telemetry2, invokeCount, debug);
   }
   /**
@@ -3407,7 +3430,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
       env: context.env,
       retries: context.retries,
       retryDelay: context.retryDelay,
-      flowControl: context.flowControl
+      flowControl: context.flowControl,
+      label: context.label
     });
     try {
       await routeFunction(disabledContext);
@@ -3584,11 +3608,12 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
     if (!errorMessage) {
       errorMessage = `Couldn't parse 'failResponse' in 'failureFunction', received: '${decodedBody}'`;
     }
+    const userHeaders = recreateUserHeaders(request.headers);
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
       initialPayload: sourceBody ? initialPayloadParser(decodeBase64(sourceBody)) : void 0,
-      headers: recreateUserHeaders(request.headers),
+      headers: userHeaders,
       steps: [],
       url,
       failureUrl: url,
@@ -3597,8 +3622,9 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
       retries,
       retryDelay,
       flowControl,
-      telemetry: void 0
+      telemetry: void 0,
       // not going to make requests in authentication check
+      label: userHeaders.get(WORKFLOW_LABEL_HEADER) ?? void 0
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,
@@ -3807,6 +3833,7 @@ var serveBase = (routeFunction, telemetry2, options) => {
       });
     }
     const invokeCount = Number(request.headers.get(WORKFLOW_INVOKE_COUNT_HEADER) ?? "0");
+    const label = request.headers.get(WORKFLOW_LABEL_HEADER) ?? void 0;
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
@@ -3821,7 +3848,8 @@ var serveBase = (routeFunction, telemetry2, options) => {
       retryDelay,
       telemetry: telemetry2,
       invokeCount,
-      flowControl
+      flowControl,
+      label
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,

package/h3.mjs

@@ -2,7 +2,7 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-RP7G4UD5.mjs";
+} from "./chunk-EHL7SSJF.mjs";
 
 // node_modules/defu/dist/defu.mjs
 function isPlainObject(value) {

package/hono.d.mts

@@ -1,7 +1,7 @@
 import { Context } from 'hono';
-import { R as RouteFunction, n as PublicServeOptions, x as InvokableWorkflow } from './types--R_3XZXz.mjs';
+import { R as RouteFunction, n as PublicServeOptions, x as InvokableWorkflow } from './types-B7_5AkKQ.mjs';
 import { Variables } from 'hono/types';
-import { s as serveManyBase } from './serve-many-DgDSOvQs.mjs';
+import { s as serveManyBase } from './serve-many-CEUYWQvV.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/hono.d.ts

@@ -1,7 +1,7 @@
 import { Context } from 'hono';
-import { R as RouteFunction, n as PublicServeOptions, x as InvokableWorkflow } from './types--R_3XZXz.js';
+import { R as RouteFunction, n as PublicServeOptions, x as InvokableWorkflow } from './types-B7_5AkKQ.js';
 import { Variables } from 'hono/types';
-import { s as serveManyBase } from './serve-many-B3DfoTFt.js';
+import { s as serveManyBase } from './serve-many-BObe3pdI.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/hono.js

@@ -86,12 +86,13 @@ var WORKFLOW_URL_HEADER = "Upstash-Workflow-Url";
 var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
 var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
 var WORKFLOW_INVOKE_COUNT_HEADER = "Upstash-Workflow-Invoke-Count";
+var WORKFLOW_LABEL_HEADER = "Upstash-Label";
 var WORKFLOW_PROTOCOL_VERSION = "1";
 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.17";
+var VERSION = "v0.2.18";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -635,6 +636,9 @@ var triggerFirstInvocation = async (params) => {
       if (useJSONContent) {
         headers["content-type"] = "application/json";
       }
+      if (workflowContext.label) {
+        headers[WORKFLOW_LABEL_HEADER] = workflowContext.label;
+      }
       const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
       return {
         headers,
@@ -735,10 +739,11 @@ var recreateUserHeaders = (headers) => {
   const pairs = headers.entries();
   for (const [header, value] of pairs) {
     const headerLowerCase = header.toLowerCase();
-    if (!headerLowerCase.startsWith("upstash-workflow-") && // https://vercel.com/docs/edge-network/headers/request-headers#x-vercel-id
+    const isUserHeader = !headerLowerCase.startsWith("upstash-workflow-") && // https://vercel.com/docs/edge-network/headers/request-headers#x-vercel-id
     !headerLowerCase.startsWith("x-vercel-") && !headerLowerCase.startsWith("x-forwarded-") && // https://blog.cloudflare.com/preventing-request-loops-using-cdn-loop/
     headerLowerCase !== "cf-connecting-ip" && headerLowerCase !== "cdn-loop" && headerLowerCase !== "cf-ew-via" && headerLowerCase !== "cf-ray" && // For Render https://render.com
-    headerLowerCase !== "render-proxy-ttl") {
+    headerLowerCase !== "render-proxy-ttl" || headerLowerCase === WORKFLOW_LABEL_HEADER.toLocaleLowerCase();
+    if (isUserHeader) {
       filteredHeaders.append(header, value);
     }
   }
@@ -2768,6 +2773,22 @@ var WorkflowContext = class {
    * and number of requests per second with the same key.
    */
   flowControl;
+  /**
+   * Label to apply to the workflow run.
+   *
+   * Can be used to filter the workflow run logs.
+   *
+   * Can be set by passing a `label` parameter when triggering the workflow
+   * with `client.trigger`:
+   *
+   * ```ts
+   * await client.trigger({
+   *   url: "https://workflow-endpoint.com",
+   *   label: "my-label"
+   * });
+   * ```
+   */
+  label;
   constructor({
     qstashClient,
     workflowRunId,
@@ -2782,7 +2803,8 @@ var WorkflowContext = class {
     retryDelay,
     telemetry: telemetry2,
     invokeCount,
-    flowControl
+    flowControl,
+    label
   }) {
     this.qstashClient = qstashClient;
     this.workflowRunId = workflowRunId;
@@ -2795,6 +2817,7 @@ var WorkflowContext = class {
     this.retries = retries ?? DEFAULT_RETRIES;
     this.retryDelay = retryDelay;
     this.flowControl = flowControl;
+    this.label = label;
     this.executor = new AutoExecutor(this, this.steps, telemetry2, invokeCount, debug);
   }
   /**
@@ -3095,7 +3118,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
       env: context.env,
       retries: context.retries,
       retryDelay: context.retryDelay,
-      flowControl: context.flowControl
+      flowControl: context.flowControl,
+      label: context.label
     });
     try {
       await routeFunction(disabledContext);
@@ -3272,11 +3296,12 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
     if (!errorMessage) {
       errorMessage = `Couldn't parse 'failResponse' in 'failureFunction', received: '${decodedBody}'`;
     }
+    const userHeaders = recreateUserHeaders(request.headers);
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
       initialPayload: sourceBody ? initialPayloadParser(decodeBase64(sourceBody)) : void 0,
-      headers: recreateUserHeaders(request.headers),
+      headers: userHeaders,
       steps: [],
       url,
       failureUrl: url,
@@ -3285,8 +3310,9 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
       retries,
       retryDelay,
       flowControl,
-      telemetry: void 0
+      telemetry: void 0,
       // not going to make requests in authentication check
+      label: userHeaders.get(WORKFLOW_LABEL_HEADER) ?? void 0
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,
@@ -3495,6 +3521,7 @@ var serveBase = (routeFunction, telemetry2, options) => {
       });
     }
     const invokeCount = Number(request.headers.get(WORKFLOW_INVOKE_COUNT_HEADER) ?? "0");
+    const label = request.headers.get(WORKFLOW_LABEL_HEADER) ?? void 0;
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
@@ -3509,7 +3536,8 @@ var serveBase = (routeFunction, telemetry2, options) => {
       retryDelay,
       telemetry: telemetry2,
       invokeCount,
-      flowControl
+      flowControl,
+      label
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,

package/hono.mjs

@@ -2,7 +2,7 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-RP7G4UD5.mjs";
+} from "./chunk-EHL7SSJF.mjs";
 
 // platforms/hono.ts
 var telemetry = {

package/index.d.mts

@@ -1,5 +1,5 @@
-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 } from './types--R_3XZXz.mjs';
-export { A as AsyncStepFunction, C as CallResponse, v as CallSettings, D as DetailedFinishCondition, t as Duration, o as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, x as InvokableWorkflow, w as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, y as LogLevel, s as NotifyStepResponse, P as ParallelCallState, n as PublicServeOptions, p as RequiredExceptFields, k as Step, m as StepFunction, j as StepTypes, l as SyncStepFunction, u as WaitEventOptions, q as WaitRequest, r as WaitStepResponse, d as WorkflowAbort, h as WorkflowClient, g as WorkflowContext, c as WorkflowError, B as WorkflowLogger, z as WorkflowLoggerOptions, e as WorkflowNonRetryableError, i as WorkflowReceiver, f as WorkflowTool } from './types--R_3XZXz.mjs';
+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 } from './types-B7_5AkKQ.mjs';
+export { A as AsyncStepFunction, C as CallResponse, v as CallSettings, D as DetailedFinishCondition, t as Duration, o as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, x as InvokableWorkflow, w as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, y as LogLevel, s as NotifyStepResponse, P as ParallelCallState, n as PublicServeOptions, p as RequiredExceptFields, k as Step, m as StepFunction, j as StepTypes, l as SyncStepFunction, u as WaitEventOptions, q as WaitRequest, r as WaitStepResponse, d as WorkflowAbort, h as WorkflowClient, g as WorkflowContext, c as WorkflowError, B as WorkflowLogger, z as WorkflowLoggerOptions, e as WorkflowNonRetryableError, i as WorkflowReceiver, f as WorkflowTool } from './types-B7_5AkKQ.mjs';
 import { FlowControl, PublishRequest, HTTPMethods, State, Client as Client$1 } from '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -343,6 +343,10 @@ type WorkflowRunLog = {
      * If the workflow run has failed, id of the run in DLQ
      */
     dlqId?: string;
+    /**
+     * Label of the workflow run
+     */
+    label?: string;
 };
 type WorkflowRunLogs = {
     cursor: string;
@@ -412,6 +416,12 @@ type TriggerOptions = {
      * Delay to apply before triggering the workflow.
      */
     delay?: PublishRequest["delay"];
+    /**
+     * Label to apply to the workflow run.
+     *
+     * Can be used to filter the workflow run logs.
+     */
+    label?: string;
 } & ({
     /**
      * URL to call if the first request to the workflow endpoint fails
@@ -456,6 +466,7 @@ type DLQFilterOptions = Pick<QStashDLQFilterOptions, "fromDate" | "toDate" | "ur
     workflowRunId?: string;
     workflowCreatedAt?: string;
     failureFunctionState?: FailureCallbackInfo["state"];
+    label?: string;
 };
 type FailureCallbackInfo = {
     state?: "CALLBACK_FAIL" | "CALLBACK_SUCCESS" | "CALLBACK_INPROGRESS";
@@ -491,8 +502,12 @@ type DLQMessage = {
      * status of the failure callback
      */
     failureCallbackInfo?: FailureCallbackInfo;
+    /**
+     * label passed when triggering workflow
+     */
+    label?: string;
 };
-type PublicDLQMessage = Pick<DLQMessage, "header" | "body" | "maxRetries" | "notBefore" | "createdAt" | "callerIP" | "workflowRunId" | "workflowCreatedAt" | "workflowUrl" | "responseStatus" | "responseHeader" | "responseBody" | "dlqId" | "failureCallback" | "failureCallbackInfo">;
+type PublicDLQMessage = Pick<DLQMessage, "header" | "body" | "maxRetries" | "notBefore" | "createdAt" | "callerIP" | "workflowRunId" | "workflowCreatedAt" | "workflowUrl" | "responseStatus" | "responseHeader" | "responseBody" | "dlqId" | "failureCallback" | "failureCallbackInfo" | "label">;
 declare class DLQ {
     private client;
     constructor(client: Client$1);
@@ -832,6 +847,7 @@ declare class Client {
         state?: WorkflowRunLog["workflowState"];
         workflowUrl?: WorkflowRunLog["workflowUrl"];
         workflowCreatedAt?: WorkflowRunLog["workflowRunCreatedAt"];
+        label?: WorkflowRunLog["label"];
     }): Promise<WorkflowRunLogs>;
     get dlq(): DLQ;
 }

package/index.d.ts

@@ -1,5 +1,5 @@
-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 } from './types--R_3XZXz.js';
-export { A as AsyncStepFunction, C as CallResponse, v as CallSettings, D as DetailedFinishCondition, t as Duration, o as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, x as InvokableWorkflow, w as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, y as LogLevel, s as NotifyStepResponse, P as ParallelCallState, n as PublicServeOptions, p as RequiredExceptFields, k as Step, m as StepFunction, j as StepTypes, l as SyncStepFunction, u as WaitEventOptions, q as WaitRequest, r as WaitStepResponse, d as WorkflowAbort, h as WorkflowClient, g as WorkflowContext, c as WorkflowError, B as WorkflowLogger, z as WorkflowLoggerOptions, e as WorkflowNonRetryableError, i as WorkflowReceiver, f as WorkflowTool } from './types--R_3XZXz.js';
+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 } from './types-B7_5AkKQ.js';
+export { A as AsyncStepFunction, C as CallResponse, v as CallSettings, D as DetailedFinishCondition, t as Duration, o as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, x as InvokableWorkflow, w as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, y as LogLevel, s as NotifyStepResponse, P as ParallelCallState, n as PublicServeOptions, p as RequiredExceptFields, k as Step, m as StepFunction, j as StepTypes, l as SyncStepFunction, u as WaitEventOptions, q as WaitRequest, r as WaitStepResponse, d as WorkflowAbort, h as WorkflowClient, g as WorkflowContext, c as WorkflowError, B as WorkflowLogger, z as WorkflowLoggerOptions, e as WorkflowNonRetryableError, i as WorkflowReceiver, f as WorkflowTool } from './types-B7_5AkKQ.js';
 import { FlowControl, PublishRequest, HTTPMethods, State, Client as Client$1 } from '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -343,6 +343,10 @@ type WorkflowRunLog = {
      * If the workflow run has failed, id of the run in DLQ
      */
     dlqId?: string;
+    /**
+     * Label of the workflow run
+     */
+    label?: string;
 };
 type WorkflowRunLogs = {
     cursor: string;
@@ -412,6 +416,12 @@ type TriggerOptions = {
      * Delay to apply before triggering the workflow.
      */
     delay?: PublishRequest["delay"];
+    /**
+     * Label to apply to the workflow run.
+     *
+     * Can be used to filter the workflow run logs.
+     */
+    label?: string;
 } & ({
     /**
      * URL to call if the first request to the workflow endpoint fails
@@ -456,6 +466,7 @@ type DLQFilterOptions = Pick<QStashDLQFilterOptions, "fromDate" | "toDate" | "ur
     workflowRunId?: string;
     workflowCreatedAt?: string;
     failureFunctionState?: FailureCallbackInfo["state"];
+    label?: string;
 };
 type FailureCallbackInfo = {
     state?: "CALLBACK_FAIL" | "CALLBACK_SUCCESS" | "CALLBACK_INPROGRESS";
@@ -491,8 +502,12 @@ type DLQMessage = {
      * status of the failure callback
      */
     failureCallbackInfo?: FailureCallbackInfo;
+    /**
+     * label passed when triggering workflow
+     */
+    label?: string;
 };
-type PublicDLQMessage = Pick<DLQMessage, "header" | "body" | "maxRetries" | "notBefore" | "createdAt" | "callerIP" | "workflowRunId" | "workflowCreatedAt" | "workflowUrl" | "responseStatus" | "responseHeader" | "responseBody" | "dlqId" | "failureCallback" | "failureCallbackInfo">;
+type PublicDLQMessage = Pick<DLQMessage, "header" | "body" | "maxRetries" | "notBefore" | "createdAt" | "callerIP" | "workflowRunId" | "workflowCreatedAt" | "workflowUrl" | "responseStatus" | "responseHeader" | "responseBody" | "dlqId" | "failureCallback" | "failureCallbackInfo" | "label">;
 declare class DLQ {
     private client;
     constructor(client: Client$1);
@@ -832,6 +847,7 @@ declare class Client {
         state?: WorkflowRunLog["workflowState"];
         workflowUrl?: WorkflowRunLog["workflowUrl"];
         workflowCreatedAt?: WorkflowRunLog["workflowRunCreatedAt"];
+        label?: WorkflowRunLog["label"];
     }): Promise<WorkflowRunLogs>;
     get dlq(): DLQ;
 }

package/index.js

@@ -99,12 +99,13 @@ var WORKFLOW_URL_HEADER = "Upstash-Workflow-Url";
 var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
 var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
 var WORKFLOW_INVOKE_COUNT_HEADER = "Upstash-Workflow-Invoke-Count";
+var WORKFLOW_LABEL_HEADER = "Upstash-Label";
 var WORKFLOW_PROTOCOL_VERSION = "1";
 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.17";
+var VERSION = "v0.2.18";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -648,6 +649,9 @@ var triggerFirstInvocation = async (params) => {
       if (useJSONContent) {
         headers["content-type"] = "application/json";
       }
+      if (workflowContext.label) {
+        headers[WORKFLOW_LABEL_HEADER] = workflowContext.label;
+      }
       const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
       return {
         headers,
@@ -748,10 +752,11 @@ var recreateUserHeaders = (headers) => {
   const pairs = headers.entries();
   for (const [header, value] of pairs) {
     const headerLowerCase = header.toLowerCase();
-    if (!headerLowerCase.startsWith("upstash-workflow-") && // https://vercel.com/docs/edge-network/headers/request-headers#x-vercel-id
+    const isUserHeader = !headerLowerCase.startsWith("upstash-workflow-") && // https://vercel.com/docs/edge-network/headers/request-headers#x-vercel-id
     !headerLowerCase.startsWith("x-vercel-") && !headerLowerCase.startsWith("x-forwarded-") && // https://blog.cloudflare.com/preventing-request-loops-using-cdn-loop/
     headerLowerCase !== "cf-connecting-ip" && headerLowerCase !== "cdn-loop" && headerLowerCase !== "cf-ew-via" && headerLowerCase !== "cf-ray" && // For Render https://render.com
-    headerLowerCase !== "render-proxy-ttl") {
+    headerLowerCase !== "render-proxy-ttl" || headerLowerCase === WORKFLOW_LABEL_HEADER.toLocaleLowerCase();
+    if (isUserHeader) {
       filteredHeaders.append(header, value);
     }
   }
@@ -2745,6 +2750,22 @@ var WorkflowContext = class {
    * and number of requests per second with the same key.
    */
   flowControl;
+  /**
+   * Label to apply to the workflow run.
+   *
+   * Can be used to filter the workflow run logs.
+   *
+   * Can be set by passing a `label` parameter when triggering the workflow
+   * with `client.trigger`:
+   *
+   * ```ts
+   * await client.trigger({
+   *   url: "https://workflow-endpoint.com",
+   *   label: "my-label"
+   * });
+   * ```
+   */
+  label;
   constructor({
     qstashClient,
     workflowRunId,
@@ -2759,7 +2780,8 @@ var WorkflowContext = class {
     retryDelay,
     telemetry,
     invokeCount,
-    flowControl
+    flowControl,
+    label
   }) {
     this.qstashClient = qstashClient;
     this.workflowRunId = workflowRunId;
@@ -2772,6 +2794,7 @@ var WorkflowContext = class {
     this.retries = retries ?? DEFAULT_RETRIES;
     this.retryDelay = retryDelay;
     this.flowControl = flowControl;
+    this.label = label;
     this.executor = new AutoExecutor(this, this.steps, telemetry, invokeCount, debug);
   }
   /**
@@ -3072,7 +3095,8 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
       env: context.env,
       retries: context.retries,
       retryDelay: context.retryDelay,
-      flowControl: context.flowControl
+      flowControl: context.flowControl,
+      label: context.label
     });
     try {
       await routeFunction(disabledContext);
@@ -3249,11 +3273,12 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
     if (!errorMessage) {
       errorMessage = `Couldn't parse 'failResponse' in 'failureFunction', received: '${decodedBody}'`;
     }
+    const userHeaders = recreateUserHeaders(request.headers);
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
       initialPayload: sourceBody ? initialPayloadParser(decodeBase64(sourceBody)) : void 0,
-      headers: recreateUserHeaders(request.headers),
+      headers: userHeaders,
       steps: [],
       url,
       failureUrl: url,
@@ -3262,8 +3287,9 @@ var handleFailure = async (request, requestPayload, qstashClient, initialPayload
       retries,
       retryDelay,
       flowControl,
-      telemetry: void 0
+      telemetry: void 0,
       // not going to make requests in authentication check
+      label: userHeaders.get(WORKFLOW_LABEL_HEADER) ?? void 0
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,
@@ -3472,6 +3498,7 @@ var serveBase = (routeFunction, telemetry, options) => {
       });
     }
     const invokeCount = Number(request.headers.get(WORKFLOW_INVOKE_COUNT_HEADER) ?? "0");
+    const label = request.headers.get(WORKFLOW_LABEL_HEADER) ?? void 0;
     const workflowContext = new WorkflowContext({
       qstashClient,
       workflowRunId,
@@ -3486,7 +3513,8 @@ var serveBase = (routeFunction, telemetry, options) => {
       retryDelay,
       telemetry,
       invokeCount,
-      flowControl
+      flowControl,
+      label
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,
@@ -3832,7 +3860,10 @@ var Client4 = class {
       const context = new WorkflowContext({
         qstashClient: this.client,
         // @ts-expect-error header type mismatch because of bun
-        headers: new Headers(option.headers ?? {}),
+        headers: new Headers({
+          ...option.headers ?? {},
+          ...option.label ? { [WORKFLOW_LABEL_HEADER]: option.label } : {}
+        }),
         initialPayload: option.body,
         steps: [],
         url: option.url,
@@ -3841,7 +3872,8 @@ var Client4 = class {
         retryDelay: option.retryDelay,
         telemetry: { sdk: SDK_TELEMETRY },
         flowControl: option.flowControl,
-        failureUrl
+        failureUrl,
+        label: option.label
       });
       return {
         workflowContext: context,
@@ -3907,6 +3939,9 @@ var Client4 = class {
     if (workflowCreatedAt) {
       urlParams.append("workflowCreatedAt", workflowCreatedAt.toString());
     }
+    if (params?.label) {
+      urlParams.append("label", params.label);
+    }
     const result = await this.client.http.request({
       path: ["v2", "workflows", `events?${urlParams.toString()}`]
     });

package/index.mjs

@@ -1,6 +1,7 @@
 import {
   SDK_TELEMETRY,
   StepTypes,
+  WORKFLOW_LABEL_HEADER,
   WorkflowAbort,
   WorkflowContext,
   WorkflowError,
@@ -13,7 +14,7 @@ import {
   prepareFlowControl,
   serve,
   triggerFirstInvocation
-} from "./chunk-RP7G4UD5.mjs";
+} from "./chunk-EHL7SSJF.mjs";
 
 // src/client/index.ts
 import { Client as QStashClient } from "@upstash/qstash";
@@ -246,7 +247,10 @@ var Client = class {
       const context = new WorkflowContext({
         qstashClient: this.client,
         // @ts-expect-error header type mismatch because of bun
-        headers: new Headers(option.headers ?? {}),
+        headers: new Headers({
+          ...option.headers ?? {},
+          ...option.label ? { [WORKFLOW_LABEL_HEADER]: option.label } : {}
+        }),
         initialPayload: option.body,
         steps: [],
         url: option.url,
@@ -255,7 +259,8 @@ var Client = class {
         retryDelay: option.retryDelay,
         telemetry: { sdk: SDK_TELEMETRY },
         flowControl: option.flowControl,
-        failureUrl
+        failureUrl,
+        label: option.label
       });
       return {
         workflowContext: context,
@@ -321,6 +326,9 @@ var Client = class {
     if (workflowCreatedAt) {
       urlParams.append("workflowCreatedAt", workflowCreatedAt.toString());
     }
+    if (params?.label) {
+      urlParams.append("label", params.label);
+    }
     const result = await this.client.http.request({
       path: ["v2", "workflows", `events?${urlParams.toString()}`]
     });

package/nextjs.d.mts

@@ -1,6 +1,6 @@
 import { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
-import { R as RouteFunction, n as PublicServeOptions, x as InvokableWorkflow } from './types--R_3XZXz.mjs';
-import { s as serveManyBase } from './serve-many-DgDSOvQs.mjs';
+import { R as RouteFunction, n as PublicServeOptions, x as InvokableWorkflow } from './types-B7_5AkKQ.mjs';
+import { s as serveManyBase } from './serve-many-CEUYWQvV.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/nextjs.d.ts

@@ -1,6 +1,6 @@
 import { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
-import { R as RouteFunction, n as PublicServeOptions, x as InvokableWorkflow } from './types--R_3XZXz.js';
-import { s as serveManyBase } from './serve-many-B3DfoTFt.js';
+import { R as RouteFunction, n as PublicServeOptions, x as InvokableWorkflow } from './types-B7_5AkKQ.js';
+import { s as serveManyBase } from './serve-many-BObe3pdI.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';