skybridge 0.0.0-dev.d9ee984 → 0.0.0-dev.da00241

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 (518) hide show
  1. package/LICENSE +21 -674
  2. package/README.md +154 -2
  3. package/bin/run.js +5 -0
  4. package/dist/cli/build-helpers.d.ts +11 -0
  5. package/dist/cli/build-helpers.js +107 -0
  6. package/dist/cli/build-helpers.js.map +1 -0
  7. package/dist/cli/build-helpers.test.d.ts +1 -0
  8. package/dist/cli/build-helpers.test.js +132 -0
  9. package/dist/cli/build-helpers.test.js.map +1 -0
  10. package/dist/cli/build-steps.d.ts +2 -0
  11. package/dist/cli/build-steps.js +73 -0
  12. package/dist/cli/build-steps.js.map +1 -0
  13. package/dist/cli/build-steps.test.d.ts +1 -0
  14. package/dist/cli/build-steps.test.js +52 -0
  15. package/dist/cli/build-steps.test.js.map +1 -0
  16. package/dist/cli/detect-port.d.ts +18 -0
  17. package/dist/cli/detect-port.js +49 -0
  18. package/dist/cli/detect-port.js.map +1 -0
  19. package/dist/cli/header.d.ts +4 -0
  20. package/dist/cli/header.js +6 -0
  21. package/dist/cli/header.js.map +1 -0
  22. package/dist/cli/resolve-skybridge-config.d.ts +5 -0
  23. package/dist/cli/resolve-skybridge-config.js +18 -0
  24. package/dist/cli/resolve-skybridge-config.js.map +1 -0
  25. package/dist/cli/run-command.d.ts +2 -0
  26. package/dist/cli/run-command.js +43 -0
  27. package/dist/cli/run-command.js.map +1 -0
  28. package/dist/cli/run-plain.d.ts +18 -0
  29. package/dist/cli/run-plain.js +90 -0
  30. package/dist/cli/run-plain.js.map +1 -0
  31. package/dist/cli/telemetry.d.ts +7 -0
  32. package/dist/cli/telemetry.js +123 -0
  33. package/dist/cli/telemetry.js.map +1 -0
  34. package/dist/cli/tunnel-control-server.d.ts +9 -0
  35. package/dist/cli/tunnel-control-server.js +31 -0
  36. package/dist/cli/tunnel-control-server.js.map +1 -0
  37. package/dist/cli/tunnel-control-server.test.d.ts +1 -0
  38. package/dist/cli/tunnel-control-server.test.js +39 -0
  39. package/dist/cli/tunnel-control-server.test.js.map +1 -0
  40. package/dist/cli/tunnel-handler.d.ts +3 -0
  41. package/dist/cli/tunnel-handler.js +48 -0
  42. package/dist/cli/tunnel-handler.js.map +1 -0
  43. package/dist/cli/tunnel-handler.test.d.ts +1 -0
  44. package/dist/cli/tunnel-handler.test.js +105 -0
  45. package/dist/cli/tunnel-handler.test.js.map +1 -0
  46. package/dist/cli/tunnel.d.ts +57 -0
  47. package/dist/cli/tunnel.js +154 -0
  48. package/dist/cli/tunnel.js.map +1 -0
  49. package/dist/cli/tunnel.test.d.ts +1 -0
  50. package/dist/cli/tunnel.test.js +190 -0
  51. package/dist/cli/tunnel.test.js.map +1 -0
  52. package/dist/cli/types.d.ts +5 -0
  53. package/dist/cli/types.js +2 -0
  54. package/dist/cli/types.js.map +1 -0
  55. package/dist/cli/use-execute-steps.d.ts +11 -0
  56. package/dist/cli/use-execute-steps.js +36 -0
  57. package/dist/cli/use-execute-steps.js.map +1 -0
  58. package/dist/cli/use-messages.d.ts +3 -0
  59. package/dist/cli/use-messages.js +11 -0
  60. package/dist/cli/use-messages.js.map +1 -0
  61. package/dist/cli/use-nodemon.d.ts +26 -0
  62. package/dist/cli/use-nodemon.js +106 -0
  63. package/dist/cli/use-nodemon.js.map +1 -0
  64. package/dist/cli/use-open-browser.d.ts +1 -0
  65. package/dist/cli/use-open-browser.js +44 -0
  66. package/dist/cli/use-open-browser.js.map +1 -0
  67. package/dist/cli/use-tunnel.d.ts +14 -0
  68. package/dist/cli/use-tunnel.js +131 -0
  69. package/dist/cli/use-tunnel.js.map +1 -0
  70. package/dist/cli/use-typescript-check.d.ts +15 -0
  71. package/dist/cli/use-typescript-check.js +97 -0
  72. package/dist/cli/use-typescript-check.js.map +1 -0
  73. package/dist/commands/build.d.ts +6 -0
  74. package/dist/commands/build.js +31 -0
  75. package/dist/commands/build.js.map +1 -0
  76. package/dist/commands/create.d.ts +9 -0
  77. package/dist/commands/create.js +30 -0
  78. package/dist/commands/create.js.map +1 -0
  79. package/dist/commands/dev.d.ts +13 -0
  80. package/dist/commands/dev.js +128 -0
  81. package/dist/commands/dev.js.map +1 -0
  82. package/dist/commands/start.d.ts +9 -0
  83. package/dist/commands/start.js +55 -0
  84. package/dist/commands/start.js.map +1 -0
  85. package/dist/commands/telemetry/disable.d.ts +5 -0
  86. package/dist/commands/telemetry/disable.js +14 -0
  87. package/dist/commands/telemetry/disable.js.map +1 -0
  88. package/dist/commands/telemetry/enable.d.ts +5 -0
  89. package/dist/commands/telemetry/enable.js +14 -0
  90. package/dist/commands/telemetry/enable.js.map +1 -0
  91. package/dist/commands/telemetry/status.d.ts +5 -0
  92. package/dist/commands/telemetry/status.js +14 -0
  93. package/dist/commands/telemetry/status.js.map +1 -0
  94. package/dist/context-warnings.d.ts +5 -0
  95. package/dist/context-warnings.js +31 -0
  96. package/dist/context-warnings.js.map +1 -0
  97. package/dist/context-warnings.test.d.ts +1 -0
  98. package/dist/context-warnings.test.js +28 -0
  99. package/dist/context-warnings.test.js.map +1 -0
  100. package/dist/server/app.d.ts +194 -0
  101. package/dist/server/app.js +266 -0
  102. package/dist/server/app.js.map +1 -0
  103. package/dist/server/app.test.d.ts +1 -0
  104. package/dist/server/app.test.js +97 -0
  105. package/dist/server/app.test.js.map +1 -0
  106. package/dist/server/asset-base-url-transform-plugin.d.ts +11 -0
  107. package/dist/server/asset-base-url-transform-plugin.js +48 -0
  108. package/dist/server/asset-base-url-transform-plugin.js.map +1 -0
  109. package/dist/server/asset-base-url-transform-plugin.test.d.ts +1 -0
  110. package/dist/server/asset-base-url-transform-plugin.test.js +134 -0
  111. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -0
  112. package/dist/server/auth/discovery.d.ts +33 -0
  113. package/dist/server/auth/discovery.js +56 -0
  114. package/dist/server/auth/discovery.js.map +1 -0
  115. package/dist/server/auth/discovery.test.d.ts +1 -0
  116. package/dist/server/auth/discovery.test.js +93 -0
  117. package/dist/server/auth/discovery.test.js.map +1 -0
  118. package/dist/server/auth/index.d.ts +48 -0
  119. package/dist/server/auth/index.js +2 -0
  120. package/dist/server/auth/index.js.map +1 -0
  121. package/dist/server/auth/providers/auth0.d.ts +40 -0
  122. package/dist/server/auth/providers/auth0.js +36 -0
  123. package/dist/server/auth/providers/auth0.js.map +1 -0
  124. package/dist/server/auth/providers/auth0.test.d.ts +1 -0
  125. package/dist/server/auth/providers/auth0.test.js +50 -0
  126. package/dist/server/auth/providers/auth0.test.js.map +1 -0
  127. package/dist/server/auth/providers/authplane.d.ts +49 -0
  128. package/dist/server/auth/providers/authplane.js +57 -0
  129. package/dist/server/auth/providers/authplane.js.map +1 -0
  130. package/dist/server/auth/providers/authplane.test.d.ts +1 -0
  131. package/dist/server/auth/providers/authplane.test.js +143 -0
  132. package/dist/server/auth/providers/authplane.test.js.map +1 -0
  133. package/dist/server/auth/providers/clerk.d.ts +51 -0
  134. package/dist/server/auth/providers/clerk.js +19 -0
  135. package/dist/server/auth/providers/clerk.js.map +1 -0
  136. package/dist/server/auth/providers/clerk.test.d.ts +1 -0
  137. package/dist/server/auth/providers/clerk.test.js +30 -0
  138. package/dist/server/auth/providers/clerk.test.js.map +1 -0
  139. package/dist/server/auth/providers/custom.d.ts +40 -0
  140. package/dist/server/auth/providers/custom.js +59 -0
  141. package/dist/server/auth/providers/custom.js.map +1 -0
  142. package/dist/server/auth/providers/custom.test.d.ts +1 -0
  143. package/dist/server/auth/providers/custom.test.js +161 -0
  144. package/dist/server/auth/providers/custom.test.js.map +1 -0
  145. package/dist/server/auth/providers/descope.d.ts +44 -0
  146. package/dist/server/auth/providers/descope.js +44 -0
  147. package/dist/server/auth/providers/descope.js.map +1 -0
  148. package/dist/server/auth/providers/descope.test.d.ts +1 -0
  149. package/dist/server/auth/providers/descope.test.js +62 -0
  150. package/dist/server/auth/providers/descope.test.js.map +1 -0
  151. package/dist/server/auth/providers/shared.d.ts +2 -0
  152. package/dist/server/auth/providers/shared.js +6 -0
  153. package/dist/server/auth/providers/shared.js.map +1 -0
  154. package/dist/server/auth/providers/shared.test.d.ts +1 -0
  155. package/dist/server/auth/providers/shared.test.js +10 -0
  156. package/dist/server/auth/providers/shared.test.js.map +1 -0
  157. package/dist/server/auth/providers/stytch.d.ts +25 -0
  158. package/dist/server/auth/providers/stytch.js +16 -0
  159. package/dist/server/auth/providers/stytch.js.map +1 -0
  160. package/dist/server/auth/providers/verify-spy.d.ts +12 -0
  161. package/dist/server/auth/providers/verify-spy.js +21 -0
  162. package/dist/server/auth/providers/verify-spy.js.map +1 -0
  163. package/dist/server/auth/providers/workos.d.ts +33 -0
  164. package/dist/server/auth/providers/workos.js +15 -0
  165. package/dist/server/auth/providers/workos.js.map +1 -0
  166. package/dist/server/auth/security-schemes.d.ts +23 -0
  167. package/dist/server/auth/security-schemes.js +64 -0
  168. package/dist/server/auth/security-schemes.js.map +1 -0
  169. package/dist/server/auth/security-schemes.test.d.ts +1 -0
  170. package/dist/server/auth/security-schemes.test.js +99 -0
  171. package/dist/server/auth/security-schemes.test.js.map +1 -0
  172. package/dist/server/auth/setup.d.ts +6 -0
  173. package/dist/server/auth/setup.js +91 -0
  174. package/dist/server/auth/setup.js.map +1 -0
  175. package/dist/server/auth/setup.test.d.ts +1 -0
  176. package/dist/server/auth/setup.test.js +514 -0
  177. package/dist/server/auth/setup.test.js.map +1 -0
  178. package/dist/server/auth/verify.d.ts +46 -0
  179. package/dist/server/auth/verify.js +62 -0
  180. package/dist/server/auth/verify.js.map +1 -0
  181. package/dist/server/auth/verify.test.d.ts +1 -0
  182. package/dist/server/auth/verify.test.js +149 -0
  183. package/dist/server/auth/verify.test.js.map +1 -0
  184. package/dist/server/auth-extra.test-d.d.ts +1 -0
  185. package/dist/server/auth-extra.test-d.js +130 -0
  186. package/dist/server/auth-extra.test-d.js.map +1 -0
  187. package/dist/server/auth.d.ts +57 -0
  188. package/dist/server/auth.js +27 -0
  189. package/dist/server/auth.js.map +1 -0
  190. package/dist/server/build-manifest.test.d.ts +1 -0
  191. package/dist/server/build-manifest.test.js +28 -0
  192. package/dist/server/build-manifest.test.js.map +1 -0
  193. package/dist/server/content-helpers.d.ts +67 -0
  194. package/dist/server/content-helpers.js +79 -0
  195. package/dist/server/content-helpers.js.map +1 -0
  196. package/dist/server/content-helpers.test.d.ts +1 -0
  197. package/dist/server/content-helpers.test.js +70 -0
  198. package/dist/server/content-helpers.test.js.map +1 -0
  199. package/dist/server/express.d.ts +31 -0
  200. package/dist/server/express.js +107 -0
  201. package/dist/server/express.js.map +1 -0
  202. package/dist/server/express.test.d.ts +1 -0
  203. package/dist/server/express.test.js +608 -0
  204. package/dist/server/express.test.js.map +1 -0
  205. package/dist/server/file-ref.d.ts +28 -0
  206. package/dist/server/file-ref.js +27 -0
  207. package/dist/server/file-ref.js.map +1 -0
  208. package/dist/server/host.d.ts +2 -0
  209. package/dist/server/host.js +11 -0
  210. package/dist/server/host.js.map +1 -0
  211. package/dist/server/host.test.d.ts +1 -0
  212. package/dist/server/host.test.js +13 -0
  213. package/dist/server/host.test.js.map +1 -0
  214. package/dist/server/index.d.ts +22 -3
  215. package/dist/server/index.js +17 -3
  216. package/dist/server/index.js.map +1 -1
  217. package/dist/server/inferUtilityTypes.d.ts +64 -0
  218. package/dist/server/inferUtilityTypes.js +2 -0
  219. package/dist/server/inferUtilityTypes.js.map +1 -0
  220. package/dist/server/mcp-errors.test.d.ts +1 -0
  221. package/dist/server/mcp-errors.test.js +41 -0
  222. package/dist/server/mcp-errors.test.js.map +1 -0
  223. package/dist/server/metric.d.ts +14 -0
  224. package/dist/server/metric.js +62 -0
  225. package/dist/server/metric.js.map +1 -0
  226. package/dist/server/middleware.d.ts +162 -3
  227. package/dist/server/middleware.js +124 -45
  228. package/dist/server/middleware.js.map +1 -1
  229. package/dist/server/middleware.test-d.d.ts +1 -0
  230. package/dist/server/middleware.test-d.js +75 -0
  231. package/dist/server/middleware.test-d.js.map +1 -0
  232. package/dist/server/middleware.test.d.ts +1 -0
  233. package/dist/server/middleware.test.js +601 -0
  234. package/dist/server/middleware.test.js.map +1 -0
  235. package/dist/server/register-tool.test.d.ts +1 -0
  236. package/dist/server/register-tool.test.js +27 -0
  237. package/dist/server/register-tool.test.js.map +1 -0
  238. package/dist/server/requestOrigin.d.ts +7 -0
  239. package/dist/server/requestOrigin.js +25 -0
  240. package/dist/server/requestOrigin.js.map +1 -0
  241. package/dist/server/server.d.ts +418 -10
  242. package/dist/server/server.js +534 -58
  243. package/dist/server/server.js.map +1 -1
  244. package/dist/server/skills-integration.test.d.ts +1 -0
  245. package/dist/server/skills-integration.test.js +86 -0
  246. package/dist/server/skills-integration.test.js.map +1 -0
  247. package/dist/server/skills.d.ts +27 -0
  248. package/dist/server/skills.js +188 -0
  249. package/dist/server/skills.js.map +1 -0
  250. package/dist/server/skills.test.d.ts +1 -0
  251. package/dist/server/skills.test.js +243 -0
  252. package/dist/server/skills.test.js.map +1 -0
  253. package/dist/server/templateHelper.d.ts +13 -0
  254. package/dist/server/templateHelper.js +11 -0
  255. package/dist/server/templateHelper.js.map +1 -0
  256. package/dist/server/templates.generated.d.ts +4 -0
  257. package/dist/server/templates.generated.js +43 -0
  258. package/dist/server/templates.generated.js.map +1 -0
  259. package/dist/server/tool-extra.test.d.ts +1 -0
  260. package/dist/server/tool-extra.test.js +88 -0
  261. package/dist/server/tool-extra.test.js.map +1 -0
  262. package/dist/server/tunnel-proxy-router.d.ts +7 -0
  263. package/dist/server/tunnel-proxy-router.js +110 -0
  264. package/dist/server/tunnel-proxy-router.js.map +1 -0
  265. package/dist/server/tunnel-proxy-router.test.d.ts +1 -0
  266. package/dist/server/tunnel-proxy-router.test.js +229 -0
  267. package/dist/server/tunnel-proxy-router.test.js.map +1 -0
  268. package/dist/server/view-name.test-d.d.ts +1 -0
  269. package/dist/server/view-name.test-d.js +8 -0
  270. package/dist/server/view-name.test-d.js.map +1 -0
  271. package/dist/server/view-resource-resolution.test.d.ts +6 -0
  272. package/dist/server/view-resource-resolution.test.js +176 -0
  273. package/dist/server/view-resource-resolution.test.js.map +1 -0
  274. package/dist/server/viewsDevServer.d.ts +14 -0
  275. package/dist/server/viewsDevServer.js +48 -0
  276. package/dist/server/viewsDevServer.js.map +1 -0
  277. package/dist/test/utils.d.ts +125 -0
  278. package/dist/test/utils.js +266 -0
  279. package/dist/test/utils.js.map +1 -0
  280. package/dist/test/view.test.d.ts +1 -0
  281. package/dist/test/view.test.js +540 -0
  282. package/dist/test/view.test.js.map +1 -0
  283. package/dist/version.d.ts +1 -0
  284. package/dist/version.js +3 -0
  285. package/dist/version.js.map +1 -0
  286. package/dist/views/index.d.ts +10 -0
  287. package/dist/views/index.js +3 -0
  288. package/dist/views/index.js.map +1 -0
  289. package/dist/views/scan-views.d.ts +16 -0
  290. package/dist/views/scan-views.js +88 -0
  291. package/dist/views/scan-views.js.map +1 -0
  292. package/dist/views/scan-views.test.d.ts +1 -0
  293. package/dist/views/scan-views.test.js +99 -0
  294. package/dist/views/scan-views.test.js.map +1 -0
  295. package/dist/views/validate-view.d.ts +1 -0
  296. package/dist/views/validate-view.js +9 -0
  297. package/dist/views/validate-view.js.map +1 -0
  298. package/dist/views/validate-view.test.d.ts +1 -0
  299. package/dist/views/validate-view.test.js +24 -0
  300. package/dist/views/validate-view.test.js.map +1 -0
  301. package/dist/web/bridges/adaptor.d.ts +51 -0
  302. package/dist/web/bridges/adaptor.js +327 -0
  303. package/dist/web/bridges/adaptor.js.map +1 -0
  304. package/dist/web/bridges/adaptor.test.d.ts +1 -0
  305. package/dist/web/bridges/adaptor.test.js +225 -0
  306. package/dist/web/bridges/adaptor.test.js.map +1 -0
  307. package/dist/web/bridges/apps-sdk/bridge.d.ts +15 -0
  308. package/dist/web/bridges/apps-sdk/bridge.js +58 -0
  309. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -0
  310. package/dist/web/bridges/apps-sdk/index.d.ts +4 -0
  311. package/dist/web/bridges/apps-sdk/index.js +4 -0
  312. package/dist/web/bridges/apps-sdk/index.js.map +1 -0
  313. package/dist/web/bridges/apps-sdk/types.d.ts +133 -0
  314. package/dist/web/bridges/apps-sdk/types.js +10 -0
  315. package/dist/web/bridges/apps-sdk/types.js.map +1 -0
  316. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +13 -0
  317. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +18 -0
  318. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -0
  319. package/dist/web/bridges/get-adaptor.d.ts +9 -0
  320. package/dist/web/bridges/get-adaptor.js +10 -0
  321. package/dist/web/bridges/get-adaptor.js.map +1 -0
  322. package/dist/web/bridges/get-adaptor.test.d.ts +1 -0
  323. package/dist/web/bridges/get-adaptor.test.js +32 -0
  324. package/dist/web/bridges/get-adaptor.test.js.map +1 -0
  325. package/dist/web/bridges/index.d.ts +5 -0
  326. package/dist/web/bridges/index.js +6 -0
  327. package/dist/web/bridges/index.js.map +1 -0
  328. package/dist/web/bridges/mcp-app/bridge.d.ts +39 -0
  329. package/dist/web/bridges/mcp-app/bridge.js +168 -0
  330. package/dist/web/bridges/mcp-app/bridge.js.map +1 -0
  331. package/dist/web/bridges/mcp-app/bridge.test.d.ts +1 -0
  332. package/dist/web/bridges/mcp-app/bridge.test.js +17 -0
  333. package/dist/web/bridges/mcp-app/bridge.test.js.map +1 -0
  334. package/dist/web/bridges/mcp-app/index.d.ts +3 -0
  335. package/dist/web/bridges/mcp-app/index.js +3 -0
  336. package/dist/web/bridges/mcp-app/index.js.map +1 -0
  337. package/dist/web/bridges/mcp-app/types.d.ts +10 -0
  338. package/dist/web/bridges/mcp-app/types.js +2 -0
  339. package/dist/web/bridges/mcp-app/types.js.map +1 -0
  340. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +19 -0
  341. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +19 -0
  342. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -0
  343. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.d.ts +1 -0
  344. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js +26 -0
  345. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -0
  346. package/dist/web/bridges/mcp-app/view-tools.test.d.ts +1 -0
  347. package/dist/web/bridges/mcp-app/view-tools.test.js +143 -0
  348. package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -0
  349. package/dist/web/bridges/types.d.ts +219 -0
  350. package/dist/web/bridges/types.js +15 -0
  351. package/dist/web/bridges/types.js.map +1 -0
  352. package/dist/web/bridges/types.test.d.ts +1 -0
  353. package/dist/web/bridges/types.test.js +19 -0
  354. package/dist/web/bridges/types.test.js.map +1 -0
  355. package/dist/web/bridges/use-host-context.d.ts +7 -0
  356. package/dist/web/bridges/use-host-context.js +13 -0
  357. package/dist/web/bridges/use-host-context.js.map +1 -0
  358. package/dist/web/components/modal-provider.d.ts +4 -0
  359. package/dist/web/components/modal-provider.js +46 -0
  360. package/dist/web/components/modal-provider.js.map +1 -0
  361. package/dist/web/create-store.d.ts +29 -0
  362. package/dist/web/create-store.js +64 -0
  363. package/dist/web/create-store.js.map +1 -0
  364. package/dist/web/create-store.test.d.ts +1 -0
  365. package/dist/web/create-store.test.js +132 -0
  366. package/dist/web/create-store.test.js.map +1 -0
  367. package/dist/web/data-llm.d.ts +47 -0
  368. package/dist/web/data-llm.js +100 -0
  369. package/dist/web/data-llm.js.map +1 -0
  370. package/dist/web/data-llm.test.d.ts +1 -0
  371. package/dist/web/data-llm.test.js +155 -0
  372. package/dist/web/data-llm.test.js.map +1 -0
  373. package/dist/web/generate-helpers.d.ts +124 -0
  374. package/dist/web/generate-helpers.js +119 -0
  375. package/dist/web/generate-helpers.js.map +1 -0
  376. package/dist/web/generate-helpers.test-d.d.ts +1 -0
  377. package/dist/web/generate-helpers.test-d.js +211 -0
  378. package/dist/web/generate-helpers.test-d.js.map +1 -0
  379. package/dist/web/generate-helpers.test.d.ts +1 -0
  380. package/dist/web/generate-helpers.test.js +17 -0
  381. package/dist/web/generate-helpers.test.js.map +1 -0
  382. package/dist/web/helpers/state.d.ts +7 -0
  383. package/dist/web/helpers/state.js +45 -0
  384. package/dist/web/helpers/state.js.map +1 -0
  385. package/dist/web/helpers/state.test.d.ts +1 -0
  386. package/dist/web/helpers/state.test.js +53 -0
  387. package/dist/web/helpers/state.test.js.map +1 -0
  388. package/dist/web/hooks/index.d.ts +16 -0
  389. package/dist/web/hooks/index.js +17 -0
  390. package/dist/web/hooks/index.js.map +1 -0
  391. package/dist/web/hooks/test/utils.d.ts +21 -0
  392. package/dist/web/hooks/test/utils.js +75 -0
  393. package/dist/web/hooks/test/utils.js.map +1 -0
  394. package/dist/web/hooks/use-call-tool.d.ts +146 -0
  395. package/dist/web/hooks/use-call-tool.js +96 -0
  396. package/dist/web/hooks/use-call-tool.js.map +1 -0
  397. package/dist/web/hooks/use-call-tool.test-d.d.ts +1 -0
  398. package/dist/web/hooks/use-call-tool.test-d.js +104 -0
  399. package/dist/web/hooks/use-call-tool.test-d.js.map +1 -0
  400. package/dist/web/hooks/use-call-tool.test.d.ts +1 -0
  401. package/dist/web/hooks/use-call-tool.test.js +225 -0
  402. package/dist/web/hooks/use-call-tool.test.js.map +1 -0
  403. package/dist/web/hooks/use-display-mode.d.ts +24 -0
  404. package/dist/web/hooks/use-display-mode.js +29 -0
  405. package/dist/web/hooks/use-display-mode.js.map +1 -0
  406. package/dist/web/hooks/use-display-mode.test-d.d.ts +1 -0
  407. package/dist/web/hooks/use-display-mode.test-d.js +8 -0
  408. package/dist/web/hooks/use-display-mode.test-d.js.map +1 -0
  409. package/dist/web/hooks/use-display-mode.test.d.ts +1 -0
  410. package/dist/web/hooks/use-display-mode.test.js +77 -0
  411. package/dist/web/hooks/use-display-mode.test.js.map +1 -0
  412. package/dist/web/hooks/use-download.d.ts +3 -0
  413. package/dist/web/hooks/use-download.js +7 -0
  414. package/dist/web/hooks/use-download.js.map +1 -0
  415. package/dist/web/hooks/use-download.test.d.ts +1 -0
  416. package/dist/web/hooks/use-download.test.js +103 -0
  417. package/dist/web/hooks/use-download.test.js.map +1 -0
  418. package/dist/web/hooks/use-files.d.ts +39 -0
  419. package/dist/web/hooks/use-files.js +42 -0
  420. package/dist/web/hooks/use-files.js.map +1 -0
  421. package/dist/web/hooks/use-files.test.d.ts +1 -0
  422. package/dist/web/hooks/use-files.test.js +62 -0
  423. package/dist/web/hooks/use-files.test.js.map +1 -0
  424. package/dist/web/hooks/use-host.d.ts +22 -0
  425. package/dist/web/hooks/use-host.js +30 -0
  426. package/dist/web/hooks/use-host.js.map +1 -0
  427. package/dist/web/hooks/use-host.test.d.ts +1 -0
  428. package/dist/web/hooks/use-host.test.js +59 -0
  429. package/dist/web/hooks/use-host.test.js.map +1 -0
  430. package/dist/web/hooks/use-open-external.d.ts +20 -0
  431. package/dist/web/hooks/use-open-external.js +24 -0
  432. package/dist/web/hooks/use-open-external.js.map +1 -0
  433. package/dist/web/hooks/use-open-external.test.d.ts +1 -0
  434. package/dist/web/hooks/use-open-external.test.js +75 -0
  435. package/dist/web/hooks/use-open-external.test.js.map +1 -0
  436. package/dist/web/hooks/use-register-view-tool.d.ts +37 -0
  437. package/dist/web/hooks/use-register-view-tool.js +50 -0
  438. package/dist/web/hooks/use-register-view-tool.js.map +1 -0
  439. package/dist/web/hooks/use-request-close.d.ts +16 -0
  440. package/dist/web/hooks/use-request-close.js +21 -0
  441. package/dist/web/hooks/use-request-close.js.map +1 -0
  442. package/dist/web/hooks/use-request-close.test.d.ts +1 -0
  443. package/dist/web/hooks/use-request-close.test.js +47 -0
  444. package/dist/web/hooks/use-request-close.test.js.map +1 -0
  445. package/dist/web/hooks/use-request-modal.d.ts +24 -0
  446. package/dist/web/hooks/use-request-modal.js +31 -0
  447. package/dist/web/hooks/use-request-modal.js.map +1 -0
  448. package/dist/web/hooks/use-request-modal.test.d.ts +1 -0
  449. package/dist/web/hooks/use-request-modal.test.js +71 -0
  450. package/dist/web/hooks/use-request-modal.test.js.map +1 -0
  451. package/dist/web/hooks/use-request-size.d.ts +20 -0
  452. package/dist/web/hooks/use-request-size.js +24 -0
  453. package/dist/web/hooks/use-request-size.js.map +1 -0
  454. package/dist/web/hooks/use-request-size.test.d.ts +1 -0
  455. package/dist/web/hooks/use-request-size.test.js +47 -0
  456. package/dist/web/hooks/use-request-size.test.js.map +1 -0
  457. package/dist/web/hooks/use-send-follow-up-message.d.ts +19 -0
  458. package/dist/web/hooks/use-send-follow-up-message.js +25 -0
  459. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -0
  460. package/dist/web/hooks/use-set-open-in-app-url.d.ts +18 -0
  461. package/dist/web/hooks/use-set-open-in-app-url.js +25 -0
  462. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -0
  463. package/dist/web/hooks/use-set-open-in-app-url.test.d.ts +1 -0
  464. package/dist/web/hooks/use-set-open-in-app-url.test.js +57 -0
  465. package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -0
  466. package/dist/web/hooks/use-tool-info.d.ts +68 -0
  467. package/dist/web/hooks/use-tool-info.js +48 -0
  468. package/dist/web/hooks/use-tool-info.js.map +1 -0
  469. package/dist/web/hooks/use-tool-info.test-d.d.ts +1 -0
  470. package/dist/web/hooks/use-tool-info.test-d.js +86 -0
  471. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -0
  472. package/dist/web/hooks/use-tool-info.test.d.ts +1 -0
  473. package/dist/web/hooks/use-tool-info.test.js +135 -0
  474. package/dist/web/hooks/use-tool-info.test.js.map +1 -0
  475. package/dist/web/hooks/use-user.d.ts +21 -0
  476. package/dist/web/hooks/use-user.js +38 -0
  477. package/dist/web/hooks/use-user.js.map +1 -0
  478. package/dist/web/hooks/use-user.test.d.ts +1 -0
  479. package/dist/web/hooks/use-user.test.js +170 -0
  480. package/dist/web/hooks/use-user.test.js.map +1 -0
  481. package/dist/web/hooks/use-view-state.d.ts +25 -0
  482. package/dist/web/hooks/use-view-state.js +42 -0
  483. package/dist/web/hooks/use-view-state.js.map +1 -0
  484. package/dist/web/hooks/use-view-state.test.d.ts +1 -0
  485. package/dist/web/hooks/use-view-state.test.js +212 -0
  486. package/dist/web/hooks/use-view-state.test.js.map +1 -0
  487. package/dist/web/hooks/use-viewport.d.ts +20 -0
  488. package/dist/web/hooks/use-viewport.js +21 -0
  489. package/dist/web/hooks/use-viewport.js.map +1 -0
  490. package/dist/web/hooks/use-viewport.test.d.ts +1 -0
  491. package/dist/web/hooks/use-viewport.test.js +109 -0
  492. package/dist/web/hooks/use-viewport.test.js.map +1 -0
  493. package/dist/web/index.d.ts +6 -3
  494. package/dist/web/index.js +6 -3
  495. package/dist/web/index.js.map +1 -1
  496. package/dist/web/mount-view.d.ts +21 -0
  497. package/dist/web/mount-view.js +43 -0
  498. package/dist/web/mount-view.js.map +1 -0
  499. package/dist/web/proxy.d.ts +1 -0
  500. package/dist/web/proxy.js +52 -0
  501. package/dist/web/proxy.js.map +1 -0
  502. package/dist/web/types.d.ts +17 -92
  503. package/dist/web/types.js +1 -9
  504. package/dist/web/types.js.map +1 -1
  505. package/package.json +90 -21
  506. package/tsconfig.base.json +33 -0
  507. package/dist/server/widgetsDevServer.d.ts +0 -9
  508. package/dist/server/widgetsDevServer.js +0 -36
  509. package/dist/server/widgetsDevServer.js.map +0 -1
  510. package/dist/web/mount-widget.d.ts +0 -1
  511. package/dist/web/mount-widget.js +0 -10
  512. package/dist/web/mount-widget.js.map +0 -1
  513. package/dist/web/use-openai-global.d.ts +0 -2
  514. package/dist/web/use-openai-global.js +0 -21
  515. package/dist/web/use-openai-global.js.map +0 -1
  516. package/dist/web/use-tool-output.d.ts +0 -3
  517. package/dist/web/use-tool-output.js +0 -5
  518. package/dist/web/use-tool-output.js.map +0 -1
