@futdevpro/nts-dynamo 1.5.17 → 1.5.20

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 : [];
-    }
-  }
-}
- */