Skip to content
usine

@usine/orchestrator/operator

Classes

Section titled “Classes”

AgentFailureView

Section titled “AgentFailureView”

An agent failure message safe to display to the operator.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new AgentFailureView(…args): AgentFailureView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

AgentFailureView

Properties

Section titled “Properties”

message
Section titled “message”

readonly message: string

ApprovalNeed

Section titled “ApprovalNeed”

An operator approval is required before this Run can proceed.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new ApprovalNeed(…args): ApprovalNeed

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

ApprovalNeed

Properties

Section titled “Properties”

id
Section titled “id”

readonly id: string

loop
Section titled “loop”

readonly loop: string & Brand<"LoopName">

repository
Section titled “repository”

readonly repository: string & Brand<"RepositoryName">

runId
Section titled “runId”

readonly runId: string & Brand<"RunId">

AttemptView

Section titled “AttemptView”

One Attempt’s identity, Worker, effective brain, start time, optional terminal outcome, and salvaged work.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new AttemptView(…args): AttemptView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

AttemptView

Properties

Section titled “Properties”

agent
Section titled “agent”

readonly agent: string & Brand<"AgentName">

brain
Section titled “brain”

readonly brain: BrainSpec

id
Section titled “id”

readonly id: string & Brand<"AttemptId">

number
Section titled “number”

readonly number: number & Brand<"AttemptNumber">

operatorIntervened
Section titled “operatorIntervened”

readonly operatorIntervened: boolean

outcome
Section titled “outcome”

readonly outcome: SucceededAttemptView | FailedAttemptView | CanceledAttemptView | null

salvage
Section titled “salvage”

readonly salvage: SalvagePushed | SalvageRetained | null

startedAt
Section titled “startedAt”

readonly startedAt: string

task
Section titled “task”

readonly task: string & Brand<"AttemptTask">

worker
Section titled “worker”

readonly worker: string & Brand<"WorkerName">

Section titled “BoardItemLink”

An Item linked to a Task, with its own title and external destination.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new BoardItemLink(…args): BoardItemLink

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

BoardItemLink

Properties

Section titled “Properties”

itemKey
Section titled “itemKey”

readonly itemKey: string & Brand<"ItemKey">

kind
Section titled “kind”

readonly kind: "issue" | "pr"

number
Section titled “number”

readonly number: number & Brand<"ItemNumber">

title
Section titled “title”

readonly title: string

url
Section titled “url”

readonly url: string

BoardItemNotFoundError

Section titled “BoardItemNotFoundError”

The requested Item is absent from the Project’s Board.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new BoardItemNotFoundError(…args): BoardItemNotFoundError

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

BoardItemNotFoundError

Properties

Section titled “Properties”

item
Section titled “item”

readonly item: number & Brand<"ItemNumber">

repository
Section titled “repository”

readonly repository: string & Brand<"RepositoryName">

BoardLaneNotFoundError

Section titled “BoardLaneNotFoundError”

The requested destination lane is absent from the Project’s Board.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new BoardLaneNotFoundError(…args): BoardLaneNotFoundError

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

BoardLaneNotFoundError

Properties

Section titled “Properties”

lane
Section titled “lane”

readonly lane: string & Brand<"BoardLaneId">

repository
Section titled “repository”

readonly repository: string & Brand<"RepositoryName">

BoardLaneReadOnlyError

Section titled “BoardLaneReadOnlyError”

The requested destination lane does not accept label-based moves.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new BoardLaneReadOnlyError(…args): BoardLaneReadOnlyError

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

BoardLaneReadOnlyError

Properties

Section titled “Properties”

lane
Section titled “lane”

readonly lane: string & Brand<"BoardLaneId">

repository
Section titled “repository”

readonly repository: string & Brand<"RepositoryName">

BoardMove

Section titled “BoardMove”

An operator request to move one Project Item into a destination lane.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new BoardMove(…args): BoardMove

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

BoardMove

Properties

Section titled “Properties”

item
Section titled “item”

readonly item: number & Brand<"ItemNumber">

repository
Section titled “repository”

readonly repository: string & Brand<"RepositoryName">

toLane
Section titled “toLane”

readonly toLane: string & Brand<"BoardLaneId">

BoardProjectionError

Section titled “BoardProjectionError”

An Item projection could not produce a Board card; other Items remain available.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new BoardProjectionError(…args): BoardProjectionError

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

BoardProjectionError

Properties

Section titled “Properties”

itemKey
Section titled “itemKey”

readonly itemKey: string & Brand<"ItemKey">

message
Section titled “message”

