@futdevpro/nts-dynamo 1.9.15 → 1.9.17

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

@@ -1,307 +1,309 @@
-
-
-import { Request, Response } from 'express';
-
-import { DynamoFM_Array, DynamoFM_Error, DynamoFM_Log } from '@futdevpro/fsm-dynamo';
-import { DynamoNTS_RouteSecurity } from '../../_enums/route-security.enum';
-import { DynamoNTS_HttpCallType } from '../../_enums/http/http-call-type.enum';
-import { DynamoNTS_globalSettings } from '../../_constants/global-settings.const';
-import { DynamoNTS_GlobalService } from '../../_services/core/global.service';
-
-/**
- * High level endpoint for API
- * used for specific events such as saving or getting data,
- * triggering events, logging in or out, and much more
- */
-export class DynamoNTS_Endpoint_Params {
-  name: string;
-  security: DynamoNTS_RouteSecurity;
-
-  type: DynamoNTS_HttpCallType;
-  endpoint: string;
-
-  private pathParams: string[];
-
-  private preProcesses: ((req: Request, res: Response) => Promise<void>)[];
-  private tasks: ((req: Request, res: Response, issuer?: string) => Promise<void>)[];
-
-  private logRequest: boolean;
-  private logRequestsParams: boolean;
-  private logRequestsContent: boolean;
-  private logResponseContent: boolean;
-
-  constructor(
-    set: {
-      /**
-       * naming the endpoint will help to follow events on service
-       */
-      name: string,
-      /**
-       * security settings for API, different security paths will need different handlers 
-       * 
-       * open; http, secure; https or both
-       */
-      security?: DynamoNTS_RouteSecurity,
-
-      /**
-       * define basic Http Call Type such as; get, post, put, patch, delete
-       */
-      type: DynamoNTS_HttpCallType,
-      /**
-       * set endpoint here, without baseUrl and route module path
-       * 
-       * like: '/get-user/:userId'
-       */
-      endpoint: string,
-      
-      /**
-       * preProcesses are the functions you need to run before the actual function,
-       * such as authentications
-       */
-      preProcesses?: ((req: Request, res: Response) => Promise<void>)[],
-      /**
-       * the actual tasks to run, 
-       * the last one should contain the res.send(); execution to send response on API requests
-       */
-      tasks: ((req: Request, res: Response, issuer?: string) => Promise<void>)[],
-
-      /**
-       * this flag will enable the debug logs on this endpoint
-       */
-      logRequest?: boolean,
-      /**
-       * this flag will enable the debug logs on this endpoint's requests
-       */
-      logRequestsParams?: boolean,
-      /**
-       * this flag will enable the debug logs on this endpoint's requests
-       */
-      logRequestsContent?: boolean,
-      /**
-       * this flag will enable detailed debug logs on this endpoint's requests
-       */
-      logResponseContent?: boolean,
-    }
-  ) {
-    try {
-      this.name = set.name ?? set.endpoint;
-      this.security = set.security ?? DynamoNTS_globalSettings.defaultRouteSecurity;
-
-      this.type = set.type;
-      this.endpoint = set.endpoint;
-
-      if (!this.endpoint) {
-        throw new DynamoFM_Error({
-          status: 406, 
-          errorCode: 'NTS-EP0-C00',
-          addECToUserMsg: true,
-          message: 'trying to create DynamoNTS_EndpointParams without endpoint value',
-          userMessage: 
-            'We encountered an unhandled Server Error, ' +
-            'please contact the responsible development team.',
-          additionalContent: set,
-        });
-      }
-
-      let pathParts: string[] = this.endpoint.split('/');
-
-      pathParts = pathParts.filter((part: string): boolean => part[0] === ':');
-      pathParts = pathParts.map((part: string): string => part.replace(':', ''));
-      this.pathParams = pathParts;
-
-      this.preProcesses = set.preProcesses ?? [];
-      this.tasks = set.tasks ?? [];
-
-      this.logRequest = set.logRequest ?? DynamoNTS_globalSettings.logRequest;
-      this.logRequestsParams = set.logRequestsParams ?? DynamoNTS_globalSettings.logRequestsParams;
-      this.logRequestsContent = 
-        set.logRequestsContent ?? DynamoNTS_globalSettings.logRequestsContent;
-      this.logResponseContent = 
-        set.logResponseContent ?? DynamoNTS_globalSettings.logResponseContent;
-    } catch (error) {
-      DynamoFM_Log.error(
-        `\nEndpoint params setup failed: name: '${set.name}' ` +
-          `(security: ${set.security}) endpoint: ${set.endpoint}` +
-        `\nERROR:` +
-        `\n`, error
-      );
-
-      throw error;
-    }
-  }
-
-  /**
-   * 
-   * @returns 
-   */
-  private async preLog(req: Request, res: Response, issuer: string): Promise<void> {
-    try {
-      if (this.logRequest) {
-        let msg: string = `\n===>>>      incoming '${this.name}' request... (issuer: ${issuer})`;
-
-        if (this.logRequestsParams) {
-          const params = this.getPathParamsLogContent(req);
-
-          msg += `\npathParams: ${params}`;
-        }
-
-        if (this.logRequestsContent && req.body && 0 < Object.keys(req.body).length) {
-          DynamoFM_Log.info(msg + `\nbody:`, req.body);
-        } else {
-          DynamoFM_Log.info(msg);
-        }
-      }
-
-    } catch (error) {
-      this.error(req, res, error, issuer);
-    }
-  }
-
-  /**
-   * 
-   * @returns 
-   */
-  getFullExecution(): (req: Request, res: Response) => Promise<void> {
-    let issuer: string;
-
-    return async (req: Request, res: Response): Promise<void> => {
-      try {
-        issuer = DynamoNTS_GlobalService?.getAuthService()?.getIssuerFromRequest(req);
-        
-        if (this.logRequest) {
-          await this.preLog(req, res, issuer);
-        }
-
-        await DynamoFM_Array.asyncForEach(this.preProcesses, 
-          async (preProcess: (req: Request, res: Response) => Promise<void>): Promise<void> => {
-            await preProcess(req, res);
-          }
-        );
-  
-        await DynamoFM_Array.asyncForEach(this.tasks,
-          async (
-            task: (req: Request, res: Response, issuer?: string) => Promise<void>
-          ): Promise<void> => {
-            await task(req, res, issuer);
-          }
-        );
-  
-        if (this.logRequest) {
-          if (this.logResponseContent) {
-            DynamoFM_Log.success(`  <<<=====   '${this.name}' result sent.`);
-            DynamoFM_Log.warn('sorry, the logResponseContent is not implemented yet.');
-          } else {
-            DynamoFM_Log.success(`  <<<=====   '${this.name}' result sent.`);
-          }
-        }
-      } catch (error) {
-        this.error(req, res, error, issuer);
-      }
-    };
-  }
-
-  /**
-   * 
-   * @param res 
-   * @param error 
-   */
-  private async error(
-    req: Request, 
-    res: Response, 
-    error: Error | DynamoFM_Error, 
-    issuer: string
-  ): Promise<void> {
-    try {
-      let msg: string = `Endpoint catched an error. '${this.name}' (${this.endpoint})`;
-
-      msg += this.getPathParamsLogContent(req);
-
-      DynamoFM_Log.error(msg);
-      DynamoFM_Log.error(
-        'ERROR:',
-        (error as DynamoFM_Error)?.flag?.includes('DYNAMO') ? 
-          (error as DynamoFM_Error).getErrorSimplified() : 
-          error, 
-        '\n'
-      );
-
-      if ((error as DynamoFM_Error)?.flag?.includes('DYNAMO')) {
-        if (!(error as DynamoFM_Error).additionalContent) {
-          (error as DynamoFM_Error).additionalContent = {};
-        }
-        (error as DynamoFM_Error).additionalContent.endpointInfo = msg;
-        DynamoFM_Log.error(`ErrorMessage: ${(error as DynamoFM_Error)._message}`);
-        DynamoFM_Log.error(`ErrorCode: ${(error as DynamoFM_Error)._errorCode}`);
-      }
-
-      await DynamoNTS_GlobalService.globalErrorHandler?.(
-        error, 
-        req, 
-        res, 
-        issuer
-      ).catch((err): void => {
-        DynamoFM_Log.warn(
-          'DynamoNTS_GlobalService.globalErrorHandler failed to handle error: ', 
-          err
-        );
-        DynamoFM_Log.warn('It will proceed as normal.');
-      });
-
-      if (
-        (error as DynamoFM_Error)?.flag?.includes('DYNAMO') && 
-        (error as DynamoFM_Error).confidentialContent
-      ) {
-        delete (error as DynamoFM_Error).confidentialContent;
-      }
-
-      res.status((error as DynamoFM_Error)?.___status ?? 501);
-      res.send(error);
-
-      if (this.logRequest) {
-        if (this.logResponseContent) {
-          DynamoFM_Log.error(
-            `  <<<=====   '${this.name}' error sent: ${(error as DynamoFM_Error)?._message ?? ''}`
-          );
-          DynamoFM_Log.error(
-            'sorry, the logResponseContent is not implemented yet.'
-          );
-        } else {
-          DynamoFM_Log.error(
-            `  <<<=====   '${this.name}' error sent: ${(error as DynamoFM_Error)?._message ?? ''}`
-          );
-        }
-      }
-
-      DynamoFM_Log.error('');
-          
-    } catch (error) {
-      DynamoFM_Log.H_error(
-        `\n\nDYNAMO MULTILEVEL ERROR:DynamoNTS_EndpointParams: error: ` +
-          `(${this.name}, ${this.endpoint})` +
-        `\n(DYNAMO MULTILEVEL ERROR means, that the ERROR HANDLING is ALSO FAILED, ` +
-          `and the error message was not sent.)` + 
-        `\nERROR:`, error, 
-        '\n'
-      );
-
-      if (error?.flag?.includes?.('DYNAMO-ERROR-OBJECT')) {
-        DynamoFM_Log.error(`ErrorMessage: ${(error as DynamoFM_Error)._message}`);
-        DynamoFM_Log.error(`ErrorCode: ${(error as DynamoFM_Error)._errorCode}`);
-      }
-    }
-  }
-
-  private getPathParamsLogContent(req: Request): string {
-    let params: string = '';
-    
-    this.pathParams.forEach((param: string): void => {
-      params += `\n${param}: ${req.params[param]}`;
-    });
-
-    return params;
-  }
-}
-
-
-
-
+
+
+import { Request, Response } from 'express';
+
+import { DynamoFM_Array, DynamoFM_Error, DynamoFM_Log } from '@futdevpro/fsm-dynamo';
+import { DynamoNTS_RouteSecurity } from '../../_enums/route-security.enum';
+import { DynamoNTS_HttpCallType } from '../../_enums/http/http-call-type.enum';
+import { DynamoNTS_globalSettings } from '../../_constants/global-settings.const';
+import { DynamoNTS_GlobalService } from '../../_services/core/global.service';
+
+/**
+ * High level endpoint for API
+ * used for specific events such as saving or getting data,
+ * triggering events, logging in or out, and much more
+ */
+export class DynamoNTS_Endpoint_Params {
+  name: string;
+  security: DynamoNTS_RouteSecurity;
+
+  type: DynamoNTS_HttpCallType;
+  endpoint: string;
+
+  private pathParams: string[];
+
+  private preProcesses: ((req: Request, res: Response) => Promise<void>)[];
+  private tasks: ((req: Request, res: Response, issuer?: string) => Promise<void>)[];
+
+  private logRequest: boolean;
+  private logRequestsParams: boolean;
+  private logRequestsContent: boolean;
+  private logResponseContent: boolean;
+
+  constructor(
+    set: {
+      /**
+       * naming the endpoint will help to follow events on service
+       */
+      name: string,
+      /**
+       * security settings for API, different security paths will need different handlers 
+       * 
+       * open; http, secure; https or both
+       */
+      security?: DynamoNTS_RouteSecurity,
+
+      /**
+       * define basic Http Call Type such as; get, post, put, patch, delete
+       */
+      type: DynamoNTS_HttpCallType,
+      /**
+       * set endpoint here, without baseUrl and route module path
+       * 
+       * like: '/get-user/:userId'
+       */
+      endpoint: string,
+      
+      /**
+       * preProcesses are the functions you need to run before the actual function,
+       * such as authentications
+       */
+      preProcesses?: ((req: Request, res: Response) => Promise<void>)[],
+      /**
+       * the actual tasks to run, 
+       * the last one should contain the res.send(); execution to send response on API requests
+       */
+      tasks: ((req: Request, res: Response, issuer?: string) => Promise<void>)[],
+
+      /**
+       * this flag will enable the debug logs on this endpoint
+       */
+      logRequest?: boolean,
+      /**
+       * this flag will enable the debug logs on this endpoint's requests
+       */
+      logRequestsParams?: boolean,
+      /**
+       * this flag will enable the debug logs on this endpoint's requests
+       */
+      logRequestsContent?: boolean,
+      /**
+       * this flag will enable detailed debug logs on this endpoint's requests
+       */
+      logResponseContent?: boolean,
+    }
+  ) {
+    try {
+      this.name = set.name ?? set.endpoint;
+      this.security = set.security ?? DynamoNTS_globalSettings.defaultRouteSecurity;
+
+      this.type = set.type;
+      this.endpoint = set.endpoint;
+
+      if (!this.endpoint) {
+        throw new DynamoFM_Error({
+          status: 406, 
+          errorCode: 'NTS-EP0-C00',
+          addECToUserMsg: true,
+          message: 'trying to create DynamoNTS_EndpointParams without endpoint value',
+          userMessage: 
+            'We encountered an unhandled Server Error, ' +
+            'please contact the responsible development team.',
+          additionalContent: set,
+        });
+      }
+
+      let pathParts: string[] = this.endpoint.split('/');
+
+      pathParts = pathParts.filter((part: string): boolean => part[0] === ':');
+      pathParts = pathParts.map((part: string): string => part.replace(':', ''));
+      this.pathParams = pathParts;
+
+      this.preProcesses = set.preProcesses ?? [];
+      this.tasks = set.tasks ?? [];
+
+      this.logRequest = set.logRequest ?? DynamoNTS_globalSettings.logRequest;
+      this.logRequestsParams = set.logRequestsParams ?? DynamoNTS_globalSettings.logRequestsParams;
+      this.logRequestsContent = 
+        set.logRequestsContent ?? DynamoNTS_globalSettings.logRequestsContent;
+      this.logResponseContent = 
+        set.logResponseContent ?? DynamoNTS_globalSettings.logResponseContent;
+    } catch (error) {
+      DynamoFM_Log.error(
+        `\nEndpoint params setup failed: name: '${set.name}' ` +
+          `(security: ${set.security}) endpoint: ${set.endpoint}` +
+        `\nERROR:` +
+        `\n`, error
+      );
+
+      throw error;
+    }
+  }
+
+  /**
+   * 
+   * @returns 
+   */
+  private async preLog(req: Request, res: Response, issuer: string): Promise<void> {
+    try {
+      if (this.logRequest) {
+        let msg: string = `\n===>>>      incoming '${this.name}' request... (issuer: ${issuer})`;
+
+        if (this.logRequestsParams) {
+          const params = this.getPathParamsLogContent(req);
+
+          msg += `\npathParams: ${params}`;
+        }
+
+        if (this.logRequestsContent && req.body && 0 < Object.keys(req.body).length) {
+          DynamoFM_Log.info(msg + `\nbody:`, req.body);
+        } else {
+          DynamoFM_Log.info(msg);
+        }
+      }
+
+    } catch (error) {
+      this.error(req, res, error, issuer);
+    }
+  }
+
+  /**
+   * 
+   * @returns 
+   */
+  getFullExecution(): (req: Request, res: Response) => Promise<void> {
+    let issuer: string;
+
+    return async (req: Request, res: Response): Promise<void> => {
+      try {
+        issuer = DynamoNTS_GlobalService?.getAuthService()?.getIssuerFromRequest(req);
+        
+        if (this.logRequest) {
+          await this.preLog(req, res, issuer);
+        }
+
+        await DynamoFM_Array.asyncForEach(this.preProcesses, 
+          async (preProcess: (req: Request, res: Response) => Promise<void>): Promise<void> => {
+            await preProcess(req, res);
+          }
+        );
+  
+        await DynamoFM_Array.asyncForEach(this.tasks,
+          async (
+            task: (req: Request, res: Response, issuer?: string) => Promise<void>
+          ): Promise<void> => {
+            await task(req, res, issuer);
+          }
+        );
+  
+        if (this.logRequest) {
+          if (this.logResponseContent) {
+            DynamoFM_Log.success(`  <<<=====   '${this.name}' result sent.`);
+            DynamoFM_Log.warn('sorry, the logResponseContent is not implemented yet.');
+          } else {
+            DynamoFM_Log.success(`  <<<=====   '${this.name}' result sent.`);
+          }
+        }
+      } catch (error) {
+        this.error(req, res, error, issuer);
+      }
+    };
+  }
+
+  /**
+   * 
+   * @param res 
+   * @param error 
+   */
+  private async error(
+    req: Request, 
+    res: Response, 
+    error: Error | DynamoFM_Error, 
+    issuer: string
+  ): Promise<void> {
+    try {
+      let msg: string = `Endpoint catched an error. '${this.name}' (${this.endpoint})`;
+
+      msg += this.getPathParamsLogContent(req);
+
+      DynamoFM_Log.error(msg);
+      DynamoFM_Log.error(
+        'ERROR:',
+        (error as DynamoFM_Error)?.flag?.includes('DYNAMO') ? 
+          (error as DynamoFM_Error).getErrorSimplified() : 
+          error, 
+        '\n'
+      );
+
+      if ((error as DynamoFM_Error)?.flag?.includes('DYNAMO')) {
+        if (!(error as DynamoFM_Error).additionalContent) {
+          (error as DynamoFM_Error).additionalContent = {};
+        }
+        (error as DynamoFM_Error).additionalContent.endpointInfo = msg;
+        DynamoFM_Log.error(`ErrorMessage: ${(error as DynamoFM_Error)._message}`);
+        DynamoFM_Log.error(`ErrorCode: ${(error as DynamoFM_Error)._errorCode}`);
+        DynamoFM_Log.error(`UserMessage: ${(error as DynamoFM_Error).__userMessage}`);
+      }
+
+      await DynamoNTS_GlobalService.globalErrorHandler?.(
+        error, 
+        req, 
+        res, 
+        issuer
+      ).catch((err): void => {
+        DynamoFM_Log.warn(
+          'DynamoNTS_GlobalService.globalErrorHandler failed to handle error: ', 
+          err
+        );
+        DynamoFM_Log.warn('It will proceed as normal.');
+      });
+
+      if (
+        (error as DynamoFM_Error)?.flag?.includes('DYNAMO') && 
+        (error as DynamoFM_Error).confidentialContent
+      ) {
+        delete (error as DynamoFM_Error).confidentialContent;
+      }
+
+      res.status((error as DynamoFM_Error)?.___status ?? 501);
+      res.send(error);
+
+      if (this.logRequest) {
+        if (this.logResponseContent) {
+          DynamoFM_Log.error(
+            `  <<<=====   '${this.name}' error sent: ${(error as DynamoFM_Error)?._message ?? ''}`
+          );
+          DynamoFM_Log.error(
+            'sorry, the logResponseContent is not implemented yet.'
+          );
+        } else {
+          DynamoFM_Log.error(
+            `  <<<=====   '${this.name}' error sent: ${(error as DynamoFM_Error)?._message ?? ''}`
+          );
+        }
+      }
+
+      DynamoFM_Log.error('');
+          
+    } catch (error) {
+      DynamoFM_Log.H_error(
+        `\n\nDYNAMO MULTILEVEL ERROR:DynamoNTS_EndpointParams: error: ` +
+          `(${this.name}, ${this.endpoint})` +
+        `\n(DYNAMO MULTILEVEL ERROR means, that the ERROR HANDLING is ALSO FAILED, ` +
+          `and the error message was not sent.)` + 
+        `\nERROR:`, error, 
+        '\n'
+      );
+
+      if (error?.flag?.includes?.('DYNAMO-ERROR-OBJECT')) {
+        DynamoFM_Log.error(`ErrorMessage: ${(error as DynamoFM_Error)._message}`);
+        DynamoFM_Log.error(`ErrorCode: ${(error as DynamoFM_Error)._errorCode}`);
+        DynamoFM_Log.error(`UserMessage: ${(error as DynamoFM_Error).__userMessage}`);
+      }
+    }
+  }
+
+  private getPathParamsLogContent(req: Request): string {
+    let params: string = '';
+    
+    this.pathParams.forEach((param: string): void => {
+      params += `\n${param}: ${req.params[param]}`;
+    });
+
+    return params;
+  }
+}
+
+
+
+

