@tanstack/ai-grok 0.14.2 → 0.14.3

package/dist/esm/message-types.d.ts

@@ -1,64 +0,0 @@
-/**
- * Grok-specific metadata types for multimodal content parts.
- * These types extend the base ContentPart metadata with Grok-specific options.
- *
- * Grok uses an OpenAI-compatible API, so metadata types are similar to OpenAI.
- *
- * @see https://docs.x.ai
- */
-/**
- * Metadata for Grok image content parts.
- * Controls how the model processes and analyzes images.
- */
-export interface GrokImageMetadata {
-    /**
-     * Controls how the model processes the image.
-     * - 'auto': Let the model decide based on image size and content
-     * - 'low': Use low resolution processing (faster, cheaper, less detail)
-     * - 'high': Use high resolution processing (slower, more expensive, more detail)
-     *
-     * @default 'auto'
-     */
-    detail?: 'auto' | 'low' | 'high';
-}
-/**
- * Metadata for Grok audio content parts.
- * Specifies the audio format for proper processing.
- */
-export interface GrokAudioMetadata {
-    /**
-     * The format of the audio.
-     * Supported formats: mp3, wav, flac, etc.
-     * @default 'mp3'
-     */
-    format?: 'mp3' | 'wav' | 'flac' | 'ogg' | 'webm' | 'aac';
-}
-/**
- * Metadata for Grok video content parts.
- * Note: Video support in Grok is limited; check current API capabilities.
- */
-export interface GrokVideoMetadata {
-}
-/**
- * Metadata for Grok document content parts.
- * Note: Direct document support may vary; PDFs often need to be converted to images.
- */
-export interface GrokDocumentMetadata {
-}
-/**
- * Metadata for Grok text content parts.
- * Currently no specific metadata options for text in Grok.
- */
-export interface GrokTextMetadata {
-}
-/**
- * Map of modality types to their Grok-specific metadata types.
- * Used for type inference when constructing multimodal messages.
- */
-export interface GrokMessageMetadataByModality {
-    text: GrokTextMetadata;
-    image: GrokImageMetadata;
-    audio: GrokAudioMetadata;
-    video: GrokVideoMetadata;
-    document: GrokDocumentMetadata;
-}

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

