event-store-adapter-js 1.0.2-snapshot.21 → 1.0.2-snapshot.23

package/README.ja.md

@@ -0,0 +1,107 @@
+# event-store-adapter-js
+
+このライブラリは、DynamoDBをEvent Sourcing用のEvent Storeにするためのものです。
+
+[English](./README.md)
+
+# 導入方法
+
+```shell
+$ npm i event-store-adapter-js
+```
+
+# 使い方
+
+EventStoreを使えば、Event Sourcing対応リポジトリを簡単に実装できます。
+
+```typescript
+class UserAccountRepository {
+    constructor(
+        private readonly eventStore: EventStore<
+            UserAccountId,
+            UserAccount,
+            UserAccountEvent
+        >,
+    ) {}
+
+    async storeEvent(event: UserAccountEvent, version: number) {
+        await this.eventStore.persistEvent(event, version);
+    }
+
+    async storeEventAndSnapshot(event: UserAccountEvent, snapshot: UserAccount) {
+        await this.eventStore.persistEventAndSnapshot(event, snapshot);
+    }
+
+    async findById(id: UserAccountId): Promise<UserAccount | undefined> {
+        const snapshot = await this.eventStore.getLatestSnapshotById(
+            id,
+            convertJSONToUserAccount,
+        );
+        if (snapshot === undefined) {
+            return undefined;
+        } else {
+            const events = await this.eventStore.getEventsByIdSinceSequenceNumber(
+                id,
+                snapshot.sequenceNumber + 1,
+                convertJSONtoUserAccountEvent,
+            );
+            return UserAccount.replay(events, snapshot);
+        }
+    }
+}
+```
+
+以下はリポジトリの使用例です。
+
+```typescript
+const eventStore = EventStoreFactory.ofDynamoDB<
+    UserAccountId,
+    UserAccount,
+    UserAccountEvent
+>(
+    dynamodbClient,
+    JOURNAL_TABLE_NAME,
+    SNAPSHOT_TABLE_NAME,
+    JOURNAL_AID_INDEX_NAME,
+    SNAPSHOTS_AID_INDEX_NAME,
+    32,
+);
+const userAccountRepository = new UserAccountRepository(eventStore);
+
+const id = new UserAccountId(ulid());
+const name = "Alice";
+const [userAccount1, created] = UserAccount.create(id, name);
+
+await userAccountRepository.storeEventAndSnapshot(created, userAccount1);
+
+const [userAccount2, renamed] = userAccount1.rename("Bob");
+
+await userAccountRepository.storeEvent(renamed, userAccount2.version);
+
+const userAccount3 = await userAccountRepository.findById(id);
+if (userAccount3 === undefined) {
+    throw new Error("userAccount3 is undefined");
+}
+
+expect(userAccount3.id).toEqual(id);
+expect(userAccount3.name).toEqual("Bob");
+expect(userAccount3.sequenceNumber).toEqual(2);
+expect(userAccount3.version).toEqual(2);
+```
+
+## テーブル仕様
+
+[docs/DATABASE_SCHEMA.ja.md](docs/DATABASE_SCHEMA.ja.md)を参照してください。
+
+## ライセンス
+
+MITライセンスです。詳細は[LICENSE](LICENSE)を参照してください。
+
+## 他の言語のための実装
+
+- [for Java](https://github.com/j5ik2o/event-store-adapter-java)
+- [for Scala](https://github.com/j5ik2o/event-store-adapter-scala)
+- [for Kotlin](https://github.com/j5ik2o/event-store-adapter-kotlin)
+- [for Rust](https://github.com/j5ik2o/event-store-adapter-rs)
+- [for Go](https://github.com/j5ik2o/event-store-adapter-go)
+- [for JavaScript/TypeScript](https://github.com/j5ik2o/event-store-adapter-js)

package/README.md

@@ -2,6 +2,97 @@
 
 This library is designed to turn DynamoDB into an Event Store for Event Sourcing.
 
+[日本語](./README.ja.md)
+
+# Installation
+
+```shell
+$ npm i event-store-adapter-js
+```
+
+# Usage
+
+You can easily implement an Event Sourcing-enabled repository using EventStore.
+
+```typescript
+class UserAccountRepository {
+    constructor(
+        private readonly eventStore: EventStore<
+            UserAccountId,
+            UserAccount,
+            UserAccountEvent
+        >,
+    ) {}
+
+    async storeEvent(event: UserAccountEvent, version: number) {
+        await this.eventStore.persistEvent(event, version);
+    }
+
+    async storeEventAndSnapshot(event: UserAccountEvent, snapshot: UserAccount) {
+        await this.eventStore.persistEventAndSnapshot(event, snapshot);
+    }
+
+    async findById(id: UserAccountId): Promise<UserAccount | undefined> {
+        const snapshot = await this.eventStore.getLatestSnapshotById(
+            id,
+            convertJSONToUserAccount,
+        );
+        if (snapshot === undefined) {
+            return undefined;
+        } else {
+            const events = await this.eventStore.getEventsByIdSinceSequenceNumber(
+                id,
+                snapshot.sequenceNumber + 1,
+                convertJSONtoUserAccountEvent,
+            );
+            return UserAccount.replay(events, snapshot);
+        }
+    }
+}
+```
+
+The following is an example of the repository usage.
+
+```typescript
+const eventStore = EventStoreFactory.ofDynamoDB<
+    UserAccountId,
+    UserAccount,
+    UserAccountEvent
+>(
+    dynamodbClient,
+    JOURNAL_TABLE_NAME,
+    SNAPSHOT_TABLE_NAME,
+    JOURNAL_AID_INDEX_NAME,
+    SNAPSHOTS_AID_INDEX_NAME,
+    32,
+);
+const userAccountRepository = new UserAccountRepository(eventStore);
+
+const id = new UserAccountId(ulid());
+const name = "Alice";
+const [userAccount1, created] = UserAccount.create(id, name);
+
+await userAccountRepository.storeEventAndSnapshot(created, userAccount1);
+
+const [userAccount2, renamed] = userAccount1.rename("Bob");
+
+await userAccountRepository.storeEvent(renamed, userAccount2.version);
+
+const userAccount3 = await userAccountRepository.findById(id);
+if (userAccount3 === undefined) {
+    throw new Error("userAccount3 is undefined");
+}
+
+expect(userAccount3.id).toEqual(id);
+expect(userAccount3.name).toEqual("Bob");
+expect(userAccount3.sequenceNumber).toEqual(2);
+expect(userAccount3.version).toEqual(2);
+```
+
+## Table Specifications
+
+See [docs/DATABASE_SCHEMA.md](docs/DATABASE_SCHEMA.md).
+
 ## License.
 
 MIT License. See [LICENSE](LICENSE) for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "event-store-adapter-js",
-  "version": "1.0.2-snapshot.21",
+  "version": "1.0.2-snapshot.23",
   "description": "This library is designed to turn DynamoDB into an Event Store for Event Sourcing.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/event-store.ts

@@ -1,5 +1,20 @@
-import { Aggregate, AggregateId, Event } from "./types";
+import {
+  Aggregate,
+  AggregateId,
+  Event,
+  EventSerializer,
+  KeyResolver,
+  SnapshotSerializer,
+} from "./types";
 import { EventStoreOptions } from "./event-store-options";
+import { EventStoreForDynamoDB } from "./internal/event-store-for-dynamodb";
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import * as moment from "moment";
+import { DefaultKeyResolver } from "./internal/default-key-resolver";
+import {
+  JsonEventSerializer,
+  JsonSnapshotSerializer,
+} from "./internal/default-serializer";
 
 interface EventStore<
   AID extends AggregateId,
@@ -19,4 +34,44 @@ interface EventStore<
   ): Promise<A | undefined>;
 }
 
-export { EventStore };
+class EventStoreFactory {
+  static ofDynamoDB<
+    AID extends AggregateId,
+    A extends Aggregate<A, AID>,
+    E extends Event<AID>,
+  >(
+    dynamodbClient: DynamoDBClient,
+    journalTableName: string,
+    snapshotTableName: string,
+    journalAidIndexName: string,
+    snapshotAidIndexName: string,
+    shardCount: number,
+    keepSnapshotCount: number | undefined = undefined,
+    deleteTtl: moment.Duration | undefined = undefined,
+    keyResolver: KeyResolver<AID> = new DefaultKeyResolver(),
+    eventSerializer: EventSerializer<AID, E> = new JsonEventSerializer<
+      AID,
+      E
+    >(),
+    snapshotSerializer: SnapshotSerializer<AID, A> = new JsonSnapshotSerializer<
+      AID,
+      A
+    >(),
+  ) {
+    return new EventStoreForDynamoDB<AID, A, E>(
+      dynamodbClient,
+      journalTableName,
+      snapshotTableName,
+      journalAidIndexName,
+      snapshotAidIndexName,
+      shardCount,
+      keepSnapshotCount,
+      deleteTtl,
+      keyResolver,
+      eventSerializer,
+      snapshotSerializer,
+    );
+  }
+}
+
+export { EventStore, EventStoreFactory };

package/src/internal/test/user-account-repository.test.ts

@@ -5,7 +5,6 @@ import {
   TestContainer,
   Wait,
 } from "testcontainers";
-import { EventStoreForDynamoDB } from "../event-store-for-dynamodb";
 import { UserAccountId } from "./user-account-id";
 import { UserAccount } from "./user-account";
 import { UserAccountEvent } from "./user-account-event";
@@ -17,6 +16,7 @@ import {
 } from "./dynamodb-utils";
 import { ulid } from "ulid";
 import { UserAccountRepository } from "./user-account-repository";
+import { EventStore, EventStoreFactory } from "../../event-store";
 
 afterEach(() => {
   jest.useRealTimers();
@@ -29,11 +29,7 @@ describe("UserAccountRepository", () => {
 
   let container: TestContainer;
   let startedContainer: StartedTestContainer;
-  let eventStore: EventStoreForDynamoDB<
-    UserAccountId,
-    UserAccount,
-    UserAccountEvent
-  >;
+  let eventStore: EventStore<UserAccountId, UserAccount, UserAccountEvent>;
 
   const JOURNAL_TABLE_NAME = "journal";
   const SNAPSHOT_TABLE_NAME = "snapshot";
@@ -42,8 +38,8 @@ describe("UserAccountRepository", () => {
 
   function createEventStore(
     dynamodbClient: DynamoDBClient,
-  ): EventStoreForDynamoDB<UserAccountId, UserAccount, UserAccountEvent> {
-    return new EventStoreForDynamoDB<
+  ): EventStore<UserAccountId, UserAccount, UserAccountEvent> {
+    return EventStoreFactory.ofDynamoDB<
       UserAccountId,
       UserAccount,
       UserAccountEvent