@copilotkit/react-core 1.54.1 → 1.55.0-next.7

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 (183) hide show
  1. package/CHANGELOG.md +117 -116
  2. package/dist/copilotkit-B3Mb1yVE.cjs +7975 -0
  3. package/dist/copilotkit-B3Mb1yVE.cjs.map +1 -0
  4. package/dist/copilotkit-DBzgOMby.d.cts +2182 -0
  5. package/dist/copilotkit-DBzgOMby.d.cts.map +1 -0
  6. package/dist/copilotkit-DNYSFuz5.mjs +7562 -0
  7. package/dist/copilotkit-DNYSFuz5.mjs.map +1 -0
  8. package/dist/copilotkit-Dy5w3qEV.d.mts +2182 -0
  9. package/dist/copilotkit-Dy5w3qEV.d.mts.map +1 -0
  10. package/dist/index.cjs +27 -28
  11. package/dist/index.cjs.map +1 -1
  12. package/dist/index.d.cts +3 -3
  13. package/dist/index.d.cts.map +1 -1
  14. package/dist/index.d.mts +3 -3
  15. package/dist/index.d.mts.map +1 -1
  16. package/dist/index.mjs +4 -5
  17. package/dist/index.mjs.map +1 -1
  18. package/dist/index.umd.js +1941 -35
  19. package/dist/index.umd.js.map +1 -1
  20. package/dist/v2/index.cjs +77 -7
  21. package/dist/v2/index.css +1 -2
  22. package/dist/v2/index.d.cts +6 -4
  23. package/dist/v2/index.d.mts +6 -4
  24. package/dist/v2/index.mjs +7 -4
  25. package/dist/v2/index.umd.js +5725 -24
  26. package/dist/v2/index.umd.js.map +1 -1
  27. package/package.json +37 -9
  28. package/scripts/scope-preflight.mjs +101 -0
  29. package/src/components/CopilotListeners.tsx +2 -6
  30. package/src/components/copilot-provider/copilot-messages.tsx +1 -1
  31. package/src/components/copilot-provider/copilotkit-props.tsx +1 -1
  32. package/src/components/copilot-provider/copilotkit.tsx +4 -4
  33. package/src/context/copilot-messages-context.tsx +1 -1
  34. package/src/hooks/__tests__/use-coagent-config.test.ts +2 -2
  35. package/src/hooks/__tests__/use-coagent-state-render.e2e.test.tsx +2 -2
  36. package/src/hooks/__tests__/use-copilot-chat-internal-connect.test.tsx +3 -7
  37. package/src/hooks/__tests__/use-frontend-tool-available.test.tsx +1 -1
  38. package/src/hooks/__tests__/use-frontend-tool-remount.e2e.test.tsx +4 -4
  39. package/src/hooks/use-agent-nodename.ts +1 -1
  40. package/src/hooks/use-coagent-state-render-bridge.tsx +1 -4
  41. package/src/hooks/use-coagent.ts +1 -1
  42. package/src/hooks/use-configure-chat-suggestions.tsx +2 -2
  43. package/src/hooks/use-copilot-chat-suggestions.tsx +2 -2
  44. package/src/hooks/use-copilot-chat_internal.ts +2 -2
  45. package/src/hooks/use-copilot-readable.ts +1 -1
  46. package/src/hooks/use-frontend-tool.ts +2 -2
  47. package/src/hooks/use-human-in-the-loop.ts +2 -2
  48. package/src/hooks/use-langgraph-interrupt.ts +2 -5
  49. package/src/hooks/use-lazy-tool-renderer.tsx +1 -1
  50. package/src/hooks/use-render-tool-call.ts +1 -1
  51. package/src/lib/copilot-task.ts +1 -1
  52. package/src/setupTests.ts +18 -14
  53. package/src/v2/__tests__/A2UIMessageRenderer.test.tsx +176 -0
  54. package/src/v2/__tests__/globalSetup.ts +14 -0
  55. package/src/v2/__tests__/setup.ts +93 -0
  56. package/src/v2/__tests__/utils/test-helpers.tsx +470 -0
  57. package/src/v2/a2ui/A2UIMessageRenderer.tsx +206 -0
  58. package/src/v2/components/CopilotKitInspector.tsx +50 -0
  59. package/src/v2/components/MCPAppsActivityRenderer.tsx +785 -0
  60. package/src/v2/components/WildcardToolCallRender.tsx +86 -0
  61. package/src/v2/components/__tests__/license-warning-banner.test.tsx +46 -0
  62. package/src/v2/components/chat/CopilotChat.tsx +431 -0
  63. package/src/v2/components/chat/CopilotChatAssistantMessage.tsx +375 -0
  64. package/src/v2/components/chat/CopilotChatAudioRecorder.tsx +350 -0
  65. package/src/v2/components/chat/CopilotChatInput.tsx +1302 -0
  66. package/src/v2/components/chat/CopilotChatMessageView.tsx +556 -0
  67. package/src/v2/components/chat/CopilotChatReasoningMessage.tsx +252 -0
  68. package/src/v2/components/chat/CopilotChatSuggestionPill.tsx +59 -0
  69. package/src/v2/components/chat/CopilotChatSuggestionView.tsx +133 -0
  70. package/src/v2/components/chat/CopilotChatToggleButton.tsx +171 -0
  71. package/src/v2/components/chat/CopilotChatToolCallsView.tsx +40 -0
  72. package/src/v2/components/chat/CopilotChatUserMessage.tsx +388 -0
  73. package/src/v2/components/chat/CopilotChatView.tsx +598 -0
  74. package/src/v2/components/chat/CopilotModalHeader.tsx +129 -0
  75. package/src/v2/components/chat/CopilotPopup.tsx +81 -0
  76. package/src/v2/components/chat/CopilotPopupView.tsx +317 -0
  77. package/src/v2/components/chat/CopilotSidebar.tsx +76 -0
  78. package/src/v2/components/chat/CopilotSidebarView.tsx +255 -0
  79. package/src/v2/components/chat/__tests__/CopilotChat.e2e.test.tsx +1113 -0
  80. package/src/v2/components/chat/__tests__/CopilotChat.onError.test.tsx +73 -0
  81. package/src/v2/components/chat/__tests__/CopilotChat.slots.e2e.test.tsx +432 -0
  82. package/src/v2/components/chat/__tests__/CopilotChatActivityRendering.e2e.test.tsx +150 -0
  83. package/src/v2/components/chat/__tests__/CopilotChatAssistantMessage.slots.e2e.test.tsx +624 -0
  84. package/src/v2/components/chat/__tests__/CopilotChatAssistantMessage.test.tsx +702 -0
  85. package/src/v2/components/chat/__tests__/CopilotChatCssClasses.test.tsx +107 -0
  86. package/src/v2/components/chat/__tests__/CopilotChatInput.slots.e2e.test.tsx +929 -0
  87. package/src/v2/components/chat/__tests__/CopilotChatInput.test.tsx +986 -0
  88. package/src/v2/components/chat/__tests__/CopilotChatMessageView.slots.e2e.test.tsx +1004 -0
  89. package/src/v2/components/chat/__tests__/CopilotChatMessageView.test.tsx +169 -0
  90. package/src/v2/components/chat/__tests__/CopilotChatSuggestionView.slots.e2e.test.tsx +530 -0
  91. package/src/v2/components/chat/__tests__/CopilotChatToolRendering.e2e.test.tsx +782 -0
  92. package/src/v2/components/chat/__tests__/CopilotChatToolRerenders.e2e.test.tsx +2413 -0
  93. package/src/v2/components/chat/__tests__/CopilotChatUserMessage.slots.e2e.test.tsx +621 -0
  94. package/src/v2/components/chat/__tests__/CopilotChatView.onClick.e2e.test.tsx +853 -0
  95. package/src/v2/components/chat/__tests__/CopilotChatView.slots.e2e.test.tsx +1050 -0
  96. package/src/v2/components/chat/__tests__/CopilotModalHeader.slots.e2e.test.tsx +484 -0
  97. package/src/v2/components/chat/__tests__/CopilotPopupView.slots.e2e.test.tsx +612 -0
  98. package/src/v2/components/chat/__tests__/CopilotSidebarView.slots.e2e.test.tsx +502 -0
  99. package/src/v2/components/chat/__tests__/MCPAppsActivityRenderer.e2e.test.tsx +1011 -0
  100. package/src/v2/components/chat/__tests__/setup.ts +1 -0
  101. package/src/v2/components/chat/index.ts +79 -0
  102. package/src/v2/components/index.ts +7 -0
  103. package/src/v2/components/license-warning-banner.tsx +198 -0
  104. package/src/v2/components/ui/button.tsx +123 -0
  105. package/src/v2/components/ui/dropdown-menu.tsx +258 -0
  106. package/src/v2/components/ui/tooltip.tsx +60 -0
  107. package/src/v2/hooks/__tests__/standard-schema-types.test.tsx +152 -0
  108. package/src/v2/hooks/__tests__/standard-schema.test.tsx +282 -0
  109. package/src/v2/hooks/__tests__/use-agent-context-timing.e2e.test.tsx +132 -0
  110. package/src/v2/hooks/__tests__/use-agent-context.test.tsx +401 -0
  111. package/src/v2/hooks/__tests__/use-agent-error-state.test.tsx +44 -0
  112. package/src/v2/hooks/__tests__/use-agent-stability.test.tsx +205 -0
  113. package/src/v2/hooks/__tests__/use-agent.e2e.test.tsx +148 -0
  114. package/src/v2/hooks/__tests__/use-component.test.tsx +123 -0
  115. package/src/v2/hooks/__tests__/use-configure-suggestions.e2e.test.tsx +696 -0
  116. package/src/v2/hooks/__tests__/use-default-render-tool.test.tsx +153 -0
  117. package/src/v2/hooks/__tests__/use-frontend-tool-available.test.tsx +167 -0
  118. package/src/v2/hooks/__tests__/use-frontend-tool.e2e.test.tsx +2129 -0
  119. package/src/v2/hooks/__tests__/use-human-in-the-loop.e2e.test.tsx +1261 -0
  120. package/src/v2/hooks/__tests__/use-interrupt.test.tsx +397 -0
  121. package/src/v2/hooks/__tests__/use-katex-styles.test.tsx +56 -0
  122. package/src/v2/hooks/__tests__/use-keyboard-height.test.tsx +192 -0
  123. package/src/v2/hooks/__tests__/use-render-tool.test.tsx +259 -0
  124. package/src/v2/hooks/__tests__/use-suggestions.e2e.test.tsx +524 -0
  125. package/src/v2/hooks/__tests__/use-threads.test.tsx +433 -0
  126. package/src/v2/hooks/__tests__/zod-regression.test.tsx +311 -0
  127. package/src/v2/hooks/index.ts +18 -0
  128. package/src/v2/hooks/use-agent-context.tsx +45 -0
  129. package/src/v2/hooks/use-agent.tsx +155 -0
  130. package/src/v2/hooks/use-component.tsx +89 -0
  131. package/src/v2/hooks/use-configure-suggestions.tsx +187 -0
  132. package/src/v2/hooks/use-default-render-tool.tsx +254 -0
  133. package/src/v2/hooks/use-frontend-tool.tsx +43 -0
  134. package/src/v2/hooks/use-human-in-the-loop.tsx +81 -0
  135. package/src/v2/hooks/use-interrupt.tsx +305 -0
  136. package/src/v2/hooks/use-keyboard-height.tsx +67 -0
  137. package/src/v2/hooks/use-render-activity-message.tsx +73 -0
  138. package/src/v2/hooks/use-render-custom-messages.tsx +93 -0
  139. package/src/v2/hooks/use-render-tool-call.tsx +175 -0
  140. package/src/v2/hooks/use-render-tool.tsx +181 -0
  141. package/src/v2/hooks/use-suggestions.tsx +91 -0
  142. package/src/v2/hooks/use-threads.tsx +256 -0
  143. package/src/v2/hooks/useKatexStyles.ts +27 -0
  144. package/src/v2/index.css +1 -1
  145. package/src/v2/index.ts +18 -2
  146. package/src/v2/lib/__tests__/completePartialMarkdown.test.ts +495 -0
  147. package/src/v2/lib/__tests__/renderSlot.test.tsx +588 -0
  148. package/src/v2/lib/react-core.ts +156 -0
  149. package/src/v2/lib/slots.tsx +143 -0
  150. package/src/v2/lib/transcription-client.ts +184 -0
  151. package/src/v2/lib/utils.ts +8 -0
  152. package/src/v2/providers/CopilotChatConfigurationProvider.tsx +162 -0
  153. package/src/v2/providers/CopilotKitProvider.tsx +600 -0
  154. package/src/v2/providers/__tests__/CopilotChatConfigurationProvider.test.tsx +546 -0
  155. package/src/v2/providers/__tests__/CopilotKitProvider.license.test.tsx +101 -0
  156. package/src/v2/providers/__tests__/CopilotKitProvider.onError.test.tsx +69 -0
  157. package/src/v2/providers/__tests__/CopilotKitProvider.renderCustomMessages.e2e.test.tsx +881 -0
  158. package/src/v2/providers/__tests__/CopilotKitProvider.stability.test.tsx +740 -0
  159. package/src/v2/providers/__tests__/CopilotKitProvider.test.tsx +642 -0
  160. package/src/v2/providers/__tests__/CopilotKitProvider.wildcard.test.tsx +294 -0
  161. package/src/v2/providers/index.ts +14 -0
  162. package/src/v2/styles/globals.css +230 -0
  163. package/src/v2/types/__tests__/defineToolCallRenderer.test.tsx +525 -0
  164. package/src/v2/types/defineToolCallRenderer.ts +65 -0
  165. package/src/v2/types/frontend-tool.ts +8 -0
  166. package/src/v2/types/human-in-the-loop.ts +33 -0
  167. package/src/v2/types/index.ts +7 -0
  168. package/src/v2/types/interrupt.ts +15 -0
  169. package/src/v2/types/react-activity-message-renderer.ts +27 -0
  170. package/src/v2/types/react-custom-message-renderer.ts +17 -0
  171. package/src/v2/types/react-tool-call-renderer.ts +32 -0
  172. package/tsdown.config.ts +34 -10
  173. package/vitest.config.mjs +4 -3
  174. package/LICENSE +0 -21
  175. package/dist/copilotkit-BRPQ2sqS.d.cts +0 -670
  176. package/dist/copilotkit-BRPQ2sqS.d.cts.map +0 -1
  177. package/dist/copilotkit-C94ayZbs.cjs +0 -2161
  178. package/dist/copilotkit-C94ayZbs.cjs.map +0 -1
  179. package/dist/copilotkit-CwZMFmSK.d.mts +0 -670
  180. package/dist/copilotkit-CwZMFmSK.d.mts.map +0 -1
  181. package/dist/copilotkit-Yh_Ld_FX.mjs +0 -2031
  182. package/dist/copilotkit-Yh_Ld_FX.mjs.map +0 -1
  183. package/dist/v2/index.css.map +0 -1
