Rulvar API reference / @rulvar/effects
@rulvar/effects
The effect lane runtime (rfcs/effects.md): the adapter seam that cannot send without an open attempt record, the provider capability matrix (idempotency-key, qualified lookup, neither), the crash-window recovery that is licensed exclusively by provider-side fencing, the reconciler, receipt verification against a declared trust envelope, and the kill point conformance kit. Consumption semantics (the fold and the writer) live in @rulvar/core; hosts that do not run effects pay nothing for this package.
Docs: https://docs.rulvar.com/guide/effects
Classes
| Class | Description |
|---|---|
| EffectDispatcher | - |
| EffectReconciler | - |
| FakeEffectProvider | - |
Interfaces
| Interface | Description |
|---|---|
| EffectAdapter | - |
| EffectDispatcherOptions | - |
| EffectDispatchRequest | - |
| EffectLookupRequest | - |
| EffectProviderDescriptor | One provider row of the capability matrix (RFC section 6). |
| EffectReceiptObservation | What a provider hands back as evidence of an effect. |
| EffectReconcilerOptions | - |
| EffectsConformanceOptions | - |
| EffectsTelemetry | - |
| EffectSweepReport | - |
| EffectTrustEnvelope | - |
| EffectTrustKey | - |
| RestorationReport | - |
Type Aliases
| Type Alias | Description |
|---|---|
| EffectDispatchReport | - |
| EffectDispatchResult | - |
| EffectLookupAnswer | - |
| EffectRecoveryReport | - |
| FakeDispatchBehavior | - |
| ReceiptVerification | - |
| ReceiptVerifier | Trust-envelope verification of one receipt observation (the full envelope machinery is the reconciler train's; the seam is here). The default fails closed: an unverified receipt routes the machine to unknown, never to confirmed. |
Variables
| Variable | Description |
|---|---|
| EFFECTS_KILL_EXCLUSIONS | Rows that do not apply per effect class (part of the kit contract). |
Functions
| Function | Description |
|---|---|
| effectIdempotencyKey | The stable idempotency key: the logical key bound to its epoch. |
| effectsConformance | The kill point catalog as named checks (RFC section 8). |
| effectsTelemetryOf | - |
| envelopeVerifier | Adapts an envelope to the dispatcher's ReceiptVerifier seam. |
| verifyReceiptObservation | Verifies one receipt observation against the envelope. The order of checks is the RFC's: issuer identity, content bindings, key resolution with validity windows, revocation, then the signature itself. A receipt that binds fewer fields than its class requires verifies unverified no matter how good its signature is. |