@naturalcycles/db-lib 8.32.0 → 8.33.0

package/dist/index.d.ts

@@ -17,5 +17,6 @@ import { dbPipelineRestore, DBPipelineRestoreOptions } from './pipeline/dbPipeli
 import { DBQuery, DBQueryFilter, DBQueryFilterOperator, dbQueryFilterOperatorValues, DBQueryOrder, RunnableDBQuery } from './query/dbQuery';
 import { DBTransaction, RunnableDBTransaction } from './transaction/dbTransaction';
 import { commitDBTransactionSimple, mergeDBOperations } from './transaction/dbTransaction.util';
+export * from './kv/commonKeyValueDaoMemoCache';
 export type { DBQueryFilterOperator, DBQueryFilter, DBQueryOrder, CommonDaoCreateOptions, CommonDaoOptions, CommonDaoSaveOptions, CommonDaoStreamForEachOptions, CommonDaoStreamOptions, CommonDBOptions, CommonDBSaveOptions, CommonDBStreamOptions, CommonDBCreateOptions, CommonDB, RunQueryResult, CommonDaoCfg, CommonDaoCreateIdHook, CommonDaoParseNaturalIdHook, CommonDaoBeforeCreateHook, CommonDaoBeforeDBMValidateHook, CommonDaoBeforeDBMToBMHook, CommonDaoBeforeBMToDBMHook, CommonDaoBeforeTMToBMHook, CommonDaoBeforeBMToTMHook, CommonDaoAnonymizeHook, InMemoryDBCfg, InMemoryKeyValueDBCfg, DBPipelineBackupOptions, DBPipelineRestoreOptions, DBPipelineCopyOptions, CommonDBAdapter, DBOperation, DBSaveBatchOperation, DBDeleteByIdsOperation, CommonKeyValueDB, CommonKeyValueDaoCfg, KeyValueDBTuple, };
 export { DBQuery, dbQueryFilterOperatorValues, RunnableDBQuery, CommonDaoLogLevel, DBRelation, DBModelType, CommonDao, createdUpdatedFields, createdUpdatedIdFields, InMemoryDB, InMemoryKeyValueDB, queryInMemory, serializeJsonField, deserializeJsonField, dbPipelineBackup, dbPipelineRestore, dbPipelineCopy, getDB, DBLibError, BaseCommonDB, DBTransaction, RunnableDBTransaction, mergeDBOperations, commitDBTransactionSimple, CommonKeyValueDao, };

package/dist/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommonKeyValueDao = exports.commitDBTransactionSimple = exports.mergeDBOperations = exports.RunnableDBTransaction = exports.DBTransaction = exports.BaseCommonDB = exports.DBLibError = exports.getDB = exports.dbPipelineCopy = exports.dbPipelineRestore = exports.dbPipelineBackup = exports.deserializeJsonField = exports.serializeJsonField = exports.queryInMemory = exports.InMemoryKeyValueDB = exports.InMemoryDB = exports.createdUpdatedIdFields = exports.createdUpdatedFields = exports.CommonDao = exports.DBModelType = exports.DBRelation = exports.CommonDaoLogLevel = exports.RunnableDBQuery = exports.dbQueryFilterOperatorValues = exports.DBQuery = void 0;
+const tslib_1 = require("tslib");
 const inMemory_db_1 = require("./adapter/inmemory/inMemory.db");
 Object.defineProperty(exports, "InMemoryDB", { enumerable: true, get: function () { return inMemory_db_1.InMemoryDB; } });
 const inMemoryKeyValueDB_1 = require("./adapter/inmemory/inMemoryKeyValueDB");
