Skip to main content

Type Alias: PluginContext

PluginContext = object

Properties​

agenda​

agenda: object

list()​

list(options?): Promise<AgendaResult>

Parameters​
options?​

PluginAgendaOptions

Returns​

Promise<AgendaResult>

agents​

agents: object

docs​

docs: object

docs.get()​

get(agent, file): Promise<string | null>

Parameters​
agent​

string

file​

string

Returns​

Promise<string | null>

docs.list()​

list(agent): Promise<PluginAgentDoc[]>

Parameters​
agent​

string

Returns​

Promise<PluginAgentDoc[]>

docs.put()​

put(agent, file, content): Promise<PluginAgentDoc>

Parameters​
agent​

string

file​

string

content​

string

Returns​

Promise<PluginAgentDoc>

docs.rm()​

rm(agent, file): Promise<boolean>

Parameters​
agent​

string

file​

string

Returns​

Promise<boolean>

create()​

create(input): Promise<PluginAgent>

Parameters​
input​

PluginAgentInput

Returns​

Promise<PluginAgent>

delete()​

delete(name): Promise<boolean>

Parameters​
name​

string

Returns​

Promise<boolean>

list()​

list(): Promise<PluginAgent[]>

Returns​

Promise<PluginAgent[]>

rename()​

rename(name, newName): Promise<PluginAgent>

Parameters​
name​

string

newName​

string

Returns​

Promise<PluginAgent>

setAvatar()​

setAvatar(name, avatar): Promise<string | null>

Parameters​
name​

string

avatar​

AgentAvatarInput

Returns​

Promise<string | null>

update()​

update(name, patch): Promise<PluginAgent>

Parameters​
name​

string

patch​

PluginAgentPatch

Returns​

Promise<PluginAgent>

backendAccounts​

backendAccounts: object

grant()​

grant(accountId, userIds): Promise<PluginBackendAccount>

Parameters​
accountId​

string

userIds​

string[]

Returns​

Promise<PluginBackendAccount>

list()​

list(): Promise<PluginBackendAccount[]>

Returns​

Promise<PluginBackendAccount[]>

revoke()​

revoke(accountId, userIds): Promise<PluginBackendAccount>

Parameters​
accountId​

string

userIds​

string[]

Returns​

Promise<PluginBackendAccount>

backends​

backends: object

list()​

list(): Promise<PluginBackendCatalog>

Returns​

Promise<PluginBackendCatalog>

registerDialect()​

registerDialect(id, dialect): () => void

Parameters​
id​

string

dialect​

Dialect | RemoteDialect

Returns​

() => void

registerProfile()​

registerProfile(profile): () => void

Parameters​
profile​

RegisteredProfile

Returns​

() => void

backup​

backup: object

enable()​

enable(): Promise<PluginBackupStatus>

Returns​

Promise<PluginBackupStatus>

status()​

status(): Promise<PluginBackupStatus>

Returns​

Promise<PluginBackupStatus>

browser​

browser: object

list()​

list(): Promise<PluginBrowserSession[]>

Returns​

Promise<PluginBrowserSession[]>

start()​

start(project): Promise<PluginBrowserSession>

Parameters​
project​

string

Returns​

Promise<PluginBrowserSession>

status()​

status(project): Promise<PluginBrowserSession | undefined>

Parameters​
project​

string

Returns​

Promise<PluginBrowserSession | undefined>

stop()​

stop(project): Promise<PluginBrowserSession | undefined>

Parameters​
project​

string

Returns​

Promise<PluginBrowserSession | undefined>

browserAnnotations​

browserAnnotations: object

delete()​

delete(id): Promise<boolean>

Parameters​
id​

string

Returns​

Promise<boolean>

findByRef()​

findByRef(provider, ref): Promise<Readonly<Omit<BrowserAnnotationMetadata, "ownerUserId" | "thumbnailBytes">> | undefined>

Parameters​
provider​

string

ref​

string

Returns​

Promise<Readonly<Omit<BrowserAnnotationMetadata, "ownerUserId" | "thumbnailBytes">> | undefined>

get()​

