@copilotkit/shared 2.0.0-rc.15 → 2.0.0-rc.16
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/dist/a2ui-envelope.cjs +2 -2
- package/dist/a2ui-envelope.cjs.map +1 -1
- package/dist/a2ui-envelope.d.cts +1 -1
- package/dist/a2ui-envelope.d.cts.map +1 -1
- package/dist/a2ui-envelope.d.mts +1 -1
- package/dist/a2ui-envelope.d.mts.map +1 -1
- package/dist/a2ui-envelope.mjs +2 -2
- package/dist/a2ui-envelope.mjs.map +1 -1
- package/dist/generative-ui/prompt-spec.cjs +11 -11
- package/dist/generative-ui/prompt-spec.cjs.map +1 -1
- package/dist/generative-ui/prompt-spec.mjs +11 -11
- package/dist/generative-ui/prompt-spec.mjs.map +1 -1
- package/dist/generative-ui/prompt.cjs +1 -1
- package/dist/generative-ui/prompt.cjs.map +1 -1
- package/dist/generative-ui/prompt.mjs +1 -1
- package/dist/generative-ui/prompt.mjs.map +1 -1
- package/dist/generative-ui/types.cjs +2 -2
- package/dist/generative-ui/types.cjs.map +1 -1
- package/dist/generative-ui/types.d.cts +7 -7
- package/dist/generative-ui/types.d.cts.map +1 -1
- package/dist/generative-ui/types.d.mts +7 -7
- package/dist/generative-ui/types.d.mts.map +1 -1
- package/dist/generative-ui/types.mjs +2 -2
- package/dist/generative-ui/types.mjs.map +1 -1
- package/dist/index.umd.js +17 -17
- package/dist/index.umd.js.map +1 -1
- package/dist/package.cjs +1 -1
- package/dist/package.mjs +1 -1
- package/package.json +1 -1
- package/src/__tests__/a2ui-envelope.test.ts +18 -13
- package/src/__tests__/a2ui-prompts.test.ts +5 -5
- package/src/__tests__/fixtures/prompt-goldens.json +64 -64
- package/src/a2ui-envelope.ts +5 -5
- package/src/generative-ui/__tests__/render-ui-args.test.ts +7 -7
- package/src/generative-ui/__tests__/validate-operation.test.ts +19 -13
- package/src/generative-ui/prompt-spec.ts +11 -11
- package/src/generative-ui/prompt.ts +1 -1
- package/src/generative-ui/types.ts +10 -7
package/dist/package.cjs
CHANGED
package/dist/package.mjs
CHANGED
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@ import { envelopeToManifest, readCopilotKitUIEnvelope } from "../a2ui-envelope";
|
|
|
3
3
|
import type { CopilotKitUIEnvelope } from "../a2ui-envelope";
|
|
4
4
|
|
|
5
5
|
type InlineCatalog = NonNullable<
|
|
6
|
-
CopilotKitUIEnvelope["
|
|
6
|
+
CopilotKitUIEnvelope["1.0"]["inlineCatalogs"]
|
|
7
7
|
>[number];
|
|
8
8
|
type Extensions = CopilotKitUIEnvelope["metadata"]["extensions"];
|
|
9
9
|
|
|
@@ -52,7 +52,7 @@ function createEnvelope(options?: {
|
|
|
52
52
|
extensions?: Partial<Extensions>;
|
|
53
53
|
}): CopilotKitUIEnvelope {
|
|
54
54
|
return {
|
|
55
|
-
"
|
|
55
|
+
"1.0": {
|
|
56
56
|
supportedCatalogIds: ["acme/app@1"],
|
|
57
57
|
inlineCatalogs: [createCatalog(options?.catalog)],
|
|
58
58
|
},
|
|
@@ -78,8 +78,8 @@ const withCatalogField = (key: string, value: unknown) => {
|
|
|
78
78
|
const envelope = createEnvelope();
|
|
79
79
|
return {
|
|
80
80
|
...envelope,
|
|
81
|
-
"
|
|
82
|
-
...envelope["
|
|
81
|
+
"1.0": {
|
|
82
|
+
...envelope["1.0"],
|
|
83
83
|
inlineCatalogs: [{ ...createCatalog(), [key]: value }],
|
|
84
84
|
},
|
|
85
85
|
};
|
|
@@ -88,7 +88,7 @@ const withCatalogField = (key: string, value: unknown) => {
|
|
|
88
88
|
/** An envelope with one key of the capabilities replaced by any value. */
|
|
89
89
|
const withCapability = (key: string, value: unknown) => {
|
|
90
90
|
const envelope = createEnvelope();
|
|
91
|
-
return { ...envelope, "
|
|
91
|
+
return { ...envelope, "1.0": { ...envelope["1.0"], [key]: value } };
|
|
92
92
|
};
|
|
93
93
|
|
|
94
94
|
/** An envelope with one CopilotKit extension replaced by any value. */
|
|
@@ -103,6 +103,11 @@ const withExtension = (key: string, value: unknown) => {
|
|
|
103
103
|
};
|
|
104
104
|
|
|
105
105
|
describe("readCopilotKitUIEnvelope", () => {
|
|
106
|
+
it("does not read the pre-release v1.0 capability key", () => {
|
|
107
|
+
const { "1.0": capabilities, ...rest } = createEnvelope();
|
|
108
|
+
expect(readUI({ ...rest, "v1.0": capabilities })).toBeUndefined();
|
|
109
|
+
});
|
|
110
|
+
|
|
106
111
|
it("reads a markdown envelope from forwardedProps.copilotkit.ui", () => {
|
|
107
112
|
const envelope = createEnvelope();
|
|
108
113
|
expect(readUI(envelope)).toEqual(envelope);
|
|
@@ -110,7 +115,7 @@ describe("readCopilotKitUIEnvelope", () => {
|
|
|
110
115
|
|
|
111
116
|
it("reads a tool envelope without instructions and without components", () => {
|
|
112
117
|
const envelope: CopilotKitUIEnvelope = {
|
|
113
|
-
"
|
|
118
|
+
"1.0": {
|
|
114
119
|
supportedCatalogIds: ["acme/app@1"],
|
|
115
120
|
inlineCatalogs: [
|
|
116
121
|
{ catalogId: "acme/app@1", protocolVersion: "1.0", functions: {} },
|
|
@@ -132,7 +137,7 @@ describe("readCopilotKitUIEnvelope", () => {
|
|
|
132
137
|
it("reads an envelope without inline catalogs", () => {
|
|
133
138
|
const envelope: CopilotKitUIEnvelope = {
|
|
134
139
|
...createEnvelope(),
|
|
135
|
-
"
|
|
140
|
+
"1.0": { supportedCatalogIds: ["acme/app@1"] },
|
|
136
141
|
};
|
|
137
142
|
expect(readUI(envelope)).toEqual(envelope);
|
|
138
143
|
});
|
|
@@ -201,7 +206,7 @@ describe("readCopilotKitUIEnvelope", () => {
|
|
|
201
206
|
],
|
|
202
207
|
["format 2 in the extensions", withExtension("copilotkit_format", 2)],
|
|
203
208
|
["an unknown transport", withExtension("copilotkit_transport", "fence")],
|
|
204
|
-
["no capabilities", { ...createEnvelope(), "
|
|
209
|
+
["no capabilities", { ...createEnvelope(), "1.0": undefined }],
|
|
205
210
|
["no metadata", { ...createEnvelope(), metadata: undefined }],
|
|
206
211
|
["no extensions", { ...createEnvelope(), metadata: {} }],
|
|
207
212
|
["no catalog id", withCapability("supportedCatalogIds", [])],
|
|
@@ -333,7 +338,7 @@ describe("envelopeToManifest", () => {
|
|
|
333
338
|
|
|
334
339
|
it("gives the action of the user event that started the run", () => {
|
|
335
340
|
const action = {
|
|
336
|
-
version: "
|
|
341
|
+
version: "1.0" as const,
|
|
337
342
|
action: {
|
|
338
343
|
name: "buy",
|
|
339
344
|
surfaceId: "s1",
|
|
@@ -371,7 +376,7 @@ describe("envelopeToManifest", () => {
|
|
|
371
376
|
it("lists every supported catalog id, the first one as the catalog of the run", () => {
|
|
372
377
|
const envelope: CopilotKitUIEnvelope = {
|
|
373
378
|
...createEnvelope(),
|
|
374
|
-
"
|
|
379
|
+
"1.0": {
|
|
375
380
|
supportedCatalogIds: ["acme/app@1", "copilotkit/standard@1"],
|
|
376
381
|
inlineCatalogs: [createCatalog()],
|
|
377
382
|
},
|
|
@@ -386,7 +391,7 @@ describe("envelopeToManifest", () => {
|
|
|
386
391
|
it("uses only the inline catalog of the first supported catalog id", () => {
|
|
387
392
|
const envelope: CopilotKitUIEnvelope = {
|
|
388
393
|
...createEnvelope(),
|
|
389
|
-
"
|
|
394
|
+
"1.0": {
|
|
390
395
|
supportedCatalogIds: ["acme/app@1"],
|
|
391
396
|
inlineCatalogs: [createCatalog({ catalogId: "other/catalog" })],
|
|
392
397
|
},
|
|
@@ -418,7 +423,7 @@ describe("component parameter order", () => {
|
|
|
418
423
|
"rejects invalid metadata %j",
|
|
419
424
|
(parameterOrder) => {
|
|
420
425
|
const envelope = createEnvelope();
|
|
421
|
-
const catalog = envelope["
|
|
426
|
+
const catalog = envelope["1.0"].inlineCatalogs![0];
|
|
422
427
|
const invalid = {
|
|
423
428
|
...catalog,
|
|
424
429
|
components: { ProductGrid: { ...productGrid, parameterOrder } },
|
|
@@ -426,7 +431,7 @@ describe("component parameter order", () => {
|
|
|
426
431
|
expect(
|
|
427
432
|
readUI({
|
|
428
433
|
...envelope,
|
|
429
|
-
"
|
|
434
|
+
"1.0": { ...envelope["1.0"], inlineCatalogs: [invalid] },
|
|
430
435
|
}),
|
|
431
436
|
).toBeUndefined();
|
|
432
437
|
},
|
|
@@ -33,9 +33,9 @@ describe("GENERATIVE_UI_MARKDOWN_GUIDELINES", () => {
|
|
|
33
33
|
);
|
|
34
34
|
});
|
|
35
35
|
|
|
36
|
-
it("asks for one JSON object per line, each with the
|
|
36
|
+
it("asks for one JSON object per line, each with the 1.0 version and no catalogId", () => {
|
|
37
37
|
expect(guide).toContain("write one JSON object per line and nothing else");
|
|
38
|
-
expect(guide).toContain('Give every operation "version":"
|
|
38
|
+
expect(guide).toContain('Give every operation "version":"1.0".');
|
|
39
39
|
expect(guide).not.toContain("v0.9");
|
|
40
40
|
expect(guide).not.toContain("catalogId");
|
|
41
41
|
});
|
|
@@ -45,7 +45,7 @@ describe("GENERATIVE_UI_MARKDOWN_GUIDELINES", () => {
|
|
|
45
45
|
'Start a surface with one createSurface. Put all the initial data in "dataModel" and the "root" component in "components".',
|
|
46
46
|
);
|
|
47
47
|
expect(guide).toContain(
|
|
48
|
-
'{"version":"
|
|
48
|
+
'{"version":"1.0","createSurface":{"surfaceId":"plan-picker","dataModel":{ ...initial data... },"components":[{"id":"root"',
|
|
49
49
|
);
|
|
50
50
|
expect(guide.indexOf('"createSurface"')).toBeLessThan(
|
|
51
51
|
guide.indexOf('"updateComponents"'),
|
|
@@ -149,14 +149,14 @@ describe("GENERATIVE_UI_MARKDOWN_GUIDELINES", () => {
|
|
|
149
149
|
"describes callRendererFunction, its unique id, and the developer-message response",
|
|
150
150
|
() => {
|
|
151
151
|
expect(guide).toContain(
|
|
152
|
-
'{"version":"
|
|
152
|
+
'{"version":"1.0","callRendererFunction":{"functionCallId":"<unique id>","callFunction":{"@call":"<function>","args":{...}}}}',
|
|
153
153
|
);
|
|
154
154
|
expect(guide).toContain(
|
|
155
155
|
"Give every callRendererFunction a new functionCallId.",
|
|
156
156
|
);
|
|
157
157
|
expect(guide).toContain('"callers": "UI or agent" or "agent only"');
|
|
158
158
|
expect(guide).toContain(
|
|
159
|
-
'{"version":"
|
|
159
|
+
'{"version":"1.0","rendererFunctionResponse":{"functionCallId":"<id>","value":...}}',
|
|
160
160
|
);
|
|
161
161
|
expect(guide).toContain("Then you get a new turn.");
|
|
162
162
|
},
|
|
@@ -7,8 +7,8 @@
|
|
|
7
7
|
"checks": false,
|
|
8
8
|
"surfaces": false
|
|
9
9
|
},
|
|
10
|
-
"markdown": "
|
|
11
|
-
"tool": "
|
|
10
|
+
"markdown": "265596cd69dac2877242fb6f9412509a63c325d1729424c6ed108f127ad38380",
|
|
11
|
+
"tool": "2831f893c748050be0c9286ac52c5edd2758d3375d8b0e22fb27631d5d7c6153"
|
|
12
12
|
},
|
|
13
13
|
{
|
|
14
14
|
"flags": {
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
"checks": false,
|
|
19
19
|
"surfaces": false
|
|
20
20
|
},
|
|
21
|
-
"markdown": "
|
|
22
|
-
"tool": "
|
|
21
|
+
"markdown": "265596cd69dac2877242fb6f9412509a63c325d1729424c6ed108f127ad38380",
|
|
22
|
+
"tool": "428bc6098febce22a187932f45bcb8e04da425904166285f8c3f038b6359ec27"
|
|
23
23
|
},
|
|
24
24
|
{
|
|
25
25
|
"flags": {
|
|
@@ -29,8 +29,8 @@
|
|
|
29
29
|
"checks": false,
|
|
30
30
|
"surfaces": false
|
|
31
31
|
},
|
|
32
|
-
"markdown": "
|
|
33
|
-
"tool": "
|
|
32
|
+
"markdown": "8089a3aac3acb22f5d6cb7320465a9ca2c79d256dd98a4011cda968a72123407",
|
|
33
|
+
"tool": "55f1755e703874aade63bef55f0a66bf4652a151b722f354d98cccc814a79b26"
|
|
34
34
|
},
|
|
35
35
|
{
|
|
36
36
|
"flags": {
|
|
@@ -40,8 +40,8 @@
|
|
|
40
40
|
"checks": false,
|
|
41
41
|
"surfaces": false
|
|
42
42
|
},
|
|
43
|
-
"markdown": "
|
|
44
|
-
"tool": "
|
|
43
|
+
"markdown": "ce392c2acc9ba13c92397ed3735b60b1296d7f2a09df1e979d50fe26c638ef23",
|
|
44
|
+
"tool": "daa208dec7887a3dd39a532c1ebbb031f7073d3fb52eb6fd65ea30bfb47205a2"
|
|
45
45
|
},
|
|
46
46
|
{
|
|
47
47
|
"flags": {
|
|
@@ -51,8 +51,8 @@
|
|
|
51
51
|
"checks": false,
|
|
52
52
|
"surfaces": false
|
|
53
53
|
},
|
|
54
|
-
"markdown": "
|
|
55
|
-
"tool": "
|
|
54
|
+
"markdown": "f4e49df0b7e100ac9c26994f57b4c4affe63415f1c9c609e91f9dd74f8f7a6d4",
|
|
55
|
+
"tool": "b8c611514da84eb3ffc264fe8eea91d2525499fd2f0e75e239d605bba365ea71"
|
|
56
56
|
},
|
|
57
57
|
{
|
|
58
58
|
"flags": {
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"checks": false,
|
|
63
63
|
"surfaces": false
|
|
64
64
|
},
|
|
65
|
-
"markdown": "
|
|
66
|
-
"tool": "
|
|
65
|
+
"markdown": "f4e49df0b7e100ac9c26994f57b4c4affe63415f1c9c609e91f9dd74f8f7a6d4",
|
|
66
|
+
"tool": "76370c17a5cdba4f880a032d55a162138ba9daf549e8896ab22b267e08dfd499"
|
|
67
67
|
},
|
|
68
68
|
{
|
|
69
69
|
"flags": {
|
|
@@ -73,8 +73,8 @@
|
|
|
73
73
|
"checks": false,
|
|
74
74
|
"surfaces": false
|
|
75
75
|
},
|
|
76
|
-
"markdown": "
|
|
77
|
-
"tool": "
|
|
76
|
+
"markdown": "5e7a0c80e08617730119cbaeb60340bf773faa2085f74d37608395b454e7b105",
|
|
77
|
+
"tool": "47ff29d2eaa301f3e0c80ae7c267a16184bf391666dae361d68cda5bdf29e7a4"
|
|
78
78
|
},
|
|
79
79
|
{
|
|
80
80
|
"flags": {
|
|
@@ -84,8 +84,8 @@
|
|
|
84
84
|
"checks": false,
|
|
85
85
|
"surfaces": false
|
|
86
86
|
},
|
|
87
|
-
"markdown": "
|
|
88
|
-
"tool": "
|
|
87
|
+
"markdown": "dda6b56c079a787437c241dc698280ab6fd53f9ec8a7c14a0c91e9cdc642466b",
|
|
88
|
+
"tool": "cd6ceb69c8ae9be058338c8f9a634e50eecf6fecff195336862cf44907b42109"
|
|
89
89
|
},
|
|
90
90
|
{
|
|
91
91
|
"flags": {
|
|
@@ -95,8 +95,8 @@
|
|
|
95
95
|
"checks": true,
|
|
96
96
|
"surfaces": false
|
|
97
97
|
},
|
|
98
|
-
"markdown": "
|
|
99
|
-
"tool": "
|
|
98
|
+
"markdown": "c9540725953d422a450f55d998a73115fdc5709881680f17c98654770236e450",
|
|
99
|
+
"tool": "cf1c7f8603b8bd3227154ee523540aef8f70129d6d99480411e0992c90c92c82"
|
|
100
100
|
},
|
|
101
101
|
{
|
|
102
102
|
"flags": {
|
|
@@ -106,8 +106,8 @@
|
|
|
106
106
|
"checks": true,
|
|
107
107
|
"surfaces": false
|
|
108
108
|
},
|
|
109
|
-
"markdown": "
|
|
110
|
-
"tool": "
|
|
109
|
+
"markdown": "c9540725953d422a450f55d998a73115fdc5709881680f17c98654770236e450",
|
|
110
|
+
"tool": "ca0ad9a17c5e6e7b7b0b4b3dbe6abd752de568ed626ca638a8921a97d168a577"
|
|
111
111
|
},
|
|
112
112
|
{
|
|
113
113
|
"flags": {
|
|
@@ -117,8 +117,8 @@
|
|
|
117
117
|
"checks": true,
|
|
118
118
|
"surfaces": false
|
|
119
119
|
},
|
|
120
|
-
"markdown": "
|
|
121
|
-
"tool": "
|
|
120
|
+
"markdown": "94c31a6d083321f352018d861a31e3e6a1db85ac3ee32d53776f9e2e334663e6",
|
|
121
|
+
"tool": "d47ae391ca59acf7ec38f135a9c3c050cadb50f06c9fa4d86161d3e1be1af6f8"
|
|
122
122
|
},
|
|
123
123
|
{
|
|
124
124
|
"flags": {
|
|
@@ -128,8 +128,8 @@
|
|
|
128
128
|
"checks": true,
|
|
129
129
|
"surfaces": false
|
|
130
130
|
},
|
|
131
|
-
"markdown": "
|
|
132
|
-
"tool": "
|
|
131
|
+
"markdown": "de8e220f6dadcb090ac7deeeab0595dbb6aaff019ffea0c9487c03e5104b1dee",
|
|
132
|
+
"tool": "9bb7c1e3f8a307b3eae12ff643f69087f250d50b8e2dd9958d4d238fb0122a17"
|
|
133
133
|
},
|
|
134
134
|
{
|
|
135
135
|
"flags": {
|
|
@@ -139,8 +139,8 @@
|
|
|
139
139
|
"checks": true,
|
|
140
140
|
"surfaces": false
|
|
141
141
|
},
|
|
142
|
-
"markdown": "
|
|
143
|
-
"tool": "
|
|
142
|
+
"markdown": "ac475fb084ed732561bb88416af3966599692e278c4a511cd8726278db6344f0",
|
|
143
|
+
"tool": "56a6232073f31385f9f1f8b4713598ef9444fc4d1f4bb8a0ed781404d96ce03b"
|
|
144
144
|
},
|
|
145
145
|
{
|
|
146
146
|
"flags": {
|
|
@@ -150,8 +150,8 @@
|
|
|
150
150
|
"checks": true,
|
|
151
151
|
"surfaces": false
|
|
152
152
|
},
|
|
153
|
-
"markdown": "
|
|
154
|
-
"tool": "
|
|
153
|
+
"markdown": "ac475fb084ed732561bb88416af3966599692e278c4a511cd8726278db6344f0",
|
|
154
|
+
"tool": "fddd878904428818a5e81266048bb03e49bdb12623c3238325b018a71a45a9f4"
|
|
155
155
|
},
|
|
156
156
|
{
|
|
157
157
|
"flags": {
|
|
@@ -161,8 +161,8 @@
|
|
|
161
161
|
"checks": true,
|
|
162
162
|
"surfaces": false
|
|
163
163
|
},
|
|
164
|
-
"markdown": "
|
|
165
|
-
"tool": "
|
|
164
|
+
"markdown": "a3dada266648564dacf6286bd7dddc6efbf321b3ead4be50061faeaf3b6cfe13",
|
|
165
|
+
"tool": "993d46f71cacf10b13b615048bbf8e4c856303d82db87b17c70a8dd6439e9b80"
|
|
166
166
|
},
|
|
167
167
|
{
|
|
168
168
|
"flags": {
|
|
@@ -172,8 +172,8 @@
|
|
|
172
172
|
"checks": true,
|
|
173
173
|
"surfaces": false
|
|
174
174
|
},
|
|
175
|
-
"markdown": "
|
|
176
|
-
"tool": "
|
|
175
|
+
"markdown": "8aedaae7606007869f5530e5a0378f8143c371c103cb557c459a174bf5b1ff0d",
|
|
176
|
+
"tool": "c4b5e660ff7f9ad59b38d3410c234fb424b4fbc36a7e8999c42f31614193fc77"
|
|
177
177
|
},
|
|
178
178
|
{
|
|
179
179
|
"flags": {
|
|
@@ -183,8 +183,8 @@
|
|
|
183
183
|
"checks": false,
|
|
184
184
|
"surfaces": true
|
|
185
185
|
},
|
|
186
|
-
"markdown": "
|
|
187
|
-
"tool": "
|
|
186
|
+
"markdown": "265596cd69dac2877242fb6f9412509a63c325d1729424c6ed108f127ad38380",
|
|
187
|
+
"tool": "99a6ab165b6eadf8b18a925de922d119e550a3f7b8f75b98536f6424f660a326"
|
|
188
188
|
},
|
|
189
189
|
{
|
|
190
190
|
"flags": {
|
|
@@ -194,8 +194,8 @@
|
|
|
194
194
|
"checks": false,
|
|
195
195
|
"surfaces": true
|
|
196
196
|
},
|
|
197
|
-
"markdown": "
|
|
198
|
-
"tool": "
|
|
197
|
+
"markdown": "265596cd69dac2877242fb6f9412509a63c325d1729424c6ed108f127ad38380",
|
|
198
|
+
"tool": "7f6acd8deadd6ecda655d41d02699a8c80b59513fac5c1dad8d2bb2f0343c26c"
|
|
199
199
|
},
|
|
200
200
|
{
|
|
201
201
|
"flags": {
|
|
@@ -205,8 +205,8 @@
|
|
|
205
205
|
"checks": false,
|
|
206
206
|
"surfaces": true
|
|
207
207
|
},
|
|
208
|
-
"markdown": "
|
|
209
|
-
"tool": "
|
|
208
|
+
"markdown": "8089a3aac3acb22f5d6cb7320465a9ca2c79d256dd98a4011cda968a72123407",
|
|
209
|
+
"tool": "0c241ec3391e2fd2c5b3df4477e7ffe9b4f7313854bb00e196c4a35d956be3f3"
|
|
210
210
|
},
|
|
211
211
|
{
|
|
212
212
|
"flags": {
|
|
@@ -216,8 +216,8 @@
|
|
|
216
216
|
"checks": false,
|
|
217
217
|
"surfaces": true
|
|
218
218
|
},
|
|
219
|
-
"markdown": "
|
|
220
|
-
"tool": "
|
|
219
|
+
"markdown": "ce392c2acc9ba13c92397ed3735b60b1296d7f2a09df1e979d50fe26c638ef23",
|
|
220
|
+
"tool": "8e1a94fbf67daf280f6ac722ccc62075598911e39e55fd5a113646e4c6ec7fc6"
|
|
221
221
|
},
|
|
222
222
|
{
|
|
223
223
|
"flags": {
|
|
@@ -227,8 +227,8 @@
|
|
|
227
227
|
"checks": false,
|
|
228
228
|
"surfaces": true
|
|
229
229
|
},
|
|
230
|
-
"markdown": "
|
|
231
|
-
"tool": "
|
|
230
|
+
"markdown": "f4e49df0b7e100ac9c26994f57b4c4affe63415f1c9c609e91f9dd74f8f7a6d4",
|
|
231
|
+
"tool": "45e9a5a47567f2c0fff0640c3646e498f0ec8068095394a55463f845bb996193"
|
|
232
232
|
},
|
|
233
233
|
{
|
|
234
234
|
"flags": {
|
|
@@ -238,8 +238,8 @@
|
|
|
238
238
|
"checks": false,
|
|
239
239
|
"surfaces": true
|
|
240
240
|
},
|
|
241
|
-
"markdown": "
|
|
242
|
-
"tool": "
|
|
241
|
+
"markdown": "f4e49df0b7e100ac9c26994f57b4c4affe63415f1c9c609e91f9dd74f8f7a6d4",
|
|
242
|
+
"tool": "f40514ab61be567c4a6f2f5b61e934d1779e3323477ce0aa868f3f3a66f1585c"
|
|
243
243
|
},
|
|
244
244
|
{
|
|
245
245
|
"flags": {
|
|
@@ -249,8 +249,8 @@
|
|
|
249
249
|
"checks": false,
|
|
250
250
|
"surfaces": true
|
|
251
251
|
},
|
|
252
|
-
"markdown": "
|
|
253
|
-
"tool": "
|
|
252
|
+
"markdown": "5e7a0c80e08617730119cbaeb60340bf773faa2085f74d37608395b454e7b105",
|
|
253
|
+
"tool": "effee9743233f14583977f93b00133ff1fce48835e25d61f91af5113a480fd11"
|
|
254
254
|
},
|
|
255
255
|
{
|
|
256
256
|
"flags": {
|
|
@@ -260,8 +260,8 @@
|
|
|
260
260
|
"checks": false,
|
|
261
261
|
"surfaces": true
|
|
262
262
|
},
|
|
263
|
-
"markdown": "
|
|
264
|
-
"tool": "
|
|
263
|
+
"markdown": "dda6b56c079a787437c241dc698280ab6fd53f9ec8a7c14a0c91e9cdc642466b",
|
|
264
|
+
"tool": "9a36d1f42b83cfa3cb5beadb130f1b3c3555098304570c0aaa133e8130ad52ea"
|
|
265
265
|
},
|
|
266
266
|
{
|
|
267
267
|
"flags": {
|
|
@@ -271,8 +271,8 @@
|
|
|
271
271
|
"checks": true,
|
|
272
272
|
"surfaces": true
|
|
273
273
|
},
|
|
274
|
-
"markdown": "
|
|
275
|
-
"tool": "
|
|
274
|
+
"markdown": "c9540725953d422a450f55d998a73115fdc5709881680f17c98654770236e450",
|
|
275
|
+
"tool": "eb5246d342a50810de921927f3e5be58a5ecac008b8e0750c5a6cfe2037a3b28"
|
|
276
276
|
},
|
|
277
277
|
{
|
|
278
278
|
"flags": {
|
|
@@ -282,8 +282,8 @@
|
|
|
282
282
|
"checks": true,
|
|
283
283
|
"surfaces": true
|
|
284
284
|
},
|
|
285
|
-
"markdown": "
|
|
286
|
-
"tool": "
|
|
285
|
+
"markdown": "c9540725953d422a450f55d998a73115fdc5709881680f17c98654770236e450",
|
|
286
|
+
"tool": "a79bd017703e7623301e33a8c33f26346e86752e7dec59344226de004ae385c5"
|
|
287
287
|
},
|
|
288
288
|
{
|
|
289
289
|
"flags": {
|
|
@@ -293,8 +293,8 @@
|
|
|
293
293
|
"checks": true,
|
|
294
294
|
"surfaces": true
|
|
295
295
|
},
|
|
296
|
-
"markdown": "
|
|
297
|
-
"tool": "
|
|
296
|
+
"markdown": "94c31a6d083321f352018d861a31e3e6a1db85ac3ee32d53776f9e2e334663e6",
|
|
297
|
+
"tool": "a4fe3c2f2326987ba63c8f4341b0bc100057cce07392f7930f47428b493cdd87"
|
|
298
298
|
},
|
|
299
299
|
{
|
|
300
300
|
"flags": {
|
|
@@ -304,8 +304,8 @@
|
|
|
304
304
|
"checks": true,
|
|
305
305
|
"surfaces": true
|
|
306
306
|
},
|
|
307
|
-
"markdown": "
|
|
308
|
-
"tool": "
|
|
307
|
+
"markdown": "de8e220f6dadcb090ac7deeeab0595dbb6aaff019ffea0c9487c03e5104b1dee",
|
|
308
|
+
"tool": "39ee92edc486d09a15ec1860f18b2349c170b4d010233afc6607b214373b32b5"
|
|
309
309
|
},
|
|
310
310
|
{
|
|
311
311
|
"flags": {
|
|
@@ -315,8 +315,8 @@
|
|
|
315
315
|
"checks": true,
|
|
316
316
|
"surfaces": true
|
|
317
317
|
},
|
|
318
|
-
"markdown": "
|
|
319
|
-
"tool": "
|
|
318
|
+
"markdown": "ac475fb084ed732561bb88416af3966599692e278c4a511cd8726278db6344f0",
|
|
319
|
+
"tool": "f215277ed2b79d86d1ad3aa9bb040c41812741ba00a5c357fd226031a083b7aa"
|
|
320
320
|
},
|
|
321
321
|
{
|
|
322
322
|
"flags": {
|
|
@@ -326,8 +326,8 @@
|
|
|
326
326
|
"checks": true,
|
|
327
327
|
"surfaces": true
|
|
328
328
|
},
|
|
329
|
-
"markdown": "
|
|
330
|
-
"tool": "
|
|
329
|
+
"markdown": "ac475fb084ed732561bb88416af3966599692e278c4a511cd8726278db6344f0",
|
|
330
|
+
"tool": "55f7a37ae48f2c5b7ead10a407f015b398ad866912f0d3b8a1c9da74a27730ae"
|
|
331
331
|
},
|
|
332
332
|
{
|
|
333
333
|
"flags": {
|
|
@@ -337,8 +337,8 @@
|
|
|
337
337
|
"checks": true,
|
|
338
338
|
"surfaces": true
|
|
339
339
|
},
|
|
340
|
-
"markdown": "
|
|
341
|
-
"tool": "
|
|
340
|
+
"markdown": "a3dada266648564dacf6286bd7dddc6efbf321b3ead4be50061faeaf3b6cfe13",
|
|
341
|
+
"tool": "541ad9d56614d3f611f6dc0873ec87e61abb499405e50bac0bd03af3263ba035"
|
|
342
342
|
},
|
|
343
343
|
{
|
|
344
344
|
"flags": {
|
|
@@ -348,7 +348,7 @@
|
|
|
348
348
|
"checks": true,
|
|
349
349
|
"surfaces": true
|
|
350
350
|
},
|
|
351
|
-
"markdown": "
|
|
352
|
-
"tool": "
|
|
351
|
+
"markdown": "8aedaae7606007869f5530e5a0378f8143c371c103cb557c459a174bf5b1ff0d",
|
|
352
|
+
"tool": "8ac027462d8448d3286401e9d520dad6b8d18c8c95912fd1baf7767fbca2ae1d"
|
|
353
353
|
}
|
|
354
354
|
]
|
package/src/a2ui-envelope.ts
CHANGED
|
@@ -29,7 +29,7 @@ export const COPILOTKIT_UI_ENVELOPE_FORMAT = 3;
|
|
|
29
29
|
/** What the client renders and calls, and how the model must write UI. */
|
|
30
30
|
export interface CopilotKitUIEnvelope {
|
|
31
31
|
/** The A2UI v1.0 renderer capabilities. */
|
|
32
|
-
"
|
|
32
|
+
"1.0": {
|
|
33
33
|
/**
|
|
34
34
|
* The catalog that the client renders comes first, then the catalogs of
|
|
35
35
|
* its `extends`. An operation can name any of them.
|
|
@@ -66,7 +66,7 @@ export interface CopilotKitUIEnvelope {
|
|
|
66
66
|
}
|
|
67
67
|
|
|
68
68
|
type InlineCatalog = NonNullable<
|
|
69
|
-
CopilotKitUIEnvelope["
|
|
69
|
+
CopilotKitUIEnvelope["1.0"]["inlineCatalogs"]
|
|
70
70
|
>[number];
|
|
71
71
|
type Extensions = CopilotKitUIEnvelope["metadata"]["extensions"];
|
|
72
72
|
|
|
@@ -149,7 +149,7 @@ function isInlineCatalog(value: unknown): value is InlineCatalog {
|
|
|
149
149
|
);
|
|
150
150
|
}
|
|
151
151
|
|
|
152
|
-
function isCapabilities(value: unknown): value is CopilotKitUIEnvelope["
|
|
152
|
+
function isCapabilities(value: unknown): value is CopilotKitUIEnvelope["1.0"] {
|
|
153
153
|
return (
|
|
154
154
|
isRecord(value) &&
|
|
155
155
|
Array.isArray(value.supportedCatalogIds) &&
|
|
@@ -222,7 +222,7 @@ function isExtensions(value: unknown): value is Extensions {
|
|
|
222
222
|
function isEnvelope(value: unknown): value is CopilotKitUIEnvelope {
|
|
223
223
|
return (
|
|
224
224
|
isRecord(value) &&
|
|
225
|
-
isCapabilities(value["
|
|
225
|
+
isCapabilities(value["1.0"]) &&
|
|
226
226
|
isRecord(value.metadata) &&
|
|
227
227
|
isExtensions(value.metadata.extensions)
|
|
228
228
|
);
|
|
@@ -282,7 +282,7 @@ export function readCopilotKitUIEnvelope(forwardedProps: unknown) {
|
|
|
282
282
|
* ```
|
|
283
283
|
*/
|
|
284
284
|
export function envelopeToManifest(envelope: CopilotKitUIEnvelope) {
|
|
285
|
-
const { supportedCatalogIds, inlineCatalogs } = envelope["
|
|
285
|
+
const { supportedCatalogIds, inlineCatalogs } = envelope["1.0"];
|
|
286
286
|
// `readCopilotKitUIEnvelope` only accepts a non-empty `supportedCatalogIds`.
|
|
287
287
|
const catalogId = supportedCatalogIds[0]!;
|
|
288
288
|
const catalog = inlineCatalogs?.find(
|
|
@@ -2,11 +2,11 @@ import { describe, expect, it } from "vitest";
|
|
|
2
2
|
import { RenderUIArgsStream, extractRenderUIArgs } from "../render-ui-args";
|
|
3
3
|
|
|
4
4
|
const opA = {
|
|
5
|
-
version: "
|
|
5
|
+
version: "1.0",
|
|
6
6
|
createSurface: { surfaceId: "s" },
|
|
7
7
|
};
|
|
8
8
|
const opB = {
|
|
9
|
-
version: "
|
|
9
|
+
version: "1.0",
|
|
10
10
|
updateComponents: {
|
|
11
11
|
surfaceId: "s",
|
|
12
12
|
components: [
|
|
@@ -20,12 +20,12 @@ const opB = {
|
|
|
20
20
|
},
|
|
21
21
|
};
|
|
22
22
|
const opC = {
|
|
23
|
-
version: "
|
|
23
|
+
version: "1.0",
|
|
24
24
|
updateDataModel: { surfaceId: "s", path: "/a", value: [1, { b: "]" }] },
|
|
25
25
|
};
|
|
26
26
|
/** One createSurface with the data model and the root inline. */
|
|
27
27
|
const inlineCreate = {
|
|
28
|
-
version: "
|
|
28
|
+
version: "1.0",
|
|
29
29
|
createSurface: {
|
|
30
30
|
surfaceId: "plan",
|
|
31
31
|
dataModel: { seats: 10, plans: [{ name: "Team" }] },
|
|
@@ -40,7 +40,7 @@ const inlineCreate = {
|
|
|
40
40
|
},
|
|
41
41
|
};
|
|
42
42
|
const functionCall = {
|
|
43
|
-
version: "
|
|
43
|
+
version: "1.0",
|
|
44
44
|
callRendererFunction: {
|
|
45
45
|
functionCallId: "f1",
|
|
46
46
|
callFunction: { "@call": "addToCart", args: { productId: "p{1}" } },
|
|
@@ -75,7 +75,7 @@ describe("extractRenderUIArgs", () => {
|
|
|
75
75
|
|
|
76
76
|
it("returns null for a balanced element that is not valid JSON", () => {
|
|
77
77
|
const text =
|
|
78
|
-
'{"target":"chat","operations":[{"version":"
|
|
78
|
+
'{"target":"chat","operations":[{"version":"1.0", bad},' +
|
|
79
79
|
JSON.stringify(opA) +
|
|
80
80
|
"]}";
|
|
81
81
|
expect(extractRenderUIArgs(text).operations).toEqual([null, opA]);
|
|
@@ -140,7 +140,7 @@ describe("RenderUIArgsStream", () => {
|
|
|
140
140
|
|
|
141
141
|
it("keeps the parser state across deltas that split strings, escapes and braces", () => {
|
|
142
142
|
const tricky = {
|
|
143
|
-
version: "
|
|
143
|
+
version: "1.0",
|
|
144
144
|
updateDataModel: { surfaceId: "s", path: "/q", value: 'a "}{" \\ ]' },
|
|
145
145
|
};
|
|
146
146
|
const text = JSON.stringify({
|