assistant-stream 0.1.2 → 0.1.4

package/dist/index.d.ts

@@ -1,18 +1,10 @@
-import { a as AssistantStreamChunk, T as ToolResponse, R as ReadonlyJSONValue, c as AssistantMessage, d as AssistantStreamEncoder, A as AssistantStream } from './assistant-stream-54RSz6y3.js';
-export { e as createAssistantStream, f as createAssistantStreamResponse } from './assistant-stream-54RSz6y3.js';
-
-declare class PipeableTransformStream<I, O> extends TransformStream<I, O> {
-    constructor(transform: (readable: ReadableStream<I>) => ReadableStream<O>);
-}
-
-type ToolCallback = (toolCall: {
-    toolCallId: string;
-    toolName: string;
-    args: unknown;
-}) => Promise<ToolResponse<ReadonlyJSONValue>> | ToolResponse<ReadonlyJSONValue> | undefined;
-declare class ToolExecutionStream extends PipeableTransformStream<AssistantStreamChunk, AssistantStreamChunk> {
-    constructor(toolCallback: ToolCallback);
-}
+import { a as AssistantStreamChunk, c as AssistantMessage, d as AssistantStreamEncoder, A as AssistantStream, T as ToolResponse } from './assistant-stream-kAoIMgvk.js';
+export { e as createAssistantStream, f as createAssistantStreamResponse } from './assistant-stream-kAoIMgvk.js';
+import { JSONSchema7 } from 'json-schema';
+import { DeepPartial } from 'ai';
+import { A as AsyncIterableStream } from './AsyncIterableStream-C3C8ZoXv.js';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+import { R as ReadonlyJSONValue } from './json-value-Ch5eKkQ_.js';
 
 declare class AssistantMessageAccumulator extends TransformStream<AssistantStreamChunk, AssistantMessage> {
     constructor({ initialMessage, }?: {
@@ -20,6 +12,10 @@ declare class AssistantMessageAccumulator extends TransformStream<AssistantStrea
     });
 }
 
