@naturalcycles/db-lib 10.41.0 → 10.42.0

package/dist/commondao/common.dao.js

@@ -386,6 +386,12 @@ export class CommonDao {
     }
     prepareSaveOptions(opt) {
         let { saveMethod, assignGeneratedIds = this.cfg.assignGeneratedIds, excludeFromIndexes = this.cfg.excludeFromIndexes, } = opt;
+        if (this.cfg.compress?.keys) {
+            excludeFromIndexes ??= [];
+            if (!excludeFromIndexes.includes('data')) {
+                excludeFromIndexes.push('data');
+            }
+        }
         if (this.cfg.immutable && !opt.allowMutability && !opt.saveMethod) {
             saveMethod = 'insert';
         }
@@ -569,7 +575,7 @@ export class CommonDao {
      * Mutates `dbm`.
      */
     async compress(dbm) {
-        if (!this.cfg.compress)
+        if (!this.cfg.compress?.keys.length)
             return; // No compression requested
         const { keys } = this.cfg.compress;
         const properties = _pick(dbm, keys);
@@ -584,6 +590,8 @@ export class CommonDao {
      */
     async decompress(dbm) {
         _typeCast(dbm);
+        if (!this.cfg.compress)
+            return; // Auto-compression not turned on
         if (!Buffer.isBuffer(dbm.data))
             return; // No compressed data
         // try-catch to avoid a `data` with Buffer which is not compressed, but legit data

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

@@ -171,11 +171,14 @@ export interface CommonDaoCfg<BM extends BaseDBEntity, DBM extends BaseDBEntity
      * When specified, the listed properties will be compressed under a `data` property in the DBM.
      * If DBM already has a `data` property and you don't add it to the list, an error will be thrown.
      *
+     * When specified with an empty `keys` list, then compression will be skipped, but all previously compressed data
+     * will be decompressed, so the Dao can still work.
+     *
      * Compression happens after the `beforeBMToDBM` hook and before the DBM is saved to the database.
      * Decompression happens after the DBM is loaded from the database and before the `beforeDBMToBM` hook.
      */
     compress?: {
-        keys: [keyof DBM, ...(keyof DBM)[]];
+        keys: (keyof DBM)[];
     };
 }
 /**

package/package.json

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

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

@@ -210,11 +210,14 @@ export interface CommonDaoCfg<
    * When specified, the listed properties will be compressed under a `data` property in the DBM.
    * If DBM already has a `data` property and you don't add it to the list, an error will be thrown.
    *
+   * When specified with an empty `keys` list, then compression will be skipped, but all previously compressed data
+   * will be decompressed, so the Dao can still work.
+   *
    * Compression happens after the `beforeBMToDBM` hook and before the DBM is saved to the database.
    * Decompression happens after the DBM is loaded from the database and before the `beforeDBMToBM` hook.
    */
   compress?: {
-    keys: [keyof DBM, ...(keyof DBM)[]]
+    keys: (keyof DBM)[]
   }
 }
 

package/src/commondao/common.dao.ts

@@ -522,6 +522,14 @@ export class CommonDao<
       assignGeneratedIds = this.cfg.assignGeneratedIds,
       excludeFromIndexes = this.cfg.excludeFromIndexes,
     } = opt
+
+    if (this.cfg.compress?.keys) {
+      excludeFromIndexes ??= []
+      if (!excludeFromIndexes.includes('data' as any)) {
+        excludeFromIndexes.push('data' as any)
+      }
+    }
+
     if (this.cfg.immutable && !opt.allowMutability && !opt.saveMethod) {
       saveMethod = 'insert'
     }
@@ -758,7 +766,7 @@ export class CommonDao<
    * Mutates `dbm`.
    */
   async compress(dbm: DBM): Promise<void> {
-    if (!this.cfg.compress) return // No compression requested
+    if (!this.cfg.compress?.keys.length) return // No compression requested
 
     const { keys } = this.cfg.compress
     const properties = _pick(dbm, keys)
@@ -777,6 +785,7 @@ export class CommonDao<
    */
   async decompress(dbm: DBM): Promise<void> {
     _typeCast<Compressed<DBM>>(dbm)
+    if (!this.cfg.compress) return // Auto-compression not turned on
     if (!Buffer.isBuffer(dbm.data)) return // No compressed data
 
     // try-catch to avoid a `data` with Buffer which is not compressed, but legit data