skybridge 0.0.0-dev.e31f406 → 0.0.0-dev.e3e0986

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 (132) hide show
  1. package/README.md +122 -0
  2. package/dist/src/server/index.d.ts +2 -0
  3. package/dist/src/server/inferUtilityTypes.d.ts +33 -0
  4. package/dist/src/server/inferUtilityTypes.js +2 -0
  5. package/dist/src/server/inferUtilityTypes.js.map +1 -0
  6. package/dist/src/server/server.d.ts +14 -7
  7. package/dist/src/server/server.js +20 -7
  8. package/dist/src/server/server.js.map +1 -1
  9. package/dist/src/server/templateHelper.d.ts +9 -8
  10. package/dist/src/server/templateHelper.js +0 -8
  11. package/dist/src/server/templateHelper.js.map +1 -1
  12. package/dist/src/server/templates/development.hbs +1 -0
  13. package/dist/src/server/templates/production.hbs +3 -2
  14. package/dist/src/test/utils.js +1 -1
  15. package/dist/src/test/utils.js.map +1 -1
  16. package/dist/src/test/widget.test.js +23 -2
  17. package/dist/src/test/widget.test.js.map +1 -1
  18. package/dist/src/web/hooks/index.d.ts +14 -0
  19. package/dist/src/web/hooks/index.js +15 -0
  20. package/dist/src/web/hooks/index.js.map +1 -0
  21. package/dist/src/web/hooks/use-call-tool.d.ts +62 -0
  22. package/dist/src/web/{use-call-tool.js → hooks/use-call-tool.js} +28 -4
  23. package/dist/src/web/hooks/use-call-tool.js.map +1 -0
  24. package/dist/src/web/hooks/use-call-tool.test.js +163 -0
  25. package/dist/src/web/hooks/use-call-tool.test.js.map +1 -0
  26. package/dist/src/web/hooks/use-display-mode.d.ts +4 -0
  27. package/dist/src/web/hooks/use-display-mode.js +7 -0
  28. package/dist/src/web/hooks/use-display-mode.js.map +1 -0
  29. package/dist/src/web/hooks/use-display-mode.test.js +40 -0
  30. package/dist/src/web/hooks/use-display-mode.test.js.map +1 -0
  31. package/dist/src/web/hooks/use-files.d.ts +10 -0
  32. package/dist/src/web/hooks/use-files.js +7 -0
  33. package/dist/src/web/hooks/use-files.js.map +1 -0
  34. package/dist/src/web/hooks/use-files.test.d.ts +1 -0
  35. package/dist/src/web/hooks/use-files.test.js +29 -0
  36. package/dist/src/web/hooks/use-files.test.js.map +1 -0
  37. package/dist/src/web/hooks/use-locale.d.ts +1 -0
  38. package/dist/src/web/hooks/use-locale.js +5 -0
  39. package/dist/src/web/hooks/use-locale.js.map +1 -0
  40. package/dist/src/web/hooks/use-locale.test.d.ts +1 -0
  41. package/dist/src/web/hooks/use-locale.test.js +21 -0
  42. package/dist/src/web/hooks/use-locale.test.js.map +1 -0
  43. package/dist/src/web/hooks/use-open-external.d.ts +1 -0
  44. package/dist/src/web/hooks/use-open-external.js +6 -0
  45. package/dist/src/web/hooks/use-open-external.js.map +1 -0
  46. package/dist/src/web/hooks/use-open-external.test.d.ts +1 -0
  47. package/dist/src/web/hooks/use-open-external.test.js +24 -0
  48. package/dist/src/web/hooks/use-open-external.test.js.map +1 -0
  49. package/dist/src/web/{use-openai-global.d.ts → hooks/use-openai-global.d.ts} +1 -1
  50. package/dist/src/web/{use-openai-global.js → hooks/use-openai-global.js} +4 -2
  51. package/dist/src/web/hooks/use-openai-global.js.map +1 -0
  52. package/dist/src/web/hooks/use-request-modal.d.ts +6 -0
  53. package/dist/src/web/hooks/use-request-modal.js +9 -0
  54. package/dist/src/web/hooks/use-request-modal.js.map +1 -0
  55. package/dist/src/web/hooks/use-request-modal.test.d.ts +1 -0
  56. package/dist/src/web/hooks/use-request-modal.test.js +24 -0
  57. package/dist/src/web/hooks/use-request-modal.test.js.map +1 -0
  58. package/dist/src/web/hooks/use-send-follow-up-message.d.ts +1 -0
  59. package/dist/src/web/hooks/use-send-follow-up-message.js +11 -0
  60. package/dist/src/web/hooks/use-send-follow-up-message.js.map +1 -0
  61. package/dist/src/web/hooks/use-theme.d.ts +1 -0
  62. package/dist/src/web/hooks/use-theme.js +5 -0
  63. package/dist/src/web/hooks/use-theme.js.map +1 -0
  64. package/dist/src/web/hooks/use-theme.test.d.ts +1 -0
  65. package/dist/src/web/hooks/use-theme.test.js +26 -0
  66. package/dist/src/web/hooks/use-theme.test.js.map +1 -0
  67. package/dist/src/web/hooks/use-tool-info.d.ts +25 -0
  68. package/dist/src/web/hooks/use-tool-info.js +22 -0
  69. package/dist/src/web/hooks/use-tool-info.js.map +1 -0
  70. package/dist/src/web/hooks/use-tool-info.test-d.d.ts +1 -0
  71. package/dist/src/web/hooks/use-tool-info.test-d.js +74 -0
  72. package/dist/src/web/hooks/use-tool-info.test-d.js.map +1 -0
  73. package/dist/src/web/hooks/use-tool-info.test.d.ts +1 -0
  74. package/dist/src/web/hooks/use-tool-info.test.js +59 -0
  75. package/dist/src/web/hooks/use-tool-info.test.js.map +1 -0
  76. package/dist/src/web/hooks/use-tool-output.d.ts +4 -0
  77. package/dist/src/web/hooks/use-tool-output.js +9 -0
  78. package/dist/src/web/hooks/use-tool-output.js.map +1 -0
  79. package/dist/src/web/hooks/use-tool-response-metadata.d.ts +4 -0
  80. package/dist/src/web/hooks/use-tool-response-metadata.js +8 -0
  81. package/dist/src/web/hooks/use-tool-response-metadata.js.map +1 -0
  82. package/dist/src/web/hooks/use-user-agent.d.ts +1 -0
  83. package/dist/src/web/hooks/use-user-agent.js +5 -0
  84. package/dist/src/web/hooks/use-user-agent.js.map +1 -0
  85. package/dist/src/web/hooks/use-user-agent.test.d.ts +1 -0
  86. package/dist/src/web/hooks/use-user-agent.test.js +31 -0
  87. package/dist/src/web/hooks/use-user-agent.test.js.map +1 -0
  88. package/dist/src/web/hooks/use-widget-state.d.ts +4 -0
  89. package/dist/src/web/hooks/use-widget-state.js +30 -0
  90. package/dist/src/web/hooks/use-widget-state.js.map +1 -0
  91. package/dist/src/web/hooks/use-widget-state.test.d.ts +1 -0
  92. package/dist/src/web/hooks/use-widget-state.test.js +60 -0
  93. package/dist/src/web/hooks/use-widget-state.test.js.map +1 -0
  94. package/dist/src/web/index.d.ts +2 -4
  95. package/dist/src/web/index.js +2 -4
  96. package/dist/src/web/index.js.map +1 -1
  97. package/dist/src/web/mount-widget.js +5 -0
  98. package/dist/src/web/mount-widget.js.map +1 -1
  99. package/dist/src/web/plugin.js +2 -4
  100. package/dist/src/web/plugin.js.map +1 -1
  101. package/dist/src/web/proxy.d.ts +1 -0
  102. package/dist/src/web/proxy.js +48 -0
  103. package/dist/src/web/proxy.js.map +1 -0
  104. package/dist/src/web/typed-hooks.d.ts +61 -0
  105. package/dist/src/web/typed-hooks.js +61 -0
  106. package/dist/src/web/typed-hooks.js.map +1 -0
  107. package/dist/src/web/typed-hooks.test-d.d.ts +1 -0
  108. package/dist/src/web/typed-hooks.test-d.js +72 -0
  109. package/dist/src/web/typed-hooks.test-d.js.map +1 -0
  110. package/dist/src/web/typed-hooks.test.d.ts +1 -0
  111. package/dist/src/web/typed-hooks.test.js +10 -0
  112. package/dist/src/web/typed-hooks.test.js.map +1 -0
  113. package/dist/src/web/types.d.ts +30 -14
  114. package/dist/src/web/types.js.map +1 -1
  115. package/dist/vitest.config.js +0 -1
  116. package/dist/vitest.config.js.map +1 -1
  117. package/package.json +4 -2
  118. package/dist/src/test/setup.js +0 -9
  119. package/dist/src/test/setup.js.map +0 -1
  120. package/dist/src/web/use-call-tool.d.ts +0 -54
  121. package/dist/src/web/use-call-tool.js.map +0 -1
  122. package/dist/src/web/use-call-tool.test.js +0 -66
  123. package/dist/src/web/use-call-tool.test.js.map +0 -1
  124. package/dist/src/web/use-openai-global.js.map +0 -1
  125. package/dist/src/web/use-tool-output.d.ts +0 -3
  126. package/dist/src/web/use-tool-output.js +0 -5
  127. package/dist/src/web/use-tool-output.js.map +0 -1
  128. package/dist/src/web/use-tool-response-metadata.d.ts +0 -3
  129. package/dist/src/web/use-tool-response-metadata.js +0 -5
  130. package/dist/src/web/use-tool-response-metadata.js.map +0 -1
  131. /package/dist/src/web/{use-call-tool.test.d.ts → hooks/use-call-tool.test.d.ts} +0 -0
  132. /package/dist/src/{test/setup.d.ts → web/hooks/use-display-mode.test.d.ts} +0 -0
