ai 4.0.26 → 4.0.27

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # ai
 
+## 4.0.27
+
+### Patch Changes
+
+- a56734f: feat (ai/core): export simulateReadableStream in ai package
+- 9589601: feat (ai/core): support null delay in smoothStream
+- e3cc23a: feat (ai/core): support regexp chunking pattern in smoothStream
+- e463e73: feat (ai/core): support skipping delays in simulateReadableStream
+
 ## 4.0.26
 
 ### Patch Changes

package/dist/index.d.mts

@@ -2151,19 +2151,19 @@ Details for all steps.
 /**
  * Smooths text streaming output.
  *
- * @param delayInMs - The delay in milliseconds between each chunk. Defaults to 10ms.
- * @param chunking - Controls how the text is chunked for streaming. Use "word" to stream word by word (default), or "line" to stream line by line.
+ * @param delayInMs - The delay in milliseconds between each chunk. Defaults to 10ms. Can be set to `null` to skip the delay.
+ * @param chunking - Controls how the text is chunked for streaming. Use "word" to stream word by word (default), "line" to stream line by line, or provide a custom RegExp pattern for custom chunking.
  *
  * @returns A transform stream that smooths text streaming output.
  */
 declare function smoothStream<TOOLS extends Record<string, CoreTool>>({ delayInMs, chunking, _internal: { delay }, }?: {
-    delayInMs?: number;
-    chunking?: 'word' | 'line';
+    delayInMs?: number | null;
+    chunking?: 'word' | 'line' | RegExp;
     /**
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
-        delay?: (delayInMs: number) => Promise<void>;
+        delay?: (delayInMs: number | null) => Promise<void>;
     };
 }): (options: {
     tools: TOOLS;
@@ -2284,6 +2284,24 @@ declare function experimental_createProviderRegistry(providers: Record<string, P
  */
 declare function cosineSimilarity(vector1: number[], vector2: number[]): number;
 
+/**
+ * Creates a ReadableStream that emits the provided values with an optional delay between each value.
+ *
+ * @param options - The configuration options
+ * @param options.chunks - Array of values to be emitted by the stream
+ * @param options.initialDelayInMs - Optional initial delay in milliseconds before emitting the first value (default: 0). Can be set to `null` to skip the initial delay. The difference between `initialDelayInMs: null` and `initialDelayInMs: 0` is that `initialDelayInMs: null` will emit the values without any delay, while `initialDelayInMs: 0` will emit the values with a delay of 0 milliseconds.
+ * @param options.chunkDelayInMs - Optional delay in milliseconds between emitting each value (default: 0). Can be set to `null` to skip the delay. The difference between `chunkDelayInMs: null` and `chunkDelayInMs: 0` is that `chunkDelayInMs: null` will emit the values without any delay, while `chunkDelayInMs: 0` will emit the values with a delay of 0 milliseconds.
+ * @returns A ReadableStream that emits the provided values
+ */
+declare function simulateReadableStream<T>({ chunks, initialDelayInMs, chunkDelayInMs, _internal, }: {
+    chunks: T[];
+    initialDelayInMs?: number | null;
+    chunkDelayInMs?: number | null;
+    _internal?: {
+        delay?: (ms: number | null) => Promise<void>;
+    };
+}): ReadableStream<T>;
+
 declare const symbol$9: unique symbol;
 declare class InvalidArgumentError extends AISDKError {
     private readonly [symbol$9];
@@ -2569,4 +2587,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createDataStream, createDataStreamResponse, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, generateObject, generateText, pipeDataStreamToResponse, smoothStream, streamObject, streamText, tool };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createDataStream, createDataStreamResponse, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool };

package/dist/index.d.ts

@@ -2151,19 +2151,19 @@ Details for all steps.
 /**
  * Smooths text streaming output.
  *
- * @param delayInMs - The delay in milliseconds between each chunk. Defaults to 10ms.
- * @param chunking - Controls how the text is chunked for streaming. Use "word" to stream word by word (default), or "line" to stream line by line.
+ * @param delayInMs - The delay in milliseconds between each chunk. Defaults to 10ms. Can be set to `null` to skip the delay.
+ * @param chunking - Controls how the text is chunked for streaming. Use "word" to stream word by word (default), "line" to stream line by line, or provide a custom RegExp pattern for custom chunking.
  *
  * @returns A transform stream that smooths text streaming output.
  */
 declare function smoothStream<TOOLS extends Record<string, CoreTool>>({ delayInMs, chunking, _internal: { delay }, }?: {
-    delayInMs?: number;
-    chunking?: 'word' | 'line';
+    delayInMs?: number | null;
+    chunking?: 'word' | 'line' | RegExp;
     /**
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
-        delay?: (delayInMs: number) => Promise<void>;
+        delay?: (delayInMs: number | null) => Promise<void>;
     };
 }): (options: {
     tools: TOOLS;
@@ -2284,6 +2284,24 @@ declare function experimental_createProviderRegistry(providers: Record<string, P
  */
 declare function cosineSimilarity(vector1: number[], vector2: number[]): number;
 
+/**
+ * Creates a ReadableStream that emits the provided values with an optional delay between each value.
+ *
+ * @param options - The configuration options
+ * @param options.chunks - Array of values to be emitted by the stream
+ * @param options.initialDelayInMs - Optional initial delay in milliseconds before emitting the first value (default: 0). Can be set to `null` to skip the initial delay. The difference between `initialDelayInMs: null` and `initialDelayInMs: 0` is that `initialDelayInMs: null` will emit the values without any delay, while `initialDelayInMs: 0` will emit the values with a delay of 0 milliseconds.
+ * @param options.chunkDelayInMs - Optional delay in milliseconds between emitting each value (default: 0). Can be set to `null` to skip the delay. The difference between `chunkDelayInMs: null` and `chunkDelayInMs: 0` is that `chunkDelayInMs: null` will emit the values without any delay, while `chunkDelayInMs: 0` will emit the values with a delay of 0 milliseconds.
+ * @returns A ReadableStream that emits the provided values
+ */
+declare function simulateReadableStream<T>({ chunks, initialDelayInMs, chunkDelayInMs, _internal, }: {
+    chunks: T[];
+    initialDelayInMs?: number | null;
+    chunkDelayInMs?: number | null;
+    _internal?: {
+        delay?: (ms: number | null) => Promise<void>;
+    };
+}): ReadableStream<T>;
+
 declare const symbol$9: unique symbol;
 declare class InvalidArgumentError extends AISDKError {
     private readonly [symbol$9];
@@ -2569,4 +2587,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createDataStream, createDataStreamResponse, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, generateObject, generateText, pipeDataStreamToResponse, smoothStream, streamObject, streamText, tool };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createDataStream, createDataStreamResponse, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool };

package/dist/index.js

@@ -70,6 +70,7 @@ __export(streams_exports, {
   pipeDataStreamToResponse: () => pipeDataStreamToResponse,
   processDataStream: () => import_ui_utils14.processDataStream,
   processTextStream: () => import_ui_utils14.processTextStream,
+  simulateReadableStream: () => simulateReadableStream,
   smoothStream: () => smoothStream,
   streamObject: () => streamObject,
   streamText: () => streamText,
@@ -289,7 +290,7 @@ var import_provider_utils = require("@ai-sdk/provider-utils");
 
 // util/delay.ts
 async function delay(delayInMs) {
-  return delayInMs === void 0 ? Promise.resolve() : new Promise((resolve) => setTimeout(resolve, delayInMs));
+  return delayInMs == null ? Promise.resolve() : new Promise((resolve) => setTimeout(resolve, delayInMs));
 }
 
 // util/retry-error.ts
@@ -5347,38 +5348,50 @@ var DefaultStreamTextResult = class {
 };
 
 // core/generate-text/smooth-stream.ts
+var import_provider17 = require("@ai-sdk/provider");
+var CHUNKING_REGEXPS = {
+  word: /\s*\S+\s+/m,
+  line: /[^\n]*\n/m
+};
 function smoothStream({
   delayInMs = 10,
   chunking = "word",
   _internal: { delay: delay2 = delay } = {}
 } = {}) {
-  let buffer = "";
-  return () => new TransformStream({
-    async transform(chunk, controller) {
-      if (chunk.type === "step-finish") {
-        if (buffer.length > 0) {
-          controller.enqueue({ type: "text-delta", textDelta: buffer });
-          buffer = "";
+  const chunkingRegexp = typeof chunking === "string" ? CHUNKING_REGEXPS[chunking] : chunking;
+  if (chunkingRegexp == null) {
+    throw new import_provider17.InvalidArgumentError({
+      argument: "chunking",
+      message: `Chunking must be "word" or "line" or a RegExp. Received: ${chunking}`
+    });
+  }
+  return () => {
+    let buffer = "";
+    return new TransformStream({
+      async transform(chunk, controller) {
+        if (chunk.type === "step-finish") {
+          if (buffer.length > 0) {
+            controller.enqueue({ type: "text-delta", textDelta: buffer });
+            buffer = "";
+          }
+          controller.enqueue(chunk);
+          return;
         }
-        controller.enqueue(chunk);
-        return;
-      }
-      if (chunk.type !== "text-delta") {
-        controller.enqueue(chunk);
-        return;
-      }
-      buffer += chunk.textDelta;
-      const regexp = chunking === "line" ? /[^\n]*\n/m : /\s*\S+\s+/m;
-      while (regexp.test(buffer)) {
-        const chunk2 = buffer.match(regexp)[0];
-        controller.enqueue({ type: "text-delta", textDelta: chunk2 });
-        buffer = buffer.slice(chunk2.length);
-        if (delayInMs > 0) {
+        if (chunk.type !== "text-delta") {
+          controller.enqueue(chunk);
+          return;
+        }
+        buffer += chunk.textDelta;
+        let match;
+        while ((match = chunkingRegexp.exec(buffer)) != null) {
+          const chunk2 = match[0];
+          controller.enqueue({ type: "text-delta", textDelta: chunk2 });
+          buffer = buffer.slice(chunk2.length);
           await delay2(delayInMs);
         }
       }
-    }
-  });
+    });
+  };
 }
 
 // core/middleware/wrap-language-model.ts
@@ -5416,7 +5429,7 @@ var experimental_wrapLanguageModel = ({
 };
 
 // core/registry/custom-provider.ts
-var import_provider17 = require("@ai-sdk/provider");
+var import_provider18 = require("@ai-sdk/provider");
 function experimental_customProvider({
   languageModels,
   textEmbeddingModels,
@@ -5430,7 +5443,7 @@ function experimental_customProvider({
       if (fallbackProvider) {
         return fallbackProvider.languageModel(modelId);
       }
-      throw new import_provider17.NoSuchModelError({ modelId, modelType: "languageModel" });
+      throw new import_provider18.NoSuchModelError({ modelId, modelType: "languageModel" });
     },
     textEmbeddingModel(modelId) {
       if (textEmbeddingModels != null && modelId in textEmbeddingModels) {
@@ -5439,18 +5452,18 @@ function experimental_customProvider({
       if (fallbackProvider) {
         return fallbackProvider.textEmbeddingModel(modelId);
       }
-      throw new import_provider17.NoSuchModelError({ modelId, modelType: "textEmbeddingModel" });
+      throw new import_provider18.NoSuchModelError({ modelId, modelType: "textEmbeddingModel" });
     }
   };
 }
 
 // core/registry/no-such-provider-error.ts
-var import_provider18 = require("@ai-sdk/provider");
+var import_provider19 = require("@ai-sdk/provider");
 var name13 = "AI_NoSuchProviderError";
 var marker13 = `vercel.ai.error.${name13}`;
 var symbol13 = Symbol.for(marker13);
 var _a13;
-var NoSuchProviderError = class extends import_provider18.NoSuchModelError {
+var NoSuchProviderError = class extends import_provider19.NoSuchModelError {
   constructor({
     modelId,
     modelType,
@@ -5464,13 +5477,13 @@ var NoSuchProviderError = class extends import_provider18.NoSuchModelError {
     this.availableProviders = availableProviders;
   }
   static isInstance(error) {
-    return import_provider18.AISDKError.hasMarker(error, marker13);
+    return import_provider19.AISDKError.hasMarker(error, marker13);
   }
 };
 _a13 = symbol13;
 
 // core/registry/provider-registry.ts
-var import_provider19 = require("@ai-sdk/provider");
+var import_provider20 = require("@ai-sdk/provider");
 function experimental_createProviderRegistry(providers) {
   const registry = new DefaultProviderRegistry();
   for (const [id, provider] of Object.entries(providers)) {
@@ -5500,7 +5513,7 @@ var DefaultProviderRegistry = class {
   splitId(id, modelType) {
     const index = id.indexOf(":");
     if (index === -1) {
-      throw new import_provider19.NoSuchModelError({
+      throw new import_provider20.NoSuchModelError({
         modelId: id,
         modelType,
         message: `Invalid ${modelType} id for registry: ${id} (must be in the format "providerId:modelId")`
@@ -5513,7 +5526,7 @@ var DefaultProviderRegistry = class {
     const [providerId, modelId] = this.splitId(id, "languageModel");
     const model = (_b = (_a14 = this.getProvider(providerId)).languageModel) == null ? void 0 : _b.call(_a14, modelId);
     if (model == null) {
-      throw new import_provider19.NoSuchModelError({ modelId: id, modelType: "languageModel" });
+      throw new import_provider20.NoSuchModelError({ modelId: id, modelType: "languageModel" });
     }
     return model;
   }
@@ -5523,7 +5536,7 @@ var DefaultProviderRegistry = class {
     const provider = this.getProvider(providerId);
     const model = (_a14 = provider.textEmbeddingModel) == null ? void 0 : _a14.call(provider, modelId);
     if (model == null) {
-      throw new import_provider19.NoSuchModelError({
+      throw new import_provider20.NoSuchModelError({
         modelId: id,
         modelType: "textEmbeddingModel"
       });
@@ -5562,6 +5575,28 @@ function magnitude(vector) {
   return Math.sqrt(dotProduct(vector, vector));
 }
 
+// core/util/simulate-readable-stream.ts
+function simulateReadableStream({
+  chunks,
+  initialDelayInMs = 0,
+  chunkDelayInMs = 0,
+  _internal
+}) {
+  var _a14;
+  const delay2 = (_a14 = _internal == null ? void 0 : _internal.delay) != null ? _a14 : delay;
+  let index = 0;
+  return new ReadableStream({
+    async pull(controller) {
+      if (index < chunks.length) {
+        await delay2(index === 0 ? initialDelayInMs : chunkDelayInMs);
+        controller.enqueue(chunks[index++]);
+      } else {
+        controller.close();
+      }
+    }
+  });
+}
+
 // streams/assistant-response.ts
 var import_ui_utils10 = require("@ai-sdk/ui-utils");
 function AssistantResponse({ threadId, messageId }, process2) {
@@ -5946,6 +5981,7 @@ var StreamData = class {
   pipeDataStreamToResponse,
   processDataStream,
   processTextStream,
+  simulateReadableStream,
   smoothStream,
   streamObject,
   streamText,