@futdevpro/nts-dynamo 1.5.34 → 1.5.36

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@futdevpro/nts-dynamo",
-  "version": "01.05.34",
+  "version": "01.05.36",
   "description": "Dynamic NodeTS (NodeJS-Typescript), MongoDB Backend System Framework by Future Development Ltd.",
   "scripts": {
     "build": "npx tsc",
@@ -59,6 +59,12 @@
       "types": "./lib/_modules/app.index.d.ts",
       "typings": "./lib/_modules/app.index.d.ts"
     },
+    "./app-extended": {
+      "default": "./lib/_modules/app-extended.index.js",
+      "module": "./lib/_modules/app-extended.index.js",
+      "types": "./lib/_modules/app-extended.index.d.ts",
+      "typings": "./lib/_modules/app-extended.index.d.ts"
+    },
     "./auth": {
       "default": "./lib/_modules/auth.index.js",
       "module": "./lib/_modules/auth.index.js",
@@ -119,6 +125,9 @@
       "app": [
         "lib/_modules/app.index.d.ts"
       ],
+      "app-extended": [
+        "lib/_modules/app-extended.index.d.ts"
+      ],
       "auth": [
         "lib/_modules/auth.index.d.ts"
       ],

package/src/_constants/dynamo-nts-global.settings.ts

@@ -1,12 +1,20 @@
 
 import { DynamoNTS_RouteSecurity } from '../_enums/dynamo-nts-route-security.enum';
+import { DynamoNTS_SocketSecurity } from '../_enums/dynamo-nts-socket-security.enum';
 import { DynamoNTS_GlobalSettings } from '../_models/dynamo-nts-global-settings';
 
 export const dynamoNTS_GlobalSettings: DynamoNTS_GlobalSettings = {
   baseUrl: '/api',
   defaultRouteSecurity: DynamoNTS_RouteSecurity.open,
+  defaultSocketSecurity: DynamoNTS_SocketSecurity.open,
+
   logSetup: false,
-  logRequests: true,
+
+  logRequest: true,
   logRequestsContent: true,
   logResponseContent: false,
+
+  logMainSocketEvent: true,
+  logAllSocketEvent: false,
+  logEventContent: false,
 };

package/src/_enums/dynamo-nts-socket-security.enum.ts

@@ -0,0 +1,5 @@
+
+export enum DynamoNTS_SocketSecurity {
+  open = 'open',
+  secure = 'secure',
+}

package/src/_enums/http/socket-event.enum.ts

@@ -0,0 +1,7 @@
+
+export enum DynamoNTS_SocketEvent {
+  connection = 'connection',
+  subscribe = 'subscribe',
+  event = 'event',
+  disconnect = 'disconnection'
+}

package/src/_enums/index.ts

@@ -4,8 +4,10 @@
 export * from './data-model-type.enum';
 export * from './dynamo-nts-data-service-function.enum';
 export * from './dynamo-nts-route-security.enum';
+export * from './dynamo-nts-socket-security.enum';
 export * from './predefined-data-types.enum';
   // HTTP ENUMS
 export * from './http/http-call-type.enum';
 export * from './http/http-response-type.enum';
+export * from './http/socket-event.enum';
 

package/src/_models/dynamo-nts-endpoint-params.ts

@@ -58,7 +58,7 @@ export class DynamoNTS_EndpointParams{
       this.preProcessess = set.preProcessess ? set.preProcessess : [];
       this.tasks = set.tasks;
 
-      this.logRequest = set.logRequest !== undefined ? set.logRequest : dynamoNTS_GlobalSettings.logRequests;
+      this.logRequest = set.logRequest !== undefined ? set.logRequest : dynamoNTS_GlobalSettings.logRequest;
       this.logRequestsContent = set.logRequestsContent !== undefined ? set.logRequestsContent : dynamoNTS_GlobalSettings.logRequestsContent;
       this.logResponseContent = set.logResponseContent !== undefined ? set.logResponseContent : dynamoNTS_GlobalSettings.logResponseContent;
 

package/src/_models/dynamo-nts-global-settings.ts

@@ -1,13 +1,26 @@
 import { DynamoNTS_RouteSecurity } from '../_enums/dynamo-nts-route-security.enum';
+import { DynamoNTS_SocketSecurity } from '../_enums/dynamo-nts-socket-security.enum';
 
 /**
+ * 
+ * 
+ * @param logRequestsContent only will log if the specific logRequest is also true
+ * 
+ * @param logEventContent only will log if the specific socket event is also set to log
  * 
  */
 export interface DynamoNTS_GlobalSettings {
   baseUrl: string;
   defaultRouteSecurity: DynamoNTS_RouteSecurity;
+  defaultSocketSecurity: DynamoNTS_SocketSecurity;
+
   logSetup?: boolean;
-  logRequests?: boolean;
+
+  logRequest?: boolean;
   logRequestsContent?: boolean;
   logResponseContent?: boolean;
+
+  logMainSocketEvent?: boolean;
+  logAllSocketEvent?: boolean;
+  logEventContent?: boolean;
 }

package/src/_models/dynamo-nts-routing-module-settings.ts

@@ -0,0 +1,11 @@
+import { DynamoNTS_RouteSecurity } from '../_enums';
+import { DynamoNTS_Controller } from '../_services';
+
+/**
+ * 
+ */
+export interface DynamoNTS_RoutingModuleSettings {
+  route: string;
+  controllers: DynamoNTS_Controller[];
+  securityOverride?: DynamoNTS_RouteSecurity;
+}

package/src/_models/dynamo-nts-socket-event-params.ts

@@ -0,0 +1,99 @@
+
+
+import { DynamoNTS_Shared } from '../_services/dynamo-nts-shared.service';
+import { dynamoNTS_GlobalSettings } from '../_constants';
+import { DynamoNTS_SocketEvent } from '../_enums/http/socket-event.enum';
+
+/**
+ * 
+ */
+export class DynamoNTS_SocketEventParams<T>{
+  event: DynamoNTS_SocketEvent | string;
+  
+  preProcessess?: ((content?: T) => Promise<T>)[];
+  tasks: ((content?: T, issuer?: string) => Promise<void>)[];
+
+  logEvent: boolean;
+  logEventContent: boolean;
+
+  constructor(
+    set: {
+      event: DynamoNTS_SocketEvent | string,
+      
+      preProcessess?: ((content?: T) => Promise<T>)[],
+      tasks: ((content?: T, issuer?: string) => Promise<void>)[],
+
+      logEvent?: boolean,
+      logEventContent?: boolean,
+    }
+  ) {
+    try {
+      this.event = set.event;
+
+      this.preProcessess = set.preProcessess ? set.preProcessess : [];
+      this.tasks = set.tasks;
+
+      if (set.logEvent !== undefined) {
+        this.logEvent = set.logEvent;
+      } else if (this.event === DynamoNTS_SocketEvent.connection || this.event === DynamoNTS_SocketEvent.disconnect) {
+        this.logEvent = dynamoNTS_GlobalSettings.logMainSocketEvent;
+      } else {
+        this.logEvent = dynamoNTS_GlobalSettings.logAllSocketEvent;
+      }
+      this.logEventContent = set.logEventContent !== undefined ? set.logEventContent : dynamoNTS_GlobalSettings.logEventContent;
+
+      if (this.logEvent) {
+        this.preProcessess.unshift(this.getPreLog());
+      }
+    } catch (error) {
+      DynamoNTS_Shared.logError(
+        `\nSocket Event params setup failed: ${set.event}`, error);
+      throw error;
+    }
+  }
+
+  /**
+   * 
+   * @returns 
+   */
+  getPreLog(): (content: T) => Promise<T> {
+    return async (content: T) => {
+      try {
+        if (this.logEvent) {
+          if (this.logEventContent) {
+            console.log(`==> incoming ${this.event} socket event... content:`, content);
+          } else {
+            console.log(`==> incoming ${this.event} socket event...`);
+          }
+        }
+        return content;
+      } catch (error) {
+        console.error('PreLog failed....', error);
+      }
+    };
+  }
+
+  /**
+   * 
+   * @returns 
+   */
+  getFullExecution(issuer?: string): (content?: T) => Promise<void> {
+    return async (content?: T) => {
+      try {          
+        for (let i = 0; i < this.preProcessess.length; i++) {
+          content = await this.preProcessess[i](content);
+        }
+
+        for (let i = 0; i < this.tasks.length; i++) {
+          await this.tasks[i](content, issuer);
+        }
+      } catch (error) {
+        console.error(`Socket Event tasks failed to execute.... (${this.event})`, error, 'content:', content);
+      }
+    };
+  }
+}
+
+
+
+

package/src/_models/dynamo-nts-socket-module-settings.ts

@@ -0,0 +1,42 @@
+
+import { dynamoNTS_GlobalSettings } from '../_constants';
+import { DynamoNTS_SocketSecurity } from '../_enums/dynamo-nts-socket-security.enum';
+import { DynamoNTS_Shared } from '../_services';
+
+/**
+ * 
+ */
+export class DynamoNTS_SocketServiceSettings {
+  name: string;
+  port: number;
+  security?: DynamoNTS_SocketSecurity;
+  groupActiveSocketsBy?: string;
+
+  getIdFromSubscrioption?: (content: any) => string;
+
+  constructor(
+    set: {
+      name: string,
+      port: number,
+      security?: DynamoNTS_SocketSecurity,
+      groupActiveSocketsBy?: string,
+      
+      getIdFromSubscrioption?: (content: any) => string,
+    }
+  ) {
+    this.name = set.name;
+    this.port = set.port;
+    this.security = set.security ? set.security : dynamoNTS_GlobalSettings.defaultSocketSecurity;
+    
+    if (set.getIdFromSubscrioption) {
+      this.getIdFromSubscrioption = set.getIdFromSubscrioption;
+      if (set.groupActiveSocketsBy) {
+        DynamoNTS_Shared.logError(
+          `setting groupActiveSocketsBy on DynamoNTS_SocketService (${this.name}) won't take effect, ` +
+          `since getIdFromSubscrioption is also setted, so it will be used instead`)
+      }
+    } else if (set.groupActiveSocketsBy) {
+      this.getIdFromSubscrioption = content => content[set.groupActiveSocketsBy];
+    }  
+  }
+}

package/src/_models/index.ts

@@ -5,4 +5,7 @@ export * from './dynamo-nts-api-call-params';
 export * from './dynamo-nts-app-params';
 export * from './dynamo-nts-endpoint-params';
 export * from './dynamo-nts-global-settings';
+export * from './dynamo-nts-routing-module-settings';
+export * from './dynamo-nts-socket-event-params';
+export * from './dynamo-nts-socket-module-settings';
 

package/src/_modules/app-extended.index.ts

@@ -0,0 +1,20 @@
+
+// SERVICES
+export * from '../_services/dynamo-nts-app';
+export * from '../_services/dynamo-nts-app-extended';
+export * from '../_services/dynamo-nts-global.service';
+export * from '../_services/dynamo-nts-routing-module.service';
+export * from '../_services/dynamo-nts-shared.service';
+
+// MODELS
+export * from '../_models/dynamo-nts-app-params';
+export * from '../_models/dynamo-nts-endpoint-params';
+export * from '../_models/dynamo-nts-global-settings';
+export * from '../_models/dynamo-nts-routing-module-settings';
+
+// ENUMS
+export * from '../_enums/dynamo-nts-route-security.enum';
+
+// CONSTANTS
+export * from '../_constants/dynamo-nts-global.settings';
+

package/src/_modules/app.index.ts

@@ -1,7 +1,6 @@
 
 // SERVICES
 export * from '../_services/dynamo-nts-app';
-export * from '../_services/dynamo-nts-app-extended';
 export * from '../_services/dynamo-nts-global.service';
 export * from '../_services/dynamo-nts-routing-module.service';
 export * from '../_services/dynamo-nts-shared.service';
@@ -10,6 +9,7 @@ export * from '../_services/dynamo-nts-shared.service';
 export * from '../_models/dynamo-nts-app-params';
 export * from '../_models/dynamo-nts-endpoint-params';
 export * from '../_models/dynamo-nts-global-settings';
+export * from '../_models/dynamo-nts-routing-module-settings';
 
 // ENUMS
 export * from '../_enums/dynamo-nts-route-security.enum';

package/src/_modules/test/get-test-routing-module.ts

@@ -1,7 +1,8 @@
 
 import { testModuleSettings } from '@futdevpro/fsm-dynamo/test-module';
 import { DynamoNTS_RouteSecurity } from '../../_enums/dynamo-nts-route-security.enum';
-import { DynamoNTS_RoutingModule, DynamoNTS_RoutingModuleSettings } from '../../_services/dynamo-nts-routing-module.service';
+import { DynamoNTS_RoutingModuleSettings } from '../../_models/dynamo-nts-routing-module-settings';
+import { DynamoNTS_RoutingModule } from '../../_services/dynamo-nts-routing-module.service';
 import { TestController } from './test-controller';
 
 export function getTestRoutingModule(securityOverride?: DynamoNTS_RouteSecurity): DynamoNTS_RoutingModule {

package/src/_modules/usage/get-usage-routing-module.ts

@@ -1,7 +1,8 @@
 
 import { usageModuleSettings } from '@futdevpro/fsm-dynamo/usage-module';
 import { DynamoNTS_RouteSecurity } from '../../_enums/dynamo-nts-route-security.enum';
-import { DynamoNTS_RoutingModule, DynamoNTS_RoutingModuleSettings } from '../../_services/dynamo-nts-routing-module.service';
+import { DynamoNTS_RoutingModuleSettings } from '../../_models/dynamo-nts-routing-module-settings';
+import { DynamoNTS_RoutingModule } from '../../_services/dynamo-nts-routing-module.service';
 import { UsageController } from './usage-controller';
 
 export function getUsageRoutingModule(securityOverride?: DynamoNTS_RouteSecurity): DynamoNTS_RoutingModule {

package/src/_services/dynamo-nts-app-extended.ts

@@ -5,11 +5,8 @@ import * as Http from 'http';
 import { DynamoNTS_Shared } from './dynamo-nts-shared.service';
 import { DynamoNTS_RouteSecurity } from '../_enums/dynamo-nts-route-security.enum';
 import { DynamoNTS_App } from './dynamo-nts-app';
-
-export class DynamoBESocketModule { // NEW
-  security:DynamoNTS_RouteSecurity; 
-  port:number 
-}
+import { DynamoNTS_SocketService } from './dynamo-nts-socket.service';
+import { DynamoNTS_SocketSecurity } from '../_enums/dynamo-nts-socket-security.enum';
 
 /**
  * This will be the main service of our server project,
@@ -17,23 +14,36 @@ export class DynamoBESocketModule { // NEW
  * 
  * In this service, there are abstract functions that you will need to implement,
  * where you need to set up the main params for your application.
+ * 
+ * The extended App is containing socket server tools
+ * 
+ * You need to add socketService definitions to setupRoutingModules
+ * 
+ * @example
+ * ...
+ *   this.socketServices = [
+ *     NotificationService.getInstance(),
+ *     ChatService.getInstance(),
+ *     ...
+ *   ];
+ * ...
  */
 export abstract class DynamoNTS_AppExtended extends DynamoNTS_App {
+
+  private socketSecurity: DynamoNTS_RouteSecurity;
   
-  private openSocketServer: SocketIO.Server;
-  /* private secureSocketServer: SocketIO.Server; */
-  
-  protected socketModules: DynamoBESocketModule[];
+  protected socketServices: DynamoNTS_SocketService[] = [];
 
   constructor(){
     super();
 
     try {
+      if (0 < this.socketServices.length) {
+        this.setSocketSecurity();
 
-      if (0 < this.socketModules.length) { // NEW
-        if (this.security !== DynamoNTS_RouteSecurity.secure) {
-          this.initOpenSocketPorts();
-        }
+        this.setupSocketServices();
+
+        if (this.log) console.log(`\nAll sockets setted up.... sockets using security: ${this.socketSecurity}`);
       }
     } catch (error) {
       DynamoNTS_Shared.logError('\nExtended Application start failed.\n', error);
@@ -43,81 +53,86 @@ export abstract class DynamoNTS_AppExtended extends DynamoNTS_App {
   /**
    * 
    */
-  private initOpenSocketPorts(): void {  // NEW NEED SECURE AS WELL
-    const httpSocketServer: Http.Server = Http.createServer(this.openExpress);
-    this.openSocketServer = new SocketIO.Server(httpSocketServer);
-
-    this.socketModules.forEach((module: DynamoBESocketModule) => {
-      if (module.security !== DynamoNTS_RouteSecurity.secure) {
-        if (this.log) console.log(`socket mount (open): ${module.port}`);
-
-
-
-
-        const existingPorts: DynamoBESocketModule[] = this.socketModules.filter(
-            (mod: DynamoBESocketModule) => mod.port === module.port);
+  private setSocketSecurity(): void {
+    console.log('setSecurityExtended');
+    this.socketServices.forEach((service: DynamoNTS_SocketService) => {
+      if (!this.socketSecurity) {
+        this.socketSecurity = DynamoNTS_RouteSecurity[service.security];
+      } else if (this.socketSecurity !== DynamoNTS_RouteSecurity.both && this.socketSecurity !== DynamoNTS_RouteSecurity[service.security]) {
+        this.socketSecurity = DynamoNTS_RouteSecurity.both;
+      }
+    });
+  }
 
-        if (1 < existingPorts.length || this.httpPort === module.port || this.httpsPort === module.port) {
-          let error = new Error(`PORT DUPLICATION: ${module.port}`);
+  /**
+   * 
+   */
+  private setupSocketServices(): void {
+    let httpSocketServer: Http.Server;
+    if (this.socketSecurity !== DynamoNTS_RouteSecurity.secure) {
+      if (!this.openExpress) {
+        this.initOpenExpress();
+      }
+      httpSocketServer = Http.createServer(this.openExpress);
+    }
+    if (this.socketSecurity !== DynamoNTS_RouteSecurity.open) {
+      if (!this.httpsServer) {
+        if (this.cert) {
+          this.initSecureExpress();
+        } else {
+          let errorMsg: string =
+            `\nYou have secure socket service, but the certification paths are not set!` +
+            `\nset...` +
+            `\n  cert: {` +
+            `\n    keyPath: FileSystem.PathLike,` +
+            `\n    certPath: FileSystem.PathLike,` +
+            `\n  }` +
+            `\nin DynamoBEServer - setupRoutingModules() to enable secure routes.`;
+            
+          errorMsg += '\n\nThe socket services setted to use secure server:';
+          this.socketServices.forEach((service: DynamoNTS_SocketService) => {
+            if (service.security != DynamoNTS_SocketSecurity.open) {
+              errorMsg += `\n  ${service.name} (port: ${service.port})`;
+            }
+          });
+          DynamoNTS_Shared.logError(errorMsg);
+  
+          let error = new Error('Secure routes cannot be established!');
           let errorStack: string[] = error.stack.split('\n');
-          errorStack.splice(1, 4);
+          errorStack.splice(1, 2);
           error.stack = errorStack.join('\n');
   
           throw error;
         }
+      }
+    }
 
-        
-    const highlight = '\n\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!' +
-    '\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!' +
-    '\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!' +
-    '\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!';
-        
-    this.openSocketServer.on('disconnect', (socket) => {
-      console.log(highlight, `\nnew DISCONNECT ALFA: \n\n`, socket);
-    })
-    
-    this.openSocketServer.on('new message', (msg) => {
-      console.log(highlight, `\nnew MESSAGE ALFA: \n\n`, msg);
-    })
-
-    this.openSocketServer.on('connection', (socket) => {
-      console.log(highlight, `\nnew CONNECTION: \n\n`, socket);
-
-      socket.on('disconnect', (socket) => {
-        console.log(highlight, `\nnew DISCONNECT BETA: \n\n`, socket);
-      });
-      
-      socket.on('new message', (msg) => {
-        console.log(highlight, `\nnew MESSAGE BETA: \n\n`, msg);
-      });
-    })
-
-
-
-        this.openSocketServer.listen(module.port);
-
+    this.socketServices.forEach((service: DynamoNTS_SocketService) => {
+      const existingPorts: DynamoNTS_SocketService[] = this.socketServices.filter(
+          (mod: DynamoNTS_SocketService) => mod.port === service.port);
 
+      if (1 < existingPorts.length || this.httpPort === service.port || this.httpsPort === service.port) {
+        let error = new Error(`PORT DUPLICATION: ${service.port}`);
+        let errorStack: string[] = error.stack.split('\n');
+        errorStack.splice(1, 4);
+        error.stack = errorStack.join('\n');
 
-        this.openSocketServer.on('disconnect', (socket) => {
-          console.log(highlight, `\nnew DISCONNECT ALFA: \n\n`, socket);
-        })
-        
-        this.openSocketServer.on('new message', (msg) => {
-          console.log(highlight, `\nnew MESSAGE ALFA: \n\n`, msg);
-        })
-    
-        this.openSocketServer.on('connection', (socket) => {
-          console.log(highlight, `\nnew CONNECTION: \n\n`, socket);
-    
-          socket.on('disconnect', (socket) => {
-            console.log(highlight, `\nnew DISCONNECT BETA: \n\n`, socket);
-          });
-          
-          socket.on('new message', (msg) => {
-            console.log(highlight, `\nnew MESSAGE BETA: \n\n`, msg);
-          });
-        })
+        throw error;
+      }
 
+      if (service.security === DynamoNTS_SocketSecurity.open) {
+        if (this.log) console.log(`\nsocket setup (open): ${service.name}:${service.port}`);
+        service.setupSocketServer(new SocketIO.Server(httpSocketServer));
+      } else if (service.security === DynamoNTS_SocketSecurity.secure) {
+        if (this.log) console.log(`\nsocket setup (secure): ${service.name}:${service.port}`);
+        service.setupSocketServer(new SocketIO.Server(this.httpsServer));
+      } else {
+        let error = new Error(`INVALID Socket Service security: ${service.security} on ${service.name}`);
+        let errorStack: string[] = error.stack.split('\n');
+        errorStack.splice(1, 4);
+        error.stack = errorStack.join('\n');
+
+        throw error;
       }
     });
   }

package/src/_services/dynamo-nts-app.ts

@@ -36,9 +36,9 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
     certPath: FileSystem.PathLike,
   };
 
-  private secureExpress: Express.Application;
-  private httpsServer: Https.Server;
   protected openExpress: Express.Application;
+  private secureExpress: Express.Application;
+  protected httpsServer: Https.Server;
 
   protected routingModules: DynamoNTS_RoutingModule[];
 
@@ -175,7 +175,7 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
   /**
    * 
    */
-  private initOpenExpress(): void {
+  protected initOpenExpress(): void {
     this.openExpress = Express();    
     this.openExpress.use(BodyParser.urlencoded({ limit: '50mb', extended: true }));
     this.openExpress.use(BodyParser.json({ limit: '50mb' }));
@@ -184,7 +184,7 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
   /**
    * 
    */
-  private initSecureExpress(): void {
+   protected initSecureExpress(): void {
     this.secureExpress = Express();    
     this.secureExpress.use(BodyParser.urlencoded({ limit: '50mb', extended: true }));
     this.secureExpress.use(BodyParser.json({ limit: '50mb' }));
@@ -278,7 +278,8 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
   /**
    * 
    */
-  private setSecurity(): void {
+  protected setSecurity(): void {
+    console.log('setSecurity');
     this.routingModules.forEach((module: DynamoNTS_RoutingModule) => {
       if (!this.security) {
         this.security = module.security;
@@ -327,32 +328,34 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
    * You must setup endpoints and required services in this function
    * 
    * @example
-   * this.httpPort = env.httpPort;
-   * this.httpsPort = env.httpsPort;
-
-   * this.cert = {
-   *   keyPath: Path.join(__dirname, './_assets/cert/ucc.key'),
-   *   certPath: Path.join(__dirname, './_assets/cert/ucc.crt'),
-   * };
-
-   * this.routingModules = [
-   *   new DynamoBERountingModule({
-   *     route: '/api/account',
-   *     controllers: [
-   *       AccountController.getInstance(),
-   *       PersonalInformationController.getInstance(),
-   *       ...
-   *     ]
-   *   }),
-   *   new DynamoBERountingModule({
-   *     route: '/api/project',
-   *     controllers: [ 
-   *       ProjectController.getInstance(),
-   *       ProjectExtensionController.getInstance(),
-   *     ]
-   *   }),
-   *   ...
-   * ];
+   * setupRoutingModules(): void {
+   *   this.httpPort = env.httpPort;
+   *   this.httpsPort = env.httpsPort;
+   *
+   *   this.cert = {
+   *     keyPath: Path.join(__dirname, './_assets/cert/ucc.key'),
+   *     certPath: Path.join(__dirname, './_assets/cert/ucc.crt'),
+   *   };
+   *
+   *   this.routingModules = [
+   *     new DynamoBERountingModule({
+   *       route: '/api/account',
+   *       controllers: [
+   *         AccountController.getInstance(),
+   *         PersonalInformationController.getInstance(),
+   *         ...
+   *       ]
+   *     }),
+   *     new DynamoBERountingModule({
+   *       route: '/api/project',
+   *       controllers: [ 
+   *         ProjectController.getInstance(),
+   *         ProjectExtensionController.getInstance(),
+   *       ]
+   *     }),
+   *     ...
+   *   ];
+   * }
    */
   abstract setupRoutingModules(): void;
 }