@futdevpro/nts-dynamo 1.9.17 → 1.9.18

package/src/_services/route/controller.service.ts

@@ -1,17 +1,17 @@
 
 
-import { DynamoFM_Error, DynamoFM_ErrorLevel, DynamoFM_Log } from '@futdevpro/fsm-dynamo';
+import { DyFM_Error, DyFM_ErrorLevel, DyFM_Log } from '@futdevpro/fsm-dynamo';
 import { 
-  DynamoNTS_Endpoint_Params 
+  DyNTS_Endpoint_Params 
 } from '../../_models/control-models/endpoint-params.control-model';
 
-import { DynamoNTS_SingletonService } from '../base/singleton.service';
+import { DyNTS_SingletonService } from '../base/singleton.service';
 
 /**
  * Basic controller for endpoint handlings
  * 
  * @example
- * export class UserMatchStatisticsController extends DynamoNTS_Controller {
+ * export class UserMatchStatisticsController extends DyNTS_Controller {
  *
  * static getInstance(): UserMatchStatisticsController {
  *   return UserMatchStatisticsController.getSingletonInstance();
@@ -24,7 +24,7 @@ import { DynamoNTS_SingletonService } from '../base/singleton.service';
  *     this.authService = AuthService.getInstance();
  *
  *     this.endpoints = [
- *       new DynamoNTS_EndpointParams({
+ *       new DyNTS_EndpointParams({
  *         name: 'getUserMatchStatistics',
  *         type: DynamoNX_HttpCallType.get,
  *         endpoint: '/get/user-match-statistics/:userId',
@@ -47,7 +47,7 @@ import { DynamoNTS_SingletonService } from '../base/singleton.service';
  *   }
  * }
  */
