@naturalcycles/db-lib 9.7.0 → 9.7.2

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

@@ -86,7 +86,7 @@ export declare class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity
      * Similar to `save` with skipIfEquals.
      * Similar to `patch`, but doesn't load the object from the Database.
      */
-    savePatch(bm: BM, patch: Partial<BM>, opt: CommonDaoSaveBatchOptions<DBM>): Promise<BM>;
+    savePatch(bm: BM, patch: Partial<BM>, opt?: CommonDaoSaveBatchOptions<DBM>): Promise<BM>;
     /**
      * Convenience method to replace 3 operations (loading+patching+saving) with one:
      *
@@ -154,10 +154,9 @@ export declare class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity
     anyToDBM(dbm?: any, opt?: CommonDaoOptions): DBM;
     anyToDBMs(entities: DBM[], opt?: CommonDaoOptions): DBM[];
     /**
-     * Returns *converted value*.
-     * Validates (unless `skipValidation=true` passed).
-     *
+     * Returns *converted value* (NOT the same reference).
      * Does NOT mutate the object.
+     * Validates (unless `skipValidation=true` passed).
      */
     validateAndConvert<T>(obj: Partial<T>, schema: ObjectSchema<T> | AjvSchema<T> | ZodSchema<T> | undefined, opt?: CommonDaoOptions): any;
     getTableSchema(): Promise<JsonSchemaRootObject<DBM>>;

package/dist/commondao/common.dao.js

