@copilotkit/react-core 1.57.3 → 1.58.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (282) hide show
  1. package/LICENSE +21 -0
  2. package/dist/{copilotkit-CC8DjOiC.mjs → copilotkit-BIn7HE8f.mjs} +2 -2
  3. package/dist/{copilotkit-CC8DjOiC.mjs.map → copilotkit-BIn7HE8f.mjs.map} +1 -1
  4. package/dist/{copilotkit-CtXcs1ea.cjs → copilotkit-Drw-g6zA.cjs} +2 -2
  5. package/dist/{copilotkit-CtXcs1ea.cjs.map → copilotkit-Drw-g6zA.cjs.map} +1 -1
  6. package/dist/index.cjs +3 -77
  7. package/dist/index.cjs.map +1 -1
  8. package/dist/index.d.cts +2 -2
  9. package/dist/index.d.mts +2 -2
  10. package/dist/index.mjs +3 -77
  11. package/dist/index.mjs.map +1 -1
  12. package/dist/index.umd.js +3 -77
  13. package/dist/index.umd.js.map +1 -1
  14. package/dist/v2/index.cjs +1 -1
  15. package/dist/v2/index.mjs +1 -1
  16. package/dist/v2/index.umd.js +1 -1
  17. package/dist/v2/index.umd.js.map +1 -1
  18. package/package.json +12 -13
  19. package/skills/react-core/SKILL.md +108 -0
  20. package/skills/react-core/references/agent-access.md +288 -0
  21. package/skills/react-core/references/attachments.md +291 -0
  22. package/skills/react-core/references/capabilities.md +138 -0
  23. package/skills/react-core/references/chat-components.md +221 -0
  24. package/skills/react-core/references/client-side-tools.md +358 -0
  25. package/skills/react-core/references/custom-message-renderers.md +226 -0
  26. package/skills/react-core/references/debug-mode.md +153 -0
  27. package/skills/react-core/references/human-in-the-loop.md +312 -0
  28. package/skills/react-core/references/provider-setup.md +326 -0
  29. package/skills/react-core/references/rendering-activity-messages.md +207 -0
  30. package/skills/react-core/references/rendering-tool-calls.md +319 -0
  31. package/skills/react-core/references/suggestions.md +211 -0
  32. package/skills/react-core/references/switching-agents-recipes.md +160 -0
  33. package/skills/react-core/references/switching-agents.md +231 -0
  34. package/skills/react-core/references/threads.md +226 -0
  35. package/.attw.json +0 -3
  36. package/CHANGELOG.md +0 -5043
  37. package/scripts/scope-preflight.mjs +0 -100
  38. package/src/components/CopilotListeners.tsx +0 -137
  39. package/src/components/__tests__/CopilotListeners.test.tsx +0 -38
  40. package/src/components/copilot-provider/__tests__/copilot-messages-key.test.tsx +0 -92
  41. package/src/components/copilot-provider/__tests__/copilotkit-error.test.tsx +0 -77
  42. package/src/components/copilot-provider/__tests__/error-visibility-prod.test.tsx +0 -70
  43. package/src/components/copilot-provider/__tests__/v1-explicit-threadid-bridge.test.tsx +0 -107
  44. package/src/components/copilot-provider/copilot-messages.tsx +0 -314
  45. package/src/components/copilot-provider/copilotkit-props.tsx +0 -214
  46. package/src/components/copilot-provider/copilotkit.tsx +0 -853
  47. package/src/components/copilot-provider/index.ts +0 -3
  48. package/src/components/dev-console/console-trigger.tsx +0 -283
  49. package/src/components/dev-console/developer-console-modal.tsx +0 -1016
  50. package/src/components/dev-console/icons.tsx +0 -106
  51. package/src/components/error-boundary/error-boundary.tsx +0 -99
  52. package/src/components/error-boundary/error-utils.tsx +0 -105
  53. package/src/components/index.ts +0 -1
  54. package/src/components/toast/exclamation-mark-icon.tsx +0 -27
  55. package/src/components/toast/toast-provider.tsx +0 -448
  56. package/src/components/usage-banner.tsx +0 -266
  57. package/src/context/__tests__/threads-context.test.tsx +0 -141
  58. package/src/context/coagent-state-renders-context.tsx +0 -89
  59. package/src/context/copilot-context.tsx +0 -365
  60. package/src/context/copilot-messages-context.tsx +0 -35
  61. package/src/context/index.ts +0 -22
  62. package/src/context/threads-context.tsx +0 -69
  63. package/src/hooks/__tests__/use-coagent-config.test.ts +0 -352
  64. package/src/hooks/__tests__/use-coagent-state-render-bridge.helpers.test.ts +0 -107
  65. package/src/hooks/__tests__/use-coagent-state-render.e2e.test.tsx +0 -1209
  66. package/src/hooks/__tests__/use-coagent-state-render.test.tsx +0 -356
  67. package/src/hooks/__tests__/use-copilot-chat-internal-connect.test.tsx +0 -241
  68. package/src/hooks/__tests__/use-frontend-tool-available.test.tsx +0 -72
  69. package/src/hooks/__tests__/use-frontend-tool-remount.e2e.test.tsx +0 -102
  70. package/src/hooks/index.ts +0 -33
  71. package/src/hooks/use-agent-nodename.ts +0 -33
  72. package/src/hooks/use-coagent-state-render-bridge.helpers.ts +0 -345
  73. package/src/hooks/use-coagent-state-render-bridge.tsx +0 -222
  74. package/src/hooks/use-coagent-state-render-registry.ts +0 -230
  75. package/src/hooks/use-coagent-state-render.ts +0 -163
  76. package/src/hooks/use-coagent.ts +0 -377
  77. package/src/hooks/use-configure-chat-suggestions.tsx +0 -96
  78. package/src/hooks/use-copilot-action.ts +0 -245
  79. package/src/hooks/use-copilot-additional-instructions.ts +0 -98
  80. package/src/hooks/use-copilot-authenticated-action.ts +0 -73
  81. package/src/hooks/use-copilot-chat-headless_c.ts +0 -264
  82. package/src/hooks/use-copilot-chat-suggestions.tsx +0 -134
  83. package/src/hooks/use-copilot-chat.ts +0 -132
  84. package/src/hooks/use-copilot-chat_internal.ts +0 -875
  85. package/src/hooks/use-copilot-readable.ts +0 -135
  86. package/src/hooks/use-copilot-runtime-client.ts +0 -178
  87. package/src/hooks/use-default-tool.ts +0 -13
  88. package/src/hooks/use-flat-category-store.ts +0 -109
  89. package/src/hooks/use-frontend-tool.ts +0 -113
  90. package/src/hooks/use-human-in-the-loop.ts +0 -138
  91. package/src/hooks/use-langgraph-interrupt.ts +0 -103
  92. package/src/hooks/use-lazy-tool-renderer.tsx +0 -30
  93. package/src/hooks/use-make-copilot-document-readable.ts +0 -30
  94. package/src/hooks/use-render-tool-call.ts +0 -89
  95. package/src/hooks/use-tree.ts +0 -222
  96. package/src/index.tsx +0 -7
  97. package/src/lib/copilot-task.ts +0 -215
  98. package/src/lib/index.ts +0 -1
  99. package/src/lib/status-checker.ts +0 -67
  100. package/src/setupTests.ts +0 -37
  101. package/src/test-helpers/copilot-context.ts +0 -91
  102. package/src/types/chat-suggestion-configuration.ts +0 -23
  103. package/src/types/coagent-action.ts +0 -35
  104. package/src/types/coagent-state.ts +0 -13
  105. package/src/types/crew.ts +0 -89
  106. package/src/types/document-pointer.ts +0 -7
  107. package/src/types/frontend-action.ts +0 -213
  108. package/src/types/index.ts +0 -17
  109. package/src/types/interrupt-action.ts +0 -58
  110. package/src/types/system-message.ts +0 -4
  111. package/src/utils/dev-console.ts +0 -19
  112. package/src/utils/index.ts +0 -2
  113. package/src/utils/suggestions-constants.ts +0 -8
  114. package/src/utils/utils.test.ts +0 -7
  115. package/src/utils/utils.ts +0 -6
  116. package/src/v2/__tests__/A2UIMessageRenderer.test.tsx +0 -240
  117. package/src/v2/__tests__/globalSetup.ts +0 -14
  118. package/src/v2/__tests__/setup.ts +0 -93
  119. package/src/v2/__tests__/utils/test-helpers.tsx +0 -570
  120. package/src/v2/a2ui/A2UICatalogContext.tsx +0 -79
  121. package/src/v2/a2ui/A2UIMessageRenderer.tsx +0 -294
  122. package/src/v2/a2ui/A2UIToolCallRenderer.tsx +0 -290
  123. package/src/v2/components/CopilotKitInspector.tsx +0 -52
  124. package/src/v2/components/MCPAppsActivityRenderer.tsx +0 -815
  125. package/src/v2/components/OpenGenerativeUIRenderer.tsx +0 -598
  126. package/src/v2/components/WildcardToolCallRender.tsx +0 -86
  127. package/src/v2/components/__tests__/OpenGenerativeUIRenderer.test.tsx +0 -665
  128. package/src/v2/components/chat/CopilotChat.tsx +0 -664
  129. package/src/v2/components/chat/CopilotChatAssistantMessage.tsx +0 -393
  130. package/src/v2/components/chat/CopilotChatAttachmentQueue.tsx +0 -374
  131. package/src/v2/components/chat/CopilotChatAttachmentRenderer.tsx +0 -159
  132. package/src/v2/components/chat/CopilotChatAudioRecorder.tsx +0 -350
  133. package/src/v2/components/chat/CopilotChatInput.tsx +0 -1412
  134. package/src/v2/components/chat/CopilotChatMessageView.tsx +0 -716
  135. package/src/v2/components/chat/CopilotChatReasoningMessage.tsx +0 -265
  136. package/src/v2/components/chat/CopilotChatSuggestionPill.tsx +0 -59
  137. package/src/v2/components/chat/CopilotChatSuggestionView.tsx +0 -134
  138. package/src/v2/components/chat/CopilotChatToggleButton.tsx +0 -171
  139. package/src/v2/components/chat/CopilotChatToolCallsView.tsx +0 -40
  140. package/src/v2/components/chat/CopilotChatUserMessage.tsx +0 -445
  141. package/src/v2/components/chat/CopilotChatView.tsx +0 -890
  142. package/src/v2/components/chat/CopilotModalHeader.tsx +0 -129
  143. package/src/v2/components/chat/CopilotPopup.tsx +0 -81
  144. package/src/v2/components/chat/CopilotPopupView.tsx +0 -317
  145. package/src/v2/components/chat/CopilotSidebar.tsx +0 -80
  146. package/src/v2/components/chat/CopilotSidebarView.tsx +0 -269
  147. package/src/v2/components/chat/Lightbox.tsx +0 -103
  148. package/src/v2/components/chat/__tests__/CopilotChat.absentThreadConnect.test.tsx +0 -66
  149. package/src/v2/components/chat/__tests__/CopilotChat.attachments.test.tsx +0 -168
  150. package/src/v2/components/chat/__tests__/CopilotChat.e2e.test.tsx +0 -1239
  151. package/src/v2/components/chat/__tests__/CopilotChat.onError.test.tsx +0 -73
  152. package/src/v2/components/chat/__tests__/CopilotChat.slots.e2e.test.tsx +0 -432
  153. package/src/v2/components/chat/__tests__/CopilotChat.suggestionsAlways.test.tsx +0 -183
  154. package/src/v2/components/chat/__tests__/CopilotChat.welcomeGate.test.tsx +0 -184
  155. package/src/v2/components/chat/__tests__/CopilotChatActivityRendering.e2e.test.tsx +0 -649
  156. package/src/v2/components/chat/__tests__/CopilotChatAssistantMessage.slots.e2e.test.tsx +0 -624
  157. package/src/v2/components/chat/__tests__/CopilotChatAssistantMessage.test.tsx +0 -702
  158. package/src/v2/components/chat/__tests__/CopilotChatAssistantMessage.thumbs.test.tsx +0 -72
  159. package/src/v2/components/chat/__tests__/CopilotChatCopyButton.clipboard.test.tsx +0 -241
  160. package/src/v2/components/chat/__tests__/CopilotChatCssClasses.test.tsx +0 -107
  161. package/src/v2/components/chat/__tests__/CopilotChatInput.slots.e2e.test.tsx +0 -929
  162. package/src/v2/components/chat/__tests__/CopilotChatInput.test.tsx +0 -1567
  163. package/src/v2/components/chat/__tests__/CopilotChatMessageView.slots.e2e.test.tsx +0 -1004
  164. package/src/v2/components/chat/__tests__/CopilotChatMessageView.test.tsx +0 -279
  165. package/src/v2/components/chat/__tests__/CopilotChatPerf.e2e.test.tsx +0 -336
  166. package/src/v2/components/chat/__tests__/CopilotChatPropsRerender.e2e.test.tsx +0 -249
  167. package/src/v2/components/chat/__tests__/CopilotChatSuggestionView.slots.e2e.test.tsx +0 -530
  168. package/src/v2/components/chat/__tests__/CopilotChatToolRendering.e2e.test.tsx +0 -785
  169. package/src/v2/components/chat/__tests__/CopilotChatToolRerenders.e2e.test.tsx +0 -2416
  170. package/src/v2/components/chat/__tests__/CopilotChatUserMessage.slots.e2e.test.tsx +0 -621
  171. package/src/v2/components/chat/__tests__/CopilotChatView.connectingGate.test.tsx +0 -56
  172. package/src/v2/components/chat/__tests__/CopilotChatView.inputOverlay.test.tsx +0 -264
  173. package/src/v2/components/chat/__tests__/CopilotChatView.onClick.e2e.test.tsx +0 -853
  174. package/src/v2/components/chat/__tests__/CopilotChatView.pinToSend.test.tsx +0 -94
  175. package/src/v2/components/chat/__tests__/CopilotChatView.slots.e2e.test.tsx +0 -1050
  176. package/src/v2/components/chat/__tests__/CopilotModalHeader.slots.e2e.test.tsx +0 -484
  177. package/src/v2/components/chat/__tests__/CopilotPopupView.slots.e2e.test.tsx +0 -612
  178. package/src/v2/components/chat/__tests__/CopilotSidebarView.position.test.tsx +0 -159
  179. package/src/v2/components/chat/__tests__/CopilotSidebarView.slots.e2e.test.tsx +0 -502
  180. package/src/v2/components/chat/__tests__/MCPAppsActivityRenderer.e2e.test.tsx +0 -1068
  181. package/src/v2/components/chat/__tests__/MCPAppsProxy.e2e.test.tsx +0 -589
  182. package/src/v2/components/chat/__tests__/MCPAppsUiMessage.e2e.test.tsx +0 -403
  183. package/src/v2/components/chat/__tests__/copilot-chat-throttle.test.tsx +0 -137
  184. package/src/v2/components/chat/__tests__/normalize-auto-scroll.test.ts +0 -37
  185. package/src/v2/components/chat/__tests__/setup.ts +0 -1
  186. package/src/v2/components/chat/index.ts +0 -90
  187. package/src/v2/components/chat/last-user-message-context.ts +0 -21
  188. package/src/v2/components/chat/normalize-auto-scroll.ts +0 -17
  189. package/src/v2/components/chat/scroll-element-context.ts +0 -13
  190. package/src/v2/components/index.ts +0 -8
  191. package/src/v2/components/intelligence-indicator/IntelligenceIndicator.tsx +0 -286
  192. package/src/v2/components/intelligence-indicator/__tests__/IntelligenceIndicator.e2e.test.tsx +0 -464
  193. package/src/v2/components/intelligence-indicator/index.ts +0 -2
  194. package/src/v2/components/license-warning-banner.tsx +0 -217
  195. package/src/v2/components/ui/button.tsx +0 -124
  196. package/src/v2/components/ui/dropdown-menu.tsx +0 -258
  197. package/src/v2/components/ui/tooltip.tsx +0 -60
  198. package/src/v2/context.ts +0 -62
  199. package/src/v2/headless.ts +0 -64
  200. package/src/v2/hooks/__tests__/standard-schema-types.test.tsx +0 -152
  201. package/src/v2/hooks/__tests__/standard-schema.test.tsx +0 -282
  202. package/src/v2/hooks/__tests__/use-agent-context-timing.e2e.test.tsx +0 -140
  203. package/src/v2/hooks/__tests__/use-agent-context.test.tsx +0 -401
  204. package/src/v2/hooks/__tests__/use-agent-error-state.test.tsx +0 -44
  205. package/src/v2/hooks/__tests__/use-agent-stability.test.tsx +0 -211
  206. package/src/v2/hooks/__tests__/use-agent-throttle.test.tsx +0 -1029
  207. package/src/v2/hooks/__tests__/use-agent.e2e.test.tsx +0 -159
  208. package/src/v2/hooks/__tests__/use-attachments.test.tsx +0 -169
  209. package/src/v2/hooks/__tests__/use-capabilities.test.tsx +0 -76
  210. package/src/v2/hooks/__tests__/use-component.test.tsx +0 -126
  211. package/src/v2/hooks/__tests__/use-configure-suggestions.e2e.test.tsx +0 -696
  212. package/src/v2/hooks/__tests__/use-default-render-tool.test.tsx +0 -153
  213. package/src/v2/hooks/__tests__/use-frontend-tool-available.test.tsx +0 -167
  214. package/src/v2/hooks/__tests__/use-frontend-tool.e2e.test.tsx +0 -2148
  215. package/src/v2/hooks/__tests__/use-human-in-the-loop.e2e.test.tsx +0 -1261
  216. package/src/v2/hooks/__tests__/use-interrupt.test.tsx +0 -397
  217. package/src/v2/hooks/__tests__/use-katex-styles.test.tsx +0 -56
  218. package/src/v2/hooks/__tests__/use-keyboard-height.test.tsx +0 -192
  219. package/src/v2/hooks/__tests__/use-pin-to-send.test.tsx +0 -219
  220. package/src/v2/hooks/__tests__/use-render-custom-messages.test.tsx +0 -55
  221. package/src/v2/hooks/__tests__/use-render-tool.test.tsx +0 -259
  222. package/src/v2/hooks/__tests__/use-suggestions.e2e.test.tsx +0 -524
  223. package/src/v2/hooks/__tests__/use-threads.test.tsx +0 -757
  224. package/src/v2/hooks/__tests__/zod-regression.test.tsx +0 -311
  225. package/src/v2/hooks/index.ts +0 -24
  226. package/src/v2/hooks/use-agent-context.tsx +0 -45
  227. package/src/v2/hooks/use-agent.tsx +0 -227
  228. package/src/v2/hooks/use-attachments.tsx +0 -269
  229. package/src/v2/hooks/use-capabilities.tsx +0 -25
  230. package/src/v2/hooks/use-component.tsx +0 -91
  231. package/src/v2/hooks/use-configure-suggestions.tsx +0 -236
  232. package/src/v2/hooks/use-default-render-tool.tsx +0 -271
  233. package/src/v2/hooks/use-frontend-tool.tsx +0 -46
  234. package/src/v2/hooks/use-human-in-the-loop.tsx +0 -81
  235. package/src/v2/hooks/use-interrupt.tsx +0 -305
  236. package/src/v2/hooks/use-keyboard-height.tsx +0 -67
  237. package/src/v2/hooks/use-pin-to-send.ts +0 -94
  238. package/src/v2/hooks/use-render-activity-message.tsx +0 -72
  239. package/src/v2/hooks/use-render-custom-messages.tsx +0 -93
  240. package/src/v2/hooks/use-render-tool-call.tsx +0 -208
  241. package/src/v2/hooks/use-render-tool.tsx +0 -184
  242. package/src/v2/hooks/use-suggestions.tsx +0 -91
  243. package/src/v2/hooks/use-threads.tsx +0 -325
  244. package/src/v2/hooks/useKatexStyles.ts +0 -27
  245. package/src/v2/index.css +0 -1
  246. package/src/v2/index.ts +0 -27
  247. package/src/v2/lib/__tests__/completePartialMarkdown.test.ts +0 -495
  248. package/src/v2/lib/__tests__/processPartialHtml.test.ts +0 -112
  249. package/src/v2/lib/__tests__/renderSlot.test.tsx +0 -588
  250. package/src/v2/lib/__tests__/slots.test.ts +0 -56
  251. package/src/v2/lib/processPartialHtml.ts +0 -45
  252. package/src/v2/lib/react-core.ts +0 -156
  253. package/src/v2/lib/slots.tsx +0 -184
  254. package/src/v2/lib/transcription-client.ts +0 -184
  255. package/src/v2/lib/utils.ts +0 -8
  256. package/src/v2/providers/CopilotChatConfigurationProvider.tsx +0 -196
  257. package/src/v2/providers/CopilotKitProvider.tsx +0 -800
  258. package/src/v2/providers/SandboxFunctionsContext.ts +0 -10
  259. package/src/v2/providers/__tests__/CopilotChatConfigurationProvider.test.tsx +0 -652
  260. package/src/v2/providers/__tests__/CopilotKitProvider.license.test.tsx +0 -101
  261. package/src/v2/providers/__tests__/CopilotKitProvider.onError.test.tsx +0 -69
  262. package/src/v2/providers/__tests__/CopilotKitProvider.renderCustomMessages.e2e.test.tsx +0 -881
  263. package/src/v2/providers/__tests__/CopilotKitProvider.sandboxFunctions.test.tsx +0 -198
  264. package/src/v2/providers/__tests__/CopilotKitProvider.stability.test.tsx +0 -740
  265. package/src/v2/providers/__tests__/CopilotKitProvider.test.tsx +0 -713
  266. package/src/v2/providers/__tests__/CopilotKitProvider.wildcard.test.tsx +0 -294
  267. package/src/v2/providers/index.ts +0 -21
  268. package/src/v2/styles/globals.css +0 -349
  269. package/src/v2/types/__tests__/defineToolCallRenderer.test.tsx +0 -525
  270. package/src/v2/types/defineToolCallRenderer.ts +0 -68
  271. package/src/v2/types/frontend-tool.ts +0 -8
  272. package/src/v2/types/human-in-the-loop.ts +0 -33
  273. package/src/v2/types/index.ts +0 -8
  274. package/src/v2/types/interrupt.ts +0 -15
  275. package/src/v2/types/react-activity-message-renderer.ts +0 -27
  276. package/src/v2/types/react-custom-message-renderer.ts +0 -17
  277. package/src/v2/types/react-tool-call-renderer.ts +0 -35
  278. package/src/v2/types/sandbox-function.ts +0 -11
  279. package/tsconfig.json +0 -8
  280. package/tsdown.config.ts +0 -193
  281. package/typedoc.json +0 -4
  282. package/vitest.config.mjs +0 -31
