@ddd-ts-kit/knex 0.8.0 → 0.10.0

package/README.md

@@ -597,6 +597,28 @@ Criteria and read models were never run on MySQL or SQLite.
   `(consumer, event_id)`. Run the consumer inside the unit of work: the mark then commits with
   the effects of the handler, and disappears with them if it fails.
 
+## Event store
+
+```ts
+// a migration of the project
+export const up = (knex) => createEventStoreTables(knex, { schema: 'scheduling' });
+
+// the composition root
+const { events, snapshots, checkpoints, subjectKeys } = createKnexEventSourcing(unitOfWork, { schema: 'scheduling' });
+```
+
+`createEventStoreTables` runs `eventStoreTablesSql` of the kernel: `stored_events`,
+`stored_events_head`, `stream_snapshots`, `subscription_checkpoints` and `subject_keys`, in the
+schema of the context. `createKnexEventSourcing` refuses a knex that does not speak PostgreSQL.
+
+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 knex`

package/dist/event-sourcing/create-event-store-tables.d.ts

@@ -0,0 +1,9 @@
+import type { Knex } from 'knex';
+import { type EventStoreTablesOptions } from '@ddd-ts-kit/kernel';
+/**
+ * Creates the tables of the event store. Call it from a migration of the consuming project
+ * (`export const up = (knex) => createEventStoreTables(knex, { schema: 'scheduling' })`), which
+ * then owns the tables like any other.
+ */
+export declare function createEventStoreTables(knex: Knex, options?: EventStoreTablesOptions): Promise<void>;
+//# sourceMappingURL=create-event-store-tables.d.ts.map

package/dist/event-sourcing/create-event-store-tables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-event-store-tables.d.ts","sourceRoot":"","sources":["../../src/event-sourcing/create-event-store-tables.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,EAAuB,KAAK,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAEvF;;;;GAIG;AACH,wBAAsB,sBAAsB,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,GAAE,uBAA4B,GAAG,OAAO,CAAC,IAAI,CAAC,CAI7G"}

package/dist/event-sourcing/create-event-store-tables.js

@@ -0,0 +1,12 @@
+import { eventStoreTablesSql } from '@ddd-ts-kit/kernel';
+/**
+ * Creates the tables of the event store. Call it from a migration of the consuming project
+ * (`export const up = (knex) => createEventStoreTables(knex, { schema: 'scheduling' })`), which
+ * then owns the tables like any other.
+ */
+export async function createEventStoreTables(knex, options = {}) {
+    for (const statement of eventStoreTablesSql(options)) {
+        await knex.raw(statement);
+    }
+}
+//# sourceMappingURL=create-event-store-tables.js.map

package/dist/event-sourcing/create-event-store-tables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-event-store-tables.js","sourceRoot":"","sources":["../../src/event-sourcing/create-event-store-tables.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAgC,MAAM,oBAAoB,CAAC;AAEvF;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,IAAU,EAAE,OAAO,GAA4B,EAAE;IAC5F,KAAK,MAAM,SAAS,IAAI,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;AACH,CAAC"}

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

@@ -0,0 +1,9 @@
+import { type EventSourcingStores, type EventStoreTablesOptions } from '@ddd-ts-kit/kernel';
+import type { KnexContext } from '../unit-of-work/knex-context.js';
+/**
+ * The event store, the snapshots, the checkpoints and the keys of the data subjects on
+ * PostgreSQL, through knex. Every statement runs on the executor 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 createKnexEventSourcing(context: KnexContext, options?: EventStoreTablesOptions): EventSourcingStores;
+//# sourceMappingURL=create-knex-event-sourcing.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-knex-event-sourcing.d.ts","sourceRoot":"","sources":["../../src/event-sourcing/create-knex-event-sourcing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,KAAK,mBAAmB,EAAE,KAAK,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAEnH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAGnE;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,WAAW,EACpB,OAAO,GAAE,uBAA4B,GACpC,mBAAmB,CAQrB"}

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

@@ -0,0 +1,16 @@
+import { postgresEventSourcing } from '@ddd-ts-kit/kernel';
+import { dialectOf } from '../sql/dialect-of.js';
+import { knexSqlRun } from './knex-sql-run.js';
+/**
+ * The event store, the snapshots, the checkpoints and the keys of the data subjects on
+ * PostgreSQL, through knex. Every statement runs on the executor 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 createKnexEventSourcing(context, options = {}) {
+    const dialect = dialectOf(context.executor());
+    if (dialect !== 'postgres') {
+        throw new TypeError(`The event store of @ddd-ts-kit/knex runs on PostgreSQL, and this knex speaks ${dialect}`);
+    }
+    return postgresEventSourcing(knexSqlRun(context), options);
+}
+//# sourceMappingURL=create-knex-event-sourcing.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-knex-event-sourcing.js","sourceRoot":"","sources":["../../src/event-sourcing/create-knex-event-sourcing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAA0D,MAAM,oBAAoB,CAAC;AACnH,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,OAAoB,EACpB,OAAO,GAA4B,EAAE;IAErC,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAE9C,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;QAC3B,MAAM,IAAI,SAAS,CAAC,gFAAgF,OAAO,EAAE,CAAC,CAAC;IACjH,CAAC;IAED,OAAO,qBAAqB,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;AAC7D,CAAC"}

package/dist/event-sourcing/knex-sql-run.d.ts

@@ -0,0 +1,5 @@
+import type { SqlRun } from '@ddd-ts-kit/kernel';
+import type { KnexContext } from '../unit-of-work/knex-context.js';
+/** Runs the statements of the shared PostgreSQL stores on the executor of the context: knex binds `?`, each `$n` is one. */
+export declare function knexSqlRun(context: KnexContext): SqlRun;
+//# sourceMappingURL=knex-sql-run.d.ts.map

package/dist/event-sourcing/knex-sql-run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"knex-sql-run.d.ts","sourceRoot":"","sources":["../../src/event-sourcing/knex-sql-run.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAEjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAEnE,4HAA4H;AAC5H,wBAAgB,UAAU,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,CAMvD"}

package/dist/event-sourcing/knex-sql-run.js

@@ -0,0 +1,9 @@
+import { recordsOf } from '../read-model/records-of.js';
+/** Runs the statements of the shared PostgreSQL stores on the executor of the context: knex binds `?`, each `$n` is one. */
+export function knexSqlRun(context) {
+    return async (statement, parameters) => {
+        const result = await context.executor().raw(statement.replace(/\$\d+/g, '?'), [...parameters]);
+        return recordsOf(typeof result === 'object' && result !== null && 'rows' in result ? result.rows : []);
+    };
+}
+//# sourceMappingURL=knex-sql-run.js.map

package/dist/event-sourcing/knex-sql-run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"knex-sql-run.js","sourceRoot":"","sources":["../../src/event-sourcing/knex-sql-run.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAGxD,4HAA4H;AAC5H,MAAM,UAAU,UAAU,CAAC,OAAoB;IAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE;QACrC,MAAM,MAAM,GAAY,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;QAExG,OAAO,SAAS,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACzG,CAAC,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 export { CONCURRENCY_CONFLICT, ConcurrencyError, optimisticUpdate, schemaNameOf, type VersionStep, } from '@ddd-ts-kit/kernel';
 export * from './unit-of-work/knex-context.js';
 export * from './unit-of-work/create-knex-unit-of-work.js';
+export * from './event-sourcing/create-event-store-tables.js';
+export * from './event-sourcing/create-knex-event-sourcing.js';
 export * from './outbox/table-names.js';
 export * from './outbox/outbox-tables-options.js';
 export * from './outbox/create-outbox-tables.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,EAChB,YAAY,EACZ,KAAK,WAAW,GACjB,MAAM,oBAAoB,CAAC;AAC5B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,yBAAyB,CAAC;AACxC,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wCAAwC,CAAC;AACvD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AACrD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,oCAAoC,CAAC;AACnD,cAAc,uCAAuC,CAAC;AACtD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8CAA8C,CAAC;AAC7D,cAAc,mDAAmD,CAAC;AAClE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,mCAAmC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,EACZ,KAAK,WAAW,GACjB,MAAM,oBAAoB,CAAC;AAC5B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,yBAAyB,CAAC;AACxC,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wCAAwC,CAAC;AACvD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AACrD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,oCAAoC,CAAC;AACnD,cAAc,uCAAuC,CAAC;AACtD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8CAA8C,CAAC;AAC7D,cAAc,mDAAmD,CAAC;AAClE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,mCAAmC,CAAC"}

package/dist/index.js

@@ -1,6 +1,8 @@
 export { CONCURRENCY_CONFLICT, ConcurrencyError, optimisticUpdate, schemaNameOf, } from '@ddd-ts-kit/kernel';
 export * from './unit-of-work/knex-context.js';
 export * from './unit-of-work/create-knex-unit-of-work.js';
+export * from './event-sourcing/create-event-store-tables.js';
+export * from './event-sourcing/create-knex-event-sourcing.js';
 export * from './outbox/table-names.js';
 export * from './outbox/outbox-tables-options.js';
 export * from './outbox/create-outbox-tables.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,EAChB,YAAY,GAEb,MAAM,oBAAoB,CAAC;AAC5B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,yBAAyB,CAAC;AACxC,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wCAAwC,CAAC;AACvD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AACrD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,oCAAoC,CAAC;AACnD,cAAc,uCAAuC,CAAC;AACtD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8CAA8C,CAAC;AAC7D,cAAc,mDAAmD,CAAC;AAClE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,mCAAmC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,GAEb,MAAM,oBAAoB,CAAC;AAC5B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,yBAAyB,CAAC;AACxC,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wCAAwC,CAAC;AACvD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AACrD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,oCAAoC,CAAC;AACnD,cAAc,uCAAuC,CAAC;AACtD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8CAA8C,CAAC;AAC7D,cAAc,mDAAmD,CAAC;AAClE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,mCAAmC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ddd-ts-kit/knex",
-  "version": "0.8.0",
-  "description": "Knex adapters for the kernel ports: unit of work, transactional outbox store, processed-event store.",
+  "version": "0.10.0",
+  "description": "Knex adapters for the kernel ports: unit of work, transactional outbox store, processed-event store, PostgreSQL event store.",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -26,15 +26,15 @@
     "dist"
   ],
   "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": {
     "knex": "^3.0.0"
   },
   "devDependencies": {
     "knex": "^3.3.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",