@graphrefly/graphrefly 0.45.0 → 0.46.0

package/dist/utils/cqrs/index.d.cts

@@ -0,0 +1,438 @@
+import { Node } from '@graphrefly/pure-ts/core';
+import { ReactiveLogBundle, AppendLogStorageTier } from '@graphrefly/pure-ts/extra';
+import { Graph, GraphOptions } from '@graphrefly/pure-ts/graph';
+import { BaseAuditRecord } from '../../base/mutation/index.cjs';
+
+/**
+ * CQRS patterns (roadmap §4.5).
+ *
+ * Composition layer over reactiveLog (3.2), pipeline/sagas (4.1), event bus (4.2),
+ * projections (4.3). Guards (1.5) enforce command/query boundary.
+ *
+ * - `cqrs(name, opts?)` → `CqrsGraph` — top-level factory
+ * - `CqrsGraph.command(name, handler)` — write-only node; guard rejects `observe`
+ * - `CqrsGraph.event(name)` — backed by `reactiveLog`; append-only
+ * - `CqrsGraph.projection(name, events, reducer, initial)` — read-only derived; guard rejects `write`
+ * - `CqrsGraph.saga(name, events, handler)` — event-driven side effects
+ */
+
+/**
+ * Immutable envelope for events emitted by command handlers.
+ *
+ * **Wave C.1 Unit 17 (locked 2026-04-24):** Extended ES standard fields —
+ * `aggregateId` / `aggregateVersion` for per-aggregate streams; correlation /
+ * causation IDs for distributed tracing; `metadata` for free-form context.
+ * Optional `handlerVersion` (Audit 5) traces which handler version produced
+ * the event.
+ *
+ * `seq` is a per-graph monotonic counter that provides stable ordering when
+ * multiple events share the same `timestampNs` (same wall-clock tick).
+ */
+type CqrsEvent<T = unknown> = {
+    type: string;
+    payload: T;
+    /** Wall-clock nanoseconds (via `wallClockNs()`). */
+    timestampNs: number;
+    /** Monotonic sequence within this CqrsGraph instance. */
+    seq: number;
+    /** Aggregate identifier (per-aggregate streams). */
+    aggregateId?: string;
+    /** Per-aggregate monotonic version (set when `aggregateId` is provided). */
+    aggregateVersion?: number;
+    /** Distributed-trace correlation id. */
+    correlationId?: string;
+    /** Causation chain id (this event was caused by event `causationId`). */
+    causationId?: string;
+    /** Free-form metadata frozen at append. */
+    metadata?: Readonly<Record<string, unknown>>;
+    /** V0 identity of the event log node at append time (§6.0b). */
+    v0?: {
+        id: string;
+        version: number;
+    };
+    /** Handler version stamped on emit (Audit 5). */
+    handlerVersion?: {
+        id: string;
+        version: string | number;
+    };
+};
+/** Compile-time event-map registry: `{ "orderPlaced": OrderPayload, ... }`. */
+type CqrsEventMap = Record<string, unknown>;
+/** Recommended `keyOf` for CQRS event-store storage tiers (Audit 4). */
+declare const cqrsEventKeyOf: (e: CqrsEvent) => string;
+interface DispatchRecord<T = unknown> extends BaseAuditRecord {
+    readonly commandName: string;
+    readonly payload: T;
+    /** Action result. Tier 1.6.2 canonical enum (renamed from `status`). */
+    readonly outcome: "success" | "failure";
+    readonly error?: unknown;
+    readonly errorType?: string;
+    /**
+     * Event names emitted by the handler.
+     * - `outcome: "success"`: events that persisted in the event log.
+     * - `outcome: "failure"`: events the handler ATTEMPTED to emit before throwing;
+     *   they were rolled back and did NOT persist. Documents the failed attempt's
+     *   intentions for debugging handler logic. The actual event log shows only
+     *   what's durable.
+     */
+    readonly emittedEvents?: readonly string[];
+}
+declare const dispatchKeyOf: <T>(r: DispatchRecord<T>) => string;
+interface SagaInvocation<T = unknown> extends BaseAuditRecord {
+    readonly eventType: string;
+    /** Action result. Tier 1.6.2 canonical enum (renamed from `status`). */
+    readonly outcome: "success" | "failure";
+    readonly error?: unknown;
+    readonly errorType?: string;
+    readonly aggregateId?: string;
+    readonly event?: CqrsEvent<T>;
+}
+declare const sagaInvocationKeyOf: <T>(i: SagaInvocation<T>) => string;
+/**
+ * Saga registration result (M10) — a typed bundle replacing the prior
+ * `Node<unknown>` return that side-attached `_saga` via an unsafe cast.
+ *
+ * `node` is the saga's effect node (subscribe to observe processing
+ * activity). `invocations` is the per-event-type audit log; `audit` aliases
+ * `invocations` (Audit 2 `.audit` duplication). `cursors` exposes the
+ * per-event-type cursor state nodes for monitoring / testing.
+ *
+ * @category patterns
+ */
+interface SagaController<T = unknown> {
+    readonly node: Node<unknown>;
+    readonly invocations: ReactiveLogBundle<SagaInvocation<T>>;
+    readonly audit: ReactiveLogBundle<SagaInvocation<T>>;
+    readonly cursors: {
+        readonly [eventName: string]: Node<number>;
+    };
+}
+type CommandActions = {
+    /** Append an event to a named event log (bypasses event guard). */
+    emit: (eventName: string, payload: unknown) => void;
+};
+/**
+ * Command handler receives the dispatch payload and actions to emit events.
+ *
+ * **Purity:** Handlers should not mutate the payload. Event emission via
+ * `actions.emit()` is the only sanctioned side effect.
+ */
+type CommandHandler<T = unknown> = (payload: T, actions: CommandActions) => void;
+/**
+ * Projection reducer folds events into a read model.
+ *
+ * **Purity contract:** Reducers MUST be pure — return a new state value
+ * without mutating `state` or any event.
+ *
+ * - In **`"replay"`** mode the `state` parameter is always the original
+ *   `initial` value (full event-sourcing replay on every recompute).
+ * - In **`"scan"`** mode the `state` parameter is the _previous_ output
+ *   (incremental fold); `events` contains only the events appended since
+ *   the last computation.
+ */
+type ProjectionReducer<TState = unknown, TEvent = unknown> = (state: TState, events: readonly CqrsEvent<TEvent>[]) => TState;
+/**
+ * Snapshot integration for {@link ProjectionOptions}.
+ *
+ * `load` is called once at projection construction and the returned value
+ * seeds the initial state. `save` (optional) is called after each reducer
+ * run, debounced by `saveDebounceMs` (default 1000 ms) and capped by
+ * `saveEvery` (default 1000 events).
+ */
+type ProjectionSnapshotOpts<TState> = {
+    /** Load a previously-saved state. `undefined` → start from `initial`. */
+    load: () => TState | undefined | Promise<TState | undefined>;
+    /** Persist the current state. Called after reducer; may be async. */
+    save?: (state: TState) => void | Promise<void>;
+    /**
+     * Debounce window (ms) before `save` fires after the last event. Default 1000.
+     */
+    saveDebounceMs?: number;
+    /**
+     * Force a save after every Nth state change regardless of debounce.
+     * Default 1000. Both knobs compose: save fires at whichever condition is
+     * met first.
+     */
+    saveEvery?: number;
+};
+/**
+ * Options for {@link CqrsGraph.projection}.
+ *
+ * **Wave C.3 Unit 21 (locked 2026-04-24):**
+ * - `mode: "scan"` (default) — incremental fold; `"replay"` — full replay
+ *   each wave.
+ * - `snapshot` — load/save integration for cold-start + auto-checkpoint.
+ * - `freezeInputs` (default `true`) — freeze event arrays before passing
+ *   to reducer (purity enforcement).
+ * - `rebuild()` / `reset()` on the returned {@link ProjectionController}.
+ *
+ * @category patterns
+ */
+type ProjectionOptions<TState> = {
+    name: string;
+    events: readonly string[];
+    reducer: ProjectionReducer<TState>;
+    initial: TState;
+    /**
+     * Fold strategy. Default `"scan"` (incremental). `"replay"` = full replay.
+     *
+     * **Scan-mode ordering caveat:** scan-mode assumes monotonic per-stream
+     * arrival order. When multiple event streams are merged for a projection,
+     * events arriving with a `timestampNs` earlier than the current sort cursor
+     * are skipped from the incremental sweep. This is an acceptable trade-off
+     * for incremental fold; use `mode: "replay"` for strict cross-stream
+     * ordering.
+     */
+    mode?: "replay" | "scan";
+    /** Snapshot integration for rebuild + auto-checkpoint. */
+    snapshot?: ProjectionSnapshotOpts<TState>;
+    /**
+     * Freeze event arrays before passing to reducer (default `true`).
+     * Set to `false` only if your reducer intentionally mutates the input
+     * (strongly discouraged — prefer immutable reducers).
+     */
+    freezeInputs?: boolean;
+};
+/**
+ * Controller returned by {@link CqrsGraph.projection}.
+ *
+ * `node` is the reactive read model. `rebuild()` performs a paginated
+ * cold-storage replay (requires `attachEventStorage` tiers). `reset()`
+ * reloads from `snapshot.load()` and re-folds the live event log on top.
+ *
+ * @category patterns
+ */
+interface ProjectionController<TState> {
+    readonly node: Node<TState>;
+    /**
+     * Async paginated rebuild from attached storage tiers. Throws
+     * {@link RebuildError} on adapter / decode / reducer failure.
+     *
+     * @param opts.fromTier - Storage tier to read from (default: first attached).
+     * @param opts.pageSize - Entries per page (default 1000).
+     */
+    rebuild(opts?: {
+        fromTier?: AppendLogStorageTier<CqrsEvent>;
+        pageSize?: number;
+    }): Promise<TState>;
+    /**
+     * Reload from `snapshot.load()` (if configured) and re-fold the live
+     * in-memory event log on top. Returns the rebuilt state. No-op on the
+     * reactive node if the state is unchanged.
+     */
+    reset(): Promise<TState>;
+}
+type SagaHandler<T = unknown> = (event: CqrsEvent<T>) => void;
+type CqrsOptions = {
+    graph?: GraphOptions;
+    /** Bounded retention for event streams; default 1024 (cross-cutting). */
+    retainedLimit?: number;
+    /** Freeze command payloads on dispatch (default `true`). */
+    freezeCommandPayload?: boolean;
+    /** Freeze event payloads on emit (default `true`). */
+    freezeEventPayload?: boolean;
+    /** LRU eviction threshold for per-aggregate streams (default 10_000). */
+    maxAggregates?: number;
+};
+type CommandRegistration<TPayload = unknown> = {
+    handler: CommandHandler<TPayload>;
+    emits?: readonly string[];
+    handlerVersion?: {
+        id: string;
+        version: string | number;
+    };
+};
+type DispatchOptions = {
+    correlationId?: string;
+    causationId?: string;
+    metadata?: Record<string, unknown>;
+    /**
+     * Optimistic-concurrency check: if set, dispatch verifies the aggregate
+     * (identified by `aggregateId`) is at this version. On mismatch, dispatch
+     * throws {@link OptimisticConcurrencyError} BEFORE the handler runs.
+     *
+     * Requires `aggregateId` to be set. Without it the check is a no-op.
+     */
+    expectedAggregateVersion?: number;
+    /**
+     * Aggregate this dispatch targets. Events emitted by the handler that
+     * also carry this `aggregateId` participate in per-aggregate versioning
+     * and LRU eviction (see {@link CqrsOptions.maxAggregates}). Events whose
+     * handler-supplied `aggregateId` differs from the dispatch's `aggregateId`
+     * are emitted untouched (their own `aggregateVersion` is computed from
+     * their own aggregate's stream).
+     */
+    aggregateId?: string;
+};
+type SagaOptions = {
+    aggregateId?: string;
+    errorPolicy?: "advance" | "hold";
+    handlerVersion?: {
+        id: string;
+        version: string | number;
+    };
+};
+/**
+ * Eviction record emitted on `aggregateEvictions` when an aggregate's
+ * per-aggregate stream is removed under `maxAggregates` LRU pressure. The
+ * eviction does NOT delete events from the fan-in stream — only the
+ * per-aggregate dedicated stream and its version counter.
+ */
+interface AggregateEvictionRecord {
+    readonly aggregateId: string;
+    readonly type: string;
+    readonly t_ns: number;
+    /** The version count the aggregate reached before eviction (for diagnostics). */
+    readonly lastVersion: number;
+}
+declare class CqrsGraph<_EM extends CqrsEventMap = Record<string, unknown>> extends Graph {
+    /** Fan-in event streams (one per type, all aggregates merged). */
+    private readonly _eventLogs;
+    /**
+     * Per-aggregate event streams: type → aggregateId → entry. Used for
+     * `event(type, aggregateId)` dual-form access and per-aggregate version
+     * tracking. Only populated when an event with `aggregateId` is emitted.
+     */
+    private readonly _eventLogsByAggregate;
+    /** Per-aggregate version counters: `${type}::${aggregateId}` → current version. */
+    private readonly _aggregateVersions;
+    /**
+     * LRU access order for `${type}::${aggregateId}`. Map insertion order
+     * tracks recency — `delete` + `set` on access moves to the end.
+     */
+    private readonly _aggregateLru;
+    private readonly _commandRegs;
+    private readonly _projections;
+    private readonly _sagas;
+    private _seq;
+    private readonly _retainedLimit;
+    private readonly _freezeCommandPayload;
+    private readonly _freezeEventPayload;
+    private readonly _maxAggregates;
+    private readonly _dispatchSeqCursor;
+    /** Audit log of every command dispatch (Audit 2). */
+    readonly dispatches: ReactiveLogBundle<DispatchRecord>;
+    /** Alias for {@link CqrsGraph.dispatches} (Audit 2 `.audit` duplication). */
+    readonly audit: ReactiveLogBundle<DispatchRecord>;
+    /** Per-aggregate LRU eviction observability; secondary log to `dispatches`. */
+    readonly aggregateEvictions: ReactiveLogBundle<AggregateEvictionRecord>;
+    constructor(name: string, opts?: CqrsOptions);
+    /**
+     * Read the current per-aggregate version (last emitted `aggregateVersion`
+     * for that `(type, aggregateId)` pair). Returns `0` if no events have been
+     * emitted yet for this aggregate. Useful for callers preparing
+     * {@link DispatchOptions.expectedAggregateVersion}.
+     */
+    aggregateVersion(type: string, aggregateId: string): number;
+    /** LRU touch — moves the key to the end of the access order. */
+    private _touchAggregate;
+    /**
+     * Evict the oldest aggregate streams (least-recently-touched) until the
+     * aggregate count is back within `_maxAggregates`. Emits one
+     * `AggregateEvictionRecord` per eviction. The fan-in stream is NOT touched
+     * — events stay in the type-level log; only the per-aggregate stream and
+     * version counter are removed.
+     */
+    private _enforceAggregateLru;
+    /** Tiers attached via {@link attachEventStorage}; auto-wired into future event streams. */
+    private readonly _attachedEventTiers;
+    private readonly _attachedTierDisposers;
+    /**
+     * Wire append-log storage tiers for ALL CQRS event streams — both currently
+     * registered AND any future streams created via `event(name)` /
+     * `event(name, aggregateId)` / handler emit. (M4 fix.)
+     *
+     * Returns a disposer that releases all storage subscriptions wired by this
+     * call (including those for streams that were created after the call).
+     */
+    attachEventStorage(tiers: readonly AppendLogStorageTier<CqrsEvent>[]): () => void;
+    /** Wire newly-created event stream into all currently-attached tier sets. */
+    private _autoWireStreamStorage;
+    /**
+     * Register a named event stream backed by `reactiveLog`.
+     * Guard denies external `write` — only commands append internally.
+     */
+    event(name: string): Node<readonly CqrsEvent[]>;
+    event(name: string, aggregateId: string): Node<readonly CqrsEvent[]>;
+    /**
+     * Get-or-create the per-aggregate event stream for `(type, aggregateId)`.
+     * Mounts the stream as a sibling node named `<type>_<aggregateId>` so it
+     * appears in `describe()`. LRU access is touched on every call.
+     */
+    private _ensureAggregateStream;
+    /** Try `resolve(path)`; return `undefined` instead of throwing on missing. */
+    private resolveOptional;
+    /** Internal: append to an event log, auto-registering if needed. */
+    private _appendEvent;
+    /**
+     * Register a command with its handler. Guard denies `observe` (write-only).
+     * Use `dispatch(name, payload)` to execute.
+     *
+     * The command node carries dynamic `meta.error` — a reactive companion
+     * that holds the last handler error (or `null` on success).
+     */
+    command<T = unknown>(name: string, handlerOrReg: CommandHandler<T> | CommandRegistration<T>): Node<T>;
+    /**
+     * Execute a registered command. Wraps the entire dispatch in `batch()` so
+     * the command node DATA and all emitted events settle atomically.
+     *
+     * If the handler throws, `meta.error` on the command node is set to the
+     * error and the exception is re-thrown.
+     *
+     * **Tier 8 / COMPOSITION-GUIDE §35:** dispatch routes through the shared
+     * {@link mutate} framework so freeze / rollback-on-throw / seq-cursor
+     * advance / audit-record stamping flow through one centralized helper.
+     * Failure records emit OUTSIDE the rolled-back batch (M5 / C4 invariants
+     * preserved by the framework).
+     */
+    dispatch<T = unknown>(commandName: string, payload: T, opts?: DispatchOptions): void;
+    /**
+     * Register a read-only projection derived from event streams.
+     * Guard denies `write` — value is computed from events only.
+     *
+     * **Wave C.3 Unit 21 (locked 2026-04-24):**
+     * - Object-bag signature replaces the positional `(name, events, reducer, initial)` form.
+     * - `mode: "scan"` (default) — incremental fold; `"replay"` — full replay each wave.
+     * - `snapshot` integration for cold-start load + auto-checkpoint save.
+     * - `freezeInputs` (default `true`) — freeze the event array before passing to reducer.
+     * - Returns `ProjectionController<TState>` with `.node`, `.rebuild()`, `.reset()`.
+     *
+     * Fan-in across `events` is implemented by depending on all event-type fan-in
+     * nodes directly, which preserves `describe()` edges (e.g. `orderPlaced →
+     * orderCount`). Events are sorted by `(timestampNs, seq, aggregateId)` before
+     * passing to the reducer (Option-3 cross-aggregate ordering, C.3).
+     */
+    projection<TState>(opts: ProjectionOptions<TState>): ProjectionController<TState>;
+    /**
+     * Register an event-driven side effect. Runs handler for each **new** event
+     * from the specified streams (tracks last-processed entry count per stream).
+     *
+     * The saga node carries dynamic `meta.error` — a reactive companion that
+     * holds the last handler error (or `null` on success). Handler errors do
+     * not propagate out of the saga run (the event cursor still advances so
+     * the same entry is not delivered twice).
+     */
+    saga<T = unknown>(name: string, eventNames: readonly string[], handler: SagaHandler<T>, opts?: SagaOptions): SagaController<T>;
+}
+/**
+ * Create a CQRS graph container.
+ *
+ * @example
+ * ```ts
+ * const app = cqrs("orders");
+ * app.event("orderPlaced");
+ * app.command("placeOrder", (payload, { emit }) => {
+ *   emit("orderPlaced", { orderId: payload.id, amount: payload.amount });
+ * });
+ * const { node: orderCount } = app.projection({
+ *   name: "orderCount",
+ *   events: ["orderPlaced"],
+ *   reducer: (_s, events) => events.length,
+ *   initial: 0,
+ * });
+ * app.dispatch("placeOrder", { id: "1", amount: 100 });
+ * ```
+ */
+declare function cqrs<EM extends CqrsEventMap = Record<string, unknown>>(name: string, opts?: CqrsOptions): CqrsGraph<EM>;
+
+export { type AggregateEvictionRecord, type CommandActions, type CommandHandler, type CommandRegistration, type CqrsEvent, type CqrsEventMap, CqrsGraph, type CqrsOptions, type DispatchOptions, type DispatchRecord, type ProjectionController, type ProjectionOptions, type ProjectionReducer, type ProjectionSnapshotOpts, type SagaController, type SagaHandler, type SagaInvocation, type SagaOptions, cqrs, cqrsEventKeyOf, dispatchKeyOf, sagaInvocationKeyOf };