skybridge 0.0.0-dev.f615683 → 0.0.0-dev.f6998b2

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 (560) hide show
  1. package/LICENSE +21 -674
  2. package/README.md +123 -94
  3. package/bin/run.js +5 -0
  4. package/dist/cli/build-helpers.d.ts +7 -0
  5. package/dist/cli/build-helpers.js +82 -0
  6. package/dist/cli/build-helpers.js.map +1 -0
  7. package/dist/cli/build-helpers.test.js +64 -0
  8. package/dist/cli/build-helpers.test.js.map +1 -0
  9. package/dist/cli/detect-port.d.ts +18 -0
  10. package/dist/cli/detect-port.js +50 -0
  11. package/dist/cli/detect-port.js.map +1 -0
  12. package/dist/cli/header.d.ts +4 -0
  13. package/dist/cli/header.js +6 -0
  14. package/dist/cli/header.js.map +1 -0
  15. package/dist/cli/resolve-views-dir.d.ts +1 -0
  16. package/dist/cli/resolve-views-dir.js +17 -0
  17. package/dist/cli/resolve-views-dir.js.map +1 -0
  18. package/dist/cli/run-command.d.ts +2 -0
  19. package/dist/cli/run-command.js +43 -0
  20. package/dist/cli/run-command.js.map +1 -0
  21. package/dist/cli/telemetry.d.ts +7 -0
  22. package/dist/cli/telemetry.js +123 -0
  23. package/dist/cli/telemetry.js.map +1 -0
  24. package/dist/cli/tunnel-control-server.d.ts +9 -0
  25. package/dist/cli/tunnel-control-server.js +31 -0
  26. package/dist/cli/tunnel-control-server.js.map +1 -0
  27. package/dist/cli/tunnel-control-server.test.js +39 -0
  28. package/dist/cli/tunnel-control-server.test.js.map +1 -0
  29. package/dist/cli/tunnel-handler.d.ts +3 -0
  30. package/dist/cli/tunnel-handler.js +48 -0
  31. package/dist/cli/tunnel-handler.js.map +1 -0
  32. package/dist/cli/tunnel-handler.test.js +105 -0
  33. package/dist/cli/tunnel-handler.test.js.map +1 -0
  34. package/dist/cli/tunnel.d.ts +57 -0
  35. package/dist/cli/tunnel.js +154 -0
  36. package/dist/cli/tunnel.js.map +1 -0
  37. package/dist/cli/tunnel.test.js +190 -0
  38. package/dist/cli/tunnel.test.js.map +1 -0
  39. package/dist/cli/types.d.ts +5 -0
  40. package/dist/cli/types.js +2 -0
  41. package/dist/cli/types.js.map +1 -0
  42. package/dist/cli/use-execute-steps.d.ts +11 -0
  43. package/dist/cli/use-execute-steps.js +36 -0
  44. package/dist/cli/use-execute-steps.js.map +1 -0
  45. package/dist/cli/use-messages.d.ts +3 -0
  46. package/dist/cli/use-messages.js +11 -0
  47. package/dist/cli/use-messages.js.map +1 -0
  48. package/dist/cli/use-nodemon.d.ts +2 -0
  49. package/dist/cli/use-nodemon.js +73 -0
  50. package/dist/cli/use-nodemon.js.map +1 -0
  51. package/dist/cli/use-open-browser.d.ts +1 -0
  52. package/dist/cli/use-open-browser.js +44 -0
  53. package/dist/cli/use-open-browser.js.map +1 -0
  54. package/dist/cli/use-tunnel.d.ts +14 -0
  55. package/dist/cli/use-tunnel.js +131 -0
  56. package/dist/cli/use-tunnel.js.map +1 -0
  57. package/dist/cli/use-typescript-check.d.ts +9 -0
  58. package/dist/cli/use-typescript-check.js +94 -0
  59. package/dist/cli/use-typescript-check.js.map +1 -0
  60. package/dist/commands/build.d.ts +8 -0
  61. package/dist/commands/build.js +90 -0
  62. package/dist/commands/build.js.map +1 -0
  63. package/dist/commands/create.d.ts +9 -0
  64. package/dist/commands/create.js +30 -0
  65. package/dist/commands/create.js.map +1 -0
  66. package/dist/commands/dev.d.ts +12 -0
  67. package/dist/commands/dev.js +96 -0
  68. package/dist/commands/dev.js.map +1 -0
  69. package/dist/commands/start.d.ts +9 -0
  70. package/dist/commands/start.js +55 -0
  71. package/dist/commands/start.js.map +1 -0
  72. package/dist/commands/telemetry/disable.d.ts +5 -0
  73. package/dist/commands/telemetry/disable.js +14 -0
  74. package/dist/commands/telemetry/disable.js.map +1 -0
  75. package/dist/commands/telemetry/enable.d.ts +5 -0
  76. package/dist/commands/telemetry/enable.js +14 -0
  77. package/dist/commands/telemetry/enable.js.map +1 -0
  78. package/dist/commands/telemetry/status.d.ts +5 -0
  79. package/dist/commands/telemetry/status.js +14 -0
  80. package/dist/commands/telemetry/status.js.map +1 -0
  81. package/dist/server/asset-base-url-transform-plugin.d.ts +11 -0
  82. package/dist/server/asset-base-url-transform-plugin.js +48 -0
  83. package/dist/server/asset-base-url-transform-plugin.js.map +1 -0
  84. package/dist/server/asset-base-url-transform-plugin.test.js +134 -0
  85. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -0
  86. package/dist/server/auth/discovery.d.ts +32 -0
  87. package/dist/server/auth/discovery.js +56 -0
  88. package/dist/server/auth/discovery.js.map +1 -0
  89. package/dist/server/auth/discovery.test.js +93 -0
  90. package/dist/server/auth/discovery.test.js.map +1 -0
  91. package/dist/server/auth/index.d.ts +18 -0
  92. package/dist/server/auth/index.js.map +1 -0
  93. package/dist/server/auth/providers/auth0.d.ts +18 -0
  94. package/dist/server/auth/providers/auth0.js +31 -0
  95. package/dist/server/auth/providers/auth0.js.map +1 -0
  96. package/dist/server/auth/providers/auth0.test.js +48 -0
  97. package/dist/server/auth/providers/auth0.test.js.map +1 -0
  98. package/dist/server/auth/providers/clerk.d.ts +14 -0
  99. package/dist/server/auth/providers/clerk.js +16 -0
  100. package/dist/server/auth/providers/clerk.js.map +1 -0
  101. package/dist/server/auth/providers/clerk.test.js +28 -0
  102. package/dist/server/auth/providers/clerk.test.js.map +1 -0
  103. package/dist/server/auth/providers/custom.d.ts +24 -0
  104. package/dist/server/auth/providers/custom.js +37 -0
  105. package/dist/server/auth/providers/custom.js.map +1 -0
  106. package/dist/server/auth/providers/custom.test.js +107 -0
  107. package/dist/server/auth/providers/custom.test.js.map +1 -0
  108. package/dist/server/auth/providers/descope.d.ts +15 -0
  109. package/dist/server/auth/providers/descope.js +33 -0
  110. package/dist/server/auth/providers/descope.js.map +1 -0
  111. package/dist/server/auth/providers/descope.test.js +37 -0
  112. package/dist/server/auth/providers/descope.test.js.map +1 -0
  113. package/dist/server/auth/providers/shared.d.ts +2 -0
  114. package/dist/server/auth/providers/shared.js +6 -0
  115. package/dist/server/auth/providers/shared.js.map +1 -0
  116. package/dist/server/auth/providers/shared.test.js +10 -0
  117. package/dist/server/auth/providers/shared.test.js.map +1 -0
  118. package/dist/server/auth/providers/stytch.d.ts +12 -0
  119. package/dist/server/auth/providers/stytch.js +13 -0
  120. package/dist/server/auth/providers/stytch.js.map +1 -0
  121. package/dist/server/auth/providers/workos.d.ts +11 -0
  122. package/dist/server/auth/providers/workos.js +12 -0
  123. package/dist/server/auth/providers/workos.js.map +1 -0
  124. package/dist/server/auth/setup.d.ts +4 -0
  125. package/dist/server/auth/setup.js +51 -0
  126. package/dist/server/auth/setup.js.map +1 -0
  127. package/dist/server/auth/setup.test.js +185 -0
  128. package/dist/server/auth/setup.test.js.map +1 -0
  129. package/dist/server/auth/verify.d.ts +12 -0
  130. package/dist/server/auth/verify.js +38 -0
  131. package/dist/server/auth/verify.js.map +1 -0
  132. package/dist/server/auth/verify.test.js +100 -0
  133. package/dist/server/auth/verify.test.js.map +1 -0
  134. package/dist/server/auth.d.ts +20 -0
  135. package/dist/server/auth.js +28 -0
  136. package/dist/server/auth.js.map +1 -0
  137. package/dist/server/build-manifest.test.js +27 -0
  138. package/dist/server/build-manifest.test.js.map +1 -0
  139. package/dist/server/content-helpers.d.ts +67 -0
  140. package/dist/server/content-helpers.js +79 -0
  141. package/dist/server/content-helpers.js.map +1 -0
  142. package/dist/server/content-helpers.test.js +70 -0
  143. package/dist/server/content-helpers.test.js.map +1 -0
  144. package/dist/server/express.d.ts +11 -0
  145. package/dist/server/express.js +101 -0
  146. package/dist/server/express.js.map +1 -0
  147. package/dist/server/express.test.js +491 -0
  148. package/dist/server/express.test.js.map +1 -0
  149. package/dist/server/file-ref.d.ts +28 -0
  150. package/dist/server/file-ref.js +27 -0
  151. package/dist/server/file-ref.js.map +1 -0
  152. package/dist/server/index.d.ts +15 -0
  153. package/dist/server/index.js +12 -0
  154. package/dist/server/index.js.map +1 -0
  155. package/dist/{src/server → server}/inferUtilityTypes.d.ts +15 -5
  156. package/dist/server/inferUtilityTypes.js.map +1 -0
  157. package/dist/server/metric.d.ts +14 -0
  158. package/dist/server/metric.js +62 -0
  159. package/dist/server/metric.js.map +1 -0
  160. package/dist/server/middleware.d.ts +137 -0
  161. package/dist/server/middleware.js +93 -0
  162. package/dist/server/middleware.js.map +1 -0
  163. package/dist/server/middleware.test-d.js +75 -0
  164. package/dist/server/middleware.test-d.js.map +1 -0
  165. package/dist/server/middleware.test.js +493 -0
  166. package/dist/server/middleware.test.js.map +1 -0
  167. package/dist/server/requestOrigin.d.ts +7 -0
  168. package/dist/server/requestOrigin.js +25 -0
  169. package/dist/server/requestOrigin.js.map +1 -0
  170. package/dist/server/server.d.ts +419 -0
  171. package/dist/server/server.js +632 -0
  172. package/dist/server/server.js.map +1 -0
  173. package/dist/{src/server → server}/templateHelper.d.ts +5 -4
  174. package/dist/server/templateHelper.js +11 -0
  175. package/dist/server/templateHelper.js.map +1 -0
  176. package/dist/server/templates.generated.d.ts +4 -0
  177. package/dist/server/templates.generated.js +47 -0
  178. package/dist/server/templates.generated.js.map +1 -0
  179. package/dist/server/tunnel-proxy-router.d.ts +7 -0
  180. package/dist/server/tunnel-proxy-router.js +110 -0
  181. package/dist/server/tunnel-proxy-router.js.map +1 -0
  182. package/dist/server/tunnel-proxy-router.test.js +229 -0
  183. package/dist/server/tunnel-proxy-router.test.js.map +1 -0
  184. package/dist/server/view-name.test-d.js +8 -0
  185. package/dist/server/view-name.test-d.js.map +1 -0
  186. package/dist/server/view-resource-resolution.test.d.ts +6 -0
  187. package/dist/server/view-resource-resolution.test.js +171 -0
  188. package/dist/server/view-resource-resolution.test.js.map +1 -0
  189. package/dist/server/viewsDevServer.d.ts +14 -0
  190. package/dist/server/viewsDevServer.js +45 -0
  191. package/dist/server/viewsDevServer.js.map +1 -0
  192. package/dist/test/utils.d.ts +127 -0
  193. package/dist/{src/test → test}/utils.js +111 -28
  194. package/dist/test/utils.js.map +1 -0
  195. package/dist/test/view.test.d.ts +1 -0
  196. package/dist/test/view.test.js +536 -0
  197. package/dist/test/view.test.js.map +1 -0
  198. package/dist/version.d.ts +1 -0
  199. package/dist/version.js +3 -0
  200. package/dist/version.js.map +1 -0
  201. package/dist/web/bridges/adaptor.d.ts +51 -0
  202. package/dist/web/bridges/adaptor.js +310 -0
  203. package/dist/web/bridges/adaptor.js.map +1 -0
  204. package/dist/web/bridges/adaptor.test.d.ts +1 -0
  205. package/dist/web/bridges/adaptor.test.js +197 -0
  206. package/dist/web/bridges/adaptor.test.js.map +1 -0
  207. package/dist/web/bridges/apps-sdk/bridge.d.ts +15 -0
  208. package/dist/web/bridges/apps-sdk/bridge.js +58 -0
  209. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -0
  210. package/dist/web/bridges/apps-sdk/index.d.ts +4 -0
  211. package/dist/web/bridges/apps-sdk/index.js +4 -0
  212. package/dist/web/bridges/apps-sdk/index.js.map +1 -0
  213. package/dist/web/bridges/apps-sdk/types.d.ts +133 -0
  214. package/dist/{src/web → web/bridges/apps-sdk}/types.js +0 -1
  215. package/dist/web/bridges/apps-sdk/types.js.map +1 -0
  216. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +13 -0
  217. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +18 -0
  218. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -0
  219. package/dist/web/bridges/get-adaptor.d.ts +9 -0
  220. package/dist/web/bridges/get-adaptor.js +10 -0
  221. package/dist/web/bridges/get-adaptor.js.map +1 -0
  222. package/dist/web/bridges/get-adaptor.test.d.ts +1 -0
  223. package/dist/web/bridges/get-adaptor.test.js +32 -0
  224. package/dist/web/bridges/get-adaptor.test.js.map +1 -0
  225. package/dist/web/bridges/index.d.ts +5 -0
  226. package/dist/web/bridges/index.js +6 -0
  227. package/dist/web/bridges/index.js.map +1 -0
  228. package/dist/web/bridges/mcp-app/bridge.d.ts +39 -0
  229. package/dist/web/bridges/mcp-app/bridge.js +166 -0
  230. package/dist/web/bridges/mcp-app/bridge.js.map +1 -0
  231. package/dist/web/bridges/mcp-app/bridge.test.d.ts +1 -0
  232. package/dist/web/bridges/mcp-app/bridge.test.js +17 -0
  233. package/dist/web/bridges/mcp-app/bridge.test.js.map +1 -0
  234. package/dist/web/bridges/mcp-app/index.d.ts +3 -0
  235. package/dist/web/bridges/mcp-app/index.js +3 -0
  236. package/dist/web/bridges/mcp-app/index.js.map +1 -0
  237. package/dist/web/bridges/mcp-app/types.d.ts +8 -0
  238. package/dist/web/bridges/mcp-app/types.js +2 -0
  239. package/dist/web/bridges/mcp-app/types.js.map +1 -0
  240. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +19 -0
  241. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +19 -0
  242. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -0
  243. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.d.ts +1 -0
  244. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js +26 -0
  245. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -0
  246. package/dist/web/bridges/mcp-app/view-tools.test.d.ts +1 -0
  247. package/dist/web/bridges/mcp-app/view-tools.test.js +143 -0
  248. package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -0
  249. package/dist/web/bridges/types.d.ts +214 -0
  250. package/dist/web/bridges/types.js +15 -0
  251. package/dist/web/bridges/types.js.map +1 -0
  252. package/dist/web/bridges/types.test.d.ts +1 -0
  253. package/dist/web/bridges/types.test.js +19 -0
  254. package/dist/web/bridges/types.test.js.map +1 -0
  255. package/dist/web/bridges/use-host-context.d.ts +7 -0
  256. package/dist/web/bridges/use-host-context.js +13 -0
  257. package/dist/web/bridges/use-host-context.js.map +1 -0
  258. package/dist/web/components/modal-provider.d.ts +4 -0
  259. package/dist/web/components/modal-provider.js +46 -0
  260. package/dist/web/components/modal-provider.js.map +1 -0
  261. package/dist/web/create-store.d.ts +29 -0
  262. package/dist/web/create-store.js +64 -0
  263. package/dist/web/create-store.js.map +1 -0
  264. package/dist/web/create-store.test.d.ts +1 -0
  265. package/dist/web/create-store.test.js +132 -0
  266. package/dist/web/create-store.test.js.map +1 -0
  267. package/dist/web/data-llm.d.ts +47 -0
  268. package/dist/{src/web → web}/data-llm.js +39 -7
  269. package/dist/web/data-llm.js.map +1 -0
  270. package/dist/web/data-llm.test.d.ts +1 -0
  271. package/dist/web/data-llm.test.js +146 -0
  272. package/dist/web/data-llm.test.js.map +1 -0
  273. package/dist/{src/web → web}/generate-helpers.d.ts +31 -24
  274. package/dist/{src/web → web}/generate-helpers.js +26 -20
  275. package/dist/web/generate-helpers.js.map +1 -0
  276. package/dist/web/generate-helpers.test-d.d.ts +1 -0
  277. package/dist/{src/web → web}/generate-helpers.test-d.js +80 -23
  278. package/dist/web/generate-helpers.test-d.js.map +1 -0
  279. package/dist/web/generate-helpers.test.d.ts +1 -0
  280. package/dist/web/generate-helpers.test.js.map +1 -0
  281. package/dist/{src/web → web}/helpers/state.d.ts +2 -2
  282. package/dist/web/helpers/state.js +45 -0
  283. package/dist/web/helpers/state.js.map +1 -0
  284. package/dist/web/helpers/state.test.d.ts +1 -0
  285. package/dist/{src/web → web}/helpers/state.test.js +9 -9
  286. package/dist/web/helpers/state.test.js.map +1 -0
  287. package/dist/web/hooks/index.d.ts +15 -0
  288. package/dist/web/hooks/index.js +16 -0
  289. package/dist/web/hooks/index.js.map +1 -0
  290. package/dist/web/hooks/test/utils.d.ts +20 -0
  291. package/dist/web/hooks/test/utils.js +75 -0
  292. package/dist/web/hooks/test/utils.js.map +1 -0
  293. package/dist/{src/web → web}/hooks/use-call-tool.d.ts +48 -2
  294. package/dist/web/hooks/use-call-tool.js +96 -0
  295. package/dist/web/hooks/use-call-tool.js.map +1 -0
  296. package/dist/web/hooks/use-call-tool.test-d.d.ts +1 -0
  297. package/dist/web/hooks/use-call-tool.test-d.js.map +1 -0
  298. package/dist/web/hooks/use-call-tool.test.d.ts +1 -0
  299. package/dist/{src/web → web}/hooks/use-call-tool.test.js +92 -38
  300. package/dist/web/hooks/use-call-tool.test.js.map +1 -0
  301. package/dist/web/hooks/use-display-mode.d.ts +24 -0
  302. package/dist/web/hooks/use-display-mode.js +29 -0
  303. package/dist/web/hooks/use-display-mode.js.map +1 -0
  304. package/dist/web/hooks/use-display-mode.test-d.d.ts +1 -0
  305. package/dist/web/hooks/use-display-mode.test-d.js +8 -0
  306. package/dist/web/hooks/use-display-mode.test-d.js.map +1 -0
  307. package/dist/web/hooks/use-display-mode.test.d.ts +1 -0
  308. package/dist/web/hooks/use-display-mode.test.js +77 -0
  309. package/dist/web/hooks/use-display-mode.test.js.map +1 -0
  310. package/dist/web/hooks/use-download.d.ts +5 -0
  311. package/dist/web/hooks/use-download.js +8 -0
  312. package/dist/web/hooks/use-download.js.map +1 -0
  313. package/dist/web/hooks/use-download.test.d.ts +1 -0
  314. package/dist/web/hooks/use-download.test.js +103 -0
  315. package/dist/web/hooks/use-download.test.js.map +1 -0
  316. package/dist/web/hooks/use-files.d.ts +39 -0
  317. package/dist/web/hooks/use-files.js +42 -0
  318. package/dist/web/hooks/use-files.js.map +1 -0
  319. package/dist/web/hooks/use-files.test.d.ts +1 -0
  320. package/dist/web/hooks/use-files.test.js +62 -0
  321. package/dist/web/hooks/use-files.test.js.map +1 -0
  322. package/dist/web/hooks/use-layout.d.ts +24 -0
  323. package/dist/web/hooks/use-layout.js +25 -0
  324. package/dist/web/hooks/use-layout.js.map +1 -0
  325. package/dist/web/hooks/use-layout.test.d.ts +1 -0
  326. package/dist/web/hooks/use-layout.test.js +129 -0
  327. package/dist/web/hooks/use-layout.test.js.map +1 -0
  328. package/dist/web/hooks/use-open-external.d.ts +20 -0
  329. package/dist/web/hooks/use-open-external.js +24 -0
  330. package/dist/web/hooks/use-open-external.js.map +1 -0
  331. package/dist/web/hooks/use-open-external.test.d.ts +1 -0
  332. package/dist/web/hooks/use-open-external.test.js +75 -0
  333. package/dist/web/hooks/use-open-external.test.js.map +1 -0
  334. package/dist/web/hooks/use-register-view-tool.d.ts +38 -0
  335. package/dist/web/hooks/use-register-view-tool.js +50 -0
  336. package/dist/web/hooks/use-register-view-tool.js.map +1 -0
  337. package/dist/web/hooks/use-request-close.d.ts +16 -0
  338. package/dist/web/hooks/use-request-close.js +21 -0
  339. package/dist/web/hooks/use-request-close.js.map +1 -0
  340. package/dist/web/hooks/use-request-close.test.d.ts +1 -0
  341. package/dist/web/hooks/use-request-close.test.js +47 -0
  342. package/dist/web/hooks/use-request-close.test.js.map +1 -0
  343. package/dist/web/hooks/use-request-modal.d.ts +24 -0
  344. package/dist/web/hooks/use-request-modal.js +31 -0
  345. package/dist/web/hooks/use-request-modal.js.map +1 -0
  346. package/dist/web/hooks/use-request-modal.test.d.ts +1 -0
  347. package/dist/web/hooks/use-request-modal.test.js +71 -0
  348. package/dist/web/hooks/use-request-modal.test.js.map +1 -0
  349. package/dist/web/hooks/use-request-size.d.ts +20 -0
  350. package/dist/web/hooks/use-request-size.js +24 -0
  351. package/dist/web/hooks/use-request-size.js.map +1 -0
  352. package/dist/web/hooks/use-request-size.test.d.ts +1 -0
  353. package/dist/web/hooks/use-request-size.test.js +47 -0
  354. package/dist/web/hooks/use-request-size.test.js.map +1 -0
  355. package/dist/web/hooks/use-send-follow-up-message.d.ts +19 -0
  356. package/dist/web/hooks/use-send-follow-up-message.js +25 -0
  357. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -0
  358. package/dist/web/hooks/use-set-open-in-app-url.d.ts +18 -0
  359. package/dist/web/hooks/use-set-open-in-app-url.js +25 -0
  360. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -0
  361. package/dist/web/hooks/use-set-open-in-app-url.test.d.ts +1 -0
  362. package/dist/web/hooks/use-set-open-in-app-url.test.js +63 -0
  363. package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -0
  364. package/dist/web/hooks/use-tool-info.d.ts +87 -0
  365. package/dist/web/hooks/use-tool-info.js +49 -0
  366. package/dist/web/hooks/use-tool-info.js.map +1 -0
  367. package/dist/web/hooks/use-tool-info.test-d.d.ts +1 -0
  368. package/dist/{src/web → web}/hooks/use-tool-info.test-d.js +24 -6
  369. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -0
  370. package/dist/web/hooks/use-tool-info.test.d.ts +1 -0
  371. package/dist/web/hooks/use-tool-info.test.js +140 -0
  372. package/dist/web/hooks/use-tool-info.test.js.map +1 -0
  373. package/dist/web/hooks/use-user.d.ts +20 -0
  374. package/dist/web/hooks/use-user.js +37 -0
  375. package/dist/web/hooks/use-user.js.map +1 -0
  376. package/dist/web/hooks/use-user.test.d.ts +1 -0
  377. package/dist/web/hooks/use-user.test.js +168 -0
  378. package/dist/web/hooks/use-user.test.js.map +1 -0
  379. package/dist/web/hooks/use-view-state.d.ts +25 -0
  380. package/dist/web/hooks/use-view-state.js +32 -0
  381. package/dist/web/hooks/use-view-state.js.map +1 -0
  382. package/dist/web/hooks/use-view-state.test.d.ts +1 -0
  383. package/dist/web/hooks/use-view-state.test.js +181 -0
  384. package/dist/web/hooks/use-view-state.test.js.map +1 -0
  385. package/dist/{src/web → web}/index.d.ts +2 -2
  386. package/dist/{src/web → web}/index.js +2 -2
  387. package/dist/web/index.js.map +1 -0
  388. package/dist/web/mount-view.d.ts +20 -0
  389. package/dist/web/mount-view.js +46 -0
  390. package/dist/web/mount-view.js.map +1 -0
  391. package/dist/web/plugin/data-llm.test.d.ts +1 -0
  392. package/dist/web/plugin/data-llm.test.js.map +1 -0
  393. package/dist/web/plugin/plugin.d.ts +33 -0
  394. package/dist/web/plugin/plugin.js +189 -0
  395. package/dist/web/plugin/plugin.js.map +1 -0
  396. package/dist/web/plugin/scan-views.d.ts +16 -0
  397. package/dist/web/plugin/scan-views.js +88 -0
  398. package/dist/web/plugin/scan-views.js.map +1 -0
  399. package/dist/web/plugin/scan-views.test.d.ts +1 -0
  400. package/dist/web/plugin/scan-views.test.js +99 -0
  401. package/dist/web/plugin/scan-views.test.js.map +1 -0
  402. package/dist/{src/web → web}/plugin/transform-data-llm.js +7 -4
  403. package/dist/web/plugin/transform-data-llm.js.map +1 -0
  404. package/dist/web/plugin/transform-data-llm.test.d.ts +1 -0
  405. package/dist/web/plugin/transform-data-llm.test.js.map +1 -0
  406. package/dist/web/plugin/validate-view.d.ts +1 -0
  407. package/dist/web/plugin/validate-view.js +9 -0
  408. package/dist/web/plugin/validate-view.js.map +1 -0
  409. package/dist/web/plugin/validate-view.test.d.ts +1 -0
  410. package/dist/web/plugin/validate-view.test.js +24 -0
  411. package/dist/web/plugin/validate-view.test.js.map +1 -0
  412. package/dist/{src/web → web}/proxy.js +5 -1
  413. package/dist/web/proxy.js.map +1 -0
  414. package/dist/web/types.d.ts +20 -0
  415. package/dist/web/types.js +2 -0
  416. package/dist/web/types.js.map +1 -0
  417. package/package.json +86 -43
  418. package/tsconfig.base.json +33 -0
  419. package/dist/src/emulator/assets/index-BjyctK8j.js +0 -133
  420. package/dist/src/emulator/assets/index-BlZAHQDQ.css +0 -1
  421. package/dist/src/emulator/favicon.ico +0 -0
  422. package/dist/src/emulator/index.html +0 -14
  423. package/dist/src/server/emulatorStaticServer.d.ts +0 -15
  424. package/dist/src/server/emulatorStaticServer.js +0 -38
  425. package/dist/src/server/emulatorStaticServer.js.map +0 -1
  426. package/dist/src/server/index.d.ts +0 -1
  427. package/dist/src/server/index.js.map +0 -1
  428. package/dist/src/server/inferUtilityTypes.js.map +0 -1
  429. package/dist/src/server/server.d.ts +0 -56
  430. package/dist/src/server/server.js +0 -62
  431. package/dist/src/server/server.js.map +0 -1
  432. package/dist/src/server/templateHelper.js +0 -29
  433. package/dist/src/server/templateHelper.js.map +0 -1
  434. package/dist/src/server/templates/development.hbs +0 -12
  435. package/dist/src/server/templates/production.hbs +0 -6
  436. package/dist/src/server/widgetsDevServer.d.ts +0 -12
  437. package/dist/src/server/widgetsDevServer.js +0 -39
  438. package/dist/src/server/widgetsDevServer.js.map +0 -1
  439. package/dist/src/test/utils.d.ts +0 -89
  440. package/dist/src/test/utils.js.map +0 -1
  441. package/dist/src/test/widget.test.js +0 -89
  442. package/dist/src/test/widget.test.js.map +0 -1
  443. package/dist/src/web/create-store.d.ts +0 -3
  444. package/dist/src/web/create-store.js +0 -25
  445. package/dist/src/web/create-store.js.map +0 -1
  446. package/dist/src/web/create-store.test.js +0 -70
  447. package/dist/src/web/create-store.test.js.map +0 -1
  448. package/dist/src/web/data-llm.d.ts +0 -14
  449. package/dist/src/web/data-llm.js.map +0 -1
  450. package/dist/src/web/data-llm.test.js +0 -76
  451. package/dist/src/web/data-llm.test.js.map +0 -1
  452. package/dist/src/web/generate-helpers.js.map +0 -1
  453. package/dist/src/web/generate-helpers.test-d.js.map +0 -1
  454. package/dist/src/web/generate-helpers.test.js.map +0 -1
  455. package/dist/src/web/helpers/state.js +0 -40
  456. package/dist/src/web/helpers/state.js.map +0 -1
  457. package/dist/src/web/helpers/state.test.js.map +0 -1
  458. package/dist/src/web/hooks/index.d.ts +0 -12
  459. package/dist/src/web/hooks/index.js +0 -13
  460. package/dist/src/web/hooks/index.js.map +0 -1
  461. package/dist/src/web/hooks/use-call-tool.js +0 -60
  462. package/dist/src/web/hooks/use-call-tool.js.map +0 -1
  463. package/dist/src/web/hooks/use-call-tool.test-d.js.map +0 -1
  464. package/dist/src/web/hooks/use-call-tool.test.js.map +0 -1
  465. package/dist/src/web/hooks/use-display-mode.d.ts +0 -4
  466. package/dist/src/web/hooks/use-display-mode.js +0 -7
  467. package/dist/src/web/hooks/use-display-mode.js.map +0 -1
  468. package/dist/src/web/hooks/use-display-mode.test.js +0 -40
  469. package/dist/src/web/hooks/use-display-mode.test.js.map +0 -1
  470. package/dist/src/web/hooks/use-files.d.ts +0 -10
  471. package/dist/src/web/hooks/use-files.js +0 -7
  472. package/dist/src/web/hooks/use-files.js.map +0 -1
  473. package/dist/src/web/hooks/use-files.test.js +0 -29
  474. package/dist/src/web/hooks/use-files.test.js.map +0 -1
  475. package/dist/src/web/hooks/use-locale.d.ts +0 -1
  476. package/dist/src/web/hooks/use-locale.js +0 -5
  477. package/dist/src/web/hooks/use-locale.js.map +0 -1
  478. package/dist/src/web/hooks/use-locale.test.js +0 -21
  479. package/dist/src/web/hooks/use-locale.test.js.map +0 -1
  480. package/dist/src/web/hooks/use-open-external.d.ts +0 -1
  481. package/dist/src/web/hooks/use-open-external.js +0 -6
  482. package/dist/src/web/hooks/use-open-external.js.map +0 -1
  483. package/dist/src/web/hooks/use-open-external.test.js +0 -24
  484. package/dist/src/web/hooks/use-open-external.test.js.map +0 -1
  485. package/dist/src/web/hooks/use-openai-global.d.ts +0 -2
  486. package/dist/src/web/hooks/use-openai-global.js +0 -23
  487. package/dist/src/web/hooks/use-openai-global.js.map +0 -1
  488. package/dist/src/web/hooks/use-request-modal.d.ts +0 -6
  489. package/dist/src/web/hooks/use-request-modal.js +0 -9
  490. package/dist/src/web/hooks/use-request-modal.js.map +0 -1
  491. package/dist/src/web/hooks/use-request-modal.test.js +0 -24
  492. package/dist/src/web/hooks/use-request-modal.test.js.map +0 -1
  493. package/dist/src/web/hooks/use-send-follow-up-message.d.ts +0 -1
  494. package/dist/src/web/hooks/use-send-follow-up-message.js +0 -11
  495. package/dist/src/web/hooks/use-send-follow-up-message.js.map +0 -1
  496. package/dist/src/web/hooks/use-theme.d.ts +0 -1
  497. package/dist/src/web/hooks/use-theme.js +0 -5
  498. package/dist/src/web/hooks/use-theme.js.map +0 -1
  499. package/dist/src/web/hooks/use-theme.test.js +0 -26
  500. package/dist/src/web/hooks/use-theme.test.js.map +0 -1
  501. package/dist/src/web/hooks/use-tool-info.d.ts +0 -25
  502. package/dist/src/web/hooks/use-tool-info.js +0 -22
  503. package/dist/src/web/hooks/use-tool-info.js.map +0 -1
  504. package/dist/src/web/hooks/use-tool-info.test-d.js.map +0 -1
  505. package/dist/src/web/hooks/use-tool-info.test.js +0 -59
  506. package/dist/src/web/hooks/use-tool-info.test.js.map +0 -1
  507. package/dist/src/web/hooks/use-user-agent.d.ts +0 -1
  508. package/dist/src/web/hooks/use-user-agent.js +0 -5
  509. package/dist/src/web/hooks/use-user-agent.js.map +0 -1
  510. package/dist/src/web/hooks/use-user-agent.test.js +0 -31
  511. package/dist/src/web/hooks/use-user-agent.test.js.map +0 -1
  512. package/dist/src/web/hooks/use-widget-state.d.ts +0 -4
  513. package/dist/src/web/hooks/use-widget-state.js +0 -32
  514. package/dist/src/web/hooks/use-widget-state.js.map +0 -1
  515. package/dist/src/web/hooks/use-widget-state.test.js +0 -60
  516. package/dist/src/web/hooks/use-widget-state.test.js.map +0 -1
  517. package/dist/src/web/index.js.map +0 -1
  518. package/dist/src/web/mount-widget.d.ts +0 -1
  519. package/dist/src/web/mount-widget.js +0 -48
  520. package/dist/src/web/mount-widget.js.map +0 -1
  521. package/dist/src/web/plugin/data-llm.test.js.map +0 -1
  522. package/dist/src/web/plugin/plugin.d.ts +0 -2
  523. package/dist/src/web/plugin/plugin.js +0 -33
  524. package/dist/src/web/plugin/plugin.js.map +0 -1
  525. package/dist/src/web/plugin/transform-data-llm.js.map +0 -1
  526. package/dist/src/web/plugin/transform-data-llm.test.js.map +0 -1
  527. package/dist/src/web/proxy.js.map +0 -1
  528. package/dist/src/web/types.d.ts +0 -133
  529. package/dist/src/web/types.js.map +0 -1
  530. package/dist/vitest.config.d.ts +0 -2
  531. package/dist/vitest.config.js +0 -8
  532. package/dist/vitest.config.js.map +0 -1
  533. /package/dist/{src/test/widget.test.d.ts → cli/build-helpers.test.d.ts} +0 -0
  534. /package/dist/{src/web/create-store.test.d.ts → cli/tunnel-control-server.test.d.ts} +0 -0
  535. /package/dist/{src/web/data-llm.test.d.ts → cli/tunnel-handler.test.d.ts} +0 -0
  536. /package/dist/{src/web/generate-helpers.test-d.d.ts → cli/tunnel.test.d.ts} +0 -0
  537. /package/dist/{src/web/generate-helpers.test.d.ts → server/asset-base-url-transform-plugin.test.d.ts} +0 -0
  538. /package/dist/{src/web/helpers/state.test.d.ts → server/auth/discovery.test.d.ts} +0 -0
  539. /package/dist/{src/server → server/auth}/index.js +0 -0
  540. /package/dist/{src/web/hooks/use-call-tool.test-d.d.ts → server/auth/providers/auth0.test.d.ts} +0 -0
  541. /package/dist/{src/web/hooks/use-call-tool.test.d.ts → server/auth/providers/clerk.test.d.ts} +0 -0
  542. /package/dist/{src/web/hooks/use-display-mode.test.d.ts → server/auth/providers/custom.test.d.ts} +0 -0
  543. /package/dist/{src/web/hooks/use-files.test.d.ts → server/auth/providers/descope.test.d.ts} +0 -0
  544. /package/dist/{src/web/hooks/use-locale.test.d.ts → server/auth/providers/shared.test.d.ts} +0 -0
  545. /package/dist/{src/web/hooks/use-open-external.test.d.ts → server/auth/setup.test.d.ts} +0 -0
  546. /package/dist/{src/web/hooks/use-request-modal.test.d.ts → server/auth/verify.test.d.ts} +0 -0
  547. /package/dist/{src/web/hooks/use-theme.test.d.ts → server/build-manifest.test.d.ts} +0 -0
  548. /package/dist/{src/web/hooks/use-tool-info.test-d.d.ts → server/content-helpers.test.d.ts} +0 -0
  549. /package/dist/{src/web/hooks/use-tool-info.test.d.ts → server/express.test.d.ts} +0 -0
  550. /package/dist/{src/server → server}/inferUtilityTypes.js +0 -0
  551. /package/dist/{src/web/hooks/use-user-agent.test.d.ts → server/middleware.test-d.d.ts} +0 -0
  552. /package/dist/{src/web/hooks/use-widget-state.test.d.ts → server/middleware.test.d.ts} +0 -0
  553. /package/dist/{src/web/plugin/data-llm.test.d.ts → server/tunnel-proxy-router.test.d.ts} +0 -0
  554. /package/dist/{src/web/plugin/transform-data-llm.test.d.ts → server/view-name.test-d.d.ts} +0 -0
  555. /package/dist/{src/web → web}/generate-helpers.test.js +0 -0
  556. /package/dist/{src/web → web}/hooks/use-call-tool.test-d.js +0 -0
  557. /package/dist/{src/web → web}/plugin/data-llm.test.js +0 -0
  558. /package/dist/{src/web → web}/plugin/transform-data-llm.d.ts +0 -0
  559. /package/dist/{src/web → web}/plugin/transform-data-llm.test.js +0 -0
  560. /package/dist/{src/web → web}/proxy.d.ts +0 -0
