event-storage 1.0.0 → 1.2.0

package/README.md

@@ -62,6 +62,8 @@ eventstore.on('ready', () => {
 | **Optimistic concurrency** | Pass `expectedVersion` to `commit()` to guarantee conflict-free writes. |
 | **Flexible stream reading** | Range queries, reverse iteration, and a fluent builder API. |
 | **Derived streams** | Filter or combine events into new read-only streams. |
+| **Multi-value matchers** | Object matchers support array values (OR semantics) and still benefit from O(1) discriminant routing on writes. |
+| **DCB / `typeAccessor`** | Configure `typeAccessor` to have per-type stream indexes maintained automatically, and use `query()` / `Condition` for fine-grained, query-scoped optimistic concurrency (Dynamic Consistency Boundaries). |
 | **Stream categories** | Name streams `<category>-<id>` and query the whole category at once. |
 | **Durable consumers** | At-least-once (and exactly-once with `setState`) event delivery with automatic position tracking. |
 | **Consistency guards** | Build aggregates that enforce business invariants with built-in snapshotting. |
@@ -73,12 +75,34 @@ eventstore.on('ready', () => {
 
 ---
 
+## HTTP API
+
+To expose an event store over HTTP, see the companion package **[event-storage-http](https://github.com/albe/node-event-storage-http)**:
+
+```bash
+npm install event-storage-http
+```
+
+```javascript
+import EventStore from 'event-storage';
+import { createEventStoreHttpServer } from 'event-storage-http';
+
+const eventStore = new EventStore('my-store', { storageDirectory: './data' });
+const server = createEventStoreHttpServer(eventStore);
+server.listen(3000);
+```
+
+The package exposes NDJSON stream endpoints, durable consumer management, and an `HttpEventStream` client helper for consuming event streams over fetch.
+
+---
+
 ## Documentation
 
 The full documentation is hosted at **<https://node-event-storage.readthedocs.io/en/latest/>** and covers:
 
 - [Getting Started](https://node-event-storage.readthedocs.io/en/latest/getting-started/) — installation, constructor options, basic usage.
 - [Event Streams](https://node-event-storage.readthedocs.io/en/latest/streams/) — writing, reading, optimistic concurrency, fluent API, joining streams, categories, and event metadata.
+- [Dynamic Consistency Boundaries (DCB)](https://node-event-storage.readthedocs.io/en/latest/dcb/) — `typeAccessor`, multi-value matchers, consistency tokens, and the full DCB workflow.
 - [Consumers](https://node-event-storage.readthedocs.io/en/latest/consumers/) — at-least-once and exactly-once delivery, consumer state, consistency guards, and read-only mode.
 - [Advanced Topics](https://node-event-storage.readthedocs.io/en/latest/advanced/) — ACID properties, reliability and crash-safety guarantees, storage configuration, partitioning, custom serialization, compression, security, and access control hooks.
 

package/index.js

@@ -1,4 +1,4 @@
-export { default as EventStore, default, ExpectedVersion, OptimisticConcurrencyError, LOCK_THROW, LOCK_RECLAIM } from './src/EventStore.js';
+export { default as EventStore, default, ExpectedVersion, OptimisticConcurrencyError, CommitCondition, LOCK_THROW, LOCK_RECLAIM } from './src/EventStore.js';
 export { default as EventStream } from './src/EventStream.js';
 export { default as Storage, StorageLockedError } from './src/Storage.js';
 export { default as Index } from './src/Index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "event-storage",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "type": "module",
   "description": "An optimized embedded event store for node.js",
   "keywords": [
@@ -43,9 +43,8 @@
     "src/Partition/*.js",
     "src/Storage/*.js",
     "src/WatchesFile.js",
-    "src/util.js",
-    "src/metadataUtil.js",
-    "index.js"
+    "index.js",
+    "src/utils/*.js"
   ],
   "license": "MIT",
   "maintainers": [

package/src/Consumer.js

@@ -1,7 +1,8 @@
 import stream from 'stream';
 import fs from 'fs';
 import path from 'path';
-import { assert, ensureDirectory } from './util.js';
+import { assert } from './utils/util.js';
+import { ensureDirectory } from './utils/fsUtil.js';
 import Storage from './Storage/ReadableStorage.js';
 const MAX_CATCHUP_BATCH = 10;
 
@@ -29,8 +30,8 @@ class Consumer extends stream.Readable {
      * @param {Storage} storage The storage to create the consumer for.
      * @param {string} indexName The name of the index to consume.
      * @param {string} identifier The unique name to identify this consumer.
-     * @param {object} [initialState] The initial state of the consumer.
-     * @param {number} [startFrom] The revision to start from within the index to consume.
+     * @param {object} [initialState={}] The initial state of the consumer.
+     * @param {number} [startFrom=0] The revision to start from within the index to consume.
      */
     constructor(storage, indexName, identifier, initialState = {}, startFrom = 0) {
         super({ objectMode: true });
@@ -110,7 +111,7 @@ class Consumer extends stream.Readable {
      * May only be called from within the document handling callback.
      *
      * @param {object|function(object):object} newState
-     * @param {boolean} [persist] Set to false if this state update should not be persisted yet
+     * @param {boolean} [persist=true] Set to false if this state update should not be persisted yet
      * @api
      */
     setState(newState, persist = true) {
@@ -150,6 +151,7 @@ class Consumer extends stream.Readable {
         if (this.doPersist) {
             this.persist();
         }
+        this.emit('progress', this.position, this.state);
     }
 
     /**
@@ -243,6 +245,7 @@ class Consumer extends stream.Readable {
                 const maxBatchPosition = Math.min(this.position + MAX_CATCHUP_BATCH + 1, this.index.length);
                 const documents = this.storage.readRange(this.position + 1, maxBatchPosition, this.index);
                 this.consumeDocuments(documents);
+                this.emit('progress', this.position, this.state);
                 this.once('persisted', () => catchUpBatch());
                 this.persist();
             });
@@ -266,8 +269,8 @@ class Consumer extends stream.Readable {
     /**
      * Reset this projection to restart processing all documents again.
      * NOTE: This will overwrite the current state of the projection and hence be destructive.
-     * @param {object} [initialState] The initial state of the consumer.
-     * @param {number} [startFrom] The revision to start from within the index to consume.
+     * @param {object} [initialState={}] The initial state of the consumer.
+     * @param {number} [startFrom=0] The revision to start from within the index to consume.
      * @api
      */
     reset(initialState = {}, startFrom = 0) {