@samet-it/be-db-common 1.1.1 → 1.1.3

package/dist/repo/db.repo.js

@@ -11,15 +11,34 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 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 query_1 = require("@leyyo/query");
 const type_1 = require("@leyyo/type");
 const error_1 = require("../error");
 // noinspection JSUnusedGlobalSymbols
 /**
  * DB repository abstract class
+ *
+ * Generics:
+ * - 0-`CONN`: db connection {@link DbConnectionBase}
+ * - 1-`OPT`: db execution options {@link DbExecOpt}
+ * - 2-`ENT`: entity {@link Entity}
+ * - 3-`ID`: id type {@link KeyValue}
+ * - 4-`URN`: urn interface {@link UrnDocLike}
+ * - 5-`VIEW`: view interface for presentation layer {@link View}
+ * - 6-`PAIR`: pair interface for presentation layer {@link Pair}
+ * - 7-`PORTION`: portion interface for presentation layer {@link Portion}
+ * - 8-`KEYS`: keys to autocomplete, def: keys of {@link Entity}
+ * - 9-`DIMS`: dimensions for presentation layer {@link DefDims}
  * */
 class DbRepo {
     // endregion protected-property
+    /**
+     * Constructor
+     *
+     * @param {DbConnectionBase} conn - db connection
+     * @param {DbRepoOpt} opt - options
+     * */
     constructor(conn, opt) {
         /**
          * Option of in-body usage in place of constructor param
@@ -91,7 +110,6 @@ class DbRepo {
         if (given.length < 1) {
             given.push(...def);
         }
-        this._removeFieldForForbidden(given, 'useSoftDelete', '_trashId');
         this._removeFieldForForbidden(given, 'useCreatedAt', 'createdAt');
         this._removeFieldForForbidden(given, 'useCreatedBy', 'createdBy');
         this._removeFieldForForbidden(given, 'useUpdatedAt', 'updatedAt');
@@ -226,6 +244,10 @@ class DbRepo {
         const { urnPrefix } = this._props;
         return (typeof key === 'string') && key.startsWith(urnPrefix + ':');
     }
+    _keyToUrn(key) {
+        const { urnPrefix } = this._props;
+        return `${urnPrefix}:${key}`;
+    }
     // endregion protected-method
     // region getter
     /** @inheritDoc */
@@ -233,19 +255,11 @@ class DbRepo {
         return this._props;
     }
     /** @inheritDoc */
-    get $def() {
-        return this;
-    }
-    /** @inheritDoc */
     $cast() {
         return this;
     }
     // endregion getter
     // region urn
-    _keyToUrn(key) {
-        const { urnPrefix } = this._props;
-        return `${urnPrefix}:${key}`;
-    }
     /** @inheritDoc */
     toUrn(urnRec) {
         const { urnPrefix, urnDelimiter } = this._props;
@@ -284,7 +298,7 @@ class DbRepo {
                     found = (yield cache.getByPrimary(key))[0];
                 }
                 catch (e) {
-                    this.logger.warn(`getByPrimary.cache.getByPrimary <${e.name}> ${e.message}`);
+                    this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'getByPrimary', 'cache', 'getByPrimary'));
                 }
                 if (found) {
                     return found;
@@ -294,7 +308,7 @@ class DbRepo {
             if (found && cache.props.isConnected) {
                 cache.ingestDoc(found)
                     .then()
-                    .catch(e => this.logger.warn(`getByPrimary.cache.ingestDoc <${e.name}> ${e.message}`));
+                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'getByPrimary', 'cache', 'ingestDoc')));
             }
             return found;
         });
@@ -323,14 +337,14 @@ class DbRepo {
                     }
                 }
                 catch (e) {
-                    this.logger.warn(`getBySecondary.cache.getBySecondary <${e.name}> ${e.message}`);
+                    this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'getBySecondary', 'cache', 'getBySecondary'));
                 }
             }
             found = yield this.$getBySecondary(key, p1, true);
             if (found && cache.props.isConnected) {
                 cache.ingestDoc(found)
                     .then()
-                    .catch(e => this.logger.warn(`getBySecondary.cache.ingestDoc <${e.name}> ${e.message}`));
+                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'getBySecondary', 'cache', 'ingestDoc')));
             }
             return found;
         });