@@ -0,0 +1,72 @@
1
+ import { expectTypeOf, test } from "vitest";
2
+ import { createTypedHooks } from "./typed-hooks.js";
3
+ test("InferWidgets extracts the widget registry type", () => {
4
+ expectTypeOf().toHaveProperty("search-voyage");
5
+ expectTypeOf().toHaveProperty("get-trip-details");
6
+ expectTypeOf().toHaveProperty("no-input-widget");
7
+ });
8
+ test("WidgetNames returns a union of widget name literals", () => {
9
+ expectTypeOf().toEqualTypeOf();
10
+ });
11
+ test("WidgetInput extracts the correct input type from Zod schema", () => {
12
+ expectTypeOf().toEqualTypeOf();
13
+ expectTypeOf().toEqualTypeOf();
14
+ });
15
+ test("WidgetOutput extracts the correct output type from Zod schema", () => {
16
+ expectTypeOf().toEqualTypeOf();
17
+ expectTypeOf().toEqualTypeOf();
18
+ });
19
+ test("createTypedHooks provides autocomplete for widget names", () => {
20
+ const { useCallTool } = createTypedHooks();
21
+ useCallTool("search-voyage");
22
+ useCallTool("get-trip-details");
23
+ useCallTool("no-input-widget");
24
+ // @ts-expect-error - "invalid-name" is not a valid widget name
25
+ useCallTool("invalid-name");
26
+ });
27
+ test("useCallTool returns correctly typed callTool function", () => {
28
+ const { useCallTool } = createTypedHooks();
29
+ const { callTool } = useCallTool("search-voyage");
30
+ callTool({ destination: "Spain" });
31
+ callTool({ destination: "France", departureDate: "2024-06-01" });
32
+ callTool({ destination: "Italy", maxPrice: 1000 });
33
+ });
34
+ test("useCallTool returns correctly typed data", () => {
35
+ const { useCallTool } = createTypedHooks();
36
+ const { data } = useCallTool("search-voyage");
37
+ if (data) {
38
+ expectTypeOf(data.structuredContent).toExtend();
39
+ expectTypeOf(data.structuredContent.results).toBeArray();
40
+ expectTypeOf(data.structuredContent.totalCount).toBeNumber();
41
+ }
42
+ });
43
+ test("widgets with no outputSchema have empty object output type", () => {
44
+ expectTypeOf().toEqualTypeOf();
45
+ });
46
+ test("createTypedHooks provides autocomplete for widget names in useToolInfo", () => {
47
+ const { useToolInfo } = createTypedHooks();
48
+ useToolInfo();
49
+ useToolInfo();
50
+ useToolInfo();
51
+ // @ts-expect-error - "invalid-name" is not a valid widget name
52
+ useToolInfo();
53
+ });
54
+ test("useToolInfo infers input types from WidgetInput utility", () => {
55
+ const { useToolInfo } = createTypedHooks();
56
+ const toolInfo = useToolInfo();
57
+ expectTypeOf(toolInfo.input).toExtend();
58
+ const detailsInfo = useToolInfo();
59
+ expectTypeOf(detailsInfo.input).toExtend();
60
+ });
61
+ test("useToolInfo infers output types from WidgetOutput utility", () => {
62
+ const { useToolInfo } = createTypedHooks();
63
+ const toolInfo = useToolInfo();
64
+ if (toolInfo.status === "success") {
65
+ expectTypeOf(toolInfo.output).toExtend();
66
+ }
67
+ const detailsInfo = useToolInfo();
68
+ if (detailsInfo.status === "success") {
69
+ expectTypeOf(detailsInfo.output).toExtend();
70
+ }
71
+ });
72
+ //# sourceMappingURL=typed-hooks.test-d.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"typed-hooks.test-d.js","sourceRoot":"","sources":["../../../src/web/typed-hooks.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAuCpD,IAAI,CAAC,gDAAgD,EAAE,GAAG,EAAE;IAG1D,YAAY,EAAW,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACxD,YAAY,EAAW,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IAC3D,YAAY,EAAW,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;AAC5D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;IAG/D,YAAY,EAAS,CAAC,aAAa,EAEhC,CAAC;AACN,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6DAA6D,EAAE,GAAG,EAAE;IAGvE,YAAY,EAAe,CAAC,aAAa,EAIrC,CAAC;IAIL,YAAY,EAAgB,CAAC,aAAa,EAEtC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;IAGzE,YAAY,EAAgB,CAAC,aAAa,EAOtC,CAAC;IAIL,YAAY,EAAiB,CAAC,aAAa,EAIvC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;IACnE,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAc,CAAC;IAEvD,WAAW,CAAC,eAAe,CAAC,CAAC;IAC7B,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAChC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAE/B,+DAA+D;IAC/D,WAAW,CAAC,cAAc,CAAC,CAAC;AAC9B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;IACjE,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAc,CAAC;IACvD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAElD,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IACnC,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC,CAAC;IACjE,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;AACrD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;IACpD,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAc,CAAC;IACvD,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAE9C,IAAI,IAAI,EAAE,CAAC;QACT,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAOzC,CAAC;QAEL,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;QACzD,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC,CAAC;AAGH,IAAI,CAAC,4DAA4D,EAAE,GAAG,EAAE;IAGtE,YAAY,EAAiB,CAAC,aAAa,EAAM,CAAC;AACpD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wEAAwE,EAAE,GAAG,EAAE;IAClF,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAc,CAAC;IAEvD,WAAW,EAAmB,CAAC;IAC/B,WAAW,EAAsB,CAAC;IAClC,WAAW,EAAqB,CAAC;IAEjC,+DAA+D;IAC/D,WAAW,EAAkB,CAAC;AAChC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;IACnE,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAc,CAAC;IACvD,MAAM,QAAQ,GAAG,WAAW,EAAmB,CAAC;IAGhD,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAiB,CAAC;IAEvD,MAAM,WAAW,GAAG,WAAW,EAAsB,CAAC;IAEtD,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAwB,CAAC;AACnE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;IACrE,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAc,CAAC;IACvD,MAAM,QAAQ,GAAG,WAAW,EAAmB,CAAC;IAGhD,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAClC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAkB,CAAC;IAC3D,CAAC;IAED,MAAM,WAAW,GAAG,WAAW,EAAsB,CAAC;IAEtD,IAAI,WAAW,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACrC,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAyB,CAAC;IACrE,CAAC;AACH,CAAC,CAAC,CAAC"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,10 @@
1
+ import { describe, expect, it } from "vitest";
2
+ import { createTypedHooks } from "./typed-hooks.js";
3
+ describe("createTypedHooks", () => {
4
+ it("should return an object with useCallTool hook", () => {
5
+ const hooks = createTypedHooks();
6
+ expect(hooks).toHaveProperty("useCallTool");
7
+ expect(typeof hooks.useCallTool).toBe("function");
8
+ });
9
+ });
10
+ //# sourceMappingURL=typed-hooks.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"typed-hooks.test.js","sourceRoot":"","sources":["../../../src/web/typed-hooks.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAYpD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,KAAK,GAAG,gBAAgB,EAAc,CAAC;QAC7C,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5C,MAAM,CAAC,OAAO,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -1,14 +1,8 @@
1
- type UnknownObject = Record<string, unknown>;
2
- export type WidgetState = UnknownObject;
3
- export type SetWidgetState = (state: WidgetState) => Promise<void>;
4
- export type SendFollowUpMessage = (args: {
5
- prompt: string;
6
- }) => Promise<void>;
7
- export type RequestDisplayMode = (args: {
8
- mode: DisplayMode;
9
- }) => Promise<{
10
- mode: DisplayMode;
11
- }>;
1
+ export type UnknownObject = Record<string, unknown>;
2
+ type WidgetState = UnknownObject;
3
+ type FileMetadata = {
4
+ fileId: string;
5
+ };
12
6
  export declare const TOOL_RESPONSE_EVENT_TYPE = "openai:tool_response";
