@tanstack/ai 0.0.2 → 0.1.0

package/dist/esm/activities/generateTranscription/adapter.js

@@ -0,0 +1,14 @@
+class BaseTranscriptionAdapter {
+  constructor(config = {}, model) {
+    this.kind = "transcription";
+    this.config = config;
+    this.model = model;
+  }
+  generateId() {
+    return `${this.name}-${Date.now()}-${Math.random().toString(36).substring(7)}`;
+  }
+}
+export {
+  BaseTranscriptionAdapter
+};
+//# sourceMappingURL=adapter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sources":["../../../../src/activities/generateTranscription/adapter.ts"],"sourcesContent":["import type { TranscriptionOptions, TranscriptionResult } from '../../types'\n\n/**\n * Configuration for transcription adapter instances\n */\nexport interface TranscriptionAdapterConfig {\n  apiKey?: string\n  baseUrl?: string\n  timeout?: number\n  maxRetries?: number\n  headers?: Record<string, string>\n}\n\n/**\n * Transcription 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 * Generic parameters:\n * - TModel: The specific model name (e.g., 'whisper-1')\n * - TProviderOptions: Provider-specific options (already resolved)\n */\nexport interface TranscriptionAdapter<\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: 'transcription'\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   * Transcribe audio to text\n   */\n  transcribe: (\n    options: TranscriptionOptions<TProviderOptions>,\n  ) => Promise<TranscriptionResult>\n}\n\n/**\n * A TranscriptionAdapter with any/unknown type parameters.\n * Useful as a constraint in generic functions and interfaces.\n */\nexport type AnyTranscriptionAdapter = TranscriptionAdapter<any, any>\n\n/**\n * Abstract base class for audio transcription adapters.\n * Extend this class to implement a transcription adapter for a specific provider.\n *\n * Generic parameters match TranscriptionAdapter - all pre-resolved by the provider function.\n */\nexport abstract class BaseTranscriptionAdapter<\n  TModel extends string = string,\n  TProviderOptions extends object = Record<string, unknown>,\n> implements TranscriptionAdapter<TModel, TProviderOptions> {\n  readonly kind = 'transcription' 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: TranscriptionAdapterConfig\n\n  constructor(config: TranscriptionAdapterConfig = {}, model: TModel) {\n    this.config = config\n    this.model = model\n  }\n\n  abstract transcribe(\n    options: TranscriptionOptions<TProviderOptions>,\n  ): Promise<TranscriptionResult>\n\n  protected generateId(): string {\n    return `${this.name}-${Date.now()}-${Math.random().toString(36).substring(7)}`\n  }\n}\n"],"names":[],"mappings":"AA6DO,MAAe,yBAGsC;AAAA,EAY1D,YAAY,SAAqC,CAAA,GAAI,OAAe;AAXpE,SAAS,OAAO;AAYd,SAAK,SAAS;AACd,SAAK,QAAQ;AAAA,EACf;AAAA,EAMU,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/generateTranscription/index.d.ts

