@vellumai/plugin-api 0.10.11-dev.202607241238.b7ebd7f → 0.10.11-dev.202607241335.d95a4c6

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 +59 -396
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -152,9 +152,6 @@ 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];
157
-
158
155
  declare type AppFilesChangedEvent = z.infer<typeof AppFilesChangedEventSchema>;
159
156
 
160
157
  declare const AppFilesChangedEventSchema: z.ZodObject<{
@@ -1621,20 +1618,6 @@ declare type _BookmarksServerMessages = BookmarkCreatedEvent | BookmarkDeletedEv
1621
1618
  */
1622
1619
  export declare function buildMessageExcerpt(rawContent: string, query: string): Promise<string>;
1623
1620
 
1624
- declare type CardSurfaceData = z.infer<typeof CardSurfaceDataSchema>;
1625
-
1626
- declare const CardSurfaceDataSchema: z.ZodObject<{
1627
- title: z.ZodOptional<z.ZodString>;
1628
- subtitle: z.ZodOptional<z.ZodString>;
1629
- body: z.ZodOptional<z.ZodString>;
1630
- metadata: z.ZodOptional<z.ZodArray<z.ZodObject<{
1631
- label: z.ZodCoercedString<unknown>;
1632
- value: z.ZodCoercedString<unknown>;
1633
- }, z.core.$strip>>>;
1634
- template: z.ZodOptional<z.ZodString>;
1635
- templateData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1636
- }, z.core.$strip>;
1637
-
1638
1621
  /**
1639
1622
  * Canonical channel-id vocabulary shared between the assistant daemon and the
1640
1623
  * gateway.
@@ -1723,28 +1706,6 @@ declare interface ChannelVerificationSessionResponse {
1723
1706
  pendingBootstrap?: boolean;
1724
1707
  }
1725
1708
 
1726
- declare type ChoiceSurfaceData = z.infer<typeof ChoiceSurfaceDataSchema>;
1727
-
1728
- declare const ChoiceSurfaceDataSchema: z.ZodObject<{
1729
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
1730
- options: z.ZodPipe<z.ZodTransform<{
1731
- id: string;
1732
- title: string;
1733
- }[], unknown>, z.ZodArray<z.ZodObject<{
1734
- id: z.ZodString;
1735
- title: z.ZodString;
1736
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
1737
- recommended: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
1738
- data: z.ZodCatch<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
1739
- }, z.core.$strip>>>;
1740
- selectionMode: z.ZodPipe<z.ZodTransform<"single" | "multiple", unknown>, z.ZodEnum<{
1741
- single: "single";
1742
- multiple: "multiple";
1743
- }>>;
1744
- commitOnSelect: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
1745
- submitLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
1746
- }, z.core.$strip>;
1747
-
1748
1709
  export declare const CLI_COMMAND_HELP: readonly CliCommandHelp[];
1749
1710
 
1750
1711
  declare interface CliArgumentHelp {
@@ -1943,17 +1904,6 @@ declare const ConfirmationStateChangedEventSchema: z.ZodObject<{
1943
1904
  toolUseId: z.ZodOptional<z.ZodString>;
1944
1905
  }, z.core.$strip>;
1945
1906
 
1946
- declare type ConfirmationSurfaceData = z.infer<typeof ConfirmationSurfaceDataSchema>;
1947
-
1948
- declare const ConfirmationSurfaceDataSchema: z.ZodObject<{
1949
- message: z.ZodCatch<z.ZodString>;
1950
- detail: z.ZodCatch<z.ZodOptional<z.ZodString>>;
1951
- confirmLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
1952
- confirmedLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
1953
- cancelLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
1954
- destructive: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
1955
- }, z.core.$strip>;
1956
-
1957
1907
  declare type ContactRequestEvent = z.infer<typeof ContactRequestEventSchema>;
1958
1908
 
1959
1909
  declare const ContactRequestEventSchema: z.ZodObject<{
@@ -2220,14 +2170,6 @@ declare type ConversationType = "standard" | "background" | "scheduled";
2220
2170
  /** Read-side alias of {@link ConversationCreateType}. */
2221
2171
  declare type ConversationType_2 = ConversationCreateType;
2222
2172
 
2223
- declare type CopyBlockSurfaceData = z.infer<typeof CopyBlockSurfaceDataSchema>;
2224
-
2225
- declare const CopyBlockSurfaceDataSchema: z.ZodObject<{
2226
- text: z.ZodCatch<z.ZodString>;
2227
- label: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2228
- language: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2229
- }, z.core.$strip>;
2230
-
2231
2173
  /** Create a live voice connection bound to the caller's `send` transport. */
2232
2174
  export declare function createLiveVoiceConnection(options: {
2233
2175
  send: LiveVoiceFrameSender;
@@ -2382,16 +2324,6 @@ declare const DocumentEditorUpdateEventSchema: z.ZodObject<{
2382
2324
  mode: z.ZodString;
2383
2325
  }, z.core.$strip>;
2384
2326
 
2385
- declare type DocumentPreviewSurfaceData = z.infer<typeof DocumentPreviewSurfaceDataSchema>;
2386
-
2387
- declare const DocumentPreviewSurfaceDataSchema: z.ZodObject<{
2388
- title: z.ZodCatch<z.ZodString>;
2389
- surfaceId: z.ZodCatch<z.ZodString>;
2390
- subtitle: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2391
- content: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2392
- mimeType: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2393
- }, z.core.$strip>;
2394
-
2395
2327
  declare type _DocumentsServerMessages = DocumentEditorShowEvent | DocumentEditorUpdateEvent;
2396
2328
 
2397
2329
  /**
@@ -2403,33 +2335,6 @@ declare type _DocumentsServerMessages = DocumentEditorShowEvent | DocumentEditor
2403
2335
  */
2404
2336
  export declare function doesSupportVision(modelOrProfile: ModelProfileInfo | string): boolean;
2405
2337
 
2406
- declare type DynamicPageSurfaceData = z.infer<typeof DynamicPageSurfaceDataSchema>;
2407
-
2408
- declare const DynamicPageSurfaceDataSchema: z.ZodObject<{
2409
- html: z.ZodCatch<z.ZodString>;
2410
- width: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
2411
- height: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
2412
- appId: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2413
- dirName: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2414
- reloadGeneration: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
2415
- status: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2416
- preview: z.ZodCatch<z.ZodOptional<z.ZodObject<{
2417
- title: z.ZodCatch<z.ZodString>;
2418
- subtitle: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2419
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2420
- icon: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2421
- metrics: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
2422
- label: z.ZodCoercedString<unknown>;
2423
- value: z.ZodCoercedString<unknown>;
2424
- }, z.core.$strip>>>>;
2425
- context: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
2426
- app_create: "app_create";
2427
- general: "general";
2428
- }>>>;
2429
- previewImage: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2430
- }, z.core.$strip>>>;
2431
- }, z.core.$strip>;
2432
-
2433
2338
  /** Embed a target and upsert its vector into the vector store. */
2434
2339
  export declare function embedAndUpsert(targetType: EmbeddingTargetType, targetId: string, input: EmbeddingInput, extraPayload?: Record<string, unknown>): Promise<void>;
2435
2340
 
@@ -2481,74 +2386,6 @@ export declare interface FileContent {
2481
2386
  _attachmentId?: string;
2482
2387
  }
2483
2388
 
2484
- declare type FileUploadSurfaceData = z.infer<typeof FileUploadSurfaceDataSchema>;
2485
-
2486
- declare const FileUploadSurfaceDataSchema: z.ZodObject<{
2487
- prompt: z.ZodOptional<z.ZodCoercedString<unknown>>;
2488
- acceptedTypes: z.ZodPipe<z.ZodTransform<string[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
2489
- maxFiles: z.ZodCatch<z.ZodOptional<z.ZodCoercedNumber<unknown>>>;
2490
- maxSizeBytes: z.ZodCatch<z.ZodOptional<z.ZodCoercedNumber<unknown>>>;
2491
- }, z.core.$strip>;
2492
-
2493
- declare type FormSurfaceData = z.infer<typeof FormSurfaceDataSchema>;
2494
-
2495
- declare const FormSurfaceDataSchema: z.ZodObject<{
2496
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2497
- fields: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
2498
- id: z.ZodCatch<z.ZodString>;
2499
- type: z.ZodCatch<z.ZodEnum<{
2500
- number: "number";
2501
- text: "text";
2502
- textarea: "textarea";
2503
- select: "select";
2504
- toggle: "toggle";
2505
- password: "password";
2506
- }>>;
2507
- label: z.ZodCatch<z.ZodString>;
2508
- placeholder: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2509
- required: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
2510
- defaultValue: z.ZodCatch<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
2511
- options: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
2512
- label: z.ZodCoercedString<unknown>;
2513
- value: z.ZodCoercedString<unknown>;
2514
- }, z.core.$strip>>>>;
2515
- }, z.core.$strip>>>;
2516
- submitLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2517
- pages: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
2518
- id: z.ZodCatch<z.ZodString>;
2519
- title: z.ZodCatch<z.ZodString>;
2520
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2521
- fields: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
2522
- id: z.ZodCatch<z.ZodString>;
2523
- type: z.ZodCatch<z.ZodEnum<{
2524
- number: "number";
2525
- text: "text";
2526
- textarea: "textarea";
2527
- select: "select";
2528
- toggle: "toggle";
2529
- password: "password";
2530
- }>>;
2531
- label: z.ZodCatch<z.ZodString>;
2532
- placeholder: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2533
- required: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
2534
- defaultValue: z.ZodCatch<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
2535
- options: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
2536
- label: z.ZodCoercedString<unknown>;
2537
- value: z.ZodCoercedString<unknown>;
2538
- }, z.core.$strip>>>>;
2539
- }, z.core.$strip>>>;
2540
- }, z.core.$strip>>>>>;
2541
- pageLabels: z.ZodCatch<z.ZodOptional<z.ZodObject<{
2542
- next: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2543
- back: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2544
- submit: z.ZodCatch<z.ZodOptional<z.ZodString>>;
2545
- }, z.core.$strip>>>;
2546
- progressStyle: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
2547
- bar: "bar";
2548
- tabs: "tabs";
2549
- }>>>;
2550
- }, z.core.$strip>;
2551
-
2552
2389
  declare type GenerationCancelledEvent = z.infer<typeof GenerationCancelledEventSchema>;
