@upstash/workflow 1.3.0 → 1.3.1

package/tanstack.js

@@ -216,6 +216,31 @@ var import_qstash4 = require("@upstash/qstash");
 // src/utils.ts
 var NANOID_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_";
 var NANOID_LENGTH = 21;
+var RESOURCE_NAME_PATTERN = /^[a-zA-Z0-9\-_.]+$/;
+function validateLabel(label) {
+  if (label === void 0) return;
+  const labels = Array.isArray(label) ? label : [label];
+  if (labels.length === 0) {
+    throw new WorkflowNonRetryableError("Invalid label: label array must not be empty.");
+  }
+  for (const value of labels) {
+    if (!RESOURCE_NAME_PATTERN.test(value)) {
+      throw new WorkflowNonRetryableError(
+        `Invalid label "${value}": must be alphanumeric, hyphen, underscore, or period.`
+      );
+    }
+  }
+}
+function serializeLabel(label) {
+  return Array.isArray(label) ? label.join(",") : label;
+}
+function validateFlowControl(flowControl) {
+  if (flowControl?.key !== void 0 && !RESOURCE_NAME_PATTERN.test(flowControl.key)) {
+    throw new WorkflowNonRetryableError(
+      `Invalid flow control key "${flowControl.key}": must be alphanumeric, hyphen, underscore, or period.`
+    );
+  }
+}
 function getRandomInt() {
   return Math.floor(Math.random() * NANOID_CHARS.length);
 }
