@fondation-io/ai 7.0.0-beta.45

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 (536) hide show
  1. package/CHANGELOG.md +7687 -0
  2. package/README.md +238 -0
  3. package/dist/index.d.mts +7056 -0
  4. package/dist/index.d.ts +7056 -0
  5. package/dist/index.js +14607 -0
  6. package/dist/index.js.map +1 -0
  7. package/dist/index.mjs +14578 -0
  8. package/dist/index.mjs.map +1 -0
  9. package/dist/internal/index.d.mts +303 -0
  10. package/dist/internal/index.d.ts +303 -0
  11. package/dist/internal/index.js +1352 -0
  12. package/dist/internal/index.js.map +1 -0
  13. package/dist/internal/index.mjs +1336 -0
  14. package/dist/internal/index.mjs.map +1 -0
  15. package/dist/test/index.d.mts +265 -0
  16. package/dist/test/index.d.ts +265 -0
  17. package/dist/test/index.js +509 -0
  18. package/dist/test/index.js.map +1 -0
  19. package/dist/test/index.mjs +472 -0
  20. package/dist/test/index.mjs.map +1 -0
  21. package/docs/00-introduction/index.mdx +76 -0
  22. package/docs/02-foundations/01-overview.mdx +43 -0
  23. package/docs/02-foundations/02-providers-and-models.mdx +160 -0
  24. package/docs/02-foundations/03-prompts.mdx +616 -0
  25. package/docs/02-foundations/04-tools.mdx +251 -0
  26. package/docs/02-foundations/05-streaming.mdx +62 -0
  27. package/docs/02-foundations/06-provider-options.mdx +345 -0
  28. package/docs/02-foundations/index.mdx +49 -0
  29. package/docs/02-getting-started/00-choosing-a-provider.mdx +110 -0
  30. package/docs/02-getting-started/01-navigating-the-library.mdx +85 -0
  31. package/docs/02-getting-started/02-nextjs-app-router.mdx +559 -0
  32. package/docs/02-getting-started/03-nextjs-pages-router.mdx +542 -0
  33. package/docs/02-getting-started/04-svelte.mdx +627 -0
  34. package/docs/02-getting-started/05-nuxt.mdx +566 -0
  35. package/docs/02-getting-started/06-nodejs.mdx +512 -0
  36. package/docs/02-getting-started/07-expo.mdx +766 -0
  37. package/docs/02-getting-started/08-tanstack-start.mdx +583 -0
  38. package/docs/02-getting-started/09-coding-agents.mdx +179 -0
  39. package/docs/02-getting-started/index.mdx +44 -0
  40. package/docs/03-agents/01-overview.mdx +96 -0
  41. package/docs/03-agents/02-building-agents.mdx +449 -0
  42. package/docs/03-agents/03-workflows.mdx +386 -0
  43. package/docs/03-agents/04-loop-control.mdx +394 -0
  44. package/docs/03-agents/05-configuring-call-options.mdx +286 -0
  45. package/docs/03-agents/06-memory.mdx +222 -0
  46. package/docs/03-agents/06-subagents.mdx +362 -0
  47. package/docs/03-agents/index.mdx +46 -0
  48. package/docs/03-ai-sdk-core/01-overview.mdx +31 -0
  49. package/docs/03-ai-sdk-core/05-generating-text.mdx +707 -0
  50. package/docs/03-ai-sdk-core/10-generating-structured-data.mdx +498 -0
  51. package/docs/03-ai-sdk-core/15-tools-and-tool-calling.mdx +1148 -0
  52. package/docs/03-ai-sdk-core/16-mcp-tools.mdx +383 -0
  53. package/docs/03-ai-sdk-core/20-prompt-engineering.mdx +146 -0
  54. package/docs/03-ai-sdk-core/25-settings.mdx +216 -0
  55. package/docs/03-ai-sdk-core/26-reasoning.mdx +190 -0
  56. package/docs/03-ai-sdk-core/30-embeddings.mdx +236 -0
  57. package/docs/03-ai-sdk-core/31-reranking.mdx +218 -0
  58. package/docs/03-ai-sdk-core/35-image-generation.mdx +341 -0
  59. package/docs/03-ai-sdk-core/36-transcription.mdx +227 -0
  60. package/docs/03-ai-sdk-core/37-speech.mdx +169 -0
  61. package/docs/03-ai-sdk-core/38-video-generation.mdx +366 -0
  62. package/docs/03-ai-sdk-core/40-middleware.mdx +485 -0
  63. package/docs/03-ai-sdk-core/45-provider-management.mdx +349 -0
  64. package/docs/03-ai-sdk-core/50-error-handling.mdx +149 -0
  65. package/docs/03-ai-sdk-core/55-testing.mdx +219 -0
  66. package/docs/03-ai-sdk-core/60-telemetry.mdx +391 -0
  67. package/docs/03-ai-sdk-core/65-devtools.mdx +107 -0
  68. package/docs/03-ai-sdk-core/65-event-listeners.mdx +1303 -0
  69. package/docs/03-ai-sdk-core/index.mdx +99 -0
  70. package/docs/04-ai-sdk-ui/01-overview.mdx +44 -0
  71. package/docs/04-ai-sdk-ui/02-chatbot.mdx +1320 -0
  72. package/docs/04-ai-sdk-ui/03-chatbot-message-persistence.mdx +534 -0
  73. package/docs/04-ai-sdk-ui/03-chatbot-resume-streams.mdx +263 -0
  74. package/docs/04-ai-sdk-ui/03-chatbot-tool-usage.mdx +682 -0
  75. package/docs/04-ai-sdk-ui/04-generative-user-interfaces.mdx +389 -0
  76. package/docs/04-ai-sdk-ui/05-completion.mdx +181 -0
  77. package/docs/04-ai-sdk-ui/08-object-generation.mdx +344 -0
  78. package/docs/04-ai-sdk-ui/20-streaming-data.mdx +397 -0
  79. package/docs/04-ai-sdk-ui/21-error-handling.mdx +190 -0
  80. package/docs/04-ai-sdk-ui/21-transport.mdx +174 -0
  81. package/docs/04-ai-sdk-ui/24-reading-ui-message-streams.mdx +104 -0
  82. package/docs/04-ai-sdk-ui/25-message-metadata.mdx +152 -0
  83. package/docs/04-ai-sdk-ui/50-stream-protocol.mdx +503 -0
  84. package/docs/04-ai-sdk-ui/index.mdx +64 -0
  85. package/docs/05-ai-sdk-rsc/01-overview.mdx +45 -0
  86. package/docs/05-ai-sdk-rsc/02-streaming-react-components.mdx +209 -0
  87. package/docs/05-ai-sdk-rsc/03-generative-ui-state.mdx +279 -0
  88. package/docs/05-ai-sdk-rsc/03-saving-and-restoring-states.mdx +105 -0
  89. package/docs/05-ai-sdk-rsc/04-multistep-interfaces.mdx +282 -0
  90. package/docs/05-ai-sdk-rsc/05-streaming-values.mdx +157 -0
  91. package/docs/05-ai-sdk-rsc/06-loading-state.mdx +273 -0
  92. package/docs/05-ai-sdk-rsc/08-error-handling.mdx +94 -0
  93. package/docs/05-ai-sdk-rsc/09-authentication.mdx +42 -0
  94. package/docs/05-ai-sdk-rsc/10-migrating-to-ui.mdx +722 -0
  95. package/docs/05-ai-sdk-rsc/index.mdx +63 -0
  96. package/docs/06-advanced/01-prompt-engineering.mdx +96 -0
  97. package/docs/06-advanced/02-stopping-streams.mdx +184 -0
  98. package/docs/06-advanced/03-backpressure.mdx +173 -0
  99. package/docs/06-advanced/04-caching.mdx +169 -0
  100. package/docs/06-advanced/05-multiple-streamables.mdx +68 -0
  101. package/docs/06-advanced/06-rate-limiting.mdx +60 -0
  102. package/docs/06-advanced/07-rendering-ui-with-language-models.mdx +225 -0
  103. package/docs/06-advanced/08-model-as-router.mdx +120 -0
  104. package/docs/06-advanced/09-multistep-interfaces.mdx +115 -0
  105. package/docs/06-advanced/09-sequential-generations.mdx +55 -0
  106. package/docs/06-advanced/10-vercel-deployment-guide.mdx +117 -0
  107. package/docs/06-advanced/index.mdx +11 -0
  108. package/docs/07-reference/01-ai-sdk-core/01-generate-text.mdx +2785 -0
  109. package/docs/07-reference/01-ai-sdk-core/02-stream-text.mdx +3752 -0
  110. package/docs/07-reference/01-ai-sdk-core/05-embed.mdx +332 -0
  111. package/docs/07-reference/01-ai-sdk-core/06-embed-many.mdx +330 -0
  112. package/docs/07-reference/01-ai-sdk-core/06-rerank.mdx +323 -0
  113. package/docs/07-reference/01-ai-sdk-core/10-generate-image.mdx +251 -0
  114. package/docs/07-reference/01-ai-sdk-core/11-transcribe.mdx +152 -0
  115. package/docs/07-reference/01-ai-sdk-core/12-generate-speech.mdx +221 -0
  116. package/docs/07-reference/01-ai-sdk-core/13-generate-video.mdx +264 -0
  117. package/docs/07-reference/01-ai-sdk-core/15-agent.mdx +235 -0
  118. package/docs/07-reference/01-ai-sdk-core/16-tool-loop-agent.mdx +973 -0
  119. package/docs/07-reference/01-ai-sdk-core/17-create-agent-ui-stream.mdx +154 -0
  120. package/docs/07-reference/01-ai-sdk-core/18-create-agent-ui-stream-response.mdx +173 -0
  121. package/docs/07-reference/01-ai-sdk-core/18-pipe-agent-ui-stream-to-response.mdx +150 -0
  122. package/docs/07-reference/01-ai-sdk-core/20-tool.mdx +209 -0
  123. package/docs/07-reference/01-ai-sdk-core/22-dynamic-tool.mdx +223 -0
  124. package/docs/07-reference/01-ai-sdk-core/23-create-mcp-client.mdx +423 -0
  125. package/docs/07-reference/01-ai-sdk-core/24-mcp-stdio-transport.mdx +68 -0
  126. package/docs/07-reference/01-ai-sdk-core/25-json-schema.mdx +94 -0
  127. package/docs/07-reference/01-ai-sdk-core/26-zod-schema.mdx +109 -0
  128. package/docs/07-reference/01-ai-sdk-core/27-valibot-schema.mdx +58 -0
  129. package/docs/07-reference/01-ai-sdk-core/28-output.mdx +342 -0
  130. package/docs/07-reference/01-ai-sdk-core/30-model-message.mdx +435 -0
  131. package/docs/07-reference/01-ai-sdk-core/31-ui-message.mdx +264 -0
  132. package/docs/07-reference/01-ai-sdk-core/32-validate-ui-messages.mdx +101 -0
  133. package/docs/07-reference/01-ai-sdk-core/33-safe-validate-ui-messages.mdx +113 -0
  134. package/docs/07-reference/01-ai-sdk-core/40-provider-registry.mdx +198 -0
  135. package/docs/07-reference/01-ai-sdk-core/42-custom-provider.mdx +157 -0
  136. package/docs/07-reference/01-ai-sdk-core/50-cosine-similarity.mdx +52 -0
  137. package/docs/07-reference/01-ai-sdk-core/60-wrap-language-model.mdx +59 -0
  138. package/docs/07-reference/01-ai-sdk-core/61-wrap-image-model.mdx +64 -0
  139. package/docs/07-reference/01-ai-sdk-core/65-language-model-v2-middleware.mdx +74 -0
  140. package/docs/07-reference/01-ai-sdk-core/66-extract-reasoning-middleware.mdx +68 -0
  141. package/docs/07-reference/01-ai-sdk-core/67-simulate-streaming-middleware.mdx +71 -0
  142. package/docs/07-reference/01-ai-sdk-core/68-default-settings-middleware.mdx +80 -0
  143. package/docs/07-reference/01-ai-sdk-core/69-add-tool-input-examples-middleware.mdx +155 -0
  144. package/docs/07-reference/01-ai-sdk-core/70-extract-json-middleware.mdx +147 -0
  145. package/docs/07-reference/01-ai-sdk-core/70-step-count-is.mdx +84 -0
  146. package/docs/07-reference/01-ai-sdk-core/71-has-tool-call.mdx +120 -0
  147. package/docs/07-reference/01-ai-sdk-core/75-simulate-readable-stream.mdx +94 -0
  148. package/docs/07-reference/01-ai-sdk-core/80-smooth-stream.mdx +145 -0
  149. package/docs/07-reference/01-ai-sdk-core/90-generate-id.mdx +30 -0
  150. package/docs/07-reference/01-ai-sdk-core/91-create-id-generator.mdx +89 -0
  151. package/docs/07-reference/01-ai-sdk-core/92-default-generated-file.mdx +68 -0
  152. package/docs/07-reference/01-ai-sdk-core/index.mdx +160 -0
  153. package/docs/07-reference/02-ai-sdk-ui/01-use-chat.mdx +493 -0
  154. package/docs/07-reference/02-ai-sdk-ui/02-use-completion.mdx +185 -0
  155. package/docs/07-reference/02-ai-sdk-ui/03-use-object.mdx +196 -0
  156. package/docs/07-reference/02-ai-sdk-ui/31-convert-to-model-messages.mdx +231 -0
  157. package/docs/07-reference/02-ai-sdk-ui/32-prune-messages.mdx +108 -0
  158. package/docs/07-reference/02-ai-sdk-ui/40-create-ui-message-stream.mdx +162 -0
  159. package/docs/07-reference/02-ai-sdk-ui/41-create-ui-message-stream-response.mdx +119 -0
  160. package/docs/07-reference/02-ai-sdk-ui/42-pipe-ui-message-stream-to-response.mdx +77 -0
  161. package/docs/07-reference/02-ai-sdk-ui/43-read-ui-message-stream.mdx +57 -0
  162. package/docs/07-reference/02-ai-sdk-ui/46-infer-ui-tools.mdx +99 -0
  163. package/docs/07-reference/02-ai-sdk-ui/47-infer-ui-tool.mdx +75 -0
  164. package/docs/07-reference/02-ai-sdk-ui/50-direct-chat-transport.mdx +333 -0
  165. package/docs/07-reference/02-ai-sdk-ui/index.mdx +89 -0
  166. package/docs/07-reference/03-ai-sdk-rsc/01-stream-ui.mdx +767 -0
  167. package/docs/07-reference/03-ai-sdk-rsc/02-create-ai.mdx +90 -0
  168. package/docs/07-reference/03-ai-sdk-rsc/03-create-streamable-ui.mdx +91 -0
  169. package/docs/07-reference/03-ai-sdk-rsc/04-create-streamable-value.mdx +78 -0
  170. package/docs/07-reference/03-ai-sdk-rsc/05-read-streamable-value.mdx +79 -0
  171. package/docs/07-reference/03-ai-sdk-rsc/06-get-ai-state.mdx +50 -0
  172. package/docs/07-reference/03-ai-sdk-rsc/07-get-mutable-ai-state.mdx +70 -0
  173. package/docs/07-reference/03-ai-sdk-rsc/08-use-ai-state.mdx +26 -0
  174. package/docs/07-reference/03-ai-sdk-rsc/09-use-actions.mdx +42 -0
  175. package/docs/07-reference/03-ai-sdk-rsc/10-use-ui-state.mdx +35 -0
  176. package/docs/07-reference/03-ai-sdk-rsc/11-use-streamable-value.mdx +46 -0
  177. package/docs/07-reference/03-ai-sdk-rsc/20-render.mdx +266 -0
  178. package/docs/07-reference/03-ai-sdk-rsc/index.mdx +67 -0
  179. package/docs/07-reference/05-ai-sdk-errors/ai-api-call-error.mdx +31 -0
  180. package/docs/07-reference/05-ai-sdk-errors/ai-download-error.mdx +28 -0
  181. package/docs/07-reference/05-ai-sdk-errors/ai-empty-response-body-error.mdx +24 -0
  182. package/docs/07-reference/05-ai-sdk-errors/ai-invalid-argument-error.mdx +26 -0
  183. package/docs/07-reference/05-ai-sdk-errors/ai-invalid-data-content-error.mdx +26 -0
  184. package/docs/07-reference/05-ai-sdk-errors/ai-invalid-message-role-error.mdx +25 -0
  185. package/docs/07-reference/05-ai-sdk-errors/ai-invalid-prompt-error.mdx +47 -0
  186. package/docs/07-reference/05-ai-sdk-errors/ai-invalid-response-data-error.mdx +25 -0
  187. package/docs/07-reference/05-ai-sdk-errors/ai-invalid-tool-approval-error.mdx +24 -0
  188. package/docs/07-reference/05-ai-sdk-errors/ai-invalid-tool-input-error.mdx +27 -0
  189. package/docs/07-reference/05-ai-sdk-errors/ai-json-parse-error.mdx +25 -0
  190. package/docs/07-reference/05-ai-sdk-errors/ai-load-api-key-error.mdx +24 -0
  191. package/docs/07-reference/05-ai-sdk-errors/ai-load-setting-error.mdx +24 -0
  192. package/docs/07-reference/05-ai-sdk-errors/ai-message-conversion-error.mdx +25 -0
  193. package/docs/07-reference/05-ai-sdk-errors/ai-no-content-generated-error.mdx +24 -0
  194. package/docs/07-reference/05-ai-sdk-errors/ai-no-image-generated-error.mdx +36 -0
  195. package/docs/07-reference/05-ai-sdk-errors/ai-no-object-generated-error.mdx +43 -0
  196. package/docs/07-reference/05-ai-sdk-errors/ai-no-output-generated-error.mdx +25 -0
  197. package/docs/07-reference/05-ai-sdk-errors/ai-no-speech-generated-error.mdx +24 -0
  198. package/docs/07-reference/05-ai-sdk-errors/ai-no-such-model-error.mdx +26 -0
  199. package/docs/07-reference/05-ai-sdk-errors/ai-no-such-provider-error.mdx +28 -0
  200. package/docs/07-reference/05-ai-sdk-errors/ai-no-such-tool-error.mdx +26 -0
  201. package/docs/07-reference/05-ai-sdk-errors/ai-no-transcript-generated-error.mdx +24 -0
  202. package/docs/07-reference/05-ai-sdk-errors/ai-no-video-generated-error.mdx +39 -0
  203. package/docs/07-reference/05-ai-sdk-errors/ai-retry-error.mdx +27 -0
  204. package/docs/07-reference/05-ai-sdk-errors/ai-too-many-embedding-values-for-call-error.mdx +27 -0
  205. package/docs/07-reference/05-ai-sdk-errors/ai-tool-call-not-found-for-approval-error.mdx +25 -0
  206. package/docs/07-reference/05-ai-sdk-errors/ai-tool-call-repair-error.mdx +28 -0
  207. package/docs/07-reference/05-ai-sdk-errors/ai-type-validation-error.mdx +25 -0
  208. package/docs/07-reference/05-ai-sdk-errors/ai-ui-message-stream-error.mdx +67 -0
  209. package/docs/07-reference/05-ai-sdk-errors/ai-unsupported-functionality-error.mdx +25 -0
  210. package/docs/07-reference/05-ai-sdk-errors/index.mdx +39 -0
  211. package/docs/07-reference/index.mdx +28 -0
  212. package/docs/08-migration-guides/00-versioning.mdx +46 -0
  213. package/docs/08-migration-guides/23-migration-guide-7-0.mdx +95 -0
  214. package/docs/08-migration-guides/24-migration-guide-6-0.mdx +823 -0
  215. package/docs/08-migration-guides/25-migration-guide-5-0-data.mdx +882 -0
  216. package/docs/08-migration-guides/26-migration-guide-5-0.mdx +3427 -0
  217. package/docs/08-migration-guides/27-migration-guide-4-2.mdx +99 -0
  218. package/docs/08-migration-guides/28-migration-guide-4-1.mdx +14 -0
  219. package/docs/08-migration-guides/29-migration-guide-4-0.mdx +1157 -0
  220. package/docs/08-migration-guides/36-migration-guide-3-4.mdx +14 -0
  221. package/docs/08-migration-guides/37-migration-guide-3-3.mdx +64 -0
  222. package/docs/08-migration-guides/38-migration-guide-3-2.mdx +46 -0
  223. package/docs/08-migration-guides/39-migration-guide-3-1.mdx +168 -0
  224. package/docs/08-migration-guides/index.mdx +22 -0
  225. package/docs/09-troubleshooting/01-azure-stream-slow.mdx +33 -0
  226. package/docs/09-troubleshooting/03-server-actions-in-client-components.mdx +40 -0
  227. package/docs/09-troubleshooting/04-strange-stream-output.mdx +36 -0
  228. package/docs/09-troubleshooting/05-streamable-ui-errors.mdx +16 -0
  229. package/docs/09-troubleshooting/05-tool-invocation-missing-result.mdx +106 -0
  230. package/docs/09-troubleshooting/06-streaming-not-working-when-deployed.mdx +31 -0
  231. package/docs/09-troubleshooting/06-streaming-not-working-when-proxied.mdx +31 -0
  232. package/docs/09-troubleshooting/06-timeout-on-vercel.mdx +60 -0
  233. package/docs/09-troubleshooting/07-unclosed-streams.mdx +34 -0
  234. package/docs/09-troubleshooting/08-use-chat-failed-to-parse-stream.mdx +26 -0
  235. package/docs/09-troubleshooting/09-client-stream-error.mdx +25 -0
  236. package/docs/09-troubleshooting/10-use-chat-tools-no-response.mdx +32 -0
  237. package/docs/09-troubleshooting/11-use-chat-custom-request-options.mdx +149 -0
  238. package/docs/09-troubleshooting/12-typescript-performance-zod.mdx +46 -0
  239. package/docs/09-troubleshooting/12-use-chat-an-error-occurred.mdx +59 -0
  240. package/docs/09-troubleshooting/13-repeated-assistant-messages.mdx +73 -0
  241. package/docs/09-troubleshooting/14-stream-abort-handling.mdx +73 -0
  242. package/docs/09-troubleshooting/14-tool-calling-with-structured-outputs.mdx +48 -0
  243. package/docs/09-troubleshooting/15-abort-breaks-resumable-streams.mdx +55 -0
  244. package/docs/09-troubleshooting/15-stream-text-not-working.mdx +33 -0
  245. package/docs/09-troubleshooting/16-streaming-status-delay.mdx +63 -0
  246. package/docs/09-troubleshooting/17-use-chat-stale-body-data.mdx +141 -0
  247. package/docs/09-troubleshooting/18-ontoolcall-type-narrowing.mdx +66 -0
  248. package/docs/09-troubleshooting/19-unsupported-model-version.mdx +50 -0
  249. package/docs/09-troubleshooting/20-no-object-generated-content-filter.mdx +76 -0
  250. package/docs/09-troubleshooting/21-missing-tool-results-error.mdx +82 -0
  251. package/docs/09-troubleshooting/30-model-is-not-assignable-to-type.mdx +21 -0
  252. package/docs/09-troubleshooting/40-typescript-cannot-find-namespace-jsx.mdx +24 -0
  253. package/docs/09-troubleshooting/50-react-maximum-update-depth-exceeded.mdx +39 -0
  254. package/docs/09-troubleshooting/60-jest-cannot-find-module-ai-rsc.mdx +22 -0
  255. package/docs/09-troubleshooting/70-high-memory-usage-with-images.mdx +108 -0
  256. package/docs/09-troubleshooting/index.mdx +11 -0
  257. package/internal.d.ts +1 -0
  258. package/package.json +120 -0
  259. package/src/agent/agent.ts +156 -0
  260. package/src/agent/create-agent-ui-stream-response.ts +61 -0
  261. package/src/agent/create-agent-ui-stream.ts +84 -0
  262. package/src/agent/index.ts +37 -0
  263. package/src/agent/infer-agent-tools.ts +7 -0
  264. package/src/agent/infer-agent-ui-message.ts +11 -0
  265. package/src/agent/pipe-agent-ui-stream-to-response.ts +64 -0
  266. package/src/agent/tool-loop-agent-settings.ts +252 -0
  267. package/src/agent/tool-loop-agent.ts +205 -0
  268. package/src/embed/embed-events.ts +181 -0
  269. package/src/embed/embed-many-result.ts +53 -0
  270. package/src/embed/embed-many.ts +428 -0
  271. package/src/embed/embed-result.ts +50 -0
  272. package/src/embed/embed.ts +266 -0
  273. package/src/embed/index.ts +5 -0
  274. package/src/error/index.ts +37 -0
  275. package/src/error/invalid-argument-error.ts +34 -0
  276. package/src/error/invalid-stream-part-error.ts +28 -0
  277. package/src/error/invalid-tool-approval-error.ts +26 -0
  278. package/src/error/invalid-tool-input-error.ts +33 -0
  279. package/src/error/missing-tool-result-error.ts +28 -0
  280. package/src/error/no-image-generated-error.ts +39 -0
  281. package/src/error/no-object-generated-error.ts +70 -0
  282. package/src/error/no-output-generated-error.ts +26 -0
  283. package/src/error/no-speech-generated-error.ts +28 -0
  284. package/src/error/no-such-tool-error.ts +35 -0
  285. package/src/error/no-transcript-generated-error.ts +30 -0
  286. package/src/error/no-video-generated-error.ts +57 -0
  287. package/src/error/tool-call-not-found-for-approval-error.ts +32 -0
  288. package/src/error/tool-call-repair-error.ts +30 -0
  289. package/src/error/ui-message-stream-error.ts +48 -0
  290. package/src/error/unsupported-model-version-error.ts +23 -0
  291. package/src/error/verify-no-object-generated-error.ts +27 -0
  292. package/src/generate-image/generate-image-result.ts +42 -0
  293. package/src/generate-image/generate-image.ts +361 -0
  294. package/src/generate-image/index.ts +18 -0
  295. package/src/generate-object/generate-object-result.ts +67 -0
  296. package/src/generate-object/generate-object.ts +514 -0
  297. package/src/generate-object/index.ts +9 -0
  298. package/src/generate-object/inject-json-instruction.ts +30 -0
  299. package/src/generate-object/output-strategy.ts +415 -0
  300. package/src/generate-object/parse-and-validate-object-result.ts +111 -0
  301. package/src/generate-object/repair-text.ts +12 -0
  302. package/src/generate-object/stream-object-result.ts +120 -0
  303. package/src/generate-object/stream-object.ts +984 -0
  304. package/src/generate-object/validate-object-generation-input.ts +144 -0
  305. package/src/generate-speech/generate-speech-result.ts +30 -0
  306. package/src/generate-speech/generate-speech.ts +191 -0
  307. package/src/generate-speech/generated-audio-file.ts +65 -0
  308. package/src/generate-speech/index.ts +3 -0
  309. package/src/generate-text/collect-tool-approvals.ts +116 -0
  310. package/src/generate-text/content-part.ts +31 -0
  311. package/src/generate-text/core-events.ts +390 -0
  312. package/src/generate-text/create-execute-tools-transformation.ts +144 -0
  313. package/src/generate-text/execute-tool-call.ts +190 -0
  314. package/src/generate-text/extract-reasoning-content.ts +17 -0
  315. package/src/generate-text/extract-text-content.ts +15 -0
  316. package/src/generate-text/generate-text-result.ts +168 -0
  317. package/src/generate-text/generate-text.ts +1445 -0
  318. package/src/generate-text/generated-file.ts +70 -0
  319. package/src/generate-text/index.ts +78 -0
  320. package/src/generate-text/invoke-tool-callbacks-from-stream.ts +81 -0
  321. package/src/generate-text/is-approval-needed.ts +29 -0
  322. package/src/generate-text/output-utils.ts +23 -0
  323. package/src/generate-text/output.ts +590 -0
  324. package/src/generate-text/parse-tool-call.ts +188 -0
  325. package/src/generate-text/prepare-step.ts +103 -0
  326. package/src/generate-text/prune-messages.ts +167 -0
  327. package/src/generate-text/reasoning-output.ts +99 -0
  328. package/src/generate-text/reasoning.ts +10 -0
  329. package/src/generate-text/response-message.ts +10 -0
  330. package/src/generate-text/smooth-stream.ts +162 -0
  331. package/src/generate-text/step-result.ts +310 -0
  332. package/src/generate-text/stop-condition.ts +29 -0
  333. package/src/generate-text/stream-model-call.ts +418 -0
  334. package/src/generate-text/stream-text-result.ts +536 -0
  335. package/src/generate-text/stream-text.ts +2696 -0
  336. package/src/generate-text/to-response-messages.ts +195 -0
  337. package/src/generate-text/tool-approval-request-output.ts +21 -0
  338. package/src/generate-text/tool-call-repair-function.ts +27 -0
  339. package/src/generate-text/tool-call.ts +47 -0
  340. package/src/generate-text/tool-error.ts +34 -0
  341. package/src/generate-text/tool-output-denied.ts +21 -0
  342. package/src/generate-text/tool-output.ts +7 -0
  343. package/src/generate-text/tool-result.ts +36 -0
  344. package/src/generate-text/tool-set.ts +14 -0
  345. package/src/generate-video/generate-video-result.ts +36 -0
  346. package/src/generate-video/generate-video.ts +402 -0
  347. package/src/generate-video/index.ts +3 -0
  348. package/src/global.ts +36 -0
  349. package/src/index.ts +49 -0
  350. package/src/logger/index.ts +6 -0
  351. package/src/logger/log-warnings.ts +140 -0
  352. package/src/middleware/add-tool-input-examples-middleware.ts +90 -0
  353. package/src/middleware/default-embedding-settings-middleware.ts +22 -0
  354. package/src/middleware/default-settings-middleware.ts +33 -0
  355. package/src/middleware/extract-json-middleware.ts +197 -0
  356. package/src/middleware/extract-reasoning-middleware.ts +249 -0
  357. package/src/middleware/index.ts +10 -0
  358. package/src/middleware/simulate-streaming-middleware.ts +79 -0
  359. package/src/middleware/wrap-embedding-model.ts +89 -0
  360. package/src/middleware/wrap-image-model.ts +92 -0
  361. package/src/middleware/wrap-language-model.ts +108 -0
  362. package/src/middleware/wrap-provider.ts +51 -0
  363. package/src/model/as-embedding-model-v3.ts +24 -0
  364. package/src/model/as-embedding-model-v4.ts +25 -0
  365. package/src/model/as-image-model-v3.ts +24 -0
  366. package/src/model/as-image-model-v4.ts +21 -0
  367. package/src/model/as-language-model-v3.ts +103 -0
  368. package/src/model/as-language-model-v4.ts +25 -0
  369. package/src/model/as-provider-v3.ts +36 -0
  370. package/src/model/as-provider-v4.ts +47 -0
  371. package/src/model/as-reranking-model-v4.ts +16 -0
  372. package/src/model/as-speech-model-v3.ts +24 -0
  373. package/src/model/as-speech-model-v4.ts +21 -0
  374. package/src/model/as-transcription-model-v3.ts +24 -0
  375. package/src/model/as-transcription-model-v4.ts +25 -0
  376. package/src/model/as-video-model-v4.ts +19 -0
  377. package/src/model/resolve-model.ts +172 -0
  378. package/src/prompt/call-settings.ts +169 -0
  379. package/src/prompt/content-part.ts +236 -0
  380. package/src/prompt/convert-to-language-model-prompt.ts +548 -0
  381. package/src/prompt/create-tool-model-output.ts +34 -0
  382. package/src/prompt/data-content.ts +134 -0
  383. package/src/prompt/index.ts +27 -0
  384. package/src/prompt/invalid-data-content-error.ts +29 -0
  385. package/src/prompt/invalid-message-role-error.ts +27 -0
  386. package/src/prompt/message-conversion-error.ts +28 -0
  387. package/src/prompt/message.ts +72 -0
  388. package/src/prompt/prepare-call-settings.ts +110 -0
  389. package/src/prompt/prepare-tools-and-tool-choice.ts +86 -0
  390. package/src/prompt/prompt.ts +43 -0
  391. package/src/prompt/split-data-url.ts +17 -0
  392. package/src/prompt/standardize-prompt.ts +99 -0
  393. package/src/prompt/wrap-gateway-error.ts +29 -0
  394. package/src/registry/custom-provider.ts +210 -0
  395. package/src/registry/index.ts +7 -0
  396. package/src/registry/no-such-provider-error.ts +41 -0
  397. package/src/registry/provider-registry.ts +331 -0
  398. package/src/rerank/index.ts +8 -0
  399. package/src/rerank/rerank-events.ts +189 -0
  400. package/src/rerank/rerank-result.ts +70 -0
  401. package/src/rerank/rerank.ts +348 -0
  402. package/src/telemetry/assemble-operation-name.ts +21 -0
  403. package/src/telemetry/get-base-telemetry-attributes.ts +45 -0
  404. package/src/telemetry/get-global-telemetry-integration.ts +126 -0
  405. package/src/telemetry/get-tracer.ts +20 -0
  406. package/src/telemetry/index.ts +4 -0
  407. package/src/telemetry/noop-tracer.ts +69 -0
  408. package/src/telemetry/open-telemetry-integration.ts +875 -0
  409. package/src/telemetry/record-span.ts +75 -0
  410. package/src/telemetry/select-telemetry-attributes.ts +78 -0
  411. package/src/telemetry/stringify-for-telemetry.ts +33 -0
  412. package/src/telemetry/telemetry-integration-registry.ts +22 -0
  413. package/src/telemetry/telemetry-integration.ts +139 -0
  414. package/src/telemetry/telemetry-settings.ts +55 -0
  415. package/src/test/mock-embedding-model-v2.ts +35 -0
  416. package/src/test/mock-embedding-model-v3.ts +48 -0
  417. package/src/test/mock-embedding-model-v4.ts +48 -0
  418. package/src/test/mock-image-model-v2.ts +28 -0
  419. package/src/test/mock-image-model-v3.ts +28 -0
  420. package/src/test/mock-image-model-v4.ts +28 -0
  421. package/src/test/mock-language-model-v2.ts +72 -0
  422. package/src/test/mock-language-model-v3.ts +77 -0
  423. package/src/test/mock-language-model-v4.ts +77 -0
  424. package/src/test/mock-provider-v2.ts +68 -0
  425. package/src/test/mock-provider-v3.ts +80 -0
  426. package/src/test/mock-provider-v4.ts +80 -0
  427. package/src/test/mock-reranking-model-v3.ts +25 -0
  428. package/src/test/mock-reranking-model-v4.ts +25 -0
  429. package/src/test/mock-server-response.ts +69 -0
  430. package/src/test/mock-speech-model-v2.ts +24 -0
  431. package/src/test/mock-speech-model-v3.ts +24 -0
  432. package/src/test/mock-speech-model-v4.ts +24 -0
  433. package/src/test/mock-tracer.ts +156 -0
  434. package/src/test/mock-transcription-model-v2.ts +24 -0
  435. package/src/test/mock-transcription-model-v3.ts +24 -0
  436. package/src/test/mock-transcription-model-v4.ts +24 -0
  437. package/src/test/mock-values.ts +4 -0
  438. package/src/test/mock-video-model-v3.ts +28 -0
  439. package/src/test/mock-video-model-v4.ts +28 -0
  440. package/src/test/not-implemented.ts +3 -0
  441. package/src/text-stream/create-text-stream-response.ts +30 -0
  442. package/src/text-stream/index.ts +2 -0
  443. package/src/text-stream/pipe-text-stream-to-response.ts +38 -0
  444. package/src/transcribe/index.ts +2 -0
  445. package/src/transcribe/transcribe-result.ts +60 -0
  446. package/src/transcribe/transcribe.ts +187 -0
  447. package/src/types/embedding-model-middleware.ts +15 -0
  448. package/src/types/embedding-model.ts +20 -0
  449. package/src/types/image-model-middleware.ts +15 -0
  450. package/src/types/image-model-response-metadata.ts +16 -0
  451. package/src/types/image-model.ts +19 -0
  452. package/src/types/index.ts +29 -0
  453. package/src/types/json-value.ts +15 -0
  454. package/src/types/language-model-middleware.ts +15 -0
  455. package/src/types/language-model-request-metadata.ts +6 -0
  456. package/src/types/language-model-response-metadata.ts +21 -0
  457. package/src/types/language-model.ts +106 -0
  458. package/src/types/provider-metadata.ts +16 -0
  459. package/src/types/provider.ts +55 -0
  460. package/src/types/reranking-model.ts +6 -0
  461. package/src/types/speech-model-response-metadata.ts +21 -0
  462. package/src/types/speech-model.ts +10 -0
  463. package/src/types/transcription-model-response-metadata.ts +16 -0
  464. package/src/types/transcription-model.ts +14 -0
  465. package/src/types/usage.ts +200 -0
  466. package/src/types/video-model-response-metadata.ts +28 -0
  467. package/src/types/video-model.ts +15 -0
  468. package/src/types/warning.ts +7 -0
  469. package/src/ui/call-completion-api.ts +157 -0
  470. package/src/ui/chat-transport.ts +83 -0
  471. package/src/ui/chat.ts +786 -0
  472. package/src/ui/convert-file-list-to-file-ui-parts.ts +36 -0
  473. package/src/ui/convert-to-model-messages.ts +403 -0
  474. package/src/ui/default-chat-transport.ts +36 -0
  475. package/src/ui/direct-chat-transport.ts +117 -0
  476. package/src/ui/http-chat-transport.ts +273 -0
  477. package/src/ui/index.ts +76 -0
  478. package/src/ui/last-assistant-message-is-complete-with-approval-responses.ts +44 -0
  479. package/src/ui/last-assistant-message-is-complete-with-tool-calls.ts +39 -0
  480. package/src/ui/process-text-stream.ts +16 -0
  481. package/src/ui/process-ui-message-stream.ts +858 -0
  482. package/src/ui/text-stream-chat-transport.ts +23 -0
  483. package/src/ui/transform-text-to-ui-message-stream.ts +27 -0
  484. package/src/ui/ui-messages.ts +602 -0
  485. package/src/ui/use-completion.ts +84 -0
  486. package/src/ui/validate-ui-messages.ts +521 -0
  487. package/src/ui-message-stream/create-ui-message-stream-response.ts +44 -0
  488. package/src/ui-message-stream/create-ui-message-stream.ts +145 -0
  489. package/src/ui-message-stream/get-response-ui-message-id.ts +35 -0
  490. package/src/ui-message-stream/handle-ui-message-stream-finish.ts +170 -0
  491. package/src/ui-message-stream/index.ts +14 -0
  492. package/src/ui-message-stream/json-to-sse-transform-stream.ts +17 -0
  493. package/src/ui-message-stream/pipe-ui-message-stream-to-response.ts +51 -0
  494. package/src/ui-message-stream/read-ui-message-stream.ts +87 -0
  495. package/src/ui-message-stream/ui-message-chunks.ts +372 -0
  496. package/src/ui-message-stream/ui-message-stream-headers.ts +7 -0
  497. package/src/ui-message-stream/ui-message-stream-on-finish-callback.ts +32 -0
  498. package/src/ui-message-stream/ui-message-stream-on-step-finish-callback.ts +25 -0
  499. package/src/ui-message-stream/ui-message-stream-response-init.ts +14 -0
  500. package/src/ui-message-stream/ui-message-stream-writer.ts +24 -0
  501. package/src/util/as-array.ts +3 -0
  502. package/src/util/async-iterable-stream.ts +94 -0
  503. package/src/util/consume-stream.ts +31 -0
  504. package/src/util/cosine-similarity.ts +46 -0
  505. package/src/util/create-resolvable-promise.ts +30 -0
  506. package/src/util/create-stitchable-stream.ts +112 -0
  507. package/src/util/data-url.ts +17 -0
  508. package/src/util/deep-partial.ts +84 -0
  509. package/src/util/detect-media-type.ts +226 -0
  510. package/src/util/download/create-download.ts +13 -0
  511. package/src/util/download/download-function.ts +45 -0
  512. package/src/util/download/download.ts +74 -0
  513. package/src/util/error-handler.ts +1 -0
  514. package/src/util/fix-json.ts +401 -0
  515. package/src/util/get-potential-start-index.ts +39 -0
  516. package/src/util/index.ts +12 -0
  517. package/src/util/is-deep-equal-data.ts +48 -0
  518. package/src/util/is-non-empty-object.ts +5 -0
  519. package/src/util/job.ts +1 -0
  520. package/src/util/log-v2-compatibility-warning.ts +21 -0
  521. package/src/util/merge-abort-signals.ts +43 -0
  522. package/src/util/merge-objects.ts +79 -0
  523. package/src/util/notify.ts +22 -0
  524. package/src/util/now.ts +4 -0
  525. package/src/util/parse-partial-json.ts +30 -0
  526. package/src/util/prepare-headers.ts +14 -0
  527. package/src/util/prepare-retries.ts +47 -0
  528. package/src/util/retry-error.ts +41 -0
  529. package/src/util/retry-with-exponential-backoff.ts +154 -0
  530. package/src/util/serial-job-executor.ts +36 -0
  531. package/src/util/simulate-readable-stream.ts +39 -0
  532. package/src/util/split-array.ts +20 -0
  533. package/src/util/value-of.ts +65 -0
  534. package/src/util/write-to-server-response.ts +49 -0
  535. package/src/version.ts +5 -0
  536. package/test.d.ts +1 -0
