skybridge 0.0.0-dev.bdad773 → 0.0.0-dev.bdbb6a7

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 (284) hide show
  1. package/README.md +153 -0
  2. package/bin/run.js +0 -4
  3. package/dist/cli/detect-port.d.ts +18 -0
  4. package/dist/cli/detect-port.js +61 -0
  5. package/dist/cli/detect-port.js.map +1 -0
  6. package/dist/cli/header.js +1 -1
  7. package/dist/cli/header.js.map +1 -1
  8. package/dist/cli/telemetry.d.ts +7 -0
  9. package/dist/cli/telemetry.js +123 -0
  10. package/dist/cli/telemetry.js.map +1 -0
  11. package/dist/cli/tunnel-control-server.d.ts +9 -0
  12. package/dist/cli/tunnel-control-server.js +31 -0
  13. package/dist/cli/tunnel-control-server.js.map +1 -0
  14. package/dist/cli/tunnel-control-server.test.js +39 -0
  15. package/dist/cli/tunnel-control-server.test.js.map +1 -0
  16. package/dist/cli/tunnel-handler.d.ts +3 -0
  17. package/dist/cli/tunnel-handler.js +48 -0
  18. package/dist/cli/tunnel-handler.js.map +1 -0
  19. package/dist/cli/tunnel-handler.test.js +105 -0
  20. package/dist/cli/tunnel-handler.test.js.map +1 -0
  21. package/dist/cli/tunnel.d.ts +57 -0
  22. package/dist/cli/tunnel.js +154 -0
  23. package/dist/cli/tunnel.js.map +1 -0
  24. package/dist/cli/tunnel.test.js +190 -0
  25. package/dist/cli/tunnel.test.js.map +1 -0
  26. package/dist/cli/types.d.ts +5 -0
  27. package/dist/cli/types.js +2 -0
  28. package/dist/cli/types.js.map +1 -0
  29. package/dist/cli/use-execute-steps.d.ts +3 -2
  30. package/dist/cli/use-execute-steps.js +6 -1
  31. package/dist/cli/use-execute-steps.js.map +1 -1
  32. package/dist/cli/use-messages.d.ts +3 -0
  33. package/dist/cli/use-messages.js +11 -0
  34. package/dist/cli/use-messages.js.map +1 -0
  35. package/dist/cli/use-nodemon.d.ts +2 -0
  36. package/dist/cli/use-nodemon.js +64 -0
  37. package/dist/cli/use-nodemon.js.map +1 -0
  38. package/dist/cli/use-open-browser.d.ts +1 -0
  39. package/dist/cli/use-open-browser.js +44 -0
  40. package/dist/cli/use-open-browser.js.map +1 -0
  41. package/dist/cli/use-tunnel.d.ts +14 -0
  42. package/dist/cli/use-tunnel.js +131 -0
  43. package/dist/cli/use-tunnel.js.map +1 -0
  44. package/dist/cli/use-typescript-check.d.ts +9 -0
  45. package/dist/cli/use-typescript-check.js +94 -0
  46. package/dist/cli/use-typescript-check.js.map +1 -0
  47. package/dist/commands/build.js +64 -6
  48. package/dist/commands/build.js.map +1 -1
  49. package/dist/commands/dev.d.ts +6 -1
  50. package/dist/commands/dev.js +69 -9
  51. package/dist/commands/dev.js.map +1 -1
  52. package/dist/commands/start.d.ts +3 -1
  53. package/dist/commands/start.js +31 -15
  54. package/dist/commands/start.js.map +1 -1
  55. package/dist/commands/telemetry/disable.d.ts +5 -0
  56. package/dist/commands/telemetry/disable.js +14 -0
  57. package/dist/commands/telemetry/disable.js.map +1 -0
  58. package/dist/commands/telemetry/enable.d.ts +5 -0
  59. package/dist/commands/telemetry/enable.js +14 -0
  60. package/dist/commands/telemetry/enable.js.map +1 -0
  61. package/dist/commands/telemetry/status.d.ts +5 -0
  62. package/dist/commands/telemetry/status.js +14 -0
  63. package/dist/commands/telemetry/status.js.map +1 -0
  64. package/dist/server/asset-base-url-transform-plugin.d.ts +10 -0
  65. package/dist/server/asset-base-url-transform-plugin.js +33 -0
  66. package/dist/server/asset-base-url-transform-plugin.js.map +1 -0
  67. package/dist/server/asset-base-url-transform-plugin.test.d.ts +1 -0
  68. package/dist/server/asset-base-url-transform-plugin.test.js +84 -0
  69. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -0
  70. package/dist/server/content-helpers.d.ts +27 -0
  71. package/dist/server/content-helpers.js +46 -0
  72. package/dist/server/content-helpers.js.map +1 -0
  73. package/dist/server/content-helpers.test.d.ts +1 -0
  74. package/dist/server/content-helpers.test.js +70 -0
  75. package/dist/server/content-helpers.test.js.map +1 -0
  76. package/dist/server/express.d.ts +15 -0
  77. package/dist/server/express.js +103 -0
  78. package/dist/server/express.js.map +1 -0
  79. package/dist/server/express.test.d.ts +1 -0
  80. package/dist/server/express.test.js +348 -0
  81. package/dist/server/express.test.js.map +1 -0
  82. package/dist/server/index.d.ts +5 -3
  83. package/dist/server/index.js +3 -2
  84. package/dist/server/index.js.map +1 -1
  85. package/dist/server/inferUtilityTypes.d.ts +6 -6
  86. package/dist/server/metric.d.ts +14 -0
  87. package/dist/server/metric.js +62 -0
  88. package/dist/server/metric.js.map +1 -0
  89. package/dist/server/middleware.d.ts +124 -0
  90. package/dist/server/middleware.js +93 -0
  91. package/dist/server/middleware.js.map +1 -0
  92. package/dist/server/middleware.test-d.d.ts +1 -0
  93. package/dist/server/middleware.test-d.js +75 -0
  94. package/dist/server/middleware.test-d.js.map +1 -0
  95. package/dist/server/middleware.test.d.ts +1 -0
  96. package/dist/server/middleware.test.js +493 -0
  97. package/dist/server/middleware.test.js.map +1 -0
  98. package/dist/server/server.d.ts +149 -61
  99. package/dist/server/server.js +412 -85
  100. package/dist/server/server.js.map +1 -1
  101. package/dist/server/templateHelper.d.ts +5 -7
  102. package/dist/server/templateHelper.js +3 -22
  103. package/dist/server/templateHelper.js.map +1 -1
  104. package/dist/server/templates.generated.d.ts +4 -0
  105. package/dist/server/templates.generated.js +47 -0
  106. package/dist/server/templates.generated.js.map +1 -0
  107. package/dist/server/tunnel-proxy-router.d.ts +7 -0
  108. package/dist/server/tunnel-proxy-router.js +110 -0
  109. package/dist/server/tunnel-proxy-router.js.map +1 -0
  110. package/dist/server/tunnel-proxy-router.test.d.ts +1 -0
  111. package/dist/server/tunnel-proxy-router.test.js +229 -0
  112. package/dist/server/tunnel-proxy-router.test.js.map +1 -0
  113. package/dist/server/viewsDevServer.d.ts +14 -0
  114. package/dist/server/viewsDevServer.js +45 -0
  115. package/dist/server/viewsDevServer.js.map +1 -0
  116. package/dist/test/utils.d.ts +13 -21
  117. package/dist/test/utils.js +42 -37
  118. package/dist/test/utils.js.map +1 -1
  119. package/dist/test/view.test.d.ts +1 -0
  120. package/dist/test/view.test.js +523 -0
  121. package/dist/test/view.test.js.map +1 -0
  122. package/dist/version.d.ts +1 -0
  123. package/dist/version.js +3 -0
  124. package/dist/version.js.map +1 -0
  125. package/dist/web/bridges/apps-sdk/adaptor.d.ts +15 -5
  126. package/dist/web/bridges/apps-sdk/adaptor.js +60 -6
  127. package/dist/web/bridges/apps-sdk/adaptor.js.map +1 -1
  128. package/dist/web/bridges/apps-sdk/bridge.d.ts +5 -5
  129. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -1
  130. package/dist/web/bridges/apps-sdk/index.d.ts +2 -2
  131. package/dist/web/bridges/apps-sdk/index.js +1 -1
  132. package/dist/web/bridges/apps-sdk/index.js.map +1 -1
  133. package/dist/web/bridges/apps-sdk/types.d.ts +32 -27
  134. package/dist/web/bridges/apps-sdk/types.js.map +1 -1
  135. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +2 -0
  136. package/dist/web/bridges/apps-sdk/{use-apps-sdk-bridge.js → use-apps-sdk-context.js} +2 -2
  137. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -0
  138. package/dist/web/bridges/mcp-app/adaptor.d.ts +36 -7
  139. package/dist/web/bridges/mcp-app/adaptor.js +173 -50
  140. package/dist/web/bridges/mcp-app/adaptor.js.map +1 -1
  141. package/dist/web/bridges/mcp-app/bridge.d.ts +18 -35
  142. package/dist/web/bridges/mcp-app/bridge.js +43 -197
  143. package/dist/web/bridges/mcp-app/bridge.js.map +1 -1
  144. package/dist/web/bridges/mcp-app/index.d.ts +2 -2
  145. package/dist/web/bridges/mcp-app/index.js +1 -1
  146. package/dist/web/bridges/mcp-app/index.js.map +1 -1
  147. package/dist/web/bridges/mcp-app/types.d.ts +2 -2
  148. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +7 -0
  149. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +7 -0
  150. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -0
  151. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.d.ts +1 -0
  152. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js +26 -0
  153. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -0
  154. package/dist/web/bridges/types.d.ts +45 -10
  155. package/dist/web/components/modal-provider.d.ts +4 -0
  156. package/dist/web/components/modal-provider.js +45 -0
  157. package/dist/web/components/modal-provider.js.map +1 -0
  158. package/dist/web/create-store.js +18 -4
  159. package/dist/web/create-store.js.map +1 -1
  160. package/dist/web/create-store.test.js +25 -21
  161. package/dist/web/create-store.test.js.map +1 -1
  162. package/dist/web/data-llm.d.ts +1 -1
  163. package/dist/web/data-llm.js +4 -4
  164. package/dist/web/data-llm.js.map +1 -1
  165. package/dist/web/data-llm.test.js +34 -32
  166. package/dist/web/data-llm.test.js.map +1 -1
  167. package/dist/web/generate-helpers.d.ts +20 -18
  168. package/dist/web/generate-helpers.js +20 -18
  169. package/dist/web/generate-helpers.js.map +1 -1
  170. package/dist/web/generate-helpers.test-d.js +26 -26
  171. package/dist/web/generate-helpers.test-d.js.map +1 -1
  172. package/dist/web/helpers/state.d.ts +2 -2
  173. package/dist/web/helpers/state.js +12 -12
  174. package/dist/web/helpers/state.js.map +1 -1
  175. package/dist/web/helpers/state.test.js +9 -9
  176. package/dist/web/helpers/state.test.js.map +1 -1
  177. package/dist/web/hooks/index.d.ts +3 -2
  178. package/dist/web/hooks/index.js +2 -1
  179. package/dist/web/hooks/index.js.map +1 -1
  180. package/dist/web/hooks/test/utils.js +4 -0
  181. package/dist/web/hooks/test/utils.js.map +1 -1
  182. package/dist/web/hooks/use-call-tool.d.ts +1 -1
  183. package/dist/web/hooks/use-call-tool.js +1 -1
  184. package/dist/web/hooks/use-call-tool.js.map +1 -1
  185. package/dist/web/hooks/use-display-mode.d.ts +3 -3
  186. package/dist/web/hooks/use-display-mode.js +1 -1
  187. package/dist/web/hooks/use-display-mode.js.map +1 -1
  188. package/dist/web/hooks/use-display-mode.test-d.d.ts +1 -0
  189. package/dist/web/hooks/use-display-mode.test-d.js +8 -0
  190. package/dist/web/hooks/use-display-mode.test-d.js.map +1 -0
  191. package/dist/web/hooks/use-files.d.ts +3 -6
  192. package/dist/web/hooks/use-files.js +5 -2
  193. package/dist/web/hooks/use-files.js.map +1 -1
  194. package/dist/web/hooks/use-files.test.js +28 -3
  195. package/dist/web/hooks/use-files.test.js.map +1 -1
  196. package/dist/web/hooks/use-layout.d.ts +2 -2
  197. package/dist/web/hooks/use-layout.js +1 -1
  198. package/dist/web/hooks/use-layout.js.map +1 -1
  199. package/dist/web/hooks/use-layout.test.js +5 -4
  200. package/dist/web/hooks/use-layout.test.js.map +1 -1
  201. package/dist/web/hooks/use-open-external.d.ts +3 -1
  202. package/dist/web/hooks/use-open-external.js +2 -2
  203. package/dist/web/hooks/use-open-external.js.map +1 -1
  204. package/dist/web/hooks/use-open-external.test.js +26 -11
  205. package/dist/web/hooks/use-open-external.test.js.map +1 -1
  206. package/dist/web/hooks/use-request-modal.d.ts +3 -3
  207. package/dist/web/hooks/use-request-modal.js +10 -8
  208. package/dist/web/hooks/use-request-modal.js.map +1 -1
  209. package/dist/web/hooks/use-request-modal.test.js +5 -1
  210. package/dist/web/hooks/use-request-modal.test.js.map +1 -1
  211. package/dist/web/hooks/use-send-follow-up-message.js +1 -1
  212. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -1
  213. package/dist/web/hooks/use-set-open-in-app-url.d.ts +1 -0
  214. package/dist/web/hooks/use-set-open-in-app-url.js +8 -0
  215. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -0
  216. package/dist/web/hooks/use-set-open-in-app-url.test.d.ts +1 -0
  217. package/dist/web/hooks/use-set-open-in-app-url.test.js +43 -0
  218. package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -0
  219. package/dist/web/hooks/use-tool-info.js +1 -1
  220. package/dist/web/hooks/use-tool-info.js.map +1 -1
  221. package/dist/web/hooks/use-tool-info.test.js +5 -4
  222. package/dist/web/hooks/use-tool-info.test.js.map +1 -1
  223. package/dist/web/hooks/use-user.d.ts +1 -1
  224. package/dist/web/hooks/use-user.js +19 -3
  225. package/dist/web/hooks/use-user.js.map +1 -1
  226. package/dist/web/hooks/use-user.test.js +31 -2
  227. package/dist/web/hooks/use-user.test.js.map +1 -1
  228. package/dist/web/hooks/use-view-state.d.ts +4 -0
  229. package/dist/web/hooks/use-view-state.js +32 -0
  230. package/dist/web/hooks/use-view-state.js.map +1 -0
  231. package/dist/web/hooks/use-view-state.test.d.ts +1 -0
  232. package/dist/web/hooks/use-view-state.test.js +177 -0
  233. package/dist/web/hooks/use-view-state.test.js.map +1 -0
  234. package/dist/web/index.d.ts +1 -2
  235. package/dist/web/index.js +1 -2
  236. package/dist/web/index.js.map +1 -1
  237. package/dist/web/mount-view.d.ts +1 -0
  238. package/dist/web/{mount-widget.js → mount-view.js} +11 -3
  239. package/dist/web/mount-view.js.map +1 -0
  240. package/dist/web/plugin/plugin.d.ts +4 -1
  241. package/dist/web/plugin/plugin.js +135 -18
  242. package/dist/web/plugin/plugin.js.map +1 -1
  243. package/dist/web/plugin/scan-views.d.ts +16 -0
  244. package/dist/web/plugin/scan-views.js +88 -0
  245. package/dist/web/plugin/scan-views.js.map +1 -0
  246. package/dist/web/plugin/scan-views.test.d.ts +1 -0
  247. package/dist/web/plugin/scan-views.test.js +99 -0
  248. package/dist/web/plugin/scan-views.test.js.map +1 -0
  249. package/dist/web/plugin/transform-data-llm.js +1 -1
  250. package/dist/web/plugin/transform-data-llm.js.map +1 -1
  251. package/dist/web/plugin/validate-view.d.ts +1 -0
  252. package/dist/web/plugin/validate-view.js +9 -0
  253. package/dist/web/plugin/validate-view.js.map +1 -0
  254. package/dist/web/plugin/validate-view.test.d.ts +1 -0
  255. package/dist/web/plugin/validate-view.test.js +24 -0
  256. package/dist/web/plugin/validate-view.test.js.map +1 -0
  257. package/dist/web/proxy.js +0 -1
  258. package/dist/web/proxy.js.map +1 -1
  259. package/package.json +50 -31
  260. package/tsconfig.base.json +33 -0
  261. package/dist/server/templates/development.hbs +0 -66
  262. package/dist/server/templates/production.hbs +0 -7
  263. package/dist/server/widgetsDevServer.d.ts +0 -12
  264. package/dist/server/widgetsDevServer.js +0 -47
  265. package/dist/server/widgetsDevServer.js.map +0 -1
  266. package/dist/test/widget.test.js +0 -234
  267. package/dist/test/widget.test.js.map +0 -1
  268. package/dist/web/bridges/apps-sdk/use-apps-sdk-bridge.d.ts +0 -2
  269. package/dist/web/bridges/apps-sdk/use-apps-sdk-bridge.js.map +0 -1
  270. package/dist/web/bridges/mcp-app/use-mcp-app-bridge.d.ts +0 -5
  271. package/dist/web/bridges/mcp-app/use-mcp-app-bridge.js +0 -7
  272. package/dist/web/bridges/mcp-app/use-mcp-app-bridge.js.map +0 -1
  273. package/dist/web/bridges/mcp-app/use-mcp-app-bridge.test.js +0 -57
  274. package/dist/web/bridges/mcp-app/use-mcp-app-bridge.test.js.map +0 -1
  275. package/dist/web/hooks/use-widget-state.d.ts +0 -4
  276. package/dist/web/hooks/use-widget-state.js +0 -32
  277. package/dist/web/hooks/use-widget-state.js.map +0 -1
  278. package/dist/web/hooks/use-widget-state.test.js +0 -61
  279. package/dist/web/hooks/use-widget-state.test.js.map +0 -1
  280. package/dist/web/mount-widget.d.ts +0 -1
  281. package/dist/web/mount-widget.js.map +0 -1
  282. /package/dist/{test/widget.test.d.ts → cli/tunnel-control-server.test.d.ts} +0 -0
  283. /package/dist/{web/bridges/mcp-app/use-mcp-app-bridge.test.d.ts → cli/tunnel-handler.test.d.ts} +0 -0
  284. /package/dist/{web/hooks/use-widget-state.test.d.ts → cli/tunnel.test.d.ts} +0 -0
