skybridge 0.0.0-dev.8d4ea94 → 0.0.0-dev.8d9b209

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 (189) hide show
  1. package/dist/src/server/devtoolsStaticServer.d.ts +15 -0
  2. package/dist/src/server/devtoolsStaticServer.js +38 -0
  3. package/dist/src/server/devtoolsStaticServer.js.map +1 -0
  4. package/dist/src/server/index.d.ts +3 -0
  5. package/dist/src/server/index.js +1 -0
  6. package/dist/src/server/index.js.map +1 -1
  7. package/dist/src/server/inferUtilityTypes.d.ts +64 -0
  8. package/dist/src/server/inferUtilityTypes.js +2 -0
  9. package/dist/src/server/inferUtilityTypes.js.map +1 -0
  10. package/dist/src/server/server.d.ts +71 -9
  11. package/dist/src/server/server.js +65 -28
  12. package/dist/src/server/server.js.map +1 -1
  13. package/dist/src/server/templateHelper.d.ts +12 -8
  14. package/dist/src/server/templateHelper.js +5 -12
  15. package/dist/src/server/templateHelper.js.map +1 -1
  16. package/dist/src/server/templates/development.hbs +13 -0
  17. package/dist/src/server/templates/production.hbs +7 -0
  18. package/dist/src/server/widgetsDevServer.js +3 -3
  19. package/dist/src/server/widgetsDevServer.js.map +1 -1
  20. package/dist/src/test/utils.d.ts +108 -1
  21. package/dist/src/test/utils.js +202 -3
  22. package/dist/src/test/utils.js.map +1 -1
  23. package/dist/src/test/widget.test.js +102 -25
  24. package/dist/src/test/widget.test.js.map +1 -1
  25. package/dist/src/web/bridges/apps-sdk-adapter.d.ts +2 -0
  26. package/dist/src/web/bridges/apps-sdk-adapter.js +4 -0
  27. package/dist/src/web/bridges/apps-sdk-adapter.js.map +1 -0
  28. package/dist/src/web/bridges/apps-sdk-bridge.d.ts +8 -0
  29. package/dist/src/web/bridges/apps-sdk-bridge.js +41 -0
  30. package/dist/src/web/bridges/apps-sdk-bridge.js.map +1 -0
  31. package/dist/src/web/bridges/get-bridge-methods.d.ts +2 -0
  32. package/dist/src/web/bridges/get-bridge-methods.js +8 -0
  33. package/dist/src/web/bridges/get-bridge-methods.js.map +1 -0
  34. package/dist/src/web/bridges/hooks/use-apps-sdk-bridge.d.ts +2 -0
  35. package/dist/src/web/bridges/hooks/use-apps-sdk-bridge.js +7 -0
  36. package/dist/src/web/bridges/hooks/use-apps-sdk-bridge.js.map +1 -0
  37. package/dist/src/web/bridges/hooks/use-bridge.d.ts +2 -0
  38. package/dist/src/web/bridges/hooks/use-bridge.js +58 -0
  39. package/dist/src/web/bridges/hooks/use-bridge.js.map +1 -0
  40. package/dist/src/web/bridges/hooks/use-mcp-app-bridge.d.ts +4 -0
  41. package/dist/src/web/bridges/hooks/use-mcp-app-bridge.js +7 -0
  42. package/dist/src/web/bridges/hooks/use-mcp-app-bridge.js.map +1 -0
  43. package/dist/src/web/bridges/hooks/use-mcp-app-bridge.test.js +58 -0
  44. package/dist/src/web/bridges/hooks/use-mcp-app-bridge.test.js.map +1 -0
  45. package/dist/src/web/bridges/index.d.ts +4 -0
  46. package/dist/src/web/bridges/index.js +5 -0
  47. package/dist/src/web/bridges/index.js.map +1 -0
  48. package/dist/src/web/bridges/mcp-app-adapter.d.ts +2 -0
  49. package/dist/src/web/bridges/mcp-app-adapter.js +12 -0
  50. package/dist/src/web/bridges/mcp-app-adapter.js.map +1 -0
  51. package/dist/src/web/bridges/mcp-app-bridge.d.ts +29 -0
  52. package/dist/src/web/bridges/mcp-app-bridge.js +130 -0
  53. package/dist/src/web/bridges/mcp-app-bridge.js.map +1 -0
  54. package/dist/src/web/bridges/types.d.ts +22 -0
  55. package/dist/src/web/bridges/types.js +2 -0
  56. package/dist/src/web/bridges/types.js.map +1 -0
  57. package/dist/src/web/create-store.d.ts +3 -0
  58. package/dist/src/web/create-store.js +25 -0
  59. package/dist/src/web/create-store.js.map +1 -0
  60. package/dist/src/web/create-store.test.d.ts +1 -0
  61. package/dist/src/web/create-store.test.js +70 -0
  62. package/dist/src/web/create-store.test.js.map +1 -0
  63. package/dist/src/web/data-llm.d.ts +14 -0
  64. package/dist/src/web/data-llm.js +68 -0
  65. package/dist/src/web/data-llm.js.map +1 -0
  66. package/dist/src/web/data-llm.test.d.ts +1 -0
  67. package/dist/src/web/data-llm.test.js +76 -0
  68. package/dist/src/web/data-llm.test.js.map +1 -0
  69. package/dist/src/web/generate-helpers.d.ts +115 -0
  70. package/dist/src/web/generate-helpers.js +111 -0
  71. package/dist/src/web/generate-helpers.js.map +1 -0
  72. package/dist/src/web/generate-helpers.test-d.d.ts +1 -0
  73. package/dist/src/web/generate-helpers.test-d.js +206 -0
  74. package/dist/src/web/generate-helpers.test-d.js.map +1 -0
  75. package/dist/src/web/generate-helpers.test.d.ts +1 -0
  76. package/dist/src/web/generate-helpers.test.js +17 -0
  77. package/dist/src/web/generate-helpers.test.js.map +1 -0
  78. package/dist/src/web/helpers/state.d.ts +7 -0
  79. package/dist/src/web/helpers/state.js +40 -0
  80. package/dist/src/web/helpers/state.js.map +1 -0
  81. package/dist/src/web/helpers/state.test.d.ts +1 -0
  82. package/dist/src/web/helpers/state.test.js +53 -0
  83. package/dist/src/web/helpers/state.test.js.map +1 -0
  84. package/dist/src/web/hooks/index.d.ts +11 -0
  85. package/dist/src/web/hooks/index.js +12 -0
  86. package/dist/src/web/hooks/index.js.map +1 -0
  87. package/dist/src/web/hooks/use-call-tool.d.ts +100 -0
  88. package/dist/src/web/hooks/use-call-tool.js +60 -0
  89. package/dist/src/web/hooks/use-call-tool.js.map +1 -0
  90. package/dist/src/web/hooks/use-call-tool.test-d.d.ts +1 -0
  91. package/dist/src/web/hooks/use-call-tool.test-d.js +104 -0
  92. package/dist/src/web/hooks/use-call-tool.test-d.js.map +1 -0
  93. package/dist/src/web/hooks/use-call-tool.test.d.ts +1 -0
  94. package/dist/src/web/hooks/use-call-tool.test.js +165 -0
  95. package/dist/src/web/hooks/use-call-tool.test.js.map +1 -0
  96. package/dist/src/web/hooks/use-display-mode.d.ts +4 -0
  97. package/dist/src/web/hooks/use-display-mode.js +10 -0
  98. package/dist/src/web/hooks/use-display-mode.js.map +1 -0
  99. package/dist/src/web/hooks/use-display-mode.test.d.ts +1 -0
  100. package/dist/src/web/hooks/use-display-mode.test.js +41 -0
  101. package/dist/src/web/hooks/use-display-mode.test.js.map +1 -0
  102. package/dist/src/web/hooks/use-files.d.ts +10 -0
  103. package/dist/src/web/hooks/use-files.js +7 -0
  104. package/dist/src/web/hooks/use-files.js.map +1 -0
  105. package/dist/src/web/hooks/use-files.test.d.ts +1 -0
  106. package/dist/src/web/hooks/use-files.test.js +29 -0
  107. package/dist/src/web/hooks/use-files.test.js.map +1 -0
  108. package/dist/src/web/hooks/use-layout.d.ts +22 -0
  109. package/dist/src/web/hooks/use-layout.js +23 -0
  110. package/dist/src/web/hooks/use-layout.js.map +1 -0
  111. package/dist/src/web/hooks/use-layout.test.d.ts +1 -0
  112. package/dist/src/web/hooks/use-layout.test.js +46 -0
  113. package/dist/src/web/hooks/use-layout.test.js.map +1 -0
  114. package/dist/src/web/hooks/use-open-external.d.ts +1 -0
  115. package/dist/src/web/hooks/use-open-external.js +6 -0
  116. package/dist/src/web/hooks/use-open-external.js.map +1 -0
  117. package/dist/src/web/hooks/use-open-external.test.d.ts +1 -0
  118. package/dist/src/web/hooks/use-open-external.test.js +24 -0
  119. package/dist/src/web/hooks/use-open-external.test.js.map +1 -0
  120. package/dist/src/web/hooks/use-openai-global.d.ts +3 -0
  121. package/dist/src/web/hooks/use-openai-global.js +6 -0
  122. package/dist/src/web/hooks/use-openai-global.js.map +1 -0
  123. package/dist/src/web/hooks/use-request-modal.d.ts +9 -0
  124. package/dist/src/web/hooks/use-request-modal.js +14 -0
  125. package/dist/src/web/hooks/use-request-modal.js.map +1 -0
  126. package/dist/src/web/hooks/use-request-modal.test.d.ts +1 -0
  127. package/dist/src/web/hooks/use-request-modal.test.js +57 -0
  128. package/dist/src/web/hooks/use-request-modal.test.js.map +1 -0
  129. package/dist/src/web/hooks/use-send-follow-up-message.d.ts +1 -0
  130. package/dist/src/web/hooks/use-send-follow-up-message.js +11 -0
  131. package/dist/src/web/hooks/use-send-follow-up-message.js.map +1 -0
  132. package/dist/src/web/hooks/use-tool-info.d.ts +25 -0
  133. package/dist/src/web/hooks/use-tool-info.js +20 -0
  134. package/dist/src/web/hooks/use-tool-info.js.map +1 -0
  135. package/dist/src/web/hooks/use-tool-info.test-d.d.ts +1 -0
  136. package/dist/src/web/hooks/use-tool-info.test-d.js +73 -0
  137. package/dist/src/web/hooks/use-tool-info.test-d.js.map +1 -0
  138. package/dist/src/web/hooks/use-tool-info.test.d.ts +1 -0
  139. package/dist/src/web/hooks/use-tool-info.test.js +60 -0
  140. package/dist/src/web/hooks/use-tool-info.test.js.map +1 -0
  141. package/dist/src/web/hooks/use-user.d.ts +18 -0
  142. package/dist/src/web/hooks/use-user.js +19 -0
  143. package/dist/src/web/hooks/use-user.js.map +1 -0
  144. package/dist/src/web/hooks/use-user.test.d.ts +1 -0
  145. package/dist/src/web/hooks/use-user.test.js +44 -0
  146. package/dist/src/web/hooks/use-user.test.js.map +1 -0
  147. package/dist/src/web/hooks/use-widget-state.d.ts +4 -0
  148. package/dist/src/web/hooks/use-widget-state.js +32 -0
  149. package/dist/src/web/hooks/use-widget-state.js.map +1 -0
  150. package/dist/src/web/hooks/use-widget-state.test.d.ts +1 -0
  151. package/dist/src/web/hooks/use-widget-state.test.js +61 -0
  152. package/dist/src/web/hooks/use-widget-state.test.js.map +1 -0
  153. package/dist/src/web/index.d.ts +7 -3
  154. package/dist/src/web/index.js +7 -3
  155. package/dist/src/web/index.js.map +1 -1
  156. package/dist/src/web/mount-widget.js +5 -0
  157. package/dist/src/web/mount-widget.js.map +1 -1
  158. package/dist/src/web/plugin/data-llm.test.d.ts +1 -0
  159. package/dist/src/web/plugin/data-llm.test.js +81 -0
  160. package/dist/src/web/plugin/data-llm.test.js.map +1 -0
  161. package/dist/src/web/plugin/plugin.d.ts +2 -0
  162. package/dist/src/web/plugin/plugin.js +39 -0
  163. package/dist/src/web/plugin/plugin.js.map +1 -0
  164. package/dist/src/web/plugin/transform-data-llm.d.ts +12 -0
  165. package/dist/src/web/plugin/transform-data-llm.js +93 -0
  166. package/dist/src/web/plugin/transform-data-llm.js.map +1 -0
  167. package/dist/src/web/plugin/transform-data-llm.test.d.ts +1 -0
  168. package/dist/src/web/plugin/transform-data-llm.test.js +81 -0
  169. package/dist/src/web/plugin/transform-data-llm.test.js.map +1 -0
  170. package/dist/src/web/proxy.d.ts +1 -0
  171. package/dist/src/web/proxy.js +53 -0
  172. package/dist/src/web/proxy.js.map +1 -0
  173. package/dist/src/web/types.d.ts +75 -19
  174. package/dist/src/web/types.js +1 -0
  175. package/dist/src/web/types.js.map +1 -1
  176. package/dist/vitest.config.js +0 -1
  177. package/dist/vitest.config.js.map +1 -1
  178. package/package.json +25 -7
  179. package/LICENSE +0 -674
  180. package/README.md +0 -69
  181. package/dist/src/test/setup.js +0 -9
  182. package/dist/src/test/setup.js.map +0 -1
  183. package/dist/src/web/use-openai-global.d.ts +0 -2
  184. package/dist/src/web/use-openai-global.js +0 -21
  185. package/dist/src/web/use-openai-global.js.map +0 -1
  186. package/dist/src/web/use-tool-output.d.ts +0 -3
  187. package/dist/src/web/use-tool-output.js +0 -5
  188. package/dist/src/web/use-tool-output.js.map +0 -1
  189. /package/dist/src/{test/setup.d.ts → web/bridges/hooks/use-mcp-app-bridge.test.d.ts} +0 -0
