ai 4.1.28 → 4.1.29

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 4.1.29
+
+### Patch Changes
+
+- 605de49: feat (ai/core): export callback types
+
 ## 4.1.28
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1226,7 +1226,7 @@ type ObjectStreamPart<PARTIAL> = {
     providerMetadata?: ProviderMetadata;
 };
 
-type OnFinishCallback<RESULT> = (event: {
+type StreamObjectOnFinishCallback<RESULT> = (event: {
     /**
   The token usage of the generated response.
   */
@@ -1319,7 +1319,7 @@ functionality that can be fully encapsulated in the provider.
     /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
-    onFinish?: OnFinishCallback<OBJECT>;
+    onFinish?: StreamObjectOnFinishCallback<OBJECT>;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -1390,7 +1390,7 @@ functionality that can be fully encapsulated in the provider.
     /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
-    onFinish?: OnFinishCallback<Array<ELEMENT>>;
+    onFinish?: StreamObjectOnFinishCallback<Array<ELEMENT>>;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -1435,7 +1435,7 @@ functionality that can be fully encapsulated in the provider.
     /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
-    onFinish?: OnFinishCallback<JSONValue>;
+    onFinish?: StreamObjectOnFinishCallback<JSONValue>;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -1901,6 +1901,12 @@ type ToolCallRepairFunction<TOOLS extends ToolSet> = (options: {
     error: NoSuchToolError | InvalidToolArgumentsError;
 }) => Promise<LanguageModelV1FunctionToolCall | null>;
 
+/**
+Callback that is set using the `onStepFinish` option.
+
+@param stepResult - The result of the step.
+ */
+type GenerateTextOnStepFinishCallback<TOOLS extends ToolSet> = (stepResult: StepResult<TOOLS>) => Promise<void> | void;
 /**
 Generate a text and call tools for a given prompt using a language model.
 
@@ -2009,7 +2015,7 @@ A function that attempts to repair a tool call that failed to parse.
     /**
     Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
-    onStepFinish?: (event: StepResult<TOOLS>) => Promise<void> | void;
+    onStepFinish?: GenerateTextOnStepFinishCallback<TOOLS>;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -2312,6 +2318,41 @@ type StreamTextTransform<TOOLS extends ToolSet> = (options: {
     stopStream: () => void;
 }) => TransformStream<TextStreamPart<TOOLS>, TextStreamPart<TOOLS>>;
 /**
+Callback that is set using the `onError` option.
+
+@param event - The event that is passed to the callback.
+ */
+type StreamTextOnErrorCallback = (event: {
+    error: unknown;
+}) => Promise<void> | void;
+/**
+Callback that is set using the `onStepFinish` option.
+
+@param stepResult - The result of the step.
+ */
+type StreamTextOnStepFinishCallback<TOOLS extends ToolSet> = (stepResult: StepResult<TOOLS>) => Promise<void> | void;
+/**
+Callback that is set using the `onChunk` option.
+
+@param event - The event that is passed to the callback.
+ */
+type StreamTextOnChunkCallback<TOOLS extends ToolSet> = (event: {
+    chunk: Extract<TextStreamPart<TOOLS>, {
+        type: 'text-delta' | 'reasoning' | 'source' | 'tool-call' | 'tool-call-streaming-start' | 'tool-call-delta' | 'tool-result';
+    }>;
+}) => Promise<void> | void;
+/**
+Callback that is set using the `onFinish` option.
+
+@param event - The event that is passed to the callback.
+ */
+type StreamTextOnFinishCallback<TOOLS extends ToolSet> = (event: Omit<StepResult<TOOLS>, 'stepType' | 'isContinued'> & {
+    /**
+Details for all steps.
+   */
+    readonly steps: StepResult<TOOLS>[];
+}) => Promise<void> | void;
+/**
 Generate a text and call tools for a given prompt using a language model.
 
 This function streams the output. If you do not want to stream the output, use `generateText` instead.
@@ -2433,35 +2474,27 @@ The stream transformations must maintain the stream structure for streamText to
      */
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
     /**
-Callback that is called for each chunk of the stream. The stream processing will pause until the callback promise is resolved.
+Callback that is called for each chunk of the stream.
+The stream processing will pause until the callback promise is resolved.
      */
-    onChunk?: (event: {
-        chunk: Extract<TextStreamPart<TOOLS>, {
-            type: 'text-delta' | 'reasoning' | 'source' | 'tool-call' | 'tool-call-streaming-start' | 'tool-call-delta' | 'tool-result';
-        }>;
-    }) => Promise<void> | void;
+    onChunk?: StreamTextOnChunkCallback<TOOLS>;
     /**
-Callback that is invoked when an error occurs during streaming. You can use it to log errors.
+Callback that is invoked when an error occurs during streaming.
+You can use it to log errors.
+The stream processing will pause until the callback promise is resolved.
      */
-    onError?: (event: {
-        error: unknown;
-    }) => Promise<void> | void;
+    onError?: StreamTextOnErrorCallback;
     /**
 Callback that is called when the LLM response and all request tool executions
 (for tools that have an `execute` function) are finished.
 
 The usage is the combined usage of all steps.
      */
-    onFinish?: (event: Omit<StepResult<TOOLS>, 'stepType' | 'isContinued'> & {
-        /**
-Details for all steps.
-       */
-        readonly steps: StepResult<TOOLS>[];
-    }) => Promise<void> | void;
+    onFinish?: StreamTextOnFinishCallback<TOOLS>;
     /**
 Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
-    onStepFinish?: (event: StepResult<TOOLS>) => Promise<void> | void;
+    onStepFinish?: StreamTextOnStepFinishCallback<TOOLS>;
     /**
 Internal. For test use only. May change without notice.
      */
@@ -2958,4 +2991,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, customProvider, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool, wrapLanguageModel };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, customProvider, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool, wrapLanguageModel };

package/dist/index.d.ts

@@ -1226,7 +1226,7 @@ type ObjectStreamPart<PARTIAL> = {
     providerMetadata?: ProviderMetadata;
 };
 
-type OnFinishCallback<RESULT> = (event: {
+type StreamObjectOnFinishCallback<RESULT> = (event: {
     /**
   The token usage of the generated response.
   */
@@ -1319,7 +1319,7 @@ functionality that can be fully encapsulated in the provider.
     /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
-    onFinish?: OnFinishCallback<OBJECT>;
+    onFinish?: StreamObjectOnFinishCallback<OBJECT>;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -1390,7 +1390,7 @@ functionality that can be fully encapsulated in the provider.
     /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
-    onFinish?: OnFinishCallback<Array<ELEMENT>>;
+    onFinish?: StreamObjectOnFinishCallback<Array<ELEMENT>>;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -1435,7 +1435,7 @@ functionality that can be fully encapsulated in the provider.
     /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
-    onFinish?: OnFinishCallback<JSONValue>;
+    onFinish?: StreamObjectOnFinishCallback<JSONValue>;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -1901,6 +1901,12 @@ type ToolCallRepairFunction<TOOLS extends ToolSet> = (options: {
     error: NoSuchToolError | InvalidToolArgumentsError;
 }) => Promise<LanguageModelV1FunctionToolCall | null>;
 
+/**
+Callback that is set using the `onStepFinish` option.
+
+@param stepResult - The result of the step.
+ */
+type GenerateTextOnStepFinishCallback<TOOLS extends ToolSet> = (stepResult: StepResult<TOOLS>) => Promise<void> | void;
 /**
 Generate a text and call tools for a given prompt using a language model.
 
@@ -2009,7 +2015,7 @@ A function that attempts to repair a tool call that failed to parse.
     /**
     Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
-    onStepFinish?: (event: StepResult<TOOLS>) => Promise<void> | void;
+    onStepFinish?: GenerateTextOnStepFinishCallback<TOOLS>;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -2312,6 +2318,41 @@ type StreamTextTransform<TOOLS extends ToolSet> = (options: {
     stopStream: () => void;
 }) => TransformStream<TextStreamPart<TOOLS>, TextStreamPart<TOOLS>>;
 /**
+Callback that is set using the `onError` option.
+
+@param event - The event that is passed to the callback.
+ */
+type StreamTextOnErrorCallback = (event: {
+    error: unknown;
+}) => Promise<void> | void;
+/**
+Callback that is set using the `onStepFinish` option.
+
+@param stepResult - The result of the step.
+ */
+type StreamTextOnStepFinishCallback<TOOLS extends ToolSet> = (stepResult: StepResult<TOOLS>) => Promise<void> | void;
+/**
+Callback that is set using the `onChunk` option.
+
+@param event - The event that is passed to the callback.
+ */
+type StreamTextOnChunkCallback<TOOLS extends ToolSet> = (event: {
+    chunk: Extract<TextStreamPart<TOOLS>, {
+        type: 'text-delta' | 'reasoning' | 'source' | 'tool-call' | 'tool-call-streaming-start' | 'tool-call-delta' | 'tool-result';
+    }>;
+}) => Promise<void> | void;
+/**
+Callback that is set using the `onFinish` option.
+
+@param event - The event that is passed to the callback.
+ */
+type StreamTextOnFinishCallback<TOOLS extends ToolSet> = (event: Omit<StepResult<TOOLS>, 'stepType' | 'isContinued'> & {
+    /**
+Details for all steps.
+   */
+    readonly steps: StepResult<TOOLS>[];
+}) => Promise<void> | void;
+/**
 Generate a text and call tools for a given prompt using a language model.
 
 This function streams the output. If you do not want to stream the output, use `generateText` instead.
@@ -2433,35 +2474,27 @@ The stream transformations must maintain the stream structure for streamText to
      */
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
     /**
-Callback that is called for each chunk of the stream. The stream processing will pause until the callback promise is resolved.
+Callback that is called for each chunk of the stream.
+The stream processing will pause until the callback promise is resolved.
      */
-    onChunk?: (event: {
-        chunk: Extract<TextStreamPart<TOOLS>, {
-            type: 'text-delta' | 'reasoning' | 'source' | 'tool-call' | 'tool-call-streaming-start' | 'tool-call-delta' | 'tool-result';
-        }>;
-    }) => Promise<void> | void;
+    onChunk?: StreamTextOnChunkCallback<TOOLS>;
     /**
-Callback that is invoked when an error occurs during streaming. You can use it to log errors.
+Callback that is invoked when an error occurs during streaming.
+You can use it to log errors.
+The stream processing will pause until the callback promise is resolved.
      */
-    onError?: (event: {
-        error: unknown;
-    }) => Promise<void> | void;
+    onError?: StreamTextOnErrorCallback;
     /**
 Callback that is called when the LLM response and all request tool executions
 (for tools that have an `execute` function) are finished.
 
 The usage is the combined usage of all steps.
      */
-    onFinish?: (event: Omit<StepResult<TOOLS>, 'stepType' | 'isContinued'> & {
-        /**
-Details for all steps.
-       */
-        readonly steps: StepResult<TOOLS>[];
-    }) => Promise<void> | void;
+    onFinish?: StreamTextOnFinishCallback<TOOLS>;
     /**
 Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
-    onStepFinish?: (event: StepResult<TOOLS>) => Promise<void> | void;
+    onStepFinish?: StreamTextOnStepFinishCallback<TOOLS>;
     /**
 Internal. For test use only. May change without notice.
      */
@@ -2958,4 +2991,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, customProvider, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool, wrapLanguageModel };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, customProvider, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool, wrapLanguageModel };

package/dist/index.js

@@ -4819,14 +4819,14 @@ var DefaultStreamTextResult = class {
     output,
     continueSteps,
     providerOptions,
-    onChunk,
-    onError,
-    onFinish,
-    onStepFinish,
     now: now2,
     currentDate,
     generateId: generateId3,
-    generateMessageId
+    generateMessageId,
+    onChunk,
+    onError,
+    onFinish,
+    onStepFinish
   }) {
     this.warningsPromise = new DelayedPromise();
     this.usagePromise = new DelayedPromise();