@@ -0,0 +1,155 @@
1
+ import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
2
+ import { cleanup, render } from "@testing-library/react";
3
+ import { afterEach, beforeEach, describe, expect, it, vi, } from "vitest";
4
+ import { VIEW_STATE_WARNING_TOKENS } from "../context-warnings.js";
5
+ import { HostAdaptor } from "./bridges/adaptor.js";
6
+ import { getAdaptor } from "./bridges/get-adaptor.js";
7
+ import { McpAppBridge } from "./bridges/mcp-app/index.js";
8
+ import { DataLLM } from "./data-llm.js";
9
+ import { getMcpAppHostPostMessageMock, MockResizeObserver, } from "./hooks/test/utils.js";
10
+ describe("DataLLM", () => {
11
+ afterEach(() => {
12
+ // Clean up React components BEFORE unstubbing globals
13
+ cleanup();
14
+ HostAdaptor.resetInstance();
15
+ vi.unstubAllGlobals();
16
+ vi.resetAllMocks();
17
+ });
18
+ describe("apps-sdk mode", () => {
19
+ let OpenaiMock;
20
+ beforeEach(() => {
21
+ OpenaiMock = {
22
+ widgetState: { modelContent: {} },
23
+ setWidgetState: vi.fn(),
24
+ };
25
+ // Use Object.defineProperty to ensure it persists
26
+ Object.defineProperty(globalThis, "openai", {
27
+ value: OpenaiMock,
28
+ writable: true,
29
+ configurable: true,
30
+ });
31
+ // Also set on window for browser-like environment
32
+ if (typeof window !== "undefined") {
33
+ Object.defineProperty(window, "openai", {
34
+ value: OpenaiMock,
35
+ writable: true,
36
+ configurable: true,
37
+ });
38
+ }
39
+ vi.stubGlobal("openai", OpenaiMock);
40
+ vi.stubGlobal("skybridge", {});
41
+ });
42
+ afterEach(() => {
43
+ // Keep the mock available for React cleanup, but reset it
44
+ if (typeof window !== "undefined" && window.openai) {
45
+ window.openai.setWidgetState = vi.fn();
46
+ window.openai.widgetState = { modelContent: {}, privateContent: {} };
47
+ }
48
+ });
49
+ it("should register a node with content and call setViewState", () => {
50
+ render(_jsx(DataLLM, { content: "Test content", children: _jsx("div", { children: "Child" }) }));
51
+ expect(OpenaiMock.setWidgetState).toHaveBeenCalled();
52
+ const callArgs = OpenaiMock.setWidgetState.mock.calls[0]?.[0]?.modelContent;
53
+ expect(callArgs).toHaveProperty("__view_context");
54
+ expect(callArgs?.__view_context).toContain("- Test content");
55
+ });
56
+ it("should preserve existing viewState when updating context", () => {
57
+ OpenaiMock.widgetState = {
58
+ modelContent: { existingKey: "existingValue" },
59
+ };
60
+ render(_jsx(DataLLM, { content: "Test content", children: _jsx("div", { children: "Child" }) }));
61
+ const callArgs = OpenaiMock.setWidgetState.mock.calls[0]?.[0]?.modelContent;
62
+ expect(callArgs).toHaveProperty("existingKey", "existingValue");
63
+ expect(callArgs).toHaveProperty("__view_context");
64
+ });
65
+ it("warns when DataLLM content reaches the 20K token warning threshold", async () => {
66
+ const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => { });
67
+ render(_jsx(DataLLM, { content: "x".repeat(VIEW_STATE_WARNING_TOKENS * 4), children: _jsx("div", { children: "Child" }) }));
68
+ await vi.waitFor(() => {
69
+ expect(warnSpy).toHaveBeenCalledWith(expect.stringContaining("setWidgetState is persisting"));
70
+ });
71
+ warnSpy.mockRestore();
72
+ });
73
+ it("should handle deeply nested DataLLM components", () => {
74
+ render(_jsxs(DataLLM, { content: "Level 1", children: [_jsx(DataLLM, { content: "Level 2A" }), _jsx(DataLLM, { content: "Level 2B", children: _jsx(DataLLM, { content: "Level 3", children: _jsx("div", { children: "Content" }) }) })] }));
75
+ const callArgs = OpenaiMock.setWidgetState.mock.calls[OpenaiMock.setWidgetState.mock.calls.length - 1]?.[0]?.modelContent;
76
+ const context = callArgs?.__view_context;
77
+ expect(context).toContain("- Level 1");
78
+ expect(context).toContain(" - Level 2A");
79
+ expect(context).toContain(" - Level 2B");
80
+ expect(context).toContain(" - Level 3");
81
+ });
82
+ it("should update context when content changes", () => {
83
+ const { rerender } = render(_jsx(DataLLM, { content: "Initial content", children: _jsx("div", { children: "Child" }) }));
84
+ const initialCalls = OpenaiMock.setWidgetState.mock.calls.length;
85
+ rerender(_jsx(DataLLM, { content: "Updated content", children: _jsx("div", { children: "Child" }) }));
86
+ expect(OpenaiMock.setWidgetState.mock.calls.length).toBeGreaterThan(initialCalls);
87
+ const lastCallArgs = OpenaiMock.setWidgetState.mock.calls[OpenaiMock.setWidgetState.mock.calls.length - 1]?.[0]?.modelContent;
88
+ expect(lastCallArgs?.__view_context).toContain("- Updated content");
89
+ });
90
+ it("should remove node and update context when component unmounts", () => {
91
+ const { unmount } = render(_jsx(DataLLM, { content: "Content to remove", children: _jsx("div", { children: "Child" }) }));
92
+ const callsBeforeUnmount = OpenaiMock.setWidgetState.mock.calls.length;
93
+ unmount();
94
+ expect(OpenaiMock.setWidgetState.mock.calls.length).toBeGreaterThan(callsBeforeUnmount);
95
+ const lastCallArgs = OpenaiMock.setWidgetState.mock.calls[OpenaiMock.setWidgetState.mock.calls.length - 1]?.[0]?.modelContent;
96
+ expect(lastCallArgs?.__view_context).not.toContain("Content to remove");
97
+ });
98
+ });
99
+ describe("mcp-app mode", () => {
100
+ let postMessageMock;
101
+ beforeEach(() => {
102
+ vi.stubGlobal("skybridge", {});
103
+ vi.stubGlobal("openai", undefined);
104
+ vi.stubGlobal("ResizeObserver", MockResizeObserver);
105
+ postMessageMock = getMcpAppHostPostMessageMock();
106
+ vi.stubGlobal("parent", { postMessage: postMessageMock });
107
+ });
108
+ afterEach(() => {
109
+ cleanup();
110
+ McpAppBridge.resetInstance();
111
+ HostAdaptor.resetInstance();
112
+ });
113
+ it("should register a node and update view state via adaptor", async () => {
114
+ const adaptor = getAdaptor();
115
+ render(_jsx(DataLLM, { content: "Test content", children: _jsx("div", { children: "Child" }) }));
116
+ await vi.waitFor(() => {
117
+ const viewState = adaptor
118
+ .getHostContextStore("viewState")
119
+ .getSnapshot();
120
+ expect(viewState?.__view_context).toContain("- Test content");
121
+ });
122
+ });
123
+ it("should preserve existing view state when updating context", async () => {
124
+ const adaptor = getAdaptor();
125
+ await adaptor.setViewState({ existingKey: "existingValue" });
126
+ render(_jsx(DataLLM, { content: "Test content", children: _jsx("div", { children: "Child" }) }));
127
+ await vi.waitFor(() => {
128
+ const viewState = adaptor
129
+ .getHostContextStore("viewState")
130
+ .getSnapshot();
131
+ expect(viewState?.existingKey).toBe("existingValue");
132
+ expect(viewState?.__view_context).toContain("- Test content");
133
+ });
134
+ });
135
+ it("should handle multiple DataLLM components sharing state through adaptor", async () => {
136
+ const adaptor = getAdaptor();
137
+ render(_jsxs(_Fragment, { children: [_jsx(DataLLM, { content: "First component", children: _jsx("div", { children: "First" }) }), _jsx(DataLLM, { content: "Second component", children: _jsx("div", { children: "Second" }) })] }));
138
+ await vi.waitFor(() => {
139
+ const viewState = adaptor
140
+ .getHostContextStore("viewState")
141
+ .getSnapshot();
142
+ const context = viewState?.__view_context;
143
+ expect(context).toContain("- First component");
144
+ expect(context).toContain("- Second component");
145
+ });
146
+ });
147
+ it("should call ui/update-model-context when view state changes", async () => {
148
+ render(_jsx(DataLLM, { content: "Test content", children: _jsx("div", { children: "Child" }) }));
149
+ await vi.waitFor(() => {
150
+ expect(postMessageMock).toHaveBeenCalledWith(expect.objectContaining({ method: "ui/update-model-context" }), "*");
151
+ });
152
+ });
153
+ });
154
+ });
155
+ //# sourceMappingURL=data-llm.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"data-llm.test.js","sourceRoot":"","sources":["../../src/web/data-llm.test.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EACL,SAAS,EACT,UAAU,EACV,QAAQ,EACR,MAAM,EACN,EAAE,EAEF,EAAE,GACH,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,uBAAuB,CAAC;AAE/B,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,SAAS,CAAC,GAAG,EAAE;QACb,sDAAsD;QACtD,OAAO,EAAE,CAAC;QACV,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,IAAI,UAA0D,CAAC;QAE/D,UAAU,CAAC,GAAG,EAAE;YACd,UAAU,GAAG;gBACX,WAAW,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE;gBACjC,cAAc,EAAE,EAAE,CAAC,EAAE,EAAE;aACxB,CAAC;YACF,kDAAkD;YAClD,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,EAAE;gBAC1C,KAAK,EAAE,UAAU;gBACjB,QAAQ,EAAE,IAAI;gBACd,YAAY,EAAE,IAAI;aACnB,CAAC,CAAC;YACH,kDAAkD;YAClD,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;gBAClC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE;oBACtC,KAAK,EAAE,UAAU;oBACjB,QAAQ,EAAE,IAAI;oBACd,YAAY,EAAE,IAAI;iBACnB,CAAC,CAAC;YACL,CAAC;YACD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACpC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,0DAA0D;YAC1D,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBACnD,MAAM,CAAC,MAAM,CAAC,cAAc,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;gBACvC,MAAM,CAAC,MAAM,CAAC,WAAW,GAAG,EAAE,YAAY,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;YACvE,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,CACJ,KAAC,OAAO,IAAC,OAAO,EAAC,cAAc,YAC7B,kCAAgB,GACR,CACX,CAAC;YAEF,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,gBAAgB,EAAE,CAAC;YACrD,MAAM,QAAQ,GACZ,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC;YAC7D,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;YAClD,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;YAClE,UAAU,CAAC,WAAW,GAAG;gBACvB,YAAY,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE;aAC/C,CAAC;YAEF,MAAM,CACJ,KAAC,OAAO,IAAC,OAAO,EAAC,cAAc,YAC7B,kCAAgB,GACR,CACX,CAAC;YAEF,MAAM,QAAQ,GACZ,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC;YAC7D,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;YAChE,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;YAClF,MAAM,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAEvE,MAAM,CACJ,KAAC,OAAO,IAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,yBAAyB,GAAG,CAAC,CAAC,YACzD,kCAAgB,GACR,CACX,CAAC;YAEF,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;gBACpB,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAClC,MAAM,CAAC,gBAAgB,CAAC,8BAA8B,CAAC,CACxD,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,OAAO,CAAC,WAAW,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACxD,MAAM,CACJ,MAAC,OAAO,IAAC,OAAO,EAAC,SAAS,aACxB,KAAC,OAAO,IAAC,OAAO,EAAC,UAAU,GAAG,EAC9B,KAAC,OAAO,IAAC,OAAO,EAAC,UAAU,YACzB,KAAC,OAAO,IAAC,OAAO,EAAC,SAAS,YACxB,oCAAkB,GACV,GACF,IACF,CACX,CAAC;YAEF,MAAM,QAAQ,GACZ,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAClC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAChD,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC;YACvB,MAAM,OAAO,GAAG,QAAQ,EAAE,cAAwB,CAAC;YACnD,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACvC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;YAC1C,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;YAC1C,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CACzB,KAAC,OAAO,IAAC,OAAO,EAAC,iBAAiB,YAChC,kCAAgB,GACR,CACX,CAAC;YAEF,MAAM,YAAY,GAAG,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;YAEjE,QAAQ,CACN,KAAC,OAAO,IAAC,OAAO,EAAC,iBAAiB,YAChC,kCAAgB,GACR,CACX,CAAC;YAEF,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,eAAe,CACjE,YAAY,CACb,CAAC;YACF,MAAM,YAAY,GAChB,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAClC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAChD,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC;YACvB,MAAM,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;YACvE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CACxB,KAAC,OAAO,IAAC,OAAO,EAAC,mBAAmB,YAClC,kCAAgB,GACR,CACX,CAAC;YAEF,MAAM,kBAAkB,GAAG,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;YAEvE,OAAO,EAAE,CAAC;YAEV,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,eAAe,CACjE,kBAAkB,CACnB,CAAC;YACF,MAAM,YAAY,GAChB,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAClC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAChD,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC;YACvB,MAAM,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,IAAI,eAAgE,CAAC;QAErE,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAC/B,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACnC,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;YACpD,eAAe,GAAG,4BAA4B,EAAE,CAAC;YACjD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,OAAO,EAAE,CAAC;YACV,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,WAAW,CAAC,aAAa,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;YAE7B,MAAM,CACJ,KAAC,OAAO,IAAC,OAAO,EAAC,cAAc,YAC7B,kCAAgB,GACR,CACX,CAAC;YAEF,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;gBACpB,MAAM,SAAS,GAAG,OAAO;qBACtB,mBAAmB,CAAC,WAAW,CAAC;qBAChC,WAAW,EAAE,CAAC;gBACjB,MAAM,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;YAChE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;YACzE,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;YAC7B,MAAM,OAAO,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;YAE7D,MAAM,CACJ,KAAC,OAAO,IAAC,OAAO,EAAC,cAAc,YAC7B,kCAAgB,GACR,CACX,CAAC;YAEF,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;gBACpB,MAAM,SAAS,GAAG,OAAO;qBACtB,mBAAmB,CAAC,WAAW,CAAC;qBAChC,WAAW,EAAE,CAAC;gBACjB,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBACrD,MAAM,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;YAChE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;YACvF,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;YAE7B,MAAM,CACJ,8BACE,KAAC,OAAO,IAAC,OAAO,EAAC,iBAAiB,YAChC,kCAAgB,GACR,EACV,KAAC,OAAO,IAAC,OAAO,EAAC,kBAAkB,YACjC,mCAAiB,GACT,IACT,CACJ,CAAC;YAEF,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;gBACpB,MAAM,SAAS,GAAG,OAAO;qBACtB,mBAAmB,CAAC,WAAW,CAAC;qBAChC,WAAW,EAAE,CAAC;gBACjB,MAAM,OAAO,GAAG,SAAS,EAAE,cAAwB,CAAC;gBACpD,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;gBAC/C,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;YAC3E,MAAM,CACJ,KAAC,OAAO,IAAC,OAAO,EAAC,cAAc,YAC7B,kCAAgB,GACR,CACX,CAAC;YAEF,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;gBACpB,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAC1C,MAAM,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,yBAAyB,EAAE,CAAC,EAC9D,GAAG,CACJ,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { cleanup, render } from \"@testing-library/react\";\nimport {\n afterEach,\n beforeEach,\n describe,\n expect,\n it,\n type Mock,\n vi,\n} from \"vitest\";\nimport { VIEW_STATE_WARNING_TOKENS } from \"../context-warnings.js\";\nimport { HostAdaptor } from \"./bridges/adaptor.js\";\nimport { getAdaptor } from \"./bridges/get-adaptor.js\";\nimport { McpAppBridge } from \"./bridges/mcp-app/index.js\";\nimport { DataLLM } from \"./data-llm.js\";\nimport {\n getMcpAppHostPostMessageMock,\n MockResizeObserver,\n} from \"./hooks/test/utils.js\";\n\ndescribe(\"DataLLM\", () => {\n afterEach(() => {\n // Clean up React components BEFORE unstubbing globals\n cleanup();\n HostAdaptor.resetInstance();\n vi.unstubAllGlobals();\n vi.resetAllMocks();\n });\n\n describe(\"apps-sdk mode\", () => {\n let OpenaiMock: { widgetState: unknown; setWidgetState: Mock };\n\n beforeEach(() => {\n OpenaiMock = {\n widgetState: { modelContent: {} },\n setWidgetState: vi.fn(),\n };\n // Use Object.defineProperty to ensure it persists\n Object.defineProperty(globalThis, \"openai\", {\n value: OpenaiMock,\n writable: true,\n configurable: true,\n });\n // Also set on window for browser-like environment\n if (typeof window !== \"undefined\") {\n Object.defineProperty(window, \"openai\", {\n value: OpenaiMock,\n writable: true,\n configurable: true,\n });\n }\n vi.stubGlobal(\"openai\", OpenaiMock);\n vi.stubGlobal(\"skybridge\", {});\n });\n\n afterEach(() => {\n // Keep the mock available for React cleanup, but reset it\n if (typeof window !== \"undefined\" && window.openai) {\n window.openai.setWidgetState = vi.fn();\n window.openai.widgetState = { modelContent: {}, privateContent: {} };\n }\n });\n\n it(\"should register a node with content and call setViewState\", () => {\n render(\n <DataLLM content=\"Test content\">\n <div>Child</div>\n </DataLLM>,\n );\n\n expect(OpenaiMock.setWidgetState).toHaveBeenCalled();\n const callArgs =\n OpenaiMock.setWidgetState.mock.calls[0]?.[0]?.modelContent;\n expect(callArgs).toHaveProperty(\"__view_context\");\n expect(callArgs?.__view_context).toContain(\"- Test content\");\n });\n it(\"should preserve existing viewState when updating context\", () => {\n OpenaiMock.widgetState = {\n modelContent: { existingKey: \"existingValue\" },\n };\n\n render(\n <DataLLM content=\"Test content\">\n <div>Child</div>\n </DataLLM>,\n );\n\n const callArgs =\n OpenaiMock.setWidgetState.mock.calls[0]?.[0]?.modelContent;\n expect(callArgs).toHaveProperty(\"existingKey\", \"existingValue\");\n expect(callArgs).toHaveProperty(\"__view_context\");\n });\n\n it(\"warns when DataLLM content reaches the 20K token warning threshold\", async () => {\n const warnSpy = vi.spyOn(console, \"warn\").mockImplementation(() => {});\n\n render(\n <DataLLM content={\"x\".repeat(VIEW_STATE_WARNING_TOKENS * 4)}>\n <div>Child</div>\n </DataLLM>,\n );\n\n await vi.waitFor(() => {\n expect(warnSpy).toHaveBeenCalledWith(\n expect.stringContaining(\"setWidgetState is persisting\"),\n );\n });\n\n warnSpy.mockRestore();\n });\n\n it(\"should handle deeply nested DataLLM components\", () => {\n render(\n <DataLLM content=\"Level 1\">\n <DataLLM content=\"Level 2A\" />\n <DataLLM content=\"Level 2B\">\n <DataLLM content=\"Level 3\">\n <div>Content</div>\n </DataLLM>\n </DataLLM>\n </DataLLM>,\n );\n\n const callArgs =\n OpenaiMock.setWidgetState.mock.calls[\n OpenaiMock.setWidgetState.mock.calls.length - 1\n ]?.[0]?.modelContent;\n const context = callArgs?.__view_context as string;\n expect(context).toContain(\"- Level 1\");\n expect(context).toContain(\" - Level 2A\");\n expect(context).toContain(\" - Level 2B\");\n expect(context).toContain(\" - Level 3\");\n });\n\n it(\"should update context when content changes\", () => {\n const { rerender } = render(\n <DataLLM content=\"Initial content\">\n <div>Child</div>\n </DataLLM>,\n );\n\n const initialCalls = OpenaiMock.setWidgetState.mock.calls.length;\n\n rerender(\n <DataLLM content=\"Updated content\">\n <div>Child</div>\n </DataLLM>,\n );\n\n expect(OpenaiMock.setWidgetState.mock.calls.length).toBeGreaterThan(\n initialCalls,\n );\n const lastCallArgs =\n OpenaiMock.setWidgetState.mock.calls[\n OpenaiMock.setWidgetState.mock.calls.length - 1\n ]?.[0]?.modelContent;\n expect(lastCallArgs?.__view_context).toContain(\"- Updated content\");\n });\n\n it(\"should remove node and update context when component unmounts\", () => {\n const { unmount } = render(\n <DataLLM content=\"Content to remove\">\n <div>Child</div>\n </DataLLM>,\n );\n\n const callsBeforeUnmount = OpenaiMock.setWidgetState.mock.calls.length;\n\n unmount();\n\n expect(OpenaiMock.setWidgetState.mock.calls.length).toBeGreaterThan(\n callsBeforeUnmount,\n );\n const lastCallArgs =\n OpenaiMock.setWidgetState.mock.calls[\n OpenaiMock.setWidgetState.mock.calls.length - 1\n ]?.[0]?.modelContent;\n expect(lastCallArgs?.__view_context).not.toContain(\"Content to remove\");\n });\n });\n\n describe(\"mcp-app mode\", () => {\n let postMessageMock: ReturnType<typeof getMcpAppHostPostMessageMock>;\n\n beforeEach(() => {\n vi.stubGlobal(\"skybridge\", {});\n vi.stubGlobal(\"openai\", undefined);\n vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n postMessageMock = getMcpAppHostPostMessageMock();\n vi.stubGlobal(\"parent\", { postMessage: postMessageMock });\n });\n\n afterEach(() => {\n cleanup();\n McpAppBridge.resetInstance();\n HostAdaptor.resetInstance();\n });\n\n it(\"should register a node and update view state via adaptor\", async () => {\n const adaptor = getAdaptor();\n\n render(\n <DataLLM content=\"Test content\">\n <div>Child</div>\n </DataLLM>,\n );\n\n await vi.waitFor(() => {\n const viewState = adaptor\n .getHostContextStore(\"viewState\")\n .getSnapshot();\n expect(viewState?.__view_context).toContain(\"- Test content\");\n });\n });\n\n it(\"should preserve existing view state when updating context\", async () => {\n const adaptor = getAdaptor();\n await adaptor.setViewState({ existingKey: \"existingValue\" });\n\n render(\n <DataLLM content=\"Test content\">\n <div>Child</div>\n </DataLLM>,\n );\n\n await vi.waitFor(() => {\n const viewState = adaptor\n .getHostContextStore(\"viewState\")\n .getSnapshot();\n expect(viewState?.existingKey).toBe(\"existingValue\");\n expect(viewState?.__view_context).toContain(\"- Test content\");\n });\n });\n\n it(\"should handle multiple DataLLM components sharing state through adaptor\", async () => {\n const adaptor = getAdaptor();\n\n render(\n <>\n <DataLLM content=\"First component\">\n <div>First</div>\n </DataLLM>\n <DataLLM content=\"Second component\">\n <div>Second</div>\n </DataLLM>\n </>,\n );\n\n await vi.waitFor(() => {\n const viewState = adaptor\n .getHostContextStore(\"viewState\")\n .getSnapshot();\n const context = viewState?.__view_context as string;\n expect(context).toContain(\"- First component\");\n expect(context).toContain(\"- Second component\");\n });\n });\n\n it(\"should call ui/update-model-context when view state changes\", async () => {\n render(\n <DataLLM content=\"Test content\">\n <div>Child</div>\n </DataLLM>,\n );\n\n await vi.waitFor(() => {\n expect(postMessageMock).toHaveBeenCalledWith(\n expect.objectContaining({ method: \"ui/update-model-context\" }),\n \"*\",\n );\n });\n });\n });\n});\n"]}
@@ -0,0 +1,124 @@
1
+ import type { InferTools, ToolInput, ToolOutput, ToolResponseMetadata } from "../server/index.js";
2
+ import type { CallToolResponse } from "./bridges/types.js";
3
+ import { type CallToolAsyncFn, type CallToolFn, type CallToolState } from "./hooks/use-call-tool.js";
4
+ import { type ToolState } from "./hooks/use-tool-info.js";
5
+ import type { Objectify, Prettify } from "./types.js";
6
+ type TypedCallToolResponse<TOutput> = CallToolResponse & {
7
+ structuredContent: TOutput;
8
+ };
9
+ type TypedCallToolReturn<TInput, TOutput> = Prettify<CallToolState<TypedCallToolResponse<TOutput>> & {
10
+ callTool: CallToolFn<TInput, TypedCallToolResponse<TOutput>>;
11
+ callToolAsync: CallToolAsyncFn<TInput, TypedCallToolResponse<TOutput>>;
12
+ }>;
13
+ type TypedToolInfoReturn<TInput, TOutput, TResponseMetadata> = ToolState<Objectify<TInput>, Objectify<TOutput>, Objectify<TResponseMetadata>>;
14
+ /**
15
+ * Creates typed versions of skybridge hooks with full type inference
16
+ * for tool names, inputs, and outputs.
17
+ *
18
+ * This is the recommended way to use skybridge hooks in your views.
19
+ * Set this up once in a dedicated file and export the typed hooks for use across your app.
20
+ *
21
+ * @typeParam AppType - The type of your Skybridge app (use `typeof app`). The
22
+ * handler must return the chained server so the tool
23
+ * types are carried on the app type.
24
+ *
25
+ * @example
26
+ * ```typescript
27
+ * // src/server.ts
28
+ * export const app = new Skybridge({
29
+ * name: "my-app",
30
+ * version: "1.0",
31
+ * handler: (server) =>
32
+ * server.registerTool({
33
+ * name: "search-trip",
34
+ * inputSchema: { destination: z.string() },
35
+ * outputSchema: { results: z.array(z.string()) },
36
+ * view: { component: "search-trip", description: "Search trips" },
37
+ * }, async ({ destination }) => {
38
+ * return { content: [{ type: "text", text: `Found trips to ${destination}` }] };
39
+ * }),
40
+ * });
41
+ *
42
+ * export type AppType = typeof app;
43
+ * ```
44
+ *
45
+ * @example
46
+ * ```typescript
47
+ * // src/helpers.ts (one-time setup)
48
+ * import type { AppType } from "./server";
49
+ * import { generateHelpers } from "skybridge/web";
50
+ *
51
+ * export const { useCallTool, useToolInfo } = generateHelpers<AppType>();
52
+ * ```
53
+ *
54
+ * @example
55
+ * ```typescript
56
+ * // src/views/search.tsx (usage)
57
+ * import { useCallTool, useToolInfo } from "../helpers";
58
+ *
59
+ * export function SearchView() {
60
+ * const { callTool, data } = useCallTool("search-trip");
61
+ * // ^ autocomplete for tool names
62
+ * callTool({ destination: "Spain" });
63
+ * // ^ autocomplete for input fields
64
+ *
65
+ * const toolInfo = useToolInfo<"search-trip">();
66
+ * // ^ autocomplete for view names
67
+ * // toolInfo.input is typed based on view input schema
68
+ * // toolInfo.output.structuredContent is typed based on view output schema
69
+ * }
70
+ * ```
71
+ *
72
+ * @see https://docs.skybridge.tech/api-reference/generate-helpers
73
+ */
74
+ export declare function generateHelpers<AppType = never>(): {
75
+ /**
76
+ * Typed version of `useCallTool` that provides autocomplete for tool names
77
+ * and type inference for inputs and outputs.
78
+ *
79
+ * @param name - The name of the tool to call. Autocompletes based on your app's tool registry.
80
+ * @returns A hook with typed `callTool` function and `data` property.
81
+ *
82
+ * @example
83
+ * ```typescript
84
+ * const { callTool, data, isPending } = useCallTool("search-trip");
85
+ * // TypeScript knows callTool expects { destination: string }
86
+ * callTool({ destination: "Spain" });
87
+ *
88
+ * // data.structuredContent is typed based on your outputSchema
89
+ * if (data) {
90
+ * console.log(data.structuredContent.results);
91
+ * }
92
+ * ```
93
+ */
94
+ useCallTool: <ToolName extends keyof InferTools<AppType> & string>(name: ToolName) => TypedCallToolReturn<ToolInput<AppType, ToolName>, ToolOutput<AppType, ToolName>>;
95
+ /**
96
+ * Typed version of `useToolInfo` that provides autocomplete for tool names
97
+ * and type inference for inputs, outputs, and responseMetadata.
98
+ *
99
+ * @typeParam K - The name of the tool. Autocompletes based on your app's tool registry.
100
+ * @returns A discriminated union with `status: "pending" | "success"` that narrows correctly.
101
+ *
102
+ * @example
103
+ * ```typescript
104
+ * const toolInfo = useToolInfo<"search-trip">();
105
+ * // toolInfo.input is typed as { destination: string; ... }
106
+ * // toolInfo.output is typed as { results: Array<...>; ... }
107
+ * // toolInfo.responseMetadata is typed based on _meta in callback return
108
+ * // toolInfo.status narrows correctly: "pending" | "success"
109
+ *
110
+ * if (toolInfo.isPending) {
111
+ * // TypeScript knows output and responseMetadata are undefined here
112
+ * console.log(toolInfo.input.destination);
113
+ * }
114
+ *
115
+ * if (toolInfo.isSuccess) {
116
+ * // TypeScript knows output and responseMetadata are defined here
117
+ * console.log(toolInfo.output.results);
118
+ * console.log(toolInfo.responseMetadata);
119
+ * }
120
+ * ```
121
+ */
122
+ useToolInfo: <ToolName extends keyof InferTools<AppType> & string>() => TypedToolInfoReturn<ToolInput<AppType, ToolName>, ToolOutput<AppType, ToolName>, ToolResponseMetadata<AppType, ToolName>>;
123
+ };
124
+ export {};
@@ -0,0 +1,119 @@
1
+ import { useCallTool, } from "./hooks/use-call-tool.js";
2
+ import { useToolInfo } from "./hooks/use-tool-info.js";
3
+ /**
4
+ * Creates typed versions of skybridge hooks with full type inference
5
+ * for tool names, inputs, and outputs.
6
+ *
7
+ * This is the recommended way to use skybridge hooks in your views.
8
+ * Set this up once in a dedicated file and export the typed hooks for use across your app.
9
+ *
10
+ * @typeParam AppType - The type of your Skybridge app (use `typeof app`). The
11
+ * handler must return the chained server so the tool
12
+ * types are carried on the app type.
13
+ *
14
+ * @example
15
+ * ```typescript
16
+ * // src/server.ts
17
+ * export const app = new Skybridge({
18
+ * name: "my-app",
19
+ * version: "1.0",
20
+ * handler: (server) =>
21
+ * server.registerTool({
22
+ * name: "search-trip",
23
+ * inputSchema: { destination: z.string() },
24
+ * outputSchema: { results: z.array(z.string()) },
25
+ * view: { component: "search-trip", description: "Search trips" },
26
+ * }, async ({ destination }) => {
27
+ * return { content: [{ type: "text", text: `Found trips to ${destination}` }] };
28
+ * }),
29
+ * });
30
+ *
31
+ * export type AppType = typeof app;
32
+ * ```
33
+ *
34
+ * @example
35
+ * ```typescript
36
+ * // src/helpers.ts (one-time setup)
37
+ * import type { AppType } from "./server";
38
+ * import { generateHelpers } from "skybridge/web";
39
+ *
40
+ * export const { useCallTool, useToolInfo } = generateHelpers<AppType>();
41
+ * ```
42
+ *
43
+ * @example
44
+ * ```typescript
45
+ * // src/views/search.tsx (usage)
46
+ * import { useCallTool, useToolInfo } from "../helpers";
47
+ *
48
+ * export function SearchView() {
49
+ * const { callTool, data } = useCallTool("search-trip");
50
+ * // ^ autocomplete for tool names
51
+ * callTool({ destination: "Spain" });
52
+ * // ^ autocomplete for input fields
53
+ *
54
+ * const toolInfo = useToolInfo<"search-trip">();
55
+ * // ^ autocomplete for view names
56
+ * // toolInfo.input is typed based on view input schema
57
+ * // toolInfo.output.structuredContent is typed based on view output schema
58
+ * }
59
+ * ```
60
+ *
61
+ * @see https://docs.skybridge.tech/api-reference/generate-helpers
62
+ */
63
+ export function generateHelpers() {
64
+ return {
65
+ /**
66
+ * Typed version of `useCallTool` that provides autocomplete for tool names
67
+ * and type inference for inputs and outputs.
68
+ *
69
+ * @param name - The name of the tool to call. Autocompletes based on your app's tool registry.
70
+ * @returns A hook with typed `callTool` function and `data` property.
71
+ *
72
+ * @example
73
+ * ```typescript
74
+ * const { callTool, data, isPending } = useCallTool("search-trip");
75
+ * // TypeScript knows callTool expects { destination: string }
76
+ * callTool({ destination: "Spain" });
77
+ *
78
+ * // data.structuredContent is typed based on your outputSchema
79
+ * if (data) {
80
+ * console.log(data.structuredContent.results);
81
+ * }
82
+ * ```
83
+ */
84
+ useCallTool: (name) => {
85
+ return useCallTool(name);
86
+ },
87
+ /**
88
+ * Typed version of `useToolInfo` that provides autocomplete for tool names
89
+ * and type inference for inputs, outputs, and responseMetadata.
90
+ *
91
+ * @typeParam K - The name of the tool. Autocompletes based on your app's tool registry.
92
+ * @returns A discriminated union with `status: "pending" | "success"` that narrows correctly.
93
+ *
94
+ * @example
95
+ * ```typescript
96
+ * const toolInfo = useToolInfo<"search-trip">();
97
+ * // toolInfo.input is typed as { destination: string; ... }
98
+ * // toolInfo.output is typed as { results: Array<...>; ... }
99
+ * // toolInfo.responseMetadata is typed based on _meta in callback return
100
+ * // toolInfo.status narrows correctly: "pending" | "success"
101
+ *
102
+ * if (toolInfo.isPending) {
103
+ * // TypeScript knows output and responseMetadata are undefined here
104
+ * console.log(toolInfo.input.destination);
105
+ * }
106
+ *
107
+ * if (toolInfo.isSuccess) {
108
+ * // TypeScript knows output and responseMetadata are defined here
109
+ * console.log(toolInfo.output.results);
110
+ * console.log(toolInfo.responseMetadata);
111
+ * }
112
+ * ```
113
+ */
114
+ useToolInfo: () => {
115
+ return useToolInfo();
116
+ },
117
+ };
118
+ }
119
+ //# sourceMappingURL=generate-helpers.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generate-helpers.js","sourceRoot":"","sources":["../../src/web/generate-helpers.ts"],"names":[],"mappings":"AAOA,OAAO,EAIL,WAAW,GACZ,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAkB,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAoBvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AACH,MAAM,UAAU,eAAe;IAI7B,OAAO;QACL;;;;;;;;;;;;;;;;;;WAkBG;QACH,WAAW,EAAE,CACX,IAAc,EAId,EAAE;YACF,OAAO,WAAW,CAAC,IAAI,CAGtB,CAAC;QACJ,CAAC;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;QACH,WAAW,EAAE,GAIX,EAAE;YACF,OAAO,WAAW,EAIjB,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import type {\n InferTools,\n ToolInput,\n ToolOutput,\n ToolResponseMetadata,\n} from \"../server/index.js\";\nimport type { CallToolResponse } from \"./bridges/types.js\";\nimport {\n type CallToolAsyncFn,\n type CallToolFn,\n type CallToolState,\n useCallTool,\n} from \"./hooks/use-call-tool.js\";\nimport { type ToolState, useToolInfo } from \"./hooks/use-tool-info.js\";\nimport type { Objectify, Prettify } from \"./types.js\";\n\ntype TypedCallToolResponse<TOutput> = CallToolResponse & {\n structuredContent: TOutput;\n};\n\ntype TypedCallToolReturn<TInput, TOutput> = Prettify<\n CallToolState<TypedCallToolResponse<TOutput>> & {\n callTool: CallToolFn<TInput, TypedCallToolResponse<TOutput>>;\n callToolAsync: CallToolAsyncFn<TInput, TypedCallToolResponse<TOutput>>;\n }\n>;\n\ntype TypedToolInfoReturn<TInput, TOutput, TResponseMetadata> = ToolState<\n Objectify<TInput>,\n Objectify<TOutput>,\n Objectify<TResponseMetadata>\n>;\n\n/**\n * Creates typed versions of skybridge hooks with full type inference\n * for tool names, inputs, and outputs.\n *\n * This is the recommended way to use skybridge hooks in your views.\n * Set this up once in a dedicated file and export the typed hooks for use across your app.\n *\n * @typeParam AppType - The type of your Skybridge app (use `typeof app`). The\n * handler must return the chained server so the tool\n * types are carried on the app type.\n *\n * @example\n * ```typescript\n * // src/server.ts\n * export const app = new Skybridge({\n * name: \"my-app\",\n * version: \"1.0\",\n * handler: (server) =>\n * server.registerTool({\n * name: \"search-trip\",\n * inputSchema: { destination: z.string() },\n * outputSchema: { results: z.array(z.string()) },\n * view: { component: \"search-trip\", description: \"Search trips\" },\n * }, async ({ destination }) => {\n * return { content: [{ type: \"text\", text: `Found trips to ${destination}` }] };\n * }),\n * });\n *\n * export type AppType = typeof app;\n * ```\n *\n * @example\n * ```typescript\n * // src/helpers.ts (one-time setup)\n * import type { AppType } from \"./server\";\n * import { generateHelpers } from \"skybridge/web\";\n *\n * export const { useCallTool, useToolInfo } = generateHelpers<AppType>();\n * ```\n *\n * @example\n * ```typescript\n * // src/views/search.tsx (usage)\n * import { useCallTool, useToolInfo } from \"../helpers\";\n *\n * export function SearchView() {\n * const { callTool, data } = useCallTool(\"search-trip\");\n * // ^ autocomplete for tool names\n * callTool({ destination: \"Spain\" });\n * // ^ autocomplete for input fields\n *\n * const toolInfo = useToolInfo<\"search-trip\">();\n * // ^ autocomplete for view names\n * // toolInfo.input is typed based on view input schema\n * // toolInfo.output.structuredContent is typed based on view output schema\n * }\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/generate-helpers\n */\nexport function generateHelpers<AppType = never>() {\n type Tools = InferTools<AppType>;\n type ToolNames = keyof Tools & string;\n\n return {\n /**\n * Typed version of `useCallTool` that provides autocomplete for tool names\n * and type inference for inputs and outputs.\n *\n * @param name - The name of the tool to call. Autocompletes based on your app's tool registry.\n * @returns A hook with typed `callTool` function and `data` property.\n *\n * @example\n * ```typescript\n * const { callTool, data, isPending } = useCallTool(\"search-trip\");\n * // TypeScript knows callTool expects { destination: string }\n * callTool({ destination: \"Spain\" });\n *\n * // data.structuredContent is typed based on your outputSchema\n * if (data) {\n * console.log(data.structuredContent.results);\n * }\n * ```\n */\n useCallTool: <ToolName extends ToolNames>(\n name: ToolName,\n ): TypedCallToolReturn<\n ToolInput<AppType, ToolName>,\n ToolOutput<AppType, ToolName>\n > => {\n return useCallTool(name) as TypedCallToolReturn<\n ToolInput<AppType, ToolName>,\n ToolOutput<AppType, ToolName>\n >;\n },\n\n /**\n * Typed version of `useToolInfo` that provides autocomplete for tool names\n * and type inference for inputs, outputs, and responseMetadata.\n *\n * @typeParam K - The name of the tool. Autocompletes based on your app's tool registry.\n * @returns A discriminated union with `status: \"pending\" | \"success\"` that narrows correctly.\n *\n * @example\n * ```typescript\n * const toolInfo = useToolInfo<\"search-trip\">();\n * // toolInfo.input is typed as { destination: string; ... }\n * // toolInfo.output is typed as { results: Array<...>; ... }\n * // toolInfo.responseMetadata is typed based on _meta in callback return\n * // toolInfo.status narrows correctly: \"pending\" | \"success\"\n *\n * if (toolInfo.isPending) {\n * // TypeScript knows output and responseMetadata are undefined here\n * console.log(toolInfo.input.destination);\n * }\n *\n * if (toolInfo.isSuccess) {\n * // TypeScript knows output and responseMetadata are defined here\n * console.log(toolInfo.output.results);\n * console.log(toolInfo.responseMetadata);\n * }\n * ```\n */\n useToolInfo: <ToolName extends ToolNames>(): TypedToolInfoReturn<\n ToolInput<AppType, ToolName>,\n ToolOutput<AppType, ToolName>,\n ToolResponseMetadata<AppType, ToolName>\n > => {\n return useToolInfo() as TypedToolInfoReturn<\n ToolInput<AppType, ToolName>,\n ToolOutput<AppType, ToolName>,\n ToolResponseMetadata<AppType, ToolName>\n >;\n },\n };\n}\n"]}
@@ -0,0 +1 @@
1
+ export {};