@@ -0,0 +1,858 @@
1
+ import { TypeValidationContext } from '@ai-sdk/provider';
2
+ import { FlexibleSchema, validateTypes } from '@ai-sdk/provider-utils';
3
+ import { UIMessageStreamError } from '../error/ui-message-stream-error';
4
+ import { ProviderMetadata } from '../types';
5
+ import { FinishReason } from '../types/language-model';
6
+ import {
7
+ DataUIMessageChunk,
8
+ InferUIMessageChunk,
9
+ isDataUIMessageChunk,
10
+ UIMessageChunk,
11
+ } from '../ui-message-stream/ui-message-chunks';
12
+ import { ErrorHandler } from '../util/error-handler';
13
+ import { mergeObjects } from '../util/merge-objects';
14
+ import { parsePartialJson } from '../util/parse-partial-json';
15
+ import { UIDataTypesToSchemas } from './chat';
16
+ import {
17
+ CustomContentUIPart,
18
+ DataUIPart,
19
+ DynamicToolUIPart,
20
+ getStaticToolName,
21
+ InferUIMessageData,
22
+ InferUIMessageMetadata,
23
+ InferUIMessageToolCall,
24
+ InferUIMessageTools,
25
+ isStaticToolUIPart,
26
+ isToolUIPart,
27
+ ReasoningUIPart,
28
+ TextUIPart,
29
+ ToolUIPart,
30
+ UIMessage,
31
+ UIMessagePart,
32
+ } from './ui-messages';
33
+
34
+ export type StreamingUIMessageState<UI_MESSAGE extends UIMessage> = {
35
+ message: UI_MESSAGE;
36
+ activeTextParts: Record<string, TextUIPart>;
37
+ activeReasoningParts: Record<string, ReasoningUIPart>;
38
+ partialToolCalls: Record<
39
+ string,
40
+ {
41
+ text: string;
42
+ index: number;
43
+ toolName: string;
44
+ dynamic?: boolean;
45
+ title?: string;
46
+ }
47
+ >;
48
+ finishReason?: FinishReason;
49
+ };
50
+
51
+ export function createStreamingUIMessageState<UI_MESSAGE extends UIMessage>({
52
+ lastMessage,
53
+ messageId,
54
+ }: {
55
+ lastMessage: UI_MESSAGE | undefined;
56
+ messageId: string;
57
+ }): StreamingUIMessageState<UI_MESSAGE> {
58
+ return {
59
+ message:
60
+ lastMessage?.role === 'assistant'
61
+ ? lastMessage
62
+ : ({
63
+ id: messageId,
64
+ metadata: undefined,
65
+ role: 'assistant',
66
+ parts: [] as UIMessagePart<
67
+ InferUIMessageData<UI_MESSAGE>,
68
+ InferUIMessageTools<UI_MESSAGE>
69
+ >[],
70
+ } as UI_MESSAGE),
71
+ activeTextParts: {},
72
+ activeReasoningParts: {},
73
+ partialToolCalls: {},
74
+ };
75
+ }
76
+
77
+ export function processUIMessageStream<UI_MESSAGE extends UIMessage>({
78
+ stream,
79
+ messageMetadataSchema,
80
+ dataPartSchemas,
81
+ runUpdateMessageJob,
82
+ onError,
83
+ onToolCall,
84
+ onData,
85
+ }: {
86
+ // input stream is not fully typed yet:
87
+ stream: ReadableStream<UIMessageChunk>;
88
+ messageMetadataSchema?: FlexibleSchema<InferUIMessageMetadata<UI_MESSAGE>>;
89
+ dataPartSchemas?: UIDataTypesToSchemas<InferUIMessageData<UI_MESSAGE>>;
90
+ onToolCall?: (options: {
91
+ toolCall: InferUIMessageToolCall<UI_MESSAGE>;
92
+ }) => void | PromiseLike<void>;
93
+ onData?: (dataPart: DataUIPart<InferUIMessageData<UI_MESSAGE>>) => void;
94
+ runUpdateMessageJob: (
95
+ job: (options: {
96
+ state: StreamingUIMessageState<UI_MESSAGE>;
97
+ write: () => void;
98
+ }) => Promise<void>,
99
+ ) => Promise<void>;
100
+ onError: ErrorHandler;
101
+ }): ReadableStream<InferUIMessageChunk<UI_MESSAGE>> {
102
+ return stream.pipeThrough(
103
+ new TransformStream<UIMessageChunk, InferUIMessageChunk<UI_MESSAGE>>({
104
+ async transform(chunk, controller) {
105
+ await runUpdateMessageJob(async ({ state, write }) => {
106
+ function getToolInvocation(toolCallId: string) {
107
+ const toolInvocations = state.message.parts.filter(isToolUIPart);
108
+
109
+ const toolInvocation = toolInvocations.find(
110
+ invocation => invocation.toolCallId === toolCallId,
111
+ );
112
+
113
+ if (toolInvocation == null) {
114
+ throw new UIMessageStreamError({
115
+ chunkType: 'tool-invocation',
116
+ chunkId: toolCallId,
117
+ message: `No tool invocation found for tool call ID "${toolCallId}".`,
118
+ });
119
+ }
120
+
121
+ return toolInvocation;
122
+ }
123
+
124
+ function updateToolPart(
125
+ options: {
126
+ toolName: keyof InferUIMessageTools<UI_MESSAGE> & string;
127
+ toolCallId: string;
128
+ providerExecuted?: boolean;
129
+ title?: string;
130
+ } & (
131
+ | {
132
+ state: 'input-streaming';
133
+ input: unknown;
134
+ providerExecuted?: boolean;
135
+ providerMetadata?: ProviderMetadata;
136
+ }
137
+ | {
138
+ state: 'input-available';
139
+ input: unknown;
140
+ providerExecuted?: boolean;
141
+ providerMetadata?: ProviderMetadata;
142
+ }
143
+ | {
144
+ state: 'output-available';
145
+ input: unknown;
146
+ output: unknown;
147
+ providerExecuted?: boolean;
148
+ preliminary?: boolean;
149
+ providerMetadata?: ProviderMetadata;
150
+ }
151
+ | {
152
+ state: 'output-error';
153
+ input: unknown;
154
+ rawInput?: unknown;
155
+ errorText: string;
156
+ providerExecuted?: boolean;
157
+ providerMetadata?: ProviderMetadata;
158
+ }
159
+ ),
160
+ ) {
161
+ const part = state.message.parts.find(
162
+ part =>
163
+ isStaticToolUIPart(part) &&
164
+ part.toolCallId === options.toolCallId,
165
+ ) as ToolUIPart<InferUIMessageTools<UI_MESSAGE>> | undefined;
166
+
167
+ const anyOptions = options as any;
168
+ const anyPart = part as any;
169
+
170
+ if (part != null) {
171
+ part.state = options.state;
172
+ anyPart.input = anyOptions.input;
173
+ anyPart.output = anyOptions.output;
174
+ anyPart.errorText = anyOptions.errorText;
175
+ anyPart.rawInput = anyOptions.rawInput;
176
+ anyPart.preliminary = anyOptions.preliminary;
177
+ if (options.title !== undefined) {
178
+ anyPart.title = options.title;
179
+ }
180
+ // once providerExecuted is set, it stays for streaming
181
+ anyPart.providerExecuted =
182
+ anyOptions.providerExecuted ?? part.providerExecuted;
183
+
184
+ const providerMetadata = anyOptions.providerMetadata;
185
+
186
+ if (providerMetadata != null) {
187
+ if (
188
+ options.state === 'output-available' ||
189
+ options.state === 'output-error'
190
+ ) {
191
+ const resultPart = part as Extract<
192
+ ToolUIPart<InferUIMessageTools<UI_MESSAGE>>,
193
+ { state: 'output-available' | 'output-error' }
194
+ >;
195
+
196
+ resultPart.resultProviderMetadata = providerMetadata;
197
+ } else {
198
+ part.callProviderMetadata = providerMetadata;
199
+ }
200
+ }
201
+ } else {
202
+ state.message.parts.push({
203
+ type: `tool-${options.toolName}`,
204
+ toolCallId: options.toolCallId,
205
+ state: options.state,
206
+ title: options.title,
207
+ input: anyOptions.input,
208
+ output: anyOptions.output,
209
+ rawInput: anyOptions.rawInput,
210
+ errorText: anyOptions.errorText,
211
+ providerExecuted: anyOptions.providerExecuted,
212
+ preliminary: anyOptions.preliminary,
213
+ ...(anyOptions.providerMetadata != null &&
214
+ (options.state === 'output-available' ||
215
+ options.state === 'output-error')
216
+ ? { resultProviderMetadata: anyOptions.providerMetadata }
217
+ : {}),
218
+ ...(anyOptions.providerMetadata != null &&
219
+ !(
220
+ options.state === 'output-available' ||
221
+ options.state === 'output-error'
222
+ )
223
+ ? { callProviderMetadata: anyOptions.providerMetadata }
224
+ : {}),
225
+ } as ToolUIPart<InferUIMessageTools<UI_MESSAGE>>);
226
+ }
227
+ }
228
+
229
+ function updateDynamicToolPart(
230
+ options: {
231
+ toolName: keyof InferUIMessageTools<UI_MESSAGE> & string;
232
+ toolCallId: string;
233
+ providerExecuted?: boolean;
234
+ title?: string;
235
+ } & (
236
+ | {
237
+ state: 'input-streaming';
238
+ input: unknown;
239
+ providerMetadata?: ProviderMetadata;
240
+ }
241
+ | {
242
+ state: 'input-available';
243
+ input: unknown;
244
+ providerMetadata?: ProviderMetadata;
245
+ }
246
+ | {
247
+ state: 'output-available';
248
+ input: unknown;
249
+ output: unknown;
250
+ preliminary: boolean | undefined;
251
+ providerMetadata?: ProviderMetadata;
252
+ }
253
+ | {
254
+ state: 'output-error';
255
+ input: unknown;
256
+ errorText: string;
257
+ providerMetadata?: ProviderMetadata;
258
+ }
259
+ ),
260
+ ) {
261
+ const part = state.message.parts.find(
262
+ part =>
263
+ part.type === 'dynamic-tool' &&
264
+ part.toolCallId === options.toolCallId,
265
+ ) as DynamicToolUIPart | undefined;
266
+
267
+ const anyOptions = options as any;
268
+ const anyPart = part as any;
269
+
270
+ if (part != null) {
271
+ part.state = options.state;
272
+ anyPart.toolName = options.toolName;
273
+ anyPart.input = anyOptions.input;
274
+ anyPart.output = anyOptions.output;
275
+ anyPart.errorText = anyOptions.errorText;
276
+ anyPart.rawInput = anyOptions.rawInput ?? anyPart.rawInput;
277
+ anyPart.preliminary = anyOptions.preliminary;
278
+ if (options.title !== undefined) {
279
+ anyPart.title = options.title;
280
+ }
281
+ // once providerExecuted is set, it stays for streaming
282
+ anyPart.providerExecuted =
283
+ anyOptions.providerExecuted ?? part.providerExecuted;
284
+
285
+ const providerMetadata = anyOptions.providerMetadata;
286
+
287
+ if (providerMetadata != null) {
288
+ if (
289
+ options.state === 'output-available' ||
290
+ options.state === 'output-error'
291
+ ) {
292
+ const resultPart = part as Extract<
293
+ DynamicToolUIPart,
294
+ { state: 'output-available' | 'output-error' }
295
+ >;
296
+
297
+ resultPart.resultProviderMetadata = providerMetadata;
298
+ } else {
299
+ part.callProviderMetadata = providerMetadata;
300
+ }
301
+ }
302
+ } else {
303
+ state.message.parts.push({
304
+ type: 'dynamic-tool',
305
+ toolName: options.toolName,
306
+ toolCallId: options.toolCallId,
307
+ state: options.state,
308
+ input: anyOptions.input,
309
+ output: anyOptions.output,
310
+ errorText: anyOptions.errorText,
311
+ preliminary: anyOptions.preliminary,
312
+ providerExecuted: anyOptions.providerExecuted,
313
+ title: options.title,
314
+ ...(anyOptions.providerMetadata != null &&
315
+ (options.state === 'output-available' ||
316
+ options.state === 'output-error')
317
+ ? { resultProviderMetadata: anyOptions.providerMetadata }
318
+ : {}),
319
+ ...(anyOptions.providerMetadata != null &&
320
+ !(
321
+ options.state === 'output-available' ||
322
+ options.state === 'output-error'
323
+ )
324
+ ? { callProviderMetadata: anyOptions.providerMetadata }
325
+ : {}),
326
+ } as DynamicToolUIPart);
327
+ }
328
+ }
329
+
330
+ async function updateMessageMetadata(metadata: unknown) {
331
+ if (metadata != null) {
332
+ const mergedMetadata =
333
+ state.message.metadata != null
334
+ ? mergeObjects(state.message.metadata, metadata)
335
+ : metadata;
336
+
337
+ if (messageMetadataSchema != null) {
338
+ await validateTypes({
339
+ value: mergedMetadata,
340
+ schema: messageMetadataSchema,
341
+ context: {
342
+ field: 'message.metadata',
343
+ entityId: state.message.id,
344
+ },
345
+ });
346
+ }
347
+
348
+ state.message.metadata =
349
+ mergedMetadata as InferUIMessageMetadata<UI_MESSAGE>;
350
+ }
351
+ }
352
+
353
+ switch (chunk.type) {
354
+ case 'text-start': {
355
+ const textPart: TextUIPart = {
356
+ type: 'text',
357
+ text: '',
358
+ providerMetadata: chunk.providerMetadata,
359
+ state: 'streaming',
360
+ };
361
+ state.activeTextParts[chunk.id] = textPart;
362
+ state.message.parts.push(textPart);
363
+ write();
364
+ break;
365
+ }
366
+
367
+ case 'text-delta': {
368
+ const textPart = state.activeTextParts[chunk.id];
369
+ if (textPart == null) {
370
+ throw new UIMessageStreamError({
371
+ chunkType: 'text-delta',
372
+ chunkId: chunk.id,
373
+ message:
374
+ `Received text-delta for missing text part with ID "${chunk.id}". ` +
375
+ `Ensure a "text-start" chunk is sent before any "text-delta" chunks.`,
376
+ });
377
+ }
378
+ textPart.text += chunk.delta;
379
+ textPart.providerMetadata =
380
+ chunk.providerMetadata ?? textPart.providerMetadata;
381
+ write();
382
+ break;
383
+ }
384
+
385
+ case 'text-end': {
386
+ const textPart = state.activeTextParts[chunk.id];
387
+ if (textPart == null) {
388
+ throw new UIMessageStreamError({
389
+ chunkType: 'text-end',
390
+ chunkId: chunk.id,
391
+ message:
392
+ `Received text-end for missing text part with ID "${chunk.id}". ` +
393
+ `Ensure a "text-start" chunk is sent before any "text-end" chunks.`,
394
+ });
395
+ }
396
+ textPart.state = 'done';
397
+ textPart.providerMetadata =
398
+ chunk.providerMetadata ?? textPart.providerMetadata;
399
+ delete state.activeTextParts[chunk.id];
400
+ write();
401
+ break;
402
+ }
403
+
404
+ case 'custom': {
405
+ const customPart: CustomContentUIPart = {
406
+ type: 'custom',
407
+ kind: chunk.kind,
408
+ providerMetadata: chunk.providerMetadata,
409
+ };
410
+ state.message.parts.push(customPart);
411
+ write();
412
+ break;
413
+ }
414
+
415
+ case 'reasoning-start': {
416
+ const reasoningPart: ReasoningUIPart = {
417
+ type: 'reasoning',
418
+ text: '',
419
+ providerMetadata: chunk.providerMetadata,
420
+ state: 'streaming',
421
+ };
422
+ state.activeReasoningParts[chunk.id] = reasoningPart;
423
+ state.message.parts.push(reasoningPart);
424
+ write();
425
+ break;
426
+ }
427
+
428
+ case 'reasoning-delta': {
429
+ const reasoningPart = state.activeReasoningParts[chunk.id];
430
+ if (reasoningPart == null) {
431
+ throw new UIMessageStreamError({
432
+ chunkType: 'reasoning-delta',
433
+ chunkId: chunk.id,
434
+ message:
435
+ `Received reasoning-delta for missing reasoning part with ID "${chunk.id}". ` +
436
+ `Ensure a "reasoning-start" chunk is sent before any "reasoning-delta" chunks.`,
437
+ });
438
+ }
439
+ reasoningPart.text += chunk.delta;
440
+ reasoningPart.providerMetadata =
441
+ chunk.providerMetadata ?? reasoningPart.providerMetadata;
442
+ write();
443
+ break;
444
+ }
445
+
446
+ case 'reasoning-end': {
447
+ const reasoningPart = state.activeReasoningParts[chunk.id];
448
+ if (reasoningPart == null) {
449
+ throw new UIMessageStreamError({
450
+ chunkType: 'reasoning-end',
451
+ chunkId: chunk.id,
452
+ message:
453
+ `Received reasoning-end for missing reasoning part with ID "${chunk.id}". ` +
454
+ `Ensure a "reasoning-start" chunk is sent before any "reasoning-end" chunks.`,
455
+ });
456
+ }
457
+ reasoningPart.providerMetadata =
458
+ chunk.providerMetadata ?? reasoningPart.providerMetadata;
459
+ reasoningPart.state = 'done';
460
+ delete state.activeReasoningParts[chunk.id];
461
+
462
+ write();
463
+ break;
464
+ }
465
+
466
+ case 'file':
467
+ case 'reasoning-file': {
468
+ state.message.parts.push({
469
+ type: chunk.type,
470
+ mediaType: chunk.mediaType,
471
+ url: chunk.url,
472
+ ...(chunk.providerMetadata != null
473
+ ? { providerMetadata: chunk.providerMetadata }
474
+ : {}),
475
+ });
476
+
477
+ write();
478
+ break;
479
+ }
480
+
481
+ case 'source-url': {
482
+ state.message.parts.push({
483
+ type: 'source-url',
484
+ sourceId: chunk.sourceId,
485
+ url: chunk.url,
486
+ title: chunk.title,
487
+ providerMetadata: chunk.providerMetadata,
488
+ });
489
+
490
+ write();
491
+ break;
492
+ }
493
+
494
+ case 'source-document': {
495
+ state.message.parts.push({
496
+ type: 'source-document',
497
+ sourceId: chunk.sourceId,
498
+ mediaType: chunk.mediaType,
499
+ title: chunk.title,
500
+ filename: chunk.filename,
501
+ providerMetadata: chunk.providerMetadata,
502
+ });
503
+
504
+ write();
505
+ break;
506
+ }
507
+
508
+ case 'tool-input-start': {
509
+ const toolInvocations =
510
+ state.message.parts.filter(isStaticToolUIPart);
511
+
512
+ // add the partial tool call to the map
513
+ state.partialToolCalls[chunk.toolCallId] = {
514
+ text: '',
515
+ toolName: chunk.toolName,
516
+ index: toolInvocations.length,
517
+ dynamic: chunk.dynamic,
518
+ title: chunk.title,
519
+ };
520
+
521
+ if (chunk.dynamic) {
522
+ updateDynamicToolPart({
523
+ toolCallId: chunk.toolCallId,
524
+ toolName: chunk.toolName,
525
+ state: 'input-streaming',
526
+ input: undefined,
527
+ providerExecuted: chunk.providerExecuted,
528
+ title: chunk.title,
529
+ providerMetadata: chunk.providerMetadata,
530
+ });
531
+ } else {
532
+ updateToolPart({
533
+ toolCallId: chunk.toolCallId,
534
+ toolName: chunk.toolName,
535
+ state: 'input-streaming',
536
+ input: undefined,
537
+ providerExecuted: chunk.providerExecuted,
538
+ title: chunk.title,
539
+ providerMetadata: chunk.providerMetadata,
540
+ });
541
+ }
542
+
543
+ write();
544
+ break;
545
+ }
546
+
547
+ case 'tool-input-delta': {
548
+ const partialToolCall = state.partialToolCalls[chunk.toolCallId];
549
+ if (partialToolCall == null) {
550
+ throw new UIMessageStreamError({
551
+ chunkType: 'tool-input-delta',
552
+ chunkId: chunk.toolCallId,
553
+ message:
554
+ `Received tool-input-delta for missing tool call with ID "${chunk.toolCallId}". ` +
555
+ `Ensure a "tool-input-start" chunk is sent before any "tool-input-delta" chunks.`,
556
+ });
557
+ }
558
+
559
+ partialToolCall.text += chunk.inputTextDelta;
560
+
561
+ const { value: partialArgs } = await parsePartialJson(
562
+ partialToolCall.text,
563
+ );
564
+
565
+ if (partialToolCall.dynamic) {
566
+ updateDynamicToolPart({
567
+ toolCallId: chunk.toolCallId,
568
+ toolName: partialToolCall.toolName,
569
+ state: 'input-streaming',
570
+ input: partialArgs,
571
+ title: partialToolCall.title,
572
+ });
573
+ } else {
574
+ updateToolPart({
575
+ toolCallId: chunk.toolCallId,
576
+ toolName: partialToolCall.toolName,
577
+ state: 'input-streaming',
578
+ input: partialArgs,
579
+ title: partialToolCall.title,
580
+ });
581
+ }
582
+
583
+ write();
584
+ break;
585
+ }
586
+
587
+ case 'tool-input-available': {
588
+ if (chunk.dynamic) {
589
+ updateDynamicToolPart({
590
+ toolCallId: chunk.toolCallId,
591
+ toolName: chunk.toolName,
592
+ state: 'input-available',
593
+ input: chunk.input,
594
+ providerExecuted: chunk.providerExecuted,
595
+ providerMetadata: chunk.providerMetadata,
596
+ title: chunk.title,
597
+ });
598
+ } else {
599
+ updateToolPart({
600
+ toolCallId: chunk.toolCallId,
601
+ toolName: chunk.toolName,
602
+ state: 'input-available',
603
+ input: chunk.input,
604
+ providerExecuted: chunk.providerExecuted,
605
+ providerMetadata: chunk.providerMetadata,
606
+ title: chunk.title,
607
+ });
608
+ }
609
+
610
+ write();
611
+
612
+ // invoke the onToolCall callback if it exists. This is blocking.
613
+ // In the future we should make this non-blocking, which
614
+ // requires additional state management for error handling etc.
615
+ // Skip calling onToolCall for provider-executed tools since they are already executed
616
+ if (onToolCall && !chunk.providerExecuted) {
617
+ await onToolCall({
618
+ toolCall: chunk as InferUIMessageToolCall<UI_MESSAGE>,
619
+ });
620
+ }
621
+ break;
622
+ }
623
+
624
+ case 'tool-input-error': {
625
+ // When a part already exists for this toolCallId (e.g. from
626
+ // tool-input-start), honour its type so we update in place
627
+ // instead of creating a duplicate with a mismatched type.
628
+ const existingPart = state.message.parts
629
+ .filter(isToolUIPart)
630
+ .find(p => p.toolCallId === chunk.toolCallId);
631
+ const isDynamic =
632
+ existingPart != null
633
+ ? existingPart.type === 'dynamic-tool'
634
+ : !!chunk.dynamic;
635
+
636
+ if (isDynamic) {
637
+ updateDynamicToolPart({
638
+ toolCallId: chunk.toolCallId,
639
+ toolName: chunk.toolName,
640
+ state: 'output-error',
641
+ input: chunk.input,
642
+ errorText: chunk.errorText,
643
+ providerExecuted: chunk.providerExecuted,
644
+ providerMetadata: chunk.providerMetadata,
645
+ });
646
+ } else {
647
+ updateToolPart({
648
+ toolCallId: chunk.toolCallId,
649
+ toolName: chunk.toolName,
650
+ state: 'output-error',
651
+ input: undefined,
652
+ rawInput: chunk.input,
653
+ errorText: chunk.errorText,
654
+ providerExecuted: chunk.providerExecuted,
655
+ providerMetadata: chunk.providerMetadata,
656
+ });
657
+ }
658
+
659
+ write();
660
+ break;
661
+ }
662
+
663
+ case 'tool-approval-request': {
664
+ const toolInvocation = getToolInvocation(chunk.toolCallId);
665
+ toolInvocation.state = 'approval-requested';
666
+ toolInvocation.approval = { id: chunk.approvalId };
667
+ write();
668
+ break;
669
+ }
670
+
671
+ case 'tool-output-denied': {
672
+ const toolInvocation = getToolInvocation(chunk.toolCallId);
673
+ toolInvocation.state = 'output-denied';
674
+ write();
675
+ break;
676
+ }
677
+
678
+ case 'tool-output-available': {
679
+ const toolInvocation = getToolInvocation(chunk.toolCallId);
680
+
681
+ if (toolInvocation.type === 'dynamic-tool') {
682
+ updateDynamicToolPart({
683
+ toolCallId: chunk.toolCallId,
684
+ toolName: toolInvocation.toolName,
685
+ state: 'output-available',
686
+ input: (toolInvocation as any).input,
687
+ output: chunk.output,
688
+ preliminary: chunk.preliminary,
689
+ providerExecuted: chunk.providerExecuted,
690
+ providerMetadata: chunk.providerMetadata,
691
+ title: toolInvocation.title,
692
+ });
693
+ } else {
694
+ updateToolPart({
695
+ toolCallId: chunk.toolCallId,
696
+ toolName: getStaticToolName(toolInvocation),
697
+ state: 'output-available',
698
+ input: (toolInvocation as any).input,
699
+ output: chunk.output,
700
+ providerExecuted: chunk.providerExecuted,
701
+ preliminary: chunk.preliminary,
702
+ providerMetadata: chunk.providerMetadata,
703
+ title: toolInvocation.title,
704
+ });
705
+ }
706
+
707
+ write();
708
+ break;
709
+ }
710
+
711
+ case 'tool-output-error': {
712
+ const toolInvocation = getToolInvocation(chunk.toolCallId);
713
+
714
+ if (toolInvocation.type === 'dynamic-tool') {
715
+ updateDynamicToolPart({
716
+ toolCallId: chunk.toolCallId,
717
+ toolName: toolInvocation.toolName,
718
+ state: 'output-error',
719
+ input: (toolInvocation as any).input,
720
+ errorText: chunk.errorText,
721
+ providerExecuted: chunk.providerExecuted,
722
+ providerMetadata: chunk.providerMetadata,
723
+ title: toolInvocation.title,
724
+ });
725
+ } else {
726
+ updateToolPart({
727
+ toolCallId: chunk.toolCallId,
728
+ toolName: getStaticToolName(toolInvocation),
729
+ state: 'output-error',
730
+ input: (toolInvocation as any).input,
731
+ rawInput: (toolInvocation as any).rawInput,
732
+ errorText: chunk.errorText,
733
+ providerExecuted: chunk.providerExecuted,
734
+ providerMetadata: chunk.providerMetadata,
735
+ title: toolInvocation.title,
736
+ });
737
+ }
738
+
739
+ write();
740
+ break;
741
+ }
742
+
743
+ case 'start-step': {
744
+ // add a step boundary part to the message
745
+ state.message.parts.push({ type: 'step-start' });
746
+ break;
747
+ }
748
+
749
+ case 'finish-step': {
750
+ // reset the current text and reasoning parts
751
+ state.activeTextParts = {};
752
+ state.activeReasoningParts = {};
753
+ break;
754
+ }
755
+
756
+ case 'start': {
757
+ if (chunk.messageId != null) {
758
+ state.message.id = chunk.messageId;
759
+ }
760
+
761
+ await updateMessageMetadata(chunk.messageMetadata);
762
+
763
+ if (chunk.messageId != null || chunk.messageMetadata != null) {
764
+ write();
765
+ }
766
+ break;
767
+ }
768
+
769
+ case 'finish': {
770
+ if (chunk.finishReason != null) {
771
+ state.finishReason = chunk.finishReason;
772
+ }
773
+ await updateMessageMetadata(chunk.messageMetadata);
774
+ if (chunk.messageMetadata != null) {
775
+ write();
776
+ }
777
+ break;
778
+ }
779
+
780
+ case 'message-metadata': {
781
+ await updateMessageMetadata(chunk.messageMetadata);
782
+ if (chunk.messageMetadata != null) {
783
+ write();
784
+ }
785
+ break;
786
+ }
787
+
788
+ case 'error': {
789
+ onError?.(new Error(chunk.errorText));
790
+ break;
791
+ }
792
+
793
+ default: {
794
+ if (isDataUIMessageChunk(chunk)) {
795
+ // validate data chunk if dataPartSchemas is provided
796
+ if (dataPartSchemas?.[chunk.type] != null) {
797
+ const partIdx = state.message.parts.findIndex(
798
+ p =>
799
+ 'id' in p &&
800
+ 'data' in p &&
801
+ p.id === chunk.id &&
802
+ p.type === chunk.type,
803
+ );
804
+ const actualPartIdx =
805
+ partIdx >= 0 ? partIdx : state.message.parts.length;
806
+
807
+ await validateTypes({
808
+ value: chunk.data,
809
+ schema: dataPartSchemas[chunk.type],
810
+ context: {
811
+ field: `message.parts[${actualPartIdx}].data`,
812
+ entityName: chunk.type,
813
+ entityId: chunk.id,
814
+ },
815
+ });
816
+ }
817
+
818
+ // cast, validation is done above
819
+ const dataChunk = chunk as DataUIMessageChunk<
820
+ InferUIMessageData<UI_MESSAGE>
821
+ >;
822
+
823
+ // transient parts are not added to the message state
824
+ if (dataChunk.transient) {
825
+ onData?.(dataChunk);
826
+ break;
827
+ }
828
+
829
+ const existingUIPart =
830
+ dataChunk.id != null
831
+ ? (state.message.parts.find(
832
+ chunkArg =>
833
+ dataChunk.type === chunkArg.type &&
834
+ dataChunk.id === chunkArg.id,
835
+ ) as
836
+ | DataUIPart<InferUIMessageData<UI_MESSAGE>>
837
+ | undefined)
838
+ : undefined;
839
+
840
+ if (existingUIPart != null) {
841
+ existingUIPart.data = dataChunk.data;
842
+ } else {
843
+ state.message.parts.push(dataChunk);
844
+ }
845
+
846
+ onData?.(dataChunk);
847
+
848
+ write();
849
+ }
850
+ }
851
+ }
852
+
853
+ controller.enqueue(chunk as InferUIMessageChunk<UI_MESSAGE>);
854
+ });
855
+ },
856
+ }),
857
+ );
858
+ }