@tanstack/ai-grok 0.7.1 → 0.7.2

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

@@ -1,4 +1,3 @@
-import { FunctionTool } from '../tools/function-tool.js';
 /**
  * Grok Text Provider Options
  *
@@ -47,20 +46,7 @@ export interface GrokTextProviderOptions extends GrokBaseOptions {
      */
     stop?: string | Array<string>;
 }
-/**
- * Internal options interface for validation
- * Used internally by the adapter
- */
-export interface InternalTextProviderOptions extends GrokTextProviderOptions {
-    model: string;
-    stream?: boolean;
-    tools?: Array<FunctionTool>;
-}
 /**
  * External provider options (what users pass in)
  */
 export type ExternalTextProviderOptions = GrokTextProviderOptions;
-/**
- * Validates text provider options
- */
-export declare function validateTextProviderOptions(_options: InternalTextProviderOptions): void;

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

@@ -1,2 +1 @@
-export { convertFunctionToolToAdapterFormat, type FunctionTool, } from './function-tool.js';
-export { convertToolsToProviderFormat } from './tool-converter.js';
+export { type ChatCompletionFunctionTool as FunctionTool, convertFunctionToolToChatCompletionsFormat as convertFunctionToolToAdapterFormat, convertToolsToChatCompletionsFormat as convertToolsToProviderFormat, } from '@tanstack/openai-base';

package/dist/esm/tools/index.js

@@ -1,7 +1,6 @@
-import { convertFunctionToolToAdapterFormat } from "./function-tool.js";
-import { convertToolsToProviderFormat } from "./tool-converter.js";
+import { convertFunctionToolToChatCompletionsFormat, convertToolsToChatCompletionsFormat } from "@tanstack/openai-base";
 export {
-  convertFunctionToolToAdapterFormat,
-  convertToolsToProviderFormat
+  convertFunctionToolToChatCompletionsFormat as convertFunctionToolToAdapterFormat,
+  convertToolsToChatCompletionsFormat as convertToolsToProviderFormat
 };
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

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