readonly message: string

repository
Section titled “repository”

readonly repository: string & Brand<"RepositoryName">

BoardProjectionNeed

Section titled “BoardProjectionNeed”

An Item could not be displayed on its Board and needs operator attention.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new BoardProjectionNeed(…args): BoardProjectionNeed

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

BoardProjectionNeed

Properties

Section titled “Properties”

failure
Section titled “failure”

readonly failure: BoardProjectionError

id
Section titled “id”

readonly id: string

BoardProjectNotFoundError

Section titled “BoardProjectNotFoundError”

The requested Project is absent from the operator overview.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new BoardProjectNotFoundError(…args): BoardProjectNotFoundError

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

BoardProjectNotFoundError

Properties

Section titled “Properties”

repository
Section titled “repository”

readonly repository: string & Brand<"RepositoryName">

BoardTaskView

Section titled “BoardTaskView”

A Task projected from linked Items. The current Item determines the key, lane, labels, and move destination; the first issue supplies the Task title.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new BoardTaskView(…args): BoardTaskView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

BoardTaskView

Properties

Section titled “Properties”

conflicting
Section titled “conflicting”

readonly conflicting: boolean

The current Item is an open pull request whose branch conflicts with its base.

itemKey
Section titled “itemKey”

readonly itemKey: string & Brand<"ItemKey">

items
Section titled “items”

readonly items: readonly BoardItemLink[]

kind
Section titled “kind”

readonly kind: "issue" | "pr"

labels
Section titled “labels”

readonly labels: readonly (string & Brand<"GitHubLabelName">)[]

needsYou
Section titled “needsYou”

readonly needsYou: boolean

number
Section titled “number”

readonly number: number & Brand<"ItemNumber">

run
Section titled “run”

readonly run: RunView | null

runs
Section titled “runs”

readonly runs: readonly RunView[]

Every saved Run for the visible Items, ordered from earliest to latest.

state
Section titled “state”

readonly state: "issue-open" | "issue-closed" | "pr-open" | "pr-closed" | "pr-merged"

title
Section titled “title”

readonly title: string

url
Section titled “url”

readonly url: string

BoardView

Section titled “BoardView”

The Project’s lanes and the Item failures encountered while constructing their cards.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new BoardView(…args): BoardView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

BoardView

Properties

Section titled “Properties”

failures
Section titled “failures”

readonly failures: readonly BoardProjectionError[]

lanes
Section titled “lanes”

readonly lanes: readonly (WritableBoardLaneView | ReadOnlyBoardLaneView)[]

CanceledAttemptView

Section titled “CanceledAttemptView”

An Attempt that ended after cancellation.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new CanceledAttemptView(…args): CanceledAttemptView

Parameters
Section titled “Parameters”
Parameter Type
…args [props?: object, options?: MakeOptions]
Returns
Section titled “Returns”

CanceledAttemptView

ChildSessionBudgetFailureView

Section titled “ChildSessionBudgetFailureView”

The configured child-session budget and the spawn count that exceeded it.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new ChildSessionBudgetFailureView(…args): ChildSessionBudgetFailureView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

ChildSessionBudgetFailureView

Properties

Section titled “Properties”

attemptedChildren
Section titled “attemptedChildren”

readonly attemptedChildren: number & Brand<"ChildSessionCount">

maxChildren
Section titled “maxChildren”

readonly maxChildren: number & Brand<"ChildSessionBudget">

ColdTranscriptRequest

Section titled “ColdTranscriptRequest”

Requests the newest bounded transcript window when opening a Run.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new ColdTranscriptRequest(…args): ColdTranscriptRequest

Parameters
Section titled “Parameters”
Parameter Type
…args [props?: object, options?: MakeOptions]
Returns
Section titled “Returns”

ColdTranscriptRequest

CycleBudgetNeed

Section titled “CycleBudgetNeed”

An Item stopped opening Runs and requires an explicit reset of its shared cycle budget.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new CycleBudgetNeed(…args): CycleBudgetNeed

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

CycleBudgetNeed

Properties

Section titled “Properties”

ask
Section titled “ask”

readonly ask: CycleBudgetAsk

id
Section titled “id”

readonly id: string

itemLabel
Section titled “itemLabel”

readonly itemLabel: string

itemUrl
Section titled “itemUrl”

readonly itemUrl: string | null

DefectFailureView

Section titled “DefectFailureView”

A captured programmer defect requiring operator intervention; the original cause stays behind this boundary.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new DefectFailureView(…args): DefectFailureView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

DefectFailureView

Properties

