skybridge 0.0.0-dev.d6c0321 → 0.0.0-dev.d6cc9be

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 (277) hide show
  1. package/bin/run.js +9 -0
  2. package/dist/cli/header.d.ts +4 -0
  3. package/dist/cli/header.js +6 -0
  4. package/dist/cli/header.js.map +1 -0
  5. package/dist/cli/run-command.d.ts +2 -0
  6. package/dist/cli/run-command.js +42 -0
  7. package/dist/cli/run-command.js.map +1 -0
  8. package/dist/cli/use-execute-steps.d.ts +10 -0
  9. package/dist/cli/use-execute-steps.js +35 -0
  10. package/dist/cli/use-execute-steps.js.map +1 -0
  11. package/dist/commands/build.d.ts +9 -0
  12. package/dist/commands/build.js +44 -0
  13. package/dist/commands/build.js.map +1 -0
  14. package/dist/commands/dev.d.ts +7 -0
  15. package/dist/commands/dev.js +20 -0
  16. package/dist/commands/dev.js.map +1 -0
  17. package/dist/commands/start.d.ts +7 -0
  18. package/dist/commands/start.js +33 -0
  19. package/dist/commands/start.js.map +1 -0
  20. package/dist/{src/server → server}/index.d.ts +1 -2
  21. package/dist/{src/server → server}/index.js +0 -1
  22. package/dist/server/index.js.map +1 -0
  23. package/dist/server/inferUtilityTypes.js.map +1 -0
  24. package/dist/{src/server → server}/server.d.ts +49 -10
  25. package/dist/server/server.js +132 -0
  26. package/dist/server/server.js.map +1 -0
  27. package/dist/{src/server → server}/templateHelper.d.ts +3 -0
  28. package/dist/server/templateHelper.js.map +1 -0
  29. package/dist/server/templates/development.hbs +66 -0
  30. package/dist/{src/server → server}/templates/production.hbs +1 -0
  31. package/dist/{src/server → server}/widgetsDevServer.d.ts +2 -2
  32. package/dist/{src/server → server}/widgetsDevServer.js +11 -3
  33. package/dist/server/widgetsDevServer.js.map +1 -0
  34. package/dist/{src/test → test}/utils.d.ts +11 -0
  35. package/dist/{src/test → test}/utils.js +20 -0
  36. package/dist/test/utils.js.map +1 -0
  37. package/dist/test/widget.test.js +234 -0
  38. package/dist/test/widget.test.js.map +1 -0
  39. package/dist/web/bridges/adaptors/apps-sdk-adaptor.d.ts +13 -0
  40. package/dist/web/bridges/adaptors/apps-sdk-adaptor.js +33 -0
  41. package/dist/web/bridges/adaptors/apps-sdk-adaptor.js.map +1 -0
  42. package/dist/web/bridges/adaptors/mcp-app-adaptor.d.ts +16 -0
  43. package/dist/web/bridges/adaptors/mcp-app-adaptor.js +120 -0
  44. package/dist/web/bridges/adaptors/mcp-app-adaptor.js.map +1 -0
  45. package/dist/web/bridges/apps-sdk-bridge.d.ts +10 -0
  46. package/dist/web/bridges/apps-sdk-bridge.js +46 -0
  47. package/dist/web/bridges/apps-sdk-bridge.js.map +1 -0
  48. package/dist/web/bridges/hooks/use-adaptor.d.ts +2 -0
  49. package/dist/web/bridges/hooks/use-adaptor.js +8 -0
  50. package/dist/web/bridges/hooks/use-adaptor.js.map +1 -0
  51. package/dist/web/bridges/hooks/use-apps-sdk-bridge.d.ts +2 -0
  52. package/dist/web/bridges/hooks/use-apps-sdk-bridge.js +7 -0
  53. package/dist/web/bridges/hooks/use-apps-sdk-bridge.js.map +1 -0
  54. package/dist/web/bridges/hooks/use-bridge.d.ts +2 -0
  55. package/dist/web/bridges/hooks/use-bridge.js +8 -0
  56. package/dist/web/bridges/hooks/use-bridge.js.map +1 -0
  57. package/dist/web/bridges/hooks/use-mcp-app-bridge.d.ts +5 -0
  58. package/dist/web/bridges/hooks/use-mcp-app-bridge.js +7 -0
  59. package/dist/web/bridges/hooks/use-mcp-app-bridge.js.map +1 -0
  60. package/dist/web/bridges/hooks/use-mcp-app-bridge.test.js +62 -0
  61. package/dist/web/bridges/hooks/use-mcp-app-bridge.test.js.map +1 -0
  62. package/dist/web/bridges/index.d.ts +4 -0
  63. package/dist/web/bridges/index.js +5 -0
  64. package/dist/web/bridges/index.js.map +1 -0
  65. package/dist/web/bridges/mcp-app-bridge.d.ts +49 -0
  66. package/dist/web/bridges/mcp-app-bridge.js +256 -0
  67. package/dist/web/bridges/mcp-app-bridge.js.map +1 -0
  68. package/dist/web/bridges/types.d.ts +57 -0
  69. package/dist/web/bridges/types.js +2 -0
  70. package/dist/web/bridges/types.js.map +1 -0
  71. package/dist/web/create-store.js.map +1 -0
  72. package/dist/web/create-store.test.js.map +1 -0
  73. package/dist/{src/web → web}/data-llm.js +4 -2
  74. package/dist/web/data-llm.js.map +1 -0
  75. package/dist/web/data-llm.test.js.map +1 -0
  76. package/dist/web/generate-helpers.js.map +1 -0
  77. package/dist/{src/web → web}/generate-helpers.test-d.js +31 -2
  78. package/dist/web/generate-helpers.test-d.js.map +1 -0
  79. package/dist/web/generate-helpers.test.js.map +1 -0
  80. package/dist/web/helpers/state.js.map +1 -0
  81. package/dist/web/helpers/state.test.js.map +1 -0
  82. package/dist/{src/web → web}/hooks/index.d.ts +2 -3
  83. package/dist/{src/web → web}/hooks/index.js +2 -3
  84. package/dist/web/hooks/index.js.map +1 -0
  85. package/dist/web/hooks/test/utils.d.ts +10 -0
  86. package/dist/web/hooks/test/utils.js +40 -0
  87. package/dist/web/hooks/test/utils.js.map +1 -0
  88. package/dist/{src/web → web}/hooks/use-call-tool.d.ts +1 -1
  89. package/dist/{src/web → web}/hooks/use-call-tool.js +12 -4
  90. package/dist/web/hooks/use-call-tool.js.map +1 -0
  91. package/dist/{src/web → web}/hooks/use-call-tool.test-d.js +1 -1
  92. package/dist/web/hooks/use-call-tool.test-d.js.map +1 -0
  93. package/dist/{src/web → web}/hooks/use-call-tool.test.js +28 -3
  94. package/dist/web/hooks/use-call-tool.test.js.map +1 -0
  95. package/dist/{src/web → web}/hooks/use-display-mode.d.ts +1 -1
  96. package/dist/web/hooks/use-display-mode.js +10 -0
  97. package/dist/web/hooks/use-display-mode.js.map +1 -0
  98. package/dist/{src/web → web}/hooks/use-display-mode.test.js +1 -0
  99. package/dist/web/hooks/use-display-mode.test.js.map +1 -0
  100. package/dist/{src/web → web}/hooks/use-files.d.ts +1 -1
  101. package/dist/web/hooks/use-files.js +7 -0
  102. package/dist/web/hooks/use-files.js.map +1 -0
  103. package/dist/{src/web → web}/hooks/use-files.test.js +4 -4
  104. package/dist/web/hooks/use-files.test.js.map +1 -0
  105. package/dist/web/hooks/use-layout.d.ts +22 -0
  106. package/dist/web/hooks/use-layout.js +23 -0
  107. package/dist/web/hooks/use-layout.js.map +1 -0
  108. package/dist/web/hooks/use-layout.test.js +95 -0
  109. package/dist/web/hooks/use-layout.test.js.map +1 -0
  110. package/dist/web/hooks/use-open-external.js +8 -0
  111. package/dist/web/hooks/use-open-external.js.map +1 -0
  112. package/dist/web/hooks/use-open-external.test.js +50 -0
  113. package/dist/web/hooks/use-open-external.test.js.map +1 -0
  114. package/dist/{src/web → web}/hooks/use-openai-global.d.ts +2 -1
  115. package/dist/web/hooks/use-openai-global.js +6 -0
  116. package/dist/web/hooks/use-openai-global.js.map +1 -0
  117. package/dist/web/hooks/use-request-modal.d.ts +9 -0
  118. package/dist/web/hooks/use-request-modal.js +14 -0
  119. package/dist/web/hooks/use-request-modal.js.map +1 -0
  120. package/dist/web/hooks/use-request-modal.test.js +57 -0
  121. package/dist/web/hooks/use-request-modal.test.js.map +1 -0
  122. package/dist/web/hooks/use-send-follow-up-message.js +8 -0
  123. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -0
  124. package/dist/{src/web → web}/hooks/use-tool-info.d.ts +12 -1
  125. package/dist/web/hooks/use-tool-info.js +26 -0
  126. package/dist/web/hooks/use-tool-info.js.map +1 -0
  127. package/dist/{src/web → web}/hooks/use-tool-info.test-d.js +40 -4
  128. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -0
  129. package/dist/web/hooks/use-tool-info.test.js +130 -0
  130. package/dist/web/hooks/use-tool-info.test.js.map +1 -0
  131. package/dist/web/hooks/use-user.d.ts +18 -0
  132. package/dist/web/hooks/use-user.js +19 -0
  133. package/dist/web/hooks/use-user.js.map +1 -0
  134. package/dist/web/hooks/use-user.test.js +93 -0
  135. package/dist/web/hooks/use-user.test.js.map +1 -0
  136. package/dist/{src/web → web}/hooks/use-widget-state.js +2 -2
  137. package/dist/web/hooks/use-widget-state.js.map +1 -0
  138. package/dist/{src/web → web}/hooks/use-widget-state.test.js +1 -0
  139. package/dist/web/hooks/use-widget-state.test.js.map +1 -0
  140. package/dist/{src/web → web}/index.d.ts +1 -0
  141. package/dist/{src/web → web}/index.js +1 -0
  142. package/dist/web/index.js.map +1 -0
  143. package/dist/web/mount-widget.js.map +1 -0
  144. package/dist/web/plugin/data-llm.test.js.map +1 -0
  145. package/dist/{src/web → web}/plugin/plugin.js +10 -4
  146. package/dist/web/plugin/plugin.js.map +1 -0
  147. package/dist/{src/web → web}/plugin/transform-data-llm.js +6 -3
  148. package/dist/web/plugin/transform-data-llm.js.map +1 -0
  149. package/dist/web/plugin/transform-data-llm.test.js.map +1 -0
  150. package/dist/{src/web → web}/proxy.js +5 -0
  151. package/dist/web/proxy.js.map +1 -0
  152. package/dist/{src/web → web}/types.d.ts +26 -10
  153. package/dist/web/types.js.map +1 -0
  154. package/package.json +41 -21
  155. package/dist/src/server/devtoolsStaticServer.d.ts +0 -15
  156. package/dist/src/server/devtoolsStaticServer.js +0 -38
  157. package/dist/src/server/devtoolsStaticServer.js.map +0 -1
  158. package/dist/src/server/index.js.map +0 -1
  159. package/dist/src/server/inferUtilityTypes.js.map +0 -1
  160. package/dist/src/server/server.js +0 -62
  161. package/dist/src/server/server.js.map +0 -1
  162. package/dist/src/server/templateHelper.js.map +0 -1
  163. package/dist/src/server/templates/development.hbs +0 -12
  164. package/dist/src/server/widgetsDevServer.js.map +0 -1
  165. package/dist/src/test/utils.js.map +0 -1
  166. package/dist/src/test/widget.test.js +0 -95
  167. package/dist/src/test/widget.test.js.map +0 -1
  168. package/dist/src/web/create-store.js.map +0 -1
  169. package/dist/src/web/create-store.test.js.map +0 -1
  170. package/dist/src/web/data-llm.js.map +0 -1
  171. package/dist/src/web/data-llm.test.js.map +0 -1
  172. package/dist/src/web/generate-helpers.js.map +0 -1
  173. package/dist/src/web/generate-helpers.test-d.js.map +0 -1
  174. package/dist/src/web/generate-helpers.test.js.map +0 -1
  175. package/dist/src/web/helpers/state.js.map +0 -1
  176. package/dist/src/web/helpers/state.test.js.map +0 -1
  177. package/dist/src/web/hooks/index.js.map +0 -1
  178. package/dist/src/web/hooks/use-call-tool.js.map +0 -1
  179. package/dist/src/web/hooks/use-call-tool.test-d.js.map +0 -1
  180. package/dist/src/web/hooks/use-call-tool.test.js.map +0 -1
  181. package/dist/src/web/hooks/use-display-mode.js +0 -7
  182. package/dist/src/web/hooks/use-display-mode.js.map +0 -1
  183. package/dist/src/web/hooks/use-display-mode.test.js.map +0 -1
  184. package/dist/src/web/hooks/use-files.js +0 -7
  185. package/dist/src/web/hooks/use-files.js.map +0 -1
  186. package/dist/src/web/hooks/use-files.test.js.map +0 -1
  187. package/dist/src/web/hooks/use-locale.d.ts +0 -1
  188. package/dist/src/web/hooks/use-locale.js +0 -5
  189. package/dist/src/web/hooks/use-locale.js.map +0 -1
  190. package/dist/src/web/hooks/use-locale.test.js +0 -21
  191. package/dist/src/web/hooks/use-locale.test.js.map +0 -1
  192. package/dist/src/web/hooks/use-open-external.js +0 -6
  193. package/dist/src/web/hooks/use-open-external.js.map +0 -1
  194. package/dist/src/web/hooks/use-open-external.test.js +0 -24
  195. package/dist/src/web/hooks/use-open-external.test.js.map +0 -1
  196. package/dist/src/web/hooks/use-openai-global.js +0 -25
  197. package/dist/src/web/hooks/use-openai-global.js.map +0 -1
  198. package/dist/src/web/hooks/use-request-modal.d.ts +0 -6
  199. package/dist/src/web/hooks/use-request-modal.js +0 -9
  200. package/dist/src/web/hooks/use-request-modal.js.map +0 -1
  201. package/dist/src/web/hooks/use-request-modal.test.js +0 -24
  202. package/dist/src/web/hooks/use-request-modal.test.js.map +0 -1
  203. package/dist/src/web/hooks/use-send-follow-up-message.js +0 -11
  204. package/dist/src/web/hooks/use-send-follow-up-message.js.map +0 -1
  205. package/dist/src/web/hooks/use-theme.d.ts +0 -1
  206. package/dist/src/web/hooks/use-theme.js +0 -5
  207. package/dist/src/web/hooks/use-theme.js.map +0 -1
  208. package/dist/src/web/hooks/use-theme.test.js +0 -26
  209. package/dist/src/web/hooks/use-theme.test.js.map +0 -1
  210. package/dist/src/web/hooks/use-tool-info.js +0 -20
  211. package/dist/src/web/hooks/use-tool-info.js.map +0 -1
  212. package/dist/src/web/hooks/use-tool-info.test-d.js.map +0 -1
  213. package/dist/src/web/hooks/use-tool-info.test.js +0 -59
  214. package/dist/src/web/hooks/use-tool-info.test.js.map +0 -1
  215. package/dist/src/web/hooks/use-user-agent.d.ts +0 -1
  216. package/dist/src/web/hooks/use-user-agent.js +0 -5
  217. package/dist/src/web/hooks/use-user-agent.js.map +0 -1
  218. package/dist/src/web/hooks/use-user-agent.test.js +0 -31
  219. package/dist/src/web/hooks/use-user-agent.test.js.map +0 -1
  220. package/dist/src/web/hooks/use-widget-state.js.map +0 -1
  221. package/dist/src/web/hooks/use-widget-state.test.js.map +0 -1
  222. package/dist/src/web/index.js.map +0 -1
  223. package/dist/src/web/mount-widget.js.map +0 -1
  224. package/dist/src/web/plugin/data-llm.test.js.map +0 -1
  225. package/dist/src/web/plugin/plugin.js.map +0 -1
  226. package/dist/src/web/plugin/transform-data-llm.js.map +0 -1
  227. package/dist/src/web/plugin/transform-data-llm.test.js.map +0 -1
  228. package/dist/src/web/proxy.js.map +0 -1
  229. package/dist/src/web/types.js.map +0 -1
  230. package/dist/vitest.config.d.ts +0 -2
  231. package/dist/vitest.config.js +0 -8
  232. package/dist/vitest.config.js.map +0 -1
  233. /package/dist/{src/server → server}/inferUtilityTypes.d.ts +0 -0
  234. /package/dist/{src/server → server}/inferUtilityTypes.js +0 -0
  235. /package/dist/{src/server → server}/templateHelper.js +0 -0
  236. /package/dist/{src/test → test}/widget.test.d.ts +0 -0
  237. /package/dist/{src/web/create-store.test.d.ts → web/bridges/hooks/use-mcp-app-bridge.test.d.ts} +0 -0
  238. /package/dist/{src/web → web}/create-store.d.ts +0 -0
  239. /package/dist/{src/web → web}/create-store.js +0 -0
  240. /package/dist/{src/web/data-llm.test.d.ts → web/create-store.test.d.ts} +0 -0
  241. /package/dist/{src/web → web}/create-store.test.js +0 -0
  242. /package/dist/{src/web → web}/data-llm.d.ts +0 -0
  243. /package/dist/{src/web/plugin → web}/data-llm.test.d.ts +0 -0
  244. /package/dist/{src/web → web}/data-llm.test.js +0 -0
  245. /package/dist/{src/web → web}/generate-helpers.d.ts +0 -0
  246. /package/dist/{src/web → web}/generate-helpers.js +0 -0
  247. /package/dist/{src/web → web}/generate-helpers.test-d.d.ts +0 -0
  248. /package/dist/{src/web → web}/generate-helpers.test.d.ts +0 -0
  249. /package/dist/{src/web → web}/generate-helpers.test.js +0 -0
  250. /package/dist/{src/web → web}/helpers/state.d.ts +0 -0
  251. /package/dist/{src/web → web}/helpers/state.js +0 -0
  252. /package/dist/{src/web → web}/helpers/state.test.d.ts +0 -0
  253. /package/dist/{src/web → web}/helpers/state.test.js +0 -0
  254. /package/dist/{src/web → web}/hooks/use-call-tool.test-d.d.ts +0 -0
  255. /package/dist/{src/web → web}/hooks/use-call-tool.test.d.ts +0 -0
  256. /package/dist/{src/web → web}/hooks/use-display-mode.test.d.ts +0 -0
  257. /package/dist/{src/web → web}/hooks/use-files.test.d.ts +0 -0
  258. /package/dist/{src/web/hooks/use-locale.test.d.ts → web/hooks/use-layout.test.d.ts} +0 -0
  259. /package/dist/{src/web → web}/hooks/use-open-external.d.ts +0 -0
  260. /package/dist/{src/web → web}/hooks/use-open-external.test.d.ts +0 -0
  261. /package/dist/{src/web → web}/hooks/use-request-modal.test.d.ts +0 -0
  262. /package/dist/{src/web → web}/hooks/use-send-follow-up-message.d.ts +0 -0
  263. /package/dist/{src/web → web}/hooks/use-tool-info.test-d.d.ts +0 -0
  264. /package/dist/{src/web → web}/hooks/use-tool-info.test.d.ts +0 -0
  265. /package/dist/{src/web/hooks/use-theme.test.d.ts → web/hooks/use-user.test.d.ts} +0 -0
  266. /package/dist/{src/web → web}/hooks/use-widget-state.d.ts +0 -0
  267. /package/dist/{src/web → web}/hooks/use-widget-state.test.d.ts +0 -0
  268. /package/dist/{src/web → web}/mount-widget.d.ts +0 -0
  269. /package/dist/{src/web → web}/mount-widget.js +0 -0
  270. /package/dist/{src/web/hooks/use-user-agent.test.d.ts → web/plugin/data-llm.test.d.ts} +0 -0
  271. /package/dist/{src/web → web}/plugin/data-llm.test.js +0 -0
  272. /package/dist/{src/web → web}/plugin/plugin.d.ts +0 -0
  273. /package/dist/{src/web → web}/plugin/transform-data-llm.d.ts +0 -0
  274. /package/dist/{src/web → web}/plugin/transform-data-llm.test.d.ts +0 -0
  275. /package/dist/{src/web → web}/plugin/transform-data-llm.test.js +0 -0
  276. /package/dist/{src/web → web}/proxy.d.ts +0 -0
  277. /package/dist/{src/web → web}/types.js +0 -0
