@copilotkit/shared 2.0.0-next.1 → 2.0.0-rc.1

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 (592) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +93 -12
  3. package/dist/_virtual/_rolldown/runtime.cjs +29 -0
  4. package/dist/a2ui-envelope.cjs +154 -0
  5. package/dist/a2ui-envelope.cjs.map +1 -0
  6. package/dist/a2ui-envelope.d.cts +101 -0
  7. package/dist/a2ui-envelope.d.cts.map +1 -0
  8. package/dist/a2ui-envelope.d.mts +101 -0
  9. package/dist/a2ui-envelope.d.mts.map +1 -0
  10. package/dist/a2ui-envelope.mjs +151 -0
  11. package/dist/a2ui-envelope.mjs.map +1 -0
  12. package/dist/a2ui-prompts.cjs +259 -0
  13. package/dist/a2ui-prompts.cjs.map +1 -0
  14. package/dist/a2ui-prompts.d.cts +79 -0
  15. package/dist/a2ui-prompts.d.cts.map +1 -0
  16. package/dist/a2ui-prompts.d.mts +79 -0
  17. package/dist/a2ui-prompts.d.mts.map +1 -0
  18. package/dist/a2ui-prompts.mjs +251 -0
  19. package/dist/a2ui-prompts.mjs.map +1 -0
  20. package/dist/attachments/content.cjs +17 -0
  21. package/dist/attachments/content.cjs.map +1 -0
  22. package/dist/attachments/content.d.cts +9 -0
  23. package/dist/attachments/content.d.cts.map +1 -0
  24. package/dist/attachments/content.d.mts +9 -0
  25. package/dist/attachments/content.d.mts.map +1 -0
  26. package/dist/attachments/content.mjs +16 -0
  27. package/dist/attachments/content.mjs.map +1 -0
  28. package/dist/attachments/types.d.cts +64 -0
  29. package/dist/attachments/types.d.cts.map +1 -0
  30. package/dist/attachments/types.d.mts +64 -0
  31. package/dist/attachments/types.d.mts.map +1 -0
  32. package/dist/attachments/utils.cjs +137 -0
  33. package/dist/attachments/utils.cjs.map +1 -0
  34. package/dist/attachments/utils.d.cts +44 -0
  35. package/dist/attachments/utils.d.cts.map +1 -0
  36. package/dist/attachments/utils.d.mts +44 -0
  37. package/dist/attachments/utils.d.mts.map +1 -0
  38. package/dist/attachments/utils.mjs +129 -0
  39. package/dist/attachments/utils.mjs.map +1 -0
  40. package/dist/constants/index.cjs +25 -0
  41. package/dist/constants/index.cjs.map +1 -0
  42. package/dist/constants/index.d.cts +17 -0
  43. package/dist/constants/index.d.cts.map +1 -0
  44. package/dist/constants/index.d.mts +17 -0
  45. package/dist/constants/index.d.mts.map +1 -0
  46. package/dist/constants/index.mjs +17 -12
  47. package/dist/constants/index.mjs.map +1 -1
  48. package/dist/debug-event-envelope.d.cts +13 -0
  49. package/dist/debug-event-envelope.d.cts.map +1 -0
  50. package/dist/debug-event-envelope.d.mts +13 -0
  51. package/dist/debug-event-envelope.d.mts.map +1 -0
  52. package/dist/debug.cjs +38 -0
  53. package/dist/debug.cjs.map +1 -0
  54. package/dist/debug.d.cts +29 -0
  55. package/dist/debug.d.cts.map +1 -0
  56. package/dist/debug.d.mts +29 -0
  57. package/dist/debug.d.mts.map +1 -0
  58. package/dist/debug.mjs +37 -0
  59. package/dist/debug.mjs.map +1 -0
  60. package/dist/event-transforms/index.cjs +15 -0
  61. package/dist/event-transforms/index.d.cts +4 -0
  62. package/dist/event-transforms/index.d.mts +4 -0
  63. package/dist/event-transforms/index.mjs +5 -0
  64. package/dist/event-transforms/open-generative-ui-middleware.cjs +286 -0
  65. package/dist/event-transforms/open-generative-ui-middleware.cjs.map +1 -0
  66. package/dist/event-transforms/open-generative-ui-middleware.d.cts +60 -0
  67. package/dist/event-transforms/open-generative-ui-middleware.d.cts.map +1 -0
  68. package/dist/event-transforms/open-generative-ui-middleware.d.mts +60 -0
  69. package/dist/event-transforms/open-generative-ui-middleware.d.mts.map +1 -0
  70. package/dist/event-transforms/open-generative-ui-middleware.mjs +283 -0
  71. package/dist/event-transforms/open-generative-ui-middleware.mjs.map +1 -0
  72. package/dist/event-transforms/recorded-events.cjs +59 -0
  73. package/dist/event-transforms/recorded-events.cjs.map +1 -0
  74. package/dist/event-transforms/recorded-events.d.cts +23 -0
  75. package/dist/event-transforms/recorded-events.d.cts.map +1 -0
  76. package/dist/event-transforms/recorded-events.d.mts +23 -0
  77. package/dist/event-transforms/recorded-events.d.mts.map +1 -0
  78. package/dist/event-transforms/recorded-events.mjs +58 -0
  79. package/dist/event-transforms/recorded-events.mjs.map +1 -0
  80. package/dist/finalize-events.cjs +186 -0
  81. package/dist/finalize-events.cjs.map +1 -0
  82. package/dist/finalize-events.d.cts +40 -0
  83. package/dist/finalize-events.d.cts.map +1 -0
  84. package/dist/finalize-events.d.mts +40 -0
  85. package/dist/finalize-events.d.mts.map +1 -0
  86. package/dist/finalize-events.mjs +184 -0
  87. package/dist/finalize-events.mjs.map +1 -0
  88. package/dist/generative-ui/basic-functions.cjs +177 -0
  89. package/dist/generative-ui/basic-functions.cjs.map +1 -0
  90. package/dist/generative-ui/basic-functions.d.cts +108 -0
  91. package/dist/generative-ui/basic-functions.d.cts.map +1 -0
  92. package/dist/generative-ui/basic-functions.d.mts +108 -0
  93. package/dist/generative-ui/basic-functions.d.mts.map +1 -0
  94. package/dist/generative-ui/basic-functions.mjs +167 -0
  95. package/dist/generative-ui/basic-functions.mjs.map +1 -0
  96. package/dist/generative-ui/child-refs.cjs +161 -0
  97. package/dist/generative-ui/child-refs.cjs.map +1 -0
  98. package/dist/generative-ui/child-refs.d.cts +68 -0
  99. package/dist/generative-ui/child-refs.d.cts.map +1 -0
  100. package/dist/generative-ui/child-refs.d.mts +68 -0
  101. package/dist/generative-ui/child-refs.d.mts.map +1 -0
  102. package/dist/generative-ui/child-refs.mjs +152 -0
  103. package/dist/generative-ui/child-refs.mjs.map +1 -0
  104. package/dist/generative-ui/is-record.cjs +10 -0
  105. package/dist/generative-ui/is-record.cjs.map +1 -0
  106. package/dist/generative-ui/is-record.mjs +9 -0
  107. package/dist/generative-ui/is-record.mjs.map +1 -0
  108. package/dist/generative-ui/prompt.cjs +91 -0
  109. package/dist/generative-ui/prompt.cjs.map +1 -0
  110. package/dist/generative-ui/prompt.d.cts +13 -0
  111. package/dist/generative-ui/prompt.d.cts.map +1 -0
  112. package/dist/generative-ui/prompt.d.mts +13 -0
  113. package/dist/generative-ui/prompt.d.mts.map +1 -0
  114. package/dist/generative-ui/prompt.mjs +90 -0
  115. package/dist/generative-ui/prompt.mjs.map +1 -0
  116. package/dist/generative-ui/render-ui-args.cjs +160 -0
  117. package/dist/generative-ui/render-ui-args.cjs.map +1 -0
  118. package/dist/generative-ui/render-ui-args.d.cts +40 -0
  119. package/dist/generative-ui/render-ui-args.d.cts.map +1 -0
  120. package/dist/generative-ui/render-ui-args.d.mts +40 -0
  121. package/dist/generative-ui/render-ui-args.d.mts.map +1 -0
  122. package/dist/generative-ui/render-ui-args.mjs +159 -0
  123. package/dist/generative-ui/render-ui-args.mjs.map +1 -0
  124. package/dist/generative-ui/types.cjs +101 -0
  125. package/dist/generative-ui/types.cjs.map +1 -0
  126. package/dist/generative-ui/types.d.cts +270 -0
  127. package/dist/generative-ui/types.d.cts.map +1 -0
  128. package/dist/generative-ui/types.d.mts +270 -0
  129. package/dist/generative-ui/types.d.mts.map +1 -0
  130. package/dist/generative-ui/types.mjs +86 -0
  131. package/dist/generative-ui/types.mjs.map +1 -0
  132. package/dist/generative-ui/validate-operation.cjs +405 -0
  133. package/dist/generative-ui/validate-operation.cjs.map +1 -0
  134. package/dist/generative-ui/validate-operation.d.cts +86 -0
  135. package/dist/generative-ui/validate-operation.d.cts.map +1 -0
  136. package/dist/generative-ui/validate-operation.d.mts +86 -0
  137. package/dist/generative-ui/validate-operation.d.mts.map +1 -0
  138. package/dist/generative-ui/validate-operation.mjs +399 -0
  139. package/dist/generative-ui/validate-operation.mjs.map +1 -0
  140. package/dist/index.cjs +233 -0
  141. package/dist/index.cjs.map +1 -0
  142. package/dist/index.d.cts +80 -0
  143. package/dist/index.d.cts.map +1 -0
  144. package/dist/index.d.mts +80 -0
  145. package/dist/index.d.mts.map +1 -0
  146. package/dist/index.mjs +78 -123
  147. package/dist/index.mjs.map +1 -1
  148. package/dist/index.umd.js +3979 -0
  149. package/dist/index.umd.js.map +1 -0
  150. package/dist/intelligence-routing-fields.cjs +35 -0
  151. package/dist/intelligence-routing-fields.cjs.map +1 -0
  152. package/dist/intelligence-routing-fields.d.cts +18 -0
  153. package/dist/intelligence-routing-fields.d.cts.map +1 -0
  154. package/dist/intelligence-routing-fields.d.mts +18 -0
  155. package/dist/intelligence-routing-fields.d.mts.map +1 -0
  156. package/dist/intelligence-routing-fields.mjs +34 -0
  157. package/dist/intelligence-routing-fields.mjs.map +1 -0
  158. package/dist/logger.cjs +7 -0
  159. package/dist/logger.cjs.map +1 -0
  160. package/dist/logger.d.cts +5 -0
  161. package/dist/logger.d.cts.map +1 -0
  162. package/dist/logger.d.mts +5 -0
  163. package/dist/logger.d.mts.map +1 -0
  164. package/dist/logger.mjs +6 -0
  165. package/dist/logger.mjs.map +1 -0
  166. package/dist/open-generative-ui-prompts.cjs +8 -0
  167. package/dist/open-generative-ui-prompts.cjs.map +1 -0
  168. package/dist/open-generative-ui-prompts.d.cts +6 -0
  169. package/dist/open-generative-ui-prompts.d.cts.map +1 -0
  170. package/dist/open-generative-ui-prompts.d.mts +6 -0
  171. package/dist/open-generative-ui-prompts.d.mts.map +1 -0
  172. package/dist/open-generative-ui-prompts.mjs +7 -0
  173. package/dist/open-generative-ui-prompts.mjs.map +1 -0
  174. package/dist/package.cjs +12 -0
  175. package/dist/package.cjs.map +1 -0
  176. package/dist/package.mjs +6 -0
  177. package/dist/package.mjs.map +1 -0
  178. package/dist/standard-schema.cjs +31 -0
  179. package/dist/standard-schema.cjs.map +1 -0
  180. package/dist/standard-schema.d.cts +33 -0
  181. package/dist/standard-schema.d.cts.map +1 -0
  182. package/dist/standard-schema.d.mts +33 -0
  183. package/dist/standard-schema.d.mts.map +1 -0
  184. package/dist/standard-schema.mjs +30 -0
  185. package/dist/standard-schema.mjs.map +1 -0
  186. package/dist/telemetry/events.d.cts +72 -0
  187. package/dist/telemetry/events.d.cts.map +1 -0
  188. package/dist/telemetry/events.d.mts +72 -0
  189. package/dist/telemetry/events.d.mts.map +1 -0
  190. package/dist/telemetry/index.cjs +18 -0
  191. package/dist/telemetry/index.d.cts +5 -0
  192. package/dist/telemetry/index.d.mts +5 -0
  193. package/dist/telemetry/index.mjs +6 -12
  194. package/dist/telemetry/lambda-client.cjs +91 -0
  195. package/dist/telemetry/lambda-client.cjs.map +1 -0
  196. package/dist/telemetry/lambda-client.d.cts +31 -0
  197. package/dist/telemetry/lambda-client.d.cts.map +1 -0
  198. package/dist/telemetry/lambda-client.d.mts +31 -0
  199. package/dist/telemetry/lambda-client.d.mts.map +1 -0
  200. package/dist/telemetry/lambda-client.mjs +87 -0
  201. package/dist/telemetry/lambda-client.mjs.map +1 -0
  202. package/dist/telemetry/model-host.cjs +104 -0
  203. package/dist/telemetry/model-host.cjs.map +1 -0
  204. package/dist/telemetry/model-host.d.cts +26 -0
  205. package/dist/telemetry/model-host.d.cts.map +1 -0
  206. package/dist/telemetry/model-host.d.mts +26 -0
  207. package/dist/telemetry/model-host.d.mts.map +1 -0
  208. package/dist/telemetry/model-host.mjs +102 -0
  209. package/dist/telemetry/model-host.mjs.map +1 -0
  210. package/dist/telemetry/sampling.cjs +50 -0
  211. package/dist/telemetry/sampling.cjs.map +1 -0
  212. package/dist/telemetry/sampling.d.cts +57 -0
  213. package/dist/telemetry/sampling.d.cts.map +1 -0
  214. package/dist/telemetry/sampling.d.mts +57 -0
  215. package/dist/telemetry/sampling.d.mts.map +1 -0
  216. package/dist/telemetry/sampling.mjs +44 -0
  217. package/dist/telemetry/sampling.mjs.map +1 -0
  218. package/dist/telemetry/telemetry-client.cjs +165 -0
  219. package/dist/telemetry/telemetry-client.cjs.map +1 -0
  220. package/dist/telemetry/telemetry-client.d.cts +87 -0
  221. package/dist/telemetry/telemetry-client.d.cts.map +1 -0
  222. package/dist/telemetry/telemetry-client.d.mts +87 -0
  223. package/dist/telemetry/telemetry-client.d.mts.map +1 -0
  224. package/dist/telemetry/telemetry-client.mjs +162 -9
  225. package/dist/telemetry/telemetry-client.mjs.map +1 -1
  226. package/dist/telemetry/telemetry-disabled.cjs +20 -0
  227. package/dist/telemetry/telemetry-disabled.cjs.map +1 -0
  228. package/dist/telemetry/telemetry-disabled.d.cts +16 -0
  229. package/dist/telemetry/telemetry-disabled.d.cts.map +1 -0
  230. package/dist/telemetry/telemetry-disabled.d.mts +16 -0
  231. package/dist/telemetry/telemetry-disabled.d.mts.map +1 -0
  232. package/dist/telemetry/telemetry-disabled.mjs +19 -0
  233. package/dist/telemetry/telemetry-disabled.mjs.map +1 -0
  234. package/dist/telemetry/utils.cjs +14 -0
  235. package/dist/telemetry/utils.cjs.map +1 -0
  236. package/dist/telemetry/utils.mjs +12 -8
  237. package/dist/telemetry/utils.mjs.map +1 -1
  238. package/dist/transcription-errors.cjs +84 -0
  239. package/dist/transcription-errors.cjs.map +1 -0
  240. package/dist/transcription-errors.d.cts +52 -0
  241. package/dist/transcription-errors.d.cts.map +1 -0
  242. package/dist/transcription-errors.d.mts +52 -0
  243. package/dist/transcription-errors.d.mts.map +1 -0
  244. package/dist/transcription-errors.mjs +82 -0
  245. package/dist/transcription-errors.mjs.map +1 -0
  246. package/dist/types/{action.d.ts → action.d.cts} +32 -32
  247. package/dist/types/action.d.cts.map +1 -0
  248. package/dist/types/action.d.mts +59 -0
  249. package/dist/types/action.d.mts.map +1 -0
  250. package/dist/types/copilot-cloud-config.d.cts +15 -0
  251. package/dist/types/copilot-cloud-config.d.cts.map +1 -0
  252. package/dist/types/copilot-cloud-config.d.mts +15 -0
  253. package/dist/types/copilot-cloud-config.d.mts.map +1 -0
  254. package/dist/types/error.d.cts +57 -0
  255. package/dist/types/error.d.cts.map +1 -0
  256. package/dist/types/error.d.mts +57 -0
  257. package/dist/types/error.d.mts.map +1 -0
  258. package/dist/types/message.d.cts +42 -0
  259. package/dist/types/message.d.cts.map +1 -0
  260. package/dist/types/message.d.mts +42 -0
  261. package/dist/types/message.d.mts.map +1 -0
  262. package/dist/types/openai-assistant.d.cts +55 -0
  263. package/dist/types/openai-assistant.d.cts.map +1 -0
  264. package/dist/types/openai-assistant.d.mts +55 -0
  265. package/dist/types/openai-assistant.d.mts.map +1 -0
  266. package/dist/types/utility.d.cts +6 -0
  267. package/dist/types/utility.d.cts.map +1 -0
  268. package/dist/types/utility.d.mts +6 -0
  269. package/dist/types/utility.d.mts.map +1 -0
  270. package/dist/utils/clipboard.cjs +28 -0
  271. package/dist/utils/clipboard.cjs.map +1 -0
  272. package/dist/utils/clipboard.d.cts +14 -0
  273. package/dist/utils/clipboard.d.cts.map +1 -0
  274. package/dist/utils/clipboard.d.mts +14 -0
  275. package/dist/utils/clipboard.d.mts.map +1 -0
  276. package/dist/utils/clipboard.mjs +27 -0
  277. package/dist/utils/clipboard.mjs.map +1 -0
  278. package/dist/utils/conditions.cjs +32 -0
  279. package/dist/utils/conditions.cjs.map +1 -0
  280. package/dist/utils/{conditions.d.ts → conditions.d.cts} +16 -11
  281. package/dist/utils/conditions.d.cts.map +1 -0
  282. package/dist/utils/conditions.d.mts +31 -0
  283. package/dist/utils/conditions.d.mts.map +1 -0
  284. package/dist/utils/conditions.mjs +30 -6
  285. package/dist/utils/conditions.mjs.map +1 -1
  286. package/dist/utils/console-styling.cjs +91 -0
  287. package/dist/utils/console-styling.cjs.map +1 -0
  288. package/dist/utils/console-styling.d.cts +65 -0
  289. package/dist/utils/console-styling.d.cts.map +1 -0
  290. package/dist/utils/console-styling.d.mts +65 -0
  291. package/dist/utils/console-styling.d.mts.map +1 -0
  292. package/dist/utils/console-styling.mjs +83 -15
  293. package/dist/utils/console-styling.mjs.map +1 -1
  294. package/dist/utils/dashboard-url.cjs +19 -0
  295. package/dist/utils/dashboard-url.cjs.map +1 -0
  296. package/dist/utils/dashboard-url.mjs +18 -0
  297. package/dist/utils/dashboard-url.mjs.map +1 -0
  298. package/dist/utils/errors.cjs +439 -0
  299. package/dist/utils/errors.cjs.map +1 -0
  300. package/dist/utils/{errors.d.ts → errors.d.cts} +188 -156
  301. package/dist/utils/errors.d.cts.map +1 -0
  302. package/dist/utils/errors.d.mts +312 -0
  303. package/dist/utils/errors.d.mts.map +1 -0
  304. package/dist/utils/errors.mjs +416 -63
  305. package/dist/utils/errors.mjs.map +1 -1
  306. package/dist/utils/index.cjs +105 -0
  307. package/dist/utils/index.cjs.map +1 -0
  308. package/dist/utils/index.d.cts +58 -0
  309. package/dist/utils/index.d.cts.map +1 -0
  310. package/dist/utils/index.d.mts +58 -0
  311. package/dist/utils/index.d.mts.map +1 -0
  312. package/dist/utils/index.mjs +97 -107
  313. package/dist/utils/index.mjs.map +1 -1
  314. package/dist/utils/inspector-learning.cjs +217 -0
  315. package/dist/utils/inspector-learning.cjs.map +1 -0
  316. package/dist/utils/inspector-learning.d.cts +104 -0
  317. package/dist/utils/inspector-learning.d.cts.map +1 -0
  318. package/dist/utils/inspector-learning.d.mts +104 -0
  319. package/dist/utils/inspector-learning.d.mts.map +1 -0
  320. package/dist/utils/inspector-learning.mjs +215 -0
  321. package/dist/utils/inspector-learning.mjs.map +1 -0
  322. package/dist/utils/inspector-metadata.cjs +146 -0
  323. package/dist/utils/inspector-metadata.cjs.map +1 -0
  324. package/dist/utils/inspector-metadata.d.cts +55 -0
  325. package/dist/utils/inspector-metadata.d.cts.map +1 -0
  326. package/dist/utils/inspector-metadata.d.mts +55 -0
  327. package/dist/utils/inspector-metadata.d.mts.map +1 -0
  328. package/dist/utils/inspector-metadata.mjs +146 -0
  329. package/dist/utils/inspector-metadata.mjs.map +1 -0
  330. package/dist/utils/inspector-visibility.cjs +13 -0
  331. package/dist/utils/inspector-visibility.cjs.map +1 -0
  332. package/dist/utils/inspector-visibility.d.cts +18 -0
  333. package/dist/utils/inspector-visibility.d.cts.map +1 -0
  334. package/dist/utils/inspector-visibility.d.mts +18 -0
  335. package/dist/utils/inspector-visibility.d.mts.map +1 -0
  336. package/dist/utils/inspector-visibility.mjs +12 -0
  337. package/dist/utils/inspector-visibility.mjs.map +1 -0
  338. package/dist/utils/json-schema.cjs +215 -0
  339. package/dist/utils/json-schema.cjs.map +1 -0
  340. package/dist/utils/{json-schema.d.ts → json-schema.d.cts} +20 -18
  341. package/dist/utils/json-schema.d.cts.map +1 -0
  342. package/dist/utils/json-schema.d.mts +36 -0
  343. package/dist/utils/json-schema.d.mts.map +1 -0
  344. package/dist/utils/json-schema.mjs +210 -12
  345. package/dist/utils/json-schema.mjs.map +1 -1
  346. package/dist/utils/random-id.cjs +38 -0
  347. package/dist/utils/random-id.cjs.map +1 -0
  348. package/dist/utils/{random-id.d.ts → random-id.d.cts} +3 -1
  349. package/dist/utils/random-id.d.cts.map +1 -0
  350. package/dist/utils/random-id.d.mts +8 -0
  351. package/dist/utils/random-id.d.mts.map +1 -0
  352. package/dist/utils/random-id.mjs +33 -12
  353. package/dist/utils/random-id.mjs.map +1 -1
  354. package/dist/utils/requests.cjs +58 -0
  355. package/dist/utils/requests.cjs.map +1 -0
  356. package/dist/utils/{requests.d.ts → requests.d.cts} +3 -1
  357. package/dist/utils/requests.d.cts.map +1 -0
  358. package/dist/utils/requests.d.mts +12 -0
  359. package/dist/utils/requests.d.mts.map +1 -0
  360. package/dist/utils/requests.mjs +56 -6
  361. package/dist/utils/requests.mjs.map +1 -1
  362. package/dist/utils/row-render-keys.cjs +206 -0
  363. package/dist/utils/row-render-keys.cjs.map +1 -0
  364. package/dist/utils/row-render-keys.d.cts +65 -0
  365. package/dist/utils/row-render-keys.d.cts.map +1 -0
  366. package/dist/utils/row-render-keys.d.mts +65 -0
  367. package/dist/utils/row-render-keys.d.mts.map +1 -0
  368. package/dist/utils/row-render-keys.mjs +201 -0
  369. package/dist/utils/row-render-keys.mjs.map +1 -0
  370. package/dist/utils/types.cjs +9 -0
  371. package/dist/utils/types.cjs.map +1 -0
  372. package/dist/utils/types.d.cts +122 -0
  373. package/dist/utils/types.d.cts.map +1 -0
  374. package/dist/utils/types.d.mts +122 -0
  375. package/dist/utils/types.d.mts.map +1 -0
  376. package/dist/utils/types.mjs +6 -1
  377. package/dist/utils/types.mjs.map +1 -1
  378. package/package.json +74 -40
  379. package/scripts/verify-cjs-exports.cjs +16 -0
  380. package/src/__tests__/a2ui-envelope.test.ts +434 -0
  381. package/src/__tests__/a2ui-prompts.test.ts +362 -0
  382. package/src/__tests__/debug.test.ts +116 -0
  383. package/src/__tests__/license-context.test.ts +253 -0
  384. package/src/__tests__/root-entry-browser-safety.test.ts +91 -0
  385. package/src/__tests__/standard-schema-types.test.ts +144 -0
  386. package/src/__tests__/standard-schema.test.ts +359 -0
  387. package/src/__tests__/zod-regression.test.ts +319 -0
  388. package/src/a2ui-envelope.ts +309 -0
  389. package/src/a2ui-prompts.ts +322 -0
  390. package/src/attachments/__tests__/utils.test.ts +214 -0
  391. package/src/attachments/content.test.ts +48 -0
  392. package/src/attachments/content.ts +16 -0
  393. package/src/attachments/index.ts +21 -0
  394. package/src/attachments/types.ts +77 -0
  395. package/src/attachments/utils.ts +169 -0
  396. package/src/constants/index.ts +14 -1
  397. package/src/debug-event-envelope.ts +9 -0
  398. package/src/debug.ts +55 -0
  399. package/src/event-transforms/index.ts +5 -0
  400. package/src/event-transforms/open-generative-ui-middleware.ts +392 -0
  401. package/src/event-transforms/recorded-events.test.ts +166 -0
  402. package/src/event-transforms/recorded-events.ts +74 -0
  403. package/src/finalize-events.test.ts +284 -0
  404. package/src/finalize-events.ts +260 -0
  405. package/src/generative-ui/__tests__/render-ui-args.test.ts +175 -0
  406. package/src/generative-ui/__tests__/validate-operation.test.ts +977 -0
  407. package/src/generative-ui/basic-functions.ts +282 -0
  408. package/src/generative-ui/child-refs.ts +210 -0
  409. package/src/generative-ui/index.ts +6 -0
  410. package/src/generative-ui/is-record.ts +4 -0
  411. package/src/generative-ui/prompt.ts +174 -0
  412. package/src/generative-ui/render-ui-args.ts +199 -0
  413. package/src/generative-ui/types.ts +314 -0
  414. package/src/generative-ui/validate-operation.ts +723 -0
  415. package/src/index.ts +190 -1
  416. package/src/intelligence-routing-fields.test.ts +51 -0
  417. package/src/intelligence-routing-fields.ts +40 -0
  418. package/src/logger.ts +1 -0
  419. package/src/open-generative-ui-prompts.ts +20 -0
  420. package/src/standard-schema.ts +82 -0
  421. package/src/telemetry/events.ts +37 -10
  422. package/src/telemetry/index.ts +8 -0
  423. package/src/telemetry/lambda-client.test.ts +446 -0
  424. package/src/telemetry/lambda-client.ts +194 -0
  425. package/src/telemetry/model-host.test.ts +145 -0
  426. package/src/telemetry/model-host.ts +156 -0
  427. package/src/telemetry/sampling.test.ts +65 -0
  428. package/src/telemetry/sampling.ts +103 -0
  429. package/src/telemetry/telemetry-blank-license-identity.test.ts +128 -0
  430. package/src/telemetry/telemetry-client.test.ts +798 -0
  431. package/src/telemetry/telemetry-client.ts +223 -37
  432. package/src/telemetry/telemetry-disabled.ts +22 -0
  433. package/src/telemetry/utils.ts +0 -24
  434. package/src/transcription-errors.ts +99 -0
  435. package/src/types/__tests__/message.test.ts +62 -0
  436. package/src/types/action.ts +9 -5
  437. package/src/types/error.ts +11 -2
  438. package/src/types/message.ts +33 -5
  439. package/src/types/openai-assistant.ts +6 -2
  440. package/src/utils/__tests__/clipboard.test.ts +87 -0
  441. package/src/utils/__tests__/conditions.test.ts +161 -0
  442. package/src/utils/__tests__/json-schema.test.ts +812 -0
  443. package/src/utils/__tests__/row-render-keys.test.ts +388 -0
  444. package/src/utils/clipboard.ts +23 -0
  445. package/src/utils/conditions.ts +27 -9
  446. package/src/utils/console-styling.ts +10 -8
  447. package/src/utils/dashboard-url.ts +17 -0
  448. package/src/utils/errors.ts +55 -22
  449. package/src/utils/index.ts +70 -1
  450. package/src/utils/inspector-learning.test.ts +423 -0
  451. package/src/utils/inspector-learning.ts +523 -0
  452. package/src/utils/inspector-metadata.test.ts +743 -0
  453. package/src/utils/inspector-metadata.ts +263 -0
  454. package/src/utils/inspector-visibility.test.ts +43 -0
  455. package/src/utils/inspector-visibility.ts +17 -0
  456. package/src/utils/json-schema.ts +156 -12
  457. package/src/utils/random-id.ts +5 -2
  458. package/src/utils/requests.ts +3 -1
  459. package/src/utils/row-render-keys.ts +263 -0
  460. package/src/utils/types.ts +128 -1
  461. package/src/utils.test.ts +137 -0
  462. package/tsconfig.json +10 -2
  463. package/tsdown.config.ts +49 -0
  464. package/vitest.config.mjs +11 -0
  465. package/CHANGELOG.md +0 -1817
  466. package/dist/chunk-2OJ5OJ2D.mjs +0 -1
  467. package/dist/chunk-2OJ5OJ2D.mjs.map +0 -1
  468. package/dist/chunk-64DYJ27R.mjs +0 -201
  469. package/dist/chunk-64DYJ27R.mjs.map +0 -1
  470. package/dist/chunk-6QGXWNS5.mjs +0 -34
  471. package/dist/chunk-6QGXWNS5.mjs.map +0 -1
  472. package/dist/chunk-6W2UEO2M.mjs +0 -94
  473. package/dist/chunk-6W2UEO2M.mjs.map +0 -1
  474. package/dist/chunk-7DJDTRNX.mjs +0 -426
  475. package/dist/chunk-7DJDTRNX.mjs.map +0 -1
  476. package/dist/chunk-A66772CV.mjs +0 -107
  477. package/dist/chunk-A66772CV.mjs.map +0 -1
  478. package/dist/chunk-BOKE4OKY.mjs +0 -41
  479. package/dist/chunk-BOKE4OKY.mjs.map +0 -1
  480. package/dist/chunk-FCCOSO5L.mjs +0 -1
  481. package/dist/chunk-FCCOSO5L.mjs.map +0 -1
  482. package/dist/chunk-GYZIHHE6.mjs +0 -13
  483. package/dist/chunk-GYZIHHE6.mjs.map +0 -1
  484. package/dist/chunk-IAFBVORQ.mjs +0 -1
  485. package/dist/chunk-IAFBVORQ.mjs.map +0 -1
  486. package/dist/chunk-JAAUCDUR.mjs +0 -38
  487. package/dist/chunk-JAAUCDUR.mjs.map +0 -1
  488. package/dist/chunk-MSUB6DGR.mjs +0 -1
  489. package/dist/chunk-MSUB6DGR.mjs.map +0 -1
  490. package/dist/chunk-N5EP5OD5.mjs +0 -1
  491. package/dist/chunk-N5EP5OD5.mjs.map +0 -1
  492. package/dist/chunk-NAFEBKSO.mjs +0 -1
  493. package/dist/chunk-NAFEBKSO.mjs.map +0 -1
  494. package/dist/chunk-P7STFMPO.mjs +0 -1
  495. package/dist/chunk-P7STFMPO.mjs.map +0 -1
  496. package/dist/chunk-PL5WNHFZ.mjs +0 -50
  497. package/dist/chunk-PL5WNHFZ.mjs.map +0 -1
  498. package/dist/chunk-UYARLQNA.mjs +0 -1
  499. package/dist/chunk-UYARLQNA.mjs.map +0 -1
  500. package/dist/chunk-XEMZTHQZ.mjs +0 -67
  501. package/dist/chunk-XEMZTHQZ.mjs.map +0 -1
  502. package/dist/chunk-XTHC46M2.mjs +0 -1
  503. package/dist/chunk-XTHC46M2.mjs.map +0 -1
  504. package/dist/constants/index.d.ts +0 -6
  505. package/dist/constants/index.js +0 -40
  506. package/dist/constants/index.js.map +0 -1
  507. package/dist/index.d.ts +0 -25
  508. package/dist/index.js +0 -1098
  509. package/dist/index.js.map +0 -1
  510. package/dist/telemetry/events.d.ts +0 -45
  511. package/dist/telemetry/events.js +0 -19
  512. package/dist/telemetry/events.js.map +0 -1
  513. package/dist/telemetry/events.mjs +0 -1
  514. package/dist/telemetry/events.mjs.map +0 -1
  515. package/dist/telemetry/index.d.ts +0 -3
  516. package/dist/telemetry/index.js +0 -188
  517. package/dist/telemetry/index.js.map +0 -1
  518. package/dist/telemetry/index.mjs.map +0 -1
  519. package/dist/telemetry/scarf-client.d.ts +0 -7
  520. package/dist/telemetry/scarf-client.js +0 -59
  521. package/dist/telemetry/scarf-client.js.map +0 -1
  522. package/dist/telemetry/scarf-client.mjs +0 -7
  523. package/dist/telemetry/scarf-client.mjs.map +0 -1
  524. package/dist/telemetry/security-check.d.ts +0 -2
  525. package/dist/telemetry/security-check.js +0 -2
  526. package/dist/telemetry/security-check.js.map +0 -1
  527. package/dist/telemetry/security-check.mjs +0 -1
  528. package/dist/telemetry/security-check.mjs.map +0 -1
  529. package/dist/telemetry/telemetry-client.d.ts +0 -40
  530. package/dist/telemetry/telemetry-client.js +0 -186
  531. package/dist/telemetry/telemetry-client.js.map +0 -1
  532. package/dist/telemetry/utils.d.ts +0 -8
  533. package/dist/telemetry/utils.js +0 -69
  534. package/dist/telemetry/utils.js.map +0 -1
  535. package/dist/types/action.js +0 -19
  536. package/dist/types/action.js.map +0 -1
  537. package/dist/types/action.mjs +0 -2
  538. package/dist/types/action.mjs.map +0 -1
  539. package/dist/types/copilot-cloud-config.d.ts +0 -13
  540. package/dist/types/copilot-cloud-config.js +0 -19
  541. package/dist/types/copilot-cloud-config.js.map +0 -1
  542. package/dist/types/copilot-cloud-config.mjs +0 -2
  543. package/dist/types/copilot-cloud-config.mjs.map +0 -1
  544. package/dist/types/error.d.ts +0 -55
  545. package/dist/types/error.js +0 -19
  546. package/dist/types/error.js.map +0 -1
  547. package/dist/types/error.mjs +0 -2
  548. package/dist/types/error.mjs.map +0 -1
  549. package/dist/types/index.d.ts +0 -7
  550. package/dist/types/index.js +0 -19
  551. package/dist/types/index.js.map +0 -1
  552. package/dist/types/index.mjs +0 -8
  553. package/dist/types/index.mjs.map +0 -1
  554. package/dist/types/message.d.ts +0 -26
  555. package/dist/types/message.js +0 -19
  556. package/dist/types/message.js.map +0 -1
  557. package/dist/types/message.mjs +0 -2
  558. package/dist/types/message.mjs.map +0 -1
  559. package/dist/types/openai-assistant.d.ts +0 -53
  560. package/dist/types/openai-assistant.js +0 -19
  561. package/dist/types/openai-assistant.js.map +0 -1
  562. package/dist/types/openai-assistant.mjs +0 -2
  563. package/dist/types/openai-assistant.mjs.map +0 -1
  564. package/dist/types/utility.d.ts +0 -6
  565. package/dist/types/utility.js +0 -19
  566. package/dist/types/utility.js.map +0 -1
  567. package/dist/types/utility.mjs +0 -2
  568. package/dist/types/utility.mjs.map +0 -1
  569. package/dist/utils/conditions.js +0 -74
  570. package/dist/utils/conditions.js.map +0 -1
  571. package/dist/utils/console-styling.d.ts +0 -84
  572. package/dist/utils/console-styling.js +0 -123
  573. package/dist/utils/console-styling.js.map +0 -1
  574. package/dist/utils/errors.js +0 -443
  575. package/dist/utils/errors.js.map +0 -1
  576. package/dist/utils/index.d.ts +0 -32
  577. package/dist/utils/index.js +0 -927
  578. package/dist/utils/index.js.map +0 -1
  579. package/dist/utils/json-schema.js +0 -228
  580. package/dist/utils/json-schema.js.map +0 -1
  581. package/dist/utils/random-id.js +0 -68
  582. package/dist/utils/random-id.js.map +0 -1
  583. package/dist/utils/requests.js +0 -91
  584. package/dist/utils/requests.js.map +0 -1
  585. package/dist/utils/types.d.ts +0 -20
  586. package/dist/utils/types.js +0 -19
  587. package/dist/utils/types.js.map +0 -1
  588. package/jest.config.js +0 -5
  589. package/src/telemetry/scarf-client.ts +0 -39
  590. package/src/telemetry/security-check.ts +0 -0
  591. package/src/utils/json-schema.test.ts +0 -383
  592. package/tsup.config.ts +0 -11
