skybridge 0.0.0-dev.fa873ea → 0.0.0-dev.faa4bf8

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 (494) hide show
  1. package/README.md +155 -0
  2. package/bin/run.js +0 -4
  3. package/dist/cli/build-helpers.d.ts +11 -0
  4. package/dist/cli/build-helpers.js +107 -0
  5. package/dist/cli/build-helpers.js.map +1 -0
  6. package/dist/cli/build-helpers.test.js +132 -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.js +52 -0
  12. package/dist/cli/build-steps.test.js.map +1 -0
  13. package/dist/cli/detect-port.d.ts +18 -0
  14. package/dist/cli/detect-port.js +50 -0
  15. package/dist/cli/detect-port.js.map +1 -0
  16. package/dist/cli/header.d.ts +1 -1
  17. package/dist/cli/header.js +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.d.ts +7 -0
  27. package/dist/cli/telemetry.js +123 -0
  28. package/dist/cli/telemetry.js.map +1 -0
  29. package/dist/cli/tunnel-control-server.d.ts +9 -0
  30. package/dist/cli/tunnel-control-server.js +31 -0
  31. package/dist/cli/tunnel-control-server.js.map +1 -0
  32. package/dist/cli/tunnel-control-server.test.d.ts +1 -0
  33. package/dist/cli/tunnel-control-server.test.js +39 -0
  34. package/dist/cli/tunnel-control-server.test.js.map +1 -0
  35. package/dist/cli/tunnel-handler.d.ts +3 -0
  36. package/dist/cli/tunnel-handler.js +48 -0
  37. package/dist/cli/tunnel-handler.js.map +1 -0
  38. package/dist/cli/tunnel-handler.test.d.ts +1 -0
  39. package/dist/cli/tunnel-handler.test.js +105 -0
  40. package/dist/cli/tunnel-handler.test.js.map +1 -0
  41. package/dist/cli/tunnel.d.ts +57 -0
  42. package/dist/cli/tunnel.js +154 -0
  43. package/dist/cli/tunnel.js.map +1 -0
  44. package/dist/cli/tunnel.test.d.ts +1 -0
  45. package/dist/cli/tunnel.test.js +190 -0
  46. package/dist/cli/tunnel.test.js.map +1 -0
  47. package/dist/cli/types.d.ts +5 -0
  48. package/dist/cli/types.js +2 -0
  49. package/dist/cli/types.js.map +1 -0
  50. package/dist/cli/use-execute-steps.d.ts +3 -2
  51. package/dist/cli/use-execute-steps.js +6 -1
  52. package/dist/cli/use-execute-steps.js.map +1 -1
  53. package/dist/cli/use-messages.d.ts +3 -0
  54. package/dist/cli/use-messages.js +11 -0
  55. package/dist/cli/use-messages.js.map +1 -0
  56. package/dist/cli/use-nodemon.d.ts +16 -0
  57. package/dist/cli/use-nodemon.js +84 -0
  58. package/dist/cli/use-nodemon.js.map +1 -0
  59. package/dist/cli/use-open-browser.d.ts +1 -0
  60. package/dist/cli/use-open-browser.js +44 -0
  61. package/dist/cli/use-open-browser.js.map +1 -0
  62. package/dist/cli/use-tunnel.d.ts +14 -0
  63. package/dist/cli/use-tunnel.js +131 -0
  64. package/dist/cli/use-tunnel.js.map +1 -0
  65. package/dist/cli/use-typescript-check.d.ts +15 -0
  66. package/dist/cli/use-typescript-check.js +97 -0
  67. package/dist/cli/use-typescript-check.js.map +1 -0
  68. package/dist/commands/build.d.ts +0 -3
  69. package/dist/commands/build.js +3 -16
  70. package/dist/commands/build.js.map +1 -1
  71. package/dist/commands/create.d.ts +9 -0
  72. package/dist/commands/create.js +30 -0
  73. package/dist/commands/create.js.map +1 -0
  74. package/dist/commands/dev.d.ts +7 -1
  75. package/dist/commands/dev.js +117 -9
  76. package/dist/commands/dev.js.map +1 -1
  77. package/dist/commands/start.d.ts +3 -1
  78. package/dist/commands/start.js +37 -15
  79. package/dist/commands/start.js.map +1 -1
  80. package/dist/commands/telemetry/disable.d.ts +5 -0
  81. package/dist/commands/telemetry/disable.js +14 -0
  82. package/dist/commands/telemetry/disable.js.map +1 -0
  83. package/dist/commands/telemetry/enable.d.ts +5 -0
  84. package/dist/commands/telemetry/enable.js +14 -0
  85. package/dist/commands/telemetry/enable.js.map +1 -0
  86. package/dist/commands/telemetry/status.d.ts +5 -0
  87. package/dist/commands/telemetry/status.js +14 -0
  88. package/dist/commands/telemetry/status.js.map +1 -0
  89. package/dist/context-warnings.d.ts +5 -0
  90. package/dist/context-warnings.js +31 -0
  91. package/dist/context-warnings.js.map +1 -0
  92. package/dist/context-warnings.test.d.ts +1 -0
  93. package/dist/context-warnings.test.js +28 -0
  94. package/dist/context-warnings.test.js.map +1 -0
  95. package/dist/server/asset-base-url-transform-plugin.d.ts +11 -0
  96. package/dist/server/asset-base-url-transform-plugin.js +48 -0
  97. package/dist/server/asset-base-url-transform-plugin.js.map +1 -0
  98. package/dist/server/asset-base-url-transform-plugin.test.d.ts +1 -0
  99. package/dist/server/asset-base-url-transform-plugin.test.js +134 -0
  100. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -0
  101. package/dist/server/auth/discovery.d.ts +32 -0
  102. package/dist/server/auth/discovery.js +56 -0
  103. package/dist/server/auth/discovery.js.map +1 -0
  104. package/dist/server/auth/discovery.test.d.ts +1 -0
  105. package/dist/server/auth/discovery.test.js +93 -0
  106. package/dist/server/auth/discovery.test.js.map +1 -0
  107. package/dist/server/auth/index.d.ts +44 -0
  108. package/dist/server/auth/index.js +2 -0
  109. package/dist/server/auth/index.js.map +1 -0
  110. package/dist/server/auth/providers/auth0.d.ts +40 -0
  111. package/dist/server/auth/providers/auth0.js +31 -0
  112. package/dist/server/auth/providers/auth0.js.map +1 -0
  113. package/dist/server/auth/providers/auth0.test.d.ts +1 -0
  114. package/dist/server/auth/providers/auth0.test.js +50 -0
  115. package/dist/server/auth/providers/auth0.test.js.map +1 -0
  116. package/dist/server/auth/providers/authplane.d.ts +49 -0
  117. package/dist/server/auth/providers/authplane.js +57 -0
  118. package/dist/server/auth/providers/authplane.js.map +1 -0
  119. package/dist/server/auth/providers/authplane.test.d.ts +1 -0
  120. package/dist/server/auth/providers/authplane.test.js +140 -0
  121. package/dist/server/auth/providers/authplane.test.js.map +1 -0
  122. package/dist/server/auth/providers/clerk.d.ts +51 -0
  123. package/dist/server/auth/providers/clerk.js +19 -0
  124. package/dist/server/auth/providers/clerk.js.map +1 -0
  125. package/dist/server/auth/providers/clerk.test.d.ts +1 -0
  126. package/dist/server/auth/providers/clerk.test.js +30 -0
  127. package/dist/server/auth/providers/clerk.test.js.map +1 -0
  128. package/dist/server/auth/providers/custom.d.ts +40 -0
  129. package/dist/server/auth/providers/custom.js +56 -0
  130. package/dist/server/auth/providers/custom.js.map +1 -0
  131. package/dist/server/auth/providers/custom.test.d.ts +1 -0
  132. package/dist/server/auth/providers/custom.test.js +158 -0
  133. package/dist/server/auth/providers/custom.test.js.map +1 -0
  134. package/dist/server/auth/providers/descope.d.ts +44 -0
  135. package/dist/server/auth/providers/descope.js +44 -0
  136. package/dist/server/auth/providers/descope.js.map +1 -0
  137. package/dist/server/auth/providers/descope.test.d.ts +1 -0
  138. package/dist/server/auth/providers/descope.test.js +62 -0
  139. package/dist/server/auth/providers/descope.test.js.map +1 -0
  140. package/dist/server/auth/providers/shared.d.ts +2 -0
  141. package/dist/server/auth/providers/shared.js +6 -0
  142. package/dist/server/auth/providers/shared.js.map +1 -0
  143. package/dist/server/auth/providers/shared.test.d.ts +1 -0
  144. package/dist/server/auth/providers/shared.test.js +10 -0
  145. package/dist/server/auth/providers/shared.test.js.map +1 -0
  146. package/dist/server/auth/providers/stytch.d.ts +25 -0
  147. package/dist/server/auth/providers/stytch.js +16 -0
  148. package/dist/server/auth/providers/stytch.js.map +1 -0
  149. package/dist/server/auth/providers/verify-spy.d.ts +12 -0
  150. package/dist/server/auth/providers/verify-spy.js +21 -0
  151. package/dist/server/auth/providers/verify-spy.js.map +1 -0
  152. package/dist/server/auth/providers/workos.d.ts +33 -0
  153. package/dist/server/auth/providers/workos.js +15 -0
  154. package/dist/server/auth/providers/workos.js.map +1 -0
  155. package/dist/server/auth/security-schemes.d.ts +23 -0
  156. package/dist/server/auth/security-schemes.js +64 -0
  157. package/dist/server/auth/security-schemes.js.map +1 -0
  158. package/dist/server/auth/security-schemes.test.d.ts +1 -0
  159. package/dist/server/auth/security-schemes.test.js +99 -0
  160. package/dist/server/auth/security-schemes.test.js.map +1 -0
  161. package/dist/server/auth/setup.d.ts +6 -0
  162. package/dist/server/auth/setup.js +92 -0
  163. package/dist/server/auth/setup.js.map +1 -0
  164. package/dist/server/auth/setup.test.d.ts +1 -0
  165. package/dist/server/auth/setup.test.js +508 -0
  166. package/dist/server/auth/setup.test.js.map +1 -0
  167. package/dist/server/auth/verify.d.ts +46 -0
  168. package/dist/server/auth/verify.js +62 -0
  169. package/dist/server/auth/verify.js.map +1 -0
  170. package/dist/server/auth/verify.test.d.ts +1 -0
  171. package/dist/server/auth/verify.test.js +149 -0
  172. package/dist/server/auth/verify.test.js.map +1 -0
  173. package/dist/server/auth-extra.test-d.d.ts +1 -0
  174. package/dist/server/auth-extra.test-d.js +82 -0
  175. package/dist/server/auth-extra.test-d.js.map +1 -0
  176. package/dist/server/auth.d.ts +58 -0
  177. package/dist/server/auth.js +28 -0
  178. package/dist/server/auth.js.map +1 -0
  179. package/dist/server/build-manifest.test.d.ts +1 -0
  180. package/dist/server/build-manifest.test.js +27 -0
  181. package/dist/server/build-manifest.test.js.map +1 -0
  182. package/dist/server/content-helpers.d.ts +67 -0
  183. package/dist/server/content-helpers.js +79 -0
  184. package/dist/server/content-helpers.js.map +1 -0
  185. package/dist/server/content-helpers.test.d.ts +1 -0
  186. package/dist/server/content-helpers.test.js +70 -0
  187. package/dist/server/content-helpers.test.js.map +1 -0
  188. package/dist/server/express.d.ts +11 -0
  189. package/dist/server/express.js +101 -0
  190. package/dist/server/express.js.map +1 -0
  191. package/dist/server/express.test.d.ts +1 -0
  192. package/dist/server/express.test.js +491 -0
  193. package/dist/server/express.test.js.map +1 -0
  194. package/dist/server/file-ref.d.ts +28 -0
  195. package/dist/server/file-ref.js +27 -0
  196. package/dist/server/file-ref.js.map +1 -0
  197. package/dist/server/host.d.ts +2 -0
  198. package/dist/server/host.js +11 -0
  199. package/dist/server/host.js.map +1 -0
  200. package/dist/server/host.test.d.ts +1 -0
  201. package/dist/server/host.test.js +13 -0
  202. package/dist/server/host.test.js.map +1 -0
  203. package/dist/server/index.d.ts +18 -3
  204. package/dist/server/index.js +15 -2
  205. package/dist/server/index.js.map +1 -1
  206. package/dist/server/inferUtilityTypes.d.ts +6 -6
  207. package/dist/server/inferUtilityTypes.js.map +1 -1
  208. package/dist/server/metric.d.ts +14 -0
  209. package/dist/server/metric.js +62 -0
  210. package/dist/server/metric.js.map +1 -0
  211. package/dist/server/middleware.d.ts +162 -0
  212. package/dist/server/middleware.js +126 -0
  213. package/dist/server/middleware.js.map +1 -0
  214. package/dist/server/middleware.test-d.d.ts +1 -0
  215. package/dist/server/middleware.test-d.js +75 -0
  216. package/dist/server/middleware.test-d.js.map +1 -0
  217. package/dist/server/middleware.test.d.ts +1 -0
  218. package/dist/server/middleware.test.js +529 -0
  219. package/dist/server/middleware.test.js.map +1 -0
  220. package/dist/server/requestOrigin.d.ts +7 -0
  221. package/dist/server/requestOrigin.js +25 -0
  222. package/dist/server/requestOrigin.js.map +1 -0
  223. package/dist/server/server.d.ts +426 -60
  224. package/dist/server/server.js +700 -96
  225. package/dist/server/server.js.map +1 -1
  226. package/dist/server/skills-integration.test.d.ts +1 -0
  227. package/dist/server/skills-integration.test.js +79 -0
  228. package/dist/server/skills-integration.test.js.map +1 -0
  229. package/dist/server/skills.d.ts +29 -0
  230. package/dist/server/skills.js +195 -0
  231. package/dist/server/skills.js.map +1 -0
  232. package/dist/server/skills.test.d.ts +1 -0
  233. package/dist/server/skills.test.js +247 -0
  234. package/dist/server/skills.test.js.map +1 -0
  235. package/dist/server/templateHelper.d.ts +5 -7
  236. package/dist/server/templateHelper.js +3 -22
  237. package/dist/server/templateHelper.js.map +1 -1
  238. package/dist/server/templates.generated.d.ts +4 -0
  239. package/dist/server/templates.generated.js +47 -0
  240. package/dist/server/templates.generated.js.map +1 -0
  241. package/dist/server/tunnel-proxy-router.d.ts +7 -0
  242. package/dist/server/tunnel-proxy-router.js +110 -0
  243. package/dist/server/tunnel-proxy-router.js.map +1 -0
  244. package/dist/server/tunnel-proxy-router.test.d.ts +1 -0
  245. package/dist/server/tunnel-proxy-router.test.js +229 -0
  246. package/dist/server/tunnel-proxy-router.test.js.map +1 -0
  247. package/dist/server/view-name.test-d.d.ts +1 -0
  248. package/dist/server/view-name.test-d.js +8 -0
  249. package/dist/server/view-name.test-d.js.map +1 -0
  250. package/dist/server/view-resource-resolution.test.d.ts +6 -0
  251. package/dist/server/view-resource-resolution.test.js +171 -0
  252. package/dist/server/view-resource-resolution.test.js.map +1 -0
  253. package/dist/server/viewsDevServer.d.ts +14 -0
  254. package/dist/server/viewsDevServer.js +48 -0
  255. package/dist/server/viewsDevServer.js.map +1 -0
  256. package/dist/test/utils.d.ts +16 -24
  257. package/dist/test/utils.js +42 -37
  258. package/dist/test/utils.js.map +1 -1
  259. package/dist/test/view.test.d.ts +1 -0
  260. package/dist/test/view.test.js +552 -0
  261. package/dist/test/view.test.js.map +1 -0
  262. package/dist/version.d.ts +1 -0
  263. package/dist/version.js +3 -0
  264. package/dist/version.js.map +1 -0
  265. package/dist/web/bridges/adaptor.d.ts +51 -0
  266. package/dist/web/bridges/adaptor.js +327 -0
  267. package/dist/web/bridges/adaptor.js.map +1 -0
  268. package/dist/web/bridges/adaptor.test.d.ts +1 -0
  269. package/dist/web/bridges/adaptor.test.js +225 -0
  270. package/dist/web/bridges/adaptor.test.js.map +1 -0
  271. package/dist/web/bridges/apps-sdk/bridge.d.ts +7 -2
  272. package/dist/web/bridges/apps-sdk/bridge.js +15 -3
  273. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -1
  274. package/dist/web/bridges/apps-sdk/index.d.ts +1 -2
  275. package/dist/web/bridges/apps-sdk/index.js +0 -1
  276. package/dist/web/bridges/apps-sdk/index.js.map +1 -1
  277. package/dist/web/bridges/apps-sdk/types.d.ts +39 -27
  278. package/dist/web/bridges/apps-sdk/types.js.map +1 -1
  279. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +11 -0
  280. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +11 -0
  281. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -1
  282. package/dist/web/bridges/get-adaptor.d.ts +7 -0
  283. package/dist/web/bridges/get-adaptor.js +9 -7
  284. package/dist/web/bridges/get-adaptor.js.map +1 -1
  285. package/dist/web/bridges/get-adaptor.test.d.ts +1 -0
  286. package/dist/web/bridges/get-adaptor.test.js +32 -0
  287. package/dist/web/bridges/get-adaptor.test.js.map +1 -0
  288. package/dist/web/bridges/index.js.map +1 -1
  289. package/dist/web/bridges/mcp-app/bridge.d.ts +27 -31
  290. package/dist/web/bridges/mcp-app/bridge.js +111 -198
  291. package/dist/web/bridges/mcp-app/bridge.js.map +1 -1
  292. package/dist/web/bridges/mcp-app/bridge.test.d.ts +1 -0
  293. package/dist/web/bridges/mcp-app/bridge.test.js +17 -0
  294. package/dist/web/bridges/mcp-app/bridge.test.js.map +1 -0
  295. package/dist/web/bridges/mcp-app/index.d.ts +0 -1
  296. package/dist/web/bridges/mcp-app/index.js +0 -1
  297. package/dist/web/bridges/mcp-app/index.js.map +1 -1
  298. package/dist/web/bridges/mcp-app/types.d.ts +2 -0
  299. package/dist/web/bridges/mcp-app/types.js.map +1 -1
  300. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +17 -3
  301. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +14 -2
  302. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -1
  303. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js +1 -41
  304. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -1
  305. package/dist/web/bridges/mcp-app/view-tools.test.d.ts +1 -0
  306. package/dist/web/bridges/mcp-app/view-tools.test.js +143 -0
  307. package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -0
  308. package/dist/web/bridges/types.d.ts +153 -13
  309. package/dist/web/bridges/types.js +14 -1
  310. package/dist/web/bridges/types.js.map +1 -1
  311. package/dist/web/bridges/types.test.d.ts +1 -0
  312. package/dist/web/bridges/types.test.js +19 -0
  313. package/dist/web/bridges/types.test.js.map +1 -0
  314. package/dist/web/bridges/use-host-context.d.ts +5 -0
  315. package/dist/web/bridges/use-host-context.js +5 -0
  316. package/dist/web/bridges/use-host-context.js.map +1 -1
  317. package/dist/web/components/modal-provider.d.ts +4 -0
  318. package/dist/web/components/modal-provider.js +46 -0
  319. package/dist/web/components/modal-provider.js.map +1 -0
  320. package/dist/web/create-store.d.ts +26 -0
  321. package/dist/web/create-store.js +43 -3
  322. package/dist/web/create-store.js.map +1 -1
  323. package/dist/web/create-store.test.js +31 -25
  324. package/dist/web/create-store.test.js.map +1 -1
  325. package/dist/web/data-llm.d.ts +35 -2
  326. package/dist/web/data-llm.js +31 -3
  327. package/dist/web/data-llm.js.map +1 -1
  328. package/dist/web/data-llm.test.js +51 -35
  329. package/dist/web/data-llm.test.js.map +1 -1
  330. package/dist/web/generate-helpers.d.ts +22 -18
  331. package/dist/web/generate-helpers.js +22 -18
  332. package/dist/web/generate-helpers.js.map +1 -1
  333. package/dist/web/generate-helpers.test-d.js +30 -28
  334. package/dist/web/generate-helpers.test-d.js.map +1 -1
  335. package/dist/web/generate-helpers.test.js.map +1 -1
  336. package/dist/web/helpers/state.d.ts +2 -2
  337. package/dist/web/helpers/state.js +11 -11
  338. package/dist/web/helpers/state.js.map +1 -1
  339. package/dist/web/helpers/state.test.js +9 -9
  340. package/dist/web/helpers/state.test.js.map +1 -1
  341. package/dist/web/hooks/index.d.ts +8 -2
  342. package/dist/web/hooks/index.js +7 -1
  343. package/dist/web/hooks/index.js.map +1 -1
  344. package/dist/web/hooks/test/utils.d.ts +7 -2
  345. package/dist/web/hooks/test/utils.js +18 -3
  346. package/dist/web/hooks/test/utils.js.map +1 -1
  347. package/dist/web/hooks/use-call-tool.d.ts +45 -0
  348. package/dist/web/hooks/use-call-tool.js +28 -0
  349. package/dist/web/hooks/use-call-tool.js.map +1 -1
  350. package/dist/web/hooks/use-call-tool.test-d.js.map +1 -1
  351. package/dist/web/hooks/use-call-tool.test.js +62 -27
  352. package/dist/web/hooks/use-call-tool.test.js.map +1 -1
  353. package/dist/web/hooks/use-display-mode.d.ts +23 -3
  354. package/dist/web/hooks/use-display-mode.js +20 -0
  355. package/dist/web/hooks/use-display-mode.js.map +1 -1
  356. package/dist/web/hooks/use-display-mode.test-d.d.ts +1 -0
  357. package/dist/web/hooks/use-display-mode.test-d.js +8 -0
  358. package/dist/web/hooks/use-display-mode.test-d.js.map +1 -0
  359. package/dist/web/hooks/use-display-mode.test.js +56 -20
  360. package/dist/web/hooks/use-display-mode.test.js.map +1 -1
  361. package/dist/web/hooks/use-download.d.ts +5 -0
  362. package/dist/web/hooks/use-download.js +8 -0
  363. package/dist/web/hooks/use-download.js.map +1 -0
  364. package/dist/web/hooks/use-download.test.d.ts +1 -0
  365. package/dist/web/hooks/use-download.test.js +103 -0
  366. package/dist/web/hooks/use-download.test.js.map +1 -0
  367. package/dist/web/hooks/use-files.d.ts +35 -6
  368. package/dist/web/hooks/use-files.js +37 -2
  369. package/dist/web/hooks/use-files.js.map +1 -1
  370. package/dist/web/hooks/use-files.test.js +36 -3
  371. package/dist/web/hooks/use-files.test.js.map +1 -1
  372. package/dist/web/hooks/use-host-info.d.ts +22 -0
  373. package/dist/web/hooks/use-host-info.js +30 -0
  374. package/dist/web/hooks/use-host-info.js.map +1 -0
  375. package/dist/web/hooks/use-host-info.test.d.ts +1 -0
  376. package/dist/web/hooks/use-host-info.test.js +59 -0
  377. package/dist/web/hooks/use-host-info.test.js.map +1 -0
  378. package/dist/web/hooks/use-layout.d.ts +3 -1
  379. package/dist/web/hooks/use-layout.js +2 -0
  380. package/dist/web/hooks/use-layout.js.map +1 -1
  381. package/dist/web/hooks/use-layout.test.js +62 -29
  382. package/dist/web/hooks/use-layout.test.js.map +1 -1
  383. package/dist/web/hooks/use-open-external.d.ts +20 -1
  384. package/dist/web/hooks/use-open-external.js +17 -1
  385. package/dist/web/hooks/use-open-external.js.map +1 -1
  386. package/dist/web/hooks/use-open-external.test.js +38 -13
  387. package/dist/web/hooks/use-open-external.test.js.map +1 -1
  388. package/dist/web/hooks/use-register-view-tool.d.ts +38 -0
  389. package/dist/web/hooks/use-register-view-tool.js +50 -0
  390. package/dist/web/hooks/use-register-view-tool.js.map +1 -0
  391. package/dist/web/hooks/use-request-close.d.ts +16 -0
  392. package/dist/web/hooks/use-request-close.js +21 -0
  393. package/dist/web/hooks/use-request-close.js.map +1 -0
  394. package/dist/web/hooks/use-request-close.test.d.ts +1 -0
  395. package/dist/web/hooks/use-request-close.test.js +47 -0
  396. package/dist/web/hooks/use-request-close.test.js.map +1 -0
  397. package/dist/web/hooks/use-request-modal.d.ts +18 -3
  398. package/dist/web/hooks/use-request-modal.js +25 -8
  399. package/dist/web/hooks/use-request-modal.js.map +1 -1
  400. package/dist/web/hooks/use-request-modal.test.js +15 -1
  401. package/dist/web/hooks/use-request-modal.test.js.map +1 -1
  402. package/dist/web/hooks/use-request-size.d.ts +20 -0
  403. package/dist/web/hooks/use-request-size.js +24 -0
  404. package/dist/web/hooks/use-request-size.js.map +1 -0
  405. package/dist/web/hooks/use-request-size.test.d.ts +1 -0
  406. package/dist/web/hooks/use-request-size.test.js +47 -0
  407. package/dist/web/hooks/use-request-size.test.js.map +1 -0
  408. package/dist/web/hooks/use-send-follow-up-message.d.ts +19 -1
  409. package/dist/web/hooks/use-send-follow-up-message.js +19 -2
  410. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -1
  411. package/dist/web/hooks/use-set-open-in-app-url.d.ts +18 -0
  412. package/dist/web/hooks/use-set-open-in-app-url.js +25 -0
  413. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -0
  414. package/dist/web/hooks/use-set-open-in-app-url.test.d.ts +1 -0
  415. package/dist/web/hooks/use-set-open-in-app-url.test.js +63 -0
  416. package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -0
  417. package/dist/web/hooks/use-tool-info.d.ts +53 -2
  418. package/dist/web/hooks/use-tool-info.js +30 -7
  419. package/dist/web/hooks/use-tool-info.js.map +1 -1
  420. package/dist/web/hooks/use-tool-info.test-d.js +11 -29
  421. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -1
  422. package/dist/web/hooks/use-tool-info.test.js +43 -33
  423. package/dist/web/hooks/use-tool-info.test.js.map +1 -1
  424. package/dist/web/hooks/use-user.d.ts +2 -0
  425. package/dist/web/hooks/use-user.js +20 -2
  426. package/dist/web/hooks/use-user.js.map +1 -1
  427. package/dist/web/hooks/use-user.test.js +101 -27
  428. package/dist/web/hooks/use-user.test.js.map +1 -1
  429. package/dist/web/hooks/use-view-state.d.ts +25 -0
  430. package/dist/web/hooks/use-view-state.js +42 -0
  431. package/dist/web/hooks/use-view-state.js.map +1 -0
  432. package/dist/web/hooks/use-view-state.test.d.ts +1 -0
  433. package/dist/web/hooks/use-view-state.test.js +212 -0
  434. package/dist/web/hooks/use-view-state.test.js.map +1 -0
  435. package/dist/web/index.d.ts +1 -2
  436. package/dist/web/index.js +1 -2
  437. package/dist/web/index.js.map +1 -1
  438. package/dist/web/mount-view.d.ts +20 -0
  439. package/dist/web/mount-view.js +46 -0
  440. package/dist/web/mount-view.js.map +1 -0
  441. package/dist/web/plugin/data-llm.test.js.map +1 -1
  442. package/dist/web/plugin/plugin-build.test.d.ts +1 -0
  443. package/dist/web/plugin/plugin-build.test.js +54 -0
  444. package/dist/web/plugin/plugin-build.test.js.map +1 -0
  445. package/dist/web/plugin/plugin.d.ts +38 -1
  446. package/dist/web/plugin/plugin.js +179 -18
  447. package/dist/web/plugin/plugin.js.map +1 -1
  448. package/dist/web/plugin/plugin.test.d.ts +1 -0
  449. package/dist/web/plugin/plugin.test.js +61 -0
  450. package/dist/web/plugin/plugin.test.js.map +1 -0
  451. package/dist/web/plugin/scan-views.d.ts +16 -0
  452. package/dist/web/plugin/scan-views.js +88 -0
  453. package/dist/web/plugin/scan-views.js.map +1 -0
  454. package/dist/web/plugin/scan-views.test.d.ts +1 -0
  455. package/dist/web/plugin/scan-views.test.js +99 -0
  456. package/dist/web/plugin/scan-views.test.js.map +1 -0
  457. package/dist/web/plugin/transform-data-llm.js +1 -1
  458. package/dist/web/plugin/transform-data-llm.js.map +1 -1
  459. package/dist/web/plugin/transform-data-llm.test.js.map +1 -1
  460. package/dist/web/plugin/validate-view.d.ts +1 -0
  461. package/dist/web/plugin/validate-view.js +9 -0
  462. package/dist/web/plugin/validate-view.js.map +1 -0
  463. package/dist/web/plugin/validate-view.test.d.ts +1 -0
  464. package/dist/web/plugin/validate-view.test.js +24 -0
  465. package/dist/web/plugin/validate-view.test.js.map +1 -0
  466. package/dist/web/proxy.js +0 -1
  467. package/dist/web/proxy.js.map +1 -1
  468. package/dist/web/types.d.ts +4 -0
  469. package/dist/web/types.js.map +1 -1
  470. package/package.json +59 -30
  471. package/tsconfig.base.json +33 -0
  472. package/dist/server/templates/development.hbs +0 -66
  473. package/dist/server/templates/production.hbs +0 -7
  474. package/dist/server/widgetsDevServer.d.ts +0 -12
  475. package/dist/server/widgetsDevServer.js +0 -47
  476. package/dist/server/widgetsDevServer.js.map +0 -1
  477. package/dist/test/widget.test.js +0 -255
  478. package/dist/test/widget.test.js.map +0 -1
  479. package/dist/web/bridges/apps-sdk/adaptor.d.ts +0 -14
  480. package/dist/web/bridges/apps-sdk/adaptor.js +0 -39
  481. package/dist/web/bridges/apps-sdk/adaptor.js.map +0 -1
  482. package/dist/web/bridges/mcp-app/adaptor.d.ts +0 -19
  483. package/dist/web/bridges/mcp-app/adaptor.js +0 -145
  484. package/dist/web/bridges/mcp-app/adaptor.js.map +0 -1
  485. package/dist/web/hooks/use-widget-state.d.ts +0 -4
  486. package/dist/web/hooks/use-widget-state.js +0 -32
  487. package/dist/web/hooks/use-widget-state.js.map +0 -1
  488. package/dist/web/hooks/use-widget-state.test.js +0 -61
  489. package/dist/web/hooks/use-widget-state.test.js.map +0 -1
  490. package/dist/web/mount-widget.d.ts +0 -1
  491. package/dist/web/mount-widget.js +0 -19
  492. package/dist/web/mount-widget.js.map +0 -1
  493. /package/dist/{test/widget.test.d.ts → cli/build-helpers.test.d.ts} +0 -0
  494. /package/dist/{web/hooks/use-widget-state.test.d.ts → cli/build-steps.test.d.ts} +0 -0
