@vellumai/plugin-api 0.10.12-staging.1 → 0.10.12-staging.2

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.
Files changed (2) hide show
  1. package/index.d.ts +91 -666
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -152,84 +152,14 @@ export declare type AgentLoopExitReason =
152
152
  /** An unhandled error ended the turn. */
153
153
  | "error";
154
154
 
155
- /** Any surface `data` payload, including the opaque (non-renderable) types. */
156
- declare type AnySurfaceData = SurfaceDataByType[SurfaceType];
155
+ declare type AppFilesChangedEvent = z.infer<typeof AppFilesChangedEventSchema>;
157
156
 
158
- declare interface AppDataResponse {
159
- type: "app_data_response";
160
- surfaceId: string;
161
- callId: string;
162
- success: boolean;
163
- result?: unknown;
164
- error?: string;
165
- }
166
-
167
- declare interface AppDeleteResponse {
168
- type: "app_delete_response";
169
- success: boolean;
170
- }
171
-
172
- declare interface AppDiffResponse {
173
- type: "app_diff_response";
174
- appId: string;
175
- diff: string;
176
- }
177
-
178
- declare interface AppFileAtVersionResponse {
179
- type: "app_file_at_version_response";
180
- appId: string;
181
- path: string;
182
- content: string;
183
- }
184
-
185
- declare interface AppFilesChanged {
186
- type: "app_files_changed";
187
- appId: string;
188
- }
189
-
190
- declare interface AppHistoryResponse {
191
- type: "app_history_response";
192
- appId: string;
193
- versions: Array<{
194
- commitHash: string;
195
- message: string;
196
- timestamp: number;
197
- }>;
198
- }
199
-
200
- declare interface AppPreviewResponse {
201
- type: "app_preview_response";
202
- appId: string;
203
- preview?: string;
204
- }
205
-
206
- declare interface AppRestoreResponse {
207
- type: "app_restore_response";
208
- success: boolean;
209
- error?: string;
210
- }
211
-
212
- declare interface AppsListResponse {
213
- type: "apps_list_response";
214
- apps: Array<{
215
- id: string;
216
- name: string;
217
- description?: string;
218
- icon?: string;
219
- preview?: string;
220
- createdAt: number;
221
- version?: string;
222
- contentId?: string;
223
- }>;
224
- }
225
-
226
- declare type _AppsServerMessages = AppDataResponse | AppsListResponse | SharedAppsListResponse | AppDeleteResponse | SharedAppDeleteResponse | ForkSharedAppResponse | BundleAppResponse | OpenBundleResponse | SignBundlePayloadRequest | GetSigningIdentityRequest | ShareAppCloudResponse | AppHistoryResponse | AppDiffResponse | AppFileAtVersionResponse | AppRestoreResponse | AppUpdatePreviewResponse | AppPreviewResponse | PublishPageResponse | UnpublishPageResponse | AppFilesChanged;
157
+ declare const AppFilesChangedEventSchema: z.ZodObject<{
158
+ type: z.ZodLiteral<"app_files_changed">;
159
+ appId: z.ZodString;
160
+ }, z.core.$strip>;
227
161
 
228
- declare interface AppUpdatePreviewResponse {
229
- type: "app_update_preview_response";
230
- success: boolean;
231
- appId: string;
232
- }
162
+ declare type _AppsServerMessages = AppFilesChangedEvent;
233
163
 
234
164
  /**
235
165
  * How {@link listConversations} (and friends) treats archived rows.
@@ -1688,39 +1618,6 @@ declare type _BookmarksServerMessages = BookmarkCreatedEvent | BookmarkDeletedEv
1688
1618
  */
1689
1619
  export declare function buildMessageExcerpt(rawContent: string, query: string): Promise<string>;
1690
1620
 
