@relaybus/core 0.3.0 → 0.3.1

package/dist/transport-BlfzIBZD.d.cts

@@ -0,0 +1,535 @@
+/** Source of the current time. Replace it in tests to control retries and leases. */
+interface Clock {
+    now(): Date;
+    /**
+     * Runs `task.run` after `task.delayMs` milliseconds, again every `delayMs` when `repeat` is set, and
+     * returns a function that cancels it. `unref` marks a timer that must not keep the process alive.
+     * Optional: without it relaybus uses the platform timers. Implement it to control timers in tests
+     * (`FakeClock` does with `controlTimers: true`).
+     */
+    schedule?(task: {
+        readonly run: () => void;
+        readonly delayMs: number;
+        readonly repeat?: boolean;
+        readonly unref?: boolean;
+    }): () => void;
+}
+declare const systemClock: Clock;
+
+/**
+ * A duration in milliseconds, or a string such as `'250ms'`, `'30s'`, `'5m'`,
+ * `'1h'` or `'7d'`.
+ */
+type Duration = number | `${number}${DurationUnit}`;
+type DurationUnit = 'ms' | 's' | 'm' | 'h' | 'd';
+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;
+}
+/**
+ * Derives the ordering key of an event from its validated payload. Declared bivariantly so an
+ * event class stays assignable wherever its payload type is widened.
+ */
+type EventKeyFunction<TPayload> = {
+    bivarianceHack(payload: TPayload): string;
+}['bivarianceHack'];
+/** A class created with {@link defineEvent}. */
+interface EventClass<TPayload = unknown> {
+    new (payload: TPayload): DomainEvent<TPayload>;
+    readonly type: string;
+    readonly schema: StandardSchemaV1<unknown, TPayload> | undefined;
+    /** The `key` given to {@link defineEvent}; undefined for events without one. */
+    readonly key?: EventKeyFunction<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;
+    /** Ordering key of every event of this type, from its validated payload. See {@link DefineEventKeyOptions}. */
+    readonly key?: (payload: StandardSchemaV1.InferOutput<TSchema>) => string;
+}
+interface DefineEventKeyOptions<TPayload> {
+    /**
+     * Ordering key of every event of this type, from its payload: `(payload) => payload.orderId`.
+     * Typed from the payload, so a missing field or a non-string fails to compile. `publish` uses it
+     * when it is given no `key`; an explicit `key` option wins (for `publishAll`, the one key of the
+     * call applies to every event). It must return a non-empty string.
+     */
+    readonly key: (payload: TPayload) => string;
+}
+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 }) {}
+ * export class OrderPaid extends defineEvent('order.paid.v1', {
+ *   schema: orderPaidSchema,
+ *   key: (payload) => payload.orderId,
+ * }) {}
+ * export class OrderCancelled extends defineEvent<{ orderId: string }>('order.cancelled.v1', {
+ *   key: (payload) => payload.orderId,
+ * }) {}
+ * ```
+ */
+declare function defineEvent<TSchema extends StandardSchemaV1>(type: string, options: DefineEventOptions<TSchema>): EventClass<StandardSchemaV1.InferOutput<TSchema>>;
+declare function defineEvent<TPayload>(type: string, options?: DefineEventKeyOptions<TPayload>): 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>;
+
+/**
+ * Base class of every error thrown by relaybus.
+ */
+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
+ * `transactionMode: 'required'` (the default). Publishing outside a transaction
+ * would reintroduce the dual-write problem the outbox exists to prevent.
+ */
+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
+ * remaining retry attempts.
+ */
+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[]);
+}
+/**
+ * A message received from a broker is not a valid event. Never retried:
+ * transports should dead-letter it instead of redelivering it forever.
+ */
+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.
+     */
+    readonly storeConfirmed: boolean;
+    constructor(message: string, options?: {
+        readonly storeConfirmed?: boolean;
+    });
+}
+/** 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
+ * finished. The delivery is released and runs again without losing an attempt.
+ */
+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;
+    readonly path?: readonly PropertyKey[] | undefined;
+}
+/** Serializable snapshot of an error, stored with failed deliveries. */
+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;
+
+/**
+ * Lifecycle of one handler's delivery of one event.
+ * `pending` (waiting or scheduled for retry) -> `processing` (leased by a worker)
+ * -> `completed` | `pending` (retry) | `dead` (exhausted or non-retryable).
+ * `dead` -> `pending` only through an explicit requeue.
+ *
+ * A completed delivery is deleted. `completed` records exist only in stores
+ * configured to keep a completion history (`retainCompleted` /
+ * `completionHistory`), where they are listed, counted and purged like before.
+ */
+type DeliveryStatus = 'pending' | 'processing' | 'completed' | 'dead';
+declare const DELIVERY_STATUSES: readonly DeliveryStatus[];
+interface NewDelivery {
+    readonly id: string;
+    /** Stable handler id. Together with the event id it is unique. */
+    readonly handler: string;
+    readonly availableAt: Date;
+}
+interface AppendEntry {
+    readonly event: EventEnvelope;
+    readonly deliveries: readonly NewDelivery[];
+}
+interface AppendResult {
+    /** Events written by this call. */
+    readonly appendedEventIds: readonly string[];
+    /** Events that already existed. Their missing deliveries were still added. */
+    readonly duplicateEventIds: readonly string[];
+    /** Deliveries written by this call. Existing (event, handler) pairs are skipped. */
+    readonly appendedDeliveryCount: number;
+}
+/**
+ * Lease expiry is compared with the `now` the caller passes, taken from the
+ * bus clock. Keep worker clocks synchronized (NTP): a skew larger than a third
+ * of the lease duration lets another worker reclaim a delivery that is still running.
+ *
+ * Stores may grant the lease on a group of deliveries (a lane) instead of on
+ * each delivery. The group is exclusive to `leaseOwner` while the lease is
+ * live, so other owners do not see its pending deliveries until it expires or
+ * is relinquished; every delivery of the group carries the group's fencing token.
+ */
+interface ClaimRequest {
+    /** Only deliveries of these handlers are claimed. */
+    readonly handlers: readonly string[];
+    readonly limit: number;
+    readonly leaseOwner: string;
+    readonly leaseExpiresAt: Date;
+    readonly now: Date;
+}
+/**
+ * Proof of ownership. Every state change after a claim must present it
+ * (fencing). A lease stays valid until another claim replaces it, even after
+ * its expiry time; expiry only makes the delivery claimable again.
+ */
+interface LeaseReference {
+    readonly deliveryId: string;
+    readonly leaseToken: string;
+}
+interface ClaimedDelivery extends LeaseReference {
+    readonly handler: string;
+    /** Attempt number of this claim, starting at 1. */
+    readonly attempt: number;
+    readonly leaseExpiresAt: Date;
+    readonly event: EventEnvelope;
+}
+interface DeliveryRecord {
+    readonly id: string;
+    readonly handler: string;
+    readonly status: DeliveryStatus;
+    readonly attempts: number;
+    readonly availableAt: Date;
+    readonly leaseOwner: string | null;
+    readonly leaseExpiresAt: Date | null;
+    readonly lastError: ErrorInfo | null;
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+    readonly completedAt: Date | null;
+    readonly event: EventEnvelope;
+}
+interface DeliveryQuery {
+    readonly status?: DeliveryStatus;
+    readonly handler?: string;
+    readonly eventType?: string;
+    readonly eventId?: string;
+    /** Default 100. */
+    readonly limit?: number;
+}
+interface PurgeRequest {
+    /** Delete completed deliveries completed before this instant. */
+    readonly completedBefore?: Date;
+    /** Delete dead deliveries last updated before this instant. */
+    readonly deadBefore?: Date;
+}
+interface PurgeResult {
+    readonly deletedDeliveries: number;
+    /** Events deleted because no delivery referenced them any more. */
+    readonly deletedEvents: number;
+}
+interface EventStoreStatistics {
+    readonly pending: number;
+    readonly processing: number;
+    readonly completed: number;
+    readonly dead: number;
+    /** `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.
+ *
+ * Every implementation must pass the contract suite in `@relaybus/testing`.
+ */
+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. `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
+     * events in commit order.
+     */
+    append(transaction: TTransaction, entries: readonly AppendEntry[], now: Date): Promise<AppendResult>;
+    /**
+     * Leases up to `limit` deliveries that are due: pending with `availableAt <= now`,
+     * or processing with an expired lease. A keyed delivery is only claimable when
+     * no earlier delivery of the same handler and key is pending or processing.
+     * Counts the attempt (`attempt` of the result; a store may persist the count
+     * only when the attempt fails or its lease is lost). Safe to call from many
+     * processes at once.
+     */
+    claim(request: ClaimRequest): Promise<ClaimedDelivery[]>;
+    /** Extends a lease the caller still holds. Returns false when the lease was lost. */
+    extendLease(lease: LeaseReference, leaseExpiresAt: Date, now: Date): Promise<boolean>;
+    /**
+     * Marks a leased delivery completed by deleting it (or moving it to the
+     * completion history, when the store keeps one). With `transaction` the change
+     * commits together with the handler's own writes. Returns false when the lease
+     * was lost.
+     */
+    complete(lease: LeaseReference, now: Date, transaction?: TTransaction): Promise<boolean>;
+    /** Returns a leased delivery to pending, due at `availableAt`. */
+    reschedule(lease: LeaseReference, availableAt: Date, error: ErrorInfo, now: Date): Promise<boolean>;
+    /**
+     * Gives a leased delivery back without counting the attempt: pending, due
+     * now, attempts decremented. Used when a handler is aborted at shutdown.
+     */
+    release(lease: LeaseReference, now: Date): Promise<boolean>;
+    /**
+     * Marks many leased deliveries completed with one round trip. Returns, for
+     * every lease in the same order, whether it was completed (false: lease lost
+     * or already finished). Each lease is fenced individually, exactly as in
+     * {@link EventStore.complete}. Optional: the dispatcher falls back to
+     * `complete` when a store does not implement it.
+     */
+    completeMany?(leases: readonly LeaseReference[], now: Date): Promise<boolean[]>;
+    /** Moves a leased delivery to dead. */
+    bury(lease: LeaseReference, error: ErrorInfo, now: Date): Promise<boolean>;
+    listDeliveries(query: DeliveryQuery): Promise<DeliveryRecord[]>;
+    /** Moves dead deliveries back to pending with a fresh attempt budget. Returns how many moved. */
+    requeue(deliveryIds: readonly string[], now: Date): Promise<number>;
+    purge(request: PurgeRequest): Promise<PurgeResult>;
+    statistics(now: Date): Promise<EventStoreStatistics>;
+    /**
+     * Hands back every lease group that `leaseOwner` holds without running work,
+     * so other workers can take them at once instead of after lease expiry.
+     * Called at graceful shutdown after the owner's deliveries settled. Groups
+     * with running deliveries stay leased. Optional.
+     */
+    relinquish?(leaseOwner: string, now: Date): Promise<void>;
+    /**
+     * Calls `listener` soon after a transaction that added deliveries due at once has committed, in this
+     * process or in any other one, so an idle dispatcher claims them without waiting for its next poll.
+     * A hint, never a guarantee: a report may be late, merged with others, or lost (while a connection
+     * is re-established, for instance), and polling still finds every delivery. Resolves with a function
+     * 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; forced once `options.signal` aborts. */
+    close?(options?: CloseOptions): 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.
+ *
+ * Outbound: the bus calls `publish` from a delivery, so a broker outage only
+ * delays events; the outbox keeps them. `publish` must resolve only after the
+ * broker acknowledged the message.
+ *
+ * Inbound: `subscribe` must acknowledge a message only after `onMessage`
+ * resolved, and redeliver it when `onMessage` rejects (at-least-once).
+ */
+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, 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. Once `options.signal` aborts (the
+     * shutdown deadline passed), stop waiting and drop the connections it opened itself.
+     */
+    close(options?: CloseOptions): Promise<void>;
+}
+
+export { toMilliseconds as $, type AppendEntry as A, type InvalidTransportMessage as B, type ClaimedDelivery as C, type Duration as D, type EventEnvelope as E, LeaseLostError as F, LifecycleError as G, HandlerTimeoutError as H, InvalidEnvelopeError as I, NonRetryableError as J, TransactionRequiredError as K, type LeaseReference as L, MAX_TIMER_DELAY_MS as M, type NewDelivery as N, TransactionTimeoutError as O, type PayloadOf as P, type TransportMessage as Q, RelayBusError as R, StandardSchemaV1 as S, type Transport as T, type TransportMessageHandler as U, type TransportSubscriptionHooks as V, type ValidationIssue as W, assertEventType as X, defineEvent as Y, systemClock as Z, toErrorInfo as _, type DomainEvent as a, validatePayload as a0, type EventHeaders as b, type EventStoreStatistics as c, type ErrorInfo as d, type PurgeResult as e, type EventStore as f, type EventReference as g, type Clock as h, type AppendResult as i, type ClaimRequest as j, type DeliveryQuery as k, type DeliveryRecord as l, type PurgeRequest as m, type EventClass as n, AttemptsExhaustedError as o, type CloseOptions as p, ConfigurationError as q, DELIVERY_STATUSES as r, type DefineEventKeyOptions as s, type DefineEventOptions as t, type DeliveryStatus as u, DispatcherStoppedError as v, DrainIncompleteError as w, type EventKeyFunction as x, type EventStoreTransactionOptions as y, EventValidationError as z };