Section titled “Properties”

message
Section titled “message”

readonly message: string

EarlierTranscriptRequest

Section titled “EarlierTranscriptRequest”

Requests an earlier page before a sequence within one Attempt.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new EarlierTranscriptRequest(…args): EarlierTranscriptRequest

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

EarlierTranscriptRequest

Properties

Section titled “Properties”

attemptId
Section titled “attemptId”

readonly attemptId: string & Brand<"AttemptId">

before
Section titled “before”

readonly before: number & Brand<"TranscriptSequence">

EditAndRetry

Section titled “EditAndRetry”

The operator’s replacement task and selected roster member; the server derives the Agent’s persona and brain.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new EditAndRetry(…args): EditAndRetry

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

EditAndRetry

Properties

Section titled “Properties”

agent
Section titled “agent”

readonly agent: string & Brand<"AgentName">

task
Section titled “task”

readonly task: string & Brand<"AttemptTask">

FailedAttemptView

Section titled “FailedAttemptView”

An Attempt that ended with a failure the operator can inspect.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new FailedAttemptView(…args): FailedAttemptView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

FailedAttemptView

Properties

Section titled “Properties”

failure
Section titled “failure”

readonly failure: InfraFailureView | DefectFailureView | AgentFailureView | RunawayFailureView | ChildSessionBudgetFailureView

FailedTranscriptView

Section titled “FailedTranscriptView”

An Attempt failure recorded in the transcript with displayable details only.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new FailedTranscriptView(…args): FailedTranscriptView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

FailedTranscriptView

Properties

Section titled “Properties”

failure
Section titled “failure”

readonly failure: InfraFailureView | DefectFailureView | AgentFailureView | RunawayFailureView | ChildSessionBudgetFailureView

InfraFailureView

Section titled “InfraFailureView”

An infra failure as the operator sees it; the defect cause stays behind this boundary.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new InfraFailureView(…args): InfraFailureView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

InfraFailureView

Properties

Section titled “Properties”

message
Section titled “message”

readonly message: string

LabelView

Section titled “LabelView”

A repository label as GitHub shows it. Color is null for catalogs stored before colors were kept.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new LabelView(…args): LabelView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

LabelView

Properties

Section titled “Properties”

color
Section titled “color”

readonly color: string | null

description
Section titled “description”

readonly description: string | null

name
Section titled “name”

readonly name: string & Brand<"GitHubLabelName">

LoopView

Section titled “LoopView”

A Loop’s authored trigger and Agent together with its runtime pause state.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new LoopView(…args): LoopView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

LoopView

Properties

Section titled “Properties”

agent
Section titled “agent”

readonly agent: string & Brand<"AgentName">

name
Section titled “name”

readonly name: string & Brand<"LoopName">

paused
Section titled “paused”

readonly paused: boolean

trigger
Section titled “trigger”

readonly trigger: string

NeedsSetupOverview

Section titled “NeedsSetupOverview”

An overview available during setup, including the error that prevents normal operation.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new NeedsSetupOverview(…args): NeedsSetupOverview

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

NeedsSetupOverview

Properties

Section titled “Properties”

errorTag
Section titled “errorTag”

readonly errorTag: string

loops
Section titled “loops”

readonly loops: readonly LoopView[]

needsYou
Section titled “needsYou”

readonly needsYou: readonly (CycleBudgetNeed | ApprovalNeed | BoardProjectionNeed | RunFailureNeed | PollFailureNeed | PreflightFindingNeed | ScheduleFailureNeed)[]

projects
Section titled “projects”

readonly projects: readonly ProjectView[]

Operator

Section titled “Operator”

The operator’s view of the factory and actions for approving, retrying, canceling, and directing work.

Extends

Section titled “Extends”
  • Context.ServiceClass

Properties

Section titled “Properties”

Service
Section titled “Service”

readonly Service: object & object

The service’s operations: what yield* Operator returns.

Type Declaration
Section titled “Type Declaration”
detail
Section titled “detail”

readonly detail: (runId, request?) => Effect.Effect<RunDetailView, OperatorObservationError>

Reads one Run and a bounded transcript page; request selects the latest, newer, or earlier activity.

Parameters
Section titled “Parameters”
Parameter Type
runId RunId
request? TranscriptRequest
Returns
Section titled “Returns”

Effect.Effect<RunDetailView, OperatorObservationError>

overview
Section titled “overview”

readonly overview: (instance) => Effect.Effect<ReadyOverview, OperatorObservationError>

Builds the supplied instance’s Projects, Boards, Runs, and items needing operator attention.