@@ -1,99 +0,0 @@
-import { GrokBuildProviderOptions, GrokTextProviderOptions } from './text/text-provider-options.js';
-export type GrokProviderToolKind = 'web_search' | 'x_search' | 'file_search' | 'mcp';
-declare const GROK_4_3: {
-    readonly name: "grok-4.3";
-    readonly context_window: 1000000;
-    readonly supports: {
-        readonly input: ["text", "image"];
-        readonly output: ["text"];
-        readonly capabilities: ["reasoning", "structured_outputs", "tool_calling"];
-        readonly tools: readonly ["web_search", "x_search", "file_search", "mcp"];
-    };
-    readonly pricing: {
-        readonly input: {
-            readonly normal: 1.25;
-            readonly cached: 0.2;
-        };
-        readonly output: {
-            readonly normal: 2.5;
-        };
-    };
-};
-declare const GROK_BUILD_0_1: {
-    readonly name: "grok-build-0.1";
-    readonly context_window: 256000;
-    readonly supports: {
-        readonly input: ["text", "image"];
-        readonly output: ["text"];
-        readonly capabilities: ["reasoning", "structured_outputs", "tool_calling"];
-        readonly tools: readonly ["web_search", "x_search", "file_search", "mcp"];
-    };
-    readonly pricing: {
-        readonly input: {
-            readonly normal: 1;
-            readonly cached: 0.2;
-        };
-        readonly output: {
-            readonly normal: 2;
-        };
-    };
-};
-/**
- * Grok chat models supported by the Responses adapter.
- */
-export declare const GROK_CHAT_MODELS: readonly ["grok-build-0.1", "grok-4.3"];
-/**
- * Grok Image Generation Models
- */
-export declare const GROK_IMAGE_MODELS: readonly ["grok-2-image-1212", "grok-imagine-image", "grok-imagine-image-quality"];
-/**
- * Grok Video Generation Models (xAI Imagine API)
- *
- * @experimental Video generation is an experimental feature and may change.
- */
-export declare const GROK_VIDEO_MODELS: readonly ["grok-imagine-video", "grok-imagine-video-1.5"];
-export declare const GROK_TTS_MODELS: readonly ["grok-tts"];
-export declare const GROK_TRANSCRIPTION_MODELS: readonly ["grok-stt"];
-export declare const GROK_REALTIME_MODELS: readonly ["grok-voice-fast-1.0", "grok-voice-think-fast-1.0"];
-export type GrokChatModel = (typeof GROK_CHAT_MODELS)[number];
-export type GrokImageModel = (typeof GROK_IMAGE_MODELS)[number];
-export type GrokVideoModel = (typeof GROK_VIDEO_MODELS)[number];
-export type GrokTTSModel = (typeof GROK_TTS_MODELS)[number];
-export type GrokTranscriptionModel = (typeof GROK_TRANSCRIPTION_MODELS)[number];
-export type GrokRealtimeModel = (typeof GROK_REALTIME_MODELS)[number];
-/**
- * Type-only map from Grok chat model name to its supported input modalities.
- * Used for type inference when constructing multimodal messages.
- */
-export type GrokModelInputModalitiesByName = {
-    [GROK_4_3.name]: typeof GROK_4_3.supports.input;
-    [GROK_BUILD_0_1.name]: typeof GROK_BUILD_0_1.supports.input;
-};
-/**
- * Type-only map from Grok chat model name to its supported provider tools.
- * Keeps Grok provider-tool factories type-checked against the models that
- * advertise xAI Responses server-side tools.
- */
-export type GrokChatModelToolCapabilitiesByName = {
-    [GROK_4_3.name]: typeof GROK_4_3.supports.tools;
-    [GROK_BUILD_0_1.name]: typeof GROK_BUILD_0_1.supports.tools;
-};
-export type GrokProviderOptions = GrokTextProviderOptions;
-/**
- * Type-only map from Grok chat model name to its provider options type.
- */
-export type GrokChatModelProviderOptionsByName = {
-    [GROK_4_3.name]: GrokProviderOptions;
-    [GROK_BUILD_0_1.name]: GrokBuildProviderOptions;
-};
-/**
- * Resolve provider options for a specific model.
- * If the model has explicit options in the map, use those; otherwise use base options.
- */
-export type ResolveProviderOptions<TModel extends string> = TModel extends keyof GrokChatModelProviderOptionsByName ? GrokChatModelProviderOptionsByName[TModel] : GrokProviderOptions;
-/**
- * Resolve input modalities for a specific model.
- * If the model has explicit modalities in the map, use those; otherwise use text only.
- */
-export type ResolveInputModalities<TModel extends string> = TModel extends keyof GrokModelInputModalitiesByName ? GrokModelInputModalitiesByName[TModel] : readonly ['text'];
-export {};

package/dist/esm/model-meta.js

