@samet-it/be-db-common 1.1.8 → 1.3.1

package/dist/connection/db.connection.d.ts

@@ -1,5 +1,5 @@
-import type { DbConnectionLike, DbConnOpt, DbOnAfter, DbConnProps, DbEvent } from "./index.types";
-import type { Logger } from "@leyyo/common";
+import { DbConnectionLike, DbConnOpt, DbOnAfter, DbConnProps, DbEvent } from "./index.types";
+import { Logger } from "@leyyo/common";
 /**
  * DB connection abstract class
  *

package/dist/connection/db.connection.js

@@ -10,8 +10,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DbConnection = void 0;
-const be_base_common_1 = require("@samet-it/be-base-common");
 const type_1 = require("@leyyo/type");
+const common_1 = require("@leyyo/common");
 // noinspection JSUnusedGlobalSymbols
 /**
  * DB connection abstract class
@@ -43,10 +43,10 @@ class DbConnection {
          * Option of in-body usage in place of constructor param
          * */
         this._opt = {};
-        if (!(0, type_1.isObjectBare)(this._opt)) {
+        if (!(0, type_1.isBareObject)(this._opt)) {
             this._opt = {};
         }
-        if ((0, type_1.isObjectBare)(opt)) {
+        if ((0, type_1.isBareObject)(opt)) {
             this._opt = Object.assign(Object.assign({}, this._opt), opt);
         }
         this._props = Object.assign(Object.assign({}, this._opt), { connectTryCount: 0, pingTryCount: 0 });
@@ -70,7 +70,7 @@ class DbConnection {
         }
         else {
             fn().then().catch(e => {
-                this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'on', name));
+                this.logger.warn(common_1.errorCommon.text(e, 'on', name));
                 if (throwable) {
                     throw e;
                 }
@@ -88,7 +88,7 @@ class DbConnection {
         if (items.length > 0) {
             items.forEach(fn => {
                 fn().then().catch(e => {
-                    this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'trigger', 'on', name));
+                    this.logger.warn(common_1.errorCommon.text(e, 'trigger', 'on', name));
                     if (throwable) {
                         throw e;
                     }

package/dist/error/db-execute.error.d.ts

@@ -1,4 +1,4 @@
-import type { Opt } from "@leyyo/common";
+import { Opt } from "@leyyo/common";
 import { DbError } from "./db.error";
 /**
  * DB execute error during run sql

package/dist/error/db-invalid-value.error.d.ts

@@ -1,4 +1,4 @@
-import type { Opt } from "@leyyo/common";
+import { Opt } from "@leyyo/common";
 import { DbError } from "./db.error";
 /**
  * Cache validation error

package/dist/error/db-not-supported.error.d.ts

@@ -1,5 +1,5 @@
 import { DbError } from "./db.error";
-import type { Opt } from "@leyyo/common";
+import { Opt } from "@leyyo/common";
 /**
  * DB not-supported error
  * */

package/dist/line/db-lines.impl.d.ts

@@ -1,4 +1,4 @@
-import type { DbLines } from "./index.types";
+import { DbLines } from "./index.types";
 /**
  * Create new/empty sql lines
  *

package/dist/repo/db.repo.d.ts

@@ -1,10 +1,10 @@
 import { DbCheckKeysResult, DbRepoProps, DbRepoLike, DbRepoOpt, UrnDelimiter, DbCheckKeysTuple, DbExecOpt, DbMeta, DbRepoExtensionLambda, DbQueryResultOne, DbQueryResultMore } from "./index.types";
 import { DefDims, Entity, IdDocLike, Pair, Portion, UrnDocLike, UrnTuple, View } from "@samet-it/be-base-common";
 import { DbConnectionLike, UserFetcherLambda } from "../connection";
-import type { KeyValue, Logger, Opt, StrKey } from "@leyyo/common";
-import { type QueryAny, type QueryRegular } from "@leyyo/query";
-import type { CacheConnectionLike, CacheChannelLike, CacheExecOpt } from "@samet-it/be-cache-common";
-import type { DbLines } from "../line";
+import { KeyValue, Logger, Opt, StrKey } from "@leyyo/common";
+import { QueryAny, QueryRegular } from "@leyyo/query";
+import { CacheConnectionLike, CacheChannelLike, CacheExecOpt } from "@samet-it/be-cache-common";
+import { DbLines } from "../line";
 /**
  * DB repository abstract class
  *
@@ -42,19 +42,63 @@ export declare abstract class DbRepo<CONN extends DbConnectionLike, OPT extends
      * @param {DbRepoOpt} opt - options
      * */
     protected constructor(conn: CONN, opt?: DbRepoOpt<ENT, ID>);
+    /**
+     * Check given options
+     * */
+    private _checkOptions;
+    /**
+     * Generate time value by configuration
+     *
+     * - hasIsoDate: true => string iso datetime
+     * - hasIsoDate: false => number timestamp
+     *
+     * @return {(string|number)}
+     * */
     protected get _now(): string | number;
+    /**
+     * Generate random index name
+     *
+     * @return {string}
+     * */
     protected get _randomIndexName(): string;
+    /**
+     * Check & validate index name
+     *
+     * @param {string} name - given index name
+     * @return {string} - validated index name
+     * */
     protected _indexName(name: string): string;
     /**
      * Fetch urn from doc as doc.urn
      * */
     protected _urnFromDoc(doc: Partial<ENT>, method: string): string;
+    /**
+     * Check key, understand it urn, id or portion
+     *
+     * @param {any} value - given id value
+     * @return {DbCheckKeysTuple} - key tuple as [value, field]
+     * */
     protected _checkKey(value: unknown): DbCheckKeysTuple<ID>;
     /**
      * Check array keys as id list or urn list
+     *
+     * @param {Array} keys - given keys
+     * @return {DbCheckKeysResult} - list of key tuple
      * */
     protected _checkKeys(keys: Array<unknown>): DbCheckKeysResult<ID>;
+    /**
+     * Is key urn or id
+     *
+     * @param {KeyValue} key - given key value
+     * @return boolean - is urn or not
+     * */
     protected _isUrn(key: KeyValue): boolean;
+    /**
+     * Build key to urn value with prefix
+     *
+     * @param {KeyValue} key - given key value
+     * @return {string} - urn value
+     * */
     protected _keyToUrn(key: KeyValue): string;
     /** @inheritDoc */
     get props(): Readonly<DbRepoProps<CONN, ENT, ID>>;

package/dist/repo/db.repo.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DbRepo = void 0;
 const node_crypto_1 = require("node:crypto");
 const be_base_common_1 = require("@samet-it/be-base-common");
+const common_1 = require("@leyyo/common");
 const query_1 = require("@leyyo/query");
 const type_1 = require("@leyyo/type");
 const error_1 = require("../error");
@@ -47,18 +48,27 @@ class DbRepo {
          * Option of in-body usage in place of constructor param
          * */
         this._opt = {};
-        if (!(0, type_1.isObjectFilled)(conn)) {
+        if (!(0, common_1.isFilledObj)(conn)) {
             throw new error_1.DbInvalidValueError('Connection', { where: 'DbRepo', method: 'constructor', type: typeof conn });
         }
-        if (!(0, type_1.isObjectBare)(this._opt)) {
+        if (!(0, type_1.isBareObject)(this._opt)) {
             this._opt = {};
         }
-        if ((0, type_1.isObjectBare)(opt)) {
+        if ((0, type_1.isBareObject)(opt)) {
             this._opt = Object.assign(Object.assign({}, this._opt), opt);
         }
+        this._checkOptions();
+        this._props = Object.assign({ conn }, this._opt);
+        delete this._opt;
+    }
+    // region protected-method
+    /**
+     * Check given options
+     * */
+    _checkOptions() {
         // handle invalid cache
         if (!this._opt.cache) {
-            this._opt.cache = { isConnected: false };
+            this._opt.cache = { isEnabled: false, isConnected: false };
         }
         if (this._opt.useVersion) {
             if (typeof this._opt.version !== 'number') {
@@ -99,18 +109,46 @@ class DbRepo {
                 }
             });
         }
-        this._props = Object.assign({ conn }, this._opt);
-        delete this._opt;
+        const directOpt = this._opt;
+        if (typeof directOpt.$toUrnTuple === 'function') {
+            this.$toUrnTuple = directOpt.$toUrnTuple;
+        }
+        if (typeof directOpt.$toDim === 'function') {
+            this.$toDim = (doc, dim) => __awaiter(this, void 0, void 0, function* () {
+                return (yield directOpt.$toDim(doc, dim));
+            });
+        }
+        if (!Array.isArray(directOpt.indexedFields)) {
+            directOpt.indexedFields = [];
+        }
     }
-    // region protected-method
+    /**
+     * Generate time value by configuration
+     *
+     * - hasIsoDate: true => string iso datetime
+     * - hasIsoDate: false => number timestamp
+     *
+     * @return {(string|number)}
+     * */
     get _now() {
         return this.hasIsoDate ? new Date().toISOString() : Date.now();
     }
+    /**
+     * Generate random index name
+     *
+     * @return {string}
+     * */
     get _randomIndexName() {
         return 'idx_' + (0, node_crypto_1.randomUUID)().match(/[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g)
             .map(s => s.toLowerCase())
             .join('_');
     }
+    /**
+     * Check & validate index name
+     *
+     * @param {string} name - given index name
+     * @return {string} - validated index name
+     * */
     _indexName(name) {
         if (typeof name !== 'string') {
             return this._randomIndexName;
@@ -143,6 +181,12 @@ class DbRepo {
         (0, type_1.assertText)(doc.urn, Object.assign({ field: 'urn' }, param));
         return doc.urn;
     }
+    /**
+     * Check key, understand it urn, id or portion
+     *
+     * @param {any} value - given id value
+     * @return {DbCheckKeysTuple} - key tuple as [value, field]
+     * */
     _checkKey(value) {
         let id;
         switch (typeof value) {
@@ -194,6 +238,9 @@ class DbRepo {
     }
     /**
      * Check array keys as id list or urn list
+     *
+     * @param {Array} keys - given keys
+     * @return {DbCheckKeysResult} - list of key tuple
      * */
     _checkKeys(keys) {
         const result = { urns: [], ids: [], ordered: [] };
@@ -215,9 +262,21 @@ class DbRepo {
         }
         return result;
     }
+    /**
+     * Is key urn or id
+     *
+     * @param {KeyValue} key - given key value
+     * @return boolean - is urn or not
+     * */
     _isUrn(key) {
         return (typeof key === 'string') && key.startsWith(this.urnPrefix + ':');
     }
+    /**
+     * Build key to urn value with prefix
+     *
+     * @param {KeyValue} key - given key value
+     * @return {string} - urn value
+     * */
     _keyToUrn(key) {
         return `${this.urnPrefix}:${key}`;
     }
@@ -363,18 +422,18 @@ class DbRepo {
         }
         if (opt === null || opt === void 0 ? void 0 : opt.silent) {
             if (size < 100) {
-                this.logger.warn(be_base_common_1.errorHandler.common.logText(err, ((_b = opt.name) !== null && _b !== void 0 ? _b : 'Database error'), size));
+                this.logger.warn(common_1.errorCommon.text(err, ((_b = opt.name) !== null && _b !== void 0 ? _b : 'Database error'), size));
             }
             return;
         }
         if (size < 100) {
-            this.logger.error(be_base_common_1.errorHandler.common.logText(err, ((_c = opt.name) !== null && _c !== void 0 ? _c : 'Database error'), size));
+            this.logger.error(common_1.errorCommon.text(err, ((_c = opt.name) !== null && _c !== void 0 ? _c : 'Database error'), size));
         }
         if (err instanceof error_1.DbError) {
             throw err;
         }
         else {
-            throw be_base_common_1.errorHandler.common.castForClass(error_1.DbError, err, { queryName: opt.name });
+            throw common_1.errorCommon.forcedCast(error_1.DbError, err, { queryName: opt.name });
         }
     }
     /** {@inheritDoc} */
@@ -474,7 +533,7 @@ class DbRepo {
                     found = yield this.cache.getByPrimary(key, opt);
                 }
                 catch (e) {
-                    this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'getByPrimary', 'cache', 'getByPrimary'));
+                    this.logger.warn(common_1.errorCommon.text(e, 'getByPrimary', 'cache', 'getByPrimary'));
                 }
                 if (found) {
                     return found;
@@ -484,7 +543,7 @@ class DbRepo {
             if (!opt.noCache && found && this.cache.isConnected) {
                 this.cache.ingestDoc(found, opt)
                     .then()
-                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'getByPrimary', 'cache', 'ingestDoc')));
+                    .catch(e => this.logger.warn(common_1.errorCommon.text(e, 'getByPrimary', 'cache', 'ingestDoc')));
             }
             return found;
         });
@@ -513,14 +572,14 @@ class DbRepo {
                     }
                 }
                 catch (e) {
-                    this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'getBySecondary', 'cache', 'getBySecondary'));
+                    this.logger.warn(common_1.errorCommon.text(e, 'getBySecondary', 'cache', 'getBySecondary'));
                 }
             }
             found = yield this.$getBySecondary(key, opt, true);
             if (found && this.cache.isConnected) {
                 this.cache.ingestDoc(found, opt)
                     .then()
-                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'getBySecondary', 'cache', 'ingestDoc')));
+                    .catch(e => this.logger.warn(common_1.errorCommon.text(e, 'getBySecondary', 'cache', 'ingestDoc')));
             }
             return found;
         });
