@tanstack/ai-grok 0.14.4 → 0.14.6

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

@@ -27,7 +27,7 @@ export type { ExternalTextProviderOptions as GrokTextProviderOptions } from '../
  * from `@tanstack/openai-base` and threads Grok-specific tool-capability
  * typing through the 5th generic of the base class.
  */
-export declare class GrokTextAdapter<TModel extends (typeof GROK_CHAT_MODELS)[number], TProviderOptions extends Record<string, unknown> = ResolveProviderOptions<TModel>, TInputModalities extends ReadonlyArray<Modality> = ResolveInputModalities<TModel>, TToolCapabilities extends ReadonlyArray<string> = ResolveToolCapabilities<TModel>> extends OpenAIBaseResponsesTextAdapter<TModel, TProviderOptions, TInputModalities, GrokMessageMetadataByModality, TToolCapabilities> {
+export declare class GrokTextAdapter<TModel extends (typeof GROK_CHAT_MODELS)[number], TProviderOptions extends Record<string, any> = ResolveProviderOptions<TModel>, TInputModalities extends ReadonlyArray<Modality> = ResolveInputModalities<TModel>, TToolCapabilities extends ReadonlyArray<string> = ResolveToolCapabilities<TModel>> extends OpenAIBaseResponsesTextAdapter<TModel, TProviderOptions, TInputModalities, GrokMessageMetadataByModality, TToolCapabilities> {
     readonly kind: "text";
     readonly name: "grok";
     constructor(config: GrokTextConfig, model: TModel);

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 { OpenAIBaseResponsesTextAdapter } from '@tanstack/openai-base'\nimport { getGrokApiKeyFromEnv, withGrokDefaults } from '../utils/client'\nimport { convertToolsToProviderFormat } from '../tools'\nimport type {\n  GROK_CHAT_MODELS,\n  GrokChatModelToolCapabilitiesByName,\n  ResolveInputModalities,\n  ResolveProviderOptions,\n} from '../model-meta'\nimport type { Modality, TextOptions } from '@tanstack/ai'\nimport type { GrokMessageMetadataByModality } from '../message-types'\nimport type { GrokClientConfig } from '../utils'\nimport type { ResponseCreateParams } from 'openai/resources/responses/responses'\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 xAI's OpenAI-compatible Responses API.\n *\n * Delegates implementation to {@link OpenAIBaseResponsesTextAdapter}\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, unknown> =\n    ResolveProviderOptions<TModel>,\n  TInputModalities extends ReadonlyArray<Modality> =\n    ResolveInputModalities<TModel>,\n  TToolCapabilities extends ReadonlyArray<string> =\n    ResolveToolCapabilities<TModel>,\n> extends OpenAIBaseResponsesTextAdapter<\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  protected override mapOptionsToRequest(\n    options: TextOptions<TProviderOptions>,\n  ): Omit<ResponseCreateParams, 'stream'> {\n    const { tools: _baseTools, ...request } = super.mapOptionsToRequest({\n      ...options,\n      tools: undefined,\n    })\n    void _baseTools\n\n    if (this.model === 'grok-build-0.1' && request.reasoning !== undefined) {\n      throw new Error(\n        'grok-build-0.1 does not support reasoning modelOptions; omit reasoning for this model.',\n      )\n    }\n\n    const tools = options.tools\n      ? convertToolsToProviderFormat(options.tools)\n      : undefined\n\n    return {\n      ...request,\n      // xAI recommends encrypted reasoning for reasoning-capable Responses\n      // requests; callers can still override either field in modelOptions.\n      store: request.store ?? false,\n      include: request.include ?? ['reasoning.encrypted_content'],\n      ...(tools &&\n        tools.length > 0 && { tools: tools as ResponseCreateParams['tools'] }),\n    }\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-build-0.1')\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-build-0.1', \"xai-...\");\n * // adapter has type-safe providerOptions for grok-build-0.1\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-build-0.1')\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-build-0.1');\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":";;;;AA2CO,MAAM,wBAQH,+BAMR;AAAA,EACkB,OAAO;AAAA,EACP,OAAO;AAAA,EAEzB,YAAY,QAAwB,OAAe;AACjD,UAAM,OAAO,QAAQ,IAAI,OAAO,iBAAiB,MAAM,CAAC,CAAC;AAAA,EAC3D;AAAA,EAEmB,oBACjB,SACsC;AACtC,UAAM,EAAE,OAAO,YAAY,GAAG,QAAA,IAAY,MAAM,oBAAoB;AAAA,MAClE,GAAG;AAAA,MACH,OAAO;AAAA,IAAA,CACR;AAGD,QAAI,KAAK,UAAU,oBAAoB,QAAQ,cAAc,QAAW;AACtE,YAAM,IAAI;AAAA,QACR;AAAA,MAAA;AAAA,IAEJ;AAEA,UAAM,QAAQ,QAAQ,QAClB,6BAA6B,QAAQ,KAAK,IAC1C;AAEJ,WAAO;AAAA,MACL,GAAG;AAAA;AAAA;AAAA,MAGH,OAAO,QAAQ,SAAS;AAAA,MACxB,SAAS,QAAQ,WAAW,CAAC,6BAA6B;AAAA,MAC1D,GAAI,SACF,MAAM,SAAS,KAAK,EAAE,MAAA;AAAA,IAA8C;AAAA,EAE1E;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 { OpenAIBaseResponsesTextAdapter } from '@tanstack/openai-base'\nimport { getGrokApiKeyFromEnv, withGrokDefaults } from '../utils/client'\nimport { convertToolsToProviderFormat } from '../tools'\nimport type {\n  GROK_CHAT_MODELS,\n  GrokChatModelToolCapabilitiesByName,\n  ResolveInputModalities,\n  ResolveProviderOptions,\n} from '../model-meta'\nimport type { Modality, TextOptions } from '@tanstack/ai'\nimport type { GrokMessageMetadataByModality } from '../message-types'\nimport type { GrokClientConfig } from '../utils'\nimport type { ResponseCreateParams } from 'openai/resources/responses/responses'\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 xAI's OpenAI-compatible Responses API.\n *\n * Delegates implementation to {@link OpenAIBaseResponsesTextAdapter}\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  // Use `Record<string, any>` (not `unknown`) to match the OpenAI text\n  // adapter: the resolved Grok provider options are a type-alias intersection\n  // with no explicit index signature, which is assignable to\n  // `Record<string, any>` but not `Record<string, unknown>`. See issue #821.\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 OpenAIBaseResponsesTextAdapter<\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  protected override mapOptionsToRequest(\n    options: TextOptions<TProviderOptions>,\n  ): Omit<ResponseCreateParams, 'stream'> {\n    const { tools: _baseTools, ...request } = super.mapOptionsToRequest({\n      ...options,\n      tools: undefined,\n    })\n    void _baseTools\n\n    if (this.model === 'grok-build-0.1' && request.reasoning !== undefined) {\n      throw new Error(\n        'grok-build-0.1 does not support reasoning modelOptions; omit reasoning for this model.',\n      )\n    }\n\n    const tools = options.tools\n      ? convertToolsToProviderFormat(options.tools)\n      : undefined\n\n    return {\n      ...request,\n      // xAI recommends encrypted reasoning for reasoning-capable Responses\n      // requests; callers can still override either field in modelOptions.\n      store: request.store ?? false,\n      include: request.include ?? ['reasoning.encrypted_content'],\n      ...(tools &&\n        tools.length > 0 && { tools: tools as ResponseCreateParams['tools'] }),\n    }\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-build-0.1')\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-build-0.1', \"xai-...\");\n * // adapter has type-safe providerOptions for grok-build-0.1\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-build-0.1')\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-build-0.1');\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":";;;;AA2CO,MAAM,wBAWH,+BAMR;AAAA,EACkB,OAAO;AAAA,EACP,OAAO;AAAA,EAEzB,YAAY,QAAwB,OAAe;AACjD,UAAM,OAAO,QAAQ,IAAI,OAAO,iBAAiB,MAAM,CAAC,CAAC;AAAA,EAC3D;AAAA,EAEmB,oBACjB,SACsC;AACtC,UAAM,EAAE,OAAO,YAAY,GAAG,QAAA,IAAY,MAAM,oBAAoB;AAAA,MAClE,GAAG;AAAA,MACH,OAAO;AAAA,IAAA,CACR;AAGD,QAAI,KAAK,UAAU,oBAAoB,QAAQ,cAAc,QAAW;AACtE,YAAM,IAAI;AAAA,QACR;AAAA,MAAA;AAAA,IAEJ;AAEA,UAAM,QAAQ,QAAQ,QAClB,6BAA6B,QAAQ,KAAK,IAC1C;AAEJ,WAAO;AAAA,MACL,GAAG;AAAA;AAAA;AAAA,MAGH,OAAO,QAAQ,SAAS;AAAA,MACxB,SAAS,QAAQ,WAAW,CAAC,6BAA6B;AAAA,MAC1D,GAAI,SACF,MAAM,SAAS,KAAK,EAAE,MAAA;AAAA,IAA8C;AAAA,EAE1E;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/text/text-provider-options.d.ts