1691
- declare interface BundleAppResponse {
1692
- type: "bundle_app_response";
1693
- bundlePath: string;
1694
- /** Base64-encoded PNG of the generated app icon, if available. */
1695
- iconImageBase64?: string;
1696
- manifest: {
1697
- format_version: number;
1698
- name: string;
1699
- description?: string;
1700
- icon?: string;
1701
- created_at: string;
1702
- created_by: string;
1703
- entry: string;
1704
- capabilities: string[];
1705
- version?: string;
1706
- content_id?: string;
1707
- };
1708
- }
1709
-
1710
- declare type CardSurfaceData = z.infer<typeof CardSurfaceDataSchema>;
1711
-
1712
- declare const CardSurfaceDataSchema: z.ZodObject<{
1713
- title: z.ZodOptional<z.ZodString>;
1714
- subtitle: z.ZodOptional<z.ZodString>;
1715
- body: z.ZodOptional<z.ZodString>;
1716
- metadata: z.ZodOptional<z.ZodArray<z.ZodObject<{
1717
- label: z.ZodCoercedString<unknown>;
1718
- value: z.ZodCoercedString<unknown>;
1719
- }, z.core.$strip>>>;
1720
- template: z.ZodOptional<z.ZodString>;
1721
- templateData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1722
- }, z.core.$strip>;
1723
-
1724
1621
  /**
1725
1622
  * Canonical channel-id vocabulary shared between the assistant daemon and the
1726
1623
  * gateway.
@@ -1809,28 +1706,6 @@ declare interface ChannelVerificationSessionResponse {
1809
1706
  pendingBootstrap?: boolean;
1810
1707
  }
1811
1708
 
1812
- declare type ChoiceSurfaceData = z.infer<typeof ChoiceSurfaceDataSchema>;
1813
-
1814
- declare const ChoiceSurfaceDataSchema: z.ZodObject<{
1815
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
1816
- options: z.ZodPipe<z.ZodTransform<{
1817
- id: string;
1818
- title: string;
1819
- }[], unknown>, z.ZodArray<z.ZodObject<{
1820
- id: z.ZodString;
1821
- title: z.ZodString;
1822
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
1823
- recommended: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
1824
- data: z.ZodCatch<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
1825
- }, z.core.$strip>>>;
1826
- selectionMode: z.ZodPipe<z.ZodTransform<"single" | "multiple", unknown>, z.ZodEnum<{
1827
- single: "single";
1828
- multiple: "multiple";
1829
- }>>;
1830
- commitOnSelect: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
1831
- submitLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
1832
- }, z.core.$strip>;
1833
-
1834
1709
  export declare const CLI_COMMAND_HELP: readonly CliCommandHelp[];
1835
1710
 
1836
1711
  declare interface CliArgumentHelp {
@@ -2029,17 +1904,6 @@ declare const ConfirmationStateChangedEventSchema: z.ZodObject<{
2029
1904
  toolUseId: z.ZodOptional<z.ZodString>;
2030
1905
  }, z.core.$strip>;
2031
1906
 
2032
- declare type ConfirmationSurfaceData = z.infer<typeof ConfirmationSurfaceDataSchema>;
2033
-
2034
- declare const ConfirmationSurfaceDataSchema: z.ZodObject<{
2035
- message: z.ZodCatch<z.ZodString>;
2036
- detail: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2037
- confirmLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2038
- confirmedLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2039
- cancelLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2040
- destructive: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
2041
- }, z.core.$strip>;
2042
-
2043
1907
  declare type ContactRequestEvent = z.infer<typeof ContactRequestEventSchema>;
2044
1908
 
2045
1909
  declare const ContactRequestEventSchema: z.ZodObject<{
@@ -2306,14 +2170,6 @@ declare type ConversationType = "standard" | "background" | "scheduled";
2306
2170
  /** Read-side alias of {@link ConversationCreateType}. */
2307
2171
  declare type ConversationType_2 = ConversationCreateType;
2308
2172
 
2309
- declare type CopyBlockSurfaceData = z.infer<typeof CopyBlockSurfaceDataSchema>;
2310
-
2311
- declare const CopyBlockSurfaceDataSchema: z.ZodObject<{
2312
- text: z.ZodCatch<z.ZodString>;
2313
- label: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2314
- language: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2315
- }, z.core.$strip>;
2316
-
2317
2173
  /** Create a live voice connection bound to the caller's `send` transport. */
2318
2174
  export declare function createLiveVoiceConnection(options: {
2319
2175
  send: LiveVoiceFrameSender;
@@ -2468,16 +2324,6 @@ declare const DocumentEditorUpdateEventSchema: z.ZodObject<{
2468
2324
  mode: z.ZodString;
2469
2325
  }, z.core.$strip>;
2470
2326
 
2471
- declare type DocumentPreviewSurfaceData = z.infer<typeof DocumentPreviewSurfaceDataSchema>;
2472
-
2473
- declare const DocumentPreviewSurfaceDataSchema: z.ZodObject<{
2474
- title: z.ZodCatch<z.ZodString>;
2475
- surfaceId: z.ZodCatch<z.ZodString>;
2476
- subtitle: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2477
- content: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2478
- mimeType: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2479
- }, z.core.$strip>;
2480
-
2481
2327
  declare type _DocumentsServerMessages = DocumentEditorShowEvent | DocumentEditorUpdateEvent;
2482
2328
 
2483
2329
  /**
@@ -2489,33 +2335,6 @@ declare type _DocumentsServerMessages = DocumentEditorShowEvent | DocumentEditor
2489
2335
  */
2490
2336
  export declare function doesSupportVision(modelOrProfile: ModelProfileInfo | string): boolean;
2491
2337
 
2492
- declare type DynamicPageSurfaceData = z.infer<typeof DynamicPageSurfaceDataSchema>;
2493
-
2494
- declare const DynamicPageSurfaceDataSchema: z.ZodObject<{
2495
- html: z.ZodCatch<z.ZodString>;
2496
- width: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
2497
- height: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
2498
- appId: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2499
- dirName: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2500
- reloadGeneration: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
2501
- status: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2502
- preview: z.ZodCatch<z.ZodOptional<z.ZodObject<{
2503
- title: z.ZodCatch<z.ZodString>;
2504
- subtitle: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2505
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2506
- icon: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2507
- metrics: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
2508
- label: z.ZodCoercedString<unknown>;
2509
- value: z.ZodCoercedString<unknown>;
2510
- }, z.core.$strip>>>>;
2511
- context: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
2512
- app_create: "app_create";
2513
- general: "general";
2514
- }>>>;
2515
- previewImage: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2516
- }, z.core.$strip>>>;
2517
- }, z.core.$strip>;
2518
-
2519
2338
  /** Embed a target and upsert its vector into the vector store. */
2520
2339
  export declare function embedAndUpsert(targetType: EmbeddingTargetType, targetId: string, input: EmbeddingInput, extraPayload?: Record<string, unknown>): Promise<void>;
2521
2340
 
@@ -2567,82 +2386,6 @@ export declare interface FileContent {
2567
2386
  _attachmentId?: string;
2568
2387
  }
2569
2388
 
