skybridge 0.0.0-dev.fe84ef2 → 0.0.0-dev.fefabd5

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 (332) hide show
  1. package/LICENSE +21 -674
  2. package/README.md +82 -352
  3. package/bin/run.js +5 -0
  4. package/dist/cli/header.d.ts +4 -0
  5. package/dist/cli/header.js +6 -0
  6. package/dist/cli/header.js.map +1 -0
  7. package/dist/cli/run-command.d.ts +2 -0
  8. package/dist/cli/run-command.js +43 -0
  9. package/dist/cli/run-command.js.map +1 -0
  10. package/dist/cli/telemetry.d.ts +7 -0
  11. package/dist/cli/telemetry.js +123 -0
  12. package/dist/cli/telemetry.js.map +1 -0
  13. package/dist/cli/use-execute-steps.d.ts +11 -0
  14. package/dist/cli/use-execute-steps.js +36 -0
  15. package/dist/cli/use-execute-steps.js.map +1 -0
  16. package/dist/cli/use-nodemon.d.ts +6 -0
  17. package/dist/cli/use-nodemon.js +69 -0
  18. package/dist/cli/use-nodemon.js.map +1 -0
  19. package/dist/cli/use-typescript-check.d.ts +8 -0
  20. package/dist/cli/use-typescript-check.js +59 -0
  21. package/dist/cli/use-typescript-check.js.map +1 -0
  22. package/dist/commands/build.d.ts +9 -0
  23. package/dist/commands/build.js +46 -0
  24. package/dist/commands/build.js.map +1 -0
  25. package/dist/commands/dev.d.ts +9 -0
  26. package/dist/commands/dev.js +31 -0
  27. package/dist/commands/dev.js.map +1 -0
  28. package/dist/commands/start.d.ts +7 -0
  29. package/dist/commands/start.js +28 -0
  30. package/dist/commands/start.js.map +1 -0
  31. package/dist/commands/telemetry/disable.d.ts +5 -0
  32. package/dist/commands/telemetry/disable.js +14 -0
  33. package/dist/commands/telemetry/disable.js.map +1 -0
  34. package/dist/commands/telemetry/enable.d.ts +5 -0
  35. package/dist/commands/telemetry/enable.js +14 -0
  36. package/dist/commands/telemetry/enable.js.map +1 -0
  37. package/dist/commands/telemetry/status.d.ts +5 -0
  38. package/dist/commands/telemetry/status.js +14 -0
  39. package/dist/commands/telemetry/status.js.map +1 -0
  40. package/dist/server/asset-base-url-transform-plugin.d.ts +11 -0
  41. package/dist/server/asset-base-url-transform-plugin.js +34 -0
  42. package/dist/server/asset-base-url-transform-plugin.js.map +1 -0
  43. package/dist/server/asset-base-url-transform-plugin.test.js +56 -0
  44. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -0
  45. package/dist/server/express.d.ts +9 -0
  46. package/dist/server/express.js +69 -0
  47. package/dist/server/express.js.map +1 -0
  48. package/dist/server/express.test.js +74 -0
  49. package/dist/server/express.test.js.map +1 -0
  50. package/dist/server/index.d.ts +4 -0
  51. package/dist/server/index.js.map +1 -0
  52. package/dist/{src/server → server}/inferUtilityTypes.d.ts +10 -0
  53. package/dist/server/inferUtilityTypes.js.map +1 -0
  54. package/dist/server/server.d.ts +109 -0
  55. package/dist/server/server.js +194 -0
  56. package/dist/server/server.js.map +1 -0
  57. package/dist/{src/server → server}/templateHelper.d.ts +4 -0
  58. package/dist/{src/server → server}/templateHelper.js +5 -4
  59. package/dist/server/templateHelper.js.map +1 -0
  60. package/dist/server/templates/development.hbs +67 -0
  61. package/dist/{src/server → server}/templates/production.hbs +1 -1
  62. package/dist/{src/server → server}/widgetsDevServer.d.ts +2 -2
  63. package/dist/server/widgetsDevServer.js +57 -0
  64. package/dist/server/widgetsDevServer.js.map +1 -0
  65. package/dist/test/utils.d.ts +355 -0
  66. package/dist/{src/test → test}/utils.js +86 -8
  67. package/dist/test/utils.js.map +1 -0
  68. package/dist/test/widget.test.js +261 -0
  69. package/dist/test/widget.test.js.map +1 -0
  70. package/dist/web/bridges/apps-sdk/adaptor.d.ts +22 -0
  71. package/dist/web/bridges/apps-sdk/adaptor.js +80 -0
  72. package/dist/web/bridges/apps-sdk/adaptor.js.map +1 -0
  73. package/dist/web/bridges/apps-sdk/bridge.d.ts +10 -0
  74. package/dist/web/bridges/apps-sdk/bridge.js +46 -0
  75. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -0
  76. package/dist/web/bridges/apps-sdk/index.d.ts +5 -0
  77. package/dist/web/bridges/apps-sdk/index.js +5 -0
  78. package/dist/web/bridges/apps-sdk/index.js.map +1 -0
  79. package/dist/{src/web → web/bridges/apps-sdk}/types.d.ts +32 -47
  80. package/dist/{src/web → web/bridges/apps-sdk}/types.js +0 -1
  81. package/dist/web/bridges/apps-sdk/types.js.map +1 -0
  82. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +2 -0
  83. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +7 -0
  84. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -0
  85. package/dist/web/bridges/get-adaptor.d.ts +2 -0
  86. package/dist/web/bridges/get-adaptor.js +8 -0
  87. package/dist/web/bridges/get-adaptor.js.map +1 -0
  88. package/dist/web/bridges/index.d.ts +5 -0
  89. package/dist/web/bridges/index.js +6 -0
  90. package/dist/web/bridges/index.js.map +1 -0
  91. package/dist/web/bridges/mcp-app/adaptor.d.ts +36 -0
  92. package/dist/web/bridges/mcp-app/adaptor.js +190 -0
  93. package/dist/web/bridges/mcp-app/adaptor.js.map +1 -0
  94. package/dist/web/bridges/mcp-app/bridge.d.ts +43 -0
  95. package/dist/web/bridges/mcp-app/bridge.js +255 -0
  96. package/dist/web/bridges/mcp-app/bridge.js.map +1 -0
  97. package/dist/web/bridges/mcp-app/index.d.ts +4 -0
  98. package/dist/web/bridges/mcp-app/index.js +4 -0
  99. package/dist/web/bridges/mcp-app/index.js.map +1 -0
  100. package/dist/web/bridges/mcp-app/types.d.ts +8 -0
  101. package/dist/web/bridges/mcp-app/types.js +2 -0
  102. package/dist/web/bridges/mcp-app/types.js.map +1 -0
  103. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +5 -0
  104. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +7 -0
  105. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -0
  106. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js +66 -0
  107. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -0
  108. package/dist/web/bridges/types.d.ts +98 -0
  109. package/dist/web/bridges/types.js +2 -0
  110. package/dist/web/bridges/types.js.map +1 -0
  111. package/dist/web/bridges/use-host-context.d.ts +2 -0
  112. package/dist/web/bridges/use-host-context.js +8 -0
  113. package/dist/web/bridges/use-host-context.js.map +1 -0
  114. package/dist/web/components/modal-provider.d.ts +4 -0
  115. package/dist/web/components/modal-provider.js +47 -0
  116. package/dist/web/components/modal-provider.js.map +1 -0
  117. package/dist/web/create-store.js +24 -0
  118. package/dist/web/create-store.js.map +1 -0
  119. package/dist/web/create-store.test.js +126 -0
  120. package/dist/web/create-store.test.js.map +1 -0
  121. package/dist/{src/web → web}/data-llm.js +11 -7
  122. package/dist/web/data-llm.js.map +1 -0
  123. package/dist/web/data-llm.test.js +141 -0
  124. package/dist/web/data-llm.test.js.map +1 -0
  125. package/dist/{src/web → web}/generate-helpers.d.ts +11 -8
  126. package/dist/{src/web → web}/generate-helpers.js +5 -3
  127. package/dist/web/generate-helpers.js.map +1 -0
  128. package/dist/{src/web → web}/generate-helpers.test-d.js +59 -3
  129. package/dist/web/generate-helpers.test-d.js.map +1 -0
  130. package/dist/{src/web → web}/generate-helpers.test.js +1 -1
  131. package/dist/web/generate-helpers.test.js.map +1 -0
  132. package/dist/{src/web → web}/helpers/state.d.ts +3 -1
  133. package/dist/web/helpers/state.js +45 -0
  134. package/dist/web/helpers/state.js.map +1 -0
  135. package/dist/web/helpers/state.test.js +53 -0
  136. package/dist/web/helpers/state.test.js.map +1 -0
  137. package/dist/{src/web → web}/hooks/index.d.ts +4 -5
  138. package/dist/{src/web → web}/hooks/index.js +3 -4
  139. package/dist/web/hooks/index.js.map +1 -0
  140. package/dist/web/hooks/test/utils.d.ts +16 -0
  141. package/dist/web/hooks/test/utils.js +60 -0
  142. package/dist/web/hooks/test/utils.js.map +1 -0
  143. package/dist/{src/web → web}/hooks/use-call-tool.d.ts +3 -2
  144. package/dist/{src/web → web}/hooks/use-call-tool.js +12 -4
  145. package/dist/web/hooks/use-call-tool.js.map +1 -0
  146. package/dist/{src/web → web}/hooks/use-call-tool.test-d.js +1 -1
  147. package/dist/web/hooks/use-call-tool.test-d.js.map +1 -0
  148. package/dist/{src/web → web}/hooks/use-call-tool.test.js +35 -16
  149. package/dist/web/hooks/use-call-tool.test.js.map +1 -0
  150. package/dist/{src/web → web}/hooks/use-display-mode.d.ts +1 -1
  151. package/dist/web/hooks/use-display-mode.js +9 -0
  152. package/dist/web/hooks/use-display-mode.js.map +1 -0
  153. package/dist/{src/web → web}/hooks/use-display-mode.test.js +3 -2
  154. package/dist/web/hooks/use-display-mode.test.js.map +1 -0
  155. package/dist/web/hooks/use-files.d.ts +6 -0
  156. package/dist/web/hooks/use-files.js +9 -0
  157. package/dist/web/hooks/use-files.js.map +1 -0
  158. package/dist/{src/web → web}/hooks/use-files.test.js +11 -6
  159. package/dist/web/hooks/use-files.test.js.map +1 -0
  160. package/dist/web/hooks/use-layout.d.ts +22 -0
  161. package/dist/web/hooks/use-layout.js +23 -0
  162. package/dist/web/hooks/use-layout.js.map +1 -0
  163. package/dist/web/hooks/use-layout.test.js +96 -0
  164. package/dist/web/hooks/use-layout.test.js.map +1 -0
  165. package/dist/web/hooks/use-open-external.js +8 -0
  166. package/dist/web/hooks/use-open-external.js.map +1 -0
  167. package/dist/web/hooks/use-open-external.test.js +50 -0
  168. package/dist/web/hooks/use-open-external.test.js.map +1 -0
  169. package/dist/web/hooks/use-request-modal.d.ts +9 -0
  170. package/dist/web/hooks/use-request-modal.js +16 -0
  171. package/dist/web/hooks/use-request-modal.js.map +1 -0
  172. package/dist/web/hooks/use-request-modal.test.js +57 -0
  173. package/dist/web/hooks/use-request-modal.test.js.map +1 -0
  174. package/dist/web/hooks/use-send-follow-up-message.js +8 -0
  175. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -0
  176. package/dist/web/hooks/use-set-open-in-app-url.d.ts +1 -0
  177. package/dist/web/hooks/use-set-open-in-app-url.js +8 -0
  178. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -0
  179. package/dist/web/hooks/use-set-open-in-app-url.test.js +49 -0
  180. package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -0
  181. package/dist/{src/web → web}/hooks/use-tool-info.d.ts +13 -2
  182. package/dist/web/hooks/use-tool-info.js +26 -0
  183. package/dist/web/hooks/use-tool-info.js.map +1 -0
  184. package/dist/{src/web → web}/hooks/use-tool-info.test-d.js +40 -5
  185. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -0
  186. package/dist/web/hooks/use-tool-info.test.d.ts +1 -0
  187. package/dist/web/hooks/use-tool-info.test.js +130 -0
  188. package/dist/web/hooks/use-tool-info.test.js.map +1 -0
  189. package/dist/web/hooks/use-user.d.ts +18 -0
  190. package/dist/web/hooks/use-user.js +19 -0
  191. package/dist/web/hooks/use-user.js.map +1 -0
  192. package/dist/web/hooks/use-user.test.d.ts +1 -0
  193. package/dist/web/hooks/use-user.test.js +94 -0
  194. package/dist/web/hooks/use-user.test.js.map +1 -0
  195. package/dist/{src/web → web}/hooks/use-widget-state.js +11 -11
  196. package/dist/web/hooks/use-widget-state.js.map +1 -0
  197. package/dist/web/hooks/use-widget-state.test.d.ts +1 -0
  198. package/dist/{src/web → web}/hooks/use-widget-state.test.js +10 -8
  199. package/dist/web/hooks/use-widget-state.test.js.map +1 -0
  200. package/dist/{src/web → web}/index.d.ts +5 -4
  201. package/dist/{src/web → web}/index.js +5 -4
  202. package/dist/web/index.js.map +1 -0
  203. package/dist/{src/web → web}/mount-widget.js +9 -1
  204. package/dist/web/mount-widget.js.map +1 -0
  205. package/dist/web/plugin/data-llm.test.d.ts +1 -0
  206. package/dist/web/plugin/data-llm.test.js.map +1 -0
  207. package/dist/web/plugin/plugin.js +46 -0
  208. package/dist/web/plugin/plugin.js.map +1 -0
  209. package/dist/{src/web → web}/plugin/transform-data-llm.js +6 -3
  210. package/dist/web/plugin/transform-data-llm.js.map +1 -0
  211. package/dist/web/plugin/transform-data-llm.test.d.ts +1 -0
  212. package/dist/web/plugin/transform-data-llm.test.js.map +1 -0
  213. package/dist/{src/web → web}/proxy.js +6 -2
  214. package/dist/web/proxy.js.map +1 -0
  215. package/dist/web/types.d.ts +16 -0
  216. package/dist/web/types.js +2 -0
  217. package/dist/web/types.js.map +1 -0
  218. package/package.json +64 -36
  219. package/dist/src/server/index.d.ts +0 -4
  220. package/dist/src/server/index.js.map +0 -1
  221. package/dist/src/server/inferUtilityTypes.js.map +0 -1
  222. package/dist/src/server/server.d.ts +0 -48
  223. package/dist/src/server/server.js +0 -62
  224. package/dist/src/server/server.js.map +0 -1
  225. package/dist/src/server/templateHelper.js.map +0 -1
  226. package/dist/src/server/templates/development.hbs +0 -12
  227. package/dist/src/server/widgetsDevServer.js +0 -39
  228. package/dist/src/server/widgetsDevServer.js.map +0 -1
  229. package/dist/src/test/utils.d.ts +0 -89
  230. package/dist/src/test/utils.js.map +0 -1
  231. package/dist/src/test/widget.test.js +0 -90
  232. package/dist/src/test/widget.test.js.map +0 -1
  233. package/dist/src/web/create-store.js +0 -41
  234. package/dist/src/web/create-store.js.map +0 -1
  235. package/dist/src/web/data-llm.js.map +0 -1
  236. package/dist/src/web/data-llm.test.js +0 -76
  237. package/dist/src/web/data-llm.test.js.map +0 -1
  238. package/dist/src/web/generate-helpers.js.map +0 -1
  239. package/dist/src/web/generate-helpers.test-d.js.map +0 -1
  240. package/dist/src/web/generate-helpers.test.js.map +0 -1
  241. package/dist/src/web/helpers/state.js +0 -37
  242. package/dist/src/web/helpers/state.js.map +0 -1
  243. package/dist/src/web/hooks/index.js.map +0 -1
  244. package/dist/src/web/hooks/use-call-tool.js.map +0 -1
  245. package/dist/src/web/hooks/use-call-tool.test-d.js.map +0 -1
  246. package/dist/src/web/hooks/use-call-tool.test.js.map +0 -1
  247. package/dist/src/web/hooks/use-display-mode.js +0 -7
  248. package/dist/src/web/hooks/use-display-mode.js.map +0 -1
  249. package/dist/src/web/hooks/use-display-mode.test.js.map +0 -1
  250. package/dist/src/web/hooks/use-files.d.ts +0 -10
  251. package/dist/src/web/hooks/use-files.js +0 -7
  252. package/dist/src/web/hooks/use-files.js.map +0 -1
  253. package/dist/src/web/hooks/use-files.test.js.map +0 -1
  254. package/dist/src/web/hooks/use-locale.d.ts +0 -1
  255. package/dist/src/web/hooks/use-locale.js +0 -5
  256. package/dist/src/web/hooks/use-locale.js.map +0 -1
  257. package/dist/src/web/hooks/use-locale.test.js +0 -21
  258. package/dist/src/web/hooks/use-locale.test.js.map +0 -1
  259. package/dist/src/web/hooks/use-open-external.js +0 -6
  260. package/dist/src/web/hooks/use-open-external.js.map +0 -1
  261. package/dist/src/web/hooks/use-open-external.test.js +0 -24
  262. package/dist/src/web/hooks/use-open-external.test.js.map +0 -1
  263. package/dist/src/web/hooks/use-openai-global.d.ts +0 -2
  264. package/dist/src/web/hooks/use-openai-global.js +0 -23
  265. package/dist/src/web/hooks/use-openai-global.js.map +0 -1
  266. package/dist/src/web/hooks/use-request-modal.d.ts +0 -6
  267. package/dist/src/web/hooks/use-request-modal.js +0 -9
  268. package/dist/src/web/hooks/use-request-modal.js.map +0 -1
  269. package/dist/src/web/hooks/use-request-modal.test.js +0 -24
  270. package/dist/src/web/hooks/use-request-modal.test.js.map +0 -1
  271. package/dist/src/web/hooks/use-send-follow-up-message.js +0 -11
  272. package/dist/src/web/hooks/use-send-follow-up-message.js.map +0 -1
  273. package/dist/src/web/hooks/use-theme.d.ts +0 -1
  274. package/dist/src/web/hooks/use-theme.js +0 -5
  275. package/dist/src/web/hooks/use-theme.js.map +0 -1
  276. package/dist/src/web/hooks/use-theme.test.js +0 -26
  277. package/dist/src/web/hooks/use-theme.test.js.map +0 -1
  278. package/dist/src/web/hooks/use-tool-info.js +0 -22
  279. package/dist/src/web/hooks/use-tool-info.js.map +0 -1
  280. package/dist/src/web/hooks/use-tool-info.test-d.js.map +0 -1
  281. package/dist/src/web/hooks/use-tool-info.test.js +0 -59
  282. package/dist/src/web/hooks/use-tool-info.test.js.map +0 -1
  283. package/dist/src/web/hooks/use-user-agent.d.ts +0 -1
  284. package/dist/src/web/hooks/use-user-agent.js +0 -5
  285. package/dist/src/web/hooks/use-user-agent.js.map +0 -1
  286. package/dist/src/web/hooks/use-user-agent.test.js +0 -31
  287. package/dist/src/web/hooks/use-user-agent.test.js.map +0 -1
  288. package/dist/src/web/hooks/use-widget-state.js.map +0 -1
  289. package/dist/src/web/hooks/use-widget-state.test.js.map +0 -1
  290. package/dist/src/web/index.js.map +0 -1
  291. package/dist/src/web/mount-widget.js.map +0 -1
  292. package/dist/src/web/plugin/data-llm.test.js.map +0 -1
  293. package/dist/src/web/plugin/plugin.js +0 -33
  294. package/dist/src/web/plugin/plugin.js.map +0 -1
  295. package/dist/src/web/plugin/transform-data-llm.js.map +0 -1
  296. package/dist/src/web/plugin/transform-data-llm.test.js.map +0 -1
  297. package/dist/src/web/proxy.js.map +0 -1
  298. package/dist/src/web/types.js.map +0 -1
  299. package/dist/vitest.config.d.ts +0 -2
  300. package/dist/vitest.config.js +0 -8
  301. package/dist/vitest.config.js.map +0 -1
  302. /package/dist/{src/test/widget.test.d.ts → server/asset-base-url-transform-plugin.test.d.ts} +0 -0
  303. /package/dist/{src/web/data-llm.test.d.ts → server/express.test.d.ts} +0 -0
  304. /package/dist/{src/server → server}/index.js +0 -0
  305. /package/dist/{src/server → server}/inferUtilityTypes.js +0 -0
  306. /package/dist/{src/web/generate-helpers.test-d.d.ts → test/widget.test.d.ts} +0 -0
  307. /package/dist/{src/web/generate-helpers.test.d.ts → web/bridges/mcp-app/use-mcp-app-context.test.d.ts} +0 -0
  308. /package/dist/{src/web → web}/create-store.d.ts +0 -0
  309. /package/dist/{src/web/hooks/use-call-tool.test-d.d.ts → web/create-store.test.d.ts} +0 -0
  310. /package/dist/{src/web → web}/data-llm.d.ts +0 -0
  311. /package/dist/{src/web/plugin → web}/data-llm.test.d.ts +0 -0
  312. /package/dist/{src/web/hooks/use-call-tool.test.d.ts → web/generate-helpers.test-d.d.ts} +0 -0
  313. /package/dist/{src/web/hooks/use-display-mode.test.d.ts → web/generate-helpers.test.d.ts} +0 -0
  314. /package/dist/{src/web/hooks/use-files.test.d.ts → web/helpers/state.test.d.ts} +0 -0
  315. /package/dist/{src/web/hooks/use-locale.test.d.ts → web/hooks/use-call-tool.test-d.d.ts} +0 -0
  316. /package/dist/{src/web/hooks/use-open-external.test.d.ts → web/hooks/use-call-tool.test.d.ts} +0 -0
  317. /package/dist/{src/web/hooks/use-request-modal.test.d.ts → web/hooks/use-display-mode.test.d.ts} +0 -0
  318. /package/dist/{src/web/hooks/use-theme.test.d.ts → web/hooks/use-files.test.d.ts} +0 -0
  319. /package/dist/{src/web/hooks/use-tool-info.test-d.d.ts → web/hooks/use-layout.test.d.ts} +0 -0
  320. /package/dist/{src/web → web}/hooks/use-open-external.d.ts +0 -0
  321. /package/dist/{src/web/hooks/use-tool-info.test.d.ts → web/hooks/use-open-external.test.d.ts} +0 -0
  322. /package/dist/{src/web/hooks/use-user-agent.test.d.ts → web/hooks/use-request-modal.test.d.ts} +0 -0
  323. /package/dist/{src/web → web}/hooks/use-send-follow-up-message.d.ts +0 -0
  324. /package/dist/{src/web/hooks/use-widget-state.test.d.ts → web/hooks/use-set-open-in-app-url.test.d.ts} +0 -0
  325. /package/dist/{src/web/plugin/transform-data-llm.test.d.ts → web/hooks/use-tool-info.test-d.d.ts} +0 -0
  326. /package/dist/{src/web → web}/hooks/use-widget-state.d.ts +0 -0
  327. /package/dist/{src/web → web}/mount-widget.d.ts +0 -0
  328. /package/dist/{src/web → web}/plugin/data-llm.test.js +0 -0
  329. /package/dist/{src/web → web}/plugin/plugin.d.ts +0 -0
  330. /package/dist/{src/web → web}/plugin/transform-data-llm.d.ts +0 -0
  331. /package/dist/{src/web → web}/plugin/transform-data-llm.test.js +0 -0
  332. /package/dist/{src/web → web}/proxy.d.ts +0 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/test/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC/C,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD;;GAEG;AACH,MAAM,UAAU,mBAAmB;IAKjC,mCAAmC;IACnC,MAAM,MAAM,GAAG,IAAI,SAAS,CAC1B;QACE,IAAI,EAAE,kBAAkB;QACxB,OAAO,EAAE,OAAO;KACjB,EACD,EAAE,YAAY,EAAE,EAAE,EAAE,CACrB,CAAC;IAEF,6CAA6C;IAC7C,MAAM,oBAAoB,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAClE,MAAM,gBAAgB,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAE1D,OAAO;QACL,MAAM;QACN,oBAAoB;QACpB,gBAAgB;KACjB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,OAAO,IAAI,SAAS,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;SAC7D,cAAc,CACb,eAAe,EACf,EAAE,EACF;QACE,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE;YACX,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;YACvB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACpC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAChC;QACD,YAAY,EAAE;YACZ,OAAO,EAAE,CAAC,CAAC,KAAK,CACd,CAAC,CAAC,MAAM,CAAC;gBACP,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;gBACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;gBAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;aAClB,CAAC,CACH;YACD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;SACvB;KACF,EACD,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;QACxB,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,WAAW,EAAE,EAAE,CAAC;YAClE,iBAAiB,EAAE;gBACjB,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;gBACjD,UAAU,EAAE,CAAC;aACd;SACF,CAAC;IACJ,CAAC,CACF;SACA,cAAc,CACb,kBAAkB,EAClB,EAAE,EACF;QACE,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EAAE;YACX,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;SACnB;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;YAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;YACvB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SAC5B;KACF,EACD,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;QACnB,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,MAAM,EAAE,EAAE,CAAC;YAC1D,iBAAiB,EAAE;gBACjB,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,cAAc;gBAC3B,MAAM,EAAE,CAAC,YAAY,CAAC;aACvB;SACF,CAAC;IACJ,CAAC,CACF;SACA,cAAc,CACb,iBAAiB,EACjB,EAAE,EACF;QACE,WAAW,EAAE,sBAAsB;QACnC,WAAW,EAAE,EAAE;QACf,YAAY,EAAE,EAAE;KACjB,EACD,KAAK,IAAI,EAAE;QACT,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;YACpD,iBAAiB,EAAE,EAAE;SACtB,CAAC;IACJ,CAAC,CACF;SACA,cAAc,CACb,wBAAwB,EACxB,EAAE,EACF;QACE,WAAW,EAAE,2CAA2C;QACxD,WAAW,EAAE;YACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;SAClB;KACF,EACD,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;QAClB,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,EAAE,EAAE,CAAC;YACpD,iBAAiB,EAAE;gBACjB,eAAe,EAAE,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;gBACpD,aAAa,EAAE,CAAC;aACjB;SACF,CAAC;IACJ,CAAC,CACF;SACA,YAAY,CACX,iBAAiB,EACjB;QACE,WAAW,EAAE,sBAAsB;QACnC,WAAW,EAAE;YACX,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;YAClB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;SACvB;QACD,YAAY,EAAE;YACZ,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;YACtB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;SACrB;KACF,EACD,KAAK,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE;QAC/B,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,MAAM,EAAE,EAAE,CAAC;YACxD,iBAAiB,EAAE;gBACjB,UAAU,EAAE,IAAI,GAAG,UAAU;gBAC7B,QAAQ,EAAE,KAAK;aAChB;SACF,CAAC;IACJ,CAAC,CACF;SACA,YAAY,CACX,eAAe,EACf;QACE,WAAW,EAAE,yCAAyC;QACtD,WAAW,EAAE;YACX,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;SACnB;KACF,EACD,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;QACnB,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,EAAE,CAAC;YACpD,iBAAiB,EAAE;gBACjB,WAAW,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,SAAS,EAAE,IAAI,EAAE;gBACvD,SAAS,EAAE,YAAY;aACxB;SACF,CAAC;IACJ,CAAC,CACF;SACA,cAAc,CACb,sBAAsB,EACtB,EAAE,EACF;QACE,WAAW,EAAE,uCAAuC;QACpD,WAAW,EAAE;YACX,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;SACvB;KACF,EACD,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;QACvB,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,UAAU,EAAE,EAAE,CAAC;YAC5D,iBAAiB,EAAE;gBACjB,IAAI,EAAE,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE;aACvC;YACD,KAAK,EAAE;gBACL,SAAS,EAAE,SAAS;gBACpB,SAAS,EAAE,aAAa;gBACxB,MAAM,EAAE,KAAK;aACd;SACF,CAAC;IACJ,CAAC,CACF;SACA,YAAY,CACX,oBAAoB,EACpB;QACE,WAAW,EAAE,qCAAqC;QAClD,WAAW,EAAE;YACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;SAClB;KACF,EACD,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;QAClB,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,EAAE,EAAE,CAAC;YACpD,iBAAiB,EAAE;gBACjB,OAAO,EAAE,CAAC,KAAK,CAAC;aACjB;YACD,KAAK,EAAE;gBACL,aAAa,EAAE,GAAG;gBAClB,MAAM,EAAE,OAAO;aAChB;SACF,CAAC;IACJ,CAAC,CACF;SACA,cAAc,CACb,2BAA2B,EAC3B,EAAE,EACF;QACE,WAAW,EACT,gEAAgE;QAClE,WAAW,EAAE;YACX,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE;SAC3B;KACF,EACD,KAAK,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE;QAC1B,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,wBAAwB;YACxB,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;gBACnD,iBAAiB,EAAE,EAAE,KAAK,EAAE,sBAAsB,EAAE;aACrD,CAAC;QACJ,CAAC;QACD,2BAA2B;QAC3B,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;YAC5C,iBAAiB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACrC,KAAK,EAAE;gBACL,WAAW,EAAE,aAAa;gBAC1B,MAAM,EAAE,WAAW;aACpB;SACF,CAAC;IACJ,CAAC,CACF,CAAC;AACN,CAAC;AAED,MAAM,UAAU,uBAAuB;IACrC,OAAO,IAAI,SAAS,CAClB,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,EACtC,EAAE,CACH,CAAC,cAAc,CACd,eAAe,EACf,EAAE,EACF;QACE,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE;YACX,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;SACxB;QACD,YAAY,EAAE;YACZ,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;SAC/C;KACF,EACD,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;QACxB,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,WAAW,EAAE,EAAE,CAAC;YAClE,iBAAiB,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE;SAC9C,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAkBD,MAAM,UAAU,yBAAyB;IACvC,OAAO,IAAI,SAAS,CAClB,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,EAAE,EAChD,EAAE,CACH,CAAC,cAAc,CAKd,kBAAkB,EAClB,EAAE,EACF;QACE,WAAW,EAAE,oCAAoC;QACjD,WAAW,EAAE;YACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;SACf;KACF,EACD,KAAK,EAAE,EAAE,EAAE,EAAE,EAAgC,EAAE;QAC7C,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;YAC/C,iBAAiB,EAAE;gBACjB,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,EAAE;aACb;YACD,KAAK,EAAE;gBACL,WAAW,EAAE,MAAM;gBACnB,OAAO,EAAE,CAAC;aACX;SACF,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,OAAO;QACL,WAAW,EAAE;YACX,OAAO,EAAE,EAAE,IAAI,EAAE;SAClB;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,GAA2B;IACpD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY;IAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;AAC9B,CAAC"}
