@futdevpro/nts-dynamo 1.9.29 → 1.9.31

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

@@ -8,6 +8,9 @@ import { DyNTS_DBUpdate } from '../../_models/types/db-update.type';
 
 import { DyNTS_DBService } from './db.service';
 import { DyNTS_GlobalService } from '../core/global.service';
+import { DyNTS_global_settings } from '../../_collections/global-settings.const';
+
+// TODO: 2 type of archiving service system: within list, or separate db elements
 
 /**
  * Basic Data Service that is connected to the relevant DBServices
@@ -45,10 +48,10 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
 
   dataParams: DyFM_DataModel_Params;
 
-  defaultErrorUserMsg: string = 
+  readonly defaultErrorUserMsg: string = 
     `We encountered an unhandled Data Service Error, ` +
     `\nplease contact the responsible development team.`; 
-  defaultValidationErrorUserMsg: string = 
+  readonly defaultValidationErrorUserMsg: string = 
     `We encountered an unhandled Validation Error, ` +
     `\nplease contact the responsible development team.`; 
 
@@ -192,13 +195,13 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
         return [];
       }
 
-      const datas: T[] = await this.dataDBService.find({ _id: { $in: ids } });
+      const dataList: T[] = await this.dataDBService.find({ _id: { $in: ids } });
 
       if (!dontSetToService) {
-        this.dataList = datas;
+        this.dataList = dataList;
       }
 
-      return datas;
+      return dataList;
     } catch (error) {
       throw new DyFM_Error({
         ...this._getDefaultErrorSettings('getDataByIds', error),
@@ -276,14 +279,17 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
     }
   }
 
-  async getDatasByDependencyIds(dependencyIds: string[], dontSetToService?: boolean): Promise<T[]> {
+  async getDataListByDependencyIds(
+    dependencyIds: string[], 
+    dontSetToService?: boolean
+  ): Promise<T[]> {
     try {
       if (!this.depKey) {
         throw new DyFM_Error({
           ...this._getDefaultErrorSettings(
-            'getDatasByDependencyIds',
+            'getDataListByDependencyIds',
             new Error(
-              `getDatasByDependencyIds failed, dependencyKey is missing from service! ` +
+              `getDataListByDependencyIds failed, dependencyKey is missing from service! ` +
               `(${this.dataParams.dataName})`
             )
           ),
@@ -295,9 +301,9 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
       if (!dependencyIds) {
         throw new DyFM_Error({
           ...this._getDefaultErrorSettings(
-            'getDatasByDependencyIds',
+            'getDataListByDependencyIds',
             new Error(
-              `getDatasByDependencyIds failed, dependencyIds is missing! ` +
+              `getDataListByDependencyIds failed, dependencyIds is missing! ` +
               `(${this.dataParams.dataName})`
             )
           ),
@@ -310,19 +316,19 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
         return [];
       }
 
-      const datas: T[] = await this.dataDBService.getDatasByDependencyIds(dependencyIds);
+      const dataList: T[] = await this.dataDBService.getDataListByDependencyIds(dependencyIds);
 
       if (!dontSetToService) {
-        this.dataList = datas;
+        this.dataList = dataList;
       }
 
-      return datas;
+      return dataList;
     } catch (error) {
       if ([ 'NTS-DS0-GDS1', 'NTS-DS0-GDS2' ].includes(error?.errorCode)) {
         throw error;
       } else {
         throw new DyFM_Error({
-          ...this._getDefaultErrorSettings('getDatasByDependencyIds', error),
+          ...this._getDefaultErrorSettings('getDataListByDependencyIds', error),
 
           errorCode: 'NTS-DS0-GDS0',
         });
@@ -484,11 +490,11 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
    * //
    * @returns {T[]} dataList: T[]
    */
