@futdevpro/nts-dynamo 1.5.51 → 1.5.52

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

@@ -9,7 +9,7 @@ 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,
+ * This will be the MAIN service of our server project,
  * follow the types and type instructions while setting up your project
  * 
  * In this service, there are abstract functions that you will need to implement,
@@ -20,13 +20,93 @@ import { DynamoNTS_SocketSecurity } from '../_enums/dynamo-nts-socket-security.e
  * You need to add socketService definitions to setupRoutingModules
  * 
  * @example
- * ...
- *   this.socketServices = [
- *     NotificationService.getInstance(),
- *     ChatService.getInstance(),
+ * export class App extends DynamoNTS_AppExtended {
+ *   
+ *   ...
+ *   
+ * // Setting up App params, and preparing project global settings
+ *   setupAppParams(): void {
+ *     this.params = new DynamoNTS_AppParams({
+ *       name: 'Warbots Distribution Server',
+ *       title: warbotsTitleLog,
+ *       version: version,
+ *       dbName: 'warbots',
+ *     });
+ *  
+ *     // dynamoNTS_GlobalSettings.logRequestsContent = false;
+ *   }
+ *   
+ *   ...
+ * 
+ *   // Setting up DBServices
+ *   setGlobalServiceCollection(): void {
+ *     DynamoNTS_GlobalService.setServices({
+ *       authService: AuthService.getInstance(),
+ *       emailServiceCollection: EmailServiceCollectionService.getInstance(),
+ *       dbModels: [
+ *         userModelParams,
+ *         userDataModelParams,
+ *         userOptionsModelParams,
+ *         userStatisticsModelParams,
+ *         userAchievementsModelParams,
+ *         userNotificationsModelParams,
+ *         
+ *         matchStatisticsModelParams,
+ *         matchDataModelParams,
+
+ *         usageSessionModelParams,
+ *         customDataModelParams,
+ *       ]
+ *     });
+ *   }
+ *   
+ *   ...
+ *   
+ *   // Setting up Routes
+ *   setupRoutingModules(): void {
+ *     this.httpPort = env.port;
+
+ *     this.routingModules = [
+ *       new DynamoNTS_RoutingModule({
+ *         route: '/user',
+ *         controllers: [ 
+ *           UserController.getInstance(),
+ *           UserDataController.getInstance(),
+ *           UserOptionsController.getInstance(),
+ *           UserStatisticsController.getInstance(),
+ *           UserAchievementsController.getInstance(),
+ *           UserNotificationsController.getInstance()
+ *         ]
+ *       }),
+ *       new DynamoNTS_RoutingModule({
+ *         route: '/match',
+ *         controllers: [ 
+ *           MatchController.getInstance(),
+ *           MatchDistributionController.getInstance(),
+ *           MatchStatisticsController.getInstance(),
+ *         ]
+ *       }),
+ *       new DynamoNTS_RoutingModule({
+ *         route: '/server',
+ *         controllers: [ 
+ *           ServerController.getInstance(),
+ *         ]
+ *       }),
+
+ *       getTestRoutingModule(),
+ *       getUsageRoutingModule()
+ *     ];
+ * 
  *     ...
- *   ];
- * ...
+ *   
+ *     // Setting up Sockets
+ *     this.socketServices = [
+ *       NotificationService.getInstance(),
+ *       ChatService.getInstance(),
+ *       ...
+ *     ];
+ *   }
+ * }
  */
 export abstract class DynamoNTS_AppExtended extends DynamoNTS_App {
 

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

@@ -14,11 +14,114 @@ import { DynamoNTS_EndpointParams } from '../_models/dynamo-nts-endpoint-params'
 import { dynamoNTS_GlobalSettings } from '../_constants';
 
 /**
- * This will be the main service of our server project,
+ * This will be the MAIN service of our server project,
  * follow the types and type instructions while setting up your project
  * 
  * 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.
+ * 
+ * (after the example, you can find the list of services you can/should setup)
+ * 
+ * @example
+ * export class App extends DynamoNTS_AppExtended {
+ *   
+ *   ...
+ *   
+ * // Setting up App params, and preparing project global settings
+ *   setupAppParams(): void {
+ *     this.params = new DynamoNTS_AppParams({
+ *       name: 'Warbots Distribution Server',
+ *       title: warbotsTitleLog,
+ *       version: version,
+ *       dbName: 'warbots',
+ *     });
+ *  
+ *     // dynamoNTS_GlobalSettings.logRequestsContent = false;
+ *   }
+ *   
+ *   ...
+ * 
+ *   // Setting up DBServices
+ *   setGlobalServiceCollection(): void {
+ *     DynamoNTS_GlobalService.setServices({
+ *       authService: AuthService.getInstance(),
+ *       emailServiceCollection: EmailServiceCollectionService.getInstance(),
+ *       dbModels: [
+ *         userModelParams,
+ *         userDataModelParams,
+ *         userOptionsModelParams,
+ *         userStatisticsModelParams,
+ *         userAchievementsModelParams,
+ *         userNotificationsModelParams,
+ *         
+ *         matchStatisticsModelParams,
+ *         matchDataModelParams,
+
+ *         usageSessionModelParams,
+ *         customDataModelParams,
+ *       ]
+ *     });
+ *   }
+ *   
+ *   ...
+ *   
+ *   // Setting up Routes
+ *   setupRoutingModules(): void {
+ *     this.httpPort = env.port;
+
+ *     this.routingModules = [
+ *       new DynamoNTS_RoutingModule({
+ *         route: '/user',
+ *         controllers: [ 
+ *           UserController.getInstance(),
+ *           UserDataController.getInstance(),
+ *           UserOptionsController.getInstance(),
+ *           UserStatisticsController.getInstance(),
+ *           UserAchievementsController.getInstance(),
+ *           UserNotificationsController.getInstance()
+ *         ]
+ *       }),
+ *       new DynamoNTS_RoutingModule({
+ *         route: '/match',
+ *         controllers: [ 
+ *           MatchController.getInstance(),
+ *           MatchDistributionController.getInstance(),
+ *           MatchStatisticsController.getInstance(),
+ *         ]
+ *       }),
+ *       new DynamoNTS_RoutingModule({
+ *         route: '/server',
+ *         controllers: [ 
+ *           ServerController.getInstance(),
+ *         ]
+ *       }),
+
+ *       getTestRoutingModule(),
+ *       getUsageRoutingModule()
+ *     ];
+ *   }
+ * }
+ * 
+ * //
+ * // The Services available
+ * // 
+ * // Authentication Service
+ * // A commonly used basic service, 
+ * // which is necessary fur certain functions (such as registering call issuers)
+ * // 
+ * // This will handle Authentication Token checking/refreshing, checking issuer's identifier and routeParams, 
+ * // handling JWT Token, or maybe with OAuth2 or other commonly used security procedures
+ * //
+ * // You can create one with this Dynamo Object:
+ * //
+ *
+ * @example 
+ * // follow the instructions on the abstract class (DynamoNTS_AuthService)
+ * export class AuthService extends DynamoNTS_AuthService {}
+ * 
+ * 
+ * 
+ * //
  */
 export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
 
@@ -289,37 +392,42 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
   }
 
   /**
+   * Setting up App params, and preparing project global settings
    * You must setup app params in this function like this:
    * 
    * @example
-   * this.params = new DynamoBEAppParams({
-   *  name: 'Sample Server',
-   *  title: 'A BIG nice header that will be logged on start',
-   *  version: version,
-   *  dbName: 'sampleapp',
-   * });
+   * setupAppParams(): void {
+   *   this.params = new DynamoBEAppParams({
+   *     name: 'Sample Server',
+   *     title: 'A BIG nice header that will be logged on start',
+   *     version: version,
+   *     dbName: 'sampleapp',
+   *   });
+   *  
+   *   DBE_Global_S.setGlobalSettings({
+   *     defaultRouteSecurity: DynamoBERouteSecurity.secure,
+   *     logSetup: true,
+   *   });
+   * }
    */
   abstract setupAppParams(): void;
 
   /**
+   * Setting up DBServices
    * You must setup globalServiceCollection and dbServices in this function
    * 
    * @example
-   * DBE_Global_S.setServices({
-   *   authService: AuthService.getInstance(),
-   *   emailServiceCollection: EmailServiceCollectionService.getInstance(),
-   *   dbModels: [
-   *     accountModelParams,
-   *     projectModelParams,
-   *     ...
-   *   ]
-   * });
-   *
-   * DBE_Global_S.setGlobalSettings({
-   *   defaultRouteSecurity: DynamoBERouteSecurity.secure,
-   *   logSetup: true,
-   * });
-   * 
+   * setGlobalServiceCollection(): void {
+   *   DBE_Global_S.setServices({
+   *     authService: AuthService.getInstance(),
+   *     emailServiceCollection: EmailServiceCollectionService.getInstance(),
+   *     dbModels: [
+   *       accountModelParams,
+   *       projectModelParams,
+   *       ...
+   *     ]
+   *   });
+   * }
    */
   abstract setGlobalServiceCollection(): void;
 