@@ -0,0 +1,881 @@
1
+ import React from "react";
2
+ import { fireEvent, screen, waitFor } from "@testing-library/react";
3
+ import {
4
+ MockStepwiseAgent,
5
+ renderWithCopilotKit,
6
+ runStartedEvent,
7
+ runFinishedEvent,
8
+ stateSnapshotEvent,
9
+ testId,
10
+ textMessageStartEvent,
11
+ textMessageContentEvent,
12
+ textMessageEndEvent,
13
+ } from "../../__tests__/utils/test-helpers";
14
+ import { ReactCustomMessageRenderer } from "../../types/react-custom-message-renderer";
15
+ import { useCopilotKit } from "../../providers/CopilotKitProvider";
16
+ import { useCopilotChatConfiguration } from "../../providers/CopilotChatConfigurationProvider";
17
+ import { useAgent } from "../../hooks/use-agent";
18
+ import { CopilotKitCoreReact } from "../../lib/react-core";
19
+ import { Message } from "@ag-ui/core";
20
+
21
+ // Test shim: some environments lack setCredentials on CopilotKitCoreReact.
22
+ if (!(CopilotKitCoreReact.prototype as any).setCredentials) {
23
+ (CopilotKitCoreReact.prototype as any).setCredentials = () => {};
24
+ }
25
+
26
+ type SnapshotRendererProps = {
27
+ message: Message;
28
+ position: "before" | "after";
29
+ runId: string;
30
+ messageIndex: number;
31
+ messageIndexInRun: number;
32
+ numberOfMessagesInRun: number;
33
+ agentId: string;
34
+ stateSnapshot: any;
35
+ };
36
+
37
+ const SnapshotRenderer: React.FC<SnapshotRendererProps> = ({
38
+ position,
39
+ message,
40
+ runId,
41
+ stateSnapshot,
42
+ }) => {
43
+ if (position !== "after" || message.role !== "assistant") {
44
+ return null;
45
+ }
46
+
47
+ const { copilotkit } = useCopilotKit();
48
+ const config = useCopilotChatConfiguration();
49
+ const typedSnapshot = stateSnapshot as { history?: number[] } | undefined;
50
+ const runHistory = typedSnapshot?.history ?? [];
51
+
52
+ let count: number | undefined;
53
+ if (config) {
54
+ const runIds = copilotkit.getRunIdsForThread(
55
+ config.agentId,
56
+ config.threadId,
57
+ );
58
+ const runIndex = runIds.indexOf(runId);
59
+ if (runIndex >= 0 && runIndex < runHistory.length) {
60
+ count = runHistory[runIndex];
61
+ }
62
+ }
63
+
64
+ if (count === undefined) {
65
+ count = runHistory[runHistory.length - 1];
66
+ }
67
+
68
+ return (
69
+ <div data-testid={`state-${message.id}`} data-run-id={runId}>
70
+ State: {count ?? "null"}
71
+ </div>
72
+ );
73
+ };
74
+
75
+ const LiveStateRenderer: React.FC<SnapshotRendererProps> = ({
76
+ messageIndexInRun,
77
+ position,
78
+ }) => {
79
+ const { agent } = useAgent();
80
+ const currentStep = (agent?.state as { current_step?: string } | undefined)
81
+ ?.current_step;
82
+
83
+ if (position !== "after") {
84
+ return null;
85
+ }
86
+ if (messageIndexInRun !== 0) {
87
+ return null;
88
+ }
89
+ if (!currentStep) {
90
+ return null;
91
+ }
92
+
93
+ return <div data-testid="live-step">{currentStep}</div>;
94
+ };
95
+
96
+ describe("CopilotKitProvider custom message renderers E2E", () => {
97
+ it("renders state snapshots before assistant text starts", async () => {
98
+ const agent = new MockStepwiseAgent();
99
+
100
+ const customRenderer: ReactCustomMessageRenderer = {
101
+ render: LiveStateRenderer,
102
+ };
103
+
104
+ renderWithCopilotKit({
105
+ agent,
106
+ renderCustomMessages: [customRenderer],
107
+ });
108
+
109
+ const input = await screen.findByRole("textbox");
110
+
111
+ fireEvent.change(input, { target: { value: "Who am I?" } });
112
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
113
+
114
+ await waitFor(() => {
115
+ expect(screen.getByText("Who am I?")).toBeDefined();
116
+ });
117
+
118
+ agent.emit(runStartedEvent());
119
+ agent.emit(stateSnapshotEvent({ current_step: "Processing..." }));
120
+
121
+ await waitFor(() => {
122
+ expect(screen.getByTestId("live-step").textContent).toContain(
123
+ "Processing...",
124
+ );
125
+ });
126
+ });
127
+
128
+ it("renders stored state snapshots for sequential runs", async () => {
129
+ const agent = new MockStepwiseAgent();
130
+ const history: number[] = [];
131
+
132
+ const emitSnapshot = (count: number) => {
133
+ history.push(count);
134
+ agent.emit(stateSnapshotEvent({ history: [...history] }));
135
+ };
136
+
137
+ const customRenderer: ReactCustomMessageRenderer = {
138
+ render: SnapshotRenderer,
139
+ };
140
+
141
+ renderWithCopilotKit({
142
+ agent,
143
+ renderCustomMessages: [customRenderer],
144
+ });
145
+
146
+ const input = await screen.findByRole("textbox");
147
+
148
+ const firstAssistantId = testId("assistant-message");
149
+ fireEvent.change(input, { target: { value: "First question" } });
150
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
151
+
152
+ await waitFor(() => {
153
+ expect(screen.getByText("First question")).toBeDefined();
154
+ });
155
+
156
+ agent.emit(runStartedEvent());
157
+ emitSnapshot(1);
158
+ agent.emit(textMessageStartEvent(firstAssistantId));
159
+ agent.emit(textMessageContentEvent(firstAssistantId, "First answer"));
160
+ agent.emit(textMessageEndEvent(firstAssistantId));
161
+ agent.emit(runFinishedEvent());
162
+
163
+ await waitFor(() => {
164
+ expect(
165
+ screen.getByTestId(`state-${firstAssistantId}`).textContent,
166
+ ).toContain("State: 1");
167
+ });
168
+ const firstRunId = screen
169
+ .getByTestId(`state-${firstAssistantId}`)
170
+ .getAttribute("data-run-id");
171
+ expect(firstRunId).toBeTruthy();
172
+
173
+ const secondAssistantId = testId("assistant-message");
174
+ fireEvent.change(input, { target: { value: "Second question" } });
175
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
176
+
177
+ await waitFor(() => {
178
+ expect(screen.getByText("Second question")).toBeDefined();
179
+ });
180
+
181
+ agent.emit(runStartedEvent());
182
+ emitSnapshot(2);
183
+ agent.emit(textMessageStartEvent(secondAssistantId));
184
+ agent.emit(textMessageContentEvent(secondAssistantId, "Second answer"));
185
+ agent.emit(textMessageEndEvent(secondAssistantId));
186
+ agent.emit(runFinishedEvent());
187
+ agent.complete();
188
+
189
+ await waitFor(() => {
190
+ expect(
191
+ screen.getByTestId(`state-${secondAssistantId}`).textContent,
192
+ ).toContain("State: 2");
193
+ });
194
+ const secondRunId = screen
195
+ .getByTestId(`state-${secondAssistantId}`)
196
+ .getAttribute("data-run-id");
197
+
198
+ expect(secondRunId).not.toBe(firstRunId);
199
+
200
+ const firstRunIdAfterSecond = screen
201
+ .getByTestId(`state-${firstAssistantId}`)
202
+ .getAttribute("data-run-id");
203
+ expect(firstRunIdAfterSecond).toBe(firstRunId);
204
+
205
+ expect(
206
+ screen.getByTestId(`state-${firstAssistantId}`).textContent,
207
+ ).toContain("State: 1");
208
+ });
209
+
210
+ it("renders only at specified position (before vs after)", async () => {
211
+ const agent = new MockStepwiseAgent();
212
+ const positions: string[] = [];
213
+
214
+ const PositionRenderer: React.FC<SnapshotRendererProps> = ({
215
+ position,
216
+ message,
217
+ }) => {
218
+ positions.push(position);
219
+ return (
220
+ <div data-testid={`${position}-${message.id}`}>
221
+ {position}: {message.role}
222
+ </div>
223
+ );
224
+ };
225
+
226
+ renderWithCopilotKit({
227
+ agent,
228
+ renderCustomMessages: [{ render: PositionRenderer }],
229
+ });
230
+
231
+ const input = await screen.findByRole("textbox");
232
+ const messageId = testId("message");
233
+
234
+ fireEvent.change(input, { target: { value: "Test" } });
235
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
236
+
237
+ await waitFor(() => {
238
+ expect(screen.getByText("Test")).toBeDefined();
239
+ });
240
+
241
+ agent.emit(runStartedEvent());
242
+ agent.emit(textMessageStartEvent(messageId));
243
+ agent.emit(textMessageContentEvent(messageId, "Response"));
244
+ agent.emit(textMessageEndEvent(messageId));
245
+ agent.emit(runFinishedEvent());
246
+
247
+ await waitFor(() => {
248
+ expect(screen.getByTestId(`before-${messageId}`)).toBeDefined();
249
+ expect(screen.getByTestId(`after-${messageId}`)).toBeDefined();
250
+ });
251
+
252
+ expect(screen.getByTestId(`before-${messageId}`).textContent).toBe(
253
+ "before: assistant",
254
+ );
255
+ expect(screen.getByTestId(`after-${messageId}`).textContent).toBe(
256
+ "after: assistant",
257
+ );
258
+
259
+ // Verify renderer was called for both positions
260
+ expect(positions).toContain("before");
261
+ expect(positions).toContain("after");
262
+ });
263
+
264
+ it("filters by message role correctly", async () => {
265
+ const agent = new MockStepwiseAgent();
266
+
267
+ const AssistantOnlyRenderer: React.FC<SnapshotRendererProps> = ({
268
+ message,
269
+ position,
270
+ }) => {
271
+ if (message.role !== "assistant" || position !== "after") return null;
272
+ return (
273
+ <div data-testid={`assistant-badge-${message.id}`}>AI Response</div>
274
+ );
275
+ };
276
+
277
+ renderWithCopilotKit({
278
+ agent,
279
+ renderCustomMessages: [{ render: AssistantOnlyRenderer }],
280
+ });
281
+
282
+ const input = await screen.findByRole("textbox");
283
+ const assistantId = testId("assistant");
284
+
285
+ fireEvent.change(input, { target: { value: "User message" } });
286
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
287
+
288
+ await waitFor(() => {
289
+ expect(screen.getByText("User message")).toBeDefined();
290
+ });
291
+
292
+ // User message should not have the badge
293
+ const userMessages = screen.queryAllByTestId(/^assistant-badge-/);
294
+ expect(userMessages.length).toBe(0);
295
+
296
+ agent.emit(runStartedEvent());
297
+ agent.emit(textMessageStartEvent(assistantId));
298
+ agent.emit(textMessageContentEvent(assistantId, "AI response"));
299
+ agent.emit(textMessageEndEvent(assistantId));
300
+ agent.emit(runFinishedEvent());
301
+
302
+ // Assistant message should have the badge
303
+ await waitFor(() => {
304
+ expect(
305
+ screen.getByTestId(`assistant-badge-${assistantId}`),
306
+ ).toBeDefined();
307
+ });
308
+ });
309
+
310
+ it("executes multiple renderers in order", async () => {
311
+ const agent = new MockStepwiseAgent();
312
+ const executionOrder: string[] = [];
313
+
314
+ const FirstRenderer: React.FC<SnapshotRendererProps> = ({
315
+ message,
316
+ position,
317
+ }) => {
318
+ if (position !== "after" || message.role !== "assistant") return null;
319
+ executionOrder.push("first");
320
+ return <div data-testid={`first-${message.id}`}>First</div>;
321
+ };
322
+
323
+ const SecondRenderer: React.FC<SnapshotRendererProps> = ({
324
+ message,
325
+ position,
326
+ }) => {
327
+ if (position !== "after" || message.role !== "assistant") return null;
328
+ executionOrder.push("second");
329
+ return <div data-testid={`second-${message.id}`}>Second</div>;
330
+ };
331
+
332
+ renderWithCopilotKit({
333
+ agent,
334
+ renderCustomMessages: [
335
+ { render: FirstRenderer },
336
+ { render: SecondRenderer },
337
+ ],
338
+ });
339
+
340
+ const input = await screen.findByRole("textbox");
341
+ const messageId = testId("message");
342
+
343
+ fireEvent.change(input, { target: { value: "Test" } });
344
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
345
+
346
+ await waitFor(() => {
347
+ expect(screen.getByText("Test")).toBeDefined();
348
+ });
349
+
350
+ agent.emit(runStartedEvent());
351
+ agent.emit(textMessageStartEvent(messageId));
352
+ agent.emit(textMessageContentEvent(messageId, "Response"));
353
+ agent.emit(textMessageEndEvent(messageId));
354
+ agent.emit(runFinishedEvent());
355
+
356
+ await waitFor(() => {
357
+ expect(screen.getByTestId(`first-${messageId}`)).toBeDefined();
358
+ });
359
+
360
+ // Only first renderer should execute since it returns a result
361
+ expect(executionOrder).toEqual(["first"]);
362
+ expect(screen.queryByTestId(`second-${messageId}`)).toBeNull();
363
+ });
364
+
365
+ it("respects agent-scoped renderers", async () => {
366
+ const agent1 = new MockStepwiseAgent();
367
+ const agent2 = new MockStepwiseAgent();
368
+
369
+ const Agent1Renderer: React.FC<SnapshotRendererProps> = ({
370
+ message,
371
+ position,
372
+ }) => {
373
+ if (position !== "after" || message.role !== "assistant") return null;
374
+ return <div data-testid={`agent1-badge-${message.id}`}>Agent 1</div>;
375
+ };
376
+
377
+ const Agent2Renderer: React.FC<SnapshotRendererProps> = ({
378
+ message,
379
+ position,
380
+ }) => {
381
+ if (position !== "after" || message.role !== "assistant") return null;
382
+ return <div data-testid={`agent2-badge-${message.id}`}>Agent 2</div>;
383
+ };
384
+
385
+ renderWithCopilotKit({
386
+ agents: { agent1: agent1, agent2: agent2 },
387
+ agentId: "agent1",
388
+ renderCustomMessages: [
389
+ { agentId: "agent1", render: Agent1Renderer },
390
+ { agentId: "agent2", render: Agent2Renderer },
391
+ ],
392
+ });
393
+
394
+ const input = await screen.findByRole("textbox");
395
+ const messageId = testId("message");
396
+
397
+ fireEvent.change(input, { target: { value: "Test" } });
398
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
399
+
400
+ await waitFor(() => {
401
+ expect(screen.getByText("Test")).toBeDefined();
402
+ });
403
+
404
+ agent1.emit(runStartedEvent());
405
+ agent1.emit(textMessageStartEvent(messageId));
406
+ agent1.emit(textMessageContentEvent(messageId, "Response"));
407
+ agent1.emit(textMessageEndEvent(messageId));
408
+ agent1.emit(runFinishedEvent());
409
+
410
+ await waitFor(() => {
411
+ expect(screen.getByTestId(`agent1-badge-${messageId}`)).toBeDefined();
412
+ });
413
+
414
+ // Agent2's renderer should not execute for agent1's messages
415
+ expect(screen.queryByTestId(`agent2-badge-${messageId}`)).toBeNull();
416
+ });
417
+
418
+ it("prioritizes agent-specific renderers over global renderers", async () => {
419
+ const agent = new MockStepwiseAgent();
420
+
421
+ const GlobalRenderer: React.FC<SnapshotRendererProps> = ({
422
+ message,
423
+ position,
424
+ }) => {
425
+ if (position !== "after" || message.role !== "assistant") return null;
426
+ return <div data-testid={`global-${message.id}`}>Global</div>;
427
+ };
428
+
429
+ const SpecificRenderer: React.FC<SnapshotRendererProps> = ({
430
+ message,
431
+ position,
432
+ }) => {
433
+ if (position !== "after" || message.role !== "assistant") return null;
434
+ return <div data-testid={`specific-${message.id}`}>Specific</div>;
435
+ };
436
+
437
+ const agentId = "specific-agent";
438
+
439
+ renderWithCopilotKit({
440
+ agents: { [agentId]: agent },
441
+ agentId,
442
+ renderCustomMessages: [
443
+ { render: GlobalRenderer },
444
+ { agentId, render: SpecificRenderer },
445
+ ],
446
+ });
447
+
448
+ const input = await screen.findByRole("textbox");
449
+ const messageId = testId("message");
450
+
451
+ fireEvent.change(input, { target: { value: "Test" } });
452
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
453
+
454
+ await waitFor(() => {
455
+ expect(screen.getByText("Test")).toBeDefined();
456
+ });
457
+
458
+ agent.emit(runStartedEvent());
459
+ agent.emit(textMessageStartEvent(messageId));
460
+ agent.emit(textMessageContentEvent(messageId, "Response"));
461
+ agent.emit(textMessageEndEvent(messageId));
462
+ agent.emit(runFinishedEvent());
463
+
464
+ await waitFor(() => {
465
+ expect(screen.getByTestId(`specific-${messageId}`)).toBeDefined();
466
+ });
467
+
468
+ // Global renderer should not execute since specific one takes precedence
469
+ expect(screen.queryByTestId(`global-${messageId}`)).toBeNull();
470
+ });
471
+
472
+ it("handles missing state snapshots gracefully", async () => {
473
+ const agent = new MockStepwiseAgent();
474
+
475
+ const StateRenderer: React.FC<SnapshotRendererProps> = ({
476
+ message,
477
+ position,
478
+ stateSnapshot,
479
+ }) => {
480
+ if (position !== "after" || message.role !== "assistant") return null;
481
+ return (
482
+ <div data-testid={`state-${message.id}`}>
483
+ {stateSnapshot ? JSON.stringify(stateSnapshot) : "no-state"}
484
+ </div>
485
+ );
486
+ };
487
+
488
+ renderWithCopilotKit({
489
+ agent,
490
+ renderCustomMessages: [{ render: StateRenderer }],
491
+ });
492
+
493
+ const input = await screen.findByRole("textbox");
494
+ const messageId = testId("message");
495
+
496
+ fireEvent.change(input, { target: { value: "Test" } });
497
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
498
+
499
+ await waitFor(() => {
500
+ expect(screen.getByText("Test")).toBeDefined();
501
+ });
502
+
503
+ // Don't emit state snapshot
504
+ agent.emit(runStartedEvent());
505
+ agent.emit(textMessageStartEvent(messageId));
506
+ agent.emit(textMessageContentEvent(messageId, "Response"));
507
+ agent.emit(textMessageEndEvent(messageId));
508
+ agent.emit(runFinishedEvent());
509
+
510
+ await waitFor(() => {
511
+ expect(screen.getByTestId(`state-${messageId}`)).toBeDefined();
512
+ });
513
+
514
+ expect(screen.getByTestId(`state-${messageId}`).textContent).toBe(
515
+ "no-state",
516
+ );
517
+ });
518
+
519
+ it("provides correct message index properties", async () => {
520
+ const agent = new MockStepwiseAgent();
521
+ let capturedProps: {
522
+ messageIndex?: number;
523
+ messageIndexInRun?: number;
524
+ numberOfMessagesInRun?: number;
525
+ } | null = null;
526
+
527
+ const IndexRenderer: React.FC<SnapshotRendererProps> = (props) => {
528
+ const {
529
+ message,
530
+ position,
531
+ messageIndex,
532
+ messageIndexInRun,
533
+ numberOfMessagesInRun,
534
+ } = props;
535
+ if (position !== "after" || message.role !== "assistant") return null;
536
+
537
+ capturedProps = {
538
+ messageIndex,
539
+ messageIndexInRun,
540
+ numberOfMessagesInRun,
541
+ };
542
+
543
+ return (
544
+ <div data-testid={`index-${message.id}`}>
545
+ {messageIndex}/{messageIndexInRun}/{numberOfMessagesInRun}
546
+ </div>
547
+ );
548
+ };
549
+
550
+ renderWithCopilotKit({
551
+ agent,
552
+ renderCustomMessages: [{ render: IndexRenderer }],
553
+ });
554
+
555
+ const input = await screen.findByRole("textbox");
556
+ const msg1 = testId("msg1");
557
+ const msg2 = testId("msg2");
558
+
559
+ // First exchange
560
+ fireEvent.change(input, { target: { value: "First" } });
561
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
562
+
563
+ await waitFor(() => {
564
+ expect(screen.getByText("First")).toBeDefined();
565
+ });
566
+
567
+ agent.emit(runStartedEvent());
568
+ agent.emit(textMessageStartEvent(msg1));
569
+ agent.emit(textMessageContentEvent(msg1, "Response 1"));
570
+ agent.emit(textMessageEndEvent(msg1));
571
+ agent.emit(runFinishedEvent());
572
+
573
+ await waitFor(() => {
574
+ expect(screen.getByTestId(`index-${msg1}`)).toBeDefined();
575
+ });
576
+
577
+ // Second exchange
578
+ fireEvent.change(input, { target: { value: "Second" } });
579
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
580
+
581
+ await waitFor(() => {
582
+ expect(screen.getByText("Second")).toBeDefined();
583
+ });
584
+
585
+ agent.emit(runStartedEvent());
586
+ agent.emit(textMessageStartEvent(msg2));
587
+ agent.emit(textMessageContentEvent(msg2, "Response 2"));
588
+ agent.emit(textMessageEndEvent(msg2));
589
+ agent.emit(runFinishedEvent());
590
+
591
+ await waitFor(() => {
592
+ expect(screen.getByTestId(`index-${msg2}`)).toBeDefined();
593
+ });
594
+
595
+ // Verify the captured props are meaningful
596
+ expect(capturedProps).toBeTruthy();
597
+ if (!capturedProps) {
598
+ throw new Error("Expected capturedProps to be set");
599
+ }
600
+ const props = capturedProps as {
601
+ messageIndex: number;
602
+ messageIndexInRun: number;
603
+ numberOfMessagesInRun: number;
604
+ };
605
+ expect(typeof props.messageIndex).toBe("number");
606
+ expect(typeof props.messageIndexInRun).toBe("number");
607
+ expect(typeof props.numberOfMessagesInRun).toBe("number");
608
+ });
609
+
610
+ it("works across multi-turn conversations", async () => {
611
+ const agent = new MockStepwiseAgent();
612
+
613
+ const TurnCounter: React.FC<SnapshotRendererProps> = ({
614
+ message,
615
+ position,
616
+ stateSnapshot,
617
+ }) => {
618
+ if (position !== "after" || message.role !== "assistant") return null;
619
+ const snapshot = stateSnapshot as { turn?: number } | undefined;
620
+ const turn = snapshot?.turn ?? 0;
621
+ return <div data-testid={`turn-${message.id}`}>Turn: {turn}</div>;
622
+ };
623
+
624
+ renderWithCopilotKit({
625
+ agent,
626
+ renderCustomMessages: [{ render: TurnCounter }],
627
+ });
628
+
629
+ const input = await screen.findByRole("textbox");
630
+
631
+ // Turn 1
632
+ const msg1 = testId("msg1");
633
+ fireEvent.change(input, { target: { value: "Turn 1" } });
634
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
635
+
636
+ await waitFor(() => {
637
+ expect(screen.getByText("Turn 1")).toBeDefined();
638
+ });
639
+
640
+ agent.emit(runStartedEvent());
641
+ agent.emit(stateSnapshotEvent({ turn: 1 }));
642
+ agent.emit(textMessageStartEvent(msg1));
643
+ agent.emit(textMessageContentEvent(msg1, "Response 1"));
644
+ agent.emit(textMessageEndEvent(msg1));
645
+ agent.emit(runFinishedEvent());
646
+
647
+ await waitFor(() => {
648
+ expect(screen.getByTestId(`turn-${msg1}`).textContent).toBe("Turn: 1");
649
+ });
650
+
651
+ // Turn 2
652
+ const msg2 = testId("msg2");
653
+ fireEvent.change(input, { target: { value: "Turn 2" } });
654
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
655
+
656
+ await waitFor(() => {
657
+ expect(screen.getByText("Turn 2")).toBeDefined();
658
+ });
659
+
660
+ agent.emit(runStartedEvent());
661
+ agent.emit(stateSnapshotEvent({ turn: 2 }));
662
+ agent.emit(textMessageStartEvent(msg2));
663
+ agent.emit(textMessageContentEvent(msg2, "Response 2"));
664
+ agent.emit(textMessageEndEvent(msg2));
665
+ agent.emit(runFinishedEvent());
666
+
667
+ await waitFor(() => {
668
+ expect(screen.getByTestId(`turn-${msg2}`).textContent).toBe("Turn: 2");
669
+ });
670
+
671
+ // Turn 3
672
+ const msg3 = testId("msg3");
673
+ fireEvent.change(input, { target: { value: "Turn 3" } });
674
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
675
+
676
+ await waitFor(() => {
677
+ expect(screen.getByText("Turn 3")).toBeDefined();
678
+ });
679
+
680
+ agent.emit(runStartedEvent());
681
+ agent.emit(stateSnapshotEvent({ turn: 3 }));
682
+ agent.emit(textMessageStartEvent(msg3));
683
+ agent.emit(textMessageContentEvent(msg3, "Response 3"));
684
+ agent.emit(textMessageEndEvent(msg3));
685
+ agent.emit(runFinishedEvent());
686
+
687
+ await waitFor(() => {
688
+ expect(screen.getByTestId(`turn-${msg3}`).textContent).toBe("Turn: 3");
689
+ });
690
+
691
+ // Verify the renderer works across multiple turns
692
+ // All messages should have turn counters rendered
693
+ expect(screen.getByTestId(`turn-${msg1}`)).toBeDefined();
694
+ expect(screen.getByTestId(`turn-${msg2}`)).toBeDefined();
695
+ expect(screen.getByTestId(`turn-${msg3}`)).toBeDefined();
696
+ });
697
+
698
+ it("handles renderers returning null without breaking", async () => {
699
+ const agent = new MockStepwiseAgent();
700
+
701
+ const NullRenderer: React.FC<SnapshotRendererProps> = () => {
702
+ return null;
703
+ };
704
+
705
+ const FallbackRenderer: React.FC<SnapshotRendererProps> = ({
706
+ message,
707
+ position,
708
+ }) => {
709
+ if (position !== "after" || message.role !== "assistant") return null;
710
+ return <div data-testid={`fallback-${message.id}`}>Fallback</div>;
711
+ };
712
+
713
+ renderWithCopilotKit({
714
+ agent,
715
+ renderCustomMessages: [
716
+ { render: NullRenderer },
717
+ { render: FallbackRenderer },
718
+ ],
719
+ });
720
+
721
+ const input = await screen.findByRole("textbox");
722
+ const messageId = testId("message");
723
+
724
+ fireEvent.change(input, { target: { value: "Test" } });
725
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
726
+
727
+ await waitFor(() => {
728
+ expect(screen.getByText("Test")).toBeDefined();
729
+ });
730
+
731
+ agent.emit(runStartedEvent());
732
+ agent.emit(textMessageStartEvent(messageId));
733
+ agent.emit(textMessageContentEvent(messageId, "Response"));
734
+ agent.emit(textMessageEndEvent(messageId));
735
+ agent.emit(runFinishedEvent());
736
+
737
+ // First renderer returns null, so second should not execute (first one doesn't break the chain)
738
+ await waitFor(() => {
739
+ const fallback = screen.queryByTestId(`fallback-${messageId}`);
740
+ expect(fallback).toBeNull();
741
+ });
742
+ });
743
+
744
+ it("re-renders custom message when state updates within the same run", async () => {
745
+ const agent = new MockStepwiseAgent();
746
+
747
+ const StateCountRenderer: React.FC<SnapshotRendererProps> = ({
748
+ message,
749
+ position,
750
+ stateSnapshot,
751
+ }) => {
752
+ if (position !== "after" || message.role !== "assistant") return null;
753
+ const snapshot = stateSnapshot as { count?: number } | undefined;
754
+ return (
755
+ <div data-testid={`count-${message.id}`}>
756
+ Count: {snapshot?.count ?? "none"}
757
+ </div>
758
+ );
759
+ };
760
+
761
+ renderWithCopilotKit({
762
+ agent,
763
+ renderCustomMessages: [{ render: StateCountRenderer }],
764
+ });
765
+
766
+ const input = await screen.findByRole("textbox");
767
+ const messageId = testId("message");
768
+
769
+ fireEvent.change(input, { target: { value: "Test" } });
770
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
771
+
772
+ await waitFor(() => {
773
+ expect(screen.getByText("Test")).toBeDefined();
774
+ });
775
+
776
+ // Start run
777
+ agent.emit(runStartedEvent());
778
+
779
+ // Emit message
780
+ agent.emit(textMessageStartEvent(messageId));
781
+ agent.emit(textMessageContentEvent(messageId, "Response"));
782
+ agent.emit(textMessageEndEvent(messageId));
783
+
784
+ // First state update
785
+ agent.emit(stateSnapshotEvent({ count: 1 }));
786
+
787
+ await waitFor(() => {
788
+ expect(screen.getByTestId(`count-${messageId}`).textContent).toBe(
789
+ "Count: 1",
790
+ );
791
+ });
792
+
793
+ // Second state update WITHIN THE SAME RUN
794
+ agent.emit(stateSnapshotEvent({ count: 2 }));
795
+
796
+ // This assertion will FAIL due to the bug - custom message won't re-render
797
+ await waitFor(() => {
798
+ expect(screen.getByTestId(`count-${messageId}`).textContent).toBe(
799
+ "Count: 2",
800
+ );
801
+ });
802
+
803
+ agent.emit(runFinishedEvent());
804
+ });
805
+
806
+ it("receives state snapshots from different runs", async () => {
807
+ const agent = new MockStepwiseAgent();
808
+ const receivedSnapshots: Array<{ messageId: string; count: number }> = [];
809
+
810
+ const CounterRenderer: React.FC<SnapshotRendererProps> = ({
811
+ message,
812
+ position,
813
+ stateSnapshot,
814
+ }) => {
815
+ if (position !== "after" || message.role !== "assistant") return null;
816
+ const snapshot = stateSnapshot as { count?: number } | undefined;
817
+ const count = snapshot?.count ?? 0;
818
+
819
+ // Track what snapshot this message received
820
+ const existing = receivedSnapshots.find(
821
+ (s) => s.messageId === message.id,
822
+ );
823
+ if (!existing) {
824
+ receivedSnapshots.push({ messageId: message.id, count });
825
+ }
826
+
827
+ return <div data-testid={`count-${message.id}`}>Count: {count}</div>;
828
+ };
829
+
830
+ renderWithCopilotKit({
831
+ agent,
832
+ renderCustomMessages: [{ render: CounterRenderer }],
833
+ });
834
+
835
+ const input = await screen.findByRole("textbox");
836
+ const msg1 = testId("msg1");
837
+
838
+ fireEvent.change(input, { target: { value: "First" } });
839
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
840
+
841
+ await waitFor(() => {
842
+ expect(screen.getByText("First")).toBeDefined();
843
+ });
844
+
845
+ agent.emit(runStartedEvent());
846
+ agent.emit(stateSnapshotEvent({ count: 5 }));
847
+ agent.emit(textMessageStartEvent(msg1));
848
+ agent.emit(textMessageContentEvent(msg1, "Response"));
849
+ agent.emit(textMessageEndEvent(msg1));
850
+ agent.emit(runFinishedEvent());
851
+
852
+ await waitFor(() => {
853
+ expect(screen.getByTestId(`count-${msg1}`)).toBeDefined();
854
+ });
855
+
856
+ // Update state in new run
857
+ const msg2 = testId("msg2");
858
+ fireEvent.change(input, { target: { value: "Second" } });
859
+ fireEvent.keyDown(input, { key: "Enter", code: "Enter" });
860
+
861
+ await waitFor(() => {
862
+ expect(screen.getByText("Second")).toBeDefined();
863
+ });
864
+
865
+ agent.emit(runStartedEvent());
866
+ agent.emit(stateSnapshotEvent({ count: 10 }));
867
+ agent.emit(textMessageStartEvent(msg2));
868
+ agent.emit(textMessageContentEvent(msg2, "Response 2"));
869
+ agent.emit(textMessageEndEvent(msg2));
870
+ agent.emit(runFinishedEvent());
871
+
872
+ await waitFor(() => {
873
+ expect(screen.getByTestId(`count-${msg2}`)).toBeDefined();
874
+ });
875
+
876
+ // Verify both messages received state snapshots
877
+ expect(receivedSnapshots.length).toBe(2);
878
+ expect(receivedSnapshots.some((s) => s.messageId === msg1)).toBe(true);
879
+ expect(receivedSnapshots.some((s) => s.messageId === msg2)).toBe(true);
880
+ });
881
+ });