https://github.com/pdmlab/sourced-ts
Tiny TypeScript framework for building models with the event sourcing pattern (events and snapshots).
https://github.com/pdmlab/sourced-ts
event-sourcing typescript
Last synced: 11 months ago
JSON representation
Tiny TypeScript framework for building models with the event sourcing pattern (events and snapshots).
- Host: GitHub
- URL: https://github.com/pdmlab/sourced-ts
- Owner: PDMLab
- License: mit
- Created: 2021-06-19T17:19:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-22T19:34:02.000Z (over 4 years ago)
- Last Synced: 2025-02-11T12:41:12.273Z (11 months ago)
- Topics: event-sourcing, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/sourced-ts
- Size: 226 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# sourced-ts
Tiny TypeScript framework forked from [sourced](https://github.com/mateodelnorte/sourced) for building models with the [event sourcing](http://cqrs.nu/Faq/event-sourcing) pattern (events and snapshots). Unlike Active Record where entity state is persisted on a one-model-per row database format, event sourcing stores all the changes (events) to the entity, rather than just its current state. The current state is derived by loading all events, or a latest snapshot plus subsequent events, and replaying them against the entity.
One large benefit of event sourcing: your data _*is*_ your audit trail. Zero discrepancies.
For example usage, see the [examples](./examples) and [tests](./test).
Sourced-ts makes no assumptions about how you _store_ your events and snapshots. The library is small and tight with only the required functionality to define entities and their logic, enqueue and emit events, and track event state to later be persisted. To actually persist, use one of the following libraries or implement your own:
- [sourced-repo-mongo-ts](https://github.com/pdmlab/sourced-repo-mongo-ts)
# TypeScript Example
```typescript
const Entity = require('sourced').SourcedEntity
class Market extends Entity {
constructor(snapshot, events) {
super()
this.orders = []
this.price = 0
this.rehydrate(snapshot, events)
}
init(param) {
this.id = param.id
this.digest('init', param)
this.emit('initialized', param, this)
}
createOrder(param) {
this.orders.push(param)
var total = 0
this.orders.forEach(function (order) {
total += order.price
})
this.price = total / this.orders.length
this.digest('createOrder', param)
this.emit('done', param, this)
}
}
```
# Reference
## Classes
- Entity
-
{Function} Entity
- EntityError
-
{Function} EntityError
## Entity
{Function} Entity
**Kind**: global class **Requires**: module:events, module:debug, module:util, module:lodash **License**: MIT
- [Entity](#Entity)
- [new Entity([snapshot], [events])](#new_Entity_new)
- _instance_
- [.emit()](#Entity+emit)
- [.enqueue()](#Entity+enqueue)
- [.digest(method, data)](#Entity+digest)
- [.merge(snapshot)](#Entity+merge)
- [.mergeProperty(name, value)](#Entity+mergeProperty)
- [.replay(events)](#Entity+replay)
- [.snapshot()](#Entity+snapshot) ⇒ Object
- [.trimSnapshot(snapshot)](#Entity+trimSnapshot)
- _static_
- [.digestMethod(type, fn)](#Entity.digestMethod)
- [.mergeProperty(type, name, fn)](#Entity.mergeProperty)
### new Entity([snapshot], [events])
Creates an event-sourced Entity.
| Param | Type | Description |
| --- | --- | --- |
| [snapshot] | Object | A previously saved snapshot of an entity. |
| [events] | Array | An array of events to apply on instantiation. |
### entity.emit()
Wrapper around the EventEmitter.emit method that adds a condition so events are not fired during replay.
**Kind**: instance method of [Entity](#Entity)
### entity.enqueue()
Add events to the queue of events to emit. If called during replay, this method does nothing.
**Kind**: instance method of [Entity](#Entity)
### entity.digest(method, data)
Digest a command with given data.This is called whenever you want to record a command into the events for the entity. If called during replay, this method does nothing.
**Kind**: instance method of [Entity](#Entity)
| Param | Type | Description |
| --- | --- | --- |
| method | String | the name of the method/command you want to digest. |
| data | Object | the data that should be passed to the replay. |
### entity.merge(snapshot)
Merge a snapshot onto the entity.
For every property passed in the snapshot, the value is deep-cloned and then merged into the instance through mergeProperty. See mergeProperty for details.
**Kind**: instance method of [Entity](#Entity) **See**: Entity.prototype.mergeProperty
| Param | Type | Description |
| -------- | ------------------- | ---------------- |
| snapshot | Object | snapshot object. |
### entity.mergeProperty(name, value)
Merge a property onto the instance.
Given a name and a value, mergeProperty checks first attempt to find the property in the mergeProperties map using the constructor name as key. If it is found and it is a function, the function is called. If it is NOT found we check if the property is an object. If so, we merge. If not, we simply assign the passed value to the instance.
**Kind**: instance method of [Entity](#Entity) **See**
- mergeProperties
- Entity.mergeProperty
| Param | Type | Description |
| ----- | ------------------- | --------------------------------------- |
| name | String | the name of the property being merged. |
| value | Object | the value of the property being merged. |
### entity.replay(events)
Replay an array of events onto the instance.
The goal here is to allow application of events without emitting, enqueueing nor digesting the replayed events. This is done by setting this.replaying to true which emit, enqueue and digest check for.
If the method in the event being replayed exists in the instance, we call the mathod with the data in the event and set the version of the instance to the version of the event. If the method is not found, we attempt to parse the constructor to give a more descriptive error.
**Kind**: instance method of [Entity](#Entity)
| Param | Type | Description |
| ------ | ------------------ | ---------------------------------- |
| events | Array | an array of events to be replayed. |
### entity.snapshot() ⇒ Object
Create a snapshot of the current state of the entity instance.
Here the instance's snapshotVersion property is set to the current version, then the instance is deep-cloned and the clone is trimmed of the internal sourced attributes using trimSnapshot and returned.
**Kind**: instance method of [Entity](#Entity)
### entity.trimSnapshot(snapshot)
Remove the internal sourced properties from the passed snapshot.
Snapshots are to contain only entity data properties. This trims all other properties from the snapshot.
**Kind**: instance method of [Entity](#Entity) **See**: Entity.prototype.snapshot
| Param | Type | Description |
| -------- | ------------------- | --------------------------- |
| snapshot | Object | the snapshot to be trimmed. |
### Entity.digestMethod(type, fn)
Helper function to automatically create a method that calls digest on the param provided. Use it to add methods that automatically call digest.
**Kind**: static method of [Entity](#Entity)
| Param | Type | Description |
| --- | --- | --- |
| type | Object | the entity class to which the method will be added. |
| fn | function | the actual function to be added. |
**Example**
```js
Entity.digestMethod(Car, function clearSettings(param) {
const self = this
this.settings.get(param.name).forEach((name, config) => {
config.sources.forEach((source) => {
source.remove()
})
})
return this.settings
})
```
### Entity.mergeProperty(type, name, fn)
Convenience function to store references to functions that should be run when mergin a particular property.
**Kind**: static method of [Entity](#Entity) **See**: mergeProperties
| Param | Type | Description |
| --- | --- | --- |
| type | Object | the entity class to which the property->fn belongs to. |
| name | String | the name of the property that holds the fn. |
| fn | function | the function to execute when merging the property. |
**Example**
```js
function Wheel(status) {
this.status = status
}
Wheel.prototype.go = function () {
this.status = 'going'
}
function Car() {
this.id = null
this.wheel = new Wheel() // for instantiating our default wheel, when we first 'new' up a Car
Entity.apply(this, arguments)
}
util.inherits(Car, Entity)
Entity.mergeProperty(Car, 'interests', function (obj) {
this.wheel = new Wheel() // for instantiating our wheel from saved values in a database
})
```
## eventsToEmit : Array
[Description]
**Kind**: global variable **Todo**
- [ ] discuss the use of this so it can be documented better.
## newEvents : Array
[Description]
**Kind**: global variable **Todo**
- [ ] discuss the use of this so it can be documented better.
## replaying : Boolean
Boolean to prevent emit, enqueue and digest from running during replay.
## snapshotVersion : Number
Holds the version of the latest snapshot for the entity.
## timestamp : Number
Holds the event's timestamp in the entity.
## version : Number
Holds the current version of the entity.
## mergeProperties
mergeProperties holds a map of entity types to properties.
**Kind**: global variable **See**
- Entity.mergeProperty
- Entity.prototype.mergeProperty
## EntityError
{Function} EntityError
### new EntityError(msg, [constr])
Extending native Error.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| msg | String | | The error message. |
| [constr] | Object | this | The constructor or instance. |