2570
- declare type FileUploadSurfaceData = z.infer<typeof FileUploadSurfaceDataSchema>;
2571
-
2572
- declare const FileUploadSurfaceDataSchema: z.ZodObject<{
2573
- prompt: z.ZodOptional<z.ZodCoercedString<unknown>>;
2574
- acceptedTypes: z.ZodPipe<z.ZodTransform<string[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
2575
- maxFiles: z.ZodCatch<z.ZodOptional<z.ZodCoercedNumber<unknown>>>;
2576
- maxSizeBytes: z.ZodCatch<z.ZodOptional<z.ZodCoercedNumber<unknown>>>;
2577
- }, z.core.$strip>;
2578
-
2579
- declare interface ForkSharedAppResponse {
2580
- type: "fork_shared_app_response";
2581
- success: boolean;
2582
- appId?: string;
2583
- name?: string;
2584
- error?: string;
2585
- }
2586
-
2587
- declare type FormSurfaceData = z.infer<typeof FormSurfaceDataSchema>;
2588
-
2589
- declare const FormSurfaceDataSchema: z.ZodObject<{
2590
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2591
- fields: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
2592
- id: z.ZodCatch<z.ZodString>;
2593
- type: z.ZodCatch<z.ZodEnum<{
2594
- number: "number";
2595
- text: "text";
2596
- textarea: "textarea";
2597
- select: "select";
2598
- toggle: "toggle";
2599
- password: "password";
2600
- }>>;
2601
- label: z.ZodCatch<z.ZodString>;
2602
- placeholder: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2603
- required: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
2604
- defaultValue: z.ZodCatch<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
2605
- options: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
2606
- label: z.ZodCoercedString<unknown>;
2607
- value: z.ZodCoercedString<unknown>;
2608
- }, z.core.$strip>>>>;
2609
- }, z.core.$strip>>>;
2610
- submitLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2611
- pages: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
2612
- id: z.ZodCatch<z.ZodString>;
2613
- title: z.ZodCatch<z.ZodString>;
2614
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2615
- fields: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
2616
- id: z.ZodCatch<z.ZodString>;
2617
- type: z.ZodCatch<z.ZodEnum<{
2618
- number: "number";
2619
- text: "text";
2620
- textarea: "textarea";
2621
- select: "select";
2622
- toggle: "toggle";
2623
- password: "password";
2624
- }>>;
2625
- label: z.ZodCatch<z.ZodString>;
2626
- placeholder: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2627
- required: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
2628
- defaultValue: z.ZodCatch<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
2629
- options: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
2630
- label: z.ZodCoercedString<unknown>;
2631
- value: z.ZodCoercedString<unknown>;
2632
- }, z.core.$strip>>>>;
2633
- }, z.core.$strip>>>;
2634
- }, z.core.$strip>>>>>;
2635
- pageLabels: z.ZodCatch<z.ZodOptional<z.ZodObject<{
2636
- next: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2637
- back: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2638
- submit: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2639
- }, z.core.$strip>>>;
2640
- progressStyle: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
2641
- bar: "bar";
2642
- tabs: "tabs";
2643
- }>>>;
2644
- }, z.core.$strip>;
2645
-
2646
2389
  declare type GenerationCancelledEvent = z.infer<typeof GenerationCancelledEventSchema>;
2647
2390
 
