event-vault v1.0.6

EventVault

An Node.js event sourcing package that lets you store events and create projections with an entity tree. Currently this package only supports file system persistance but new persistance adapters can be created by extending the class Persistence. The main target system for this package is currently turn based games but it should be usable for a lot of other systems as well.

Examples

const EventVault = require('event-vault/EventVault');
const Event = require('event-vault/Event');
const Entity = require('event-vault/Entity');

class Player extends Entity {}

class AddPlayer extends Event {
  resolve(projection) {
    projection.set(this.id, new Player({ id: this.id, name: this.name }));
  }
}

class RenamePlayer extends Event {
  resolve(projection) {
    const player = projection.get(this.id);
    player.name = this.name;
  }
}

const events = new Map();
events.set('AddPlayer', AddPlayer);
events.set('RenamePlayer', RenamePlayer);

const vault = new EventVault(undefined, undefined, events);

vault.append(new AddPlayer({
  id: 123,
  name: 'Lisa',
  time: 100
}));

vault.append(new RenamePlayer({
  id: 123,
  name: 'Anna-Lisa',
  time: 200
}));

// Project at 150 time units, expect name to be "Lisa"
console.log(vault.project(150).get(123).name);

// Project at 250 time units, expect name to be "Anna-Lisa"
console.log(vault.project(250).get(123).name);

See /examples for examples on how this system could be used.

When is this package usable?

When you have are creating a system where the entire event history could be kept in memory (persistence is only for restoring). A good usage for this would be for example game servers.

When should I look for another package?

When you need to save large amounts of events and/or if your system has the need for querying in a projection. A bad usage example for his would be for entire CMS systems.

Please help out be creating pull-requests!

I will gladly review pull-requests with good test coverage. Let's create an easy to use event sourcing package! :)