@ddd-ts-kit/knex 0.0.0-stage → 0.1.0

package/dist/sql/insert-ignoring-conflict.js

@@ -0,0 +1,28 @@
+import { dialectOf } from './dialect-of.js';
+/**
+ * Inserts one row unless its key already exists, and says whether it did insert. Unlike
+ * catching the unique violation, it leaves the surrounding transaction usable on PostgreSQL.
+ * It serves the processed-event store and the first save of an aggregate alike.
+ *
+ * `table` is the query builder of the target table, built on `executor`:
+ * `insertIgnoringConflict(db, db('invoices').withSchema('billing'), { row, conflict: 'id' })`.
+ */
+export async function insertIgnoringConflict(executor, table, { row, conflict }) {
+    const columns = typeof conflict === 'string' ? [conflict] : [...conflict];
+    const insert = table.insert(row).onConflict(columns).ignore();
+    if (dialectOf(executor) === 'mysql') {
+        return wroteOnMySql(executor, insert);
+    }
+    // RETURNING yields the row only when it was written.
+    const inserted = await insert.returning(columns[0] ?? '*');
+    return inserted.length === 1;
+}
+// No RETURNING in MySQL and knex only reports the insert id: the driver's own result header
+// is the one place that says whether INSERT IGNORE wrote the row.
+async function wroteOnMySql(executor, insert) {
+    const { sql, bindings } = insert.toSQL().toNative();
+    const result = await executor.raw(sql, bindings);
+    const header = Array.isArray(result) ? result[0] : result;
+    return typeof header === 'object' && header !== null && 'affectedRows' in header && header.affectedRows === 1;
+}
+//# sourceMappingURL=insert-ignoring-conflict.js.map

package/dist/sql/insert-ignoring-conflict.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"insert-ignoring-conflict.js","sourceRoot":"","sources":["../../src/sql/insert-ignoring-conflict.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAQ5C;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,QAAc,EACd,KAAwB,EACxB,EAAE,GAAG,EAAE,QAAQ,EAAkB;IAEjC,MAAM,OAAO,GAAG,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC;IAC1E,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;IAE9D,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,OAAO,EAAE,CAAC;QACpC,OAAO,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC;IAED,qDAAqD;IACrD,MAAM,QAAQ,GAAc,MAAM,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC;IAEtE,OAAO,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,4FAA4F;AAC5F,kEAAkE;AAClE,KAAK,UAAU,YAAY,CAAC,QAAc,EAAE,MAAyB;IACnE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC;IACpD,MAAM,MAAM,GAAY,MAAM,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAY,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IAEnE,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,cAAc,IAAI,MAAM,IAAI,MAAM,CAAC,YAAY,KAAK,CAAC,CAAC;AAChH,CAAC"}

package/dist/sql/sql-dialect.d.ts

@@ -0,0 +1,3 @@
+/** The dialect families the adapters tell apart; everything else takes the portable path. */
+export type SqlDialect = 'postgres' | 'mysql' | 'sqlite' | 'other';
+//# sourceMappingURL=sql-dialect.d.ts.map

package/dist/sql/sql-dialect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql-dialect.d.ts","sourceRoot":"","sources":["../../src/sql/sql-dialect.ts"],"names":[],"mappings":"AAAA,6FAA6F;AAC7F,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC"}

package/dist/sql/sql-dialect.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sql-dialect.js.map

package/dist/sql/sql-dialect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql-dialect.js","sourceRoot":"","sources":["../../src/sql/sql-dialect.ts"],"names":[],"mappings":""}

package/dist/unit-of-work/create-knex-unit-of-work.d.ts

@@ -0,0 +1,14 @@
+import type { Knex } from 'knex';
+import { type UnitOfWork } from '@ddd-ts-kit/kernel';
+import type { KnexContext } from './knex-context.js';
+/** One object for both ports: bind it to `UnitOfWork` and to `KnexContext`. */
+export interface KnexUnitOfWork extends UnitOfWork, KnexContext {
+}
+/**
+ * A unit of work over `knex.transaction`. The transaction travels in an AsyncLocalStorage
+ * owned by this unit of work, so two databases never see each other's transaction. A nested
+ * `run` joins the outer transaction: it commits or rolls back as a whole. Domain events are
+ * dispatched at the end of the outermost `run`, before its commit (`withinUnitOfWork`).
+ */
+export declare function createKnexUnitOfWork(knex: Knex, config?: Knex.TransactionConfig): KnexUnitOfWork;
+//# sourceMappingURL=create-knex-unit-of-work.d.ts.map

package/dist/unit-of-work/create-knex-unit-of-work.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-knex-unit-of-work.d.ts","sourceRoot":"","sources":["../../src/unit-of-work/create-knex-unit-of-work.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,EAAoB,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,+EAA+E;AAC/E,MAAM,WAAW,cAAe,SAAQ,UAAU,EAAE,WAAW;CAAG;AAElE;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,iBAAiB,GAAG,cAAc,CAgBhG"}

