@tanstack/ai-grok 0.8.7 → 0.9.0

package/dist/esm/adapters/text.d.ts

@@ -41,6 +41,15 @@ export declare class GrokTextAdapter<TModel extends (typeof GROK_CHAT_MODELS)[nu
     protected extractReasoning(chunk: OpenAI.Chat.Completions.ChatCompletionChunk): {
         text: string;
     } | 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.
+     */
+    supportsCombinedToolsAndSchema(): boolean;
 }
 /**
  * Creates a Grok text adapter with explicit API key.

package/dist/esm/adapters/text.js

@@ -1,6 +1,7 @@
 import OpenAI from "openai";
 import { OpenAIBaseChatCompletionsTextAdapter } from "@tanstack/openai-base";
 import { withGrokDefaults, getGrokApiKeyFromEnv } from "../utils/client.js";
+import { GROK_COMBINED_TOOLS_AND_SCHEMA_MODELS } from "../model-meta.js";
 class GrokTextAdapter extends OpenAIBaseChatCompletionsTextAdapter {
   kind = "text";
   name = "grok";
@@ -22,6 +23,17 @@ class GrokTextAdapter extends OpenAIBaseChatCompletionsTextAdapter {
     }
     return void 0;
   }
+  /**
+   * 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.
+   */
+  supportsCombinedToolsAndSchema() {
+    return GROK_COMBINED_TOOLS_AND_SCHEMA_MODELS.has(this.model);
+  }
 }
 function createGrokText(model, apiKey, config) {
   return new GrokTextAdapter({ apiKey, ...config }, model);

package/dist/esm/adapters/text.js.map

@@ -1 +1 @@
-{"version":3,"file":"text.js","sources":["../../../src/adapters/text.ts"],"sourcesContent":["import OpenAI from 'openai'\nimport { OpenAIBaseChatCompletionsTextAdapter } from '@tanstack/openai-base'\nimport { getGrokApiKeyFromEnv, withGrokDefaults } from '../utils/client'\nimport type {\n  GROK_CHAT_MODELS,\n  GrokChatModelToolCapabilitiesByName,\n  ResolveInputModalities,\n  ResolveProviderOptions,\n} from '../model-meta'\nimport type { Modality } from '@tanstack/ai'\nimport type { GrokMessageMetadataByModality } from '../message-types'\nimport type { GrokClientConfig } from '../utils'\n\n/**\n * Resolve tool capabilities for a specific Grok model.\n */\ntype ResolveToolCapabilities<TModel extends string> =\n  TModel extends keyof GrokChatModelToolCapabilitiesByName\n    ? NonNullable<GrokChatModelToolCapabilitiesByName[TModel]>\n    : readonly []\n\n/**\n * Configuration for Grok text adapter\n */\nexport interface GrokTextConfig extends GrokClientConfig {}\n\n/**\n * Alias for TextProviderOptions for external use\n */\nexport type { ExternalTextProviderOptions as GrokTextProviderOptions } from '../text/text-provider-options'\n\n/**\n * Grok Text (Chat) Adapter\n *\n * Tree-shakeable adapter for Grok chat/text completion functionality.\n * Uses OpenAI-compatible Chat Completions API (not Responses API).\n *\n * Delegates implementation to {@link OpenAIBaseChatCompletionsTextAdapter}\n * from `@tanstack/openai-base` and threads Grok-specific tool-capability\n * typing through the 5th generic of the base class.\n */\nexport class GrokTextAdapter<\n  TModel extends (typeof GROK_CHAT_MODELS)[number],\n  TProviderOptions extends Record<string, any> = ResolveProviderOptions<TModel>,\n  TInputModalities extends ReadonlyArray<Modality> =\n    ResolveInputModalities<TModel>,\n  TToolCapabilities extends ReadonlyArray<string> =\n    ResolveToolCapabilities<TModel>,\n> extends OpenAIBaseChatCompletionsTextAdapter<\n  TModel,\n  TProviderOptions,\n  TInputModalities,\n  GrokMessageMetadataByModality,\n  TToolCapabilities\n> {\n  override readonly kind = 'text' as const\n  override readonly name = 'grok' as const\n\n  constructor(config: GrokTextConfig, model: TModel) {\n    super(model, 'grok', new OpenAI(withGrokDefaults(config)))\n  }\n\n  /**\n   * Surfaces xAI reasoning deltas on Grok reasoning models. The DeepSeek-style\n   * convention puts the chain-of-thought on `delta.reasoning_content`; some\n   * Grok variants also populate `delta.reasoning`. Reading both keeps\n   * reasoning flowing through the base's REASONING_* lifecycle for both\n   * `chatStream` and `structuredOutputStream`.\n   */\n  protected override extractReasoning(\n    chunk: OpenAI.Chat.Completions.ChatCompletionChunk,\n  ): { text: string } | undefined {\n    const delta = chunk.choices[0]?.delta as\n      | { reasoning?: unknown; reasoning_content?: unknown }\n      | undefined\n    const raw = delta?.reasoning_content ?? delta?.reasoning\n    if (typeof raw === 'string' && raw.length > 0) {\n      return { text: raw }\n    }\n    return undefined\n  }\n}\n\n/**\n * Creates a Grok text adapter with explicit API key.\n * Type resolution happens here at the call site.\n *\n * @param model - The model name (e.g., 'grok-3', 'grok-4')\n * @param apiKey - Your xAI API key\n * @param config - Optional additional configuration\n * @returns Configured Grok text adapter instance with resolved types\n *\n * @example\n * ```typescript\n * const adapter = createGrokText('grok-3', \"xai-...\");\n * // adapter has type-safe providerOptions for grok-3\n * ```\n */\nexport function createGrokText<\n  TModel extends (typeof GROK_CHAT_MODELS)[number],\n>(\n  model: TModel,\n  apiKey: string,\n  config?: Omit<GrokTextConfig, 'apiKey'>,\n): GrokTextAdapter<TModel> {\n  return new GrokTextAdapter({ apiKey, ...config }, model)\n}\n\n/**\n * Creates a Grok text adapter with automatic API key detection from environment variables.\n * Type resolution happens here at the call site.\n *\n * Looks for `XAI_API_KEY` in:\n * - `process.env` (Node.js)\n * - `window.env` (Browser with injected env)\n *\n * @param model - The model name (e.g., 'grok-3', 'grok-4')\n * @param config - Optional configuration (excluding apiKey which is auto-detected)\n * @returns Configured Grok text adapter instance with resolved types\n * @throws Error if XAI_API_KEY is not found in environment\n *\n * @example\n * ```typescript\n * // Automatically uses XAI_API_KEY from environment\n * const adapter = grokText('grok-3');\n *\n * const stream = chat({\n *   adapter,\n *   messages: [{ role: \"user\", content: \"Hello!\" }]\n * });\n * ```\n */\nexport function grokText<TModel extends (typeof GROK_CHAT_MODELS)[number]>(\n  model: TModel,\n  config?: Omit<GrokTextConfig, 'apiKey'>,\n): GrokTextAdapter<TModel> {\n  const apiKey = getGrokApiKeyFromEnv()\n  return createGrokText(model, apiKey, config)\n}\n"],"names":[],"mappings":";;;AAyCO,MAAM,wBAOH,qCAMR;AAAA,EACkB,OAAO;AAAA,EACP,OAAO;AAAA,EAEzB,YAAY,QAAwB,OAAe;AACjD,UAAM,OAAO,QAAQ,IAAI,OAAO,iBAAiB,MAAM,CAAC,CAAC;AAAA,EAC3D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASmB,iBACjB,OAC8B;AAC9B,UAAM,QAAQ,MAAM,QAAQ,CAAC,GAAG;AAGhC,UAAM,MAAM,OAAO,qBAAqB,OAAO;AAC/C,QAAI,OAAO,QAAQ,YAAY,IAAI,SAAS,GAAG;AAC7C,aAAO,EAAE,MAAM,IAAA;AAAA,IACjB;AACA,WAAO;AAAA,EACT;AACF;AAiBO,SAAS,eAGd,OACA,QACA,QACyB;AACzB,SAAO,IAAI,gBAAgB,EAAE,QAAQ,GAAG,OAAA,GAAU,KAAK;AACzD;AA0BO,SAAS,SACd,OACA,QACyB;AACzB,QAAM,SAAS,qBAAA;AACf,SAAO,eAAe,OAAO,QAAQ,MAAM;AAC7C;"}
+{"version":3,"file":"text.js","sources":["../../../src/adapters/text.ts"],"sourcesContent":["import OpenAI from 'openai'\nimport { OpenAIBaseChatCompletionsTextAdapter } from '@tanstack/openai-base'\nimport { getGrokApiKeyFromEnv, withGrokDefaults } from '../utils/client'\nimport { GROK_COMBINED_TOOLS_AND_SCHEMA_MODELS } from '../model-meta'\nimport type {\n  GROK_CHAT_MODELS,\n  GrokChatModelToolCapabilitiesByName,\n  ResolveInputModalities,\n  ResolveProviderOptions,\n} from '../model-meta'\nimport type { Modality } from '@tanstack/ai'\nimport type { GrokMessageMetadataByModality } from '../message-types'\nimport type { GrokClientConfig } from '../utils'\n\n/**\n * Resolve tool capabilities for a specific Grok model.\n */\ntype ResolveToolCapabilities<TModel extends string> =\n  TModel extends keyof GrokChatModelToolCapabilitiesByName\n    ? NonNullable<GrokChatModelToolCapabilitiesByName[TModel]>\n    : readonly []\n\n/**\n * Configuration for Grok text adapter\n */\nexport interface GrokTextConfig extends GrokClientConfig {}\n\n/**\n * Alias for TextProviderOptions for external use\n */\nexport type { ExternalTextProviderOptions as GrokTextProviderOptions } from '../text/text-provider-options'\n\n/**\n * Grok Text (Chat) Adapter\n *\n * Tree-shakeable adapter for Grok chat/text completion functionality.\n * Uses OpenAI-compatible Chat Completions API (not Responses API).\n *\n * Delegates implementation to {@link OpenAIBaseChatCompletionsTextAdapter}\n * from `@tanstack/openai-base` and threads Grok-specific tool-capability\n * typing through the 5th generic of the base class.\n */\nexport class GrokTextAdapter<\n  TModel extends (typeof GROK_CHAT_MODELS)[number],\n  TProviderOptions extends Record<string, any> = ResolveProviderOptions<TModel>,\n  TInputModalities extends ReadonlyArray<Modality> =\n    ResolveInputModalities<TModel>,\n  TToolCapabilities extends ReadonlyArray<string> =\n    ResolveToolCapabilities<TModel>,\n> extends OpenAIBaseChatCompletionsTextAdapter<\n  TModel,\n  TProviderOptions,\n  TInputModalities,\n  GrokMessageMetadataByModality,\n  TToolCapabilities\n> {\n  override readonly kind = 'text' as const\n  override readonly name = 'grok' as const\n\n  constructor(config: GrokTextConfig, model: TModel) {\n    super(model, 'grok', new OpenAI(withGrokDefaults(config)))\n  }\n\n  /**\n   * Surfaces xAI reasoning deltas on Grok reasoning models. The DeepSeek-style\n   * convention puts the chain-of-thought on `delta.reasoning_content`; some\n   * Grok variants also populate `delta.reasoning`. Reading both keeps\n   * reasoning flowing through the base's REASONING_* lifecycle for both\n   * `chatStream` and `structuredOutputStream`.\n   */\n  protected override extractReasoning(\n    chunk: OpenAI.Chat.Completions.ChatCompletionChunk,\n  ): { text: string } | undefined {\n    const delta = chunk.choices[0]?.delta as\n      | { reasoning?: unknown; reasoning_content?: unknown }\n      | undefined\n    const raw = delta?.reasoning_content ?? delta?.reasoning\n    if (typeof raw === 'string' && raw.length > 0) {\n      return { text: raw }\n    }\n    return undefined\n  }\n\n  /**\n   * Grok's combined tools + schema support is gated to the Grok 4 family\n   * per xAI's structured-output docs; Grok 2 / 3 reject the combination.\n   * The wiring on the wire is already correct (inherits the OpenAI Chat\n   * Completions `response_format: json_schema` attach from the base\n   * adapter); this override just narrows the capability claim to the\n   * supported model family.\n   */\n  override supportsCombinedToolsAndSchema(): boolean {\n    return GROK_COMBINED_TOOLS_AND_SCHEMA_MODELS.has(this.model)\n  }\n}\n\n/**\n * Creates a Grok text adapter with explicit API key.\n * Type resolution happens here at the call site.\n *\n * @param model - The model name (e.g., 'grok-3', 'grok-4')\n * @param apiKey - Your xAI API key\n * @param config - Optional additional configuration\n * @returns Configured Grok text adapter instance with resolved types\n *\n * @example\n * ```typescript\n * const adapter = createGrokText('grok-3', \"xai-...\");\n * // adapter has type-safe providerOptions for grok-3\n * ```\n */\nexport function createGrokText<\n  TModel extends (typeof GROK_CHAT_MODELS)[number],\n>(\n  model: TModel,\n  apiKey: string,\n  config?: Omit<GrokTextConfig, 'apiKey'>,\n): GrokTextAdapter<TModel> {\n  return new GrokTextAdapter({ apiKey, ...config }, model)\n}\n\n/**\n * Creates a Grok text adapter with automatic API key detection from environment variables.\n * Type resolution happens here at the call site.\n *\n * Looks for `XAI_API_KEY` in:\n * - `process.env` (Node.js)\n * - `window.env` (Browser with injected env)\n *\n * @param model - The model name (e.g., 'grok-3', 'grok-4')\n * @param config - Optional configuration (excluding apiKey which is auto-detected)\n * @returns Configured Grok text adapter instance with resolved types\n * @throws Error if XAI_API_KEY is not found in environment\n *\n * @example\n * ```typescript\n * // Automatically uses XAI_API_KEY from environment\n * const adapter = grokText('grok-3');\n *\n * const stream = chat({\n *   adapter,\n *   messages: [{ role: \"user\", content: \"Hello!\" }]\n * });\n * ```\n */\nexport function grokText<TModel extends (typeof GROK_CHAT_MODELS)[number]>(\n  model: TModel,\n  config?: Omit<GrokTextConfig, 'apiKey'>,\n): GrokTextAdapter<TModel> {\n  const apiKey = getGrokApiKeyFromEnv()\n  return createGrokText(model, apiKey, config)\n}\n"],"names":[],"mappings":";;;;AA0CO,MAAM,wBAOH,qCAMR;AAAA,EACkB,OAAO;AAAA,EACP,OAAO;AAAA,EAEzB,YAAY,QAAwB,OAAe;AACjD,UAAM,OAAO,QAAQ,IAAI,OAAO,iBAAiB,MAAM,CAAC,CAAC;AAAA,EAC3D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASmB,iBACjB,OAC8B;AAC9B,UAAM,QAAQ,MAAM,QAAQ,CAAC,GAAG;AAGhC,UAAM,MAAM,OAAO,qBAAqB,OAAO;AAC/C,QAAI,OAAO,QAAQ,YAAY,IAAI,SAAS,GAAG;AAC7C,aAAO,EAAE,MAAM,IAAA;AAAA,IACjB;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUS,iCAA0C;AACjD,WAAO,sCAAsC,IAAI,KAAK,KAAK;AAAA,EAC7D;AACF;AAiBO,SAAS,eAGd,OACA,QACA,QACyB;AACzB,SAAO,IAAI,gBAAgB,EAAE,QAAQ,GAAG,OAAA,GAAU,KAAK;AACzD;AA0BO,SAAS,SACd,OACA,QACyB;AACzB,QAAM,SAAS,qBAAA;AACf,SAAO,eAAe,OAAO,QAAQ,MAAM;AAC7C;"}

package/dist/esm/model-meta.d.ts

@@ -249,6 +249,19 @@ declare const GROK_BUILD_0_1: {
     };
 };
 export declare const GROK_CHAT_MODELS: readonly ["grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning", "grok-code-fast-1", "grok-4-fast-reasoning", "grok-4-fast-non-reasoning", "grok-4", "grok-3", "grok-3-mini", "grok-2-vision-1212", "grok-4.20", "grok-4.20-multi-agent", "grok-4.3", "grok-build-0.1"];
