@ai-sdk/workflow 2.0.23 → 2.0.25

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @ai-sdk/workflow
 
+## 2.0.25
+
+### Patch Changes
+
+- Updated dependencies [a4ba394]
+- Updated dependencies [36b3364]
+- Updated dependencies [45099da]
+- Updated dependencies [9e1d1b2]
+- Updated dependencies [a495511]
+  - ai@7.0.94
+  - @ai-sdk/provider@4.0.11
+  - @ai-sdk/provider-utils@5.0.37
+
+## 2.0.24
+
+### Patch Changes
+
+- 3204ab6: fix(workflow): preserve per-tool types in execution callbacks and export the callback event types
+- Updated dependencies [df6c009]
+- Updated dependencies [6ee74a3]
+- Updated dependencies [f13d371]
+- Updated dependencies [d4485fe]
+- Updated dependencies [4f201cc]
+- Updated dependencies [8cdb2a7]
+- Updated dependencies [0f2281e]
+- Updated dependencies [fc8e8ac]
+- Updated dependencies [ee8391e]
+  - ai@7.0.93
+
 ## 2.0.23
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { LanguageModelV4, LanguageModelV4CallOptions, SharedV4ProviderOptions, LanguageModelV4Prompt, LanguageModelV4StreamPart } from '@ai-sdk/provider';
-import { Context, HasRequiredKey, InferToolSetContext } from '@ai-sdk/provider-utils';
+import { Context, HasRequiredKey, InferToolSetContext, InferToolInput, InferToolContext, InferToolOutput } from '@ai-sdk/provider-utils';
 import { ToolSet, Experimental_LanguageModelStreamPart, LanguageModel, Instructions, ToolChoice, TelemetryOptions as TelemetryOptions$1, StopCondition, ActiveTools, LanguageModelResponseMetadata, LanguageModelUsage, FinishReason, ToolCallRepairFunction, Experimental_SandboxSession, ModelMessage, StepResult, GenerateTextOnStepEndCallback, UIMessage, InferUITools, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
 export { Output, ToolCallRepairFunction } from 'ai';
 
@@ -588,57 +588,90 @@ type WorkflowAgentOnStepStartCallback<TTools extends ToolSet = ToolSet, TRuntime
     /** Per-tool context map for this step */
     readonly toolsContext: InferToolSetContext<TTools>;
 }) => PromiseLike<void> | void;
+type WorkflowToolContext<TOOL extends ToolSet[keyof ToolSet]> = [
+    InferToolContext<TOOL>
+] extends [never] ? undefined : InferToolContext<TOOL>;
+type WorkflowToolCall<TTools extends ToolSet, NAME extends keyof TTools> = ToolCall & {
+    readonly toolName: NAME & string;
+    readonly input: InferToolInput<TTools[NAME]>;
+};
 /**
- * Callback that is called before a tool's execute function runs.
+ * Event passed to a WorkflowAgent tool-execution-start callback.
+ *
+ * For a concrete tool set, each union member correlates the tool call with that
+ * tool's context. TypeScript narrows the nested tool call directly; use
+ * `Extract` or a user-defined type guard to narrow correlated sibling fields.
  */
-type WorkflowAgentOnToolExecutionStartCallback<TTools extends ToolSet = ToolSet> = (event: {
-    /** The tool call being executed */
+type WorkflowAgentToolExecutionStartEvent<TTools extends ToolSet = ToolSet> = [ToolSet] extends [TTools] ? {
     readonly toolCall: ToolCall;
-    /** The current step number (0-based) */
     readonly stepNumber: number;
-    /** Messages sent to the language model for the step that produced the call */
     readonly messages: ModelMessage[];
-    /** Tool-specific context passed to the tool */
-    readonly toolContext: InferToolSetContext<TTools>[keyof InferToolSetContext<TTools>] | undefined;
-}) => PromiseLike<void> | void;
+    readonly toolContext: unknown;
+} : {
+    [NAME in keyof TTools]: {
+        readonly toolCall: WorkflowToolCall<TTools, NAME>;
+        readonly stepNumber: number;
+        readonly messages: ModelMessage[];
+        readonly toolContext: WorkflowToolContext<TTools[NAME]>;
+    };
+}[keyof TTools];
 /**
- * Callback that is called after a tool execution completes.
- * Uses a discriminated union pattern: check `success` to determine
- * whether `output` or `error` is available.
+ * Callback that is called before a tool's execute function runs.
+ */
+type WorkflowAgentOnToolExecutionStartCallback<TTools extends ToolSet = ToolSet> = (event: WorkflowAgentToolExecutionStartEvent<TTools>) => PromiseLike<void> | void;
+/**
+ * Event passed to a WorkflowAgent tool-execution-end callback.
+ *
+ * For a concrete tool set, each union member correlates the tool call with that
+ * tool's context and successful output. Check `success` to distinguish output
+ * and error events. Use `Extract` or a user-defined type guard to narrow
+ * correlated sibling fields by tool name.
  */
