@schemeless/event-store-types 2.8.3 → 2.10.0

package/dist/Errors.d.ts

@@ -0,0 +1,6 @@
+export declare class ConcurrencyError extends Error {
+    readonly streamKey: string;
+    readonly expectedSequence: number;
+    readonly actualSequence: number;
+    constructor(streamKey: string, expectedSequence: number, actualSequence: number);
+}

package/dist/Errors.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConcurrencyError = void 0;
+class ConcurrencyError extends Error {
+    constructor(streamKey, expectedSequence, actualSequence) {
+        super(`Concurrency conflict on stream "${streamKey}": expected sequence ${expectedSequence}, but found ${actualSequence}`);
+        this.streamKey = streamKey;
+        this.expectedSequence = expectedSequence;
+        this.actualSequence = actualSequence;
+        this.name = 'ConcurrencyError';
+    }
+}
+exports.ConcurrencyError = ConcurrencyError;

package/dist/EventStore.types.d.ts

@@ -38,6 +38,17 @@ export interface EventFlow<PartialPayload = any, Payload extends PartialPayload
     readonly eventType?: CreatedEvent<Payload>;
     readonly payloadType?: PartialPayload | Payload;
     readonly samplePayload?: PartialPayload | Payload;
+    /**
+     * Extract the shard key for event routing.
+     * Events with the same shard key will be processed sequentially in the same partition.
+     * Events with different shard keys can be processed in parallel.
+     *
+     * @param event - The event to extract the shard key from
+     * @returns The shard key string, or undefined to use fallback (identifier)
+     * @example
+     * getShardKey: (event) => event.payload.userId
+     */
+    readonly getShardKey?: (event: BaseEvent<Payload>) => string | undefined;
     readonly receive: (eventStore: {
         receive: (eventFlow: EventFlow<PartialPayload, Payload>) => (eventInput: BaseEventInput<PartialPayload>) => Promise<[CreatedEvent<Payload>, ...Array<CreatedEvent<any>>]>;
     }) => (eventInputArgs: BaseEventInput<PartialPayload>) => Promise<[CreatedEvent<Payload>, ...Array<CreatedEvent<any>>]>;

package/dist/Repo.types.d.ts

@@ -8,14 +8,28 @@ export interface IEventStoreEntity<PAYLOAD = any, META = any> {
     identifier?: string;
     correlationId?: string;
     causationId?: string;
+    sequence?: number;
     readonly created: Date;
 }
+export interface StoreEventsOptions {
+    /**
+     * Expected sequence number for the stream (domain + identifier).
+     * If provided, the store will verify the current sequence matches
+     * before writing. Throws ConcurrencyError on mismatch.
+     */
+    expectedSequence?: number;
+}
 export interface IEventStoreRepo<PAYLOAD = any, META = any> {
     init: () => Promise<void>;
     getAllEvents: (pageSize: number, startFromId?: string) => Promise<AsyncIterableIterator<Array<IEventStoreEntity<PAYLOAD, META>>>>;
     createEventEntity: (event: CreatedEvent<any>) => IEventStoreEntity<PAYLOAD, META>;
-    storeEvents: (events: CreatedEvent<any>[]) => Promise<void>;
+    storeEvents: (events: CreatedEvent<any>[], options?: StoreEventsOptions) => Promise<void>;
     resetStore: () => Promise<void>;
+    /**
+     * Get the current sequence number for a stream.
+     * Returns 0 if no events exist for this stream.
+     */
+    getStreamSequence?: (domain: string, identifier: string) => Promise<number>;
     /**
      * Retrieves a single event by its ID.
      * Required for revert operations.

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './EventStore.types';
 export * from './Repo.types';
 export * from './Revert.types';
+export * from './Errors';

package/dist/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./EventStore.types"), exports);
 __exportStar(require("./Repo.types"), exports);
 __exportStar(require("./Revert.types"), exports);
+__exportStar(require("./Errors"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schemeless/event-store-types",
-  "version": "2.8.3",
+  "version": "2.10.0",
   "typescript:main": "src/index.ts",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -34,5 +34,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "03e86735e57d21512ff96e3588f40f98e59e5d41"
+  "gitHead": "396c3bfbe61bb81b93f0d3d0686388ed3d80a594"
 }