skybridge 0.0.0-dev.fec1c58 → 0.0.0-dev.fef24cf

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 (309) hide show
  1. package/README.md +123 -116
  2. package/dist/cli/detect-port.d.ts +18 -0
  3. package/dist/cli/detect-port.js +61 -0
  4. package/dist/cli/detect-port.js.map +1 -0
  5. package/dist/cli/header.js +1 -1
  6. package/dist/cli/header.js.map +1 -1
  7. package/dist/cli/run-command.js.map +1 -1
  8. package/dist/cli/telemetry.js.map +1 -1
  9. package/dist/cli/tunnel-control-server.d.ts +9 -0
  10. package/dist/cli/tunnel-control-server.js +31 -0
  11. package/dist/cli/tunnel-control-server.js.map +1 -0
  12. package/dist/cli/tunnel-control-server.test.js +39 -0
  13. package/dist/cli/tunnel-control-server.test.js.map +1 -0
  14. package/dist/cli/tunnel-handler.d.ts +3 -0
  15. package/dist/cli/tunnel-handler.js +48 -0
  16. package/dist/cli/tunnel-handler.js.map +1 -0
  17. package/dist/cli/tunnel-handler.test.js +105 -0
  18. package/dist/cli/tunnel-handler.test.js.map +1 -0
  19. package/dist/cli/tunnel.d.ts +57 -0
  20. package/dist/cli/tunnel.js +154 -0
  21. package/dist/cli/tunnel.js.map +1 -0
  22. package/dist/cli/tunnel.test.d.ts +1 -0
  23. package/dist/cli/tunnel.test.js +190 -0
  24. package/dist/cli/tunnel.test.js.map +1 -0
  25. package/dist/cli/types.d.ts +5 -0
  26. package/dist/cli/types.js +2 -0
  27. package/dist/cli/types.js.map +1 -0
  28. package/dist/cli/use-execute-steps.js.map +1 -1
  29. package/dist/cli/use-messages.d.ts +3 -0
  30. package/dist/cli/use-messages.js +11 -0
  31. package/dist/cli/use-messages.js.map +1 -0
  32. package/dist/cli/use-nodemon.d.ts +2 -6
  33. package/dist/cli/use-nodemon.js +18 -14
  34. package/dist/cli/use-nodemon.js.map +1 -1
  35. package/dist/cli/use-open-browser.d.ts +1 -0
  36. package/dist/cli/use-open-browser.js +44 -0
  37. package/dist/cli/use-open-browser.js.map +1 -0
  38. package/dist/cli/use-tunnel.d.ts +14 -0
  39. package/dist/cli/use-tunnel.js +131 -0
  40. package/dist/cli/use-tunnel.js.map +1 -0
  41. package/dist/cli/use-typescript-check.d.ts +1 -0
  42. package/dist/cli/use-typescript-check.js +42 -7
  43. package/dist/cli/use-typescript-check.js.map +1 -1
  44. package/dist/commands/build.js +63 -7
  45. package/dist/commands/build.js.map +1 -1
  46. package/dist/commands/create.d.ts +9 -0
  47. package/dist/commands/create.js +30 -0
  48. package/dist/commands/create.js.map +1 -0
  49. package/dist/commands/dev.d.ts +4 -1
  50. package/dist/commands/dev.js +57 -8
  51. package/dist/commands/dev.js.map +1 -1
  52. package/dist/commands/start.d.ts +3 -1
  53. package/dist/commands/start.js +30 -9
  54. package/dist/commands/start.js.map +1 -1
  55. package/dist/commands/telemetry/disable.js.map +1 -1
  56. package/dist/commands/telemetry/enable.js.map +1 -1
  57. package/dist/commands/telemetry/status.js.map +1 -1
  58. package/dist/server/asset-base-url-transform-plugin.d.ts +6 -6
  59. package/dist/server/asset-base-url-transform-plugin.js +25 -11
  60. package/dist/server/asset-base-url-transform-plugin.js.map +1 -1
  61. package/dist/server/asset-base-url-transform-plugin.test.js +92 -14
  62. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -1
  63. package/dist/server/auth.d.ts +20 -0
  64. package/dist/server/auth.js +28 -0
  65. package/dist/server/auth.js.map +1 -0
  66. package/dist/server/content-helpers.d.ts +67 -0
  67. package/dist/server/content-helpers.js +79 -0
  68. package/dist/server/content-helpers.js.map +1 -0
  69. package/dist/server/content-helpers.test.d.ts +1 -0
  70. package/dist/server/content-helpers.test.js +70 -0
  71. package/dist/server/content-helpers.test.js.map +1 -0
  72. package/dist/server/express.d.ts +7 -5
  73. package/dist/server/express.js +60 -28
  74. package/dist/server/express.js.map +1 -1
  75. package/dist/server/express.test.js +381 -25
  76. package/dist/server/express.test.js.map +1 -1
  77. package/dist/server/file-ref.d.ts +28 -0
  78. package/dist/server/file-ref.js +27 -0
  79. package/dist/server/file-ref.js.map +1 -0
  80. package/dist/server/index.d.ts +7 -3
  81. package/dist/server/index.js +5 -2
  82. package/dist/server/index.js.map +1 -1
  83. package/dist/server/inferUtilityTypes.d.ts +6 -6
  84. package/dist/server/inferUtilityTypes.js.map +1 -1
  85. package/dist/server/metric.d.ts +14 -0
  86. package/dist/server/metric.js +62 -0
  87. package/dist/server/metric.js.map +1 -0
  88. package/dist/server/middleware.d.ts +137 -0
  89. package/dist/server/middleware.js +93 -0
  90. package/dist/server/middleware.js.map +1 -0
  91. package/dist/server/middleware.test-d.d.ts +1 -0
  92. package/dist/server/middleware.test-d.js +75 -0
  93. package/dist/server/middleware.test-d.js.map +1 -0
  94. package/dist/server/middleware.test.d.ts +1 -0
  95. package/dist/server/middleware.test.js +493 -0
  96. package/dist/server/middleware.test.js.map +1 -0
  97. package/dist/server/server.d.ts +358 -69
  98. package/dist/server/server.js +469 -102
  99. package/dist/server/server.js.map +1 -1
  100. package/dist/server/templateHelper.d.ts +5 -8
  101. package/dist/server/templateHelper.js +3 -22
  102. package/dist/server/templateHelper.js.map +1 -1
  103. package/dist/server/templates.generated.d.ts +4 -0
  104. package/dist/server/templates.generated.js +47 -0
  105. package/dist/server/templates.generated.js.map +1 -0
  106. package/dist/server/tunnel-proxy-router.d.ts +7 -0
  107. package/dist/server/tunnel-proxy-router.js +110 -0
  108. package/dist/server/tunnel-proxy-router.js.map +1 -0
  109. package/dist/server/tunnel-proxy-router.test.d.ts +1 -0
  110. package/dist/server/tunnel-proxy-router.test.js +229 -0
  111. package/dist/server/tunnel-proxy-router.test.js.map +1 -0
  112. package/dist/server/viewsDevServer.d.ts +14 -0
  113. package/dist/server/viewsDevServer.js +45 -0
  114. package/dist/server/viewsDevServer.js.map +1 -0
  115. package/dist/test/utils.d.ts +16 -244
  116. package/dist/test/utils.js +42 -37
  117. package/dist/test/utils.js.map +1 -1
  118. package/dist/test/view.test.d.ts +1 -0
  119. package/dist/test/view.test.js +568 -0
  120. package/dist/test/view.test.js.map +1 -0
  121. package/dist/version.d.ts +1 -0
  122. package/dist/version.js +3 -0
  123. package/dist/version.js.map +1 -0
  124. package/dist/web/bridges/apps-sdk/adaptor.d.ts +13 -7
  125. package/dist/web/bridges/apps-sdk/adaptor.js +62 -29
  126. package/dist/web/bridges/apps-sdk/adaptor.js.map +1 -1
  127. package/dist/web/bridges/apps-sdk/bridge.d.ts +2 -1
  128. package/dist/web/bridges/apps-sdk/bridge.js +1 -0
  129. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -1
  130. package/dist/web/bridges/apps-sdk/index.d.ts +1 -1
  131. package/dist/web/bridges/apps-sdk/index.js.map +1 -1
  132. package/dist/web/bridges/apps-sdk/types.d.ts +26 -11
  133. package/dist/web/bridges/apps-sdk/types.js.map +1 -1
  134. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +11 -0
  135. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +11 -0
  136. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -1
  137. package/dist/web/bridges/get-adaptor.d.ts +7 -0
  138. package/dist/web/bridges/get-adaptor.js +7 -0
  139. package/dist/web/bridges/get-adaptor.js.map +1 -1
  140. package/dist/web/bridges/index.js.map +1 -1
  141. package/dist/web/bridges/mcp-app/adaptor.d.ts +25 -9
  142. package/dist/web/bridges/mcp-app/adaptor.js +156 -66
  143. package/dist/web/bridges/mcp-app/adaptor.js.map +1 -1
  144. package/dist/web/bridges/mcp-app/bridge.d.ts +14 -30
  145. package/dist/web/bridges/mcp-app/bridge.js +44 -196
  146. package/dist/web/bridges/mcp-app/bridge.js.map +1 -1
  147. package/dist/web/bridges/mcp-app/index.js.map +1 -1
  148. package/dist/web/bridges/mcp-app/types.js.map +1 -1
  149. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +17 -3
  150. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +14 -2
  151. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -1
  152. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js +1 -41
  153. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -1
  154. package/dist/web/bridges/types.d.ts +87 -14
  155. package/dist/web/bridges/types.js.map +1 -1
  156. package/dist/web/bridges/use-host-context.d.ts +5 -0
  157. package/dist/web/bridges/use-host-context.js +5 -0
  158. package/dist/web/bridges/use-host-context.js.map +1 -1
  159. package/dist/web/components/modal-provider.js +3 -5
  160. package/dist/web/components/modal-provider.js.map +1 -1
  161. package/dist/web/create-store.d.ts +26 -0
  162. package/dist/web/create-store.js +43 -3
  163. package/dist/web/create-store.js.map +1 -1
  164. package/dist/web/create-store.test.js +21 -18
  165. package/dist/web/create-store.test.js.map +1 -1
  166. package/dist/web/data-llm.d.ts +34 -1
  167. package/dist/web/data-llm.js +31 -3
  168. package/dist/web/data-llm.js.map +1 -1
  169. package/dist/web/data-llm.test.js +24 -23
  170. package/dist/web/data-llm.test.js.map +1 -1
  171. package/dist/web/generate-helpers.d.ts +22 -18
  172. package/dist/web/generate-helpers.js +22 -18
  173. package/dist/web/generate-helpers.js.map +1 -1
  174. package/dist/web/generate-helpers.test-d.js +26 -26
  175. package/dist/web/generate-helpers.test-d.js.map +1 -1
  176. package/dist/web/generate-helpers.test.js.map +1 -1
  177. package/dist/web/helpers/state.d.ts +2 -2
  178. package/dist/web/helpers/state.js +11 -11
  179. package/dist/web/helpers/state.js.map +1 -1
  180. package/dist/web/helpers/state.test.js +9 -9
  181. package/dist/web/helpers/state.test.js.map +1 -1
  182. package/dist/web/hooks/index.d.ts +5 -2
  183. package/dist/web/hooks/index.js +4 -1
  184. package/dist/web/hooks/index.js.map +1 -1
  185. package/dist/web/hooks/test/utils.d.ts +6 -2
  186. package/dist/web/hooks/test/utils.js +17 -2
  187. package/dist/web/hooks/test/utils.js.map +1 -1
  188. package/dist/web/hooks/use-call-tool.d.ts +45 -0
  189. package/dist/web/hooks/use-call-tool.js +28 -0
  190. package/dist/web/hooks/use-call-tool.js.map +1 -1
  191. package/dist/web/hooks/use-call-tool.test-d.js.map +1 -1
  192. package/dist/web/hooks/use-call-tool.test.js +27 -6
  193. package/dist/web/hooks/use-call-tool.test.js.map +1 -1
  194. package/dist/web/hooks/use-display-mode.d.ts +23 -3
  195. package/dist/web/hooks/use-display-mode.js +20 -0
  196. package/dist/web/hooks/use-display-mode.js.map +1 -1
  197. package/dist/web/hooks/use-display-mode.test-d.d.ts +1 -0
  198. package/dist/web/hooks/use-display-mode.test-d.js +8 -0
  199. package/dist/web/hooks/use-display-mode.test-d.js.map +1 -0
  200. package/dist/web/hooks/use-display-mode.test.js.map +1 -1
  201. package/dist/web/hooks/use-download.d.ts +5 -0
  202. package/dist/web/hooks/use-download.js +8 -0
  203. package/dist/web/hooks/use-download.js.map +1 -0
  204. package/dist/web/hooks/use-download.test.d.ts +1 -0
  205. package/dist/web/hooks/use-download.test.js +95 -0
  206. package/dist/web/hooks/use-download.test.js.map +1 -0
  207. package/dist/web/hooks/use-files.d.ts +34 -1
  208. package/dist/web/hooks/use-files.js +33 -0
  209. package/dist/web/hooks/use-files.js.map +1 -1
  210. package/dist/web/hooks/use-files.test.js +22 -2
  211. package/dist/web/hooks/use-files.test.js.map +1 -1
  212. package/dist/web/hooks/use-layout.d.ts +2 -0
  213. package/dist/web/hooks/use-layout.js +2 -0
  214. package/dist/web/hooks/use-layout.js.map +1 -1
  215. package/dist/web/hooks/use-layout.test.js +3 -3
  216. package/dist/web/hooks/use-layout.test.js.map +1 -1
  217. package/dist/web/hooks/use-open-external.d.ts +20 -1
  218. package/dist/web/hooks/use-open-external.js +17 -1
  219. package/dist/web/hooks/use-open-external.js.map +1 -1
  220. package/dist/web/hooks/use-open-external.test.js +26 -11
  221. package/dist/web/hooks/use-open-external.test.js.map +1 -1
  222. package/dist/web/hooks/use-request-close.d.ts +16 -0
  223. package/dist/web/hooks/use-request-close.js +21 -0
  224. package/dist/web/hooks/use-request-close.js.map +1 -0
  225. package/dist/web/hooks/use-request-close.test.d.ts +1 -0
  226. package/dist/web/hooks/use-request-close.test.js +52 -0
  227. package/dist/web/hooks/use-request-close.test.js.map +1 -0
  228. package/dist/web/hooks/use-request-modal.d.ts +16 -1
  229. package/dist/web/hooks/use-request-modal.js +19 -4
  230. package/dist/web/hooks/use-request-modal.js.map +1 -1
  231. package/dist/web/hooks/use-request-modal.test.js +5 -1
  232. package/dist/web/hooks/use-request-modal.test.js.map +1 -1
  233. package/dist/web/hooks/use-request-size.d.ts +20 -0
  234. package/dist/web/hooks/use-request-size.js +24 -0
  235. package/dist/web/hooks/use-request-size.js.map +1 -0
  236. package/dist/web/hooks/use-request-size.test.d.ts +1 -0
  237. package/dist/web/hooks/use-request-size.test.js +65 -0
  238. package/dist/web/hooks/use-request-size.test.js.map +1 -0
  239. package/dist/web/hooks/use-send-follow-up-message.d.ts +19 -1
  240. package/dist/web/hooks/use-send-follow-up-message.js +19 -2
  241. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -1
  242. package/dist/web/hooks/use-set-open-in-app-url.d.ts +17 -0
  243. package/dist/web/hooks/use-set-open-in-app-url.js +17 -0
  244. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -1
  245. package/dist/web/hooks/use-set-open-in-app-url.test.js +5 -11
  246. package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -1
  247. package/dist/web/hooks/use-tool-info.d.ts +33 -0
  248. package/dist/web/hooks/use-tool-info.js +26 -0
  249. package/dist/web/hooks/use-tool-info.js.map +1 -1
  250. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -1
  251. package/dist/web/hooks/use-tool-info.test.js +1 -1
  252. package/dist/web/hooks/use-tool-info.test.js.map +1 -1
  253. package/dist/web/hooks/use-user.d.ts +2 -0
  254. package/dist/web/hooks/use-user.js +20 -2
  255. package/dist/web/hooks/use-user.js.map +1 -1
  256. package/dist/web/hooks/use-user.test.js +29 -1
  257. package/dist/web/hooks/use-user.test.js.map +1 -1
  258. package/dist/web/hooks/use-view-state.d.ts +25 -0
  259. package/dist/web/hooks/use-view-state.js +32 -0
  260. package/dist/web/hooks/use-view-state.js.map +1 -0
  261. package/dist/web/hooks/use-view-state.test.d.ts +1 -0
  262. package/dist/web/hooks/use-view-state.test.js +177 -0
  263. package/dist/web/hooks/use-view-state.test.js.map +1 -0
  264. package/dist/web/index.d.ts +1 -2
  265. package/dist/web/index.js +1 -2
  266. package/dist/web/index.js.map +1 -1
  267. package/dist/web/mount-view.d.ts +20 -0
  268. package/dist/web/{mount-widget.js → mount-view.js} +21 -2
  269. package/dist/web/mount-view.js.map +1 -0
  270. package/dist/web/plugin/data-llm.test.js.map +1 -1
  271. package/dist/web/plugin/plugin.d.ts +32 -1
  272. package/dist/web/plugin/plugin.js +161 -18
  273. package/dist/web/plugin/plugin.js.map +1 -1
  274. package/dist/web/plugin/scan-views.d.ts +16 -0
  275. package/dist/web/plugin/scan-views.js +88 -0
  276. package/dist/web/plugin/scan-views.js.map +1 -0
  277. package/dist/web/plugin/scan-views.test.d.ts +1 -0
  278. package/dist/web/plugin/scan-views.test.js +99 -0
  279. package/dist/web/plugin/scan-views.test.js.map +1 -0
  280. package/dist/web/plugin/transform-data-llm.js +1 -1
  281. package/dist/web/plugin/transform-data-llm.js.map +1 -1
  282. package/dist/web/plugin/transform-data-llm.test.js.map +1 -1
  283. package/dist/web/plugin/validate-view.d.ts +1 -0
  284. package/dist/web/plugin/validate-view.js +9 -0
  285. package/dist/web/plugin/validate-view.js.map +1 -0
  286. package/dist/web/plugin/validate-view.test.d.ts +1 -0
  287. package/dist/web/plugin/validate-view.test.js +24 -0
  288. package/dist/web/plugin/validate-view.test.js.map +1 -0
  289. package/dist/web/proxy.js.map +1 -1
  290. package/dist/web/types.d.ts +4 -0
  291. package/dist/web/types.js.map +1 -1
  292. package/package.json +42 -25
  293. package/tsconfig.base.json +33 -0
  294. package/dist/server/templates/development.hbs +0 -67
  295. package/dist/server/templates/production.hbs +0 -6
  296. package/dist/server/widgetsDevServer.d.ts +0 -12
  297. package/dist/server/widgetsDevServer.js +0 -57
  298. package/dist/server/widgetsDevServer.js.map +0 -1
  299. package/dist/test/widget.test.js +0 -261
  300. package/dist/test/widget.test.js.map +0 -1
  301. package/dist/web/hooks/use-widget-state.d.ts +0 -4
  302. package/dist/web/hooks/use-widget-state.js +0 -32
  303. package/dist/web/hooks/use-widget-state.js.map +0 -1
  304. package/dist/web/hooks/use-widget-state.test.js +0 -62
  305. package/dist/web/hooks/use-widget-state.test.js.map +0 -1
  306. package/dist/web/mount-widget.d.ts +0 -1
  307. package/dist/web/mount-widget.js.map +0 -1
  308. /package/dist/{test/widget.test.d.ts → cli/tunnel-control-server.test.d.ts} +0 -0
  309. /package/dist/{web/hooks/use-widget-state.test.d.ts → cli/tunnel-handler.test.d.ts} +0 -0
