@futdevpro/nts-dynamo 1.5.18 → 1.5.20

package/src/_services/dynamobe-email.service.ts

@@ -7,6 +7,9 @@ import { DynamoBEError } from '@futdevpro/fsm-dynamo';
 
 import { DBE_Shared } from './dynamobe-shared.service';
 
+/**
+ * 
+ */
 export class DynamoBEEmailService {
   private nmTransporter: NodeMailer.Transporter;
   private senderName: string;
@@ -52,14 +55,21 @@ export class DynamoBEEmailService {
         this.constructionFinished();
       }
     } catch (error) {
-      console.log(`\nDynamoBEEmailService ERROR, The emailService construction failed for ${set.email}.`, new Error());
+      DBE_Shared.logError(`\nDynamoBEEmailService ERROR, The emailService construction failed for ${set.email}.`, new Error());
     }
   }
 
+  /**
+   * 
+   */
   private constructionFinished(): void { 
     DBE_Shared.logSuccess(`\nEmailService construction (${this.senderName}) Finished!\n`) 
   }
 
+  /**
+   * 
+   * @param set 
+   */
   public async sendEmail(set: {
     to: string,
     subject: string,
@@ -77,24 +87,33 @@ export class DynamoBEEmailService {
         content = set.content
       } else if (set.useTemplate) {
         if (!this.templates[set.useTemplate]) {
-          throw new DynamoBEError({ message: `no template found with this parameter! (${set.useTemplate})` });
+          throw new DynamoBEError({ 
+            message: `no template found with this parameter! (${set.useTemplate})`,
+            userMessage: `We encountered an uncought BackEnd Email Service Error, please contact the responsible development team. errorcode: 701-114-101`, 
+          });
         }
         content = this.templates[set.useTemplate];
 
         if (this.templatePropertyKeys[set.useTemplate].length > 0) {
           if (!set.templateProperties) {
-            throw new DynamoBEError({ message: `templateProperties missing!` });
+            throw new DynamoBEError({ 
+              message: `templateProperties missing!`,
+              userMessage: `We encountered an uncought BackEnd Email Service Error, please contact the responsible development team. errorcode: 701-114-102`, 
+            });
           }
           this.templatePropertyKeys[set.useTemplate].forEach((propertyKey: string) => {
             if (!set.templateProperties[propertyKey]) {
-              console.log(`templateProperty missing! (${propertyKey})`);
+              DBE_Shared.logError(`templateProperty missing! (${propertyKey})`);
             }
             const reg = new RegExp(`{{${propertyKey}}}`, 'g')
             content = content.replace(reg, set.templateProperties[propertyKey]);
           })
         }
       } else {
-        throw new DynamoBEError({ message: 'no content setting passsed to emailSending!' });
+        throw new DynamoBEError({ 
+          message: 'no content setting passsed to emailSending!',
+          userMessage: `We encountered an uncought BackEnd Email Service Error, please contact the responsible development team. errorcode: 701-114-100`, 
+        });
       }
 
       let mailOptions: MailOptions = {
@@ -112,10 +131,17 @@ export class DynamoBEEmailService {
         }
       });
     } catch (error) {
-      console.log('\nDynamoBEEmailService ERROR, email sending error', error);
+      DBE_Shared.logError('\nDynamoBEEmailService ERROR, email sending error', error);
     }
   }
 
