@xsai/stream-text 0.2.0 → 0.2.2

package/dist/index.d.ts

@@ -1,4 +1,33 @@
-import { ToolCall, FinishReason, Usage, ChatOptions, AssistantMessage, Message, StepType, CompletionToolCall, CompletionToolResult, Tool } from '@xsai/shared-chat';
+import { ToolMessagePart, FinishReason, Usage, ToolCall, ChatOptions, AssistantMessage, Message, StepType, CompletionToolCall, CompletionToolResult, Tool } from '@xsai/shared-chat';
+
+type StreamTextEvent = {
+    error: unknown;
+    type: 'error';
+} | {
+    error?: unknown;
+    id: string;
+    result?: string | ToolMessagePart[];
+    type: 'tool-call-result';
+} | {
+    finishReason?: FinishReason;
+    type: 'finish';
+    usage?: Usage;
+} | {
+    reasoning: string;
+    type: 'reasoning';
+} | {
+    refusal: string;
+    type: 'refusal';
+} | {
+    text: string;
+    type: 'text-delta';
+} | {
+    toolCall: ToolCall;
+    type: 'tool-call';
+} | {
+    toolCall: ToolCall;
+    type: 'tool-call-delta';
+};
 
 interface StreamTextChunkResult {
     choices: {
@@ -29,6 +58,11 @@ interface StreamTextOptions extends ChatOptions {
      * @param chunk - The current chunk of the stream.
      */
     onChunk?: (chunk: StreamTextChunkResult) => Promise<unknown> | unknown;
+    /**
+     * Callback function that is called with each event of the stream.
+     * @param event - The current event of the stream.
+     */
+    onEvent?: (event: StreamTextEvent) => Promise<unknown> | unknown;
     /**
      * Callback function that is called when the stream is finished.
      * @param result - The final result of the stream.
@@ -94,4 +128,4 @@ interface StreamTextToolCall extends ToolCall {
 }
 declare const streamText: (options: StreamTextOptions) => Promise<StreamTextResult>;
 
-export { type StreamTextChunkResult, type StreamTextOptions, type StreamTextResult, type StreamTextStep, streamText };
+export { type StreamTextChunkResult, type StreamTextEvent, type StreamTextOptions, type StreamTextResult, type StreamTextStep, streamText };

package/dist/index.js

@@ -61,6 +61,8 @@ const streamText = async (options) => {
     };
     const choiceState = {};
     let buffer = "";
+    let finishReason;
+    let usage;
     let shouldOutputText = true;
     const endToolCallByIndex = (state, idx) => {
       if (state.endedToolCallIndex.has(idx)) {
@@ -99,13 +101,21 @@ const streamText = async (options) => {
           stepCtrl.error(reason);
           textCtrl.error(reason);
         },
+        close: () => {
+          options2.onEvent?.({
+            finishReason,
+            type: "finish",
+            usage
+          });
+        },
         // eslint-disable-next-line sonarjs/cognitive-complexity
         write: async (chunk) => {
           options2.onChunk?.(chunk);
           chunkCtrl.enqueue(chunk);
+          usage = chunk.usage;
+          if (chunk.choices == null || chunk.choices.length === 0)
+            return;
           const choice = chunk.choices[0];
-          if (!choice)
-            throw new XSAIError("no choice found");
           if (choice.delta.tool_calls) {
             shouldOutputText = false;
           }
@@ -118,6 +128,7 @@ const streamText = async (options) => {
             }
           };
           if (finish_reason !== void 0) {
+            finishReason = finish_reason;
             step.finishReason = finish_reason;
             choiceSnapshot.finishReason = finish_reason;
             if (finish_reason === "length") {
@@ -133,12 +144,25 @@ const streamText = async (options) => {
           Object.assign(message, rests);
           if (refusal !== void 0) {
             message.refusal = (message.refusal || "") + (refusal || "");
+            options2.onEvent?.({
+              refusal: message.refusal,
+              type: "refusal"
+            });
           }
           if (content !== void 0) {
             message.content = (message.content || "") + (content || "");
             shouldOutputText && textCtrl?.enqueue(content);
+            options2.onEvent?.({
+              text: content,
+              type: "text-delta"
+            });
           }
-          for (const { function: fn, id, index: index2, type } of tool_calls || []) {
+          for (const tool_call of tool_calls || []) {
+            options2.onEvent?.({
+              toolCall: tool_call,
+              type: "tool-call-delta"
+            });
+            const { function: fn, id, index: index2, type } = tool_call;
             message.toolCalls ??= {};
             const toolCall = message.toolCalls[index2] ??= {
               function: {
@@ -202,6 +226,10 @@ const streamText = async (options) => {
         if (state.toolCallResults[toolCall.id]) {
           return;
         }
+        options2.onEvent?.({
+          toolCall,
+          type: "tool-call"
+        });
         try {
           const { parsedArgs, result, toolName } = await executeTool({
             abortSignal: options2.abortSignal,
@@ -222,6 +250,11 @@ const streamText = async (options) => {
             toolCallId: toolCall.id,
             toolName
           });
+          options2.onEvent?.({
+            id: toolCall.id,
+            result,
+            type: "tool-call-result"
+          });
         } catch (error) {
           state.toolCallErrors[idx] = error;
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xsai/stream-text",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "extra-small AI SDK.",
   "author": "Moeru AI",
   "license": "MIT",