-export abstract class DynamoNTS_Controller extends DynamoNTS_SingletonService {
+export abstract class DyNTS_Controller extends DyNTS_SingletonService {
 
   /**
    * setup this in the setupEndpoints(), which will be called on the construcion
@@ -55,7 +55,7 @@ export abstract class DynamoNTS_Controller extends DynamoNTS_SingletonService {
    * @example
    * 
    * this.endpoints = [
-   *   new DynamoNTS_EndpointParams({
+   *   new DyNTS_EndpointParams({
    *     name: 'getUserMatchStatistics',
    *     type: DynamoNX_HttpCallType.get,
    *     endpoint: '/get/user-match-statistics/:userId',
@@ -76,7 +76,7 @@ export abstract class DynamoNTS_Controller extends DynamoNTS_SingletonService {
    *   }),
    * ];
    */
-  endpoints: DynamoNTS_Endpoint_Params[];
+  endpoints: DyNTS_Endpoint_Params[];
 
   /* protected constructor(){
     super();
@@ -84,12 +84,12 @@ export abstract class DynamoNTS_Controller extends DynamoNTS_SingletonService {
     try {
       this.setupEndpoints();
     } catch (error) {
-      throw new DynamoFM_Error({
+      throw new DyFM_Error({
         message: 'DynamoBEController setup failed. Please check the setupEndpoints() method.',
         errorCode: 'NTS-COS-000',
         issuerService: this?.constructor?.name,
         error: error,
-        level: DynamoFM_ErrorLevel.critical,
+        level: DyFM_ErrorLevel.critical,
       });
     }
   } */
@@ -103,7 +103,7 @@ export abstract class DynamoNTS_Controller extends DynamoNTS_SingletonService {
    *   this.authService = AuthService.getInstance();
    *
    *   this.endpoints = [
-   *     new DynamoNTS_EndpointParams({
+   *     new DyNTS_EndpointParams({
    *       name: 'getUserMatchStatistics',
    *       type: DynamoNX_HttpCallType.get,
    *       endpoint: '/get/user-match-statistics/:userId',

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

@@ -1,17 +1,17 @@
 
 import { Router } from 'express';
 
-import { DynamoFM_AnyError, DynamoFM_Error, DynamoFM_ErrorLevel, DynamoFM_Error_Settings, DynamoFM_Log } from '@futdevpro/fsm-dynamo';
+import { DyFM_AnyError, DyFM_Error, DyFM_ErrorLevel, DyFM_Error_Settings, DyFM_Log } from '@futdevpro/fsm-dynamo';
 
-import { DynamoNTS_globalSettings } from '../../_constants/global-settings.const';
-import { DynamoNTS_RouteSecurity } from '../../_enums/route-security.enum';
-import { DynamoNTS_HttpCallType } from '../../_enums/http/http-call-type.enum';
-import { DynamoNTS_Controller } from './controller.service';
+import { DyNTS_globalSettings } from '../../_constants/global-settings.const';
+import { DyNTS_RouteSecurity } from '../../_enums/route-security.enum';
+import { DyNTS_HttpCallType } from '../../_enums/http/http-call-type.enum';
+import { DyNTS_Controller } from './controller.service';
 import { 
-  DynamoNTS_RoutingModule_Settings 
+  DyNTS_RoutingModule_Settings 
 } from '../../_models/interfaces/routing-module-settings.interface';
 import { 
-  DynamoNTS_Endpoint_Params 
+  DyNTS_Endpoint_Params 
 } from '../../_models/control-models/endpoint-params.control-model';
 
 /**
@@ -25,7 +25,7 @@ import {
  *     this.httpPort = env.port;
 
  *     this.routingModules = [
- *       new DynamoNTS_RoutingModule({
+ *       new DyNTS_RoutingModule({
  *         route: '/user',
  *         controllers: [ 
  *           UserController.getInstance(),
@@ -36,7 +36,7 @@ import {
  *           UserNotificationsController.getInstance()
  *         ]
  *       }),
- *       new DynamoNTS_RoutingModule({
+ *       new DyNTS_RoutingModule({
  *         route: '/match',
  *         controllers: [ 
  *           MatchController.getInstance(),
@@ -44,7 +44,7 @@ import {
  *           MatchStatisticsController.getInstance(),
  *         ]
  *       }),
- *       new DynamoNTS_RoutingModule({
+ *       new DyNTS_RoutingModule({
  *         route: '/server',
  *         controllers: [ 
  *           ServerController.getInstance(),
@@ -56,31 +56,31 @@ import {
  *     ];
  *   }
  */
-export class DynamoNTS_RoutingModule {
+export class DyNTS_RoutingModule {
 
   /* serviceName: string; */
   
-  security: DynamoNTS_RouteSecurity;
+  security: DyNTS_RouteSecurity;
   route: string;
 
-  private controllers: DynamoNTS_Controller[];
-  endpoints: DynamoNTS_Endpoint_Params[] = [];
+  private controllers: DyNTS_Controller[];
+  endpoints: DyNTS_Endpoint_Params[] = [];
 
   openRouter: Router = Router();
   secureRouter: Router = Router();
 
-  protected log: boolean = DynamoNTS_globalSettings.logSetup;
+  protected log: boolean = DyNTS_globalSettings.logSetup;
 
   defaultErrorUserMsg = 
     `We encountered an uncaught BackEnd Build Error, ` +
     `\nplease contact the responsible development team.`;
 
   constructor(
-    set: DynamoNTS_RoutingModule_Settings
+    set: DyNTS_RoutingModule_Settings
   ){
     try {
       /* this.serviceName = set.route.replace('/', '') + 'RoutingModule'; */
-      this.route = DynamoNTS_globalSettings.baseUrl + set.route;
+      this.route = DyNTS_globalSettings.baseUrl + set.route;
       this.controllers = set.controllers ?? [];
       this.setupRoutes();
       this.mountRoutes(set.securityOverride);
@@ -89,8 +89,8 @@ export class DynamoNTS_RoutingModule {
         `routing module setup done: ${this.route} security: ${this.security}\n`
       );
     } catch (error) {
-      /* DynamoFM_Log.error(`\nRouting module setup failed (${this.route})`, error); */
-      throw new DynamoFM_Error({
+      /* DyFM_Log.error(`\nRouting module setup failed (${this.route})`, error); */
+      throw new DyFM_Error({
         ...this.getDefaultErrorSettings(
           'constructor', 
           new Error(`Routing module setup failed (${this.route}).`)
@@ -106,18 +106,18 @@ export class DynamoNTS_RoutingModule {
    * You must setup endpoints and required services for this function
    */
   private setupRoutes(): void {
-    this.controllers.forEach((controller: DynamoNTS_Controller): void => {
+    this.controllers.forEach((controller: DyNTS_Controller): void => {
       try {
         controller.setupEndpoints();
       } catch (error) {
-        throw new DynamoFM_Error({
+        throw new DyFM_Error({
           ...this.getDefaultErrorSettings(
             'setupRoutes', 
             new Error(`DynamoBEController setup failed. Please check the setupEndpoints() method.`)
           ),
 
           errorCode: 'NTS-RMS-SR1',
-          level: DynamoFM_ErrorLevel.critical,
+          level: DyFM_ErrorLevel.critical,
         });
       }
     
@@ -131,29 +131,29 @@ export class DynamoNTS_RoutingModule {
    * 
    * @param securityOverride 
    */
-  private mountRoutes(securityOverride?: DynamoNTS_RouteSecurity): void {
+  private mountRoutes(securityOverride?: DyNTS_RouteSecurity): void {
     if (securityOverride) {
       this.security = securityOverride;
     }
 
-    this.endpoints.forEach((endpoint: DynamoNTS_Endpoint_Params): void => {
+    this.endpoints.forEach((endpoint: DyNTS_Endpoint_Params): void => {
       if (securityOverride) {
         endpoint.security = securityOverride;
       } else {
         if (!endpoint.security) {
-          DynamoFM_Log.error(`Endpoint security not set: ${endpoint.endpoint}\n`);
+          DyFM_Log.error(`Endpoint security not set: ${endpoint.endpoint}\n`);
         } else if (!this.security) {
           this.security = endpoint.security;
         } else if (this.security !== endpoint.security) {
-          this.security = DynamoNTS_RouteSecurity.both;
+          this.security = DyNTS_RouteSecurity.both;
         }
       }
 
       if (this.log) console.log(
         `endpoint mount (${endpoint.security}): ${this.route}${endpoint.endpoint}`
       );
-      const existingEndPoints: DynamoNTS_Endpoint_Params[] = this.endpoints.filter(
-        (e_params: DynamoNTS_Endpoint_Params): boolean => e_params.endpoint === endpoint.endpoint
+      const existingEndPoints: DyNTS_Endpoint_Params[] = this.endpoints.filter(
+        (e_params: DyNTS_Endpoint_Params): boolean => e_params.endpoint === endpoint.endpoint
       );
         
       if (1 < existingEndPoints.length) {
@@ -167,17 +167,17 @@ export class DynamoNTS_RoutingModule {
       }
 
       try {
-        if (endpoint.security !== DynamoNTS_RouteSecurity.secure) {
+        if (endpoint.security !== DyNTS_RouteSecurity.secure) {
           this.mountOpenRoute(endpoint);
         }
 
-        if (endpoint.security !== DynamoNTS_RouteSecurity.open) {
+        if (endpoint.security !== DyNTS_RouteSecurity.open) {
           this.mountSecureRoute(endpoint);
         }
       } catch (error) {
-        DynamoFM_Log.error(`\nRouting module setup failed (${this.route})`, error);
+        DyFM_Log.error(`\nRouting module setup failed (${this.route})`, error);
 
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this.getDefaultErrorSettings(
             'mountRoutes', 
             new Error(`DYNAMO-NTS ERROR: Failed to mount routes.`)
@@ -193,32 +193,32 @@ export class DynamoNTS_RoutingModule {
    * 
    * @param endpointParams 
    */
-  private mountOpenRoute(endpointParams: DynamoNTS_Endpoint_Params): void {
+  private mountOpenRoute(endpointParams: DyNTS_Endpoint_Params): void {
     switch (endpointParams.type) {
-      case DynamoNTS_HttpCallType.get:
+      case DyNTS_HttpCallType.get:
         this.openRouter.get(endpointParams.endpoint, endpointParams.getFullExecution());
         break;
 
-      case DynamoNTS_HttpCallType.post:
+      case DyNTS_HttpCallType.post:
         this.openRouter.post(endpointParams.endpoint, endpointParams.getFullExecution());
         break;
 
-      case DynamoNTS_HttpCallType.put:
+      case DyNTS_HttpCallType.put:
         this.openRouter.put(endpointParams.endpoint, endpointParams.getFullExecution());
         break;
 
-      case DynamoNTS_HttpCallType.patch:
+      case DyNTS_HttpCallType.patch:
         this.openRouter.patch(endpointParams.endpoint, endpointParams.getFullExecution());
         break;
 
-      case DynamoNTS_HttpCallType.delete:
+      case DyNTS_HttpCallType.delete:
         this.openRouter.delete(endpointParams.endpoint, endpointParams.getFullExecution());
         break;
 
       default:
-        DynamoFM_Log.error(`INVALID route type: ${endpointParams.type} - ${endpointParams.name}`);
+        DyFM_Log.error(`INVALID route type: ${endpointParams.type} - ${endpointParams.name}`);
 
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this.getDefaultErrorSettings(
             'mountOpenRoute', 
             new Error(
@@ -236,34 +236,34 @@ export class DynamoNTS_RoutingModule {
    * 
    * @param endpointParams 
    */
-  private mountSecureRoute(endpointParams: DynamoNTS_Endpoint_Params): void {
+  private mountSecureRoute(endpointParams: DyNTS_Endpoint_Params): void {
     switch (endpointParams.type) {
-      case DynamoNTS_HttpCallType.get:
+      case DyNTS_HttpCallType.get:
         this.secureRouter.get(endpointParams.endpoint, endpointParams.getFullExecution());
         break;
 
-      case DynamoNTS_HttpCallType.post:
+      case DyNTS_HttpCallType.post:
         this.secureRouter.post(endpointParams.endpoint, endpointParams.getFullExecution());
         break;
 
-      case DynamoNTS_HttpCallType.put:
+      case DyNTS_HttpCallType.put:
         this.secureRouter.put(endpointParams.endpoint, endpointParams.getFullExecution());
         break;
 
-      case DynamoNTS_HttpCallType.patch:
+      case DyNTS_HttpCallType.patch:
         this.secureRouter.patch(endpointParams.endpoint, endpointParams.getFullExecution());
         break;
 
-      case DynamoNTS_HttpCallType.delete:
+      case DyNTS_HttpCallType.delete:
         this.secureRouter.delete(endpointParams.endpoint, endpointParams.getFullExecution());
         break;
 
       default:
-        DynamoFM_Log.error(
+        DyFM_Log.error(
           `DYNAMO-NTS ERROR: INVALID route type: ${endpointParams.type} - ${endpointParams.name}`
         );
 
-        throw new DynamoFM_Error({ 
+        throw new DyFM_Error({ 
           ...this.getDefaultErrorSettings(
             'mountSecureRoute', 
             new Error(
@@ -279,13 +279,13 @@ export class DynamoNTS_RoutingModule {
 
   private getDefaultErrorSettings(
     fnName: string, 
-    error: DynamoFM_AnyError
-  ): DynamoFM_Error_Settings {
+    error: DyFM_AnyError
+  ): DyFM_Error_Settings {
     return {
       status: 500,
       message: (error as Error)?.message ?? `${fnName} was UNSUCCESSFUL (NTS)`,
       issuerService: this.constructor?.name,
-      userMessage: (error as DynamoFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
       addECToUserMsg: true,
       error: error,
     };

package/src/_services/server/app-extended.server.spec.ts

@@ -1,16 +1,16 @@
-import { DynamoFM_delay } from '@futdevpro/fsm-dynamo';
+import { DyFM_delay } from '@futdevpro/fsm-dynamo';
 import { 
-  DynamoNTS_AppExtendedBase_Mock, DynamoNTS_AppExtendedFull_Mock, DynamoNTS_AppWbMock_Mock 
+  DyNTS_AppExtendedBase_Mock, DyNTS_AppExtendedFull_Mock, DyNTS_AppWbMock_Mock 
 } from '../../_constants/mocks/app-extended-server.mock';
 
-describe('DynamoNTS_AppExtended;', (): void => {
+describe('DyNTS_AppExtended;', (): void => {
   describe('a extended-base instance;', (): void => {
-    let app: DynamoNTS_AppExtendedBase_Mock;
+    let app: DyNTS_AppExtendedBase_Mock;
 
     beforeEach(async (): Promise<void> => {
-      app = new DynamoNTS_AppExtendedBase_Mock();
+      app = new DyNTS_AppExtendedBase_Mock();
 
-      await DynamoFM_delay(100);
+      await DyFM_delay(100);
       
       await app.ready();
     });
@@ -18,7 +18,7 @@ describe('DynamoNTS_AppExtended;', (): void => {
     afterEach(async (): Promise<void> => {
       await app.stop();
 
-      await DynamoFM_delay(100);
+      await DyFM_delay(100);
     });
 
     it('should be created', (): void => {
@@ -31,10 +31,10 @@ describe('DynamoNTS_AppExtended;', (): void => {
   });
 
   describe('a extended-full instance;', (): void => {
-    let app: DynamoNTS_AppExtendedFull_Mock;
+    let app: DyNTS_AppExtendedFull_Mock;
 
     beforeEach(async (): Promise<void> => {
-      app = new DynamoNTS_AppExtendedFull_Mock();
+      app = new DyNTS_AppExtendedFull_Mock();
       await app.ready();
     });
 
@@ -52,17 +52,17 @@ describe('DynamoNTS_AppExtended;', (): void => {
   });
 
   describe('a wb-mock instance;', (): void => {
-    let app: DynamoNTS_AppWbMock_Mock;
+    let app: DyNTS_AppWbMock_Mock;
 
     beforeEach(async (): Promise<void> => {
-      app = new DynamoNTS_AppWbMock_Mock();
+      app = new DyNTS_AppWbMock_Mock();
       await app.ready();
     });
 
     afterEach(async (): Promise<void> => {
       await app.stop();
 
-      await DynamoFM_delay(100);
+      await DyFM_delay(100);
     });
 
     it('should be created', (): void => {