skybridge 0.0.0-dev.f5a2ffe → 0.0.0-dev.f615683
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 +73 -148
- package/dist/src/emulator/assets/index-BjyctK8j.js +133 -0
- package/dist/src/emulator/assets/index-BlZAHQDQ.css +1 -0
- package/dist/src/emulator/favicon.ico +0 -0
- package/dist/src/emulator/index.html +14 -0
- package/dist/src/server/emulatorStaticServer.d.ts +15 -0
- package/dist/src/server/emulatorStaticServer.js +38 -0
- package/dist/src/server/emulatorStaticServer.js.map +1 -0
- package/dist/src/server/index.d.ts +1 -2
- package/dist/src/server/index.js +1 -2
- package/dist/src/server/index.js.map +1 -1
- package/dist/src/server/inferUtilityTypes.d.ts +54 -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 +52 -9
- package/dist/src/server/server.js +12 -4
- package/dist/src/server/server.js.map +1 -1
- package/dist/src/server/templateHelper.js +2 -2
- package/dist/src/server/templateHelper.js.map +1 -1
- package/dist/src/server/widgetsDevServer.js +2 -2
- package/dist/src/server/widgetsDevServer.js.map +1 -1
- package/dist/src/test/utils.d.ts +62 -1
- package/dist/src/test/utils.js +124 -3
- package/dist/src/test/utils.js.map +1 -1
- package/dist/src/test/widget.test.js +19 -20
- package/dist/src/test/widget.test.js.map +1 -1
- package/dist/src/web/create-store.d.ts +3 -0
- package/dist/src/web/create-store.js +25 -0
- package/dist/src/web/create-store.js.map +1 -0
- package/dist/src/web/create-store.test.js +70 -0
- package/dist/src/web/create-store.test.js.map +1 -0
- package/dist/src/web/data-llm.d.ts +14 -0
- package/dist/src/web/data-llm.js +68 -0
- package/dist/src/web/data-llm.js.map +1 -0
- package/dist/src/web/data-llm.test.d.ts +1 -0
- package/dist/src/web/data-llm.test.js +76 -0
- package/dist/src/web/data-llm.test.js.map +1 -0
- package/dist/src/web/generate-helpers.d.ts +113 -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 +154 -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/helpers/state.d.ts +7 -0
- package/dist/src/web/helpers/state.js +40 -0
- package/dist/src/web/helpers/state.js.map +1 -0
- package/dist/src/web/helpers/state.test.d.ts +1 -0
- package/dist/src/web/helpers/state.test.js +53 -0
- package/dist/src/web/helpers/state.test.js.map +1 -0
- package/dist/src/web/hooks/index.d.ts +10 -5
- package/dist/src/web/hooks/index.js +10 -5
- package/dist/src/web/hooks/index.js.map +1 -1
- package/dist/src/web/hooks/use-call-tool.d.ts +69 -23
- package/dist/src/web/hooks/use-call-tool.js +26 -10
- 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-call-tool.test.js +108 -3
- package/dist/src/web/hooks/use-call-tool.test.js.map +1 -1
- package/dist/src/web/hooks/use-display-mode.js.map +1 -1
- package/dist/src/web/hooks/use-display-mode.test.js +2 -2
- package/dist/src/web/hooks/use-display-mode.test.js.map +1 -1
- package/dist/src/web/hooks/use-files.d.ts +10 -0
- package/dist/src/web/hooks/use-files.js +7 -0
- package/dist/src/web/hooks/use-files.js.map +1 -0
- package/dist/src/web/hooks/use-files.test.d.ts +1 -0
- package/dist/src/web/hooks/use-files.test.js +29 -0
- package/dist/src/web/hooks/use-files.test.js.map +1 -0
- package/dist/src/web/hooks/use-locale.d.ts +1 -0
- package/dist/src/web/hooks/use-locale.js +5 -0
- package/dist/src/web/hooks/use-locale.js.map +1 -0
- package/dist/src/web/hooks/use-locale.test.d.ts +1 -0
- package/dist/src/web/hooks/use-locale.test.js +21 -0
- package/dist/src/web/hooks/use-locale.test.js.map +1 -0
- package/dist/src/web/hooks/use-open-external.d.ts +1 -0
- package/dist/src/web/hooks/use-open-external.js +6 -0
- package/dist/src/web/hooks/use-open-external.js.map +1 -0
- package/dist/src/web/hooks/use-open-external.test.d.ts +1 -0
- package/dist/src/web/hooks/use-open-external.test.js +24 -0
- package/dist/src/web/hooks/use-open-external.test.js.map +1 -0
- package/dist/src/web/hooks/use-openai-global.d.ts +2 -2
- package/dist/src/web/hooks/use-openai-global.js +4 -2
- package/dist/src/web/hooks/use-openai-global.js.map +1 -1
- package/dist/src/web/hooks/use-request-modal.d.ts +6 -0
- package/dist/src/web/hooks/use-request-modal.js +9 -0
- package/dist/src/web/hooks/use-request-modal.js.map +1 -0
- package/dist/src/web/hooks/use-request-modal.test.d.ts +1 -0
- package/dist/src/web/hooks/use-request-modal.test.js +24 -0
- package/dist/src/web/hooks/use-request-modal.test.js.map +1 -0
- package/dist/src/web/hooks/use-send-follow-up-message.d.ts +1 -0
- package/dist/src/web/hooks/use-send-follow-up-message.js +11 -0
- package/dist/src/web/hooks/use-send-follow-up-message.js.map +1 -0
- package/dist/src/web/hooks/use-theme.d.ts +1 -0
- package/dist/src/web/hooks/use-theme.js +5 -0
- package/dist/src/web/hooks/use-theme.js.map +1 -0
- package/dist/src/web/hooks/use-theme.test.d.ts +1 -0
- package/dist/src/web/hooks/use-theme.test.js +26 -0
- package/dist/src/web/hooks/use-theme.test.js.map +1 -0
- package/dist/src/web/hooks/use-tool-info.d.ts +24 -4
- package/dist/src/web/hooks/use-tool-info.js +17 -4
- package/dist/src/web/hooks/use-tool-info.js.map +1 -1
- package/dist/src/web/hooks/use-tool-info.test-d.d.ts +1 -0
- package/dist/src/web/hooks/use-tool-info.test-d.js +73 -0
- package/dist/src/web/hooks/use-tool-info.test-d.js.map +1 -0
- package/dist/src/web/hooks/use-tool-info.test.js +36 -15
- package/dist/src/web/hooks/use-tool-info.test.js.map +1 -1
- package/dist/src/web/hooks/use-user-agent.d.ts +1 -0
- package/dist/src/web/hooks/use-user-agent.js +5 -0
- package/dist/src/web/hooks/use-user-agent.js.map +1 -0
- package/dist/src/web/hooks/use-user-agent.test.d.ts +1 -0
- package/dist/src/web/hooks/use-user-agent.test.js +31 -0
- package/dist/src/web/hooks/use-user-agent.test.js.map +1 -0
- package/dist/src/web/hooks/use-widget-state.js +9 -7
- package/dist/src/web/hooks/use-widget-state.js.map +1 -1
- package/dist/src/web/hooks/use-widget-state.test.js +2 -3
- package/dist/src/web/hooks/use-widget-state.test.js.map +1 -1
- package/dist/src/web/index.d.ts +6 -3
- package/dist/src/web/index.js +6 -3
- package/dist/src/web/index.js.map +1 -1
- package/dist/src/web/mount-widget.d.ts +1 -1
- package/dist/src/web/mount-widget.js +35 -1
- package/dist/src/web/mount-widget.js.map +1 -1
- package/dist/src/web/plugin/data-llm.test.d.ts +1 -0
- package/dist/src/web/plugin/data-llm.test.js +81 -0
- package/dist/src/web/plugin/data-llm.test.js.map +1 -0
- package/dist/src/web/{plugin.js → plugin/plugin.js} +5 -0
- package/dist/src/web/plugin/plugin.js.map +1 -0
- package/dist/src/web/plugin/transform-data-llm.d.ts +12 -0
- package/dist/src/web/plugin/transform-data-llm.js +93 -0
- package/dist/src/web/plugin/transform-data-llm.js.map +1 -0
- package/dist/src/web/plugin/transform-data-llm.test.d.ts +1 -0
- package/dist/src/web/plugin/transform-data-llm.test.js +81 -0
- package/dist/src/web/plugin/transform-data-llm.test.js.map +1 -0
- package/dist/src/web/proxy.d.ts +1 -0
- package/dist/src/web/proxy.js +48 -0
- package/dist/src/web/proxy.js.map +1 -0
- package/dist/src/web/types.d.ts +47 -18
- package/dist/src/web/types.js +1 -0
- package/dist/src/web/types.js.map +1 -1
- package/dist/vitest.config.js +0 -1
- package/dist/vitest.config.js.map +1 -1
- package/package.json +17 -6
- package/dist/src/test/setup.js +0 -9
- package/dist/src/test/setup.js.map +0 -1
- package/dist/src/web/hooks/use-tool-output.d.ts +0 -4
- package/dist/src/web/hooks/use-tool-output.js +0 -9
- package/dist/src/web/hooks/use-tool-output.js.map +0 -1
- package/dist/src/web/hooks/use-tool-response-metadata.d.ts +0 -4
- package/dist/src/web/hooks/use-tool-response-metadata.js +0 -8
- package/dist/src/web/hooks/use-tool-response-metadata.js.map +0 -1
- package/dist/src/web/plugin.js.map +0 -1
- /package/dist/src/{test/setup.d.ts → web/create-store.test.d.ts} +0 -0
- /package/dist/src/web/{plugin.d.ts → plugin/plugin.d.ts} +0 -0
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import type { InferTools, ToolInput, ToolOutput } from "../server/index.js";
|
|
2
|
+
import { type CallToolAsyncFn, type CallToolFn, type CallToolState } from "./hooks/use-call-tool.js";
|
|
3
|
+
import { type ToolState } from "./hooks/use-tool-info.js";
|
|
4
|
+
import type { CallToolResponse, Objectify, Prettify } from "./types.js";
|
|
5
|
+
type TypedCallToolResponse<TOutput> = CallToolResponse & {
|
|
6
|
+
structuredContent: TOutput;
|
|
7
|
+
};
|
|
8
|
+
type TypedCallToolReturn<TInput, TOutput> = Prettify<CallToolState<TypedCallToolResponse<TOutput>> & {
|
|
9
|
+
callTool: CallToolFn<TInput, TypedCallToolResponse<TOutput>>;
|
|
10
|
+
callToolAsync: CallToolAsyncFn<TInput, TypedCallToolResponse<TOutput>>;
|
|
11
|
+
}>;
|
|
12
|
+
type TypedToolInfoReturn<TInput, TOutput> = ToolState<Objectify<TInput>, Objectify<TOutput>, Objectify<{}>>;
|
|
13
|
+
/**
|
|
14
|
+
* Creates typed versions of skybridge hooks with full type inference
|
|
15
|
+
* for tool names, inputs, and outputs.
|
|
16
|
+
*
|
|
17
|
+
* This is the recommended way to use skybridge hooks in your widgets.
|
|
18
|
+
* Set this up once in a dedicated file and export the typed hooks for use across your app.
|
|
19
|
+
*
|
|
20
|
+
* @typeParam ServerType - The type of your McpServer instance (use `typeof server`).
|
|
21
|
+
* Must be a server instance created with method chaining.
|
|
22
|
+
* TypeScript will validate that tools can be inferred from this type.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```typescript
|
|
26
|
+
* // server/src/index.ts
|
|
27
|
+
* const server = new McpServer({ name: "my-app", version: "1.0" }, {})
|
|
28
|
+
* .widget("search-voyage", {}, {
|
|
29
|
+
* inputSchema: { destination: z.string() },
|
|
30
|
+
* outputSchema: { results: z.array(z.string()) },
|
|
31
|
+
* }, async ({ destination }) => {
|
|
32
|
+
* return { content: [{ type: "text", text: `Found trips to ${destination}` }] };
|
|
33
|
+
* });
|
|
34
|
+
*
|
|
35
|
+
* export type AppType = typeof server;
|
|
36
|
+
* ```
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```typescript
|
|
40
|
+
* // web/src/skybridge.ts (one-time setup)
|
|
41
|
+
* import type { AppType } from "../server";
|
|
42
|
+
* import { generateHelpers } from "skybridge/web";
|
|
43
|
+
*
|
|
44
|
+
* export const { useCallTool, useToolInfo } = generateHelpers<AppType>();
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```typescript
|
|
49
|
+
* // web/src/widgets/search.tsx (usage)
|
|
50
|
+
* import { useCallTool, useToolInfo } from "../skybridge";
|
|
51
|
+
*
|
|
52
|
+
* export function SearchWidget() {
|
|
53
|
+
* const { callTool, data } = useCallTool("search-voyage");
|
|
54
|
+
* // ^ autocomplete for tool names
|
|
55
|
+
* callTool({ destination: "Spain" });
|
|
56
|
+
* // ^ autocomplete for input fields
|
|
57
|
+
*
|
|
58
|
+
* const toolInfo = useToolInfo<"search-voyage">();
|
|
59
|
+
* // ^ autocomplete for widget names
|
|
60
|
+
* // toolInfo.input is typed based on widget input schema
|
|
61
|
+
* // toolInfo.output.structuredContent is typed based on widget output schema
|
|
62
|
+
* }
|
|
63
|
+
* ```
|
|
64
|
+
*/
|
|
65
|
+
export declare function generateHelpers<ServerType = never>(): {
|
|
66
|
+
/**
|
|
67
|
+
* Typed version of `useCallTool` that provides autocomplete for tool names
|
|
68
|
+
* and type inference for inputs and outputs.
|
|
69
|
+
*
|
|
70
|
+
* @param name - The name of the widget to call. Autocompletes based on your server's widget registry.
|
|
71
|
+
* @returns A hook with typed `callTool` function and `data` property.
|
|
72
|
+
*
|
|
73
|
+
* @example
|
|
74
|
+
* ```typescript
|
|
75
|
+
* const { callTool, data, isPending } = useCallTool("search-voyage");
|
|
76
|
+
* // TypeScript knows callTool expects { destination: string }
|
|
77
|
+
* callTool({ destination: "Spain" });
|
|
78
|
+
*
|
|
79
|
+
* // data.structuredContent is typed based on your outputSchema
|
|
80
|
+
* if (data) {
|
|
81
|
+
* console.log(data.structuredContent.results);
|
|
82
|
+
* }
|
|
83
|
+
* ```
|
|
84
|
+
*/
|
|
85
|
+
useCallTool: <ToolName extends keyof InferTools<ServerType> & string>(name: ToolName) => TypedCallToolReturn<ToolInput<ServerType, ToolName>, ToolOutput<ServerType, ToolName>>;
|
|
86
|
+
/**
|
|
87
|
+
* Typed version of `useToolInfo` that provides autocomplete for widget names
|
|
88
|
+
* and type inference for inputs, outputs, and responseMetadata.
|
|
89
|
+
*
|
|
90
|
+
* @typeParam K - The name of the widget. Autocompletes based on your server's widget registry.
|
|
91
|
+
* @returns A discriminated union with `status: "pending" | "success"` that narrows correctly.
|
|
92
|
+
*
|
|
93
|
+
* @example
|
|
94
|
+
* ```typescript
|
|
95
|
+
* const toolInfo = useToolInfo<"search-voyage">();
|
|
96
|
+
* // toolInfo.input is typed as { destination: string; ... }
|
|
97
|
+
* // toolInfo.output is typed as { results: Array<...>; ... }
|
|
98
|
+
* // toolInfo.status narrows correctly: "pending" | "success"
|
|
99
|
+
*
|
|
100
|
+
* if (toolInfo.isPending) {
|
|
101
|
+
* // TypeScript knows output is undefined here
|
|
102
|
+
* console.log(toolInfo.input.destination);
|
|
103
|
+
* }
|
|
104
|
+
*
|
|
105
|
+
* if (toolInfo.isSuccess) {
|
|
106
|
+
* // TypeScript knows output is defined here
|
|
107
|
+
* console.log(toolInfo.output.results);
|
|
108
|
+
* }
|
|
109
|
+
* ```
|
|
110
|
+
*/
|
|
111
|
+
useToolInfo: <ToolName extends keyof InferTools<ServerType> & string>() => TypedToolInfoReturn<ToolInput<ServerType, ToolName>, ToolOutput<ServerType, ToolName>>;
|
|
112
|
+
};
|
|
113
|
+
export {};
|
|
@@ -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 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.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":"AACA,OAAO,EAIL,WAAW,GACZ,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAkB,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAoBvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,UAAU,eAAe;IAI7B,OAAO;QACL;;;;;;;;;;;;;;;;;;WAkBG;QACH,WAAW,EAAE,CACX,IAAc,EAId,EAAE;YACF,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,154 @@
|
|
|
1
|
+
import { expectTypeOf, test } from "vitest";
|
|
2
|
+
import { createTestServer } from "../test/utils.js";
|
|
3
|
+
import { generateHelpers } from "./generate-helpers.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 } = 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(error).toBeUnknown();
|
|
86
|
+
expectTypeOf(args.destination).toBeString();
|
|
87
|
+
},
|
|
88
|
+
});
|
|
89
|
+
});
|
|
90
|
+
test("callTool supports sideEffects for tools with no required inputs", () => {
|
|
91
|
+
const { useCallTool } = generateHelpers();
|
|
92
|
+
const { callTool } = useCallTool("no-input-widget");
|
|
93
|
+
callTool({
|
|
94
|
+
onSuccess: (response) => {
|
|
95
|
+
expectTypeOf(response).toHaveProperty("structuredContent");
|
|
96
|
+
},
|
|
97
|
+
});
|
|
98
|
+
callTool({}, {
|
|
99
|
+
onSuccess: (response) => {
|
|
100
|
+
expectTypeOf(response).toHaveProperty("structuredContent");
|
|
101
|
+
},
|
|
102
|
+
});
|
|
103
|
+
});
|
|
104
|
+
test("callToolAsync returns correctly typed promise", () => {
|
|
105
|
+
const { useCallTool } = generateHelpers();
|
|
106
|
+
const { callToolAsync: searchAsync } = useCallTool("search-voyage");
|
|
107
|
+
const searchPromise = searchAsync({ destination: "Spain" });
|
|
108
|
+
expectTypeOf(searchPromise).resolves.toHaveProperty("structuredContent");
|
|
109
|
+
const { callToolAsync: noInputAsync } = useCallTool("no-input-widget");
|
|
110
|
+
const noInputPromise = noInputAsync();
|
|
111
|
+
expectTypeOf(noInputPromise).resolves.toHaveProperty("structuredContent");
|
|
112
|
+
});
|
|
113
|
+
test("useCallTool returns correctly typed data", () => {
|
|
114
|
+
const { useCallTool } = generateHelpers();
|
|
115
|
+
const { data } = useCallTool("search-voyage");
|
|
116
|
+
if (data) {
|
|
117
|
+
expectTypeOf(data.structuredContent).toExtend();
|
|
118
|
+
expectTypeOf(data.structuredContent.results).toBeArray();
|
|
119
|
+
expectTypeOf(data.structuredContent.totalCount).toBeNumber();
|
|
120
|
+
}
|
|
121
|
+
});
|
|
122
|
+
test("useCallTool returns correctly typed data for callback-inferred outputs", () => {
|
|
123
|
+
const { useCallTool } = generateHelpers();
|
|
124
|
+
const { data: widgetData } = useCallTool("inferred-output-widget");
|
|
125
|
+
if (widgetData) {
|
|
126
|
+
expectTypeOf(widgetData.structuredContent).toExtend();
|
|
127
|
+
}
|
|
128
|
+
const { data: toolData } = useCallTool("inferred-tool");
|
|
129
|
+
if (toolData) {
|
|
130
|
+
expectTypeOf(toolData.structuredContent).toExtend();
|
|
131
|
+
}
|
|
132
|
+
});
|
|
133
|
+
test("generateHelpers provides autocomplete for tool names in useToolInfo (widgets + registerTool)", () => {
|
|
134
|
+
const { useToolInfo } = generateHelpers();
|
|
135
|
+
useToolInfo();
|
|
136
|
+
useToolInfo();
|
|
137
|
+
useToolInfo();
|
|
138
|
+
useToolInfo();
|
|
139
|
+
useToolInfo();
|
|
140
|
+
useToolInfo();
|
|
141
|
+
// @ts-expect-error - "invalid-name" is not a valid tool name
|
|
142
|
+
useToolInfo();
|
|
143
|
+
});
|
|
144
|
+
test("useToolInfo infers input and output types", () => {
|
|
145
|
+
const { useToolInfo } = generateHelpers();
|
|
146
|
+
const toolInfo = useToolInfo();
|
|
147
|
+
expectTypeOf(toolInfo.input).toExtend();
|
|
148
|
+
if (toolInfo.status === "success") {
|
|
149
|
+
expectTypeOf(toolInfo.output).toExtend();
|
|
150
|
+
expectTypeOf(toolInfo.output.results).toBeArray();
|
|
151
|
+
expectTypeOf(toolInfo.output.totalCount).toBeNumber();
|
|
152
|
+
}
|
|
153
|
+
});
|
|
154
|
+
//# 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;AAO5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,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,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAElD,QAAQ,CACN,EAAE,WAAW,EAAE,OAAO,EAAE,EACxB;QACE,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,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;KACF,CACF,CAAC;AACJ,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,CACN,EAAE,EACF;QACE,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE;YACtB,YAAY,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QAC7D,CAAC;KACF,CACF,CAAC;AACJ,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,EAElC,CAAC;IAEJ,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAClC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,EAEnC,CAAC;QACJ,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;QAClD,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;IACxD,CAAC;AACH,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { describe, expect, it } from "vitest";
|
|
2
|
+
import { createMinimalTestServer } from "../test/utils.js";
|
|
3
|
+
import { generateHelpers } from "./generate-helpers.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,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,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"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { type SuperJSONResult } from "superjson";
|
|
2
|
+
import type { UnknownObject } from "../types.js";
|
|
3
|
+
export declare function filterWidgetContext<T extends UnknownObject>(state?: T | null): T | null;
|
|
4
|
+
export declare function injectWidgetContext<T extends UnknownObject>(newState: T | null): T | null;
|
|
5
|
+
export declare function serializeState(value: UnknownObject): unknown;
|
|
6
|
+
export declare function deserializeState(value: SuperJSONResult): unknown;
|
|
7
|
+
export declare function getInitialState<State extends UnknownObject>(defaultState?: State | (() => State)): State | null;
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import superjson, {} from "superjson";
|
|
2
|
+
import { WIDGET_CONTEXT_KEY } from "../data-llm.js";
|
|
3
|
+
export function filterWidgetContext(state) {
|
|
4
|
+
if (state === null || state === undefined) {
|
|
5
|
+
return null;
|
|
6
|
+
}
|
|
7
|
+
const { [WIDGET_CONTEXT_KEY]: _, ...filteredState } = state;
|
|
8
|
+
return filteredState;
|
|
9
|
+
}
|
|
10
|
+
export function injectWidgetContext(newState) {
|
|
11
|
+
if (newState === null) {
|
|
12
|
+
return null;
|
|
13
|
+
}
|
|
14
|
+
const currentWindowState = window.openai?.widgetState;
|
|
15
|
+
if (currentWindowState !== null &&
|
|
16
|
+
currentWindowState !== undefined &&
|
|
17
|
+
WIDGET_CONTEXT_KEY in currentWindowState) {
|
|
18
|
+
return {
|
|
19
|
+
...newState,
|
|
20
|
+
[WIDGET_CONTEXT_KEY]: currentWindowState[WIDGET_CONTEXT_KEY],
|
|
21
|
+
};
|
|
22
|
+
}
|
|
23
|
+
return newState;
|
|
24
|
+
}
|
|
25
|
+
export function serializeState(value) {
|
|
26
|
+
return superjson.parse(superjson.stringify(value)); // Strips functions
|
|
27
|
+
}
|
|
28
|
+
export function deserializeState(value) {
|
|
29
|
+
return superjson.deserialize(value);
|
|
30
|
+
}
|
|
31
|
+
export function getInitialState(defaultState) {
|
|
32
|
+
const widgetStateFromWindow = window.openai?.widgetState;
|
|
33
|
+
if (widgetStateFromWindow !== null && widgetStateFromWindow !== undefined) {
|
|
34
|
+
return filterWidgetContext(widgetStateFromWindow);
|
|
35
|
+
}
|
|
36
|
+
return typeof defaultState === "function"
|
|
37
|
+
? defaultState()
|
|
38
|
+
: (defaultState ?? null);
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=state.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"state.js","sourceRoot":"","sources":["../../../../src/web/helpers/state.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,EAAE,EAAwB,MAAM,WAAW,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGpD,MAAM,UAAU,mBAAmB,CACjC,KAAgB;IAEhB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC,EAAE,GAAG,aAAa,EAAE,GAAG,KAErD,CAAC;IAEF,OAAO,aAAkB,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,QAAkB;IAElB,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,WAG7B,CAAC;IAEd,IACE,kBAAkB,KAAK,IAAI;QAC3B,kBAAkB,KAAK,SAAS;QAChC,kBAAkB,IAAI,kBAAkB,EACxC,CAAC;QACD,OAAO;YACL,GAAG,QAAQ;YACX,CAAC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC,kBAAkB,CAAC;SACxD,CAAC;IACT,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAoB;IACjD,OAAO,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,mBAAmB;AACzE,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAsB;IACrD,OAAO,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,YAAoC;IAEpC,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,WAGhC,CAAC;IAEd,IAAI,qBAAqB,KAAK,IAAI,IAAI,qBAAqB,KAAK,SAAS,EAAE,CAAC;QAC1E,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,OAAO,YAAY,KAAK,UAAU;QACvC,CAAC,CAAC,YAAY,EAAE;QAChB,CAAC,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC;AAC7B,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { describe, expect, it } from "vitest";
|
|
2
|
+
import { WIDGET_CONTEXT_KEY } from "../data-llm.js";
|
|
3
|
+
import { filterWidgetContext, serializeState } from "./state.js";
|
|
4
|
+
describe("state helpers", () => {
|
|
5
|
+
describe("filterWidgetContext", () => {
|
|
6
|
+
it("should return null when state is null", () => {
|
|
7
|
+
expect(filterWidgetContext(null)).toBe(null);
|
|
8
|
+
});
|
|
9
|
+
it("should return null when state is undefined", () => {
|
|
10
|
+
expect(filterWidgetContext(undefined)).toBe(null);
|
|
11
|
+
});
|
|
12
|
+
it("should correctly filter WIDGET_CONTEXT_KEY and preserve other properties", () => {
|
|
13
|
+
const stateWithContextAndOthers = {
|
|
14
|
+
a: 1,
|
|
15
|
+
b: "two",
|
|
16
|
+
c: { nested: true },
|
|
17
|
+
[WIDGET_CONTEXT_KEY]: "context",
|
|
18
|
+
};
|
|
19
|
+
const filteredWithContextAndOthers = filterWidgetContext(stateWithContextAndOthers);
|
|
20
|
+
expect(filteredWithContextAndOthers).toEqual({
|
|
21
|
+
a: 1,
|
|
22
|
+
b: "two",
|
|
23
|
+
c: { nested: true },
|
|
24
|
+
});
|
|
25
|
+
const stateNoContext = { count: 5, name: "test" };
|
|
26
|
+
const filteredNoContext = filterWidgetContext(stateNoContext);
|
|
27
|
+
expect(filteredNoContext).toEqual(stateNoContext);
|
|
28
|
+
});
|
|
29
|
+
});
|
|
30
|
+
describe("serializeState", () => {
|
|
31
|
+
it("should serialize plain objects", () => {
|
|
32
|
+
const array = [1, "two", { three: 3 }];
|
|
33
|
+
const date = new Date("2023-01-01T00:00:00Z");
|
|
34
|
+
const object = {
|
|
35
|
+
a: 1,
|
|
36
|
+
b: "test",
|
|
37
|
+
c: true,
|
|
38
|
+
array,
|
|
39
|
+
date,
|
|
40
|
+
function: () => "test",
|
|
41
|
+
};
|
|
42
|
+
const result = serializeState(object);
|
|
43
|
+
expect(result).toEqual({
|
|
44
|
+
a: 1,
|
|
45
|
+
b: "test",
|
|
46
|
+
c: true,
|
|
47
|
+
array: [1, "two", { three: 3 }],
|
|
48
|
+
date: new Date("2023-01-01T00:00:00.000Z"),
|
|
49
|
+
});
|
|
50
|
+
});
|
|
51
|
+
});
|
|
52
|
+
});
|
|
53
|
+
//# sourceMappingURL=state.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"state.test.js","sourceRoot":"","sources":["../../../../src/web/helpers/state.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjE,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,GAAG,EAAE;YAClF,MAAM,yBAAyB,GAAG;gBAChC,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,KAAK;gBACR,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;gBACnB,CAAC,kBAAkB,CAAC,EAAE,SAAS;aAChC,CAAC;YACF,MAAM,4BAA4B,GAAG,mBAAmB,CACtD,yBAAyB,CAC1B,CAAC;YACF,MAAM,CAAC,4BAA4B,CAAC,CAAC,OAAO,CAAC;gBAC3C,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,KAAK;gBACR,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;aACpB,CAAC,CAAC;YAEH,MAAM,cAAc,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAClD,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;YAC9D,MAAM,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACxC,MAAM,KAAK,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC;YAC9C,MAAM,MAAM,GAAG;gBACb,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,MAAM;gBACT,CAAC,EAAE,IAAI;gBACP,KAAK;gBACL,IAAI;gBACJ,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM;aACvB,CAAC;YACF,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;YAEtC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,MAAM;gBACT,CAAC,EAAE,IAAI;gBACP,KAAK,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;gBAC/B,IAAI,EAAE,IAAI,IAAI,CAAC,0BAA0B,CAAC;aAC3C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -1,7 +1,12 @@
|
|
|
1
|
+
export { type CallToolAsyncFn, type CallToolFn, type CallToolState, type SideEffects, useCallTool, } from "./use-call-tool.js";
|
|
2
|
+
export { useDisplayMode } from "./use-display-mode.js";
|
|
3
|
+
export { useFiles } from "./use-files.js";
|
|
4
|
+
export { useLocale } from "./use-locale.js";
|
|
5
|
+
export { useOpenExternal } from "./use-open-external.js";
|
|
1
6
|
export { useOpenAiGlobal } from "./use-openai-global.js";
|
|
2
|
-
export {
|
|
3
|
-
export {
|
|
4
|
-
export {
|
|
5
|
-
export { useWidgetState } from "./use-widget-state.js";
|
|
7
|
+
export { useRequestModal } from "./use-request-modal.js";
|
|
8
|
+
export { useSendFollowUpMessage } from "./use-send-follow-up-message.js";
|
|
9
|
+
export { useTheme } from "./use-theme.js";
|
|
6
10
|
export { useToolInfo } from "./use-tool-info.js";
|
|
7
|
-
export {
|
|
11
|
+
export { useUserAgent } from "./use-user-agent.js";
|
|
12
|
+
export { useWidgetState } from "./use-widget-state.js";
|
|
@@ -1,8 +1,13 @@
|
|
|
1
|
+
export { useCallTool, } from "./use-call-tool.js";
|
|
2
|
+
export { useDisplayMode } from "./use-display-mode.js";
|
|
3
|
+
export { useFiles } from "./use-files.js";
|
|
4
|
+
export { useLocale } from "./use-locale.js";
|
|
5
|
+
export { useOpenExternal } from "./use-open-external.js";
|
|
1
6
|
export { useOpenAiGlobal } from "./use-openai-global.js";
|
|
2
|
-
export {
|
|
3
|
-
export {
|
|
4
|
-
export {
|
|
5
|
-
export { useWidgetState } from "./use-widget-state.js";
|
|
7
|
+
export { useRequestModal } from "./use-request-modal.js";
|
|
8
|
+
export { useSendFollowUpMessage } from "./use-send-follow-up-message.js";
|
|
9
|
+
export { useTheme } from "./use-theme.js";
|
|
6
10
|
export { useToolInfo } from "./use-tool-info.js";
|
|
7
|
-
export {
|
|
11
|
+
export { useUserAgent } from "./use-user-agent.js";
|
|
12
|
+
export { useWidgetState } from "./use-widget-state.js";
|
|
8
13
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/web/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/web/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,WAAW,GACZ,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,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC"}
|