API Reference Framework v#0.5.0

Production-ready Elixir framework for event-driven applications.

AppSpec DSL for defining verified routes and message security.

Consumer cursor persistence for sequencer consumers.

Effects & Idempotency implementation.

Email sending and template rendering for Framework effects.

Webhook sending and template rendering for Framework effects.

Effects Worker for executing effects post-commit.

Runtime environment helpers that avoid relying on Mix in release builds.

Internationalization (i18n) support for Framework.

Gettext backend for Framework internationalization.

Generic Kernel implementation providing the canonical flow: Accept → Plan → Commit → Emit → Replay

Emitter module for range-scan delivery.

Replay module for test and recovery.

MessageSecurity provides pure predicate functions compiled from AppSpec visible_if clauses. These predicates run during Accept/Plan phase and enforce the same authorization logic used for UI visibility.

Dead Letter Queue Browser for observability overlay.

One-click record & explain functionality for debugging overlay.

Outbox Browser for observability overlay.

Schema-driven redaction service using x_pii_tags from SchemaRegistry.

Replay Harness for observability overlay.

Structured Logger for consistent correlation ID logging.

Supersedence Visualizer for observability overlay.

Timeline component for observability overlay.

Framework debug overlay controller functions.

Route definitions for Framework debug overlay system.

Schema registry + digesting + append-time size/PII enforcement.

Emitter streaming by sequence with jitter/backoff implementation.

Behavior for sequencer event consumers.

Consumer behavior for cursor persistence and resume.

Emitter provides streaming range-scan delivery with jitter/backoff.

PubSub bridge for real-time event streaming integration.

Replay harness for deterministic reconstruction.

Sequencer event emitter for consumer conformance.

Framework telemetry setup and SLO gauge registration.

Database infrastructure client for test support.

Mock webhook service for testing retry scenarios and uniqueness verification.

Test operation for batch profile updates with locking - used by framework tests only. This operation demonstrates proper use of list_locked/2 for concurrent safety.

Test operation for settings change - used by framework tests only. Applications should define their own operations.

Test operation for account creation - used by framework tests only. Applications should define their own operations.

Test operation designed to fail - used by framework tests only. Applications should define their own operations.

Test operation for order fulfillment - used by framework tests only. Applications should define their own operations.

Test operation for navigation - used by framework tests only. Applications should define their own navigation operations.

Test operation for determinism testing - used by framework tests only. Applications should define their own operations.

Test operation for transactional effects testing - used by framework tests only. Applications should define their own operations.

Test operation for profile update - used by framework tests only. Applications should define their own operations.

Test operation for user signup - used by framework tests only. Applications should define their own operations.

Test-only Ecto repository for the Framework package tests.

Test schema for Session - used by framework tests only. Applications should define their own schemas.

Test schema for User - used by framework tests only. Applications should define their own schemas.

Test schema for UserProfile - used by framework tests only. Applications should define their own schemas.

Test schema for UserSettings - used by framework tests only. Applications should define their own schemas.

Simulates sequence gaps for testing consumer gap tolerance.

Test consumer implementation for consumer conformance tests.

Test verified routes - used by framework tests only. Applications should define their own verified routes.

Transaction DSL Implementation.

DSL functions available inside plan blocks.

Schema validation metrics tracking for SLO monitoring.

VerifiedRoutes provides type-safe route generation and parameter validation.

Generates Framework migrations with version stamps and drift guards.