skybridge 0.0.0-dev.fb0af8c → 0.0.0-dev.fb11426

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 (421) hide show
  1. package/README.md +152 -0
  2. package/bin/run.js +0 -4
  3. package/dist/cli/build-helpers.d.ts +7 -0
  4. package/dist/cli/build-helpers.js +82 -0
  5. package/dist/cli/build-helpers.js.map +1 -0
  6. package/dist/cli/build-helpers.test.js +64 -0
  7. package/dist/cli/build-helpers.test.js.map +1 -0
  8. package/dist/cli/detect-port.d.ts +18 -0
  9. package/dist/cli/detect-port.js +50 -0
  10. package/dist/cli/detect-port.js.map +1 -0
  11. package/dist/cli/header.d.ts +4 -0
  12. package/dist/cli/header.js +6 -0
  13. package/dist/cli/header.js.map +1 -0
  14. package/dist/cli/resolve-views-dir.d.ts +1 -0
  15. package/dist/cli/resolve-views-dir.js +17 -0
  16. package/dist/cli/resolve-views-dir.js.map +1 -0
  17. package/dist/cli/run-command.d.ts +2 -0
  18. package/dist/cli/run-command.js +43 -0
  19. package/dist/cli/run-command.js.map +1 -0
  20. package/dist/cli/telemetry.d.ts +7 -0
  21. package/dist/cli/telemetry.js +123 -0
  22. package/dist/cli/telemetry.js.map +1 -0
  23. package/dist/cli/tunnel-control-server.d.ts +9 -0
  24. package/dist/cli/tunnel-control-server.js +31 -0
  25. package/dist/cli/tunnel-control-server.js.map +1 -0
  26. package/dist/cli/tunnel-control-server.test.js +39 -0
  27. package/dist/cli/tunnel-control-server.test.js.map +1 -0
  28. package/dist/cli/tunnel-handler.d.ts +3 -0
  29. package/dist/cli/tunnel-handler.js +48 -0
  30. package/dist/cli/tunnel-handler.js.map +1 -0
  31. package/dist/cli/tunnel-handler.test.js +105 -0
  32. package/dist/cli/tunnel-handler.test.js.map +1 -0
  33. package/dist/cli/tunnel.d.ts +57 -0
  34. package/dist/cli/tunnel.js +154 -0
  35. package/dist/cli/tunnel.js.map +1 -0
  36. package/dist/cli/tunnel.test.d.ts +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 +6 -1
  67. package/dist/commands/dev.js +87 -21
  68. package/dist/commands/dev.js.map +1 -1
  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.d.ts +1 -0
  85. package/dist/server/asset-base-url-transform-plugin.test.js +134 -0
  86. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -0
  87. package/dist/server/auth/discovery.d.ts +7 -0
  88. package/dist/server/auth/discovery.js +41 -0
  89. package/dist/server/auth/discovery.js.map +1 -0
  90. package/dist/server/auth/discovery.test.d.ts +1 -0
  91. package/dist/server/auth/discovery.test.js +73 -0
  92. package/dist/server/auth/discovery.test.js.map +1 -0
  93. package/dist/server/auth/index.d.ts +16 -0
  94. package/dist/server/auth/index.js +2 -0
  95. package/dist/server/auth/index.js.map +1 -0
  96. package/dist/server/auth/providers/custom.d.ts +12 -0
  97. package/dist/server/auth/providers/custom.js +28 -0
  98. package/dist/server/auth/providers/custom.js.map +1 -0
  99. package/dist/server/auth/providers/custom.test.d.ts +1 -0
  100. package/dist/server/auth/providers/custom.test.js +82 -0
  101. package/dist/server/auth/providers/custom.test.js.map +1 -0
  102. package/dist/server/auth/setup.d.ts +4 -0
  103. package/dist/server/auth/setup.js +28 -0
  104. package/dist/server/auth/setup.js.map +1 -0
  105. package/dist/server/auth/setup.test.d.ts +1 -0
  106. package/dist/server/auth/setup.test.js +161 -0
  107. package/dist/server/auth/setup.test.js.map +1 -0
  108. package/dist/server/auth/verify.d.ts +11 -0
  109. package/dist/server/auth/verify.js +37 -0
  110. package/dist/server/auth/verify.js.map +1 -0
  111. package/dist/server/auth/verify.test.d.ts +1 -0
  112. package/dist/server/auth/verify.test.js +87 -0
  113. package/dist/server/auth/verify.test.js.map +1 -0
  114. package/dist/server/auth.d.ts +20 -0
  115. package/dist/server/auth.js +28 -0
  116. package/dist/server/auth.js.map +1 -0
  117. package/dist/server/build-manifest.test.d.ts +1 -0
  118. package/dist/server/build-manifest.test.js +27 -0
  119. package/dist/server/build-manifest.test.js.map +1 -0
  120. package/dist/server/content-helpers.d.ts +67 -0
  121. package/dist/server/content-helpers.js +79 -0
  122. package/dist/server/content-helpers.js.map +1 -0
  123. package/dist/server/content-helpers.test.d.ts +1 -0
  124. package/dist/server/content-helpers.test.js +70 -0
  125. package/dist/server/content-helpers.test.js.map +1 -0
  126. package/dist/server/express.d.ts +11 -0
  127. package/dist/server/express.js +101 -0
  128. package/dist/server/express.js.map +1 -0
  129. package/dist/server/express.test.d.ts +1 -0
  130. package/dist/server/express.test.js +491 -0
  131. package/dist/server/express.test.js.map +1 -0
  132. package/dist/server/file-ref.d.ts +28 -0
  133. package/dist/server/file-ref.js +27 -0
  134. package/dist/server/file-ref.js.map +1 -0
  135. package/dist/server/index.d.ts +9 -3
  136. package/dist/server/index.js +6 -2
  137. package/dist/server/index.js.map +1 -1
  138. package/dist/server/inferUtilityTypes.d.ts +6 -6
  139. package/dist/server/inferUtilityTypes.js.map +1 -1
  140. package/dist/server/metric.d.ts +14 -0
  141. package/dist/server/metric.js +62 -0
  142. package/dist/server/metric.js.map +1 -0
  143. package/dist/server/middleware.d.ts +137 -0
  144. package/dist/server/middleware.js +93 -0
  145. package/dist/server/middleware.js.map +1 -0
  146. package/dist/server/middleware.test-d.d.ts +1 -0
  147. package/dist/server/middleware.test-d.js +75 -0
  148. package/dist/server/middleware.test-d.js.map +1 -0
  149. package/dist/server/middleware.test.d.ts +1 -0
  150. package/dist/server/middleware.test.js +493 -0
  151. package/dist/server/middleware.test.js.map +1 -0
  152. package/dist/server/server.d.ts +363 -61
  153. package/dist/server/server.js +614 -86
  154. package/dist/server/server.js.map +1 -1
  155. package/dist/server/templateHelper.d.ts +5 -7
  156. package/dist/server/templateHelper.js +3 -22
  157. package/dist/server/templateHelper.js.map +1 -1
  158. package/dist/server/templates.generated.d.ts +4 -0
  159. package/dist/server/templates.generated.js +47 -0
  160. package/dist/server/templates.generated.js.map +1 -0
  161. package/dist/server/tunnel-proxy-router.d.ts +7 -0
  162. package/dist/server/tunnel-proxy-router.js +110 -0
  163. package/dist/server/tunnel-proxy-router.js.map +1 -0
  164. package/dist/server/tunnel-proxy-router.test.d.ts +1 -0
  165. package/dist/server/tunnel-proxy-router.test.js +229 -0
  166. package/dist/server/tunnel-proxy-router.test.js.map +1 -0
  167. package/dist/server/view-resource-resolution.test.d.ts +6 -0
  168. package/dist/server/view-resource-resolution.test.js +88 -0
  169. package/dist/server/view-resource-resolution.test.js.map +1 -0
  170. package/dist/server/viewsDevServer.d.ts +14 -0
  171. package/dist/server/viewsDevServer.js +45 -0
  172. package/dist/server/viewsDevServer.js.map +1 -0
  173. package/dist/test/utils.d.ts +13 -21
  174. package/dist/test/utils.js +42 -37
  175. package/dist/test/utils.js.map +1 -1
  176. package/dist/test/view.test.d.ts +1 -0
  177. package/dist/test/view.test.js +568 -0
  178. package/dist/test/view.test.js.map +1 -0
  179. package/dist/version.d.ts +1 -0
  180. package/dist/version.js +3 -0
  181. package/dist/version.js.map +1 -0
  182. package/dist/web/bridges/apps-sdk/adaptor.d.ts +29 -0
  183. package/dist/web/bridges/apps-sdk/adaptor.js +117 -0
  184. package/dist/web/bridges/apps-sdk/adaptor.js.map +1 -0
  185. package/dist/web/bridges/apps-sdk/bridge.d.ts +11 -0
  186. package/dist/web/bridges/{apps-sdk-bridge.js → apps-sdk/bridge.js} +3 -2
  187. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -0
  188. package/dist/web/bridges/apps-sdk/index.d.ts +5 -0
  189. package/dist/web/bridges/apps-sdk/index.js +5 -0
  190. package/dist/web/bridges/apps-sdk/index.js.map +1 -0
  191. package/dist/web/bridges/apps-sdk/types.d.ts +133 -0
  192. package/dist/web/bridges/apps-sdk/types.js +10 -0
  193. package/dist/web/bridges/apps-sdk/types.js.map +1 -0
  194. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +13 -0
  195. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +18 -0
  196. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -0
  197. package/dist/web/bridges/get-adaptor.d.ts +9 -0
  198. package/dist/web/bridges/get-adaptor.js +15 -0
  199. package/dist/web/bridges/get-adaptor.js.map +1 -0
  200. package/dist/web/bridges/index.d.ts +5 -4
  201. package/dist/web/bridges/index.js +5 -4
  202. package/dist/web/bridges/index.js.map +1 -1
  203. package/dist/web/bridges/mcp-app/adaptor.d.ts +53 -0
  204. package/dist/web/bridges/mcp-app/adaptor.js +283 -0
  205. package/dist/web/bridges/mcp-app/adaptor.js.map +1 -0
  206. package/dist/web/bridges/mcp-app/bridge.d.ts +28 -0
  207. package/dist/web/bridges/mcp-app/bridge.js +124 -0
  208. package/dist/web/bridges/mcp-app/bridge.js.map +1 -0
  209. package/dist/web/bridges/mcp-app/index.d.ts +4 -0
  210. package/dist/web/bridges/mcp-app/index.js +4 -0
  211. package/dist/web/bridges/mcp-app/index.js.map +1 -0
  212. package/dist/web/bridges/mcp-app/types.d.ts +8 -0
  213. package/dist/web/bridges/mcp-app/types.js +2 -0
  214. package/dist/web/bridges/mcp-app/types.js.map +1 -0
  215. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +19 -0
  216. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +19 -0
  217. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -0
  218. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.d.ts +1 -0
  219. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js +26 -0
  220. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -0
  221. package/dist/web/bridges/mcp-app/view-tools.test.d.ts +1 -0
  222. package/dist/web/bridges/mcp-app/view-tools.test.js +144 -0
  223. package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -0
  224. package/dist/web/bridges/types.d.ts +177 -30
  225. package/dist/web/bridges/types.js.map +1 -1
  226. package/dist/web/bridges/use-host-context.d.ts +7 -0
  227. package/dist/web/bridges/use-host-context.js +13 -0
  228. package/dist/web/bridges/use-host-context.js.map +1 -0
  229. package/dist/web/components/modal-provider.d.ts +4 -0
  230. package/dist/web/components/modal-provider.js +45 -0
  231. package/dist/web/components/modal-provider.js.map +1 -0
  232. package/dist/web/create-store.d.ts +26 -0
  233. package/dist/web/create-store.js +47 -8
  234. package/dist/web/create-store.js.map +1 -1
  235. package/dist/web/create-store.test.js +112 -53
  236. package/dist/web/create-store.test.js.map +1 -1
  237. package/dist/web/data-llm.d.ts +34 -1
  238. package/dist/web/data-llm.js +35 -5
  239. package/dist/web/data-llm.js.map +1 -1
  240. package/dist/web/data-llm.test.js +131 -65
  241. package/dist/web/data-llm.test.js.map +1 -1
  242. package/dist/web/generate-helpers.d.ts +24 -19
  243. package/dist/web/generate-helpers.js +22 -18
  244. package/dist/web/generate-helpers.js.map +1 -1
  245. package/dist/web/generate-helpers.test-d.js +30 -28
  246. package/dist/web/generate-helpers.test-d.js.map +1 -1
  247. package/dist/web/generate-helpers.test.js.map +1 -1
  248. package/dist/web/helpers/state.d.ts +2 -2
  249. package/dist/web/helpers/state.js +17 -12
  250. package/dist/web/helpers/state.js.map +1 -1
  251. package/dist/web/helpers/state.test.js +9 -9
  252. package/dist/web/helpers/state.test.js.map +1 -1
  253. package/dist/web/hooks/index.d.ts +7 -3
  254. package/dist/web/hooks/index.js +6 -2
  255. package/dist/web/hooks/index.js.map +1 -1
  256. package/dist/web/hooks/test/utils.d.ts +12 -2
  257. package/dist/web/hooks/test/utils.js +49 -14
  258. package/dist/web/hooks/test/utils.js.map +1 -1
  259. package/dist/web/hooks/use-call-tool.d.ts +48 -2
  260. package/dist/web/hooks/use-call-tool.js +30 -2
  261. package/dist/web/hooks/use-call-tool.js.map +1 -1
  262. package/dist/web/hooks/use-call-tool.test-d.js +1 -1
  263. package/dist/web/hooks/use-call-tool.test-d.js.map +1 -1
  264. package/dist/web/hooks/use-call-tool.test.js +30 -9
  265. package/dist/web/hooks/use-call-tool.test.js.map +1 -1
  266. package/dist/web/hooks/use-display-mode.d.ts +23 -3
  267. package/dist/web/hooks/use-display-mode.js +23 -4
  268. package/dist/web/hooks/use-display-mode.js.map +1 -1
  269. package/dist/web/hooks/use-display-mode.test-d.d.ts +1 -0
  270. package/dist/web/hooks/use-display-mode.test-d.js +8 -0
  271. package/dist/web/hooks/use-display-mode.test-d.js.map +1 -0
  272. package/dist/web/hooks/use-display-mode.test.js.map +1 -1
  273. package/dist/web/hooks/use-download.d.ts +5 -0
  274. package/dist/web/hooks/use-download.js +8 -0
  275. package/dist/web/hooks/use-download.js.map +1 -0
  276. package/dist/web/hooks/use-download.test.d.ts +1 -0
  277. package/dist/web/hooks/use-download.test.js +95 -0
  278. package/dist/web/hooks/use-download.test.js.map +1 -0
  279. package/dist/web/hooks/use-files.d.ts +35 -6
  280. package/dist/web/hooks/use-files.js +37 -2
  281. package/dist/web/hooks/use-files.js.map +1 -1
  282. package/dist/web/hooks/use-files.test.js +28 -3
  283. package/dist/web/hooks/use-files.test.js.map +1 -1
  284. package/dist/web/hooks/use-layout.d.ts +4 -2
  285. package/dist/web/hooks/use-layout.js +6 -4
  286. package/dist/web/hooks/use-layout.js.map +1 -1
  287. package/dist/web/hooks/use-layout.test.js +7 -6
  288. package/dist/web/hooks/use-layout.test.js.map +1 -1
  289. package/dist/web/hooks/use-open-external.d.ts +20 -1
  290. package/dist/web/hooks/use-open-external.js +19 -3
  291. package/dist/web/hooks/use-open-external.js.map +1 -1
  292. package/dist/web/hooks/use-open-external.test.js +27 -12
  293. package/dist/web/hooks/use-open-external.test.js.map +1 -1
  294. package/dist/web/hooks/use-register-view-tool.d.ts +38 -0
  295. package/dist/web/hooks/use-register-view-tool.js +50 -0
  296. package/dist/web/hooks/use-register-view-tool.js.map +1 -0
  297. package/dist/web/hooks/use-request-close.d.ts +16 -0
  298. package/dist/web/hooks/use-request-close.js +21 -0
  299. package/dist/web/hooks/use-request-close.js.map +1 -0
  300. package/dist/web/hooks/use-request-close.test.d.ts +1 -0
  301. package/dist/web/hooks/use-request-close.test.js +52 -0
  302. package/dist/web/hooks/use-request-close.test.js.map +1 -0
  303. package/dist/web/hooks/use-request-modal.d.ts +18 -3
  304. package/dist/web/hooks/use-request-modal.js +25 -8
  305. package/dist/web/hooks/use-request-modal.js.map +1 -1
  306. package/dist/web/hooks/use-request-modal.test.js +5 -1
  307. package/dist/web/hooks/use-request-modal.test.js.map +1 -1
  308. package/dist/web/hooks/use-request-size.d.ts +20 -0
  309. package/dist/web/hooks/use-request-size.js +24 -0
  310. package/dist/web/hooks/use-request-size.js.map +1 -0
  311. package/dist/web/hooks/use-request-size.test.d.ts +1 -0
  312. package/dist/web/hooks/use-request-size.test.js +65 -0
  313. package/dist/web/hooks/use-request-size.test.js.map +1 -0
  314. package/dist/web/hooks/use-send-follow-up-message.d.ts +19 -1
  315. package/dist/web/hooks/use-send-follow-up-message.js +20 -3
  316. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -1
  317. package/dist/web/hooks/use-set-open-in-app-url.d.ts +18 -0
  318. package/dist/web/hooks/use-set-open-in-app-url.js +25 -0
  319. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -0
  320. package/dist/web/hooks/use-set-open-in-app-url.test.d.ts +1 -0
  321. package/dist/web/hooks/use-set-open-in-app-url.test.js +43 -0
  322. package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -0
  323. package/dist/web/hooks/use-tool-info.d.ts +53 -2
  324. package/dist/web/hooks/use-tool-info.js +34 -11
  325. package/dist/web/hooks/use-tool-info.js.map +1 -1
  326. package/dist/web/hooks/use-tool-info.test-d.js +11 -29
  327. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -1
  328. package/dist/web/hooks/use-tool-info.test.js +10 -10
  329. package/dist/web/hooks/use-tool-info.test.js.map +1 -1
  330. package/dist/web/hooks/use-user.d.ts +3 -1
  331. package/dist/web/hooks/use-user.js +22 -4
  332. package/dist/web/hooks/use-user.js.map +1 -1
  333. package/dist/web/hooks/use-user.test.js +33 -4
  334. package/dist/web/hooks/use-user.test.js.map +1 -1
  335. package/dist/web/hooks/use-view-state.d.ts +25 -0
  336. package/dist/web/hooks/use-view-state.js +32 -0
  337. package/dist/web/hooks/use-view-state.js.map +1 -0
  338. package/dist/web/hooks/use-view-state.test.d.ts +1 -0
  339. package/dist/web/hooks/use-view-state.test.js +177 -0
  340. package/dist/web/hooks/use-view-state.test.js.map +1 -0
  341. package/dist/web/index.d.ts +1 -2
  342. package/dist/web/index.js +1 -2
  343. package/dist/web/index.js.map +1 -1
  344. package/dist/web/mount-view.d.ts +20 -0
  345. package/dist/web/mount-view.js +46 -0
  346. package/dist/web/mount-view.js.map +1 -0
  347. package/dist/web/plugin/data-llm.test.js.map +1 -1
  348. package/dist/web/plugin/plugin.d.ts +32 -1
  349. package/dist/web/plugin/plugin.js +168 -18
  350. package/dist/web/plugin/plugin.js.map +1 -1
  351. package/dist/web/plugin/scan-views.d.ts +16 -0
  352. package/dist/web/plugin/scan-views.js +88 -0
  353. package/dist/web/plugin/scan-views.js.map +1 -0
  354. package/dist/web/plugin/scan-views.test.d.ts +1 -0
  355. package/dist/web/plugin/scan-views.test.js +99 -0
  356. package/dist/web/plugin/scan-views.test.js.map +1 -0
  357. package/dist/web/plugin/transform-data-llm.js +1 -1
  358. package/dist/web/plugin/transform-data-llm.js.map +1 -1
  359. package/dist/web/plugin/transform-data-llm.test.js.map +1 -1
  360. package/dist/web/plugin/validate-view.d.ts +1 -0
  361. package/dist/web/plugin/validate-view.js +9 -0
  362. package/dist/web/plugin/validate-view.js.map +1 -0
  363. package/dist/web/plugin/validate-view.test.d.ts +1 -0
  364. package/dist/web/plugin/validate-view.test.js +24 -0
  365. package/dist/web/plugin/validate-view.test.js.map +1 -0
  366. package/dist/web/proxy.js +0 -1
  367. package/dist/web/proxy.js.map +1 -1
  368. package/dist/web/types.d.ts +4 -133
  369. package/dist/web/types.js +0 -9
  370. package/dist/web/types.js.map +1 -1
  371. package/package.json +59 -31
  372. package/tsconfig.base.json +33 -0
  373. package/dist/cli/use-version.d.ts +0 -1
  374. package/dist/cli/use-version.js +0 -33
  375. package/dist/cli/use-version.js.map +0 -1
  376. package/dist/server/templates/development.hbs +0 -66
  377. package/dist/server/templates/production.hbs +0 -7
  378. package/dist/server/widgetsDevServer.d.ts +0 -12
  379. package/dist/server/widgetsDevServer.js +0 -47
  380. package/dist/server/widgetsDevServer.js.map +0 -1
  381. package/dist/test/widget.test.js +0 -234
  382. package/dist/test/widget.test.js.map +0 -1
  383. package/dist/web/bridges/adaptors/apps-sdk-adaptor.d.ts +0 -13
  384. package/dist/web/bridges/adaptors/apps-sdk-adaptor.js +0 -33
  385. package/dist/web/bridges/adaptors/apps-sdk-adaptor.js.map +0 -1
  386. package/dist/web/bridges/adaptors/mcp-app-adaptor.d.ts +0 -16
  387. package/dist/web/bridges/adaptors/mcp-app-adaptor.js +0 -115
  388. package/dist/web/bridges/adaptors/mcp-app-adaptor.js.map +0 -1
  389. package/dist/web/bridges/apps-sdk-bridge.d.ts +0 -10
  390. package/dist/web/bridges/apps-sdk-bridge.js.map +0 -1
  391. package/dist/web/bridges/hooks/use-adaptor.d.ts +0 -2
  392. package/dist/web/bridges/hooks/use-adaptor.js +0 -8
  393. package/dist/web/bridges/hooks/use-adaptor.js.map +0 -1
  394. package/dist/web/bridges/hooks/use-apps-sdk-bridge.d.ts +0 -2
  395. package/dist/web/bridges/hooks/use-apps-sdk-bridge.js +0 -7
  396. package/dist/web/bridges/hooks/use-apps-sdk-bridge.js.map +0 -1
  397. package/dist/web/bridges/hooks/use-bridge.d.ts +0 -2
  398. package/dist/web/bridges/hooks/use-bridge.js +0 -8
  399. package/dist/web/bridges/hooks/use-bridge.js.map +0 -1
  400. package/dist/web/bridges/hooks/use-mcp-app-bridge.d.ts +0 -5
  401. package/dist/web/bridges/hooks/use-mcp-app-bridge.js +0 -7
  402. package/dist/web/bridges/hooks/use-mcp-app-bridge.js.map +0 -1
  403. package/dist/web/bridges/hooks/use-mcp-app-bridge.test.js +0 -62
  404. package/dist/web/bridges/hooks/use-mcp-app-bridge.test.js.map +0 -1
  405. package/dist/web/bridges/mcp-app-bridge.d.ts +0 -46
  406. package/dist/web/bridges/mcp-app-bridge.js +0 -217
  407. package/dist/web/bridges/mcp-app-bridge.js.map +0 -1
  408. package/dist/web/hooks/use-openai-global.d.ts +0 -3
  409. package/dist/web/hooks/use-openai-global.js +0 -6
  410. package/dist/web/hooks/use-openai-global.js.map +0 -1
  411. package/dist/web/hooks/use-widget-state.d.ts +0 -4
  412. package/dist/web/hooks/use-widget-state.js +0 -32
  413. package/dist/web/hooks/use-widget-state.js.map +0 -1
  414. package/dist/web/hooks/use-widget-state.test.js +0 -61
  415. package/dist/web/hooks/use-widget-state.test.js.map +0 -1
  416. package/dist/web/mount-widget.d.ts +0 -1
  417. package/dist/web/mount-widget.js +0 -19
  418. package/dist/web/mount-widget.js.map +0 -1
  419. /package/dist/{test/widget.test.d.ts → cli/build-helpers.test.d.ts} +0 -0
  420. /package/dist/{web/bridges/hooks/use-mcp-app-bridge.test.d.ts → cli/tunnel-control-server.test.d.ts} +0 -0
  421. /package/dist/{web/hooks/use-widget-state.test.d.ts → cli/tunnel-handler.test.d.ts} +0 -0