@@ -367,7 +381,7 @@ class DbRepo {
                     }
                 }
                 catch (e) {
-                    this.logger.warn(`existsByPrimary.cache.existsByPrimary <${e.name}> ${e.message}`);
+                    this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'existsByPrimary', 'cache', 'getByPrimary'));
                 }
             }
             return this.$existsByPrimary(key, p1, true);
@@ -396,7 +410,7 @@ class DbRepo {
                     }
                 }
                 catch (e) {
-                    this.logger.warn(`existsBySecondary.cache.existsBySecondary <${e.name}> ${e.message}`);
+                    this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'existsBySecondary', 'cache', 'getBySecondary'));
                 }
             }
             return this.$existsBySecondary(key, p1, true);
@@ -424,7 +438,7 @@ class DbRepo {
                         founds = yield cache.getByPrimary(...result.urns);
                     }
                     catch (e) {
-                        this.logger.warn(`list.cache.getByPrimary <${e.name}> ${e.message}`);
+                        this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'list', 'cache', 'getByPrimary'));
                     }
                     founds.forEach(val => {
                         const index = result.urns.indexOf(val._urn);
@@ -440,7 +454,7 @@ class DbRepo {
                         if (cache.props.isConnected) {
                             founds.forEach(found => cache.ingestDoc(found)
                                 .then()
-                                .catch(e => this.logger.warn(`list.cache.ingestDoc <${e.name}> ${e.message}`)));
+                                .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'list', 'cache', 'ingestDoc'))));
                         }
                         docs.push(...founds);
                     }
@@ -452,7 +466,7 @@ class DbRepo {
                         founds = yield cache.getBySecondary(...result.ids);
                     }
                     catch (e) {
-                        this.logger.warn(`list.cache.getBySecondary <${e.name}> ${e.message}`);
+                        this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'list', 'cache', 'getBySecondary'));
                     }
                     founds.forEach(val => {
                         const index = result.ids.indexOf(val.id);
@@ -468,7 +482,7 @@ class DbRepo {
                         if (cache.props.isConnected) {
                             founds.forEach(found => cache.ingestDoc(found)
                                 .then()
-                                .catch(e => this.logger.warn(`list.cache.ingestDoc <${e.name}> ${e.message}`)));
+                                .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'list', 'cache', 'ingestDoc'))));
                         }
                         docs.push(...founds);
                     }
