node-cqrs 0.16.4 → 1.0.0-beta.0

package/src/utils/validateHandlers.js

@@ -1,25 +0,0 @@
-'use strict';
-
-const getHandler = require('./getHandler');
-
-/**
- * Ensure instance has handlers declared for all handled message types
- *
- * @param {object} instance
- */
-function validateHandlers(instance, handlesFieldName = 'handles') {
-	if (!instance) throw new TypeError('instance argument required');
-
-	const messageTypes = Object.getPrototypeOf(instance).constructor[handlesFieldName];
-	if (messageTypes === undefined)
-		return;
-	if (!Array.isArray(messageTypes))
-		throw new TypeError('handles getter, when defined, must return an Array of Strings');
-
-	for (const type of messageTypes) {
-		if (!getHandler(instance, type))
-			throw new Error(`'${type}' handler is not defined or not a function`);
-	}
-}
-
-module.exports = validateHandlers;

package/types/index.d.ts

@@ -1,16 +0,0 @@
-export * from "../src";
-export * from "./interfaces/IAggregate";
-export * from "./interfaces/IAggregateSnapshotStorage";
-export * from "./interfaces/ICommandBus";
-export * from "./interfaces/ICommandHandler";
-export * from "./interfaces/IConcurrentView";
-export * from "./interfaces/Identifier";
-export * from "./interfaces/IEventReceptor";
-export * from "./interfaces/IEventStorage";
-export * from "./interfaces/IEventStore";
-export * from "./interfaces/IEventStream";
-export * from "./interfaces/ILogger";
-export * from "./interfaces/IMessageBus";
-export * from "./interfaces/IObserver";
-export * from "./interfaces/IProjection";
-export * from "./interfaces/ISaga";

package/types/interfaces/IAggregate.d.ts

@@ -1,30 +0,0 @@
-/**
- * Minimum aggregate interface, as it's used by default `AggregateCommandHandler`
- */
-declare interface IAggregate {
-	/** Main entry point for aggregate commands */
-	handle(command: ICommand): void | Promise<void>;
-
-	/** List of events emitted by Aggregate as a result of handling command(s) */
-	readonly changes: IEventStream;
-
-	/** An indicator if aggregate snapshot should be taken */
-	readonly shouldTakeSnapshot?: boolean;
-
-	/** Make a snapshot event and append it to `changes` */
-	takeSnapshot?(): void;
-}
-
-declare type TAggregateConstructorParams = {
-	id: Identifier,
-	events?: IEventStream,
-	state?: any
-};
-
-declare interface IAggregateConstructor {
-	new(options: TAggregateConstructorParams): IAggregate;
-	readonly handles?: string[];
-}
-
-declare type IAggregateFactory = (options: TAggregateConstructorParams) => IAggregate;
-

package/types/interfaces/IAggregateSnapshotStorage.d.ts

@@ -1,4 +0,0 @@
-declare interface IAggregateSnapshotStorage {
-	getAggregateSnapshot(aggregateId: Identifier): Promise<IEvent>;
-	saveAggregateSnapshot(IEvent): Promise<void>;
-}

package/types/interfaces/ICommandBus.d.ts

@@ -1,6 +0,0 @@
-interface ICommandBus extends IObservable {
-	send(commandType: string, aggregateId: Identifier | undefined, options: { payload?: object, context?: object }):
-		Promise<IEventStream>;
-	sendRaw(ICommand):
-		Promise<IEventStream>;
-}

package/types/interfaces/ICommandHandler.d.ts

@@ -1,3 +0,0 @@
-declare interface ICommandHandler extends IObserver {
-	subscribe(commandBus: ICommandBus): void;
-}

package/types/interfaces/IConcurrentView.d.ts

@@ -1,22 +0,0 @@
-declare interface IConcurrentView {
-
-	/**
-	 * Indicates if concurrent view is ready for external operations
-	 */
-	ready: boolean;
-
-	/**
-	 * Lock the view for external reads/writes
-	 */
-	lock(): Promise<void>;
-
-	/**
-	 * Unlock external read/write operations
-	 */
-	unlock(): Promise<void>;
-
-	/**
-	 * Wait until the view is unlocked
-	 */
-	once(eventType: "ready"): Promise<void>;
-}

package/types/interfaces/IEventReceptor.d.ts

@@ -1,3 +0,0 @@
-declare interface IEventReceptor extends IObserver {
-	subscribe(eventStore: IEventStore): void;
-}

package/types/interfaces/IEventStorage.d.ts

