@futdevpro/nts-dynamo 1.9.30 → 1.9.32

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@futdevpro/nts-dynamo",
-  "version": "01.09.30",
+  "version": "01.09.32",
   "description": "Dynamic NodeTS (NodeJS-Typescript), MongoDB Backend System Framework by Future Development Program Ltd.",
   "scripts": {
     "prep": "npm i rimraf nodemon -g",

package/src/_models/control-models/app-params.control-model.ts

@@ -31,6 +31,10 @@ export class DyNTS_App_Params {
    * name of the system, by default, its: this.name.replace(' ', '-')
    */
   systemName?: string;
+  /**
+   * short code name of the system
+   */
+  systemShortCodeName?: string;
 
   constructor(
     set: DyNTS_App_Params
@@ -41,5 +45,6 @@ export class DyNTS_App_Params {
     this.dbName = set.dbName;
     this.dbUri = set.dbUri ?? `mongodb://localhost:27017/${this.dbName}`;
     this.systemName = set.systemName ?? this.name.replace(' ', '-');
+    this.systemShortCodeName = set.systemShortCodeName ?? this.systemName.replace(/[^A-Z]/g, '');
   }
 }

package/src/_models/interfaces/global-settings.interface.ts

@@ -25,6 +25,11 @@ export interface DyNTS_Global_Settings {
    */
   defaultSocketSecurity: DyNTS_SocketSecurity;
 
+  /**
+   * this is the name of the system, this will be used for the logs and errors
+   */
+  systemShortCodeName?: string;
+
   /**
    * this setting will set which logs will be shown
    */

package/src/_modules/socket/_services/socket-server.service.ts

@@ -59,7 +59,7 @@ export abstract class DyNTS_SocketServerService<
   get logSetup(): boolean { return DyNTS_global_settings.log_settings.setup; }
   get highDetailedLogs(): boolean { return DyNTS_global_settings.log_settings.highDetailedLogs; }
 
-  defaultErrorUserMsg = 
+  override readonly defaultErrorUserMsg = 
     `We encountered an unhandled Socket Server Error, ` +
     `\nplease contact the responsible development team.`;
 

package/src/_modules/usage/usage.data-service.ts

@@ -153,20 +153,4 @@ export class DyNTS_Usage_DataService extends DyNTS_DataService<DyFM_UsageSession
       });
     }
   }
-  
-  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-  private getDefaultErrorSettings(
-    fnName: string, 
-    error: Error | DyFM_Error
-  )/* : DyFM_ErrorSettings */ {
-    return {
-      status: (error as DyFM_Error)?.___status ?? 417,
-      message: (error as Error)?.message ?? `${fnName} was UNSUCCESSFUL (NTS; ${this.serviceName})`,
-      addECToUserMsg: true,
-      userMessage: this.defaultErrorUserMsg,
-      issuer: this.issuer,
-      issuerService: this.serviceName,
-      error: error,
-    };
-  }
 }

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

@@ -8,8 +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)
+// TODO: 2 type of archiving service system: within list, or separate db elements
 
 /**
  * Basic Data Service that is connected to the relevant DBServices
@@ -47,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.`; 
 
@@ -194,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),
@@ -278,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})`
             )
           ),
@@ -297,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})`
             )
           ),
@@ -312,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',
         });
@@ -486,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 {
@@ -505,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',
       });
@@ -944,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/email.service.ts

@@ -8,6 +8,8 @@ import { Options as MailOptions, Attachment } from 'nodemailer/lib/mailer';
 import { 
   DyFM_AnyError, DyFM_Array, DyFM_Error, DyFM_Error_Settings, DyFM_Log 
 } from '@futdevpro/fsm-dynamo';
+import { DyNTS_SingletonService } from '../base/singleton.service';
+import { DyNTS_global_settings } from '../../_collections/global-settings.const';
 
 export interface DyNTS_EmailService_Settings {
   host: string,
@@ -58,7 +60,7 @@ export interface DyNTS_SendEmail_Settings<T = { [propertyKey: string]: string; }
 /**
  * 
  */
-export class DyNTS_EmailService {
+export class DyNTS_EmailService /* extends DyNTS_SingletonService */ {
   serviceName: string;
 
   private nmTransporter: NodeMailer.Transporter;
@@ -75,8 +77,8 @@ export class DyNTS_EmailService {
 
   private readonly styleLimitWarning: number = 16;
 
-  defaultErrorUserMsg = 
-    `We encountered an uncought Email Service Error, ` +
+  readonly defaultErrorUserMsg = 
+    `We encountered an uncaught Email Service Error, ` +
     `\nplease contact the responsible development team.`;
   
   constructor (
@@ -677,4 +679,21 @@ export class DyNTS_EmailService {
       error: error,
     };
   }
+  
+  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/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

@@ -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,
     };
   }