-  async findDatas(filterBy: DyNTS_DBFilter<T>, dontSetToService?: boolean): Promise<T[]> {
+  async findDataList(filterBy: DyNTS_DBFilter<T>, dontSetToService?: boolean): Promise<T[]> {
     try {
       const dataListExists: T[] = await this.dataDBService.find(filterBy).catch((error): T[] => {
         if (error?.errorCode === 'NTS-DBS-F1') {
-          DyFM_Log.warn(`findDatas ${this.dataParams.dataName} didn't found any.`);
+          DyFM_Log.warn(`findDataList ${this.dataParams.dataName} didn't found any.`);
 
           return [];
         } else {
@@ -503,7 +509,7 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
       return dataListExists;
     } catch (error) {
       throw new DyFM_Error({ 
-        ...this._getDefaultErrorSettings('findDatas', error),
+        ...this._getDefaultErrorSettings('findDataList', error),
         
         errorCode: 'NTS-DS0-FDS0',
       });
@@ -626,9 +632,13 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
    * (when you simultaneously trying to change the same data's 
    * different values from different flows)
    */
-  async saveData(): Promise<T> {
+  async saveData(data?: T, dontSetToService?: boolean): Promise<T> {
     try {
-      if (!this.data) {
+      if (!data && this.data) {
+        data = this.data;
+      }
+
+      if (!data) {
         throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings(
             'saveData', 
@@ -641,24 +651,32 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
 
       await this.validateForSave();
 
-      if (!this.data._id && (!this.depKey || !this.data[this.depKey])) {
+      if (!data._id && (!this.depKey || !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);
+        data = await this.dataDBService.createData(data, this.issuer);
 
-        return this.data;
+        if (!dontSetToService) {
+          this.data = data;
+        }
+
+        return data;
       }
 
       let dataExists: T;
 
       // check if data already exists with the specific ID
-      if (this.data._id) {
+      if (data._id) {
         dataExists = await this.getDataById(null, true);
 
         if (dataExists) {
           // if data exists do modify
-          this.data = await this.dataDBService.modifyData(this.data, this.issuer);
+          data = await this.dataDBService.modifyData(data, this.issuer);
+
+          if (!dontSetToService) {
+            this.data = data;
+          }
 
-          return this.data;
+          return data;
 
         } else {
           throw new DyFM_Error({ 
@@ -666,7 +684,7 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
               'saveData',
               new Error(
                 `saveData was unsuccessful: provided ID not exists ` +
-                `(id: ${this.data._id}, ${this.dataParams.dataName})`
+                `(id: ${data._id}, ${this.dataParams.dataName})`
               )
             ),
 
@@ -676,7 +694,7 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
       }
 
       if (this.depKey) {
-        if (!this.data[this.depKey]) {
+        if (!data[this.depKey]) {
           throw new DyFM_Error({ 
             ...this._getDefaultErrorSettings(
               'saveData',
@@ -695,14 +713,18 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
 
           if (dataExists) {
             // if data exists do modify
-            this.data = await this.dataDBService.modifyData(this.data, this.issuer);
+            data = await this.dataDBService.modifyData(data, this.issuer);
 
-            return this.data;
+            if (!dontSetToService) {
+              this.data = data;
+            }
+
+            return data;
 
           } else if (this.depKeyIsRequired) {
             // if data not exists check that dependency already exists for this
             const dependencyExists = await this.getDependencyDataDBService()
-              .getDataById(this.data[this.depKey])
+              .getDataById(data[this.depKey])
               .catch();
 
             if (!dependencyExists) {
@@ -711,7 +733,7 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
                   'saveData',
                   new Error(
                     `saveData was unsuccessful: dependency data not exists ` +
-                    `(key: ${this.depKey}, id: ${this.data[this.depKey]}, ` +
+                    `(key: ${this.depKey}, id: ${data[this.depKey]}, ` +
                     `${this.dataParams.dataName})`
                   )
                 ),
@@ -724,9 +746,13 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
       }
 
       // if data not exists create new data
-      this.data = await this.dataDBService.createData(this.data, this.issuer);
+      data = await this.dataDBService.createData(data, this.issuer);
 
-      return this.data;
+      if (!dontSetToService) {
+        this.data = data;
+      }
+
+      return data;
 
     } catch (error) {
       if ([ 'NTS-DS0-SD1', 'NTS-DS0-SD2' ].includes(error?.errorCode)) {
@@ -747,7 +773,11 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
    */
   async deleteData(id?: string): Promise<void> {
     try {
-      if (!id && !this.data._id) {
+      if (!id && this.data._id) {
+        id = this.data._id;
+      }
+
+      if (!id) {
         throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings(
             'deleteData',
@@ -758,7 +788,7 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
         });
       }
           
-      await this.dataDBService.deleteDataById(id ?? this.data._id);
+      await this.dataDBService.deleteDataById(id);
     } catch (error) {
       if (error?.errorCode == 'NTS-DS0-DD1') {
         throw error;
@@ -918,4 +948,20 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
       error: error,
     };
   }
+
+  protected getDefaultErrorSettings(
+    fnName: string, 
+    error: DyFM_AnyError
+  ): DyFM_Error_Settings {
+    return {
+      status: (error as DyFM_Error)?.___status ?? 500,
+      message: (error as Error)?.message ?? 
+        `${fnName} was UNSUCCESSFUL (${DyNTS_global_settings.systemShortCodeName})`,
+      addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
+      userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      issuer: this.issuer,
+      issuerService: this.constructor?.name,
+      error: error,
+    };
+  }
 }

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

@@ -288,14 +288,21 @@ export class DyNTS_DBService<T extends DyFM_Metadata> {
     return dataList;
   }
 
-  async getDatasByDependencyIds(dependencyIds: string[]): Promise<T[]> {
+  /**
+   * get multiple data objects by a list of DependencyIDs, 
+   * !!!: throws error if not found (errorCode on not found: NTS-DBS-GLDS2)
+   * 
+   * @param ids ids
+   * @returns dataList
+   */
+  async getDataListByDependencyIds(dependencyIds: string[]): Promise<T[]> {
     if (!this.depDataName) {
       throw new DyFM_Error({
         ...this._getDefaultErrorSettings(
-          'getDatasByDependencyIds',
+          'getDataListByDependencyIds',
           new Error(
-            `dependencyDataIdKey not setted up for this db-service (${this.dataParams.dbName}) ` +
-            `(NTS DB)`
+            `getDataListByDependencyIds not setted up for this db-service ` +
+            `(${this.dataParams.dbName}) (NTS DB)`
           )
         ),
 
@@ -309,7 +316,7 @@ export class DyNTS_DBService<T extends DyFM_Metadata> {
       .then((res): T[] => res as T[] ?? [])
       .catch((error): void => {
         throw new DyFM_Error({
-          ...this._getDefaultErrorSettings('getDatasByDependencyIds', error),
+          ...this._getDefaultErrorSettings('getDataListByDependencyIds', error),
 
           errorCode: 'NTS-DBS-GLDS1',
           additionalContent: { dependencyIds },
@@ -318,20 +325,13 @@ export class DyNTS_DBService<T extends DyFM_Metadata> {
       });
 
     dataList.forEach((data: T): void => {
-      data = this.stringifyDataId(data, 'getDatasByDependencyIds');
+      data = this.stringifyDataId(data, 'getDataListByDependencyIds');
     });
 
     return dataList;
   }
 
-  /**
-   * get multiple data objects by a list of DependencyIDs, 
-   * !!!: throws error if not found (errorCode on not found: NTS-DBS-GLDS2)
-   * 
-   * @param ids ids
-   * @returns dataList
-   */
-  async getDataListByDependencyIds(ids: string[]): Promise<T[]> {
+  /* async getDataListByDependencyIds(ids: string[]): Promise<T[]> {
     if (!this.depDataName) {
       throw new DyFM_Error({ 
         ...this._getDefaultErrorSettings(
@@ -366,7 +366,7 @@ export class DyNTS_DBService<T extends DyFM_Metadata> {
     });
 
     return dataList;
-  }
+  } */
 
   /**
    * returns all data from database, 

package/src/_services/base/singleton.service-base.ts

@@ -0,0 +1,25 @@
+import { DyFM_AnyError, DyFM_Error_Settings, DyFM_Error } from '@futdevpro/fsm-dynamo';
+
+import { DyNTS_global_settings } from '../../_collections/global-settings.const';
+
+/**
+ * 
+ */
+export class DyNTS_SingletonServiceBase {
+
+  /// ---     ---     ---     SINGLETON     ---     ---     --- \\\
+  protected static instance;
+  
+  static getSingletonInstance() {
+    if (!this.instance) {
+      this.instance = new this();
+    }
+
+    return this.instance;
+  }
+  /// ---     ---     ---     SINGLETON     ---     ---     --- ///
+  
+  // SINGLETON services are using private constructor  
+  protected constructor() {}
+  
+}

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

@@ -1,21 +1,31 @@
+import { DyFM_AnyError, DyFM_Error_Settings, DyFM_Error } from '@futdevpro/fsm-dynamo';
+
+import { DyNTS_global_settings } from '../../_collections/global-settings.const';
+import { DyNTS_SingletonServiceBase } from './singleton.service-base';
 
 /**
  * 
  */
-export class DyNTS_SingletonService {
-
-  /// ---     ---     ---     SINGLETON     ---     ---     --- \\\
-  protected static instance;
+export class DyNTS_SingletonService extends DyNTS_SingletonServiceBase {
   
-  static getSingletonInstance() {
-    if (!this.instance) {
-      this.instance = new this();
-    }
-
-    return this.instance;
-  }
-  /// ---     ---     ---     SINGLETON     ---     ---     --- ///
+  readonly defaultErrorUserMsg: string = 
+    `We encountered an unhandled Control Service Error, ` +
+    `\nplease contact the responsible development team.`; 
   
-  // SINGLETON services are using private constructor  
-  protected constructor() {}
+  protected getDefaultErrorSettings(
+    fnName: string, 
+    error: DyFM_AnyError,
+    issuer: string
+  ): DyFM_Error_Settings {
+    return {
+      status: (error as DyFM_Error)?.___status ?? 500,
+      message: (error as Error)?.message ?? 
+        `${fnName} was UNSUCCESSFUL (${DyNTS_global_settings.systemShortCodeName})`,
+      addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
+      userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      issuer: issuer,
+      issuerService: this.constructor?.name,
+      error: error,
+    };
+  }
 }

package/src/_services/core/auth.service.ts

@@ -22,8 +22,8 @@ export abstract class DyNTS_AuthService extends DyNTS_SingletonService {
 
   readonly serviceName: string = 'AuthService';
 
-  readonly defaultErrorUserMsg = 
-    `We encountered an unhandled BackEnd Auth Error, ` +
+  override readonly defaultErrorUserMsg = 
+    `We encountered an unhandled Auth Error, ` +
     `\nplease contact the responsible development team.`;
 
   /**

package/src/_services/core/service-collection.service.ts

@@ -1,5 +1,6 @@
-import { DyNTS_SingletonService } from '../base/singleton.service';
 
-export class DyNTS_Service_Collection<T> extends DyNTS_SingletonService {
+import { DyNTS_SingletonServiceBase } from '../base/singleton.service-base';
+
+export class DyNTS_Service_Collection<T> extends DyNTS_SingletonServiceBase {
   [service: string]: T;
 }

package/src/_services/server/app.server.ts

@@ -83,8 +83,8 @@ import { DyNTS_global_settings } from '../../_collections/global-settings.const'
  *         matchStatisticsModelParams,
  *         matchDataModelParams,
 
- *         DyFM_usageSessionModel_params,
- *         DyFM_customDataModel_params,
+ *         DyFM_usageSession_dataParams,
+ *         DyFM_customData_dataParams,
  *       ]
  *     });
  *   }
@@ -249,8 +249,8 @@ export abstract class DyNTS_App extends DyNTS_SingletonService {
 
   private _routingModules: DyNTS_RoutingModule[] = [];
 
-  defaultErrorUserMsg = 
-    `We encountered a Server Error, ` +
+  override readonly defaultErrorUserMsg = 
+    `We encountered an unhandled Server Error, ` +
     `\nplease contact the responsible development team.` +
     `\n(Internal Server error)`;
 
@@ -327,6 +327,10 @@ export abstract class DyNTS_App extends DyNTS_SingletonService {
       if (!this._params) {
         throw new Error('getAppParams() must return a DyNTS_AppParams object!');
       }
+
+      if (!DyNTS_global_settings.systemShortCodeName) {
+        DyNTS_global_settings.systemShortCodeName = this.params.systemShortCodeName;
+      }
       
       process.stdout.write(
         String.fromCharCode(27) + ']0;' + 
@@ -1180,11 +1184,11 @@ export abstract class DyNTS_App extends DyNTS_SingletonService {
     return {
       status: (error as DyFM_Error)?.___status ?? 500,
       message: (error as Error)?.message ?? `${fnName} was UNSUCCESSFUL (NTS)`,
-      addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
       userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
       issuerService: `${this?.constructor?.name}-DyNTS_App`,
-      error: error,
       level: DyFM_ErrorLevel.fatal,
+      error: error,
     };
   }