@relaybus/core 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -1,8 +1,5 @@
-/** Source of the current time. Replace it in tests to control retries and leases. */
-interface Clock {
-    now(): Date;
-}
-declare const systemClock: Clock;
+import { E as EventEnvelope, D as DomainEvent, S as StandardSchemaV1, P as PayloadOf, a as EventHeaders, b as EventReference, C as Clock, c as EventClass } from './event-DCRTuYKI.js';
+export { d as DefineEventKeyOptions, e as DefineEventOptions, f as EventKeyFunction, g as assertEventType, h as defineEvent, s as systemClock, v as validatePayload } from './event-DCRTuYKI.js';
 
 /**
  * A duration in milliseconds, or a string such as `'250ms'`, `'30s'`, `'5m'`,
@@ -14,102 +11,6 @@ declare function toMilliseconds(value: Duration, name: string): number;
 /** Largest delay Node.js timers support. Longer values fire after 1ms instead. */
 declare const MAX_TIMER_DELAY_MS = 2147483647;
 
-/**
- * The Standard Schema interface (https://standardschema.dev), copied as the
- * specification recommends so relaybus needs no runtime dependency. Zod,
- * Valibot, ArkType and other libraries implement it.
- */
-interface StandardSchemaV1<Input = unknown, Output = Input> {
-    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
-}
-declare namespace StandardSchemaV1 {
-    interface Props<Input = unknown, Output = Input> {
-        readonly version: 1;
-        readonly vendor: string;
-        readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>;
-        readonly types?: Types<Input, Output> | undefined;
-    }
-    type Result<Output> = SuccessResult<Output> | FailureResult;
-    interface SuccessResult<Output> {
-        readonly value: Output;
-        readonly issues?: undefined;
-    }
-    interface FailureResult {
-        readonly issues: ReadonlyArray<Issue>;
-    }
-    interface Issue {
-        readonly message: string;
-        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
-    }
-    interface PathSegment {
-        readonly key: PropertyKey;
-    }
-    interface Types<Input = unknown, Output = Input> {
-        readonly input: Input;
-        readonly output: Output;
-    }
-    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
-    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
-}
-
-/** String metadata carried with an event, such as `traceparent`. */
-type EventHeaders = Readonly<Record<string, string>>;
-/**
- * An event as stored and delivered. Field names follow CloudEvents where they
- * overlap (`id`, `type`, `source`, `time` as `occurredAt`, `subject` as `key`).
- */
-interface EventEnvelope<TPayload = unknown> {
-    /** Globally unique id. Handlers and transports deduplicate on it. */
-    readonly id: string;
-    /** Event type, for example `order.created.v1`. */
-    readonly type: string;
-    /** Logical name of the publishing service. */
-    readonly source: string;
-    /** Ordering and partition key. Events sharing a key are handled in publish order. */
-    readonly key: string | null;
-    readonly payload: TPayload;
-    readonly headers: EventHeaders;
-    /** Id shared by every event of one business flow. */
-    readonly correlationId: string | null;
-    /** Id of the event whose handler published this one. */
-    readonly causationId: string | null;
-    readonly occurredAt: Date;
-}
-/** An instance of a class created with {@link defineEvent}. */
-interface DomainEvent<TPayload = unknown> {
-    readonly type: string;
-    readonly payload: TPayload;
-}
-/** A class created with {@link defineEvent}. */
-interface EventClass<TPayload = unknown> {
-    new (payload: TPayload): DomainEvent<TPayload>;
-    readonly type: string;
-    readonly schema: StandardSchemaV1<unknown, TPayload> | undefined;
-}
-/** Payload type of an event class: `PayloadOf<typeof OrderPlaced>`. */
-type PayloadOf<TEvent> = TEvent extends EventClass<infer TPayload> ? TPayload : never;
-/** Anything that names an event type: an event class or the type string itself. */
-type EventReference = {
-    readonly type: string;
-} | string;
-interface DefineEventOptions<TSchema extends StandardSchemaV1> {
-    /** Validates the payload on publish and before every handler call. */
-    readonly schema: TSchema;
-}
-declare function assertEventType(type: string): void;
-/**
- * Defines an event type. Extend the returned class to name it:
- *
- * ```ts
- * export class OrderPlaced extends defineEvent<{ orderId: string }>('order.placed.v1') {}
- * export class OrderShipped extends defineEvent('order.shipped.v1', { schema: orderShippedSchema }) {}
- * ```
- */
-declare function defineEvent<TSchema extends StandardSchemaV1>(type: string, options: DefineEventOptions<TSchema>): EventClass<StandardSchemaV1.InferOutput<TSchema>>;
-declare function defineEvent<TPayload>(type: string): EventClass<TPayload>;
-/** Runs a Standard Schema and returns its output, or throws {@link EventValidationError}. */
-declare function validatePayload<TPayload>(type: string, schema: StandardSchemaV1<unknown, TPayload> | undefined, payload: unknown): Promise<TPayload>;
-
 /**
  * How the delay between attempts is randomized.
  * - `full`: uniform in [0, delay]. Spreads retries the most (AWS recommendation).
@@ -430,7 +331,7 @@ interface CatalogDeclaration<TCatalog extends Catalog = Catalog, TName extends k
  * Declares that this service consumes events of a catalog, typically one
  * shared between services through a contracts package. `start()` fails unless
  * every declared event has a local handler (`subscribeCatalog`, `subscribe`,
- * `@EventConsumer`, `@Subscribe`); a route to a transport does not count.
+ * `@RelayBusCatalogConsumer`, `@RelayBusConsumer`); a route to a transport does not count.
  * Without `events`, every event of the catalog is declared. Unknown names do
  * not compile and are rejected at runtime with a {@link ConfigurationError}.
  *
@@ -462,10 +363,17 @@ declare function produce<TCatalog extends Catalog, const TName extends keyof TCa
  */
 declare class RelayBusError extends Error {
     name: string;
+    /**
+     * Stable, machine-readable identifier of the error class, such as `RELAYBUS_LEASE_LOST`.
+     * Unlike `name` and `message`, a code is never renamed once released; branch on it in
+     * alerts and dashboards. Subclasses declared outside relaybus inherit `RELAYBUS_ERROR`.
+     */
+    readonly code: string;
 }
 /** Invalid options passed to a relaybus component. */
 declare class ConfigurationError extends RelayBusError {
     name: string;
+    readonly code: string;
 }
 /**
  * Thrown by `publish` when no transaction can be found and the bus runs with
@@ -474,6 +382,16 @@ declare class ConfigurationError extends RelayBusError {
  */
 declare class TransactionRequiredError extends RelayBusError {
     name: string;
+    readonly code: string;
+}
+/**
+ * A `bus.transaction` (or `@RelayBusTransaction()` method) ran past its `transactionTimeout` and
+ * was rolled back. Its `cause` is the error the database raised when it ended the transaction,
+ * when there was one. Usually a slow call to another service made inside the transaction.
+ */
+declare class TransactionTimeoutError extends RelayBusError {
+    name: string;
+    readonly code: string;
 }
 /**
  * Throw from a handler to dead-letter the delivery immediately, skipping the
@@ -481,11 +399,13 @@ declare class TransactionRequiredError extends RelayBusError {
  */
 declare class NonRetryableError extends RelayBusError {
     name: string;
+    readonly code: string;
 }
 /** A payload failed its event schema. Never retried: the payload will not change. */
 declare class EventValidationError extends NonRetryableError {
     readonly issues: readonly ValidationIssue[];
     name: string;
+    readonly code: string;
     constructor(message: string, issues: readonly ValidationIssue[]);
 }
 /**
@@ -494,10 +414,12 @@ declare class EventValidationError extends NonRetryableError {
  */
 declare class InvalidEnvelopeError extends NonRetryableError {
     name: string;
+    readonly code: string;
 }
 /** The worker no longer owns the delivery it was processing. */
 declare class LeaseLostError extends RelayBusError {
     name: string;
+    readonly code: string;
     /**
      * Whether the store said so (a fenced write returned false). A worker that only noticed
      * locally that its lease ran out may still own the delivery in the store and has to give it back.
@@ -510,6 +432,7 @@ declare class LeaseLostError extends RelayBusError {
 /** A handler did not settle within its configured timeout. Retried like any failure. */
 declare class HandlerTimeoutError extends RelayBusError {
     name: string;
+    readonly code: string;
 }
 /**
  * Reason of a handler's abort signal when the bus stops before the handler
@@ -517,6 +440,25 @@ declare class HandlerTimeoutError extends RelayBusError {
  */
 declare class DispatcherStoppedError extends RelayBusError {
     name: string;
+    readonly code: string;
+}
+/**
+ * A delivery came back after its lease expired on its last attempt, so it is
+ * dead-lettered without running its handler again.
+ */
+declare class AttemptsExhaustedError extends RelayBusError {
+    name: string;
+    readonly code: string;
+}
+/** A lifecycle method was called in a state that does not allow it, such as starting a bus twice. */
+declare class LifecycleError extends RelayBusError {
+    name: string;
+    readonly code: string;
+}
+/** `drain` still found due deliveries after its maximum number of batches. */
+declare class DrainIncompleteError extends RelayBusError {
+    name: string;
+    readonly code: string;
 }
 interface ValidationIssue {
     readonly message: string;
@@ -527,6 +469,8 @@ interface ErrorInfo {
     readonly name: string;
     readonly message: string;
     readonly stack?: string | undefined;
+    /** The {@link RelayBusError.code} of a relaybus error; absent for any other error. */
+    readonly code?: string | undefined;
 }
 declare function toErrorInfo(error: unknown): ErrorInfo;
 
@@ -635,6 +579,26 @@ interface EventStoreStatistics {
     /** `availableAt` of the oldest delivery that is due but not yet processed. */
     readonly oldestDueAt: Date | null;
 }
+/** How `stop` closes a transport or a store. */
+interface CloseOptions {
+    /**
+     * Aborted when the shutdown deadline passes (`bus.stop({ timeout })`), possibly before `close` is
+     * called. From then on, close what you opened yourself at once (destroy connections, cancel
+     * running queries) instead of waiting for it to finish; the bus no longer waits for `close`.
+     * Leave alone what the application passed in.
+     */
+    readonly signal?: AbortSignal;
+}
+/** How a store runs one transaction of `bus.transaction`. */
+interface EventStoreTransactionOptions {
+    /**
+     * Time budget of the whole transaction, in milliseconds. A store makes the database enforce it
+     * where it can (for example a statement or idle-in-transaction timeout), so a transaction that
+     * waits on something slow is ended by the server and its locks are released. The bus rolls back
+     * a transaction that still ran past the budget, so a store may also ignore it.
+     */
+    readonly timeoutMs: number;
+}
 /**
  * Storage port. Implementations persist events and deliveries in the same
  * database as the application's business data so that both commit atomically.
@@ -644,8 +608,11 @@ interface EventStoreStatistics {
 interface EventStore<TTransaction = unknown> {
     /** Creates tables, collections and indexes when they do not exist. */
     setup?(): Promise<void>;
-    /** Runs `work` inside a new database transaction and commits when it resolves. */
-    transaction<T>(work: (transaction: TTransaction) => Promise<T>): Promise<T>;
+    /**
+     * Runs `work` inside a new database transaction and commits when it resolves. `options` come
+     * from `bus.transaction`; the store's own transactions and the dispatcher's pass none.
+     */
+    transaction<T>(work: (transaction: TTransaction) => Promise<T>, options?: EventStoreTransactionOptions): Promise<T>;
     /**
      * Writes events and their deliveries inside `transaction`. Idempotent on
      * event id and on (event id, handler). Assigns a per-key sequence to keyed
@@ -707,8 +674,8 @@ interface EventStore<TTransaction = unknown> {
      * that stops listening, or with `undefined` when this store cannot listen. Optional.
      */
     watchNewDeliveries?(listener: () => void): Promise<(() => Promise<void>) | undefined>;
-    /** Releases connections the store opened itself. */
-    close?(): Promise<void>;
+    /** Releases connections the store opened itself; forced once `options.signal` aborts. */
+    close?(options?: CloseOptions): Promise<void>;
 }
 
 /**
@@ -720,7 +687,167 @@ declare function createUuidV7(timestamp?: number): string;
 /** Produces unique identifiers for events, deliveries and lease tokens. */
 type IdentifierGenerator = () => string;
 
-type FailureStage = 'claim' | 'dispatch' | 'complete' | 'reschedule' | 'bury' | 'release' | 'relinquish' | 'extend-lease' | 'purge' | 'watch' | 'observer';
+/** Event header that carries the W3C trace context (`version-traceid-parentid-flags`). */
+declare const TRACEPARENT_HEADER = "traceparent";
+/** Event header that carries the vendor part of the W3C trace context. */
+declare const TRACESTATE_HEADER = "tracestate";
+/** A W3C Trace Context as it travels in event headers. */
+interface TraceContext {
+    readonly traceparent: string;
+    readonly tracestate?: string;
+}
+/**
+ * The W3C trace context an event carries in its headers, or undefined when it has none or a
+ * malformed one. A handler or a consumer span continues the publisher's trace from it.
+ *
+ * ```ts
+ * bus.subscribe(OrderPlaced, (event) => startSpan({ parent: traceContextOf(event.headers) }), ...)
+ * ```
+ */
+declare function traceContextOf(headers: EventHeaders): TraceContext | undefined;
+/** A `publish` or `publishAll` call. */
+interface PublishTraceInput {
+    /** The type of every event of the call, in order. */
+    readonly eventTypes: readonly string[];
+}
+/** A route sending one event to its transport. */
+interface SendTraceInput {
+    readonly envelope: EventEnvelope;
+    readonly transport: string;
+    /** The messaging system of the transport (`kafka`, `rabbitmq`), else its name. */
+    readonly system: string;
+    readonly destination: string;
+}
+/** A local handler running for one claimed delivery. */
+interface ProcessTraceInput {
+    readonly delivery: ClaimedDelivery;
+}
+/**
+ * Tracing hooks, for example from `@relaybus/otel`. Each one wraps an operation: it starts a span,
+ * calls `run` inside it and ends the span when the returned promise settles, passing its result or
+ * error through unchanged. relaybus itself depends on no tracing library.
+ */
+interface RelayBusTracer {
+    /**
+     * Wraps one publish call. `run` takes the trace headers (`traceparent`, `tracestate`) to write
+     * into every event of the call, so its consumers continue the trace; headers passed to
+     * `publish` explicitly win.
+     */
+    publish?<T>(input: PublishTraceInput, run: (headers: EventHeaders) => Promise<T>): Promise<T>;
+    /**
+     * Wraps one send of a route. `run` takes the trace headers to send the event with, in place of
+     * the ones it was stored with, so the consumer's trace continues from this send.
+     */
+    send?<T>(input: SendTraceInput, run: (headers: EventHeaders) => Promise<T>): Promise<T>;
+    /**
+     * Wraps one run of a local handler; the handler runs inside `run`, so what it publishes or calls
+     * joins the span. The event's own trace context is in `traceContextOf(delivery.event.headers)`.
+     */
+    process?<T>(input: ProcessTraceInput, run: () => Promise<T>): Promise<T>;
+}
+
+type FailureStage = 'claim' | 'dispatch' | 'complete' | 'reschedule' | 'bury' | 'release' | 'relinquish' | 'extend-lease' | 'purge' | 'watch' | 'backlog' | 'observer';
+/** How a timed operation ended. On `error` the event carries the error. */
+type OperationOutcome = 'success' | 'error';
+/** Whether a delivery runs a local handler or forwards its event to a transport (a route). */
+type DeliveryKind = 'handler' | 'route';
+/** A `publish` or `publishAll` call returned or threw. */
+interface PublishFinishedEvent {
+    /** The type of every event of the call, in order. */
+    readonly eventTypes: readonly string[];
+    readonly durationMs: number;
+    readonly outcome: OperationOutcome;
+    readonly error?: ErrorInfo;
+}
+/** One claim query of the dispatcher answered or failed. */
+interface ClaimFinishedEvent {
+    /** Handler ids the claim asked for. */
+    readonly handlers: readonly string[];
+    /** Most deliveries the claim asked for (the batch size of this query). */
+    readonly requested: number;
+    readonly claimed: number;
+    /** Distinct leases among the claimed deliveries: a store that leases lanes counts each lane once. */
+    readonly lanes: number;
+    readonly durationMs: number;
+    readonly outcome: OperationOutcome;
+    readonly error?: ErrorInfo;
+}
+/** A handler (or a route's send) is about to run for a claimed delivery. */
+interface HandlerStartedEvent {
+    readonly delivery: ClaimedDelivery;
+    readonly kind: DeliveryKind;
+    /** From the event's `occurredAt` to this start, across services for a received event. */
+    readonly endToEndLatencyMs: number;
+}
+/**
+ * A handler run ended: it resolved (`success`) or threw, timed out, lost its lease or was
+ * stopped (`error`). What happens to the delivery next is reported by the delivery hooks.
+ */
+interface HandlerFinishedEvent {
+    readonly delivery: ClaimedDelivery;
+    readonly kind: DeliveryKind;
+    readonly durationMs: number;
+    readonly outcome: OperationOutcome;
+    readonly error?: ErrorInfo;
+}
+/** A route handed an event to its transport, which acknowledged it or failed. */
+interface TransportSentEvent {
+    readonly envelope: EventEnvelope;
+    /** Name of the transport. */
+    readonly transport: string;
+    /** The messaging system of the transport (`kafka`, `rabbitmq`), else its name. */
+    readonly system: string;
+    readonly destination: string;
+    readonly durationMs: number;
+    readonly outcome: OperationOutcome;
+    readonly error?: ErrorInfo;
+}
+/**
+ * What `receive` did with an event from a broker: stored it (`accepted`), found it stored already
+ * (`duplicate`), had no handler for it (`ignored`), rejected it as malformed (`invalid`) or failed
+ * (`error`, the broker redelivers it).
+ */
+type ReceiveOutcome = 'accepted' | 'duplicate' | 'ignored' | 'invalid' | 'error';
+/** One event from a broker went through `receive`. */
+interface ReceiveFinishedEvent {
+    /** Name of the transport that delivered it; undefined when `bus.receive` was called directly. */
+    readonly transport: string | undefined;
+    /** Messaging system of that transport (`kafka`, `rabbitmq`), else its name. */
+    readonly system: string | undefined;
+    /** Topic, routing key or queue it arrived on, when the transport tells. */
+    readonly destination: string | undefined;
+    /** The event's type and source as received; undefined when missing or not text. */
+    readonly eventType: string | undefined;
+    readonly source: string | undefined;
+    /** W3C trace context the event carries, to continue the trace of its publisher. */
+    readonly traceContext: TraceContext | undefined;
+    readonly outcome: ReceiveOutcome;
+    readonly durationMs: number;
+    readonly error?: ErrorInfo;
+}
+/**
+ * A transport could not decode an inbound message (codec failure, malformed record) and
+ * dead-lettered or skipped it. It never reached the bus, so `onReceiveFinished` does not see it.
+ */
+interface InvalidMessageEvent {
+    /** Name of the transport. */
+    readonly transport: string;
+    /** The messaging system of the transport (`kafka`, `rabbitmq`), else its name. */
+    readonly system: string;
+    /** Topic, routing key or queue the message arrived on. */
+    readonly destination: string;
+    /** Why the message was rejected. */
+    readonly reason: string;
+    readonly error: ErrorInfo;
+}
+/** A periodic reading of the store's backlog (`RelayBusOptions.backlogInterval`). */
+interface BacklogEvent {
+    /** Deliveries waiting to run, due or not. */
+    readonly pending: number;
+    /** How long the oldest due delivery has waited; 0 when none is due. */
+    readonly oldestPendingAgeMs: number;
+    readonly statistics: EventStoreStatistics;
+}
 /**
  * Hooks for logging, metrics and tracing. Every method is optional, runs
  * synchronously on the hot path and must not throw; errors it throws are
@@ -769,6 +896,17 @@ interface RelayBusObserver {
         readonly stage: FailureStage;
         readonly error: ErrorInfo;
     }): void;
+    /** A publish call ended; called before the publishing transaction commits. */
+    onPublishFinished?(event: PublishFinishedEvent): void;
+    onClaimFinished?(event: ClaimFinishedEvent): void;
+    onHandlerStarted?(event: HandlerStartedEvent): void;
+    onHandlerFinished?(event: HandlerFinishedEvent): void;
+    onTransportSent?(event: TransportSentEvent): void;
+    onReceiveFinished?(event: ReceiveFinishedEvent): void;
+    /** A transport rejected an inbound message it could not decode. */
+    onInvalidMessage?(event: InvalidMessageEvent): void;
+    /** Called every `backlogInterval` while the bus runs, when that option is set. */
+    onBacklog?(event: BacklogEvent): void;
 }
 /** Minimal logger. Nest's `Logger` and `console` both satisfy it. */
 interface RelayBusLogger {
@@ -777,8 +915,35 @@ interface RelayBusLogger {
     error(message: string): void;
 }
 
-/** Receives an event from a broker. Resolve only after it is durably stored. */
-type TransportMessageHandler = (envelope: EventEnvelope) => Promise<void>;
+/** Where an incoming message came from, for observers and traces. */
+interface TransportMessage {
+    /** Topic, routing key or queue the message arrived on. */
+    readonly destination: string;
+}
+/** A message the transport could not turn into an event, so it never reaches the bus. */
+interface InvalidTransportMessage {
+    /** Topic, routing key or queue the message arrived on. */
+    readonly destination: string;
+    /** What the codec or decoder threw. */
+    readonly error: unknown;
+}
+/**
+ * What the bus offers a transport at `subscribe`, beyond the message handler. Present only when
+ * an observer implements the matching hook, so a transport can skip the work otherwise.
+ */
+interface TransportSubscriptionHooks {
+    /**
+     * Call once for each inbound message the transport rejected as undecodable (dead-lettered or
+     * skipped) before it reached `onMessage`. Messages the bus rejected itself are reported by
+     * `onReceiveFinished` and must not be reported here. Never throws.
+     */
+    readonly onInvalidMessage: (message: InvalidTransportMessage) => void;
+}
+/**
+ * Receives an event from a broker. Resolve only after it is durably stored. Transports pass
+ * `message` to tell where the event arrived; it is optional for transports written before it.
+ */
+type TransportMessageHandler = (envelope: EventEnvelope, message?: TransportMessage) => Promise<void>;
 /**
  * Broker port used to exchange events between services.
  *
@@ -792,17 +957,25 @@ type TransportMessageHandler = (envelope: EventEnvelope) => Promise<void>;
 interface Transport {
     /** Unique name referenced by routes and subscriptions. */
     readonly name: string;
+    /**
+     * The messaging system, as OpenTelemetry names it (`kafka`, `rabbitmq`), reported to observers
+     * and traces. Default: the transport's name.
+     */
+    readonly system?: string;
     connect?(): Promise<void>;
     publish(envelope: EventEnvelope, destination: string): Promise<void>;
-    subscribe?(destinations: readonly string[], onMessage: TransportMessageHandler): Promise<void>;
+    subscribe?(destinations: readonly string[], onMessage: TransportMessageHandler, hooks?: TransportSubscriptionHooks): Promise<void>;
     /**
      * Whether the transport can currently publish and, when subscribed, is
      * consuming. Health checks use it to report a dead consumer or a lost
      * connection. Transports without it count as ready.
      */
     isReady?(): boolean;
-    /** Releases connections. A closed transport is not reopened. */
-    close(): Promise<void>;
+    /**
+     * Releases connections. A closed transport is not reopened. Once `options.signal` aborts (the
+     * shutdown deadline passed), stop waiting and drop the connections it opened itself.
+     */
+    close(options?: CloseOptions): Promise<void>;
 }
 
 /**
@@ -830,7 +1003,11 @@ interface DispatcherOptions {
     readonly pollInterval?: Duration;
     /** Lease length; renewed every third of it while the handler runs. Default `'30s'`. */
     readonly leaseDuration?: Duration;
