@naturalcycles/db-lib 9.7.1 → 9.8.0

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

@@ -4,7 +4,7 @@ import { AsyncMapper, BaseDBEntity, CommonLogger, JsonSchemaObject, JsonSchemaRo
 import { AjvSchema, ObjectSchema, ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { CommonDBTransactionOptions, DBPatch, DBTransaction, RunQueryResult } from '../db.model';
 import { DBQuery, RunnableDBQuery } from '../query/dbQuery';
-import { CommonDaoCfg, CommonDaoCreateOptions, CommonDaoOptions, CommonDaoSaveBatchOptions, CommonDaoSaveOptions, CommonDaoStreamDeleteOptions, CommonDaoStreamForEachOptions, CommonDaoStreamOptions, CommonDaoStreamSaveOptions } from './common.dao.model';
+import { CommonDaoCfg, CommonDaoCreateOptions, CommonDaoOptions, CommonDaoPatchOptions, CommonDaoSaveBatchOptions, CommonDaoSaveOptions, CommonDaoStreamDeleteOptions, CommonDaoStreamForEachOptions, CommonDaoStreamOptions, CommonDaoStreamSaveOptions } from './common.dao.model';
 /**
  * Lowest common denominator API between supported Databases.
  *
@@ -78,15 +78,6 @@ export declare class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity
      * "Returns", just to have a type of "Saved"
      */
     assignIdCreatedUpdated<T extends BaseDBEntity>(obj: Partial<T>, opt?: CommonDaoOptions): T;
-    /**
-     * 1. Applies the patch
-     * 2. If object is the same after patching - skips saving it
-     * 3. Otherwise - saves the patched object and returns it
-     *
-     * 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>;
     /**
      * Convenience method to replace 3 operations (loading+patching+saving) with one:
      *
@@ -107,7 +98,7 @@ export declare class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity
      * Otherwise, similar behavior as patchById.
      * It still loads the row from the DB.
      */
-    patch(bm: BM, patch: Partial<BM>, opt?: CommonDaoSaveBatchOptions<DBM>): Promise<BM>;
+    patch(bm: BM, patch: Partial<BM>, opt?: CommonDaoPatchOptions<DBM>): Promise<BM>;
     /**
      * Like patch, but runs all operations within a Transaction.
      */

package/dist/commondao/common.dao.js

@@ -444,27 +444,6 @@ class CommonDao {
         return obj;
     }
     // SAVE
-    /**
-     * 1. Applies the patch
-     * 2. If object is the same after patching - skips saving it
-     * 3. Otherwise - saves the patched object and returns it
-     *
-     * Similar to `save` with skipIfEquals.
-     * Similar to `patch`, but doesn't load the object from the Database.
-     */
-    async savePatch(bm, patch, opt) {
-        const patched = {
-            ...bm,
-            ...patch,
-        };
-        if ((0, js_lib_1._deepJsonEquals)(bm, patched)) {
-            // Skipping the save operation, as data is the same
-            return bm;
-        }
-        // Actually apply the patch by mutating the original object (by design)
-        Object.assign(bm, patch);
-        return await this.save(bm, opt);
-    }
     /**
      * Convenience method to replace 3 operations (loading+patching+saving) with one:
      *
@@ -516,18 +495,28 @@ class CommonDao {
             // and should just continue as-is
             return await this.patchInTransaction(bm, patch, opt);
         }
-        const loaded = await this.getById(bm.id, opt);
-        if (loaded) {
-            Object.assign(loaded, patch);
-            if ((0, js_lib_1._deepJsonEquals)(loaded, bm)) {
+        if (opt.skipDBRead) {
+            const bmBefore = (0, js_lib_1._deepCopy)(bm);
+            Object.assign(bm, patch);
+            if ((0, js_lib_1._deepJsonEquals)(bm, bmBefore)) {
                 // Skipping the save operation, as data is the same
                 return bm;
             }
-            // Make `bm` exactly the same as `loaded`
-            (0, js_lib_1._objectAssignExact)(bm, loaded);
         }
         else {
-            Object.assign(bm, patch);
+            const loaded = await this.getById(bm.id, opt);
+            if (loaded) {
+                Object.assign(loaded, patch);
+                if ((0, js_lib_1._deepJsonEquals)(loaded, bm)) {
+                    // Skipping the save operation, as data is the same
+                    return bm;
+                }
+                // Make `bm` exactly the same as `loaded`
+                (0, js_lib_1._objectAssignExact)(bm, loaded);
+            }
+            else {
+                Object.assign(bm, patch);
+            }
         }
         return await this.save(bm, opt);
     }

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

@@ -209,6 +209,12 @@ export interface CommonDaoSaveOptions<BM extends BaseDBEntity, DBM extends BaseD
      */
     skipIfEquals?: BM;
 }
+export interface CommonDaoPatchOptions<DBM extends BaseDBEntity> extends CommonDaoSaveBatchOptions<DBM> {
+    /**
+     * If true - patch will skip loading from DB, and will just optimistically patch passed object.
+     */
+    skipDBRead?: boolean;
+}
 /**
  * All properties default to undefined.
  */

package/dist/testing/timeSeriesTest.util.js

@@ -4,6 +4,6 @@ exports.createTestTimeSeries = void 0;
 const js_lib_1 = require("@naturalcycles/js-lib");
 function createTestTimeSeries(count = 10) {
     const ts = Date.now();
-    return (0, js_lib_1._range)(1, count + 1).map(i => [ts - i * 60000, (0, js_lib_1._randomInt)(10, 20)]);
+    return (0, js_lib_1._range)(1, count + 1).map(i => [ts - i * 60_000, (0, js_lib_1._randomInt)(10, 20)]);
 }
 exports.createTestTimeSeries = createTestTimeSeries;

package/package.json

@@ -8,7 +8,7 @@
     "@naturalcycles/nodejs-lib": "^13.1.1"
   },
   "devDependencies": {
-    "@naturalcycles/bench-lib": "^1.0.0",
+    "@naturalcycles/bench-lib": "^2.0.0",
     "@naturalcycles/dev-lib": "^13.0.0",
     "@types/node": "^20.2.1",
     "jest": "^29.0.0"
@@ -40,7 +40,7 @@
   "engines": {
     "node": ">=18.12"
   },
-  "version": "9.7.1",
+  "version": "9.8.0",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

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

@@ -257,6 +257,14 @@ export interface CommonDaoSaveOptions<BM extends BaseDBEntity, DBM extends BaseD
   skipIfEquals?: BM
 }
 