+/**
+ * Grok models that support combining `tools` + `response_format: json_schema`
+ * in a single streaming Chat Completions request (per issue #605). xAI
+ * docs gate this to the Grok 4 family — Grok 2 / 3 reject the
+ * combination. Grok 2 image generation is not a chat model, omitted.
+ *
+ * Note: Grok streams tool-call arguments atomically (not token-streamed)
+ * per the issue's source matrix; partial-JSON tool-arg parsing should be
+ * skipped for Grok specifically. That's a separate adapter concern from
+ * this set — the set only gates whether the engine takes the native
+ * combined path vs the legacy finalization path.
+ */
+export declare const GROK_COMBINED_TOOLS_AND_SCHEMA_MODELS: Set<string>;
 /**
  * Grok Image Generation Models
  */

package/dist/esm/model-meta.js

@@ -55,6 +55,17 @@ const GROK_CHAT_MODELS = [
   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_IMAGE_MODELS = [GROK_2_IMAGE.name];
 const GROK_TTS = {
   name: "grok-tts"
@@ -76,6 +87,7 @@ 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/**\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 Image Generation Models\n */\nexport const GROK_IMAGE_MODELS = [GROK_2_IMAGE.name] 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;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;AAKO,MAAM,oBAAoB,CAAC,aAAa,IAAI;AAKnD,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 */\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/**\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 = [GROK_2_IMAGE.name] 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;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,CAAC,aAAa,IAAI;AAKnD,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai-grok",
-  "version": "0.8.7",
+  "version": "0.9.0",
   "description": "xAI Grok adapter for TanStack AI chat, image generation, realtime, and structured outputs.",
   "author": "",
   "license": "MIT",
@@ -42,18 +42,18 @@
   ],
   "dependencies": {
     "openai": "^6.9.1",
-    "@tanstack/ai-utils": "0.2.1",
-    "@tanstack/openai-base": "0.3.6"
+    "@tanstack/openai-base": "0.4.0",
+    "@tanstack/ai-utils": "0.2.1"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "4.0.14",
     "vite": "^7.3.3",
-    "@tanstack/ai-client": "0.11.6",
-    "@tanstack/ai": "0.21.2"
+    "@tanstack/ai": "0.22.0",
+    "@tanstack/ai-client": "0.11.8"
   },
   "peerDependencies": {
     "zod": "^4.0.0",
-    "@tanstack/ai": "^0.21.2"
+    "@tanstack/ai": "^0.22.0"
   },
   "scripts": {
     "build": "vite build",

package/src/adapters/text.ts

@@ -1,6 +1,7 @@
 import OpenAI from 'openai'
 import { OpenAIBaseChatCompletionsTextAdapter } from '@tanstack/openai-base'
 import { getGrokApiKeyFromEnv, withGrokDefaults } from '../utils/client'
+import { GROK_COMBINED_TOOLS_AND_SCHEMA_MODELS } from '../model-meta'
 import type {
   GROK_CHAT_MODELS,
   GrokChatModelToolCapabilitiesByName,
@@ -79,6 +80,18 @@ export class GrokTextAdapter<
     }
     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)
+  }
 }
 
 /**

package/src/model-meta.ts

@@ -322,6 +322,30 @@ export const GROK_CHAT_MODELS = [
   GROK_BUILD_0_1.name,
 ] as const
 
+/**
+ * Grok models that support combining `tools` + `response_format: json_schema`
+ * in a single streaming Chat Completions request (per issue #605). xAI
+ * docs gate this to the Grok 4 family — Grok 2 / 3 reject the
+ * combination. Grok 2 image generation is not a chat model, omitted.
+ *
+ * Note: Grok streams tool-call arguments atomically (not token-streamed)
+ * per the issue's source matrix; partial-JSON tool-arg parsing should be
+ * skipped for Grok specifically. That's a separate adapter concern from
+ * this set — the set only gates whether the engine takes the native
+ * combined path vs the legacy finalization path.
+ */
+export const GROK_COMBINED_TOOLS_AND_SCHEMA_MODELS = new Set<string>([
+  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,
+])
+
 /**
  * Grok Image Generation Models
  */