@ai-sdk/xai 3.0.108 → 3.0.109

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/xai
 
+## 3.0.109
+
+### Patch Changes
+
+- b0db900: feat(provider/xai): support end-user identifiers for video generation and editing
+
 ## 3.0.108
 
 ### Patch Changes

package/dist/index.d.mts

@@ -122,7 +122,13 @@ interface XaiVideoSharedOptions {
     pollTimeoutMs?: number | null;
     resolution?: XaiVideoResolution | null;
 }
-interface XaiVideoEditModeOptions extends XaiVideoSharedOptions {
+interface XaiVideoUserOptions {
+    /**
+     * A unique identifier representing the end user, for abuse monitoring.
+     */
+    user?: string;
+}
+interface XaiVideoEditModeOptions extends XaiVideoSharedOptions, XaiVideoUserOptions {
     /**
      * Select edit-video mode explicitly for best autocomplete and narrowing.
      */
@@ -138,7 +144,7 @@ interface XaiVideoExtendModeOptions extends XaiVideoSharedOptions {
     /** Source video URL to extend from its last frame. */
     videoUrl: string;
 }
-interface XaiVideoReferenceToVideoOptions extends XaiVideoSharedOptions {
+interface XaiVideoReferenceToVideoOptions extends XaiVideoSharedOptions, XaiVideoUserOptions {
     /**
      * Select reference-to-video mode explicitly for best autocomplete and narrowing.
      */
@@ -146,12 +152,12 @@ interface XaiVideoReferenceToVideoOptions extends XaiVideoSharedOptions {
     /** Reference image URLs (1-7) for R2V generation. */
     referenceImageUrls: string[];
 }
-interface XaiVideoGenerationOptions extends XaiVideoSharedOptions {
+interface XaiVideoGenerationOptions extends XaiVideoSharedOptions, XaiVideoUserOptions {
     mode?: undefined;
     videoUrl?: undefined;
     referenceImageUrls?: undefined;
 }
-interface XaiLegacyEditVideoOptions extends XaiVideoSharedOptions {
+interface XaiLegacyEditVideoOptions extends XaiVideoSharedOptions, XaiVideoUserOptions {
     /**
      * Legacy backward-compatible shape: omitting `mode` while providing
      * `videoUrl` behaves like edit-video.
@@ -159,7 +165,7 @@ interface XaiLegacyEditVideoOptions extends XaiVideoSharedOptions {
     mode?: undefined;
     videoUrl: string;
 }
-interface XaiLegacyReferenceToVideoOptions extends XaiVideoSharedOptions {
+interface XaiLegacyReferenceToVideoOptions extends XaiVideoSharedOptions, XaiVideoUserOptions {
     /**
      * Legacy backward-compatible shape: omitting `mode` while providing
      * `referenceImageUrls` behaves like reference-to-video.

package/dist/index.d.ts

@@ -122,7 +122,13 @@ interface XaiVideoSharedOptions {
     pollTimeoutMs?: number | null;
     resolution?: XaiVideoResolution | null;
 }
-interface XaiVideoEditModeOptions extends XaiVideoSharedOptions {
+interface XaiVideoUserOptions {
+    /**
+     * A unique identifier representing the end user, for abuse monitoring.
+     */
+    user?: string;
+}
+interface XaiVideoEditModeOptions extends XaiVideoSharedOptions, XaiVideoUserOptions {
     /**
      * Select edit-video mode explicitly for best autocomplete and narrowing.
      */
@@ -138,7 +144,7 @@ interface XaiVideoExtendModeOptions extends XaiVideoSharedOptions {
     /** Source video URL to extend from its last frame. */
     videoUrl: string;
 }
-interface XaiVideoReferenceToVideoOptions extends XaiVideoSharedOptions {
+interface XaiVideoReferenceToVideoOptions extends XaiVideoSharedOptions, XaiVideoUserOptions {
     /**
      * Select reference-to-video mode explicitly for best autocomplete and narrowing.
      */
@@ -146,12 +152,12 @@ interface XaiVideoReferenceToVideoOptions extends XaiVideoSharedOptions {
     /** Reference image URLs (1-7) for R2V generation. */
     referenceImageUrls: string[];
 }
-interface XaiVideoGenerationOptions extends XaiVideoSharedOptions {
+interface XaiVideoGenerationOptions extends XaiVideoSharedOptions, XaiVideoUserOptions {
     mode?: undefined;
     videoUrl?: undefined;
     referenceImageUrls?: undefined;
 }
-interface XaiLegacyEditVideoOptions extends XaiVideoSharedOptions {
+interface XaiLegacyEditVideoOptions extends XaiVideoSharedOptions, XaiVideoUserOptions {
     /**
      * Legacy backward-compatible shape: omitting `mode` while providing
      * `videoUrl` behaves like edit-video.
@@ -159,7 +165,7 @@ interface XaiLegacyEditVideoOptions extends XaiVideoSharedOptions {
     mode?: undefined;
     videoUrl: string;
 }
-interface XaiLegacyReferenceToVideoOptions extends XaiVideoSharedOptions {
+interface XaiLegacyReferenceToVideoOptions extends XaiVideoSharedOptions, XaiVideoUserOptions {
     /**
      * Legacy backward-compatible shape: omitting `mode` while providing
      * `referenceImageUrls` behaves like reference-to-video.

package/dist/index.js

@@ -2891,7 +2891,7 @@ var xaiTools = {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.108" : "0.0.0-test";
+var VERSION = true ? "3.0.109" : "0.0.0-test";
 
 // src/xai-video-model.ts
 var import_provider6 = require("@ai-sdk/provider");
@@ -2909,8 +2909,12 @@ var baseFields = {
   pollTimeoutMs: import_v416.z.number().positive().nullish(),
   resolution: resolutionSchema.nullish()
 };
+var userField = {
+  user: import_v416.z.string().optional()
+};
 var editVideoSchema = import_v416.z.object({
   ...baseFields,
+  ...userField,
   mode: import_v416.z.literal("edit-video"),
   videoUrl: nonEmptyStringSchema,
   referenceImageUrls: import_v416.z.undefined().optional()
@@ -2923,12 +2927,14 @@ var extendVideoSchema = import_v416.z.object({
 });
 var referenceToVideoSchema = import_v416.z.object({
   ...baseFields,
+  ...userField,
   mode: import_v416.z.literal("reference-to-video"),
   referenceImageUrls: import_v416.z.array(nonEmptyStringSchema).min(1).max(7),
   videoUrl: import_v416.z.undefined().optional()
 });
 var autoDetectSchema = import_v416.z.object({
   ...baseFields,
+  ...userField,
   mode: import_v416.z.undefined().optional(),
   videoUrl: nonEmptyStringSchema.optional(),
   referenceImageUrls: import_v416.z.array(nonEmptyStringSchema).min(1).max(7).optional()
@@ -2943,6 +2949,7 @@ var runtimeSchema = import_v416.z.object({
   mode: modeSchema.optional(),
   videoUrl: nonEmptyStringSchema.optional(),
   referenceImageUrls: import_v416.z.array(nonEmptyStringSchema).min(1).max(7).optional(),
+  user: import_v416.z.string().optional(),
   ...baseFields
 }).passthrough();
 var xaiVideoModelOptionsSchema = (0, import_provider_utils15.lazySchema)(
@@ -3166,6 +3173,9 @@ var XaiVideoModel = class {
         details: "xAI only supports inputReferences for reference-to-video generation. The reference images were ignored."
       });
     }
+    if (!isExtension && (xaiOptions == null ? void 0 : xaiOptions.user) !== void 0) {
+      body.user = xaiOptions.user;
+    }
     if (xaiOptions != null) {
       for (const [key, value] of Object.entries(xaiOptions)) {
         if (![
@@ -3174,7 +3184,8 @@ var XaiVideoModel = class {
           "pollTimeoutMs",
           "resolution",
           "videoUrl",
-          "referenceImageUrls"
+          "referenceImageUrls",
+          "user"
         ].includes(key)) {
           body[key] = value;
         }