@@ -544,9 +544,15 @@ class CommonDao {
      */
     async save(bm, opt = {}) {
         this.requireWriteAccess();
-        if (opt.skipIfEquals && (0, js_lib_1._deepJsonEquals)(bm, opt.skipIfEquals)) {
-            // Skipping the save operation
-            return bm;
+        if (opt.skipIfEquals) {
+            // We compare with convertedBM, to account for cases when some extra property is assigned to bm,
+            // which should be removed post-validation, but it breaks the "equality check"
+            // Post-validation the equality check should work as intended
+            const convertedBM = this.validateAndConvert(bm, this.cfg.bmSchema, opt);
+            if ((0, js_lib_1._deepJsonEquals)(convertedBM, opt.skipIfEquals)) {
+                // Skipping the save operation
+                return bm;
+            }
         }
         const idWasGenerated = !bm.id && this.cfg.generateId;
         this.assignIdCreatedUpdated(bm, opt); // mutates
@@ -820,13 +826,7 @@ class CommonDao {
             dbm = this.cfg.hooks.anonymize(dbm);
         }
         // DBM > BM
-        let bm;
-        if (this.cfg.hooks.beforeDBMToBM) {
-            bm = await this.cfg.hooks.beforeDBMToBM(dbm);
-        }
-        else {
-            bm = dbm;
-        }
+        const bm = ((await this.cfg.hooks.beforeDBMToBM?.(dbm)) || dbm);
         // Validate/convert BM
         return this.validateAndConvert(bm, this.cfg.bmSchema, opt);
     }
@@ -836,21 +836,10 @@ class CommonDao {
     async bmToDBM(bm, opt) {
         if (bm === undefined)
             return;
-        // should not do it on load, but only on save!
-        // this.assignIdCreatedUpdated(bm, opt)
         // bm gets assigned to the new reference
         bm = this.validateAndConvert(bm, this.cfg.bmSchema, opt);
         // BM > DBM
-        let dbm;
-        if (this.cfg.hooks.beforeBMToDBM) {
-            dbm = { ...(await this.cfg.hooks.beforeBMToDBM(bm)) };
-        }
-        else {
-            dbm = bm;
-        }
-        // Validate/convert DBM
-        // return this.validateAndConvert(dbm, this.cfg.dbmSchema, DBModelType.DBM, opt)
-        return dbm;
+        return ((await this.cfg.hooks.beforeBMToDBM?.(bm)) || bm);
     }
     async bmsToDBM(bms, opt = {}) {
         // try/catch?
@@ -875,10 +864,9 @@ class CommonDao {
         return entities.map(entity => this.anyToDBM(entity, opt));
     }
     /**
-     * Returns *converted value*.
-     * Validates (unless `skipValidation=true` passed).
-     *
+     * Returns *converted value* (NOT the same reference).
      * Does NOT mutate the object.
+     * Validates (unless `skipValidation=true` passed).
      */
     validateAndConvert(obj, schema, opt = {}) {
         // Kirill 2021-10-18: I realized that there's little reason to keep removing null values

package/package.json

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

package/src/commondao/common.dao.ts

@@ -612,7 +612,7 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
    * Similar to `save` with skipIfEquals.
    * Similar to `patch`, but doesn't load the object from the Database.
    */
-  async savePatch(bm: BM, patch: Partial<BM>, opt: CommonDaoSaveBatchOptions<DBM>): Promise<BM> {
+  async savePatch(bm: BM, patch: Partial<BM>, opt?: CommonDaoSaveBatchOptions<DBM>): Promise<BM> {
     const patched: BM = {
       ...bm,
       ...patch,
@@ -732,9 +732,15 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
   async save(bm: Unsaved<BM>, opt: CommonDaoSaveOptions<BM, DBM> = {}): Promise<BM> {
     this.requireWriteAccess()
 
-    if (opt.skipIfEquals && _deepJsonEquals(bm, opt.skipIfEquals)) {
-      // Skipping the save operation
-      return bm as BM
+    if (opt.skipIfEquals) {
+      // We compare with convertedBM, to account for cases when some extra property is assigned to bm,
+      // which should be removed post-validation, but it breaks the "equality check"
+      // Post-validation the equality check should work as intended
+      const convertedBM = this.validateAndConvert(bm as Partial<BM>, this.cfg.bmSchema, opt)
+      if (_deepJsonEquals(convertedBM, opt.skipIfEquals)) {
+        // Skipping the save operation
+        return bm as BM
+      }
     }
 
     const idWasGenerated = !bm.id && this.cfg.generateId
@@ -1083,15 +1089,9 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
     }
 
     // DBM > BM
-    let bm: Partial<BM>
-    if (this.cfg.hooks!.beforeDBMToBM) {
-      bm = await this.cfg.hooks!.beforeDBMToBM(dbm)
-    } else {
-      bm = dbm as any
-    }
+    const bm = ((await this.cfg.hooks!.beforeDBMToBM?.(dbm)) || dbm) as Partial<BM>
 
     // Validate/convert BM
-
     return this.validateAndConvert(bm, this.cfg.bmSchema, opt)
   }
 
@@ -1108,23 +1108,11 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
   async bmToDBM(bm?: BM, opt?: CommonDaoOptions): Promise<DBM | undefined> {
     if (bm === undefined) return
 
-    // should not do it on load, but only on save!
-    // this.assignIdCreatedUpdated(bm, opt)
-
     // bm gets assigned to the new reference
     bm = this.validateAndConvert(bm, this.cfg.bmSchema, opt)
 
     // BM > DBM
-    let dbm: DBM
-    if (this.cfg.hooks!.beforeBMToDBM) {
-      dbm = { ...((await this.cfg.hooks!.beforeBMToDBM(bm!)) as DBM) }
-    } else {
-      dbm = bm as any
-    }
-
-    // Validate/convert DBM
-    // return this.validateAndConvert(dbm, this.cfg.dbmSchema, DBModelType.DBM, opt)
-    return dbm
+    return ((await this.cfg.hooks!.beforeBMToDBM?.(bm!)) || bm) as DBM
   }
 
   async bmsToDBM(bms: BM[], opt: CommonDaoOptions = {}): Promise<DBM[]> {
@@ -1158,10 +1146,9 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
   }
 
   /**
-   * Returns *converted value*.
-   * Validates (unless `skipValidation=true` passed).
-   *
+   * Returns *converted value* (NOT the same reference).
    * Does NOT mutate the object.
+   * Validates (unless `skipValidation=true` passed).
    */
   validateAndConvert<T>(
     obj: Partial<T>,