@vellumai/plugin-api 0.10.9-dev.202607162126.2d253b7 → 0.10.9-staging.2
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 +99 -76
- package/index.js +0 -3
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -295,6 +295,10 @@ declare const AssistantConfigSchema: z.ZodObject<{
|
|
|
295
295
|
}>>;
|
|
296
296
|
}, z.core.$strip>>;
|
|
297
297
|
"web-fetch": z.ZodDefault<z.ZodObject<{
|
|
298
|
+
mode: z.ZodDefault<z.ZodEnum<{
|
|
299
|
+
managed: "managed";
|
|
300
|
+
"your-own": "your-own";
|
|
301
|
+
}>>;
|
|
298
302
|
provider: z.ZodDefault<z.ZodEnum<{
|
|
299
303
|
[x: string]: string;
|
|
300
304
|
}>>;
|
|
@@ -663,7 +667,6 @@ declare const AssistantConfigSchema: z.ZodObject<{
|
|
|
663
667
|
minCooldownMs: z.ZodDefault<z.ZodNumber>;
|
|
664
668
|
keepSupersededRuns: z.ZodDefault<z.ZodBoolean>;
|
|
665
669
|
matchConversationProfile: z.ZodDefault<z.ZodBoolean>;
|
|
666
|
-
promptPath: z.ZodDefault<z.ZodNullable<z.ZodString>>;
|
|
667
670
|
}, z.core.$strip>>;
|
|
668
671
|
}, z.core.$strip>>;
|
|
669
672
|
monitoring: z.ZodDefault<z.ZodObject<{
|
|
@@ -706,6 +709,82 @@ declare const AssistantConfigSchema: z.ZodObject<{
|
|
|
706
709
|
retentionDays: z.ZodDefault<z.ZodNumber>;
|
|
707
710
|
}, z.core.$strip>>;
|
|
708
711
|
llm: z.ZodDefault<z.ZodObject<{
|
|
712
|
+
default: z.ZodDefault<z.ZodObject<{
|
|
713
|
+
provider: z.ZodDefault<z.ZodEnum<{
|
|
714
|
+
anthropic: "anthropic";
|
|
715
|
+
openai: "openai";
|
|
716
|
+
gemini: "gemini";
|
|
717
|
+
fireworks: "fireworks";
|
|
718
|
+
openrouter: "openrouter";
|
|
719
|
+
ollama: "ollama";
|
|
720
|
+
"vercel-ai-gateway": "vercel-ai-gateway";
|
|
721
|
+
"openai-compatible": "openai-compatible";
|
|
722
|
+
minimax: "minimax";
|
|
723
|
+
atlascloud: "atlascloud";
|
|
724
|
+
together: "together";
|
|
725
|
+
}>>;
|
|
726
|
+
provider_connection: z.ZodOptional<z.ZodString>;
|
|
727
|
+
model: z.ZodDefault<z.ZodString>;
|
|
728
|
+
maxTokens: z.ZodDefault<z.ZodNumber>;
|
|
729
|
+
effort: z.ZodDefault<z.ZodEnum<{
|
|
730
|
+
low: "low";
|
|
731
|
+
medium: "medium";
|
|
732
|
+
high: "high";
|
|
733
|
+
none: "none";
|
|
734
|
+
xhigh: "xhigh";
|
|
735
|
+
max: "max";
|
|
736
|
+
}>>;
|
|
737
|
+
speed: z.ZodDefault<z.ZodEnum<{
|
|
738
|
+
standard: "standard";
|
|
739
|
+
fast: "fast";
|
|
740
|
+
}>>;
|
|
741
|
+
verbosity: z.ZodDefault<z.ZodEnum<{
|
|
742
|
+
low: "low";
|
|
743
|
+
medium: "medium";
|
|
744
|
+
high: "high";
|
|
745
|
+
}>>;
|
|
746
|
+
temperature: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
|
|
747
|
+
topP: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
|
|
748
|
+
thinking: z.ZodDefault<z.ZodObject<{
|
|
749
|
+
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
750
|
+
streamThinking: z.ZodDefault<z.ZodBoolean>;
|
|
751
|
+
level: z.ZodOptional<z.ZodEnum<{
|
|
752
|
+
low: "low";
|
|
753
|
+
medium: "medium";
|
|
754
|
+
high: "high";
|
|
755
|
+
minimal: "minimal";
|
|
756
|
+
}>>;
|
|
757
|
+
}, z.core.$strip>>;
|
|
758
|
+
contextWindow: z.ZodDefault<z.ZodObject<{
|
|
759
|
+
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
760
|
+
maxInputTokens: z.ZodDefault<z.ZodNumber>;
|
|
761
|
+
targetBudgetRatio: z.ZodDefault<z.ZodNumber>;
|
|
762
|
+
compactThreshold: z.ZodDefault<z.ZodNumber>;
|
|
763
|
+
summaryBudgetRatio: z.ZodDefault<z.ZodNumber>;
|
|
764
|
+
overflowRecovery: z.ZodDefault<z.ZodObject<{
|
|
765
|
+
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
766
|
+
safetyMarginRatio: z.ZodDefault<z.ZodNumber>;
|
|
767
|
+
maxAttempts: z.ZodDefault<z.ZodNumber>;
|
|
768
|
+
interactiveLatestTurnCompression: z.ZodDefault<z.ZodEnum<{
|
|
769
|
+
truncate: "truncate";
|
|
770
|
+
summarize: "summarize";
|
|
771
|
+
drop: "drop";
|
|
772
|
+
}>>;
|
|
773
|
+
nonInteractiveLatestTurnCompression: z.ZodDefault<z.ZodEnum<{
|
|
774
|
+
truncate: "truncate";
|
|
775
|
+
summarize: "summarize";
|
|
776
|
+
drop: "drop";
|
|
777
|
+
}>>;
|
|
778
|
+
}, z.core.$strip>>;
|
|
779
|
+
}, z.core.$strip>>;
|
|
780
|
+
openrouter: z.ZodDefault<z.ZodObject<{
|
|
781
|
+
only: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
782
|
+
}, z.core.$strip>>;
|
|
783
|
+
logitBias: z.ZodOptional<z.ZodEnum<{
|
|
784
|
+
"suppress-cjk": "suppress-cjk";
|
|
785
|
+
}>>;
|
|
786
|
+
disableCache: z.ZodOptional<z.ZodBoolean>;
|
|
787
|
+
}, z.core.$strip>>;
|
|
709
788
|
profiles: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
710
789
|
provider: z.ZodOptional<z.ZodEnum<{
|
|
711
790
|
anthropic: "anthropic";
|
|
@@ -719,7 +798,6 @@ declare const AssistantConfigSchema: z.ZodObject<{
|
|
|
719
798
|
minimax: "minimax";
|
|
720
799
|
atlascloud: "atlascloud";
|
|
721
800
|
together: "together";
|
|
722
|
-
baseten: "baseten";
|
|
723
801
|
}>>;
|
|
724
802
|
model: z.ZodOptional<z.ZodString>;
|
|
725
803
|
maxTokens: z.ZodOptional<z.ZodNumber>;
|
|
@@ -852,7 +930,6 @@ declare const AssistantConfigSchema: z.ZodObject<{
|
|
|
852
930
|
minimax: "minimax";
|
|
853
931
|
atlascloud: "atlascloud";
|
|
854
932
|
together: "together";
|
|
855
|
-
baseten: "baseten";
|
|
856
933
|
}>>;
|
|
857
934
|
model: z.ZodOptional<z.ZodString>;
|
|
858
935
|
maxTokens: z.ZodOptional<z.ZodNumber>;
|
|
@@ -1177,7 +1254,6 @@ declare const AssistantConfigSchema: z.ZodObject<{
|
|
|
1177
1254
|
bargeInMinSpeechMs: z.ZodDefault<z.ZodNumber>;
|
|
1178
1255
|
}, z.core.$strip>>;
|
|
1179
1256
|
maxSessionDurationSeconds: z.ZodDefault<z.ZodNumber>;
|
|
1180
|
-
archiveAudio: z.ZodDefault<z.ZodBoolean>;
|
|
1181
1257
|
}, z.core.$strip>>;
|
|
1182
1258
|
whatsapp: z.ZodDefault<z.ZodObject<{
|
|
1183
1259
|
phoneNumber: z.ZodDefault<z.ZodString>;
|
|
@@ -2365,7 +2441,7 @@ declare interface ConversationSearchResultItem {
|
|
|
2365
2441
|
matchingMessages: ConversationSearchMatchingMessage[];
|
|
2366
2442
|
}
|
|
2367
2443
|
|
|
2368
|
-
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 |
|
|
2444
|
+
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;
|
|
2369
2445
|
|
|
2370
2446
|
declare type ConversationTitleUpdatedEvent = z.infer<typeof ConversationTitleUpdatedEventSchema>;
|
|
2371
2447
|
|
|
@@ -2386,34 +2462,6 @@ declare interface CopyBlockSurfaceData {
|
|
|
2386
2462
|
language?: string;
|
|
2387
2463
|
}
|
|
2388
2464
|
|
|
2389
|
-
/**
|
|
2390
|
-
* Plugin-facing credential resolution.
|
|
2391
|
-
*
|
|
2392
|
-
* {@link resolveCredential} returns a stored credential's plaintext value — the
|
|
2393
|
-
* same value `assistant credentials reveal` prints — resolving a reference that
|
|
2394
|
-
* is either a credential UUID or a `"service/field"` string, exactly as the
|
|
2395
|
-
* reveal path does (see {@link ../tools/credentials/resolve.resolveCredentialRef}
|
|
2396
|
-
* and the `credentials/reveal` route).
|
|
2397
|
-
*
|
|
2398
|
-
* ## Plugin scoping
|
|
2399
|
-
*
|
|
2400
|
-
* When a plugin is in context — its hook or tool is executing, tracked by
|
|
2401
|
-
* {@link ../plugins/plugin-execution-context.getCurrentPluginName} — resolution
|
|
2402
|
-
* is restricted: the plugin may only resolve credentials whose `field` equals
|
|
2403
|
-
* the plugin's own manifest name. A plugin named `acme` can therefore read
|
|
2404
|
-
* `openai/acme` or `stripe/acme` but not `openai/api_key`. Outside any plugin
|
|
2405
|
-
* context (host-internal callers, CLI, tests) the resolver is unscoped and
|
|
2406
|
-
* behaves like a direct reveal.
|
|
2407
|
-
*/
|
|
2408
|
-
/**
|
|
2409
|
-
* Raised when a credential cannot be resolved: the reference does not match a
|
|
2410
|
-
* stored credential, the store is unreachable, or the calling plugin is not
|
|
2411
|
-
* permitted to resolve the requested credential.
|
|
2412
|
-
*/
|
|
2413
|
-
export declare class CredentialResolutionError extends Error {
|
|
2414
|
-
constructor(message: string);
|
|
2415
|
-
}
|
|
2416
|
-
|
|
2417
2465
|
declare interface CustomSlimSkill extends SlimSkillBase {
|
|
2418
2466
|
origin: "custom";
|
|
2419
2467
|
}
|
|
@@ -3586,17 +3634,6 @@ declare const INTERFACE_IDS: readonly ["macos", "ios", "cli", "telegram", "phone
|
|
|
3586
3634
|
|
|
3587
3635
|
declare type InterfaceId = (typeof INTERFACE_IDS)[number];
|
|
3588
3636
|
|
|
3589
|
-
/**
|
|
3590
|
-
* Appended (inside the `<system_notice>` wrapper) to the internal continuation /
|
|
3591
|
-
* completion nudge strings that re-query the model. Those notices are injected
|
|
3592
|
-
* as user-role turns; weaker models without a separate reasoning channel
|
|
3593
|
-
* otherwise narrate or answer the notice as visible text, leaking agent-loop
|
|
3594
|
-
* scaffolding into the user-facing reply. This clause forbids that narration
|
|
3595
|
-
* without licensing an empty reply — each nudge's own instruction still drives
|
|
3596
|
-
* the expected output (summary / final reply / continuation).
|
|
3597
|
-
*/
|
|
3598
|
-
export declare const INTERNAL_NUDGE_OUTPUT_SUPPRESSION = " This notice is internal: do not repeat, quote, describe, or acknowledge it, and do not narrate whether you will continue or whether the turn is done. Reply with only the content the user should see.";
|
|
3599
|
-
|
|
3600
3637
|
/** Whether the conversation currently has a turn in flight. */
|
|
3601
3638
|
export declare function isConversationProcessing(id: string): Promise<boolean>;
|
|
3602
3639
|
|
|
@@ -3864,8 +3901,8 @@ declare const messageMetadataSchema: z.ZodObject<{
|
|
|
3864
3901
|
status: z.ZodEnum<{
|
|
3865
3902
|
completed: "completed";
|
|
3866
3903
|
failed: "failed";
|
|
3867
|
-
aborted: "aborted";
|
|
3868
3904
|
running: "running";
|
|
3905
|
+
aborted: "aborted";
|
|
3869
3906
|
}>;
|
|
3870
3907
|
error: z.ZodOptional<z.ZodString>;
|
|
3871
3908
|
conversationId: z.ZodOptional<z.ZodString>;
|
|
@@ -3896,7 +3933,6 @@ declare const messageMetadataSchema: z.ZodObject<{
|
|
|
3896
3933
|
provenanceRequesterIdentifier: z.ZodOptional<z.ZodString>;
|
|
3897
3934
|
automated: z.ZodOptional<z.ZodBoolean>;
|
|
3898
3935
|
hidden: z.ZodOptional<z.ZodBoolean>;
|
|
3899
|
-
messageKind: z.ZodOptional<z.ZodString>;
|
|
3900
3936
|
backgroundToolCompletion: z.ZodOptional<z.ZodObject<{
|
|
3901
3937
|
id: z.ZodString;
|
|
3902
3938
|
toolName: z.ZodString;
|
|
@@ -4135,15 +4171,22 @@ declare interface OpenBundleResponse {
|
|
|
4135
4171
|
bundleSizeBytes: number;
|
|
4136
4172
|
}
|
|
4137
4173
|
|
|
4138
|
-
|
|
4139
|
-
|
|
4140
|
-
|
|
4141
|
-
|
|
4142
|
-
|
|
4143
|
-
|
|
4144
|
-
|
|
4145
|
-
|
|
4146
|
-
|
|
4174
|
+
/**
|
|
4175
|
+
* Server push — instructs the client to open and focus a conversation. If
|
|
4176
|
+
* the conversation isn't already present in the client's sidebar list (e.g.
|
|
4177
|
+
* it was just created via `POST /v1/conversations`), the client should stub
|
|
4178
|
+
* a sidebar entry using the provided `title` before navigating.
|
|
4179
|
+
*/
|
|
4180
|
+
declare interface OpenConversation {
|
|
4181
|
+
type: "open_conversation";
|
|
4182
|
+
conversationId: string;
|
|
4183
|
+
/** Optional conversation title; supplied when the client may not yet have the conversation in its list. */
|
|
4184
|
+
title?: string;
|
|
4185
|
+
/** Optional message ID to scroll to after focus. */
|
|
4186
|
+
anchorMessageId?: string;
|
|
4187
|
+
/** When `false`, the client should register the conversation in its sidebar (so it's visible and navigable) but must NOT switch focus to it. Omitting the field defaults to `true` for backward compatibility with existing single-target 'jump to conversation' callers. */
|
|
4188
|
+
focus?: boolean;
|
|
4189
|
+
}
|
|
4147
4190
|
|
|
4148
4191
|
declare type OpenPanelEvent = z.infer<typeof OpenPanelEventSchema>;
|
|
4149
4192
|
|
|
@@ -4788,16 +4831,6 @@ declare const RelationshipStateUpdatedEventSchema: z.ZodObject<{
|
|
|
4788
4831
|
updatedAt: z.ZodString;
|
|
4789
4832
|
}, z.core.$strip>;
|
|
4790
4833
|
|
|
4791
|
-
/**
|
|
4792
|
-
* Resolve a credential reference to its plaintext value.
|
|
4793
|
-
*
|
|
4794
|
-
* @param ref A credential UUID or a `"service/field"` string.
|
|
4795
|
-
* @returns The plaintext credential value.
|
|
4796
|
-
* @throws {CredentialResolutionError} when the reference does not resolve, the
|
|
4797
|
-
* store is unreachable, or a plugin in context is not scoped to the credential.
|
|
4798
|
-
*/
|
|
4799
|
-
export declare function resolveCredential(ref: string): Promise<string>;
|
|
4800
|
-
|
|
4801
4834
|
/**
|
|
4802
4835
|
* Plugin-facing read API over the skill surface: the locally installed
|
|
4803
4836
|
* catalog with resolved enablement states, and the remote skill catalog —
|
|
@@ -4921,15 +4954,6 @@ export declare interface RunConversationTurnOptions {
|
|
|
4921
4954
|
* controller fires, terminating the in-flight agent loop.
|
|
4922
4955
|
*/
|
|
4923
4956
|
signal?: AbortSignal;
|
|
4924
|
-
/**
|
|
4925
|
-
* Conversation type for newly created conversations. When omitted,
|
|
4926
|
-
* defaults to `"standard"` (visible in the sidebar). Set to
|
|
4927
|
-
* `"background"` for plugin-driven conversations that should not
|
|
4928
|
-
* appear in the sidebar's Recents grouping.
|
|
4929
|
-
*
|
|
4930
|
-
* Ignored when `conversationId` references an existing conversation.
|
|
4931
|
-
*/
|
|
4932
|
-
conversationType?: "standard" | "background";
|
|
4933
4957
|
}
|
|
4934
4958
|
|
|
4935
4959
|
export declare interface RunConversationTurnResult {
|
|
@@ -5080,8 +5104,7 @@ export declare interface SendMessageConfig {
|
|
|
5080
5104
|
* LLM call-site identifier. `RetryProvider` resolves
|
|
5081
5105
|
* provider/model/maxTokens/effort/speed/verbosity/temperature/thinking/
|
|
5082
5106
|
* contextWindow via `resolveCallSiteConfig(callSite, config.llm)`, falling
|
|
5083
|
-
* back to
|
|
5084
|
-
* is present.
|
|
5107
|
+
* back to `llm.default` when no callSite-specific entry is present.
|
|
5085
5108
|
*/
|
|
5086
5109
|
callSite?: LLMCallSite;
|
|
5087
5110
|
/**
|
package/index.js
CHANGED
|
@@ -1,9 +1,7 @@
|
|
|
1
1
|
// Generated by scripts/build-plugin-api.ts — do not edit by hand.
|
|
2
2
|
const api = globalThis[Symbol.for("vellum.plugin-api")] ?? {};
|
|
3
3
|
export const CLI_COMMAND_HELP = api.CLI_COMMAND_HELP;
|
|
4
|
-
export const CredentialResolutionError = api.CredentialResolutionError;
|
|
5
4
|
export const HOOKS = api.HOOKS;
|
|
6
|
-
export const INTERNAL_NUDGE_OUTPUT_SUPPRESSION = api.INTERNAL_NUDGE_OUTPUT_SUPPRESSION;
|
|
7
5
|
export const RiskLevel = api.RiskLevel;
|
|
8
6
|
export const TtsSynthesisError = api.TtsSynthesisError;
|
|
9
7
|
export const addMessage = api.addMessage;
|
|
@@ -26,7 +24,6 @@ export const listCatalogSkills = api.listCatalogSkills;
|
|
|
26
24
|
export const listConversations = api.listConversations;
|
|
27
25
|
export const listInstalledSkills = api.listInstalledSkills;
|
|
28
26
|
export const parseMessageMetadata = api.parseMessageMetadata;
|
|
29
|
-
export const resolveCredential = api.resolveCredential;
|
|
30
27
|
export const resolveMediaSourceData = api.resolveMediaSourceData;
|
|
31
28
|
export const resolveUserName = api.resolveUserName;
|
|
32
29
|
export const runConversationTurn = api.runConversationTurn;
|
package/package.json
CHANGED