@voltagent/core 1.1.15 → 1.1.16

package/dist/index.d.mts

@@ -655,7 +655,7 @@ interface WorkflowStateEntry {
     /** Workflow name for reference */
     workflowName: string;
     /** Current status */
-    status: "running" | "suspended" | "completed" | "error";
+    status: "running" | "suspended" | "completed" | "cancelled" | "error";
     /** Original input to the workflow */
     input?: unknown;
     /** Execution context */
@@ -3579,7 +3579,7 @@ declare class Agent {
     private createWorkingMemoryTools;
 }
 
-type WorkflowStateStatus = "pending" | "running" | "completed" | "failed" | "suspended";
+type WorkflowStateStatus = "pending" | "running" | "completed" | "failed" | "suspended" | "cancelled";
 type WorkflowState<INPUT, RESULT> = {
     executionId: string;
     conversationId?: string;
@@ -3598,6 +3598,8 @@ type WorkflowState<INPUT, RESULT> = {
     error: Error | null;
     /** suspension metadata when workflow is suspended */
     suspension?: WorkflowSuspensionMetadata;
+    /** cancellation metadata when workflow is cancelled */
+    cancellation?: WorkflowCancellationMetadata;
     /** accumulated usage from andAgent calls */
     usage: UsageInfo;
 };
@@ -3621,6 +3623,12 @@ interface WorkflowSuspensionMetadata<SUSPEND_DATA = DangerouslyAllowAny> {
         completedStepsData?: DangerouslyAllowAny[];
     };
 }
+interface WorkflowCancellationMetadata {
+    /** Timestamp when the workflow was cancelled */
+    cancelledAt: Date;
+    /** Reason for cancellation */
+    reason?: string;
+}
 /**
  * Custom abort controller for workflow suspension with reason tracking
  */
@@ -3633,14 +3641,26 @@ interface WorkflowSuspendController {
      * Suspend the workflow with a reason
      */
     suspend: (reason?: string) => void;
+    /**
+     * Cancel the workflow with a reason
+     */
+    cancel: (reason?: string) => void;
     /**
      * Check if the workflow has been suspended
      */
     isSuspended: () => boolean;
     /**
-     * Get the suspension reason
+     * Check if the workflow has been cancelled
+     */
+    isCancelled: () => boolean;
+    /**
+     * Get the suspension or cancellation reason
      */
     getReason: () => string | undefined;
+    /**
+     * Get the cancellation reason if cancellation was requested
+     */
+    getCancelReason: () => string | undefined;
 }
 /**
  * Base result interface shared by all workflow execution results
@@ -3665,7 +3685,7 @@ interface WorkflowExecutionResultBase<RESULT_SCHEMA extends z.ZodTypeAny, RESUME
     /**
      * Current status of the workflow execution
      */
-    status: "completed" | "suspended" | "error" | Promise<"completed" | "suspended" | "error">;
+    status: "completed" | "suspended" | "cancelled" | "error" | Promise<"completed" | "suspended" | "cancelled" | "error">;
     /**
      * The result data if workflow completed successfully
      */
@@ -3674,6 +3694,10 @@ interface WorkflowExecutionResultBase<RESULT_SCHEMA extends z.ZodTypeAny, RESUME
      * Suspension metadata if workflow was suspended
      */
     suspension?: WorkflowSuspensionMetadata | Promise<WorkflowSuspensionMetadata | undefined>;
+    /**
+     * Cancellation metadata if workflow was cancelled
+     */
+    cancellation?: WorkflowCancellationMetadata | Promise<WorkflowCancellationMetadata | undefined>;
     /**
      * Error information if workflow failed
      */
@@ -3688,9 +3712,10 @@ interface WorkflowExecutionResultBase<RESULT_SCHEMA extends z.ZodTypeAny, RESUME
  */
 interface WorkflowExecutionResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCHEMA extends z.ZodTypeAny = z.ZodAny> extends WorkflowExecutionResultBase<RESULT_SCHEMA, RESUME_SCHEMA> {
     endAt: Date;
-    status: "completed" | "suspended" | "error";
+    status: "completed" | "suspended" | "cancelled" | "error";
     result: z.infer<RESULT_SCHEMA> | null;
     suspension?: WorkflowSuspensionMetadata;
+    cancellation?: WorkflowCancellationMetadata;
     error?: unknown;
     usage: UsageInfo;
     /**
@@ -3709,9 +3734,10 @@ interface WorkflowExecutionResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCH
  */
 interface WorkflowStreamResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCHEMA extends z.ZodTypeAny = z.ZodAny> extends WorkflowExecutionResultBase<RESULT_SCHEMA, RESUME_SCHEMA>, AsyncIterable<WorkflowStreamEvent> {
     endAt: Promise<Date>;
-    status: Promise<"completed" | "suspended" | "error">;
+    status: Promise<"completed" | "suspended" | "cancelled" | "error">;
     result: Promise<z.infer<RESULT_SCHEMA> | null>;
     suspension: Promise<WorkflowSuspensionMetadata | undefined>;
+    cancellation: Promise<WorkflowCancellationMetadata | undefined>;
     error: Promise<unknown | undefined>;
     usage: Promise<UsageInfo>;
     /**
@@ -3723,6 +3749,14 @@ interface WorkflowStreamResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCHEMA
     resume: (input: z.infer<RESUME_SCHEMA>, options?: {
         stepId?: string;
     }) => Promise<WorkflowStreamResult<RESULT_SCHEMA, RESUME_SCHEMA>>;
+    /**
+     * Request workflow suspension
+     */
+    suspend: (reason?: string) => void;
+    /**
+     * Cancel the workflow execution
+     */
+    cancel: (reason?: string) => void;
     /**
      * Abort the workflow execution
      */
@@ -4018,7 +4052,7 @@ interface WorkflowStreamEvent {
     /**
      * Current status of the step/event
      */
-    status: "pending" | "running" | "success" | "error" | "suspended";
+    status: "pending" | "running" | "success" | "error" | "suspended" | "cancelled";
     /**
      * User context passed through the workflow
      */
@@ -4124,6 +4158,10 @@ declare class WorkflowTraceContext {
      * Record a suspension event on the workflow
      */
     recordSuspension(stepIndex: number, reason: string, suspendData?: any, checkpoint?: any): void;
+    /**
+     * Record a cancellation event on the workflow
+     */
+    recordCancellation(reason?: string): void;
     /**
      * Record a resume event on the workflow
      */
@@ -4147,16 +4185,17 @@ declare class WorkflowTraceContext {
     /**
      * End the root span with a status
      */
-    end(status: "completed" | "suspended" | "error", error?: Error | any): void;
+    end(status: "completed" | "suspended" | "cancelled" | "error", error?: Error | any): void;
     /**
      * End a step span with proper status
      */
-    endStepSpan(span: Span, status: "completed" | "skipped" | "suspended" | "error", options?: {
+    endStepSpan(span: Span, status: "completed" | "skipped" | "suspended" | "cancelled" | "error", options?: {
         output?: any;
         error?: Error | any;
         attributes?: Record<string, any>;
         skippedReason?: string;
         suspensionReason?: string;
+        cancellationReason?: string;
     }): void;
     /**
      * Get the active context for manual context propagation
@@ -5382,16 +5421,7 @@ declare class WorkflowRegistry extends EventEmitter {
     /**
      * Resume a suspended workflow execution
      */
-    resumeSuspendedWorkflow(workflowId: string, executionId: string, resumeData?: any, resumeStepId?: string): Promise<{
-        executionId: string;
-        startAt: Date;
-        endAt: Date;
-        status: "completed" | "suspended" | "error";
-        result: any;
-        usage: UsageInfo;
-        suspension?: any;
-        error?: unknown;
-    } | null>;
+    resumeSuspendedWorkflow(workflowId: string, executionId: string, resumeData?: any, resumeStepId?: string): Promise<WorkflowExecutionResult<any, any> | null>;
     /**
      * Get all suspended workflow executions
      */

package/dist/index.d.ts

@@ -655,7 +655,7 @@ interface WorkflowStateEntry {
     /** Workflow name for reference */
     workflowName: string;
     /** Current status */
-    status: "running" | "suspended" | "completed" | "error";
+    status: "running" | "suspended" | "completed" | "cancelled" | "error";
     /** Original input to the workflow */
     input?: unknown;
     /** Execution context */
@@ -3579,7 +3579,7 @@ declare class Agent {
     private createWorkingMemoryTools;
 }
 
-type WorkflowStateStatus = "pending" | "running" | "completed" | "failed" | "suspended";
+type WorkflowStateStatus = "pending" | "running" | "completed" | "failed" | "suspended" | "cancelled";
 type WorkflowState<INPUT, RESULT> = {
     executionId: string;
     conversationId?: string;
@@ -3598,6 +3598,8 @@ type WorkflowState<INPUT, RESULT> = {
     error: Error | null;
     /** suspension metadata when workflow is suspended */
     suspension?: WorkflowSuspensionMetadata;
+    /** cancellation metadata when workflow is cancelled */
+    cancellation?: WorkflowCancellationMetadata;
     /** accumulated usage from andAgent calls */
     usage: UsageInfo;
 };
@@ -3621,6 +3623,12 @@ interface WorkflowSuspensionMetadata<SUSPEND_DATA = DangerouslyAllowAny> {
         completedStepsData?: DangerouslyAllowAny[];
     };
 }
+interface WorkflowCancellationMetadata {
+    /** Timestamp when the workflow was cancelled */
+    cancelledAt: Date;
+    /** Reason for cancellation */
+    reason?: string;
+}
 /**
  * Custom abort controller for workflow suspension with reason tracking
  */
@@ -3633,14 +3641,26 @@ interface WorkflowSuspendController {
      * Suspend the workflow with a reason
      */
     suspend: (reason?: string) => void;
+    /**
+     * Cancel the workflow with a reason
+     */
+    cancel: (reason?: string) => void;
     /**
      * Check if the workflow has been suspended
      */
     isSuspended: () => boolean;
     /**
-     * Get the suspension reason
+     * Check if the workflow has been cancelled
+     */
+    isCancelled: () => boolean;
+    /**
+     * Get the suspension or cancellation reason
      */
     getReason: () => string | undefined;
+    /**
+     * Get the cancellation reason if cancellation was requested
+     */
+    getCancelReason: () => string | undefined;
 }
 /**
  * Base result interface shared by all workflow execution results
@@ -3665,7 +3685,7 @@ interface WorkflowExecutionResultBase<RESULT_SCHEMA extends z.ZodTypeAny, RESUME
     /**
      * Current status of the workflow execution
      */
-    status: "completed" | "suspended" | "error" | Promise<"completed" | "suspended" | "error">;
+    status: "completed" | "suspended" | "cancelled" | "error" | Promise<"completed" | "suspended" | "cancelled" | "error">;
     /**
      * The result data if workflow completed successfully
      */
@@ -3674,6 +3694,10 @@ interface WorkflowExecutionResultBase<RESULT_SCHEMA extends z.ZodTypeAny, RESUME
      * Suspension metadata if workflow was suspended
      */
     suspension?: WorkflowSuspensionMetadata | Promise<WorkflowSuspensionMetadata | undefined>;
+    /**
+     * Cancellation metadata if workflow was cancelled
+     */
+    cancellation?: WorkflowCancellationMetadata | Promise<WorkflowCancellationMetadata | undefined>;
     /**
      * Error information if workflow failed
      */
@@ -3688,9 +3712,10 @@ interface WorkflowExecutionResultBase<RESULT_SCHEMA extends z.ZodTypeAny, RESUME
  */
 interface WorkflowExecutionResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCHEMA extends z.ZodTypeAny = z.ZodAny> extends WorkflowExecutionResultBase<RESULT_SCHEMA, RESUME_SCHEMA> {
     endAt: Date;
-    status: "completed" | "suspended" | "error";
+    status: "completed" | "suspended" | "cancelled" | "error";
     result: z.infer<RESULT_SCHEMA> | null;
     suspension?: WorkflowSuspensionMetadata;
+    cancellation?: WorkflowCancellationMetadata;
     error?: unknown;
     usage: UsageInfo;
     /**
@@ -3709,9 +3734,10 @@ interface WorkflowExecutionResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCH
  */
 interface WorkflowStreamResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCHEMA extends z.ZodTypeAny = z.ZodAny> extends WorkflowExecutionResultBase<RESULT_SCHEMA, RESUME_SCHEMA>, AsyncIterable<WorkflowStreamEvent> {
     endAt: Promise<Date>;
-    status: Promise<"completed" | "suspended" | "error">;
+    status: Promise<"completed" | "suspended" | "cancelled" | "error">;
     result: Promise<z.infer<RESULT_SCHEMA> | null>;
     suspension: Promise<WorkflowSuspensionMetadata | undefined>;
+    cancellation: Promise<WorkflowCancellationMetadata | undefined>;
     error: Promise<unknown | undefined>;
     usage: Promise<UsageInfo>;
     /**
@@ -3723,6 +3749,14 @@ interface WorkflowStreamResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCHEMA
     resume: (input: z.infer<RESUME_SCHEMA>, options?: {
         stepId?: string;
     }) => Promise<WorkflowStreamResult<RESULT_SCHEMA, RESUME_SCHEMA>>;
+    /**
+     * Request workflow suspension
+     */
+    suspend: (reason?: string) => void;
+    /**
+     * Cancel the workflow execution
+     */
+    cancel: (reason?: string) => void;
     /**
      * Abort the workflow execution
      */
@@ -4018,7 +4052,7 @@ interface WorkflowStreamEvent {
     /**
      * Current status of the step/event
      */
-    status: "pending" | "running" | "success" | "error" | "suspended";
+    status: "pending" | "running" | "success" | "error" | "suspended" | "cancelled";
     /**
      * User context passed through the workflow
      */
@@ -4124,6 +4158,10 @@ declare class WorkflowTraceContext {
      * Record a suspension event on the workflow
      */
     recordSuspension(stepIndex: number, reason: string, suspendData?: any, checkpoint?: any): void;
+    /**
+     * Record a cancellation event on the workflow
+     */
+    recordCancellation(reason?: string): void;
     /**
      * Record a resume event on the workflow
      */
@@ -4147,16 +4185,17 @@ declare class WorkflowTraceContext {
     /**
      * End the root span with a status
      */
-    end(status: "completed" | "suspended" | "error", error?: Error | any): void;
+    end(status: "completed" | "suspended" | "cancelled" | "error", error?: Error | any): void;
     /**
      * End a step span with proper status
      */
-    endStepSpan(span: Span, status: "completed" | "skipped" | "suspended" | "error", options?: {
+    endStepSpan(span: Span, status: "completed" | "skipped" | "suspended" | "cancelled" | "error", options?: {
         output?: any;
         error?: Error | any;
         attributes?: Record<string, any>;
         skippedReason?: string;
         suspensionReason?: string;
+        cancellationReason?: string;
     }): void;
     /**
      * Get the active context for manual context propagation
@@ -5382,16 +5421,7 @@ declare class WorkflowRegistry extends EventEmitter {
     /**
      * Resume a suspended workflow execution
      */
-    resumeSuspendedWorkflow(workflowId: string, executionId: string, resumeData?: any, resumeStepId?: string): Promise<{
-        executionId: string;
-        startAt: Date;
-        endAt: Date;
-        status: "completed" | "suspended" | "error";
-        result: any;
-        usage: UsageInfo;
-        suspension?: any;
-        error?: unknown;
-    } | null>;
+    resumeSuspendedWorkflow(workflowId: string, executionId: string, resumeData?: any, resumeStepId?: string): Promise<WorkflowExecutionResult<any, any> | null>;
     /**
      * Get all suspended workflow executions
      */