@voltagent/core 0.1.80 → 0.1.81

package/dist/index.d.mts

@@ -271,7 +271,7 @@ interface WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA> {
     logger: Logger;
     /**
      * Stream writer for emitting events during streaming execution.
-     * Always available for writing custom events.
+     * Always available - uses NoOpWorkflowStreamWriter when not streaming
      */
     writer: WorkflowStreamWriter;
 }
@@ -421,9 +421,9 @@ interface WorkflowSuspendController {
     getReason: () => string | undefined;
 }
 /**
- * Result returned from workflow execution with suspend/resume capabilities
+ * Base result interface shared by all workflow execution results
  */
-interface WorkflowExecutionResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCHEMA extends z.ZodTypeAny = z.ZodAny> {
+interface WorkflowExecutionResultBase<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCHEMA extends z.ZodTypeAny = z.ZodAny> {
     /**
      * Unique execution ID for this workflow run
      */
@@ -439,30 +439,37 @@ interface WorkflowExecutionResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCH
     /**
      * When the workflow execution ended (completed, suspended, or errored)
      */
-    endAt: Date;
+    endAt: Date | Promise<Date>;
     /**
      * Current status of the workflow execution
      */
-    status: "completed" | "suspended" | "error";
+    status: "completed" | "suspended" | "error" | Promise<"completed" | "suspended" | "error">;
     /**
      * The result data if workflow completed successfully
      */
-    result: z.infer<RESULT_SCHEMA> | null;
-    /**
-     * Stream of workflow events for real-time monitoring
-     */
-    stream: AsyncIterableIterator<WorkflowStreamEvent>;
+    result: z.infer<RESULT_SCHEMA> | null | Promise<z.infer<RESULT_SCHEMA> | null>;
     /**
      * Suspension metadata if workflow was suspended
      */
-    suspension?: WorkflowSuspensionMetadata;
+    suspension?: WorkflowSuspensionMetadata | Promise<WorkflowSuspensionMetadata | undefined>;
     /**
      * Error information if workflow failed
      */
-    error?: unknown;
+    error?: unknown | Promise<unknown | undefined>;
     /**
      * Total token usage from all andAgent steps in the workflow
      */
+    usage: UsageInfo | Promise<UsageInfo>;
+}
+/**
+ * Result returned from workflow execution with suspend/resume capabilities
+ */
+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";
+    result: z.infer<RESULT_SCHEMA> | null;
+    suspension?: WorkflowSuspensionMetadata;
+    error?: unknown;
     usage: UsageInfo;
     /**
      * Resume a suspended workflow execution
@@ -474,6 +481,31 @@ interface WorkflowExecutionResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCH
         stepId?: string;
     }) => Promise<WorkflowExecutionResult<RESULT_SCHEMA, RESUME_SCHEMA>>;
 }
+/**
+ * Result returned from workflow stream execution
+ * Extends base with streaming capabilities and promise-based fields
+ */
+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">;
+    result: Promise<z.infer<RESULT_SCHEMA> | null>;
+    suspension: Promise<WorkflowSuspensionMetadata | undefined>;
+    error: Promise<unknown | undefined>;
+    usage: Promise<UsageInfo>;
+    /**
+     * Resume a suspended workflow execution
+     * @param input - Optional new input data for resuming (validated against resumeSchema if provided)
+     * @param options - Optional options for resuming, including stepId to resume from a specific step
+     * @returns A new stream result that can also be resumed if suspended again
+     */
+    resume: (input: z.infer<RESUME_SCHEMA>, options?: {
+        stepId?: string;
+    }) => Promise<WorkflowStreamResult<RESULT_SCHEMA, RESUME_SCHEMA>>;
+    /**
+     * Abort the workflow execution
+     */
+    abort: () => void;
+}
 interface WorkflowRunOptions {
     /**
      * The active step, this can be used to track the current step in a workflow
@@ -666,9 +698,16 @@ type Workflow<INPUT_SCHEMA extends InternalBaseWorkflowInputSchema, RESULT_SCHEM
      * Execute the workflow with the given input
      * @param input - The input to the workflow
      * @param options - Options for the workflow execution
-     * @returns Execution result with stream and final result
+     * @returns Execution result with final result
      */
     run: (input: WorkflowInput<INPUT_SCHEMA>, options?: WorkflowRunOptions) => Promise<WorkflowExecutionResult<RESULT_SCHEMA, RESUME_SCHEMA>>;
+    /**
+     * Execute the workflow with streaming support
+     * @param input - The input to the workflow
+     * @param options - Options for the workflow execution
+     * @returns Stream result with real-time events and promise-based fields
+     */
+    stream: (input: WorkflowInput<INPUT_SCHEMA>, options?: WorkflowRunOptions) => WorkflowStreamResult<RESULT_SCHEMA, RESUME_SCHEMA>;
     /**
      * Create a WorkflowSuspendController that can be used to suspend the workflow
      * @returns A WorkflowSuspendController instance
@@ -934,7 +973,7 @@ interface WorkflowExecutionContext {
     logger: Logger;
     /**
      * Stream writer for emitting events during streaming execution
-     * Always available for writing custom events
+     * Always available - uses NoOpWorkflowStreamWriter when not streaming
      */
     streamWriter: WorkflowStreamWriter;
 }
