skybridge 0.0.0-dev.fe84ef2 → 0.0.0-dev.fe9bc33

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 (368) hide show
  1. package/LICENSE +21 -674
  2. package/README.md +91 -353
  3. package/bin/run.js +5 -0
  4. package/dist/cli/detect-port.d.ts +18 -0
  5. package/dist/cli/detect-port.js +61 -0
  6. package/dist/cli/detect-port.js.map +1 -0
  7. package/dist/cli/header.d.ts +4 -0
  8. package/dist/cli/header.js +6 -0
  9. package/dist/cli/header.js.map +1 -0
  10. package/dist/cli/run-command.d.ts +2 -0
  11. package/dist/cli/run-command.js +43 -0
  12. package/dist/cli/run-command.js.map +1 -0
  13. package/dist/cli/telemetry.d.ts +7 -0
  14. package/dist/cli/telemetry.js +123 -0
  15. package/dist/cli/telemetry.js.map +1 -0
  16. package/dist/cli/types.d.ts +5 -0
  17. package/dist/cli/types.js +2 -0
  18. package/dist/cli/types.js.map +1 -0
  19. package/dist/cli/use-execute-steps.d.ts +11 -0
  20. package/dist/cli/use-execute-steps.js +36 -0
  21. package/dist/cli/use-execute-steps.js.map +1 -0
  22. package/dist/cli/use-nodemon.d.ts +2 -0
  23. package/dist/cli/use-nodemon.js +80 -0
  24. package/dist/cli/use-nodemon.js.map +1 -0
  25. package/dist/cli/use-tunnel.d.ts +8 -0
  26. package/dist/cli/use-tunnel.js +101 -0
  27. package/dist/cli/use-tunnel.js.map +1 -0
  28. package/dist/cli/use-typescript-check.d.ts +8 -0
  29. package/dist/cli/use-typescript-check.js +59 -0
  30. package/dist/cli/use-typescript-check.js.map +1 -0
  31. package/dist/commands/build.d.ts +9 -0
  32. package/dist/commands/build.js +46 -0
  33. package/dist/commands/build.js.map +1 -0
  34. package/dist/commands/dev.d.ts +10 -0
  35. package/dist/commands/dev.js +44 -0
  36. package/dist/commands/dev.js.map +1 -0
  37. package/dist/commands/start.d.ts +9 -0
  38. package/dist/commands/start.js +52 -0
  39. package/dist/commands/start.js.map +1 -0
  40. package/dist/commands/telemetry/disable.d.ts +5 -0
  41. package/dist/commands/telemetry/disable.js +14 -0
  42. package/dist/commands/telemetry/disable.js.map +1 -0
  43. package/dist/commands/telemetry/enable.d.ts +5 -0
  44. package/dist/commands/telemetry/enable.js +14 -0
  45. package/dist/commands/telemetry/enable.js.map +1 -0
  46. package/dist/commands/telemetry/status.d.ts +5 -0
  47. package/dist/commands/telemetry/status.js +14 -0
  48. package/dist/commands/telemetry/status.js.map +1 -0
  49. package/dist/server/asset-base-url-transform-plugin.d.ts +10 -0
  50. package/dist/server/asset-base-url-transform-plugin.js +33 -0
  51. package/dist/server/asset-base-url-transform-plugin.js.map +1 -0
  52. package/dist/server/asset-base-url-transform-plugin.test.js +55 -0
  53. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -0
  54. package/dist/server/express.d.ts +15 -0
  55. package/dist/server/express.js +77 -0
  56. package/dist/server/express.js.map +1 -0
  57. package/dist/server/express.test.js +252 -0
  58. package/dist/server/express.test.js.map +1 -0
  59. package/dist/server/index.d.ts +5 -0
  60. package/dist/server/index.js.map +1 -0
  61. package/dist/{src/server → server}/inferUtilityTypes.d.ts +10 -0
  62. package/dist/server/inferUtilityTypes.js.map +1 -0
  63. package/dist/server/metric.d.ts +14 -0
  64. package/dist/server/metric.js +62 -0
  65. package/dist/server/metric.js.map +1 -0
  66. package/dist/server/middleware.d.ts +124 -0
  67. package/dist/server/middleware.js +93 -0
  68. package/dist/server/middleware.js.map +1 -0
  69. package/dist/server/middleware.test-d.js +75 -0
  70. package/dist/server/middleware.test-d.js.map +1 -0
  71. package/dist/server/middleware.test.js +490 -0
  72. package/dist/server/middleware.test.js.map +1 -0
  73. package/dist/server/server.d.ts +150 -0
  74. package/dist/server/server.js +302 -0
  75. package/dist/server/server.js.map +1 -0
  76. package/dist/{src/server → server}/templateHelper.d.ts +3 -0
  77. package/dist/{src/server → server}/templateHelper.js +5 -4
  78. package/dist/server/templateHelper.js.map +1 -0
  79. package/dist/server/templates/development.hbs +12 -0
  80. package/dist/{src/server → server}/templates/production.hbs +1 -1
  81. package/dist/{src/server → server}/widgetsDevServer.d.ts +3 -2
  82. package/dist/{src/server → server}/widgetsDevServer.js +20 -7
  83. package/dist/server/widgetsDevServer.js.map +1 -0
  84. package/dist/{src/test → test}/utils.d.ts +54 -8
  85. package/dist/{src/test → test}/utils.js +86 -8
  86. package/dist/test/utils.js.map +1 -0
  87. package/dist/test/widget.test.js +303 -0
  88. package/dist/test/widget.test.js.map +1 -0
  89. package/dist/version.d.ts +1 -0
  90. package/dist/version.js +5 -0
  91. package/dist/version.js.map +1 -0
  92. package/dist/web/bridges/apps-sdk/adaptor.d.ts +22 -0
  93. package/dist/web/bridges/apps-sdk/adaptor.js +75 -0
  94. package/dist/web/bridges/apps-sdk/adaptor.js.map +1 -0
  95. package/dist/web/bridges/apps-sdk/bridge.d.ts +10 -0
  96. package/dist/web/bridges/apps-sdk/bridge.js +46 -0
  97. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -0
  98. package/dist/web/bridges/apps-sdk/index.d.ts +5 -0
  99. package/dist/web/bridges/apps-sdk/index.js +5 -0
  100. package/dist/web/bridges/apps-sdk/index.js.map +1 -0
  101. package/dist/{src/web → web/bridges/apps-sdk}/types.d.ts +37 -49
  102. package/dist/{src/web → web/bridges/apps-sdk}/types.js +0 -1
  103. package/dist/web/bridges/apps-sdk/types.js.map +1 -0
  104. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +2 -0
  105. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +7 -0
  106. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -0
  107. package/dist/web/bridges/get-adaptor.d.ts +2 -0
  108. package/dist/web/bridges/get-adaptor.js +8 -0
  109. package/dist/web/bridges/get-adaptor.js.map +1 -0
  110. package/dist/web/bridges/index.d.ts +5 -0
  111. package/dist/web/bridges/index.js +6 -0
  112. package/dist/web/bridges/index.js.map +1 -0
  113. package/dist/web/bridges/mcp-app/adaptor.d.ts +42 -0
  114. package/dist/web/bridges/mcp-app/adaptor.js +262 -0
  115. package/dist/web/bridges/mcp-app/adaptor.js.map +1 -0
  116. package/dist/web/bridges/mcp-app/bridge.d.ts +26 -0
  117. package/dist/web/bridges/mcp-app/bridge.js +102 -0
  118. package/dist/web/bridges/mcp-app/bridge.js.map +1 -0
  119. package/dist/web/bridges/mcp-app/index.d.ts +4 -0
  120. package/dist/web/bridges/mcp-app/index.js +4 -0
  121. package/dist/web/bridges/mcp-app/index.js.map +1 -0
  122. package/dist/web/bridges/mcp-app/types.d.ts +8 -0
  123. package/dist/web/bridges/mcp-app/types.js +2 -0
  124. package/dist/web/bridges/mcp-app/types.js.map +1 -0
  125. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +7 -0
  126. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +7 -0
  127. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -0
  128. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js +26 -0
  129. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -0
  130. package/dist/web/bridges/types.d.ts +103 -0
  131. package/dist/web/bridges/types.js +2 -0
  132. package/dist/web/bridges/types.js.map +1 -0
  133. package/dist/web/bridges/use-host-context.d.ts +2 -0
  134. package/dist/web/bridges/use-host-context.js +8 -0
  135. package/dist/web/bridges/use-host-context.js.map +1 -0
  136. package/dist/web/components/modal-provider.d.ts +4 -0
  137. package/dist/web/components/modal-provider.js +45 -0
  138. package/dist/web/components/modal-provider.js.map +1 -0
  139. package/dist/web/create-store.js +38 -0
  140. package/dist/web/create-store.js.map +1 -0
  141. package/dist/web/create-store.test.js +131 -0
  142. package/dist/web/create-store.test.js.map +1 -0
  143. package/dist/{src/web → web}/data-llm.js +11 -7
  144. package/dist/web/data-llm.js.map +1 -0
  145. package/dist/web/data-llm.test.js +142 -0
  146. package/dist/web/data-llm.test.js.map +1 -0
  147. package/dist/{src/web → web}/generate-helpers.d.ts +11 -8
  148. package/dist/{src/web → web}/generate-helpers.js +5 -3
  149. package/dist/web/generate-helpers.js.map +1 -0
  150. package/dist/{src/web → web}/generate-helpers.test-d.js +59 -3
  151. package/dist/web/generate-helpers.test-d.js.map +1 -0
  152. package/dist/{src/web → web}/generate-helpers.test.js +1 -1
  153. package/dist/web/generate-helpers.test.js.map +1 -0
  154. package/dist/{src/web → web}/helpers/state.d.ts +3 -1
  155. package/dist/web/helpers/state.js +45 -0
  156. package/dist/web/helpers/state.js.map +1 -0
  157. package/dist/web/helpers/state.test.js +53 -0
  158. package/dist/web/helpers/state.test.js.map +1 -0
  159. package/dist/web/hooks/index.d.ts +11 -0
  160. package/dist/{src/web → web}/hooks/index.js +3 -4
  161. package/dist/web/hooks/index.js.map +1 -0
  162. package/dist/web/hooks/test/utils.d.ts +16 -0
  163. package/dist/web/hooks/test/utils.js +64 -0
  164. package/dist/web/hooks/test/utils.js.map +1 -0
  165. package/dist/{src/web → web}/hooks/use-call-tool.d.ts +3 -2
  166. package/dist/{src/web → web}/hooks/use-call-tool.js +12 -4
  167. package/dist/web/hooks/use-call-tool.js.map +1 -0
  168. package/dist/{src/web → web}/hooks/use-call-tool.test-d.js +1 -1
  169. package/dist/web/hooks/use-call-tool.test-d.js.map +1 -0
  170. package/dist/{src/web → web}/hooks/use-call-tool.test.js +35 -16
  171. package/dist/web/hooks/use-call-tool.test.js.map +1 -0
  172. package/dist/web/hooks/use-display-mode.d.ts +4 -0
  173. package/dist/web/hooks/use-display-mode.js +9 -0
  174. package/dist/web/hooks/use-display-mode.js.map +1 -0
  175. package/dist/web/hooks/use-display-mode.test-d.js +8 -0
  176. package/dist/web/hooks/use-display-mode.test-d.js.map +1 -0
  177. package/dist/{src/web → web}/hooks/use-display-mode.test.js +3 -2
  178. package/dist/web/hooks/use-display-mode.test.js.map +1 -0
  179. package/dist/web/hooks/use-files.d.ts +6 -0
  180. package/dist/web/hooks/use-files.js +9 -0
  181. package/dist/web/hooks/use-files.js.map +1 -0
  182. package/dist/{src/web → web}/hooks/use-files.test.js +11 -6
  183. package/dist/web/hooks/use-files.test.js.map +1 -0
  184. package/dist/web/hooks/use-layout.d.ts +22 -0
  185. package/dist/web/hooks/use-layout.js +23 -0
  186. package/dist/web/hooks/use-layout.js.map +1 -0
  187. package/dist/web/hooks/use-layout.test.js +96 -0
  188. package/dist/web/hooks/use-layout.test.js.map +1 -0
  189. package/dist/web/hooks/use-open-external.d.ts +3 -0
  190. package/dist/web/hooks/use-open-external.js +8 -0
  191. package/dist/web/hooks/use-open-external.js.map +1 -0
  192. package/dist/web/hooks/use-open-external.test.js +65 -0
  193. package/dist/web/hooks/use-open-external.test.js.map +1 -0
  194. package/dist/web/hooks/use-request-modal.d.ts +9 -0
  195. package/dist/web/hooks/use-request-modal.js +16 -0
  196. package/dist/web/hooks/use-request-modal.js.map +1 -0
  197. package/dist/web/hooks/use-request-modal.test.d.ts +1 -0
  198. package/dist/web/hooks/use-request-modal.test.js +61 -0
  199. package/dist/web/hooks/use-request-modal.test.js.map +1 -0
  200. package/dist/web/hooks/use-send-follow-up-message.js +8 -0
  201. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -0
  202. package/dist/web/hooks/use-set-open-in-app-url.d.ts +1 -0
  203. package/dist/web/hooks/use-set-open-in-app-url.js +8 -0
  204. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -0
  205. package/dist/web/hooks/use-set-open-in-app-url.test.d.ts +1 -0
  206. package/dist/web/hooks/use-set-open-in-app-url.test.js +43 -0
  207. package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -0
  208. package/dist/{src/web → web}/hooks/use-tool-info.d.ts +13 -2
  209. package/dist/web/hooks/use-tool-info.js +26 -0
  210. package/dist/web/hooks/use-tool-info.js.map +1 -0
  211. package/dist/web/hooks/use-tool-info.test-d.d.ts +1 -0
  212. package/dist/{src/web → web}/hooks/use-tool-info.test-d.js +40 -5
  213. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -0
  214. package/dist/web/hooks/use-tool-info.test.d.ts +1 -0
  215. package/dist/web/hooks/use-tool-info.test.js +130 -0
  216. package/dist/web/hooks/use-tool-info.test.js.map +1 -0
  217. package/dist/web/hooks/use-user.d.ts +18 -0
  218. package/dist/web/hooks/use-user.js +35 -0
  219. package/dist/web/hooks/use-user.js.map +1 -0
  220. package/dist/web/hooks/use-user.test.d.ts +1 -0
  221. package/dist/web/hooks/use-user.test.js +122 -0
  222. package/dist/web/hooks/use-user.test.js.map +1 -0
  223. package/dist/{src/web → web}/hooks/use-widget-state.js +11 -11
  224. package/dist/web/hooks/use-widget-state.js.map +1 -0
  225. package/dist/web/hooks/use-widget-state.test.d.ts +1 -0
  226. package/dist/web/hooks/use-widget-state.test.js +177 -0
  227. package/dist/web/hooks/use-widget-state.test.js.map +1 -0
  228. package/dist/{src/web → web}/index.d.ts +5 -4
  229. package/dist/{src/web → web}/index.js +5 -4
  230. package/dist/web/index.js.map +1 -0
  231. package/dist/{src/web → web}/mount-widget.js +9 -1
  232. package/dist/web/mount-widget.js.map +1 -0
  233. package/dist/web/plugin/data-llm.test.d.ts +1 -0
  234. package/dist/web/plugin/data-llm.test.js.map +1 -0
  235. package/dist/web/plugin/plugin.js +54 -0
  236. package/dist/web/plugin/plugin.js.map +1 -0
  237. package/dist/{src/web → web}/plugin/transform-data-llm.js +7 -4
  238. package/dist/web/plugin/transform-data-llm.js.map +1 -0
  239. package/dist/web/plugin/transform-data-llm.test.d.ts +1 -0
  240. package/dist/web/plugin/transform-data-llm.test.js.map +1 -0
  241. package/dist/web/plugin/validate-widget.d.ts +5 -0
  242. package/dist/web/plugin/validate-widget.js +27 -0
  243. package/dist/web/plugin/validate-widget.js.map +1 -0
  244. package/dist/web/plugin/validate-widget.test.d.ts +1 -0
  245. package/dist/web/plugin/validate-widget.test.js +42 -0
  246. package/dist/web/plugin/validate-widget.test.js.map +1 -0
  247. package/dist/{src/web → web}/proxy.js +6 -2
  248. package/dist/web/proxy.js.map +1 -0
  249. package/dist/web/types.d.ts +16 -0
  250. package/dist/web/types.js +2 -0
  251. package/dist/web/types.js.map +1 -0
  252. package/package.json +70 -38
  253. package/tsconfig.base.json +31 -0
  254. package/dist/src/server/index.d.ts +0 -4
  255. package/dist/src/server/index.js.map +0 -1
  256. package/dist/src/server/inferUtilityTypes.js.map +0 -1
  257. package/dist/src/server/server.d.ts +0 -48
  258. package/dist/src/server/server.js +0 -62
  259. package/dist/src/server/server.js.map +0 -1
  260. package/dist/src/server/templateHelper.js.map +0 -1
  261. package/dist/src/server/templates/development.hbs +0 -12
  262. package/dist/src/server/widgetsDevServer.js.map +0 -1
  263. package/dist/src/test/utils.js.map +0 -1
  264. package/dist/src/test/widget.test.js +0 -90
  265. package/dist/src/test/widget.test.js.map +0 -1
  266. package/dist/src/web/create-store.js +0 -41
  267. package/dist/src/web/create-store.js.map +0 -1
  268. package/dist/src/web/data-llm.js.map +0 -1
  269. package/dist/src/web/data-llm.test.js +0 -76
  270. package/dist/src/web/data-llm.test.js.map +0 -1
  271. package/dist/src/web/generate-helpers.js.map +0 -1
  272. package/dist/src/web/generate-helpers.test-d.js.map +0 -1
  273. package/dist/src/web/generate-helpers.test.js.map +0 -1
  274. package/dist/src/web/helpers/state.js +0 -37
  275. package/dist/src/web/helpers/state.js.map +0 -1
  276. package/dist/src/web/hooks/index.d.ts +0 -12
  277. package/dist/src/web/hooks/index.js.map +0 -1
  278. package/dist/src/web/hooks/use-call-tool.js.map +0 -1
  279. package/dist/src/web/hooks/use-call-tool.test-d.js.map +0 -1
  280. package/dist/src/web/hooks/use-call-tool.test.js.map +0 -1
  281. package/dist/src/web/hooks/use-display-mode.d.ts +0 -4
  282. package/dist/src/web/hooks/use-display-mode.js +0 -7
  283. package/dist/src/web/hooks/use-display-mode.js.map +0 -1
  284. package/dist/src/web/hooks/use-display-mode.test.js.map +0 -1
  285. package/dist/src/web/hooks/use-files.d.ts +0 -10
  286. package/dist/src/web/hooks/use-files.js +0 -7
  287. package/dist/src/web/hooks/use-files.js.map +0 -1
  288. package/dist/src/web/hooks/use-files.test.js.map +0 -1
  289. package/dist/src/web/hooks/use-locale.d.ts +0 -1
  290. package/dist/src/web/hooks/use-locale.js +0 -5
  291. package/dist/src/web/hooks/use-locale.js.map +0 -1
  292. package/dist/src/web/hooks/use-locale.test.js +0 -21
  293. package/dist/src/web/hooks/use-locale.test.js.map +0 -1
  294. package/dist/src/web/hooks/use-open-external.d.ts +0 -1
  295. package/dist/src/web/hooks/use-open-external.js +0 -6
  296. package/dist/src/web/hooks/use-open-external.js.map +0 -1
  297. package/dist/src/web/hooks/use-open-external.test.js +0 -24
  298. package/dist/src/web/hooks/use-open-external.test.js.map +0 -1
  299. package/dist/src/web/hooks/use-openai-global.d.ts +0 -2
  300. package/dist/src/web/hooks/use-openai-global.js +0 -23
  301. package/dist/src/web/hooks/use-openai-global.js.map +0 -1
  302. package/dist/src/web/hooks/use-request-modal.d.ts +0 -6
  303. package/dist/src/web/hooks/use-request-modal.js +0 -9
  304. package/dist/src/web/hooks/use-request-modal.js.map +0 -1
  305. package/dist/src/web/hooks/use-request-modal.test.js +0 -24
  306. package/dist/src/web/hooks/use-request-modal.test.js.map +0 -1
  307. package/dist/src/web/hooks/use-send-follow-up-message.js +0 -11
  308. package/dist/src/web/hooks/use-send-follow-up-message.js.map +0 -1
  309. package/dist/src/web/hooks/use-theme.d.ts +0 -1
  310. package/dist/src/web/hooks/use-theme.js +0 -5
  311. package/dist/src/web/hooks/use-theme.js.map +0 -1
  312. package/dist/src/web/hooks/use-theme.test.js +0 -26
  313. package/dist/src/web/hooks/use-theme.test.js.map +0 -1
  314. package/dist/src/web/hooks/use-tool-info.js +0 -22
  315. package/dist/src/web/hooks/use-tool-info.js.map +0 -1
  316. package/dist/src/web/hooks/use-tool-info.test-d.js.map +0 -1
  317. package/dist/src/web/hooks/use-tool-info.test.js +0 -59
  318. package/dist/src/web/hooks/use-tool-info.test.js.map +0 -1
  319. package/dist/src/web/hooks/use-user-agent.d.ts +0 -1
  320. package/dist/src/web/hooks/use-user-agent.js +0 -5
  321. package/dist/src/web/hooks/use-user-agent.js.map +0 -1
  322. package/dist/src/web/hooks/use-user-agent.test.js +0 -31
  323. package/dist/src/web/hooks/use-user-agent.test.js.map +0 -1
  324. package/dist/src/web/hooks/use-widget-state.js.map +0 -1
  325. package/dist/src/web/hooks/use-widget-state.test.js +0 -60
  326. package/dist/src/web/hooks/use-widget-state.test.js.map +0 -1
  327. package/dist/src/web/index.js.map +0 -1
  328. package/dist/src/web/mount-widget.js.map +0 -1
  329. package/dist/src/web/plugin/data-llm.test.js.map +0 -1
  330. package/dist/src/web/plugin/plugin.js +0 -33
  331. package/dist/src/web/plugin/plugin.js.map +0 -1
  332. package/dist/src/web/plugin/transform-data-llm.js.map +0 -1
  333. package/dist/src/web/plugin/transform-data-llm.test.js.map +0 -1
  334. package/dist/src/web/proxy.js.map +0 -1
  335. package/dist/src/web/types.js.map +0 -1
  336. package/dist/vitest.config.d.ts +0 -2
  337. package/dist/vitest.config.js +0 -8
  338. package/dist/vitest.config.js.map +0 -1
  339. /package/dist/{src/test/widget.test.d.ts → server/asset-base-url-transform-plugin.test.d.ts} +0 -0
  340. /package/dist/{src/web/data-llm.test.d.ts → server/express.test.d.ts} +0 -0
  341. /package/dist/{src/server → server}/index.js +0 -0
  342. /package/dist/{src/server → server}/inferUtilityTypes.js +0 -0
  343. /package/dist/{src/web/generate-helpers.test-d.d.ts → server/middleware.test-d.d.ts} +0 -0
  344. /package/dist/{src/web/generate-helpers.test.d.ts → server/middleware.test.d.ts} +0 -0
  345. /package/dist/{src/web/hooks/use-call-tool.test-d.d.ts → test/widget.test.d.ts} +0 -0
  346. /package/dist/{src/web/hooks/use-call-tool.test.d.ts → web/bridges/mcp-app/use-mcp-app-context.test.d.ts} +0 -0
  347. /package/dist/{src/web → web}/create-store.d.ts +0 -0
  348. /package/dist/{src/web/hooks/use-display-mode.test.d.ts → web/create-store.test.d.ts} +0 -0
  349. /package/dist/{src/web → web}/data-llm.d.ts +0 -0
  350. /package/dist/{src/web/plugin → web}/data-llm.test.d.ts +0 -0
  351. /package/dist/{src/web/hooks/use-files.test.d.ts → web/generate-helpers.test-d.d.ts} +0 -0
  352. /package/dist/{src/web/hooks/use-locale.test.d.ts → web/generate-helpers.test.d.ts} +0 -0
  353. /package/dist/{src/web/hooks/use-open-external.test.d.ts → web/helpers/state.test.d.ts} +0 -0
  354. /package/dist/{src/web/hooks/use-request-modal.test.d.ts → web/hooks/use-call-tool.test-d.d.ts} +0 -0
  355. /package/dist/{src/web/hooks/use-theme.test.d.ts → web/hooks/use-call-tool.test.d.ts} +0 -0
  356. /package/dist/{src/web/hooks/use-tool-info.test-d.d.ts → web/hooks/use-display-mode.test-d.d.ts} +0 -0
  357. /package/dist/{src/web/hooks/use-tool-info.test.d.ts → web/hooks/use-display-mode.test.d.ts} +0 -0
  358. /package/dist/{src/web/hooks/use-user-agent.test.d.ts → web/hooks/use-files.test.d.ts} +0 -0
  359. /package/dist/{src/web/hooks/use-widget-state.test.d.ts → web/hooks/use-layout.test.d.ts} +0 -0
  360. /package/dist/{src/web/plugin/transform-data-llm.test.d.ts → web/hooks/use-open-external.test.d.ts} +0 -0
  361. /package/dist/{src/web → web}/hooks/use-send-follow-up-message.d.ts +0 -0
  362. /package/dist/{src/web → web}/hooks/use-widget-state.d.ts +0 -0
  363. /package/dist/{src/web → web}/mount-widget.d.ts +0 -0
  364. /package/dist/{src/web → web}/plugin/data-llm.test.js +0 -0
  365. /package/dist/{src/web → web}/plugin/plugin.d.ts +0 -0
  366. /package/dist/{src/web → web}/plugin/transform-data-llm.d.ts +0 -0
  367. /package/dist/{src/web → web}/plugin/transform-data-llm.test.js +0 -0
  368. /package/dist/{src/web → web}/proxy.d.ts +0 -0
