keiro-0.12.0.0: src/Keiro.hs

-- | Umbrella entry point for the Keiro event-sourcing framework.
--
-- Importing @Keiro@ brings the everyday command-side surface into scope in
-- one go: the command runner ("Keiro.Command"), event 'Codec's
-- ("Keiro.Codec"), the 'EventStream' definition and its snapshot policy
-- ("Keiro.EventStream"), the content-based 'Router' ("Keiro.Router"),
-- snapshot helpers ("Keiro.Snapshot"), typed 'Stream' handles
-- ("Keiro.Stream"), and the validated projection-catalog facade
-- ("Keiro.Projection.Catalog").
--
-- The more specialized subsystems are not re-exported here and are imported
-- directly when needed: read models ("Keiro.ReadModel"), low-level projections
-- ("Keiro.Projection"), process managers ("Keiro.ProcessManager"), the
-- integration in/outbox ("Keiro.Inbox", "Keiro.Outbox"), timers
-- ("Keiro.Timer"), and telemetry ("Keiro.Telemetry").
--
-- Known limit: Keiro currently uses kiroku's PostgreSQL event store, whose append
-- path serializes all writers through the @$all@ stream row while assigning the
-- global event order. That makes the global position simple and deterministic,
-- but it is a throughput ceiling for very high write rates across many unrelated
-- streams. This production-readiness hardening pass documents the limit rather
-- than redesigning it; applications that outgrow the single-row global append
-- lock need a future event-store migration plan.
module Keiro
  ( -- * Library version
    version,

    -- * Command side
    module Keiro.Command,
    module Keiro.Codec,

    -- * Stream definitions
    EventStream (..),
    Terminality (..),
    SnapshotPolicy (..),
    StateCodec (..),
    module Keiro.EventStream.Validate,
    module Keiro.Stream,

    -- * Routing and snapshots
    module Keiro.Router,
    module Keiro.Snapshot,

    -- * Projection catalogs
    module Keiro.Projection.Catalog,
  )
where

import Data.Text qualified as Text
import Data.Version (showVersion)
import Keiro.Codec
import Keiro.Command
import Keiro.EventStream
import Keiro.EventStream.Validate
import Keiro.Prelude
import Keiro.Projection.Catalog hiding (AllStreams, version)
import Keiro.Router
import Keiro.Snapshot
import Keiro.Stream
import Paths_keiro qualified as Package

-- | The Cabal package version, rendered as 'Text' for display and telemetry.
version :: Text
version = Text.pack (showVersion Package.version)