get(id): Promise<PluginBrowserAnnotationDetail | undefined>

Parameters​
id​

string

Returns​

Promise<PluginBrowserAnnotationDetail | undefined>

list()​

list(filter?): Promise<Readonly<Omit<BrowserAnnotationMetadata, "ownerUserId" | "thumbnailBytes">>[]>

Parameters​
filter?​

PluginBrowserAnnotationFilter

Returns​

Promise<Readonly<Omit<BrowserAnnotationMetadata, "ownerUserId" | "thumbnailBytes">>[]>

resolve()​

resolve(id, resolution): Promise<Readonly<Omit<BrowserAnnotationMetadata, "ownerUserId" | "thumbnailBytes">>>

Parameters​
id​

string

resolution​

PluginBrowserAnnotationResolution

Returns​

Promise<Readonly<Omit<BrowserAnnotationMetadata, "ownerUserId" | "thumbnailBytes">>>

setRef()​

setRef(id, ref): Promise<Readonly<Omit<BrowserAnnotationMetadata, "ownerUserId" | "thumbnailBytes">>>

Parameters​
id​

string

ref​

BrowserAnnotationExternalRef | null

Returns​

Promise<Readonly<Omit<BrowserAnnotationMetadata, "ownerUserId" | "thumbnailBytes">>>

browserRecordings​

browserRecordings: object

delete()​

delete(id): Promise<boolean>

Parameters​
id​

string

Returns​

Promise<boolean>

findByRef()​

findByRef(provider, ref): Promise<Readonly<Omit<BrowserRecordingMetadata, "ownerUserId">> | undefined>

Parameters​
provider​

string

ref​

string

Returns​

Promise<Readonly<Omit<BrowserRecordingMetadata, "ownerUserId">> | undefined>

get()​

get(id): Promise<PluginBrowserRecordingDetail | undefined>

Parameters​
id​

string

Returns​

Promise<PluginBrowserRecordingDetail | undefined>

list()​

list(filter?): Promise<Readonly<Omit<BrowserRecordingMetadata, "ownerUserId">>[]>

Parameters​
filter?​
profileId?​

string

Returns​

Promise<Readonly<Omit<BrowserRecordingMetadata, "ownerUserId">>[]>

patch()​

patch(id, ops): Promise<PluginBrowserRecordingDetail>

Parameters​
id​

string

ops​

readonly PluginBrowserRecordingOp[]

Returns​

Promise<PluginBrowserRecordingDetail>

setRef()​

setRef(id, ref): Promise<Readonly<Omit<BrowserRecordingMetadata, "ownerUserId">>>

Parameters​
id​

string

ref​

BrowserRecordingExternalRef | null

Returns​

Promise<Readonly<Omit<BrowserRecordingMetadata, "ownerUserId">>>

businessEvents​

businessEvents: PluginBusinessEvents

chat​

chat: ScopedChat

config​

readonly config: Record<string, unknown>

connections​

connections: PluginConnections

docs​

docs: object

read()​

read(route, heading?): Promise<string>

Parameters​
route​

string

heading?​

string

Returns​

Promise<string>

search(query, options?): Promise<PluginDocHit[]>

Parameters​
query​

string

options?​
limit?​

number

Returns​

Promise<PluginDocHit[]>

events​

events: object

on()​

Call Signature​

on<K>(kind, handler): () => void

Type Parameters​
K​

K extends PluginTaskEventKind

Parameters​
kind​

K

handler​

(ev) => void | Promise<void>

Returns​

() => void

Call Signature​

on<K>(kind, handler): () => void

Type Parameters​
K​

K extends PluginTodoEventKind

Parameters​
kind​

K

handler​

(ev) => void | Promise<void>

Returns​

() => void

Call Signature​

on<K>(kind, handler): () => void

Type Parameters​
K​

K extends PluginUiDocumentEventKind

Parameters​
kind​

K

handler​

(ev) => void | Promise<void>

Returns​

() => void

Call Signature​

on<K>(kind, handler): () => void

Type Parameters​
K​

K extends PluginQuestionEventKind

Parameters​
kind​

K

handler​

