@copilotkit/shared 2.0.0-rc.3 → 2.0.0-rc.30

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 (287) hide show
  1. package/README.md +3 -14
  2. package/dist/a2ui-envelope.cjs +2 -2
  3. package/dist/a2ui-envelope.cjs.map +1 -1
  4. package/dist/a2ui-envelope.d.cts +1 -1
  5. package/dist/a2ui-envelope.d.cts.map +1 -1
  6. package/dist/a2ui-envelope.d.mts +1 -1
  7. package/dist/a2ui-envelope.d.mts.map +1 -1
  8. package/dist/a2ui-envelope.mjs +2 -2
  9. package/dist/a2ui-envelope.mjs.map +1 -1
  10. package/dist/a2ui-prompts.cjs +21 -62
  11. package/dist/a2ui-prompts.cjs.map +1 -1
  12. package/dist/a2ui-prompts.d.cts +8 -1
  13. package/dist/a2ui-prompts.d.cts.map +1 -1
  14. package/dist/a2ui-prompts.d.mts +8 -1
  15. package/dist/a2ui-prompts.d.mts.map +1 -1
  16. package/dist/a2ui-prompts.mjs +22 -62
  17. package/dist/a2ui-prompts.mjs.map +1 -1
  18. package/dist/attachments/types.d.cts +1 -3
  19. package/dist/attachments/types.d.cts.map +1 -1
  20. package/dist/attachments/types.d.mts +1 -3
  21. package/dist/attachments/types.d.mts.map +1 -1
  22. package/dist/attachments/utils.cjs +16 -5
  23. package/dist/attachments/utils.cjs.map +1 -1
  24. package/dist/attachments/utils.d.cts +3 -1
  25. package/dist/attachments/utils.d.cts.map +1 -1
  26. package/dist/attachments/utils.d.mts +3 -1
  27. package/dist/attachments/utils.d.mts.map +1 -1
  28. package/dist/attachments/utils.mjs +16 -5
  29. package/dist/attachments/utils.mjs.map +1 -1
  30. package/dist/finalize-events.cjs +16 -0
  31. package/dist/finalize-events.cjs.map +1 -1
  32. package/dist/finalize-events.d.cts.map +1 -1
  33. package/dist/finalize-events.d.mts.map +1 -1
  34. package/dist/finalize-events.mjs +16 -0
  35. package/dist/finalize-events.mjs.map +1 -1
  36. package/dist/generative-ui/basic-functions.cjs +1 -1
  37. package/dist/generative-ui/basic-functions.cjs.map +1 -1
  38. package/dist/generative-ui/basic-functions.mjs +1 -1
  39. package/dist/generative-ui/basic-functions.mjs.map +1 -1
  40. package/dist/generative-ui/child-refs.cjs +3 -3
  41. package/dist/generative-ui/child-refs.cjs.map +1 -1
  42. package/dist/generative-ui/child-refs.d.cts.map +1 -1
  43. package/dist/generative-ui/child-refs.d.mts.map +1 -1
  44. package/dist/generative-ui/child-refs.mjs +3 -3
  45. package/dist/generative-ui/child-refs.mjs.map +1 -1
  46. package/dist/generative-ui/compact-schema.cjs +187 -0
  47. package/dist/generative-ui/compact-schema.cjs.map +1 -0
  48. package/dist/generative-ui/compact-schema.d.cts +55 -0
  49. package/dist/generative-ui/compact-schema.d.cts.map +1 -0
  50. package/dist/generative-ui/compact-schema.d.mts +55 -0
  51. package/dist/generative-ui/compact-schema.d.mts.map +1 -0
  52. package/dist/generative-ui/compact-schema.mjs +185 -0
  53. package/dist/generative-ui/compact-schema.mjs.map +1 -0
  54. package/dist/generative-ui/prompt-spec.cjs +225 -0
  55. package/dist/generative-ui/prompt-spec.cjs.map +1 -0
  56. package/dist/generative-ui/prompt-spec.d.cts +94 -0
  57. package/dist/generative-ui/prompt-spec.d.cts.map +1 -0
  58. package/dist/generative-ui/prompt-spec.d.mts +94 -0
  59. package/dist/generative-ui/prompt-spec.d.mts.map +1 -0
  60. package/dist/generative-ui/prompt-spec.mjs +220 -0
  61. package/dist/generative-ui/prompt-spec.mjs.map +1 -0
  62. package/dist/generative-ui/prompt.cjs +10 -36
  63. package/dist/generative-ui/prompt.cjs.map +1 -1
  64. package/dist/generative-ui/prompt.d.cts +2 -1
  65. package/dist/generative-ui/prompt.d.cts.map +1 -1
  66. package/dist/generative-ui/prompt.d.mts +2 -1
  67. package/dist/generative-ui/prompt.d.mts.map +1 -1
  68. package/dist/generative-ui/prompt.mjs +12 -38
  69. package/dist/generative-ui/prompt.mjs.map +1 -1
  70. package/dist/generative-ui/render-ui-args.cjs +1 -0
  71. package/dist/generative-ui/render-ui-args.cjs.map +1 -1
  72. package/dist/generative-ui/render-ui-args.d.cts.map +1 -1
  73. package/dist/generative-ui/render-ui-args.d.mts.map +1 -1
  74. package/dist/generative-ui/render-ui-args.mjs +1 -0
  75. package/dist/generative-ui/render-ui-args.mjs.map +1 -1
  76. package/dist/generative-ui/schema-render.cjs +242 -0
  77. package/dist/generative-ui/schema-render.cjs.map +1 -0
  78. package/dist/generative-ui/schema-render.d.cts +44 -0
  79. package/dist/generative-ui/schema-render.d.cts.map +1 -0
  80. package/dist/generative-ui/schema-render.d.mts +44 -0
  81. package/dist/generative-ui/schema-render.d.mts.map +1 -0
  82. package/dist/generative-ui/schema-render.mjs +239 -0
  83. package/dist/generative-ui/schema-render.mjs.map +1 -0
  84. package/dist/generative-ui/types.cjs +2 -2
  85. package/dist/generative-ui/types.cjs.map +1 -1
  86. package/dist/generative-ui/types.d.cts +7 -7
  87. package/dist/generative-ui/types.d.cts.map +1 -1
  88. package/dist/generative-ui/types.d.mts +7 -7
  89. package/dist/generative-ui/types.d.mts.map +1 -1
  90. package/dist/generative-ui/types.mjs +2 -2
  91. package/dist/generative-ui/types.mjs.map +1 -1
  92. package/dist/generative-ui/validate-operation.cjs +2 -2
  93. package/dist/generative-ui/validate-operation.cjs.map +1 -1
  94. package/dist/generative-ui/validate-operation.mjs +2 -2
  95. package/dist/generative-ui/validate-operation.mjs.map +1 -1
  96. package/dist/index.cjs +16 -15
  97. package/dist/index.cjs.map +1 -1
  98. package/dist/index.d.cts +10 -10
  99. package/dist/index.d.cts.map +1 -1
  100. package/dist/index.d.mts +10 -10
  101. package/dist/index.d.mts.map +1 -1
  102. package/dist/index.mjs +9 -8
  103. package/dist/index.mjs.map +1 -1
  104. package/dist/index.umd.js +866 -455
  105. package/dist/index.umd.js.map +1 -1
  106. package/dist/package.cjs +1 -1
  107. package/dist/package.mjs +1 -1
  108. package/dist/standard-schema.cjs +20 -7
  109. package/dist/standard-schema.cjs.map +1 -1
  110. package/dist/standard-schema.d.cts +15 -16
  111. package/dist/standard-schema.d.cts.map +1 -1
  112. package/dist/standard-schema.d.mts +15 -16
  113. package/dist/standard-schema.d.mts.map +1 -1
  114. package/dist/standard-schema.mjs +20 -8
  115. package/dist/standard-schema.mjs.map +1 -1
  116. package/dist/telemetry/lambda-client.cjs +1 -1
  117. package/dist/telemetry/lambda-client.cjs.map +1 -1
  118. package/dist/telemetry/lambda-client.d.cts.map +1 -1
  119. package/dist/telemetry/lambda-client.d.mts.map +1 -1
  120. package/dist/telemetry/lambda-client.mjs +1 -1
  121. package/dist/telemetry/lambda-client.mjs.map +1 -1
  122. package/dist/telemetry/telemetry-disabled.cjs +0 -5
  123. package/dist/telemetry/telemetry-disabled.cjs.map +1 -1
  124. package/dist/telemetry/telemetry-disabled.d.cts +0 -5
  125. package/dist/telemetry/telemetry-disabled.d.cts.map +1 -1
  126. package/dist/telemetry/telemetry-disabled.d.mts +0 -5
  127. package/dist/telemetry/telemetry-disabled.d.mts.map +1 -1
  128. package/dist/telemetry/telemetry-disabled.mjs +0 -5
  129. package/dist/telemetry/telemetry-disabled.mjs.map +1 -1
  130. package/dist/types/message.d.cts +1 -18
  131. package/dist/types/message.d.cts.map +1 -1
  132. package/dist/types/message.d.mts +1 -18
  133. package/dist/types/message.d.mts.map +1 -1
  134. package/dist/utils/errors.cjs +5 -42
  135. package/dist/utils/errors.cjs.map +1 -1
  136. package/dist/utils/errors.d.cts +16 -34
  137. package/dist/utils/errors.d.cts.map +1 -1
  138. package/dist/utils/errors.d.mts +16 -34
  139. package/dist/utils/errors.d.mts.map +1 -1
  140. package/dist/utils/errors.mjs +6 -41
  141. package/dist/utils/errors.mjs.map +1 -1
  142. package/dist/utils/index.cjs +0 -2
  143. package/dist/utils/index.cjs.map +1 -1
  144. package/dist/utils/index.d.cts +4 -6
  145. package/dist/utils/index.d.cts.map +1 -1
  146. package/dist/utils/index.d.mts +4 -6
  147. package/dist/utils/index.d.mts.map +1 -1
  148. package/dist/utils/index.mjs +4 -6
  149. package/dist/utils/index.mjs.map +1 -1
  150. package/dist/utils/inspector-visibility.cjs +25 -3
  151. package/dist/utils/inspector-visibility.cjs.map +1 -1
  152. package/dist/utils/inspector-visibility.d.cts +26 -3
  153. package/dist/utils/inspector-visibility.d.cts.map +1 -1
  154. package/dist/utils/inspector-visibility.d.mts +26 -3
  155. package/dist/utils/inspector-visibility.d.mts.map +1 -1
  156. package/dist/utils/inspector-visibility.mjs +25 -4
  157. package/dist/utils/inspector-visibility.mjs.map +1 -1
  158. package/dist/utils/json-schema.cjs +4 -79
  159. package/dist/utils/json-schema.cjs.map +1 -1
  160. package/dist/utils/json-schema.d.cts +1 -4
  161. package/dist/utils/json-schema.d.cts.map +1 -1
  162. package/dist/utils/json-schema.d.mts +1 -4
  163. package/dist/utils/json-schema.d.mts.map +1 -1
  164. package/dist/utils/json-schema.mjs +5 -78
  165. package/dist/utils/json-schema.mjs.map +1 -1
  166. package/dist/utils/random-id.cjs +13 -26
  167. package/dist/utils/random-id.cjs.map +1 -1
  168. package/dist/utils/random-id.d.cts +6 -3
  169. package/dist/utils/random-id.d.cts.map +1 -1
  170. package/dist/utils/random-id.d.mts +6 -3
  171. package/dist/utils/random-id.d.mts.map +1 -1
  172. package/dist/utils/random-id.mjs +14 -25
  173. package/dist/utils/random-id.mjs.map +1 -1
  174. package/package.json +10 -34
  175. package/scripts/verify-cjs-exports.cjs +1 -1
  176. package/src/__tests__/a2ui-envelope.test.ts +18 -13
  177. package/src/__tests__/a2ui-prompts.test.ts +47 -14
  178. package/src/__tests__/fixtures/prompt-goldens.json +354 -0
  179. package/src/__tests__/prompt-spec.test.ts +191 -0
  180. package/src/__tests__/root-entry-browser-safety.test.ts +5 -7
  181. package/src/__tests__/schema-render.test.ts +245 -0
  182. package/src/__tests__/standard-schema.test.ts +61 -101
  183. package/src/a2ui-envelope.ts +7 -6
  184. package/src/a2ui-prompts.ts +47 -96
  185. package/src/attachments/__tests__/utils.test.ts +22 -0
  186. package/src/attachments/types.ts +1 -3
  187. package/src/attachments/utils.ts +23 -5
  188. package/src/finalize-events.ts +16 -0
  189. package/src/generative-ui/__tests__/render-ui-args.test.ts +7 -7
  190. package/src/generative-ui/__tests__/validate-operation.test.ts +19 -13
  191. package/src/generative-ui/basic-functions.ts +1 -1
  192. package/src/generative-ui/child-refs.ts +5 -4
  193. package/src/generative-ui/compact-schema.ts +277 -0
  194. package/src/generative-ui/index.ts +3 -0
  195. package/src/generative-ui/prompt-spec.ts +335 -0
  196. package/src/generative-ui/prompt.ts +25 -75
  197. package/src/generative-ui/render-ui-args.ts +3 -0
  198. package/src/generative-ui/schema-render.ts +377 -0
  199. package/src/generative-ui/types.ts +10 -7
  200. package/src/generative-ui/validate-operation.ts +2 -2
  201. package/src/index.ts +3 -16
  202. package/src/standard-schema.ts +24 -27
  203. package/src/telemetry/lambda-client.ts +8 -3
  204. package/src/telemetry/model-host.test.ts +2 -5
  205. package/src/telemetry/telemetry-disabled.ts +0 -5
  206. package/src/types/message.ts +1 -19
  207. package/src/utils/__tests__/errors.test.ts +44 -0
  208. package/src/utils/__tests__/json-schema.test.ts +3 -479
  209. package/src/utils/__tests__/random-id.test.ts +37 -0
  210. package/src/utils/errors.ts +28 -85
  211. package/src/utils/index.ts +0 -2
  212. package/src/utils/inspector-visibility.test.ts +26 -0
  213. package/src/utils/inspector-visibility.ts +35 -3
  214. package/src/utils/json-schema.ts +5 -152
  215. package/src/utils/random-id.ts +17 -37
  216. package/tsconfig.json +3 -1
  217. package/tsdown.config.ts +2 -19
  218. package/dist/event-transforms/index.cjs +0 -15
  219. package/dist/event-transforms/index.d.cts +0 -4
  220. package/dist/event-transforms/index.d.mts +0 -4
  221. package/dist/event-transforms/index.mjs +0 -5
  222. package/dist/event-transforms/open-generative-ui-middleware.cjs +0 -286
  223. package/dist/event-transforms/open-generative-ui-middleware.cjs.map +0 -1
  224. package/dist/event-transforms/open-generative-ui-middleware.d.cts +0 -60
  225. package/dist/event-transforms/open-generative-ui-middleware.d.cts.map +0 -1
  226. package/dist/event-transforms/open-generative-ui-middleware.d.mts +0 -60
  227. package/dist/event-transforms/open-generative-ui-middleware.d.mts.map +0 -1
  228. package/dist/event-transforms/open-generative-ui-middleware.mjs +0 -283
  229. package/dist/event-transforms/open-generative-ui-middleware.mjs.map +0 -1
  230. package/dist/event-transforms/recorded-events.cjs +0 -59
  231. package/dist/event-transforms/recorded-events.cjs.map +0 -1
  232. package/dist/event-transforms/recorded-events.d.cts +0 -23
  233. package/dist/event-transforms/recorded-events.d.cts.map +0 -1
  234. package/dist/event-transforms/recorded-events.d.mts +0 -23
  235. package/dist/event-transforms/recorded-events.d.mts.map +0 -1
  236. package/dist/event-transforms/recorded-events.mjs +0 -58
  237. package/dist/event-transforms/recorded-events.mjs.map +0 -1
  238. package/dist/telemetry/events.d.cts +0 -72
  239. package/dist/telemetry/events.d.cts.map +0 -1
  240. package/dist/telemetry/events.d.mts +0 -72
  241. package/dist/telemetry/events.d.mts.map +0 -1
  242. package/dist/telemetry/index.cjs +0 -18
  243. package/dist/telemetry/index.d.cts +0 -5
  244. package/dist/telemetry/index.d.mts +0 -5
  245. package/dist/telemetry/index.mjs +0 -6
  246. package/dist/telemetry/telemetry-client.cjs +0 -165
  247. package/dist/telemetry/telemetry-client.cjs.map +0 -1
  248. package/dist/telemetry/telemetry-client.d.cts +0 -87
  249. package/dist/telemetry/telemetry-client.d.cts.map +0 -1
  250. package/dist/telemetry/telemetry-client.d.mts +0 -87
  251. package/dist/telemetry/telemetry-client.d.mts.map +0 -1
  252. package/dist/telemetry/telemetry-client.mjs +0 -164
  253. package/dist/telemetry/telemetry-client.mjs.map +0 -1
  254. package/dist/telemetry/utils.cjs +0 -14
  255. package/dist/telemetry/utils.cjs.map +0 -1
  256. package/dist/telemetry/utils.mjs +0 -13
  257. package/dist/telemetry/utils.mjs.map +0 -1
  258. package/dist/utils/conditions.cjs +0 -32
  259. package/dist/utils/conditions.cjs.map +0 -1
  260. package/dist/utils/conditions.d.cts +0 -31
  261. package/dist/utils/conditions.d.cts.map +0 -1
  262. package/dist/utils/conditions.d.mts +0 -31
  263. package/dist/utils/conditions.d.mts.map +0 -1
  264. package/dist/utils/conditions.mjs +0 -31
  265. package/dist/utils/conditions.mjs.map +0 -1
  266. package/dist/utils/console-styling.cjs +0 -91
  267. package/dist/utils/console-styling.cjs.map +0 -1
  268. package/dist/utils/console-styling.d.cts +0 -65
  269. package/dist/utils/console-styling.d.cts.map +0 -1
  270. package/dist/utils/console-styling.d.mts +0 -65
  271. package/dist/utils/console-styling.d.mts.map +0 -1
  272. package/dist/utils/console-styling.mjs +0 -85
  273. package/dist/utils/console-styling.mjs.map +0 -1
  274. package/src/__tests__/zod-regression.test.ts +0 -319
  275. package/src/event-transforms/index.ts +0 -5
  276. package/src/event-transforms/open-generative-ui-middleware.ts +0 -392
  277. package/src/event-transforms/recorded-events.test.ts +0 -166
  278. package/src/event-transforms/recorded-events.ts +0 -74
  279. package/src/telemetry/events.ts +0 -68
  280. package/src/telemetry/index.ts +0 -9
  281. package/src/telemetry/telemetry-blank-license-identity.test.ts +0 -128
  282. package/src/telemetry/telemetry-client.test.ts +0 -798
  283. package/src/telemetry/telemetry-client.ts +0 -328
  284. package/src/telemetry/utils.ts +0 -15
  285. package/src/utils/__tests__/conditions.test.ts +0 -161
  286. package/src/utils/conditions.ts +0 -116
  287. package/src/utils/console-styling.ts +0 -126
