nestjs-eventstore

Eventstore connector for nestjs

Showing:

Popularity

Downloads/wk

240

GitHub Stars

45

Maintenance

Last Commit

4mos ago

Contributors

8

Package

Dependencies

6

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

nestjs-eventstore


GitHub Actions status

Nest Logo

NPM Version Package License NPM Downloads

Description

Injects eventstore connector modules, components, bus and eventstore config into a nestjs application. An example is provided in the examples folder.

Installation

npm i --save nestjs-eventstore

Usage

Using the EventStoreCqrsModule

EventStoreCqrsModule uses @nestjs/cqrs module under the hood. It overrides the default eventbus of @nestjs/cqrs and pushes the event to the eventstore rather than the internal eventBus. Therefore the eventBus.publish(event, streamName) method takes two arguments instead of one. The first one is the event itself, and the second one is the stream name.

Once the event is pushed to the eventStore all the subscriptions listening to that event are pushed that event from the event store. Event handlers can then be triggered to cater for those events.

app.module.ts

import {
  EventStoreBusConfig,
  EventStoreSubscriptionType,
} from 'nestjs-eventstore';

//linking of events from EventStore to local events
const EventInstantiators = [
  SomeEvent: (_id: any, data: any, loggedInUserId: any) => new SomeEvent(_id, data, loggedInUserId);
];

export const eventStoreBusConfig: EventStoreBusConfig = {
  subscriptions: [
    { // persistanct subscription
      type: EventStoreSubscriptionType.Persistent,
      stream: '$ce-persons',
      persistentSubscriptionName: 'contacts',
    },
    { // Catchup subscription
      type: EventStoreSubscriptionType.CatchUp,
      stream: '$ce-users',
    },
  ],
  eventInstantiators: {
    ...EventInstantiators
  },
};

@Module({
  imports: [
    ConfigModule.load(path.resolve(__dirname, 'config', '**/!(*.d).{ts,js}')),
    EventStoreCqrsModule.forRootAsync(
      {
        useFactory: async (config: ConfigService) => {
          return {
            connectionSettings: config.get('eventstore.connectionSettings'),
            endpoint: config.get('eventstore.tcpEndpoint'),
          };
        },
        inject: [ConfigService],
      },
      eventStoreBusConfig,
    ),
  ],
})
export class AppModule {}

custom.command.handler.ts

This following is a way to use the command handlers that push to the custom eventBus to the eventstore using aggregate root.

import { ICommandHandler, CommandHandler } from '@nestjs/cqrs';
import { SomeCommand } from '../impl/some.command';
import { EventPublisher } from 'nestjs-eventstore'; //this is necessary as it overrides the default publisher
import { ObjectAggregate } from '../../models/object.aggregate';

@CommandHandler(SomeCommand)
export class SomeCommandHandler
  implements ICommandHandler<SomeCommand> {
  constructor(private readonly publisher: EventPublisher) {}

  async execute(command: SomeCommand) {
    const { object, loggedInUserId } = command;
    const objectAggregate = this.publisher.mergeObjectContext(
      new ObjectAggregate(object._id, object),
    );
    objectAggregate.add(loggedInUserId);
    objectAggregate.commit();
  }
}

Using the EventStoreModule

EventStoreModule connects directly to the event store without cqrs implementation.

app.module.ts

@Module({
  imports: [
    ConfigModule.load(path.resolve(__dirname, 'config', '**/!(*.d).{ts,js}')),
    EventStoreCqrsModule.forRootAsync(
      {
        useFactory: async (config: ConfigService) => {
          return {
            connectionSettings: config.get('eventstore.connectionSettings'),
            endpoint: config.get('eventstore.tcpEndpoint'),
          };
        },
        inject: [ConfigService],
      },
    ),
  ],
})
export class AppModule {}

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100