@savantoai/ai-sdk 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -30,6 +30,71 @@ under semver, meaning:
 caret update. Bumping that range is itself a major-version event for the
 SDK.
 
+## 3.1.0 — 2026-05-19
+
+### Added
+
+- Search responses may include `query.truncated` and `query.originalLength` on
+  product and post search when the input text was shortened server-side.
+
+### Changed
+
+- **`POST /recommendations`** response type now uses the standard
+  `{ object, requestId, data }` envelope (`object: "recommendations"`).
+  Payload fields remain under `data`.
+- **OpenAPI alignment** for non-streaming `POST /chat` and `POST /threads/search`
+  (documented envelopes; chat wire format unchanged if you already read `data`).
+- **`POST /threads/search`** list field is `data.items` in generated types (matches
+  the handler; replaces any `results` naming in older spec snapshots).
+
+### Breaking (TypeScript)
+
+- **`Product.stockStatus` and `Product.type`** are strict enums. Values outside
+  `instock | outofstock | onbackorder` and `simple | grouped | external | variable`
+  are omitted at runtime and absent from the type.
+- Any client code that assumed recommendations returned only `{ data: T }` at the
+  top level should use the generated `PostRecommendationsResponse` type (includes
+  `object` and `requestId`).
+
+## Unreleased
+
+### Breaking — streaming chat protocol
+
+> The SDK's TypeScript surface is unchanged, but the **wire protocol** for
+> the `/chat` streaming endpoint has been rewritten. Any client code that
+> switches on `chunk.type` (including code generated against earlier
+> versions of this README's example) must be migrated. The SDK is not
+> under semver for the wire protocol — see _Versioning policy_ above —
+> but we're flagging this prominently because real client switches will
+> silently stop matching after this rollout.
+
+The `/chat` streaming protocol has been rewritten to a block-based shape.
+The legacy `text_delta`, `product`, `post`, `post_delta`, and `bubble_termination`
+chunk types are gone; the new types are `block_start`, `block_delta`, `block_data`,
+`item_delta`, and `block_end`, plus existing flow-control chunks (`progress`,
+`prompts`, `metadata`, `complete`, `error`, `domain_offer`, `domain_offer_success`,
+`agent_status`, `handoff_ended`, `analytics`, `usage`).
+
+Migration cheat-sheet for code switching on `chunk.type`:
+
+| Old chunk type        | New chunk type                                                 |
+| --------------------- | -------------------------------------------------------------- |
+| `text_delta`          | `block_delta` (read `chunk.data.content`)                      |
+| `product` / `post`    | `block_data` (full payload) + `block_start` (ordering)         |
+| `post_delta`          | `item_delta` (read `chunk.data.field` + `chunk.data.delta`)    |
+| `bubble_termination`  | (removed — single message bubble per turn now)                 |
+
+The SDK's exported `ChatStreamChunk` type is intentionally unchanged
+(`{ type: string; data?: unknown }`) — no SDK regen is required. See
+the [Streaming Chat docs](https://savanto.ai/docs/developers/streaming)
+for the full chunk reference and a worked React example.
+
+The streaming `chat.message_sent` webhook payload has also picked up
+`responseMessage.respondedBy` (which domain answered) and
+`responseMessage.composedBlocks` (a tiny `{ type, ids }[]` describing
+the structured blocks the composer wove together for multi-domain answers).
+See the [Webhooks docs](https://savanto.ai/docs/developers/webhooks#chatmessage_sent).
+
 ## 3.0.0 — 2026-05-12
 
 ### Breaking (TypeScript)

package/README.md

@@ -114,7 +114,12 @@ const { data, response } = await chat({
   throwOnError: true,
 });
 
-// For streaming (NDJSON), read the response body directly:
+// For streaming (NDJSON), read the response body directly. The protocol is
+// block-based: text streams as `block_delta` chunks inside an active text
+// block, structured items arrive as `block_data` keyed by item id, and
+// per-field streaming (post summaries, product reasons, etc.) flows through
+// `item_delta`. See https://savanto.ai/docs/developers/streaming for the
+// full chunk-type reference.
 const reader = response.body!.getReader();
 const decoder = new TextDecoder();
 
@@ -124,7 +129,7 @@ while (true) {
   const lines = decoder.decode(value).split('\n').filter(Boolean);
   for (const line of lines) {
     const chunk = JSON.parse(line);
-    if (chunk.type === 'text_delta') process.stdout.write(chunk.data);
+    if (chunk.type === 'block_delta') process.stdout.write(chunk.data.content);
   }
 }
 ```

package/dist/index.cjs

@@ -325,8 +325,8 @@ const checkForExistence = (options, name) => {
 	if (options.headers.has(name) || options.query?.[name] || options.headers.get("Cookie")?.includes(`${name}=`)) return true;
 	return false;
 };
-const setAuthParams = async ({ security, ...options }) => {
-	for (const auth of security) {
+async function setAuthParams(options) {
+	for (const auth of options.security ?? []) {
 		if (checkForExistence(options, auth.name)) continue;
 		const token = await getAuthToken(auth, options.auth);
 		if (!token) continue;
@@ -344,7 +344,7 @@ const setAuthParams = async ({ security, ...options }) => {
 				break;
 		}
 	}
-};
+}
 const buildUrl = (options) => getUrl({
 	baseUrl: options.baseUrl,
 	path: options.path,
@@ -454,10 +454,7 @@ const createClient = (config = {}) => {
 			headers: mergeHeaders(_config.headers, options.headers),
 			serializedBody: void 0
 		};
-		if (opts.security) await setAuthParams({
-			...opts,
-			security: opts.security
-		});
+		if (opts.security) await setAuthParams(opts);
 		if (opts.requestValidator) await opts.requestValidator(opts);
 		if (opts.body !== void 0 && opts.bodySerializer) opts.serializedBody = opts.bodySerializer(opts.body);
 		if (opts.body === void 0 || opts.serializedBody === "") opts.headers.delete("Content-Type");