ai 5.0.0-canary.0 → 5.0.0-canary.2

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # ai
 
+## 5.0.0-canary.2
+
+### Patch Changes
+
+- bd398e4: fix (core): improve error handling in streamText's consumeStream method
+
+## 5.0.0-canary.1
+
+### Minor Changes
+
+- b7eae2d: feat (core): Add finishReason field to NoObjectGeneratedError
+
+### Patch Changes
+
+- c22ad54: feat(smooth-stream): chunking callbacks
+- a4f3007: chore: remove ai/react
+- Updated dependencies [060370c]
+- Updated dependencies [0c0c0b3]
+- Updated dependencies [63d791d]
+  - @ai-sdk/provider-utils@3.0.0-canary.1
+  - @ai-sdk/ui-utils@2.0.0-canary.1
+
 ## 5.0.0-canary.0
 
 ### Major Changes

package/dist/index.d.mts

@@ -2,8 +2,8 @@ import { IDGenerator } from '@ai-sdk/provider-utils';
 export { CoreToolCall, CoreToolResult, IDGenerator, ToolCall, ToolResult, createIdGenerator, generateId } from '@ai-sdk/provider-utils';
 import { DataStreamString, Message, Schema, DeepPartial, JSONValue as JSONValue$1 } from '@ai-sdk/ui-utils';
 export { Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataStreamPart, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, ToolInvocation, UIMessage, formatDataStreamPart, jsonSchema, parseDataStreamPart, processDataStream, processTextStream, zodSchema } from '@ai-sdk/ui-utils';
-import { LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1Source, JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV1ProviderMetadata, LanguageModelV1CallOptions, AISDKError, LanguageModelV1FunctionToolCall, JSONSchema7, JSONParseError, TypeValidationError, ProviderV1, NoSuchModelError } from '@ai-sdk/provider';
-export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV1, LanguageModelV1CallOptions, LanguageModelV1Prompt, LanguageModelV1StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
+import { LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2LogProbs, LanguageModelV2CallWarning, LanguageModelV2Source, JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV2ProviderMetadata, LanguageModelV2CallOptions, AISDKError, LanguageModelV2FunctionToolCall, JSONSchema7, JSONParseError, TypeValidationError, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
+export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Prompt, LanguageModelV2StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { ServerResponse } from 'node:http';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
 import { z } from 'zod';
@@ -12,7 +12,7 @@ import { ServerResponse as ServerResponse$1 } from 'http';
 /**
 Language model that is used by the AI SDK Core functions.
 */
-type LanguageModel = LanguageModelV1;
+type LanguageModel = LanguageModelV2;
 /**
 Reason why a language model finished generating a response.
 
@@ -24,22 +24,22 @@ Can be one of the following:
 - `error`: model stopped because of an error
 - `other`: model stopped for other reasons
 */
-type FinishReason = LanguageModelV1FinishReason;
+type FinishReason = LanguageModelV2FinishReason;
 /**
 Log probabilities for each token and its top log probabilities.
 
 @deprecated Will become a provider extension in the future.
  */
-type LogProbs = LanguageModelV1LogProbs;
+type LogProbs = LanguageModelV2LogProbs;
 /**
 Warning from the model provider for this call. The call will proceed, but e.g.
 some settings might not be supported, which can lead to suboptimal results.
 */
-type CallWarning = LanguageModelV1CallWarning;
+type CallWarning = LanguageModelV2CallWarning;
 /**
 A source that has been used as input to generate the response.
 */
-type Source = LanguageModelV1Source;
+type Source = LanguageModelV2Source;
 /**
 Tool choice for the generation. It supports the following settings:
 
@@ -240,14 +240,14 @@ Additional provider-specific metadata that is returned from the provider.
 This is needed to enable provider-specific functionality that can be
 fully encapsulated in the provider.
  */
-type ProviderMetadata = LanguageModelV1ProviderMetadata;
+type ProviderMetadata = LanguageModelV2ProviderMetadata;
 /**
 Additional provider-specific options.
 
 They are passed through to the provider from the AI SDK and enable
 provider-specific functionality that can be fully encapsulated in the provider.
  */
-type ProviderOptions = LanguageModelV1ProviderMetadata;
+type ProviderOptions = LanguageModelV2ProviderMetadata;
 
 /**
 Represents the number of tokens used in a prompt and completion.
@@ -2243,7 +2243,7 @@ interface Output<OUTPUT, PARTIAL> {
     }): string | undefined;
     responseFormat: (options: {
         model: LanguageModel;
-    }) => LanguageModelV1CallOptions['responseFormat'];
+    }) => LanguageModelV2CallOptions['responseFormat'];
     parsePartial(options: {
         text: string;
     }): {
@@ -2254,6 +2254,7 @@ interface Output<OUTPUT, PARTIAL> {
     }, context: {
         response: LanguageModelResponseMetadata;
         usage: LanguageModelUsage;
+        finishReason: FinishReason;
     }): OUTPUT;
 }
 declare const text: () => Output<string, string>;
@@ -2351,13 +2352,13 @@ declare function convertToCoreMessages<TOOLS extends ToolSet = never>(messages:
 type ToolCallRepairFunction<TOOLS extends ToolSet> = (options: {
     system: string | undefined;
     messages: CoreMessage[];
-    toolCall: LanguageModelV1FunctionToolCall;
+    toolCall: LanguageModelV2FunctionToolCall;
     tools: TOOLS;
     parameterSchema: (options: {
         toolName: string;
     }) => JSONSchema7;
     error: NoSuchToolError | InvalidToolArgumentsError;
-}) => Promise<LanguageModelV1FunctionToolCall | null>;
+}) => Promise<LanguageModelV2FunctionToolCall | null>;
 
 /**
 Callback that is set using the `onStepFinish` option.
@@ -2538,6 +2539,9 @@ type DataStreamOptions = {
      */
     experimental_sendStart?: boolean;
 };
