@upstash/workflow 0.2.14 → 0.2.15

package/svelte.js

@@ -91,7 +91,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.14";
+var VERSION = "v0.2.15";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -129,6 +129,16 @@ var WorkflowAbort = class extends Error {
     this.cancelWorkflow = cancelWorkflow;
   }
 };
+var WorkflowNonRetryableError = class extends WorkflowAbort {
+  /**
+   * @param message error message to be displayed
+   */
+  constructor(message) {
+    super("fail", void 0, false);
+    this.name = "WorkflowNonRetryableError";
+    if (message) this.message = message;
+  }
+};
 var formatWorkflowError = (error) => {
   return error instanceof Error ? {
     error: error.name,
@@ -693,6 +703,8 @@ var triggerRouteFunction = async ({
       return ok("workflow-was-finished");
     } else if (!(error_ instanceof WorkflowAbort)) {
       return err(error_);
+    } else if (error_ instanceof WorkflowNonRetryableError) {
+      return ok(error_);
     } else if (error_.cancelWorkflow) {
       await onCancel();
       return ok("workflow-finished");
@@ -854,7 +866,7 @@ ${atob(callbackMessage.body ?? "")}`
 var getTelemetryHeaders = (telemetry2) => {
   return {
     [TELEMETRY_HEADER_SDK]: telemetry2.sdk,
-    [TELEMETRY_HEADER_FRAMEWORK]: telemetry2.framework,
+    [TELEMETRY_HEADER_FRAMEWORK]: telemetry2.framework ?? "unknown",
     [TELEMETRY_HEADER_RUNTIME]: telemetry2.runtime ?? "unknown"
   };
 };
@@ -2966,10 +2978,10 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
     throw new WorkflowAbort(_DisabledWorkflowContext.disabledMessage);
   }
   /**
-   * overwrite cancel method to do nothing
+   * overwrite cancel method to throw WorkflowAbort with the disabledMessage
    */
   async cancel() {
-    return;
+    throw new WorkflowAbort(_DisabledWorkflowContext.disabledMessage);
   }
   /**
    * copies the passed context to create a DisabledWorkflowContext. Then, runs the
@@ -3001,7 +3013,7 @@ var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowCon
     try {
       await routeFunction(disabledContext);
     } catch (error) {
-      if (error instanceof WorkflowAbort && error.stepName === this.disabledMessage) {
+      if (error instanceof WorkflowAbort && error.stepName === this.disabledMessage || error instanceof WorkflowNonRetryableError) {
         return ok("step-found");
       }
       return err(error);
@@ -3222,6 +3234,13 @@ var processOptions = (options) => {
             status: 400
           }
         );
+      } else if (finishCondition instanceof WorkflowNonRetryableError) {
+        return new Response(JSON.stringify(formatWorkflowError(finishCondition)), {
+          headers: {
+            "Upstash-NonRetryable-Error": "true"
+          },
+          status: 489
+        });
       }
       return new Response(JSON.stringify({ workflowRunId }), {
         status: 200
@@ -3414,6 +3433,9 @@ var serveBase = (routeFunction, telemetry2, options) => {
         },
         debug
       });
+      if (result.isOk() && result.value instanceof WorkflowNonRetryableError) {
+        return onStepFinish(workflowRunId, result.value);
+      }
       if (result.isErr()) {
         await debug?.log("ERROR", "ERROR", { error: result.error.message });
         throw result.error;

package/svelte.mjs

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

package/{types-C1WIgVLA.d.ts → types-Dd-3bPoU.d.mts}

@@ -1,9 +1,44 @@
-import { PublishRequest, FlowControl, Client, Receiver, HTTPMethods as HTTPMethods$1 } from '@upstash/qstash';
+import { QstashError, PublishRequest, FlowControl, Client, Receiver, HTTPMethods as HTTPMethods$1 } from '@upstash/qstash';
 import { ZodType, z } from 'zod';
 import * as ai from 'ai';
 import { CoreTool, generateText } from 'ai';
 import { createOpenAI } from '@ai-sdk/openai';
 
+/**
+ * Error raised during Workflow execution
+ */
+declare class WorkflowError extends QstashError {
+    constructor(message: string);
+}
+/**
+ * Raised when the workflow executes a function successfully
+ * and aborts to end the execution
+ */
+declare class WorkflowAbort extends Error {
+    stepInfo?: Step;
+    stepName: string;
+    /**
+     * whether workflow is to be canceled on abort
+     */
+    cancelWorkflow: boolean;
+    /**
+     *
+     * @param stepName name of the aborting step
+     * @param stepInfo step information
+     * @param cancelWorkflow
+     */
+    constructor(stepName: string, stepInfo?: Step, cancelWorkflow?: boolean);
+}
+/**
+ * Raised when the workflow is failed due to a non-retryable error
+ */
+declare class WorkflowNonRetryableError extends WorkflowAbort {
+    /**
+     * @param message error message to be displayed
+     */
+    constructor(message?: string);
+}
+
 declare const LOG_LEVELS: readonly ["DEBUG", "INFO", "SUBMIT", "WARN", "ERROR"];
 type LogLevel = (typeof LOG_LEVELS)[number];
 type ChatLogEntry = {
@@ -1133,7 +1168,7 @@ type AsyncStepFunction<TResult> = () => Promise<TResult>;
 type StepFunction<TResult> = AsyncStepFunction<TResult> | SyncStepFunction<TResult>;
 type ParallelCallState = "first" | "partial" | "discard" | "last";
 type RouteFunction<TInitialPayload, TResult = unknown> = (context: WorkflowContext<TInitialPayload>) => Promise<TResult>;
-type FinishCondition = "success" | "duplicate-step" | "fromCallback" | "auth-fail" | "failure-callback" | "workflow-already-ended";
+type FinishCondition = "success" | "duplicate-step" | "fromCallback" | "auth-fail" | "failure-callback" | "workflow-already-ended" | WorkflowNonRetryableError;
 type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload = unknown> = ValidationOptions<TInitialPayload> & {
     /**
      * QStash client
@@ -1260,7 +1295,7 @@ type Telemetry = {
     /**
      * platform (such as nextjs/cloudflare)
      */
-    framework: string;
+    framework?: string;
     /**
      * node version
      */
@@ -1470,4 +1505,4 @@ type InvokableWorkflow<TInitialPayload, TResult> = {
     workflowId?: string;
 };
 
-export { type AsyncStepFunction as A, type CallResponse as C, type Duration as D, type ExclusiveValidationOptions as E, type FinishCondition as F, type HeaderParams as H, type InvokeWorkflowRequest as I, type LazyInvokeStepParams as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, type Step as c, WorkflowTool as d, WorkflowContext as e, type WorkflowClient as f, type WorkflowReceiver as g, StepTypes as h, type SyncStepFunction as i, type StepFunction as j, type PublicServeOptions as k, type FailureFunctionPayload as l, type RequiredExceptFields as m, type WaitRequest as n, type WaitStepResponse as o, type NotifyStepResponse as p, type WaitEventOptions as q, type CallSettings as r, type InvokeStepResponse as s, type InvokableWorkflow as t, type LogLevel as u, type WorkflowLoggerOptions as v, WorkflowLogger as w };
+export { type AsyncStepFunction as A, type CallResponse as C, type Duration as D, type ExclusiveValidationOptions as E, type FinishCondition as F, type HeaderParams as H, type InvokeWorkflowRequest as I, type LazyInvokeStepParams as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, WorkflowError as c, WorkflowAbort as d, WorkflowNonRetryableError as e, WorkflowTool as f, WorkflowContext as g, type WorkflowClient as h, type WorkflowReceiver as i, StepTypes as j, type Step as k, type SyncStepFunction as l, type StepFunction as m, type PublicServeOptions as n, type FailureFunctionPayload as o, type RequiredExceptFields as p, type WaitRequest as q, type WaitStepResponse as r, type NotifyStepResponse as s, type WaitEventOptions as t, type CallSettings as u, type InvokeStepResponse as v, type InvokableWorkflow as w, type LogLevel as x, type WorkflowLoggerOptions as y, WorkflowLogger as z };

package/{types-C1WIgVLA.d.mts → types-Dd-3bPoU.d.ts}

@@ -1,9 +1,44 @@
-import { PublishRequest, FlowControl, Client, Receiver, HTTPMethods as HTTPMethods$1 } from '@upstash/qstash';
+import { QstashError, PublishRequest, FlowControl, Client, Receiver, HTTPMethods as HTTPMethods$1 } from '@upstash/qstash';
 import { ZodType, z } from 'zod';
 import * as ai from 'ai';
 import { CoreTool, generateText } from 'ai';
 import { createOpenAI } from '@ai-sdk/openai';
 
+/**
+ * Error raised during Workflow execution
+ */
+declare class WorkflowError extends QstashError {
+    constructor(message: string);
+}
+/**
+ * Raised when the workflow executes a function successfully
+ * and aborts to end the execution
+ */
+declare class WorkflowAbort extends Error {
+    stepInfo?: Step;
+    stepName: string;
+    /**
+     * whether workflow is to be canceled on abort
+     */
+    cancelWorkflow: boolean;
+    /**
+     *
+     * @param stepName name of the aborting step
+     * @param stepInfo step information
+     * @param cancelWorkflow
+     */
+    constructor(stepName: string, stepInfo?: Step, cancelWorkflow?: boolean);
+}
+/**
+ * Raised when the workflow is failed due to a non-retryable error
+ */
+declare class WorkflowNonRetryableError extends WorkflowAbort {
+    /**
+     * @param message error message to be displayed
+     */
+    constructor(message?: string);
+}
+
 declare const LOG_LEVELS: readonly ["DEBUG", "INFO", "SUBMIT", "WARN", "ERROR"];
 type LogLevel = (typeof LOG_LEVELS)[number];
 type ChatLogEntry = {
@@ -1133,7 +1168,7 @@ type AsyncStepFunction<TResult> = () => Promise<TResult>;
 type StepFunction<TResult> = AsyncStepFunction<TResult> | SyncStepFunction<TResult>;
 type ParallelCallState = "first" | "partial" | "discard" | "last";
 type RouteFunction<TInitialPayload, TResult = unknown> = (context: WorkflowContext<TInitialPayload>) => Promise<TResult>;
-type FinishCondition = "success" | "duplicate-step" | "fromCallback" | "auth-fail" | "failure-callback" | "workflow-already-ended";
+type FinishCondition = "success" | "duplicate-step" | "fromCallback" | "auth-fail" | "failure-callback" | "workflow-already-ended" | WorkflowNonRetryableError;
 type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload = unknown> = ValidationOptions<TInitialPayload> & {
     /**
      * QStash client
@@ -1260,7 +1295,7 @@ type Telemetry = {
     /**
      * platform (such as nextjs/cloudflare)
      */
-    framework: string;
+    framework?: string;
     /**
      * node version
      */
@@ -1470,4 +1505,4 @@ type InvokableWorkflow<TInitialPayload, TResult> = {
     workflowId?: string;
 };
 
-export { type AsyncStepFunction as A, type CallResponse as C, type Duration as D, type ExclusiveValidationOptions as E, type FinishCondition as F, type HeaderParams as H, type InvokeWorkflowRequest as I, type LazyInvokeStepParams as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, type Step as c, WorkflowTool as d, WorkflowContext as e, type WorkflowClient as f, type WorkflowReceiver as g, StepTypes as h, type SyncStepFunction as i, type StepFunction as j, type PublicServeOptions as k, type FailureFunctionPayload as l, type RequiredExceptFields as m, type WaitRequest as n, type WaitStepResponse as o, type NotifyStepResponse as p, type WaitEventOptions as q, type CallSettings as r, type InvokeStepResponse as s, type InvokableWorkflow as t, type LogLevel as u, type WorkflowLoggerOptions as v, WorkflowLogger as w };
+export { type AsyncStepFunction as A, type CallResponse as C, type Duration as D, type ExclusiveValidationOptions as E, type FinishCondition as F, type HeaderParams as H, type InvokeWorkflowRequest as I, type LazyInvokeStepParams as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, WorkflowError as c, WorkflowAbort as d, WorkflowNonRetryableError as e, WorkflowTool as f, WorkflowContext as g, type WorkflowClient as h, type WorkflowReceiver as i, StepTypes as j, type Step as k, type SyncStepFunction as l, type StepFunction as m, type PublicServeOptions as n, type FailureFunctionPayload as o, type RequiredExceptFields as p, type WaitRequest as q, type WaitStepResponse as r, type NotifyStepResponse as s, type WaitEventOptions as t, type CallSettings as u, type InvokeStepResponse as v, type InvokableWorkflow as w, type LogLevel as x, type WorkflowLoggerOptions as y, WorkflowLogger as z };