@@ -1,20 +0,0 @@
-declare interface IEventEmitter extends IObservable {
-	on?(messageType: string, handler: IMessageHandler): void;
-	off?(messageType: string, handler: IMessageHandler): void;
-}
-
-declare interface IEventStorage extends IEventEmitter {
-	getNewId(): Identifier | Promise<Identifier>;
-
-	commitEvents(events: ReadonlyArray<IEvent>):
-		Promise<any>;
-
-	getAggregateEvents(aggregateId: Identifier, options: { snapshot: IEvent }):
-		Promise<IEventStream> | AsyncIterableIterator<IEvent>;
-
-	getSagaEvents(sagaId: Identifier, filter: { beforeEvent: IEvent }):
-		Promise<IEventStream> | AsyncIterableIterator<IEvent>;
-
-	getEvents(eventTypes: string[]):
-		Promise<IEventStream> | AsyncIterableIterator<IEvent>;
-}

package/types/interfaces/IEventStore.d.ts

@@ -1,18 +0,0 @@
-declare interface IEventStore extends IObservable {
-	getNewId(): Promise<Identifier>;
-
-	commit(events: IEventStream): Promise<IEventStream>;
-
-	getAllEvents(eventTypes: string[]): AsyncIterableIterator<IEvent>;
-
-	getAggregateEvents(aggregateId: Identifier): Promise<IEventStream>;
-
-	getSagaEvents(sagaId: Identifier, filter: { beforeEvent: IEvent }): Promise<IEventStream>;
-
-	registerSagaStarters(eventTypes: string[]): void;
-
-	once(messageType: string, handler?: IMessageHandler, filter?: function(IEvent): boolean):
-		Promise<IEvent>;
-
-	snapshotsSupported?: boolean;
-}

package/types/interfaces/IEventStream.d.ts

@@ -1,13 +0,0 @@
-declare interface IMessage {
-	type: string;
-	aggregateId?: Identifier;
-	aggregateVersion?: number;
-	sagaId?: Identifier;
-	sagaVersion?: number;
-	payload?: any;
-	context?: any;
-}
-
-declare type ICommand = IMessage;
-declare type IEvent = IMessage;
-declare type IEventStream = ReadonlyArray<Readonly<IEvent>>;

package/types/interfaces/ILogger.d.ts

@@ -1,3 +0,0 @@
-declare interface ILogger {
-	log(level: 'debug' | 'info' | 'warn' | 'error', message: string, meta?: { [key: string]: any }): void;
-}

package/types/interfaces/IMessageBus.d.ts

@@ -1,5 +0,0 @@
-declare interface IMessageBus extends IObservable {
-	send(command: ICommand): Promise<any>;
-	publish(event: IEvent): Promise<any>;
-}
-

package/types/interfaces/IObserver.d.ts

@@ -1,11 +0,0 @@
-declare type IMessageHandler = (message: IMessage) => void;
-
-declare interface IObservable {
-	on(type: string, handler: IMessageHandler): void;
-
-	queue?(name: string): IObservable;
-}
-
-declare interface IObserver {
-	subscribe(observable: IObservable): void;
-}

package/types/interfaces/IProjection.d.ts

@@ -1,10 +0,0 @@
-declare interface IProjection extends IObserver {
-	readonly view: object;
-	subscribe(eventStore: IEventStore): void;
-	project(event: IEvent, options?: { nowait: boolean }): Promise<void>;
-}
-
-declare interface IProjectionConstructor {
-	new(c?: any): IProjection;
-	readonly handles?: string[];
-}

package/types/interfaces/ISaga.d.ts

@@ -1,27 +0,0 @@
-declare interface ISaga {
-	/** List of commands emitted by Saga */
-	readonly uncommittedMessages: ICommand[];
-
-	/** Main entry point for Saga events */
-	apply(event: IEvent): void | Promise<void>;
-
-	/** Reset emitted commands when they are not longer needed */
-	resetUncommittedMessages(): void;
-}
-
-declare type TSagaConstructorParams = {
-	id: Identifier,
-	events?: IEventStream
-};
-
-declare type ISagaFactory = (options: TSagaConstructorParams) => ISaga;
-
-declare interface ISagaConstructor {
-	new(options: TSagaConstructorParams): ISaga;
-
-	/** List of event types that trigger new saga start */
-	readonly startsWith: string[];
-
-	/** List of events being handled by Saga */
-	readonly handles: string[];
-}

package/types/interfaces/Identifier.d.ts

@@ -1 +0,0 @@
-declare type Identifier = string | number;