skybridge 0.0.0-dev.eab2782 → 0.0.0-dev.eabe71b

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 (547) hide show
  1. package/README.md +152 -0
  2. package/bin/run.js +5 -0
  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.js +190 -0
  37. package/dist/cli/tunnel.test.js.map +1 -0
  38. package/dist/cli/types.d.ts +5 -0
  39. package/dist/cli/types.js.map +1 -0
  40. package/dist/cli/use-execute-steps.d.ts +11 -0
  41. package/dist/cli/use-execute-steps.js +36 -0
  42. package/dist/cli/use-execute-steps.js.map +1 -0
  43. package/dist/cli/use-messages.d.ts +3 -0
  44. package/dist/cli/use-messages.js +11 -0
  45. package/dist/cli/use-messages.js.map +1 -0
  46. package/dist/cli/use-nodemon.d.ts +2 -0
  47. package/dist/cli/use-nodemon.js +73 -0
  48. package/dist/cli/use-nodemon.js.map +1 -0
  49. package/dist/cli/use-open-browser.d.ts +1 -0
  50. package/dist/cli/use-open-browser.js +44 -0
  51. package/dist/cli/use-open-browser.js.map +1 -0
  52. package/dist/cli/use-tunnel.d.ts +14 -0
  53. package/dist/cli/use-tunnel.js +131 -0
  54. package/dist/cli/use-tunnel.js.map +1 -0
  55. package/dist/cli/use-typescript-check.d.ts +9 -0
  56. package/dist/cli/use-typescript-check.js +94 -0
  57. package/dist/cli/use-typescript-check.js.map +1 -0
  58. package/dist/commands/build.d.ts +8 -0
  59. package/dist/commands/build.js +90 -0
  60. package/dist/commands/build.js.map +1 -0
  61. package/dist/commands/create.d.ts +9 -0
  62. package/dist/commands/create.js +30 -0
  63. package/dist/commands/create.js.map +1 -0
  64. package/dist/commands/dev.d.ts +12 -0
  65. package/dist/commands/dev.js +96 -0
  66. package/dist/commands/dev.js.map +1 -0
  67. package/dist/commands/start.d.ts +9 -0
  68. package/dist/commands/start.js +55 -0
  69. package/dist/commands/start.js.map +1 -0
  70. package/dist/commands/telemetry/disable.d.ts +5 -0
  71. package/dist/commands/telemetry/disable.js +14 -0
  72. package/dist/commands/telemetry/disable.js.map +1 -0
  73. package/dist/commands/telemetry/enable.d.ts +5 -0
  74. package/dist/commands/telemetry/enable.js +14 -0
  75. package/dist/commands/telemetry/enable.js.map +1 -0
  76. package/dist/commands/telemetry/status.d.ts +5 -0
  77. package/dist/commands/telemetry/status.js +14 -0
  78. package/dist/commands/telemetry/status.js.map +1 -0
  79. package/dist/server/asset-base-url-transform-plugin.d.ts +11 -0
  80. package/dist/server/asset-base-url-transform-plugin.js +48 -0
  81. package/dist/server/asset-base-url-transform-plugin.js.map +1 -0
  82. package/dist/server/asset-base-url-transform-plugin.test.js +134 -0
  83. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -0
  84. package/dist/server/auth/discovery.d.ts +11 -0
  85. package/dist/server/auth/discovery.js +38 -0
  86. package/dist/server/auth/discovery.js.map +1 -0
  87. package/dist/server/auth/discovery.test.js +81 -0
  88. package/dist/server/auth/discovery.test.js.map +1 -0
  89. package/dist/server/auth/index.d.ts +18 -0
  90. package/dist/server/auth/index.js +2 -0
  91. package/dist/server/auth/index.js.map +1 -0
  92. package/dist/server/auth/providers/custom.d.ts +14 -0
  93. package/dist/server/auth/providers/custom.js +28 -0
  94. package/dist/server/auth/providers/custom.js.map +1 -0
  95. package/dist/server/auth/providers/custom.test.js +113 -0
  96. package/dist/server/auth/providers/custom.test.js.map +1 -0
  97. package/dist/server/auth/providers/descope.d.ts +13 -0
  98. package/dist/server/auth/providers/descope.js +14 -0
  99. package/dist/server/auth/providers/descope.js.map +1 -0
  100. package/dist/server/auth/providers/descope.test.js +35 -0
  101. package/dist/server/auth/providers/descope.test.js.map +1 -0
  102. package/dist/server/auth/providers/stytch.d.ts +11 -0
  103. package/dist/server/auth/providers/stytch.js +17 -0
  104. package/dist/server/auth/providers/stytch.js.map +1 -0
  105. package/dist/server/auth/providers/stytch.test.js +33 -0
  106. package/dist/server/auth/providers/stytch.test.js.map +1 -0
  107. package/dist/server/auth/providers/workos.d.ts +10 -0
  108. package/dist/server/auth/providers/workos.js +16 -0
  109. package/dist/server/auth/providers/workos.js.map +1 -0
  110. package/dist/server/auth/providers/workos.test.js +41 -0
  111. package/dist/server/auth/providers/workos.test.js.map +1 -0
  112. package/dist/server/auth/setup.d.ts +4 -0
  113. package/dist/server/auth/setup.js +51 -0
  114. package/dist/server/auth/setup.js.map +1 -0
  115. package/dist/server/auth/setup.test.js +185 -0
  116. package/dist/server/auth/setup.test.js.map +1 -0
  117. package/dist/server/auth/verify.d.ts +11 -0
  118. package/dist/server/auth/verify.js +37 -0
  119. package/dist/server/auth/verify.js.map +1 -0
  120. package/dist/server/auth/verify.test.js +87 -0
  121. package/dist/server/auth/verify.test.js.map +1 -0
  122. package/dist/server/auth.d.ts +20 -0
  123. package/dist/server/auth.js +28 -0
  124. package/dist/server/auth.js.map +1 -0
  125. package/dist/server/build-manifest.test.js +27 -0
  126. package/dist/server/build-manifest.test.js.map +1 -0
  127. package/dist/server/content-helpers.d.ts +67 -0
  128. package/dist/server/content-helpers.js +79 -0
  129. package/dist/server/content-helpers.js.map +1 -0
  130. package/dist/server/content-helpers.test.js +70 -0
  131. package/dist/server/content-helpers.test.js.map +1 -0
  132. package/dist/server/express.d.ts +11 -0
  133. package/dist/server/express.js +101 -0
  134. package/dist/server/express.js.map +1 -0
  135. package/dist/server/express.test.js +491 -0
  136. package/dist/server/express.test.js.map +1 -0
  137. package/dist/server/file-ref.d.ts +28 -0
  138. package/dist/server/file-ref.js +27 -0
  139. package/dist/server/file-ref.js.map +1 -0
  140. package/dist/server/index.d.ts +13 -0
  141. package/dist/server/index.js +10 -0
  142. package/dist/server/index.js.map +1 -0
  143. package/dist/{src/server → server}/inferUtilityTypes.d.ts +6 -6
  144. package/dist/server/inferUtilityTypes.js.map +1 -0
  145. package/dist/server/metric.d.ts +14 -0
  146. package/dist/server/metric.js +62 -0
  147. package/dist/server/metric.js.map +1 -0
  148. package/dist/server/middleware.d.ts +137 -0
  149. package/dist/server/middleware.js +93 -0
  150. package/dist/server/middleware.js.map +1 -0
  151. package/dist/server/middleware.test-d.js +75 -0
  152. package/dist/server/middleware.test-d.js.map +1 -0
  153. package/dist/server/middleware.test.js +493 -0
  154. package/dist/server/middleware.test.js.map +1 -0
  155. package/dist/server/requestOrigin.d.ts +7 -0
  156. package/dist/server/requestOrigin.js +25 -0
  157. package/dist/server/requestOrigin.js.map +1 -0
  158. package/dist/server/server.d.ts +403 -0
  159. package/dist/server/server.js +641 -0
  160. package/dist/server/server.js.map +1 -0
  161. package/dist/{src/server → server}/templateHelper.d.ts +5 -7
  162. package/dist/server/templateHelper.js +11 -0
  163. package/dist/server/templateHelper.js.map +1 -0
  164. package/dist/server/templates.generated.d.ts +4 -0
  165. package/dist/server/templates.generated.js +47 -0
  166. package/dist/server/templates.generated.js.map +1 -0
  167. package/dist/server/tunnel-proxy-router.d.ts +7 -0
  168. package/dist/server/tunnel-proxy-router.js +110 -0
  169. package/dist/server/tunnel-proxy-router.js.map +1 -0
  170. package/dist/server/tunnel-proxy-router.test.js +229 -0
  171. package/dist/server/tunnel-proxy-router.test.js.map +1 -0
  172. package/dist/server/view-resource-resolution.test.d.ts +6 -0
  173. package/dist/server/view-resource-resolution.test.js +88 -0
  174. package/dist/server/view-resource-resolution.test.js.map +1 -0
  175. package/dist/server/viewsDevServer.d.ts +14 -0
  176. package/dist/server/viewsDevServer.js +45 -0
  177. package/dist/server/viewsDevServer.js.map +1 -0
  178. package/dist/{src/test → test}/utils.d.ts +13 -21
  179. package/dist/{src/test → test}/utils.js +42 -37
  180. package/dist/test/utils.js.map +1 -0
  181. package/dist/test/view.test.js +568 -0
  182. package/dist/test/view.test.js.map +1 -0
  183. package/dist/version.d.ts +1 -0
  184. package/dist/version.js +3 -0
  185. package/dist/version.js.map +1 -0
  186. package/dist/web/bridges/apps-sdk/adaptor.d.ts +29 -0
  187. package/dist/web/bridges/apps-sdk/adaptor.js +117 -0
  188. package/dist/web/bridges/apps-sdk/adaptor.js.map +1 -0
  189. package/dist/web/bridges/apps-sdk/bridge.d.ts +11 -0
  190. package/dist/{src/web/bridges/apps-sdk-bridge.js → web/bridges/apps-sdk/bridge.js} +3 -2
  191. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -0
  192. package/dist/web/bridges/apps-sdk/index.d.ts +5 -0
  193. package/dist/web/bridges/apps-sdk/index.js +5 -0
  194. package/dist/web/bridges/apps-sdk/index.js.map +1 -0
  195. package/dist/web/bridges/apps-sdk/types.d.ts +133 -0
  196. package/dist/{src/web → web/bridges/apps-sdk}/types.js +0 -1
  197. package/dist/web/bridges/apps-sdk/types.js.map +1 -0
  198. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +13 -0
  199. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +18 -0
  200. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -0
  201. package/dist/web/bridges/get-adaptor.d.ts +9 -0
  202. package/dist/web/bridges/get-adaptor.js +15 -0
  203. package/dist/web/bridges/get-adaptor.js.map +1 -0
  204. package/dist/web/bridges/index.d.ts +5 -0
  205. package/dist/web/bridges/index.js +6 -0
  206. package/dist/web/bridges/index.js.map +1 -0
  207. package/dist/web/bridges/mcp-app/adaptor.d.ts +53 -0
  208. package/dist/web/bridges/mcp-app/adaptor.js +283 -0
  209. package/dist/web/bridges/mcp-app/adaptor.js.map +1 -0
  210. package/dist/web/bridges/mcp-app/bridge.d.ts +28 -0
  211. package/dist/web/bridges/mcp-app/bridge.js +124 -0
  212. package/dist/web/bridges/mcp-app/bridge.js.map +1 -0
  213. package/dist/web/bridges/mcp-app/index.d.ts +4 -0
  214. package/dist/web/bridges/mcp-app/index.js +4 -0
  215. package/dist/web/bridges/mcp-app/index.js.map +1 -0
  216. package/dist/web/bridges/mcp-app/types.d.ts +8 -0
  217. package/dist/web/bridges/mcp-app/types.js +2 -0
  218. package/dist/web/bridges/mcp-app/types.js.map +1 -0
  219. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +19 -0
  220. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +19 -0
  221. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -0
  222. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js +26 -0
  223. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -0
  224. package/dist/web/bridges/mcp-app/view-tools.test.d.ts +1 -0
  225. package/dist/web/bridges/mcp-app/view-tools.test.js +144 -0
  226. package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -0
  227. package/dist/web/bridges/types.d.ts +204 -0
  228. package/dist/web/bridges/types.js +2 -0
  229. package/dist/web/bridges/types.js.map +1 -0
  230. package/dist/web/bridges/use-host-context.d.ts +7 -0
  231. package/dist/web/bridges/use-host-context.js +13 -0
  232. package/dist/web/bridges/use-host-context.js.map +1 -0
  233. package/dist/web/components/modal-provider.d.ts +4 -0
  234. package/dist/web/components/modal-provider.js +45 -0
  235. package/dist/web/components/modal-provider.js.map +1 -0
  236. package/dist/web/create-store.d.ts +29 -0
  237. package/dist/web/create-store.js +64 -0
  238. package/dist/web/create-store.js.map +1 -0
  239. package/dist/web/create-store.test.d.ts +1 -0
  240. package/dist/web/create-store.test.js +129 -0
  241. package/dist/web/create-store.test.js.map +1 -0
  242. package/dist/web/data-llm.d.ts +47 -0
  243. package/dist/{src/web → web}/data-llm.js +35 -5
  244. package/dist/web/data-llm.js.map +1 -0
  245. package/dist/web/data-llm.test.d.ts +1 -0
  246. package/dist/web/data-llm.test.js +142 -0
  247. package/dist/web/data-llm.test.js.map +1 -0
  248. package/dist/{src/web → web}/generate-helpers.d.ts +24 -19
  249. package/dist/{src/web → web}/generate-helpers.js +22 -18
  250. package/dist/web/generate-helpers.js.map +1 -0
  251. package/dist/web/generate-helpers.test-d.d.ts +1 -0
  252. package/dist/{src/web → web}/generate-helpers.test-d.js +30 -28
  253. package/dist/web/generate-helpers.test-d.js.map +1 -0
  254. package/dist/web/generate-helpers.test.d.ts +1 -0
  255. package/dist/web/generate-helpers.test.js.map +1 -0
  256. package/dist/{src/web → web}/helpers/state.d.ts +2 -2
  257. package/dist/web/helpers/state.js +45 -0
  258. package/dist/web/helpers/state.js.map +1 -0
  259. package/dist/web/helpers/state.test.d.ts +1 -0
  260. package/dist/{src/web → web}/helpers/state.test.js +9 -9
  261. package/dist/web/helpers/state.test.js.map +1 -0
  262. package/dist/{src/web → web}/hooks/index.d.ts +7 -3
  263. package/dist/{src/web → web}/hooks/index.js +6 -2
  264. package/dist/web/hooks/index.js.map +1 -0
  265. package/dist/web/hooks/test/utils.d.ts +20 -0
  266. package/dist/web/hooks/test/utils.js +75 -0
  267. package/dist/web/hooks/test/utils.js.map +1 -0
  268. package/dist/{src/web → web}/hooks/use-call-tool.d.ts +47 -1
  269. package/dist/{src/web → web}/hooks/use-call-tool.js +30 -2
  270. package/dist/web/hooks/use-call-tool.js.map +1 -0
  271. package/dist/web/hooks/use-call-tool.test-d.d.ts +1 -0
  272. package/dist/web/hooks/use-call-tool.test-d.js.map +1 -0
  273. package/dist/web/hooks/use-call-tool.test.d.ts +1 -0
  274. package/dist/{src/web → web}/hooks/use-call-tool.test.js +26 -6
  275. package/dist/web/hooks/use-call-tool.test.js.map +1 -0
  276. package/dist/web/hooks/use-display-mode.d.ts +24 -0
  277. package/dist/web/hooks/use-display-mode.js +29 -0
  278. package/dist/web/hooks/use-display-mode.js.map +1 -0
  279. package/dist/web/hooks/use-display-mode.test-d.d.ts +1 -0
  280. package/dist/web/hooks/use-display-mode.test-d.js +8 -0
  281. package/dist/web/hooks/use-display-mode.test-d.js.map +1 -0
  282. package/dist/web/hooks/use-display-mode.test.d.ts +1 -0
  283. package/dist/web/hooks/use-display-mode.test.js.map +1 -0
  284. package/dist/web/hooks/use-download.d.ts +5 -0
  285. package/dist/web/hooks/use-download.js +8 -0
  286. package/dist/web/hooks/use-download.js.map +1 -0
  287. package/dist/web/hooks/use-download.test.d.ts +1 -0
  288. package/dist/web/hooks/use-download.test.js +95 -0
  289. package/dist/web/hooks/use-download.test.js.map +1 -0
  290. package/dist/web/hooks/use-files.d.ts +39 -0
  291. package/dist/web/hooks/use-files.js +42 -0
  292. package/dist/web/hooks/use-files.js.map +1 -0
  293. package/dist/web/hooks/use-files.test.d.ts +1 -0
  294. package/dist/web/hooks/use-files.test.js +54 -0
  295. package/dist/web/hooks/use-files.test.js.map +1 -0
  296. package/dist/{src/web → web}/hooks/use-layout.d.ts +4 -2
  297. package/dist/{src/web → web}/hooks/use-layout.js +6 -4
  298. package/dist/web/hooks/use-layout.js.map +1 -0
  299. package/dist/web/hooks/use-layout.test.d.ts +1 -0
  300. package/dist/{src/web → web}/hooks/use-layout.test.js +7 -6
  301. package/dist/web/hooks/use-layout.test.js.map +1 -0
  302. package/dist/web/hooks/use-open-external.d.ts +20 -0
  303. package/dist/web/hooks/use-open-external.js +24 -0
  304. package/dist/web/hooks/use-open-external.js.map +1 -0
  305. package/dist/web/hooks/use-open-external.test.d.ts +1 -0
  306. package/dist/{src/web → web}/hooks/use-open-external.test.js +27 -12
  307. package/dist/web/hooks/use-open-external.test.js.map +1 -0
  308. package/dist/web/hooks/use-register-view-tool.d.ts +38 -0
  309. package/dist/web/hooks/use-register-view-tool.js +50 -0
  310. package/dist/web/hooks/use-register-view-tool.js.map +1 -0
  311. package/dist/web/hooks/use-request-close.d.ts +16 -0
  312. package/dist/web/hooks/use-request-close.js +21 -0
  313. package/dist/web/hooks/use-request-close.js.map +1 -0
  314. package/dist/web/hooks/use-request-close.test.d.ts +1 -0
  315. package/dist/web/hooks/use-request-close.test.js +52 -0
  316. package/dist/web/hooks/use-request-close.test.js.map +1 -0
  317. package/dist/web/hooks/use-request-modal.d.ts +24 -0
  318. package/dist/web/hooks/use-request-modal.js +31 -0
  319. package/dist/web/hooks/use-request-modal.js.map +1 -0
  320. package/dist/web/hooks/use-request-modal.test.d.ts +1 -0
  321. package/dist/{src/web → web}/hooks/use-request-modal.test.js +5 -1
  322. package/dist/web/hooks/use-request-modal.test.js.map +1 -0
  323. package/dist/web/hooks/use-request-size.d.ts +20 -0
  324. package/dist/web/hooks/use-request-size.js +24 -0
  325. package/dist/web/hooks/use-request-size.js.map +1 -0
  326. package/dist/web/hooks/use-request-size.test.d.ts +1 -0
  327. package/dist/web/hooks/use-request-size.test.js +65 -0
  328. package/dist/web/hooks/use-request-size.test.js.map +1 -0
  329. package/dist/web/hooks/use-send-follow-up-message.d.ts +19 -0
  330. package/dist/web/hooks/use-send-follow-up-message.js +25 -0
  331. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -0
  332. package/dist/web/hooks/use-set-open-in-app-url.d.ts +18 -0
  333. package/dist/web/hooks/use-set-open-in-app-url.js +25 -0
  334. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -0
  335. package/dist/web/hooks/use-set-open-in-app-url.test.d.ts +1 -0
  336. package/dist/web/hooks/use-set-open-in-app-url.test.js +43 -0
  337. package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -0
  338. package/dist/web/hooks/use-tool-info.d.ts +87 -0
  339. package/dist/web/hooks/use-tool-info.js +49 -0
  340. package/dist/web/hooks/use-tool-info.js.map +1 -0
  341. package/dist/web/hooks/use-tool-info.test-d.d.ts +1 -0
  342. package/dist/{src/web → web}/hooks/use-tool-info.test-d.js +11 -29
  343. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -0
  344. package/dist/web/hooks/use-tool-info.test.d.ts +1 -0
  345. package/dist/{src/web → web}/hooks/use-tool-info.test.js +10 -10
  346. package/dist/web/hooks/use-tool-info.test.js.map +1 -0
  347. package/dist/{src/web → web}/hooks/use-user.d.ts +3 -1
  348. package/dist/web/hooks/use-user.js +37 -0
  349. package/dist/web/hooks/use-user.js.map +1 -0
  350. package/dist/web/hooks/use-user.test.d.ts +1 -0
  351. package/dist/{src/web → web}/hooks/use-user.test.js +33 -4
  352. package/dist/web/hooks/use-user.test.js.map +1 -0
  353. package/dist/web/hooks/use-view-state.d.ts +25 -0
  354. package/dist/web/hooks/use-view-state.js +32 -0
  355. package/dist/web/hooks/use-view-state.js.map +1 -0
  356. package/dist/web/hooks/use-view-state.test.d.ts +1 -0
  357. package/dist/web/hooks/use-view-state.test.js +177 -0
  358. package/dist/web/hooks/use-view-state.test.js.map +1 -0
  359. package/dist/{src/web → web}/index.d.ts +1 -2
  360. package/dist/{src/web → web}/index.js +1 -2
  361. package/dist/web/index.js.map +1 -0
  362. package/dist/web/mount-view.d.ts +20 -0
  363. package/dist/web/mount-view.js +46 -0
  364. package/dist/web/mount-view.js.map +1 -0
  365. package/dist/web/plugin/data-llm.test.d.ts +1 -0
  366. package/dist/web/plugin/data-llm.test.js.map +1 -0
  367. package/dist/web/plugin/plugin.d.ts +33 -0
  368. package/dist/web/plugin/plugin.js +189 -0
  369. package/dist/web/plugin/plugin.js.map +1 -0
  370. package/dist/web/plugin/scan-views.d.ts +16 -0
  371. package/dist/web/plugin/scan-views.js +88 -0
  372. package/dist/web/plugin/scan-views.js.map +1 -0
  373. package/dist/web/plugin/scan-views.test.d.ts +1 -0
  374. package/dist/web/plugin/scan-views.test.js +99 -0
  375. package/dist/web/plugin/scan-views.test.js.map +1 -0
  376. package/dist/{src/web → web}/plugin/transform-data-llm.js +1 -1
  377. package/dist/web/plugin/transform-data-llm.js.map +1 -0
  378. package/dist/web/plugin/transform-data-llm.test.d.ts +1 -0
  379. package/dist/web/plugin/transform-data-llm.test.js.map +1 -0
  380. package/dist/web/plugin/validate-view.d.ts +1 -0
  381. package/dist/web/plugin/validate-view.js +9 -0
  382. package/dist/web/plugin/validate-view.js.map +1 -0
  383. package/dist/web/plugin/validate-view.test.d.ts +1 -0
  384. package/dist/web/plugin/validate-view.test.js +24 -0
  385. package/dist/web/plugin/validate-view.test.js.map +1 -0
  386. package/dist/{src/web → web}/proxy.js +0 -1
  387. package/dist/web/proxy.js.map +1 -0
  388. package/dist/web/types.d.ts +20 -0
  389. package/dist/web/types.js +2 -0
  390. package/dist/web/types.js.map +1 -0
  391. package/package.json +76 -33
  392. package/tsconfig.base.json +33 -0
  393. package/dist/src/server/devtoolsStaticServer.d.ts +0 -19
  394. package/dist/src/server/devtoolsStaticServer.js +0 -48
  395. package/dist/src/server/devtoolsStaticServer.js.map +0 -1
  396. package/dist/src/server/index.d.ts +0 -5
  397. package/dist/src/server/index.js +0 -4
  398. package/dist/src/server/index.js.map +0 -1
  399. package/dist/src/server/inferUtilityTypes.js.map +0 -1
  400. package/dist/src/server/server.d.ts +0 -74
  401. package/dist/src/server/server.js +0 -82
  402. package/dist/src/server/server.js.map +0 -1
  403. package/dist/src/server/templateHelper.js +0 -30
  404. package/dist/src/server/templateHelper.js.map +0 -1
  405. package/dist/src/server/templates/development.hbs +0 -13
  406. package/dist/src/server/templates/production.hbs +0 -7
  407. package/dist/src/server/widgetsDevServer.d.ts +0 -12
  408. package/dist/src/server/widgetsDevServer.js +0 -38
  409. package/dist/src/server/widgetsDevServer.js.map +0 -1
  410. package/dist/src/test/utils.js.map +0 -1
  411. package/dist/src/test/widget.test.js +0 -146
  412. package/dist/src/test/widget.test.js.map +0 -1
  413. package/dist/src/web/bridges/adaptors/apps-sdk-adaptor.d.ts +0 -13
  414. package/dist/src/web/bridges/adaptors/apps-sdk-adaptor.js +0 -33
  415. package/dist/src/web/bridges/adaptors/apps-sdk-adaptor.js.map +0 -1
  416. package/dist/src/web/bridges/adaptors/mcp-app-adaptor.d.ts +0 -16
  417. package/dist/src/web/bridges/adaptors/mcp-app-adaptor.js +0 -115
  418. package/dist/src/web/bridges/adaptors/mcp-app-adaptor.js.map +0 -1
  419. package/dist/src/web/bridges/apps-sdk-bridge.d.ts +0 -10
  420. package/dist/src/web/bridges/apps-sdk-bridge.js.map +0 -1
  421. package/dist/src/web/bridges/hooks/use-adaptor.d.ts +0 -2
  422. package/dist/src/web/bridges/hooks/use-adaptor.js +0 -8
  423. package/dist/src/web/bridges/hooks/use-adaptor.js.map +0 -1
  424. package/dist/src/web/bridges/hooks/use-apps-sdk-bridge.d.ts +0 -2
  425. package/dist/src/web/bridges/hooks/use-apps-sdk-bridge.js +0 -7
  426. package/dist/src/web/bridges/hooks/use-apps-sdk-bridge.js.map +0 -1
  427. package/dist/src/web/bridges/hooks/use-bridge.d.ts +0 -2
  428. package/dist/src/web/bridges/hooks/use-bridge.js +0 -8
  429. package/dist/src/web/bridges/hooks/use-bridge.js.map +0 -1
  430. package/dist/src/web/bridges/hooks/use-mcp-app-bridge.d.ts +0 -5
  431. package/dist/src/web/bridges/hooks/use-mcp-app-bridge.js +0 -7
  432. package/dist/src/web/bridges/hooks/use-mcp-app-bridge.js.map +0 -1
  433. package/dist/src/web/bridges/hooks/use-mcp-app-bridge.test.js +0 -41
  434. package/dist/src/web/bridges/hooks/use-mcp-app-bridge.test.js.map +0 -1
  435. package/dist/src/web/bridges/index.d.ts +0 -4
  436. package/dist/src/web/bridges/index.js +0 -5
  437. package/dist/src/web/bridges/index.js.map +0 -1
  438. package/dist/src/web/bridges/mcp-app-bridge.d.ts +0 -38
  439. package/dist/src/web/bridges/mcp-app-bridge.js +0 -162
  440. package/dist/src/web/bridges/mcp-app-bridge.js.map +0 -1
  441. package/dist/src/web/bridges/types.d.ts +0 -57
  442. package/dist/src/web/bridges/types.js.map +0 -1
  443. package/dist/src/web/create-store.d.ts +0 -3
  444. package/dist/src/web/create-store.js +0 -25
  445. package/dist/src/web/create-store.js.map +0 -1
  446. package/dist/src/web/create-store.test.js +0 -70
  447. package/dist/src/web/create-store.test.js.map +0 -1
  448. package/dist/src/web/data-llm.d.ts +0 -14
  449. package/dist/src/web/data-llm.js.map +0 -1
  450. package/dist/src/web/data-llm.test.js +0 -76
  451. package/dist/src/web/data-llm.test.js.map +0 -1
  452. package/dist/src/web/generate-helpers.js.map +0 -1
  453. package/dist/src/web/generate-helpers.test-d.js.map +0 -1
  454. package/dist/src/web/generate-helpers.test.js.map +0 -1
  455. package/dist/src/web/helpers/state.js +0 -40
  456. package/dist/src/web/helpers/state.js.map +0 -1
  457. package/dist/src/web/helpers/state.test.js.map +0 -1
  458. package/dist/src/web/hooks/index.js.map +0 -1
  459. package/dist/src/web/hooks/test/utils.d.ts +0 -10
  460. package/dist/src/web/hooks/test/utils.js +0 -40
  461. package/dist/src/web/hooks/test/utils.js.map +0 -1
  462. package/dist/src/web/hooks/use-call-tool.js.map +0 -1
  463. package/dist/src/web/hooks/use-call-tool.test-d.js.map +0 -1
  464. package/dist/src/web/hooks/use-call-tool.test.js.map +0 -1
  465. package/dist/src/web/hooks/use-display-mode.d.ts +0 -4
  466. package/dist/src/web/hooks/use-display-mode.js +0 -10
  467. package/dist/src/web/hooks/use-display-mode.js.map +0 -1
  468. package/dist/src/web/hooks/use-display-mode.test.js.map +0 -1
  469. package/dist/src/web/hooks/use-files.d.ts +0 -10
  470. package/dist/src/web/hooks/use-files.js +0 -7
  471. package/dist/src/web/hooks/use-files.js.map +0 -1
  472. package/dist/src/web/hooks/use-files.test.js +0 -29
  473. package/dist/src/web/hooks/use-files.test.js.map +0 -1
  474. package/dist/src/web/hooks/use-layout.js.map +0 -1
  475. package/dist/src/web/hooks/use-layout.test.js.map +0 -1
  476. package/dist/src/web/hooks/use-open-external.d.ts +0 -1
  477. package/dist/src/web/hooks/use-open-external.js +0 -8
  478. package/dist/src/web/hooks/use-open-external.js.map +0 -1
  479. package/dist/src/web/hooks/use-open-external.test.js.map +0 -1
  480. package/dist/src/web/hooks/use-openai-global.d.ts +0 -3
  481. package/dist/src/web/hooks/use-openai-global.js +0 -6
  482. package/dist/src/web/hooks/use-openai-global.js.map +0 -1
  483. package/dist/src/web/hooks/use-request-modal.d.ts +0 -9
  484. package/dist/src/web/hooks/use-request-modal.js +0 -14
  485. package/dist/src/web/hooks/use-request-modal.js.map +0 -1
  486. package/dist/src/web/hooks/use-request-modal.test.js.map +0 -1
  487. package/dist/src/web/hooks/use-send-follow-up-message.d.ts +0 -1
  488. package/dist/src/web/hooks/use-send-follow-up-message.js +0 -8
  489. package/dist/src/web/hooks/use-send-follow-up-message.js.map +0 -1
  490. package/dist/src/web/hooks/use-tool-info.d.ts +0 -36
  491. package/dist/src/web/hooks/use-tool-info.js +0 -26
  492. package/dist/src/web/hooks/use-tool-info.js.map +0 -1
  493. package/dist/src/web/hooks/use-tool-info.test-d.js.map +0 -1
  494. package/dist/src/web/hooks/use-tool-info.test.js.map +0 -1
  495. package/dist/src/web/hooks/use-user.js +0 -19
  496. package/dist/src/web/hooks/use-user.js.map +0 -1
  497. package/dist/src/web/hooks/use-user.test.js.map +0 -1
  498. package/dist/src/web/hooks/use-widget-state.d.ts +0 -4
  499. package/dist/src/web/hooks/use-widget-state.js +0 -32
  500. package/dist/src/web/hooks/use-widget-state.js.map +0 -1
  501. package/dist/src/web/hooks/use-widget-state.test.js +0 -61
  502. package/dist/src/web/hooks/use-widget-state.test.js.map +0 -1
  503. package/dist/src/web/index.js.map +0 -1
  504. package/dist/src/web/mount-widget.d.ts +0 -1
  505. package/dist/src/web/mount-widget.js +0 -19
  506. package/dist/src/web/mount-widget.js.map +0 -1
  507. package/dist/src/web/plugin/data-llm.test.js.map +0 -1
  508. package/dist/src/web/plugin/plugin.d.ts +0 -2
  509. package/dist/src/web/plugin/plugin.js +0 -39
  510. package/dist/src/web/plugin/plugin.js.map +0 -1
  511. package/dist/src/web/plugin/transform-data-llm.js.map +0 -1
  512. package/dist/src/web/plugin/transform-data-llm.test.js.map +0 -1
  513. package/dist/src/web/proxy.js.map +0 -1
  514. package/dist/src/web/types.d.ts +0 -149
  515. package/dist/src/web/types.js.map +0 -1
  516. package/dist/vitest.config.d.ts +0 -2
  517. package/dist/vitest.config.js +0 -8
  518. package/dist/vitest.config.js.map +0 -1
  519. /package/dist/{src/test/widget.test.d.ts → cli/build-helpers.test.d.ts} +0 -0
  520. /package/dist/{src/web/bridges/hooks/use-mcp-app-bridge.test.d.ts → cli/tunnel-control-server.test.d.ts} +0 -0
  521. /package/dist/{src/web/create-store.test.d.ts → cli/tunnel-handler.test.d.ts} +0 -0
  522. /package/dist/{src/web/data-llm.test.d.ts → cli/tunnel.test.d.ts} +0 -0
  523. /package/dist/{src/web/bridges → cli}/types.js +0 -0
  524. /package/dist/{src/web/generate-helpers.test-d.d.ts → server/asset-base-url-transform-plugin.test.d.ts} +0 -0
  525. /package/dist/{src/web/generate-helpers.test.d.ts → server/auth/discovery.test.d.ts} +0 -0
  526. /package/dist/{src/web/helpers/state.test.d.ts → server/auth/providers/custom.test.d.ts} +0 -0
  527. /package/dist/{src/web/hooks/use-call-tool.test-d.d.ts → server/auth/providers/descope.test.d.ts} +0 -0
  528. /package/dist/{src/web/hooks/use-call-tool.test.d.ts → server/auth/providers/stytch.test.d.ts} +0 -0
  529. /package/dist/{src/web/hooks/use-display-mode.test.d.ts → server/auth/providers/workos.test.d.ts} +0 -0
  530. /package/dist/{src/web/hooks/use-files.test.d.ts → server/auth/setup.test.d.ts} +0 -0
  531. /package/dist/{src/web/hooks/use-layout.test.d.ts → server/auth/verify.test.d.ts} +0 -0
  532. /package/dist/{src/web/hooks/use-open-external.test.d.ts → server/build-manifest.test.d.ts} +0 -0
  533. /package/dist/{src/web/hooks/use-request-modal.test.d.ts → server/content-helpers.test.d.ts} +0 -0
  534. /package/dist/{src/web/hooks/use-tool-info.test-d.d.ts → server/express.test.d.ts} +0 -0
  535. /package/dist/{src/server → server}/inferUtilityTypes.js +0 -0
  536. /package/dist/{src/web/hooks/use-tool-info.test.d.ts → server/middleware.test-d.d.ts} +0 -0
  537. /package/dist/{src/web/hooks/use-user.test.d.ts → server/middleware.test.d.ts} +0 -0
  538. /package/dist/{src/web/hooks/use-widget-state.test.d.ts → server/tunnel-proxy-router.test.d.ts} +0 -0
  539. /package/dist/{src/web/plugin/data-llm.test.d.ts → test/view.test.d.ts} +0 -0
  540. /package/dist/{src/web/plugin/transform-data-llm.test.d.ts → web/bridges/mcp-app/use-mcp-app-context.test.d.ts} +0 -0
  541. /package/dist/{src/web → web}/generate-helpers.test.js +0 -0
  542. /package/dist/{src/web → web}/hooks/use-call-tool.test-d.js +0 -0
  543. /package/dist/{src/web → web}/hooks/use-display-mode.test.js +0 -0
  544. /package/dist/{src/web → web}/plugin/data-llm.test.js +0 -0
  545. /package/dist/{src/web → web}/plugin/transform-data-llm.d.ts +0 -0
  546. /package/dist/{src/web → web}/plugin/transform-data-llm.test.js +0 -0
  547. /package/dist/{src/web → web}/proxy.d.ts +0 -0
