@ddd-ts-kit/prisma 0.8.0 → 0.10.0

package/README.md

@@ -543,6 +543,26 @@ disappears with them if it fails.
 
 Delivery is at least once, unordered.
 
+## Event store
+
+Copy the models of `prisma/event-store.postgresql.prisma` into the schema; `prisma migrate dev`
+creates the tables. Keep their table and column names: the stores run raw statements on them.
+
+```ts
+const { events, snapshots, checkpoints, subjectKeys } = createPrismaEventSourcing(unitOfWork);
+```
+
+A context that keeps its event store in a schema of its own adds `@@schema("<context>")` to
+the copies, gives them model names of their own, and passes `{ schema: '<context>' }`.
+
+Each statement runs on the executor of the context: an append joins the transaction of the
+unit of work, so the stream and the outbox records its events publish commit together
+(`eventStoreUnitOfWorkContract`). Appends take the head of the store, a row locked until their
+transaction ends: positions are given in commit order, without gaps, and two appends never run
+side by side, whatever their streams. PostgreSQL only. The stores are the ones of the kernel
+(`PostgresEventStore` and its companions), held to `eventStoreContract` here; how an
+event-sourced aggregate uses them: the README of `@ddd-ts-kit/kernel`, section "Event sourcing".
+
 ## Dialect coverage
 
 What follows is about this package. The CLI generates for PostgreSQL only: `init --orm prisma`

package/dist/event-sourcing/create-prisma-event-sourcing.d.ts

@@ -0,0 +1,11 @@
+import { type EventSourcingStores, type EventStoreTablesOptions } from '@ddd-ts-kit/kernel';
+import type { PrismaRawQueries } from '../outbox/prisma-raw-queries.js';
+import type { PrismaContext } from '../unit-of-work/prisma-context.js';
+/**
+ * The event store, the snapshots, the checkpoints and the keys of the data subjects on
+ * PostgreSQL, through the raw queries of the Prisma client, over the models of
+ * `prisma/event-store.postgresql.prisma`. Every statement runs on the client of the context, so
+ * an append joins the transaction of the unit of work, with the outbox. Bind each one to its port.
+ */
+export declare function createPrismaEventSourcing<Tx extends PrismaRawQueries>(context: PrismaContext<Tx>, options?: EventStoreTablesOptions): EventSourcingStores;
+//# sourceMappingURL=create-prisma-event-sourcing.d.ts.map

package/dist/event-sourcing/create-prisma-event-sourcing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-prisma-event-sourcing.d.ts","sourceRoot":"","sources":["../../src/event-sourcing/create-prisma-event-sourcing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,KAAK,mBAAmB,EAAE,KAAK,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AACnH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAEvE;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,EAAE,SAAS,gBAAgB,EACnE,OAAO,EAAE,aAAa,CAAC,EAAE,CAAC,EAC1B,OAAO,GAAE,uBAA4B,GACpC,mBAAmB,CAQrB"}

package/dist/event-sourcing/create-prisma-event-sourcing.js

@@ -0,0 +1,16 @@
+import { postgresEventSourcing } from '@ddd-ts-kit/kernel';
+/**
+ * The event store, the snapshots, the checkpoints and the keys of the data subjects on
+ * PostgreSQL, through the raw queries of the Prisma client, over the models of
+ * `prisma/event-store.postgresql.prisma`. Every statement runs on the client of the context, so
+ * an append joins the transaction of the unit of work, with the outbox. Bind each one to its port.
+ */
+export function createPrismaEventSourcing(context, options = {}) {
+    return postgresEventSourcing(async (statement, parameters) => {
+        const rows = await context.client().$queryRawUnsafe(statement, ...parameters);
+        return Array.isArray(rows)
+            ? rows.filter((row) => typeof row === 'object' && row !== null)
+            : [];
+    }, options);
+}
+//# sourceMappingURL=create-prisma-event-sourcing.js.map

package/dist/event-sourcing/create-prisma-event-sourcing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-prisma-event-sourcing.js","sourceRoot":"","sources":["../../src/event-sourcing/create-prisma-event-sourcing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAA0D,MAAM,oBAAoB,CAAC;AAInH;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CACvC,OAA0B,EAC1B,OAAO,GAA4B,EAAE;IAErC,OAAO,qBAAqB,CAAC,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE;QAC3D,MAAM,IAAI,GAAY,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,eAAe,CAAC,SAAS,EAAE,GAAG,UAAU,CAAC,CAAC;QAEvF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;YACxB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAA4C,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,CAAC;YACzG,CAAC,CAAC,EAAE,CAAC;IACT,CAAC,EAAE,OAAO,CAAC,CAAC;AACd,CAAC"}

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export * from './unit-of-work/prisma-transaction-host.js';
 export * from './unit-of-work/prisma-transaction-client.js';
 export * from './unit-of-work/prisma-context.js';
 export * from './unit-of-work/create-prisma-unit-of-work.js';
