@tanstack/ai-grok 0.4.0 → 0.5.0

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

@@ -1,5 +1,5 @@
 import { BaseImageAdapter } from '@tanstack/ai/adapters';
-import { GROK_IMAGE_MODELS } from '../model-meta.js';
+import { GrokImageModel } from '../model-meta.js';
 import { GrokImageModelProviderOptionsByName, GrokImageModelSizeByName, GrokImageProviderOptions } from '../image/image-provider-options.js';
 import { ImageGenerationOptions, ImageGenerationResult } from '@tanstack/ai';
 import { GrokClientConfig } from '../utils.js';
@@ -8,8 +8,6 @@ import { GrokClientConfig } from '../utils.js';
  */
 export interface GrokImageConfig extends GrokClientConfig {
 }
-/** Model type for Grok Image */
-export type GrokImageModel = (typeof GROK_IMAGE_MODELS)[number];
 /**
  * Grok Image Generation Adapter
  *

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

@@ -1 +1 @@
-{"version":3,"file":"image.js","sources":["../../../src/adapters/image.ts"],"sourcesContent":["import { BaseImageAdapter } from '@tanstack/ai/adapters'\nimport { createGrokClient, generateId, getGrokApiKeyFromEnv } from '../utils'\nimport {\n  validateImageSize,\n  validateNumberOfImages,\n  validatePrompt,\n} from '../image/image-provider-options'\nimport type { GROK_IMAGE_MODELS } from '../model-meta'\nimport type {\n  GrokImageModelProviderOptionsByName,\n  GrokImageModelSizeByName,\n  GrokImageProviderOptions,\n} from '../image/image-provider-options'\nimport type {\n  GeneratedImage,\n  ImageGenerationOptions,\n  ImageGenerationResult,\n} from '@tanstack/ai'\nimport type OpenAI_SDK from 'openai'\nimport type { GrokClientConfig } from '../utils'\n\n/**\n * Configuration for Grok image adapter\n */\nexport interface GrokImageConfig extends GrokClientConfig {}\n\n/** Model type for Grok Image */\nexport type GrokImageModel = (typeof GROK_IMAGE_MODELS)[number]\n\n/**\n * Grok Image Generation Adapter\n *\n * Tree-shakeable adapter for Grok image generation functionality.\n * Supports grok-2-image-1212 model.\n *\n * Features:\n * - Model-specific type-safe provider options\n * - Size validation per model\n * - Number of images validation\n */\nexport class GrokImageAdapter<\n  TModel extends GrokImageModel,\n> extends BaseImageAdapter<\n  TModel,\n  GrokImageProviderOptions,\n  GrokImageModelProviderOptionsByName,\n  GrokImageModelSizeByName\n> {\n  readonly kind = 'image' as const\n  readonly name = 'grok' as const\n\n  private client: OpenAI_SDK\n\n  constructor(config: GrokImageConfig, model: TModel) {\n    super({}, model)\n    this.client = createGrokClient(config)\n  }\n\n  async generateImages(\n    options: ImageGenerationOptions<GrokImageProviderOptions>,\n  ): Promise<ImageGenerationResult> {\n    const { model, prompt, numberOfImages, size } = options\n\n    // Validate inputs\n    validatePrompt({ prompt, model })\n    validateImageSize(model, size)\n    validateNumberOfImages(model, numberOfImages)\n\n    // Build request based on model type\n    const request = this.buildRequest(options)\n\n    const response = await this.client.images.generate({\n      ...request,\n      stream: false,\n    })\n\n    return this.transformResponse(model, response)\n  }\n\n  private buildRequest(\n    options: ImageGenerationOptions<GrokImageProviderOptions>,\n  ): OpenAI_SDK.Images.ImageGenerateParams {\n    const { model, prompt, numberOfImages, size, modelOptions } = options\n\n    return {\n      model,\n      prompt,\n      n: numberOfImages ?? 1,\n      size: size as OpenAI_SDK.Images.ImageGenerateParams['size'],\n      ...modelOptions,\n    }\n  }\n\n  private transformResponse(\n    model: string,\n    response: OpenAI_SDK.Images.ImagesResponse,\n  ): ImageGenerationResult {\n    const images: Array<GeneratedImage> = (response.data ?? []).map((item) => ({\n      b64Json: item.b64_json,\n      url: item.url,\n      revisedPrompt: item.revised_prompt,\n    }))\n\n    return {\n      id: generateId(this.name),\n      model,\n      images,\n      usage: response.usage\n        ? {\n            inputTokens: response.usage.input_tokens,\n            outputTokens: response.usage.output_tokens,\n            totalTokens: response.usage.total_tokens,\n          }\n        : undefined,\n    }\n  }\n}\n\n/**\n * Creates a Grok image adapter with explicit API key.\n * Type resolution happens here at the call site.\n *\n * @param model - The model name (e.g., 'grok-2-image-1212')\n * @param apiKey - Your xAI API key\n * @param config - Optional additional configuration\n * @returns Configured Grok image adapter instance with resolved types\n *\n * @example\n * ```typescript\n * const adapter = createGrokImage('grok-2-image-1212', \"xai-...\");\n *\n * const result = await generateImage({\n *   adapter,\n *   prompt: 'A cute baby sea otter'\n * });\n * ```\n */\nexport function createGrokImage<TModel extends GrokImageModel>(\n  model: TModel,\n  apiKey: string,\n  config?: Omit<GrokImageConfig, 'apiKey'>,\n): GrokImageAdapter<TModel> {\n  return new GrokImageAdapter({ apiKey, ...config }, model)\n}\n\n/**\n * Creates a Grok image 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-2-image-1212')\n * @param config - Optional configuration (excluding apiKey which is auto-detected)\n * @returns Configured Grok image 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 = grokImage('grok-2-image-1212');\n *\n * const result = await generateImage({\n *   adapter,\n *   prompt: 'A beautiful sunset over mountains'\n * });\n * ```\n */\nexport function grokImage<TModel extends GrokImageModel>(\n  model: TModel,\n  config?: Omit<GrokImageConfig, 'apiKey'>,\n): GrokImageAdapter<TModel> {\n  const apiKey = getGrokApiKeyFromEnv()\n  return createGrokImage(model, apiKey, config)\n}\n"],"names":[],"mappings":";;;AAwCO,MAAM,yBAEH,iBAKR;AAAA,EAMA,YAAY,QAAyB,OAAe;AAClD,UAAM,CAAA,GAAI,KAAK;AANjB,SAAS,OAAO;AAChB,SAAS,OAAO;AAMd,SAAK,SAAS,iBAAiB,MAAM;AAAA,EACvC;AAAA,EAEA,MAAM,eACJ,SACgC;AAChC,UAAM,EAAE,OAAO,QAAQ,gBAAgB,SAAS;AAGhD,mBAAe,EAAE,OAAc,CAAC;AAChC,sBAAkB,OAAO,IAAI;AAC7B,2BAAuB,OAAO,cAAc;AAG5C,UAAM,UAAU,KAAK,aAAa,OAAO;AAEzC,UAAM,WAAW,MAAM,KAAK,OAAO,OAAO,SAAS;AAAA,MACjD,GAAG;AAAA,MACH,QAAQ;AAAA,IAAA,CACT;AAED,WAAO,KAAK,kBAAkB,OAAO,QAAQ;AAAA,EAC/C;AAAA,EAEQ,aACN,SACuC;AACvC,UAAM,EAAE,OAAO,QAAQ,gBAAgB,MAAM,iBAAiB;AAE9D,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,GAAG,kBAAkB;AAAA,MACrB;AAAA,MACA,GAAG;AAAA,IAAA;AAAA,EAEP;AAAA,EAEQ,kBACN,OACA,UACuB;AACvB,UAAM,UAAiC,SAAS,QAAQ,CAAA,GAAI,IAAI,CAAC,UAAU;AAAA,MACzE,SAAS,KAAK;AAAA,MACd,KAAK,KAAK;AAAA,MACV,eAAe,KAAK;AAAA,IAAA,EACpB;AAEF,WAAO;AAAA,MACL,IAAI,WAAW,KAAK,IAAI;AAAA,MACxB;AAAA,MACA;AAAA,MACA,OAAO,SAAS,QACZ;AAAA,QACE,aAAa,SAAS,MAAM;AAAA,QAC5B,cAAc,SAAS,MAAM;AAAA,QAC7B,aAAa,SAAS,MAAM;AAAA,MAAA,IAE9B;AAAA,IAAA;AAAA,EAER;AACF;AAqBO,SAAS,gBACd,OACA,QACA,QAC0B;AAC1B,SAAO,IAAI,iBAAiB,EAAE,QAAQ,GAAG,OAAA,GAAU,KAAK;AAC1D;AA0BO,SAAS,UACd,OACA,QAC0B;AAC1B,QAAM,SAAS,qBAAA;AACf,SAAO,gBAAgB,OAAO,QAAQ,MAAM;AAC9C;"}
+{"version":3,"file":"image.js","sources":["../../../src/adapters/image.ts"],"sourcesContent":["import { BaseImageAdapter } from '@tanstack/ai/adapters'\nimport { createGrokClient, generateId, getGrokApiKeyFromEnv } from '../utils'\nimport {\n  validateImageSize,\n  validateNumberOfImages,\n  validatePrompt,\n} from '../image/image-provider-options'\nimport type { GrokImageModel } from '../model-meta'\nimport type {\n  GrokImageModelProviderOptionsByName,\n  GrokImageModelSizeByName,\n  GrokImageProviderOptions,\n} from '../image/image-provider-options'\nimport type {\n  GeneratedImage,\n  ImageGenerationOptions,\n  ImageGenerationResult,\n} from '@tanstack/ai'\nimport type OpenAI_SDK from 'openai'\nimport type { GrokClientConfig } from '../utils'\n\n/**\n * Configuration for Grok image adapter\n */\nexport interface GrokImageConfig extends GrokClientConfig {}\n\n/**\n * Grok Image Generation Adapter\n *\n * Tree-shakeable adapter for Grok image generation functionality.\n * Supports grok-2-image-1212 model.\n *\n * Features:\n * - Model-specific type-safe provider options\n * - Size validation per model\n * - Number of images validation\n */\nexport class GrokImageAdapter<\n  TModel extends GrokImageModel,\n> extends BaseImageAdapter<\n  TModel,\n  GrokImageProviderOptions,\n  GrokImageModelProviderOptionsByName,\n  GrokImageModelSizeByName\n> {\n  readonly kind = 'image' as const\n  readonly name = 'grok' as const\n\n  private client: OpenAI_SDK\n\n  constructor(config: GrokImageConfig, model: TModel) {\n    super({}, model)\n    this.client = createGrokClient(config)\n  }\n\n  async generateImages(\n    options: ImageGenerationOptions<GrokImageProviderOptions>,\n  ): Promise<ImageGenerationResult> {\n    const { model, prompt, numberOfImages, size } = options\n\n    // Validate inputs\n    validatePrompt({ prompt, model })\n    validateImageSize(model, size)\n    validateNumberOfImages(model, numberOfImages)\n\n    // Build request based on model type\n    const request = this.buildRequest(options)\n\n    const response = await this.client.images.generate({\n      ...request,\n      stream: false,\n    })\n\n    return this.transformResponse(model, response)\n  }\n\n  private buildRequest(\n    options: ImageGenerationOptions<GrokImageProviderOptions>,\n  ): OpenAI_SDK.Images.ImageGenerateParams {\n    const { model, prompt, numberOfImages, size, modelOptions } = options\n\n    return {\n      model,\n      prompt,\n      n: numberOfImages ?? 1,\n      size: size as OpenAI_SDK.Images.ImageGenerateParams['size'],\n      ...modelOptions,\n    }\n  }\n\n  private transformResponse(\n    model: string,\n    response: OpenAI_SDK.Images.ImagesResponse,\n  ): ImageGenerationResult {\n    const images: Array<GeneratedImage> = (response.data ?? []).map((item) => ({\n      b64Json: item.b64_json,\n      url: item.url,\n      revisedPrompt: item.revised_prompt,\n    }))\n\n    return {\n      id: generateId(this.name),\n      model,\n      images,\n      usage: response.usage\n        ? {\n            inputTokens: response.usage.input_tokens,\n            outputTokens: response.usage.output_tokens,\n            totalTokens: response.usage.total_tokens,\n          }\n        : undefined,\n    }\n  }\n}\n\n/**\n * Creates a Grok image adapter with explicit API key.\n * Type resolution happens here at the call site.\n *\n * @param model - The model name (e.g., 'grok-2-image-1212')\n * @param apiKey - Your xAI API key\n * @param config - Optional additional configuration\n * @returns Configured Grok image adapter instance with resolved types\n *\n * @example\n * ```typescript\n * const adapter = createGrokImage('grok-2-image-1212', \"xai-...\");\n *\n * const result = await generateImage({\n *   adapter,\n *   prompt: 'A cute baby sea otter'\n * });\n * ```\n */\nexport function createGrokImage<TModel extends GrokImageModel>(\n  model: TModel,\n  apiKey: string,\n  config?: Omit<GrokImageConfig, 'apiKey'>,\n): GrokImageAdapter<TModel> {\n  return new GrokImageAdapter({ apiKey, ...config }, model)\n}\n\n/**\n * Creates a Grok image 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-2-image-1212')\n * @param config - Optional configuration (excluding apiKey which is auto-detected)\n * @returns Configured Grok image 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 = grokImage('grok-2-image-1212');\n *\n * const result = await generateImage({\n *   adapter,\n *   prompt: 'A beautiful sunset over mountains'\n * });\n * ```\n */\nexport function grokImage<TModel extends GrokImageModel>(\n  model: TModel,\n  config?: Omit<GrokImageConfig, 'apiKey'>,\n): GrokImageAdapter<TModel> {\n  const apiKey = getGrokApiKeyFromEnv()\n  return createGrokImage(model, apiKey, config)\n}\n"],"names":[],"mappings":";;;AAqCO,MAAM,yBAEH,iBAKR;AAAA,EAMA,YAAY,QAAyB,OAAe;AAClD,UAAM,CAAA,GAAI,KAAK;AANjB,SAAS,OAAO;AAChB,SAAS,OAAO;AAMd,SAAK,SAAS,iBAAiB,MAAM;AAAA,EACvC;AAAA,EAEA,MAAM,eACJ,SACgC;AAChC,UAAM,EAAE,OAAO,QAAQ,gBAAgB,SAAS;AAGhD,mBAAe,EAAE,OAAc,CAAC;AAChC,sBAAkB,OAAO,IAAI;AAC7B,2BAAuB,OAAO,cAAc;AAG5C,UAAM,UAAU,KAAK,aAAa,OAAO;AAEzC,UAAM,WAAW,MAAM,KAAK,OAAO,OAAO,SAAS;AAAA,MACjD,GAAG;AAAA,MACH,QAAQ;AAAA,IAAA,CACT;AAED,WAAO,KAAK,kBAAkB,OAAO,QAAQ;AAAA,EAC/C;AAAA,EAEQ,aACN,SACuC;AACvC,UAAM,EAAE,OAAO,QAAQ,gBAAgB,MAAM,iBAAiB;AAE9D,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,GAAG,kBAAkB;AAAA,MACrB;AAAA,MACA,GAAG;AAAA,IAAA;AAAA,EAEP;AAAA,EAEQ,kBACN,OACA,UACuB;AACvB,UAAM,UAAiC,SAAS,QAAQ,CAAA,GAAI,IAAI,CAAC,UAAU;AAAA,MACzE,SAAS,KAAK;AAAA,MACd,KAAK,KAAK;AAAA,MACV,eAAe,KAAK;AAAA,IAAA,EACpB;AAEF,WAAO;AAAA,MACL,IAAI,WAAW,KAAK,IAAI;AAAA,MACxB;AAAA,MACA;AAAA,MACA,OAAO,SAAS,QACZ;AAAA,QACE,aAAa,SAAS,MAAM;AAAA,QAC5B,cAAc,SAAS,MAAM;AAAA,QAC7B,aAAa,SAAS,MAAM;AAAA,MAAA,IAE9B;AAAA,IAAA;AAAA,EAER;AACF;AAqBO,SAAS,gBACd,OACA,QACA,QAC0B;AAC1B,SAAO,IAAI,iBAAiB,EAAE,QAAQ,GAAG,OAAA,GAAU,KAAK;AAC1D;AA0BO,SAAS,UACd,OACA,QAC0B;AAC1B,QAAM,SAAS,qBAAA;AACf,SAAO,gBAAgB,OAAO,QAAQ,MAAM;AAC9C;"}

package/dist/esm/index.d.ts

@@ -1,7 +1,7 @@
 export { GrokTextAdapter, createGrokText, grokText, type GrokTextConfig, type GrokTextProviderOptions, } from './adapters/text.js';
 export { GrokSummarizeAdapter, createGrokSummarize, grokSummarize, type GrokSummarizeConfig, type GrokSummarizeProviderOptions, type GrokSummarizeModel, } from './adapters/summarize.js';
-export { GrokImageAdapter, createGrokImage, grokImage, type GrokImageConfig, type GrokImageModel, } from './adapters/image.js';
+export { GrokImageAdapter, createGrokImage, grokImage, type GrokImageConfig, } from './adapters/image.js';
 export type { GrokImageProviderOptions, GrokImageModelProviderOptionsByName, } from './image/image-provider-options.js';
-export type { GrokChatModelProviderOptionsByName, GrokModelInputModalitiesByName, ResolveProviderOptions, ResolveInputModalities, } from './model-meta.js';
+export type { GrokChatModelProviderOptionsByName, GrokModelInputModalitiesByName, ResolveProviderOptions, ResolveInputModalities, GrokChatModel, GrokImageModel, } from './model-meta.js';
 export { GROK_CHAT_MODELS, GROK_IMAGE_MODELS } from './model-meta.js';
 export type { GrokTextMetadata, GrokImageMetadata, GrokAudioMetadata, GrokVideoMetadata, GrokDocumentMetadata, GrokMessageMetadataByModality, } from './message-types.js';

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

@@ -168,6 +168,8 @@ export declare const GROK_CHAT_MODELS: readonly ["grok-4-1-fast-reasoning", "gro
  * Grok Image Generation Models
  */
 export declare const GROK_IMAGE_MODELS: readonly ["grok-2-image-1212"];
+export type GrokChatModel = (typeof GROK_CHAT_MODELS)[number];
+export type GrokImageModel = (typeof GROK_IMAGE_MODELS)[number];
 /**
  * Type-only map from Grok chat model name to its supported input modalities.
  * Used for type inference when constructing multimodal messages.

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  }\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  },\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  },\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  },\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  },\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  },\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  },\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  },\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  },\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  },\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 */\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] as const\n\n/**\n * Grok Image Generation Models\n */\nexport const GROK_IMAGE_MODELS = [GROK_2_IMAGE.name] as const\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}\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 * 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":"AAyBA,MAAM,0BAA0B;AAAA,EAC9B,MAAM;AAgBR;AAEA,MAAM,8BAA8B;AAAA,EAClC,MAAM;AAgBR;AAEA,MAAM,mBAAmB;AAAA,EACvB,MAAM;AAgBR;AAEA,MAAM,wBAAwB;AAAA,EAC5B,MAAM;AAgBR;AAEA,MAAM,4BAA4B;AAAA,EAChC,MAAM;AAgBR;AAEA,MAAM,SAAS;AAAA,EACb,MAAM;AAgBR;AAEA,MAAM,cAAc;AAAA,EAClB,MAAM;AAgBR;AAEA,MAAM,SAAS;AAAA,EACb,MAAM;AAgBR;AAEA,MAAM,gBAAgB;AAAA,EACpB,MAAM;AAeR;AAEA,MAAM,eAAe;AAAA,EACnB,MAAM;AAaR;AAMO,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;AAChB;AAKO,MAAM,oBAAoB,CAAC,aAAa,IAAI;"}
+{"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  }\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  },\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  },\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  },\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  },\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  },\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  },\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  },\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  },\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  },\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 */\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] as const\n\n/**\n * Grok Image Generation Models\n */\nexport const GROK_IMAGE_MODELS = [GROK_2_IMAGE.name] as const\n\nexport type GrokChatModel = (typeof GROK_CHAT_MODELS)[number]\nexport type GrokImageModel = (typeof GROK_IMAGE_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}\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 * 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":"AAyBA,MAAM,0BAA0B;AAAA,EAC9B,MAAM;AAgBR;AAEA,MAAM,8BAA8B;AAAA,EAClC,MAAM;AAgBR;AAEA,MAAM,mBAAmB;AAAA,EACvB,MAAM;AAgBR;AAEA,MAAM,wBAAwB;AAAA,EAC5B,MAAM;AAgBR;AAEA,MAAM,4BAA4B;AAAA,EAChC,MAAM;AAgBR;AAEA,MAAM,SAAS;AAAA,EACb,MAAM;AAgBR;AAEA,MAAM,cAAc;AAAA,EAClB,MAAM;AAgBR;AAEA,MAAM,SAAS;AAAA,EACb,MAAM;AAgBR;AAEA,MAAM,gBAAgB;AAAA,EACpB,MAAM;AAeR;AAEA,MAAM,eAAe;AAAA,EACnB,MAAM;AAaR;AAMO,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;AAChB;AAKO,MAAM,oBAAoB,CAAC,aAAa,IAAI;"}

package/dist/esm/utils/client.d.ts

@@ -1,7 +1,6 @@
-import { default as OpenAI_SDK } from 'openai';
-export interface GrokClientConfig {
+import { default as OpenAI_SDK, ClientOptions } from 'openai';
+export interface GrokClientConfig extends ClientOptions {
     apiKey: string;
-    baseURL?: string;
 }
 /**
  * Creates a Grok SDK client instance using OpenAI SDK with xAI's base URL

package/dist/esm/utils/client.js

@@ -1,6 +1,7 @@
 import OpenAI_SDK from "openai";
 function createGrokClient(config) {
   return new OpenAI_SDK({
+    ...config,
     apiKey: config.apiKey,
     baseURL: config.baseURL || "https://api.x.ai/v1"
   });

package/dist/esm/utils/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sources":["../../../src/utils/client.ts"],"sourcesContent":["import OpenAI_SDK from 'openai'\n\nexport interface GrokClientConfig {\n  apiKey: string\n  baseURL?: string\n}\n\n/**\n * Creates a Grok SDK client instance using OpenAI SDK with xAI's base URL\n */\nexport function createGrokClient(config: GrokClientConfig): OpenAI_SDK {\n  return new OpenAI_SDK({\n    apiKey: config.apiKey,\n    baseURL: config.baseURL || 'https://api.x.ai/v1',\n  })\n}\n\n/**\n * Gets Grok API key from environment variables\n * @throws Error if XAI_API_KEY is not found\n */\nexport function getGrokApiKeyFromEnv(): string {\n  const env =\n    typeof globalThis !== 'undefined' && (globalThis as any).window?.env\n      ? (globalThis as any).window.env\n      : typeof process !== 'undefined'\n        ? process.env\n        : undefined\n  const key = env?.XAI_API_KEY\n\n  if (!key) {\n    throw new Error(\n      'XAI_API_KEY is required. Please set it in your environment variables or use the factory function with an explicit API key.',\n    )\n  }\n\n  return key\n}\n\n/**\n * Generates a unique ID with a prefix\n */\nexport function generateId(prefix: string): string {\n  return `${prefix}-${Date.now()}-${Math.random().toString(36).substring(7)}`\n}\n"],"names":[],"mappings":";AAUO,SAAS,iBAAiB,QAAsC;AACrE,SAAO,IAAI,WAAW;AAAA,IACpB,QAAQ,OAAO;AAAA,IACf,SAAS,OAAO,WAAW;AAAA,EAAA,CAC5B;AACH;AAMO,SAAS,uBAA+B;AAC7C,QAAM,MACJ,OAAO,eAAe,eAAgB,WAAmB,QAAQ,MAC5D,WAAmB,OAAO,MAC3B,OAAO,YAAY,cACjB,QAAQ,MACR;AACR,QAAM,MAAM,KAAK;AAEjB,MAAI,CAAC,KAAK;AACR,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AAEA,SAAO;AACT;AAKO,SAAS,WAAW,QAAwB;AACjD,SAAO,GAAG,MAAM,IAAI,KAAK,KAAK,IAAI,KAAK,OAAA,EAAS,SAAS,EAAE,EAAE,UAAU,CAAC,CAAC;AAC3E;"}
+{"version":3,"file":"client.js","sources":["../../../src/utils/client.ts"],"sourcesContent":["import OpenAI_SDK from 'openai'\nimport type { ClientOptions } from 'openai'\n\nexport interface GrokClientConfig extends ClientOptions {\n  apiKey: string\n}\n\n/**\n * Creates a Grok SDK client instance using OpenAI SDK with xAI's base URL\n */\nexport function createGrokClient(config: GrokClientConfig): OpenAI_SDK {\n  return new OpenAI_SDK({\n    ...config,\n    apiKey: config.apiKey,\n    baseURL: config.baseURL || 'https://api.x.ai/v1',\n  })\n}\n\n/**\n * Gets Grok API key from environment variables\n * @throws Error if XAI_API_KEY is not found\n */\nexport function getGrokApiKeyFromEnv(): string {\n  const env =\n    typeof globalThis !== 'undefined' && (globalThis as any).window?.env\n      ? (globalThis as any).window.env\n      : typeof process !== 'undefined'\n        ? process.env\n        : undefined\n  const key = env?.XAI_API_KEY\n\n  if (!key) {\n    throw new Error(\n      'XAI_API_KEY is required. Please set it in your environment variables or use the factory function with an explicit API key.',\n    )\n  }\n\n  return key\n}\n\n/**\n * Generates a unique ID with a prefix\n */\nexport function generateId(prefix: string): string {\n  return `${prefix}-${Date.now()}-${Math.random().toString(36).substring(7)}`\n}\n"],"names":[],"mappings":";AAUO,SAAS,iBAAiB,QAAsC;AACrE,SAAO,IAAI,WAAW;AAAA,IACpB,GAAG;AAAA,IACH,QAAQ,OAAO;AAAA,IACf,SAAS,OAAO,WAAW;AAAA,EAAA,CAC5B;AACH;AAMO,SAAS,uBAA+B;AAC7C,QAAM,MACJ,OAAO,eAAe,eAAgB,WAAmB,QAAQ,MAC5D,WAAmB,OAAO,MAC3B,OAAO,YAAY,cACjB,QAAQ,MACR;AACR,QAAM,MAAM,KAAK;AAEjB,MAAI,CAAC,KAAK;AACR,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AAEA,SAAO;AACT;AAKO,SAAS,WAAW,QAAwB;AACjD,SAAO,GAAG,MAAM,IAAI,KAAK,KAAK,IAAI,KAAK,OAAA,EAAS,SAAS,EAAE,EAAE,UAAU,CAAC,CAAC;AAC3E;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai-grok",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Grok (xAI) adapter for TanStack AI",
   "author": "",
   "license": "MIT",
@@ -38,7 +38,7 @@
   },
   "peerDependencies": {
     "zod": "^4.0.0",
-    "@tanstack/ai": "^0.4.0"
+    "@tanstack/ai": "^0.5.0"
   },
   "scripts": {
     "build": "vite build",

package/src/adapters/image.ts

@@ -5,7 +5,7 @@ import {
   validateNumberOfImages,
   validatePrompt,
 } from '../image/image-provider-options'
-import type { GROK_IMAGE_MODELS } from '../model-meta'
+import type { GrokImageModel } from '../model-meta'
 import type {
   GrokImageModelProviderOptionsByName,
   GrokImageModelSizeByName,
@@ -24,9 +24,6 @@ import type { GrokClientConfig } from '../utils'
  */
 export interface GrokImageConfig extends GrokClientConfig {}
 
-/** Model type for Grok Image */
-export type GrokImageModel = (typeof GROK_IMAGE_MODELS)[number]
-
 /**
  * Grok Image Generation Adapter
  *

package/src/index.ts

@@ -27,7 +27,6 @@ export {
   createGrokImage,
   grokImage,
   type GrokImageConfig,
-  type GrokImageModel,
 } from './adapters/image'
 export type {
   GrokImageProviderOptions,
@@ -43,6 +42,8 @@ export type {
   GrokModelInputModalitiesByName,
   ResolveProviderOptions,
   ResolveInputModalities,
+  GrokChatModel,
+  GrokImageModel,
 } from './model-meta'
 export { GROK_CHAT_MODELS, GROK_IMAGE_MODELS } from './model-meta'
 export type {

package/src/model-meta.ts

@@ -230,6 +230,9 @@ export const GROK_CHAT_MODELS = [
  */
 export const GROK_IMAGE_MODELS = [GROK_2_IMAGE.name] as const
 
+export type GrokChatModel = (typeof GROK_CHAT_MODELS)[number]
+export type GrokImageModel = (typeof GROK_IMAGE_MODELS)[number]
+
 /**
  * Type-only map from Grok chat model name to its supported input modalities.
  * Used for type inference when constructing multimodal messages.

package/src/utils/client.ts

@@ -1,8 +1,8 @@
 import OpenAI_SDK from 'openai'
+import type { ClientOptions } from 'openai'
 
-export interface GrokClientConfig {
+export interface GrokClientConfig extends ClientOptions {
   apiKey: string
-  baseURL?: string
 }
 
 /**
@@ -10,6 +10,7 @@ export interface GrokClientConfig {
  */
 export function createGrokClient(config: GrokClientConfig): OpenAI_SDK {
   return new OpenAI_SDK({
+    ...config,
     apiKey: config.apiKey,
     baseURL: config.baseURL || 'https://api.x.ai/v1',
   })