-type WorkflowAgentOnToolExecutionEndCallback<TTools extends ToolSet = ToolSet> = (event: {
-    /** The tool call that was executed */
+type WorkflowAgentToolExecutionEndEvent<TTools extends ToolSet = ToolSet> = [ToolSet] extends [TTools] ? {
     readonly toolCall: ToolCall;
-    /** The current step number (0-based) */
     readonly stepNumber: number;
-    /** Execution time in milliseconds */
     readonly durationMs: number;
-    /** Messages sent to the language model for the step that produced the call */
     readonly messages: ModelMessage[];
-    /** Tool-specific context passed to the tool */
-    readonly toolContext: InferToolSetContext<TTools>[keyof InferToolSetContext<TTools>] | undefined;
-    /** Whether the tool call succeeded */
+    readonly toolContext: unknown;
     readonly success: true;
-    /** The tool result */
     readonly output: unknown;
     readonly error?: never;
 } | {
-    /** The tool call that was executed */
     readonly toolCall: ToolCall;
-    /** The current step number (0-based) */
     readonly stepNumber: number;
-    /** Execution time in milliseconds */
     readonly durationMs: number;
-    /** Messages sent to the language model for the step that produced the call */
     readonly messages: ModelMessage[];
-    /** Tool-specific context passed to the tool */
-    readonly toolContext: InferToolSetContext<TTools>[keyof InferToolSetContext<TTools>] | undefined;
-    /** Whether the tool call succeeded */
+    readonly toolContext: unknown;
     readonly success: false;
-    /** The error that occurred */
     readonly error: unknown;
     readonly output?: never;
-}) => PromiseLike<void> | void;
+} : {
+    [NAME in keyof TTools]: {
+        readonly toolCall: WorkflowToolCall<TTools, NAME>;
+        readonly stepNumber: number;
+        readonly durationMs: number;
+        readonly messages: ModelMessage[];
+        readonly toolContext: WorkflowToolContext<TTools[NAME]>;
+        readonly success: true;
+        readonly output: InferToolOutput<TTools[NAME]>;
+        readonly error?: never;
+    } | {
+        readonly toolCall: WorkflowToolCall<TTools, NAME>;
+        readonly stepNumber: number;
+        readonly durationMs: number;
+        readonly messages: ModelMessage[];
+        readonly toolContext: WorkflowToolContext<TTools[NAME]>;
+        readonly success: false;
+        readonly error: unknown;
+        readonly output?: never;
+    };
+}[keyof TTools];
+/**
+ * Callback that is called after a tool execution completes.
+ * Uses a discriminated union pattern: check `success` to determine
+ * whether `output` or `error` is available.
+ */
+type WorkflowAgentOnToolExecutionEndCallback<TTools extends ToolSet = ToolSet> = (event: WorkflowAgentToolExecutionEndEvent<TTools>) => PromiseLike<void> | void;
 /**
  * Options for the {@link WorkflowAgent.stream} method.
  */
@@ -1290,4 +1323,4 @@ declare class WorkflowChatTransport<UI_MESSAGE extends UIMessage> implements Cha
  */
 declare function normalizeUIMessageStreamParts(source: AsyncIterable<UIMessageChunk>): AsyncGenerator<UIMessageChunk>;
 
-export { type CompatibleLanguageModel, type DownloadFunction, type GenerationSettings, type InferWorkflowAgentTools, type InferWorkflowAgentUIMessage, type ModelCallStreamPart, type OutputSpecification, type PrepareCallCallback, type PrepareCallOptions, type PrepareCallResult, type PrepareStepCallback, type PrepareStepInfo, type PrepareStepResult, type ProviderOptions, type ReconnectToStreamOptions, type SendMessagesOptions, type StreamTextTransform, type TelemetryOptions, WorkflowAgent, type WorkflowAgentOnAbortCallback, type WorkflowAgentOnEndCallback, type WorkflowAgentOnErrorCallback, type WorkflowAgentOnFinishCallback, type WorkflowAgentOnStartCallback, type WorkflowAgentOnStepEndCallback, type WorkflowAgentOnStepFinishCallback, type WorkflowAgentOnStepStartCallback, type WorkflowAgentOnToolExecutionEndCallback, type WorkflowAgentOnToolExecutionStartCallback, type WorkflowAgentOptions, type WorkflowAgentStreamOptions, type WorkflowAgentStreamResult, WorkflowChatTransport, type WorkflowChatTransportOptions, type WorkflowToolApprovalSecret, createModelCallToUIChunkTransform, normalizeUIMessageStreamParts, toUIMessageChunk };
+export { type CompatibleLanguageModel, type DownloadFunction, type GenerationSettings, type InferWorkflowAgentTools, type InferWorkflowAgentUIMessage, type ModelCallStreamPart, type OutputSpecification, type PrepareCallCallback, type PrepareCallOptions, type PrepareCallResult, type PrepareStepCallback, type PrepareStepInfo, type PrepareStepResult, type ProviderOptions, type ReconnectToStreamOptions, type SendMessagesOptions, type StreamTextTransform, type TelemetryOptions, WorkflowAgent, type WorkflowAgentOnAbortCallback, type WorkflowAgentOnEndCallback, type WorkflowAgentOnErrorCallback, type WorkflowAgentOnFinishCallback, type WorkflowAgentOnStartCallback, type WorkflowAgentOnStepEndCallback, type WorkflowAgentOnStepFinishCallback, type WorkflowAgentOnStepStartCallback, type WorkflowAgentOnToolExecutionEndCallback, type WorkflowAgentOnToolExecutionStartCallback, type WorkflowAgentOptions, type WorkflowAgentStreamOptions, type WorkflowAgentStreamResult, type WorkflowAgentToolExecutionEndEvent, type WorkflowAgentToolExecutionStartEvent, WorkflowChatTransport, type WorkflowChatTransportOptions, type WorkflowToolApprovalSecret, createModelCallToUIChunkTransform, normalizeUIMessageStreamParts, toUIMessageChunk };