package/src/_models/control-models/http-settings.control-model.ts

@@ -1,29 +1,29 @@
-
-import * as BodyParser from 'body-parser';
-export class DynamoNTS_Http_Settings {
-  httpPort?: number;
-  httpsPort?: number;
-
-  httpUrlencoded?: BodyParser.OptionsUrlencoded = {
-    limit: '50mb', 
-    extended: true,
-  };
-  httpJson?: BodyParser.OptionsJson = {
-    limit: '50mb',
-  };
-  httpsUrlencoded?: BodyParser.OptionsUrlencoded = {
-    limit: '50mb',
-    extended: true,
-  };
-  httpsJson?: BodyParser.OptionsJson = {
-    limit: '50mb',
-  };
-
-  constructor(
-    set?: DynamoNTS_Http_Settings
-  ) {
-    if (set) {
-      Object.assign(this, set);
-    }
-  }
-}
+
+import * as BodyParser from 'body-parser';
+export class DynamoNTS_Http_Settings {
+  httpPort?: number;
+  httpsPort?: number;
+
+  httpUrlencoded?: BodyParser.OptionsUrlencoded = {
+    limit: '50mb', 
+    extended: true,
+  };
+  httpJson?: BodyParser.OptionsJson = {
+    limit: '50mb',
+  };
+  httpsUrlencoded?: BodyParser.OptionsUrlencoded = {
+    limit: '50mb',
+    extended: true,
+  };
+  httpsJson?: BodyParser.OptionsJson = {
+    limit: '50mb',
+  };
+
+  constructor(
+    set?: DynamoNTS_Http_Settings
+  ) {
+    if (set) {
+      Object.assign(this, set);
+    }
+  }
+}