@usine/core/attempt/channel

Classes

Cancel

Stops the entire Attempt, including every held or paused session. Used by cancellation and guardrails.

Extends

• Schema.Class

Constructors

Constructor

new Cancel(…args): Cancel

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

Cancel

---

ChildTarget

A harness child of the Attempt’s parent, addressed by the id it reports in the normalized event stream.

Extends

• Schema.Class

Constructors

Constructor

new ChildTarget(…args): ChildTarget

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

ChildTarget

Properties

sessionId

readonly sessionId: string & Brand<"AgentSessionId">

---

Failed

Extends

• Schema.Class

Constructors

Constructor

new Failed(…args): Failed

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

Failed

Properties

failure

readonly failure: InfraFailure | DefectFailure | AgentFailure | RunawayFailure | ChildSessionBudgetFailure

---

Final

Extends

• Schema.Class

Constructors

Constructor

new Final(…args): Final

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

Final

Properties

result

readonly result: StepResult

---

InboundEnvelope

Extends

• Schema.Class

Constructors

Constructor

new InboundEnvelope(…args): InboundEnvelope

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

InboundEnvelope

Properties

attemptId

readonly attemptId: string & Brand<"AttemptId">

operator

readonly operator: string

payload

readonly payload: Steer | Interrupt | OperatorMessage | Release | Cancel

sentAt

readonly sentAt: Utc

sequence

readonly sequence: number & Brand<"AttemptChannelSequence">

target

readonly target: ParentTarget | ChildTarget

The session this envelope addresses; the Pi parent unless a child is named.

version

readonly version: 7

---

Interrupt

Extends

• Schema.Class

Constructors

Constructor

new Interrupt(…args): Interrupt

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

Interrupt

---

Interrupted

The Attempt’s parent acknowledged cancellation. Terminal.

Extends

• Schema.Class

Constructors

Constructor

new Interrupted(…args): Interrupted

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

Interrupted

---

Intervention

Attributed operator input addressed to one live session, never an Event.

Extends

• Schema.Class

Constructors

Constructor

new Intervention(…args): Intervention

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

Intervention

Properties

action

readonly action: Steer | Interrupt | OperatorMessage | Release

operator

readonly operator: string

target

readonly target: ParentTarget | ChildTarget

---

InterventionApplied

Acknowledges delivery and records the resulting Hold or pause in the transcript.

Extends

• Schema.Class

Constructors

Constructor

new InterventionApplied(…args): InterventionApplied

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

InterventionApplied

Properties

inputSequence

readonly inputSequence: number & Brand<"AttemptChannelSequence">

intervention

readonly intervention: Intervention

state

readonly state: InterventionState

---

InterventionRejected

A session closed or refused an operator action; the Attempt itself continues.

Extends

• Schema.Class

Constructors

Constructor

new InterventionRejected(…args): InterventionRejected

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

InterventionRejected

Properties

inputSequence

readonly inputSequence: number & Brand<"AttemptChannelSequence">

intervention

readonly intervention: Intervention

message

readonly message: string

---

InterventionState

The session’s supervision state after an accepted operator action.

Extends

• Schema.Class

Constructors

Constructor

new InterventionState(…args): InterventionState

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

InterventionState

Properties

held

readonly held: boolean

paused

readonly paused: boolean

---

OperatorMessage

An operator turn joined to the target session, distinct from a Steer so a takeover can record and hold it (ADR 0018).

Extends

• Schema.Class

Constructors

Constructor

new OperatorMessage(…args): OperatorMessage

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

OperatorMessage

Properties

message

readonly message: string

---

OutboundEnvelope

Extends

• Schema.Class

Constructors

Constructor

new OutboundEnvelope(…args): OutboundEnvelope

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

OutboundEnvelope

Properties

attemptId

readonly attemptId: string & Brand<"AttemptId">

payload

readonly payload: Started | SessionEvent | Final | Failed | Interrupted | InterventionApplied | InterventionRejected

sentAt

readonly sentAt: Utc

sequence

readonly sequence: number & Brand<"AttemptChannelSequence">

version

readonly version: 7

---

ParentTarget

The Pi parent, the default recipient of operator input for an Attempt.

Extends

• Schema.Class

Constructors

Constructor

new ParentTarget(…args): ParentTarget

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

ParentTarget

---

Release

Ends a held child’s takeover, letting its idle result return to the awaiting parent (ADR 0018).

Extends

• Schema.Class

Constructors

Constructor

new Release(…args): Release

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

Release

---

RunSpec

Launch input for one Attempt. Worker credentials are never part of it.

Extends

• Schema.Class

Constructors

Constructor

new RunSpec(…args): RunSpec

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

RunSpec

Properties

agent

readonly agent: Agent

attemptId

readonly attemptId: string & Brand<"AttemptId">

baseCommit

readonly baseCommit: string & Brand<"CommitSha">

maxChildren

readonly maxChildren: number & Brand<"ChildSessionBudget">

parentEffort

readonly parentEffort: "off" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max"

parentModel

readonly parentModel: Option<string & Brand<"ModelId">>

payload

readonly payload: Json

repository

readonly repository: string & Brand<"RepositoryName">

resume

readonly resume: Option<SalvagePushed>