@@ -0,0 +1,71 @@
+import { TranscriptionAdapter } from './adapter.js';
+import { TranscriptionResult } from '../../types.js';
+/** The adapter kind this activity handles */
+export declare const kind: "transcription";
+/**
+ * Extract provider options from a TranscriptionAdapter via ~types.
+ */
+export type TranscriptionProviderOptions<TAdapter> = TAdapter extends TranscriptionAdapter<any, any> ? TAdapter['~types']['providerOptions'] : object;
+/**
+ * Options for the transcription activity.
+ * The model is extracted from the adapter's model property.
+ *
+ * @template TAdapter - The transcription adapter type
+ */
+export interface TranscriptionActivityOptions<TAdapter extends TranscriptionAdapter<string, object>> {
+    /** The transcription adapter to use (must be created with a model) */
+    adapter: TAdapter & {
+        kind: typeof kind;
+    };
+    /** The audio data to transcribe - can be base64 string, File, Blob, or Buffer */
+    audio: string | File | Blob | ArrayBuffer;
+    /** The language of the audio in ISO-639-1 format (e.g., 'en') */
+    language?: string;
+    /** An optional prompt to guide the transcription */
+    prompt?: string;
+    /** The format of the transcription output */
+    responseFormat?: 'json' | 'text' | 'srt' | 'verbose_json' | 'vtt';
+    /** Provider-specific options for transcription */
+    modelOptions?: TranscriptionProviderOptions<TAdapter>;
+}
+/** Result type for the transcription activity */
+export type TranscriptionActivityResult = Promise<TranscriptionResult>;
+/**
+ * Transcription activity - converts audio to text.
+ *
+ * Uses AI speech-to-text models to transcribe audio content.
+ *
+ * @example Transcribe an audio file
+ * ```ts
+ * import { generateTranscription } from '@tanstack/ai'
+ * import { openaiTranscription } from '@tanstack/ai-openai'
+ *
+ * const result = await generateTranscription({
+ *   adapter: openaiTranscription('whisper-1'),
+ *   audio: audioFile, // File, Blob, or base64 string
+ *   language: 'en'
+ * })
+ *
+ * console.log(result.text)
+ * ```
+ *
+ * @example With verbose output for timestamps
+ * ```ts
+ * const result = await generateTranscription({
+ *   adapter: openaiTranscription('whisper-1'),
+ *   audio: audioFile,
+ *   responseFormat: 'verbose_json'
+ * })
+ *
+ * result.segments?.forEach(segment => {
+ *   console.log(`[${segment.start}s - ${segment.end}s]: ${segment.text}`)
+ * })
+ * ```
+ */
+export declare function generateTranscription<TAdapter extends TranscriptionAdapter<string, object>>(options: TranscriptionActivityOptions<TAdapter>): TranscriptionActivityResult;
+/**
+ * Create typed options for the generateTranscription() function without executing.
+ */
+export declare function createTranscriptionOptions<TAdapter extends TranscriptionAdapter<string, object>>(options: TranscriptionActivityOptions<TAdapter>): TranscriptionActivityOptions<TAdapter>;
+export type { TranscriptionAdapter, TranscriptionAdapterConfig, AnyTranscriptionAdapter, } from './adapter.js';
+export { BaseTranscriptionAdapter } from './adapter.js';

package/dist/esm/activities/generateTranscription/index.js