@@ -0,0 +1,50 @@
1
+ import { renderHook } from "@testing-library/react";
2
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
3
+ import { McpAppBridge } from "../bridges/mcp-app-bridge.js";
4
+ import { useOpenExternal } from "./use-open-external.js";
5
+ describe("useOpenExternal", () => {
6
+ describe("apps-sdk host", () => {
7
+ let openExternalMock;
8
+ beforeEach(() => {
9
+ openExternalMock = vi.fn();
10
+ vi.stubGlobal("openai", {
11
+ openExternal: openExternalMock,
12
+ });
13
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
14
+ });
15
+ afterEach(() => {
16
+ vi.unstubAllGlobals();
17
+ vi.resetAllMocks();
18
+ });
19
+ it("should return a function that calls window.openai.openExternal with the href", () => {
20
+ const { result } = renderHook(() => useOpenExternal());
21
+ const href = "https://example.com";
22
+ result.current(href);
23
+ expect(openExternalMock).toHaveBeenCalledTimes(1);
24
+ expect(openExternalMock).toHaveBeenCalledWith({ href });
25
+ });
26
+ });
27
+ describe("mcp-app host", () => {
28
+ const mockPostMessage = vi.fn();
29
+ beforeEach(() => {
30
+ vi.stubGlobal("parent", { postMessage: mockPostMessage });
31
+ vi.stubGlobal("skybridge", { hostType: "mcp-app" });
32
+ });
33
+ afterEach(() => {
34
+ vi.unstubAllGlobals();
35
+ vi.resetAllMocks();
36
+ McpAppBridge.resetInstance();
37
+ });
38
+ it("should return a function that sends ui/open-link request to the MCP host", () => {
39
+ const { result } = renderHook(() => useOpenExternal());
40
+ const href = "https://example.com";
41
+ result.current(href);
42
+ expect(mockPostMessage).toHaveBeenCalledWith(expect.objectContaining({
43
+ jsonrpc: "2.0",
44
+ method: "ui/open-link",
45
+ params: { url: href },
46
+ }), "*");
47
+ });
48
+ });
49
+ });
50
+ //# sourceMappingURL=use-open-external.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-open-external.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-open-external.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,IAAI,gBAA0C,CAAC;QAE/C,UAAU,CAAC,GAAG,EAAE;YACd,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3B,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,YAAY,EAAE,gBAAgB;aAC/B,CAAC,CAAC;YACH,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8EAA8E,EAAE,GAAG,EAAE;YACtF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;YAEvD,MAAM,IAAI,GAAG,qBAAqB,CAAC;YACnC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAErB,MAAM,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,MAAM,eAAe,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAEhC,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;YAC1D,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,GAAG,EAAE;YAClF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;YAEvD,MAAM,IAAI,GAAG,qBAAqB,CAAC;YACnC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAErB,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAC1C,MAAM,CAAC,gBAAgB,CAAC;gBACtB,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,cAAc;gBACtB,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE;aACtB,CAAC,EACF,GAAG,CACJ,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -1,2 +1,3 @@
1
- import { type OpenAiProperties } from "../types.js";
1
+ import type { OpenAiProperties } from "../types.js";
2
+ /** @deprecated Use `useAppsSdkBridge` instead */
2
3
  export declare function useOpenAiGlobal<K extends keyof OpenAiProperties>(key: K): OpenAiProperties[K];
