event-sourcing

Upgrading from 3.x? Follow the migration guide. 3.x is on the latest-3 tag and receives security and critical fixes until at least 2027-03-31.

Requirements

See versioning and support for the tested database versions and the support policy.

Installation

Install the core. It falls back to in-memory event and snapshot stores, which are fine for tests and prototypes:

npm install @ocoda/event-sourcing@4   # 4.x, NestJS 12
npm install @ocoda/event-sourcing@3   # 3.x, NestJS 11

For persistence, add an integration. On 4.x the database driver is a peer dependency, so install it next to the integration:

# PostgreSQL
npm install @ocoda/event-sourcing-postgres@4 pg pg-cursor

# MariaDB or MySQL
npm install @ocoda/event-sourcing-mariadb@4 mariadb

# MongoDB
npm install @ocoda/event-sourcing-mongodb@4 mongodb

Keep the core and the integrations on the same version. TypeScript projects need TypeScript 5.4 or later, and, with PostgreSQL, @types/pg and @types/pg-cursor.

On 3.x, install the integration with @3 and leave out the driver, which the integration brings along. The DynamoDB store (@ocoda/event-sourcing-dynamodb@3) is only available on 3.x.

Documentation 📗

• The documentation starts with the installation and the module configuration. The 3.x documentation is at ocoda.github.io/event-sourcing/v3.
• Migrating from 3.x to 4.0 lists every breaking change in the order in which you apply them, including the one-time migration of the stored data.
• The example application is a small NestJS 12 application on PostgreSQL that starts with docker compose.
• Versioning and support lists the release lines, and SUPPORT.md where to ask for help.

Contact

dries@drieshooghe.com  

Acknowledgments

This library is inspired by @nestjs/cqrs