@@ -1,4 +1,20 @@
1
1
  import { useHostContext } from "../bridges/index.js";
2
+ const DEFAULT_LOCALE = "en-US";
3
+ /**
4
+ * Normalizes a locale string to canonical BCP 47 format using {@link Intl.Locale}.
5
+ *
6
+ * Handles underscored identifiers returned by the ChatGPT mobile app (e.g. "fr_FR" → "fr-FR"),
7
+ * incorrect casing (e.g. "en-us" → "en-US"), and complex subtags (e.g. "zh_Hans_CN" → "zh-Hans-CN").
8
+ * Falls back to "en-US" if the locale is invalid.
9
+ */
10
+ function normalizeLocale(locale) {
11
+ try {
12
+ return new Intl.Locale(locale.replace(/_/g, "-")).toString();
13
+ }
14
+ catch {
15
+ return DEFAULT_LOCALE;
16
+ }
17
+ }
2
18
  /**
3
19
  * Hook for accessing session-stable user information.
4
20
  * These values are set once at initialization and do not change during the session.
@@ -10,10 +26,12 @@ import { useHostContext } from "../bridges/index.js";
10
26
  * // Access device type
11
27
  * const isMobile = userAgent.device.type === "mobile";
12
28
  * ```
29
+ *
30
+ * @see https://docs.skybridge.tech/api-reference/use-user
13
31
  */