@@ -0,0 +1,54 @@
1
+ import { renderHook } from "@testing-library/react";
2
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
3
+ import { AppsSdkAdaptor } from "../bridges/apps-sdk/adaptor.js";
4
+ import { useFiles } from "./use-files.js";
5
+ describe("useFiles", () => {
6
+ const OpenaiMock = {
7
+ uploadFile: vi.fn().mockResolvedValue({
8
+ fileId: `sediment://file_abc123`,
9
+ }),
10
+ getFileDownloadUrl: vi.fn(),
11
+ widgetState: null,
12
+ setWidgetState: vi.fn(),
13
+ };
14
+ beforeEach(() => {
15
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
16
+ vi.stubGlobal("openai", OpenaiMock);
17
+ });
18
+ afterEach(() => {
19
+ vi.unstubAllGlobals();
20
+ vi.clearAllMocks();
21
+ AppsSdkAdaptor.resetInstance();
22
+ });
23
+ const dummyFile = new File([], "test.txt");
24
+ it("should upload a file to ChatGPT", () => {
25
+ const { result } = renderHook(() => useFiles());
26
+ result.current.upload(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;
46
+ });
47
+ it("should download a file from ChatGPT", () => {
48
+ const fileId = "123";
49
+ const { result } = renderHook(() => useFiles());
50
+ result.current.getDownloadUrl({ fileId });
51
+ expect(OpenaiMock.getFileDownloadUrl).toHaveBeenCalledWith({ fileId });
52
+ });
53
+ });
54
+ //# sourceMappingURL=use-files.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-files.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-files.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,MAAM,UAAU,GAA4B;QAC1C,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;YACpC,MAAM,EAAE,wBAAwB;SACjC,CAAC;QACF,kBAAkB,EAAE,EAAE,CAAC,EAAE,EAAE;QAC3B,WAAW,EAAE,IAAI;QACjB,cAAc,EAAE,EAAE,CAAC,EAAE,EAAE;KACxB,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACrD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACnB,cAAc,CAAC,aAAa,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IAE3C,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACjC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACpD,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE;YAC5D,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,aAAa,GAAG;YACpB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,EAAE;SACvE,CAAC;QACF,UAAU,CAAC,WAAW,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAElE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QACjD,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,gBAAgB,EAAE,CAAC;QAClD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAErC,OAAO,UAAU,CAAC,WAAW,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,MAAM,GAAG,KAAK,CAAC;QACrB,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC1C,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","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
@@ -0,0 +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;;;;;;;;;;;;;;;;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"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -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
  });
