UNPKG

@tanstack/ai

Version:

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

tanstack.com/ai

TanStack/ai

31 lines (30 loc) • 1.47 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
import { Tool } from '../types.js'; /** * A provider-specific tool produced by an adapter-package factory * (e.g. `webSearchTool` from `@tanstack/ai-anthropic/tools`). * * The two `~`-prefixed fields are type-only phantom brands — they are never * assigned at runtime. They allow the core type system to match a factory's * output against the selected model's `supports.tools` list and surface a * compile-time error when the combination is unsupported. * * User-defined tools (via `toolDefinition()`) remain plain `Tool` and stay * assignable to any model. * * @template TProvider - Provider identifier (e.g. `'anthropic'`, `'openai'`). * @template TKind - Canonical tool-kind string matching the provider's * `supports.tools` entries (e.g. `'web_search'`, `'code_execution'`). */ export interface ProviderTool<TProvider extends string, TKind extends string> extends Tool { readonly '~provider': TProvider; readonly '~toolKind': TKind; } /** * Attach the `ProviderTool` phantom brand to a plain `Tool`-shaped object. * * The brand fields (`'~provider'`, `'~toolKind'`) exist only in the type * system and are never assigned at runtime, so this is a single audited * type-only assertion. Use it inside adapter `xxxTool()` factories instead * of `as unknown as` — the cast collapses to one named site. */ export declare function brandProviderTool<T extends ProviderTool<string, string>>(tool: Omit<T, '~provider' | '~toolKind'>): T;