@tanstack/ai-client 0.25.2 → 0.28.0

package/dist/esm/chat-client.js

@@ -1,9 +1,11 @@
+import { prepareResolvedByokHeaders, resolveByokProviderId } from "./byok/resolve.js";
 import { createNoOpChatDevtoolsBridge } from "./devtools-noop.js";
-import { fetcherToConnectionAdapter, getChunkRunId, normalizeConnectionAdapter } from "./connection-adapters.js";
+import { fetcherToConnectionAdapter, getChunkRunId as getChunkRunId$1, normalizeConnectionAdapter } from "./connection-adapters.js";
 import { ChatPersistor } from "./client-persistor.js";
 import { ClearedStreamTracker } from "./cleared-stream-tracker.js";
 import { InterruptManager } from "./interrupt-manager.js";
-import { StreamProcessor, convertSchemaToJsonSchema, generateMessageId, isStandardSchema, normalizeToUIMessage, parseWithStandardSchema } from "@tanstack/ai/client";
+import { StreamProcessor, convertSchemaToJsonSchema, generateMessageId, isStandardSchema, mergeMetadata, normalizeToUIMessage, parseWithStandardSchema, restoreInboundChunk, tanstackMetadata } from "@tanstack/ai/client";
+import { ByokBlockedError, ByokMissingError, ByokUnresolvedProviderError } from "@tanstack/ai/byok";
 //#region src/chat-client.ts
 function assertUniqueInterruptDefinitions(interrupts) {
 	const ids = /* @__PURE__ */ new Set();
@@ -49,6 +51,7 @@ function normalizeQueueOption(option) {
 * Merge a run of queued messages into a single send for `drain: 'batch'`.
 * All-string content is joined with newlines; mixed/multimodal content is
 * flattened into a single `ContentPart` array. The last item's `body` wins.
+* Object-form metadata is merged last-write-wins per key.
 */
 function mergeQueuedMessages(items) {
 	const body = items.at(-1)?.body;
@@ -62,17 +65,27 @@ function mergeQueuedMessages(items) {
 		...body !== void 0 ? { body } : {}
 	};
 	const parts = [];
-	for (const item of items) if (typeof item.content === "string") parts.push({
-		type: "text",
-		content: item.content
-	});
-	else if (typeof item.content.content === "string") parts.push({
-		type: "text",
-		content: item.content.content
-	});
-	else parts.push(...item.content.content);
+	let metadata;
+	for (const item of items) {
+		if (typeof item.content === "string") {
+			parts.push({
+				type: "text",
+				content: item.content
+			});
+			continue;
+		}
+		if (typeof item.content.content === "string") parts.push({
+			type: "text",
+			content: item.content.content
+		});
+		else parts.push(...item.content.content);
+		metadata = mergeMetadata(metadata, item.content.metadata);
+	}
 	return {
-		content: { content: parts },
+		content: {
+			content: parts,
+			...metadata !== void 0 ? { metadata } : {}
+		},
 		...body !== void 0 ? { body } : {}
 	};
 }
@@ -137,6 +150,8 @@ var ChatClient = class {
 	activeResumeRunId = null;
 	bodyOption = {};
 	forwardedPropsOption = {};
+	byok;
+	byokProvider;
 	context = void 0;
 	pendingMessageBody = void 0;
 	queueConfig;
@@ -217,6 +232,8 @@ var ChatClient = class {
 		}
 		this.bodyOption = options.body || {};
 		this.forwardedPropsOption = options.forwardedProps || {};
+		this.byok = options.byok;
+		this.byokProvider = options.byokProvider;
 		this.context = options.context;
 		this.queueConfig = normalizeQueueOption(options.queue);
 		this.connection = normalizeConnectionAdapter(resolveTransport(options));
@@ -511,15 +528,15 @@ var ChatClient = class {
 	}
 	retireIgnoredClearedTerminalChunk(chunk) {
 		if (chunk.type !== "RUN_FINISHED" && chunk.type !== "RUN_ERROR") return;
-		const runId = getChunkRunId(chunk) ?? this.clearedStreamTracker.takeRunlessRunId();
+		const runId = getChunkRunId$1(chunk) ?? this.clearedStreamTracker.takeRunlessRunId();
 		if (!runId) return;
 		this.activeRunIds.delete(runId);
 		this.setSessionGenerating(this.activeRunIds.size > 0);
-		if (!getChunkRunId(chunk)) this.resolveProcessing();
+		if (!getChunkRunId$1(chunk)) this.resolveProcessing();
 	}
 	updateRunLifecycle(chunk, options) {
 		if (chunk.type === "RUN_STARTED") {
-			const chunkRunId = getChunkRunId(chunk) ?? chunk.runId;
+			const chunkRunId = getChunkRunId$1(chunk) ?? chunk.runId;
 			this.activeResumeThreadId = "threadId" in chunk && typeof chunk.threadId === "string" ? chunk.threadId : this.activeResumeThreadId;
 			this.activeResumeRunId = chunkRunId;
 			this.activeRunIds.add(chunkRunId);
@@ -532,7 +549,7 @@ var ChatClient = class {
 			return;
 		}
 		if (chunk.type !== "RUN_FINISHED" && chunk.type !== "RUN_ERROR") return;
-		const runId = getChunkRunId(chunk);
+		const runId = getChunkRunId$1(chunk);
 		if (runId) {
 			this.activeRunIds.delete(runId);
 			this.clearedStreamTracker.onRunSettled(runId);
@@ -552,7 +569,7 @@ var ChatClient = class {
 	observeInterruptState(chunk) {
 		if (chunk.type !== "RUN_FINISHED" && chunk.type !== "RUN_ERROR") return;
 		if (this.activeInterruptSubmission && chunk.type === "RUN_ERROR") return;
-		const runId = getChunkRunId(chunk);
+		const runId = getChunkRunId$1(chunk);
 		const threadId = "threadId" in chunk && typeof chunk.threadId === "string" ? chunk.threadId : this.activeResumeThreadId;
 		if (chunk.type === "RUN_FINISHED" && chunk.outcome?.type === "interrupt") {
 			const interruptedRunId = this.currentRunId ?? runId ?? this.activeResumeRunId ?? "";
@@ -943,11 +960,15 @@ var ChatClient = class {
 		if (last && last.role === "assistant") this.processor.setMessages(messages.slice(0, -1));
 	}
 	async processIncomingChunk(chunk, options) {
-		if (chunk.type === "RUN_ERROR" && this.isActiveInterruptSubmissionFailure(chunk)) this.interruptSubmissionFailure = { errors: chunk["tanstack:interruptErrors"] ?? [] };
+		chunk = restoreInboundChunk(chunk);
+		if (chunk.type === "RUN_ERROR" && this.isActiveInterruptSubmissionFailure(chunk)) {
+			const interruptErrors = tanstackMetadata(chunk)?.interruptErrors;
+			this.interruptSubmissionFailure = { errors: Array.isArray(interruptErrors) ? interruptErrors : [] };
+		}
 		if (this.connectionStatus === "connecting") this.setConnectionStatus("connected");
 		if (this.clearedStreamTracker.shouldIgnoreChunk(chunk)) {
 			if (chunk.type === "RUN_FINISHED" || chunk.type === "RUN_ERROR") {
-				if (getChunkRunId(chunk)) this.updateRunLifecycle(chunk, { resolveProcessing: false });
+				if (getChunkRunId$1(chunk)) this.updateRunLifecycle(chunk, { resolveProcessing: false });
 				else this.drainIgnoredRunlessChunk(chunk);
 				this.retireIgnoredClearedTerminalChunk(chunk);
 				this.resolveJoinedRun(chunk);
@@ -964,16 +985,19 @@ var ChatClient = class {
 	}
 	isActiveInterruptSubmissionFailure(chunk) {
 		const submission = this.activeInterruptSubmission;
-		const errors = chunk["tanstack:interruptErrors"];
-		if (!submission || !errors || errors.length === 0) return false;
-		const runId = getChunkRunId(chunk);
+		const errors = tanstackMetadata(chunk)?.interruptErrors;
+		if (!submission || !Array.isArray(errors) || errors.length === 0) return false;
+		const runId = getChunkRunId$1(chunk);
 		if (runId !== void 0 && runId !== this.currentRunId) return false;
 		if (typeof chunk.threadId === "string" && chunk.threadId !== submission.threadId) return false;
-		return errors.every((error) => error.threadId === submission.threadId && error.interruptedRunId === submission.interruptedRunId && error.generation === submission.generation);
+		return errors.every((error) => {
+			if (error == null || typeof error !== "object" || typeof error.threadId !== "string" || typeof error.interruptedRunId !== "string" || typeof error.generation !== "number") return false;
+			return error.threadId === submission.threadId && error.interruptedRunId === submission.interruptedRunId && error.generation === submission.generation;
+		});
 	}
 	resolveJoinedRun(chunk) {
 		if (chunk.type !== "RUN_FINISHED" && chunk.type !== "RUN_ERROR") return;
-		const runId = getChunkRunId(chunk);
+		const runId = getChunkRunId$1(chunk);
 		if (runId === void 0) return;
 		const resolve = this.joinedRunWaiters.get(runId);
 		if (resolve === void 0) return;
@@ -1009,8 +1033,12 @@ var ChatClient = class {
 	*   - A MultimodalContent object with content array and optional custom ID
 	* @param body - Optional body parameters to merge with the client's base body for this request.
 	*               Uses shallow merge with per-message body taking priority.
-	* @param sendOptions - Per-call overrides, e.g. `{ whenBusy: 'interrupt' }` to
-	*                      override the configured queue policy for this one send.
+	* @param sendOptions - Per-call overrides. `{ whenBusy }` overrides the
+	*                      queue policy for this one send. `{ body }`
+	*                      shallow-merges with `body` and with the chat-level
+	*                      `body` / `forwardedProps`. `sendOptions.body` wins
+	*                      on key collisions. Framework hooks forward this
+	*                      object as their second argument.
 	*
 	* @example
 	* ```ts
@@ -1020,9 +1048,13 @@ var ChatClient = class {
 	* // Text message with custom body params
 	* await client.sendMessage('Hello!', { temperature: 0.7 })
 	*
-	* // Per-call whenBusy override (body must still be the 2nd arg on ChatClient)
+	* // Per-call whenBusy override
 	* await client.sendMessage('Urgent', undefined, { whenBusy: 'interrupt' })
 	*
+	* // Per-call body via options. Same effect as the positional arg.
+	* // This is the shape the framework hooks (`useChat`, `injectChat`) forward.
+	* await client.sendMessage('Hello!', undefined, { body: { temperature: 0.7 } })
+	*
 	* // Multimodal message with image
 	* await client.sendMessage({
 	*   content: [
@@ -1048,11 +1080,15 @@ var ChatClient = class {
 		this.mountDevtools();
 		if (typeof content === "string" && !content.trim()) return;
 		if (this.hasBlockingInterrupts()) throw new Error("ChatClient: cannot send normal input while pending interrupts exist. Use resumeInterrupts() instead.");
+		const resolvedBody = {
+			...body,
+			...sendOptions?.body
+		};
 		if (this.isSendBusy()) {
 			const { action, id } = this.decideWhenBusy(content, sendOptions);
 			if (action === "drop") return;
 			if (action === "queue") {
-				this.enqueueMessage(content, body, id);
+				this.enqueueMessage(content, resolvedBody, id);
 				return;
 			}
 			this.stopMessageQueueDrain = true;
@@ -1061,7 +1097,7 @@ var ChatClient = class {
 			this.resetSessionGenerating();
 		} else this.sendInFlight = true;
 		try {
-			await this.deliverMessage(content, body);
+			await this.deliverMessage(content, resolvedBody);
 		} finally {
 			this.sendInFlight = false;
 		}
@@ -1096,7 +1132,7 @@ var ChatClient = class {
 		try {
 			const normalizedContent = this.normalizeMessageInput(content);
 			this.pendingMessageBody = body;
-			const userMessage = this.processor.addUserMessage(normalizedContent.content, normalizedContent.id);
+			const userMessage = this.processor.addUserMessage(normalizedContent.content, normalizedContent.id, normalizedContent.metadata);
 			this.events.messageSent(userMessage.id, normalizedContent.content);
 			return await this.streamResponse();
 		} finally {
@@ -1149,14 +1185,15 @@ var ChatClient = class {
 		this.emitQueueChange();
 	}
 	/**
-	* Normalize the message input to extract content and optional id.
-	* Trims string content automatically.
+	* Normalize the message input to extract content, optional id, and
+	* optional metadata. String form has no metadata. Trims string content.
 	*/
 	normalizeMessageInput(input) {
 		if (typeof input === "string") return { content: input.trim() };
 		return {
 			content: input.content,
-			id: input.id
+			id: input.id,
+			...input.metadata !== void 0 ? { metadata: input.metadata } : {}
 		};
 	}
 	/**
@@ -1228,6 +1265,11 @@ var ChatClient = class {
 			this.processor.prepareAssistantMessage();
 			this.ensureSubscription();
 			const processingComplete = this.waitForProcessing();
+			let byokHeaders;
+			if (this.byok) {
+				const provider = resolveByokProviderId(this.byokProvider, mergedBody.provider);
+				byokHeaders = await prepareResolvedByokHeaders(this.byok, provider);
+			}
 			const runContext = {
 				threadId: resumeThreadId ?? this.threadId,
 				runId,
@@ -1238,7 +1280,8 @@ var ChatClient = class {
 					parameters: t.inputSchema ? convertSchemaToJsonSchema(t.inputSchema) : { type: "object" }
 				})),
 				forwardedProps: { ...mergedBody },
-				...resumeItems ? { resume: resumeItems } : {}
+				...resumeItems ? { resume: resumeItems } : {},
+				...byokHeaders ? { headers: byokHeaders } : {}
 			};
 			this.devtoolsBridge.beginRun(runContext.runId, runContext.threadId);
 			activeDevtoolsRunId = runContext.runId;
@@ -1260,22 +1303,24 @@ var ChatClient = class {
 			this.processor.finalizeStream();
 			streamCompletedSuccessfully = true;
 		} catch (err) {
-			if (err instanceof Error) {
-				if (err.name === "AbortError") {
-					if (activeDevtoolsRunId) {
-						this.devtoolsBridge.emitRunLifecycle("run:cancelled", activeDevtoolsRunId, "cancelled");
-						runTerminalEventEmitted = true;
-					}
-					return false;
+			const error = err instanceof Error ? err : new Error(String(err));
+			if (error.name === "AbortError") {
+				if (activeDevtoolsRunId) {
+					this.devtoolsBridge.emitRunLifecycle("run:cancelled", activeDevtoolsRunId, "cancelled");
+					runTerminalEventEmitted = true;
 				}
-				if (generation === this.streamGeneration) {
-					this.reportStreamError(err);
-					if (activeDevtoolsRunId) {
-						this.devtoolsBridge.emitRunLifecycle("run:errored", activeDevtoolsRunId, "errored", { error: err.message });
-						runTerminalEventEmitted = true;
-					}
+				return false;
+			}
+			if (error instanceof ByokMissingError) this.byok?.request(error.provider, "missing");
+			if (error instanceof ByokBlockedError && error.reason === "locked") this.byok?.request(error.provider, "locked");
+			if (generation === this.streamGeneration) {
+				this.reportStreamError(error);
+				if (activeDevtoolsRunId) {
+					this.devtoolsBridge.emitRunLifecycle("run:errored", activeDevtoolsRunId, "errored", { error: error.message });
+					runTerminalEventEmitted = true;
 				}
 			}
+			if (generation === this.streamGeneration && (error instanceof ByokMissingError || error instanceof ByokBlockedError || error instanceof ByokUnresolvedProviderError)) throw error;
 		} finally {
 			if (generation === this.streamGeneration) {
 				this.currentStreamId = null;
@@ -1293,18 +1338,8 @@ var ChatClient = class {
 				}
 				await this.drainPostStreamActions();
 				if (streamCompletedSuccessfully) {
-					const lastPart = this.processor.getMessages().at(-1)?.parts.at(-1);
-					const { finishReason } = this.processor.getState();
-					if (lastPart?.type === "tool-result" && finishReason !== "stop" && this.shouldAutoSend()) try {
-						await this.checkForContinuation();
-					} catch (error) {
-						console.error("Failed to continue flow after tool result:", error);
-						await this.drainQueue();
-					}
-					else {
-						if (this.status !== "ready") this.setStatus("ready");
-						if (!this.messageQueueDraining) await this.drainQueue();
-					}
+					if (this.status !== "ready") this.setStatus("ready");
+					if (!this.messageQueueDraining) await this.drainQueue();
 				} else this.flushQueue();
 			}
 		}
@@ -1661,6 +1696,8 @@ var ChatClient = class {
 		}
 		if (options.body !== void 0) this.bodyOption = options.body;
 		if (options.forwardedProps !== void 0) this.forwardedPropsOption = options.forwardedProps;
+		if (options.byok !== void 0) this.byok = options.byok;
+		if (options.byokProvider !== void 0) this.byokProvider = options.byokProvider;
 		if ("context" in options) this.context = options.context;
 		if (options.tools !== void 0) {
 			this.interruptManager.updateTools(options.tools);