skybridge 0.0.0-dev.f615683 → 0.0.0-dev.f67d065

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 (590) hide show
  1. package/LICENSE +21 -674
  2. package/README.md +124 -94
  3. package/bin/run.js +5 -0
  4. package/dist/cli/build-helpers.d.ts +11 -0
  5. package/dist/cli/build-helpers.js +102 -0
  6. package/dist/cli/build-helpers.js.map +1 -0
  7. package/dist/cli/build-helpers.test.js +119 -0
  8. package/dist/cli/build-helpers.test.js.map +1 -0
  9. package/dist/cli/build-steps.d.ts +2 -0
  10. package/dist/cli/build-steps.js +73 -0
  11. package/dist/cli/build-steps.js.map +1 -0
  12. package/dist/cli/build-steps.test.js +52 -0
  13. package/dist/cli/build-steps.test.js.map +1 -0
  14. package/dist/cli/detect-port.d.ts +18 -0
  15. package/dist/cli/detect-port.js +50 -0
  16. package/dist/cli/detect-port.js.map +1 -0
  17. package/dist/cli/header.d.ts +4 -0
  18. package/dist/cli/header.js +6 -0
  19. package/dist/cli/header.js.map +1 -0
  20. package/dist/cli/resolve-views-dir.d.ts +1 -0
  21. package/dist/cli/resolve-views-dir.js +17 -0
  22. package/dist/cli/resolve-views-dir.js.map +1 -0
  23. package/dist/cli/run-command.d.ts +2 -0
  24. package/dist/cli/run-command.js +43 -0
  25. package/dist/cli/run-command.js.map +1 -0
  26. package/dist/cli/run-plain.d.ts +18 -0
  27. package/dist/cli/run-plain.js +89 -0
  28. package/dist/cli/run-plain.js.map +1 -0
  29. package/dist/cli/telemetry.d.ts +7 -0
  30. package/dist/cli/telemetry.js +123 -0
  31. package/dist/cli/telemetry.js.map +1 -0
  32. package/dist/cli/tunnel-control-server.d.ts +9 -0
  33. package/dist/cli/tunnel-control-server.js +31 -0
  34. package/dist/cli/tunnel-control-server.js.map +1 -0
  35. package/dist/cli/tunnel-control-server.test.js +39 -0
  36. package/dist/cli/tunnel-control-server.test.js.map +1 -0
  37. package/dist/cli/tunnel-handler.d.ts +3 -0
  38. package/dist/cli/tunnel-handler.js +48 -0
  39. package/dist/cli/tunnel-handler.js.map +1 -0
  40. package/dist/cli/tunnel-handler.test.js +105 -0
  41. package/dist/cli/tunnel-handler.test.js.map +1 -0
  42. package/dist/cli/tunnel.d.ts +57 -0
  43. package/dist/cli/tunnel.js +154 -0
  44. package/dist/cli/tunnel.js.map +1 -0
  45. package/dist/cli/tunnel.test.js +190 -0
  46. package/dist/cli/tunnel.test.js.map +1 -0
  47. package/dist/cli/types.d.ts +5 -0
  48. package/dist/cli/types.js +2 -0
  49. package/dist/cli/types.js.map +1 -0
  50. package/dist/cli/use-execute-steps.d.ts +11 -0
  51. package/dist/cli/use-execute-steps.js +36 -0
  52. package/dist/cli/use-execute-steps.js.map +1 -0
  53. package/dist/cli/use-messages.d.ts +3 -0
  54. package/dist/cli/use-messages.js +11 -0
  55. package/dist/cli/use-messages.js.map +1 -0
  56. package/dist/cli/use-nodemon.d.ts +16 -0
  57. package/dist/cli/use-nodemon.js +84 -0
  58. package/dist/cli/use-nodemon.js.map +1 -0
  59. package/dist/cli/use-open-browser.d.ts +1 -0
  60. package/dist/cli/use-open-browser.js +44 -0
  61. package/dist/cli/use-open-browser.js.map +1 -0
  62. package/dist/cli/use-tunnel.d.ts +14 -0
  63. package/dist/cli/use-tunnel.js +131 -0
  64. package/dist/cli/use-tunnel.js.map +1 -0
  65. package/dist/cli/use-typescript-check.d.ts +15 -0
  66. package/dist/cli/use-typescript-check.js +97 -0
  67. package/dist/cli/use-typescript-check.js.map +1 -0
  68. package/dist/commands/build.d.ts +6 -0
  69. package/dist/commands/build.js +31 -0
  70. package/dist/commands/build.js.map +1 -0
  71. package/dist/commands/create.d.ts +9 -0
  72. package/dist/commands/create.js +30 -0
  73. package/dist/commands/create.js.map +1 -0
  74. package/dist/commands/dev.d.ts +13 -0
  75. package/dist/commands/dev.js +128 -0
  76. package/dist/commands/dev.js.map +1 -0
  77. package/dist/commands/start.d.ts +9 -0
  78. package/dist/commands/start.js +55 -0
  79. package/dist/commands/start.js.map +1 -0
  80. package/dist/commands/telemetry/disable.d.ts +5 -0
  81. package/dist/commands/telemetry/disable.js +14 -0
  82. package/dist/commands/telemetry/disable.js.map +1 -0
  83. package/dist/commands/telemetry/enable.d.ts +5 -0
  84. package/dist/commands/telemetry/enable.js +14 -0
  85. package/dist/commands/telemetry/enable.js.map +1 -0
  86. package/dist/commands/telemetry/status.d.ts +5 -0
  87. package/dist/commands/telemetry/status.js +14 -0
  88. package/dist/commands/telemetry/status.js.map +1 -0
  89. package/dist/server/asset-base-url-transform-plugin.d.ts +11 -0
  90. package/dist/server/asset-base-url-transform-plugin.js +48 -0
  91. package/dist/server/asset-base-url-transform-plugin.js.map +1 -0
  92. package/dist/server/asset-base-url-transform-plugin.test.js +134 -0
  93. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -0
  94. package/dist/server/auth/discovery.d.ts +32 -0
  95. package/dist/server/auth/discovery.js +56 -0
  96. package/dist/server/auth/discovery.js.map +1 -0
  97. package/dist/server/auth/discovery.test.js +93 -0
  98. package/dist/server/auth/discovery.test.js.map +1 -0
  99. package/dist/server/auth/index.d.ts +18 -0
  100. package/dist/server/auth/index.js.map +1 -0
  101. package/dist/server/auth/providers/auth0.d.ts +18 -0
  102. package/dist/server/auth/providers/auth0.js +31 -0
  103. package/dist/server/auth/providers/auth0.js.map +1 -0
  104. package/dist/server/auth/providers/auth0.test.js +48 -0
  105. package/dist/server/auth/providers/auth0.test.js.map +1 -0
  106. package/dist/server/auth/providers/clerk.d.ts +14 -0
  107. package/dist/server/auth/providers/clerk.js +16 -0
  108. package/dist/server/auth/providers/clerk.js.map +1 -0
  109. package/dist/server/auth/providers/clerk.test.js +28 -0
  110. package/dist/server/auth/providers/clerk.test.js.map +1 -0
  111. package/dist/server/auth/providers/custom.d.ts +31 -0
  112. package/dist/server/auth/providers/custom.js +49 -0
  113. package/dist/server/auth/providers/custom.js.map +1 -0
  114. package/dist/server/auth/providers/custom.test.js +156 -0
  115. package/dist/server/auth/providers/custom.test.js.map +1 -0
  116. package/dist/server/auth/providers/descope.d.ts +15 -0
  117. package/dist/server/auth/providers/descope.js +36 -0
  118. package/dist/server/auth/providers/descope.js.map +1 -0
  119. package/dist/server/auth/providers/descope.test.js +61 -0
  120. package/dist/server/auth/providers/descope.test.js.map +1 -0
  121. package/dist/server/auth/providers/shared.d.ts +2 -0
  122. package/dist/server/auth/providers/shared.js +6 -0
  123. package/dist/server/auth/providers/shared.js.map +1 -0
  124. package/dist/server/auth/providers/shared.test.js +10 -0
  125. package/dist/server/auth/providers/shared.test.js.map +1 -0
  126. package/dist/server/auth/providers/stytch.d.ts +12 -0
  127. package/dist/server/auth/providers/stytch.js +13 -0
  128. package/dist/server/auth/providers/stytch.js.map +1 -0
  129. package/dist/server/auth/providers/workos.d.ts +11 -0
  130. package/dist/server/auth/providers/workos.js +12 -0
  131. package/dist/server/auth/providers/workos.js.map +1 -0
  132. package/dist/server/auth/security-schemes.d.ts +23 -0
  133. package/dist/server/auth/security-schemes.js +64 -0
  134. package/dist/server/auth/security-schemes.js.map +1 -0
  135. package/dist/server/auth/security-schemes.test.js +99 -0
  136. package/dist/server/auth/security-schemes.test.js.map +1 -0
  137. package/dist/server/auth/setup.d.ts +6 -0
  138. package/dist/server/auth/setup.js +92 -0
  139. package/dist/server/auth/setup.js.map +1 -0
  140. package/dist/server/auth/setup.test.js +474 -0
  141. package/dist/server/auth/setup.test.js.map +1 -0
  142. package/dist/server/auth/verify.d.ts +12 -0
  143. package/dist/server/auth/verify.js +38 -0
  144. package/dist/server/auth/verify.js.map +1 -0
  145. package/dist/server/auth/verify.test.js +100 -0
  146. package/dist/server/auth/verify.test.js.map +1 -0
  147. package/dist/server/auth.d.ts +20 -0
  148. package/dist/server/auth.js +28 -0
  149. package/dist/server/auth.js.map +1 -0
  150. package/dist/server/build-manifest.test.js +27 -0
  151. package/dist/server/build-manifest.test.js.map +1 -0
  152. package/dist/server/content-helpers.d.ts +67 -0
  153. package/dist/server/content-helpers.js +79 -0
  154. package/dist/server/content-helpers.js.map +1 -0
  155. package/dist/server/content-helpers.test.js +70 -0
  156. package/dist/server/content-helpers.test.js.map +1 -0
  157. package/dist/server/express.d.ts +11 -0
  158. package/dist/server/express.js +101 -0
  159. package/dist/server/express.js.map +1 -0
  160. package/dist/server/express.test.js +491 -0
  161. package/dist/server/express.test.js.map +1 -0
  162. package/dist/server/file-ref.d.ts +28 -0
  163. package/dist/server/file-ref.js +27 -0
  164. package/dist/server/file-ref.js.map +1 -0
  165. package/dist/server/host.d.ts +2 -0
  166. package/dist/server/host.js +11 -0
  167. package/dist/server/host.js.map +1 -0
  168. package/dist/server/host.test.js +13 -0
  169. package/dist/server/host.test.js.map +1 -0
  170. package/dist/server/index.d.ts +16 -0
  171. package/dist/server/index.js +13 -0
  172. package/dist/server/index.js.map +1 -0
  173. package/dist/{src/server → server}/inferUtilityTypes.d.ts +15 -5
  174. package/dist/server/inferUtilityTypes.js.map +1 -0
  175. package/dist/server/metric.d.ts +14 -0
  176. package/dist/server/metric.js +62 -0
  177. package/dist/server/metric.js.map +1 -0
  178. package/dist/server/middleware.d.ts +137 -0
  179. package/dist/server/middleware.js +93 -0
  180. package/dist/server/middleware.js.map +1 -0
  181. package/dist/server/middleware.test-d.js +75 -0
  182. package/dist/server/middleware.test-d.js.map +1 -0
  183. package/dist/server/middleware.test.d.ts +1 -0
  184. package/dist/server/middleware.test.js +493 -0
  185. package/dist/server/middleware.test.js.map +1 -0
  186. package/dist/server/requestOrigin.d.ts +7 -0
  187. package/dist/server/requestOrigin.js +25 -0
  188. package/dist/server/requestOrigin.js.map +1 -0
  189. package/dist/server/server.d.ts +455 -0
  190. package/dist/server/server.js +731 -0
  191. package/dist/server/server.js.map +1 -0
  192. package/dist/server/skills-integration.test.d.ts +1 -0
  193. package/dist/server/skills-integration.test.js +63 -0
  194. package/dist/server/skills-integration.test.js.map +1 -0
  195. package/dist/server/skills.d.ts +23 -0
  196. package/dist/server/skills.js +178 -0
  197. package/dist/server/skills.js.map +1 -0
  198. package/dist/server/skills.test.d.ts +1 -0
  199. package/dist/server/skills.test.js +210 -0
  200. package/dist/server/skills.test.js.map +1 -0
  201. package/dist/{src/server → server}/templateHelper.d.ts +5 -4
  202. package/dist/server/templateHelper.js +11 -0
  203. package/dist/server/templateHelper.js.map +1 -0
  204. package/dist/server/templates.generated.d.ts +4 -0
  205. package/dist/server/templates.generated.js +47 -0
  206. package/dist/server/templates.generated.js.map +1 -0
  207. package/dist/server/tunnel-proxy-router.d.ts +7 -0
  208. package/dist/server/tunnel-proxy-router.js +110 -0
  209. package/dist/server/tunnel-proxy-router.js.map +1 -0
  210. package/dist/server/tunnel-proxy-router.test.d.ts +1 -0
  211. package/dist/server/tunnel-proxy-router.test.js +229 -0
  212. package/dist/server/tunnel-proxy-router.test.js.map +1 -0
  213. package/dist/server/view-name.test-d.d.ts +1 -0
  214. package/dist/server/view-name.test-d.js +8 -0
  215. package/dist/server/view-name.test-d.js.map +1 -0
  216. package/dist/server/view-resource-resolution.test.d.ts +6 -0
  217. package/dist/server/view-resource-resolution.test.js +171 -0
  218. package/dist/server/view-resource-resolution.test.js.map +1 -0
  219. package/dist/server/viewsDevServer.d.ts +14 -0
  220. package/dist/server/viewsDevServer.js +48 -0
  221. package/dist/server/viewsDevServer.js.map +1 -0
  222. package/dist/test/utils.d.ts +127 -0
  223. package/dist/{src/test → test}/utils.js +111 -28
  224. package/dist/test/utils.js.map +1 -0
  225. package/dist/test/view.test.d.ts +1 -0
  226. package/dist/test/view.test.js +536 -0
  227. package/dist/test/view.test.js.map +1 -0
  228. package/dist/version.d.ts +1 -0
  229. package/dist/version.js +3 -0
  230. package/dist/version.js.map +1 -0
  231. package/dist/web/bridges/adaptor.d.ts +51 -0
  232. package/dist/web/bridges/adaptor.js +330 -0
  233. package/dist/web/bridges/adaptor.js.map +1 -0
  234. package/dist/web/bridges/adaptor.test.d.ts +1 -0
  235. package/dist/web/bridges/adaptor.test.js +208 -0
  236. package/dist/web/bridges/adaptor.test.js.map +1 -0
  237. package/dist/web/bridges/apps-sdk/bridge.d.ts +15 -0
  238. package/dist/web/bridges/apps-sdk/bridge.js +58 -0
  239. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -0
  240. package/dist/web/bridges/apps-sdk/index.d.ts +4 -0
  241. package/dist/web/bridges/apps-sdk/index.js +4 -0
  242. package/dist/web/bridges/apps-sdk/index.js.map +1 -0
  243. package/dist/web/bridges/apps-sdk/types.d.ts +133 -0
  244. package/dist/{src/web → web/bridges/apps-sdk}/types.js +0 -1
  245. package/dist/web/bridges/apps-sdk/types.js.map +1 -0
  246. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +13 -0
  247. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +18 -0
  248. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -0
  249. package/dist/web/bridges/get-adaptor.d.ts +9 -0
  250. package/dist/web/bridges/get-adaptor.js +10 -0
  251. package/dist/web/bridges/get-adaptor.js.map +1 -0
  252. package/dist/web/bridges/get-adaptor.test.d.ts +1 -0
  253. package/dist/web/bridges/get-adaptor.test.js +32 -0
  254. package/dist/web/bridges/get-adaptor.test.js.map +1 -0
  255. package/dist/web/bridges/index.d.ts +5 -0
  256. package/dist/web/bridges/index.js +6 -0
  257. package/dist/web/bridges/index.js.map +1 -0
  258. package/dist/web/bridges/mcp-app/bridge.d.ts +39 -0
  259. package/dist/web/bridges/mcp-app/bridge.js +166 -0
  260. package/dist/web/bridges/mcp-app/bridge.js.map +1 -0
  261. package/dist/web/bridges/mcp-app/bridge.test.d.ts +1 -0
  262. package/dist/web/bridges/mcp-app/bridge.test.js +17 -0
  263. package/dist/web/bridges/mcp-app/bridge.test.js.map +1 -0
  264. package/dist/web/bridges/mcp-app/index.d.ts +3 -0
  265. package/dist/web/bridges/mcp-app/index.js +3 -0
  266. package/dist/web/bridges/mcp-app/index.js.map +1 -0
  267. package/dist/web/bridges/mcp-app/types.d.ts +8 -0
  268. package/dist/web/bridges/mcp-app/types.js +2 -0
  269. package/dist/web/bridges/mcp-app/types.js.map +1 -0
  270. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +19 -0
  271. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +19 -0
  272. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -0
  273. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.d.ts +1 -0
  274. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js +26 -0
  275. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -0
  276. package/dist/web/bridges/mcp-app/view-tools.test.d.ts +1 -0
  277. package/dist/web/bridges/mcp-app/view-tools.test.js +143 -0
  278. package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -0
  279. package/dist/web/bridges/types.d.ts +214 -0
  280. package/dist/web/bridges/types.js +15 -0
  281. package/dist/web/bridges/types.js.map +1 -0
  282. package/dist/web/bridges/types.test.d.ts +1 -0
  283. package/dist/web/bridges/types.test.js +19 -0
  284. package/dist/web/bridges/types.test.js.map +1 -0
  285. package/dist/web/bridges/use-host-context.d.ts +7 -0
  286. package/dist/web/bridges/use-host-context.js +13 -0
  287. package/dist/web/bridges/use-host-context.js.map +1 -0
  288. package/dist/web/components/modal-provider.d.ts +4 -0
  289. package/dist/web/components/modal-provider.js +46 -0
  290. package/dist/web/components/modal-provider.js.map +1 -0
  291. package/dist/web/create-store.d.ts +29 -0
  292. package/dist/web/create-store.js +64 -0
  293. package/dist/web/create-store.js.map +1 -0
  294. package/dist/web/create-store.test.d.ts +1 -0
  295. package/dist/web/create-store.test.js +132 -0
  296. package/dist/web/create-store.test.js.map +1 -0
  297. package/dist/web/data-llm.d.ts +47 -0
  298. package/dist/{src/web → web}/data-llm.js +39 -7
  299. package/dist/web/data-llm.js.map +1 -0
  300. package/dist/web/data-llm.test.d.ts +1 -0
  301. package/dist/web/data-llm.test.js +154 -0
  302. package/dist/web/data-llm.test.js.map +1 -0
  303. package/dist/{src/web → web}/generate-helpers.d.ts +31 -24
  304. package/dist/{src/web → web}/generate-helpers.js +26 -20
  305. package/dist/web/generate-helpers.js.map +1 -0
  306. package/dist/web/generate-helpers.test-d.d.ts +1 -0
  307. package/dist/{src/web → web}/generate-helpers.test-d.js +80 -23
  308. package/dist/web/generate-helpers.test-d.js.map +1 -0
  309. package/dist/web/generate-helpers.test.d.ts +1 -0
  310. package/dist/web/generate-helpers.test.js.map +1 -0
  311. package/dist/{src/web → web}/helpers/state.d.ts +2 -2
  312. package/dist/web/helpers/state.js +45 -0
  313. package/dist/web/helpers/state.js.map +1 -0
  314. package/dist/web/helpers/state.test.d.ts +1 -0
  315. package/dist/{src/web → web}/helpers/state.test.js +9 -9
  316. package/dist/web/helpers/state.test.js.map +1 -0
  317. package/dist/web/hooks/index.d.ts +15 -0
  318. package/dist/web/hooks/index.js +16 -0
  319. package/dist/web/hooks/index.js.map +1 -0
  320. package/dist/web/hooks/test/utils.d.ts +20 -0
  321. package/dist/web/hooks/test/utils.js +75 -0
  322. package/dist/web/hooks/test/utils.js.map +1 -0
  323. package/dist/{src/web → web}/hooks/use-call-tool.d.ts +48 -2
  324. package/dist/web/hooks/use-call-tool.js +96 -0
  325. package/dist/web/hooks/use-call-tool.js.map +1 -0
  326. package/dist/web/hooks/use-call-tool.test-d.d.ts +1 -0
  327. package/dist/web/hooks/use-call-tool.test-d.js.map +1 -0
  328. package/dist/web/hooks/use-call-tool.test.d.ts +1 -0
  329. package/dist/{src/web → web}/hooks/use-call-tool.test.js +92 -38
  330. package/dist/web/hooks/use-call-tool.test.js.map +1 -0
  331. package/dist/web/hooks/use-display-mode.d.ts +24 -0
  332. package/dist/web/hooks/use-display-mode.js +29 -0
  333. package/dist/web/hooks/use-display-mode.js.map +1 -0
  334. package/dist/web/hooks/use-display-mode.test-d.d.ts +1 -0
  335. package/dist/web/hooks/use-display-mode.test-d.js +8 -0
  336. package/dist/web/hooks/use-display-mode.test-d.js.map +1 -0
  337. package/dist/web/hooks/use-display-mode.test.d.ts +1 -0
  338. package/dist/web/hooks/use-display-mode.test.js +77 -0
  339. package/dist/web/hooks/use-display-mode.test.js.map +1 -0
  340. package/dist/web/hooks/use-download.d.ts +5 -0
  341. package/dist/web/hooks/use-download.js +8 -0
  342. package/dist/web/hooks/use-download.js.map +1 -0
  343. package/dist/web/hooks/use-download.test.d.ts +1 -0
  344. package/dist/web/hooks/use-download.test.js +103 -0
  345. package/dist/web/hooks/use-download.test.js.map +1 -0
  346. package/dist/web/hooks/use-files.d.ts +39 -0
  347. package/dist/web/hooks/use-files.js +42 -0
  348. package/dist/web/hooks/use-files.js.map +1 -0
  349. package/dist/web/hooks/use-files.test.d.ts +1 -0
  350. package/dist/web/hooks/use-files.test.js +62 -0
  351. package/dist/web/hooks/use-files.test.js.map +1 -0
  352. package/dist/web/hooks/use-layout.d.ts +24 -0
  353. package/dist/web/hooks/use-layout.js +25 -0
  354. package/dist/web/hooks/use-layout.js.map +1 -0
  355. package/dist/web/hooks/use-layout.test.d.ts +1 -0
  356. package/dist/web/hooks/use-layout.test.js +129 -0
  357. package/dist/web/hooks/use-layout.test.js.map +1 -0
  358. package/dist/web/hooks/use-open-external.d.ts +20 -0
  359. package/dist/web/hooks/use-open-external.js +24 -0
  360. package/dist/web/hooks/use-open-external.js.map +1 -0
  361. package/dist/web/hooks/use-open-external.test.d.ts +1 -0
  362. package/dist/web/hooks/use-open-external.test.js +75 -0
  363. package/dist/web/hooks/use-open-external.test.js.map +1 -0
  364. package/dist/web/hooks/use-register-view-tool.d.ts +38 -0
  365. package/dist/web/hooks/use-register-view-tool.js +50 -0
  366. package/dist/web/hooks/use-register-view-tool.js.map +1 -0
  367. package/dist/web/hooks/use-request-close.d.ts +16 -0
  368. package/dist/web/hooks/use-request-close.js +21 -0
  369. package/dist/web/hooks/use-request-close.js.map +1 -0
  370. package/dist/web/hooks/use-request-close.test.d.ts +1 -0
  371. package/dist/web/hooks/use-request-close.test.js +47 -0
  372. package/dist/web/hooks/use-request-close.test.js.map +1 -0
  373. package/dist/web/hooks/use-request-modal.d.ts +24 -0
  374. package/dist/web/hooks/use-request-modal.js +31 -0
  375. package/dist/web/hooks/use-request-modal.js.map +1 -0
  376. package/dist/web/hooks/use-request-modal.test.d.ts +1 -0
  377. package/dist/web/hooks/use-request-modal.test.js +71 -0
  378. package/dist/web/hooks/use-request-modal.test.js.map +1 -0
  379. package/dist/web/hooks/use-request-size.d.ts +20 -0
  380. package/dist/web/hooks/use-request-size.js +24 -0
  381. package/dist/web/hooks/use-request-size.js.map +1 -0
  382. package/dist/web/hooks/use-request-size.test.d.ts +1 -0
  383. package/dist/web/hooks/use-request-size.test.js +47 -0
  384. package/dist/web/hooks/use-request-size.test.js.map +1 -0
  385. package/dist/web/hooks/use-send-follow-up-message.d.ts +19 -0
  386. package/dist/web/hooks/use-send-follow-up-message.js +25 -0
  387. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -0
  388. package/dist/web/hooks/use-set-open-in-app-url.d.ts +18 -0
  389. package/dist/web/hooks/use-set-open-in-app-url.js +25 -0
  390. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -0
  391. package/dist/web/hooks/use-set-open-in-app-url.test.d.ts +1 -0
  392. package/dist/web/hooks/use-set-open-in-app-url.test.js +63 -0
  393. package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -0
  394. package/dist/web/hooks/use-tool-info.d.ts +87 -0
  395. package/dist/web/hooks/use-tool-info.js +49 -0
  396. package/dist/web/hooks/use-tool-info.js.map +1 -0
  397. package/dist/web/hooks/use-tool-info.test-d.d.ts +1 -0
  398. package/dist/{src/web → web}/hooks/use-tool-info.test-d.js +24 -6
  399. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -0
  400. package/dist/web/hooks/use-tool-info.test.d.ts +1 -0
  401. package/dist/web/hooks/use-tool-info.test.js +140 -0
  402. package/dist/web/hooks/use-tool-info.test.js.map +1 -0
  403. package/dist/web/hooks/use-user.d.ts +20 -0
  404. package/dist/web/hooks/use-user.js +37 -0
  405. package/dist/web/hooks/use-user.js.map +1 -0
  406. package/dist/web/hooks/use-user.test.d.ts +1 -0
  407. package/dist/web/hooks/use-user.test.js +168 -0
  408. package/dist/web/hooks/use-user.test.js.map +1 -0
  409. package/dist/web/hooks/use-view-state.d.ts +25 -0
  410. package/dist/web/hooks/use-view-state.js +32 -0
  411. package/dist/web/hooks/use-view-state.js.map +1 -0
  412. package/dist/web/hooks/use-view-state.test.d.ts +1 -0
  413. package/dist/web/hooks/use-view-state.test.js +181 -0
  414. package/dist/web/hooks/use-view-state.test.js.map +1 -0
  415. package/dist/{src/web → web}/index.d.ts +2 -2
  416. package/dist/{src/web → web}/index.js +2 -2
  417. package/dist/web/index.js.map +1 -0
  418. package/dist/web/mount-view.d.ts +20 -0
  419. package/dist/web/mount-view.js +46 -0
  420. package/dist/web/mount-view.js.map +1 -0
  421. package/dist/web/plugin/data-llm.test.d.ts +1 -0
  422. package/dist/web/plugin/data-llm.test.js.map +1 -0
  423. package/dist/web/plugin/plugin.d.ts +33 -0
  424. package/dist/web/plugin/plugin.js +188 -0
  425. package/dist/web/plugin/plugin.js.map +1 -0
  426. package/dist/web/plugin/scan-views.d.ts +16 -0
  427. package/dist/web/plugin/scan-views.js +88 -0
  428. package/dist/web/plugin/scan-views.js.map +1 -0
  429. package/dist/web/plugin/scan-views.test.d.ts +1 -0
  430. package/dist/web/plugin/scan-views.test.js +99 -0
  431. package/dist/web/plugin/scan-views.test.js.map +1 -0
  432. package/dist/{src/web → web}/plugin/transform-data-llm.js +7 -4
  433. package/dist/web/plugin/transform-data-llm.js.map +1 -0
  434. package/dist/web/plugin/transform-data-llm.test.d.ts +1 -0
  435. package/dist/web/plugin/transform-data-llm.test.js.map +1 -0
  436. package/dist/web/plugin/validate-view.d.ts +1 -0
  437. package/dist/web/plugin/validate-view.js +9 -0
  438. package/dist/web/plugin/validate-view.js.map +1 -0
  439. package/dist/web/plugin/validate-view.test.d.ts +1 -0
  440. package/dist/web/plugin/validate-view.test.js +24 -0
  441. package/dist/web/plugin/validate-view.test.js.map +1 -0
  442. package/dist/{src/web → web}/proxy.js +5 -1
  443. package/dist/web/proxy.js.map +1 -0
  444. package/dist/web/types.d.ts +20 -0
  445. package/dist/web/types.js +2 -0
  446. package/dist/web/types.js.map +1 -0
  447. package/package.json +87 -43
  448. package/tsconfig.base.json +33 -0
  449. package/dist/src/emulator/assets/index-BjyctK8j.js +0 -133
  450. package/dist/src/emulator/assets/index-BlZAHQDQ.css +0 -1
  451. package/dist/src/emulator/favicon.ico +0 -0
  452. package/dist/src/emulator/index.html +0 -14
  453. package/dist/src/server/emulatorStaticServer.d.ts +0 -15
  454. package/dist/src/server/emulatorStaticServer.js +0 -38
  455. package/dist/src/server/emulatorStaticServer.js.map +0 -1
  456. package/dist/src/server/index.d.ts +0 -1
  457. package/dist/src/server/index.js.map +0 -1
  458. package/dist/src/server/inferUtilityTypes.js.map +0 -1
  459. package/dist/src/server/server.d.ts +0 -56
  460. package/dist/src/server/server.js +0 -62
  461. package/dist/src/server/server.js.map +0 -1
  462. package/dist/src/server/templateHelper.js +0 -29
  463. package/dist/src/server/templateHelper.js.map +0 -1
  464. package/dist/src/server/templates/development.hbs +0 -12
  465. package/dist/src/server/templates/production.hbs +0 -6
  466. package/dist/src/server/widgetsDevServer.d.ts +0 -12
  467. package/dist/src/server/widgetsDevServer.js +0 -39
  468. package/dist/src/server/widgetsDevServer.js.map +0 -1
  469. package/dist/src/test/utils.d.ts +0 -89
  470. package/dist/src/test/utils.js.map +0 -1
  471. package/dist/src/test/widget.test.js +0 -89
  472. package/dist/src/test/widget.test.js.map +0 -1
  473. package/dist/src/web/create-store.d.ts +0 -3
  474. package/dist/src/web/create-store.js +0 -25
  475. package/dist/src/web/create-store.js.map +0 -1
  476. package/dist/src/web/create-store.test.js +0 -70
  477. package/dist/src/web/create-store.test.js.map +0 -1
  478. package/dist/src/web/data-llm.d.ts +0 -14
  479. package/dist/src/web/data-llm.js.map +0 -1
  480. package/dist/src/web/data-llm.test.js +0 -76
  481. package/dist/src/web/data-llm.test.js.map +0 -1
  482. package/dist/src/web/generate-helpers.js.map +0 -1
  483. package/dist/src/web/generate-helpers.test-d.js.map +0 -1
  484. package/dist/src/web/generate-helpers.test.js.map +0 -1
  485. package/dist/src/web/helpers/state.js +0 -40
  486. package/dist/src/web/helpers/state.js.map +0 -1
  487. package/dist/src/web/helpers/state.test.js.map +0 -1
  488. package/dist/src/web/hooks/index.d.ts +0 -12
  489. package/dist/src/web/hooks/index.js +0 -13
  490. package/dist/src/web/hooks/index.js.map +0 -1
  491. package/dist/src/web/hooks/use-call-tool.js +0 -60
  492. package/dist/src/web/hooks/use-call-tool.js.map +0 -1
  493. package/dist/src/web/hooks/use-call-tool.test-d.js.map +0 -1
  494. package/dist/src/web/hooks/use-call-tool.test.js.map +0 -1
  495. package/dist/src/web/hooks/use-display-mode.d.ts +0 -4
  496. package/dist/src/web/hooks/use-display-mode.js +0 -7
  497. package/dist/src/web/hooks/use-display-mode.js.map +0 -1
  498. package/dist/src/web/hooks/use-display-mode.test.js +0 -40
  499. package/dist/src/web/hooks/use-display-mode.test.js.map +0 -1
  500. package/dist/src/web/hooks/use-files.d.ts +0 -10
  501. package/dist/src/web/hooks/use-files.js +0 -7
  502. package/dist/src/web/hooks/use-files.js.map +0 -1
  503. package/dist/src/web/hooks/use-files.test.js +0 -29
  504. package/dist/src/web/hooks/use-files.test.js.map +0 -1
  505. package/dist/src/web/hooks/use-locale.d.ts +0 -1
  506. package/dist/src/web/hooks/use-locale.js +0 -5
  507. package/dist/src/web/hooks/use-locale.js.map +0 -1
  508. package/dist/src/web/hooks/use-locale.test.js +0 -21
  509. package/dist/src/web/hooks/use-locale.test.js.map +0 -1
  510. package/dist/src/web/hooks/use-open-external.d.ts +0 -1
  511. package/dist/src/web/hooks/use-open-external.js +0 -6
  512. package/dist/src/web/hooks/use-open-external.js.map +0 -1
  513. package/dist/src/web/hooks/use-open-external.test.js +0 -24
  514. package/dist/src/web/hooks/use-open-external.test.js.map +0 -1
  515. package/dist/src/web/hooks/use-openai-global.d.ts +0 -2
  516. package/dist/src/web/hooks/use-openai-global.js +0 -23
  517. package/dist/src/web/hooks/use-openai-global.js.map +0 -1
  518. package/dist/src/web/hooks/use-request-modal.d.ts +0 -6
  519. package/dist/src/web/hooks/use-request-modal.js +0 -9
  520. package/dist/src/web/hooks/use-request-modal.js.map +0 -1
  521. package/dist/src/web/hooks/use-request-modal.test.js +0 -24
  522. package/dist/src/web/hooks/use-request-modal.test.js.map +0 -1
  523. package/dist/src/web/hooks/use-send-follow-up-message.d.ts +0 -1
  524. package/dist/src/web/hooks/use-send-follow-up-message.js +0 -11
  525. package/dist/src/web/hooks/use-send-follow-up-message.js.map +0 -1
  526. package/dist/src/web/hooks/use-theme.d.ts +0 -1
  527. package/dist/src/web/hooks/use-theme.js +0 -5
  528. package/dist/src/web/hooks/use-theme.js.map +0 -1
  529. package/dist/src/web/hooks/use-theme.test.js +0 -26
  530. package/dist/src/web/hooks/use-theme.test.js.map +0 -1
  531. package/dist/src/web/hooks/use-tool-info.d.ts +0 -25
  532. package/dist/src/web/hooks/use-tool-info.js +0 -22
  533. package/dist/src/web/hooks/use-tool-info.js.map +0 -1
  534. package/dist/src/web/hooks/use-tool-info.test-d.js.map +0 -1
  535. package/dist/src/web/hooks/use-tool-info.test.js +0 -59
  536. package/dist/src/web/hooks/use-tool-info.test.js.map +0 -1
  537. package/dist/src/web/hooks/use-user-agent.d.ts +0 -1
  538. package/dist/src/web/hooks/use-user-agent.js +0 -5
  539. package/dist/src/web/hooks/use-user-agent.js.map +0 -1
  540. package/dist/src/web/hooks/use-user-agent.test.js +0 -31
  541. package/dist/src/web/hooks/use-user-agent.test.js.map +0 -1
  542. package/dist/src/web/hooks/use-widget-state.d.ts +0 -4
  543. package/dist/src/web/hooks/use-widget-state.js +0 -32
  544. package/dist/src/web/hooks/use-widget-state.js.map +0 -1
  545. package/dist/src/web/hooks/use-widget-state.test.js +0 -60
  546. package/dist/src/web/hooks/use-widget-state.test.js.map +0 -1
  547. package/dist/src/web/index.js.map +0 -1
  548. package/dist/src/web/mount-widget.d.ts +0 -1
  549. package/dist/src/web/mount-widget.js +0 -48
  550. package/dist/src/web/mount-widget.js.map +0 -1
  551. package/dist/src/web/plugin/data-llm.test.js.map +0 -1
  552. package/dist/src/web/plugin/plugin.d.ts +0 -2
  553. package/dist/src/web/plugin/plugin.js +0 -33
  554. package/dist/src/web/plugin/plugin.js.map +0 -1
  555. package/dist/src/web/plugin/transform-data-llm.js.map +0 -1
  556. package/dist/src/web/plugin/transform-data-llm.test.js.map +0 -1
  557. package/dist/src/web/proxy.js.map +0 -1
  558. package/dist/src/web/types.d.ts +0 -133
  559. package/dist/src/web/types.js.map +0 -1
  560. package/dist/vitest.config.d.ts +0 -2
  561. package/dist/vitest.config.js +0 -8
  562. package/dist/vitest.config.js.map +0 -1
  563. /package/dist/{src/test/widget.test.d.ts → cli/build-helpers.test.d.ts} +0 -0
  564. /package/dist/{src/web/create-store.test.d.ts → cli/build-steps.test.d.ts} +0 -0
  565. /package/dist/{src/web/data-llm.test.d.ts → cli/tunnel-control-server.test.d.ts} +0 -0
  566. /package/dist/{src/web/generate-helpers.test-d.d.ts → cli/tunnel-handler.test.d.ts} +0 -0
  567. /package/dist/{src/web/generate-helpers.test.d.ts → cli/tunnel.test.d.ts} +0 -0
  568. /package/dist/{src/web/helpers/state.test.d.ts → server/asset-base-url-transform-plugin.test.d.ts} +0 -0
  569. /package/dist/{src/web/hooks/use-call-tool.test-d.d.ts → server/auth/discovery.test.d.ts} +0 -0
  570. /package/dist/{src/server → server/auth}/index.js +0 -0
  571. /package/dist/{src/web/hooks/use-call-tool.test.d.ts → server/auth/providers/auth0.test.d.ts} +0 -0
  572. /package/dist/{src/web/hooks/use-display-mode.test.d.ts → server/auth/providers/clerk.test.d.ts} +0 -0
  573. /package/dist/{src/web/hooks/use-files.test.d.ts → server/auth/providers/custom.test.d.ts} +0 -0
  574. /package/dist/{src/web/hooks/use-locale.test.d.ts → server/auth/providers/descope.test.d.ts} +0 -0
  575. /package/dist/{src/web/hooks/use-open-external.test.d.ts → server/auth/providers/shared.test.d.ts} +0 -0
  576. /package/dist/{src/web/hooks/use-request-modal.test.d.ts → server/auth/security-schemes.test.d.ts} +0 -0
  577. /package/dist/{src/web/hooks/use-theme.test.d.ts → server/auth/setup.test.d.ts} +0 -0
  578. /package/dist/{src/web/hooks/use-tool-info.test-d.d.ts → server/auth/verify.test.d.ts} +0 -0
  579. /package/dist/{src/web/hooks/use-tool-info.test.d.ts → server/build-manifest.test.d.ts} +0 -0
  580. /package/dist/{src/web/hooks/use-user-agent.test.d.ts → server/content-helpers.test.d.ts} +0 -0
  581. /package/dist/{src/web/hooks/use-widget-state.test.d.ts → server/express.test.d.ts} +0 -0
  582. /package/dist/{src/web/plugin/data-llm.test.d.ts → server/host.test.d.ts} +0 -0
  583. /package/dist/{src/server → server}/inferUtilityTypes.js +0 -0
  584. /package/dist/{src/web/plugin/transform-data-llm.test.d.ts → server/middleware.test-d.d.ts} +0 -0
  585. /package/dist/{src/web → web}/generate-helpers.test.js +0 -0
  586. /package/dist/{src/web → web}/hooks/use-call-tool.test-d.js +0 -0
  587. /package/dist/{src/web → web}/plugin/data-llm.test.js +0 -0
  588. /package/dist/{src/web → web}/plugin/transform-data-llm.d.ts +0 -0
  589. /package/dist/{src/web → web}/plugin/transform-data-llm.test.js +0 -0
  590. /package/dist/{src/web → web}/proxy.d.ts +0 -0
