Sanity Library Reference Docs
    Preparing search index...
    interface ActionEvaluation {
        action: Action;
        allowed: boolean;
        disabledReason?: DisabledReason;
        firing?: FiringConsequence;
        holderGate?: { holders: Assignee[] };
        insight?: ConditionInsight;
        semantics?: ActionSemantic[];
        triggered?: true;
        whenInsight?: ConditionInsight;
    }
    Index

    Properties

    action: Action
    allowed: boolean
    disabledReason?: DisabledReason

    Present iff allowed === false. The first failing gate wins.

    What firing this action would do to the flow RIGHT NOW — the fire replayed in memory on the engine's own machinery (ops, the triggered fixpoint, transition selection) against this projection's state, and conditional on the commit landing (rejectability is allowed / disabledReason's story). Omitted when the consequence depends on inputs the projection doesn't hold — caller params, a spawn's dataset-driven fan-out, a terminal instance, a stage visit whose entries have diverged from the pinned definition — and on cascade-fired actions, which are never a caller's to fire. Advisory like every derived verdict: a placement/phrasing hint, never a gate.

    holderGate?: { holders: Assignee[] }

    A canonical $assigned filter leg withheld this absent action. The action still follows filter-existence semantics; this metadata lets the owning activity explain who currently holds the work.

    Derived state of the action's filter gate — why it holds or fails, atom by atom. Present iff the action declares a filter.

    semantics?: ActionSemantic[]

    The action's advisory workflow meaning, unchanged from its definition.

    triggered?: true

    The action is cascade-fired (when): the engine fires it on truth, it is never fireAction-able, and a consumer must not render it as a button — narrate it ("will escalate when overdue") via whenInsight. Always set together with the cascade-fired disabledReason — either check suffices; the flag is the ergonomic spelling.

    whenInsight?: ConditionInsight

    Derived state of a cascade-fired action's when trigger — what would fire it. Present iff the action declares when.