@@ -558,7 +617,7 @@ class DbRepo {
                     }
                 }
                 catch (e) {
-                    this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'existsByPrimary', 'cache', 'getByPrimary'));
+                    this.logger.warn(common_1.errorCommon.text(e, 'existsByPrimary', 'cache', 'getByPrimary'));
                 }
             }
             return this.$existsByPrimary(key, opt, true);
@@ -587,7 +646,7 @@ class DbRepo {
                     }
                 }
                 catch (e) {
-                    this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'existsBySecondary', 'cache', 'getBySecondary'));
+                    this.logger.warn(common_1.errorCommon.text(e, 'existsBySecondary', 'cache', 'getBySecondary'));
                 }
             }
             return this.$existsBySecondary(key, opt, true);
@@ -614,7 +673,7 @@ class DbRepo {
                         founds = yield this.cache.getByPrimaryMore(result.urns, opt);
                     }
                     catch (e) {
-                        this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'list', 'cache', 'getByPrimary'));
+                        this.logger.warn(common_1.errorCommon.text(e, 'list', 'cache', 'getByPrimary'));
                     }
                     founds.forEach(val => {
                         const index = result.urns.indexOf(val.urn);
@@ -630,7 +689,7 @@ class DbRepo {
                         if (!opt.noCache && this.cache.isConnected) {
                             founds.forEach(found => this.cache.ingestDoc(found, opt)
                                 .then()
-                                .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'list', 'cache', 'ingestDoc'))));
+                                .catch(e => this.logger.warn(common_1.errorCommon.text(e, 'list', 'cache', 'ingestDoc'))));
                         }
                         docs.push(...founds);
                     }