@@ -0,0 +1,15 @@
+const kind = "transcription";
+async function generateTranscription(options) {
+  const { adapter, ...rest } = options;
+  const model = adapter.model;
+  return adapter.transcribe({ ...rest, model });
+}
+function createTranscriptionOptions(options) {
+  return options;
+}
+export {
+  createTranscriptionOptions,
+  generateTranscription,
+  kind
+};
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../../src/activities/generateTranscription/index.ts"],"sourcesContent":["/**\n * Transcription Activity\n *\n * Transcribes audio to text using speech-to-text models.\n * This is a self-contained module with implementation, types, and JSDoc.\n */\n\nimport type { TranscriptionAdapter } from './adapter'\nimport type { TranscriptionResult } from '../../types'\n\n// ===========================\n// Activity Kind\n// ===========================\n\n/** The adapter kind this activity handles */\nexport const kind = 'transcription' as const\n\n// ===========================\n// Type Extraction Helpers\n// ===========================\n\n/**\n * Extract provider options from a TranscriptionAdapter via ~types.\n */\nexport type TranscriptionProviderOptions<TAdapter> =\n  TAdapter extends TranscriptionAdapter<any, any>\n    ? TAdapter['~types']['providerOptions']\n    : object\n\n// ===========================\n// Activity Options Type\n// ===========================\n\n/**\n * Options for the transcription activity.\n * The model is extracted from the adapter's model property.\n *\n * @template TAdapter - The transcription adapter type\n */\nexport interface TranscriptionActivityOptions<\n  TAdapter extends TranscriptionAdapter<string, object>,\n> {\n  /** The transcription adapter to use (must be created with a model) */\n  adapter: TAdapter & { kind: typeof kind }\n  /** The audio data to transcribe - can be base64 string, File, Blob, or Buffer */\n  audio: string | File | Blob | ArrayBuffer\n  /** The language of the audio in ISO-639-1 format (e.g., 'en') */\n  language?: string\n  /** An optional prompt to guide the transcription */\n  prompt?: string\n  /** The format of the transcription output */\n  responseFormat?: 'json' | 'text' | 'srt' | 'verbose_json' | 'vtt'\n  /** Provider-specific options for transcription */\n  modelOptions?: TranscriptionProviderOptions<TAdapter>\n}\n\n// ===========================\n// Activity Result Type\n// ===========================\n\n/** Result type for the transcription activity */\nexport type TranscriptionActivityResult = Promise<TranscriptionResult>\n\n// ===========================\n// Activity Implementation\n// ===========================\n\n/**\n * Transcription activity - converts audio to text.\n *\n * Uses AI speech-to-text models to transcribe audio content.\n *\n * @example Transcribe an audio file\n * ```ts\n * import { generateTranscription } from '@tanstack/ai'\n * import { openaiTranscription } from '@tanstack/ai-openai'\n *\n * const result = await generateTranscription({\n *   adapter: openaiTranscription('whisper-1'),\n *   audio: audioFile, // File, Blob, or base64 string\n *   language: 'en'\n * })\n *\n * console.log(result.text)\n * ```\n *\n * @example With verbose output for timestamps\n * ```ts\n * const result = await generateTranscription({\n *   adapter: openaiTranscription('whisper-1'),\n *   audio: audioFile,\n *   responseFormat: 'verbose_json'\n * })\n *\n * result.segments?.forEach(segment => {\n *   console.log(`[${segment.start}s - ${segment.end}s]: ${segment.text}`)\n * })\n * ```\n */\nexport async function generateTranscription<\n  TAdapter extends TranscriptionAdapter<string, object>,\n>(\n  options: TranscriptionActivityOptions<TAdapter>,\n): TranscriptionActivityResult {\n  const { adapter, ...rest } = options\n  const model = adapter.model\n\n  return adapter.transcribe({ ...rest, model })\n}\n\n// ===========================\n// Options Factory\n// ===========================\n\n/**\n * Create typed options for the generateTranscription() function without executing.\n */\nexport function createTranscriptionOptions<\n  TAdapter extends TranscriptionAdapter<string, object>,\n>(\n  options: TranscriptionActivityOptions<TAdapter>,\n): TranscriptionActivityOptions<TAdapter> {\n  return options\n}\n\n// Re-export adapter types\nexport type {\n  TranscriptionAdapter,\n  TranscriptionAdapterConfig,\n  AnyTranscriptionAdapter,\n} from './adapter'\nexport { BaseTranscriptionAdapter } from './adapter'\n"],"names":[],"mappings":"AAeO,MAAM,OAAO;AAoFpB,eAAsB,sBAGpB,SAC6B;AAC7B,QAAM,EAAE,SAAS,GAAG,KAAA,IAAS;AAC7B,QAAM,QAAQ,QAAQ;AAEtB,SAAO,QAAQ,WAAW,EAAE,GAAG,MAAM,OAAO;AAC9C;AASO,SAAS,2BAGd,SACwC;AACxC,SAAO;AACT;"}

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

