@vellumai/plugin-api 0.10.0 → 0.10.1-dev.202606240317.ea25efe

package/index.d.ts

@@ -561,19 +561,19 @@ declare interface BundleAppResponse {
     };
 }
 
-declare interface CardSurfaceData {
-    title: string;
-    subtitle?: string;
-    body: string;
-    metadata?: Array<{
-        label: string;
-        value: string;
-    }>;
-    /** Optional template name for specialized rendering (e.g. "weather_forecast"). */
-    template?: string;
-    /** Arbitrary data consumed by the template renderer. Shape depends on template. */
-    templateData?: Record<string, unknown>;
-}
+declare type CardSurfaceData = z.infer<typeof CardSurfaceDataSchema>;
+
+declare const CardSurfaceDataSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    subtitle: z.ZodOptional<z.ZodString>;
+    body: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        label: z.ZodCoercedString<unknown>;
+        value: z.ZodCoercedString<unknown>;
+    }, z.core.$strip>>>;
+    template: z.ZodOptional<z.ZodString>;
+    templateData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
 
 declare const CHANNEL_IDS: readonly ["telegram", "phone", "vellum", "whatsapp", "slack", "email", "platform", "a2a"];
 
@@ -1244,6 +1244,15 @@ declare interface DocumentSaveResponse {
 
 declare type _DocumentsServerMessages = DocumentEditorShow | DocumentEditorUpdateEvent | DocumentSaveResponse | DocumentLoadResponse | DocumentListResponse;
 
+/**
+ * Whether the given model or profile can process image input.
+ *
+ * `modelOrProfile` may be a concrete model id, a profile key, or a
+ * {@link ModelProfileInfo}. A bare string is resolved as a model id first and,
+ * failing that, as a profile key. Returns `false` when nothing resolves.
+ */
+export declare function doesSupportVision(modelOrProfile: ModelProfileInfo | string): boolean;
+
 declare interface DynamicPagePreview {
     title: string;
     subtitle?: string;
@@ -1485,7 +1494,9 @@ export declare function getConfiguredProvider(callSite: LLMCallSite, opts?: {
 /**
  * List the workspace inference profiles a plugin can route to, in the order the
  * `/model` picker presents them (`llm.profileOrder` first, then the rest
- * alphabetically). Disabled profiles are included and flagged via
+ * alphabetically). Metadata-only entries without a provider, model, or mix are
+ * not routing targets, so plugins never see them. Disabled profiles are
+ * included and flagged via
  * {@link ModelProfileInfo.isDisabled}; weighted "mix" profiles are included and
  * flagged via {@link ModelProfileInfo.isMix}, since a mix is itself a valid
  * routing target (it resolves to one constituent per conversation).
@@ -1495,12 +1506,6 @@ export declare function getConfiguredProvider(callSite: LLMCallSite, opts?: {
  */
 export declare function getModelProfiles(): ModelProfileInfo[];
 
-/**
- * Retrieve a secret from secure storage. Convenience wrapper over
- * `getSecureKeyResultAsync` that returns only the value.
- */
-export declare function getSecureKeyAsync(account: string): Promise<string | undefined>;
-
 declare interface GetSigningIdentityRequest {
     type: "get_signing_identity";
     requestId: string;
@@ -1535,11 +1540,9 @@ declare interface GuardianDecisionAction {
 }
 
 /**
- * Shared types for the guardian decision primitive.
- *
- * All decision entrypoints (callback buttons, conversational engine, legacy
- * parser, requester self-cancel) use these types to route through the
- * unified `applyGuardianDecision` primitive.
+ * Shared types and render helpers for guardian decision prompts: the prompt
+ * model shown to guardians, the canonical action constants, and the
+ * legend/fallback builders used to present them on rich and plain-text channels.
  */
 /** Structured model for prompts shown to guardians. */
 declare interface GuardianDecisionPrompt {
@@ -2185,6 +2188,7 @@ declare const LLMCallSiteEnum: z.ZodEnum<{
     meetChatOpportunity: "meetChatOpportunity";
     inference: "inference";
     advisor: "advisor";
+    vision: "vision";
     trustRuleSuggestion: "trustRuleSuggestion";
     homeGreeting: "homeGreeting";
     homeSuggestedPrompts: "homeSuggestedPrompts";
@@ -2447,7 +2451,7 @@ declare const MessageRequestCompleteEventSchema: z.ZodObject<{
     runStillActive: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 
-declare type _MessagesServerMessages = UserMessageEchoEvent | AssistantTurnStartEvent | AssistantTextDeltaEvent | AssistantThinkingDeltaEvent | ToolUseStartEvent | ToolUsePreviewStartEvent | ToolOutputChunkEvent | ToolInputDelta | ToolResultEvent | ConfirmationRequestEvent | SecretRequestEvent | QuestionRequestEvent | MessageCompleteEvent | ErrorEvent_2 | MessageQueuedEvent | MessageDequeuedEvent | MessageRequestCompleteEvent | MessageQueuedDeletedEvent | MessageSteered | SuggestionResponse | TraceEvent | ConfirmationStateChanged | AssistantActivityStateEvent | TurnProfileAutoRoutedEvent | ConversationInferenceProfileUpdated | InteractionResolvedEvent;
+declare type _MessagesServerMessages = UserMessageEchoEvent | AssistantTurnStartEvent | AssistantTextDeltaEvent | AssistantThinkingDeltaEvent | ToolUseStartEvent | ToolUsePreviewStartEvent | ToolOutputChunkEvent | ToolInputDelta | ToolResultEvent | ConfirmationRequestEvent | SecretRequestEvent | QuestionRequestEvent | MessageCompleteEvent | ErrorEvent_2 | MessageQueuedEvent | MessageDequeuedEvent | MessageRequestCompleteEvent | MessageQueuedDeletedEvent | MessageSteered | SuggestionResponse | TraceEvent | ConfirmationStateChanged | AssistantActivityStateEvent | ConversationInferenceProfileUpdated | InteractionResolvedEvent;
 
 declare interface MessageSteered {
     type: "message_steered";
@@ -3045,7 +3049,28 @@ export declare interface Provider {
      * Falls back to `name` when unset.
      */
     tokenEstimationProvider?: string;
+    /**
+     * True when this provider instance was constructed to run web search
+     * server-side (provider-native). The native search only activates when a
+     * `web_search`-named tool is passed in the request, so callers that want to
+     * enable web search on a one-shot completion (e.g. the advisor consult) check
+     * this first — passing the tool to a non-native instance would surface an
+     * unexecutable client tool call. Absent/false on providers without it.
+     */
+    supportsNativeWebSearch?: boolean;
     sendMessage(messages: Message[], options?: SendMessageOptions): Promise<ProviderResponse>;
+    /**
+     * Exact prompt-token count from the provider's own tokenizer, for the
+     * `messages` + `systemPrompt` + `tools` composition the next call would
+     * send. Optional: providers without a token-counting endpoint omit it, and
+     * callers must fall back to the local estimator (`estimatePromptTokens`).
+     *
+     * This runs a dedicated counting request (no inference), so it carries a
+     * network round-trip and the provider's own rate limit — use it for
+     * user-initiated, occasional actions (e.g. `/compact`), never on the
+     * per-turn hot path.
+     */
+    countInputTokens?(messages: Message[], systemPrompt: string, tools?: ToolDefinition_2[]): Promise<number>;
 }
 
 export declare type ProviderEvent = {
@@ -4000,6 +4025,7 @@ declare const ToolDefinitionSchema: z.ZodObject<{
         host: "host";
     }>>;
     execute: z.ZodOptional<z.ZodCustom<(input: Record<string, unknown>, context: ToolContext) => Promise<ToolExecutionResult>, (input: Record<string, unknown>, context: ToolContext) => Promise<ToolExecutionResult>>>;
+    exclusive: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 
 /**
@@ -4442,15 +4468,6 @@ declare const TraceEventSchema: z.ZodObject<{
  */
 declare type TrustClass = "guardian" | "trusted_contact" | "unverified_contact" | "unknown";
 
-declare type TurnProfileAutoRoutedEvent = z.infer<typeof TurnProfileAutoRoutedEventSchema>;
-
-declare const TurnProfileAutoRoutedEventSchema: z.ZodObject<{
-    type: z.ZodLiteral<"turn_profile_auto_routed">;
-    conversationId: z.ZodString;
-    profile: z.ZodString;
-    profileLabel: z.ZodString;
-}, z.core.$strip>;
-
 declare interface UiSurfaceComplete {
     type: "ui_surface_complete";
     conversationId: string;

package/index.js

@@ -3,6 +3,6 @@ const api = globalThis[Symbol.for("vellum.plugin-api")] ?? {};
 export const HOOKS = api.HOOKS;
 export const RiskLevel = api.RiskLevel;
 export const assistantEventHub = api.assistantEventHub;
+export const doesSupportVision = api.doesSupportVision;
 export const getConfiguredProvider = api.getConfiguredProvider;
 export const getModelProfiles = api.getModelProfiles;
-export const getSecureKeyAsync = api.getSecureKeyAsync;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vellumai/plugin-api",
-  "version": "0.10.0",
+  "version": "0.10.1-dev.202606240317.ea25efe",
   "description": "Public TypeScript authoring contract for Vellum assistant plugins.",
   "license": "MIT",
   "type": "module",