@threadplane/ag-uiInterfacev0.3.7

InterruptSession

The pending pause with its request ownership, as the Angular adapter's interruptSession reported it.

  • none: nothing is waiting.
  • collecting: the pausing run has not settled locally yet.
  • pending: the pause can be answered.
  • resuming: an answer was claimed and its run is going. Claiming and sending are one step here, so there is no separate claimed.
  • acknowledged: the answering run reported RUN_STARTED and is going.
  • uncertain: the answering run ended with no proof the backend took the answer, before it reported RUN_STARTED.
  • recovery-required: the answering run ended after it had started on the backend. Only reconciliation can say how.
  • unsupported: a pause this session cannot answer.
import type { InterruptSession } from '@threadplane/ag-ui';

Declaration

export interface InterruptSession  {
  readonly attempt?: NativeDecision['attempt'];
  readonly command?: NativeDecision['command'];
  readonly id?: PauseId;
  readonly interrupts: readonly OwnedInterrupt[];
  readonly phase: 'none' | 'collecting' | 'pending' | 'resuming' | 'acknowledged' | 'uncertain' | 'recovery-required' | 'unsupported';
  readonly runId?: string;
}

Members

attempt

The answer that was claimed: its run, responses and command.

readonly attempt?: NativeDecision['attempt'];

command

Present when the pause is answered through forwardedProps.command.

readonly command?: NativeDecision['command'];

id

Changes with every new pause, as the legacy generation did.

readonly id?: PauseId;

interrupts

readonly interrupts: readonly OwnedInterrupt[];

phase

readonly phase: 'none' | 'collecting' | 'pending' | 'resuming' | 'acknowledged' | 'uncertain' | 'recovery-required' | 'unsupported';

runId

The run that paused.

readonly runId?: string;