Parameters
Section titled “Parameters”
Parameter Type
instance LoadedInstance
Returns
Section titled “Returns”

Effect.Effect<ReadyOverview, OperatorObservationError>

approve
Section titled “approve”

readonly approve: (runId) => Effect.Effect<void, OperatorError>

Records approval for a waiting Run; execution still waits for Worker capacity.

Parameters
Section titled “Parameters”
Parameter Type
runId RunId
Returns
Section titled “Returns”

Effect.Effect<void, OperatorError>

cancel
Section titled “cancel”

readonly cancel: (runId) => Effect.Effect<void, OperatorError>

Cancels an open Run and interrupts its current Attempt; an already closed Run is unchanged.

Parameters
Section titled “Parameters”
Parameter Type
runId RunId
Returns
Section titled “Returns”

Effect.Effect<void, OperatorError>

editAndRetry
Section titled “editAndRetry”

readonly editAndRetry: (instance, runId, edit) => Effect.Effect<void, OperatorError>

Atomically amends a failed Run before requesting its next Attempt.

Parameters
Section titled “Parameters”
Parameter Type
instance LoadedInstance
runId RunId
edit EditAndRetry
Returns
Section titled “Returns”

Effect.Effect<void, OperatorError>

intervene
Section titled “intervene”

readonly intervene: (instance, runId, input) => Effect.Effect<void, OperatorError>

Delivers an attributed action through a live session’s Attempt channel.

Parameters
Section titled “Parameters”
Parameter Type
instance LoadedInstance
runId RunId
input SessionIntervention
Returns
Section titled “Returns”

Effect.Effect<void, OperatorError>

moveBoardItem
Section titled “moveBoardItem”

readonly moveBoardItem: (instance, move) => Effect.Effect<void, BoardMoveError>

Swaps lane labels on GitHub and hints an authoritative refresh of its Board position and Loop matches.

Parameters
Section titled “Parameters”
Parameter Type
instance LoadedInstance
move BoardMove
Returns
Section titled “Returns”

Effect.Effect<void, BoardMoveError>

pause
Section titled “pause”

readonly pause: (loop) => Effect.Effect<LoopRuntimeState, EnginePersistenceError>

Pauses new work for a Loop while its existing Runs continue.

Parameters
Section titled “Parameters”
Parameter Type
loop LoopName
Returns
Section titled “Returns”

Effect.Effect<LoopRuntimeState, EnginePersistenceError>

resetCycleBudget
Section titled “resetCycleBudget”

readonly resetCycleBudget: (askId) => Effect.Effect<void, OperatorError>

Answers the Item’s current cycle Ask; polling refreshes its state before more Runs open.

Parameters
Section titled “Parameters”
Parameter Type
askId CycleBudgetAskId
Returns
Section titled “Returns”

Effect.Effect<void, OperatorError>

resolveFailure
Section titled “resolveFailure”

readonly resolveFailure: (runId, attemptId) => Effect.Effect<void, OperatorError>

Resolves attention for the failed Attempt displayed to the operator; stale requests are rejected.

Parameters
Section titled “Parameters”
Parameter Type
runId RunId
attemptId AttemptId
Returns
Section titled “Returns”

Effect.Effect<void, OperatorError>

retry
Section titled “retry”

readonly retry: (runId) => Effect.Effect<void, OperatorError>

Requests a new Attempt for a failed Run using its effective task and Agent.

Parameters
Section titled “Parameters”
Parameter Type
runId RunId
Returns
Section titled “Returns”

Effect.Effect<void, OperatorError>

unpause
Section titled “unpause”

readonly unpause: (loop) => Effect.Effect<LoopRuntimeState, EnginePersistenceError>

Allows the Loop’s triggers to open new Runs again.

Parameters
Section titled “Parameters”
Parameter Type
loop LoopName
Returns
Section titled “Returns”

Effect.Effect<LoopRuntimeState, EnginePersistenceError>

layer
Section titled “layer”

readonly static layer: Layer<Operator, never, CycleBudgets | RunEngine | ItemProjectionReader | LoopControl | RepositoryLabelProjectionReader | RunReader | GitHubItemWriter | PollingTriggers | ScheduleTriggers>

OperatorObservation

Section titled “OperatorObservation”

The read-only operator surface. It needs no trigger execution to build.

Extends

Section titled “Extends”
  • Context.ServiceClass

Properties

Section titled “Properties”

Service
Section titled “Service”

readonly Service: object

The service’s operations: what yield* OperatorObservation returns.

detail
Section titled “detail”

