@ocoda/event-sourcing-mariadb 3.0.2 → 4.0.0-next.0

package/README.md

@@ -25,6 +25,14 @@ This is a complementing module for `@ocoda/event-sourcing`, a powerful library d
 
 This store-driver library uses [MariaDB](https://mariadb.com/) as an underlying driver for event- and snapshot-stores, and needs to be installed together with the core module `@ocoda/event-sourcing` in order to get started.
 
+## Installation
+The `mariadb` driver is a peer dependency, so install it next to the core module:
+```bash
+npm install @ocoda/event-sourcing @ocoda/event-sourcing-mariadb mariadb
+```
+
+Requires Node.js 22.12 or later and NestJS 12. The package is ESM-only; CommonJS applications load it through `require()`, which Node.js supports for ES modules since 22.12.
+
 ## Documentation 📗
 Ready to dive right in? Visit [the documentation](https://ocoda.github.io/event-sourcing) to find out how to get started.
 

package/dist/index.d.ts

@@ -1,77 +1,4 @@
-import { IEventPayload, IEvent, EventStore, IEventPool, IEventCollection, IEventCollectionFilter, EventStream, IEventFilter, EventEnvelope, IAllEventsFilter, EventStoreConfig, AggregateRoot, ISnapshot, SnapshotStore, ISnapshotPool, ISnapshotCollection, ISnapshotCollectionFilter, SnapshotStream, ISnapshotFilter, SnapshotEnvelope, ILatestSnapshotFilter, SnapshotStoreConfig } from '@ocoda/event-sourcing';
-import { Type } from '@nestjs/common';
-import { PoolConfig } from 'mariadb';
-
-type MariaDBEventEntity = {
-    stream_id: string;
-    version: number;
-    event: string;
-    payload: IEventPayload<IEvent>;
-    event_id: string;
-    aggregate_id: string;
-    occurred_on: Date;
-    correlation_id: string | null;
-    causation_id: string | null;
-};
-
-declare class MariaDBEventStore extends EventStore<MariaDBEventStoreConfig> {
-    private pool;
-    connect(): Promise<void>;
-    disconnect(): Promise<void>;
-    ensureCollection(pool?: IEventPool): Promise<IEventCollection>;
-    listCollections(filter?: IEventCollectionFilter): AsyncGenerator<IEventCollection[]>;
-    getEvents({ streamId }: EventStream, filter?: IEventFilter): AsyncGenerator<IEvent[]>;
-    getEvent({ streamId }: EventStream, version: number, pool?: IEventPool): Promise<IEvent>;
-    appendEvents(stream: EventStream, aggregateVersion: number, events: IEvent[] | EventEnvelope[], pool?: IEventPool): Promise<EventEnvelope[]>;
-    getEnvelope({ streamId }: EventStream, version: number, pool?: IEventPool): Promise<EventEnvelope>;
-    getEnvelopes({ streamId }: EventStream, filter?: IEventFilter): AsyncGenerator<EventEnvelope[]>;
-    getAllEnvelopes(filter: IAllEventsFilter): AsyncGenerator<EventEnvelope[]>;
-    /**
-     * Best effort lookup of the latest version of a stream, used to report a conflict.
-     */
-    private getLatestVersion;
-}
-
-interface MariaDBEventStoreConfig extends EventStoreConfig, PoolConfig {
-    driver: Type<MariaDBEventStore>;
-}
-
-type MariaDBSnapshotEntity<A extends AggregateRoot> = {
-    stream_id: string;
-    version: number;
-    payload: ISnapshot<A>;
-    snapshot_id: string;
-    aggregate_id: string;
-    registered_on: Date;
-    aggregate_name: string;
-    latest?: string;
-};
-
-declare class MariaDBSnapshotStore extends SnapshotStore<MariaDBSnapshotStoreConfig> {
-    private pool;
-    connect(): Promise<void>;
-    disconnect(): Promise<void>;
-    ensureCollection(pool?: ISnapshotPool): Promise<ISnapshotCollection>;
-    listCollections(filter?: ISnapshotCollectionFilter): AsyncGenerator<ISnapshotCollection[]>;
-    getSnapshots<A extends AggregateRoot>({ streamId }: SnapshotStream, filter?: ISnapshotFilter): AsyncGenerator<ISnapshot<A>[]>;
-    getSnapshot<A extends AggregateRoot>({ streamId }: SnapshotStream, version: number, pool?: ISnapshotPool): Promise<ISnapshot<A>>;
-    appendSnapshot<A extends AggregateRoot>(stream: SnapshotStream, aggregateVersion: number, snapshot: ISnapshot<A>, pool?: ISnapshotPool): Promise<SnapshotEnvelope<A>>;
-    getLastSnapshot<A extends AggregateRoot>(stream: SnapshotStream, pool?: ISnapshotPool): Promise<ISnapshot<A> | void>;
-    getLastSnapshots<A extends AggregateRoot>(streams: SnapshotStream[], pool?: ISnapshotPool): Promise<Map<SnapshotStream, ISnapshot<A>>>;
-    getLastEnvelope<A extends AggregateRoot>(stream: SnapshotStream, pool?: ISnapshotPool): Promise<SnapshotEnvelope<A> | void>;
-    getEnvelopes<A extends AggregateRoot>({ streamId }: SnapshotStream, filter?: ISnapshotFilter): AsyncGenerator<SnapshotEnvelope<A>[]>;
-    getEnvelope<A extends AggregateRoot>({ streamId }: SnapshotStream, version: number, pool?: ISnapshotPool): Promise<SnapshotEnvelope<A>>;
-    getLastEnvelopesForAggregate<A extends AggregateRoot>(aggregate: Type<A>, filter?: ILatestSnapshotFilter): AsyncGenerator<SnapshotEnvelope<A>[]>;
-    getManyLastSnapshotEnvelopes<A extends AggregateRoot>(streams: SnapshotStream[], pool?: ISnapshotPool): Promise<Map<SnapshotStream, SnapshotEnvelope<A>>>;
-    private getLastStreamEntities;
-    /**
-     * Best effort lookup of the latest snapshot version of a stream, used to report a conflict.
-     */
-    private getLatestVersion;
-}
-
-interface MariaDBSnapshotStoreConfig extends SnapshotStoreConfig, PoolConfig {
-    driver: Type<MariaDBSnapshotStore>;
-}
-
-export { type MariaDBEventEntity, MariaDBEventStore, type MariaDBEventStoreConfig, type MariaDBSnapshotEntity, MariaDBSnapshotStore, type MariaDBSnapshotStoreConfig };
+export type * from './interfaces/index.js';
+export * from './mariadb.event-store.js';
+export * from './mariadb.snapshot-store.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,uBAAuB,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC"}