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
@@ -1,17 +1,27 @@
1
1
  import { act, renderHook, waitFor } from "@testing-library/react";
2
2
  import { afterEach, beforeEach, describe, expect, expectTypeOf, it, vi, } from "vitest";
3
+ import { HostAdaptor } from "../bridges/adaptor.js";
4
+ import { AppsSdkBridge } from "../bridges/apps-sdk/bridge.js";
5
+ import { getAdaptor } from "../bridges/get-adaptor.js";
6
+ import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
3
7
  import { useCallTool } from "./use-call-tool.js";
4
8
  describe("useCallTool - onSuccess callback", () => {
5
- let OpenaiMock;
9
+ let callToolMock;
6
10
  beforeEach(() => {
7
- OpenaiMock = {
8
- callTool: vi.fn(),
9
- };
10
- vi.stubGlobal("openai", OpenaiMock);
11
+ HostAdaptor.resetInstance();
12
+ McpAppBridge.resetInstance();
13
+ AppsSdkBridge.resetInstance();
14
+ vi.stubGlobal("parent", { postMessage: vi.fn() });
15
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
16
+ vi.stubGlobal("openai", { callTool: vi.fn() });
17
+ callToolMock = vi.spyOn(getAdaptor(), "callTool");
11
18
  });
12
19
  afterEach(() => {
13
20
  vi.unstubAllGlobals();
14
21
  vi.resetAllMocks();
22
+ HostAdaptor.resetInstance();
23
+ McpAppBridge.resetInstance();
24
+ AppsSdkBridge.resetInstance();
15
25
  });
16
26
  const toolName = "test-tool";
17
27
  const args = { input: "test input" };
@@ -19,21 +29,38 @@ describe("useCallTool - onSuccess callback", () => {
19
29
  content: [{ type: "text", text: "test result" }],
20
30
  structuredContent: { result: "test" },
21
31
  isError: false,
22
- result: "test result",
23
32
  meta: {},
24
33
  };
25
34
  const error = new Error("test error");
26
- it("should call window.openai.callTool with correct arguments", async () => {
35
+ it("should normalize _meta to meta when SDK returns _meta instead of meta", async () => {
36
+ const rawSdkResponse = {
37
+ content: [{ type: "text", text: "result" }],
38
+ structuredContent: { value: 1 },
39
+ isError: false,
40
+ meta: { secret: "only visible to widget" },
41
+ };
42
+ callToolMock.mockResolvedValueOnce(rawSdkResponse);
43
+ const { result } = renderHook(() => useCallTool(toolName));
44
+ await act(async () => {
45
+ result.current.callTool(args);
46
+ });
47
+ await waitFor(() => {
48
+ expect(result.current.data).toMatchObject({
49
+ meta: { secret: "only visible to widget" },
50
+ });
51
+ });
52
+ });
53
+ it("should call adaptor.callTool with correct arguments", async () => {
27
54
  const { result } = renderHook(() => useCallTool(toolName));
28
55
  await act(async () => {
29
56
  result.current.callTool(args);
30
57
  });
31
- expect(OpenaiMock.callTool).toHaveBeenCalledWith(toolName, args);
58
+ expect(callToolMock).toHaveBeenCalledWith(toolName, args);
32
59
  });
33
60
  it("should call onSuccess callback with correct data and toolArgs on successful execution", async () => {
34
61
  const onSuccess = vi.fn();
35
62
  const onError = vi.fn();
36
- OpenaiMock.callTool.mockResolvedValueOnce(data);
63
+ callToolMock.mockResolvedValueOnce(data);
37
64
  const { result } = renderHook(() => useCallTool(toolName));
38
65
  act(() => {
39
66
  result.current.callTool(args, {
@@ -49,7 +76,7 @@ describe("useCallTool - onSuccess callback", () => {
49
76
  it("should call onError callback with error and toolArgs on failed execution", async () => {
50
77
  const onSuccess = vi.fn();
51
78
  const onError = vi.fn();
52
- OpenaiMock.callTool.mockRejectedValueOnce(error);
79
+ callToolMock.mockRejectedValueOnce(error);
53
80
  const { result } = renderHook(() => useCallTool(toolName));
54
81
  act(() => {
55
82
  result.current.callTool(args, {
@@ -66,7 +93,7 @@ describe("useCallTool - onSuccess callback", () => {
66
93
  const onSuccess = vi.fn();
67
94
  const onError = vi.fn();
68
95
  const onSettled = vi.fn();
69
- OpenaiMock.callTool.mockResolvedValueOnce(data);
96
+ callToolMock.mockResolvedValueOnce(data);
70
97
  const { result } = renderHook(() => useCallTool(toolName));
71
98
  act(() => {
72
99
  result.current.callTool(args, {
@@ -85,7 +112,7 @@ describe("useCallTool - onSuccess callback", () => {
85
112
  const onSuccess = vi.fn();
86
113
  const onError = vi.fn();
87
114
  const onSettled = vi.fn();
88
- OpenaiMock.callTool.mockRejectedValueOnce(error);
115
+ callToolMock.mockRejectedValueOnce(error);
89
116
  const { result } = renderHook(() => useCallTool(toolName));
90
117
  act(() => {
91
118
  result.current.callTool(args, {
@@ -100,18 +127,53 @@ describe("useCallTool - onSuccess callback", () => {
100
127
  expect(onSuccess).not.toHaveBeenCalled();
101
128
  });
102
129
  });
130
+ it("should always return last call started state", async () => {
131
+ const { result } = renderHook(() => useCallTool(toolName));
132
+ const firstCallData = {
133
+ ...data,
134
+ structuredContent: { result: "first call result" },
135
+ };
136
+ const secondCallData = {
137
+ ...data,
138
+ structuredContent: { result: "second call result" },
139
+ };
140
+ const { promise: firstCallToolPromise, resolve: resolveFirstCallTool } = Promise.withResolvers();
141
+ const { promise: secondCallToolPromise, resolve: resolveSecondCallTool } = Promise.withResolvers();
142
+ callToolMock
143
+ .mockImplementationOnce(() => firstCallToolPromise)
144
+ .mockImplementationOnce(() => secondCallToolPromise);
145
+ await act(() => {
146
+ result.current.callTool(args);
147
+ result.current.callTool(args);
148
+ resolveFirstCallTool(firstCallData);
149
+ return firstCallToolPromise;
150
+ });
151
+ expect(result.current.status).toEqual("pending");
152
+ expect(result.current.data).toEqual(undefined);
153
+ resolveSecondCallTool(secondCallData);
154
+ await waitFor(() => {
155
+ expect(result.current.status).toEqual("success");
156
+ expect(result.current.data).toEqual(secondCallData);
157
+ });
158
+ });
103
159
  });
104
160
  describe("useCallTool - TypeScript typing", () => {
105
- let OpenaiMock;
161
+ let callToolMock;
106
162
  beforeEach(() => {
107
- OpenaiMock = {
108
- callTool: vi.fn(),
109
- };
110
- vi.stubGlobal("openai", OpenaiMock);
163
+ HostAdaptor.resetInstance();
164
+ McpAppBridge.resetInstance();
165
+ AppsSdkBridge.resetInstance();
166
+ vi.stubGlobal("parent", { postMessage: vi.fn() });
167
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
168
+ vi.stubGlobal("openai", { callTool: vi.fn() });
169
+ callToolMock = vi.spyOn(getAdaptor(), "callTool");
111
170
  });
112
171
  afterEach(() => {
113
172
  vi.unstubAllGlobals();
114
173
  vi.resetAllMocks();
174
+ HostAdaptor.resetInstance();
175
+ McpAppBridge.resetInstance();
176
+ AppsSdkBridge.resetInstance();
115
177
  });
116
178
  it("should have correct return types when ToolArgs is null and ToolResponse is specified", async () => {
117
179
  const { result } = renderHook(() => useCallTool("test-tool"));
@@ -119,14 +181,13 @@ describe("useCallTool - TypeScript typing", () => {
119
181
  content: [{ type: "text", text: "test" }],
120
182
  structuredContent: { result: "test" },
121
183
  isError: false,
122
- result: "test",
123
184
  meta: { id: 123 },
124
185
  };
125
- OpenaiMock.callTool.mockResolvedValueOnce(data);
186
+ callToolMock.mockResolvedValueOnce(data);
126
187
  await act(async () => {
127
188
  result.current.callTool();
128
189
  });
129
- expect(OpenaiMock.callTool).toHaveBeenCalledWith("test-tool", null);
190
+ expect(callToolMock).toHaveBeenCalledWith("test-tool", null);
130
191
  expectTypeOf(result.current.data);
131
192
  });
132
193
  it("should correctly type callToolAsync return value", async () => {
@@ -136,18 +197,14 @@ describe("useCallTool - TypeScript typing", () => {
136
197
  content: [{ type: "text", text: "answer" }],
137
198
  structuredContent: { answer: "test answer" },
138
199
  isError: false,
139
- result: "answer",
140
200
  meta: {},
141
201
  };
142
- OpenaiMock.callTool.mockResolvedValueOnce(mockResponse);
143
- let promise;
144
- let resolvedValue;
145
- await act(async () => {
146
- promise = result.current.callToolAsync(testArgs);
147
- expectTypeOf(promise);
148
- resolvedValue = await promise;
202
+ callToolMock.mockResolvedValueOnce(mockResponse);
203
+ const returnedValue = await act(async () => {
204
+ return result.current.callToolAsync(testArgs);
149
205
  });
150
- expect(resolvedValue).toEqual(mockResponse);
206
+ expectTypeOf(returnedValue);
207
+ expect(returnedValue).toEqual(mockResponse);
151
208
  });
152
209
  it("should correctly type callToolAsync when ToolArgs is null", async () => {
153
210
  const { result } = renderHook(() => useCallTool("test-tool"));
@@ -155,17 +212,14 @@ describe("useCallTool - TypeScript typing", () => {
155
212
  content: [{ type: "text", text: "data" }],
156
213
  structuredContent: { data: "test data" },
157
214
  isError: false,
158
- result: "data",
215
+ meta: {},
159
216
  };
160
- OpenaiMock.callTool.mockResolvedValueOnce(mockResponse);
161
- let promise;
162
- let resolvedValue;
163
- await act(async () => {
164
- promise = result.current.callToolAsync();
165
- expectTypeOf(promise);
166
- resolvedValue = await promise;
217
+ callToolMock.mockResolvedValueOnce(mockResponse);
218
+ const returnedValue = await act(async () => {
219
+ return result.current.callToolAsync();
167
220
  });
168
- expect(resolvedValue).toEqual(mockResponse);
221
+ expectTypeOf(returnedValue);
222
+ expect(returnedValue).toEqual(mockResponse);
169
223
  });
170
224
  });
171
225
  //# sourceMappingURL=use-call-tool.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-call-tool.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-call-tool.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EACL,SAAS,EACT,UAAU,EACV,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,EAAE,EAEF,EAAE,GACH,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;IAChD,IAAI,YAAkB,CAAC;IAEvB,UAAU,CAAC,GAAG,EAAE;QACd,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;QAC9B,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAClD,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACrD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/C,YAAY,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,UAAU,CAAoB,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACnB,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,WAAW,CAAC;IAC7B,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;IACrC,MAAM,IAAI,GAAqB;QAC7B,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;QACzD,iBAAiB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;QACrC,OAAO,EAAE,KAAK;QACd,IAAI,EAAE,EAAE;KACT,CAAC;IACF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAEtC,EAAE,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;QACrF,MAAM,cAAc,GAAG;YACrB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YACpD,iBAAiB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;YAC/B,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,EAAE,MAAM,EAAE,wBAAwB,EAAE;SAC3C,CAAC;QACF,YAAY,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC;QACnD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC;gBACxC,IAAI,EAAE,EAAE,MAAM,EAAE,wBAAwB,EAAE;aAC3C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QACF,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;QACrG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,YAAY,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACnD,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;QACxF,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,YAAY,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;YACzC,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sFAAsF,EAAE,KAAK,IAAI,EAAE;QACpG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,YAAY,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;gBACP,SAAS;aACV,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACnD,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAC9D,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;QAChG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,YAAY,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;gBACP,SAAS;aACV,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAClD,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YAC/D,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,MAAM,aAAa,GAAG;YACpB,GAAG,IAAI;YACP,iBAAiB,EAAE,EAAE,MAAM,EAAE,mBAAmB,EAAE;SACnD,CAAC;QACF,MAAM,cAAc,GAAG;YACrB,GAAG,IAAI;YACP,iBAAiB,EAAE,EAAE,MAAM,EAAE,oBAAoB,EAAE;SACpD,CAAC;QACF,MAAM,EAAE,OAAO,EAAE,oBAAoB,EAAE,OAAO,EAAE,oBAAoB,EAAE,GACpE,OAAO,CAAC,aAAa,EAAE,CAAC;QAC1B,MAAM,EAAE,OAAO,EAAE,qBAAqB,EAAE,OAAO,EAAE,qBAAqB,EAAE,GACtE,OAAO,CAAC,aAAa,EAAE,CAAC;QAC1B,YAAY;aACT,sBAAsB,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC;aAClD,sBAAsB,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,CAAC;QAEvD,MAAM,GAAG,CAAC,GAAG,EAAE;YACb,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9B,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9B,oBAAoB,CAAC,aAAa,CAAC,CAAC;YACpC,OAAO,oBAAoB,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC/C,qBAAqB,CAAC,cAAc,CAAC,CAAC;QAEtC,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,IAAI,YAAkB,CAAC;IAEvB,UAAU,CAAC,GAAG,EAAE;QACd,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;QAC9B,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAClD,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACrD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/C,YAAY,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,UAAU,CAAoB,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACnB,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sFAAsF,EAAE,KAAK,IAAI,EAAE;QAMpG,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAAqB,WAAW,CAAC,CAC7C,CAAC;QACF,MAAM,IAAI,GAAiB;YACzB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAClD,iBAAiB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;YACrC,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE;SAClB,CAAC;QAEF,YAAY,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAEzC,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC7D,YAAY,CAA0B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAMhE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAAyB,WAAW,CAAC,CACjD,CAAC;QAEF,MAAM,QAAQ,GAAa,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAC7C,MAAM,YAAY,GAAiB;YACjC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YACpD,iBAAiB,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE;YAC5C,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,EAAE;SACT,CAAC;QAEF,YAAY,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,aAAa,GAAG,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACzC,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QACH,YAAY,CAAsB,aAAa,CAAC,CAAC;QACjD,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QAKzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAAqB,WAAW,CAAC,CAC7C,CAAC;QAEF,MAAM,YAAY,GAAiB;YACjC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAClD,iBAAiB,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE;YACxC,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,EAAE;SACT,CAAC;QAEF,YAAY,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,aAAa,GAAG,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACzC,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;QACxC,CAAC,CAAC,CAAC;QACH,YAAY,CAAsB,aAAa,CAAC,CAAC;QACjD,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { act, renderHook, waitFor } from \"@testing-library/react\";\nimport {\n afterEach,\n beforeEach,\n describe,\n expect,\n expectTypeOf,\n it,\n type Mock,\n vi,\n} from \"vitest\";\nimport { HostAdaptor } from \"../bridges/adaptor.js\";\nimport { AppsSdkBridge } from \"../bridges/apps-sdk/bridge.js\";\nimport { getAdaptor } from \"../bridges/get-adaptor.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/bridge.js\";\nimport type { CallToolResponse } from \"../bridges/types.js\";\nimport { useCallTool } from \"./use-call-tool.js\";\n\ndescribe(\"useCallTool - onSuccess callback\", () => {\n let callToolMock: Mock;\n\n beforeEach(() => {\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n AppsSdkBridge.resetInstance();\n vi.stubGlobal(\"parent\", { postMessage: vi.fn() });\n vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n vi.stubGlobal(\"openai\", { callTool: vi.fn() });\n callToolMock = vi.spyOn(getAdaptor(), \"callTool\") as unknown as Mock;\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n AppsSdkBridge.resetInstance();\n });\n\n const toolName = \"test-tool\";\n const args = { input: \"test input\" };\n const data: CallToolResponse = {\n content: [{ type: \"text\" as const, text: \"test result\" }],\n structuredContent: { result: \"test\" },\n isError: false,\n meta: {},\n };\n const error = new Error(\"test error\");\n\n it(\"should normalize _meta to meta when SDK returns _meta instead of meta\", async () => {\n const rawSdkResponse = {\n content: [{ type: \"text\" as const, text: \"result\" }],\n structuredContent: { value: 1 },\n isError: false,\n meta: { secret: \"only visible to widget\" },\n };\n callToolMock.mockResolvedValueOnce(rawSdkResponse);\n const { result } = renderHook(() =>\n useCallTool<typeof args, typeof data>(toolName),\n );\n\n await act(async () => {\n result.current.callTool(args);\n });\n\n await waitFor(() => {\n expect(result.current.data).toMatchObject({\n meta: { secret: \"only visible to widget\" },\n });\n });\n });\n\n it(\"should call adaptor.callTool with correct arguments\", async () => {\n const { result } = renderHook(() =>\n useCallTool<typeof args, typeof data>(toolName),\n );\n await act(async () => {\n result.current.callTool(args);\n });\n expect(callToolMock).toHaveBeenCalledWith(toolName, args);\n });\n\n it(\"should call onSuccess callback with correct data and toolArgs on successful execution\", async () => {\n const onSuccess = vi.fn();\n const onError = vi.fn();\n callToolMock.mockResolvedValueOnce(data);\n const { result } = renderHook(() =>\n useCallTool<typeof args, typeof data>(toolName),\n );\n\n act(() => {\n result.current.callTool(args, {\n onSuccess,\n onError,\n });\n });\n\n await waitFor(() => {\n expect(onSuccess).toHaveBeenCalledWith(data, args);\n expect(onError).not.toHaveBeenCalled();\n });\n });\n\n it(\"should call onError callback with error and toolArgs on failed execution\", async () => {\n const onSuccess = vi.fn();\n const onError = vi.fn();\n callToolMock.mockRejectedValueOnce(error);\n const { result } = renderHook(() =>\n useCallTool<typeof args, typeof data>(toolName),\n );\n\n act(() => {\n result.current.callTool(args, {\n onSuccess,\n onError,\n });\n });\n\n await waitFor(() => {\n expect(onSuccess).not.toHaveBeenCalled();\n expect(onError).toHaveBeenCalledWith(error, args);\n });\n });\n\n it(\"should call onSettled callback with data and undefined error on successful execution\", async () => {\n const onSuccess = vi.fn();\n const onError = vi.fn();\n const onSettled = vi.fn();\n callToolMock.mockResolvedValueOnce(data);\n const { result } = renderHook(() =>\n useCallTool<typeof args, typeof data>(toolName),\n );\n\n act(() => {\n result.current.callTool(args, {\n onSuccess,\n onError,\n onSettled,\n });\n });\n\n await waitFor(() => {\n expect(onSuccess).toHaveBeenCalledWith(data, args);\n expect(onSettled).toHaveBeenCalledWith(data, undefined, args);\n expect(onError).not.toHaveBeenCalled();\n });\n });\n\n it(\"should call onSettled callback with undefined data and error on failed execution\", async () => {\n const onSuccess = vi.fn();\n const onError = vi.fn();\n const onSettled = vi.fn();\n callToolMock.mockRejectedValueOnce(error);\n const { result } = renderHook(() =>\n useCallTool<typeof args, typeof data>(toolName),\n );\n\n act(() => {\n result.current.callTool(args, {\n onSuccess,\n onError,\n onSettled,\n });\n });\n\n await waitFor(() => {\n expect(onError).toHaveBeenCalledWith(error, args);\n expect(onSettled).toHaveBeenCalledWith(undefined, error, args);\n expect(onSuccess).not.toHaveBeenCalled();\n });\n });\n\n it(\"should always return last call started state\", async () => {\n const { result } = renderHook(() =>\n useCallTool<typeof args, typeof data>(toolName),\n );\n\n const firstCallData = {\n ...data,\n structuredContent: { result: \"first call result\" },\n };\n const secondCallData = {\n ...data,\n structuredContent: { result: \"second call result\" },\n };\n const { promise: firstCallToolPromise, resolve: resolveFirstCallTool } =\n Promise.withResolvers();\n const { promise: secondCallToolPromise, resolve: resolveSecondCallTool } =\n Promise.withResolvers();\n callToolMock\n .mockImplementationOnce(() => firstCallToolPromise)\n .mockImplementationOnce(() => secondCallToolPromise);\n\n await act(() => {\n result.current.callTool(args);\n result.current.callTool(args);\n resolveFirstCallTool(firstCallData);\n return firstCallToolPromise;\n });\n\n expect(result.current.status).toEqual(\"pending\");\n expect(result.current.data).toEqual(undefined);\n resolveSecondCallTool(secondCallData);\n\n await waitFor(() => {\n expect(result.current.status).toEqual(\"success\");\n expect(result.current.data).toEqual(secondCallData);\n });\n });\n});\n\ndescribe(\"useCallTool - TypeScript typing\", () => {\n let callToolMock: Mock;\n\n beforeEach(() => {\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n AppsSdkBridge.resetInstance();\n vi.stubGlobal(\"parent\", { postMessage: vi.fn() });\n vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n vi.stubGlobal(\"openai\", { callTool: vi.fn() });\n callToolMock = vi.spyOn(getAdaptor(), \"callTool\") as unknown as Mock;\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n AppsSdkBridge.resetInstance();\n });\n\n it(\"should have correct return types when ToolArgs is null and ToolResponse is specified\", async () => {\n type TestResponse = CallToolResponse & {\n structuredContent: { result: string };\n meta: { id: number };\n };\n\n const { result } = renderHook(() =>\n useCallTool<null, TestResponse>(\"test-tool\"),\n );\n const data: TestResponse = {\n content: [{ type: \"text\" as const, text: \"test\" }],\n structuredContent: { result: \"test\" },\n isError: false,\n meta: { id: 123 },\n };\n\n callToolMock.mockResolvedValueOnce(data);\n\n await act(async () => {\n result.current.callTool();\n });\n\n expect(callToolMock).toHaveBeenCalledWith(\"test-tool\", null);\n expectTypeOf<typeof data | undefined>(result.current.data);\n });\n\n it(\"should correctly type callToolAsync return value\", async () => {\n type TestArgs = { query: string };\n type TestResponse = CallToolResponse & {\n structuredContent: { answer: string };\n };\n\n const { result } = renderHook(() =>\n useCallTool<TestArgs, TestResponse>(\"test-tool\"),\n );\n\n const testArgs: TestArgs = { query: \"test\" };\n const mockResponse: TestResponse = {\n content: [{ type: \"text\" as const, text: \"answer\" }],\n structuredContent: { answer: \"test answer\" },\n isError: false,\n meta: {},\n };\n\n callToolMock.mockResolvedValueOnce(mockResponse);\n\n const returnedValue = await act(async () => {\n return result.current.callToolAsync(testArgs);\n });\n expectTypeOf<typeof mockResponse>(returnedValue);\n expect(returnedValue).toEqual(mockResponse);\n });\n\n it(\"should correctly type callToolAsync when ToolArgs is null\", async () => {\n type TestResponse = CallToolResponse & {\n structuredContent: { data: string };\n };\n\n const { result } = renderHook(() =>\n useCallTool<null, TestResponse>(\"test-tool\"),\n );\n\n const mockResponse: TestResponse = {\n content: [{ type: \"text\" as const, text: \"data\" }],\n structuredContent: { data: \"test data\" },\n isError: false,\n meta: {},\n };\n\n callToolMock.mockResolvedValueOnce(mockResponse);\n\n const returnedValue = await act(async () => {\n return result.current.callToolAsync();\n });\n expectTypeOf<typeof mockResponse>(returnedValue);\n expect(returnedValue).toEqual(mockResponse);\n });\n});\n"]}
@@ -0,0 +1,24 @@
1
+ import type { RequestDisplayMode } from "../bridges/types.js";
2
+ /**
3
+ * Read and change the view's display mode (`"inline"`, `"pip"`, `"fullscreen"`).
4
+ *
5
+ * Returns a tuple `[displayMode, setDisplayMode]`. `setDisplayMode` asks the
6
+ * host to switch modes — the host returns the mode it actually applied, which
7
+ * may differ from the request. The reported value also updates when the host
8
+ * changes the mode on its own (e.g. user expands the widget).
9
+ *
10
+ * `"modal"` is reachable via {@link useRequestModal}, not this hook. To react
11
+ * to layout changes that come with display-mode switches (e.g. `maxHeight`),
12
+ * pair with {@link useLayout}.
13
+ *
14
+ * @example
15
+ * ```tsx
16
+ * const [mode, setMode] = useDisplayMode();
17
+ * <button onClick={() => setMode("fullscreen")}>Expand</button>
18
+ * ```
19
+ *
20
+ * @see https://docs.skybridge.tech/api-reference/use-display-mode
21
+ */
22
+ export declare function useDisplayMode(): readonly [import("../index.js").DisplayMode, (mode: RequestDisplayMode) => Promise<{
23
+ mode: RequestDisplayMode;
24
+ }>];
@@ -0,0 +1,29 @@
1
+ import { useCallback } from "react";
2
+ import { getAdaptor, useHostContext } from "../bridges/index.js";
3
+ /**
4
+ * Read and change the view's display mode (`"inline"`, `"pip"`, `"fullscreen"`).
5
+ *
6
+ * Returns a tuple `[displayMode, setDisplayMode]`. `setDisplayMode` asks the
7
+ * host to switch modes — the host returns the mode it actually applied, which
8
+ * may differ from the request. The reported value also updates when the host
9
+ * changes the mode on its own (e.g. user expands the widget).
10
+ *
11
+ * `"modal"` is reachable via {@link useRequestModal}, not this hook. To react
12
+ * to layout changes that come with display-mode switches (e.g. `maxHeight`),
13
+ * pair with {@link useLayout}.
14
+ *
15
+ * @example
16
+ * ```tsx
17
+ * const [mode, setMode] = useDisplayMode();
18
+ * <button onClick={() => setMode("fullscreen")}>Expand</button>
19
+ * ```
20
+ *
21
+ * @see https://docs.skybridge.tech/api-reference/use-display-mode
22
+ */
23
+ export function useDisplayMode() {
24
+ const displayMode = useHostContext("displayMode");
25
+ const adaptor = getAdaptor();
26
+ const setDisplayMode = useCallback((mode) => adaptor.requestDisplayMode(mode), [adaptor]);
27
+ return [displayMode, setDisplayMode];
28
+ }
29
+ //# sourceMappingURL=use-display-mode.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-display-mode.js","sourceRoot":"","sources":["../../../src/web/hooks/use-display-mode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGjE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,cAAc;IAC5B,MAAM,WAAW,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC;IAClD,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,cAAc,GAAG,WAAW,CAChC,CAAC,IAAwB,EAAE,EAAE,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAC9D,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,OAAO,CAAC,WAAW,EAAE,cAAc,CAAU,CAAC;AAChD,CAAC","sourcesContent":["import { useCallback } from \"react\";\nimport { getAdaptor, useHostContext } from \"../bridges/index.js\";\nimport type { RequestDisplayMode } from \"../bridges/types.js\";\n\n/**\n * Read and change the view's display mode (`\"inline\"`, `\"pip\"`, `\"fullscreen\"`).\n *\n * Returns a tuple `[displayMode, setDisplayMode]`. `setDisplayMode` asks the\n * host to switch modes — the host returns the mode it actually applied, which\n * may differ from the request. The reported value also updates when the host\n * changes the mode on its own (e.g. user expands the widget).\n *\n * `\"modal\"` is reachable via {@link useRequestModal}, not this hook. To react\n * to layout changes that come with display-mode switches (e.g. `maxHeight`),\n * pair with {@link useLayout}.\n *\n * @example\n * ```tsx\n * const [mode, setMode] = useDisplayMode();\n * <button onClick={() => setMode(\"fullscreen\")}>Expand</button>\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-display-mode\n */\nexport function useDisplayMode() {\n const displayMode = useHostContext(\"displayMode\");\n const adaptor = getAdaptor();\n const setDisplayMode = useCallback(\n (mode: RequestDisplayMode) => adaptor.requestDisplayMode(mode),\n [adaptor],\n );\n\n return [displayMode, setDisplayMode] as const;\n}\n"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,8 @@
1
+ import { expectTypeOf, test } from "vitest";
2
+ test("setDisplayMode only accepts requestable display modes", () => {
3
+ expectTypeOf().toEqualTypeOf();
4
+ // @ts-expect-error "modal" is a host state, not a valid request mode
5
+ const _invalidMode = "modal";
6
+ void _invalidMode;
7
+ });
8
+ //# sourceMappingURL=use-display-mode.test-d.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-display-mode.test-d.js","sourceRoot":"","sources":["../../../src/web/hooks/use-display-mode.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAI5C,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;IAGjE,YAAY,EAET,CAAC,aAAa,EAAsB,CAAC;IAExC,qEAAqE;IACrE,MAAM,YAAY,GAAkC,OAAO,CAAC;IAC5D,KAAK,YAAY,CAAC;AACpB,CAAC,CAAC,CAAC","sourcesContent":["import { expectTypeOf, test } from \"vitest\";\nimport type { RequestDisplayMode } from \"../bridges/types.js\";\nimport type { useDisplayMode } from \"./use-display-mode.js\";\n\ntest(\"setDisplayMode only accepts requestable display modes\", () => {\n type SetDisplayMode = ReturnType<typeof useDisplayMode>[1];\n\n expectTypeOf<\n Parameters<SetDisplayMode>[0]\n >().toEqualTypeOf<RequestDisplayMode>();\n\n // @ts-expect-error \"modal\" is a host state, not a valid request mode\n const _invalidMode: Parameters<SetDisplayMode>[0] = \"modal\";\n void _invalidMode;\n});\n"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,77 @@
1
+ import { act, fireEvent, 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 { AppsSdkBridge } from "../bridges/apps-sdk/bridge.js";
5
+ import { getAdaptor } from "../bridges/get-adaptor.js";
6
+ import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
7
+ import { getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
8
+ import { useDisplayMode } from "./use-display-mode.js";
9
+ describe("useDisplayMode", () => {
10
+ beforeEach(() => {
11
+ HostAdaptor.resetInstance();
12
+ McpAppBridge.resetInstance();
13
+ AppsSdkBridge.resetInstance();
14
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
15
+ vi.stubGlobal("openai", { view: { mode: "inline" } });
16
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
17
+ });
18
+ afterEach(() => {
19
+ vi.unstubAllGlobals();
20
+ vi.resetAllMocks();
21
+ HostAdaptor.resetInstance();
22
+ McpAppBridge.resetInstance();
23
+ AppsSdkBridge.resetInstance();
24
+ });
25
+ it("should return the current display mode from MCP host context", async () => {
26
+ vi.stubGlobal("parent", {
27
+ postMessage: getMcpAppHostPostMessageMock({ displayMode: "inline" }),
28
+ });
29
+ const { result } = renderHook(() => useDisplayMode());
30
+ await waitFor(() => {
31
+ expect(result.current[0]).toBe("inline");
32
+ });
33
+ });
34
+ it("should update display mode on host-context-changed notification", async () => {
35
+ vi.stubGlobal("parent", {
36
+ postMessage: getMcpAppHostPostMessageMock({ displayMode: "inline" }),
37
+ });
38
+ const { result } = renderHook(() => useDisplayMode());
39
+ await waitFor(() => {
40
+ expect(result.current[0]).toBe("inline");
41
+ });
42
+ act(() => {
43
+ fireEvent(window, new MessageEvent("message", {
44
+ source: window.parent,
45
+ data: {
46
+ jsonrpc: "2.0",
47
+ method: "ui/notifications/host-context-changed",
48
+ params: { displayMode: "fullscreen" },
49
+ },
50
+ }));
51
+ });
52
+ await waitFor(() => {
53
+ expect(result.current[0]).toBe("fullscreen");
54
+ });
55
+ });
56
+ it("should call requestDisplayMode on the adaptor when setDisplayMode is called", async () => {
57
+ vi.stubGlobal("parent", {
58
+ postMessage: getMcpAppHostPostMessageMock({ displayMode: "inline" }),
59
+ });
60
+ const { result } = renderHook(() => useDisplayMode());
61
+ await waitFor(() => expect(result.current[0]).toBe("inline"));
62
+ // Patch mcp.getApp to avoid real protocol request
63
+ const adaptor = getAdaptor();
64
+ const fakeApp = {
65
+ requestDisplayMode: vi.fn().mockResolvedValue({ mode: "fullscreen" }),
66
+ };
67
+ // biome-ignore lint/suspicious/noExplicitAny: test seam
68
+ adaptor.mcp.getApp = vi.fn().mockResolvedValue(fakeApp);
69
+ await act(async () => {
70
+ await result.current[1]("fullscreen");
71
+ });
72
+ expect(fakeApp.requestDisplayMode).toHaveBeenCalledWith({
73
+ mode: "fullscreen",
74
+ });
75
+ });
76
+ });
77
+ //# sourceMappingURL=use-display-mode.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-display-mode.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-display-mode.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC7E,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,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,UAAU,CAAC,GAAG,EAAE;QACd,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;QAC9B,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACrD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QACtD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACnB,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,WAAW,EAAE,4BAA4B,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;SACrE,CAAC,CAAC;QAEH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;QAEtD,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,WAAW,EAAE,4BAA4B,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;SACrE,CAAC,CAAC;QAEH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;QAEtD,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,EAAE;YACP,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CAAC,SAAS,EAAE;gBAC1B,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,IAAI,EAAE;oBACJ,OAAO,EAAE,KAAK;oBACd,MAAM,EAAE,uCAAuC;oBAC/C,MAAM,EAAE,EAAE,WAAW,EAAE,YAAY,EAAE;iBACtC;aACF,CAAC,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6EAA6E,EAAE,KAAK,IAAI,EAAE;QAC3F,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,WAAW,EAAE,4BAA4B,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;SACrE,CAAC,CAAC;QAEH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;QAEtD,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE9D,kDAAkD;QAClD,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG;YACd,kBAAkB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;SACtE,CAAC;QACF,wDAAwD;QACvD,OAAe,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAEjE,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CAAC;YACtD,IAAI,EAAE,YAAY;SACnB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { act, fireEvent, renderHook, waitFor } from \"@testing-library/react\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { HostAdaptor } from \"../bridges/adaptor.js\";\nimport { AppsSdkBridge } from \"../bridges/apps-sdk/bridge.js\";\nimport { getAdaptor } from \"../bridges/get-adaptor.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/bridge.js\";\nimport {\n getMcpAppHostPostMessageMock,\n MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useDisplayMode } from \"./use-display-mode.js\";\n\ndescribe(\"useDisplayMode\", () => {\n beforeEach(() => {\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n AppsSdkBridge.resetInstance();\n vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n vi.stubGlobal(\"openai\", { view: { mode: \"inline\" } });\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n AppsSdkBridge.resetInstance();\n });\n\n it(\"should return the current display mode from MCP host context\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({ displayMode: \"inline\" }),\n });\n\n const { result } = renderHook(() => useDisplayMode());\n\n await waitFor(() => {\n expect(result.current[0]).toBe(\"inline\");\n });\n });\n\n it(\"should update display mode on host-context-changed notification\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({ displayMode: \"inline\" }),\n });\n\n const { result } = renderHook(() => useDisplayMode());\n\n await waitFor(() => {\n expect(result.current[0]).toBe(\"inline\");\n });\n\n act(() => {\n fireEvent(\n window,\n new MessageEvent(\"message\", {\n source: window.parent,\n data: {\n jsonrpc: \"2.0\",\n method: \"ui/notifications/host-context-changed\",\n params: { displayMode: \"fullscreen\" },\n },\n }),\n );\n });\n\n await waitFor(() => {\n expect(result.current[0]).toBe(\"fullscreen\");\n });\n });\n\n it(\"should call requestDisplayMode on the adaptor when setDisplayMode is called\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({ displayMode: \"inline\" }),\n });\n\n const { result } = renderHook(() => useDisplayMode());\n\n await waitFor(() => expect(result.current[0]).toBe(\"inline\"));\n\n // Patch mcp.getApp to avoid real protocol request\n const adaptor = getAdaptor();\n const fakeApp = {\n requestDisplayMode: vi.fn().mockResolvedValue({ mode: \"fullscreen\" }),\n };\n // biome-ignore lint/suspicious/noExplicitAny: test seam\n (adaptor as any).mcp.getApp = vi.fn().mockResolvedValue(fakeApp);\n\n await act(async () => {\n await result.current[1](\"fullscreen\");\n });\n\n expect(fakeApp.requestDisplayMode).toHaveBeenCalledWith({\n mode: \"fullscreen\",\n });\n });\n});\n"]}
@@ -0,0 +1,5 @@
1
+ import type { DownloadParams, DownloadResult } from "../bridges/types.js";
2
+ export type DownloadFn = (params: DownloadParams) => Promise<DownloadResult>;
3
+ export declare function useDownload(): {
4
+ download: DownloadFn;
5
+ };
@@ -0,0 +1,8 @@
1
+ import { useCallback } from "react";
2
+ import { getAdaptor } from "../bridges/index.js";
3
+ export function useDownload() {
4
+ const adaptor = getAdaptor();
5
+ const download = useCallback((params) => adaptor.download(params), [adaptor]);
6
+ return { download };
7
+ }
8
+ //# sourceMappingURL=use-download.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-download.js","sourceRoot":"","sources":["../../../src/web/hooks/use-download.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAKjD,MAAM,UAAU,WAAW;IACzB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,QAAQ,GAAG,WAAW,CAC1B,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EACpC,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,OAAO,EAAE,QAAQ,EAAE,CAAC;AACtB,CAAC","sourcesContent":["import { useCallback } from \"react\";\nimport { getAdaptor } from \"../bridges/index.js\";\nimport type { DownloadParams, DownloadResult } from \"../bridges/types.js\";\n\nexport type DownloadFn = (params: DownloadParams) => Promise<DownloadResult>;\n\nexport function useDownload(): { download: DownloadFn } {\n const adaptor = getAdaptor();\n const download = useCallback<DownloadFn>(\n (params) => adaptor.download(params),\n [adaptor],\n );\n\n return { download };\n}\n"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,103 @@
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 { useDownload } from "./use-download.js";
7
+ const params = {
8
+ contents: [
9
+ {
10
+ type: "resource",
11
+ resource: {
12
+ uri: "file:///export.json",
13
+ mimeType: "application/json",
14
+ text: '{"hello":"world"}',
15
+ },
16
+ },
17
+ ],
18
+ };
19
+ describe("useDownload", () => {
20
+ describe("apps-sdk host", () => {
21
+ beforeEach(() => {
22
+ vi.stubGlobal("openai", {});
23
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
24
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
25
+ vi.stubGlobal("parent", { postMessage: getMcpAppHostPostMessageMock() });
26
+ });
27
+ afterEach(() => {
28
+ vi.unstubAllGlobals();
29
+ vi.resetAllMocks();
30
+ HostAdaptor.resetInstance();
31
+ McpAppBridge.resetInstance();
32
+ });
33
+ it("returns { isError: true } and logs an error", async () => {
34
+ const errorSpy = vi.spyOn(console, "error").mockImplementation(() => { });
35
+ const { result } = renderHook(() => useDownload());
36
+ const res = await result.current.download(params);
37
+ expect(res).toEqual({ isError: true });
38
+ expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining("does not support ui/download-file"));
39
+ });
40
+ });
41
+ describe("mcp-app host without downloadFile capability", () => {
42
+ beforeEach(() => {
43
+ vi.stubGlobal("openai", undefined);
44
+ vi.stubGlobal("skybridge", { hostType: "mcp-app" });
45
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
46
+ vi.stubGlobal("parent", { postMessage: getMcpAppHostPostMessageMock() });
47
+ });
48
+ afterEach(async () => {
49
+ vi.unstubAllGlobals();
50
+ vi.resetAllMocks();
51
+ HostAdaptor.resetInstance();
52
+ McpAppBridge.resetInstance();
53
+ });
54
+ it("returns { isError: true } and logs an error", async () => {
55
+ const errorSpy = vi.spyOn(console, "error").mockImplementation(() => { });
56
+ const { result } = renderHook(() => useDownload());
57
+ const res = await result.current.download(params);
58
+ expect(res).toEqual({ isError: true });
59
+ expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining("does not support ui/download-file"));
60
+ });
61
+ });
62
+ describe("mcp-app host with downloadFile capability", () => {
63
+ let postMessageMock;
64
+ beforeEach(() => {
65
+ vi.stubGlobal("openai", undefined);
66
+ vi.stubGlobal("skybridge", { hostType: "mcp-app" });
67
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
68
+ postMessageMock = getMcpAppHostPostMessageMock({}, { hostCapabilities: { downloadFile: {} } });
69
+ vi.stubGlobal("parent", { postMessage: postMessageMock });
70
+ });
71
+ afterEach(async () => {
72
+ vi.unstubAllGlobals();
73
+ vi.resetAllMocks();
74
+ HostAdaptor.resetInstance();
75
+ McpAppBridge.resetInstance();
76
+ });
77
+ it("sends ui/download-file with the provided contents", async () => {
78
+ const { result } = renderHook(() => useDownload());
79
+ const res = await result.current.download(params);
80
+ expect(res).toEqual({});
81
+ await waitFor(() => {
82
+ expect(postMessageMock).toHaveBeenCalledWith(expect.objectContaining({
83
+ jsonrpc: "2.0",
84
+ method: "ui/download-file",
85
+ params,
86
+ }), "*");
87
+ });
88
+ });
89
+ it("returns { isError: true } when the host denies the request", async () => {
90
+ HostAdaptor.resetInstance();
91
+ McpAppBridge.resetInstance();
92
+ postMessageMock = getMcpAppHostPostMessageMock({}, {
93
+ hostCapabilities: { downloadFile: {} },
94
+ downloadFileResult: { isError: true },
95
+ });
96
+ vi.stubGlobal("parent", { postMessage: postMessageMock });
97
+ const { result } = renderHook(() => useDownload());
98
+ const res = await result.current.download(params);
99
+ expect(res).toEqual({ isError: true });
100
+ });
101
+ });
102
+ });
103
+ //# sourceMappingURL=use-download.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-download.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-download.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;AAE5D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,MAAM,GAAmB;IAC7B,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE;gBACR,GAAG,EAAE,qBAAqB;gBAC1B,QAAQ,EAAE,kBAAkB;gBAC5B,IAAI,EAAE,mBAAmB;aAC1B;SACF;KACF;CACF,CAAC;AAEF,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,CAAC,CAAC;YAC5B,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;YACrD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;YACpD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,4BAA4B,EAAE,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC3D,MAAM,QAAQ,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YACzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAElD,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YACvC,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CACnC,MAAM,CAAC,gBAAgB,CAAC,mCAAmC,CAAC,CAC7D,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,8CAA8C,EAAE,GAAG,EAAE;QAC5D,UAAU,CAAC,GAAG,EAAE;YACd,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;YACpD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,4BAA4B,EAAE,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC3D,MAAM,QAAQ,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YACzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAElD,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YACvC,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CACnC,MAAM,CAAC,gBAAgB,CAAC,mCAAmC,CAAC,CAC7D,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACzD,IAAI,eAAgE,CAAC;QAErE,UAAU,CAAC,GAAG,EAAE;YACd,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;YACpD,eAAe,GAAG,4BAA4B,CAC5C,EAAE,EACF,EAAE,gBAAgB,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE,CAC3C,CAAC;YACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;YACjE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAElD,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACxB,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAC1C,MAAM,CAAC,gBAAgB,CAAC;oBACtB,OAAO,EAAE,KAAK;oBACd,MAAM,EAAE,kBAAkB;oBAC1B,MAAM;iBACP,CAAC,EACF,GAAG,CACJ,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;YAC1E,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,eAAe,GAAG,4BAA4B,CAC5C,EAAE,EACF;gBACE,gBAAgB,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE;gBACtC,kBAAkB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;aACtC,CACF,CAAC;YACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;YAE1D,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAElD,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACzC,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 type { DownloadParams } from \"../bridges/types.js\";\nimport {\n getMcpAppHostPostMessageMock,\n MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useDownload } from \"./use-download.js\";\n\nconst params: DownloadParams = {\n contents: [\n {\n type: \"resource\",\n resource: {\n uri: \"file:///export.json\",\n mimeType: \"application/json\",\n text: '{\"hello\":\"world\"}',\n },\n },\n ],\n};\n\ndescribe(\"useDownload\", () => {\n describe(\"apps-sdk host\", () => {\n beforeEach(() => {\n vi.stubGlobal(\"openai\", {});\n vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n vi.stubGlobal(\"parent\", { postMessage: getMcpAppHostPostMessageMock() });\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n });\n\n it(\"returns { isError: true } and logs an error\", async () => {\n const errorSpy = vi.spyOn(console, \"error\").mockImplementation(() => {});\n const { result } = renderHook(() => useDownload());\n\n const res = await result.current.download(params);\n\n expect(res).toEqual({ isError: true });\n expect(errorSpy).toHaveBeenCalledWith(\n expect.stringContaining(\"does not support ui/download-file\"),\n );\n });\n });\n\n describe(\"mcp-app host without downloadFile capability\", () => {\n beforeEach(() => {\n vi.stubGlobal(\"openai\", undefined);\n vi.stubGlobal(\"skybridge\", { hostType: \"mcp-app\" });\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n vi.stubGlobal(\"parent\", { postMessage: getMcpAppHostPostMessageMock() });\n });\n\n afterEach(async () => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n });\n\n it(\"returns { isError: true } and logs an error\", async () => {\n const errorSpy = vi.spyOn(console, \"error\").mockImplementation(() => {});\n const { result } = renderHook(() => useDownload());\n\n const res = await result.current.download(params);\n\n expect(res).toEqual({ isError: true });\n expect(errorSpy).toHaveBeenCalledWith(\n expect.stringContaining(\"does not support ui/download-file\"),\n );\n });\n });\n\n describe(\"mcp-app host with downloadFile capability\", () => {\n let postMessageMock: ReturnType<typeof getMcpAppHostPostMessageMock>;\n\n beforeEach(() => {\n vi.stubGlobal(\"openai\", undefined);\n vi.stubGlobal(\"skybridge\", { hostType: \"mcp-app\" });\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n postMessageMock = getMcpAppHostPostMessageMock(\n {},\n { hostCapabilities: { downloadFile: {} } },\n );\n vi.stubGlobal(\"parent\", { postMessage: postMessageMock });\n });\n\n afterEach(async () => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n });\n\n it(\"sends ui/download-file with the provided contents\", async () => {\n const { result } = renderHook(() => useDownload());\n\n const res = await result.current.download(params);\n\n expect(res).toEqual({});\n await waitFor(() => {\n expect(postMessageMock).toHaveBeenCalledWith(\n expect.objectContaining({\n jsonrpc: \"2.0\",\n method: \"ui/download-file\",\n params,\n }),\n \"*\",\n );\n });\n });\n\n it(\"returns { isError: true } when the host denies the request\", async () => {\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n postMessageMock = getMcpAppHostPostMessageMock(\n {},\n {\n hostCapabilities: { downloadFile: {} },\n downloadFileResult: { isError: true },\n },\n );\n vi.stubGlobal(\"parent\", { postMessage: postMessageMock });\n\n const { result } = renderHook(() => useDownload());\n\n const res = await result.current.download(params);\n\n expect(res).toEqual({ isError: true });\n });\n });\n});\n"]}
@@ -0,0 +1,39 @@
1
+ /**
2
+ * File operations bound to the current host: `upload` a `File`, resolve a
3
+ * `downloadUrl` for an uploaded file, and `selectFiles` to open the host's
4
+ * native file picker.
5
+ *
6
+ * Currently Apps-SDK-only — calling any of these from MCP Apps throws.
7
+ * `selectFiles` additionally requires a ChatGPT host version that exposes the
8
+ * picker; it throws if the capability is unavailable.
9
+ *
10
+ * `upload` returns `FileMetadata` (`fileId`, optional `fileName`, `mimeType`).
11
+ * To pass an uploaded file to a tool whose input uses {@link FileRef}, first
12
+ * call `getDownloadUrl` and then build the ref yourself — field names differ
13
+ * (camelCase on the client, snake_case in the schema) and `download_url` is
14
+ * required.
15
+ *
16
+ * @example
17
+ * ```tsx
18
+ * const { upload, getDownloadUrl } = useFiles();
19
+ * const meta = await upload(file);
20
+ * const { downloadUrl } = await getDownloadUrl(meta);
21
+ * callTool({
22
+ * document: {
23
+ * file_id: meta.fileId,
24
+ * download_url: downloadUrl,
25
+ * file_name: meta.fileName,
26
+ * mime_type: meta.mimeType,
27
+ * },
28
+ * });
29
+ * ```
30
+ *
31
+ * @see https://docs.skybridge.tech/api-reference/use-files
32
+ */
33
+ export declare function useFiles(): {
34
+ upload: (file: File, options?: import("../index.js").UploadFileOptions) => Promise<import("../index.js").FileMetadata>;
35
+ getDownloadUrl: (file: import("../index.js").FileMetadata) => Promise<{
36
+ downloadUrl: string;
37
+ }>;
38
+ selectFiles: () => Promise<import("../index.js").FileMetadata[]>;
39
+ };