readonly detail: (runId, request?) => Effect.Effect<RunDetailView, OperatorObservationError>

Reads one Run and a bounded transcript page; request selects the latest, newer, or earlier activity.

Parameters
Section titled “Parameters”
Parameter Type
runId RunId
request? TranscriptRequest
Returns
Section titled “Returns”

Effect.Effect<RunDetailView, OperatorObservationError>

overview
Section titled “overview”

readonly overview: (instance) => Effect.Effect<ReadyOverview, OperatorObservationError>

Builds the supplied instance’s Projects, Boards, Runs, and items needing operator attention.

Parameters
Section titled “Parameters”
Parameter Type
instance LoadedInstance
Returns
Section titled “Returns”

Effect.Effect<ReadyOverview, OperatorObservationError>

layer
Section titled “layer”

readonly static layer: Layer<OperatorObservation, never, CycleBudgets | ItemProjectionReader | LoopControl | RepositoryLabelProjectionReader | RunReader | PollingTriggers | ScheduleTriggers>

PollFailureNeed

Section titled “PollFailureNeed”

Repository polling failed and needs operator attention.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new PollFailureNeed(…args): PollFailureNeed

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

PollFailureNeed

Properties

Section titled “Properties”

failure
Section titled “failure”

readonly failure: RepositoryPollFailure

id
Section titled “id”

readonly id: string

PreflightFindingNeed

Section titled “PreflightFindingNeed”

A declared repository label could not be provisioned or confirmed.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new PreflightFindingNeed(…args): PreflightFindingNeed

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

PreflightFindingNeed

Properties

Section titled “Properties”

finding
Section titled “finding”

readonly finding: LabelPreflightFinding

id
Section titled “id”

readonly id: string

ProjectView

Section titled “ProjectView”

A managed repository with its Runs, Board, label catalog, and preflight findings.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new ProjectView(…args): ProjectView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

ProjectView

Properties

Section titled “Properties”

board
Section titled “board”

readonly board: BoardView

labels
Section titled “labels”

readonly labels: readonly LabelView[]

The repository’s label catalog, used to color badges on cards and lanes.

preflightFindings
Section titled “preflightFindings”

readonly preflightFindings: readonly LabelPreflightFinding[]

Failures from provisioning this Project’s declared labels; they do not block the Board.

repository
Section titled “repository”

readonly repository: string & Brand<"RepositoryName">

runs
Section titled “runs”

readonly runs: readonly RunView[]

status
Section titled “status”

readonly status: "clear" | "active" | "needs-you"

ReadOnlyBoardLaneView

Section titled “ReadOnlyBoardLaneView”

A lane that groups Items without accepting label-based moves.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new ReadOnlyBoardLaneView(…args): ReadOnlyBoardLaneView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

ReadOnlyBoardLaneView

Properties

Section titled “Properties”

id
Section titled “id”

readonly id: string & Brand<"BoardLaneId">

items
Section titled “items”

readonly items: readonly BoardTaskView[]

name
Section titled “name”

readonly name: string & Brand<"LaneName">

origin
Section titled “origin”

readonly origin: "authored" | "proposed" | "fallback"

sources
Section titled “sources”

readonly sources: readonly (LabelLaneSource | StateLaneSource)[]

ReadyOverview

Section titled “ReadyOverview”

The Projects, Loops, and operator needs of a configured factory.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new ReadyOverview(…args): ReadyOverview

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

ReadyOverview

Properties

Section titled “Properties”

loops
Section titled “loops”

readonly loops: readonly LoopView[]

needsYou
Section titled “needsYou”

readonly needsYou: readonly (CycleBudgetNeed | ApprovalNeed | BoardProjectionNeed | RunFailureNeed | PollFailureNeed | PreflightFindingNeed | ScheduleFailureNeed)[]

projects
Section titled “projects”

readonly projects: readonly ProjectView[]

RosterAgentNotFoundError

Section titled “RosterAgentNotFoundError”

The requested Agent is absent from the loaded instance roster.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new RosterAgentNotFoundError(…args): RosterAgentNotFoundError

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

RosterAgentNotFoundError

Properties

Section titled “Properties”

agent
Section titled “agent”

readonly agent: string & Brand<"AgentName">

message
Section titled “message”

readonly message: string

RunawayFailureView

Section titled “RunawayFailureView”

The wall-clock or token ceiling that stopped an Attempt.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new RunawayFailureView(…args): RunawayFailureView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

RunawayFailureView

Properties

Section titled “Properties”

ceiling
Section titled “ceiling”