package/README.md CHANGED
@@ -1,415 +1,153 @@
1
1
  <div align="center">
2
2
 
3
- # Skybridge
3
+ <img alt="Skybridge" src="https://raw.githubusercontent.com/alpic-ai/skybridge/main/docs/images/github-banner.png" width="100%">
4
4
 
5
- **Skybridge is the TypeScript framework for building ChatGPT apps**
5
+ <br />
6
6
 
7
- [![By Alpic](https://img.shields.io/badge/Made%20by%20Alpic-f6ffed?logo=alpic)](https://alpic.ai)
7
+ **Build ChatGPT & MCP Apps. The Modern TypeScript Way.**
8
8
 
9
- ![NPM Downloads](https://img.shields.io/npm/dm/skybridge?color=e90060)
10
- ![NPM Version](https://img.shields.io/npm/v/skybridge?color=e90060)
11
- ![GitHub License](https://img.shields.io/github/license/alpic-ai/skybridge?color=e90060)
9
+ The fullstack TypeScript framework for AI-embedded widgets.<br />
10
+ **Type-safe. React-powered. Platform-agnostic.**
12
11
 
13
- </div>
14
-
15
- Skybridge comes with 2 packages:
16
-
17
- - `skybridge/server`: A drop-in replacement of the `@modelcontextprotocol/sdk` official `McpServer` class with extra features for widget development.
18
- - `skybridge/web`: A react library with hooks and components to build widgets on the underlying _OpenAI iFrame skybridge_ runtime.
19
-
20
- ## Quick start
12
+ <br />
21
13
 
22
- To get started in less than a minute, you can [create a new repository](https://github.com/new?template_name=apps-sdk-template&template_owner=alpic-ai) using our [ChatGPT SDK template](https://github.com/alpic-ai/apps-sdk-template). This template includes a basic setup for both the server and the widgets.
14
+ [![NPM Version](https://img.shields.io/npm/v/skybridge?color=e90060&style=for-the-badge)](https://www.npmjs.com/package/skybridge)
15
+ [![NPM Downloads](https://img.shields.io/npm/dm/skybridge?color=e90060&style=for-the-badge)](https://www.npmjs.com/package/skybridge)
16
+ [![GitHub License](https://img.shields.io/github/license/alpic-ai/skybridge?color=e90060&style=for-the-badge)](https://github.com/alpic-ai/skybridge/blob/main/LICENSE)
23
17
 
24
- ## Installation
18
+ <br />
25
19
 
26
- ```bash
27
- pnpm add skybridge
28
- ```
20
+ [Documentation](https://docs.skybridge.tech) · [Quick Start](https://docs.skybridge.tech/quickstart/create-new-app) · [Showcase](https://docs.skybridge.tech/showcase)
29
21
 
30
- ## Concepts
31
-
32
- ### Widgets
33
-
34
- > A widget is a UI component that turns structured tool results into a human-friendly UI. Those are built using React components. They are rendered inside an iframe inline with the conversation on ChatGPT.
35
-
36
- Each widget in your app must have a unique name. The name is used to bridge the tool invocation result with the widget React component.
37
-
38
- For example, in order to register a new widget named `pokemon` on your ChatGPT app. You should have the following file structure and file contents:
39
-
40
- _Project structure_
22
+ </div>
41
23
 
42
- ```
43
- server/
44
- └── src/
45
- └── index.ts // Register the widget with McpServer.widget()
46
- web/
47
- └── src/
48
- └── widgets/
49
- └── pokemon.tsx // Use the same widget name as the file name
50
- ```
24
+ <br />
51
25
 
52
- _server/src/index.ts_
26
+ ## ✨ Why Skybridge?
53
27
 
54
- ```ts
55
- import { McpServer } from "skybridge/server";
28
+ ChatGPT Apps and MCP Apps let you embed **rich, interactive UIs** directly in AI conversations. But the raw SDKs are low-level—no hooks, no type safety, no dev tools, and no HMR.
56
29
 
57
- const server = new McpServer();
30
+ **Skybridge fixes that.**
58
31
 
59
- server.widget(
60
- "pokemon"
61
- // Remaining arguments...
62
- );
63
- ```
32
+ | | |
33
+ |:--|:--|
34
+ | 🌐 **Write once, run everywhere** — Skybridge works seamlessly with ChatGPT (Apps SDK) and MCP-compatible clients. | ✅ **End-to-End Type Safety** — tRPC-style inference from server to widget. Autocomplete everywhere. |
35
+ | 🔄 **Widget-to-Model Sync** — Keep the model aware of UI state with `data-llm`. Dual surfaces, one source of truth. | ⚒️ **React Query-style Hooks** — `isPending`, `isError`, callbacks. State management you already know. |
36
+ | 👨‍💻 **Full dev environment** — HMR, debug traces, and local devtools. | 📦 **Showcase Examples** — Production-ready examples to learn from and build upon. |
64
37
 
65
- _web/src/widgets/pokemon.tsx_
38
+ <br />
66
39
 
67
- ```ts
68
- import { mountWidget } from "skybridge/web";
40
+ ## 🚀 Get Started
69
41
 
70
- const Pokemon: React.FunctionComponent = () => {
71
- // Your React component code goes here...
72
- };
42
+ **Create a new app:**
73
43
 
74
- mountWidget(<Pokemon />);
44
+ ```bash
45
+ npm create skybridge@latest
75
46
  ```
76
47
 
77
- ## Packages
78
-
79
- ### skybridge/server
80
-
81
- The `skybridge/server` package is a drop-in replacement of the `@modelcontextprotocol/sdk` official `McpServer` class with extra features for widget development. If you're already using the `@modelcontextprotocol/sdk`, you can simply replace your `McpServer` import with `skybridge/server` and you're good to go.
82
-
83
- ### skybridge/web
84
-
85
- The `skybridge/web` package is a react library with hooks and components to build widgets on the underlying _OpenAI iFrame skybridge_ runtime.
86
-
87
- **Vite plugin**
88
-
89
- The `skybridge/web` package comes with a Vite plugin that allows you to build your widgets as regular Vite apps.
48
+ **Or add to an existing project:**
90
49
 
91
- ```ts
92
- import { defineConfig } from "vite";
93
- import { skybridge } from "skybridge/web";
94
-
95
- export default defineConfig({
96
- plugins: [skybridge()],
97
- });
50
+ ```bash
51
+ npm i skybridge
52
+ yarn add skybridge
53
+ pnpm add skybridge
54
+ bun add skybridge
55
+ deno add skybridge
98
56
  ```
99
57
 
100
- **Typed Hooks**
58
+ <div align="center">
101
59
 
102
- Skybridge provides fully typed hooks that give you autocomplete for tool names and type inference for inputs/outputs - similar to tRPC. This is opt-in and requires exporting your server type.
60
+ **👉 [Read the Docs](https://docs.skybridge.tech) 👈**
103
61
 
104
- > **Tip:** For the best TypeScript experience, use typed hooks throughout your application. They provide autocomplete, type safety, and better IDE support.
62
+ </div>
105
63
 
106
- > **Important:** For `generateHelpers` to work correctly, your MCP server must be defined using method chaining (e.g., `server.widget(...).widget(...).registerTool(...)`). This ensures TypeScript can properly infer the tool registry type from the chained calls.
64
+ <br />
107
65
 
108
- **Examples:**
66
+ ## 📦 Architecture
109
67
 
110
- **Works** - Using method chaining:
68
+ Skybridge is a fullstack framework with unified server and client modules:
111
69
 
112
- ```ts
113
- import { McpServer } from "skybridge/server";
114
- import { z } from "zod";
115
-
116
- const server = new McpServer({ name: "my-app", version: "1.0" }, {})
117
- .widget("search-voyage", {}, {
118
- inputSchema: { destination: z.string() },
119
- }, async ({ destination }) => {
120
- return { content: [{ type: "text", text: `Found trips to ${destination}` }] };
121
- })
122
- .registerTool("calculate-price", {
123
- inputSchema: { tripId: z.string() },
124
- }, async ({ tripId }) => {
125
- return { content: [{ type: "text", text: `Price for ${tripId}` }] };
126
- });
127
-
128
- export type AppType = typeof server; // ✅ Type inference works correctly
129
- ```
70
+ - **`skybridge/server`** — Define tools and widgets with full type inference. Extends the MCP SDK.
71
+ - **`skybridge/web`** React hooks that consume your server types. Works with Apps SDK (ChatGPT) and MCP Apps.
72
+ - **Dev Environment** Vite plugin with HMR, DevTools emulator, and optimized builds.
130
73
 
131
- **Doesn't work** - Without method chaining:
74
+ ### Server
132
75
 
133
76
  ```ts
134
77
  import { McpServer } from "skybridge/server";
135
- import { z } from "zod";
136
78
 
137
- const server = new McpServer({ name: "my-app", version: "1.0" }, {});
138
-
139
- server.widget("search-voyage", {}, {
79
+ server.registerWidget("flights", {}, {
140
80
  inputSchema: { destination: z.string() },
141
81
  }, async ({ destination }) => {
142
- return { content: [{ type: "text", text: `Found trips to ${destination}` }] };
143
- });
144
-
145
- server.registerTool("calculate-price", {
146
- inputSchema: { tripId: z.string() },
147
- }, async ({ tripId }) => {
148
- return { content: [{ type: "text", text: `Price for ${tripId}` }] };
82
+ const flights = await searchFlights(destination);
83
+ return { structuredContent: { flights } };
149
84
  });
150
-
151
- export type AppType = typeof server; // ❌ Type inference fails - tool registry is empty
152
- ```
153
-
154
- _Server setup (server/src/index.ts)_
155
-
156
- ```ts
157
- import { McpServer } from "skybridge/server";
158
- import { z } from "zod";
159
-
160
- const server = new McpServer({ name: "my-app", version: "1.0" }, {})
161
- .widget("search-voyage", {}, {
162
- description: "Search for trips",
163
- inputSchema: {
164
- destination: z.string(),
165
- departureDate: z.string().optional(),
166
- },
167
- outputSchema: {
168
- results: z.array(z.object({ id: z.string(), name: z.string() })),
169
- totalCount: z.number(),
170
- },
171
- }, async ({ destination }) => {
172
- // Your tool logic here...
173
- return { content: [{ type: "text", text: `Found trips to ${destination}` }] };
174
- })
175
- .widget("get-details", {}, {
176
- inputSchema: { tripId: z.string() },
177
- }, async ({ tripId }) => {
178
- return { content: [{ type: "text", text: `Details for ${tripId}` }] };
179
- });
180
-
181
- // Export the server type for the client
182
- export type AppType = typeof server;
183
- ```
184
-
185
- _One-time setup (web/src/skybridge.ts)_
186
-
187
- Create typed hooks once and export them for use across your app. This file acts as a bridge between your server types and your widgets:
188
-
189
- ```ts
190
- import type { AppType } from "../server"; // type-only import
191
- import { generateHelpers } from "skybridge/web";
192
-
193
- export const { useCallTool, useToolInfo } = generateHelpers<AppType>();
194
85
  ```
195
86
 
196
- _Usage in widgets (web/src/widgets/search.tsx)_
87
+ ### Widget
197
88
 
198
89
  ```tsx
199
- import { useCallTool, useToolInfo } from "../skybridge"; // import typed hooks
200
-
201
- export function SearchWidget() {
202
- const { callTool, data, isPending } = useCallTool("search-voyage");
203
- // ^ autocomplete for tool names
204
- const toolInfo = useToolInfo<"search-voyage">();
205
- // ^ autocomplete for widget names
206
-
207
- const handleSearch = () => {
208
- callTool({ destination: "Spain" });
209
- // ^ autocomplete for input fields
210
- };
211
-
212
- return (
213
- <div>
214
- <button onClick={handleSearch} disabled={isPending}>
215
- Search
216
- </button>
217
- {toolInfo.isSuccess && (
218
- <div>Found {toolInfo.output.structuredContent.totalCount} results</div>
219
- // ^ typed output
220
- )}
221
- </div>
222
- );
223
- }
224
- ```
225
-
226
- **Hooks**
227
-
228
- The `skybridge/web` package comes with a set of hooks to help you build your widgets :
229
-
230
- - `useOpenAiGlobal`: A generic hook to get any global data from the OpenAI iFrame skybridge runtime (in `window.openai`).
231
- - `useToolOutput`: A hook to get the initial tool `structuredContent` returned when rendering the widget for the first time. The data inside this hook is not updated when the tool is called again.
232
- - `useToolResponseMetadata`: A hook to get the initial tool `meta` returned when rendering the widget for the first time. The data inside this hook is not updated when the tool is called again.
233
- - `useToolInfo`: A hook to get the tool input, output, and response metadata with type inference. Provides a discriminated union based on status (pending/success).
234
- - `useCallTool`: A @tanstack/react-query inspired hook to send make additional tool calls inside a widget.
235
- - `generateHelpers`: A factory that creates typed versions of `useCallTool` and `useToolInfo` with full type inference from your server type.
236
-
237
- _useOpenAiGlobal_
238
-
239
- ```ts
240
- import { useOpenAiGlobal } from "skybridge/web";
241
-
242
- const theme = useOpenAiGlobal("theme");
243
- ```
244
-
245
- _useToolOutput_
246
-
247
- ```ts
248
- import { useToolOutput } from "skybridge/web";
249
-
250
- const toolOutput = useToolOutput();
251
- ```
252
-
253
- _useToolResponseMetadata_
254
-
255
- ```ts
256
- import { useToolResponseMetadata } from "skybridge/web";
257
-
258
- const toolResponseMetadata = useToolResponseMetadata();
259
- ```
260
-
261
- _useToolInfo_
262
-
263
- ```ts
264
90
  import { useToolInfo } from "skybridge/web";
265
91
 
266
- const toolInfo = useToolInfo<{
267
- input: { query: string };
268
- output: { results: string[] };
269
- responseMetadata: { id: number };
270
- }>();
271
-
272
- // toolInfo.input is typed based on the input type
273
- // toolInfo.output.structuredContent is typed based on the output type (undefined when pending)
274
- // toolInfo.status narrows correctly: "pending" | "success"
92
+ function FlightsWidget() {
93
+ const { output } = useToolInfo();
275
94
 
276
- if (toolInfo.isPending) {
277
- // toolInfo.output is undefined here (pending state)
278
- console.log(toolInfo.input.query);
279
- }
280
-
281
- if (toolInfo.isSuccess) {
282
- // toolInfo.output.structuredContent is typed here
283
- console.log(toolInfo.output.structuredContent.results);
95
+ return output.structuredContent.flights.map(flight =>
96
+ <FlightCard key={flight.id} flight={flight} />
97
+ );
284
98
  }
285
99
  ```
286
100
 
287
- _useToolInfo_ with typed hooks (recommended)
101
+ <br />
288
102
 
289
- ```tsx
290
- import { useToolInfo } from "../skybridge"; // import typed hooks
103
+ ## 🎯 Features at a Glance
291
104
 
292
- export function SearchWidget() {
293
- const toolInfo = useToolInfo<"search-voyage">();
294
- // ^ autocomplete for widget names
295
- // toolInfo.input is typed as { destination: string; departureDate?: string; ... }
296
- // toolInfo.output.structuredContent is typed as { results: Array<...>; totalCount: number; }
105
+ - **Live Reload** — Vite HMR. See changes instantly without reinstalling.
106
+ - **Typed Hooks** — Full autocomplete for tools, inputs, outputs.
107
+ - **Widget Tool Calls** — Trigger server actions from UI.
108
+ - **Dual Surface Sync** Keep model aware of what users see with `data-llm`.
109
+ - **React Query-style API** `isPending`, `isError`, callbacks.
110
+ - **Platform Agnostic** — Works with ChatGPT (Apps SDK) and MCP Apps clients (Goose, VSCode, etc.).
111
+ - **MCP Compatible** — Extends the official SDK. Works with any MCP client.
297
112
 
298
- if (toolInfo.isSuccess) {
299
- return <div>Found {toolInfo.output.structuredContent.totalCount} results</div>;
300
- }
113
+ <br />
301
114
 
302
- return <div>Searching for {toolInfo.input.destination}...</div>;
303
- }
304
- ```
115
+ ## 📖 Showcase
305
116
 
306
- _useCallTool_ in synchronous mode
117
+ Explore production-ready examples:
307
118
 
308
- ```ts
309
- import { useCallTool } from "skybridge/web";
310
-
311
- export const TestTool: React.FunctionComponent = () => {
312
- const { callTool, isPending } = useCallTool("myToolName");
313
-
314
- return (
315
- <div>
316
- <button
317
- disabled={isPending}
318
- onClick={() => {
319
- callTool({ input: "test input" }, {
320
- onSuccess: (data) => {
321
- alert("Tool returned: " + data);
322
- },
323
- });
324
- >
325
- Call Tool inside a widget
326
- </button>
327
- </div>
328
- );
329
- };
330
- ```
331
-
332
- _useCallTool_ in asynchronous mode
333
-
334
- ```ts
335
- import { useCallTool } from "skybridge/web";
336
-
337
- export const TestTool: React.FunctionComponent = () => {
338
- const { callToolAsync, isPending } = useCallTool("myToolName");
339
-
340
- return (
341
- <div>
342
- <button
343
- disabled={isPending}
344
- onClick={async () => {
345
- const data = await callToolAsync({ input: "test input" });
346
- alert("Tool returned: " + data);
347
- }}
348
- >
349
- Call Tool inside a widget
350
- </button>
351
- </div>
352
- );
353
- };
354
- ```
119
+ | Example | Description | Demo | Code |
120
+ |------------------------|----------------------------------------------------------------------------------|-----------------------------------------------------|-------------------------------------------------------------------------------------|
121
+ | **Awaze — Cottage Search** | Holiday cottage search and booking experience — browse properties, filter by location, and explore availability | [Try Demo](https://mcp.cottages.com/try) | — |
122
+ | **Capitals Explorer** | Interactive world map with geolocation and Wikipedia integration | [Try Demo](https://capitals.skybridge.tech/try) | [View Code](https://github.com/alpic-ai/skybridge/tree/main/examples/capitals) |
123
+ | **Ecommerce Carousel** | Product carousel with cart, localization, and modals | [Try Demo](https://ecommerce.skybridge.tech/try) | [View Code](https://github.com/alpic-ai/skybridge/tree/main/examples/ecom-carousel) |
124
+ | **Everything** | Comprehensive playground showcasing all hooks and features | [Try Demo](https://everything.skybridge.tech/try) | [View Code](https://github.com/alpic-ai/skybridge/tree/main/examples/everything) |
125
+ | **Investigation Game** | Interactive murder mystery game with multi-screen gameplay and dynamic story progression | [Try Demo](https://investigation-game.skybridge.tech/try) | [View Code](https://github.com/alpic-ai/skybridge/tree/main/examples/investigation-game) |
126
+ | **Productivity** | Data visualization dashboard demonstrating Skybridge capabilities for MCP Apps | [Try Demo](https://productivity.skybridge.tech/try) | [View Code](https://github.com/alpic-ai/skybridge/tree/main/examples/productivity) |
127
+ | **Time's Up** | Word-guessing party game where the user gives hints and the AI tries to guess the secret word | [Try Demo](https://times-up.skybridge.tech/try) | [View Code](https://github.com/alpic-ai/skybridge/tree/main/examples/times-up) |
128
+ | **Lumo — Interactive AI Tutor** | Adaptive educational tutor with Mermaid.js diagrams, mind maps, quizzes, and fill-in-the-blank exercises | [Try Demo](https://lumo-mcp-app-39519fdd.alpic.live/try) | [View Code](https://github.com/connorads/lumo-mcp-app) |
129
+ | **Auth — Auth0** | Full OAuth authentication with Auth0 and personalized coffee shop search | — | [View Code](https://github.com/alpic-ai/skybridge/tree/main/examples/auth-auth0) |
130
+ | **Auth — Clerk** | Full OAuth authentication with Clerk and personalized coffee shop search | — | [View Code](https://github.com/alpic-ai/skybridge/tree/main/examples/auth-clerk) |
131
+ | **Auth — Stytch** | Full OAuth authentication with Stytch and personalized coffee shop search | — | [View Code](https://github.com/alpic-ai/skybridge/tree/main/examples/auth-stytch) |
132
+ | **Auth WorkOS AuthKit** | Full OAuth authentication with WorkOS AuthKit and personalized coffee shop search | — | [View Code](https://github.com/alpic-ai/skybridge/tree/main/examples/auth-workos) |
133
+ | **Flight Booking** | Flight booking carousel with dynamic search and booking flow | [Try Demo](https://flight-booking.skybridge.tech/try) | [View Code](https://github.com/alpic-ai/skybridge/tree/main/examples/flight-booking) |
134
+ | **Generative UI** | Dynamic UI generation using json-render and Skybridge | [Try Demo](https://generative-ui.skybridge.tech/try) | [View Code](https://github.com/alpic-ai/skybridge/tree/main/examples/generative-ui) |
135
+ | **Manifest Starter** | Starter app with Manifest UI agentic components out-of-the-box | [Try Demo](https://manifest-ui.skybridge.tech/try) | [View Code](https://github.com/alpic-ai/skybridge/tree/main/examples/manifest-ui) |
355
136
 
356
- **State Management**
137
+ See all examples in the [Showcase](https://docs.skybridge.tech/showcase) or browse the [examples/](examples/) directory.
357
138
 
358
- The `skybridge/web` package provides `createStore` for creating Zustand stores with automatic persistence to `window.openai.widgetState`. This is useful when you need more advanced state management than what `useWidgetState` provides.
139
+ <br />
359
140
 
360
- _createStore_
361
-
362
- ```ts
363
- import { createStore } from "skybridge/web";
364
-
365
- type CounterState = {
366
- count: number;
367
- increment: () => void;
368
- decrement: () => void;
369
- };
370
-
371
- const useCounterStore = createStore<CounterState>(
372
- (set) => ({
373
- count: 0,
374
- increment: () => set((state) => ({ count: state.count + 1 })),
375
- decrement: () => set((state) => ({ count: state.count - 1 })),
376
- }),
377
- { count: 0 } // Optional default state
378
- );
379
-
380
- // Use in your component
381
- function CounterWidget() {
382
- const { count, increment, decrement } = useCounterStore();
383
-
384
- return (
385
- <div>
386
- <p>Count: {count}</p>
387
- <button onClick={increment}>Increment</button>
388
- <button onClick={decrement}>Decrement</button>
389
- </div>
390
- );
391
- }
392
- ```
393
-
394
- The `createStore` function:
395
-
396
- - Automatically persists state to `window.openai.widgetState`
397
- - Syncs with external state changes from the host
398
- - Only serializes state data, not methods
141
+ <div align="center">
399
142
 
400
- ## Migrate your existing MCP server to a ChatGPT app
143
+ [![GitHub Discussions](https://img.shields.io/badge/Discussions-Ask%20Questions-blue?style=flat-square&logo=github)](https://github.com/alpic-ai/skybridge/discussions)
144
+ [![GitHub Issues](https://img.shields.io/badge/Issues-Report%20Bugs-red?style=flat-square&logo=github)](https://github.com/alpic-ai/skybridge/issues)
145
+ [![Discord](https://img.shields.io/badge/Discord-Chat-5865F2?style=flat-square&logo=discord&logoColor=white)](https://discord.com/invite/gNAazGueab)
401
146
 
402
- If you're already using the `@modelcontextprotocol/sdk` to build a MCP server, you can migrate to a ChatGPT app by following these steps:
147
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for setup instructions
403
148
 
404
- 1. Replace your `McpServer` import from `@modelcontextprotocol/sdk` with the same import from `skybridge/server`
405
- 2. Create a new vite project in a folder named `web` and install the `skybridge` package
406
- 3. Replace the `vite.config.ts` file with the following:
149
+ <br />
407
150
 
408
- ```ts
409
- import { defineConfig } from "vite";
410
- import { skybridge } from "skybridge/web";
151
+ **[MIT License](LICENSE)** · Made with ❤️ by **[Alpic](https://alpic.ai)**
411
152
 
412
- export default defineConfig({
413
- plugins: [skybridge()],
414
- });
415
- ```
153
+ </div>
package/bin/run.js ADDED
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env node
2
+
3
+ import { execute } from "@oclif/core";
4
+
5
+ await execute({ dir: import.meta.url });
@@ -0,0 +1,18 @@
1
+ export declare function resolvePort(flagPort?: number): Promise<{
2
+ port: number;
3
+ fallback: boolean;
4
+ envWarning?: undefined;
5
+ } | {
6
+ port: number;
7
+ fallback: boolean;
8
+ envWarning: string;
9
+ }>;
10
+ /**
11
+ * Returns the given port if available, otherwise lets the OS
12
+ * pick a free port via `listen(0)`.
13
+ *
14
+ * @param host - Bind address for the check. Pass `"localhost"` for
15
+ * services that bind to 127.0.0.1 (e.g. Vite HMR). Omit for
16
+ * services that bind to all interfaces (e.g. the HTTP server).
17
+ */
18
+ export declare function detectAvailablePort(startPort: number, host?: string): Promise<number>;
@@ -0,0 +1,61 @@
1
+ import net from "node:net";
2
+ const DEFAULT_PORT = 3000;
3
+ export async function resolvePort(flagPort) {
4
+ if (flagPort && flagPort > 1) {
5
+ return { port: flagPort, fallback: false };
6
+ }
7
+ const rawEnv = process.env.PORT;
8
+ if (rawEnv) {
9
+ const parsed = Number(rawEnv);
10
+ if (Number.isInteger(parsed) && parsed > 0) {
11
+ return { port: parsed, fallback: false };
12
+ }
13
+ return {
14
+ port: await detectAvailablePort(DEFAULT_PORT),
15
+ fallback: false,
16
+ envWarning: `Invalid PORT="${rawEnv}", ignoring and using default`,
17
+ };
18
+ }
19
+ const port = await detectAvailablePort(DEFAULT_PORT);
20
+ return { port, fallback: port !== DEFAULT_PORT };
21
+ }
22
+ /**
23
+ * Returns the given port if available, otherwise lets the OS
24
+ * pick a free port via `listen(0)`.
25
+ *
26
+ * @param host - Bind address for the check. Pass `"localhost"` for
27
+ * services that bind to 127.0.0.1 (e.g. Vite HMR). Omit for
28
+ * services that bind to all interfaces (e.g. the HTTP server).
29
+ */
30
+ export async function detectAvailablePort(startPort, host) {
31
+ const available = await isPortAvailable(startPort, host);
32
+ if (available) {
33
+ return startPort;
34
+ }
35
+ return new Promise((resolve, reject) => {
36
+ const server = net.createServer();
37
+ server.once("error", reject);
38
+ server.once("listening", () => {
39
+ const addr = server.address();
40
+ if (addr && typeof addr === "object") {
41
+ const { port } = addr;
42
+ server.close(() => resolve(port));
43
+ }
44
+ else {
45
+ server.close(() => reject(new Error("Failed to detect available port")));
46
+ }
47
+ });
48
+ server.listen(0, host);
49
+ });
50
+ }
51
+ function isPortAvailable(port, host) {
52
+ return new Promise((resolve) => {
53
+ const server = net.createServer();
54
+ server.once("error", () => resolve(false));
55
+ server.once("listening", () => {
56
+ server.close(() => resolve(true));
57
+ });
58
+ server.listen(port, host);
59
+ });
60
+ }
61
+ //# sourceMappingURL=detect-port.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"detect-port.js","sourceRoot":"","sources":["../../src/cli/detect-port.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,UAAU,CAAC;AAE3B,MAAM,YAAY,GAAG,IAAI,CAAC;AAE1B,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,QAAiB;IACjD,IAAI,QAAQ,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QAC7B,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IAC7C,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;IAChC,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QAC9B,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;QAC3C,CAAC;QACD,OAAO;YACL,IAAI,EAAE,MAAM,mBAAmB,CAAC,YAAY,CAAC;YAC7C,QAAQ,EAAE,KAAK;YACf,UAAU,EAAE,iBAAiB,MAAM,+BAA+B;SACnE,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,YAAY,CAAC,CAAC;IACrD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,KAAK,YAAY,EAAE,CAAC;AACnD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,SAAiB,EACjB,IAAa;IAEb,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACzD,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,MAAM,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC;QAElC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE;YAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;YAC9B,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACrC,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;gBACtB,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAChB,MAAM,CAAC,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC,CACrD,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,eAAe,CAAC,IAAY,EAAE,IAAa;IAClD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,MAAM,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC;QAElC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE;YAC5B,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;AACL,CAAC"}
@@ -0,0 +1,4 @@
1
+ export declare const Header: ({ version, children, }: {
2
+ version: string;
3
+ children?: React.ReactNode;
4
+ }) => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,6 @@
1
+ import { jsxs as _jsxs } from "react/jsx-runtime";
2
+ import { Box, Text } from "ink";
3
+ export const Header = ({ version, children, }) => {
4
+ return (_jsxs(Box, { marginBottom: 1, children: [_jsxs(Text, { color: "cyan", bold: true, children: ["\u26F0", " ", "Welcome to Skybridge"] }), _jsxs(Text, { color: "cyan", children: [" v", version] }), children] }));
5
+ };
6
+ //# sourceMappingURL=header.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"header.js","sourceRoot":"","sources":["../../src/cli/header.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,KAAK,CAAC;AAEhC,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,EACrB,OAAO,EACP,QAAQ,GAIT,EAAE,EAAE;IACH,OAAO,CACL,MAAC,GAAG,IAAC,YAAY,EAAE,CAAC,aAClB,MAAC,IAAI,IAAC,KAAK,EAAC,MAAM,EAAC,IAAI,6BACnB,IAAI,4BACD,EACP,MAAC,IAAI,IAAC,KAAK,EAAC,MAAM,mBAAI,OAAO,IAAQ,EACpC,QAAQ,IACL,CACP,CAAC;AACJ,CAAC,CAAC"}
@@ -0,0 +1,2 @@
1
+ import { type SpawnOptions } from "node:child_process";
2
+ export declare function runCommand(command: string, options?: SpawnOptions): Promise<void>;