@@ -751,8 +776,8 @@ var triggerFirstInvocation = async (params) => {
       if (unknownSdk) {
         headers[WORKFLOW_UNKOWN_SDK_TRIGGER_HEADER] = "true";
       }
-      if (workflowContext.label) {
-        headers[WORKFLOW_LABEL_HEADER] = workflowContext.label;
+      if (workflowContext.labels.length > 0) {
+        headers[WORKFLOW_LABEL_HEADER] = serializeLabel(workflowContext.labels);
       }
       const body = typeof workflowContext.requestPayload === "string" ? workflowContext.requestPayload : JSON.stringify(workflowContext.requestPayload);
       return {
@@ -1554,8 +1579,9 @@ var LazyInvokeStep = class extends BaseLazyStep {
     });
     triggerHeaders["Upstash-Workflow-Invoke"] = "true";
     if (label) {
-      triggerHeaders[WORKFLOW_LABEL_HEADER] = label;
-      triggerHeaders[`upstash-forward-${WORKFLOW_LABEL_HEADER}`] = label;
+      const labelHeader = serializeLabel(label);
+      triggerHeaders[WORKFLOW_LABEL_HEADER] = labelHeader;
+      triggerHeaders[`upstash-forward-${WORKFLOW_LABEL_HEADER}`] = labelHeader;
     }
     return { headers: triggerHeaders, contentType };
   }
@@ -2696,9 +2722,10 @@ var WorkflowContext = class {
    */
   env;
   /**
-   * Label to apply to the workflow run.
+   * Labels attached to the workflow run.
    *
-   * Can be used to filter the workflow run logs.
+   * Can be used to filter the workflow run logs. A run can have multiple
+   * labels when triggered with `label: string[]`.
    *
    * Can be set by passing a `label` parameter when triggering the workflow
    * with `client.trigger`:
@@ -2706,11 +2733,20 @@ var WorkflowContext = class {
    * ```ts
    * await client.trigger({
    *   url: "https://workflow-endpoint.com",
-   *   label: "my-label"
+   *   label: ["label-1", "label-2"]
    * });
    * ```
    */
-  label;
+  labels;
+  /**
+   * Label of the workflow run.
+   *
+   * @deprecated Use `labels` instead. When a run has multiple labels, this
+   *   only returns the first one.
+   */
+  get label() {
+    return this.labels[0];
+  }
   /**
    * Number of times QStash has retried delivering the current request.
    *
@@ -2741,7 +2777,7 @@ var WorkflowContext = class {
     this.headers = headers;
     this.requestPayload = initialPayload;
     this.env = env ?? {};
-    this.label = label;
+    this.labels = label === void 0 ? [] : Array.isArray(label) ? label : label ? label.split(",") : [];
     this.retried = retried ?? 0;
     const middlewareManagerInstance = middlewareManager ?? new MiddlewareManager([]);
     middlewareManagerInstance.assignContext(this);
@@ -2822,8 +2858,10 @@ var WorkflowContext = class {
     await this.addStep(new LazySleepUntilStep(this, stepName, time));
   }
   async call(stepName, settings) {
+    validateFlowControl(settings.flowControl);
     let callStep;
     if ("workflow" in settings) {
+      validateLabel(settings.label);
       const url = getNewUrlFromWorkflowId(this.url, settings.workflow.workflowId);
       const stringBody = typeof settings.body === "string" ? settings.body : settings.body === void 0 ? void 0 : JSON.stringify(settings.body);
       callStep = new LazyCallStep({
@@ -2931,6 +2969,8 @@ var WorkflowContext = class {
     );
   }
   async invoke(stepName, settings) {
+    validateLabel(settings.label);
+    validateFlowControl(settings.flowControl);
     return await this.addStep(
       new LazyInvokeStep(this, stepName, settings)
     );
@@ -3016,7 +3056,7 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
       url: context.url,
       initialPayload: context.requestPayload,
       env: context.env,
-      label: context.label,
+      label: context.labels,
       retried: context.retried
     });
     try {

package/tanstack.mjs

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

package/{types-B_E1VAK6.d.ts → types-CekOpKvz.d.mts}

@@ -685,9 +685,10 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      */
     readonly env: Record<string, string | undefined>;
     /**
-     * Label to apply to the workflow run.
+     * Labels attached to the workflow run.
      *
-     * Can be used to filter the workflow run logs.
+     * Can be used to filter the workflow run logs. A run can have multiple
+     * labels when triggered with `label: string[]`.
      *
      * Can be set by passing a `label` parameter when triggering the workflow
      * with `client.trigger`:
@@ -695,11 +696,18 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * ```ts
      * await client.trigger({
      *   url: "https://workflow-endpoint.com",
-     *   label: "my-label"
+     *   label: ["label-1", "label-2"]
      * });
      * ```
      */
-    readonly label?: string;
+    readonly labels: string[];
+    /**
+     * Label of the workflow run.
+     *
+     * @deprecated Use `labels` instead. When a run has multiple labels, this
+     *   only returns the first one.
+     */
+    get label(): string | undefined;
     /**
      * Number of times QStash has retried delivering the current request.
      *
@@ -718,7 +726,7 @@ declare class WorkflowContext<TInitialPayload = unknown> {
         env?: Record<string, string | undefined>;
         telemetry?: Telemetry;
         invokeCount?: number;
-        label?: string;
+        label?: string | string[];
         retried?: number;
         middlewareManager?: MiddlewareManager<TInitialPayload>;
     });
@@ -1311,7 +1319,7 @@ type InvokeWorkflowRequest = {
 type LazyInvokeStepParams<TInitiaPayload, TResult> = {
     workflow: InvokableWorkflow<TInitiaPayload, TResult>;
     workflowRunId?: string;
-    label?: string;
+    label?: string | string[];
 } & Pick<CallSettings, "retries" | "headers" | "flowControl" | "retryDelay"> & (TInitiaPayload extends undefined ? {
     body?: undefined;
 } : {

package/{types-B_E1VAK6.d.mts → types-CekOpKvz.d.ts}

@@ -685,9 +685,10 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      */
     readonly env: Record<string, string | undefined>;
     /**
-     * Label to apply to the workflow run.
+     * Labels attached to the workflow run.
      *
-     * Can be used to filter the workflow run logs.
+     * Can be used to filter the workflow run logs. A run can have multiple
+     * labels when triggered with `label: string[]`.
      *
      * Can be set by passing a `label` parameter when triggering the workflow
      * with `client.trigger`:
@@ -695,11 +696,18 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * ```ts
      * await client.trigger({
      *   url: "https://workflow-endpoint.com",
-     *   label: "my-label"
+     *   label: ["label-1", "label-2"]
      * });
      * ```
      */
-    readonly label?: string;
+    readonly labels: string[];
+    /**
+     * Label of the workflow run.
+     *
+     * @deprecated Use `labels` instead. When a run has multiple labels, this
+     *   only returns the first one.
+     */
+    get label(): string | undefined;
     /**
      * Number of times QStash has retried delivering the current request.
      *
@@ -718,7 +726,7 @@ declare class WorkflowContext<TInitialPayload = unknown> {
         env?: Record<string, string | undefined>;
         telemetry?: Telemetry;
         invokeCount?: number;
-        label?: string;
+        label?: string | string[];
         retried?: number;
         middlewareManager?: MiddlewareManager<TInitialPayload>;
     });
@@ -1311,7 +1319,7 @@ type InvokeWorkflowRequest = {
 type LazyInvokeStepParams<TInitiaPayload, TResult> = {
     workflow: InvokableWorkflow<TInitiaPayload, TResult>;
     workflowRunId?: string;
-    label?: string;
+    label?: string | string[];
 } & Pick<CallSettings, "retries" | "headers" | "flowControl" | "retryDelay"> & (TInitiaPayload extends undefined ? {
     body?: undefined;
 } : {