readonly ceiling: "wall-clock" | "tokens"

RunDetailView

Section titled “RunDetailView”

A Run summary with its triggering Event payload and a bounded portion of its transcript.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new RunDetailView(…args): RunDetailView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

RunDetailView

Properties

Section titled “Properties”

earlierTranscript
Section titled “earlierTranscript”

readonly earlierTranscript: readonly TranscriptPageCursor[]

eventDedupKey
Section titled “eventDedupKey”

readonly eventDedupKey: string

eventPayload
Section titled “eventPayload”

readonly eventPayload: Json

run
Section titled “run”

readonly run: RunView

sessionState
Section titled “sessionState”

readonly sessionState: readonly TranscriptEventView[]

Current session controls remain available when their last activity predates the transcript page.

transcript
Section titled “transcript”

readonly transcript: readonly TranscriptEventView[]

RunFailureNeed

Section titled “RunFailureNeed”

A failed Run requires an operator decision, with its displayable failure details.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new RunFailureNeed(…args): RunFailureNeed

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

RunFailureNeed

Properties

Section titled “Properties”

failure
Section titled “failure”

readonly failure: InfraFailureView | DefectFailureView | AgentFailureView | RunawayFailureView | ChildSessionBudgetFailureView

id
Section titled “id”

readonly id: string

loop
Section titled “loop”

readonly loop: string & Brand<"LoopName">

repository
Section titled “repository”

readonly repository: string & Brand<"RepositoryName">

runId
Section titled “runId”

readonly runId: string & Brand<"RunId">

RunView

Section titled “RunView”

A Run summary with its Attempts, result links, and currently available operator actions.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new RunView(…args): RunView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

RunView

Properties

Section titled “Properties”

agent
Section titled “agent”

readonly agent: string & Brand<"AgentName">

attempts
Section titled “attempts”

readonly attempts: readonly AttemptView[]

canApprove
Section titled “canApprove”

readonly canApprove: boolean

canCancel
Section titled “canCancel”

readonly canCancel: boolean

canResolveFailure
Section titled “canResolveFailure”

readonly canResolveFailure: boolean

The latest failed Attempt still requests attention; retry availability is independent.

canRetry
Section titled “canRetry”

readonly canRetry: boolean

id
Section titled “id”

readonly id: string & Brand<"RunId">

itemKey
Section titled “itemKey”

readonly itemKey: string & Brand<"ItemKey">

loop
Section titled “loop”

readonly loop: string & Brand<"LoopName">

loopPaused
Section titled “loopPaused”

readonly loopPaused: boolean

openedAt
Section titled “openedAt”

readonly openedAt: string

pullRequestUrl
Section titled “pullRequestUrl”

readonly pullRequestUrl: string | null

repository
Section titled “repository”

readonly repository: string & Brand<"RepositoryName">

resultMessage
Section titled “resultMessage”

readonly resultMessage: string | null

state
Section titled “state”

readonly state: "Succeeded" | "Failed" | "Canceled" | "Running" | "Pending" | "Waiting" | "Queued"

task
Section titled “task”

readonly task: string

ScheduleFailureNeed

Section titled “ScheduleFailureNeed”

A scheduled Loop could not evaluate or submit its work.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new ScheduleFailureNeed(…args): ScheduleFailureNeed

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

ScheduleFailureNeed

Properties

Section titled “Properties”

failure
Section titled “failure”

readonly failure: ScheduleAgentFailure | ScheduleTickFailure | ScheduleCronFailure

id
Section titled “id”

readonly id: string

SessionIntervention

Section titled “SessionIntervention”

An action for a specific live Attempt and session, so stale controls cannot target a new Attempt.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new SessionIntervention(…args): SessionIntervention

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

SessionIntervention

Properties

Section titled “Properties”

action
Section titled “action”

readonly action: Steer | Interrupt | OperatorMessage | Release

attemptId
Section titled “attemptId”

readonly attemptId: string & Brand<"AttemptId">

target
Section titled “target”

readonly target: ParentTarget | ChildTarget

SucceededAttemptView

Section titled “SucceededAttemptView”

An Attempt that completed successfully.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new SucceededAttemptView(…args): SucceededAttemptView

Parameters
Section titled “Parameters”
Parameter Type
…args [props?: object, options?: MakeOptions]
Returns
Section titled “Returns”

SucceededAttemptView

TailTranscriptRequest

Section titled “TailTranscriptRequest”

Requests transcript events after the last observed sequence.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new TailTranscriptRequest(…args): TailTranscriptRequest

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

TailTranscriptRequest