@@ -0,0 +1,80 @@
+import { VideoGenerationOptions, VideoJobResult, VideoStatusResult, VideoUrlResult } from '../../types.js';
+/**
+ * Configuration for video adapter instances
+ *
+ * @experimental Video generation is an experimental feature and may change.
+ */
+export interface VideoAdapterConfig {
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: number;
+    maxRetries?: number;
+    headers?: Record<string, string>;
+}
+/**
+ * Video adapter interface with pre-resolved generics.
+ *
+ * An adapter is created by a provider function: `provider('model')` → `adapter`
+ * All type resolution happens at the provider call site, not in this interface.
+ *
+ * @experimental Video generation is an experimental feature and may change.
+ *
+ * Generic parameters:
+ * - TModel: The specific model name (e.g., 'sora-2')
+ * - TProviderOptions: Provider-specific options (already resolved)
+ */
+export interface VideoAdapter<TModel extends string = string, TProviderOptions extends object = Record<string, unknown>> {
+    /** Discriminator for adapter kind - used to determine API shape */
+    readonly kind: 'video';
+    /** Adapter name identifier */
+    readonly name: string;
+    /** The model this adapter is configured for */
+    readonly model: TModel;
+    /**
+     * @internal Type-only properties for inference. Not assigned at runtime.
+     */
+    '~types': {
+        providerOptions: TProviderOptions;
+    };
+    /**
+     * 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>;
+    /**
+     * Get the current status of a video generation job.
+     */
+    getVideoStatus: (jobId: string) => Promise<VideoStatusResult>;
+    /**
+     * Get the URL to download/view the generated video.
+     * Should only be called after status is 'completed'.
+     */
+    getVideoUrl: (jobId: string) => Promise<VideoUrlResult>;
+}
+/**
+ * A VideoAdapter with any/unknown type parameters.
+ * Useful as a constraint in generic functions and interfaces.
+ */
+export type AnyVideoAdapter = VideoAdapter<any, any>;
+/**
+ * Abstract base class for video generation adapters.
+ * Extend this class to implement a video adapter for a specific provider.
+ *
+ * @experimental Video generation is an experimental feature and may change.
+ *
+ * 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> {
+    readonly kind: "video";
+    abstract readonly name: string;
+    readonly model: TModel;
+    '~types': {
+        providerOptions: TProviderOptions;
+    };
+    protected config: VideoAdapterConfig;
+    constructor(config: VideoAdapterConfig | undefined, model: TModel);
+    abstract createVideoJob(options: VideoGenerationOptions<TProviderOptions>): Promise<VideoJobResult>;
+    abstract getVideoStatus(jobId: string): Promise<VideoStatusResult>;
+    abstract getVideoUrl(jobId: string): Promise<VideoUrlResult>;
+    protected generateId(): string;
+}

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

@@ -0,0 +1,14 @@
+class BaseVideoAdapter {
+  constructor(config = {}, model) {
+    this.kind = "video";
+    this.config = config;
+    this.model = model;
+  }
+  generateId() {
+    return `${this.name}-${Date.now()}-${Math.random().toString(36).substring(7)}`;
+  }
+}
+export {
+  BaseVideoAdapter
+};
+//# sourceMappingURL=adapter.js.map

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

@@ -0,0 +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;"}

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

@@ -0,0 +1,136 @@
+import { VideoAdapter } from './adapter.js';
+import { VideoJobResult, VideoStatusResult, VideoUrlResult } from '../../types.js';
+/** The adapter kind this activity handles */
+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;
+/**
+ * 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>> {
+    /** The video adapter to use (must be created with a model) */
+    adapter: TAdapter & {
+        kind: typeof kind;
+    };
+}
+/**
+ * Options for creating a new video generation job.
+ * The model is extracted from the adapter's model property.
+ *
+ * @experimental Video generation is an experimental feature and may change.
+ */
+export interface VideoCreateOptions<TAdapter extends VideoAdapter<string, object>> extends 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 duration in seconds */
+    duration?: number;
+    /** 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> {
+    /** Request type - get job status */
+    request: 'status';
+    /** The job ID to check status for */
+    jobId: string;
+}
+/**
+ * Options for getting the URL of a completed video.
+ *
+ * @experimental Video generation is an experimental feature and may change.
+ */
+export interface VideoUrlOptions<TAdapter extends VideoAdapter<string, object>> extends VideoActivityBaseOptions<TAdapter> {
+    /** Request type - get video URL */
+    request: 'url';
+    /** The job ID to get URL for */
+    jobId: string;
+}
+/**
+ * Union type for all video activity options.
+ * Discriminated by the `request` field.
+ *
+ * @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>;
+/**
+ * Result type for the video activity, based on request type.
+ *
+ * @experimental Video generation is an experimental feature and may change.
+ */
+export type VideoActivityResult<TRequest extends 'create' | 'status' | 'url' = 'create'> = TRequest extends 'status' ? Promise<VideoStatusResult> : TRequest extends 'url' ? Promise<VideoUrlResult> : Promise<VideoJobResult>;
+/**
+ * Generate video - creates a video generation job from a text prompt.
+ *
+ * Uses AI video generation models to create videos based on natural language descriptions.
+ * Unlike image generation, video generation is asynchronous and requires polling for completion.
+ *
+ * @experimental Video generation is an experimental feature and may change.
+ *
+ * @example Create a video generation job
+ * ```ts
+ * import { generateVideo } from '@tanstack/ai'
+ * import { openaiVideo } from '@tanstack/ai-openai'
+ *
+ * // Start a video generation job
+ * const { jobId } = await generateVideo({
+ *   adapter: openaiVideo('sora-2'),
+ *   prompt: 'A cat chasing a dog in a sunny park'
+ * })
+ *
+ * console.log('Job started:', jobId)
+ * ```
+ */
+export declare function generateVideo<TAdapter extends VideoAdapter<string, object>>(options: VideoCreateOptions<TAdapter>): Promise<VideoJobResult>;
+/**
+ * Get video job status - returns the current status, progress, and URL if available.
+ *
+ * This function combines status checking and URL retrieval. If the job is completed,
+ * it will automatically fetch and include the video URL.
+ *
+ * @experimental Video generation is an experimental feature and may change.
+ *
+ * @example Check job status
+ * ```ts
+ * import { getVideoJobStatus } from '@tanstack/ai'
+ * import { openaiVideo } from '@tanstack/ai-openai'
+ *
+ * const result = await getVideoJobStatus({
+ *   adapter: openaiVideo('sora-2'),
+ *   jobId: 'job-123'
+ * })
+ *
+ * console.log('Status:', result.status)
+ * console.log('Progress:', result.progress)
+ * if (result.url) {
+ *   console.log('Video URL:', result.url)
+ * }
+ * ```
+ */
+export declare function getVideoJobStatus<TAdapter extends VideoAdapter<string, object>>(options: {
+    adapter: TAdapter & {
+        kind: typeof kind;
+    };
+    jobId: string;
+}): Promise<{
+    status: 'pending' | 'processing' | 'completed' | 'failed';
+    progress?: number;
+    url?: string;
+    error?: 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 type { VideoAdapter, VideoAdapterConfig, AnyVideoAdapter, } from './adapter.js';
+export { BaseVideoAdapter } from './adapter.js';

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

@@ -0,0 +1,47 @@
+const kind = "video";
+async function generateVideo(options) {
+  const { adapter, prompt, size, duration, modelOptions } = options;
+  const model = adapter.model;
+  return adapter.createVideoJob({
+    model,
+    prompt,
+    size,
+    duration,
+    modelOptions
+  });
+}
+async function getVideoJobStatus(options) {
+  const { adapter, jobId } = options;
+  const statusResult = await adapter.getVideoStatus(jobId);
+  if (statusResult.status === "completed") {
+    try {
+      const urlResult = await adapter.getVideoUrl(jobId);
+      return {
+        status: statusResult.status,
+        progress: statusResult.progress,
+        url: urlResult.url
+      };
+    } catch (error) {
+      return {
+        status: statusResult.status,
+        progress: statusResult.progress,
+        error: error instanceof Error ? error.message : "Failed to get video URL"
+      };
+    }
+  }
+  return {
+    status: statusResult.status,
+    progress: statusResult.progress,
+    error: statusResult.error
+  };
+}
+function createVideoOptions(options) {
+  return options;
+}
+export {
+  createVideoOptions,
+  generateVideo,
+  getVideoJobStatus,
+  kind
+};
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +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 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// ===========================\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\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      return {\n        status: statusResult.status,\n        progress: statusResult.progress,\n        url: urlResult.url,\n      }\n    } catch (error) {\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  // 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":"AAqBO,MAAM,OAAO;AAwIpB,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;AAG3B,QAAM,eAAe,MAAM,QAAQ,eAAe,KAAK;AAGvD,MAAI,aAAa,WAAW,aAAa;AACvC,QAAI;AACF,YAAM,YAAY,MAAM,QAAQ,YAAY,KAAK;AACjD,aAAO;AAAA,QACL,QAAQ,aAAa;AAAA,QACrB,UAAU,aAAa;AAAA,QACvB,KAAK,UAAU;AAAA,MAAA;AAAA,IAEnB,SAAS,OAAO;AAEd,aAAO;AAAA,QACL,QAAQ,aAAa;AAAA,QACrB,UAAU,aAAa;AAAA,QACvB,OACE,iBAAiB,QAAQ,MAAM,UAAU;AAAA,MAAA;AAAA,IAE/C;AAAA,EACF;AAGA,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/activities/index.d.ts

@@ -0,0 +1,22 @@
+import { AnyTextAdapter } from './chat/adapter.js';
+import { AnySummarizeAdapter } from './summarize/adapter.js';
+import { AnyImageAdapter } from './generateImage/adapter.js';
+import { AnyVideoAdapter } from './generateVideo/adapter.js';
+import { AnyTTSAdapter } from './generateSpeech/adapter.js';
+import { AnyTranscriptionAdapter } from './generateTranscription/adapter.js';
+export { kind as textKind, chat, type TextActivityOptions, type TextActivityResult, } from './chat/index.js';
+export { BaseTextAdapter, type AnyTextAdapter, type TextAdapter, type TextAdapterConfig, type StructuredOutputOptions, type StructuredOutputResult, } from './chat/adapter.js';
+export { kind as summarizeKind, summarize, type SummarizeActivityOptions, type SummarizeActivityResult, type SummarizeProviderOptions, } from './summarize/index.js';
+export { BaseSummarizeAdapter, type SummarizeAdapter, type SummarizeAdapterConfig, type AnySummarizeAdapter, } from './summarize/adapter.js';
+export { kind as imageKind, generateImage, type ImageActivityOptions, type ImageActivityResult, type ImageProviderOptionsForModel, type ImageSizeForModel, } from './generateImage/index.js';
+export { BaseImageAdapter, type ImageAdapter, type ImageAdapterConfig, type AnyImageAdapter, } from './generateImage/adapter.js';
+export { kind as videoKind, generateVideo, getVideoJobStatus, type VideoActivityOptions, type VideoActivityResult, type VideoProviderOptions, type VideoCreateOptions, type VideoStatusOptions, type VideoUrlOptions, } from './generateVideo/index.js';
+export { BaseVideoAdapter, type VideoAdapter, type VideoAdapterConfig, type AnyVideoAdapter, } from './generateVideo/adapter.js';
+export { kind as ttsKind, generateSpeech, type TTSActivityOptions, type TTSActivityResult, type TTSProviderOptions, } from './generateSpeech/index.js';
+export { BaseTTSAdapter, type TTSAdapter, type TTSAdapterConfig, type AnyTTSAdapter, } from './generateSpeech/adapter.js';
+export { kind as transcriptionKind, generateTranscription, type TranscriptionActivityOptions, type TranscriptionActivityResult, type TranscriptionProviderOptions, } from './generateTranscription/index.js';
+export { BaseTranscriptionAdapter, type TranscriptionAdapter, type TranscriptionAdapterConfig, type AnyTranscriptionAdapter, } from './generateTranscription/adapter.js';
+/** Union of all adapter types that can be passed to chat() */
+export type AIAdapter = AnyTextAdapter | AnySummarizeAdapter | AnyImageAdapter | AnyVideoAdapter | AnyTTSAdapter | AnyTranscriptionAdapter;
+/** Union type of all adapter kinds */
+export type AdapterKind = 'text' | 'summarize' | 'image' | 'video' | 'tts' | 'transcription';

package/dist/esm/activities/index.js

@@ -0,0 +1,34 @@
+import { chat, kind } from "./chat/index.js";
+import { BaseTextAdapter } from "./chat/adapter.js";
+import { summarize, kind as kind2 } from "./summarize/index.js";
+import { BaseSummarizeAdapter } from "./summarize/adapter.js";
+import { generateImage, kind as kind3 } from "./generateImage/index.js";
+import { BaseImageAdapter } from "./generateImage/adapter.js";
+import { generateVideo, getVideoJobStatus, kind as kind4 } from "./generateVideo/index.js";
+import { BaseVideoAdapter } from "./generateVideo/adapter.js";
+import { generateSpeech, kind as kind5 } from "./generateSpeech/index.js";
+import { BaseTTSAdapter } from "./generateSpeech/adapter.js";
+import { generateTranscription, kind as kind6 } from "./generateTranscription/index.js";
+import { BaseTranscriptionAdapter } from "./generateTranscription/adapter.js";
+export {
+  BaseImageAdapter,
+  BaseSummarizeAdapter,
+  BaseTTSAdapter,
+  BaseTextAdapter,
+  BaseTranscriptionAdapter,
+  BaseVideoAdapter,
+  chat,
+  generateImage,
+  generateSpeech,
+  generateTranscription,
+  generateVideo,
+  getVideoJobStatus,
+  kind3 as imageKind,
+  summarize,
+  kind2 as summarizeKind,
+  kind as textKind,
+  kind6 as transcriptionKind,
+  kind5 as ttsKind,
+  kind4 as videoKind
+};
+//# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,74 @@
+import { StreamChunk, SummarizationOptions, SummarizationResult } from '../../types.js';
+/**
+ * Configuration for summarize adapter instances
+ */
+export interface SummarizeAdapterConfig {
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: number;
+    maxRetries?: number;
+    headers?: Record<string, string>;
+}
+/**
+ * Summarize adapter interface with pre-resolved generics.
+ *
+ * An adapter is created by a provider function: `provider('model')` → `adapter`
+ * All type resolution happens at the provider call site, not in this interface.
+ *
+ * Generic parameters:
+ * - TModel: The specific model name (e.g., 'gpt-4o')
+ * - TProviderOptions: Provider-specific options (already resolved)
+ */
+export interface SummarizeAdapter<TModel extends string = string, TProviderOptions extends object = Record<string, unknown>> {
+    /** Discriminator for adapter kind - used by generate() to determine API shape */
+    readonly kind: 'summarize';
+    /** Adapter name identifier */
+    readonly name: string;
+    /** The model this adapter is configured for */
+    readonly model: TModel;
+    /**
+     * @internal Type-only properties for inference. Not assigned at runtime.
+     */
+    '~types': {
+        providerOptions: TProviderOptions;
+    };
+    /**
+     * Summarize the given text
+     */
+    summarize: (options: SummarizationOptions) => Promise<SummarizationResult>;
+    /**
+     * Stream summarization of the given text.
+     * Optional - if not implemented, the activity layer will fall back to
+     * non-streaming summarize and yield the result as a single chunk.
+     */
+    summarizeStream?: (options: SummarizationOptions) => AsyncIterable<StreamChunk>;
+}
+/**
+ * A SummarizeAdapter with any/unknown type parameters.
+ * Useful as a constraint in generic functions and interfaces.
+ */
+export type AnySummarizeAdapter = SummarizeAdapter<any, any>;
+/**
+ * Abstract base class for summarize adapters.
+ * Extend this class to implement a summarize adapter for a specific provider.
+ *
+ * Generic parameters match SummarizeAdapter - all pre-resolved by the provider function.
+ */
+export declare abstract class BaseSummarizeAdapter<TModel extends string = string, TProviderOptions extends object = Record<string, unknown>> implements SummarizeAdapter<TModel, TProviderOptions> {
+    readonly kind: "summarize";
+    abstract readonly name: string;
+    readonly model: TModel;
+    '~types': {
+        providerOptions: TProviderOptions;
+    };
+    protected config: SummarizeAdapterConfig;
+    constructor(config: SummarizeAdapterConfig | undefined, model: TModel);
+    abstract summarize(options: SummarizationOptions): Promise<SummarizationResult>;
+    /**
+     * Stream summarization of the given text.
+     * Override this method in concrete implementations to enable streaming.
+     * If not overridden, the activity layer will fall back to non-streaming.
+     */
+    summarizeStream?(options: SummarizationOptions): AsyncIterable<StreamChunk>;
+    protected generateId(): string;
+}

package/dist/esm/activities/summarize/adapter.js

@@ -0,0 +1,14 @@
+class BaseSummarizeAdapter {
+  constructor(config = {}, model) {
+    this.kind = "summarize";
+    this.config = config;
+    this.model = model;
+  }
+  generateId() {
+    return `${this.name}-${Date.now()}-${Math.random().toString(36).substring(7)}`;
+  }
+}
+export {
+  BaseSummarizeAdapter
+};
+//# sourceMappingURL=adapter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sources":["../../../../src/activities/summarize/adapter.ts"],"sourcesContent":["import type {\n  StreamChunk,\n  SummarizationOptions,\n  SummarizationResult,\n} from '../../types'\n\n/**\n * Configuration for summarize adapter instances\n */\nexport interface SummarizeAdapterConfig {\n  apiKey?: string\n  baseUrl?: string\n  timeout?: number\n  maxRetries?: number\n  headers?: Record<string, string>\n}\n\n/**\n * Summarize 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 * Generic parameters:\n * - TModel: The specific model name (e.g., 'gpt-4o')\n * - TProviderOptions: Provider-specific options (already resolved)\n */\nexport interface SummarizeAdapter<\n  TModel extends string = string,\n  TProviderOptions extends object = Record<string, unknown>,\n> {\n  /** Discriminator for adapter kind - used by generate() to determine API shape */\n  readonly kind: 'summarize'\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   * Summarize the given text\n   */\n  summarize: (options: SummarizationOptions) => Promise<SummarizationResult>\n\n  /**\n   * Stream summarization of the given text.\n   * Optional - if not implemented, the activity layer will fall back to\n   * non-streaming summarize and yield the result as a single chunk.\n   */\n  summarizeStream?: (\n    options: SummarizationOptions,\n  ) => AsyncIterable<StreamChunk>\n}\n\n/**\n * A SummarizeAdapter with any/unknown type parameters.\n * Useful as a constraint in generic functions and interfaces.\n */\nexport type AnySummarizeAdapter = SummarizeAdapter<any, any>\n\n/**\n * Abstract base class for summarize adapters.\n * Extend this class to implement a summarize adapter for a specific provider.\n *\n * Generic parameters match SummarizeAdapter - all pre-resolved by the provider function.\n */\nexport abstract class BaseSummarizeAdapter<\n  TModel extends string = string,\n  TProviderOptions extends object = Record<string, unknown>,\n> implements SummarizeAdapter<TModel, TProviderOptions> {\n  readonly kind = 'summarize' 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: SummarizeAdapterConfig\n\n  constructor(config: SummarizeAdapterConfig = {}, model: TModel) {\n    this.config = config\n    this.model = model\n  }\n\n  abstract summarize(\n    options: SummarizationOptions,\n  ): Promise<SummarizationResult>\n\n  /**\n   * Stream summarization of the given text.\n   * Override this method in concrete implementations to enable streaming.\n   * If not overridden, the activity layer will fall back to non-streaming.\n   */\n  summarizeStream?(options: SummarizationOptions): AsyncIterable<StreamChunk>\n\n  protected generateId(): string {\n    return `${this.name}-${Date.now()}-${Math.random().toString(36).substring(7)}`\n  }\n}\n"],"names":[],"mappings":"AAwEO,MAAe,qBAGkC;AAAA,EAYtD,YAAY,SAAiC,CAAA,GAAI,OAAe;AAXhE,SAAS,OAAO;AAYd,SAAK,SAAS;AACd,SAAK,QAAQ;AAAA,EACf;AAAA,EAaU,aAAqB;AAC7B,WAAO,GAAG,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,KAAK,OAAA,EAAS,SAAS,EAAE,EAAE,UAAU,CAAC,CAAC;AAAA,EAC9E;AACF;"}