14
32
  export function useUser() {
15
- const locale = useHostContext("locale");
33
+ const rawLocale = useHostContext("locale");
16
34
  const userAgent = useHostContext("userAgent");
17
- return { locale, userAgent };
35
+ return { locale: normalizeLocale(rawLocale), userAgent };
18
36
  }
19
37
  //# sourceMappingURL=use-user.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"use-user.js","sourceRoot":"","sources":["../../../src/web/hooks/use-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAOrE;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,OAAO;IACrB,MAAM,MAAM,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IACxC,MAAM,SAAS,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;IAE9C,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AAC/B,CAAC"}
1
+ {"version":3,"file":"use-user.js","sourceRoot":"","sources":["../../../src/web/hooks/use-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAOrE,MAAM,cAAc,GAAG,OAAO,CAAC;AAE/B;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,MAAc;IACrC,IAAI,CAAC;QACH,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,cAAc,CAAC;IACxB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,OAAO;IACrB,MAAM,SAAS,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;IAE9C,OAAO,EAAE,MAAM,EAAE,eAAe,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC;AAC3D,CAAC","sourcesContent":["import { type UserAgent, useHostContext } from \"../bridges/index.js\";\n\nexport type UserState = {\n locale: string;\n userAgent: UserAgent;\n};\n\nconst DEFAULT_LOCALE = \"en-US\";\n\n/**\n * Normalizes a locale string to canonical BCP 47 format using {@link Intl.Locale}.\n *\n * Handles underscored identifiers returned by the ChatGPT mobile app (e.g. \"fr_FR\" → \"fr-FR\"),\n * incorrect casing (e.g. \"en-us\" → \"en-US\"), and complex subtags (e.g. \"zh_Hans_CN\" → \"zh-Hans-CN\").\n * Falls back to \"en-US\" if the locale is invalid.\n */\nfunction normalizeLocale(locale: string): string {\n try {\n return new Intl.Locale(locale.replace(/_/g, \"-\")).toString();\n } catch {\n return DEFAULT_LOCALE;\n }\n}\n\n/**\n * Hook for accessing session-stable user information.\n * These values are set once at initialization and do not change during the session.\n *\n * @example\n * ```tsx\n * const { locale, userAgent } = useUser();\n *\n * // Access device type\n * const isMobile = userAgent.device.type === \"mobile\";\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-user\n */\nexport function useUser(): UserState {\n const rawLocale = useHostContext(\"locale\");\n const userAgent = useHostContext(\"userAgent\");\n\n return { locale: normalizeLocale(rawLocale), userAgent };\n}\n"]}
@@ -44,13 +44,28 @@ describe("useUser", () => {
44
44
  const { result } = renderHook(() => useUser());
45
45
  expect(result.current.locale).toBe("es-ES");
46
46
  });
47
+ it("should normalize underscore locale to BCP 47 hyphen format", () => {
48
+ OpenaiMock.locale = "fr_FR";
49
+ const { result } = renderHook(() => useUser());
50
+ expect(result.current.locale).toBe("fr-FR");
51
+ });
52
+ it("should canonicalize locale casing", () => {
53
+ OpenaiMock.locale = "en-us";
54
+ const { result } = renderHook(() => useUser());
55
+ expect(result.current.locale).toBe("en-US");
56
+ });
57
+ it("should fall back to en-US for invalid locale", () => {
58
+ OpenaiMock.locale = "not-a-locale-!!";
59
+ const { result } = renderHook(() => useUser());
60
+ expect(result.current.locale).toBe("en-US");
61
+ });
47
62
  });
