@vellumai/plugin-api 0.10.7-dev.202607091111.4355283 → 0.10.7-dev.202607091639.d1d600b
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 +37 -12
- package/index.js +2 -0
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -1586,6 +1586,9 @@ declare const GenerationHandoffEventSchema: z.ZodObject<{
|
|
|
1586
1586
|
attachmentWarnings: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1587
1587
|
}, z.core.$strip>;
|
|
1588
1588
|
|
|
1589
|
+
/** Read the assistant's name from IDENTITY.md for personalized responses. */
|
|
1590
|
+
export declare function getAssistantName(): string | null;
|
|
1591
|
+
|
|
1589
1592
|
/**
|
|
1590
1593
|
* Resolve the configured provider through the registry.
|
|
1591
1594
|
* Thin wrapper around `resolveConfiguredProvider()` for callsites
|
|
@@ -2063,7 +2066,7 @@ declare interface HostBashRequest {
|
|
|
2063
2066
|
command: string;
|
|
2064
2067
|
working_dir?: string;
|
|
2065
2068
|
timeout_seconds?: number;
|
|
2066
|
-
/** Extra environment variables to inject into the subprocess (e.g.
|
|
2069
|
+
/** Extra environment variables to inject into the subprocess (e.g. __CONVERSATION_ID). */
|
|
2067
2070
|
env?: Record<string, string>;
|
|
2068
2071
|
/** When set, route this request only to the client with this ID. */
|
|
2069
2072
|
targetClientId?: string;
|
|
@@ -2724,18 +2727,24 @@ declare const OpenUrlEventSchema: z.ZodObject<{
|
|
|
2724
2727
|
}, z.core.$strip>;
|
|
2725
2728
|
|
|
2726
2729
|
/**
|
|
2727
|
-
* Identifies
|
|
2728
|
-
* Tracked by the tool registry keyed by tool
|
|
2729
|
-
* object itself — query via
|
|
2730
|
+
* Identifies what owns a tool: the built-in default set, or a skill / plugin /
|
|
2731
|
+
* MCP server / workspace override. Tracked by the tool registry keyed by tool
|
|
2732
|
+
* name, not stored on the `Tool` object itself — query via
|
|
2733
|
+
* {@link ../tools/registry.getToolOwner}.
|
|
2730
2734
|
*/
|
|
2731
2735
|
declare interface OwnerInfo {
|
|
2732
2736
|
kind: OwnerKind;
|
|
2733
|
-
/** ID of the
|
|
2737
|
+
/** ID of the owner: skill id / plugin name / MCP server id / workspace path, or `"default"` for built-ins. */
|
|
2734
2738
|
id: string;
|
|
2735
2739
|
}
|
|
2736
2740
|
|
|
2737
|
-
/**
|
|
2738
|
-
|
|
2741
|
+
/**
|
|
2742
|
+
* The kind of entity that owns a tool. `"default"` is the built-in tool set
|
|
2743
|
+
* that ships with the assistant; the others are extension surfaces. Every
|
|
2744
|
+
* *registered* tool has an owner — {@link ../tools/registry.getToolOwner}
|
|
2745
|
+
* returns `undefined` only for a name that is not registered at all.
|
|
2746
|
+
*/
|
|
2747
|
+
declare type OwnerKind = "default" | "skill" | "mcp" | "plugin" | "workspace";
|
|
2739
2748
|
|
|
2740
2749
|
declare interface PartnerAudit {
|
|
2741
2750
|
risk: RiskLevel_2;
|
|
@@ -3339,6 +3348,13 @@ export declare function resolveMediaSourceData(source: MediaSource_2): {
|
|
|
3339
3348
|
media_type: string;
|
|
3340
3349
|
} | null;
|
|
3341
3350
|
|
|
3351
|
+
/**
|
|
3352
|
+
* Read the guardian's display name from `users/default.md`. We look for the
|
|
3353
|
+
* markdown-bold "Name" label (matching the IDENTITY.md convention) and fall
|
|
3354
|
+
* back to `null` on any miss; callers substitute a generic label.
|
|
3355
|
+
*/
|
|
3356
|
+
export declare function resolveUserName(workspaceDir: string): string | null;
|
|
3357
|
+
|
|
3342
3358
|
export declare enum RiskLevel {
|
|
3343
3359
|
Low = "low",
|
|
3344
3360
|
Medium = "medium",
|
|
@@ -3635,6 +3651,13 @@ declare interface ShowPlatformLogin {
|
|
|
3635
3651
|
* The `assistantVersion` field mirrors the init context's so plugins that stash
|
|
3636
3652
|
* a version stamp at init can compare against the same name on tear-down
|
|
3637
3653
|
* without keeping their own copy.
|
|
3654
|
+
*
|
|
3655
|
+
* **`shutdown` may run in a different process than `init`.** A managed
|
|
3656
|
+
* `uninstall` runs it in whichever process performs the removal (the CLI or the
|
|
3657
|
+
* daemon), which is not necessarily the daemon process that ran `init`. Do not
|
|
3658
|
+
* close over in-memory state established at `init` (open handles, timers,
|
|
3659
|
+
* module-level singletons) and expect to tear it down here — reconstruct
|
|
3660
|
+
* anything you need from the plugin's config and `data/` directory instead.
|
|
3638
3661
|
*/
|
|
3639
3662
|
export declare interface ShutdownContext {
|
|
3640
3663
|
/** Assistant semver for compatibility checks inside the plugin. */
|
|
@@ -3651,8 +3674,10 @@ export declare interface ShutdownContext {
|
|
|
3651
3674
|
* - `disable` — the plugin was disabled at runtime (e.g. a `.disabled`
|
|
3652
3675
|
* sentinel was added, or a feature flag turned it off).
|
|
3653
3676
|
* - `reload` — a source file inside the plugin directory changed and the
|
|
3654
|
-
* plugin is being redeployed in place;
|
|
3655
|
-
*
|
|
3677
|
+
* plugin is being redeployed in place; `shutdown` runs before the new version
|
|
3678
|
+
* is imported and its `init` fires. Note the `shutdown` that runs is the one
|
|
3679
|
+
* currently on disk, which is the previous version *unless* the edit was to
|
|
3680
|
+
* `shutdown` itself.
|
|
3656
3681
|
*/
|
|
3657
3682
|
declare type ShutdownReason = "shutdown" | "uninstall" | "disable" | "reload";
|
|
3658
3683
|
|
|
@@ -4087,9 +4112,9 @@ export declare interface ToolContext {
|
|
|
4087
4112
|
* "Always Allow" rules, or non-interactive auto-approve shortcuts may
|
|
4088
4113
|
* bypass the prompt. This flag is independently sufficient: it
|
|
4089
4114
|
* promotes allow → prompt decisions on its own and suppresses
|
|
4090
|
-
* temporary override options in the prompt UI. Used by
|
|
4091
|
-
*
|
|
4092
|
-
*
|
|
4115
|
+
* temporary override options in the prompt UI. Used by the `run_workflow`
|
|
4116
|
+
* launch path so a human consents to a run whose capability manifest grants
|
|
4117
|
+
* side-effecting tools.
|
|
4093
4118
|
* @legacy
|
|
4094
4119
|
*/
|
|
4095
4120
|
requireFreshApproval?: boolean;
|
package/index.js
CHANGED
|
@@ -4,7 +4,9 @@ export const HOOKS = api.HOOKS;
|
|
|
4
4
|
export const RiskLevel = api.RiskLevel;
|
|
5
5
|
export const assistantEventHub = api.assistantEventHub;
|
|
6
6
|
export const doesSupportVision = api.doesSupportVision;
|
|
7
|
+
export const getAssistantName = api.getAssistantName;
|
|
7
8
|
export const getConfiguredProvider = api.getConfiguredProvider;
|
|
8
9
|
export const getModelProfiles = api.getModelProfiles;
|
|
9
10
|
export const isMaxTokensStopReason = api.isMaxTokensStopReason;
|
|
10
11
|
export const resolveMediaSourceData = api.resolveMediaSourceData;
|
|
12
|
+
export const resolveUserName = api.resolveUserName;
|
package/package.json
CHANGED