skybridge 0.0.0-dev.e9c6623 → 0.0.0-dev.eac9740
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.
- package/dist/src/web/hooks/use-call-tool.d.ts +6 -2
- package/dist/src/web/hooks/use-call-tool.js +6 -0
- package/dist/src/web/hooks/use-call-tool.js.map +1 -1
- package/dist/src/web/hooks/use-call-tool.test.js +38 -0
- package/dist/src/web/hooks/use-call-tool.test.js.map +1 -1
- package/dist/src/web/hooks/use-openai-global.js +1 -3
- package/dist/src/web/hooks/use-openai-global.js.map +1 -1
- package/dist/src/web/hooks/use-tool-info.d.ts +4 -13
- package/dist/src/web/hooks/use-tool-info.js +2 -14
- package/dist/src/web/hooks/use-tool-info.js.map +1 -1
- package/dist/src/web/hooks/use-tool-info.test.js +18 -38
- package/dist/src/web/hooks/use-tool-info.test.js.map +1 -1
- package/dist/src/web/hooks/use-tool-output.d.ts +1 -1
- package/dist/src/web/types.d.ts +4 -5
- package/dist/src/web/types.js.map +1 -1
- package/package.json +2 -4
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
import type { CallToolArgs, CallToolResponse } from "../types.js";
|
|
2
|
-
export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends
|
|
1
|
+
import type { CallToolArgs, CallToolResponse, CallToolResponseConstraint } from "../types.js";
|
|
2
|
+
export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends CallToolResponseConstraint = CallToolResponse>(name: string) => {
|
|
3
3
|
callTool: (toolArgs: ToolArgs, sideEffects?: {
|
|
4
4
|
onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
|
|
5
5
|
onError?: (error: unknown, toolArgs: ToolArgs) => void;
|
|
6
|
+
onSettled?: (data: ToolResponse | undefined, error: unknown | undefined, toolArgs: ToolArgs) => void;
|
|
6
7
|
}) => void;
|
|
7
8
|
callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse>;
|
|
8
9
|
status: "idle";
|
|
@@ -16,6 +17,7 @@ export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolRes
|
|
|
16
17
|
callTool: (toolArgs: ToolArgs, sideEffects?: {
|
|
17
18
|
onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
|
|
18
19
|
onError?: (error: unknown, toolArgs: ToolArgs) => void;
|
|
20
|
+
onSettled?: (data: ToolResponse | undefined, error: unknown | undefined, toolArgs: ToolArgs) => void;
|
|
19
21
|
}) => void;
|
|
20
22
|
callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse>;
|
|
21
23
|
status: "pending";
|
|
@@ -29,6 +31,7 @@ export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolRes
|
|
|
29
31
|
callTool: (toolArgs: ToolArgs, sideEffects?: {
|
|
30
32
|
onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
|
|
31
33
|
onError?: (error: unknown, toolArgs: ToolArgs) => void;
|
|
34
|
+
onSettled?: (data: ToolResponse | undefined, error: unknown | undefined, toolArgs: ToolArgs) => void;
|
|
32
35
|
}) => void;
|
|
33
36
|
callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse>;
|
|
34
37
|
status: "error";
|
|
@@ -42,6 +45,7 @@ export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolRes
|
|
|
42
45
|
callTool: (toolArgs: ToolArgs, sideEffects?: {
|
|
43
46
|
onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
|
|
44
47
|
onError?: (error: unknown, toolArgs: ToolArgs) => void;
|
|
48
|
+
onSettled?: (data: ToolResponse | undefined, error: unknown | undefined, toolArgs: ToolArgs) => void;
|
|
45
49
|
}) => void;
|
|
46
50
|
callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse>;
|
|
47
51
|
status: "success";
|
|
@@ -19,11 +19,17 @@ export const useCallTool = (name) => {
|
|
|
19
19
|
if (sideEffects?.onSuccess) {
|
|
20
20
|
sideEffects.onSuccess(data, toolArgs);
|
|
21
21
|
}
|
|
22
|
+
if (sideEffects?.onSettled) {
|
|
23
|
+
sideEffects.onSettled(data, undefined, toolArgs);
|
|
24
|
+
}
|
|
22
25
|
})
|
|
23
26
|
.catch((error) => {
|
|
24
27
|
if (sideEffects?.onError) {
|
|
25
28
|
sideEffects.onError(error, toolArgs);
|
|
26
29
|
}
|
|
30
|
+
if (sideEffects?.onSettled) {
|
|
31
|
+
sideEffects.onSettled(undefined, error, toolArgs);
|
|
32
|
+
}
|
|
27
33
|
});
|
|
28
34
|
};
|
|
29
35
|
const callToolState = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use-call-tool.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-call-tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"use-call-tool.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-call-tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAmCjC,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,WAQC,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;YACD,IAAI,WAAW,EAAE,SAAS,EAAE,CAAC;gBAC3B,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;YACnD,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;YACD,IAAI,WAAW,EAAE,SAAS,EAAE,CAAC;gBAC3B,WAAW,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;YACpD,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"}
|
|
@@ -62,5 +62,43 @@ describe("useCallTool - onSuccess callback", () => {
|
|
|
62
62
|
expect(onError).toHaveBeenCalledWith(error, args);
|
|
63
63
|
});
|
|
64
64
|
});
|
|
65
|
+
it("should call onSettled callback with data and undefined error on successful execution", async () => {
|
|
66
|
+
const onSuccess = vi.fn();
|
|
67
|
+
const onError = vi.fn();
|
|
68
|
+
const onSettled = vi.fn();
|
|
69
|
+
OpenaiMock.callTool.mockResolvedValueOnce(data);
|
|
70
|
+
const { result } = renderHook(() => useCallTool(toolName));
|
|
71
|
+
act(() => {
|
|
72
|
+
result.current.callTool(args, {
|
|
73
|
+
onSuccess,
|
|
74
|
+
onError,
|
|
75
|
+
onSettled,
|
|
76
|
+
});
|
|
77
|
+
});
|
|
78
|
+
await waitFor(() => {
|
|
79
|
+
expect(onSuccess).toHaveBeenCalledWith(data, args);
|
|
80
|
+
expect(onSettled).toHaveBeenCalledWith(data, undefined, args);
|
|
81
|
+
expect(onError).not.toHaveBeenCalled();
|
|
82
|
+
});
|
|
83
|
+
});
|
|
84
|
+
it("should call onSettled callback with undefined data and error on failed execution", async () => {
|
|
85
|
+
const onSuccess = vi.fn();
|
|
86
|
+
const onError = vi.fn();
|
|
87
|
+
const onSettled = vi.fn();
|
|
88
|
+
OpenaiMock.callTool.mockRejectedValueOnce(error);
|
|
89
|
+
const { result } = renderHook(() => useCallTool(toolName));
|
|
90
|
+
act(() => {
|
|
91
|
+
result.current.callTool(args, {
|
|
92
|
+
onSuccess,
|
|
93
|
+
onError,
|
|
94
|
+
onSettled,
|
|
95
|
+
});
|
|
96
|
+
});
|
|
97
|
+
await waitFor(() => {
|
|
98
|
+
expect(onError).toHaveBeenCalledWith(error, args);
|
|
99
|
+
expect(onSettled).toHaveBeenCalledWith(undefined, error, args);
|
|
100
|
+
expect(onSuccess).not.toHaveBeenCalled();
|
|
101
|
+
});
|
|
102
|
+
});
|
|
65
103
|
});
|
|
66
104
|
//# sourceMappingURL=use-call-tool.test.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use-call-tool.test.js","sourceRoot":"","sources":["../../../../src/web/hooks/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
|
+
{"version":3,"file":"use-call-tool.test.js","sourceRoot":"","sources":["../../../../src/web/hooks/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;IAEH,EAAE,CAAC,sFAAsF,EAAE,KAAK,IAAI,EAAE;QACpG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,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;gBACP,SAAS;aACV,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,SAAS,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAC9D,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;QAChG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,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;gBACP,SAAS;aACV,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAClD,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YAC/D,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -1,15 +1,13 @@
|
|
|
1
1
|
import { useSyncExternalStore } from "react";
|
|
2
2
|
import { SET_GLOBALS_EVENT_TYPE, SetGlobalsEvent, } from "../types.js";
|
|
3
3
|
export function useOpenAiGlobal(key) {
|
|
4
|
-
if (!window.openai) {
|
|
5
|
-
console.warn("openai is not defined on window. Please make sure to only call this hook inside the OpenAI iFrame skybridge runtime.");
|
|
6
|
-
}
|
|
7
4
|
return useSyncExternalStore((onChange) => {
|
|
8
5
|
const handleSetGlobal = (event) => {
|
|
9
6
|
const value = event.detail.globals[key];
|
|
10
7
|
if (value === undefined) {
|
|
11
8
|
return;
|
|
12
9
|
}
|
|
10
|
+
console.dir(event.detail.globals, { depth: Infinity });
|
|
13
11
|
onChange();
|
|
14
12
|
};
|
|
15
13
|
window.addEventListener(SET_GLOBALS_EVENT_TYPE, handleSetGlobal, {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use-openai-global.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-openai-global.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EACL,sBAAsB,EACtB,eAAe,GAEhB,MAAM,aAAa,CAAC;AAErB,MAAM,UAAU,eAAe,CAC7B,GAAM;IAEN,
|
|
1
|
+
{"version":3,"file":"use-openai-global.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-openai-global.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EACL,sBAAsB,EACtB,eAAe,GAEhB,MAAM,aAAa,CAAC;AAErB,MAAM,UAAU,eAAe,CAC7B,GAAM;IAEN,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,14 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
isSuccess: TStatus extends "success" ? true : false;
|
|
6
|
-
input: ToolInput;
|
|
7
|
-
output: TStatus extends "success" ? ToolOutput : undefined;
|
|
8
|
-
responseMetadata: TStatus extends "success" ? ToolResponseMetadata : undefined;
|
|
1
|
+
export declare function useToolInfo(): {
|
|
2
|
+
output: import("skybridge/web").UnknownObject | null | undefined;
|
|
3
|
+
input: import("skybridge/web").UnknownObject | undefined;
|
|
4
|
+
responseMetadata: import("skybridge/web").UnknownObject | null | undefined;
|
|
9
5
|
};
|
|
10
|
-
type PendingToolState<ToolInput extends UnknownObject> = BaseToolState<"pending", ToolInput>;
|
|
11
|
-
type SuccessToolState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = BaseToolState<"success", ToolInput, ToolOutput, ToolResponseMetadata>;
|
|
12
|
-
type ToolState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = PendingToolState<ToolInput> | SuccessToolState<ToolInput, ToolOutput, ToolResponseMetadata>;
|
|
13
|
-
export declare function useToolInfo<ToolInput extends UnknownObject = UnknownObject, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject>(): ToolState<ToolInput, ToolOutput, ToolResponseMetadata>;
|
|
14
|
-
export {};
|
|
@@ -1,21 +1,9 @@
|
|
|
1
|
-
import { useEffect, useState } from "react";
|
|
2
1
|
import { useOpenAiGlobal } from "skybridge/web";
|
|
3
2
|
export function useToolInfo() {
|
|
4
|
-
const [status, setStatus] = useState("pending");
|
|
5
|
-
const output = useOpenAiGlobal("toolOutput") ?? undefined;
|
|
6
|
-
const responseMetadata = useOpenAiGlobal("toolResponseMetadata") ?? undefined;
|
|
7
|
-
useEffect(() => {
|
|
8
|
-
setStatus(output === undefined && responseMetadata === undefined
|
|
9
|
-
? "pending"
|
|
10
|
-
: "success");
|
|
11
|
-
}, [output, responseMetadata]);
|
|
12
3
|
return {
|
|
4
|
+
output: useOpenAiGlobal("toolOutput"),
|
|
13
5
|
input: useOpenAiGlobal("toolInput"),
|
|
14
|
-
|
|
15
|
-
isPending: status === "pending",
|
|
16
|
-
isSuccess: status === "success",
|
|
17
|
-
output,
|
|
18
|
-
responseMetadata,
|
|
6
|
+
responseMetadata: useOpenAiGlobal("toolResponseMetadata"),
|
|
19
7
|
};
|
|
20
8
|
}
|
|
21
9
|
//# sourceMappingURL=use-tool-info.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use-tool-info.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-tool-info.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"use-tool-info.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-tool-info.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,MAAM,UAAU,WAAW;IACzB,OAAO;QACL,MAAM,EAAE,eAAe,CAAC,YAAY,CAAC;QACrC,KAAK,EAAE,eAAe,CAAC,WAAW,CAAC;QACnC,gBAAgB,EAAE,eAAe,CAAC,sBAAsB,CAAC;KAC1D,CAAC;AACJ,CAAC"}
|
|
@@ -1,14 +1,17 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { renderHook } from "@testing-library/react";
|
|
2
2
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
3
3
|
import { useToolInfo } from "./use-tool-info.js";
|
|
4
|
-
import { SET_GLOBALS_EVENT_TYPE, SetGlobalsEvent, } from "../types.js";
|
|
5
4
|
describe("useToolInfo", () => {
|
|
6
5
|
let OpenaiMock;
|
|
7
6
|
beforeEach(() => {
|
|
8
7
|
OpenaiMock = {
|
|
9
|
-
toolInput: { name: "
|
|
10
|
-
toolOutput:
|
|
11
|
-
|
|
8
|
+
toolInput: { name: "pikachu", args: { param: "value" } },
|
|
9
|
+
toolOutput: {
|
|
10
|
+
name: "pikachu",
|
|
11
|
+
color: "yellow",
|
|
12
|
+
description: "When several of these POKéMON gather, their\felectricity could build and cause lightning storms.",
|
|
13
|
+
},
|
|
14
|
+
toolResponseMetadata: { id: 12 },
|
|
12
15
|
};
|
|
13
16
|
vi.stubGlobal("openai", OpenaiMock);
|
|
14
17
|
});
|
|
@@ -16,42 +19,19 @@ describe("useToolInfo", () => {
|
|
|
16
19
|
vi.unstubAllGlobals();
|
|
17
20
|
vi.resetAllMocks();
|
|
18
21
|
});
|
|
19
|
-
it("should return toolInput
|
|
22
|
+
it("should return toolInput, toolOutput, and toolResponseMetadata from window.openai", () => {
|
|
20
23
|
const { result } = renderHook(() => useToolInfo());
|
|
21
24
|
expect(result.current.input).toEqual({
|
|
22
|
-
name: "
|
|
23
|
-
args: {
|
|
25
|
+
name: "pikachu",
|
|
26
|
+
args: { param: "value" },
|
|
24
27
|
});
|
|
25
|
-
expect(result.current.
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
const { result } = renderHook(() => useToolInfo());
|
|
33
|
-
fireEvent(window, new SetGlobalsEvent(SET_GLOBALS_EVENT_TYPE, {
|
|
34
|
-
detail: {
|
|
35
|
-
globals: {
|
|
36
|
-
toolOutput: {
|
|
37
|
-
name: "pikachu",
|
|
38
|
-
color: "yellow",
|
|
39
|
-
description: "When several of these POKéMON gather, their\felectricity could build and cause lightning storms.",
|
|
40
|
-
},
|
|
41
|
-
toolResponseMetadata: { id: 12 },
|
|
42
|
-
},
|
|
43
|
-
},
|
|
44
|
-
}));
|
|
45
|
-
waitFor(() => {
|
|
46
|
-
expect(result.current.status).toEqual("success");
|
|
47
|
-
expect(result.current.isPending).toEqual(false);
|
|
48
|
-
expect(result.current.isSuccess).toEqual(true);
|
|
49
|
-
expect(result.current.output).toEqual({
|
|
50
|
-
name: "pikachu",
|
|
51
|
-
color: "yellow",
|
|
52
|
-
description: "When several of these POKéMON gather, their\felectricity could build and cause lightning storms.",
|
|
53
|
-
});
|
|
54
|
-
expect(result.current.responseMetadata).toEqual({ id: 12 });
|
|
28
|
+
expect(result.current.output).toEqual({
|
|
29
|
+
name: "pikachu",
|
|
30
|
+
color: "yellow",
|
|
31
|
+
description: "When several of these POKéMON gather, their\felectricity could build and cause lightning storms.",
|
|
32
|
+
});
|
|
33
|
+
expect(result.current.responseMetadata).toEqual({
|
|
34
|
+
id: 12,
|
|
55
35
|
});
|
|
56
36
|
});
|
|
57
37
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use-tool-info.test.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-tool-info.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"use-tool-info.test.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-tool-info.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAI,UAIH,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YACxD,UAAU,EAAE;gBACV,IAAI,EAAE,SAAS;gBACf,KAAK,EAAE,QAAQ;gBACf,WAAW,EACT,kGAAkG;aACrG;YACD,oBAAoB,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;SACjC,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,EAAE,CAAC,kFAAkF,EAAE,GAAG,EAAE;QAC1F,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAEnD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;YACnC,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;SACzB,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACpC,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,QAAQ;YACf,WAAW,EACT,kGAAkG;SACrG,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC;YAC9C,EAAE,EAAE,EAAE;SACP,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @deprecated This hook is deprecated. Use `useToolInfo()` instead and access the `output` property.
|
|
3
3
|
*/
|
|
4
|
-
export declare function useToolOutput(): import("../types.js").UnknownObject | undefined;
|
|
4
|
+
export declare function useToolOutput(): import("../types.js").UnknownObject | null | undefined;
|
package/dist/src/web/types.d.ts
CHANGED
|
@@ -30,7 +30,7 @@ declare global {
|
|
|
30
30
|
[SET_GLOBALS_EVENT_TYPE]: SetGlobalsEvent;
|
|
31
31
|
}
|
|
32
32
|
}
|
|
33
|
-
export type OpenAiGlobals<ToolInput extends UnknownObject =
|
|
33
|
+
export type OpenAiGlobals<ToolInput extends UnknownObject = UnknownObject, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject, WidgetState extends UnknownObject = UnknownObject> = {
|
|
34
34
|
theme: Theme;
|
|
35
35
|
userAgent: UserAgent;
|
|
36
36
|
locale: string;
|
|
@@ -38,9 +38,7 @@ export type OpenAiGlobals<ToolInput extends UnknownObject = {}, ToolOutput exten
|
|
|
38
38
|
displayMode: DisplayMode;
|
|
39
39
|
safeArea: SafeArea;
|
|
40
40
|
toolInput: ToolInput;
|
|
41
|
-
toolOutput: ToolOutput |
|
|
42
|
-
text: string;
|
|
43
|
-
} | null;
|
|
41
|
+
toolOutput: ToolOutput | null;
|
|
44
42
|
toolResponseMetadata: ToolResponseMetadata | null;
|
|
45
43
|
widgetState: WidgetState | null;
|
|
46
44
|
requestDisplayMode: RequestDisplayMode;
|
|
@@ -57,9 +55,10 @@ export type CallToolResponse = {
|
|
|
57
55
|
result: string;
|
|
58
56
|
meta: Record<string, unknown>;
|
|
59
57
|
};
|
|
58
|
+
export type CallToolResponseConstraint = Pick<CallToolResponse, "content" | "isError" | "result"> & Partial<Pick<CallToolResponse, "structuredContent" | "meta">>;
|
|
60
59
|
type API<WidgetState extends UnknownObject> = {
|
|
61
60
|
/** Calls a tool on your MCP. Returns the full response. */
|
|
62
|
-
callTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends
|
|
61
|
+
callTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends CallToolResponseConstraint = CallToolResponse>(name: string, args: ToolArgs) => Promise<ToolResponse>;
|
|
63
62
|
/** Triggers a followup turn in the ChatGPT conversation */
|
|
64
63
|
sendFollowUpMessage: (args: {
|
|
65
64
|
prompt: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/web/types.ts"],"names":[],"mappings":"AAkBA,MAAM,CAAC,MAAM,wBAAwB,GAAG,sBAAsB,CAAC;AAC/D,MAAM,OAAO,iBAAkB,SAAQ,WAErC;IACkB,IAAI,GAAG,wBAAwB,CAAC;CACnD;
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/web/types.ts"],"names":[],"mappings":"AAkBA,MAAM,CAAC,MAAM,wBAAwB,GAAG,sBAAsB,CAAC;AAC/D,MAAM,OAAO,iBAAkB,SAAQ,WAErC;IACkB,IAAI,GAAG,wBAAwB,CAAC;CACnD;AAmFD,sDAAsD;AACtD,MAAM,CAAC,MAAM,sBAAsB,GAAG,oBAAoB,CAAC;AAC3D,MAAM,OAAO,eAAgB,SAAQ,WAEnC;IACkB,IAAI,GAAG,sBAAsB,CAAC;CACjD"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "skybridge",
|
|
3
|
-
"version": "0.0.0-dev.
|
|
3
|
+
"version": "0.0.0-dev.eac9740",
|
|
4
4
|
"description": "Skybridge is a framework for building ChatGPT apps",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"files": [
|
|
@@ -19,9 +19,7 @@
|
|
|
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": "
|
|
23
|
-
"test:unit": "vitest run --silent",
|
|
24
|
-
"test:type": "tsc --noEmit",
|
|
22
|
+
"test": "vitest run --silent",
|
|
25
23
|
"docs:dev": "pnpm --filter @skybridge/docs start",
|
|
26
24
|
"docs:build": "pnpm --filter @skybridge/docs build",
|
|
27
25
|
"docs:serve": "pnpm --filter @skybridge/docs serve"
|