@futdevpro/nts-dynamo 1.7.16 → 1.7.20

package/src/_services/base/data.service.ts

@@ -1,5 +1,7 @@
 
-import { Dynamo_Metadata, Dynamo_DataParams, Dynamo_DataPropertyParams, Dynamo_Error, Dynamo_Log } from '@futdevpro/fsm-dynamo';
+import { 
+  Dynamo_Metadata, Dynamo_DataParams, Dynamo_DataPropertyParams, Dynamo_Error, Dynamo_Log 
+} from '@futdevpro/fsm-dynamo';
 import { DynamoNTS_DBFilter } from '../../_models/types/db-filter.type';
 import { DynamoNTS_DBUpdate } from '../../_models/types/db-update.type';
 
@@ -70,7 +72,14 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       this.lookForDependencyDataSettings();
       this.issuer = issuer;
     } catch (error) {
-      Dynamo_Log.error(`\nDynamoNTS_DataService ERROR, The dataService construction failed for ${dataParams?.dataName}. ${this.serviceName}`, new Error());
+      Dynamo_Log.error(
+        `\nDynamoNTS_DataService ERROR: ` +
+        `\nThe dataService construction failed for ` +
+        `${dataParams?.dataName}. ${this.serviceName} (${this.constructor.name})` +
+        `\nMaybe you forgot to add the dbService to the GlobalService?` +
+        `\n\n`, 
+        new Error()
+      );
     }
   }
 
@@ -79,14 +88,16 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
    */
   async getAll(dontSetToService?: boolean): Promise<T[]> {
     try {
-      const dataListExists: T[] = await this.dataDBService.getAll().catch(error => {
+      const dataListExists: T[] = await this.dataDBService.getAll().catch((error): T[] => {
         if (error?.errorCode === 'NTS-DBS-GA1') {
           Dynamo_Log.warn(`getAll ${this.dataParams.dataName} didn't found any.`);
+
           return [];
         } else {
           throw error;
         }
       });
+
       if (!dontSetToService) {
         this.dataList = dataListExists;
       }
@@ -123,7 +134,11 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         throw new Dynamo_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataById', 
-            new Error(`getDataById failed, ID is missing! (maybe you wanted to use getDataByDependencyId() instead...) (${this.dataParams.dataName})`)
+            new Error(
+              `getDataById failed, ID is missing! ` +
+              `(maybe you wanted to use getDataByDependencyId() instead...) ` +
+              `(${this.dataParams.dataName})`
+            )
           ),
           
           errorCode: 'NTS-DS0-GI1',
@@ -131,6 +146,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       }
 
       const dataExists: T = await this.dataDBService.getDataById(id ?? this.data._id);
+
       if (!dontSetToService) {
         this.data = dataExists;
       }
@@ -142,7 +158,6 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       } else {
         throw new Dynamo_Error({ 
           ...this._getDefaultErrorSettings('getDataById', error),
-
           errorCode: 'NTS-DS0-GI0',
         });
       }
@@ -167,6 +182,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       }
 
       const datas: T[] = await this.dataDBService.find({ _id: { $in: ids, }, });
+
       if (!dontSetToService) {
         this.dataList = datas;
       }
@@ -192,7 +208,10 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         throw new Dynamo_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataByDependencyId',
-            new Error(`getDataByDependencyId failed, dependencyKey is missing from service! (${this.dataParams.dataName})`)
+            new Error(
+              `getDataByDependencyId failed, dependencyKey is missing from service! ` +
+              `(${this.dataParams.dataName})`
+            )
           ),
           
           errorCode: 'NTS-DS0-GD1',
@@ -203,21 +222,31 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         throw new Dynamo_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataByDependencyId',
-            new Error(`getDataByDependencyId failed, ${this.depKey} is missing! (${this.dataParams.dataName})`)
+            new Error(
+              `getDataByDependencyId failed, ${this.depKey} is missing! ` +
+              `(${this.dataParams.dataName})`
+            )
           ),
           
           errorCode: 'NTS-DS0-GD2',
         });
       }
 
