@ai-sdk/xai 3.0.55 → 3.0.57

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/xai
 
+## 3.0.57
+
+### Patch Changes
+
+- 56dfdf6: feat (provider/xai): add video support
+
+## 3.0.56
+
+### Patch Changes
+
+- 7ccb902: fix(provider/xai): handle inconsistent cached token reporting
+
 ## 3.0.55
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import { z } from 'zod/v4';
-import { ProviderV3, LanguageModelV3, ImageModelV3 } from '@ai-sdk/provider';
+import { ProviderV3, LanguageModelV3, ImageModelV3, Experimental_VideoModelV3 } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 
@@ -81,6 +81,16 @@ declare const xaiImageModelOptions: z.ZodObject<{
 }, z.core.$strip>;
 type XaiImageModelOptions = z.infer<typeof xaiImageModelOptions>;
 
+type XaiVideoModelId = 'grok-imagine-video' | (string & {});
+
+type XaiVideoModelOptions = {
+    pollIntervalMs?: number | null;
+    pollTimeoutMs?: number | null;
+    resolution?: '480p' | '720p' | null;
+    videoUrl?: string | null;
+    [key: string]: unknown;
+};
+
 type XaiImageModelId = 'grok-2-image' | 'grok-imagine-image' | (string & {});
 
 declare const codeExecutionToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