@@ -43,3 +44,4 @@ Object.defineProperty(exports, "RunnableDBTransaction", { enumerable: true, get:
 const dbTransaction_util_1 = require("./transaction/dbTransaction.util");
 Object.defineProperty(exports, "commitDBTransactionSimple", { enumerable: true, get: function () { return dbTransaction_util_1.commitDBTransactionSimple; } });
 Object.defineProperty(exports, "mergeDBOperations", { enumerable: true, get: function () { return dbTransaction_util_1.mergeDBOperations; } });
+(0, tslib_1.__exportStar)(require("./kv/commonKeyValueDaoMemoCache"), exports);

package/dist/kv/commonKeyValueDao.d.ts

@@ -25,6 +25,12 @@ export interface CommonKeyValueDaoCfg<T> {
         mapBufferToValue?: (b: Buffer) => Promise<T>;
         beforeCreate?: (v: Partial<T>) => Partial<T>;
     };
+    /**
+     * Set to `true` to conveniently enable zipping+JSON.stringify
+     * (and unzipping+JSON.parse) of the Buffer value via hooks.
+     * Custom hooks will override these hooks (if provided).
+     */
+    deflatedJsonValue?: boolean;
 }
 export declare class CommonKeyValueDao<T> {
     cfg: CommonKeyValueDaoCfg<T>;

package/dist/kv/commonKeyValueDao.js

@@ -9,6 +9,13 @@ const cnst_1 = require("../cnst");
 class CommonKeyValueDao {
     constructor(cfg) {
         this.cfg = cfg;
+        if (cfg.deflatedJsonValue) {
+            cfg.hooks = {
+                mapValueToBuffer: async (v) => await (0, nodejs_lib_1.deflateString)(JSON.stringify(v)),
+                mapBufferToValue: async (buf) => JSON.parse(await (0, nodejs_lib_1.inflateToString)(buf)),
+                ...cfg.hooks,
+            };
+        }
     }
     async ping() {
         await this.cfg.db.ping();

package/dist/kv/commonKeyValueDaoMemoCache.d.ts

@@ -0,0 +1,9 @@
+import { AsyncMemoCache } from '@naturalcycles/js-lib';
+import { CommonKeyValueDao } from './commonKeyValueDao';
+export declare class CommonKeyValueDaoMemoCache<VALUE = any> implements AsyncMemoCache<string, VALUE> {
+    private dao;
+    constructor(dao: CommonKeyValueDao<VALUE>);
+    get(k: string): Promise<VALUE | undefined>;
+    set(k: string, v: VALUE): Promise<void>;
+    clear(): Promise<void>;
+}

package/dist/kv/commonKeyValueDaoMemoCache.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommonKeyValueDaoMemoCache = void 0;
+class CommonKeyValueDaoMemoCache {
+    constructor(dao) {
+        this.dao = dao;
+    }
+    async get(k) {
+        return (await this.dao.getById(k)) || undefined;
+    }
+    async set(k, v) {
+        await this.dao.save(k, v);
+    }
+    async clear() {
+        throw new Error('CommonKeyValueDaoCacheFactory.clear is not supported, because cache is expected to be persistent');
+    }
+}
+exports.CommonKeyValueDaoMemoCache = CommonKeyValueDaoMemoCache;

package/package.json

@@ -43,7 +43,7 @@
   "engines": {
     "node": ">=14.15"
   },
-  "version": "8.32.0",
+  "version": "8.33.0",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

package/src/index.ts

@@ -58,6 +58,7 @@ import {
 } from './query/dbQuery'
 import { DBTransaction, RunnableDBTransaction } from './transaction/dbTransaction'
 import { commitDBTransactionSimple, mergeDBOperations } from './transaction/dbTransaction.util'
+export * from './kv/commonKeyValueDaoMemoCache'
 
 export type {
   DBQueryFilterOperator,

package/src/kv/commonKeyValueDao.ts

@@ -1,5 +1,10 @@
 import { AppError, ErrorMode, KeyValueTuple, pMap } from '@naturalcycles/js-lib'
-import { ReadableTyped, transformMap } from '@naturalcycles/nodejs-lib'
+import {
+  deflateString,
+  inflateToString,
+  ReadableTyped,
+  transformMap,
+} from '@naturalcycles/nodejs-lib'
 import { DBLibError } from '../cnst'
 import { CommonDaoLogLevel } from '../commondao/common.dao.model'
 import { CommonDBCreateOptions } from '../db.model'
@@ -31,13 +36,28 @@ export interface CommonKeyValueDaoCfg<T> {
     mapBufferToValue?: (b: Buffer) => Promise<T>
     beforeCreate?: (v: Partial<T>) => Partial<T>
   }
+
+  /**
+   * Set to `true` to conveniently enable zipping+JSON.stringify
+   * (and unzipping+JSON.parse) of the Buffer value via hooks.
+   * Custom hooks will override these hooks (if provided).
+   */
+  deflatedJsonValue?: boolean
 }
 
 // todo: logging
 // todo: readonly
 
 export class CommonKeyValueDao<T> {
-  constructor(public cfg: CommonKeyValueDaoCfg<T>) {}
+  constructor(public cfg: CommonKeyValueDaoCfg<T>) {
+    if (cfg.deflatedJsonValue) {
+      cfg.hooks = {
+        mapValueToBuffer: async v => await deflateString(JSON.stringify(v)),
+        mapBufferToValue: async buf => JSON.parse(await inflateToString(buf)),
+        ...cfg.hooks,
+      }
+    }
+  }
 
   async ping(): Promise<void> {
     await this.cfg.db.ping()

package/src/kv/commonKeyValueDaoMemoCache.ts

@@ -0,0 +1,20 @@
+import { AsyncMemoCache } from '@naturalcycles/js-lib'
+import { CommonKeyValueDao } from './commonKeyValueDao'
+
+export class CommonKeyValueDaoMemoCache<VALUE = any> implements AsyncMemoCache<string, VALUE> {
+  constructor(private dao: CommonKeyValueDao<VALUE>) {}
+
+  async get(k: string): Promise<VALUE | undefined> {
+    return (await this.dao.getById(k)) || undefined
+  }
+
+  async set(k: string, v: VALUE): Promise<void> {
+    await this.dao.save(k, v)
+  }
+
+  async clear(): Promise<void> {
+    throw new Error(
+      'CommonKeyValueDaoCacheFactory.clear is not supported, because cache is expected to be persistent',
+    )
+  }
+}