@naturalcycles/db-lib 10.20.3 → 10.21.0

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

@@ -158,10 +158,10 @@ export declare class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity
      * Proxy to this.cfg.db.ping
      */
     ping(): Promise<void>;
-    withId(id: ID): DaoWithId<typeof this>;
-    withIds(ids: ID[]): DaoWithIds<typeof this>;
-    withRowsToSave(rows: Unsaved<BM>[]): DaoWithRows<typeof this>;
-    withRowToSave(row: Unsaved<BM>, opt?: DaoWithRowOptions<BM>): DaoWithRow<typeof this>;
+    withId(id: ID): DaoWithId<CommonDao<BM, DBM, ID>>;
+    withIds(ids: ID[]): DaoWithIds<CommonDao<BM, DBM, ID>>;
+    withRowsToSave(rows: Unsaved<BM>[]): DaoWithRows<CommonDao<BM, DBM, ID>>;
+    withRowToSave(row: Unsaved<BM>, opt?: DaoWithRowOptions<BM>): DaoWithRow<CommonDao<BM, DBM, ID>>;
     /**
      * Load rows (by their ids) from Multiple tables at once.
      * An optimized way to load data, minimizing DB round-trips.
@@ -177,8 +177,8 @@ export declare class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity
     /**
      * Very @experimental.
      */
-    static multiDeleteByIds(inputs: DaoWithIds<any>[], _opt?: CommonDaoOptions): Promise<NonNegativeInteger>;
-    static multiSave(inputs: (DaoWithRows<any> | DaoWithRow<any>)[], opt?: CommonDaoSaveBatchOptions<any>): Promise<void>;
+    static multiDeleteByIds(inputs: DaoWithIds<AnyDao>[], _opt?: CommonDaoOptions): Promise<NonNegativeInteger>;
+    static multiSave(inputs: (DaoWithRows<AnyDao> | DaoWithRow<AnyDao>)[], opt?: CommonDaoSaveBatchOptions<any>): Promise<void>;
     createTransaction(opt?: CommonDBTransactionOptions): Promise<CommonDaoTransaction>;
     runInTransaction<T = void>(fn: CommonDaoTransactionFn<T>, opt?: CommonDBTransactionOptions): Promise<T>;
     private ensureRequired;

package/dist/commondao/common.dao.js

@@ -6,7 +6,7 @@ import { _deepJsonEquals } from '@naturalcycles/js-lib/object/deepEquals.js';
 import { _filterUndefinedValues, _objectAssignExact, } from '@naturalcycles/js-lib/object/object.util.js';
 import { pMap } from '@naturalcycles/js-lib/promise/pMap.js';
 import { _stringMapEntries, _stringMapValues, } from '@naturalcycles/js-lib/types';
-import { _passthroughPredicate, _typeCast, SKIP } from '@naturalcycles/js-lib/types';
+import { _passthroughPredicate, _typeCast } from '@naturalcycles/js-lib/types';
 import { stringId } from '@naturalcycles/nodejs-lib';
 import { transformFlatten, transformMapSync, } from '@naturalcycles/nodejs-lib/stream';
 import { _pipeline, transformChunk, transformLogProgress, transformMap, transformNoOp, writableVoid, } from '@naturalcycles/nodejs-lib/stream';
@@ -454,12 +454,8 @@ export class CommonDao {
         }
         this.assignIdCreatedUpdated(bm, opt); // mutates
         _typeCast(bm);
-        let dbm = await this.bmToDBM(bm, opt); // validates BM
-        if (this.cfg.hooks.beforeSave) {
-            dbm = (await this.cfg.hooks.beforeSave(dbm));
-            if (dbm === null)
-                return bm;
-        }
+        const dbm = await this.bmToDBM(bm, opt); // validates BM
+        this.cfg.hooks.beforeSave?.(dbm);
         const table = opt.table || this.cfg.table;
         const saveOptions = this.prepareSaveOptions(opt);
         await (opt.tx || this.cfg.db).saveBatch(table, [dbm], saveOptions);