Properties

Section titled “Properties”

after
Section titled “after”

readonly after: number & Brand<"TranscriptSequence">

TranscriptAttemptNotFoundError

Section titled “TranscriptAttemptNotFoundError”

The requested Attempt is absent from the Run whose transcript is being read.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new TranscriptAttemptNotFoundError(…args): TranscriptAttemptNotFoundError

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

TranscriptAttemptNotFoundError

Properties

Section titled “Properties”

attemptId
Section titled “attemptId”

readonly attemptId: string & Brand<"AttemptId">

runId
Section titled “runId”

readonly runId: string & Brand<"RunId">

TranscriptEventView

Section titled “TranscriptEventView”

A persisted Attempt channel message with its sequence, direction, and receipt time.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new TranscriptEventView(…args): TranscriptEventView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

TranscriptEventView

Properties

Section titled “Properties”

attemptId
Section titled “attemptId”

readonly attemptId: string & Brand<"AttemptId">

direction
Section titled “direction”

readonly direction: "inbound" | "outbound"

operator?
Section titled “operator?”

readonly optional operator?: string

payload
Section titled “payload”

readonly payload: Steer | Interrupt | OperatorMessage | Release | Started | SessionEvent | Final | Interrupted | Cancel | InterventionApplied | InterventionRejected | FailedTranscriptView

receivedAt
Section titled “receivedAt”

readonly receivedAt: string

sequence
Section titled “sequence”

readonly sequence: number & Brand<"TranscriptSequence">

target?
Section titled “target?”

readonly optional target?: ParentTarget | ChildTarget

TranscriptPageCursor

Section titled “TranscriptPageCursor”

Where the next earlier transcript page starts, scoped to one Attempt.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new TranscriptPageCursor(…args): TranscriptPageCursor

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

TranscriptPageCursor

Properties

Section titled “Properties”

attemptId
Section titled “attemptId”

readonly attemptId: string & Brand<"AttemptId">

before
Section titled “before”

readonly before: number & Brand<"TranscriptSequence">

WritableBoardLaneView

Section titled “WritableBoardLaneView”

An authored lane the operator can move Items into by applying its configured GitHub labels.

Extends

Section titled “Extends”
  • Schema.Class

Constructors

Section titled “Constructors”

Constructor
Section titled “Constructor”

new WritableBoardLaneView(…args): WritableBoardLaneView

Parameters
Section titled “Parameters”
Parameter Type
…args [props: object, options?: MakeOptions]
Returns
Section titled “Returns”

WritableBoardLaneView

Properties

Section titled “Properties”

id
Section titled “id”

readonly id: string & Brand<"BoardLaneId">

items
Section titled “items”

readonly items: readonly BoardTaskView[]

labels
Section titled “labels”

readonly labels: readonly (string & Brand<"GitHubLabelName">)[]

name
Section titled “name”

readonly name: string & Brand<"LaneName">

origin
Section titled “origin”

readonly origin: "authored"

sources
Section titled “sources”

readonly sources: readonly (LabelLaneSource | StateLaneSource)[]

Type Aliases

Section titled “Type Aliases”

AttemptOutcomeView

Section titled “AttemptOutcomeView”

AttemptOutcomeView = typeof AttemptOutcomeView.Type

The terminal outcome displayed for an Attempt; a live Attempt has no outcome.

BoardLaneId

Section titled “BoardLaneId”

BoardLaneId = typeof BoardLaneId.Type

Identifies a lane within a Project’s Board for operator moves.

BoardLaneOrigin

Section titled “BoardLaneOrigin”

BoardLaneOrigin = typeof BoardLaneOrigin.Type

Whether a lane came from authored settings, a proposal, or default grouping.

BoardLaneView

Section titled “BoardLaneView”

BoardLaneView = typeof BoardLaneView.Type

A displayed lane whose variant determines whether operator moves are supported.

BoardMoveError

Section titled “BoardMoveError”

BoardMoveError = BoardItemNotFoundError | BoardLaneNotFoundError | BoardLaneReadOnlyError | BoardProjectNotFoundError | EnginePersistenceError | GitHubAppError

FactoryOverview

Section titled “FactoryOverview”

FactoryOverview = typeof FactoryOverview.Type

The operator overview, distinguished by whether factory setup is complete.

FailureView

Section titled “FailureView”

FailureView = typeof FailureView.Type

An Attempt failure with only the details the operator can inspect.

NeedView

Section titled “NeedView”

NeedView = typeof NeedView.Type

One reason the factory asks for operator attention in the overview.

OperatorError

