@ddd-ts-kit/knex 0.7.0 → 0.9.0

package/dist/tenancy/tenant-session.js

@@ -0,0 +1,21 @@
+import { TENANT_SETTINGS, tenantSettingValues } from '@ddd-ts-kit/kernel';
+/**
+ * The `begin` of a unit of work under row-level security: sets the tenant settings for the
+ * transaction only (`set_config(..., true)`), from the execution context of the work, so that a
+ * pooled connection never carries them to the next transaction. Work without a tenant sets them
+ * empty, and the policies then show it nothing.
+ */
+export function tenantSession(scope) {
+    return async (transaction) => {
+        const { tenant, reach, everyTenant } = tenantSettingValues(scope.current());
+        await transaction.raw('select set_config(?, ?, true), set_config(?, ?, true), set_config(?, ?, true)', [
+            TENANT_SETTINGS.tenant,
+            tenant,
+            TENANT_SETTINGS.reach,
+            reach,
+            TENANT_SETTINGS.everyTenant,
+            everyTenant,
+        ]);
+    };
+}
+//# sourceMappingURL=tenant-session.js.map

package/dist/tenancy/tenant-session.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenant-session.js","sourceRoot":"","sources":["../../src/tenancy/tenant-session.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAuB,MAAM,oBAAoB,CAAC;AAE/F;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAAqB;IACjD,OAAO,KAAK,EAAE,WAAW,EAAE,EAAE;QAC3B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,mBAAmB,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAE5E,MAAM,WAAW,CAAC,GAAG,CAAC,+EAA+E,EAAE;YACrG,eAAe,CAAC,MAAM;YACtB,MAAM;YACN,eAAe,CAAC,KAAK;YACrB,KAAK;YACL,eAAe,CAAC,WAAW;YAC3B,WAAW;SACZ,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC"}

package/dist/tenancy/tenant-table-target.d.ts

@@ -0,0 +1,7 @@
+/** A table of tenant data: its name, its schema, and its tenant column (`tenant_id` by default). */
+export interface TenantTableTarget {
+    readonly table: string;
+    readonly schema?: string;
+    readonly column?: string;
+}
+//# sourceMappingURL=tenant-table-target.d.ts.map

package/dist/tenancy/tenant-table-target.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenant-table-target.d.ts","sourceRoot":"","sources":["../../src/tenancy/tenant-table-target.ts"],"names":[],"mappings":"AAAA,oGAAoG;AACpG,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B"}

package/dist/tenancy/tenant-table-target.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=tenant-table-target.js.map

package/dist/tenancy/tenant-table-target.js.map

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

package/dist/tenancy/tenant-table.d.ts

@@ -0,0 +1,12 @@
+import type { Knex } from 'knex';
+import type { ExecutionScope } from '@ddd-ts-kit/kernel';
+import type { KnexContext } from '../unit-of-work/knex-context.js';
+import type { TenantTableTarget } from './tenant-table-target.js';
+/**
+ * The rows of a table of tenant data that a read may reach, on the executor of the unit of
+ * work: those of the tenant of the work, or of the tenants of an elevation. The one way a
+ * repository of a tenant-scoped project reads (`tenancy/scoped-statement`). Writes go through
+ * `ownTenantTable`, which an elevation does not widen.
+ */
+export declare function tenantTable<Row extends object>(context: KnexContext, scope: ExecutionScope, target: TenantTableTarget): Knex.QueryBuilder<Row, Row[]>;
+//# sourceMappingURL=tenant-table.d.ts.map

package/dist/tenancy/tenant-table.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenant-table.d.ts","sourceRoot":"","sources":["../../src/tenancy/tenant-table.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAGlE;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,SAAS,MAAM,EAC5C,OAAO,EAAE,WAAW,EACpB,KAAK,EAAE,cAAc,EACrB,MAAM,EAAE,iBAAiB,GACxB,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAE/B"}

package/dist/tenancy/tenant-table.js

@@ -0,0 +1,12 @@
+import { tableIn } from './table-in.js';
+import { whereTenant } from './where-tenant.js';
+/**
+ * The rows of a table of tenant data that a read may reach, on the executor of the unit of
+ * work: those of the tenant of the work, or of the tenants of an elevation. The one way a
+ * repository of a tenant-scoped project reads (`tenancy/scoped-statement`). Writes go through
+ * `ownTenantTable`, which an elevation does not widen.
+ */
+export function tenantTable(context, scope, target) {
+    return whereTenant(tableIn(context, target), scope, target.column);
+}
+//# sourceMappingURL=tenant-table.js.map

package/dist/tenancy/tenant-table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenant-table.js","sourceRoot":"","sources":["../../src/tenancy/tenant-table.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CACzB,OAAoB,EACpB,KAAqB,EACrB,MAAyB;IAEzB,OAAO,WAAW,CAAC,OAAO,CAAM,OAAO,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;AAC1E,CAAC"}

package/dist/tenancy/where-tenant.d.ts

@@ -0,0 +1,10 @@
+import type { Knex } from 'knex';
+import { type ExecutionScope } from '@ddd-ts-kit/kernel';
+/** The tenant column every table of tenant data has: `tenantColumn` writes it. */
+export declare const TENANT_COLUMN = "tenant_id";
+/**
+ * Confines a read to what the work in progress may see (`tenantReachOf`): its tenant, or the
+ * tenants of an elevation. Work that names no tenant is refused, never read unscoped.
+ */
+export declare function whereTenant<Row extends object, Result>(builder: Knex.QueryBuilder<Row, Result>, scope: ExecutionScope, column?: string): Knex.QueryBuilder<Row, Result>;
+//# sourceMappingURL=where-tenant.d.ts.map