@@ -5946,6 +5985,10 @@ declare class WorkflowChain<INPUT_SCHEMA extends InternalBaseWorkflowInputSchema
      * Execute the workflow with the given input
      */
     run(input: WorkflowInput<INPUT_SCHEMA>, options?: WorkflowRunOptions): Promise<WorkflowExecutionResult<RESULT_SCHEMA, RESUME_SCHEMA>>;
+    /**
+     * Execute the workflow with streaming support
+     */
+    stream(input: WorkflowInput<INPUT_SCHEMA>, options?: WorkflowRunOptions): WorkflowStreamResult<RESULT_SCHEMA, RESUME_SCHEMA>;
 }
 /**
  * Creates a new workflow chain with the given configuration
@@ -6241,7 +6284,6 @@ declare class WorkflowRegistry extends EventEmitter {
         endAt: Date;
         status: "completed" | "suspended" | "error";
         result: any;
-        stream: AsyncIterableIterator<WorkflowStreamEvent>;
         usage: UsageInfo;
         suspension?: any;
         error?: unknown;

package/dist/index.d.ts

@@ -271,7 +271,7 @@ interface WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA> {
     logger: Logger;
     /**
      * Stream writer for emitting events during streaming execution.
-     * Always available for writing custom events.
+     * Always available - uses NoOpWorkflowStreamWriter when not streaming
      */
     writer: WorkflowStreamWriter;
 }
@@ -421,9 +421,9 @@ interface WorkflowSuspendController {
     getReason: () => string | undefined;
 }
 /**
- * Result returned from workflow execution with suspend/resume capabilities
+ * Base result interface shared by all workflow execution results
  */
