rulvar API reference

---

rulvar API reference / @rulvar/plan / RevisionGuards

Class: RevisionGuards

Defined in: packages/plan/src/guards.ts:81

The guard state machine. All counting inputs arrive from pure folds (the caller feeds landed revisions, severs, and re-adds in journal order), so live and replay converge on identical verdicts; the caller journals each verdict BEFORE applying its effects.

Constructors

Constructor

new RevisionGuards(options?): RevisionGuards;

Defined in: packages/plan/src/guards.ts:94

Parameters

Parameter	Type
options?	RevisionGuardsOptions & { maxOscillationsPerKey?: number; stallReplanCap?: number; }

Returns

RevisionGuards

Accessors

planFrozen

Get Signature

get planFrozen(): boolean;

Defined in: packages/plan/src/guards.ts:112

True once a terminating fallback engaged: the plan is frozen for adaptation.

Returns

boolean

---

revisionsRejected

Get Signature

get revisionsRejected(): boolean;

Defined in: packages/plan/src/guards.ts:117

True when further plan_revise calls are rejected outright.

Returns

boolean

---

stallReplanExhausted

Get Signature

get stallReplanExhausted(): boolean;

Defined in: packages/plan/src/guards.ts:197

Returns

boolean

---

state

Get Signature

get state(): GuardsState;

Defined in: packages/plan/src/guards.ts:103

Returns

GuardsState

Methods

absorbVerdict()

absorbVerdict(value): void;

Defined in: packages/plan/src/guards.ts:202

Rebuilds guard state from a journaled verdict (replay path).

Parameters

Parameter	Type
value	GuardVerdictValue

Returns

void

---

isFrozenSignature()

isFrozenSignature(approachSigCoarse): boolean;

Defined in: packages/plan/src/guards.ts:172

True when further re-adds of this coarse signature are frozen.

Parameters

Parameter	Type
approachSigCoarse	string

Returns

boolean

---

onReAdd()

onReAdd(approachSigCoarse): 
  | GuardVerdictValue
  | undefined;

Defined in: packages/plan/src/guards.ts:151

Feeds one admitted add of this coarse signature; a re-add after a sever counts one oscillation ACROSS LTID boundaries. Returns the freeze verdict to journal when the per-key limit is reached.

Parameters

Parameter	Type
approachSigCoarse	string

Returns

| GuardVerdictValue | undefined

---

onRevisionLanded()

onRevisionLanded(effectiveDroppedStreak): 
  | GuardVerdictValue
  | undefined;

Defined in: packages/plan/src/guards.ts:125

Feeds one landed revision's effective streak; returns the verdict to journal when the limit is reached (single-shot).

Parameters

Parameter	Type
effectiveDroppedStreak	number

Returns

| GuardVerdictValue | undefined

---

onSevered()

onSevered(approachSigCoarse): void;

Defined in: packages/plan/src/guards.ts:139

Feeds a severing cancel/abandon of a node with this coarse signature.

Parameters

Parameter	Type
approachSigCoarse	string

Returns

void

---

onStallReplan()

onStallReplan(): 
  | GuardVerdictValue
  | undefined;

Defined in: packages/plan/src/guards.ts:184

Consumes one stall-triggered replan slot; returns the cap verdict when the hard per-run bound is exhausted (single-shot per call site).

Returns

| GuardVerdictValue | undefined

---

oscillationCountOf()

oscillationCountOf(approachSigCoarse): number;

Defined in: packages/plan/src/guards.ts:176

Parameters

Parameter	Type
approachSigCoarse	string

Returns

number

---

verdictJson()

static verdictJson(value): Json;

Defined in: packages/plan/src/guards.ts:218

Serializes a verdict for the journal append.

Parameters

Parameter	Type
value	GuardVerdictValue

Returns

Json