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

package/README.md

@@ -35,6 +35,12 @@ npm i @samet-it/be-db-common
 - [function dbLines()](./src/line/db-lines.impl.ts)
 - [abstract class DbRepo](./src/repo/db.repo.ts)
 
+## Errors
+- `base error` [DbError](./src/error/db.error.ts)
+- `execute error` [DbExecuteError](./src/error/db-execute.error.ts)
+- `invalid value error` [DbInvalidValueError](./src/error/db-invalid-value.error.ts)
+- `not supported error` [DbNotSupportedError](./src/error/db-not-supported.error.ts)
+
 ## Development
 > You can start to develop on it
 >

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

@@ -157,3 +157,14 @@ export type DbEvent = 'connected' | 'disconnected' | 'first-connected';
  * - It uses ASL
  * */
 export type UserFetcherLambda = () => Promise<KeyValue>;
+/**
+ * Db direct connection option
+ * */
+export interface DbConnDirectOpt extends DbConnOpt {
+    /**
+     * logger name
+     *
+     * @type {string}
+     * */
+    name?: string;
+}

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 _checkKeys(keys: Array<KeyValue>): DbCheckKeysResult<ID>;
     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>>;
@@ -145,7 +189,7 @@ export declare abstract class DbRepo<CONN extends DbConnectionLike, OPT extends
     /** @inheritDoc */
     $toUrnTuple(urnRec: URN): UrnTuple;
     /** @inheritDoc */
-    get(k1: KeyValue, p1?: OPT | string): Promise<ENT | undefined>;
+    get(keyLike: PORTION | KeyValue, p1?: OPT | string): Promise<ENT | undefined>;
     /** @inheritDoc */
     getByPrimary(key: string, p1?: OPT | string, ignoreCheck?: boolean): Promise<ENT | undefined>;
     /** @inheritDoc */
@@ -155,7 +199,7 @@ export declare abstract class DbRepo<CONN extends DbConnectionLike, OPT extends
     /** @inheritDoc */
     abstract $getBySecondary(key: KeyValue, p1?: OPT | string, ignoreCheck?: boolean): Promise<ENT | undefined>;
     /** @inheritDoc */
-    exists(k1: KeyValue, p1?: OPT | string): Promise<boolean>;
+    exists(keyLike: PORTION | KeyValue, p1?: OPT | string): Promise<boolean>;
     /** @inheritDoc */
     existsByPrimary(key: string, p1?: OPT | string, ignoreCheck?: boolean): Promise<boolean>;
     /** @inheritDoc */
@@ -165,7 +209,7 @@ export declare abstract class DbRepo<CONN extends DbConnectionLike, OPT extends
     /** @inheritDoc */
     abstract $existsBySecondary(key: KeyValue, p1?: OPT | string, ignoreCheck?: boolean): Promise<boolean>;
     /** @inheritDoc */
-    list(keys: Array<KeyValue>, p1?: OPT | string, ignoreCheck?: boolean): Promise<Array<ENT>>;
+    list(keyLikes: Array<PORTION | KeyValue>, p1?: OPT | string, ignoreCheck?: boolean): Promise<Array<ENT>>;
     /** @inheritDoc */
     abstract $listByPrimary(keys: string[], p1?: OPT | string, ignoreCheck?: boolean): Promise<Array<ENT>>;
     /** @inheritDoc */