+export interface CommonDaoPatchOptions<DBM extends BaseDBEntity>
+  extends CommonDaoSaveBatchOptions<DBM> {
+  /**
+   * If true - patch will skip loading from DB, and will just optimistically patch passed object.
+   */
+  skipDBRead?: boolean
+}
+
 /**
  * All properties default to undefined.
  */

package/src/commondao/common.dao.ts

@@ -51,6 +51,7 @@ import {
   CommonDaoHooks,
   CommonDaoLogLevel,
   CommonDaoOptions,
+  CommonDaoPatchOptions,
   CommonDaoSaveBatchOptions,
   CommonDaoSaveOptions,
   CommonDaoStreamDeleteOptions,
@@ -604,31 +605,6 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
   }
 
   // SAVE
-  /**
-   * 1. Applies the patch
-   * 2. If object is the same after patching - skips saving it
-   * 3. Otherwise - saves the patched object and returns it
-   *
-   * 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> {
-    const patched: BM = {
-      ...bm,
-      ...patch,
-    }
-
-    if (_deepJsonEquals(bm, patched)) {
-      // Skipping the save operation, as data is the same
-      return bm
-    }
-
-    // Actually apply the patch by mutating the original object (by design)
-    Object.assign(bm, patch)
-
-    return await this.save(bm, opt)
-  }
-
   /**
    * Convenience method to replace 3 operations (loading+patching+saving) with one:
    *
@@ -686,7 +662,7 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
    * Otherwise, similar behavior as patchById.
    * It still loads the row from the DB.
    */
-  async patch(bm: BM, patch: Partial<BM>, opt: CommonDaoSaveBatchOptions<DBM> = {}): Promise<BM> {
+  async patch(bm: BM, patch: Partial<BM>, opt: CommonDaoPatchOptions<DBM> = {}): Promise<BM> {
     if (this.cfg.patchInTransaction && !opt.tx) {
       // patchInTransaction means that we should run this op in Transaction
       // But if opt.tx is passed - means that we are already in a Transaction,
@@ -694,20 +670,29 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
       return await this.patchInTransaction(bm, patch, opt)
     }
 
-    const loaded = await this.getById(bm.id, opt)
-
-    if (loaded) {
-      Object.assign(loaded, patch)
-
-      if (_deepJsonEquals(loaded, bm)) {
+    if (opt.skipDBRead) {
+      const bmBefore = _deepCopy(bm)
+      Object.assign(bm, patch)
+      if (_deepJsonEquals(bm, bmBefore)) {
         // Skipping the save operation, as data is the same
         return bm
       }
-
-      // Make `bm` exactly the same as `loaded`
-      _objectAssignExact(bm, loaded)
     } else {
-      Object.assign(bm, patch)
+      const loaded = await this.getById(bm.id, opt)
+
+      if (loaded) {
+        Object.assign(loaded, patch)
+
+        if (_deepJsonEquals(loaded, bm)) {
+          // Skipping the save operation, as data is the same
+          return bm
+        }
+
+        // Make `bm` exactly the same as `loaded`
+        _objectAssignExact(bm, loaded)
+      } else {
+        Object.assign(bm, patch)
+      }
     }
 
     return await this.save(bm, opt)