@xsai/stream-text 0.0.26 → 0.0.28

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-import { ChatOptions, FinishReason } from '@xsai/shared-chat';
+import { ChatOptions, FinishReason, Usage } from '@xsai/shared-chat';
 
 interface StreamTextOptions extends ChatOptions {
+    onChunk?: (chunk: ChunkResult) => Promise<void> | void;
     /** if you want to disable stream, use `@xsai/generate-{text,object}` */
     stream?: never;
     streamOptions?: {
@@ -12,18 +13,13 @@ interface StreamTextOptions extends ChatOptions {
         usage?: boolean;
     };
 }
-interface StreamTextResponseUsage {
-    completion_tokens: number;
-    prompt_tokens: number;
-    total_tokens: number;
-}
 interface StreamTextResult {
-    chunkStream: ReadableStream<StreamTextResponse>;
+    chunkStream: ReadableStream<ChunkResult>;
     finishReason?: FinishReason;
     textStream: ReadableStream<string>;
-    usage?: StreamTextResponseUsage;
+    usage?: Usage;
 }
-interface StreamTextResponse {
+interface ChunkResult {
     choices: {
         delta: {
             content: string;
@@ -37,11 +33,11 @@ interface StreamTextResponse {
     model: string;
     object: 'chat.completion.chunk';
     system_fingerprint: string;
-    usage?: StreamTextResponseUsage;
+    usage?: Usage;
 }
 /**
  * @experimental WIP, does not support function calling (tools).
  */
 declare const streamText: (options: StreamTextOptions) => Promise<StreamTextResult>;
 
-export { type StreamTextOptions, type StreamTextResponse, type StreamTextResponseUsage, type StreamTextResult, streamText as default, streamText };
+export { type ChunkResult, type StreamTextOptions, type StreamTextResult, streamText as default, streamText };

package/dist/index.js

@@ -1,7 +1,7 @@
 import { chat } from '@xsai/shared-chat';
 
-const dataHeaderPrefix = "data: ";
-const dataErrorPrefix = `{"error":`;
+const chunkHeaderPrefix = "data: ";
+const chunkErrorPrefix = `{"error":`;
 const streamText = async (options) => await chat({
   ...options,
   stream: true
@@ -11,30 +11,32 @@ const streamText = async (options) => await chat({
   let usage;
   let buffer = "";
   const rawChunkStream = res.body.pipeThrough(new TransformStream({
-    transform: (chunk, controller) => {
+    transform: async (chunk, controller) => {
       buffer += decoder.decode(chunk);
       const lines = buffer.split("\n\n");
       buffer = lines.pop() || "";
       for (const line of lines) {
-        if (!line || !line.startsWith(dataHeaderPrefix)) {
+        if (!line || !line.startsWith(chunkHeaderPrefix)) {
           continue;
         }
-        if (line.startsWith(dataErrorPrefix)) {
+        if (line.startsWith(chunkErrorPrefix)) {
           controller.error(new Error(`Error from server: ${line}`));
           break;
         }
-        const lineWithoutPrefix = line.slice(dataHeaderPrefix.length);
+        const lineWithoutPrefix = line.slice(chunkHeaderPrefix.length);
         if (lineWithoutPrefix === "[DONE]") {
           controller.terminate();
           break;
         }
-        const data = JSON.parse(lineWithoutPrefix);
-        controller.enqueue(data);
-        if (data.choices[0].finish_reason) {
-          finishReason = data.choices[0].finish_reason;
+        const chunk2 = JSON.parse(lineWithoutPrefix);
+        controller.enqueue(chunk2);
+        if (options.onChunk)
+          await options.onChunk(chunk2);
+        if (chunk2.choices[0].finish_reason) {
+          finishReason = chunk2.choices[0].finish_reason;
         }
-        if (data.usage) {
-          usage = data.usage;
+        if (chunk2.usage) {
+          usage = chunk2.usage;
         }
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xsai/stream-text",
-  "version": "0.0.26",
+  "version": "0.0.28",
   "type": "module",
   "author": "Moeru AI",
   "license": "MIT",