@xsai/stream-object 0.1.0-beta.7 → 0.1.0-beta.8

package/dist/index.d.ts

@@ -2,15 +2,36 @@ import { StreamTextOptions, StreamTextResult } from '@xsai/stream-text';
 import { PartialDeep } from 'type-fest';
 import { Schema, Infer } from 'xsschema';
 
+interface StreamObjectOnFinishResult<T extends Schema> {
+    object?: Infer<T>;
+}
 interface StreamObjectOptions<T extends Schema> extends StreamTextOptions {
     schema: T;
     schemaDescription?: string;
     schemaName?: string;
 }
 interface StreamObjectResult<T extends Schema> extends StreamTextResult {
-    partialObjectStream: ReadableStream<PartialDeep<Infer<T>>>;
+    elementStream?: ReadableStream<Infer<T>>;
+    partialObjectStream?: ReadableStream<PartialDeep<Infer<T>>>;
+}
+interface StreamObjectExtraOptions<T extends Schema> {
+    onFinish?: (result: StreamObjectOnFinishResult<T>) => unknown;
 }
-/** @experimental WIP */
-declare const streamObject: <T extends Schema>(options: StreamObjectOptions<T>) => Promise<StreamObjectResult<T>>;
+declare function streamObject<T extends Schema>(options: StreamObjectExtraOptions<T> & StreamObjectOptions<T> & {
+    output: 'array';
+}): Promise<StreamObjectResult<T> & {
+    elementStream: ReadableStream<Infer<T>>;
+    partialObjectStream: undefined;
+}>;
+declare function streamObject<T extends Schema>(options: StreamObjectExtraOptions<T> & StreamObjectOptions<T> & {
+    output: 'object';
+}): Promise<StreamObjectResult<T> & {
+    elementStream: undefined;
+    partialObjectStream: ReadableStream<PartialDeep<Infer<T>>>;
+}>;
+declare function streamObject<T extends Schema>(options: StreamObjectExtraOptions<T> & StreamObjectOptions<T>): Promise<StreamObjectResult<T> & {
+    elementStream: undefined;
+    partialObjectStream: ReadableStream<PartialDeep<Infer<T>>>;
+}>;
 
-export { type StreamObjectOptions, type StreamObjectResult, streamObject };
+export { type StreamObjectOnFinishResult, type StreamObjectOptions, type StreamObjectResult, streamObject };

package/dist/index.js

@@ -251,44 +251,90 @@ var require_parse = __commonJS({
 var import_best_effort_json_parser = __toESM(require_parse(), 1);
 import { streamText } from "@xsai/stream-text";
 import { toJSONSchema } from "xsschema";
-var streamObject = async (options) => streamText({
-  ...options,
-  response_format: {
-    json_schema: {
-      description: options.schemaDescription,
-      name: options.schemaName ?? "json_schema",
-      schema: await toJSONSchema(options.schema),
-      strict: true
+var wrap = (schema) => {
+  return {
+    properties: {
+      elements: {
+        items: schema,
+        type: "array"
+      }
     },
-    type: "json_schema"
-  },
-  schema: void 0,
-  schemaDescription: void 0,
-  schemaName: void 0
-}).then(({ chunkStream, stepStream, textStream: rawTextStream }) => {
-  const [textStream, rawPartialObjectStream] = rawTextStream.tee();
-  let partialObjectData = "";
-  let partialObjectSnapshot = {};
-  const partialObjectStream = rawPartialObjectStream.pipeThrough(new TransformStream({
-    transform: (chunk, controller) => {
-      partialObjectData += chunk;
-      try {
-        const data = (0, import_best_effort_json_parser.parse)(partialObjectData);
-        if (JSON.stringify(partialObjectSnapshot) !== JSON.stringify(data)) {
-          partialObjectSnapshot = data;
-          controller.enqueue(data);
+    required: ["elements"],
+    type: "object"
+  };
+};
+async function streamObject(options) {
+  const { schema: schemaValidator } = options;
+  let schema = await toJSONSchema(schemaValidator);
+  if (options.output === "array")
+    schema = wrap(schema);
+  return streamText({
+    ...options,
+    response_format: {
+      json_schema: {
+        description: options.schemaDescription,
+        name: options.schemaName ?? "json_schema",
+        schema,
+        strict: true
+      },
+      type: "json_schema"
+    },
+    schema: void 0,
+    schemaDescription: void 0,
+    schemaName: void 0
+  }).then(({ chunkStream, stepStream, textStream }) => {
+    let elementStream;
+    let partialObjectStream;
+    let index = 0;
+    if (options.output === "array") {
+      let rawElementStream;
+      [rawElementStream, textStream] = textStream.tee();
+      let partialData = "";
+      elementStream = rawElementStream.pipeThrough(new TransformStream({
+        flush: (controller) => {
+          const data = (0, import_best_effort_json_parser.parse)(partialData);
+          controller.enqueue(data.elements.at(-1));
+          options.onFinish?.({ object: data.elements });
+        },
+        transform: (chunk, controller) => {
+          partialData += chunk;
+          try {
+            const data = (0, import_best_effort_json_parser.parse)(partialData);
+            if (Array.isArray(Object.getOwnPropertyDescriptor(data, "elements")?.value) && data.elements.length > index + 1) {
+              controller.enqueue(data.elements[index++]);
+            }
+          } catch {
+          }
         }
-      } catch {
-      }
+      }));
+    } else {
+      let rawPartialObjectStream;
+      [textStream, rawPartialObjectStream] = textStream.tee();
+      let partialObjectData = "";
+      let partialObjectSnapshot = {};
+      partialObjectStream = rawPartialObjectStream.pipeThrough(new TransformStream({
+        transform: (chunk, controller) => {
+          partialObjectData += chunk;
+          try {
+            const data = (0, import_best_effort_json_parser.parse)(partialObjectData);
+            if (JSON.stringify(partialObjectSnapshot) !== JSON.stringify(data)) {
+              partialObjectSnapshot = data;
+              controller.enqueue(data);
+            }
+          } catch {
+          }
+        }
+      }));
     }
-  }));
-  return {
-    chunkStream,
-    partialObjectStream,
-    stepStream,
-    textStream
-  };
-});
+    return {
+      chunkStream,
+      elementStream,
+      partialObjectStream,
+      stepStream,
+      textStream
+    };
+  });
+}
 export {
   streamObject
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xsai/stream-object",
   "type": "module",
-  "version": "0.1.0-beta.7",
+  "version": "0.1.0-beta.8",
   "description": "extra-small AI SDK for Browser, Node.js, Deno, Bun or Edge Runtime.",
   "author": "Moeru AI",
   "license": "MIT",