@tanstack/ai/dist/esm/byok/keyed.js

Type-safe TypeScript AI SDK for streaming chat, tool calling, agents, structured outputs, and multimodal generation.

import { isProviderId, resolveProviderId } from "./providers.js";
//#region src/byok/keyed.ts
var KEYED_ADAPTER = Symbol.for("tanstack.ai.keyedAdapter");
/**
* Wrap an adapter factory that needs a provider key. The host finds the key
* and calls `create` just before each call, so the key is not in your code
* or in a `.env` file. Works for every adapter kind: text, image, speech,
* audio, video, and the rest.
*
* @param provider - The provider whose key `create` needs: a BYOK descriptor
*   such as `openaiByok` (its `env` names are the fallback), or a provider id.
* @param create - Builds the adapter from the key.
* @throws Error when the provider id is not a valid BYOK slug.
*
* @example
* ```ts
* import { createOpenaiChat } from '@tanstack/ai-openai'
* import { openaiByok } from '@tanstack/ai-openai/byok'
*
* const adapter = keyedAdapter(openaiByok, (key) =>
*   createOpenaiChat('gpt-5.5', key),
* )
* // In a server route, with `getByokKey` from `@tanstack/ai/byok/server`:
* const key = getByokKey(request, adapter.provider)
* if (key) chat({ adapter: adapter.create(key), messages })
* ```
*/
function keyedAdapter(provider, create) {
	const id = resolveProviderId(provider);
	if (!isProviderId(id)) throw new Error(`Invalid BYOK provider id: ${id}`);
	return {
		[KEYED_ADAPTER]: true,
		provider,
		create
	};
}
/**
* True when `value` came from {@link keyedAdapter}. A host uses it to decide
* if an adapter needs a key first.
*/
function isKeyedAdapter(value) {
	return typeof value === "object" && value !== null && KEYED_ADAPTER in value;
}
/**
* Keyed adapters for several providers in one map. The map key is the
* provider id, so a key goes only to the factory of its own provider. An
* entry is a factory (the key comes only from the `x-byok-<id>` header), or a
* {@link keyedAdapter} made with a BYOK descriptor (its `env` names are the
* fallback). Pick one per request with `keyedAdapterFromRequest` from
* `@tanstack/ai/byok/server`.
*
* @throws Error when a key is not a valid provider id, or when a keyed adapter
*   entry is for a different provider than its key.
*
* @example
* ```ts
* const models = keyedAdapters({
*   openai: (key) => createOpenaiChat('gpt-6.1-sol', key),
*   anthropic: keyedAdapter(anthropicByok, (key) =>
*     createAnthropicChat('claude-sonnet-5-5', key),
*   ),
* })
* ```
*/
function keyedAdapters(map) {
	const entries = Object.entries(map).map(([id, entry]) => {
		if (!isKeyedAdapter(entry)) return [id, keyedAdapter(id, entry)];
		const entryId = resolveProviderId(entry.provider);
		if (entryId !== id) throw new Error(`keyedAdapters: the "${id}" entry is a keyed adapter for "${entryId}"`);
		return [id, entry];
	});
	return Object.fromEntries(entries);
}
//#endregion
export { isKeyedAdapter, keyedAdapter, keyedAdapters };

//# sourceMappingURL=keyed.js.map