-      const dataExists: T = await this.dataDBService.getDataByDependencyId(dependencyId ?? this.data[this.depKey]).catch(error => {
+      const dataExists: T = await this.dataDBService.getDataByDependencyId(
+        dependencyId ?? this.data[this.depKey]
+      ).catch((error): null => {
         if (error?.errorCode === 'NTS-DBS-GD2') {
-          Dynamo_Log.warn(`getDataByDependencyId failed; ${this.dataParams.dataName} (${this.depKey}: ${dependencyId ?? this.data[this.depKey]}) didn't found any.`);
+          Dynamo_Log.warn(
+            `getDataByDependencyId failed; ${this.dataParams.dataName} ` +
+            `(${this.depKey}: ${dependencyId ?? this.data[this.depKey]}) didn't found any.`
+          );
+
           return null;
         } else {
           throw error;
         }
       });
+
       if (!dontSetToService) {
         this.data = dataExists;
       }
@@ -242,7 +271,10 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         throw new Dynamo_Error({
           ...this._getDefaultErrorSettings(
             'getDatasByDependencyIds',
-            new Error(`getDatasByDependencyIds failed, dependencyKey is missing from service! (${this.dataParams.dataName})`)
+            new Error(
+              `getDatasByDependencyIds failed, dependencyKey is missing from service! ` +
+              `(${this.dataParams.dataName})`
+            )
           ),
 
           errorCode: 'NTS-DS0-GDS1',
@@ -253,7 +285,10 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         throw new Dynamo_Error({
           ...this._getDefaultErrorSettings(
             'getDatasByDependencyIds',
-            new Error(`getDatasByDependencyIds failed, dependencyIds is missing! (${this.dataParams.dataName})`)
+            new Error(
+              `getDatasByDependencyIds failed, dependencyIds is missing! ` +
+              `(${this.dataParams.dataName})`
+            )
           ),
 
           errorCode: 'NTS-DS0-GDS2',
@@ -265,6 +300,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       }
 
       const datas: T[] = await this.dataDBService.getDatasByDependencyIds(dependencyIds);
+
       if (!dontSetToService) {
         this.dataList = datas;
       }
@@ -293,7 +329,10 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         throw new Dynamo_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataListByDependencyId',
-            new Error(`getDataListByDependencyId failed, dependencyKey is missing from service! (${this.dataParams.dataName})`)
+            new Error(
+              `getDataListByDependencyId failed, dependencyKey is missing from service! ` +
+              `(${this.dataParams.dataName})`
+            )
           ),
           
           errorCode: 'NTS-DS0-GLD1',
@@ -304,21 +343,31 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         throw new Dynamo_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataListByDependencyId',
-            new Error(`getDataListByDependencyId failed, ${this.depKey} is missing! (${this.dataParams.dataName})`)
+            new Error(
+              `getDataListByDependencyId failed, ${this.depKey} is missing! ` +
+              `(${this.dataParams.dataName})`
+            )
           ),
           
           errorCode: 'NTS-DS0-GLD2',
         });
       }
 