(ev) => void | Promise<void>

Returns​

() => void

Call Signature​

on<K>(kind, handler): () => void

Type Parameters​
K​

K extends PluginMissionEventKind

Parameters​
kind​

K

handler​

(ev) => void | Promise<void>

Returns​

() => void

Call Signature​

on<K>(kind, handler): () => void

Type Parameters​
K​

K extends PluginMemoryEventKind

Parameters​
kind​

K

handler​

(ev) => void | Promise<void>

Returns​

() => void

Call Signature​

on<K>(kind, handler): () => void

Type Parameters​
K​

K extends PluginProjectEventKind

Parameters​
kind​

K

handler​

(ev) => void | Promise<void>

Returns​

() => void

Call Signature​

on<K>(kind, handler): () => void

Type Parameters​
K​

K extends PluginAgentEventKind

Parameters​
kind​

K

handler​

(ev) => void | Promise<void>

Returns​

() => void

Call Signature​

on<K>(kind, handler): () => void

Type Parameters​
K​

K extends PluginAutomationEventKind

Parameters​
kind​

K

handler​

(ev) => void | Promise<void>

Returns​

() => void

Call Signature​

on<K>(kind, handler): () => void

Type Parameters​
K​

K extends PluginBrowserRecordingEventKind

Parameters​
kind​

K

handler​

(ev) => void | Promise<void>

Returns​

() => void

Call Signature​

on<K>(kind, handler): () => void

Type Parameters​
K​

K extends PluginBrowserAnnotationEventKind

Parameters​
kind​

K

handler​

(ev) => void | Promise<void>

Returns​

() => void

Call Signature​

on(kind, handler): () => void

Parameters​
kind​

"mission_complete" | "task_done" | "task_blocked" | "mission_started" | "turn_complete" | "mission_title_changed" | "notifications_changed" | "workflow_run" | "workflow_proposal"

handler​

(ev) => void

Returns​

() => void

fetch?​

readonly optional fetch?: typeof globalThis.fetch

groups​

groups: object

create()​

create(input): Promise<PluginGroup>

Parameters​
input​

PluginGroupInput

Returns​

Promise<PluginGroup>

delete()​

delete(groupId): Promise<boolean>

Parameters​
groupId​

string

Returns​

Promise<boolean>

get()​

get(groupId): Promise<PluginGroup | undefined>

Parameters​
groupId​

string

Returns​

Promise<PluginGroup | undefined>

list()​

list(): Promise<PluginGroup[]>

Returns​

Promise<PluginGroup[]>

update()​

update(groupId, patch): Promise<PluginGroup>

Parameters​
groupId​

string

patch​

Partial<PluginGroupInput>

Returns​

Promise<PluginGroup>

host​

host: object

exec()​

exec(bin, args?, opts?): Promise<PluginExecResult>

Parameters​
bin​

string

args?​

readonly string[]

opts?​
cwd?​

string

Returns​

Promise<PluginExecResult>

id​

readonly id: string

kanban​

kanban: object

refs​

refs: object

refs.findByRef()​

findByRef(provider, ref): Promise<PluginTask | undefined>

Parameters​
provider​

string

ref​

string

Returns​

Promise<PluginTask | undefined>

refs.list()​

list(taskId): Promise<PluginTaskLink[]>

Parameters​
taskId​

string

Returns​

Promise<PluginTaskLink[]>

refs.remove()​

remove(taskId, provider, ref): Promise<boolean>

Parameters​
taskId​

string

provider​

string

ref​

string

Returns​

Promise<boolean>

refs.set()​

set(taskId, link): Promise<PluginTaskLink>

Parameters​
taskId​

string

PluginTaskLinkInput

Returns​

Promise<PluginTaskLink>

todos​

todos: PluginTodos

add()​

add(task): Promise<PluginTask>

Parameters​
task​

PluginTaskInput

Returns​

Promise<PluginTask>

block()​

block(id, reason): Promise<PluginTask>

Parameters​
id​

string

reason​

string

Returns​

Promise<PluginTask>

delete()​

delete(id, opts?): Promise<{ deleted: string[]; }>