@@ -492,7 +506,10 @@ class DbRepo {
     /** @inheritDoc */
     insert(doc, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { useCreatedAt, useNumericId, useCreatedBy, useUpdatedAt, useUpdatedBy } = this._props;
+            const { useCreatedAt, noInsert, useNumericId, useCreatedBy, useUpdatedAt, useUpdatedBy } = this._props;
+            if (noInsert) {
+                throw new error_1.DbNotSupportedError('Insert', 'DbRepo', 'insert');
+            }
             if (!ignoreCheck) {
                 (0, type_1.assertObject)(doc, { field: 'doc', where: 'DbRepo', method: 'insert' });
                 if (useNumericId) {
@@ -524,6 +541,10 @@ class DbRepo {
     /** @inheritDoc */
     inserts(docs, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
+            const { noInsert } = this._props;
+            if (noInsert) {
+                throw new error_1.DbNotSupportedError('Insert', 'DbRepo', 'inserts');
+            }
             if (!ignoreCheck) {
                 (0, type_1.assertArray)(docs, { field: 'docs', where: 'DbRepo', method: 'inserts' });
             }
@@ -544,10 +565,10 @@ class DbRepo {
                 (0, type_1.assertObject)(doc, { field: 'doc', where: 'DbRepo', method: 'replace' });
                 (0, type_1.assertText)(doc._urn, { field: 'doc._urn', where: 'DbRepo', method: 'replace' });
                 if (useNumericId) {
-                    (0, type_1.assertInteger)(doc.id, { field: 'doc.id', where: 'DbRepo', method: 'insert' });
+                    (0, type_1.assertInteger)(doc.id, { field: 'doc.id', where: 'DbRepo', method: 'replace' });
                 }
                 else {
-                    (0, type_1.assertText)(doc.id, { field: 'doc.id', where: 'DbRepo', method: 'insert' });
+                    (0, type_1.assertText)(doc.id, { field: 'doc.id', where: 'DbRepo', method: 'replace' });
                 }
             }
             if (doc._trashId !== undefined) {
@@ -559,16 +580,53 @@ class DbRepo {
             if (useUpdatedBy) {
                 // todo
             }
-            const replacedId = yield this.$replace(doc, p1, true);
+            const replacedKey = yield this.$replace(doc, p1, true);
             if (cache.props.isConnected) {
-                cache.clearDoc(replacedId)
+                cache.clearDoc(replacedKey)
                     .then()
-                    .catch(e => this.logger.warn(`replace.cache.clearDoc <${e.name}> ${e.message}`));
+                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'replace', 'cache', 'clearDoc')));
             }
-            return replacedId;
+            return replacedKey;
         });
     }
     // endregion replace
+    // region upsert
+    /** @inheritDoc */
+    upsert(doc, p1, ignoreCheck) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { noInsert, noUpdate, cache, useNumericId, useUpdatedAt, useUpdatedBy } = this._props;
+            if (noInsert || noUpdate) {
+                throw new error_1.DbNotSupportedError('Upsert', 'DbRepo', 'upsert');
+            }
+            if (!ignoreCheck) {
+                (0, type_1.assertObject)(doc, { field: 'doc', where: 'DbRepo', method: 'upsert' });
+                (0, type_1.assertText)(doc._urn, { field: 'doc._urn', where: 'DbRepo', method: 'upsert' });
+                if (useNumericId) {
+                    (0, type_1.assertInteger)(doc.id, { field: 'doc.id', where: 'DbRepo', method: 'upsert' });
+                }
+                else {
+                    (0, type_1.assertText)(doc.id, { field: 'doc.id', where: 'DbRepo', method: 'upsert' });
+                }
+            }
+            if (doc._trashId !== undefined) {
+                delete doc._trashId;
+            }
+            if (useUpdatedAt) {
+                doc.updatedAt = this._now;
+            }
+            if (useUpdatedBy) {
+                // todo
+            }
+            const createdKey = yield this.$replace(doc, p1, true);
+            if (cache.props.isConnected) {
+                cache.clearDoc(createdKey)
+                    .then()
+                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'upsert', 'cache', 'clearDoc')));
+            }
+            return createdKey;
+        });
+    }
+    // endregion upsert
     // region update
     /** @inheritDoc */
     update(k1, doc, p1, ignoreCheck) {
@@ -590,7 +648,10 @@ class DbRepo {
     /** @inheritDoc */
     updateByPrimary(key, doc, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { forbiddenSet, cache, useUpdatedAt, useUpdatedBy } = this._props;
+            const { noUpdate, forbiddenSet, cache, useUpdatedAt, useUpdatedBy } = this._props;
+            if (noUpdate) {
+                throw new error_1.DbNotSupportedError('Update', 'DbRepo', 'updateByPrimary');
+            }
             if (!ignoreCheck) {
                 (0, type_1.assertText)(key, { field: 'key', where: 'DbRepo', method: 'updateByPrimary' });
                 (0, type_1.assertObject)(doc, { field: 'doc', where: 'DbRepo', method: 'updateByPrimary' });
@@ -613,7 +674,7 @@ class DbRepo {
             if (updatedKey && cache.props.isConnected) {
                 cache.clearDoc(updatedKey)
                     .then()
-                    .catch(e => this.logger.warn(`updateByPrimary.cache.clearDoc <${e.name}> ${e.message}`));
+                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'updateByPrimary', 'cache', 'clearDoc')));
             }
             return updatedKey;
         });
@@ -621,7 +682,10 @@ class DbRepo {
     /** @inheritDoc */
     updateBySecondary(key, doc, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { forbiddenSet, cache, useNumericId, idSame, useUpdatedAt, useUpdatedBy } = this._props;
+            const { forbiddenSet, noUpdate, cache, useNumericId, idSame, useUpdatedAt, useUpdatedBy } = this._props;
+            if (noUpdate) {
+                throw new error_1.DbNotSupportedError('Update', 'DbRepo', 'updateBySecondary');
+            }
             if (!ignoreCheck) {
                 if (useNumericId) {
                     (0, type_1.assertInteger)(key, { field: 'key', where: 'DbRepo', method: 'getBySecondary' });
@@ -652,7 +716,7 @@ class DbRepo {
             if (updatedKey && cache.props.isConnected) {
                 cache.clearDoc(updatedKey)
                     .then()
-                    .catch(e => this.logger.warn(`updateBySecondary.cache.clearDoc <${e.name}> ${e.message}`));
+                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'updateBySecondary', 'cache', 'clearDoc')));
             }
             return updatedKey;
         });