@@ -1,16 +1,20 @@
1
1
  import { expectTypeOf, test } from "vitest";
2
- import { createTestServer } from "../test/utils.js";
2
+ import { createInterfaceTestServer, createTestServer } from "../test/utils.js";
3
3
  import { generateHelpers } from "./generate-helpers.js";
4
4
  const server = createTestServer();
5
- test("InferTools extracts the tool registry type (widgets + registerTool)", () => {
6
- expectTypeOf().toHaveProperty("search-voyage");
5
+ const interfaceServer = createInterfaceTestServer();
6
+ test("InferTools extracts the tool registry type (views + registerTool)", () => {
7
+ expectTypeOf().toHaveProperty("search-trip");
7
8
  expectTypeOf().toHaveProperty("get-trip-details");
8
- expectTypeOf().toHaveProperty("no-input-widget");
9
+ expectTypeOf().toHaveProperty("no-input-view");
9
10
  expectTypeOf().toHaveProperty("calculate-price");
10
- expectTypeOf().toHaveProperty("inferred-output-widget");
11
+ expectTypeOf().toHaveProperty("inferred-output-view");
11
12
  expectTypeOf().toHaveProperty("inferred-tool");
13
+ expectTypeOf().toHaveProperty("view-with-metadata");
14
+ expectTypeOf().toHaveProperty("tool-with-metadata");
15
+ expectTypeOf().toHaveProperty("view-with-mixed-returns");
12
16
  });
13
- test("ToolNames returns a union of tool name literals (widgets + registerTool)", () => {
17
+ test("ToolNames returns a union of tool name literals (views + registerTool)", () => {
14
18
  expectTypeOf().toEqualTypeOf();
15
19
  });
16
20
  test("ToolInput extracts the correct input type from Zod schema", () => {
@@ -28,20 +32,23 @@ test("ToolOutput extracts the correct output type from callback (inferred)", ()
28
32
  expectTypeOf().toEqualTypeOf();
29
33
  expectTypeOf().toEqualTypeOf();
30
34
  });
31
- test("generateHelpers provides autocomplete for tool names (widgets + registerTool)", () => {
35
+ test("generateHelpers provides autocomplete for tool names (views + registerTool)", () => {
32
36
  const { useCallTool } = generateHelpers();
33
- useCallTool("search-voyage");
37
+ useCallTool("search-trip");
34
38
  useCallTool("get-trip-details");
35
- useCallTool("no-input-widget");
39
+ useCallTool("no-input-view");
36
40
  useCallTool("calculate-price");
37
- useCallTool("inferred-output-widget");
41
+ useCallTool("inferred-output-view");
38
42
  useCallTool("inferred-tool");
43
+ useCallTool("view-with-metadata");
44
+ useCallTool("tool-with-metadata");
45
+ useCallTool("view-with-mixed-returns");
39
46
  // @ts-expect-error - "invalid-name" is not a valid tool name
40
47
  useCallTool("invalid-name");
41
48
  });
42
49
  test("useCallTool returns correctly typed callTool function", () => {
43
50
  const { useCallTool } = generateHelpers();
44
- const { callTool } = useCallTool("search-voyage");
51
+ const { callTool } = useCallTool("search-trip");
45
52
  callTool({ destination: "Spain" });
46
53
  callTool({ destination: "France", departureDate: "2024-06-01" });
47
54
  callTool({ destination: "Italy", maxPrice: 1000 });
@@ -50,7 +57,7 @@ test("useCallTool returns correctly typed callTool function", () => {
50
57
  });
51
58
  test("callTool can be called without args for tools with no required inputs", () => {
52
59
  const { useCallTool } = generateHelpers();
53
- const { callTool, callToolAsync } = useCallTool("no-input-widget");
60
+ const { callTool, callToolAsync } = useCallTool("no-input-view");
54
61
  callTool();
55
62
  callTool({});
56
63
  callToolAsync();
@@ -58,7 +65,7 @@ test("callTool can be called without args for tools with no required inputs", ()
58
65
  });
59
66
  test("callTool requires args for tools with required inputs", () => {
60
67
  const { useCallTool } = generateHelpers();
61
- const { callTool } = useCallTool("search-voyage");
68
+ const { callTool } = useCallTool("search-trip");
62
69
  // @ts-expect-error - "destination" is required
63
70
  callTool();
64
71
  // @ts-expect-error - "destination" is required
@@ -68,7 +75,7 @@ test("callTool requires args for tools with required inputs", () => {
68
75
  });
69
76
  test("callTool supports sideEffects for tools with required inputs", () => {
70
77
  const { useCallTool } = generateHelpers();
71
- const { callTool } = useCallTool("search-voyage");
78
+ const { callTool } = useCallTool("search-trip");
72
79
  callTool({ destination: "Spain" }, {
73
80
  onSuccess: (response, args) => {
74
81
  expectTypeOf(response.structuredContent.results).toBeArray();
@@ -89,7 +96,7 @@ test("callTool supports sideEffects for tools with required inputs", () => {
89
96
  });
90
97
  test("callTool supports sideEffects for tools with no required inputs", () => {
91
98
  const { useCallTool } = generateHelpers();
92
- const { callTool } = useCallTool("no-input-widget");
99
+ const { callTool } = useCallTool("no-input-view");
93
100
  callTool({
94
101
  onSuccess: (response) => {
95
102
  expectTypeOf(response).toHaveProperty("structuredContent");
@@ -103,16 +110,16 @@ test("callTool supports sideEffects for tools with no required inputs", () => {
103
110
  });
104
111
  test("callToolAsync returns correctly typed promise", () => {
105
112
  const { useCallTool } = generateHelpers();
106
- const { callToolAsync: searchAsync } = useCallTool("search-voyage");
113
+ const { callToolAsync: searchAsync } = useCallTool("search-trip");
107
114
  const searchPromise = searchAsync({ destination: "Spain" });
108
115
  expectTypeOf(searchPromise).resolves.toHaveProperty("structuredContent");
109
- const { callToolAsync: noInputAsync } = useCallTool("no-input-widget");
116
+ const { callToolAsync: noInputAsync } = useCallTool("no-input-view");
110
117
  const noInputPromise = noInputAsync();
111
118
  expectTypeOf(noInputPromise).resolves.toHaveProperty("structuredContent");
112
119
  });
113
120
  test("useCallTool returns correctly typed data", () => {
114
121
  const { useCallTool } = generateHelpers();
115
- const { data } = useCallTool("search-voyage");
122
+ const { data } = useCallTool("search-trip");
116
123
  if (data) {
117
124
  expectTypeOf(data.structuredContent).toExtend();
118
125
  expectTypeOf(data.structuredContent.results).toBeArray();
@@ -121,16 +128,16 @@ test("useCallTool returns correctly typed data", () => {
121
128
  });
122
129
  test("useCallTool returns correctly typed data for callback-inferred outputs", () => {
123
130
  const { useCallTool } = generateHelpers();
124
- const { data: widgetData } = useCallTool("inferred-output-widget");
125
- if (widgetData) {
126
- expectTypeOf(widgetData.structuredContent).toExtend();
131
+ const { data: viewData } = useCallTool("inferred-output-view");
132
+ if (viewData) {
133
+ expectTypeOf(viewData.structuredContent).toExtend();
127
134
  }
128
135
  const { data: toolData } = useCallTool("inferred-tool");
129
136
  if (toolData) {
130
137
  expectTypeOf(toolData.structuredContent).toExtend();
131
138
  }
132
139
  });
133
- test("generateHelpers provides autocomplete for tool names in useToolInfo (widgets + registerTool)", () => {
140
+ test("generateHelpers provides autocomplete for tool names in useToolInfo (views + registerTool)", () => {
134
141
  const { useToolInfo } = generateHelpers();
135
142
  useToolInfo();
136
143
  useToolInfo();
@@ -138,17 +145,67 @@ test("generateHelpers provides autocomplete for tool names in useToolInfo (widge
138
145
  useToolInfo();
139
146
  useToolInfo();
140
147
  useToolInfo();
148
+ useToolInfo();
149
+ useToolInfo();
150
+ useToolInfo();
141
151
  // @ts-expect-error - "invalid-name" is not a valid tool name
142
152
  useToolInfo();
143
153
  });
144
154
  test("useToolInfo infers input and output types", () => {
145
155
  const { useToolInfo } = generateHelpers();
146
156
  const toolInfo = useToolInfo();
147
- expectTypeOf(toolInfo.input).toExtend();
157
+ // Input is optional in pending — host may not have delivered args yet
158
+ if (toolInfo.status === "pending") {
159
+ expectTypeOf(toolInfo.input).toExtend();
160
+ }
148
161
  if (toolInfo.status === "success") {
162
+ // Input is optional in success — the host may not have surfaced args yet
163
+ expectTypeOf(toolInfo.input).toExtend();
149
164
  expectTypeOf(toolInfo.output).toExtend();
150
165
  expectTypeOf(toolInfo.output.results).toBeArray();
151
166
  expectTypeOf(toolInfo.output.totalCount).toBeNumber();
152
167
  }
153
168
  });
169
+ test("ToolResponseMetadata extracts _meta type from callback", () => {
170
+ expectTypeOf().toEqualTypeOf();
171
+ expectTypeOf().toEqualTypeOf();
172
+ expectTypeOf().toBeUnknown();
173
+ });
174
+ test("useToolInfo infers responseMetadata type from generateHelpers", () => {
175
+ const { useToolInfo } = generateHelpers();
176
+ const toolInfo = useToolInfo();
177
+ if (toolInfo.isSuccess) {
178
+ expectTypeOf(toolInfo.responseMetadata.requestId).toBeString();
179
+ expectTypeOf(toolInfo.responseMetadata.timestamp).toBeNumber();
180
+ expectTypeOf(toolInfo.responseMetadata.cached).toBeBoolean();
181
+ }
182
+ });
183
+ test("ToolResponseMetadata extracts _meta from mixed return paths", () => {
184
+ expectTypeOf().toEqualTypeOf();
185
+ });
186
+ test("ToolOutput extracts correct type when using interface declaration", () => {
187
+ expectTypeOf().toHaveProperty("itemName");
188
+ expectTypeOf().toBeString();
189
+ expectTypeOf().toBeNumber();
190
+ });
191
+ test("ToolResponseMetadata extracts correct type when using interface declaration", () => {
192
+ expectTypeOf().toHaveProperty("processedBy");
193
+ expectTypeOf().toBeString();
194
+ expectTypeOf().toBeNumber();
195
+ });
196
+ test("generateHelpers works with interface-typed server", () => {
197
+ const { useCallTool, useToolInfo } = generateHelpers();
198
+ const { data } = useCallTool("interface-view");
199
+ if (data) {
200
+ expectTypeOf(data.structuredContent.itemName).toBeString();
201
+ expectTypeOf(data.structuredContent.quantity).toBeNumber();
202
+ }
203
+ const toolInfo = useToolInfo();
204
+ if (toolInfo.isSuccess) {
205
+ expectTypeOf(toolInfo.output.itemName).toBeString();
206
+ expectTypeOf(toolInfo.output.quantity).toBeNumber();
207
+ expectTypeOf(toolInfo.responseMetadata.processedBy).toBeString();
208
+ expectTypeOf(toolInfo.responseMetadata.version).toBeNumber();
209
+ }
210
+ });
154
211
  //# sourceMappingURL=generate-helpers.test-d.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generate-helpers.test-d.js","sourceRoot":"","sources":["../../src/web/generate-helpers.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAQ5C,OAAO,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;AAGlC,MAAM,eAAe,GAAG,yBAAyB,EAAE,CAAC;AAGpD,IAAI,CAAC,mEAAmE,EAAE,GAAG,EAAE;IAG7E,YAAY,EAAS,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IACpD,YAAY,EAAS,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IACzD,YAAY,EAAS,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACtD,YAAY,EAAS,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;IACxD,YAAY,EAAS,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC;IAC7D,YAAY,EAAS,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACtD,YAAY,EAAS,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAC3D,YAAY,EAAS,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAC3D,YAAY,EAAS,CAAC,cAAc,CAAC,yBAAyB,CAAC,CAAC;AAClE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wEAAwE,EAAE,GAAG,EAAE;IAGlF,YAAY,EAAS,CAAC,aAAa,EAUhC,CAAC;AACN,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;IAGrE,YAAY,EAAe,CAAC,aAAa,EAIrC,CAAC;IAIL,YAAY,EAAgB,CAAC,aAAa,EAEtC,CAAC;IAIL,YAAY,EAAkB,CAAC,aAAa,EAGxC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+EAA+E,EAAE,GAAG,EAAE;IAGzF,YAAY,EAAgB,CAAC,aAAa,EAOtC,CAAC;IAIL,YAAY,EAAiB,CAAC,aAAa,EAIvC,CAAC;IAML,YAAY,EAAmB,CAAC,aAAa,EAGzC,CAAC;IAGL,YAAY,EAAiB,CAAC,aAAa,EAA0B,CAAC;AACxE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,sEAAsE,EAAE,GAAG,EAAE;IAGhF,YAAY,EAAsB,CAAC,aAAa,EAG5C,CAAC;IAIL,YAAY,EAAsB,CAAC,aAAa,EAG5C,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6EAA6E,EAAE,GAAG,EAAE;IACvF,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,WAAW,CAAC,aAAa,CAAC,CAAC;IAC3B,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAChC,WAAW,CAAC,eAAe,CAAC,CAAC;IAC7B,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC/B,WAAW,CAAC,sBAAsB,CAAC,CAAC;IACpC,WAAW,CAAC,eAAe,CAAC,CAAC;IAC7B,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAClC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAClC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IAEvC,6DAA6D;IAC7D,WAAW,CAAC,cAAc,CAAC,CAAC;AAC9B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;IACjE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAEhD,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IACnC,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC,CAAC;IACjE,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAEnD,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAC;IACnE,aAAa,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;AAClD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uEAAuE,EAAE,GAAG,EAAE;IACjF,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAEjE,QAAQ,EAAE,CAAC;IAEX,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEb,aAAa,EAAE,CAAC;IAChB,aAAa,CAAC,EAAE,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;IACjE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAEhD,+CAA+C;IAC/C,QAAQ,EAAE,CAAC;IAEX,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEb,mBAAmB;IACnB,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;AACrC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;IACxE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAEhD,QAAQ,CACN,EAAE,WAAW,EAAE,OAAO,EAAE,EACxB;QACE,SAAS,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;YAC5B,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;YAC7D,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;QACD,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACvB,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;QACD,SAAS,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACnC,IAAI,QAAQ,EAAE,CAAC;gBACb,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;YACnE,CAAC;YACD,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;KACF,CACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;IAC3E,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAElD,QAAQ,CAAC;QACP,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE;YACtB,YAAY,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QAC7D,CAAC;KACF,CAAC,CAAC;IAEH,QAAQ,CACN,EAAE,EACF;QACE,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE;YACtB,YAAY,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QAC7D,CAAC;KACF,CACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;IACzD,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAClE,MAAM,aAAa,GAAG,WAAW,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5D,YAAY,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;IAEzE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IACrE,MAAM,cAAc,GAAG,YAAY,EAAE,CAAC;IACtC,YAAY,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;AAC5E,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;IACpD,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAE5C,IAAI,IAAI,EAAE,CAAC;QACT,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAOzC,CAAC;QAEL,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;QACzD,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wEAAwE,EAAE,GAAG,EAAE;IAClF,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAC/D,IAAI,QAAQ,EAAE,CAAC;QACb,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAG7C,CAAC;IACP,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IACxD,IAAI,QAAQ,EAAE,CAAC;QACb,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAG7C,CAAC;IACP,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,4FAA4F,EAAE,GAAG,EAAE;IACtG,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,WAAW,EAAiB,CAAC;IAC7B,WAAW,EAAsB,CAAC;IAClC,WAAW,EAAmB,CAAC;IAC/B,WAAW,EAAqB,CAAC;IACjC,WAAW,EAA0B,CAAC;IACtC,WAAW,EAAmB,CAAC;IAC/B,WAAW,EAAwB,CAAC;IACpC,WAAW,EAAwB,CAAC;IACpC,WAAW,EAA6B,CAAC;IAEzC,6DAA6D;IAC7D,WAAW,EAAkB,CAAC;AAChC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;IACrD,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,QAAQ,GAAG,WAAW,EAAiB,CAAC;IAE9C,sEAAsE;IACtE,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAClC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,EAElC,CAAC;IACN,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAClC,yEAAyE;QACzE,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,EAElC,CAAC;QACJ,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,EAEnC,CAAC;QACJ,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;QAClD,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;IACxD,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wDAAwD,EAAE,GAAG,EAAE;IAElE,YAAY,EAAY,CAAC,aAAa,EAIlC,CAAC;IAGL,YAAY,EAAY,CAAC,aAAa,EAGlC,CAAC;IAGL,YAAY,EAAc,CAAC,WAAW,EAAE,CAAC;AAC3C,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;IACzE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,QAAQ,GAAG,WAAW,EAAwB,CAAC;IAErD,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC;QAC/D,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC;QAC/D,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6DAA6D,EAAE,GAAG,EAAE;IAIvE,YAAY,EAAa,CAAC,aAAa,EAGnC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mEAAmE,EAAE,GAAG,EAAE;IAG7E,YAAY,EAAuB,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAC/D,YAAY,EAAmC,CAAC,UAAU,EAAE,CAAC;IAC7D,YAAY,EAAmC,CAAC,UAAU,EAAE,CAAC;AAC/D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6EAA6E,EAAE,GAAG,EAAE;IAMvF,YAAY,EAAqB,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAChE,YAAY,EAAoC,CAAC,UAAU,EAAE,CAAC;IAC9D,YAAY,EAAgC,CAAC,UAAU,EAAE,CAAC;AAC5D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;IAC7D,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,eAAe,EAAuB,CAAC;IAE5E,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAC/C,IAAI,IAAI,EAAE,CAAC;QACT,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;QAC3D,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;IAC7D,CAAC;IAED,MAAM,QAAQ,GAAG,WAAW,EAAoB,CAAC;IACjD,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;QACpD,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;QACpD,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QACjE,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC,CAAC","sourcesContent":["import { expectTypeOf, test } from \"vitest\";\nimport type {\n InferTools,\n ToolInput,\n ToolNames,\n ToolOutput,\n ToolResponseMetadata,\n} from \"../server/index.js\";\nimport { createInterfaceTestServer, createTestServer } from \"../test/utils.js\";\nimport { generateHelpers } from \"./generate-helpers.js\";\n\nconst server = createTestServer();\ntype TestServer = typeof server;\n\nconst interfaceServer = createInterfaceTestServer();\ntype InterfaceTestServer = typeof interfaceServer;\n\ntest(\"InferTools extracts the tool registry type (views + registerTool)\", () => {\n type Tools = InferTools<TestServer>;\n\n expectTypeOf<Tools>().toHaveProperty(\"search-trip\");\n expectTypeOf<Tools>().toHaveProperty(\"get-trip-details\");\n expectTypeOf<Tools>().toHaveProperty(\"no-input-view\");\n expectTypeOf<Tools>().toHaveProperty(\"calculate-price\");\n expectTypeOf<Tools>().toHaveProperty(\"inferred-output-view\");\n expectTypeOf<Tools>().toHaveProperty(\"inferred-tool\");\n expectTypeOf<Tools>().toHaveProperty(\"view-with-metadata\");\n expectTypeOf<Tools>().toHaveProperty(\"tool-with-metadata\");\n expectTypeOf<Tools>().toHaveProperty(\"view-with-mixed-returns\");\n});\n\ntest(\"ToolNames returns a union of tool name literals (views + registerTool)\", () => {\n type Names = ToolNames<TestServer>;\n\n expectTypeOf<Names>().toEqualTypeOf<\n | \"search-trip\"\n | \"get-trip-details\"\n | \"no-input-view\"\n | \"calculate-price\"\n | \"inferred-output-view\"\n | \"inferred-tool\"\n | \"view-with-metadata\"\n | \"tool-with-metadata\"\n | \"view-with-mixed-returns\"\n >();\n});\n\ntest(\"ToolInput extracts the correct input type from Zod schema\", () => {\n type SearchInput = ToolInput<TestServer, \"search-trip\">;\n\n expectTypeOf<SearchInput>().toEqualTypeOf<{\n destination: string;\n departureDate?: string | undefined;\n maxPrice?: number | undefined;\n }>();\n\n type DetailsInput = ToolInput<TestServer, \"get-trip-details\">;\n\n expectTypeOf<DetailsInput>().toEqualTypeOf<{\n tripId: string;\n }>();\n\n type CalculateInput = ToolInput<TestServer, \"calculate-price\">;\n\n expectTypeOf<CalculateInput>().toEqualTypeOf<{\n tripId: string;\n passengers: number;\n }>();\n});\n\ntest(\"ToolOutput extracts the correct output type from callback's structuredContent\", () => {\n type SearchOutput = ToolOutput<TestServer, \"search-trip\">;\n\n expectTypeOf<SearchOutput>().toEqualTypeOf<{\n results: Array<{\n id: string;\n name: string;\n price: number;\n }>;\n totalCount: number;\n }>();\n\n type DetailsOutput = ToolOutput<TestServer, \"get-trip-details\">;\n\n expectTypeOf<DetailsOutput>().toEqualTypeOf<{\n name: string;\n description: string;\n images: string[];\n }>();\n\n // Note: outputSchema has totalPrice: z.string(), but callback returns number\n // Type is inferred from callback, so totalPrice is number\n type CalculateOutput = ToolOutput<TestServer, \"calculate-price\">;\n\n expectTypeOf<CalculateOutput>().toEqualTypeOf<{\n totalPrice: number;\n currency: string;\n }>();\n\n type NoInputOutput = ToolOutput<TestServer, \"no-input-view\">;\n expectTypeOf<NoInputOutput>().toEqualTypeOf<Record<never, unknown>>();\n});\n\ntest(\"ToolOutput extracts the correct output type from callback (inferred)\", () => {\n type InferredViewOutput = ToolOutput<TestServer, \"inferred-output-view\">;\n\n expectTypeOf<InferredViewOutput>().toEqualTypeOf<{\n inferredResults: { id: string; score: number }[];\n inferredCount: number;\n }>();\n\n type InferredToolOutput = ToolOutput<TestServer, \"inferred-tool\">;\n\n expectTypeOf<InferredToolOutput>().toEqualTypeOf<{\n itemDetails: { name: string; available: boolean };\n fetchedAt: string;\n }>();\n});\n\ntest(\"generateHelpers provides autocomplete for tool names (views + registerTool)\", () => {\n const { useCallTool } = generateHelpers<TestServer>();\n\n useCallTool(\"search-trip\");\n useCallTool(\"get-trip-details\");\n useCallTool(\"no-input-view\");\n useCallTool(\"calculate-price\");\n useCallTool(\"inferred-output-view\");\n useCallTool(\"inferred-tool\");\n useCallTool(\"view-with-metadata\");\n useCallTool(\"tool-with-metadata\");\n useCallTool(\"view-with-mixed-returns\");\n\n // @ts-expect-error - \"invalid-name\" is not a valid tool name\n useCallTool(\"invalid-name\");\n});\n\ntest(\"useCallTool returns correctly typed callTool function\", () => {\n const { useCallTool } = generateHelpers<TestServer>();\n const { callTool } = useCallTool(\"search-trip\");\n\n callTool({ destination: \"Spain\" });\n callTool({ destination: \"France\", departureDate: \"2024-06-01\" });\n callTool({ destination: \"Italy\", maxPrice: 1000 });\n\n const { callTool: calculateTool } = useCallTool(\"calculate-price\");\n calculateTool({ tripId: \"123\", passengers: 2 });\n});\n\ntest(\"callTool can be called without args for tools with no required inputs\", () => {\n const { useCallTool } = generateHelpers<TestServer>();\n const { callTool, callToolAsync } = useCallTool(\"no-input-view\");\n\n callTool();\n\n callTool({});\n\n callToolAsync();\n callToolAsync({});\n});\n\ntest(\"callTool requires args for tools with required inputs\", () => {\n const { useCallTool } = generateHelpers<TestServer>();\n const { callTool } = useCallTool(\"search-trip\");\n\n // @ts-expect-error - \"destination\" is required\n callTool();\n\n // @ts-expect-error - \"destination\" is required\n callTool({});\n\n // This should work\n callTool({ destination: \"Spain\" });\n});\n\ntest(\"callTool supports sideEffects for tools with required inputs\", () => {\n const { useCallTool } = generateHelpers<TestServer>();\n const { callTool } = useCallTool(\"search-trip\");\n\n callTool(\n { destination: \"Spain\" },\n {\n onSuccess: (response, args) => {\n expectTypeOf(response.structuredContent.results).toBeArray();\n expectTypeOf(args.destination).toBeString();\n },\n onError: (error, args) => {\n expectTypeOf(error).toBeUnknown();\n expectTypeOf(args.destination).toBeString();\n },\n onSettled: (response, error, args) => {\n if (response) {\n expectTypeOf(response.structuredContent.totalCount).toBeNumber();\n }\n expectTypeOf(error).toBeUnknown();\n expectTypeOf(args.destination).toBeString();\n },\n },\n );\n});\n\ntest(\"callTool supports sideEffects for tools with no required inputs\", () => {\n const { useCallTool } = generateHelpers<TestServer>();\n const { callTool } = useCallTool(\"no-input-view\");\n\n callTool({\n onSuccess: (response) => {\n expectTypeOf(response).toHaveProperty(\"structuredContent\");\n },\n });\n\n callTool(\n {},\n {\n onSuccess: (response) => {\n expectTypeOf(response).toHaveProperty(\"structuredContent\");\n },\n },\n );\n});\n\ntest(\"callToolAsync returns correctly typed promise\", () => {\n const { useCallTool } = generateHelpers<TestServer>();\n\n const { callToolAsync: searchAsync } = useCallTool(\"search-trip\");\n const searchPromise = searchAsync({ destination: \"Spain\" });\n expectTypeOf(searchPromise).resolves.toHaveProperty(\"structuredContent\");\n\n const { callToolAsync: noInputAsync } = useCallTool(\"no-input-view\");\n const noInputPromise = noInputAsync();\n expectTypeOf(noInputPromise).resolves.toHaveProperty(\"structuredContent\");\n});\n\ntest(\"useCallTool returns correctly typed data\", () => {\n const { useCallTool } = generateHelpers<TestServer>();\n const { data } = useCallTool(\"search-trip\");\n\n if (data) {\n expectTypeOf(data.structuredContent).toExtend<{\n results: Array<{\n id: string;\n name: string;\n price: number;\n }>;\n totalCount: number;\n }>();\n\n expectTypeOf(data.structuredContent.results).toBeArray();\n expectTypeOf(data.structuredContent.totalCount).toBeNumber();\n }\n});\n\ntest(\"useCallTool returns correctly typed data for callback-inferred outputs\", () => {\n const { useCallTool } = generateHelpers<TestServer>();\n\n const { data: viewData } = useCallTool(\"inferred-output-view\");\n if (viewData) {\n expectTypeOf(viewData.structuredContent).toExtend<{\n inferredResults: { id: string; score: number }[];\n inferredCount: number;\n }>();\n }\n\n const { data: toolData } = useCallTool(\"inferred-tool\");\n if (toolData) {\n expectTypeOf(toolData.structuredContent).toExtend<{\n itemDetails: { name: string; available: boolean };\n fetchedAt: string;\n }>();\n }\n});\n\ntest(\"generateHelpers provides autocomplete for tool names in useToolInfo (views + registerTool)\", () => {\n const { useToolInfo } = generateHelpers<TestServer>();\n\n useToolInfo<\"search-trip\">();\n useToolInfo<\"get-trip-details\">();\n useToolInfo<\"no-input-view\">();\n useToolInfo<\"calculate-price\">();\n useToolInfo<\"inferred-output-view\">();\n useToolInfo<\"inferred-tool\">();\n useToolInfo<\"view-with-metadata\">();\n useToolInfo<\"tool-with-metadata\">();\n useToolInfo<\"view-with-mixed-returns\">();\n\n // @ts-expect-error - \"invalid-name\" is not a valid tool name\n useToolInfo<\"invalid-name\">();\n});\n\ntest(\"useToolInfo infers input and output types\", () => {\n const { useToolInfo } = generateHelpers<TestServer>();\n const toolInfo = useToolInfo<\"search-trip\">();\n\n // Input is optional in pending — host may not have delivered args yet\n if (toolInfo.status === \"pending\") {\n expectTypeOf(toolInfo.input).toExtend<\n ToolInput<TestServer, \"search-trip\"> | undefined\n >();\n }\n\n if (toolInfo.status === \"success\") {\n // Input is optional in success — the host may not have surfaced args yet\n expectTypeOf(toolInfo.input).toExtend<\n ToolInput<TestServer, \"search-trip\"> | undefined\n >();\n expectTypeOf(toolInfo.output).toExtend<\n ToolOutput<TestServer, \"search-trip\">\n >();\n expectTypeOf(toolInfo.output.results).toBeArray();\n expectTypeOf(toolInfo.output.totalCount).toBeNumber();\n }\n});\n\ntest(\"ToolResponseMetadata extracts _meta type from callback\", () => {\n type ViewMeta = ToolResponseMetadata<TestServer, \"view-with-metadata\">;\n expectTypeOf<ViewMeta>().toEqualTypeOf<{\n requestId: string;\n timestamp: number;\n cached: boolean;\n }>();\n\n type ToolMeta = ToolResponseMetadata<TestServer, \"tool-with-metadata\">;\n expectTypeOf<ToolMeta>().toEqualTypeOf<{\n executionTime: number;\n source: string;\n }>();\n\n type SearchMeta = ToolResponseMetadata<TestServer, \"search-trip\">;\n expectTypeOf<SearchMeta>().toBeUnknown();\n});\n\ntest(\"useToolInfo infers responseMetadata type from generateHelpers\", () => {\n const { useToolInfo } = generateHelpers<TestServer>();\n const toolInfo = useToolInfo<\"view-with-metadata\">();\n\n if (toolInfo.isSuccess) {\n expectTypeOf(toolInfo.responseMetadata.requestId).toBeString();\n expectTypeOf(toolInfo.responseMetadata.timestamp).toBeNumber();\n expectTypeOf(toolInfo.responseMetadata.cached).toBeBoolean();\n }\n});\n\ntest(\"ToolResponseMetadata extracts _meta from mixed return paths\", () => {\n // View has multiple return paths: some with _meta, some without\n // ExtractMeta should still infer the _meta type from branches that have it\n type MixedMeta = ToolResponseMetadata<TestServer, \"view-with-mixed-returns\">;\n expectTypeOf<MixedMeta>().toEqualTypeOf<{\n processedAt: number;\n region: string;\n }>();\n});\n\ntest(\"ToolOutput extracts correct type when using interface declaration\", () => {\n type InterfaceViewOutput = ToolOutput<InterfaceTestServer, \"interface-view\">;\n\n expectTypeOf<InterfaceViewOutput>().toHaveProperty(\"itemName\");\n expectTypeOf<InterfaceViewOutput[\"itemName\"]>().toBeString();\n expectTypeOf<InterfaceViewOutput[\"quantity\"]>().toBeNumber();\n});\n\ntest(\"ToolResponseMetadata extracts correct type when using interface declaration\", () => {\n type InterfaceViewMeta = ToolResponseMetadata<\n InterfaceTestServer,\n \"interface-view\"\n >;\n\n expectTypeOf<InterfaceViewMeta>().toHaveProperty(\"processedBy\");\n expectTypeOf<InterfaceViewMeta[\"processedBy\"]>().toBeString();\n expectTypeOf<InterfaceViewMeta[\"version\"]>().toBeNumber();\n});\n\ntest(\"generateHelpers works with interface-typed server\", () => {\n const { useCallTool, useToolInfo } = generateHelpers<InterfaceTestServer>();\n\n const { data } = useCallTool(\"interface-view\");\n if (data) {\n expectTypeOf(data.structuredContent.itemName).toBeString();\n expectTypeOf(data.structuredContent.quantity).toBeNumber();\n }\n\n const toolInfo = useToolInfo<\"interface-view\">();\n if (toolInfo.isSuccess) {\n expectTypeOf(toolInfo.output.itemName).toBeString();\n expectTypeOf(toolInfo.output.quantity).toBeNumber();\n expectTypeOf(toolInfo.responseMetadata.processedBy).toBeString();\n expectTypeOf(toolInfo.responseMetadata.version).toBeNumber();\n }\n});\n"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generate-helpers.test.js","sourceRoot":"","sources":["../../src/web/generate-helpers.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,MAAM,GAAG,uBAAuB,EAAE,CAAC;AAGzC,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,KAAK,GAAG,eAAe,EAAc,CAAC;QAC5C,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5C,MAAM,CAAC,OAAO,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,KAAK,GAAG,eAAe,EAAc,CAAC;QAC5C,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5C,MAAM,CAAC,OAAO,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, it } from \"vitest\";\nimport { createMinimalTestServer } from \"../test/utils.js\";\nimport { generateHelpers } from \"./generate-helpers.js\";\n\nconst server = createMinimalTestServer();\ntype TestServer = typeof server;\n\ndescribe(\"generateHelpers\", () => {\n it(\"should return an object with useCallTool hook\", () => {\n const hooks = generateHelpers<TestServer>();\n expect(hooks).toHaveProperty(\"useCallTool\");\n expect(typeof hooks.useCallTool).toBe(\"function\");\n });\n\n it(\"should return an object with useToolInfo hook\", () => {\n const hooks = generateHelpers<TestServer>();\n expect(hooks).toHaveProperty(\"useToolInfo\");\n expect(typeof hooks.useToolInfo).toBe(\"function\");\n });\n});\n"]}
@@ -1,7 +1,7 @@
1
1
  import { type SuperJSONResult } from "superjson";
2
2
  import type { UnknownObject } from "../types.js";
3
- export declare function filterWidgetContext<T extends UnknownObject>(state?: T | null): T | null;
4
- export declare function injectWidgetContext<T extends UnknownObject>(newState: T | null): T | null;
3
+ export declare function filterViewContext<T extends UnknownObject>(state?: T | null): T | null;
4
+ export declare function injectViewContext<T extends UnknownObject>(newState: T | null): T | null;
5
5
  export declare function serializeState(value: UnknownObject): unknown;
6
6
  export declare function deserializeState(value: SuperJSONResult): unknown;
7
7
  export declare function getInitialState<State extends UnknownObject>(defaultState?: State | (() => State)): State | null;
@@ -0,0 +1,45 @@
1
+ import superjson, {} from "superjson";
2
+ import { getAdaptor } from "../bridges/index.js";
3
+ import { VIEW_CONTEXT_KEY } from "../data-llm.js";
4
+ export function filterViewContext(state) {
5
+ if (state === null || state === undefined) {
6
+ return null;
7
+ }
8
+ const { [VIEW_CONTEXT_KEY]: _, ...filteredState } = state;
9
+ return filteredState;
10
+ }
11
+ export function injectViewContext(newState) {
12
+ if (newState === null) {
13
+ return null;
14
+ }
15
+ const currentState = getAdaptor()
16
+ .getHostContextStore("viewState")
17
+ .getSnapshot();
18
+ if (currentState !== null &&
19
+ currentState !== undefined &&
20
+ VIEW_CONTEXT_KEY in currentState) {
21
+ return {
22
+ ...newState,
23
+ [VIEW_CONTEXT_KEY]: currentState[VIEW_CONTEXT_KEY],
24
+ };
25
+ }
26
+ return newState;
27
+ }
28
+ export function serializeState(value) {
29
+ return superjson.parse(superjson.stringify(value)); // Strips functions
30
+ }
31
+ export function deserializeState(value) {
32
+ return superjson.deserialize(value);
33
+ }
34
+ export function getInitialState(defaultState) {
35
+ const viewState = getAdaptor()
36
+ .getHostContextStore("viewState")
37
+ .getSnapshot();
38
+ if (viewState !== null && viewState !== undefined) {
39
+ return filterViewContext(viewState);
40
+ }
41
+ return typeof defaultState === "function"
42
+ ? defaultState()
43
+ : (defaultState ?? null);
44
+ }
45
+ //# sourceMappingURL=state.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"state.js","sourceRoot":"","sources":["../../../src/web/helpers/state.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,EAAE,EAAwB,MAAM,WAAW,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAGlD,MAAM,UAAU,iBAAiB,CAC/B,KAAgB;IAEhB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,EAAE,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE,GAAG,aAAa,EAAE,GAAG,KAEnD,CAAC;IAEF,OAAO,aAAkB,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,QAAkB;IAElB,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,YAAY,GAAG,UAAU,EAAE;SAC9B,mBAAmB,CAAC,WAAW,CAAC;SAChC,WAAW,EAAmD,CAAC;IAElE,IACE,YAAY,KAAK,IAAI;QACrB,YAAY,KAAK,SAAS;QAC1B,gBAAgB,IAAI,YAAY,EAChC,CAAC;QACD,OAAO;YACL,GAAG,QAAQ;YACX,CAAC,gBAAgB,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC;SAC9C,CAAC;IACT,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAoB;IACjD,OAAO,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,mBAAmB;AACzE,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAsB;IACrD,OAAO,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,YAAoC;IAEpC,MAAM,SAAS,GAAG,UAAU,EAAE;SAC3B,mBAAmB,CAAC,WAAW,CAAC;SAChC,WAAW,EAAkB,CAAC;IAEjC,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAClD,OAAO,iBAAiB,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,OAAO,YAAY,KAAK,UAAU;QACvC,CAAC,CAAC,YAAY,EAAE;QAChB,CAAC,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC;AAC7B,CAAC","sourcesContent":["import superjson, { type SuperJSONResult } from \"superjson\";\nimport { getAdaptor } from \"../bridges/index.js\";\nimport { VIEW_CONTEXT_KEY } from \"../data-llm.js\";\nimport type { UnknownObject } from \"../types.js\";\n\nexport function filterViewContext<T extends UnknownObject>(\n state?: T | null,\n): T | null {\n if (state === null || state === undefined) {\n return null;\n }\n\n const { [VIEW_CONTEXT_KEY]: _, ...filteredState } = state as T & {\n [VIEW_CONTEXT_KEY]?: unknown;\n };\n\n return filteredState as T;\n}\n\nexport function injectViewContext<T extends UnknownObject>(\n newState: T | null,\n): T | null {\n if (newState === null) {\n return null;\n }\n\n const currentState = getAdaptor()\n .getHostContextStore(\"viewState\")\n .getSnapshot() as (T & { [VIEW_CONTEXT_KEY]?: unknown }) | null;\n\n if (\n currentState !== null &&\n currentState !== undefined &&\n VIEW_CONTEXT_KEY in currentState\n ) {\n return {\n ...newState,\n [VIEW_CONTEXT_KEY]: currentState[VIEW_CONTEXT_KEY],\n } as T;\n }\n\n return newState;\n}\n\nexport function serializeState(value: UnknownObject) {\n return superjson.parse(superjson.stringify(value)); // Strips functions\n}\n\nexport function deserializeState(value: SuperJSONResult): unknown {\n return superjson.deserialize(value);\n}\n\nexport function getInitialState<State extends UnknownObject>(\n defaultState?: State | (() => State),\n): State | null {\n const viewState = getAdaptor()\n .getHostContextStore(\"viewState\")\n .getSnapshot() as State | null;\n\n if (viewState !== null && viewState !== undefined) {\n return filterViewContext(viewState);\n }\n\n return typeof defaultState === \"function\"\n ? defaultState()\n : (defaultState ?? null);\n}\n"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -1,29 +1,29 @@
1
1
  import { describe, expect, it } from "vitest";
2
- import { WIDGET_CONTEXT_KEY } from "../data-llm.js";
3
- import { filterWidgetContext, serializeState } from "./state.js";
2
+ import { VIEW_CONTEXT_KEY } from "../data-llm.js";
3
+ import { filterViewContext, serializeState } from "./state.js";
4
4
  describe("state helpers", () => {
5
- describe("filterWidgetContext", () => {
5
+ describe("filterViewContext", () => {
6
6
  it("should return null when state is null", () => {
7
- expect(filterWidgetContext(null)).toBe(null);
7
+ expect(filterViewContext(null)).toBe(null);
8
8
  });
9
9
  it("should return null when state is undefined", () => {
10
- expect(filterWidgetContext(undefined)).toBe(null);
10
+ expect(filterViewContext(undefined)).toBe(null);
11
11
  });
12
- it("should correctly filter WIDGET_CONTEXT_KEY and preserve other properties", () => {
12
+ it("should correctly filter VIEW_CONTEXT_KEY and preserve other properties", () => {
13
13
  const stateWithContextAndOthers = {
14
14
  a: 1,
15
15
  b: "two",
16
16
  c: { nested: true },
17
- [WIDGET_CONTEXT_KEY]: "context",
17
+ [VIEW_CONTEXT_KEY]: "context",
18
18
  };
19
- const filteredWithContextAndOthers = filterWidgetContext(stateWithContextAndOthers);
19
+ const filteredWithContextAndOthers = filterViewContext(stateWithContextAndOthers);
20
20
  expect(filteredWithContextAndOthers).toEqual({
21
21
  a: 1,
22
22
  b: "two",
23
23
  c: { nested: true },
24
24
  });
25
25
  const stateNoContext = { count: 5, name: "test" };
26
- const filteredNoContext = filterWidgetContext(stateNoContext);
26
+ const filteredNoContext = filterViewContext(stateNoContext);
27
27
  expect(filteredNoContext).toEqual(stateNoContext);
28
28
  });
29
29
  });
@@ -0,0 +1 @@
1
+ {"version":3,"file":"state.test.js","sourceRoot":"","sources":["../../../src/web/helpers/state.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE/D,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;YAChF,MAAM,yBAAyB,GAAG;gBAChC,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,KAAK;gBACR,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;gBACnB,CAAC,gBAAgB,CAAC,EAAE,SAAS;aAC9B,CAAC;YACF,MAAM,4BAA4B,GAAG,iBAAiB,CACpD,yBAAyB,CAC1B,CAAC;YACF,MAAM,CAAC,4BAA4B,CAAC,CAAC,OAAO,CAAC;gBAC3C,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,KAAK;gBACR,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;aACpB,CAAC,CAAC;YAEH,MAAM,cAAc,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAClD,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;YAC5D,MAAM,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACxC,MAAM,KAAK,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC;YAC9C,MAAM,MAAM,GAAG;gBACb,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,MAAM;gBACT,CAAC,EAAE,IAAI;gBACP,KAAK;gBACL,IAAI;gBACJ,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM;aACvB,CAAC;YACF,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;YAEtC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,MAAM;gBACT,CAAC,EAAE,IAAI;gBACP,KAAK,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;gBAC/B,IAAI,EAAE,IAAI,IAAI,CAAC,0BAA0B,CAAC;aAC3C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, it } from \"vitest\";\nimport { VIEW_CONTEXT_KEY } from \"../data-llm.js\";\nimport { filterViewContext, serializeState } from \"./state.js\";\n\ndescribe(\"state helpers\", () => {\n describe(\"filterViewContext\", () => {\n it(\"should return null when state is null\", () => {\n expect(filterViewContext(null)).toBe(null);\n });\n\n it(\"should return null when state is undefined\", () => {\n expect(filterViewContext(undefined)).toBe(null);\n });\n\n it(\"should correctly filter VIEW_CONTEXT_KEY and preserve other properties\", () => {\n const stateWithContextAndOthers = {\n a: 1,\n b: \"two\",\n c: { nested: true },\n [VIEW_CONTEXT_KEY]: \"context\",\n };\n const filteredWithContextAndOthers = filterViewContext(\n stateWithContextAndOthers,\n );\n expect(filteredWithContextAndOthers).toEqual({\n a: 1,\n b: \"two\",\n c: { nested: true },\n });\n\n const stateNoContext = { count: 5, name: \"test\" };\n const filteredNoContext = filterViewContext(stateNoContext);\n expect(filteredNoContext).toEqual(stateNoContext);\n });\n });\n\n describe(\"serializeState\", () => {\n it(\"should serialize plain objects\", () => {\n const array = [1, \"two\", { three: 3 }];\n const date = new Date(\"2023-01-01T00:00:00Z\");\n const object = {\n a: 1,\n b: \"test\",\n c: true,\n array,\n date,\n function: () => \"test\",\n };\n const result = serializeState(object);\n\n expect(result).toEqual({\n a: 1,\n b: \"test\",\n c: true,\n array: [1, \"two\", { three: 3 }],\n date: new Date(\"2023-01-01T00:00:00.000Z\"),\n });\n });\n });\n});\n"]}
@@ -0,0 +1,15 @@
1
+ export { type CallToolAsyncFn, type CallToolFn, type CallToolState, type SideEffects, useCallTool, } from "./use-call-tool.js";
2
+ export { useDisplayMode } from "./use-display-mode.js";
3
+ export { type DownloadFn, useDownload } from "./use-download.js";
4
+ export { useFiles } from "./use-files.js";
5
+ export { type LayoutState, useLayout } from "./use-layout.js";
6
+ export { type OpenExternalFn, useOpenExternal } from "./use-open-external.js";
7
+ export { useRegisterViewTool } from "./use-register-view-tool.js";
8
+ export { type RequestCloseFn, useRequestClose } from "./use-request-close.js";
9
+ export { useRequestModal } from "./use-request-modal.js";
10
+ export { type RequestSizeFn, useRequestSize } from "./use-request-size.js";
11
+ export { useSendFollowUpMessage } from "./use-send-follow-up-message.js";
12
+ export { useSetOpenInAppUrl } from "./use-set-open-in-app-url.js";
13
+ export { useToolInfo } from "./use-tool-info.js";
14
+ export { type UserState, useUser } from "./use-user.js";
15
+ export { useViewState } from "./use-view-state.js";
@@ -0,0 +1,16 @@
1
+ export { useCallTool, } from "./use-call-tool.js";
2
+ export { useDisplayMode } from "./use-display-mode.js";
3
+ export { useDownload } from "./use-download.js";
4
+ export { useFiles } from "./use-files.js";
5
+ export { useLayout } from "./use-layout.js";
6
+ export { useOpenExternal } from "./use-open-external.js";
7
+ export { useRegisterViewTool } from "./use-register-view-tool.js";
8
+ export { useRequestClose } from "./use-request-close.js";
9
+ export { useRequestModal } from "./use-request-modal.js";
10
+ export { useRequestSize } from "./use-request-size.js";
11
+ export { useSendFollowUpMessage } from "./use-send-follow-up-message.js";
12
+ export { useSetOpenInAppUrl } from "./use-set-open-in-app-url.js";
13
+ export { useToolInfo } from "./use-tool-info.js";
14
+ export { useUser } from "./use-user.js";
15
+ export { useViewState } from "./use-view-state.js";
16
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/web/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,WAAW,GACZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAmB,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAoB,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,EAAuB,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAuB,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAsB,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAkB,OAAO,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC","sourcesContent":["export {\n type CallToolAsyncFn,\n type CallToolFn,\n type CallToolState,\n type SideEffects,\n useCallTool,\n} from \"./use-call-tool.js\";\nexport { useDisplayMode } from \"./use-display-mode.js\";\nexport { type DownloadFn, useDownload } from \"./use-download.js\";\nexport { useFiles } from \"./use-files.js\";\nexport { type LayoutState, useLayout } from \"./use-layout.js\";\nexport { type OpenExternalFn, useOpenExternal } from \"./use-open-external.js\";\nexport { useRegisterViewTool } from \"./use-register-view-tool.js\";\nexport { type RequestCloseFn, useRequestClose } from \"./use-request-close.js\";\nexport { useRequestModal } from \"./use-request-modal.js\";\nexport { type RequestSizeFn, useRequestSize } from \"./use-request-size.js\";\nexport { useSendFollowUpMessage } from \"./use-send-follow-up-message.js\";\nexport { useSetOpenInAppUrl } from \"./use-set-open-in-app-url.js\";\nexport { useToolInfo } from \"./use-tool-info.js\";\nexport { type UserState, useUser } from \"./use-user.js\";\nexport { useViewState } from \"./use-view-state.js\";\n"]}
@@ -0,0 +1,20 @@
1
+ import type { McpUiDownloadFileResult, McpUiHostCapabilities, McpUiHostContext, McpUiToolResultNotification } from "@modelcontextprotocol/ext-apps";
2
+ export declare class MockResizeObserver {
3
+ observe(): void;
4
+ unobserve(): void;
5
+ disconnect(): void;
6
+ }
7
+ export type McpAppHostMockOptions = {
8
+ hostCapabilities?: McpUiHostCapabilities;
9
+ downloadFileResult?: McpUiDownloadFileResult;
10
+ };
11
+ export declare const getMcpAppHostPostMessageMock: (initialContext?: McpUiHostContext, options?: McpAppHostMockOptions) => import("vitest").Mock<(message: {
12
+ method: string;
13
+ id: number;
14
+ }) => void>;
15
+ export declare const fireToolInputNotification: (args: Record<string, unknown>) => void;
16
+ export declare const fireToolResultNotification: (params: {
17
+ content: McpUiToolResultNotification["params"]["content"];
18
+ structuredContent: Record<string, unknown>;
19
+ _meta?: Record<string, unknown>;
20
+ }) => void;
@@ -0,0 +1,75 @@
1
+ import { fireEvent } from "@testing-library/react";
2
+ import { act } from "react";
3
+ import { vi } from "vitest";
4
+ export class MockResizeObserver {
5
+ observe() { }
6
+ unobserve() { }
7
+ disconnect() { }
8
+ }
9
+ const DEFAULT_CONTEXT = {};
10
+ export const getMcpAppHostPostMessageMock = (initialContext = DEFAULT_CONTEXT, options = {}) => vi.fn((message) => {
11
+ switch (message.method) {
12
+ case "ui/initialize": {
13
+ const result = {
14
+ protocolVersion: "2025-06-18",
15
+ hostInfo: { name: "test-host", version: "1.0.0" },
16
+ hostCapabilities: options.hostCapabilities ?? {},
17
+ hostContext: initialContext,
18
+ };
19
+ act(() => fireEvent(window, new MessageEvent("message", {
20
+ source: window.parent,
21
+ data: {
22
+ jsonrpc: "2.0",
23
+ id: message.id,
24
+ result,
25
+ },
26
+ })));
27
+ break;
28
+ }
29
+ case "ui/update-model-context": {
30
+ act(() => fireEvent(window, new MessageEvent("message", {
31
+ source: window.parent,
32
+ data: {
33
+ jsonrpc: "2.0",
34
+ id: message.id,
35
+ result: {},
36
+ },
37
+ })));
38
+ break;
39
+ }
40
+ case "ui/download-file": {
41
+ act(() => fireEvent(window, new MessageEvent("message", {
42
+ source: window.parent,
43
+ data: {
44
+ jsonrpc: "2.0",
45
+ id: message.id,
46
+ result: options.downloadFileResult ?? {},
47
+ },
48
+ })));
49
+ break;
50
+ }
51
+ }
52
+ });
53
+ export const fireToolInputNotification = (args) => {
54
+ fireEvent(window, new MessageEvent("message", {
55
+ source: window.parent,
56
+ data: {
57
+ jsonrpc: "2.0",
58
+ method: "ui/notifications/tool-input",
59
+ params: {
60
+ arguments: args,
61
+ },
62
+ },
63
+ }));
64
+ };
65
+ export const fireToolResultNotification = (params) => {
66
+ fireEvent(window, new MessageEvent("message", {
67
+ source: window.parent,
68
+ data: {
69
+ jsonrpc: "2.0",
70
+ method: "ui/notifications/tool-result",
71
+ params,
72
+ },
73
+ }));
74
+ };
75
+ //# sourceMappingURL=utils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/web/hooks/test/utils.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE5B,MAAM,OAAO,kBAAkB;IAC7B,OAAO,KAAU,CAAC;IAClB,SAAS,KAAU,CAAC;IACpB,UAAU,KAAU,CAAC;CACtB;AAED,MAAM,eAAe,GAAqB,EAAE,CAAC;AAO7C,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,iBAAmC,eAAe,EAClD,UAAiC,EAAE,EACnC,EAAE,CACF,EAAE,CAAC,EAAE,CAAC,CAAC,OAAuC,EAAE,EAAE;IAChD,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;QACvB,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,MAAM,MAAM,GAA0B;gBACpC,eAAe,EAAE,YAAY;gBAC7B,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE;gBACjD,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,IAAI,EAAE;gBAChD,WAAW,EAAE,cAAc;aAC5B,CAAC;YACF,GAAG,CAAC,GAAG,EAAE,CACP,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CAIb,SAAS,EAAE;gBACZ,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,IAAI,EAAE;oBACJ,OAAO,EAAE,KAAK;oBACd,EAAE,EAAE,OAAO,CAAC,EAAE;oBACd,MAAM;iBACP;aACF,CAAC,CACH,CACF,CAAC;YACF,MAAM;QACR,CAAC;QACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;YAC/B,GAAG,CAAC,GAAG,EAAE,CACP,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CACd,SAAS,EACT;gBACE,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,IAAI,EAAE;oBACJ,OAAO,EAAE,KAAK;oBACd,EAAE,EAAE,OAAO,CAAC,EAAE;oBACd,MAAM,EAAE,EAAE;iBACX;aACF,CACF,CACF,CACF,CAAC;YACF,MAAM;QACR,CAAC;QACD,KAAK,kBAAkB,CAAC,CAAC,CAAC;YACxB,GAAG,CAAC,GAAG,EAAE,CACP,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CAIb,SAAS,EAAE;gBACZ,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,IAAI,EAAE;oBACJ,OAAO,EAAE,KAAK;oBACd,EAAE,EAAE,OAAO,CAAC,EAAE;oBACd,MAAM,EAAE,OAAO,CAAC,kBAAkB,IAAI,EAAE;iBACzC;aACF,CAAC,CACH,CACF,CAAC;YACF,MAAM;QACR,CAAC;IACH,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,IAA6B,EAAE,EAAE;IACzE,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CACd,SAAS,EACT;QACE,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,IAAI,EAAE;YACJ,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,6BAA6B;YACrC,MAAM,EAAE;gBACN,SAAS,EAAE,IAAI;aAChB;SACF;KACF,CACF,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,MAI1C,EAAE,EAAE;IACH,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CACd,SAAS,EACT;QACE,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,IAAI,EAAE;YACJ,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,8BAA8B;YACtC,MAAM;SACP;KACF,CACF,CACF,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import type {\n McpUiDownloadFileResult,\n McpUiHostCapabilities,\n McpUiHostContext,\n McpUiInitializeResult,\n McpUiToolInputNotification,\n McpUiToolResultNotification,\n} from \"@modelcontextprotocol/ext-apps\";\nimport { fireEvent } from \"@testing-library/react\";\nimport { act } from \"react\";\nimport { vi } from \"vitest\";\n\nexport class MockResizeObserver {\n observe(): void {}\n unobserve(): void {}\n disconnect(): void {}\n}\n\nconst DEFAULT_CONTEXT: McpUiHostContext = {};\n\nexport type McpAppHostMockOptions = {\n hostCapabilities?: McpUiHostCapabilities;\n downloadFileResult?: McpUiDownloadFileResult;\n};\n\nexport const getMcpAppHostPostMessageMock = (\n initialContext: McpUiHostContext = DEFAULT_CONTEXT,\n options: McpAppHostMockOptions = {},\n) =>\n vi.fn((message: { method: string; id: number }) => {\n switch (message.method) {\n case \"ui/initialize\": {\n const result: McpUiInitializeResult = {\n protocolVersion: \"2025-06-18\",\n hostInfo: { name: \"test-host\", version: \"1.0.0\" },\n hostCapabilities: options.hostCapabilities ?? {},\n hostContext: initialContext,\n };\n act(() =>\n fireEvent(\n window,\n new MessageEvent<{\n jsonrpc: \"2.0\";\n id: number;\n result: McpUiInitializeResult;\n }>(\"message\", {\n source: window.parent,\n data: {\n jsonrpc: \"2.0\",\n id: message.id,\n result,\n },\n }),\n ),\n );\n break;\n }\n case \"ui/update-model-context\": {\n act(() =>\n fireEvent(\n window,\n new MessageEvent<{ jsonrpc: \"2.0\"; id: number; result: unknown }>(\n \"message\",\n {\n source: window.parent,\n data: {\n jsonrpc: \"2.0\",\n id: message.id,\n result: {},\n },\n },\n ),\n ),\n );\n break;\n }\n case \"ui/download-file\": {\n act(() =>\n fireEvent(\n window,\n new MessageEvent<{\n jsonrpc: \"2.0\";\n id: number;\n result: McpUiDownloadFileResult;\n }>(\"message\", {\n source: window.parent,\n data: {\n jsonrpc: \"2.0\",\n id: message.id,\n result: options.downloadFileResult ?? {},\n },\n }),\n ),\n );\n break;\n }\n }\n });\n\nexport const fireToolInputNotification = (args: Record<string, unknown>) => {\n fireEvent(\n window,\n new MessageEvent<McpUiToolInputNotification & { jsonrpc: \"2.0\" }>(\n \"message\",\n {\n source: window.parent,\n data: {\n jsonrpc: \"2.0\",\n method: \"ui/notifications/tool-input\",\n params: {\n arguments: args,\n },\n },\n },\n ),\n );\n};\n\nexport const fireToolResultNotification = (params: {\n content: McpUiToolResultNotification[\"params\"][\"content\"];\n structuredContent: Record<string, unknown>;\n _meta?: Record<string, unknown>;\n}) => {\n fireEvent(\n window,\n new MessageEvent<McpUiToolResultNotification & { jsonrpc: \"2.0\" }>(\n \"message\",\n {\n source: window.parent,\n data: {\n jsonrpc: \"2.0\",\n method: \"ui/notifications/tool-result\",\n params,\n },\n },\n ),\n );\n};\n"]}
@@ -1,4 +1,5 @@
1
- import type { CallToolArgs, CallToolResponse, HasRequiredKeys } from "../types.js";
1
+ import { type CallToolArgs, type CallToolResponse } from "../bridges/index.js";
2
+ import type { HasRequiredKeys } from "../types.js";
2
3
  type CallToolIdleState = {
3
4
  status: "idle";
4
5
  isIdle: true;
@@ -35,13 +36,26 @@ type CallToolErrorState = {
35
36
  data: undefined;
36
37
  error: unknown;
37
38
  };
39
+ /**
40
+ * State of a {@link useCallTool} invocation, discriminated by `status`.
41
+ * Use `isIdle` / `isPending` / `isSuccess` / `isError` for ergonomic conditional rendering.
42
+ */
38
43
  export type CallToolState<TData extends CallToolResponse = CallToolResponse> = CallToolIdleState | CallToolPendingState | CallToolSuccessState<TData> | CallToolErrorState;
44
+ /**
45
+ * Optional callbacks fired around a {@link useCallTool} call.
46
+ * `onSettled` runs after success or error.
47
+ */
39
48
  export type SideEffects<ToolArgs, ToolResponse> = {
40
49
  onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
41
50
  onError?: (error: unknown, toolArgs: ToolArgs) => void;
42
51
  onSettled?: (data: ToolResponse | undefined, error: unknown | undefined, toolArgs: ToolArgs) => void;
43
52
  };
44
53
  type IsArgsOptional<T> = [T] extends [null] ? true : HasRequiredKeys<T> extends false ? true : false;
54
+ /**
55
+ * Fire-and-forget call function returned by {@link useCallTool}. Tracks state
56
+ * on the hook and supports optional {@link SideEffects} callbacks. Args are
57
+ * optional when the tool accepts none.
58
+ */
45
59
  export type CallToolFn<TArgs, TResponse> = IsArgsOptional<TArgs> extends true ? {
46
60
  (): void;
47
61
  (sideEffects: SideEffects<TArgs, TResponse>): void;
@@ -51,12 +65,44 @@ export type CallToolFn<TArgs, TResponse> = IsArgsOptional<TArgs> extends true ?
51
65
  (args: TArgs): void;
52
66
  (args: TArgs, sideEffects: SideEffects<TArgs, TResponse>): void;
53
67
  };
68
+ /**
69
+ * Promise-returning call function returned by {@link useCallTool}. Rejects
70
+ * if the tool errors; use `try/catch` for error handling.
71
+ */
54
72
  export type CallToolAsyncFn<TArgs, TResponse> = IsArgsOptional<TArgs> extends true ? {
55
73
  (): Promise<TResponse>;
56
74
  (args: TArgs): Promise<TResponse>;
57
75
  } : (args: TArgs) => Promise<TResponse>;
58
76
  type ToolResponseSignature = Pick<CallToolResponse, "structuredContent" | "meta">;
59
- export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends Partial<ToolResponseSignature> = {}>(name: string) => {
77
+ /**
78
+ * Call a server tool from a view and track its execution state.
79
+ *
80
+ * Returns the current {@link CallToolState} plus two callers: `callTool`
81
+ * (fire-and-forget, with optional {@link SideEffects}) and `callToolAsync`
82
+ * (promise-returning). If the same instance is invoked again while a call is
83
+ * in flight, the older response is dropped from the rendered state (but any
84
+ * `onSuccess` / `onError` / `onSettled` callbacks attached to it still fire).
85
+ *
86
+ * Pair with {@link useToolInfo} to read the result of the tool invocation
87
+ * that produced the current view. For end-to-end type safety across tool
88
+ * inputs and outputs, prefer the typed helpers produced by {@link generateHelpers}
89
+ * over calling this hook directly.
90
+ *
91
+ * @typeParam ToolArgs - Shape of the tool's input args (`null` for no-arg tools).
92
+ * @typeParam ToolResponse - Shape of the tool's `structuredContent` / `meta`.
93
+ *
94
+ * @example
95
+ * ```tsx
96
+ * const { callTool, isPending, data } = useCallTool<{ query: string }>("search");
97
+ *
98
+ * <button onClick={() => callTool({ query: "skybridge" }, {
99
+ * onSuccess: (res) => console.log(res.structuredContent),
100
+ * })} />
101
+ * ```
102
+ *
103
+ * @see https://docs.skybridge.tech/api-reference/use-call-tool
104
+ */
105
+ export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends Partial<ToolResponseSignature> = Record<string, never>>(name: string) => {
60
106
  callTool: CallToolFn<ToolArgs, CallToolResponse & ToolResponse>;
61
107
  callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
62
108
  status: "idle";