@ulearning/ai-sdk-adapter 0.0.0-stage → 1.0.0-next.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 (210) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +29 -2
  3. package/dist/adapters/aiSDKFormatAdapter.d.ts +6 -0
  4. package/dist/adapters/aiSDKFormatAdapter.d.ts.map +1 -0
  5. package/dist/adapters/aiSDKFormatAdapter.js +17 -0
  6. package/dist/adapters/aiSDKFormatAdapter.js.map +1 -0
  7. package/dist/adapters/vercelAttachmentAdapter.d.ts +3 -0
  8. package/dist/adapters/vercelAttachmentAdapter.d.ts.map +1 -0
  9. package/dist/adapters/vercelAttachmentAdapter.js +36 -0
  10. package/dist/adapters/vercelAttachmentAdapter.js.map +1 -0
  11. package/dist/aiSDKExtras.d.ts +13 -0
  12. package/dist/aiSDKExtras.d.ts.map +1 -0
  13. package/dist/aiSDKExtras.js +6 -0
  14. package/dist/aiSDKExtras.js.map +1 -0
  15. package/dist/converters/convertMessage.d.ts +44 -0
  16. package/dist/converters/convertMessage.d.ts.map +1 -0
  17. package/dist/converters/convertMessage.js +465 -0
  18. package/dist/converters/convertMessage.js.map +1 -0
  19. package/dist/converters/toCreateMessage.d.ts +4 -0
  20. package/dist/converters/toCreateMessage.d.ts.map +1 -0
  21. package/dist/converters/toCreateMessage.js +65 -0
  22. package/dist/converters/toCreateMessage.js.map +1 -0
  23. package/dist/converters/toolApprovalAnswers.d.ts +3 -0
  24. package/dist/converters/toolApprovalAnswers.d.ts.map +1 -0
  25. package/dist/converters/toolApprovalAnswers.js +16 -0
  26. package/dist/converters/toolApprovalAnswers.js.map +1 -0
  27. package/dist/hooks.d.ts +17 -0
  28. package/dist/hooks.d.ts.map +1 -0
  29. package/dist/hooks.js +19 -0
  30. package/dist/hooks.js.map +1 -0
  31. package/dist/index.d.ts +17 -0
  32. package/dist/index.d.ts.map +1 -0
  33. package/dist/index.js +13 -0
  34. package/dist/model-context/injectInteractableContext.d.ts +37 -0
  35. package/dist/model-context/injectInteractableContext.d.ts.map +1 -0
  36. package/dist/model-context/injectInteractableContext.js +54 -0
  37. package/dist/model-context/injectInteractableContext.js.map +1 -0
  38. package/dist/model-context/injectQuoteContext.d.ts +25 -0
  39. package/dist/model-context/injectQuoteContext.d.ts.map +1 -0
  40. package/dist/model-context/injectQuoteContext.js +51 -0
  41. package/dist/model-context/injectQuoteContext.js.map +1 -0
  42. package/dist/runtime/AISDKChat.d.ts +13 -0
  43. package/dist/runtime/AISDKChat.d.ts.map +1 -0
  44. package/dist/runtime/AISDKChat.js +34 -0
  45. package/dist/runtime/AISDKChat.js.map +1 -0
  46. package/dist/runtime/AISDKThreads.d.ts +24 -0
  47. package/dist/runtime/AISDKThreads.d.ts.map +1 -0
  48. package/dist/runtime/AISDKThreads.js +92 -0
  49. package/dist/runtime/AISDKThreads.js.map +1 -0
  50. package/dist/runtime/DynamicChatTransport.d.ts +50 -0
  51. package/dist/runtime/DynamicChatTransport.d.ts.map +1 -0
  52. package/dist/runtime/DynamicChatTransport.js +153 -0
  53. package/dist/runtime/DynamicChatTransport.js.map +1 -0
  54. package/dist/runtime/getResumableAdapter.d.ts +5 -0
  55. package/dist/runtime/getResumableAdapter.d.ts.map +1 -0
  56. package/dist/runtime/getResumableAdapter.js +11 -0
  57. package/dist/runtime/getResumableAdapter.js.map +1 -0
  58. package/dist/runtime/toolHistoryCodec.d.ts +20 -0
  59. package/dist/runtime/toolHistoryCodec.d.ts.map +1 -0
  60. package/dist/runtime/toolHistoryCodec.js +122 -0
  61. package/dist/runtime/toolHistoryCodec.js.map +1 -0
  62. package/dist/runtime/useAISDKRuntime.d.ts +95 -0
  63. package/dist/runtime/useAISDKRuntime.d.ts.map +1 -0
  64. package/dist/runtime/useAISDKRuntime.js +754 -0
  65. package/dist/runtime/useAISDKRuntime.js.map +1 -0
  66. package/dist/runtime/useChatRuntime.d.ts +17 -0
  67. package/dist/runtime/useChatRuntime.d.ts.map +1 -0
  68. package/dist/runtime/useChatRuntime.js +50 -0
  69. package/dist/runtime/useChatRuntime.js.map +1 -0
  70. package/dist/runtime/useChatSnapshot.d.ts +6 -0
  71. package/dist/runtime/useChatSnapshot.d.ts.map +1 -0
  72. package/dist/runtime/useChatSnapshot.js +62 -0
  73. package/dist/runtime/useChatSnapshot.js.map +1 -0
  74. package/dist/runtime/useChatThread.d.ts +121 -0
  75. package/dist/runtime/useChatThread.d.ts.map +1 -0
  76. package/dist/runtime/useChatThread.js +255 -0
  77. package/dist/runtime/useChatThread.js.map +1 -0
  78. package/dist/runtime/useDynamicChatTransport.d.ts +4 -0
  79. package/dist/runtime/useDynamicChatTransport.d.ts.map +1 -0
  80. package/dist/runtime/useDynamicChatTransport.js +26 -0
  81. package/dist/runtime/useDynamicChatTransport.js.map +1 -0
  82. package/dist/runtime/useExternalHistory.d.ts +12 -0
  83. package/dist/runtime/useExternalHistory.d.ts.map +1 -0
  84. package/dist/runtime/useExternalHistory.js +556 -0
  85. package/dist/runtime/useExternalHistory.js.map +1 -0
  86. package/dist/runtime/useMessageQueue.d.ts +14 -0
  87. package/dist/runtime/useMessageQueue.d.ts.map +1 -0
  88. package/dist/runtime/useMessageQueue.js +142 -0
  89. package/dist/runtime/useMessageQueue.js.map +1 -0
  90. package/dist/runtime/useResourceCleanup.d.ts +2 -0
  91. package/dist/runtime/useResourceCleanup.d.ts.map +1 -0
  92. package/dist/runtime/useResourceCleanup.js +47 -0
  93. package/dist/runtime/useResourceCleanup.js.map +1 -0
  94. package/dist/runtime/useStreamingTiming.d.ts +12 -0
  95. package/dist/runtime/useStreamingTiming.d.ts.map +1 -0
  96. package/dist/runtime/useStreamingTiming.js +36 -0
  97. package/dist/runtime/useStreamingTiming.js.map +1 -0
  98. package/dist/tools/generativeTools.d.ts +71 -0
  99. package/dist/tools/generativeTools.d.ts.map +1 -0
  100. package/dist/tools/generativeTools.js +258 -0
  101. package/dist/tools/generativeTools.js.map +1 -0
  102. package/dist/tools/mcp-stdio.node.d.ts +2 -0
  103. package/dist/tools/mcp-stdio.node.d.ts.map +1 -0
  104. package/dist/tools/mcp-stdio.node.js +1 -0
  105. package/dist/tools/mcp-stdio.unsupported.d.ts +3 -0
  106. package/dist/tools/mcp-stdio.unsupported.d.ts.map +1 -0
  107. package/dist/tools/mcp-stdio.unsupported.js +10 -0
  108. package/dist/tools/mcp-stdio.unsupported.js.map +1 -0
  109. package/dist/transport/AssistantChatTransport.d.ts +20 -0
  110. package/dist/transport/AssistantChatTransport.d.ts.map +1 -0
  111. package/dist/transport/AssistantChatTransport.js +151 -0
  112. package/dist/transport/AssistantChatTransport.js.map +1 -0
  113. package/dist/transport/resumable.d.ts +36 -0
  114. package/dist/transport/resumable.d.ts.map +1 -0
  115. package/dist/transport/resumable.js +112 -0
  116. package/dist/transport/resumable.js.map +1 -0
  117. package/dist/usage.d.ts +24 -0
  118. package/dist/usage.d.ts.map +1 -0
  119. package/dist/usage.js +121 -0
  120. package/dist/usage.js.map +1 -0
  121. package/dist/utils/getVercelAIMessages.d.ts +4 -0
  122. package/dist/utils/getVercelAIMessages.d.ts.map +1 -0
  123. package/dist/utils/getVercelAIMessages.js +8 -0
  124. package/dist/utils/getVercelAIMessages.js.map +1 -0
  125. package/dist/utils/sliceMessagesUntil.d.ts +3 -0
  126. package/dist/utils/sliceMessagesUntil.d.ts.map +1 -0
  127. package/dist/utils/sliceMessagesUntil.js +10 -0
  128. package/dist/utils/sliceMessagesUntil.js.map +1 -0
  129. package/package.json +96 -3
  130. package/src/__tests__/standalone.e2e.ts +118 -0
  131. package/src/adapters/aiSDKFormatAdapter.test.ts +36 -0
  132. package/src/adapters/aiSDKFormatAdapter.ts +18 -0
  133. package/src/adapters/vercelAttachmentAdapter.test.ts +52 -0
  134. package/src/adapters/vercelAttachmentAdapter.ts +36 -0
  135. package/src/aiSDKExtras.ts +31 -0
  136. package/src/converters/convertMessage.metadata-key.test.tsx +182 -0
  137. package/src/converters/convertMessage.test.ts +2428 -0
  138. package/src/converters/convertMessage.tool-args-status.test.tsx +185 -0
  139. package/src/converters/convertMessage.ts +919 -0
  140. package/src/converters/toCreateMessage.test.ts +716 -0
  141. package/src/converters/toCreateMessage.ts +110 -0
  142. package/src/converters/toolApprovalAnswers.ts +27 -0
  143. package/src/hooks.test.ts +168 -0
  144. package/src/hooks.ts +26 -0
  145. package/src/index.ts +29 -0
  146. package/src/model-context/injectInteractableContext.test.ts +167 -0
  147. package/src/model-context/injectInteractableContext.ts +64 -0
  148. package/src/model-context/injectQuoteContext.test.ts +33 -0
  149. package/src/model-context/injectQuoteContext.ts +63 -0
  150. package/src/runtime/AISDKChat.artifacts.test.ts +48 -0
  151. package/src/runtime/AISDKChat.integration.test.tsx +148 -0
  152. package/src/runtime/AISDKChat.test.ts +241 -0
  153. package/src/runtime/AISDKChat.ts +43 -0
  154. package/src/runtime/AISDKThreads.test.ts +811 -0
  155. package/src/runtime/AISDKThreads.ts +194 -0
  156. package/src/runtime/DynamicChatTransport.test.ts +228 -0
  157. package/src/runtime/DynamicChatTransport.ts +281 -0
  158. package/src/runtime/__tests__/controlled-transport.ts +70 -0
  159. package/src/runtime/__tests__/tap.ts +80 -0
  160. package/src/runtime/__tests__/vue.ts +46 -0
  161. package/src/runtime/getResumableAdapter.ts +16 -0
  162. package/src/runtime/toolHistoryCodec.test.ts +187 -0
  163. package/src/runtime/toolHistoryCodec.ts +245 -0
  164. package/src/runtime/useAISDKRuntime.approval.integration.test.tsx +1956 -0
  165. package/src/runtime/useAISDKRuntime.approval.test.tsx +580 -0
  166. package/src/runtime/useAISDKRuntime.denied-tool.test.tsx +122 -0
  167. package/src/runtime/useAISDKRuntime.fast-refresh.test.tsx +302 -0
  168. package/src/runtime/useAISDKRuntime.metadata-cache.test.tsx +157 -0
  169. package/src/runtime/useAISDKRuntime.queue.test.tsx +707 -0
  170. package/src/runtime/useAISDKRuntime.reload.test.tsx +217 -0
  171. package/src/runtime/useAISDKRuntime.test.ts +2345 -0
  172. package/src/runtime/useAISDKRuntime.tool-output.test.tsx +113 -0
  173. package/src/runtime/useAISDKRuntime.ts +1503 -0
  174. package/src/runtime/useAISDKRuntime.voice.test.tsx +319 -0
  175. package/src/runtime/useChatOnTap.test.ts +60 -0
  176. package/src/runtime/useChatRuntime.fast-refresh.test.tsx +83 -0
  177. package/src/runtime/useChatRuntime.integration.test.tsx +661 -0
  178. package/src/runtime/useChatRuntime.local-storage.test.tsx +114 -0
  179. package/src/runtime/useChatRuntime.native.test.ts +147 -0
  180. package/src/runtime/useChatRuntime.run-telemetry.test.tsx +226 -0
  181. package/src/runtime/useChatRuntime.test.ts +619 -0
  182. package/src/runtime/useChatRuntime.ts +80 -0
  183. package/src/runtime/useChatSnapshot.test.ts +60 -0
  184. package/src/runtime/useChatSnapshot.ts +86 -0
  185. package/src/runtime/useChatThread.binding.test.tsx +140 -0
  186. package/src/runtime/useChatThread.test.ts +993 -0
  187. package/src/runtime/useChatThread.transport.test.tsx +149 -0
  188. package/src/runtime/useChatThread.ts +533 -0
  189. package/src/runtime/useDynamicChatTransport.ts +26 -0
  190. package/src/runtime/useExternalHistory.test.ts +4187 -0
  191. package/src/runtime/useExternalHistory.ts +902 -0
  192. package/src/runtime/useMessageQueue.effects.test.tsx +88 -0
  193. package/src/runtime/useMessageQueue.test.tsx +256 -0
  194. package/src/runtime/useMessageQueue.ts +189 -0
  195. package/src/runtime/useResourceCleanup.ts +58 -0
  196. package/src/runtime/useStreamingTiming.test.tsx +96 -0
  197. package/src/runtime/useStreamingTiming.ts +69 -0
  198. package/src/tools/generativeTools.test.ts +1058 -0
  199. package/src/tools/generativeTools.ts +491 -0
  200. package/src/tools/mcp-stdio.node.ts +1 -0
  201. package/src/tools/mcp-stdio.unsupported.ts +12 -0
  202. package/src/transport/AssistantChatTransport.test.ts +631 -0
  203. package/src/transport/AssistantChatTransport.ts +236 -0
  204. package/src/transport/resumable.test.ts +262 -0
  205. package/src/transport/resumable.ts +162 -0
  206. package/src/usage.test.ts +204 -0
  207. package/src/usage.ts +179 -0
  208. package/src/utils/getVercelAIMessages.ts +11 -0
  209. package/src/utils/sliceMessagesUntil.test.ts +51 -0
  210. package/src/utils/sliceMessagesUntil.ts +16 -0