+type ConsumeStreamOptions = {
+    onError?: (error: unknown) => void;
+};
 /**
 A result object for accessing different stream types and additional information.
  */
@@ -2658,8 +2662,10 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
   This is useful to force the stream to finish.
   It effectively removes the backpressure and allows the stream to finish,
   triggering the `onFinish` callback and the promise resolution.
+  
+  If an error occurs, it is passed to the optional `onError` callback.
     */
-    consumeStream(): Promise<void>;
+    consumeStream(options?: ConsumeStreamOptions): Promise<void>;
     /**
     Converts the result to a data stream.
   
@@ -2805,6 +2811,14 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     error: unknown;
 };
 
+/**
+ * Detects the first chunk in a buffer.
+ *
+ * @param buffer - The buffer to detect the first chunk in.
+ *
+ * @returns The first detected chunk, or `undefined` if no chunk was detected.
+ */
+type ChunkDetector = (buffer: string) => string | undefined | null;
 /**
  * Smooths text streaming output.
  *
@@ -2815,7 +2829,7 @@ type TextStreamPart<TOOLS extends ToolSet> = {
  */
 declare function smoothStream<TOOLS extends ToolSet>({ delayInMs, chunking, _internal: { delay }, }?: {
     delayInMs?: number | null;
-    chunking?: 'word' | 'line' | RegExp;
+    chunking?: 'word' | 'line' | RegExp | ChunkDetector;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -3778,74 +3792,14 @@ Callback that is called when the LLM response and the final object validation ar
     };
 }): StreamObjectResult<JSONValue, JSONValue, never>;
 