@@ -307,6 +317,14 @@ interface XaiProvider extends ProviderV3 {
      * Creates an Xai image model for image generation.
      */
     imageModel(modelId: XaiImageModelId): ImageModelV3;
+    /**
+     * Creates an Xai video model for video generation.
+     */
+    video(modelId: XaiVideoModelId): Experimental_VideoModelV3;
+    /**
+     * Creates an Xai video model for video generation.
+     */
+    videoModel(modelId: XaiVideoModelId): Experimental_VideoModelV3;
     /**
      * Server-side agentic tools for use with the responses API.
      */
@@ -340,4 +358,4 @@ declare const xai: XaiProvider;
 
 declare const VERSION: string;
 
-export { VERSION, type XaiErrorData, type XaiImageModelOptions, type XaiImageModelOptions as XaiImageProviderOptions, type XaiLanguageModelChatOptions, type XaiLanguageModelResponsesOptions, type XaiProvider, type XaiLanguageModelChatOptions as XaiProviderOptions, type XaiProviderSettings, type XaiLanguageModelResponsesOptions as XaiResponsesProviderOptions, codeExecution, createXai, mcpServer, viewImage, viewXVideo, webSearch, xSearch, xai, xaiTools };
+export { VERSION, type XaiErrorData, type XaiImageModelOptions, type XaiImageModelOptions as XaiImageProviderOptions, type XaiLanguageModelChatOptions, type XaiLanguageModelResponsesOptions, type XaiProvider, type XaiLanguageModelChatOptions as XaiProviderOptions, type XaiProviderSettings, type XaiLanguageModelResponsesOptions as XaiResponsesProviderOptions, type XaiVideoModelId, type XaiVideoModelOptions, type XaiVideoModelOptions as XaiVideoProviderOptions, codeExecution, createXai, mcpServer, viewImage, viewXVideo, webSearch, xSearch, xai, xaiTools };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod/v4';
-import { ProviderV3, LanguageModelV3, ImageModelV3 } from '@ai-sdk/provider';
+import { ProviderV3, LanguageModelV3, ImageModelV3, Experimental_VideoModelV3 } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 
@@ -81,6 +81,16 @@ declare const xaiImageModelOptions: z.ZodObject<{
 }, z.core.$strip>;
 type XaiImageModelOptions = z.infer<typeof xaiImageModelOptions>;
 
+type XaiVideoModelId = 'grok-imagine-video' | (string & {});
+
+type XaiVideoModelOptions = {
+    pollIntervalMs?: number | null;
+    pollTimeoutMs?: number | null;
+    resolution?: '480p' | '720p' | null;
+    videoUrl?: string | null;
+    [key: string]: unknown;
+};
+
 type XaiImageModelId = 'grok-2-image' | 'grok-imagine-image' | (string & {});
 
 declare const codeExecutionToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
@@ -307,6 +317,14 @@ interface XaiProvider extends ProviderV3 {
      * Creates an Xai image model for image generation.
      */
     imageModel(modelId: XaiImageModelId): ImageModelV3;
+    /**
+     * Creates an Xai video model for video generation.
+     */
+    video(modelId: XaiVideoModelId): Experimental_VideoModelV3;
+    /**
+     * Creates an Xai video model for video generation.
+     */
+    videoModel(modelId: XaiVideoModelId): Experimental_VideoModelV3;
     /**
      * Server-side agentic tools for use with the responses API.
      */
@@ -340,4 +358,4 @@ declare const xai: XaiProvider;
 
 declare const VERSION: string;
 
-export { VERSION, type XaiErrorData, type XaiImageModelOptions, type XaiImageModelOptions as XaiImageProviderOptions, type XaiLanguageModelChatOptions, type XaiLanguageModelResponsesOptions, type XaiProvider, type XaiLanguageModelChatOptions as XaiProviderOptions, type XaiProviderSettings, type XaiLanguageModelResponsesOptions as XaiResponsesProviderOptions, codeExecution, createXai, mcpServer, viewImage, viewXVideo, webSearch, xSearch, xai, xaiTools };
+export { VERSION, type XaiErrorData, type XaiImageModelOptions, type XaiImageModelOptions as XaiImageProviderOptions, type XaiLanguageModelChatOptions, type XaiLanguageModelResponsesOptions, type XaiProvider, type XaiLanguageModelChatOptions as XaiProviderOptions, type XaiProviderSettings, type XaiLanguageModelResponsesOptions as XaiResponsesProviderOptions, type XaiVideoModelId, type XaiVideoModelOptions, type XaiVideoModelOptions as XaiVideoProviderOptions, codeExecution, createXai, mcpServer, viewImage, viewXVideo, webSearch, xSearch, xai, xaiTools };

package/dist/index.js

@@ -34,8 +34,8 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/xai-provider.ts
-var import_provider6 = require("@ai-sdk/provider");
-var import_provider_utils15 = require("@ai-sdk/provider-utils");
+var import_provider7 = require("@ai-sdk/provider");
+var import_provider_utils17 = require("@ai-sdk/provider-utils");
 
 // src/xai-chat-language-model.ts
 var import_provider3 = require("@ai-sdk/provider");
@@ -159,10 +159,11 @@ function convertXaiChatUsage(usage) {
   var _a, _b, _c, _d;
   const cacheReadTokens = (_b = (_a = usage.prompt_tokens_details) == null ? void 0 : _a.cached_tokens) != null ? _b : 0;
   const reasoningTokens = (_d = (_c = usage.completion_tokens_details) == null ? void 0 : _c.reasoning_tokens) != null ? _d : 0;
+  const promptTokensIncludesCached = cacheReadTokens <= usage.prompt_tokens;
   return {
     inputTokens: {
-      total: usage.prompt_tokens,
-      noCache: usage.prompt_tokens - cacheReadTokens,
+      total: promptTokensIncludesCached ? usage.prompt_tokens : usage.prompt_tokens + cacheReadTokens,
+      noCache: promptTokensIncludesCached ? usage.prompt_tokens - cacheReadTokens : usage.prompt_tokens,
       cacheRead: cacheReadTokens,
       cacheWrite: void 0
     },
@@ -1186,10 +1187,11 @@ function convertXaiResponsesUsage(usage) {
   var _a, _b, _c, _d;
   const cacheReadTokens = (_b = (_a = usage.input_tokens_details) == null ? void 0 : _a.cached_tokens) != null ? _b : 0;
   const reasoningTokens = (_d = (_c = usage.output_tokens_details) == null ? void 0 : _c.reasoning_tokens) != null ? _d : 0;
+  const inputTokensIncludesCached = cacheReadTokens <= usage.input_tokens;
   return {
     inputTokens: {
-      total: usage.input_tokens,
-      noCache: usage.input_tokens - cacheReadTokens,
+      total: inputTokensIncludesCached ? usage.input_tokens : usage.input_tokens + cacheReadTokens,
+      noCache: inputTokensIncludesCached ? usage.input_tokens - cacheReadTokens : usage.input_tokens,
       cacheRead: cacheReadTokens,
       cacheWrite: void 0
     },
@@ -2690,17 +2692,247 @@ var xaiTools = {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.55" : "0.0.0-test";
+var VERSION = true ? "3.0.57" : "0.0.0-test";
+
+// src/xai-video-model.ts
+var import_provider6 = require("@ai-sdk/provider");
+var import_provider_utils16 = require("@ai-sdk/provider-utils");
+var import_v416 = require("zod/v4");
+
+// src/xai-video-options.ts
+var import_provider_utils15 = require("@ai-sdk/provider-utils");
+var import_v415 = require("zod/v4");
+var xaiVideoModelOptionsSchema = (0, import_provider_utils15.lazySchema)(
+  () => (0, import_provider_utils15.zodSchema)(
+    import_v415.z.object({
+      pollIntervalMs: import_v415.z.number().positive().nullish(),
+      pollTimeoutMs: import_v415.z.number().positive().nullish(),
+      resolution: import_v415.z.enum(["480p", "720p"]).nullish(),
+      videoUrl: import_v415.z.string().nullish()
+    }).passthrough()
+  )
+);
+
+// src/xai-video-model.ts
+var RESOLUTION_MAP = {
+  "1280x720": "720p",
+  "854x480": "480p",
+  "640x480": "480p"
+};
+var XaiVideoModel = class {
+  constructor(modelId, config) {
+    this.modelId = modelId;
+    this.config = config;
+    this.specificationVersion = "v3";
+    this.maxVideosPerCall = 1;
+  }
+  get provider() {
+    return this.config.provider;
+  }
+  async doGenerate(options) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    const currentDate = (_c = (_b = (_a = this.config._internal) == null ? void 0 : _a.currentDate) == null ? void 0 : _b.call(_a)) != null ? _c : /* @__PURE__ */ new Date();
+    const warnings = [];
+    const xaiOptions = await (0, import_provider_utils16.parseProviderOptions)({
+      provider: "xai",
+      providerOptions: options.providerOptions,
+      schema: xaiVideoModelOptionsSchema
+    });
+    const isEdit = (xaiOptions == null ? void 0 : xaiOptions.videoUrl) != null;
+    if (options.fps != null) {
+      warnings.push({
+        type: "unsupported",
+        feature: "fps",
+        details: "xAI video models do not support custom FPS."
+      });
+    }
+    if (options.seed != null) {
+      warnings.push({
+        type: "unsupported",
+        feature: "seed",
+        details: "xAI video models do not support seed."
+      });
+    }
+    if (options.n != null && options.n > 1) {
+      warnings.push({
+        type: "unsupported",
+        feature: "n",
+        details: "xAI video models do not support generating multiple videos per call. Only 1 video will be generated."
+      });
+    }
+    if (isEdit && options.duration != null) {
+      warnings.push({
+        type: "unsupported",
+        feature: "duration",
+        details: "xAI video editing does not support custom duration."
+      });
+    }
+    if (isEdit && options.aspectRatio != null) {
+      warnings.push({
+        type: "unsupported",
+        feature: "aspectRatio",
+        details: "xAI video editing does not support custom aspect ratio."
+      });
+    }
+    if (isEdit && ((xaiOptions == null ? void 0 : xaiOptions.resolution) != null || options.resolution != null)) {
+      warnings.push({
+        type: "unsupported",
+        feature: "resolution",
+        details: "xAI video editing does not support custom resolution."
+      });
+    }
+    const body = {
+      model: this.modelId,
+      prompt: options.prompt
+    };
+    if (!isEdit && options.duration != null) {
+      body.duration = options.duration;
+    }
+    if (!isEdit && options.aspectRatio != null) {
+      body.aspect_ratio = options.aspectRatio;
+    }
+    if (!isEdit && (xaiOptions == null ? void 0 : xaiOptions.resolution) != null) {
+      body.resolution = xaiOptions.resolution;
+    } else if (!isEdit && options.resolution != null) {
+      const mapped = RESOLUTION_MAP[options.resolution];
+      if (mapped != null) {
+        body.resolution = mapped;
+      } else {
+        warnings.push({
+          type: "unsupported",
+          feature: "resolution",
+          details: `Unrecognized resolution "${options.resolution}". Use providerOptions.xai.resolution with "480p" or "720p" instead.`
+        });
+      }
+    }
+    if ((xaiOptions == null ? void 0 : xaiOptions.videoUrl) != null) {
+      body.video = { url: xaiOptions.videoUrl };
+    }
+    if (options.image != null) {
+      if (options.image.type === "url") {
+        body.image = { url: options.image.url };
+      } else {
+        const base64Data = typeof options.image.data === "string" ? options.image.data : (0, import_provider_utils16.convertUint8ArrayToBase64)(options.image.data);
+        body.image = {
+          url: `data:${options.image.mediaType};base64,${base64Data}`
+        };
+      }
+    }
+    if (xaiOptions != null) {
+      for (const [key, value] of Object.entries(xaiOptions)) {
+        if (![
+          "pollIntervalMs",
+          "pollTimeoutMs",
+          "resolution",
+          "videoUrl"
+        ].includes(key)) {
+          body[key] = value;
+        }
+      }
+    }
+    const baseURL = (_d = this.config.baseURL) != null ? _d : "https://api.x.ai/v1";
+    const { value: createResponse } = await (0, import_provider_utils16.postJsonToApi)({
+      url: `${baseURL}/videos/${isEdit ? "edits" : "generations"}`,
+      headers: (0, import_provider_utils16.combineHeaders)(this.config.headers(), options.headers),
+      body,
+      failedResponseHandler: xaiFailedResponseHandler,
+      successfulResponseHandler: (0, import_provider_utils16.createJsonResponseHandler)(
+        xaiCreateVideoResponseSchema
+      ),
+      abortSignal: options.abortSignal,
+      fetch: this.config.fetch
+    });
+    const requestId = createResponse.request_id;
+    if (!requestId) {
+      throw new import_provider6.AISDKError({
+        name: "XAI_VIDEO_GENERATION_ERROR",
+        message: `No request_id returned from xAI API. Response: ${JSON.stringify(createResponse)}`
+      });
+    }
+    const pollIntervalMs = (_e = xaiOptions == null ? void 0 : xaiOptions.pollIntervalMs) != null ? _e : 5e3;
+    const pollTimeoutMs = (_f = xaiOptions == null ? void 0 : xaiOptions.pollTimeoutMs) != null ? _f : 6e5;
+    const startTime = Date.now();
+    let responseHeaders;
+    while (true) {
+      await (0, import_provider_utils16.delay)(pollIntervalMs, { abortSignal: options.abortSignal });
+      if (Date.now() - startTime > pollTimeoutMs) {
+        throw new import_provider6.AISDKError({
+          name: "XAI_VIDEO_GENERATION_TIMEOUT",
+          message: `Video generation timed out after ${pollTimeoutMs}ms`
+        });
+      }
+      const { value: statusResponse, responseHeaders: pollHeaders } = await (0, import_provider_utils16.getFromApi)({
+        url: `${baseURL}/videos/${requestId}`,
+        headers: (0, import_provider_utils16.combineHeaders)(this.config.headers(), options.headers),
+        successfulResponseHandler: (0, import_provider_utils16.createJsonResponseHandler)(
+          xaiVideoStatusResponseSchema
+        ),
+        failedResponseHandler: xaiFailedResponseHandler,
+        abortSignal: options.abortSignal,
+        fetch: this.config.fetch
+      });
+      responseHeaders = pollHeaders;
+      if (statusResponse.status === "done" || statusResponse.status == null && ((_g = statusResponse.video) == null ? void 0 : _g.url)) {
+        if (!((_h = statusResponse.video) == null ? void 0 : _h.url)) {
+          throw new import_provider6.AISDKError({
+            name: "XAI_VIDEO_GENERATION_ERROR",
+            message: "Video generation completed but no video URL was returned."
+          });
+        }
+        return {
+          videos: [
+            {
+              type: "url",
+              url: statusResponse.video.url,
+              mediaType: "video/mp4"
+            }
+          ],
+          warnings,
+          response: {
+            timestamp: currentDate,
+            modelId: this.modelId,
+            headers: responseHeaders
+          },
+          providerMetadata: {
+            xai: {
+              requestId,
+              videoUrl: statusResponse.video.url,
+              ...statusResponse.video.duration != null ? { duration: statusResponse.video.duration } : {}
+            }
+          }
+        };
+      }
+      if (statusResponse.status === "expired") {
+        throw new import_provider6.AISDKError({
+          name: "XAI_VIDEO_GENERATION_EXPIRED",
+          message: "Video generation request expired."
+        });
+      }
+    }
+  }
+};
+var xaiCreateVideoResponseSchema = import_v416.z.object({
+  request_id: import_v416.z.string().nullish()
+});
+var xaiVideoStatusResponseSchema = import_v416.z.object({
+  status: import_v416.z.string().nullish(),
+  video: import_v416.z.object({
+    url: import_v416.z.string(),
+    duration: import_v416.z.number().nullish(),
+    respect_moderation: import_v416.z.boolean().nullish()
+  }).nullish(),
+  model: import_v416.z.string().nullish()
+});
 
 // src/xai-provider.ts
 function createXai(options = {}) {
   var _a;
-  const baseURL = (0, import_provider_utils15.withoutTrailingSlash)(
+  const baseURL = (0, import_provider_utils17.withoutTrailingSlash)(
     (_a = options.baseURL) != null ? _a : "https://api.x.ai/v1"
   );
-  const getHeaders = () => (0, import_provider_utils15.withUserAgentSuffix)(
+  const getHeaders = () => (0, import_provider_utils17.withUserAgentSuffix)(
     {
-      Authorization: `Bearer ${(0, import_provider_utils15.loadApiKey)({
+      Authorization: `Bearer ${(0, import_provider_utils17.loadApiKey)({
         apiKey: options.apiKey,
         environmentVariableName: "XAI_API_KEY",
         description: "xAI API key"
@@ -2714,7 +2946,7 @@ function createXai(options = {}) {
       provider: "xai.chat",
       baseURL,
       headers: getHeaders,
-      generateId: import_provider_utils15.generateId,
+      generateId: import_provider_utils17.generateId,
       fetch: options.fetch
     });
   };
@@ -2723,7 +2955,7 @@ function createXai(options = {}) {
       provider: "xai.responses",
       baseURL,
       headers: getHeaders,
-      generateId: import_provider_utils15.generateId,
+      generateId: import_provider_utils17.generateId,
       fetch: options.fetch
     });
   };
@@ -2735,17 +2967,27 @@ function createXai(options = {}) {
       fetch: options.fetch
     });
   };
+  const createVideoModel = (modelId) => {
+    return new XaiVideoModel(modelId, {
+      provider: "xai.video",
+      baseURL,
+      headers: getHeaders,
+      fetch: options.fetch
+    });
+  };
   const provider = (modelId) => createChatLanguageModel(modelId);
   provider.specificationVersion = "v3";
   provider.languageModel = createChatLanguageModel;
   provider.chat = createChatLanguageModel;
   provider.responses = createResponsesLanguageModel;
   provider.embeddingModel = (modelId) => {
-    throw new import_provider6.NoSuchModelError({ modelId, modelType: "embeddingModel" });
+    throw new import_provider7.NoSuchModelError({ modelId, modelType: "embeddingModel" });
   };
   provider.textEmbeddingModel = provider.embeddingModel;
   provider.imageModel = createImageModel;
   provider.image = createImageModel;
+  provider.videoModel = createVideoModel;
+  provider.video = createVideoModel;
   provider.tools = xaiTools;
   return provider;
 }