@@ -12,6 +12,18 @@ export class AppsSdkAdaptor {
12
12
  }
13
13
  getHostContextStore(key) {
14
14
  const bridge = AppsSdkBridge.getInstance();
15
+ if (key === "viewState") {
16
+ return {
17
+ subscribe: bridge.subscribe("widgetState"),
18
+ getSnapshot: () => bridge.getSnapshot("widgetState")?.modelContent ?? null,
19
+ };
20
+ }
21
+ if (key === "display") {
22
+ return {
23
+ subscribe: bridge.subscribe("view"),
24
+ getSnapshot: () => bridge.getSnapshot("view"),
25
+ };
26
+ }
15
27
  return {
16
28
  subscribe: bridge.subscribe(key),
17
29
  getSnapshot: () => bridge.getSnapshot(key),
@@ -26,14 +38,56 @@ export class AppsSdkAdaptor {
26
38
  sendFollowUpMessage = (prompt) => {
27
39
  return window.openai.sendFollowUpMessage({ prompt });
28
40
  };
29
- openExternal(href) {
30
- window.openai.openExternal({ href });
41
+ openExternal(href, options = {}) {
42
+ window.openai.openExternal({ href, ...options });
31
43
  }
32
- setWidgetState = (stateOrUpdater) => {
33
- const newState = typeof stateOrUpdater === "function"
34
- ? stateOrUpdater(window.openai.widgetState)
44
+ setViewState = (stateOrUpdater) => {
45
+ const modelContent = typeof stateOrUpdater === "function"
46
+ ? stateOrUpdater(window.openai.widgetState?.modelContent ?? null)
35
47
  : stateOrUpdater;
36
- return window.openai.setWidgetState(newState);
48
+ return window.openai.setWidgetState({
49
+ privateContent: {},
50
+ ...window.openai.widgetState,
51
+ modelContent,
52
+ });
53
+ };
54
+ uploadFile = async (file, options) => {
55
+ const metadata = await window.openai.uploadFile(file, options);
56
+ await this.trackFileIds(metadata.fileId);
57
+ return metadata;
58
+ };
59
+ getFileDownloadUrl = (file) => {
60
+ return window.openai.getFileDownloadUrl(file);
61
+ };
62
+ selectFiles = async () => {
63
+ if (!window.openai.selectFiles) {
64
+ throw new Error("selectFiles is not supported by the current host version.");
65
+ }
66
+ const files = await window.openai.selectFiles();
67
+ if (files.length > 0) {
68
+ await this.trackFileIds(...files.map((f) => f.fileId));
69
+ }
70
+ return files;
37
71
  };
72
+ async trackFileIds(...fileIds) {
73
+ const state = window.openai.widgetState
74
+ ? { ...window.openai.widgetState }
75
+ : { modelContent: {}, privateContent: {} };
76
+ if (!state.imageIds) {
77
+ state.imageIds = [];
78
+ }
79
+ state.imageIds.push(...fileIds);
80
+ await window.openai.setWidgetState(state);
81
+ }
82
+ openModal(options) {
83
+ return window.openai.requestModal(options);
84
+ }
85
+ setOpenInAppUrl(href) {
86
+ href = href.trim();
87
+ if (!href) {
88
+ throw new Error("The href parameter is required.");
89
+ }
90
+ return window.openai.setOpenInAppUrl({ href });
91
+ }
38
92
  }
39
93
  //# sourceMappingURL=adaptor.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"adaptor.js","sourceRoot":"","sources":["../../../../src/web/bridges/apps-sdk/adaptor.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,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;QAC3C,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,QAAQ,GACZ,OAAO,cAAc,KAAK,UAAU;YAClC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC;YAC3C,CAAC,CAAC,cAAc,CAAC;QAErB,OAAO,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC,CAAC"}
1
+ {"version":3,"file":"adaptor.js","sourceRoot":"","sources":["../../../../src/web/bridges/apps-sdk/adaptor.ts"],"names":[],"mappings":"AAYA,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,WAAW,EAAE,CAAC;YACxB,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,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,OAAO;gBACL,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;gBACnC,WAAW,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC;aACvB,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;SACpB,CAAC;IAC3B,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,IAAwB,EACe,EAAE;QACzC,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,EAAE,UAA+B,EAAE;QACjE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnD,CAAC;IAEM,YAAY,GAAG,CAAC,cAAkC,EAAiB,EAAE;QAC1E,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;YAClC,cAAc,EAAE,EAAE;YAClB,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW;YAC5B,YAAY;SACb,CAAC,CAAC;IACL,CAAC,CAAC;IAEK,UAAU,GAAG,KAAK,EAAE,IAAU,EAAE,OAA2B,EAAE,EAAE;QACpE,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/D,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACzC,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IAEK,kBAAkB,GAAG,CAAC,IAAwB,EAAE,EAAE;QACvD,OAAO,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC,CAAC;IAEK,WAAW,GAAG,KAAK,IAA6B,EAAE;QACvD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,2DAA2D,CAC5D,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAChD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,GAAG,OAAiB;QAC7C,MAAM,KAAK,GAAuB,MAAM,CAAC,MAAM,CAAC,WAAW;YACzD,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE;YAClC,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;QAC7C,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACpB,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC;QACtB,CAAC;QACD,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;QAChC,MAAM,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAEM,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,OAAO,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC"}
@@ -1,10 +1,10 @@
1
1
  import type { Bridge, Subscribe } from "../types.js";
2
- import { type OpenAiProperties } from "./types.js";
3
- export declare class AppsSdkBridge implements Bridge<OpenAiProperties> {
2
+ import { type AppsSdkContext } from "./types.js";
3
+ export declare class AppsSdkBridge implements Bridge<AppsSdkContext> {
4
4
  private static instance;
5
5
  static getInstance(): AppsSdkBridge;
6
6
  static resetInstance(): void;
7
- subscribe(key: keyof OpenAiProperties): Subscribe;
8
- subscribe(keys: readonly (keyof OpenAiProperties)[]): Subscribe;
9
- getSnapshot: <K extends keyof OpenAiProperties>(key: K) => (import("./types.js").OpenAiMethods<import("../../types.js").UnknownObject> & OpenAiProperties<Record<never, unknown>, import("../../types.js").UnknownObject, import("../../types.js").UnknownObject, import("../../types.js").UnknownObject>)[K];
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").AppsSdkWidgetState> & AppsSdkContext<Record<never, unknown>, import("../../types.js").UnknownObject, import("../../types.js").UnknownObject, import("./types.js").AppsSdkWidgetState>)[K];
10
10
  }
@@ -1 +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,SAAuE;QAEvE,MAAM,IAAI,GAAwC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;YACxE,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,CAAmC,GAAM,EAAE,EAAE;QAChE,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"}
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"}
@@ -1,5 +1,5 @@
1
1
  export { AppsSdkAdaptor } from "./adaptor.js";
2
2
  export { AppsSdkBridge } from "./bridge.js";
3
- export type { OpenAiMethods, OpenAiProperties, RequestModalOptions, ToolResponseEvent, } from "./types.js";
3
+ export type { AppsSdkContext, AppsSdkMethods, AppsSdkWidgetState, ToolResponseEvent, } from "./types.js";
4
4
  export { SET_GLOBALS_EVENT_TYPE, SetGlobalsEvent, TOOL_RESPONSE_EVENT_TYPE, } from "./types.js";
5
- export { useAppsSdkBridge } from "./use-apps-sdk-bridge.js";
5
+ export { useAppsSdkContext } from "./use-apps-sdk-context.js";
@@ -1,5 +1,5 @@
1
1
  export { AppsSdkAdaptor } from "./adaptor.js";
2
2
  export { AppsSdkBridge } from "./bridge.js";
3
3
  export { SET_GLOBALS_EVENT_TYPE, SetGlobalsEvent, TOOL_RESPONSE_EVENT_TYPE, } from "./types.js";
4
- export { useAppsSdkBridge } from "./use-apps-sdk-bridge.js";
4
+ export { useAppsSdkContext } from "./use-apps-sdk-context.js";
5
5
  //# sourceMappingURL=index.js.map
@@ -1 +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;AAO5C,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,wBAAwB,GACzB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC"}
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;AAO5C,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,wBAAwB,GACzB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC"}
@@ -1,9 +1,11 @@
1
1
  import type { UnknownObject } from "../../types.js";
2
- import type { CallToolArgs, CallToolResponse } from "../types.js";
2
+ import type { CallToolArgs, CallToolResponse, FileMetadata, RequestModalOptions, UploadFileOptions } from "../types.js";
3
3
  type DisplayMode = "pip" | "inline" | "fullscreen" | "modal";
4
- type WidgetState = UnknownObject;
5
- type FileMetadata = {
6
- fileId: string;
4
+ type RequestDisplayMode = Exclude<DisplayMode, "modal">;
5
+ export type AppsSdkWidgetState = {
6
+ modelContent: Record<string, unknown>;
7
+ privateContent: Record<string, unknown>;
8
+ imageIds?: string[];
7
9
  };
8
10
  export declare const TOOL_RESPONSE_EVENT_TYPE = "openai:tool_response";
9
11
  export declare class ToolResponseEvent extends CustomEvent<{
@@ -16,17 +18,17 @@ export declare class ToolResponseEvent extends CustomEvent<{
16
18
  }
17
19
  declare global {
18
20
  interface Window {
19
- openai: OpenAiMethods<WidgetState> & OpenAiProperties;
21
+ openai: AppsSdkMethods & AppsSdkContext;
20
22
  }
21
23
  interface WindowEventMap {
22
24
  [SET_GLOBALS_EVENT_TYPE]: SetGlobalsEvent;
23
25
  }
24
26
  }
25
- export type OpenAiProperties<ToolInput extends UnknownObject = Record<never, unknown>, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject, WidgetState extends UnknownObject = UnknownObject> = {
27
+ export type AppsSdkContext<ToolInput extends UnknownObject = Record<never, unknown>, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject, WS extends AppsSdkWidgetState = AppsSdkWidgetState> = {
26
28
  theme: Theme;
27
29
  userAgent: UserAgent;
28
30
  locale: string;
29
- maxHeight: number;
31
+ maxHeight: number | undefined;
30
32
  displayMode: DisplayMode;
31
33
  safeArea: SafeArea;
32
34
  view: View;
@@ -35,19 +37,9 @@ export type OpenAiProperties<ToolInput extends UnknownObject = Record<never, unk
35
37
  text: string;
36
38
  } | null;
37
39
  toolResponseMetadata: ToolResponseMetadata | null;
38
- widgetState: WidgetState | null;
40
+ widgetState: WS | null;
39
41
  };
40
- export type RequestModalOptions = {
41
- title?: string;
42
- params?: Record<string, unknown>;
43
- anchor?: {
44
- top?: number;
45
- left?: number;
46
- width?: number;
47
- height?: number;
48
- };
49
- };
50
- export type OpenAiMethods<WidgetState extends UnknownObject = UnknownObject> = {
42
+ export type AppsSdkMethods<WS extends AppsSdkWidgetState = AppsSdkWidgetState> = {
51
43
  /** Calls a tool on your MCP. Returns the full response. */
52
44
  callTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends CallToolResponse = CallToolResponse>(name: string, args: ToolArgs) => Promise<ToolResponse>;
53
45
  /** Triggers a followup turn in the ChatGPT conversation */
@@ -57,40 +49,53 @@ export type OpenAiMethods<WidgetState extends UnknownObject = UnknownObject> = {
57
49
  /** Opens an external link, redirects web page or mobile app */
58
50
  openExternal(args: {
59
51
  href: string;
52
+ redirectUrl?: false;
60
53
  }): void;
61
54
  /** For transitioning an app from inline to fullscreen or pip */
62
55
  requestDisplayMode: (args: {
63
- mode: DisplayMode;
56
+ mode: RequestDisplayMode;
64
57
  }) => Promise<{
65
58
  /**
66
59
  * The granted display mode. The host may reject the request.
67
60
  * For mobile, PiP is always coerced to fullscreen.
68
61
  */
69
- mode: DisplayMode;
62
+ mode: RequestDisplayMode;
70
63
  }>;
71
64
  /**
72
65
  * Sets the widget state.
73
66
  * This state is persisted across widget renders.
74
67
  */
75
- setWidgetState: (state: WidgetState) => Promise<void>;
68
+ setWidgetState: (state: WS) => Promise<void>;
76
69
  /**
77
70
  * Opens a modal portaled outside of the widget iFrame.
78
71
  * This ensures the modal is correctly displayed and not limited to the widget's area.
79
72
  */
80
73
  requestModal: (args: RequestModalOptions) => Promise<void>;
81
- /** Uploads a new file to the host */
82
- uploadFile: (file: File) => Promise<FileMetadata>;
74
+ /** Uploads a new file to the host. Pass `{ library: true }` to also save to the user's ChatGPT file library. */
75
+ uploadFile: (file: File, options?: UploadFileOptions) => Promise<FileMetadata>;
76
+ /**
77
+ * Opens ChatGPT's file library picker and returns app-authorized files.
78
+ * Feature-detect before using: this method may not be available on all host versions.
79
+ */
80
+ selectFiles?: () => Promise<FileMetadata[]>;
83
81
  /**
84
- * Downloads a file from the host that was previously uploaded.
85
- * Only files uploaded by the same connector instance can be downloaded.
82
+ * Downloads a file from the host. Works for files uploaded by the widget,
83
+ * files selected via selectFiles(), or files provided via tool/file params.
86
84
  */
87
85
  getFileDownloadUrl: (file: FileMetadata) => Promise<{
88
86
  downloadUrl: string;
89
87
  }>;
88
+ /**
89
+ * Sets the open in app URL.
90
+ * This URL will be opened in the app when the user clicks on the top right button in fullscreen mode.
91
+ */
92
+ setOpenInAppUrl: (args: {
93
+ href: string;
94
+ }) => Promise<void>;
90
95
  };
91
96
  export declare const SET_GLOBALS_EVENT_TYPE = "openai:set_globals";
92
97
  export declare class SetGlobalsEvent extends CustomEvent<{
93
- globals: Partial<OpenAiProperties>;
98
+ globals: Partial<AppsSdkContext>;
94
99
  }> {
95
100
  readonly type = "openai:set_globals";
96
101
  }
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/web/bridges/apps-sdk/types.ts"],"names":[],"mappings":"AASA,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"}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/web/bridges/apps-sdk/types.ts"],"names":[],"mappings":"AAkBA,MAAM,CAAC,MAAM,wBAAwB,GAAG,sBAAsB,CAAC;AAC/D,MAAM,OAAO,iBAAkB,SAAQ,WAErC;IACkB,IAAI,GAAG,wBAAwB,CAAC;CACnD;AAoGD,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];
@@ -1,7 +1,7 @@
1
1
  import { useSyncExternalStore } from "react";
2
2
  import { AppsSdkBridge } from "./bridge.js";
3
- export function useAppsSdkBridge(key) {
3
+ export function useAppsSdkContext(key) {
4
4
  const bridge = AppsSdkBridge.getInstance();
5
5
  return useSyncExternalStore(bridge.subscribe(key), () => bridge.getSnapshot(key));
6
6
  }
7
- //# sourceMappingURL=use-apps-sdk-bridge.js.map
7
+ //# sourceMappingURL=use-apps-sdk-context.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-apps-sdk-context.js","sourceRoot":"","sources":["../../../../src/web/bridges/apps-sdk/use-apps-sdk-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C,MAAM,UAAU,iBAAiB,CAC/B,GAAM;IAEN,MAAM,MAAM,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;IAC3C,OAAO,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CACtD,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CACxB,CAAC;AACJ,CAAC"}
@@ -1,19 +1,48 @@
1
- import type { McpUiRequestDisplayModeResult } from "@modelcontextprotocol/ext-apps";
2
- import type { Adaptor, CallToolResponse, DisplayMode, HostContext, HostContextStore, SetWidgetStateAction } from "../types.js";
1
+ import type { Adaptor, CallToolResponse, HostContext, HostContextStore, OpenExternalOptions, RequestDisplayMode, RequestModalOptions, SetViewStateAction } from "../types.js";
3
2
  export declare class McpAppAdaptor implements Adaptor {
4
3
  private static instance;
5
4
  private stores;
6
- private _widgetState;
7
- private widgetStateListeners;
5
+ private _viewState;
6
+ private viewStateListeners;
7
+ private _viewUUID;
8
+ private _displayState;
9
+ private displayListeners;
8
10
  private constructor();
9
11
  static getInstance(): McpAppAdaptor;
10
12
  static resetInstance(): void;
11
13
  getHostContextStore<K extends keyof HostContext>(key: K): HostContextStore<K>;
12
14
  callTool: <ToolArgs extends Record<string, unknown> | null = null, ToolResponse extends CallToolResponse = CallToolResponse>(name: string, args: ToolArgs) => Promise<ToolResponse>;
13
- requestDisplayMode: (mode: DisplayMode) => Promise<McpUiRequestDisplayModeResult>;
15
+ requestDisplayMode: (mode: RequestDisplayMode) => Promise<{
16
+ [x: string]: unknown;
17
+ mode: "inline" | "fullscreen" | "pip";
18
+ }>;
14
19
  sendFollowUpMessage: (prompt: string) => Promise<void>;
15
- openExternal(href: string): void;
20
+ openExternal(href: string, options?: OpenExternalOptions): void;
16
21
  private initializeStores;
17
- setWidgetState: (stateOrUpdater: SetWidgetStateAction) => Promise<void>;
22
+ setViewState: (stateOrUpdater: SetViewStateAction) => Promise<void>;
23
+ /**
24
+ * @throws File upload is not supported in MCP App.
25
+ */
26
+ uploadFile(): Promise<{
27
+ fileId: string;
28
+ }>;
29
+ /**
30
+ * @throws File download is not supported in MCP App.
31
+ */
32
+ getFileDownloadUrl(): Promise<{
33
+ downloadUrl: string;
34
+ }>;
35
+ /**
36
+ * @throws File selection is not supported in MCP App.
37
+ */
38
+ selectFiles(): Promise<{
39
+ fileId: string;
40
+ }[]>;
41
+ openModal(options: RequestModalOptions): void;
42
+ closeModal(): void;
43
+ setOpenInAppUrl(_href: string): Promise<void>;
44
+ private subscribeToViewUUID;
45
+ private restoreFromLocalStorage;
46
+ private persistToLocalStorage;
18
47
  private createHostContextStore;
19
48
  }
@@ -1,12 +1,30 @@
1
1
  import { dequal } from "dequal/lite";
2
2
  import { McpAppBridge } from "./bridge.js";
3
+ const STORAGE_PREFIX = "sb:";
4
+ const MAX_STORAGE_ENTRIES = 200;
5
+ function findStorageKey(viewUUID) {
6
+ const suffix = `:${viewUUID}`;
7
+ for (let i = 0; i < localStorage.length; i++) {
8
+ const key = localStorage.key(i);
9
+ if (key?.startsWith(STORAGE_PREFIX) && key.endsWith(suffix)) {
10
+ return key;
11
+ }
12
+ }
13
+ return undefined;
14
+ }
3
15
  export class McpAppAdaptor {
4
16
  static instance = null;
5
17
  stores;
6
- _widgetState = null;
7
- widgetStateListeners = new Set();
18
+ _viewState = null;
19
+ viewStateListeners = new Set();
20
+ _viewUUID = null;
21
+ _displayState = {
22
+ mode: "inline",
23
+ };
24
+ displayListeners = new Set();
8
25
  constructor() {
9
26
  this.stores = this.initializeStores();
27
+ this.subscribeToViewUUID();
10
28
  }
11
29
  static getInstance() {
12
30
  if (!McpAppAdaptor.instance) {
@@ -21,13 +39,10 @@ export class McpAppAdaptor {
21
39
  return this.stores[key];
22
40
  }
23
41
  callTool = async (name, args) => {
24
- const bridge = McpAppBridge.getInstance();
25
- const response = await bridge.request({
26
- method: "tools/call",
27
- params: {
28
- name,
29
- arguments: args ?? undefined,
30
- },
42
+ const app = await McpAppBridge.getInstance().getApp();
43
+ const response = await app.callServerTool({
44
+ name,
45
+ arguments: args ?? undefined,
31
46
  });
32
47
  const result = response.content
33
48
  .filter((content) => content.type === "text")
@@ -41,36 +56,31 @@ export class McpAppAdaptor {
41
56
  meta: response._meta ?? {},
42
57
  };
43
58
  };
44
- requestDisplayMode = (mode) => {
45
- const bridge = McpAppBridge.getInstance();
46
- if (mode !== "modal") {
47
- return bridge.request({
48
- method: "ui/request-display-mode",
49
- params: { mode },
50
- });
51
- }
52
- throw new Error("Modal display mode is not accessible in MCP App.");
59
+ requestDisplayMode = async (mode) => {
60
+ const app = await McpAppBridge.getInstance().getApp();
61
+ return app.requestDisplayMode({ mode });
53
62
  };
54
63
  sendFollowUpMessage = async (prompt) => {
55
- const bridge = McpAppBridge.getInstance();
56
- await bridge.request({
57
- method: "ui/message",
58
- params: {
59
- role: "user",
60
- content: [
61
- {
62
- type: "text",
63
- text: prompt,
64
- },
65
- ],
66
- },
64
+ const app = await McpAppBridge.getInstance().getApp();
65
+ await app.sendMessage({
66
+ role: "user",
67
+ content: [
68
+ {
69
+ type: "text",
70
+ text: prompt,
71
+ },
72
+ ],
67
73
  });
68
74
  };
69
- openExternal(href) {
70
- const bridge = McpAppBridge.getInstance();
71
- bridge.request({
72
- method: "ui/open-link",
73
- params: { url: href },
75
+ openExternal(href, options) {
76
+ if (options?.redirectUrl === false) {
77
+ console.warn("[skybridge] redirectUrl option is not supported by the MCP ui/open-link protocol and will be ignored.");
78
+ }
79
+ McpAppBridge.getInstance()
80
+ .getApp()
81
+ .then((app) => app.openLink({ url: href }))
82
+ .catch((err) => {
83
+ console.error("Failed to open external link:", err);
74
84
  });
75
85
  }
76
86
  initializeStores() {
@@ -83,9 +93,9 @@ export class McpAppAdaptor {
83
93
  displayMode: this.createHostContextStore(["displayMode"], ({ displayMode }) => displayMode ?? "inline"),
84
94
  maxHeight: this.createHostContextStore(["containerDimensions"], ({ containerDimensions }) => {
85
95
  if (containerDimensions && "maxHeight" in containerDimensions) {
86
- return containerDimensions.maxHeight ?? window.innerHeight;
96
+ return containerDimensions.maxHeight;
87
97
  }
88
- return window.innerHeight;
98
+ return undefined;
89
99
  }),
90
100
  userAgent: this.createHostContextStore(["platform", "deviceCapabilities"], ({ platform, deviceCapabilities }) => ({
91
101
  device: {
@@ -100,31 +110,144 @@ export class McpAppAdaptor {
100
110
  toolInput: this.createHostContextStore(["toolInput"], ({ toolInput }) => toolInput ?? null),
101
111
  toolOutput: this.createHostContextStore(["toolResult"], ({ toolResult }) => toolResult?.structuredContent ?? null),
102
112
  toolResponseMetadata: this.createHostContextStore(["toolResult"], ({ toolResult }) => toolResult?._meta ?? null),
103
- widgetState: {
113
+ display: {
104
114
  subscribe: (onChange) => {
105
- this.widgetStateListeners.add(onChange);
115
+ this.displayListeners.add(onChange);
106
116
  return () => {
107
- this.widgetStateListeners.delete(onChange);
117
+ this.displayListeners.delete(onChange);
108
118
  };
109
119
  },
110
- getSnapshot: () => this._widgetState,
120
+ getSnapshot: () => this._displayState,
121
+ },
122
+ viewState: {
123
+ subscribe: (onChange) => {
124
+ this.viewStateListeners.add(onChange);
125
+ return () => {
126
+ this.viewStateListeners.delete(onChange);
127
+ };
128
+ },
129
+ getSnapshot: () => this._viewState,
111
130
  },
112
131
  };
113
132
  }
114
- setWidgetState = async (stateOrUpdater) => {
133
+ setViewState = async (stateOrUpdater) => {
115
134
  const newState = typeof stateOrUpdater === "function"
116
- ? stateOrUpdater(this._widgetState)
135
+ ? stateOrUpdater(this._viewState)
117
136
  : stateOrUpdater;
118
- const bridge = McpAppBridge.getInstance();
119
- await bridge.request({
120
- method: "ui/update-model-context",
121
- params: { structuredContent: newState },
122
- });
123
- this._widgetState = newState;
124
- this.widgetStateListeners.forEach((listener) => {
137
+ // must happen before the async bridge call to ensure the state is updated immediately for the UI,
138
+ // otherwise successive calls to setViewState may have stale state
139
+ this._viewState = newState;
140
+ this.viewStateListeners.forEach((listener) => {
125
141
  listener();
126
142
  });
143
+ this.persistToLocalStorage(newState);
144
+ try {
145
+ const app = await McpAppBridge.getInstance().getApp();
146
+ await app.updateModelContext({
147
+ structuredContent: newState,
148
+ content: [{ type: "text", text: JSON.stringify(newState) }],
149
+ });
150
+ }
151
+ catch (error) {
152
+ console.error("Failed to update view state in MCP App.", error);
153
+ }
127
154
  };
155
+ /**
156
+ * @throws File upload is not supported in MCP App.
157
+ */
158
+ uploadFile() {
159
+ throw new Error("File upload is not supported in MCP App.");
160
+ }
161
+ /**
162
+ * @throws File download is not supported in MCP App.
163
+ */
164
+ getFileDownloadUrl() {
165
+ throw new Error("File download is not supported in MCP App.");
166
+ }
167
+ /**
168
+ * @throws File selection is not supported in MCP App.
169
+ */
170
+ selectFiles() {
171
+ throw new Error("File selection is not supported in MCP App.");
172
+ }
173
+ openModal(options) {
174
+ this._displayState = { mode: "modal", params: options.params };
175
+ this.displayListeners.forEach((listener) => {
176
+ listener();
177
+ });
178
+ }
179
+ closeModal() {
180
+ this._displayState = { mode: "inline" };
181
+ this.displayListeners.forEach((listener) => {
182
+ listener();
183
+ });
184
+ }
185
+ setOpenInAppUrl(_href) {
186
+ throw new Error("setOpenInAppUrl is not implemented in MCP App.");
187
+ }
188
+ subscribeToViewUUID() {
189
+ const bridge = McpAppBridge.getInstance();
190
+ bridge.subscribe("toolResult")(() => {
191
+ const toolResult = bridge.getSnapshot("toolResult");
192
+ const viewUUID = toolResult?._meta?.viewUUID;
193
+ if (viewUUID && viewUUID !== this._viewUUID) {
194
+ this._viewUUID = viewUUID;
195
+ this.restoreFromLocalStorage(viewUUID);
196
+ }
197
+ });
198
+ }
199
+ // localStorage keys: sb:{unix_ms}:{viewUUID}
200
+ // Timestamp is updated on every write (LRU); eviction drops the least recently used entries.
201
+ restoreFromLocalStorage(viewUUID) {
202
+ try {
203
+ const existingKey = findStorageKey(viewUUID);
204
+ if (existingKey) {
205
+ const stored = localStorage.getItem(existingKey);
206
+ if (stored !== null) {
207
+ this._viewState = JSON.parse(stored);
208
+ this.viewStateListeners.forEach((listener) => {
209
+ listener();
210
+ });
211
+ }
212
+ }
213
+ }
214
+ catch (err) {
215
+ console.error(err);
216
+ }
217
+ }
218
+ persistToLocalStorage(state) {
219
+ if (!this._viewUUID || state === null) {
220
+ return;
221
+ }
222
+ try {
223
+ // Remove old key for this view, write with fresh timestamp (LRU)
224
+ const oldKey = findStorageKey(this._viewUUID);
225
+ if (oldKey) {
226
+ localStorage.removeItem(oldKey);
227
+ }
228
+ const newKey = `${STORAGE_PREFIX}${Date.now()}:${this._viewUUID}`;
229
+ localStorage.setItem(newKey, JSON.stringify(state));
230
+ // lru cleanup
231
+ const keys = [];
232
+ for (let i = 0; i < localStorage.length; i++) {
233
+ const key = localStorage.key(i);
234
+ if (key?.startsWith(STORAGE_PREFIX)) {
235
+ keys.push(key);
236
+ }
237
+ }
238
+ if (keys.length <= MAX_STORAGE_ENTRIES) {
239
+ return;
240
+ }
241
+ keys.sort();
242
+ const toRemove = keys.slice(0, keys.length - MAX_STORAGE_ENTRIES);
243
+ for (const key of toRemove) {
244
+ localStorage.removeItem(key);
245
+ }
246
+ }
247
+ catch (err) {
248
+ console.error(err);
249
+ }
250
+ }
128
251
  createHostContextStore(keys, computeSnapshot) {
129
252
  const bridge = McpAppBridge.getInstance();
130
253
  let cachedValue;