@vellumai/plugin-api 0.10.11-dev.202607230140.b414d01 → 0.10.11-dev.202607230310.c962b95

package/index.d.ts

@@ -151,6 +151,9 @@ export declare type AgentLoopExitReason =
 /** An unhandled error ended the turn. */
 | "error";
 
+/** Any surface `data` payload, including the opaque (non-renderable) types. */
+declare type AnySurfaceData = SurfaceDataByType[SurfaceType];
+
 declare interface AppDataResponse {
     type: "app_data_response";
     surfaceId: string;
@@ -6253,10 +6256,63 @@ declare interface SurfaceAction {
     data?: Record<string, unknown>;
 }
 
-declare type SurfaceData = CardSurfaceData | ChoiceSurfaceData | CopyBlockSurfaceData | OAuthConnectSurfaceData | FormSurfaceData | ListSurfaceData | TableSurfaceData | ConfirmationSurfaceData | DynamicPageSurfaceData | FileUploadSurfaceData | DocumentPreviewSurfaceData | WorkResultSurfaceData;
+/**
+ * Per-type `data` payload shapes, keyed by surface type. This is the
+ * correlation source for everything that pairs a `surfaceType` with its
+ * `data`: generic code indexes it (`SurfaceDataByType[K]`) so the compiler
+ * tracks which data shape belongs to which type instead of collapsing to
+ * the undiscriminated `SurfaceData` union.
+ *
+ * Several types are opaque records — they carry data the daemon persists
+ * and serves verbatim but whose shape it does not model, which is why they
+ * are absent from the renderable `SurfaceData` union: `channel_setup` (a
+ * side-effect command forwarded to the setup panel), `task_preferences` (a
+ * fixed grid that reads no data), and `skill_card` / `call_summary` (cards
+ * the daemon appends to history directly — the memory retrospective and a
+ * call summary — and whose data shape is owned by their client renderers).
+ */
+declare interface SurfaceDataByType {
+    card: CardSurfaceData;
+    channel_setup: Record<string, unknown>;
+    choice: ChoiceSurfaceData;
+    copy_block: CopyBlockSurfaceData;
+    oauth_connect: OAuthConnectSurfaceData;
+    form: FormSurfaceData;
+    list: ListSurfaceData;
+    table: TableSurfaceData;
+    confirmation: ConfirmationSurfaceData;
+    dynamic_page: DynamicPageSurfaceData;
+    file_upload: FileUploadSurfaceData;
+    document_preview: DocumentPreviewSurfaceData;
+    task_preferences: Record<string, unknown>;
+    work_result: WorkResultSurfaceData;
+    skill_card: Record<string, unknown>;
+    call_summary: Record<string, unknown>;
+}
 
 declare type _SurfacesServerMessages = UiSurfaceShow | UiSurfaceUpdate | UiSurfaceDismiss | UiSurfaceComplete | UiSurfaceUndoResult;
 
+declare type SurfaceType = z.infer<typeof SurfaceTypeSchema>;
+
+declare const SurfaceTypeSchema: z.ZodEnum<{
+    table: "table";
+    form: "form";
+    list: "list";
+    card: "card";
+    channel_setup: "channel_setup";
+    choice: "choice";
+    copy_block: "copy_block";
+    oauth_connect: "oauth_connect";
+    confirmation: "confirmation";
+    dynamic_page: "dynamic_page";
+    file_upload: "file_upload";
+    document_preview: "document_preview";
+    task_preferences: "task_preferences";
+    work_result: "work_result";
+    skill_card: "skill_card";
+    call_summary: "call_summary";
+}>;
+
 /**
  * Delete `graph_node` Qdrant points whose backing `memory_graph_nodes` row no
  * longer exists.
@@ -7062,7 +7118,15 @@ declare interface UiSurfaceDismiss {
     surfaceId: string;
 }
 
-declare type UiSurfaceShow = UiSurfaceShowCard | UiSurfaceShowChoice | UiSurfaceShowCopyBlock | UiSurfaceShowOAuthConnect | UiSurfaceShowForm | UiSurfaceShowList | UiSurfaceShowTable | UiSurfaceShowConfirmation | UiSurfaceShowDynamicPage | UiSurfaceShowFileUpload | UiSurfaceShowDocumentPreview | UiSurfaceShowWorkResult;
+/**
+ * Discriminated union over every surface type, derived from
+ * `SurfaceDataByType` so a type added there appears here automatically.
+ * Includes the opaque types (`channel_setup`, `task_preferences`) — their
+ * show events carry opaque record data.
+ */
+declare type UiSurfaceShow = {
+    [K in SurfaceType]: UiSurfaceShowFor<K>;
+}[SurfaceType];
 
 /** Common fields shared by all UiSurfaceShow variants. */
 declare interface UiSurfaceShowBase {
@@ -7080,65 +7144,15 @@ declare interface UiSurfaceShowBase {
     toolCallId?: string;
 }
 
-declare interface UiSurfaceShowCard extends UiSurfaceShowBase {
-    surfaceType: "card";
-    data: CardSurfaceData;
-}
-
-declare interface UiSurfaceShowChoice extends UiSurfaceShowBase {
-    surfaceType: "choice";
-    data: ChoiceSurfaceData;
-}
-
-declare interface UiSurfaceShowConfirmation extends UiSurfaceShowBase {
-    surfaceType: "confirmation";
-    data: ConfirmationSurfaceData;
-}
-
-declare interface UiSurfaceShowCopyBlock extends UiSurfaceShowBase {
-    surfaceType: "copy_block";
-    data: CopyBlockSurfaceData;
-}
-
-declare interface UiSurfaceShowDocumentPreview extends UiSurfaceShowBase {
-    surfaceType: "document_preview";
-    data: DocumentPreviewSurfaceData;
-}
-
-declare interface UiSurfaceShowDynamicPage extends UiSurfaceShowBase {
-    surfaceType: "dynamic_page";
-    data: DynamicPageSurfaceData;
-}
-
-declare interface UiSurfaceShowFileUpload extends UiSurfaceShowBase {
-    surfaceType: "file_upload";
-    data: FileUploadSurfaceData;
-}
-
-declare interface UiSurfaceShowForm extends UiSurfaceShowBase {
-    surfaceType: "form";
-    data: FormSurfaceData;
-}
-
-declare interface UiSurfaceShowList extends UiSurfaceShowBase {
-    surfaceType: "list";
-    data: ListSurfaceData;
-}
-
-declare interface UiSurfaceShowOAuthConnect extends UiSurfaceShowBase {
-    surfaceType: "oauth_connect";
-    data: OAuthConnectSurfaceData;
-}
-
-declare interface UiSurfaceShowTable extends UiSurfaceShowBase {
-    surfaceType: "table";
-    data: TableSurfaceData;
-}
-
-declare interface UiSurfaceShowWorkResult extends UiSurfaceShowBase {
-    surfaceType: "work_result";
-    data: WorkResultSurfaceData;
-}
+/**
+ * The show event for one specific surface type: base fields plus the
+ * correlated `surfaceType`/`data` pair, both indexed from
+ * `SurfaceDataByType` so generic code keeps the pairing.
+ */
+declare type UiSurfaceShowFor<K extends SurfaceType> = UiSurfaceShowBase & {
+    surfaceType: K;
+    data: SurfaceDataByType[K];
+};
 
 declare interface UiSurfaceUndoResult {
     type: "ui_surface_undo_result";
@@ -7153,7 +7167,7 @@ declare interface UiSurfaceUpdate {
     type: "ui_surface_update";
     conversationId: string;
     surfaceId: string;
-    data: Partial<SurfaceData>;
+    data: Partial<AnySurfaceData>;
 }
 
 declare interface UndoComplete {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vellumai/plugin-api",
-  "version": "0.10.11-dev.202607230140.b414d01",
+  "version": "0.10.11-dev.202607230310.c962b95",
   "description": "Public TypeScript authoring contract for Vellum assistant plugins.",
   "license": "MIT",
   "type": "module",