@@ -0,0 +1,49 @@
1
+ import { useHostContext } from "../bridges/index.js";
2
+ function deriveStatus(output, responseMetadata) {
3
+ if (output === null && responseMetadata === null) {
4
+ return "pending";
5
+ }
6
+ return "success";
7
+ }
8
+ /**
9
+ * Access the tool invocation that produced the current view: its `input`,
10
+ * resulting `output`, and `responseMetadata`. The shape evolves as the tool
11
+ * runs (pending → success), exposed through {@link ToolState}.
12
+ *
13
+ * For full input/output typing per tool name, prefer the typed `useToolInfo`
14
+ * returned by {@link generateHelpers} over the generic form.
15
+ *
16
+ * @typeParam TS - Optional partial shape `{ input, output, responseMetadata }`
17
+ * to refine each field's type. When omitted, each typed field resolves to
18
+ * `never` — pass an explicit shape or use the typed helper from
19
+ * {@link generateHelpers} to get usable types.
20
+ *
21
+ * @example
22
+ * ```tsx
23
+ * const { isSuccess, input, output } = useToolInfo<{
24
+ * input: { query: string };
25
+ * output: { results: Result[] };
26
+ * }>();
27
+ *
28
+ * if (!isSuccess || !output) return <Skeleton />;
29
+ * return <Results items={output.results} />;
30
+ * ```
31
+ *
32
+ * @see https://docs.skybridge.tech/api-reference/use-tool-info
33
+ */
34
+ export function useToolInfo() {
35
+ const input = useHostContext("toolInput");
36
+ const output = useHostContext("toolOutput");
37
+ const responseMetadata = useHostContext("toolResponseMetadata");
38
+ const status = deriveStatus(output, responseMetadata);
39
+ return {
40
+ input: input ?? undefined,
41
+ status,
42
+ isIdle: false,
43
+ isPending: status === "pending",
44
+ isSuccess: status === "success",
45
+ output,
46
+ responseMetadata,
47
+ };
48
+ }
49
+ //# sourceMappingURL=use-tool-info.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-tool-info.js","sourceRoot":"","sources":["../../../src/web/hooks/use-tool-info.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AA6ErD,SAAS,YAAY,CACnB,MAAsC,EACtC,gBAAgD;IAEhD,IAAI,MAAM,KAAK,IAAI,IAAI,gBAAgB,KAAK,IAAI,EAAE,CAAC;QACjD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,WAAW;IAGzB,MAAM,KAAK,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC;IAC5C,MAAM,gBAAgB,GAAG,cAAc,CAAC,sBAAsB,CAAC,CAAC;IAEhE,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAMtD,OAAO;QACL,KAAK,EAAE,KAAK,IAAI,SAAS;QACzB,MAAM;QACN,MAAM,EAAE,KAAK;QACb,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,MAAM;QACN,gBAAgB;KACqB,CAAC;AAC1C,CAAC","sourcesContent":["import { useHostContext } from \"../bridges/index.js\";\nimport type { UnknownObject } from \"../types.js\";\n\n/**\n * {@link useToolInfo} state before the tool has been invoked.\n *\n * @deprecated `useToolInfo` no longer returns the idle state — it starts in\n * `\"pending\"` and transitions to `\"success\"`, so `isIdle` is always `false` at\n * runtime. This type is retained in {@link ToolState} for backwards\n * compatibility and will be removed in the next major.\n */\nexport type ToolIdleState = {\n status: \"idle\";\n isIdle: true;\n isPending: false;\n isSuccess: false;\n input: undefined;\n output: undefined;\n responseMetadata: undefined;\n};\n\n/**\n * {@link useToolInfo} state while the tool is executing — `output` is not yet\n * available.\n *\n * `input` is optional: the host may render the view before delivering the\n * tool arguments.\n */\nexport type ToolPendingState<ToolInput extends UnknownObject> = {\n status: \"pending\";\n isIdle: false;\n isPending: true;\n isSuccess: false;\n input: ToolInput | undefined;\n output: undefined;\n responseMetadata: undefined;\n};\n\n/**\n * {@link useToolInfo} state once the tool returned — `output` is available.\n *\n * `input` is optional: the host may not have surfaced the tool arguments by\n * the time `output` arrives.\n */\nexport type ToolSuccessState<\n ToolInput extends UnknownObject,\n ToolOutput extends UnknownObject,\n ToolResponseMetadata extends UnknownObject,\n> = {\n status: \"success\";\n isIdle: false;\n isPending: false;\n isSuccess: true;\n input: ToolInput | undefined;\n output: ToolOutput;\n responseMetadata: ToolResponseMetadata;\n};\n\n/**\n * Discriminated union describing the tool invocation that triggered the\n * current view render. Use `isPending` / `isSuccess` to narrow.\n */\nexport type ToolState<\n ToolInput extends UnknownObject,\n ToolOutput extends UnknownObject,\n ToolResponseMetadata extends UnknownObject,\n> =\n | ToolIdleState\n | ToolPendingState<ToolInput>\n | ToolSuccessState<ToolInput, ToolOutput, ToolResponseMetadata>;\n\ntype ToolSignature = {\n input: UnknownObject;\n output: UnknownObject;\n responseMetadata: UnknownObject;\n};\n\nfunction deriveStatus(\n output: Record<string, unknown> | null,\n responseMetadata: Record<string, unknown> | null,\n): \"pending\" | \"success\" {\n if (output === null && responseMetadata === null) {\n return \"pending\";\n }\n return \"success\";\n}\n\n/**\n * Access the tool invocation that produced the current view: its `input`,\n * resulting `output`, and `responseMetadata`. The shape evolves as the tool\n * runs (pending → success), exposed through {@link ToolState}.\n *\n * For full input/output typing per tool name, prefer the typed `useToolInfo`\n * returned by {@link generateHelpers} over the generic form.\n *\n * @typeParam TS - Optional partial shape `{ input, output, responseMetadata }`\n * to refine each field's type. When omitted, each typed field resolves to\n * `never` — pass an explicit shape or use the typed helper from\n * {@link generateHelpers} to get usable types.\n *\n * @example\n * ```tsx\n * const { isSuccess, input, output } = useToolInfo<{\n * input: { query: string };\n * output: { results: Result[] };\n * }>();\n *\n * if (!isSuccess || !output) return <Skeleton />;\n * return <Results items={output.results} />;\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-tool-info\n */\nexport function useToolInfo<\n TS extends Partial<ToolSignature> = Record<string, never>,\n>() {\n const input = useHostContext(\"toolInput\");\n const output = useHostContext(\"toolOutput\");\n const responseMetadata = useHostContext(\"toolResponseMetadata\");\n\n const status = deriveStatus(output, responseMetadata);\n\n type Input = UnknownObject & TS[\"input\"];\n type Output = UnknownObject & TS[\"output\"];\n type Metadata = UnknownObject & TS[\"responseMetadata\"];\n\n return {\n input: input ?? undefined,\n status,\n isIdle: false,\n isPending: status === \"pending\",\n isSuccess: status === \"success\",\n output,\n responseMetadata,\n } as ToolState<Input, Output, Metadata>;\n}\n"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -6,41 +6,50 @@ test("useToolInfo - TypeScript typing", () => {
6
6
  expectTypeOf(result.status);
