ChannelRuntimeContext

ChannelRuntimeContext = object

Defined in: types/channel-types/index.ts:414

The minimal capabilities every channel gets from the core — the intersection across terminal, HTTP and Google Chat, nothing channel-specific. Anything specific (Google Chat’s credentials, HTTP’s port) the channel reads from env in its own build(). This is the dependency-inversion seam: the core injects these, the channel imports none of them.

env, log, confirm and admit are the floor every channel relies on. resolveConfirmation, reads, authenticate, logins, linking and settings are optional in-process capabilities that can’t come from env: the core populates them, only a channel that needs them (HTTP) reads them, the others ignore them.

Properties

admit

admit: (principal, hint?) => Promise<Admission>

Defined in: types/channel-types/index.ts:437

Whether the core talks to principal at all (see Admission). A channel that authenticates its own callers checks it before anything else and answers with message when it’s refused; the core checks again on every turn, confirmation and read, so a channel that doesn’t still can’t let anyone in. message is in the language hint asks for (see ChannelI18n).

Parameters

principal

Principal

hint?

string

Returns

Promise<Admission>

assistantName?

optional assistantName?: string

Defined in: types/channel-types/index.ts:453

The assistant’s name (the app’s persona.name), for what the channel tells people itself (a login page, a card). The core always sets it; absent on an older core.

authenticate?

optional authenticate?: Authenticate

Defined in: types/channel-types/index.ts:445

The configured auth provider, built; absent when the app declares none or it failed to build.

confirm

confirm: (token, sessionKey, principal, hint?) => Promise<ConfirmReply | null>

Defined in: types/channel-types/index.ts:429

Resolves a confirmation token against the core’s single ConfirmationStore, already bound to this instance’s store/vault/writer. The channel calls it and holds no state: staging and the store stay the core’s. The token resolves only for the principal who staged it, in the same session. Returns what to tell the person, in their language (hint as in ChannelI18n), or null when the input wasn’t token-shaped (see resolveConfirmation). A link code (xxxx-xxxx-xxxx, see ChannelLinking) is taken here too, from whoever sends it.

Parameters

token

string

sessionKey

string

principal

Principal

hint?

string

Returns

Promise<ConfirmReply | null>

env

env: Record<string, string | undefined>

Defined in: types/channel-types/index.ts:416

The process env, so a channel reads its own config (subscription, credentials, port) without the core knowing which keys it needs.

frameworkVersion?

optional frameworkVersion?: string

Defined in: types/channel-types/index.ts:455

The framework’s version (major.minor.patch), for a channel that tells people which Mercury they’re talking to (HTTP’s /version). The core always sets it; absent on an older core.