@@ -1,294 +0,0 @@
1
- import { useCopilotKit } from "../providers";
2
- import type { ReactActivityMessageRenderer } from "../types/react-activity-message-renderer";
3
- import { useCallback, useEffect, useMemo, useRef, useState } from "react";
4
- import { z } from "zod";
5
- import {
6
- A2UIProvider,
7
- useA2UIActions,
8
- useA2UIError,
9
- A2UIRenderer,
10
- initializeDefaultCatalog,
11
- injectStyles,
12
- DEFAULT_SURFACE_ID,
13
- } from "@copilotkit/a2ui-renderer";
14
- import type { Theme, A2UIClientEventMessage } from "@copilotkit/a2ui-renderer";
15
-
16
- /**
17
- * The container key used to wrap A2UI operations for explicit detection.
18
- * Must match A2UI_OPERATIONS_KEY in @ag-ui/a2ui-middleware and copilotkit.a2ui (Python).
19
- */
20
- const A2UI_OPERATIONS_KEY = "a2ui_operations";
21
-
22
- // Initialize the React renderer's component catalog and styles once
23
- let initialized = false;
24
- function ensureInitialized() {
25
- if (!initialized) {
26
- initializeDefaultCatalog();
27
- injectStyles();
28
- initialized = true;
29
- }
30
- }
31
-
32
- /**
33
- * User action with dataContextPath, as dispatched by A2UI components.
34
- */
35
- export type A2UIUserAction = {
36
- name: string;
37
- sourceComponentId: string;
38
- surfaceId: string;
39
- timestamp: string;
40
- context?: Record<string, unknown>;
41
- dataContextPath?: string;
42
- };
43
-
44
- export type A2UIMessageRendererOptions = {
45
- theme: Theme;
46
- /** Optional component catalog to pass to A2UIProvider */
47
- catalog?: any;
48
- /** Optional custom loading component shown while A2UI surface is generating. */
49
- loadingComponent?: React.ComponentType;
50
- };
51
-
52
- export function createA2UIMessageRenderer(
53
- options: A2UIMessageRendererOptions,
54
- ): ReactActivityMessageRenderer<any> {
55
- const { theme, catalog, loadingComponent } = options;
56
-
57
- return {
58
- activityType: "a2ui-surface",
59
- content: z.any(),
60
- render: ({ content, agent }) => {
61
- ensureInitialized();
62
-
63
- const [operations, setOperations] = useState<any[]>([]);
64
- const { copilotkit } = useCopilotKit();
65
-
66
- const lastContentRef = useRef<unknown>(null);
67
- useEffect(() => {
68
- // Skip if same content reference
69
- if (content === lastContentRef.current) return;
70
- lastContentRef.current = content;
71
-
72
- const incoming = content?.[A2UI_OPERATIONS_KEY];
73
- if (!content || !Array.isArray(incoming)) {
74
- setOperations([]);
75
- return;
76
- }
77
-
78
- setOperations(incoming);
79
- }, [content]);
80
-
81
- // Group operations by surface ID
82
- const groupedOperations = useMemo(() => {
83
- const groups = new Map<string, any[]>();
84
-
85
- for (const operation of operations) {
86
- const surfaceId =
87
- getOperationSurfaceId(operation) ?? DEFAULT_SURFACE_ID;
88
-
89
- if (!groups.has(surfaceId)) {
90
- groups.set(surfaceId, []);
91
- }
92
- groups.get(surfaceId)!.push(operation);
93
- }
94
-
95
- return groups;
96
- }, [operations]);
97
-
98
- if (!groupedOperations.size) {
99
- // Show loading state while A2UI surface is being generated
100
- const LoadingComponent = loadingComponent ?? DefaultA2UILoading;
101
- return <LoadingComponent />;
102
- }
103
-
104
- return (
105
- <div className="cpk:flex cpk:min-h-0 cpk:flex-1 cpk:flex-col cpk:gap-6 cpk:overflow-auto cpk:py-6">
106
- {Array.from(groupedOperations.entries()).map(([surfaceId, ops]) => (
107
- <ReactSurfaceHost
108
- key={surfaceId}
109
- surfaceId={surfaceId}
110
- operations={ops}
111
- theme={theme}
112
- agent={agent}
113
- copilotkit={copilotkit}
114
- catalog={catalog}
115
- />
116
- ))}
117
- </div>
118
- );
119
- },
120
- };
121
- }
122
-
123
- type ReactSurfaceHostProps = {
124
- surfaceId: string;
125
- operations: any[];
126
- theme: Theme;
127
- agent: any;
128
- copilotkit: any;
129
- /** Optional component catalog to pass to A2UIProvider */
130
- catalog?: any;
131
- };
132
-
133
- /**
134
- * Renders a single A2UI surface using the React renderer.
135
- * Wraps A2UIProvider + A2UIRenderer and bridges actions back to CopilotKit.
136
- */
137
- function ReactSurfaceHost({
138
- surfaceId,
139
- operations,
140
- theme,
141
- agent,
142
- copilotkit,
143
- catalog,
144
- }: ReactSurfaceHostProps) {
145
- // Bridge: when the React renderer dispatches an action, forward to CopilotKit
146
- const handleAction = useCallback(
147
- async (message: A2UIClientEventMessage) => {
148
- if (!agent) return;
149
-
150
- const action = message.userAction as A2UIUserAction | undefined;
151
-
152
- try {
153
- copilotkit.setProperties({
154
- ...copilotkit.properties,
155
- a2uiAction: message,
156
- });
157
-
158
- await copilotkit.runAgent({ agent });
159
- } finally {
160
- if (copilotkit.properties) {
161
- const { a2uiAction, ...rest } = copilotkit.properties;
162
- copilotkit.setProperties(rest);
163
- }
164
- }
165
- },
166
- [agent, copilotkit],
167
- );
168
-
169
- return (
170
- <div className="cpk:flex cpk:w-full cpk:flex-none cpk:flex-col cpk:gap-4">
171
- <A2UIProvider onAction={handleAction} theme={theme} catalog={catalog}>
172
- <SurfaceMessageProcessor
173
- surfaceId={surfaceId}
174
- operations={operations}
175
- />
176
- <A2UISurfaceOrError surfaceId={surfaceId} />
177
- </A2UIProvider>
178
- </div>
179
- );
180
- }
181
-
182
- /**
183
- * Renders the A2UI surface, or an error message if processing failed.
184
- * Must be a child of A2UIProvider to access the error state.
185
- */
186
- function A2UISurfaceOrError({ surfaceId }: { surfaceId: string }) {
187
- const error = useA2UIError();
188
- if (error) {
189
- return (
190
- <div className="cpk:rounded-lg cpk:border cpk:border-red-200 cpk:bg-red-50 cpk:p-3 cpk:text-sm cpk:text-red-700">
191
- A2UI render error: {error}
192
- </div>
193
- );
194
- }
195
- return <A2UIRenderer surfaceId={surfaceId} className="cpk:flex cpk:flex-1" />;
196
- }
197
-
198
- /**
199
- * Processes A2UI operations into the provider's message processor.
200
- * Must be a child of A2UIProvider to access the actions context.
201
- */
202
- function SurfaceMessageProcessor({
203
- surfaceId,
204
- operations,
205
- }: {
206
- surfaceId: string;
207
- operations: any[];
208
- }) {
209
- const { processMessages, getSurface } = useA2UIActions();
210
- const lastHashRef = useRef<string>("");
211
- useEffect(() => {
212
- // Skip if operations haven't actually changed (deep compare via hash).
213
- // ACTIVITY_DELTA + ACTIVITY_SNAPSHOT can trigger multiple renders with
214
- // the same logical content but different object references.
215
- const hash = JSON.stringify(operations);
216
- if (hash === lastHashRef.current) return;
217
- lastHashRef.current = hash;
218
-
219
- // Filter out createSurface if the surface already exists — the
220
- // MessageProcessor throws on duplicate createSurface, but content
221
- // snapshots always include the full operation list.
222
- const existing = getSurface(surfaceId);
223
- const ops = existing
224
- ? operations.filter((op) => !op?.createSurface)
225
- : operations;
226
-
227
- // Error handling is done inside A2UIProvider.processMessages
228
- processMessages(ops);
229
- }, [processMessages, getSurface, surfaceId, operations]);
230
-
231
- return null;
232
- }
233
-
234
- /**
235
- * Default loading component shown while an A2UI surface is generating.
236
- * Displays an animated shimmer skeleton.
237
- */
238
- function DefaultA2UILoading() {
239
- return (
240
- <div
241
- className="cpk:flex cpk:flex-col cpk:gap-3 cpk:rounded-xl cpk:border cpk:border-gray-100 cpk:bg-gray-50/50 cpk:p-5"
242
- style={{ minHeight: 120 }}
243
- >
244
- <div className="cpk:flex cpk:items-center cpk:gap-2">
245
- <div
246
- className="cpk:h-3 cpk:w-3 cpk:rounded-full cpk:bg-gray-200"
247
- style={{
248
- animation: "cpk-a2ui-pulse 1.5s ease-in-out infinite",
249
- }}
250
- />
251
- <span className="cpk:text-xs cpk:font-medium cpk:text-gray-400">
252
- Generating UI...
253
- </span>
254
- </div>
255
- <div className="cpk:flex cpk:flex-col cpk:gap-2">
256
- {[0.8, 0.6, 0.4].map((width, i) => (
257
- <div
258
- key={i}
259
- className="cpk:h-3 cpk:rounded cpk:bg-gray-200/70"
260
- style={{
261
- width: `${width * 100}%`,
262
- animation: `cpk-a2ui-pulse 1.5s ease-in-out ${i * 0.15}s infinite`,
263
- }}
264
- />
265
- ))}
266
- </div>
267
- <style>{`
268
- @keyframes cpk-a2ui-pulse {
269
- 0%, 100% { opacity: 0.4; }
270
- 50% { opacity: 1; }
271
- }
272
- `}</style>
273
- </div>
274
- );
275
- }
276
-
277
- function getOperationSurfaceId(operation: any): string | null {
278
- if (!operation || typeof operation !== "object") {
279
- return null;
280
- }
281
-
282
- if (typeof operation.surfaceId === "string") {
283
- return operation.surfaceId;
284
- }
285
-
286
- // v0.9 message keys
287
- return (
288
- operation?.createSurface?.surfaceId ??
289
- operation?.updateComponents?.surfaceId ??
290
- operation?.updateDataModel?.surfaceId ??
291
- operation?.deleteSurface?.surfaceId ??
292
- null
293
- );
294
- }
@@ -1,290 +0,0 @@
1
- import React, { useEffect, useRef } from "react";
2
- import { useCopilotKit } from "../providers/CopilotKitProvider";
3
- import { defineToolCallRenderer } from "../types/defineToolCallRenderer";
4
- import { z } from "zod";
5
-
6
- /**
7
- * Tool name used by the dynamic A2UI generation secondary LLM.
8
- * This renderer is auto-registered when A2UI is enabled.
9
- */
10
- export const RENDER_A2UI_TOOL_NAME = "render_a2ui";
11
-
12
- interface A2UIProgressProps {
13
- parameters: unknown;
14
- }
15
-
16
- /**
17
- * Built-in progress indicator for dynamic A2UI generation.
18
- * Shows a skeleton wireframe that progressively reveals as tokens stream in.
19
- *
20
- * Registered automatically when A2UI is enabled. Users can override by
21
- * providing their own `useRenderTool({ name: "render_a2ui", ... })`.
22
- */
23
- function A2UIProgressIndicator({ parameters }: A2UIProgressProps) {
24
- const lastRef = useRef({ time: 0, tokens: 0 });
25
- const now = Date.now();
26
-
27
- let { tokens } = lastRef.current;
28
- if (now - lastRef.current.time > 200) {
29
- const chars = JSON.stringify(parameters ?? {}).length;
30
- tokens = Math.round(chars / 4);
31
- lastRef.current = { time: now, tokens };
32
- }
33
-
34
- const phase = tokens < 50 ? 0 : tokens < 200 ? 1 : tokens < 400 ? 2 : 3;
35
-
36
- return (
37
- <div style={{ margin: "12px 0", maxWidth: 320 }}>
38
- <div
39
- style={{
40
- position: "relative",
41
- overflow: "hidden",
42
- borderRadius: 12,
43
- border: "1px solid rgba(228,228,231,0.8)",
44
- backgroundColor: "#fff",
45
- boxShadow: "0 1px 2px rgba(0,0,0,0.04)",
46
- padding: "16px 18px 14px",
47
- }}
48
- >
49
- {/* Top bar */}
50
- <div
51
- style={{
52
- display: "flex",
53
- alignItems: "center",
54
- gap: 8,
55
- marginBottom: 12,
56
- }}
57
- >
58
- <div style={{ display: "flex", gap: 4 }}>
59
- <Dot />
60
- <Dot />
61
- <Dot />
62
- </div>
63
- <Bar
64
- w={64}
65
- h={6}
66
- bg="#e4e4e7"
67
- opacity={phase >= 1 ? 1 : 0.4}
68
- transition="opacity 0.5s"
69
- />
70
- </div>
71
-
72
- {/* Skeleton lines */}
73
- <div style={{ display: "grid", gap: 7 }}>
74
- <Row show={phase >= 0}>
75
- <Bar w={36} h={7} bg="rgba(147,197,253,0.7)" anim={0} />
76
- <Bar w={80} h={7} bg="rgba(219,234,254,0.8)" anim={0.2} />
77
- </Row>
78
- <Row show={phase >= 0} delay={0.1}>
79
- <Spacer />
80
- <Dot />
81
- <Bar w={100} h={7} bg="rgba(24,24,27,0.2)" anim={0.3} />
82
- </Row>
83
- <Row show={phase >= 1} delay={0.15}>
84
- <Spacer />
85
- <Bar w={48} h={7} bg="rgba(24,24,27,0.15)" anim={0.1} />
86
- <Bar w={40} h={7} bg="rgba(153,246,228,0.6)" anim={0.5} />
87
- <Bar w={56} h={7} bg="rgba(147,197,253,0.6)" anim={0.3} />
88
- </Row>
89
- <Row show={phase >= 1} delay={0.2}>
90
- <Spacer />
91
- <Dot />
92
- <Bar w={60} h={7} bg="rgba(24,24,27,0.15)" anim={0.4} />
93
- </Row>
94
- <Row show={phase >= 2} delay={0.25}>
95
- <Bar w={40} h={7} bg="rgba(153,246,228,0.5)" anim={0.2} />
96
- <Dot />
97
- <Bar w={48} h={7} bg="rgba(24,24,27,0.15)" anim={0.6} />
98
- <Bar w={64} h={7} bg="rgba(147,197,253,0.5)" anim={0.1} />
99
- </Row>
100
- <Row show={phase >= 2} delay={0.3}>
101
- <Bar w={36} h={7} bg="rgba(147,197,253,0.6)" anim={0.5} />
102
- <Bar w={36} h={7} bg="rgba(24,24,27,0.12)" anim={0.7} />
103
- </Row>
104
- <Row show={phase >= 3} delay={0.35}>
105
- <Dot />
106
- <Bar w={44} h={7} bg="rgba(24,24,27,0.18)" anim={0.3} />
107
- <Dot />
108
- <Bar w={56} h={7} bg="rgba(153,246,228,0.5)" anim={0.8} />
109
- <Bar w={48} h={7} bg="rgba(147,197,253,0.5)" anim={0.4} />
110
- </Row>
111
- </div>
112
-
113
- {/* Shimmer */}
114
- <div
115
- style={{
116
- pointerEvents: "none",
117
- position: "absolute",
118
- inset: 0,
119
- background:
120
- "linear-gradient(105deg, transparent 0%, transparent 40%, rgba(255,255,255,0.6) 50%, transparent 60%, transparent 100%)",
121
- backgroundSize: "250% 100%",
122
- animation: "cpk-a2ui-sweep 3s ease-in-out infinite",
123
- }}
124
- />
125
- </div>
126
-
127
- {/* Label */}
128
- <div
129
- style={{
130
- display: "flex",
131
- alignItems: "center",
132
- justifyContent: "center",
133
- gap: 8,
134
- marginTop: 8,
135
- }}
136
- >
137
- <span
138
- style={{
139
- fontSize: 12,
140
- color: "#a1a1aa",
141
- letterSpacing: "0.025em",
142
- }}
143
- >
144
- Building interface
145
- </span>
146
- {tokens > 0 && (
147
- <span
148
- style={{
149
- fontSize: 11,
150
- color: "#d4d4d8",
151
- fontVariantNumeric: "tabular-nums",
152
- }}
153
- >
154
- ~{tokens.toLocaleString()} tokens
155
- </span>
156
- )}
157
- </div>
158
-
159
- <style>{`
160
- @keyframes cpk-a2ui-fade {
161
- 0%, 100% { opacity: 1; }
162
- 50% { opacity: 0.5; }
163
- }
164
- @keyframes cpk-a2ui-sweep {
165
- 0% { background-position: 250% 0; }
166
- 100% { background-position: -250% 0; }
167
- }
168
- `}</style>
169
- </div>
170
- );
171
- }
172
-
173
- // --- Primitives ---
174
-
175
- function Dot() {
176
- return (
177
- <div
178
- style={{
179
- width: 7,
180
- height: 7,
181
- borderRadius: "50%",
182
- backgroundColor: "#d4d4d8",
183
- flexShrink: 0,
184
- }}
185
- />
186
- );
187
- }
188
-
189
- function Spacer() {
190
- return <div style={{ width: 12 }} />;
191
- }
192
-
193
- function Bar({
194
- w,
195
- h,
196
- bg,
197
- anim,
198
- opacity,
199
- transition,
200
- }: {
201
- w: number;
202
- h: number;
203
- bg: string;
204
- anim?: number;
205
- opacity?: number;
206
- transition?: string;
207
- }) {
208
- return (
209
- <div
210
- style={{
211
- width: w,
212
- height: h,
213
- borderRadius: 9999,
214
- backgroundColor: bg,
215
- ...(anim !== undefined
216
- ? { animation: `cpk-a2ui-fade 2.4s ease-in-out ${anim}s infinite` }
217
- : {}),
218
- ...(opacity !== undefined ? { opacity } : {}),
219
- ...(transition ? { transition } : {}),
220
- }}
221
- />
222
- );
223
- }
224
-
225
- function Row({
226
- children,
227
- show,
228
- delay = 0,
229
- }: {
230
- children: React.ReactNode;
231
- show: boolean;
232
- delay?: number;
233
- }) {
234
- return (
235
- <div
236
- style={{
237
- display: "flex",
238
- alignItems: "center",
239
- gap: 6,
240
- opacity: show ? 1 : 0,
241
- transition: `opacity 0.4s ${delay}s`,
242
- }}
243
- >
244
- {children}
245
- </div>
246
- );
247
- }
248
-
249
- // --- Hook entry point ---
250
-
251
- /**
252
- * Registers the built-in `render_a2ui` tool call renderer via the props-based
253
- * `setRenderToolCalls` mechanism (not `useRenderTool`).
254
- *
255
- * This ensures user-registered `useRenderTool({ name: "render_a2ui", ... })`
256
- * hooks automatically override the built-in, since the merge logic in
257
- * react-core.ts gives hook-based entries priority over prop-based entries.
258
- */
259
- export function A2UIBuiltInToolCallRenderer(): null {
260
- const { copilotkit } = useCopilotKit();
261
-
262
- useEffect(() => {
263
- const renderer = defineToolCallRenderer({
264
- name: RENDER_A2UI_TOOL_NAME,
265
- args: z.any(),
266
- render: ({ status, args: parameters }) => {
267
- if (status === "complete") return <></>;
268
- const params = parameters as any;
269
- // Hide skeleton once the A2UI surface has enough data to render.
270
- // For data-bound surfaces: items array is populated.
271
- // For dashboard-style surfaces: components array has multiple entries
272
- // (meaning the streaming path is emitting activity snapshots).
273
- const items = params?.items;
274
- if (Array.isArray(items) && items.length > 0) return <></>;
275
- const components = params?.components;
276
- if (Array.isArray(components) && components.length > 2) return <></>;
277
- return <A2UIProgressIndicator parameters={parameters} />;
278
- },
279
- });
280
-
281
- // Register via props-based mechanism so useRenderTool hooks take priority
282
- const existing = (copilotkit as any)._renderToolCalls ?? [];
283
- copilotkit.setRenderToolCalls([
284
- ...existing.filter((rc: any) => rc.name !== RENDER_A2UI_TOOL_NAME),
285
- renderer,
286
- ]);
287
- }, [copilotkit]);
288
-
289
- return null;
290
- }
@@ -1,52 +0,0 @@
1
- import * as React from "react";
2
- import { createComponent } from "@lit-labs/react";
3
- import type { CopilotKitCore } from "@copilotkit/core";
4
- import type { Anchor } from "@copilotkit/web-inspector";
5
-
6
- type CopilotKitInspectorBaseProps = {
7
- core?: CopilotKitCore | null;
8
- defaultAnchor?: Anchor;
9
- [key: string]: unknown;
10
- };
11
-
12
- type InspectorComponent = React.ComponentType<CopilotKitInspectorBaseProps>;
13
-
14
- export interface CopilotKitInspectorProps extends CopilotKitInspectorBaseProps {}
15
-
16
- export const CopilotKitInspector: React.FC<CopilotKitInspectorProps> = ({
17
- core,
18
- ...rest
19
- }) => {
20
- const [InspectorComponent, setInspectorComponent] =
21
- React.useState<InspectorComponent | null>(null);
22
-
23
- React.useEffect(() => {
24
- let mounted = true;
25
-
26
- // Load the web component only on the client to keep SSR output stable.
27
- import("@copilotkit/web-inspector").then((mod) => {
28
- mod.defineWebInspector?.();
29
-
30
- const Component = createComponent({
31
- tagName: mod.WEB_INSPECTOR_TAG,
32
- elementClass: mod.WebInspectorElement,
33
- react: React,
34
- }) as InspectorComponent;
35
-
36
- if (mounted) {
37
- setInspectorComponent(() => Component);
38
- }
39
- });
40
-
41
- return () => {
42
- mounted = false;
43
- };
44
- }, []);
45
-
46
- // During SSR (and until the client finishes loading), render nothing to keep markup consistent.
47
- if (!InspectorComponent) return null;
48
-
49
- return <InspectorComponent {...rest} core={core ?? null} />;
50
- };
51
-
52
- CopilotKitInspector.displayName = "CopilotKitInspector";