@ai-sdk/xai 3.0.32 → 3.0.34

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/xai",
-  "version": "3.0.32",
+  "version": "3.0.34",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -10,6 +10,10 @@
     "dist/**/*",
     "docs/**/*",
     "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
+    "!src/**/__snapshots__",
+    "!src/**/__fixtures__",
     "CHANGELOG.md",
     "README.md"
   ],
@@ -25,16 +29,16 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/openai-compatible": "2.0.17",
-    "@ai-sdk/provider-utils": "4.0.8",
-    "@ai-sdk/provider": "3.0.4"
+    "@ai-sdk/openai-compatible": "2.0.18",
+    "@ai-sdk/provider": "3.0.5",
+    "@ai-sdk/provider-utils": "4.0.9"
   },
   "devDependencies": {
     "@types/node": "20.17.24",
     "tsup": "^8",
     "typescript": "5.8.3",
     "zod": "3.25.76",
-    "@ai-sdk/test-server": "1.0.2",
+    "@ai-sdk/test-server": "1.0.3",
     "@vercel/ai-tsconfig": "0.0.0"
   },
   "peerDependencies": {

package/src/responses/xai-responses-api.ts

@@ -222,7 +222,7 @@ export const xaiResponsesResponseSchema = z.object({
   model: z.string().nullish(),
   object: z.literal('response'),
   output: z.array(outputItemSchema),
-  usage: xaiResponsesUsageSchema,
+  usage: xaiResponsesUsageSchema.nullish(),
   status: z.string(),
 });
 

package/src/responses/xai-responses-language-model.ts

@@ -343,7 +343,12 @@ export class XaiResponsesLanguageModel implements LanguageModelV3 {
         unified: mapXaiResponsesFinishReason(response.status),
         raw: response.status ?? undefined,
       },
-      usage: convertXaiResponsesUsage(response.usage),
+      usage: response.usage
+        ? convertXaiResponsesUsage(response.usage)
+        : {
+            inputTokens: { total: 0, noCache: 0, cacheRead: 0, cacheWrite: 0 },
+            outputTokens: { total: 0, text: 0, reasoning: 0 },
+          },
       request: { body },
       response: {
         ...getResponseMetadata(response),

package/src/convert-to-xai-chat-messages.test.ts

@@ -1,243 +0,0 @@
-import { convertToXaiChatMessages } from './convert-to-xai-chat-messages';
-import { describe, it, expect } from 'vitest';
-
-describe('convertToXaiChatMessages', () => {
-  it('should convert simple text messages', () => {
-    const { messages, warnings } = convertToXaiChatMessages([
-      { role: 'user', content: [{ type: 'text', text: 'Hello' }] },
-    ]);
-
-    expect(warnings).toEqual([]);
-    expect(messages).toEqual([{ role: 'user', content: 'Hello' }]);
-  });
-
-  it('should convert system messages', () => {
-    const { messages, warnings } = convertToXaiChatMessages([
-      { role: 'system', content: 'You are a helpful assistant.' },
-    ]);
-
-    expect(warnings).toEqual([]);
-    expect(messages).toEqual([
-      { role: 'system', content: 'You are a helpful assistant.' },
-    ]);
-  });
-
-  it('should convert assistant messages', () => {
-    const { messages, warnings } = convertToXaiChatMessages([
-      { role: 'assistant', content: [{ type: 'text', text: 'Hello there!' }] },
-    ]);
-
-    expect(warnings).toEqual([]);
-    expect(messages).toEqual([
-      { role: 'assistant', content: 'Hello there!', tool_calls: undefined },
-    ]);
-  });
-
-  it('should convert messages with image parts', () => {
-    const { messages, warnings } = convertToXaiChatMessages([
-      {
-        role: 'user',
-        content: [
-          { type: 'text', text: 'What is in this image?' },
-          {
-            type: 'file',
-            mediaType: 'image/png',
-            data: Buffer.from([0, 1, 2, 3]),
-          },
-        ],
-      },
-    ]);
-
-    expect(warnings).toEqual([]);
-    expect(messages).toEqual([
-      {
-        role: 'user',
-        content: [
-          { type: 'text', text: 'What is in this image?' },
-          {
-            type: 'image_url',
-            image_url: { url: 'data:image/png;base64,AAECAw==' },
-          },
-        ],
-      },
-    ]);
-  });
-
-  it('should convert image URLs', () => {
-    const { messages, warnings } = convertToXaiChatMessages([
-      {
-        role: 'user',
-        content: [
-          {
-            type: 'file',
-            mediaType: 'image/jpeg',
-            data: new URL('https://example.com/image.jpg'),
-          },
-        ],
-      },
-    ]);
-
-    expect(warnings).toEqual([]);
-    expect(messages).toEqual([
-      {
-        role: 'user',
-        content: [
-          {
-            type: 'image_url',
-            image_url: { url: 'https://example.com/image.jpg' },
-          },
-        ],
-      },
-    ]);
-  });
-
-  it('should throw error for unsupported file types', () => {
-    expect(() => {
-      convertToXaiChatMessages([
-        {
-          role: 'user',
-          content: [
-            {
-              type: 'file',
-              mediaType: 'application/pdf',
-              data: Buffer.from([0, 1, 2, 3]),
-            },
-          ],
-        },
-      ]);
-    }).toThrow('file part media type application/pdf');
-  });
-
-  it('should convert tool calls and tool responses', () => {
-    const { messages, warnings } = convertToXaiChatMessages([
-      {
-        role: 'assistant',
-        content: [
-          {
-            type: 'tool-call',
-            toolCallId: 'call_123',
-            toolName: 'weather',
-            input: { location: 'Paris' },
-          },
-        ],
-      },
-      {
-        role: 'tool',
-        content: [
-          {
-            type: 'tool-result',
-            toolCallId: 'call_123',
-            toolName: 'weather',
-            output: { type: 'json', value: { temperature: 20 } },
-          },
-        ],
-      },
-    ]);
-
-    expect(warnings).toEqual([]);
-    expect(messages).toEqual([
-      {
-        role: 'assistant',
-        content: '',
-        tool_calls: [
-          {
-            id: 'call_123',
-            type: 'function',
-            function: {
-              name: 'weather',
-              arguments: '{"location":"Paris"}',
-            },
-          },
-        ],
-      },
-      {
-        role: 'tool',
-        tool_call_id: 'call_123',
-        content: '{"temperature":20}',
-      },
-    ]);
-  });
-
-  it('should handle multiple tool calls in one message', () => {
-    const { messages, warnings } = convertToXaiChatMessages([
-      {
-        role: 'assistant',
-        content: [
-          {
-            type: 'tool-call',
-            toolCallId: 'call_123',
-            toolName: 'weather',
-            input: { location: 'Paris' },
-          },
-          {
-            type: 'tool-call',
-            toolCallId: 'call_456',
-            toolName: 'time',
-            input: { timezone: 'UTC' },
-          },
-        ],
-      },
-    ]);
-
-    expect(warnings).toEqual([]);
-    expect(messages).toEqual([
-      {
-        role: 'assistant',
-        content: '',
-        tool_calls: [
-          {
-            id: 'call_123',
-            type: 'function',
-            function: {
-              name: 'weather',
-              arguments: '{"location":"Paris"}',
-            },
-          },
-          {
-            id: 'call_456',
-            type: 'function',
-            function: {
-              name: 'time',
-              arguments: '{"timezone":"UTC"}',
-            },
-          },
-        ],
-      },
-    ]);
-  });
-
-  it('should handle mixed content with text and tool calls', () => {
-    const { messages, warnings } = convertToXaiChatMessages([
-      {
-        role: 'assistant',
-        content: [
-          { type: 'text', text: 'Let me check the weather for you.' },
-          {
-            type: 'tool-call',
-            toolCallId: 'call_123',
-            toolName: 'weather',
-            input: { location: 'Paris' },
-          },
-        ],
-      },
-    ]);
-
-    expect(warnings).toEqual([]);
-    expect(messages).toEqual([
-      {
-        role: 'assistant',
-        content: 'Let me check the weather for you.',
-        tool_calls: [
-          {
-            id: 'call_123',
-            type: 'function',
-            function: {
-              name: 'weather',
-              arguments: '{"location":"Paris"}',
-            },
-          },
-        ],
-      },
-    ]);
-  });
-});

package/src/convert-xai-chat-usage.test.ts

@@ -1,240 +0,0 @@
-import { convertXaiChatUsage } from './convert-xai-chat-usage';
-import { describe, it, expect } from 'vitest';
-
-describe('convertXaiChatUsage', () => {
-  it('should convert basic usage without reasoning tokens', () => {
-    const result = convertXaiChatUsage({
-      prompt_tokens: 100,
-      completion_tokens: 50,
-      total_tokens: 150,
-    });
-
-    expect(result).toEqual({
-      inputTokens: {
-        total: 100,
-        noCache: 100,
-        cacheRead: 0,
-        cacheWrite: undefined,
-      },
-      outputTokens: {
-        total: 50,
-        text: 50,
-        reasoning: 0,
-      },
-      raw: {
-        prompt_tokens: 100,
-        completion_tokens: 50,
-        total_tokens: 150,
-      },
-    });
-  });
-
-  it('should convert usage with reasoning tokens', () => {
-    const result = convertXaiChatUsage({
-      prompt_tokens: 168,
-      completion_tokens: 870, // includes reasoning tokens
-      total_tokens: 1038,
-      completion_tokens_details: {
-        reasoning_tokens: 528,
-      },
-    });
-
-    expect(result).toEqual({
-      inputTokens: {
-        total: 168,
-        noCache: 168,
-        cacheRead: 0,
-        cacheWrite: undefined,
-      },
-      outputTokens: {
-        total: 870, // completion_tokens (includes reasoning)
-        text: 342, // 870 - 528
-        reasoning: 528,
-      },
-      raw: {
-        prompt_tokens: 168,
-        completion_tokens: 870,
-        total_tokens: 1038,
-        completion_tokens_details: {
-          reasoning_tokens: 528,
-        },
-      },
-    });
-  });
-
-  it('should handle reasoning tokens greater than completion tokens', () => {
-    // When reasoning tokens are greater, completion_tokens would include them
-    // This scenario tests edge case where we still get valid results
-    const result = convertXaiChatUsage({
-      prompt_tokens: 168,
-      completion_tokens: 870, // includes reasoning
-      total_tokens: 1038,
-      completion_tokens_details: {
-        reasoning_tokens: 528,
-      },
-    });
-
-    expect(result.outputTokens.text).toBe(342); // 870 - 528
-    expect(result.outputTokens.text).toBeGreaterThanOrEqual(0);
-    expect(result.outputTokens.total).toBe(870);
-  });
-
-  it('should convert usage with cached input tokens', () => {
-    const result = convertXaiChatUsage({
-      prompt_tokens: 168,
-      completion_tokens: 1036, // includes reasoning tokens
-      total_tokens: 1204,
-      prompt_tokens_details: {
-        text_tokens: 168,
-        audio_tokens: 0,
-        image_tokens: 0,
-        cached_tokens: 146,
-      },
-      completion_tokens_details: {
-        reasoning_tokens: 458,
-      },
-    });
-
-    expect(result).toEqual({
-      inputTokens: {
-        total: 168,
-        noCache: 22, // 168 - 146
-        cacheRead: 146,
-        cacheWrite: undefined,
-      },
-      outputTokens: {
-        total: 1036, // completion_tokens (includes reasoning)
-        text: 578, // 1036 - 458
-        reasoning: 458,
-      },
-      raw: {
-        prompt_tokens: 168,
-        completion_tokens: 1036,
-        total_tokens: 1204,
-        prompt_tokens_details: {
-          text_tokens: 168,
-          audio_tokens: 0,
-          image_tokens: 0,
-          cached_tokens: 146,
-        },
-        completion_tokens_details: {
-          reasoning_tokens: 458,
-        },
-      },
-    });
-  });
-
-  it('should handle null/undefined token details gracefully', () => {
-    const result = convertXaiChatUsage({
-      prompt_tokens: 100,
-      completion_tokens: 200,
-      total_tokens: 300,
-      prompt_tokens_details: null,
-      completion_tokens_details: null,
-    });
-
-    expect(result.inputTokens.cacheRead).toBe(0);
-    expect(result.inputTokens.noCache).toBe(100);
-    expect(result.outputTokens.reasoning).toBe(0);
-    expect(result.outputTokens.text).toBe(200);
-    expect(result.outputTokens.total).toBe(200);
-  });
-
-  it('should handle zero reasoning tokens', () => {
-    const result = convertXaiChatUsage({
-      prompt_tokens: 50,
-      completion_tokens: 100,
-      total_tokens: 150,
-      completion_tokens_details: {
-        reasoning_tokens: 0,
-      },
-    });
-
-    expect(result.outputTokens).toEqual({
-      total: 100,
-      text: 100,
-      reasoning: 0,
-    });
-  });
-
-  it('should preserve raw usage data', () => {
-    const rawUsage = {
-      prompt_tokens: 168,
-      completion_tokens: 870, // includes reasoning
-      total_tokens: 1038,
-      prompt_tokens_details: {
-        text_tokens: 168,
-        audio_tokens: 0,
-        image_tokens: 0,
-        cached_tokens: 167,
-      },
-      completion_tokens_details: {
-        reasoning_tokens: 528,
-        audio_tokens: 0,
-        accepted_prediction_tokens: 0,
-        rejected_prediction_tokens: 0,
-      },
-    };
-
-    const result = convertXaiChatUsage(rawUsage);
-
-    expect(result.raw).toEqual(rawUsage);
-  });
-
-  it('should handle the issue case with grok-4-fast-reasoning', () => {
-    // Test case from GitHub issue: grok-4-fast-reasoning returning negative text_output_tokens
-    // Raw API response format where completion_tokens includes reasoning tokens
-    const result = convertXaiChatUsage({
-      prompt_tokens: 279,
-      completion_tokens: 95, // includes reasoning tokens (6 text + 89 reasoning)
-      total_tokens: 374,
-      prompt_tokens_details: {
-        text_tokens: 279,
-        audio_tokens: 0,
-        image_tokens: 0,
-        cached_tokens: 149,
-      },
-      completion_tokens_details: {
-        reasoning_tokens: 89,
-        audio_tokens: 0,
-        accepted_prediction_tokens: 0,
-        rejected_prediction_tokens: 0,
-      },
-    });
-
-    expect(result).toEqual({
-      inputTokens: {
-        total: 279,
-        noCache: 130, // 279 - 149
-        cacheRead: 149,
-        cacheWrite: undefined,
-      },
-      outputTokens: {
-        total: 95, // completion_tokens (includes reasoning)
-        text: 6, // 95 - 89 (should be positive, not -83!)
-        reasoning: 89,
-      },
-      raw: {
-        prompt_tokens: 279,
-        completion_tokens: 95,
-        total_tokens: 374,
-        prompt_tokens_details: {
-          text_tokens: 279,
-          audio_tokens: 0,
-          image_tokens: 0,
-          cached_tokens: 149,
-        },
-        completion_tokens_details: {
-          reasoning_tokens: 89,
-          audio_tokens: 0,
-          accepted_prediction_tokens: 0,
-          rejected_prediction_tokens: 0,
-        },
-      },
-    });
-
-    // Verify no negative text tokens
-    expect(result.outputTokens.text).toBeGreaterThanOrEqual(0);
-    expect(result.outputTokens.text).toBe(6);
-  });
-});

package/src/responses/__fixtures__/xai-code-execution-tool.1.json

@@ -1,68 +0,0 @@
-{
-  "created_at": 1761768921,
-  "id": "5138abcf-4c4e-b0ab-7e0b-f4c81b98f455_us-east-1",
-  "max_output_tokens": null,
-  "model": "grok-4-fast-reasoning",
-  "object": "response",
-  "output": [
-    {
-      "arguments": "{\"code\":\"def fibonacci(n):\\n    if n <= 0:\\n        return 0\\n    elif n == 1:\\n        return 1\\n    else:\\n        a, b = 0, 1\\n        for _ in range(2, n + 1):\\n            a, b = b, a + b\\n        return b\\n\\nprint(fibonacci(10))\"}",
-      "call_id": "",
-      "name": "code_execution",
-      "type": "code_interpreter_call",
-      "id": "fc_5138abcf-4c4e-b0ab-7e0b-f4c81b98f455_us-east-1_0",
-      "status": "completed"
-    },
-    {
-      "content": [
-        {
-          "type": "output_text",
-          "text": "55",
-          "logprobs": [],
-          "annotations": []
-        }
-      ],
-      "id": "msg_5138abcf-4c4e-b0ab-7e0b-f4c81b98f455_us-east-1",
-      "role": "assistant",
-      "type": "message",
-      "status": "completed"
-    }
-  ],
-  "parallel_tool_calls": true,
-  "previous_response_id": null,
-  "reasoning": {
-    "effort": null,
-    "summary": null
-  },
-  "temperature": null,
-  "text": {
-    "format": {
-      "type": "text"
-    }
-  },
-  "tool_choice": "auto",
-  "tools": [
-    {
-      "type": "code_interpreter"
-    }
-  ],
-  "top_p": null,
-  "usage": {
-    "input_tokens": 1606,
-    "input_tokens_details": {
-      "cached_tokens": 1235
-    },
-    "output_tokens": 292,
-    "output_tokens_details": {
-      "reasoning_tokens": 190
-    },
-    "total_tokens": 1898,
-    "num_sources_used": 0,
-    "num_server_side_tools_used": 1
-  },
-  "user": null,
-  "incomplete_details": null,
-  "status": "completed",
-  "store": true,
-  "metadata": {}
-}