@@ -642,7 +701,7 @@ class DbRepo {
                         founds = yield this.cache.getBySecondaryMore(result.ids, opt);
                     }
                     catch (e) {
-                        this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'list', 'cache', 'getBySecondary'));
+                        this.logger.warn(common_1.errorCommon.text(e, 'list', 'cache', 'getBySecondary'));
                     }
                     founds.forEach(val => {
                         const index = result.ids.indexOf(val.id);
@@ -658,7 +717,7 @@ class DbRepo {
                         if (!opt.noCache && this.cache.isConnected) {
                             founds.forEach(found => this.cache.ingestDoc(found, opt)
                                 .then()
-                                .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'list', 'cache', 'ingestDoc'))));
+                                .catch(e => this.logger.warn(common_1.errorCommon.text(e, 'list', 'cache', 'ingestDoc'))));
                         }
                         docs.push(...founds);
                     }
@@ -768,7 +827,7 @@ class DbRepo {
             if (!opt.noCache && this.cache.isConnected) {
                 this.cache.clearDoc(replacedKey, opt)
                     .then()
-                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'replace', 'cache', 'clearDoc')));
+                    .catch(e => this.logger.warn(common_1.errorCommon.text(e, 'replace', 'cache', 'clearDoc')));
             }
             return replacedKey;
         });
