@allternit/gizzi-sdk 1.3.0

package/dist/providers/allternit/lib/MessageStream.d.ts

@@ -0,0 +1,121 @@
+import { AllternitError, APIUserAbortError } from '../error';
+import { type ContentBlock, Messages, type Message, type MessageStreamEvent, type MessageParam, type MessageCreateParams, type MessageCreateParamsBase, type TextCitation, type ToolUseBlock, type ServerToolUseBlock } from '../resources/messages';
+import { RequestOptions } from '../internal/request-options';
+import type { Logger } from '../client';
+import { type ParsedMessage } from './parser';
+export interface MessageStreamEvents<ParsedT = null> {
+    connect: () => void;
+    streamEvent: (event: MessageStreamEvent, snapshot: Message) => void;
+    text: (textDelta: string, textSnapshot: string) => void;
+    citation: (citation: TextCitation, citationsSnapshot: TextCitation[]) => void;
+    inputJson: (partialJson: string, jsonSnapshot: unknown) => void;
+    thinking: (thinkingDelta: string, thinkingSnapshot: string) => void;
+    signature: (signature: string) => void;
+    message: (message: ParsedMessage<ParsedT>) => void;
+    contentBlock: (content: ContentBlock) => void;
+    finalMessage: (message: ParsedMessage<ParsedT>) => void;
+    error: (error: AllternitError) => void;
+    abort: (error: APIUserAbortError) => void;
+    end: () => void;
+}
+export type TracksToolInput = ToolUseBlock | ServerToolUseBlock;
+export declare class MessageStream<ParsedT = null> implements AsyncIterable<MessageStreamEvent> {
+    #private;
+    messages: MessageParam[];
+    receivedMessages: ParsedMessage<ParsedT>[];
+    controller: AbortController;
+    constructor(params: MessageCreateParamsBase | null, opts?: {
+        logger?: Logger | undefined;
+    });
+    get response(): Response | null | undefined;
+    get request_id(): string | null | undefined;
+    /**
+     * Returns the `MessageStream` data, the raw `Response` instance and the ID of the request,
+     * returned vie the `request-id` header which is useful for debugging requests and resporting
+     * issues to Allternit.
+     *
+     * This is the same as the `APIPromise.withResponse()` method.
+     *
+     * This method will raise an error if you created the stream using `MessageStream.fromReadableStream`
+     * as no `Response` is available.
+     */
+    withResponse(): Promise<{
+        data: MessageStream<ParsedT>;
+        response: Response;
+        request_id: string | null | undefined;
+    }>;
+    /**
+     * Intended for use on the frontend, consuming a stream produced with
+     * `.toReadableStream()` on the backend.
+     *
+     * Note that messages sent to the model do not appear in `.on('message')`
+     * in this context.
+     */
+    static fromReadableStream(stream: ReadableStream): MessageStream;
+    static createMessage<ParsedT>(messages: Messages, params: MessageCreateParamsBase, options?: RequestOptions, { logger }?: {
+        logger?: Logger | undefined;
+    }): MessageStream<ParsedT>;
+    protected _run(executor: () => Promise<any>): void;
+    protected _addMessageParam(message: MessageParam): void;
+    protected _addMessage(message: ParsedMessage<ParsedT>, emit?: boolean): void;
+    protected _createMessage(messages: Messages, params: MessageCreateParams, options?: RequestOptions): Promise<void>;
+    protected _connected(response: Response | null): void;
+    get ended(): boolean;
+    get errored(): boolean;
+    get aborted(): boolean;
+    abort(): void;
+    /**
+     * Adds the listener function to the end of the listeners array for the event.
+     * No checks are made to see if the listener has already been added. Multiple calls passing
+     * the same combination of event and listener will result in the listener being added, and
+     * called, multiple times.
+     * @returns this MessageStream, so that calls can be chained
+     */
+    on<Event extends keyof MessageStreamEvents<ParsedT>>(event: Event, listener: MessageStreamEvents<ParsedT>[Event]): this;
+    /**
+     * Removes the specified listener from the listener array for the event.
+     * off() will remove, at most, one instance of a listener from the listener array. If any single
+     * listener has been added multiple times to the listener array for the specified event, then
+     * off() must be called multiple times to remove each instance.
+     * @returns this MessageStream, so that calls can be chained
+     */
+    off<Event extends keyof MessageStreamEvents<ParsedT>>(event: Event, listener: MessageStreamEvents<ParsedT>[Event]): this;
+    /**
+     * Adds a one-time listener function for the event. The next time the event is triggered,
+     * this listener is removed and then invoked.
+     * @returns this MessageStream, so that calls can be chained
+     */
+    once<Event extends keyof MessageStreamEvents<ParsedT>>(event: Event, listener: MessageStreamEvents<ParsedT>[Event]): this;
+    /**
+     * This is similar to `.once()`, but returns a Promise that resolves the next time
+     * the event is triggered, instead of calling a listener callback.
+     * @returns a Promise that resolves the next time given event is triggered,
+     * or rejects if an error is emitted.  (If you request the 'error' event,
+     * returns a promise that resolves with the error).
+     *
+     * Example:
+     *
+     *   const message = await stream.emitted('message') // rejects if the stream errors
+     */
+    emitted<Event extends keyof MessageStreamEvents<ParsedT>>(event: Event): Promise<Parameters<MessageStreamEvents<ParsedT>[Event]> extends [infer Param] ? Param : Parameters<MessageStreamEvents<ParsedT>[Event]> extends [] ? void : Parameters<MessageStreamEvents<ParsedT>[Event]>>;
+    done(): Promise<void>;
+    get currentMessage(): Message | undefined;
+    /**
+     * @returns a promise that resolves with the the final assistant Message response,
+     * or rejects if an error occurred or the stream ended prematurely without producing a Message.
+     * If structured outputs were used, this will be a ParsedMessage with a `parsed_output` field.
+     */
+    finalMessage(): Promise<ParsedMessage<ParsedT>>;
+    /**
+     * @returns a promise that resolves with the the final assistant Message's text response, concatenated
+     * together if there are more than one text blocks.
+     * Rejects if an error occurred or the stream ended prematurely without producing a Message.
+     */
+    finalText(): Promise<string>;
+    protected _emit<Event extends keyof MessageStreamEvents<ParsedT>>(event: Event, ...args: Parameters<MessageStreamEvents<ParsedT>[Event]>): void;
+    protected _emitFinal(): void;
+    protected _fromReadableStream(readableStream: ReadableStream, options?: RequestOptions): Promise<void>;
+    [Symbol.asyncIterator](): AsyncIterator<MessageStreamEvent>;
+    toReadableStream(): ReadableStream;
+}
+//# sourceMappingURL=MessageStream.d.ts.map

