Skip to content

rulvar API reference


rulvar API reference / @rulvar/store-conformance

@rulvar/store-conformance

Interfaces

InterfaceDescription
ConformanceCheckOne mandatory check; run rejects with a descriptive Error on violation.
ConformanceSuite@rulvar/store-conformance: the executable store conformance kit (M2-T11, DEF-4). A store implementation passes journalStoreConformance (and leasableStoreConformance when it has the lease capability) or it is not a rulvar store; the kit is the executable definition of the storage seam frozen at 1.0.
TestRegistrarStructural subset of the Vitest/Jest registration API.

Type Aliases

Type AliasDescription
StoreFactoryThe factory contract: every call MUST return a fresh, isolated store (checks run against independent instances; a JsonlFileStore factory uses a fresh temp directory per call).

Variables

VariableDescription
GOLDEN_FOLD_JOURNALseq 0 agent spawn (running; abandoned by seq 6) seq 1 suspended external gate-a under the spawn's child scope seq 2 suspended external gate-b at the root seq 3 resolution of gate-a: schema-INVALID (never closes) seq 4 resolution of gate-a: applied seq 5 resolution of gate-a: noop (already_resolved) seq 6 abandon of the spawn: applied (covers the agent:0 subtree) seq 7 resolution of gate-b: applied (root scope, not covered) seq 8 abandon of gate-b: noop (already_resolved; first-closing-wins) seq 9 abandon of the spawn again: noop (target_abandoned)
GOLDEN_FOLD_STATE_SHA256The reference hash; computed once from the kernel fold and frozen.

Functions

FunctionDescription
foldStateSha256-
journalStoreConformance-
leasableStoreConformance-
makeSuite@rulvar/store-conformance: the executable store conformance kit (M2-T11, DEF-4). A store implementation passes journalStoreConformance (and leasableStoreConformance when it has the lease capability) or it is not a rulvar store; the kit is the executable definition of the storage seam frozen at 1.0.
materializeFoldStateMaterializes the observable fold state of a journal: ref-entry classifications (invalid details excluded: validator message wording is not contractual), suspension states, and per-seq abandon coverage.
registerConformance@rulvar/store-conformance: the executable store conformance kit (M2-T11, DEF-4). A store implementation passes journalStoreConformance (and leasableStoreConformance when it has the lease capability) or it is not a rulvar store; the kit is the executable definition of the storage seam frozen at 1.0.
stableStringify@rulvar/store-conformance: the executable store conformance kit (M2-T11, DEF-4). A store implementation passes journalStoreConformance (and leasableStoreConformance when it has the lease capability) or it is not a rulvar store; the kit is the executable definition of the storage seam frozen at 1.0.