@@ -806,7 +865,7 @@ class DbRepo {
             if (!opt.noCache && this.cache.isConnected) {
                 this.cache.clearDoc(createdKey, opt)
                     .then()
-                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'upsert', 'cache', 'clearDoc')));
+                    .catch(e => this.logger.warn(common_1.errorCommon.text(e, 'upsert', 'cache', 'clearDoc')));
             }
             return createdKey;
         });
@@ -861,7 +920,7 @@ class DbRepo {
             if (updatedKey && !opt.noCache && this.cache.isConnected) {
                 this.cache.clearDoc(updatedKey, opt)
                     .then()
-                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'updateByPrimary', 'cache', 'clearDoc')));
+                    .catch(e => this.logger.warn(common_1.errorCommon.text(e, 'updateByPrimary', 'cache', 'clearDoc')));
             }
             return updatedKey;
         });
@@ -904,7 +963,7 @@ class DbRepo {
             if (updatedKey && !opt.noCache && this.cache.isConnected) {
                 this.cache.clearDoc(updatedKey, opt)
                     .then()
-                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'updateBySecondary', 'cache', 'clearDoc')));
+                    .catch(e => this.logger.warn(common_1.errorCommon.text(e, 'updateBySecondary', 'cache', 'clearDoc')));
             }
             return updatedKey;
         });