Parameters​
id​

string

opts?​
chain?​

boolean

Returns​

Promise<{ deleted: string[]; }>

done()​

done(id, input): Promise<PluginTask>

Parameters​
id​

string

input​

PluginTaskDoneInput

Returns​

Promise<PluginTask>

ensure()​

ensure(task, links): Promise<{ created: boolean; task: PluginTask; }>

Parameters​
task​

PluginTaskInput

readonly PluginTaskLinkInput[]

Returns​

Promise<{ created: boolean; task: PluginTask; }>

get()​

get(id): Promise<PluginTask | undefined>

Parameters​
id​

string

Returns​

Promise<PluginTask | undefined>

list()​

list(filter?): Promise<PluginTask[]>

Parameters​
filter?​

PluginTaskFilter

Returns​

Promise<PluginTask[]>

update()​

update(id, patch): Promise<PluginTask>

Parameters​
id​

string

patch​

PluginTaskPatch

Returns​

Promise<PluginTask>

layout​

layout: Omit<ScopedLayout, "navigate" | "onboardingProfile">

license​

license: object

edition()​

edition(): Promise<PluginEdition>

Returns​

Promise<PluginEdition>

log​

readonly log: PluginLog

mcp​

mcp: object

issueToken()​

issueToken(input): Promise<PluginMcpToken>

Parameters​
input​

PluginMcpTokenInput

Returns​

Promise<PluginMcpToken>

revokeToken()​

revokeToken(tokenId): Promise<boolean>

Parameters​
tokenId​

string

Returns​

Promise<boolean>

mcpServers​

mcpServers: PluginMcpServers

memory​

memory: object

rules​

rules: object

rules.add()​

add(input): Promise<Readonly<{ agent: string | null; createdAt: number; id: number; kind: string; mine: boolean; project: string | null; role: string | null; scope: string; source: string; status: string; text: string; tier: string; }>>

Parameters​
input​

PluginMemoryRuleInput

Returns​

Promise<Readonly<{ agent: string | null; createdAt: number; id: number; kind: string; mine: boolean; project: string | null; role: string | null; scope: string; source: string; status: string; text: string; tier: string; }>>

rules.list()​

list(filter?): Promise<Readonly<{ agent: string | null; createdAt: number; id: number; kind: string; mine: boolean; project: string | null; role: string | null; scope: string; source: string; status: string; text: string; tier: string; }>[]>

Parameters​
filter?​

PluginMemoryRuleFilter

Returns​

Promise<Readonly<{ agent: string | null; createdAt: number; id: number; kind: string; mine: boolean; project: string | null; role: string | null; scope: string; source: string; status: string; text: string; tier: string; }>[]>

rules.rm()​

rm(id): Promise<Readonly<{ agent: string | null; createdAt: number; id: number; kind: string; mine: boolean; project: string | null; role: string | null; scope: string; source: string; status: string; text: string; tier: string; }>>

Parameters​
id​

number

Returns​

Promise<Readonly<{ agent: string | null; createdAt: number; id: number; kind: string; mine: boolean; project: string | null; role: string | null; scope: string; source: string; status: string; text: string; tier: string; }>>

overview()​

overview(): Promise<MemoryOverview>

Returns​

Promise<MemoryOverview>

search()​

search(query): Promise<MemorySearchResult>

Parameters​
query​

string

Returns​

Promise<MemorySearchResult>

show()​

Call Signature​

show(scope, id): Promise<Readonly<{ modified: number; name: string; size: number; }>[]>

Parameters​
scope​

PluginMemoryTargetScope

id​

string

Returns​

Promise<Readonly<{ modified: number; name: string; size: number; }>[]>

Call Signature​

show(scope, id, file): Promise<Readonly<{ content: string; name: string; }>>

Parameters​
scope​

PluginMemoryTargetScope

id​

string

file​

string

Returns​

Promise<Readonly<{ content: string; name: string; }>>

messages​

messages: PluginMessages

missions​

missions: object

fork()​

fork(missionId, input): Promise<PluginMissionFork>

Parameters​
missionId​

string

input​

