Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,16 +69,20 @@ Message delivery is handled by the following components (in order of appearance)
- [examples/worker-projection](examples/worker-projection) projection in a worker thread
- [examples/user-domain-own-implementation](examples/user-domain-own-implementation/index.ts) minimal, framework-free CQRS/ES example in 1 file

TS examples can be run with `node` without transpiling

## Installation

```bash
npm i node-cqrs
```

Tested under

- Node 18
- Node 20
- Node 22
- Browser (through [browserify](https://browserify.org))

### Peer Dependencies

Expand Down
17 changes: 17 additions & 0 deletions examples/browser-smoke-test/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Browser smoke test

This example is meant to quickly verify that the core `node-cqrs` APIs work in a browser environment.

## Run

From the repo root:

```bash
npm run build:browser
```

Then open `examples/browser-smoke-test/index.html` directly (e.g. double-click it).

Notes:
- The bundle is written to `dist/browser/node-cqrs.iife.js`.
- If you don’t have Browserify installed locally, run `npm i -D browserify`.
40 changes: 40 additions & 0 deletions examples/browser-smoke-test/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!doctype html>
<html lang="en">

<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>node-cqrs browser smoke test</title>
<style>
body {
font-family: ui-sans-serif, system-ui, -apple-system, Segoe UI, Roboto, Helvetica, Arial;
padding: 16px;
}

pre {
background: #0b1020;
color: #e6e6e6;
padding: 12px;
border-radius: 8px;
overflow: auto;
}

.ok {
color: #19c37d;
}

.fail {
color: #ff4d4f;
}
</style>
</head>

<body>
<h1>node-cqrs browser smoke test</h1>
<p>Open DevTools console for details.</p>
<pre id="out">Running…</pre>
<script src="../../dist/browser/bundle.iife.js"></script>
<script src="./main.js"></script>
</body>

</html>
111 changes: 111 additions & 0 deletions examples/browser-smoke-test/main.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
(function () {
const out = document.getElementById('out');

function write(line) {
out.textContent = `${out.textContent}\n${line}`;
}

function setStatusOk() {
out.classList.remove('fail');
out.classList.add('ok');
}

function setStatusFail() {
out.classList.remove('ok');
out.classList.add('fail');
}

if (!globalThis.Cqrs)
throw new Error('Cqrs bundle is not loaded. Run `npm run build:browser` first.');

const {
AbstractAggregate,
AbstractProjection,
ContainerBuilder,
InMemoryEventStorage
} = globalThis.Cqrs;

class UserAggregateState {
userCreated(event) {
this.password = event.payload.password;
}

passwordChanged(event) {
this.password = event.payload.newPassword;
}
}

class UserAggregate extends AbstractAggregate {
constructor(params) {
super(params);
this.state = new UserAggregateState();
}

createUser(payload) {
this.emit('userCreated', {
username: payload.username,
password: payload.password
});
}

changePassword(payload) {
if (payload.oldPassword !== this.state.password)
throw new Error('Invalid password');

this.emit('passwordChanged', {
newPassword: payload.newPassword
});
}
}

class UsersProjection extends AbstractProjection {
constructor() {
super();
this.view = new Map();
}

userCreated(event) {
this.view.set(event.aggregateId, { username: event.payload.username });
}
}

async function main() {
out.textContent = '';
write('Building container…');

const builder = new ContainerBuilder();
builder.register(InMemoryEventStorage)
.as('eventStorageReader')
.as('eventStorageWriter');
builder.registerAggregate(UserAggregate);
builder.registerProjection(UsersProjection, 'users');

const container = builder.container();
const { users, commandBus } = container;

write('Sending commands…');
const [userCreated] = await commandBus.send('createUser', undefined, {
payload: { username: 'john', password: 'magic' },
context: {}
});

await commandBus.send('changePassword', userCreated.aggregateId, {
payload: { oldPassword: 'magic', newPassword: 'no magic' },
context: {}
});

const user = users.get(userCreated.aggregateId);
if (!user || user.username !== 'john')
throw new Error(`Unexpected user view value: ${JSON.stringify(user)}`);

write(`OK: ${JSON.stringify(user)}`);
setStatusOk();
}

main().catch(err => {
console.error(err);
out.textContent = `FAILED: ${err?.message ?? String(err)}`;
setStatusFail();
});
}());

32 changes: 32 additions & 0 deletions examples/jsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"compilerOptions": {
"target": "es2022",
"module": "commonjs",
"moduleResolution": "node",
"checkJs": true,
"allowSyntheticDefaultImports": true,
"resolveJsonModule": true,
"lib": [
"es2022",
"dom"
],
"baseUrl": "..",
"paths": {
"node-cqrs": [
"types/index.d.ts"
],
"node-cqrs/*": [
"types/*/index.d.ts"
]
}
},
"include": [
"**/*"
],
"exclude": [
"../node_modules",
"../dist",
"**/bundle.js",
"browser-smoke-test/**"
]
}
13 changes: 13 additions & 0 deletions examples/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"compilerOptions": {
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"lib": [
"ES2022"
],
"strict": true,
"noEmit": true,
"allowImportingTsExtensions": true
}
}
11 changes: 8 additions & 3 deletions examples/user-domain-ts/UserAggregate.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
import type { ChangePasswordCommandPayload, CreateUserCommandPayload, PasswordChangedEvent, UserCreatedEvent } from './messages';
import { AbstractAggregate } from '../..';
import { md5 } from './utils';
import { AbstractAggregate } from 'node-cqrs';
import { md5 } from './utils.ts';
import type {
ChangePasswordCommandPayload,
CreateUserCommandPayload,
PasswordChangedEvent,
UserCreatedEvent
} from './messages.ts';

