@copilotkit/shared 2.0.0-rc.5 → 2.0.0-rc.51

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 (569) hide show
  1. package/README.md +4 -15
  2. package/dist/a2ui-envelope.cjs +3 -3
  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 +3 -3
  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/catalog/catalog-export.cjs +329 -0
  41. package/dist/generative-ui/catalog/catalog-export.cjs.map +1 -0
  42. package/dist/generative-ui/catalog/catalog-export.d.cts +92 -0
  43. package/dist/generative-ui/catalog/catalog-export.d.cts.map +1 -0
  44. package/dist/generative-ui/catalog/catalog-export.d.mts +92 -0
  45. package/dist/generative-ui/catalog/catalog-export.d.mts.map +1 -0
  46. package/dist/generative-ui/catalog/catalog-export.mjs +328 -0
  47. package/dist/generative-ui/catalog/catalog-export.mjs.map +1 -0
  48. package/dist/generative-ui/catalog/catalog.cjs +315 -0
  49. package/dist/generative-ui/catalog/catalog.cjs.map +1 -0
  50. package/dist/generative-ui/catalog/catalog.d.cts +407 -0
  51. package/dist/generative-ui/catalog/catalog.d.cts.map +1 -0
  52. package/dist/generative-ui/catalog/catalog.d.mts +407 -0
  53. package/dist/generative-ui/catalog/catalog.d.mts.map +1 -0
  54. package/dist/generative-ui/catalog/catalog.mjs +312 -0
  55. package/dist/generative-ui/catalog/catalog.mjs.map +1 -0
  56. package/dist/generative-ui/catalog/errors.cjs +13 -0
  57. package/dist/generative-ui/catalog/errors.cjs.map +1 -0
  58. package/dist/generative-ui/catalog/errors.d.cts +46 -0
  59. package/dist/generative-ui/catalog/errors.d.cts.map +1 -0
  60. package/dist/generative-ui/catalog/errors.d.mts +46 -0
  61. package/dist/generative-ui/catalog/errors.d.mts.map +1 -0
  62. package/dist/generative-ui/catalog/errors.mjs +12 -0
  63. package/dist/generative-ui/catalog/errors.mjs.map +1 -0
  64. package/dist/generative-ui/catalog/index.d.mts +6 -0
  65. package/dist/generative-ui/catalog/json-schema.cjs +16 -0
  66. package/dist/generative-ui/catalog/json-schema.cjs.map +1 -0
  67. package/dist/generative-ui/catalog/json-schema.d.cts +12 -0
  68. package/dist/generative-ui/catalog/json-schema.d.cts.map +1 -0
  69. package/dist/generative-ui/catalog/json-schema.d.mts +12 -0
  70. package/dist/generative-ui/catalog/json-schema.d.mts.map +1 -0
  71. package/dist/generative-ui/catalog/json-schema.mjs +16 -0
  72. package/dist/generative-ui/catalog/json-schema.mjs.map +1 -0
  73. package/dist/generative-ui/catalog/refs.cjs +21 -0
  74. package/dist/generative-ui/catalog/refs.cjs.map +1 -0
  75. package/dist/generative-ui/catalog/refs.d.cts +55 -0
  76. package/dist/generative-ui/catalog/refs.d.cts.map +1 -0
  77. package/dist/generative-ui/catalog/refs.d.mts +55 -0
  78. package/dist/generative-ui/catalog/refs.d.mts.map +1 -0
  79. package/dist/generative-ui/catalog/refs.mjs +18 -0
  80. package/dist/generative-ui/catalog/refs.mjs.map +1 -0
  81. package/dist/generative-ui/catalog/schema.cjs +74 -0
  82. package/dist/generative-ui/catalog/schema.cjs.map +1 -0
  83. package/dist/generative-ui/catalog/schema.d.cts +43 -0
  84. package/dist/generative-ui/catalog/schema.d.cts.map +1 -0
  85. package/dist/generative-ui/catalog/schema.d.mts +43 -0
  86. package/dist/generative-ui/catalog/schema.d.mts.map +1 -0
  87. package/dist/generative-ui/catalog/schema.mjs +68 -0
  88. package/dist/generative-ui/catalog/schema.mjs.map +1 -0
  89. package/dist/generative-ui/child-refs.cjs +3 -3
  90. package/dist/generative-ui/child-refs.cjs.map +1 -1
  91. package/dist/generative-ui/child-refs.d.cts.map +1 -1
  92. package/dist/generative-ui/child-refs.d.mts.map +1 -1
  93. package/dist/generative-ui/child-refs.mjs +3 -3
  94. package/dist/generative-ui/child-refs.mjs.map +1 -1
  95. package/dist/generative-ui/clone-value.cjs +364 -0
  96. package/dist/generative-ui/clone-value.cjs.map +1 -0
  97. package/dist/generative-ui/clone-value.d.cts +51 -0
  98. package/dist/generative-ui/clone-value.d.cts.map +1 -0
  99. package/dist/generative-ui/clone-value.d.mts +51 -0
  100. package/dist/generative-ui/clone-value.d.mts.map +1 -0
  101. package/dist/generative-ui/clone-value.mjs +363 -0
  102. package/dist/generative-ui/clone-value.mjs.map +1 -0
  103. package/dist/generative-ui/compact-schema.cjs +187 -0
  104. package/dist/generative-ui/compact-schema.cjs.map +1 -0
  105. package/dist/generative-ui/compact-schema.d.cts +55 -0
  106. package/dist/generative-ui/compact-schema.d.cts.map +1 -0
  107. package/dist/generative-ui/compact-schema.d.mts +55 -0
  108. package/dist/generative-ui/compact-schema.d.mts.map +1 -0
  109. package/dist/generative-ui/compact-schema.mjs +185 -0
  110. package/dist/generative-ui/compact-schema.mjs.map +1 -0
  111. package/dist/generative-ui/index.cjs +286 -0
  112. package/dist/generative-ui/index.d.cts +39 -0
  113. package/dist/generative-ui/index.d.mts +41 -0
  114. package/dist/generative-ui/index.mjs +40 -0
  115. package/dist/generative-ui/is-record.cjs +6 -1
  116. package/dist/generative-ui/is-record.cjs.map +1 -1
  117. package/dist/generative-ui/is-record.d.cts +8 -0
  118. package/dist/generative-ui/is-record.d.cts.map +1 -0
  119. package/dist/generative-ui/is-record.d.mts +8 -0
  120. package/dist/generative-ui/is-record.d.mts.map +1 -0
  121. package/dist/generative-ui/is-record.mjs +6 -2
  122. package/dist/generative-ui/is-record.mjs.map +1 -1
  123. package/dist/generative-ui/prompt-spec.cjs +225 -0
  124. package/dist/generative-ui/prompt-spec.cjs.map +1 -0
  125. package/dist/generative-ui/prompt-spec.d.cts +94 -0
  126. package/dist/generative-ui/prompt-spec.d.cts.map +1 -0
  127. package/dist/generative-ui/prompt-spec.d.mts +94 -0
  128. package/dist/generative-ui/prompt-spec.d.mts.map +1 -0
  129. package/dist/generative-ui/prompt-spec.mjs +220 -0
  130. package/dist/generative-ui/prompt-spec.mjs.map +1 -0
  131. package/dist/generative-ui/prompt.cjs +10 -36
  132. package/dist/generative-ui/prompt.cjs.map +1 -1
  133. package/dist/generative-ui/prompt.d.cts +2 -1
  134. package/dist/generative-ui/prompt.d.cts.map +1 -1
  135. package/dist/generative-ui/prompt.d.mts +2 -1
  136. package/dist/generative-ui/prompt.d.mts.map +1 -1
  137. package/dist/generative-ui/prompt.mjs +12 -38
  138. package/dist/generative-ui/prompt.mjs.map +1 -1
  139. package/dist/generative-ui/render-ui-args.cjs +1 -0
  140. package/dist/generative-ui/render-ui-args.cjs.map +1 -1
  141. package/dist/generative-ui/render-ui-args.d.cts.map +1 -1
  142. package/dist/generative-ui/render-ui-args.d.mts.map +1 -1
  143. package/dist/generative-ui/render-ui-args.mjs +1 -0
  144. package/dist/generative-ui/render-ui-args.mjs.map +1 -1
  145. package/dist/generative-ui/schema-render.cjs +243 -0
  146. package/dist/generative-ui/schema-render.cjs.map +1 -0
  147. package/dist/generative-ui/schema-render.d.cts +44 -0
  148. package/dist/generative-ui/schema-render.d.cts.map +1 -0
  149. package/dist/generative-ui/schema-render.d.mts +44 -0
  150. package/dist/generative-ui/schema-render.d.mts.map +1 -0
  151. package/dist/generative-ui/schema-render.mjs +240 -0
  152. package/dist/generative-ui/schema-render.mjs.map +1 -0
  153. package/dist/generative-ui/standard/chart-config.cjs +347 -0
  154. package/dist/generative-ui/standard/chart-config.cjs.map +1 -0
  155. package/dist/generative-ui/standard/chart-config.d.cts +97 -0
  156. package/dist/generative-ui/standard/chart-config.d.cts.map +1 -0
  157. package/dist/generative-ui/standard/chart-config.d.mts +97 -0
  158. package/dist/generative-ui/standard/chart-config.d.mts.map +1 -0
  159. package/dist/generative-ui/standard/chart-config.mjs +342 -0
  160. package/dist/generative-ui/standard/chart-config.mjs.map +1 -0
  161. package/dist/generative-ui/standard/chart.cjs +56 -0
  162. package/dist/generative-ui/standard/chart.cjs.map +1 -0
  163. package/dist/generative-ui/standard/chart.d.cts +62 -0
  164. package/dist/generative-ui/standard/chart.d.cts.map +1 -0
  165. package/dist/generative-ui/standard/chart.d.mts +62 -0
  166. package/dist/generative-ui/standard/chart.d.mts.map +1 -0
  167. package/dist/generative-ui/standard/chart.mjs +54 -0
  168. package/dist/generative-ui/standard/chart.mjs.map +1 -0
  169. package/dist/generative-ui/standard/checks.cjs +74 -0
  170. package/dist/generative-ui/standard/checks.cjs.map +1 -0
  171. package/dist/generative-ui/standard/checks.d.cts +56 -0
  172. package/dist/generative-ui/standard/checks.d.cts.map +1 -0
  173. package/dist/generative-ui/standard/checks.d.mts +56 -0
  174. package/dist/generative-ui/standard/checks.d.mts.map +1 -0
  175. package/dist/generative-ui/standard/checks.mjs +71 -0
  176. package/dist/generative-ui/standard/checks.mjs.map +1 -0
  177. package/dist/generative-ui/standard/components.cjs +23 -0
  178. package/dist/generative-ui/standard/components.cjs.map +1 -0
  179. package/dist/generative-ui/standard/components.d.cts +24 -0
  180. package/dist/generative-ui/standard/components.d.cts.map +1 -0
  181. package/dist/generative-ui/standard/components.d.mts +24 -0
  182. package/dist/generative-ui/standard/components.d.mts.map +1 -0
  183. package/dist/generative-ui/standard/components.mjs +22 -0
  184. package/dist/generative-ui/standard/components.mjs.map +1 -0
  185. package/dist/generative-ui/standard/composites.cjs +143 -0
  186. package/dist/generative-ui/standard/composites.cjs.map +1 -0
  187. package/dist/generative-ui/standard/composites.d.cts +233 -0
  188. package/dist/generative-ui/standard/composites.d.cts.map +1 -0
  189. package/dist/generative-ui/standard/composites.d.mts +233 -0
  190. package/dist/generative-ui/standard/composites.d.mts.map +1 -0
  191. package/dist/generative-ui/standard/composites.mjs +132 -0
  192. package/dist/generative-ui/standard/composites.mjs.map +1 -0
  193. package/dist/generative-ui/standard/data.cjs +176 -0
  194. package/dist/generative-ui/standard/data.cjs.map +1 -0
  195. package/dist/generative-ui/standard/data.d.cts +365 -0
  196. package/dist/generative-ui/standard/data.d.cts.map +1 -0
  197. package/dist/generative-ui/standard/data.d.mts +365 -0
  198. package/dist/generative-ui/standard/data.d.mts.map +1 -0
  199. package/dist/generative-ui/standard/data.mjs +167 -0
  200. package/dist/generative-ui/standard/data.mjs.map +1 -0
  201. package/dist/generative-ui/standard/declarations.cjs +40 -0
  202. package/dist/generative-ui/standard/declarations.cjs.map +1 -0
  203. package/dist/generative-ui/standard/declarations.d.cts +2570 -0
  204. package/dist/generative-ui/standard/declarations.d.cts.map +1 -0
  205. package/dist/generative-ui/standard/declarations.d.mts +2571 -0
  206. package/dist/generative-ui/standard/declarations.d.mts.map +1 -0
  207. package/dist/generative-ui/standard/declarations.mjs +39 -0
  208. package/dist/generative-ui/standard/declarations.mjs.map +1 -0
  209. package/dist/generative-ui/standard/feedback.cjs +97 -0
  210. package/dist/generative-ui/standard/feedback.cjs.map +1 -0
  211. package/dist/generative-ui/standard/feedback.d.cts +133 -0
  212. package/dist/generative-ui/standard/feedback.d.cts.map +1 -0
  213. package/dist/generative-ui/standard/feedback.d.mts +133 -0
  214. package/dist/generative-ui/standard/feedback.d.mts.map +1 -0
  215. package/dist/generative-ui/standard/feedback.mjs +90 -0
  216. package/dist/generative-ui/standard/feedback.mjs.map +1 -0
  217. package/dist/generative-ui/standard/index.d.mts +20 -0
  218. package/dist/generative-ui/standard/inputs.cjs +333 -0
  219. package/dist/generative-ui/standard/inputs.cjs.map +1 -0
  220. package/dist/generative-ui/standard/inputs.d.cts +1128 -0
  221. package/dist/generative-ui/standard/inputs.d.cts.map +1 -0
  222. package/dist/generative-ui/standard/inputs.d.mts +1128 -0
  223. package/dist/generative-ui/standard/inputs.d.mts.map +1 -0
  224. package/dist/generative-ui/standard/inputs.mjs +318 -0
  225. package/dist/generative-ui/standard/inputs.mjs.map +1 -0
  226. package/dist/generative-ui/standard/layout.cjs +289 -0
  227. package/dist/generative-ui/standard/layout.cjs.map +1 -0
  228. package/dist/generative-ui/standard/layout.d.cts +1974 -0
  229. package/dist/generative-ui/standard/layout.d.cts.map +1 -0
  230. package/dist/generative-ui/standard/layout.d.mts +1975 -0
  231. package/dist/generative-ui/standard/layout.d.mts.map +1 -0
  232. package/dist/generative-ui/standard/layout.mjs +269 -0
  233. package/dist/generative-ui/standard/layout.mjs.map +1 -0
  234. package/dist/generative-ui/standard/map-helpers.cjs +104 -0
  235. package/dist/generative-ui/standard/map-helpers.cjs.map +1 -0
  236. package/dist/generative-ui/standard/map-helpers.d.cts +88 -0
  237. package/dist/generative-ui/standard/map-helpers.d.cts.map +1 -0
  238. package/dist/generative-ui/standard/map-helpers.d.mts +88 -0
  239. package/dist/generative-ui/standard/map-helpers.d.mts.map +1 -0
  240. package/dist/generative-ui/standard/map-helpers.mjs +95 -0
  241. package/dist/generative-ui/standard/map-helpers.mjs.map +1 -0
  242. package/dist/generative-ui/standard/map.cjs +27 -0
  243. package/dist/generative-ui/standard/map.cjs.map +1 -0
  244. package/dist/generative-ui/standard/map.d.cts +31 -0
  245. package/dist/generative-ui/standard/map.d.cts.map +1 -0
  246. package/dist/generative-ui/standard/map.d.mts +31 -0
  247. package/dist/generative-ui/standard/map.d.mts.map +1 -0
  248. package/dist/generative-ui/standard/map.mjs +25 -0
  249. package/dist/generative-ui/standard/map.mjs.map +1 -0
  250. package/dist/generative-ui/standard/media.cjs +215 -0
  251. package/dist/generative-ui/standard/media.cjs.map +1 -0
  252. package/dist/generative-ui/standard/media.d.cts +396 -0
  253. package/dist/generative-ui/standard/media.d.cts.map +1 -0
  254. package/dist/generative-ui/standard/media.d.mts +396 -0
  255. package/dist/generative-ui/standard/media.d.mts.map +1 -0
  256. package/dist/generative-ui/standard/media.mjs +205 -0
  257. package/dist/generative-ui/standard/media.mjs.map +1 -0
  258. package/dist/generative-ui/standard/parameter-order.cjs +231 -0
  259. package/dist/generative-ui/standard/parameter-order.cjs.map +1 -0
  260. package/dist/generative-ui/standard/parameter-order.d.cts +84 -0
  261. package/dist/generative-ui/standard/parameter-order.d.cts.map +1 -0
  262. package/dist/generative-ui/standard/parameter-order.d.mts +84 -0
  263. package/dist/generative-ui/standard/parameter-order.d.mts.map +1 -0
  264. package/dist/generative-ui/standard/parameter-order.mjs +230 -0
  265. package/dist/generative-ui/standard/parameter-order.mjs.map +1 -0
  266. package/dist/generative-ui/standard/style-helpers.cjs +151 -0
  267. package/dist/generative-ui/standard/style-helpers.cjs.map +1 -0
  268. package/dist/generative-ui/standard/style-helpers.d.cts +56 -0
  269. package/dist/generative-ui/standard/style-helpers.d.cts.map +1 -0
  270. package/dist/generative-ui/standard/style-helpers.d.mts +56 -0
  271. package/dist/generative-ui/standard/style-helpers.d.mts.map +1 -0
  272. package/dist/generative-ui/standard/style-helpers.mjs +142 -0
  273. package/dist/generative-ui/standard/style-helpers.mjs.map +1 -0
  274. package/dist/generative-ui/standard/styles.cjs +62 -0
  275. package/dist/generative-ui/standard/styles.cjs.map +1 -0
  276. package/dist/generative-ui/standard/styles.d.cts +17 -0
  277. package/dist/generative-ui/standard/styles.d.cts.map +1 -0
  278. package/dist/generative-ui/standard/styles.d.mts +17 -0
  279. package/dist/generative-ui/standard/styles.d.mts.map +1 -0
  280. package/dist/generative-ui/standard/styles.mjs +60 -0
  281. package/dist/generative-ui/standard/styles.mjs.map +1 -0
  282. package/dist/generative-ui/standard/text.cjs +226 -0
  283. package/dist/generative-ui/standard/text.cjs.map +1 -0
  284. package/dist/generative-ui/standard/text.d.cts +522 -0
  285. package/dist/generative-ui/standard/text.d.cts.map +1 -0
  286. package/dist/generative-ui/standard/text.d.mts +522 -0
  287. package/dist/generative-ui/standard/text.d.mts.map +1 -0
  288. package/dist/generative-ui/standard/text.mjs +209 -0
  289. package/dist/generative-ui/standard/text.mjs.map +1 -0
  290. package/dist/generative-ui/standard/theme.cjs +115 -0
  291. package/dist/generative-ui/standard/theme.cjs.map +1 -0
  292. package/dist/generative-ui/standard/theme.d.cts +60 -0
  293. package/dist/generative-ui/standard/theme.d.cts.map +1 -0
  294. package/dist/generative-ui/standard/theme.d.mts +60 -0
  295. package/dist/generative-ui/standard/theme.d.mts.map +1 -0
  296. package/dist/generative-ui/standard/theme.mjs +112 -0
  297. package/dist/generative-ui/standard/theme.mjs.map +1 -0
  298. package/dist/generative-ui/standard/tokens.cjs +336 -0
  299. package/dist/generative-ui/standard/tokens.cjs.map +1 -0
  300. package/dist/generative-ui/standard/tokens.d.cts +76 -0
  301. package/dist/generative-ui/standard/tokens.d.cts.map +1 -0
  302. package/dist/generative-ui/standard/tokens.d.mts +76 -0
  303. package/dist/generative-ui/standard/tokens.d.mts.map +1 -0
  304. package/dist/generative-ui/standard/tokens.mjs +305 -0
  305. package/dist/generative-ui/standard/tokens.mjs.map +1 -0
  306. package/dist/generative-ui/standard/url.cjs +54 -0
  307. package/dist/generative-ui/standard/url.cjs.map +1 -0
  308. package/dist/generative-ui/standard/url.d.cts +32 -0
  309. package/dist/generative-ui/standard/url.d.cts.map +1 -0
  310. package/dist/generative-ui/standard/url.d.mts +32 -0
  311. package/dist/generative-ui/standard/url.d.mts.map +1 -0
  312. package/dist/generative-ui/standard/url.mjs +50 -0
  313. package/dist/generative-ui/standard/url.mjs.map +1 -0
  314. package/dist/generative-ui/thrown.cjs +69 -0
  315. package/dist/generative-ui/thrown.cjs.map +1 -0
  316. package/dist/generative-ui/thrown.d.cts +21 -0
  317. package/dist/generative-ui/thrown.d.cts.map +1 -0
  318. package/dist/generative-ui/thrown.d.mts +21 -0
  319. package/dist/generative-ui/thrown.d.mts.map +1 -0
  320. package/dist/generative-ui/thrown.mjs +67 -0
  321. package/dist/generative-ui/thrown.mjs.map +1 -0
  322. package/dist/generative-ui/types.cjs +2 -2
  323. package/dist/generative-ui/types.cjs.map +1 -1
  324. package/dist/generative-ui/types.d.cts +20 -7
  325. package/dist/generative-ui/types.d.cts.map +1 -1
  326. package/dist/generative-ui/types.d.mts +20 -7
  327. package/dist/generative-ui/types.d.mts.map +1 -1
  328. package/dist/generative-ui/types.mjs +2 -2
  329. package/dist/generative-ui/types.mjs.map +1 -1
  330. package/dist/generative-ui/validate-operation.cjs +2 -2
  331. package/dist/generative-ui/validate-operation.cjs.map +1 -1
  332. package/dist/generative-ui/validate-operation.mjs +2 -2
  333. package/dist/generative-ui/validate-operation.mjs.map +1 -1
  334. package/dist/index.cjs +18 -15
  335. package/dist/index.cjs.map +1 -1
  336. package/dist/index.d.cts +18 -17
  337. package/dist/index.d.cts.map +1 -1
  338. package/dist/index.d.mts +18 -17
  339. package/dist/index.d.mts.map +1 -1
  340. package/dist/index.mjs +10 -8
  341. package/dist/index.mjs.map +1 -1
  342. package/dist/index.umd.js +1233 -456
  343. package/dist/index.umd.js.map +1 -1
  344. package/dist/package.cjs +1 -1
  345. package/dist/package.mjs +1 -1
  346. package/dist/standard-schema.cjs +20 -7
  347. package/dist/standard-schema.cjs.map +1 -1
  348. package/dist/standard-schema.d.cts +15 -16
  349. package/dist/standard-schema.d.cts.map +1 -1
  350. package/dist/standard-schema.d.mts +15 -16
  351. package/dist/standard-schema.d.mts.map +1 -1
  352. package/dist/standard-schema.mjs +20 -8
  353. package/dist/standard-schema.mjs.map +1 -1
  354. package/dist/telemetry/lambda-client.cjs +1 -1
  355. package/dist/telemetry/lambda-client.cjs.map +1 -1
  356. package/dist/telemetry/lambda-client.d.cts.map +1 -1
  357. package/dist/telemetry/lambda-client.d.mts.map +1 -1
  358. package/dist/telemetry/lambda-client.mjs +1 -1
  359. package/dist/telemetry/lambda-client.mjs.map +1 -1
  360. package/dist/telemetry/telemetry-disabled.cjs +0 -5
  361. package/dist/telemetry/telemetry-disabled.cjs.map +1 -1
  362. package/dist/telemetry/telemetry-disabled.d.cts +0 -5
  363. package/dist/telemetry/telemetry-disabled.d.cts.map +1 -1
  364. package/dist/telemetry/telemetry-disabled.d.mts +0 -5
  365. package/dist/telemetry/telemetry-disabled.d.mts.map +1 -1
  366. package/dist/telemetry/telemetry-disabled.mjs +0 -5
  367. package/dist/telemetry/telemetry-disabled.mjs.map +1 -1
  368. package/dist/types/message.d.cts +1 -18
  369. package/dist/types/message.d.cts.map +1 -1
  370. package/dist/types/message.d.mts +1 -18
  371. package/dist/types/message.d.mts.map +1 -1
  372. package/dist/utils/errors.cjs +5 -42
  373. package/dist/utils/errors.cjs.map +1 -1
  374. package/dist/utils/errors.d.cts +16 -34
  375. package/dist/utils/errors.d.cts.map +1 -1
  376. package/dist/utils/errors.d.mts +16 -34
  377. package/dist/utils/errors.d.mts.map +1 -1
  378. package/dist/utils/errors.mjs +6 -41
  379. package/dist/utils/errors.mjs.map +1 -1
  380. package/dist/utils/index.cjs +0 -2
  381. package/dist/utils/index.cjs.map +1 -1
  382. package/dist/utils/index.d.cts +5 -7
  383. package/dist/utils/index.d.cts.map +1 -1
  384. package/dist/utils/index.d.mts +5 -7
  385. package/dist/utils/index.d.mts.map +1 -1
  386. package/dist/utils/index.mjs +4 -6
  387. package/dist/utils/index.mjs.map +1 -1
  388. package/dist/utils/inspector-visibility.cjs +25 -3
  389. package/dist/utils/inspector-visibility.cjs.map +1 -1
  390. package/dist/utils/inspector-visibility.d.cts +26 -3
  391. package/dist/utils/inspector-visibility.d.cts.map +1 -1
  392. package/dist/utils/inspector-visibility.d.mts +26 -3
  393. package/dist/utils/inspector-visibility.d.mts.map +1 -1
  394. package/dist/utils/inspector-visibility.mjs +25 -4
  395. package/dist/utils/inspector-visibility.mjs.map +1 -1
  396. package/dist/utils/json-schema.cjs +4 -79
  397. package/dist/utils/json-schema.cjs.map +1 -1
  398. package/dist/utils/json-schema.d.cts +1 -4
  399. package/dist/utils/json-schema.d.cts.map +1 -1
  400. package/dist/utils/json-schema.d.mts +1 -4
  401. package/dist/utils/json-schema.d.mts.map +1 -1
  402. package/dist/utils/json-schema.mjs +5 -78
  403. package/dist/utils/json-schema.mjs.map +1 -1
  404. package/dist/utils/random-id.cjs +13 -26
  405. package/dist/utils/random-id.cjs.map +1 -1
  406. package/dist/utils/random-id.d.cts +6 -3
  407. package/dist/utils/random-id.d.cts.map +1 -1
  408. package/dist/utils/random-id.d.mts +6 -3
  409. package/dist/utils/random-id.d.mts.map +1 -1
  410. package/dist/utils/random-id.mjs +14 -25
  411. package/dist/utils/random-id.mjs.map +1 -1
  412. package/dist/utils/types.cjs.map +1 -1
  413. package/dist/utils/types.d.cts +5 -12
  414. package/dist/utils/types.d.cts.map +1 -1
  415. package/dist/utils/types.d.mts +5 -12
  416. package/dist/utils/types.d.mts.map +1 -1
  417. package/dist/utils/types.mjs.map +1 -1
  418. package/package.json +19 -32
  419. package/scripts/verify-cjs-exports.cjs +1 -1
  420. package/src/__tests__/a2ui-envelope.test.ts +38 -13
  421. package/src/__tests__/a2ui-prompts.test.ts +47 -14
  422. package/src/__tests__/fixtures/prompt-goldens.json +354 -0
  423. package/src/__tests__/prompt-spec.test.ts +191 -0
  424. package/src/__tests__/root-entry-browser-safety.test.ts +5 -7
  425. package/src/__tests__/schema-render.test.ts +323 -0
  426. package/src/__tests__/standard-schema.test.ts +61 -101
  427. package/src/a2ui-envelope.ts +9 -7
  428. package/src/a2ui-prompts.ts +47 -96
  429. package/src/attachments/__tests__/utils.test.ts +22 -0
  430. package/src/attachments/types.ts +1 -3
  431. package/src/attachments/utils.ts +23 -5
  432. package/src/finalize-events.ts +16 -0
  433. package/src/generative-ui/__tests__/clone-value-differential.test.ts +480 -0
  434. package/src/generative-ui/__tests__/clone-value.test.ts +226 -0
  435. package/src/generative-ui/__tests__/render-ui-args.test.ts +7 -7
  436. package/src/generative-ui/__tests__/validate-operation.test.ts +19 -13
  437. package/src/generative-ui/base.ts +9 -0
  438. package/src/generative-ui/basic-functions.ts +1 -1
  439. package/src/generative-ui/catalog/catalog-export.ts +478 -0
  440. package/src/generative-ui/catalog/catalog.ts +1167 -0
  441. package/src/generative-ui/catalog/errors.ts +102 -0
  442. package/src/generative-ui/catalog/index.ts +6 -0
  443. package/src/generative-ui/catalog/json-schema.ts +14 -0
  444. package/src/generative-ui/catalog/refs.ts +87 -0
  445. package/src/generative-ui/catalog/schema.ts +107 -0
  446. package/src/generative-ui/child-refs.ts +5 -4
  447. package/src/generative-ui/clone-value.ts +511 -0
  448. package/src/generative-ui/compact-schema.ts +277 -0
  449. package/src/generative-ui/index.ts +14 -0
  450. package/src/generative-ui/is-record.ts +6 -1
  451. package/src/generative-ui/prompt-spec.ts +335 -0
  452. package/src/generative-ui/prompt.ts +25 -75
  453. package/src/generative-ui/render-ui-args.ts +3 -0
  454. package/src/generative-ui/schema-render.ts +378 -0
  455. package/src/generative-ui/standard/__tests__/standard-helpers.test.ts +407 -0
  456. package/src/generative-ui/standard/__tests__/theme.test.ts +61 -0
  457. package/src/generative-ui/standard/__tests__/tokens.test.ts +139 -0
  458. package/src/generative-ui/standard/chart-config.ts +434 -0
  459. package/src/generative-ui/standard/chart.ts +79 -0
  460. package/src/generative-ui/standard/checks.ts +98 -0
  461. package/src/generative-ui/standard/components.ts +35 -0
  462. package/src/generative-ui/standard/composites.ts +158 -0
  463. package/src/generative-ui/standard/data.ts +213 -0
  464. package/src/generative-ui/standard/declarations.ts +57 -0
  465. package/src/generative-ui/standard/feedback.ts +105 -0
  466. package/src/generative-ui/standard/index.ts +55 -0
  467. package/src/generative-ui/standard/inputs.ts +423 -0
  468. package/src/generative-ui/standard/layout.ts +312 -0
  469. package/src/generative-ui/standard/map-helpers.ts +155 -0
  470. package/src/generative-ui/standard/map.ts +32 -0
  471. package/src/generative-ui/standard/media.ts +265 -0
  472. package/src/generative-ui/standard/parameter-order.ts +155 -0
  473. package/src/generative-ui/standard/style-helpers.ts +170 -0
  474. package/src/generative-ui/standard/styles.ts +79 -0
  475. package/src/generative-ui/standard/text.ts +210 -0
  476. package/src/generative-ui/standard/theme.ts +198 -0
  477. package/src/generative-ui/standard/tokens.ts +317 -0
  478. package/src/generative-ui/standard/url.ts +51 -0
  479. package/src/generative-ui/thrown.ts +90 -0
  480. package/src/generative-ui/types.ts +23 -7
  481. package/src/generative-ui/validate-operation.ts +2 -2
  482. package/src/index.ts +9 -17
  483. package/src/standard-schema.ts +24 -27
  484. package/src/telemetry/lambda-client.ts +8 -3
  485. package/src/telemetry/model-host.test.ts +2 -5
  486. package/src/telemetry/telemetry-disabled.ts +0 -5
  487. package/src/types/message.ts +1 -19
  488. package/src/utils/__tests__/errors.test.ts +44 -0
  489. package/src/utils/__tests__/json-schema.test.ts +3 -479
  490. package/src/utils/__tests__/random-id.test.ts +37 -0
  491. package/src/utils/errors.ts +28 -85
  492. package/src/utils/index.ts +0 -2
  493. package/src/utils/inspector-visibility.test.ts +26 -0
  494. package/src/utils/inspector-visibility.ts +35 -3
  495. package/src/utils/json-schema.ts +5 -152
  496. package/src/utils/random-id.ts +17 -37
  497. package/src/utils/types.ts +4 -11
  498. package/tsconfig.json +3 -1
  499. package/tsdown.config.ts +2 -19
  500. package/dist/event-transforms/index.cjs +0 -15
  501. package/dist/event-transforms/index.d.cts +0 -4
  502. package/dist/event-transforms/index.d.mts +0 -4
  503. package/dist/event-transforms/index.mjs +0 -5
  504. package/dist/event-transforms/open-generative-ui-middleware.cjs +0 -286
  505. package/dist/event-transforms/open-generative-ui-middleware.cjs.map +0 -1
  506. package/dist/event-transforms/open-generative-ui-middleware.d.cts +0 -60
  507. package/dist/event-transforms/open-generative-ui-middleware.d.cts.map +0 -1
  508. package/dist/event-transforms/open-generative-ui-middleware.d.mts +0 -60
  509. package/dist/event-transforms/open-generative-ui-middleware.d.mts.map +0 -1
  510. package/dist/event-transforms/open-generative-ui-middleware.mjs +0 -283
  511. package/dist/event-transforms/open-generative-ui-middleware.mjs.map +0 -1
  512. package/dist/event-transforms/recorded-events.cjs +0 -59
  513. package/dist/event-transforms/recorded-events.cjs.map +0 -1
  514. package/dist/event-transforms/recorded-events.d.cts +0 -23
  515. package/dist/event-transforms/recorded-events.d.cts.map +0 -1
  516. package/dist/event-transforms/recorded-events.d.mts +0 -23
  517. package/dist/event-transforms/recorded-events.d.mts.map +0 -1
  518. package/dist/event-transforms/recorded-events.mjs +0 -58
  519. package/dist/event-transforms/recorded-events.mjs.map +0 -1
  520. package/dist/telemetry/events.d.cts +0 -72
  521. package/dist/telemetry/events.d.cts.map +0 -1
  522. package/dist/telemetry/events.d.mts +0 -72
  523. package/dist/telemetry/events.d.mts.map +0 -1
  524. package/dist/telemetry/index.cjs +0 -18
  525. package/dist/telemetry/index.d.cts +0 -5
  526. package/dist/telemetry/index.d.mts +0 -5
  527. package/dist/telemetry/index.mjs +0 -6
  528. package/dist/telemetry/telemetry-client.cjs +0 -165
  529. package/dist/telemetry/telemetry-client.cjs.map +0 -1
  530. package/dist/telemetry/telemetry-client.d.cts +0 -87
  531. package/dist/telemetry/telemetry-client.d.cts.map +0 -1
  532. package/dist/telemetry/telemetry-client.d.mts +0 -87
  533. package/dist/telemetry/telemetry-client.d.mts.map +0 -1
  534. package/dist/telemetry/telemetry-client.mjs +0 -164
  535. package/dist/telemetry/telemetry-client.mjs.map +0 -1
  536. package/dist/telemetry/utils.cjs +0 -14
  537. package/dist/telemetry/utils.cjs.map +0 -1
  538. package/dist/telemetry/utils.mjs +0 -13
  539. package/dist/telemetry/utils.mjs.map +0 -1
  540. package/dist/utils/conditions.cjs +0 -32
  541. package/dist/utils/conditions.cjs.map +0 -1
  542. package/dist/utils/conditions.d.cts +0 -31
  543. package/dist/utils/conditions.d.cts.map +0 -1
  544. package/dist/utils/conditions.d.mts +0 -31
  545. package/dist/utils/conditions.d.mts.map +0 -1
  546. package/dist/utils/conditions.mjs +0 -31
  547. package/dist/utils/conditions.mjs.map +0 -1
  548. package/dist/utils/console-styling.cjs +0 -91
  549. package/dist/utils/console-styling.cjs.map +0 -1
  550. package/dist/utils/console-styling.d.cts +0 -65
  551. package/dist/utils/console-styling.d.cts.map +0 -1
  552. package/dist/utils/console-styling.d.mts +0 -65
  553. package/dist/utils/console-styling.d.mts.map +0 -1
  554. package/dist/utils/console-styling.mjs +0 -85
  555. package/dist/utils/console-styling.mjs.map +0 -1
  556. package/src/__tests__/zod-regression.test.ts +0 -319
  557. package/src/event-transforms/index.ts +0 -5
  558. package/src/event-transforms/open-generative-ui-middleware.ts +0 -392
  559. package/src/event-transforms/recorded-events.test.ts +0 -166
  560. package/src/event-transforms/recorded-events.ts +0 -74
  561. package/src/telemetry/events.ts +0 -68
  562. package/src/telemetry/index.ts +0 -9
  563. package/src/telemetry/telemetry-blank-license-identity.test.ts +0 -128
  564. package/src/telemetry/telemetry-client.test.ts +0 -798
  565. package/src/telemetry/telemetry-client.ts +0 -328
  566. package/src/telemetry/utils.ts +0 -15
  567. package/src/utils/__tests__/conditions.test.ts +0 -161
  568. package/src/utils/conditions.ts +0 -116
  569. package/src/utils/console-styling.ts +0 -126
