@naturalcycles/db-lib 9.26.3 → 9.27.0

package/dist/commondao/common.dao.js

@@ -509,7 +509,7 @@ class CommonDao {
         }
         else {
             const table = opt.table || this.cfg.table;
-            (0, js_lib_1._assert)(!opt.requireToExist, `${table}.patchById row is required, but missing`, {
+            (0, js_lib_1._assert)(opt.createIfMissing, `DB row required, but not found in ${table}`, {
                 id,
                 table,
             });
@@ -550,26 +550,21 @@ class CommonDao {
             Object.assign(bm, patch);
         }
         else {
-            const loaded = await this.getById(bm.id, {
+            const loaded = await this.requireById(bm.id, {
                 // Skipping validation here for performance reasons.
                 // Validation is going to happen on save anyway, just down below.
                 skipValidation: true,
                 ...opt,
             });
-            if (loaded) {
-                const loadedWithPatch = {
-                    ...loaded,
-                    ...patch,
-                };
-                // Make `bm` exactly the same as `loadedWithPatch`
-                (0, js_lib_1._objectAssignExact)(bm, loadedWithPatch);
-                if ((0, js_lib_1._deepJsonEquals)(loaded, loadedWithPatch)) {
-                    // Skipping the save operation, as data is the same
-                    return bm;
-                }
-            }
-            else {
-                Object.assign(bm, patch);
+            const loadedWithPatch = {
+                ...loaded,
+                ...patch,
+            };
+            // Make `bm` exactly the same as `loadedWithPatch`
+            (0, js_lib_1._objectAssignExact)(bm, loadedWithPatch);
+            if ((0, js_lib_1._deepJsonEquals)(loaded, loadedWithPatch)) {
+                // Skipping the save operation, as data is the same
+                return bm;
             }
         }
         return await this.save(bm, opt);

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

@@ -227,16 +227,18 @@ export interface CommonDaoSaveOptions<BM extends BaseDBEntity, DBM extends BaseD
 export interface CommonDaoPatchByIdOptions<DBM extends BaseDBEntity> extends CommonDaoSaveBatchOptions<DBM> {
     /**
      * Defaults to false.
-     * With false, if the row doesn't exist - it will be auto-created with `dao.create`.
-     * With true, if the row doesn't exist - it will throw an error.
+     * With false, if the row doesn't exist - it will throw an error.
+     * With true, if the row doesn't exist - it will be auto-created with `dao.create`.
      *
      * Use true when you expect the row to exist and it would be an error if it doesn't.
      */
-    requireToExist?: boolean;
+    createIfMissing?: boolean;
 }
 export interface CommonDaoPatchOptions<DBM extends BaseDBEntity> extends CommonDaoSaveBatchOptions<DBM> {
     /**
      * If true - patch will skip loading from DB, and will just optimistically patch passed object.
+     *
+     * Consequently, when the row doesn't exist - it will be auto-created with `dao.create`.
      */
     skipDBRead?: boolean;
 }

package/package.json

@@ -45,7 +45,7 @@
   "engines": {
     "node": ">=22.10.0"
   },
-  "version": "9.26.3",
+  "version": "9.27.0",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

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

@@ -285,18 +285,20 @@ export interface CommonDaoPatchByIdOptions<DBM extends BaseDBEntity>
   extends CommonDaoSaveBatchOptions<DBM> {
   /**
    * Defaults to false.
-   * With false, if the row doesn't exist - it will be auto-created with `dao.create`.
-   * With true, if the row doesn't exist - it will throw an error.
+   * With false, if the row doesn't exist - it will throw an error.
+   * With true, if the row doesn't exist - it will be auto-created with `dao.create`.
    *
    * Use true when you expect the row to exist and it would be an error if it doesn't.
    */
-  requireToExist?: boolean
+  createIfMissing?: boolean
 }
 
 export interface CommonDaoPatchOptions<DBM extends BaseDBEntity>
   extends CommonDaoSaveBatchOptions<DBM> {
   /**
    * If true - patch will skip loading from DB, and will just optimistically patch passed object.
+   *
+   * Consequently, when the row doesn't exist - it will be auto-created with `dao.create`.
    */
   skipDBRead?: boolean
 }

package/src/commondao/common.dao.ts

@@ -679,7 +679,7 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM, I
       }
     } else {
       const table = opt.table || this.cfg.table
-      _assert(!opt.requireToExist, `${table}.patchById row is required, but missing`, {
+      _assert(opt.createIfMissing, `DB row required, but not found in ${table}`, {
         id,
         table,
       })
@@ -728,28 +728,24 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM, I
       }
       Object.assign(bm, patch)
     } else {
-      const loaded = await this.getById(bm.id as ID, {
+      const loaded = await this.requireById(bm.id as ID, {
         // Skipping validation here for performance reasons.
         // Validation is going to happen on save anyway, just down below.
         skipValidation: true,
         ...opt,
       })
 
-      if (loaded) {
-        const loadedWithPatch: BM = {
-          ...loaded,
-          ...patch,
-        }
+      const loadedWithPatch: BM = {
+        ...loaded,
+        ...patch,
+      }
 
-        // Make `bm` exactly the same as `loadedWithPatch`
-        _objectAssignExact(bm, loadedWithPatch)
+      // Make `bm` exactly the same as `loadedWithPatch`
+      _objectAssignExact(bm, loadedWithPatch)
 
-        if (_deepJsonEquals(loaded, loadedWithPatch)) {
-          // Skipping the save operation, as data is the same
-          return bm
-        }
-      } else {
-        Object.assign(bm, patch)
+      if (_deepJsonEquals(loaded, loadedWithPatch)) {
+        // Skipping the save operation, as data is the same
+        return bm
       }
     }