package/dist/unit-of-work/create-knex-unit-of-work.js

@@ -0,0 +1,24 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { withinUnitOfWork } from '@ddd-ts-kit/kernel';
+/**
+ * A unit of work over `knex.transaction`. The transaction travels in an AsyncLocalStorage
+ * owned by this unit of work, so two databases never see each other's transaction. A nested
+ * `run` joins the outer transaction: it commits or rolls back as a whole. Domain events are
+ * dispatched at the end of the outermost `run`, before its commit (`withinUnitOfWork`).
+ */
+export function createKnexUnitOfWork(knex, config) {
+    const current = new AsyncLocalStorage();
+    return {
+        run(work) {
+            return withinUnitOfWork(work, (scoped) => {
+                if (current.getStore() !== undefined) {
+                    return scoped();
+                }
+                return knex.transaction((transaction) => current.run(transaction, scoped), config);
+            });
+        },
+        executor: () => current.getStore() ?? knex,
+        inTransaction: () => current.getStore() !== undefined,
+    };
+}
+//# sourceMappingURL=create-knex-unit-of-work.js.map

package/dist/unit-of-work/create-knex-unit-of-work.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-knex-unit-of-work.js","sourceRoot":"","sources":["../../src/unit-of-work/create-knex-unit-of-work.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,EAAE,gBAAgB,EAAmB,MAAM,oBAAoB,CAAC;AAMvE;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAU,EAAE,MAA+B;IAC9E,MAAM,OAAO,GAAG,IAAI,iBAAiB,EAAoB,CAAC;IAE1D,OAAO;QACL,GAAG,CAAI,IAAsB;YAC3B,OAAO,gBAAgB,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE;gBACvC,IAAI,OAAO,CAAC,QAAQ,EAAE,KAAK,SAAS,EAAE,CAAC;oBACrC,OAAO,MAAM,EAAE,CAAC;gBAClB,CAAC;gBAED,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;YACrF,CAAC,CAAC,CAAC;QACL,CAAC;QACD,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,IAAI;QAC1C,aAAa,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,SAAS;KACtD,CAAC;AACJ,CAAC"}

package/dist/unit-of-work/knex-context.d.ts

@@ -0,0 +1,13 @@
+import type { Knex } from 'knex';
+/**
+ * Gives adapters the right handle to run their queries on: the transaction of the current
+ * unit of work when there is one, the root knex instance otherwise. Repositories depend on
+ * this and never receive a transaction as a parameter. A knex transaction is a `Knex`, hence
+ * the single return type.
+ */
+export declare abstract class KnexContext {
+    static readonly tokenKey = "knex.KnexContext";
+    abstract executor(): Knex;
+    abstract inTransaction(): boolean;
+}
+//# sourceMappingURL=knex-context.d.ts.map

package/dist/unit-of-work/knex-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"knex-context.d.ts","sourceRoot":"","sources":["../../src/unit-of-work/knex-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAEjC;;;;;GAKG;AACH,8BAAsB,WAAW;IAC/B,MAAM,CAAC,QAAQ,CAAC,QAAQ,sBAAsB;IAE9C,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;IAE1B,QAAQ,CAAC,aAAa,IAAI,OAAO,CAAC;CACnC"}

package/dist/unit-of-work/knex-context.js

@@ -0,0 +1,10 @@
+/**
+ * Gives adapters the right handle to run their queries on: the transaction of the current
+ * unit of work when there is one, the root knex instance otherwise. Repositories depend on
+ * this and never receive a transaction as a parameter. A knex transaction is a `Knex`, hence
+ * the single return type.
+ */
+export class KnexContext {
+    static tokenKey = 'knex.KnexContext';
+}
+//# sourceMappingURL=knex-context.js.map

package/dist/unit-of-work/knex-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"knex-context.js","sourceRoot":"","sources":["../../src/unit-of-work/knex-context.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,OAAgB,WAAW;IAC/B,MAAM,CAAU,QAAQ,GAAG,kBAAkB,CAAC;CAK/C"}

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@ddd-ts-kit/knex",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Knex adapters for the kernel ports: unit of work, transactional outbox store, processed-event store.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gbourgeat/ddd-ts-kit.git",
+    "directory": "packages/knex"
+  },
+  "homepage": "https://github.com/gbourgeat/ddd-ts-kit/tree/main/packages/knex#readme",
+  "bugs": "https://github.com/gbourgeat/ddd-ts-kit/issues",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@ddd-ts-kit/kernel": "0.1.0",
+    "@ddd-ts-kit/events": "0.1.0"
+  },
+  "peerDependencies": {
+    "knex": "^3.0.0"
+  },
+  "devDependencies": {
+    "knex": "^3.3.0",
+    "@ddd-ts-kit/testing": "0.1.0",
+    "pg": "^8.23.1",
+    "@types/pg": "^8.23.1",
+    "@electric-sql/pglite": "^0.5.8",
+    "@electric-sql/pglite-socket": "^0.2.11"
+  }
+}