skybridge 0.0.0-dev.d8b52a9 → 0.0.0-dev.d91f2cb
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/LICENSE +21 -674
- package/bin/run.js +9 -0
- package/dist/cli/use-version.d.ts +1 -0
- package/dist/cli/use-version.js +33 -0
- package/dist/cli/use-version.js.map +1 -0
- package/dist/commands/dev.d.ts +7 -0
- package/dist/commands/dev.js +30 -0
- package/dist/commands/dev.js.map +1 -0
- package/dist/server/index.d.ts +4 -0
- package/dist/server/index.js.map +1 -0
- package/dist/server/inferUtilityTypes.d.ts +64 -0
- package/dist/server/inferUtilityTypes.js.map +1 -0
- package/dist/server/server.d.ts +101 -0
- package/dist/server/server.js +132 -0
- package/dist/server/server.js.map +1 -0
- package/dist/{src/server → server}/templateHelper.d.ts +3 -0
- package/dist/{src/server → server}/templateHelper.js +5 -4
- package/dist/server/templateHelper.js.map +1 -0
- package/dist/server/templates/development.hbs +66 -0
- package/dist/{src/server → server}/templates/production.hbs +1 -0
- package/dist/{src/server → server}/widgetsDevServer.d.ts +2 -2
- package/dist/{src/server → server}/widgetsDevServer.js +13 -5
- package/dist/server/widgetsDevServer.js.map +1 -0
- package/dist/test/utils.d.ts +135 -0
- package/dist/test/utils.js +242 -0
- package/dist/test/utils.js.map +1 -0
- package/dist/test/widget.test.js +234 -0
- package/dist/test/widget.test.js.map +1 -0
- package/dist/web/bridges/adaptors/apps-sdk-adaptor.d.ts +13 -0
- package/dist/web/bridges/adaptors/apps-sdk-adaptor.js +33 -0
- package/dist/web/bridges/adaptors/apps-sdk-adaptor.js.map +1 -0
- package/dist/web/bridges/adaptors/mcp-app-adaptor.d.ts +16 -0
- package/dist/web/bridges/adaptors/mcp-app-adaptor.js +115 -0
- package/dist/web/bridges/adaptors/mcp-app-adaptor.js.map +1 -0
- package/dist/web/bridges/apps-sdk-bridge.d.ts +10 -0
- package/dist/web/bridges/apps-sdk-bridge.js +46 -0
- package/dist/web/bridges/apps-sdk-bridge.js.map +1 -0
- package/dist/web/bridges/hooks/use-adaptor.d.ts +2 -0
- package/dist/web/bridges/hooks/use-adaptor.js +8 -0
- package/dist/web/bridges/hooks/use-adaptor.js.map +1 -0
- package/dist/web/bridges/hooks/use-apps-sdk-bridge.d.ts +2 -0
- package/dist/web/bridges/hooks/use-apps-sdk-bridge.js +7 -0
- package/dist/web/bridges/hooks/use-apps-sdk-bridge.js.map +1 -0
- package/dist/web/bridges/hooks/use-bridge.d.ts +2 -0
- package/dist/web/bridges/hooks/use-bridge.js +8 -0
- package/dist/web/bridges/hooks/use-bridge.js.map +1 -0
- package/dist/web/bridges/hooks/use-mcp-app-bridge.d.ts +5 -0
- package/dist/web/bridges/hooks/use-mcp-app-bridge.js +7 -0
- package/dist/web/bridges/hooks/use-mcp-app-bridge.js.map +1 -0
- package/dist/web/bridges/hooks/use-mcp-app-bridge.test.js +62 -0
- package/dist/web/bridges/hooks/use-mcp-app-bridge.test.js.map +1 -0
- package/dist/web/bridges/index.d.ts +4 -0
- package/dist/web/bridges/index.js +5 -0
- package/dist/web/bridges/index.js.map +1 -0
- package/dist/web/bridges/mcp-app-bridge.d.ts +46 -0
- package/dist/web/bridges/mcp-app-bridge.js +217 -0
- package/dist/web/bridges/mcp-app-bridge.js.map +1 -0
- package/dist/web/bridges/types.d.ts +57 -0
- package/dist/web/bridges/types.js +2 -0
- package/dist/web/bridges/types.js.map +1 -0
- package/dist/web/create-store.d.ts +3 -0
- package/dist/web/create-store.js +25 -0
- package/dist/web/create-store.js.map +1 -0
- package/dist/web/create-store.test.js +70 -0
- package/dist/web/create-store.test.js.map +1 -0
- package/dist/web/data-llm.d.ts +14 -0
- package/dist/web/data-llm.js +70 -0
- package/dist/web/data-llm.js.map +1 -0
- package/dist/web/data-llm.test.js +76 -0
- package/dist/web/data-llm.test.js.map +1 -0
- package/dist/{src/web/typed-hooks.d.ts → web/generate-helpers.d.ts} +26 -18
- package/dist/{src/web/typed-hooks.js → web/generate-helpers.js} +14 -14
- package/dist/web/generate-helpers.js.map +1 -0
- package/dist/web/generate-helpers.test-d.js +209 -0
- package/dist/web/generate-helpers.test-d.js.map +1 -0
- package/dist/web/generate-helpers.test.js +17 -0
- package/dist/web/generate-helpers.test.js.map +1 -0
- package/dist/web/helpers/state.d.ts +7 -0
- package/dist/web/helpers/state.js +40 -0
- package/dist/web/helpers/state.js.map +1 -0
- package/dist/web/helpers/state.test.js +53 -0
- package/dist/web/helpers/state.test.js.map +1 -0
- package/dist/{src/web → web}/hooks/index.d.ts +4 -7
- package/dist/{src/web → web}/hooks/index.js +4 -7
- package/dist/web/hooks/index.js.map +1 -0
- package/dist/web/hooks/test/utils.d.ts +10 -0
- package/dist/web/hooks/test/utils.js +40 -0
- package/dist/web/hooks/test/utils.js.map +1 -0
- package/dist/web/hooks/use-call-tool.d.ts +100 -0
- package/dist/{src/web → web}/hooks/use-call-tool.js +19 -19
- package/dist/web/hooks/use-call-tool.js.map +1 -0
- package/dist/web/hooks/use-call-tool.test-d.js +104 -0
- package/dist/web/hooks/use-call-tool.test-d.js.map +1 -0
- package/dist/{src/web → web}/hooks/use-call-tool.test.js +42 -15
- package/dist/web/hooks/use-call-tool.test.js.map +1 -0
- package/dist/{src/web → web}/hooks/use-display-mode.d.ts +1 -1
- package/dist/web/hooks/use-display-mode.js +10 -0
- package/dist/web/hooks/use-display-mode.js.map +1 -0
- package/dist/{src/web → web}/hooks/use-display-mode.test.js +3 -2
- package/dist/web/hooks/use-display-mode.test.js.map +1 -0
- package/dist/web/hooks/use-files.js.map +1 -0
- package/dist/{src/web → web}/hooks/use-files.test.js +1 -1
- package/dist/web/hooks/use-files.test.js.map +1 -0
- package/dist/web/hooks/use-layout.d.ts +22 -0
- package/dist/web/hooks/use-layout.js +23 -0
- package/dist/web/hooks/use-layout.js.map +1 -0
- package/dist/web/hooks/use-layout.test.js +95 -0
- package/dist/web/hooks/use-layout.test.js.map +1 -0
- package/dist/web/hooks/use-open-external.js +8 -0
- package/dist/web/hooks/use-open-external.js.map +1 -0
- package/dist/web/hooks/use-open-external.test.js +50 -0
- package/dist/web/hooks/use-open-external.test.js.map +1 -0
- package/dist/web/hooks/use-openai-global.d.ts +3 -0
- package/dist/web/hooks/use-openai-global.js +6 -0
- package/dist/web/hooks/use-openai-global.js.map +1 -0
- package/dist/web/hooks/use-request-modal.d.ts +9 -0
- package/dist/web/hooks/use-request-modal.js +14 -0
- package/dist/web/hooks/use-request-modal.js.map +1 -0
- package/dist/web/hooks/use-request-modal.test.js +57 -0
- package/dist/web/hooks/use-request-modal.test.js.map +1 -0
- package/dist/web/hooks/use-send-follow-up-message.js +8 -0
- package/dist/web/hooks/use-send-follow-up-message.js.map +1 -0
- package/dist/{src/web → web}/hooks/use-tool-info.d.ts +13 -2
- package/dist/web/hooks/use-tool-info.js +26 -0
- package/dist/web/hooks/use-tool-info.js.map +1 -0
- package/dist/web/hooks/use-tool-info.test-d.d.ts +1 -0
- package/dist/{src/web → web}/hooks/use-tool-info.test-d.js +40 -5
- package/dist/web/hooks/use-tool-info.test-d.js.map +1 -0
- package/dist/web/hooks/use-tool-info.test.d.ts +1 -0
- package/dist/web/hooks/use-tool-info.test.js +130 -0
- package/dist/web/hooks/use-tool-info.test.js.map +1 -0
- package/dist/web/hooks/use-user.d.ts +18 -0
- package/dist/web/hooks/use-user.js +19 -0
- package/dist/web/hooks/use-user.js.map +1 -0
- package/dist/web/hooks/use-user.test.d.ts +1 -0
- package/dist/web/hooks/use-user.test.js +93 -0
- package/dist/web/hooks/use-user.test.js.map +1 -0
- package/dist/{src/web → web}/hooks/use-widget-state.js +11 -9
- package/dist/web/hooks/use-widget-state.js.map +1 -0
- package/dist/web/hooks/use-widget-state.test.d.ts +1 -0
- package/dist/{src/web → web}/hooks/use-widget-state.test.js +3 -2
- package/dist/web/hooks/use-widget-state.test.js.map +1 -0
- package/dist/web/index.d.ts +8 -0
- package/dist/web/index.js +9 -0
- package/dist/web/index.js.map +1 -0
- package/dist/web/mount-widget.js.map +1 -0
- package/dist/web/plugin/data-llm.test.d.ts +1 -0
- package/dist/web/plugin/data-llm.test.js +81 -0
- package/dist/web/plugin/data-llm.test.js.map +1 -0
- package/dist/web/plugin/plugin.js +39 -0
- package/dist/web/plugin/plugin.js.map +1 -0
- package/dist/web/plugin/transform-data-llm.d.ts +12 -0
- package/dist/web/plugin/transform-data-llm.js +96 -0
- package/dist/web/plugin/transform-data-llm.js.map +1 -0
- package/dist/web/plugin/transform-data-llm.test.d.ts +1 -0
- package/dist/web/plugin/transform-data-llm.test.js +81 -0
- package/dist/web/plugin/transform-data-llm.test.js.map +1 -0
- package/dist/{src/web → web}/proxy.js +6 -1
- package/dist/web/proxy.js.map +1 -0
- package/dist/{src/web → web}/types.d.ts +43 -13
- package/dist/{src/web → web}/types.js +1 -0
- package/dist/web/types.js.map +1 -0
- package/package.json +54 -30
- package/README.md +0 -323
- package/dist/src/server/index.d.ts +0 -4
- package/dist/src/server/index.js.map +0 -1
- package/dist/src/server/inferUtilityTypes.d.ts +0 -44
- package/dist/src/server/inferUtilityTypes.js.map +0 -1
- package/dist/src/server/server.d.ts +0 -19
- package/dist/src/server/server.js +0 -58
- package/dist/src/server/server.js.map +0 -1
- package/dist/src/server/templateHelper.js.map +0 -1
- package/dist/src/server/templates/development.hbs +0 -12
- package/dist/src/server/widgetsDevServer.js.map +0 -1
- package/dist/src/test/utils.d.ts +0 -28
- package/dist/src/test/utils.js +0 -43
- package/dist/src/test/utils.js.map +0 -1
- package/dist/src/test/widget.test.js +0 -90
- package/dist/src/test/widget.test.js.map +0 -1
- package/dist/src/web/hooks/index.js.map +0 -1
- package/dist/src/web/hooks/use-call-tool.d.ts +0 -62
- package/dist/src/web/hooks/use-call-tool.js.map +0 -1
- package/dist/src/web/hooks/use-call-tool.test.js.map +0 -1
- package/dist/src/web/hooks/use-display-mode.js +0 -7
- package/dist/src/web/hooks/use-display-mode.js.map +0 -1
- package/dist/src/web/hooks/use-display-mode.test.js.map +0 -1
- package/dist/src/web/hooks/use-files.js.map +0 -1
- package/dist/src/web/hooks/use-files.test.js.map +0 -1
- package/dist/src/web/hooks/use-locale.d.ts +0 -1
- package/dist/src/web/hooks/use-locale.js +0 -5
- package/dist/src/web/hooks/use-locale.js.map +0 -1
- package/dist/src/web/hooks/use-locale.test.js +0 -21
- package/dist/src/web/hooks/use-locale.test.js.map +0 -1
- package/dist/src/web/hooks/use-open-external.js +0 -6
- package/dist/src/web/hooks/use-open-external.js.map +0 -1
- package/dist/src/web/hooks/use-open-external.test.js +0 -24
- package/dist/src/web/hooks/use-open-external.test.js.map +0 -1
- package/dist/src/web/hooks/use-openai-global.d.ts +0 -2
- package/dist/src/web/hooks/use-openai-global.js +0 -23
- package/dist/src/web/hooks/use-openai-global.js.map +0 -1
- package/dist/src/web/hooks/use-request-modal.d.ts +0 -6
- package/dist/src/web/hooks/use-request-modal.js +0 -9
- package/dist/src/web/hooks/use-request-modal.js.map +0 -1
- package/dist/src/web/hooks/use-request-modal.test.js +0 -24
- package/dist/src/web/hooks/use-request-modal.test.js.map +0 -1
- package/dist/src/web/hooks/use-send-follow-up-message.js +0 -11
- package/dist/src/web/hooks/use-send-follow-up-message.js.map +0 -1
- package/dist/src/web/hooks/use-theme.d.ts +0 -1
- package/dist/src/web/hooks/use-theme.js +0 -5
- package/dist/src/web/hooks/use-theme.js.map +0 -1
- package/dist/src/web/hooks/use-theme.test.js +0 -26
- package/dist/src/web/hooks/use-theme.test.js.map +0 -1
- package/dist/src/web/hooks/use-tool-info.js +0 -22
- package/dist/src/web/hooks/use-tool-info.js.map +0 -1
- package/dist/src/web/hooks/use-tool-info.test-d.js.map +0 -1
- package/dist/src/web/hooks/use-tool-info.test.js +0 -59
- package/dist/src/web/hooks/use-tool-info.test.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/hooks/use-user-agent.d.ts +0 -1
- package/dist/src/web/hooks/use-user-agent.js +0 -5
- package/dist/src/web/hooks/use-user-agent.js.map +0 -1
- package/dist/src/web/hooks/use-user-agent.test.js +0 -31
- package/dist/src/web/hooks/use-user-agent.test.js.map +0 -1
- package/dist/src/web/hooks/use-widget-state.js.map +0 -1
- package/dist/src/web/hooks/use-widget-state.test.js.map +0 -1
- package/dist/src/web/index.d.ts +0 -5
- package/dist/src/web/index.js +0 -6
- package/dist/src/web/index.js.map +0 -1
- package/dist/src/web/mount-widget.js.map +0 -1
- package/dist/src/web/plugin.js +0 -28
- package/dist/src/web/plugin.js.map +0 -1
- package/dist/src/web/proxy.js.map +0 -1
- package/dist/src/web/typed-hooks.js.map +0 -1
- package/dist/src/web/typed-hooks.test-d.js +0 -72
- package/dist/src/web/typed-hooks.test-d.js.map +0 -1
- package/dist/src/web/typed-hooks.test.js +0 -10
- package/dist/src/web/typed-hooks.test.js.map +0 -1
- package/dist/src/web/types.js.map +0 -1
- package/dist/vitest.config.d.ts +0 -2
- package/dist/vitest.config.js +0 -8
- package/dist/vitest.config.js.map +0 -1
- /package/dist/{src/server → server}/index.js +0 -0
- /package/dist/{src/server → server}/inferUtilityTypes.js +0 -0
- /package/dist/{src/test → test}/widget.test.d.ts +0 -0
- /package/dist/{src/web/hooks/use-call-tool.test.d.ts → web/bridges/hooks/use-mcp-app-bridge.test.d.ts} +0 -0
- /package/dist/{src/web/hooks/use-display-mode.test.d.ts → web/create-store.test.d.ts} +0 -0
- /package/dist/{src/web/hooks/use-files.test.d.ts → web/data-llm.test.d.ts} +0 -0
- /package/dist/{src/web/hooks/use-locale.test.d.ts → web/generate-helpers.test-d.d.ts} +0 -0
- /package/dist/{src/web/hooks/use-open-external.test.d.ts → web/generate-helpers.test.d.ts} +0 -0
- /package/dist/{src/web/hooks/use-request-modal.test.d.ts → web/helpers/state.test.d.ts} +0 -0
- /package/dist/{src/web/hooks/use-theme.test.d.ts → web/hooks/use-call-tool.test-d.d.ts} +0 -0
- /package/dist/{src/web/hooks/use-tool-info.test-d.d.ts → web/hooks/use-call-tool.test.d.ts} +0 -0
- /package/dist/{src/web/hooks/use-tool-info.test.d.ts → web/hooks/use-display-mode.test.d.ts} +0 -0
- /package/dist/{src/web → web}/hooks/use-files.d.ts +0 -0
- /package/dist/{src/web → web}/hooks/use-files.js +0 -0
- /package/dist/{src/web/hooks/use-user-agent.test.d.ts → web/hooks/use-files.test.d.ts} +0 -0
- /package/dist/{src/web/hooks/use-widget-state.test.d.ts → web/hooks/use-layout.test.d.ts} +0 -0
- /package/dist/{src/web → web}/hooks/use-open-external.d.ts +0 -0
- /package/dist/{src/web/typed-hooks.test-d.d.ts → web/hooks/use-open-external.test.d.ts} +0 -0
- /package/dist/{src/web/typed-hooks.test.d.ts → web/hooks/use-request-modal.test.d.ts} +0 -0
- /package/dist/{src/web → web}/hooks/use-send-follow-up-message.d.ts +0 -0
- /package/dist/{src/web → web}/hooks/use-widget-state.d.ts +0 -0
- /package/dist/{src/web → web}/mount-widget.d.ts +0 -0
- /package/dist/{src/web → web}/mount-widget.js +0 -0
- /package/dist/{src/web → web/plugin}/plugin.d.ts +0 -0
- /package/dist/{src/web → web}/proxy.d.ts +0 -0
|
@@ -1,11 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import type
|
|
3
|
-
import
|
|
4
|
-
import type {
|
|
5
|
-
type
|
|
6
|
-
structuredContent: TOutput
|
|
7
|
-
}
|
|
8
|
-
type
|
|
1
|
+
import type { InferTools, ToolInput, ToolOutput, ToolResponseMetadata } 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, TResponseMetadata> = ToolState<Objectify<TInput>, Objectify<TOutput>, Objectify<TResponseMetadata>>;
|
|
9
13
|
/**
|
|
10
14
|
* Creates typed versions of skybridge hooks with full type inference
|
|
11
15
|
* for tool names, inputs, and outputs.
|
|
@@ -13,7 +17,9 @@ type TypedToolInfoReturn<TInput extends UnknownObject, TOutput extends UnknownOb
|
|
|
13
17
|
* This is the recommended way to use skybridge hooks in your widgets.
|
|
14
18
|
* Set this up once in a dedicated file and export the typed hooks for use across your app.
|
|
15
19
|
*
|
|
16
|
-
* @typeParam
|
|
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.
|
|
17
23
|
*
|
|
18
24
|
* @example
|
|
19
25
|
* ```typescript
|
|
@@ -33,9 +39,9 @@ type TypedToolInfoReturn<TInput extends UnknownObject, TOutput extends UnknownOb
|
|
|
33
39
|
* ```typescript
|
|
34
40
|
* // web/src/skybridge.ts (one-time setup)
|
|
35
41
|
* import type { AppType } from "../server";
|
|
36
|
-
* import {
|
|
42
|
+
* import { generateHelpers } from "skybridge/web";
|
|
37
43
|
*
|
|
38
|
-
* export const { useCallTool, useToolInfo } =
|
|
44
|
+
* export const { useCallTool, useToolInfo } = generateHelpers<AppType>();
|
|
39
45
|
* ```
|
|
40
46
|
*
|
|
41
47
|
* @example
|
|
@@ -52,11 +58,11 @@ type TypedToolInfoReturn<TInput extends UnknownObject, TOutput extends UnknownOb
|
|
|
52
58
|
* const toolInfo = useToolInfo<"search-voyage">();
|
|
53
59
|
* // ^ autocomplete for widget names
|
|
54
60
|
* // toolInfo.input is typed based on widget input schema
|
|
55
|
-
* // toolInfo.output is typed based on widget output schema
|
|
61
|
+
* // toolInfo.output.structuredContent is typed based on widget output schema
|
|
56
62
|
* }
|
|
57
63
|
* ```
|
|
58
64
|
*/
|
|
59
|
-
export declare function
|
|
65
|
+
export declare function generateHelpers<ServerType = never>(): {
|
|
60
66
|
/**
|
|
61
67
|
* Typed version of `useCallTool` that provides autocomplete for tool names
|
|
62
68
|
* and type inference for inputs and outputs.
|
|
@@ -76,7 +82,7 @@ export declare function createTypedHooks<T extends McpServer<AnyWidgetRegistry>>
|
|
|
76
82
|
* }
|
|
77
83
|
* ```
|
|
78
84
|
*/
|
|
79
|
-
useCallTool: <
|
|
85
|
+
useCallTool: <ToolName extends keyof InferTools<ServerType> & string>(name: ToolName) => TypedCallToolReturn<ToolInput<ServerType, ToolName>, ToolOutput<ServerType, ToolName>>;
|
|
80
86
|
/**
|
|
81
87
|
* Typed version of `useToolInfo` that provides autocomplete for widget names
|
|
82
88
|
* and type inference for inputs, outputs, and responseMetadata.
|
|
@@ -88,20 +94,22 @@ export declare function createTypedHooks<T extends McpServer<AnyWidgetRegistry>>
|
|
|
88
94
|
* ```typescript
|
|
89
95
|
* const toolInfo = useToolInfo<"search-voyage">();
|
|
90
96
|
* // toolInfo.input is typed as { destination: string; ... }
|
|
91
|
-
* // toolInfo.output is typed as { results: Array<...>; ... }
|
|
97
|
+
* // toolInfo.output is typed as { results: Array<...>; ... }
|
|
98
|
+
* // toolInfo.responseMetadata is typed based on _meta in callback return
|
|
92
99
|
* // toolInfo.status narrows correctly: "pending" | "success"
|
|
93
100
|
*
|
|
94
101
|
* if (toolInfo.isPending) {
|
|
95
|
-
* // TypeScript knows output
|
|
102
|
+
* // TypeScript knows output and responseMetadata are undefined here
|
|
96
103
|
* console.log(toolInfo.input.destination);
|
|
97
104
|
* }
|
|
98
105
|
*
|
|
99
106
|
* if (toolInfo.isSuccess) {
|
|
100
|
-
* // TypeScript knows output
|
|
107
|
+
* // TypeScript knows output and responseMetadata are defined here
|
|
101
108
|
* console.log(toolInfo.output.results);
|
|
109
|
+
* console.log(toolInfo.responseMetadata);
|
|
102
110
|
* }
|
|
103
111
|
* ```
|
|
104
112
|
*/
|
|
105
|
-
useToolInfo: <
|
|
113
|
+
useToolInfo: <ToolName extends keyof InferTools<ServerType> & string>() => TypedToolInfoReturn<ToolInput<ServerType, ToolName>, ToolOutput<ServerType, ToolName>, ToolResponseMetadata<ServerType, ToolName>>;
|
|
106
114
|
};
|
|
107
115
|
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { useCallTool } from "./hooks/use-call-tool.js";
|
|
1
|
+
import { useCallTool, } from "./hooks/use-call-tool.js";
|
|
2
2
|
import { useToolInfo } from "./hooks/use-tool-info.js";
|
|
3
3
|
/**
|
|
4
4
|
* Creates typed versions of skybridge hooks with full type inference
|
|
@@ -7,7 +7,9 @@ import { useToolInfo } from "./hooks/use-tool-info.js";
|
|
|
7
7
|
* This is the recommended way to use skybridge hooks in your widgets.
|
|
8
8
|
* Set this up once in a dedicated file and export the typed hooks for use across your app.
|
|
9
9
|
*
|
|
10
|
-
* @typeParam
|
|
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.
|
|
11
13
|
*
|
|
12
14
|
* @example
|
|
13
15
|
* ```typescript
|
|
@@ -27,9 +29,9 @@ import { useToolInfo } from "./hooks/use-tool-info.js";
|
|
|
27
29
|
* ```typescript
|
|
28
30
|
* // web/src/skybridge.ts (one-time setup)
|
|
29
31
|
* import type { AppType } from "../server";
|
|
30
|
-
* import {
|
|
32
|
+
* import { generateHelpers } from "skybridge/web";
|
|
31
33
|
*
|
|
32
|
-
* export const { useCallTool, useToolInfo } =
|
|
34
|
+
* export const { useCallTool, useToolInfo } = generateHelpers<AppType>();
|
|
33
35
|
* ```
|
|
34
36
|
*
|
|
35
37
|
* @example
|
|
@@ -46,11 +48,11 @@ import { useToolInfo } from "./hooks/use-tool-info.js";
|
|
|
46
48
|
* const toolInfo = useToolInfo<"search-voyage">();
|
|
47
49
|
* // ^ autocomplete for widget names
|
|
48
50
|
* // toolInfo.input is typed based on widget input schema
|
|
49
|
-
* // toolInfo.output is typed based on widget output schema
|
|
51
|
+
* // toolInfo.output.structuredContent is typed based on widget output schema
|
|
50
52
|
* }
|
|
51
53
|
* ```
|
|
52
54
|
*/
|
|
53
|
-
export function
|
|
55
|
+
export function generateHelpers() {
|
|
54
56
|
return {
|
|
55
57
|
/**
|
|
56
58
|
* Typed version of `useCallTool` that provides autocomplete for tool names
|
|
@@ -72,8 +74,6 @@ export function createTypedHooks() {
|
|
|
72
74
|
* ```
|
|
73
75
|
*/
|
|
74
76
|
useCallTool: (name) => {
|
|
75
|
-
// Type assertion is safe here because the runtime types are compatible.
|
|
76
|
-
// The underlying hook accepts broader types, but we expose narrower, more specific types.
|
|
77
77
|
return useCallTool(name);
|
|
78
78
|
},
|
|
79
79
|
/**
|
|
@@ -87,25 +87,25 @@ export function createTypedHooks() {
|
|
|
87
87
|
* ```typescript
|
|
88
88
|
* const toolInfo = useToolInfo<"search-voyage">();
|
|
89
89
|
* // toolInfo.input is typed as { destination: string; ... }
|
|
90
|
-
* // toolInfo.output is typed as { results: Array<...>; ... }
|
|
90
|
+
* // toolInfo.output is typed as { results: Array<...>; ... }
|
|
91
|
+
* // toolInfo.responseMetadata is typed based on _meta in callback return
|
|
91
92
|
* // toolInfo.status narrows correctly: "pending" | "success"
|
|
92
93
|
*
|
|
93
94
|
* if (toolInfo.isPending) {
|
|
94
|
-
* // TypeScript knows output
|
|
95
|
+
* // TypeScript knows output and responseMetadata are undefined here
|
|
95
96
|
* console.log(toolInfo.input.destination);
|
|
96
97
|
* }
|
|
97
98
|
*
|
|
98
99
|
* if (toolInfo.isSuccess) {
|
|
99
|
-
* // TypeScript knows output
|
|
100
|
+
* // TypeScript knows output and responseMetadata are defined here
|
|
100
101
|
* console.log(toolInfo.output.results);
|
|
102
|
+
* console.log(toolInfo.responseMetadata);
|
|
101
103
|
* }
|
|
102
104
|
* ```
|
|
103
105
|
*/
|
|
104
106
|
useToolInfo: () => {
|
|
105
|
-
// Type assertion is safe here because the runtime types are compatible.
|
|
106
|
-
// The underlying hook accepts broader types, but we expose narrower, more specific types.
|
|
107
107
|
return useToolInfo();
|
|
108
108
|
},
|
|
109
109
|
};
|
|
110
110
|
}
|
|
111
|
-
//# sourceMappingURL=
|
|
111
|
+
//# sourceMappingURL=generate-helpers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generate-helpers.js","sourceRoot":"","sources":["../../src/web/generate-helpers.ts"],"names":[],"mappings":"AAMA,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;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;QACH,WAAW,EAAE,GAIX,EAAE;YACF,OAAO,WAAW,EAIjB,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
import { expectTypeOf, test } from "vitest";
|
|
2
|
+
import { createInterfaceTestServer, createTestServer } from "../test/utils.js";
|
|
3
|
+
import { generateHelpers } from "./generate-helpers.js";
|
|
4
|
+
const server = createTestServer();
|
|
5
|
+
const interfaceServer = createInterfaceTestServer();
|
|
6
|
+
test("InferTools extracts the tool registry type (widgets + registerTool)", () => {
|
|
7
|
+
expectTypeOf().toHaveProperty("search-voyage");
|
|
8
|
+
expectTypeOf().toHaveProperty("get-trip-details");
|
|
9
|
+
expectTypeOf().toHaveProperty("no-input-widget");
|
|
10
|
+
expectTypeOf().toHaveProperty("calculate-price");
|
|
11
|
+
expectTypeOf().toHaveProperty("inferred-output-widget");
|
|
12
|
+
expectTypeOf().toHaveProperty("inferred-tool");
|
|
13
|
+
expectTypeOf().toHaveProperty("widget-with-metadata");
|
|
14
|
+
expectTypeOf().toHaveProperty("tool-with-metadata");
|
|
15
|
+
expectTypeOf().toHaveProperty("widget-with-mixed-returns");
|
|
16
|
+
});
|
|
17
|
+
test("ToolNames returns a union of tool name literals (widgets + registerTool)", () => {
|
|
18
|
+
expectTypeOf().toEqualTypeOf();
|
|
19
|
+
});
|
|
20
|
+
test("ToolInput extracts the correct input type from Zod schema", () => {
|
|
21
|
+
expectTypeOf().toEqualTypeOf();
|
|
22
|
+
expectTypeOf().toEqualTypeOf();
|
|
23
|
+
expectTypeOf().toEqualTypeOf();
|
|
24
|
+
});
|
|
25
|
+
test("ToolOutput extracts the correct output type from callback's structuredContent", () => {
|
|
26
|
+
expectTypeOf().toEqualTypeOf();
|
|
27
|
+
expectTypeOf().toEqualTypeOf();
|
|
28
|
+
expectTypeOf().toEqualTypeOf();
|
|
29
|
+
expectTypeOf().toEqualTypeOf();
|
|
30
|
+
});
|
|
31
|
+
test("ToolOutput extracts the correct output type from callback (inferred)", () => {
|
|
32
|
+
expectTypeOf().toEqualTypeOf();
|
|
33
|
+
expectTypeOf().toEqualTypeOf();
|
|
34
|
+
});
|
|
35
|
+
test("generateHelpers provides autocomplete for tool names (widgets + registerTool)", () => {
|
|
36
|
+
const { useCallTool } = generateHelpers();
|
|
37
|
+
useCallTool("search-voyage");
|
|
38
|
+
useCallTool("get-trip-details");
|
|
39
|
+
useCallTool("no-input-widget");
|
|
40
|
+
useCallTool("calculate-price");
|
|
41
|
+
useCallTool("inferred-output-widget");
|
|
42
|
+
useCallTool("inferred-tool");
|
|
43
|
+
useCallTool("widget-with-metadata");
|
|
44
|
+
useCallTool("tool-with-metadata");
|
|
45
|
+
useCallTool("widget-with-mixed-returns");
|
|
46
|
+
// @ts-expect-error - "invalid-name" is not a valid tool name
|
|
47
|
+
useCallTool("invalid-name");
|
|
48
|
+
});
|
|
49
|
+
test("useCallTool returns correctly typed callTool function", () => {
|
|
50
|
+
const { useCallTool } = generateHelpers();
|
|
51
|
+
const { callTool } = useCallTool("search-voyage");
|
|
52
|
+
callTool({ destination: "Spain" });
|
|
53
|
+
callTool({ destination: "France", departureDate: "2024-06-01" });
|
|
54
|
+
callTool({ destination: "Italy", maxPrice: 1000 });
|
|
55
|
+
const { callTool: calculateTool } = useCallTool("calculate-price");
|
|
56
|
+
calculateTool({ tripId: "123", passengers: 2 });
|
|
57
|
+
});
|
|
58
|
+
test("callTool can be called without args for tools with no required inputs", () => {
|
|
59
|
+
const { useCallTool } = generateHelpers();
|
|
60
|
+
const { callTool, callToolAsync } = useCallTool("no-input-widget");
|
|
61
|
+
callTool();
|
|
62
|
+
callTool({});
|
|
63
|
+
callToolAsync();
|
|
64
|
+
callToolAsync({});
|
|
65
|
+
});
|
|
66
|
+
test("callTool requires args for tools with required inputs", () => {
|
|
67
|
+
const { useCallTool } = generateHelpers();
|
|
68
|
+
const { callTool } = useCallTool("search-voyage");
|
|
69
|
+
// @ts-expect-error - "destination" is required
|
|
70
|
+
callTool();
|
|
71
|
+
// @ts-expect-error - "destination" is required
|
|
72
|
+
callTool({});
|
|
73
|
+
// This should work
|
|
74
|
+
callTool({ destination: "Spain" });
|
|
75
|
+
});
|
|
76
|
+
test("callTool supports sideEffects for tools with required inputs", () => {
|
|
77
|
+
const { useCallTool } = generateHelpers();
|
|
78
|
+
const { callTool } = useCallTool("search-voyage");
|
|
79
|
+
callTool({ destination: "Spain" }, {
|
|
80
|
+
onSuccess: (response, args) => {
|
|
81
|
+
expectTypeOf(response.structuredContent.results).toBeArray();
|
|
82
|
+
expectTypeOf(args.destination).toBeString();
|
|
83
|
+
},
|
|
84
|
+
onError: (error, args) => {
|
|
85
|
+
expectTypeOf(error).toBeUnknown();
|
|
86
|
+
expectTypeOf(args.destination).toBeString();
|
|
87
|
+
},
|
|
88
|
+
onSettled: (response, error, args) => {
|
|
89
|
+
if (response) {
|
|
90
|
+
expectTypeOf(response.structuredContent.totalCount).toBeNumber();
|
|
91
|
+
}
|
|
92
|
+
expectTypeOf(error).toBeUnknown();
|
|
93
|
+
expectTypeOf(args.destination).toBeString();
|
|
94
|
+
},
|
|
95
|
+
});
|
|
96
|
+
});
|
|
97
|
+
test("callTool supports sideEffects for tools with no required inputs", () => {
|
|
98
|
+
const { useCallTool } = generateHelpers();
|
|
99
|
+
const { callTool } = useCallTool("no-input-widget");
|
|
100
|
+
callTool({
|
|
101
|
+
onSuccess: (response) => {
|
|
102
|
+
expectTypeOf(response).toHaveProperty("structuredContent");
|
|
103
|
+
},
|
|
104
|
+
});
|
|
105
|
+
callTool({}, {
|
|
106
|
+
onSuccess: (response) => {
|
|
107
|
+
expectTypeOf(response).toHaveProperty("structuredContent");
|
|
108
|
+
},
|
|
109
|
+
});
|
|
110
|
+
});
|
|
111
|
+
test("callToolAsync returns correctly typed promise", () => {
|
|
112
|
+
const { useCallTool } = generateHelpers();
|
|
113
|
+
const { callToolAsync: searchAsync } = useCallTool("search-voyage");
|
|
114
|
+
const searchPromise = searchAsync({ destination: "Spain" });
|
|
115
|
+
expectTypeOf(searchPromise).resolves.toHaveProperty("structuredContent");
|
|
116
|
+
const { callToolAsync: noInputAsync } = useCallTool("no-input-widget");
|
|
117
|
+
const noInputPromise = noInputAsync();
|
|
118
|
+
expectTypeOf(noInputPromise).resolves.toHaveProperty("structuredContent");
|
|
119
|
+
});
|
|
120
|
+
test("useCallTool returns correctly typed data", () => {
|
|
121
|
+
const { useCallTool } = generateHelpers();
|
|
122
|
+
const { data } = useCallTool("search-voyage");
|
|
123
|
+
if (data) {
|
|
124
|
+
expectTypeOf(data.structuredContent).toExtend();
|
|
125
|
+
expectTypeOf(data.structuredContent.results).toBeArray();
|
|
126
|
+
expectTypeOf(data.structuredContent.totalCount).toBeNumber();
|
|
127
|
+
}
|
|
128
|
+
});
|
|
129
|
+
test("useCallTool returns correctly typed data for callback-inferred outputs", () => {
|
|
130
|
+
const { useCallTool } = generateHelpers();
|
|
131
|
+
const { data: widgetData } = useCallTool("inferred-output-widget");
|
|
132
|
+
if (widgetData) {
|
|
133
|
+
expectTypeOf(widgetData.structuredContent).toExtend();
|
|
134
|
+
}
|
|
135
|
+
const { data: toolData } = useCallTool("inferred-tool");
|
|
136
|
+
if (toolData) {
|
|
137
|
+
expectTypeOf(toolData.structuredContent).toExtend();
|
|
138
|
+
}
|
|
139
|
+
});
|
|
140
|
+
test("generateHelpers provides autocomplete for tool names in useToolInfo (widgets + registerTool)", () => {
|
|
141
|
+
const { useToolInfo } = generateHelpers();
|
|
142
|
+
useToolInfo();
|
|
143
|
+
useToolInfo();
|
|
144
|
+
useToolInfo();
|
|
145
|
+
useToolInfo();
|
|
146
|
+
useToolInfo();
|
|
147
|
+
useToolInfo();
|
|
148
|
+
useToolInfo();
|
|
149
|
+
useToolInfo();
|
|
150
|
+
useToolInfo();
|
|
151
|
+
// @ts-expect-error - "invalid-name" is not a valid tool name
|
|
152
|
+
useToolInfo();
|
|
153
|
+
});
|
|
154
|
+
test("useToolInfo infers input and output types", () => {
|
|
155
|
+
const { useToolInfo } = generateHelpers();
|
|
156
|
+
const toolInfo = useToolInfo();
|
|
157
|
+
// Input is only available when not in idle state
|
|
158
|
+
if (!(toolInfo.status === "idle")) {
|
|
159
|
+
expectTypeOf(toolInfo.input).toExtend();
|
|
160
|
+
}
|
|
161
|
+
if (toolInfo.status === "success") {
|
|
162
|
+
expectTypeOf(toolInfo.output).toExtend();
|
|
163
|
+
expectTypeOf(toolInfo.output.results).toBeArray();
|
|
164
|
+
expectTypeOf(toolInfo.output.totalCount).toBeNumber();
|
|
165
|
+
}
|
|
166
|
+
});
|
|
167
|
+
test("ToolResponseMetadata extracts _meta type from callback", () => {
|
|
168
|
+
expectTypeOf().toEqualTypeOf();
|
|
169
|
+
expectTypeOf().toEqualTypeOf();
|
|
170
|
+
expectTypeOf().toBeUnknown();
|
|
171
|
+
});
|
|
172
|
+
test("useToolInfo infers responseMetadata type from generateHelpers", () => {
|
|
173
|
+
const { useToolInfo } = generateHelpers();
|
|
174
|
+
const toolInfo = useToolInfo();
|
|
175
|
+
if (toolInfo.isSuccess) {
|
|
176
|
+
expectTypeOf(toolInfo.responseMetadata.requestId).toBeString();
|
|
177
|
+
expectTypeOf(toolInfo.responseMetadata.timestamp).toBeNumber();
|
|
178
|
+
expectTypeOf(toolInfo.responseMetadata.cached).toBeBoolean();
|
|
179
|
+
}
|
|
180
|
+
});
|
|
181
|
+
test("ToolResponseMetadata extracts _meta from mixed return paths", () => {
|
|
182
|
+
expectTypeOf().toEqualTypeOf();
|
|
183
|
+
});
|
|
184
|
+
test("ToolOutput extracts correct type when using interface declaration", () => {
|
|
185
|
+
expectTypeOf().toHaveProperty("itemName");
|
|
186
|
+
expectTypeOf().toBeString();
|
|
187
|
+
expectTypeOf().toBeNumber();
|
|
188
|
+
});
|
|
189
|
+
test("ToolResponseMetadata extracts correct type when using interface declaration", () => {
|
|
190
|
+
expectTypeOf().toHaveProperty("processedBy");
|
|
191
|
+
expectTypeOf().toBeString();
|
|
192
|
+
expectTypeOf().toBeNumber();
|
|
193
|
+
});
|
|
194
|
+
test("generateHelpers works with interface-typed server", () => {
|
|
195
|
+
const { useCallTool, useToolInfo } = generateHelpers();
|
|
196
|
+
const { data } = useCallTool("interface-widget");
|
|
197
|
+
if (data) {
|
|
198
|
+
expectTypeOf(data.structuredContent.itemName).toBeString();
|
|
199
|
+
expectTypeOf(data.structuredContent.quantity).toBeNumber();
|
|
200
|
+
}
|
|
201
|
+
const toolInfo = useToolInfo();
|
|
202
|
+
if (toolInfo.isSuccess) {
|
|
203
|
+
expectTypeOf(toolInfo.output.itemName).toBeString();
|
|
204
|
+
expectTypeOf(toolInfo.output.quantity).toBeNumber();
|
|
205
|
+
expectTypeOf(toolInfo.responseMetadata.processedBy).toBeString();
|
|
206
|
+
expectTypeOf(toolInfo.responseMetadata.version).toBeNumber();
|
|
207
|
+
}
|
|
208
|
+
});
|
|
209
|
+
//# 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;AAQ5C,OAAO,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;AAGlC,MAAM,eAAe,GAAG,yBAAyB,EAAE,CAAC;AAGpD,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;IACtD,YAAY,EAAS,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC;IAC7D,YAAY,EAAS,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAC3D,YAAY,EAAS,CAAC,cAAc,CAAC,2BAA2B,CAAC,CAAC;AACpE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0EAA0E,EAAE,GAAG,EAAE;IAGpF,YAAY,EAAS,CAAC,aAAa,EAUhC,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,EAA0B,CAAC;AACxE,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;IAC7B,WAAW,CAAC,sBAAsB,CAAC,CAAC;IACpC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAClC,WAAW,CAAC,2BAA2B,CAAC,CAAC;IAEzC,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;IAC/B,WAAW,EAA0B,CAAC;IACtC,WAAW,EAAwB,CAAC;IACpC,WAAW,EAA+B,CAAC;IAE3C,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,iDAAiD;IACjD,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC,EAAE,CAAC;QAClC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,EAElC,CAAC;IACN,CAAC;IAED,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;AAEH,IAAI,CAAC,wDAAwD,EAAE,GAAG,EAAE;IAElE,YAAY,EAAc,CAAC,aAAa,EAIpC,CAAC;IAGL,YAAY,EAAY,CAAC,aAAa,EAGlC,CAAC;IAGL,YAAY,EAAc,CAAC,WAAW,EAAE,CAAC;AAC3C,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;IACzE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,QAAQ,GAAG,WAAW,EAA0B,CAAC;IAEvD,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC;QAC/D,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC;QAC/D,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6DAA6D,EAAE,GAAG,EAAE;IAOvE,YAAY,EAAa,CAAC,aAAa,EAGnC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mEAAmE,EAAE,GAAG,EAAE;IAM7E,YAAY,EAAyB,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IACjE,YAAY,EAAqC,CAAC,UAAU,EAAE,CAAC;IAC/D,YAAY,EAAqC,CAAC,UAAU,EAAE,CAAC;AACjE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6EAA6E,EAAE,GAAG,EAAE;IAMvF,YAAY,EAAuB,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAClE,YAAY,EAAsC,CAAC,UAAU,EAAE,CAAC;IAChE,YAAY,EAAkC,CAAC,UAAU,EAAE,CAAC;AAC9D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;IAC7D,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,eAAe,EAAuB,CAAC;IAE5E,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,kBAAkB,CAAC,CAAC;IACjD,IAAI,IAAI,EAAE,CAAC;QACT,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;QAC3D,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;IAC7D,CAAC;IAED,MAAM,QAAQ,GAAG,WAAW,EAAsB,CAAC;IACnD,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;QACpD,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;QACpD,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QACjE,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC,CAAC"}
|
|
@@ -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,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,14 +1,11 @@
|
|
|
1
|
-
export { useCallTool } from "./use-call-tool.js";
|
|
1
|
+
export { type CallToolAsyncFn, type CallToolFn, type CallToolState, type SideEffects, useCallTool, } from "./use-call-tool.js";
|
|
2
2
|
export { useDisplayMode } from "./use-display-mode.js";
|
|
3
3
|
export { useFiles } from "./use-files.js";
|
|
4
|
-
export {
|
|
5
|
-
export { useOpenAiGlobal } from "./use-openai-global.js";
|
|
4
|
+
export { type LayoutState, useLayout } from "./use-layout.js";
|
|
6
5
|
export { useOpenExternal } from "./use-open-external.js";
|
|
6
|
+
export { useOpenAiGlobal } from "./use-openai-global.js";
|
|
7
7
|
export { useRequestModal } from "./use-request-modal.js";
|
|
8
8
|
export { useSendFollowUpMessage } from "./use-send-follow-up-message.js";
|
|
9
|
-
export { useTheme } from "./use-theme.js";
|
|
10
9
|
export { useToolInfo } from "./use-tool-info.js";
|
|
11
|
-
export {
|
|
12
|
-
export { useToolResponseMetadata } from "./use-tool-response-metadata.js";
|
|
13
|
-
export { useUserAgent } from "./use-user-agent.js";
|
|
10
|
+
export { type UserState, useUser } from "./use-user.js";
|
|
14
11
|
export { useWidgetState } from "./use-widget-state.js";
|
|
@@ -1,15 +1,12 @@
|
|
|
1
|
-
export { useCallTool } from "./use-call-tool.js";
|
|
1
|
+
export { useCallTool, } from "./use-call-tool.js";
|
|
2
2
|
export { useDisplayMode } from "./use-display-mode.js";
|
|
3
3
|
export { useFiles } from "./use-files.js";
|
|
4
|
-
export {
|
|
5
|
-
export { useOpenAiGlobal } from "./use-openai-global.js";
|
|
4
|
+
export { useLayout } from "./use-layout.js";
|
|
6
5
|
export { useOpenExternal } from "./use-open-external.js";
|
|
6
|
+
export { useOpenAiGlobal } from "./use-openai-global.js";
|
|
7
7
|
export { useRequestModal } from "./use-request-modal.js";
|
|
8
8
|
export { useSendFollowUpMessage } from "./use-send-follow-up-message.js";
|
|
9
|
-
export { useTheme } from "./use-theme.js";
|
|
10
9
|
export { useToolInfo } from "./use-tool-info.js";
|
|
11
|
-
export {
|
|
12
|
-
export { useToolResponseMetadata } from "./use-tool-response-metadata.js";
|
|
13
|
-
export { useUserAgent } from "./use-user-agent.js";
|
|
10
|
+
export { useUser } from "./use-user.js";
|
|
14
11
|
export { useWidgetState } from "./use-widget-state.js";
|
|
15
12
|
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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,EAAoB,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC9D,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,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAkB,OAAO,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { McpUiHostContext, McpUiInitializeRequest, McpUiToolResultNotification } from "@modelcontextprotocol/ext-apps";
|
|
2
|
+
export declare const getMcpAppHostPostMessageMock: (initialContext?: McpUiHostContext) => import("vitest").Mock<(message: McpUiInitializeRequest & {
|
|
3
|
+
id: number;
|
|
4
|
+
}) => void>;
|
|
5
|
+
export declare const fireToolInputNotification: (args: Record<string, unknown>) => void;
|
|
6
|
+
export declare const fireToolResultNotification: (params: {
|
|
7
|
+
content: McpUiToolResultNotification["params"]["content"];
|
|
8
|
+
structuredContent: Record<string, unknown>;
|
|
9
|
+
_meta?: Record<string, unknown>;
|
|
10
|
+
}) => void;
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { fireEvent } from "@testing-library/react";
|
|
2
|
+
import { act } from "react";
|
|
3
|
+
import { vi } from "vitest";
|
|
4
|
+
const DEFAULT_CONTEXT = {};
|
|
5
|
+
export const getMcpAppHostPostMessageMock = (initialContext = DEFAULT_CONTEXT) => vi.fn((message) => {
|
|
6
|
+
const result = {
|
|
7
|
+
protocolVersion: "2025-06-18",
|
|
8
|
+
hostInfo: { name: "test-host", version: "1.0.0" },
|
|
9
|
+
hostCapabilities: {},
|
|
10
|
+
hostContext: initialContext,
|
|
11
|
+
};
|
|
12
|
+
act(() => fireEvent(window, new MessageEvent("message", {
|
|
13
|
+
data: {
|
|
14
|
+
jsonrpc: "2.0",
|
|
15
|
+
id: message.id,
|
|
16
|
+
result,
|
|
17
|
+
},
|
|
18
|
+
})));
|
|
19
|
+
});
|
|
20
|
+
export const fireToolInputNotification = (args) => {
|
|
21
|
+
fireEvent(window, new MessageEvent("message", {
|
|
22
|
+
data: {
|
|
23
|
+
jsonrpc: "2.0",
|
|
24
|
+
method: "ui/notifications/tool-input",
|
|
25
|
+
params: {
|
|
26
|
+
arguments: args,
|
|
27
|
+
},
|
|
28
|
+
},
|
|
29
|
+
}));
|
|
30
|
+
};
|
|
31
|
+
export const fireToolResultNotification = (params) => {
|
|
32
|
+
fireEvent(window, new MessageEvent("message", {
|
|
33
|
+
data: {
|
|
34
|
+
jsonrpc: "2.0",
|
|
35
|
+
method: "ui/notifications/tool-result",
|
|
36
|
+
params,
|
|
37
|
+
},
|
|
38
|
+
}));
|
|
39
|
+
};
|
|
40
|
+
//# sourceMappingURL=utils.js.map
|