@copilotkit/shared 2.0.0-next.1 → 2.0.0-rc.1

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 (592) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +93 -12
  3. package/dist/_virtual/_rolldown/runtime.cjs +29 -0
  4. package/dist/a2ui-envelope.cjs +154 -0
  5. package/dist/a2ui-envelope.cjs.map +1 -0
  6. package/dist/a2ui-envelope.d.cts +101 -0
  7. package/dist/a2ui-envelope.d.cts.map +1 -0
  8. package/dist/a2ui-envelope.d.mts +101 -0
  9. package/dist/a2ui-envelope.d.mts.map +1 -0
  10. package/dist/a2ui-envelope.mjs +151 -0
  11. package/dist/a2ui-envelope.mjs.map +1 -0
  12. package/dist/a2ui-prompts.cjs +259 -0
  13. package/dist/a2ui-prompts.cjs.map +1 -0
  14. package/dist/a2ui-prompts.d.cts +79 -0
  15. package/dist/a2ui-prompts.d.cts.map +1 -0
  16. package/dist/a2ui-prompts.d.mts +79 -0
  17. package/dist/a2ui-prompts.d.mts.map +1 -0
  18. package/dist/a2ui-prompts.mjs +251 -0
  19. package/dist/a2ui-prompts.mjs.map +1 -0
  20. package/dist/attachments/content.cjs +17 -0
  21. package/dist/attachments/content.cjs.map +1 -0
  22. package/dist/attachments/content.d.cts +9 -0
  23. package/dist/attachments/content.d.cts.map +1 -0
  24. package/dist/attachments/content.d.mts +9 -0
  25. package/dist/attachments/content.d.mts.map +1 -0
  26. package/dist/attachments/content.mjs +16 -0
  27. package/dist/attachments/content.mjs.map +1 -0
  28. package/dist/attachments/types.d.cts +64 -0
  29. package/dist/attachments/types.d.cts.map +1 -0
  30. package/dist/attachments/types.d.mts +64 -0
  31. package/dist/attachments/types.d.mts.map +1 -0
  32. package/dist/attachments/utils.cjs +137 -0
  33. package/dist/attachments/utils.cjs.map +1 -0
  34. package/dist/attachments/utils.d.cts +44 -0
  35. package/dist/attachments/utils.d.cts.map +1 -0
  36. package/dist/attachments/utils.d.mts +44 -0
  37. package/dist/attachments/utils.d.mts.map +1 -0
  38. package/dist/attachments/utils.mjs +129 -0
  39. package/dist/attachments/utils.mjs.map +1 -0
  40. package/dist/constants/index.cjs +25 -0
  41. package/dist/constants/index.cjs.map +1 -0
  42. package/dist/constants/index.d.cts +17 -0
  43. package/dist/constants/index.d.cts.map +1 -0
  44. package/dist/constants/index.d.mts +17 -0
  45. package/dist/constants/index.d.mts.map +1 -0
  46. package/dist/constants/index.mjs +17 -12
  47. package/dist/constants/index.mjs.map +1 -1
  48. package/dist/debug-event-envelope.d.cts +13 -0
  49. package/dist/debug-event-envelope.d.cts.map +1 -0
  50. package/dist/debug-event-envelope.d.mts +13 -0
  51. package/dist/debug-event-envelope.d.mts.map +1 -0
  52. package/dist/debug.cjs +38 -0
  53. package/dist/debug.cjs.map +1 -0
  54. package/dist/debug.d.cts +29 -0
  55. package/dist/debug.d.cts.map +1 -0
  56. package/dist/debug.d.mts +29 -0
  57. package/dist/debug.d.mts.map +1 -0
  58. package/dist/debug.mjs +37 -0
  59. package/dist/debug.mjs.map +1 -0
  60. package/dist/event-transforms/index.cjs +15 -0
  61. package/dist/event-transforms/index.d.cts +4 -0
  62. package/dist/event-transforms/index.d.mts +4 -0
  63. package/dist/event-transforms/index.mjs +5 -0
  64. package/dist/event-transforms/open-generative-ui-middleware.cjs +286 -0
  65. package/dist/event-transforms/open-generative-ui-middleware.cjs.map +1 -0
  66. package/dist/event-transforms/open-generative-ui-middleware.d.cts +60 -0
  67. package/dist/event-transforms/open-generative-ui-middleware.d.cts.map +1 -0
  68. package/dist/event-transforms/open-generative-ui-middleware.d.mts +60 -0
  69. package/dist/event-transforms/open-generative-ui-middleware.d.mts.map +1 -0
  70. package/dist/event-transforms/open-generative-ui-middleware.mjs +283 -0
  71. package/dist/event-transforms/open-generative-ui-middleware.mjs.map +1 -0
  72. package/dist/event-transforms/recorded-events.cjs +59 -0
  73. package/dist/event-transforms/recorded-events.cjs.map +1 -0
  74. package/dist/event-transforms/recorded-events.d.cts +23 -0
  75. package/dist/event-transforms/recorded-events.d.cts.map +1 -0
  76. package/dist/event-transforms/recorded-events.d.mts +23 -0
  77. package/dist/event-transforms/recorded-events.d.mts.map +1 -0
  78. package/dist/event-transforms/recorded-events.mjs +58 -0
  79. package/dist/event-transforms/recorded-events.mjs.map +1 -0
  80. package/dist/finalize-events.cjs +186 -0
  81. package/dist/finalize-events.cjs.map +1 -0
  82. package/dist/finalize-events.d.cts +40 -0
  83. package/dist/finalize-events.d.cts.map +1 -0
  84. package/dist/finalize-events.d.mts +40 -0
  85. package/dist/finalize-events.d.mts.map +1 -0
  86. package/dist/finalize-events.mjs +184 -0
  87. package/dist/finalize-events.mjs.map +1 -0
  88. package/dist/generative-ui/basic-functions.cjs +177 -0
  89. package/dist/generative-ui/basic-functions.cjs.map +1 -0
  90. package/dist/generative-ui/basic-functions.d.cts +108 -0
  91. package/dist/generative-ui/basic-functions.d.cts.map +1 -0
  92. package/dist/generative-ui/basic-functions.d.mts +108 -0
  93. package/dist/generative-ui/basic-functions.d.mts.map +1 -0
  94. package/dist/generative-ui/basic-functions.mjs +167 -0
  95. package/dist/generative-ui/basic-functions.mjs.map +1 -0
  96. package/dist/generative-ui/child-refs.cjs +161 -0
  97. package/dist/generative-ui/child-refs.cjs.map +1 -0
  98. package/dist/generative-ui/child-refs.d.cts +68 -0
  99. package/dist/generative-ui/child-refs.d.cts.map +1 -0
  100. package/dist/generative-ui/child-refs.d.mts +68 -0
  101. package/dist/generative-ui/child-refs.d.mts.map +1 -0
  102. package/dist/generative-ui/child-refs.mjs +152 -0
  103. package/dist/generative-ui/child-refs.mjs.map +1 -0
  104. package/dist/generative-ui/is-record.cjs +10 -0
  105. package/dist/generative-ui/is-record.cjs.map +1 -0
  106. package/dist/generative-ui/is-record.mjs +9 -0
  107. package/dist/generative-ui/is-record.mjs.map +1 -0
  108. package/dist/generative-ui/prompt.cjs +91 -0
  109. package/dist/generative-ui/prompt.cjs.map +1 -0
  110. package/dist/generative-ui/prompt.d.cts +13 -0
  111. package/dist/generative-ui/prompt.d.cts.map +1 -0
  112. package/dist/generative-ui/prompt.d.mts +13 -0
  113. package/dist/generative-ui/prompt.d.mts.map +1 -0
  114. package/dist/generative-ui/prompt.mjs +90 -0
  115. package/dist/generative-ui/prompt.mjs.map +1 -0
  116. package/dist/generative-ui/render-ui-args.cjs +160 -0
  117. package/dist/generative-ui/render-ui-args.cjs.map +1 -0
  118. package/dist/generative-ui/render-ui-args.d.cts +40 -0
  119. package/dist/generative-ui/render-ui-args.d.cts.map +1 -0
  120. package/dist/generative-ui/render-ui-args.d.mts +40 -0
  121. package/dist/generative-ui/render-ui-args.d.mts.map +1 -0
  122. package/dist/generative-ui/render-ui-args.mjs +159 -0
  123. package/dist/generative-ui/render-ui-args.mjs.map +1 -0
  124. package/dist/generative-ui/types.cjs +101 -0
  125. package/dist/generative-ui/types.cjs.map +1 -0
  126. package/dist/generative-ui/types.d.cts +270 -0
  127. package/dist/generative-ui/types.d.cts.map +1 -0
  128. package/dist/generative-ui/types.d.mts +270 -0
  129. package/dist/generative-ui/types.d.mts.map +1 -0
  130. package/dist/generative-ui/types.mjs +86 -0
  131. package/dist/generative-ui/types.mjs.map +1 -0
  132. package/dist/generative-ui/validate-operation.cjs +405 -0
  133. package/dist/generative-ui/validate-operation.cjs.map +1 -0
  134. package/dist/generative-ui/validate-operation.d.cts +86 -0
  135. package/dist/generative-ui/validate-operation.d.cts.map +1 -0
  136. package/dist/generative-ui/validate-operation.d.mts +86 -0
  137. package/dist/generative-ui/validate-operation.d.mts.map +1 -0
  138. package/dist/generative-ui/validate-operation.mjs +399 -0
  139. package/dist/generative-ui/validate-operation.mjs.map +1 -0
  140. package/dist/index.cjs +233 -0
  141. package/dist/index.cjs.map +1 -0
  142. package/dist/index.d.cts +80 -0
  143. package/dist/index.d.cts.map +1 -0
  144. package/dist/index.d.mts +80 -0
  145. package/dist/index.d.mts.map +1 -0
  146. package/dist/index.mjs +78 -123
  147. package/dist/index.mjs.map +1 -1
  148. package/dist/index.umd.js +3979 -0
  149. package/dist/index.umd.js.map +1 -0
  150. package/dist/intelligence-routing-fields.cjs +35 -0
  151. package/dist/intelligence-routing-fields.cjs.map +1 -0
  152. package/dist/intelligence-routing-fields.d.cts +18 -0
  153. package/dist/intelligence-routing-fields.d.cts.map +1 -0
  154. package/dist/intelligence-routing-fields.d.mts +18 -0
  155. package/dist/intelligence-routing-fields.d.mts.map +1 -0
  156. package/dist/intelligence-routing-fields.mjs +34 -0
  157. package/dist/intelligence-routing-fields.mjs.map +1 -0
  158. package/dist/logger.cjs +7 -0
  159. package/dist/logger.cjs.map +1 -0
  160. package/dist/logger.d.cts +5 -0
  161. package/dist/logger.d.cts.map +1 -0
  162. package/dist/logger.d.mts +5 -0
  163. package/dist/logger.d.mts.map +1 -0
  164. package/dist/logger.mjs +6 -0
  165. package/dist/logger.mjs.map +1 -0
  166. package/dist/open-generative-ui-prompts.cjs +8 -0
  167. package/dist/open-generative-ui-prompts.cjs.map +1 -0
  168. package/dist/open-generative-ui-prompts.d.cts +6 -0
  169. package/dist/open-generative-ui-prompts.d.cts.map +1 -0
  170. package/dist/open-generative-ui-prompts.d.mts +6 -0
  171. package/dist/open-generative-ui-prompts.d.mts.map +1 -0
  172. package/dist/open-generative-ui-prompts.mjs +7 -0
  173. package/dist/open-generative-ui-prompts.mjs.map +1 -0
  174. package/dist/package.cjs +12 -0
  175. package/dist/package.cjs.map +1 -0
  176. package/dist/package.mjs +6 -0
  177. package/dist/package.mjs.map +1 -0
  178. package/dist/standard-schema.cjs +31 -0
  179. package/dist/standard-schema.cjs.map +1 -0
  180. package/dist/standard-schema.d.cts +33 -0
  181. package/dist/standard-schema.d.cts.map +1 -0
  182. package/dist/standard-schema.d.mts +33 -0
  183. package/dist/standard-schema.d.mts.map +1 -0
  184. package/dist/standard-schema.mjs +30 -0
  185. package/dist/standard-schema.mjs.map +1 -0
  186. package/dist/telemetry/events.d.cts +72 -0
  187. package/dist/telemetry/events.d.cts.map +1 -0
  188. package/dist/telemetry/events.d.mts +72 -0
  189. package/dist/telemetry/events.d.mts.map +1 -0
  190. package/dist/telemetry/index.cjs +18 -0
  191. package/dist/telemetry/index.d.cts +5 -0
  192. package/dist/telemetry/index.d.mts +5 -0
  193. package/dist/telemetry/index.mjs +6 -12
  194. package/dist/telemetry/lambda-client.cjs +91 -0
  195. package/dist/telemetry/lambda-client.cjs.map +1 -0
  196. package/dist/telemetry/lambda-client.d.cts +31 -0
  197. package/dist/telemetry/lambda-client.d.cts.map +1 -0
  198. package/dist/telemetry/lambda-client.d.mts +31 -0
  199. package/dist/telemetry/lambda-client.d.mts.map +1 -0
  200. package/dist/telemetry/lambda-client.mjs +87 -0
  201. package/dist/telemetry/lambda-client.mjs.map +1 -0
  202. package/dist/telemetry/model-host.cjs +104 -0
  203. package/dist/telemetry/model-host.cjs.map +1 -0
  204. package/dist/telemetry/model-host.d.cts +26 -0
  205. package/dist/telemetry/model-host.d.cts.map +1 -0
  206. package/dist/telemetry/model-host.d.mts +26 -0
  207. package/dist/telemetry/model-host.d.mts.map +1 -0
  208. package/dist/telemetry/model-host.mjs +102 -0
  209. package/dist/telemetry/model-host.mjs.map +1 -0
  210. package/dist/telemetry/sampling.cjs +50 -0
  211. package/dist/telemetry/sampling.cjs.map +1 -0
  212. package/dist/telemetry/sampling.d.cts +57 -0
  213. package/dist/telemetry/sampling.d.cts.map +1 -0
  214. package/dist/telemetry/sampling.d.mts +57 -0
  215. package/dist/telemetry/sampling.d.mts.map +1 -0
  216. package/dist/telemetry/sampling.mjs +44 -0
  217. package/dist/telemetry/sampling.mjs.map +1 -0
  218. package/dist/telemetry/telemetry-client.cjs +165 -0
  219. package/dist/telemetry/telemetry-client.cjs.map +1 -0
  220. package/dist/telemetry/telemetry-client.d.cts +87 -0
  221. package/dist/telemetry/telemetry-client.d.cts.map +1 -0
  222. package/dist/telemetry/telemetry-client.d.mts +87 -0
  223. package/dist/telemetry/telemetry-client.d.mts.map +1 -0
  224. package/dist/telemetry/telemetry-client.mjs +162 -9
  225. package/dist/telemetry/telemetry-client.mjs.map +1 -1
  226. package/dist/telemetry/telemetry-disabled.cjs +20 -0
  227. package/dist/telemetry/telemetry-disabled.cjs.map +1 -0
  228. package/dist/telemetry/telemetry-disabled.d.cts +16 -0
  229. package/dist/telemetry/telemetry-disabled.d.cts.map +1 -0
  230. package/dist/telemetry/telemetry-disabled.d.mts +16 -0
  231. package/dist/telemetry/telemetry-disabled.d.mts.map +1 -0
  232. package/dist/telemetry/telemetry-disabled.mjs +19 -0
  233. package/dist/telemetry/telemetry-disabled.mjs.map +1 -0
  234. package/dist/telemetry/utils.cjs +14 -0
  235. package/dist/telemetry/utils.cjs.map +1 -0
  236. package/dist/telemetry/utils.mjs +12 -8
  237. package/dist/telemetry/utils.mjs.map +1 -1
  238. package/dist/transcription-errors.cjs +84 -0
  239. package/dist/transcription-errors.cjs.map +1 -0
  240. package/dist/transcription-errors.d.cts +52 -0
  241. package/dist/transcription-errors.d.cts.map +1 -0
  242. package/dist/transcription-errors.d.mts +52 -0
  243. package/dist/transcription-errors.d.mts.map +1 -0
  244. package/dist/transcription-errors.mjs +82 -0
  245. package/dist/transcription-errors.mjs.map +1 -0
  246. package/dist/types/{action.d.ts → action.d.cts} +32 -32
  247. package/dist/types/action.d.cts.map +1 -0
  248. package/dist/types/action.d.mts +59 -0
  249. package/dist/types/action.d.mts.map +1 -0
  250. package/dist/types/copilot-cloud-config.d.cts +15 -0
  251. package/dist/types/copilot-cloud-config.d.cts.map +1 -0
  252. package/dist/types/copilot-cloud-config.d.mts +15 -0
  253. package/dist/types/copilot-cloud-config.d.mts.map +1 -0
  254. package/dist/types/error.d.cts +57 -0
  255. package/dist/types/error.d.cts.map +1 -0
  256. package/dist/types/error.d.mts +57 -0
  257. package/dist/types/error.d.mts.map +1 -0
  258. package/dist/types/message.d.cts +42 -0
  259. package/dist/types/message.d.cts.map +1 -0
  260. package/dist/types/message.d.mts +42 -0
  261. package/dist/types/message.d.mts.map +1 -0
  262. package/dist/types/openai-assistant.d.cts +55 -0
  263. package/dist/types/openai-assistant.d.cts.map +1 -0
  264. package/dist/types/openai-assistant.d.mts +55 -0
  265. package/dist/types/openai-assistant.d.mts.map +1 -0
  266. package/dist/types/utility.d.cts +6 -0
  267. package/dist/types/utility.d.cts.map +1 -0
  268. package/dist/types/utility.d.mts +6 -0
  269. package/dist/types/utility.d.mts.map +1 -0
  270. package/dist/utils/clipboard.cjs +28 -0
  271. package/dist/utils/clipboard.cjs.map +1 -0
  272. package/dist/utils/clipboard.d.cts +14 -0
  273. package/dist/utils/clipboard.d.cts.map +1 -0
  274. package/dist/utils/clipboard.d.mts +14 -0
  275. package/dist/utils/clipboard.d.mts.map +1 -0
  276. package/dist/utils/clipboard.mjs +27 -0
  277. package/dist/utils/clipboard.mjs.map +1 -0
  278. package/dist/utils/conditions.cjs +32 -0
  279. package/dist/utils/conditions.cjs.map +1 -0
  280. package/dist/utils/{conditions.d.ts → conditions.d.cts} +16 -11
  281. package/dist/utils/conditions.d.cts.map +1 -0
  282. package/dist/utils/conditions.d.mts +31 -0
  283. package/dist/utils/conditions.d.mts.map +1 -0
  284. package/dist/utils/conditions.mjs +30 -6
  285. package/dist/utils/conditions.mjs.map +1 -1
  286. package/dist/utils/console-styling.cjs +91 -0
  287. package/dist/utils/console-styling.cjs.map +1 -0
  288. package/dist/utils/console-styling.d.cts +65 -0
  289. package/dist/utils/console-styling.d.cts.map +1 -0
  290. package/dist/utils/console-styling.d.mts +65 -0
  291. package/dist/utils/console-styling.d.mts.map +1 -0
  292. package/dist/utils/console-styling.mjs +83 -15
  293. package/dist/utils/console-styling.mjs.map +1 -1
  294. package/dist/utils/dashboard-url.cjs +19 -0
  295. package/dist/utils/dashboard-url.cjs.map +1 -0
  296. package/dist/utils/dashboard-url.mjs +18 -0
  297. package/dist/utils/dashboard-url.mjs.map +1 -0
  298. package/dist/utils/errors.cjs +439 -0
  299. package/dist/utils/errors.cjs.map +1 -0
  300. package/dist/utils/{errors.d.ts → errors.d.cts} +188 -156
  301. package/dist/utils/errors.d.cts.map +1 -0
  302. package/dist/utils/errors.d.mts +312 -0
  303. package/dist/utils/errors.d.mts.map +1 -0
  304. package/dist/utils/errors.mjs +416 -63
  305. package/dist/utils/errors.mjs.map +1 -1
  306. package/dist/utils/index.cjs +105 -0
  307. package/dist/utils/index.cjs.map +1 -0
  308. package/dist/utils/index.d.cts +58 -0
  309. package/dist/utils/index.d.cts.map +1 -0
  310. package/dist/utils/index.d.mts +58 -0
  311. package/dist/utils/index.d.mts.map +1 -0
  312. package/dist/utils/index.mjs +97 -107
  313. package/dist/utils/index.mjs.map +1 -1
  314. package/dist/utils/inspector-learning.cjs +217 -0
  315. package/dist/utils/inspector-learning.cjs.map +1 -0
  316. package/dist/utils/inspector-learning.d.cts +104 -0
  317. package/dist/utils/inspector-learning.d.cts.map +1 -0
  318. package/dist/utils/inspector-learning.d.mts +104 -0
  319. package/dist/utils/inspector-learning.d.mts.map +1 -0
  320. package/dist/utils/inspector-learning.mjs +215 -0
  321. package/dist/utils/inspector-learning.mjs.map +1 -0
  322. package/dist/utils/inspector-metadata.cjs +146 -0
  323. package/dist/utils/inspector-metadata.cjs.map +1 -0
  324. package/dist/utils/inspector-metadata.d.cts +55 -0
  325. package/dist/utils/inspector-metadata.d.cts.map +1 -0
  326. package/dist/utils/inspector-metadata.d.mts +55 -0
  327. package/dist/utils/inspector-metadata.d.mts.map +1 -0
  328. package/dist/utils/inspector-metadata.mjs +146 -0
  329. package/dist/utils/inspector-metadata.mjs.map +1 -0
  330. package/dist/utils/inspector-visibility.cjs +13 -0
  331. package/dist/utils/inspector-visibility.cjs.map +1 -0
  332. package/dist/utils/inspector-visibility.d.cts +18 -0
  333. package/dist/utils/inspector-visibility.d.cts.map +1 -0
  334. package/dist/utils/inspector-visibility.d.mts +18 -0
  335. package/dist/utils/inspector-visibility.d.mts.map +1 -0
  336. package/dist/utils/inspector-visibility.mjs +12 -0
  337. package/dist/utils/inspector-visibility.mjs.map +1 -0
  338. package/dist/utils/json-schema.cjs +215 -0
  339. package/dist/utils/json-schema.cjs.map +1 -0
  340. package/dist/utils/{json-schema.d.ts → json-schema.d.cts} +20 -18
  341. package/dist/utils/json-schema.d.cts.map +1 -0
  342. package/dist/utils/json-schema.d.mts +36 -0
  343. package/dist/utils/json-schema.d.mts.map +1 -0
  344. package/dist/utils/json-schema.mjs +210 -12
  345. package/dist/utils/json-schema.mjs.map +1 -1
  346. package/dist/utils/random-id.cjs +38 -0
  347. package/dist/utils/random-id.cjs.map +1 -0
  348. package/dist/utils/{random-id.d.ts → random-id.d.cts} +3 -1
  349. package/dist/utils/random-id.d.cts.map +1 -0
  350. package/dist/utils/random-id.d.mts +8 -0
  351. package/dist/utils/random-id.d.mts.map +1 -0
  352. package/dist/utils/random-id.mjs +33 -12
  353. package/dist/utils/random-id.mjs.map +1 -1
  354. package/dist/utils/requests.cjs +58 -0
  355. package/dist/utils/requests.cjs.map +1 -0
  356. package/dist/utils/{requests.d.ts → requests.d.cts} +3 -1
  357. package/dist/utils/requests.d.cts.map +1 -0
  358. package/dist/utils/requests.d.mts +12 -0
  359. package/dist/utils/requests.d.mts.map +1 -0
  360. package/dist/utils/requests.mjs +56 -6
  361. package/dist/utils/requests.mjs.map +1 -1
  362. package/dist/utils/row-render-keys.cjs +206 -0
  363. package/dist/utils/row-render-keys.cjs.map +1 -0
  364. package/dist/utils/row-render-keys.d.cts +65 -0
  365. package/dist/utils/row-render-keys.d.cts.map +1 -0
  366. package/dist/utils/row-render-keys.d.mts +65 -0
  367. package/dist/utils/row-render-keys.d.mts.map +1 -0
  368. package/dist/utils/row-render-keys.mjs +201 -0
  369. package/dist/utils/row-render-keys.mjs.map +1 -0
  370. package/dist/utils/types.cjs +9 -0
  371. package/dist/utils/types.cjs.map +1 -0
  372. package/dist/utils/types.d.cts +122 -0
  373. package/dist/utils/types.d.cts.map +1 -0
  374. package/dist/utils/types.d.mts +122 -0
  375. package/dist/utils/types.d.mts.map +1 -0
  376. package/dist/utils/types.mjs +6 -1
  377. package/dist/utils/types.mjs.map +1 -1
  378. package/package.json +74 -40
  379. package/scripts/verify-cjs-exports.cjs +16 -0
  380. package/src/__tests__/a2ui-envelope.test.ts +434 -0
  381. package/src/__tests__/a2ui-prompts.test.ts +362 -0
  382. package/src/__tests__/debug.test.ts +116 -0
  383. package/src/__tests__/license-context.test.ts +253 -0
  384. package/src/__tests__/root-entry-browser-safety.test.ts +91 -0
  385. package/src/__tests__/standard-schema-types.test.ts +144 -0
  386. package/src/__tests__/standard-schema.test.ts +359 -0
  387. package/src/__tests__/zod-regression.test.ts +319 -0
  388. package/src/a2ui-envelope.ts +309 -0
  389. package/src/a2ui-prompts.ts +322 -0
  390. package/src/attachments/__tests__/utils.test.ts +214 -0
  391. package/src/attachments/content.test.ts +48 -0
  392. package/src/attachments/content.ts +16 -0
  393. package/src/attachments/index.ts +21 -0
  394. package/src/attachments/types.ts +77 -0
  395. package/src/attachments/utils.ts +169 -0
  396. package/src/constants/index.ts +14 -1
  397. package/src/debug-event-envelope.ts +9 -0
  398. package/src/debug.ts +55 -0
  399. package/src/event-transforms/index.ts +5 -0
  400. package/src/event-transforms/open-generative-ui-middleware.ts +392 -0
  401. package/src/event-transforms/recorded-events.test.ts +166 -0
  402. package/src/event-transforms/recorded-events.ts +74 -0
  403. package/src/finalize-events.test.ts +284 -0
  404. package/src/finalize-events.ts +260 -0
  405. package/src/generative-ui/__tests__/render-ui-args.test.ts +175 -0
  406. package/src/generative-ui/__tests__/validate-operation.test.ts +977 -0
  407. package/src/generative-ui/basic-functions.ts +282 -0
  408. package/src/generative-ui/child-refs.ts +210 -0
  409. package/src/generative-ui/index.ts +6 -0
  410. package/src/generative-ui/is-record.ts +4 -0
  411. package/src/generative-ui/prompt.ts +174 -0
  412. package/src/generative-ui/render-ui-args.ts +199 -0
  413. package/src/generative-ui/types.ts +314 -0
  414. package/src/generative-ui/validate-operation.ts +723 -0
  415. package/src/index.ts +190 -1
  416. package/src/intelligence-routing-fields.test.ts +51 -0
  417. package/src/intelligence-routing-fields.ts +40 -0
  418. package/src/logger.ts +1 -0
  419. package/src/open-generative-ui-prompts.ts +20 -0
  420. package/src/standard-schema.ts +82 -0
  421. package/src/telemetry/events.ts +37 -10
  422. package/src/telemetry/index.ts +8 -0
  423. package/src/telemetry/lambda-client.test.ts +446 -0
  424. package/src/telemetry/lambda-client.ts +194 -0
  425. package/src/telemetry/model-host.test.ts +145 -0
  426. package/src/telemetry/model-host.ts +156 -0
  427. package/src/telemetry/sampling.test.ts +65 -0
  428. package/src/telemetry/sampling.ts +103 -0
  429. package/src/telemetry/telemetry-blank-license-identity.test.ts +128 -0
  430. package/src/telemetry/telemetry-client.test.ts +798 -0
  431. package/src/telemetry/telemetry-client.ts +223 -37
  432. package/src/telemetry/telemetry-disabled.ts +22 -0
  433. package/src/telemetry/utils.ts +0 -24
  434. package/src/transcription-errors.ts +99 -0
  435. package/src/types/__tests__/message.test.ts +62 -0
  436. package/src/types/action.ts +9 -5
  437. package/src/types/error.ts +11 -2
  438. package/src/types/message.ts +33 -5
  439. package/src/types/openai-assistant.ts +6 -2
  440. package/src/utils/__tests__/clipboard.test.ts +87 -0
  441. package/src/utils/__tests__/conditions.test.ts +161 -0
  442. package/src/utils/__tests__/json-schema.test.ts +812 -0
  443. package/src/utils/__tests__/row-render-keys.test.ts +388 -0
  444. package/src/utils/clipboard.ts +23 -0
  445. package/src/utils/conditions.ts +27 -9
  446. package/src/utils/console-styling.ts +10 -8
  447. package/src/utils/dashboard-url.ts +17 -0
  448. package/src/utils/errors.ts +55 -22
  449. package/src/utils/index.ts +70 -1
  450. package/src/utils/inspector-learning.test.ts +423 -0
  451. package/src/utils/inspector-learning.ts +523 -0
  452. package/src/utils/inspector-metadata.test.ts +743 -0
  453. package/src/utils/inspector-metadata.ts +263 -0
  454. package/src/utils/inspector-visibility.test.ts +43 -0
  455. package/src/utils/inspector-visibility.ts +17 -0
  456. package/src/utils/json-schema.ts +156 -12
  457. package/src/utils/random-id.ts +5 -2
  458. package/src/utils/requests.ts +3 -1
  459. package/src/utils/row-render-keys.ts +263 -0
  460. package/src/utils/types.ts +128 -1
  461. package/src/utils.test.ts +137 -0
  462. package/tsconfig.json +10 -2
  463. package/tsdown.config.ts +49 -0
  464. package/vitest.config.mjs +11 -0
  465. package/CHANGELOG.md +0 -1817
  466. package/dist/chunk-2OJ5OJ2D.mjs +0 -1
  467. package/dist/chunk-2OJ5OJ2D.mjs.map +0 -1
  468. package/dist/chunk-64DYJ27R.mjs +0 -201
  469. package/dist/chunk-64DYJ27R.mjs.map +0 -1
  470. package/dist/chunk-6QGXWNS5.mjs +0 -34
  471. package/dist/chunk-6QGXWNS5.mjs.map +0 -1
  472. package/dist/chunk-6W2UEO2M.mjs +0 -94
  473. package/dist/chunk-6W2UEO2M.mjs.map +0 -1
  474. package/dist/chunk-7DJDTRNX.mjs +0 -426
  475. package/dist/chunk-7DJDTRNX.mjs.map +0 -1
  476. package/dist/chunk-A66772CV.mjs +0 -107
  477. package/dist/chunk-A66772CV.mjs.map +0 -1
  478. package/dist/chunk-BOKE4OKY.mjs +0 -41
  479. package/dist/chunk-BOKE4OKY.mjs.map +0 -1
  480. package/dist/chunk-FCCOSO5L.mjs +0 -1
  481. package/dist/chunk-FCCOSO5L.mjs.map +0 -1
  482. package/dist/chunk-GYZIHHE6.mjs +0 -13
  483. package/dist/chunk-GYZIHHE6.mjs.map +0 -1
  484. package/dist/chunk-IAFBVORQ.mjs +0 -1
  485. package/dist/chunk-IAFBVORQ.mjs.map +0 -1
  486. package/dist/chunk-JAAUCDUR.mjs +0 -38
  487. package/dist/chunk-JAAUCDUR.mjs.map +0 -1
  488. package/dist/chunk-MSUB6DGR.mjs +0 -1
  489. package/dist/chunk-MSUB6DGR.mjs.map +0 -1
  490. package/dist/chunk-N5EP5OD5.mjs +0 -1
  491. package/dist/chunk-N5EP5OD5.mjs.map +0 -1
  492. package/dist/chunk-NAFEBKSO.mjs +0 -1
  493. package/dist/chunk-NAFEBKSO.mjs.map +0 -1
  494. package/dist/chunk-P7STFMPO.mjs +0 -1
  495. package/dist/chunk-P7STFMPO.mjs.map +0 -1
  496. package/dist/chunk-PL5WNHFZ.mjs +0 -50
  497. package/dist/chunk-PL5WNHFZ.mjs.map +0 -1
  498. package/dist/chunk-UYARLQNA.mjs +0 -1
  499. package/dist/chunk-UYARLQNA.mjs.map +0 -1
  500. package/dist/chunk-XEMZTHQZ.mjs +0 -67
  501. package/dist/chunk-XEMZTHQZ.mjs.map +0 -1
  502. package/dist/chunk-XTHC46M2.mjs +0 -1
  503. package/dist/chunk-XTHC46M2.mjs.map +0 -1
  504. package/dist/constants/index.d.ts +0 -6
  505. package/dist/constants/index.js +0 -40
  506. package/dist/constants/index.js.map +0 -1
  507. package/dist/index.d.ts +0 -25
  508. package/dist/index.js +0 -1098
  509. package/dist/index.js.map +0 -1
  510. package/dist/telemetry/events.d.ts +0 -45
  511. package/dist/telemetry/events.js +0 -19
  512. package/dist/telemetry/events.js.map +0 -1
  513. package/dist/telemetry/events.mjs +0 -1
  514. package/dist/telemetry/events.mjs.map +0 -1
  515. package/dist/telemetry/index.d.ts +0 -3
  516. package/dist/telemetry/index.js +0 -188
  517. package/dist/telemetry/index.js.map +0 -1
  518. package/dist/telemetry/index.mjs.map +0 -1
  519. package/dist/telemetry/scarf-client.d.ts +0 -7
  520. package/dist/telemetry/scarf-client.js +0 -59
  521. package/dist/telemetry/scarf-client.js.map +0 -1
  522. package/dist/telemetry/scarf-client.mjs +0 -7
  523. package/dist/telemetry/scarf-client.mjs.map +0 -1
  524. package/dist/telemetry/security-check.d.ts +0 -2
  525. package/dist/telemetry/security-check.js +0 -2
  526. package/dist/telemetry/security-check.js.map +0 -1
  527. package/dist/telemetry/security-check.mjs +0 -1
  528. package/dist/telemetry/security-check.mjs.map +0 -1
  529. package/dist/telemetry/telemetry-client.d.ts +0 -40
  530. package/dist/telemetry/telemetry-client.js +0 -186
  531. package/dist/telemetry/telemetry-client.js.map +0 -1
  532. package/dist/telemetry/utils.d.ts +0 -8
  533. package/dist/telemetry/utils.js +0 -69
  534. package/dist/telemetry/utils.js.map +0 -1
  535. package/dist/types/action.js +0 -19
  536. package/dist/types/action.js.map +0 -1
  537. package/dist/types/action.mjs +0 -2
  538. package/dist/types/action.mjs.map +0 -1
  539. package/dist/types/copilot-cloud-config.d.ts +0 -13
  540. package/dist/types/copilot-cloud-config.js +0 -19
  541. package/dist/types/copilot-cloud-config.js.map +0 -1
  542. package/dist/types/copilot-cloud-config.mjs +0 -2
  543. package/dist/types/copilot-cloud-config.mjs.map +0 -1
  544. package/dist/types/error.d.ts +0 -55
  545. package/dist/types/error.js +0 -19
  546. package/dist/types/error.js.map +0 -1
  547. package/dist/types/error.mjs +0 -2
  548. package/dist/types/error.mjs.map +0 -1
  549. package/dist/types/index.d.ts +0 -7
  550. package/dist/types/index.js +0 -19
  551. package/dist/types/index.js.map +0 -1
  552. package/dist/types/index.mjs +0 -8
  553. package/dist/types/index.mjs.map +0 -1
  554. package/dist/types/message.d.ts +0 -26
  555. package/dist/types/message.js +0 -19
  556. package/dist/types/message.js.map +0 -1
  557. package/dist/types/message.mjs +0 -2
  558. package/dist/types/message.mjs.map +0 -1
  559. package/dist/types/openai-assistant.d.ts +0 -53
  560. package/dist/types/openai-assistant.js +0 -19
  561. package/dist/types/openai-assistant.js.map +0 -1
  562. package/dist/types/openai-assistant.mjs +0 -2
  563. package/dist/types/openai-assistant.mjs.map +0 -1
  564. package/dist/types/utility.d.ts +0 -6
  565. package/dist/types/utility.js +0 -19
  566. package/dist/types/utility.js.map +0 -1
  567. package/dist/types/utility.mjs +0 -2
  568. package/dist/types/utility.mjs.map +0 -1
  569. package/dist/utils/conditions.js +0 -74
  570. package/dist/utils/conditions.js.map +0 -1
  571. package/dist/utils/console-styling.d.ts +0 -84
  572. package/dist/utils/console-styling.js +0 -123
  573. package/dist/utils/console-styling.js.map +0 -1
  574. package/dist/utils/errors.js +0 -443
  575. package/dist/utils/errors.js.map +0 -1
  576. package/dist/utils/index.d.ts +0 -32
  577. package/dist/utils/index.js +0 -927
  578. package/dist/utils/index.js.map +0 -1
  579. package/dist/utils/json-schema.js +0 -228
  580. package/dist/utils/json-schema.js.map +0 -1
  581. package/dist/utils/random-id.js +0 -68
  582. package/dist/utils/random-id.js.map +0 -1
  583. package/dist/utils/requests.js +0 -91
  584. package/dist/utils/requests.js.map +0 -1
  585. package/dist/utils/types.d.ts +0 -20
  586. package/dist/utils/types.js +0 -19
  587. package/dist/utils/types.js.map +0 -1
  588. package/jest.config.js +0 -5
  589. package/src/telemetry/scarf-client.ts +0 -39
  590. package/src/telemetry/security-check.ts +0 -0
  591. package/src/utils/json-schema.test.ts +0 -383
  592. package/tsup.config.ts +0 -11
