@tanstack/ai 0.36.0 → 0.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (205) hide show
  1. package/dist/esm/activities/chat/adapter.d.ts +163 -0
  2. package/dist/esm/activities/chat/adapter.js +17 -0
  3. package/dist/esm/activities/chat/adapter.js.map +1 -0
  4. package/dist/esm/activities/chat/agent-loop-strategies.d.ts +59 -0
  5. package/dist/esm/activities/chat/agent-loop-strategies.js +23 -0
  6. package/dist/esm/activities/chat/agent-loop-strategies.js.map +1 -0
  7. package/dist/esm/activities/chat/index.d.ts +270 -0
  8. package/dist/esm/activities/chat/index.js +1724 -0
  9. package/dist/esm/activities/chat/index.js.map +1 -0
  10. package/dist/esm/activities/chat/mcp/manager.d.ts +25 -0
  11. package/dist/esm/activities/chat/mcp/manager.js +71 -0
  12. package/dist/esm/activities/chat/mcp/manager.js.map +1 -0
  13. package/dist/esm/activities/chat/mcp/types.d.ts +56 -0
  14. package/dist/esm/activities/chat/messages.d.ts +78 -0
  15. package/dist/esm/activities/chat/messages.js +374 -0
  16. package/dist/esm/activities/chat/messages.js.map +1 -0
  17. package/dist/esm/activities/chat/middleware/builder.d.ts +46 -0
  18. package/dist/esm/activities/chat/middleware/builder.js +17 -0
  19. package/dist/esm/activities/chat/middleware/builder.js.map +1 -0
  20. package/dist/esm/activities/chat/middleware/capabilities.d.ts +93 -0
  21. package/dist/esm/activities/chat/middleware/capabilities.js +45 -0
  22. package/dist/esm/activities/chat/middleware/capabilities.js.map +1 -0
  23. package/dist/esm/activities/chat/middleware/compose.d.ts +87 -0
  24. package/dist/esm/activities/chat/middleware/compose.js +510 -0
  25. package/dist/esm/activities/chat/middleware/compose.js.map +1 -0
  26. package/dist/esm/activities/chat/middleware/define.d.ts +20 -0
  27. package/dist/esm/activities/chat/middleware/define.js +7 -0
  28. package/dist/esm/activities/chat/middleware/define.js.map +1 -0
  29. package/dist/esm/activities/chat/middleware/index.d.ts +10 -0
  30. package/dist/esm/activities/chat/middleware/tool-cache-middleware.d.ts +89 -0
  31. package/dist/esm/activities/chat/middleware/tool-cache-middleware.js +76 -0
  32. package/dist/esm/activities/chat/middleware/tool-cache-middleware.js.map +1 -0
  33. package/dist/esm/activities/chat/middleware/types.d.ts +405 -0
  34. package/dist/esm/activities/chat/middleware/validate.d.ts +19 -0
  35. package/dist/esm/activities/chat/middleware/validate.js +30 -0
  36. package/dist/esm/activities/chat/middleware/validate.js.map +1 -0
  37. package/dist/esm/activities/chat/runtime-context-types.d.ts +43 -0
  38. package/dist/esm/activities/chat/stream/index.d.ts +11 -0
  39. package/dist/esm/activities/chat/stream/json-parser.d.ts +38 -0
  40. package/dist/esm/activities/chat/stream/json-parser.js +28 -0
  41. package/dist/esm/activities/chat/stream/json-parser.js.map +1 -0
  42. package/dist/esm/activities/chat/stream/message-updaters.d.ts +81 -0
  43. package/dist/esm/activities/chat/stream/message-updaters.js +253 -0
  44. package/dist/esm/activities/chat/stream/message-updaters.js.map +1 -0
  45. package/dist/esm/activities/chat/stream/processor.d.ts +439 -0
  46. package/dist/esm/activities/chat/stream/processor.js +1426 -0
  47. package/dist/esm/activities/chat/stream/processor.js.map +1 -0
  48. package/dist/esm/activities/chat/stream/strategies.d.ts +43 -0
  49. package/dist/esm/activities/chat/stream/strategies.js +54 -0
  50. package/dist/esm/activities/chat/stream/strategies.js.map +1 -0
  51. package/dist/esm/activities/chat/stream/types.d.ts +90 -0
  52. package/dist/esm/activities/chat/tools/lazy-tool-manager.d.ts +82 -0
  53. package/dist/esm/activities/chat/tools/lazy-tool-manager.js +194 -0
  54. package/dist/esm/activities/chat/tools/lazy-tool-manager.js.map +1 -0
  55. package/dist/esm/activities/chat/tools/lazy-tools.d.ts +15 -0
  56. package/dist/esm/activities/chat/tools/lazy-tools.js +16 -0
  57. package/dist/esm/activities/chat/tools/lazy-tools.js.map +1 -0
  58. package/dist/esm/activities/chat/tools/schema-converter.d.ts +140 -0
  59. package/dist/esm/activities/chat/tools/schema-converter.js +167 -0
  60. package/dist/esm/activities/chat/tools/schema-converter.js.map +1 -0
  61. package/dist/esm/activities/chat/tools/tool-calls.d.ts +140 -0
  62. package/dist/esm/activities/chat/tools/tool-calls.js +512 -0
  63. package/dist/esm/activities/chat/tools/tool-calls.js.map +1 -0
  64. package/dist/esm/activities/chat/tools/tool-definition.d.ts +135 -0
  65. package/dist/esm/activities/chat/tools/tool-definition.js +25 -0
  66. package/dist/esm/activities/chat/tools/tool-definition.js.map +1 -0
  67. package/dist/esm/activities/error-payload.d.ts +30 -0
  68. package/dist/esm/activities/error-payload.js +54 -0
  69. package/dist/esm/activities/error-payload.js.map +1 -0
  70. package/dist/esm/activities/generateAudio/adapter.d.ts +62 -0
  71. package/dist/esm/activities/generateAudio/adapter.js +16 -0
  72. package/dist/esm/activities/generateAudio/adapter.js.map +1 -0
  73. package/dist/esm/activities/generateAudio/index.d.ts +85 -0
  74. package/dist/esm/activities/generateAudio/index.js +114 -0
  75. package/dist/esm/activities/generateAudio/index.js.map +1 -0
  76. package/dist/esm/activities/generateImage/adapter.d.ts +78 -0
  77. package/dist/esm/activities/generateImage/adapter.js +16 -0
  78. package/dist/esm/activities/generateImage/adapter.js.map +1 -0
  79. package/dist/esm/activities/generateImage/index.d.ts +134 -0
  80. package/dist/esm/activities/generateImage/index.js +121 -0
  81. package/dist/esm/activities/generateImage/index.js.map +1 -0
  82. package/dist/esm/activities/generateSpeech/adapter.d.ts +62 -0
  83. package/dist/esm/activities/generateSpeech/adapter.js +16 -0
  84. package/dist/esm/activities/generateSpeech/adapter.js.map +1 -0
  85. package/dist/esm/activities/generateSpeech/index.d.ts +96 -0
  86. package/dist/esm/activities/generateSpeech/index.js +119 -0
  87. package/dist/esm/activities/generateSpeech/index.js.map +1 -0
  88. package/dist/esm/activities/generateTranscription/adapter.d.ts +62 -0
  89. package/dist/esm/activities/generateTranscription/adapter.js +16 -0
  90. package/dist/esm/activities/generateTranscription/adapter.js.map +1 -0
  91. package/dist/esm/activities/generateTranscription/index.d.ts +109 -0
  92. package/dist/esm/activities/generateTranscription/index.js +109 -0
  93. package/dist/esm/activities/generateTranscription/index.js.map +1 -0
  94. package/dist/esm/activities/generateVideo/adapter.d.ts +145 -0
  95. package/dist/esm/activities/generateVideo/adapter.js +30 -0
  96. package/dist/esm/activities/generateVideo/adapter.js.map +1 -0
  97. package/dist/esm/activities/generateVideo/index.d.ts +223 -0
  98. package/dist/esm/activities/generateVideo/index.js +295 -0
  99. package/dist/esm/activities/generateVideo/index.js.map +1 -0
  100. package/dist/esm/activities/generateVideo/snap.d.ts +14 -0
  101. package/dist/esm/activities/generateVideo/snap.js +54 -0
  102. package/dist/esm/activities/generateVideo/snap.js.map +1 -0
  103. package/dist/esm/activities/index.d.ts +27 -0
  104. package/dist/esm/activities/index.js +43 -0
  105. package/dist/esm/activities/index.js.map +1 -0
  106. package/dist/esm/activities/middleware/index.d.ts +2 -0
  107. package/dist/esm/activities/middleware/run.d.ts +20 -0
  108. package/dist/esm/activities/middleware/run.js +42 -0
  109. package/dist/esm/activities/middleware/run.js.map +1 -0
  110. package/dist/esm/activities/middleware/types.d.ts +118 -0
  111. package/dist/esm/activities/stream-generation-result.d.ts +15 -0
  112. package/dist/esm/activities/stream-generation-result.js +49 -0
  113. package/dist/esm/activities/stream-generation-result.js.map +1 -0
  114. package/dist/esm/activities/summarize/adapter.d.ts +74 -0
  115. package/dist/esm/activities/summarize/adapter.js +16 -0
  116. package/dist/esm/activities/summarize/adapter.js.map +1 -0
  117. package/dist/esm/activities/summarize/chat-stream-summarize.d.ts +45 -0
  118. package/dist/esm/activities/summarize/chat-stream-summarize.js +212 -0
  119. package/dist/esm/activities/summarize/chat-stream-summarize.js.map +1 -0
  120. package/dist/esm/activities/summarize/index.d.ts +108 -0
  121. package/dist/esm/activities/summarize/index.js +113 -0
  122. package/dist/esm/activities/summarize/index.js.map +1 -0
  123. package/dist/esm/adapter-internals.d.ts +5 -0
  124. package/dist/esm/adapter-internals.js +10 -0
  125. package/dist/esm/adapter-internals.js.map +1 -0
  126. package/dist/esm/client.d.ts +44 -0
  127. package/dist/esm/client.js +67 -0
  128. package/dist/esm/client.js.map +1 -0
  129. package/dist/esm/extend-adapter.d.ts +152 -0
  130. package/dist/esm/extend-adapter.js +21 -0
  131. package/dist/esm/extend-adapter.js.map +1 -0
  132. package/dist/esm/index.d.ts +45 -0
  133. package/dist/esm/index.js +109 -0
  134. package/dist/esm/index.js.map +1 -0
  135. package/dist/esm/logger/console-logger.d.ts +29 -0
  136. package/dist/esm/logger/console-logger.js +83 -0
  137. package/dist/esm/logger/console-logger.js.map +1 -0
  138. package/dist/esm/logger/internal-logger.d.ts +41 -0
  139. package/dist/esm/logger/internal-logger.js +86 -0
  140. package/dist/esm/logger/internal-logger.js.map +1 -0
  141. package/dist/esm/logger/resolve.d.ts +14 -0
  142. package/dist/esm/logger/resolve.js +54 -0
  143. package/dist/esm/logger/resolve.js.map +1 -0
  144. package/dist/esm/logger/types.d.ts +75 -0
  145. package/dist/esm/middlewares/content-guard.d.ts +77 -0
  146. package/dist/esm/middlewares/content-guard.js +156 -0
  147. package/dist/esm/middlewares/content-guard.js.map +1 -0
  148. package/dist/esm/middlewares/index.d.ts +2 -0
  149. package/dist/esm/middlewares/index.js +7 -0
  150. package/dist/esm/middlewares/index.js.map +1 -0
  151. package/dist/esm/middlewares/otel.d.ts +81 -0
  152. package/dist/esm/middlewares/otel.js +745 -0
  153. package/dist/esm/middlewares/otel.js.map +1 -0
  154. package/dist/esm/middlewares/tool-cache.d.ts +1 -0
  155. package/dist/esm/middlewares/usage-attributes.d.ts +24 -0
  156. package/dist/esm/middlewares/usage-attributes.js +43 -0
  157. package/dist/esm/middlewares/usage-attributes.js.map +1 -0
  158. package/dist/esm/realtime/index.d.ts +28 -0
  159. package/dist/esm/realtime/index.js +8 -0
  160. package/dist/esm/realtime/index.js.map +1 -0
  161. package/dist/esm/realtime/types.d.ts +282 -0
  162. package/dist/esm/stream-to-response.d.ts +102 -0
  163. package/dist/esm/stream-to-response.js +121 -0
  164. package/dist/esm/stream-to-response.js.map +1 -0
  165. package/dist/esm/strip-to-spec-middleware.d.ts +18 -0
  166. package/dist/esm/strip-to-spec-middleware.js +20 -0
  167. package/dist/esm/strip-to-spec-middleware.js.map +1 -0
  168. package/dist/esm/system-prompts.d.ts +66 -0
  169. package/dist/esm/system-prompts.js +23 -0
  170. package/dist/esm/system-prompts.js.map +1 -0
  171. package/dist/esm/tool-registry.d.ts +81 -0
  172. package/dist/esm/tool-registry.js +49 -0
  173. package/dist/esm/tool-registry.js.map +1 -0
  174. package/dist/esm/tools/provider-tool.d.ts +30 -0
  175. package/dist/esm/tools/provider-tool.js +7 -0
  176. package/dist/esm/tools/provider-tool.js.map +1 -0
  177. package/dist/esm/types.d.ts +1594 -0
  178. package/dist/esm/utilities/ag-ui-wire.d.ts +44 -0
  179. package/dist/esm/utilities/ag-ui-wire.js +107 -0
  180. package/dist/esm/utilities/ag-ui-wire.js.map +1 -0
  181. package/dist/esm/utilities/chat-params.d.ts +85 -0
  182. package/dist/esm/utilities/chat-params.js +100 -0
  183. package/dist/esm/utilities/chat-params.js.map +1 -0
  184. package/dist/esm/utilities/errors.d.ts +13 -0
  185. package/dist/esm/utilities/errors.js +22 -0
  186. package/dist/esm/utilities/errors.js.map +1 -0
  187. package/dist/esm/utilities/media-prompt.d.ts +35 -0
  188. package/dist/esm/utilities/media-prompt.js +43 -0
  189. package/dist/esm/utilities/media-prompt.js.map +1 -0
  190. package/dist/esm/utilities/numbers.d.ts +8 -0
  191. package/dist/esm/utilities/numbers.js +12 -0
  192. package/dist/esm/utilities/numbers.js.map +1 -0
  193. package/dist/esm/utilities/sampling-keys.d.ts +20 -0
  194. package/dist/esm/utilities/sampling-keys.js +20 -0
  195. package/dist/esm/utilities/sampling-keys.js.map +1 -0
  196. package/dist/esm/utilities/tool-result.d.ts +21 -0
  197. package/dist/esm/utilities/tool-result.js +37 -0
  198. package/dist/esm/utilities/tool-result.js.map +1 -0
  199. package/dist/esm/utilities/usage.d.ts +31 -0
  200. package/dist/esm/utilities/usage.js +11 -0
  201. package/dist/esm/utilities/usage.js.map +1 -0
  202. package/dist/esm/utils.d.ts +17 -0
  203. package/dist/esm/utils.js +20 -0
  204. package/dist/esm/utils.js.map +1 -0
  205. package/package.json +3 -3