+declare class PipeableTransformStream<I, O> extends TransformStream<I, O> {
+    constructor(transform: (readable: ReadableStream<I>) => ReadableStream<O>);
+}
+
 declare class DataStreamEncoder extends PipeableTransformStream<AssistantStreamChunk, Uint8Array> implements AssistantStreamEncoder {
     headers: Headers;
     constructor();
@@ -47,4 +43,105 @@ declare class AssistantMessageStream {
     tee(): [AssistantMessageStream, AssistantMessageStream];
 }
 
-export { AssistantMessage, AssistantMessageAccumulator, AssistantMessageStream, AssistantStream, AssistantStreamChunk, DataStreamDecoder, DataStreamEncoder, PlainTextDecoder, PlainTextEncoder, ToolExecutionStream, ToolResponse };
+type AsNumber<K> = K extends `${infer N extends number}` ? N | K : never;
+type TupleIndex<T extends readonly any[]> = Exclude<keyof T, keyof any[]>;
+type ObjectKey<T> = keyof T & (string | number);
+type TypePath<T> = [] | (0 extends 1 & T ? any[] : T extends object ? T extends readonly any[] ? number extends T["length"] ? {
+    [K in TupleIndex<T>]: [AsNumber<K>, ...TypePath<T[K]>];
+}[TupleIndex<T>] : [
+    number,
+    ...TypePath<T[number]>
+] : {
+    [K in ObjectKey<T>]: [K, ...TypePath<T[K]>];
+}[ObjectKey<T>] : [
+]);
+type TypeAtPath<T, P extends readonly any[]> = P extends [
+    infer Head,
+    ...infer Rest
+] ? Head extends keyof T ? TypeAtPath<T[Head], Rest> : never : T;
+
+/**
+ * Interface for reading tool call arguments from a stream, which are
+ * generated by a language learning model (LLM). Provides methods to
+ * retrieve specific values, partial streams, or complete items from
+ * an array, based on a specified path.
+ *
+ * @template TArgs The type of arguments being read.
+ */
+interface ToolCallArgsReader<TArgs> {
+    /**
+     * Returns a promise that will resolve to the value at the given path,
+     * as soon as that path is generated by the LLM.
+     *
+     * @param fieldPath An array of object keys or array indices.
+     */
+    get<PathT extends TypePath<TArgs>>(...fieldPath: PathT): Promise<TypeAtPath<TArgs, PathT>>;
+    /**
+     * Returns a stream that will emit partial values at the given path,
+     * as they are generated by the LLM.
+     *
+     * @param fieldPath An array of object keys or array indices.
+     */
+    streamValues<PathT extends TypePath<TArgs>>(...fieldPath: PathT): AsyncIterableStream<DeepPartial<TypeAtPath<TArgs, PathT>>>;
+    /**
+     * Returns a stream that will emit partial text at the given path,
+     * as they are generated by the LLM.
+     *
+     * @param fieldPath An array of object keys or array indices.
+     */
+    streamText<PathT extends TypePath<TArgs>>(...fieldPath: PathT): TypeAtPath<TArgs, PathT> extends string & infer U ? AsyncIterableStream<U> : never;
+    /**
+     * Returns a stream that will emit complete items in the array
+     * at the given path, as they are generated by the LLM.
+     *
+     * @param fieldPath An array of object keys or array indices.
+     */
+    forEach<PathT extends TypePath<TArgs>>(...fieldPath: PathT): TypeAtPath<TArgs, PathT> extends Array<infer U> ? AsyncIterableStream<U> : never;
+}
+interface ToolCallResultReader<TResult> {
+    get: () => Promise<TResult>;
+}
+interface ToolCallReader<TArgs, TResult> {
+    args: ToolCallArgsReader<TArgs>;
+    result: ToolCallResultReader<TResult>;
+}
+type ToolExecutionContext = {
+    toolCallId: string;
+    abortSignal: AbortSignal;
+};
+type ToolExecuteFunction<TArgs, TResult> = (args: TArgs, context: ToolExecutionContext) => TResult | Promise<TResult>;
+type ToolStreamCallFunction<TArgs, TResult> = (reader: ToolCallReader<TArgs, TResult>, context: ToolExecutionContext) => void;
+type OnSchemaValidationErrorFunction<TResult> = ToolExecuteFunction<unknown, TResult>;
+type Tool<TArgs = unknown, TResult = unknown> = {
+    description?: string | undefined;
+    parameters: StandardSchemaV1<TArgs> | JSONSchema7;
+    execute?: ToolExecuteFunction<TArgs, TResult>;
+    /**
+     * @deprecated Experimental, API may change.
+     */
+    streamCall?: ToolStreamCallFunction<TArgs, TResult>;
+    experimental_onSchemaValidationError?: OnSchemaValidationErrorFunction<TResult>;
+};
+
+type ToolCallback = (toolCall: {
+    toolCallId: string;
+    toolName: string;
+    args: unknown;
+}) => Promise<ToolResponse<ReadonlyJSONValue>> | ToolResponse<ReadonlyJSONValue> | undefined;
+type ToolStreamCallback = <TArgs, TResult>(toolCall: {
+    reader: ToolCallReader<TArgs, TResult>;
+    toolCallId: string;
+    toolName: string;
+}) => void;
+type ToolExecutionOptions = {
+    execute: ToolCallback;
+    streamCall: ToolStreamCallback;
+};
+declare class ToolExecutionStream extends PipeableTransformStream<AssistantStreamChunk, AssistantStreamChunk> {
+    constructor(options: ToolExecutionOptions);
+}
+
+declare function unstable_runPendingTools(message: AssistantMessage, tools: Record<string, Tool<any, any>> | undefined, abortSignal: AbortSignal): Promise<AssistantMessage>;
+declare function toolResultStream(tools: Record<string, Tool<any, any>> | undefined, abortSignal: AbortSignal): ToolExecutionStream;
+
+export { AssistantMessage, AssistantMessageAccumulator, AssistantMessageStream, AssistantStream, AssistantStreamChunk, DataStreamDecoder, DataStreamEncoder, PlainTextDecoder, PlainTextEncoder, type Tool, type ToolCallReader, ToolExecutionStream, ToolResponse, unstable_runPendingTools, toolResultStream as unstable_toolResultStream };