@@ -327,6 +435,7 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
    * You must setup endpoints and required services in this function
    * 
    * @example
+   * // Setting up Routes
    * setupRoutingModules(): void {
    *   this.httpPort = env.httpPort;
    *   this.httpsPort = env.httpsPort;

package/src/_services/dynamo-nts-auth.service.ts

@@ -55,32 +55,106 @@ export abstract class DynamoNTS_AuthService extends DynamoNTS_SingletonService {
   }
   
   /**
+   * You need to implement a token validation logic, 
+   * when if the token is invalid, or the authentication fails, it sends or throws an error
+   * 
+   * @example
+   * 
+   * async authenticateToken(req: Request, res: Response, next: NextFunction) {
+   *   try {
+   *     let token = AuthService.getTokenFromRequest(req);
+   *     token = await AuthService.verifyToken(token);
+   * 
+   *     DynamoNTS_Shared.logSuccess('token authenticated');
+   *     res.setHeader('authorization', `Bearer ${token}`);
+   *     next();
+   *   } catch (error) {
+   *     error = new Dynamo_Error({ 
+   *       status: 401, 
+   *       message: `authenticateToken (WB-ERROR)`,
+   *       addECToUserMsg: true,
+   *       userMessage: `Authorization failed.`, 
+   *       error 
+   *     });
+   *     DynamoNTS_Shared.logError(error?.message, error);
+   * 
+   *     res.status(error.status);
+   *     res.send(error);
+   *   }
+   * }
+   * */
+  abstract authenticateToken(req: Request, res: Response, next: NextFunction): Promise<void>;
+
+  /**
+   * You need to implement a token validation logic, 
+   * when if the token is invalid, or the authentication fails, it sends or throws an error
    * 
    * @param req 
    * @param res 
    * @param next 
-   */
-  abstract authenticateTokenSelf(req: Request, res: Response, next: NextFunction): Promise<void>;
-  /**
+   * 
+   * @example 
+   * 
+   * async authenticateTokenSelf(req: Request, res: Response, next: NextFunction): Promise<void> {
+   *   try {
+   *     let token = AuthService.getTokenFromRequest(req);
+   *     token = await AuthService.verifyTokenSelf(token, req?.params?.userId);
+   *     DynamoNTS_Shared.logSuccess('selftoken authenticated');
+   * 
+   *     res.setHeader('authorization', `Bearer ${token}`);
+   *     next();
+   *   } catch (error) {
+   *     error = new Dynamo_Error({ 
+   *       status: 401, 
+   *       message: `authenticateTokenSelf (WB-ERROR)`,
+   *       addECToUserMsg: true,
+   *       userMessage: `Authorization failed.`, 
+   *       error 
+   *     });
+   *     DynamoNTS_Shared.logError(error?.message, error);
+   * 
+   *     res.status(error.status);
+   *     res.send(error);
+   *   }
+   * }
    * 
    */
-  abstract authenticateToken(req: Request, res: Response, next: NextFunction): Promise<void>;
+  abstract authenticateTokenSelf(req: Request, res: Response, next: NextFunction): Promise<void>;
   
   /**
    * Authenticate Token for Permission to Access UsageData
    * @param req 
    * @param res 
    * @param next 
+   * 
+   * @example
+   * You need to implement a token validation logic, 
+   * when if the token is invalid, or the authentication fails, it sends or throws an error
+   * 
+   * async authTokenPermAccUsageData(req: Request, res: Response, next: NextFunction): Promise<void> {
+   *   AuthService.authTokenAndPerm(req, res, next, Permission.accessUsageData);
+   * }
    */
   abstract authTokenPermAccUsageData(req: Request, res: Response, next: NextFunction): Promise<void>;
 
   /**
    * The DynamoBE System is using this to get issuer, that will be set on DBServices
    * @param req 
+   * 
+   * @example
+   * getAccountIdFromRequest(req: Request): string {
+   *   try {
+   *     const authHeader = req.headers['authorization'];
+   *     const token = authHeader.split(' ')[1];
+   *     return this.getAccountIdFromToken(token);
+   *   } catch {
+   *     return undefined;
+   *   }
+   * }
    */
   abstract getAccountIdFromRequest(req: Request): string;
   /**
-   * 
+   * Basic Module: UsageModule uses this function
    * @param req 
    */
   abstract getUsernameFromRequest(req: Request): string;