@@ -0,0 +1,362 @@
1
+ import { describe, expect, it } from "vitest";
2
+ import {
3
+ buildGenerativeUIMarkdownGuidelines,
4
+ generativeUIGuideFeatures,
5
+ GENERATIVE_UI_MARKDOWN_GUIDELINES,
6
+ GENERATIVE_UI_MARKDOWN_GUIDELINES_DESCRIPTION,
7
+ GENERATIVE_UI_MARKDOWN_SCHEMA_CONTEXT_DESCRIPTION,
8
+ GENERATIVE_UI_WHEN_TO_SHOW,
9
+ } from "../a2ui-prompts";
10
+ import { COPILOTKIT_FUNCTIONS } from "../generative-ui/basic-functions";
11
+ import { buildGenerativeUIPrompt } from "../generative-ui/prompt";
12
+ import { GENERATIVE_UI_AGENT_FUNCTION_CALLS } from "../generative-ui/types";
13
+
14
+ const guide = GENERATIVE_UI_MARKDOWN_GUIDELINES;
15
+
16
+ describe("GENERATIVE_UI_MARKDOWN_GUIDELINES", () => {
17
+ it("tells the model to write fences, and never to call a tool", () => {
18
+ expect(guide).toContain("```a2ui");
19
+ expect(guide).not.toContain("render_ui");
20
+ expect(guide).not.toContain("render_a2ui");
21
+ });
22
+
23
+ it("places a fence in the chat or in a named target", () => {
24
+ expect(guide).toContain(
25
+ "Open a fence with ```a2ui to show the surface in the chat, at the place of the fence.",
26
+ );
27
+ expect(guide).toContain(
28
+ "Open a fence with ```a2ui target=<id> to show the surface in a named target.",
29
+ );
30
+ expect(guide).toContain(
31
+ 'When a target has "components", its surfaces can use only those components.',
32
+ );
33
+ });
34
+
35
+ it("asks for one JSON object per line, each with the v1.0 version and no catalogId", () => {
36
+ 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).not.toContain("v0.9");
39
+ expect(guide).not.toContain("catalogId");
40
+ });
41
+
42
+ it("starts a surface with one createSurface that holds the data and the root, then streams the children", () => {
43
+ expect(guide).toContain(
44
+ 'Start a surface with one createSurface. Put all the initial data in "dataModel" and the "root" component in "components".',
45
+ );
46
+ expect(guide).toContain(
47
+ '{"version":"v1.0","createSurface":{"surfaceId":"plan-picker","dataModel":{ ...initial data... },"components":[{"id":"root"',
48
+ );
49
+ expect(guide.indexOf('"createSurface"')).toBeLessThan(
50
+ guide.indexOf('"updateComponents"'),
51
+ );
52
+ expect(guide).toContain('Keep "dataModel" flat');
53
+ });
54
+
55
+ it("keeps components flat, which live models got wrong", () => {
56
+ expect(guide).toContain(
57
+ 'Put the component name in "component" (never "type")',
58
+ );
59
+ expect(guide).toContain('never inside a "props" object');
60
+ });
61
+
62
+ it("describes @path bindings for data and for writable inputs, and forbids the path form", () => {
63
+ expect(guide).toContain('bind it to the data model with {"@path":"/x"}');
64
+ expect(guide).toContain('Never write {"path":"/x"} as a binding.');
65
+ expect(guide).toContain(
66
+ 'Bind a writable prop to let the user edit it: "value":{"@path":"/form/email"}.',
67
+ );
68
+ });
69
+
70
+ it("requires a value in updateDataModel and deletes with null", () => {
71
+ expect(guide).toContain('Always give "value".');
72
+ expect(guide).toContain('Set "value":null to delete the key at "path".');
73
+ });
74
+
75
+ it("describes events with userMessage, function calls with @call, and that an unbound button does nothing", () => {
76
+ expect(guide).toContain(
77
+ '{"event":{"name":"<name>","userMessage":"<text>","context":{...}}}',
78
+ );
79
+ expect(guide).toContain(
80
+ '{"functionCall":{"@call":"<function>","args":{...}}}',
81
+ );
82
+ expect(guide).toContain(
83
+ '{"event":{"name":"choose","userMessage":"Show me the Team plan"}}',
84
+ );
85
+ expect(guide).toContain('"context":{"email":{"@path":"/form/email"}}');
86
+ expect(guide).toContain('Never a flat {"event":"<name>"}.');
87
+ expect(guide).toContain(
88
+ "A button or other event prop without an event or functionCall does nothing.",
89
+ );
90
+ });
91
+
92
+ it("describes function values and the formatString grammar", () => {
93
+ expect(guide).toContain(
94
+ 'A prop can also be a function value that updates with the data: {"@call":"formatCurrency"',
95
+ );
96
+ expect(guide).toContain(
97
+ 'Use only the functions under "functions" in the schema.',
98
+ );
99
+ expect(guide).toContain("formatString interpolates ${...}");
100
+ expect(guide).toContain(
101
+ "Inside formatString, ${...} does not support operators",
102
+ );
103
+ expect(guide).toContain(
104
+ '{"@call":"calc","args":{"expression":"seats * 29 * (annual ? 0.8 : 1)"',
105
+ );
106
+ expect(guide).toContain(
107
+ 'use series. Its description under "functions" in the schema',
108
+ );
109
+ expect(guide).toContain('the "items" of a List');
110
+ expect(guide).not.toContain("template path of a list");
111
+ expect(guide).toContain('{"@call":"@index","args":{"offset":1}}');
112
+ });
113
+
114
+ it("describes checks with the validator functions", () => {
115
+ expect(guide).toContain('Validate an input with "checks"');
116
+ expect(guide).toContain("required, regex, length, numeric and email");
117
+ expect(guide).toContain("disables a Button that has the same checks");
118
+ });
119
+
120
+ it("describes slots with child ids and with a template of relative paths", () => {
121
+ expect(guide).toContain('"tabs":[{"title":"Specs","child":"specs"}]');
122
+ expect(guide).toContain('"children":["a","b"]');
123
+ expect(guide).toContain('"children":{"componentId":"row","path":"/items"}');
124
+ expect(guide).toContain(
125
+ 'paths are relative to the item ("name", not "/name")',
126
+ );
127
+ });
128
+
129
+ it("updates a surface from a later fence with the same surfaceId in the reply, and a target from a later reply", () => {
130
+ expect(guide).toContain(
131
+ "To change a surface in this reply, write another fence with the same surfaceId.",
132
+ );
133
+ expect(guide).toContain(
134
+ "A surface in a target can also be changed from a later reply; a chat surface cannot",
135
+ );
136
+ expect(guide).toContain(
137
+ "Never use a surfaceId again, also after the surface is deleted.",
138
+ );
139
+ });
140
+
141
+ it.skipIf(GENERATIVE_UI_AGENT_FUNCTION_CALLS)(
142
+ "does not mention callRendererFunction while the agent path is off",
143
+ () => {
144
+ expect(guide).not.toContain("callRendererFunction");
145
+ expect(guide).not.toContain("rendererFunctionResponse");
146
+ },
147
+ );
148
+
149
+ it.skipIf(!GENERATIVE_UI_AGENT_FUNCTION_CALLS)(
150
+ "describes callRendererFunction, its unique id, and the developer-message response",
151
+ () => {
152
+ expect(guide).toContain(
153
+ '{"version":"v1.0","callRendererFunction":{"functionCallId":"<unique id>","callFunction":{"@call":"<function>","args":{...}}}}',
154
+ );
155
+ expect(guide).toContain(
156
+ "Give every callRendererFunction a new functionCallId.",
157
+ );
158
+ expect(guide).toContain('"callers": "UI or agent" or "agent only"');
159
+ expect(guide).toContain(
160
+ '{"version":"v1.0","rendererFunctionResponse":{"functionCallId":"<id>","value":...}}',
161
+ );
162
+ expect(guide).toContain("Then you get a new turn.");
163
+ },
164
+ );
165
+
166
+ it("keeps prose outside the fences and Card for interactive panels", () => {
167
+ expect(guide).toContain("Never make a surface that is only prose.");
168
+ expect(guide).toContain("Use Card only for an interactive panel");
169
+ expect(guide).toContain("Never wrap the whole reply in a fence.");
170
+ });
171
+ });
172
+
173
+ describe("markdown context entry descriptions", () => {
174
+ it("names the schema entry differently from the a2ui-middleware schema key", () => {
175
+ // The LangGraph and Strands adapters move an entry with this exact
176
+ // description out of the prompt and into the render_a2ui tool state.
177
+ expect(GENERATIVE_UI_MARKDOWN_SCHEMA_CONTEXT_DESCRIPTION).not.toBe(
178
+ "A2UI Component Schema — available components for generating UI surfaces. Use these component names and properties when creating A2UI operations.",
179
+ );
180
+ expect(GENERATIVE_UI_MARKDOWN_SCHEMA_CONTEXT_DESCRIPTION).not.toBe(
181
+ GENERATIVE_UI_MARKDOWN_GUIDELINES_DESCRIPTION,
182
+ );
183
+ });
184
+ });
185
+
186
+ describe("generativeUIGuideFeatures", () => {
187
+ const props = { type: "object", properties: {} };
188
+
189
+ it("finds mounted functions, event props, and multiple slots", () => {
190
+ expect(
191
+ generativeUIGuideFeatures({
192
+ components: {
193
+ List: { props, slots: { items: "multiple" } },
194
+ Button: { props, events: { onClick: { parameters: props } } },
195
+ },
196
+ functions: { save: { parameters: props } },
197
+ }),
198
+ ).toEqual({
199
+ functions: true,
200
+ events: true,
201
+ templates: true,
202
+ checks: false,
203
+ });
204
+ });
205
+
206
+ it("finds none when the components have no events or multiple slots and no function is mounted", () => {
207
+ expect(
208
+ generativeUIGuideFeatures({
209
+ components: {
210
+ Card: { props, slots: { child: "single" }, events: {} },
211
+ },
212
+ functions: {},
213
+ }),
214
+ ).toEqual({
215
+ functions: false,
216
+ events: false,
217
+ templates: false,
218
+ checks: false,
219
+ });
220
+ });
221
+ });
222
+
223
+ describe("buildGenerativeUIMarkdownGuidelines", () => {
224
+ const none = {
225
+ functions: false,
226
+ events: false,
227
+ templates: false,
228
+ checks: false,
229
+ };
230
+
231
+ it("has every rule group by default", () => {
232
+ expect(buildGenerativeUIMarkdownGuidelines()).toBe(
233
+ GENERATIVE_UI_MARKDOWN_GUIDELINES,
234
+ );
235
+ });
236
+
237
+ it("leaves out the function, event, and template rules when they are off", () => {
238
+ const small = buildGenerativeUIMarkdownGuidelines(none);
239
+ expect(small).not.toContain("callRendererFunction");
240
+ expect(small).not.toContain("functionCall");
241
+ expect(small).not.toContain("userMessage");
242
+ expect(small).not.toContain("@index");
243
+ expect(small).not.toContain('"checks"');
244
+ expect(small).toContain("Never wrap the whole reply in a fence.");
245
+ expect(small.length).toBeLessThan(GENERATIVE_UI_MARKDOWN_GUIDELINES.length);
246
+ });
247
+
248
+ it("keeps events and openUrl, but no app functions, when none is mounted", () => {
249
+ const text = buildGenerativeUIMarkdownGuidelines({ ...none, events: true });
250
+ expect(text).toContain("userMessage");
251
+ expect(text).toContain('"@call":"openUrl"');
252
+ expect(text).not.toContain("an app function from the schema");
253
+ expect(text).not.toContain("callRendererFunction");
254
+ });
255
+
256
+ it("adds the checks rule for a component with a checks prop", () => {
257
+ const text = buildGenerativeUIMarkdownGuidelines({ ...none, checks: true });
258
+ expect(text).toContain('Validate an input with "checks"');
259
+ expect(
260
+ generativeUIGuideFeatures({
261
+ components: {
262
+ TextField: {
263
+ props: {
264
+ type: "object",
265
+ properties: { checks: { type: "array" } },
266
+ },
267
+ },
268
+ },
269
+ functions: {},
270
+ }).checks,
271
+ ).toBe(true);
272
+ });
273
+
274
+ it("adds the template and @index rules for a multiple slot", () => {
275
+ const text = buildGenerativeUIMarkdownGuidelines({
276
+ ...none,
277
+ templates: true,
278
+ });
279
+ expect(text).toContain("@index");
280
+ expect(text).toContain("componentId");
281
+ });
282
+ });
283
+
284
+ describe("GENERATIVE_UI_WHEN_TO_SHOW", () => {
285
+ it("encourages UI where it conveys the answer better, and prose otherwise, on both transports", () => {
286
+ expect(GENERATIVE_UI_WHEN_TO_SHOW).toContain("illustrate a concept");
287
+ expect(GENERATIVE_UI_WHEN_TO_SHOW).toContain("prose alone");
288
+ expect(GENERATIVE_UI_WHEN_TO_SHOW).toContain("decoration");
289
+ expect(buildGenerativeUIMarkdownGuidelines()).toContain(
290
+ GENERATIVE_UI_WHEN_TO_SHOW,
291
+ );
292
+ expect(
293
+ buildGenerativeUIPrompt({
294
+ catalogId: "test",
295
+ targets: [],
296
+ components: {},
297
+ functions: {},
298
+ surfaces: {},
299
+ }),
300
+ ).toContain(GENERATIVE_UI_WHEN_TO_SHOW);
301
+ });
302
+ });
303
+
304
+ describe("computed data guidance", () => {
305
+ const series = COPILOTKIT_FUNCTIONS.series;
306
+ const markdownGuide = buildGenerativeUIMarkdownGuidelines();
307
+ const toolPrompt = buildGenerativeUIPrompt({
308
+ catalogId: "test",
309
+ targets: [],
310
+ components: {},
311
+ functions: {
312
+ series: {
313
+ description: series.description,
314
+ parameters: { type: "object", description: series.parameters },
315
+ returnType: series.returnType,
316
+ },
317
+ },
318
+ surfaces: {},
319
+ });
320
+
321
+ it("the series description carries the rules and the example", () => {
322
+ expect(series.description).toContain('"month":"${i}"');
323
+ expect(series.description).toContain(
324
+ '"monthlyCost":{"@path":"/monthlyCost"}',
325
+ );
326
+ expect(series.description).toContain(
327
+ "whole-expression string retains the result type",
328
+ );
329
+ expect(series.description).toContain("resolve before the series loop");
330
+ expect(series.description).not.toContain('"variable":"m"');
331
+ expect(series.description).not.toContain("WORKAROUND");
332
+ expect(series.description).not.toContain("a2ui-agent-sdk");
333
+ });
334
+
335
+ it.each([
336
+ ["markdown", markdownGuide],
337
+ ["tool", toolPrompt],
338
+ ])(
339
+ "points to series and scopes ${...} in the %s transport",
340
+ (_transport, prompt) => {
341
+ expect(prompt).toContain(
342
+ "For a computed list (chart data, template items) use series. Its description under",
343
+ );
344
+ expect(prompt).toContain(
345
+ "${...} is evaluated only in the value of formatString and in the item of series",
346
+ );
347
+ expect(prompt).toContain(
348
+ "Inside formatString, ${...} does not support operators",
349
+ );
350
+ expect(prompt).not.toContain('"variable":"m"');
351
+ expect(prompt).not.toContain("There are no operators in ${...}");
352
+ },
353
+ );
354
+
355
+ it("gives the series description once, in the function list of the tool prompt", () => {
356
+ expect(toolPrompt.split(series.description)).toHaveLength(2);
357
+ });
358
+
359
+ it("leaves the series description to the schema in the markdown guide", () => {
360
+ expect(markdownGuide).not.toContain(series.description);
361
+ });
362
+ });
@@ -0,0 +1,116 @@
1
+ import { describe, it, expect } from "vitest";
2
+ import { resolveDebugConfig } from "../debug";
3
+
4
+ describe("resolveDebugConfig", () => {
5
+ it("returns all-off for undefined", () => {
6
+ expect(resolveDebugConfig(undefined)).toEqual({
7
+ enabled: false,
8
+ events: false,
9
+ lifecycle: false,
10
+ verbose: false,
11
+ });
12
+ });
13
+
14
+ it("returns all-off for false", () => {
15
+ expect(resolveDebugConfig(false)).toEqual({
16
+ enabled: false,
17
+ events: false,
18
+ lifecycle: false,
19
+ verbose: false,
20
+ });
21
+ });
22
+
23
+ it("returns events + lifecycle on but verbose off for true (PII safety)", () => {
24
+ expect(resolveDebugConfig(true)).toEqual({
25
+ enabled: true,
26
+ events: true,
27
+ lifecycle: true,
28
+ verbose: false,
29
+ });
30
+ });
31
+
32
+ it("allows explicit verbose opt-in via object shorthand", () => {
33
+ expect(resolveDebugConfig({ verbose: true })).toEqual({
34
+ enabled: true,
35
+ events: true,
36
+ lifecycle: true,
37
+ verbose: true,
38
+ });
39
+ });
40
+
41
+ it("allows explicit verbose opt-in with events", () => {
42
+ expect(resolveDebugConfig({ events: true, verbose: true })).toEqual({
43
+ enabled: true,
44
+ events: true,
45
+ lifecycle: true,
46
+ verbose: true,
47
+ });
48
+ });
49
+
50
+ it("defaults events and lifecycle to true, verbose to false for empty object", () => {
51
+ expect(resolveDebugConfig({})).toEqual({
52
+ enabled: true,
53
+ events: true,
54
+ lifecycle: true,
55
+ verbose: false,
56
+ });
57
+ });
58
+
59
+ it("respects explicit events: true", () => {
60
+ expect(resolveDebugConfig({ events: true })).toEqual({
61
+ enabled: true,
62
+ events: true,
63
+ lifecycle: true,
64
+ verbose: false,
65
+ });
66
+ });
67
+
68
+ it("respects explicit events: false (lifecycle still defaults true)", () => {
69
+ expect(resolveDebugConfig({ events: false })).toEqual({
70
+ enabled: true,
71
+ events: false,
72
+ lifecycle: true,
73
+ verbose: false,
74
+ });
75
+ });
76
+
77
+ it("respects explicit lifecycle: false (events still defaults true)", () => {
78
+ expect(resolveDebugConfig({ lifecycle: false })).toEqual({
79
+ enabled: true,
80
+ events: true,
81
+ lifecycle: false,
82
+ verbose: false,
83
+ });
84
+ });
85
+
86
+ it("sets enabled to false when both events and lifecycle are false", () => {
87
+ expect(resolveDebugConfig({ events: false, lifecycle: false })).toEqual({
88
+ enabled: false,
89
+ events: false,
90
+ lifecycle: false,
91
+ verbose: false,
92
+ });
93
+ });
94
+
95
+ it("clamps verbose to false when enabled is false (events and lifecycle both false)", () => {
96
+ expect(
97
+ resolveDebugConfig({ events: false, lifecycle: false, verbose: true }),
98
+ ).toEqual({
99
+ enabled: false,
100
+ events: false,
101
+ lifecycle: false,
102
+ verbose: false,
103
+ });
104
+ });
105
+
106
+ it("handles mixed config: events true, lifecycle false, verbose true", () => {
107
+ expect(
108
+ resolveDebugConfig({ events: true, lifecycle: false, verbose: true }),
109
+ ).toEqual({
110
+ enabled: true,
111
+ events: true,
112
+ lifecycle: false,
113
+ verbose: true,
114
+ });
115
+ });
116
+ });