-/**
- * Experimental middleware for LanguageModelV1.
- * This type defines the structure for middleware that can be used to modify
- * the behavior of LanguageModelV1 operations.
- */
-type LanguageModelV1Middleware = {
-    /**
-     * Middleware specification version. Use `v1` for the current version.
-     */
-    middlewareVersion?: 'v1' | undefined;
-    /**
-     * Transforms the parameters before they are passed to the language model.
-     * @param options - Object containing the type of operation and the parameters.
-     * @param options.type - The type of operation ('generate' or 'stream').
-     * @param options.params - The original parameters for the language model call.
-     * @returns A promise that resolves to the transformed parameters.
-     */
-    transformParams?: (options: {
-        type: 'generate' | 'stream';
-        params: LanguageModelV1CallOptions;
-    }) => PromiseLike<LanguageModelV1CallOptions>;
-    /**
-     * Wraps the generate operation of the language model.
-     * @param options - Object containing the generate function, parameters, and model.
-     * @param options.doGenerate - The original generate function.
-     * @param options.doStream - The original stream function.
-     * @param options.params - The parameters for the generate call. If the
-     * `transformParams` middleware is used, this will be the transformed parameters.
-     * @param options.model - The language model instance.
-     * @returns A promise that resolves to the result of the generate operation.
-     */
-    wrapGenerate?: (options: {
-        doGenerate: () => ReturnType<LanguageModelV1['doGenerate']>;
-        doStream: () => ReturnType<LanguageModelV1['doStream']>;
-        params: LanguageModelV1CallOptions;
-        model: LanguageModelV1;
-    }) => Promise<Awaited<ReturnType<LanguageModelV1['doGenerate']>>>;
-    /**
-     * Wraps the stream operation of the language model.
-     *
-     * @param options - Object containing the stream function, parameters, and model.
-     * @param options.doGenerate - The original generate function.
-     * @param options.doStream - The original stream function.
-     * @param options.params - The parameters for the stream call. If the
-     * `transformParams` middleware is used, this will be the transformed parameters.
-     * @param options.model - The language model instance.
-     * @returns A promise that resolves to the result of the stream operation.
-     */
-    wrapStream?: (options: {
-        doGenerate: () => ReturnType<LanguageModelV1['doGenerate']>;
-        doStream: () => ReturnType<LanguageModelV1['doStream']>;
-        params: LanguageModelV1CallOptions;
-        model: LanguageModelV1;
-    }) => PromiseLike<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
-};
-/**
- * @deprecated Use `LanguageModelV1Middleware` instead.
- */
-type Experimental_LanguageModelV1Middleware = LanguageModelV1Middleware;
-
 /**
  * Applies default settings for a language model.
  */
 declare function defaultSettingsMiddleware({ settings, }: {
-    settings: Partial<LanguageModelV1CallOptions & {
-        providerMetadata?: LanguageModelV1ProviderMetadata;
+    settings: Partial<LanguageModelV2CallOptions & {
+        providerMetadata?: LanguageModelV2ProviderMetadata;
     }>;
-}): LanguageModelV1Middleware;
+}): LanguageModelV2Middleware;
 
 /**
  * Extract an XML-tagged reasoning section from the generated text and exposes it
@@ -3859,40 +3813,40 @@ declare function extractReasoningMiddleware({ tagName, separator, startWithReaso
     tagName: string;
     separator?: string;
     startWithReasoning?: boolean;
-}): LanguageModelV1Middleware;
+}): LanguageModelV2Middleware;
 
 /**
  * Simulates streaming chunks with the response from a generate call.
  */