package/dist/tenancy/where-tenant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"where-tenant.d.ts","sourceRoot":"","sources":["../../src/tenancy/where-tenant.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,EAAiB,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAExE,kFAAkF;AAClF,eAAO,MAAM,aAAa,cAAc,CAAC;AAEzC;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,SAAS,MAAM,EAAE,MAAM,EACpD,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,EACvC,KAAK,EAAE,cAAc,EACrB,MAAM,SAAgB,GACrB,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,CAQhC"}

package/dist/tenancy/where-tenant.js

@@ -0,0 +1,15 @@
+import { tenantReachOf } from '@ddd-ts-kit/kernel';
+/** The tenant column every table of tenant data has: `tenantColumn` writes it. */
+export const TENANT_COLUMN = 'tenant_id';
+/**
+ * Confines a read to what the work in progress may see (`tenantReachOf`): its tenant, or the
+ * tenants of an elevation. Work that names no tenant is refused, never read unscoped.
+ */
+export function whereTenant(builder, scope, column = TENANT_COLUMN) {
+    const reach = tenantReachOf(scope);
+    if (reach.kind === 'tenant') {
+        return builder.where(column, reach.tenantId);
+    }
+    return reach.tenants === 'all' ? builder : builder.whereIn(column, [...reach.tenants]);
+}
+//# sourceMappingURL=where-tenant.js.map

package/dist/tenancy/where-tenant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"where-tenant.js","sourceRoot":"","sources":["../../src/tenancy/where-tenant.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAuB,MAAM,oBAAoB,CAAC;AAExE,kFAAkF;AAClF,MAAM,CAAC,MAAM,aAAa,GAAG,WAAW,CAAC;AAEzC;;;GAGG;AACH,MAAM,UAAU,WAAW,CACzB,OAAuC,EACvC,KAAqB,EACrB,MAAM,GAAG,aAAa;IAEtB,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IAEnC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO,KAAK,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;AACzF,CAAC"}

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

@@ -4,11 +4,18 @@ 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 {
 }
+export interface KnexUnitOfWorkOptions {
+    /**
+     * Runs first in each outermost transaction, before the work: `tenantSession(scope)` sets the
+     * tenant settings row-level security reads, `tenantSearchPath` the schemas of the tenant.
+     */
+    readonly begin?: (transaction: Knex.Transaction) => Promise<void>;
+}
 /**
  * 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;
+export declare function createKnexUnitOfWork(knex: Knex, config?: Knex.TransactionConfig, options?: KnexUnitOfWorkOptions): KnexUnitOfWork;
 //# sourceMappingURL=create-knex-unit-of-work.d.ts.map

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

@@ -1 +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"}
+{"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,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACnE;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,IAAI,EACV,MAAM,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAC/B,OAAO,GAAE,qBAA0B,GAClC,cAAc,CAuBhB"}

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

@@ -6,15 +6,20 @@ import { withinUnitOfWork } from '@ddd-ts-kit/kernel';
  * `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) {
+export function createKnexUnitOfWork(knex, config, options = {}) {
     const current = new AsyncLocalStorage();
+    const { begin } = options;
     return {
         run(work) {
             return withinUnitOfWork(work, (scoped) => {
                 if (current.getStore() !== undefined) {
                     return scoped();
                 }
-                return knex.transaction((transaction) => current.run(transaction, scoped), config);
+                const opened = async (transaction) => {
+                    await begin?.(transaction);
+                    return scoped();
+                };
+                return knex.transaction((transaction) => current.run(transaction, () => opened(transaction)), config);
             });
         },
         executor: () => current.getStore() ?? knex,

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

@@ -1 +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"}
+{"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;AAcvE;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAClC,IAAU,EACV,MAA+B,EAC/B,OAAO,GAA0B,EAAE;IAEnC,MAAM,OAAO,GAAG,IAAI,iBAAiB,EAAoB,CAAC;IAC1D,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAE1B,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,MAAM,MAAM,GAAG,KAAK,EAAE,WAA6B,EAAc,EAAE;oBACjE,MAAM,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC;oBAE3B,OAAO,MAAM,EAAE,CAAC;gBAClB,CAAC,CAAC;gBAEF,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACxG,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ddd-ts-kit/knex",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Knex adapters for the kernel ports: unit of work, transactional outbox store, processed-event store.",
   "license": "MIT",
   "repository": {
@@ -26,15 +26,15 @@
     "dist"
   ],
   "dependencies": {
-    "@ddd-ts-kit/kernel": "0.7.0",
-    "@ddd-ts-kit/events": "0.7.0"
+    "@ddd-ts-kit/kernel": "0.9.0",
+    "@ddd-ts-kit/events": "0.9.0"
   },
   "peerDependencies": {
     "knex": "^3.0.0"
   },
   "devDependencies": {
     "knex": "^3.3.0",
-    "@ddd-ts-kit/testing": "0.7.0",
+    "@ddd-ts-kit/testing": "0.9.0",
     "pg": "^8.23.1",
     "@types/pg": "^8.23.1",
     "@electric-sql/pglite": "0.5.9",