@@ -977,7 +1036,7 @@ class DbRepo {
             if (removedKey && !opt.noCache && this.cache.isConnected) {
                 this.cache.clearDoc(removedKey, opt)
                     .then()
-                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'removeByPrimary', 'cache', 'clearDoc')));
+                    .catch(e => this.logger.warn(common_1.errorCommon.text(e, 'removeByPrimary', 'cache', 'clearDoc')));
             }
             return removedKey;
         });
@@ -1003,7 +1062,7 @@ class DbRepo {
             if (removedKey && !opt.noCache && this.cache.isConnected) {
                 this.cache.clearDoc(removedKey, opt)
                     .then()
-                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'removeBySecondary', 'cache', 'clearDoc')));
+                    .catch(e => this.logger.warn(common_1.errorCommon.text(e, 'removeBySecondary', 'cache', 'clearDoc')));
             }
             return removedKey;
         });
@@ -1039,14 +1098,14 @@ class DbRepo {
             if (!ignoreCheck) {
                 (0, type_1.assertText)(key, Object.assign({ field: 'urn' }, param));
             }
-            if (!(0, type_1.isText)(opt.trashId)) {
+            if (!(0, common_1.isText)(opt.trashId)) {
                 opt.trashId = (0, node_crypto_1.randomUUID)();
             }
             const trashedKey = yield this.$trashByPrimary(key, opt, true);
             if (trashedKey && !opt.noCache && this.cache.isConnected) {
                 this.cache.clearDoc(trashedKey, opt)
                     .then()
-                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'trashByPrimary', 'cache', 'clearDoc')));
+                    .catch(e => this.logger.warn(common_1.errorCommon.text(e, 'trashByPrimary', 'cache', 'clearDoc')));
             }
             return trashedKey;
         });