@@ -0,0 +1,261 @@
1
+ import { afterEach, beforeEach, describe, expect, it, vi, } from "vitest";
2
+ import { createMockExtra, createMockMcpServer, resetTestEnv, setTestEnv, } from "./utils.js";
3
+ const mockManifest = {
4
+ "src/widgets/my-widget.tsx": { file: "my-widget.js" },
5
+ "src/widgets/folder-widget/index.tsx": { file: "folder-widget.js" },
6
+ "style.css": { file: "style.css" },
7
+ };
8
+ const actual = vi.hoisted(() => require("node:fs"));
9
+ vi.mock("node:fs", () => {
10
+ const readFileSyncImpl = (path, ...args) => {
11
+ if (typeof path === "string" && path.includes("manifest.json")) {
12
+ return JSON.stringify(mockManifest);
13
+ }
14
+ return actual.readFileSync(path, ...args);
15
+ };
16
+ const readFileSync = vi.fn(readFileSyncImpl);
17
+ return {
18
+ readFileSync,
19
+ default: {
20
+ readFileSync,
21
+ },
22
+ };
23
+ });
24
+ describe("McpServer.registerWidget", () => {
25
+ let server;
26
+ let mockRegisterResource;
27
+ let mockRegisterTool;
28
+ beforeEach(() => {
29
+ ({ server, mockRegisterResource, mockRegisterTool } =
30
+ createMockMcpServer());
31
+ });
32
+ afterEach(() => {
33
+ vi.clearAllMocks();
34
+ resetTestEnv();
35
+ });
36
+ it("should generate correct HTML for development mode", async () => {
37
+ setTestEnv({ NODE_ENV: "development" });
38
+ const mockToolCallback = vi.fn();
39
+ const mockRegisterResourceConfig = { description: "Test widget" };
40
+ const mockToolConfig = { description: "Test tool" };
41
+ server.registerWidget("my-widget", mockRegisterResourceConfig, mockToolConfig, mockToolCallback);
42
+ // Get the resource callback function
43
+ const appsSdkResourceCallback = mockRegisterResource.mock
44
+ .calls[0]?.[3];
45
+ expect(appsSdkResourceCallback).toBeDefined();
46
+ const serverUrl = "http://localhost:3000";
47
+ const mockExtra = createMockExtra("__not_used__");
48
+ const result = await appsSdkResourceCallback(new URL("ui://widgets/apps-sdk/my-widget.html"), mockExtra);
49
+ expect(mockRegisterTool).toHaveBeenCalled();
50
+ expect(result).toEqual({
51
+ contents: [
52
+ {
53
+ uri: "ui://widgets/apps-sdk/my-widget.html",
54
+ mimeType: "text/html+skybridge",
55
+ text: expect.stringContaining('<div id="root"></div>'),
56
+ _meta: {
57
+ "openai/widgetCSP": {
58
+ resource_domains: [serverUrl],
59
+ connect_domains: [serverUrl, "ws://localhost:24678"],
60
+ },
61
+ "openai/widgetDomain": serverUrl,
62
+ "openai/widgetDescription": "Test widget",
63
+ },
64
+ },
65
+ ],
66
+ });
67
+ // Check development-specific content
68
+ expect(result.contents[0]?.text).toContain(`${serverUrl}/assets/@react-refresh`);
69
+ expect(result.contents[0]?.text).toContain(`${serverUrl}/@vite/client`);
70
+ expect(result.contents[0]?.text).toContain(`${serverUrl}/src/widgets/my-widget`);
71
+ expect(result.contents[0]?.text).not.toContain(`${serverUrl}/src/widgets/my-widget.tsx`);
72
+ });
73
+ it("should generate correct HTML for production mode", async () => {
74
+ setTestEnv({ NODE_ENV: "production" });
75
+ const mockToolCallback = vi.fn();
76
+ const mockRegisterResourceConfig = { description: "Test widget" };
77
+ const mockToolConfig = { description: "Test tool" };
78
+ server.registerWidget("my-widget", mockRegisterResourceConfig, mockToolConfig, mockToolCallback);
79
+ // Get the resource callback function
80
+ const appsSdkResourceCallback = mockRegisterResource.mock
81
+ .calls[0]?.[3];
82
+ expect(appsSdkResourceCallback).toBeDefined();
83
+ const host = "myapp.com";
84
+ const serverUrl = `https://${host}`;
85
+ const mockExtra = createMockExtra(host);
86
+ const result = await appsSdkResourceCallback(new URL("ui://widgets/apps-sdk/my-widget.html"), mockExtra);
87
+ expect(result).toEqual({
88
+ contents: [
89
+ {
90
+ uri: "ui://widgets/apps-sdk/my-widget.html",
91
+ mimeType: "text/html+skybridge",
92
+ text: expect.stringContaining('<div id="root"></div>'),
93
+ _meta: {
94
+ "openai/widgetCSP": {
95
+ resource_domains: [serverUrl],
96
+ connect_domains: [serverUrl],
97
+ },
98
+ "openai/widgetDomain": serverUrl,
99
+ "openai/widgetDescription": "Test widget",
100
+ },
101
+ },
102
+ ],
103
+ });
104
+ // Check production-specific content
105
+ expect(result.contents[0]?.text).not.toContain(`${serverUrl}/assets/@react-refresh`);
106
+ expect(result.contents[0]?.text).not.toContain(`${serverUrl}@vite/client`);
107
+ expect(result.contents[0]?.text).toContain(`${serverUrl}/assets/my-widget.js`);
108
+ expect(result.contents[0]?.text).toContain(`${serverUrl}/assets/style.css`);
109
+ });
110
+ it("should resolve folder-based widgets (barrel files) in production mode", async () => {
111
+ setTestEnv({ NODE_ENV: "production" });
112
+ const mockToolCallback = vi.fn();
113
+ const mockRegisterResourceConfig = { description: "Folder widget" };
114
+ const mockToolConfig = { description: "Folder tool" };
115
+ server.registerWidget("folder-widget", mockRegisterResourceConfig, mockToolConfig, mockToolCallback);
116
+ const appsSdkResourceCallback = mockRegisterResource.mock
117
+ .calls[0]?.[3];
118
+ expect(appsSdkResourceCallback).toBeDefined();
119
+ const host = "myapp.com";
120
+ const serverUrl = `https://${host}`;
121
+ const mockExtra = createMockExtra(host);
122
+ const result = await appsSdkResourceCallback(new URL("ui://widgets/apps-sdk/folder-widget.html"), mockExtra);
123
+ // Should resolve to folder-widget.js from the manifest entry "src/widgets/folder-widget/index.tsx"
124
+ expect(result.contents[0]?.text).toContain(`${serverUrl}/assets/folder-widget.js`);
125
+ });
126
+ it("should register resources with correct hostType for both apps-sdk and ext-apps formats", async () => {
127
+ const mockToolCallback = vi.fn();
128
+ const mockRegisterResourceConfig = {
129
+ description: "Test widget",
130
+ _meta: { "openai/widgetPrefersBorder": true },
131
+ };
132
+ const mockToolConfig = { description: "Test tool" };
133
+ server.registerWidget("my-widget", mockRegisterResourceConfig, mockToolConfig, mockToolCallback);
134
+ expect(mockRegisterResource).toHaveBeenCalledTimes(2);
135
+ const appsSdkCallback = mockRegisterResource.mock
136
+ .calls[0]?.[3];
137
+ const appsSdkResult = await appsSdkCallback(new URL("ui://widgets/apps-sdk/my-widget.html"), createMockExtra("__not_used__"));
138
+ const serverUrl = "http://localhost:3000";
139
+ expect(appsSdkResult).toEqual({
140
+ contents: [
141
+ {
142
+ uri: "ui://widgets/apps-sdk/my-widget.html",
143
+ mimeType: "text/html+skybridge",
144
+ text: expect.stringContaining('<div id="root"></div>'),
145
+ _meta: {
146
+ "openai/widgetCSP": {
147
+ resource_domains: [serverUrl],
148
+ connect_domains: [serverUrl, "ws://localhost:24678"],
149
+ },
150
+ "openai/widgetDomain": serverUrl,
151
+ "openai/widgetDescription": "Test widget",
152
+ "openai/widgetPrefersBorder": true,
153
+ },
154
+ },
155
+ ],
156
+ });
157
+ expect(appsSdkResult.contents[0]?.text).toContain('window.skybridge = { hostType: "apps-sdk", serverUrl: "http://localhost:3000" };');
158
+ const extAppsResourceCallback = mockRegisterResource.mock
159
+ .calls[1]?.[3];
160
+ expect(extAppsResourceCallback).toBeDefined();
161
+ const extAppsResult = await extAppsResourceCallback(new URL("ui://widgets/ext-apps/my-widget.html"), createMockExtra("__not_used__"));
162
+ expect(extAppsResult).toEqual({
163
+ contents: [
164
+ {
165
+ uri: "ui://widgets/ext-apps/my-widget.html",
166
+ mimeType: "text/html;profile=mcp-app",
167
+ text: expect.stringContaining('<div id="root"></div>'),
168
+ _meta: {
169
+ ui: {
170
+ csp: {
171
+ resourceDomains: [serverUrl],
172
+ connectDomains: [serverUrl, "ws://localhost:24678"],
173
+ },
174
+ domain: serverUrl,
175
+ },
176
+ },
177
+ },
178
+ ],
179
+ });
180
+ expect(extAppsResult.contents[0]?.text).toContain('window.skybridge = { hostType: "mcp-app", serverUrl: "http://localhost:3000" };');
181
+ });
182
+ it("should register tool with ui.resourceUri metadata (not deprecated ui/resourceUri)", async () => {
183
+ const mockToolCallback = vi.fn();
184
+ const mockRegisterResourceConfig = { description: "Test widget" };
185
+ const mockToolConfig = { description: "Test tool" };
186
+ server.registerWidget("my-widget", mockRegisterResourceConfig, mockToolConfig, mockToolCallback);
187
+ expect(mockRegisterTool).toHaveBeenCalledTimes(1);
188
+ const toolCallArgs = mockRegisterTool.mock.calls[0];
189
+ const toolConfig = toolCallArgs?.[1];
190
+ expect(toolConfig._meta).toHaveProperty("ui");
191
+ expect(toolConfig._meta?.ui).toEqual({
192
+ resourceUri: "ui://widgets/ext-apps/my-widget.html",
193
+ });
194
+ });
195
+ it("should apply meta overrides in correct priority: defaults < ui.* < direct openai/* keys", async () => {
196
+ const mockToolCallback = vi.fn();
197
+ const mockRegisterResourceConfig = {
198
+ description: "Test widget",
199
+ _meta: {
200
+ // ui.csp overrides (middle priority)
201
+ ui: {
202
+ csp: {
203
+ resourceDomains: ["https://from-ui-csp.com"],
204
+ connectDomains: ["https://from-ui-csp.com"],
205
+ },
206
+ domain: "https://from-ui-domain.com",
207
+ prefersBorder: false,
208
+ },
209
+ // Direct openai/* keys (highest priority) - should override ui.*
210
+ "openai/widgetDomain": "https://direct-override.com",
211
+ "openai/widgetPrefersBorder": true,
212
+ },
213
+ };
214
+ const mockToolConfig = { description: "Test tool" };
215
+ server.registerWidget("override-test", mockRegisterResourceConfig, mockToolConfig, mockToolCallback);
216
+ const appsSdkCallback = mockRegisterResource.mock
217
+ .calls[0]?.[3];
218
+ const serverUrl = "http://localhost:3000";
219
+ const result = await appsSdkCallback(new URL("ui://widgets/apps-sdk/override-test.html"), createMockExtra("__not_used__"));
220
+ const meta = result.contents[0]?._meta;
221
+ // CSP arrays are merged with union - all unique domains from defaults and user config are preserved
222
+ expect(meta["openai/widgetCSP"]).toEqual({
223
+ resource_domains: [serverUrl, "https://from-ui-csp.com"],
224
+ connect_domains: [
225
+ serverUrl,
226
+ "ws://localhost:24678",
227
+ "https://from-ui-csp.com",
228
+ ],
229
+ frame_domains: undefined,
230
+ redirect_domains: undefined,
231
+ });
232
+ // Domain should be overridden by direct openai/* key (highest priority)
233
+ expect(meta["openai/widgetDomain"]).toBe("https://direct-override.com");
234
+ // PrefersBorder should be overridden by direct openai/* key (highest priority)
235
+ expect(meta["openai/widgetPrefersBorder"]).toBe(true);
236
+ // Description should be from defaults (toolConfig.description)
237
+ expect(meta["openai/widgetDescription"]).toBe("Test widget");
238
+ });
239
+ it("should register tool with ui.resourceUri metadata only", async () => {
240
+ const mockToolCallback = vi.fn();
241
+ server.registerWidget("my-widget", { description: "Test widget", hosts: ["mcp-app"] }, { description: "Test tool" }, mockToolCallback);
242
+ expect(mockRegisterTool).toHaveBeenCalledTimes(1);
243
+ const toolCallArgs = mockRegisterTool.mock.calls[0];
244
+ const toolConfig = toolCallArgs?.[1];
245
+ expect(toolConfig._meta).toHaveProperty("ui");
246
+ expect(toolConfig._meta?.ui).toEqual({
247
+ resourceUri: "ui://widgets/ext-apps/my-widget.html",
248
+ });
249
+ expect(toolConfig._meta?.["openai/outputTemplate"]).to.be.undefined;
250
+ });
251
+ it("should register tool with uopenai/outputTemplate metadata only", async () => {
252
+ const mockToolCallback = vi.fn();
253
+ server.registerWidget("my-widget", { description: "Test widget", hosts: ["apps-sdk"] }, { description: "Test tool" }, mockToolCallback);
254
+ expect(mockRegisterTool).toHaveBeenCalledTimes(1);
255
+ const toolCallArgs = mockRegisterTool.mock.calls[0];
256
+ const toolConfig = toolCallArgs?.[1];
257
+ expect(toolConfig._meta).not.toHaveProperty("ui");
258
+ expect(toolConfig._meta?.["openai/outputTemplate"]).to.eq("ui://widgets/apps-sdk/my-widget.html");
259
+ });
260
+ });
261
+ //# sourceMappingURL=widget.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"widget.test.js","sourceRoot":"","sources":["../../src/test/widget.test.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,SAAS,EACT,UAAU,EACV,QAAQ,EACR,MAAM,EACN,EAAE,EAEF,EAAE,GACH,MAAM,QAAQ,CAAC;AAEhB,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,YAAY,EACZ,UAAU,GACX,MAAM,YAAY,CAAC;AAEpB,MAAM,YAAY,GAAG;IACnB,2BAA2B,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE;IACrD,qCAAqC,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE;IACnE,WAAW,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE;CACnC,CAAC;AAEF,MAAM,MAAM,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;AAEpD,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;IACtB,MAAM,gBAAgB,GAAG,CACvB,IAA+C,EAC/C,GAAG,IAAe,EACsB,EAAE;QAC1C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YAC/D,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,CAEjC,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;IAC5C,CAAC,CAAC;IACF,MAAM,YAAY,GAAG,EAAE,CAAC,EAAE,CAAC,gBAAgB,CAA+B,CAAC;IAE3E,OAAO;QACL,YAAY;QACZ,OAAO,EAAE;YACP,YAAY;SACb;KACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,IAAI,MAAiB,CAAC;IACtB,IAAI,oBAAiE,CAAC;IACtE,IAAI,gBAAyD,CAAC;IAE9D,UAAU,CAAC,GAAG,EAAE;QACd,CAAC,EAAE,MAAM,EAAE,oBAAoB,EAAE,gBAAgB,EAAE;YACjD,mBAAmB,EAAE,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,aAAa,EAAE,CAAC;QACnB,YAAY,EAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,UAAU,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAC;QAExC,MAAM,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,MAAM,0BAA0B,GAAG,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;QAClE,MAAM,cAAc,GAAG,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;QAEpD,MAAM,CAAC,cAAc,CACnB,WAAW,EACX,0BAA0B,EAC1B,cAAc,EACd,gBAAgB,CACjB,CAAC;QAEF,qCAAqC;QACrC,MAAM,uBAAuB,GAAG,oBAAoB,CAAC,IAAI;aACtD,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAKb,CAAC;QACH,MAAM,CAAC,uBAAuB,CAAC,CAAC,WAAW,EAAE,CAAC;QAE9C,MAAM,SAAS,GAAG,uBAAuB,CAAC;QAC1C,MAAM,SAAS,GAAG,eAAe,CAC/B,cAAc,CACsD,CAAC;QACvE,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAC1C,IAAI,GAAG,CAAC,sCAAsC,CAAC,EAC/C,SAAS,CACV,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,CAAC,gBAAgB,EAAE,CAAC;QAC5C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,sCAAsC;oBAC3C,QAAQ,EAAE,qBAAqB;oBAC/B,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC,uBAAuB,CAAC;oBACtD,KAAK,EAAE;wBACL,kBAAkB,EAAE;4BAClB,gBAAgB,EAAE,CAAC,SAAS,CAAC;4BAC7B,eAAe,EAAE,CAAC,SAAS,EAAE,sBAAsB,CAAC;yBACrD;wBACD,qBAAqB,EAAE,SAAS;wBAChC,0BAA0B,EAAE,aAAa;qBAC1C;iBACF;aACF;SACF,CAAC,CAAC;QAEH,qCAAqC;QACrC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS,CACxC,GAAG,SAAS,wBAAwB,CACrC,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,GAAG,SAAS,eAAe,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS,CACxC,GAAG,SAAS,wBAAwB,CACrC,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAC5C,GAAG,SAAS,4BAA4B,CACzC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAChE,UAAU,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;QAEvC,MAAM,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,MAAM,0BAA0B,GAAG,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;QAClE,MAAM,cAAc,GAAG,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;QAEpD,MAAM,CAAC,cAAc,CACnB,WAAW,EACX,0BAA0B,EAC1B,cAAc,EACd,gBAAgB,CACjB,CAAC;QAEF,qCAAqC;QACrC,MAAM,uBAAuB,GAAG,oBAAoB,CAAC,IAAI;aACtD,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAKb,CAAC;QACH,MAAM,CAAC,uBAAuB,CAAC,CAAC,WAAW,EAAE,CAAC;QAE9C,MAAM,IAAI,GAAG,WAAW,CAAC;QACzB,MAAM,SAAS,GAAG,WAAW,IAAI,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,CAGrC,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAC1C,IAAI,GAAG,CAAC,sCAAsC,CAAC,EAC/C,SAAS,CACV,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,sCAAsC;oBAC3C,QAAQ,EAAE,qBAAqB;oBAC/B,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC,uBAAuB,CAAC;oBACtD,KAAK,EAAE;wBACL,kBAAkB,EAAE;4BAClB,gBAAgB,EAAE,CAAC,SAAS,CAAC;4BAC7B,eAAe,EAAE,CAAC,SAAS,CAAC;yBAC7B;wBACD,qBAAqB,EAAE,SAAS;wBAChC,0BAA0B,EAAE,aAAa;qBAC1C;iBACF;aACF;SACF,CAAC,CAAC;QAEH,oCAAoC;QACpC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAC5C,GAAG,SAAS,wBAAwB,CACrC,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,SAAS,cAAc,CAAC,CAAC;QAC3E,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS,CACxC,GAAG,SAAS,sBAAsB,CACnC,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;QACrF,UAAU,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;QAEvC,MAAM,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,MAAM,0BAA0B,GAAG,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC;QACpE,MAAM,cAAc,GAAG,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;QAEtD,MAAM,CAAC,cAAc,CACnB,eAAe,EACf,0BAA0B,EAC1B,cAAc,EACd,gBAAgB,CACjB,CAAC;QAEF,MAAM,uBAAuB,GAAG,oBAAoB,CAAC,IAAI;aACtD,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAKb,CAAC;QACH,MAAM,CAAC,uBAAuB,CAAC,CAAC,WAAW,EAAE,CAAC;QAE9C,MAAM,IAAI,GAAG,WAAW,CAAC;QACzB,MAAM,SAAS,GAAG,WAAW,IAAI,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,CAGrC,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAC1C,IAAI,GAAG,CAAC,0CAA0C,CAAC,EACnD,SAAS,CACV,CAAC;QAEF,mGAAmG;QACnG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS,CACxC,GAAG,SAAS,0BAA0B,CACvC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wFAAwF,EAAE,KAAK,IAAI,EAAE;QACtG,MAAM,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,MAAM,0BAA0B,GAAG;YACjC,WAAW,EAAE,aAAa;YAC1B,KAAK,EAAE,EAAE,4BAA4B,EAAE,IAAI,EAAE;SAC9C,CAAC;QACF,MAAM,cAAc,GAAG,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;QAEpD,MAAM,CAAC,cAAc,CACnB,WAAW,EACX,0BAA0B,EAC1B,cAAc,EACd,gBAAgB,CACjB,CAAC;QAEF,MAAM,CAAC,oBAAoB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAEtD,MAAM,eAAe,GAAG,oBAAoB,CAAC,IAAI;aAC9C,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAKb,CAAC;QACH,MAAM,aAAa,GAAG,MAAM,eAAe,CACzC,IAAI,GAAG,CAAC,sCAAsC,CAAC,EAC/C,eAAe,CAAC,cAAc,CAG7B,CACF,CAAC;QACF,MAAM,SAAS,GAAG,uBAAuB,CAAC;QAE1C,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC;YAC5B,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,sCAAsC;oBAC3C,QAAQ,EAAE,qBAAqB;oBAC/B,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC,uBAAuB,CAAC;oBACtD,KAAK,EAAE;wBACL,kBAAkB,EAAE;4BAClB,gBAAgB,EAAE,CAAC,SAAS,CAAC;4BAC7B,eAAe,EAAE,CAAC,SAAS,EAAE,sBAAsB,CAAC;yBACrD;wBACD,qBAAqB,EAAE,SAAS;wBAChC,0BAA0B,EAAE,aAAa;wBACzC,4BAA4B,EAAE,IAAI;qBACnC;iBACF;aACF;SACF,CAAC,CAAC;QACH,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS,CAC/C,kFAAkF,CACnF,CAAC;QAEF,MAAM,uBAAuB,GAAG,oBAAoB,CAAC,IAAI;aACtD,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAUb,CAAC;QACH,MAAM,CAAC,uBAAuB,CAAC,CAAC,WAAW,EAAE,CAAC;QAE9C,MAAM,aAAa,GAAG,MAAM,uBAAuB,CACjD,IAAI,GAAG,CAAC,sCAAsC,CAAC,EAC/C,eAAe,CAAC,cAAc,CAG7B,CACF,CAAC;QAEF,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC;YAC5B,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,sCAAsC;oBAC3C,QAAQ,EAAE,2BAA2B;oBACrC,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC,uBAAuB,CAAC;oBACtD,KAAK,EAAE;wBACL,EAAE,EAAE;4BACF,GAAG,EAAE;gCACH,eAAe,EAAE,CAAC,SAAS,CAAC;gCAC5B,cAAc,EAAE,CAAC,SAAS,EAAE,sBAAsB,CAAC;6BACpD;4BACD,MAAM,EAAE,SAAS;yBAClB;qBACF;iBACF;aACF;SACF,CAAC,CAAC;QACH,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS,CAC/C,iFAAiF,CAClF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mFAAmF,EAAE,KAAK,IAAI,EAAE;QACjG,MAAM,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,MAAM,0BAA0B,GAAG,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;QAClE,MAAM,cAAc,GAAG,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;QAEpD,MAAM,CAAC,cAAc,CACnB,WAAW,EACX,0BAA0B,EAC1B,cAAc,EACd,gBAAgB,CACjB,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAElD,MAAM,YAAY,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,YAAY,EAAE,CAAC,CAAC,CAAwC,CAAC;QAE5E,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC;YACnC,WAAW,EAAE,sCAAsC;SACpD,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yFAAyF,EAAE,KAAK,IAAI,EAAE;QACvG,MAAM,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,MAAM,0BAA0B,GAAG;YACjC,WAAW,EAAE,aAAa;YAC1B,KAAK,EAAE;gBACL,qCAAqC;gBACrC,EAAE,EAAE;oBACF,GAAG,EAAE;wBACH,eAAe,EAAE,CAAC,yBAAyB,CAAC;wBAC5C,cAAc,EAAE,CAAC,yBAAyB,CAAC;qBAC5C;oBACD,MAAM,EAAE,4BAA4B;oBACpC,aAAa,EAAE,KAAK;iBACrB;gBACD,iEAAiE;gBACjE,qBAAqB,EAAE,6BAA6B;gBACpD,4BAA4B,EAAE,IAAI;aACnC;SACF,CAAC;QACF,MAAM,cAAc,GAAG,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;QAEpD,MAAM,CAAC,cAAc,CACnB,eAAe,EACf,0BAA0B,EAC1B,cAAc,EACd,gBAAgB,CACjB,CAAC;QAEF,MAAM,eAAe,GAAG,oBAAoB,CAAC,IAAI;aAC9C,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAUb,CAAC;QACH,MAAM,SAAS,GAAG,uBAAuB,CAAC;QAE1C,MAAM,MAAM,GAAG,MAAM,eAAe,CAClC,IAAI,GAAG,CAAC,0CAA0C,CAAC,EACnD,eAAe,CAAC,cAAc,CAG7B,CACF,CAAC;QAEF,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAgC,CAAC;QAElE,oGAAoG;QACpG,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,OAAO,CAAC;YACvC,gBAAgB,EAAE,CAAC,SAAS,EAAE,yBAAyB,CAAC;YACxD,eAAe,EAAE;gBACf,SAAS;gBACT,sBAAsB;gBACtB,yBAAyB;aAC1B;YACD,aAAa,EAAE,SAAS;YACxB,gBAAgB,EAAE,SAAS;SAC5B,CAAC,CAAC;QAEH,wEAAwE;QACxE,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QAExE,+EAA+E;QAC/E,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEtD,+DAA+D;QAC/D,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACtE,MAAM,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,MAAM,CAAC,cAAc,CACnB,WAAW,EACX,EAAE,WAAW,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,EAClD,EAAE,WAAW,EAAE,WAAW,EAAE,EAC5B,gBAAgB,CACjB,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAElD,MAAM,YAAY,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,YAAY,EAAE,CAAC,CAAC,CAAwC,CAAC;QAE5E,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC;YACnC,WAAW,EAAE,sCAAsC;SACpD,CAAC,CAAC;QACH,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,MAAM,CAAC,cAAc,CACnB,WAAW,EACX,EAAE,WAAW,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,UAAU,CAAC,EAAE,EACnD,EAAE,WAAW,EAAE,WAAW,EAAE,EAC5B,gBAAgB,CACjB,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAElD,MAAM,YAAY,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,YAAY,EAAE,CAAC,CAAC,CAAwC,CAAC;QAE5E,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CACvD,sCAAsC,CACvC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,22 @@
1
+ import type { Adaptor, CallToolResponse, DisplayMode, HostContext, HostContextStore, RequestModalOptions, SetWidgetStateAction } from "../types.js";
2
+ export declare class AppsSdkAdaptor implements Adaptor {
3
+ private static instance;
4
+ static getInstance(): AppsSdkAdaptor;
5
+ static resetInstance(): void;
6
+ getHostContextStore<K extends keyof HostContext>(key: K): HostContextStore<K>;
7
+ callTool: <ToolArgs extends Record<string, unknown> | null = null, ToolResponse extends CallToolResponse = CallToolResponse>(name: string, args: ToolArgs) => Promise<ToolResponse>;
8
+ requestDisplayMode: (mode: DisplayMode) => Promise<{
9
+ mode: DisplayMode;
10
+ }>;
11
+ sendFollowUpMessage: (prompt: string) => Promise<void>;
12
+ openExternal(href: string): void;
13
+ setWidgetState: (stateOrUpdater: SetWidgetStateAction) => Promise<void>;
14
+ uploadFile: (file: File) => Promise<import("../types.js").FileMetadata>;
15
+ getFileDownloadUrl: (file: {
16
+ fileId: string;
17
+ }) => Promise<{
18
+ downloadUrl: string;
19
+ }>;
20
+ openModal(options: RequestModalOptions): Promise<void>;
21
+ setOpenInAppUrl(href: string): Promise<void>;
22
+ }
@@ -0,0 +1,80 @@
1
+ import { AppsSdkBridge } from "./bridge.js";
2
+ export class AppsSdkAdaptor {
3
+ static instance = null;
4
+ static getInstance() {
5
+ if (!AppsSdkAdaptor.instance) {
6
+ AppsSdkAdaptor.instance = new AppsSdkAdaptor();
7
+ }
8
+ return AppsSdkAdaptor.instance;
9
+ }
10
+ static resetInstance() {
11
+ AppsSdkAdaptor.instance = null;
12
+ }
13
+ getHostContextStore(key) {
14
+ const bridge = AppsSdkBridge.getInstance();
15
+ if (key === "widgetState") {
16
+ return {
17
+ subscribe: bridge.subscribe("widgetState"),
18
+ getSnapshot: () => bridge.getSnapshot("widgetState")?.modelContent ?? null,
19
+ };
20
+ }
21
+ return {
22
+ subscribe: bridge.subscribe(key),
23
+ getSnapshot: () => bridge.getSnapshot(key),
24
+ };
25
+ }
26
+ callTool = async (name, args) => {
27
+ return window.openai.callTool(name, args);
28
+ };
29
+ requestDisplayMode = (mode) => {
30
+ return window.openai.requestDisplayMode({ mode });
31
+ };
32
+ sendFollowUpMessage = (prompt) => {
33
+ return window.openai.sendFollowUpMessage({ prompt });
34
+ };
35
+ openExternal(href) {
36
+ window.openai.openExternal({ href });
37
+ }
38
+ setWidgetState = (stateOrUpdater) => {
39
+ const modelContent = typeof stateOrUpdater === "function"
40
+ ? stateOrUpdater(window.openai.widgetState?.modelContent ?? null)
41
+ : stateOrUpdater;
42
+ return window.openai.setWidgetState({ modelContent });
43
+ };
44
+ uploadFile = (file) => {
45
+ return window.openai.uploadFile(file).then(async (metadata) => {
46
+ const state = window.openai.widgetState
47
+ ? { ...window.openai.widgetState }
48
+ : { modelContent: {} };
49
+ if (!state.imageIds) {
50
+ state.imageIds = [];
51
+ }
52
+ state.imageIds.push(metadata.fileId);
53
+ await window.openai.setWidgetState(state);
54
+ return metadata;
55
+ });
56
+ };
57
+ getFileDownloadUrl = (file) => {
58
+ return window.openai.getFileDownloadUrl(file);
59
+ };
60
+ openModal(options) {
61
+ return window.openai.requestModal(options);
62
+ }
63
+ setOpenInAppUrl(href) {
64
+ href = href.trim();
65
+ if (!href) {
66
+ throw new Error("The href parameter is required.");
67
+ }
68
+ const serverUrl = window.skybridge.serverUrl;
69
+ if (!serverUrl) {
70
+ throw new Error("The widgetDomain property has not been set on the widget resource meta object.");
71
+ }
72
+ const domainUrl = new URL(serverUrl);
73
+ const hrefUrl = new URL(href, serverUrl);
74
+ if (domainUrl.origin !== hrefUrl.origin) {
75
+ throw new Error("Provided href is not compatible with widget domain: origin differs");
76
+ }
77
+ return window.openai.setOpenInAppUrl({ href });
78
+ }
79
+ }
80
+ //# sourceMappingURL=adaptor.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"adaptor.js","sourceRoot":"","sources":["../../../../src/web/bridges/apps-sdk/adaptor.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C,MAAM,OAAO,cAAc;IACjB,MAAM,CAAC,QAAQ,GAA0B,IAAI,CAAC;IAE/C,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;YAC7B,cAAc,CAAC,QAAQ,GAAG,IAAI,cAAc,EAAE,CAAC;QACjD,CAAC;QACD,OAAO,cAAc,CAAC,QAAQ,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,aAAa;QACzB,cAAc,CAAC,QAAQ,GAAG,IAAI,CAAC;IACjC,CAAC;IAEM,mBAAmB,CACxB,GAAM;QAEN,MAAM,MAAM,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QAE3C,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;YAC1B,OAAO;gBACL,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC;gBAC1C,WAAW,EAAE,GAAG,EAAE,CAChB,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,YAAY,IAAI,IAAI;aACnC,CAAC;QAC3B,CAAC;QAED,OAAO;YACL,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;YAChC,WAAW,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC;SAC3C,CAAC;IACJ,CAAC;IAEM,QAAQ,GAAG,KAAK,EAIrB,IAAY,EACZ,IAAc,EACS,EAAE;QACzB,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAyB,IAAI,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC,CAAC;IAEK,kBAAkB,GAAG,CAC1B,IAAiB,EACe,EAAE;QAClC,OAAO,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IACpD,CAAC,CAAC;IAEK,mBAAmB,GAAG,CAAC,MAAc,EAAiB,EAAE;QAC7D,OAAO,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC,CAAC;IAEK,YAAY,CAAC,IAAY;QAC9B,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IACvC,CAAC;IAEM,cAAc,GAAG,CACtB,cAAoC,EACrB,EAAE;QACjB,MAAM,YAAY,GAChB,OAAO,cAAc,KAAK,UAAU;YAClC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,IAAI,IAAI,CAAC;YACjE,CAAC,CAAC,cAAc,CAAC;QAErB,OAAO,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC;IAEK,UAAU,GAAG,CAAC,IAAU,EAAE,EAAE;QACjC,OAAO,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YAC5D,MAAM,KAAK,GAAgB,MAAM,CAAC,MAAM,CAAC,WAAW;gBAClD,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE;gBAClC,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;YACzB,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACpB,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC;YACtB,CAAC;YACD,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACrC,MAAM,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC1C,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEK,kBAAkB,GAAG,CAAC,IAAwB,EAAE,EAAE;QACvD,OAAO,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC,CAAC;IAEK,SAAS,CAAC,OAA4B;QAC3C,OAAO,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAEM,eAAe,CAAC,IAAY;QACjC,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAEnB,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC;QAC7C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,gFAAgF,CACjF,CAAC;QACJ,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAEzC,IAAI,SAAS,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC"}
@@ -0,0 +1,10 @@
1
+ import type { Bridge, Subscribe } from "../types.js";
2
+ import { type AppsSdkContext } from "./types.js";
3
+ export declare class AppsSdkBridge implements Bridge<AppsSdkContext> {
4
+ private static instance;
5
+ static getInstance(): AppsSdkBridge;
6
+ static resetInstance(): void;
7
+ subscribe(key: keyof AppsSdkContext): Subscribe;
8
+ subscribe(keys: readonly (keyof AppsSdkContext)[]): Subscribe;
9
+ getSnapshot: <K extends keyof AppsSdkContext>(key: K) => (import("./types.js").AppsSdkMethods<import("./types.js").WidgetState> & AppsSdkContext<Record<never, unknown>, import("../../types.js").UnknownObject, import("../../types.js").UnknownObject, import("./types.js").WidgetState>)[K];
10
+ }
@@ -0,0 +1,46 @@
1
+ import { SET_GLOBALS_EVENT_TYPE, } from "./types.js";
2
+ export class AppsSdkBridge {
3
+ static instance = null;
4
+ static getInstance() {
5
+ if (window.skybridge.hostType !== "apps-sdk" ||
6
+ window.openai === undefined) {
7
+ throw new Error("Apps SDK Bridge can only be used in the apps-sdk runtime");
8
+ }
9
+ if (AppsSdkBridge.instance === null) {
10
+ AppsSdkBridge.instance = new AppsSdkBridge();
11
+ }
12
+ return AppsSdkBridge.instance;
13
+ }
14
+ static resetInstance() {
15
+ if (AppsSdkBridge.instance) {
16
+ AppsSdkBridge.instance = null;
17
+ }
18
+ }
19
+ subscribe(keyOrKeys) {
20
+ const keys = Array.isArray(keyOrKeys)
21
+ ? keyOrKeys
22
+ : [keyOrKeys];
23
+ return (onChange) => {
24
+ const handleSetGlobal = (event) => {
25
+ const hasRelevantChange = keys.some((key) => event.detail.globals[key] !== undefined);
26
+ if (!hasRelevantChange) {
27
+ return;
28
+ }
29
+ onChange();
30
+ };
31
+ window.addEventListener(SET_GLOBALS_EVENT_TYPE, handleSetGlobal, {
32
+ passive: true,
33
+ });
34
+ return () => {
35
+ window.removeEventListener(SET_GLOBALS_EVENT_TYPE, handleSetGlobal);
36
+ };
37
+ };
38
+ }
39
+ getSnapshot = (key) => {
40
+ if (window.openai === undefined) {
41
+ throw new Error(`window.openai is not available. Make sure you're calling the hook requiring ${key} within the OpenAI iFrame skybridge runtime.`);
42
+ }
43
+ return window.openai[key];
44
+ };
45
+ }
46
+ //# sourceMappingURL=bridge.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"bridge.js","sourceRoot":"","sources":["../../../../src/web/bridges/apps-sdk/bridge.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,sBAAsB,GAEvB,MAAM,YAAY,CAAC;AAEpB,MAAM,OAAO,aAAa;IAChB,MAAM,CAAC,QAAQ,GAAyB,IAAI,CAAC;IAE9C,MAAM,CAAC,WAAW;QACvB,IACE,MAAM,CAAC,SAAS,CAAC,QAAQ,KAAK,UAAU;YACxC,MAAM,CAAC,MAAM,KAAK,SAAS,EAC3B,CAAC;YACD,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;QACJ,CAAC;QACD,IAAI,aAAa,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YACpC,aAAa,CAAC,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;QAC/C,CAAC;QACD,OAAO,aAAa,CAAC,QAAQ,CAAC;IAChC,CAAC;IAEM,MAAM,CAAC,aAAa;QACzB,IAAI,aAAa,CAAC,QAAQ,EAAE,CAAC;YAC3B,aAAa,CAAC,QAAQ,GAAG,IAAI,CAAC;QAChC,CAAC;IACH,CAAC;IAIM,SAAS,CACd,SAAmE;QAEnE,MAAM,IAAI,GAAsC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;YACtE,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAChB,OAAO,CAAC,QAAoB,EAAE,EAAE;YAC9B,MAAM,eAAe,GAAG,CAAC,KAAsB,EAAE,EAAE;gBACjD,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CACjC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,CACjD,CAAC;gBACF,IAAI,CAAC,iBAAiB,EAAE,CAAC;oBACvB,OAAO;gBACT,CAAC;gBACD,QAAQ,EAAE,CAAC;YACb,CAAC,CAAC;YAEF,MAAM,CAAC,gBAAgB,CAAC,sBAAsB,EAAE,eAAe,EAAE;gBAC/D,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;YAEH,OAAO,GAAG,EAAE;gBACV,MAAM,CAAC,mBAAmB,CAAC,sBAAsB,EAAE,eAAe,CAAC,CAAC;YACtE,CAAC,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAEM,WAAW,GAAG,CAAiC,GAAM,EAAE,EAAE;QAC9D,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CACb,+EAA+E,GAAG,8CAA8C,CACjI,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC,CAAC"}
@@ -0,0 +1,5 @@
1
+ export { AppsSdkAdaptor } from "./adaptor.js";
2
+ export { AppsSdkBridge } from "./bridge.js";
3
+ export type { AppsSdkContext, AppsSdkMethods, ToolResponseEvent, } from "./types.js";
4
+ export { SET_GLOBALS_EVENT_TYPE, SetGlobalsEvent, TOOL_RESPONSE_EVENT_TYPE, } from "./types.js";
5
+ export { useAppsSdkContext } from "./use-apps-sdk-context.js";
@@ -0,0 +1,5 @@
1
+ export { AppsSdkAdaptor } from "./adaptor.js";
2
+ export { AppsSdkBridge } from "./bridge.js";
3
+ export { SET_GLOBALS_EVENT_TYPE, SetGlobalsEvent, TOOL_RESPONSE_EVENT_TYPE, } from "./types.js";
4
+ export { useAppsSdkContext } from "./use-apps-sdk-context.js";
5
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/web/bridges/apps-sdk/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAM5C,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,wBAAwB,GACzB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC"}
@@ -1,21 +1,9 @@
1
- import "react";
2
- declare module "react" {
3
- interface HTMLAttributes<T extends Element = HTMLElement> {
4
- "data-llm"?: string;
5
- }
6
- }
7
- export type UnknownObject = Record<string, unknown>;
8
- export type Prettify<T> = {
9
- [K in keyof T]: T[K];
10
- } & {};
11
- export type Objectify<T> = T & UnknownObject;
12
- type RequiredKeys<T> = {
13
- [K in keyof T]-?: {} extends Pick<T, K> ? never : K;
14
- }[keyof T];
15
- export type HasRequiredKeys<T> = RequiredKeys<T> extends never ? false : true;
16
- type WidgetState = UnknownObject;
17
- type FileMetadata = {
18
- fileId: string;
1
+ import type { UnknownObject } from "../../types.js";
2
+ import type { CallToolArgs, CallToolResponse, FileMetadata, RequestModalOptions } from "../types.js";
3
+ type DisplayMode = "pip" | "inline" | "fullscreen" | "modal";
4
+ export type WidgetState = {
5
+ modelContent: Record<string, unknown>;
6
+ imageIds?: string[];
19
7
  };
20
8
  export declare const TOOL_RESPONSE_EVENT_TYPE = "openai:tool_response";
21
9
  export declare class ToolResponseEvent extends CustomEvent<{
@@ -28,38 +16,28 @@ export declare class ToolResponseEvent extends CustomEvent<{
28
16
  }
29
17
  declare global {
30
18
  interface Window {
31
- openai: API<WidgetState> & OpenAiGlobals;
19
+ openai: AppsSdkMethods & AppsSdkContext;
32
20
  }
33
21
  interface WindowEventMap {
34
22
  [SET_GLOBALS_EVENT_TYPE]: SetGlobalsEvent;
35
23
  }
36
24
  }
37
- export type OpenAiGlobals<ToolInput extends UnknownObject = {}, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject, WidgetState extends UnknownObject = UnknownObject> = {
25
+ export type AppsSdkContext<ToolInput extends UnknownObject = Record<never, unknown>, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject, WS extends WidgetState = WidgetState> = {
38
26
  theme: Theme;
39
27
  userAgent: UserAgent;
40
28
  locale: string;
41
- maxHeight: number;
29
+ maxHeight: number | undefined;
42
30
  displayMode: DisplayMode;
43
31
  safeArea: SafeArea;
32
+ view: View;
44
33
  toolInput: ToolInput;
45
34
  toolOutput: ToolOutput | {
46
35
  text: string;
47
36
  } | null;
48
37
  toolResponseMetadata: ToolResponseMetadata | null;
49
- widgetState: WidgetState | null;
38
+ widgetState: WS | null;
50
39
  };
51
- export type CallToolArgs = Record<string, unknown> | null;
52
- export type CallToolResponse = {
53
- content: {
54
- type: "text";
55
- text: string;
56
- }[];
57
- structuredContent: Record<string, unknown>;
58
- isError: boolean;
59
- result: string;
60
- meta: Record<string, unknown>;
61
- };
62
- type API<WidgetState extends UnknownObject> = {
40
+ export type AppsSdkMethods<WS extends WidgetState = WidgetState> = {
63
41
  /** Calls a tool on your MCP. Returns the full response. */
64
42
  callTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends CallToolResponse = CallToolResponse>(name: string, args: ToolArgs) => Promise<ToolResponse>;
65
43
  /** Triggers a followup turn in the ChatGPT conversation */
@@ -84,44 +62,51 @@ type API<WidgetState extends UnknownObject> = {
84
62
  * Sets the widget state.
85
63
  * This state is persisted across widget renders.
86
64
  */
87
- setWidgetState: (state: WidgetState) => Promise<void>;
65
+ setWidgetState: (state: WS) => Promise<void>;
88
66
  /**
89
67
  * Opens a modal portaled outside of the widget iFrame.
90
68
  * This ensures the modal is correctly displayed and not limited to the widget's area.
91
69
  */
92
- requestModal: (args: {
93
- title: string;
94
- }) => Promise<void>;
70
+ requestModal: (args: RequestModalOptions) => Promise<void>;
95
71
  /** Uploads a new file to the host */
96
72
  uploadFile: (file: File) => Promise<FileMetadata>;
97
73
  /**
98
74
  * Downloads a file from the host that was previously uploaded.
99
75
  * Only files uploaded by the same connector instance can be downloaded.
100
76
  */
101
- downloadFile: (file: FileMetadata) => Promise<{
77
+ getFileDownloadUrl: (file: FileMetadata) => Promise<{
102
78
  downloadUrl: string;
103
79
  }>;
80
+ /**
81
+ * Sets the open in app URL.
82
+ * This URL will be opened in the app when the user clicks on the top right button in fullscreen mode.
83
+ */
84
+ setOpenInAppUrl: (args: {
85
+ href: string;
86
+ }) => Promise<void>;
104
87
  };
105
88
  export declare const SET_GLOBALS_EVENT_TYPE = "openai:set_globals";
106
89
  export declare class SetGlobalsEvent extends CustomEvent<{
107
- globals: Partial<OpenAiGlobals>;
90
+ globals: Partial<AppsSdkContext>;
108
91
  }> {
109
92
  readonly type = "openai:set_globals";
110
93
  }
111
- export type CallTool = (name: string, args: Record<string, unknown>) => Promise<CallToolResponse>;
112
- export type DisplayMode = "pip" | "inline" | "fullscreen";
113
- export type Theme = "light" | "dark";
114
- export type SafeAreaInsets = {
94
+ type View = {
95
+ mode: DisplayMode;
96
+ params?: Record<string, unknown>;
97
+ };
98
+ type Theme = "light" | "dark";
99
+ type SafeAreaInsets = {
115
100
  top: number;
116
101
  bottom: number;
117
102
  left: number;
118
103
  right: number;
119
104
  };
120
- export type SafeArea = {
105
+ type SafeArea = {
121
106
  insets: SafeAreaInsets;
122
107
  };
123
- export type DeviceType = "mobile" | "tablet" | "desktop" | "unknown";
124
- export type UserAgent = {
108
+ type DeviceType = "mobile" | "tablet" | "desktop" | "unknown";
109
+ type UserAgent = {
125
110
  device: {
126
111
  type: DeviceType;
127
112
  };
@@ -1,4 +1,3 @@
1
- import "react";
2
1
  export const TOOL_RESPONSE_EVENT_TYPE = "openai:tool_response";
3
2
  export class ToolResponseEvent extends CustomEvent {
4
3
  type = TOOL_RESPONSE_EVENT_TYPE;
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/web/bridges/apps-sdk/types.ts"],"names":[],"mappings":"AAeA,MAAM,CAAC,MAAM,wBAAwB,GAAG,sBAAsB,CAAC;AAC/D,MAAM,OAAO,iBAAkB,SAAQ,WAErC;IACkB,IAAI,GAAG,wBAAwB,CAAC;CACnD;AAwFD,sDAAsD;AACtD,MAAM,CAAC,MAAM,sBAAsB,GAAG,oBAAoB,CAAC;AAC3D,MAAM,OAAO,eAAgB,SAAQ,WAEnC;IACkB,IAAI,GAAG,sBAAsB,CAAC;CACjD"}
@@ -0,0 +1,2 @@
1
+ import type { AppsSdkContext } from "./types.js";
2
+ export declare function useAppsSdkContext<K extends keyof AppsSdkContext>(key: K): AppsSdkContext[K];