@tanstack/ai 0.5.0 → 0.6.1

package/dist/esm/activities/generateImage/index.d.ts

@@ -19,7 +19,7 @@ export type ImageSizeForModel<TAdapter, TModel extends string> = TAdapter extend
  *
  * @template TAdapter - The image adapter type
  */
-export interface ImageActivityOptions<TAdapter extends ImageAdapter<string, object, any, any>> {
+export type ImageActivityOptions<TAdapter extends ImageAdapter<string, any, any, any>> = {
     /** The image adapter to use (must be created with a model) */
     adapter: TAdapter & {
         kind: typeof kind;
@@ -30,9 +30,11 @@ export interface ImageActivityOptions<TAdapter extends ImageAdapter<string, obje
     numberOfImages?: number;
     /** Image size in WIDTHxHEIGHT format (e.g., "1024x1024") */
     size?: ImageSizeForModel<TAdapter, TAdapter['model']>;
-    /** Provider-specific options for image generation */
-    modelOptions?: ImageProviderOptionsForModel<TAdapter, TAdapter['model']>;
-}
+} & ({} extends ImageProviderOptionsForModel<TAdapter, TAdapter['model']> ? {
+    /** Provider-specific options for image generation */ modelOptions?: ImageProviderOptionsForModel<TAdapter, TAdapter['model']>;
+} : {
+    /** Provider-specific options for image generation */ modelOptions: ImageProviderOptionsForModel<TAdapter, TAdapter['model']>;
+});
 /** Result type for the image activity */
 export type ImageActivityResult = Promise<ImageGenerationResult>;
 /**
@@ -80,10 +82,10 @@ export type ImageActivityResult = Promise<ImageGenerationResult>;
  * })
  * ```
  */
-export declare function generateImage<TAdapter extends ImageAdapter<string, object, any, any>>(options: ImageActivityOptions<TAdapter>): ImageActivityResult;
+export declare function generateImage<TAdapter extends ImageAdapter<string, any, any, any>>(options: ImageActivityOptions<TAdapter>): ImageActivityResult;
 /**
  * Create typed options for the generateImage() function without executing.
  */
-export declare function createImageOptions<TAdapter extends ImageAdapter<string, object, any, any>>(options: ImageActivityOptions<TAdapter>): ImageActivityOptions<TAdapter>;
+export declare function createImageOptions<TAdapter extends ImageAdapter<string, any, any, any>>(options: ImageActivityOptions<TAdapter>): ImageActivityOptions<TAdapter>;
 export type { ImageAdapter, ImageAdapterConfig, AnyImageAdapter, } from './adapter.js';
 export { BaseImageAdapter } from './adapter.js';

package/dist/esm/activities/generateImage/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../../src/activities/generateImage/index.ts"],"sourcesContent":["/**\n * Image Activity\n *\n * Generates images from text prompts.\n * This is a self-contained module with implementation, types, and JSDoc.\n */\n\nimport { aiEventClient } from '../../event-client.js'\nimport type { ImageAdapter } from './adapter'\nimport type { ImageGenerationResult } from '../../types'\n\n// ===========================\n// Activity Kind\n// ===========================\n\n/** The adapter kind this activity handles */\nexport const kind = 'image' as const\n\n// ===========================\n// Type Extraction Helpers\n// ===========================\n\n/**\n * Extract model-specific provider options from an ImageAdapter via ~types.\n * If the model has specific options defined in ModelProviderOptions (and not just via index signature),\n * use those; otherwise fall back to base provider options.\n */\nexport type ImageProviderOptionsForModel<TAdapter, TModel extends string> =\n  TAdapter extends ImageAdapter<any, infer BaseOptions, infer ModelOptions, any>\n    ? string extends keyof ModelOptions\n      ? // ModelOptions is Record<string, unknown> or has index signature - use BaseOptions\n        BaseOptions\n      : // ModelOptions has explicit keys - check if TModel is one of them\n        TModel extends keyof ModelOptions\n        ? ModelOptions[TModel]\n        : BaseOptions\n    : object\n\n/**\n * Extract model-specific size options from an ImageAdapter via ~types.\n * If the model has specific sizes defined, use those; otherwise fall back to string.\n */\nexport type ImageSizeForModel<TAdapter, TModel extends string> =\n  TAdapter extends ImageAdapter<any, any, any, infer SizeByName>\n    ? string extends keyof SizeByName\n      ? // SizeByName has index signature - fall back to string\n        string\n      : // SizeByName has explicit keys - check if TModel is one of them\n        TModel extends keyof SizeByName\n        ? SizeByName[TModel]\n        : string\n    : string\n\n// ===========================\n// Activity Options Type\n// ===========================\n\n/**\n * Options for the image activity.\n * The model is extracted from the adapter's model property.\n *\n * @template TAdapter - The image adapter type\n */\nexport interface ImageActivityOptions<\n  TAdapter extends ImageAdapter<string, object, any, any>,\n> {\n  /** The image adapter to use (must be created with a model) */\n  adapter: TAdapter & { kind: typeof kind }\n  /** Text description of the desired image(s) */\n  prompt: string\n  /** Number of images to generate (default: 1) */\n  numberOfImages?: number\n  /** Image size in WIDTHxHEIGHT format (e.g., \"1024x1024\") */\n  size?: ImageSizeForModel<TAdapter, TAdapter['model']>\n  /** Provider-specific options for image generation */\n  modelOptions?: ImageProviderOptionsForModel<TAdapter, TAdapter['model']>\n}\n\n// ===========================\n// Activity Result Type\n// ===========================\n\n/** Result type for the image activity */\nexport type ImageActivityResult = Promise<ImageGenerationResult>\n\nfunction createId(prefix: string): string {\n  return `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2, 9)}`\n}\n\n// ===========================\n// Activity Implementation\n// ===========================\n\n/**\n * Image activity - generates images from text prompts.\n *\n * Uses AI image generation models to create images based on natural language descriptions.\n *\n * @example Generate a single image\n * ```ts\n * import { generateImage } from '@tanstack/ai'\n * import { openaiImage } from '@tanstack/ai-openai'\n *\n * const result = await generateImage({\n *   adapter: openaiImage('dall-e-3'),\n *   prompt: 'A serene mountain landscape at sunset'\n * })\n *\n * console.log(result.images[0].url)\n * ```\n *\n * @example Generate multiple images\n * ```ts\n * const result = await generateImage({\n *   adapter: openaiImage('dall-e-2'),\n *   prompt: 'A cute robot mascot',\n *   numberOfImages: 4,\n *   size: '512x512'\n * })\n *\n * result.images.forEach((image, i) => {\n *   console.log(`Image ${i + 1}: ${image.url}`)\n * })\n * ```\n *\n * @example With provider-specific options\n * ```ts\n * const result = await generateImage({\n *   adapter: openaiImage('dall-e-3'),\n *   prompt: 'A professional headshot photo',\n *   size: '1024x1024',\n *   modelOptions: {\n *     quality: 'hd',\n *     style: 'natural'\n *   }\n * })\n * ```\n */\nexport async function generateImage<\n  TAdapter extends ImageAdapter<string, object, any, any>,\n>(options: ImageActivityOptions<TAdapter>): ImageActivityResult {\n  const { adapter, ...rest } = options\n  const model = adapter.model\n  const requestId = createId('image')\n  const startTime = Date.now()\n\n  aiEventClient.emit('image:request:started', {\n    requestId,\n    provider: adapter.name,\n    model,\n    prompt: rest.prompt,\n    numberOfImages: rest.numberOfImages,\n    size: rest.size as string | undefined,\n    modelOptions: rest.modelOptions as Record<string, unknown> | undefined,\n    timestamp: startTime,\n  })\n\n  return adapter.generateImages({ ...rest, model }).then((result) => {\n    const duration = Date.now() - startTime\n\n    aiEventClient.emit('image:request:completed', {\n      requestId,\n      provider: adapter.name,\n      model,\n      images: result.images.map((image) => ({\n        url: image.url,\n        b64Json: image.b64Json,\n      })),\n      duration,\n      modelOptions: rest.modelOptions as Record<string, unknown> | undefined,\n      timestamp: Date.now(),\n    })\n\n    if (result.usage) {\n      aiEventClient.emit('image:usage', {\n        requestId,\n        model,\n        usage: result.usage,\n        modelOptions: rest.modelOptions as Record<string, unknown> | undefined,\n        timestamp: Date.now(),\n      })\n    }\n\n    return result\n  })\n}\n\n// ===========================\n// Options Factory\n// ===========================\n\n/**\n * Create typed options for the generateImage() function without executing.\n */\nexport function createImageOptions<\n  TAdapter extends ImageAdapter<string, object, any, any>,\n>(options: ImageActivityOptions<TAdapter>): ImageActivityOptions<TAdapter> {\n  return options\n}\n\n// Re-export adapter types\nexport type {\n  ImageAdapter,\n  ImageAdapterConfig,\n  AnyImageAdapter,\n} from './adapter'\nexport { BaseImageAdapter } from './adapter'\n"],"names":[],"mappings":";AAgBO,MAAM,OAAO;AAqEpB,SAAS,SAAS,QAAwB;AACxC,SAAO,GAAG,MAAM,IAAI,KAAK,IAAA,CAAK,IAAI,KAAK,OAAA,EAAS,SAAS,EAAE,EAAE,MAAM,GAAG,CAAC,CAAC;AAC1E;AAmDA,eAAsB,cAEpB,SAA8D;AAC9D,QAAM,EAAE,SAAS,GAAG,KAAA,IAAS;AAC7B,QAAM,QAAQ,QAAQ;AACtB,QAAM,YAAY,SAAS,OAAO;AAClC,QAAM,YAAY,KAAK,IAAA;AAEvB,gBAAc,KAAK,yBAAyB;AAAA,IAC1C;AAAA,IACA,UAAU,QAAQ;AAAA,IAClB;AAAA,IACA,QAAQ,KAAK;AAAA,IACb,gBAAgB,KAAK;AAAA,IACrB,MAAM,KAAK;AAAA,IACX,cAAc,KAAK;AAAA,IACnB,WAAW;AAAA,EAAA,CACZ;AAED,SAAO,QAAQ,eAAe,EAAE,GAAG,MAAM,OAAO,EAAE,KAAK,CAAC,WAAW;AACjE,UAAM,WAAW,KAAK,IAAA,IAAQ;AAE9B,kBAAc,KAAK,2BAA2B;AAAA,MAC5C;AAAA,MACA,UAAU,QAAQ;AAAA,MAClB;AAAA,MACA,QAAQ,OAAO,OAAO,IAAI,CAAC,WAAW;AAAA,QACpC,KAAK,MAAM;AAAA,QACX,SAAS,MAAM;AAAA,MAAA,EACf;AAAA,MACF;AAAA,MACA,cAAc,KAAK;AAAA,MACnB,WAAW,KAAK,IAAA;AAAA,IAAI,CACrB;AAED,QAAI,OAAO,OAAO;AAChB,oBAAc,KAAK,eAAe;AAAA,QAChC;AAAA,QACA;AAAA,QACA,OAAO,OAAO;AAAA,QACd,cAAc,KAAK;AAAA,QACnB,WAAW,KAAK,IAAA;AAAA,MAAI,CACrB;AAAA,IACH;AAEA,WAAO;AAAA,EACT,CAAC;AACH;AASO,SAAS,mBAEd,SAAyE;AACzE,SAAO;AACT;"}
+{"version":3,"file":"index.js","sources":["../../../../src/activities/generateImage/index.ts"],"sourcesContent":["/**\n * Image Activity\n *\n * Generates images from text prompts.\n * This is a self-contained module with implementation, types, and JSDoc.\n */\n\nimport { aiEventClient } from '../../event-client.js'\nimport type { ImageAdapter } from './adapter'\nimport type { ImageGenerationResult } from '../../types'\n\n// ===========================\n// Activity Kind\n// ===========================\n\n/** The adapter kind this activity handles */\nexport const kind = 'image' as const\n\n// ===========================\n// Type Extraction Helpers\n// ===========================\n\n/**\n * Extract model-specific provider options from an ImageAdapter via ~types.\n * If the model has specific options defined in ModelProviderOptions (and not just via index signature),\n * use those; otherwise fall back to base provider options.\n */\nexport type ImageProviderOptionsForModel<TAdapter, TModel extends string> =\n  TAdapter extends ImageAdapter<any, infer BaseOptions, infer ModelOptions, any>\n    ? string extends keyof ModelOptions\n      ? // ModelOptions is Record<string, unknown> or has index signature - use BaseOptions\n        BaseOptions\n      : // ModelOptions has explicit keys - check if TModel is one of them\n        TModel extends keyof ModelOptions\n        ? ModelOptions[TModel]\n        : BaseOptions\n    : object\n\n/**\n * Extract model-specific size options from an ImageAdapter via ~types.\n * If the model has specific sizes defined, use those; otherwise fall back to string.\n */\nexport type ImageSizeForModel<TAdapter, TModel extends string> =\n  TAdapter extends ImageAdapter<any, any, any, infer SizeByName>\n    ? string extends keyof SizeByName\n      ? // SizeByName has index signature - fall back to string\n        string\n      : // SizeByName has explicit keys - check if TModel is one of them\n        TModel extends keyof SizeByName\n        ? SizeByName[TModel]\n        : string\n    : string\n\n// ===========================\n// Activity Options Type\n// ===========================\n\n/**\n * Options for the image activity.\n * The model is extracted from the adapter's model property.\n *\n * @template TAdapter - The image adapter type\n */\nexport type ImageActivityOptions<\n  TAdapter extends ImageAdapter<string, any, any, any>,\n> = {\n  /** The image adapter to use (must be created with a model) */\n  adapter: TAdapter & { kind: typeof kind }\n  /** Text description of the desired image(s) */\n  prompt: string\n  /** Number of images to generate (default: 1) */\n  numberOfImages?: number\n  /** Image size in WIDTHxHEIGHT format (e.g., \"1024x1024\") */\n  size?: ImageSizeForModel<TAdapter, TAdapter['model']>\n} & ({} extends ImageProviderOptionsForModel<TAdapter, TAdapter['model']>\n  ? {\n      /** Provider-specific options for image generation */ modelOptions?: ImageProviderOptionsForModel<\n        TAdapter,\n        TAdapter['model']\n      >\n    }\n  : {\n      /** Provider-specific options for image generation */ modelOptions: ImageProviderOptionsForModel<\n        TAdapter,\n        TAdapter['model']\n      >\n    })\n\n// ===========================\n// Activity Result Type\n// ===========================\n\n/** Result type for the image activity */\nexport type ImageActivityResult = Promise<ImageGenerationResult>\n\nfunction createId(prefix: string): string {\n  return `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2, 9)}`\n}\n\n// ===========================\n// Activity Implementation\n// ===========================\n\n/**\n * Image activity - generates images from text prompts.\n *\n * Uses AI image generation models to create images based on natural language descriptions.\n *\n * @example Generate a single image\n * ```ts\n * import { generateImage } from '@tanstack/ai'\n * import { openaiImage } from '@tanstack/ai-openai'\n *\n * const result = await generateImage({\n *   adapter: openaiImage('dall-e-3'),\n *   prompt: 'A serene mountain landscape at sunset'\n * })\n *\n * console.log(result.images[0].url)\n * ```\n *\n * @example Generate multiple images\n * ```ts\n * const result = await generateImage({\n *   adapter: openaiImage('dall-e-2'),\n *   prompt: 'A cute robot mascot',\n *   numberOfImages: 4,\n *   size: '512x512'\n * })\n *\n * result.images.forEach((image, i) => {\n *   console.log(`Image ${i + 1}: ${image.url}`)\n * })\n * ```\n *\n * @example With provider-specific options\n * ```ts\n * const result = await generateImage({\n *   adapter: openaiImage('dall-e-3'),\n *   prompt: 'A professional headshot photo',\n *   size: '1024x1024',\n *   modelOptions: {\n *     quality: 'hd',\n *     style: 'natural'\n *   }\n * })\n * ```\n */\nexport async function generateImage<\n  TAdapter extends ImageAdapter<string, any, any, any>,\n>(options: ImageActivityOptions<TAdapter>): ImageActivityResult {\n  const { adapter, ...rest } = options\n  const model = adapter.model\n  const requestId = createId('image')\n  const startTime = Date.now()\n\n  aiEventClient.emit('image:request:started', {\n    requestId,\n    provider: adapter.name,\n    model,\n    prompt: rest.prompt,\n    numberOfImages: rest.numberOfImages,\n    size: rest.size,\n    modelOptions: rest.modelOptions as Record<string, unknown> | undefined,\n    timestamp: startTime,\n  })\n\n  return adapter.generateImages({ ...rest, model }).then((result) => {\n    const duration = Date.now() - startTime\n\n    aiEventClient.emit('image:request:completed', {\n      requestId,\n      provider: adapter.name,\n      model,\n      images: result.images.map((image) => ({\n        url: image.url,\n        b64Json: image.b64Json,\n      })),\n      duration,\n      modelOptions: rest.modelOptions as Record<string, unknown> | undefined,\n      timestamp: Date.now(),\n    })\n\n    if (result.usage) {\n      aiEventClient.emit('image:usage', {\n        requestId,\n        model,\n        usage: result.usage,\n        modelOptions: rest.modelOptions as Record<string, unknown> | undefined,\n        timestamp: Date.now(),\n      })\n    }\n\n    return result\n  })\n}\n\n// ===========================\n// Options Factory\n// ===========================\n\n/**\n * Create typed options for the generateImage() function without executing.\n */\nexport function createImageOptions<\n  TAdapter extends ImageAdapter<string, any, any, any>,\n>(options: ImageActivityOptions<TAdapter>): ImageActivityOptions<TAdapter> {\n  return options\n}\n\n// Re-export adapter types\nexport type {\n  ImageAdapter,\n  ImageAdapterConfig,\n  AnyImageAdapter,\n} from './adapter'\nexport { BaseImageAdapter } from './adapter'\n"],"names":[],"mappings":";AAgBO,MAAM,OAAO;AA+EpB,SAAS,SAAS,QAAwB;AACxC,SAAO,GAAG,MAAM,IAAI,KAAK,IAAA,CAAK,IAAI,KAAK,OAAA,EAAS,SAAS,EAAE,EAAE,MAAM,GAAG,CAAC,CAAC;AAC1E;AAmDA,eAAsB,cAEpB,SAA8D;AAC9D,QAAM,EAAE,SAAS,GAAG,KAAA,IAAS;AAC7B,QAAM,QAAQ,QAAQ;AACtB,QAAM,YAAY,SAAS,OAAO;AAClC,QAAM,YAAY,KAAK,IAAA;AAEvB,gBAAc,KAAK,yBAAyB;AAAA,IAC1C;AAAA,IACA,UAAU,QAAQ;AAAA,IAClB;AAAA,IACA,QAAQ,KAAK;AAAA,IACb,gBAAgB,KAAK;AAAA,IACrB,MAAM,KAAK;AAAA,IACX,cAAc,KAAK;AAAA,IACnB,WAAW;AAAA,EAAA,CACZ;AAED,SAAO,QAAQ,eAAe,EAAE,GAAG,MAAM,OAAO,EAAE,KAAK,CAAC,WAAW;AACjE,UAAM,WAAW,KAAK,IAAA,IAAQ;AAE9B,kBAAc,KAAK,2BAA2B;AAAA,MAC5C;AAAA,MACA,UAAU,QAAQ;AAAA,MAClB;AAAA,MACA,QAAQ,OAAO,OAAO,IAAI,CAAC,WAAW;AAAA,QACpC,KAAK,MAAM;AAAA,QACX,SAAS,MAAM;AAAA,MAAA,EACf;AAAA,MACF;AAAA,MACA,cAAc,KAAK;AAAA,MACnB,WAAW,KAAK,IAAA;AAAA,IAAI,CACrB;AAED,QAAI,OAAO,OAAO;AAChB,oBAAc,KAAK,eAAe;AAAA,QAChC;AAAA,QACA;AAAA,QACA,OAAO,OAAO;AAAA,QACd,cAAc,KAAK;AAAA,QACnB,WAAW,KAAK,IAAA;AAAA,MAAI,CACrB;AAAA,IACH;AAEA,WAAO;AAAA,EACT,CAAC;AACH;AASO,SAAS,mBAEd,SAAyE;AACzE,SAAO;AACT;"}

package/dist/esm/activities/generateVideo/adapter.d.ts

@@ -22,8 +22,10 @@ export interface VideoAdapterConfig {
  * Generic parameters:
  * - TModel: The specific model name (e.g., 'sora-2')
  * - TProviderOptions: Provider-specific options (already resolved)
+ * - TModelProviderOptionsByName: Map from model name to its specific provider options
+ * - TModelSizeByName: Map from model name to its supported sizes
  */
-export interface VideoAdapter<TModel extends string = string, TProviderOptions extends object = Record<string, unknown>> {
+export interface VideoAdapter<TModel extends string = string, TProviderOptions extends object = Record<string, unknown>, TModelProviderOptionsByName extends Record<string, any> = Record<string, any>, TModelSizeByName extends Record<string, string> = Record<string, string>> {
     /** Discriminator for adapter kind - used to determine API shape */
     readonly kind: 'video';
     /** Adapter name identifier */
@@ -35,12 +37,14 @@ export interface VideoAdapter<TModel extends string = string, TProviderOptions e
      */
     '~types': {
         providerOptions: TProviderOptions;
+        modelProviderOptionsByName: TModelProviderOptionsByName;
+        modelSizeByName: TModelSizeByName;
     };
     /**
      * Create a new video generation job.
      * Returns a job ID that can be used to poll for status and retrieve the video.
      */
-    createVideoJob: (options: VideoGenerationOptions<TProviderOptions>) => Promise<VideoJobResult>;
+    createVideoJob: (options: VideoGenerationOptions<TProviderOptions, TModelSizeByName[TModel]>) => Promise<VideoJobResult>;
     /**
      * Get the current status of a video generation job.
      */
@@ -55,7 +59,7 @@ export interface VideoAdapter<TModel extends string = string, TProviderOptions e
  * A VideoAdapter with any/unknown type parameters.
  * Useful as a constraint in generic functions and interfaces.
  */
-export type AnyVideoAdapter = VideoAdapter<any, any>;
+export type AnyVideoAdapter = VideoAdapter<any, any, any, any>;
 /**
  * Abstract base class for video generation adapters.
  * Extend this class to implement a video adapter for a specific provider.
@@ -64,16 +68,18 @@ export type AnyVideoAdapter = VideoAdapter<any, any>;
  *
  * Generic parameters match VideoAdapter - all pre-resolved by the provider function.
  */
-export declare abstract class BaseVideoAdapter<TModel extends string = string, TProviderOptions extends object = Record<string, unknown>> implements VideoAdapter<TModel, TProviderOptions> {
+export declare abstract class BaseVideoAdapter<TModel extends string = string, TProviderOptions extends object = Record<string, unknown>, TModelProviderOptionsByName extends Record<string, any> = Record<string, any>, TModelSizeByName extends Record<string, string> = Record<string, string>> implements VideoAdapter<TModel, TProviderOptions, TModelProviderOptionsByName, TModelSizeByName> {
     readonly kind: "video";
     abstract readonly name: string;
     readonly model: TModel;
     '~types': {
         providerOptions: TProviderOptions;
+        modelProviderOptionsByName: TModelProviderOptionsByName;
+        modelSizeByName: TModelSizeByName;
     };
     protected config: VideoAdapterConfig;
     constructor(config: VideoAdapterConfig | undefined, model: TModel);
-    abstract createVideoJob(options: VideoGenerationOptions<TProviderOptions>): Promise<VideoJobResult>;
+    abstract createVideoJob(options: VideoGenerationOptions<TProviderOptions, TModelSizeByName[TModel]>): Promise<VideoJobResult>;
     abstract getVideoStatus(jobId: string): Promise<VideoStatusResult>;
     abstract getVideoUrl(jobId: string): Promise<VideoUrlResult>;
     protected generateId(): string;

package/dist/esm/activities/generateVideo/adapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"adapter.js","sources":["../../../../src/activities/generateVideo/adapter.ts"],"sourcesContent":["import type {\n  VideoGenerationOptions,\n  VideoJobResult,\n  VideoStatusResult,\n  VideoUrlResult,\n} from '../../types'\n\n/**\n * Configuration for video adapter instances\n *\n * @experimental Video generation is an experimental feature and may change.\n */\nexport interface VideoAdapterConfig {\n  apiKey?: string\n  baseUrl?: string\n  timeout?: number\n  maxRetries?: number\n  headers?: Record<string, string>\n}\n\n/**\n * Video adapter interface with pre-resolved generics.\n *\n * An adapter is created by a provider function: `provider('model')` → `adapter`\n * All type resolution happens at the provider call site, not in this interface.\n *\n * @experimental Video generation is an experimental feature and may change.\n *\n * Generic parameters:\n * - TModel: The specific model name (e.g., 'sora-2')\n * - TProviderOptions: Provider-specific options (already resolved)\n */\nexport interface VideoAdapter<\n  TModel extends string = string,\n  TProviderOptions extends object = Record<string, unknown>,\n> {\n  /** Discriminator for adapter kind - used to determine API shape */\n  readonly kind: 'video'\n  /** Adapter name identifier */\n  readonly name: string\n  /** The model this adapter is configured for */\n  readonly model: TModel\n\n  /**\n   * @internal Type-only properties for inference. Not assigned at runtime.\n   */\n  '~types': {\n    providerOptions: TProviderOptions\n  }\n\n  /**\n   * Create a new video generation job.\n   * Returns a job ID that can be used to poll for status and retrieve the video.\n   */\n  createVideoJob: (\n    options: VideoGenerationOptions<TProviderOptions>,\n  ) => Promise<VideoJobResult>\n\n  /**\n   * Get the current status of a video generation job.\n   */\n  getVideoStatus: (jobId: string) => Promise<VideoStatusResult>\n\n  /**\n   * Get the URL to download/view the generated video.\n   * Should only be called after status is 'completed'.\n   */\n  getVideoUrl: (jobId: string) => Promise<VideoUrlResult>\n}\n\n/**\n * A VideoAdapter with any/unknown type parameters.\n * Useful as a constraint in generic functions and interfaces.\n */\nexport type AnyVideoAdapter = VideoAdapter<any, any>\n\n/**\n * Abstract base class for video generation adapters.\n * Extend this class to implement a video adapter for a specific provider.\n *\n * @experimental Video generation is an experimental feature and may change.\n *\n * Generic parameters match VideoAdapter - all pre-resolved by the provider function.\n */\nexport abstract class BaseVideoAdapter<\n  TModel extends string = string,\n  TProviderOptions extends object = Record<string, unknown>,\n> implements VideoAdapter<TModel, TProviderOptions> {\n  readonly kind = 'video' as const\n  abstract readonly name: string\n  readonly model: TModel\n\n  // Type-only property - never assigned at runtime\n  declare '~types': {\n    providerOptions: TProviderOptions\n  }\n\n  protected config: VideoAdapterConfig\n\n  constructor(config: VideoAdapterConfig = {}, model: TModel) {\n    this.config = config\n    this.model = model\n  }\n\n  abstract createVideoJob(\n    options: VideoGenerationOptions<TProviderOptions>,\n  ): Promise<VideoJobResult>\n\n  abstract getVideoStatus(jobId: string): Promise<VideoStatusResult>\n\n  abstract getVideoUrl(jobId: string): Promise<VideoUrlResult>\n\n  protected generateId(): string {\n    return `${this.name}-${Date.now()}-${Math.random().toString(36).substring(7)}`\n  }\n}\n"],"names":[],"mappings":"AAoFO,MAAe,iBAG8B;AAAA,EAYlD,YAAY,SAA6B,CAAA,GAAI,OAAe;AAX5D,SAAS,OAAO;AAYd,SAAK,SAAS;AACd,SAAK,QAAQ;AAAA,EACf;AAAA,EAUU,aAAqB;AAC7B,WAAO,GAAG,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,KAAK,OAAA,EAAS,SAAS,EAAE,EAAE,UAAU,CAAC,CAAC;AAAA,EAC9E;AACF;"}
+{"version":3,"file":"adapter.js","sources":["../../../../src/activities/generateVideo/adapter.ts"],"sourcesContent":["import type {\n  VideoGenerationOptions,\n  VideoJobResult,\n  VideoStatusResult,\n  VideoUrlResult,\n} from '../../types'\n\n/**\n * Configuration for video adapter instances\n *\n * @experimental Video generation is an experimental feature and may change.\n */\nexport interface VideoAdapterConfig {\n  apiKey?: string\n  baseUrl?: string\n  timeout?: number\n  maxRetries?: number\n  headers?: Record<string, string>\n}\n\n/**\n * Video adapter interface with pre-resolved generics.\n *\n * An adapter is created by a provider function: `provider('model')` → `adapter`\n * All type resolution happens at the provider call site, not in this interface.\n *\n * @experimental Video generation is an experimental feature and may change.\n *\n * Generic parameters:\n * - TModel: The specific model name (e.g., 'sora-2')\n * - TProviderOptions: Provider-specific options (already resolved)\n * - TModelProviderOptionsByName: Map from model name to its specific provider options\n * - TModelSizeByName: Map from model name to its supported sizes\n */\nexport interface VideoAdapter<\n  TModel extends string = string,\n  TProviderOptions extends object = Record<string, unknown>,\n  TModelProviderOptionsByName extends Record<string, any> = Record<string, any>,\n  TModelSizeByName extends Record<string, string> = Record<string, string>,\n> {\n  /** Discriminator for adapter kind - used to determine API shape */\n  readonly kind: 'video'\n  /** Adapter name identifier */\n  readonly name: string\n  /** The model this adapter is configured for */\n  readonly model: TModel\n\n  /**\n   * @internal Type-only properties for inference. Not assigned at runtime.\n   */\n  '~types': {\n    providerOptions: TProviderOptions\n    modelProviderOptionsByName: TModelProviderOptionsByName\n    modelSizeByName: TModelSizeByName\n  }\n\n  /**\n   * Create a new video generation job.\n   * Returns a job ID that can be used to poll for status and retrieve the video.\n   */\n  createVideoJob: (\n    options: VideoGenerationOptions<TProviderOptions, TModelSizeByName[TModel]>,\n  ) => Promise<VideoJobResult>\n\n  /**\n   * Get the current status of a video generation job.\n   */\n  getVideoStatus: (jobId: string) => Promise<VideoStatusResult>\n\n  /**\n   * Get the URL to download/view the generated video.\n   * Should only be called after status is 'completed'.\n   */\n  getVideoUrl: (jobId: string) => Promise<VideoUrlResult>\n}\n\n/**\n * A VideoAdapter with any/unknown type parameters.\n * Useful as a constraint in generic functions and interfaces.\n */\nexport type AnyVideoAdapter = VideoAdapter<any, any, any, any>\n\n/**\n * Abstract base class for video generation adapters.\n * Extend this class to implement a video adapter for a specific provider.\n *\n * @experimental Video generation is an experimental feature and may change.\n *\n * Generic parameters match VideoAdapter - all pre-resolved by the provider function.\n */\nexport abstract class BaseVideoAdapter<\n  TModel extends string = string,\n  TProviderOptions extends object = Record<string, unknown>,\n  TModelProviderOptionsByName extends Record<string, any> = Record<string, any>,\n  TModelSizeByName extends Record<string, string> = Record<string, string>,\n> implements VideoAdapter<\n  TModel,\n  TProviderOptions,\n  TModelProviderOptionsByName,\n  TModelSizeByName\n> {\n  readonly kind = 'video' as const\n  abstract readonly name: string\n  readonly model: TModel\n\n  // Type-only property - never assigned at runtime\n  declare '~types': {\n    providerOptions: TProviderOptions\n    modelProviderOptionsByName: TModelProviderOptionsByName\n    modelSizeByName: TModelSizeByName\n  }\n\n  protected config: VideoAdapterConfig\n\n  constructor(config: VideoAdapterConfig = {}, model: TModel) {\n    this.config = config\n    this.model = model\n  }\n\n  abstract createVideoJob(\n    options: VideoGenerationOptions<TProviderOptions, TModelSizeByName[TModel]>,\n  ): Promise<VideoJobResult>\n\n  abstract getVideoStatus(jobId: string): Promise<VideoStatusResult>\n\n  abstract getVideoUrl(jobId: string): Promise<VideoUrlResult>\n\n  protected generateId(): string {\n    return `${this.name}-${Date.now()}-${Math.random().toString(36).substring(7)}`\n  }\n}\n"],"names":[],"mappings":"AA0FO,MAAe,iBAUpB;AAAA,EAcA,YAAY,SAA6B,CAAA,GAAI,OAAe;AAb5D,SAAS,OAAO;AAcd,SAAK,SAAS;AACd,SAAK,QAAQ;AAAA,EACf;AAAA,EAUU,aAAqB;AAC7B,WAAO,GAAG,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,KAAK,OAAA,EAAS,SAAS,EAAE,EAAE,UAAU,CAAC,CAAC;AAAA,EAC9E;AACF;"}

package/dist/esm/activities/generateVideo/index.d.ts

@@ -5,12 +5,16 @@ export declare const kind: "video";
 /**
  * Extract provider options from a VideoAdapter via ~types.
  */
-export type VideoProviderOptions<TAdapter> = TAdapter extends VideoAdapter<any, any> ? TAdapter['~types']['providerOptions'] : object;
+export type VideoProviderOptions<TAdapter> = TAdapter extends VideoAdapter<any, any, any, any> ? TAdapter['~types']['providerOptions'] : object;
+/**
+ * Extract the size type for a VideoAdapter's model via ~types.
+ */
+export type VideoSizeForAdapter<TAdapter> = TAdapter extends VideoAdapter<infer TModel, any, any, infer TSizeMap> ? TModel extends keyof TSizeMap ? TSizeMap[TModel] : string : string;
 /**
  * Base options shared by all video activity operations.
  * The model is extracted from the adapter's model property.
  */
-interface VideoActivityBaseOptions<TAdapter extends VideoAdapter<string, object>> {
+interface VideoActivityBaseOptions<TAdapter extends VideoAdapter<string, any, any, any>> {
     /** The video adapter to use (must be created with a model) */
     adapter: TAdapter & {
         kind: typeof kind;
@@ -22,24 +26,26 @@ interface VideoActivityBaseOptions<TAdapter extends VideoAdapter<string, object>
  *
  * @experimental Video generation is an experimental feature and may change.
  */
-export interface VideoCreateOptions<TAdapter extends VideoAdapter<string, object>> extends VideoActivityBaseOptions<TAdapter> {
+export type VideoCreateOptions<TAdapter extends VideoAdapter<string, any, any, any>> = VideoActivityBaseOptions<TAdapter> & {
     /** Request type - create a new job (default if not specified) */
     request?: 'create';
     /** Text description of the desired video */
     prompt: string;
-    /** Video size in WIDTHxHEIGHT format (e.g., "1280x720") */
-    size?: string;
+    /** Video size — format depends on the provider (e.g., "16:9", "1280x720") */
+    size?: VideoSizeForAdapter<TAdapter>;
     /** Video duration in seconds */
     duration?: number;
-    /** Provider-specific options for video generation */
-    modelOptions?: VideoProviderOptions<TAdapter>;
-}
+} & ({} extends VideoProviderOptions<TAdapter> ? {
+    /** Provider-specific options for video generation */ modelOptions?: VideoProviderOptions<TAdapter>;
+} : {
+    /** Provider-specific options for video generation */ modelOptions: VideoProviderOptions<TAdapter>;
+});
 /**
  * Options for polling the status of a video generation job.
  *
  * @experimental Video generation is an experimental feature and may change.
  */
-export interface VideoStatusOptions<TAdapter extends VideoAdapter<string, object>> extends VideoActivityBaseOptions<TAdapter> {
+export interface VideoStatusOptions<TAdapter extends VideoAdapter<string, any, any, any>> extends VideoActivityBaseOptions<TAdapter> {
     /** Request type - get job status */
     request: 'status';
     /** The job ID to check status for */
@@ -50,7 +56,7 @@ export interface VideoStatusOptions<TAdapter extends VideoAdapter<string, object
  *
  * @experimental Video generation is an experimental feature and may change.
  */
-export interface VideoUrlOptions<TAdapter extends VideoAdapter<string, object>> extends VideoActivityBaseOptions<TAdapter> {
+export interface VideoUrlOptions<TAdapter extends VideoAdapter<string, any, any, any>> extends VideoActivityBaseOptions<TAdapter> {
     /** Request type - get video URL */
     request: 'url';
     /** The job ID to get URL for */
@@ -62,7 +68,7 @@ export interface VideoUrlOptions<TAdapter extends VideoAdapter<string, object>>
  *
  * @experimental Video generation is an experimental feature and may change.
  */
-export type VideoActivityOptions<TAdapter extends VideoAdapter<string, object>, TRequest extends 'create' | 'status' | 'url' = 'create'> = TRequest extends 'status' ? VideoStatusOptions<TAdapter> : TRequest extends 'url' ? VideoUrlOptions<TAdapter> : VideoCreateOptions<TAdapter>;
+export type VideoActivityOptions<TAdapter extends VideoAdapter<string, any, any, any>, TRequest extends 'create' | 'status' | 'url' = 'create'> = TRequest extends 'status' ? VideoStatusOptions<TAdapter> : TRequest extends 'url' ? VideoUrlOptions<TAdapter> : VideoCreateOptions<TAdapter>;
 /**
  * Result type for the video activity, based on request type.
  *
@@ -91,7 +97,7 @@ export type VideoActivityResult<TRequest extends 'create' | 'status' | 'url' = '
  * console.log('Job started:', jobId)
  * ```
  */
-export declare function generateVideo<TAdapter extends VideoAdapter<string, object>>(options: VideoCreateOptions<TAdapter>): Promise<VideoJobResult>;
+export declare function generateVideo<TAdapter extends VideoAdapter<string, any, any, any>>(options: VideoCreateOptions<TAdapter>): Promise<VideoJobResult>;
 /**
  * Get video job status - returns the current status, progress, and URL if available.
  *
@@ -117,7 +123,7 @@ export declare function generateVideo<TAdapter extends VideoAdapter<string, obje
  * }
  * ```
  */
-export declare function getVideoJobStatus<TAdapter extends VideoAdapter<string, object>>(options: {
+export declare function getVideoJobStatus<TAdapter extends VideoAdapter<string, any, any, any>>(options: {
     adapter: TAdapter & {
         kind: typeof kind;
     };
@@ -131,6 +137,6 @@ export declare function getVideoJobStatus<TAdapter extends VideoAdapter<string,
 /**
  * Create typed options for the generateVideo() function without executing.
  */
-export declare function createVideoOptions<TAdapter extends VideoAdapter<string, object>>(options: VideoCreateOptions<TAdapter>): VideoCreateOptions<TAdapter>;
+export declare function createVideoOptions<TAdapter extends VideoAdapter<string, any, any, any>>(options: VideoCreateOptions<TAdapter>): VideoCreateOptions<TAdapter>;
 export type { VideoAdapter, VideoAdapterConfig, AnyVideoAdapter, } from './adapter.js';
 export { BaseVideoAdapter } from './adapter.js';

package/dist/esm/activities/generateVideo/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../../src/activities/generateVideo/index.ts"],"sourcesContent":["/**\n * Video Activity (Experimental)\n *\n * Generates videos from text prompts using a jobs/polling architecture.\n * This is a self-contained module with implementation, types, and JSDoc.\n *\n * @experimental Video generation is an experimental feature and may change.\n */\n\nimport { aiEventClient } from '../../event-client.js'\nimport type { VideoAdapter } from './adapter'\nimport type {\n  VideoJobResult,\n  VideoStatusResult,\n  VideoUrlResult,\n} from '../../types'\n\n// ===========================\n// Activity Kind\n// ===========================\n\n/** The adapter kind this activity handles */\nexport const kind = 'video' as const\n\n// ===========================\n// Type Extraction Helpers\n// ===========================\n\n/**\n * Extract provider options from a VideoAdapter via ~types.\n */\nexport type VideoProviderOptions<TAdapter> =\n  TAdapter extends VideoAdapter<any, any>\n    ? TAdapter['~types']['providerOptions']\n    : object\n\n// ===========================\n// Activity Options Types\n\nfunction createId(prefix: string): string {\n  return `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2, 9)}`\n}\n// ===========================\n\n/**\n * Base options shared by all video activity operations.\n * The model is extracted from the adapter's model property.\n */\ninterface VideoActivityBaseOptions<\n  TAdapter extends VideoAdapter<string, object>,\n> {\n  /** The video adapter to use (must be created with a model) */\n  adapter: TAdapter & { kind: typeof kind }\n}\n\n/**\n * Options for creating a new video generation job.\n * The model is extracted from the adapter's model property.\n *\n * @experimental Video generation is an experimental feature and may change.\n */\nexport interface VideoCreateOptions<\n  TAdapter extends VideoAdapter<string, object>,\n> extends VideoActivityBaseOptions<TAdapter> {\n  /** Request type - create a new job (default if not specified) */\n  request?: 'create'\n  /** Text description of the desired video */\n  prompt: string\n  /** Video size in WIDTHxHEIGHT format (e.g., \"1280x720\") */\n  size?: string\n  /** Video duration in seconds */\n  duration?: number\n  /** Provider-specific options for video generation */\n  modelOptions?: VideoProviderOptions<TAdapter>\n}\n\n/**\n * Options for polling the status of a video generation job.\n *\n * @experimental Video generation is an experimental feature and may change.\n */\nexport interface VideoStatusOptions<\n  TAdapter extends VideoAdapter<string, object>,\n> extends VideoActivityBaseOptions<TAdapter> {\n  /** Request type - get job status */\n  request: 'status'\n  /** The job ID to check status for */\n  jobId: string\n}\n\n/**\n * Options for getting the URL of a completed video.\n *\n * @experimental Video generation is an experimental feature and may change.\n */\nexport interface VideoUrlOptions<\n  TAdapter extends VideoAdapter<string, object>,\n> extends VideoActivityBaseOptions<TAdapter> {\n  /** Request type - get video URL */\n  request: 'url'\n  /** The job ID to get URL for */\n  jobId: string\n}\n\n/**\n * Union type for all video activity options.\n * Discriminated by the `request` field.\n *\n * @experimental Video generation is an experimental feature and may change.\n */\nexport type VideoActivityOptions<\n  TAdapter extends VideoAdapter<string, object>,\n  TRequest extends 'create' | 'status' | 'url' = 'create',\n> = TRequest extends 'status'\n  ? VideoStatusOptions<TAdapter>\n  : TRequest extends 'url'\n    ? VideoUrlOptions<TAdapter>\n    : VideoCreateOptions<TAdapter>\n\n// ===========================\n// Activity Result Types\n// ===========================\n\n/**\n * Result type for the video activity, based on request type.\n *\n * @experimental Video generation is an experimental feature and may change.\n */\nexport type VideoActivityResult<\n  TRequest extends 'create' | 'status' | 'url' = 'create',\n> = TRequest extends 'status'\n  ? Promise<VideoStatusResult>\n  : TRequest extends 'url'\n    ? Promise<VideoUrlResult>\n    : Promise<VideoJobResult>\n\n// ===========================\n// Activity Implementation\n// ===========================\n\n/**\n * Generate video - creates a video generation job from a text prompt.\n *\n * Uses AI video generation models to create videos based on natural language descriptions.\n * Unlike image generation, video generation is asynchronous and requires polling for completion.\n *\n * @experimental Video generation is an experimental feature and may change.\n *\n * @example Create a video generation job\n * ```ts\n * import { generateVideo } from '@tanstack/ai'\n * import { openaiVideo } from '@tanstack/ai-openai'\n *\n * // Start a video generation job\n * const { jobId } = await generateVideo({\n *   adapter: openaiVideo('sora-2'),\n *   prompt: 'A cat chasing a dog in a sunny park'\n * })\n *\n * console.log('Job started:', jobId)\n * ```\n */\nexport async function generateVideo<\n  TAdapter extends VideoAdapter<string, object>,\n>(options: VideoCreateOptions<TAdapter>): Promise<VideoJobResult> {\n  const { adapter, prompt, size, duration, modelOptions } = options\n  const model = adapter.model\n\n  return adapter.createVideoJob({\n    model,\n    prompt,\n    size,\n    duration,\n    modelOptions,\n  })\n}\n\n/**\n * Get video job status - returns the current status, progress, and URL if available.\n *\n * This function combines status checking and URL retrieval. If the job is completed,\n * it will automatically fetch and include the video URL.\n *\n * @experimental Video generation is an experimental feature and may change.\n *\n * @example Check job status\n * ```ts\n * import { getVideoJobStatus } from '@tanstack/ai'\n * import { openaiVideo } from '@tanstack/ai-openai'\n *\n * const result = await getVideoJobStatus({\n *   adapter: openaiVideo('sora-2'),\n *   jobId: 'job-123'\n * })\n *\n * console.log('Status:', result.status)\n * console.log('Progress:', result.progress)\n * if (result.url) {\n *   console.log('Video URL:', result.url)\n * }\n * ```\n */\nexport async function getVideoJobStatus<\n  TAdapter extends VideoAdapter<string, object>,\n>(options: {\n  adapter: TAdapter & { kind: typeof kind }\n  jobId: string\n}): Promise<{\n  status: 'pending' | 'processing' | 'completed' | 'failed'\n  progress?: number\n  url?: string\n  error?: string\n}> {\n  const { adapter, jobId } = options\n  const requestId = createId('video-status')\n  const startTime = Date.now()\n\n  aiEventClient.emit('video:request:started', {\n    requestId,\n    provider: adapter.name,\n    model: adapter.model,\n    requestType: 'status',\n    jobId,\n    timestamp: startTime,\n  })\n\n  // Get status first\n  const statusResult = await adapter.getVideoStatus(jobId)\n\n  // If completed, also get the URL\n  if (statusResult.status === 'completed') {\n    try {\n      const urlResult = await adapter.getVideoUrl(jobId)\n      aiEventClient.emit('video:request:completed', {\n        requestId,\n        provider: adapter.name,\n        model: adapter.model,\n        requestType: 'status',\n        jobId,\n        status: statusResult.status,\n        progress: statusResult.progress,\n        url: urlResult.url,\n        duration: Date.now() - startTime,\n        timestamp: Date.now(),\n      })\n      return {\n        status: statusResult.status,\n        progress: statusResult.progress,\n        url: urlResult.url,\n      }\n    } catch (error) {\n      aiEventClient.emit('video:request:completed', {\n        requestId,\n        provider: adapter.name,\n        model: adapter.model,\n        requestType: 'status',\n        jobId,\n        status: statusResult.status,\n        progress: statusResult.progress,\n        error:\n          error instanceof Error ? error.message : 'Failed to get video URL',\n        duration: Date.now() - startTime,\n        timestamp: Date.now(),\n      })\n      // If URL fetch fails, still return status\n      return {\n        status: statusResult.status,\n        progress: statusResult.progress,\n        error:\n          error instanceof Error ? error.message : 'Failed to get video URL',\n      }\n    }\n  }\n\n  aiEventClient.emit('video:request:completed', {\n    requestId,\n    provider: adapter.name,\n    model: adapter.model,\n    requestType: 'status',\n    jobId,\n    status: statusResult.status,\n    progress: statusResult.progress,\n    error: statusResult.error,\n    duration: Date.now() - startTime,\n    timestamp: Date.now(),\n  })\n\n  // Return status for non-completed jobs\n  return {\n    status: statusResult.status,\n    progress: statusResult.progress,\n    error: statusResult.error,\n  }\n}\n\n// ===========================\n// Options Factory\n// ===========================\n\n/**\n * Create typed options for the generateVideo() function without executing.\n */\nexport function createVideoOptions<\n  TAdapter extends VideoAdapter<string, object>,\n>(options: VideoCreateOptions<TAdapter>): VideoCreateOptions<TAdapter> {\n  return options\n}\n\n// Re-export adapter types\nexport type {\n  VideoAdapter,\n  VideoAdapterConfig,\n  AnyVideoAdapter,\n} from './adapter'\nexport { BaseVideoAdapter } from './adapter'\n"],"names":[],"mappings":";AAsBO,MAAM,OAAO;AAiBpB,SAAS,SAAS,QAAwB;AACxC,SAAO,GAAG,MAAM,IAAI,KAAK,IAAA,CAAK,IAAI,KAAK,OAAA,EAAS,SAAS,EAAE,EAAE,MAAM,GAAG,CAAC,CAAC;AAC1E;AAyHA,eAAsB,cAEpB,SAAgE;AAChE,QAAM,EAAE,SAAS,QAAQ,MAAM,UAAU,iBAAiB;AAC1D,QAAM,QAAQ,QAAQ;AAEtB,SAAO,QAAQ,eAAe;AAAA,IAC5B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA,CACD;AACH;AA2BA,eAAsB,kBAEpB,SAQC;AACD,QAAM,EAAE,SAAS,MAAA,IAAU;AAC3B,QAAM,YAAY,SAAS,cAAc;AACzC,QAAM,YAAY,KAAK,IAAA;AAEvB,gBAAc,KAAK,yBAAyB;AAAA,IAC1C;AAAA,IACA,UAAU,QAAQ;AAAA,IAClB,OAAO,QAAQ;AAAA,IACf,aAAa;AAAA,IACb;AAAA,IACA,WAAW;AAAA,EAAA,CACZ;AAGD,QAAM,eAAe,MAAM,QAAQ,eAAe,KAAK;AAGvD,MAAI,aAAa,WAAW,aAAa;AACvC,QAAI;AACF,YAAM,YAAY,MAAM,QAAQ,YAAY,KAAK;AACjD,oBAAc,KAAK,2BAA2B;AAAA,QAC5C;AAAA,QACA,UAAU,QAAQ;AAAA,QAClB,OAAO,QAAQ;AAAA,QACf,aAAa;AAAA,QACb;AAAA,QACA,QAAQ,aAAa;AAAA,QACrB,UAAU,aAAa;AAAA,QACvB,KAAK,UAAU;AAAA,QACf,UAAU,KAAK,IAAA,IAAQ;AAAA,QACvB,WAAW,KAAK,IAAA;AAAA,MAAI,CACrB;AACD,aAAO;AAAA,QACL,QAAQ,aAAa;AAAA,QACrB,UAAU,aAAa;AAAA,QACvB,KAAK,UAAU;AAAA,MAAA;AAAA,IAEnB,SAAS,OAAO;AACd,oBAAc,KAAK,2BAA2B;AAAA,QAC5C;AAAA,QACA,UAAU,QAAQ;AAAA,QAClB,OAAO,QAAQ;AAAA,QACf,aAAa;AAAA,QACb;AAAA,QACA,QAAQ,aAAa;AAAA,QACrB,UAAU,aAAa;AAAA,QACvB,OACE,iBAAiB,QAAQ,MAAM,UAAU;AAAA,QAC3C,UAAU,KAAK,IAAA,IAAQ;AAAA,QACvB,WAAW,KAAK,IAAA;AAAA,MAAI,CACrB;AAED,aAAO;AAAA,QACL,QAAQ,aAAa;AAAA,QACrB,UAAU,aAAa;AAAA,QACvB,OACE,iBAAiB,QAAQ,MAAM,UAAU;AAAA,MAAA;AAAA,IAE/C;AAAA,EACF;AAEA,gBAAc,KAAK,2BAA2B;AAAA,IAC5C;AAAA,IACA,UAAU,QAAQ;AAAA,IAClB,OAAO,QAAQ;AAAA,IACf,aAAa;AAAA,IACb;AAAA,IACA,QAAQ,aAAa;AAAA,IACrB,UAAU,aAAa;AAAA,IACvB,OAAO,aAAa;AAAA,IACpB,UAAU,KAAK,IAAA,IAAQ;AAAA,IACvB,WAAW,KAAK,IAAA;AAAA,EAAI,CACrB;AAGD,SAAO;AAAA,IACL,QAAQ,aAAa;AAAA,IACrB,UAAU,aAAa;AAAA,IACvB,OAAO,aAAa;AAAA,EAAA;AAExB;AASO,SAAS,mBAEd,SAAqE;AACrE,SAAO;AACT;"}
+{"version":3,"file":"index.js","sources":["../../../../src/activities/generateVideo/index.ts"],"sourcesContent":["/**\n * Video Activity (Experimental)\n *\n * Generates videos from text prompts using a jobs/polling architecture.\n * This is a self-contained module with implementation, types, and JSDoc.\n *\n * @experimental Video generation is an experimental feature and may change.\n */\n\nimport { aiEventClient } from '../../event-client.js'\nimport type { VideoAdapter } from './adapter'\nimport type {\n  VideoJobResult,\n  VideoStatusResult,\n  VideoUrlResult,\n} from '../../types'\n\n// ===========================\n// Activity Kind\n// ===========================\n\n/** The adapter kind this activity handles */\nexport const kind = 'video' as const\n\n// ===========================\n// Type Extraction Helpers\n// ===========================\n\n/**\n * Extract provider options from a VideoAdapter via ~types.\n */\nexport type VideoProviderOptions<TAdapter> =\n  TAdapter extends VideoAdapter<any, any, any, any>\n    ? TAdapter['~types']['providerOptions']\n    : object\n\n/**\n * Extract the size type for a VideoAdapter's model via ~types.\n */\nexport type VideoSizeForAdapter<TAdapter> =\n  TAdapter extends VideoAdapter<infer TModel, any, any, infer TSizeMap>\n    ? TModel extends keyof TSizeMap\n      ? TSizeMap[TModel]\n      : string\n    : string\n\n// ===========================\n// Activity Options Types\n\nfunction createId(prefix: string): string {\n  return `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2, 9)}`\n}\n// ===========================\n\n/**\n * Base options shared by all video activity operations.\n * The model is extracted from the adapter's model property.\n */\ninterface VideoActivityBaseOptions<\n  TAdapter extends VideoAdapter<string, any, any, any>,\n> {\n  /** The video adapter to use (must be created with a model) */\n  adapter: TAdapter & { kind: typeof kind }\n}\n\n/**\n * Options for creating a new video generation job.\n * The model is extracted from the adapter's model property.\n *\n * @experimental Video generation is an experimental feature and may change.\n */\nexport type VideoCreateOptions<\n  TAdapter extends VideoAdapter<string, any, any, any>,\n> = VideoActivityBaseOptions<TAdapter> & {\n  /** Request type - create a new job (default if not specified) */\n  request?: 'create'\n  /** Text description of the desired video */\n  prompt: string\n  /** Video size — format depends on the provider (e.g., \"16:9\", \"1280x720\") */\n  size?: VideoSizeForAdapter<TAdapter>\n  /** Video duration in seconds */\n  duration?: number\n} & ({} extends VideoProviderOptions<TAdapter>\n    ? {\n        /** Provider-specific options for video generation */ modelOptions?: VideoProviderOptions<TAdapter>\n      }\n    : {\n        /** Provider-specific options for video generation */ modelOptions: VideoProviderOptions<TAdapter>\n      })\n\n/**\n * Options for polling the status of a video generation job.\n *\n * @experimental Video generation is an experimental feature and may change.\n */\nexport interface VideoStatusOptions<\n  TAdapter extends VideoAdapter<string, any, any, any>,\n> extends VideoActivityBaseOptions<TAdapter> {\n  /** Request type - get job status */\n  request: 'status'\n  /** The job ID to check status for */\n  jobId: string\n}\n\n/**\n * Options for getting the URL of a completed video.\n *\n * @experimental Video generation is an experimental feature and may change.\n */\nexport interface VideoUrlOptions<\n  TAdapter extends VideoAdapter<string, any, any, any>,\n> extends VideoActivityBaseOptions<TAdapter> {\n  /** Request type - get video URL */\n  request: 'url'\n  /** The job ID to get URL for */\n  jobId: string\n}\n\n/**\n * Union type for all video activity options.\n * Discriminated by the `request` field.\n *\n * @experimental Video generation is an experimental feature and may change.\n */\nexport type VideoActivityOptions<\n  TAdapter extends VideoAdapter<string, any, any, any>,\n  TRequest extends 'create' | 'status' | 'url' = 'create',\n> = TRequest extends 'status'\n  ? VideoStatusOptions<TAdapter>\n  : TRequest extends 'url'\n    ? VideoUrlOptions<TAdapter>\n    : VideoCreateOptions<TAdapter>\n\n// ===========================\n// Activity Result Types\n// ===========================\n\n/**\n * Result type for the video activity, based on request type.\n *\n * @experimental Video generation is an experimental feature and may change.\n */\nexport type VideoActivityResult<\n  TRequest extends 'create' | 'status' | 'url' = 'create',\n> = TRequest extends 'status'\n  ? Promise<VideoStatusResult>\n  : TRequest extends 'url'\n    ? Promise<VideoUrlResult>\n    : Promise<VideoJobResult>\n\n// ===========================\n// Activity Implementation\n// ===========================\n\n/**\n * Generate video - creates a video generation job from a text prompt.\n *\n * Uses AI video generation models to create videos based on natural language descriptions.\n * Unlike image generation, video generation is asynchronous and requires polling for completion.\n *\n * @experimental Video generation is an experimental feature and may change.\n *\n * @example Create a video generation job\n * ```ts\n * import { generateVideo } from '@tanstack/ai'\n * import { openaiVideo } from '@tanstack/ai-openai'\n *\n * // Start a video generation job\n * const { jobId } = await generateVideo({\n *   adapter: openaiVideo('sora-2'),\n *   prompt: 'A cat chasing a dog in a sunny park'\n * })\n *\n * console.log('Job started:', jobId)\n * ```\n */\nexport async function generateVideo<\n  TAdapter extends VideoAdapter<string, any, any, any>,\n>(options: VideoCreateOptions<TAdapter>): Promise<VideoJobResult> {\n  const { adapter, prompt, size, duration, modelOptions } = options\n  const model = adapter.model\n\n  return adapter.createVideoJob({\n    model,\n    prompt,\n    size,\n    duration,\n    modelOptions,\n  })\n}\n\n/**\n * Get video job status - returns the current status, progress, and URL if available.\n *\n * This function combines status checking and URL retrieval. If the job is completed,\n * it will automatically fetch and include the video URL.\n *\n * @experimental Video generation is an experimental feature and may change.\n *\n * @example Check job status\n * ```ts\n * import { getVideoJobStatus } from '@tanstack/ai'\n * import { openaiVideo } from '@tanstack/ai-openai'\n *\n * const result = await getVideoJobStatus({\n *   adapter: openaiVideo('sora-2'),\n *   jobId: 'job-123'\n * })\n *\n * console.log('Status:', result.status)\n * console.log('Progress:', result.progress)\n * if (result.url) {\n *   console.log('Video URL:', result.url)\n * }\n * ```\n */\nexport async function getVideoJobStatus<\n  TAdapter extends VideoAdapter<string, any, any, any>,\n>(options: {\n  adapter: TAdapter & { kind: typeof kind }\n  jobId: string\n}): Promise<{\n  status: 'pending' | 'processing' | 'completed' | 'failed'\n  progress?: number\n  url?: string\n  error?: string\n}> {\n  const { adapter, jobId } = options\n  const requestId = createId('video-status')\n  const startTime = Date.now()\n\n  aiEventClient.emit('video:request:started', {\n    requestId,\n    provider: adapter.name,\n    model: adapter.model,\n    requestType: 'status',\n    jobId,\n    timestamp: startTime,\n  })\n\n  // Get status first\n  const statusResult = await adapter.getVideoStatus(jobId)\n\n  // If completed, also get the URL\n  if (statusResult.status === 'completed') {\n    try {\n      const urlResult = await adapter.getVideoUrl(jobId)\n      aiEventClient.emit('video:request:completed', {\n        requestId,\n        provider: adapter.name,\n        model: adapter.model,\n        requestType: 'status',\n        jobId,\n        status: statusResult.status,\n        progress: statusResult.progress,\n        url: urlResult.url,\n        duration: Date.now() - startTime,\n        timestamp: Date.now(),\n      })\n      return {\n        status: statusResult.status,\n        progress: statusResult.progress,\n        url: urlResult.url,\n      }\n    } catch (error) {\n      aiEventClient.emit('video:request:completed', {\n        requestId,\n        provider: adapter.name,\n        model: adapter.model,\n        requestType: 'status',\n        jobId,\n        status: statusResult.status,\n        progress: statusResult.progress,\n        error:\n          error instanceof Error ? error.message : 'Failed to get video URL',\n        duration: Date.now() - startTime,\n        timestamp: Date.now(),\n      })\n      // If URL fetch fails, still return status\n      return {\n        status: statusResult.status,\n        progress: statusResult.progress,\n        error:\n          error instanceof Error ? error.message : 'Failed to get video URL',\n      }\n    }\n  }\n\n  aiEventClient.emit('video:request:completed', {\n    requestId,\n    provider: adapter.name,\n    model: adapter.model,\n    requestType: 'status',\n    jobId,\n    status: statusResult.status,\n    progress: statusResult.progress,\n    error: statusResult.error,\n    duration: Date.now() - startTime,\n    timestamp: Date.now(),\n  })\n\n  // Return status for non-completed jobs\n  return {\n    status: statusResult.status,\n    progress: statusResult.progress,\n    error: statusResult.error,\n  }\n}\n\n// ===========================\n// Options Factory\n// ===========================\n\n/**\n * Create typed options for the generateVideo() function without executing.\n */\nexport function createVideoOptions<\n  TAdapter extends VideoAdapter<string, any, any, any>,\n>(options: VideoCreateOptions<TAdapter>): VideoCreateOptions<TAdapter> {\n  return options\n}\n\n// Re-export adapter types\nexport type {\n  VideoAdapter,\n  VideoAdapterConfig,\n  AnyVideoAdapter,\n} from './adapter'\nexport { BaseVideoAdapter } from './adapter'\n"],"names":[],"mappings":";AAsBO,MAAM,OAAO;AA2BpB,SAAS,SAAS,QAAwB;AACxC,SAAO,GAAG,MAAM,IAAI,KAAK,IAAA,CAAK,IAAI,KAAK,OAAA,EAAS,SAAS,EAAE,EAAE,MAAM,GAAG,CAAC,CAAC;AAC1E;AA6HA,eAAsB,cAEpB,SAAgE;AAChE,QAAM,EAAE,SAAS,QAAQ,MAAM,UAAU,iBAAiB;AAC1D,QAAM,QAAQ,QAAQ;AAEtB,SAAO,QAAQ,eAAe;AAAA,IAC5B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA,CACD;AACH;AA2BA,eAAsB,kBAEpB,SAQC;AACD,QAAM,EAAE,SAAS,MAAA,IAAU;AAC3B,QAAM,YAAY,SAAS,cAAc;AACzC,QAAM,YAAY,KAAK,IAAA;AAEvB,gBAAc,KAAK,yBAAyB;AAAA,IAC1C;AAAA,IACA,UAAU,QAAQ;AAAA,IAClB,OAAO,QAAQ;AAAA,IACf,aAAa;AAAA,IACb;AAAA,IACA,WAAW;AAAA,EAAA,CACZ;AAGD,QAAM,eAAe,MAAM,QAAQ,eAAe,KAAK;AAGvD,MAAI,aAAa,WAAW,aAAa;AACvC,QAAI;AACF,YAAM,YAAY,MAAM,QAAQ,YAAY,KAAK;AACjD,oBAAc,KAAK,2BAA2B;AAAA,QAC5C;AAAA,QACA,UAAU,QAAQ;AAAA,QAClB,OAAO,QAAQ;AAAA,QACf,aAAa;AAAA,QACb;AAAA,QACA,QAAQ,aAAa;AAAA,QACrB,UAAU,aAAa;AAAA,QACvB,KAAK,UAAU;AAAA,QACf,UAAU,KAAK,IAAA,IAAQ;AAAA,QACvB,WAAW,KAAK,IAAA;AAAA,MAAI,CACrB;AACD,aAAO;AAAA,QACL,QAAQ,aAAa;AAAA,QACrB,UAAU,aAAa;AAAA,QACvB,KAAK,UAAU;AAAA,MAAA;AAAA,IAEnB,SAAS,OAAO;AACd,oBAAc,KAAK,2BAA2B;AAAA,QAC5C;AAAA,QACA,UAAU,QAAQ;AAAA,QAClB,OAAO,QAAQ;AAAA,QACf,aAAa;AAAA,QACb;AAAA,QACA,QAAQ,aAAa;AAAA,QACrB,UAAU,aAAa;AAAA,QACvB,OACE,iBAAiB,QAAQ,MAAM,UAAU;AAAA,QAC3C,UAAU,KAAK,IAAA,IAAQ;AAAA,QACvB,WAAW,KAAK,IAAA;AAAA,MAAI,CACrB;AAED,aAAO;AAAA,QACL,QAAQ,aAAa;AAAA,QACrB,UAAU,aAAa;AAAA,QACvB,OACE,iBAAiB,QAAQ,MAAM,UAAU;AAAA,MAAA;AAAA,IAE/C;AAAA,EACF;AAEA,gBAAc,KAAK,2BAA2B;AAAA,IAC5C;AAAA,IACA,UAAU,QAAQ;AAAA,IAClB,OAAO,QAAQ;AAAA,IACf,aAAa;AAAA,IACb;AAAA,IACA,QAAQ,aAAa;AAAA,IACrB,UAAU,aAAa;AAAA,IACvB,OAAO,aAAa;AAAA,IACpB,UAAU,KAAK,IAAA,IAAQ;AAAA,IACvB,WAAW,KAAK,IAAA;AAAA,EAAI,CACrB;AAGD,SAAO;AAAA,IACL,QAAQ,aAAa;AAAA,IACrB,UAAU,aAAa;AAAA,IACvB,OAAO,aAAa;AAAA,EAAA;AAExB;AASO,SAAS,mBAEd,SAAqE;AACrE,SAAO;AACT;"}

package/dist/esm/extend-adapter.d.ts

@@ -0,0 +1,114 @@
+import { Modality } from './types.js';
+/**
+ * Definition for a custom model to add to an adapter.
+ *
+ * @template TName - The model name as a literal string type
+ * @template TInput - Array of supported input modalities
+ * @template TOptions - Provider options type for this model
+ *
+ * @example
+ * ```typescript
+ * const customModels = [
+ *   createModel('my-custom-model', ['text', 'image']),
+ * ] as const
+ * ```
+ */
+export interface ExtendedModelDef<TName extends string = string, TInput extends ReadonlyArray<Modality> = ReadonlyArray<Modality>, TOptions = unknown> {
+    /** The model name identifier */
+    name: TName;
+    /** Supported input modalities for this model */
+    input: TInput;
+    /** Type brand for provider options - use `{} as YourOptionsType` */
+    modelOptions: TOptions;
+}
+/**
+ * Creates a custom model definition for use with `extendAdapter`.
+ *
+ * This is a helper function that provides proper type inference without
+ * requiring manual `as const` casts on individual properties.
+ *
+ * @template TName - The model name (inferred from argument)
+ * @template TInput - The input modalities array (inferred from argument)
+ *
+ * @param name - The model name identifier (literal string)
+ * @param input - Array of supported input modalities
+ * @returns A properly typed model definition for use with `extendAdapter`
+ *
+ * @example
+ * ```typescript
+ * import { extendAdapter, createModel } from '@tanstack/ai'
+ * import { openaiText } from '@tanstack/ai-openai'
+ *
+ * // Define custom models with full type inference
+ * const customModels = [
+ *   createModel('my-fine-tuned-gpt4', ['text', 'image']),
+ *   createModel('local-llama', ['text']),
+ * ] as const
+ *
+ * const myOpenai = extendAdapter(openaiText, customModels)
+ * ```
+ */
+export declare function createModel<const TName extends string, const TInput extends ReadonlyArray<Modality>>(name: TName, input: TInput): ExtendedModelDef<TName, TInput>;
+/**
+ * Extract the model name union from an array of model definitions.
+ */
+type ExtractCustomModelNames<TDefs extends ReadonlyArray<ExtendedModelDef>> = TDefs[number]['name'];
+/**
+ * Infer the model parameter type from an adapter factory function.
+ * For generic functions like `<T extends Union>(model: T)`, this gets `T` which
+ * TypeScript treats as the constraint union when used in parameter position.
+ */
+type InferFactoryModels<TFactory> = TFactory extends (model: infer TModel, ...args: Array<any>) => any ? TModel extends string ? TModel : string : string;
+/**
+ * Infer the config parameter type from an adapter factory function.
+ */
+type InferConfig<TFactory> = TFactory extends (model: any, config?: infer TConfig) => any ? TConfig : undefined;
+/**
+ * Infer the adapter return type from a factory function.
+ */
+type InferAdapterReturn<TFactory> = TFactory extends (...args: Array<any>) => infer TReturn ? TReturn : never;
+/**
+ * Extends an existing adapter factory with additional custom models.
+ *
+ * The extended adapter accepts both original models (with full original type inference)
+ * and custom models (with types from your definitions).
+ *
+ * At runtime, this simply passes through to the original factory - no validation is performed.
+ * The original factory's signature is fully preserved, including any config parameters.
+ *
+ * @param factory - The original adapter factory function (e.g., `openaiText`, `anthropicText`)
+ * @param models - Array of custom model definitions with `name` and `input`
+ * @returns A new factory function that accepts both original and custom models
+ *
+ * @example
+ * ```typescript
+ * import { extendAdapter, createModel } from '@tanstack/ai'
+ * import { openaiText } from '@tanstack/ai-openai'
+ *
+ * // Define custom models
+ * const customModels = [
+ *   createModel('my-fine-tuned-gpt4', ['text', 'image']),
+ *   createModel('local-llama', ['text']),
+ * ] as const
+ *
+ * // Create extended adapter
+ * const myOpenai = extendAdapter(openaiText, customModels)
+ *
+ * // Use with original models - full type inference preserved
+ * const gpt4 = myOpenai('gpt-4o')
+ *
+ * // Use with custom models
+ * const custom = myOpenai('my-fine-tuned-gpt4')
+ *
+ * // Type error: 'invalid-model' is not a valid model
+ * // myOpenai('invalid-model')
+ *
+ * // Works with chat()
+ * chat({
+ *   adapter: myOpenai('my-fine-tuned-gpt4'),
+ *   messages: [...]
+ * })
+ * ```
+ */
+export declare function extendAdapter<TFactory extends (...args: Array<any>) => any, const TDefs extends ReadonlyArray<ExtendedModelDef>>(factory: TFactory, _customModels: TDefs): (model: InferFactoryModels<TFactory> | ExtractCustomModelNames<TDefs>, ...args: InferConfig<TFactory> extends undefined ? [] : [config?: InferConfig<TFactory>]) => InferAdapterReturn<TFactory>;
+export {};

package/dist/esm/extend-adapter.js

@@ -0,0 +1,15 @@
+function createModel(name, input) {
+  return {
+    name,
+    input,
+    modelOptions: {}
+  };
+}
+function extendAdapter(factory, _customModels) {
+  return factory;
+}
+export {
+  createModel,
+  extendAdapter
+};
+//# sourceMappingURL=extend-adapter.js.map

package/dist/esm/extend-adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extend-adapter.js","sources":["../../src/extend-adapter.ts"],"sourcesContent":["import type { Modality } from './types'\n\n// ===========================\n// Extended Model Definition\n// ===========================\n\n/**\n * Definition for a custom model to add to an adapter.\n *\n * @template TName - The model name as a literal string type\n * @template TInput - Array of supported input modalities\n * @template TOptions - Provider options type for this model\n *\n * @example\n * ```typescript\n * const customModels = [\n *   createModel('my-custom-model', ['text', 'image']),\n * ] as const\n * ```\n */\nexport interface ExtendedModelDef<\n  TName extends string = string,\n  TInput extends ReadonlyArray<Modality> = ReadonlyArray<Modality>,\n  TOptions = unknown,\n> {\n  /** The model name identifier */\n  name: TName\n  /** Supported input modalities for this model */\n  input: TInput\n  /** Type brand for provider options - use `{} as YourOptionsType` */\n  modelOptions: TOptions\n}\n\n/**\n * Creates a custom model definition for use with `extendAdapter`.\n *\n * This is a helper function that provides proper type inference without\n * requiring manual `as const` casts on individual properties.\n *\n * @template TName - The model name (inferred from argument)\n * @template TInput - The input modalities array (inferred from argument)\n *\n * @param name - The model name identifier (literal string)\n * @param input - Array of supported input modalities\n * @returns A properly typed model definition for use with `extendAdapter`\n *\n * @example\n * ```typescript\n * import { extendAdapter, createModel } from '@tanstack/ai'\n * import { openaiText } from '@tanstack/ai-openai'\n *\n * // Define custom models with full type inference\n * const customModels = [\n *   createModel('my-fine-tuned-gpt4', ['text', 'image']),\n *   createModel('local-llama', ['text']),\n * ] as const\n *\n * const myOpenai = extendAdapter(openaiText, customModels)\n * ```\n */\nexport function createModel<\n  const TName extends string,\n  const TInput extends ReadonlyArray<Modality>,\n>(name: TName, input: TInput): ExtendedModelDef<TName, TInput> {\n  return {\n    name,\n    input,\n    modelOptions: {} as unknown,\n  }\n}\n\n// ===========================\n// Type Extraction Utilities\n// ===========================\n\n/**\n * Extract the model name union from an array of model definitions.\n */\ntype ExtractCustomModelNames<TDefs extends ReadonlyArray<ExtendedModelDef>> =\n  TDefs[number]['name']\n\n// ===========================\n// Factory Type Inference\n// ===========================\n\n/**\n * Infer the model parameter type from an adapter factory function.\n * For generic functions like `<T extends Union>(model: T)`, this gets `T` which\n * TypeScript treats as the constraint union when used in parameter position.\n */\ntype InferFactoryModels<TFactory> = TFactory extends (\n  model: infer TModel,\n  ...args: Array<any>\n) => any\n  ? TModel extends string\n    ? TModel\n    : string\n  : string\n\n/**\n * Infer the config parameter type from an adapter factory function.\n */\ntype InferConfig<TFactory> = TFactory extends (\n  model: any,\n  config?: infer TConfig,\n) => any\n  ? TConfig\n  : undefined\n\n/**\n * Infer the adapter return type from a factory function.\n */\ntype InferAdapterReturn<TFactory> = TFactory extends (\n  ...args: Array<any>\n) => infer TReturn\n  ? TReturn\n  : never\n\n// ===========================\n// extendAdapter Function\n// ===========================\n\n/**\n * Extends an existing adapter factory with additional custom models.\n *\n * The extended adapter accepts both original models (with full original type inference)\n * and custom models (with types from your definitions).\n *\n * At runtime, this simply passes through to the original factory - no validation is performed.\n * The original factory's signature is fully preserved, including any config parameters.\n *\n * @param factory - The original adapter factory function (e.g., `openaiText`, `anthropicText`)\n * @param models - Array of custom model definitions with `name` and `input`\n * @returns A new factory function that accepts both original and custom models\n *\n * @example\n * ```typescript\n * import { extendAdapter, createModel } from '@tanstack/ai'\n * import { openaiText } from '@tanstack/ai-openai'\n *\n * // Define custom models\n * const customModels = [\n *   createModel('my-fine-tuned-gpt4', ['text', 'image']),\n *   createModel('local-llama', ['text']),\n * ] as const\n *\n * // Create extended adapter\n * const myOpenai = extendAdapter(openaiText, customModels)\n *\n * // Use with original models - full type inference preserved\n * const gpt4 = myOpenai('gpt-4o')\n *\n * // Use with custom models\n * const custom = myOpenai('my-fine-tuned-gpt4')\n *\n * // Type error: 'invalid-model' is not a valid model\n * // myOpenai('invalid-model')\n *\n * // Works with chat()\n * chat({\n *   adapter: myOpenai('my-fine-tuned-gpt4'),\n *   messages: [...]\n * })\n * ```\n */\nexport function extendAdapter<\n  TFactory extends (...args: Array<any>) => any,\n  const TDefs extends ReadonlyArray<ExtendedModelDef>,\n>(\n  factory: TFactory,\n  _customModels: TDefs,\n): (\n  model: InferFactoryModels<TFactory> | ExtractCustomModelNames<TDefs>,\n  ...args: InferConfig<TFactory> extends undefined\n    ? []\n    : [config?: InferConfig<TFactory>]\n) => InferAdapterReturn<TFactory> {\n  // At runtime, we simply pass through to the original factory.\n  // The _customModels parameter is only used for type inference.\n  // No runtime validation - users are trusted to pass valid model names.\n  return factory as any\n}\n"],"names":[],"mappings":"AA4DO,SAAS,YAGd,MAAa,OAAgD;AAC7D,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,cAAc,CAAA;AAAA,EAAC;AAEnB;AAgGO,SAAS,cAId,SACA,eAMgC;AAIhC,SAAO;AACT;"}

package/dist/esm/index.d.ts

@@ -17,3 +17,5 @@ export * from './event-client.js';
 export { convertMessagesToModelMessages, generateMessageId, uiMessageToModelMessages, modelMessageToUIMessage, modelMessagesToUIMessages, normalizeToUIMessage, } from './activities/chat/messages.js';
 export { StreamProcessor, createReplayStream, ImmediateStrategy, PunctuationStrategy, BatchStrategy, WordBoundaryStrategy, CompositeStrategy, PartialJSONParser, defaultJSONParser, parsePartialJSON, } from './activities/chat/stream/index.js';
 export type { ChunkStrategy, ChunkRecording, InternalToolCallState, ProcessorResult, ProcessorState, StreamProcessorEvents, StreamProcessorOptions, ToolCallState, ToolResultState, JSONParser, } from './activities/chat/stream/index.js';
+export { createModel, extendAdapter } from './extend-adapter.js';
+export type { ExtendedModelDef } from './extend-adapter.js';

package/dist/esm/index.js

@@ -12,6 +12,7 @@ import { combineStrategies, maxIterations, untilFinishReason } from "./activitie
 import { detectImageMimeType } from "./utils.js";
 import { aiEventClient } from "./event-client.js";
 import { convertMessagesToModelMessages, generateMessageId, modelMessageToUIMessage, modelMessagesToUIMessages, normalizeToUIMessage, uiMessageToModelMessages } from "./activities/chat/messages.js";
+import { createModel, extendAdapter } from "./extend-adapter.js";
 import { StreamProcessor, createReplayStream } from "./activities/chat/stream/processor.js";
 import { BatchStrategy, CompositeStrategy, ImmediateStrategy, PunctuationStrategy, WordBoundaryStrategy } from "./activities/chat/stream/strategies.js";
 import { PartialJSONParser, defaultJSONParser, parsePartialJSON } from "./activities/chat/stream/json-parser.js";
@@ -31,6 +32,7 @@ export {
   convertSchemaToJsonSchema,
   createChatOptions,
   createImageOptions,
+  createModel,
   createReplayStream,
   createSpeechOptions,
   createSummarizeOptions,
@@ -38,6 +40,7 @@ export {
   createVideoOptions,
   defaultJSONParser,
   detectImageMimeType,
+  extendAdapter,
   generateImage,
   generateMessageId,
   generateSpeech,

package/dist/esm/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/types.d.ts

@@ -261,6 +261,33 @@ export type InputModalitiesTypes = {
 export type ConstrainedModelMessage<TInputModalitiesTypes extends InputModalitiesTypes> = Omit<ModelMessage, 'content'> & {
     content: ConstrainedContent<TInputModalitiesTypes>;
 };
+/**
+ * Context passed to tool execute functions, providing capabilities like
+ * emitting custom events during execution.
+ */
+export interface ToolExecutionContext {
+    /** The ID of the tool call being executed */
+    toolCallId?: string;
+    /**
+     * Emit a custom event during tool execution.
+     * Events are streamed to the client in real-time as AG-UI CUSTOM events.
+     *
+     * @param eventName - Name of the custom event
+     * @param value - Event payload value
+     *
+     * @example
+     * ```ts
+     * const tool = toolDefinition({ ... }).server(async (args, context) => {
+     *   context?.emitCustomEvent('progress', { step: 1, total: 3 })
+     *   // ... do work ...
+     *   context?.emitCustomEvent('progress', { step: 2, total: 3 })
+     *   // ... do more work ...
+     *   return result
+     * })
+     * ```
+     */
+    emitCustomEvent: (eventName: string, value: Record<string, any>) => void;
+}
 /**
  * Tool/Function definition for function calling.
  *
@@ -369,7 +396,7 @@ export interface Tool<TInput extends SchemaInput = SchemaInput, TOutput extends
      *   return weather; // Can return object or string
      * }
      */
-    execute?: (args: any) => Promise<any> | any;
+    execute?: (args: any, context?: ToolExecutionContext) => Promise<any> | any;
     /** If true, tool execution requires user approval before running. Works with both server and client tools. */
     needsApproval?: boolean;
     /** Additional metadata for adapters or custom extensions */
@@ -748,8 +775,8 @@ export interface CustomEvent extends BaseAGUIEvent {
     type: 'CUSTOM';
     /** Custom event name */
     name: string;
-    /** Custom event data */
-    data?: unknown;
+    /** Custom event value */
+    value?: unknown;
 }
 /**
  * Union of all AG-UI events.
@@ -793,7 +820,7 @@ export interface SummarizationResult {
  * Options for image generation.
  * These are the common options supported across providers.
  */
-export interface ImageGenerationOptions<TProviderOptions extends object = object> {
+export interface ImageGenerationOptions<TProviderOptions extends object = object, TSize extends string = string> {
     /** The model to use for image generation */
     model: string;
     /** Text description of the desired image(s) */
@@ -801,7 +828,7 @@ export interface ImageGenerationOptions<TProviderOptions extends object = object
     /** Number of images to generate (default: 1) */
     numberOfImages?: number;
     /** Image size in WIDTHxHEIGHT format (e.g., "1024x1024") */
-    size?: string;
+    size?: TSize;
     /** Model-specific options for image generation */
     modelOptions?: TProviderOptions;
 }
@@ -839,13 +866,13 @@ export interface ImageGenerationResult {
  *
  * @experimental Video generation is an experimental feature and may change.
  */
-export interface VideoGenerationOptions<TProviderOptions extends object = object> {
+export interface VideoGenerationOptions<TProviderOptions extends object = object, TSize extends string = string> {
     /** The model to use for video generation */
     model: string;
     /** Text description of the desired video */
     prompt: string;
-    /** Video size in WIDTHxHEIGHT format (e.g., "1280x720") */
-    size?: string;
+    /** Video size — format depends on the provider (e.g., "16:9", "1280x720") */
+    size?: TSize;
     /** Video duration in seconds */
     duration?: number;
     /** Model-specific options for video generation */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai",
-  "version": "0.5.0",
+  "version": "0.6.1",
   "description": "Core TanStack AI library - Open source AI SDK",
   "author": "Tanner Linsley",
   "license": "MIT",