@@ -0,0 +1,6 @@
1
+ import { useAppsSdkBridge } from "../bridges/index.js";
2
+ /** @deprecated Use `useAppsSdkBridge` instead */
3
+ export function useOpenAiGlobal(key) {
4
+ return useAppsSdkBridge(key);
5
+ }
6
+ //# sourceMappingURL=use-openai-global.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-openai-global.js","sourceRoot":"","sources":["../../../src/web/hooks/use-openai-global.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGvD,iDAAiD;AACjD,MAAM,UAAU,eAAe,CAC7B,GAAM;IAEN,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC;AAC/B,CAAC"}
@@ -0,0 +1,9 @@
1
+ import type { RequestModalOptions } from "../types.js";
2
+ /**
3
+ * Triggers a modal containing the widget rendered in display mode "modal"
4
+ */
5
+ export declare function useRequestModal(): {
6
+ isOpen: boolean;
7
+ open: (options: RequestModalOptions) => void;
8
+ params: Record<string, unknown> | undefined;
9
+ };
@@ -0,0 +1,14 @@
1
+ import { useAppsSdkBridge } from "../bridges/hooks/use-apps-sdk-bridge.js";
2
+ /**
3
+ * Triggers a modal containing the widget rendered in display mode "modal"
4
+ */
5
+ export function useRequestModal() {
6
+ const view = useAppsSdkBridge("view");
7
+ const isOpen = view?.mode === "modal";
8
+ const params = view?.params;
9
+ const open = (options) => {
10
+ window.openai.requestModal(options);
11
+ };
12
+ return { isOpen, open, params };
13
+ }
14
+ //# sourceMappingURL=use-request-modal.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-request-modal.js","sourceRoot":"","sources":["../../../src/web/hooks/use-request-modal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAG3E;;GAEG;AACH,MAAM,UAAU,eAAe;IAC7B,MAAM,IAAI,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,MAAM,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC;IACtC,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,CAAC;IAE5B,MAAM,IAAI,GAAG,CAAC,OAA4B,EAAE,EAAE;QAC5C,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC,CAAC;IAEF,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAClC,CAAC"}
@@ -0,0 +1,57 @@
1
+ import { renderHook } from "@testing-library/react";
2
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
3
+ import { useRequestModal } from "./use-request-modal.js";
4
+ describe("useRequestModal", () => {
5
+ let requestModalMock;
6
+ beforeEach(() => {
7
+ requestModalMock = vi.fn();
8
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
9
+ vi.stubGlobal("openai", {
10
+ requestModal: requestModalMock,
11
+ view: { mode: "inline" },
12
+ });
13
+ });
14
+ afterEach(() => {
15
+ vi.unstubAllGlobals();
16
+ vi.resetAllMocks();
17
+ });
18
+ it("should return an object with open, isOpen, and params properties where isOpen is false when mode is not modal", () => {
19
+ const { result } = renderHook(() => useRequestModal());
20
+ expect(typeof result.current).toBe("object");
21
+ expect(result.current).toHaveProperty("open");
22
+ expect(result.current).toHaveProperty("isOpen");
23
+ expect(result.current).toHaveProperty("params");
24
+ const { open, isOpen, params } = result.current;
25
+ expect(typeof open).toBe("function");
26
+ expect(isOpen).toBe(false);
27
+ expect(params).toBeUndefined();
28
+ });
29
+ it("should return isOpen as true when mode is modal", () => {
30
+ vi.stubGlobal("openai", {
31
+ requestModal: requestModalMock,
32
+ view: { mode: "modal" },
33
+ });
34
+ const { result } = renderHook(() => useRequestModal());
35
+ const { isOpen } = result.current;
36
+ expect(isOpen).toBe(true);
37
+ });
38
+ it("should return params from view when available", () => {
39
+ const testParams = { foo: "bar", baz: 42 };
40
+ vi.stubGlobal("openai", {
41
+ requestModal: requestModalMock,
42
+ view: { mode: "modal", params: testParams },
43
+ });
44
+ const { result } = renderHook(() => useRequestModal());
45
+ const { params } = result.current;
46
+ expect(params).toEqual(testParams);
47
+ });
48
+ it("should call window.openai.requestModal with the options when open is called", () => {
49
+ const { result } = renderHook(() => useRequestModal());
50
+ const { open } = result.current;
51
+ const options = { title: "Test Modal" };
52
+ open(options);
53
+ expect(requestModalMock).toHaveBeenCalledTimes(1);
54
+ expect(requestModalMock).toHaveBeenCalledWith(options);
55
+ });
56
+ });
57
+ //# sourceMappingURL=use-request-modal.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-request-modal.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-request-modal.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,IAAI,gBAA0C,CAAC;IAE/C,UAAU,CAAC,GAAG,EAAE;QACd,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3B,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACrD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,YAAY,EAAE,gBAAgB;YAC9B,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SACzB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+GAA+G,EAAE,GAAG,EAAE;QACvH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;QAEvD,MAAM,CAAC,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAEhD,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;QAChD,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,YAAY,EAAE,gBAAgB;YAC9B,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;SACxB,CAAC,CAAC;QAEH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;QACvD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;QAElC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,UAAU,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;QAC3C,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,YAAY,EAAE,gBAAgB;YAC9B,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;QACvD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;QAElC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE;QACrF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;QACvD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;QAEhC,MAAM,OAAO,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;QACxC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEd,MAAM,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAClD,MAAM,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,8 @@
1
+ import { useCallback } from "react";
2
+ import { useAdaptor } from "../bridges/index.js";
3
+ export function useSendFollowUpMessage() {
4
+ const adaptor = useAdaptor();
5
+ const sendFollowUpMessage = useCallback((prompt) => adaptor.sendFollowUpMessage(prompt), [adaptor]);
6
+ return sendFollowUpMessage;
7
+ }
8
+ //# sourceMappingURL=use-send-follow-up-message.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-send-follow-up-message.js","sourceRoot":"","sources":["../../../src/web/hooks/use-send-follow-up-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,MAAM,UAAU,sBAAsB;IACpC,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,mBAAmB,GAAG,WAAW,CACrC,CAAC,MAAc,EAAE,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,MAAM,CAAC,EACvD,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,OAAO,mBAAmB,CAAC;AAC7B,CAAC"}
@@ -1,6 +1,16 @@
1
1
  import type { UnknownObject } from "../types.js";