-      const dataListExists: T[] = await this.dataDBService.getDataListByDependencyId(dependencyId ?? this.data[this.depKey]).catch(error => {
+      const dataListExists: T[] = await this.dataDBService.getDataListByDependencyId(
+        dependencyId ?? this.data[this.depKey]
+      ).catch((error): T[] => {
         if (error?.errorCode === 'NTS-DBS-GLD2') {
-          Dynamo_Log.warn(`getDataListByDependencyId ${this.dataParams.dataName} (${this.depKey}: ${dependencyId ?? this.data[this.depKey]}) didn't found any.`);
+          Dynamo_Log.warn(
+            `getDataListByDependencyId ${this.dataParams.dataName} ` +
+            `(${this.depKey}: ${dependencyId ?? this.data[this.depKey]}) didn't found any.`
+          );
+
           return [];
         } else {
           throw error;
         }
       });
+
       if (!dontSetToService) {
         this.dataList = dataListExists;
       }
@@ -369,14 +418,16 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
    */
   async findData(filterBy: DynamoNTS_DBFilter<T>, dontSetToService?: boolean): Promise<T> {
     try {
-      const dataExists: T = await this.dataDBService.findOne(filterBy).catch(error => {
+      const dataExists: T = await this.dataDBService.findOne(filterBy).catch((error): null => {
         if (error?.errorCode === 'NTS-DBS-FO1') {
           Dynamo_Log.warn(`findData ${this.dataParams.dataName} didn't found any.`);
+
           return null;
         } else {
           throw error;
         }
       });
+
       if (!dontSetToService) {
         this.data = dataExists;
       }
@@ -423,14 +474,16 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
    */
   async findDatas(filterBy: DynamoNTS_DBFilter<T>, dontSetToService?: boolean): Promise<T[]> {
     try {
-      const dataListExists: T[] = await this.dataDBService.find(filterBy).catch(error => {
+      const dataListExists: T[] = await this.dataDBService.find(filterBy).catch((error): T[] => {
         if (error?.errorCode === 'NTS-DBS-F1') {
           Dynamo_Log.warn(`findDatas ${this.dataParams.dataName} didn't found any.`);
+
           return [];
         } else {
           throw error;
         }
       });
+
       if (!dontSetToService) {
         this.dataList = dataListExists;
       }
@@ -501,22 +554,35 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
    * $unset:       // Removes the specified field from a document. (set: "" to value)
    * //
    */
-  async updateData(set: { filterBy?: DynamoNTS_DBFilter<T>, update: DynamoNTS_DBUpdate<T> }): Promise<void> {
+  async updateData(
+    set: { filterBy?: DynamoNTS_DBFilter<T>, update: DynamoNTS_DBUpdate<T> }
+  ): Promise<void> {
     try {
       if (set.filterBy) {
         await this.dataDBService.updateOne(set.filterBy, set.update, this.issuer);
 
       } else if (this.data._id) {
-        await this.dataDBService.updateOne({ _id: this.data._id } as DynamoNTS_DBFilter<T>, set.update, this.issuer);
+        await this.dataDBService.updateOne(
+          { _id: this.data._id } as DynamoNTS_DBFilter<T>, 
+          set.update, 
+          this.issuer
+        );
 
       } else if (this.depKey && this.data[this.depKey]) {
-        await this.dataDBService.updateOne({ [this.depKey]: this.data[this.depKey] } as DynamoNTS_DBFilter<T>, set.update, this.issuer);
+        await this.dataDBService.updateOne(
+          { [this.depKey]: this.data[this.depKey] } as DynamoNTS_DBFilter<T>, 
+          set.update, 
+          this.issuer
+        );
 
       } else {
         throw new Dynamo_Error({
           ...this._getDefaultErrorSettings(
             'updateData',
-            new Error(`no usable parameter provided for updateData; no updateBy, no id, no dependencyId (${this.dataParams.dataName})`)
+            new Error(
+              `no usable parameter provided for updateData; no updateBy, no id, no dependencyId ` +
+              `(${this.dataParams.dataName})`
+            )
           ),
           
           errorCode: 'NTS-DS0-UD1',
@@ -552,7 +618,10 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
     try {
       if (!this.data) {
         throw new Dynamo_Error({ 
-          ...this._getDefaultErrorSettings('saveData', new Error(`no data to save! (${this.dataParams.dataName})`)),
+          ...this._getDefaultErrorSettings(
+            'saveData', 
+            new Error(`no data to save! (${this.dataParams.dataName})`)
+          ),
           
           errorCode: 'NTS-DS0-SD4',
         });
@@ -561,6 +630,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       if (!this.data._id && (!this.depKey || !this.data[this.depKey])) {
         // if ID of dependencyID is not present, data not exists, create new data
         this.data = await this.dataDBService.createData(this.data, this.issuer);
+
         return this.data;
       }
 
@@ -573,13 +643,17 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         if (dataExists) {
           // if data exists do modify
           this.data = await this.dataDBService.modifyData(this.data, this.issuer);
+
           return this.data;
 
         } else {
           throw new Dynamo_Error({ 
             ...this._getDefaultErrorSettings(
               'saveData',
-              new Error(`saveData was unsuccessful: provided ID not exists (id: ${this.data._id}, ${this.dataParams.dataName})`)
+              new Error(
+                `saveData was unsuccessful: provided ID not exists ` +
+                `(id: ${this.data._id}, ${this.dataParams.dataName})`
+              )
             ),
 
             errorCode: 'NTS-DS0-SD1',
@@ -592,7 +666,10 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
           throw new Dynamo_Error({ 
             ...this._getDefaultErrorSettings(
               'saveData',
-              new Error(`saveData was unsuccessful: dependency data id missing from data (key: ${this.depKey}, ${this.dataParams.dataName})`)
+              new Error(
+                `saveData was unsuccessful: dependency data id missing from data ` +
+                `(key: ${this.depKey}, ${this.dataParams.dataName})`
+              )
             ),
             
             errorCode: 'NTS-DS0-SD2',
@@ -612,13 +689,17 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
             // if data not exists check that dependency already exists for this
             const dependencyExists = await this.getDependencyDataDBService()
               .getDataById(this.data[this.depKey])
-              .catch(error => null);
+              .catch((error): null => null);
 
             if(!dependencyExists) {
               throw new Dynamo_Error({ 
                 ...this._getDefaultErrorSettings(
                   'saveData',
-                  new Error(`saveData was unsuccessful: dependency data not exists (key: ${this.depKey}, id: ${this.data[this.depKey]}, ${this.dataParams.dataName})`)
+                  new Error(
+                    `saveData was unsuccessful: dependency data not exists ` +
+                    `(key: ${this.depKey}, id: ${this.data[this.depKey]}, ` +
+                    `${this.dataParams.dataName})`
+                  )
                 ),
                 
                 errorCode: 'NTS-DS0-SD3',
@@ -630,6 +711,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
 
       // if data not exists create new data
       this.data = await this.dataDBService.createData(this.data, this.issuer);
+
       return this.data;
 
     } catch (error) {
@@ -683,7 +765,8 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
     try {
       for (let i = 0; i < this.dataParams.modelParams.length; i++) {
         // basic required validations
-        if ((this.dataParams.modelParams[i].required && 
+        if (
+          (this.dataParams.modelParams[i].required && 
             (this.data[this.dataParams.modelParams[i].key] === null || 
               this.data[this.dataParams.modelParams[i].key] === undefined
             )
@@ -697,7 +780,10 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
           throw new Dynamo_Error({ 
             ...this._getDefaultErrorSettings(
               'validateForSave',
-              new Error(`validateForSave failed, ${this.dataParams.modelParams[i].key} is missing! (${this.dataParams.dataName})`)
+              new Error(
+                `validateForSave failed, ${this.dataParams.modelParams[i].key} is missing! ` +
+                `(${this.dataParams.dataName})`
+              )
             ),
 
             status: 422, 
@@ -713,7 +799,10 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
           throw new Dynamo_Error({
             ...this._getDefaultErrorSettings(
               'validateForSave',
-              new Error(`validateForSave failed, ${this.dataParams.modelParams[i].key} is not a date! (${this.dataParams.dataName})`)
+              new Error(
+                `validateForSave failed, ${this.dataParams.modelParams[i].key} is not a date! ` +
+                `(${this.dataParams.dataName})`
+              )
             ),
 
             status: 422, 
@@ -725,7 +814,9 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         // call additional validators
         if (this.dataParams.modelParams[i].additionalValidators) {
           for (let j = 0; j < this.dataParams.modelParams[i].additionalValidators.length; j++) {
-            this.dataParams.modelParams[i].additionalValidators[j](this.data[this.dataParams.modelParams[i].key]);
+            this.dataParams.modelParams[i].additionalValidators[j](
+              this.data[this.dataParams.modelParams[i].key]
+            );
           }
         }
       }
@@ -747,7 +838,10 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
    * setting up dependency dataHook by DynamoBEDataModelParams
    */
   private lookForDependencyDataSettings(): void {
-    const dependencyParam: Dynamo_DataPropertyParams = this.dataParams.modelParams.find((modelParams: Dynamo_DataPropertyParams) => modelParams.isDependencyHook);
+    const dependencyParam: Dynamo_DataPropertyParams = this.dataParams.modelParams.find(
+      (modelParams: Dynamo_DataPropertyParams): boolean => modelParams.isDependencyHook
+    );
+
     if (dependencyParam) {
       this.depKey = dependencyParam.key;
 
@@ -770,7 +864,10 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       throw new Dynamo_Error({ 
         ...this._getDefaultErrorSettings(
           'getDependencyDataDBService',
-          new Error(`getDependencyDataDBService was unsuccessful, service key not setted up! (${this.dataParams.dataName}))`)
+          new Error(
+            `getDependencyDataDBService was unsuccessful, service key not setted up! ` +
+            `(${this.dataParams.dataName}))`
+          )
         ),
 
         status: 501, 
@@ -782,6 +879,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       return this.depDataDBService;
     } else {
       this.depDataDBService = DynamoNTS_GlobalService.getDBServiceByKey(this.depDBServiceKey);
+
       return this.depDataDBService;
     }
   }
@@ -789,12 +887,13 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
   private _getDefaultErrorSettings(fnName: string, error: Error | Dynamo_Error) {
     return {
       status: (error as Dynamo_Error)?.___status ?? 500,
-      message: (error as Error)?.message ?? `${fnName} was UNSUCCESFUL (NTS; ${this.dataParams.dataName})`,
+      message: 
+        (error as Error)?.message ?? `${fnName} was UNSUCCESFUL (NTS; ${this.dataParams.dataName})`,
       addECToUserMsg: true,
       userMessage: this.defaultErrorUserMsg,
       issuer: this.issuer,
       issuerService: this.serviceName + ` (${this?.constructor?.name}-DynamoNTS_DataService)`,
       error: error,
-    }
+    };
   }
 }