2648
2391
  declare const GenerationCancelledEventSchema: z.ZodObject<{
@@ -2716,11 +2459,6 @@ export declare function getMessages(conversationId: string): Promise<MessageRow[
2716
2459
  */
2717
2460
  export declare function getModelProfiles(): ModelProfileInfo[];
2718
2461
 
2719
- declare interface GetSigningIdentityRequest {
2720
- type: "get_signing_identity";
2721
- requestId: string;
2722
- }
2723
-
2724
2462
  /**
2725
2463
  * Returns the workspace root for user-facing state.
2726
2464
  *
@@ -3261,22 +2999,6 @@ declare interface ImageEmbeddingInput {
3261
2999
  mimeType: string;
3262
3000
  }
3263
3001
 
3264
- declare interface IngressConfigResponse {
3265
- type: "ingress_config_response";
3266
- enabled: boolean;
3267
- publicBaseUrl: string;
3268
- /** Read-only gateway target computed from GATEWAY_PORT env var (default 7830) + loopback host. */
3269
- localGatewayTarget: string;
3270
- /**
3271
- * When true, this assistant uses platform-managed callback routing.
3272
- * Webhook delivery is handled by the platform — no local tunnel or
3273
- * ngrok setup is needed. `publicBaseUrl` reflects the platform callback URL.
3274
- */
3275
- managedCallbacks?: boolean;
3276
- success: boolean;
3277
- error?: string;
3278
- }
3279
-
3280
3002
  /**
3281
3003
  * Context passed to `Plugin.init()` during bootstrap. Carries the resolved
3282
3004
  * config, a pino-compatible logger scoped to the plugin, a per-plugin
@@ -3320,29 +3042,7 @@ declare interface InsertedMessage {
3320
3042
  deduplicated: boolean;
3321
3043
  }
3322
3044
 
3323
- declare interface IntegrationConnectResult {
3324
- type: "integration_connect_result";
3325
- integrationId: string;
3326
- success: boolean;
3327
- accountInfo?: string | null;
3328
- error?: string | null;
3329
- setupRequired?: boolean;
3330
- setupHint?: string;
3331
- }
3332
-
3333
- declare interface IntegrationListResponse {
3334
- type: "integration_list_response";
3335
- integrations: Array<{
3336
- id: string;
3337
- connected: boolean;
3338
- accountInfo?: string | null;
3339
- connectedAt?: number | null;
3340
- lastUsed?: number | null;
3341
- error?: string | null;
3342
- }>;
3343
- }
3344
-
3345
- declare type _IntegrationsServerMessages = SlackWebhookConfigResponse | IngressConfigResponse | PlatformConfigResponse | VercelApiConfigResponse | TelegramConfigResponse | ChannelVerificationSessionResponse | IntegrationListResponse | IntegrationConnectResult | OAuthConnectResultResponse | OpenUrlEvent | OpenPanelEvent | NavigateSettingsEvent | ShowPlatformLogin | PlatformDisconnected;
3045
+ declare type _IntegrationsServerMessages = ChannelVerificationSessionResponse | OAuthConnectResultEvent | OpenUrlEvent | OpenPanelEvent | NavigateSettingsEvent | ShowPlatformLoginEvent | PlatformDisconnectedEvent;
3346
3046
 
3347
3047
  declare type InteractionResolvedEvent = z.infer<typeof InteractionResolvedEventSchema>;
3348
3048
 
@@ -3450,23 +3150,6 @@ export declare function listConversations(limit?: number, conversationType?: Con
3450
3150
  */
3451
3151
  export declare function listInstalledSkills(): Promise<ResolvedSkillEntry[]>;
3452
3152
 
3453
- declare type ListSurfaceData = z.infer<typeof ListSurfaceDataSchema>;
3454
-
3455
- declare const ListSurfaceDataSchema: z.ZodObject<{
3456
- items: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
3457
- id: z.ZodCatch<z.ZodString>;
3458
- title: z.ZodCatch<z.ZodString>;
3459
- subtitle: z.ZodCatch<z.ZodOptional<z.ZodString>>;
3460
- icon: z.ZodCatch<z.ZodOptional<z.ZodString>>;
3461
- selected: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
3462
- }, z.core.$strip>>>;
3463
- selectionMode: z.ZodCatch<z.ZodEnum<{
3464
- none: "none";
3465
- single: "single";
3466
- multiple: "multiple";
3467
- }>>;
3468
- }, z.core.$strip>;
3469
-
3470
3153
  declare const _LIVE_VOICE_SERVER_FRAME_TYPES: readonly ["ready", "busy", "speech_started", "utterance_end", "utterance_discarded", "stt_partial", "stt_final", "thinking", "assistant_text_delta", "tts_audio", "tts_done", "turn_cancelled", "metrics", "archived", "error"];
3471
3154
 
3472
3155
  declare const LIVE_VOICE_TURN_DETECTION_MODES: readonly ["manual", "server_vad"];