PluginMissionForkInput

Returns​

Promise<PluginMissionFork>

get()​

get(id): Promise<unknown>

Parameters​
id​

string

Returns​

Promise<unknown>

kill()​

kill(missionId): Promise<{ outcome: "killed" | "closed"; }>

Parameters​
missionId​

string

Returns​

Promise<{ outcome: "killed" | "closed"; }>

list()​

list(opts?): Promise<unknown[]>

Parameters​
opts?​
agents?​

string[]

limit?​

number

status?​

string

Returns​

Promise<unknown[]>

rename()​

rename(missionId, title): Promise<{ title: string | null; }>

Parameters​
missionId​

string

title​

string | null

Returns​

Promise<{ title: string | null; }>

search()​

search(q, filter?): Promise<PluginMissionSearchResult>

Parameters​
q​

string

filter?​

PluginMissionSearchFilter

Returns​

Promise<PluginMissionSearchResult>

send()​

send(missionId, text): Promise<PluginMissionSendResult>

Parameters​
missionId​

string

text​

string

Returns​

Promise<PluginMissionSendResult>

spawn()​

spawn(input): Promise<string>

Parameters​
input​

PluginMissionInput

Returns​

Promise<string>

stopScope()​

stopScope(scope): Promise<Readonly<Record<string, unknown>>>

Parameters​
scope​

PluginStopScope

Returns​

Promise<Readonly<Record<string, unknown>>>

summarize()​

summarize(missionId, opts?): Promise<PluginMissionSummary>

Parameters​
missionId​

string

opts?​
force?​

boolean

Returns​

Promise<PluginMissionSummary>

modules​

modules: object

list()​

list(): Promise<PluginModuleInfo[]>

Returns​

Promise<PluginModuleInfo[]>

notifications​

notifications: PluginNotifications

notify​

notify: object

alert()​

alert(title, body?, opts?): void

Parameters​
title​

string

body?​

string

opts?​
urgent?​

boolean

Returns​

void

report()​

report(title, body?): void

Parameters​
title​

string

body?​

string

Returns​

void

onboarding​

onboarding: object

profile​

profile: ScopedLayout["onboardingProfile"]

outbox​

outbox: PluginOutbox

permissions​

readonly permissions: readonly PluginPermission[]

pipelines​

pipelines: object

create()​

create(input): Promise<PluginOwnPipeline>

Parameters​
input​

PluginPipelineInput

Returns​

Promise<PluginOwnPipeline>

delete()​

delete(pipelineId): Promise<boolean>

Parameters​
pipelineId​

string

Returns​

Promise<boolean>

get()​

get(pipelineId): Promise<PluginPipeline | PluginOwnPipeline | undefined>

Parameters​
pipelineId​

string

Returns​

Promise<PluginPipeline | PluginOwnPipeline | undefined>

list()​

list(): Promise<(PluginPipeline | PluginOwnPipeline)[]>

Returns​

Promise<(PluginPipeline | PluginOwnPipeline)[]>

run()​

run(pipelineId, input?): Promise<PluginPipelineRun>

Parameters​
pipelineId​

string

input?​

Record<string, unknown>

Returns​

Promise<PluginPipelineRun>

runStatus()​

runStatus(runId): Promise<PluginPipelineRunStatus | undefined>

Parameters​
runId​

string

Returns​

Promise<PluginPipelineRunStatus | undefined>

plugins​

plugins: object

list()​

list(): Promise<PluginInfo[]>

Returns​

Promise<PluginInfo[]>

setEnabled()​

setEnabled(pluginId, enabled): Promise<boolean>

Parameters​
pluginId​

string

enabled​

boolean

Returns​

Promise<boolean>

projects​

projects: object

create()​

create(input): Promise<Readonly<{ project: PluginProject; warnings: readonly PluginProjectWarning[]; }>>

Parameters​
input​

PluginProjectInput

Returns​

Promise<Readonly<{ project: PluginProject; warnings: readonly PluginProjectWarning[]; }>>

get()​