Section titled “OperatorError”

OperatorError = RosterAgentNotFoundError | RunEngineError | TranscriptAttemptNotFoundError | BoardMoveError | CycleBudgetResetRejectedError

OperatorObservationError

Section titled “OperatorObservationError”

OperatorObservationError = RunStoreError | TranscriptAttemptNotFoundError

ProjectStatus

Section titled “ProjectStatus”

ProjectStatus = typeof ProjectStatus.Type

The Project’s summary indicator for activity or required operator attention.

RunStateTag

Section titled “RunStateTag”

RunStateTag = typeof RunStateTag.Type

The persisted Run lifecycle state as exposed in operator views.

TranscriptPayload

Section titled “TranscriptPayload”

TranscriptPayload = typeof TranscriptPayload.Type

Attempt channel messages exposed to the operator, with defect causes removed from failures.

TranscriptRequest

Section titled “TranscriptRequest”

TranscriptRequest = typeof TranscriptRequest.Type

Selects the initial window, live tail, or earlier page of a Run transcript.

Variables

Section titled “Variables”

AttemptOutcomeView

Section titled “AttemptOutcomeView”

const AttemptOutcomeView: Schema.Union<readonly [typeof SucceededAttemptView, typeof FailedAttemptView, typeof CanceledAttemptView]>

The terminal outcome displayed for an Attempt; a live Attempt has no outcome.

BoardLaneId

Section titled “BoardLaneId”

const BoardLaneId: Schema.brand<Schema.NonEmptyString, "BoardLaneId">

Identifies a lane within a Project’s Board for operator moves.

BoardLaneOrigin

Section titled “BoardLaneOrigin”

const BoardLaneOrigin: Schema.Literals<readonly ["authored", "proposed", "fallback"]>

Whether a lane came from authored settings, a proposal, or default grouping.

BoardLaneView

Section titled “BoardLaneView”

const BoardLaneView: Schema.Union<readonly [typeof WritableBoardLaneView, typeof ReadOnlyBoardLaneView]>

A displayed lane whose variant determines whether operator moves are supported.

FactoryOverview

Section titled “FactoryOverview”

const FactoryOverview: Schema.Union<readonly [typeof ReadyOverview, typeof NeedsSetupOverview]>

The operator overview, distinguished by whether factory setup is complete.

FailureView

Section titled “FailureView”

const FailureView: Schema.Union<readonly [typeof InfraFailureView, typeof DefectFailureView, typeof AgentFailureView, typeof RunawayFailureView, typeof ChildSessionBudgetFailureView]>

An Attempt failure with only the details the operator can inspect.

NeedView

Section titled “NeedView”

const NeedView: Schema.Union<readonly [typeof CycleBudgetNeed, typeof ApprovalNeed, typeof BoardProjectionNeed, typeof RunFailureNeed, typeof PollFailureNeed, typeof PreflightFindingNeed, typeof ScheduleFailureNeed]>

One reason the factory asks for operator attention in the overview.

ProjectStatus

Section titled “ProjectStatus”

const ProjectStatus: Schema.Literals<readonly ["clear", "active", "needs-you"]>

The Project’s summary indicator for activity or required operator attention.

RunStateTag

Section titled “RunStateTag”

const RunStateTag: Schema.Literals<readonly ["Pending", "Waiting", "Queued", "Running", "Succeeded", "Failed", "Canceled"]>

The persisted Run lifecycle state as exposed in operator views.

TranscriptPayload

Section titled “TranscriptPayload”

const TranscriptPayload: Schema.Union<readonly [typeof Started, typeof SessionEvent, typeof Final, typeof FailedTranscriptView, typeof Interrupted, typeof Steer, typeof Interrupt, typeof OperatorMessage, typeof Release, typeof Cancel, typeof InterventionApplied, typeof InterventionRejected]>

Attempt channel messages exposed to the operator, with defect causes removed from failures.

TranscriptRequest

Section titled “TranscriptRequest”

const TranscriptRequest: Schema.Union<readonly [typeof ColdTranscriptRequest, typeof TailTranscriptRequest, typeof EarlierTranscriptRequest]>

Selects the initial window, live tail, or earlier page of a Run transcript.

GuidesArchitectureReferenceGitHub

Guides

Run a factoryWrite a LoopWrite an AgentOperate RunsBounded review and fix LoopsAdd a Worker

Architecture

Architecture overviewRun lifecycleHow an Attempt runsWorkers and the GatewayStorage and configurationOperator surfacesThe dogfood instance's LoopsGaps

Reference

Overview