@@ -0,0 +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,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"]}
@@ -0,0 +1,20 @@
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;
@@ -0,0 +1,24 @@
1
+ import { useCallback } from "react";
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
+ */
19
+ export function useOpenExternal() {
20
+ const adaptor = getAdaptor();
21
+ const openExternal = useCallback((href, options) => adaptor.openExternal(href, options), [adaptor]);
22
+ return openExternal;
23
+ }
24
+ //# sourceMappingURL=use-open-external.js.map
@@ -0,0 +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;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"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -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
  });
@@ -0,0 +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,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 {};
@@ -0,0 +1,52 @@
1
+ import { renderHook, waitFor } from "@testing-library/react";
2
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
3
+ import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
4
+ import { getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
5
+ import { useRequestClose } from "./use-request-close.js";
6
+ describe("useRequestClose", () => {
7
+ describe("apps-sdk host", () => {
8
+ let requestCloseMock;
9
+ beforeEach(() => {
10
+ requestCloseMock = vi.fn().mockResolvedValue(undefined);
11
+ vi.stubGlobal("openai", {
12
+ requestClose: requestCloseMock,
13
+ });
14
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
15
+ });
16
+ afterEach(() => {
17
+ vi.unstubAllGlobals();
18
+ vi.resetAllMocks();
19
+ });
20
+ it("should return a function that calls window.openai.requestClose", async () => {
21
+ const { result } = renderHook(() => useRequestClose());
22
+ await result.current();
23
+ expect(requestCloseMock).toHaveBeenCalledTimes(1);
24
+ expect(requestCloseMock).toHaveBeenCalledWith();
25
+ });
26
+ });
27
+ describe("mcp-app host", () => {
28
+ let postMessageMock;
29
+ beforeEach(() => {
30
+ vi.stubGlobal("skybridge", { hostType: "mcp-app" });
31
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
32
+ postMessageMock = getMcpAppHostPostMessageMock();
33
+ vi.stubGlobal("parent", { postMessage: postMessageMock });
34
+ });
35
+ afterEach(async () => {
36
+ vi.unstubAllGlobals();
37
+ vi.resetAllMocks();
38
+ McpAppBridge.resetInstance();
39
+ });
40
+ it("should send a ui/notifications/request-teardown notification to the MCP host", async () => {
41
+ const { result } = renderHook(() => useRequestClose());
42
+ await result.current();
43
+ await waitFor(() => {
44
+ expect(postMessageMock).toHaveBeenCalledWith(expect.objectContaining({
45
+ jsonrpc: "2.0",
46
+ method: "ui/notifications/request-teardown",
47
+ }), "*");
48
+ });
49
+ });
50
+ });
51
+ });
52
+ //# 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,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,iBAAiB,CAAC,SAAS,CAAC,CAAC;YACxD,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,gEAAgE,EAAE,KAAK,IAAI,EAAE;YAC9E,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;YAEvD,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;YAEvB,MAAM,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,EAAE,CAAC;QAClD,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,8EAA8E,EAAE,KAAK,IAAI,EAAE;YAC5F,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;YAEvD,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;YAEvB,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAC1C,MAAM,CAAC,gBAAgB,CAAC;oBACtB,OAAO,EAAE,KAAK;oBACd,MAAM,EAAE,mCAAmC;iBAC5C,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 { useRequestClose } from \"./use-request-close.js\";\n\ndescribe(\"useRequestClose\", () => {\n describe(\"apps-sdk host\", () => {\n let requestCloseMock: ReturnType<typeof vi.fn>;\n\n beforeEach(() => {\n requestCloseMock = vi.fn().mockResolvedValue(undefined);\n vi.stubGlobal(\"openai\", {\n requestClose: requestCloseMock,\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.requestClose\", async () => {\n const { result } = renderHook(() => useRequestClose());\n\n await result.current();\n\n expect(requestCloseMock).toHaveBeenCalledTimes(1);\n expect(requestCloseMock).toHaveBeenCalledWith();\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 send a ui/notifications/request-teardown notification to the MCP host\", async () => {\n const { result } = renderHook(() => useRequestClose());\n\n await result.current();\n\n await waitFor(() => {\n expect(postMessageMock).toHaveBeenCalledWith(\n expect.objectContaining({\n jsonrpc: \"2.0\",\n method: \"ui/notifications/request-teardown\",\n }),\n \"*\",\n );\n });\n });\n });\n});\n"]}
@@ -0,0 +1,24 @@
1
+ import { type RequestModalOptions } from "../bridges/index.js";
2
+ /**
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
19
+ */
20
+ export declare function useRequestModal(): {
21
+ isOpen: boolean;
22
+ params: Record<string, unknown> | undefined;
23
+ open: (opts: RequestModalOptions) => void;
24
+ };
@@ -0,0 +1,31 @@
1
+ import { useCallback } from "react";
2
+ import { getAdaptor, useHostContext, } from "../bridges/index.js";
3
+ /**
4
+ * Open the current view in a modal overlay (`displayMode === "modal"`).
5
+ *
6
+ * Returns `{ isOpen, params, open }`: `open(opts)` triggers the host to render
7
+ * the view in a modal, optionally passing `params` that are surfaced back via
8
+ * `params` here. Useful for confirmation flows, detail panels, or any modal
9
+ * lifecycle owned by the host.
10
+ *
11
+ * Use {@link useDisplayMode} for non-modal display modes.
12
+ *
13
+ * @example
14
+ * ```tsx
15
+ * const { isOpen, open } = useRequestModal();
16
+ * <button onClick={() => open({ params: { id: 42 } })}>Show details</button>
17
+ * ```
18
+ *
19
+ * @see https://docs.skybridge.tech/api-reference/use-request-modal
20
+ */
21
+ export function useRequestModal() {
22
+ const adaptor = getAdaptor();
23
+ const display = useHostContext("display");
24
+ const open = useCallback((opts) => adaptor.openModal(opts), [adaptor]);
25
+ return {
26
+ isOpen: display.mode === "modal",
27
+ params: display.params,
28
+ open,
29
+ };
30
+ }
31
+ //# sourceMappingURL=use-request-modal.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-request-modal.js","sourceRoot":"","sources":["../../../src/web/hooks/use-request-modal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EACL,UAAU,EAEV,cAAc,GACf,MAAM,qBAAqB,CAAC;AAE7B;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,eAAe;IAC7B,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,OAAO,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,WAAW,CACtB,CAAC,IAAyB,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,EACtD,CAAC,OAAO,CAAC,CACV,CAAC;IACF,OAAO;QACL,MAAM,EAAE,OAAO,CAAC,IAAI,KAAK,OAAO;QAChC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,IAAI;KACL,CAAC;AACJ,CAAC","sourcesContent":["import { useCallback } from \"react\";\nimport {\n getAdaptor,\n type RequestModalOptions,\n useHostContext,\n} from \"../bridges/index.js\";\n\n/**\n * Open the current view in a modal overlay (`displayMode === \"modal\"`).\n *\n * Returns `{ isOpen, params, open }`: `open(opts)` triggers the host to render\n * the view in a modal, optionally passing `params` that are surfaced back via\n * `params` here. Useful for confirmation flows, detail panels, or any modal\n * lifecycle owned by the host.\n *\n * Use {@link useDisplayMode} for non-modal display modes.\n *\n * @example\n * ```tsx\n * const { isOpen, open } = useRequestModal();\n * <button onClick={() => open({ params: { id: 42 } })}>Show details</button>\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-request-modal\n */\nexport function useRequestModal() {\n const adaptor = getAdaptor();\n const display = useHostContext(\"display\");\n const open = useCallback(\n (opts: RequestModalOptions) => adaptor.openModal(opts),\n [adaptor],\n );\n return {\n isOpen: display.mode === \"modal\",\n params: display.params,\n open,\n };\n}\n"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -48,7 +48,11 @@ describe("useRequestModal", () => {
48
48
  it("should call window.openai.requestModal with the options when open is called", () => {
49
49
  const { result } = renderHook(() => useRequestModal());
50
50
  const { open } = result.current;
51
- const options = { title: "Test Modal" };
51
+ const options = {
52
+ title: "Test Modal",
53
+ params: { foo: "bar" },
54
+ template: "ui://view/modal-template.html",
55
+ };
52
56
  open(options);
53
57
  expect(requestModalMock).toHaveBeenCalledTimes(1);
54
58
  expect(requestModalMock).toHaveBeenCalledWith(options);
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-request-modal.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-request-modal.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,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,IAAI,gBAA0C,CAAC;IAE/C,UAAU,CAAC,GAAG,EAAE;QACd,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3B,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACrD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,YAAY,EAAE,gBAAgB;YAC9B,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SACzB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+GAA+G,EAAE,GAAG,EAAE;QACvH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;QAEvD,MAAM,CAAC,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAEhD,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;QAChD,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,YAAY,EAAE,gBAAgB;YAC9B,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;SACxB,CAAC,CAAC;QAEH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;QACvD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;QAElC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,UAAU,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;QAC3C,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,YAAY,EAAE,gBAAgB;YAC9B,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;QACvD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;QAElC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE;QACrF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;QACvD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;QAEhC,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE;YACtB,QAAQ,EAAE,+BAA+B;SAC1C,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,CAAC;QAEd,MAAM,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAClD,MAAM,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { renderHook } from \"@testing-library/react\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { useRequestModal } from \"./use-request-modal.js\";\n\ndescribe(\"useRequestModal\", () => {\n let requestModalMock: ReturnType<typeof vi.fn>;\n\n beforeEach(() => {\n requestModalMock = vi.fn();\n vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n vi.stubGlobal(\"openai\", {\n requestModal: requestModalMock,\n view: { mode: \"inline\" },\n });\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n });\n\n it(\"should return an object with open, isOpen, and params properties where isOpen is false when mode is not modal\", () => {\n const { result } = renderHook(() => useRequestModal());\n\n expect(typeof result.current).toBe(\"object\");\n expect(result.current).toHaveProperty(\"open\");\n expect(result.current).toHaveProperty(\"isOpen\");\n expect(result.current).toHaveProperty(\"params\");\n\n const { open, isOpen, params } = result.current;\n expect(typeof open).toBe(\"function\");\n expect(isOpen).toBe(false);\n expect(params).toBeUndefined();\n });\n\n it(\"should return isOpen as true when mode is modal\", () => {\n vi.stubGlobal(\"openai\", {\n requestModal: requestModalMock,\n view: { mode: \"modal\" },\n });\n\n const { result } = renderHook(() => useRequestModal());\n const { isOpen } = result.current;\n\n expect(isOpen).toBe(true);\n });\n\n it(\"should return params from view when available\", () => {\n const testParams = { foo: \"bar\", baz: 42 };\n vi.stubGlobal(\"openai\", {\n requestModal: requestModalMock,\n view: { mode: \"modal\", params: testParams },\n });\n\n const { result } = renderHook(() => useRequestModal());\n const { params } = result.current;\n\n expect(params).toEqual(testParams);\n });\n\n it(\"should call window.openai.requestModal with the options when open is called\", () => {\n const { result } = renderHook(() => useRequestModal());\n const { open } = result.current;\n\n const options = {\n title: \"Test Modal\",\n params: { foo: \"bar\" },\n template: \"ui://view/modal-template.html\",\n };\n open(options);\n\n expect(requestModalMock).toHaveBeenCalledTimes(1);\n expect(requestModalMock).toHaveBeenCalledWith(options);\n });\n});\n"]}