get(slug): Promise<Readonly<{ color: string | null; createdBy: string | null; cwd: string | null; icon: string | null; kind: string | null; lastActivity: number | null; mine: boolean; name: string | null; slug: string; speech: string | null; status: string; workspace: string | null; }> | undefined>

Parameters​
slug​

string

Returns​

Promise<Readonly<{ color: string | null; createdBy: string | null; cwd: string | null; icon: string | null; kind: string | null; lastActivity: number | null; mine: boolean; name: string | null; slug: string; speech: string | null; status: string; workspace: string | null; }> | undefined>

list()​

list(): Promise<Readonly<{ color: string | null; createdBy: string | null; cwd: string | null; icon: string | null; kind: string | null; lastActivity: number | null; mine: boolean; name: string | null; slug: string; speech: string | null; status: string; workspace: string | null; }>[]>

Returns​

Promise<Readonly<{ color: string | null; createdBy: string | null; cwd: string | null; icon: string | null; kind: string | null; lastActivity: number | null; mine: boolean; name: string | null; slug: string; speech: string | null; status: string; workspace: string | null; }>[]>

roles()​

roles(slug): Promise<Readonly<Partial<Record<TaskRole, Readonly<{ agent: string; backend?: string | null; model?: string | null; permissionMode?: string | null; }>>>>>

Parameters​
slug​

string

Returns​

Promise<Readonly<Partial<Record<TaskRole, Readonly<{ agent: string; backend?: string | null; model?: string | null; permissionMode?: string | null; }>>>>>

setRole()​

setRole(slug, role, spec): Promise<Readonly<Partial<Record<TaskRole, Readonly<{ agent: string; backend?: string | null; model?: string | null; permissionMode?: string | null; }>>>>>

Parameters​
slug​

string

role​

string

spec​

PluginRoleInput | null

Returns​

Promise<Readonly<Partial<Record<TaskRole, Readonly<{ agent: string; backend?: string | null; model?: string | null; permissionMode?: string | null; }>>>>>

update()​

update(slug, patch): Promise<Readonly<{ project: PluginProject; warnings: readonly PluginProjectWarning[]; }>>

Parameters​
slug​

string

patch​

PluginProjectPatch

Returns​

Promise<Readonly<{ project: PluginProject; warnings: readonly PluginProjectWarning[]; }>>

workspaces()​

workspaces(): Promise<Readonly<{ color: string | null; leadAgent: string | null; name: string; projects: readonly string[]; slug: string; }>[]>

Returns​

Promise<Readonly<{ color: string | null; leadAgent: string | null; name: string; projects: readonly string[]; slug: string; }>[]>

provider​

provider: ProviderServices

questions​

questions: PluginQuestions

realtime​

realtime: PluginRealtime

roles​

roles: object

create()​

create(input): Promise<PluginRole>

Parameters​
input​

PluginAccountRoleInput

Returns​

Promise<PluginRole>

delete()​

delete(roleId): Promise<boolean>

Parameters​
roleId​

string

Returns​

Promise<boolean>

get()​

get(roleId): Promise<PluginRole | undefined>

Parameters​
roleId​

string

Returns​

Promise<PluginRole | undefined>

list()​

list(): Promise<PluginRole[]>

Returns​

Promise<PluginRole[]>

update()​

update(roleId, patch): Promise<PluginRole>

Parameters​
roleId​

string

patch​

Partial<PluginAccountRoleInput>

Returns​

Promise<PluginRole>

routines​

routines: object

create()​

create(input): Promise<PluginRoutine>

Parameters​
input​

PluginRoutineInput

Returns​

Promise<PluginRoutine>

delete()​

delete(routineId): Promise<boolean>

Parameters​
routineId​

string

Returns​

Promise<boolean>

list()​

list(): Promise<PluginRoutine[]>

Returns​

Promise<PluginRoutine[]>

update()​

update(routineId, patch): Promise<PluginRoutine>

Parameters​
routineId​

string

patch​

PluginRoutinePatch

Returns​

Promise<PluginRoutine>

secrets​

secrets: PluginSecrets

series​

series: object

fallback​

fallback: object

fallback.clear()​