@@ -471,12 +467,8 @@ export class CommonDao {
     async saveAsDBM(dbm, opt = {}) {
         this.requireWriteAccess();
         this.assignIdCreatedUpdated(dbm, opt); // mutates
-        let row = this.anyToDBM(dbm, opt);
-        if (this.cfg.hooks.beforeSave) {
-            row = (await this.cfg.hooks.beforeSave(row));
-            if (row === null)
-                return dbm;
-        }
+        const row = this.anyToDBM(dbm, opt);
+        this.cfg.hooks.beforeSave?.(row);
         const table = opt.table || this.cfg.table;
         const saveOptions = this.prepareSaveOptions(opt);
         await (opt.tx || this.cfg.db).saveBatch(table, [row], saveOptions);
@@ -490,9 +482,9 @@ export class CommonDao {
             return [];
         this.requireWriteAccess();
         bms.forEach(bm => this.assignIdCreatedUpdated(bm, opt));
-        let dbms = await this.bmsToDBM(bms, opt);
-        if (this.cfg.hooks.beforeSave && dbms.length) {
-            dbms = (await pMap(dbms, async (dbm) => await this.cfg.hooks.beforeSave(dbm))).filter(_isTruthy);
+        const dbms = await this.bmsToDBM(bms, opt);
+        if (this.cfg.hooks.beforeSave) {
+            dbms.forEach(dbm => this.cfg.hooks.beforeSave(dbm));
         }
         const table = opt.table || this.cfg.table;
         const saveOptions = this.prepareSaveOptions(opt);
@@ -507,9 +499,9 @@ export class CommonDao {
             return [];
         this.requireWriteAccess();
         dbms.forEach(dbm => this.assignIdCreatedUpdated(dbm, opt));
-        let rows = this.anyToDBMs(dbms, opt);
-        if (this.cfg.hooks.beforeSave && rows.length) {
-            rows = (await pMap(rows, async (row) => await this.cfg.hooks.beforeSave(row))).filter(_isTruthy);
+        const rows = this.anyToDBMs(dbms, opt);
+        if (this.cfg.hooks.beforeSave) {
+            rows.forEach(row => this.cfg.hooks.beforeSave(row));
         }
         const table = opt.table || this.cfg.table;
         const saveOptions = this.prepareSaveOptions(opt);
@@ -550,13 +542,9 @@ export class CommonDao {
         const { chunkSize = 500, chunkConcurrency = 32, errorMode } = opt;
         return [
             transformMap(async (bm) => {
-                this.assignIdCreatedUpdated(bm, opt); // mutates
-                let dbm = await this.bmToDBM(bm, opt);
-                if (beforeSave) {
-                    dbm = (await beforeSave(dbm));
-                    if (dbm === null)
-                        return SKIP;
-                }
+                this.assignIdCreatedUpdated(bm, opt);
+                const dbm = await this.bmToDBM(bm, opt);
+                beforeSave?.(dbm);
                 return dbm;
             }, {
                 errorMode,
@@ -901,12 +889,18 @@ export class CommonDao {
                     }
                 }
                 dao.assignIdCreatedUpdated(row, opt);
-                dbmsByTable[table].push(await dao.bmToDBM(row, opt));
+                const dbm = await dao.bmToDBM(row, opt);
+                dao.cfg.hooks.beforeSave?.(dbm);
+                dbmsByTable[table].push(dbm);
             }
             else {
                 // Plural
                 input.rows.forEach(bm => dao.assignIdCreatedUpdated(bm, opt));
-                dbmsByTable[table].push(...(await dao.bmsToDBM(input.rows, opt)));
+                const dbms = await dao.bmsToDBM(input.rows, opt);
+                if (dao.cfg.hooks.beforeSave) {
+                    dbms.forEach(dbm => dao.cfg.hooks.beforeSave(dbm));
+                }
+                dbmsByTable[table].push(...dbms);
             }
         });
         await db.multiSave(dbmsByTable);

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

@@ -1,11 +1,11 @@
 import type { ValidationFunction } from '@naturalcycles/js-lib';
 import type { AppError, ErrorMode } from '@naturalcycles/js-lib/error';
 import type { CommonLogger } from '@naturalcycles/js-lib/log';
-import type { BaseDBEntity, Promisable, UnixTimestamp } from '@naturalcycles/js-lib/types';
+import type { BaseDBEntity, UnixTimestamp } from '@naturalcycles/js-lib/types';
 import type { TransformLogProgressOptions, TransformMapOptions } from '@naturalcycles/nodejs-lib/stream';
 import type { CommonDB } from '../commondb/common.db.js';
 import type { CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions } from '../db.model.js';
-export interface CommonDaoHooks<BM extends BaseDBEntity, DBM extends BaseDBEntity, ID = BM['id']> {
+export interface CommonDaoHooks<BM extends BaseDBEntity, DBM extends BaseDBEntity, ID extends string = BM['id']> {
     /**
      * Allows to override the id generation function.
      * By default it uses `stringId` from nodejs-lib
@@ -50,15 +50,10 @@ export interface CommonDaoHooks<BM extends BaseDBEntity, DBM extends BaseDBEntit
      *
      * 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.
+     * Or, you can mutate the DBM if needed.
      */
-    beforeSave?: (dbm: DBM) => Promisable<DBM | null>;
+    beforeSave?: (dbm: DBM) => void;
     /**
      * Called in:
      * - dbmToBM (applied before DBM becomes BM)
@@ -95,7 +90,7 @@ export declare enum CommonDaoLogLevel {
      */
     DATA_FULL = 30
 }
-export interface CommonDaoCfg<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM, ID = BM['id']> {
+export interface CommonDaoCfg<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM, ID extends string = BM['id']> {
     db: CommonDB;
     table: string;
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/db-lib",
   "type": "module",
-  "version": "10.20.3",
+  "version": "10.21.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@naturalcycles/nodejs-lib": "^15"

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

@@ -1,7 +1,7 @@
 import type { ValidationFunction } from '@naturalcycles/js-lib'
 import type { AppError, ErrorMode } from '@naturalcycles/js-lib/error'
 import type { CommonLogger } from '@naturalcycles/js-lib/log'
-import type { BaseDBEntity, Promisable, UnixTimestamp } from '@naturalcycles/js-lib/types'
+import type { BaseDBEntity, UnixTimestamp } from '@naturalcycles/js-lib/types'
 import type {
   TransformLogProgressOptions,
   TransformMapOptions,
@@ -9,7 +9,11 @@ import type {
 import type { CommonDB } from '../commondb/common.db.js'
 import type { CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions } from '../db.model.js'
 
-export interface CommonDaoHooks<BM extends BaseDBEntity, DBM extends BaseDBEntity, ID = BM['id']> {
+export interface CommonDaoHooks<
+  BM extends BaseDBEntity,
+  DBM extends BaseDBEntity,
+  ID extends string = BM['id'],
+> {
   /**
    * Allows to override the id generation function.
    * By default it uses `stringId` from nodejs-lib
@@ -61,15 +65,10 @@ export interface CommonDaoHooks<BM extends BaseDBEntity, DBM extends BaseDBEntit
    *
    * 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.
+   * Or, you can mutate the DBM if needed.
    */
-  beforeSave?: (dbm: DBM) => Promisable<DBM | null>
+  beforeSave?: (dbm: DBM) => void
 
   /**
    * Called in:
@@ -113,7 +112,7 @@ export enum CommonDaoLogLevel {
 export interface CommonDaoCfg<
   BM extends BaseDBEntity,
   DBM extends BaseDBEntity = BM,
-  ID = BM['id'],
+  ID extends string = BM['id'],
 > {
   db: CommonDB
   table: string

package/src/commondao/common.dao.ts

@@ -20,7 +20,7 @@ import {
   type StringMap,
   type Unsaved,
 } from '@naturalcycles/js-lib/types'
-import { _passthroughPredicate, _typeCast, SKIP } from '@naturalcycles/js-lib/types'
+import { _passthroughPredicate, _typeCast } from '@naturalcycles/js-lib/types'
 import { stringId } from '@naturalcycles/nodejs-lib'
 import {
   type ReadableTyped,
@@ -616,13 +616,8 @@ export class CommonDao<
 
     this.assignIdCreatedUpdated(bm, opt) // mutates
     _typeCast<BM>(bm)
-    let dbm = await this.bmToDBM(bm, opt) // validates BM
-
-    if (this.cfg.hooks!.beforeSave) {
-      dbm = (await this.cfg.hooks!.beforeSave(dbm))!
-      if (dbm === null) return bm
-    }
-
+    const dbm = await this.bmToDBM(bm, opt) // validates BM
+    this.cfg.hooks!.beforeSave?.(dbm)
     const table = opt.table || this.cfg.table
     const saveOptions = this.prepareSaveOptions(opt)
 
@@ -637,15 +632,9 @@ export class CommonDao<
 
   async saveAsDBM(dbm: Unsaved<DBM>, opt: CommonDaoSaveOptions<BM, DBM> = {}): Promise<DBM> {
     this.requireWriteAccess()
-
     this.assignIdCreatedUpdated(dbm, opt) // mutates
-    let row = this.anyToDBM(dbm, opt)
-
-    if (this.cfg.hooks!.beforeSave) {
-      row = (await this.cfg.hooks!.beforeSave(row))!
-      if (row === null) return dbm as DBM
-    }
-
+    const row = this.anyToDBM(dbm, opt)
+    this.cfg.hooks!.beforeSave?.(row)
     const table = opt.table || this.cfg.table
     const saveOptions = this.prepareSaveOptions(opt)
 
@@ -662,14 +651,10 @@ export class CommonDao<
     if (!bms.length) return []
     this.requireWriteAccess()
     bms.forEach(bm => this.assignIdCreatedUpdated(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,
-      )
+    const dbms = await this.bmsToDBM(bms as BM[], opt)
+    if (this.cfg.hooks!.beforeSave) {
+      dbms.forEach(dbm => this.cfg.hooks!.beforeSave!(dbm))
     }
-
     const table = opt.table || this.cfg.table
     const saveOptions = this.prepareSaveOptions(opt)
 
@@ -689,14 +674,10 @@ export class CommonDao<
     if (!dbms.length) return []
     this.requireWriteAccess()
     dbms.forEach(dbm => this.assignIdCreatedUpdated(dbm, opt))
-    let rows = this.anyToDBMs(dbms as DBM[], opt)
-
-    if (this.cfg.hooks!.beforeSave && rows.length) {
-      rows = (await pMap(rows, async row => await this.cfg.hooks!.beforeSave!(row))).filter(
-        _isTruthy,
-      )
+    const rows = this.anyToDBMs(dbms as DBM[], opt)
+    if (this.cfg.hooks!.beforeSave) {
+      rows.forEach(row => this.cfg.hooks!.beforeSave!(row))
     }
-
     const table = opt.table || this.cfg.table
     const saveOptions = this.prepareSaveOptions(opt)
 
@@ -752,15 +733,9 @@ export class CommonDao<
     return [
       transformMap<BM, DBM>(
         async bm => {
-          this.assignIdCreatedUpdated(bm, opt) // mutates
-
-          let dbm = await this.bmToDBM(bm, opt)
-
-          if (beforeSave) {
-            dbm = (await beforeSave(dbm))!
-            if (dbm === null) return SKIP
-          }
-
+          this.assignIdCreatedUpdated(bm, opt)
+          const dbm = await this.bmToDBM(bm, opt)
+          beforeSave?.(dbm)
           return dbm
         },
         {
@@ -1035,28 +1010,28 @@ export class CommonDao<
     await this.cfg.db.ping()
   }
 
-  withId(id: ID): DaoWithId<typeof this> {
+  withId(id: ID): DaoWithId<CommonDao<BM, DBM, ID>> {
     return {
       dao: this,
       id,
     }
   }
 
-  withIds(ids: ID[]): DaoWithIds<typeof this> {
+  withIds(ids: ID[]): DaoWithIds<CommonDao<BM, DBM, ID>> {
     return {
       dao: this,
       ids,
     }
   }
 
-  withRowsToSave(rows: Unsaved<BM>[]): DaoWithRows<typeof this> {
+  withRowsToSave(rows: Unsaved<BM>[]): DaoWithRows<CommonDao<BM, DBM, ID>> {
     return {
       dao: this,
       rows: rows as any,
     }
   }
 
-  withRowToSave(row: Unsaved<BM>, opt?: DaoWithRowOptions<BM>): DaoWithRow<typeof this> {
+  withRowToSave(row: Unsaved<BM>, opt?: DaoWithRowOptions<BM>): DaoWithRow<CommonDao<BM, DBM, ID>> {
     return {
       dao: this,
       row: row as any,
@@ -1167,7 +1142,7 @@ export class CommonDao<
    * Very @experimental.
    */
   static async multiDeleteByIds(
-    inputs: DaoWithIds<any>[],
+    inputs: DaoWithIds<AnyDao>[],
     _opt: CommonDaoOptions = {},
   ): Promise<NonNegativeInteger> {
     if (!inputs.length) return 0
@@ -1181,7 +1156,7 @@ export class CommonDao<
   }
 
   static async multiSave(
-    inputs: (DaoWithRows<any> | DaoWithRow<any>)[],
+    inputs: (DaoWithRows<AnyDao> | DaoWithRow<AnyDao>)[],
     opt: CommonDaoSaveBatchOptions<any> = {},
   ): Promise<void> {
     if (!inputs.length) return
@@ -1208,11 +1183,17 @@ export class CommonDao<
         }
 
         dao.assignIdCreatedUpdated(row, opt)
-        dbmsByTable[table].push(await dao.bmToDBM(row, opt))
+        const dbm = await dao.bmToDBM(row, opt)
+        dao.cfg.hooks!.beforeSave?.(dbm)
+        dbmsByTable[table].push(dbm)
       } else {
         // Plural
         input.rows.forEach(bm => dao.assignIdCreatedUpdated(bm, opt))
-        dbmsByTable[table].push(...(await dao.bmsToDBM(input.rows, opt)))
+        const dbms = await dao.bmsToDBM(input.rows, opt)
+        if (dao.cfg.hooks!.beforeSave) {
+          dbms.forEach(dbm => dao.cfg.hooks!.beforeSave!(dbm))
+        }
+        dbmsByTable[table].push(...dbms)
       }
     })