@@ -1,10 +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
+ */
1
33
  export declare function useFiles(): {
2
- upload: (file: File) => Promise<{
3
- fileId: string;
4
- }>;
5
- getDownloadUrl: (file: {
6
- fileId: string;
7
- }) => Promise<{
34
+ upload: (file: File, options?: import("../index.js").UploadFileOptions) => Promise<import("../index.js").FileMetadata>;
35
+ getDownloadUrl: (file: import("../index.js").FileMetadata) => Promise<{
8
36
  downloadUrl: string;
9
37
  }>;
38
+ selectFiles: () => Promise<import("../index.js").FileMetadata[]>;
10
39
  };
@@ -1,7 +1,42 @@
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
+ */
1
34
  export function useFiles() {
35
+ const adaptor = getAdaptor();
2
36
  return {
3
- upload: window.openai.uploadFile,
4
- getDownloadUrl: window.openai.getFileDownloadUrl,
37
+ upload: adaptor.uploadFile,
38
+ getDownloadUrl: adaptor.getFileDownloadUrl,
39
+ selectFiles: adaptor.selectFiles,
5
40
  };
6
41
  }
7
42
  //# sourceMappingURL=use-files.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"use-files.js","sourceRoot":"","sources":["../../../src/web/hooks/use-files.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,QAAQ;IACtB,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU;QAChC,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB;KACjD,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,23 +1,48 @@
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
4
  import { useFiles } from "./use-files.js";
4
5
  describe("useFiles", () => {
5
6
  const OpenaiMock = {
6
- uploadFile: vi.fn(),
7
+ uploadFile: vi.fn().mockResolvedValue({
8
+ fileId: `sediment://file_abc123`,
9
+ }),
7
10
  getFileDownloadUrl: vi.fn(),
11
+ widgetState: null,
12
+ setWidgetState: vi.fn(),
8
13
  };
9
14
  beforeEach(() => {
15
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
10
16
  vi.stubGlobal("openai", OpenaiMock);
11
17
  });
12
18
  afterEach(() => {
13
19
  vi.unstubAllGlobals();
14
- vi.resetAllMocks();
20
+ vi.clearAllMocks();
21
+ AppsSdkAdaptor.resetInstance();
15
22
  });
16
23
  const dummyFile = new File([], "test.txt");
17
24
  it("should upload a file to ChatGPT", () => {
18
25
  const { result } = renderHook(() => useFiles());
19
26
  result.current.upload(dummyFile);
20
- expect(OpenaiMock.uploadFile).toHaveBeenCalledWith(dummyFile);
27
+ expect(OpenaiMock.uploadFile).toHaveBeenCalledWith(dummyFile, undefined);
28
+ });
29
+ it("should upload a file with library option", () => {
30
+ const { result } = renderHook(() => useFiles());
31
+ result.current.upload(dummyFile, { library: true });
32
+ expect(OpenaiMock.uploadFile).toHaveBeenCalledWith(dummyFile, {
33
+ library: true,
34
+ });
35
+ });
36
+ it("should select files from ChatGPT", async () => {
37
+ const selectedFiles = [
38
+ { fileId: "file_1", fileName: "doc.pdf", mimeType: "application/pdf" },
39
+ ];
40
+ OpenaiMock.selectFiles = vi.fn().mockResolvedValue(selectedFiles);
41
+ const { result } = renderHook(() => useFiles());
42
+ const files = await result.current.selectFiles();
43
+ expect(OpenaiMock.selectFiles).toHaveBeenCalled();
44
+ expect(files).toEqual(selectedFiles);
45
+ delete OpenaiMock.selectFiles;
21
46
  });
22
47
  it("should download a file from ChatGPT", () => {
23
48
  const fileId = "123";
@@ -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,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,MAAM,UAAU,GAAG;QACjB,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE;QACnB,kBAAkB,EAAE,EAAE,CAAC,EAAE,EAAE;KAC5B,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,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;IACrB,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,CAAC,CAAC;IAChE,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,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","sourcesContent":["import { renderHook } from \"@testing-library/react\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { AppsSdkAdaptor } from \"../bridges/apps-sdk/adaptor.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 vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n vi.stubGlobal(\"openai\", OpenaiMock);\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.clearAllMocks();\n AppsSdkAdaptor.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"]}
@@ -1,7 +1,7 @@
1
- import type { SafeArea, Theme } from "../types.js";
1
+ import { type SafeArea, type Theme } from "../bridges/index.js";
2
2
  export type LayoutState = {
3
3
  theme: Theme;
4
- maxHeight: number;
4
+ maxHeight: number | undefined;
5
5
  safeArea: SafeArea;
6
6
  };
7
7
  /**
@@ -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;
@@ -1,4 +1,4 @@
1
- import { useBridge } from "../bridges/index.js";
1
+ import { useHostContext } from "../bridges/index.js";
2
2
  /**
3
3
  * Hook for accessing layout and visual environment information.
4
4
  * These values may change on resize or theme toggle.
@@ -13,11 +13,13 @@ import { useBridge } 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
- const theme = useBridge("theme");
19
- const maxHeight = useBridge("maxHeight");
20
- const safeArea = useBridge("safeArea");
20
+ const theme = useHostContext("theme");
21
+ const maxHeight = useHostContext("maxHeight");
22
+ const safeArea = useHostContext("safeArea");
21
23
  return { theme, maxHeight, safeArea };
22
24
  }
23
25
  //# sourceMappingURL=use-layout.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"use-layout.js","sourceRoot":"","sources":["../../../src/web/hooks/use-layout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAShD;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,SAAS;IACvB,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IACjC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;IAEvC,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"]}
@@ -1,8 +1,8 @@
1
1
  import { renderHook, waitFor } from "@testing-library/react";
2
2
  import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
3
- import { McpAppAdaptor } from "../bridges/adaptors/mcp-app-adaptor.js";
4
- import { McpAppBridge } from "../bridges/mcp-app-bridge.js";
5
- import { getMcpAppHostPostMessageMock } from "./test/utils.js";
3
+ import { McpAppAdaptor } from "../bridges/mcp-app/adaptor.js";
4
+ import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
5
+ import { getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
6
6
  import { useLayout } from "./use-layout.js";
7
7
  describe("useLayout", () => {
8
8
  describe("apps-sdk host type", () => {
@@ -50,8 +50,9 @@ describe("useLayout", () => {
50
50
  describe("mcp-app host type", () => {
51
51
  beforeEach(() => {
52
52
  vi.stubGlobal("skybridge", { hostType: "mcp-app" });
53
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
53
54
  });
54
- afterEach(() => {
55
+ afterEach(async () => {
55
56
  vi.unstubAllGlobals();
56
57
  vi.resetAllMocks();
57
58
  McpAppBridge.resetInstance();
@@ -61,7 +62,7 @@ describe("useLayout", () => {
61
62
  vi.stubGlobal("parent", {
62
63
  postMessage: getMcpAppHostPostMessageMock({
63
64
  theme: "dark",
64
- viewport: { height: 400, width: 400, maxHeight: 800 },
65
+ containerDimensions: { maxHeight: 800, width: 400 },
65
66
  safeAreaInsets: { top: 20, right: 0, bottom: 34, left: 0 },
66
67
  }),
67
68
  });
@@ -78,7 +79,7 @@ describe("useLayout", () => {
78
79
  vi.stubGlobal("parent", {
79
80
  postMessage: getMcpAppHostPostMessageMock({
80
81
  theme: "light",
81
- viewport: { height: 400, width: 400, maxHeight: 500 },
82
+ containerDimensions: { maxHeight: 500, width: 400 },
82
83
  safeAreaInsets: { top: 44, right: 0, bottom: 34, left: 0 },
83
84
  }),
84
85
  });
@@ -1 +1 @@
1
- {"version":3,"file":"use-layout.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-layout.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,aAAa,EAAE,MAAM,wCAAwC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,OAAO,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,IAAI,UAIH,CAAC;QAEF,UAAU,CAAC,GAAG,EAAE;YACd,UAAU,GAAG;gBACX,KAAK,EAAE,OAAO;gBACd,SAAS,EAAE,GAAG;gBACd,QAAQ,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;aAC/D,CAAC;YACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACpC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;YACzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;gBACtC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;aACjD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,UAAU,CAAC,KAAK,GAAG,MAAM,CAAC;YAC1B,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,UAAU,CAAC,SAAS,GAAG,GAAG,CAAC;YAC3B,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,UAAU,CAAC,QAAQ,GAAG;gBACpB,MAAM,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;aACnD,CAAC;YACF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACpD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;YAClF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,KAAK,EAAE,MAAM;oBACb,QAAQ,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE;oBACrD,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE;iBAC3D,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC1C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC3C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;oBACtC,MAAM,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE;iBACnD,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;YACxF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,KAAK,EAAE,OAAO;oBACd,QAAQ,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE;oBACrD,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE;iBAC3D,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAE3D,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;YAChD,CAAC,CAAC,CAAC;YAEH,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;YAEhD,QAAQ,EAAE,CAAC;YAEX,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"use-layout.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-layout.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,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,IAAI,UAIH,CAAC;QAEF,UAAU,CAAC,GAAG,EAAE;YACd,UAAU,GAAG;gBACX,KAAK,EAAE,OAAO;gBACd,SAAS,EAAE,GAAG;gBACd,QAAQ,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;aAC/D,CAAC;YACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACpC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;YACzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;gBACtC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;aACjD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,UAAU,CAAC,KAAK,GAAG,MAAM,CAAC;YAC1B,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,UAAU,CAAC,SAAS,GAAG,GAAG,CAAC;YAC3B,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,UAAU,CAAC,QAAQ,GAAG;gBACpB,MAAM,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;aACnD,CAAC;YACF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACpD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;YACpD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;YAClF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,KAAK,EAAE,MAAM;oBACb,mBAAmB,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE;oBACnD,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE;iBAC3D,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC1C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC3C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;oBACtC,MAAM,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE;iBACnD,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;YACxF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,KAAK,EAAE,OAAO;oBACd,mBAAmB,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE;oBACnD,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE;iBAC3D,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAE3D,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;YAChD,CAAC,CAAC,CAAC;YAEH,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;YAEhD,QAAQ,EAAE,CAAC;YAEX,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACxD,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 { McpAppAdaptor } from \"../bridges/mcp-app/adaptor.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/bridge.js\";\nimport type { SafeArea, Theme } from \"../bridges/types.js\";\nimport {\n getMcpAppHostPostMessageMock,\n MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useLayout } from \"./use-layout.js\";\n\ndescribe(\"useLayout\", () => {\n describe(\"apps-sdk host type\", () => {\n let OpenaiMock: {\n theme: Theme;\n maxHeight: number;\n safeArea: SafeArea;\n };\n\n beforeEach(() => {\n OpenaiMock = {\n theme: \"light\",\n maxHeight: 500,\n safeArea: { insets: { top: 0, bottom: 0, left: 0, right: 0 } },\n };\n vi.stubGlobal(\"openai\", OpenaiMock);\n vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n });\n\n it(\"should return theme, maxHeight, and safeArea from window.openai\", () => {\n const { result } = renderHook(() => useLayout());\n\n expect(result.current.theme).toBe(\"light\");\n expect(result.current.maxHeight).toBe(500);\n expect(result.current.safeArea).toEqual({\n insets: { top: 0, bottom: 0, left: 0, right: 0 },\n });\n });\n\n it(\"should return dark theme when set to dark\", () => {\n OpenaiMock.theme = \"dark\";\n const { result } = renderHook(() => useLayout());\n\n expect(result.current.theme).toBe(\"dark\");\n });\n\n it(\"should return different maxHeight when set\", () => {\n OpenaiMock.maxHeight = 800;\n const { result } = renderHook(() => useLayout());\n\n expect(result.current.maxHeight).toBe(800);\n });\n\n it(\"should return safeArea with insets when set\", () => {\n OpenaiMock.safeArea = {\n insets: { top: 44, bottom: 34, left: 0, right: 0 },\n };\n const { result } = renderHook(() => useLayout());\n\n expect(result.current.safeArea.insets.top).toBe(44);\n expect(result.current.safeArea.insets.bottom).toBe(34);\n });\n });\n\n describe(\"mcp-app host type\", () => {\n beforeEach(() => {\n vi.stubGlobal(\"skybridge\", { hostType: \"mcp-app\" });\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n });\n\n afterEach(async () => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n McpAppBridge.resetInstance();\n McpAppAdaptor.resetInstance();\n });\n\n it(\"should return theme, maxHeight, and safeArea from mcp host context\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n theme: \"dark\",\n containerDimensions: { maxHeight: 800, width: 400 },\n safeAreaInsets: { top: 20, right: 0, bottom: 34, left: 0 },\n }),\n });\n const { result } = renderHook(() => useLayout());\n\n await waitFor(() => {\n expect(result.current.theme).toBe(\"dark\");\n expect(result.current.maxHeight).toBe(800);\n expect(result.current.safeArea).toEqual({\n insets: { top: 20, right: 0, bottom: 34, left: 0 },\n });\n });\n });\n\n it(\"should maintain safeArea referential stability when data has not changed\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n theme: \"light\",\n containerDimensions: { maxHeight: 500, width: 400 },\n safeAreaInsets: { top: 44, right: 0, bottom: 34, left: 0 },\n }),\n });\n const { result, rerender } = renderHook(() => useLayout());\n\n await waitFor(() => {\n expect(result.current.safeArea).toBeDefined();\n });\n\n const initialSafeArea = result.current.safeArea;\n\n rerender();\n\n expect(result.current.safeArea).toBe(initialSafeArea);\n });\n });\n});\n"]}
@@ -1 +1,20 @@
1
- export declare function useOpenExternal(): (href: string) => void;
1
+ import type { OpenExternalOptions } from "../bridges/types.js";
2
+ /** Function that opens a URL outside the view's iframe, returned by {@link useOpenExternal}. */
3
+ export type OpenExternalFn = (href: string, options?: OpenExternalOptions) => void;
4
+ /**
5
+ * Open an external URL through the host (e.g. in the user's browser).
6
+ *
7
+ * Use this instead of `window.open` or anchor `target="_blank"`, which are
8
+ * unreliable inside a sandboxed iframe. Hosts may transform the URL (e.g.
9
+ * ChatGPT appends a `?redirectUrl=…` parameter for allowlisted targets — pass
10
+ * `redirectUrl: false` to suppress it).
11
+ *
12
+ * @example
13
+ * ```tsx
14
+ * const openExternal = useOpenExternal();
15
+ * <button onClick={() => openExternal("https://example.com")}>Open docs</button>
16
+ * ```
17
+ *
18
+ * @see https://docs.skybridge.tech/api-reference/use-open-external
19
+ */
20
+ export declare function useOpenExternal(): OpenExternalFn;
@@ -1,8 +1,24 @@
1
1
  import { useCallback } from "react";
2
- import { useAdaptor } from "../bridges/index.js";
2
+ import { getAdaptor } from "../bridges/index.js";
3
+ /**
4
+ * Open an external URL through the host (e.g. in the user's browser).
5
+ *
6
+ * Use this instead of `window.open` or anchor `target="_blank"`, which are
7
+ * unreliable inside a sandboxed iframe. Hosts may transform the URL (e.g.
8
+ * ChatGPT appends a `?redirectUrl=…` parameter for allowlisted targets — pass
9
+ * `redirectUrl: false` to suppress it).
10
+ *
11
+ * @example
12
+ * ```tsx
13
+ * const openExternal = useOpenExternal();
14
+ * <button onClick={() => openExternal("https://example.com")}>Open docs</button>
15
+ * ```
16
+ *
17
+ * @see https://docs.skybridge.tech/api-reference/use-open-external
18
+ */
3
19
  export function useOpenExternal() {
4
- const adaptor = useAdaptor();
5
- const openExternal = useCallback((href) => adaptor.openExternal(href), [adaptor]);
20
+ const adaptor = getAdaptor();
21
+ const openExternal = useCallback((href, options) => adaptor.openExternal(href, options), [adaptor]);
6
22
  return openExternal;
7
23
  }
8
24
  //# sourceMappingURL=use-open-external.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"use-open-external.js","sourceRoot":"","sources":["../../../src/web/hooks/use-open-external.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,MAAM,UAAU,eAAe;IAC7B,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,YAAY,GAAG,WAAW,CAC9B,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,EAC5C,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,OAAO,YAAY,CAAC;AACtB,CAAC"}
1
+ {"version":3,"file":"use-open-external.js","sourceRoot":"","sources":["../../../src/web/hooks/use-open-external.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AASjD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,eAAe;IAC7B,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,YAAY,GAAG,WAAW,CAC9B,CAAC,IAAY,EAAE,OAA6B,EAAE,EAAE,CAC9C,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,EACrC,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,OAAO,YAAY,CAAC;AACtB,CAAC","sourcesContent":["import { useCallback } from \"react\";\nimport { getAdaptor } from \"../bridges/index.js\";\nimport type { OpenExternalOptions } from \"../bridges/types.js\";\n\n/** Function that opens a URL outside the view's iframe, returned by {@link useOpenExternal}. */\nexport type OpenExternalFn = (\n href: string,\n options?: OpenExternalOptions,\n) => void;\n\n/**\n * Open an external URL through the host (e.g. in the user's browser).\n *\n * Use this instead of `window.open` or anchor `target=\"_blank\"`, which are\n * unreliable inside a sandboxed iframe. Hosts may transform the URL (e.g.\n * ChatGPT appends a `?redirectUrl=…` parameter for allowlisted targets — pass\n * `redirectUrl: false` to suppress it).\n *\n * @example\n * ```tsx\n * const openExternal = useOpenExternal();\n * <button onClick={() => openExternal(\"https://example.com\")}>Open docs</button>\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-open-external\n */\nexport function useOpenExternal(): OpenExternalFn {\n const adaptor = getAdaptor();\n const openExternal = useCallback(\n (href: string, options?: OpenExternalOptions) =>\n adaptor.openExternal(href, options),\n [adaptor],\n );\n\n return openExternal;\n}\n"]}
@@ -1,6 +1,7 @@
1
- import { renderHook } from "@testing-library/react";
1
+ import { renderHook, waitFor } from "@testing-library/react";
2
2
  import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
3
- import { McpAppBridge } from "../bridges/mcp-app-bridge.js";
3
+ import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
4
+ import { getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
4
5
  import { useOpenExternal } from "./use-open-external.js";
5
6
  describe("useOpenExternal", () => {
6
7
  describe("apps-sdk host", () => {
@@ -23,27 +24,41 @@ describe("useOpenExternal", () => {
23
24
  expect(openExternalMock).toHaveBeenCalledTimes(1);
24
25
  expect(openExternalMock).toHaveBeenCalledWith({ href });
25
26
  });
27
+ it("should forward redirectUrl false option to window.openai.openExternal", () => {
28
+ const { result } = renderHook(() => useOpenExternal());
29
+ const href = "https://example.com";
30
+ result.current(href, { redirectUrl: false });
31
+ expect(openExternalMock).toHaveBeenCalledTimes(1);
32
+ expect(openExternalMock).toHaveBeenCalledWith({
33
+ href,
34
+ redirectUrl: false,
35
+ });
36
+ });
26
37
  });
27
38
  describe("mcp-app host", () => {
28
- const mockPostMessage = vi.fn();
39
+ let postMessageMock;
29
40
  beforeEach(() => {
30
- vi.stubGlobal("parent", { postMessage: mockPostMessage });
31
41
  vi.stubGlobal("skybridge", { hostType: "mcp-app" });
42
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
43
+ postMessageMock = getMcpAppHostPostMessageMock();
44
+ vi.stubGlobal("parent", { postMessage: postMessageMock });
32
45
  });
33
- afterEach(() => {
46
+ afterEach(async () => {
34
47
  vi.unstubAllGlobals();
35
48
  vi.resetAllMocks();
36
49
  McpAppBridge.resetInstance();
37
50
  });
38
- it("should return a function that sends ui/open-link request to the MCP host", () => {
51
+ it("should return a function that sends ui/open-link request to the MCP host", async () => {
39
52
  const { result } = renderHook(() => useOpenExternal());
40
53
  const href = "https://example.com";
41
- result.current(href);
42
- expect(mockPostMessage).toHaveBeenCalledWith(expect.objectContaining({
43
- jsonrpc: "2.0",
44
- method: "ui/open-link",
45
- params: { url: href },
46
- }), "*");
54
+ result.current(href, { redirectUrl: false });
55
+ await waitFor(() => {
56
+ expect(postMessageMock).toHaveBeenCalledWith(expect.objectContaining({
57
+ jsonrpc: "2.0",
58
+ method: "ui/open-link",
59
+ params: { url: href },
60
+ }), "*");
61
+ });
47
62
  });
48
63
  });
49
64
  });
@@ -1 +1 @@
1
- {"version":3,"file":"use-open-external.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-open-external.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,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,IAAI,gBAA0C,CAAC;QAE/C,UAAU,CAAC,GAAG,EAAE;YACd,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3B,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,YAAY,EAAE,gBAAgB;aAC/B,CAAC,CAAC;YACH,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8EAA8E,EAAE,GAAG,EAAE;YACtF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;YAEvD,MAAM,IAAI,GAAG,qBAAqB,CAAC;YACnC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAErB,MAAM,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,MAAM,eAAe,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAEhC,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;YAC1D,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,GAAG,EAAE;YAClF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;YAEvD,MAAM,IAAI,GAAG,qBAAqB,CAAC;YACnC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAErB,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAC1C,MAAM,CAAC,gBAAgB,CAAC;gBACtB,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,cAAc;gBACtB,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE;aACtB,CAAC,EACF,GAAG,CACJ,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"use-open-external.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-open-external.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,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,IAAI,gBAA0C,CAAC;QAE/C,UAAU,CAAC,GAAG,EAAE;YACd,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3B,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,YAAY,EAAE,gBAAgB;aAC/B,CAAC,CAAC;YACH,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8EAA8E,EAAE,GAAG,EAAE;YACtF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;YAEvD,MAAM,IAAI,GAAG,qBAAqB,CAAC;YACnC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAErB,MAAM,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;YAC/E,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;YAEvD,MAAM,IAAI,GAAG,qBAAqB,CAAC;YACnC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;YAE7C,MAAM,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAAC;gBAC5C,IAAI;gBACJ,WAAW,EAAE,KAAK;aACnB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,IAAI,eAAgE,CAAC;QAErE,UAAU,CAAC,GAAG,EAAE;YACd,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,EAAE,CAAC;YACjD,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,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;YACxF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;YAEvD,MAAM,IAAI,GAAG,qBAAqB,CAAC;YACnC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;YAE7C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAC1C,MAAM,CAAC,gBAAgB,CAAC;oBACtB,OAAO,EAAE,KAAK;oBACd,MAAM,EAAE,cAAc;oBACtB,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE;iBACtB,CAAC,EACF,GAAG,CACJ,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,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 { McpAppBridge } from \"../bridges/mcp-app/bridge.js\";\nimport {\n getMcpAppHostPostMessageMock,\n MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useOpenExternal } from \"./use-open-external.js\";\n\ndescribe(\"useOpenExternal\", () => {\n describe(\"apps-sdk host\", () => {\n let openExternalMock: ReturnType<typeof vi.fn>;\n\n beforeEach(() => {\n openExternalMock = vi.fn();\n vi.stubGlobal(\"openai\", {\n openExternal: openExternalMock,\n });\n vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n });\n\n it(\"should return a function that calls window.openai.openExternal with the href\", () => {\n const { result } = renderHook(() => useOpenExternal());\n\n const href = \"https://example.com\";\n result.current(href);\n\n expect(openExternalMock).toHaveBeenCalledTimes(1);\n expect(openExternalMock).toHaveBeenCalledWith({ href });\n });\n\n it(\"should forward redirectUrl false option to window.openai.openExternal\", () => {\n const { result } = renderHook(() => useOpenExternal());\n\n const href = \"https://example.com\";\n result.current(href, { redirectUrl: false });\n\n expect(openExternalMock).toHaveBeenCalledTimes(1);\n expect(openExternalMock).toHaveBeenCalledWith({\n href,\n redirectUrl: false,\n });\n });\n });\n\n describe(\"mcp-app host\", () => {\n let postMessageMock: ReturnType<typeof getMcpAppHostPostMessageMock>;\n\n beforeEach(() => {\n vi.stubGlobal(\"skybridge\", { hostType: \"mcp-app\" });\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n postMessageMock = getMcpAppHostPostMessageMock();\n vi.stubGlobal(\"parent\", { postMessage: postMessageMock });\n });\n\n afterEach(async () => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n McpAppBridge.resetInstance();\n });\n\n it(\"should return a function that sends ui/open-link request to the MCP host\", async () => {\n const { result } = renderHook(() => useOpenExternal());\n\n const href = \"https://example.com\";\n result.current(href, { redirectUrl: false });\n\n await waitFor(() => {\n expect(postMessageMock).toHaveBeenCalledWith(\n expect.objectContaining({\n jsonrpc: \"2.0\",\n method: \"ui/open-link\",\n params: { url: href },\n }),\n \"*\",\n );\n });\n });\n });\n});\n"]}
@@ -0,0 +1,38 @@
1
+ import type { ZodRawShapeCompat } from "@modelcontextprotocol/sdk/server/zod-compat.js";
2
+ import type { ViewToolConfig, ViewToolHandler } from "../bridges/types.js";
3
+ /**
4
+ * Register a tool the view exposes to the host and model — the MCP Apps
5
+ * "app-provided tools" feature. A view tool runs *inside the view*: the host
6
+ * discovers it via `tools/list` and invokes it via `tools/call`, and the
7
+ * handler executes against the view's live state. It is the inverse of
8
+ * {@link useCallTool} (which calls a server tool). Registered on mount, removed
9
+ * on unmount; re-registered when `config.name` changes.
10
+ *
11
+ * MCP Apps only — on the Apps SDK (`window.openai`) runtime it is a no-op.
12
+ *
13
+ * @example
14
+ * ```tsx
15
+ * import * as z from "zod";
16
+ * import { useRegisterViewTool } from "skybridge/web";
17
+ *
18
+ * useRegisterViewTool(
19
+ * {
20
+ * name: "chess_make_move",
21
+ * description: "Play a move in algebraic notation, e.g. 'e4' or 'Nf3'.",
22
+ * inputSchema: { san: z.string() },
23
+ * annotations: { readOnlyHint: false },
24
+ * },
25
+ * ({ san }) => {
26
+ * const move = game.move(san);
27
+ * return {
28
+ * content: [{ type: "text", text: move ? `Played ${move.san}` : "Illegal move" }],
29
+ * structuredContent: { fen: game.fen() },
30
+ * isError: !move,
31
+ * };
32
+ * },
33
+ * );
34
+ * ```
35
+ *
36
+ * @see https://docs.skybridge.tech/api-reference/use-register-view-tool
37
+ */
38
+ export declare const useRegisterViewTool: <TInput extends ZodRawShapeCompat = ZodRawShapeCompat>(config: ViewToolConfig<TInput>, handler: ViewToolHandler<TInput>) => void;
@@ -0,0 +1,50 @@
1
+ import { useEffect, useRef } from "react";
2
+ import { getAdaptor } from "../bridges/index.js";
3
+ /**
4
+ * Register a tool the view exposes to the host and model — the MCP Apps
5
+ * "app-provided tools" feature. A view tool runs *inside the view*: the host
6
+ * discovers it via `tools/list` and invokes it via `tools/call`, and the
7
+ * handler executes against the view's live state. It is the inverse of
8
+ * {@link useCallTool} (which calls a server tool). Registered on mount, removed
9
+ * on unmount; re-registered when `config.name` changes.
10
+ *
11
+ * MCP Apps only — on the Apps SDK (`window.openai`) runtime it is a no-op.
12
+ *
13
+ * @example
14
+ * ```tsx
15
+ * import * as z from "zod";
16
+ * import { useRegisterViewTool } from "skybridge/web";
17
+ *
18
+ * useRegisterViewTool(
19
+ * {
20
+ * name: "chess_make_move",
21
+ * description: "Play a move in algebraic notation, e.g. 'e4' or 'Nf3'.",
22
+ * inputSchema: { san: z.string() },
23
+ * annotations: { readOnlyHint: false },
24
+ * },
25
+ * ({ san }) => {
26
+ * const move = game.move(san);
27
+ * return {
28
+ * content: [{ type: "text", text: move ? `Played ${move.san}` : "Illegal move" }],
29
+ * structuredContent: { fen: game.fen() },
30
+ * isError: !move,
31
+ * };
32
+ * },
33
+ * );
34
+ * ```
35
+ *
36
+ * @see https://docs.skybridge.tech/api-reference/use-register-view-tool
37
+ */
38
+ export const useRegisterViewTool = (config, handler) => {
39
+ const { name } = config;
40
+ const configRef = useRef(config);
41
+ configRef.current = config;
42
+ const handlerRef = useRef(handler);
43
+ handlerRef.current = handler;
44
+ useEffect(() => {
45
+ const adaptor = getAdaptor();
46
+ const wrappedHandler = (args) => handlerRef.current(args);
47
+ return adaptor.registerViewTool({ ...configRef.current, name }, wrappedHandler);
48
+ }, [name]);
49
+ };
50
+ //# sourceMappingURL=use-register-view-tool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-register-view-tool.js","sourceRoot":"","sources":["../../../src/web/hooks/use-register-view-tool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAOjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAGjC,MAA8B,EAC9B,OAAgC,EAChC,EAAE;IACF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;IACxB,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IACjC,SAAS,CAAC,OAAO,GAAG,MAAM,CAAC;IAC3B,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IACnC,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;IAE7B,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;QAC7B,MAAM,cAAc,GAAuB,CAAC,IAAI,EAAE,EAAE,CAClD,UAAU,CAAC,OAAO,CAAC,IAA8C,CAAC,CAAC;QAErE,OAAO,OAAO,CAAC,gBAAgB,CAC7B,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,EAC9B,cAAc,CACf,CAAC;IACJ,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;AACb,CAAC,CAAC","sourcesContent":["import type { ZodRawShapeCompat } from \"@modelcontextprotocol/sdk/server/zod-compat.js\";\nimport { useEffect, useRef } from \"react\";\nimport { getAdaptor } from \"../bridges/index.js\";\nimport type {\n AnyViewToolHandler,\n ViewToolConfig,\n ViewToolHandler,\n} from \"../bridges/types.js\";\n\n/**\n * Register a tool the view exposes to the host and model — the MCP Apps\n * \"app-provided tools\" feature. A view tool runs *inside the view*: the host\n * discovers it via `tools/list` and invokes it via `tools/call`, and the\n * handler executes against the view's live state. It is the inverse of\n * {@link useCallTool} (which calls a server tool). Registered on mount, removed\n * on unmount; re-registered when `config.name` changes.\n *\n * MCP Apps only — on the Apps SDK (`window.openai`) runtime it is a no-op.\n *\n * @example\n * ```tsx\n * import * as z from \"zod\";\n * import { useRegisterViewTool } from \"skybridge/web\";\n *\n * useRegisterViewTool(\n * {\n * name: \"chess_make_move\",\n * description: \"Play a move in algebraic notation, e.g. 'e4' or 'Nf3'.\",\n * inputSchema: { san: z.string() },\n * annotations: { readOnlyHint: false },\n * },\n * ({ san }) => {\n * const move = game.move(san);\n * return {\n * content: [{ type: \"text\", text: move ? `Played ${move.san}` : \"Illegal move\" }],\n * structuredContent: { fen: game.fen() },\n * isError: !move,\n * };\n * },\n * );\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-register-view-tool\n */\nexport const useRegisterViewTool = <\n TInput extends ZodRawShapeCompat = ZodRawShapeCompat,\n>(\n config: ViewToolConfig<TInput>,\n handler: ViewToolHandler<TInput>,\n) => {\n const { name } = config;\n const configRef = useRef(config);\n configRef.current = config;\n const handlerRef = useRef(handler);\n handlerRef.current = handler;\n\n useEffect(() => {\n const adaptor = getAdaptor();\n const wrappedHandler: AnyViewToolHandler = (args) =>\n handlerRef.current(args as Parameters<ViewToolHandler<TInput>>[0]);\n\n return adaptor.registerViewTool(\n { ...configRef.current, name },\n wrappedHandler,\n );\n }, [name]);\n};\n"]}
@@ -0,0 +1,16 @@
1
+ /** Function that asks the host to close the current view, returned by {@link useRequestClose}. */
2
+ export type RequestCloseFn = () => Promise<void>;
3
+ /**
4
+ * Ask the host to close (dismiss) the current view. The host decides whether
5
+ * to honor the request. Useful from modal views or after a terminal action
6
+ * like "Done".
7
+ *
8
+ * @example
9
+ * ```tsx
10
+ * const close = useRequestClose();
11
+ * <button onClick={() => close()}>Done</button>
12
+ * ```
13
+ *
14
+ * @see https://docs.skybridge.tech/api-reference/use-request-close
15
+ */
16
+ export declare function useRequestClose(): RequestCloseFn;
@@ -0,0 +1,21 @@
1
+ import { useCallback } from "react";
2
+ import { getAdaptor } from "../bridges/index.js";
3
+ /**
4
+ * Ask the host to close (dismiss) the current view. The host decides whether
5
+ * to honor the request. Useful from modal views or after a terminal action
6
+ * like "Done".
7
+ *
8
+ * @example
9
+ * ```tsx
10
+ * const close = useRequestClose();
11
+ * <button onClick={() => close()}>Done</button>
12
+ * ```
13
+ *
14
+ * @see https://docs.skybridge.tech/api-reference/use-request-close
15
+ */
16
+ export function useRequestClose() {
17
+ const adaptor = getAdaptor();
18
+ const requestClose = useCallback(() => adaptor.requestClose(), [adaptor]);
19
+ return requestClose;
20
+ }
21
+ //# sourceMappingURL=use-request-close.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-request-close.js","sourceRoot":"","sources":["../../../src/web/hooks/use-request-close.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAKjD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,eAAe;IAC7B,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAE1E,OAAO,YAAY,CAAC;AACtB,CAAC","sourcesContent":["import { useCallback } from \"react\";\nimport { getAdaptor } from \"../bridges/index.js\";\n\n/** Function that asks the host to close the current view, returned by {@link useRequestClose}. */\nexport type RequestCloseFn = () => Promise<void>;\n\n/**\n * Ask the host to close (dismiss) the current view. The host decides whether\n * to honor the request. Useful from modal views or after a terminal action\n * like \"Done\".\n *\n * @example\n * ```tsx\n * const close = useRequestClose();\n * <button onClick={() => close()}>Done</button>\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-request-close\n */\nexport function useRequestClose(): RequestCloseFn {\n const adaptor = getAdaptor();\n const requestClose = useCallback(() => adaptor.requestClose(), [adaptor]);\n\n return requestClose;\n}\n"]}
@@ -0,0 +1 @@
1
+ export {};