@naturalcycles/db-lib 8.52.0 → 8.54.0

package/dist/commondao/common.dao.d.ts

@@ -1,4 +1,4 @@
-import { AnyObject, AsyncMapper, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId, Promisable, Saved, Unsaved, ZodSchema } from '@naturalcycles/js-lib';
+import { AnyObject, AsyncMapper, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId, Promisable, Saved, UnixTimestampMillisNumber, Unsaved, ZodSchema } from '@naturalcycles/js-lib';
 import { AjvSchema, ObjectSchemaTyped, ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { DBDeleteByIdsOperation, DBModelType, DBOperation, DBPatch, DBSaveBatchOperation, RunQueryResult } from '../db.model';
 import { DBQuery, RunnableDBQuery } from '../query/dbQuery';
@@ -84,7 +84,7 @@ export declare class CommonDao<BM extends Partial<ObjectWithId<ID>>, DBM extends
     assignIdCreatedUpdated(obj: BM, opt?: CommonDaoOptions): Saved<BM>;
     assignIdCreatedUpdated(obj: Unsaved<BM>, opt?: CommonDaoOptions): Saved<BM>;
     tx: {
-        save: (bm: Unsaved<BM>, opt?: CommonDaoSaveOptions<DBM>) => Promise<DBSaveBatchOperation>;
+        save: (bm: Unsaved<BM>, opt?: CommonDaoSaveOptions<DBM>) => Promise<DBSaveBatchOperation | undefined>;
         saveBatch: (bms: Unsaved<BM>[], opt?: CommonDaoSaveOptions<DBM>) => Promise<DBSaveBatchOperation | undefined>;
         deleteByIds: (ids: ID[], opt?: CommonDaoOptions) => Promise<DBDeleteByIdsOperation | undefined>;
         deleteById: (id: ID | null | undefined, opt?: CommonDaoOptions) => Promise<DBDeleteByIdsOperation | undefined>;
@@ -139,9 +139,6 @@ export declare class CommonDao<BM extends Partial<ObjectWithId<ID>>, DBM extends
     bmToTM(bm: undefined, opt?: CommonDaoOptions): TM | undefined;
     bmToTM(bm?: Saved<BM>, opt?: CommonDaoOptions): TM;
     bmsToTM(bms: Saved<BM>[], opt?: CommonDaoOptions): TM[];
-    tmToBM(tm: undefined, opt?: CommonDaoOptions): undefined;
-    tmToBM(tm?: TM, opt?: CommonDaoOptions): BM;
-    tmsToBM(tms: TM[], opt?: CommonDaoOptions): BM[];
     /**
      * Returns *converted value*.
      * Validates (unless `skipValidation=true` passed).
@@ -158,6 +155,6 @@ export declare class CommonDao<BM extends Partial<ObjectWithId<ID>>, DBM extends
     runInTransaction(ops: Promisable<DBOperation | undefined>[]): Promise<void>;
     protected logResult(started: number, op: string, res: any, table: string): void;
     protected logSaveResult(started: number, op: string, table: string): void;
-    protected logStarted(op: string, table: string, force?: boolean): number;
-    protected logSaveStarted(op: string, items: any, table: string): number;
+    protected logStarted(op: string, table: string, force?: boolean): UnixTimestampMillisNumber;
+    protected logSaveStarted(op: string, items: any, table: string): UnixTimestampMillisNumber;
 }

package/dist/commondao/common.dao.js

@@ -22,7 +22,10 @@ class CommonDao {
         this.cfg = cfg;
         this.tx = {
             save: async (bm, opt = {}) => {
+                // .save actually returns DBM (not BM) when it detects `opt.tx === true`
                 const row = (await this.save(bm, { ...opt, tx: true }));
+                if (row === null)
+                    return;
                 return {
                     type: 'saveBatch',
                     table: this.cfg.table,
@@ -34,9 +37,9 @@ class CommonDao {
                 };
             },
             saveBatch: async (bms, opt = {}) => {
-                if (!bms.length)
-                    return;
                 const rows = (await this.saveBatch(bms, { ...opt, tx: true }));
+                if (!rows.length)
+                    return;
                 return {
                     type: 'saveBatch',
                     table: this.cfg.table,
@@ -86,7 +89,6 @@ class CommonDao {
                 beforeDBMValidate: dbm => dbm,
                 beforeDBMToBM: dbm => dbm,
                 beforeBMToDBM: bm => bm,
-                beforeTMToBM: tm => tm,
                 beforeBMToTM: bm => bm,
                 anonymize: dbm => dbm,
                 onValidationError: err => err,
@@ -114,7 +116,10 @@ class CommonDao {
         const op = `getById(${id})`;
         const table = opt.table || this.cfg.table;
         const started = this.logStarted(op, table);
-        const dbm = (await this.cfg.db.getByIds(table, [id]))[0];
+        let dbm = (await this.cfg.db.getByIds(table, [id]))[0];
+        if (dbm && !opt.raw && this.cfg.hooks.afterLoad) {
+            dbm = (await this.cfg.hooks.afterLoad(dbm)) || undefined;
+        }
         const bm = opt.raw ? dbm : await this.dbmToBM(dbm, opt);
         this.logResult(started, op, bm, table);
         return bm || null;
@@ -139,6 +144,9 @@ class CommonDao {
         const table = opt.table || this.cfg.table;
         const started = this.logStarted(op, table);
         let [dbm] = await this.cfg.db.getByIds(table, [id]);
+        if (dbm && !opt.raw && this.cfg.hooks.afterLoad) {
+            dbm = (await this.cfg.hooks.afterLoad(dbm)) || undefined;
+        }
         if (!opt.raw) {
             dbm = this.anyToDBM(dbm, opt);
         }
@@ -151,7 +159,10 @@ class CommonDao {
         const op = `getByIdAsTM(${id})`;
         const table = opt.table || this.cfg.table;
         const started = this.logStarted(op, table);
-        const [dbm] = await this.cfg.db.getByIds(table, [id]);
+        let [dbm] = await this.cfg.db.getByIds(table, [id]);
+        if (dbm && !opt.raw && this.cfg.hooks.afterLoad) {
+            dbm = (await this.cfg.hooks.afterLoad(dbm)) || undefined;
+        }
         if (opt.raw) {
             this.logResult(started, op, dbm, table);
             return dbm || null;
@@ -162,19 +173,29 @@ class CommonDao {
         return tm || null;
     }
     async getByIds(ids, opt = {}) {
+        if (!ids.length)
+            return [];
         const op = `getByIds ${ids.length} id(s) (${(0, js_lib_1._truncate)(ids.slice(0, 10).join(', '), 50)})`;
         const table = opt.table || this.cfg.table;
         const started = this.logStarted(op, table);
-        const dbms = await this.cfg.db.getByIds(table, ids);
+        let dbms = await this.cfg.db.getByIds(table, ids);
+        if (!opt.raw && this.cfg.hooks.afterLoad && dbms.length) {
+            dbms = (await (0, js_lib_1.pMap)(dbms, async (dbm) => await this.cfg.hooks.afterLoad(dbm))).filter(js_lib_1._isTruthy);
+        }
         const bms = opt.raw ? dbms : await this.dbmsToBM(dbms, opt);
         this.logResult(started, op, bms, table);
         return bms;
     }
     async getByIdsAsDBM(ids, opt = {}) {
+        if (!ids.length)
+            return [];
         const op = `getByIdsAsDBM ${ids.length} id(s) (${(0, js_lib_1._truncate)(ids.slice(0, 10).join(', '), 50)})`;
         const table = opt.table || this.cfg.table;
         const started = this.logStarted(op, table);
-        const dbms = await this.cfg.db.getByIds(table, ids);
+        let dbms = await this.cfg.db.getByIds(table, ids);
+        if (!opt.raw && this.cfg.hooks.afterLoad && dbms.length) {
+            dbms = (await (0, js_lib_1.pMap)(dbms, async (dbm) => await this.cfg.hooks.afterLoad(dbm))).filter(js_lib_1._isTruthy);
+        }
         this.logResult(started, op, dbms, table);
         return dbms;
     }
@@ -273,8 +294,11 @@ class CommonDao {
         q.table = opt.table || q.table;
         const op = `runQuery(${q.pretty()})`;
         const started = this.logStarted(op, q.table);
-        const { rows, ...queryResult } = await this.cfg.db.runQuery(q, opt);
+        let { rows, ...queryResult } = await this.cfg.db.runQuery(q, opt);
         const partialQuery = !!q._selectedFieldNames;
+        if (!opt.raw && this.cfg.hooks.afterLoad && rows.length) {
+            rows = (await (0, js_lib_1.pMap)(rows, async (dbm) => await this.cfg.hooks.afterLoad(dbm))).filter(js_lib_1._isTruthy);
+        }
         const bms = partialQuery || opt.raw ? rows : await this.dbmsToBM(rows, opt);
         this.logResult(started, op, bms, q.table);
         return {
@@ -290,7 +314,10 @@ class CommonDao {
         q.table = opt.table || q.table;
         const op = `runQueryAsDBM(${q.pretty()})`;
         const started = this.logStarted(op, q.table);
-        const { rows, ...queryResult } = await this.cfg.db.runQuery(q, opt);
+        let { rows, ...queryResult } = await this.cfg.db.runQuery(q, opt);
+        if (!opt.raw && this.cfg.hooks.afterLoad && rows.length) {
+            rows = (await (0, js_lib_1.pMap)(rows, async (dbm) => await this.cfg.hooks.afterLoad(dbm))).filter(js_lib_1._isTruthy);
+        }
         const partialQuery = !!q._selectedFieldNames;
         const dbms = partialQuery || opt.raw ? rows : this.anyToDBMs(rows, opt);
         this.logResult(started, op, dbms, q.table);
@@ -304,7 +331,10 @@ class CommonDao {
         q.table = opt.table || q.table;
         const op = `runQueryAsTM(${q.pretty()})`;
         const started = this.logStarted(op, q.table);
-        const { rows, ...queryResult } = await this.cfg.db.runQuery(q, opt);
+        let { rows, ...queryResult } = await this.cfg.db.runQuery(q, opt);
+        if (!opt.raw && this.cfg.hooks.afterLoad && rows.length) {
+            rows = (await (0, js_lib_1.pMap)(rows, async (dbm) => await this.cfg.hooks.afterLoad(dbm))).filter(js_lib_1._isTruthy);
+        }
         const partialQuery = !!q._selectedFieldNames;
         const tms = partialQuery || opt.raw ? rows : this.bmsToTM(await this.dbmsToBM(rows, opt), opt);
         this.logResult(started, op, tms, q.table);
@@ -334,11 +364,16 @@ class CommonDao {
         let count = 0;
         await (0, nodejs_lib_1._pipeline)([
             this.cfg.db.streamQuery(q, opt),
-            // optimization: 1 validation is enough
-            // transformMap<any, DBM>(dbm => (partialQuery || opt.raw ? dbm : this.anyToDBM(dbm, opt)), opt),
             (0, nodejs_lib_1.transformMap)(async (dbm) => {
                 count++;
-                return partialQuery || opt.raw ? dbm : await this.dbmToBM(dbm, opt);
+                if (partialQuery || opt.raw)
+                    return dbm;
+                if (this.cfg.hooks.afterLoad) {
+                    dbm = (await this.cfg.hooks.afterLoad(dbm));
+                    if (dbm === null)
+                        return js_lib_1.SKIP;
+                }
+                return await this.dbmToBM(dbm, opt);
             }, {
                 errorMode: opt.errorMode,
             }),
@@ -368,9 +403,16 @@ class CommonDao {
         let count = 0;
         await (0, nodejs_lib_1._pipeline)([
             this.cfg.db.streamQuery(q, opt),
-            (0, nodejs_lib_1.transformMapSync)(dbm => {
+            (0, nodejs_lib_1.transformMap)(async (dbm) => {
                 count++;
-                return partialQuery || opt.raw ? dbm : this.anyToDBM(dbm, opt);
+                if (partialQuery || opt.raw)
+                    return dbm;
+                if (this.cfg.hooks.afterLoad) {
+                    dbm = (await this.cfg.hooks.afterLoad(dbm));
+                    if (dbm === null)
+                        return js_lib_1.SKIP;
+                }
+                return this.anyToDBM(dbm, opt);
             }, {
                 errorMode: opt.errorMode,
             }),
@@ -403,8 +445,15 @@ class CommonDao {
             return stream;
         return stream
             .on('error', err => stream.emit('error', err))
-            .pipe((0, nodejs_lib_1.transformMapSimple)(dbm => this.anyToDBM(dbm, opt), {
-            errorMode: js_lib_1.ErrorMode.SUPPRESS, // cause .pipe() cannot propagate errors
+            .pipe((0, nodejs_lib_1.transformMap)(async (dbm) => {
+            if (this.cfg.hooks.afterLoad) {
+                dbm = (await this.cfg.hooks.afterLoad(dbm));
+                if (dbm === null)
+                    return js_lib_1.SKIP;
+            }
+            return this.anyToDBM(dbm, opt);
+        }, {
+            errorMode: opt.errorMode,
         }));
     }
     /**
@@ -430,8 +479,15 @@ class CommonDao {
             // .pipe(transformMap<any, DBM>(dbm => this.anyToDBM(dbm, opt), safeOpt))
             // .pipe(transformMap<DBM, Saved<BM>>(dbm => this.dbmToBM(dbm, opt), safeOpt))
             .on('error', err => stream.emit('error', err))
-            .pipe((0, nodejs_lib_1.transformMap)(async (dbm) => await this.dbmToBM(dbm, opt), {
-            errorMode: js_lib_1.ErrorMode.SUPPRESS, // cause .pipe() cannot propagate errors
+            .pipe((0, nodejs_lib_1.transformMap)(async (dbm) => {
+            if (this.cfg.hooks.afterLoad) {
+                dbm = (await this.cfg.hooks.afterLoad(dbm));
+                if (dbm === null)
+                    return js_lib_1.SKIP;
+            }
+            return await this.dbmToBM(dbm, opt);
+        }, {
+            errorMode: opt.errorMode,
         }))
         // this can make the stream async-iteration-friendly
         // but not applying it now for perf reasons
@@ -462,8 +518,10 @@ class CommonDao {
         let count = 0;
         await (0, nodejs_lib_1._pipeline)([
             this.cfg.db.streamQuery(q.select(['id']), opt),
-            (0, nodejs_lib_1.transformMapSimple)(objectWithId => objectWithId.id),
-            (0, nodejs_lib_1.transformTap)(() => count++),
+            (0, nodejs_lib_1.transformMapSimple)(objectWithId => {
+                count++;
+                return objectWithId.id;
+            }),
             (0, nodejs_lib_1.transformMap)(mapper, {
                 ...opt,
                 predicate: js_lib_1._passthroughPredicate,
@@ -503,8 +561,14 @@ class CommonDao {
         this.requireWriteAccess();
         const idWasGenerated = !bm.id && this.cfg.createId;
         this.assignIdCreatedUpdated(bm, opt); // mutates
-        const dbm = await this.bmToDBM(bm, opt);
+        let dbm = await this.bmToDBM(bm, opt);
+        if (this.cfg.hooks.beforeSave) {
+            dbm = (await this.cfg.hooks.beforeSave(dbm));
+            if (dbm === null && !opt.tx)
+                return bm;
+        }
         if (opt.tx) {
+            // May return `null`, in which case it'll be skipped
             return dbm;
         }
         const table = opt.table || this.cfg.table;
@@ -570,6 +634,11 @@ class CommonDao {
         const started = this.logSaveStarted(op, row, table);
         const { excludeFromIndexes } = this.cfg;
         const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds;
+        if (this.cfg.hooks.beforeSave) {
+            row = (await this.cfg.hooks.beforeSave(row));
+            if (row === null)
+                return dbm;
+        }
         await this.cfg.db.saveBatch(table, [row], {
             excludeFromIndexes,
             assignGeneratedIds,
@@ -582,10 +651,15 @@ class CommonDao {
         return row;
     }
     async saveBatch(bms, opt = {}) {
+        if (!bms.length)
+            return [];
         this.requireWriteAccess();
         const table = opt.table || this.cfg.table;
         bms.forEach(bm => this.assignIdCreatedUpdated(bm, opt));
-        const dbms = await this.bmsToDBM(bms, opt);
+        let dbms = await this.bmsToDBM(bms, opt);
+        if (this.cfg.hooks.beforeSave && dbms.length) {
+            dbms = (await (0, js_lib_1.pMap)(dbms, async (dbm) => await this.cfg.hooks.beforeSave(dbm))).filter(js_lib_1._isTruthy);
+        }
         if (opt.tx) {
             return dbms;
         }
@@ -613,6 +687,8 @@ class CommonDao {
         return bms;
     }
     async saveBatchAsDBM(dbms, opt = {}) {
+        if (!dbms.length)
+            return [];
         this.requireWriteAccess();
         const table = opt.table || this.cfg.table;
         let rows = dbms;
@@ -632,6 +708,9 @@ class CommonDao {
         const started = this.logSaveStarted(op, rows, table);
         const { excludeFromIndexes } = this.cfg;
         const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds;
+        if (this.cfg.hooks.beforeSave && rows.length) {
+            rows = (await (0, js_lib_1.pMap)(rows, async (row) => await this.cfg.hooks.beforeSave(row))).filter(js_lib_1._isTruthy);
+        }
         await this.cfg.db.saveBatch(table, rows, {
             excludeFromIndexes,
             assignGeneratedIds,
@@ -656,6 +735,8 @@ class CommonDao {
         return count;
     }
     async deleteByIds(ids, opt = {}) {
+        if (!ids.length)
+            return 0;
         this.requireWriteAccess();
         this.requireObjectMutability(opt);
         const op = `deleteByIds(${ids.join(', ')})`;
@@ -710,6 +791,8 @@ class CommonDao {
         return await this.updateByQuery(this.query().filterEq('id', id), patch, opt);
     }
     async updateByIds(ids, patch, opt = {}) {
+        if (!ids.length)
+            return 0;
         return await this.updateByQuery(this.query().filterIn('id', ids), patch, opt);
     }
     async updateByQuery(q, patch, opt = {}) {
@@ -790,22 +873,6 @@ class CommonDao {
         // try/catch?
         return bms.map(bm => this.bmToTM(bm, opt));
     }
-    tmToBM(tm, opt = {}) {
-        if (!tm)
-            return;
-        // optimization: 1 validation is enough
-        // Validate/convert TM
-        // bm gets assigned to the new reference
-        // tm = this.validateAndConvert(tm, this.cfg.tmSchema, DBModelType.TM, opt)
-        // TM > BM
-        const bm = this.cfg.hooks.beforeTMToBM(tm);
-        // Validate/convert BM
-        return this.validateAndConvert(bm, this.cfg.bmSchema, db_model_1.DBModelType.BM, opt);
-    }
-    tmsToBM(tms, opt = {}) {
-        // try/catch?
-        return tms.map(tm => this.tmToBM(tm, opt));
-    }
     /**
      * Returns *converted value*.
      * Validates (unless `skipValidation=true` passed).

package/dist/commondao/common.dao.model.d.ts

@@ -1,21 +1,82 @@
-import { CommonLogger, ErrorMode, ObjectWithId, Saved, ZodError, ZodSchema } from '@naturalcycles/js-lib';
+import { CommonLogger, ErrorMode, ObjectWithId, Promisable, Saved, ZodError, ZodSchema } from '@naturalcycles/js-lib';
 import { AjvSchema, AjvValidationError, JoiValidationError, ObjectSchemaTyped, TransformLogProgressOptions, TransformMapOptions } from '@naturalcycles/nodejs-lib';
 import { CommonDB } from '../common.db';
 import { CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions } from '../db.model';
 export interface CommonDaoHooks<BM extends Partial<ObjectWithId<ID>>, DBM extends ObjectWithId<ID>, TM, ID extends string | number> {
+    /**
+     * Allows to override the id generation function.
+     * By default it uses `stringId` from nodejs-lib
+     * (which uses lowercase alphanumberic alphabet and the size of 16).
+     */
     createRandomId: () => ID;
     /**
      * createNaturalId hook is called (tried) first.
      * If it doesn't exist - createRandomId is called.
      */
     createNaturalId: (obj: DBM | BM) => ID;
+    /**
+     * It's a counter-part of `createNaturalId`.
+     * Allows to provide a parser function to parse "natural id" into
+     * DBM components (e.g accountId and some other property that is part of the id).
+     */
     parseNaturalId: (id: ID) => Partial<DBM>;
+    /**
+     * It is called only on `dao.create` method.
+     * Dao.create method is called in:
+     *
+     * - getByIdOrEmpty, getByIdAsDBMOrEmpty
+     * - patch, patchAsDBM
+     */
     beforeCreate: (bm: Partial<BM>) => Partial<BM>;
+    /**
+     * Called when loading things "as DBM" and validation is not skipped.
+     * When loading things as BM/TM - other hooks get involved instead:
+     * - beforeDBMToBM
+     * - beforeBMToTM
+     *
+     * TODO: maybe rename those to `validateAs(model)`
+     * as it only validates "final state", not intermediate
+     */
     beforeDBMValidate: (dbm: Partial<DBM>) => Partial<DBM>;
     beforeDBMToBM: (dbm: DBM) => Partial<BM> | Promise<Partial<BM>>;
     beforeBMToDBM: (bm: BM) => Partial<DBM> | Promise<Partial<DBM>>;
-    beforeTMToBM: (tm: TM) => Partial<BM>;
     beforeBMToTM: (bm: BM) => Partial<TM>;
+    /**
+     * Allows to access the DBM just after it has been loaded from the DB.
+     *
+     * Normally does nothing.
+     *
+     * You can change the DBM as you want here: ok to mutate or not, but you need to return the DBM
+     * to pass it further.
+     *
+     * You can return `null` to make it look "not found".
+     *
+     * You can do validations as needed here and throw errors, they will be propagated.
+     */
+    afterLoad?: (dbm: DBM) => Promisable<DBM | null>;
+    /**
+     * Allows to access the DBM just before it's supposed to be saved to the DB.
+     *
+     * Normally does nothing.
+     *
+     * You can change the DBM as you want here: ok to mutate or not, but you need to return the DBM
+     * to pass it further.
+     *
+     * You can return `null` to prevent it from being saved, without throwing an error.
+     * `.save` method will then return the BM/DBM as it has entered the method (it **won't** return the null value!).
+     *
+     * You can do validations as needed here and throw errors, they will be propagated.
+     */
+    beforeSave?: (dbm: DBM) => Promisable<DBM | null>;
+    /**
+     * Called in:
+     * - dbmToBM (applied before DBM becomes BM)
+     * - anyToDBM
+     *
+     * Hook only allows to apply anonymization to DBM (not to BM).
+     * It still applies to BM "transitively", during dbmToBM
+     * (e.g after loaded from the Database).
+     */
     anonymize: (dbm: DBM) => DBM;
     /**
      * If hook is defined - allows to prevent or modify the error thrown.

package/package.json

@@ -41,7 +41,7 @@
   "engines": {
     "node": ">=18.12"
   },
-  "version": "8.52.0",
+  "version": "8.54.0",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

package/src/commondao/common.dao.model.ts

@@ -2,6 +2,7 @@ import {
   CommonLogger,
   ErrorMode,
   ObjectWithId,
+  Promisable,
   Saved,
   ZodError,
   ZodSchema,
@@ -23,19 +24,88 @@ export interface CommonDaoHooks<
   TM,
   ID extends string | number,
 > {
+  /**
+   * Allows to override the id generation function.
+   * By default it uses `stringId` from nodejs-lib
+   * (which uses lowercase alphanumberic alphabet and the size of 16).
+   */
   createRandomId: () => ID
+
   /**
    * createNaturalId hook is called (tried) first.
    * If it doesn't exist - createRandomId is called.
    */
   createNaturalId: (obj: DBM | BM) => ID
+
+  /**
+   * It's a counter-part of `createNaturalId`.
+   * Allows to provide a parser function to parse "natural id" into
+   * DBM components (e.g accountId and some other property that is part of the id).
+   */
   parseNaturalId: (id: ID) => Partial<DBM>
+
+  /**
+   * It is called only on `dao.create` method.
+   * Dao.create method is called in:
+   *
+   * - getByIdOrEmpty, getByIdAsDBMOrEmpty
+   * - patch, patchAsDBM
+   */
   beforeCreate: (bm: Partial<BM>) => Partial<BM>
+
+  /**
+   * Called when loading things "as DBM" and validation is not skipped.
+   * When loading things as BM/TM - other hooks get involved instead:
+   * - beforeDBMToBM
+   * - beforeBMToTM
+   *
+   * TODO: maybe rename those to `validateAs(model)`
+   * as it only validates "final state", not intermediate
+   */
   beforeDBMValidate: (dbm: Partial<DBM>) => Partial<DBM>
+
   beforeDBMToBM: (dbm: DBM) => Partial<BM> | Promise<Partial<BM>>
   beforeBMToDBM: (bm: BM) => Partial<DBM> | Promise<Partial<DBM>>
-  beforeTMToBM: (tm: TM) => Partial<BM>
   beforeBMToTM: (bm: BM) => Partial<TM>
+
+  /**
+   * Allows to access the DBM just after it has been loaded from the DB.
+   *
+   * Normally does nothing.
+   *
+   * You can change the DBM as you want here: ok to mutate or not, but you need to return the DBM
+   * to pass it further.
+   *
+   * You can return `null` to make it look "not found".
+   *
+   * You can do validations as needed here and throw errors, they will be propagated.
+   */
+  afterLoad?: (dbm: DBM) => Promisable<DBM | null>
+
+  /**
+   * Allows to access the DBM just before it's supposed to be saved to the DB.
+   *
+   * Normally does nothing.
+   *
+   * You can change the DBM as you want here: ok to mutate or not, but you need to return the DBM
+   * to pass it further.
+   *
+   * You can return `null` to prevent it from being saved, without throwing an error.
+   * `.save` method will then return the BM/DBM as it has entered the method (it **won't** return the null value!).
+   *
+   * You can do validations as needed here and throw errors, they will be propagated.
+   */
+  beforeSave?: (dbm: DBM) => Promisable<DBM | null>
+
+  /**
+   * Called in:
+   * - dbmToBM (applied before DBM becomes BM)
+   * - anyToDBM
+   *
+   * Hook only allows to apply anonymization to DBM (not to BM).
+   * It still applies to BM "transitively", during dbmToBM
+   * (e.g after loaded from the Database).
+   */
   anonymize: (dbm: DBM) => DBM
 
   /**

package/src/commondao/common.dao.ts

@@ -17,6 +17,8 @@ import {
   pMap,
   Promisable,
   Saved,
+  SKIP,
+  UnixTimestampMillisNumber,
   Unsaved,
   ZodSchema,
   ZodValidationError,
@@ -35,8 +37,6 @@ import {
   transformLogProgress,
   transformMap,
   transformMapSimple,
-  transformMapSync,
-  transformTap,
   writableVoid,
 } from '@naturalcycles/nodejs-lib'
 import { DBLibError } from '../cnst'
@@ -53,6 +53,7 @@ import { DBTransaction } from '../transaction/dbTransaction'
 import {
   CommonDaoCfg,
   CommonDaoCreateOptions,
+  CommonDaoHooks,
   CommonDaoLogLevel,
   CommonDaoOptions,
   CommonDaoSaveOptions,
@@ -95,12 +96,11 @@ export class CommonDao<
         beforeDBMValidate: dbm => dbm,
         beforeDBMToBM: dbm => dbm as any,
         beforeBMToDBM: bm => bm as any,
-        beforeTMToBM: tm => tm as any,
         beforeBMToTM: bm => bm as any,
         anonymize: dbm => dbm,
         onValidationError: err => err,
         ...cfg.hooks,
-      },
+      } satisfies Partial<CommonDaoHooks<BM, DBM, TM, ID>>,
     }
 
     if (this.cfg.createId) {
@@ -132,7 +132,10 @@ export class CommonDao<
     const table = opt.table || this.cfg.table
     const started = this.logStarted(op, table)
 
-    const dbm = (await this.cfg.db.getByIds<DBM>(table, [id]))[0]
+    let dbm = (await this.cfg.db.getByIds<DBM>(table, [id]))[0]
+    if (dbm && !opt.raw && this.cfg.hooks!.afterLoad) {
+      dbm = (await this.cfg.hooks!.afterLoad(dbm)) || undefined
+    }
 
     const bm = opt.raw ? (dbm as any) : await this.dbmToBM(dbm, opt)
     this.logResult(started, op, bm, table)
@@ -162,6 +165,10 @@ export class CommonDao<
     const table = opt.table || this.cfg.table
     const started = this.logStarted(op, table)
     let [dbm] = await this.cfg.db.getByIds<DBM>(table, [id])
+    if (dbm && !opt.raw && this.cfg.hooks!.afterLoad) {
+      dbm = (await this.cfg.hooks!.afterLoad(dbm)) || undefined
+    }
+
     if (!opt.raw) {
       dbm = this.anyToDBM(dbm!, opt)
     }
@@ -176,7 +183,11 @@ export class CommonDao<
     const op = `getByIdAsTM(${id})`
     const table = opt.table || this.cfg.table
     const started = this.logStarted(op, table)
-    const [dbm] = await this.cfg.db.getByIds<DBM>(table, [id])
+    let [dbm] = await this.cfg.db.getByIds<DBM>(table, [id])
+    if (dbm && !opt.raw && this.cfg.hooks!.afterLoad) {
+      dbm = (await this.cfg.hooks!.afterLoad(dbm)) || undefined
+    }
+
     if (opt.raw) {
       this.logResult(started, op, dbm, table)
       return (dbm as any) || null
@@ -188,20 +199,34 @@ export class CommonDao<
   }
 
   async getByIds(ids: ID[], opt: CommonDaoOptions = {}): Promise<Saved<BM>[]> {
+    if (!ids.length) return []
     const op = `getByIds ${ids.length} id(s) (${_truncate(ids.slice(0, 10).join(', '), 50)})`
     const table = opt.table || this.cfg.table
     const started = this.logStarted(op, table)
-    const dbms = await this.cfg.db.getByIds<DBM>(table, ids)
+    let dbms = await this.cfg.db.getByIds<DBM>(table, ids)
+    if (!opt.raw && this.cfg.hooks!.afterLoad && dbms.length) {
+      dbms = (await pMap(dbms, async dbm => await this.cfg.hooks!.afterLoad!(dbm))).filter(
+        _isTruthy,
+      )
+    }
+
     const bms = opt.raw ? (dbms as any) : await this.dbmsToBM(dbms, opt)
     this.logResult(started, op, bms, table)
     return bms
   }
 
   async getByIdsAsDBM(ids: ID[], opt: CommonDaoOptions = {}): Promise<DBM[]> {
+    if (!ids.length) return []
     const op = `getByIdsAsDBM ${ids.length} id(s) (${_truncate(ids.slice(0, 10).join(', '), 50)})`
     const table = opt.table || this.cfg.table
     const started = this.logStarted(op, table)
-    const dbms = await this.cfg.db.getByIds<DBM>(table, ids)
+    let dbms = await this.cfg.db.getByIds<DBM>(table, ids)
+    if (!opt.raw && this.cfg.hooks!.afterLoad && dbms.length) {
+      dbms = (await pMap(dbms, async dbm => await this.cfg.hooks!.afterLoad!(dbm))).filter(
+        _isTruthy,
+      )
+    }
+
     this.logResult(started, op, dbms, table)
     return dbms
   }
@@ -324,8 +349,14 @@ export class CommonDao<
     q.table = opt.table || q.table
     const op = `runQuery(${q.pretty()})`
     const started = this.logStarted(op, q.table)
-    const { rows, ...queryResult } = await this.cfg.db.runQuery<DBM>(q, opt)
+    let { rows, ...queryResult } = await this.cfg.db.runQuery<DBM>(q, opt)
     const partialQuery = !!q._selectedFieldNames
+    if (!opt.raw && this.cfg.hooks!.afterLoad && rows.length) {
+      rows = (await pMap(rows, async dbm => await this.cfg.hooks!.afterLoad!(dbm))).filter(
+        _isTruthy,
+      )
+    }
+
     const bms = partialQuery || opt.raw ? (rows as any[]) : await this.dbmsToBM(rows, opt)
     this.logResult(started, op, bms, q.table)
     return {
@@ -346,7 +377,13 @@ export class CommonDao<
     q.table = opt.table || q.table
     const op = `runQueryAsDBM(${q.pretty()})`
     const started = this.logStarted(op, q.table)
-    const { rows, ...queryResult } = await this.cfg.db.runQuery<DBM>(q, opt)
+    let { rows, ...queryResult } = await this.cfg.db.runQuery<DBM>(q, opt)
+    if (!opt.raw && this.cfg.hooks!.afterLoad && rows.length) {
+      rows = (await pMap(rows, async dbm => await this.cfg.hooks!.afterLoad!(dbm))).filter(
+        _isTruthy,
+      )
+    }
+
     const partialQuery = !!q._selectedFieldNames
     const dbms = partialQuery || opt.raw ? rows : this.anyToDBMs(rows, opt)
     this.logResult(started, op, dbms, q.table)
@@ -365,7 +402,13 @@ export class CommonDao<
     q.table = opt.table || q.table
     const op = `runQueryAsTM(${q.pretty()})`
     const started = this.logStarted(op, q.table)
-    const { rows, ...queryResult } = await this.cfg.db.runQuery<DBM>(q, opt)
+    let { rows, ...queryResult } = await this.cfg.db.runQuery<DBM>(q, opt)
+    if (!opt.raw && this.cfg.hooks!.afterLoad && rows.length) {
+      rows = (await pMap(rows, async dbm => await this.cfg.hooks!.afterLoad!(dbm))).filter(
+        _isTruthy,
+      )
+    }
+
     const partialQuery = !!q._selectedFieldNames
     const tms =
       partialQuery || opt.raw ? (rows as any[]) : this.bmsToTM(await this.dbmsToBM(rows, opt), opt)
@@ -404,12 +447,17 @@ export class CommonDao<
 
     await _pipeline([
       this.cfg.db.streamQuery<DBM>(q, opt),
-      // optimization: 1 validation is enough
-      // transformMap<any, DBM>(dbm => (partialQuery || opt.raw ? dbm : this.anyToDBM(dbm, opt)), opt),
       transformMap<DBM, Saved<BM>>(
         async dbm => {
           count++
-          return partialQuery || opt.raw ? (dbm as any) : await this.dbmToBM(dbm, opt)
+          if (partialQuery || opt.raw) return dbm as any
+
+          if (this.cfg.hooks!.afterLoad) {
+            dbm = (await this.cfg.hooks!.afterLoad(dbm)) as DBM
+            if (dbm === null) return SKIP
+          }
+
+          return await this.dbmToBM(dbm, opt)
         },
         {
           errorMode: opt.errorMode,
@@ -449,10 +497,17 @@ export class CommonDao<
 
     await _pipeline([
       this.cfg.db.streamQuery<any>(q, opt),
-      transformMapSync<any, DBM>(
-        dbm => {
+      transformMap<any, DBM>(
+        async dbm => {
           count++
-          return partialQuery || opt.raw ? dbm : this.anyToDBM(dbm, opt)
+          if (partialQuery || opt.raw) return dbm
+
+          if (this.cfg.hooks!.afterLoad) {
+            dbm = (await this.cfg.hooks!.afterLoad(dbm)) as DBM
+            if (dbm === null) return SKIP
+          }
+
+          return this.anyToDBM(dbm, opt)
         },
         {
           errorMode: opt.errorMode,
@@ -492,9 +547,19 @@ export class CommonDao<
     return stream
       .on('error', err => stream.emit('error', err))
       .pipe(
-        transformMapSimple<any, DBM>(dbm => this.anyToDBM(dbm, opt), {
-          errorMode: ErrorMode.SUPPRESS, // cause .pipe() cannot propagate errors
-        }),
+        transformMap<any, DBM>(
+          async dbm => {
+            if (this.cfg.hooks!.afterLoad) {
+              dbm = (await this.cfg.hooks!.afterLoad(dbm)) as DBM
+              if (dbm === null) return SKIP
+            }
+
+            return this.anyToDBM(dbm, opt)
+          },
+          {
+            errorMode: opt.errorMode,
+          },
+        ),
       )
   }
 
@@ -524,9 +589,19 @@ export class CommonDao<
         // .pipe(transformMap<DBM, Saved<BM>>(dbm => this.dbmToBM(dbm, opt), safeOpt))
         .on('error', err => stream.emit('error', err))
         .pipe(
-          transformMap<DBM, Saved<BM>>(async dbm => await this.dbmToBM(dbm, opt), {
-            errorMode: ErrorMode.SUPPRESS, // cause .pipe() cannot propagate errors
-          }),
+          transformMap<DBM, Saved<BM>>(
+            async dbm => {
+              if (this.cfg.hooks!.afterLoad) {
+                dbm = (await this.cfg.hooks!.afterLoad(dbm)) as DBM
+                if (dbm === null) return SKIP
+              }
+
+              return await this.dbmToBM(dbm, opt)
+            },
+            {
+              errorMode: opt.errorMode,
+            },
+          ),
         )
       // this can make the stream async-iteration-friendly
       // but not applying it now for perf reasons
@@ -570,8 +645,10 @@ export class CommonDao<
 
     await _pipeline([
       this.cfg.db.streamQuery<DBM>(q.select(['id']), opt),
-      transformMapSimple<DBM, ID>(objectWithId => objectWithId.id),
-      transformTap(() => count++),
+      transformMapSimple<DBM, ID>(objectWithId => {
+        count++
+        return objectWithId.id
+      }),
       transformMap<ID, void>(mapper, {
         ...opt,
         predicate: _passthroughPredicate,
@@ -619,8 +696,10 @@ export class CommonDao<
     save: async (
       bm: Unsaved<BM>,
       opt: CommonDaoSaveOptions<DBM> = {},
-    ): Promise<DBSaveBatchOperation> => {
-      const row: DBM = (await this.save(bm, { ...opt, tx: true })) as any
+    ): Promise<DBSaveBatchOperation | undefined> => {
+      // .save actually returns DBM (not BM) when it detects `opt.tx === true`
+      const row: DBM | null = (await this.save(bm, { ...opt, tx: true })) as any
+      if (row === null) return
 
       return {
         type: 'saveBatch',
@@ -636,8 +715,8 @@ export class CommonDao<
       bms: Unsaved<BM>[],
       opt: CommonDaoSaveOptions<DBM> = {},
     ): Promise<DBSaveBatchOperation | undefined> => {
-      if (!bms.length) return
       const rows: DBM[] = (await this.saveBatch(bms, { ...opt, tx: true })) as any
+      if (!rows.length) return
 
       return {
         type: 'saveBatch',
@@ -683,9 +762,15 @@ export class CommonDao<
     this.requireWriteAccess()
     const idWasGenerated = !bm.id && this.cfg.createId
     this.assignIdCreatedUpdated(bm, opt) // mutates
-    const dbm = await this.bmToDBM(bm as BM, opt)
+    let dbm = await this.bmToDBM(bm as BM, opt)
+
+    if (this.cfg.hooks!.beforeSave) {
+      dbm = (await this.cfg.hooks!.beforeSave(dbm)) as DBM
+      if (dbm === null && !opt.tx) return bm as any
+    }
 
     if (opt.tx) {
+      // May return `null`, in which case it'll be skipped
       return dbm as any
     }
 
@@ -698,6 +783,7 @@ export class CommonDao<
     const started = this.logSaveStarted(op, bm, table)
     const { excludeFromIndexes } = this.cfg
     const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds
+
     await this.cfg.db.saveBatch(table, [dbm], {
       excludeFromIndexes,
       assignGeneratedIds,
@@ -764,6 +850,12 @@ export class CommonDao<
     const started = this.logSaveStarted(op, row, table)
     const { excludeFromIndexes } = this.cfg
     const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds
+
+    if (this.cfg.hooks!.beforeSave) {
+      row = (await this.cfg.hooks!.beforeSave(row)) as DBM
+      if (row === null) return dbm
+    }
+
     await this.cfg.db.saveBatch(table, [row], {
       excludeFromIndexes,
       assignGeneratedIds,
@@ -779,10 +871,17 @@ export class CommonDao<
   }
 
   async saveBatch(bms: Unsaved<BM>[], opt: CommonDaoSaveOptions<DBM> = {}): Promise<Saved<BM>[]> {
+    if (!bms.length) return []
     this.requireWriteAccess()
     const table = opt.table || this.cfg.table
     bms.forEach(bm => this.assignIdCreatedUpdated(bm, opt))
-    const dbms = await this.bmsToDBM(bms as BM[], opt)
+    let dbms = await this.bmsToDBM(bms as BM[], opt)
+
+    if (this.cfg.hooks!.beforeSave && dbms.length) {
+      dbms = (await pMap(dbms, async dbm => await this.cfg.hooks!.beforeSave!(dbm))).filter(
+        _isTruthy,
+      )
+    }
 
     if (opt.tx) {
       return dbms as any
@@ -803,6 +902,7 @@ export class CommonDao<
     const started = this.logSaveStarted(op, bms, table)
     const { excludeFromIndexes } = this.cfg
     const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds
+
     await this.cfg.db.saveBatch(table, dbms, {
       excludeFromIndexes,
       assignGeneratedIds,
@@ -819,6 +919,7 @@ export class CommonDao<
   }
 
   async saveBatchAsDBM(dbms: DBM[], opt: CommonDaoSaveOptions<DBM> = {}): Promise<DBM[]> {
+    if (!dbms.length) return []
     this.requireWriteAccess()
     const table = opt.table || this.cfg.table
     let rows = dbms
@@ -841,6 +942,12 @@ export class CommonDao<
     const { excludeFromIndexes } = this.cfg
     const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds
 
+    if (this.cfg.hooks!.beforeSave && rows.length) {
+      rows = (await pMap(rows, async row => await this.cfg.hooks!.beforeSave!(row))).filter(
+        _isTruthy,
+      )
+    }
+
     await this.cfg.db.saveBatch(table, rows, {
       excludeFromIndexes,
       assignGeneratedIds,
@@ -874,6 +981,7 @@ export class CommonDao<
   }
 
   async deleteByIds(ids: ID[], opt: CommonDaoOptions = {}): Promise<number> {
+    if (!ids.length) return 0
     this.requireWriteAccess()
     this.requireObjectMutability(opt)
     const op = `deleteByIds(${ids.join(', ')})`
@@ -942,6 +1050,7 @@ export class CommonDao<
   }
 
   async updateByIds(ids: ID[], patch: DBPatch<DBM>, opt: CommonDaoOptions = {}): Promise<number> {
+    if (!ids.length) return 0
     return await this.updateByQuery(this.query().filterIn('id', ids), patch, opt)
   }
 
@@ -1061,28 +1170,6 @@ export class CommonDao<
     return bms.map(bm => this.bmToTM(bm, opt))
   }
 
-  tmToBM(tm: undefined, opt?: CommonDaoOptions): undefined
-  tmToBM(tm?: TM, opt?: CommonDaoOptions): BM
-  tmToBM(tm?: TM, opt: CommonDaoOptions = {}): BM | undefined {
-    if (!tm) return
-
-    // optimization: 1 validation is enough
-    // Validate/convert TM
-    // bm gets assigned to the new reference
-    // tm = this.validateAndConvert(tm, this.cfg.tmSchema, DBModelType.TM, opt)
-
-    // TM > BM
-    const bm = this.cfg.hooks!.beforeTMToBM!(tm) as BM
-
-    // Validate/convert BM
-    return this.validateAndConvert<BM>(bm, this.cfg.bmSchema, DBModelType.BM, opt)
-  }
-
-  tmsToBM(tms: TM[], opt: CommonDaoOptions = {}): BM[] {
-    // try/catch?
-    return tms.map(tm => this.tmToBM(tm, opt))
-  }
-
   /**
    * Returns *converted value*.
    * Validates (unless `skipValidation=true` passed).
@@ -1210,14 +1297,14 @@ export class CommonDao<
     this.cfg.logger?.log(`<< ${table}.${op} in ${_since(started)}`)
   }
 
-  protected logStarted(op: string, table: string, force = false): number {
+  protected logStarted(op: string, table: string, force = false): UnixTimestampMillisNumber {
     if (this.cfg.logStarted || force) {
       this.cfg.logger?.log(`>> ${table}.${op}`)
     }
     return Date.now()
   }
 
-  protected logSaveStarted(op: string, items: any, table: string): number {
+  protected logSaveStarted(op: string, items: any, table: string): UnixTimestampMillisNumber {
     if (this.cfg.logStarted) {
       const args: any[] = [`>> ${table}.${op}`]
       if (Array.isArray(items)) {

package/src/db.model.ts

@@ -10,7 +10,6 @@ import { ObjectWithId } from '@naturalcycles/js-lib'
  */
 export type CommonDBSaveMethod = 'upsert' | 'insert' | 'update'
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface CommonDBOptions {}
 
 /**