@copilotkit/vue 1.57.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 (437) hide show
  1. package/AGENTS.md +50 -0
  2. package/CHANGELOG.md +13 -0
  3. package/PARITY.md +434 -0
  4. package/README.md +396 -0
  5. package/dist/components/copilot-provider/CopilotKit.vue.d.ts +20 -0
  6. package/dist/components/copilot-provider/CopilotKit.vue.d.ts.map +1 -0
  7. package/dist/components/copilot-provider/index.d.ts +3 -0
  8. package/dist/components/copilot-provider/index.d.ts.map +1 -0
  9. package/dist/components/copilot-provider/types.d.ts +22 -0
  10. package/dist/components/copilot-provider/types.d.ts.map +1 -0
  11. package/dist/hooks/index.d.ts +7 -0
  12. package/dist/hooks/index.d.ts.map +1 -0
  13. package/dist/hooks/use-copilot-action.d.ts +27 -0
  14. package/dist/hooks/use-copilot-action.d.ts.map +1 -0
  15. package/dist/hooks/use-copilot-readable.d.ts +20 -0
  16. package/dist/hooks/use-copilot-readable.d.ts.map +1 -0
  17. package/dist/hooks/use-frontend-tool.d.ts +21 -0
  18. package/dist/hooks/use-frontend-tool.d.ts.map +1 -0
  19. package/dist/index.cjs +2 -0
  20. package/dist/index.cjs.map +1 -0
  21. package/dist/index.d.cts +10 -0
  22. package/dist/index.d.mts +10 -0
  23. package/dist/index.d.ts +10 -0
  24. package/dist/index.d.ts.map +1 -0
  25. package/dist/index.mjs +252 -0
  26. package/dist/index.mjs.map +1 -0
  27. package/dist/styles.css +2 -0
  28. package/dist/use-render-activity-message-BRL1Rpl-.cjs +85 -0
  29. package/dist/use-render-activity-message-BRL1Rpl-.cjs.map +1 -0
  30. package/dist/use-render-activity-message-CqtxiFSs.js +8927 -0
  31. package/dist/use-render-activity-message-CqtxiFSs.js.map +1 -0
  32. package/dist/v2/components/A2UIMessageRenderer.d.ts +9 -0
  33. package/dist/v2/components/A2UIMessageRenderer.d.ts.map +1 -0
  34. package/dist/v2/components/A2UISurfaceActivityRenderer.vue.d.ts +16 -0
  35. package/dist/v2/components/A2UISurfaceActivityRenderer.vue.d.ts.map +1 -0
  36. package/dist/v2/components/CopilotKitInspector.vue.d.ts +7 -0
  37. package/dist/v2/components/CopilotKitInspector.vue.d.ts.map +1 -0
  38. package/dist/v2/components/InlineFeatureWarning.vue.d.ts +6 -0
  39. package/dist/v2/components/InlineFeatureWarning.vue.d.ts.map +1 -0
  40. package/dist/v2/components/LicenseWarningBanner.vue.d.ts +18 -0
  41. package/dist/v2/components/LicenseWarningBanner.vue.d.ts.map +1 -0
  42. package/dist/v2/components/MCPAppsActivityRenderer.d.ts +88 -0
  43. package/dist/v2/components/MCPAppsActivityRenderer.d.ts.map +1 -0
  44. package/dist/v2/components/OpenGenerativeUIRenderer.d.ts +154 -0
  45. package/dist/v2/components/OpenGenerativeUIRenderer.d.ts.map +1 -0
  46. package/dist/v2/components/a2ui/A2UIBuiltInToolCallRenderer.d.ts +19 -0
  47. package/dist/v2/components/a2ui/A2UIBuiltInToolCallRenderer.d.ts.map +1 -0
  48. package/dist/v2/components/a2ui/A2UICatalogContext.d.ts +16 -0
  49. package/dist/v2/components/a2ui/A2UICatalogContext.d.ts.map +1 -0
  50. package/dist/v2/components/a2ui/VueSurface.d.ts +62 -0
  51. package/dist/v2/components/a2ui/VueSurface.d.ts.map +1 -0
  52. package/dist/v2/components/a2ui/adapter.d.ts +38 -0
  53. package/dist/v2/components/a2ui/adapter.d.ts.map +1 -0
  54. package/dist/v2/components/a2ui/catalog.d.ts +29 -0
  55. package/dist/v2/components/a2ui/catalog.d.ts.map +1 -0
  56. package/dist/v2/components/a2ui/index.d.ts +5 -0
  57. package/dist/v2/components/a2ui/index.d.ts.map +1 -0
  58. package/dist/v2/components/a2ui/utils.d.ts +18 -0
  59. package/dist/v2/components/a2ui/utils.d.ts.map +1 -0
  60. package/dist/v2/components/a2ui.d.ts +12 -0
  61. package/dist/v2/components/a2ui.d.ts.map +1 -0
  62. package/dist/v2/components/chat/CopilotChat.vue.d.ts +50 -0
  63. package/dist/v2/components/chat/CopilotChat.vue.d.ts.map +1 -0
  64. package/dist/v2/components/chat/CopilotChatAssistantMessage.vue.d.ts +164 -0
  65. package/dist/v2/components/chat/CopilotChatAssistantMessage.vue.d.ts.map +1 -0
  66. package/dist/v2/components/chat/CopilotChatAttachmentQueue.vue.d.ts +12 -0
  67. package/dist/v2/components/chat/CopilotChatAttachmentQueue.vue.d.ts.map +1 -0
  68. package/dist/v2/components/chat/CopilotChatAttachmentRenderer.vue.d.ts +7 -0
  69. package/dist/v2/components/chat/CopilotChatAttachmentRenderer.vue.d.ts.map +1 -0
  70. package/dist/v2/components/chat/CopilotChatAudioRecorder.vue.d.ts +12 -0
  71. package/dist/v2/components/chat/CopilotChatAudioRecorder.vue.d.ts.map +1 -0
  72. package/dist/v2/components/chat/CopilotChatInput.vue.d.ts +290 -0
  73. package/dist/v2/components/chat/CopilotChatInput.vue.d.ts.map +1 -0
  74. package/dist/v2/components/chat/CopilotChatMessageView.vue.d.ts +72 -0
  75. package/dist/v2/components/chat/CopilotChatMessageView.vue.d.ts.map +1 -0
  76. package/dist/v2/components/chat/CopilotChatReasoningMessage.vue.d.ts +65 -0
  77. package/dist/v2/components/chat/CopilotChatReasoningMessage.vue.d.ts.map +1 -0
  78. package/dist/v2/components/chat/CopilotChatSuggestionPill.vue.d.ts +27 -0
  79. package/dist/v2/components/chat/CopilotChatSuggestionPill.vue.d.ts.map +1 -0
  80. package/dist/v2/components/chat/CopilotChatSuggestionView.vue.d.ts +26 -0
  81. package/dist/v2/components/chat/CopilotChatSuggestionView.vue.d.ts.map +1 -0
  82. package/dist/v2/components/chat/CopilotChatToggleButton.vue.d.ts +17 -0
  83. package/dist/v2/components/chat/CopilotChatToggleButton.vue.d.ts.map +1 -0
  84. package/dist/v2/components/chat/CopilotChatToggleButtonCloseIcon.d.ts +5 -0
  85. package/dist/v2/components/chat/CopilotChatToggleButtonCloseIcon.d.ts.map +1 -0
  86. package/dist/v2/components/chat/CopilotChatToggleButtonOpenIcon.d.ts +5 -0
  87. package/dist/v2/components/chat/CopilotChatToggleButtonOpenIcon.d.ts.map +1 -0
  88. package/dist/v2/components/chat/CopilotChatToolCallsView.vue.d.ts +21 -0
  89. package/dist/v2/components/chat/CopilotChatToolCallsView.vue.d.ts.map +1 -0
  90. package/dist/v2/components/chat/CopilotChatUserMessage.vue.d.ts +34 -0
  91. package/dist/v2/components/chat/CopilotChatUserMessage.vue.d.ts.map +1 -0
  92. package/dist/v2/components/chat/CopilotChatView.vue.d.ts +106 -0
  93. package/dist/v2/components/chat/CopilotChatView.vue.d.ts.map +1 -0
  94. package/dist/v2/components/chat/CopilotModalHeader.vue.d.ts +15 -0
  95. package/dist/v2/components/chat/CopilotModalHeader.vue.d.ts.map +1 -0
  96. package/dist/v2/components/chat/CopilotModalHeaderCloseButton.d.ts +5 -0
  97. package/dist/v2/components/chat/CopilotModalHeaderCloseButton.d.ts.map +1 -0
  98. package/dist/v2/components/chat/CopilotModalHeaderTitle.d.ts +5 -0
  99. package/dist/v2/components/chat/CopilotModalHeaderTitle.d.ts.map +1 -0
  100. package/dist/v2/components/chat/CopilotPopup.vue.d.ts +50 -0
  101. package/dist/v2/components/chat/CopilotPopup.vue.d.ts.map +1 -0
  102. package/dist/v2/components/chat/CopilotPopupView.vue.d.ts +55 -0
  103. package/dist/v2/components/chat/CopilotPopupView.vue.d.ts.map +1 -0
  104. package/dist/v2/components/chat/CopilotPopupViewInternal.vue.d.ts +55 -0
  105. package/dist/v2/components/chat/CopilotPopupViewInternal.vue.d.ts.map +1 -0
  106. package/dist/v2/components/chat/CopilotPopupWelcomeScreen.vue.d.ts +28 -0
  107. package/dist/v2/components/chat/CopilotPopupWelcomeScreen.vue.d.ts.map +1 -0
  108. package/dist/v2/components/chat/CopilotSidebar.vue.d.ts +48 -0
  109. package/dist/v2/components/chat/CopilotSidebar.vue.d.ts.map +1 -0
  110. package/dist/v2/components/chat/CopilotSidebarView.vue.d.ts +62 -0
  111. package/dist/v2/components/chat/CopilotSidebarView.vue.d.ts.map +1 -0
  112. package/dist/v2/components/chat/CopilotSidebarViewInternal.vue.d.ts +53 -0
  113. package/dist/v2/components/chat/CopilotSidebarViewInternal.vue.d.ts.map +1 -0
  114. package/dist/v2/components/chat/CopilotSidebarWelcomeScreen.vue.d.ts +28 -0
  115. package/dist/v2/components/chat/CopilotSidebarWelcomeScreen.vue.d.ts.map +1 -0
  116. package/dist/v2/components/chat/audioRecorder.d.ts +11 -0
  117. package/dist/v2/components/chat/audioRecorder.d.ts.map +1 -0
  118. package/dist/v2/components/chat/index.d.ts +682 -0
  119. package/dist/v2/components/chat/index.d.ts.map +1 -0
  120. package/dist/v2/components/chat/last-user-message-context.d.ts +29 -0
  121. package/dist/v2/components/chat/last-user-message-context.d.ts.map +1 -0
  122. package/dist/v2/components/chat/normalize-auto-scroll.d.ts +3 -0
  123. package/dist/v2/components/chat/normalize-auto-scroll.d.ts.map +1 -0
  124. package/dist/v2/components/chat/types.d.ts +380 -0
  125. package/dist/v2/components/chat/types.d.ts.map +1 -0
  126. package/dist/v2/components/icons/index.d.ts +2 -0
  127. package/dist/v2/components/icons/index.d.ts.map +1 -0
  128. package/dist/v2/components/index.d.ts +8 -0
  129. package/dist/v2/components/index.d.ts.map +1 -0
  130. package/dist/v2/hooks/index.d.ts +24 -0
  131. package/dist/v2/hooks/index.d.ts.map +1 -0
  132. package/dist/v2/hooks/use-agent-context.d.ts +24 -0
  133. package/dist/v2/hooks/use-agent-context.d.ts.map +1 -0
  134. package/dist/v2/hooks/use-agent.d.ts +53 -0
  135. package/dist/v2/hooks/use-agent.d.ts.map +1 -0
  136. package/dist/v2/hooks/use-attachments.d.ts +21 -0
  137. package/dist/v2/hooks/use-attachments.d.ts.map +1 -0
  138. package/dist/v2/hooks/use-capabilities.d.ts +16 -0
  139. package/dist/v2/hooks/use-capabilities.d.ts.map +1 -0
  140. package/dist/v2/hooks/use-component.d.ts +13 -0
  141. package/dist/v2/hooks/use-component.d.ts.map +1 -0
  142. package/dist/v2/hooks/use-configure-suggestions.d.ts +24 -0
  143. package/dist/v2/hooks/use-configure-suggestions.d.ts.map +1 -0
  144. package/dist/v2/hooks/use-default-render-tool.d.ts +14 -0
  145. package/dist/v2/hooks/use-default-render-tool.d.ts.map +1 -0
  146. package/dist/v2/hooks/use-frontend-tool.d.ts +19 -0
  147. package/dist/v2/hooks/use-frontend-tool.d.ts.map +1 -0
  148. package/dist/v2/hooks/use-human-in-the-loop.d.ts +19 -0
  149. package/dist/v2/hooks/use-human-in-the-loop.d.ts.map +1 -0
  150. package/dist/v2/hooks/use-interrupt.d.ts +36 -0
  151. package/dist/v2/hooks/use-interrupt.d.ts.map +1 -0
  152. package/dist/v2/hooks/use-katex-styles.d.ts +22 -0
  153. package/dist/v2/hooks/use-katex-styles.d.ts.map +1 -0
  154. package/dist/v2/hooks/use-keyboard-height.d.ts +33 -0
  155. package/dist/v2/hooks/use-keyboard-height.d.ts.map +1 -0
  156. package/dist/v2/hooks/use-pin-to-send.d.ts +28 -0
  157. package/dist/v2/hooks/use-pin-to-send.d.ts.map +1 -0
  158. package/dist/v2/hooks/use-render-activity-message.d.ts +21 -0
  159. package/dist/v2/hooks/use-render-activity-message.d.ts.map +1 -0
  160. package/dist/v2/hooks/use-render-custom-messages.d.ts +27 -0
  161. package/dist/v2/hooks/use-render-custom-messages.d.ts.map +1 -0
  162. package/dist/v2/hooks/use-render-tool.d.ts +36 -0
  163. package/dist/v2/hooks/use-render-tool.d.ts.map +1 -0
  164. package/dist/v2/hooks/use-suggestions.d.ts +26 -0
  165. package/dist/v2/hooks/use-suggestions.d.ts.map +1 -0
  166. package/dist/v2/hooks/use-threads.d.ts +42 -0
  167. package/dist/v2/hooks/use-threads.d.ts.map +1 -0
  168. package/dist/v2/index.cjs +2 -0
  169. package/dist/v2/index.cjs.map +1 -0
  170. package/dist/v2/index.d.cts +9 -0
  171. package/dist/v2/index.d.mts +9 -0
  172. package/dist/v2/index.d.ts +9 -0
  173. package/dist/v2/index.d.ts.map +1 -0
  174. package/dist/v2/index.mjs +75 -0
  175. package/dist/v2/index.mjs.map +1 -0
  176. package/dist/v2/lib/processPartialHtml.d.ts +3 -0
  177. package/dist/v2/lib/processPartialHtml.d.ts.map +1 -0
  178. package/dist/v2/lib/shallow-stable.d.ts +7 -0
  179. package/dist/v2/lib/shallow-stable.d.ts.map +1 -0
  180. package/dist/v2/lib/transcription-client.d.ts +19 -0
  181. package/dist/v2/lib/transcription-client.d.ts.map +1 -0
  182. package/dist/v2/lib/vue-core.d.ts +47 -0
  183. package/dist/v2/lib/vue-core.d.ts.map +1 -0
  184. package/dist/v2/providers/CopilotChatConfigurationProvider.types.d.ts +15 -0
  185. package/dist/v2/providers/CopilotChatConfigurationProvider.types.d.ts.map +1 -0
  186. package/dist/v2/providers/CopilotChatConfigurationProvider.vue.d.ts +17 -0
  187. package/dist/v2/providers/CopilotChatConfigurationProvider.vue.d.ts.map +1 -0
  188. package/dist/v2/providers/CopilotKitProvider.types.d.ts +61 -0
  189. package/dist/v2/providers/CopilotKitProvider.types.d.ts.map +1 -0
  190. package/dist/v2/providers/CopilotKitProvider.vue.d.ts +37 -0
  191. package/dist/v2/providers/CopilotKitProvider.vue.d.ts.map +1 -0
  192. package/dist/v2/providers/SandboxFunctionsContext.d.ts +4 -0
  193. package/dist/v2/providers/SandboxFunctionsContext.d.ts.map +1 -0
  194. package/dist/v2/providers/index.d.ts +13 -0
  195. package/dist/v2/providers/index.d.ts.map +1 -0
  196. package/dist/v2/providers/keys.d.ts +17 -0
  197. package/dist/v2/providers/keys.d.ts.map +1 -0
  198. package/dist/v2/providers/license-context.d.ts +7 -0
  199. package/dist/v2/providers/license-context.d.ts.map +1 -0
  200. package/dist/v2/providers/types.d.ts +38 -0
  201. package/dist/v2/providers/types.d.ts.map +1 -0
  202. package/dist/v2/providers/useCopilotChatConfiguration.d.ts +4 -0
  203. package/dist/v2/providers/useCopilotChatConfiguration.d.ts.map +1 -0
  204. package/dist/v2/providers/useCopilotKit.d.ts +2 -0
  205. package/dist/v2/providers/useCopilotKit.d.ts.map +1 -0
  206. package/dist/v2/providers/useLicenseContext.d.ts +14 -0
  207. package/dist/v2/providers/useLicenseContext.d.ts.map +1 -0
  208. package/dist/v2/types/a2ui.d.ts +5 -0
  209. package/dist/v2/types/a2ui.d.ts.map +1 -0
  210. package/dist/v2/types/defineToolCallRenderer.d.ts +15 -0
  211. package/dist/v2/types/defineToolCallRenderer.d.ts.map +1 -0
  212. package/dist/v2/types/frontend-tool.d.ts +6 -0
  213. package/dist/v2/types/frontend-tool.d.ts.map +1 -0
  214. package/dist/v2/types/human-in-the-loop.d.ts +29 -0
  215. package/dist/v2/types/human-in-the-loop.d.ts.map +1 -0
  216. package/dist/v2/types/index.d.ts +10 -0
  217. package/dist/v2/types/index.d.ts.map +1 -0
  218. package/dist/v2/types/interrupt.d.ts +14 -0
  219. package/dist/v2/types/interrupt.d.ts.map +1 -0
  220. package/dist/v2/types/sandbox-function.d.ts +8 -0
  221. package/dist/v2/types/sandbox-function.d.ts.map +1 -0
  222. package/dist/v2/types/vue-activity-message-renderer.d.ts +18 -0
  223. package/dist/v2/types/vue-activity-message-renderer.d.ts.map +1 -0
  224. package/dist/v2/types/vue-custom-message-renderer.d.ts +19 -0
  225. package/dist/v2/types/vue-custom-message-renderer.d.ts.map +1 -0
  226. package/dist/v2/types/vue-tool-call-renderer.d.ts +37 -0
  227. package/dist/v2/types/vue-tool-call-renderer.d.ts.map +1 -0
  228. package/env.d.ts +7 -0
  229. package/eslint.config.mjs +42 -0
  230. package/package.json +130 -0
  231. package/scripts/scope-preflight.mjs +100 -0
  232. package/src/components/copilot-provider/CopilotKit.vue +18 -0
  233. package/src/components/copilot-provider/index.ts +2 -0
  234. package/src/components/copilot-provider/types.ts +24 -0
  235. package/src/hooks/index.ts +9 -0
  236. package/src/hooks/use-copilot-action.ts +168 -0
  237. package/src/hooks/use-copilot-readable.ts +75 -0
  238. package/src/hooks/use-frontend-tool.ts +76 -0
  239. package/src/index.ts +12 -0
  240. package/src/styles/globals.css +314 -0
  241. package/src/v2/__tests__/exports.test.ts +35 -0
  242. package/src/v2/__tests__/mocks/web-inspector.ts +5 -0
  243. package/src/v2/__tests__/setup.ts +141 -0
  244. package/src/v2/__tests__/utils/agents.ts +391 -0
  245. package/src/v2/__tests__/utils/mount.ts +83 -0
  246. package/src/v2/__tests__/utils/test-helpers.ts +712 -0
  247. package/src/v2/components/A2UIMessageRenderer.ts +125 -0
  248. package/src/v2/components/A2UISurfaceActivityRenderer.vue +186 -0
  249. package/src/v2/components/CopilotKitInspector.vue +42 -0
  250. package/src/v2/components/InlineFeatureWarning.vue +35 -0
  251. package/src/v2/components/LicenseWarningBanner.vue +196 -0
  252. package/src/v2/components/MCPAppsActivityRenderer.ts +778 -0
  253. package/src/v2/components/OpenGenerativeUIRenderer.ts +550 -0
  254. package/src/v2/components/__tests__/A2UIMessageRenderer.test.ts +271 -0
  255. package/src/v2/components/__tests__/CopilotKitInspector.test.ts +57 -0
  256. package/src/v2/components/__tests__/MCPAppsActivityRenderer.e2e.test.ts +851 -0
  257. package/src/v2/components/__tests__/MCPAppsActivityRenderer.test.ts +237 -0
  258. package/src/v2/components/__tests__/OpenGenerativeUIRenderer.test.ts +516 -0
  259. package/src/v2/components/a2ui/A2UIBuiltInToolCallRenderer.ts +295 -0
  260. package/src/v2/components/a2ui/A2UICatalogContext.ts +190 -0
  261. package/src/v2/components/a2ui/VueSurface.ts +144 -0
  262. package/src/v2/components/a2ui/adapter.ts +156 -0
  263. package/src/v2/components/a2ui/catalog.ts +858 -0
  264. package/src/v2/components/a2ui/index.ts +7 -0
  265. package/src/v2/components/a2ui/utils.ts +67 -0
  266. package/src/v2/components/a2ui.ts +30 -0
  267. package/src/v2/components/chat/CopilotChat.vue +777 -0
  268. package/src/v2/components/chat/CopilotChatAssistantMessage.vue +891 -0
  269. package/src/v2/components/chat/CopilotChatAttachmentQueue.vue +411 -0
  270. package/src/v2/components/chat/CopilotChatAttachmentRenderer.vue +87 -0
  271. package/src/v2/components/chat/CopilotChatAudioRecorder.vue +269 -0
  272. package/src/v2/components/chat/CopilotChatInput.vue +1271 -0
  273. package/src/v2/components/chat/CopilotChatMessageView.vue +476 -0
  274. package/src/v2/components/chat/CopilotChatReasoningMessage.vue +247 -0
  275. package/src/v2/components/chat/CopilotChatSuggestionPill.vue +56 -0
  276. package/src/v2/components/chat/CopilotChatSuggestionView.vue +93 -0
  277. package/src/v2/components/chat/CopilotChatToggleButton.vue +145 -0
  278. package/src/v2/components/chat/CopilotChatToggleButtonCloseIcon.ts +17 -0
  279. package/src/v2/components/chat/CopilotChatToggleButtonOpenIcon.ts +18 -0
  280. package/src/v2/components/chat/CopilotChatToolCallsView.vue +161 -0
  281. package/src/v2/components/chat/CopilotChatUserMessage.vue +322 -0
  282. package/src/v2/components/chat/CopilotChatView.vue +740 -0
  283. package/src/v2/components/chat/CopilotModalHeader.vue +73 -0
  284. package/src/v2/components/chat/CopilotModalHeaderCloseButton.ts +38 -0
  285. package/src/v2/components/chat/CopilotModalHeaderTitle.ts +22 -0
  286. package/src/v2/components/chat/CopilotPopup.vue +182 -0
  287. package/src/v2/components/chat/CopilotPopupView.vue +168 -0
  288. package/src/v2/components/chat/CopilotPopupViewInternal.vue +453 -0
  289. package/src/v2/components/chat/CopilotPopupWelcomeScreen.vue +140 -0
  290. package/src/v2/components/chat/CopilotSidebar.vue +178 -0
  291. package/src/v2/components/chat/CopilotSidebarView.vue +172 -0
  292. package/src/v2/components/chat/CopilotSidebarViewInternal.vue +366 -0
  293. package/src/v2/components/chat/CopilotSidebarWelcomeScreen.vue +142 -0
  294. package/src/v2/components/chat/__tests__/CopilotChat.attachments.test.ts +237 -0
  295. package/src/v2/components/chat/__tests__/CopilotChat.e2e.test.ts +1240 -0
  296. package/src/v2/components/chat/__tests__/CopilotChat.licenseWarning.test.ts +138 -0
  297. package/src/v2/components/chat/__tests__/CopilotChat.onError.test.ts +85 -0
  298. package/src/v2/components/chat/__tests__/CopilotChat.slots.e2e.test.ts +141 -0
  299. package/src/v2/components/chat/__tests__/CopilotChat.test.ts +652 -0
  300. package/src/v2/components/chat/__tests__/CopilotChatActivityRendering.e2e.test.ts +683 -0
  301. package/src/v2/components/chat/__tests__/CopilotChatAssistantMessage.slots.e2e.test.ts +768 -0
  302. package/src/v2/components/chat/__tests__/CopilotChatAssistantMessage.test.ts +1108 -0
  303. package/src/v2/components/chat/__tests__/CopilotChatAssistantMessage.thumbs.test.ts +87 -0
  304. package/src/v2/components/chat/__tests__/CopilotChatAttachmentQueue.test.ts +277 -0
  305. package/src/v2/components/chat/__tests__/CopilotChatAttachmentRenderer.test.ts +124 -0
  306. package/src/v2/components/chat/__tests__/CopilotChatCopyButton.clipboard.test.ts +230 -0
  307. package/src/v2/components/chat/__tests__/CopilotChatInput.bottomAnchored.test.ts +83 -0
  308. package/src/v2/components/chat/__tests__/CopilotChatInput.slots.e2e.test.ts +1139 -0
  309. package/src/v2/components/chat/__tests__/CopilotChatInput.test.ts +1051 -0
  310. package/src/v2/components/chat/__tests__/CopilotChatMessageView.slots.e2e.test.ts +141 -0
  311. package/src/v2/components/chat/__tests__/CopilotChatMessageView.test.ts +494 -0
  312. package/src/v2/components/chat/__tests__/CopilotChatPropsRerender.e2e.test.ts +181 -0
  313. package/src/v2/components/chat/__tests__/CopilotChatReasoningMessage.test.ts +73 -0
  314. package/src/v2/components/chat/__tests__/CopilotChatSuggestionPill.test.ts +73 -0
  315. package/src/v2/components/chat/__tests__/CopilotChatSuggestionView.slots.e2e.test.ts +674 -0
  316. package/src/v2/components/chat/__tests__/CopilotChatSuggestionView.test.ts +91 -0
  317. package/src/v2/components/chat/__tests__/CopilotChatToggleButton.test.ts +93 -0
  318. package/src/v2/components/chat/__tests__/CopilotChatToolCallsView.test.ts +382 -0
  319. package/src/v2/components/chat/__tests__/CopilotChatToolRendering.e2e.test.ts +1019 -0
  320. package/src/v2/components/chat/__tests__/CopilotChatToolRerenders.e2e.test.ts +516 -0
  321. package/src/v2/components/chat/__tests__/CopilotChatUserMessage.slots.e2e.test.ts +701 -0
  322. package/src/v2/components/chat/__tests__/CopilotChatUserMessage.test.ts +337 -0
  323. package/src/v2/components/chat/__tests__/CopilotChatView.connectingGate.test.ts +135 -0
  324. package/src/v2/components/chat/__tests__/CopilotChatView.inputOverlay.test.ts +278 -0
  325. package/src/v2/components/chat/__tests__/CopilotChatView.onClick.e2e.test.ts +1082 -0
  326. package/src/v2/components/chat/__tests__/CopilotChatView.pinToSend.test.ts +166 -0
  327. package/src/v2/components/chat/__tests__/CopilotChatView.slots.e2e.test.ts +1145 -0
  328. package/src/v2/components/chat/__tests__/CopilotChatView.test.ts +374 -0
  329. package/src/v2/components/chat/__tests__/CopilotModalHeader.slots.e2e.test.ts +636 -0
  330. package/src/v2/components/chat/__tests__/CopilotModalHeader.test.ts +112 -0
  331. package/src/v2/components/chat/__tests__/CopilotPopup.test.ts +58 -0
  332. package/src/v2/components/chat/__tests__/CopilotPopupView.slots.e2e.test.ts +725 -0
  333. package/src/v2/components/chat/__tests__/CopilotPopupView.test.ts +112 -0
  334. package/src/v2/components/chat/__tests__/CopilotSidebar.test.ts +58 -0
  335. package/src/v2/components/chat/__tests__/CopilotSidebarView.slots.e2e.test.ts +603 -0
  336. package/src/v2/components/chat/__tests__/CopilotSidebarView.test.ts +214 -0
  337. package/src/v2/components/chat/__tests__/MCPAppsUiMessage.e2e.test.ts +394 -0
  338. package/src/v2/components/chat/__tests__/copilot-chat-throttle.test.ts +82 -0
  339. package/src/v2/components/chat/__tests__/normalize-auto-scroll.test.ts +39 -0
  340. package/src/v2/components/chat/audioRecorder.ts +15 -0
  341. package/src/v2/components/chat/index.ts +52 -0
  342. package/src/v2/components/chat/last-user-message-context.ts +39 -0
  343. package/src/v2/components/chat/normalize-auto-scroll.ts +17 -0
  344. package/src/v2/components/chat/types.ts +481 -0
  345. package/src/v2/components/icons/__tests__/icons.test.ts +86 -0
  346. package/src/v2/components/icons/index.ts +22 -0
  347. package/src/v2/components/index.ts +7 -0
  348. package/src/v2/hooks/__tests__/standard-schema-types.test.ts +149 -0
  349. package/src/v2/hooks/__tests__/standard-schema.test.ts +315 -0
  350. package/src/v2/hooks/__tests__/use-agent-context-timing.e2e.test.ts +144 -0
  351. package/src/v2/hooks/__tests__/use-agent-context.test.ts +271 -0
  352. package/src/v2/hooks/__tests__/use-agent-error-state.test.ts +64 -0
  353. package/src/v2/hooks/__tests__/use-agent-stability.test.ts +268 -0
  354. package/src/v2/hooks/__tests__/use-agent-thread-isolation.test.ts +433 -0
  355. package/src/v2/hooks/__tests__/use-agent-throttle.test.ts +747 -0
  356. package/src/v2/hooks/__tests__/use-agent.e2e.test.ts +187 -0
  357. package/src/v2/hooks/__tests__/use-agent.test.ts +126 -0
  358. package/src/v2/hooks/__tests__/use-attachments.test.ts +181 -0
  359. package/src/v2/hooks/__tests__/use-component.test.ts +145 -0
  360. package/src/v2/hooks/__tests__/use-configure-suggestions.e2e.test.ts +527 -0
  361. package/src/v2/hooks/__tests__/use-configure-suggestions.test.ts +399 -0
  362. package/src/v2/hooks/__tests__/use-default-render-tool.test.ts +214 -0
  363. package/src/v2/hooks/__tests__/use-frontend-tool-available.test.ts +220 -0
  364. package/src/v2/hooks/__tests__/use-frontend-tool.e2e.test.ts +2320 -0
  365. package/src/v2/hooks/__tests__/use-frontend-tool.test.ts +648 -0
  366. package/src/v2/hooks/__tests__/use-human-in-the-loop.e2e.test.ts +1379 -0
  367. package/src/v2/hooks/__tests__/use-human-in-the-loop.test.ts +282 -0
  368. package/src/v2/hooks/__tests__/use-interrupt.test.ts +345 -0
  369. package/src/v2/hooks/__tests__/use-katex-styles.test.ts +69 -0
  370. package/src/v2/hooks/__tests__/use-keyboard-height.test.ts +199 -0
  371. package/src/v2/hooks/__tests__/use-pin-to-send.test.ts +363 -0
  372. package/src/v2/hooks/__tests__/use-render-tool.test.ts +329 -0
  373. package/src/v2/hooks/__tests__/use-suggestions.e2e.test.ts +397 -0
  374. package/src/v2/hooks/__tests__/use-suggestions.test.ts +198 -0
  375. package/src/v2/hooks/__tests__/use-threads.test.ts +1041 -0
  376. package/src/v2/hooks/__tests__/zod-regression.test.ts +339 -0
  377. package/src/v2/hooks/index.ts +29 -0
  378. package/src/v2/hooks/use-agent-context.ts +55 -0
  379. package/src/v2/hooks/use-agent.ts +345 -0
  380. package/src/v2/hooks/use-attachments.ts +261 -0
  381. package/src/v2/hooks/use-capabilities.ts +30 -0
  382. package/src/v2/hooks/use-component.ts +46 -0
  383. package/src/v2/hooks/use-configure-suggestions.ts +252 -0
  384. package/src/v2/hooks/use-default-render-tool.ts +130 -0
  385. package/src/v2/hooks/use-frontend-tool.ts +68 -0
  386. package/src/v2/hooks/use-human-in-the-loop.ts +90 -0
  387. package/src/v2/hooks/use-interrupt.ts +257 -0
  388. package/src/v2/hooks/use-katex-styles.ts +44 -0
  389. package/src/v2/hooks/use-keyboard-height.ts +87 -0
  390. package/src/v2/hooks/use-pin-to-send.ts +160 -0
  391. package/src/v2/hooks/use-render-activity-message.ts +92 -0
  392. package/src/v2/hooks/use-render-custom-messages.ts +129 -0
  393. package/src/v2/hooks/use-render-tool.ts +128 -0
  394. package/src/v2/hooks/use-suggestions.ts +98 -0
  395. package/src/v2/hooks/use-threads.ts +208 -0
  396. package/src/v2/index.ts +11 -0
  397. package/src/v2/lib/__tests__/processPartialHtml.test.ts +84 -0
  398. package/src/v2/lib/__tests__/transcription-client.test.ts +65 -0
  399. package/src/v2/lib/processPartialHtml.ts +21 -0
  400. package/src/v2/lib/shallow-stable.ts +54 -0
  401. package/src/v2/lib/transcription-client.ts +151 -0
  402. package/src/v2/lib/vue-core.ts +161 -0
  403. package/src/v2/providers/CopilotChatConfigurationProvider.types.ts +15 -0
  404. package/src/v2/providers/CopilotChatConfigurationProvider.vue +95 -0
  405. package/src/v2/providers/CopilotKitProvider.types.ts +66 -0
  406. package/src/v2/providers/CopilotKitProvider.vue +653 -0
  407. package/src/v2/providers/SandboxFunctionsContext.ts +11 -0
  408. package/src/v2/providers/__tests__/CopilotChatConfigurationProvider.test.ts +309 -0
  409. package/src/v2/providers/__tests__/CopilotKitProvider.debug.test.ts +295 -0
  410. package/src/v2/providers/__tests__/CopilotKitProvider.license.test.ts +110 -0
  411. package/src/v2/providers/__tests__/CopilotKitProvider.onError.test.ts +67 -0
  412. package/src/v2/providers/__tests__/CopilotKitProvider.renderCustomMessages.e2e.test.ts +901 -0
  413. package/src/v2/providers/__tests__/CopilotKitProvider.sandboxFunctions.test.ts +141 -0
  414. package/src/v2/providers/__tests__/CopilotKitProvider.stability.test.ts +871 -0
  415. package/src/v2/providers/__tests__/CopilotKitProvider.test.ts +603 -0
  416. package/src/v2/providers/__tests__/CopilotKitProvider.wildcard.test.ts +104 -0
  417. package/src/v2/providers/index.ts +21 -0
  418. package/src/v2/providers/keys.ts +25 -0
  419. package/src/v2/providers/license-context.ts +16 -0
  420. package/src/v2/providers/types.ts +40 -0
  421. package/src/v2/providers/useCopilotChatConfiguration.ts +11 -0
  422. package/src/v2/providers/useCopilotKit.ts +11 -0
  423. package/src/v2/providers/useLicenseContext.ts +21 -0
  424. package/src/v2/types/__tests__/defineToolCallRenderer.test.ts +157 -0
  425. package/src/v2/types/a2ui.ts +5 -0
  426. package/src/v2/types/defineToolCallRenderer.ts +32 -0
  427. package/src/v2/types/frontend-tool.ts +8 -0
  428. package/src/v2/types/human-in-the-loop.ts +38 -0
  429. package/src/v2/types/index.ts +9 -0
  430. package/src/v2/types/interrupt.ts +15 -0
  431. package/src/v2/types/sandbox-function.ts +8 -0
  432. package/src/v2/types/vue-activity-message-renderer.ts +22 -0
  433. package/src/v2/types/vue-custom-message-renderer.ts +24 -0
  434. package/src/v2/types/vue-tool-call-renderer.ts +44 -0
  435. package/tsconfig.json +27 -0
  436. package/vite.config.ts +49 -0
  437. package/vitest.config.ts +23 -0
