@robinmalfait/event-source 0.0.11 → 0.0.13

package/dist/{index.d.mts → index.d.cts}

@@ -1,12 +1,13 @@
-interface EventType<T extends string = any, P = any> {
+interface EventType<T extends string = any, P = any, M = any> {
     aggregateId: string;
     eventId: string;
     eventName: T;
     payload: P;
+    metadata: M;
     recordedAt: Date;
     version: number;
 }
-declare function Event<const T extends string, P = null>(eventName: T, aggregateId: string, payload?: P): EventType<T, P>;
+declare function Event<const T extends string, P = null, M = null>(eventName: T, aggregateId: string, payload?: P, metadata?: M): EventType<T, P>;
 
 type ApplyConcreteEvents<Events extends EventType> = Events extends EventType<infer EventName, any> ? {
     [T in EventName]: (event: Extract<Events, {
@@ -23,7 +24,7 @@ declare abstract class Aggregate {
     replayEvents(events?: EventType[]): this;
     private applyAnEvent;
     protected recordThat<T extends EventType>(event: T): this;
-    releaseEvents(): EventType<any, any>[];
+    releaseEvents(): EventType<any, any, any>[];
 }
 
 interface CommandType<T extends string = any, P = any> {
@@ -43,18 +44,6 @@ declare function abort<T>(message: string, attributes?: T): void;
 
 declare function objectToYaml<T extends Object>(object: T): string;
 
-interface Job {
-    handle: () => void;
-    resolve: (value: unknown) => unknown;
-    reject: (value: unknown) => unknown;
-}
-declare class Queue {
-    constructor();
-    get length(): number;
-    start(): Promise<void>;
-    push(handle: Job['handle']): Promise<unknown>;
-}
-
 type MaybePromise<T> = T | Promise<T>;
 interface EventStore {
     persist(events: EventType[]): MaybePromise<void>;
@@ -74,10 +63,22 @@ type ApplyLazyProjectorEvents<Events extends Lazy<EventType>> = ApplyConcretePro
 type MaybeLazy<T> = T | Lazy<T>;
 type ApplyProjectorEvents<Events extends MaybeLazy<EventType> = any> = Events extends Lazy<EventType> ? ApplyLazyProjectorEvents<Events> : Events extends EventType ? ApplyConcreteProjectorEvents<Events> : never;
 declare abstract class Projector<T extends ApplyProjectorEvents<any> = any> {
+    #private;
+    /**
+     * Name of the projector
+     */
     abstract name: string;
-    abstract apply?: T;
+    /**
+     * Map from event name to projection to apply an individual event.
+     */
+    apply?: T;
+    /**
+     * Initialize the projector.
+     *
+     * Executed before loading all existing events to get the projection up to
+     * date.
+     */
     initializer?(): void | Promise<void>;
-    q: Queue;
     init(es: EventSource): Promise<void>;
     applyEvent(event: EventType): Promise<void>;
     project(event: EventType): void | Promise<void>;
@@ -95,7 +96,7 @@ declare class EventSource {
     static new(store: EventStore, commandHandlers: Map<string, CommandHandler>, projectors: Projector[], eventHandlers: EventHandler[]): EventSource;
     resetProjections(): Promise<void>;
     dispatch<T extends CommandType>(command: T): Promise<T>;
-    loadEvents(): Promise<EventType<any, any>[]>;
+    loadEvents(): Promise<EventType<any, any, any>[]>;
     load<T extends Aggregate>(aggregate: T, aggregateId: string): Promise<T>;
     persist(aggregate: Aggregate): Promise<void>;
     loadPersist<T extends Aggregate>(aggregate: T, aggregateId: string, handle: (aggregate: T) => Promise<void> | void): Promise<void>;
@@ -118,7 +119,7 @@ declare function createEventMapper(mapper: EventMapper): (event: EventType, es:
 declare function createTestEventStore(commandHandlers: Record<string, CommandHandler>, projectors?: Projector[]): {
     ___: any;
     given(events?: EventType[]): Promise<void>;
-    when<T extends CommandType<any, any>>(command: T | (() => T)): Promise<T>;
+    when<T extends CommandType>(command: T | (() => T)): Promise<T> | never;
     then(expectation: EventType[] | Error): Promise<void>;
 };
 

package/dist/index.d.ts

@@ -1,12 +1,13 @@
-interface EventType<T extends string = any, P = any> {
+interface EventType<T extends string = any, P = any, M = any> {
     aggregateId: string;
     eventId: string;
     eventName: T;
     payload: P;
+    metadata: M;
     recordedAt: Date;
     version: number;
 }
-declare function Event<const T extends string, P = null>(eventName: T, aggregateId: string, payload?: P): EventType<T, P>;
+declare function Event<const T extends string, P = null, M = null>(eventName: T, aggregateId: string, payload?: P, metadata?: M): EventType<T, P>;
 
 type ApplyConcreteEvents<Events extends EventType> = Events extends EventType<infer EventName, any> ? {
     [T in EventName]: (event: Extract<Events, {
@@ -23,7 +24,7 @@ declare abstract class Aggregate {
     replayEvents(events?: EventType[]): this;
     private applyAnEvent;
     protected recordThat<T extends EventType>(event: T): this;
-    releaseEvents(): EventType<any, any>[];
+    releaseEvents(): EventType<any, any, any>[];
 }
 
 interface CommandType<T extends string = any, P = any> {
@@ -43,18 +44,6 @@ declare function abort<T>(message: string, attributes?: T): void;
 
 declare function objectToYaml<T extends Object>(object: T): string;
 
-interface Job {
-    handle: () => void;
-    resolve: (value: unknown) => unknown;
-    reject: (value: unknown) => unknown;
-}
-declare class Queue {
-    constructor();
-    get length(): number;
-    start(): Promise<void>;
-    push(handle: Job['handle']): Promise<unknown>;
-}
-
 type MaybePromise<T> = T | Promise<T>;
 interface EventStore {
     persist(events: EventType[]): MaybePromise<void>;
@@ -74,10 +63,22 @@ type ApplyLazyProjectorEvents<Events extends Lazy<EventType>> = ApplyConcretePro
 type MaybeLazy<T> = T | Lazy<T>;
 type ApplyProjectorEvents<Events extends MaybeLazy<EventType> = any> = Events extends Lazy<EventType> ? ApplyLazyProjectorEvents<Events> : Events extends EventType ? ApplyConcreteProjectorEvents<Events> : never;
 declare abstract class Projector<T extends ApplyProjectorEvents<any> = any> {
+    #private;
+    /**
+     * Name of the projector
+     */
     abstract name: string;
-    abstract apply?: T;
+    /**
+     * Map from event name to projection to apply an individual event.
+     */
+    apply?: T;
+    /**
+     * Initialize the projector.
+     *
+     * Executed before loading all existing events to get the projection up to
+     * date.
+     */
     initializer?(): void | Promise<void>;
-    q: Queue;
     init(es: EventSource): Promise<void>;
     applyEvent(event: EventType): Promise<void>;
     project(event: EventType): void | Promise<void>;
@@ -95,7 +96,7 @@ declare class EventSource {
     static new(store: EventStore, commandHandlers: Map<string, CommandHandler>, projectors: Projector[], eventHandlers: EventHandler[]): EventSource;
     resetProjections(): Promise<void>;
     dispatch<T extends CommandType>(command: T): Promise<T>;
-    loadEvents(): Promise<EventType<any, any>[]>;
+    loadEvents(): Promise<EventType<any, any, any>[]>;
     load<T extends Aggregate>(aggregate: T, aggregateId: string): Promise<T>;
     persist(aggregate: Aggregate): Promise<void>;
     loadPersist<T extends Aggregate>(aggregate: T, aggregateId: string, handle: (aggregate: T) => Promise<void> | void): Promise<void>;
@@ -118,7 +119,7 @@ declare function createEventMapper(mapper: EventMapper): (event: EventType, es:
 declare function createTestEventStore(commandHandlers: Record<string, CommandHandler>, projectors?: Projector[]): {
     ___: any;
     given(events?: EventType[]): Promise<void>;
-    when<T extends CommandType<any, any>>(command: T | (() => T)): Promise<T>;
+    when<T extends CommandType>(command: T | (() => T)): Promise<T> | never;
     then(expectation: EventType[] | Error): Promise<void>;
 };