@@ -1,17 +1,13 @@
-import { default as OpenAI_SDK, ClientOptions } from 'openai';
-export interface GrokClientConfig extends ClientOptions {
-    apiKey: string;
+import { OpenAICompatibleClientConfig } from '@tanstack/openai-base';
+export interface GrokClientConfig extends OpenAICompatibleClientConfig {
 }
-/**
- * Creates a Grok SDK client instance using OpenAI SDK with xAI's base URL
- */
-export declare function createGrokClient(config: GrokClientConfig): OpenAI_SDK;
 /**
  * Gets Grok API key from environment variables
  * @throws Error if XAI_API_KEY is not found
  */
 export declare function getGrokApiKeyFromEnv(): string;
 /**
- * Generates a unique ID with a prefix
+ * Returns a Grok client config with the default xAI base URL applied
+ * when not already set.
  */
-export declare function generateId(prefix: string): string;
+export declare function withGrokDefaults(config: GrokClientConfig): OpenAICompatibleClientConfig;

package/dist/esm/utils/client.js

@@ -1,27 +1,21 @@
-import OpenAI_SDK from "openai";
-function createGrokClient(config) {
-  return new OpenAI_SDK({
-    ...config,
-    apiKey: config.apiKey,
-    baseURL: config.baseURL || "https://api.x.ai/v1"
-  });
-}
+import { getApiKeyFromEnv } from "@tanstack/ai-utils";
 function getGrokApiKeyFromEnv() {
-  const env = typeof globalThis !== "undefined" && globalThis.window?.env ? globalThis.window.env : typeof process !== "undefined" ? process.env : void 0;
-  const key = env?.XAI_API_KEY;
-  if (!key) {
+  try {
+    return getApiKeyFromEnv("XAI_API_KEY");
+  } catch {
     throw new Error(
       "XAI_API_KEY is required. Please set it in your environment variables or use the factory function with an explicit API key."
     );
   }
-  return key;
 }
-function generateId(prefix) {
-  return `${prefix}-${Date.now()}-${Math.random().toString(36).substring(7)}`;
+function withGrokDefaults(config) {
+  return {
+    ...config,
+    baseURL: config.baseURL || "https://api.x.ai/v1"
+  };
 }
 export {
-  createGrokClient,
-  generateId,
-  getGrokApiKeyFromEnv
+  getGrokApiKeyFromEnv,
+  withGrokDefaults
 };
 //# sourceMappingURL=client.js.map

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'\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;"}
+{"version":3,"file":"client.js","sources":["../../../src/utils/client.ts"],"sourcesContent":["import { getApiKeyFromEnv } from '@tanstack/ai-utils'\nimport type { OpenAICompatibleClientConfig } from '@tanstack/openai-base'\n\nexport interface GrokClientConfig extends OpenAICompatibleClientConfig {}\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  try {\n    return getApiKeyFromEnv('XAI_API_KEY')\n  } catch {\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\n/**\n * Returns a Grok client config with the default xAI base URL applied\n * when not already set.\n */\nexport function withGrokDefaults(\n  config: GrokClientConfig,\n): OpenAICompatibleClientConfig {\n  return {\n    ...config,\n    baseURL: config.baseURL || 'https://api.x.ai/v1',\n  }\n}\n"],"names":[],"mappings":";AASO,SAAS,uBAA+B;AAC7C,MAAI;AACF,WAAO,iBAAiB,aAAa;AAAA,EACvC,QAAQ;AACN,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AACF;AAMO,SAAS,iBACd,QAC8B;AAC9B,SAAO;AAAA,IACL,GAAG;AAAA,IACH,SAAS,OAAO,WAAW;AAAA,EAAA;AAE/B;"}

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

@@ -1,3 +1,4 @@
-export { createGrokClient, getGrokApiKeyFromEnv, generateId, type GrokClientConfig, } from './client.js';
+export { generateId } from '@tanstack/ai-utils';
+export { getGrokApiKeyFromEnv, withGrokDefaults, type GrokClientConfig, } from './client.js';
 export { makeGrokStructuredOutputCompatible, transformNullsToUndefined, } from './schema-converter.js';
 export { toAudioFile, arrayBufferToBase64 } from './audio.js';

package/dist/esm/utils/schema-converter.d.ts

@@ -1,24 +1,2 @@
-/**
- * Recursively transform null values to undefined in an object.
- *
- * This is needed because Grok's structured output (via OpenAI-compatible API) requires all fields to be
- * in the `required` array, with optional fields made nullable (type: ["string", "null"]).
- * When Grok returns null for optional fields, we need to convert them back to
- * undefined to match the original Zod schema expectations.
- *
- * @param obj - Object to transform
- * @returns Object with nulls converted to undefined
- */
-export declare function transformNullsToUndefined<T>(obj: T): T;
-/**
- * Transform a JSON schema to be compatible with Grok's structured output requirements (OpenAI-compatible).
- * Grok requires:
- * - All properties must be in the `required` array
- * - Optional fields should have null added to their type union
- * - additionalProperties must be false for objects
- *
- * @param schema - JSON schema to transform
- * @param originalRequired - Original required array (to know which fields were optional)
- * @returns Transformed schema compatible with Grok structured output
- */
-export declare function makeGrokStructuredOutputCompatible(schema: Record<string, any>, originalRequired?: Array<string>): Record<string, any>;
+export { transformNullsToUndefined } from '@tanstack/ai-utils';
+export { makeStructuredOutputCompatible as makeGrokStructuredOutputCompatible } from '@tanstack/openai-base';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai-grok",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "Grok (xAI) adapter for TanStack AI",
   "author": "",
   "license": "MIT",
@@ -34,14 +34,14 @@
     "adapter"
   ],
   "dependencies": {
-    "openai": "^6.9.1"
+    "@tanstack/ai-utils": "0.2.0",
+    "@tanstack/openai-base": "0.2.0"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "4.0.14",
     "vite": "^7.2.7",
-    "zod": "^4.2.0",
-    "@tanstack/ai-client": "0.9.0",
-    "@tanstack/ai": "0.15.0"
+    "@tanstack/ai": "0.15.0",
+    "@tanstack/ai-client": "0.9.0"
   },
   "peerDependencies": {
     "zod": "^4.0.0",

package/src/adapters/image.ts

@@ -1,5 +1,5 @@
-import { BaseImageAdapter } from '@tanstack/ai/adapters'
-import { createGrokClient, generateId, getGrokApiKeyFromEnv } from '../utils'
+import { OpenAICompatibleImageAdapter } from '@tanstack/openai-base'
+import { getGrokApiKeyFromEnv, withGrokDefaults } from '../utils/client'
 import {
   validateImageSize,
   validateNumberOfImages,
@@ -11,12 +11,6 @@ import type {
   GrokImageModelSizeByName,
   GrokImageProviderOptions,
 } from '../image/image-provider-options'
-import type {
-  GeneratedImage,
-  ImageGenerationOptions,
-  ImageGenerationResult,
-} from '@tanstack/ai'
-import type OpenAI_SDK from 'openai'
 import type { GrokClientConfig } from '../utils'
 
 /**
@@ -37,7 +31,7 @@ export interface GrokImageConfig extends GrokClientConfig {}
  */
 export class GrokImageAdapter<
   TModel extends GrokImageModel,
-> extends BaseImageAdapter<
+> extends OpenAICompatibleImageAdapter<
   TModel,
   GrokImageProviderOptions,
   GrokImageModelProviderOptionsByName,
@@ -46,92 +40,29 @@ export class GrokImageAdapter<
   readonly kind = 'image' as const
   readonly name = 'grok' as const
 
-  private client: OpenAI_SDK
-
   constructor(config: GrokImageConfig, model: TModel) {
-    super(model, {})
-    this.client = createGrokClient(config)
+    super(withGrokDefaults(config), model, 'grok')
   }
 
-  async generateImages(
-    options: ImageGenerationOptions<GrokImageProviderOptions>,
-  ): Promise<ImageGenerationResult> {
-    const { model, prompt, numberOfImages, size, logger } = options
-
-    logger.request(`activity=generateImage provider=grok model=${this.model}`, {
-      provider: 'grok',
-      model: this.model,
-    })
-
-    try {
-      // Validate inputs
-      validatePrompt({ prompt, model })
-      validateImageSize(model, size)
-      validateNumberOfImages(model, numberOfImages)
-
-      // Build request based on model type
-      const request = this.buildRequest(options)
-
-      const response = await this.client.images.generate({
-        ...request,
-        stream: false,
-      })
-
-      return this.transformResponse(model, response)
-    } catch (error) {
-      logger.errors('grok.generateImage fatal', {
-        error,
-        source: 'grok.generateImage',
-      })
-      throw error
-    }
+  protected override validatePrompt(options: {
+    prompt: string
+    model: string
+  }): void {
+    validatePrompt(options)
   }
 
-  private buildRequest(
-    options: ImageGenerationOptions<GrokImageProviderOptions>,
-  ): OpenAI_SDK.Images.ImageGenerateParams {
-    const { model, prompt, numberOfImages, size, modelOptions } = options
-
-    // Spread modelOptions FIRST so explicit args (model, prompt, n, size) win
-    // and user-supplied modelOptions cannot silently override them.
-    return {
-      ...modelOptions,
-      model,
-      prompt,
-      n: numberOfImages ?? 1,
-      size: size as OpenAI_SDK.Images.ImageGenerateParams['size'],
-    }
+  protected override validateImageSize(
+    model: string,
+    size: string | undefined,
+  ): void {
+    validateImageSize(model, size)
   }
 
-  private transformResponse(
+  protected override validateNumberOfImages(
     model: string,
-    response: OpenAI_SDK.Images.ImagesResponse,
-  ): ImageGenerationResult {
-    const images: Array<GeneratedImage> = (response.data ?? []).flatMap(
-      (item): Array<GeneratedImage> => {
-        const revisedPrompt = item.revised_prompt
-        if (item.b64_json) {
-          return [{ b64Json: item.b64_json, revisedPrompt }]
-        }
-        if (item.url) {
-          return [{ url: item.url, revisedPrompt }]
-        }
-        return []
-      },
-    )
-
-    return {
-      id: generateId(this.name),
-      model,
-      images,
-      usage: response.usage
-        ? {
-            inputTokens: response.usage.input_tokens,
-            outputTokens: response.usage.output_tokens,
-            totalTokens: response.usage.total_tokens,
-          }
-        : undefined,
-    }
+    numberOfImages: number | undefined,
+  ): void {
+    validateNumberOfImages(model, numberOfImages)
   }
 }
 

package/src/adapters/summarize.ts

@@ -1,12 +1,8 @@
-import { BaseSummarizeAdapter } from '@tanstack/ai/adapters'
+import { OpenAICompatibleSummarizeAdapter } from '@tanstack/openai-base'
 import { getGrokApiKeyFromEnv } from '../utils'
 import { GrokTextAdapter } from './text'
+import type { ChatStreamCapable } from '@tanstack/openai-base'
 import type { GROK_CHAT_MODELS } from '../model-meta'
-import type {
-  StreamChunk,
-  SummarizationOptions,
-  SummarizationResult,
-} from '@tanstack/ai'
 import type { GrokClientConfig } from '../utils'
 
 /**
@@ -35,125 +31,24 @@ export type GrokSummarizeModel = (typeof GROK_CHAT_MODELS)[number]
  */
 export class GrokSummarizeAdapter<
   TModel extends GrokSummarizeModel,
-> extends BaseSummarizeAdapter<TModel, GrokSummarizeProviderOptions> {
+> extends OpenAICompatibleSummarizeAdapter<
+  TModel,
+  GrokSummarizeProviderOptions
+> {
   readonly kind = 'summarize' as const
   readonly name = 'grok' as const
 
-  private textAdapter: GrokTextAdapter<TModel>
-
   constructor(config: GrokSummarizeConfig, model: TModel) {
-    super({}, model)
-    this.textAdapter = new GrokTextAdapter(config, model)
-  }
-
-  async summarize(options: SummarizationOptions): Promise<SummarizationResult> {
-    const { logger } = options
-    const systemPrompt = this.buildSummarizationPrompt(options)
-
-    logger.request(`activity=summarize provider=grok`, {
-      provider: 'grok',
-      model: options.model,
-    })
-
-    // Use the text adapter's streaming and collect the result
-    let summary = ''
-    const id = ''
-    let model = options.model
-    let usage = { promptTokens: 0, completionTokens: 0, totalTokens: 0 }
-
-    try {
-      for await (const chunk of this.textAdapter.chatStream({
-        model: options.model,
-        messages: [{ role: 'user', content: options.text }],
-        systemPrompts: [systemPrompt],
-        maxTokens: options.maxLength,
-        temperature: 0.3,
-        logger,
-      })) {
-        // AG-UI TEXT_MESSAGE_CONTENT event
-        if (chunk.type === 'TEXT_MESSAGE_CONTENT') {
-          if (chunk.content) {
-            summary = chunk.content
-          } else {
-            summary += chunk.delta
-          }
-          model = chunk.model || model
-        }
-        // AG-UI RUN_FINISHED event
-        if (chunk.type === 'RUN_FINISHED') {
-          if (chunk.usage) {
-            usage = chunk.usage
-          }
-        }
-      }
-    } catch (error) {
-      logger.errors('grok.summarize fatal', {
-        error,
-        source: 'grok.summarize',
-      })
-      throw error
-    }
-
-    return { id, model, summary, usage }
-  }
-
-  async *summarizeStream(
-    options: SummarizationOptions,
-  ): AsyncIterable<StreamChunk> {
-    const { logger } = options
-    const systemPrompt = this.buildSummarizationPrompt(options)
-
-    logger.request(`activity=summarize provider=grok`, {
-      provider: 'grok',
-      model: options.model,
-      stream: true,
-    })
-
-    try {
-      // Delegate directly to the text adapter's streaming
-      yield* this.textAdapter.chatStream({
-        model: options.model,
-        messages: [{ role: 'user', content: options.text }],
-        systemPrompts: [systemPrompt],
-        maxTokens: options.maxLength,
-        temperature: 0.3,
-        logger,
-      })
-    } catch (error) {
-      logger.errors('grok.summarize fatal', {
-        error,
-        source: 'grok.summarize',
-      })
-      throw error
-    }
-  }
-
-  private buildSummarizationPrompt(options: SummarizationOptions): string {
-    let prompt = 'You are a professional summarizer. '
-
-    switch (options.style) {
-      case 'bullet-points':
-        prompt += 'Provide a summary in bullet point format. '
-        break
-      case 'paragraph':
-        prompt += 'Provide a summary in paragraph format. '
-        break
-      case 'concise':
-        prompt += 'Provide a very concise summary in 1-2 sentences. '
-        break
-      default:
-        prompt += 'Provide a clear and concise summary. '
-    }
-
-    if (options.focus && options.focus.length > 0) {
-      prompt += `Focus on the following aspects: ${options.focus.join(', ')}. `
-    }
-
-    if (options.maxLength) {
-      prompt += `Keep the summary under ${options.maxLength} tokens. `
-    }
-
-    return prompt
+    // The text adapter accepts richer provider options than the summarize adapter needs,
+    // but we only pass basic options (model, messages, systemPrompts, etc.) at call time.
+    super(
+      new GrokTextAdapter(
+        config,
+        model,
+      ) as unknown as ChatStreamCapable<GrokSummarizeProviderOptions>,
+      model,
+      'grok',
+    )
   }
 }