class UserAggregateState {
passwordHash!: string;
Expand Down
4 changes: 2 additions & 2 deletions examples/user-domain-ts/UsersProjection.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { UserCreatedEvent } from './messages';
import { AbstractProjection } from '../..';
import { AbstractProjection } from 'node-cqrs';
import type { UserCreatedEvent } from './messages.ts';

export type UsersView = Map<string, { username: string; }>;

Expand Down
8 changes: 4 additions & 4 deletions examples/user-domain-ts/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { ContainerBuilder, IContainer, InMemoryEventStorage } from '../..';
import type { ChangePasswordCommandPayload, CreateUserCommandPayload } from './messages';
import { UserAggregate } from './UserAggregate';
import { UsersProjection, UsersView } from './UsersProjection';
import { ContainerBuilder, type IContainer, InMemoryEventStorage } from 'node-cqrs';
import type { ChangePasswordCommandPayload, CreateUserCommandPayload } from './messages.ts';
import { UserAggregate } from './UserAggregate.ts';
import { UsersProjection, type UsersView } from './UsersProjection.ts';

interface MyDiContainer extends IContainer {
users: UsersView;
Expand Down
3 changes: 1 addition & 2 deletions examples/user-domain-ts/messages.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { IEvent } from '../../types';
import type { IEvent } from 'node-cqrs';

export type CreateUserCommandPayload = { username: string, password: string };
export type UserCreatedEventPayload = { username: string, passwordHash: string };
Expand All @@ -7,4 +7,3 @@ export type UserCreatedEvent = IEvent<UserCreatedEventPayload>;
export type ChangePasswordCommandPayload = { oldPassword: string, newPassword: string };
export type PasswordChangedEventPayload = { passwordHash: string };
export type PasswordChangedEvent = IEvent<PasswordChangedEventPayload>;

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// @ts-check
'use strict';

const { AbstractAggregate } = require('../..'); // node-cqrs
const { AbstractAggregate } = require('node-cqrs');

const crypto = require('crypto');

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// @ts-check
'use strict';

const { AbstractProjection } = require('../..'); // node-cqrs
const { AbstractProjection } = require('node-cqrs');

/**
* Users projection listens to events and updates associated view (read model)
Expand Down Expand Up @@ -29,7 +29,7 @@ class UsersProjection extends AbstractProjection {
* userCreated event handler
*
* @param {object} event
* @param {import('../../src').Identifier} event.aggregateId
* @param {import('node-cqrs').Identifier} event.aggregateId
* @param {object} event.payload
* @param {string} event.payload.username
* @param {string} event.payload.passwordHash
Expand Down
16 changes: 8 additions & 8 deletions examples/user-domain/index.js → examples/user-domain/index.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ const {
EventStore,
AggregateCommandHandler,
InMemoryMessageBus,
EventDispatcher
} = require('../..'); // node-cqrs
const { InMemorySnapshotStorage } = require('../..');
const UserAggregate = require('./UserAggregate');
const UsersProjection = require('./UsersProjection');
EventDispatcher,
InMemorySnapshotStorage
} = require('node-cqrs');
const UserAggregate = require('./UserAggregate.cjs');
const UsersProjection = require('./UsersProjection.cjs');

/**
* DI container factory
Expand Down Expand Up @@ -47,14 +47,14 @@ exports.createBaseInstances = () => {
const eventStore = new EventStore({ eventStorageReader: storage, eventBus, eventDispatcher });
const commandBus = new CommandBus();

/** @type {import('../..').IAggregateConstructor} */
/** @type {import('node-cqrs').IAggregateConstructor} */
const aggregateType = UserAggregate;

/** @type {import('../..').ICommandHandler} */
/** @type {import('node-cqrs').ICommandHandler} */
const userCommandHandler = new AggregateCommandHandler({ eventStore, aggregateType });
userCommandHandler.subscribe(commandBus);

/** @type {import('../..').IProjection} */
/** @type {import('node-cqrs').IProjection} */
const usersProjection = new UsersProjection();
usersProjection.subscribe(eventStore);

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'use strict';

const { expect } = require('chai');
const { createContainer, createBaseInstances } = require('..');
const { createContainer, createBaseInstances } = require('../index.cjs');

describe('user-domain example', () => {

Expand Down
2 changes: 1 addition & 1 deletion examples/worker-projection/CounterProjection.cjs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const { AbstractWorkerProjection } = require('../../dist/workers');
const { AbstractWorkerProjection } = require('node-cqrs/workers');

class CounterView {
counter = 0;
Expand Down
20 changes: 17 additions & 3 deletions jsconfig.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,29 @@
{
"compilerOptions": {
"target": "es6",
"target": "es2022",
"module": "commonjs",
"moduleResolution": "node",
"baseUrl": ".",
"paths": {
"node-cqrs": [
"./types/index.d.ts"
],
"node-cqrs/*": [
"./types/*/index.d.ts"
]
},
"allowSyntheticDefaultImports": true,
"checkJs": true,
"resolveJsonModule": true,
"lib": [
"es2018"
"es2022",
"dom"
]
},
"exclude": [
"node_modules"
"node_modules",
"dist",
"dist/**",
"examples/**/bundle.js"
]
}
Loading