48
63
  describe("mcp-app host type", () => {
49
64
  beforeEach(() => {
50
65
  vi.stubGlobal("skybridge", { hostType: "mcp-app" });
51
66
  vi.stubGlobal("ResizeObserver", MockResizeObserver);
52
67
  });
53
- afterEach(() => {
68
+ afterEach(async () => {
54
69
  vi.unstubAllGlobals();
55
70
  vi.resetAllMocks();
56
71
  McpAppBridge.resetInstance();
@@ -73,6 +88,19 @@ describe("useUser", () => {
73
88
  });
74
89
  });
75
90
  });
91
+ it("should normalize underscore locale to BCP 47 hyphen format", async () => {
92
+ vi.stubGlobal("parent", {
93
+ postMessage: getMcpAppHostPostMessageMock({
94
+ locale: "fr_FR",
95
+ platform: "web",
96
+ deviceCapabilities: { hover: true, touch: false },
97
+ }),
98
+ });
99
+ const { result } = renderHook(() => useUser());
100
+ await waitFor(() => {
101
+ expect(result.current.locale).toBe("fr-FR");
102
+ });
103
+ });
76
104
  it("should maintain userAgent referential stability when data has not changed", async () => {
77
105
  vi.stubGlobal("parent", {
78
106
  postMessage: getMcpAppHostPostMessageMock({
@@ -1 +1 @@
1
- {"version":3,"file":"use-user.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-user.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,IAAI,UAGH,CAAC;QAEF,UAAU,CAAC,GAAG,EAAE;YACd,UAAU,GAAG;gBACX,MAAM,EAAE,OAAO;gBACf,SAAS,EAAE;oBACT,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;oBAC3B,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAC5C;aACF,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,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;gBACvC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC3B,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;aAC5C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAC3D,UAAU,CAAC,SAAS,GAAG;gBACrB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAC1B,YAAY,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE;aAC5C,CAAC;YACF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5D,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,UAAU,CAAC,MAAM,GAAG,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;YACpD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;oBACvC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;oBAC3B,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAC5C,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2EAA2E,EAAE,KAAK,IAAI,EAAE;YACzF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAEzD,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;YACjD,CAAC,CAAC,CAAC;YAEH,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;YAElD,QAAQ,EAAE,CAAC;YAEX,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"use-user.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-user.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,IAAI,UAGH,CAAC;QAEF,UAAU,CAAC,GAAG,EAAE;YACd,UAAU,GAAG;gBACX,MAAM,EAAE,OAAO;gBACf,SAAS,EAAE;oBACT,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;oBAC3B,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAC5C;aACF,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,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;gBACvC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC3B,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;aAC5C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAC3D,UAAU,CAAC,SAAS,GAAG;gBACrB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAC1B,YAAY,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE;aAC5C,CAAC;YACF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5D,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,UAAU,CAAC,MAAM,GAAG,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;YACpE,UAAU,CAAC,MAAM,GAAG,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC3C,UAAU,CAAC,MAAM,GAAG,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,UAAU,CAAC,MAAM,GAAG,iBAAiB,CAAC;YACtC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;YACpD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;oBACvC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;oBAC3B,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAC5C,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;YAC1E,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2EAA2E,EAAE,KAAK,IAAI,EAAE;YACzF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAEzD,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;YACjD,CAAC,CAAC,CAAC;YAEH,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;YAElD,QAAQ,EAAE,CAAC;YAEX,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { renderHook, waitFor } from \"@testing-library/react\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { McpAppAdaptor } from \"../bridges/mcp-app/adaptor.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/bridge.js\";\nimport type { UserAgent } from \"../bridges/types.js\";\nimport {\n getMcpAppHostPostMessageMock,\n MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useUser } from \"./use-user.js\";\n\ndescribe(\"useUser\", () => {\n describe(\"apps-sdk host type\", () => {\n let OpenaiMock: {\n locale: string;\n userAgent: UserAgent;\n };\n\n beforeEach(() => {\n OpenaiMock = {\n locale: \"en-US\",\n userAgent: {\n device: { type: \"desktop\" },\n capabilities: { hover: true, touch: false },\n },\n };\n vi.stubGlobal(\"openai\", OpenaiMock);\n vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n });\n\n it(\"should return locale and userAgent from window.openai\", () => {\n const { result } = renderHook(() => useUser());\n\n expect(result.current.locale).toBe(\"en-US\");\n expect(result.current.userAgent).toEqual({\n device: { type: \"desktop\" },\n capabilities: { hover: true, touch: false },\n });\n });\n\n it(\"should return mobile userAgent when set to mobile\", () => {\n OpenaiMock.userAgent = {\n device: { type: \"mobile\" },\n capabilities: { hover: false, touch: true },\n };\n const { result } = renderHook(() => useUser());\n\n expect(result.current.userAgent.device.type).toBe(\"mobile\");\n expect(result.current.userAgent.capabilities.touch).toBe(true);\n });\n\n it(\"should return different locale when set\", () => {\n OpenaiMock.locale = \"es-ES\";\n const { result } = renderHook(() => useUser());\n\n expect(result.current.locale).toBe(\"es-ES\");\n });\n\n it(\"should normalize underscore locale to BCP 47 hyphen format\", () => {\n OpenaiMock.locale = \"fr_FR\";\n const { result } = renderHook(() => useUser());\n\n expect(result.current.locale).toBe(\"fr-FR\");\n });\n\n it(\"should canonicalize locale casing\", () => {\n OpenaiMock.locale = \"en-us\";\n const { result } = renderHook(() => useUser());\n\n expect(result.current.locale).toBe(\"en-US\");\n });\n\n it(\"should fall back to en-US for invalid locale\", () => {\n OpenaiMock.locale = \"not-a-locale-!!\";\n const { result } = renderHook(() => useUser());\n\n expect(result.current.locale).toBe(\"en-US\");\n });\n });\n\n describe(\"mcp-app host type\", () => {\n beforeEach(() => {\n vi.stubGlobal(\"skybridge\", { hostType: \"mcp-app\" });\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n });\n\n afterEach(async () => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n McpAppBridge.resetInstance();\n McpAppAdaptor.resetInstance();\n });\n\n it(\"should return locale and userAgent from mcp host context\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n locale: \"fr-FR\",\n platform: \"web\",\n deviceCapabilities: { hover: true, touch: false },\n }),\n });\n const { result } = renderHook(() => useUser());\n\n await waitFor(() => {\n expect(result.current.locale).toBe(\"fr-FR\");\n expect(result.current.userAgent).toEqual({\n device: { type: \"desktop\" },\n capabilities: { hover: true, touch: false },\n });\n });\n });\n\n it(\"should normalize underscore locale to BCP 47 hyphen format\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n locale: \"fr_FR\",\n platform: \"web\",\n deviceCapabilities: { hover: true, touch: false },\n }),\n });\n const { result } = renderHook(() => useUser());\n\n await waitFor(() => {\n expect(result.current.locale).toBe(\"fr-FR\");\n });\n });\n\n it(\"should maintain userAgent referential stability when data has not changed\", async () => {\n vi.stubGlobal(\"parent\", {\n postMessage: getMcpAppHostPostMessageMock({\n locale: \"en-US\",\n platform: \"web\",\n deviceCapabilities: { hover: true, touch: false },\n }),\n });\n const { result, rerender } = renderHook(() => useUser());\n\n await waitFor(() => {\n expect(result.current.userAgent).toBeDefined();\n });\n\n const initialUserAgent = result.current.userAgent;\n\n rerender();\n\n expect(result.current.userAgent).toBe(initialUserAgent);\n });\n });\n});\n"]}
@@ -0,0 +1,25 @@
1
+ import { type SetStateAction } from "react";
2
+ import type { UnknownObject } from "../types.js";
3
+ /**
4
+ * Persist a piece of UI state on the host, so it survives view remounts and
5
+ * is restored on subsequent renders of the same tool invocation.
6
+ *
7
+ * Returns a `[state, setState]` pair with the same ergonomics as
8
+ * `useState`. State is filtered to strip Skybridge-internal context fields
9
+ * (see {@link DataLLM}) before being returned to your component.
10
+ *
11
+ * Provide a `defaultState` (value or lazy initializer) to get a non-nullable
12
+ * tuple; omit it for `T | null`.
13
+ *
14
+ * @typeParam T - Shape of the persisted state. Must be a plain object.
15
+ *
16
+ * @example
17
+ * ```tsx
18
+ * const [filters, setFilters] = useViewState({ sort: "newest", page: 1 });
19
+ * setFilters((f) => ({ ...f, page: f.page + 1 }));
20
+ * ```
21
+ *
22
+ * @see https://docs.skybridge.tech/api-reference/use-view-state
23
+ */
24
+ export declare function useViewState<T extends UnknownObject>(defaultState: T | (() => T)): readonly [T, (state: SetStateAction<T>) => void];
25
+ export declare function useViewState<T extends UnknownObject>(defaultState?: T | (() => T | null) | null): readonly [T | null, (state: SetStateAction<T | null>) => void];
@@ -0,0 +1,32 @@
1
+ import { useCallback, useEffect, useState } from "react";
2
+ import { getAdaptor, useHostContext } from "../bridges/index.js";
3
+ import { filterViewContext, injectViewContext } from "../helpers/state.js";
4
+ export function useViewState(defaultState) {
5
+ const adaptor = getAdaptor();
6
+ const viewStateFromBridge = useHostContext("viewState");
7
+ const [viewState, _setViewState] = useState(() => {
8
+ if (viewStateFromBridge !== null) {
9
+ return filterViewContext(viewStateFromBridge);
10
+ }
11
+ return typeof defaultState === "function"
12
+ ? defaultState()
13
+ : (defaultState ?? null);
14
+ });
15
+ useEffect(() => {
16
+ if (viewStateFromBridge !== null) {
17
+ _setViewState(filterViewContext(viewStateFromBridge));
18
+ }
19
+ }, [viewStateFromBridge]);
20
+ const setViewState = useCallback((state) => {
21
+ _setViewState((prevState) => {
22
+ const newState = typeof state === "function" ? state(prevState) : state;
23
+ const stateToSet = injectViewContext(newState);
24
+ if (stateToSet !== null) {
25
+ adaptor.setViewState(stateToSet);
26
+ }
27
+ return filterViewContext(stateToSet);
28
+ });
29
+ }, [adaptor]);
30
+ return [viewState, setViewState];
31
+ }
32
+ //# sourceMappingURL=use-view-state.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-view-state.js","sourceRoot":"","sources":["../../../src/web/hooks/use-view-state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AA8B3E,MAAM,UAAU,YAAY,CAC1B,YAA0C;IAE1C,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,mBAAmB,GAAG,cAAc,CAAC,WAAW,CAAa,CAAC;IAEpE,MAAM,CAAC,SAAS,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAW,GAAG,EAAE;QACzD,IAAI,mBAAmB,KAAK,IAAI,EAAE,CAAC;YACjC,OAAO,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;QAChD,CAAC;QAED,OAAO,OAAO,YAAY,KAAK,UAAU;YACvC,CAAC,CAAC,YAAY,EAAE;YAChB,CAAC,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,mBAAmB,KAAK,IAAI,EAAE,CAAC;YACjC,aAAa,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC;QACxD,CAAC;IACH,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAE1B,MAAM,YAAY,GAAG,WAAW,CAC9B,CAAC,KAA+B,EAAE,EAAE;QAClC,aAAa,CAAC,CAAC,SAAS,EAAE,EAAE;YAC1B,MAAM,QAAQ,GAAG,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YACxE,MAAM,UAAU,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;YAE/C,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;gBACxB,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YACnC,CAAC;YAED,OAAO,iBAAiB,CAAC,UAAU,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC,EACD,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,OAAO,CAAC,SAAS,EAAE,YAAY,CAAU,CAAC;AAC5C,CAAC","sourcesContent":["import { type SetStateAction, useCallback, useEffect, useState } from \"react\";\nimport { getAdaptor, useHostContext } from \"../bridges/index.js\";\nimport { filterViewContext, injectViewContext } from \"../helpers/state.js\";\nimport type { UnknownObject } from \"../types.js\";\n\n/**\n * Persist a piece of UI state on the host, so it survives view remounts and\n * is restored on subsequent renders of the same tool invocation.\n *\n * Returns a `[state, setState]` pair with the same ergonomics as\n * `useState`. State is filtered to strip Skybridge-internal context fields\n * (see {@link DataLLM}) before being returned to your component.\n *\n * Provide a `defaultState` (value or lazy initializer) to get a non-nullable\n * tuple; omit it for `T | null`.\n *\n * @typeParam T - Shape of the persisted state. Must be a plain object.\n *\n * @example\n * ```tsx\n * const [filters, setFilters] = useViewState({ sort: \"newest\", page: 1 });\n * setFilters((f) => ({ ...f, page: f.page + 1 }));\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-view-state\n */\nexport function useViewState<T extends UnknownObject>(\n defaultState: T | (() => T),\n): readonly [T, (state: SetStateAction<T>) => void];\nexport function useViewState<T extends UnknownObject>(\n defaultState?: T | (() => T | null) | null,\n): readonly [T | null, (state: SetStateAction<T | null>) => void];\nexport function useViewState<T extends UnknownObject>(\n defaultState?: T | (() => T | null) | null,\n): readonly [T | null, (state: SetStateAction<T | null>) => void] {\n const adaptor = getAdaptor();\n const viewStateFromBridge = useHostContext(\"viewState\") as T | null;\n\n const [viewState, _setViewState] = useState<T | null>(() => {\n if (viewStateFromBridge !== null) {\n return filterViewContext(viewStateFromBridge);\n }\n\n return typeof defaultState === \"function\"\n ? defaultState()\n : (defaultState ?? null);\n });\n\n useEffect(() => {\n if (viewStateFromBridge !== null) {\n _setViewState(filterViewContext(viewStateFromBridge));\n }\n }, [viewStateFromBridge]);\n\n const setViewState = useCallback(\n (state: SetStateAction<T | null>) => {\n _setViewState((prevState) => {\n const newState = typeof state === \"function\" ? state(prevState) : state;\n const stateToSet = injectViewContext(newState);\n\n if (stateToSet !== null) {\n adaptor.setViewState(stateToSet);\n }\n\n return filterViewContext(stateToSet);\n });\n },\n [adaptor],\n );\n\n return [viewState, setViewState] as const;\n}\n"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,177 @@
1
+ import { act, renderHook, waitFor } from "@testing-library/react";
2
+ import { afterEach, beforeEach, describe, expect, it, vi, } from "vitest";
3
+ import { McpAppAdaptor, McpAppBridge } from "../bridges/mcp-app/index.js";
4
+ import { fireToolResultNotification, getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
5
+ import { useViewState } from "./use-view-state.js";
6
+ describe("useViewState", () => {
7
+ let OpenaiMock;
8
+ beforeEach(() => {
9
+ OpenaiMock = {
10
+ widgetState: null,
11
+ setWidgetState: vi.fn().mockResolvedValue(undefined),
12
+ };
13
+ vi.stubGlobal("openai", OpenaiMock);
14
+ vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
15
+ });
16
+ afterEach(() => {
17
+ vi.unstubAllGlobals();
18
+ vi.resetAllMocks();
19
+ });
20
+ const defaultState = { count: 0, name: "test" };
21
+ const windowState = { count: 5, name: "window" };
22
+ it("should initialize with default state when window.openai.widgetState is null", () => {
23
+ OpenaiMock.widgetState = null;
24
+ const { result } = renderHook(() => useViewState(defaultState));
25
+ expect(result.current[0]).toEqual(defaultState);
26
+ });
27
+ it("should initialize with window.openai.widgetState when available", () => {
28
+ OpenaiMock.widgetState = { modelContent: windowState };
29
+ const { result } = renderHook(() => useViewState(defaultState));
30
+ expect(result.current[0]).toEqual(windowState);
31
+ });
32
+ it("should call window.openai.setWidgetState when setViewState is called with a new state", async () => {
33
+ const { result } = renderHook(() => useViewState(defaultState));
34
+ const newState = { count: 10, name: "updated" };
35
+ act(() => {
36
+ result.current[1](newState);
37
+ });
38
+ expect(OpenaiMock.setWidgetState).toHaveBeenCalledWith({
39
+ modelContent: newState,
40
+ privateContent: {},
41
+ });
42
+ expect(result.current[0]).toEqual(newState);
43
+ });
44
+ it("should call window.openai.setWidgetState when setViewState is called with a function updater", async () => {
45
+ const { result } = renderHook(() => useViewState(defaultState));
46
+ act(() => {
47
+ result.current[1]((prev) => ({ ...prev, count: prev.count + 1 }));
48
+ });
49
+ expect(OpenaiMock.setWidgetState).toHaveBeenCalledWith({
50
+ modelContent: { count: 1, name: "test" },
51
+ privateContent: {},
52
+ });
53
+ expect(result.current[0]).toEqual({ count: 1, name: "test" });
54
+ });
55
+ it("should update state when window.openai.widgetState changes", () => {
56
+ OpenaiMock.widgetState = { modelContent: defaultState };
57
+ const { result, rerender } = renderHook(() => useViewState(defaultState));
58
+ expect(result.current[0]).toEqual(defaultState);
59
+ // Simulate window.openai.widgetState changing
60
+ OpenaiMock.widgetState = { modelContent: windowState };
61
+ // Trigger re-render to simulate the useEffect running
62
+ rerender();
63
+ expect(result.current[0]).toEqual(windowState);
64
+ });
65
+ });
66
+ describe("useViewState (mcp-app host — localStorage persistence)", () => {
67
+ beforeEach(() => {
68
+ vi.stubGlobal("parent", { postMessage: getMcpAppHostPostMessageMock() });
69
+ vi.stubGlobal("skybridge", { hostType: "mcp-app" });
70
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
71
+ localStorage.clear();
72
+ });
73
+ afterEach(() => {
74
+ vi.unstubAllGlobals();
75
+ vi.resetAllMocks();
76
+ McpAppBridge.resetInstance();
77
+ McpAppAdaptor.resetInstance();
78
+ localStorage.clear();
79
+ });
80
+ it("should persist state to localStorage when viewUUID is available", async () => {
81
+ const viewUUID = "test-uuid-123";
82
+ const { result } = renderHook(() => useViewState({ page: 1, zoom: 100 }));
83
+ await act(async () => {
84
+ fireToolResultNotification({
85
+ content: [{ type: "text", text: "result" }],
86
+ structuredContent: {},
87
+ _meta: { viewUUID },
88
+ });
89
+ });
90
+ act(() => {
91
+ result.current[1]({ page: 3, zoom: 150 });
92
+ });
93
+ expect(result.current[0]).toEqual({ page: 3, zoom: 150 });
94
+ expect(localStorage.length).toBe(1);
95
+ });
96
+ it("should restore state from localStorage when viewUUID arrives", async () => {
97
+ const viewUUID = "test-uuid-456";
98
+ // Pre-seed with the sb:{timestamp}:{viewUUID} format
99
+ localStorage.setItem(`sb:1700000000000:${viewUUID}`, JSON.stringify({ page: 5, zoom: 200 }));
100
+ const { result } = renderHook(() => useViewState({ page: 1, zoom: 100 }));
101
+ act(() => {
102
+ fireToolResultNotification({
103
+ content: [{ type: "text", text: "result" }],
104
+ structuredContent: {},
105
+ _meta: { viewUUID },
106
+ });
107
+ });
108
+ await waitFor(() => {
109
+ expect(result.current[0]).toEqual({ page: 5, zoom: 200 });
110
+ });
111
+ });
112
+ it("should not persist when no viewUUID is available", () => {
113
+ const { result } = renderHook(() => useViewState({ page: 1 }));
114
+ act(() => {
115
+ result.current[1]({ page: 2 });
116
+ });
117
+ expect(result.current[0]).toEqual({ page: 2 });
118
+ expect(localStorage.length).toBe(0);
119
+ });
120
+ it("should handle corrupted localStorage data gracefully", async () => {
121
+ const viewUUID = "test-uuid-corrupt";
122
+ localStorage.setItem(`sb:1700000000000:${viewUUID}`, "not valid json{{{");
123
+ const { result } = renderHook(() => useViewState({ page: 1 }));
124
+ act(() => {
125
+ fireToolResultNotification({
126
+ content: [{ type: "text", text: "result" }],
127
+ structuredContent: {},
128
+ _meta: { viewUUID },
129
+ });
130
+ });
131
+ await waitFor(() => {
132
+ expect(result.current[0]).toEqual({ page: 1 });
133
+ });
134
+ });
135
+ it("should refresh localStorage timestamp on each persist (LRU)", async () => {
136
+ const viewUUID = "lru-test-uuid";
137
+ const oldKey = `sb:1000000000000:${viewUUID}`;
138
+ localStorage.setItem(oldKey, JSON.stringify({ page: 1 }));
139
+ const { result } = renderHook(() => useViewState({ page: 1 }));
140
+ await act(async () => {
141
+ fireToolResultNotification({
142
+ content: [{ type: "text", text: "result" }],
143
+ structuredContent: {},
144
+ _meta: { viewUUID },
145
+ });
146
+ });
147
+ act(() => {
148
+ result.current[1]({ page: 2 });
149
+ });
150
+ // Old key removed, replaced with a new one (still just 1 entry)
151
+ expect(localStorage.getItem(oldKey)).toBeNull();
152
+ expect(localStorage.length).toBe(1);
153
+ });
154
+ it("should evict oldest entries when exceeding max storage entries", async () => {
155
+ // Fill localStorage with 200 entries (the max)
156
+ for (let i = 0; i < 200; i++) {
157
+ localStorage.setItem(`sb:${String(1000000000000 + i)}:old-uuid-${String(i).padStart(4, "0")}`, JSON.stringify({ i }));
158
+ }
159
+ expect(localStorage.length).toBe(200);
160
+ const viewUUID = "eviction-test-uuid";
161
+ const { result } = renderHook(() => useViewState({ page: 1 }));
162
+ await act(async () => {
163
+ fireToolResultNotification({
164
+ content: [{ type: "text", text: "result" }],
165
+ structuredContent: {},
166
+ _meta: { viewUUID },
167
+ });
168
+ });
169
+ act(() => {
170
+ result.current[1]({ page: 99 });
171
+ });
172
+ // Should have evicted the oldest entry to stay at 200
173
+ expect(localStorage.length).toBe(200);
174
+ expect(localStorage.getItem("sb:1000000000000:old-uuid-0000")).toBeNull();
175
+ });
176
+ });
177
+ //# sourceMappingURL=use-view-state.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-view-state.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-view-state.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EACL,SAAS,EACT,UAAU,EACV,QAAQ,EACR,MAAM,EACN,EAAE,EAEF,EAAE,GACH,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,EACL,0BAA0B,EAC1B,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAI,UAA0D,CAAC;IAE/D,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,WAAW,EAAE,IAAI;YACjB,cAAc,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;SACrD,CAAC;QACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACpC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;IACvD,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,MAAM,YAAY,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAChD,MAAM,WAAW,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAEjD,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE;QACrF,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC;QAC9B,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;QAEhE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,UAAU,CAAC,WAAW,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;QACvD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;QAEhE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;QACrG,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;QAChE,MAAM,QAAQ,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAEhD,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,oBAAoB,CAAC;YACrD,YAAY,EAAE,QAAQ;YACtB,cAAc,EAAE,EAAE;SACnB,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8FAA8F,EAAE,KAAK,IAAI,EAAE;QAC5G,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;QAEhE,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,oBAAoB,CAAC;YACrD,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE;YACxC,cAAc,EAAE,EAAE;SACnB,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,UAAU,CAAC,WAAW,GAAG,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC;QACxD,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;QAE1E,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAEhD,8CAA8C;QAC9C,UAAU,CAAC,WAAW,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;QACvD,sDAAsD;QACtD,QAAQ,EAAE,CAAC;QAEX,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,wDAAwD,EAAE,GAAG,EAAE;IACtE,UAAU,CAAC,GAAG,EAAE;QACd,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,4BAA4B,EAAE,EAAE,CAAC,CAAC;QACzE,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QACpD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACpD,YAAY,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACnB,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;QAC9B,YAAY,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,QAAQ,GAAG,eAAe,CAAC;QACjC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAE1E,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,0BAA0B,CAAC;gBACzB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;gBAC3C,iBAAiB,EAAE,EAAE;gBACrB,KAAK,EAAE,EAAE,QAAQ,EAAE;aACpB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;QAC1D,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,QAAQ,GAAG,eAAe,CAAC;QACjC,qDAAqD;QACrD,YAAY,CAAC,OAAO,CAClB,oBAAoB,QAAQ,EAAE,EAC9B,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CACvC,CAAC;QAEF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAE1E,GAAG,CAAC,GAAG,EAAE;YACP,0BAA0B,CAAC;gBACzB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;gBAC3C,iBAAiB,EAAE,EAAE;gBACrB,KAAK,EAAE,EAAE,QAAQ,EAAE;aACpB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAE/D,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QAC/C,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,QAAQ,GAAG,mBAAmB,CAAC;QACrC,YAAY,CAAC,OAAO,CAAC,oBAAoB,QAAQ,EAAE,EAAE,mBAAmB,CAAC,CAAC;QAE1E,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAE/D,GAAG,CAAC,GAAG,EAAE;YACP,0BAA0B,CAAC;gBACzB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;gBAC3C,iBAAiB,EAAE,EAAE;gBACrB,KAAK,EAAE,EAAE,QAAQ,EAAE;aACpB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,QAAQ,GAAG,eAAe,CAAC;QACjC,MAAM,MAAM,GAAG,oBAAoB,QAAQ,EAAE,CAAC;QAC9C,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAE1D,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAE/D,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,0BAA0B,CAAC;gBACzB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;gBAC3C,iBAAiB,EAAE,EAAE;gBACrB,KAAK,EAAE,EAAE,QAAQ,EAAE;aACpB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,gEAAgE;QAChE,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChD,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,+CAA+C;QAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7B,YAAY,CAAC,OAAO,CAClB,MAAM,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,aAAa,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EACxE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,CACtB,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEtC,MAAM,QAAQ,GAAG,oBAAoB,CAAC;QACtC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAE/D,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,0BAA0B,CAAC;gBACzB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;gBAC3C,iBAAiB,EAAE,EAAE;gBACrB,KAAK,EAAE,EAAE,QAAQ,EAAE;aACpB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,sDAAsD;QACtD,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { act, renderHook, waitFor } from \"@testing-library/react\";\nimport {\n afterEach,\n beforeEach,\n describe,\n expect,\n it,\n type Mock,\n vi,\n} from \"vitest\";\nimport { McpAppAdaptor, McpAppBridge } from \"../bridges/mcp-app/index.js\";\nimport {\n fireToolResultNotification,\n getMcpAppHostPostMessageMock,\n MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useViewState } from \"./use-view-state.js\";\n\ndescribe(\"useViewState\", () => {\n let OpenaiMock: { widgetState: unknown; setWidgetState: Mock };\n\n beforeEach(() => {\n OpenaiMock = {\n widgetState: null,\n setWidgetState: vi.fn().mockResolvedValue(undefined),\n };\n vi.stubGlobal(\"openai\", OpenaiMock);\n vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n });\n\n const defaultState = { count: 0, name: \"test\" };\n const windowState = { count: 5, name: \"window\" };\n\n it(\"should initialize with default state when window.openai.widgetState is null\", () => {\n OpenaiMock.widgetState = null;\n const { result } = renderHook(() => useViewState(defaultState));\n\n expect(result.current[0]).toEqual(defaultState);\n });\n\n it(\"should initialize with window.openai.widgetState when available\", () => {\n OpenaiMock.widgetState = { modelContent: windowState };\n const { result } = renderHook(() => useViewState(defaultState));\n\n expect(result.current[0]).toEqual(windowState);\n });\n\n it(\"should call window.openai.setWidgetState when setViewState is called with a new state\", async () => {\n const { result } = renderHook(() => useViewState(defaultState));\n const newState = { count: 10, name: \"updated\" };\n\n act(() => {\n result.current[1](newState);\n });\n\n expect(OpenaiMock.setWidgetState).toHaveBeenCalledWith({\n modelContent: newState,\n privateContent: {},\n });\n expect(result.current[0]).toEqual(newState);\n });\n\n it(\"should call window.openai.setWidgetState when setViewState is called with a function updater\", async () => {\n const { result } = renderHook(() => useViewState(defaultState));\n\n act(() => {\n result.current[1]((prev) => ({ ...prev, count: prev.count + 1 }));\n });\n\n expect(OpenaiMock.setWidgetState).toHaveBeenCalledWith({\n modelContent: { count: 1, name: \"test\" },\n privateContent: {},\n });\n expect(result.current[0]).toEqual({ count: 1, name: \"test\" });\n });\n\n it(\"should update state when window.openai.widgetState changes\", () => {\n OpenaiMock.widgetState = { modelContent: defaultState };\n const { result, rerender } = renderHook(() => useViewState(defaultState));\n\n expect(result.current[0]).toEqual(defaultState);\n\n // Simulate window.openai.widgetState changing\n OpenaiMock.widgetState = { modelContent: windowState };\n // Trigger re-render to simulate the useEffect running\n rerender();\n\n expect(result.current[0]).toEqual(windowState);\n });\n});\n\ndescribe(\"useViewState (mcp-app host — localStorage persistence)\", () => {\n beforeEach(() => {\n vi.stubGlobal(\"parent\", { postMessage: getMcpAppHostPostMessageMock() });\n vi.stubGlobal(\"skybridge\", { hostType: \"mcp-app\" });\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n localStorage.clear();\n });\n\n afterEach(() => {\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n McpAppBridge.resetInstance();\n McpAppAdaptor.resetInstance();\n localStorage.clear();\n });\n\n it(\"should persist state to localStorage when viewUUID is available\", async () => {\n const viewUUID = \"test-uuid-123\";\n const { result } = renderHook(() => useViewState({ page: 1, zoom: 100 }));\n\n await act(async () => {\n fireToolResultNotification({\n content: [{ type: \"text\", text: \"result\" }],\n structuredContent: {},\n _meta: { viewUUID },\n });\n });\n\n act(() => {\n result.current[1]({ page: 3, zoom: 150 });\n });\n\n expect(result.current[0]).toEqual({ page: 3, zoom: 150 });\n expect(localStorage.length).toBe(1);\n });\n\n it(\"should restore state from localStorage when viewUUID arrives\", async () => {\n const viewUUID = \"test-uuid-456\";\n // Pre-seed with the sb:{timestamp}:{viewUUID} format\n localStorage.setItem(\n `sb:1700000000000:${viewUUID}`,\n JSON.stringify({ page: 5, zoom: 200 }),\n );\n\n const { result } = renderHook(() => useViewState({ page: 1, zoom: 100 }));\n\n act(() => {\n fireToolResultNotification({\n content: [{ type: \"text\", text: \"result\" }],\n structuredContent: {},\n _meta: { viewUUID },\n });\n });\n\n await waitFor(() => {\n expect(result.current[0]).toEqual({ page: 5, zoom: 200 });\n });\n });\n\n it(\"should not persist when no viewUUID is available\", () => {\n const { result } = renderHook(() => useViewState({ page: 1 }));\n\n act(() => {\n result.current[1]({ page: 2 });\n });\n\n expect(result.current[0]).toEqual({ page: 2 });\n expect(localStorage.length).toBe(0);\n });\n\n it(\"should handle corrupted localStorage data gracefully\", async () => {\n const viewUUID = \"test-uuid-corrupt\";\n localStorage.setItem(`sb:1700000000000:${viewUUID}`, \"not valid json{{{\");\n\n const { result } = renderHook(() => useViewState({ page: 1 }));\n\n act(() => {\n fireToolResultNotification({\n content: [{ type: \"text\", text: \"result\" }],\n structuredContent: {},\n _meta: { viewUUID },\n });\n });\n\n await waitFor(() => {\n expect(result.current[0]).toEqual({ page: 1 });\n });\n });\n\n it(\"should refresh localStorage timestamp on each persist (LRU)\", async () => {\n const viewUUID = \"lru-test-uuid\";\n const oldKey = `sb:1000000000000:${viewUUID}`;\n localStorage.setItem(oldKey, JSON.stringify({ page: 1 }));\n\n const { result } = renderHook(() => useViewState({ page: 1 }));\n\n await act(async () => {\n fireToolResultNotification({\n content: [{ type: \"text\", text: \"result\" }],\n structuredContent: {},\n _meta: { viewUUID },\n });\n });\n\n act(() => {\n result.current[1]({ page: 2 });\n });\n\n // Old key removed, replaced with a new one (still just 1 entry)\n expect(localStorage.getItem(oldKey)).toBeNull();\n expect(localStorage.length).toBe(1);\n });\n\n it(\"should evict oldest entries when exceeding max storage entries\", async () => {\n // Fill localStorage with 200 entries (the max)\n for (let i = 0; i < 200; i++) {\n localStorage.setItem(\n `sb:${String(1000000000000 + i)}:old-uuid-${String(i).padStart(4, \"0\")}`,\n JSON.stringify({ i }),\n );\n }\n expect(localStorage.length).toBe(200);\n\n const viewUUID = \"eviction-test-uuid\";\n const { result } = renderHook(() => useViewState({ page: 1 }));\n\n await act(async () => {\n fireToolResultNotification({\n content: [{ type: \"text\", text: \"result\" }],\n structuredContent: {},\n _meta: { viewUUID },\n });\n });\n\n act(() => {\n result.current[1]({ page: 99 });\n });\n\n // Should have evicted the oldest entry to stay at 200\n expect(localStorage.length).toBe(200);\n expect(localStorage.getItem(\"sb:1000000000000:old-uuid-0000\")).toBeNull();\n });\n});\n"]}
@@ -3,6 +3,5 @@ export { createStore } from "./create-store.js";
3
3
  export * from "./data-llm.js";
4
4
  export { generateHelpers } from "./generate-helpers.js";
5
5
  export * from "./hooks/index.js";
6
- export { mountWidget } from "./mount-widget.js";
7
- export { skybridge } from "./plugin/plugin.js";
6
+ export { mountView } from "./mount-view.js";
8
7
  export * from "./types.js";
package/dist/web/index.js CHANGED
@@ -3,7 +3,6 @@ export { createStore } from "./create-store.js";
3
3
  export * from "./data-llm.js";
4
4
  export { generateHelpers } from "./generate-helpers.js";
5
5
  export * from "./hooks/index.js";
6
- export { mountWidget } from "./mount-widget.js";
7
- export { skybridge } from "./plugin/plugin.js";
6
+ export { mountView } from "./mount-view.js";
8
7
  export * from "./types.js";
9
8
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/web/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,cAAc,kBAAkB,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,cAAc,YAAY,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/web/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,cAAc,kBAAkB,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,cAAc,YAAY,CAAC","sourcesContent":["export * from \"./bridges/index.js\";\nexport { createStore } from \"./create-store.js\";\nexport * from \"./data-llm.js\";\nexport { generateHelpers } from \"./generate-helpers.js\";\nexport * from \"./hooks/index.js\";\nexport { mountView } from \"./mount-view.js\";\nexport * from \"./types.js\";\n"]}
@@ -0,0 +1,20 @@
1
+ /**
2
+ * Mount a view's root React component into `#root`. Each view file's entry
3
+ * point should call this exactly once.
4
+ *
5
+ * Wraps the component in `StrictMode`, applies host-specific providers
6
+ * automatically (e.g. modal support for MCP Apps), and installs the dev-mode
7
+ * logging proxy for `window.openai` calls.
8
+ *
9
+ * @param component - Your root React element (already constructed, e.g. `<App />`).
10
+ *
11
+ * @example
12
+ * ```tsx
13
+ * // src/views/search.tsx
14
+ * import { mountView } from "skybridge/web";
15
+ * import { App } from "./App";
16
+ *
17
+ * mountView(<App />);
18
+ * ```
19
+ */
20
+ export declare const mountView: (component: React.ReactNode) => void;
@@ -3,7 +3,26 @@ import { createElement, StrictMode } from "react";
3
3
  import { createRoot } from "react-dom/client";
4
4
  import { installOpenAILoggingProxy } from "./proxy.js";
5
5
  let rootInstance = null;
6
- export const mountWidget = (component) => {
6
+ /**
7
+ * Mount a view's root React component into `#root`. Each view file's entry
8
+ * point should call this exactly once.
9
+ *
10
+ * Wraps the component in `StrictMode`, applies host-specific providers
11
+ * automatically (e.g. modal support for MCP Apps), and installs the dev-mode
12
+ * logging proxy for `window.openai` calls.
13
+ *
14
+ * @param component - Your root React element (already constructed, e.g. `<App />`).
15
+ *
16
+ * @example
17
+ * ```tsx
18
+ * // src/views/search.tsx
19
+ * import { mountView } from "skybridge/web";
20
+ * import { App } from "./App";
21
+ *
22
+ * mountView(<App />);
23
+ * ```
24
+ */
25
+ export const mountView = (component) => {
7
26
  const rootElement = document.getElementById("root");
8
27
  if (!rootElement) {
9
28
  throw new Error("Root element not found");
@@ -24,4 +43,4 @@ export const mountWidget = (component) => {
24
43
  rootInstance.render(createElement(StrictMode, null, app));
25
44
  })();
26
45
  };
27
- //# sourceMappingURL=mount-widget.js.map
46
+ //# sourceMappingURL=mount-view.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mount-view.js","sourceRoot":"","sources":["../../src/web/mount-view.ts"],"names":[],"mappings":"AAAA,qCAAqC;AAErC,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAClD,OAAO,EAAE,UAAU,EAAa,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAEvD,IAAI,YAAY,GAAgB,IAAI,CAAC;AAErC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,SAA0B,EAAE,EAAE;IACtD,MAAM,WAAW,GAAG,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACpD,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,YAAY,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;QACxB,yBAAyB,EAAE,CAAC;IAC9B,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC;IAE5C,CAAC,KAAK,IAAI,EAAE;QACV,IAAI,GAAG,GAAG,SAAS,CAAC;QACpB,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,MAAM,CAAC,gCAAgC,CAAC,CAAC;YACzE,GAAG,GAAG,aAAa,CAAC,aAAa,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;QACtD,CAAC;QACD,YAAY,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAC5D,CAAC,CAAC,EAAE,CAAC;AACP,CAAC,CAAC","sourcesContent":["/// <reference types=\"vite/client\" />\n\nimport { createElement, StrictMode } from \"react\";\nimport { createRoot, type Root } from \"react-dom/client\";\nimport { installOpenAILoggingProxy } from \"./proxy.js\";\n\nlet rootInstance: Root | null = null;\n\n/**\n * Mount a view's root React component into `#root`. Each view file's entry\n * point should call this exactly once.\n *\n * Wraps the component in `StrictMode`, applies host-specific providers\n * automatically (e.g. modal support for MCP Apps), and installs the dev-mode\n * logging proxy for `window.openai` calls.\n *\n * @param component - Your root React element (already constructed, e.g. `<App />`).\n *\n * @example\n * ```tsx\n * // src/views/search.tsx\n * import { mountView } from \"skybridge/web\";\n * import { App } from \"./App\";\n *\n * mountView(<App />);\n * ```\n */\nexport const mountView = (component: React.ReactNode) => {\n const rootElement = document.getElementById(\"root\");\n if (!rootElement) {\n throw new Error(\"Root element not found\");\n }\n\n if (!rootInstance) {\n rootInstance = createRoot(rootElement);\n }\n\n if (import.meta.env.DEV) {\n installOpenAILoggingProxy();\n }\n\n const hostType = window.skybridge?.hostType;\n\n (async () => {\n let app = component;\n if (hostType === \"mcp-app\") {\n const { ModalProvider } = await import(\"./components/modal-provider.js\");\n app = createElement(ModalProvider, null, component);\n }\n rootInstance.render(createElement(StrictMode, null, app));\n })();\n};\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"data-llm.test.js","sourceRoot":"","sources":["../../../src/web/plugin/data-llm.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,IAAI,GAAG;;;;KAIZ,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;QAC7D,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,IAAI,GAAG;;;;;KAKZ,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QACjD,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,IAAI,GAAG;;;;KAIZ,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,yCAAyC,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,sBAAsB;QACtB,MAAM,cAAc,GAAG;;;;;KAKtB,CAAC;QACF,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAC5D,MAAM,CACJ,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAC9D,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAElB,iDAAiD;QACjD,MAAM,cAAc,GAAG;;;;;;KAMtB,CAAC;QACF,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAC5D,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;QAC7D,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;QACpE,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,yCAAyC,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,IAAI,GAAG;;;;;;;;;;;;;KAaZ,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"data-llm.test.js","sourceRoot":"","sources":["../../../src/web/plugin/data-llm.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,IAAI,GAAG;;;;KAIZ,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;QAC7D,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,IAAI,GAAG;;;;;KAKZ,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QACjD,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,IAAI,GAAG;;;;KAIZ,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,yCAAyC,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,sBAAsB;QACtB,MAAM,cAAc,GAAG;;;;;KAKtB,CAAC;QACF,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAC5D,MAAM,CACJ,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAC9D,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAElB,iDAAiD;QACjD,MAAM,cAAc,GAAG;;;;;;KAMtB,CAAC;QACF,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAC5D,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;QAC7D,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;QACpE,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,yCAAyC,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,IAAI,GAAG;;;;;;;;;;;;;KAaZ,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, it } from \"vitest\";\nimport { transform } from \"./transform-data-llm.js\";\n\ndescribe(\"data-llm plugin\", () => {\n it(\"should transform JSX element with data-llm string attribute\", async () => {\n const code = `\n function Component() {\n return <div data-llm=\"Test description\">Content</div>;\n }\n `;\n\n const result = await transform(code, \"test.tsx\");\n\n expect(result).not.toBeNull();\n expect(result?.code).toContain(\"DataLLM\");\n expect(result?.code).toContain('content=\"Test description\"');\n expect(result?.code).not.toContain(\"data-llm\");\n });\n\n it(\"should transform JSX element with data-llm expression attribute\", async () => {\n const code = `\n function Component() {\n const desc = \"Dynamic description\";\n return <div data-llm={desc}>Content</div>;\n }\n `;\n\n const result = await transform(code, \"test.tsx\");\n\n expect(result).not.toBeNull();\n expect(result?.code).toContain(\"DataLLM\");\n expect(result?.code).toContain(\"content={desc}\");\n expect(result?.code).not.toContain(\"data-llm\");\n });\n\n it(\"should add import for DataLLM when not present\", async () => {\n const code = `\n function Component() {\n return <div data-llm=\"Test\">Content</div>;\n }\n `;\n\n const result = await transform(code, \"test.tsx\");\n\n expect(result).not.toBeNull();\n expect(result?.code).toContain('import { DataLLM } from \"skybridge/web\"');\n });\n\n it(\"should handle DataLLM imports correctly\", async () => {\n // No duplicate import\n const codeWithImport = `\n import { DataLLM } from \"skybridge/web\";\n function Component() {\n return <div data-llm=\"Test\">Content</div>;\n }\n `;\n const result1 = await transform(codeWithImport, \"test.tsx\");\n expect(\n result1?.code.match(/import.*DataLLM.*from.*skybridge\\/web/g),\n ).toHaveLength(1);\n\n // Preserve other imports and add missing DataLLM\n const codeWithOthers = `\n import React from \"react\";\n import { useState } from \"react\";\n function Component() {\n return <div data-llm=\"Test\">Content</div>;\n }\n `;\n const result2 = await transform(codeWithOthers, \"test.tsx\");\n expect(result2?.code).toContain('import React from \"react\"');\n expect(result2?.code).toContain('import { useState } from \"react\"');\n expect(result2?.code).toContain('import { DataLLM } from \"skybridge/web\"');\n });\n\n it(\"should handle complex JSX with multiple data-llm attributes\", async () => {\n const code = `\n function Component() {\n return (\n <div>\n <section data-llm=\"Section 1\">\n <p>Content 1</p>\n </section>\n <section data-llm=\"Section 2\">\n <p>Content 2</p>\n </section>\n </div>\n );\n }\n `;\n\n const result = await transform(code, \"test.tsx\");\n\n expect(result).toMatchSnapshot();\n });\n});\n"]}
@@ -1,2 +1,33 @@
1
1
  import type { Plugin } from "vite";
2
- export declare function skybridge(): Plugin;
2
+ /** Options for the {@link skybridge} Vite plugin. */
3
+ export interface SkybridgePluginOptions {
4
+ /** Directory scanned for view modules. Defaults to `"src/views"`. */
5
+ viewsDir?: string;
6
+ }
7
+ /**
8
+ * Vite plugin that wires a Skybridge project's view files into Vite.
9
+ *
10
+ * For each `.tsx` / `.jsx` file in `viewsDir` with a default export, the
11
+ * plugin:
12
+ * - exposes a virtual entry that calls {@link mountView} with the view's
13
+ * default export,
14
+ * - generates `.skybridge/views.d.ts` to augment {@link ViewNameRegistry} so
15
+ * {@link ViewName} narrows to the actual view names,
16
+ * - rewrites `<DataLLM>` JSX so the host can extract its content,
17
+ * - warns in dev if a view file is missing a default export.
18
+ *
19
+ * Add it to your `vite.config.ts` alongside `@vitejs/plugin-react`.
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * // vite.config.ts
24
+ * import { defineConfig } from "vite";
25
+ * import react from "@vitejs/plugin-react";
26
+ * import { skybridge } from "skybridge/vite";
27
+ *
28
+ * export default defineConfig({
29
+ * plugins: [react(), skybridge({ viewsDir: "src/views" })],
30
+ * });
31
+ * ```
32
+ */
33
+ export declare function skybridge(options?: SkybridgePluginOptions): Plugin;