skybridge 0.0.0-dev.5961f4a → 0.0.0-dev.5d2997d
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/server/server.js +4 -1
- package/dist/src/server/server.js.map +1 -1
- package/dist/src/web/hooks/use-call-tool.d.ts +30 -22
- package/dist/src/web/hooks/use-call-tool.js +26 -4
- package/dist/src/web/hooks/use-call-tool.js.map +1 -1
- package/dist/src/web/hooks/use-call-tool.test.js +99 -2
- package/dist/src/web/hooks/use-call-tool.test.js.map +1 -1
- package/dist/src/web/hooks/use-tool-info.d.ts +16 -11
- package/dist/src/web/hooks/use-tool-info.js +1 -1
- package/dist/src/web/hooks/use-tool-info.js.map +1 -1
- package/dist/src/web/hooks/use-tool-info.test.js +75 -1
- package/dist/src/web/hooks/use-tool-info.test.js.map +1 -1
- package/dist/src/web/types.d.ts +2 -4
- package/package.json +1 -1
|
@@ -5,7 +5,9 @@ import path from "node:path";
|
|
|
5
5
|
export class McpServer extends McpServerBase {
|
|
6
6
|
widget(name, resourceConfig, toolConfig, toolCallback) {
|
|
7
7
|
const uri = `ui://widgets/${name}.html`;
|
|
8
|
-
const resourceMetadata = {
|
|
8
|
+
const resourceMetadata = {
|
|
9
|
+
...(resourceConfig._meta ?? {}),
|
|
10
|
+
};
|
|
9
11
|
if (toolConfig.description !== undefined) {
|
|
10
12
|
resourceMetadata["openai/widgetDescription"] = toolConfig.description;
|
|
11
13
|
}
|
|
@@ -40,6 +42,7 @@ export class McpServer extends McpServerBase {
|
|
|
40
42
|
const toolMeta = {
|
|
41
43
|
...toolConfig._meta,
|
|
42
44
|
"openai/outputTemplate": uri,
|
|
45
|
+
"ui/resourceUri": uri,
|
|
43
46
|
};
|
|
44
47
|
this.registerTool(name, {
|
|
45
48
|
...toolConfig,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"server.js","sourceRoot":"","sources":["../../../src/server/server.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,IAAI,aAAa,GAE3B,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"server.js","sourceRoot":"","sources":["../../../src/server/server.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,IAAI,aAAa,GAE3B,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;AA+C7B,MAAM,OAAO,SAAU,SAAQ,aAAa;IAC1C,MAAM,CACJ,IAAY,EACZ,cAA+C,EAC/C,UAGC,EACD,YAAqC;QAErC,MAAM,GAAG,GAAG,gBAAgB,IAAI,OAAO,CAAC;QACxC,MAAM,gBAAgB,GAAiB;YACrC,GAAG,CAAC,cAAc,CAAC,KAAK,IAAI,EAAE,CAAC;SAChC,CAAC;QACF,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACzC,gBAAgB,CAAC,0BAA0B,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC;QACxE,CAAC;QAED,IAAI,CAAC,QAAQ,CACX,IAAI,EACJ,GAAG,EACH;YACE,GAAG,cAAc;YACjB,KAAK,EAAE,gBAAgB;SACxB,EACD,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;YACpB,MAAM,SAAS,GACb,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;gBACnC,CAAC,CAAC,WACE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,kBAAkB,CAAC;oBACjD,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,IAC/B,EAAE;gBACJ,CAAC,CAAC,uBAAuB,CAAC;YAE9B,MAAM,IAAI,GACR,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;gBACnC,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC;oBAC9B,SAAS;oBACT,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,eAAe,IAAI,MAAM,CAAC;oBAC1D,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC;iBAC5C,CAAC;gBACJ,CAAC,CAAC,cAAc,CAAC,iBAAiB,CAAC;oBAC/B,SAAS;oBACT,UAAU,EAAE,IAAI;iBACjB,CAAC,CAAC;YAET,OAAO;gBACL,QAAQ,EAAE;oBACR;wBACE,GAAG;wBACH,QAAQ,EAAE,qBAAqB;wBAC/B,IAAI,EAAE,IAAI;qBACX;iBACF;aACF,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,MAAM,QAAQ,GAAa;YACzB,GAAG,UAAU,CAAC,KAAK;YACnB,uBAAuB,EAAE,GAAG;YAC5B,gBAAgB,EAAE,GAAG;SACtB,CAAC;QAEF,IAAI,CAAC,YAAY,CACf,IAAI,EACJ;YACE,GAAG,UAAU;YACb,KAAK,EAAE,QAAQ;SAChB,EACD,YAAY,CACb,CAAC;IACJ,CAAC;IAEO,cAAc,CAAC,GAAW;QAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CACzB,YAAY,CACV,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,eAAe,CAAC,EACpE,OAAO,CACR,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC;IAC7B,CAAC;CACF"}
|
|
@@ -1,10 +1,17 @@
|
|
|
1
1
|
import type { CallToolArgs, CallToolResponse } from "../types.js";
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
2
|
+
type SideEffects<ToolArgs, ToolResponse> = {
|
|
3
|
+
onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
|
|
4
|
+
onError?: (error: unknown, toolArgs: ToolArgs) => void;
|
|
5
|
+
onSettled?: (data: ToolResponse | undefined, error: unknown | undefined, toolArgs: ToolArgs) => void;
|
|
6
|
+
};
|
|
7
|
+
type CallToolAsyncFn<TA, TR> = TA extends null ? () => Promise<TR> : (toolArgs: TA) => Promise<TR>;
|
|
8
|
+
type CallToolResponseConstraint = Partial<Pick<CallToolResponse, "structuredContent" | "meta">>;
|
|
9
|
+
export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends CallToolResponseConstraint = CallToolResponseConstraint>(name: string) => {
|
|
10
|
+
callTool: {
|
|
11
|
+
(sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
12
|
+
(toolArgs: ToolArgs, sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
13
|
+
};
|
|
14
|
+
callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
|
|
8
15
|
status: "idle";
|
|
9
16
|
isIdle: true;
|
|
10
17
|
isPending: false;
|
|
@@ -13,11 +20,11 @@ export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolRes
|
|
|
13
20
|
data: undefined;
|
|
14
21
|
error: undefined;
|
|
15
22
|
} | {
|
|
16
|
-
callTool:
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
}
|
|
20
|
-
callToolAsync:
|
|
23
|
+
callTool: {
|
|
24
|
+
(sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
25
|
+
(toolArgs: ToolArgs, sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
26
|
+
};
|
|
27
|
+
callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
|
|
21
28
|
status: "pending";
|
|
22
29
|
isIdle: false;
|
|
23
30
|
isPending: true;
|
|
@@ -26,11 +33,11 @@ export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolRes
|
|
|
26
33
|
data: undefined;
|
|
27
34
|
error: undefined;
|
|
28
35
|
} | {
|
|
29
|
-
callTool:
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
}
|
|
33
|
-
callToolAsync:
|
|
36
|
+
callTool: {
|
|
37
|
+
(sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
38
|
+
(toolArgs: ToolArgs, sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
39
|
+
};
|
|
40
|
+
callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
|
|
34
41
|
status: "error";
|
|
35
42
|
isIdle: false;
|
|
36
43
|
isPending: false;
|
|
@@ -39,16 +46,17 @@ export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolRes
|
|
|
39
46
|
data: undefined;
|
|
40
47
|
error: unknown;
|
|
41
48
|
} | {
|
|
42
|
-
callTool:
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
}
|
|
46
|
-
callToolAsync:
|
|
49
|
+
callTool: {
|
|
50
|
+
(sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
51
|
+
(toolArgs: ToolArgs, sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
52
|
+
};
|
|
53
|
+
callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
|
|
47
54
|
status: "success";
|
|
48
55
|
isIdle: false;
|
|
49
56
|
isPending: false;
|
|
50
57
|
isSuccess: true;
|
|
51
58
|
isError: false;
|
|
52
|
-
data: ToolResponse;
|
|
59
|
+
data: CallToolResponse & ToolResponse;
|
|
53
60
|
error: undefined;
|
|
54
61
|
};
|
|
62
|
+
export {};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { useState } from "react";
|
|
2
2
|
export const useCallTool = (name) => {
|
|
3
3
|
const [{ status, data, error }, setCallToolState] = useState({ status: "idle", data: undefined, error: undefined });
|
|
4
|
-
const
|
|
4
|
+
const execute = async (toolArgs) => {
|
|
5
5
|
setCallToolState({ status: "pending", data: undefined, error: undefined });
|
|
6
6
|
try {
|
|
7
7
|
const data = await window.openai.callTool(name, toolArgs);
|
|
@@ -13,19 +13,41 @@ export const useCallTool = (name) => {
|
|
|
13
13
|
throw error;
|
|
14
14
|
}
|
|
15
15
|
};
|
|
16
|
-
const
|
|
17
|
-
|
|
16
|
+
const callToolAsync = (async (toolArgs) => {
|
|
17
|
+
if (toolArgs === undefined) {
|
|
18
|
+
return execute(null);
|
|
19
|
+
}
|
|
20
|
+
return execute(toolArgs);
|
|
21
|
+
});
|
|
22
|
+
function callTool(arg1, sideEffects) {
|
|
23
|
+
let toolArgs;
|
|
24
|
+
if (arg1 &&
|
|
25
|
+
typeof arg1 === "object" &&
|
|
26
|
+
("onSuccess" in arg1 || "onError" in arg1 || "onSettled" in arg1)) {
|
|
27
|
+
toolArgs = null; // no toolArgs provided
|
|
28
|
+
sideEffects = arg1;
|
|
29
|
+
}
|
|
30
|
+
else {
|
|
31
|
+
toolArgs = (arg1 === undefined ? null : arg1);
|
|
32
|
+
}
|
|
33
|
+
execute(toolArgs)
|
|
18
34
|
.then((data) => {
|
|
19
35
|
if (sideEffects?.onSuccess) {
|
|
20
36
|
sideEffects.onSuccess(data, toolArgs);
|
|
21
37
|
}
|
|
38
|
+
if (sideEffects?.onSettled) {
|
|
39
|
+
sideEffects.onSettled(data, undefined, toolArgs);
|
|
40
|
+
}
|
|
22
41
|
})
|
|
23
42
|
.catch((error) => {
|
|
24
43
|
if (sideEffects?.onError) {
|
|
25
44
|
sideEffects.onError(error, toolArgs);
|
|
26
45
|
}
|
|
46
|
+
if (sideEffects?.onSettled) {
|
|
47
|
+
sideEffects.onSettled(undefined, error, toolArgs);
|
|
48
|
+
}
|
|
27
49
|
});
|
|
28
|
-
}
|
|
50
|
+
}
|
|
29
51
|
const callToolState = {
|
|
30
52
|
status,
|
|
31
53
|
data,
|
|
@@ -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;AA2DjC,MAAM,CAAC,MAAM,WAAW,GAAG,CAIzB,IAAY,EACZ,EAAE;IAGF,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,OAAO,GAAG,KAAK,EACnB,QAAkB,EACiB,EAAE;QACrC,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,CAGvC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAClB,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,aAAa,GAAG,CAAC,KAAK,EAAE,QAAmB,EAAE,EAAE;QACnD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,OAAO,CAAC,IAAgB,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,OAAO,CAAC,QAAoB,CAAC,CAAC;IACvC,CAAC,CAAwD,CAAC;IAS1D,SAAS,QAAQ,CACf,IAAiE,EACjE,WAA6D;QAE7D,IAAI,QAAkB,CAAC;QACvB,IACE,IAAI;YACJ,OAAO,IAAI,KAAK,QAAQ;YACxB,CAAC,WAAW,IAAI,IAAI,IAAI,SAAS,IAAI,IAAI,IAAI,WAAW,IAAI,IAAI,CAAC,EACjE,CAAC;YACD,QAAQ,GAAG,IAAgB,CAAC,CAAC,uBAAuB;YACpD,WAAW,GAAG,IAAI,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAa,CAAC;QAC5D,CAAC;QAED,OAAO,CAAC,QAAQ,CAAC;aACd,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;IAED,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;KACe,CAAC;IAE7C,OAAO;QACL,GAAG,aAAa;QAChB,QAAQ;QACR,aAAa;KACd,CAAC;AACJ,CAAC,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
+
import { act, renderHook, waitFor } from "@testing-library/react";
|
|
2
|
+
import { afterEach, beforeEach, describe, expect, it, vi, expectTypeOf, } from "vitest";
|
|
1
3
|
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
4
|
describe("useCallTool - onSuccess callback", () => {
|
|
5
5
|
let OpenaiMock;
|
|
6
6
|
beforeEach(() => {
|
|
@@ -62,5 +62,102 @@ 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
|
+
});
|
|
103
|
+
});
|
|
104
|
+
describe("useCallTool - TypeScript typing", () => {
|
|
105
|
+
let OpenaiMock;
|
|
106
|
+
beforeEach(() => {
|
|
107
|
+
OpenaiMock = {
|
|
108
|
+
callTool: vi.fn(),
|
|
109
|
+
};
|
|
110
|
+
vi.stubGlobal("openai", OpenaiMock);
|
|
111
|
+
});
|
|
112
|
+
afterEach(() => {
|
|
113
|
+
vi.unstubAllGlobals();
|
|
114
|
+
vi.resetAllMocks();
|
|
115
|
+
});
|
|
116
|
+
it("should have correct return types when ToolArgs is null and ToolResponse is specified", () => {
|
|
117
|
+
const { result } = renderHook(() => useCallTool("test-tool"));
|
|
118
|
+
const data = {
|
|
119
|
+
content: [{ type: "text", text: "test" }],
|
|
120
|
+
structuredContent: { result: "test" },
|
|
121
|
+
isError: false,
|
|
122
|
+
result: "test",
|
|
123
|
+
meta: { id: 123 },
|
|
124
|
+
};
|
|
125
|
+
OpenaiMock.callTool.mockResolvedValueOnce(data);
|
|
126
|
+
act(() => {
|
|
127
|
+
result.current.callTool();
|
|
128
|
+
});
|
|
129
|
+
expect(OpenaiMock.callTool).toHaveBeenCalledWith("test-tool", null);
|
|
130
|
+
expectTypeOf(result.current.data);
|
|
131
|
+
});
|
|
132
|
+
it("should correctly type callToolAsync return value", async () => {
|
|
133
|
+
const { result } = renderHook(() => useCallTool("test-tool"));
|
|
134
|
+
const testArgs = { query: "test" };
|
|
135
|
+
const mockResponse = {
|
|
136
|
+
content: [{ type: "text", text: "answer" }],
|
|
137
|
+
structuredContent: { answer: "test answer" },
|
|
138
|
+
isError: false,
|
|
139
|
+
result: "answer",
|
|
140
|
+
meta: {},
|
|
141
|
+
};
|
|
142
|
+
OpenaiMock.callTool.mockResolvedValueOnce(mockResponse);
|
|
143
|
+
const promise = result.current.callToolAsync(testArgs);
|
|
144
|
+
expectTypeOf(promise);
|
|
145
|
+
const resolvedValue = await promise;
|
|
146
|
+
expect(resolvedValue).toEqual(mockResponse);
|
|
147
|
+
});
|
|
148
|
+
it("should correctly type callToolAsync when ToolArgs is null", async () => {
|
|
149
|
+
const { result } = renderHook(() => useCallTool("test-tool"));
|
|
150
|
+
const mockResponse = {
|
|
151
|
+
content: [{ type: "text", text: "data" }],
|
|
152
|
+
structuredContent: { data: "test data" },
|
|
153
|
+
isError: false,
|
|
154
|
+
result: "data",
|
|
155
|
+
};
|
|
156
|
+
OpenaiMock.callTool.mockResolvedValueOnce(mockResponse);
|
|
157
|
+
const promise = result.current.callToolAsync();
|
|
158
|
+
expectTypeOf(promise);
|
|
159
|
+
const resolvedValue = await promise;
|
|
160
|
+
expect(resolvedValue).toEqual(mockResponse);
|
|
161
|
+
});
|
|
65
162
|
});
|
|
66
163
|
//# 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,
|
|
1
|
+
{"version":3,"file":"use-call-tool.test.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-call-tool.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EACL,SAAS,EACT,UAAU,EACV,QAAQ,EACR,MAAM,EACN,EAAE,EACF,EAAE,EAEF,YAAY,GACb,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,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;AAEH,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,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,EAAE,CAAC,sFAAsF,EAAE,GAAG,EAAE;QAM9F,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAAqB,WAAW,CAAC,CAC7C,CAAC;QACF,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAClD,iBAAiB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;YACrC,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE;SAClB,CAAC;QAEF,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAEhD,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACpE,YAAY,CAA0B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAMhE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAAyB,WAAW,CAAC,CACjD,CAAC;QAEF,MAAM,QAAQ,GAAa,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAC7C,MAAM,YAAY,GAAG;YACnB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YACpD,iBAAiB,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE;YAC5C,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,EAAE;SACT,CAAC;QAEF,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAExD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACvD,YAAY,CAA+B,OAAO,CAAC,CAAC;QAEpD,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC;QACpC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QAKzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAAqB,WAAW,CAAC,CAC7C,CAAC;QAEF,MAAM,YAAY,GAId;YACF,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAClD,iBAAiB,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE;YACxC,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,MAAM;SACf,CAAC;QAEF,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAExD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;QAC/C,YAAY,CAA+B,OAAO,CAAC,CAAC;QAEpD,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC;QACpC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -1,18 +1,23 @@
|
|
|
1
1
|
import type { UnknownObject } from "../types.js";
|
|
2
|
-
type
|
|
3
|
-
status:
|
|
4
|
-
isPending:
|
|
5
|
-
isSuccess:
|
|
2
|
+
type ToolState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = {
|
|
3
|
+
status: "pending";
|
|
4
|
+
isPending: true;
|
|
5
|
+
isSuccess: false;
|
|
6
6
|
input: ToolInput;
|
|
7
|
-
output:
|
|
8
|
-
responseMetadata:
|
|
7
|
+
output: undefined;
|
|
8
|
+
responseMetadata: undefined;
|
|
9
|
+
} | {
|
|
10
|
+
status: "success";
|
|
11
|
+
isPending: false;
|
|
12
|
+
isSuccess: true;
|
|
13
|
+
input: ToolInput;
|
|
14
|
+
output: ToolOutput;
|
|
15
|
+
responseMetadata: ToolResponseMetadata;
|
|
9
16
|
};
|
|
10
|
-
type
|
|
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<ToolSignature extends Partial<{
|
|
17
|
+
type ToolSignature = {
|
|
14
18
|
input: UnknownObject;
|
|
15
19
|
output: UnknownObject;
|
|
16
20
|
responseMetadata: UnknownObject;
|
|
17
|
-
}
|
|
21
|
+
};
|
|
22
|
+
export declare function useToolInfo<TS extends Partial<ToolSignature> = {}>(): ToolState<TS["input"] extends UnknownObject ? TS["input"] : UnknownObject, TS["output"] extends UnknownObject ? TS["output"] : UnknownObject, TS["responseMetadata"] extends UnknownObject ? TS["responseMetadata"] : UnknownObject>;
|
|
18
23
|
export {};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { useEffect, useState } from "react";
|
|
2
1
|
import { useOpenAiGlobal } from "./use-openai-global.js";
|
|
2
|
+
import { useEffect, useState } from "react";
|
|
3
3
|
export function useToolInfo() {
|
|
4
4
|
const [status, setStatus] = useState("pending");
|
|
5
5
|
const input = useOpenAiGlobal("toolInput");
|
|
@@ -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,wBAAwB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AA+B5C,MAAM,UAAU,WAAW;IACzB,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAwB,SAAS,CAAC,CAAC;IACvE,MAAM,KAAK,GAAG,eAAe,CAAC,WAAW,CAAE,CAAC;IAC5C,MAAM,MAAM,GAAG,eAAe,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC;IAC1D,MAAM,gBAAgB,GAAG,eAAe,CAAC,sBAAsB,CAAC,IAAI,SAAS,CAAC;IAE9E,SAAS,CAAC,GAAG,EAAE;QACb,SAAS,CACP,MAAM,KAAK,SAAS,IAAI,gBAAgB,KAAK,SAAS;YACpD,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,SAAS,CACd,CAAC;IACJ,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAU/B,OAAO;QACL,KAAK;QACL,MAAM;QACN,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,MAAM;QACN,gBAAgB;KACqB,CAAC;AAC1C,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { fireEvent, renderHook, waitFor, act } from "@testing-library/react";
|
|
2
|
-
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
2
|
+
import { afterEach, beforeEach, describe, expect, it, vi, expectTypeOf, } from "vitest";
|
|
3
3
|
import { useToolInfo } from "./use-tool-info.js";
|
|
4
4
|
import { SET_GLOBALS_EVENT_TYPE, SetGlobalsEvent, } from "../types.js";
|
|
5
5
|
describe("useToolInfo", () => {
|
|
@@ -56,4 +56,78 @@ describe("useToolInfo", () => {
|
|
|
56
56
|
});
|
|
57
57
|
});
|
|
58
58
|
});
|
|
59
|
+
describe("useToolInfo - TypeScript typing", () => {
|
|
60
|
+
it("should have correct types when no generic parameter is provided", () => {
|
|
61
|
+
const { result } = renderHook(() => useToolInfo());
|
|
62
|
+
expectTypeOf(result.current.status);
|
|
63
|
+
expectTypeOf(result.current.isPending);
|
|
64
|
+
expectTypeOf(result.current.isSuccess);
|
|
65
|
+
expectTypeOf(result.current.input);
|
|
66
|
+
});
|
|
67
|
+
it("should correctly type input, output, and responseMetadata with explicit ToolSignature", () => {
|
|
68
|
+
const { result } = renderHook(() => useToolInfo());
|
|
69
|
+
expectTypeOf(result.current.input);
|
|
70
|
+
// When pending, output and responseMetadata should be undefined
|
|
71
|
+
if (result.current.status === "pending") {
|
|
72
|
+
expectTypeOf(result.current.output);
|
|
73
|
+
expectTypeOf(result.current.responseMetadata);
|
|
74
|
+
expectTypeOf(result.current.isPending);
|
|
75
|
+
expectTypeOf(result.current.isSuccess);
|
|
76
|
+
}
|
|
77
|
+
// When success, output and responseMetadata should be defined
|
|
78
|
+
if (result.current.status === "success") {
|
|
79
|
+
expectTypeOf(result.current.output);
|
|
80
|
+
expectTypeOf(result.current.responseMetadata);
|
|
81
|
+
expectTypeOf(result.current.isPending);
|
|
82
|
+
expectTypeOf(result.current.isSuccess);
|
|
83
|
+
}
|
|
84
|
+
});
|
|
85
|
+
it("should correctly narrow types based on status discriminated union", () => {
|
|
86
|
+
const { result } = renderHook(() => useToolInfo());
|
|
87
|
+
// Test type narrowing
|
|
88
|
+
if (result.current.isPending) {
|
|
89
|
+
expectTypeOf(result.current.status);
|
|
90
|
+
expectTypeOf(result.current.isPending);
|
|
91
|
+
expectTypeOf(result.current.isSuccess);
|
|
92
|
+
expectTypeOf(result.current.output);
|
|
93
|
+
expectTypeOf(result.current.responseMetadata);
|
|
94
|
+
}
|
|
95
|
+
if (result.current.isSuccess) {
|
|
96
|
+
expectTypeOf(result.current.status);
|
|
97
|
+
expectTypeOf(result.current.isPending);
|
|
98
|
+
expectTypeOf(result.current.isSuccess);
|
|
99
|
+
expectTypeOf(result.current.output);
|
|
100
|
+
expectTypeOf(result.current.responseMetadata);
|
|
101
|
+
}
|
|
102
|
+
if (result.current.status === "pending") {
|
|
103
|
+
expectTypeOf(result.current.input);
|
|
104
|
+
expectTypeOf(result.current.isPending);
|
|
105
|
+
expectTypeOf(result.current.isSuccess);
|
|
106
|
+
expectTypeOf(result.current.output);
|
|
107
|
+
expectTypeOf(result.current.responseMetadata);
|
|
108
|
+
}
|
|
109
|
+
if (result.current.status === "success") {
|
|
110
|
+
expectTypeOf(result.current.input);
|
|
111
|
+
expectTypeOf(result.current.isPending);
|
|
112
|
+
expectTypeOf(result.current.isSuccess);
|
|
113
|
+
expectTypeOf(result.current.output);
|
|
114
|
+
expectTypeOf(result.current.responseMetadata);
|
|
115
|
+
}
|
|
116
|
+
});
|
|
117
|
+
it("should handle partial ToolSignature with only input specified", () => {
|
|
118
|
+
const { result } = renderHook(() => useToolInfo());
|
|
119
|
+
expectTypeOf(result.current.input);
|
|
120
|
+
if (result.current.status === "success") {
|
|
121
|
+
expectTypeOf(result.current.output);
|
|
122
|
+
expectTypeOf(result.current.responseMetadata);
|
|
123
|
+
}
|
|
124
|
+
});
|
|
125
|
+
it("should handle ToolSignature with only output specified", () => {
|
|
126
|
+
const { result } = renderHook(() => useToolInfo());
|
|
127
|
+
expectTypeOf(result.current.input);
|
|
128
|
+
if (result.current.status === "success") {
|
|
129
|
+
expectTypeOf(result.current.output);
|
|
130
|
+
}
|
|
131
|
+
});
|
|
132
|
+
});
|
|
59
133
|
//# sourceMappingURL=use-tool-info.test.js.map
|
|
@@ -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,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,
|
|
1
|
+
{"version":3,"file":"use-tool-info.test.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-tool-info.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EACL,SAAS,EACT,UAAU,EACV,QAAQ,EACR,MAAM,EACN,EAAE,EACF,EAAE,EACF,YAAY,GACb,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EACL,sBAAsB,EACtB,eAAe,GAEhB,MAAM,aAAa,CAAC;AAErB,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAI,UAGH,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;YACzD,UAAU,EAAE,IAAI;YAChB,oBAAoB,EAAE,IAAI;SAC3B,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,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAEnD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;YACnC,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;YACrD,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,IAAI;YACf,SAAS,EAAE,KAAK;SACjB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qFAAqF,EAAE,KAAK,IAAI,EAAE;QACnG,MAAM,UAAU,GAAG;YACjB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,QAAQ;YACf,WAAW,EACT,kGAAkG;SACrG,CAAC;QACF,MAAM,oBAAoB,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;QACxC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAEnD,GAAG,CAAC,GAAG,EAAE;YACP,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC;YACnC,UAAU,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;YACvD,SAAS,CACP,MAAM,EACN,IAAI,eAAe,CAAC,sBAAsB,EAAE;gBAC1C,MAAM,EAAE;oBACN,OAAO,EAAE;wBACP,UAAU;wBACV,oBAAoB;qBACrB;iBACF;aACF,CAAC,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;gBACnC,MAAM,EAAE,SAAS;gBACjB,SAAS,EAAE,KAAK;gBAChB,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,UAAU;gBAClB,gBAAgB,EAAE,oBAAoB;aACvC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAEnD,YAAY,CAAwB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC3D,YAAY,CAAU,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAChD,YAAY,CAAU,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAChD,YAAY,CAA0B,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uFAAuF,EAAE,GAAG,EAAE;QAK/F,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,EAIP,CACL,CAAC;QAEF,YAAY,CAAY,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE9C,gEAAgE;QAChE,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACxC,YAAY,CAAY,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC/C,YAAY,CAAY,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;YACzD,YAAY,CAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC7C,YAAY,CAAQ,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAChD,CAAC;QAED,8DAA8D;QAC9D,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACxC,YAAY,CAAa,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChD,YAAY,CAAe,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;YAC5D,YAAY,CAAQ,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC9C,YAAY,CAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAK3E,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,EAIP,CACL,CAAC;QAEF,sBAAsB;QACtB,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YAC7B,YAAY,CAAY,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC/C,YAAY,CAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC7C,YAAY,CAAQ,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC9C,YAAY,CAAY,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC/C,YAAY,CAAY,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YAC7B,YAAY,CAAY,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC/C,YAAY,CAAQ,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC9C,YAAY,CAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC7C,YAAY,CAAa,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChD,YAAY,CAAe,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACxC,YAAY,CAAY,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC9C,YAAY,CAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC7C,YAAY,CAAQ,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC9C,YAAY,CAAY,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC/C,YAAY,CAAY,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACxC,YAAY,CAAY,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC9C,YAAY,CAAQ,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC9C,YAAY,CAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC7C,YAAY,CAAa,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChD,YAAY,CAAe,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QAGvE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,EAEP,CACL,CAAC;QAEF,YAAY,CAAY,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE9C,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACxC,YAAY,CAA0B,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC7D,YAAY,CAA0B,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACzE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAGhE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,EAEP,CACL,CAAC;QAEF,YAAY,CAA0B,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE5D,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACxC,YAAY,CAAa,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAClD,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
package/dist/src/web/types.d.ts
CHANGED
|
@@ -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;
|
|
@@ -59,7 +57,7 @@ export type CallToolResponse = {
|
|
|
59
57
|
};
|
|
60
58
|
type API<WidgetState extends UnknownObject> = {
|
|
61
59
|
/** Calls a tool on your MCP. Returns the full response. */
|
|
62
|
-
callTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends CallToolResponse = CallToolResponse>(name: string, args: ToolArgs) => Promise<ToolResponse>;
|
|
60
|
+
callTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends CallToolResponse = CallToolResponse>(name: string, args: ToolArgs) => Promise<CallToolResponse & ToolResponse>;
|
|
63
61
|
/** Triggers a followup turn in the ChatGPT conversation */
|
|
64
62
|
sendFollowUpMessage: (args: {
|
|
65
63
|
prompt: string;
|