The previous Attempt’s pushed salvage checked out in this workspace; the agent continues from it.

revision

readonly revision: string & Brand<"RepositoryRevision">

task

readonly task: string & Brand<"AttemptTask">

---

SessionEvent

One normalized parent or child session event, persisted in the Attempt transcript.

Extends

• Schema.Class

Constructors

Constructor

new SessionEvent(…args): SessionEvent

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

SessionEvent

Properties

event

readonly event: SessionStarted | TextOutput | ToolStarted | ToolFinished | PoolRateLimitsUpdated | SessionFinished | SessionIdle | SessionResumed | SessionTokensUpdated

---

Started

The parent model the SDK selected at launch, which the roster may not declare. Child sessions report their own model in SessionStarted events.

Extends

• Schema.Class

Constructors

Constructor

new Started(…args): Started

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

Started

Properties

parentModel

readonly parentModel: string & Brand<"ModelId">

---

Steer

Extends

• Schema.Class

Constructors

Constructor

new Steer(…args): Steer

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

Steer

Properties

message

readonly message: string

Interfaces

Progress

How far one outbound channel has legally progressed.

Properties

nextSequence

readonly nextSequence: number

state

readonly state: "AwaitingStarted" | "Running" | "Terminal"

---

Sink

Where a channel consumer persists envelopes and the executor’s salvage record.

Properties

append

readonly append: (direction, envelope) => Effect<void, InfraFailure | DefectFailure | AgentFailure | RunawayFailure | ChildSessionBudgetFailure>

Parameters

Parameter	Type
direction	"inbound" | "outbound"
envelope	OutboundEnvelope | InboundEnvelope

Returns

Effect<void, InfraFailure | DefectFailure | AgentFailure | RunawayFailure | ChildSessionBudgetFailure>

salvage

readonly salvage: (salvage) => Effect<void, InfraFailure | DefectFailure | AgentFailure | RunawayFailure | ChildSessionBudgetFailure>

Records what the executor preserved of the workspace after the Attempt ended without success.

Parameters

Parameter	Type
salvage	SalvagePushed | SalvageRetained

Returns

Effect<void, InfraFailure | DefectFailure | AgentFailure | RunawayFailure | ChildSessionBudgetFailure>

---

Violation

One protocol violation, described for the infra failure that reports it.

Properties

detail

readonly detail: string

message

readonly message: string

Type Aliases

Direction

Direction = typeof Direction.Type

---

Envelope

Envelope = typeof Envelope.Type

---

InboundPayload

InboundPayload = typeof InboundPayload.Type

---

OperatorAction

OperatorAction = typeof OperatorAction.Type

Nonterminal operator controls; cancellation is an Attempt operation.

---

OutboundPayload

OutboundPayload = typeof OutboundPayload.Type

---

Sequence

Sequence = typeof Sequence.Type

Per-Attempt, per-direction message sequence, starting at 1. Distinct from the engine’s transcript sequence, which orders persisted rows globally.

---

SessionTarget

SessionTarget = typeof SessionTarget.Type

Which session inside an Attempt an inbound envelope addresses: the Pi parent, or one of its children.

Variables

admit

const admit: (progress, attemptId, envelope) => Result.Result<Progress, Violation>

Checks one outbound envelope against the progress so far and returns the next progress, or the violation. Whatever sends outbound envelopes folds each one through it before appending it.

Parameters

Parameter	Type
progress	Progress
attemptId	AttemptId
envelope	OutboundEnvelope

Returns

Result.Result<Progress, Violation>

---

Direction

const Direction: Schema.Literals<readonly ["inbound", "outbound"]>

---

DIRECTIONS

const DIRECTIONS: readonly ["inbound", "outbound"]

Relative to the Attempt’s parent: inbound envelopes carry operator input and Cancel to it, and outbound envelopes carry its activity and outcome.

---

Envelope

const Envelope: Schema.Union<readonly [typeof OutboundEnvelope, typeof InboundEnvelope]>

---

InboundPayload

const InboundPayload: Schema.Union<readonly [Schema.Union<readonly [typeof Steer, typeof Interrupt, typeof OperatorMessage, typeof Release]>, typeof Cancel]>

---

initialProgress

const initialProgress: Progress

---

OperatorAction

const OperatorAction: Schema.Union<readonly [typeof Steer, typeof Interrupt, typeof OperatorMessage, typeof Release]>

Nonterminal operator controls; cancellation is an Attempt operation.

---

OutboundPayload

const OutboundPayload: Schema.Union<readonly [typeof Started, typeof SessionEvent, typeof Final, typeof Failed, typeof Interrupted, typeof InterventionApplied, typeof InterventionRejected]>

---

PROTOCOL_VERSION

const PROTOCOL_VERSION: 7

---

Sequence

const Sequence: Schema.brand<Schema.Int, "AttemptChannelSequence">

Per-Attempt, per-direction message sequence, starting at 1. Distinct from the engine’s transcript sequence, which orders persisted rows globally.

---

SessionTarget

const SessionTarget: Schema.Union<readonly [typeof ParentTarget, typeof ChildTarget]>

Which session inside an Attempt an inbound envelope addresses: the Pi parent, or one of its children.