-interface WorkflowExecutionResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCHEMA extends z.ZodTypeAny = z.ZodAny> {
+interface WorkflowExecutionResultBase<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCHEMA extends z.ZodTypeAny = z.ZodAny> {
     /**
      * Unique execution ID for this workflow run
      */
@@ -439,30 +439,37 @@ interface WorkflowExecutionResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCH
     /**
      * When the workflow execution ended (completed, suspended, or errored)
      */
-    endAt: Date;
+    endAt: Date | Promise<Date>;
     /**
      * Current status of the workflow execution
      */
-    status: "completed" | "suspended" | "error";
+    status: "completed" | "suspended" | "error" | Promise<"completed" | "suspended" | "error">;
     /**
      * The result data if workflow completed successfully
      */
-    result: z.infer<RESULT_SCHEMA> | null;
-    /**
-     * Stream of workflow events for real-time monitoring
-     */
-    stream: AsyncIterableIterator<WorkflowStreamEvent>;
+    result: z.infer<RESULT_SCHEMA> | null | Promise<z.infer<RESULT_SCHEMA> | null>;
     /**
      * Suspension metadata if workflow was suspended
      */
-    suspension?: WorkflowSuspensionMetadata;
+    suspension?: WorkflowSuspensionMetadata | Promise<WorkflowSuspensionMetadata | undefined>;
     /**
      * Error information if workflow failed
      */
-    error?: unknown;
+    error?: unknown | Promise<unknown | undefined>;
     /**
      * Total token usage from all andAgent steps in the workflow
      */
+    usage: UsageInfo | Promise<UsageInfo>;
+}
+/**
+ * Result returned from workflow execution with suspend/resume capabilities
+ */
+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";
+    result: z.infer<RESULT_SCHEMA> | null;
+    suspension?: WorkflowSuspensionMetadata;
+    error?: unknown;
     usage: UsageInfo;
     /**
      * Resume a suspended workflow execution
@@ -474,6 +481,31 @@ interface WorkflowExecutionResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCH
         stepId?: string;
     }) => Promise<WorkflowExecutionResult<RESULT_SCHEMA, RESUME_SCHEMA>>;
 }
+/**
+ * Result returned from workflow stream execution
+ * Extends base with streaming capabilities and promise-based fields
+ */
+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">;
+    result: Promise<z.infer<RESULT_SCHEMA> | null>;
+    suspension: Promise<WorkflowSuspensionMetadata | undefined>;
+    error: Promise<unknown | undefined>;
+    usage: Promise<UsageInfo>;
+    /**
+     * Resume a suspended workflow execution
+     * @param input - Optional new input data for resuming (validated against resumeSchema if provided)
+     * @param options - Optional options for resuming, including stepId to resume from a specific step
+     * @returns A new stream result that can also be resumed if suspended again
+     */
+    resume: (input: z.infer<RESUME_SCHEMA>, options?: {
+        stepId?: string;
+    }) => Promise<WorkflowStreamResult<RESULT_SCHEMA, RESUME_SCHEMA>>;
+    /**
+     * Abort the workflow execution
+     */
+    abort: () => void;
+}
 interface WorkflowRunOptions {
     /**
      * The active step, this can be used to track the current step in a workflow
@@ -666,9 +698,16 @@ type Workflow<INPUT_SCHEMA extends InternalBaseWorkflowInputSchema, RESULT_SCHEM
      * Execute the workflow with the given input
      * @param input - The input to the workflow
      * @param options - Options for the workflow execution
-     * @returns Execution result with stream and final result
+     * @returns Execution result with final result
      */
     run: (input: WorkflowInput<INPUT_SCHEMA>, options?: WorkflowRunOptions) => Promise<WorkflowExecutionResult<RESULT_SCHEMA, RESUME_SCHEMA>>;
+    /**
+     * Execute the workflow with streaming support
+     * @param input - The input to the workflow
+     * @param options - Options for the workflow execution
+     * @returns Stream result with real-time events and promise-based fields
+     */
+    stream: (input: WorkflowInput<INPUT_SCHEMA>, options?: WorkflowRunOptions) => WorkflowStreamResult<RESULT_SCHEMA, RESUME_SCHEMA>;
     /**
      * Create a WorkflowSuspendController that can be used to suspend the workflow
      * @returns A WorkflowSuspendController instance
@@ -934,7 +973,7 @@ interface WorkflowExecutionContext {
     logger: Logger;
     /**
      * Stream writer for emitting events during streaming execution
-     * Always available for writing custom events
+     * Always available - uses NoOpWorkflowStreamWriter when not streaming
      */
     streamWriter: WorkflowStreamWriter;
 }
@@ -5946,6 +5985,10 @@ declare class WorkflowChain<INPUT_SCHEMA extends InternalBaseWorkflowInputSchema
      * Execute the workflow with the given input
      */
     run(input: WorkflowInput<INPUT_SCHEMA>, options?: WorkflowRunOptions): Promise<WorkflowExecutionResult<RESULT_SCHEMA, RESUME_SCHEMA>>;
+    /**
+     * Execute the workflow with streaming support
+     */
+    stream(input: WorkflowInput<INPUT_SCHEMA>, options?: WorkflowRunOptions): WorkflowStreamResult<RESULT_SCHEMA, RESUME_SCHEMA>;
 }
 /**
  * Creates a new workflow chain with the given configuration
@@ -6241,7 +6284,6 @@ declare class WorkflowRegistry extends EventEmitter {
         endAt: Date;
         status: "completed" | "suspended" | "error";
         result: any;
-        stream: AsyncIterableIterator<WorkflowStreamEvent>;
         usage: UsageInfo;
         suspension?: any;
         error?: unknown;