@@ -4081,50 +3764,17 @@ declare const NotificationIntentEventSchema: z.ZodObject<{
4081
3764
 
4082
3765
  declare type _NotificationsServerMessages = NotificationIntentEvent | NotificationConversationCreatedEvent;
4083
3766
 
4084
- declare interface OAuthConnectResultResponse {
4085
- type: "oauth_connect_result";
4086
- success: boolean;
4087
- service?: string;
4088
- grantedScopes?: string[];
4089
- accountInfo?: string;
4090
- error?: string;
4091
- }
4092
-
4093
- declare type OAuthConnectSurfaceData = z.infer<typeof OAuthConnectSurfaceDataSchema>;
3767
+ declare type OAuthConnectResultEvent = z.infer<typeof OAuthConnectResultEventSchema>;
4094
3768
 
4095
- declare const OAuthConnectSurfaceDataSchema: z.ZodObject<{
4096
- providerKey: z.ZodCatch<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>>;
4097
- displayName: z.ZodCatch<z.ZodOptional<z.ZodString>>;
4098
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
4099
- logoUrl: z.ZodCatch<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
3769
+ declare const OAuthConnectResultEventSchema: z.ZodObject<{
3770
+ type: z.ZodLiteral<"oauth_connect_result">;
3771
+ success: z.ZodBoolean;
3772
+ service: z.ZodOptional<z.ZodString>;
3773
+ grantedScopes: z.ZodOptional<z.ZodArray<z.ZodString>>;
3774
+ accountInfo: z.ZodOptional<z.ZodString>;
3775
+ error: z.ZodOptional<z.ZodString>;
4100
3776
  }, z.core.$strip>;
4101
3777
 
4102
- declare interface OpenBundleResponse {
4103
- type: "open_bundle_response";
4104
- manifest: {
4105
- format_version: number;
4106
- name: string;
4107
- description?: string;
4108
- icon?: string;
4109
- created_at: string;
4110
- created_by: string;
4111
- entry: string;
4112
- capabilities: string[];
4113
- };
4114
- scanResult: {
4115
- passed: boolean;
4116
- blocked: string[];
4117
- warnings: string[];
4118
- };
4119
- signatureResult: {
4120
- trustTier: "verified" | "signed" | "unsigned" | "tampered";
4121
- signerKeyId?: string;
4122
- signerDisplayName?: string;
4123
- signerAccount?: string;
4124
- };
4125
- bundleSizeBytes: number;
4126
- }
4127
-
4128
3778
  declare type OpenConversationEvent = z.infer<typeof OpenConversationEventSchema>;
4129
3779
 
4130
3780
  declare const OpenConversationEventSchema: z.ZodObject<{
@@ -4188,16 +3838,11 @@ export declare function parseMessageMetadata(metadataJson: string | null): Promi
4188
3838
  */
4189
3839
  declare function parseMessageMetadata_2(metadataJson: string | null): MessageMetadata_2 | undefined;
4190
3840
 
4191
- declare interface PlatformConfigResponse {
4192
- type: "platform_config_response";
4193
- baseUrl: string;
4194
- success: boolean;
4195
- error?: string;
4196
- }
3841
+ declare type PlatformDisconnectedEvent = z.infer<typeof PlatformDisconnectedEventSchema>;
4197
3842
 
4198
- declare interface PlatformDisconnected {
4199
- type: "platform_disconnected";
4200
- }
3843
+ declare const PlatformDisconnectedEventSchema: z.ZodObject<{
3844
+ type: z.ZodLiteral<"platform_disconnected">;
3845
+ }, z.core.$strip>;
4201
3846
 
4202
3847
  /**
4203
3848
  * The subset of {@link AssistantEventHub} workspace plugins may use. Picking
@@ -4688,15 +4333,6 @@ declare interface ProxyApprovalRequest {
4688
4333
 
4689
4334
  declare type ProxyToolResolver = (toolName: string, input: Record<string, unknown>) => Promise<ToolExecutionResult>;
4690
4335
 
4691
- declare interface PublishPageResponse {
4692
- type: "publish_page_response";
4693
- success: boolean;
4694
- publicUrl?: string;
4695
- deploymentId?: string;
4696
- error?: string;
4697
- errorCode?: string;
4698
- }
4699
-
4700
4336
  /**
4701
4337
  * Remove every previously-refused exchange from a working history: for each
4702
4338
  * assistant message that is exactly the refusal fallback, drop it together with
@@ -5290,41 +4926,11 @@ declare const ServiceGroupUpdateStartingEventSchema: z.ZodObject<{
5290
4926
 
5291
4927
  declare type _SettingsServerMessages = ClientSettingsUpdateEvent | AvatarUpdatedEvent | ConfigChangedEvent | SoundsConfigUpdatedEvent;
5292
4928
 
5293
- declare interface ShareAppCloudResponse {
5294
- type: "share_app_cloud_response";
5295
- success: boolean;
5296
- shareToken?: string;
5297
- shareUrl?: string;
5298
- error?: string;
5299
- }
5300
-
5301
- declare interface SharedAppDeleteResponse {
5302
- type: "shared_app_delete_response";
5303
- success: boolean;
5304
- }
4929
+ declare type ShowPlatformLoginEvent = z.infer<typeof ShowPlatformLoginEventSchema>;
5305
4930
 
5306
- declare interface SharedAppsListResponse {
5307
- type: "shared_apps_list_response";
5308
- apps: Array<{
5309
- uuid: string;
5310
- name: string;
5311
- description?: string;
5312
- icon?: string;
5313
- preview?: string;
5314
- entry: string;
5315
- trustTier: string;
5316
- signerDisplayName?: string;
5317
- bundleSizeBytes: number;
5318
- installedAt: string;
5319
- version?: string;
5320
- contentId?: string;
5321
- updateAvailable?: boolean;
5322
- }>;
5323
- }
5324
-
5325
- declare interface ShowPlatformLogin {
5326
- type: "show_platform_login";
5327
- }
4931
+ declare const ShowPlatformLoginEventSchema: z.ZodObject<{
4932
+ type: z.ZodLiteral<"show_platform_login">;
4933
+ }, z.core.$strip>;
5328
4934
 
5329
4935
  /**
5330
4936
  * Context passed to the `shutdown` hook. Kept intentionally narrower than
@@ -5367,12 +4973,6 @@ export declare interface ShutdownContext {
5367
4973
  */
5368
4974
  declare type ShutdownReason = "shutdown" | "uninstall" | "disable" | "reload";
5369
4975
 
5370
- declare interface SignBundlePayloadRequest {
5371
- type: "sign_bundle_payload";
5372
- requestId: string;
5373
- payload: string;
5374
- }
5375
-
5376
4976
  declare interface SkillInstallMeta {
5377
4977
  origin: "vellum" | "clawhub" | "skillssh" | "custom";
5378
4978
  installedAt: string;
@@ -5417,13 +5017,6 @@ declare const SkillStateChangedEventSchema: z.ZodObject<{
5417
5017
  }>;
5418
5018
  }, z.core.$strip>;
5419
5019
 
5420
- declare interface SlackWebhookConfigResponse {
5421
- type: "slack_webhook_config_response";
5422
- webhookUrl?: string;
5423
- success: boolean;
5424
- error?: string;
5425
- }
5426
-
5427
5020
  declare type SoundsConfigUpdatedEvent = z.infer<typeof SoundsConfigUpdatedEventSchema>;
5428
5021
 
5429
5022
  declare const SoundsConfigUpdatedEventSchema: z.ZodObject<{
@@ -5727,70 +5320,7 @@ declare type SubscriberInput = DistributiveOmit<SubscriberEntry, "active" | "con
5727
5320
  onEvict?: () => void;
5728
5321
  };
5729
5322
 
5730
- declare interface SurfaceAction {
5731
- id: string;
5732
- label: string;
5733
- style?: "primary" | "secondary" | "destructive";
5734
- /** Optional data payload returned to the daemon when this action is clicked. */
5735
- data?: Record<string, unknown>;
5736
- }
5737
-
5738
- /**
5739
- * Per-type `data` payload shapes, keyed by surface type. This is the
5740
- * correlation source for everything that pairs a `surfaceType` with its
5741
- * `data`: generic code indexes it (`SurfaceDataByType[K]`) so the compiler
5742
- * tracks which data shape belongs to which type instead of collapsing to
5743
- * the undiscriminated `SurfaceData` union.
5744
- *
5745
- * Several types are opaque records — they carry data the daemon persists
5746
- * and serves verbatim but whose shape it does not model, which is why they
5747
- * are absent from the renderable `SurfaceData` union: `channel_setup` (a
5748
- * side-effect command forwarded to the setup panel), `task_preferences` (a
5749
- * fixed grid that reads no data), and `skill_card` / `call_summary` (cards
5750
- * the daemon appends to history directly — the memory retrospective and a
5751
- * call summary — and whose data shape is owned by their client renderers).
5752
- */
5753
- declare interface SurfaceDataByType {
5754
- card: CardSurfaceData;
5755
- channel_setup: Record<string, unknown>;
5756
- choice: ChoiceSurfaceData;
5757
- copy_block: CopyBlockSurfaceData;
5758
- oauth_connect: OAuthConnectSurfaceData;
5759
- form: FormSurfaceData;
5760
- list: ListSurfaceData;
5761
- table: TableSurfaceData;
5762
- confirmation: ConfirmationSurfaceData;
5763
- dynamic_page: DynamicPageSurfaceData;
5764
- file_upload: FileUploadSurfaceData;
5765
- document_preview: DocumentPreviewSurfaceData;
5766
- task_preferences: Record<string, unknown>;
5767
- work_result: WorkResultSurfaceData;
5768
- skill_card: Record<string, unknown>;
5769
- call_summary: Record<string, unknown>;
5770
- }
5771
-
5772
- declare type _SurfacesServerMessages = UiSurfaceShow | UiSurfaceUpdate | UiSurfaceDismiss | UiSurfaceComplete | UiSurfaceUndoResult;
5773
-
5774
- declare type SurfaceType = z.infer<typeof SurfaceTypeSchema>;
5775
-
5776
- declare const SurfaceTypeSchema: z.ZodEnum<{
5777
- table: "table";
5778
- card: "card";
5779
- channel_setup: "channel_setup";
5780
- choice: "choice";
5781
- copy_block: "copy_block";
5782
- oauth_connect: "oauth_connect";
5783
- form: "form";
5784
- list: "list";
5785
- confirmation: "confirmation";
5786
- dynamic_page: "dynamic_page";
5787
- file_upload: "file_upload";
5788
- document_preview: "document_preview";
5789
- task_preferences: "task_preferences";
5790
- work_result: "work_result";
5791
- skill_card: "skill_card";
5792
- call_summary: "call_summary";
5793
- }>;
5323
+ declare type _SurfacesServerMessages = UISurfaceShowEvent | UISurfaceUpdateEvent | UISurfaceDismissEvent | UISurfaceCompleteEvent | UISurfaceUndoResultEvent;
5794
5324
 
5795
5325
  /**
5796
5326
  * Delete `graph_node` Qdrant points whose backing `memory_graph_nodes` row no
@@ -5856,48 +5386,6 @@ export declare interface SynthesizeTextOptions {
5856
5386
  signal?: AbortSignal;
5857
5387
  }
5858
5388
 
5859
- declare type TableSurfaceData = z.infer<typeof TableSurfaceDataSchema>;
5860
-
5861
- declare const TableSurfaceDataSchema: z.ZodObject<{
5862
- columns: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
5863
- id: z.ZodCatch<z.ZodString>;
5864
- label: z.ZodCatch<z.ZodString>;
5865
- width: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
5866
- }, z.core.$strip>>>;
5867
- rows: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
5868
- id: z.ZodCatch<z.ZodString>;
5869
- cells: z.ZodCatch<z.ZodRecord<z.ZodString, z.ZodCatch<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
5870
- text: z.ZodCatch<z.ZodCoercedString<unknown>>;
5871
- icon: z.ZodCatch<z.ZodOptional<z.ZodString>>;
5872
- iconColor: z.ZodCatch<z.ZodOptional<z.ZodString>>;
5873
- }, z.core.$strip>]>>>>;
5874
- selectable: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
5875
- selected: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
5876
- }, z.core.$strip>>>;
5877
- selectionMode: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
5878
- none: "none";
5879
- single: "single";
5880
- multiple: "multiple";
5881
- }>>>;
5882
- caption: z.ZodCatch<z.ZodOptional<z.ZodString>>;
5883
- }, z.core.$strip>;
5884
-
5885
- declare interface TelegramConfigResponse {
5886
- type: "telegram_config_response";
5887
- success: boolean;
5888
- hasBotToken: boolean;
5889
- botId?: string;
5890
- botUsername?: string;
5891
- connected: boolean;
5892
- hasWebhookSecret: boolean;
5893
- lastError?: string;
5894
- error?: string;
5895
- /** Names of bot commands that were registered (present after set_commands or setup). */
5896
- commandsRegistered?: string[];
5897
- /** Non-fatal warning (e.g. commands registration failed during setup but token was configured). */
5898
- warning?: string;
5899
- }
5900
-
5901
5389
  export declare interface TextContent {
5902
5390
  type: "text";
5903
5391
  text: string;
@@ -5955,6 +5443,15 @@ export declare interface ToolContext {
5955
5443
  assistantId?: string;
5956
5444
  /** True when an interactive client is connected (not just a no-op callback). */
5957
5445
  isInteractive?: boolean;
5446
+ /**
5447
+ * Whether the current turn's channel can render dynamic UI surfaces
5448
+ * (interactive cards, tappable option pickers, secure prompts). `false` on
5449
+ * text-only channels (e.g. Telegram, SMS). UI-dependent tools read this to
5450
+ * degrade to a text-formatted equivalent instead of emitting a surface the
5451
+ * channel silently drops. `undefined` means unknown and is treated as
5452
+ * supported (desktop/web/app clients).
5453
+ */
5454
+ supportsDynamicUi?: boolean;
5958
5455
  /**
5959
5456
  * When set, the tool execution is part of a task run. Used to retrieve ephemeral permission rules.
5960
5457
  * @legacy
@@ -6582,71 +6079,70 @@ declare type TtsUseCase =
6582
6079
  /** In-app message playback — buffer-oriented, higher quality acceptable. */
6583
6080
  | "message-playback";
6584
6081
 
6585
- declare interface UiSurfaceComplete {
6586
- type: "ui_surface_complete";
6587
- conversationId: string;
6588
- surfaceId: string;
6589
- summary: string;
6590
- submittedData?: Record<string, unknown>;
6591
- }
6082
+ declare type UISurfaceCompleteEvent = z.infer<typeof UISurfaceCompleteEventSchema>;
6592
6083
 
6593
- declare interface UiSurfaceDismiss {
6594
- type: "ui_surface_dismiss";
6595
- conversationId: string;
6596
- surfaceId: string;
6597
- }
6084
+ declare const UISurfaceCompleteEventSchema: z.ZodObject<{
6085
+ type: z.ZodLiteral<"ui_surface_complete">;
6086
+ conversationId: z.ZodString;
6087
+ surfaceId: z.ZodString;
6088
+ summary: z.ZodString;
6089
+ submittedData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
6090
+ }, z.core.$strip>;
6598
6091
 
6599
- /**
6600
- * Discriminated union over every surface type, derived from
6601
- * `SurfaceDataByType` so a type added there appears here automatically.
6602
- * Includes the opaque types (`channel_setup`, `task_preferences`) — their
6603
- * show events carry opaque record data.
6604
- */
6605
- declare type UiSurfaceShow = {
6606
- [K in SurfaceType]: UiSurfaceShowFor<K>;
6607
- }[SurfaceType];
6092
+ declare type UISurfaceDismissEvent = z.infer<typeof UISurfaceDismissEventSchema>;
6608
6093
 
6609
- /** Common fields shared by all UiSurfaceShow variants. */
6610
- declare interface UiSurfaceShowBase {
6611
- type: "ui_surface_show";
6612
- conversationId: string;
6613
- surfaceId: string;
6614
- title?: string;
6615
- actions?: SurfaceAction[];
6616
- display?: "inline" | "panel";
6617
- /** The message ID that this surface belongs to (for history loading). */
6618
- messageId?: string;
6619
- /** When `true`, clicking an action does not dismiss the surface — the client keeps the card visible and only marks the clicked `actionId` as spent so siblings remain clickable. */
6620
- persistent?: boolean;
6621
- /** Id of the tool call that produced this surface (the `ui_show` proxy tool). Lets the client gate app previews on the tool result's arrival rather than whole-turn streaming state. */
6622
- toolCallId?: string;
6623
- }
6094
+ declare const UISurfaceDismissEventSchema: z.ZodObject<{
6095
+ type: z.ZodLiteral<"ui_surface_dismiss">;
6096
+ conversationId: z.ZodString;
6097
+ surfaceId: z.ZodString;
6098
+ }, z.core.$strip>;
6624
6099
 
6625
- /**
6626
- * The show event for one specific surface type: base fields plus the
6627
- * correlated `surfaceType`/`data` pair, both indexed from
6628
- * `SurfaceDataByType` so generic code keeps the pairing.
6629
- */
6630
- declare type UiSurfaceShowFor<K extends SurfaceType> = UiSurfaceShowBase & {
6631
- surfaceType: K;
6632
- data: SurfaceDataByType[K];
6633
- };
6100
+ declare type UISurfaceShowEvent = z.infer<typeof UISurfaceShowEventSchema>;
6634
6101
 
6635
- declare interface UiSurfaceUndoResult {
6636
- type: "ui_surface_undo_result";
6637
- conversationId: string;
6638
- surfaceId: string;
6639
- success: boolean;
6640
- /** Number of remaining undo entries after this undo. */
6641
- remainingUndos: number;
6642
- }
6102
+ declare const UISurfaceShowEventSchema: z.ZodObject<{
6103
+ type: z.ZodLiteral<"ui_surface_show">;
6104
+ conversationId: z.ZodString;
6105
+ surfaceId: z.ZodString;
6106
+ surfaceType: z.ZodString;
6107
+ title: z.ZodOptional<z.ZodString>;
6108
+ data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
6109
+ actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
6110
+ id: z.ZodString;
6111
+ label: z.ZodString;
6112
+ style: z.ZodOptional<z.ZodEnum<{
6113
+ primary: "primary";
6114
+ secondary: "secondary";
6115
+ destructive: "destructive";
6116
+ }>>;
6117
+ data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
6118
+ }, z.core.$strip>>>;
6119
+ display: z.ZodOptional<z.ZodEnum<{
6120
+ inline: "inline";
6121
+ panel: "panel";
6122
+ }>>;
6123
+ messageId: z.ZodOptional<z.ZodString>;
6124
+ persistent: z.ZodOptional<z.ZodBoolean>;
6125
+ toolCallId: z.ZodOptional<z.ZodString>;
6126
+ }, z.core.$strip>;
6643
6127
 
6644
- declare interface UiSurfaceUpdate {
6645
- type: "ui_surface_update";
6646
- conversationId: string;
6647
- surfaceId: string;
6648
- data: Partial<AnySurfaceData>;
6649
- }
6128
+ declare type UISurfaceUndoResultEvent = z.infer<typeof UISurfaceUndoResultEventSchema>;
6129
+
6130
+ declare const UISurfaceUndoResultEventSchema: z.ZodObject<{
6131
+ type: z.ZodLiteral<"ui_surface_undo_result">;
6132
+ conversationId: z.ZodString;
6133
+ surfaceId: z.ZodString;
6134
+ success: z.ZodBoolean;
6135
+ remainingUndos: z.ZodNumber;
6136
+ }, z.core.$strip>;
6137
+
6138
+ declare type UISurfaceUpdateEvent = z.infer<typeof UISurfaceUpdateEventSchema>;
6139
+
6140
+ declare const UISurfaceUpdateEventSchema: z.ZodObject<{
6141
+ type: z.ZodLiteral<"ui_surface_update">;
6142
+ conversationId: z.ZodString;
6143
+ surfaceId: z.ZodString;
6144
+ data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
6145
+ }, z.core.$strip>;
6650
6146
 
6651
6147
  declare interface UndoComplete {
6652
6148
  type: "undo_complete";
@@ -6654,12 +6150,6 @@ declare interface UndoComplete {
6654
6150
  conversationId?: string;
6655
6151
  }
6656
6152
 
6657
- declare interface UnpublishPageResponse {
6658
- type: "unpublish_page_response";
6659
- success: boolean;
6660
- error?: string;
6661
- }
6662
-
6663
6153
  /** Merge the given keys into a message's metadata JSON. */
6664
6154
  export declare function updateMessageMetadata(messageId: string, updates: Record<string, unknown>): Promise<void>;
6665
6155
 
@@ -6861,13 +6351,6 @@ declare interface UserPromptSubmitInputContext {
6861
6351
  latestMessages: Message[];
6862
6352
  }
6863
6353
 
6864
- declare interface VercelApiConfigResponse {
6865
- type: "vercel_api_config_response";
6866
- hasToken: boolean;
6867
- success: boolean;
6868
- error?: string;
6869
- }
6870
-
6871
6354
  declare interface VideoEmbeddingInput {
6872
6355
  type: "video";
6873
6356
  data: Buffer;
@@ -6999,64 +6482,6 @@ declare const WorkflowStartedEventSchema: z.ZodObject<{
6999
6482
  label: z.ZodOptional<z.ZodString>;
7000
6483
  }, z.core.$strict>;
7001
6484
 
7002
- declare type WorkResultSurfaceData = z.infer<typeof WorkResultSurfaceDataSchema>;
7003
-
7004
- declare const WorkResultSurfaceDataSchema: z.ZodObject<{
7005
- eyebrow: z.ZodCatch<z.ZodOptional<z.ZodString>>;
7006
- status: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
7007
- completed: "completed";
7008
- failed: "failed";
7009
- partial: "partial";
7010
- in_progress: "in_progress";
7011
- }>>>;
7012
- summary: z.ZodCatch<z.ZodOptional<z.ZodString>>;
7013
- metrics: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
7014
- detail: z.ZodCatch<z.ZodOptional<z.ZodString>>;
7015
- tone: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
7016
- neutral: "neutral";
7017
- positive: "positive";
7018
- warning: "warning";
7019
- negative: "negative";
7020
- }>>>;
7021
- label: z.ZodCatch<z.ZodCoercedString<unknown>>;
7022
- value: z.ZodCatch<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
7023
- }, z.core.$strip>>>>>;
7024
- sections: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
7025
- id: z.ZodCatch<z.ZodOptional<z.ZodString>>;
7026
- title: z.ZodCatch<z.ZodCoercedString<unknown>>;
7027
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
7028
- type: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
7029
- diff: "diff";
7030
- items: "items";
7031
- timeline: "timeline";
7032
- artifacts: "artifacts";
7033
- warnings: "warnings";
7034
- }>>>;
7035
- items: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
7036
- id: z.ZodCatch<z.ZodOptional<z.ZodString>>;
7037
- title: z.ZodCatch<z.ZodCoercedString<unknown>>;
7038
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
7039
- status: z.ZodCatch<z.ZodOptional<z.ZodString>>;
7040
- tone: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
7041
- neutral: "neutral";
7042
- positive: "positive";
7043
- warning: "warning";
7044
- negative: "negative";
7045
- }>>>;
7046
- metadata: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
7047
- label: z.ZodCatch<z.ZodCoercedString<unknown>>;
7048
- value: z.ZodCatch<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
7049
- }, z.core.$strip>>>>>;
7050
- href: z.ZodCatch<z.ZodOptional<z.ZodString>>;
7051
- }, z.core.$strip>>>>>;
7052
- diffs: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
7053
- label: z.ZodCatch<z.ZodOptional<z.ZodString>>;
7054
- before: z.ZodCatch<z.ZodOptional<z.ZodString>>;
7055
- after: z.ZodCatch<z.ZodOptional<z.ZodString>>;
7056
- }, z.core.$strip>>>>>;
7057
- }, z.core.$strip>>>>>;
7058
- }, z.core.$strip>;
7059
-
7060
6485
  declare interface WorkspaceFileReadResponse {
7061
6486
  type: "workspace_file_read_response";
7062
6487
  path: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vellumai/plugin-api",
3
- "version": "0.10.12-staging.1",
3
+ "version": "0.10.12-staging.2",
4
4
  "description": "Public TypeScript authoring contract for Vellum assistant plugins.",
5
5
  "license": "MIT",
6
6
  "type": "module",