Get unlimited public & private packages + team-based management with npm Teams.Learn more »

events-sourcing

1.0.0 • Public • Published

Event sourcing library.

This library allow you to create projection object that result from a list of events. You can also revert events and time travels at any point in time.

To compute your events you need to attach reducer for each event types. Your reducer must be pure and return an object that reflect the update that you want to apply to your projection.

CreateProjection(events, state, reducers) :

  • events: optional array of events. Default value: [].
  • state: optional object. Default value: { sequence: 0, values:{} }
  • reducers: optional array. Default value: []
const evsc = require('events-sourcing');
 
const state = { sequence: 0, balance: 0 };
 
const events = [
  {
    // Event1
    sequence: 1 // Beware if you try to add a sequence number which is not the current state sequence + 1 this will throw an error.
    type: 'add:money',
    payload: { amount: 10 },
  },
];
 
const reducers = [{
  event: 'add:money',
  reducer: (payload, state) => {
    return { balance: state.balance + payload.amount };
  },
}];
 
const projection = evsc.createProjection(events, state, reducers);
projection.sequence(); // => 1
projection.values(); // => { balance: 10 }
projection.events(); // => [ Event1 ]

This will return a projection object which is the results of all events that compose an entity. A projection will expose these functions :

  • addReducer(eventType, reducer): Will attach a reducer function to an event type.
  • addEvent(eventType, payload): Will add a new event to the projection and refresh his state. Throw an error if no reducer is found.
  • goTo(n): Go to the entity at the time of the event n.
  • revert(n): Revert n events on the projection.
  • apply(n): Apply n next events on the projection.
  • sequence(): Return the current sequence number of the projection.
  • values(): Return the current state values.
  • events(): Return the events list of the projection.
  • reducers(): Return the reducers object map.

Projection.addReducer(eventType, reducer) :

This method will attach a reducer function to an event type.

  • EventType is a string
  • Reducer must be a pure function

You can replace a reducer by a new version but in this case you will need to replay all events to get the state computed with your new reducer implementation

const evsc = require('events-sourcing');
 
const projection = evsc.createProjection([], { balance: 0 });
 
projection.addReducer('add:money', (payload, state) => {
  return {
    balance: state.balance + payload.amount,
  };
});
 
projection.addEvent('add:money', { amount: 10 });
projection.values(); // { balance: 10 }
projection.sequence(); // 1

Projection.addEvent(eventType, payload) :

This method will create an event push it in the projection events array and apply it to the projection.

  • Warning: You must have registered a reducer for that kind of event. Otherwise an error will be throw.
const evsc = require('events-sourcing');
 
const events = [event1, event2, event3, event4];
 
const projection = evsc.createProjection(events, state); // state is optional
projection.sequence(); // => 4
projection.values(); // => State of the projection after event4.
projection.events(); // => [ event1, event2, event3, event4 ]
 
projection.addEvent('user:updated', { firstName: 'John' });
projection.sequence(); // => 5
projection.values(); // => { firstName: 'John', ...rest }
projection.events(); // => [ event1, event2, event3, event4, event5 ]

Projection.goTo(targetSequence) :

This method will revert or apply events until matching the targetSequence

const evsc = require('events-sourcing');
 
const events = [event1, event2, event3, event4];
const projection = evsc.createProjection(events, state);
 
projection.goTo(2);
projection.sequence(); // => 2
projection.values(); // => State of the projection after event sequence 2.

Projection.apply(n) :

This method will apply n events from the projection

const evsc = require('events-sourcing');
 
const events = [event1, event2, event3, event4];
const projection = evsc.createProjection(events, state);
 
projection.goTo(2);
projection.sequence(); // 2
 
projection.apply(2); // Will reapply the event 3 and 4
projection.sequence(); // => 4

Projection.revert(n) :

This method will revert n events from the projection

const evsc = require('events-sourcing');
 
const events = [event1, event2, event3, event4];
const projection = evsc.createProjection(events, state);
 
projection.revert(2); // Will revert event 3 and 4
projection.sequence(); // => 2
projection.values(); // => State of the projection after event sequence 2.

Events sequences

  • The default state has the sequence 0.
  • All events must have a consecutive sequence number. If not an error will be thrown : with error.code === 'APPLY_EVENT_OUT_OF_SEQUENCE'

Remove a key :

To remove a key from a state make you reducer return this key undefined.

projection.values(); // => { firstName: 'John', lastName: 'Snow' }
 
projection.addReducer('user:remove:firstname', () => {
  return {
    firstname: undefined,
  };
});
projection.addEvent('user:remove:firstname', {});
projection.values(); // => { lastName: 'Snow' }

Nested objects :

evsc support nested objects. It use deepmerge for that.

projection.values(); // => { user : { firstName: 'John' } }
projection.addEvent('user:updated', { user: { lastName: 'Snow' } });
projection.values(); // => { user: { firstName: 'John', lastName: 'Snow' }  }

Install

npm i events-sourcing

DownloadsWeekly Downloads

7

Version

1.0.0

License

GPL-3.0-only

Unpacked Size

58.3 kB

Total Files

27

Last publish

Collaborators

  • avatar