@@ -1,12 +1,13 @@
1
- import {
2
- GENERATIVE_UI_WHEN_TO_SHOW,
3
- generativeUIGuideFeatures,
4
- } from "../a2ui-prompts";
1
+ import { generativeUIGuideFeatures } from "../a2ui-prompts";
5
2
  import { functionCallers } from "./basic-functions";
6
3
  import {
7
- GENERATIVE_UI_AGENT_FUNCTION_CALLS,
8
- GENERATIVE_UI_RENDER_TOOL,
9
- } from "./types";
4
+ defaultGenerativeUIPromptSpec,
5
+ generativeUIPromptFeatures,
6
+ selectPromptItems,
7
+ } from "./prompt-spec";
8
+ import type { GenerativeUIPromptSpec } from "./prompt-spec";
9
+ import { renderGenerativeUIComponentList } from "./schema-render";
10
+ import { GENERATIVE_UI_AGENT_FUNCTION_CALLS } from "./types";
10
11
  import type { GenerativeUIManifest } from "./types";
11
12
 
12
13
  export const GENERATIVE_UI_CONTEXT_DESCRIPTION =
@@ -27,7 +28,10 @@ function shorten(text: string) {
27
28
  * the `render_ui` rules, the targets, components, functions, and surfaces of
28
29
  * the manifest. It is in shared so that the inspector shows the same text.
29
30
  */
30
- export function buildGenerativeUIPrompt(manifest: GenerativeUIManifest) {
31
+ export function buildGenerativeUIPrompt(
32
+ manifest: GenerativeUIManifest,
33
+ spec: GenerativeUIPromptSpec = defaultGenerativeUIPromptSpec(),
34
+ ) {
31
35
  const targets = manifest.targets
32
36
  .map((t) => {
33
37
  const place =
@@ -41,18 +45,10 @@ export function buildGenerativeUIPrompt(manifest: GenerativeUIManifest) {
41
45
  return `- "${t.id}" (${place}${limit})${description}`;
42
46
  })
43
47
  .join("\n");
44
- const components = Object.entries(manifest.components)
45
- .map(([name, c]) => {
46
- const lines = [
47
- `- **${name}**${c.description ? `: ${c.description}` : ""}`,
48
- ` props: ${JSON.stringify(c.props)}`,
49
- ];
50
- if (c.events) lines.push(` event props: ${JSON.stringify(c.events)}`);
51
- if (c.slots)
52
- lines.push(` slot props (component ids): ${JSON.stringify(c.slots)}`);
53
- return lines.join("\n");
54
- })
55
- .join("\n");
48
+ const components = renderGenerativeUIComponentList(
49
+ manifest.components,
50
+ spec.schema.tool,
51
+ );
56
52
  const functions = Object.entries(manifest.functions)
57
53
  .map(([name, f]) => {
58
54
  // A built-in function carries its short signature in the description
@@ -103,65 +99,19 @@ export function buildGenerativeUIPrompt(manifest: GenerativeUIManifest) {
103
99
 
104
100
  // Rules for functions, events, and templates go only to runs whose manifest
105
101
  // has them, so the guide stays small.
106
- const {
107
- functions: hasFunctions,
108
- events,
109
- templates,
110
- checks,
111
- } = generativeUIGuideFeatures(manifest);
112
- // The agent calls functions only while that path is on.
113
- const agentCalls = hasFunctions && GENERATIVE_UI_AGENT_FUNCTION_CALLS;
114
- const operations = [
115
- '{"version":"v1.0","createSurface":{"surfaceId":"<new id>","dataModel":{...},"components":[{"id":"root","component":"<Name>","children":["<child id>"]}]}}: the first operation of a new surface. "dataModel" and "components" are optional.',
116
- '{"version":"v1.0","updateComponents":{"surfaceId":"<id>","components":[<component>, ...]}}: add or replace components by id.',
117
- '{"version":"v1.0","updateDataModel":{"surfaceId":"<id>","path":"/some/path","value":<json>}}: set the value at "path". Always give "value". "value":null deletes the key at "path".',
118
- '{"version":"v1.0","deleteSurface":{"surfaceId":"<id>"}}: remove the surface.',
119
- ...(agentCalls
120
- ? [
121
- '{"version":"v1.0","callRendererFunction":{"functionCallId":"<unique id>","callFunction":{"@call":"<function>","args":{...}}}}: run an app function now, with no click. It needs no surface.',
122
- ]
123
- : []),
124
- ];
125
- const eventRule = hasFunctions
126
- ? 'Event props take an action. {"functionCall":{"@call":"<function>","args":{...}}} runs an app function in the browser immediately, and you are not told about it. {"event":{"name":"<name>","userMessage":"<text>","context":{...}}} sends the interaction back to you as a user message, with "userMessage" as its first line. "userMessage" is plain text: ${...} is not interpolated in it; put values in "context". Only call functions listed below.'
127
- : 'Event props take an action: {"event":{"name":"<name>","userMessage":"<text>","context":{...}}} sends the interaction back to you as a user message, with "userMessage" as its first line. "userMessage" is plain text: ${...} is not interpolated in it; put values in "context".';
128
- const rules = [
129
- 'Components are flat objects: {"id":"...","component":"<Name>", ...props}. Every surface renders from the component with id "root". Reference children by id in slot props.',
130
- 'A component may take "accessibility":{"label":"<1 to 3 words>","description":"<what it does>"} for screen readers: on the component it describes, when nothing visible names it. Not on every component, and "live":"polite" only on text that changes by itself.',
131
- 'Stream progressively: put the initial data in "dataModel" and the root in "components" of the createSurface operation, then send one updateComponents operation per child, so the UI appears while you are still writing. The root must already list the ids of its children in its slot props (for example "children":["card-1","card-2"]), even though the children come later. A component that no slot references is never shown.',
132
- "Updating a component replaces all of its props, so resend every prop.",
133
- 'Prop values are literals or data bindings {"@path":"/data/path"}. Never write {"path":"/data/path"} as a binding.',
134
- ...(events ? [eventRule] : []),
135
- "To show a different view, create a new surface with a new surfaceId (for example, a checkout form after a cart summary). Update an existing surface only when the user asks to change that same view: then do not send createSurface, use its surfaceId, and pass its existing target. Never reuse an earlier chat surface for a different view, because that replaces the earlier UI and anything the user typed into it.",
136
- "Never use a surfaceId again, also after deleteSurface.",
137
- 'A prop can also be a function value that updates with the data: {"@call":"formatCurrency","args":{"value":{"@path":"/total"},"currency":"EUR"}}. Only call functions listed below. formatString interpolates ${/path} and ${fn(arg: value)} in its value.',
138
- '${...} is evaluated only in the value of formatString and in the item of series; in other strings it stays literal text. Inside formatString, ${...} does not support operators. For arithmetic use calc, with the values as named args: {"@call":"calc","args":{"expression":"seats * 29 * (annual ? 0.8 : 1)","seats":{"@path":"/seats"},"annual":{"@path":"/annual"}}}.',
139
- "For a computed list (chart data, template items) use series. Its description under Functions gives the rules and an example.",
140
- ...(checks
141
- ? [
142
- 'Validate an input with "checks": [{"condition":{"@call":"email","args":{"value":{"@path":"/form/email"}}},"message":"Enter a valid email"}]. The check functions are required, regex, length, numeric and email. A failed check shows the message under the input and disables a Button that has the same checks.',
143
- ]
144
- : []),
145
- ...(templates
146
- ? [
147
- 'To repeat a component for each item of a list, give a multiple slot a template: "children":{"componentId":"row","path":"/items"}. Inside the template, paths are relative to the item ("name", not "/name"). {"@call":"@index"} gives the position of the item, from 0; {"@call":"@index","args":{"offset":1}} counts from 1.',
148
- ]
149
- : []),
150
- ...(agentCalls
151
- ? [
152
- "Give every callRendererFunction a new functionCallId. Call only a function marked (UI or agent) or (agent only); a function with no mark is for the UI only. A function marked (agent only) is only for callRendererFunction: do not bind an event to it.",
153
- 'The result of a callRendererFunction comes back to you in a new turn, as a developer message: {"version":"v1.0","rendererFunctionResponse":{"functionCallId":"<id>","value":...}}. If the call failed, it has "error" in place of "value". Do not wait for the result in this reply, and do not guess it.',
154
- ]
155
- : []),
156
- ];
102
+ const features = generativeUIPromptFeatures(
103
+ generativeUIGuideFeatures(manifest),
104
+ );
105
+ const { intro, whenToShow } = spec.tool;
106
+ const operations = selectPromptItems(spec.tool.operations ?? [], features);
107
+ const rules = selectPromptItems(spec.tool.rules, features);
108
+ const when = whenToShow ? `${whenToShow}\n\n` : "";
157
109
 
158
110
  return [
159
111
  `## Generative UI
160
- Call \`${GENERATIVE_UI_RENDER_TOOL}\` to show UI. Arguments: \`target\` first, then \`operations\` (A2UI v1.0 operations, applied in order).
161
-
162
- ${GENERATIVE_UI_WHEN_TO_SHOW}
112
+ ${intro}
163
113
 
164
- Every operation has "version":"v1.0" and exactly one of:
114
+ ${when}Every operation has "version":"1.0" and exactly one of:
165
115
  ${operations.map((op) => `- ${op}`).join("\n")}
166
116
 
167
117
  Rules:
@@ -140,6 +140,9 @@ class RenderUIArgsScanner {
140
140
  expectingValue = false;
141
141
  }
142
142
  break;
143
+ case undefined:
144
+ // Unreachable: `i < text.length`, so `text[i]` is always a char.
145
+ break;
143
146
  }
144
147
  }
145
148
  this.inString = inString;
@@ -0,0 +1,378 @@
1
+ import { functionCallers } from "./basic-functions";
2
+ import { cloneValue } from "./clone-value";
3
+ import {
4
+ buildCompactGenerativeUISchema,
5
+ compactProps,
6
+ compactType,
7
+ } from "./compact-schema";
8
+ import type { GenerativeUISchemaSettings } from "./prompt-spec";
9
+ import { GENERATIVE_UI_AGENT_FUNCTION_CALLS } from "./types";
10
+ import type {
11
+ GenerativeUIComponentManifest,
12
+ GenerativeUIJSONSchema,
13
+ GenerativeUIManifest,
14
+ } from "./types";
15
+
16
+ type SchemaManifest = Pick<
17
+ GenerativeUIManifest,
18
+ "catalogId" | "components" | "functions" | "targets" | "surfaces"
19
+ >;
20
+
21
+ /** An own key (shared compiles to ES2017, which has no Object.hasOwn). */
22
+ const hasOwn = (target: object, key: string) =>
23
+ Object.prototype.hasOwnProperty.call(target, key);
24
+
25
+ function isRecord(value: unknown): value is Record<string, unknown> {
26
+ return typeof value === "object" && value !== null && !Array.isArray(value);
27
+ }
28
+
29
+ /** The props schema without the description of each prop. */
30
+ function withoutPropDescriptions(
31
+ schema: GenerativeUIJSONSchema,
32
+ ): GenerativeUIJSONSchema {
33
+ if (!isRecord(schema.properties)) return schema;
34
+ return {
35
+ ...schema,
36
+ properties: Object.fromEntries(
37
+ Object.entries(schema.properties).map(([key, value]) => {
38
+ if (!isRecord(value)) return [key, value];
39
+ const { description: _description, ...rest } = value;
40
+ return [key, rest];
41
+ }),
42
+ ),
43
+ };
44
+ }
45
+
46
+ /** The short signature of a function: its built-in signature, or its schema made short. */
47
+ function functionSignature(fn: GenerativeUIManifest["functions"][string]) {
48
+ const signature = fn.parameters.description;
49
+ const hasSignature =
50
+ typeof signature === "string" &&
51
+ signature.startsWith("{") &&
52
+ Object.keys(fn.parameters).length === 2;
53
+ return hasSignature ? signature : compactType(fn.parameters, 0);
54
+ }
55
+
56
+ /**
57
+ * A function name with its parameters: `pick{ id: string }`, `clearCart{}`
58
+ * for no arguments, `setVolume(number)` for a parameter that is not an object.
59
+ */
60
+ function nameWithParameters(name: string, parameters: string) {
61
+ if (parameters.startsWith("{")) return `${name}${parameters}`;
62
+ if (parameters === "object") return `${name}{}`;
63
+ return `${name}(${parameters})`;
64
+ }
65
+
66
+ /**
67
+ * One component as a TypeScript-like signature line, with its events and
68
+ * slots on the lines below:
69
+ * `- Text(text?: string // The text): Shows text`.
70
+ */
71
+ function signatureLines(
72
+ name: string,
73
+ component: GenerativeUIComponentManifest,
74
+ settings: GenerativeUISchemaSettings,
75
+ ) {
76
+ const props = Object.entries(
77
+ compactProps(component.props, settings.propDescriptions),
78
+ ).map(([key, type]) => `${key}: ${type}`);
79
+ const lines = [
80
+ `- ${name}(${props.join(", ")})${component.description ? `: ${oneLine(component.description)}` : ""}`,
81
+ ];
82
+ const events = Object.entries(component.events ?? {}).map(
83
+ ([event, definition]) =>
84
+ `${event}(${definition.description ? oneLine(definition.description) : compactType(definition.parameters, 0)})`,
85
+ );
86
+ if (events.length > 0) lines.push(` events: ${events.join(", ")}`);
87
+ const slots = Object.entries(component.slots ?? {}).map(
88
+ ([slot, kind]) => `${slot} (${kind})`,
89
+ );
90
+ if (slots.length > 0) lines.push(` slots: ${slots.join(", ")}`);
91
+ return lines;
92
+ }
93
+
94
+ /** The whole schema as signature text: targets, functions, components, surfaces. */
95
+ function signatureSchema(
96
+ manifest: SchemaManifest,
97
+ settings: GenerativeUISchemaSettings,
98
+ ) {
99
+ const targets = manifest.targets.map((t) => {
100
+ const limit = t.components ? `; only ${t.components.join(", ")}` : "";
101
+ return `- ${t.id} (${t.kind}${limit})${t.description ? `: ${oneLine(t.description)}` : ""}`;
102
+ });
103
+ const functions = Object.entries(manifest.functions).map(([name, fn]) => {
104
+ const callers = functionCallers(fn);
105
+ const who =
106
+ callers.agent && GENERATIVE_UI_AGENT_FUNCTION_CALLS
107
+ ? callers.renderer
108
+ ? " (UI or agent)"
109
+ : " (agent only)"
110
+ : "";
111
+ return `- ${nameWithParameters(name, functionSignature(fn))}${who}${fn.description ? `: ${oneLine(fn.description)}` : ""}`;
112
+ });
113
+ const components = Object.entries(manifest.components).flatMap(
114
+ ([name, component]) => signatureLines(name, component, settings),
115
+ );
116
+ const surfaces = Object.entries(manifest.surfaces).map(
117
+ ([id, s]) =>
118
+ `- ${id} (target ${s.target})${s.status ? ` status: ${s.status}` : ""}${s.dataModel ? ` user values: ${JSON.stringify(s.dataModel)}` : ""}${(s.rejected ?? []).map((r) => ` rejected: ${r}`).join("")}`,
119
+ );
120
+ return [
121
+ `Catalog: ${manifest.catalogId}`,
122
+ `Targets:\n${targets.join("\n") || "- none"}`,
123
+ `Functions:\n${functions.join("\n") || "- none"}`,
124
+ `Components:\n${components.join("\n") || "- none"}`,
125
+ `Surfaces:\n${surfaces.join("\n") || "- none"}`,
126
+ ].join("\n\n");
127
+ }
128
+
129
+ /** A description on one line, so its lines cannot read as new entries. */
130
+ function oneLine(text: string) {
131
+ return text.replace(/\s*\n\s*/g, " ");
132
+ }
133
+
134
+ /** Values that would read as a type or a number once their quotes are gone. */
135
+ const AMBIGUOUS_VALUE =
136
+ /^(?:string|number|integer|boolean|true|false|null|object|array|unknown|any|-?\d[\d.]*)$/;
137
+
138
+ /**
139
+ * A compact type with bare enum values and tight unions:
140
+ * `"sm" | "md" | "lg"` becomes `sm|md|lg`. A union keeps its quotes when it
141
+ * also holds a type (`"sm" | number`) or a value that reads as a type or a
142
+ * number (`"number" | "currency"`, `"1" | "2"`), and so do values that are
143
+ * not plain words.
144
+ */
145
+ function bareType(type: string) {
146
+ return type
147
+ .replace(
148
+ /"[A-Za-z0-9_#%.-]+"(?: \| "[A-Za-z0-9_#%.-]+")*(?! \|)/g,
149
+ (union: string, offset: number, whole: string) => {
150
+ if (whole.slice(offset - 2, offset) === "| ") return union;
151
+ const values = union.split(" | ").map((v) => v.slice(1, -1));
152
+ if (values.some((v) => AMBIGUOUS_VALUE.test(v))) return union;
153
+ return values.join("|");
154
+ },
155
+ )
156
+ .replace(/ \| /g, "|");
157
+ }
158
+
159
+ /** A compact prop (`type // description`) as `name: type - description`. */
160
+ function propLine(key: string, value: string) {
161
+ const name = key.endsWith("?") ? key.slice(0, -1) : `${key}*`;
162
+ const cut = value.indexOf(" // ");
163
+ const type = bareType(cut < 0 ? value : value.slice(0, cut));
164
+ const text = cut < 0 ? "" : value.slice(cut + 4).trim();
165
+ const description = text ? ` - ${oneLine(text)}` : "";
166
+ return ` ${name}: ${type}${description}`;
167
+ }
168
+
169
+ /**
170
+ * The whole schema as plain lines: a header line per component and one
171
+ * indented line per prop: events are `action` props and slots `componentId`
172
+ * or `childList` props. Props are optional unless marked `*`, enum values
173
+ * are bare, and the common props are listed once. It carries the same names, types and descriptions as
174
+ * `compact`, in fewer tokens.
175
+ */
176
+ function linesSchema(
177
+ manifest: SchemaManifest,
178
+ settings: GenerativeUISchemaSettings,
179
+ ) {
180
+ const compact = buildCompactGenerativeUISchema(manifest, {
181
+ propDescriptions: settings.propDescriptions,
182
+ commonProps: settings.commonProps,
183
+ });
184
+ const targets = compact.targets
185
+ .map((t) => {
186
+ const limit = t.components ? `, only ${t.components.join(", ")}` : "";
187
+ return `${t.id} (${t.kind}${limit})${t.description ? `: ${oneLine(t.description)}` : ""}`;
188
+ })
189
+ .join("; ");
190
+ const functions = Object.entries(compact.functions).map(
191
+ ([name, fn]) =>
192
+ `${nameWithParameters(name, fn.parameters)}${"callers" in fn ? ` (${fn.callers})` : ""}${fn.description ? `: ${oneLine(fn.description)}` : ""}`,
193
+ );
194
+ const common = compact.commonProps
195
+ ? Object.entries(compact.commonProps).map(([k, v]) => propLine(k, v))
196
+ : [];
197
+ const lineSets = Object.entries(compact.components).map(([name, c]) => ({
198
+ name,
199
+ c,
200
+ own: [
201
+ ...Object.entries(c.props).map(([k, v]) => propLine(k, v)),
202
+ ...Object.entries(c.events ?? {}).map(
203
+ ([e, d]) => ` ${e}: action - ${oneLine(d)}`,
204
+ ),
205
+ ],
206
+ }));
207
+ const components = lineSets.flatMap(({ name, c, own }) => {
208
+ const lines = [
209
+ `${name}${c.includesCommonProps ? " +common" : ""}${c.description ? `: ${oneLine(c.description)}` : ""}`,
210
+ ...own,
211
+ ];
212
+ // Slots are props that take component ids.
213
+ for (const [slot, kind] of Object.entries(c.slots ?? {})) {
214
+ lines.push(
215
+ ` ${slot}: ${kind === "single" ? "componentId" : "childList"}`,
216
+ );
217
+ }
218
+ return lines;
219
+ });
220
+ const surfaces = Object.keys(compact.surfaces).length
221
+ ? JSON.stringify(compact.surfaces)
222
+ : "none";
223
+ return [
224
+ `Catalog ${compact.catalogId}. Targets: ${targets || "none"}`,
225
+ 'Props are optional unless marked *. a|b|c is one of those strings, quoted when one reads as a type or a number. A component marked +common also takes every common prop. A prop of type action is an event prop: give it {"event":{...}} or {"functionCall":{...}}. A componentId prop takes one component id; a childList prop takes a list of ids or a template.',
226
+ `Functions:\n${functions.join("\n")}`,
227
+ ...(common.length ? [`Common props:\n${common.join("\n")}`] : []),
228
+ `Components:\n${components.join("\n")}`,
229
+ `Surfaces: ${surfaces}`,
230
+ ].join("\n\n");
231
+ }
232
+
233
+ /**
234
+ * The component schema of the markdown transport, as the text of its
235
+ * context entry, in the notation of `settings`. `compact` is the schema that
236
+ * ships (`buildCompactGenerativeUISchema`), `json-schema` the manifest parts
237
+ * as JSON, `ts-signature` one line per component, `lines` one line per
238
+ * prop with bare enums (the fewest tokens).
239
+ *
240
+ * @example
241
+ * ```ts
242
+ * const value = renderGenerativeUISchema(manifest, spec.schema.markdown);
243
+ * ```
244
+ */
245
+ export function renderGenerativeUISchema(
246
+ manifest: SchemaManifest,
247
+ settings: GenerativeUISchemaSettings,
248
+ ): string {
249
+ switch (settings.notation) {
250
+ case "compact":
251
+ return JSON.stringify(
252
+ buildCompactGenerativeUISchema(manifest, {
253
+ propDescriptions: settings.propDescriptions,
254
+ commonProps: settings.commonProps,
255
+ }),
256
+ );
257
+ case "json-schema": {
258
+ const components = Object.fromEntries(
259
+ Object.entries(manifest.components).map(([name, c]) => [
260
+ name,
261
+ settings.propDescriptions
262
+ ? c
263
+ : { ...c, props: withoutPropDescriptions(c.props) },
264
+ ]),
265
+ );
266
+ return JSON.stringify({
267
+ catalogId: manifest.catalogId,
268
+ targets: manifest.targets,
269
+ functions: manifest.functions,
270
+ components,
271
+ surfaces: manifest.surfaces,
272
+ });
273
+ }
274
+ case "ts-signature":
275
+ return signatureSchema(manifest, settings);
276
+ case "lines":
277
+ return linesSchema(manifest, settings);
278
+ }
279
+ }
280
+
281
+ /**
282
+ * The component list of the tool guide, one entry per component, in the
283
+ * notation of `settings`. `json-schema` is the list that ships.
284
+ */
285
+ export function renderGenerativeUIComponentList(
286
+ components: GenerativeUIManifest["components"],
287
+ settings: GenerativeUISchemaSettings,
288
+ ): string {
289
+ return Object.entries(components)
290
+ .map(([name, c]) => {
291
+ if (
292
+ settings.notation === "ts-signature" ||
293
+ settings.notation === "lines"
294
+ ) {
295
+ return signatureLines(name, c, settings).join("\n");
296
+ }
297
+ const props =
298
+ settings.notation === "compact"
299
+ ? compactProps(c.props, settings.propDescriptions)
300
+ : settings.propDescriptions
301
+ ? c.props
302
+ : withoutPropDescriptions(c.props);
303
+ const lines = [
304
+ `- **${name}**${c.description ? `: ${oneLine(c.description)}` : ""}`,
305
+ ` props: ${JSON.stringify(props)}`,
306
+ ];
307
+ if (c.events) lines.push(` event props: ${JSON.stringify(c.events)}`);
308
+ if (c.slots)
309
+ lines.push(` slot props (component ids): ${JSON.stringify(c.slots)}`);
310
+ return lines.join("\n");
311
+ })
312
+ .join("\n");
313
+ }
314
+
315
+ /**
316
+ * The manifest with replaced descriptions: `"Name"` replaces the
317
+ * description of a component, `"Name.prop"` the description of one of its
318
+ * props. Keys that name no component or prop are left out of the result
319
+ * and listed in `unknown`. The manifest is not changed.
320
+ */
321
+ export function applyDescriptionOverrides<
322
+ M extends Pick<GenerativeUIManifest, "components">,
323
+ >(
324
+ manifest: M,
325
+ overrides: Record<string, string>,
326
+ ): { manifest: M; unknown: string[] } {
327
+ const components = cloneValue(manifest.components);
328
+ const unknown: string[] = [];
329
+ for (const [key, description] of Object.entries(overrides)) {
330
+ const [name, prop, ...rest] = key.split(".");
331
+ // Own keys only: "__proto__" must never reach Object.prototype.
332
+ const component =
333
+ name !== undefined && hasOwn(components, name)
334
+ ? components[name]
335
+ : undefined;
336
+ if (!component || rest.length > 0) {
337
+ unknown.push(key);
338
+ continue;
339
+ }
340
+ if (prop === undefined) {
341
+ component.description = description;
342
+ continue;
343
+ }
344
+ const properties = component.props.properties;
345
+ const property =
346
+ isRecord(properties) && hasOwn(properties, prop)
347
+ ? properties[prop]
348
+ : undefined;
349
+ if (!isRecord(property)) {
350
+ unknown.push(key);
351
+ continue;
352
+ }
353
+ property.description = description;
354
+ }
355
+ return { manifest: { ...manifest, components }, unknown };
356
+ }
357
+
358
+ /**
359
+ * The components and props of `manifest` whose names do not appear in
360
+ * `rendered`. A schema notation that leaves one out would hide part of the
361
+ * catalog from the model.
362
+ */
363
+ export function schemaCoverage(
364
+ manifest: Pick<GenerativeUIManifest, "components">,
365
+ rendered: string,
366
+ ): { missing: string[] } {
367
+ const missing: string[] = [];
368
+ for (const [name, component] of Object.entries(manifest.components)) {
369
+ if (!rendered.includes(name)) missing.push(name);
370
+ const properties = isRecord(component.props.properties)
371
+ ? component.props.properties
372
+ : {};
373
+ for (const prop of Object.keys(properties)) {
374
+ if (!rendered.includes(prop)) missing.push(`${name}.${prop}`);
375
+ }
376
+ }
377
+ return { missing };
378
+ }