+  /**
+   * 
+   * @param templateName 
+   * @param rootPath 
+   * @param templatePath 
+   * @returns 
+   */
   private async loadTemplate(templateName: string, rootPath: string, templatePath: string): Promise<void> {
     try {
       this.templateLoadingInProgressCounter++;
@@ -123,7 +149,7 @@ export class DynamoBEEmailService {
         templatePath = Path.join(rootPath, templatePath);
         FileSystem.readFile(templatePath, 'utf8' , (err, template) => {
           if (err) {
-            console.log(`\nDynamoBEEmailService readFile ERROR (0), Couldn't load email template; ${templateName} from ${templatePath}\nerror:\n`, err, '\n');
+            DBE_Shared.logError(`\nDynamoBEEmailService readFile ERROR (0), Couldn't load email template; ${templateName} from ${templatePath}\nerror:\n`, err, '\n');
             reject(err);
             return;
           } else {
@@ -139,10 +165,15 @@ export class DynamoBEEmailService {
         });
       });
     } catch (error) {
-      console.log(`\nDynamoBEEmailService ERROR (1), Couldn't load email template; ${templateName} from ${templatePath}`, new Error());
+      DBE_Shared.logError(`\nDynamoBEEmailService ERROR (1), Couldn't load email template; ${templateName} from ${templatePath}`, new Error());
     }
   }
 
+  /**
+   * 
+   * @param template 
+   * @returns 
+   */
   private getTemplatePropertyKeys(template: string): string[] {
     try {
       const propertyKeys: string[] = [];
@@ -150,8 +181,11 @@ export class DynamoBEEmailService {
       let propertyCloseTagIndex = template.indexOf('}}', propertyOpenTagIndex + 2);
       while (propertyOpenTagIndex >= 0) {
         if (propertyCloseTagIndex === -1) {
-          console.log(`\nDynamoBEEmailService ERROR, missing closing tag from email template! (${propertyOpenTagIndex} -)`, propertyKeys);
-          throw new DynamoBEError({ message: `ERROR, missing closing tag from email template! (${propertyOpenTagIndex} -)` });
+          DBE_Shared.logError(`\nDynamoBEEmailService ERROR, missing closing tag from email template! (${propertyOpenTagIndex} -)`, propertyKeys);
+          throw new DynamoBEError({ 
+            message: `ERROR, missing closing tag from email template! (${propertyOpenTagIndex} -)`,
+            userMessage: `We encountered an uncought BackEnd Email Service Error, please contact the responsible development team. errorcode: 701-114-200`, 
+          });
         }
         const newKey: string = template.substring(propertyOpenTagIndex + 2, propertyCloseTagIndex);
         if (!propertyKeys.includes(newKey)) {
@@ -163,7 +197,7 @@ export class DynamoBEEmailService {
       // console.log('\n\n\nTEST propertyKeys: ', propertyKeys);
       return propertyKeys;
     } catch (error) {
-      console.log(`\nDynamoBEEmailService ERROR, getTemplatePropertyKeys ERROR`, new Error(), '\ntemplate:\n', template);
+      DBE_Shared.logError(`\nDynamoBEEmailService ERROR, getTemplatePropertyKeys ERROR`, new Error(), '\ntemplate:\n', template);
     }
   }
 }

package/src/_services/dynamobe-global.service.ts

@@ -55,6 +55,10 @@ export class DBE_Global_S extends DynamoBESingletonService {
     this.instance.emailServiceCollection = set.emailServiceCollection;
   }
 
+  /**
+   * 
+   * @returns 
+   */
   static getAuthService(): DynamoBEAuthService {
     if (!this.instance?.authService?.authenticateToken) {
       throw new Error(
@@ -65,6 +69,10 @@ export class DBE_Global_S extends DynamoBESingletonService {
     return this.instance.authService;
   }
 
+  /**
+   * 
+   * @returns 
+   */
   static getDBServiceCollection(): DynamoBEDBServiceCollection {
     if (!this.instance?.dbServiceCollection) {
       throw new Error(
@@ -75,10 +83,20 @@ export class DBE_Global_S extends DynamoBESingletonService {
     return this.instance.dbServiceCollection;
   }
 
+  /**
+   * 
+   * @param dataParams 
+   * @returns 
+   */
   static getDBService<T extends Metadata>(dataParams: DynamoBEDataParams): DynamoBEDBService<T> {
     return this.getDBServiceByKey<T>(dataParams.dataName);
   }
 
+  /**
+   * 
+   * @param key 
+   * @returns 
+   */
   static getDBServiceByKey<T extends Metadata>(key: string): DynamoBEDBService<T> {
     const collection = this.getDBServiceCollection();
     if (collection[key]) {
@@ -94,6 +112,10 @@ export class DBE_Global_S extends DynamoBESingletonService {
     }
   }
 
+  /**
+   * 
+   * @returns 
+   */
   static getEmailServiceCollection(): DynamoBEEmailServiceCollection {
     if (!this.instance?.emailServiceCollection) {
       throw new Error(

package/src/_services/dynamobe-routing-module.service.ts

@@ -15,6 +15,9 @@ export interface DynamoBERoutingModuleSettings {
   securityOverride?: DynamoBERouteSecurity;
 }
 
+/**
+ * 
+ */
 export class DynamoBERoutingModule {
   
   security: DynamoBERouteSecurity;
@@ -52,6 +55,10 @@ export class DynamoBERoutingModule {
     });
   }
 
+  /**
+   * 
+   * @param securityOverride 
+   */
   private mountRoutes(securityOverride?: DynamoBERouteSecurity): void {
     if (securityOverride) {
       this.security = securityOverride;
@@ -87,11 +94,19 @@ export class DynamoBERoutingModule {
           this.mountSecureRoute(endpoint);
         }
       } catch (error) {
-        throw new DynamoBEError({ message: `DYNAMOBEERROR: Failed to mount routes.`, error })
+        throw new DynamoBEError({ 
+          message: `DYNAMOBEERROR: Failed to mount routes.`, 
+          userMessage: `We encountered an uncought BackEnd Build Error, please contact the responsible development team. errorcode: 900-456-100`, 
+          error 
+        })
       }
     });
   }
 
+  /**
+   * 
+   * @param endpointParams 
+   */
   private mountOpenRoute(endpointParams: DynamoBEEndpointParams): void {
     switch(endpointParams.type) {
       case HttpCallType.get:
@@ -115,10 +130,17 @@ export class DynamoBERoutingModule {
           endpointParams.preProcessess, endpointParams.getTasksExecution());
         break;
       default:
-        throw new DynamoBEError({ message: `DYNAMOBEERROR: INVALID route type: ${endpointParams.type} - ${endpointParams.name}` })
+        throw new DynamoBEError({ 
+          message: `DYNAMOBEERROR: INVALID route type: ${endpointParams.type} - ${endpointParams.name}` ,
+          userMessage: `We encountered an uncought BackEnd Build Error, please contact the responsible development team. errorcode: 900-456-200`, 
+        })
     }
   }
 
+  /**
+   * 
+   * @param endpointParams 
+   */
   private mountSecureRoute(endpointParams: DynamoBEEndpointParams): void {
     switch(endpointParams.type) {
       case HttpCallType.get:
@@ -142,7 +164,10 @@ export class DynamoBERoutingModule {
           endpointParams.preProcessess, endpointParams.getTasksExecution());
         break;
       default:
-        throw new DynamoBEError({ message: `DYNAMOBEERROR: INVALID route type: ${endpointParams.type} - ${endpointParams.name}` })
+        throw new DynamoBEError({ 
+          message: `DYNAMOBEERROR: INVALID route type: ${endpointParams.type} - ${endpointParams.name}`,
+          userMessage: `We encountered an uncought BackEnd Build Error, please contact the responsible development team. errorcode: 900-456-300`, 
+        })
     }
   }
 }

package/src/_services/dynamobe-shared.service.ts

@@ -4,8 +4,16 @@ import { Request } from 'express';
 import * as GeoIp from 'geoip-lite';
 import { GeoIpLocation, D_Shared } from '@futdevpro/fsm-dynamo/shared-service';
 
+/**
+ * 
+ */
 export class DBE_Shared extends D_Shared {
 
+  /**
+   * 
+   * @param request 
+   * @returns 
+   */
   static getIpFromRequest(request: Request): string {
     let ip: string;
     if (request.headers['x-forwarded-for']) {
@@ -18,10 +26,20 @@ export class DBE_Shared extends D_Shared {
     return ip;
   }
 
+  /**
+   * 
+   * @param request 
+   * @returns 
+   */
   static getLocationDataByRequest(request: Request): GeoIpLocation {
     return GeoIp.lookup(this.getIpFromRequest(request));
   }
 
+  /**
+   * 
+   * @param question 
+   * @returns 
+   */
   static async prompt(question: string): Promise<string> {
     const readLine = ReadLine.createInterface({ 
       input: process.stdin, 

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

@@ -1,4 +1,7 @@
 
+/**
+ * 
+ */
 export class DynamoBESingletonService {
   /// ---     ---     ---     SINGLETON     ---     ---     --- \\\
   protected static instance;

package/src/_models/dynamobe-data-model-params.ts

@@ -1,24 +0,0 @@
-/* 
-export { DynamoBEDataPropertyParams } from '@futdevpro/fsm-dynamo';
-import { DataModelType } from '../_enums/data-model-type.enum';
-
-export class DynamoBEDataModelParams {
-  dataName: string;
-  type: DataModelType;
-  properties: DynamoBEDataPropertyParams[] = [];
-
-  constructor(
-    set?: {
-      dataName: string,
-      type: DataModelType,
-      properties: DynamoBEDataPropertyParams[],
-    }
-  ) {
-    if (set) {
-      this.dataName = set.dataName;
-      this.type = set.type;
-      this.properties = set.properties ? set.properties : [];
-    }
-  }
-}
- */