@@ -1071,14 +1130,14 @@ class DbRepo {
             if (this.isIdSame) {
                 return this.trashByPrimary(this._keyToUrn(key), opt, ignoreCheck);
             }
-            if (!(0, type_1.isText)(opt.trashId)) {
+            if (!(0, common_1.isText)(opt.trashId)) {
                 opt.trashId = (0, node_crypto_1.randomUUID)();
             }
             const trashedKey = yield this.$trashBySecondary(key, opt, true);
             if (trashedKey && !opt.noCache && this.cache.isConnected) {
                 this.cache.clearDoc(trashedKey, opt)
                     .then()
-                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'trashBySecondary', 'cache', 'clearDoc')));
+                    .catch(e => this.logger.warn(common_1.errorCommon.text(e, 'trashBySecondary', 'cache', 'clearDoc')));
             }
             return trashedKey;
         });

package/dist/repo/index.types.d.ts

@@ -1,9 +1,9 @@
-import type { DefDims, Entity, IdDocLike, Pair, Portion, UrnDef, UrnDocLike, UrnTuple, View } from "@samet-it/be-base-common";
-import type { DbConnectionLike, UserFetcherLambda } from "../connection";
-import type { QueryAny, QueryRegular } from "@leyyo/query";
-import type { CacheChannelLike, CacheConnectionLike, CacheExecOpt } from "@samet-it/be-cache-common";
-import type { KeyValue, OmitError, Opt, StrKey } from "@leyyo/common";
-import type { DbLines } from "../line";
+import { DefDims, Entity, IdDocLike, Pair, Portion, UrnDef, UrnDocLike, UrnTuple, View } from "@samet-it/be-base-common";
+import { DbConnectionLike, UserFetcherLambda } from "../connection";
+import { QueryAny, QueryRegular } from "@leyyo/query";
+import { CacheChannelLike, CacheConnectionLike, CacheExecOpt } from "@samet-it/be-cache-common";
+import { KeyValue, OmitError, Opt, StrKey } from "@leyyo/common";
+import { DbLines } from "../line";
 /**
  * DB repository interface
  *
@@ -954,6 +954,10 @@ export interface DbRepoProps<CONN extends DbConnectionLike, ENT extends Entity<I
      * @type {number}
      * */
     urnLength?: number;
+    /**
+     * Indexed fields
+     * */
+    indexedFields?: Array<keyof ENT | string>;
 }
 /**
  * DB keys result
@@ -1155,5 +1159,5 @@ export interface DbRepoDirectOpt<ENT extends Entity<ID>, ID extends KeyValue = K
     /**
      * Indexed fields
      * */
-    $indexedFields?: Array<keyof ENT | string>;
+    indexedFields?: Array<keyof ENT | string>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@samet-it/be-db-common",
-  "version": "1.1.8",
+  "version": "1.3.1",
   "description": "Backend DB Common",
   "repository": {
     "type": "git",
@@ -64,10 +64,10 @@
     }
   },
   "dependencies": {
-    "@leyyo/common": "^1.2.4",
-    "@leyyo/query": "^1.2.2",
-    "@leyyo/type": "^1.1.1",
-    "@samet-it/be-base-common": "^1.1.5",
-    "@samet-it/be-cache-common": "^1.1.10"
+    "@leyyo/common": "^1.3.7",
+    "@leyyo/query": "^1.3.1",
+    "@leyyo/type": "^1.3.3",
+    "@samet-it/be-base-common": "^1.3.1",
+    "@samet-it/be-cache-common": "^1.3.1"
   }
 }