2553
2390
 
2554
2391
  declare const GenerationCancelledEventSchema: z.ZodObject<{
@@ -3313,23 +3150,6 @@ export declare function listConversations(limit?: number, conversationType?: Con
3313
3150
  */
3314
3151
  export declare function listInstalledSkills(): Promise<ResolvedSkillEntry[]>;
3315
3152
 
3316
- declare type ListSurfaceData = z.infer<typeof ListSurfaceDataSchema>;
3317
-
3318
- declare const ListSurfaceDataSchema: z.ZodObject<{
3319
- items: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
3320
- id: z.ZodCatch<z.ZodString>;
3321
- title: z.ZodCatch<z.ZodString>;
3322
- subtitle: z.ZodCatch<z.ZodOptional<z.ZodString>>;
3323
- icon: z.ZodCatch<z.ZodOptional<z.ZodString>>;
3324
- selected: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
3325
- }, z.core.$strip>>>;
3326
- selectionMode: z.ZodCatch<z.ZodEnum<{
3327
- none: "none";
3328
- single: "single";
3329
- multiple: "multiple";
3330
- }>>;
3331
- }, z.core.$strip>;
3332
-
3333
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"];
3334
3154
 
3335
3155
  declare const LIVE_VOICE_TURN_DETECTION_MODES: readonly ["manual", "server_vad"];
@@ -3955,15 +3775,6 @@ declare const OAuthConnectResultEventSchema: z.ZodObject<{
3955
3775
  error: z.ZodOptional<z.ZodString>;
3956
3776
  }, z.core.$strip>;
3957
3777
 
3958
- declare type OAuthConnectSurfaceData = z.infer<typeof OAuthConnectSurfaceDataSchema>;
3959
-
3960
- declare const OAuthConnectSurfaceDataSchema: z.ZodObject<{
3961
- providerKey: z.ZodCatch<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>>;
3962
- displayName: z.ZodCatch<z.ZodOptional<z.ZodString>>;
3963
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
3964
- logoUrl: z.ZodCatch<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
3965
- }, z.core.$strip>;
3966
-
3967
3778
  declare type OpenConversationEvent = z.infer<typeof OpenConversationEventSchema>;
3968
3779
 
3969
3780
  declare const OpenConversationEventSchema: z.ZodObject<{
@@ -5509,70 +5320,7 @@ declare type SubscriberInput = DistributiveOmit<SubscriberEntry, "active" | "con
5509
5320
  onEvict?: () => void;
5510
5321
  };
5511
5322
 
5512
- declare interface SurfaceAction {
5513
- id: string;
5514
- label: string;
5515
- style?: "primary" | "secondary" | "destructive";
5516
- /** Optional data payload returned to the daemon when this action is clicked. */
5517
- data?: Record<string, unknown>;
5518
- }
5519
-
5520
- /**
5521
- * Per-type `data` payload shapes, keyed by surface type. This is the
5522
- * correlation source for everything that pairs a `surfaceType` with its
5523
- * `data`: generic code indexes it (`SurfaceDataByType[K]`) so the compiler
5524
- * tracks which data shape belongs to which type instead of collapsing to
5525
- * the undiscriminated `SurfaceData` union.
5526
- *
5527
- * Several types are opaque records — they carry data the daemon persists
5528
- * and serves verbatim but whose shape it does not model, which is why they
5529
- * are absent from the renderable `SurfaceData` union: `channel_setup` (a
5530
- * side-effect command forwarded to the setup panel), `task_preferences` (a
5531
- * fixed grid that reads no data), and `skill_card` / `call_summary` (cards
5532
- * the daemon appends to history directly — the memory retrospective and a
5533
- * call summary — and whose data shape is owned by their client renderers).
5534
- */
5535
- declare interface SurfaceDataByType {
5536
- card: CardSurfaceData;
5537
- channel_setup: Record<string, unknown>;
5538
- choice: ChoiceSurfaceData;
5539
- copy_block: CopyBlockSurfaceData;
5540
- oauth_connect: OAuthConnectSurfaceData;
5541
- form: FormSurfaceData;
5542
- list: ListSurfaceData;
5543
- table: TableSurfaceData;
5544
- confirmation: ConfirmationSurfaceData;
5545
- dynamic_page: DynamicPageSurfaceData;
5546
- file_upload: FileUploadSurfaceData;
5547
- document_preview: DocumentPreviewSurfaceData;
5548
- task_preferences: Record<string, unknown>;
5549
- work_result: WorkResultSurfaceData;
5550
- skill_card: Record<string, unknown>;
5551
- call_summary: Record<string, unknown>;
5552
- }
5553
-
5554
- declare type _SurfacesServerMessages = UiSurfaceShow | UiSurfaceUpdate | UiSurfaceDismiss | UiSurfaceComplete | UiSurfaceUndoResult;
5555
-
5556
- declare type SurfaceType = z.infer<typeof SurfaceTypeSchema>;
5557
-
5558
- declare const SurfaceTypeSchema: z.ZodEnum<{
5559
- table: "table";
5560
- card: "card";
5561
- channel_setup: "channel_setup";
5562
- choice: "choice";
5563
- copy_block: "copy_block";
5564
- oauth_connect: "oauth_connect";
5565
- form: "form";
5566
- list: "list";
5567
- confirmation: "confirmation";
5568
- dynamic_page: "dynamic_page";
5569
- file_upload: "file_upload";
5570
- document_preview: "document_preview";
5571
- task_preferences: "task_preferences";
5572
- work_result: "work_result";
5573
- skill_card: "skill_card";
5574
- call_summary: "call_summary";
5575
- }>;
5323
+ declare type _SurfacesServerMessages = UISurfaceShowEvent | UISurfaceUpdateEvent | UISurfaceDismissEvent | UISurfaceCompleteEvent | UISurfaceUndoResultEvent;
5576
5324
 
5577
5325
  /**
5578
5326
  * Delete `graph_node` Qdrant points whose backing `memory_graph_nodes` row no
@@ -5638,32 +5386,6 @@ export declare interface SynthesizeTextOptions {
5638
5386
  signal?: AbortSignal;
5639
5387
  }
5640
5388
 
5641
- declare type TableSurfaceData = z.infer<typeof TableSurfaceDataSchema>;
5642
-
5643
- declare const TableSurfaceDataSchema: z.ZodObject<{
5644
- columns: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
5645
- id: z.ZodCatch<z.ZodString>;
5646
- label: z.ZodCatch<z.ZodString>;
5647
- width: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
5648
- }, z.core.$strip>>>;
5649
- rows: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
5650
- id: z.ZodCatch<z.ZodString>;
5651
- cells: z.ZodCatch<z.ZodRecord<z.ZodString, z.ZodCatch<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
5652
- text: z.ZodCatch<z.ZodCoercedString<unknown>>;
5653
- icon: z.ZodCatch<z.ZodOptional<z.ZodString>>;
5654
- iconColor: z.ZodCatch<z.ZodOptional<z.ZodString>>;
5655
- }, z.core.$strip>]>>>>;
5656
- selectable: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
5657
- selected: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
5658
- }, z.core.$strip>>>;
5659
- selectionMode: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
5660
- none: "none";
5661
- single: "single";
5662
- multiple: "multiple";
5663
- }>>>;
5664
- caption: z.ZodCatch<z.ZodOptional<z.ZodString>>;
5665
- }, z.core.$strip>;
5666
-
5667
5389
  export declare interface TextContent {
5668
5390
  type: "text";
5669
5391
  text: string;
@@ -6357,71 +6079,70 @@ declare type TtsUseCase =
6357
6079
  /** In-app message playback — buffer-oriented, higher quality acceptable. */
6358
6080
  | "message-playback";
6359
6081
 
6360
- declare interface UiSurfaceComplete {
6361
- type: "ui_surface_complete";
6362
- conversationId: string;
6363
- surfaceId: string;
6364
- summary: string;
6365
- submittedData?: Record<string, unknown>;
6366
- }
6082
+ declare type UISurfaceCompleteEvent = z.infer<typeof UISurfaceCompleteEventSchema>;
6367
6083
 
6368
- declare interface UiSurfaceDismiss {
6369
- type: "ui_surface_dismiss";
6370
- conversationId: string;
6371
- surfaceId: string;
6372
- }
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>;
6373
6091
 
6374
- /**
6375
- * Discriminated union over every surface type, derived from
6376
- * `SurfaceDataByType` so a type added there appears here automatically.
6377
- * Includes the opaque types (`channel_setup`, `task_preferences`) — their
6378
- * show events carry opaque record data.
6379
- */
6380
- declare type UiSurfaceShow = {
6381
- [K in SurfaceType]: UiSurfaceShowFor<K>;
6382
- }[SurfaceType];
6092
+ declare type UISurfaceDismissEvent = z.infer<typeof UISurfaceDismissEventSchema>;
6383
6093
 
6384
- /** Common fields shared by all UiSurfaceShow variants. */
6385
- declare interface UiSurfaceShowBase {
6386
- type: "ui_surface_show";
6387
- conversationId: string;
6388
- surfaceId: string;
6389
- title?: string;
6390
- actions?: SurfaceAction[];
6391
- display?: "inline" | "panel";
6392
- /** The message ID that this surface belongs to (for history loading). */
6393
- messageId?: string;
6394
- /** 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. */
6395
- persistent?: boolean;
6396
- /** 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. */
6397
- toolCallId?: string;
6398
- }
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>;
6399
6099
 
6400
- /**
6401
- * The show event for one specific surface type: base fields plus the
6402
- * correlated `surfaceType`/`data` pair, both indexed from
6403
- * `SurfaceDataByType` so generic code keeps the pairing.
6404
- */
6405
- declare type UiSurfaceShowFor<K extends SurfaceType> = UiSurfaceShowBase & {
6406
- surfaceType: K;
6407
- data: SurfaceDataByType[K];
6408
- };
6100
+ declare type UISurfaceShowEvent = z.infer<typeof UISurfaceShowEventSchema>;
6409
6101
 
6410
- declare interface UiSurfaceUndoResult {
6411
- type: "ui_surface_undo_result";
6412
- conversationId: string;
6413
- surfaceId: string;
6414
- success: boolean;
6415
- /** Number of remaining undo entries after this undo. */
6416
- remainingUndos: number;
6417
- }
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>;
6418
6127
 
6419
- declare interface UiSurfaceUpdate {
6420
- type: "ui_surface_update";
6421
- conversationId: string;
6422
- surfaceId: string;
6423
- data: Partial<AnySurfaceData>;
6424
- }
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>;
6425
6146
 
6426
6147
  declare interface UndoComplete {
6427
6148
  type: "undo_complete";
@@ -6761,64 +6482,6 @@ declare const WorkflowStartedEventSchema: z.ZodObject<{
6761
6482
  label: z.ZodOptional<z.ZodString>;
6762
6483
  }, z.core.$strict>;
6763
6484
 
6764
- declare type WorkResultSurfaceData = z.infer<typeof WorkResultSurfaceDataSchema>;
6765
-
6766
- declare const WorkResultSurfaceDataSchema: z.ZodObject<{
6767
- eyebrow: z.ZodCatch<z.ZodOptional<z.ZodString>>;
6768
- status: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
6769
- completed: "completed";
6770
- failed: "failed";
6771
- partial: "partial";
6772
- in_progress: "in_progress";
6773
- }>>>;
6774
- summary: z.ZodCatch<z.ZodOptional<z.ZodString>>;
6775
- metrics: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
6776
- detail: z.ZodCatch<z.ZodOptional<z.ZodString>>;
6777
- tone: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
6778
- neutral: "neutral";
6779
- positive: "positive";
6780
- warning: "warning";
6781
- negative: "negative";
6782
- }>>>;
6783
- label: z.ZodCatch<z.ZodCoercedString<unknown>>;
6784
- value: z.ZodCatch<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
6785
- }, z.core.$strip>>>>>;
6786
- sections: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
6787
- id: z.ZodCatch<z.ZodOptional<z.ZodString>>;
6788
- title: z.ZodCatch<z.ZodCoercedString<unknown>>;
6789
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
6790
- type: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
6791
- diff: "diff";
6792
- items: "items";
6793
- timeline: "timeline";
6794
- artifacts: "artifacts";
6795
- warnings: "warnings";
6796
- }>>>;
6797
- items: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
6798
- id: z.ZodCatch<z.ZodOptional<z.ZodString>>;
6799
- title: z.ZodCatch<z.ZodCoercedString<unknown>>;
6800
- description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
6801
- status: z.ZodCatch<z.ZodOptional<z.ZodString>>;
6802
- tone: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
6803
- neutral: "neutral";
6804
- positive: "positive";
6805
- warning: "warning";
6806
- negative: "negative";
6807
- }>>>;
6808
- metadata: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
6809
- label: z.ZodCatch<z.ZodCoercedString<unknown>>;
6810
- value: z.ZodCatch<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
6811
- }, z.core.$strip>>>>>;
6812
- href: z.ZodCatch<z.ZodOptional<z.ZodString>>;
6813
- }, z.core.$strip>>>>>;
6814
- diffs: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
6815
- label: z.ZodCatch<z.ZodOptional<z.ZodString>>;
6816
- before: z.ZodCatch<z.ZodOptional<z.ZodString>>;
6817
- after: z.ZodCatch<z.ZodOptional<z.ZodString>>;
6818
- }, z.core.$strip>>>>>;
6819
- }, z.core.$strip>>>>>;
6820
- }, z.core.$strip>;
6821
-
6822
6485
  declare interface WorkspaceFileReadResponse {
6823
6486
  type: "workspace_file_read_response";
6824
6487
  path: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vellumai/plugin-api",
3
- "version": "0.10.11-dev.202607241238.b7ebd7f",
3
+ "version": "0.10.11-dev.202607241335.d95a4c6",
4
4
  "description": "Public TypeScript authoring contract for Vellum assistant plugins.",
5
5
  "license": "MIT",
6
6
  "type": "module",