clear(seriesId, scope, group?): Promise<Readonly<{ backend: string | null; model: string | null; planGroup: string | null; scope: string; updatedAt: number; }>[]>

Parameters​
seriesId​

string

scope​

string

group?​

string | null

Returns​

Promise<Readonly<{ backend: string | null; model: string | null; planGroup: string | null; scope: string; updatedAt: number; }>[]>

fallback.list()​

list(seriesId): Promise<Readonly<{ backend: string | null; model: string | null; planGroup: string | null; scope: string; updatedAt: number; }>[]>

Parameters​
seriesId​

string

Returns​

Promise<Readonly<{ backend: string | null; model: string | null; planGroup: string | null; scope: string; updatedAt: number; }>[]>

fallback.set()​

set(seriesId, rule): Promise<Readonly<{ applied: { backend: string; model: string | null; } | null; applyError: string | null; rules: readonly PluginSeriesRule[]; }>>

Parameters​
seriesId​

string

rule​

PluginSeriesFallbackInput

Returns​

Promise<Readonly<{ applied: { backend: string; model: string | null; } | null; applyError: string | null; rules: readonly PluginSeriesRule[]; }>>

role​

role: object

role.clear()​

clear(seriesId, scope, group?): Promise<Readonly<{ backend: string | null; model: string | null; planGroup: string | null; scope: string; updatedAt: number; }>[]>

Parameters​
seriesId​

string

scope​

string

group?​

string | null

Returns​

Promise<Readonly<{ backend: string | null; model: string | null; planGroup: string | null; scope: string; updatedAt: number; }>[]>

role.list()​

list(seriesId): Promise<Readonly<{ backend: string | null; model: string | null; planGroup: string | null; scope: string; updatedAt: number; }>[]>

Parameters​
seriesId​

string

Returns​

Promise<Readonly<{ backend: string | null; model: string | null; planGroup: string | null; scope: string; updatedAt: number; }>[]>

role.set()​

set(seriesId, choice): Promise<Readonly<{ backend: string | null; model: string | null; planGroup: string | null; scope: string; updatedAt: number; }>[]>

Parameters​
seriesId​

string

choice​

PluginSeriesRoleInput

Returns​

Promise<Readonly<{ backend: string | null; model: string | null; planGroup: string | null; scope: string; updatedAt: number; }>[]>

settings​

settings: object

get()​

get(key): PluginSettingValue

Parameters​
key​

string

Returns​

PluginSettingValue

skills​

skills: PluginSkills

storage​

storage: PluginStorage

system​

system: object

doctor()​

doctor(): Promise<PluginDoctorReport>

Returns​

Promise<PluginDoctorReport>

health()​

health(): Promise<PluginSystemHealth>

Returns​

Promise<PluginSystemHealth>

logs()​

logs(options?): Promise<string[]>

Parameters​
options?​

PluginLogsOptions

Returns​

Promise<string[]>

traces​

traces: object

get()​

get(id, opts?): Promise<unknown>

Parameters​
id​

string

opts?​

PluginTraceOptions

Returns​

Promise<unknown>

transports​

transports: PluginTransports

triggers​

triggers: object

create()​

create(input): Promise<PluginTriggerCreated>

Parameters​
input​

PluginTriggerInput

Returns​

Promise<PluginTriggerCreated>

disable()​

disable(triggerId): Promise<boolean>

Parameters​
triggerId​

string

Returns​

Promise<boolean>

get()​

get(triggerId): Promise<PluginTriggerInfo | PluginOwnTrigger | undefined>

Parameters​
triggerId​

string

Returns​

Promise<PluginTriggerInfo | PluginOwnTrigger | undefined>

list()​

list(): Promise<PluginTriggerInfo[]>

Returns​

Promise<PluginTriggerInfo[]>

remove()​

remove(triggerId): Promise<boolean>

Parameters​
triggerId​

string

Returns​

Promise<boolean>

test()​

test(triggerId, options?): Promise<PluginTriggerTestResult>

Parameters​
triggerId​

string

options?​

PluginTriggerTestOptions

Returns​

Promise<PluginTriggerTestResult>

ui​

ui: object

documents​