13
7
  export declare class ToolResponseEvent extends CustomEvent<{
14
8
  tool: {
@@ -26,7 +20,7 @@ declare global {
26
20
  [SET_GLOBALS_EVENT_TYPE]: SetGlobalsEvent;
27
21
  }
28
22
  }
29
- export type OpenAiGlobals<ToolInput extends UnknownObject = UnknownObject, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject, WidgetState extends UnknownObject = UnknownObject> = {
23
+ export type OpenAiGlobals<ToolInput extends UnknownObject = {}, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject, WidgetState extends UnknownObject = UnknownObject> = {
30
24
  theme: Theme;
31
25
  userAgent: UserAgent;
32
26
  locale: string;
@@ -34,7 +28,9 @@ export type OpenAiGlobals<ToolInput extends UnknownObject = UnknownObject, ToolO
34
28
  displayMode: DisplayMode;
35
29
  safeArea: SafeArea;
36
30
  toolInput: ToolInput;
37
- toolOutput: ToolOutput | null;
31
+ toolOutput: ToolOutput | {
32
+ text: string;
33
+ } | null;
38
34
  toolResponseMetadata: ToolResponseMetadata | null;
39
35
  widgetState: WidgetState | null;
40
36
  };
@@ -57,7 +53,7 @@ type API<WidgetState extends UnknownObject> = {
57
53
  prompt: string;
58
54
  }) => Promise<void>;
59
55
  /** Opens an external link, redirects web page or mobile app */
60
- openExternal(payload: {
56
+ openExternal(args: {
61
57
  href: string;
62
58
  }): void;
63
59
  /** For transitioning an app from inline to fullscreen or pip */
@@ -70,7 +66,27 @@ type API<WidgetState extends UnknownObject> = {
70
66
  */
71
67
  mode: DisplayMode;
72
68
  }>;
69
+ /**
70
+ * Sets the widget state.
71
+ * This state is persisted across widget renders.
72
+ */
73
73
  setWidgetState: (state: WidgetState) => Promise<void>;
74
+ /**
75
+ * Opens a modal portaled outside of the widget iFrame.
76
+ * This ensures the modal is correctly displayed and not limited to the widget's area.
77
+ */
78
+ requestModal: (args: {
79
+ title: string;
80
+ }) => Promise<void>;
81
+ /** Uploads a new file to the host */
82
+ uploadFile: (file: File) => Promise<FileMetadata>;
83
+ /**
84
+ * Downloads a file from the host that was previously uploaded.
85
+ * Only files uploaded by the same connector instance can be downloaded.
86
+ */
87
+ downloadFile: (file: FileMetadata) => Promise<{
88
+ downloadUrl: string;
89
+ }>;
74
90
  };
75
91
  export declare const SET_GLOBALS_EVENT_TYPE = "openai:set_globals";
76
92
  export declare class SetGlobalsEvent extends CustomEvent<{
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/web/types.ts"],"names":[],"mappings":"AAYA,MAAM,CAAC,MAAM,wBAAwB,GAAG,sBAAsB,CAAC;AAC/D,MAAM,OAAO,iBAAkB,SAAQ,WAErC;IACkB,IAAI,GAAG,wBAAwB,CAAC;CACnD;AA2ED,sDAAsD;AACtD,MAAM,CAAC,MAAM,sBAAsB,GAAG,oBAAoB,CAAC;AAC3D,MAAM,OAAO,eAAgB,SAAQ,WAEnC;IACkB,IAAI,GAAG,sBAAsB,CAAC;CACjD"}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/web/types.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,MAAM,wBAAwB,GAAG,sBAAsB,CAAC;AAC/D,MAAM,OAAO,iBAAkB,SAAQ,WAErC;IACkB,IAAI,GAAG,wBAAwB,CAAC;CACnD;AA8FD,sDAAsD;AACtD,MAAM,CAAC,MAAM,sBAAsB,GAAG,oBAAoB,CAAC;AAC3D,MAAM,OAAO,eAAgB,SAAQ,WAEnC;IACkB,IAAI,GAAG,sBAAsB,CAAC;CACjD"}
@@ -3,7 +3,6 @@ export default defineConfig({
3
3
  test: {
4
4
  environment: "jsdom",
5
5
  globals: true,
6
- setupFiles: ["./src/test/setup.ts"],
7
6
  },
8
7
  });
9
8
  //# sourceMappingURL=vitest.config.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"vitest.config.js","sourceRoot":"","sources":["../vitest.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,eAAe,YAAY,CAAC;IAC1B,IAAI,EAAE;QACJ,WAAW,EAAE,OAAO;QACpB,OAAO,EAAE,IAAI;QACb,UAAU,EAAE,CAAC,qBAAqB,CAAC;KACpC;CACF,CAAC,CAAC"}
1
+ {"version":3,"file":"vitest.config.js","sourceRoot":"","sources":["../vitest.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,eAAe,YAAY,CAAC;IAC1B,IAAI,EAAE;QACJ,WAAW,EAAE,OAAO;QACpB,OAAO,EAAE,IAAI;KACd;CACF,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "skybridge",
3
- "version": "0.0.0-dev.e31f406",
3
+ "version": "0.0.0-dev.e3e0986",
4
4
  "description": "Skybridge is a framework for building ChatGPT apps",
5
5
  "type": "module",
6
6
  "files": [
@@ -19,7 +19,9 @@
19
19
  "scripts": {
20
20
  "build": "tsc && pnpm run build:templates",
21
21
  "build:templates": "cp -r src/server/templates dist/src/server/",
22
- "test": "vitest run --silent",
22
+ "test": "pnpm run test:unit && pnpm run test:type",
23
+ "test:unit": "vitest run --silent",
24
+ "test:type": "tsc --noEmit",
23
25
  "docs:dev": "pnpm --filter @skybridge/docs start",
24
26
  "docs:build": "pnpm --filter @skybridge/docs build",
25
27
  "docs:serve": "pnpm --filter @skybridge/docs serve"
@@ -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,54 +0,0 @@
1
- import type { CallToolArgs, CallToolResponse } from "./types.js";
2
- export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends CallToolResponse = CallToolResponse>(name: string) => {
3
- callTool: (toolArgs: ToolArgs, sideEffects?: {
4
- onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
5
- onError?: (error: unknown, toolArgs: ToolArgs) => void;
6
- }) => void;
7
- callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse>;
8
- status: "idle";
9
- isIdle: true;
10
- isPending: false;
11
- isSuccess: false;
12
- isError: false;
13
- data: undefined;
14
- error: undefined;
15
- } | {
16
- callTool: (toolArgs: ToolArgs, sideEffects?: {
17
- onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
18
- onError?: (error: unknown, toolArgs: ToolArgs) => void;
19
- }) => void;
20
- callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse>;
21
- status: "pending";
22
- isIdle: false;
23
- isPending: true;
24
- isSuccess: false;
25
- isError: false;
26
- data: undefined;
27
- error: undefined;
28
- } | {
29
- callTool: (toolArgs: ToolArgs, sideEffects?: {
30
- onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
31
- onError?: (error: unknown, toolArgs: ToolArgs) => void;
32
- }) => void;
33
- callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse>;
34
- status: "error";
35
- isIdle: false;
36
- isPending: false;
37
- isSuccess: false;
38
- isError: true;
39
- data: undefined;
40
- error: unknown;
41
- } | {
42
- callTool: (toolArgs: ToolArgs, sideEffects?: {
43
- onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
44
- onError?: (error: unknown, toolArgs: ToolArgs) => void;
45
- }) => void;
46
- callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse>;
47
- status: "success";
48
- isIdle: false;
49
- isPending: false;
50
- isSuccess: true;
51
- isError: false;
52
- data: ToolResponse;
53
- error: undefined;
54
- };
@@ -1 +0,0 @@
1
- {"version":3,"file":"use-call-tool.js","sourceRoot":"","sources":["../../../src/web/use-call-tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AA4BjC,MAAM,CAAC,MAAM,WAAW,GAAG,CAIzB,IAAY,EACZ,EAAE;IACF,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAK1D,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAEzD,MAAM,aAAa,GAAG,KAAK,EAAE,QAAkB,EAAE,EAAE;QACjD,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAC3E,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CACvC,IAAI,EACJ,QAAQ,CACT,CAAC;YACF,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YAEhE,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,gBAAgB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;YAC9D,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,CACf,QAAkB,EAClB,WAGC,EACD,EAAE;QACF,aAAa,CAAC,QAAQ,CAAC;aACpB,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACb,IAAI,WAAW,EAAE,SAAS,EAAE,CAAC;gBAC3B,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACxC,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,IAAI,WAAW,EAAE,OAAO,EAAE,CAAC;gBACzB,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACvC,CAAC;QACH,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG;QACpB,MAAM;QACN,IAAI;QACJ,KAAK;QACL,MAAM,EAAE,MAAM,KAAK,MAAM;QACzB,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,OAAO,EAAE,MAAM,KAAK,OAAO;KACG,CAAC;IAEjC,OAAO;QACL,GAAG,aAAa;QAChB,QAAQ;QACR,aAAa;KACd,CAAC;AACJ,CAAC,CAAC"}
@@ -1,66 +0,0 @@
1
- import { useCallTool } from "./use-call-tool.js";
2
- import { describe, it, expect, vi, beforeEach, afterEach, } from "vitest";
3
- import { renderHook, act, waitFor } from "@testing-library/react";
4
- describe("useCallTool - onSuccess callback", () => {
5
- let OpenaiMock;
6
- beforeEach(() => {
7
- OpenaiMock = {
8
- callTool: vi.fn(),
9
- };
10
- vi.stubGlobal("openai", OpenaiMock);
11
- });
12
- afterEach(() => {
13
- vi.unstubAllGlobals();
14
- vi.resetAllMocks();
15
- });
16
- const toolName = "test-tool";
17
- const args = { input: "test input" };
18
- const data = {
19
- content: [{ type: "text", text: "test result" }],
20
- structuredContent: { result: "test" },
21
- isError: false,
22
- result: "test result",
23
- meta: {},
24
- };
25
- const error = new Error("test error");
26
- it("should call window.openai.callTool with correct arguments", async () => {
27
- const { result } = renderHook(() => useCallTool(toolName));
28
- act(() => {
29
- result.current.callTool(args);
30
- });
31
- expect(OpenaiMock.callTool).toHaveBeenCalledWith(toolName, args);
32
- });
33
- it("should call onSuccess callback with correct data and toolArgs on successful execution", async () => {
34
- const onSuccess = vi.fn();
35
- const onError = vi.fn();
36
- OpenaiMock.callTool.mockResolvedValueOnce(data);
37
- const { result } = renderHook(() => useCallTool(toolName));
38
- act(() => {
39
- result.current.callTool(args, {
40
- onSuccess,
41
- onError,
42
- });
43
- });
44
- await waitFor(() => {
45
- expect(onSuccess).toHaveBeenCalledWith(data, args);
46
- expect(onError).not.toHaveBeenCalled();
47
- });
48
- });
49
- it("should call onError callback with error and toolArgs on failed execution", async () => {
50
- const onSuccess = vi.fn();
51
- const onError = vi.fn();
52
- OpenaiMock.callTool.mockRejectedValueOnce(error);
53
- const { result } = renderHook(() => useCallTool(toolName));
54
- act(() => {
55
- result.current.callTool(args, {
56
- onSuccess,
57
- onError,
58
- });
59
- });
60
- await waitFor(() => {
61
- expect(onSuccess).not.toHaveBeenCalled();
62
- expect(onError).toHaveBeenCalledWith(error, args);
63
- });
64
- });
65
- });
66
- //# sourceMappingURL=use-call-tool.test.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"use-call-tool.test.js","sourceRoot":"","sources":["../../../src/web/use-call-tool.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EACL,QAAQ,EACR,EAAE,EACF,MAAM,EACN,EAAE,EACF,UAAU,EACV,SAAS,GAEV,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAElE,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;IAChD,IAAI,UAA8B,CAAC;IAEnC,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CAAC;QACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,WAAW,CAAC;IAC7B,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG;QACX,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;QACzD,iBAAiB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;QACrC,OAAO,EAAE,KAAK;QACd,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,EAAE;KACT,CAAC;IACF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAEtC,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QACF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;QACrG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACnD,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;QACxF,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;YACzC,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -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"}
@@ -1,3 +0,0 @@
1
- export declare function useToolResponseMetadata(): {
2
- [x: string]: unknown;
3
- } | null | undefined;
@@ -1,5 +0,0 @@
1
- import { useOpenAiGlobal } from "./use-openai-global.js";
2
- export function useToolResponseMetadata() {
3
- return useOpenAiGlobal("toolResponseMetadata");
4
- }
5
- //# sourceMappingURL=use-tool-response-metadata.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"use-tool-response-metadata.js","sourceRoot":"","sources":["../../../src/web/use-tool-response-metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,MAAM,UAAU,uBAAuB;IACrC,OAAO,eAAe,CAAC,sBAAsB,CAAC,CAAC;AACjD,CAAC"}