7
7
  expectTypeOf(result.isPending);
8
8
  expectTypeOf(result.isSuccess);
9
+ expectTypeOf(result.isIdle);
9
10
  expectTypeOf(result.input);
10
11
  });
11
12
  test("should correctly type input, output, and responseMetadata with explicit ToolSignature", () => {
12
13
  const result = useToolInfo();
13
- expectTypeOf(result.input);
14
- // When pending, output and responseMetadata should be undefined
14
+ // When pending, input may be undefined (host hasn't delivered args yet,
15
+ // or the tool has no input schema)
15
16
  if (result.status === "pending") {
17
+ expectTypeOf(result.input);
16
18
  expectTypeOf(result.output);
17
19
  expectTypeOf(result.responseMetadata);
18
20
  }
19
- // When success, output and responseMetadata should be defined
21
+ // When success, output and responseMetadata are defined; input may still
22
+ // be undefined if the host hasn't surfaced the tool arguments
20
23
  if (result.status === "success") {
24
+ expectTypeOf(result.input);
21
25
  expectTypeOf(result.output);
22
26
  expectTypeOf(result.responseMetadata);
23
27
  }
24
28
  });
25
29
  test("should correctly narrow types based on status discriminated union", () => {
26
30
  const result = useToolInfo();
27
- // Test type narrowing
31
+ // Test type narrowing for pending
28
32
  if (result.isPending) {
29
33
  expectTypeOf(result.status);
34
+ expectTypeOf(result.isIdle);
30
35
  expectTypeOf(result.isPending);
31
36
  expectTypeOf(result.isSuccess);
37
+ expectTypeOf(result.input);
32
38
  expectTypeOf(result.output);
33
39
  expectTypeOf(result.responseMetadata);
34
40
  }
35
41
  if (result.isSuccess) {
36
42
  expectTypeOf(result.status);
43
+ expectTypeOf(result.isIdle);
37
44
  expectTypeOf(result.isPending);
38
45
  expectTypeOf(result.isSuccess);
46
+ expectTypeOf(result.input);
39
47
  expectTypeOf(result.output);
40
48
  expectTypeOf(result.responseMetadata);
41
49
  }
42
50
  if (result.status === "pending") {
43
51
  expectTypeOf(result.input);
52
+ expectTypeOf(result.isIdle);
44
53
  expectTypeOf(result.isPending);
45
54
  expectTypeOf(result.isSuccess);
46
55
  expectTypeOf(result.output);
@@ -48,6 +57,7 @@ test("useToolInfo - TypeScript typing", () => {
48
57
  }
49
58
  if (result.status === "success") {
50
59
  expectTypeOf(result.input);
60
+ expectTypeOf(result.isIdle);
51
61
  expectTypeOf(result.isPending);
52
62
  expectTypeOf(result.isSuccess);
53
63
  expectTypeOf(result.output);
@@ -56,16 +66,24 @@ test("useToolInfo - TypeScript typing", () => {
56
66
  });
57
67
  test("should handle partial ToolSignature with only input specified", () => {
58
68
  const result = useToolInfo();
59
- expectTypeOf(result.input);
69
+ // Input is optional in both states — undefined while args haven't arrived
70
+ // (pending) and for no-input tools (success).
71
+ if (result.status === "pending") {
72
+ expectTypeOf(result.input);
73
+ }
60
74
  if (result.status === "success") {
75
+ expectTypeOf(result.input);
61
76
  expectTypeOf(result.output);
62
77
  expectTypeOf(result.responseMetadata);
63
78
  }
64
79
  });
65
80
  test("should handle ToolSignature with only output specified", () => {
66
81
  const result = useToolInfo();
67
- expectTypeOf(result.input);
82
+ if (result.status === "pending") {
83
+ expectTypeOf(result.input);
84
+ }
68
85
  if (result.status === "success") {
86
+ expectTypeOf(result.input);
69
87
  expectTypeOf(result.output);
70
88
  }
71
89
  });
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-tool-info.test-d.js","sourceRoot":"","sources":["../../../src/web/hooks/use-tool-info.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,IAAI,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC3C,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;QAC3E,MAAM,MAAM,GAAG,WAAW,EAAE,CAAC;QAE7B,YAAY,CAAiC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5D,YAAY,CAAU,MAAM,CAAC,SAAS,CAAC,CAAC;QACxC,YAAY,CAAU,MAAM,CAAC,SAAS,CAAC,CAAC;QACxC,YAAY,CAAU,MAAM,CAAC,MAAM,CAAC,CAAC;QACrC,YAAY,CAAsC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uFAAuF,EAAE,GAAG,EAAE;QAKjG,MAAM,MAAM,GAAG,WAAW,EAItB,CAAC;QAEL,wEAAwE;QACxE,mCAAmC;QACnC,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAAwB,MAAM,CAAC,KAAK,CAAC,CAAC;YAClD,YAAY,CAAY,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,YAAY,CAAY,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACnD,CAAC;QAED,yEAAyE;QACzE,8DAA8D;QAC9D,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAAwB,MAAM,CAAC,KAAK,CAAC,CAAC;YAClD,YAAY,CAAa,MAAM,CAAC,MAAM,CAAC,CAAC;YACxC,YAAY,CAAe,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACtD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAK7E,MAAM,MAAM,GAAG,WAAW,EAItB,CAAC;QAEL,kCAAkC;QAClC,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACrB,YAAY,CAAY,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,YAAY,CAAQ,MAAM,CAAC,MAAM,CAAC,CAAC;YACnC,YAAY,CAAO,MAAM,CAAC,SAAS,CAAC,CAAC;YACrC,YAAY,CAAQ,MAAM,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAwB,MAAM,CAAC,KAAK,CAAC,CAAC;YAClD,YAAY,CAAY,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,YAAY,CAAY,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACnD,CAAC;QAED,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACrB,YAAY,CAAY,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,YAAY,CAAQ,MAAM,CAAC,MAAM,CAAC,CAAC;YACnC,YAAY,CAAQ,MAAM,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAO,MAAM,CAAC,SAAS,CAAC,CAAC;YACrC,YAAY,CAAwB,MAAM,CAAC,KAAK,CAAC,CAAC;YAClD,YAAY,CAAa,MAAM,CAAC,MAAM,CAAC,CAAC;YACxC,YAAY,CAAe,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAAwB,MAAM,CAAC,KAAK,CAAC,CAAC;YAClD,YAAY,CAAQ,MAAM,CAAC,MAAM,CAAC,CAAC;YACnC,YAAY,CAAO,MAAM,CAAC,SAAS,CAAC,CAAC;YACrC,YAAY,CAAQ,MAAM,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAY,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,YAAY,CAAY,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACnD,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAAwB,MAAM,CAAC,KAAK,CAAC,CAAC;YAClD,YAAY,CAAQ,MAAM,CAAC,MAAM,CAAC,CAAC;YACnC,YAAY,CAAQ,MAAM,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAO,MAAM,CAAC,SAAS,CAAC,CAAC;YACrC,YAAY,CAAa,MAAM,CAAC,MAAM,CAAC,CAAC;YACxC,YAAY,CAAe,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACtD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;QAGzE,MAAM,MAAM,GAAG,WAAW,EAEtB,CAAC;QAEL,0EAA0E;QAC1E,8CAA8C;QAC9C,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAAwB,MAAM,CAAC,KAAK,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAAwB,MAAM,CAAC,KAAK,CAAC,CAAC;YAClD,YAAY,CAA0B,MAAM,CAAC,MAAM,CAAC,CAAC;YACrD,YAAY,CAA0B,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACjE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAGlE,MAAM,MAAM,GAAG,WAAW,EAEtB,CAAC;QAEL,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAAsC,MAAM,CAAC,KAAK,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAAsC,MAAM,CAAC,KAAK,CAAC,CAAC;YAChE,YAAY,CAAa,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { expectTypeOf, test } from \"vitest\";\nimport { useToolInfo } from \"./use-tool-info.js\";\n\ntest(\"useToolInfo - TypeScript typing\", () => {\n test(\"should have correct types when no generic parameter is provided\", () => {\n const result = useToolInfo();\n\n expectTypeOf<\"idle\" | \"pending\" | \"success\">(result.status);\n expectTypeOf<boolean>(result.isPending);\n expectTypeOf<boolean>(result.isSuccess);\n expectTypeOf<boolean>(result.isIdle);\n expectTypeOf<Record<string, unknown> | undefined>(result.input);\n });\n\n test(\"should correctly type input, output, and responseMetadata with explicit ToolSignature\", () => {\n type TestInput = { name: string; args: { name: string } };\n type TestOutput = { name: string; color: string };\n type TestMetadata = { id: number };\n\n const result = useToolInfo<{\n input: TestInput;\n output: TestOutput;\n responseMetadata: TestMetadata;\n }>();\n\n // When pending, input may be undefined (host hasn't delivered args yet,\n // or the tool has no input schema)\n if (result.status === \"pending\") {\n expectTypeOf<TestInput | undefined>(result.input);\n expectTypeOf<undefined>(result.output);\n expectTypeOf<undefined>(result.responseMetadata);\n }\n\n // When success, output and responseMetadata are defined; input may still\n // be undefined if the host hasn't surfaced the tool arguments\n if (result.status === \"success\") {\n expectTypeOf<TestInput | undefined>(result.input);\n expectTypeOf<TestOutput>(result.output);\n expectTypeOf<TestMetadata>(result.responseMetadata);\n }\n });\n\n test(\"should correctly narrow types based on status discriminated union\", () => {\n type TestInput = { query: string };\n type TestOutput = { result: string };\n type TestMetadata = { timestamp: number };\n\n const result = useToolInfo<{\n input: TestInput;\n output: TestOutput;\n responseMetadata: TestMetadata;\n }>();\n\n // Test type narrowing for pending\n if (result.isPending) {\n expectTypeOf<\"pending\">(result.status);\n expectTypeOf<false>(result.isIdle);\n expectTypeOf<true>(result.isPending);\n expectTypeOf<false>(result.isSuccess);\n expectTypeOf<TestInput | undefined>(result.input);\n expectTypeOf<undefined>(result.output);\n expectTypeOf<undefined>(result.responseMetadata);\n }\n\n if (result.isSuccess) {\n expectTypeOf<\"success\">(result.status);\n expectTypeOf<false>(result.isIdle);\n expectTypeOf<false>(result.isPending);\n expectTypeOf<true>(result.isSuccess);\n expectTypeOf<TestInput | undefined>(result.input);\n expectTypeOf<TestOutput>(result.output);\n expectTypeOf<TestMetadata>(result.responseMetadata);\n }\n\n if (result.status === \"pending\") {\n expectTypeOf<TestInput | undefined>(result.input);\n expectTypeOf<false>(result.isIdle);\n expectTypeOf<true>(result.isPending);\n expectTypeOf<false>(result.isSuccess);\n expectTypeOf<undefined>(result.output);\n expectTypeOf<undefined>(result.responseMetadata);\n }\n\n if (result.status === \"success\") {\n expectTypeOf<TestInput | undefined>(result.input);\n expectTypeOf<false>(result.isIdle);\n expectTypeOf<false>(result.isPending);\n expectTypeOf<true>(result.isSuccess);\n expectTypeOf<TestOutput>(result.output);\n expectTypeOf<TestMetadata>(result.responseMetadata);\n }\n });\n\n test(\"should handle partial ToolSignature with only input specified\", () => {\n type TestInput = { id: number };\n\n const result = useToolInfo<{\n input: TestInput;\n }>();\n\n // Input is optional in both states — undefined while args haven't arrived\n // (pending) and for no-input tools (success).\n if (result.status === \"pending\") {\n expectTypeOf<TestInput | undefined>(result.input);\n }\n\n if (result.status === \"success\") {\n expectTypeOf<TestInput | undefined>(result.input);\n expectTypeOf<Record<string, unknown>>(result.output);\n expectTypeOf<Record<string, unknown>>(result.responseMetadata);\n }\n });\n\n test(\"should handle ToolSignature with only output specified\", () => {\n type TestOutput = { data: string[] };\n\n const result = useToolInfo<{\n output: TestOutput;\n }>();\n\n if (result.status === \"pending\") {\n expectTypeOf<Record<string, unknown> | undefined>(result.input);\n }\n\n if (result.status === \"success\") {\n expectTypeOf<Record<string, unknown> | undefined>(result.input);\n expectTypeOf<TestOutput>(result.output);\n }\n });\n});\n"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,140 @@
1
+ import { act, renderHook, waitFor } from "@testing-library/react";
2
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
3
+ import { HostAdaptor } from "../bridges/adaptor.js";
4
+ import { McpAppBridge } from "../bridges/mcp-app/index.js";
5
+ import { fireToolInputNotification, fireToolResultNotification, getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
6
+ import { useToolInfo } from "./use-tool-info.js";
7
+ describe("useToolInfo", () => {
8
+ describe("apps-sdk host", () => {
9
+ beforeEach(() => {
10
+ vi.stubGlobal("parent", { postMessage: getMcpAppHostPostMessageMock() });
11
+ vi.stubGlobal("openai", {
12
+ toolInput: null,
13
+ toolOutput: null,
14
+ toolResponseMetadata: null,
15
+ });
16
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
17
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
18
+ });
19
+ afterEach(() => {
20
+ HostAdaptor.resetInstance();
21
+ vi.unstubAllGlobals();
22
+ vi.resetAllMocks();
23
+ McpAppBridge.resetInstance();
24
+ });
25
+ it("should return pending state with tool input from tool-input notification", async () => {
26
+ const { result } = renderHook(() => useToolInfo());
27
+ act(() => {
28
+ fireToolInputNotification({
29
+ name: "pokemon",
30
+ args: { name: "pikachu" },
31
+ });
32
+ });
33
+ await waitFor(() => {
34
+ expect(result.current).toMatchObject({
35
+ input: { name: "pokemon", args: { name: "pikachu" } },
36
+ status: "pending",
37
+ isIdle: false,
38
+ isPending: true,
39
+ isSuccess: false,
40
+ });
41
+ });
42
+ });
43
+ it("should return success state once tool-result notification arrives", async () => {
44
+ const toolOutput = {
45
+ name: "pikachu",
46
+ color: "yellow",
47
+ description: "When several of these POKéMON gather, their\felectricity could build and cause lightning storms.",
48
+ };
49
+ const toolResponseMetadata = { id: 12 };
50
+ const { result } = renderHook(() => useToolInfo());
51
+ act(() => {
52
+ fireToolInputNotification({
53
+ name: "pokemon",
54
+ args: { name: "pikachu" },
55
+ });
56
+ fireToolResultNotification({
57
+ content: [{ type: "text", text: JSON.stringify(toolOutput) }],
58
+ structuredContent: toolOutput,
59
+ _meta: toolResponseMetadata,
60
+ });
61
+ });
62
+ await waitFor(() => {
63
+ expect(result.current).toMatchObject({
64
+ status: "success",
65
+ isIdle: false,
66
+ isPending: false,
67
+ isSuccess: true,
68
+ output: toolOutput,
69
+ responseMetadata: toolResponseMetadata,
70
+ });
71
+ });
72
+ });
73
+ });
74
+ describe("mcp-app host", () => {
75
+ beforeEach(() => {
76
+ vi.stubGlobal("parent", { postMessage: getMcpAppHostPostMessageMock() });
77
+ vi.stubGlobal("skybridge", { hostType: "mcp-app" });
78
+ vi.stubGlobal("openai", undefined);
79
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
80
+ });
81
+ afterEach(async () => {
82
+ HostAdaptor.resetInstance();
83
+ vi.unstubAllGlobals();
84
+ vi.resetAllMocks();
85
+ McpAppBridge.resetInstance();
86
+ });
87
+ it("should return pending state with undefined input before tool-input notification arrives", async () => {
88
+ const { result } = renderHook(() => useToolInfo());
89
+ await waitFor(() => {
90
+ expect(result.current).toMatchObject({
91
+ status: "pending",
92
+ isIdle: false,
93
+ isPending: true,
94
+ isSuccess: false,
95
+ input: undefined,
96
+ output: null,
97
+ responseMetadata: null,
98
+ });
99
+ });
100
+ });
101
+ it("should return pending state with tool input from tool-input notification", async () => {
102
+ const { result } = renderHook(() => useToolInfo());
103
+ act(() => {
104
+ fireToolInputNotification({ name: "pokemon", query: "pikachu" });
105
+ });
106
+ await waitFor(() => {
107
+ expect(result.current).toMatchObject({
108
+ status: "pending",
109
+ isIdle: false,
110
+ isPending: true,
111
+ isSuccess: false,
112
+ input: { name: "pokemon", query: "pikachu" },
113
+ });
114
+ });
115
+ });
116
+ it("should return success state with output from tool-result notification", async () => {
117
+ const { result } = renderHook(() => useToolInfo());
118
+ act(() => {
119
+ fireToolInputNotification({ name: "pokemon", query: "pikachu" });
120
+ fireToolResultNotification({
121
+ content: [{ type: "text", text: "Pikachu data" }],
122
+ structuredContent: { name: "pikachu", color: "yellow" },
123
+ _meta: { requestId: "123" },
124
+ });
125
+ });
126
+ await waitFor(() => {
127
+ expect(result.current).toMatchObject({
128
+ status: "success",
129
+ isIdle: false,
130
+ isPending: false,
131
+ isSuccess: true,
132
+ input: { name: "pokemon", query: "pikachu" },
133
+ output: { name: "pikachu", color: "yellow" },
134
+ responseMetadata: { requestId: "123" },
135
+ });
136
+ });
137
+ });
138
+ });
139
+ });
140
+ //# sourceMappingURL=use-tool-info.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-tool-info.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-tool-info.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EACL,yBAAyB,EACzB,0BAA0B,EAC1B,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,4BAA4B,EAAE,EAAE,CAAC,CAAC;YACzE,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,SAAS,EAAE,IAAI;gBACf,UAAU,EAAE,IAAI;gBAChB,oBAAoB,EAAE,IAAI;aAC3B,CAAC,CAAC;YACH,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;YACrD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;YACxF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,GAAG,CAAC,GAAG,EAAE;gBACP,yBAAyB,CAAC;oBACxB,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;iBAC1B,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;oBACrD,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,IAAI;oBACf,SAAS,EAAE,KAAK;iBACjB,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;YACjF,MAAM,UAAU,GAAG;gBACjB,IAAI,EAAE,SAAS;gBACf,KAAK,EAAE,QAAQ;gBACf,WAAW,EACT,kGAAkG;aACrG,CAAC;YACF,MAAM,oBAAoB,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;YACxC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,GAAG,CAAC,GAAG,EAAE;gBACP,yBAAyB,CAAC;oBACxB,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;iBAC1B,CAAC,CAAC;gBACH,0BAA0B,CAAC;oBACzB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC7D,iBAAiB,EAAE,UAAU;oBAC7B,KAAK,EAAE,oBAAoB;iBAC5B,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,KAAK;oBAChB,SAAS,EAAE,IAAI;oBACf,MAAM,EAAE,UAAU;oBAClB,gBAAgB,EAAE,oBAAoB;iBACvC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,4BAA4B,EAAE,EAAE,CAAC,CAAC;YACzE,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;YACpD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACnC,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yFAAyF,EAAE,KAAK,IAAI,EAAE;YACvG,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,IAAI;oBACf,SAAS,EAAE,KAAK;oBAChB,KAAK,EAAE,SAAS;oBAChB,MAAM,EAAE,IAAI;oBACZ,gBAAgB,EAAE,IAAI;iBACvB,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;YACxF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,GAAG,CAAC,GAAG,EAAE;gBACP,yBAAyB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YACnE,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,IAAI;oBACf,SAAS,EAAE,KAAK;oBAChB,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;iBAC7C,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;YACrF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,GAAG,CAAC,GAAG,EAAE;gBACP,yBAAyB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;gBACjE,0BAA0B,CAAC;oBACzB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;oBACjD,iBAAiB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE;oBACvD,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE;iBAC5B,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,KAAK;oBAChB,SAAS,EAAE,IAAI;oBACf,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;oBAC5C,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE;oBAC5C,gBAAgB,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE;iBACvC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { act, renderHook, waitFor } from \"@testing-library/react\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { HostAdaptor } from \"../bridges/adaptor.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/index.js\";\nimport {\n fireToolInputNotification,\n fireToolResultNotification,\n getMcpAppHostPostMessageMock,\n MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useToolInfo } from \"./use-tool-info.js\";\n\ndescribe(\"useToolInfo\", () => {\n describe(\"apps-sdk host\", () => {\n beforeEach(() => {\n vi.stubGlobal(\"parent\", { postMessage: getMcpAppHostPostMessageMock() });\n vi.stubGlobal(\"openai\", {\n toolInput: null,\n toolOutput: null,\n toolResponseMetadata: null,\n });\n vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n });\n\n afterEach(() => {\n HostAdaptor.resetInstance();\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n McpAppBridge.resetInstance();\n });\n\n it(\"should return pending state with tool input from tool-input notification\", async () => {\n const { result } = renderHook(() => useToolInfo());\n\n act(() => {\n fireToolInputNotification({\n name: \"pokemon\",\n args: { name: \"pikachu\" },\n });\n });\n\n await waitFor(() => {\n expect(result.current).toMatchObject({\n input: { name: \"pokemon\", args: { name: \"pikachu\" } },\n status: \"pending\",\n isIdle: false,\n isPending: true,\n isSuccess: false,\n });\n });\n });\n\n it(\"should return success state once tool-result notification arrives\", async () => {\n const toolOutput = {\n name: \"pikachu\",\n color: \"yellow\",\n description:\n \"When several of these POKéMON gather, their\\felectricity could build and cause lightning storms.\",\n };\n const toolResponseMetadata = { id: 12 };\n const { result } = renderHook(() => useToolInfo());\n\n act(() => {\n fireToolInputNotification({\n name: \"pokemon\",\n args: { name: \"pikachu\" },\n });\n fireToolResultNotification({\n content: [{ type: \"text\", text: JSON.stringify(toolOutput) }],\n structuredContent: toolOutput,\n _meta: toolResponseMetadata,\n });\n });\n\n await waitFor(() => {\n expect(result.current).toMatchObject({\n status: \"success\",\n isIdle: false,\n isPending: false,\n isSuccess: true,\n output: toolOutput,\n responseMetadata: toolResponseMetadata,\n });\n });\n });\n });\n\n describe(\"mcp-app host\", () => {\n beforeEach(() => {\n vi.stubGlobal(\"parent\", { postMessage: getMcpAppHostPostMessageMock() });\n vi.stubGlobal(\"skybridge\", { hostType: \"mcp-app\" });\n vi.stubGlobal(\"openai\", undefined);\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n });\n\n afterEach(async () => {\n HostAdaptor.resetInstance();\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n McpAppBridge.resetInstance();\n });\n\n it(\"should return pending state with undefined input before tool-input notification arrives\", async () => {\n const { result } = renderHook(() => useToolInfo());\n\n await waitFor(() => {\n expect(result.current).toMatchObject({\n status: \"pending\",\n isIdle: false,\n isPending: true,\n isSuccess: false,\n input: undefined,\n output: null,\n responseMetadata: null,\n });\n });\n });\n\n it(\"should return pending state with tool input from tool-input notification\", async () => {\n const { result } = renderHook(() => useToolInfo());\n\n act(() => {\n fireToolInputNotification({ name: \"pokemon\", query: \"pikachu\" });\n });\n\n await waitFor(() => {\n expect(result.current).toMatchObject({\n status: \"pending\",\n isIdle: false,\n isPending: true,\n isSuccess: false,\n input: { name: \"pokemon\", query: \"pikachu\" },\n });\n });\n });\n\n it(\"should return success state with output from tool-result notification\", async () => {\n const { result } = renderHook(() => useToolInfo());\n\n act(() => {\n fireToolInputNotification({ name: \"pokemon\", query: \"pikachu\" });\n fireToolResultNotification({\n content: [{ type: \"text\", text: \"Pikachu data\" }],\n structuredContent: { name: \"pikachu\", color: \"yellow\" },\n _meta: { requestId: \"123\" },\n });\n });\n\n await waitFor(() => {\n expect(result.current).toMatchObject({\n status: \"success\",\n isIdle: false,\n isPending: false,\n isSuccess: true,\n input: { name: \"pokemon\", query: \"pikachu\" },\n output: { name: \"pikachu\", color: \"yellow\" },\n responseMetadata: { requestId: \"123\" },\n });\n });\n });\n });\n});\n"]}
@@ -0,0 +1,20 @@
1
+ import { type UserAgent } from "../bridges/index.js";
2
+ export type UserState = {
3
+ locale: string;
4
+ userAgent: UserAgent;
5
+ };
6
+ /**
7
+ * Hook for accessing session-stable user information.
8
+ * These values are set once at initialization and do not change during the session.
9
+ *
10
+ * @example
11
+ * ```tsx
12
+ * const { locale, userAgent } = useUser();
13
+ *
14
+ * // Access device type
15
+ * const isMobile = userAgent.device.type === "mobile";
16
+ * ```
17
+ *
18
+ * @see https://docs.skybridge.tech/api-reference/use-user
19
+ */
20
+ export declare function useUser(): UserState;
@@ -0,0 +1,37 @@
1
+ import { useHostContext } from "../bridges/index.js";
2
+ const DEFAULT_LOCALE = "en-US";
3
+ /**
4
+ * Normalizes a locale string to canonical BCP 47 format using {@link Intl.Locale}.
5
+ *
6
+ * Handles underscored identifiers returned by the ChatGPT mobile app (e.g. "fr_FR" → "fr-FR"),
7
+ * incorrect casing (e.g. "en-us" → "en-US"), and complex subtags (e.g. "zh_Hans_CN" → "zh-Hans-CN").
8
+ * Falls back to "en-US" if the locale is invalid.
9
+ */
10
+ function normalizeLocale(locale) {
11
+ try {
12
+ return new Intl.Locale(locale.replace(/_/g, "-")).toString();
13
+ }
14
+ catch {
15
+ return DEFAULT_LOCALE;
16
+ }
17
+ }
18
+ /**
19
+ * Hook for accessing session-stable user information.
20
+ * These values are set once at initialization and do not change during the session.
21
+ *
22
+ * @example
23
+ * ```tsx
24
+ * const { locale, userAgent } = useUser();
25
+ *
26
+ * // Access device type
27
+ * const isMobile = userAgent.device.type === "mobile";
28
+ * ```
29
+ *
30
+ * @see https://docs.skybridge.tech/api-reference/use-user
31
+ */
32
+ export function useUser() {
33
+ const rawLocale = useHostContext("locale");
34
+ const userAgent = useHostContext("userAgent");
35
+ return { locale: normalizeLocale(rawLocale), userAgent };
36
+ }
37
+ //# sourceMappingURL=use-user.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-user.js","sourceRoot":"","sources":["../../../src/web/hooks/use-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAOrE,MAAM,cAAc,GAAG,OAAO,CAAC;AAE/B;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,MAAc;IACrC,IAAI,CAAC;QACH,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,cAAc,CAAC;IACxB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,OAAO;IACrB,MAAM,SAAS,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;IAE9C,OAAO,EAAE,MAAM,EAAE,eAAe,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC;AAC3D,CAAC","sourcesContent":["import { type UserAgent, useHostContext } from \"../bridges/index.js\";\n\nexport type UserState = {\n locale: string;\n userAgent: UserAgent;\n};\n\nconst DEFAULT_LOCALE = \"en-US\";\n\n/**\n * Normalizes a locale string to canonical BCP 47 format using {@link Intl.Locale}.\n *\n * Handles underscored identifiers returned by the ChatGPT mobile app (e.g. \"fr_FR\" → \"fr-FR\"),\n * incorrect casing (e.g. \"en-us\" → \"en-US\"), and complex subtags (e.g. \"zh_Hans_CN\" → \"zh-Hans-CN\").\n * Falls back to \"en-US\" if the locale is invalid.\n */\nfunction normalizeLocale(locale: string): string {\n try {\n return new Intl.Locale(locale.replace(/_/g, \"-\")).toString();\n } catch {\n return DEFAULT_LOCALE;\n }\n}\n\n/**\n * Hook for accessing session-stable user information.\n * These values are set once at initialization and do not change during the session.\n *\n * @example\n * ```tsx\n * const { locale, userAgent } = useUser();\n *\n * // Access device type\n * const isMobile = userAgent.device.type === \"mobile\";\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-user\n */\nexport function useUser(): UserState {\n const rawLocale = useHostContext(\"locale\");\n const userAgent = useHostContext(\"userAgent\");\n\n return { locale: normalizeLocale(rawLocale), userAgent };\n}\n"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,168 @@
1
+ import { renderHook, waitFor } from "@testing-library/react";
2
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
3
+ import { HostAdaptor } from "../bridges/adaptor.js";
4
+ import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
5
+ import { getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
6
+ import { useUser } from "./use-user.js";
7
+ describe("useUser", () => {
8
+ describe("apps-sdk host type", () => {
9
+ beforeEach(() => {
10
+ HostAdaptor.resetInstance();
11
+ McpAppBridge.resetInstance();
12
+ vi.stubGlobal("openai", { locale: "en-US" });
13
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
14
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
15
+ });
16
+ afterEach(() => {
17
+ vi.unstubAllGlobals();
18
+ vi.resetAllMocks();
19
+ McpAppBridge.resetInstance();
20
+ HostAdaptor.resetInstance();
21
+ });
22
+ it("should return locale and userAgent from mcp host context", async () => {
23
+ vi.stubGlobal("parent", {
24
+ postMessage: getMcpAppHostPostMessageMock({
25
+ locale: "en-US",
26
+ platform: "web",
27
+ deviceCapabilities: { hover: true, touch: false },
28
+ }),
29
+ });
30
+ const { result } = renderHook(() => useUser());
31
+ await waitFor(() => {
32
+ expect(result.current.locale).toBe("en-US");
33
+ expect(result.current.userAgent).toEqual({
34
+ device: { type: "desktop" },
35
+ capabilities: { hover: true, touch: false },
36
+ });
37
+ });
38
+ });
39
+ it("should return mobile userAgent when set to mobile", async () => {
40
+ vi.stubGlobal("parent", {
41
+ postMessage: getMcpAppHostPostMessageMock({
42
+ locale: "en-US",
43
+ platform: "mobile",
44
+ deviceCapabilities: { hover: false, touch: true },
45
+ }),
46
+ });
47
+ const { result } = renderHook(() => useUser());
48
+ await waitFor(() => {
49
+ expect(result.current.userAgent.device.type).toBe("mobile");
50
+ expect(result.current.userAgent.capabilities.touch).toBe(true);
51
+ });
52
+ });
53
+ it("should return different locale when set", async () => {
54
+ vi.stubGlobal("parent", {
55
+ postMessage: getMcpAppHostPostMessageMock({
56
+ locale: "es-ES",
57
+ platform: "web",
58
+ deviceCapabilities: { hover: true, touch: false },
59
+ }),
60
+ });
61
+ const { result } = renderHook(() => useUser());
62
+ await waitFor(() => {
63
+ expect(result.current.locale).toBe("es-ES");
64
+ });
65
+ });
66
+ it("should normalize underscore locale to BCP 47 hyphen format", async () => {
67
+ vi.stubGlobal("parent", {
68
+ postMessage: getMcpAppHostPostMessageMock({
69
+ locale: "fr_FR",
70
+ platform: "web",
71
+ deviceCapabilities: { hover: true, touch: false },
72
+ }),
73
+ });
74
+ const { result } = renderHook(() => useUser());
75
+ await waitFor(() => {
76
+ expect(result.current.locale).toBe("fr-FR");
77
+ });
78
+ });
79
+ it("should canonicalize locale casing", async () => {
80
+ vi.stubGlobal("parent", {
81
+ postMessage: getMcpAppHostPostMessageMock({
82
+ locale: "en-us",
83
+ platform: "web",
84
+ deviceCapabilities: { hover: true, touch: false },
85
+ }),
86
+ });
87
+ const { result } = renderHook(() => useUser());
88
+ await waitFor(() => {
89
+ expect(result.current.locale).toBe("en-US");
90
+ });
91
+ });
92
+ it("should fall back to en-US for invalid locale", async () => {
93
+ vi.stubGlobal("parent", {
94
+ postMessage: getMcpAppHostPostMessageMock({
95
+ locale: "not-a-locale-!!",
96
+ platform: "web",
97
+ deviceCapabilities: { hover: true, touch: false },
98
+ }),
99
+ });
100
+ const { result } = renderHook(() => useUser());
101
+ await waitFor(() => {
102
+ expect(result.current.locale).toBe("en-US");
103
+ });
104
+ });
105
+ });
106
+ describe("mcp-app host type", () => {
107
+ beforeEach(() => {
108
+ HostAdaptor.resetInstance();
109
+ McpAppBridge.resetInstance();
110
+ vi.stubGlobal("openai", undefined);
111
+ vi.stubGlobal("skybridge", { hostType: "mcp-app" });
112
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
113
+ });
114
+ afterEach(async () => {
115
+ vi.unstubAllGlobals();
116
+ vi.resetAllMocks();
117
+ McpAppBridge.resetInstance();
118
+ HostAdaptor.resetInstance();
119
+ });
120
+ it("should return locale and userAgent from mcp host context", async () => {
121
+ vi.stubGlobal("parent", {
122
+ postMessage: getMcpAppHostPostMessageMock({
123
+ locale: "fr-FR",
124
+ platform: "web",
125
+ deviceCapabilities: { hover: true, touch: false },
126
+ }),
127
+ });
128
+ const { result } = renderHook(() => useUser());
129
+ await waitFor(() => {
130
+ expect(result.current.locale).toBe("fr-FR");
131
+ expect(result.current.userAgent).toEqual({
132
+ device: { type: "desktop" },
133
+ capabilities: { hover: true, touch: false },
134
+ });
135
+ });
136
+ });
137
+ it("should normalize underscore locale to BCP 47 hyphen format", async () => {
138
+ vi.stubGlobal("parent", {
139
+ postMessage: getMcpAppHostPostMessageMock({
140
+ locale: "fr_FR",
141
+ platform: "web",
142
+ deviceCapabilities: { hover: true, touch: false },
143
+ }),
144
+ });
145
+ const { result } = renderHook(() => useUser());
146
+ await waitFor(() => {
147
+ expect(result.current.locale).toBe("fr-FR");
148
+ });
149
+ });
150
+ it("should maintain userAgent referential stability when data has not changed", async () => {
151
+ vi.stubGlobal("parent", {
152
+ postMessage: getMcpAppHostPostMessageMock({
153
+ locale: "en-US",
154
+ platform: "web",
155
+ deviceCapabilities: { hover: true, touch: false },
156
+ }),
157
+ });
158
+ const { result, rerender } = renderHook(() => useUser());
159
+ await waitFor(() => {
160
+ expect(result.current.userAgent).toBeDefined();
161
+ });
162
+ const initialUserAgent = result.current.userAgent;
163
+ rerender();
164
+ expect(result.current.userAgent).toBe(initialUserAgent);
165
+ });
166
+ });
167
+ });
168
+ //# sourceMappingURL=use-user.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-user.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-user.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,UAAU,CAAC,GAAG,EAAE;YACd,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;YAC7C,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;YACrD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,WAAW,CAAC,aAAa,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;oBACvC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;oBAC3B,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAC5C,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;YACjE,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,QAAQ;oBAClB,kBAAkB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC5D,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACvD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;YAC1E,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;YACjD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC5D,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,iBAAiB;oBACzB,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,UAAU,CAAC,GAAG,EAAE;YACd,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACnC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;YACpD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,WAAW,CAAC,aAAa,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;oBACvC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;oBAC3B,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAC5C,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;YAC1E,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2EAA2E,EAAE,KAAK,IAAI,EAAE;YACzF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAEzD,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;YACjD,CAAC,CAAC,CAAC;YAEH,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;YAElD,QAAQ,EAAE,CAAC;YAEX,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { renderHook, waitFor } from \"@testing-library/react\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { HostAdaptor } from \"../bridges/adaptor.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/bridge.js\";\nimport {\n getMcpAppHostPostMessageMock,\n MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useUser } from \"./use-user.js\";\n\ndescribe(\"useUser\", () => {\n describe(\"apps-sdk host type\", () => {\n beforeEach(() => {\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n vi.stubGlobal(\"openai\", { locale: \"en-US\" });\n vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n McpAppBridge.resetInstance();\n HostAdaptor.resetInstance();\n });\n\n it(\"should return locale and userAgent from mcp host context\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n locale: \"en-US\",\n platform: \"web\",\n deviceCapabilities: { hover: true, touch: false },\n }),\n });\n const { result } = renderHook(() => useUser());\n\n await waitFor(() => {\n expect(result.current.locale).toBe(\"en-US\");\n expect(result.current.userAgent).toEqual({\n device: { type: \"desktop\" },\n capabilities: { hover: true, touch: false },\n });\n });\n });\n\n it(\"should return mobile userAgent when set to mobile\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n locale: \"en-US\",\n platform: \"mobile\",\n deviceCapabilities: { hover: false, touch: true },\n }),\n });\n const { result } = renderHook(() => useUser());\n\n await waitFor(() => {\n expect(result.current.userAgent.device.type).toBe(\"mobile\");\n expect(result.current.userAgent.capabilities.touch).toBe(true);\n });\n });\n\n it(\"should return different locale when set\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n locale: \"es-ES\",\n platform: \"web\",\n deviceCapabilities: { hover: true, touch: false },\n }),\n });\n const { result } = renderHook(() => useUser());\n\n await waitFor(() => {\n expect(result.current.locale).toBe(\"es-ES\");\n });\n });\n\n it(\"should normalize underscore locale to BCP 47 hyphen format\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n locale: \"fr_FR\",\n platform: \"web\",\n deviceCapabilities: { hover: true, touch: false },\n }),\n });\n const { result } = renderHook(() => useUser());\n\n await waitFor(() => {\n expect(result.current.locale).toBe(\"fr-FR\");\n });\n });\n\n it(\"should canonicalize locale casing\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n locale: \"en-us\",\n platform: \"web\",\n deviceCapabilities: { hover: true, touch: false },\n }),\n });\n const { result } = renderHook(() => useUser());\n\n await waitFor(() => {\n expect(result.current.locale).toBe(\"en-US\");\n });\n });\n\n it(\"should fall back to en-US for invalid locale\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n locale: \"not-a-locale-!!\",\n platform: \"web\",\n deviceCapabilities: { hover: true, touch: false },\n }),\n });\n const { result } = renderHook(() => useUser());\n\n await waitFor(() => {\n expect(result.current.locale).toBe(\"en-US\");\n });\n });\n });\n\n describe(\"mcp-app host type\", () => {\n beforeEach(() => {\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n vi.stubGlobal(\"openai\", undefined);\n vi.stubGlobal(\"skybridge\", { hostType: \"mcp-app\" });\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n });\n\n afterEach(async () => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n McpAppBridge.resetInstance();\n HostAdaptor.resetInstance();\n });\n\n it(\"should return locale and userAgent from mcp host context\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n locale: \"fr-FR\",\n platform: \"web\",\n deviceCapabilities: { hover: true, touch: false },\n }),\n });\n const { result } = renderHook(() => useUser());\n\n await waitFor(() => {\n expect(result.current.locale).toBe(\"fr-FR\");\n expect(result.current.userAgent).toEqual({\n device: { type: \"desktop\" },\n capabilities: { hover: true, touch: false },\n });\n });\n });\n\n it(\"should normalize underscore locale to BCP 47 hyphen format\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n locale: \"fr_FR\",\n platform: \"web\",\n deviceCapabilities: { hover: true, touch: false },\n }),\n });\n const { result } = renderHook(() => useUser());\n\n await waitFor(() => {\n expect(result.current.locale).toBe(\"fr-FR\");\n });\n });\n\n it(\"should maintain userAgent referential stability when data has not changed\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n locale: \"en-US\",\n platform: \"web\",\n deviceCapabilities: { hover: true, touch: false },\n }),\n });\n const { result, rerender } = renderHook(() => useUser());\n\n await waitFor(() => {\n expect(result.current.userAgent).toBeDefined();\n });\n\n const initialUserAgent = result.current.userAgent;\n\n rerender();\n\n expect(result.current.userAgent).toBe(initialUserAgent);\n });\n });\n});\n"]}
@@ -0,0 +1,25 @@
1
+ import { type SetStateAction } from "react";
2
+ import type { UnknownObject } from "../types.js";
3
+ /**
4
+ * Persist a piece of UI state on the host, so it survives view remounts and
5
+ * is restored on subsequent renders of the same tool invocation.
6
+ *
7
+ * Returns a `[state, setState]` pair with the same ergonomics as
8
+ * `useState`. State is filtered to strip Skybridge-internal context fields
9
+ * (see {@link DataLLM}) before being returned to your component.
10
+ *
11
+ * Provide a `defaultState` (value or lazy initializer) to get a non-nullable
12
+ * tuple; omit it for `T | null`.
13
+ *
14
+ * @typeParam T - Shape of the persisted state. Must be a plain object.
15
+ *
16
+ * @example
17
+ * ```tsx
18
+ * const [filters, setFilters] = useViewState({ sort: "newest", page: 1 });
19
+ * setFilters((f) => ({ ...f, page: f.page + 1 }));
20
+ * ```
21
+ *
22
+ * @see https://docs.skybridge.tech/api-reference/use-view-state
23
+ */
24
+ export declare function useViewState<T extends UnknownObject>(defaultState: T | (() => T)): readonly [T, (state: SetStateAction<T>) => void];
25
+ export declare function useViewState<T extends UnknownObject>(defaultState?: T | (() => T | null) | null): readonly [T | null, (state: SetStateAction<T | null>) => void];