soulcraft/brainy
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

docs: cite the cross-layer integrity contract generically in comments and notes

Browse source
This commit is contained in:
David Snelling 2026-07-14 10:11:41 -07:00
parent c40a89e649
commit 1d26988963
7 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/plugin.ts
View file

@ -116,7 +116,7 @@ export interface BrainyPluginContext {
// ===========================================================================
/**
* @description How a failed provider invariant should be remediated (ADR-004 §6):
* @description How a failed provider invariant should be remediated:
* - `'none'` — informational; the invariant held or nothing to do.
* - `'repair'` — a targeted, cheap fix exists (e.g. re-derive a count/manifest field).
* - `'rebuild'` — the derived state must be rebuilt from canonical (`provider.rebuild()`).
@ -124,7 +124,7 @@ export interface BrainyPluginContext {
export type InvariantHeal = 'none' | 'repair' | 'rebuild'
/**
* @description The result of ONE provider invariant check (ADR-004 §6). A failure
* @description The result of ONE provider invariant check. A failure
* (`holds === false`) NAMES what diverged, with numbers, so it is diagnosable
* from the report alone — never a bare boolean. `name` is a stable kebab-case id
* for telemetry / remediation routing.
@ -146,7 +146,7 @@ export interface InvariantResult {
/**
* @description A provider's self-report of its own cross-layer invariants
* (ADR-004 §6 — the `validateInvariants()` hook). Contract:
* (the `validateInvariants()` hook). Contract:
* - It NEVER throws — a failure is DATA (`healthy: false` + a failing invariant),
* not an exception.
* - It is BOUNDED (<50ms): residency checks + O(1) counts only, NO canonical
@ -196,7 +196,7 @@ export interface MetadataIndexProvider {
isReady?(): boolean
/**
* @description OPTIONAL (ADR-004 §6). The provider's self-report of its own
* @description OPTIONAL. The provider's self-report of its own
* cross-layer invariants (manifest ↔ segments ↔ counts residency/coherence).
* MUST NOT throw — a failure is DATA (`healthy: false` + a failing invariant).
* MUST be bounded (<50ms): residency + O(1) counts only, NO canonical walks, so
@ -358,7 +358,7 @@ export interface GraphIndexProvider {
isReady?(): boolean
/**
* @description OPTIONAL (ADR-004 §6). The provider's self-report of its own
* @description OPTIONAL. The provider's self-report of its own
* cross-layer invariants (manifest ↔ segments ↔ counts residency/coherence).
* MUST NOT throw — a failure is DATA (`healthy: false` + a failing invariant).
* MUST be bounded (<50ms): residency + O(1) counts only, NO canonical walks, so
@ -1024,7 +1024,7 @@ export interface VectorIndexProvider {
isReady?(): boolean
/**
* @description OPTIONAL (ADR-004 §6). The provider's self-report of its own
* @description OPTIONAL. The provider's self-report of its own
* cross-layer invariants (manifest ↔ segments ↔ counts residency/coherence).
* MUST NOT throw — a failure is DATA (`healthy: false` + a failing invariant).
* MUST be bounded (<50ms): residency + O(1) counts only, NO canonical walks, so