@@ -1,58 +0,0 @@
-const GROK_2_IMAGE = {
-  name: "grok-2-image-1212"
-};
-const GROK_IMAGINE_IMAGE = {
-  name: "grok-imagine-image"
-};
-const GROK_IMAGINE_IMAGE_QUALITY = {
-  name: "grok-imagine-image-quality"
-};
-const GROK_IMAGINE_VIDEO = {
-  name: "grok-imagine-video"
-};
-const GROK_IMAGINE_VIDEO_1_5 = {
-  name: "grok-imagine-video-1.5"
-};
-const GROK_4_3 = {
-  name: "grok-4.3"
-};
-const GROK_BUILD_0_1 = {
-  name: "grok-build-0.1"
-};
-const GROK_CHAT_MODELS = [GROK_BUILD_0_1.name, GROK_4_3.name];
-const GROK_IMAGE_MODELS = [
-  GROK_2_IMAGE.name,
-  GROK_IMAGINE_IMAGE.name,
-  GROK_IMAGINE_IMAGE_QUALITY.name
-];
-const GROK_VIDEO_MODELS = [
-  GROK_IMAGINE_VIDEO.name,
-  GROK_IMAGINE_VIDEO_1_5.name
-];
-const GROK_TTS = {
-  name: "grok-tts"
-};
-const GROK_STT = {
-  name: "grok-stt"
-};
-const GROK_VOICE_FAST_1 = {
-  name: "grok-voice-fast-1.0"
-};
-const GROK_VOICE_THINK_FAST_1 = {
-  name: "grok-voice-think-fast-1.0"
-};
-const GROK_TTS_MODELS = [GROK_TTS.name];
-const GROK_TRANSCRIPTION_MODELS = [GROK_STT.name];
-const GROK_REALTIME_MODELS = [
-  GROK_VOICE_FAST_1.name,
-  GROK_VOICE_THINK_FAST_1.name
-];
-export {
-  GROK_CHAT_MODELS,
-  GROK_IMAGE_MODELS,
-  GROK_REALTIME_MODELS,
-  GROK_TRANSCRIPTION_MODELS,
-  GROK_TTS_MODELS,
-  GROK_VIDEO_MODELS
-};
-//# sourceMappingURL=model-meta.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"model-meta.js","sources":["../../src/model-meta.ts"],"sourcesContent":["/**\n * Model metadata interface for documentation and type inference\n */\nimport type {\n  GrokBuildProviderOptions,\n  GrokTextProviderOptions,\n} from './text/text-provider-options'\n\ninterface ModelMeta {\n  name: string\n  supports: {\n    input: Array<'text' | 'image' | 'audio' | 'video' | 'document'>\n    output: Array<'text' | 'image' | 'audio' | 'video'>\n    capabilities?: Array<'reasoning' | 'tool_calling' | 'structured_outputs'>\n    tools?: ReadonlyArray<GrokProviderToolKind>\n  }\n  max_input_tokens?: number\n  max_output_tokens?: number\n  context_window?: number\n  knowledge_cutoff?: string\n  pricing?: {\n    input: {\n      normal: number\n      cached?: number\n    }\n    output: {\n      normal: number\n    }\n  }\n}\n\nexport type GrokProviderToolKind =\n  | 'web_search'\n  | 'x_search'\n  | 'file_search'\n  | 'mcp'\n\nconst GROK_RESPONSES_TOOLS = [\n  'web_search',\n  'x_search',\n  'file_search',\n  'mcp',\n] as const satisfies ReadonlyArray<GrokProviderToolKind>\n\nconst GROK_2_IMAGE = {\n  name: 'grok-2-image-1212',\n  supports: {\n    input: ['text'],\n    output: ['image'],\n  },\n  pricing: {\n    input: {\n      normal: 0.07,\n    },\n    output: {\n      normal: 0.07,\n    },\n  },\n} as const satisfies ModelMeta\n\n// Imagine API image models. Pricing is per generated image (output only).\nconst GROK_IMAGINE_IMAGE = {\n  name: 'grok-imagine-image',\n  supports: {\n    input: ['text', 'image'],\n    output: ['image'],\n  },\n  pricing: {\n    input: {\n      normal: 0,\n    },\n    output: {\n      normal: 0.02,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_IMAGINE_IMAGE_QUALITY = {\n  name: 'grok-imagine-image-quality',\n  supports: {\n    input: ['text', 'image'],\n    output: ['image'],\n  },\n  pricing: {\n    input: {\n      normal: 0,\n    },\n    output: {\n      normal: 0.05,\n    },\n  },\n} as const satisfies ModelMeta\n\n// Imagine API video models. Pricing is per second of generated video\n// (output only); generated videos carry an audio track.\n//\n// grok-imagine-video (v1.0) supports both text-to-video (a starting image is\n// optional) and image-to-video. grok-imagine-video-1.5 is image-to-video\n// only: a starting-frame image is required (the text prompt describes the\n// desired motion) — its text-to-video is rejected by the API.\nconst GROK_IMAGINE_VIDEO = {\n  name: 'grok-imagine-video',\n  supports: {\n    input: ['text', 'image'],\n    output: ['video', 'audio'],\n  },\n  pricing: {\n    input: {\n      normal: 0,\n    },\n    output: {\n      // per second of video\n      normal: 0.05,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_IMAGINE_VIDEO_1_5 = {\n  name: 'grok-imagine-video-1.5',\n  supports: {\n    input: ['text', 'image'],\n    output: ['video', 'audio'],\n  },\n  pricing: {\n    input: {\n      normal: 0,\n    },\n    output: {\n      // per second of video\n      normal: 0.08,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_4_3 = {\n  name: 'grok-4.3',\n  context_window: 1_000_000,\n  supports: {\n    input: ['text', 'image'],\n    output: ['text'],\n    capabilities: ['reasoning', 'structured_outputs', 'tool_calling'],\n    tools: GROK_RESPONSES_TOOLS,\n  },\n  pricing: {\n    input: {\n      normal: 1.25,\n      cached: 0.2,\n    },\n    output: {\n      normal: 2.5,\n    },\n  },\n} as const satisfies ModelMeta\n\nconst GROK_BUILD_0_1 = {\n  name: 'grok-build-0.1',\n  context_window: 256_000,\n  supports: {\n    input: ['text', 'image'],\n    output: ['text'],\n    capabilities: ['reasoning', 'structured_outputs', 'tool_calling'],\n    tools: GROK_RESPONSES_TOOLS,\n  },\n  pricing: {\n    input: {\n      normal: 1,\n      cached: 0.2,\n    },\n    output: {\n      normal: 2,\n    },\n  },\n} as const satisfies ModelMeta\n\n/**\n * Grok chat models supported by the Responses adapter.\n */\nexport const GROK_CHAT_MODELS = [GROK_BUILD_0_1.name, GROK_4_3.name] as const\n\n/**\n * Grok Image Generation Models\n */\nexport const GROK_IMAGE_MODELS = [\n  GROK_2_IMAGE.name,\n  GROK_IMAGINE_IMAGE.name,\n  GROK_IMAGINE_IMAGE_QUALITY.name,\n] as const\n\n/**\n * Grok Video Generation Models (xAI Imagine API)\n *\n * @experimental Video generation is an experimental feature and may change.\n */\nexport const GROK_VIDEO_MODELS = [\n  GROK_IMAGINE_VIDEO.name,\n  GROK_IMAGINE_VIDEO_1_5.name,\n] as const\n\n// xAI's `/v1/tts` endpoint is endpoint-addressed and does not take a `model`\n// parameter. This synthetic identifier satisfies the SDK's `TTSOptions.model`\n// contract and provides a stable value for logging and fixture matching.\nconst GROK_TTS = {\n  name: 'grok-tts',\n  supports: {\n    input: ['text'],\n    output: ['audio'],\n  },\n} as const satisfies ModelMeta\n\n// xAI's `/v1/stt` endpoint is endpoint-addressed and does not take a `model`\n// parameter. This synthetic identifier satisfies the SDK's\n// `TranscriptionOptions.model` contract.\nconst GROK_STT = {\n  name: 'grok-stt',\n  supports: {\n    input: ['audio'],\n    output: ['text'],\n  },\n} as const satisfies ModelMeta\n\nconst GROK_VOICE_FAST_1 = {\n  name: 'grok-voice-fast-1.0',\n  supports: {\n    input: ['audio', 'text'],\n    output: ['audio', 'text'],\n    capabilities: ['tool_calling'],\n    tools: [] as const,\n  },\n} as const satisfies ModelMeta\n\nconst GROK_VOICE_THINK_FAST_1 = {\n  name: 'grok-voice-think-fast-1.0',\n  supports: {\n    input: ['audio', 'text'],\n    output: ['audio', 'text'],\n    capabilities: ['reasoning', 'tool_calling'],\n    tools: [] as const,\n  },\n} as const satisfies ModelMeta\n\nexport const GROK_TTS_MODELS = [GROK_TTS.name] as const\n\nexport const GROK_TRANSCRIPTION_MODELS = [GROK_STT.name] as const\n\nexport const GROK_REALTIME_MODELS = [\n  GROK_VOICE_FAST_1.name,\n  GROK_VOICE_THINK_FAST_1.name,\n] as const\n\nexport type GrokChatModel = (typeof GROK_CHAT_MODELS)[number]\nexport type GrokImageModel = (typeof GROK_IMAGE_MODELS)[number]\nexport type GrokVideoModel = (typeof GROK_VIDEO_MODELS)[number]\nexport type GrokTTSModel = (typeof GROK_TTS_MODELS)[number]\nexport type GrokTranscriptionModel = (typeof GROK_TRANSCRIPTION_MODELS)[number]\nexport type GrokRealtimeModel = (typeof GROK_REALTIME_MODELS)[number]\n\n/**\n * Type-only map from Grok chat model name to its supported input modalities.\n * Used for type inference when constructing multimodal messages.\n */\nexport type GrokModelInputModalitiesByName = {\n  [GROK_4_3.name]: typeof GROK_4_3.supports.input\n  [GROK_BUILD_0_1.name]: typeof GROK_BUILD_0_1.supports.input\n}\n\n/**\n * Type-only map from Grok chat model name to its supported provider tools.\n * Keeps Grok provider-tool factories type-checked against the models that\n * advertise xAI Responses server-side tools.\n */\nexport type GrokChatModelToolCapabilitiesByName = {\n  [GROK_4_3.name]: typeof GROK_4_3.supports.tools\n  [GROK_BUILD_0_1.name]: typeof GROK_BUILD_0_1.supports.tools\n}\n\nexport type GrokProviderOptions = GrokTextProviderOptions\n\n/**\n * Type-only map from Grok chat model name to its provider options type.\n */\nexport type GrokChatModelProviderOptionsByName = {\n  [GROK_4_3.name]: GrokProviderOptions\n  [GROK_BUILD_0_1.name]: GrokBuildProviderOptions\n}\n\n// ===========================\n// Type Resolution Helpers\n// ===========================\n\n/**\n * Resolve provider options for a specific model.\n * If the model has explicit options in the map, use those; otherwise use base options.\n */\nexport type ResolveProviderOptions<TModel extends string> =\n  TModel extends keyof GrokChatModelProviderOptionsByName\n    ? GrokChatModelProviderOptionsByName[TModel]\n    : GrokProviderOptions\n\n/**\n * Resolve input modalities for a specific model.\n * If the model has explicit modalities in the map, use those; otherwise use text only.\n */\nexport type ResolveInputModalities<TModel extends string> =\n  TModel extends keyof GrokModelInputModalitiesByName\n    ? GrokModelInputModalitiesByName[TModel]\n    : readonly ['text']\n"],"names":[],"mappings":"AA4CA,MAAM,eAAe;AAAA,EACnB,MAAM;AAaR;AAGA,MAAM,qBAAqB;AAAA,EACzB,MAAM;AAaR;AAEA,MAAM,6BAA6B;AAAA,EACjC,MAAM;AAaR;AASA,MAAM,qBAAqB;AAAA,EACzB,MAAM;AAcR;AAEA,MAAM,yBAAyB;AAAA,EAC7B,MAAM;AAcR;AAEA,MAAM,WAAW;AAAA,EACf,MAAM;AAiBR;AAEA,MAAM,iBAAiB;AAAA,EACrB,MAAM;AAiBR;AAKO,MAAM,mBAAmB,CAAC,eAAe,MAAM,SAAS,IAAI;AAK5D,MAAM,oBAAoB;AAAA,EAC/B,aAAa;AAAA,EACb,mBAAmB;AAAA,EACnB,2BAA2B;AAC7B;AAOO,MAAM,oBAAoB;AAAA,EAC/B,mBAAmB;AAAA,EACnB,uBAAuB;AACzB;AAKA,MAAM,WAAW;AAAA,EACf,MAAM;AAKR;AAKA,MAAM,WAAW;AAAA,EACf,MAAM;AAKR;AAEA,MAAM,oBAAoB;AAAA,EACxB,MAAM;AAOR;AAEA,MAAM,0BAA0B;AAAA,EAC9B,MAAM;AAOR;AAEO,MAAM,kBAAkB,CAAC,SAAS,IAAI;AAEtC,MAAM,4BAA4B,CAAC,SAAS,IAAI;AAEhD,MAAM,uBAAuB;AAAA,EAClC,kBAAkB;AAAA,EAClB,wBAAwB;AAC1B;"}

package/dist/esm/realtime/adapter.d.ts

@@ -1,21 +0,0 @@
-import { RealtimeAdapter } from '@tanstack/ai';
-import { GrokRealtimeOptions } from './types.js';
-/**
- * Creates a Grok realtime adapter for client-side use.
- *
- * Uses WebRTC for browser connections (default). Mirrors the OpenAI realtime
- * adapter because xAI's Voice Agent API is OpenAI-realtime-compatible — the
- * only differences are the endpoint URL and default model.
- *
- * @example
- * ```typescript
- * import { RealtimeClient } from '@tanstack/ai-client'
- * import { grokRealtime } from '@tanstack/ai-grok'
- *
- * const client = new RealtimeClient({
- *   getToken: () => fetch('/api/realtime-token').then(r => r.json()),
- *   adapter: grokRealtime(),
- * })
- * ```
- */
-export declare function grokRealtime(options?: GrokRealtimeOptions): RealtimeAdapter;