@tambo-ai/typescript-sdk 0.70.0 → 0.72.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 0.72.0 (2025-09-19)
+
+Full Changelog: [v0.71.0...v0.72.0](https://github.com/tambo-ai/typescript-sdk/compare/v0.71.0...v0.72.0)
+
+### Features
+
+* **api:** api update ([d5e3a89](https://github.com/tambo-ai/typescript-sdk/commit/d5e3a89fba8b39bc801d1b9bce4ef953e62ab7a0))
+
+## 0.71.0 (2025-09-17)
+
+Full Changelog: [v0.70.0...v0.71.0](https://github.com/tambo-ai/typescript-sdk/compare/v0.70.0...v0.71.0)
+
+### Features
+
+* **api:** add new typescript target ([248b028](https://github.com/tambo-ai/typescript-sdk/commit/248b028efdc8a775f41e6221d820fb83b653d3ce))
+* **api:** fix temporary production repo ([b7a9127](https://github.com/tambo-ai/typescript-sdk/commit/b7a9127fa03eaf4f23b090a3ddcc328b72697b1b))
+* **api:** turn off `node`, turn on `typescript` ([54013ec](https://github.com/tambo-ai/typescript-sdk/commit/54013ec925970e6e38686361faa97c045deb0065))
+* **api:** turn on sdk publishing ([ca2b841](https://github.com/tambo-ai/typescript-sdk/commit/ca2b8418df9cced4585b0db6b06825e3d2c1e84d))
+
+
+### Chores
+
+* update SDK settings ([2bdb0e9](https://github.com/tambo-ai/typescript-sdk/commit/2bdb0e94d5e8e56a1286a8c0f705fb206fdea906))
+* update SDK settings ([d0f895b](https://github.com/tambo-ai/typescript-sdk/commit/d0f895bb3e4675f9aefb372779d62e42a95cc067))
+
 ## 0.70.0 (2025-09-09)
 
 Full Changelog: [v0.69.0...v0.70.0](https://github.com/tambo-ai/typescript-sdk/compare/v0.69.0...v0.70.0)

package/README.md

@@ -1,6 +1,6 @@
 # Tambo Typescript API Library
 
-[![NPM version](https://img.shields.io/npm/v/@tambo-ai/typescript-sdk.svg)](https://npmjs.org/package/@tambo-ai/typescript-sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@tambo-ai/typescript-sdk)
+[![NPM version](<https://img.shields.io/npm/v/@tambo-ai/typescript-sdk.svg?label=npm%20(stable)>)](https://npmjs.org/package/@tambo-ai/typescript-sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@tambo-ai/typescript-sdk)
 
 This library provides convenient access to the Tambo AI REST API from server-side TypeScript or JavaScript.
 
@@ -50,7 +50,7 @@ const client = new TamboAI({
 const params: TamboAI.Beta.ThreadAdvanceByIDParams = {
   messageToAppend: { role: 'user', content: [{ type: 'text', text: 'And what about oakland?' }] },
 };
-const response: TamboAI.Beta.ThreadAdvanceByIDResponse = await client.beta.threads.advanceById(
+const response: TamboAI.Beta.ThreadAdvanceByIDResponse = await client.beta.threads.advanceByID(
   'thr_123',
   params,
 );
@@ -67,7 +67,7 @@ a subclass of `APIError` will be thrown:
 <!-- prettier-ignore -->
 ```ts
 const response = await client.beta.threads
-  .advanceById('thr_123', {
+  .advanceByID('thr_123', {
     messageToAppend: { role: 'user', content: [{ type: 'text', text: 'And what about oakland?' }] },
   })
   .catch(async (err) => {
@@ -110,7 +110,7 @@ const client = new TamboAI({
 });
 
 // Or, configure per-request:
-await client.beta.threads.advanceById('thr_123', { messageToAppend: { role: 'user', content: [{ type: 'text', text: 'And what about oakland?' }] } }, {
+await client.beta.threads.advanceByID('thr_123', { messageToAppend: { role: 'user', content: [{ type: 'text', text: 'And what about oakland?' }] } }, {
   maxRetries: 5,
 });
 ```
@@ -127,7 +127,7 @@ const client = new TamboAI({
 });
 
 // Override per-request:
-await client.beta.threads.advanceById('thr_123', { messageToAppend: { role: 'user', content: [{ type: 'text', text: 'And what about oakland?' }] } }, {
+await client.beta.threads.advanceByID('thr_123', { messageToAppend: { role: 'user', content: [{ type: 'text', text: 'And what about oakland?' }] } }, {
   timeout: 5 * 1000,
 });
 ```
@@ -172,15 +172,17 @@ while (page.hasNextPage()) {
 ### Accessing raw Response data (e.g., headers)
 
 The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
+This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.
 
 You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
+Unlike `.asResponse()` this method consumes the body, returning once it is parsed.
 
 <!-- prettier-ignore -->
 ```ts
 const client = new TamboAI();
 
 const response = await client.beta.threads
-  .advanceById('thr_123', {
+  .advanceByID('thr_123', {
     messageToAppend: { role: 'user', content: [{ type: 'text', text: 'And what about oakland?' }] },
   })
   .asResponse();
@@ -188,7 +190,7 @@ console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
 const { data: response, response: raw } = await client.beta.threads
-  .advanceById('thr_123', {
+  .advanceByID('thr_123', {
     messageToAppend: { role: 'user', content: [{ type: 'text', text: 'And what about oakland?' }] },
   })
   .withResponse();
@@ -196,6 +198,59 @@ console.log(raw.headers.get('X-My-Header'));
 console.log(response.generationStage);
 ```
 
+### Logging
+
+> [!IMPORTANT]
+> All log messages are intended for debugging only. The format and content of log messages
+> may change between releases.
+
+#### Log levels
+
+The log level can be configured in two ways:
+
+1. Via the `TAMBO_AI_LOG` environment variable
+2. Using the `logLevel` client option (overrides the environment variable if set)
+
+```ts
+import TamboAI from '@tambo-ai/typescript-sdk';
+
+const client = new TamboAI({
+  logLevel: 'debug', // Show all log messages
+});
+```
+
+Available log levels, from most to least verbose:
+
+- `'debug'` - Show debug messages, info, warnings, and errors
+- `'info'` - Show info messages, warnings, and errors
+- `'warn'` - Show warnings and errors (default)
+- `'error'` - Show only errors
+- `'off'` - Disable all logging
+
+At the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.
+Some authentication-related headers are redacted, but sensitive data in request and response bodies
+may still be visible.
+
+#### Custom logger
+
+By default, this library logs to `globalThis.console`. You can also provide a custom logger.
+Most logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.
+
+When providing a custom logger, the `logLevel` option still controls which messages are emitted, messages
+below the configured level will not be sent to your logger.
+
+```ts
+import TamboAI from '@tambo-ai/typescript-sdk';
+import pino from 'pino';
+
+const logger = pino();
+
+const client = new TamboAI({
+  logger: logger.child({ name: 'TamboAI' }),
+  logLevel: 'debug', // Send all messages to pino, allowing it to filter
+});
+```
+
 ### Making custom/undocumented requests
 
 This library is typed for convenient access to the documented API. If you need to access undocumented
@@ -220,9 +275,8 @@ parameter. This library doesn't validate at runtime that the request matches the
 send will be sent as-is.
 
 ```ts
-client.foo.create({
-  foo: 'my_param',
-  bar: 12,
+client.beta.threads.advance({
+  // ...
   // @ts-expect-error baz is not yet public
   baz: 'undocumented option',
 });
@@ -242,70 +296,85 @@ validate or strip extra properties from the response from the API.
 
 ### Customizing the fetch client
 
-By default, this library uses `node-fetch` in Node, and expects a global `fetch` function in other environments.
+By default, this library expects a global `fetch` function is defined.
 
-If you would prefer to use a global, web-standards-compliant `fetch` function even in a Node environment,
-(for example, if you are running Node with `--experimental-fetch` or using NextJS which polyfills with `undici`),
-add the following import before your first import `from "TamboAI"`:
+If you want to use a different `fetch` function, you can either polyfill the global:
 
 ```ts
-// Tell TypeScript and the package to use the global web fetch instead of node-fetch.
-// Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.
-import '@tambo-ai/typescript-sdk/shims/web';
-import TamboAI from '@tambo-ai/typescript-sdk';
+import fetch from 'my-fetch';
+
+globalThis.fetch = fetch;
 ```
 
-To do the inverse, add `import "@tambo-ai/typescript-sdk/shims/node"` (which does import polyfills).
-This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/tambo-ai/typescript-sdk/tree/main/src/_shims#readme)).
+Or pass it to the client:
 
-### Logging and middleware
+```ts
+import TamboAI from '@tambo-ai/typescript-sdk';
+import fetch from 'my-fetch';
 
-You may also provide a custom `fetch` function when instantiating the client,
-which can be used to inspect or alter the `Request` or `Response` before/after each request:
+const client = new TamboAI({ fetch });
+```
+
+### Fetch options
+
+If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
 
 ```ts
-import { fetch } from 'undici'; // as one example
 import TamboAI from '@tambo-ai/typescript-sdk';
 
 const client = new TamboAI({
-  fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => {
-    console.log('About to make a request', url, init);
-    const response = await fetch(url, init);
-    console.log('Got response', response);
-    return response;
+  fetchOptions: {
+    // `RequestInit` options
   },
 });
 ```
 
-Note that if given a `DEBUG=true` environment variable, this library will log all requests and responses automatically.
-This is intended for debugging purposes only and may change in the future without notice.
+#### Configuring proxies
+
+To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy
+options to requests:
 
-### Configuring an HTTP(S) Agent (e.g., for proxies)
+<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
 
-By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.
+```ts
+import TamboAI from '@tambo-ai/typescript-sdk';
+import * as undici from 'undici';
 
-If you would like to disable or customize this behavior, for example to use the API behind a proxy, you can pass an `httpAgent` which is used for all requests (be they http or https), for example:
+const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
+const client = new TamboAI({
+  fetchOptions: {
+    dispatcher: proxyAgent,
+  },
+});
+```
+
+<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
 
-<!-- prettier-ignore -->
 ```ts
-import http from 'http';
-import { HttpsProxyAgent } from 'https-proxy-agent';
+import TamboAI from '@tambo-ai/typescript-sdk';
 
-// Configure the default for all requests:
 const client = new TamboAI({
-  httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
+  fetchOptions: {
+    proxy: 'http://localhost:8888',
+  },
 });
+```
 
-// Override per-request:
-await client.beta.threads.advanceById(
-  'thr_123',
-  { messageToAppend: { role: 'user', content: [{ type: 'text', text: 'And what about oakland?' }] } },
-  {
-    httpAgent: new http.Agent({ keepAlive: false }),
+<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
+
+```ts
+import TamboAI from 'npm:@tambo-ai/typescript-sdk';
+
+const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
+const client = new TamboAI({
+  fetchOptions: {
+    client: httpClient,
   },
-);
+});
 ```
 
+## Frequently Asked Questions
+
 ## Semantic versioning
 
 This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
@@ -320,12 +389,12 @@ We are keen for your feedback; please open an [issue](https://www.github.com/tam
 
 ## Requirements
 
-TypeScript >= 4.5 is supported.
+TypeScript >= 4.9 is supported.
 
 The following runtimes are supported:
 
 - Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
-- Node.js 18 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
+- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
 - Deno v1.28.0 or higher.
 - Bun 1.0 or later.
 - Cloudflare Workers.

package/api-promise.d.mts

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

package/api-promise.d.mts.map

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

package/api-promise.d.ts

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

package/api-promise.d.ts.map

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

package/api-promise.js

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

package/api-promise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-promise.js","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,gEAAmC"}

package/api-promise.mjs

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

package/api-promise.mjs.map

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

package/bin/cli

@@ -0,0 +1,53 @@
+#!/usr/bin/env node
+
+const { spawnSync } = require('child_process');
+
+const commands = {
+  migrate: {
+    description:
+      'Run migrations to update your code using @tambo-ai/typescript-sdk@1 to be compatible with @tambo-ai/typescript-sdk@2',
+    fn: () => {
+      const result = spawnSync(
+        'npx',
+        [
+          '-y',
+          'https://github.com/stainless-api/migrate-ts/releases/download/0.0.2/stainless-api-migrate-0.0.2-6.tgz',
+          '--migrationConfig',
+          require.resolve('./migration-config.json'),
+          ...process.argv.slice(3),
+        ],
+        { stdio: 'inherit' },
+      );
+      if (result.status !== 0) {
+        process.exit(result.status);
+      }
+    },
+  },
+};
+
+function exitWithHelp() {
+  console.log(`Usage: tambo-ai-typescript-sdk <subcommand>`);
+  console.log();
+  console.log('Subcommands:');
+
+  for (const [name, info] of Object.entries(commands)) {
+    console.log(`  ${name}  ${info.description}`);
+  }
+
+  console.log();
+  process.exit(1);
+}
+
+if (process.argv.length < 3) {
+  exitWithHelp();
+}
+
+const commandName = process.argv[2];
+
+const command = commands[commandName];
+if (!command) {
+  console.log(`Unknown subcommand ${commandName}.`);
+  exitWithHelp();
+}
+
+command.fn();

package/bin/migration-config.json

@@ -0,0 +1,213 @@
+{
+  "pkg": "@tambo-ai/typescript-sdk",
+  "githubRepo": "https://github.com/tambo-ai/typescript-sdk",
+  "clientClass": "TamboAI",
+  "methods": [
+    {
+      "base": "beta.projects.apiKey",
+      "name": "delete",
+      "params": [
+        {
+          "type": "param",
+          "key": "apiKeyId",
+          "location": "path"
+        },
+        {
+          "type": "params",
+          "maybeOverload": false
+        },
+        {
+          "type": "options"
+        }
+      ],
+      "oldParams": [
+        {
+          "type": "param",
+          "key": "id",
+          "location": "path"
+        },
+        {
+          "type": "param",
+          "key": "apiKeyId",
+          "location": "path"
+        },
+        {
+          "type": "options"
+        }
+      ]
+    },
+    {
+      "base": "beta.projects.providerKey",
+      "name": "delete",
+      "params": [
+        {
+          "type": "param",
+          "key": "providerKeyId",
+          "location": "path"
+        },
+        {
+          "type": "params",
+          "maybeOverload": false
+        },
+        {
+          "type": "options"
+        }
+      ],
+      "oldParams": [
+        {
+          "type": "param",
+          "key": "id",
+          "location": "path"
+        },
+        {
+          "type": "param",
+          "key": "providerKeyId",
+          "location": "path"
+        },
+        {
+          "type": "options"
+        }
+      ]
+    },
+    {
+      "base": "beta.threads.messages",
+      "name": "delete",
+      "params": [
+        {
+          "type": "param",
+          "key": "messageId",
+          "location": "path"
+        },
+        {
+          "type": "params",
+          "maybeOverload": false
+        },
+        {
+          "type": "options"
+        }
+      ],
+      "oldParams": [
+        {
+          "type": "param",
+          "key": "id",
+          "location": "path"
+        },
+        {
+          "type": "param",
+          "key": "messageId",
+          "location": "path"
+        },
+        {
+          "type": "options"
+        }
+      ]
+    },
+    {
+      "base": "beta.threads.messages",
+      "name": "updateComponentState",
+      "params": [
+        {
+          "type": "param",
+          "key": "messageId",
+          "location": "path"
+        },
+        {
+          "type": "params",
+          "maybeOverload": false
+        },
+        {
+          "type": "options"
+        }
+      ],
+      "oldParams": [
+        {
+          "type": "param",
+          "key": "id",
+          "location": "path"
+        },
+        {
+          "type": "param",
+          "key": "messageId",
+          "location": "path"
+        },
+        {
+          "type": "params",
+          "maybeOverload": false
+        },
+        {
+          "type": "options"
+        }
+      ]
+    },
+    {
+      "base": "beta.threads.suggestions",
+      "name": "list",
+      "params": [
+        {
+          "type": "param",
+          "key": "messageId",
+          "location": "path"
+        },
+        {
+          "type": "params",
+          "maybeOverload": false
+        },
+        {
+          "type": "options"
+        }
+      ],
+      "oldParams": [
+        {
+          "type": "param",
+          "key": "id",
+          "location": "path"
+        },
+        {
+          "type": "param",
+          "key": "messageId",
+          "location": "path"
+        },
+        {
+          "type": "options"
+        }
+      ]
+    },
+    {
+      "base": "beta.threads.suggestions",
+      "name": "generate",
+      "params": [
+        {
+          "type": "param",
+          "key": "messageId",
+          "location": "path"
+        },
+        {
+          "type": "params",
+          "maybeOverload": false
+        },
+        {
+          "type": "options"
+        }
+      ],
+      "oldParams": [
+        {
+          "type": "param",
+          "key": "id",
+          "location": "path"
+        },
+        {
+          "type": "param",
+          "key": "messageId",
+          "location": "path"
+        },
+        {
+          "type": "params",
+          "maybeOverload": false
+        },
+        {
+          "type": "options"
+        }
+      ]
+    }
+  ]
+}