@vellumai/plugin-api 0.11.5 → 0.11.6-staging.1

package/index.d.ts

@@ -137,11 +137,13 @@ declare const AssistantConfigSchema: z.ZodObject<{
             provider: z.ZodDefault<z.ZodEnum<{
                 [x: string]: string;
             }>>;
+            apiBase: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>>;
         "web-fetch": z.ZodDefault<z.ZodObject<{
             provider: z.ZodDefault<z.ZodEnum<{
                 [x: string]: string;
             }>>;
+            apiBase: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>>;
         stt: z.ZodDefault<z.ZodObject<{
             provider: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodEnum<{
@@ -662,6 +664,7 @@ declare const AssistantConfigSchema: z.ZodObject<{
             label: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             description: z.ZodOptional<z.ZodString>;
             provider_connection: z.ZodOptional<z.ZodString>;
+            allowUnlisted: z.ZodOptional<z.ZodBoolean>;
             status: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
                 active: "active";
                 disabled: "disabled";
@@ -1331,9 +1334,9 @@ declare const AssistantEventEnvelopeSchema: z.ZodObject<{
         id: z.ZodString;
         conversationId: z.ZodString;
         status: z.ZodEnum<{
-            cancelled: "cancelled";
             completed: "completed";
             failed: "failed";
+            cancelled: "cancelled";
         }>;
         exitCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
         output: z.ZodOptional<z.ZodString>;
@@ -1672,8 +1675,8 @@ declare const AssistantEventEnvelopeSchema: z.ZodObject<{
         hookName: z.ZodString;
         owner: z.ZodObject<{
             kind: z.ZodEnum<{
-                workspace: "workspace";
                 plugin: "plugin";
+                workspace: "workspace";
             }>;
             id: z.ZodString;
         }, z.core.$strip>;
@@ -2266,6 +2269,7 @@ declare const AssistantEventEnvelopeSchema: z.ZodObject<{
                     tavily: "tavily";
                     keenable: "keenable";
                     firecrawl: "firecrawl";
+                    fastcrw: "fastcrw";
                 }>;
                 resultCount: z.ZodNumber;
                 durationMs: z.ZodNumber;
@@ -2287,6 +2291,7 @@ declare const AssistantEventEnvelopeSchema: z.ZodObject<{
                 provider: z.ZodOptional<z.ZodEnum<{
                     default: "default";
                     firecrawl: "firecrawl";
+                    fastcrw: "fastcrw";
                 }>>;
                 status: z.ZodNumber;
                 contentType: z.ZodOptional<z.ZodString>;
@@ -2427,6 +2432,11 @@ declare const AssistantEventEnvelopeSchema: z.ZodObject<{
         requestId: z.ZodOptional<z.ZodString>;
         clientMessageId: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"watch_retro_completed">;
+        sessionId: z.ZodString;
+        conversationId: z.ZodString;
+        reportReady: z.ZodBoolean;
+    }, z.core.$strip>, z.ZodObject<{
         type: z.ZodLiteral<"workflow_completed">;
         runId: z.ZodString;
         conversationId: z.ZodOptional<z.ZodString>;
@@ -2662,12 +2672,12 @@ declare const AssistantEventPublishOptionsSchema: z.ZodObject<{
     targetClientId: z.ZodOptional<z.ZodString>;
     targetInterfaceId: z.ZodOptional<z.ZodEnum<{
         phone: "phone";
-        a2a: "a2a";
-        whatsapp: "whatsapp";
-        discord: "discord";
         telegram: "telegram";
+        whatsapp: "whatsapp";
         slack: "slack";
         email: "email";
+        a2a: "a2a";
+        discord: "discord";
         plugin: "plugin";
         macos: "macos";
         windows: "windows";
@@ -2815,9 +2825,9 @@ declare const AssistantEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     id: z.ZodString;
     conversationId: z.ZodString;
     status: z.ZodEnum<{
-        cancelled: "cancelled";
         completed: "completed";
         failed: "failed";
+        cancelled: "cancelled";
     }>;
     exitCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     output: z.ZodOptional<z.ZodString>;
@@ -3156,8 +3166,8 @@ declare const AssistantEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     hookName: z.ZodString;
     owner: z.ZodObject<{
         kind: z.ZodEnum<{
-            workspace: "workspace";
             plugin: "plugin";
+            workspace: "workspace";
         }>;
         id: z.ZodString;
     }, z.core.$strip>;
@@ -3750,6 +3760,7 @@ declare const AssistantEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
                 tavily: "tavily";
                 keenable: "keenable";
                 firecrawl: "firecrawl";
+                fastcrw: "fastcrw";
             }>;
             resultCount: z.ZodNumber;
             durationMs: z.ZodNumber;
@@ -3771,6 +3782,7 @@ declare const AssistantEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
             provider: z.ZodOptional<z.ZodEnum<{
                 default: "default";
                 firecrawl: "firecrawl";
+                fastcrw: "fastcrw";
             }>>;
             status: z.ZodNumber;
             contentType: z.ZodOptional<z.ZodString>;
@@ -3911,6 +3923,11 @@ declare const AssistantEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     requestId: z.ZodOptional<z.ZodString>;
     clientMessageId: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"watch_retro_completed">;
+    sessionId: z.ZodString;
+    conversationId: z.ZodString;
+    reportReady: z.ZodBoolean;
+}, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"workflow_completed">;
     runId: z.ZodString;
     conversationId: z.ZodOptional<z.ZodString>;
@@ -4057,6 +4074,13 @@ declare interface BaseSubscriberEntry {
  */
 export declare function buildMessageExcerpt(rawContent: string, query: string): Promise<string>;
 
+/**
+ * Conversation-type axis within an adapter (the "channel-type" cascade
+ * level): direct message, private channel/group, public channel. Adapters
+ * map their native surfaces onto these three.
+ */
+declare const CHANNEL_CONVERSATION_TYPES: readonly ["dm", "private", "public"];
+
 /**
  * Canonical channel-id vocabulary shared between the assistant daemon and the
  * gateway.
@@ -4090,6 +4114,8 @@ export declare function buildMessageExcerpt(rawContent: string, query: string):
  */
 declare const CHANNEL_IDS: readonly ["telegram", "phone", "vellum", "whatsapp", "slack", "email", "platform", "a2a", "discord", "plugin"];
 
+declare type ChannelConversationType = (typeof CHANNEL_CONVERSATION_TYPES)[number];
+
 declare type ChannelId = (typeof CHANNEL_IDS)[number];
 
 export declare const CLI_COMMAND_HELP: readonly CliCommandHelp[];
@@ -4323,9 +4349,17 @@ export declare type ConversationsClearedContext = BaseHookContext;
 /** Read-side alias of {@link ConversationCreateType}. */
 declare type ConversationType = ConversationCreateType;
 
-/** Create a live voice connection bound to the caller's `send` transport. */
+/**
+ * Create a live voice connection bound to the caller's `send` transport.
+ *
+ * `close` is how the daemon hangs up. It is optional only because a transport
+ * may not be able to (an in-process pipe), but a real one should always pass
+ * it: without it, a session the daemon reclaims from an absent client leaves
+ * the transport open behind it.
+ */
 export declare function createLiveVoiceConnection(options: {
     send: LiveVoiceFrameSender;
+    close?: () => void;
 }): LiveVoiceConnection;
 
 /**
@@ -5064,7 +5098,7 @@ declare interface LiveVoiceServerFrameBase {
 
 declare type LiveVoiceServerFrameType = (typeof _LIVE_VOICE_SERVER_FRAME_TYPES)[number];
 
-export declare type LiveVoiceSessionCloseReason = "client_end" | "error" | "websocket_close" | "transport_closed" | "manager_shutdown";
+export declare type LiveVoiceSessionCloseReason = "client_end" | "error" | "websocket_close" | "transport_closed" | "client_timeout" | "forced_end" | "manager_shutdown";
 
 /**
  * Emitted when the server VAD detects user speech. The client MUST
@@ -5222,30 +5256,30 @@ declare const messageMetadataSchema: z.ZodObject<{
     sentAt: z.ZodOptional<z.ZodNumber>;
     userMessageChannel: z.ZodOptional<z.ZodEnum<{
         phone: "phone";
-        platform: "platform";
-        a2a: "a2a";
+        telegram: "telegram";
         vellum: "vellum";
         whatsapp: "whatsapp";
-        discord: "discord";
-        telegram: "telegram";
         slack: "slack";
         email: "email";
+        platform: "platform";
+        a2a: "a2a";
+        discord: "discord";
         plugin: "plugin";
     }>>;
     assistantMessageChannel: z.ZodOptional<z.ZodEnum<{
         phone: "phone";
-        platform: "platform";
-        a2a: "a2a";
+        telegram: "telegram";
         vellum: "vellum";
         whatsapp: "whatsapp";
-        discord: "discord";
-        telegram: "telegram";
         slack: "slack";
         email: "email";
+        platform: "platform";
+        a2a: "a2a";
+        discord: "discord";
         plugin: "plugin";
     }>>;
-    userMessageInterface: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<"phone" | "a2a" | "whatsapp" | "discord" | "telegram" | "slack" | "email" | "plugin" | "macos" | "windows" | "ios" | "cli" | "web" | "chrome-extension" | "route" | null, string>> & z.ZodType<"phone" | "a2a" | "whatsapp" | "discord" | "telegram" | "slack" | "email" | "plugin" | "macos" | "windows" | "ios" | "cli" | "web" | "chrome-extension" | "route", string, z.core.$ZodTypeInternals<"phone" | "a2a" | "whatsapp" | "discord" | "telegram" | "slack" | "email" | "plugin" | "macos" | "windows" | "ios" | "cli" | "web" | "chrome-extension" | "route", string>>>;
-    assistantMessageInterface: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<"phone" | "a2a" | "whatsapp" | "discord" | "telegram" | "slack" | "email" | "plugin" | "macos" | "windows" | "ios" | "cli" | "web" | "chrome-extension" | "route" | null, string>> & z.ZodType<"phone" | "a2a" | "whatsapp" | "discord" | "telegram" | "slack" | "email" | "plugin" | "macos" | "windows" | "ios" | "cli" | "web" | "chrome-extension" | "route", string, z.core.$ZodTypeInternals<"phone" | "a2a" | "whatsapp" | "discord" | "telegram" | "slack" | "email" | "plugin" | "macos" | "windows" | "ios" | "cli" | "web" | "chrome-extension" | "route", string>>>;
+    userMessageInterface: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<"phone" | "telegram" | "whatsapp" | "slack" | "email" | "a2a" | "discord" | "plugin" | "macos" | "windows" | "ios" | "cli" | "web" | "chrome-extension" | "route" | null, string>> & z.ZodType<"phone" | "telegram" | "whatsapp" | "slack" | "email" | "a2a" | "discord" | "plugin" | "macos" | "windows" | "ios" | "cli" | "web" | "chrome-extension" | "route", string, z.core.$ZodTypeInternals<"phone" | "telegram" | "whatsapp" | "slack" | "email" | "a2a" | "discord" | "plugin" | "macos" | "windows" | "ios" | "cli" | "web" | "chrome-extension" | "route", string>>>;
+    assistantMessageInterface: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<"phone" | "telegram" | "whatsapp" | "slack" | "email" | "a2a" | "discord" | "plugin" | "macos" | "windows" | "ios" | "cli" | "web" | "chrome-extension" | "route" | null, string>> & z.ZodType<"phone" | "telegram" | "whatsapp" | "slack" | "email" | "a2a" | "discord" | "plugin" | "macos" | "windows" | "ios" | "cli" | "web" | "chrome-extension" | "route", string, z.core.$ZodTypeInternals<"phone" | "telegram" | "whatsapp" | "slack" | "email" | "a2a" | "discord" | "plugin" | "macos" | "windows" | "ios" | "cli" | "web" | "chrome-extension" | "route", string>>>;
     client: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     clientOsFromRequest: z.ZodOptional<z.ZodBoolean>;
     subagentNotification: z.ZodOptional<z.ZodObject<{
@@ -5274,14 +5308,14 @@ declare const messageMetadataSchema: z.ZodObject<{
     model: z.ZodOptional<z.ZodString>;
     provenanceSourceChannel: z.ZodOptional<z.ZodEnum<{
         phone: "phone";
-        platform: "platform";
-        a2a: "a2a";
+        telegram: "telegram";
         vellum: "vellum";
         whatsapp: "whatsapp";
-        discord: "discord";
-        telegram: "telegram";
         slack: "slack";
         email: "email";
+        platform: "platform";
+        a2a: "a2a";
+        discord: "discord";
         plugin: "plugin";
     }>>;
     provenanceGuardianExternalUserId: z.ZodOptional<z.ZodString>;
@@ -5299,9 +5333,9 @@ declare const messageMetadataSchema: z.ZodObject<{
         command: z.ZodString;
         startedAt: z.ZodNumber;
         status: z.ZodEnum<{
-            cancelled: "cancelled";
             completed: "completed";
             failed: "failed";
+            cancelled: "cancelled";
         }>;
         exitCode: z.ZodNullable<z.ZodNumber>;
         output: z.ZodString;
@@ -7261,7 +7295,7 @@ export declare interface ToolContext {
      * resolution; undefined when the chat type is unknown or ambiguous.
      * @legacy
      */
-    channelConversationType?: "dm" | "private" | "public";
+    channelConversationType?: ChannelConversationType;
     /**
      * External channel/conversation ID of the current chat (the binding's
      * external chat id — Slack channel, Telegram chat, …). Keys the channel
@@ -7740,7 +7774,7 @@ declare interface WebFetchMetadata {
 }
 
 /** Provider that backed a `web_fetch` call. `default` is the built-in fetcher. */
-declare type WebFetchProviderId = "default" | "firecrawl";
+declare type WebFetchProviderId = "default" | "firecrawl" | "fastcrw";
 
 /**
  * Public URL resolution for a plugin's own ingress route.
@@ -7797,7 +7831,7 @@ declare interface WebSearchMetadata {
     errorMessage?: string;
 }
 
-declare type WebSearchProviderId = "anthropic-native" | "brave" | "perplexity" | "tavily" | "keenable" | "firecrawl";
+declare type WebSearchProviderId = "anthropic-native" | "brave" | "perplexity" | "tavily" | "keenable" | "firecrawl" | "fastcrw";
 
 declare interface WebSearchResultItem {
     rank: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vellumai/plugin-api",
-  "version": "0.11.5",
+  "version": "0.11.6-staging.1",
   "description": "Public TypeScript authoring contract for Vellum assistant plugins.",
   "license": "MIT",
   "type": "module",