@@ -0,0 +1,284 @@
1
+ import type {
2
+ BaseEvent,
3
+ RunErrorEvent,
4
+ ToolCallResultEvent,
5
+ } from "@ag-ui/client";
6
+ import { EventType } from "@ag-ui/client";
7
+ import { describe, expect, it } from "vitest";
8
+
9
+ import { createRunEventFinalizer, finalizeRunEvents } from "./finalize-events";
10
+
11
+ const event = (value: Record<string, unknown>): BaseEvent => value as BaseEvent;
12
+
13
+ describe("createRunEventFinalizer", () => {
14
+ it("closes what is still open and adds a terminal event", () => {
15
+ const source = [
16
+ event({ type: EventType.TEXT_MESSAGE_START, messageId: "message-1" }),
17
+ event({ type: EventType.TOOL_CALL_START, toolCallId: "tool-1" }),
18
+ event({ type: EventType.TOOL_CALL_END, toolCallId: "tool-1" }),
19
+ ];
20
+
21
+ for (const options of [{ stopRequested: true }, {}]) {
22
+ const finalizer = createRunEventFinalizer();
23
+ for (const value of source) finalizer.observe(value);
24
+ const appended = finalizer.finalize(options);
25
+
26
+ expect(appended.map(({ type }) => type)).toEqual([
27
+ EventType.TEXT_MESSAGE_END,
28
+ EventType.TOOL_CALL_RESULT,
29
+ options.stopRequested ? EventType.RUN_FINISHED : EventType.RUN_ERROR,
30
+ ]);
31
+ const result = appended[1] as ToolCallResultEvent;
32
+ expect(JSON.parse(result.content)).toMatchObject({
33
+ status: options.stopRequested ? "stopped" : "error",
34
+ reason: options.stopRequested
35
+ ? "stop_requested"
36
+ : "missing_terminal_event",
37
+ });
38
+ expect(finalizer.finalize(options)).toEqual([]);
39
+ }
40
+ });
41
+
42
+ it.each([EventType.RUN_FINISHED, EventType.RUN_ERROR])(
43
+ "appends nothing once %s was observed",
44
+ (terminal) => {
45
+ const finalizer = createRunEventFinalizer();
46
+ finalizer.observe(
47
+ event({ type: EventType.TEXT_MESSAGE_START, messageId: "message-1" }),
48
+ );
49
+ finalizer.observe(
50
+ event({ type: terminal, message: "finished upstream" }),
51
+ );
52
+ finalizer.observe(
53
+ event({ type: EventType.TEXT_MESSAGE_START, messageId: "message-2" }),
54
+ );
55
+
56
+ expect(finalizer.finalize()).toEqual([]);
57
+ },
58
+ );
59
+
60
+ it("closes open reasoning, message before span, because AG-UI 1.0 requires it", () => {
61
+ const finalizer = createRunEventFinalizer();
62
+ for (const value of [
63
+ event({ type: EventType.REASONING_START, messageId: "span-1" }),
64
+ event({ type: EventType.REASONING_MESSAGE_START, messageId: "r-1" }),
65
+ event({ type: EventType.REASONING_START, messageId: "span-2" }),
66
+ event({ type: EventType.REASONING_END, messageId: "span-2" }),
67
+ ]) {
68
+ finalizer.observe(value);
69
+ }
70
+
71
+ expect(finalizer.finalize({ stopRequested: true }).slice(0, 2)).toEqual([
72
+ { type: EventType.REASONING_MESSAGE_END, messageId: "r-1" },
73
+ { type: EventType.REASONING_END, messageId: "span-1" },
74
+ ]);
75
+ });
76
+
77
+ it("stamps the run identity on a stop and marks it cancelled for a 1.0 client", () => {
78
+ const started = event({
79
+ type: EventType.RUN_STARTED,
80
+ threadId: "thread-1",
81
+ runId: "run-1",
82
+ });
83
+ const stopFor = (protocolVersion?: string) => {
84
+ const finalizer = createRunEventFinalizer();
85
+ finalizer.observe(started);
86
+ return finalizer.finalize({ stopRequested: true, protocolVersion });
87
+ };
88
+
89
+ expect(stopFor("1.0")).toEqual([
90
+ {
91
+ type: EventType.RUN_FINISHED,
92
+ threadId: "thread-1",
93
+ runId: "run-1",
94
+ outcome: { type: "cancelled" },
95
+ },
96
+ ]);
97
+ // A client without a declared version predates 1.0 and cannot parse it.
98
+ expect(stopFor(undefined)).toEqual([
99
+ { type: EventType.RUN_FINISHED, threadId: "thread-1", runId: "run-1" },
100
+ ]);
101
+ });
102
+
103
+ it("forgets a lifecycle as soon as it closes", () => {
104
+ const finalizer = createRunEventFinalizer();
105
+ for (let index = 0; index < 1000; index += 1) {
106
+ const messageId = `message-${index}`;
107
+ const toolCallId = `tool-${index}`;
108
+ for (const value of [
109
+ event({ type: EventType.TEXT_MESSAGE_START, messageId }),
110
+ event({ type: EventType.TEXT_MESSAGE_CONTENT, messageId, delta: "x" }),
111
+ event({ type: EventType.TEXT_MESSAGE_END, messageId }),
112
+ event({ type: EventType.TOOL_CALL_START, toolCallId }),
113
+ event({ type: EventType.TOOL_CALL_RESULT, toolCallId, content: "x" }),
114
+ event({ type: EventType.TOOL_CALL_END, toolCallId }),
115
+ ]) {
116
+ finalizer.observe(value);
117
+ }
118
+ }
119
+ finalizer.observe(
120
+ event({ type: EventType.TEXT_MESSAGE_START, messageId: "open" }),
121
+ );
122
+
123
+ expect(finalizer.finalize()).toEqual([
124
+ { type: EventType.TEXT_MESSAGE_END, messageId: "open" },
125
+ expect.objectContaining({ type: EventType.RUN_ERROR }),
126
+ ]);
127
+ });
128
+
129
+ it.each([
130
+ [EventType.TOOL_CALL_END, EventType.TOOL_CALL_RESULT],
131
+ [EventType.TOOL_CALL_RESULT, EventType.TOOL_CALL_END],
132
+ ])("preserves %s across a repeated start before %s", (first, last) => {
133
+ const finalizer = createRunEventFinalizer();
134
+ for (const type of [
135
+ EventType.TOOL_CALL_START,
136
+ first,
137
+ EventType.TOOL_CALL_START,
138
+ last,
139
+ ]) {
140
+ finalizer.observe(event({ type, toolCallId: "tool-1" }));
141
+ }
142
+
143
+ expect(finalizer.finalize().map(({ type }) => type)).toEqual([
144
+ EventType.RUN_ERROR,
145
+ ]);
146
+ });
147
+
148
+ it("closes open subagents on a stop, children first, after their messages and before the terminal", () => {
149
+ const finalizer = createRunEventFinalizer();
150
+ for (const value of [
151
+ event({
152
+ type: EventType.SUBAGENT_STARTED,
153
+ subagentRunId: "parent",
154
+ name: "researcher",
155
+ }),
156
+ event({
157
+ type: EventType.SUBAGENT_STARTED,
158
+ subagentRunId: "child",
159
+ name: "searcher",
160
+ parentSubagentRunId: "parent",
161
+ }),
162
+ event({
163
+ type: EventType.TEXT_MESSAGE_START,
164
+ messageId: "message-1",
165
+ subagentRunId: "child",
166
+ }),
167
+ ]) {
168
+ finalizer.observe(value);
169
+ }
170
+
171
+ expect(
172
+ finalizer.finalize({
173
+ stopRequested: true,
174
+ interruptionMessage: "Stopped from the toolbar",
175
+ }),
176
+ ).toEqual([
177
+ { type: EventType.TEXT_MESSAGE_END, messageId: "message-1" },
178
+ {
179
+ type: EventType.SUBAGENT_ERROR,
180
+ subagentRunId: "child",
181
+ message: "Stopped from the toolbar",
182
+ code: "CANCELLED",
183
+ },
184
+ {
185
+ type: EventType.SUBAGENT_ERROR,
186
+ subagentRunId: "parent",
187
+ message: "Stopped from the toolbar",
188
+ code: "CANCELLED",
189
+ },
190
+ { type: EventType.RUN_FINISHED },
191
+ ]);
192
+ });
193
+
194
+ it.each([EventType.SUBAGENT_FINISHED, EventType.SUBAGENT_ERROR])(
195
+ "does not close a subagent again after %s",
196
+ (closer) => {
197
+ const finalizer = createRunEventFinalizer();
198
+ finalizer.observe(
199
+ event({
200
+ type: EventType.SUBAGENT_STARTED,
201
+ subagentRunId: "done",
202
+ name: "writer",
203
+ }),
204
+ );
205
+ finalizer.observe(
206
+ event({ type: closer, subagentRunId: "done", message: "boom" }),
207
+ );
208
+ finalizer.observe(
209
+ event({
210
+ type: EventType.SUBAGENT_STARTED,
211
+ subagentRunId: "open",
212
+ name: "critic",
213
+ }),
214
+ );
215
+
216
+ expect(finalizer.finalize({ stopRequested: true })).toEqual([
217
+ {
218
+ type: EventType.SUBAGENT_ERROR,
219
+ subagentRunId: "open",
220
+ message: "Run stopped by user",
221
+ code: "CANCELLED",
222
+ },
223
+ { type: EventType.RUN_FINISHED },
224
+ ]);
225
+ },
226
+ );
227
+
228
+ it("leaves open subagents unclosed when the stream ends abruptly, because RUN_ERROR abandons them", () => {
229
+ const finalizer = createRunEventFinalizer();
230
+ finalizer.observe(
231
+ event({
232
+ type: EventType.SUBAGENT_STARTED,
233
+ subagentRunId: "open",
234
+ name: "critic",
235
+ }),
236
+ );
237
+
238
+ expect(finalizer.finalize().map(({ type }) => type)).toEqual([
239
+ EventType.RUN_ERROR,
240
+ ]);
241
+ });
242
+
243
+ it("ignores start events without an id so finalize never emits an empty id", () => {
244
+ const finalizer = createRunEventFinalizer();
245
+ finalizer.observe(
246
+ event({ type: EventType.TEXT_MESSAGE_START, messageId: "" }),
247
+ );
248
+ finalizer.observe(
249
+ event({ type: EventType.TOOL_CALL_START, toolCallId: "" }),
250
+ );
251
+ finalizer.observe(event({ type: EventType.TOOL_CALL_START }));
252
+
253
+ expect(finalizer.finalize().map((e) => e.type)).toEqual([
254
+ EventType.RUN_ERROR,
255
+ ]);
256
+ });
257
+ });
258
+
259
+ describe("finalizeRunEvents", () => {
260
+ it("appends the closers in place and keeps the interruption message", () => {
261
+ const events = [
262
+ event({ type: EventType.TOOL_CALL_START, toolCallId: "tool-1" }),
263
+ event({
264
+ type: EventType.TOOL_CALL_RESULT,
265
+ toolCallId: "tool-1",
266
+ messageId: "result-1",
267
+ role: "tool",
268
+ content: "done",
269
+ }),
270
+ ];
271
+ const appended = finalizeRunEvents(events, {
272
+ interruptionMessage: "Gateway connection failed",
273
+ });
274
+
275
+ expect(appended.map(({ type }) => type)).toEqual([
276
+ EventType.TOOL_CALL_END,
277
+ EventType.RUN_ERROR,
278
+ ]);
279
+ expect((appended[1] as RunErrorEvent).message).toBe(
280
+ "Gateway connection failed",
281
+ );
282
+ expect(events.slice(-2)).toEqual(appended);
283
+ });
284
+ });
@@ -0,0 +1,260 @@
1
+ import type { BaseEvent, RunErrorEvent } from "@ag-ui/client";
2
+ import { EventType } from "@ag-ui/client";
3
+
4
+ export interface FinalizeRunOptions {
5
+ stopRequested?: boolean;
6
+ interruptionMessage?: string;
7
+ /**
8
+ * The `protocolVersion` the client declared on its RunAgentInput. When it is
9
+ * set, a stopped run finishes with the AG-UI 1.0 `cancelled` outcome. A
10
+ * client that declares no version predates 1.0 and cannot parse that
11
+ * outcome, so it gets the plain RUN_FINISHED it always got.
12
+ */
13
+ protocolVersion?: string;
14
+ }
15
+
16
+ export interface RunEventFinalizer {
17
+ /** Observe one streamed event. Only the ids of open lifecycles are kept. */
18
+ observe(event: BaseEvent): void;
19
+ /** Return the events that close an interrupted or abruptly ended stream. */
20
+ finalize(options?: FinalizeRunOptions): BaseEvent[];
21
+ }
22
+
23
+ const defaultStopMessage = "Run stopped by user";
24
+ const defaultAbruptEndMessage = "Run ended without emitting a terminal event";
25
+
26
+ interface OpenToolCall {
27
+ hasEnd: boolean;
28
+ hasResult: boolean;
29
+ }
30
+
31
+ /**
32
+ * Incremental finalizer for a streamed AG-UI run. Feed every event to
33
+ * `observe`; when the stream ends without a terminal event, `finalize` returns
34
+ * the closers for reasoning, text messages and tool calls still open plus a
35
+ * terminal event. AG-UI 1.0 fails a run that ends with reasoning still open,
36
+ * so reasoning is closed too. It also fails a RUN_FINISHED while a subagent
37
+ * is still open, so a stop closes open subagents as well; a RUN_ERROR
38
+ * abandons them, which the protocol allows. Closed lifecycles are forgotten at once and payloads are never kept,
39
+ * so a caller does not have to retain the event array for this purpose.
40
+ */
41
+ export function createRunEventFinalizer(): RunEventFinalizer {
42
+ const openMessageIds = new Set<string>();
43
+ const openReasoningMessageIds = new Set<string>();
44
+ const openReasoningSpanIds = new Set<string>();
45
+ const openToolCalls = new Map<string, OpenToolCall>();
46
+ // Insertion order is start order, so closing in reverse closes children first.
47
+ const openSubagentRunIds = new Set<string>();
48
+ let runIdentity: { threadId?: string; runId?: string } = {};
49
+ let terminalEventObserved = false;
50
+
51
+ const clearOpen = () => {
52
+ openMessageIds.clear();
53
+ openReasoningMessageIds.clear();
54
+ openReasoningSpanIds.clear();
55
+ openToolCalls.clear();
56
+ openSubagentRunIds.clear();
57
+ };
58
+
59
+ const observe = (event: BaseEvent) => {
60
+ if (terminalEventObserved) return;
61
+
62
+ switch (event.type) {
63
+ case EventType.RUN_STARTED: {
64
+ const { threadId, runId } = event as {
65
+ threadId?: string;
66
+ runId?: string;
67
+ };
68
+ runIdentity = { threadId, runId };
69
+ break;
70
+ }
71
+ case EventType.REASONING_START:
72
+ case EventType.REASONING_END:
73
+ case EventType.REASONING_MESSAGE_START:
74
+ case EventType.REASONING_MESSAGE_END: {
75
+ const messageId = (event as { messageId?: string }).messageId;
76
+ if (typeof messageId !== "string") break;
77
+ const open =
78
+ event.type === EventType.REASONING_START ||
79
+ event.type === EventType.REASONING_END
80
+ ? openReasoningSpanIds
81
+ : openReasoningMessageIds;
82
+ if (
83
+ event.type === EventType.REASONING_START ||
84
+ event.type === EventType.REASONING_MESSAGE_START
85
+ ) {
86
+ open.add(messageId);
87
+ } else {
88
+ open.delete(messageId);
89
+ }
90
+ break;
91
+ }
92
+ case EventType.TEXT_MESSAGE_START: {
93
+ const messageId = (event as { messageId?: string }).messageId;
94
+ if (messageId) openMessageIds.add(messageId);
95
+ break;
96
+ }
97
+ case EventType.TEXT_MESSAGE_END: {
98
+ const messageId = (event as { messageId?: string }).messageId;
99
+ if (typeof messageId === "string") openMessageIds.delete(messageId);
100
+ break;
101
+ }
102
+ case EventType.TOOL_CALL_START: {
103
+ const toolCallId = (event as { toolCallId?: string }).toolCallId;
104
+ if (toolCallId && !openToolCalls.has(toolCallId)) {
105
+ openToolCalls.set(toolCallId, { hasEnd: false, hasResult: false });
106
+ }
107
+ break;
108
+ }
109
+ case EventType.TOOL_CALL_END:
110
+ case EventType.TOOL_CALL_RESULT: {
111
+ const toolCallId = (event as { toolCallId?: string }).toolCallId;
112
+ if (!toolCallId) break;
113
+ const info = openToolCalls.get(toolCallId);
114
+ if (!info) break;
115
+
116
+ if (event.type === EventType.TOOL_CALL_END) info.hasEnd = true;
117
+ else info.hasResult = true;
118
+ if (info.hasEnd && info.hasResult) openToolCalls.delete(toolCallId);
119
+ break;
120
+ }
121
+ case EventType.SUBAGENT_STARTED:
122
+ case EventType.SUBAGENT_FINISHED:
123
+ case EventType.SUBAGENT_ERROR: {
124
+ const subagentRunId = (event as { subagentRunId?: string })
125
+ .subagentRunId;
126
+ if (!subagentRunId) break;
127
+ if (event.type === EventType.SUBAGENT_STARTED) {
128
+ openSubagentRunIds.add(subagentRunId);
129
+ } else {
130
+ openSubagentRunIds.delete(subagentRunId);
131
+ }
132
+ break;
133
+ }
134
+ case EventType.RUN_FINISHED:
135
+ case EventType.RUN_ERROR:
136
+ terminalEventObserved = true;
137
+ clearOpen();
138
+ break;
139
+ default:
140
+ break;
141
+ }
142
+ };
143
+
144
+ const finalize = (options: FinalizeRunOptions = {}): BaseEvent[] => {
145
+ if (terminalEventObserved) return [];
146
+
147
+ const { stopRequested = false, interruptionMessage } = options;
148
+ const resolvedStopMessage = interruptionMessage ?? defaultStopMessage;
149
+ const resolvedAbruptMessage =
150
+ interruptionMessage && interruptionMessage !== defaultStopMessage
151
+ ? interruptionMessage
152
+ : defaultAbruptEndMessage;
153
+ const appended: BaseEvent[] = [];
154
+
155
+ // A reasoning message closes before the span that holds it.
156
+ for (const messageId of openReasoningMessageIds) {
157
+ appended.push({
158
+ type: EventType.REASONING_MESSAGE_END,
159
+ messageId,
160
+ } as BaseEvent);
161
+ }
162
+ for (const messageId of openReasoningSpanIds) {
163
+ appended.push({ type: EventType.REASONING_END, messageId } as BaseEvent);
164
+ }
165
+
166
+ for (const messageId of openMessageIds) {
167
+ appended.push({
168
+ type: EventType.TEXT_MESSAGE_END,
169
+ messageId,
170
+ } as BaseEvent);
171
+ }
172
+
173
+ for (const [toolCallId, info] of openToolCalls) {
174
+ if (!info.hasEnd) {
175
+ appended.push({
176
+ type: EventType.TOOL_CALL_END,
177
+ toolCallId,
178
+ } as BaseEvent);
179
+ }
180
+
181
+ if (!info.hasResult) {
182
+ appended.push({
183
+ type: EventType.TOOL_CALL_RESULT,
184
+ toolCallId,
185
+ messageId: `${toolCallId}-result`,
186
+ role: "tool",
187
+ content: JSON.stringify(
188
+ stopRequested
189
+ ? {
190
+ status: "stopped",
191
+ reason: "stop_requested",
192
+ message: resolvedStopMessage,
193
+ }
194
+ : {
195
+ status: "error",
196
+ reason: "missing_terminal_event",
197
+ message: resolvedAbruptMessage,
198
+ },
199
+ ),
200
+ } as BaseEvent);
201
+ }
202
+ }
203
+
204
+ if (stopRequested) {
205
+ // Newest first, so a nested subagent closes before its parent. An index
206
+ // loop, because `toReversed` is ES2023 and this package targets older.
207
+ const openIds = [...openSubagentRunIds];
208
+ for (let index = openIds.length - 1; index >= 0; index -= 1) {
209
+ appended.push({
210
+ type: EventType.SUBAGENT_ERROR,
211
+ subagentRunId: openIds[index],
212
+ message: resolvedStopMessage,
213
+ code: "CANCELLED",
214
+ } as BaseEvent);
215
+ }
216
+ appended.push({
217
+ type: EventType.RUN_FINISHED,
218
+ ...(runIdentity.threadId !== undefined
219
+ ? { threadId: runIdentity.threadId }
220
+ : {}),
221
+ ...(runIdentity.runId !== undefined
222
+ ? { runId: runIdentity.runId }
223
+ : {}),
224
+ ...(options.protocolVersion !== undefined
225
+ ? { outcome: { type: "cancelled" } }
226
+ : {}),
227
+ } as BaseEvent);
228
+ } else {
229
+ const errorEvent: RunErrorEvent = {
230
+ type: EventType.RUN_ERROR,
231
+ message: resolvedAbruptMessage,
232
+ code: "INCOMPLETE_STREAM",
233
+ };
234
+ appended.push(errorEvent);
235
+ }
236
+
237
+ terminalEventObserved = true;
238
+ clearOpen();
239
+ return appended;
240
+ };
241
+
242
+ return { observe, finalize };
243
+ }
244
+
245
+ /**
246
+ * Array form of {@link createRunEventFinalizer} for callers that already keep
247
+ * the run's events (runners persist them). Appends the closers to `events` in
248
+ * place and returns them.
249
+ */
250
+ export function finalizeRunEvents(
251
+ events: BaseEvent[],
252
+ options: FinalizeRunOptions = {},
253
+ ): BaseEvent[] {
254
+ const finalizer = createRunEventFinalizer();
255
+ for (const event of events) finalizer.observe(event);
256
+
257
+ const appended = finalizer.finalize(options);
258
+ events.push(...appended);
259
+ return appended;
260
+ }