@vellumai/plugin-api 0.10.11-dev.202607221832.fc8c883 → 0.10.11-dev.202607221933.baa2119

package/index.d.ts

@@ -1818,27 +1818,27 @@ declare interface ChannelVerificationSessionResponse {
     pendingBootstrap?: boolean;
 }
 
-declare interface ChoiceOption {
-    id: string;
-    title: string;
-    description?: string;
-    /** Visually highlight this option as the assistant's recommendation. */
-    recommended?: boolean;
-    /** Optional structured payload returned with this choice. */
-    data?: Record<string, unknown>;
-}
+declare type ChoiceSurfaceData = z.infer<typeof ChoiceSurfaceDataSchema>;
 
-declare interface ChoiceSurfaceData {
-    description?: string;
-    options: ChoiceOption[];
-    selectionMode?: "single" | "multiple";
-    /**
-     * When true, clicking an option submits it immediately. Defaults to true for
-     * single-select choice surfaces.
-     */
-    commitOnSelect?: boolean;
-    submitLabel?: string;
-}
+declare const ChoiceSurfaceDataSchema: z.ZodObject<{
+    description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    options: z.ZodPipe<z.ZodTransform<{
+        id: string;
+        title: string;
+    }[], unknown>, z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        recommended: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
+        data: z.ZodCatch<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    }, z.core.$strip>>>;
+    selectionMode: z.ZodPipe<z.ZodTransform<"single" | "multiple", unknown>, z.ZodEnum<{
+        single: "single";
+        multiple: "multiple";
+    }>>;
+    commitOnSelect: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
+    submitLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
 
 declare interface ClawhubSlimSkill extends SlimSkillBase {
     origin: "clawhub";
@@ -2044,14 +2044,16 @@ declare interface ConfirmationStateChanged {
     toolUseId?: string;
 }
 
-declare interface ConfirmationSurfaceData {
-    message: string;
-    detail?: string;
-    confirmLabel?: string;
-    confirmedLabel?: string;
-    cancelLabel?: string;
-    destructive?: boolean;
-}
+declare type ConfirmationSurfaceData = z.infer<typeof ConfirmationSurfaceDataSchema>;
+
+declare const ConfirmationSurfaceDataSchema: z.ZodObject<{
+    message: z.ZodCatch<z.ZodString>;
+    detail: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    confirmLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    confirmedLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    cancelLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    destructive: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>;
 
 declare interface ContactChannelPayload {
     id: string;
@@ -2381,6 +2383,16 @@ export declare interface ConversationRow {
     processingStartedAt: number | null;
 }
 
+/**
+ * The full `conversations-cleared` context a hook receives. Fires once when the
+ * clear-all reset wipes every conversation, so unlike `conversation-deleted` it
+ * carries no `conversationId` — a hook keyed on it wipes its own
+ * per-conversation state wholesale. Only the pipeline-stamped
+ * {@link BaseHookContext} capabilities are present, so the context is exactly
+ * {@link BaseHookContext}.
+ */
+export declare type ConversationsClearedContext = BaseHookContext;
+
 declare interface ConversationsClearResponse {
     type: "conversations_clear_response";
     cleared: number;
@@ -2422,11 +2434,13 @@ declare type ConversationType = "standard" | "background" | "scheduled";
 /** Read-side alias of {@link ConversationCreateType}. */
 declare type ConversationType_2 = ConversationCreateType;
 
-declare interface CopyBlockSurfaceData {
-    text: string;
-    label?: string;
-    language?: string;
-}
+declare type CopyBlockSurfaceData = z.infer<typeof CopyBlockSurfaceDataSchema>;
+
+declare const CopyBlockSurfaceDataSchema: z.ZodObject<{
+    text: z.ZodCatch<z.ZodString>;
+    label: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    language: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
 
 /** Create a live voice connection bound to the caller's `send` transport. */
 export declare function createLiveVoiceConnection(options: {
@@ -2620,11 +2634,13 @@ declare interface DocumentLoadResponse {
     error?: string;
 }
 
-declare interface DocumentPreviewSurfaceData {
-    title: string;
-    surfaceId: string;
-    subtitle?: string;
-}
+declare type DocumentPreviewSurfaceData = z.infer<typeof DocumentPreviewSurfaceDataSchema>;
+
+declare const DocumentPreviewSurfaceDataSchema: z.ZodObject<{
+    title: z.ZodCatch<z.ZodString>;
+    surfaceId: z.ZodCatch<z.ZodString>;
+    subtitle: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
 
 declare interface DocumentSaveResponse {
     type: "document_save_response";
@@ -2644,30 +2660,32 @@ declare type _DocumentsServerMessages = DocumentEditorShow | DocumentEditorUpdat
  */
 export declare function doesSupportVision(modelOrProfile: ModelProfileInfo | string): boolean;
 
-declare interface DynamicPagePreview {
-    title: string;
-    subtitle?: string;
-    description?: string;
-    icon?: string;
-    metrics?: Array<{
-        label: string;
-        value: string;
-    }>;
-    context?: "app_create" | "general";
-    previewImage?: string;
-}
-
-declare interface DynamicPageSurfaceData {
-    html: string;
-    width?: number;
-    height?: number;
-    appId?: string;
-    /** Filesystem directory name for this app (may differ from `appId`). */
-    dirName?: string;
-    reloadGeneration?: number;
-    status?: string;
-    preview?: DynamicPagePreview;
-}
+declare type DynamicPageSurfaceData = z.infer<typeof DynamicPageSurfaceDataSchema>;
+
+declare const DynamicPageSurfaceDataSchema: z.ZodObject<{
+    html: z.ZodCatch<z.ZodString>;
+    width: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
+    height: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
+    appId: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    dirName: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    reloadGeneration: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
+    status: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    preview: z.ZodCatch<z.ZodOptional<z.ZodObject<{
+        title: z.ZodCatch<z.ZodString>;
+        subtitle: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        icon: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        metrics: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            label: z.ZodCoercedString<unknown>;
+            value: z.ZodCoercedString<unknown>;
+        }, z.core.$strip>>>>;
+        context: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
+            app_create: "app_create";
+            general: "general";
+        }>>>;
+        previewImage: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
 
 /** Embed a target and upsert its vector into the vector store. */
 export declare function embedAndUpsert(targetType: EmbeddingTargetType, targetId: string, input: EmbeddingInput, extraPayload?: Record<string, unknown>): Promise<void>;
@@ -2761,39 +2779,64 @@ declare interface ForkSharedAppResponse {
     error?: string;
 }
 
-declare interface FormField {
-    id: string;
-    type: "text" | "textarea" | "select" | "toggle" | "number" | "password";
-    label: string;
-    placeholder?: string;
-    required?: boolean;
-    defaultValue?: string | number | boolean;
-    options?: Array<{
-        label: string;
-        value: string;
-    }>;
-}
+declare type FormSurfaceData = z.infer<typeof FormSurfaceDataSchema>;
 
-declare interface FormPage {
-    id: string;
-    title: string;
-    description?: string;
-    fields: FormField[];
-}
-
-declare interface FormSurfaceData {
-    description?: string;
-    fields: FormField[];
-    submitLabel?: string;
-    pages?: FormPage[];
-    pageLabels?: {
-        next?: string;
-        back?: string;
-        submit?: string;
-    };
-    /** Progress indicator style for multi-page forms: segment bar or labeled tabs. */
-    progressStyle?: "bar" | "tabs";
-}
+declare const FormSurfaceDataSchema: z.ZodObject<{
+    description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    fields: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
+        id: z.ZodCatch<z.ZodString>;
+        type: z.ZodCatch<z.ZodEnum<{
+            number: "number";
+            text: "text";
+            select: "select";
+            textarea: "textarea";
+            toggle: "toggle";
+            password: "password";
+        }>>;
+        label: z.ZodCatch<z.ZodString>;
+        placeholder: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        required: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
+        defaultValue: z.ZodCatch<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
+        options: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            label: z.ZodCoercedString<unknown>;
+            value: z.ZodCoercedString<unknown>;
+        }, z.core.$strip>>>>;
+    }, z.core.$strip>>>;
+    submitLabel: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    pages: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
+        id: z.ZodCatch<z.ZodString>;
+        title: z.ZodCatch<z.ZodString>;
+        description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        fields: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
+            id: z.ZodCatch<z.ZodString>;
+            type: z.ZodCatch<z.ZodEnum<{
+                number: "number";
+                text: "text";
+                select: "select";
+                textarea: "textarea";
+                toggle: "toggle";
+                password: "password";
+            }>>;
+            label: z.ZodCatch<z.ZodString>;
+            placeholder: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+            required: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
+            defaultValue: z.ZodCatch<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
+            options: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
+                label: z.ZodCoercedString<unknown>;
+                value: z.ZodCoercedString<unknown>;
+            }, z.core.$strip>>>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>>>>;
+    pageLabels: z.ZodCatch<z.ZodOptional<z.ZodObject<{
+        next: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        back: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        submit: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>>;
+    progressStyle: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
+        bar: "bar";
+        tabs: "tabs";
+    }>>>;
+}, z.core.$strip>;
 
 /** Response to a generate_avatar request indicating success or failure. */
 declare interface GenerateAvatarResponse {
@@ -3191,6 +3234,7 @@ declare const HookEventSchema: z.ZodObject<{
  *   - `stop` — {@link StopContext}
  *   - `post-model-call` — {@link PostModelCallContext}
  *   - `conversation-deleted` — {@link ConversationDeletedContext}
+ *   - `conversations-cleared` — {@link ConversationsClearedContext}
  */
 export declare type HookFunction<TCtx = unknown> = (ctx: TCtx) => Promise<Partial<TCtx> | void>;
 
@@ -3230,6 +3274,8 @@ export declare const HOOKS: {
     readonly POST_COMPACT: "post-compact";
     /** Fires once per deleted conversation, after its rows are removed. Fire-and-forget cleanup signal — hooks run async with no ordering guarantee relative to the caller. */
     readonly CONVERSATION_DELETED: "conversation-deleted";
+    /** Fires once when every conversation is wiped at once (the clear-all reset), after the main tables are cleared. Carries no `conversationId`; cleanup hooks wipe their own per-conversation state wholesale. */
+    readonly CONVERSATIONS_CLEARED: "conversations-cleared";
 };
 
 /**
@@ -3746,18 +3792,22 @@ export declare function listConversations(limit?: number, conversationType?: Con
  */
 export declare function listInstalledSkills(): Promise<ResolvedSkillEntry[]>;
 
-declare interface ListItem {
-    id: string;
-    title: string;
-    subtitle?: string;
-    icon?: string;
-    selected?: boolean;
-}
+declare type ListSurfaceData = z.infer<typeof ListSurfaceDataSchema>;
 
-declare interface ListSurfaceData {
-    items: ListItem[];
-    selectionMode: "single" | "multiple" | "none";
-}
+declare const ListSurfaceDataSchema: z.ZodObject<{
+    items: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
+        id: z.ZodCatch<z.ZodString>;
+        title: z.ZodCatch<z.ZodString>;
+        subtitle: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        icon: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        selected: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
+    }, z.core.$strip>>>;
+    selectionMode: z.ZodCatch<z.ZodEnum<{
+        none: "none";
+        single: "single";
+        multiple: "multiple";
+    }>>;
+}, z.core.$strip>;
 
 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"];
 
@@ -4405,16 +4455,14 @@ declare interface OAuthConnectResultResponse {
     error?: string;
 }
 
-declare interface OAuthConnectSurfaceData {
-    /** OAuth provider key from the managed provider catalog, e.g. "google". */
-    providerKey: string;
-    /** Optional display label. The client falls back to the provider catalog. */
-    displayName?: string;
-    /** Optional helper text. The client falls back to the provider catalog. */
-    description?: string;
-    /** Optional provider logo URL. The client falls back to the provider catalog. */
-    logoUrl?: string | null;
-}
+declare type OAuthConnectSurfaceData = z.infer<typeof OAuthConnectSurfaceDataSchema>;
+
+declare const OAuthConnectSurfaceDataSchema: z.ZodObject<{
+    providerKey: z.ZodCatch<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>>;
+    displayName: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    logoUrl: z.ZodCatch<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+}, z.core.$strip>;
 
 declare interface OpenBundleResponse {
     type: "open_bundle_response";
@@ -6277,31 +6325,31 @@ export declare interface SynthesizeTextOptions {
     signal?: AbortSignal;
 }
 
-declare interface TableCellValue {
-    text: string;
-    icon?: string;
-    iconColor?: string;
-}
+declare type TableSurfaceData = z.infer<typeof TableSurfaceDataSchema>;
 
-declare interface TableColumn {
-    id: string;
-    label: string;
-    width?: number;
-}
-
-declare interface TableRow {
-    id: string;
-    cells: Record<string, string | TableCellValue>;
-    selectable?: boolean;
-    selected?: boolean;
-}
-
-declare interface TableSurfaceData {
-    columns: TableColumn[];
-    rows: TableRow[];
-    selectionMode?: "none" | "single" | "multiple";
-    caption?: string;
-}
+declare const TableSurfaceDataSchema: z.ZodObject<{
+    columns: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
+        id: z.ZodCatch<z.ZodString>;
+        label: z.ZodCatch<z.ZodString>;
+        width: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+    rows: z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
+        id: z.ZodCatch<z.ZodString>;
+        cells: z.ZodCatch<z.ZodRecord<z.ZodString, z.ZodCatch<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            text: z.ZodCatch<z.ZodCoercedString<unknown>>;
+            icon: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+            iconColor: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>]>>>>;
+        selectable: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
+        selected: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
+    }, z.core.$strip>>>;
+    selectionMode: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        single: "single";
+        multiple: "multiple";
+    }>>>;
+    caption: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
 
 declare interface TelegramConfigResponse {
     type: "telegram_config_response";
@@ -7459,56 +7507,63 @@ declare const WorkflowStartedEventSchema: z.ZodObject<{
     label: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>;
 
-declare interface WorkResultDiff {
-    label?: string;
-    before?: string;
-    after?: string;
-}
-
-declare interface WorkResultItem {
-    id?: string;
-    title: string;
-    description?: string;
-    status?: string;
-    tone?: WorkResultTone;
-    metadata?: WorkResultMetadata[];
-    href?: string;
-}
-
-declare interface WorkResultMetadata {
-    label: string;
-    value: string | number;
-}
-
-declare interface WorkResultMetric {
-    label: string;
-    value: string | number;
-    detail?: string;
-    tone?: WorkResultTone;
-}
-
-declare interface WorkResultSection {
-    id?: string;
-    title: string;
-    description?: string;
-    type?: WorkResultSectionType;
-    items?: WorkResultItem[];
-    diffs?: WorkResultDiff[];
-}
-
-declare type WorkResultSectionType = "items" | "timeline" | "diff" | "artifacts" | "warnings";
-
-declare type WorkResultStatus = "completed" | "partial" | "failed" | "in_progress";
-
-declare interface WorkResultSurfaceData {
-    eyebrow?: string;
-    status?: WorkResultStatus;
-    summary?: string;
-    metrics?: WorkResultMetric[];
-    sections?: WorkResultSection[];
-}
+declare type WorkResultSurfaceData = z.infer<typeof WorkResultSurfaceDataSchema>;
 
-declare type WorkResultTone = "neutral" | "positive" | "warning" | "negative";
+declare const WorkResultSurfaceDataSchema: z.ZodObject<{
+    eyebrow: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    status: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
+        failed: "failed";
+        partial: "partial";
+        in_progress: "in_progress";
+        completed: "completed";
+    }>>>;
+    summary: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    metrics: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
+        detail: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        tone: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
+            neutral: "neutral";
+            positive: "positive";
+            warning: "warning";
+            negative: "negative";
+        }>>>;
+        label: z.ZodCatch<z.ZodCoercedString<unknown>>;
+        value: z.ZodCatch<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    }, z.core.$strip>>>>>;
+    sections: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
+        id: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        title: z.ZodCatch<z.ZodCoercedString<unknown>>;
+        description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        type: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
+            diff: "diff";
+            items: "items";
+            timeline: "timeline";
+            artifacts: "artifacts";
+            warnings: "warnings";
+        }>>>;
+        items: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
+            id: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+            title: z.ZodCatch<z.ZodCoercedString<unknown>>;
+            description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+            status: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+            tone: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
+                neutral: "neutral";
+                positive: "positive";
+                warning: "warning";
+                negative: "negative";
+            }>>>;
+            metadata: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
+                label: z.ZodCatch<z.ZodCoercedString<unknown>>;
+                value: z.ZodCatch<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+            }, z.core.$strip>>>>>;
+            href: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>>>>>;
+        diffs: z.ZodCatch<z.ZodOptional<z.ZodPipe<z.ZodTransform<Record<string, unknown>[], unknown>, z.ZodArray<z.ZodObject<{
+            label: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+            before: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+            after: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>>>>>;
+    }, z.core.$strip>>>>>;
+}, z.core.$strip>;
 
 declare interface WorkspaceFileReadResponse {
     type: "workspace_file_read_response";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vellumai/plugin-api",
-  "version": "0.10.11-dev.202607221832.fc8c883",
+  "version": "0.10.11-dev.202607221933.baa2119",
   "description": "Public TypeScript authoring contract for Vellum assistant plugins.",
   "license": "MIT",
   "type": "module",