@@ -189,7 +233,7 @@ export declare abstract class DbRepo<CONN extends DbConnectionLike, OPT extends
     /** @inheritDoc */
     abstract $upsert(doc: ENT, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    update(k1: KeyValue, doc: Partial<ENT>, p1?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    update(k1: PORTION | KeyValue, doc: Partial<ENT>, p1?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
     updateByPrimary(key: string, doc: Partial<ENT>, p1?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
@@ -199,11 +243,11 @@ export declare abstract class DbRepo<CONN extends DbConnectionLike, OPT extends
     /** @inheritDoc */
     abstract $updateBySecondary(key: KeyValue, doc: Partial<ENT>, p1?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    set(key: KeyValue, doc: Partial<ENT>, p1?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    set(key: PORTION | KeyValue, doc: Partial<ENT>, p1?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    unset(key: KeyValue, fields: Array<keyof ENT | KEYS | string>, p1?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    unset(key: PORTION | KeyValue, fields: Array<keyof ENT | KEYS | string>, p1?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    remove(k1: KeyValue, p1?: OPT | string): Promise<string>;
+    remove(keyLike: PORTION | KeyValue, p1?: OPT | string): Promise<string>;
     /** @inheritDoc */
     removeByPrimary(key: string, p1?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
@@ -213,7 +257,7 @@ export declare abstract class DbRepo<CONN extends DbConnectionLike, OPT extends
     /** @inheritDoc */
     abstract $removeBySecondary(key: KeyValue, p1?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    trash(k1: KeyValue, p1?: OPT | string): Promise<string>;
+    trash(keyLike: PORTION | KeyValue, p1?: OPT | string): Promise<string>;
     /** @inheritDoc */
     trashByPrimary(key: string, p1?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
@@ -225,24 +269,19 @@ export declare abstract class DbRepo<CONN extends DbConnectionLike, OPT extends
     /** @inheritDoc */
     $toDim<R extends IdDocLike<ID>>(doc: ENT, dim?: DIMS): Promise<R>;
     /** @inheritDoc */
-    getDim<R extends IdDocLike<ID>>(key: KeyValue, dim?: DIMS): Promise<R>;
-    /** @inheritDoc */
-    listDims<R extends IdDocLike<ID>>(keys: Array<KeyValue>, dim?: DIMS, ignoreCheck?: boolean): Promise<Array<R>>;
-    /** @inheritDoc */
-    $toPair(doc: ENT): Promise<PAIR>;
+    getDim<R extends IdDocLike<ID>>(key: PORTION | KeyValue, dim?: DIMS): Promise<R>;
     /** @inheritDoc */
-    getPair(key: KeyValue): Promise<PAIR>;
+    listDims<R extends IdDocLike<ID>>(keys: Array<PORTION | KeyValue>, dim?: DIMS, ignoreCheck?: boolean): Promise<Array<R>>;
     /** @inheritDoc */
-    listPairs(keys: Array<KeyValue>, ignoreCheck?: boolean): Promise<Array<PAIR>>;
-    $toView(doc: ENT): Promise<VIEW>;
+    getPair(key: PORTION | KeyValue): Promise<PAIR>;
     /** @inheritDoc */
-    getView(identifier: string): Promise<VIEW>;
+    listPairs(keys: Array<PORTION | KeyValue>, ignoreCheck?: boolean): Promise<Array<PAIR>>;
     /** @inheritDoc */
-    listViews(identifiers: Array<string>, ignoreCheck?: boolean): Promise<Array<VIEW>>;
+    getView(key: PORTION | KeyValue): Promise<VIEW>;
     /** @inheritDoc */
-    $toPortion(doc: ENT): Promise<PORTION>;
+    listViews(keys: Array<PORTION | KeyValue>, ignoreCheck?: boolean): Promise<Array<VIEW>>;
     /** @inheritDoc */
-    getPortion(identifier: string): Promise<PORTION>;
+    getPortion(key: PORTION | KeyValue): Promise<PORTION>;
     /** @inheritDoc */
-    listPortions(identifiers: Array<string>, ignoreCheck?: boolean): Promise<Array<PORTION>>;
+    listPortions(keys: Array<PORTION | KeyValue>, ignoreCheck?: boolean): Promise<Array<PORTION>>;
 }

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) {
@@ -182,18 +225,21 @@ class DbRepo {
                     return [undefined, undefined];
                 }
                 const obj = value;
-                if (obj.id !== undefined) {
-                    return this._checkKey(obj.id);
-                }
                 if (obj.urn !== undefined) {
                     return this._checkKey(obj.urn);
                 }
+                if (obj.id !== undefined) {
+                    return this._checkKey(obj.id);
+                }
                 break;
         }
         return [undefined, undefined];
     }
     /**
      * 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}`;
     }
@@ -345,6 +403,10 @@ class DbRepo {
     }
     /** @inheritDoc */
     get urnLength() {
+        var _a, _b;
+        if (!this._props.urnLength) {
+            this._props.urnLength = (_b = (_a = this._props.urnPrefix) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0;
+        }
         return this._props.urnLength;
     }
     // endregion getter
@@ -443,17 +505,17 @@ class DbRepo {
     // endregion urn
     // region get
     /** @inheritDoc */
-    get(k1, p1) {
+    get(keyLike, p1) {
         return __awaiter(this, void 0, void 0, function* () {
             const opt = this.buildOpt(p1, 'get');
-            const [key, field] = this._checkKey(k1);
+            const [key, field] = this._checkKey(keyLike);
             switch (field) {
                 case "urn":
                     return this.getByPrimary(key, opt, true);
                 case "id":
                     return this.getBySecondary(key, opt, true);
                 default:
-                    (0, type_1.assertMessage)('Invalid key', { field: 'key', value: k1, where: 'DbRepo', method: 'get', queryName: opt.name });
+                    (0, type_1.assertMessage)('Invalid key', { field: 'key', value: keyLike, where: 'DbRepo', method: 'get', queryName: opt.name });
             }
         });
     }
@@ -524,17 +586,17 @@ class DbRepo {
     // endregion get
     // region exists
     /** @inheritDoc */
-    exists(k1, p1) {
+    exists(keyLike, p1) {
         return __awaiter(this, void 0, void 0, function* () {
             const opt = this.buildOpt(p1, 'exists');
-            const [key, field] = this._checkKey(k1);
+            const [key, field] = this._checkKey(keyLike);
             switch (field) {
                 case "urn":
                     return this.existsByPrimary(key, opt, true);
                 case "id":
                     return this.existsBySecondary(key, opt, true);
                 default:
-                    (0, type_1.assertMessage)('Invalid key', { field: 'key', value: k1, where: 'DbRepo', method: 'exists', queryName: opt.name });
+                    (0, type_1.assertMessage)('Invalid key', { field: 'key', value: keyLike, where: 'DbRepo', method: 'exists', queryName: opt.name });
                     break;
             }
         });
@@ -592,13 +654,13 @@ class DbRepo {
     // endregion exists
     // region list
     /** @inheritDoc */
-    list(keys, p1, ignoreCheck) {
+    list(keyLikes, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
             const opt = this.buildOpt(p1, 'list');
             if (!ignoreCheck) {
-                (0, type_1.assertArray)(keys, { field: 'keys', where: 'DbRepo', method: 'list', queryName: opt.name });
+                (0, type_1.assertArray)(keyLikes, { field: 'keys', where: 'DbRepo', method: 'list', queryName: opt.name });
             }
-            const result = this._checkKeys(keys);
+            const result = this._checkKeys(keyLikes);
             if (result.ordered.length < 1) {
                 return [];
             }
@@ -944,17 +1006,17 @@ class DbRepo {
     // endregion set
     // region remove
     /** @inheritDoc */
-    remove(k1, p1) {
+    remove(keyLike, p1) {
         return __awaiter(this, void 0, void 0, function* () {
             const opt = this.buildOpt(p1, 'remove');
-            const [key, field] = this._checkKey(k1);
+            const [key, field] = this._checkKey(keyLike);
             switch (field) {
                 case "urn":
                     return this.removeByPrimary(key, opt, true);
                 case "id":
                     return this.removeBySecondary(key, opt, true);
                 default:
-                    (0, type_1.assertMessage)('Invalid key', { field: 'key', value: k1, where: 'DbRepo', method: 'remove', queryName: opt.name });
+                    (0, type_1.assertMessage)('Invalid key', { field: 'key', value: keyLike, where: 'DbRepo', method: 'remove', queryName: opt.name });
             }
         });
     }
@@ -1007,17 +1069,17 @@ class DbRepo {
     // endregion remove
     // region trash
     /** @inheritDoc */
-    trash(k1, p1) {
+    trash(keyLike, p1) {
         return __awaiter(this, void 0, void 0, function* () {
             const opt = this.buildOpt(p1, 'trash');
-            const [key, field] = this._checkKey(k1);
+            const [key, field] = this._checkKey(keyLike);
             switch (field) {
                 case "urn":
                     return this.trashByPrimary(key, opt, true);
                 case "id":
                     return this.trashBySecondary(key, opt, true);
                 default:
-                    (0, type_1.assertMessage)('Invalid key', { field: 'key', value: k1, where: 'DbRepo', method: 'trash', queryName: opt.name });
+                    (0, type_1.assertMessage)('Invalid key', { field: 'key', value: keyLike, where: 'DbRepo', method: 'trash', queryName: opt.name });
             }
         });
     }
@@ -1088,14 +1150,17 @@ class DbRepo {
                 return undefined;
             }
             switch (dim) {
-                case "portion":
-                    return yield this.$toPortion(doc);
                 case "view":
-                    return yield this.$toView(doc);
+                    return doc;
                 case "pair":
-                    return yield this.$toPair(doc);
-                default:
-                    return yield this.$toPortion(doc);
+                    return { id: doc.id, name: doc.name };
+                default: // portion
+                    if (this.isIdSame) {
+                        return { id: doc.id };
+                    }
+                    else {
+                        return { id: doc.id, urn: doc.urn };
+                    }
             }
         });
     }
@@ -1123,15 +1188,6 @@ class DbRepo {
     // endregion dim
     // region pair
     /** @inheritDoc */
-    $toPair(doc) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!doc) {
-                return undefined;
-            }
-            return { id: doc === null || doc === void 0 ? void 0 : doc.id, name: doc === null || doc === void 0 ? void 0 : doc.name };
-        });
-    }
-    /** @inheritDoc */
     getPair(key) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.getDim(key, 'pair');
@@ -1145,44 +1201,30 @@ class DbRepo {
     }
     // endregion pair
     // region view
-    $toView(doc) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return doc;
-        });
-    }
     /** @inheritDoc */
-    getView(identifier) {
+    getView(key) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.getDim(identifier, 'view');
+            return this.getDim(key, 'view');
         });
     }
     /** @inheritDoc */
-    listViews(identifiers, ignoreCheck) {
+    listViews(keys, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.listDims(identifiers, 'view', ignoreCheck);
+            return this.listDims(keys, 'view', ignoreCheck);
         });
     }
     // endregion view
     // region portion
     /** @inheritDoc */
-    $toPortion(doc) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!doc) {
-                return undefined;
-            }
-            return { id: doc === null || doc === void 0 ? void 0 : doc.id };
-        });
-    }
-    /** @inheritDoc */
-    getPortion(identifier) {
+    getPortion(key) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.getDim(identifier, 'portion');
+            return this.getDim(key, 'portion');
         });
     }
     /** @inheritDoc */
-    listPortions(identifiers, ignoreCheck) {
+    listPortions(keys, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.listDims(identifiers, 'portion', ignoreCheck);
+            return this.listDims(keys, 'portion', ignoreCheck);
         });
     }
 }

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

@@ -1,5 +1,5 @@
-import type { DefDims, Entity, IdDocLike, Pair, Portion, UrnDocLike, UrnTuple, View } from "@samet-it/be-base-common";
-import { DbConnectionLike, UserFetcherLambda } from "../connection";
+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";
@@ -255,12 +255,12 @@ export interface DbRepoLike<CONN extends DbConnectionLike, OPT extends DbExecOpt
     /**
      * Get document by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @return {Promise<Entity?>} - document
      * @async
      * */
-    get(key: KeyValue, opt?: OPT | string): Promise<ENT | undefined>;
+    get(key: PORTION | KeyValue, opt?: OPT | string): Promise<ENT | undefined>;
     /**
      * Get document by primary key
      *
@@ -304,12 +304,12 @@ export interface DbRepoLike<CONN extends DbConnectionLike, OPT extends DbExecOpt
     /**
      * Document exists by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @return {Promise<boolean>} - exists or not
      * @async
      * */
-    exists(key: KeyValue, opt?: OPT | string): Promise<boolean>;
+    exists(key: PORTION | KeyValue, opt?: OPT | string): Promise<boolean>;
     /**
      * Document exists by primary key
      *
@@ -353,13 +353,13 @@ export interface DbRepoLike<CONN extends DbConnectionLike, OPT extends DbExecOpt
     /**
      * List documents by keys (primary or secondary)
      *
-     * @param {Array<KeyValue>} keys - primary or secondary keys
+     * @param {Array<Portion|KeyValue>} keys - primary or secondary keys
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<Array<Entity>>} - documents
      * @async
      * */
-    list(keys: Array<KeyValue>, opt?: OPT | string, ignoreCheck?: boolean): Promise<Array<ENT>>;
+    list(keys: Array<PORTION | KeyValue>, opt?: OPT | string, ignoreCheck?: boolean): Promise<Array<ENT>>;
     /**
      * List documents by primary keys
      *
@@ -464,14 +464,14 @@ export interface DbRepoLike<CONN extends DbConnectionLike, OPT extends DbExecOpt
     /**
      * Update document by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {Entity} doc - document
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<string>}
      * @async
      * */
-    update(key: KeyValue, doc: Partial<ENT>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    update(key: PORTION | KeyValue, doc: Partial<ENT>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /**
      * Update document by primary key
      *
@@ -519,33 +519,33 @@ export interface DbRepoLike<CONN extends DbConnectionLike, OPT extends DbExecOpt
     /**
      * Set document with partial data by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {Partial<Entity>} doc - partial entity will be set
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<string>}
      * @async
      * */
-    set(key: KeyValue, doc: Partial<ENT>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    set(key: PORTION | KeyValue, doc: Partial<ENT>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /**
      * Unset document for given fields
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {Array<string>} fields - fields will be unset
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<string>}
      * @async
      * */
-    unset(key: KeyValue, fields: Array<keyof ENT | KEYS | string>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    unset(key: PORTION | KeyValue, fields: Array<keyof ENT | KEYS | string>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
     /**
      * Remove document (hard delete) by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @async
      * */
-    remove(key: KeyValue, opt?: OPT | string): Promise<string>;
+    remove(key: PORTION | KeyValue, opt?: OPT | string): Promise<string>;
     /**
      * Remove document by primary key (hard delete)
      *
@@ -585,11 +585,11 @@ export interface DbRepoLike<CONN extends DbConnectionLike, OPT extends DbExecOpt
     /**
      * Trash document (soft delete) by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {(opt?: OPT|string)?} opt - option or query name
      * @async
      * */
-    trash(key: KeyValue, opt?: OPT | string): Promise<string>;
+    trash(key: PORTION | KeyValue, opt?: OPT | string): Promise<string>;
     /**
      * Trash document by primary key (soft delete)
      *
@@ -644,64 +644,48 @@ export interface DbRepoLike<CONN extends DbConnectionLike, OPT extends DbExecOpt
      * Generics
      * - 0-`R`: dim interface {@link IdDocLike}
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @param {string?} dim - dimension, default: `def`
      * @return {Promise<IdDocLike>} - dim object
      * @async
      * */
-    getDim<R extends IdDocLike<ID>>(key: KeyValue, dim?: DIMS): Promise<R>;
+    getDim<R extends IdDocLike<ID>>(key: PORTION | KeyValue, dim?: DIMS): Promise<R>;
     /**
      * List dims by keys (primary or secondary)
      *
      * Generics
      * - 0-`R`: dim interface {@link IdDocLike}
      *
-     * @param {Array<string>} keys - primary or secondary keys
+     * @param {Array<Portion|KeyValue>} keys - primary or secondary keys
      * @param {string?} dim - dimension, default: `def`
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<Array<IdDocLike>>} - dim objects
      * */
-    listDims<R extends IdDocLike<ID>>(keys: Array<KeyValue>, dim?: DIMS, ignoreCheck?: boolean): Promise<Array<R>>;
-    /**
-     * Set pair by document
-     *
-     * @param {Entity} doc - document
-     * @return {Promise<Pair>} - pair object
-     * @async
-     * */
-    $toPair(doc: ENT): Promise<PAIR>;
+    listDims<R extends IdDocLike<ID>>(keys: Array<PORTION | KeyValue>, dim?: DIMS, ignoreCheck?: boolean): Promise<Array<R>>;
     /**
      * Get pair by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @return {Promise<Pair>} - pair object
      * @async
      * */
-    getPair(key: KeyValue): Promise<PAIR>;
+    getPair(key: PORTION | KeyValue): Promise<PAIR>;
     /**
      * List pairs by keys (primary or secondary)
      *
-     * @param {Array<KeyValue>} keys - primary or secondary keys
+     * @param {Array<Portion|KeyValue>} keys - primary or secondary keys
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<Array<Pair>>} - pair objects
      * */
-    listPairs(keys: Array<KeyValue>, ignoreCheck?: boolean): Promise<Array<PAIR>>;
-    /**
-     * Set view by document
-     *
-     * @param {Entity} doc - document
-     * @return {Promise<View>} - view object
-     * @async
-     * */
-    $toView(doc: ENT): Promise<VIEW>;
+    listPairs(keys: Array<PORTION | KeyValue>, ignoreCheck?: boolean): Promise<Array<PAIR>>;
     /**
      * Get view by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @return {Promise<View>} - view object
      * @async
      * */
-    getView(key: KeyValue): Promise<VIEW>;
+    getView(key: PORTION | KeyValue): Promise<VIEW>;
     /**
      * List views by keys (primary or secondary)
      *
@@ -710,30 +694,22 @@ export interface DbRepoLike<CONN extends DbConnectionLike, OPT extends DbExecOpt
      * @return {Promise<Array<View>>} - view objects
      * */
     listViews(keys: Array<KeyValue>, ignoreCheck?: boolean): Promise<Array<VIEW>>;
-    /**
-     * Set portion by document
-     *
-     * @param {Entity} doc - document
-     * @return {Promise<Portion>} - portion object
-     * @async
-     * */
-    $toPortion(doc: ENT): Promise<PORTION>;
     /**
      * Get portion by key (primary or secondary)
      *
-     * @param {KeyValue} key - primary or secondary key
+     * @param {Portion|KeyValue} key - primary or secondary key
      * @return {Promise<Portion>} - portion object
      * @async
      * */
-    getPortion(key: KeyValue): Promise<PORTION>;
+    getPortion(key: PORTION | KeyValue): Promise<PORTION>;
     /**
      * List portions by key (primary or secondary)
      *
-     * @param {Array<KeyValue>} keys - primary or secondary keys
+     * @param {Array<Portion|KeyValue>} keys - primary or secondary keys
      * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<Array<Portion>>} - portion objects
      * */
-    listPortions(keys: Array<KeyValue>, ignoreCheck?: boolean): Promise<Array<PORTION>>;
+    listPortions(keys: Array<PORTION | KeyValue>, ignoreCheck?: boolean): Promise<Array<PORTION>>;
 }
 /**
  * DB repository option
@@ -978,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
@@ -1036,14 +1016,17 @@ export type DbRepoToUrnTuple<URN extends UrnDocLike = UrnDocLike> = (urnRec: URN
 export type DbRepoToDim<R, ENT extends Entity<ID>, ID extends KeyValue, DIMS extends DefDims = DefDims> = (doc: ENT, dim: DIMS | undefined) => Promise<R>;
 /**
  * Default model which contains keys
+ *
+ * Generics:
+ * - 0-`ID`: id type {@link KeyValue}
  * */
-export interface DbIdLike {
+export interface DbIdLike<ID extends KeyValue = KeyValue> {
     /**
      * Secondary key for an entity
      *
      * @type {KeyValue}
      */
-    id?: KeyValue;
+    id?: ID;
     /**
      * Primary key for an entity
      *
@@ -1106,6 +1089,10 @@ export interface DbExecOpt extends Opt {
 }
 /**
  * DB query result as a row
+ *
+ * Generics:
+ * - 0-`E`: result model, it will be row type
+ * - 1-`META`: query result metadata {@link DbMeta}
  * */
 export interface DbQueryResultOne<E = any, META extends DbMeta = DbMeta> extends DbQueryResult<META> {
     /**
@@ -1115,6 +1102,10 @@ export interface DbQueryResultOne<E = any, META extends DbMeta = DbMeta> extends
 }
 /**
  * DB query result as rows
+ *
+ * Generics:
+ * - 0-`E`: result model, it will be rows item type, `rows: E[]`
+ * - 1-`META`: query result metadata {@link DbMeta}
  * */
 export interface DbQueryResultMore<E = any, META extends DbMeta = DbMeta> extends DbQueryResult<META> {
     /**
@@ -1125,7 +1116,8 @@ export interface DbQueryResultMore<E = any, META extends DbMeta = DbMeta> extend
 /**
  * DB query result
  *
- * Generics
+ * Generics:
+ * - 0-`META`: query result metadata {@link DbMeta}
  * */
 export interface DbQueryResult<META> {
     /**
@@ -1141,3 +1133,31 @@ export interface DbQueryResult<META> {
      */
     error?: OmitError;
 }
+/**
+ * Couchbase direct repository (collection) option
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
+ * - 2-`URN`: urn interface {@link UrnDocLike}
+ * - 3-`DIMS`: dimensions for presentation layer {@link DefDims}
+ * - 4-`R`: ??
+ * */
+export interface DbRepoDirectOpt<ENT extends Entity<ID>, ID extends KeyValue = KeyValue, URN extends UrnDocLike = UrnDef<ID>, DIMS extends DefDims = DefDims, R = unknown> extends DbRepoOpt<ENT, ID> {
+    /**
+     * Name of logger class
+     * */
+    name?: string;
+    /**
+     * Overridable method to easy use
+     * */
+    $toUrnTuple?: DbRepoToUrnTuple<URN>;
+    /**
+     * Overridable method to easy use
+     * */
+    $toDim?: DbRepoToDim<R, ENT, ID, DIMS>;
+    /**
+     * Indexed fields
+     * */
+    indexedFields?: Array<keyof ENT | string>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@samet-it/be-db-common",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "description": "Backend DB Common",
   "repository": {
     "type": "git",