skybridge 0.7.0 → 0.8.1
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/README.md +173 -0
- package/dist/src/server/index.d.ts +2 -0
- package/dist/src/server/inferUtilityTypes.d.ts +48 -0
- package/dist/src/server/inferUtilityTypes.js +2 -0
- package/dist/src/server/inferUtilityTypes.js.map +1 -0
- package/dist/src/server/server.d.ts +31 -9
- package/dist/src/server/server.js +5 -0
- package/dist/src/server/server.js.map +1 -1
- package/dist/src/test/utils.d.ts +61 -0
- package/dist/src/test/utils.js +122 -1
- package/dist/src/test/utils.js.map +1 -1
- package/dist/src/web/generate-helpers.d.ts +115 -0
- package/dist/src/web/generate-helpers.js +109 -0
- package/dist/src/web/generate-helpers.js.map +1 -0
- package/dist/src/web/generate-helpers.test-d.d.ts +1 -0
- package/dist/src/web/generate-helpers.test-d.js +151 -0
- package/dist/src/web/generate-helpers.test-d.js.map +1 -0
- package/dist/src/web/generate-helpers.test.d.ts +1 -0
- package/dist/src/web/generate-helpers.test.js +17 -0
- package/dist/src/web/generate-helpers.test.js.map +1 -0
- package/dist/src/web/hooks/index.d.ts +1 -1
- package/dist/src/web/hooks/index.js +1 -1
- package/dist/src/web/hooks/index.js.map +1 -1
- package/dist/src/web/hooks/use-call-tool.d.ts +57 -19
- package/dist/src/web/hooks/use-call-tool.js +7 -15
- package/dist/src/web/hooks/use-call-tool.js.map +1 -1
- package/dist/src/web/hooks/use-call-tool.test-d.d.ts +1 -0
- package/dist/src/web/hooks/use-call-tool.test-d.js +104 -0
- package/dist/src/web/hooks/use-call-tool.test-d.js.map +1 -0
- package/dist/src/web/hooks/use-tool-info.d.ts +3 -3
- package/dist/src/web/index.d.ts +1 -0
- package/dist/src/web/index.js +1 -0
- package/dist/src/web/index.js.map +1 -1
- package/dist/src/web/types.d.ts +8 -0
- package/dist/src/web/types.js.map +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { useCallTool, } from "./hooks/use-call-tool.js";
|
|
2
|
+
import { useToolInfo } from "./hooks/use-tool-info.js";
|
|
3
|
+
/**
|
|
4
|
+
* Creates typed versions of skybridge hooks with full type inference
|
|
5
|
+
* for tool names, inputs, and outputs.
|
|
6
|
+
*
|
|
7
|
+
* This is the recommended way to use skybridge hooks in your widgets.
|
|
8
|
+
* Set this up once in a dedicated file and export the typed hooks for use across your app.
|
|
9
|
+
*
|
|
10
|
+
* @typeParam ServerType - The type of your McpServer instance (use `typeof server`).
|
|
11
|
+
* Must be a server instance created with method chaining.
|
|
12
|
+
* TypeScript will validate that tools can be inferred from this type.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```typescript
|
|
16
|
+
* // server/src/index.ts
|
|
17
|
+
* const server = new McpServer({ name: "my-app", version: "1.0" }, {})
|
|
18
|
+
* .widget("search-voyage", {}, {
|
|
19
|
+
* inputSchema: { destination: z.string() },
|
|
20
|
+
* outputSchema: { results: z.array(z.string()) },
|
|
21
|
+
* }, async ({ destination }) => {
|
|
22
|
+
* return { content: [{ type: "text", text: `Found trips to ${destination}` }] };
|
|
23
|
+
* });
|
|
24
|
+
*
|
|
25
|
+
* export type AppType = typeof server;
|
|
26
|
+
* ```
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```typescript
|
|
30
|
+
* // web/src/skybridge.ts (one-time setup)
|
|
31
|
+
* import type { AppType } from "../server";
|
|
32
|
+
* import { generateHelpers } from "skybridge/web";
|
|
33
|
+
*
|
|
34
|
+
* export const { useCallTool, useToolInfo } = generateHelpers<AppType>();
|
|
35
|
+
* ```
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```typescript
|
|
39
|
+
* // web/src/widgets/search.tsx (usage)
|
|
40
|
+
* import { useCallTool, useToolInfo } from "../skybridge";
|
|
41
|
+
*
|
|
42
|
+
* export function SearchWidget() {
|
|
43
|
+
* const { callTool, data } = useCallTool("search-voyage");
|
|
44
|
+
* // ^ autocomplete for tool names
|
|
45
|
+
* callTool({ destination: "Spain" });
|
|
46
|
+
* // ^ autocomplete for input fields
|
|
47
|
+
*
|
|
48
|
+
* const toolInfo = useToolInfo<"search-voyage">();
|
|
49
|
+
* // ^ autocomplete for widget names
|
|
50
|
+
* // toolInfo.input is typed based on widget input schema
|
|
51
|
+
* // toolInfo.output.structuredContent is typed based on widget output schema
|
|
52
|
+
* }
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
55
|
+
export function generateHelpers() {
|
|
56
|
+
return {
|
|
57
|
+
/**
|
|
58
|
+
* Typed version of `useCallTool` that provides autocomplete for tool names
|
|
59
|
+
* and type inference for inputs and outputs.
|
|
60
|
+
*
|
|
61
|
+
* @param name - The name of the widget to call. Autocompletes based on your server's widget registry.
|
|
62
|
+
* @returns A hook with typed `callTool` function and `data` property.
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```typescript
|
|
66
|
+
* const { callTool, data, isPending } = useCallTool("search-voyage");
|
|
67
|
+
* // TypeScript knows callTool expects { destination: string }
|
|
68
|
+
* callTool({ destination: "Spain" });
|
|
69
|
+
*
|
|
70
|
+
* // data.structuredContent is typed based on your outputSchema
|
|
71
|
+
* if (data) {
|
|
72
|
+
* console.log(data.structuredContent.results);
|
|
73
|
+
* }
|
|
74
|
+
* ```
|
|
75
|
+
*/
|
|
76
|
+
useCallTool: (name) => {
|
|
77
|
+
return useCallTool(name);
|
|
78
|
+
},
|
|
79
|
+
/**
|
|
80
|
+
* Typed version of `useToolInfo` that provides autocomplete for widget names
|
|
81
|
+
* and type inference for inputs, outputs, and responseMetadata.
|
|
82
|
+
*
|
|
83
|
+
* @typeParam K - The name of the widget. Autocompletes based on your server's widget registry.
|
|
84
|
+
* @returns A discriminated union with `status: "pending" | "success"` that narrows correctly.
|
|
85
|
+
*
|
|
86
|
+
* @example
|
|
87
|
+
* ```typescript
|
|
88
|
+
* const toolInfo = useToolInfo<"search-voyage">();
|
|
89
|
+
* // toolInfo.input is typed as { destination: string; ... }
|
|
90
|
+
* // toolInfo.output.structuredContent is typed as { results: Array<...>; ... }
|
|
91
|
+
* // toolInfo.status narrows correctly: "pending" | "success"
|
|
92
|
+
*
|
|
93
|
+
* if (toolInfo.isPending) {
|
|
94
|
+
* // TypeScript knows output is undefined here
|
|
95
|
+
* console.log(toolInfo.input.destination);
|
|
96
|
+
* }
|
|
97
|
+
*
|
|
98
|
+
* if (toolInfo.isSuccess) {
|
|
99
|
+
* // TypeScript knows output is defined here
|
|
100
|
+
* console.log(toolInfo.output.structuredContent.results);
|
|
101
|
+
* }
|
|
102
|
+
* ```
|
|
103
|
+
*/
|
|
104
|
+
useToolInfo: () => {
|
|
105
|
+
return useToolInfo();
|
|
106
|
+
},
|
|
107
|
+
};
|
|
108
|
+
}
|
|
109
|
+
//# sourceMappingURL=generate-helpers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generate-helpers.js","sourceRoot":"","sources":["../../../src/web/generate-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,GAIZ,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,WAAW,EAAkB,MAAM,0BAA0B,CAAC;AAmBvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,UAAU,eAAe;IAI7B,OAAO;QACL;;;;;;;;;;;;;;;;;;WAkBG;QACH,WAAW,EAAE,CACX,IAAc,EAC0E,EAAE;YAC1F,OAAO,WAAW,CAAC,IAAI,CAGtB,CAAC;QACJ,CAAC;QAED;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,WAAW,EAAE,GAGX,EAAE;YACF,OAAO,WAAW,EAGjB,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import { expectTypeOf, test } from "vitest";
|
|
2
|
+
import { generateHelpers } from "./generate-helpers.js";
|
|
3
|
+
import { createTestServer } from "../test/utils.js";
|
|
4
|
+
const server = createTestServer();
|
|
5
|
+
test("InferTools extracts the tool registry type (widgets + registerTool)", () => {
|
|
6
|
+
expectTypeOf().toHaveProperty("search-voyage");
|
|
7
|
+
expectTypeOf().toHaveProperty("get-trip-details");
|
|
8
|
+
expectTypeOf().toHaveProperty("no-input-widget");
|
|
9
|
+
expectTypeOf().toHaveProperty("calculate-price");
|
|
10
|
+
expectTypeOf().toHaveProperty("inferred-output-widget");
|
|
11
|
+
expectTypeOf().toHaveProperty("inferred-tool");
|
|
12
|
+
});
|
|
13
|
+
test("ToolNames returns a union of tool name literals (widgets + registerTool)", () => {
|
|
14
|
+
expectTypeOf().toEqualTypeOf();
|
|
15
|
+
});
|
|
16
|
+
test("ToolInput extracts the correct input type from Zod schema", () => {
|
|
17
|
+
expectTypeOf().toEqualTypeOf();
|
|
18
|
+
expectTypeOf().toEqualTypeOf();
|
|
19
|
+
expectTypeOf().toEqualTypeOf();
|
|
20
|
+
});
|
|
21
|
+
test("ToolOutput extracts the correct output type from callback's structuredContent", () => {
|
|
22
|
+
expectTypeOf().toEqualTypeOf();
|
|
23
|
+
expectTypeOf().toEqualTypeOf();
|
|
24
|
+
expectTypeOf().toEqualTypeOf();
|
|
25
|
+
expectTypeOf().toEqualTypeOf();
|
|
26
|
+
});
|
|
27
|
+
test("ToolOutput extracts the correct output type from callback (inferred)", () => {
|
|
28
|
+
expectTypeOf().toEqualTypeOf();
|
|
29
|
+
expectTypeOf().toEqualTypeOf();
|
|
30
|
+
});
|
|
31
|
+
test("generateHelpers provides autocomplete for tool names (widgets + registerTool)", () => {
|
|
32
|
+
const { useCallTool } = generateHelpers();
|
|
33
|
+
useCallTool("search-voyage");
|
|
34
|
+
useCallTool("get-trip-details");
|
|
35
|
+
useCallTool("no-input-widget");
|
|
36
|
+
useCallTool("calculate-price");
|
|
37
|
+
useCallTool("inferred-output-widget");
|
|
38
|
+
useCallTool("inferred-tool");
|
|
39
|
+
// @ts-expect-error - "invalid-name" is not a valid tool name
|
|
40
|
+
useCallTool("invalid-name");
|
|
41
|
+
});
|
|
42
|
+
test("useCallTool returns correctly typed callTool function", () => {
|
|
43
|
+
const { useCallTool } = generateHelpers();
|
|
44
|
+
const { callTool } = useCallTool("search-voyage");
|
|
45
|
+
callTool({ destination: "Spain" });
|
|
46
|
+
callTool({ destination: "France", departureDate: "2024-06-01" });
|
|
47
|
+
callTool({ destination: "Italy", maxPrice: 1000 });
|
|
48
|
+
const { callTool: calculateTool } = useCallTool("calculate-price");
|
|
49
|
+
calculateTool({ tripId: "123", passengers: 2 });
|
|
50
|
+
});
|
|
51
|
+
test("callTool can be called without args for tools with no required inputs", () => {
|
|
52
|
+
const { useCallTool } = generateHelpers();
|
|
53
|
+
const { callTool, callToolAsync } = useCallTool("no-input-widget");
|
|
54
|
+
callTool();
|
|
55
|
+
callTool({});
|
|
56
|
+
callToolAsync();
|
|
57
|
+
callToolAsync({});
|
|
58
|
+
});
|
|
59
|
+
test("callTool requires args for tools with required inputs", () => {
|
|
60
|
+
const { useCallTool } = generateHelpers();
|
|
61
|
+
const { callTool } = useCallTool("search-voyage");
|
|
62
|
+
// @ts-expect-error - "destination" is required
|
|
63
|
+
callTool();
|
|
64
|
+
// @ts-expect-error - "destination" is required
|
|
65
|
+
callTool({});
|
|
66
|
+
// This should work
|
|
67
|
+
callTool({ destination: "Spain" });
|
|
68
|
+
});
|
|
69
|
+
test("callTool supports sideEffects for tools with required inputs", () => {
|
|
70
|
+
const { useCallTool } = generateHelpers();
|
|
71
|
+
const { callTool, data } = useCallTool("search-voyage");
|
|
72
|
+
callTool({ destination: "Spain" }, {
|
|
73
|
+
onSuccess: (response, args) => {
|
|
74
|
+
expectTypeOf(response.structuredContent.results).toBeArray();
|
|
75
|
+
expectTypeOf(args.destination).toBeString();
|
|
76
|
+
},
|
|
77
|
+
onError: (error, args) => {
|
|
78
|
+
expectTypeOf(error).toBeUnknown();
|
|
79
|
+
expectTypeOf(args.destination).toBeString();
|
|
80
|
+
},
|
|
81
|
+
onSettled: (response, error, args) => {
|
|
82
|
+
if (response) {
|
|
83
|
+
expectTypeOf(response.structuredContent.totalCount).toBeNumber();
|
|
84
|
+
}
|
|
85
|
+
expectTypeOf(args.destination).toBeString();
|
|
86
|
+
},
|
|
87
|
+
});
|
|
88
|
+
});
|
|
89
|
+
test("callTool supports sideEffects for tools with no required inputs", () => {
|
|
90
|
+
const { useCallTool } = generateHelpers();
|
|
91
|
+
const { callTool } = useCallTool("no-input-widget");
|
|
92
|
+
callTool({
|
|
93
|
+
onSuccess: (response) => {
|
|
94
|
+
expectTypeOf(response).toHaveProperty("structuredContent");
|
|
95
|
+
},
|
|
96
|
+
});
|
|
97
|
+
callTool({}, {
|
|
98
|
+
onSuccess: (response) => {
|
|
99
|
+
expectTypeOf(response).toHaveProperty("structuredContent");
|
|
100
|
+
},
|
|
101
|
+
});
|
|
102
|
+
});
|
|
103
|
+
test("callToolAsync returns correctly typed promise", () => {
|
|
104
|
+
const { useCallTool } = generateHelpers();
|
|
105
|
+
const { callToolAsync: searchAsync } = useCallTool("search-voyage");
|
|
106
|
+
const searchPromise = searchAsync({ destination: "Spain" });
|
|
107
|
+
expectTypeOf(searchPromise).resolves.toHaveProperty("structuredContent");
|
|
108
|
+
const { callToolAsync: noInputAsync } = useCallTool("no-input-widget");
|
|
109
|
+
const noInputPromise = noInputAsync();
|
|
110
|
+
expectTypeOf(noInputPromise).resolves.toHaveProperty("structuredContent");
|
|
111
|
+
});
|
|
112
|
+
test("useCallTool returns correctly typed data", () => {
|
|
113
|
+
const { useCallTool } = generateHelpers();
|
|
114
|
+
const { data } = useCallTool("search-voyage");
|
|
115
|
+
if (data) {
|
|
116
|
+
expectTypeOf(data.structuredContent).toExtend();
|
|
117
|
+
expectTypeOf(data.structuredContent.results).toBeArray();
|
|
118
|
+
expectTypeOf(data.structuredContent.totalCount).toBeNumber();
|
|
119
|
+
}
|
|
120
|
+
});
|
|
121
|
+
test("useCallTool returns correctly typed data for callback-inferred outputs", () => {
|
|
122
|
+
const { useCallTool } = generateHelpers();
|
|
123
|
+
const { data: widgetData } = useCallTool("inferred-output-widget");
|
|
124
|
+
if (widgetData) {
|
|
125
|
+
expectTypeOf(widgetData.structuredContent).toExtend();
|
|
126
|
+
}
|
|
127
|
+
const { data: toolData } = useCallTool("inferred-tool");
|
|
128
|
+
if (toolData) {
|
|
129
|
+
expectTypeOf(toolData.structuredContent).toExtend();
|
|
130
|
+
}
|
|
131
|
+
});
|
|
132
|
+
test("generateHelpers provides autocomplete for tool names in useToolInfo (widgets + registerTool)", () => {
|
|
133
|
+
const { useToolInfo } = generateHelpers();
|
|
134
|
+
useToolInfo();
|
|
135
|
+
useToolInfo();
|
|
136
|
+
useToolInfo();
|
|
137
|
+
useToolInfo();
|
|
138
|
+
useToolInfo();
|
|
139
|
+
useToolInfo();
|
|
140
|
+
// @ts-expect-error - "invalid-name" is not a valid tool name
|
|
141
|
+
useToolInfo();
|
|
142
|
+
});
|
|
143
|
+
test("useToolInfo infers input and output types", () => {
|
|
144
|
+
const { useToolInfo } = generateHelpers();
|
|
145
|
+
const toolInfo = useToolInfo();
|
|
146
|
+
expectTypeOf(toolInfo.input).toExtend();
|
|
147
|
+
if (toolInfo.status === "success") {
|
|
148
|
+
expectTypeOf(toolInfo.output.structuredContent).toExtend();
|
|
149
|
+
}
|
|
150
|
+
});
|
|
151
|
+
//# sourceMappingURL=generate-helpers.test-d.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generate-helpers.test-d.js","sourceRoot":"","sources":["../../../src/web/generate-helpers.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;AAGlC,IAAI,CAAC,qEAAqE,EAAE,GAAG,EAAE;IAG/E,YAAY,EAAS,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACtD,YAAY,EAAS,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IACzD,YAAY,EAAS,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;IACxD,YAAY,EAAS,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;IACxD,YAAY,EAAS,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAC;IAC/D,YAAY,EAAS,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0EAA0E,EAAE,GAAG,EAAE;IAGpF,YAAY,EAAS,CAAC,aAAa,EAOhC,CAAC;AACN,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;IAGrE,YAAY,EAAe,CAAC,aAAa,EAIrC,CAAC;IAIL,YAAY,EAAgB,CAAC,aAAa,EAEtC,CAAC;IAIL,YAAY,EAAkB,CAAC,aAAa,EAGxC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+EAA+E,EAAE,GAAG,EAAE;IAGzF,YAAY,EAAgB,CAAC,aAAa,EAOtC,CAAC;IAIL,YAAY,EAAiB,CAAC,aAAa,EAIvC,CAAC;IAML,YAAY,EAAmB,CAAC,aAAa,EAGzC,CAAC;IAGL,YAAY,EAAiB,CAAC,aAAa,EAAM,CAAC;AACpD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,sEAAsE,EAAE,GAAG,EAAE;IAGhF,YAAY,EAAwB,CAAC,aAAa,EAG9C,CAAC;IAIL,YAAY,EAAsB,CAAC,aAAa,EAG5C,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+EAA+E,EAAE,GAAG,EAAE;IACzF,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,WAAW,CAAC,eAAe,CAAC,CAAC;IAC7B,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAChC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC/B,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC/B,WAAW,CAAC,wBAAwB,CAAC,CAAC;IACtC,WAAW,CAAC,eAAe,CAAC,CAAC;IAE7B,6DAA6D;IAC7D,WAAW,CAAC,cAAc,CAAC,CAAC;AAC9B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;IACjE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,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;IAEnD,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAC;IACnE,aAAa,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;AAClD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uEAAuE,EAAE,GAAG,EAAE;IACjF,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAEnE,QAAQ,EAAE,CAAC;IAEX,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEb,aAAa,EAAE,CAAC;IAChB,aAAa,CAAC,EAAE,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;IACjE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAElD,+CAA+C;IAC/C,QAAQ,EAAE,CAAC;IAEX,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEb,mBAAmB;IACnB,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;AACrC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;IACxE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAExD,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE;QACjC,SAAS,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;YAC5B,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;YAC7D,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;QACD,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACvB,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;QACD,SAAS,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACnC,IAAI,QAAQ,EAAE,CAAC;gBACb,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;YACnE,CAAC;YACD,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;IAC3E,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAEpD,QAAQ,CAAC;QACP,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE;YACtB,YAAY,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QAC7D,CAAC;KACF,CAAC,CAAC;IAEH,QAAQ,CAAC,EAAE,EAAE;QACX,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE;YACtB,YAAY,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QAC7D,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;IACzD,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,WAAW,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5D,YAAY,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;IAEzE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAC;IACvE,MAAM,cAAc,GAAG,YAAY,EAAE,CAAC;IACtC,YAAY,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;AAC5E,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;IACpD,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,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;AAEH,IAAI,CAAC,wEAAwE,EAAE,GAAG,EAAE;IAClF,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC,wBAAwB,CAAC,CAAC;IACnE,IAAI,UAAU,EAAE,CAAC;QACf,YAAY,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAG/C,CAAC;IACP,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IACxD,IAAI,QAAQ,EAAE,CAAC;QACb,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAG7C,CAAC;IACP,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,8FAA8F,EAAE,GAAG,EAAE;IACxG,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,WAAW,EAAmB,CAAC;IAC/B,WAAW,EAAsB,CAAC;IAClC,WAAW,EAAqB,CAAC;IACjC,WAAW,EAAqB,CAAC;IACjC,WAAW,EAA4B,CAAC;IACxC,WAAW,EAAmB,CAAC;IAE/B,6DAA6D;IAC7D,WAAW,EAAkB,CAAC;AAChC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;IACrD,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,QAAQ,GAAG,WAAW,EAAmB,CAAC;IAEhD,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,EAA0C,CAAC;IAEhF,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAClC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAA2C,CAAC;IACtG,CAAC;AACH,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { describe, expect, it } from "vitest";
|
|
2
|
+
import { generateHelpers } from "./generate-helpers.js";
|
|
3
|
+
import { createMinimalTestServer } from "../test/utils.js";
|
|
4
|
+
const server = createMinimalTestServer();
|
|
5
|
+
describe("generateHelpers", () => {
|
|
6
|
+
it("should return an object with useCallTool hook", () => {
|
|
7
|
+
const hooks = generateHelpers();
|
|
8
|
+
expect(hooks).toHaveProperty("useCallTool");
|
|
9
|
+
expect(typeof hooks.useCallTool).toBe("function");
|
|
10
|
+
});
|
|
11
|
+
it("should return an object with useToolInfo hook", () => {
|
|
12
|
+
const hooks = generateHelpers();
|
|
13
|
+
expect(hooks).toHaveProperty("useToolInfo");
|
|
14
|
+
expect(typeof hooks.useToolInfo).toBe("function");
|
|
15
|
+
});
|
|
16
|
+
});
|
|
17
|
+
//# sourceMappingURL=generate-helpers.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generate-helpers.test.js","sourceRoot":"","sources":["../../../src/web/generate-helpers.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAE3D,MAAM,MAAM,GAAG,uBAAuB,EAAE,CAAC;AAGzC,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,KAAK,GAAG,eAAe,EAAc,CAAC;QAC5C,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;IAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,KAAK,GAAG,eAAe,EAAc,CAAC;QAC5C,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,4 +1,4 @@
|
|
|
1
|
-
export { useCallTool } from "./use-call-tool.js";
|
|
1
|
+
export { useCallTool, type CallToolState, type SideEffects, type CallToolFn, type CallToolAsyncFn, } from "./use-call-tool.js";
|
|
2
2
|
export { useDisplayMode } from "./use-display-mode.js";
|
|
3
3
|
export { useFiles } from "./use-files.js";
|
|
4
4
|
export { useLocale } from "./use-locale.js";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/web/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/web/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,GAKZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC"}
|
|
@@ -1,16 +1,63 @@
|
|
|
1
|
-
import type { CallToolArgs, CallToolResponse } from "../types.js";
|
|
2
|
-
type
|
|
1
|
+
import type { CallToolArgs, CallToolResponse, HasRequiredKeys } from "../types.js";
|
|
2
|
+
type CallToolIdleState = {
|
|
3
|
+
status: "idle";
|
|
4
|
+
isIdle: true;
|
|
5
|
+
isPending: false;
|
|
6
|
+
isSuccess: false;
|
|
7
|
+
isError: false;
|
|
8
|
+
data: undefined;
|
|
9
|
+
error: undefined;
|
|
10
|
+
};
|
|
11
|
+
type CallToolPendingState = {
|
|
12
|
+
status: "pending";
|
|
13
|
+
isIdle: false;
|
|
14
|
+
isPending: true;
|
|
15
|
+
isSuccess: false;
|
|
16
|
+
isError: false;
|
|
17
|
+
data: undefined;
|
|
18
|
+
error: undefined;
|
|
19
|
+
};
|
|
20
|
+
type CallToolSuccessState<TData extends CallToolResponse = CallToolResponse> = {
|
|
21
|
+
status: "success";
|
|
22
|
+
isIdle: false;
|
|
23
|
+
isPending: false;
|
|
24
|
+
isSuccess: true;
|
|
25
|
+
isError: false;
|
|
26
|
+
data: TData;
|
|
27
|
+
error: undefined;
|
|
28
|
+
};
|
|
29
|
+
type CallToolErrorState = {
|
|
30
|
+
status: "error";
|
|
31
|
+
isIdle: false;
|
|
32
|
+
isPending: false;
|
|
33
|
+
isSuccess: false;
|
|
34
|
+
isError: true;
|
|
35
|
+
data: undefined;
|
|
36
|
+
error: unknown;
|
|
37
|
+
};
|
|
38
|
+
export type CallToolState<TData extends CallToolResponse = CallToolResponse> = CallToolIdleState | CallToolPendingState | CallToolSuccessState<TData> | CallToolErrorState;
|
|
39
|
+
export type SideEffects<ToolArgs, ToolResponse> = {
|
|
3
40
|
onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
|
|
4
41
|
onError?: (error: unknown, toolArgs: ToolArgs) => void;
|
|
5
42
|
onSettled?: (data: ToolResponse | undefined, error: unknown | undefined, toolArgs: ToolArgs) => void;
|
|
6
43
|
};
|
|
7
|
-
type
|
|
44
|
+
type IsArgsOptional<T> = [T] extends [null] ? true : HasRequiredKeys<T> extends false ? true : false;
|
|
45
|
+
export type CallToolFn<TArgs, TResponse> = IsArgsOptional<TArgs> extends true ? {
|
|
46
|
+
(): void;
|
|
47
|
+
(sideEffects: SideEffects<TArgs, TResponse>): void;
|
|
48
|
+
(args: TArgs): void;
|
|
49
|
+
(args: TArgs, sideEffects: SideEffects<TArgs, TResponse>): void;
|
|
50
|
+
} : {
|
|
51
|
+
(args: TArgs): void;
|
|
52
|
+
(args: TArgs, sideEffects: SideEffects<TArgs, TResponse>): void;
|
|
53
|
+
};
|
|
54
|
+
export type CallToolAsyncFn<TArgs, TResponse> = IsArgsOptional<TArgs> extends true ? {
|
|
55
|
+
(): Promise<TResponse>;
|
|
56
|
+
(args: TArgs): Promise<TResponse>;
|
|
57
|
+
} : (args: TArgs) => Promise<TResponse>;
|
|
8
58
|
type ToolResponseSignature = Pick<CallToolResponse, "structuredContent" | "meta">;
|
|
9
59
|
export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends Partial<ToolResponseSignature> = {}>(name: string) => {
|
|
10
|
-
callTool:
|
|
11
|
-
(sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
12
|
-
(toolArgs: ToolArgs, sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
13
|
-
};
|
|
60
|
+
callTool: CallToolFn<ToolArgs, CallToolResponse & ToolResponse>;
|
|
14
61
|
callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
|
|
15
62
|
status: "idle";
|
|
16
63
|
isIdle: true;
|
|
@@ -20,10 +67,7 @@ export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolRes
|
|
|
20
67
|
data: undefined;
|
|
21
68
|
error: undefined;
|
|
22
69
|
} | {
|
|
23
|
-
callTool:
|
|
24
|
-
(sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
25
|
-
(toolArgs: ToolArgs, sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
26
|
-
};
|
|
70
|
+
callTool: CallToolFn<ToolArgs, CallToolResponse & ToolResponse>;
|
|
27
71
|
callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
|
|
28
72
|
status: "pending";
|
|
29
73
|
isIdle: false;
|
|
@@ -33,10 +77,7 @@ export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolRes
|
|
|
33
77
|
data: undefined;
|
|
34
78
|
error: undefined;
|
|
35
79
|
} | {
|
|
36
|
-
callTool:
|
|
37
|
-
(sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
38
|
-
(toolArgs: ToolArgs, sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
39
|
-
};
|
|
80
|
+
callTool: CallToolFn<ToolArgs, CallToolResponse & ToolResponse>;
|
|
40
81
|
callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
|
|
41
82
|
status: "error";
|
|
42
83
|
isIdle: false;
|
|
@@ -46,10 +87,7 @@ export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolRes
|
|
|
46
87
|
data: undefined;
|
|
47
88
|
error: unknown;
|
|
48
89
|
} | {
|
|
49
|
-
callTool:
|
|
50
|
-
(sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
51
|
-
(toolArgs: ToolArgs, sideEffects?: SideEffects<ToolArgs, CallToolResponse & ToolResponse>): void;
|
|
52
|
-
};
|
|
90
|
+
callTool: CallToolFn<ToolArgs, CallToolResponse & ToolResponse>;
|
|
53
91
|
callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
|
|
54
92
|
status: "success";
|
|
55
93
|
isIdle: false;
|
|
@@ -13,13 +13,13 @@ export const useCallTool = (name) => {
|
|
|
13
13
|
throw error;
|
|
14
14
|
}
|
|
15
15
|
};
|
|
16
|
-
const callToolAsync = (
|
|
16
|
+
const callToolAsync = ((toolArgs) => {
|
|
17
17
|
if (toolArgs === undefined) {
|
|
18
18
|
return execute(null);
|
|
19
19
|
}
|
|
20
20
|
return execute(toolArgs);
|
|
21
21
|
});
|
|
22
|
-
|
|
22
|
+
const callTool = ((firstArg, sideEffects) => {
|
|
23
23
|
let toolArgs;
|
|
24
24
|
if (firstArg &&
|
|
25
25
|
typeof firstArg === "object" &&
|
|
@@ -34,22 +34,14 @@ export const useCallTool = (name) => {
|
|
|
34
34
|
}
|
|
35
35
|
execute(toolArgs)
|
|
36
36
|
.then((data) => {
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
}
|
|
40
|
-
if (sideEffects?.onSettled) {
|
|
41
|
-
sideEffects.onSettled(data, undefined, toolArgs);
|
|
42
|
-
}
|
|
37
|
+
sideEffects?.onSuccess?.(data, toolArgs);
|
|
38
|
+
sideEffects?.onSettled?.(data, undefined, toolArgs);
|
|
43
39
|
})
|
|
44
40
|
.catch((error) => {
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
}
|
|
48
|
-
if (sideEffects?.onSettled) {
|
|
49
|
-
sideEffects.onSettled(undefined, error, toolArgs);
|
|
50
|
-
}
|
|
41
|
+
sideEffects?.onError?.(error, toolArgs);
|
|
42
|
+
sideEffects?.onSettled?.(undefined, error, toolArgs);
|
|
51
43
|
});
|
|
52
|
-
}
|
|
44
|
+
});
|
|
53
45
|
const callToolState = {
|
|
54
46
|
status,
|
|
55
47
|
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;AA0FjC,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,CAAC,QAAmB,EAAE,EAAE;QAC7C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,OAAO,CAAC,IAAgB,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC,CAAwD,CAAC;IAE1D,MAAM,QAAQ,GAAG,CAAC,CAChB,QAAqE,EACrE,WAA6D,EAC7D,EAAE;QACF,IAAI,QAAkB,CAAC;QACvB,IACE,QAAQ;YACR,OAAO,QAAQ,KAAK,QAAQ;YAC5B,CAAC,WAAW,IAAI,QAAQ;gBACtB,SAAS,IAAI,QAAQ;gBACrB,WAAW,IAAI,QAAQ,CAAC,EAC1B,CAAC;YACD,QAAQ,GAAG,IAAgB,CAAC,CAAC,uBAAuB;YACpD,WAAW,GAAG,QAAQ,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAa,CAAC;QACpE,CAAC;QAED,OAAO,CAAC,QAAQ,CAAC;aACd,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACb,WAAW,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACzC,WAAW,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACtD,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,WAAW,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACxC,WAAW,EAAE,SAAS,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACP,CAAC,CAAmD,CAAC;IAErD,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"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { expectTypeOf, test } from "vitest";
|
|
2
|
+
import { useCallTool } from "./use-call-tool.js";
|
|
3
|
+
test("callTool can be called without args when ToolArgs is null", () => {
|
|
4
|
+
const { callTool, callToolAsync } = useCallTool("test-tool");
|
|
5
|
+
callTool();
|
|
6
|
+
callTool({ onSuccess: () => { } });
|
|
7
|
+
callToolAsync();
|
|
8
|
+
});
|
|
9
|
+
test("callTool requires args when ToolArgs has required properties", () => {
|
|
10
|
+
const { callTool, callToolAsync } = useCallTool("test-tool");
|
|
11
|
+
// @ts-expect-error - query is required
|
|
12
|
+
callTool();
|
|
13
|
+
callTool({ query: "test" });
|
|
14
|
+
callTool({ query: "test" }, { onSuccess: () => { } });
|
|
15
|
+
// @ts-expect-error - query is required
|
|
16
|
+
callToolAsync();
|
|
17
|
+
callToolAsync({ query: "test" });
|
|
18
|
+
});
|
|
19
|
+
test("callTool supports sideEffects with correct types", () => {
|
|
20
|
+
const { callTool } = useCallTool("test-tool");
|
|
21
|
+
callTool({ id: 1 }, {
|
|
22
|
+
onSuccess: (data, args) => {
|
|
23
|
+
expectTypeOf(data.structuredContent.result).toBeString();
|
|
24
|
+
expectTypeOf(args.id).toBeNumber();
|
|
25
|
+
},
|
|
26
|
+
onError: (error, args) => {
|
|
27
|
+
expectTypeOf(error).toBeUnknown();
|
|
28
|
+
expectTypeOf(args.id).toBeNumber();
|
|
29
|
+
},
|
|
30
|
+
onSettled: (data, error, args) => {
|
|
31
|
+
if (data) {
|
|
32
|
+
expectTypeOf(data.structuredContent.result).toBeString();
|
|
33
|
+
}
|
|
34
|
+
expectTypeOf(error).toEqualTypeOf();
|
|
35
|
+
expectTypeOf(args.id).toBeNumber();
|
|
36
|
+
},
|
|
37
|
+
});
|
|
38
|
+
});
|
|
39
|
+
test("callTool allows sideEffects as first arg when ToolArgs is null", () => {
|
|
40
|
+
const { callTool } = useCallTool("test-tool");
|
|
41
|
+
callTool({
|
|
42
|
+
onSuccess: (data) => {
|
|
43
|
+
expectTypeOf(data.structuredContent.value).toBeNumber();
|
|
44
|
+
},
|
|
45
|
+
});
|
|
46
|
+
});
|
|
47
|
+
test("callToolAsync returns correctly typed promise", () => {
|
|
48
|
+
const { callToolAsync } = useCallTool("test-tool");
|
|
49
|
+
const promise = callToolAsync({ name: "test" });
|
|
50
|
+
expectTypeOf(promise).resolves.toHaveProperty("structuredContent");
|
|
51
|
+
expectTypeOf(promise).resolves.toHaveProperty("meta");
|
|
52
|
+
});
|
|
53
|
+
test("state narrowing works correctly with status", () => {
|
|
54
|
+
const result = useCallTool("test-tool");
|
|
55
|
+
if (result.status === "idle") {
|
|
56
|
+
expectTypeOf(result.isIdle).toEqualTypeOf();
|
|
57
|
+
expectTypeOf(result.data).toEqualTypeOf();
|
|
58
|
+
}
|
|
59
|
+
if (result.status === "pending") {
|
|
60
|
+
expectTypeOf(result.isPending).toEqualTypeOf();
|
|
61
|
+
expectTypeOf(result.data).toEqualTypeOf();
|
|
62
|
+
}
|
|
63
|
+
if (result.status === "success") {
|
|
64
|
+
expectTypeOf(result.isSuccess).toEqualTypeOf();
|
|
65
|
+
expectTypeOf(result.data).not.toEqualTypeOf();
|
|
66
|
+
expectTypeOf(result.data.structuredContent.data).toBeString();
|
|
67
|
+
}
|
|
68
|
+
if (result.status === "error") {
|
|
69
|
+
expectTypeOf(result.isError).toEqualTypeOf();
|
|
70
|
+
expectTypeOf(result.error).toBeUnknown();
|
|
71
|
+
}
|
|
72
|
+
});
|
|
73
|
+
test("state narrowing works correctly with boolean flags", () => {
|
|
74
|
+
const result = useCallTool("test-tool");
|
|
75
|
+
if (result.isIdle) {
|
|
76
|
+
expectTypeOf(result.status).toEqualTypeOf();
|
|
77
|
+
}
|
|
78
|
+
if (result.isPending) {
|
|
79
|
+
expectTypeOf(result.status).toEqualTypeOf();
|
|
80
|
+
}
|
|
81
|
+
if (result.isSuccess) {
|
|
82
|
+
expectTypeOf(result.status).toEqualTypeOf();
|
|
83
|
+
expectTypeOf(result.data.structuredContent.items).toBeArray();
|
|
84
|
+
}
|
|
85
|
+
if (result.isError) {
|
|
86
|
+
expectTypeOf(result.status).toEqualTypeOf();
|
|
87
|
+
}
|
|
88
|
+
});
|
|
89
|
+
test("CallToolState type is correctly exported and usable", () => {
|
|
90
|
+
const state = {};
|
|
91
|
+
if (state.status === "success") {
|
|
92
|
+
expectTypeOf(state.data.structuredContent.foo).toBeString();
|
|
93
|
+
}
|
|
94
|
+
});
|
|
95
|
+
test("SideEffects type is correctly exported and usable", () => {
|
|
96
|
+
const sideEffects = {
|
|
97
|
+
onSuccess: (data, args) => {
|
|
98
|
+
expectTypeOf(data.structuredContent.y).toBeString();
|
|
99
|
+
expectTypeOf(args.x).toBeNumber();
|
|
100
|
+
},
|
|
101
|
+
};
|
|
102
|
+
expectTypeOf(sideEffects).toHaveProperty("onSuccess");
|
|
103
|
+
});
|
|
104
|
+
//# sourceMappingURL=use-call-tool.test-d.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-call-tool.test-d.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-call-tool.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAwC,MAAM,oBAAoB,CAAC;AAGvF,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;IACrE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAO,WAAW,CAAC,CAAC;IACnE,QAAQ,EAAE,CAAC;IACX,QAAQ,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC,CAAC;IAClC,aAAa,EAAE,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;IAExE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAO,WAAW,CAAC,CAAC;IAEnE,uCAAuC;IACvC,QAAQ,EAAE,CAAC;IAEX,QAAQ,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IAC5B,QAAQ,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC,CAAC;IAErD,uCAAuC;IACvC,aAAa,EAAE,CAAC;IAChB,aAAa,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kDAAkD,EAAE,GAAG,EAAE;IAI5D,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAE9D,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE;QAClB,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YACxB,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC;YACzD,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;QACrC,CAAC;QACD,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACvB,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;QACrC,CAAC;QACD,SAAS,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC/B,IAAI,IAAI,EAAE,CAAC;gBACT,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC;YAC3D,CAAC;YACD,YAAY,CAAC,KAAK,CAAC,CAAC,aAAa,EAAuB,CAAC;YACzD,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;QACrC,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,gEAAgE,EAAE,GAAG,EAAE;IAE1E,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAE9D,QAAQ,CAAC;QACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;YAClB,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;QAC1D,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;IAIzD,MAAM,EAAE,aAAa,EAAE,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAEnE,MAAM,OAAO,GAAG,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAEhD,YAAY,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;IACnE,YAAY,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6CAA6C,EAAE,GAAG,EAAE;IAEvD,MAAM,MAAM,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAExD,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAC7B,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAQ,CAAC;QAClD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,EAAa,CAAC;IACvD,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,EAAQ,CAAC;QACrD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,EAAa,CAAC;IACvD,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,EAAQ,CAAC;QACrD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,aAAa,EAAa,CAAC;QACzD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;IAChE,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;QAC9B,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAQ,CAAC;QACnD,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;IAC3C,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,oDAAoD,EAAE,GAAG,EAAE;IAE9D,MAAM,MAAM,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAExD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAU,CAAC;IACtD,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAa,CAAC;IACzD,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAa,CAAC;QACvD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC;IAChE,CAAC;IAED,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAW,CAAC;IACvD,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;IAI/D,MAAM,KAAK,GAAY,EAAa,CAAC;IAErC,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC;IAC9D,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;IAI7D,MAAM,WAAW,GAAgC;QAC/C,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YACxB,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;YACpD,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QACpC,CAAC;KACF,CAAC;IAEF,YAAY,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { UnknownObject } from "../types.js";
|
|
2
|
-
type ToolPendingState<ToolInput extends UnknownObject> = {
|
|
2
|
+
export type ToolPendingState<ToolInput extends UnknownObject> = {
|
|
3
3
|
status: "pending";
|
|
4
4
|
isPending: true;
|
|
5
5
|
isSuccess: false;
|
|
@@ -7,7 +7,7 @@ type ToolPendingState<ToolInput extends UnknownObject> = {
|
|
|
7
7
|
output: undefined;
|
|
8
8
|
responseMetadata: undefined;
|
|
9
9
|
};
|
|
10
|
-
type ToolSuccessState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = {
|
|
10
|
+
export type ToolSuccessState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = {
|
|
11
11
|
status: "success";
|
|
12
12
|
isPending: false;
|
|
13
13
|
isSuccess: true;
|
|
@@ -15,7 +15,7 @@ type ToolSuccessState<ToolInput extends UnknownObject, ToolOutput extends Unknow
|
|
|
15
15
|
output: ToolOutput;
|
|
16
16
|
responseMetadata: ToolResponseMetadata;
|
|
17
17
|
};
|
|
18
|
-
type ToolState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = ToolPendingState<ToolInput> | ToolSuccessState<ToolInput, ToolOutput, ToolResponseMetadata>;
|
|
18
|
+
export type ToolState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = ToolPendingState<ToolInput> | ToolSuccessState<ToolInput, ToolOutput, ToolResponseMetadata>;
|
|
19
19
|
type ToolSignature = {
|
|
20
20
|
input: UnknownObject;
|
|
21
21
|
output: UnknownObject;
|
package/dist/src/web/index.d.ts
CHANGED
package/dist/src/web/index.js
CHANGED