-declare function simulateStreamingMiddleware(): LanguageModelV1Middleware;
+declare function simulateStreamingMiddleware(): LanguageModelV2Middleware;
 
 /**
- * Wraps a LanguageModelV1 instance with middleware functionality.
+ * Wraps a LanguageModelV2 instance with middleware functionality.
  * This function allows you to apply middleware to transform parameters,
  * wrap generate operations, and wrap stream operations of a language model.
  *
  * @param options - Configuration options for wrapping the language model.
- * @param options.model - The original LanguageModelV1 instance to be wrapped.
+ * @param options.model - The original LanguageModelV2 instance to be wrapped.
  * @param options.middleware - The middleware to be applied to the language model. When multiple middlewares are provided, the first middleware will transform the input first, and the last middleware will be wrapped directly around the model.
  * @param options.modelId - Optional custom model ID to override the original model's ID.
  * @param options.providerId - Optional custom provider ID to override the original model's provider.
- * @returns A new LanguageModelV1 instance with middleware applied.
+ * @returns A new LanguageModelV2 instance with middleware applied.
  */
 declare const wrapLanguageModel: ({ model, middleware: middlewareArg, modelId, providerId, }: {
-    model: LanguageModelV1;
-    middleware: LanguageModelV1Middleware | LanguageModelV1Middleware[];
+    model: LanguageModelV2;
+    middleware: LanguageModelV2Middleware | LanguageModelV2Middleware[];
     modelId?: string;
     providerId?: string;
-}) => LanguageModelV1;
+}) => LanguageModelV2;
 /**
  * @deprecated Use `wrapLanguageModel` instead.
  */
 declare const experimental_wrapLanguageModel: ({ model, middleware: middlewareArg, modelId, providerId, }: {
-    model: LanguageModelV1;
-    middleware: LanguageModelV1Middleware | LanguageModelV1Middleware[];
+    model: LanguageModelV2;
+    middleware: LanguageModelV2Middleware | LanguageModelV2Middleware[];
     modelId?: string;
     providerId?: string;
-}) => LanguageModelV1;
+}) => LanguageModelV2;
 
 /**
  * Creates a custom provider with specified language models, text embedding models, and an optional fallback provider.
@@ -3910,7 +3864,7 @@ declare function customProvider<LANGUAGE_MODELS extends Record<string, LanguageM
     languageModels?: LANGUAGE_MODELS;
     textEmbeddingModels?: EMBEDDING_MODELS;
     imageModels?: IMAGE_MODELS;
-    fallbackProvider?: ProviderV1;
+    fallbackProvider?: ProviderV2;
 }): Provider & {
     languageModel(modelId: ExtractModelId<LANGUAGE_MODELS>): LanguageModel;
     textEmbeddingModel(modelId: ExtractModelId<EMBEDDING_MODELS>): EmbeddingModel<string>;
@@ -3938,7 +3892,7 @@ declare class NoSuchProviderError extends NoSuchModelError {
 }
 
 type ExtractLiteralUnion<T> = T extends string ? string extends T ? never : T : never;
-interface ProviderRegistryProvider<PROVIDERS extends Record<string, ProviderV1> = Record<string, ProviderV1>, SEPARATOR extends string = ':'> {
+interface ProviderRegistryProvider<PROVIDERS extends Record<string, ProviderV2> = Record<string, ProviderV2>, SEPARATOR extends string = ':'> {
     languageModel<KEY extends keyof PROVIDERS>(id: KEY extends string ? `${KEY & string}${SEPARATOR}${ExtractLiteralUnion<Parameters<NonNullable<PROVIDERS[KEY]['languageModel']>>[0]>}` : never): LanguageModel;
     languageModel<KEY extends keyof PROVIDERS>(id: KEY extends string ? `${KEY & string}${SEPARATOR}${string}` : never): LanguageModel;
     textEmbeddingModel<KEY extends keyof PROVIDERS>(id: KEY extends string ? `${KEY & string}${SEPARATOR}${ExtractLiteralUnion<Parameters<NonNullable<PROVIDERS[KEY]['textEmbeddingModel']>>[0]>}` : never): EmbeddingModel<string>;
@@ -3949,7 +3903,7 @@ interface ProviderRegistryProvider<PROVIDERS extends Record<string, ProviderV1>
 /**
  * Creates a registry for the given providers.
  */
-declare function createProviderRegistry<PROVIDERS extends Record<string, ProviderV1>, SEPARATOR extends string = ':'>(providers: PROVIDERS, { separator, }?: {
+declare function createProviderRegistry<PROVIDERS extends Record<string, ProviderV2>, SEPARATOR extends string = ':'>(providers: PROVIDERS, { separator, }?: {
     separator?: SEPARATOR;
 }): ProviderRegistryProvider<PROVIDERS, SEPARATOR>;
 /**
@@ -4114,12 +4068,17 @@ declare class NoObjectGeneratedError extends AISDKError {
     The usage of the model.
      */
     readonly usage: LanguageModelUsage | undefined;
-    constructor({ message, cause, text, response, usage, }: {
+    /**
+    Reason why the model finished generating a response.
+     */
+    readonly finishReason: FinishReason | undefined;
+    constructor({ message, cause, text, response, usage, finishReason, }: {
         message?: string;
         cause?: Error;
         text?: string;
         response: LanguageModelResponseMetadata;
         usage: LanguageModelUsage;
+        finishReason: FinishReason;
     });
     static isInstance(error: unknown): error is NoObjectGeneratedError;
 }
@@ -4339,4 +4298,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MCPClientError, MCPTransport, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, ProviderRegistryProvider, RepairTextFunction, 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, createProviderRegistry, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, tool, wrapLanguageModel };
+export { AssistantContent, CallWarning, ChunkDetector, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MCPClientError, MCPTransport, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, ProviderRegistryProvider, RepairTextFunction, 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, createProviderRegistry, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, tool, wrapLanguageModel };