@tanstack/ai-grok 0.12.4 → 0.13.0

package/dist/esm/model-meta.js

@@ -1,30 +1,3 @@
-const GROK_4_1_FAST_REASONING = {
-  name: "grok-4-1-fast-reasoning"
-};
-const GROK_4_1_FAST_NON_REASONING = {
-  name: "grok-4-1-fast-non-reasoning"
-};
-const GROK_CODE_FAST_1 = {
-  name: "grok-code-fast-1"
-};
-const GROK_4_FAST_REASONING = {
-  name: "grok-4-fast-reasoning"
-};
-const GROK_4_FAST_NON_REASONING = {
-  name: "grok-4-fast-non-reasoning"
-};
-const GROK_4 = {
-  name: "grok-4"
-};
-const GROK_3_MINI = {
-  name: "grok-3-mini"
-};
-const GROK_3 = {
-  name: "grok-3"
-};
-const GROK_2_VISION = {
-  name: "grok-2-vision-1212"
-};
 const GROK_2_IMAGE = {
   name: "grok-2-image-1212"
 };
@@ -34,44 +7,13 @@ const GROK_IMAGINE_IMAGE = {
 const GROK_IMAGINE_IMAGE_QUALITY = {
   name: "grok-imagine-image-quality"
 };
-const GROK_4_20 = {
-  name: "grok-4.20"
-};
-const GROK_4_20_MULTI_AGENT = {
-  name: "grok-4.20-multi-agent"
-};
 const GROK_4_3 = {
   name: "grok-4.3"
 };
 const GROK_BUILD_0_1 = {
   name: "grok-build-0.1"
 };
-const GROK_CHAT_MODELS = [
-  GROK_4_1_FAST_REASONING.name,
-  GROK_4_1_FAST_NON_REASONING.name,
-  GROK_CODE_FAST_1.name,
-  GROK_4_FAST_REASONING.name,
-  GROK_4_FAST_NON_REASONING.name,
-  GROK_4.name,
-  GROK_3.name,
-  GROK_3_MINI.name,
-  GROK_2_VISION.name,
-  GROK_4_20.name,
-  GROK_4_20_MULTI_AGENT.name,
-  GROK_4_3.name,
-  GROK_BUILD_0_1.name
-];
-const GROK_COMBINED_TOOLS_AND_SCHEMA_MODELS = /* @__PURE__ */ new Set([
-  GROK_4_1_FAST_REASONING.name,
-  GROK_4_1_FAST_NON_REASONING.name,
-  GROK_CODE_FAST_1.name,
-  GROK_4_FAST_REASONING.name,
-  GROK_4_FAST_NON_REASONING.name,
-  GROK_4.name,
-  GROK_4_20.name,
-  GROK_4_20_MULTI_AGENT.name,
-  GROK_4_3.name
-]);
+const GROK_CHAT_MODELS = [GROK_BUILD_0_1.name, GROK_4_3.name];
 const GROK_IMAGE_MODELS = [
   GROK_2_IMAGE.name,
   GROK_IMAGINE_IMAGE.name,
@@ -97,7 +39,6 @@ const GROK_REALTIME_MODELS = [
 ];
 export {
   GROK_CHAT_MODELS,
-  GROK_COMBINED_TOOLS_AND_SCHEMA_MODELS,
   GROK_IMAGE_MODELS,
   GROK_REALTIME_MODELS,
   GROK_TRANSCRIPTION_MODELS,

package/dist/esm/model-meta.js.map

@@ -1 +1 @@
-{"version":3,"file":"model-meta.js","sources":["../../src/model-meta.ts"],"sourcesContent":["/**\n * Model metadata interface for documentation and type inference\n */\ninterface ModelMeta {\n  name: string\n  supports: {\n    input: Array<'text' | 'image' | 'audio' | 'video' | 'document'>\n    output: Array<'text' | 'image' | 'audio' | 'video'>\n    capabilities?: Array<'reasoning' | 'tool_calling' | 'structured_outputs'>\n    tools?: ReadonlyArray<never>\n  }\n  max_input_tokens?: number\n  max_output_tokens?: number\n  context_window?: number\n  knowledge_cutoff?: string\n  pricing?: {\n    input: {\n      normal: number\n      cached?: number\n    }\n    output: {\n      normal: number\n    }\n  }\n}\n\nconst GROK_4_1_FAST_REASONING = {\n  name: 'grok-4-1-fast-reasoning',\n  context_window: 2_000_000,\n  supports: {\n    input: ['text', 'image'],\n    output: ['text'],\n    capabilities: ['reasoning', 'structured_outputs', 'tool_calling'],\n    tools: [] as const,\n  },\n  pricing: {\n    input: {\n      normal: 0.2,\n      cached: 0.05,\n    },\n    output: {\n      normal: 0.5,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_4_1_FAST_NON_REASONING = {\n  name: 'grok-4-1-fast-non-reasoning',\n  context_window: 2_000_000,\n  supports: {\n    input: ['text', 'image'],\n    output: ['text'],\n    capabilities: ['structured_outputs', 'tool_calling'],\n    tools: [] as const,\n  },\n  pricing: {\n    input: {\n      normal: 0.2,\n      cached: 0.05,\n    },\n    output: {\n      normal: 0.5,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_CODE_FAST_1 = {\n  name: 'grok-code-fast-1',\n  context_window: 256_000,\n  supports: {\n    input: ['text'],\n    output: ['text'],\n    capabilities: ['reasoning', 'structured_outputs', 'tool_calling'],\n    tools: [] as const,\n  },\n  pricing: {\n    input: {\n      normal: 0.2,\n      cached: 0.02,\n    },\n    output: {\n      normal: 1.5,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_4_FAST_REASONING = {\n  name: 'grok-4-fast-reasoning',\n  context_window: 2_000_000,\n  supports: {\n    input: ['text', 'image'],\n    output: ['text'],\n    capabilities: ['reasoning', 'structured_outputs', 'tool_calling'],\n    tools: [] as const,\n  },\n  pricing: {\n    input: {\n      normal: 0.2,\n      cached: 0.05,\n    },\n    output: {\n      normal: 0.5,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_4_FAST_NON_REASONING = {\n  name: 'grok-4-fast-non-reasoning',\n  context_window: 2_000_000,\n  supports: {\n    input: ['text', 'image'],\n    output: ['text'],\n    capabilities: ['structured_outputs', 'tool_calling'],\n    tools: [] as const,\n  },\n  pricing: {\n    input: {\n      normal: 0.2,\n      cached: 0.05,\n    },\n    output: {\n      normal: 0.5,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_4 = {\n  name: 'grok-4',\n  context_window: 256_000,\n  supports: {\n    input: ['text', 'image'],\n    output: ['text'],\n    capabilities: ['reasoning', 'structured_outputs', 'tool_calling'],\n    tools: [] as const,\n  },\n  pricing: {\n    input: {\n      normal: 3,\n      cached: 0.75,\n    },\n    output: {\n      normal: 15,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_3_MINI = {\n  name: 'grok-3-mini',\n  context_window: 131_072,\n  supports: {\n    input: ['text'],\n    output: ['text'],\n    capabilities: ['reasoning', 'structured_outputs', 'tool_calling'],\n    tools: [] as const,\n  },\n  pricing: {\n    input: {\n      normal: 0.3,\n      cached: 0.075,\n    },\n    output: {\n      normal: 0.5,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_3 = {\n  name: 'grok-3',\n  context_window: 131_072,\n  supports: {\n    input: ['text'],\n    output: ['text'],\n    capabilities: ['structured_outputs', 'tool_calling'],\n    tools: [] as const,\n  },\n  pricing: {\n    input: {\n      normal: 3,\n      cached: 0.75,\n    },\n    output: {\n      normal: 15,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_2_VISION = {\n  name: 'grok-2-vision-1212',\n  context_window: 32_768,\n  supports: {\n    input: ['text', 'image'],\n    output: ['text'],\n    capabilities: ['structured_outputs', 'tool_calling'],\n    tools: [] as const,\n  },\n  pricing: {\n    input: {\n      normal: 2,\n    },\n    output: {\n      normal: 10,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_2_IMAGE = {\n  name: 'grok-2-image-1212',\n  supports: {\n    input: ['text'],\n    output: ['image'],\n  },\n  pricing: {\n    input: {\n      normal: 0.07,\n    },\n    output: {\n      normal: 0.07,\n    },\n  },\n} as const satisfies ModelMeta\n\n// Imagine API image models. Pricing is per generated image (output only).\nconst GROK_IMAGINE_IMAGE = {\n  name: 'grok-imagine-image',\n  supports: {\n    input: ['text', 'image'],\n    output: ['image'],\n  },\n  pricing: {\n    input: {\n      normal: 0,\n    },\n    output: {\n      normal: 0.02,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_IMAGINE_IMAGE_QUALITY = {\n  name: 'grok-imagine-image-quality',\n  supports: {\n    input: ['text', 'image'],\n    output: ['image'],\n  },\n  pricing: {\n    input: {\n      normal: 0,\n    },\n    output: {\n      normal: 0.05,\n    },\n  },\n} as const satisfies ModelMeta\n\n/**\n * Grok Chat Models\n * Based on xAI's available models as of 2025\n */\nconst GROK_4_20 = {\n  name: 'grok-4.20',\n  context_window: 2_000_000,\n  supports: {\n    input: ['text', 'image', 'document'],\n    output: ['text'],\n    capabilities: ['reasoning', 'structured_outputs', 'tool_calling'],\n    tools: [] as const,\n  },\n  pricing: {\n    input: {\n      normal: 2,\n      cached: 0.2,\n    },\n    output: {\n      normal: 6,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_4_20_MULTI_AGENT = {\n  name: 'grok-4.20-multi-agent',\n  context_window: 2_000_000,\n  supports: {\n    input: ['text', 'image', 'document'],\n    output: ['text'],\n    capabilities: ['reasoning', 'structured_outputs', 'tool_calling'],\n    tools: [] as const,\n  },\n  pricing: {\n    input: {\n      normal: 2,\n      cached: 0.2,\n    },\n    output: {\n      normal: 6,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_4_3 = {\n  name: 'grok-4.3',\n  context_window: 1_000_000,\n  supports: {\n    input: ['text', 'image'],\n    output: ['text'],\n    capabilities: ['reasoning', 'structured_outputs', 'tool_calling'],\n    tools: [],\n  },\n  pricing: {\n    input: {\n      normal: 1.25,\n      cached: 0.2,\n    },\n    output: {\n      normal: 2.5,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_BUILD_0_1 = {\n  name: 'grok-build-0.1',\n  context_window: 256_000,\n  supports: {\n    input: ['text', 'image'],\n    output: ['text'],\n    capabilities: ['reasoning', 'structured_outputs', 'tool_calling'],\n    tools: [],\n  },\n  pricing: {\n    input: {\n      normal: 1,\n      cached: 0.2,\n    },\n    output: {\n      normal: 2,\n    },\n  },\n} as const satisfies ModelMeta\n\nexport const GROK_CHAT_MODELS = [\n  GROK_4_1_FAST_REASONING.name,\n  GROK_4_1_FAST_NON_REASONING.name,\n  GROK_CODE_FAST_1.name,\n  GROK_4_FAST_REASONING.name,\n  GROK_4_FAST_NON_REASONING.name,\n  GROK_4.name,\n  GROK_3.name,\n  GROK_3_MINI.name,\n  GROK_2_VISION.name,\n\n  GROK_4_20.name,\n  GROK_4_20_MULTI_AGENT.name,\n\n  GROK_4_3.name,\n\n  GROK_BUILD_0_1.name,\n] as const\n\n/**\n * Grok models that support combining `tools` + `response_format: json_schema`\n * in a single streaming Chat Completions request (per issue #605). xAI\n * docs gate this to the Grok 4 family — Grok 2 / 3 reject the\n * combination. Grok 2 image generation is not a chat model, omitted.\n *\n * Note: Grok streams tool-call arguments atomically (not token-streamed)\n * per the issue's source matrix; partial-JSON tool-arg parsing should be\n * skipped for Grok specifically. That's a separate adapter concern from\n * this set — the set only gates whether the engine takes the native\n * combined path vs the legacy finalization path.\n */\nexport const GROK_COMBINED_TOOLS_AND_SCHEMA_MODELS = new Set<string>([\n  GROK_4_1_FAST_REASONING.name,\n  GROK_4_1_FAST_NON_REASONING.name,\n  GROK_CODE_FAST_1.name,\n  GROK_4_FAST_REASONING.name,\n  GROK_4_FAST_NON_REASONING.name,\n  GROK_4.name,\n  GROK_4_20.name,\n  GROK_4_20_MULTI_AGENT.name,\n  GROK_4_3.name,\n])\n\n/**\n * Grok Image Generation Models\n */\nexport const GROK_IMAGE_MODELS = [\n  GROK_2_IMAGE.name,\n  GROK_IMAGINE_IMAGE.name,\n  GROK_IMAGINE_IMAGE_QUALITY.name,\n] as const\n\n// xAI's `/v1/tts` endpoint is endpoint-addressed and does not take a `model`\n// parameter. This synthetic identifier satisfies the SDK's `TTSOptions.model`\n// contract and provides a stable value for logging and fixture matching.\nconst GROK_TTS = {\n  name: 'grok-tts',\n  supports: {\n    input: ['text'],\n    output: ['audio'],\n  },\n} as const satisfies ModelMeta\n\n// xAI's `/v1/stt` endpoint is endpoint-addressed and does not take a `model`\n// parameter. This synthetic identifier satisfies the SDK's\n// `TranscriptionOptions.model` contract.\nconst GROK_STT = {\n  name: 'grok-stt',\n  supports: {\n    input: ['audio'],\n    output: ['text'],\n  },\n} as const satisfies ModelMeta\n\nconst GROK_VOICE_FAST_1 = {\n  name: 'grok-voice-fast-1.0',\n  supports: {\n    input: ['audio', 'text'],\n    output: ['audio', 'text'],\n    capabilities: ['tool_calling'],\n    tools: [] as const,\n  },\n} as const satisfies ModelMeta\n\nconst GROK_VOICE_THINK_FAST_1 = {\n  name: 'grok-voice-think-fast-1.0',\n  supports: {\n    input: ['audio', 'text'],\n    output: ['audio', 'text'],\n    capabilities: ['reasoning', 'tool_calling'],\n    tools: [] as const,\n  },\n} as const satisfies ModelMeta\n\nexport const GROK_TTS_MODELS = [GROK_TTS.name] as const\n\nexport const GROK_TRANSCRIPTION_MODELS = [GROK_STT.name] as const\n\nexport const GROK_REALTIME_MODELS = [\n  GROK_VOICE_FAST_1.name,\n  GROK_VOICE_THINK_FAST_1.name,\n] as const\n\nexport type GrokChatModel = (typeof GROK_CHAT_MODELS)[number]\nexport type GrokImageModel = (typeof GROK_IMAGE_MODELS)[number]\nexport type GrokTTSModel = (typeof GROK_TTS_MODELS)[number]\nexport type GrokTranscriptionModel = (typeof GROK_TRANSCRIPTION_MODELS)[number]\nexport type GrokRealtimeModel = (typeof GROK_REALTIME_MODELS)[number]\n\n/**\n * Type-only map from Grok chat model name to its supported input modalities.\n * Used for type inference when constructing multimodal messages.\n */\nexport type GrokModelInputModalitiesByName = {\n  [GROK_4_1_FAST_REASONING.name]: typeof GROK_4_1_FAST_REASONING.supports.input\n  [GROK_4_1_FAST_NON_REASONING.name]: typeof GROK_4_1_FAST_NON_REASONING.supports.input\n  [GROK_CODE_FAST_1.name]: typeof GROK_CODE_FAST_1.supports.input\n  [GROK_4_FAST_REASONING.name]: typeof GROK_4_FAST_REASONING.supports.input\n  [GROK_4_FAST_NON_REASONING.name]: typeof GROK_4_FAST_NON_REASONING.supports.input\n  [GROK_4.name]: typeof GROK_4.supports.input\n  [GROK_3.name]: typeof GROK_3.supports.input\n  [GROK_3_MINI.name]: typeof GROK_3_MINI.supports.input\n  [GROK_2_VISION.name]: typeof GROK_2_VISION.supports.input\n  [GROK_4_20.name]: typeof GROK_4_20.supports.input\n  [GROK_4_20_MULTI_AGENT.name]: typeof GROK_4_20_MULTI_AGENT.supports.input\n  [GROK_4_3.name]: typeof GROK_4_3.supports.input\n  [GROK_BUILD_0_1.name]: typeof GROK_BUILD_0_1.supports.input\n}\n\n/**\n * Type-only map from Grok chat model name to its provider options type.\n * Since Grok uses OpenAI-compatible API, we reuse OpenAI provider options.\n */\nexport type GrokChatModelProviderOptionsByName = {\n  [K in (typeof GROK_CHAT_MODELS)[number]]: GrokProviderOptions\n}\n\n/**\n * Type-only map from Grok chat model name to its supported provider tools.\n * Grok exposes no provider-specific tool factories, so every model gets an\n * empty tuple. This ensures that passing an Anthropic/OpenAI ProviderTool to\n * a Grok adapter produces a compile-time type error.\n */\nexport type GrokChatModelToolCapabilitiesByName = {\n  [GROK_4_1_FAST_REASONING.name]: typeof GROK_4_1_FAST_REASONING.supports.tools\n  [GROK_4_1_FAST_NON_REASONING.name]: typeof GROK_4_1_FAST_NON_REASONING.supports.tools\n  [GROK_CODE_FAST_1.name]: typeof GROK_CODE_FAST_1.supports.tools\n  [GROK_4_FAST_REASONING.name]: typeof GROK_4_FAST_REASONING.supports.tools\n  [GROK_4_FAST_NON_REASONING.name]: typeof GROK_4_FAST_NON_REASONING.supports.tools\n  [GROK_4.name]: typeof GROK_4.supports.tools\n  [GROK_3.name]: typeof GROK_3.supports.tools\n  [GROK_3_MINI.name]: typeof GROK_3_MINI.supports.tools\n  [GROK_2_VISION.name]: typeof GROK_2_VISION.supports.tools\n  [GROK_4_20.name]: typeof GROK_4_20.supports.tools\n  [GROK_4_20_MULTI_AGENT.name]: typeof GROK_4_20_MULTI_AGENT.supports.tools\n}\n\n/**\n * Grok-specific provider options\n * Based on OpenAI-compatible API options\n */\nexport interface GrokProviderOptions {\n  /** Temperature for response generation (0-2) */\n  temperature?: number\n  /** Maximum tokens in the response */\n  max_tokens?: number\n  /** Top-p sampling parameter */\n  top_p?: number\n  /** Frequency penalty (-2.0 to 2.0) */\n  frequency_penalty?: number\n  /** Presence penalty (-2.0 to 2.0) */\n  presence_penalty?: number\n  /** Stop sequences */\n  stop?: string | Array<string>\n  /** A unique identifier representing your end-user */\n  user?: string\n}\n\n// ===========================\n// Type Resolution Helpers\n// ===========================\n\n/**\n * Resolve provider options for a specific model.\n * If the model has explicit options in the map, use those; otherwise use base options.\n */\nexport type ResolveProviderOptions<TModel extends string> =\n  TModel extends keyof GrokChatModelProviderOptionsByName\n    ? GrokChatModelProviderOptionsByName[TModel]\n    : GrokProviderOptions\n\n/**\n * Resolve input modalities for a specific model.\n * If the model has explicit modalities in the map, use those; otherwise use text only.\n */\nexport type ResolveInputModalities<TModel extends string> =\n  TModel extends keyof GrokModelInputModalitiesByName\n    ? GrokModelInputModalitiesByName[TModel]\n    : readonly ['text']\n"],"names":[],"mappings":"AA0BA,MAAM,0BAA0B;AAAA,EAC9B,MAAM;AAiBR;AAEA,MAAM,8BAA8B;AAAA,EAClC,MAAM;AAiBR;AAEA,MAAM,mBAAmB;AAAA,EACvB,MAAM;AAiBR;AAEA,MAAM,wBAAwB;AAAA,EAC5B,MAAM;AAiBR;AAEA,MAAM,4BAA4B;AAAA,EAChC,MAAM;AAiBR;AAEA,MAAM,SAAS;AAAA,EACb,MAAM;AAiBR;AAEA,MAAM,cAAc;AAAA,EAClB,MAAM;AAiBR;AAEA,MAAM,SAAS;AAAA,EACb,MAAM;AAiBR;AAEA,MAAM,gBAAgB;AAAA,EACpB,MAAM;AAgBR;AAEA,MAAM,eAAe;AAAA,EACnB,MAAM;AAaR;AAGA,MAAM,qBAAqB;AAAA,EACzB,MAAM;AAaR;AAEA,MAAM,6BAA6B;AAAA,EACjC,MAAM;AAaR;AAMA,MAAM,YAAY;AAAA,EAChB,MAAM;AAiBR;AAEA,MAAM,wBAAwB;AAAA,EAC5B,MAAM;AAiBR;AAEA,MAAM,WAAW;AAAA,EACf,MAAM;AAiBR;AAEA,MAAM,iBAAiB;AAAA,EACrB,MAAM;AAiBR;AAEO,MAAM,mBAAmB;AAAA,EAC9B,wBAAwB;AAAA,EACxB,4BAA4B;AAAA,EAC5B,iBAAiB;AAAA,EACjB,sBAAsB;AAAA,EACtB,0BAA0B;AAAA,EAC1B,OAAO;AAAA,EACP,OAAO;AAAA,EACP,YAAY;AAAA,EACZ,cAAc;AAAA,EAEd,UAAU;AAAA,EACV,sBAAsB;AAAA,EAEtB,SAAS;AAAA,EAET,eAAe;AACjB;AAcO,MAAM,4DAA4C,IAAY;AAAA,EACnE,wBAAwB;AAAA,EACxB,4BAA4B;AAAA,EAC5B,iBAAiB;AAAA,EACjB,sBAAsB;AAAA,EACtB,0BAA0B;AAAA,EAC1B,OAAO;AAAA,EACP,UAAU;AAAA,EACV,sBAAsB;AAAA,EACtB,SAAS;AACX,CAAC;AAKM,MAAM,oBAAoB;AAAA,EAC/B,aAAa;AAAA,EACb,mBAAmB;AAAA,EACnB,2BAA2B;AAC7B;AAKA,MAAM,WAAW;AAAA,EACf,MAAM;AAKR;AAKA,MAAM,WAAW;AAAA,EACf,MAAM;AAKR;AAEA,MAAM,oBAAoB;AAAA,EACxB,MAAM;AAOR;AAEA,MAAM,0BAA0B;AAAA,EAC9B,MAAM;AAOR;AAEO,MAAM,kBAAkB,CAAC,SAAS,IAAI;AAEtC,MAAM,4BAA4B,CAAC,SAAS,IAAI;AAEhD,MAAM,uBAAuB;AAAA,EAClC,kBAAkB;AAAA,EAClB,wBAAwB;AAC1B;"}
+{"version":3,"file":"model-meta.js","sources":["../../src/model-meta.ts"],"sourcesContent":["/**\n * Model metadata interface for documentation and type inference\n */\nimport type {\n  GrokBuildProviderOptions,\n  GrokTextProviderOptions,\n} from './text/text-provider-options'\n\ninterface ModelMeta {\n  name: string\n  supports: {\n    input: Array<'text' | 'image' | 'audio' | 'video' | 'document'>\n    output: Array<'text' | 'image' | 'audio' | 'video'>\n    capabilities?: Array<'reasoning' | 'tool_calling' | 'structured_outputs'>\n    tools?: ReadonlyArray<GrokProviderToolKind>\n  }\n  max_input_tokens?: number\n  max_output_tokens?: number\n  context_window?: number\n  knowledge_cutoff?: string\n  pricing?: {\n    input: {\n      normal: number\n      cached?: number\n    }\n    output: {\n      normal: number\n    }\n  }\n}\n\nexport type GrokProviderToolKind =\n  | 'web_search'\n  | 'x_search'\n  | 'file_search'\n  | 'mcp'\n\nconst GROK_RESPONSES_TOOLS = [\n  'web_search',\n  'x_search',\n  'file_search',\n  'mcp',\n] as const satisfies ReadonlyArray<GrokProviderToolKind>\n\nconst GROK_2_IMAGE = {\n  name: 'grok-2-image-1212',\n  supports: {\n    input: ['text'],\n    output: ['image'],\n  },\n  pricing: {\n    input: {\n      normal: 0.07,\n    },\n    output: {\n      normal: 0.07,\n    },\n  },\n} as const satisfies ModelMeta\n\n// Imagine API image models. Pricing is per generated image (output only).\nconst GROK_IMAGINE_IMAGE = {\n  name: 'grok-imagine-image',\n  supports: {\n    input: ['text', 'image'],\n    output: ['image'],\n  },\n  pricing: {\n    input: {\n      normal: 0,\n    },\n    output: {\n      normal: 0.02,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_IMAGINE_IMAGE_QUALITY = {\n  name: 'grok-imagine-image-quality',\n  supports: {\n    input: ['text', 'image'],\n    output: ['image'],\n  },\n  pricing: {\n    input: {\n      normal: 0,\n    },\n    output: {\n      normal: 0.05,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_4_3 = {\n  name: 'grok-4.3',\n  context_window: 1_000_000,\n  supports: {\n    input: ['text', 'image'],\n    output: ['text'],\n    capabilities: ['reasoning', 'structured_outputs', 'tool_calling'],\n    tools: GROK_RESPONSES_TOOLS,\n  },\n  pricing: {\n    input: {\n      normal: 1.25,\n      cached: 0.2,\n    },\n    output: {\n      normal: 2.5,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_BUILD_0_1 = {\n  name: 'grok-build-0.1',\n  context_window: 256_000,\n  supports: {\n    input: ['text', 'image'],\n    output: ['text'],\n    capabilities: ['reasoning', 'structured_outputs', 'tool_calling'],\n    tools: GROK_RESPONSES_TOOLS,\n  },\n  pricing: {\n    input: {\n      normal: 1,\n      cached: 0.2,\n    },\n    output: {\n      normal: 2,\n    },\n  },\n} as const satisfies ModelMeta\n\n/**\n * Grok chat models supported by the Responses adapter.\n */\nexport const GROK_CHAT_MODELS = [GROK_BUILD_0_1.name, GROK_4_3.name] as const\n\n/**\n * Grok Image Generation Models\n */\nexport const GROK_IMAGE_MODELS = [\n  GROK_2_IMAGE.name,\n  GROK_IMAGINE_IMAGE.name,\n  GROK_IMAGINE_IMAGE_QUALITY.name,\n] as const\n\n// xAI's `/v1/tts` endpoint is endpoint-addressed and does not take a `model`\n// parameter. This synthetic identifier satisfies the SDK's `TTSOptions.model`\n// contract and provides a stable value for logging and fixture matching.\nconst GROK_TTS = {\n  name: 'grok-tts',\n  supports: {\n    input: ['text'],\n    output: ['audio'],\n  },\n} as const satisfies ModelMeta\n\n// xAI's `/v1/stt` endpoint is endpoint-addressed and does not take a `model`\n// parameter. This synthetic identifier satisfies the SDK's\n// `TranscriptionOptions.model` contract.\nconst GROK_STT = {\n  name: 'grok-stt',\n  supports: {\n    input: ['audio'],\n    output: ['text'],\n  },\n} as const satisfies ModelMeta\n\nconst GROK_VOICE_FAST_1 = {\n  name: 'grok-voice-fast-1.0',\n  supports: {\n    input: ['audio', 'text'],\n    output: ['audio', 'text'],\n    capabilities: ['tool_calling'],\n    tools: [] as const,\n  },\n} as const satisfies ModelMeta\n\nconst GROK_VOICE_THINK_FAST_1 = {\n  name: 'grok-voice-think-fast-1.0',\n  supports: {\n    input: ['audio', 'text'],\n    output: ['audio', 'text'],\n    capabilities: ['reasoning', 'tool_calling'],\n    tools: [] as const,\n  },\n} as const satisfies ModelMeta\n\nexport const GROK_TTS_MODELS = [GROK_TTS.name] as const\n\nexport const GROK_TRANSCRIPTION_MODELS = [GROK_STT.name] as const\n\nexport const GROK_REALTIME_MODELS = [\n  GROK_VOICE_FAST_1.name,\n  GROK_VOICE_THINK_FAST_1.name,\n] as const\n\nexport type GrokChatModel = (typeof GROK_CHAT_MODELS)[number]\nexport type GrokImageModel = (typeof GROK_IMAGE_MODELS)[number]\nexport type GrokTTSModel = (typeof GROK_TTS_MODELS)[number]\nexport type GrokTranscriptionModel = (typeof GROK_TRANSCRIPTION_MODELS)[number]\nexport type GrokRealtimeModel = (typeof GROK_REALTIME_MODELS)[number]\n\n/**\n * Type-only map from Grok chat model name to its supported input modalities.\n * Used for type inference when constructing multimodal messages.\n */\nexport type GrokModelInputModalitiesByName = {\n  [GROK_4_3.name]: typeof GROK_4_3.supports.input\n  [GROK_BUILD_0_1.name]: typeof GROK_BUILD_0_1.supports.input\n}\n\n/**\n * Type-only map from Grok chat model name to its supported provider tools.\n * Keeps Grok provider-tool factories type-checked against the models that\n * advertise xAI Responses server-side tools.\n */\nexport type GrokChatModelToolCapabilitiesByName = {\n  [GROK_4_3.name]: typeof GROK_4_3.supports.tools\n  [GROK_BUILD_0_1.name]: typeof GROK_BUILD_0_1.supports.tools\n}\n\nexport type GrokProviderOptions = GrokTextProviderOptions\n\n/**\n * Type-only map from Grok chat model name to its provider options type.\n */\nexport type GrokChatModelProviderOptionsByName = {\n  [GROK_4_3.name]: GrokProviderOptions\n  [GROK_BUILD_0_1.name]: GrokBuildProviderOptions\n}\n\n// ===========================\n// Type Resolution Helpers\n// ===========================\n\n/**\n * Resolve provider options for a specific model.\n * If the model has explicit options in the map, use those; otherwise use base options.\n */\nexport type ResolveProviderOptions<TModel extends string> =\n  TModel extends keyof GrokChatModelProviderOptionsByName\n    ? GrokChatModelProviderOptionsByName[TModel]\n    : GrokProviderOptions\n\n/**\n * Resolve input modalities for a specific model.\n * If the model has explicit modalities in the map, use those; otherwise use text only.\n */\nexport type ResolveInputModalities<TModel extends string> =\n  TModel extends keyof GrokModelInputModalitiesByName\n    ? GrokModelInputModalitiesByName[TModel]\n    : readonly ['text']\n"],"names":[],"mappings":"AA4CA,MAAM,eAAe;AAAA,EACnB,MAAM;AAaR;AAGA,MAAM,qBAAqB;AAAA,EACzB,MAAM;AAaR;AAEA,MAAM,6BAA6B;AAAA,EACjC,MAAM;AAaR;AAEA,MAAM,WAAW;AAAA,EACf,MAAM;AAiBR;AAEA,MAAM,iBAAiB;AAAA,EACrB,MAAM;AAiBR;AAKO,MAAM,mBAAmB,CAAC,eAAe,MAAM,SAAS,IAAI;AAK5D,MAAM,oBAAoB;AAAA,EAC/B,aAAa;AAAA,EACb,mBAAmB;AAAA,EACnB,2BAA2B;AAC7B;AAKA,MAAM,WAAW;AAAA,EACf,MAAM;AAKR;AAKA,MAAM,WAAW;AAAA,EACf,MAAM;AAKR;AAEA,MAAM,oBAAoB;AAAA,EACxB,MAAM;AAOR;AAEA,MAAM,0BAA0B;AAAA,EAC9B,MAAM;AAOR;AAEO,MAAM,kBAAkB,CAAC,SAAS,IAAI;AAEtC,MAAM,4BAA4B,CAAC,SAAS,IAAI;AAEhD,MAAM,uBAAuB;AAAA,EAClC,kBAAkB;AAAA,EAClB,wBAAwB;AAC1B;"}

package/dist/esm/text/text-provider-options.d.ts

@@ -1,9 +1,8 @@
-/**
- * Grok Text Provider Options
- *
- * Grok uses an OpenAI-compatible Chat Completions API.
- * However, not all OpenAI features may be supported by Grok.
- */
+import { ResponseCreateParams } from 'openai/resources/responses/responses';
+export type GrokReasoningEffort = 'none' | 'low' | 'medium' | 'high';
+export type GrokReasoning = Omit<NonNullable<ResponseCreateParams['reasoning']>, 'effort'> & {
+    effort?: GrokReasoningEffort;
+};
 /**
  * Base provider options for Grok text/chat models
  */
@@ -16,9 +15,9 @@ export interface GrokBaseOptions {
 }
 /**
  * Grok-specific provider options for text/chat
- * Based on OpenAI-compatible API options
+ * Based on xAI Responses API options
  */
-export interface GrokTextProviderOptions extends GrokBaseOptions {
+export interface GrokTextProviderOptions extends GrokBaseOptions, Record<string, unknown> {
     /**
      * Temperature for response generation (0-2)
      * Higher values make output more random, lower values more focused
@@ -32,20 +31,23 @@ export interface GrokTextProviderOptions extends GrokBaseOptions {
     /**
      * Maximum tokens in the response
      */
-    max_tokens?: number;
+    max_output_tokens?: number;
     /**
-     * Frequency penalty (-2.0 to 2.0)
+     * Whether xAI should store the response. Defaults to `false` in the adapter.
      */
-    frequency_penalty?: number;
+    store?: boolean;
     /**
-     * Presence penalty (-2.0 to 2.0)
+     * Additional response fields to include. Defaults to encrypted reasoning.
      */
-    presence_penalty?: number;
+    include?: ResponseCreateParams['include'];
     /**
-     * Stop sequences
+     * xAI/OpenAI-compatible reasoning controls for reasoning-capable models.
      */
-    stop?: string | Array<string>;
+    reasoning?: GrokReasoning;
 }
+export type GrokBuildProviderOptions = Omit<GrokTextProviderOptions, 'reasoning'> & {
+    reasoning?: never;
+};
 /**
  * External provider options (what users pass in)
  */

package/dist/esm/tools/index.d.ts

@@ -1 +1,45 @@
-export { type ChatCompletionFunctionTool as FunctionTool, convertFunctionToolToChatCompletionsFormat as convertFunctionToolToAdapterFormat, convertToolsToChatCompletionsFormat as convertToolsToProviderFormat, } from '@tanstack/openai-base';
+import { convertFunctionToolToResponsesFormat, ResponsesFunctionTool } from '@tanstack/openai-base';
+import { ProviderTool, Tool } from '@tanstack/ai';
+import { GrokProviderToolKind } from '../model-meta.js';
+export type FunctionTool = ResponsesFunctionTool;
+export { convertFunctionToolToResponsesFormat as convertFunctionToolToAdapterFormat };
+export type GrokProviderTool<TKind extends GrokProviderToolKind> = ProviderTool<'grok', TKind>;
+export interface GrokWebSearchToolConfig {
+    type: 'web_search';
+    filters?: {
+        allowed_domains?: Array<string>;
+        excluded_domains?: Array<string>;
+    };
+    enable_image_understanding?: boolean;
+    enable_image_search?: boolean;
+}
+export interface GrokXSearchToolConfig {
+    type: 'x_search';
+    allowed_x_handles?: Array<string>;
+    excluded_x_handles?: Array<string>;
+    from_date?: string;
+    to_date?: string;
+    enable_image_understanding?: boolean;
+    enable_video_understanding?: boolean;
+}
+export interface GrokFileSearchToolConfig {
+    type: 'file_search';
+    vector_store_ids: Array<string>;
+    max_num_results?: number;
+}
+export interface GrokMCPToolConfig {
+    type: 'mcp';
+    server_label: string;
+    server_url: string;
+    allowed_tools?: Array<string>;
+    server_description?: string;
+    authorization?: string;
+    headers?: Record<string, string>;
+}
+export type GrokServerTool = GrokWebSearchToolConfig | GrokXSearchToolConfig | GrokFileSearchToolConfig | GrokMCPToolConfig;
+export type GrokResponsesTool = GrokServerTool | ResponsesFunctionTool;
+export declare function grokWebSearchTool(config?: Omit<GrokWebSearchToolConfig, 'type'>): GrokProviderTool<'web_search'>;
+export declare function grokXSearchTool(config?: Omit<GrokXSearchToolConfig, 'type'>): GrokProviderTool<'x_search'>;
+export declare function grokFileSearchTool(config: Omit<GrokFileSearchToolConfig, 'type'>): GrokProviderTool<'file_search'>;
+export declare function grokMCPTool(config: Omit<GrokMCPToolConfig, 'type'>): GrokProviderTool<'mcp'>;
+export declare function convertToolsToProviderFormat(tools: Array<Tool>): Array<GrokResponsesTool>;

package/dist/esm/tools/index.js

@@ -1,6 +1,113 @@
-import { convertFunctionToolToChatCompletionsFormat, convertToolsToChatCompletionsFormat } from "@tanstack/openai-base";
+import { brandProviderTool } from "@tanstack/ai";
+import { convertFunctionToolToResponsesFormat } from "@tanstack/openai-base";
+import { convertFunctionToolToResponsesFormat as convertFunctionToolToResponsesFormat2 } from "@tanstack/openai-base";
+function providerTool(kind, description, metadata) {
+  return brandProviderTool({
+    name: kind,
+    description,
+    metadata: {
+      __kind: `grok.${kind}`,
+      ...metadata
+    }
+  });
+}
+function grokWebSearchTool(config = {}) {
+  if (config.filters?.allowed_domains !== void 0 && config.filters.excluded_domains !== void 0) {
+    throw new Error(
+      "allowed_domains and excluded_domains cannot both be provided."
+    );
+  }
+  if (config.filters?.allowed_domains !== void 0 && config.filters.allowed_domains.length > 5) {
+    throw new Error("allowed_domains supports at most 5 domains.");
+  }
+  if (config.filters?.excluded_domains !== void 0 && config.filters.excluded_domains.length > 5) {
+    throw new Error("excluded_domains supports at most 5 domains.");
+  }
+  return providerTool("web_search", "Search the web", {
+    type: "web_search",
+    ...config
+  });
+}
+function grokXSearchTool(config = {}) {
+  if (config.allowed_x_handles !== void 0 && config.excluded_x_handles !== void 0) {
+    throw new Error(
+      "allowed_x_handles and excluded_x_handles cannot both be provided."
+    );
+  }
+  if (config.allowed_x_handles !== void 0 && config.allowed_x_handles.length > 20) {
+    throw new Error("allowed_x_handles supports at most 20 handles.");
+  }
+  if (config.excluded_x_handles !== void 0 && config.excluded_x_handles.length > 20) {
+    throw new Error("excluded_x_handles supports at most 20 handles.");
+  }
+  return providerTool("x_search", "Search X posts", {
+    type: "x_search",
+    ...config
+  });
+}
+function grokFileSearchTool(config) {
+  if (config.vector_store_ids.length === 0) {
+    throw new Error("vector_store_ids must contain at least one collection id.");
+  }
+  if (config.max_num_results !== void 0) {
+    if (config.max_num_results < 1 || config.max_num_results > 50) {
+      throw new Error("max_num_results must be between 1 and 50.");
+    }
+  }
+  return providerTool("file_search", "Search xAI file collections", {
+    type: "file_search",
+    ...config
+  });
+}
+function grokMCPTool(config) {
+  if (!config.server_url) {
+    throw new Error("server_url must be provided.");
+  }
+  return providerTool("mcp", config.server_description || "Remote MCP server", {
+    type: "mcp",
+    ...config
+  });
+}
+function getGrokProviderToolKind(tool) {
+  const kind = tool.metadata?.__kind;
+  switch (kind) {
+    case "grok.web_search":
+      return "web_search";
+    case "grok.x_search":
+      return "x_search";
+    case "grok.file_search":
+      return "file_search";
+    case "grok.mcp":
+      return "mcp";
+    default:
+      return void 0;
+  }
+}
+function convertGrokProviderToolToAdapterFormat(tool, kind) {
+  const metadata = tool.metadata;
+  if (metadata.type !== kind) {
+    throw new Error(
+      `convertGrokProviderToolToAdapterFormat: tool "${tool.name}" has mismatched Grok tool metadata.`
+    );
+  }
+  const { __kind: _kind, ...toolConfig } = metadata;
+  return toolConfig;
+}
+function convertToolsToProviderFormat(tools) {
+  return tools.map((tool) => {
+    const grokProviderToolKind = getGrokProviderToolKind(tool);
+    if (grokProviderToolKind) {
+      return convertGrokProviderToolToAdapterFormat(tool, grokProviderToolKind);
+    }
+    return convertFunctionToolToResponsesFormat(tool);
+  });
+}
 export {
-  convertFunctionToolToChatCompletionsFormat as convertFunctionToolToAdapterFormat,
-  convertToolsToChatCompletionsFormat as convertToolsToProviderFormat
+  convertFunctionToolToResponsesFormat2 as convertFunctionToolToAdapterFormat,
+  convertToolsToProviderFormat,
+  grokFileSearchTool,
+  grokMCPTool,
+  grokWebSearchTool,
+  grokXSearchTool
 };
 //# sourceMappingURL=index.js.map

package/dist/esm/tools/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}
+{"version":3,"file":"index.js","sources":["../../../src/tools/index.ts"],"sourcesContent":["import { brandProviderTool } from '@tanstack/ai'\nimport { convertFunctionToolToResponsesFormat } from '@tanstack/openai-base'\nimport type { ProviderTool, Tool } from '@tanstack/ai'\nimport type { ResponsesFunctionTool } from '@tanstack/openai-base'\nimport type { GrokProviderToolKind } from '../model-meta'\n\nexport type FunctionTool = ResponsesFunctionTool\n\nexport { convertFunctionToolToResponsesFormat as convertFunctionToolToAdapterFormat }\n\nexport type GrokProviderTool<TKind extends GrokProviderToolKind> = ProviderTool<\n  'grok',\n  TKind\n>\n\ntype GrokToolKindMarker<TKind extends GrokProviderToolKind> = `grok.${TKind}`\n\nexport interface GrokWebSearchToolConfig {\n  type: 'web_search'\n  filters?: {\n    allowed_domains?: Array<string>\n    excluded_domains?: Array<string>\n  }\n  enable_image_understanding?: boolean\n  enable_image_search?: boolean\n}\n\nexport interface GrokXSearchToolConfig {\n  type: 'x_search'\n  allowed_x_handles?: Array<string>\n  excluded_x_handles?: Array<string>\n  from_date?: string\n  to_date?: string\n  enable_image_understanding?: boolean\n  enable_video_understanding?: boolean\n}\n\nexport interface GrokFileSearchToolConfig {\n  type: 'file_search'\n  vector_store_ids: Array<string>\n  max_num_results?: number\n}\n\nexport interface GrokMCPToolConfig {\n  type: 'mcp'\n  server_label: string\n  server_url: string\n  allowed_tools?: Array<string>\n  server_description?: string\n  authorization?: string\n  headers?: Record<string, string>\n}\n\nexport type GrokServerTool =\n  | GrokWebSearchToolConfig\n  | GrokXSearchToolConfig\n  | GrokFileSearchToolConfig\n  | GrokMCPToolConfig\n\ntype GrokProviderToolMetadata<TKind extends GrokProviderToolKind> = Extract<\n  GrokServerTool,\n  { type: TKind }\n> & {\n  __kind: GrokToolKindMarker<TKind>\n}\n\nexport type GrokResponsesTool = GrokServerTool | ResponsesFunctionTool\n\nfunction providerTool<TKind extends GrokProviderToolKind>(\n  kind: TKind,\n  description: string,\n  metadata: Extract<GrokServerTool, { type: TKind }>,\n): GrokProviderTool<TKind> {\n  return brandProviderTool<GrokProviderTool<TKind>>({\n    name: kind,\n    description,\n    metadata: {\n      __kind: `grok.${kind}`,\n      ...metadata,\n    },\n  })\n}\n\nexport function grokWebSearchTool(\n  config: Omit<GrokWebSearchToolConfig, 'type'> = {},\n): GrokProviderTool<'web_search'> {\n  if (\n    config.filters?.allowed_domains !== undefined &&\n    config.filters.excluded_domains !== undefined\n  ) {\n    throw new Error(\n      'allowed_domains and excluded_domains cannot both be provided.',\n    )\n  }\n  if (\n    config.filters?.allowed_domains !== undefined &&\n    config.filters.allowed_domains.length > 5\n  ) {\n    throw new Error('allowed_domains supports at most 5 domains.')\n  }\n  if (\n    config.filters?.excluded_domains !== undefined &&\n    config.filters.excluded_domains.length > 5\n  ) {\n    throw new Error('excluded_domains supports at most 5 domains.')\n  }\n  return providerTool('web_search', 'Search the web', {\n    type: 'web_search',\n    ...config,\n  })\n}\n\nexport function grokXSearchTool(\n  config: Omit<GrokXSearchToolConfig, 'type'> = {},\n): GrokProviderTool<'x_search'> {\n  if (\n    config.allowed_x_handles !== undefined &&\n    config.excluded_x_handles !== undefined\n  ) {\n    throw new Error(\n      'allowed_x_handles and excluded_x_handles cannot both be provided.',\n    )\n  }\n  if (\n    config.allowed_x_handles !== undefined &&\n    config.allowed_x_handles.length > 20\n  ) {\n    throw new Error('allowed_x_handles supports at most 20 handles.')\n  }\n  if (\n    config.excluded_x_handles !== undefined &&\n    config.excluded_x_handles.length > 20\n  ) {\n    throw new Error('excluded_x_handles supports at most 20 handles.')\n  }\n  return providerTool('x_search', 'Search X posts', {\n    type: 'x_search',\n    ...config,\n  })\n}\n\nexport function grokFileSearchTool(\n  config: Omit<GrokFileSearchToolConfig, 'type'>,\n): GrokProviderTool<'file_search'> {\n  if (config.vector_store_ids.length === 0) {\n    throw new Error('vector_store_ids must contain at least one collection id.')\n  }\n  if (config.max_num_results !== undefined) {\n    if (config.max_num_results < 1 || config.max_num_results > 50) {\n      throw new Error('max_num_results must be between 1 and 50.')\n    }\n  }\n  return providerTool('file_search', 'Search xAI file collections', {\n    type: 'file_search',\n    ...config,\n  })\n}\n\nexport function grokMCPTool(\n  config: Omit<GrokMCPToolConfig, 'type'>,\n): GrokProviderTool<'mcp'> {\n  if (!config.server_url) {\n    throw new Error('server_url must be provided.')\n  }\n  return providerTool('mcp', config.server_description || 'Remote MCP server', {\n    type: 'mcp',\n    ...config,\n  })\n}\n\nfunction getGrokProviderToolKind(tool: Tool): GrokProviderToolKind | undefined {\n  const kind = (tool.metadata as { __kind?: unknown } | undefined)?.__kind\n  switch (kind) {\n    case 'grok.web_search':\n      return 'web_search'\n    case 'grok.x_search':\n      return 'x_search'\n    case 'grok.file_search':\n      return 'file_search'\n    case 'grok.mcp':\n      return 'mcp'\n    default:\n      return undefined\n  }\n}\n\nfunction convertGrokProviderToolToAdapterFormat(\n  tool: Tool,\n  kind: GrokProviderToolKind,\n): GrokServerTool {\n  const metadata = tool.metadata as GrokProviderToolMetadata<typeof kind>\n  if (metadata.type !== kind) {\n    throw new Error(\n      `convertGrokProviderToolToAdapterFormat: tool \"${tool.name}\" has mismatched Grok tool metadata.`,\n    )\n  }\n  const { __kind: _kind, ...toolConfig } = metadata\n  void _kind\n  return toolConfig\n}\n\nexport function convertToolsToProviderFormat(\n  tools: Array<Tool>,\n): Array<GrokResponsesTool> {\n  return tools.map((tool) => {\n    const grokProviderToolKind = getGrokProviderToolKind(tool)\n    if (grokProviderToolKind) {\n      return convertGrokProviderToolToAdapterFormat(tool, grokProviderToolKind)\n    }\n    return convertFunctionToolToResponsesFormat(tool)\n  })\n}\n"],"names":[],"mappings":";;;AAoEA,SAAS,aACP,MACA,aACA,UACyB;AACzB,SAAO,kBAA2C;AAAA,IAChD,MAAM;AAAA,IACN;AAAA,IACA,UAAU;AAAA,MACR,QAAQ,QAAQ,IAAI;AAAA,MACpB,GAAG;AAAA,IAAA;AAAA,EACL,CACD;AACH;AAEO,SAAS,kBACd,SAAgD,IAChB;AAChC,MACE,OAAO,SAAS,oBAAoB,UACpC,OAAO,QAAQ,qBAAqB,QACpC;AACA,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AACA,MACE,OAAO,SAAS,oBAAoB,UACpC,OAAO,QAAQ,gBAAgB,SAAS,GACxC;AACA,UAAM,IAAI,MAAM,6CAA6C;AAAA,EAC/D;AACA,MACE,OAAO,SAAS,qBAAqB,UACrC,OAAO,QAAQ,iBAAiB,SAAS,GACzC;AACA,UAAM,IAAI,MAAM,8CAA8C;AAAA,EAChE;AACA,SAAO,aAAa,cAAc,kBAAkB;AAAA,IAClD,MAAM;AAAA,IACN,GAAG;AAAA,EAAA,CACJ;AACH;AAEO,SAAS,gBACd,SAA8C,IAChB;AAC9B,MACE,OAAO,sBAAsB,UAC7B,OAAO,uBAAuB,QAC9B;AACA,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AACA,MACE,OAAO,sBAAsB,UAC7B,OAAO,kBAAkB,SAAS,IAClC;AACA,UAAM,IAAI,MAAM,gDAAgD;AAAA,EAClE;AACA,MACE,OAAO,uBAAuB,UAC9B,OAAO,mBAAmB,SAAS,IACnC;AACA,UAAM,IAAI,MAAM,iDAAiD;AAAA,EACnE;AACA,SAAO,aAAa,YAAY,kBAAkB;AAAA,IAChD,MAAM;AAAA,IACN,GAAG;AAAA,EAAA,CACJ;AACH;AAEO,SAAS,mBACd,QACiC;AACjC,MAAI,OAAO,iBAAiB,WAAW,GAAG;AACxC,UAAM,IAAI,MAAM,2DAA2D;AAAA,EAC7E;AACA,MAAI,OAAO,oBAAoB,QAAW;AACxC,QAAI,OAAO,kBAAkB,KAAK,OAAO,kBAAkB,IAAI;AAC7D,YAAM,IAAI,MAAM,2CAA2C;AAAA,IAC7D;AAAA,EACF;AACA,SAAO,aAAa,eAAe,+BAA+B;AAAA,IAChE,MAAM;AAAA,IACN,GAAG;AAAA,EAAA,CACJ;AACH;AAEO,SAAS,YACd,QACyB;AACzB,MAAI,CAAC,OAAO,YAAY;AACtB,UAAM,IAAI,MAAM,8BAA8B;AAAA,EAChD;AACA,SAAO,aAAa,OAAO,OAAO,sBAAsB,qBAAqB;AAAA,IAC3E,MAAM;AAAA,IACN,GAAG;AAAA,EAAA,CACJ;AACH;AAEA,SAAS,wBAAwB,MAA8C;AAC7E,QAAM,OAAQ,KAAK,UAA+C;AAClE,UAAQ,MAAA;AAAA,IACN,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT;AACE,aAAO;AAAA,EAAA;AAEb;AAEA,SAAS,uCACP,MACA,MACgB;AAChB,QAAM,WAAW,KAAK;AACtB,MAAI,SAAS,SAAS,MAAM;AAC1B,UAAM,IAAI;AAAA,MACR,iDAAiD,KAAK,IAAI;AAAA,IAAA;AAAA,EAE9D;AACA,QAAM,EAAE,QAAQ,OAAO,GAAG,eAAe;AAEzC,SAAO;AACT;AAEO,SAAS,6BACd,OAC0B;AAC1B,SAAO,MAAM,IAAI,CAAC,SAAS;AACzB,UAAM,uBAAuB,wBAAwB,IAAI;AACzD,QAAI,sBAAsB;AACxB,aAAO,uCAAuC,MAAM,oBAAoB;AAAA,IAC1E;AACA,WAAO,qCAAqC,IAAI;AAAA,EAClD,CAAC;AACH;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai-grok",
-  "version": "0.12.4",
+  "version": "0.13.0",
   "description": "xAI Grok adapter for TanStack AI chat, image generation, realtime, and structured outputs.",
   "author": "Tanner Linsley",
   "license": "MIT",

package/src/adapters/summarize.ts

@@ -17,14 +17,14 @@ export type GrokSummarizeModel = (typeof GROK_CHAT_MODELS)[number]
  * Creates a Grok summarize adapter with explicit API key.
  * Type resolution happens here at the call site.
  *
- * @param model - The model name (e.g., 'grok-3', 'grok-4')
+ * @param model - The model name (e.g., 'grok-build-0.1')
  * @param apiKey - Your xAI API key
  * @param config - Optional additional configuration
  * @returns Configured Grok summarize adapter instance with resolved types
  *
  * @example
  * ```typescript
- * const adapter = createGrokSummarize('grok-3', "xai-...");
+ * const adapter = createGrokSummarize('grok-build-0.1', "xai-...");
  * ```
  */
 export function createGrokSummarize<TModel extends GrokSummarizeModel>(
@@ -50,7 +50,7 @@ export function createGrokSummarize<TModel extends GrokSummarizeModel>(
  * - `process.env` (Node.js)
  * - `window.env` (Browser with injected env)
  *
- * @param model - The model name (e.g., 'grok-3', 'grok-4')
+ * @param model - The model name (e.g., 'grok-build-0.1')
  * @param config - Optional configuration (excluding apiKey which is auto-detected)
  * @returns Configured Grok summarize adapter instance with resolved types
  * @throws Error if XAI_API_KEY is not found in environment
@@ -58,7 +58,7 @@ export function createGrokSummarize<TModel extends GrokSummarizeModel>(
  * @example
  * ```typescript
  * // Automatically uses XAI_API_KEY from environment
- * const adapter = grokSummarize('grok-3');
+ * const adapter = grokSummarize('grok-build-0.1');
  *
  * await summarize({
  *   adapter,

package/src/adapters/text.ts

@@ -1,16 +1,17 @@
 import OpenAI from 'openai'
-import { OpenAIBaseChatCompletionsTextAdapter } from '@tanstack/openai-base'
+import { OpenAIBaseResponsesTextAdapter } from '@tanstack/openai-base'
 import { getGrokApiKeyFromEnv, withGrokDefaults } from '../utils/client'
-import { GROK_COMBINED_TOOLS_AND_SCHEMA_MODELS } from '../model-meta'
+import { convertToolsToProviderFormat } from '../tools'
 import type {
   GROK_CHAT_MODELS,
   GrokChatModelToolCapabilitiesByName,
   ResolveInputModalities,
   ResolveProviderOptions,
 } from '../model-meta'
-import type { Modality } from '@tanstack/ai'
+import type { Modality, TextOptions } from '@tanstack/ai'
 import type { GrokMessageMetadataByModality } from '../message-types'
 import type { GrokClientConfig } from '../utils'
+import type { ResponseCreateParams } from 'openai/resources/responses/responses'
 
 /**
  * Resolve tool capabilities for a specific Grok model.
@@ -34,20 +35,21 @@ export type { ExternalTextProviderOptions as GrokTextProviderOptions } from '../
  * Grok Text (Chat) Adapter
  *
  * Tree-shakeable adapter for Grok chat/text completion functionality.
- * Uses OpenAI-compatible Chat Completions API (not Responses API).
+ * Uses xAI's OpenAI-compatible Responses API.
  *
- * Delegates implementation to {@link OpenAIBaseChatCompletionsTextAdapter}
+ * Delegates implementation to {@link OpenAIBaseResponsesTextAdapter}
  * from `@tanstack/openai-base` and threads Grok-specific tool-capability
  * typing through the 5th generic of the base class.
  */
 export class GrokTextAdapter<
   TModel extends (typeof GROK_CHAT_MODELS)[number],
-  TProviderOptions extends Record<string, any> = ResolveProviderOptions<TModel>,
+  TProviderOptions extends Record<string, unknown> =
+    ResolveProviderOptions<TModel>,
   TInputModalities extends ReadonlyArray<Modality> =
     ResolveInputModalities<TModel>,
   TToolCapabilities extends ReadonlyArray<string> =
     ResolveToolCapabilities<TModel>,
-> extends OpenAIBaseChatCompletionsTextAdapter<
+> extends OpenAIBaseResponsesTextAdapter<
   TModel,
   TProviderOptions,
   TInputModalities,
@@ -61,36 +63,34 @@ export class GrokTextAdapter<
     super(model, 'grok', new OpenAI(withGrokDefaults(config)))
   }
 
-  /**
-   * Surfaces xAI reasoning deltas on Grok reasoning models. The DeepSeek-style
-   * convention puts the chain-of-thought on `delta.reasoning_content`; some
-   * Grok variants also populate `delta.reasoning`. Reading both keeps
-   * reasoning flowing through the base's REASONING_* lifecycle for both
-   * `chatStream` and `structuredOutputStream`.
-   */
-  protected override extractReasoning(
-    chunk: OpenAI.Chat.Completions.ChatCompletionChunk,
-  ): { text: string } | undefined {
-    const delta = chunk.choices[0]?.delta as
-      | { reasoning?: unknown; reasoning_content?: unknown }
-      | undefined
-    const raw = delta?.reasoning_content ?? delta?.reasoning
-    if (typeof raw === 'string' && raw.length > 0) {
-      return { text: raw }
+  protected override mapOptionsToRequest(
+    options: TextOptions<TProviderOptions>,
+  ): Omit<ResponseCreateParams, 'stream'> {
+    const { tools: _baseTools, ...request } = super.mapOptionsToRequest({
+      ...options,
+      tools: undefined,
+    })
+    void _baseTools
+
+    if (this.model === 'grok-build-0.1' && request.reasoning !== undefined) {
+      throw new Error(
+        'grok-build-0.1 does not support reasoning modelOptions; omit reasoning for this model.',
+      )
     }
-    return undefined
-  }
 
-  /**
-   * Grok's combined tools + schema support is gated to the Grok 4 family
-   * per xAI's structured-output docs; Grok 2 / 3 reject the combination.
-   * The wiring on the wire is already correct (inherits the OpenAI Chat
-   * Completions `response_format: json_schema` attach from the base
-   * adapter); this override just narrows the capability claim to the
-   * supported model family.
-   */
-  override supportsCombinedToolsAndSchema(): boolean {
-    return GROK_COMBINED_TOOLS_AND_SCHEMA_MODELS.has(this.model)
+    const tools = options.tools
+      ? convertToolsToProviderFormat(options.tools)
+      : undefined
+
+    return {
+      ...request,
+      // xAI recommends encrypted reasoning for reasoning-capable Responses
+      // requests; callers can still override either field in modelOptions.
+      store: request.store ?? false,
+      include: request.include ?? ['reasoning.encrypted_content'],
+      ...(tools &&
+        tools.length > 0 && { tools: tools as ResponseCreateParams['tools'] }),
+    }
   }
 }
 
@@ -98,15 +98,15 @@ export class GrokTextAdapter<
  * Creates a Grok text adapter with explicit API key.
  * Type resolution happens here at the call site.
  *
- * @param model - The model name (e.g., 'grok-3', 'grok-4')
+ * @param model - The model name (e.g., 'grok-build-0.1')
  * @param apiKey - Your xAI API key
  * @param config - Optional additional configuration
  * @returns Configured Grok text adapter instance with resolved types
  *
  * @example
  * ```typescript
- * const adapter = createGrokText('grok-3', "xai-...");
- * // adapter has type-safe providerOptions for grok-3
+ * const adapter = createGrokText('grok-build-0.1', "xai-...");
+ * // adapter has type-safe providerOptions for grok-build-0.1
  * ```
  */
 export function createGrokText<
@@ -127,7 +127,7 @@ export function createGrokText<
  * - `process.env` (Node.js)
  * - `window.env` (Browser with injected env)
  *
- * @param model - The model name (e.g., 'grok-3', 'grok-4')
+ * @param model - The model name (e.g., 'grok-build-0.1')
  * @param config - Optional configuration (excluding apiKey which is auto-detected)
  * @returns Configured Grok text adapter instance with resolved types
  * @throws Error if XAI_API_KEY is not found in environment
@@ -135,7 +135,7 @@ export function createGrokText<
  * @example
  * ```typescript
  * // Automatically uses XAI_API_KEY from environment
- * const adapter = grokText('grok-3');
+ * const adapter = grokText('grok-build-0.1');
  *
  * const stream = chat({
  *   adapter,