API Reference ash_onetime v#0.3.0

Copy Markdown View Source

Modules

Explicit keyed-effect semantics for Ash actions.

Optional cache behaviour for completed idempotency responses.

A completed-response cache entry bound to an authoritative PostgreSQL claim.

No-op cache used when no optional completed-response cache is configured.

Bounded, deterministic encoding for an explicit closed value algebra.

Trusted clock boundary used when minting and verifying tokens.

Contract for response codecs and shared boundary validation.

JSON codec for declared generic action return values.

Typed JSON response codec.

JSON codec for allowlisted fields of Ash resource action results.

Typed failure returned by AshOnetime boundary modules.

Contract for a peer effect that is idempotent and recoverable by operation key.

Computes SHA-256 fingerprints over exact canonical bytes.

Resolves purpose-specific signing or verification material.

Closed key-source algebra used by protected actions.

Optional Oban entry point for the same bounded cleanup operation as mix ash_onetime.prune.

Optional Oban entry point for forward response-partition creation, mirroring mix ash_onetime.roll_partitions. Schedule it ahead of the retention horizon (e.g. daily or weekly) so payloads never route to the _default partition; without it, bounded retention silently degrades past the install window.

Optional Oban entry point for the same bounded reap operation as mix ash_onetime.reap.

Copies configured request headers into conn.private.ash_onetime.untrusted.

Declaration for lifecycle callbacks that are safe during stored-result replay.

Spark resource extension for explicit idempotency and one-time nonce protection.

Read-only introspection for the normalized per-action protections a resource declares under onetime.

The normalized, per-action keyed-effect declaration produced by an onetime protect block.

The normalized response contract for a protected action: the codec, the projected field allowlist, the result classifier, and codec options.

Normalizes application response classification at the persistence boundary.

Closed, explicit scope algebra for collision isolation.

Behaviour implemented by bounded token signers.

Ed25519 signing with private material and verification with public material.

HMAC-SHA-256 signer restricted to explicitly same-service key material.

Emits the closed, value-free telemetry surface for keyed-effect admission.

Mints, signs, and verifies bounded self-identifying canonical tokens.

Trusted local facts returned by a configured token verifier or minter.

Behaviour for trusted local verification callbacks.

Inclusive replay and expiry window validation.

Mix Tasks

Generates the PostgreSQL objects required by ash_onetime.

Generates the SEC-5/SEC-6 forward migration for an existing ash_onetime install.

Installs ash_onetime formatting and its deterministic migration.

Removes one bounded batch of expired claims and empty response partitions.

Removes one bounded batch of abandoned processing idempotency recovery points past an abandonment horizon.

Creates the next batch of monthly ash_onetime_response_payloads range partitions.