@@ -5,6 +5,7 @@ import {
5
5
  GENERATIVE_UI_MARKDOWN_GUIDELINES,
6
6
  GENERATIVE_UI_MARKDOWN_GUIDELINES_DESCRIPTION,
7
7
  GENERATIVE_UI_MARKDOWN_SCHEMA_CONTEXT_DESCRIPTION,
8
+ GENERATIVE_UI_MARKDOWN_WHEN_TO_SHOW,
8
9
  GENERATIVE_UI_WHEN_TO_SHOW,
9
10
  } from "../a2ui-prompts";
10
11
  import { COPILOTKIT_FUNCTIONS } from "../generative-ui/basic-functions";
@@ -28,13 +29,13 @@ describe("GENERATIVE_UI_MARKDOWN_GUIDELINES", () => {
28
29
  "Open a fence with ```a2ui target=<id> to show the surface in a named target.",
29
30
  );
30
31
  expect(guide).toContain(
31
- 'When a target has "components", its surfaces can use only those components.',
32
+ "When a target limits its components, its surfaces can use only those components.",
32
33
  );
33
34
  });
34
35
 
35
- it("asks for one JSON object per line, each with the v1.0 version and no catalogId", () => {
36
+ it("asks for one JSON object per line, each with the 1.0 version and no catalogId", () => {
36
37
  expect(guide).toContain("write one JSON object per line and nothing else");
37
- expect(guide).toContain('Give every operation "version":"v1.0".');
38
+ expect(guide).toContain('Give every operation "version":"1.0".');
38
39
  expect(guide).not.toContain("v0.9");
39
40
  expect(guide).not.toContain("catalogId");
40
41
  });
@@ -44,7 +45,7 @@ describe("GENERATIVE_UI_MARKDOWN_GUIDELINES", () => {
44
45
  'Start a surface with one createSurface. Put all the initial data in "dataModel" and the "root" component in "components".',
45
46
  );
46
47
  expect(guide).toContain(
47
- '{"version":"v1.0","createSurface":{"surfaceId":"plan-picker","dataModel":{ ...initial data... },"components":[{"id":"root"',
48
+ '{"version":"1.0","createSurface":{"surfaceId":"plan-picker","dataModel":{ ...initial data... },"components":[{"id":"root"',
48
49
  );
49
50
  expect(guide.indexOf('"createSurface"')).toBeLessThan(
50
51
  guide.indexOf('"updateComponents"'),
@@ -93,9 +94,7 @@ describe("GENERATIVE_UI_MARKDOWN_GUIDELINES", () => {
93
94
  expect(guide).toContain(
94
95
  'A prop can also be a function value that updates with the data: {"@call":"formatCurrency"',
95
96
  );
96
- expect(guide).toContain(
97
- 'Use only the functions under "functions" in the schema.',
98
- );
97
+ expect(guide).toContain("Use only the functions in the schema.");
99
98
  expect(guide).toContain("formatString interpolates ${...}");
100
99
  expect(guide).toContain(
101
100
  "Inside formatString, ${...} does not support operators",
@@ -104,7 +103,7 @@ describe("GENERATIVE_UI_MARKDOWN_GUIDELINES", () => {
104
103
  '{"@call":"calc","args":{"expression":"seats * 29 * (annual ? 0.8 : 1)"',
105
104
  );
106
105
  expect(guide).toContain(
107
- 'use series. Its description under "functions" in the schema',
106
+ "use series. Its description under Functions in the schema",
108
107
  );
109
108
  expect(guide).toContain('the "items" of a List');
110
109
  expect(guide).not.toContain("template path of a list");
@@ -150,14 +149,14 @@ describe("GENERATIVE_UI_MARKDOWN_GUIDELINES", () => {
150
149
  "describes callRendererFunction, its unique id, and the developer-message response",
151
150
  () => {
152
151
  expect(guide).toContain(
153
- '{"version":"v1.0","callRendererFunction":{"functionCallId":"<unique id>","callFunction":{"@call":"<function>","args":{...}}}}',
152
+ '{"version":"1.0","callRendererFunction":{"functionCallId":"<unique id>","callFunction":{"@call":"<function>","args":{...}}}}',
154
153
  );
155
154
  expect(guide).toContain(
156
155
  "Give every callRendererFunction a new functionCallId.",
157
156
  );
158
157
  expect(guide).toContain('"callers": "UI or agent" or "agent only"');
159
158
  expect(guide).toContain(
160
- '{"version":"v1.0","rendererFunctionResponse":{"functionCallId":"<id>","value":...}}',
159
+ '{"version":"1.0","rendererFunctionResponse":{"functionCallId":"<id>","value":...}}',
161
160
  );
162
161
  expect(guide).toContain("Then you get a new turn.");
163
162
  },
@@ -196,6 +195,7 @@ describe("generativeUIGuideFeatures", () => {
196
195
  functions: { save: { parameters: props } },
197
196
  }),
198
197
  ).toEqual({
198
+ components: ["List", "Button"],
199
199
  functions: true,
200
200
  events: true,
201
201
  templates: true,
@@ -212,6 +212,7 @@ describe("generativeUIGuideFeatures", () => {
212
212
  functions: {},
213
213
  }),
214
214
  ).toEqual({
215
+ components: ["Card"],
215
216
  functions: false,
216
217
  events: false,
217
218
  templates: false,
@@ -221,6 +222,28 @@ describe("generativeUIGuideFeatures", () => {
221
222
  });
222
223
 
223
224
  describe("buildGenerativeUIMarkdownGuidelines", () => {
225
+ it("leaves out the guide lines that name a standard component the catalog lacks", () => {
226
+ const all = {
227
+ functions: true,
228
+ events: true,
229
+ templates: true,
230
+ checks: true,
231
+ };
232
+ const full = buildGenerativeUIMarkdownGuidelines(all);
233
+ const reduced = buildGenerativeUIMarkdownGuidelines({
234
+ ...all,
235
+ components: ["Text", "Title", "Table", "Button", "Card", "Badge"],
236
+ });
237
+ expect(full).toContain("a Map with the places as markers");
238
+ expect(reduced).not.toMatch(/\bMap\b|\bSlider\b|\bCharts?\b/);
239
+ expect(reduced).toContain(
240
+ "- Items with a status, a category or a level: a Badge on each item.",
241
+ );
242
+ expect(reduced).toContain(
243
+ "Updating a component replaces all of its props.",
244
+ );
245
+ });
246
+
224
247
  const none = {
225
248
  functions: false,
226
249
  events: false,
@@ -282,13 +305,23 @@ describe("buildGenerativeUIMarkdownGuidelines", () => {
282
305
  });
283
306
 
284
307
  describe("GENERATIVE_UI_WHEN_TO_SHOW", () => {
285
- it("encourages UI where it conveys the answer better, and prose otherwise, on both transports", () => {
308
+ it("guides the markdown transport with its own text: UI by task, prose for quick answers", () => {
309
+ expect(GENERATIVE_UI_MARKDOWN_WHEN_TO_SHOW).toContain(
310
+ "Match the UI to the task",
311
+ );
312
+ expect(GENERATIVE_UI_MARKDOWN_WHEN_TO_SHOW).toContain(
313
+ "prose alone only for",
314
+ );
315
+ expect(GENERATIVE_UI_MARKDOWN_WHEN_TO_SHOW).toContain("No decoration");
316
+ expect(buildGenerativeUIMarkdownGuidelines()).toContain(
317
+ GENERATIVE_UI_MARKDOWN_WHEN_TO_SHOW,
318
+ );
319
+ });
320
+
321
+ it("encourages UI where it conveys the answer better, and prose otherwise, in the tool transport", () => {
286
322
  expect(GENERATIVE_UI_WHEN_TO_SHOW).toContain("illustrate a concept");
287
323
  expect(GENERATIVE_UI_WHEN_TO_SHOW).toContain("prose alone");
288
324
  expect(GENERATIVE_UI_WHEN_TO_SHOW).toContain("decoration");
289
- expect(buildGenerativeUIMarkdownGuidelines()).toContain(
290
- GENERATIVE_UI_WHEN_TO_SHOW,
291
- );
292
325
  expect(
293
326
  buildGenerativeUIPrompt({
294
327
  catalogId: "test",
@@ -0,0 +1,354 @@
1
+ [
2
+ {
3
+ "flags": {
4
+ "functions": false,
5
+ "events": false,
6
+ "templates": false,
7
+ "checks": false,
8
+ "surfaces": false
9
+ },
10
+ "markdown": "265596cd69dac2877242fb6f9412509a63c325d1729424c6ed108f127ad38380",
11
+ "tool": "2831f893c748050be0c9286ac52c5edd2758d3375d8b0e22fb27631d5d7c6153"
12
+ },
13
+ {
14
+ "flags": {
15
+ "functions": true,
16
+ "events": false,
17
+ "templates": false,
18
+ "checks": false,
19
+ "surfaces": false
20
+ },
21
+ "markdown": "265596cd69dac2877242fb6f9412509a63c325d1729424c6ed108f127ad38380",
22
+ "tool": "428bc6098febce22a187932f45bcb8e04da425904166285f8c3f038b6359ec27"
23
+ },
24
+ {
25
+ "flags": {
26
+ "functions": false,
27
+ "events": true,
28
+ "templates": false,
29
+ "checks": false,
30
+ "surfaces": false
31
+ },
32
+ "markdown": "8089a3aac3acb22f5d6cb7320465a9ca2c79d256dd98a4011cda968a72123407",
33
+ "tool": "55f1755e703874aade63bef55f0a66bf4652a151b722f354d98cccc814a79b26"
34
+ },
35
+ {
36
+ "flags": {
37
+ "functions": true,
38
+ "events": true,
39
+ "templates": false,
40
+ "checks": false,
41
+ "surfaces": false
42
+ },
43
+ "markdown": "ce392c2acc9ba13c92397ed3735b60b1296d7f2a09df1e979d50fe26c638ef23",
44
+ "tool": "daa208dec7887a3dd39a532c1ebbb031f7073d3fb52eb6fd65ea30bfb47205a2"
45
+ },
46
+ {
47
+ "flags": {
48
+ "functions": false,
49
+ "events": false,
50
+ "templates": true,
51
+ "checks": false,
52
+ "surfaces": false
53
+ },
54
+ "markdown": "f4e49df0b7e100ac9c26994f57b4c4affe63415f1c9c609e91f9dd74f8f7a6d4",
55
+ "tool": "b8c611514da84eb3ffc264fe8eea91d2525499fd2f0e75e239d605bba365ea71"
56
+ },
57
+ {
58
+ "flags": {
59
+ "functions": true,
60
+ "events": false,
61
+ "templates": true,
62
+ "checks": false,
63
+ "surfaces": false
64
+ },
65
+ "markdown": "f4e49df0b7e100ac9c26994f57b4c4affe63415f1c9c609e91f9dd74f8f7a6d4",
66
+ "tool": "76370c17a5cdba4f880a032d55a162138ba9daf549e8896ab22b267e08dfd499"
67
+ },
68
+ {
69
+ "flags": {
70
+ "functions": false,
71
+ "events": true,
72
+ "templates": true,
73
+ "checks": false,
74
+ "surfaces": false
75
+ },
76
+ "markdown": "5e7a0c80e08617730119cbaeb60340bf773faa2085f74d37608395b454e7b105",
77
+ "tool": "47ff29d2eaa301f3e0c80ae7c267a16184bf391666dae361d68cda5bdf29e7a4"
78
+ },
79
+ {
80
+ "flags": {
81
+ "functions": true,
82
+ "events": true,
83
+ "templates": true,
84
+ "checks": false,
85
+ "surfaces": false
86
+ },
87
+ "markdown": "dda6b56c079a787437c241dc698280ab6fd53f9ec8a7c14a0c91e9cdc642466b",
88
+ "tool": "cd6ceb69c8ae9be058338c8f9a634e50eecf6fecff195336862cf44907b42109"
89
+ },
90
+ {
91
+ "flags": {
92
+ "functions": false,
93
+ "events": false,
94
+ "templates": false,
95
+ "checks": true,
96
+ "surfaces": false
97
+ },
98
+ "markdown": "c9540725953d422a450f55d998a73115fdc5709881680f17c98654770236e450",
99
+ "tool": "cf1c7f8603b8bd3227154ee523540aef8f70129d6d99480411e0992c90c92c82"
100
+ },
101
+ {
102
+ "flags": {
103
+ "functions": true,
104
+ "events": false,
105
+ "templates": false,
106
+ "checks": true,
107
+ "surfaces": false
108
+ },
109
+ "markdown": "c9540725953d422a450f55d998a73115fdc5709881680f17c98654770236e450",
110
+ "tool": "ca0ad9a17c5e6e7b7b0b4b3dbe6abd752de568ed626ca638a8921a97d168a577"
111
+ },
112
+ {
113
+ "flags": {
114
+ "functions": false,
115
+ "events": true,
116
+ "templates": false,
117
+ "checks": true,
118
+ "surfaces": false
119
+ },
120
+ "markdown": "94c31a6d083321f352018d861a31e3e6a1db85ac3ee32d53776f9e2e334663e6",
121
+ "tool": "d47ae391ca59acf7ec38f135a9c3c050cadb50f06c9fa4d86161d3e1be1af6f8"
122
+ },
123
+ {
124
+ "flags": {
125
+ "functions": true,
126
+ "events": true,
127
+ "templates": false,
128
+ "checks": true,
129
+ "surfaces": false
130
+ },
131
+ "markdown": "de8e220f6dadcb090ac7deeeab0595dbb6aaff019ffea0c9487c03e5104b1dee",
132
+ "tool": "9bb7c1e3f8a307b3eae12ff643f69087f250d50b8e2dd9958d4d238fb0122a17"
133
+ },
134
+ {
135
+ "flags": {
136
+ "functions": false,
137
+ "events": false,
138
+ "templates": true,
139
+ "checks": true,
140
+ "surfaces": false
141
+ },
142
+ "markdown": "ac475fb084ed732561bb88416af3966599692e278c4a511cd8726278db6344f0",
143
+ "tool": "56a6232073f31385f9f1f8b4713598ef9444fc4d1f4bb8a0ed781404d96ce03b"
144
+ },
145
+ {
146
+ "flags": {
147
+ "functions": true,
148
+ "events": false,
149
+ "templates": true,
150
+ "checks": true,
151
+ "surfaces": false
152
+ },
153
+ "markdown": "ac475fb084ed732561bb88416af3966599692e278c4a511cd8726278db6344f0",
154
+ "tool": "fddd878904428818a5e81266048bb03e49bdb12623c3238325b018a71a45a9f4"
155
+ },
156
+ {
157
+ "flags": {
158
+ "functions": false,
159
+ "events": true,
160
+ "templates": true,
161
+ "checks": true,
162
+ "surfaces": false
163
+ },
164
+ "markdown": "a3dada266648564dacf6286bd7dddc6efbf321b3ead4be50061faeaf3b6cfe13",
165
+ "tool": "993d46f71cacf10b13b615048bbf8e4c856303d82db87b17c70a8dd6439e9b80"
166
+ },
167
+ {
168
+ "flags": {
169
+ "functions": true,
170
+ "events": true,
171
+ "templates": true,
172
+ "checks": true,
173
+ "surfaces": false
174
+ },
175
+ "markdown": "8aedaae7606007869f5530e5a0378f8143c371c103cb557c459a174bf5b1ff0d",
176
+ "tool": "c4b5e660ff7f9ad59b38d3410c234fb424b4fbc36a7e8999c42f31614193fc77"
177
+ },
178
+ {
179
+ "flags": {
180
+ "functions": false,
181
+ "events": false,
182
+ "templates": false,
183
+ "checks": false,
184
+ "surfaces": true
185
+ },
186
+ "markdown": "265596cd69dac2877242fb6f9412509a63c325d1729424c6ed108f127ad38380",
187
+ "tool": "99a6ab165b6eadf8b18a925de922d119e550a3f7b8f75b98536f6424f660a326"
188
+ },
189
+ {
190
+ "flags": {
191
+ "functions": true,
192
+ "events": false,
193
+ "templates": false,
194
+ "checks": false,
195
+ "surfaces": true
196
+ },
197
+ "markdown": "265596cd69dac2877242fb6f9412509a63c325d1729424c6ed108f127ad38380",
198
+ "tool": "7f6acd8deadd6ecda655d41d02699a8c80b59513fac5c1dad8d2bb2f0343c26c"
199
+ },
200
+ {
201
+ "flags": {
202
+ "functions": false,
203
+ "events": true,
204
+ "templates": false,
205
+ "checks": false,
206
+ "surfaces": true
207
+ },
208
+ "markdown": "8089a3aac3acb22f5d6cb7320465a9ca2c79d256dd98a4011cda968a72123407",
209
+ "tool": "0c241ec3391e2fd2c5b3df4477e7ffe9b4f7313854bb00e196c4a35d956be3f3"
210
+ },
211
+ {
212
+ "flags": {
213
+ "functions": true,
214
+ "events": true,
215
+ "templates": false,
216
+ "checks": false,
217
+ "surfaces": true
218
+ },
219
+ "markdown": "ce392c2acc9ba13c92397ed3735b60b1296d7f2a09df1e979d50fe26c638ef23",
220
+ "tool": "8e1a94fbf67daf280f6ac722ccc62075598911e39e55fd5a113646e4c6ec7fc6"
221
+ },
222
+ {
223
+ "flags": {
224
+ "functions": false,
225
+ "events": false,
226
+ "templates": true,
227
+ "checks": false,
228
+ "surfaces": true
229
+ },
230
+ "markdown": "f4e49df0b7e100ac9c26994f57b4c4affe63415f1c9c609e91f9dd74f8f7a6d4",
231
+ "tool": "45e9a5a47567f2c0fff0640c3646e498f0ec8068095394a55463f845bb996193"
232
+ },
233
+ {
234
+ "flags": {
235
+ "functions": true,
236
+ "events": false,
237
+ "templates": true,
238
+ "checks": false,
239
+ "surfaces": true
240
+ },
241
+ "markdown": "f4e49df0b7e100ac9c26994f57b4c4affe63415f1c9c609e91f9dd74f8f7a6d4",
242
+ "tool": "f40514ab61be567c4a6f2f5b61e934d1779e3323477ce0aa868f3f3a66f1585c"
243
+ },
244
+ {
245
+ "flags": {
246
+ "functions": false,
247
+ "events": true,
248
+ "templates": true,
249
+ "checks": false,
250
+ "surfaces": true
251
+ },
252
+ "markdown": "5e7a0c80e08617730119cbaeb60340bf773faa2085f74d37608395b454e7b105",
253
+ "tool": "effee9743233f14583977f93b00133ff1fce48835e25d61f91af5113a480fd11"
254
+ },
255
+ {
256
+ "flags": {
257
+ "functions": true,
258
+ "events": true,
259
+ "templates": true,
260
+ "checks": false,
261
+ "surfaces": true
262
+ },
263
+ "markdown": "dda6b56c079a787437c241dc698280ab6fd53f9ec8a7c14a0c91e9cdc642466b",
264
+ "tool": "9a36d1f42b83cfa3cb5beadb130f1b3c3555098304570c0aaa133e8130ad52ea"
265
+ },
266
+ {
267
+ "flags": {
268
+ "functions": false,
269
+ "events": false,
270
+ "templates": false,
271
+ "checks": true,
272
+ "surfaces": true
273
+ },
274
+ "markdown": "c9540725953d422a450f55d998a73115fdc5709881680f17c98654770236e450",
275
+ "tool": "eb5246d342a50810de921927f3e5be58a5ecac008b8e0750c5a6cfe2037a3b28"
276
+ },
277
+ {
278
+ "flags": {
279
+ "functions": true,
280
+ "events": false,
281
+ "templates": false,
282
+ "checks": true,
283
+ "surfaces": true
284
+ },
285
+ "markdown": "c9540725953d422a450f55d998a73115fdc5709881680f17c98654770236e450",
286
+ "tool": "a79bd017703e7623301e33a8c33f26346e86752e7dec59344226de004ae385c5"
287
+ },
288
+ {
289
+ "flags": {
290
+ "functions": false,
291
+ "events": true,
292
+ "templates": false,
293
+ "checks": true,
294
+ "surfaces": true
295
+ },
296
+ "markdown": "94c31a6d083321f352018d861a31e3e6a1db85ac3ee32d53776f9e2e334663e6",
297
+ "tool": "a4fe3c2f2326987ba63c8f4341b0bc100057cce07392f7930f47428b493cdd87"
298
+ },
299
+ {
300
+ "flags": {
301
+ "functions": true,
302
+ "events": true,
303
+ "templates": false,
304
+ "checks": true,
305
+ "surfaces": true
306
+ },
307
+ "markdown": "de8e220f6dadcb090ac7deeeab0595dbb6aaff019ffea0c9487c03e5104b1dee",
308
+ "tool": "39ee92edc486d09a15ec1860f18b2349c170b4d010233afc6607b214373b32b5"
309
+ },
310
+ {
311
+ "flags": {
312
+ "functions": false,
313
+ "events": false,
314
+ "templates": true,
315
+ "checks": true,
316
+ "surfaces": true
317
+ },
318
+ "markdown": "ac475fb084ed732561bb88416af3966599692e278c4a511cd8726278db6344f0",
319
+ "tool": "f215277ed2b79d86d1ad3aa9bb040c41812741ba00a5c357fd226031a083b7aa"
320
+ },
321
+ {
322
+ "flags": {
323
+ "functions": true,
324
+ "events": false,
325
+ "templates": true,
326
+ "checks": true,
327
+ "surfaces": true
328
+ },
329
+ "markdown": "ac475fb084ed732561bb88416af3966599692e278c4a511cd8726278db6344f0",
330
+ "tool": "55f7a37ae48f2c5b7ead10a407f015b398ad866912f0d3b8a1c9da74a27730ae"
331
+ },
332
+ {
333
+ "flags": {
334
+ "functions": false,
335
+ "events": true,
336
+ "templates": true,
337
+ "checks": true,
338
+ "surfaces": true
339
+ },
340
+ "markdown": "a3dada266648564dacf6286bd7dddc6efbf321b3ead4be50061faeaf3b6cfe13",
341
+ "tool": "541ad9d56614d3f611f6dc0873ec87e61abb499405e50bac0bd03af3263ba035"
342
+ },
343
+ {
344
+ "flags": {
345
+ "functions": true,
346
+ "events": true,
347
+ "templates": true,
348
+ "checks": true,
349
+ "surfaces": true
350
+ },
351
+ "markdown": "8aedaae7606007869f5530e5a0378f8143c371c103cb557c459a174bf5b1ff0d",
352
+ "tool": "8ac027462d8448d3286401e9d520dad6b8d18c8c95912fd1baf7767fbca2ae1d"
353
+ }
354
+ ]
@@ -0,0 +1,191 @@
1
+ import { createHash } from "node:crypto";
2
+ import { describe, expect, it } from "vitest";
3
+ import goldens from "./fixtures/prompt-goldens.json";
4
+ import { buildGenerativeUIMarkdownGuidelines } from "../a2ui-prompts";
5
+ import { buildGenerativeUIPrompt } from "../generative-ui/prompt";
6
+ import {
7
+ defaultGenerativeUIPromptSpec,
8
+ selectPromptItems,
9
+ } from "../generative-ui/prompt-spec";
10
+ import type {
11
+ GenerativeUIComponentManifest,
12
+ GenerativeUIManifest,
13
+ } from "../generative-ui/types";
14
+
15
+ interface Flags {
16
+ functions: boolean;
17
+ events: boolean;
18
+ templates: boolean;
19
+ checks: boolean;
20
+ surfaces: boolean;
21
+ }
22
+
23
+ const childList = { $ref: "common_types.json#/$defs/ChildList" };
24
+
25
+ /** The manifest the goldens were captured with, for one set of flags. */
26
+ function goldenManifest(f: Flags): GenerativeUIManifest {
27
+ const components: Record<string, GenerativeUIComponentManifest> = {
28
+ Text: {
29
+ description: "Shows text",
30
+ props: {
31
+ type: "object",
32
+ properties: { text: { type: "string", description: "The text" } },
33
+ },
34
+ },
35
+ Column: {
36
+ description: "A column",
37
+ props: {
38
+ type: "object",
39
+ properties: {
40
+ children: f.templates
41
+ ? childList
42
+ : { type: "array", items: { type: "string" } },
43
+ },
44
+ },
45
+ ...(f.templates ? { slots: { children: "multiple" as const } } : {}),
46
+ },
47
+ };
48
+ if (f.events) {
49
+ components.Button = {
50
+ description: "A button",
51
+ props: { type: "object", properties: { label: { type: "string" } } },
52
+ events: { onClick: { description: "Action" } },
53
+ };
54
+ }
55
+ if (f.checks) {
56
+ components.TextField = {
57
+ description: "An input",
58
+ props: {
59
+ type: "object",
60
+ properties: { value: { type: "string" }, checks: { type: "array" } },
61
+ },
62
+ };
63
+ }
64
+ return {
65
+ catalogId: "test/goldens@1",
66
+ components,
67
+ functions: {
68
+ formatCurrency: {
69
+ description: "Formats money",
70
+ parameters: {
71
+ type: "object",
72
+ description: "{value: number, currency: string}",
73
+ },
74
+ },
75
+ ...(f.functions
76
+ ? {
77
+ addToCart: {
78
+ description: "Adds to cart",
79
+ parameters: {
80
+ type: "object",
81
+ properties: { id: { type: "string" } },
82
+ },
83
+ },
84
+ }
85
+ : {}),
86
+ },
87
+ targets: [
88
+ { id: "chat", kind: "chat" },
89
+ {
90
+ id: "sidebar",
91
+ kind: "inline",
92
+ description: "The side panel",
93
+ components: ["Text"],
94
+ },
95
+ ],
96
+ surfaces: f.surfaces
97
+ ? {
98
+ s1: {
99
+ target: "chat",
100
+ dataModel: { name: "Ada" },
101
+ rejected: ["updateComponents: unknown component"],
102
+ },
103
+ }
104
+ : {},
105
+ };
106
+ }
107
+
108
+ const sha = (text: string) => createHash("sha256").update(text).digest("hex");
109
+
110
+ describe("prompt builders without a spec", () => {
111
+ it.each(goldens.map((g) => [JSON.stringify(g.flags), g] as const))(
112
+ "render today's text for %s",
113
+ (_name, golden) => {
114
+ const { surfaces: _surfaces, ...features } = golden.flags;
115
+ expect(sha(buildGenerativeUIMarkdownGuidelines(features))).toBe(
116
+ golden.markdown,
117
+ );
118
+ expect(sha(buildGenerativeUIPrompt(goldenManifest(golden.flags)))).toBe(
119
+ golden.tool,
120
+ );
121
+ },
122
+ );
123
+ });
124
+
125
+ describe("prompt builders with a spec", () => {
126
+ const noFeatures = {
127
+ functions: false,
128
+ events: false,
129
+ templates: false,
130
+ checks: false,
131
+ };
132
+
133
+ it("render the default spec exactly like no spec", () => {
134
+ const spec = defaultGenerativeUIPromptSpec();
135
+ expect(buildGenerativeUIMarkdownGuidelines(undefined, spec)).toBe(
136
+ buildGenerativeUIMarkdownGuidelines(),
137
+ );
138
+ const manifest = goldenManifest({ ...noFeatures, surfaces: true });
139
+ expect(buildGenerativeUIPrompt(manifest, spec)).toBe(
140
+ buildGenerativeUIPrompt(manifest),
141
+ );
142
+ });
143
+
144
+ it("use the intro, the paragraph and the rules of the spec", () => {
145
+ const spec = defaultGenerativeUIPromptSpec();
146
+ spec.markdown.intro = "Draw UI in a2ui fences.";
147
+ spec.markdown.whenToShow = "";
148
+ spec.markdown.rules = ["Rule one.", "Rule two."];
149
+ expect(buildGenerativeUIMarkdownGuidelines(noFeatures, spec)).toBe(
150
+ "Draw UI in a2ui fences.\n\nRULES\n- Rule one.\n- Rule two.\n",
151
+ );
152
+ spec.tool.intro = "Use render_ui.";
153
+ spec.tool.rules = ["Only rule."];
154
+ const tool = buildGenerativeUIPrompt(
155
+ goldenManifest({ ...noFeatures, surfaces: false }),
156
+ spec,
157
+ );
158
+ expect(tool).toContain("## Generative UI\nUse render_ui.\n\n");
159
+ expect(tool).toContain("Rules:\n1. Only rule.\n");
160
+ });
161
+
162
+ it("include a block only when all of its features hold", () => {
163
+ const items = [
164
+ "always",
165
+ { when: ["checks" as const], items: ["checks only"] },
166
+ {
167
+ when: ["events" as const, "noFunctions" as const],
168
+ items: ["events, no functions"],
169
+ },
170
+ ];
171
+ const features = {
172
+ functions: false,
173
+ noFunctions: true,
174
+ events: true,
175
+ templates: false,
176
+ checks: false,
177
+ agentCalls: false,
178
+ };
179
+ expect(selectPromptItems(items, features)).toEqual([
180
+ "always",
181
+ "events, no functions",
182
+ ]);
183
+ expect(
184
+ selectPromptItems(items, {
185
+ ...features,
186
+ checks: true,
187
+ noFunctions: false,
188
+ }),
189
+ ).toEqual(["always", "checks only"]);
190
+ });
191
+ });