@schemeless/event-store-types 2.3.0 → 2.3.1

package/jest.config.js

@@ -3,4 +3,7 @@ module.exports = {
   transform: {
     '^.+\\.tsx?$': 'ts-jest',
   },
+  moduleNameMapper: {
+    '^@schemeless/(.*)$': '<rootDir>/../$1/src',
+  },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schemeless/event-store-types",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "typescript:main": "src/index.ts",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -32,5 +32,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0b9166b4dbfe2733f7a13817f5243ec5c9398050"
+  "gitHead": "727d39bd2300bb875489fe42a44775e5d4cd774e"
 }

package/readme.md

@@ -0,0 +1,51 @@
+# @schemeless/event-store-types
+
+Shared TypeScript definitions used by the event store runtime, adapters, and application code. Import these contracts when authoring event flows, observers, or custom persistence layers.
+
+## Installation
+
+```bash
+yarn add @schemeless/event-store-types
+```
+
+## Event primitives
+
+The package defines the shape of event inputs, created events, and the lifecycle metadata that flows through the runtime.
+
+```ts
+import { BaseEventInput, CreatedEvent, EventFlow } from '@schemeless/event-store-types';
+
+const draft: BaseEventInput<{ id: string }> = {
+  payload: { id: '123' },
+};
+
+const eventFlow: EventFlow = {
+  domain: 'user',
+  type: 'registered',
+  receive: (eventStore) => eventStore.receive(eventFlow),
+};
+```
+
+`CreatedEvent` extends the base shape with generated identifiers and timestamps, while `SideEffectsState`, `EventOutputState`, and `EventObserverState` describe the possible outcomes emitted by the runtime.
+
+## Repository contracts
+
+`Repo.types` exposes the `IEventStoreRepo` and `IEventStoreEntity` interfaces. Adapters implement these to integrate with the core runtime.
+
+```ts
+import { IEventStoreRepo } from '@schemeless/event-store-types';
+
+class CustomRepo implements IEventStoreRepo {
+  async init() {}
+  async getAllEvents(pageSize: number) {
+    // return an async iterator of stored events
+  }
+  createEventEntity(event) {
+    return event;
+  }
+  async storeEvents(events) {}
+  async resetStore() {}
+}
+```
+
+The iterator returned by `getAllEvents` yields arrays of `IEventStoreEntity` records. Each record includes identifiers, correlation/causation metadata, and the `created` timestamp so replays can process history in order.

package/tsconfig.json

@@ -10,7 +10,11 @@
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
     "skipLibCheck": true,
-    "strictPropertyInitialization": false
+    "strictPropertyInitialization": false,
+    "baseUrl": ".",
+    "paths": {
+      "@schemeless/*": ["../*/src"]
+    }
   },
   "exclude": ["node_modules"],
   "include": ["src/**/*.ts"]