@modelcontextprotocol/ext-apps 0.0.7 → 0.2.0
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 +2 -2
- package/dist/src/app-bridge.d.ts +341 -26
- package/dist/src/app-bridge.js +38 -25
- package/dist/src/app.d.ts +141 -10
- package/dist/src/app.js +38 -25
- package/dist/src/generated/schema.d.ts +708 -0
- package/dist/src/generated/schema.test.d.ts +33 -0
- package/dist/src/react/index.d.ts +4 -0
- package/dist/src/react/index.js +38 -25
- package/dist/src/react/useDocumentTheme.d.ts +46 -0
- package/dist/src/react/useHostStyles.d.ts +56 -0
- package/dist/src/server/index.d.ts +109 -0
- package/dist/src/server/index.js +42 -0
- package/dist/src/server/index.test.d.ts +1 -0
- package/dist/src/spec.types.d.ts +412 -0
- package/dist/src/styles.d.ts +89 -0
- package/dist/src/types.d.ts +28 -836
- package/package.json +55 -16
|
@@ -0,0 +1,708 @@
|
|
|
1
|
+
import * as z from "zod/v4";
|
|
2
|
+
/**
|
|
3
|
+
* @description Color theme preference for the host environment.
|
|
4
|
+
*/
|
|
5
|
+
export declare const McpUiThemeSchema: z.ZodUnion<readonly [z.ZodLiteral<"light">, z.ZodLiteral<"dark">]>;
|
|
6
|
+
/**
|
|
7
|
+
* @description Display mode for UI presentation.
|
|
8
|
+
*/
|
|
9
|
+
export declare const McpUiDisplayModeSchema: z.ZodUnion<readonly [z.ZodLiteral<"inline">, z.ZodLiteral<"fullscreen">, z.ZodLiteral<"pip">]>;
|
|
10
|
+
/**
|
|
11
|
+
* @description CSS variable keys available to MCP apps for theming.
|
|
12
|
+
*/
|
|
13
|
+
export declare const McpUiStyleVariableKeySchema: z.ZodUnion<readonly [z.ZodLiteral<"--color-background-primary">, z.ZodLiteral<"--color-background-secondary">, z.ZodLiteral<"--color-background-tertiary">, z.ZodLiteral<"--color-background-inverse">, z.ZodLiteral<"--color-background-ghost">, z.ZodLiteral<"--color-background-info">, z.ZodLiteral<"--color-background-danger">, z.ZodLiteral<"--color-background-success">, z.ZodLiteral<"--color-background-warning">, z.ZodLiteral<"--color-background-disabled">, z.ZodLiteral<"--color-text-primary">, z.ZodLiteral<"--color-text-secondary">, z.ZodLiteral<"--color-text-tertiary">, z.ZodLiteral<"--color-text-inverse">, z.ZodLiteral<"--color-text-info">, z.ZodLiteral<"--color-text-danger">, z.ZodLiteral<"--color-text-success">, z.ZodLiteral<"--color-text-warning">, z.ZodLiteral<"--color-text-disabled">, z.ZodLiteral<"--color-border-primary">, z.ZodLiteral<"--color-border-secondary">, z.ZodLiteral<"--color-border-tertiary">, z.ZodLiteral<"--color-border-inverse">, z.ZodLiteral<"--color-border-ghost">, z.ZodLiteral<"--color-border-info">, z.ZodLiteral<"--color-border-danger">, z.ZodLiteral<"--color-border-success">, z.ZodLiteral<"--color-border-warning">, z.ZodLiteral<"--color-border-disabled">, z.ZodLiteral<"--color-ring-primary">, z.ZodLiteral<"--color-ring-secondary">, z.ZodLiteral<"--color-ring-inverse">, z.ZodLiteral<"--color-ring-info">, z.ZodLiteral<"--color-ring-danger">, z.ZodLiteral<"--color-ring-success">, z.ZodLiteral<"--color-ring-warning">, z.ZodLiteral<"--font-sans">, z.ZodLiteral<"--font-mono">, z.ZodLiteral<"--font-weight-normal">, z.ZodLiteral<"--font-weight-medium">, z.ZodLiteral<"--font-weight-semibold">, z.ZodLiteral<"--font-weight-bold">, z.ZodLiteral<"--font-text-xs-size">, z.ZodLiteral<"--font-text-sm-size">, z.ZodLiteral<"--font-text-md-size">, z.ZodLiteral<"--font-text-lg-size">, z.ZodLiteral<"--font-heading-xs-size">, z.ZodLiteral<"--font-heading-sm-size">, z.ZodLiteral<"--font-heading-md-size">, z.ZodLiteral<"--font-heading-lg-size">, z.ZodLiteral<"--font-heading-xl-size">, z.ZodLiteral<"--font-heading-2xl-size">, z.ZodLiteral<"--font-heading-3xl-size">, z.ZodLiteral<"--font-text-xs-line-height">, z.ZodLiteral<"--font-text-sm-line-height">, z.ZodLiteral<"--font-text-md-line-height">, z.ZodLiteral<"--font-text-lg-line-height">, z.ZodLiteral<"--font-heading-xs-line-height">, z.ZodLiteral<"--font-heading-sm-line-height">, z.ZodLiteral<"--font-heading-md-line-height">, z.ZodLiteral<"--font-heading-lg-line-height">, z.ZodLiteral<"--font-heading-xl-line-height">, z.ZodLiteral<"--font-heading-2xl-line-height">, z.ZodLiteral<"--font-heading-3xl-line-height">, z.ZodLiteral<"--border-radius-xs">, z.ZodLiteral<"--border-radius-sm">, z.ZodLiteral<"--border-radius-md">, z.ZodLiteral<"--border-radius-lg">, z.ZodLiteral<"--border-radius-xl">, z.ZodLiteral<"--border-radius-full">, z.ZodLiteral<"--border-width-regular">, z.ZodLiteral<"--shadow-hairline">, z.ZodLiteral<"--shadow-sm">, z.ZodLiteral<"--shadow-md">, z.ZodLiteral<"--shadow-lg">]>;
|
|
14
|
+
/**
|
|
15
|
+
* @description Style variables for theming MCP apps.
|
|
16
|
+
*
|
|
17
|
+
* Individual style keys are optional - hosts may provide any subset of these values.
|
|
18
|
+
* Values are strings containing CSS values (colors, sizes, font stacks, etc.).
|
|
19
|
+
*
|
|
20
|
+
* Note: This type uses `Record<K, string | undefined>` rather than `Partial<Record<K, string>>`
|
|
21
|
+
* for compatibility with Zod schema generation. Both are functionally equivalent for validation.
|
|
22
|
+
*/
|
|
23
|
+
export declare const McpUiStylesSchema: z.ZodRecord<z.ZodUnion<readonly [z.ZodLiteral<"--color-background-primary">, z.ZodLiteral<"--color-background-secondary">, z.ZodLiteral<"--color-background-tertiary">, z.ZodLiteral<"--color-background-inverse">, z.ZodLiteral<"--color-background-ghost">, z.ZodLiteral<"--color-background-info">, z.ZodLiteral<"--color-background-danger">, z.ZodLiteral<"--color-background-success">, z.ZodLiteral<"--color-background-warning">, z.ZodLiteral<"--color-background-disabled">, z.ZodLiteral<"--color-text-primary">, z.ZodLiteral<"--color-text-secondary">, z.ZodLiteral<"--color-text-tertiary">, z.ZodLiteral<"--color-text-inverse">, z.ZodLiteral<"--color-text-info">, z.ZodLiteral<"--color-text-danger">, z.ZodLiteral<"--color-text-success">, z.ZodLiteral<"--color-text-warning">, z.ZodLiteral<"--color-text-disabled">, z.ZodLiteral<"--color-border-primary">, z.ZodLiteral<"--color-border-secondary">, z.ZodLiteral<"--color-border-tertiary">, z.ZodLiteral<"--color-border-inverse">, z.ZodLiteral<"--color-border-ghost">, z.ZodLiteral<"--color-border-info">, z.ZodLiteral<"--color-border-danger">, z.ZodLiteral<"--color-border-success">, z.ZodLiteral<"--color-border-warning">, z.ZodLiteral<"--color-border-disabled">, z.ZodLiteral<"--color-ring-primary">, z.ZodLiteral<"--color-ring-secondary">, z.ZodLiteral<"--color-ring-inverse">, z.ZodLiteral<"--color-ring-info">, z.ZodLiteral<"--color-ring-danger">, z.ZodLiteral<"--color-ring-success">, z.ZodLiteral<"--color-ring-warning">, z.ZodLiteral<"--font-sans">, z.ZodLiteral<"--font-mono">, z.ZodLiteral<"--font-weight-normal">, z.ZodLiteral<"--font-weight-medium">, z.ZodLiteral<"--font-weight-semibold">, z.ZodLiteral<"--font-weight-bold">, z.ZodLiteral<"--font-text-xs-size">, z.ZodLiteral<"--font-text-sm-size">, z.ZodLiteral<"--font-text-md-size">, z.ZodLiteral<"--font-text-lg-size">, z.ZodLiteral<"--font-heading-xs-size">, z.ZodLiteral<"--font-heading-sm-size">, z.ZodLiteral<"--font-heading-md-size">, z.ZodLiteral<"--font-heading-lg-size">, z.ZodLiteral<"--font-heading-xl-size">, z.ZodLiteral<"--font-heading-2xl-size">, z.ZodLiteral<"--font-heading-3xl-size">, z.ZodLiteral<"--font-text-xs-line-height">, z.ZodLiteral<"--font-text-sm-line-height">, z.ZodLiteral<"--font-text-md-line-height">, z.ZodLiteral<"--font-text-lg-line-height">, z.ZodLiteral<"--font-heading-xs-line-height">, z.ZodLiteral<"--font-heading-sm-line-height">, z.ZodLiteral<"--font-heading-md-line-height">, z.ZodLiteral<"--font-heading-lg-line-height">, z.ZodLiteral<"--font-heading-xl-line-height">, z.ZodLiteral<"--font-heading-2xl-line-height">, z.ZodLiteral<"--font-heading-3xl-line-height">, z.ZodLiteral<"--border-radius-xs">, z.ZodLiteral<"--border-radius-sm">, z.ZodLiteral<"--border-radius-md">, z.ZodLiteral<"--border-radius-lg">, z.ZodLiteral<"--border-radius-xl">, z.ZodLiteral<"--border-radius-full">, z.ZodLiteral<"--border-width-regular">, z.ZodLiteral<"--shadow-hairline">, z.ZodLiteral<"--shadow-sm">, z.ZodLiteral<"--shadow-md">, z.ZodLiteral<"--shadow-lg">]>, z.ZodUnion<readonly [z.ZodString, z.ZodUndefined]>>;
|
|
24
|
+
/**
|
|
25
|
+
* @description Request to open an external URL in the host's default browser.
|
|
26
|
+
* @see {@link app.App.sendOpenLink} for the method that sends this request
|
|
27
|
+
*/
|
|
28
|
+
export declare const McpUiOpenLinkRequestSchema: z.ZodObject<{
|
|
29
|
+
method: z.ZodLiteral<"ui/open-link">;
|
|
30
|
+
params: z.ZodObject<{
|
|
31
|
+
url: z.ZodString;
|
|
32
|
+
}, z.core.$strip>;
|
|
33
|
+
}, z.core.$strip>;
|
|
34
|
+
/**
|
|
35
|
+
* @description Result from opening a URL.
|
|
36
|
+
* @see {@link McpUiOpenLinkRequest}
|
|
37
|
+
*/
|
|
38
|
+
export declare const McpUiOpenLinkResultSchema: z.ZodObject<{
|
|
39
|
+
/** @description True if the host failed to open the URL (e.g., due to security policy). */
|
|
40
|
+
isError: z.ZodOptional<z.ZodBoolean>;
|
|
41
|
+
}, z.core.$loose>;
|
|
42
|
+
/**
|
|
43
|
+
* @description Result from sending a message.
|
|
44
|
+
* @see {@link McpUiMessageRequest}
|
|
45
|
+
*/
|
|
46
|
+
export declare const McpUiMessageResultSchema: z.ZodObject<{
|
|
47
|
+
/** @description True if the host rejected or failed to deliver the message. */
|
|
48
|
+
isError: z.ZodOptional<z.ZodBoolean>;
|
|
49
|
+
}, z.core.$loose>;
|
|
50
|
+
/**
|
|
51
|
+
* @description Notification that the sandbox proxy iframe is ready to receive content.
|
|
52
|
+
* @internal
|
|
53
|
+
* @see https://github.com/modelcontextprotocol/ext-apps/blob/main/specification/draft/apps.mdx#sandbox-proxy
|
|
54
|
+
*/
|
|
55
|
+
export declare const McpUiSandboxProxyReadyNotificationSchema: z.ZodObject<{
|
|
56
|
+
method: z.ZodLiteral<"ui/notifications/sandbox-proxy-ready">;
|
|
57
|
+
params: z.ZodObject<{}, z.core.$strip>;
|
|
58
|
+
}, z.core.$strip>;
|
|
59
|
+
/**
|
|
60
|
+
* @description Notification containing HTML resource for the sandbox proxy to load.
|
|
61
|
+
* @internal
|
|
62
|
+
* @see https://github.com/modelcontextprotocol/ext-apps/blob/main/specification/draft/apps.mdx#sandbox-proxy
|
|
63
|
+
*/
|
|
64
|
+
export declare const McpUiSandboxResourceReadyNotificationSchema: z.ZodObject<{
|
|
65
|
+
method: z.ZodLiteral<"ui/notifications/sandbox-resource-ready">;
|
|
66
|
+
params: z.ZodObject<{
|
|
67
|
+
html: z.ZodString;
|
|
68
|
+
sandbox: z.ZodOptional<z.ZodString>;
|
|
69
|
+
csp: z.ZodOptional<z.ZodObject<{
|
|
70
|
+
connectDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
71
|
+
resourceDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
72
|
+
}, z.core.$strip>>;
|
|
73
|
+
}, z.core.$strip>;
|
|
74
|
+
}, z.core.$strip>;
|
|
75
|
+
/**
|
|
76
|
+
* @description Notification of UI size changes (bidirectional: Guest <-> Host).
|
|
77
|
+
* @see {@link app.App.sendSizeChanged} for the method to send this from Guest UI
|
|
78
|
+
*/
|
|
79
|
+
export declare const McpUiSizeChangedNotificationSchema: z.ZodObject<{
|
|
80
|
+
method: z.ZodLiteral<"ui/notifications/size-changed">;
|
|
81
|
+
params: z.ZodObject<{
|
|
82
|
+
width: z.ZodOptional<z.ZodNumber>;
|
|
83
|
+
height: z.ZodOptional<z.ZodNumber>;
|
|
84
|
+
}, z.core.$strip>;
|
|
85
|
+
}, z.core.$strip>;
|
|
86
|
+
/**
|
|
87
|
+
* @description Notification containing complete tool arguments (Host -> Guest UI).
|
|
88
|
+
*/
|
|
89
|
+
export declare const McpUiToolInputNotificationSchema: z.ZodObject<{
|
|
90
|
+
method: z.ZodLiteral<"ui/notifications/tool-input">;
|
|
91
|
+
params: z.ZodObject<{
|
|
92
|
+
arguments: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
93
|
+
}, z.core.$strip>;
|
|
94
|
+
}, z.core.$strip>;
|
|
95
|
+
/**
|
|
96
|
+
* @description Notification containing partial/streaming tool arguments (Host -> Guest UI).
|
|
97
|
+
*/
|
|
98
|
+
export declare const McpUiToolInputPartialNotificationSchema: z.ZodObject<{
|
|
99
|
+
method: z.ZodLiteral<"ui/notifications/tool-input-partial">;
|
|
100
|
+
params: z.ZodObject<{
|
|
101
|
+
arguments: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
102
|
+
}, z.core.$strip>;
|
|
103
|
+
}, z.core.$strip>;
|
|
104
|
+
/**
|
|
105
|
+
* @description Notification that tool execution was cancelled (Host -> Guest UI).
|
|
106
|
+
* Host MUST send this if tool execution was cancelled for any reason (user action,
|
|
107
|
+
* sampling error, classifier intervention, etc.).
|
|
108
|
+
*/
|
|
109
|
+
export declare const McpUiToolCancelledNotificationSchema: z.ZodObject<{
|
|
110
|
+
method: z.ZodLiteral<"ui/notifications/tool-cancelled">;
|
|
111
|
+
params: z.ZodObject<{
|
|
112
|
+
reason: z.ZodOptional<z.ZodString>;
|
|
113
|
+
}, z.core.$strip>;
|
|
114
|
+
}, z.core.$strip>;
|
|
115
|
+
/**
|
|
116
|
+
* @description Style configuration for theming MCP apps.
|
|
117
|
+
*/
|
|
118
|
+
export declare const McpUiHostStylesSchema: z.ZodObject<{
|
|
119
|
+
variables: z.ZodOptional<z.ZodRecord<z.ZodUnion<readonly [z.ZodLiteral<"--color-background-primary">, z.ZodLiteral<"--color-background-secondary">, z.ZodLiteral<"--color-background-tertiary">, z.ZodLiteral<"--color-background-inverse">, z.ZodLiteral<"--color-background-ghost">, z.ZodLiteral<"--color-background-info">, z.ZodLiteral<"--color-background-danger">, z.ZodLiteral<"--color-background-success">, z.ZodLiteral<"--color-background-warning">, z.ZodLiteral<"--color-background-disabled">, z.ZodLiteral<"--color-text-primary">, z.ZodLiteral<"--color-text-secondary">, z.ZodLiteral<"--color-text-tertiary">, z.ZodLiteral<"--color-text-inverse">, z.ZodLiteral<"--color-text-info">, z.ZodLiteral<"--color-text-danger">, z.ZodLiteral<"--color-text-success">, z.ZodLiteral<"--color-text-warning">, z.ZodLiteral<"--color-text-disabled">, z.ZodLiteral<"--color-border-primary">, z.ZodLiteral<"--color-border-secondary">, z.ZodLiteral<"--color-border-tertiary">, z.ZodLiteral<"--color-border-inverse">, z.ZodLiteral<"--color-border-ghost">, z.ZodLiteral<"--color-border-info">, z.ZodLiteral<"--color-border-danger">, z.ZodLiteral<"--color-border-success">, z.ZodLiteral<"--color-border-warning">, z.ZodLiteral<"--color-border-disabled">, z.ZodLiteral<"--color-ring-primary">, z.ZodLiteral<"--color-ring-secondary">, z.ZodLiteral<"--color-ring-inverse">, z.ZodLiteral<"--color-ring-info">, z.ZodLiteral<"--color-ring-danger">, z.ZodLiteral<"--color-ring-success">, z.ZodLiteral<"--color-ring-warning">, z.ZodLiteral<"--font-sans">, z.ZodLiteral<"--font-mono">, z.ZodLiteral<"--font-weight-normal">, z.ZodLiteral<"--font-weight-medium">, z.ZodLiteral<"--font-weight-semibold">, z.ZodLiteral<"--font-weight-bold">, z.ZodLiteral<"--font-text-xs-size">, z.ZodLiteral<"--font-text-sm-size">, z.ZodLiteral<"--font-text-md-size">, z.ZodLiteral<"--font-text-lg-size">, z.ZodLiteral<"--font-heading-xs-size">, z.ZodLiteral<"--font-heading-sm-size">, z.ZodLiteral<"--font-heading-md-size">, z.ZodLiteral<"--font-heading-lg-size">, z.ZodLiteral<"--font-heading-xl-size">, z.ZodLiteral<"--font-heading-2xl-size">, z.ZodLiteral<"--font-heading-3xl-size">, z.ZodLiteral<"--font-text-xs-line-height">, z.ZodLiteral<"--font-text-sm-line-height">, z.ZodLiteral<"--font-text-md-line-height">, z.ZodLiteral<"--font-text-lg-line-height">, z.ZodLiteral<"--font-heading-xs-line-height">, z.ZodLiteral<"--font-heading-sm-line-height">, z.ZodLiteral<"--font-heading-md-line-height">, z.ZodLiteral<"--font-heading-lg-line-height">, z.ZodLiteral<"--font-heading-xl-line-height">, z.ZodLiteral<"--font-heading-2xl-line-height">, z.ZodLiteral<"--font-heading-3xl-line-height">, z.ZodLiteral<"--border-radius-xs">, z.ZodLiteral<"--border-radius-sm">, z.ZodLiteral<"--border-radius-md">, z.ZodLiteral<"--border-radius-lg">, z.ZodLiteral<"--border-radius-xl">, z.ZodLiteral<"--border-radius-full">, z.ZodLiteral<"--border-width-regular">, z.ZodLiteral<"--shadow-hairline">, z.ZodLiteral<"--shadow-sm">, z.ZodLiteral<"--shadow-md">, z.ZodLiteral<"--shadow-lg">]>, z.ZodUnion<readonly [z.ZodString, z.ZodUndefined]>>>;
|
|
120
|
+
}, z.core.$strip>;
|
|
121
|
+
/**
|
|
122
|
+
* @description Request for graceful shutdown of the Guest UI (Host -> Guest UI).
|
|
123
|
+
* @see {@link app-bridge.AppBridge.teardownResource} for the host method that sends this
|
|
124
|
+
*/
|
|
125
|
+
export declare const McpUiResourceTeardownRequestSchema: z.ZodObject<{
|
|
126
|
+
method: z.ZodLiteral<"ui/resource-teardown">;
|
|
127
|
+
params: z.ZodObject<{}, z.core.$strip>;
|
|
128
|
+
}, z.core.$strip>;
|
|
129
|
+
/**
|
|
130
|
+
* @description Result from graceful shutdown request.
|
|
131
|
+
* @see {@link McpUiResourceTeardownRequest}
|
|
132
|
+
*/
|
|
133
|
+
export declare const McpUiResourceTeardownResultSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
134
|
+
/**
|
|
135
|
+
* @description Capabilities supported by the host application.
|
|
136
|
+
* @see {@link McpUiInitializeResult} for the initialization result that includes these capabilities
|
|
137
|
+
*/
|
|
138
|
+
export declare const McpUiHostCapabilitiesSchema: z.ZodObject<{
|
|
139
|
+
experimental: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
|
|
140
|
+
openLinks: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
|
|
141
|
+
serverTools: z.ZodOptional<z.ZodObject<{
|
|
142
|
+
listChanged: z.ZodOptional<z.ZodBoolean>;
|
|
143
|
+
}, z.core.$strip>>;
|
|
144
|
+
serverResources: z.ZodOptional<z.ZodObject<{
|
|
145
|
+
listChanged: z.ZodOptional<z.ZodBoolean>;
|
|
146
|
+
}, z.core.$strip>>;
|
|
147
|
+
logging: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
|
|
148
|
+
}, z.core.$strip>;
|
|
149
|
+
/**
|
|
150
|
+
* @description Capabilities provided by the Guest UI (App).
|
|
151
|
+
* @see {@link McpUiInitializeRequest} for the initialization request that includes these capabilities
|
|
152
|
+
*/
|
|
153
|
+
export declare const McpUiAppCapabilitiesSchema: z.ZodObject<{
|
|
154
|
+
experimental: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
|
|
155
|
+
tools: z.ZodOptional<z.ZodObject<{
|
|
156
|
+
listChanged: z.ZodOptional<z.ZodBoolean>;
|
|
157
|
+
}, z.core.$strip>>;
|
|
158
|
+
}, z.core.$strip>;
|
|
159
|
+
/**
|
|
160
|
+
* @description Notification that Guest UI has completed initialization (Guest UI -> Host).
|
|
161
|
+
* @see {@link app.App.connect} for the method that sends this notification
|
|
162
|
+
*/
|
|
163
|
+
export declare const McpUiInitializedNotificationSchema: z.ZodObject<{
|
|
164
|
+
method: z.ZodLiteral<"ui/notifications/initialized">;
|
|
165
|
+
params: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
|
|
166
|
+
}, z.core.$strip>;
|
|
167
|
+
/**
|
|
168
|
+
* @description Content Security Policy configuration for UI resources.
|
|
169
|
+
*/
|
|
170
|
+
export declare const McpUiResourceCspSchema: z.ZodObject<{
|
|
171
|
+
connectDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
172
|
+
resourceDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
173
|
+
}, z.core.$strip>;
|
|
174
|
+
/**
|
|
175
|
+
* @description UI Resource metadata for security and rendering configuration.
|
|
176
|
+
*/
|
|
177
|
+
export declare const McpUiResourceMetaSchema: z.ZodObject<{
|
|
178
|
+
csp: z.ZodOptional<z.ZodObject<{
|
|
179
|
+
connectDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
180
|
+
resourceDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
181
|
+
}, z.core.$strip>>;
|
|
182
|
+
domain: z.ZodOptional<z.ZodString>;
|
|
183
|
+
prefersBorder: z.ZodOptional<z.ZodBoolean>;
|
|
184
|
+
}, z.core.$strip>;
|
|
185
|
+
/**
|
|
186
|
+
* @description Request to change the display mode of the UI.
|
|
187
|
+
* The host will respond with the actual display mode that was set,
|
|
188
|
+
* which may differ from the requested mode if not supported.
|
|
189
|
+
* @see {@link app.App.requestDisplayMode} for the method that sends this request
|
|
190
|
+
*/
|
|
191
|
+
export declare const McpUiRequestDisplayModeRequestSchema: z.ZodObject<{
|
|
192
|
+
method: z.ZodLiteral<"ui/request-display-mode">;
|
|
193
|
+
params: z.ZodObject<{
|
|
194
|
+
mode: z.ZodUnion<readonly [z.ZodLiteral<"inline">, z.ZodLiteral<"fullscreen">, z.ZodLiteral<"pip">]>;
|
|
195
|
+
}, z.core.$strip>;
|
|
196
|
+
}, z.core.$strip>;
|
|
197
|
+
/**
|
|
198
|
+
* @description Result from requesting a display mode change.
|
|
199
|
+
* @see {@link McpUiRequestDisplayModeRequest}
|
|
200
|
+
*/
|
|
201
|
+
export declare const McpUiRequestDisplayModeResultSchema: z.ZodObject<{
|
|
202
|
+
/** @description The display mode that was actually set. May differ from requested if not supported. */
|
|
203
|
+
mode: z.ZodUnion<readonly [z.ZodLiteral<"inline">, z.ZodLiteral<"fullscreen">, z.ZodLiteral<"pip">]>;
|
|
204
|
+
}, z.core.$loose>;
|
|
205
|
+
/**
|
|
206
|
+
* @description Tool visibility scope - who can access the tool.
|
|
207
|
+
*/
|
|
208
|
+
export declare const McpUiToolVisibilitySchema: z.ZodUnion<readonly [z.ZodLiteral<"model">, z.ZodLiteral<"app">]>;
|
|
209
|
+
/**
|
|
210
|
+
* @description UI-related metadata for tools.
|
|
211
|
+
*/
|
|
212
|
+
export declare const McpUiToolMetaSchema: z.ZodObject<{
|
|
213
|
+
resourceUri: z.ZodString;
|
|
214
|
+
visibility: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"model">, z.ZodLiteral<"app">]>>>;
|
|
215
|
+
}, z.core.$strip>;
|
|
216
|
+
/**
|
|
217
|
+
* @description Request to send a message to the host's chat interface.
|
|
218
|
+
* @see {@link app.App.sendMessage} for the method that sends this request
|
|
219
|
+
*/
|
|
220
|
+
export declare const McpUiMessageRequestSchema: z.ZodObject<{
|
|
221
|
+
method: z.ZodLiteral<"ui/message">;
|
|
222
|
+
params: z.ZodObject<{
|
|
223
|
+
role: z.ZodLiteral<"user">;
|
|
224
|
+
content: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
|
|
225
|
+
type: z.ZodLiteral<"text">;
|
|
226
|
+
text: z.ZodString;
|
|
227
|
+
annotations: z.ZodOptional<z.ZodObject<{
|
|
228
|
+
audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
229
|
+
user: "user";
|
|
230
|
+
assistant: "assistant";
|
|
231
|
+
}>>>;
|
|
232
|
+
priority: z.ZodOptional<z.ZodNumber>;
|
|
233
|
+
lastModified: z.ZodOptional<z.ZodISODateTime>;
|
|
234
|
+
}, z.core.$strip>>;
|
|
235
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
236
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
237
|
+
type: z.ZodLiteral<"image">;
|
|
238
|
+
data: z.ZodString;
|
|
239
|
+
mimeType: z.ZodString;
|
|
240
|
+
annotations: z.ZodOptional<z.ZodObject<{
|
|
241
|
+
audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
242
|
+
user: "user";
|
|
243
|
+
assistant: "assistant";
|
|
244
|
+
}>>>;
|
|
245
|
+
priority: z.ZodOptional<z.ZodNumber>;
|
|
246
|
+
lastModified: z.ZodOptional<z.ZodISODateTime>;
|
|
247
|
+
}, z.core.$strip>>;
|
|
248
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
249
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
250
|
+
type: z.ZodLiteral<"audio">;
|
|
251
|
+
data: z.ZodString;
|
|
252
|
+
mimeType: z.ZodString;
|
|
253
|
+
annotations: z.ZodOptional<z.ZodObject<{
|
|
254
|
+
audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
255
|
+
user: "user";
|
|
256
|
+
assistant: "assistant";
|
|
257
|
+
}>>>;
|
|
258
|
+
priority: z.ZodOptional<z.ZodNumber>;
|
|
259
|
+
lastModified: z.ZodOptional<z.ZodISODateTime>;
|
|
260
|
+
}, z.core.$strip>>;
|
|
261
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
262
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
263
|
+
uri: z.ZodString;
|
|
264
|
+
description: z.ZodOptional<z.ZodString>;
|
|
265
|
+
mimeType: z.ZodOptional<z.ZodString>;
|
|
266
|
+
annotations: z.ZodOptional<z.ZodObject<{
|
|
267
|
+
audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
268
|
+
user: "user";
|
|
269
|
+
assistant: "assistant";
|
|
270
|
+
}>>>;
|
|
271
|
+
priority: z.ZodOptional<z.ZodNumber>;
|
|
272
|
+
lastModified: z.ZodOptional<z.ZodISODateTime>;
|
|
273
|
+
}, z.core.$strip>>;
|
|
274
|
+
_meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
|
|
275
|
+
icons: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
276
|
+
src: z.ZodString;
|
|
277
|
+
mimeType: z.ZodOptional<z.ZodString>;
|
|
278
|
+
sizes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
279
|
+
}, z.core.$strip>>>;
|
|
280
|
+
name: z.ZodString;
|
|
281
|
+
title: z.ZodOptional<z.ZodString>;
|
|
282
|
+
type: z.ZodLiteral<"resource_link">;
|
|
283
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
284
|
+
type: z.ZodLiteral<"resource">;
|
|
285
|
+
resource: z.ZodUnion<readonly [z.ZodObject<{
|
|
286
|
+
uri: z.ZodString;
|
|
287
|
+
mimeType: z.ZodOptional<z.ZodString>;
|
|
288
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
289
|
+
text: z.ZodString;
|
|
290
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
291
|
+
uri: z.ZodString;
|
|
292
|
+
mimeType: z.ZodOptional<z.ZodString>;
|
|
293
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
294
|
+
blob: z.ZodString;
|
|
295
|
+
}, z.core.$strip>]>;
|
|
296
|
+
annotations: z.ZodOptional<z.ZodObject<{
|
|
297
|
+
audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
298
|
+
user: "user";
|
|
299
|
+
assistant: "assistant";
|
|
300
|
+
}>>>;
|
|
301
|
+
priority: z.ZodOptional<z.ZodNumber>;
|
|
302
|
+
lastModified: z.ZodOptional<z.ZodISODateTime>;
|
|
303
|
+
}, z.core.$strip>>;
|
|
304
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
305
|
+
}, z.core.$strip>]>>;
|
|
306
|
+
}, z.core.$strip>;
|
|
307
|
+
}, z.core.$strip>;
|
|
308
|
+
/**
|
|
309
|
+
* @description Notification containing tool execution result (Host -> Guest UI).
|
|
310
|
+
*/
|
|
311
|
+
export declare const McpUiToolResultNotificationSchema: z.ZodObject<{
|
|
312
|
+
method: z.ZodLiteral<"ui/notifications/tool-result">;
|
|
313
|
+
params: z.ZodObject<{
|
|
314
|
+
_meta: z.ZodOptional<z.ZodObject<{
|
|
315
|
+
"io.modelcontextprotocol/related-task": z.ZodOptional<z.ZodObject<{
|
|
316
|
+
taskId: z.ZodString;
|
|
317
|
+
}, z.core.$loose>>;
|
|
318
|
+
}, z.core.$loose>>;
|
|
319
|
+
content: z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
|
|
320
|
+
type: z.ZodLiteral<"text">;
|
|
321
|
+
text: z.ZodString;
|
|
322
|
+
annotations: z.ZodOptional<z.ZodObject<{
|
|
323
|
+
audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
324
|
+
user: "user";
|
|
325
|
+
assistant: "assistant";
|
|
326
|
+
}>>>;
|
|
327
|
+
priority: z.ZodOptional<z.ZodNumber>;
|
|
328
|
+
lastModified: z.ZodOptional<z.ZodISODateTime>;
|
|
329
|
+
}, z.core.$strip>>;
|
|
330
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
331
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
332
|
+
type: z.ZodLiteral<"image">;
|
|
333
|
+
data: z.ZodString;
|
|
334
|
+
mimeType: z.ZodString;
|
|
335
|
+
annotations: z.ZodOptional<z.ZodObject<{
|
|
336
|
+
audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
337
|
+
user: "user";
|
|
338
|
+
assistant: "assistant";
|
|
339
|
+
}>>>;
|
|
340
|
+
priority: z.ZodOptional<z.ZodNumber>;
|
|
341
|
+
lastModified: z.ZodOptional<z.ZodISODateTime>;
|
|
342
|
+
}, z.core.$strip>>;
|
|
343
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
344
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
345
|
+
type: z.ZodLiteral<"audio">;
|
|
346
|
+
data: z.ZodString;
|
|
347
|
+
mimeType: z.ZodString;
|
|
348
|
+
annotations: z.ZodOptional<z.ZodObject<{
|
|
349
|
+
audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
350
|
+
user: "user";
|
|
351
|
+
assistant: "assistant";
|
|
352
|
+
}>>>;
|
|
353
|
+
priority: z.ZodOptional<z.ZodNumber>;
|
|
354
|
+
lastModified: z.ZodOptional<z.ZodISODateTime>;
|
|
355
|
+
}, z.core.$strip>>;
|
|
356
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
357
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
358
|
+
uri: z.ZodString;
|
|
359
|
+
description: z.ZodOptional<z.ZodString>;
|
|
360
|
+
mimeType: z.ZodOptional<z.ZodString>;
|
|
361
|
+
annotations: z.ZodOptional<z.ZodObject<{
|
|
362
|
+
audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
363
|
+
user: "user";
|
|
364
|
+
assistant: "assistant";
|
|
365
|
+
}>>>;
|
|
366
|
+
priority: z.ZodOptional<z.ZodNumber>;
|
|
367
|
+
lastModified: z.ZodOptional<z.ZodISODateTime>;
|
|
368
|
+
}, z.core.$strip>>;
|
|
369
|
+
_meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
|
|
370
|
+
icons: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
371
|
+
src: z.ZodString;
|
|
372
|
+
mimeType: z.ZodOptional<z.ZodString>;
|
|
373
|
+
sizes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
374
|
+
}, z.core.$strip>>>;
|
|
375
|
+
name: z.ZodString;
|
|
376
|
+
title: z.ZodOptional<z.ZodString>;
|
|
377
|
+
type: z.ZodLiteral<"resource_link">;
|
|
378
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
379
|
+
type: z.ZodLiteral<"resource">;
|
|
380
|
+
resource: z.ZodUnion<readonly [z.ZodObject<{
|
|
381
|
+
uri: z.ZodString;
|
|
382
|
+
mimeType: z.ZodOptional<z.ZodString>;
|
|
383
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
384
|
+
text: z.ZodString;
|
|
385
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
386
|
+
uri: z.ZodString;
|
|
387
|
+
mimeType: z.ZodOptional<z.ZodString>;
|
|
388
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
389
|
+
blob: z.ZodString;
|
|
390
|
+
}, z.core.$strip>]>;
|
|
391
|
+
annotations: z.ZodOptional<z.ZodObject<{
|
|
392
|
+
audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
393
|
+
user: "user";
|
|
394
|
+
assistant: "assistant";
|
|
395
|
+
}>>>;
|
|
396
|
+
priority: z.ZodOptional<z.ZodNumber>;
|
|
397
|
+
lastModified: z.ZodOptional<z.ZodISODateTime>;
|
|
398
|
+
}, z.core.$strip>>;
|
|
399
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
400
|
+
}, z.core.$strip>]>>>;
|
|
401
|
+
structuredContent: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
402
|
+
isError: z.ZodOptional<z.ZodBoolean>;
|
|
403
|
+
}, z.core.$loose>;
|
|
404
|
+
}, z.core.$strip>;
|
|
405
|
+
/**
|
|
406
|
+
* @description Rich context about the host environment provided to Guest UIs.
|
|
407
|
+
*/
|
|
408
|
+
export declare const McpUiHostContextSchema: z.ZodObject<{
|
|
409
|
+
/** @description Metadata of the tool call that instantiated this App. */
|
|
410
|
+
toolInfo: z.ZodOptional<z.ZodObject<{
|
|
411
|
+
id: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
|
|
412
|
+
tool: z.ZodObject<{
|
|
413
|
+
description: z.ZodOptional<z.ZodString>;
|
|
414
|
+
inputSchema: z.ZodObject<{
|
|
415
|
+
type: z.ZodLiteral<"object">;
|
|
416
|
+
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodCustom<object, object>>>;
|
|
417
|
+
required: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
418
|
+
}, z.core.$catchall<z.ZodUnknown>>;
|
|
419
|
+
outputSchema: z.ZodOptional<z.ZodObject<{
|
|
420
|
+
type: z.ZodLiteral<"object">;
|
|
421
|
+
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodCustom<object, object>>>;
|
|
422
|
+
required: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
423
|
+
}, z.core.$catchall<z.ZodUnknown>>>;
|
|
424
|
+
annotations: z.ZodOptional<z.ZodObject<{
|
|
425
|
+
title: z.ZodOptional<z.ZodString>;
|
|
426
|
+
readOnlyHint: z.ZodOptional<z.ZodBoolean>;
|
|
427
|
+
destructiveHint: z.ZodOptional<z.ZodBoolean>;
|
|
428
|
+
idempotentHint: z.ZodOptional<z.ZodBoolean>;
|
|
429
|
+
openWorldHint: z.ZodOptional<z.ZodBoolean>;
|
|
430
|
+
}, z.core.$strip>>;
|
|
431
|
+
execution: z.ZodOptional<z.ZodObject<{
|
|
432
|
+
taskSupport: z.ZodOptional<z.ZodEnum<{
|
|
433
|
+
optional: "optional";
|
|
434
|
+
required: "required";
|
|
435
|
+
forbidden: "forbidden";
|
|
436
|
+
}>>;
|
|
437
|
+
}, z.core.$strip>>;
|
|
438
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
439
|
+
icons: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
440
|
+
src: z.ZodString;
|
|
441
|
+
mimeType: z.ZodOptional<z.ZodString>;
|
|
442
|
+
sizes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
443
|
+
}, z.core.$strip>>>;
|
|
444
|
+
name: z.ZodString;
|
|
445
|
+
title: z.ZodOptional<z.ZodString>;
|
|
446
|
+
}, z.core.$strip>;
|
|
447
|
+
}, z.core.$strip>>;
|
|
448
|
+
/** @description Current color theme preference. */
|
|
449
|
+
theme: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"light">, z.ZodLiteral<"dark">]>>;
|
|
450
|
+
/** @description Style configuration for theming the app. */
|
|
451
|
+
styles: z.ZodOptional<z.ZodObject<{
|
|
452
|
+
variables: z.ZodOptional<z.ZodRecord<z.ZodUnion<readonly [z.ZodLiteral<"--color-background-primary">, z.ZodLiteral<"--color-background-secondary">, z.ZodLiteral<"--color-background-tertiary">, z.ZodLiteral<"--color-background-inverse">, z.ZodLiteral<"--color-background-ghost">, z.ZodLiteral<"--color-background-info">, z.ZodLiteral<"--color-background-danger">, z.ZodLiteral<"--color-background-success">, z.ZodLiteral<"--color-background-warning">, z.ZodLiteral<"--color-background-disabled">, z.ZodLiteral<"--color-text-primary">, z.ZodLiteral<"--color-text-secondary">, z.ZodLiteral<"--color-text-tertiary">, z.ZodLiteral<"--color-text-inverse">, z.ZodLiteral<"--color-text-info">, z.ZodLiteral<"--color-text-danger">, z.ZodLiteral<"--color-text-success">, z.ZodLiteral<"--color-text-warning">, z.ZodLiteral<"--color-text-disabled">, z.ZodLiteral<"--color-border-primary">, z.ZodLiteral<"--color-border-secondary">, z.ZodLiteral<"--color-border-tertiary">, z.ZodLiteral<"--color-border-inverse">, z.ZodLiteral<"--color-border-ghost">, z.ZodLiteral<"--color-border-info">, z.ZodLiteral<"--color-border-danger">, z.ZodLiteral<"--color-border-success">, z.ZodLiteral<"--color-border-warning">, z.ZodLiteral<"--color-border-disabled">, z.ZodLiteral<"--color-ring-primary">, z.ZodLiteral<"--color-ring-secondary">, z.ZodLiteral<"--color-ring-inverse">, z.ZodLiteral<"--color-ring-info">, z.ZodLiteral<"--color-ring-danger">, z.ZodLiteral<"--color-ring-success">, z.ZodLiteral<"--color-ring-warning">, z.ZodLiteral<"--font-sans">, z.ZodLiteral<"--font-mono">, z.ZodLiteral<"--font-weight-normal">, z.ZodLiteral<"--font-weight-medium">, z.ZodLiteral<"--font-weight-semibold">, z.ZodLiteral<"--font-weight-bold">, z.ZodLiteral<"--font-text-xs-size">, z.ZodLiteral<"--font-text-sm-size">, z.ZodLiteral<"--font-text-md-size">, z.ZodLiteral<"--font-text-lg-size">, z.ZodLiteral<"--font-heading-xs-size">, z.ZodLiteral<"--font-heading-sm-size">, z.ZodLiteral<"--font-heading-md-size">, z.ZodLiteral<"--font-heading-lg-size">, z.ZodLiteral<"--font-heading-xl-size">, z.ZodLiteral<"--font-heading-2xl-size">, z.ZodLiteral<"--font-heading-3xl-size">, z.ZodLiteral<"--font-text-xs-line-height">, z.ZodLiteral<"--font-text-sm-line-height">, z.ZodLiteral<"--font-text-md-line-height">, z.ZodLiteral<"--font-text-lg-line-height">, z.ZodLiteral<"--font-heading-xs-line-height">, z.ZodLiteral<"--font-heading-sm-line-height">, z.ZodLiteral<"--font-heading-md-line-height">, z.ZodLiteral<"--font-heading-lg-line-height">, z.ZodLiteral<"--font-heading-xl-line-height">, z.ZodLiteral<"--font-heading-2xl-line-height">, z.ZodLiteral<"--font-heading-3xl-line-height">, z.ZodLiteral<"--border-radius-xs">, z.ZodLiteral<"--border-radius-sm">, z.ZodLiteral<"--border-radius-md">, z.ZodLiteral<"--border-radius-lg">, z.ZodLiteral<"--border-radius-xl">, z.ZodLiteral<"--border-radius-full">, z.ZodLiteral<"--border-width-regular">, z.ZodLiteral<"--shadow-hairline">, z.ZodLiteral<"--shadow-sm">, z.ZodLiteral<"--shadow-md">, z.ZodLiteral<"--shadow-lg">]>, z.ZodUnion<readonly [z.ZodString, z.ZodUndefined]>>>;
|
|
453
|
+
}, z.core.$strip>>;
|
|
454
|
+
/** @description How the UI is currently displayed. */
|
|
455
|
+
displayMode: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"inline">, z.ZodLiteral<"fullscreen">, z.ZodLiteral<"pip">]>>;
|
|
456
|
+
/** @description Display modes the host supports. */
|
|
457
|
+
availableDisplayModes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
458
|
+
/** @description Current and maximum dimensions available to the UI. */
|
|
459
|
+
viewport: z.ZodOptional<z.ZodObject<{
|
|
460
|
+
width: z.ZodNumber;
|
|
461
|
+
height: z.ZodNumber;
|
|
462
|
+
maxHeight: z.ZodOptional<z.ZodNumber>;
|
|
463
|
+
maxWidth: z.ZodOptional<z.ZodNumber>;
|
|
464
|
+
}, z.core.$strip>>;
|
|
465
|
+
/** @description User's language and region preference in BCP 47 format. */
|
|
466
|
+
locale: z.ZodOptional<z.ZodString>;
|
|
467
|
+
/** @description User's timezone in IANA format. */
|
|
468
|
+
timeZone: z.ZodOptional<z.ZodString>;
|
|
469
|
+
/** @description Host application identifier. */
|
|
470
|
+
userAgent: z.ZodOptional<z.ZodString>;
|
|
471
|
+
/** @description Platform type for responsive design decisions. */
|
|
472
|
+
platform: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"web">, z.ZodLiteral<"desktop">, z.ZodLiteral<"mobile">]>>;
|
|
473
|
+
/** @description Device input capabilities. */
|
|
474
|
+
deviceCapabilities: z.ZodOptional<z.ZodObject<{
|
|
475
|
+
touch: z.ZodOptional<z.ZodBoolean>;
|
|
476
|
+
hover: z.ZodOptional<z.ZodBoolean>;
|
|
477
|
+
}, z.core.$strip>>;
|
|
478
|
+
/** @description Mobile safe area boundaries in pixels. */
|
|
479
|
+
safeAreaInsets: z.ZodOptional<z.ZodObject<{
|
|
480
|
+
top: z.ZodNumber;
|
|
481
|
+
right: z.ZodNumber;
|
|
482
|
+
bottom: z.ZodNumber;
|
|
483
|
+
left: z.ZodNumber;
|
|
484
|
+
}, z.core.$strip>>;
|
|
485
|
+
}, z.core.$loose>;
|
|
486
|
+
/**
|
|
487
|
+
* @description Notification that host context has changed (Host -> Guest UI).
|
|
488
|
+
* @see {@link McpUiHostContext} for the full context structure
|
|
489
|
+
*/
|
|
490
|
+
export declare const McpUiHostContextChangedNotificationSchema: z.ZodObject<{
|
|
491
|
+
method: z.ZodLiteral<"ui/notifications/host-context-changed">;
|
|
492
|
+
params: z.ZodObject<{
|
|
493
|
+
/** @description Metadata of the tool call that instantiated this App. */
|
|
494
|
+
toolInfo: z.ZodOptional<z.ZodObject<{
|
|
495
|
+
id: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
|
|
496
|
+
tool: z.ZodObject<{
|
|
497
|
+
description: z.ZodOptional<z.ZodString>;
|
|
498
|
+
inputSchema: z.ZodObject<{
|
|
499
|
+
type: z.ZodLiteral<"object">;
|
|
500
|
+
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodCustom<object, object>>>;
|
|
501
|
+
required: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
502
|
+
}, z.core.$catchall<z.ZodUnknown>>;
|
|
503
|
+
outputSchema: z.ZodOptional<z.ZodObject<{
|
|
504
|
+
type: z.ZodLiteral<"object">;
|
|
505
|
+
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodCustom<object, object>>>;
|
|
506
|
+
required: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
507
|
+
}, z.core.$catchall<z.ZodUnknown>>>;
|
|
508
|
+
annotations: z.ZodOptional<z.ZodObject<{
|
|
509
|
+
title: z.ZodOptional<z.ZodString>;
|
|
510
|
+
readOnlyHint: z.ZodOptional<z.ZodBoolean>;
|
|
511
|
+
destructiveHint: z.ZodOptional<z.ZodBoolean>;
|
|
512
|
+
idempotentHint: z.ZodOptional<z.ZodBoolean>;
|
|
513
|
+
openWorldHint: z.ZodOptional<z.ZodBoolean>;
|
|
514
|
+
}, z.core.$strip>>;
|
|
515
|
+
execution: z.ZodOptional<z.ZodObject<{
|
|
516
|
+
taskSupport: z.ZodOptional<z.ZodEnum<{
|
|
517
|
+
optional: "optional";
|
|
518
|
+
required: "required";
|
|
519
|
+
forbidden: "forbidden";
|
|
520
|
+
}>>;
|
|
521
|
+
}, z.core.$strip>>;
|
|
522
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
523
|
+
icons: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
524
|
+
src: z.ZodString;
|
|
525
|
+
mimeType: z.ZodOptional<z.ZodString>;
|
|
526
|
+
sizes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
527
|
+
}, z.core.$strip>>>;
|
|
528
|
+
name: z.ZodString;
|
|
529
|
+
title: z.ZodOptional<z.ZodString>;
|
|
530
|
+
}, z.core.$strip>;
|
|
531
|
+
}, z.core.$strip>>;
|
|
532
|
+
/** @description Current color theme preference. */
|
|
533
|
+
theme: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"light">, z.ZodLiteral<"dark">]>>;
|
|
534
|
+
/** @description Style configuration for theming the app. */
|
|
535
|
+
styles: z.ZodOptional<z.ZodObject<{
|
|
536
|
+
variables: z.ZodOptional<z.ZodRecord<z.ZodUnion<readonly [z.ZodLiteral<"--color-background-primary">, z.ZodLiteral<"--color-background-secondary">, z.ZodLiteral<"--color-background-tertiary">, z.ZodLiteral<"--color-background-inverse">, z.ZodLiteral<"--color-background-ghost">, z.ZodLiteral<"--color-background-info">, z.ZodLiteral<"--color-background-danger">, z.ZodLiteral<"--color-background-success">, z.ZodLiteral<"--color-background-warning">, z.ZodLiteral<"--color-background-disabled">, z.ZodLiteral<"--color-text-primary">, z.ZodLiteral<"--color-text-secondary">, z.ZodLiteral<"--color-text-tertiary">, z.ZodLiteral<"--color-text-inverse">, z.ZodLiteral<"--color-text-info">, z.ZodLiteral<"--color-text-danger">, z.ZodLiteral<"--color-text-success">, z.ZodLiteral<"--color-text-warning">, z.ZodLiteral<"--color-text-disabled">, z.ZodLiteral<"--color-border-primary">, z.ZodLiteral<"--color-border-secondary">, z.ZodLiteral<"--color-border-tertiary">, z.ZodLiteral<"--color-border-inverse">, z.ZodLiteral<"--color-border-ghost">, z.ZodLiteral<"--color-border-info">, z.ZodLiteral<"--color-border-danger">, z.ZodLiteral<"--color-border-success">, z.ZodLiteral<"--color-border-warning">, z.ZodLiteral<"--color-border-disabled">, z.ZodLiteral<"--color-ring-primary">, z.ZodLiteral<"--color-ring-secondary">, z.ZodLiteral<"--color-ring-inverse">, z.ZodLiteral<"--color-ring-info">, z.ZodLiteral<"--color-ring-danger">, z.ZodLiteral<"--color-ring-success">, z.ZodLiteral<"--color-ring-warning">, z.ZodLiteral<"--font-sans">, z.ZodLiteral<"--font-mono">, z.ZodLiteral<"--font-weight-normal">, z.ZodLiteral<"--font-weight-medium">, z.ZodLiteral<"--font-weight-semibold">, z.ZodLiteral<"--font-weight-bold">, z.ZodLiteral<"--font-text-xs-size">, z.ZodLiteral<"--font-text-sm-size">, z.ZodLiteral<"--font-text-md-size">, z.ZodLiteral<"--font-text-lg-size">, z.ZodLiteral<"--font-heading-xs-size">, z.ZodLiteral<"--font-heading-sm-size">, z.ZodLiteral<"--font-heading-md-size">, z.ZodLiteral<"--font-heading-lg-size">, z.ZodLiteral<"--font-heading-xl-size">, z.ZodLiteral<"--font-heading-2xl-size">, z.ZodLiteral<"--font-heading-3xl-size">, z.ZodLiteral<"--font-text-xs-line-height">, z.ZodLiteral<"--font-text-sm-line-height">, z.ZodLiteral<"--font-text-md-line-height">, z.ZodLiteral<"--font-text-lg-line-height">, z.ZodLiteral<"--font-heading-xs-line-height">, z.ZodLiteral<"--font-heading-sm-line-height">, z.ZodLiteral<"--font-heading-md-line-height">, z.ZodLiteral<"--font-heading-lg-line-height">, z.ZodLiteral<"--font-heading-xl-line-height">, z.ZodLiteral<"--font-heading-2xl-line-height">, z.ZodLiteral<"--font-heading-3xl-line-height">, z.ZodLiteral<"--border-radius-xs">, z.ZodLiteral<"--border-radius-sm">, z.ZodLiteral<"--border-radius-md">, z.ZodLiteral<"--border-radius-lg">, z.ZodLiteral<"--border-radius-xl">, z.ZodLiteral<"--border-radius-full">, z.ZodLiteral<"--border-width-regular">, z.ZodLiteral<"--shadow-hairline">, z.ZodLiteral<"--shadow-sm">, z.ZodLiteral<"--shadow-md">, z.ZodLiteral<"--shadow-lg">]>, z.ZodUnion<readonly [z.ZodString, z.ZodUndefined]>>>;
|
|
537
|
+
}, z.core.$strip>>;
|
|
538
|
+
/** @description How the UI is currently displayed. */
|
|
539
|
+
displayMode: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"inline">, z.ZodLiteral<"fullscreen">, z.ZodLiteral<"pip">]>>;
|
|
540
|
+
/** @description Display modes the host supports. */
|
|
541
|
+
availableDisplayModes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
542
|
+
/** @description Current and maximum dimensions available to the UI. */
|
|
543
|
+
viewport: z.ZodOptional<z.ZodObject<{
|
|
544
|
+
width: z.ZodNumber;
|
|
545
|
+
height: z.ZodNumber;
|
|
546
|
+
maxHeight: z.ZodOptional<z.ZodNumber>;
|
|
547
|
+
maxWidth: z.ZodOptional<z.ZodNumber>;
|
|
548
|
+
}, z.core.$strip>>;
|
|
549
|
+
/** @description User's language and region preference in BCP 47 format. */
|
|
550
|
+
locale: z.ZodOptional<z.ZodString>;
|
|
551
|
+
/** @description User's timezone in IANA format. */
|
|
552
|
+
timeZone: z.ZodOptional<z.ZodString>;
|
|
553
|
+
/** @description Host application identifier. */
|
|
554
|
+
userAgent: z.ZodOptional<z.ZodString>;
|
|
555
|
+
/** @description Platform type for responsive design decisions. */
|
|
556
|
+
platform: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"web">, z.ZodLiteral<"desktop">, z.ZodLiteral<"mobile">]>>;
|
|
557
|
+
/** @description Device input capabilities. */
|
|
558
|
+
deviceCapabilities: z.ZodOptional<z.ZodObject<{
|
|
559
|
+
touch: z.ZodOptional<z.ZodBoolean>;
|
|
560
|
+
hover: z.ZodOptional<z.ZodBoolean>;
|
|
561
|
+
}, z.core.$strip>>;
|
|
562
|
+
/** @description Mobile safe area boundaries in pixels. */
|
|
563
|
+
safeAreaInsets: z.ZodOptional<z.ZodObject<{
|
|
564
|
+
top: z.ZodNumber;
|
|
565
|
+
right: z.ZodNumber;
|
|
566
|
+
bottom: z.ZodNumber;
|
|
567
|
+
left: z.ZodNumber;
|
|
568
|
+
}, z.core.$strip>>;
|
|
569
|
+
}, z.core.$loose>;
|
|
570
|
+
}, z.core.$strip>;
|
|
571
|
+
/**
|
|
572
|
+
* @description Initialization request sent from Guest UI to Host.
|
|
573
|
+
* @see {@link app.App.connect} for the method that sends this request
|
|
574
|
+
*/
|
|
575
|
+
export declare const McpUiInitializeRequestSchema: z.ZodObject<{
|
|
576
|
+
method: z.ZodLiteral<"ui/initialize">;
|
|
577
|
+
params: z.ZodObject<{
|
|
578
|
+
appInfo: z.ZodObject<{
|
|
579
|
+
version: z.ZodString;
|
|
580
|
+
websiteUrl: z.ZodOptional<z.ZodString>;
|
|
581
|
+
icons: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
582
|
+
src: z.ZodString;
|
|
583
|
+
mimeType: z.ZodOptional<z.ZodString>;
|
|
584
|
+
sizes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
585
|
+
}, z.core.$strip>>>;
|
|
586
|
+
name: z.ZodString;
|
|
587
|
+
title: z.ZodOptional<z.ZodString>;
|
|
588
|
+
}, z.core.$strip>;
|
|
589
|
+
appCapabilities: z.ZodObject<{
|
|
590
|
+
experimental: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
|
|
591
|
+
tools: z.ZodOptional<z.ZodObject<{
|
|
592
|
+
listChanged: z.ZodOptional<z.ZodBoolean>;
|
|
593
|
+
}, z.core.$strip>>;
|
|
594
|
+
}, z.core.$strip>;
|
|
595
|
+
protocolVersion: z.ZodString;
|
|
596
|
+
}, z.core.$strip>;
|
|
597
|
+
}, z.core.$strip>;
|
|
598
|
+
/**
|
|
599
|
+
* @description Initialization result returned from Host to Guest UI.
|
|
600
|
+
* @see {@link McpUiInitializeRequest}
|
|
601
|
+
*/
|
|
602
|
+
export declare const McpUiInitializeResultSchema: z.ZodObject<{
|
|
603
|
+
/** @description Negotiated protocol version string (e.g., "2025-11-21"). */
|
|
604
|
+
protocolVersion: z.ZodString;
|
|
605
|
+
/** @description Host application identification and version. */
|
|
606
|
+
hostInfo: z.ZodObject<{
|
|
607
|
+
version: z.ZodString;
|
|
608
|
+
websiteUrl: z.ZodOptional<z.ZodString>;
|
|
609
|
+
icons: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
610
|
+
src: z.ZodString;
|
|
611
|
+
mimeType: z.ZodOptional<z.ZodString>;
|
|
612
|
+
sizes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
613
|
+
}, z.core.$strip>>>;
|
|
614
|
+
name: z.ZodString;
|
|
615
|
+
title: z.ZodOptional<z.ZodString>;
|
|
616
|
+
}, z.core.$strip>;
|
|
617
|
+
/** @description Features and capabilities provided by the host. */
|
|
618
|
+
hostCapabilities: z.ZodObject<{
|
|
619
|
+
experimental: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
|
|
620
|
+
openLinks: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
|
|
621
|
+
serverTools: z.ZodOptional<z.ZodObject<{
|
|
622
|
+
listChanged: z.ZodOptional<z.ZodBoolean>;
|
|
623
|
+
}, z.core.$strip>>;
|
|
624
|
+
serverResources: z.ZodOptional<z.ZodObject<{
|
|
625
|
+
listChanged: z.ZodOptional<z.ZodBoolean>;
|
|
626
|
+
}, z.core.$strip>>;
|
|
627
|
+
logging: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
|
|
628
|
+
}, z.core.$strip>;
|
|
629
|
+
/** @description Rich context about the host environment. */
|
|
630
|
+
hostContext: z.ZodObject<{
|
|
631
|
+
/** @description Metadata of the tool call that instantiated this App. */
|
|
632
|
+
toolInfo: z.ZodOptional<z.ZodObject<{
|
|
633
|
+
id: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
|
|
634
|
+
tool: z.ZodObject<{
|
|
635
|
+
description: z.ZodOptional<z.ZodString>;
|
|
636
|
+
inputSchema: z.ZodObject<{
|
|
637
|
+
type: z.ZodLiteral<"object">;
|
|
638
|
+
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodCustom<object, object>>>;
|
|
639
|
+
required: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
640
|
+
}, z.core.$catchall<z.ZodUnknown>>;
|
|
641
|
+
outputSchema: z.ZodOptional<z.ZodObject<{
|
|
642
|
+
type: z.ZodLiteral<"object">;
|
|
643
|
+
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodCustom<object, object>>>;
|
|
644
|
+
required: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
645
|
+
}, z.core.$catchall<z.ZodUnknown>>>;
|
|
646
|
+
annotations: z.ZodOptional<z.ZodObject<{
|
|
647
|
+
title: z.ZodOptional<z.ZodString>;
|
|
648
|
+
readOnlyHint: z.ZodOptional<z.ZodBoolean>;
|
|
649
|
+
destructiveHint: z.ZodOptional<z.ZodBoolean>;
|
|
650
|
+
idempotentHint: z.ZodOptional<z.ZodBoolean>;
|
|
651
|
+
openWorldHint: z.ZodOptional<z.ZodBoolean>;
|
|
652
|
+
}, z.core.$strip>>;
|
|
653
|
+
execution: z.ZodOptional<z.ZodObject<{
|
|
654
|
+
taskSupport: z.ZodOptional<z.ZodEnum<{
|
|
655
|
+
optional: "optional";
|
|
656
|
+
required: "required";
|
|
657
|
+
forbidden: "forbidden";
|
|
658
|
+
}>>;
|
|
659
|
+
}, z.core.$strip>>;
|
|
660
|
+
_meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
661
|
+
icons: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
662
|
+
src: z.ZodString;
|
|
663
|
+
mimeType: z.ZodOptional<z.ZodString>;
|
|
664
|
+
sizes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
665
|
+
}, z.core.$strip>>>;
|
|
666
|
+
name: z.ZodString;
|
|
667
|
+
title: z.ZodOptional<z.ZodString>;
|
|
668
|
+
}, z.core.$strip>;
|
|
669
|
+
}, z.core.$strip>>;
|
|
670
|
+
/** @description Current color theme preference. */
|
|
671
|
+
theme: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"light">, z.ZodLiteral<"dark">]>>;
|
|
672
|
+
/** @description Style configuration for theming the app. */
|
|
673
|
+
styles: z.ZodOptional<z.ZodObject<{
|
|
674
|
+
variables: z.ZodOptional<z.ZodRecord<z.ZodUnion<readonly [z.ZodLiteral<"--color-background-primary">, z.ZodLiteral<"--color-background-secondary">, z.ZodLiteral<"--color-background-tertiary">, z.ZodLiteral<"--color-background-inverse">, z.ZodLiteral<"--color-background-ghost">, z.ZodLiteral<"--color-background-info">, z.ZodLiteral<"--color-background-danger">, z.ZodLiteral<"--color-background-success">, z.ZodLiteral<"--color-background-warning">, z.ZodLiteral<"--color-background-disabled">, z.ZodLiteral<"--color-text-primary">, z.ZodLiteral<"--color-text-secondary">, z.ZodLiteral<"--color-text-tertiary">, z.ZodLiteral<"--color-text-inverse">, z.ZodLiteral<"--color-text-info">, z.ZodLiteral<"--color-text-danger">, z.ZodLiteral<"--color-text-success">, z.ZodLiteral<"--color-text-warning">, z.ZodLiteral<"--color-text-disabled">, z.ZodLiteral<"--color-border-primary">, z.ZodLiteral<"--color-border-secondary">, z.ZodLiteral<"--color-border-tertiary">, z.ZodLiteral<"--color-border-inverse">, z.ZodLiteral<"--color-border-ghost">, z.ZodLiteral<"--color-border-info">, z.ZodLiteral<"--color-border-danger">, z.ZodLiteral<"--color-border-success">, z.ZodLiteral<"--color-border-warning">, z.ZodLiteral<"--color-border-disabled">, z.ZodLiteral<"--color-ring-primary">, z.ZodLiteral<"--color-ring-secondary">, z.ZodLiteral<"--color-ring-inverse">, z.ZodLiteral<"--color-ring-info">, z.ZodLiteral<"--color-ring-danger">, z.ZodLiteral<"--color-ring-success">, z.ZodLiteral<"--color-ring-warning">, z.ZodLiteral<"--font-sans">, z.ZodLiteral<"--font-mono">, z.ZodLiteral<"--font-weight-normal">, z.ZodLiteral<"--font-weight-medium">, z.ZodLiteral<"--font-weight-semibold">, z.ZodLiteral<"--font-weight-bold">, z.ZodLiteral<"--font-text-xs-size">, z.ZodLiteral<"--font-text-sm-size">, z.ZodLiteral<"--font-text-md-size">, z.ZodLiteral<"--font-text-lg-size">, z.ZodLiteral<"--font-heading-xs-size">, z.ZodLiteral<"--font-heading-sm-size">, z.ZodLiteral<"--font-heading-md-size">, z.ZodLiteral<"--font-heading-lg-size">, z.ZodLiteral<"--font-heading-xl-size">, z.ZodLiteral<"--font-heading-2xl-size">, z.ZodLiteral<"--font-heading-3xl-size">, z.ZodLiteral<"--font-text-xs-line-height">, z.ZodLiteral<"--font-text-sm-line-height">, z.ZodLiteral<"--font-text-md-line-height">, z.ZodLiteral<"--font-text-lg-line-height">, z.ZodLiteral<"--font-heading-xs-line-height">, z.ZodLiteral<"--font-heading-sm-line-height">, z.ZodLiteral<"--font-heading-md-line-height">, z.ZodLiteral<"--font-heading-lg-line-height">, z.ZodLiteral<"--font-heading-xl-line-height">, z.ZodLiteral<"--font-heading-2xl-line-height">, z.ZodLiteral<"--font-heading-3xl-line-height">, z.ZodLiteral<"--border-radius-xs">, z.ZodLiteral<"--border-radius-sm">, z.ZodLiteral<"--border-radius-md">, z.ZodLiteral<"--border-radius-lg">, z.ZodLiteral<"--border-radius-xl">, z.ZodLiteral<"--border-radius-full">, z.ZodLiteral<"--border-width-regular">, z.ZodLiteral<"--shadow-hairline">, z.ZodLiteral<"--shadow-sm">, z.ZodLiteral<"--shadow-md">, z.ZodLiteral<"--shadow-lg">]>, z.ZodUnion<readonly [z.ZodString, z.ZodUndefined]>>>;
|
|
675
|
+
}, z.core.$strip>>;
|
|
676
|
+
/** @description How the UI is currently displayed. */
|
|
677
|
+
displayMode: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"inline">, z.ZodLiteral<"fullscreen">, z.ZodLiteral<"pip">]>>;
|
|
678
|
+
/** @description Display modes the host supports. */
|
|
679
|
+
availableDisplayModes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
680
|
+
/** @description Current and maximum dimensions available to the UI. */
|
|
681
|
+
viewport: z.ZodOptional<z.ZodObject<{
|
|
682
|
+
width: z.ZodNumber;
|
|
683
|
+
height: z.ZodNumber;
|
|
684
|
+
maxHeight: z.ZodOptional<z.ZodNumber>;
|
|
685
|
+
maxWidth: z.ZodOptional<z.ZodNumber>;
|
|
686
|
+
}, z.core.$strip>>;
|
|
687
|
+
/** @description User's language and region preference in BCP 47 format. */
|
|
688
|
+
locale: z.ZodOptional<z.ZodString>;
|
|
689
|
+
/** @description User's timezone in IANA format. */
|
|
690
|
+
timeZone: z.ZodOptional<z.ZodString>;
|
|
691
|
+
/** @description Host application identifier. */
|
|
692
|
+
userAgent: z.ZodOptional<z.ZodString>;
|
|
693
|
+
/** @description Platform type for responsive design decisions. */
|
|
694
|
+
platform: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"web">, z.ZodLiteral<"desktop">, z.ZodLiteral<"mobile">]>>;
|
|
695
|
+
/** @description Device input capabilities. */
|
|
696
|
+
deviceCapabilities: z.ZodOptional<z.ZodObject<{
|
|
697
|
+
touch: z.ZodOptional<z.ZodBoolean>;
|
|
698
|
+
hover: z.ZodOptional<z.ZodBoolean>;
|
|
699
|
+
}, z.core.$strip>>;
|
|
700
|
+
/** @description Mobile safe area boundaries in pixels. */
|
|
701
|
+
safeAreaInsets: z.ZodOptional<z.ZodObject<{
|
|
702
|
+
top: z.ZodNumber;
|
|
703
|
+
right: z.ZodNumber;
|
|
704
|
+
bottom: z.ZodNumber;
|
|
705
|
+
left: z.ZodNumber;
|
|
706
|
+
}, z.core.$strip>>;
|
|
707
|
+
}, z.core.$loose>;
|
|
708
|
+
}, z.core.$loose>;
|