@vellumai/plugin-api 0.10.5-dev.202607031543.075941f → 0.10.5-dev.202607031636.61acd91

package/index.d.ts

@@ -1827,6 +1827,22 @@ declare const HomeFeedUpdatedEventSchema: z.ZodObject<{
 
 declare type _HomeServerMessages = RelationshipStateUpdatedEvent | HomeFeedUpdatedEvent;
 
+declare type HookEvent = z.infer<typeof HookEventSchema>;
+
+declare const HookEventSchema: z.ZodObject<{
+    type: z.ZodLiteral<"hook_event">;
+    conversationId: z.ZodOptional<z.ZodString>;
+    hookName: z.ZodString;
+    owner: z.ZodObject<{
+        kind: z.ZodEnum<{
+            plugin: "plugin";
+            workspace: "workspace";
+        }>;
+        id: z.ZodString;
+    }, z.core.$strip>;
+    detail: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$strip>;
+
 /**
  * A plugin lifecycle hook. Receives a per-lifecycle context shape and may
  * either mutate `ctx` in place (returning `void`) or return a *partial*
@@ -3460,7 +3476,7 @@ declare interface SensitiveOutputBinding {
 
 declare type SensitiveOutputKind = "invite_code";
 
-declare type ServerMessage = _ConversationsServerMessages | _MessagesServerMessages | _SurfacesServerMessages | _SkillsServerMessages | _AppsServerMessages | _IntegrationsServerMessages | _ComputerUseServerMessages | _ContactsServerMessages | _WorkItemsServerMessages | _SubagentsServerMessages | _DocumentsServerMessages | _DocumentCommentsServerMessages | _GuardianActionsServerMessages | _SyncInvalidationServerMessages | _HomeServerMessages | _HostAppControlServerMessages | _HostBashServerMessages | _HostBrowserServerMessages | _HostCuServerMessages | _HostFileServerMessages | _HostTransferServerMessages | _MemoryServerMessages | _WorkspaceServerMessages | _SchedulesServerMessages | _SettingsServerMessages | _DiagnosticsServerMessages | _InboxServerMessages | _NotificationsServerMessages | _UpgradesServerMessages | _AcpServerMessages | _BackgroundToolsServerMessages | _BookmarksServerMessages | _WorkflowsServerMessages | DiskPressureStatusChangedEvent | SubagentEvent;
+declare type ServerMessage = _ConversationsServerMessages | _MessagesServerMessages | _SurfacesServerMessages | _SkillsServerMessages | _AppsServerMessages | _IntegrationsServerMessages | _ComputerUseServerMessages | _ContactsServerMessages | _WorkItemsServerMessages | _SubagentsServerMessages | _DocumentsServerMessages | _DocumentCommentsServerMessages | _GuardianActionsServerMessages | _SyncInvalidationServerMessages | _HomeServerMessages | _HostAppControlServerMessages | _HostBashServerMessages | _HostBrowserServerMessages | _HostCuServerMessages | _HostFileServerMessages | _HostTransferServerMessages | _MemoryServerMessages | _WorkspaceServerMessages | _SchedulesServerMessages | _SettingsServerMessages | _DiagnosticsServerMessages | _InboxServerMessages | _NotificationsServerMessages | _UpgradesServerMessages | _AcpServerMessages | _BackgroundToolsServerMessages | _BookmarksServerMessages | _WorkflowsServerMessages | DiskPressureStatusChangedEvent | HookEvent | SubagentEvent;
 
 export declare interface ServerToolUseContent {
     type: "server_tool_use";
@@ -4938,6 +4954,19 @@ export declare interface UserPromptSubmitContext {
      * fields (e.g. `{ plugin: "<name>" }`) for attribution.
      */
     readonly logger: PluginLogger;
+    /**
+     * Emit a transient `hook_event` to any UI watching this conversation —
+     * e.g. progress while the hook does work the user can feel (memory
+     * selection). The daemon stamps the conversation, this hook's name, and
+     * the owning plugin; the hook supplies only `detail`, an arbitrary
+     * JSON-serializable record whose shape it and its client renderer agree on.
+     *
+     * Best-effort and fire-and-forget: it never blocks or fails the turn, is
+     * not persisted (a client joining mid-turn will not replay it), and cannot
+     * emit any other event type or target another conversation — the emit
+     * surface is bound to this turn.
+     */
+    readonly broadcast: (detail: Record<string, unknown>) => void;
 }
 
 declare interface VellumSlimSkill extends SlimSkillBase {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vellumai/plugin-api",
-  "version": "0.10.5-dev.202607031543.075941f",
+  "version": "0.10.5-dev.202607031636.61acd91",
   "description": "Public TypeScript authoring contract for Vellum assistant plugins.",
   "license": "MIT",
   "type": "module",