skybridge 0.0.0-dev.efbdb09 → 0.0.0-dev.efd00e6

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 (405) hide show
  1. package/README.md +124 -124
  2. package/dist/cli/build-helpers.d.ts +11 -0
  3. package/dist/cli/build-helpers.js +107 -0
  4. package/dist/cli/build-helpers.js.map +1 -0
  5. package/dist/cli/build-helpers.test.d.ts +1 -0
  6. package/dist/cli/build-helpers.test.js +130 -0
  7. package/dist/cli/build-helpers.test.js.map +1 -0
  8. package/dist/cli/build-steps.d.ts +2 -0
  9. package/dist/cli/build-steps.js +73 -0
  10. package/dist/cli/build-steps.js.map +1 -0
  11. package/dist/cli/build-steps.test.d.ts +1 -0
  12. package/dist/cli/build-steps.test.js +52 -0
  13. package/dist/cli/build-steps.test.js.map +1 -0
  14. package/dist/cli/detect-port.d.ts +2 -2
  15. package/dist/cli/detect-port.js +9 -20
  16. package/dist/cli/detect-port.js.map +1 -1
  17. package/dist/cli/header.d.ts +1 -1
  18. package/dist/cli/header.js.map +1 -1
  19. package/dist/cli/resolve-skybridge-config.d.ts +5 -0
  20. package/dist/cli/resolve-skybridge-config.js +18 -0
  21. package/dist/cli/resolve-skybridge-config.js.map +1 -0
  22. package/dist/cli/run-command.js.map +1 -1
  23. package/dist/cli/run-plain.d.ts +18 -0
  24. package/dist/cli/run-plain.js +89 -0
  25. package/dist/cli/run-plain.js.map +1 -0
  26. package/dist/cli/telemetry.js.map +1 -1
  27. package/dist/cli/tunnel-control-server.d.ts +9 -0
  28. package/dist/cli/tunnel-control-server.js +31 -0
  29. package/dist/cli/tunnel-control-server.js.map +1 -0
  30. package/dist/cli/tunnel-control-server.test.d.ts +1 -0
  31. package/dist/cli/tunnel-control-server.test.js +39 -0
  32. package/dist/cli/tunnel-control-server.test.js.map +1 -0
  33. package/dist/cli/tunnel-handler.d.ts +3 -0
  34. package/dist/cli/tunnel-handler.js +48 -0
  35. package/dist/cli/tunnel-handler.js.map +1 -0
  36. package/dist/cli/tunnel-handler.test.d.ts +1 -0
  37. package/dist/cli/tunnel-handler.test.js +105 -0
  38. package/dist/cli/tunnel-handler.test.js.map +1 -0
  39. package/dist/cli/tunnel.d.ts +57 -0
  40. package/dist/cli/tunnel.js +154 -0
  41. package/dist/cli/tunnel.js.map +1 -0
  42. package/dist/cli/tunnel.test.d.ts +1 -0
  43. package/dist/cli/tunnel.test.js +190 -0
  44. package/dist/cli/tunnel.test.js.map +1 -0
  45. package/dist/cli/types.js.map +1 -1
  46. package/dist/cli/use-execute-steps.js.map +1 -1
  47. package/dist/cli/use-messages.js.map +1 -1
  48. package/dist/cli/use-nodemon.d.ts +14 -0
  49. package/dist/cli/use-nodemon.js +72 -52
  50. package/dist/cli/use-nodemon.js.map +1 -1
  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 +1 -1
  55. package/dist/cli/use-tunnel.js +102 -68
  56. package/dist/cli/use-tunnel.js.map +1 -1
  57. package/dist/cli/use-typescript-check.d.ts +8 -2
  58. package/dist/cli/use-typescript-check.js +71 -68
  59. package/dist/cli/use-typescript-check.js.map +1 -1
  60. package/dist/commands/build.d.ts +0 -3
  61. package/dist/commands/build.js +2 -38
  62. package/dist/commands/build.js.map +1 -1
  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 +2 -0
  67. package/dist/commands/dev.js +81 -2
  68. package/dist/commands/dev.js.map +1 -1
  69. package/dist/commands/start.js +7 -1
  70. package/dist/commands/start.js.map +1 -1
  71. package/dist/commands/telemetry/disable.js.map +1 -1
  72. package/dist/commands/telemetry/enable.js.map +1 -1
  73. package/dist/commands/telemetry/status.js.map +1 -1
  74. package/dist/server/asset-base-url-transform-plugin.d.ts +1 -0
  75. package/dist/server/asset-base-url-transform-plugin.js +17 -2
  76. package/dist/server/asset-base-url-transform-plugin.js.map +1 -1
  77. package/dist/server/asset-base-url-transform-plugin.test.js +80 -1
  78. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -1
  79. package/dist/server/auth/discovery.d.ts +32 -0
  80. package/dist/server/auth/discovery.js +56 -0
  81. package/dist/server/auth/discovery.js.map +1 -0
  82. package/dist/server/auth/discovery.test.d.ts +1 -0
  83. package/dist/server/auth/discovery.test.js +93 -0
  84. package/dist/server/auth/discovery.test.js.map +1 -0
  85. package/dist/server/auth/index.d.ts +18 -0
  86. package/dist/server/auth/index.js +2 -0
  87. package/dist/server/auth/index.js.map +1 -0
  88. package/dist/server/auth/providers/auth0.d.ts +18 -0
  89. package/dist/server/auth/providers/auth0.js +31 -0
  90. package/dist/server/auth/providers/auth0.js.map +1 -0
  91. package/dist/server/auth/providers/auth0.test.d.ts +1 -0
  92. package/dist/server/auth/providers/auth0.test.js +48 -0
  93. package/dist/server/auth/providers/auth0.test.js.map +1 -0
  94. package/dist/server/auth/providers/clerk.d.ts +14 -0
  95. package/dist/server/auth/providers/clerk.js +16 -0
  96. package/dist/server/auth/providers/clerk.js.map +1 -0
  97. package/dist/server/auth/providers/clerk.test.d.ts +1 -0
  98. package/dist/server/auth/providers/clerk.test.js +28 -0
  99. package/dist/server/auth/providers/clerk.test.js.map +1 -0
  100. package/dist/server/auth/providers/custom.d.ts +32 -0
  101. package/dist/server/auth/providers/custom.js +49 -0
  102. package/dist/server/auth/providers/custom.js.map +1 -0
  103. package/dist/server/auth/providers/custom.test.d.ts +1 -0
  104. package/dist/server/auth/providers/custom.test.js +156 -0
  105. package/dist/server/auth/providers/custom.test.js.map +1 -0
  106. package/dist/server/auth/providers/descope.d.ts +15 -0
  107. package/dist/server/auth/providers/descope.js +44 -0
  108. package/dist/server/auth/providers/descope.js.map +1 -0
  109. package/dist/server/auth/providers/descope.test.d.ts +1 -0
  110. package/dist/server/auth/providers/descope.test.js +60 -0
  111. package/dist/server/auth/providers/descope.test.js.map +1 -0
  112. package/dist/server/auth/providers/shared.d.ts +2 -0
  113. package/dist/server/auth/providers/shared.js +6 -0
  114. package/dist/server/auth/providers/shared.js.map +1 -0
  115. package/dist/server/auth/providers/shared.test.d.ts +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/security-schemes.d.ts +23 -0
  125. package/dist/server/auth/security-schemes.js +64 -0
  126. package/dist/server/auth/security-schemes.js.map +1 -0
  127. package/dist/server/auth/security-schemes.test.d.ts +1 -0
  128. package/dist/server/auth/security-schemes.test.js +99 -0
  129. package/dist/server/auth/security-schemes.test.js.map +1 -0
  130. package/dist/server/auth/setup.d.ts +6 -0
  131. package/dist/server/auth/setup.js +92 -0
  132. package/dist/server/auth/setup.js.map +1 -0
  133. package/dist/server/auth/setup.test.d.ts +1 -0
  134. package/dist/server/auth/setup.test.js +474 -0
  135. package/dist/server/auth/setup.test.js.map +1 -0
  136. package/dist/server/auth/verify.d.ts +12 -0
  137. package/dist/server/auth/verify.js +38 -0
  138. package/dist/server/auth/verify.js.map +1 -0
  139. package/dist/server/auth/verify.test.d.ts +1 -0
  140. package/dist/server/auth/verify.test.js +100 -0
  141. package/dist/server/auth/verify.test.js.map +1 -0
  142. package/dist/server/auth.d.ts +20 -0
  143. package/dist/server/auth.js +28 -0
  144. package/dist/server/auth.js.map +1 -0
  145. package/dist/server/build-manifest.test.d.ts +1 -0
  146. package/dist/server/build-manifest.test.js +27 -0
  147. package/dist/server/build-manifest.test.js.map +1 -0
  148. package/dist/server/content-helpers.d.ts +40 -0
  149. package/dist/server/content-helpers.js +33 -0
  150. package/dist/server/content-helpers.js.map +1 -1
  151. package/dist/server/content-helpers.test.js.map +1 -1
  152. package/dist/server/express.d.ts +1 -5
  153. package/dist/server/express.js +31 -7
  154. package/dist/server/express.js.map +1 -1
  155. package/dist/server/express.test.js +271 -69
  156. package/dist/server/express.test.js.map +1 -1
  157. package/dist/server/file-ref.d.ts +28 -0
  158. package/dist/server/file-ref.js +27 -0
  159. package/dist/server/file-ref.js.map +1 -0
  160. package/dist/server/host.d.ts +2 -0
  161. package/dist/server/host.js +11 -0
  162. package/dist/server/host.js.map +1 -0
  163. package/dist/server/host.test.d.ts +1 -0
  164. package/dist/server/host.test.js +13 -0
  165. package/dist/server/host.test.js.map +1 -0
  166. package/dist/server/index.d.ts +12 -2
  167. package/dist/server/index.js +10 -1
  168. package/dist/server/index.js.map +1 -1
  169. package/dist/server/inferUtilityTypes.js.map +1 -1
  170. package/dist/server/metric.js.map +1 -1
  171. package/dist/server/middleware.d.ts +16 -3
  172. package/dist/server/middleware.js.map +1 -1
  173. package/dist/server/middleware.test-d.js.map +1 -1
  174. package/dist/server/middleware.test.js.map +1 -1
  175. package/dist/server/requestOrigin.d.ts +7 -0
  176. package/dist/server/requestOrigin.js +25 -0
  177. package/dist/server/requestOrigin.js.map +1 -0
  178. package/dist/server/server.d.ts +292 -10
  179. package/dist/server/server.js +479 -184
  180. package/dist/server/server.js.map +1 -1
  181. package/dist/server/skills-integration.test.d.ts +1 -0
  182. package/dist/server/skills-integration.test.js +63 -0
  183. package/dist/server/skills-integration.test.js.map +1 -0
  184. package/dist/server/skills.d.ts +23 -0
  185. package/dist/server/skills.js +178 -0
  186. package/dist/server/skills.js.map +1 -0
  187. package/dist/server/skills.test.d.ts +1 -0
  188. package/dist/server/skills.test.js +210 -0
  189. package/dist/server/skills.test.js.map +1 -0
  190. package/dist/server/templateHelper.d.ts +0 -2
  191. package/dist/server/templateHelper.js +3 -22
  192. package/dist/server/templateHelper.js.map +1 -1
  193. package/dist/server/templates.generated.d.ts +4 -0
  194. package/dist/server/templates.generated.js +47 -0
  195. package/dist/server/templates.generated.js.map +1 -0
  196. package/dist/server/tunnel-proxy-router.d.ts +7 -0
  197. package/dist/server/tunnel-proxy-router.js +110 -0
  198. package/dist/server/tunnel-proxy-router.js.map +1 -0
  199. package/dist/server/tunnel-proxy-router.test.d.ts +1 -0
  200. package/dist/server/tunnel-proxy-router.test.js +229 -0
  201. package/dist/server/tunnel-proxy-router.test.js.map +1 -0
  202. package/dist/server/view-name.test-d.d.ts +1 -0
  203. package/dist/server/view-name.test-d.js +8 -0
  204. package/dist/server/view-name.test-d.js.map +1 -0
  205. package/dist/server/view-resource-resolution.test.d.ts +6 -0
  206. package/dist/server/view-resource-resolution.test.js +171 -0
  207. package/dist/server/view-resource-resolution.test.js.map +1 -0
  208. package/dist/server/viewsDevServer.js +4 -1
  209. package/dist/server/viewsDevServer.js.map +1 -1
  210. package/dist/test/utils.js.map +1 -1
  211. package/dist/test/view.test.js +109 -96
  212. package/dist/test/view.test.js.map +1 -1
  213. package/dist/version.js +1 -3
  214. package/dist/version.js.map +1 -1
  215. package/dist/web/bridges/adaptor.d.ts +51 -0
  216. package/dist/web/bridges/adaptor.js +341 -0
  217. package/dist/web/bridges/adaptor.js.map +1 -0
  218. package/dist/web/bridges/adaptor.test.d.ts +1 -0
  219. package/dist/web/bridges/adaptor.test.js +224 -0
  220. package/dist/web/bridges/adaptor.test.js.map +1 -0
  221. package/dist/web/bridges/apps-sdk/bridge.d.ts +6 -1
  222. package/dist/web/bridges/apps-sdk/bridge.js +15 -3
  223. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -1
  224. package/dist/web/bridges/apps-sdk/index.d.ts +0 -1
  225. package/dist/web/bridges/apps-sdk/index.js +0 -1
  226. package/dist/web/bridges/apps-sdk/index.js.map +1 -1
  227. package/dist/web/bridges/apps-sdk/types.d.ts +8 -1
  228. package/dist/web/bridges/apps-sdk/types.js.map +1 -1
  229. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +11 -0
  230. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +11 -0
  231. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -1
  232. package/dist/web/bridges/get-adaptor.d.ts +7 -0
  233. package/dist/web/bridges/get-adaptor.js +9 -7
  234. package/dist/web/bridges/get-adaptor.js.map +1 -1
  235. package/dist/web/bridges/get-adaptor.test.d.ts +1 -0
  236. package/dist/web/bridges/get-adaptor.test.js +32 -0
  237. package/dist/web/bridges/get-adaptor.test.js.map +1 -0
  238. package/dist/web/bridges/index.js.map +1 -1
  239. package/dist/web/bridges/mcp-app/bridge.d.ts +15 -2
  240. package/dist/web/bridges/mcp-app/bridge.js +73 -7
  241. package/dist/web/bridges/mcp-app/bridge.js.map +1 -1
  242. package/dist/web/bridges/mcp-app/bridge.test.d.ts +1 -0
  243. package/dist/web/bridges/mcp-app/bridge.test.js +17 -0
  244. package/dist/web/bridges/mcp-app/bridge.test.js.map +1 -0
  245. package/dist/web/bridges/mcp-app/index.d.ts +0 -1
  246. package/dist/web/bridges/mcp-app/index.js +0 -1
  247. package/dist/web/bridges/mcp-app/index.js.map +1 -1
  248. package/dist/web/bridges/mcp-app/types.d.ts +2 -0
  249. package/dist/web/bridges/mcp-app/types.js.map +1 -1
  250. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +12 -0
  251. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +12 -0
  252. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -1
  253. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -1
  254. package/dist/web/bridges/mcp-app/view-tools.test.d.ts +1 -0
  255. package/dist/web/bridges/mcp-app/view-tools.test.js +143 -0
  256. package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -0
  257. package/dist/web/bridges/types.d.ts +108 -3
  258. package/dist/web/bridges/types.js +14 -1
  259. package/dist/web/bridges/types.js.map +1 -1
  260. package/dist/web/bridges/types.test.d.ts +1 -0
  261. package/dist/web/bridges/types.test.js +19 -0
  262. package/dist/web/bridges/types.test.js.map +1 -0
  263. package/dist/web/bridges/use-host-context.d.ts +5 -0
  264. package/dist/web/bridges/use-host-context.js +5 -0
  265. package/dist/web/bridges/use-host-context.js.map +1 -1
  266. package/dist/web/components/modal-provider.d.ts +1 -1
  267. package/dist/web/components/modal-provider.js +4 -3
  268. package/dist/web/components/modal-provider.js.map +1 -1
  269. package/dist/web/create-store.d.ts +26 -0
  270. package/dist/web/create-store.js +26 -0
  271. package/dist/web/create-store.js.map +1 -1
  272. package/dist/web/create-store.test.js +8 -5
  273. package/dist/web/create-store.test.js.map +1 -1
  274. package/dist/web/data-llm.d.ts +34 -1
  275. package/dist/web/data-llm.js +28 -0
  276. package/dist/web/data-llm.js.map +1 -1
  277. package/dist/web/data-llm.test.js +17 -5
  278. package/dist/web/data-llm.test.js.map +1 -1
  279. package/dist/web/generate-helpers.d.ts +2 -0
  280. package/dist/web/generate-helpers.js +2 -0
  281. package/dist/web/generate-helpers.js.map +1 -1
  282. package/dist/web/generate-helpers.test-d.js +4 -2
  283. package/dist/web/generate-helpers.test-d.js.map +1 -1
  284. package/dist/web/generate-helpers.test.js.map +1 -1
  285. package/dist/web/helpers/state.js.map +1 -1
  286. package/dist/web/helpers/state.test.js.map +1 -1
  287. package/dist/web/hooks/index.d.ts +5 -0
  288. package/dist/web/hooks/index.js +5 -0
  289. package/dist/web/hooks/index.js.map +1 -1
  290. package/dist/web/hooks/test/utils.d.ts +7 -2
  291. package/dist/web/hooks/test/utils.js +14 -3
  292. package/dist/web/hooks/test/utils.js.map +1 -1
  293. package/dist/web/hooks/use-call-tool.d.ts +45 -0
  294. package/dist/web/hooks/use-call-tool.js +28 -0
  295. package/dist/web/hooks/use-call-tool.js.map +1 -1
  296. package/dist/web/hooks/use-call-tool.test-d.js.map +1 -1
  297. package/dist/web/hooks/use-call-tool.test.js +62 -27
  298. package/dist/web/hooks/use-call-tool.test.js.map +1 -1
  299. package/dist/web/hooks/use-display-mode.d.ts +20 -0
  300. package/dist/web/hooks/use-display-mode.js +20 -0
  301. package/dist/web/hooks/use-display-mode.js.map +1 -1
  302. package/dist/web/hooks/use-display-mode.test-d.js.map +1 -1
  303. package/dist/web/hooks/use-display-mode.test.js +56 -20
  304. package/dist/web/hooks/use-display-mode.test.js.map +1 -1
  305. package/dist/web/hooks/use-download.d.ts +5 -0
  306. package/dist/web/hooks/use-download.js +8 -0
  307. package/dist/web/hooks/use-download.js.map +1 -0
  308. package/dist/web/hooks/use-download.test.d.ts +1 -0
  309. package/dist/web/hooks/use-download.test.js +103 -0
  310. package/dist/web/hooks/use-download.test.js.map +1 -0
  311. package/dist/web/hooks/use-files.d.ts +32 -0
  312. package/dist/web/hooks/use-files.js +32 -0
  313. package/dist/web/hooks/use-files.js.map +1 -1
  314. package/dist/web/hooks/use-files.test.js +10 -2
  315. package/dist/web/hooks/use-files.test.js.map +1 -1
  316. package/dist/web/hooks/use-host-info.d.ts +22 -0
  317. package/dist/web/hooks/use-host-info.js +30 -0
  318. package/dist/web/hooks/use-host-info.js.map +1 -0
  319. package/dist/web/hooks/use-host-info.test.d.ts +1 -0
  320. package/dist/web/hooks/use-host-info.test.js +59 -0
  321. package/dist/web/hooks/use-host-info.test.js.map +1 -0
  322. package/dist/web/hooks/use-layout.d.ts +2 -0
  323. package/dist/web/hooks/use-layout.js +2 -0
  324. package/dist/web/hooks/use-layout.js.map +1 -1
  325. package/dist/web/hooks/use-layout.test.js +59 -26
  326. package/dist/web/hooks/use-layout.test.js.map +1 -1
  327. package/dist/web/hooks/use-open-external.d.ts +17 -0
  328. package/dist/web/hooks/use-open-external.js +16 -0
  329. package/dist/web/hooks/use-open-external.js.map +1 -1
  330. package/dist/web/hooks/use-open-external.test.js +13 -3
  331. package/dist/web/hooks/use-open-external.test.js.map +1 -1
  332. package/dist/web/hooks/use-register-view-tool.d.ts +38 -0
  333. package/dist/web/hooks/use-register-view-tool.js +50 -0
  334. package/dist/web/hooks/use-register-view-tool.js.map +1 -0
  335. package/dist/web/hooks/use-request-close.d.ts +16 -0
  336. package/dist/web/hooks/use-request-close.js +21 -0
  337. package/dist/web/hooks/use-request-close.js.map +1 -0
  338. package/dist/web/hooks/use-request-close.test.d.ts +1 -0
  339. package/dist/web/hooks/use-request-close.test.js +47 -0
  340. package/dist/web/hooks/use-request-close.test.js.map +1 -0
  341. package/dist/web/hooks/use-request-modal.d.ts +16 -1
  342. package/dist/web/hooks/use-request-modal.js +16 -1
  343. package/dist/web/hooks/use-request-modal.js.map +1 -1
  344. package/dist/web/hooks/use-request-modal.test.js +10 -0
  345. package/dist/web/hooks/use-request-modal.test.js.map +1 -1
  346. package/dist/web/hooks/use-request-size.d.ts +20 -0
  347. package/dist/web/hooks/use-request-size.js +24 -0
  348. package/dist/web/hooks/use-request-size.js.map +1 -0
  349. package/dist/web/hooks/use-request-size.test.d.ts +1 -0
  350. package/dist/web/hooks/use-request-size.test.js +47 -0
  351. package/dist/web/hooks/use-request-size.test.js.map +1 -0
  352. package/dist/web/hooks/use-send-follow-up-message.d.ts +19 -1
  353. package/dist/web/hooks/use-send-follow-up-message.js +19 -2
  354. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -1
  355. package/dist/web/hooks/use-set-open-in-app-url.d.ts +17 -0
  356. package/dist/web/hooks/use-set-open-in-app-url.js +17 -0
  357. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -1
  358. package/dist/web/hooks/use-set-open-in-app-url.test.js +28 -8
  359. package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -1
  360. package/dist/web/hooks/use-tool-info.d.ts +53 -2
  361. package/dist/web/hooks/use-tool-info.js +30 -7
  362. package/dist/web/hooks/use-tool-info.js.map +1 -1
  363. package/dist/web/hooks/use-tool-info.test-d.js +11 -29
  364. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -1
  365. package/dist/web/hooks/use-tool-info.test.js +42 -32
  366. package/dist/web/hooks/use-tool-info.test.js.map +1 -1
  367. package/dist/web/hooks/use-user.d.ts +2 -0
  368. package/dist/web/hooks/use-user.js +2 -0
  369. package/dist/web/hooks/use-user.js.map +1 -1
  370. package/dist/web/hooks/use-user.test.js +81 -35
  371. package/dist/web/hooks/use-user.test.js.map +1 -1
  372. package/dist/web/hooks/use-view-state.d.ts +21 -0
  373. package/dist/web/hooks/use-view-state.js +19 -9
  374. package/dist/web/hooks/use-view-state.js.map +1 -1
  375. package/dist/web/hooks/use-view-state.test.js +37 -2
  376. package/dist/web/hooks/use-view-state.test.js.map +1 -1
  377. package/dist/web/index.js.map +1 -1
  378. package/dist/web/mount-view.d.ts +19 -0
  379. package/dist/web/mount-view.js +19 -0
  380. package/dist/web/mount-view.js.map +1 -1
  381. package/dist/web/plugin/data-llm.test.js.map +1 -1
  382. package/dist/web/plugin/plugin.d.ts +34 -0
  383. package/dist/web/plugin/plugin.js +65 -17
  384. package/dist/web/plugin/plugin.js.map +1 -1
  385. package/dist/web/plugin/scan-views.d.ts +8 -0
  386. package/dist/web/plugin/scan-views.js +26 -8
  387. package/dist/web/plugin/scan-views.js.map +1 -1
  388. package/dist/web/plugin/scan-views.test.js +33 -1
  389. package/dist/web/plugin/scan-views.test.js.map +1 -1
  390. package/dist/web/plugin/transform-data-llm.js.map +1 -1
  391. package/dist/web/plugin/transform-data-llm.test.js.map +1 -1
  392. package/dist/web/plugin/validate-view.js.map +1 -1
  393. package/dist/web/plugin/validate-view.test.js.map +1 -1
  394. package/dist/web/proxy.js.map +1 -1
  395. package/dist/web/types.d.ts +4 -0
  396. package/dist/web/types.js.map +1 -1
  397. package/package.json +34 -24
  398. package/dist/server/templates/development.hbs +0 -12
  399. package/dist/server/templates/production.hbs +0 -6
  400. package/dist/web/bridges/apps-sdk/adaptor.d.ts +0 -24
  401. package/dist/web/bridges/apps-sdk/adaptor.js +0 -93
  402. package/dist/web/bridges/apps-sdk/adaptor.js.map +0 -1
  403. package/dist/web/bridges/mcp-app/adaptor.d.ts +0 -48
  404. package/dist/web/bridges/mcp-app/adaptor.js +0 -268
  405. package/dist/web/bridges/mcp-app/adaptor.js.map +0 -1