-    /** How long `stop` waits for running handlers before aborting them. Default `'30s'`. */
+    /**
+     * Longest `stop` takes in all, and its default `timeout`: waiting for running handlers, handing
+     * back leases, closing transports and the store. Past it, `stop` aborts the handlers still
+     * running, force-closes what relaybus opened itself and resolves. Default `'30s'`.
+     */
     readonly shutdownTimeout?: Duration;
     /**
      * Longest a finished delivery waits so that deliveries finishing around the
@@ -855,6 +1032,11 @@ interface RetentionOptions {
     /** How often the cleanup runs. Default `'1h'`. */
     readonly interval?: Duration;
 }
+/**
+ * Every route to one destination of one transport is one handler,
+ * `relaybus.transport:<transport>:<destination>`: its events of one key are sent in commit
+ * order whatever their types. Such routes must resolve to the same `retry` and `timeout`.
+ */
 interface RouteOptions {
     /** Event class or type forwarded to the transport. */
     readonly event: EventReference;
@@ -877,6 +1059,15 @@ interface RelayBusOptions<TTransaction = unknown> {
     readonly source?: string;
     /** Default `'required'`. */
     readonly transactionMode?: TransactionMode;
+    /**
+     * Time budget of every `bus.transaction` (and `@RelayBusTransaction()` method). The store makes
+     * the database enforce it where it can (PostgreSQL: `statement_timeout`, plus
+     * `idle_in_transaction_session_timeout` and on PostgreSQL 17+ `transaction_timeout`; MongoDB:
+     * `maxCommitTimeMS`), and a transaction that still runs past
+     * it is rolled back with a {@link TransactionTimeoutError}. Keep calls to other services out of
+     * transactions instead of raising it. Default `'5s'`.
+     */
+    readonly transactionTimeout?: Duration;
     /**
      * Finds the caller's active transaction when none is passed to `publish`
      * and none was opened with `bus.transaction`, for example from
@@ -898,7 +1089,23 @@ interface RelayBusOptions<TTransaction = unknown> {
     readonly subscriptions?: readonly InboundSubscriptionOptions[];
     /** Create tables and indexes on start. Default true. */
     readonly setupStore?: boolean;
+    /**
+     * Hooks for logging and metrics. The hooks an observer implements are read when the bus is
+     * created; the newer ones (`onPublishFinished` and the other timed hooks) are skipped entirely,
+     * clock reads included, when no observer implements them.
+     */
     readonly observers?: readonly RelayBusObserver[];
+    /**
+     * Spans around publish, send and handler runs, and the W3C trace context written into published
+     * events (`traceparent`, `tracestate` headers). `@relaybus/otel` provides one. Default: none.
+     */
+    readonly tracer?: RelayBusTracer;
+    /**
+     * Reads `statistics()` this often while the bus runs and reports the backlog (pending deliveries,
+     * age of the oldest due one) to the observers' `onBacklog`. Each reading is a store query, so it
+     * is off unless set; `'15s'` to `'1m'` suits metrics scraped every minute. Default: off.
+     */
+    readonly backlogInterval?: Duration;
     /** Default: `console`. */
     readonly logger?: RelayBusLogger;
     readonly clock?: Clock;
@@ -921,7 +1128,9 @@ interface PublishOptions<TTransaction = unknown> {
     /**
      * Ordering and partition key. Events with the same key are handled one at a
      * time per handler, in commit order. A delayed or retrying event holds back
-     * later events of its key.
+     * later events of its key. Default: the `key` of the event's definition
+     * (`defineEvent(type, { key })`), else none. An explicit key wins over the definition's, and in
+     * `publishAll` applies to every event of the call.
      */
     readonly key?: string;
     /** Deliver no earlier than this delay from now. */
@@ -942,6 +1151,27 @@ interface PublishOneOptions<TTransaction = unknown> extends PublishOptions<TTran
     readonly id?: string;
 }
 type ReceiveStatus = 'accepted' | 'duplicate' | 'ignored';
+
+interface StopOptions {
+    /**
+     * Longest the whole `stop` may take. Default: `dispatcher.shutdownTimeout`. Keep it below the time
+     * the platform waits before killing the process (Kubernetes `terminationGracePeriodSeconds`).
+     */
+    readonly timeout?: Duration;
+}
+/** How a `stop` went. */
+interface StopResult {
+    /** False when the deadline passed and `stop` aborted handlers or force-closed connections. */
+    readonly graceful: boolean;
+    /**
+     * Deliveries whose handlers still ran at the deadline. Their leases expire after
+     * `dispatcher.leaseDuration` and another process runs them again (at-least-once).
+     */
+    readonly abandonedDeliveries: number;
+    /** Time `stop` took, on the bus clock. */
+    readonly durationMs: number;
+}
+
 /**
  * Reliable event bus: events are stored with business data in one transaction,
  * then dispatched to every subscribed handler and route with independent
@@ -1005,9 +1235,16 @@ declare class RelayBus<TTransaction = unknown> {
     publishAll(events: readonly DomainEvent[], options?: PublishOptions<TTransaction>): Promise<EventEnvelope[]>;
     /**
      * Runs `work` in a new store transaction. `publish` calls inside it join the
-     * transaction without passing it explicitly.
+     * transaction without passing it explicitly. The transaction is held to `transactionTimeout`
+     * and rolled back with a {@link TransactionTimeoutError} when it runs past it.
      */
     transaction<T>(work: (transaction: TTransaction) => Promise<T>): Promise<T>;
+    /**
+     * The transaction `publish` would join right now: the one of the enclosing `bus.transaction`
+     * (or `@RelayBusTransaction()` method, or transactional handler), else the one
+     * `transactionResolver` finds. Repositories use it to write in the same transaction.
+     */
+    currentTransaction(): TTransaction | undefined;
     /**
      * Stores an event received from a broker and schedules it for local handlers.
      * Idempotent on the event id. Transports call it and acknowledge the message
@@ -1022,10 +1259,15 @@ declare class RelayBus<TTransaction = unknown> {
      */
     start(): Promise<void>;
     /**
-     * Stops dispatching, waits for running handlers, closes transports and the
-     * store. Waits for a start in progress first. Safe to call more than once.
+     * Stops claiming, waits for running handlers, hands back leases, closes transports and the store,
+     * all within `options.timeout` (default `dispatcher.shutdownTimeout`). When the deadline passes it
+     * aborts the handlers still running, force-closes what relaybus opened itself (never pools or
+     * clients the application passed in) and resolves anyway: it never rejects because of the
+     * deadline. Abandoned deliveries stay leased until their lease expires and then run again
+     * (at-least-once). Waits for a start in progress first. Safe to call more than once: later calls
+     * get the result of the first.
      */
-    stop(): Promise<void>;
+    stop(options?: StopOptions): Promise<StopResult>;
     /**
      * Claims and runs one batch of due deliveries, resolving when they settle.
      * Returns how many ran. Intended for tests and scripts.
@@ -1077,6 +1319,17 @@ declare class CatalogPublisher<TCatalog extends Catalog, TTransaction = unknown,
     publishAll(events: readonly CatalogEvents<TCatalog, TName>[], options?: PublishOptions<TTransaction>): Promise<EventEnvelope[]>;
 }
 
+/** Transaction handle of {@link InMemoryEventStore}. Writes apply on commit only. */
+declare class InMemoryTransaction {
+    #private;
+    get state(): 'open' | 'committed' | 'rolled-back';
+    enqueue(operation: () => void): void;
+    /** Runs `finisher` once the transaction commits or rolls back, like a lock release. */
+    onFinish(finisher: () => void): void;
+    commit(): void;
+    rollback(): void;
+}
+
 interface InMemoryEventStoreOptions {
     /** Allow use when `NODE_ENV` is `production`. Data is lost on restart. Default false. */
     readonly allowInProduction?: boolean;
@@ -1088,16 +1341,6 @@ interface InMemoryEventStoreOptions {
      */
     readonly retainCompleted?: boolean;
 }
-/** Transaction handle of {@link InMemoryEventStore}. Writes apply on commit only. */
-declare class InMemoryTransaction {
-    #private;
-    get state(): 'open' | 'committed' | 'rolled-back';
-    enqueue(operation: () => void): void;
-    /** Runs `finisher` once the transaction commits or rolls back, like a lock release. */
-    onFinish(finisher: () => void): void;
-    commit(): void;
-    rollback(): void;
-}
 /**
  * Event store kept in process memory, with the same semantics as the database
  * stores: transactional appends, leases, fencing and per-key ordering. Payloads
@@ -1122,4 +1365,4 @@ declare class InMemoryEventStore implements EventStore<InMemoryTransaction> {
     statistics(now: Date): Promise<EventStoreStatistics>;
 }
 
-export { type AppendEntry, type AppendResult, type Catalog, type CatalogDeclaration, type CatalogDescription, type CatalogEntry, type CatalogEventClass, type CatalogEventName, type CatalogEventSelection, type CatalogEvents, CatalogPublisher, type CatalogRole, type ClaimRequest, type ClaimedDelivery, type Clock, ConfigurationError, DEFAULT_RETRY_POLICY, DEFAULT_ROUTE_RETRY_POLICY, DELIVERY_STATUSES, type DefineCatalogOptions, type DefineEventOptions, type DeliveryQuery, type DeliveryRecord, type DeliveryStatus, type DispatcherOptions, DispatcherStoppedError, type DomainEvent, type Duration, type ErrorInfo, type EventClass, type EventEnvelope, type EventHandler, type EventHeaders, type EventOf, type EventReference, type EventStore, type EventStoreStatistics, EventValidationError, type FailureStage, type HandlerContext, type HandlerDescriptor, type HandlerShapeOf, HandlerTimeoutError, type HandlersOf, type IdentifierGenerator, InMemoryEventStore, type InMemoryEventStoreOptions, InMemoryTransaction, type InboundSubscriptionOptions, InvalidEnvelopeError, type JitterStrategy, LeaseLostError, type LeaseReference, MAX_TIMER_DELAY_MS, type MatchingHandlers, type NewDelivery, type NoExtraHandlers, NonRetryableError, type PartialHandlersOf, type PayloadOf, type PublishOneOptions, type PublishOptions, type PublishTarget, type PurgeRequest, type PurgeResult, type ReceiveStatus, RelayBus, RelayBusError, type RelayBusLogger, type RelayBusObserver, type RelayBusOptions, type RetentionOptions, type RetryPolicy, type RetryPolicyOptions, type RouteOptions, StandardSchemaV1, type SubscribeCatalogOptions, type SubscribeOptions, type TransactionMode, TransactionRequiredError, type Transport, type TransportMessageHandler, type UnroutedEventPolicy, type ValidationIssue, assertEventType, computeRetryDelay, consume, createRetryPolicy, createUuidV7, defineCatalog, defineEvent, defineHandlers, describeCatalog, isRetryableError, produce, systemClock, toErrorInfo, toMilliseconds, validatePayload };
+export { type AppendEntry, type AppendResult, AttemptsExhaustedError, type BacklogEvent, type Catalog, type CatalogDeclaration, type CatalogDescription, type CatalogEntry, type CatalogEventClass, type CatalogEventName, type CatalogEventSelection, type CatalogEvents, CatalogPublisher, type CatalogRole, type ClaimFinishedEvent, type ClaimRequest, type ClaimedDelivery, Clock, type CloseOptions, ConfigurationError, DEFAULT_RETRY_POLICY, DEFAULT_ROUTE_RETRY_POLICY, DELIVERY_STATUSES, type DefineCatalogOptions, type DeliveryKind, type DeliveryQuery, type DeliveryRecord, type DeliveryStatus, type DispatcherOptions, DispatcherStoppedError, DomainEvent, DrainIncompleteError, type Duration, type ErrorInfo, EventClass, EventEnvelope, type EventHandler, EventHeaders, type EventOf, EventReference, type EventStore, type EventStoreStatistics, type EventStoreTransactionOptions, EventValidationError, type FailureStage, type HandlerContext, type HandlerDescriptor, type HandlerFinishedEvent, type HandlerShapeOf, type HandlerStartedEvent, HandlerTimeoutError, type HandlersOf, type IdentifierGenerator, InMemoryEventStore, type InMemoryEventStoreOptions, InMemoryTransaction, type InboundSubscriptionOptions, InvalidEnvelopeError, type InvalidMessageEvent, type InvalidTransportMessage, type JitterStrategy, LeaseLostError, type LeaseReference, LifecycleError, MAX_TIMER_DELAY_MS, type MatchingHandlers, type NewDelivery, type NoExtraHandlers, NonRetryableError, type OperationOutcome, type PartialHandlersOf, PayloadOf, type ProcessTraceInput, type PublishFinishedEvent, type PublishOneOptions, type PublishOptions, type PublishTarget, type PublishTraceInput, type PurgeRequest, type PurgeResult, type ReceiveFinishedEvent, type ReceiveOutcome, type ReceiveStatus, RelayBus, RelayBusError, type RelayBusLogger, type RelayBusObserver, type RelayBusOptions, type RelayBusTracer, type RetentionOptions, type RetryPolicy, type RetryPolicyOptions, type RouteOptions, type SendTraceInput, StandardSchemaV1, type StopOptions, type StopResult, type SubscribeCatalogOptions, type SubscribeOptions, TRACEPARENT_HEADER, TRACESTATE_HEADER, type TraceContext, type TransactionMode, TransactionRequiredError, TransactionTimeoutError, type Transport, type TransportMessage, type TransportMessageHandler, type TransportSentEvent, type TransportSubscriptionHooks, type UnroutedEventPolicy, type ValidationIssue, computeRetryDelay, consume, createRetryPolicy, createUuidV7, defineCatalog, defineHandlers, describeCatalog, isRetryableError, produce, toErrorInfo, toMilliseconds, traceContextOf };