@@ -711,7 +775,10 @@ class DbRepo {
     /** @inheritDoc */
     removeByPrimary(key, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { cache } = this._props;
+            const { cache, noRemove } = this._props;
+            if (noRemove) {
+                throw new error_1.DbNotSupportedError('Remove', 'DbRepo', 'removeByPrimary');
+            }
             if (!ignoreCheck) {
                 (0, type_1.assertText)(key, { field: 'key', where: 'DbRepo', method: 'removeByPrimary' });
             }
@@ -719,7 +786,7 @@ class DbRepo {
             if (removedKey && cache.props.isConnected) {
                 cache.clearDoc(removedKey)
                     .then()
-                    .catch(e => this.logger.warn(`removeByPrimary.cache.clearDoc <${e.name}> ${e.message}`));
+                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'removeByPrimary', 'cache', 'clearDoc')));
             }
             return removedKey;
         });
@@ -727,7 +794,10 @@ class DbRepo {
     /** @inheritDoc */
     removeBySecondary(key, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { cache, useNumericId, idSame } = this._props;
+            const { cache, noRemove, useNumericId, idSame } = this._props;
+            if (noRemove) {
+                throw new error_1.DbNotSupportedError('Remove', 'DbRepo', 'removeByPrimary');
+            }
             if (useNumericId) {
                 (0, type_1.assertInteger)(key, { field: 'key', where: 'DbRepo', method: 'removeBySecondary' });
             }
@@ -741,7 +811,7 @@ class DbRepo {
             if (removedKey && cache.props.isConnected) {
                 cache.clearDoc(removedKey)
                     .then()
-                    .catch(e => this.logger.warn(`removeBySecondary.cache.clearDoc <${e.name}> ${e.message}`));
+                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'removeBySecondary', 'cache', 'clearDoc')));
             }
             return removedKey;
         });
@@ -765,9 +835,9 @@ class DbRepo {
     /** @inheritDoc */
     trashByPrimary(key, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { useSoftDelete, conn, cache } = this._props;
-            if (!useSoftDelete) {
-                throw new error_1.DbNotSupportedError('Soft delete', 'DbRepo', 'trashByPrimary');
+            const { noTrash, conn, cache } = this._props;
+            if (noTrash) {
+                throw new error_1.DbNotSupportedError('Trash', 'DbRepo', 'trashByPrimary');
             }
             if (!ignoreCheck) {
                 (0, type_1.assertText)(key, { field: 'urn', where: 'DbRepo', method: 'trashByPrimary' });
@@ -780,7 +850,7 @@ class DbRepo {
             if (trashedKey && cache.props.isConnected) {
                 cache.clearDoc(trashedKey)
                     .then()
-                    .catch(e => this.logger.warn(`trashByPrimary.cache.clearDoc <${e.name}> ${e.message}`));
+                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'trashByPrimary', 'cache', 'clearDoc')));
             }
             return trashedKey;
         });
@@ -788,9 +858,9 @@ class DbRepo {
     /** @inheritDoc */
     trashBySecondary(key, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { useSoftDelete, useNumericId, idSame, conn, cache } = this._props;
-            if (!useSoftDelete) {
-                throw new error_1.DbNotSupportedError('Soft delete', 'DbRepo', 'trashBySecondary');
+            const { noTrash, useNumericId, idSame, conn, cache } = this._props;
+            if (noTrash) {
+                throw new error_1.DbNotSupportedError('Trash', 'DbRepo', 'trashBySecondary');
             }
             if (useNumericId) {
                 (0, type_1.assertInteger)(key, { field: 'key', where: 'DbRepo', method: 'trashBySecondary' });
@@ -809,7 +879,7 @@ class DbRepo {
             if (trashedKey && cache.props.isConnected) {
                 cache.clearDoc(trashedKey)
                     .then()
-                    .catch(e => this.logger.warn(`trashBySecondary.cache.clearDoc <${e.name}> ${e.message}`));
+                    .catch(e => this.logger.warn(be_base_common_1.errorHandler.common.logText(e, 'trashBySecondary', 'cache', 'clearDoc')));
             }
             return trashedKey;
         });