@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,145 @@
1
+ import { describe, it, expect } from "vitest";
2
+ import {
3
+ classifyModelHost,
4
+ MODEL_HOST_CLASSES,
5
+ type ModelHostClass,
6
+ } from "./model-host";
7
+
8
+ describe("classifyModelHost", () => {
9
+ describe("the case this exists for: an OpenAI-shaped client aimed elsewhere", () => {
10
+ // Every row below reports `provider: "openai.responses"` from the AI SDK,
11
+ // so the provider label cannot tell them apart. The host can.
12
+ it.each([
13
+ ["https://api.openai.com/v1", "openai"],
14
+ ["https://myresource.openai.azure.com/openai/v1", "azure"],
15
+ ["https://myresource.services.ai.azure.com/models", "azure"],
16
+ ["https://myresource.cognitiveservices.azure.com/", "azure"],
17
+ ["https://openrouter.ai/api/v1", "openrouter"],
18
+ ["http://localhost:11434/v1", "local"],
19
+ ["https://llm.internal.acme.example/v1", "other"],
20
+ ])("classifies %s as %s", (baseUrl, expected) => {
21
+ expect(classifyModelHost(baseUrl, "openai")).toBe(expected);
22
+ });
23
+ });
24
+
25
+ describe("absent base URL falls back to the provider default", () => {
26
+ it("returns the provider default when the base URL is undefined", () => {
27
+ expect(classifyModelHost(undefined, "openai")).toBe("openai");
28
+ expect(classifyModelHost(undefined, "anthropic")).toBe("anthropic");
29
+ });
30
+
31
+ it("returns the provider default for null and empty string", () => {
32
+ expect(classifyModelHost(null, "vertex")).toBe("vertex");
33
+ expect(classifyModelHost("", "vertex")).toBe("vertex");
34
+ expect(classifyModelHost(" ", "vertex")).toBe("vertex");
35
+ });
36
+
37
+ it("defaults to unknown when the caller supplies no provider default", () => {
38
+ // This is the pre-built LanguageModel case: nobody knows the host.
39
+ expect(classifyModelHost(undefined)).toBe("unknown");
40
+ });
41
+ });
42
+
43
+ describe("known vendor hosts", () => {
44
+ it.each([
45
+ ["https://api.anthropic.com", "anthropic"],
46
+ ["https://generativelanguage.googleapis.com/v1beta", "google"],
47
+ ["https://us-central1-aiplatform.googleapis.com/v1", "vertex"],
48
+ ["https://bedrock-runtime.us-east-1.amazonaws.com", "bedrock"],
49
+ ["https://api.groq.com/openai/v1", "groq"],
50
+ ["https://api.unify.ai/v0/", "unify"],
51
+ ["https://api.minimax.io/v1", "minimax"],
52
+ ])("classifies %s as %s", (baseUrl, expected) => {
53
+ expect(classifyModelHost(baseUrl)).toBe(expected);
54
+ });
55
+ });
56
+
57
+ describe("local and private endpoints", () => {
58
+ it.each([
59
+ "http://localhost:1234/v1",
60
+ "http://127.0.0.1:8000/v1",
61
+ "http://[::1]:11434/v1",
62
+ "http://0.0.0.0:11434/v1",
63
+ "http://10.1.2.3:8000/v1",
64
+ "http://192.168.1.50:8000/v1",
65
+ "http://172.16.0.9:8000/v1",
66
+ "http://172.31.255.254:8000/v1",
67
+ "http://host.docker.internal:11434/v1",
68
+ "http://ollama.local:11434/v1",
69
+ ])("treats %s as local", (baseUrl) => {
70
+ expect(classifyModelHost(baseUrl, "openai")).toBe("local");
71
+ });
72
+
73
+ it("does not mistake a public 172.x address for a private one", () => {
74
+ // 172.32.x is outside the 172.16.0.0/12 private block.
75
+ expect(classifyModelHost("http://172.32.0.1:8000/v1", "openai")).toBe(
76
+ "other",
77
+ );
78
+ });
79
+ });
80
+
81
+ describe("it never leaks the host", () => {
82
+ it.each([
83
+ "https://myresource.openai.azure.com/openai/v1",
84
+ "https://acme-secret-gateway.internal.example/v1",
85
+ "not a url at all",
86
+ "://malformed",
87
+ "ftp://weird.example/v1",
88
+ ])("returns a closed-vocabulary value for %s", (baseUrl) => {
89
+ const result = classifyModelHost(baseUrl, "openai");
90
+ expect(MODEL_HOST_CLASSES).toContain(result);
91
+ // The customer's resource name must never reach telemetry.
92
+ expect(result).not.toContain("myresource");
93
+ expect(result).not.toContain("acme");
94
+ });
95
+
96
+ it("classifies an unparseable base URL as other, not unknown", () => {
97
+ // `unknown` means "we could not observe a host". A malformed string
98
+ // means we did observe one and failed to read it. Those differ.
99
+ expect(classifyModelHost("not a url at all", "openai")).toBe("other");
100
+ });
101
+ });
102
+
103
+ describe("normalization", () => {
104
+ it("ignores case and trailing whitespace", () => {
105
+ expect(
106
+ classifyModelHost(" HTTPS://MyResource.OpenAI.Azure.COM/openai/v1 "),
107
+ ).toBe("azure");
108
+ });
109
+
110
+ it("ignores port, path and query", () => {
111
+ expect(
112
+ classifyModelHost("https://api.openai.com:443/v1/chat?x=1#frag"),
113
+ ).toBe("openai");
114
+ });
115
+
116
+ it("does not match a lookalike suffix", () => {
117
+ // `evil-openai.azure.com.attacker.example` must not read as azure.
118
+ expect(
119
+ classifyModelHost("https://myresource.openai.azure.com.attacker.test/"),
120
+ ).toBe("other");
121
+ // A bare substring is not a suffix match either.
122
+ expect(classifyModelHost("https://notapi.openai.com.example/")).toBe(
123
+ "other",
124
+ );
125
+ });
126
+ });
127
+
128
+ describe("the vocabulary is closed", () => {
129
+ it("exposes unknown and other as members", () => {
130
+ expect(MODEL_HOST_CLASSES).toContain("unknown");
131
+ expect(MODEL_HOST_CLASSES).toContain("other");
132
+ });
133
+
134
+ it("has no duplicate members", () => {
135
+ expect(new Set(MODEL_HOST_CLASSES).size).toBe(MODEL_HOST_CLASSES.length);
136
+ });
137
+
138
+ it("accepts every member as a provider default", () => {
139
+ for (const member of MODEL_HOST_CLASSES) {
140
+ const value: ModelHostClass = classifyModelHost(undefined, member);
141
+ expect(value).toBe(member);
142
+ }
143
+ });
144
+ });
145
+ });
@@ -0,0 +1,156 @@
1
+ // Which endpoint the runtime sends completions to, as a closed vocabulary.
2
+ //
3
+ // The AI SDK's provider label cannot answer this. A model built by
4
+ // `createOpenAI` reports only its wire API: `openai.responses` for both
5
+ // api.openai.com and Azure (whose own migration guide tells customers to use
6
+ // exactly that client), and `openai.chat` for OpenRouter and a laptop running
7
+ // Ollama alike. So the provider field reports the wire protocol, and the host
8
+ // reports the vendor.
9
+ //
10
+ // Only the classification travels. A base URL like
11
+ // `myresource.openai.azure.com` carries the customer's Azure resource name,
12
+ // which identifies them, so the raw host must never reach telemetry. That is
13
+ // why this returns a member of a fixed list rather than anything derived from
14
+ // the input.
15
+
16
+ /**
17
+ * Every value `classifyModelHost` can return.
18
+ *
19
+ * `other` means a host we observed and did not recognize: a gateway, a proxy,
20
+ * or a vendor we have no rule for. `unknown` means we never saw a host at all,
21
+ * which is the case when a caller hands us an already-built LanguageModel.
22
+ * The two are not interchangeable — one is an unrecognized answer, the other
23
+ * is a missing one, and they need different follow-up.
24
+ */
25
+ export const MODEL_HOST_CLASSES = [
26
+ "openai",
27
+ "azure",
28
+ "openrouter",
29
+ "anthropic",
30
+ "google",
31
+ "vertex",
32
+ "bedrock",
33
+ "groq",
34
+ "unify",
35
+ "minimax",
36
+ "local",
37
+ "other",
38
+ "unknown",
39
+ ] as const;
40
+
41
+ export type ModelHostClass = (typeof MODEL_HOST_CLASSES)[number];
42
+
43
+ /**
44
+ * Host suffixes mapped to their vendor.
45
+ *
46
+ * Matched on label boundaries, never as substrings, so
47
+ * `myresource.openai.azure.com.attacker.test` does not read as Azure.
48
+ */
49
+ const HOST_SUFFIXES: ReadonlyArray<readonly [string, ModelHostClass]> = [
50
+ // Azure exposes the same models under three host families: the classic
51
+ // Azure OpenAI host, the Foundry Models host, and the general Cognitive
52
+ // Services host. All three are Azure for our purposes.
53
+ ["openai.azure.com", "azure"],
54
+ ["services.ai.azure.com", "azure"],
55
+ ["cognitiveservices.azure.com", "azure"],
56
+ // API Management fronting an Azure OpenAI deployment, a common enterprise
57
+ // pattern. Reported as azure because that is what sits behind it.
58
+ ["azure-api.net", "azure"],
59
+
60
+ ["api.openai.com", "openai"],
61
+ ["openrouter.ai", "openrouter"],
62
+ ["api.anthropic.com", "anthropic"],
63
+ ["generativelanguage.googleapis.com", "google"],
64
+ // Vertex regional hosts are `<region>-aiplatform.googleapis.com`, which is
65
+ // not a suffix of a single label, so both spellings are listed.
66
+ ["aiplatform.googleapis.com", "vertex"],
67
+ ["api.groq.com", "groq"],
68
+ ["api.unify.ai", "unify"],
69
+ ["api.minimax.io", "minimax"],
70
+ ["api.minimaxi.com", "minimax"],
71
+ ];
72
+
73
+ /** Suffixes that mean the model runs on the same machine or private network. */
74
+ const LOCAL_SUFFIXES = ["localhost", "local", "internal", "docker.internal"];
75
+
76
+ /** Matches `<region>-aiplatform.googleapis.com` and the Bedrock regional hosts. */
77
+ const REGIONAL_HOST_PATTERNS: ReadonlyArray<readonly [RegExp, ModelHostClass]> =
78
+ [
79
+ [/^[a-z0-9-]+-aiplatform\.googleapis\.com$/, "vertex"],
80
+ [/^bedrock[a-z0-9.-]*\.[a-z0-9-]+\.amazonaws\.com$/, "bedrock"],
81
+ ];
82
+
83
+ /** True when `host` equals `suffix` or sits directly beneath it. */
84
+ function matchesSuffix(host: string, suffix: string): boolean {
85
+ return host === suffix || host.endsWith(`.${suffix}`);
86
+ }
87
+
88
+ /** True for loopback, unspecified, and RFC 1918 private addresses. */
89
+ function isPrivateAddress(host: string): boolean {
90
+ if (host === "127.0.0.1" || host === "0.0.0.0" || host === "::1") {
91
+ return true;
92
+ }
93
+ // 127.0.0.0/8 is entirely loopback.
94
+ if (host.startsWith("127.")) return true;
95
+ // 10.0.0.0/8 and 192.168.0.0/16.
96
+ if (host.startsWith("10.") || host.startsWith("192.168.")) return true;
97
+ // 172.16.0.0/12 is 172.16 through 172.31 only. 172.32 is public, so the
98
+ // second octet is range-checked rather than prefix-matched.
99
+ const privateClassB = /^172\.(\d{1,3})\./.exec(host);
100
+ if (privateClassB) {
101
+ const secondOctet = Number(privateClassB[1]);
102
+ return secondOctet >= 16 && secondOctet <= 31;
103
+ }
104
+ return false;
105
+ }
106
+
107
+ /**
108
+ * Reduce a model endpoint to one of {@link MODEL_HOST_CLASSES}.
109
+ *
110
+ * @param baseUrl The endpoint the provider was configured with. Absent when
111
+ * the provider was left on its own default, which is why `providerDefault`
112
+ * exists: "no base URL, provider is openai" means api.openai.com.
113
+ * @param providerDefault What to report when no base URL was supplied. Callers
114
+ * that genuinely cannot observe a host — a pre-built LanguageModel handed in
115
+ * by the developer — leave this alone and get `unknown`.
116
+ */
117
+ export function classifyModelHost(
118
+ baseUrl?: string | null,
119
+ providerDefault: ModelHostClass = "unknown",
120
+ ): ModelHostClass {
121
+ const trimmed = baseUrl?.trim();
122
+ if (!trimmed) {
123
+ return providerDefault;
124
+ }
125
+
126
+ let host: string;
127
+ try {
128
+ // `hostname` drops the port, the path, the query and any credentials, so
129
+ // nothing but the host can survive into the return value below.
130
+ host = new URL(trimmed).hostname.toLowerCase();
131
+ } catch {
132
+ // We were given something and could not read it. That is a different fact
133
+ // from having been given nothing, so it does not fall back to the default.
134
+ return "other";
135
+ }
136
+
137
+ // IPv6 hostnames arrive bracketed from the URL parser.
138
+ host = host.replace(/^\[|\]$/g, "");
139
+
140
+ if (!host) return "other";
141
+
142
+ if (isPrivateAddress(host)) return "local";
143
+ for (const suffix of LOCAL_SUFFIXES) {
144
+ if (matchesSuffix(host, suffix)) return "local";
145
+ }
146
+
147
+ for (const [suffix, hostClass] of HOST_SUFFIXES) {
148
+ if (matchesSuffix(host, suffix)) return hostClass;
149
+ }
150
+
151
+ for (const [pattern, hostClass] of REGIONAL_HOST_PATTERNS) {
152
+ if (pattern.test(host)) return hostClass;
153
+ }
154
+
155
+ return "other";
156
+ }
@@ -0,0 +1,65 @@
1
+ import { describe, expect, test } from "vitest";
2
+ import {
3
+ computeSamplingMeta,
4
+ TELEMETRY_EMITTER_V1,
5
+ TELEMETRY_EMITTER_V2,
6
+ } from "./sampling";
7
+
8
+ describe("computeSamplingMeta", () => {
9
+ test("anonymous callers get the population weight 1/sampleRate", () => {
10
+ // The gate let 5% through, so each surviving event stands for 20.
11
+ expect(
12
+ computeSamplingMeta({ telemetryId: null, sampleRate: 0.05 }),
13
+ ).toEqual({
14
+ sampleRate: 0.05,
15
+ sampleRateAdjustmentFactor: 0.95,
16
+ sampleWeight: 20,
17
+ telemetry_identified: false,
18
+ });
19
+ });
20
+
21
+ test("identified callers get weight 1 — they bypassed the gate", () => {
22
+ // The branch that matters: an identified event represents only itself,
23
+ // so weighting it by the anonymous population's 20 would inflate every
24
+ // paying customer's volume 20×.
25
+ expect(
26
+ computeSamplingMeta({ telemetryId: "abc-123", sampleRate: 0.05 }),
27
+ ).toEqual({
28
+ sampleRate: 1,
29
+ sampleRateAdjustmentFactor: 0,
30
+ sampleWeight: 1,
31
+ telemetry_identified: true,
32
+ });
33
+ });
34
+
35
+ test("telemetry_identified stays true when sampleRate=1 makes the weights identical", () => {
36
+ // COPILOTKIT_TELEMETRY_SAMPLE_RATE=1 gives anonymous events weight 1
37
+ // too, so weight alone stops separating the populations. This is the
38
+ // case that makes the flag worth carrying rather than inferring
39
+ // (OSS-1018).
40
+ const anon = computeSamplingMeta({ telemetryId: null, sampleRate: 1 });
41
+ const identified = computeSamplingMeta({
42
+ telemetryId: "abc-123",
43
+ sampleRate: 1,
44
+ });
45
+
46
+ expect(anon.sampleWeight).toBe(identified.sampleWeight);
47
+ expect(anon.telemetry_identified).toBe(false);
48
+ expect(identified.telemetry_identified).toBe(true);
49
+ });
50
+
51
+ test("an empty telemetry_id is anonymous, not identified", () => {
52
+ // parseTelemetryIdFromLicense only returns strings or null, but a
53
+ // token carrying `telemetry_id: ""` would otherwise read as identified
54
+ // and silently bypass the sample gate.
55
+ expect(
56
+ computeSamplingMeta({ telemetryId: "", sampleRate: 0.05 }),
57
+ ).toMatchObject({ sampleWeight: 20, telemetry_identified: false });
58
+ });
59
+
60
+ test("the two emitter markers are distinct", () => {
61
+ // Downstream separates the populations by this value; if they ever
62
+ // collide the dedupe rule silently keeps or drops both.
63
+ expect(TELEMETRY_EMITTER_V1).not.toBe(TELEMETRY_EMITTER_V2);
64
+ });
65
+ });
@@ -0,0 +1,103 @@
1
+ // Per-event telemetry metadata shared by both TelemetryClients.
2
+ //
3
+ // Two clients emit `oss.runtime.*`: the v1 client in this package and the
4
+ // v2 client in @copilotkit/runtime. Neither samples the lambda sink any
5
+ // more — that sink is ours, so anonymous volume costs us nothing per
6
+ // event and full fidelity beats an extrapolation. One wire is still
7
+ // gated: the Segment copy the v1 client sends, which is billed per event.
8
+ //
9
+ // Every event therefore still carries a sampling block, because the two
10
+ // populations remain distinguishable and a Segment-sourced count still
11
+ // needs sum(sampleWeight) to mean anything. On the lambda wire the block
12
+ // reads sampleRate=1/sampleWeight=1, which is the honest answer rather
13
+ // than a placeholder.
14
+ //
15
+ // The two clients computed this independently and drifted: v2 sampled but
16
+ // stamped nothing, leaving ~24% of runtime volume unweightable from the
17
+ // data alone (OSS-1017). Computing it here is what stops them drifting
18
+ // again.
19
+
20
+ /** The rate a sink that takes every event is "gated" at. */
21
+ export const UNSAMPLED_RATE = 1;
22
+
23
+ /** Identifies which client emitted an event. */
24
+ export const TELEMETRY_EMITTER_V1 = "v1-shared";
25
+ export const TELEMETRY_EMITTER_V2 = "v2-runtime";
26
+
27
+ export type TelemetryEmitter =
28
+ | typeof TELEMETRY_EMITTER_V1
29
+ | typeof TELEMETRY_EMITTER_V2;
30
+
31
+ /**
32
+ * Which public API surface the developer built against.
33
+ *
34
+ * Separate from {@link TelemetryEmitter} on purpose. The emitter names a
35
+ * client library, and there are six of them across four languages; the
36
+ * surface answers the question anyone actually asks of this data, which
37
+ * is how much traffic still arrives through the deprecated v1 API. The
38
+ * native runtimes (Go, Python, Ruby, .NET) expose v2 only, so they report
39
+ * `v2` without having a v1 notion of their own.
40
+ */
41
+ // `as const` so the values keep their literal types when they land in a
42
+ // mutable object property, which is how the v1 shim passes the surface
43
+ // into the V2 runtime's options.
44
+ export const TELEMETRY_SURFACE_V1 = "v1" as const;
45
+ export const TELEMETRY_SURFACE_V2 = "v2" as const;
46
+
47
+ export type TelemetrySurface =
48
+ | typeof TELEMETRY_SURFACE_V1
49
+ | typeof TELEMETRY_SURFACE_V2;
50
+
51
+ /**
52
+ * Which wire an event copy travelled on. The v1 client sends each capture
53
+ * to both, so this is what tells the two copies apart downstream
54
+ * (OSS-1019); the v2 client only ever sends to the lambda sink.
55
+ */
56
+ export type TelemetryTransport = "segment" | "lambda";
57
+
58
+ export interface SamplingMeta {
59
+ /** The rate this event was actually gated at: 1 when unsampled or identified. */
60
+ sampleRate: number;
61
+ sampleRateAdjustmentFactor: number;
62
+ /** Multiply by this to extrapolate the population the event stands for. */
63
+ sampleWeight: number;
64
+ /** Whether the event bypassed the sample gate. */
65
+ telemetry_identified: boolean;
66
+ }
67
+
68
+ /**
69
+ * Compute the sampling block for one captured event.
70
+ *
71
+ * `telemetryId` is the caller's parsed license telemetry_id, or null when
72
+ * anonymous — it decides the branch, and is deliberately not returned:
73
+ * only the non-PII shape below travels on the event.
74
+ *
75
+ * `sampleRate` is the rate of the wire this copy travels on, so an
76
+ * unsampled sink passes {@link UNSAMPLED_RATE}. Call it once per wire:
77
+ * the v1 client sends one capture to two wires gated differently, and a
78
+ * shared block would misweight one of them.
79
+ */
80
+ export function computeSamplingMeta({
81
+ telemetryId,
82
+ sampleRate,
83
+ }: {
84
+ telemetryId: string | null;
85
+ sampleRate: number;
86
+ }): SamplingMeta {
87
+ const identified = Boolean(telemetryId);
88
+ // Identified events ship at a 100% effective rate, anonymous ones at
89
+ // sampleRate. Computed per event because a single global weight would
90
+ // overweight identified-customer counts by 1/sampleRate.
91
+ const effectiveSampleRate = identified ? 1 : sampleRate;
92
+
93
+ return {
94
+ sampleRate: effectiveSampleRate,
95
+ sampleRateAdjustmentFactor: 1 - effectiveSampleRate,
96
+ sampleWeight: 1 / effectiveSampleRate,
97
+ // Stated outright rather than inferred from sampleWeight === 1:
98
+ // under COPILOTKIT_TELEMETRY_SAMPLE_RATE=1 anonymous events also
99
+ // weigh 1, and the two populations stop being distinguishable
100
+ // (OSS-1018).
101
+ telemetry_identified: identified,
102
+ };
103
+ }
@@ -0,0 +1,128 @@
1
+ import { expect, test, vi } from "vitest";
2
+ import { lambdaClient } from "./lambda-client";
3
+ import { TelemetryClient } from "./telemetry-client";
4
+
5
+ const { segmentTrackMock } = vi.hoisted(() => ({
6
+ segmentTrackMock: vi.fn(),
7
+ }));
8
+
9
+ vi.mock("@segment/analytics-node", () => ({
10
+ Analytics: class {
11
+ track = segmentTrackMock;
12
+ },
13
+ }));
14
+
15
+ const instanceCreatedEvent = {
16
+ actionsAmount: 0,
17
+ endpointTypes: [],
18
+ endpointsAmount: 0,
19
+ "cloud.api_key_provided": false,
20
+ };
21
+
22
+ /** Build the signature-agnostic legacy token shape used at this boundary. */
23
+ function jwtWithTelemetryId(telemetryId: string): string {
24
+ const payload = Buffer.from(
25
+ JSON.stringify({ telemetry_id: telemetryId }),
26
+ ).toString("base64url");
27
+ return `header.${payload}.sig`;
28
+ }
29
+
30
+ /** Creates one isolated Shared telemetry capture with a fixed sampling decision. */
31
+ function setupSharedCapture(randomValue: number, telemetryId: string = " \t ") {
32
+ const priorSampleRate = process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE;
33
+ delete process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE;
34
+ segmentTrackMock.mockReset();
35
+ const randomSpy = vi.spyOn(Math, "random").mockReturnValue(randomValue);
36
+ const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => undefined);
37
+ const client = new TelemetryClient({
38
+ packageName: "@copilotkit/shared",
39
+ packageVersion: "test",
40
+ telemetryDisabled: false,
41
+ sampleRate: 0.05,
42
+ });
43
+ client.setLicenseToken(jwtWithTelemetryId(telemetryId));
44
+
45
+ return {
46
+ client,
47
+ randomSpy,
48
+ teardown: () => {
49
+ randomSpy.mockRestore();
50
+ warnSpy.mockRestore();
51
+ segmentTrackMock.mockReset();
52
+ if (priorSampleRate === undefined) {
53
+ delete process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE;
54
+ } else {
55
+ process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE = priorSampleRate;
56
+ }
57
+ },
58
+ };
59
+ }
60
+
61
+ test("Shared whitespace-only legacy claim stays subject to the Segment gate", async () => {
62
+ const sinkSpy = vi.spyOn(lambdaClient, "send").mockResolvedValue(undefined);
63
+ const { client, randomSpy, teardown } = setupSharedCapture(0.99);
64
+
65
+ try {
66
+ await client.capture("oss.runtime.instance_created", instanceCreatedEvent);
67
+
68
+ // An unusable claim must not buy identified status. The gate it now
69
+ // fails is Segment's alone: the lambda copy goes either way, and what
70
+ // proves the claim was rejected is that it goes marked anonymous.
71
+ expect(randomSpy).toHaveBeenCalledTimes(1);
72
+ expect(segmentTrackMock).not.toHaveBeenCalled();
73
+ expect(sinkSpy.mock.calls[0][0].globalProperties).toMatchObject({
74
+ telemetry_identified: false,
75
+ });
76
+ } finally {
77
+ sinkSpy.mockRestore();
78
+ teardown();
79
+ }
80
+ });
81
+
82
+ test("Shared sampled whitespace-only legacy claim sends no identity header", async () => {
83
+ const fetchSpy = vi
84
+ .spyOn(globalThis, "fetch")
85
+ .mockResolvedValue(new Response("", { status: 202 }));
86
+ const { client, randomSpy, teardown } = setupSharedCapture(0);
87
+
88
+ try {
89
+ await client.capture("oss.runtime.instance_created", instanceCreatedEvent);
90
+
91
+ expect(randomSpy).toHaveBeenCalledTimes(1);
92
+ expect(fetchSpy).toHaveBeenCalledTimes(1);
93
+ const request = fetchSpy.mock.calls[0]?.[1];
94
+ expect(
95
+ new Headers(request?.headers).get("X-CopilotKit-Telemetry-Id"),
96
+ ).toBeNull();
97
+ } finally {
98
+ fetchSpy.mockRestore();
99
+ teardown();
100
+ }
101
+ });
102
+
103
+ test.each(["bad\nid", "bad\u0000id", "tenant-🚀"])(
104
+ "Shared header-invalid legacy claim %j stays subject to the Segment gate",
105
+ async (invalidTelemetryId) => {
106
+ const sinkSpy = vi.spyOn(lambdaClient, "send").mockResolvedValue(undefined);
107
+ const { client, randomSpy, teardown } = setupSharedCapture(
108
+ 0.99,
109
+ invalidTelemetryId,
110
+ );
111
+
112
+ try {
113
+ await client.capture(
114
+ "oss.runtime.instance_created",
115
+ instanceCreatedEvent,
116
+ );
117
+
118
+ expect(randomSpy).toHaveBeenCalledTimes(1);
119
+ expect(segmentTrackMock).not.toHaveBeenCalled();
120
+ expect(sinkSpy.mock.calls[0][0].globalProperties).toMatchObject({
121
+ telemetry_identified: false,
122
+ });
123
+ } finally {
124
+ sinkSpy.mockRestore();
125
+ teardown();
126
+ }
127
+ },
128
+ );