@@ -1,39 +1,75 @@
1
- import { act, renderHook } from "@testing-library/react";
2
- import { afterEach, beforeEach, describe, expect, it, vi, } from "vitest";
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";
3
8
  import { useDisplayMode } from "./use-display-mode.js";
4
9
  describe("useDisplayMode", () => {
5
- let OpenaiMock;
6
10
  beforeEach(() => {
7
- OpenaiMock = {
8
- displayMode: "inline",
9
- requestDisplayMode: vi.fn().mockResolvedValue({ mode: "inline" }),
10
- };
11
- vi.stubGlobal("openai", OpenaiMock);
11
+ HostAdaptor.resetInstance();
12
+ McpAppBridge.resetInstance();
13
+ AppsSdkBridge.resetInstance();
12
14
  vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
15
+ vi.stubGlobal("openai", { view: { mode: "inline" } });
16
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
13
17
  });
14
18
  afterEach(() => {
15
19
  vi.unstubAllGlobals();
16
20
  vi.resetAllMocks();
21
+ HostAdaptor.resetInstance();
22
+ McpAppBridge.resetInstance();
23
+ AppsSdkBridge.resetInstance();
17
24
  });
18
- it("should return the current display mode from window.openai.displayMode", () => {
19
- OpenaiMock.displayMode = "inline";
25
+ it("should return the current display mode from MCP host context", async () => {
26
+ vi.stubGlobal("parent", {
27
+ postMessage: getMcpAppHostPostMessageMock({ displayMode: "inline" }),
28
+ });
20
29
  const { result } = renderHook(() => useDisplayMode());
21
- expect(result.current[0]).toBe("inline");
30
+ await waitFor(() => {
31
+ expect(result.current[0]).toBe("inline");
32
+ });
22
33
  });
23
- it("should return different display modes when window.openai.displayMode changes", () => {
24
- OpenaiMock.displayMode = "inline";
25
- const { result, rerender } = renderHook(() => useDisplayMode());
26
- expect(result.current[0]).toBe("inline");
27
- OpenaiMock.displayMode = "fullscreen";
28
- rerender();
29
- expect(result.current[0]).toBe("fullscreen");
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
+ });
30
55
  });
31
- it("should call window.openai.requestDisplayMode with correct mode when setDisplayMode is called", async () => {
56
+ it("should call requestDisplayMode on the adaptor when setDisplayMode is called", async () => {
57
+ vi.stubGlobal("parent", {
58
+ postMessage: getMcpAppHostPostMessageMock({ displayMode: "inline" }),
59
+ });
32
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);
33
69
  await act(async () => {
34
70
  await result.current[1]("fullscreen");
35
71
  });
36
- expect(OpenaiMock.requestDisplayMode).toHaveBeenCalledWith({
72
+ expect(fakeApp.requestDisplayMode).toHaveBeenCalledWith({
37
73
  mode: "fullscreen",
38
74
  });
39
75
  });
@@ -1 +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,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EACL,SAAS,EACT,UAAU,EACV,QAAQ,EACR,MAAM,EACN,EAAE,EAEF,EAAE,GACH,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,IAAI,UAGH,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,WAAW,EAAE,QAAQ;YACrB,kBAAkB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;SAClE,CAAC;QACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACpC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC/E,UAAU,CAAC,WAAW,GAAG,QAAQ,CAAC;QAClC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;QAEtD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8EAA8E,EAAE,GAAG,EAAE;QACtF,UAAU,CAAC,WAAW,GAAG,QAAQ,CAAC;QAClC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;QAEhE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEzC,UAAU,CAAC,WAAW,GAAG,YAAY,CAAC;QACtC,QAAQ,EAAE,CAAC;QAEX,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8FAA8F,EAAE,KAAK,IAAI,EAAE;QAC5G,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;QAEtD,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,UAAU,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CAAC;YACzD,IAAI,EAAE,YAAY;SACnB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
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"]}
@@ -1,3 +1,35 @@
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
+ */
1
33
  export declare function useFiles(): {
2
34
  upload: (file: File, options?: import("../index.js").UploadFileOptions) => Promise<import("../index.js").FileMetadata>;
3
35
  getDownloadUrl: (file: import("../index.js").FileMetadata) => Promise<{
@@ -1,4 +1,36 @@
1
1
  import { getAdaptor } from "../bridges/index.js";
2
+ /**
3
+ * File operations bound to the current host: `upload` a `File`, resolve a
4
+ * `downloadUrl` for an uploaded file, and `selectFiles` to open the host's
5
+ * native file picker.
6
+ *
7
+ * Currently Apps-SDK-only — calling any of these from MCP Apps throws.
8
+ * `selectFiles` additionally requires a ChatGPT host version that exposes the
9
+ * picker; it throws if the capability is unavailable.
10
+ *
11
+ * `upload` returns `FileMetadata` (`fileId`, optional `fileName`, `mimeType`).
12
+ * To pass an uploaded file to a tool whose input uses {@link FileRef}, first
13
+ * call `getDownloadUrl` and then build the ref yourself — field names differ
14
+ * (camelCase on the client, snake_case in the schema) and `download_url` is
15
+ * required.
16
+ *
17
+ * @example
18
+ * ```tsx
19
+ * const { upload, getDownloadUrl } = useFiles();
20
+ * const meta = await upload(file);
21
+ * const { downloadUrl } = await getDownloadUrl(meta);
22
+ * callTool({
23
+ * document: {
24
+ * file_id: meta.fileId,
25
+ * download_url: downloadUrl,
26
+ * file_name: meta.fileName,
27
+ * mime_type: meta.mimeType,
28
+ * },
29
+ * });
30
+ * ```
31
+ *
32
+ * @see https://docs.skybridge.tech/api-reference/use-files
33
+ */
2
34
  export function useFiles() {
3
35
  const adaptor = getAdaptor();
4
36
  return {
@@ -1 +1 @@
1
- {"version":3,"file":"use-files.js","sourceRoot":"","sources":["../../../src/web/hooks/use-files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,MAAM,UAAU,QAAQ;IACtB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,OAAO;QACL,MAAM,EAAE,OAAO,CAAC,UAAU;QAC1B,cAAc,EAAE,OAAO,CAAC,kBAAkB;QAC1C,WAAW,EAAE,OAAO,CAAC,WAAW;KACjC,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"use-files.js","sourceRoot":"","sources":["../../../src/web/hooks/use-files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,QAAQ;IACtB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,OAAO;QACL,MAAM,EAAE,OAAO,CAAC,UAAU;QAC1B,cAAc,EAAE,OAAO,CAAC,kBAAkB;QAC1C,WAAW,EAAE,OAAO,CAAC,WAAW;KACjC,CAAC;AACJ,CAAC","sourcesContent":["import { getAdaptor } from \"../bridges/index.js\";\n\n/**\n * File operations bound to the current host: `upload` a `File`, resolve a\n * `downloadUrl` for an uploaded file, and `selectFiles` to open the host's\n * native file picker.\n *\n * Currently Apps-SDK-only — calling any of these from MCP Apps throws.\n * `selectFiles` additionally requires a ChatGPT host version that exposes the\n * picker; it throws if the capability is unavailable.\n *\n * `upload` returns `FileMetadata` (`fileId`, optional `fileName`, `mimeType`).\n * To pass an uploaded file to a tool whose input uses {@link FileRef}, first\n * call `getDownloadUrl` and then build the ref yourself — field names differ\n * (camelCase on the client, snake_case in the schema) and `download_url` is\n * required.\n *\n * @example\n * ```tsx\n * const { upload, getDownloadUrl } = useFiles();\n * const meta = await upload(file);\n * const { downloadUrl } = await getDownloadUrl(meta);\n * callTool({\n * document: {\n * file_id: meta.fileId,\n * download_url: downloadUrl,\n * file_name: meta.fileName,\n * mime_type: meta.mimeType,\n * },\n * });\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-files\n */\nexport function useFiles() {\n const adaptor = getAdaptor();\n return {\n upload: adaptor.uploadFile,\n getDownloadUrl: adaptor.getFileDownloadUrl,\n selectFiles: adaptor.selectFiles,\n };\n}\n"]}
@@ -1,6 +1,8 @@
1
1
  import { renderHook } from "@testing-library/react";
2
2
  import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
3
- import { AppsSdkAdaptor } from "../bridges/apps-sdk/adaptor.js";
3
+ import { HostAdaptor } from "../bridges/adaptor.js";
4
+ import { AppsSdkBridge } from "../bridges/apps-sdk/bridge.js";
5
+ import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
4
6
  import { useFiles } from "./use-files.js";
5
7
  describe("useFiles", () => {
6
8
  const OpenaiMock = {
@@ -12,13 +14,19 @@ describe("useFiles", () => {
12
14
  setWidgetState: vi.fn(),
13
15
  };
14
16
  beforeEach(() => {
17
+ HostAdaptor.resetInstance();
18
+ McpAppBridge.resetInstance();
19
+ AppsSdkBridge.resetInstance();
15
20
  vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
16
21
  vi.stubGlobal("openai", OpenaiMock);
22
+ vi.stubGlobal("parent", { postMessage: vi.fn() });
17
23
  });
18
24
  afterEach(() => {
19
25
  vi.unstubAllGlobals();
20
26
  vi.clearAllMocks();
21
- AppsSdkAdaptor.resetInstance();
27
+ HostAdaptor.resetInstance();
28
+ McpAppBridge.resetInstance();
29
+ AppsSdkBridge.resetInstance();
22
30
  });
23
31
  const dummyFile = new File([], "test.txt");
24
32
  it("should upload a file to ChatGPT", () => {
@@ -1 +1 @@
1
- {"version":3,"file":"use-files.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-files.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,MAAM,UAAU,GAA4B;QAC1C,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;YACpC,MAAM,EAAE,wBAAwB;SACjC,CAAC;QACF,kBAAkB,EAAE,EAAE,CAAC,EAAE,EAAE;QAC3B,WAAW,EAAE,IAAI;QACjB,cAAc,EAAE,EAAE,CAAC,EAAE,EAAE;KACxB,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACrD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACnB,cAAc,CAAC,aAAa,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IAE3C,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACjC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACpD,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE;YAC5D,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,aAAa,GAAG;YACpB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,EAAE;SACvE,CAAC;QACF,UAAU,CAAC,WAAW,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAElE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QACjD,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,gBAAgB,EAAE,CAAC;QAClD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAErC,OAAO,UAAU,CAAC,WAAW,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,MAAM,GAAG,KAAK,CAAC;QACrB,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC1C,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"use-files.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-files.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,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,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,MAAM,UAAU,GAA4B;QAC1C,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;YACpC,MAAM,EAAE,wBAAwB;SACjC,CAAC;QACF,kBAAkB,EAAE,EAAE,CAAC,EAAE,EAAE;QAC3B,WAAW,EAAE,IAAI;QACjB,cAAc,EAAE,EAAE,CAAC,EAAE,EAAE;KACxB,CAAC;IAEF,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,UAAU,CAAC,CAAC;QACpC,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACpD,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,SAAS,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IAE3C,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACjC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACpD,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE;YAC5D,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,aAAa,GAAG;YACpB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,EAAE;SACvE,CAAC;QACF,UAAU,CAAC,WAAW,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAElE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QACjD,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,gBAAgB,EAAE,CAAC;QAClD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAErC,OAAO,UAAU,CAAC,WAAW,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,MAAM,GAAG,KAAK,CAAC;QACrB,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC1C,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { renderHook } 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 { McpAppBridge } from \"../bridges/mcp-app/bridge.js\";\nimport { useFiles } from \"./use-files.js\";\n\ndescribe(\"useFiles\", () => {\n const OpenaiMock: Record<string, unknown> = {\n uploadFile: vi.fn().mockResolvedValue({\n fileId: `sediment://file_abc123`,\n }),\n getFileDownloadUrl: vi.fn(),\n widgetState: null,\n setWidgetState: vi.fn(),\n };\n\n beforeEach(() => {\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n AppsSdkBridge.resetInstance();\n vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n vi.stubGlobal(\"openai\", OpenaiMock);\n vi.stubGlobal(\"parent\", { postMessage: vi.fn() });\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.clearAllMocks();\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n AppsSdkBridge.resetInstance();\n });\n\n const dummyFile = new File([], \"test.txt\");\n\n it(\"should upload a file to ChatGPT\", () => {\n const { result } = renderHook(() => useFiles());\n\n result.current.upload(dummyFile);\n expect(OpenaiMock.uploadFile).toHaveBeenCalledWith(dummyFile, undefined);\n });\n\n it(\"should upload a file with library option\", () => {\n const { result } = renderHook(() => useFiles());\n\n result.current.upload(dummyFile, { library: true });\n expect(OpenaiMock.uploadFile).toHaveBeenCalledWith(dummyFile, {\n library: true,\n });\n });\n\n it(\"should select files from ChatGPT\", async () => {\n const selectedFiles = [\n { fileId: \"file_1\", fileName: \"doc.pdf\", mimeType: \"application/pdf\" },\n ];\n OpenaiMock.selectFiles = vi.fn().mockResolvedValue(selectedFiles);\n\n const { result } = renderHook(() => useFiles());\n\n const files = await result.current.selectFiles();\n expect(OpenaiMock.selectFiles).toHaveBeenCalled();\n expect(files).toEqual(selectedFiles);\n\n delete OpenaiMock.selectFiles;\n });\n\n it(\"should download a file from ChatGPT\", () => {\n const fileId = \"123\";\n const { result } = renderHook(() => useFiles());\n\n result.current.getDownloadUrl({ fileId });\n expect(OpenaiMock.getFileDownloadUrl).toHaveBeenCalledWith({ fileId });\n });\n});\n"]}
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Known host applications, as normalized slugs. Unrecognized hosts surface
3
+ * their raw `hostInfo.name` string instead.
4
+ */
5
+ export type Host = "chatgpt" | "claude" | "cursor" | "goose" | "mistral-vibe" | "alpic";
6
+ export type HostInfo = {
7
+ name: Host | (string & {}) | undefined;
8
+ version: string | undefined;
9
+ };
10
+ /**
11
+ * Identity of the host application rendering the view, from the MCP Apps
12
+ * `ui/initialize` handshake. `name` is normalized to a {@link Host} slug when
13
+ * recognized, otherwise the raw string; both fields are `undefined` until the
14
+ * handshake resolves (the view renders first and re-renders once it lands).
15
+ *
16
+ * @example
17
+ * ```tsx
18
+ * const { name } = useHostInfo();
19
+ * if (name === "claude") return <ClaudeLayout />;
20
+ * ```
21
+ */
22
+ export declare function useHostInfo(): HostInfo;
@@ -0,0 +1,30 @@
1
+ import { useMcpAppContext } from "../bridges/index.js";
2
+ const HOST_BY_REPORTED_NAME = {
3
+ chatgpt: "chatgpt",
4
+ Claude: "claude",
5
+ Cursor: "cursor",
6
+ "MCP-UI Host": "goose",
7
+ "Le Chat": "mistral-vibe",
8
+ "alpic-playground": "alpic",
9
+ };
10
+ /**
11
+ * Identity of the host application rendering the view, from the MCP Apps
12
+ * `ui/initialize` handshake. `name` is normalized to a {@link Host} slug when
13
+ * recognized, otherwise the raw string; both fields are `undefined` until the
14
+ * handshake resolves (the view renders first and re-renders once it lands).
15
+ *
16
+ * @example
17
+ * ```tsx
18
+ * const { name } = useHostInfo();
19
+ * if (name === "claude") return <ClaudeLayout />;
20
+ * ```
21
+ */
22
+ export function useHostInfo() {
23
+ const hostInfo = useMcpAppContext("hostInfo");
24
+ const name = hostInfo?.name;
25
+ return {
26
+ name: name !== undefined ? (HOST_BY_REPORTED_NAME[name] ?? name) : undefined,
27
+ version: hostInfo?.version,
28
+ };
29
+ }
30
+ //# sourceMappingURL=use-host-info.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-host-info.js","sourceRoot":"","sources":["../../../src/web/hooks/use-host-info.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAcvD,MAAM,qBAAqB,GAAyB;IAClD,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,aAAa,EAAE,OAAO;IACtB,SAAS,EAAE,cAAc;IACzB,kBAAkB,EAAE,OAAO;CAC5B,CAAC;AAOF;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,WAAW;IACzB,MAAM,QAAQ,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAC9C,MAAM,IAAI,GAAG,QAAQ,EAAE,IAAI,CAAC;IAE5B,OAAO;QACL,IAAI,EACF,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;QACxE,OAAO,EAAE,QAAQ,EAAE,OAAO;KAC3B,CAAC;AACJ,CAAC","sourcesContent":["import { useMcpAppContext } from \"../bridges/index.js\";\n\n/**\n * Known host applications, as normalized slugs. Unrecognized hosts surface\n * their raw `hostInfo.name` string instead.\n */\nexport type Host =\n | \"chatgpt\"\n | \"claude\"\n | \"cursor\"\n | \"goose\"\n | \"mistral-vibe\"\n | \"alpic\";\n\nconst HOST_BY_REPORTED_NAME: Record<string, Host> = {\n chatgpt: \"chatgpt\",\n Claude: \"claude\",\n Cursor: \"cursor\",\n \"MCP-UI Host\": \"goose\",\n \"Le Chat\": \"mistral-vibe\",\n \"alpic-playground\": \"alpic\",\n};\n\nexport type HostInfo = {\n name: Host | (string & {}) | undefined;\n version: string | undefined;\n};\n\n/**\n * Identity of the host application rendering the view, from the MCP Apps\n * `ui/initialize` handshake. `name` is normalized to a {@link Host} slug when\n * recognized, otherwise the raw string; both fields are `undefined` until the\n * handshake resolves (the view renders first and re-renders once it lands).\n *\n * @example\n * ```tsx\n * const { name } = useHostInfo();\n * if (name === \"claude\") return <ClaudeLayout />;\n * ```\n */\nexport function useHostInfo(): HostInfo {\n const hostInfo = useMcpAppContext(\"hostInfo\");\n const name = hostInfo?.name;\n\n return {\n name:\n name !== undefined ? (HOST_BY_REPORTED_NAME[name] ?? name) : undefined,\n version: hostInfo?.version,\n };\n}\n"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,59 @@
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 { useHostInfo } from "./use-host-info.js";
7
+ const stubHost = (hostInfo) => {
8
+ vi.stubGlobal("parent", {
9
+ postMessage: getMcpAppHostPostMessageMock({}, { hostInfo }),
10
+ });
11
+ };
12
+ describe("useHostInfo", () => {
13
+ beforeEach(() => {
14
+ HostAdaptor.resetInstance();
15
+ McpAppBridge.resetInstance();
16
+ vi.stubGlobal("openai", undefined);
17
+ vi.stubGlobal("skybridge", { hostType: "mcp-app" });
18
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
19
+ });
20
+ afterEach(() => {
21
+ vi.unstubAllGlobals();
22
+ vi.resetAllMocks();
23
+ McpAppBridge.resetInstance();
24
+ HostAdaptor.resetInstance();
25
+ });
26
+ it("is undefined before the handshake resolves, then populated after", async () => {
27
+ stubHost({ name: "Claude", version: "1.2.3" });
28
+ const { result } = renderHook(() => useHostInfo());
29
+ expect(result.current.name).toBeUndefined();
30
+ expect(result.current.version).toBeUndefined();
31
+ await waitFor(() => {
32
+ expect(result.current.name).toBe("claude");
33
+ expect(result.current.version).toBe("1.2.3");
34
+ });
35
+ });
36
+ it.each([
37
+ ["chatgpt", "chatgpt"],
38
+ ["Claude", "claude"],
39
+ ["Cursor", "cursor"],
40
+ ["MCP-UI Host", "goose"],
41
+ ["Le Chat", "mistral-vibe"],
42
+ ["alpic-playground", "alpic"],
43
+ ])("normalizes reported name %j to slug %j", async (reported, slug) => {
44
+ stubHost({ name: reported, version: "1.0.0" });
45
+ const { result } = renderHook(() => useHostInfo());
46
+ await waitFor(() => {
47
+ expect(result.current.name).toBe(slug);
48
+ });
49
+ });
50
+ it("preserves an unrecognized reported name as-is", async () => {
51
+ stubHost({ name: "Some Future Host", version: "9.9.9" });
52
+ const { result } = renderHook(() => useHostInfo());
53
+ await waitFor(() => {
54
+ expect(result.current.name).toBe("Some Future Host");
55
+ expect(result.current.version).toBe("9.9.9");
56
+ });
57
+ });
58
+ });
59
+ //# sourceMappingURL=use-host-info.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-host-info.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-host-info.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,EAAa,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAE5D,MAAM,QAAQ,GAAG,CAAC,QAA4C,EAAE,EAAE;IAChE,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;QACtB,WAAW,EAAE,4BAA4B,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC;KAC5D,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,UAAU,CAAC,GAAG,EAAE;QACd,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACnC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QACpD,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,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,WAAW,CAAC,aAAa,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;QAChF,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/C,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAEnD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;QAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,CAAC;QAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAiB;QACtB,CAAC,SAAS,EAAE,SAAS,CAAC;QACtB,CAAC,QAAQ,EAAE,QAAQ,CAAC;QACpB,CAAC,QAAQ,EAAE,QAAQ,CAAC;QACpB,CAAC,aAAa,EAAE,OAAO,CAAC;QACxB,CAAC,SAAS,EAAE,cAAc,CAAC;QAC3B,CAAC,kBAAkB,EAAE,OAAO,CAAC;KAC9B,CAAC,CAAC,wCAAwC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;QACpE,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/C,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAEnD,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC7D,QAAQ,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QACzD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAEnD,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/C,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 { type Host, useHostInfo } from \"./use-host-info.js\";\n\nconst stubHost = (hostInfo?: { name: string; version: string }) => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({}, { hostInfo }),\n });\n};\n\ndescribe(\"useHostInfo\", () => {\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(() => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n McpAppBridge.resetInstance();\n HostAdaptor.resetInstance();\n });\n\n it(\"is undefined before the handshake resolves, then populated after\", async () => {\n stubHost({ name: \"Claude\", version: \"1.2.3\" });\n const { result } = renderHook(() => useHostInfo());\n\n expect(result.current.name).toBeUndefined();\n expect(result.current.version).toBeUndefined();\n\n await waitFor(() => {\n expect(result.current.name).toBe(\"claude\");\n expect(result.current.version).toBe(\"1.2.3\");\n });\n });\n\n it.each<[string, Host]>([\n [\"chatgpt\", \"chatgpt\"],\n [\"Claude\", \"claude\"],\n [\"Cursor\", \"cursor\"],\n [\"MCP-UI Host\", \"goose\"],\n [\"Le Chat\", \"mistral-vibe\"],\n [\"alpic-playground\", \"alpic\"],\n ])(\"normalizes reported name %j to slug %j\", async (reported, slug) => {\n stubHost({ name: reported, version: \"1.0.0\" });\n const { result } = renderHook(() => useHostInfo());\n\n await waitFor(() => {\n expect(result.current.name).toBe(slug);\n });\n });\n\n it(\"preserves an unrecognized reported name as-is\", async () => {\n stubHost({ name: \"Some Future Host\", version: \"9.9.9\" });\n const { result } = renderHook(() => useHostInfo());\n\n await waitFor(() => {\n expect(result.current.name).toBe(\"Some Future Host\");\n expect(result.current.version).toBe(\"9.9.9\");\n });\n });\n});\n"]}
@@ -18,5 +18,7 @@ export type LayoutState = {
18
18
  * // Respect safe area insets
19
19
  * const paddingTop = safeArea.insets.top;
20
20
  * ```
21
+ *
22
+ * @see https://docs.skybridge.tech/api-reference/use-layout
21
23
  */
22
24
  export declare function useLayout(): LayoutState;
@@ -13,6 +13,8 @@ import { useHostContext } from "../bridges/index.js";
13
13
  * // Respect safe area insets
14
14
  * const paddingTop = safeArea.insets.top;
15
15
  * ```
16
+ *
17
+ * @see https://docs.skybridge.tech/api-reference/use-layout
16
18
  */
17
19
  export function useLayout() {
18
20
  const theme = useHostContext("theme");
@@ -1 +1 @@
1
- {"version":3,"file":"use-layout.js","sourceRoot":"","sources":["../../../src/web/hooks/use-layout.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAQhF;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,SAAS;IACvB,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,SAAS,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;IAE5C,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;AACxC,CAAC"}
1
+ {"version":3,"file":"use-layout.js","sourceRoot":"","sources":["../../../src/web/hooks/use-layout.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAQhF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,SAAS;IACvB,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,SAAS,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;IAE5C,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;AACxC,CAAC","sourcesContent":["import { type SafeArea, type Theme, useHostContext } from \"../bridges/index.js\";\n\nexport type LayoutState = {\n theme: Theme;\n maxHeight: number | undefined;\n safeArea: SafeArea;\n};\n\n/**\n * Hook for accessing layout and visual environment information.\n * These values may change on resize or theme toggle.\n *\n * @example\n * ```tsx\n * const { theme, maxHeight, safeArea } = useLayout();\n *\n * // Apply theme-aware styling\n * const backgroundColor = theme === \"dark\" ? \"#1a1a1a\" : \"#ffffff\";\n *\n * // Respect safe area insets\n * const paddingTop = safeArea.insets.top;\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-layout\n */\nexport function useLayout(): LayoutState {\n const theme = useHostContext(\"theme\");\n const maxHeight = useHostContext(\"maxHeight\");\n const safeArea = useHostContext(\"safeArea\");\n\n return { theme, maxHeight, safeArea };\n}\n"]}