@@ -0,0 +1,747 @@
1
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
2
+ import { defineComponent, h, nextTick, ref } from "vue";
3
+ import type { Ref } from "vue";
4
+ import type { AbstractAgent, Message, RunAgentInput } from "@ag-ui/client";
5
+ import { EventType } from "@ag-ui/client";
6
+ import type { RunErrorEvent } from "@ag-ui/client";
7
+ import { useAgent, UseAgentUpdate } from "../use-agent";
8
+ import { mountWithProvider } from "../../__tests__/utils/mount";
9
+
10
+ class NotifyingAgent implements Partial<AbstractAgent> {
11
+ agentId: string;
12
+ threadId?: string;
13
+ isRunning = false;
14
+ messages: Message[] = [];
15
+ state: Record<string, unknown> = {};
16
+ private readonly handlers = new Set<
17
+ Parameters<AbstractAgent["subscribe"]>[0]
18
+ >();
19
+
20
+ constructor(agentId: string) {
21
+ this.agentId = agentId;
22
+ }
23
+
24
+ get subscriberCount() {
25
+ return this.handlers.size;
26
+ }
27
+
28
+ clone() {
29
+ return this as AbstractAgent;
30
+ }
31
+
32
+ run(input: RunAgentInput): never {
33
+ void input;
34
+ throw new Error("NotifyingAgent.run() should not be called in this test");
35
+ }
36
+
37
+ subscribe(handler: Parameters<AbstractAgent["subscribe"]>[0]) {
38
+ this.handlers.add(handler);
39
+ return {
40
+ unsubscribe: () => {
41
+ this.handlers.delete(handler);
42
+ },
43
+ };
44
+ }
45
+
46
+ setMessages(messages: Message[]) {
47
+ this.messages = messages;
48
+ }
49
+
50
+ notifyMessagesChanged() {
51
+ for (const handler of this.handlers) {
52
+ handler.onMessagesChanged?.({
53
+ agent: this as AbstractAgent,
54
+ messages: this.messages,
55
+ state: this.state,
56
+ });
57
+ }
58
+ }
59
+
60
+ notifyStateChanged() {
61
+ for (const handler of this.handlers) {
62
+ handler.onStateChanged?.({
63
+ agent: this as AbstractAgent,
64
+ messages: this.messages,
65
+ state: this.state,
66
+ });
67
+ }
68
+ }
69
+
70
+ notifyRunInitialized() {
71
+ const input: RunAgentInput = {
72
+ threadId: "t-1",
73
+ runId: "r-1",
74
+ state: {},
75
+ messages: [],
76
+ tools: [],
77
+ context: [],
78
+ forwardedProps: {},
79
+ };
80
+ for (const handler of this.handlers) {
81
+ handler.onRunInitialized?.({
82
+ agent: this as AbstractAgent,
83
+ messages: this.messages,
84
+ state: this.state,
85
+ input,
86
+ });
87
+ }
88
+ }
89
+
90
+ notifyRunErrorEvent(
91
+ message = "run failed",
92
+ code: string | number | undefined = undefined,
93
+ ) {
94
+ const input: RunAgentInput = {
95
+ threadId: "t-1",
96
+ runId: "r-1",
97
+ state: {},
98
+ messages: [],
99
+ tools: [],
100
+ context: [],
101
+ forwardedProps: {},
102
+ };
103
+ const event: RunErrorEvent = {
104
+ type: EventType.RUN_ERROR,
105
+ message,
106
+ ...(code !== undefined ? { code } : {}),
107
+ } as RunErrorEvent;
108
+ for (const handler of this.handlers) {
109
+ handler.onRunErrorEvent?.({
110
+ agent: this as AbstractAgent,
111
+ messages: this.messages,
112
+ state: this.state,
113
+ input,
114
+ event,
115
+ });
116
+ }
117
+ }
118
+ }
119
+
120
+ function userMsg(id: string, content = `msg-${id}`): Message {
121
+ return { id, role: "user", content } as Message;
122
+ }
123
+
124
+ function assistantMsg(id: string, content = `msg-${id}`): Message {
125
+ return { id, role: "assistant", content } as Message;
126
+ }
127
+
128
+ function createMessages(count: number): Message[] {
129
+ return Array.from({ length: count }, (_, idx) =>
130
+ idx % 2 === 0
131
+ ? userMsg(String(idx + 1), `tok${idx + 1}`)
132
+ : assistantMsg(String(idx + 1), `tok${idx + 1}`),
133
+ );
134
+ }
135
+
136
+ async function flushVue() {
137
+ await Promise.resolve();
138
+ await nextTick();
139
+ }
140
+
141
+ function mountHookComponent(options: {
142
+ agent: NotifyingAgent;
143
+ updates?: UseAgentUpdate[];
144
+ throttleMs?: number | Ref<number | undefined>;
145
+ defaultThrottleMs?: number | undefined;
146
+ renderCount?: { current: number };
147
+ }) {
148
+ const {
149
+ agent,
150
+ updates = [UseAgentUpdate.OnMessagesChanged],
151
+ throttleMs,
152
+ defaultThrottleMs,
153
+ renderCount,
154
+ } = options;
155
+
156
+ const Child = defineComponent({
157
+ setup() {
158
+ const { agent: agentRef } = useAgent({
159
+ agentId: "test-agent",
160
+ updates,
161
+ throttleMs,
162
+ });
163
+ return () => {
164
+ if (renderCount) renderCount.current += 1;
165
+ return h("div", [
166
+ h("span", { "data-testid": "count" }, agentRef.value.messages.length),
167
+ h(
168
+ "span",
169
+ { "data-testid": "state" },
170
+ JSON.stringify(agentRef.value.state),
171
+ ),
172
+ ]);
173
+ };
174
+ },
175
+ });
176
+
177
+ return mountWithProvider(() => h(Child), {
178
+ agents__unsafe_dev_only: { "test-agent": agent as AbstractAgent },
179
+ defaultThrottleMs,
180
+ });
181
+ }
182
+
183
+ describe("useAgent throttleMs", () => {
184
+ let agent: NotifyingAgent;
185
+
186
+ beforeEach(() => {
187
+ vi.useFakeTimers();
188
+ vi.spyOn(console, "error").mockImplementation(() => {});
189
+ agent = new NotifyingAgent("test-agent");
190
+ });
191
+
192
+ afterEach(() => {
193
+ vi.useRealTimers();
194
+ vi.restoreAllMocks();
195
+ });
196
+
197
+ it("without throttleMs, component reflects latest messages after notification", async () => {
198
+ const { wrapper } = mountHookComponent({ agent });
199
+ expect(wrapper.find("[data-testid=count]").text()).toBe("0");
200
+ agent.setMessages([userMsg("1", "hello")]);
201
+ agent.notifyMessagesChanged();
202
+ await flushVue();
203
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
204
+ });
205
+
206
+ it("with throttleMs: 0 (explicit), behaves identically to omitting throttleMs", async () => {
207
+ const { wrapper } = mountHookComponent({ agent, throttleMs: 0 });
208
+ agent.setMessages([userMsg("1", "hello")]);
209
+ agent.notifyMessagesChanged();
210
+ await flushVue();
211
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
212
+ agent.setMessages([userMsg("1", "hello"), assistantMsg("2", "world")]);
213
+ agent.notifyMessagesChanged();
214
+ await flushVue();
215
+ expect(wrapper.find("[data-testid=count]").text()).toBe("2");
216
+ });
217
+
218
+ it("with throttleMs, first notification fires immediately (leading edge)", async () => {
219
+ const { wrapper } = mountHookComponent({ agent, throttleMs: 100 });
220
+ agent.setMessages([userMsg("1", "hello")]);
221
+ agent.notifyMessagesChanged();
222
+ await flushVue();
223
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
224
+ });
225
+
226
+ it("with throttleMs, second notification within window is deferred until trailing edge", async () => {
227
+ const { wrapper } = mountHookComponent({ agent, throttleMs: 100 });
228
+ agent.setMessages([userMsg("1", "a")]);
229
+ agent.notifyMessagesChanged();
230
+ await flushVue();
231
+ vi.advanceTimersByTime(10);
232
+ agent.setMessages([userMsg("1", "a"), assistantMsg("2", "b")]);
233
+ agent.notifyMessagesChanged();
234
+ await flushVue();
235
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
236
+ vi.advanceTimersByTime(100);
237
+ await flushVue();
238
+ expect(wrapper.find("[data-testid=count]").text()).toBe("2");
239
+ });
240
+
241
+ it("with throttleMs, rapid burst of many notifications results in exactly 2 renders (leading + trailing)", async () => {
242
+ const { wrapper } = mountHookComponent({ agent, throttleMs: 100 });
243
+ agent.setMessages([userMsg("1", "tok1")]);
244
+ agent.notifyMessagesChanged();
245
+ await flushVue();
246
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
247
+ for (let i = 2; i <= 11; i += 1) {
248
+ vi.advanceTimersByTime(1);
249
+ agent.setMessages(createMessages(i));
250
+ agent.notifyMessagesChanged();
251
+ await flushVue();
252
+ }
253
+ vi.advanceTimersByTime(100);
254
+ await flushVue();
255
+ expect(wrapper.find("[data-testid=count]").text()).toBe("11");
256
+ });
257
+
258
+ it("with throttleMs, new notification after trailing edge fires immediately (new cycle)", async () => {
259
+ const { wrapper } = mountHookComponent({ agent, throttleMs: 100 });
260
+ agent.setMessages([userMsg("1", "a")]);
261
+ agent.notifyMessagesChanged();
262
+ await flushVue();
263
+ vi.advanceTimersByTime(10);
264
+ agent.setMessages([userMsg("1", "a"), assistantMsg("2", "b")]);
265
+ agent.notifyMessagesChanged();
266
+ vi.advanceTimersByTime(100);
267
+ await flushVue();
268
+ expect(wrapper.find("[data-testid=count]").text()).toBe("2");
269
+ vi.advanceTimersByTime(200);
270
+ agent.setMessages([
271
+ userMsg("1", "a"),
272
+ assistantMsg("2", "b"),
273
+ userMsg("3", "c"),
274
+ ]);
275
+ agent.notifyMessagesChanged();
276
+ await flushVue();
277
+ expect(wrapper.find("[data-testid=count]").text()).toBe("3");
278
+ });
279
+
280
+ it("with throttleMs, onStateChanged is also throttled (shared window)", async () => {
281
+ // Parity with React: `subscribeToAgentWithOptions` now shares a single
282
+ // throttle window across `onMessagesChanged` and `onStateChanged`, so a
283
+ // state change fired inside the message throttle window is deferred to
284
+ // the trailing edge instead of rendering immediately.
285
+ const { wrapper } = mountHookComponent({
286
+ agent,
287
+ throttleMs: 100,
288
+ updates: [
289
+ UseAgentUpdate.OnMessagesChanged,
290
+ UseAgentUpdate.OnStateChanged,
291
+ ],
292
+ });
293
+
294
+ // Leading edge via messages.
295
+ agent.setMessages([userMsg("1", "a")]);
296
+ agent.notifyMessagesChanged();
297
+ await flushVue();
298
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
299
+
300
+ // State change inside the throttle window — should be deferred.
301
+ vi.advanceTimersByTime(10);
302
+ agent.state = { count: 42 };
303
+ agent.notifyStateChanged();
304
+ await flushVue();
305
+ expect(wrapper.find("[data-testid=state]").text()).toBe("{}");
306
+
307
+ // Trailing edge fires after the window expires.
308
+ vi.advanceTimersByTime(100);
309
+ await flushVue();
310
+ expect(wrapper.find("[data-testid=state]").text()).toBe('{"count":42}');
311
+ });
312
+
313
+ it("with throttleMs and only OnStateChanged subscribed, first state fires on leading edge", async () => {
314
+ const { wrapper } = mountHookComponent({
315
+ agent,
316
+ throttleMs: 100,
317
+ updates: [UseAgentUpdate.OnStateChanged],
318
+ });
319
+
320
+ // First onStateChanged fires immediately (leading edge).
321
+ agent.state = { value: "test" };
322
+ agent.notifyStateChanged();
323
+ await flushVue();
324
+ expect(wrapper.find("[data-testid=state]").text()).toBe('{"value":"test"}');
325
+
326
+ // No onMessagesChanged subscription exists — notification is a no-op.
327
+ agent.setMessages([userMsg("1", "a")]);
328
+ agent.notifyMessagesChanged();
329
+ await flushVue();
330
+ expect(wrapper.find("[data-testid=state]").text()).toBe('{"value":"test"}');
331
+ });
332
+
333
+ it("with throttleMs, onRunErrorEvent fires immediately (bypasses shared throttle window)", async () => {
334
+ // Run lifecycle callbacks — including `onRunErrorEvent` — always fire
335
+ // immediately in core's `subscribeToAgentWithOptions`, regardless of the
336
+ // active throttle window for messages/state.
337
+ const { wrapper } = mountHookComponent({
338
+ agent,
339
+ throttleMs: 100,
340
+ updates: [
341
+ UseAgentUpdate.OnMessagesChanged,
342
+ UseAgentUpdate.OnStateChanged,
343
+ UseAgentUpdate.OnRunStatusChanged,
344
+ ],
345
+ });
346
+
347
+ // Open the throttle window with a messages change.
348
+ agent.setMessages([userMsg("1", "a")]);
349
+ agent.notifyMessagesChanged();
350
+ await flushVue();
351
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
352
+
353
+ // Inside the window, a state change is deferred…
354
+ vi.advanceTimersByTime(10);
355
+ agent.state = { count: 1 };
356
+ agent.notifyStateChanged();
357
+ await flushVue();
358
+ expect(wrapper.find("[data-testid=state]").text()).toBe("{}");
359
+
360
+ // …but a RUN_ERROR event triggers an immediate re-render. We update
361
+ // state first so the next render proves the error path flushed.
362
+ agent.state = { count: 2 };
363
+ agent.notifyRunErrorEvent();
364
+ await flushVue();
365
+ expect(wrapper.find("[data-testid=state]").text()).toBe('{"count":2}');
366
+ });
367
+
368
+ it("with throttleMs, pending trailing timer does not fire after unmount", async () => {
369
+ const renderCount = { current: 0 };
370
+ const { wrapper } = mountHookComponent({
371
+ agent,
372
+ throttleMs: 100,
373
+ renderCount,
374
+ });
375
+ agent.setMessages([userMsg("1", "a")]);
376
+ agent.notifyMessagesChanged();
377
+ await flushVue();
378
+ vi.advanceTimersByTime(10);
379
+ agent.setMessages([userMsg("1", "a"), assistantMsg("2", "b")]);
380
+ agent.notifyMessagesChanged();
381
+ await flushVue();
382
+ const beforeUnmount = renderCount.current;
383
+ wrapper.unmount();
384
+ vi.advanceTimersByTime(100);
385
+ await flushVue();
386
+ expect(renderCount.current).toBe(beforeUnmount);
387
+ });
388
+
389
+ it("with throttleMs and updates excluding OnMessagesChanged, throttle is a no-op", async () => {
390
+ const { wrapper } = mountHookComponent({
391
+ agent,
392
+ throttleMs: 100,
393
+ updates: [UseAgentUpdate.OnStateChanged],
394
+ });
395
+ agent.state = { value: "test" };
396
+ agent.notifyStateChanged();
397
+ await flushVue();
398
+ expect(wrapper.find("[data-testid=state]").text()).toBe('{"value":"test"}');
399
+ agent.setMessages([userMsg("1", "a")]);
400
+ agent.notifyMessagesChanged();
401
+ await flushVue();
402
+ expect(wrapper.find("[data-testid=state]").text()).toBe('{"value":"test"}');
403
+ });
404
+
405
+ it.each([
406
+ { label: "NaN", value: Number.NaN },
407
+ { label: "Infinity", value: Number.POSITIVE_INFINITY },
408
+ { label: "-1", value: -1 },
409
+ { label: "-Infinity", value: Number.NEGATIVE_INFINITY },
410
+ ])(
411
+ "with invalid throttleMs ($label), falls back to unthrottled and warns",
412
+ async ({ value }) => {
413
+ const errorSpy = vi.spyOn(console, "error").mockImplementation(() => {});
414
+ const { wrapper } = mountHookComponent({ agent, throttleMs: value });
415
+ // Source of the warning is now core's `subscribeToAgentWithOptions`,
416
+ // which calls `console.error(message, error)` via `logAndEmitError`.
417
+ expect(errorSpy).toHaveBeenCalledWith(
418
+ expect.stringContaining(
419
+ "throttleMs must be a non-negative finite number",
420
+ ),
421
+ expect.any(Error),
422
+ );
423
+ agent.setMessages([userMsg("1", "a")]);
424
+ agent.notifyMessagesChanged();
425
+ await flushVue();
426
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
427
+ agent.setMessages([userMsg("1", "a"), assistantMsg("2", "b")]);
428
+ agent.notifyMessagesChanged();
429
+ await flushVue();
430
+ expect(wrapper.find("[data-testid=count]").text()).toBe("2");
431
+ },
432
+ );
433
+
434
+ it("trailing-edge render reflects the latest messages, not stale data", async () => {
435
+ const { wrapper } = mountHookComponent({ agent, throttleMs: 100 });
436
+ agent.setMessages([userMsg("1", "A")]);
437
+ agent.notifyMessagesChanged();
438
+ await flushVue();
439
+ vi.advanceTimersByTime(20);
440
+ agent.setMessages([userMsg("1", "A"), assistantMsg("2", "B")]);
441
+ agent.notifyMessagesChanged();
442
+ vi.advanceTimersByTime(20);
443
+ agent.setMessages([
444
+ userMsg("1", "A"),
445
+ assistantMsg("2", "B"),
446
+ assistantMsg("3", "C"),
447
+ ]);
448
+ agent.notifyMessagesChanged();
449
+ await flushVue();
450
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
451
+ vi.advanceTimersByTime(100);
452
+ await flushVue();
453
+ expect(wrapper.find("[data-testid=count]").text()).toBe("3");
454
+ });
455
+
456
+ it("trailing edge fires at exactly throttleMs after the leading edge", async () => {
457
+ const { wrapper } = mountHookComponent({ agent, throttleMs: 100 });
458
+ agent.setMessages([userMsg("1", "a")]);
459
+ agent.notifyMessagesChanged();
460
+ await flushVue();
461
+ vi.advanceTimersByTime(40);
462
+ agent.setMessages([userMsg("1", "a"), assistantMsg("2", "b")]);
463
+ agent.notifyMessagesChanged();
464
+ vi.advanceTimersByTime(59);
465
+ await flushVue();
466
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
467
+ vi.advanceTimersByTime(1);
468
+ await flushVue();
469
+ expect(wrapper.find("[data-testid=count]").text()).toBe("2");
470
+ });
471
+
472
+ it("changing throttleMs cleans up pending timers from the previous configuration", async () => {
473
+ const throttleRef = ref<number | undefined>(200);
474
+ const { wrapper } = mountHookComponent({ agent, throttleMs: throttleRef });
475
+ agent.setMessages([userMsg("1", "a")]);
476
+ agent.notifyMessagesChanged();
477
+ await flushVue();
478
+ vi.advanceTimersByTime(50);
479
+ agent.setMessages([userMsg("1", "a"), assistantMsg("2", "b")]);
480
+ agent.notifyMessagesChanged();
481
+ await flushVue();
482
+ throttleRef.value = 50;
483
+ await flushVue();
484
+ agent.setMessages([
485
+ userMsg("1", "a"),
486
+ assistantMsg("2", "b"),
487
+ userMsg("3", "c"),
488
+ ]);
489
+ agent.notifyMessagesChanged();
490
+ await flushVue();
491
+ expect(wrapper.find("[data-testid=count]").text()).toBe("3");
492
+ vi.advanceTimersByTime(200);
493
+ await flushVue();
494
+ expect(wrapper.find("[data-testid=count]").text()).toBe("3");
495
+ });
496
+
497
+ it("notification immediately after trailing edge is throttled (trailing restarts the window)", async () => {
498
+ const { wrapper } = mountHookComponent({ agent, throttleMs: 100 });
499
+ agent.setMessages([userMsg("1", "a")]);
500
+ agent.notifyMessagesChanged();
501
+ await flushVue();
502
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
503
+ vi.advanceTimersByTime(10);
504
+ agent.setMessages([userMsg("1", "a"), assistantMsg("2", "b")]);
505
+ agent.notifyMessagesChanged();
506
+ vi.advanceTimersByTime(90);
507
+ await flushVue();
508
+ expect(wrapper.find("[data-testid=count]").text()).toBe("2");
509
+ vi.advanceTimersByTime(1);
510
+ agent.setMessages([
511
+ userMsg("1", "a"),
512
+ assistantMsg("2", "b"),
513
+ userMsg("3", "c"),
514
+ ]);
515
+ agent.notifyMessagesChanged();
516
+ await flushVue();
517
+ vi.advanceTimersByTime(99);
518
+ await flushVue();
519
+ expect(wrapper.find("[data-testid=count]").text()).toBe("3");
520
+ });
521
+
522
+ it("cleans up all subscriptions after unmount", async () => {
523
+ const { wrapper } = mountHookComponent({
524
+ agent,
525
+ throttleMs: 100,
526
+ updates: [
527
+ UseAgentUpdate.OnMessagesChanged,
528
+ UseAgentUpdate.OnStateChanged,
529
+ ],
530
+ });
531
+ expect(agent.subscriberCount).toBeGreaterThan(0);
532
+ wrapper.unmount();
533
+ await flushVue();
534
+ const countAfterUnmount = agent.subscriberCount;
535
+ agent.setMessages([userMsg("1", "post-unmount")]);
536
+ agent.notifyMessagesChanged();
537
+ await flushVue();
538
+ expect(agent.subscriberCount).toBe(countAfterUnmount);
539
+ });
540
+
541
+ it("single notification within window does not trigger a trailing re-render", async () => {
542
+ const renderCount = { current: 0 };
543
+ mountHookComponent({ agent, throttleMs: 100, renderCount });
544
+ const afterMount = renderCount.current;
545
+ agent.setMessages([userMsg("1", "a")]);
546
+ agent.notifyMessagesChanged();
547
+ await flushVue();
548
+ expect(renderCount.current).toBe(afterMount + 1);
549
+ vi.advanceTimersByTime(200);
550
+ await flushVue();
551
+ expect(renderCount.current).toBe(afterMount + 1);
552
+ });
553
+
554
+ it("with throttleMs, onRunInitialized still fires immediately during throttle window", async () => {
555
+ const { wrapper } = mountHookComponent({
556
+ agent,
557
+ throttleMs: 100,
558
+ updates: [
559
+ UseAgentUpdate.OnMessagesChanged,
560
+ UseAgentUpdate.OnRunStatusChanged,
561
+ ],
562
+ });
563
+ agent.setMessages([userMsg("1", "a")]);
564
+ agent.notifyMessagesChanged();
565
+ await flushVue();
566
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
567
+ vi.advanceTimersByTime(10);
568
+ agent.notifyRunInitialized();
569
+ await flushVue();
570
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
571
+ });
572
+
573
+ it("changing throttleMs from positive to 0 disables throttling immediately", async () => {
574
+ const throttleRef = ref<number | undefined>(200);
575
+ const { wrapper } = mountHookComponent({ agent, throttleMs: throttleRef });
576
+ agent.setMessages([userMsg("1", "a")]);
577
+ agent.notifyMessagesChanged();
578
+ await flushVue();
579
+ vi.advanceTimersByTime(50);
580
+ agent.setMessages([userMsg("1", "a"), assistantMsg("2", "b")]);
581
+ agent.notifyMessagesChanged();
582
+ await flushVue();
583
+ throttleRef.value = 0;
584
+ await flushVue();
585
+ agent.setMessages([
586
+ userMsg("1", "a"),
587
+ assistantMsg("2", "b"),
588
+ userMsg("3", "c"),
589
+ ]);
590
+ agent.notifyMessagesChanged();
591
+ await flushVue();
592
+ expect(wrapper.find("[data-testid=count]").text()).toBe("3");
593
+ agent.setMessages([
594
+ userMsg("1", "a"),
595
+ assistantMsg("2", "b"),
596
+ userMsg("3", "c"),
597
+ assistantMsg("4", "d"),
598
+ ]);
599
+ agent.notifyMessagesChanged();
600
+ await flushVue();
601
+ expect(wrapper.find("[data-testid=count]").text()).toBe("4");
602
+ });
603
+ });
604
+
605
+ describe("useAgent defaultThrottleMs from provider", () => {
606
+ let agent: NotifyingAgent;
607
+
608
+ beforeEach(() => {
609
+ vi.useFakeTimers();
610
+ vi.spyOn(console, "error").mockImplementation(() => {});
611
+ agent = new NotifyingAgent("test-agent");
612
+ });
613
+
614
+ afterEach(() => {
615
+ vi.useRealTimers();
616
+ vi.restoreAllMocks();
617
+ });
618
+
619
+ it("uses provider defaultThrottleMs when no explicit throttleMs is passed", async () => {
620
+ const { wrapper } = mountHookComponent({ agent, defaultThrottleMs: 100 });
621
+ agent.setMessages([userMsg("1", "hello")]);
622
+ agent.notifyMessagesChanged();
623
+ await flushVue();
624
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
625
+ vi.advanceTimersByTime(10);
626
+ agent.setMessages([userMsg("1", "hello"), assistantMsg("2", "world")]);
627
+ agent.notifyMessagesChanged();
628
+ await flushVue();
629
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
630
+ vi.advanceTimersByTime(100);
631
+ await flushVue();
632
+ expect(wrapper.find("[data-testid=count]").text()).toBe("2");
633
+ });
634
+
635
+ it("explicit throttleMs overrides provider defaultThrottleMs", async () => {
636
+ const { wrapper } = mountHookComponent({
637
+ agent,
638
+ defaultThrottleMs: 5000,
639
+ throttleMs: 100,
640
+ });
641
+ agent.setMessages([userMsg("1", "hello")]);
642
+ agent.notifyMessagesChanged();
643
+ await flushVue();
644
+ vi.advanceTimersByTime(10);
645
+ agent.setMessages([userMsg("1", "hello"), assistantMsg("2", "world")]);
646
+ agent.notifyMessagesChanged();
647
+ await flushVue();
648
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
649
+ vi.advanceTimersByTime(100);
650
+ await flushVue();
651
+ expect(wrapper.find("[data-testid=count]").text()).toBe("2");
652
+ });
653
+
654
+ it("without provider defaultThrottleMs or explicit throttleMs, behaves unthrottled", async () => {
655
+ const { wrapper } = mountHookComponent({ agent });
656
+ agent.setMessages([userMsg("1", "hello")]);
657
+ agent.notifyMessagesChanged();
658
+ await flushVue();
659
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
660
+ agent.setMessages([userMsg("1", "hello"), assistantMsg("2", "world")]);
661
+ agent.notifyMessagesChanged();
662
+ await flushVue();
663
+ expect(wrapper.find("[data-testid=count]").text()).toBe("2");
664
+ });
665
+
666
+ it("explicit throttleMs: 0 overrides non-zero provider defaultThrottleMs (opt-out)", async () => {
667
+ const { wrapper } = mountHookComponent({
668
+ agent,
669
+ defaultThrottleMs: 500,
670
+ throttleMs: 0,
671
+ });
672
+ agent.setMessages([userMsg("1", "hello")]);
673
+ agent.notifyMessagesChanged();
674
+ await flushVue();
675
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
676
+ agent.setMessages([userMsg("1", "hello"), assistantMsg("2", "world")]);
677
+ agent.notifyMessagesChanged();
678
+ await flushVue();
679
+ expect(wrapper.find("[data-testid=count]").text()).toBe("2");
680
+ });
681
+
682
+ it.each([
683
+ { label: "NaN", value: Number.NaN },
684
+ { label: "Infinity", value: Number.POSITIVE_INFINITY },
685
+ { label: "-1", value: -1 },
686
+ { label: "-Infinity", value: Number.NEGATIVE_INFINITY },
687
+ ])(
688
+ "with invalid provider defaultThrottleMs ($label), falls back to unthrottled and warns",
689
+ async ({ value }) => {
690
+ const errorSpy = vi.spyOn(console, "error").mockImplementation(() => {});
691
+ const { wrapper } = mountHookComponent({
692
+ agent,
693
+ defaultThrottleMs: value,
694
+ });
695
+ expect(errorSpy).toHaveBeenCalledWith(
696
+ expect.stringContaining("CopilotKitProvider: defaultThrottleMs"),
697
+ );
698
+ agent.setMessages([userMsg("1", "a")]);
699
+ agent.notifyMessagesChanged();
700
+ await flushVue();
701
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
702
+ agent.setMessages([userMsg("1", "a"), assistantMsg("2", "b")]);
703
+ agent.notifyMessagesChanged();
704
+ await flushVue();
705
+ expect(wrapper.find("[data-testid=count]").text()).toBe("2");
706
+ },
707
+ );
708
+
709
+ it("dynamically changing provider defaultThrottleMs updates throttle behavior", async () => {
710
+ const mounted = mountHookComponent({ agent, defaultThrottleMs: 200 });
711
+ const { wrapper } = mounted;
712
+ agent.setMessages([userMsg("1", "hello")]);
713
+ agent.notifyMessagesChanged();
714
+ await flushVue();
715
+ vi.advanceTimersByTime(10);
716
+ agent.setMessages([userMsg("1", "hello"), assistantMsg("2", "world")]);
717
+ agent.notifyMessagesChanged();
718
+ await flushVue();
719
+ expect(wrapper.find("[data-testid=count]").text()).toBe("1");
720
+ vi.advanceTimersByTime(200);
721
+ await flushVue();
722
+ expect(wrapper.find("[data-testid=count]").text()).toBe("2");
723
+ await wrapper.setProps({ defaultThrottleMs: 50 });
724
+ await flushVue();
725
+ agent.setMessages([
726
+ userMsg("1", "hello"),
727
+ assistantMsg("2", "world"),
728
+ userMsg("3", "new"),
729
+ ]);
730
+ agent.notifyMessagesChanged();
731
+ await flushVue();
732
+ expect(wrapper.find("[data-testid=count]").text()).toBe("3");
733
+ vi.advanceTimersByTime(10);
734
+ agent.setMessages([
735
+ userMsg("1", "hello"),
736
+ assistantMsg("2", "world"),
737
+ userMsg("3", "new"),
738
+ assistantMsg("4", "reply"),
739
+ ]);
740
+ agent.notifyMessagesChanged();
741
+ await flushVue();
742
+ expect(wrapper.find("[data-testid=count]").text()).toBe("3");
743
+ vi.advanceTimersByTime(50);
744
+ await flushVue();
745
+ expect(wrapper.find("[data-testid=count]").text()).toBe("4");
746
+ });
747
+ });