+export * from './event-sourcing/create-prisma-event-sourcing.js';
 export * from './outbox/prisma-json-input.js';
 export * from './outbox/prisma-outbox-delegate.js';
 export * from './outbox/prisma-raw-queries.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAEhB,YAAY,EACZ,KAAK,WAAW,GACjB,MAAM,oBAAoB,CAAC;AAC5B,cAAc,2CAA2C,CAAC;AAC1D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,kCAAkC,CAAC;AACjD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oCAAoC,CAAC;AACnD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,iCAAiC,CAAC;AAChD,cAAc,qCAAqC,CAAC;AACpD,cAAc,oCAAoC,CAAC;AACnD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAEhB,YAAY,EACZ,KAAK,WAAW,GACjB,MAAM,oBAAoB,CAAC;AAC5B,cAAc,2CAA2C,CAAC;AAC1D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,kCAAkC,CAAC;AACjD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,kDAAkD,CAAC;AACjE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oCAAoC,CAAC;AACnD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,iCAAiC,CAAC;AAChD,cAAc,qCAAqC,CAAC;AACpD,cAAc,oCAAoC,CAAC;AACnD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC"}

package/dist/index.js

@@ -5,6 +5,7 @@ export * from './unit-of-work/prisma-transaction-host.js';
 export * from './unit-of-work/prisma-transaction-client.js';
 export * from './unit-of-work/prisma-context.js';
 export * from './unit-of-work/create-prisma-unit-of-work.js';
+export * from './event-sourcing/create-prisma-event-sourcing.js';
 export * from './outbox/prisma-json-input.js';
 export * from './outbox/prisma-outbox-delegate.js';
 export * from './outbox/prisma-raw-queries.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB;AAChB,oFAAoF;AACpF,YAAY,GAEb,MAAM,oBAAoB,CAAC;AAC5B,cAAc,2CAA2C,CAAC;AAC1D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,kCAAkC,CAAC;AACjD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oCAAoC,CAAC;AACnD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,iCAAiC,CAAC;AAChD,cAAc,qCAAqC,CAAC;AACpD,cAAc,oCAAoC,CAAC;AACnD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB;AAChB,oFAAoF;AACpF,YAAY,GAEb,MAAM,oBAAoB,CAAC;AAC5B,cAAc,2CAA2C,CAAC;AAC1D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,kCAAkC,CAAC;AACjD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,kDAAkD,CAAC;AACjE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oCAAoC,CAAC;AACnD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,iCAAiC,CAAC;AAChD,cAAc,qCAAqC,CAAC;AACpD,cAAc,oCAAoC,CAAC;AACnD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ddd-ts-kit/prisma",
-  "version": "0.8.0",
-  "description": "Prisma adapters for the kernel ports: unit of work, transactional outbox store, processed-event store.",
+  "version": "0.10.0",
+  "description": "Prisma adapters for the kernel ports: unit of work, transactional outbox store, processed-event store, PostgreSQL event store.",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -27,8 +27,8 @@
     "prisma"
   ],
   "dependencies": {
-    "@ddd-ts-kit/kernel": "0.8.0",
-    "@ddd-ts-kit/events": "0.8.0"
+    "@ddd-ts-kit/kernel": "0.10.0",
+    "@ddd-ts-kit/events": "0.10.0"
   },
   "peerDependencies": {
     "@prisma/client": "^7.0.0"
@@ -37,7 +37,7 @@
     "@prisma/client": "^7.10.0",
     "prisma": "^7.10.0",
     "@prisma/adapter-pg": "^7.10.0",
-    "@ddd-ts-kit/testing": "0.8.0",
+    "@ddd-ts-kit/testing": "0.10.0",
     "pg": "^8.23.1",
     "@types/pg": "^8.23.1",
     "@electric-sql/pglite": "0.5.9",

package/prisma/event-store.postgresql.prisma

@@ -0,0 +1,60 @@
+// Models of the event store of @ddd-ts-kit/prisma for PostgreSQL. Copy them into your
+// schema.prisma; your own `prisma migrate dev` then creates the tables in a migration of your
+// project. The stores run raw statements against these tables: keep the table and column names
+// (`@@map`, `@map`). A context that keeps its own event store puts the models in its schema
+// (`@@schema("<context>")`, with model names of its own) and gives `createPrismaEventSourcing`
+// that `schema`.
+
+/// The head of the store: the position the next append starts after. One row, id 1, locked by
+/// each append until its transaction ends.
+model StoredEventsHead {
+  id       Int    @id @db.SmallInt
+  position BigInt
+
+  @@map("stored_events_head")
+}
+
+/// The events of every stream, never changed once written.
+model StoredEvent {
+  position      BigInt   @id
+  stream        String
+  version       Int
+  eventId       String   @unique @map("event_id")
+  type          String
+  schemaVersion Int      @map("schema_version")
+  data          Json
+  metadata      Json
+  occurredAt    DateTime @map("occurred_at") @db.Timestamptz(3)
+  recordedAt    DateTime @default(now()) @map("recorded_at") @db.Timestamptz(3)
+
+  @@unique([stream, version])
+  @@map("stored_events")
+}
+
+model StreamSnapshot {
+  stream        String   @id
+  version       Int
+  schemaVersion Int      @map("schema_version")
+  data          Json
+  takenAt       DateTime @default(now()) @map("taken_at") @db.Timestamptz(3)
+
+  @@map("stream_snapshots")
+}
+
+model SubscriptionCheckpoint {
+  subscriber String   @id
+  position   BigInt
+  updatedAt  DateTime @default(now()) @map("updated_at") @db.Timestamptz(3)
+
+  @@map("subscription_checkpoints")
+}
+
+/// One key per data subject: erasing the subject deletes its row.
+model SubjectKey {
+  subject   String   @id
+  keyId     String   @unique @map("key_id")
+  material  String
+  createdAt DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
+
+  @@map("subject_keys")
+}