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

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

@@ -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

@@ -56,9 +56,18 @@ class DbRepo {
         if ((0, type_1.isObjectBare)(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 +108,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 +180,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 +237,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 +261,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}`;
     }

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

@@ -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.1.9",
   "description": "Backend DB Common",
   "repository": {
     "type": "git",