@@ -0,0 +1,217 @@
1
+ // @vitest-environment jsdom
2
+ import { act, renderHook, waitFor } from "./__tests__/tap";
3
+ import { describe, expect, it, vi } from "vitest";
4
+ import { useTestChat } from "./__tests__/tap";
5
+ import type { ChatTransport, UIMessage, UIMessageChunk } from "ai";
6
+
7
+ vi.mock("./useExternalHistory", async (importOriginal) => {
8
+ const original =
9
+ await importOriginal<typeof import("./useExternalHistory")>();
10
+ return {
11
+ ...original,
12
+ useExternalHistory: vi.fn(() => ({
13
+ isLoading: false,
14
+ deleteMessage: vi.fn().mockResolvedValue(undefined),
15
+ markRunCancelled: vi.fn(),
16
+ persistToolInteractions: vi.fn().mockResolvedValue(undefined),
17
+ persistToolApprovalResponses: vi.fn().mockResolvedValue(undefined),
18
+ })),
19
+ };
20
+ });
21
+
22
+ import { useAISDKRuntime, type AISDKRuntimeAdapter } from "./useAISDKRuntime";
23
+
24
+ const text = (id: string, role: UIMessage["role"], value: string) =>
25
+ ({ id, role, parts: [{ type: "text", text: value }] }) as UIMessage;
26
+
27
+ const makeTransport = () => {
28
+ const sent: string[][] = [];
29
+ const transport: ChatTransport<UIMessage> = {
30
+ async sendMessages({ messages }) {
31
+ sent.push(messages.map((message) => message.id));
32
+ const chunks: UIMessageChunk[] = [
33
+ { type: "start", messageId: "regenerated" },
34
+ { type: "text-start", id: "t" },
35
+ { type: "text-delta", id: "t", delta: "new" },
36
+ { type: "text-end", id: "t" },
37
+ { type: "finish" },
38
+ ];
39
+ return new ReadableStream({
40
+ start(controller) {
41
+ for (const chunk of chunks) controller.enqueue(chunk);
42
+ controller.close();
43
+ },
44
+ });
45
+ },
46
+ async reconnectToStream() {
47
+ return null;
48
+ },
49
+ };
50
+ return { transport, sent };
51
+ };
52
+
53
+ const setup = (initial: UIMessage[], options: AISDKRuntimeAdapter = {}) => {
54
+ const { transport, sent } = makeTransport();
55
+ const { result } = renderHook(() => {
56
+ const chat = useTestChat({ messages: initial, transport });
57
+ const runtime = useAISDKRuntime(chat, options);
58
+ return { chat, runtime };
59
+ });
60
+ return { result, sent };
61
+ };
62
+
63
+ describe("useAISDKRuntime reload and edit of a joined response", () => {
64
+ it("does not send any part of the response being reloaded", async () => {
65
+ const { result, sent } = setup([
66
+ text("u1", "user", "hi"),
67
+ text("a1", "assistant", "old-1"),
68
+ text("a2", "assistant", "old-2"),
69
+ ]);
70
+ await waitFor(() =>
71
+ expect(result.current.runtime.thread.getState().messages).toHaveLength(2),
72
+ );
73
+ const assistant = result.current.runtime.thread.getState().messages[1]!;
74
+
75
+ act(() => {
76
+ result.current.runtime.thread.getMessageById(assistant.id).reload();
77
+ });
78
+
79
+ await waitFor(() => expect(sent).toHaveLength(1));
80
+ await waitFor(() => expect(result.current.chat.status).toBe("ready"));
81
+ expect(sent[0]).toEqual(["u1"]);
82
+ expect(result.current.chat.messages.map((m) => m.id)).toEqual([
83
+ "u1",
84
+ "regenerated",
85
+ ]);
86
+ });
87
+
88
+ it('does not send the reloaded message with joinStrategy "none"', async () => {
89
+ const { result, sent } = setup(
90
+ [
91
+ text("u1", "user", "hi"),
92
+ text("a1", "assistant", "old-1"),
93
+ text("a2", "assistant", "old-2"),
94
+ ],
95
+ { joinStrategy: "none" },
96
+ );
97
+ await waitFor(() =>
98
+ expect(result.current.runtime.thread.getState().messages).toHaveLength(3),
99
+ );
100
+
101
+ act(() => {
102
+ result.current.runtime.thread.getMessageById("a1").reload();
103
+ });
104
+
105
+ await waitFor(() => expect(sent).toHaveLength(1));
106
+ await waitFor(() => expect(result.current.chat.status).toBe("ready"));
107
+ expect(sent[0]).toEqual(["u1"]);
108
+ });
109
+
110
+ it("keeps an assistant parent when reloading the message after it", async () => {
111
+ const { result, sent } = setup(
112
+ [
113
+ text("u1", "user", "hi"),
114
+ text("a1", "assistant", "first"),
115
+ text("a2", "assistant", "second"),
116
+ ],
117
+ { joinStrategy: "none" },
118
+ );
119
+ await waitFor(() =>
120
+ expect(result.current.runtime.thread.getState().messages).toHaveLength(3),
121
+ );
122
+
123
+ act(() => {
124
+ result.current.runtime.thread.getMessageById("a2").reload();
125
+ });
126
+
127
+ await waitFor(() => expect(sent).toHaveLength(1));
128
+ await waitFor(() => expect(result.current.chat.status).toBe("ready"));
129
+ expect(sent[0]).toEqual(["u1", "a1"]);
130
+ });
131
+
132
+ it("keeps a voice reply when reloading the text reply after it", async () => {
133
+ const { result, sent } = setup([
134
+ text("u1", "user", "hi"),
135
+ { ...text("v1", "assistant", "spoken"), metadata: { modality: "voice" } },
136
+ text("a1", "assistant", "written"),
137
+ ]);
138
+ await waitFor(() =>
139
+ expect(result.current.runtime.thread.getState().messages).toHaveLength(3),
140
+ );
141
+ const reply = result.current.runtime.thread.getState().messages[2]!;
142
+
143
+ act(() => {
144
+ result.current.runtime.thread.getMessageById(reply.id).reload();
145
+ });
146
+
147
+ await waitFor(() => expect(sent).toHaveLength(1));
148
+ await waitFor(() => expect(result.current.chat.status).toBe("ready"));
149
+ expect(sent[0]).toEqual(["u1", "v1"]);
150
+ });
151
+
152
+ it("replaces every part of a joined response when it is edited", async () => {
153
+ const { result, sent } = setup([
154
+ text("u1", "user", "hi"),
155
+ text("a1", "assistant", "old-1"),
156
+ text("a2", "assistant", "old-2"),
157
+ ]);
158
+ await waitFor(() =>
159
+ expect(result.current.runtime.thread.getState().messages).toHaveLength(2),
160
+ );
161
+ const assistant = result.current.runtime.thread.getState().messages[1]!;
162
+ const composer = result.current.runtime.thread.getMessageById(
163
+ assistant.id,
164
+ ).composer;
165
+
166
+ act(() => {
167
+ composer.beginEdit();
168
+ composer.setText("edited");
169
+ });
170
+ await act(async () => {
171
+ await composer.send();
172
+ });
173
+
174
+ await waitFor(() =>
175
+ expect(result.current.chat.messages.map((m) => m.role)).toEqual([
176
+ "user",
177
+ "assistant",
178
+ ]),
179
+ );
180
+ expect(result.current.chat.messages[1]!.parts).toEqual([
181
+ expect.objectContaining({ type: "text", text: "edited" }),
182
+ ]);
183
+ expect(sent).toEqual([]);
184
+ });
185
+
186
+ it("keeps every part of a joined response that a new branch follows", async () => {
187
+ const { result, sent } = setup([
188
+ text("u1", "user", "hi"),
189
+ text("a1", "assistant", "part-1"),
190
+ text("a2", "assistant", "part-2"),
191
+ text("u2", "user", "next"),
192
+ text("a3", "assistant", "answer"),
193
+ ]);
194
+ await waitFor(() =>
195
+ expect(result.current.runtime.thread.getState().messages).toHaveLength(4),
196
+ );
197
+ const assistant = result.current.runtime.thread.getState().messages[1]!;
198
+
199
+ act(() => {
200
+ result.current.runtime.thread.append({
201
+ role: "user",
202
+ parentId: assistant.id,
203
+ content: [{ type: "text", text: "rewritten" }],
204
+ });
205
+ });
206
+
207
+ await waitFor(() => expect(sent).toHaveLength(1));
208
+ expect(sent[0]!.slice(0, 3)).toEqual(["u1", "a1", "a2"]);
209
+ expect(sent[0]).toHaveLength(4);
210
+ expect(result.current.chat.messages[3]).toEqual(
211
+ expect.objectContaining({
212
+ role: "user",
213
+ parts: [expect.objectContaining({ type: "text", text: "rewritten" })],
214
+ }),
215
+ );
216
+ });
217
+ });