@futdevpro/nts-dynamo 1.7.28 → 1.9.1

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

@@ -1,7 +1,7 @@
 
 import { 
-  Dynamo_Metadata, Dynamo_DataParams, Dynamo_DataPropertyParams, Dynamo_Error,
-  Dynamo_Log, Dynamo_AnyError, Dynamo_Error_Settings 
+  DynamoFM_Metadata, DynamoFM_DataModel_Params, DynamoFM_DataProperty_Params, DynamoFM_Error,
+  DynamoFM_Log, DynamoFM_AnyError, DynamoFM_Error_Settings 
 } from '@futdevpro/fsm-dynamo';
 import { DynamoNTS_DBFilter } from '../../_models/types/db-filter.type';
 import { DynamoNTS_DBUpdate } from '../../_models/types/db-update.type';
@@ -28,7 +28,7 @@ import { DynamoNTS_GlobalService } from '../core/global.service';
  *   }
  * }
  */
-export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
+export class DynamoNTS_DataService<T extends DynamoFM_Metadata> {
 
   serviceName: string;
 
@@ -43,7 +43,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
   depKeyIsRequired?: boolean;
   private depDataDBService: DynamoNTS_DBService<any>;
 
-  dataParams: Dynamo_DataParams;
+  dataParams: DynamoFM_DataModel_Params;
 
   defaultErrorUserMsg: string = 
     `We encountered an unhandled Data Service Error, ` +
@@ -60,7 +60,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
     /**
      * DB data prams will be used to connect to usable dbService on GlobalService
      */
-    dataParams: Dynamo_DataParams,
+    dataParams: DynamoFM_DataModel_Params,
     /**
      * Initial set for issuer to be able to follow the issuer's activity
      */
@@ -74,7 +74,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       this.lookForDependencyDataSettings();
       this.issuer = issuer;
     } catch (error) {
-      Dynamo_Log.error(
+      DynamoFM_Log.error(
         `\nDynamoNTS_DataService ERROR: ` +
         `\nThe dataService construction failed for ` +
         `${dataParams?.dataName}. ${this.serviceName} (${this.constructor.name})` +
@@ -92,7 +92,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
     try {
       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.`);
+          DynamoFM_Log.warn(`getAll ${this.dataParams.dataName} didn't found any.`);
 
           return [];
         } else {
@@ -106,7 +106,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
 
       return dataListExists;
     } catch (error) {
-      throw new Dynamo_Error({ 
+      throw new DynamoFM_Error({ 
         ...this._getDefaultErrorSettings('getAll', error),
 
         errorCode: 'NTS-DS0-GA0',
@@ -133,7 +133,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
   async getDataById(id?: string, dontSetToService?: boolean): Promise<T> {
     try {
       if (!id && !this.data._id) {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataById', 
             new Error(
@@ -158,7 +158,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       if (error?.errorCode == 'NTS-DS0-GI1') {
         throw error;
       } else {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings('getDataById', error),
           errorCode: 'NTS-DS0-GI0',
         });
@@ -169,7 +169,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
   async getDataByIds(ids: string[], dontSetToService?: boolean): Promise<T[]> {
     try {
       if (!ids) {
-        throw new Dynamo_Error({
+        throw new DynamoFM_Error({
           ...this._getDefaultErrorSettings(
             'getDataByIds',
             new Error(`getDataByIds failed, ids is missing! (${this.dataParams.dataName})`)
@@ -191,7 +191,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
 
       return datas;
     } catch (error) {
-      throw new Dynamo_Error({
+      throw new DynamoFM_Error({
         ...this._getDefaultErrorSettings('getDataByIds', error),
 
         errorCode: 'NTS-DS0-GIS0',
@@ -207,7 +207,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
   async getDataByDependencyId(dependencyId?: string, dontSetToService?: boolean): Promise<T> {
     try {
       if (!this.depKey) {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataByDependencyId',
             new Error(
@@ -221,7 +221,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       }
 
       if (!dependencyId && !this.data[this.depKey]) {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataByDependencyId',
             new Error(
@@ -238,7 +238,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         dependencyId ?? this.data[this.depKey]
       ).catch((error): null => {
         if (error?.errorCode === 'NTS-DBS-GD2') {
-          Dynamo_Log.warn(
+          DynamoFM_Log.warn(
             `getDataByDependencyId failed; ${this.dataParams.dataName} ` +
             `(${this.depKey}: ${dependencyId ?? this.data[this.depKey]}) didn't found any.`
           );
@@ -258,7 +258,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       if ([ 'NTS-DS0-GD1', 'NTS-DS0-GD2' ].includes(error?.errorCode)) {
         throw error;
       } else {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings('getDataByDependencyId', error),
           
           errorCode: 'NTS-DS0-GD0',
@@ -270,7 +270,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
   async getDatasByDependencyIds(dependencyIds: string[], dontSetToService?: boolean): Promise<T[]> {
     try {
       if (!this.depKey) {
-        throw new Dynamo_Error({
+        throw new DynamoFM_Error({
           ...this._getDefaultErrorSettings(
             'getDatasByDependencyIds',
             new Error(
@@ -284,7 +284,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       }
 
       if (!dependencyIds) {
-        throw new Dynamo_Error({
+        throw new DynamoFM_Error({
           ...this._getDefaultErrorSettings(
             'getDatasByDependencyIds',
             new Error(
@@ -312,7 +312,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       if ([ 'NTS-DS0-GDS1', 'NTS-DS0-GDS2' ].includes(error?.errorCode)) {
         throw error;
       } else {
-        throw new Dynamo_Error({
+        throw new DynamoFM_Error({
           ...this._getDefaultErrorSettings('getDatasByDependencyIds', error),
 
           errorCode: 'NTS-DS0-GDS0',
@@ -328,7 +328,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
   async getDataListByDependencyId(dependencyId?: string, dontSetToService?: boolean): Promise<T[]> {
     try {
       if (!this.depKey) {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataListByDependencyId',
             new Error(
@@ -342,7 +342,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       }
 
       if (!dependencyId && !this.data[this.depKey]) {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings(
             'getDataListByDependencyId',
             new Error(
@@ -359,7 +359,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         dependencyId ?? this.data[this.depKey]
       ).catch((error): T[] => {
         if (error?.errorCode === 'NTS-DBS-GLD2') {
-          Dynamo_Log.warn(
+          DynamoFM_Log.warn(
             `getDataListByDependencyId ${this.dataParams.dataName} ` +
             `(${this.depKey}: ${dependencyId ?? this.data[this.depKey]}) didn't found any.`
           );
@@ -379,10 +379,11 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       if (['NTS-DS0-GLD1', 'NTS-DS0-GLD2'].includes(error?.errorCode)) {
         throw error;
       } else {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings('getDataListByDependencyId', error),
           
           errorCode: 'NTS-DS0-GLD0',
+          
         });
       }
     }
@@ -422,7 +423,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
     try {
       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.`);
+          DynamoFM_Log.warn(`findData ${this.dataParams.dataName} didn't found any.`);
 
           return null;
         } else {
@@ -436,7 +437,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
 
       return dataExists;
     } catch (error) {
-      throw new Dynamo_Error({ 
+      throw new DynamoFM_Error({ 
         ...this._getDefaultErrorSettings('findData', error),
         
         errorCode: 'NTS-DS0-FD0',
@@ -478,7 +479,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
     try {
       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.`);
+          DynamoFM_Log.warn(`findDatas ${this.dataParams.dataName} didn't found any.`);
 
           return [];
         } else {
@@ -492,7 +493,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
 
       return dataListExists;
     } catch (error) {
-      throw new Dynamo_Error({ 
+      throw new DynamoFM_Error({ 
         ...this._getDefaultErrorSettings('findDatas', error),
         
         errorCode: 'NTS-DS0-FDS0',
@@ -578,7 +579,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         );
 
       } else {
-        throw new Dynamo_Error({
+        throw new DynamoFM_Error({
           ...this._getDefaultErrorSettings(
             'updateData',
             new Error(
@@ -596,7 +597,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         throw error;
 
       } else {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings('updateData', error),
           
           errorCode: 'NTS-DS0-UD0',
@@ -619,7 +620,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
   async saveData(): Promise<T> {
     try {
       if (!this.data) {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings(
             'saveData', 
             new Error(`no data to save! (${this.dataParams.dataName})`)
@@ -649,7 +650,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
           return this.data;
 
         } else {
-          throw new Dynamo_Error({ 
+          throw new DynamoFM_Error({ 
             ...this._getDefaultErrorSettings(
               'saveData',
               new Error(
@@ -665,7 +666,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
 
       if (this.depKey) {
         if (!this.data[this.depKey]) {
-          throw new Dynamo_Error({ 
+          throw new DynamoFM_Error({ 
             ...this._getDefaultErrorSettings(
               'saveData',
               new Error(
@@ -694,7 +695,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
               .catch();
 
             if (!dependencyExists) {
-              throw new Dynamo_Error({ 
+              throw new DynamoFM_Error({ 
                 ...this._getDefaultErrorSettings(
                   'saveData',
                   new Error(
@@ -721,7 +722,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         throw error;
 
       } else {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings('saveData', error),
           
           errorCode: 'NTS-DS0-SD0',
@@ -736,7 +737,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
   async deleteData(): Promise<void> {
     try {
       if (!this.data._id) {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings(
             'deleteData',
             new Error(`deleteData failed, ID is missing! (${this.dataParams.dataName})`)
@@ -751,7 +752,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       if (error?.errorCode == 'NTS-DS0-DD1') {
         throw error;
       } else {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings('deleteData', error),
           
           errorCode: 'NTS-DS0-DD0',
@@ -765,25 +766,25 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
    */
   async validateForSave(): Promise<void> {
     try {
-      for (let i = 0; i < this.dataParams.modelParams.length; i++) {
+      for (let i = 0; i < this.dataParams.properties.length; i++) {
         // basic required validations
         if (
-          (this.dataParams.modelParams[i].required && 
-            (this.data[this.dataParams.modelParams[i].key] === null || 
-              this.data[this.dataParams.modelParams[i].key] === undefined
+          (this.dataParams.properties[i].required && 
+            (this.data[this.dataParams.properties[i].key] === null || 
+              this.data[this.dataParams.properties[i].key] === undefined
             )
           ) ||
-          (this.dataParams.modelParams[i].index && 
-            (this.data[this.dataParams.modelParams[i].key] === null || 
-              this.data[this.dataParams.modelParams[i].key] === undefined
+          (this.dataParams.properties[i].index && 
+            (this.data[this.dataParams.properties[i].key] === null || 
+              this.data[this.dataParams.properties[i].key] === undefined
             )
           )
         ) {
-          throw new Dynamo_Error({ 
+          throw new DynamoFM_Error({ 
             ...this._getDefaultErrorSettings(
               'validateForSave',
               new Error(
-                `validateForSave failed, ${this.dataParams.modelParams[i].key} is missing! ` +
+                `validateForSave failed, ${this.dataParams.properties[i].key} is missing! ` +
                 `(${this.dataParams.dataName})`
               )
             ),
@@ -795,14 +796,14 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
         }
 
         // specific Date validation
-        if (this.dataParams.modelParams[i].type === 'Date' && 
-          !(new Date(this.data[this.dataParams.modelParams[i].key]) instanceof Date)
+        if (this.dataParams.properties[i].type === 'Date' && 
+          !(new Date(this.data[this.dataParams.properties[i].key]) instanceof Date)
         ) {
-          throw new Dynamo_Error({
+          throw new DynamoFM_Error({
             ...this._getDefaultErrorSettings(
               'validateForSave',
               new Error(
-                `validateForSave failed, ${this.dataParams.modelParams[i].key} is not a date! ` +
+                `validateForSave failed, ${this.dataParams.properties[i].key} is not a date! ` +
                 `(${this.dataParams.dataName})`
               )
             ),
@@ -814,10 +815,10 @@ 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]
+        if (this.dataParams.properties[i].additionalValidators) {
+          for (let j = 0; j < this.dataParams.properties[i].additionalValidators.length; j++) {
+            this.dataParams.properties[i].additionalValidators[j](
+              this.data[this.dataParams.properties[i].key]
             );
           }
         }
@@ -826,7 +827,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
       if (['NTS-DS0-VD1', 'NTS-DS0-VD2'].includes(error?.errorCode)) {
         throw error;
       } else {
-        throw new Dynamo_Error({ 
+        throw new DynamoFM_Error({ 
           ...this._getDefaultErrorSettings('validateForSave', error),
 
           status: 422, 
@@ -840,8 +841,8 @@ 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): boolean => modelParams.isDependencyHook
+    const dependencyParam: DynamoFM_DataProperty_Params = this.dataParams.properties.find(
+      (modelParams: DynamoFM_DataProperty_Params): boolean => modelParams.isDependencyHook
     );
 
     if (dependencyParam) {
@@ -867,7 +868,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
    */
   getDependencyDataDBService(): DynamoNTS_DBService<any> {
     if (!this.depDBServiceKey) {
-      throw new Dynamo_Error({ 
+      throw new DynamoFM_Error({ 
         ...this._getDefaultErrorSettings(
           'getDependencyDataDBService',
           new Error(
@@ -890,14 +891,14 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
     }
   }
   
-  private _getDefaultErrorSettings(fnName: string, error: Dynamo_AnyError): Dynamo_Error_Settings {
+  private _getDefaultErrorSettings(fnName: string, error: DynamoFM_AnyError): DynamoFM_Error_Settings {
     return {
-      status: (error as Dynamo_Error)?.___status ?? 500,
+      status: (error as DynamoFM_Error)?.___status ?? 500,
       message: 
         (error as Error)?.message ?? 
         `${fnName} was UNSUCCESFUL (NTS; ${this.dataParams.dataName})`,
-      addECToUserMsg: !(error as Dynamo_Error)?.__userMessage,
-      userMessage: (error as Dynamo_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      addECToUserMsg: !(error as DynamoFM_Error)?.__userMessage,
+      userMessage: (error as DynamoFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
       issuer: this.issuer,
       issuerService: this.serviceName + ` (${this?.constructor?.name}-DynamoNTS_DataService)`,
       error: error,