@naturalcycles/db-lib 8.30.0 → 8.33.1

package/dist/commondao/common.dao.js

@@ -25,7 +25,8 @@ class CommonDao {
             // otherwise to log Operations
             // e.g in Dev (local machine), Test - it will log operations (useful for debugging)
             logLevel: isGAE || isCI ? common_dao_model_1.CommonDaoLogLevel.NONE : common_dao_model_1.CommonDaoLogLevel.OPERATIONS,
-            createdUpdated: true,
+            created: true,
+            updated: true,
             logger: console,
             ...cfg,
             hooks: {
@@ -405,9 +406,13 @@ class CommonDao {
     assignIdCreatedUpdated(obj, opt = {}) {
         const now = Math.floor(Date.now() / 1000);
         obj.id = obj.id || this.cfg.hooks.createId(obj);
-        if (this.cfg.createdUpdated) {
+        if (this.cfg.created) {
             Object.assign(obj, {
                 created: obj.created || obj.updated || now,
+            });
+        }
+        if (this.cfg.updated) {
+            Object.assign(obj, {
                 updated: opt.preserveUpdatedCreated && obj.updated ? obj.updated : now,
             });
         }

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

@@ -76,10 +76,15 @@ export interface CommonDaoCfg<BM extends Partial<ObjectWithId>, DBM extends Obje
     logStarted?: boolean;
     hooks?: Partial<CommonDaoHooks<BM, DBM, TM>>;
     /**
-     * @default true
-     * Set to false to disable created/updated fields management.
+     * Defaults to true
+     * Set to false to disable `created` field management.
      */
-    createdUpdated?: boolean;
+    created?: boolean;
+    /**
+     * Defaults to true
+     * Set to false to disable `updated` field management.
+     */
+    updated?: boolean;
     /**
      * Default is false.
      * If true - will run `_filterNullishValues` inside `validateAndConvert` function

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>;
@@ -33,6 +39,7 @@ export declare class CommonKeyValueDao<T> {
     createTable(opt?: CommonDBCreateOptions): Promise<void>;
     create(input?: Partial<T>): T;
     getById(id?: string): Promise<T | null>;
+    requireById(id: string): Promise<T>;
     getByIdOrEmpty(id: string, part?: Partial<T>): Promise<T>;
     patch(id: string, patch: Partial<T>): Promise<T>;
     getByIds(ids: string[]): Promise<KeyValueTuple<string, T>[]>;

package/dist/kv/commonKeyValueDao.js

@@ -3,11 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommonKeyValueDao = void 0;
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
+const cnst_1 = require("../cnst");
 // todo: logging
 // todo: readonly
 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();
@@ -26,6 +34,18 @@ class CommonKeyValueDao {
         const [r] = await this.getByIds([id]);
         return r?.[1] || null;
     }
+    async requireById(id) {
+        const [r] = await this.getByIds([id]);
+        if (!r) {
+            const { table } = this.cfg;
+            throw new js_lib_1.AppError(`DB row required, but not found: ${table}.${id}`, {
+                code: cnst_1.DBLibError.DB_ROW_REQUIRED,
+                table,
+                id,
+            });
+        }
+        return r[1];
+    }
     async getByIdOrEmpty(id, part = {}) {
         const [r] = await this.getByIds([id]);
         if (r)

package/dist/kv/commonKeyValueDaoMemoCache.d.ts

@@ -0,0 +1,17 @@
+import { AsyncMemoCache } from '@naturalcycles/js-lib';
+import { CommonKeyValueDao } from './commonKeyValueDao';
+/**
+ * AsyncMemoCache implementation, backed by CommonKeyValueDao.
+ *
+ * Does NOT support persisting Errors, skips them instead.
+ *
+ * Also, does not support .clear(), as it's more dangerous than useful to actually
+ * clear the whole table/cache.
+ */
+export declare class CommonKeyValueDaoMemoCache<VALUE = any> implements AsyncMemoCache<string, VALUE> {
+    private dao;
+    constructor(dao: CommonKeyValueDao<VALUE>);
+    get(k: string): Promise<VALUE | Error | undefined>;
+    set(k: string, v: VALUE | Error): Promise<void>;
+    clear(): Promise<void>;
+}

package/dist/kv/commonKeyValueDaoMemoCache.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommonKeyValueDaoMemoCache = void 0;
+/**
+ * AsyncMemoCache implementation, backed by CommonKeyValueDao.
+ *
+ * Does NOT support persisting Errors, skips them instead.
+ *
+ * Also, does not support .clear(), as it's more dangerous than useful to actually
+ * clear the whole table/cache.
+ */
+class CommonKeyValueDaoMemoCache {
+    constructor(dao) {
+        this.dao = dao;
+    }
+    async get(k) {
+        return (await this.dao.getById(k)) || undefined;
+    }
+    async set(k, v) {
+        if (v instanceof Error) {
+            // We currently don't persist errors there
+            return;
+        }
+        await this.dao.save(k, v);
+    }
+    async clear() {
+        throw new Error('CommonKeyValueDaoMemoCache.clear is not supported, because cache is expected to be persistent');
+    }
+}
+exports.CommonKeyValueDaoMemoCache = CommonKeyValueDaoMemoCache;

package/dist/testing/test.model.d.ts

@@ -17,7 +17,7 @@ export interface TestItemTM {
 export declare const testItemBMSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<TestItemBM, TestItemBM>;
 export declare const testItemDBMSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<TestItemDBM, TestItemDBM>;
 export declare const testItemTMSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<TestItemTM, TestItemTM>;
-export declare const testItemBMJsonSchema: import("@naturalcycles/js-lib/dist/json-schema/jsonSchemaBuilder").JsonSchemaObjectBuilder<TestItemBM & Partial<import("@naturalcycles/js-lib").SavedDBEntity>>;
+export declare const testItemBMJsonSchema: import("@naturalcycles/js-lib/dist/json-schema/jsonSchemaBuilder").JsonSchemaObjectBuilder<TestItemBM & Partial<import("@naturalcycles/js-lib").SavedDBEntity<string>>>;
 export declare const testItemDBMJsonSchema: import("@naturalcycles/js-lib/dist/json-schema/jsonSchemaBuilder").JsonSchemaObjectBuilder<TestItemDBM>;
 export declare function createTestItemDBM(num?: number): TestItemDBM;
 export declare function createTestItemBM(num?: number): Saved<TestItemBM>;

package/dist/validation/index.d.ts

@@ -1,8 +1,8 @@
 import { CommonDBOptions, CommonDBSaveOptions } from '../db.model';
 import { DBQuery, DBQueryFilter, DBQueryOrder } from '../query/dbQuery';
 export declare const commonDBOptionsSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<CommonDBOptions, CommonDBOptions>;
-export declare const commonDBSaveOptionsSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<CommonDBSaveOptions<import("@naturalcycles/js-lib").AnyObjectWithId>, CommonDBSaveOptions<import("@naturalcycles/js-lib").AnyObjectWithId>>;
+export declare const commonDBSaveOptionsSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<CommonDBSaveOptions<import("@naturalcycles/js-lib").AnyObjectWithId<string>>, CommonDBSaveOptions<import("@naturalcycles/js-lib").AnyObjectWithId<string>>>;
 export declare const dbQueryFilterOperatorSchema: import("@naturalcycles/nodejs-lib/dist/validation/joi/string.extensions").ExtendedStringSchema;
-export declare const dbQueryFilterSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryFilter<import("@naturalcycles/js-lib").AnyObjectWithId>, DBQueryFilter<import("@naturalcycles/js-lib").AnyObjectWithId>>;
-export declare const dbQueryOrderSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryOrder<import("@naturalcycles/js-lib").AnyObjectWithId>, DBQueryOrder<import("@naturalcycles/js-lib").AnyObjectWithId>>;
+export declare const dbQueryFilterSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryFilter<import("@naturalcycles/js-lib").AnyObjectWithId<string>>, DBQueryFilter<import("@naturalcycles/js-lib").AnyObjectWithId<string>>>;
+export declare const dbQueryOrderSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryOrder<import("@naturalcycles/js-lib").AnyObjectWithId<string>>, DBQueryOrder<import("@naturalcycles/js-lib").AnyObjectWithId<string>>>;
 export declare const dbQuerySchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQuery<any>, DBQuery<any>>;

package/package.json

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

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

@@ -102,10 +102,16 @@ export interface CommonDaoCfg<
   hooks?: Partial<CommonDaoHooks<BM, DBM, TM>>
 
   /**
-   * @default true
-   * Set to false to disable created/updated fields management.
+   * Defaults to true
+   * Set to false to disable `created` field management.
    */
-  createdUpdated?: boolean
+  created?: boolean
+
+  /**
+   * Defaults to true
+   * Set to false to disable `updated` field management.
+   */
+  updated?: boolean
 
   /**
    * Default is false.

package/src/commondao/common.dao.ts

@@ -69,7 +69,8 @@ export class CommonDao<
       // otherwise to log Operations
       // e.g in Dev (local machine), Test - it will log operations (useful for debugging)
       logLevel: isGAE || isCI ? CommonDaoLogLevel.NONE : CommonDaoLogLevel.OPERATIONS,
-      createdUpdated: true,
+      created: true,
+      updated: true,
       logger: console,
       ...cfg,
       hooks: {
@@ -562,9 +563,14 @@ export class CommonDao<
 
     obj.id = obj.id || this.cfg.hooks!.createId!(obj)
 
-    if (this.cfg.createdUpdated) {
+    if (this.cfg.created) {
       Object.assign(obj, {
         created: (obj as any).created || (obj as any).updated || now,
+      })
+    }
+
+    if (this.cfg.updated) {
+      Object.assign(obj, {
         updated: opt.preserveUpdatedCreated && (obj as any).updated ? (obj as any).updated : now,
       })
     }

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,11 @@
-import { ErrorMode, KeyValueTuple, pMap } from '@naturalcycles/js-lib'
-import { ReadableTyped, transformMap } from '@naturalcycles/nodejs-lib'
+import { AppError, ErrorMode, KeyValueTuple, pMap } from '@naturalcycles/js-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'
 import { CommonKeyValueDB, KeyValueDBTuple } from './commonKeyValueDB'
@@ -30,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()
@@ -58,6 +79,21 @@ export class CommonKeyValueDao<T> {
     return r?.[1] || null
   }
 
+  async requireById(id: string): Promise<T> {
+    const [r] = await this.getByIds([id])
+
+    if (!r) {
+      const { table } = this.cfg
+      throw new AppError(`DB row required, but not found: ${table}.${id}`, {
+        code: DBLibError.DB_ROW_REQUIRED,
+        table,
+        id,
+      })
+    }
+
+    return r[1]
+  }
+
   async getByIdOrEmpty(id: string, part: Partial<T> = {}): Promise<T> {
     const [r] = await this.getByIds([id])
     if (r) return r[1]

package/src/kv/commonKeyValueDaoMemoCache.ts

@@ -0,0 +1,33 @@
+import { AsyncMemoCache } from '@naturalcycles/js-lib'
+import { CommonKeyValueDao } from './commonKeyValueDao'
+
+/**
+ * AsyncMemoCache implementation, backed by CommonKeyValueDao.
+ *
+ * Does NOT support persisting Errors, skips them instead.
+ *
+ * Also, does not support .clear(), as it's more dangerous than useful to actually
+ * clear the whole table/cache.
+ */
+export class CommonKeyValueDaoMemoCache<VALUE = any> implements AsyncMemoCache<string, VALUE> {
+  constructor(private dao: CommonKeyValueDao<VALUE>) {}
+
+  async get(k: string): Promise<VALUE | Error | undefined> {
+    return (await this.dao.getById(k)) || undefined
+  }
+
+  async set(k: string, v: VALUE | Error): Promise<void> {
+    if (v instanceof Error) {
+      // We currently don't persist errors there
+      return
+    }
+
+    await this.dao.save(k, v)
+  }
+
+  async clear(): Promise<void> {
+    throw new Error(
+      'CommonKeyValueDaoMemoCache.clear is not supported, because cache is expected to be persistent',
+    )
+  }
+}