documents: PluginUiDocuments

navigate: ScopedLayout["navigate"]

token()​

token(): string

Returns​

string

usage​

usage: object

get()​

get(backend, options?): Promise<UsageEntry | null>

Parameters​
backend​

string

options?​

UsageProbeOptions

Returns​

Promise<UsageEntry | null>

list()​

list(options?): Promise<UsageEntry[]>

Parameters​
options?​

UsageProbeOptions

Returns​

Promise<UsageEntry[]>

registerCollector()​

registerCollector(backend, collect): () => void

Parameters​
backend​

string

collect​

UsageCollector

Returns​

() => void

users​

users: object

get()​

get(userId): Promise<PluginAccountUser | undefined>

Parameters​
userId​

string

Returns​

Promise<PluginAccountUser | undefined>

list()​

list(): Promise<PluginAccountUser[]>

Returns​

Promise<PluginAccountUser[]>

setGroups()​

setGroups(userId, groupIds): Promise<PluginAccountUser>

Parameters​
userId​

string

groupIds​

string[]

Returns​

Promise<PluginAccountUser>

setStatus()​

setStatus(userId, status): Promise<PluginAccountUser>

Parameters​
userId​

string

status​

"active" | "disabled"

Returns​

Promise<PluginAccountUser>

version​

readonly version: string

webhooks​

webhooks: object

on()​

on(name, handler): () => void

Parameters​
name​

string

handler​

PluginWebhookHandler

Returns​

() => void

workflows​

workflows: PluginWorkflows & object

Type Declaration​

cancel()​

cancel(runId): Promise<boolean>

Parameters​
runId​

string

Returns​

Promise<boolean>

get()​

get(workflowId): Promise<PluginWorkflowDetail | undefined>

Parameters​
workflowId​

string

Returns​

Promise<PluginWorkflowDetail | undefined>

list()​

list(): Promise<PluginWorkflow[]>

Returns​

Promise<PluginWorkflow[]>

run()​

run(workflowId, input?): Promise<PluginWorkflowRun>

Parameters​
workflowId​

string

input?​

unknown

Returns​

Promise<PluginWorkflowRun>

status()​

status(runId): Promise<PluginWorkflowRunStatus | undefined>

Parameters​
runId​

string

Returns​

Promise<PluginWorkflowRunStatus | undefined>

worktrees​

worktrees: object

create()​

create(taskId, opts?): Promise<Readonly<{ base: string | null; branch: string | null; mergedCommitSha: string | null; path: string | null; taskId: string; }>>

Parameters​
taskId​

string

opts?​
base?​

string

Returns​

Promise<Readonly<{ base: string | null; branch: string | null; mergedCommitSha: string | null; path: string | null; taskId: string; }>>

dispose()​

dispose(taskId, opts?): Promise<{ disposed: boolean; }>

Parameters​
taskId​

string

opts?​
force?​

boolean

Returns​

Promise<{ disposed: boolean; }>

info()​

info(taskId): Promise<Readonly<{ base: string | null; branch: string | null; mergedCommitSha: string | null; path: string | null; taskId: string; }> | undefined>

Parameters​
taskId​

string

Returns​

Promise<Readonly<{ base: string | null; branch: string | null; mergedCommitSha: string | null; path: string | null; taskId: string; }> | undefined>

Methods​

assert()​

assert(permission): void

Parameters​

permission​

PluginPermission

Returns​

void

assertPermission()​

assertPermission(permission): void

Parameters​

permission​

string

Returns​

void

can()​

can(permission): boolean

Parameters​

permission​

PluginPermission

Returns​

boolean

effect()​

Call Signature​

effect(fn): PluginEffectHandle

Parameters​
fn​

() => void | PluginSyncEffect

Returns​

PluginEffectHandle

Call Signature​

effect(fn): PluginAsyncEffectHandle

Parameters​
fn​

() => void | PluginEffect

Returns​

PluginAsyncEffectHandle

router()​

router(prefix?): Router

Parameters​

prefix?​

string

Returns​

Router

user()​

user(): PluginUser | undefined

Returns​

PluginUser | undefined