@@ -0,0 +1,119 @@
1
+ import { aiEventClient } from "@tanstack/ai-event-client";
2
+ import { streamGenerationResult } from "../stream-generation-result.js";
3
+ import { resolveDebugOption } from "../../logger/resolve.js";
4
+ import { createGenerationContext, runGenerationStart, runGenerationUsage, runGenerationFinish, runGenerationError } from "../middleware/run.js";
5
+ const kind = "tts";
6
+ function createId(prefix) {
7
+ return `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2, 9)}`;
8
+ }
9
+ function generateSpeech(options) {
10
+ if (options.stream) {
11
+ return streamGenerationResult(
12
+ () => runGenerateSpeech(options)
13
+ );
14
+ }
15
+ return runGenerateSpeech(options);
16
+ }
17
+ async function runGenerateSpeech(options) {
18
+ const {
19
+ adapter,
20
+ stream: _stream,
21
+ debug: _debug,
22
+ middleware,
23
+ ...rest
24
+ } = options;
25
+ const model = adapter.model;
26
+ const requestId = createId("speech");
27
+ const startTime = Date.now();
28
+ const logger = resolveDebugOption(options.debug);
29
+ const providerName = adapter.provider ?? adapter.name ?? "unknown";
30
+ const mwCtx = createGenerationContext({
31
+ requestId,
32
+ activity: "tts",
33
+ provider: adapter.name,
34
+ model,
35
+ modelOptions: rest.modelOptions,
36
+ createId
37
+ });
38
+ await runGenerationStart(middleware, mwCtx);
39
+ aiEventClient.emit("speech:request:started", {
40
+ requestId,
41
+ provider: adapter.name,
42
+ model,
43
+ text: rest.text,
44
+ voice: rest.voice,
45
+ format: rest.format,
46
+ speed: rest.speed,
47
+ modelOptions: rest.modelOptions,
48
+ timestamp: startTime
49
+ });
50
+ logger.request(`activity=generateSpeech provider=${providerName}`, {
51
+ provider: providerName,
52
+ model
53
+ });
54
+ try {
55
+ const result = await adapter.generateSpeech({ ...rest, model, logger });
56
+ const duration = Date.now() - startTime;
57
+ aiEventClient.emit("speech:request:completed", {
58
+ requestId,
59
+ provider: adapter.name,
60
+ model,
61
+ audio: result.audio,
62
+ format: result.format,
63
+ audioDuration: result.duration,
64
+ contentType: result.contentType,
65
+ duration,
66
+ modelOptions: rest.modelOptions,
67
+ timestamp: Date.now()
68
+ });
69
+ if (result.usage) {
70
+ aiEventClient.emit("speech:usage", {
71
+ requestId,
72
+ model,
73
+ usage: result.usage,
74
+ modelOptions: rest.modelOptions,
75
+ timestamp: Date.now()
76
+ });
77
+ }
78
+ logger.output(`activity=generateSpeech bytes=${result.audio.length}`, {
79
+ bytes: result.audio.length,
80
+ contentType: result.contentType
81
+ });
82
+ if (result.usage) await runGenerationUsage(middleware, mwCtx, result.usage);
83
+ await runGenerationFinish(middleware, mwCtx, {
84
+ duration,
85
+ usage: result.usage
86
+ });
87
+ return result;
88
+ } catch (error) {
89
+ const duration = Date.now() - startTime;
90
+ const err = error;
91
+ aiEventClient.emit("speech:request:error", {
92
+ requestId,
93
+ provider: adapter.name,
94
+ model,
95
+ error: { message: err.message, name: err.name },
96
+ duration,
97
+ modelOptions: rest.modelOptions,
98
+ timestamp: Date.now()
99
+ });
100
+ await runGenerationError(middleware, mwCtx, {
101
+ error,
102
+ duration
103
+ });
104
+ logger.errors("generateSpeech activity failed", {
105
+ error,
106
+ source: "generateSpeech"
107
+ });
108
+ throw error;
109
+ }
110
+ }
111
+ function createSpeechOptions(options) {
112
+ return options;
113
+ }
114
+ export {
115
+ createSpeechOptions,
116
+ generateSpeech,
117
+ kind
118
+ };
119
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sources":["../../../../src/activities/generateSpeech/index.ts"],"sourcesContent":["/**\n * TTS Activity\n *\n * Generates speech audio from text using text-to-speech models.\n * This is a self-contained module with implementation, types, and JSDoc.\n */\n\nimport { aiEventClient } from '@tanstack/ai-event-client'\nimport { streamGenerationResult } from '../stream-generation-result.js'\nimport { resolveDebugOption } from '../../logger/resolve'\nimport {\n createGenerationContext,\n runGenerationError,\n runGenerationFinish,\n runGenerationStart,\n runGenerationUsage,\n} from '../middleware'\nimport type { InternalLogger } from '../../logger/internal-logger'\nimport type { DebugOption } from '../../logger/types'\nimport type { GenerationMiddleware } from '../middleware'\nimport type { TTSAdapter } from './adapter'\nimport type { StreamChunk, TTSResult } from '../../types'\n\n// ===========================\n// Activity Kind\n// ===========================\n\n/** The adapter kind this activity handles */\nexport const kind = 'tts' as const\n\n// ===========================\n// Type Extraction Helpers\n// ===========================\n\n/**\n * Extract provider options from a TTSAdapter via ~types.\n */\nexport type TTSProviderOptions<TAdapter> =\n TAdapter extends TTSAdapter<any, any>\n ? TAdapter['~types']['providerOptions']\n : object\n\n// ===========================\n// Activity Options Type\n// ===========================\n\n/**\n * Options for the TTS activity.\n * The model is extracted from the adapter's model property.\n *\n * @template TAdapter - The TTS adapter type\n * @template TStream - Whether to stream the output\n */\nexport interface TTSActivityOptions<\n TAdapter extends TTSAdapter<string, TTSProviderOptions<TAdapter>>,\n TStream extends boolean = false,\n> {\n /** The TTS adapter to use (must be created with a model) */\n adapter: TAdapter & { kind: typeof kind }\n /** The text to convert to speech */\n text: string\n /** The voice to use for generation */\n voice?: string\n /** The output audio format */\n format?: 'mp3' | 'opus' | 'aac' | 'flac' | 'wav' | 'pcm'\n /** The speed of the generated audio (0.25 to 4.0) */\n speed?: number\n /** Provider-specific options for TTS generation */\n modelOptions?: TTSProviderOptions<TAdapter>\n /**\n * Whether to stream the generation result.\n * When true, returns an AsyncIterable<StreamChunk> for streaming transport.\n * When false or not provided, returns a Promise<TTSResult>.\n *\n * @default false\n */\n stream?: TStream\n /**\n * Enable debug logging. Pass `true` to enable all categories, `false` to\n * silence everything including errors, or a `DebugConfig` object for granular\n * control and/or a custom `Logger`.\n */\n debug?: DebugOption\n /**\n * Observe-only middleware notified on start, usage, success, and error. Pass\n * `otelMiddleware()` to emit OpenTelemetry spans, or implement the\n * `GenerationMiddleware` contract for a custom backend.\n */\n middleware?: Array<GenerationMiddleware>\n}\n\n// ===========================\n// Activity Result Type\n// ===========================\n\n/**\n * Result type for the TTS activity.\n * - If stream is true: AsyncIterable<StreamChunk>\n * - Otherwise: Promise<TTSResult>\n */\nexport type TTSActivityResult<TStream extends boolean = false> =\n TStream extends true ? AsyncIterable<StreamChunk> : Promise<TTSResult>\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 * TTS activity - generates speech from text.\n *\n * Uses AI text-to-speech models to create audio from natural language text.\n *\n * @example Generate speech from text\n * ```ts\n * import { generateSpeech } from '@tanstack/ai'\n * import { openaiSpeech } from '@tanstack/ai-openai'\n *\n * const result = await generateSpeech({\n * adapter: openaiSpeech('tts-1-hd'),\n * text: 'Hello, welcome to TanStack AI!',\n * voice: 'nova'\n * })\n *\n * console.log(result.audio) // base64-encoded audio\n * ```\n *\n * @example With format and speed options\n * ```ts\n * const result = await generateSpeech({\n * adapter: openaiSpeech('tts-1'),\n * text: 'This is slower speech.',\n * voice: 'alloy',\n * format: 'wav',\n * speed: 0.8\n * })\n * ```\n */\nexport function generateSpeech<\n TAdapter extends TTSAdapter<string, TTSProviderOptions<TAdapter>>,\n TStream extends boolean = false,\n>(options: TTSActivityOptions<TAdapter, TStream>): TTSActivityResult<TStream> {\n if (options.stream) {\n return streamGenerationResult(() =>\n runGenerateSpeech(options),\n ) as TTSActivityResult<TStream>\n }\n return runGenerateSpeech(options) as TTSActivityResult<TStream>\n}\n\n/**\n * Run the core TTS generation logic (non-streaming).\n */\nasync function runGenerateSpeech<\n TAdapter extends TTSAdapter<string, TTSProviderOptions<TAdapter>>,\n>(options: TTSActivityOptions<TAdapter, boolean>): Promise<TTSResult> {\n const {\n adapter,\n stream: _stream,\n debug: _debug,\n middleware,\n ...rest\n } = options\n const model = adapter.model\n const requestId = createId('speech')\n const startTime = Date.now()\n const logger: InternalLogger = resolveDebugOption(options.debug)\n const providerName =\n (adapter as { name?: string; provider?: string }).provider ??\n (adapter as { name?: string }).name ??\n 'unknown'\n\n const mwCtx = createGenerationContext({\n requestId,\n activity: 'tts',\n provider: adapter.name,\n model,\n modelOptions: rest.modelOptions,\n createId,\n })\n\n await runGenerationStart(middleware, mwCtx)\n\n aiEventClient.emit('speech:request:started', {\n requestId,\n provider: adapter.name,\n model,\n text: rest.text,\n voice: rest.voice,\n format: rest.format,\n speed: rest.speed,\n modelOptions: rest.modelOptions as Record<string, unknown> | undefined,\n timestamp: startTime,\n })\n\n logger.request(`activity=generateSpeech provider=${providerName}`, {\n provider: providerName,\n model,\n })\n\n try {\n const result = await adapter.generateSpeech({ ...rest, model, logger })\n const duration = Date.now() - startTime\n\n aiEventClient.emit('speech:request:completed', {\n requestId,\n provider: adapter.name,\n model,\n audio: result.audio,\n format: result.format,\n audioDuration: result.duration,\n contentType: result.contentType,\n duration,\n modelOptions: rest.modelOptions as Record<string, unknown> | undefined,\n timestamp: Date.now(),\n })\n\n if (result.usage) {\n aiEventClient.emit('speech: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 logger.output(`activity=generateSpeech bytes=${result.audio.length}`, {\n bytes: result.audio.length,\n contentType: result.contentType,\n })\n\n if (result.usage) await runGenerationUsage(middleware, mwCtx, result.usage)\n await runGenerationFinish(middleware, mwCtx, {\n duration,\n usage: result.usage,\n })\n\n return result\n } catch (error) {\n const duration = Date.now() - startTime\n const err = error as Error\n aiEventClient.emit('speech:request:error', {\n requestId,\n provider: adapter.name,\n model,\n error: { message: err.message, name: err.name },\n duration,\n modelOptions: rest.modelOptions as Record<string, unknown> | undefined,\n timestamp: Date.now(),\n })\n await runGenerationError(middleware, mwCtx, {\n error,\n duration,\n })\n logger.errors('generateSpeech activity failed', {\n error,\n source: 'generateSpeech',\n })\n throw error\n }\n}\n\n// ===========================\n// Options Factory\n// ===========================\n\n/**\n * Create typed options for the generateSpeech() function without executing.\n */\nexport function createSpeechOptions<\n TAdapter extends TTSAdapter<string, TTSProviderOptions<TAdapter>>,\n TStream extends boolean = false,\n>(\n options: TTSActivityOptions<TAdapter, TStream>,\n): TTSActivityOptions<TAdapter, TStream> {\n return options\n}\n\n// Re-export adapter types\nexport type { TTSAdapter, TTSAdapterConfig, AnyTTSAdapter } from './adapter'\nexport { BaseTTSAdapter } from './adapter'\n"],"names":[],"mappings":";;;;AA4BO,MAAM,OAAO;AA2EpB,SAAS,SAAS,QAAwB;AACxC,SAAO,GAAG,MAAM,IAAI,KAAK,IAAA,CAAK,IAAI,KAAK,OAAA,EAAS,SAAS,EAAE,EAAE,MAAM,GAAG,CAAC,CAAC;AAC1E;AAoCO,SAAS,eAGd,SAA4E;AAC5E,MAAI,QAAQ,QAAQ;AAClB,WAAO;AAAA,MAAuB,MAC5B,kBAAkB,OAAO;AAAA,IAAA;AAAA,EAE7B;AACA,SAAO,kBAAkB,OAAO;AAClC;AAKA,eAAe,kBAEb,SAAoE;AACpE,QAAM;AAAA,IACJ;AAAA,IACA,QAAQ;AAAA,IACR,OAAO;AAAA,IACP;AAAA,IACA,GAAG;AAAA,EAAA,IACD;AACJ,QAAM,QAAQ,QAAQ;AACtB,QAAM,YAAY,SAAS,QAAQ;AACnC,QAAM,YAAY,KAAK,IAAA;AACvB,QAAM,SAAyB,mBAAmB,QAAQ,KAAK;AAC/D,QAAM,eACH,QAAiD,YACjD,QAA8B,QAC/B;AAEF,QAAM,QAAQ,wBAAwB;AAAA,IACpC;AAAA,IACA,UAAU;AAAA,IACV,UAAU,QAAQ;AAAA,IAClB;AAAA,IACA,cAAc,KAAK;AAAA,IACnB;AAAA,EAAA,CACD;AAED,QAAM,mBAAmB,YAAY,KAAK;AAE1C,gBAAc,KAAK,0BAA0B;AAAA,IAC3C;AAAA,IACA,UAAU,QAAQ;AAAA,IAClB;AAAA,IACA,MAAM,KAAK;AAAA,IACX,OAAO,KAAK;AAAA,IACZ,QAAQ,KAAK;AAAA,IACb,OAAO,KAAK;AAAA,IACZ,cAAc,KAAK;AAAA,IACnB,WAAW;AAAA,EAAA,CACZ;AAED,SAAO,QAAQ,oCAAoC,YAAY,IAAI;AAAA,IACjE,UAAU;AAAA,IACV;AAAA,EAAA,CACD;AAED,MAAI;AACF,UAAM,SAAS,MAAM,QAAQ,eAAe,EAAE,GAAG,MAAM,OAAO,QAAQ;AACtE,UAAM,WAAW,KAAK,IAAA,IAAQ;AAE9B,kBAAc,KAAK,4BAA4B;AAAA,MAC7C;AAAA,MACA,UAAU,QAAQ;AAAA,MAClB;AAAA,MACA,OAAO,OAAO;AAAA,MACd,QAAQ,OAAO;AAAA,MACf,eAAe,OAAO;AAAA,MACtB,aAAa,OAAO;AAAA,MACpB;AAAA,MACA,cAAc,KAAK;AAAA,MACnB,WAAW,KAAK,IAAA;AAAA,IAAI,CACrB;AAED,QAAI,OAAO,OAAO;AAChB,oBAAc,KAAK,gBAAgB;AAAA,QACjC;AAAA,QACA;AAAA,QACA,OAAO,OAAO;AAAA,QACd,cAAc,KAAK;AAAA,QACnB,WAAW,KAAK,IAAA;AAAA,MAAI,CACrB;AAAA,IACH;AAEA,WAAO,OAAO,iCAAiC,OAAO,MAAM,MAAM,IAAI;AAAA,MACpE,OAAO,OAAO,MAAM;AAAA,MACpB,aAAa,OAAO;AAAA,IAAA,CACrB;AAED,QAAI,OAAO,MAAO,OAAM,mBAAmB,YAAY,OAAO,OAAO,KAAK;AAC1E,UAAM,oBAAoB,YAAY,OAAO;AAAA,MAC3C;AAAA,MACA,OAAO,OAAO;AAAA,IAAA,CACf;AAED,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,WAAW,KAAK,IAAA,IAAQ;AAC9B,UAAM,MAAM;AACZ,kBAAc,KAAK,wBAAwB;AAAA,MACzC;AAAA,MACA,UAAU,QAAQ;AAAA,MAClB;AAAA,MACA,OAAO,EAAE,SAAS,IAAI,SAAS,MAAM,IAAI,KAAA;AAAA,MACzC;AAAA,MACA,cAAc,KAAK;AAAA,MACnB,WAAW,KAAK,IAAA;AAAA,IAAI,CACrB;AACD,UAAM,mBAAmB,YAAY,OAAO;AAAA,MAC1C;AAAA,MACA;AAAA,IAAA,CACD;AACD,WAAO,OAAO,kCAAkC;AAAA,MAC9C;AAAA,MACA,QAAQ;AAAA,IAAA,CACT;AACD,UAAM;AAAA,EACR;AACF;AASO,SAAS,oBAId,SACuC;AACvC,SAAO;AACT;"}
@@ -0,0 +1,62 @@
1
+ import { TranscriptionOptions, TranscriptionResult } from '../../types.js';
2
+ /**
3
+ * Configuration for transcription adapter instances
4
+ */
5
+ export interface TranscriptionAdapterConfig {
6
+ apiKey?: string;
7
+ baseUrl?: string;
8
+ timeout?: number;
9
+ maxRetries?: number;
10
+ headers?: Record<string, string>;
11
+ }
12
+ /**
13
+ * Transcription adapter interface with pre-resolved generics.
14
+ *
15
+ * An adapter is created by a provider function: `provider('model')` → `adapter`
16
+ * All type resolution happens at the provider call site, not in this interface.
17
+ *
18
+ * Generic parameters:
19
+ * - TModel: The specific model name (e.g., 'whisper-1')
20
+ * - TProviderOptions: Provider-specific options (already resolved)
21
+ */
22
+ export interface TranscriptionAdapter<TModel extends string = string, TProviderOptions extends object = Record<string, unknown>> {
23
+ /** Discriminator for adapter kind - used to determine API shape */
24
+ readonly kind: 'transcription';
25
+ /** Adapter name identifier */
26
+ readonly name: string;
27
+ /** The model this adapter is configured for */
28
+ readonly model: TModel;
29
+ /**
30
+ * @internal Type-only properties for inference. Not assigned at runtime.
31
+ */
32
+ '~types': {
33
+ providerOptions: TProviderOptions;
34
+ };
35
+ /**
36
+ * Transcribe audio to text
37
+ */
38
+ transcribe: (options: TranscriptionOptions<TProviderOptions>) => Promise<TranscriptionResult>;
39
+ }
40
+ /**
41
+ * A TranscriptionAdapter with any/unknown type parameters.
42
+ * Useful as a constraint in generic functions and interfaces.
43
+ */
44
+ export type AnyTranscriptionAdapter = TranscriptionAdapter<any, any>;
45
+ /**
46
+ * Abstract base class for audio transcription adapters.
47
+ * Extend this class to implement a transcription adapter for a specific provider.
48
+ *
49
+ * Generic parameters match TranscriptionAdapter - all pre-resolved by the provider function.
50
+ */
51
+ export declare abstract class BaseTranscriptionAdapter<TModel extends string = string, TProviderOptions extends object = Record<string, unknown>> implements TranscriptionAdapter<TModel, TProviderOptions> {
52
+ readonly kind: "transcription";
53
+ abstract readonly name: string;
54
+ readonly model: TModel;
55
+ '~types': {
56
+ providerOptions: TProviderOptions;
57
+ };
58
+ protected config: TranscriptionAdapterConfig;
59
+ constructor(model: TModel, config?: TranscriptionAdapterConfig);
60
+ abstract transcribe(options: TranscriptionOptions<TProviderOptions>): Promise<TranscriptionResult>;
61
+ protected generateId(): string;
62
+ }
@@ -0,0 +1,16 @@
1
+ class BaseTranscriptionAdapter {
2
+ kind = "transcription";
3
+ model;
4
+ config;
5
+ constructor(model, config = {}) {
6
+ this.config = config;
7
+ this.model = model;
8
+ }
9
+ generateId() {
10
+ return `${this.name}-${Date.now()}-${Math.random().toString(36).substring(7)}`;
11
+ }
12
+ }
13
+ export {
14
+ BaseTranscriptionAdapter
15
+ };
16
+ //# sourceMappingURL=adapter.js.map
@@ -0,0 +1 @@
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(model: TModel, config: TranscriptionAdapterConfig = {}) {\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,EACjD,OAAO;AAAA,EAEP;AAAA,EAOC;AAAA,EAEV,YAAY,OAAe,SAAqC,IAAI;AAClE,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;"}
@@ -0,0 +1,109 @@
1
+ import { DebugOption } from '../../logger/types.js';
2
+ import { GenerationMiddleware } from '../middleware.js';
3
+ import { TranscriptionAdapter } from './adapter.js';
4
+ import { StreamChunk, TranscriptionResult } from '../../types.js';
5
+ /** The adapter kind this activity handles */
6
+ export declare const kind: "transcription";
7
+ /**
8
+ * Extract provider options from a TranscriptionAdapter via ~types.
9
+ */
10
+ export type TranscriptionProviderOptions<TAdapter> = TAdapter extends TranscriptionAdapter<any, any> ? TAdapter['~types']['providerOptions'] : object;
11
+ /**
12
+ * Options for the transcription activity.
13
+ * The model is extracted from the adapter's model property.
14
+ *
15
+ * @template TAdapter - The transcription adapter type
16
+ * @template TStream - Whether to stream the output
17
+ */
18
+ export interface TranscriptionActivityOptions<TAdapter extends TranscriptionAdapter<string, TranscriptionProviderOptions<TAdapter>>, TStream extends boolean = false> {
19
+ /** The transcription adapter to use (must be created with a model) */
20
+ adapter: TAdapter & {
21
+ kind: typeof kind;
22
+ };
23
+ /** The audio data to transcribe - can be base64 string, File, Blob, or Buffer */
24
+ audio: string | File | Blob | ArrayBuffer;
25
+ /** The language of the audio in ISO-639-1 format (e.g., 'en') */
26
+ language?: string;
27
+ /** An optional prompt to guide the transcription */
28
+ prompt?: string;
29
+ /** The format of the transcription output */
30
+ responseFormat?: 'json' | 'text' | 'srt' | 'verbose_json' | 'vtt';
31
+ /** Provider-specific options for transcription */
32
+ modelOptions?: TranscriptionProviderOptions<TAdapter>;
33
+ /**
34
+ * Whether to stream the transcription result.
35
+ * When true, returns an AsyncIterable<StreamChunk> for streaming transport.
36
+ * When false or not provided, returns a Promise<TranscriptionResult>.
37
+ *
38
+ * @default false
39
+ */
40
+ stream?: TStream;
41
+ /**
42
+ * Enable debug logging. Pass `true` to enable all categories, `false` to
43
+ * silence everything including errors, or a `DebugConfig` object for granular
44
+ * control and/or a custom `Logger`.
45
+ */
46
+ debug?: DebugOption;
47
+ /**
48
+ * Observe-only middleware notified on start, usage, success, and error. Pass
49
+ * `otelMiddleware()` to emit OpenTelemetry spans, or implement the
50
+ * `GenerationMiddleware` contract for a custom backend.
51
+ */
52
+ middleware?: Array<GenerationMiddleware>;
53
+ }
54
+ /**
55
+ * Result type for the transcription activity.
56
+ * - If stream is true: AsyncIterable<StreamChunk>
57
+ * - Otherwise: Promise<TranscriptionResult>
58
+ */
59
+ export type TranscriptionActivityResult<TStream extends boolean = false> = TStream extends true ? AsyncIterable<StreamChunk> : Promise<TranscriptionResult>;
60
+ /**
61
+ * Transcription activity - converts audio to text.
62
+ *
63
+ * Uses AI speech-to-text models to transcribe audio content.
64
+ *
65
+ * @example Transcribe an audio file
66
+ * ```ts
67
+ * import { generateTranscription } from '@tanstack/ai'
68
+ * import { openaiTranscription } from '@tanstack/ai-openai'
69
+ *
70
+ * const result = await generateTranscription({
71
+ * adapter: openaiTranscription('whisper-1'),
72
+ * audio: audioFile, // File, Blob, or base64 string
73
+ * language: 'en'
74
+ * })
75
+ *
76
+ * console.log(result.text)
77
+ * ```
78
+ *
79
+ * @example With verbose output for timestamps
80
+ * ```ts
81
+ * const result = await generateTranscription({
82
+ * adapter: openaiTranscription('whisper-1'),
83
+ * audio: audioFile,
84
+ * responseFormat: 'verbose_json'
85
+ * })
86
+ *
87
+ * result.segments?.forEach(segment => {
88
+ * console.log(`[${segment.start}s - ${segment.end}s]: ${segment.text}`)
89
+ * })
90
+ * ```
91
+ *
92
+ * @example Streaming transcription result
93
+ * ```ts
94
+ * for await (const chunk of generateTranscription({
95
+ * adapter: openaiTranscription('whisper-1'),
96
+ * audio: audioFile,
97
+ * stream: true
98
+ * })) {
99
+ * console.log(chunk)
100
+ * }
101
+ * ```
102
+ */
103
+ export declare function generateTranscription<TAdapter extends TranscriptionAdapter<string, TranscriptionProviderOptions<TAdapter>>, TStream extends boolean = false>(options: TranscriptionActivityOptions<TAdapter, TStream>): TranscriptionActivityResult<TStream>;
104
+ /**
105
+ * Create typed options for the generateTranscription() function without executing.
106
+ */
107
+ export declare function createTranscriptionOptions<TAdapter extends TranscriptionAdapter<string, TranscriptionProviderOptions<TAdapter>>, TStream extends boolean = false>(options: TranscriptionActivityOptions<TAdapter, TStream>): TranscriptionActivityOptions<TAdapter, TStream>;
108
+ export type { TranscriptionAdapter, TranscriptionAdapterConfig, AnyTranscriptionAdapter, } from './adapter.js';
109
+ export { BaseTranscriptionAdapter } from './adapter.js';
@@ -0,0 +1,109 @@
1
+ import { aiEventClient } from "@tanstack/ai-event-client";
2
+ import { streamGenerationResult } from "../stream-generation-result.js";
3
+ import { resolveDebugOption } from "../../logger/resolve.js";
4
+ import { createGenerationContext, runGenerationStart, runGenerationUsage, runGenerationFinish, runGenerationError } from "../middleware/run.js";
5
+ const kind = "transcription";
6
+ function createId(prefix) {
7
+ return `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2, 9)}`;
8
+ }
9
+ function generateTranscription(options) {
10
+ if (options.stream) {
11
+ return streamGenerationResult(
12
+ () => runGenerateTranscription(options)
13
+ );
14
+ }
15
+ return runGenerateTranscription(
16
+ options
17
+ );
18
+ }
19
+ async function runGenerateTranscription(options) {
20
+ const {
21
+ adapter,
22
+ stream: _stream,
23
+ debug: _debug,
24
+ middleware,
25
+ ...rest
26
+ } = options;
27
+ const model = adapter.model;
28
+ const requestId = createId("transcription");
29
+ const startTime = Date.now();
30
+ const logger = resolveDebugOption(options.debug);
31
+ const providerName = adapter.provider ?? adapter.name ?? "unknown";
32
+ const mwCtx = createGenerationContext({
33
+ requestId,
34
+ activity: "transcription",
35
+ provider: adapter.name,
36
+ model,
37
+ modelOptions: rest.modelOptions,
38
+ createId
39
+ });
40
+ await runGenerationStart(middleware, mwCtx);
41
+ aiEventClient.emit("transcription:request:started", {
42
+ requestId,
43
+ provider: adapter.name,
44
+ model,
45
+ language: rest.language,
46
+ prompt: rest.prompt,
47
+ responseFormat: rest.responseFormat,
48
+ modelOptions: rest.modelOptions,
49
+ timestamp: startTime
50
+ });
51
+ logger.request(`activity=generateTranscription provider=${providerName}`, {
52
+ provider: providerName,
53
+ model
54
+ });
55
+ try {
56
+ const result = await adapter.transcribe({ ...rest, model, logger });
57
+ const duration = Date.now() - startTime;
58
+ aiEventClient.emit("transcription:request:completed", {
59
+ requestId,
60
+ provider: adapter.name,
61
+ model,
62
+ text: result.text,
63
+ language: result.language,
64
+ duration,
65
+ modelOptions: rest.modelOptions,
66
+ timestamp: Date.now()
67
+ });
68
+ logger.output(
69
+ `activity=generateTranscription length=${result.text.length}`,
70
+ { hasText: !!result.text }
71
+ );
72
+ if (result.usage) await runGenerationUsage(middleware, mwCtx, result.usage);
73
+ await runGenerationFinish(middleware, mwCtx, {
74
+ duration,
75
+ usage: result.usage
76
+ });
77
+ return result;
78
+ } catch (error) {
79
+ const duration = Date.now() - startTime;
80
+ const err = error;
81
+ aiEventClient.emit("transcription:request:error", {
82
+ requestId,
83
+ provider: adapter.name,
84
+ model,
85
+ error: { message: err.message, name: err.name },
86
+ duration,
87
+ modelOptions: rest.modelOptions,
88
+ timestamp: Date.now()
89
+ });
90
+ await runGenerationError(middleware, mwCtx, {
91
+ error,
92
+ duration
93
+ });
94
+ logger.errors("generateTranscription activity failed", {
95
+ error,
96
+ source: "generateTranscription"
97
+ });
98
+ throw error;
99
+ }
100
+ }
101
+ function createTranscriptionOptions(options) {
102
+ return options;
103
+ }
104
+ export {
105
+ createTranscriptionOptions,
106
+ generateTranscription,
107
+ kind
108
+ };
109
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
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 { aiEventClient } from '@tanstack/ai-event-client'\nimport { streamGenerationResult } from '../stream-generation-result.js'\nimport { resolveDebugOption } from '../../logger/resolve'\nimport {\n createGenerationContext,\n runGenerationError,\n runGenerationFinish,\n runGenerationStart,\n runGenerationUsage,\n} from '../middleware'\nimport type { InternalLogger } from '../../logger/internal-logger'\nimport type { DebugOption } from '../../logger/types'\nimport type { GenerationMiddleware } from '../middleware'\nimport type { TranscriptionAdapter } from './adapter'\nimport type { StreamChunk, 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 * @template TStream - Whether to stream the output\n */\nexport interface TranscriptionActivityOptions<\n TAdapter extends TranscriptionAdapter<\n string,\n TranscriptionProviderOptions<TAdapter>\n >,\n TStream extends boolean = false,\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 * Whether to stream the transcription result.\n * When true, returns an AsyncIterable<StreamChunk> for streaming transport.\n * When false or not provided, returns a Promise<TranscriptionResult>.\n *\n * @default false\n */\n stream?: TStream\n /**\n * Enable debug logging. Pass `true` to enable all categories, `false` to\n * silence everything including errors, or a `DebugConfig` object for granular\n * control and/or a custom `Logger`.\n */\n debug?: DebugOption\n /**\n * Observe-only middleware notified on start, usage, success, and error. Pass\n * `otelMiddleware()` to emit OpenTelemetry spans, or implement the\n * `GenerationMiddleware` contract for a custom backend.\n */\n middleware?: Array<GenerationMiddleware>\n}\n\n// ===========================\n// Activity Result Type\n// ===========================\n\n/**\n * Result type for the transcription activity.\n * - If stream is true: AsyncIterable<StreamChunk>\n * - Otherwise: Promise<TranscriptionResult>\n */\nexport type TranscriptionActivityResult<TStream extends boolean = false> =\n TStream extends true\n ? AsyncIterable<StreamChunk>\n : Promise<TranscriptionResult>\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 * 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 *\n * @example Streaming transcription result\n * ```ts\n * for await (const chunk of generateTranscription({\n * adapter: openaiTranscription('whisper-1'),\n * audio: audioFile,\n * stream: true\n * })) {\n * console.log(chunk)\n * }\n * ```\n */\nexport function generateTranscription<\n TAdapter extends TranscriptionAdapter<\n string,\n TranscriptionProviderOptions<TAdapter>\n >,\n TStream extends boolean = false,\n>(\n options: TranscriptionActivityOptions<TAdapter, TStream>,\n): TranscriptionActivityResult<TStream> {\n if (options.stream) {\n return streamGenerationResult(() =>\n runGenerateTranscription(options),\n ) as TranscriptionActivityResult<TStream>\n }\n\n return runGenerateTranscription(\n options,\n ) as TranscriptionActivityResult<TStream>\n}\n\n/**\n * Run non-streaming transcription\n */\nasync function runGenerateTranscription<\n TAdapter extends TranscriptionAdapter<\n string,\n TranscriptionProviderOptions<TAdapter>\n >,\n>(\n options: TranscriptionActivityOptions<TAdapter, boolean>,\n): Promise<TranscriptionResult> {\n const {\n adapter,\n stream: _stream,\n debug: _debug,\n middleware,\n ...rest\n } = options\n const model = adapter.model\n const requestId = createId('transcription')\n const startTime = Date.now()\n const logger: InternalLogger = resolveDebugOption(options.debug)\n const providerName =\n (adapter as { name?: string; provider?: string }).provider ??\n (adapter as { name?: string }).name ??\n 'unknown'\n\n const mwCtx = createGenerationContext({\n requestId,\n activity: 'transcription',\n provider: adapter.name,\n model,\n modelOptions: rest.modelOptions,\n createId,\n })\n\n await runGenerationStart(middleware, mwCtx)\n\n aiEventClient.emit('transcription:request:started', {\n requestId,\n provider: adapter.name,\n model,\n language: rest.language,\n prompt: rest.prompt,\n responseFormat: rest.responseFormat,\n modelOptions: rest.modelOptions as Record<string, unknown> | undefined,\n timestamp: startTime,\n })\n\n logger.request(`activity=generateTranscription provider=${providerName}`, {\n provider: providerName,\n model,\n })\n\n try {\n const result = await adapter.transcribe({ ...rest, model, logger })\n const duration = Date.now() - startTime\n\n aiEventClient.emit('transcription:request:completed', {\n requestId,\n provider: adapter.name,\n model,\n text: result.text,\n language: result.language,\n duration,\n modelOptions: rest.modelOptions as Record<string, unknown> | undefined,\n timestamp: Date.now(),\n })\n\n logger.output(\n `activity=generateTranscription length=${result.text.length}`,\n { hasText: !!result.text },\n )\n\n if (result.usage) await runGenerationUsage(middleware, mwCtx, result.usage)\n await runGenerationFinish(middleware, mwCtx, {\n duration,\n usage: result.usage,\n })\n\n return result\n } catch (error) {\n const duration = Date.now() - startTime\n const err = error as Error\n aiEventClient.emit('transcription:request:error', {\n requestId,\n provider: adapter.name,\n model,\n error: { message: err.message, name: err.name },\n duration,\n modelOptions: rest.modelOptions as Record<string, unknown> | undefined,\n timestamp: Date.now(),\n })\n await runGenerationError(middleware, mwCtx, {\n error,\n duration,\n })\n logger.errors('generateTranscription activity failed', {\n error,\n source: 'generateTranscription',\n })\n throw error\n }\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<\n string,\n TranscriptionProviderOptions<TAdapter>\n >,\n TStream extends boolean = false,\n>(\n options: TranscriptionActivityOptions<TAdapter, TStream>,\n): TranscriptionActivityOptions<TAdapter, TStream> {\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":";;;;AA4BO,MAAM,OAAO;AAgFpB,SAAS,SAAS,QAAwB;AACxC,SAAO,GAAG,MAAM,IAAI,KAAK,IAAA,CAAK,IAAI,KAAK,OAAA,EAAS,SAAS,EAAE,EAAE,MAAM,GAAG,CAAC,CAAC;AAC1E;AAiDO,SAAS,sBAOd,SACsC;AACtC,MAAI,QAAQ,QAAQ;AAClB,WAAO;AAAA,MAAuB,MAC5B,yBAAyB,OAAO;AAAA,IAAA;AAAA,EAEpC;AAEA,SAAO;AAAA,IACL;AAAA,EAAA;AAEJ;AAKA,eAAe,yBAMb,SAC8B;AAC9B,QAAM;AAAA,IACJ;AAAA,IACA,QAAQ;AAAA,IACR,OAAO;AAAA,IACP;AAAA,IACA,GAAG;AAAA,EAAA,IACD;AACJ,QAAM,QAAQ,QAAQ;AACtB,QAAM,YAAY,SAAS,eAAe;AAC1C,QAAM,YAAY,KAAK,IAAA;AACvB,QAAM,SAAyB,mBAAmB,QAAQ,KAAK;AAC/D,QAAM,eACH,QAAiD,YACjD,QAA8B,QAC/B;AAEF,QAAM,QAAQ,wBAAwB;AAAA,IACpC;AAAA,IACA,UAAU;AAAA,IACV,UAAU,QAAQ;AAAA,IAClB;AAAA,IACA,cAAc,KAAK;AAAA,IACnB;AAAA,EAAA,CACD;AAED,QAAM,mBAAmB,YAAY,KAAK;AAE1C,gBAAc,KAAK,iCAAiC;AAAA,IAClD;AAAA,IACA,UAAU,QAAQ;AAAA,IAClB;AAAA,IACA,UAAU,KAAK;AAAA,IACf,QAAQ,KAAK;AAAA,IACb,gBAAgB,KAAK;AAAA,IACrB,cAAc,KAAK;AAAA,IACnB,WAAW;AAAA,EAAA,CACZ;AAED,SAAO,QAAQ,2CAA2C,YAAY,IAAI;AAAA,IACxE,UAAU;AAAA,IACV;AAAA,EAAA,CACD;AAED,MAAI;AACF,UAAM,SAAS,MAAM,QAAQ,WAAW,EAAE,GAAG,MAAM,OAAO,QAAQ;AAClE,UAAM,WAAW,KAAK,IAAA,IAAQ;AAE9B,kBAAc,KAAK,mCAAmC;AAAA,MACpD;AAAA,MACA,UAAU,QAAQ;AAAA,MAClB;AAAA,MACA,MAAM,OAAO;AAAA,MACb,UAAU,OAAO;AAAA,MACjB;AAAA,MACA,cAAc,KAAK;AAAA,MACnB,WAAW,KAAK,IAAA;AAAA,IAAI,CACrB;AAED,WAAO;AAAA,MACL,yCAAyC,OAAO,KAAK,MAAM;AAAA,MAC3D,EAAE,SAAS,CAAC,CAAC,OAAO,KAAA;AAAA,IAAK;AAG3B,QAAI,OAAO,MAAO,OAAM,mBAAmB,YAAY,OAAO,OAAO,KAAK;AAC1E,UAAM,oBAAoB,YAAY,OAAO;AAAA,MAC3C;AAAA,MACA,OAAO,OAAO;AAAA,IAAA,CACf;AAED,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,WAAW,KAAK,IAAA,IAAQ;AAC9B,UAAM,MAAM;AACZ,kBAAc,KAAK,+BAA+B;AAAA,MAChD;AAAA,MACA,UAAU,QAAQ;AAAA,MAClB;AAAA,MACA,OAAO,EAAE,SAAS,IAAI,SAAS,MAAM,IAAI,KAAA;AAAA,MACzC;AAAA,MACA,cAAc,KAAK;AAAA,MACnB,WAAW,KAAK,IAAA;AAAA,IAAI,CACrB;AACD,UAAM,mBAAmB,YAAY,OAAO;AAAA,MAC1C;AAAA,MACA;AAAA,IAAA,CACD;AACD,WAAO,OAAO,yCAAyC;AAAA,MACrD;AAAA,MACA,QAAQ;AAAA,IAAA,CACT;AACD,UAAM;AAAA,EACR;AACF;AASO,SAAS,2BAOd,SACiD;AACjD,SAAO;AACT;"}
@@ -0,0 +1,145 @@
1
+ import { ModelInputModalitiesByName, VideoGenerationOptions, VideoJobResult, VideoStatusResult, VideoUrlResult } from '../../types.js';
2
+ /**
3
+ * Structured description of the durations a video model accepts.
4
+ *
5
+ * Tagged union so the same shape can express discrete enums (OpenAI Sora,
6
+ * Veo), continuous ranges, mixed shapes, and models with no duration field.
7
+ * Consumed by `VideoAdapter.availableDurations()`.
8
+ *
9
+ * @experimental Video generation is an experimental feature and may change.
10
+ */
11
+ export type DurationOptions<T extends string | number | undefined> = {
12
+ kind: 'discrete';
13
+ values: ReadonlyArray<NonNullable<T>>;
14
+ } | {
15
+ kind: 'range';
16
+ min: number;
17
+ max: number;
18
+ step?: number;
19
+ unit: 'seconds';
20
+ } | {
21
+ kind: 'mixed';
22
+ values: ReadonlyArray<NonNullable<T>>;
23
+ range?: {
24
+ min: number;
25
+ max: number;
26
+ step?: number;
27
+ };
28
+ } | {
29
+ kind: 'none';
30
+ };
31
+ /**
32
+ * Configuration for video adapter instances
33
+ *
34
+ * @experimental Video generation is an experimental feature and may change.
35
+ */
36
+ export interface VideoAdapterConfig {
37
+ apiKey?: string;
38
+ baseUrl?: string;
39
+ timeout?: number;
40
+ maxRetries?: number;
41
+ headers?: Record<string, string>;
42
+ }
43
+ /**
44
+ * Video adapter interface with pre-resolved generics.
45
+ *
46
+ * An adapter is created by a provider function: `provider('model')` → `adapter`
47
+ * All type resolution happens at the provider call site, not in this interface.
48
+ *
49
+ * @experimental Video generation is an experimental feature and may change.
50
+ *
51
+ * Generic parameters:
52
+ * - TModel: The specific model name (e.g., 'sora-2')
53
+ * - TProviderOptions: Provider-specific options (already resolved)
54
+ * - TModelProviderOptionsByName: Map from model name to its specific provider options
55
+ * - TModelSizeByName: Map from model name to its supported sizes
56
+ * - TModelInputModalitiesByName: Map from model name to the non-text prompt
57
+ * modalities it accepts (constrains the `prompt` part types at compile time)
58
+ * - TModelDurationByName: Map from model name to its supported duration
59
+ * union. Defaults to `Record<string, number>` so adapters that haven't
60
+ * declared a map keep today's `duration?: number` typing.
61
+ */
62
+ 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 | undefined> = Record<string, string>, TModelInputModalitiesByName extends ModelInputModalitiesByName = ModelInputModalitiesByName, TModelDurationByName extends Record<string, string | number | undefined> = Record<string, number>> {
63
+ /** Discriminator for adapter kind - used to determine API shape */
64
+ readonly kind: 'video';
65
+ /** Adapter name identifier */
66
+ readonly name: string;
67
+ /** The model this adapter is configured for */
68
+ readonly model: TModel;
69
+ /**
70
+ * @internal Type-only properties for inference. Not assigned at runtime.
71
+ */
72
+ '~types': {
73
+ providerOptions: TProviderOptions;
74
+ modelProviderOptionsByName: TModelProviderOptionsByName;
75
+ modelSizeByName: TModelSizeByName;
76
+ modelInputModalitiesByName: TModelInputModalitiesByName;
77
+ modelDurationByName: TModelDurationByName;
78
+ };
79
+ /**
80
+ * Create a new video generation job.
81
+ * Returns a job ID that can be used to poll for status and retrieve the video.
82
+ */
83
+ createVideoJob: (options: VideoGenerationOptions<TProviderOptions, TModelSizeByName[TModel], TModelDurationByName[TModel]>) => Promise<VideoJobResult>;
84
+ /**
85
+ * Get the current status of a video generation job.
86
+ */
87
+ getVideoStatus: (jobId: string) => Promise<VideoStatusResult>;
88
+ /**
89
+ * Get the URL to download/view the generated video.
90
+ * Should only be called after status is 'completed'.
91
+ */
92
+ getVideoUrl: (jobId: string) => Promise<VideoUrlResult>;
93
+ /**
94
+ * Describe the durations this adapter's model accepts. Returns a tagged
95
+ * union so consumers can render UI / coerce input without provider-specific
96
+ * knowledge.
97
+ */
98
+ availableDurations: () => DurationOptions<TModelDurationByName[TModel]>;
99
+ /**
100
+ * Coerce a raw seconds value to the closest valid duration for this model.
101
+ * Returns `undefined` for models with no duration field.
102
+ */
103
+ snapDuration: (seconds: number) => TModelDurationByName[TModel] | undefined;
104
+ }
105
+ /**
106
+ * A VideoAdapter with any/unknown type parameters.
107
+ * Useful as a constraint in generic functions and interfaces.
108
+ */
109
+ export type AnyVideoAdapter = VideoAdapter<any, any, any, any, any, any>;
110
+ /**
111
+ * Abstract base class for video generation adapters.
112
+ * Extend this class to implement a video adapter for a specific provider.
113
+ *
114
+ * @experimental Video generation is an experimental feature and may change.
115
+ *
116
+ * Generic parameters match VideoAdapter - all pre-resolved by the provider function.
117
+ */
118
+ 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 | undefined> = Record<string, string>, TModelInputModalitiesByName extends ModelInputModalitiesByName = ModelInputModalitiesByName, TModelDurationByName extends Record<string, string | number | undefined> = Record<string, number>> implements VideoAdapter<TModel, TProviderOptions, TModelProviderOptionsByName, TModelSizeByName, TModelInputModalitiesByName, TModelDurationByName> {
119
+ readonly kind: "video";
120
+ abstract readonly name: string;
121
+ readonly model: TModel;
122
+ '~types': {
123
+ providerOptions: TProviderOptions;
124
+ modelProviderOptionsByName: TModelProviderOptionsByName;
125
+ modelSizeByName: TModelSizeByName;
126
+ modelInputModalitiesByName: TModelInputModalitiesByName;
127
+ modelDurationByName: TModelDurationByName;
128
+ };
129
+ protected config: VideoAdapterConfig;
130
+ constructor(config: VideoAdapterConfig | undefined, model: TModel);
131
+ abstract createVideoJob(options: VideoGenerationOptions<TProviderOptions, TModelSizeByName[TModel], TModelDurationByName[TModel]>): Promise<VideoJobResult>;
132
+ abstract getVideoStatus(jobId: string): Promise<VideoStatusResult>;
133
+ abstract getVideoUrl(jobId: string): Promise<VideoUrlResult>;
134
+ /**
135
+ * Default implementation returns `{ kind: 'none' }`. Adapters that have
136
+ * declared their per-model duration map should override this.
137
+ */
138
+ availableDurations(): DurationOptions<TModelDurationByName[TModel]>;
139
+ /**
140
+ * Default implementation returns `undefined`. Adapters that have declared
141
+ * their per-model duration map should override.
142
+ */
143
+ snapDuration(_seconds: number): TModelDurationByName[TModel] | undefined;
144
+ protected generateId(): string;
145
+ }
@@ -0,0 +1,30 @@
1
+ class BaseVideoAdapter {
2
+ kind = "video";
3
+ model;
4
+ config;
5
+ constructor(config = {}, model) {
6
+ this.config = config;
7
+ this.model = model;
8
+ }
9
+ /**
10
+ * Default implementation returns `{ kind: 'none' }`. Adapters that have
11
+ * declared their per-model duration map should override this.
12
+ */
13
+ availableDurations() {
14
+ return { kind: "none" };
15
+ }
16
+ /**
17
+ * Default implementation returns `undefined`. Adapters that have declared
18
+ * their per-model duration map should override.
19
+ */
20
+ snapDuration(_seconds) {
21
+ return void 0;
22
+ }
23
+ generateId() {
24
+ return `${this.name}-${Date.now()}-${Math.random().toString(36).substring(7)}`;
25
+ }
26
+ }
27
+ export {
28
+ BaseVideoAdapter
29
+ };
30
+ //# sourceMappingURL=adapter.js.map