@vellumai/plugin-api 0.10.2-dev.202606242234.c9e9e1d → 0.10.2-dev.202606250106.466483e
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.
- package/index.d.ts +64 -7
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -575,6 +575,27 @@ declare const CardSurfaceDataSchema: z.ZodObject<{
|
|
|
575
575
|
templateData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
576
576
|
}, z.core.$strip>;
|
|
577
577
|
|
|
578
|
+
/**
|
|
579
|
+
* Canonical channel-id vocabulary shared between the assistant daemon and the
|
|
580
|
+
* gateway.
|
|
581
|
+
*
|
|
582
|
+
* A "channel" is an external messaging surface an actor can reach the
|
|
583
|
+
* assistant through (Slack, Telegram, WhatsApp, phone, …) plus a couple of
|
|
584
|
+
* internal ids (`vellum` for native app conversations, `platform` for the
|
|
585
|
+
* internal control plane). This is the single source of truth for that set:
|
|
586
|
+
* the assistant adopts it wholesale as its `ChannelId`, and the gateway
|
|
587
|
+
* asserts its own (narrower) inbound list is a subset of it so the two sides
|
|
588
|
+
* cannot silently drift.
|
|
589
|
+
*
|
|
590
|
+
* Both packages depend on `@vellumai/service-contracts`, so hoisting the set
|
|
591
|
+
* here (rather than maintaining a copy on each side) means adding or renaming
|
|
592
|
+
* a channel happens in exactly one place.
|
|
593
|
+
*
|
|
594
|
+
* Note that a consumer may legitimately handle only a *subset* of these — the
|
|
595
|
+
* gateway, for example, never ingresses `platform`. Use a local list guarded
|
|
596
|
+
* by `satisfies readonly ChannelId[]` for those cases rather than redefining
|
|
597
|
+
* the union.
|
|
598
|
+
*/
|
|
578
599
|
declare const CHANNEL_IDS: readonly ["telegram", "phone", "vellum", "whatsapp", "slack", "email", "platform", "a2a"];
|
|
579
600
|
|
|
580
601
|
/** Channel binding metadata exposed in conversation list APIs. */
|
|
@@ -1035,6 +1056,40 @@ declare interface ConversationListResponse {
|
|
|
1035
1056
|
hasMore?: boolean;
|
|
1036
1057
|
}
|
|
1037
1058
|
|
|
1059
|
+
declare type ConversationNoticeEvent = z.infer<typeof ConversationNoticeEventSchema>;
|
|
1060
|
+
|
|
1061
|
+
declare const ConversationNoticeEventSchema: z.ZodObject<{
|
|
1062
|
+
type: z.ZodLiteral<"conversation_notice">;
|
|
1063
|
+
conversationId: z.ZodString;
|
|
1064
|
+
source: z.ZodEnum<{
|
|
1065
|
+
memory_v3: "memory_v3";
|
|
1066
|
+
}>;
|
|
1067
|
+
code: z.ZodEnum<{
|
|
1068
|
+
PROVIDER_NETWORK: "PROVIDER_NETWORK";
|
|
1069
|
+
PROVIDER_RATE_LIMIT: "PROVIDER_RATE_LIMIT";
|
|
1070
|
+
MANAGED_USAGE_LIMIT: "MANAGED_USAGE_LIMIT";
|
|
1071
|
+
PROVIDER_OVERLOADED: "PROVIDER_OVERLOADED";
|
|
1072
|
+
PROVIDER_API: "PROVIDER_API";
|
|
1073
|
+
IMAGE_TOO_LARGE: "IMAGE_TOO_LARGE";
|
|
1074
|
+
PROVIDER_BILLING: "PROVIDER_BILLING";
|
|
1075
|
+
PROVIDER_ORDERING: "PROVIDER_ORDERING";
|
|
1076
|
+
PROVIDER_WEB_SEARCH: "PROVIDER_WEB_SEARCH";
|
|
1077
|
+
PROVIDER_NOT_CONFIGURED: "PROVIDER_NOT_CONFIGURED";
|
|
1078
|
+
PROVIDER_INVALID_KEY: "PROVIDER_INVALID_KEY";
|
|
1079
|
+
MANAGED_KEY_INVALID: "MANAGED_KEY_INVALID";
|
|
1080
|
+
CONTEXT_TOO_LARGE: "CONTEXT_TOO_LARGE";
|
|
1081
|
+
BUDGET_YIELD_UNRECOVERED: "BUDGET_YIELD_UNRECOVERED";
|
|
1082
|
+
MAX_TOKENS_REACHED: "MAX_TOKENS_REACHED";
|
|
1083
|
+
CONVERSATION_ABORTED: "CONVERSATION_ABORTED";
|
|
1084
|
+
CONVERSATION_PROCESSING_FAILED: "CONVERSATION_PROCESSING_FAILED";
|
|
1085
|
+
DISK_SPACE_CRITICAL: "DISK_SPACE_CRITICAL";
|
|
1086
|
+
REGENERATE_FAILED: "REGENERATE_FAILED";
|
|
1087
|
+
UNKNOWN: "UNKNOWN";
|
|
1088
|
+
}>;
|
|
1089
|
+
userMessage: z.ZodString;
|
|
1090
|
+
errorCategory: z.ZodOptional<z.ZodString>;
|
|
1091
|
+
}, z.core.$strip>;
|
|
1092
|
+
|
|
1038
1093
|
declare interface ConversationsClearResponse {
|
|
1039
1094
|
type: "conversations_clear_response";
|
|
1040
1095
|
cleared: number;
|
|
@@ -1061,7 +1116,7 @@ declare interface ConversationSearchResultItem {
|
|
|
1061
1116
|
matchingMessages: ConversationSearchMatchingMessage[];
|
|
1062
1117
|
}
|
|
1063
1118
|
|
|
1064
|
-
declare type _ConversationsServerMessages = AuthResult | PongMessage | AssistantStatusMessage | GenerationCancelledEvent | GenerationHandoffEvent | ModelInfo | HistoryResponse | UndoComplete | UsageUpdateEvent | UsageProgressEvent | UsageResponse | ContextCompacted | CompactionCircuitOpenEvent | CompactionCircuitClosedEvent | ConversationErrorEvent | ConversationInfo | ConversationTitleUpdatedEvent | ConversationListResponse | ConversationsClearResponse | ConversationSearchResponse | MessageContentResponse | ConversationListInvalidatedEvent | ScheduleConversationCreated | OpenConversation;
|
|
1119
|
+
declare type _ConversationsServerMessages = AuthResult | PongMessage | AssistantStatusMessage | GenerationCancelledEvent | GenerationHandoffEvent | ModelInfo | HistoryResponse | UndoComplete | UsageUpdateEvent | UsageProgressEvent | UsageResponse | ContextCompacted | CompactionCircuitOpenEvent | CompactionCircuitClosedEvent | ConversationErrorEvent | ConversationNoticeEvent | ConversationInfo | ConversationTitleUpdatedEvent | ConversationListResponse | ConversationsClearResponse | ConversationSearchResponse | MessageContentResponse | ConversationListInvalidatedEvent | ScheduleConversationCreated | OpenConversation;
|
|
1065
1120
|
|
|
1066
1121
|
declare type ConversationTitleUpdatedEvent = z.infer<typeof ConversationTitleUpdatedEventSchema>;
|
|
1067
1122
|
|
|
@@ -1370,12 +1425,14 @@ export declare interface FileContent {
|
|
|
1370
1425
|
_attachmentId?: string;
|
|
1371
1426
|
}
|
|
1372
1427
|
|
|
1373
|
-
declare
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1428
|
+
declare type FileUploadSurfaceData = z.infer<typeof FileUploadSurfaceDataSchema>;
|
|
1429
|
+
|
|
1430
|
+
declare const FileUploadSurfaceDataSchema: z.ZodObject<{
|
|
1431
|
+
prompt: z.ZodOptional<z.ZodCoercedString<unknown>>;
|
|
1432
|
+
acceptedTypes: z.ZodPipe<z.ZodTransform<string[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
1433
|
+
maxFiles: z.ZodCatch<z.ZodOptional<z.ZodCoercedNumber<unknown>>>;
|
|
1434
|
+
maxSizeBytes: z.ZodCatch<z.ZodOptional<z.ZodCoercedNumber<unknown>>>;
|
|
1435
|
+
}, z.core.$strip>;
|
|
1379
1436
|
|
|
1380
1437
|
declare interface FilingConfigResponse {
|
|
1381
1438
|
type: "filing_config_response";
|
package/package.json
CHANGED