@tambo-ai/typescript-sdk 0.83.0 → 0.84.0

package/src/internal/decoders/line.ts

@@ -0,0 +1,135 @@
+import { concatBytes, decodeUTF8, encodeUTF8 } from '../utils/bytes';
+
+export type Bytes = string | ArrayBuffer | Uint8Array | null | undefined;
+
+/**
+ * A re-implementation of httpx's `LineDecoder` in Python that handles incrementally
+ * reading lines from text.
+ *
+ * https://github.com/encode/httpx/blob/920333ea98118e9cf617f246905d7b202510941c/httpx/_decoders.py#L258
+ */
+export class LineDecoder {
+  // prettier-ignore
+  static NEWLINE_CHARS = new Set(['\n', '\r']);
+  static NEWLINE_REGEXP = /\r\n|[\n\r]/g;
+
+  #buffer: Uint8Array;
+  #carriageReturnIndex: number | null;
+
+  constructor() {
+    this.#buffer = new Uint8Array();
+    this.#carriageReturnIndex = null;
+  }
+
+  decode(chunk: Bytes): string[] {
+    if (chunk == null) {
+      return [];
+    }
+
+    const binaryChunk =
+      chunk instanceof ArrayBuffer ? new Uint8Array(chunk)
+      : typeof chunk === 'string' ? encodeUTF8(chunk)
+      : chunk;
+
+    this.#buffer = concatBytes([this.#buffer, binaryChunk]);
+
+    const lines: string[] = [];
+    let patternIndex;
+    while ((patternIndex = findNewlineIndex(this.#buffer, this.#carriageReturnIndex)) != null) {
+      if (patternIndex.carriage && this.#carriageReturnIndex == null) {
+        // skip until we either get a corresponding `\n`, a new `\r` or nothing
+        this.#carriageReturnIndex = patternIndex.index;
+        continue;
+      }
+
+      // we got double \r or \rtext\n
+      if (
+        this.#carriageReturnIndex != null &&
+        (patternIndex.index !== this.#carriageReturnIndex + 1 || patternIndex.carriage)
+      ) {
+        lines.push(decodeUTF8(this.#buffer.subarray(0, this.#carriageReturnIndex - 1)));
+        this.#buffer = this.#buffer.subarray(this.#carriageReturnIndex);
+        this.#carriageReturnIndex = null;
+        continue;
+      }
+
+      const endIndex =
+        this.#carriageReturnIndex !== null ? patternIndex.preceding - 1 : patternIndex.preceding;
+
+      const line = decodeUTF8(this.#buffer.subarray(0, endIndex));
+      lines.push(line);
+
+      this.#buffer = this.#buffer.subarray(patternIndex.index);
+      this.#carriageReturnIndex = null;
+    }
+
+    return lines;
+  }
+
+  flush(): string[] {
+    if (!this.#buffer.length) {
+      return [];
+    }
+    return this.decode('\n');
+  }
+}
+
+/**
+ * This function searches the buffer for the end patterns, (\r or \n)
+ * and returns an object with the index preceding the matched newline and the
+ * index after the newline char. `null` is returned if no new line is found.
+ *
+ * ```ts
+ * findNewLineIndex('abc\ndef') -> { preceding: 2, index: 3 }
+ * ```
+ */
+function findNewlineIndex(
+  buffer: Uint8Array,
+  startIndex: number | null,
+): { preceding: number; index: number; carriage: boolean } | null {
+  const newline = 0x0a; // \n
+  const carriage = 0x0d; // \r
+
+  for (let i = startIndex ?? 0; i < buffer.length; i++) {
+    if (buffer[i] === newline) {
+      return { preceding: i, index: i + 1, carriage: false };
+    }
+
+    if (buffer[i] === carriage) {
+      return { preceding: i, index: i + 1, carriage: true };
+    }
+  }
+
+  return null;
+}
+
+export function findDoubleNewlineIndex(buffer: Uint8Array): number {
+  // This function searches the buffer for the end patterns (\r\r, \n\n, \r\n\r\n)
+  // and returns the index right after the first occurrence of any pattern,
+  // or -1 if none of the patterns are found.
+  const newline = 0x0a; // \n
+  const carriage = 0x0d; // \r
+
+  for (let i = 0; i < buffer.length - 1; i++) {
+    if (buffer[i] === newline && buffer[i + 1] === newline) {
+      // \n\n
+      return i + 2;
+    }
+    if (buffer[i] === carriage && buffer[i + 1] === carriage) {
+      // \r\r
+      return i + 2;
+    }
+    if (
+      buffer[i] === carriage &&
+      buffer[i + 1] === newline &&
+      i + 3 < buffer.length &&
+      buffer[i + 2] === carriage &&
+      buffer[i + 3] === newline
+    ) {
+      // \r\n\r\n
+      return i + 4;
+    }
+  }
+
+  return -1;
+}

package/src/internal/parse.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import type { FinalRequestOptions } from './request-options';
+import { Stream } from '../core/streaming';
 import { type TamboAI } from '../client';
 import { formatRequestDetails, loggerFor } from './utils/log';
 
@@ -16,6 +17,19 @@ export type APIResponseProps = {
 export async function defaultParseResponse<T>(client: TamboAI, props: APIResponseProps): Promise<T> {
   const { response, requestLogID, retryOfRequestLogID, startTime } = props;
   const body = await (async () => {
+    if (props.options.stream) {
+      loggerFor(client).debug('response', response.status, response.url, response.headers, response.body);
+
+      // Note: there is an invariant here that isn't represented in the type system
+      // that if you set `stream: true` the response type must also be `Stream<T>`
+
+      if (props.options.__streamClass) {
+        return props.options.__streamClass.fromSSEResponse(response, props.controller, client) as any;
+      }
+
+      return Stream.fromSSEResponse(response, props.controller, client) as any;
+    }
+
     // fetch refuses to read the body when the status code is 204.
     if (response.status === 204) {
       return null as T;

package/src/internal/request-options.ts

@@ -3,6 +3,7 @@
 import { NullableHeaders } from './headers';
 
 import type { BodyInit } from './builtin-types';
+import { Stream } from '../core/streaming';
 import type { HTTPMethod, MergedRequestInit } from './types';
 import { type HeadersLike } from './headers';
 
@@ -76,6 +77,7 @@ export type RequestOptions = {
   defaultBaseURL?: string | undefined;
 
   __binaryResponse?: boolean | undefined;
+  __streamClass?: typeof Stream;
 };
 
 export type EncodedContent = { bodyHeaders: HeadersLike; body: BodyInit };

package/src/resources/threads/index.ts

@@ -10,7 +10,9 @@ export {
 export {
   Runs,
   type InputMessage,
+  type RunCreateResponse,
   type RunDeleteResponse,
+  type RunRunResponse,
   type RunCreateParams,
   type RunDeleteParams,
   type RunRunParams,

package/src/resources/threads/runs.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../../core/resource';
 import * as RunsAPI from './runs';
 import * as ThreadsAPI from './threads';
 import { APIPromise } from '../../core/api-promise';
+import { Stream } from '../../core/streaming';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -15,7 +16,7 @@ export class Runs extends APIResource {
    *
    * @example
    * ```ts
-   * await client.threads.runs.create({
+   * const run = await client.threads.runs.create({
    *   message: {
    *     content: [{ text: 'Hello, world!', type: 'text' }],
    *     role: 'user',
@@ -23,12 +24,13 @@ export class Runs extends APIResource {
    * });
    * ```
    */
-  create(body: RunCreateParams, options?: RequestOptions): APIPromise<void> {
+  create(body: RunCreateParams, options?: RequestOptions): APIPromise<Stream<RunCreateResponse>> {
     return this._client.post('/v1/threads/runs', {
       body,
       ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+      headers: buildHeaders([{ Accept: 'text/event-stream' }, options?.headers]),
+      stream: true,
+    }) as APIPromise<Stream<RunCreateResponse>>;
   }
 
   /**
@@ -54,20 +56,24 @@ export class Runs extends APIResource {
    *
    * @example
    * ```ts
-   * await client.threads.runs.run('thr_abc123xyz', {
-   *   message: {
-   *     content: [{ text: 'Hello, world!', type: 'text' }],
-   *     role: 'user',
+   * const response = await client.threads.runs.run(
+   *   'thr_abc123xyz',
+   *   {
+   *     message: {
+   *       content: [{ text: 'Hello, world!', type: 'text' }],
+   *       role: 'user',
+   *     },
    *   },
-   * });
+   * );
    * ```
    */
-  run(threadID: string, body: RunRunParams, options?: RequestOptions): APIPromise<void> {
+  run(threadID: string, body: RunRunParams, options?: RequestOptions): APIPromise<Stream<RunRunResponse>> {
     return this._client.post(path`/v1/threads/${threadID}/runs`, {
       body,
       ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+      headers: buildHeaders([{ Accept: 'text/event-stream' }, options?.headers]),
+      stream: true,
+    }) as APIPromise<Stream<RunRunResponse>>;
   }
 }
 
@@ -88,6 +94,19 @@ export interface InputMessage {
   metadata?: unknown;
 }
 
+export interface RunCreateResponse {
+  /**
+   * Event type discriminator (e.g., RUN_STARTED, TEXT_MESSAGE_CONTENT,
+   * TOOL_CALL_START)
+   */
+  type: string;
+
+  /**
+   * Unix timestamp (milliseconds) when event was generated
+   */
+  timestamp?: number;
+}
+
 export interface RunDeleteResponse {
   /**
    * The run ID that was cancelled
@@ -100,6 +119,19 @@ export interface RunDeleteResponse {
   status: 'cancelled';
 }
 
+export interface RunRunResponse {
+  /**
+   * Event type discriminator (e.g., RUN_STARTED, TEXT_MESSAGE_CONTENT,
+   * TOOL_CALL_START)
+   */
+  type: string;
+
+  /**
+   * Unix timestamp (milliseconds) when event was generated
+   */
+  timestamp?: number;
+}
+
 export interface RunCreateParams {
   /**
    * The user's message
@@ -346,7 +378,9 @@ export namespace RunRunParams {
 export declare namespace Runs {
   export {
     type InputMessage as InputMessage,
+    type RunCreateResponse as RunCreateResponse,
     type RunDeleteResponse as RunDeleteResponse,
+    type RunRunResponse as RunRunResponse,
     type RunCreateParams as RunCreateParams,
     type RunDeleteParams as RunDeleteParams,
     type RunRunParams as RunRunParams,

package/src/resources/threads/threads.ts

@@ -15,9 +15,11 @@ import * as RunsAPI from './runs';
 import {
   InputMessage,
   RunCreateParams,
+  RunCreateResponse,
   RunDeleteParams,
   RunDeleteResponse,
   RunRunParams,
+  RunRunResponse,
   Runs,
 } from './runs';
 import { APIPromise } from '../../core/api-promise';
@@ -528,7 +530,9 @@ export declare namespace Threads {
   export {
     Runs as Runs,
     type InputMessage as InputMessage,
+    type RunCreateResponse as RunCreateResponse,
     type RunDeleteResponse as RunDeleteResponse,
+    type RunRunResponse as RunRunResponse,
     type RunCreateParams as RunCreateParams,
     type RunDeleteParams as RunDeleteParams,
     type RunRunParams as RunRunParams,

package/src/streaming.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/streaming instead */
+export * from './core/streaming';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.83.0'; // x-release-please-version
+export const VERSION = '0.84.0'; // x-release-please-version

package/streaming.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/streaming.mjs";
+//# sourceMappingURL=streaming.d.mts.map

package/streaming.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.d.mts","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":""}

package/streaming.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/streaming.js";
+//# sourceMappingURL=streaming.d.ts.map

package/streaming.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.d.ts","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":""}

package/streaming.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/streaming instead */
+tslib_1.__exportStar(require("./core/streaming.js"), exports);
+//# sourceMappingURL=streaming.js.map

package/streaming.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.js","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,8DAAiC"}

package/streaming.mjs

@@ -0,0 +1,2 @@
+export * from "./core/streaming.mjs";
+//# sourceMappingURL=streaming.mjs.map

package/streaming.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.mjs","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":""}

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.83.0";
+export declare const VERSION = "0.84.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.83.0";
+export declare const VERSION = "0.84.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.83.0'; // x-release-please-version
+exports.VERSION = '0.84.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.83.0'; // x-release-please-version
+export const VERSION = '0.84.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map