2
+ export type ToolIdleState = {
3
+ status: "idle";
4
+ isIdle: true;
5
+ isPending: false;
6
+ isSuccess: false;
7
+ input: undefined;
8
+ output: undefined;
9
+ responseMetadata: undefined;
10
+ };
2
11
  export type ToolPendingState<ToolInput extends UnknownObject> = {
3
12
  status: "pending";
13
+ isIdle: false;
4
14
  isPending: true;
5
15
  isSuccess: false;
6
16
  input: ToolInput;
@@ -9,13 +19,14 @@ export type ToolPendingState<ToolInput extends UnknownObject> = {
9
19
  };
10
20
  export type ToolSuccessState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = {
11
21
  status: "success";
22
+ isIdle: false;
12
23
  isPending: false;
13
24
  isSuccess: true;
14
25
  input: ToolInput;
15
26
  output: ToolOutput;
16
27
  responseMetadata: ToolResponseMetadata;
17
28
  };
18
- export type ToolState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = ToolPendingState<ToolInput> | ToolSuccessState<ToolInput, ToolOutput, ToolResponseMetadata>;
29
+ export type ToolState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = ToolIdleState | ToolPendingState<ToolInput> | ToolSuccessState<ToolInput, ToolOutput, ToolResponseMetadata>;
19
30
  type ToolSignature = {
20
31
  input: UnknownObject;
21
32
  output: UnknownObject;
@@ -0,0 +1,26 @@
1
+ import { useBridge } from "../bridges/index.js";
2
+ function deriveStatus(input, output, responseMetadata) {
3
+ if (input === null) {
4
+ return "idle";
5
+ }
6
+ if (output === null && responseMetadata === null) {
7
+ return "pending";
8
+ }
9
+ return "success";
10
+ }
11
+ export function useToolInfo() {
12
+ const input = useBridge("toolInput");
13
+ const output = useBridge("toolOutput");
14
+ const responseMetadata = useBridge("toolResponseMetadata");
15
+ const status = deriveStatus(input, output, responseMetadata);
16
+ return {
17
+ input,
18
+ status,
19
+ isIdle: status === "idle",
20
+ isPending: status === "pending",
21
+ isSuccess: status === "success",
22
+ output,
23
+ responseMetadata,
24
+ };
25
+ }
26
+ //# sourceMappingURL=use-tool-info.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-tool-info.js","sourceRoot":"","sources":["../../../src/web/hooks/use-tool-info.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAoDhD,SAAS,YAAY,CACnB,KAAqC,EACrC,MAAsC,EACtC,gBAAgD;IAEhD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,IAAI,MAAM,KAAK,IAAI,IAAI,gBAAgB,KAAK,IAAI,EAAE,CAAC;QACjD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,WAAW;IAGzB,MAAM,KAAK,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;IACvC,MAAM,gBAAgB,GAAG,SAAS,CAAC,sBAAsB,CAAC,CAAC;IAE3D,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAM7D,OAAO;QACL,KAAK;QACL,MAAM;QACN,MAAM,EAAE,MAAM,KAAK,MAAM;QACzB,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,MAAM;QACN,gBAAgB;KACqB,CAAC;AAC1C,CAAC"}
@@ -6,27 +6,46 @@ test("useToolInfo - TypeScript typing", () => {
6
6
  expectTypeOf(result.status);
7
7
  expectTypeOf(result.isPending);
8
8
  expectTypeOf(result.isSuccess);
9
+ expectTypeOf(result.isIdle);
9
10
  expectTypeOf(result.input);
10
11
  });
11
12
  test("should correctly type input, output, and responseMetadata with explicit ToolSignature", () => {
12
13
  const result = useToolInfo();
13
- expectTypeOf(result.input);
14
+ // When idle, input should be undefined
15
+ if (result.status === "idle") {
16
+ expectTypeOf(result.input);
17
+ expectTypeOf(result.output);
18
+ expectTypeOf(result.responseMetadata);
19
+ }
14
20
  // When pending, output and responseMetadata should be undefined
15
21
  if (result.status === "pending") {
22
+ expectTypeOf(result.input);
16
23
  expectTypeOf(result.output);
17
24
  expectTypeOf(result.responseMetadata);
18
25
  }
19
26
  // When success, output and responseMetadata should be defined
20
27
  if (result.status === "success") {
28
+ expectTypeOf(result.input);
21
29
  expectTypeOf(result.output);
22
30
  expectTypeOf(result.responseMetadata);
23
31
  }
24
32
  });
25
33
  test("should correctly narrow types based on status discriminated union", () => {
26
34
  const result = useToolInfo();
27
- // Test type narrowing
35
+ // Test type narrowing for idle
36
+ if (result.isIdle) {
37
+ expectTypeOf(result.status);
38
+ expectTypeOf(result.isIdle);
39
+ expectTypeOf(result.isPending);
40
+ expectTypeOf(result.isSuccess);
41
+ expectTypeOf(result.input);
42
+ expectTypeOf(result.output);
43
+ expectTypeOf(result.responseMetadata);
44
+ }
45
+ // Test type narrowing for pending
28
46
  if (result.isPending) {
29
47
  expectTypeOf(result.status);
48
+ expectTypeOf(result.isIdle);
30
49
  expectTypeOf(result.isPending);
31
50
  expectTypeOf(result.isSuccess);
32
51
  expectTypeOf(result.output);
@@ -34,13 +53,23 @@ test("useToolInfo - TypeScript typing", () => {
34
53
  }
35
54
  if (result.isSuccess) {
36
55
  expectTypeOf(result.status);
56
+ expectTypeOf(result.isIdle);
37
57
  expectTypeOf(result.isPending);
38
58
  expectTypeOf(result.isSuccess);
39
59
  expectTypeOf(result.output);
40
60
  expectTypeOf(result.responseMetadata);
41
61
  }
62
+ if (result.status === "idle") {
63
+ expectTypeOf(result.isIdle);
64
+ expectTypeOf(result.isPending);
65
+ expectTypeOf(result.isSuccess);
66
+ expectTypeOf(result.input);
67
+ expectTypeOf(result.output);
68
+ expectTypeOf(result.responseMetadata);
69
+ }
42
70
  if (result.status === "pending") {
43
71
  expectTypeOf(result.input);
72
+ expectTypeOf(result.isIdle);
44
73
  expectTypeOf(result.isPending);
45
74
  expectTypeOf(result.isSuccess);
46
75
  expectTypeOf(result.output);
@@ -48,6 +77,7 @@ test("useToolInfo - TypeScript typing", () => {
48
77
  }
49
78
  if (result.status === "success") {
50
79
  expectTypeOf(result.input);
80
+ expectTypeOf(result.isIdle);
51
81
  expectTypeOf(result.isPending);
52
82
  expectTypeOf(result.isSuccess);
53
83
  expectTypeOf(result.output);
@@ -56,7 +86,10 @@ test("useToolInfo - TypeScript typing", () => {
56
86
  });
57
87
  test("should handle partial ToolSignature with only input specified", () => {
58
88
  const result = useToolInfo();
59
- expectTypeOf(result.input);
89
+ // Input can be TestInput or undefined (when idle)
90
+ if (result.status === "pending" || result.status === "success") {
91
+ expectTypeOf(result.input);
92
+ }
60
93
  if (result.status === "success") {
61
94
  expectTypeOf(result.output);
62
95
  expectTypeOf(result.responseMetadata);
@@ -64,7 +97,10 @@ test("useToolInfo - TypeScript typing", () => {
64
97
  });
65
98
  test("should handle ToolSignature with only output specified", () => {
66
99
  const result = useToolInfo();
67
- expectTypeOf(result.input);
100
+ // Input can be Record<string, unknown> or undefined (when idle)
101
+ if (result.status === "pending" || result.status === "success") {
102
+ expectTypeOf(result.input);
103
+ }
68
104
  if (result.status === "success") {
69
105
  expectTypeOf(result.output);
70
106
  }
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-tool-info.test-d.js","sourceRoot":"","sources":["../../../src/web/hooks/use-tool-info.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,IAAI,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC3C,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;QAC3E,MAAM,MAAM,GAAG,WAAW,EAAE,CAAC;QAE7B,YAAY,CAAiC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5D,YAAY,CAAU,MAAM,CAAC,SAAS,CAAC,CAAC;QACxC,YAAY,CAAU,MAAM,CAAC,SAAS,CAAC,CAAC;QACxC,YAAY,CAAU,MAAM,CAAC,MAAM,CAAC,CAAC;QACrC,YAAY,CAAsC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uFAAuF,EAAE,GAAG,EAAE;QAKjG,MAAM,MAAM,GAAG,WAAW,EAItB,CAAC;QAEL,uCAAuC;QACvC,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC7B,YAAY,CAAY,MAAM,CAAC,KAAK,CAAC,CAAC;YACtC,YAAY,CAAY,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,YAAY,CAAY,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACnD,CAAC;QAED,gEAAgE;QAChE,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAAY,MAAM,CAAC,KAAK,CAAC,CAAC;YACtC,YAAY,CAAY,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,YAAY,CAAY,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACnD,CAAC;QAED,8DAA8D;QAC9D,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAAY,MAAM,CAAC,KAAK,CAAC,CAAC;YACtC,YAAY,CAAa,MAAM,CAAC,MAAM,CAAC,CAAC;YACxC,YAAY,CAAe,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACtD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAK7E,MAAM,MAAM,GAAG,WAAW,EAItB,CAAC;QAEL,+BAA+B;QAC/B,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,YAAY,CAAS,MAAM,CAAC,MAAM,CAAC,CAAC;YACpC,YAAY,CAAO,MAAM,CAAC,MAAM,CAAC,CAAC;YAClC,YAAY,CAAQ,MAAM,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAQ,MAAM,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAY,MAAM,CAAC,KAAK,CAAC,CAAC;YACtC,YAAY,CAAY,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,YAAY,CAAY,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACnD,CAAC;QAED,kCAAkC;QAClC,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACrB,YAAY,CAAY,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,YAAY,CAAQ,MAAM,CAAC,MAAM,CAAC,CAAC;YACnC,YAAY,CAAO,MAAM,CAAC,SAAS,CAAC,CAAC;YACrC,YAAY,CAAQ,MAAM,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAY,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,YAAY,CAAY,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACnD,CAAC;QAED,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACrB,YAAY,CAAY,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,YAAY,CAAQ,MAAM,CAAC,MAAM,CAAC,CAAC;YACnC,YAAY,CAAQ,MAAM,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAO,MAAM,CAAC,SAAS,CAAC,CAAC;YACrC,YAAY,CAAa,MAAM,CAAC,MAAM,CAAC,CAAC;YACxC,YAAY,CAAe,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC7B,YAAY,CAAO,MAAM,CAAC,MAAM,CAAC,CAAC;YAClC,YAAY,CAAQ,MAAM,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAQ,MAAM,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAY,MAAM,CAAC,KAAK,CAAC,CAAC;YACtC,YAAY,CAAY,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,YAAY,CAAY,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACnD,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAAY,MAAM,CAAC,KAAK,CAAC,CAAC;YACtC,YAAY,CAAQ,MAAM,CAAC,MAAM,CAAC,CAAC;YACnC,YAAY,CAAO,MAAM,CAAC,SAAS,CAAC,CAAC;YACrC,YAAY,CAAQ,MAAM,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAY,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,YAAY,CAAY,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACnD,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAAY,MAAM,CAAC,KAAK,CAAC,CAAC;YACtC,YAAY,CAAQ,MAAM,CAAC,MAAM,CAAC,CAAC;YACnC,YAAY,CAAQ,MAAM,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAO,MAAM,CAAC,SAAS,CAAC,CAAC;YACrC,YAAY,CAAa,MAAM,CAAC,MAAM,CAAC,CAAC;YACxC,YAAY,CAAe,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACtD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;QAGzE,MAAM,MAAM,GAAG,WAAW,EAEtB,CAAC;QAEL,kDAAkD;QAClD,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC/D,YAAY,CAAY,MAAM,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAA0B,MAAM,CAAC,MAAM,CAAC,CAAC;YACrD,YAAY,CAA0B,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACjE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAGlE,MAAM,MAAM,GAAG,WAAW,EAEtB,CAAC;QAEL,gEAAgE;QAChE,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC/D,YAAY,CAA0B,MAAM,CAAC,KAAK,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,YAAY,CAAa,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,130 @@
1
+ import { act, fireEvent, renderHook, waitFor } from "@testing-library/react";
2
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
3
+ import { McpAppAdaptor } from "../bridges/adaptors/mcp-app-adaptor.js";
4
+ import { McpAppBridge } from "../bridges/mcp-app-bridge.js";
5
+ import { SET_GLOBALS_EVENT_TYPE, SetGlobalsEvent, } from "../types.js";
6
+ import { fireToolInputNotification, fireToolResultNotification, getMcpAppHostPostMessageMock, } from "./test/utils.js";
7
+ import { useToolInfo } from "./use-tool-info.js";
8
+ describe("useToolInfo", () => {
9
+ describe("apps-sdk host", () => {
10
+ let OpenaiMock;
11
+ beforeEach(() => {
12
+ OpenaiMock = {
13
+ toolInput: { name: "pokemon", args: { name: "pikachu" } },
14
+ toolOutput: null,
15
+ toolResponseMetadata: null,
16
+ };
17
+ vi.stubGlobal("openai", OpenaiMock);
18
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
19
+ });
20
+ afterEach(() => {
21
+ vi.unstubAllGlobals();
22
+ vi.resetAllMocks();
23
+ });
24
+ it("should return toolInput on initial mount window.openai", () => {
25
+ const { result } = renderHook(() => useToolInfo());
26
+ expect(result.current).toMatchObject({
27
+ input: { name: "pokemon", args: { name: "pikachu" } },
28
+ status: "pending",
29
+ isIdle: false,
30
+ isPending: true,
31
+ isSuccess: false,
32
+ });
33
+ });
34
+ it("should eventually return tool output and response metadata once tool call completes", async () => {
35
+ const toolOutput = {
36
+ name: "pikachu",
37
+ color: "yellow",
38
+ description: "When several of these POKéMON gather, their\felectricity could build and cause lightning storms.",
39
+ };
40
+ const toolResponseMetadata = { id: 12 };
41
+ const { result } = renderHook(() => useToolInfo());
42
+ act(() => {
43
+ OpenaiMock.toolOutput = toolOutput;
44
+ OpenaiMock.toolResponseMetadata = toolResponseMetadata;
45
+ fireEvent(window, new SetGlobalsEvent(SET_GLOBALS_EVENT_TYPE, {
46
+ detail: {
47
+ globals: {
48
+ toolOutput,
49
+ toolResponseMetadata,
50
+ },
51
+ },
52
+ }));
53
+ });
54
+ await waitFor(() => {
55
+ expect(result.current).toMatchObject({
56
+ status: "success",
57
+ isIdle: false,
58
+ isPending: false,
59
+ isSuccess: true,
60
+ output: toolOutput,
61
+ responseMetadata: toolResponseMetadata,
62
+ });
63
+ });
64
+ });
65
+ });
66
+ describe("mcp-app host", () => {
67
+ beforeEach(() => {
68
+ vi.stubGlobal("parent", { postMessage: getMcpAppHostPostMessageMock() });
69
+ vi.stubGlobal("skybridge", { hostType: "mcp-app" });
70
+ });
71
+ afterEach(() => {
72
+ vi.unstubAllGlobals();
73
+ vi.resetAllMocks();
74
+ McpAppBridge.resetInstance();
75
+ McpAppAdaptor.resetInstance();
76
+ });
77
+ it("should return idle state initially when tool input is not yet set", async () => {
78
+ const { result } = renderHook(() => useToolInfo());
79
+ await waitFor(() => {
80
+ expect(result.current).toMatchObject({
81
+ status: "idle",
82
+ isIdle: true,
83
+ isPending: false,
84
+ isSuccess: false,
85
+ input: null,
86
+ output: null,
87
+ responseMetadata: null,
88
+ });
89
+ });
90
+ });
91
+ it("should return pending state with tool input from tool-input notification", async () => {
92
+ const { result } = renderHook(() => useToolInfo());
93
+ act(() => {
94
+ fireToolInputNotification({ name: "pokemon", query: "pikachu" });
95
+ });
96
+ await waitFor(() => {
97
+ expect(result.current).toMatchObject({
98
+ status: "pending",
99
+ isIdle: false,
100
+ isPending: true,
101
+ isSuccess: false,
102
+ input: { name: "pokemon", query: "pikachu" },
103
+ });
104
+ });
105
+ });
106
+ it("should return success state with output from tool-result notification", async () => {
107
+ const { result } = renderHook(() => useToolInfo());
108
+ act(() => {
109
+ fireToolInputNotification({ name: "pokemon", query: "pikachu" });
110
+ fireToolResultNotification({
111
+ content: [{ type: "text", text: "Pikachu data" }],
112
+ structuredContent: { name: "pikachu", color: "yellow" },
113
+ _meta: { requestId: "123" },
114
+ });
115
+ });
116
+ await waitFor(() => {
117
+ expect(result.current).toMatchObject({
118
+ status: "success",
119
+ isIdle: false,
120
+ isPending: false,
121
+ isSuccess: true,
122
+ input: { name: "pokemon", query: "pikachu" },
123
+ output: { name: "pikachu", color: "yellow" },
124
+ responseMetadata: { requestId: "123" },
125
+ });
126
+ });
127
+ });
128
+ });
129
+ });
130
+ //# sourceMappingURL=use-tool-info.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-tool-info.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-tool-info.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAEL,sBAAsB,EACtB,eAAe,GAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,yBAAyB,EACzB,0BAA0B,EAC1B,4BAA4B,GAC7B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,IAAI,UAGH,CAAC;QAEF,UAAU,CAAC,GAAG,EAAE;YACd,UAAU,GAAG;gBACX,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;gBACzD,UAAU,EAAE,IAAI;gBAChB,oBAAoB,EAAE,IAAI;aAC3B,CAAC;YACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACpC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;YAChE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;gBACnC,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;gBACrD,MAAM,EAAE,SAAS;gBACjB,MAAM,EAAE,KAAK;gBACb,SAAS,EAAE,IAAI;gBACf,SAAS,EAAE,KAAK;aACjB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qFAAqF,EAAE,KAAK,IAAI,EAAE;YACnG,MAAM,UAAU,GAAG;gBACjB,IAAI,EAAE,SAAS;gBACf,KAAK,EAAE,QAAQ;gBACf,WAAW,EACT,kGAAkG;aACrG,CAAC;YACF,MAAM,oBAAoB,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;YACxC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,GAAG,CAAC,GAAG,EAAE;gBACP,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC;gBACnC,UAAU,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;gBACvD,SAAS,CACP,MAAM,EACN,IAAI,eAAe,CAAC,sBAAsB,EAAE;oBAC1C,MAAM,EAAE;wBACN,OAAO,EAAE;4BACP,UAAU;4BACV,oBAAoB;yBACrB;qBACF;iBACF,CAAC,CACH,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,KAAK;oBAChB,SAAS,EAAE,IAAI;oBACf,MAAM,EAAE,UAAU;oBAClB,gBAAgB,EAAE,oBAAoB;iBACvC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,4BAA4B,EAAE,EAAE,CAAC,CAAC;YACzE,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;YACjF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,MAAM,EAAE,MAAM;oBACd,MAAM,EAAE,IAAI;oBACZ,SAAS,EAAE,KAAK;oBAChB,SAAS,EAAE,KAAK;oBAChB,KAAK,EAAE,IAAI;oBACX,MAAM,EAAE,IAAI;oBACZ,gBAAgB,EAAE,IAAI;iBACvB,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;YACxF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,GAAG,CAAC,GAAG,EAAE;gBACP,yBAAyB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YACnE,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,IAAI;oBACf,SAAS,EAAE,KAAK;oBAChB,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;iBAC7C,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;YACrF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,GAAG,CAAC,GAAG,EAAE;gBACP,yBAAyB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;gBACjE,0BAA0B,CAAC;oBACzB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;oBACjD,iBAAiB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE;oBACvD,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE;iBAC5B,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,KAAK;oBAChB,SAAS,EAAE,IAAI;oBACf,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;oBAC5C,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE;oBAC5C,gBAAgB,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE;iBACvC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,18 @@
1
+ import type { UserAgent } from "../types.js";
2
+ export type UserState = {
3
+ locale: string;
4
+ userAgent: UserAgent;
5
+ };
6
+ /**
7
+ * Hook for accessing session-stable user information.
8
+ * These values are set once at initialization and do not change during the session.
9
+ *
10
+ * @example
11
+ * ```tsx
12
+ * const { locale, userAgent } = useUser();
13
+ *
14
+ * // Access device type
15
+ * const isMobile = userAgent.device.type === "mobile";
16
+ * ```
17
+ */
18
+ export declare function useUser(): UserState;
@@ -0,0 +1,19 @@
1
+ import { useBridge } from "../bridges/index.js";
2
+ /**
3
+ * Hook for accessing session-stable user information.
4
+ * These values are set once at initialization and do not change during the session.
5
+ *
6
+ * @example
7
+ * ```tsx
8
+ * const { locale, userAgent } = useUser();
9
+ *
10
+ * // Access device type
11
+ * const isMobile = userAgent.device.type === "mobile";
12
+ * ```
13
+ */
14
+ export function useUser() {
15
+ const locale = useBridge("locale");
16
+ const userAgent = useBridge("userAgent");
17
+ return { locale, userAgent };
18
+ }
19
+ //# sourceMappingURL=use-user.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-user.js","sourceRoot":"","sources":["../../../src/web/hooks/use-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAQhD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,OAAO;IACrB,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;IACnC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;IAEzC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AAC/B,CAAC"}
@@ -0,0 +1,93 @@
1
+ import { renderHook, waitFor } from "@testing-library/react";
2
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
3
+ import { McpAppAdaptor } from "../bridges/adaptors/mcp-app-adaptor.js";
4
+ import { McpAppBridge } from "../bridges/mcp-app-bridge.js";
5
+ import { getMcpAppHostPostMessageMock } from "./test/utils.js";
6
+ import { useUser } from "./use-user.js";
7
+ describe("useUser", () => {
8
+ describe("apps-sdk host type", () => {
9
+ let OpenaiMock;
10
+ beforeEach(() => {
11
+ OpenaiMock = {
12
+ locale: "en-US",
13
+ userAgent: {
14
+ device: { type: "desktop" },
15
+ capabilities: { hover: true, touch: false },
16
+ },
17
+ };
18
+ vi.stubGlobal("openai", OpenaiMock);
19
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
20
+ });
21
+ afterEach(() => {
22
+ vi.unstubAllGlobals();
23
+ vi.resetAllMocks();
24
+ });
25
+ it("should return locale and userAgent from window.openai", () => {
26
+ const { result } = renderHook(() => useUser());
27
+ expect(result.current.locale).toBe("en-US");
28
+ expect(result.current.userAgent).toEqual({
29
+ device: { type: "desktop" },
30
+ capabilities: { hover: true, touch: false },
31
+ });
32
+ });
33
+ it("should return mobile userAgent when set to mobile", () => {
34
+ OpenaiMock.userAgent = {
35
+ device: { type: "mobile" },
36
+ capabilities: { hover: false, touch: true },
37
+ };
38
+ const { result } = renderHook(() => useUser());
39
+ expect(result.current.userAgent.device.type).toBe("mobile");
40
+ expect(result.current.userAgent.capabilities.touch).toBe(true);
41
+ });
42
+ it("should return different locale when set", () => {
43
+ OpenaiMock.locale = "es-ES";
44
+ const { result } = renderHook(() => useUser());
45
+ expect(result.current.locale).toBe("es-ES");
46
+ });
47
+ });
48
+ describe("mcp-app host type", () => {
49
+ beforeEach(() => {
50
+ vi.stubGlobal("skybridge", { hostType: "mcp-app" });
51
+ });
52
+ afterEach(() => {
53
+ vi.unstubAllGlobals();
54
+ vi.resetAllMocks();
55
+ McpAppBridge.resetInstance();
56
+ McpAppAdaptor.resetInstance();
57
+ });
58
+ it("should return locale and userAgent from mcp host context", async () => {
59
+ vi.stubGlobal("parent", {
60
+ postMessage: getMcpAppHostPostMessageMock({
61
+ locale: "fr-FR",
62
+ platform: "web",
63
+ deviceCapabilities: { hover: true, touch: false },
64
+ }),
65
+ });
66
+ const { result } = renderHook(() => useUser());
67
+ await waitFor(() => {
68
+ expect(result.current.locale).toBe("fr-FR");
69
+ expect(result.current.userAgent).toEqual({
70
+ device: { type: "desktop" },
71
+ capabilities: { hover: true, touch: false },
72
+ });
73
+ });
74
+ });
75
+ it("should maintain userAgent referential stability when data has not changed", async () => {
76
+ vi.stubGlobal("parent", {
77
+ postMessage: getMcpAppHostPostMessageMock({
78
+ locale: "en-US",
79
+ platform: "web",
80
+ deviceCapabilities: { hover: true, touch: false },
81
+ }),
82
+ });
83
+ const { result, rerender } = renderHook(() => useUser());
84
+ await waitFor(() => {
85
+ expect(result.current.userAgent).toBeDefined();
86
+ });
87
+ const initialUserAgent = result.current.userAgent;
88
+ rerender();
89
+ expect(result.current.userAgent).toBe(initialUserAgent);
90
+ });
91
+ });
92
+ });
93
+ //# sourceMappingURL=use-user.test.js.map