@vellumai/plugin-api 0.11.3-dev.202608181811.60ef9e5 → 0.11.3-dev.202608182007.738dd45

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +67 -57
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -127,9 +127,9 @@ declare const AssistantConfigSchema: z.ZodObject<{
127
127
  inference: z.ZodDefault<z.ZodObject<{}, z.core.$strip>>;
128
128
  "image-generation": z.ZodDefault<z.ZodObject<{
129
129
  provider: z.ZodDefault<z.ZodEnum<{
130
+ vellum: "vellum";
130
131
  openai: "openai";
131
132
  gemini: "gemini";
132
- vellum: "vellum";
133
133
  }>>;
134
134
  model: z.ZodDefault<z.ZodString>;
135
135
  }, z.core.$strip>>;
@@ -601,9 +601,9 @@ declare const AssistantConfigSchema: z.ZodObject<{
601
601
  low: "low";
602
602
  medium: "medium";
603
603
  high: "high";
604
+ none: "none";
604
605
  xhigh: "xhigh";
605
606
  max: "max";
606
- none: "none";
607
607
  }>>;
608
608
  speed: z.ZodOptional<z.ZodEnum<{
609
609
  standard: "standard";
@@ -656,8 +656,8 @@ declare const AssistantConfigSchema: z.ZodObject<{
656
656
  }>>;
657
657
  disableCache: z.ZodOptional<z.ZodBoolean>;
658
658
  source: z.ZodOptional<z.ZodEnum<{
659
- managed: "managed";
660
659
  user: "user";
660
+ managed: "managed";
661
661
  }>>;
662
662
  label: z.ZodOptional<z.ZodNullable<z.ZodString>>;
663
663
  description: z.ZodOptional<z.ZodString>;
@@ -723,9 +723,9 @@ declare const AssistantConfigSchema: z.ZodObject<{
723
723
  low: "low";
724
724
  medium: "medium";
725
725
  high: "high";
726
+ none: "none";
726
727
  xhigh: "xhigh";
727
728
  max: "max";
728
- none: "none";
729
729
  }>>;
730
730
  speed: z.ZodOptional<z.ZodEnum<{
731
731
  standard: "standard";
@@ -1171,8 +1171,8 @@ declare const AssistantConfigSchema: z.ZodObject<{
1171
1171
  plugins: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
1172
1172
  pluginUpdates: z.ZodDefault<z.ZodObject<{
1173
1173
  mode: z.ZodDefault<z.ZodEnum<{
1174
- auto: "auto";
1175
1174
  manual: "manual";
1175
+ auto: "auto";
1176
1176
  }>>;
1177
1177
  strategy: z.ZodDefault<z.ZodEnum<{
1178
1178
  theirs: "theirs";
@@ -1240,12 +1240,12 @@ declare const AssistantEventEnvelopeSchema: z.ZodObject<{
1240
1240
  type: z.ZodLiteral<"acp_session_update">;
1241
1241
  acpSessionId: z.ZodString;
1242
1242
  updateType: z.ZodEnum<{
1243
+ plan: "plan";
1243
1244
  agent_message_chunk: "agent_message_chunk";
1244
1245
  agent_thought_chunk: "agent_thought_chunk";
1245
1246
  user_message_chunk: "user_message_chunk";
1246
1247
  tool_call: "tool_call";
1247
1248
  tool_call_update: "tool_call_update";
1248
- plan: "plan";
1249
1249
  }>;
1250
1250
  content: z.ZodOptional<z.ZodString>;
1251
1251
  toolCallId: z.ZodOptional<z.ZodString>;
@@ -1331,8 +1331,8 @@ declare const AssistantEventEnvelopeSchema: z.ZodObject<{
1331
1331
  id: z.ZodString;
1332
1332
  conversationId: z.ZodString;
1333
1333
  status: z.ZodEnum<{
1334
- completed: "completed";
1335
1334
  cancelled: "cancelled";
1335
+ completed: "completed";
1336
1336
  failed: "failed";
1337
1337
  }>;
1338
1338
  exitCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
@@ -1424,18 +1424,18 @@ declare const AssistantEventEnvelopeSchema: z.ZodObject<{
1424
1424
  conversationId: z.ZodString;
1425
1425
  requestId: z.ZodString;
1426
1426
  state: z.ZodEnum<{
1427
- timed_out: "timed_out";
1428
1427
  pending: "pending";
1429
1428
  approved: "approved";
1430
1429
  denied: "denied";
1430
+ timed_out: "timed_out";
1431
1431
  resolved_stale: "resolved_stale";
1432
1432
  }>;
1433
1433
  source: z.ZodEnum<{
1434
+ timeout: "timeout";
1434
1435
  system: "system";
1435
1436
  button: "button";
1436
1437
  inline_nl: "inline_nl";
1437
1438
  auto_deny: "auto_deny";
1438
- timeout: "timeout";
1439
1439
  }>;
1440
1440
  causedByRequestId: z.ZodOptional<z.ZodString>;
1441
1441
  decisionText: z.ZodOptional<z.ZodString>;
@@ -1510,9 +1510,9 @@ declare const AssistantEventEnvelopeSchema: z.ZodObject<{
1510
1510
  }, z.core.$strip>, z.ZodObject<{
1511
1511
  type: z.ZodLiteral<"conversation_list_invalidated">;
1512
1512
  reason: z.ZodEnum<{
1513
+ deleted: "deleted";
1513
1514
  created: "created";
1514
1515
  renamed: "renamed";
1515
- deleted: "deleted";
1516
1516
  reordered: "reordered";
1517
1517
  seen_changed: "seen_changed";
1518
1518
  }>;
@@ -1555,9 +1555,9 @@ declare const AssistantEventEnvelopeSchema: z.ZodObject<{
1555
1555
  enabled: z.ZodBoolean;
1556
1556
  state: z.ZodEnum<{
1557
1557
  unknown: "unknown";
1558
+ ok: "ok";
1558
1559
  disabled: "disabled";
1559
1560
  critical: "critical";
1560
- ok: "ok";
1561
1561
  warning: "warning";
1562
1562
  }>;
1563
1563
  locked: z.ZodBoolean;
@@ -1672,8 +1672,8 @@ declare const AssistantEventEnvelopeSchema: z.ZodObject<{
1672
1672
  hookName: z.ZodString;
1673
1673
  owner: z.ZodObject<{
1674
1674
  kind: z.ZodEnum<{
1675
- plugin: "plugin";
1676
1675
  workspace: "workspace";
1676
+ plugin: "plugin";
1677
1677
  }>;
1678
1678
  id: z.ZodString;
1679
1679
  }, z.core.$strip>;
@@ -1865,9 +1865,9 @@ declare const AssistantEventEnvelopeSchema: z.ZodObject<{
1865
1865
  requestId: z.ZodString;
1866
1866
  conversationId: z.ZodString;
1867
1867
  state: z.ZodEnum<{
1868
+ approved: "approved";
1868
1869
  cancelled: "cancelled";
1869
1870
  superseded: "superseded";
1870
- approved: "approved";
1871
1871
  rejected: "rejected";
1872
1872
  answered: "answered";
1873
1873
  }>;
@@ -2160,9 +2160,9 @@ declare const AssistantEventEnvelopeSchema: z.ZodObject<{
2160
2160
  type: z.ZodLiteral<"subagent_status_changed">;
2161
2161
  subagentId: z.ZodString;
2162
2162
  status: z.ZodEnum<{
2163
+ pending: "pending";
2163
2164
  completed: "completed";
2164
2165
  failed: "failed";
2165
- pending: "pending";
2166
2166
  running: "running";
2167
2167
  awaiting_input: "awaiting_input";
2168
2168
  aborted: "aborted";
@@ -2636,14 +2636,14 @@ declare const AssistantEventPublishOptionsSchema: z.ZodObject<{
2636
2636
  }>>;
2637
2637
  targetClientId: z.ZodOptional<z.ZodString>;
2638
2638
  targetInterfaceId: z.ZodOptional<z.ZodEnum<{
2639
- plugin: "plugin";
2640
- telegram: "telegram";
2641
2639
  phone: "phone";
2640
+ a2a: "a2a";
2642
2641
  whatsapp: "whatsapp";
2642
+ discord: "discord";
2643
+ telegram: "telegram";
2643
2644
  slack: "slack";
2644
2645
  email: "email";
2645
- a2a: "a2a";
2646
- discord: "discord";
2646
+ plugin: "plugin";
2647
2647
  macos: "macos";
2648
2648
  ios: "ios";
2649
2649
  cli: "cli";
@@ -2698,12 +2698,12 @@ declare const AssistantEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
2698
2698
  type: z.ZodLiteral<"acp_session_update">;
2699
2699
  acpSessionId: z.ZodString;
2700
2700
  updateType: z.ZodEnum<{
2701
+ plan: "plan";
2701
2702
  agent_message_chunk: "agent_message_chunk";
2702
2703
  agent_thought_chunk: "agent_thought_chunk";
2703
2704
  user_message_chunk: "user_message_chunk";
2704
2705
  tool_call: "tool_call";
2705
2706
  tool_call_update: "tool_call_update";
2706
- plan: "plan";
2707
2707
  }>;
2708
2708
  content: z.ZodOptional<z.ZodString>;
2709
2709
  toolCallId: z.ZodOptional<z.ZodString>;
@@ -2789,8 +2789,8 @@ declare const AssistantEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
2789
2789
  id: z.ZodString;
2790
2790
  conversationId: z.ZodString;
2791
2791
  status: z.ZodEnum<{
2792
- completed: "completed";
2793
2792
  cancelled: "cancelled";
2793
+ completed: "completed";
2794
2794
  failed: "failed";
2795
2795
  }>;
2796
2796
  exitCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
@@ -2882,18 +2882,18 @@ declare const AssistantEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
2882
2882
  conversationId: z.ZodString;
2883
2883
  requestId: z.ZodString;
2884
2884
  state: z.ZodEnum<{
2885
- timed_out: "timed_out";
2886
2885
  pending: "pending";
2887
2886
  approved: "approved";
2888
2887
  denied: "denied";
2888
+ timed_out: "timed_out";
2889
2889
  resolved_stale: "resolved_stale";
2890
2890
  }>;
2891
2891
  source: z.ZodEnum<{
2892
+ timeout: "timeout";
2892
2893
  system: "system";
2893
2894
  button: "button";
2894
2895
  inline_nl: "inline_nl";
2895
2896
  auto_deny: "auto_deny";
2896
- timeout: "timeout";
2897
2897
  }>;
2898
2898
  causedByRequestId: z.ZodOptional<z.ZodString>;
2899
2899
  decisionText: z.ZodOptional<z.ZodString>;
@@ -2968,9 +2968,9 @@ declare const AssistantEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
2968
2968
  }, z.core.$strip>, z.ZodObject<{
2969
2969
  type: z.ZodLiteral<"conversation_list_invalidated">;
2970
2970
  reason: z.ZodEnum<{
2971
+ deleted: "deleted";
2971
2972
  created: "created";
2972
2973
  renamed: "renamed";
2973
- deleted: "deleted";
2974
2974
  reordered: "reordered";
2975
2975
  seen_changed: "seen_changed";
2976
2976
  }>;
@@ -3013,9 +3013,9 @@ declare const AssistantEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
3013
3013
  enabled: z.ZodBoolean;
3014
3014
  state: z.ZodEnum<{
3015
3015
  unknown: "unknown";
3016
+ ok: "ok";
3016
3017
  disabled: "disabled";
3017
3018
  critical: "critical";
3018
- ok: "ok";
3019
3019
  warning: "warning";
3020
3020
  }>;
3021
3021
  locked: z.ZodBoolean;
@@ -3130,8 +3130,8 @@ declare const AssistantEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
3130
3130
  hookName: z.ZodString;
3131
3131
  owner: z.ZodObject<{
3132
3132
  kind: z.ZodEnum<{
3133
- plugin: "plugin";
3134
3133
  workspace: "workspace";
3134
+ plugin: "plugin";
3135
3135
  }>;
3136
3136
  id: z.ZodString;
3137
3137
  }, z.core.$strip>;
@@ -3323,9 +3323,9 @@ declare const AssistantEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
3323
3323
  requestId: z.ZodString;
3324
3324
  conversationId: z.ZodString;
3325
3325
  state: z.ZodEnum<{
3326
+ approved: "approved";
3326
3327
  cancelled: "cancelled";
3327
3328
  superseded: "superseded";
3328
- approved: "approved";
3329
3329
  rejected: "rejected";
3330
3330
  answered: "answered";
3331
3331
  }>;
@@ -3618,9 +3618,9 @@ declare const AssistantEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
3618
3618
  type: z.ZodLiteral<"subagent_status_changed">;
3619
3619
  subagentId: z.ZodString;
3620
3620
  status: z.ZodEnum<{
3621
+ pending: "pending";
3621
3622
  completed: "completed";
3622
3623
  failed: "failed";
3623
- pending: "pending";
3624
3624
  running: "running";
3625
3625
  awaiting_input: "awaiting_input";
3626
3626
  aborted: "aborted";
@@ -5122,31 +5122,31 @@ declare type MessageMetadata_2 = z.infer<typeof messageMetadataSchema>;
5122
5122
 
5123
5123
  declare const messageMetadataSchema: z.ZodObject<{
5124
5124
  userMessageChannel: z.ZodOptional<z.ZodEnum<{
5125
- plugin: "plugin";
5126
- vellum: "vellum";
5127
- platform: "platform";
5128
- telegram: "telegram";
5129
5125
  phone: "phone";
5126
+ platform: "platform";
5127
+ a2a: "a2a";
5128
+ vellum: "vellum";
5130
5129
  whatsapp: "whatsapp";
5130
+ discord: "discord";
5131
+ telegram: "telegram";
5131
5132
  slack: "slack";
5132
5133
  email: "email";
5133
- a2a: "a2a";
5134
- discord: "discord";
5134
+ plugin: "plugin";
5135
5135
  }>>;
5136
5136
  assistantMessageChannel: z.ZodOptional<z.ZodEnum<{
5137
- plugin: "plugin";
5138
- vellum: "vellum";
5139
- platform: "platform";
5140
- telegram: "telegram";
5141
5137
  phone: "phone";
5138
+ platform: "platform";
5139
+ a2a: "a2a";
5140
+ vellum: "vellum";
5142
5141
  whatsapp: "whatsapp";
5142
+ discord: "discord";
5143
+ telegram: "telegram";
5143
5144
  slack: "slack";
5144
5145
  email: "email";
5145
- a2a: "a2a";
5146
- discord: "discord";
5146
+ plugin: "plugin";
5147
5147
  }>>;
5148
- userMessageInterface: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<"plugin" | "telegram" | "phone" | "whatsapp" | "slack" | "email" | "a2a" | "discord" | "macos" | "ios" | "cli" | "web" | "chrome-extension" | "route" | null, string>> & z.ZodType<"plugin" | "telegram" | "phone" | "whatsapp" | "slack" | "email" | "a2a" | "discord" | "macos" | "ios" | "cli" | "web" | "chrome-extension" | "route", string, z.core.$ZodTypeInternals<"plugin" | "telegram" | "phone" | "whatsapp" | "slack" | "email" | "a2a" | "discord" | "macos" | "ios" | "cli" | "web" | "chrome-extension" | "route", string>>>;
5149
- assistantMessageInterface: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<"plugin" | "telegram" | "phone" | "whatsapp" | "slack" | "email" | "a2a" | "discord" | "macos" | "ios" | "cli" | "web" | "chrome-extension" | "route" | null, string>> & z.ZodType<"plugin" | "telegram" | "phone" | "whatsapp" | "slack" | "email" | "a2a" | "discord" | "macos" | "ios" | "cli" | "web" | "chrome-extension" | "route", string, z.core.$ZodTypeInternals<"plugin" | "telegram" | "phone" | "whatsapp" | "slack" | "email" | "a2a" | "discord" | "macos" | "ios" | "cli" | "web" | "chrome-extension" | "route", string>>>;
5148
+ userMessageInterface: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<"phone" | "a2a" | "whatsapp" | "discord" | "telegram" | "slack" | "email" | "plugin" | "macos" | "ios" | "cli" | "web" | "chrome-extension" | "route" | null, string>> & z.ZodType<"phone" | "a2a" | "whatsapp" | "discord" | "telegram" | "slack" | "email" | "plugin" | "macos" | "ios" | "cli" | "web" | "chrome-extension" | "route", string, z.core.$ZodTypeInternals<"phone" | "a2a" | "whatsapp" | "discord" | "telegram" | "slack" | "email" | "plugin" | "macos" | "ios" | "cli" | "web" | "chrome-extension" | "route", string>>>;
5149
+ assistantMessageInterface: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<"phone" | "a2a" | "whatsapp" | "discord" | "telegram" | "slack" | "email" | "plugin" | "macos" | "ios" | "cli" | "web" | "chrome-extension" | "route" | null, string>> & z.ZodType<"phone" | "a2a" | "whatsapp" | "discord" | "telegram" | "slack" | "email" | "plugin" | "macos" | "ios" | "cli" | "web" | "chrome-extension" | "route", string, z.core.$ZodTypeInternals<"phone" | "a2a" | "whatsapp" | "discord" | "telegram" | "slack" | "email" | "plugin" | "macos" | "ios" | "cli" | "web" | "chrome-extension" | "route", string>>>;
5150
5150
  client: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
5151
5151
  clientOsFromRequest: z.ZodOptional<z.ZodBoolean>;
5152
5152
  subagentNotification: z.ZodOptional<z.ZodObject<{
@@ -5174,16 +5174,16 @@ declare const messageMetadataSchema: z.ZodObject<{
5174
5174
  }>>;
5175
5175
  model: z.ZodOptional<z.ZodString>;
5176
5176
  provenanceSourceChannel: z.ZodOptional<z.ZodEnum<{
5177
- plugin: "plugin";
5178
- vellum: "vellum";
5179
- platform: "platform";
5180
- telegram: "telegram";
5181
5177
  phone: "phone";
5178
+ platform: "platform";
5179
+ a2a: "a2a";
5180
+ vellum: "vellum";
5182
5181
  whatsapp: "whatsapp";
5182
+ discord: "discord";
5183
+ telegram: "telegram";
5183
5184
  slack: "slack";
5184
5185
  email: "email";
5185
- a2a: "a2a";
5186
- discord: "discord";
5186
+ plugin: "plugin";
5187
5187
  }>>;
5188
5188
  provenanceGuardianExternalUserId: z.ZodOptional<z.ZodString>;
5189
5189
  provenanceRequesterIdentifier: z.ZodOptional<z.ZodString>;
@@ -5200,8 +5200,8 @@ declare const messageMetadataSchema: z.ZodObject<{
5200
5200
  command: z.ZodString;
5201
5201
  startedAt: z.ZodNumber;
5202
5202
  status: z.ZodEnum<{
5203
- completed: "completed";
5204
5203
  cancelled: "cancelled";
5204
+ completed: "completed";
5205
5205
  failed: "failed";
5206
5206
  }>;
5207
5207
  exitCode: z.ZodNullable<z.ZodNumber>;
@@ -6083,6 +6083,23 @@ export declare function resolveUserName(workspaceDir: string): string | null;
6083
6083
  */
6084
6084
  export declare function resolveWebhookUrl(options: WebhookUrlOptions): Promise<string>;
6085
6085
 
6086
+ declare type RiskAllowlistOption = z.infer<typeof RiskAllowlistOptionSchema>;
6087
+
6088
+ /** Minimatch ladder for the "always allow" prompt option (what a rule matches). */
6089
+ declare const RiskAllowlistOptionSchema: z.ZodObject<{
6090
+ label: z.ZodString;
6091
+ description: z.ZodString;
6092
+ pattern: z.ZodString;
6093
+ }, z.core.$strip>;
6094
+
6095
+ declare type RiskDirectoryScopeOption = z.infer<typeof RiskDirectoryScopeOptionSchema>;
6096
+
6097
+ /** Directory ladder for filesystem operations; `scope` is a path glob or `everywhere`. */
6098
+ declare const RiskDirectoryScopeOptionSchema: z.ZodObject<{
6099
+ scope: z.ZodString;
6100
+ label: z.ZodString;
6101
+ }, z.core.$strip>;
6102
+
6086
6103
  export declare enum RiskLevel {
6087
6104
  Low = "low",
6088
6105
  Medium = "medium",
@@ -7288,16 +7305,9 @@ export declare interface ToolExecutionResult {
7288
7305
  * wildcards) — what the gateway actually matches against. Mirrors
7289
7306
  * the `allowlistOptions` field on `ConfirmationRequest` SSE events.
7290
7307
  */
7291
- riskAllowlistOptions?: Array<{
7292
- label: string;
7293
- description: string;
7294
- pattern: string;
7295
- }>;
7308
+ riskAllowlistOptions?: RiskAllowlistOption[];
7296
7309
  /** Directory scope ladder for the rule editor (narrowest to broadest). */
7297
- riskDirectoryScopeOptions?: Array<{
7298
- scope: string;
7299
- label: string;
7300
- }>;
7310
+ riskDirectoryScopeOptions?: RiskDirectoryScopeOption[];
7301
7311
  /** Structured activity metadata for client rendering (web search, web fetch, etc).
7302
7312
  * Populated by daemon-internal tools; plugins must not set this. */
7303
7313
  activityMetadata?: ToolActivityMetadata;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vellumai/plugin-api",
3
- "version": "0.11.3-dev.202608181811.60ef9e5",
3
+ "version": "0.11.3-dev.202608182007.738dd45",
4
4
  "description": "Public TypeScript authoring contract for Vellum assistant plugins.",
5
5
  "license": "MIT",
6
6
  "type": "module",