package/dist/providers/allternit/lib/MessageStream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MessageStream.d.ts","sourceRoot":"","sources":["../../../../src/providers/allternit/lib/MessageStream.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7D,OAAO,EACL,KAAK,YAAY,EACjB,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAE5B,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACxB,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAqB,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAEjE,MAAM,WAAW,mBAAmB,CAAC,OAAO,GAAG,IAAI;IACjD,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,WAAW,EAAE,CAAC,KAAK,EAAE,kBAAkB,EAAE,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;IACpE,IAAI,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;IACxD,QAAQ,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,iBAAiB,EAAE,YAAY,EAAE,KAAK,IAAI,CAAC;IAC9E,SAAS,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,KAAK,IAAI,CAAC;IAChE,QAAQ,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,KAAK,IAAI,CAAC;IACpE,SAAS,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;IACvC,OAAO,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IACnD,YAAY,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,CAAC;IAC9C,YAAY,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IACxD,KAAK,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IACvC,KAAK,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAC1C,GAAG,EAAE,MAAM,IAAI,CAAC;CACjB;AASD,MAAM,MAAM,eAAe,GAAG,YAAY,GAAG,kBAAkB,CAAC;AAMhE,qBAAa,aAAa,CAAC,OAAO,GAAG,IAAI,CAAE,YAAW,aAAa,CAAC,kBAAkB,CAAC;;IACrF,QAAQ,EAAE,YAAY,EAAE,CAAM;IAC9B,gBAAgB,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,CAAM;IAIhD,UAAU,EAAE,eAAe,CAAyB;gBAsBxC,MAAM,EAAE,uBAAuB,GAAG,IAAI,EAAE,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE;IAsB1F,IAAI,QAAQ,IAAI,QAAQ,GAAG,IAAI,GAAG,SAAS,CAE1C;IAED,IAAI,UAAU,IAAI,MAAM,GAAG,IAAI,GAAG,SAAS,CAE1C;IAED;;;;;;;;;OASG;IACG,YAAY,IAAI,OAAO,CAAC;QAC5B,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;QAC7B,QAAQ,EAAE,QAAQ,CAAC;QACnB,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;KACvC,CAAC;IAeF;;;;;;OAMG;IACH,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,cAAc,GAAG,aAAa;IAMhE,MAAM,CAAC,aAAa,CAAC,OAAO,EAC1B,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,EACxB,EAAE,MAAM,EAAE,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAO,GAC/C,aAAa,CAAC,OAAO,CAAC;IAgBzB,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC;IAO3C,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,YAAY;IAIhD,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,IAAI,UAAO;cAOlD,cAAc,CAC5B,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IA4BhB,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;IAQ9C,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,KAAK;IAIL;;;;;;OAMG;IACH,EAAE,CAAC,KAAK,SAAS,MAAM,mBAAmB,CAAC,OAAO,CAAC,EACjD,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,GAC5C,IAAI;IAOP;;;;;;OAMG;IACH,GAAG,CAAC,KAAK,SAAS,MAAM,mBAAmB,CAAC,OAAO,CAAC,EAClD,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,GAC5C,IAAI;IAQP;;;;OAIG;IACH,IAAI,CAAC,KAAK,SAAS,MAAM,mBAAmB,CAAC,OAAO,CAAC,EACnD,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,GAC5C,IAAI;IAOP;;;;;;;;;;OAUG;IACH,OAAO,CAAC,KAAK,SAAS,MAAM,mBAAmB,CAAC,OAAO,CAAC,EACtD,KAAK,EAAE,KAAK,GACX,OAAO,CACR,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,GAC3E,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,GAAG,IAAI,GACjE,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAClD;IAQK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAK3B,IAAI,cAAc,IAAI,OAAO,GAAG,SAAS,CAExC;IASD;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAmBrD;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IA0BlC,SAAS,CAAC,KAAK,CAAC,KAAK,SAAS,MAAM,mBAAmB,CAAC,OAAO,CAAC,EAC9D,KAAK,EAAE,KAAK,EACZ,GAAG,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC;IA8C1D,SAAS,CAAC,UAAU;cAqFJ,mBAAmB,CACjC,cAAc,EAAE,cAAc,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAmJhB,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,kBAAkB,CAAC;IA6D3D,gBAAgB,IAAI,cAAc;CAInC"}