@@ -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"]}
@@ -1,68 +1,101 @@
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/mcp-app/adaptor.js";
3
+ import { HostAdaptor } from "../bridges/adaptor.js";
4
4
  import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
5
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", () => {
9
- let OpenaiMock;
10
9
  beforeEach(() => {
11
- OpenaiMock = {
12
- theme: "light",
13
- maxHeight: 500,
14
- safeArea: { insets: { top: 0, bottom: 0, left: 0, right: 0 } },
15
- };
16
- vi.stubGlobal("openai", OpenaiMock);
10
+ HostAdaptor.resetInstance();
11
+ McpAppBridge.resetInstance();
17
12
  vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
13
+ vi.stubGlobal("openai", { view: { mode: "inline" } });
14
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
18
15
  });
19
16
  afterEach(() => {
20
17
  vi.unstubAllGlobals();
21
18
  vi.resetAllMocks();
19
+ McpAppBridge.resetInstance();
20
+ HostAdaptor.resetInstance();
22
21
  });
23
- it("should return theme, maxHeight, and safeArea from window.openai", () => {
22
+ it("should return theme, maxHeight, and safeArea from mcp host context", async () => {
23
+ vi.stubGlobal("parent", {
24
+ postMessage: getMcpAppHostPostMessageMock({
25
+ theme: "light",
26
+ containerDimensions: { maxHeight: 500, width: 400 },
27
+ safeAreaInsets: { top: 0, bottom: 0, left: 0, right: 0 },
28
+ }),
29
+ });
24
30
  const { result } = renderHook(() => useLayout());
25
- expect(result.current.theme).toBe("light");
26
- expect(result.current.maxHeight).toBe(500);
27
- expect(result.current.safeArea).toEqual({
28
- insets: { top: 0, bottom: 0, left: 0, right: 0 },
31
+ await waitFor(() => {
32
+ expect(result.current.theme).toBe("light");
33
+ expect(result.current.maxHeight).toBe(500);
34
+ expect(result.current.safeArea).toEqual({
35
+ insets: { top: 0, bottom: 0, left: 0, right: 0 },
36
+ });
29
37
  });
30
38
  });
31
- it("should return dark theme when set to dark", () => {
32
- OpenaiMock.theme = "dark";
39
+ it("should return dark theme when set to dark", async () => {
40
+ vi.stubGlobal("parent", {
41
+ postMessage: getMcpAppHostPostMessageMock({
42
+ theme: "dark",
43
+ containerDimensions: { maxHeight: 500, width: 400 },
44
+ safeAreaInsets: { top: 0, bottom: 0, left: 0, right: 0 },
45
+ }),
46
+ });
33
47
  const { result } = renderHook(() => useLayout());
34
- expect(result.current.theme).toBe("dark");
48
+ await waitFor(() => {
49
+ expect(result.current.theme).toBe("dark");
50
+ });
35
51
  });
36
- it("should return different maxHeight when set", () => {
37
- OpenaiMock.maxHeight = 800;
52
+ it("should return different maxHeight when set", async () => {
53
+ vi.stubGlobal("parent", {
54
+ postMessage: getMcpAppHostPostMessageMock({
55
+ theme: "light",
56
+ containerDimensions: { maxHeight: 800, width: 400 },
57
+ safeAreaInsets: { top: 0, bottom: 0, left: 0, right: 0 },
58
+ }),
59
+ });
38
60
  const { result } = renderHook(() => useLayout());
39
- expect(result.current.maxHeight).toBe(800);
61
+ await waitFor(() => {
62
+ expect(result.current.maxHeight).toBe(800);
63
+ });
40
64
  });
41
- it("should return safeArea with insets when set", () => {
42
- OpenaiMock.safeArea = {
43
- insets: { top: 44, bottom: 34, left: 0, right: 0 },
44
- };
65
+ it("should return safeArea with insets when set", async () => {
66
+ vi.stubGlobal("parent", {
67
+ postMessage: getMcpAppHostPostMessageMock({
68
+ theme: "light",
69
+ containerDimensions: { maxHeight: 500, width: 400 },
70
+ safeAreaInsets: { top: 44, bottom: 34, left: 0, right: 0 },
71
+ }),
72
+ });
45
73
  const { result } = renderHook(() => useLayout());
46
- expect(result.current.safeArea.insets.top).toBe(44);
47
- expect(result.current.safeArea.insets.bottom).toBe(34);
74
+ await waitFor(() => {
75
+ expect(result.current.safeArea.insets.top).toBe(44);
76
+ expect(result.current.safeArea.insets.bottom).toBe(34);
77
+ });
48
78
  });
49
79
  });
50
80
  describe("mcp-app host type", () => {
51
81
  beforeEach(() => {
82
+ HostAdaptor.resetInstance();
83
+ McpAppBridge.resetInstance();
52
84
  vi.stubGlobal("skybridge", { hostType: "mcp-app" });
85
+ vi.stubGlobal("openai", undefined);
53
86
  vi.stubGlobal("ResizeObserver", MockResizeObserver);
54
87
  });
55
- afterEach(() => {
88
+ afterEach(async () => {
56
89
  vi.unstubAllGlobals();
57
90
  vi.resetAllMocks();
58
91
  McpAppBridge.resetInstance();
59
- McpAppAdaptor.resetInstance();
92
+ HostAdaptor.resetInstance();
60
93
  });
61
94
  it("should return theme, maxHeight, and safeArea from mcp host context", async () => {
62
95
  vi.stubGlobal("parent", {
63
96
  postMessage: getMcpAppHostPostMessageMock({
64
97
  theme: "dark",
65
- containerDimensions: { height: 400, width: 400, maxHeight: 800 },
98
+ containerDimensions: { maxHeight: 800, width: 400 },
66
99
  safeAreaInsets: { top: 20, right: 0, bottom: 34, left: 0 },
67
100
  }),
68
101
  });
@@ -79,7 +112,7 @@ describe("useLayout", () => {
79
112
  vi.stubGlobal("parent", {
80
113
  postMessage: getMcpAppHostPostMessageMock({
81
114
  theme: "light",
82
- containerDimensions: { height: 400, width: 400, maxHeight: 500 },
115
+ containerDimensions: { maxHeight: 500, width: 400 },
83
116
  safeAreaInsets: { top: 44, right: 0, bottom: 34, left: 0 },
84
117
  }),
85
118
  });
@@ -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,+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,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,mBAAmB,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE;oBAChE,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,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE;oBAChE,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,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,UAAU,CAAC,GAAG,EAAE;YACd,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;YACrD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;YACtD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,WAAW,CAAC,aAAa,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;YAClF,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,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;iBACzD,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,OAAO,CAAC,CAAC;gBAC3C,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,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;iBACjD,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YACzD,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,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;iBACzD,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;YAC5C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;YAC1D,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,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;iBACzD,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,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC3D,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,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,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,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACpD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACzD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,UAAU,CAAC,GAAG,EAAE;YACd,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;YACpD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACnC,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,WAAW,CAAC,aAAa,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,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 { HostAdaptor } from \"../bridges/adaptor.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/bridge.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 beforeEach(() => {\n HostAdaptor.resetInstance();\n McpAppBridge.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 McpAppBridge.resetInstance();\n HostAdaptor.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: \"light\",\n containerDimensions: { maxHeight: 500, width: 400 },\n safeAreaInsets: { top: 0, bottom: 0, left: 0, right: 0 },\n }),\n });\n const { result } = renderHook(() => useLayout());\n\n await waitFor(() => {\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\n it(\"should return dark theme when set to dark\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n theme: \"dark\",\n containerDimensions: { maxHeight: 500, width: 400 },\n safeAreaInsets: { top: 0, bottom: 0, left: 0, right: 0 },\n }),\n });\n const { result } = renderHook(() => useLayout());\n\n await waitFor(() => {\n expect(result.current.theme).toBe(\"dark\");\n });\n });\n\n it(\"should return different maxHeight when set\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n theme: \"light\",\n containerDimensions: { maxHeight: 800, width: 400 },\n safeAreaInsets: { top: 0, bottom: 0, left: 0, right: 0 },\n }),\n });\n const { result } = renderHook(() => useLayout());\n\n await waitFor(() => {\n expect(result.current.maxHeight).toBe(800);\n });\n });\n\n it(\"should return safeArea with insets when set\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n theme: \"light\",\n containerDimensions: { maxHeight: 500, width: 400 },\n safeAreaInsets: { top: 44, bottom: 34, left: 0, right: 0 },\n }),\n });\n const { result } = renderHook(() => useLayout());\n\n await waitFor(() => {\n expect(result.current.safeArea.insets.top).toBe(44);\n expect(result.current.safeArea.insets.bottom).toBe(34);\n });\n });\n });\n\n describe(\"mcp-app host type\", () => {\n beforeEach(() => {\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n vi.stubGlobal(\"skybridge\", { hostType: \"mcp-app\" });\n vi.stubGlobal(\"openai\", undefined);\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n });\n\n afterEach(async () => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n McpAppBridge.resetInstance();\n HostAdaptor.resetInstance();\n });\n\n it(\"should return 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
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
20
  const adaptor = getAdaptor();
5
- const openExternal = useCallback((href) => adaptor.openExternal(href), [adaptor]);
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,49 +1,74 @@
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 { HostAdaptor } from "../bridges/adaptor.js";
3
4
  import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
5
+ import { getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
4
6
  import { useOpenExternal } from "./use-open-external.js";
5
7
  describe("useOpenExternal", () => {
6
8
  describe("apps-sdk host", () => {
7
9
  let openExternalMock;
10
+ let postMessageMock;
8
11
  beforeEach(() => {
9
12
  openExternalMock = vi.fn();
10
13
  vi.stubGlobal("openai", {
11
14
  openExternal: openExternalMock,
12
15
  });
13
16
  vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
17
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
18
+ postMessageMock = getMcpAppHostPostMessageMock();
19
+ vi.stubGlobal("parent", { postMessage: postMessageMock });
14
20
  });
15
21
  afterEach(() => {
22
+ HostAdaptor.resetInstance();
23
+ McpAppBridge.resetInstance();
16
24
  vi.unstubAllGlobals();
17
25
  vi.resetAllMocks();
18
26
  });
19
- it("should return a function that calls window.openai.openExternal with the href", () => {
27
+ it("should call window.openai.openExternal even without a redirectUrl option", () => {
20
28
  const { result } = renderHook(() => useOpenExternal());
21
29
  const href = "https://example.com";
22
30
  result.current(href);
23
31
  expect(openExternalMock).toHaveBeenCalledTimes(1);
24
32
  expect(openExternalMock).toHaveBeenCalledWith({ href });
33
+ expect(postMessageMock).not.toHaveBeenCalledWith(expect.objectContaining({ method: "ui/open-link" }), "*");
34
+ });
35
+ it("should call window.openai.openExternal when redirectUrl is false", () => {
36
+ const { result } = renderHook(() => useOpenExternal());
37
+ const href = "https://example.com";
38
+ result.current(href, { redirectUrl: false });
39
+ expect(openExternalMock).toHaveBeenCalledTimes(1);
40
+ expect(openExternalMock).toHaveBeenCalledWith({
41
+ href,
42
+ redirectUrl: false,
43
+ });
25
44
  });
26
45
  });
27
46
  describe("mcp-app host", () => {
28
- const mockPostMessage = vi.fn();
47
+ let postMessageMock;
29
48
  beforeEach(() => {
30
- vi.stubGlobal("parent", { postMessage: mockPostMessage });
49
+ vi.stubGlobal("openai", undefined);
31
50
  vi.stubGlobal("skybridge", { hostType: "mcp-app" });
51
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
52
+ postMessageMock = getMcpAppHostPostMessageMock();
53
+ vi.stubGlobal("parent", { postMessage: postMessageMock });
32
54
  });
33
- afterEach(() => {
55
+ afterEach(async () => {
56
+ HostAdaptor.resetInstance();
57
+ McpAppBridge.resetInstance();
34
58
  vi.unstubAllGlobals();
35
59
  vi.resetAllMocks();
36
- McpAppBridge.resetInstance();
37
60
  });
38
- it("should return a function that sends ui/open-link request to the MCP host", () => {
61
+ it("should return a function that sends ui/open-link request to the MCP host", async () => {
39
62
  const { result } = renderHook(() => useOpenExternal());
40
63
  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
- }), "*");
64
+ result.current(href, { redirectUrl: false });
65
+ await waitFor(() => {
66
+ expect(postMessageMock).toHaveBeenCalledWith(expect.objectContaining({
67
+ jsonrpc: "2.0",
68
+ method: "ui/open-link",
69
+ params: { url: href },
70
+ }), "*");
71
+ });
47
72
  });
48
73
  });
49
74
  });
@@ -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,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,IAAI,gBAA0C,CAAC;QAC/C,IAAI,eAAgE,CAAC;QAErE,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;YACrD,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,GAAG,EAAE;YACb,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACrB,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,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;YACxD,MAAM,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAC9C,MAAM,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,EACnD,GAAG,CACJ,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;YAC1E,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,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,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,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACrB,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 { HostAdaptor } from \"../bridges/adaptor.js\";\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 let postMessageMock: ReturnType<typeof getMcpAppHostPostMessageMock>;\n\n beforeEach(() => {\n openExternalMock = vi.fn();\n vi.stubGlobal(\"openai\", {\n openExternal: openExternalMock,\n });\n vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n postMessageMock = getMcpAppHostPostMessageMock();\n vi.stubGlobal(\"parent\", { postMessage: postMessageMock });\n });\n\n afterEach(() => {\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n });\n\n it(\"should call window.openai.openExternal even without a redirectUrl option\", () => {\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 expect(postMessageMock).not.toHaveBeenCalledWith(\n expect.objectContaining({ method: \"ui/open-link\" }),\n \"*\",\n );\n });\n\n it(\"should call window.openai.openExternal when redirectUrl is false\", () => {\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(\"openai\", undefined);\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 HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n vi.unstubAllGlobals();\n vi.resetAllMocks();\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 {};
@@ -0,0 +1,47 @@
1
+ import { act, renderHook } from "@testing-library/react";
2
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
3
+ import { HostAdaptor } from "../bridges/adaptor.js";
4
+ import { getAdaptor } from "../bridges/get-adaptor.js";
5
+ import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
6
+ import { useRequestClose } from "./use-request-close.js";
7
+ describe("useRequestClose", () => {
8
+ beforeEach(() => {
9
+ HostAdaptor.resetInstance();
10
+ McpAppBridge.resetInstance();
11
+ vi.stubGlobal("skybridge", { hostType: "mcp-app" });
12
+ vi.stubGlobal("openai", undefined);
13
+ vi.stubGlobal("parent", { postMessage: vi.fn() });
14
+ });
15
+ afterEach(() => {
16
+ vi.unstubAllGlobals();
17
+ vi.resetAllMocks();
18
+ HostAdaptor.resetInstance();
19
+ McpAppBridge.resetInstance();
20
+ });
21
+ it("calls app.requestTeardown via the MCP path", async () => {
22
+ const requestTeardown = vi.fn().mockResolvedValue(undefined);
23
+ // biome-ignore lint/suspicious/noExplicitAny: test seam
24
+ const adaptor = getAdaptor();
25
+ adaptor.mcp.getApp = vi.fn().mockResolvedValue({ requestTeardown });
26
+ const { result } = renderHook(() => useRequestClose());
27
+ await act(async () => {
28
+ await result.current();
29
+ });
30
+ expect(requestTeardown).toHaveBeenCalledTimes(1);
31
+ });
32
+ it("calls app.requestTeardown even when window.openai is present", async () => {
33
+ vi.stubGlobal("openai", { requestClose: vi.fn() });
34
+ HostAdaptor.resetInstance();
35
+ McpAppBridge.resetInstance();
36
+ const requestTeardown = vi.fn().mockResolvedValue(undefined);
37
+ // biome-ignore lint/suspicious/noExplicitAny: test seam
38
+ const adaptor = getAdaptor();
39
+ adaptor.mcp.getApp = vi.fn().mockResolvedValue({ requestTeardown });
40
+ const { result } = renderHook(() => useRequestClose());
41
+ await act(async () => {
42
+ await result.current();
43
+ });
44
+ expect(requestTeardown).toHaveBeenCalledTimes(1);
45
+ });
46
+ });
47
+ //# sourceMappingURL=use-request-close.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-request-close.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-request-close.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,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,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,UAAU,CAAC,GAAG,EAAE;QACd,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QACpD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACnC,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;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,eAAe,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC7D,wDAAwD;QACxD,MAAM,OAAO,GAAG,UAAU,EAAS,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,eAAe,EAAE,CAAC,CAAC;QAEpE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;QACvD,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,eAAe,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QACnD,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAE7B,MAAM,eAAe,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC7D,wDAAwD;QACxD,MAAM,OAAO,GAAG,UAAU,EAAS,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,eAAe,EAAE,CAAC,CAAC;QAEpE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;QACvD,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,eAAe,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { act, renderHook } from \"@testing-library/react\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { HostAdaptor } from \"../bridges/adaptor.js\";\nimport { getAdaptor } from \"../bridges/get-adaptor.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/bridge.js\";\nimport { useRequestClose } from \"./use-request-close.js\";\n\ndescribe(\"useRequestClose\", () => {\n beforeEach(() => {\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n vi.stubGlobal(\"skybridge\", { hostType: \"mcp-app\" });\n vi.stubGlobal(\"openai\", undefined);\n vi.stubGlobal(\"parent\", { postMessage: vi.fn() });\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n });\n\n it(\"calls app.requestTeardown via the MCP path\", async () => {\n const requestTeardown = vi.fn().mockResolvedValue(undefined);\n // biome-ignore lint/suspicious/noExplicitAny: test seam\n const adaptor = getAdaptor() as any;\n adaptor.mcp.getApp = vi.fn().mockResolvedValue({ requestTeardown });\n\n const { result } = renderHook(() => useRequestClose());\n await act(async () => {\n await result.current();\n });\n\n expect(requestTeardown).toHaveBeenCalledTimes(1);\n });\n\n it(\"calls app.requestTeardown even when window.openai is present\", async () => {\n vi.stubGlobal(\"openai\", { requestClose: vi.fn() });\n HostAdaptor.resetInstance();\n McpAppBridge.resetInstance();\n\n const requestTeardown = vi.fn().mockResolvedValue(undefined);\n // biome-ignore lint/suspicious/noExplicitAny: test seam\n const adaptor = getAdaptor() as any;\n adaptor.mcp.getApp = vi.fn().mockResolvedValue({ requestTeardown });\n\n const { result } = renderHook(() => useRequestClose());\n await act(async () => {\n await result.current();\n });\n\n expect(requestTeardown).toHaveBeenCalledTimes(1);\n });\n});\n"]}
@@ -1,9 +1,24 @@
1
- import { type RequestModalOptions } from "../bridges/apps-sdk/index.js";
1
+ import { type RequestModalOptions } from "../bridges/index.js";
2
2
  /**
3
- * Triggers a modal containing the widget rendered in display mode "modal"
3
+ * Open the current view in a modal overlay (`displayMode === "modal"`).
4
+ *
5
+ * Returns `{ isOpen, params, open }`: `open(opts)` triggers the host to render
6
+ * the view in a modal, optionally passing `params` that are surfaced back via
7
+ * `params` here. Useful for confirmation flows, detail panels, or any modal
8
+ * lifecycle owned by the host.
9
+ *
10
+ * Use {@link useDisplayMode} for non-modal display modes.
11
+ *
12
+ * @example
13
+ * ```tsx
14
+ * const { isOpen, open } = useRequestModal();
15
+ * <button onClick={() => open({ params: { id: 42 } })}>Show details</button>
16
+ * ```
17
+ *
18
+ * @see https://docs.skybridge.tech/api-reference/use-request-modal
4
19
  */
5
20
  export declare function useRequestModal(): {
6
21
  isOpen: boolean;
7
- open: (options: RequestModalOptions) => void;
8
22
  params: Record<string, unknown> | undefined;
23
+ open: (opts: RequestModalOptions) => void;
9
24
  };