@@ -14,10 +14,9 @@ export interface GrokBaseOptions {
     user?: string;
 }
 /**
- * Grok-specific provider options for text/chat
- * Based on xAI Responses API options
+ * Sampling and response controls for Grok text/chat models.
  */
-export interface GrokTextProviderOptions extends GrokBaseOptions, Record<string, unknown> {
+export interface GrokSamplingOptions {
     /**
      * Temperature for response generation (0-2)
      * Higher values make output more random, lower values more focused
@@ -45,6 +44,20 @@ export interface GrokTextProviderOptions extends GrokBaseOptions, Record<string,
      */
     reasoning?: GrokReasoning;
 }
+/**
+ * Grok-specific provider options for text/chat
+ * Based on xAI Responses API options.
+ *
+ * Declared as a type-alias intersection of interfaces with all-optional props
+ * (matching the OpenAI text adapter), NOT an `interface ... extends
+ * Record<string, unknown>`. An explicit index signature makes `object`
+ * un-assignable to these options, which breaks the contravariantly-checked
+ * `summarize()` adapter constraint (`SummarizeAdapter<string, object>`); see
+ * issue #821. Without the index signature these options no longer satisfy a
+ * `Record<string, unknown>` constraint, so the text adapter's provider-options
+ * generic is widened to `Record<string, any>` to match OpenAI.
+ */
+export type GrokTextProviderOptions = GrokBaseOptions & GrokSamplingOptions;
 export type GrokBuildProviderOptions = Omit<GrokTextProviderOptions, 'reasoning'> & {
     reasoning?: never;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai-grok",
-  "version": "0.14.4",
+  "version": "0.14.6",
   "description": "xAI Grok adapter for TanStack AI chat, image generation, realtime, and structured outputs.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -51,16 +51,16 @@
   "dependencies": {
     "openai": "^6.41.0",
     "@tanstack/ai-utils": "0.3.1",
-    "@tanstack/openai-base": "0.9.4"
+    "@tanstack/openai-base": "0.9.6"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "4.0.14",
     "vite": "^7.3.3",
-    "@tanstack/ai": "0.37.0"
+    "@tanstack/ai": "0.39.0"
   },
   "peerDependencies": {
     "zod": "^4.0.0",
-    "@tanstack/ai": "^0.37.0"
+    "@tanstack/ai": "^0.39.0"
   },
   "scripts": {
     "build": "vite build",

package/src/adapters/text.ts

@@ -43,8 +43,11 @@ export type { ExternalTextProviderOptions as GrokTextProviderOptions } from '../
  */
 export class GrokTextAdapter<
   TModel extends (typeof GROK_CHAT_MODELS)[number],
-  TProviderOptions extends Record<string, unknown> =
-    ResolveProviderOptions<TModel>,
+  // Use `Record<string, any>` (not `unknown`) to match the OpenAI text
+  // adapter: the resolved Grok provider options are a type-alias intersection
+  // with no explicit index signature, which is assignable to
+  // `Record<string, any>` but not `Record<string, unknown>`. See issue #821.
+  TProviderOptions extends Record<string, any> = ResolveProviderOptions<TModel>,
   TInputModalities extends ReadonlyArray<Modality> =
     ResolveInputModalities<TModel>,
   TToolCapabilities extends ReadonlyArray<string> =

package/src/text/text-provider-options.ts

@@ -29,11 +29,9 @@ export interface GrokBaseOptions {
 }
 
 /**
- * Grok-specific provider options for text/chat
- * Based on xAI Responses API options
+ * Sampling and response controls for Grok text/chat models.
  */
-export interface GrokTextProviderOptions
-  extends GrokBaseOptions, Record<string, unknown> {
+export interface GrokSamplingOptions {
   /**
    * Temperature for response generation (0-2)
    * Higher values make output more random, lower values more focused
@@ -62,6 +60,21 @@ export interface GrokTextProviderOptions
   reasoning?: GrokReasoning
 }
 
+/**
+ * Grok-specific provider options for text/chat
+ * Based on xAI Responses API options.
+ *
+ * Declared as a type-alias intersection of interfaces with all-optional props
+ * (matching the OpenAI text adapter), NOT an `interface ... extends
+ * Record<string, unknown>`. An explicit index signature makes `object`
+ * un-assignable to these options, which breaks the contravariantly-checked
+ * `summarize()` adapter constraint (`SummarizeAdapter<string, object>`); see
+ * issue #821. Without the index signature these options no longer satisfy a
+ * `Record<string, unknown>` constraint, so the text adapter's provider-options
+ * generic is widened to `Record<string, any>` to match OpenAI.
+ */
+export type GrokTextProviderOptions = GrokBaseOptions & GrokSamplingOptions
+
 export type GrokBuildProviderOptions = Omit<
   GrokTextProviderOptions,
   'reasoning'