@copilotkit/sdk-js 2.0.0-next.1 → 2.0.0-rc.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.
- package/LICENSE +21 -0
- package/README.md +0 -1
- package/dist/_virtual/_rolldown/runtime.cjs +29 -0
- package/dist/header-propagation.cjs +37 -0
- package/dist/header-propagation.cjs.map +1 -0
- package/dist/header-propagation.d.cts +16 -0
- package/dist/header-propagation.d.cts.map +1 -0
- package/dist/header-propagation.d.mts +16 -0
- package/dist/header-propagation.d.mts.map +1 -0
- package/dist/header-propagation.mjs +35 -0
- package/dist/header-propagation.mjs.map +1 -0
- package/dist/index.cjs +5 -0
- package/dist/index.d.cts +18 -0
- package/dist/index.d.mts +18 -0
- package/dist/index.mjs +3 -1
- package/dist/langchain.cjs +21 -0
- package/dist/langchain.cjs.map +1 -0
- package/dist/langchain.d.cts +139 -0
- package/dist/langchain.d.mts +140 -0
- package/dist/langchain.mjs +7 -23
- package/dist/langchain.mjs.map +1 -1
- package/dist/langgraph/middleware.cjs +433 -0
- package/dist/langgraph/middleware.cjs.map +1 -0
- package/dist/langgraph/middleware.d.cts +86 -0
- package/dist/langgraph/middleware.d.cts.map +1 -0
- package/dist/langgraph/middleware.d.mts +86 -0
- package/dist/langgraph/middleware.d.mts.map +1 -0
- package/dist/langgraph/middleware.mjs +429 -0
- package/dist/langgraph/middleware.mjs.map +1 -0
- package/dist/langgraph/state-schema.cjs +37 -0
- package/dist/langgraph/state-schema.cjs.map +1 -0
- package/dist/langgraph/state-schema.d.cts +118 -0
- package/dist/langgraph/state-schema.d.cts.map +1 -0
- package/dist/langgraph/state-schema.d.mts +118 -0
- package/dist/langgraph/state-schema.d.mts.map +1 -0
- package/dist/langgraph/state-schema.mjs +36 -0
- package/dist/langgraph/state-schema.mjs.map +1 -0
- package/dist/langgraph/types.cjs +60 -0
- package/dist/langgraph/types.cjs.map +1 -0
- package/dist/langgraph/types.d.cts +335 -0
- package/dist/langgraph/types.d.cts.map +1 -0
- package/dist/langgraph/types.d.mts +335 -0
- package/dist/langgraph/types.d.mts.map +1 -0
- package/dist/langgraph/types.mjs +57 -0
- package/dist/langgraph/types.mjs.map +1 -0
- package/dist/langgraph/utils.cjs +297 -0
- package/dist/langgraph/utils.cjs.map +1 -0
- package/dist/langgraph/utils.d.cts +209 -0
- package/dist/langgraph/utils.d.cts.map +1 -0
- package/dist/langgraph/utils.d.mts +209 -0
- package/dist/langgraph/utils.d.mts.map +1 -0
- package/dist/langgraph/utils.mjs +289 -0
- package/dist/langgraph/utils.mjs.map +1 -0
- package/dist/langgraph-middlewares.cjs +22 -0
- package/dist/langgraph-middlewares.d.cts +30 -0
- package/dist/langgraph-middlewares.d.mts +30 -0
- package/dist/langgraph-middlewares.mjs +5 -0
- package/dist/langgraph.cjs +21 -0
- package/dist/langgraph.d.cts +5 -0
- package/dist/langgraph.d.mts +5 -0
- package/dist/langgraph.mjs +6 -27
- package/package.json +50 -47
- package/src/__tests__/error-handling.test.ts +54 -20
- package/src/__tests__/header-propagation.test.ts +131 -0
- package/src/header-propagation.ts +61 -0
- package/src/index.ts +41 -0
- package/src/langchain.ts +168 -8
- package/src/langgraph/__tests__/middleware.a2ui-params.test.ts +139 -0
- package/src/langgraph/__tests__/middleware.native-a2ui.test.ts +118 -0
- package/src/langgraph/__tests__/middleware.properties.test.ts +357 -0
- package/src/langgraph/__tests__/middleware.test.ts +1141 -0
- package/src/langgraph/__tests__/state-schema.test.ts +85 -0
- package/src/langgraph/__tests__/utils.test.ts +363 -0
- package/src/langgraph/index.ts +1 -0
- package/src/langgraph/middleware.ts +698 -95
- package/src/langgraph/state-schema.ts +34 -0
- package/src/langgraph/types.ts +57 -0
- package/src/langgraph/utils.ts +76 -19
- package/src/langgraph-middlewares.ts +55 -0
- package/tsconfig.json +11 -2
- package/tsdown.config.ts +18 -0
- package/vitest.config.mjs +11 -0
- package/CHANGELOG.md +0 -2169
- package/dist/chunk-JLGOQLGS.mjs +0 -433
- package/dist/chunk-JLGOQLGS.mjs.map +0 -1
- package/dist/index.d.ts +0 -2
- package/dist/index.js +0 -1
- package/dist/index.js.map +0 -1
- package/dist/index.mjs.map +0 -1
- package/dist/langchain-2645763d.d.ts +0 -427
- package/dist/langchain.d.ts +0 -6
- package/dist/langchain.js +0 -284
- package/dist/langchain.js.map +0 -1
- package/dist/langgraph/index.d.ts +0 -11
- package/dist/langgraph.js +0 -476
- package/dist/langgraph.js.map +0 -1
- package/dist/langgraph.mjs.map +0 -1
- package/jest.config.js +0 -5
- package/tsup.config.ts +0 -23
|
@@ -0,0 +1,357 @@
|
|
|
1
|
+
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
2
|
+
import { AIMessage } from "@langchain/core/messages";
|
|
3
|
+
import { StateGraph, START, END } from "@langchain/langgraph";
|
|
4
|
+
import type { A2UIToolParams } from "@ag-ui/langgraph";
|
|
5
|
+
|
|
6
|
+
// Capture the adapter boundary; no model or LLM responses are mocked.
|
|
7
|
+
const { captured, invoked } = vi.hoisted(() => {
|
|
8
|
+
const params: A2UIToolParams[] = [];
|
|
9
|
+
return {
|
|
10
|
+
captured: params,
|
|
11
|
+
invoked: vi.fn(
|
|
12
|
+
async (_input: unknown, config: { state?: unknown }) => config.state,
|
|
13
|
+
),
|
|
14
|
+
};
|
|
15
|
+
});
|
|
16
|
+
vi.mock("@ag-ui/langgraph", () => ({
|
|
17
|
+
getA2UITools: (params: A2UIToolParams) => {
|
|
18
|
+
captured.push(params);
|
|
19
|
+
return { name: "generate_a2ui", invoke: invoked };
|
|
20
|
+
},
|
|
21
|
+
}));
|
|
22
|
+
import { createCopilotkitMiddleware } from "../middleware";
|
|
23
|
+
|
|
24
|
+
const catalog = (id: string) => [
|
|
25
|
+
{
|
|
26
|
+
description: "A2UI catalog capabilities",
|
|
27
|
+
value: "Available A2UI catalog:\n- " + id + "\n - Card: {}",
|
|
28
|
+
},
|
|
29
|
+
];
|
|
30
|
+
const middleware = createCopilotkitMiddleware();
|
|
31
|
+
async function wrap(state: object) {
|
|
32
|
+
const tools: Array<{
|
|
33
|
+
name: string;
|
|
34
|
+
invoke: (input: unknown, config: { state: object }) => Promise<unknown>;
|
|
35
|
+
}> = [];
|
|
36
|
+
const request = { state, model: {}, tools, messages: [], runtime: {} };
|
|
37
|
+
let received = request;
|
|
38
|
+
await middleware.wrapModelCall(request, async (req) => {
|
|
39
|
+
received = req;
|
|
40
|
+
return new AIMessage("ok");
|
|
41
|
+
});
|
|
42
|
+
return received;
|
|
43
|
+
}
|
|
44
|
+
// The App Context note the model sees, folded into its system prompt.
|
|
45
|
+
async function context(state: object, runtime = {}) {
|
|
46
|
+
const request = { state, model: {}, tools: [], messages: [], runtime };
|
|
47
|
+
let received: { systemPrompt?: string } = request;
|
|
48
|
+
await middleware.wrapModelCall(request, async (req) => {
|
|
49
|
+
received = req;
|
|
50
|
+
return new AIMessage("ok");
|
|
51
|
+
});
|
|
52
|
+
return received.systemPrompt;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
beforeEach(() => {
|
|
56
|
+
captured.length = 0;
|
|
57
|
+
invoked.mockClear();
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
describe("effective AG-UI and CopilotKit properties", () => {
|
|
61
|
+
it.each([null, false, []])(
|
|
62
|
+
"treats explicit %j actions as empty while injection is enabled",
|
|
63
|
+
async (actions) => {
|
|
64
|
+
const result = await wrap({
|
|
65
|
+
"ag-ui": { inject_a2ui_tool: true, actions: [{ name: "base" }] },
|
|
66
|
+
copilotkit: { actions },
|
|
67
|
+
});
|
|
68
|
+
expect(result.tools.map((tool) => tool.name)).toEqual(["generate_a2ui"]);
|
|
69
|
+
},
|
|
70
|
+
);
|
|
71
|
+
|
|
72
|
+
it("replaces serialized schemas atomically and adapts object context only for the toolkit", async () => {
|
|
73
|
+
const schema = JSON.stringify({ catalogId: "override" });
|
|
74
|
+
const state = {
|
|
75
|
+
"ag-ui": {
|
|
76
|
+
inject_a2ui_tool: true,
|
|
77
|
+
a2ui_schema: JSON.stringify({
|
|
78
|
+
catalogId: "base",
|
|
79
|
+
components: { Card: {} },
|
|
80
|
+
}),
|
|
81
|
+
},
|
|
82
|
+
copilotkit: { a2ui_schema: schema, context: { user: "alice" } },
|
|
83
|
+
};
|
|
84
|
+
const result = await wrap(state);
|
|
85
|
+
await result.tools[0].invoke({}, { state });
|
|
86
|
+
expect(captured[0].defaultCatalogId).toBe("override");
|
|
87
|
+
expect(invoked.mock.calls[0][1].state).toEqual(
|
|
88
|
+
expect.objectContaining({
|
|
89
|
+
"ag-ui": expect.objectContaining({ a2ui_schema: schema, context: [] }),
|
|
90
|
+
}),
|
|
91
|
+
);
|
|
92
|
+
expect(state.copilotkit.context).toEqual({ user: "alice" });
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
it("retains both namespace fields through the graph state schema", async () => {
|
|
96
|
+
const graph = new StateGraph(middleware.stateSchema)
|
|
97
|
+
.addNode("echo", () => ({}))
|
|
98
|
+
.addEdge(START, "echo")
|
|
99
|
+
.addEdge("echo", END)
|
|
100
|
+
.compile();
|
|
101
|
+
const state = {
|
|
102
|
+
"ag-ui": { context: catalog("native") },
|
|
103
|
+
copilotkit: { a2ui_schema: "schema", inject_a2ui_tool: false },
|
|
104
|
+
};
|
|
105
|
+
expect(await graph.invoke(state)).toEqual(state);
|
|
106
|
+
});
|
|
107
|
+
|
|
108
|
+
it("decodes serialized catalog carriers only at the catalog consumer", async () => {
|
|
109
|
+
const entries = catalog("serialized");
|
|
110
|
+
entries[0].value = JSON.stringify(entries[0].value);
|
|
111
|
+
const state = {
|
|
112
|
+
"ag-ui": { inject_a2ui_tool: true, context: JSON.stringify(entries) },
|
|
113
|
+
};
|
|
114
|
+
await wrap(state);
|
|
115
|
+
expect(captured[0].defaultCatalogId).toBe("serialized");
|
|
116
|
+
expect(await context(state)).toBe(
|
|
117
|
+
"App Context:\n" + state["ag-ui"].context,
|
|
118
|
+
);
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
it("ignores malformed catalog entries", async () => {
|
|
122
|
+
await wrap({
|
|
123
|
+
"ag-ui": {
|
|
124
|
+
inject_a2ui_tool: true,
|
|
125
|
+
context: [
|
|
126
|
+
null,
|
|
127
|
+
1,
|
|
128
|
+
{ description: 4, value: true },
|
|
129
|
+
{ description: "A2UI catalog", value: {} },
|
|
130
|
+
],
|
|
131
|
+
},
|
|
132
|
+
});
|
|
133
|
+
expect(captured[0].defaultCatalogId).toBeUndefined();
|
|
134
|
+
});
|
|
135
|
+
|
|
136
|
+
it("merges nested context while preserving conflicting scalar and array leaves", async () => {
|
|
137
|
+
const state = {
|
|
138
|
+
"ag-ui": {
|
|
139
|
+
context: {
|
|
140
|
+
nested: { retained: 1, conflict: "old", items: [{ base: 1 }] },
|
|
141
|
+
enabled: true,
|
|
142
|
+
},
|
|
143
|
+
},
|
|
144
|
+
copilotkit: {
|
|
145
|
+
context: {
|
|
146
|
+
nested: { added: 2, conflict: null, items: [{ override: 2 }] },
|
|
147
|
+
enabled: false,
|
|
148
|
+
},
|
|
149
|
+
},
|
|
150
|
+
};
|
|
151
|
+
const before = structuredClone(state);
|
|
152
|
+
expect(await context(state)).toBe(
|
|
153
|
+
"App Context:\n" +
|
|
154
|
+
JSON.stringify(
|
|
155
|
+
{
|
|
156
|
+
nested: {
|
|
157
|
+
retained: 1,
|
|
158
|
+
conflict: null,
|
|
159
|
+
items: [{ override: 2 }],
|
|
160
|
+
added: 2,
|
|
161
|
+
},
|
|
162
|
+
enabled: false,
|
|
163
|
+
},
|
|
164
|
+
null,
|
|
165
|
+
2,
|
|
166
|
+
),
|
|
167
|
+
);
|
|
168
|
+
expect(state).toEqual(before);
|
|
169
|
+
});
|
|
170
|
+
|
|
171
|
+
it.each([null, false, "", []])(
|
|
172
|
+
"does not resurrect AG-UI or runtime context after an explicit %j override",
|
|
173
|
+
async (value) => {
|
|
174
|
+
expect(
|
|
175
|
+
await context(
|
|
176
|
+
{ "ag-ui": { context: "base" }, copilotkit: { context: value } },
|
|
177
|
+
{ context: { copilotkit: { context: "runtime" } } },
|
|
178
|
+
),
|
|
179
|
+
).toBeUndefined();
|
|
180
|
+
},
|
|
181
|
+
);
|
|
182
|
+
|
|
183
|
+
// Each namespace comes from state, or from its runtime carrier when state has
|
|
184
|
+
// none, before CopilotKit merges over AG-UI (the Python resolution order).
|
|
185
|
+
it.each([
|
|
186
|
+
[
|
|
187
|
+
"an AG-UI state value loses to a CopilotKit runtime carrier",
|
|
188
|
+
{ "ag-ui": { context: "page" } },
|
|
189
|
+
{ copilotkit: { context: "fresh" } },
|
|
190
|
+
"fresh",
|
|
191
|
+
],
|
|
192
|
+
[
|
|
193
|
+
"an undefined state value counts as absent",
|
|
194
|
+
{ "ag-ui": { context: "page" }, copilotkit: { context: undefined } },
|
|
195
|
+
{ copilotkit: { context: "fresh" } },
|
|
196
|
+
"fresh",
|
|
197
|
+
],
|
|
198
|
+
[
|
|
199
|
+
"interception bookkeeping alone counts as absent",
|
|
200
|
+
{ copilotkit: { interceptedToolCalls: [], originalAIMessageId: "m" } },
|
|
201
|
+
{ copilotkit: { context: "fresh" } },
|
|
202
|
+
"fresh",
|
|
203
|
+
],
|
|
204
|
+
[
|
|
205
|
+
"a CopilotKit state namespace keeps its runtime carrier out",
|
|
206
|
+
{ copilotkit: { actions: [] } },
|
|
207
|
+
{ copilotkit: { context: "fresh" } },
|
|
208
|
+
undefined,
|
|
209
|
+
],
|
|
210
|
+
])(
|
|
211
|
+
"resolves context per namespace: %s",
|
|
212
|
+
async (_name, state, carrier, note) => {
|
|
213
|
+
expect(await context(state, { context: carrier })).toBe(
|
|
214
|
+
note && "App Context:\n" + note,
|
|
215
|
+
);
|
|
216
|
+
},
|
|
217
|
+
);
|
|
218
|
+
|
|
219
|
+
it.each([
|
|
220
|
+
["state", { copilotkit: { context: "CTX" } }, {}],
|
|
221
|
+
["a runtime carrier", {}, { context: { copilotkit: { context: "CTX" } } }],
|
|
222
|
+
])(
|
|
223
|
+
"never renders forwarded headers from %s",
|
|
224
|
+
async (_name, state, runtime) => {
|
|
225
|
+
const value = {
|
|
226
|
+
page: "/dashboard",
|
|
227
|
+
copilotkit_forwarded_headers: { authorization: "Bearer secret" },
|
|
228
|
+
};
|
|
229
|
+
const swap = (carrier: object) =>
|
|
230
|
+
JSON.parse(
|
|
231
|
+
JSON.stringify(carrier).replace('"CTX"', JSON.stringify(value)),
|
|
232
|
+
);
|
|
233
|
+
|
|
234
|
+
expect(await context(swap(state), swap(runtime))).toBe(
|
|
235
|
+
"App Context:\n" + JSON.stringify({ page: "/dashboard" }, null, 2),
|
|
236
|
+
);
|
|
237
|
+
},
|
|
238
|
+
);
|
|
239
|
+
|
|
240
|
+
it("renders nothing when forwarded headers are the only context", async () => {
|
|
241
|
+
expect(
|
|
242
|
+
await context({
|
|
243
|
+
copilotkit: { context: { copilotkit_forwarded_headers: { a: "b" } } },
|
|
244
|
+
}),
|
|
245
|
+
).toBeUndefined();
|
|
246
|
+
});
|
|
247
|
+
|
|
248
|
+
it("keeps serialized context atomic and reads only a namespaced runtime carrier", async () => {
|
|
249
|
+
expect(
|
|
250
|
+
await context({
|
|
251
|
+
"ag-ui": { context: { base: 1 } },
|
|
252
|
+
copilotkit: { context: '{"override":2}' },
|
|
253
|
+
}),
|
|
254
|
+
).toBe('App Context:\n{"override":2}');
|
|
255
|
+
expect(
|
|
256
|
+
await context({}, { context: { copilotkit: { context: "runtime" } } }),
|
|
257
|
+
).toBe("App Context:\nruntime");
|
|
258
|
+
expect(await context({}, { context: "runtime" })).toBeUndefined();
|
|
259
|
+
});
|
|
260
|
+
|
|
261
|
+
it.each(["ag-ui", "copilotkit"])(
|
|
262
|
+
"uses a catalog and frontend action supplied only through %s",
|
|
263
|
+
async (namespace) => {
|
|
264
|
+
const state = {
|
|
265
|
+
[namespace]: {
|
|
266
|
+
context: catalog("catalog-one"),
|
|
267
|
+
actions: [{ name: "frontend" }],
|
|
268
|
+
inject_a2ui_tool: true,
|
|
269
|
+
},
|
|
270
|
+
};
|
|
271
|
+
const result = await wrap(state);
|
|
272
|
+
expect(result.tools.map((tool) => tool.name)).toEqual([
|
|
273
|
+
"generate_a2ui",
|
|
274
|
+
"frontend",
|
|
275
|
+
]);
|
|
276
|
+
expect(captured[0].defaultCatalogId).toBe("catalog-one");
|
|
277
|
+
expect(captured[0].guidelines.compositionGuide).toContain("catalog-one");
|
|
278
|
+
},
|
|
279
|
+
);
|
|
280
|
+
|
|
281
|
+
it("replaces context and action lists as wholes, including empty lists", async () => {
|
|
282
|
+
const state = {
|
|
283
|
+
"ag-ui": {
|
|
284
|
+
context: catalog("base"),
|
|
285
|
+
actions: [{ name: "base" }],
|
|
286
|
+
inject_a2ui_tool: true,
|
|
287
|
+
},
|
|
288
|
+
copilotkit: { context: [], actions: [] },
|
|
289
|
+
};
|
|
290
|
+
const result = await wrap(state);
|
|
291
|
+
expect(result.tools.map((tool) => tool.name)).toEqual(["generate_a2ui"]);
|
|
292
|
+
expect(captured[0].defaultCatalogId).toBeUndefined();
|
|
293
|
+
expect(captured[0].guidelines).toBeUndefined();
|
|
294
|
+
});
|
|
295
|
+
|
|
296
|
+
it.each([false, null, ""])(
|
|
297
|
+
"honors an explicit %j injection override",
|
|
298
|
+
async (value) => {
|
|
299
|
+
const result = await wrap({
|
|
300
|
+
"ag-ui": { inject_a2ui_tool: true },
|
|
301
|
+
copilotkit: { inject_a2ui_tool: value },
|
|
302
|
+
});
|
|
303
|
+
expect(result.tools).toEqual([]);
|
|
304
|
+
expect(captured).toEqual([]);
|
|
305
|
+
},
|
|
306
|
+
);
|
|
307
|
+
|
|
308
|
+
it("intercepts and restores AG-UI frontend calls without losing the namespace", () => {
|
|
309
|
+
const message = new AIMessage({
|
|
310
|
+
id: "assistant",
|
|
311
|
+
content: "",
|
|
312
|
+
tool_calls: [{ id: "call", name: "frontend", args: {} }],
|
|
313
|
+
});
|
|
314
|
+
const state = {
|
|
315
|
+
"ag-ui": { actions: [{ name: "frontend" }] },
|
|
316
|
+
messages: [message],
|
|
317
|
+
};
|
|
318
|
+
const intercepted = middleware.afterModel(state);
|
|
319
|
+
expect(intercepted.messages[0].tool_calls).toEqual([]);
|
|
320
|
+
const restored = middleware.afterAgent({ ...state, ...intercepted });
|
|
321
|
+
expect(restored.messages[0].tool_calls).toEqual(message.tool_calls);
|
|
322
|
+
expect(state.messages[0]).toBe(message);
|
|
323
|
+
});
|
|
324
|
+
|
|
325
|
+
it("delivers the merged native schema to the tool invocation without mutating state", async () => {
|
|
326
|
+
const state = {
|
|
327
|
+
"ag-ui": {
|
|
328
|
+
inject_a2ui_tool: true,
|
|
329
|
+
a2ui_schema: {
|
|
330
|
+
catalogId: "base",
|
|
331
|
+
components: { Card: { base: true, shared: "old" } },
|
|
332
|
+
},
|
|
333
|
+
},
|
|
334
|
+
copilotkit: {
|
|
335
|
+
a2ui_schema: {
|
|
336
|
+
catalogId: "override",
|
|
337
|
+
components: { Card: { shared: "new" }, Button: {} },
|
|
338
|
+
},
|
|
339
|
+
},
|
|
340
|
+
};
|
|
341
|
+
const before = structuredClone(state);
|
|
342
|
+
const result = await wrap(state);
|
|
343
|
+
await result.tools[0].invoke({}, { state });
|
|
344
|
+
expect(captured[0].defaultCatalogId).toBe("override");
|
|
345
|
+
expect(invoked.mock.calls[0][1].state).toEqual(
|
|
346
|
+
expect.objectContaining({
|
|
347
|
+
"ag-ui": expect.objectContaining({
|
|
348
|
+
a2ui_schema: JSON.stringify({
|
|
349
|
+
catalogId: "override",
|
|
350
|
+
components: { Card: { base: true, shared: "new" }, Button: {} },
|
|
351
|
+
}),
|
|
352
|
+
}),
|
|
353
|
+
}),
|
|
354
|
+
);
|
|
355
|
+
expect(state).toEqual(before);
|
|
356
|
+
});
|
|
357
|
+
});
|