package/README.md DELETED
@@ -1,69 +0,0 @@
1
- <div align="center">
2
-
3
- # Skybridge
4
-
5
- **Skybridge is the TypeScript framework for building ChatGPT apps**
6
-
7
- [![By Alpic](https://img.shields.io/badge/Made%20by%20Alpic-f6ffed?logo=alpic)](https://alpic.ai)
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)
12
-
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
21
-
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.
23
-
24
- ## Installation
25
-
26
- ```bash
27
- pnpm add skybridge
28
- ```
29
-
30
- ## Packages
31
-
32
- ### skybridge/server
33
-
34
- 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.
35
-
36
- ### skybridge/web
37
-
38
- The `skybridge/web` package is a react library with hooks and components to build widgets on the underlying _OpenAI iFrame skybridge_ runtime.
39
-
40
- **Vite plugin**
41
-
42
- The `skybridge/web` package comes with a Vite plugin that allows you to build your widgets as regular Vite apps.
43
-
44
- ```ts
45
- import { defineConfig } from "vite";
46
- import { skybridge } from "skybridge/web";
47
-
48
- export default defineConfig({
49
- plugins: [skybridge()],
50
- });
51
- ```
52
-
53
- **Hooks**
54
-
55
- The `skybridge/web` package comes with a set of hooks to help you build your widgets.
56
-
57
- ```ts
58
- import { useToolOutput } from "skybridge/web";
59
-
60
- // Initial data returned by the tool invocation on structuredOutput
61
- const toolOutput = useToolOutput();
62
- ```
63
-
64
- ## Migrate your existing MCP server to a ChatGPT app
65
-
66
- If you're already using the `@modelcontextprotocol/sdk` to build a MCP server, you can migrate to a ChatGPT app by following these steps:
67
-
68
- 1. Replace your `McpServer` import from `@modelcontextprotocol/sdk` with the same import from `skybridge/server`
69
- 2. Create a new node project named `web` and install the `skybridge` package
@@ -1,9 +0,0 @@
1
- import { vi } from "vitest";
2
- // Mock console methods to avoid noise in tests
3
- global.console = {
4
- ...console,
5
- error: vi.fn(),
6
- warn: vi.fn(),
7
- log: vi.fn(),
8
- };
9
- //# sourceMappingURL=setup.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"setup.js","sourceRoot":"","sources":["../../../src/test/setup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE5B,+CAA+C;AAC/C,MAAM,CAAC,OAAO,GAAG;IACf,GAAG,OAAO;IACV,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE;IACd,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE;IACb,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;CACb,CAAC"}
@@ -1,2 +0,0 @@
1
- import { type OpenAiGlobals } from "./types.js";
2
- export declare function useOpenAiGlobal<K extends keyof OpenAiGlobals>(key: K): OpenAiGlobals[K] | undefined;
@@ -1,21 +0,0 @@
1
- import { useSyncExternalStore } from "react";
2
- import { SET_GLOBALS_EVENT_TYPE, SetGlobalsEvent } from "./types.js";
3
- export function useOpenAiGlobal(key) {
4
- return useSyncExternalStore((onChange) => {
5
- const handleSetGlobal = (event) => {
6
- const value = event.detail.globals[key];
7
- if (value === undefined) {
8
- return;
9
- }
10
- console.dir(event.detail.globals, { depth: Infinity });
11
- onChange();
12
- };
13
- window.addEventListener(SET_GLOBALS_EVENT_TYPE, handleSetGlobal, {
14
- passive: true,
15
- });
16
- return () => {
17
- window.removeEventListener(SET_GLOBALS_EVENT_TYPE, handleSetGlobal);
18
- };
19
- }, () => window.openai?.[key]);
20
- }
21
- //# sourceMappingURL=use-openai-global.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"use-openai-global.js","sourceRoot":"","sources":["../../../src/web/use-openai-global.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAAsB,MAAM,YAAY,CAAC;AAEzF,MAAM,UAAU,eAAe,CAAgC,GAAM;IACnE,OAAO,oBAAoB,CACzB,CAAC,QAAQ,EAAE,EAAE;QACX,MAAM,eAAe,GAAG,CAAC,KAAsB,EAAE,EAAE;YACjD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO;YACT,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;YACvD,QAAQ,EAAE,CAAC;QACb,CAAC,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,sBAAsB,EAAE,eAAe,EAAE;YAC/D,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE;YACV,MAAM,CAAC,mBAAmB,CAAC,sBAAsB,EAAE,eAAe,CAAC,CAAC;QACtE,CAAC,CAAC;IACJ,CAAC,EACD,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAC3B,CAAC;AACJ,CAAC"}
@@ -1,3 +0,0 @@
1
- export declare function useToolOutput(): {
2
- [x: string]: unknown;
3
- } | null | undefined;
@@ -1,5 +0,0 @@
1
- import { useOpenAiGlobal } from "./use-openai-global.js";
2
- export function useToolOutput() {
3
- return useOpenAiGlobal("toolOutput");
4
- }
5
- //# sourceMappingURL=use-tool-output.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"use-tool-output.js","sourceRoot":"","sources":["../../../src/web/use-tool-output.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,MAAM,UAAU,aAAa;IAC3B,OAAO,eAAe,CAAC,YAAY,CAAC,CAAC;AACvC,CAAC"}