@futdevpro/nts-dynamo 1.5.69 → 1.5.72

package/src/_modules/models.index.ts

@@ -0,0 +1,2 @@
+
+export * from '../_models';

package/src/_modules/services.index.ts

@@ -0,0 +1,2 @@
+
+export * from '../_services';

package/src/_modules/test/test.controller.ts

@@ -4,6 +4,7 @@ import { testModuleSettings } from '@futdevpro/fsm-dynamo/test-module';
 import { HttpCallType } from '../../_enums/http/http-call-type.enum';
 import { DynamoNTS_EndpointParams } from '../../_models/dynamo-nts-endpoint-params';
 import { DynamoNTS_Controller } from '../../_services/dynamo-nts-controller.service';
+import { DynamoNTS_GlobalService } from '../app-extended.index';
 
 export class TestController extends DynamoNTS_Controller {
 
@@ -97,7 +98,9 @@ export class TestController extends DynamoNTS_Controller {
                     async (req: Request, res: Response) => {
                         
                         res.send({
-                            status: 'ready'
+                            status: 'ready',
+                            version: DynamoNTS_GlobalService.params.version,
+                            upTime: DynamoNTS_GlobalService.upTime,
                         });
                     }
                 ]

package/src/_modules/test-module.index.ts

@@ -0,0 +1,2 @@
+
+export * from './test';

package/src/_modules/usage-module.index.ts

@@ -0,0 +1,2 @@
+
+export * from './usage';

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

@@ -127,10 +127,12 @@ export abstract class DynamoNTS_AppExtended extends DynamoNTS_App {
     super();
 
     try {
-      if (0 < this.socketServices.length) {
+      this.socketServices = this.getSocketServices();
+
+      if (this.socketServices?.length) {
         this.setSocketSecurity();
 
-        this.setupSocketServices();
+        this.mountSocketServices();
 
         if (this.debugLog) console.log(`\nAll sockets setted up.... sockets using security: ${this.socketSecurity}`);
       } else {
@@ -160,7 +162,7 @@ export abstract class DynamoNTS_AppExtended extends DynamoNTS_App {
   /**
    * 
    */
-  private setupSocketServices(): void {
+  private mountSocketServices(): void {
     let httpSocketServer: Http.Server;
     if (this.socketSecurity !== DynamoNTS_RouteSecurity.secure) {
       if (!this.openExpress) {
@@ -205,7 +207,7 @@ export abstract class DynamoNTS_AppExtended extends DynamoNTS_App {
         (mod: DynamoNTS_SocketService<any>) => mod.port === service.port
       );
 
-      if (1 < existingPorts.length || this.httpPort === service.port || this.httpsPort === service.port) {
+      if (1 < existingPorts.length || this.ports.httpPort === service.port || this.ports.httpsPort === service.port) {
         let error = new Error(`PORT DUPLICATION: ${service.port}`);
         let errorStack: string[] = error.stack.split('\n');
         errorStack.splice(1, 4);
@@ -230,4 +232,9 @@ export abstract class DynamoNTS_AppExtended extends DynamoNTS_App {
       }
     });
   }
+
+  /**
+   * MISSING Description (TODO)
+   */
+  abstract getSocketServices(): DynamoNTS_SocketService<any>[];
 }

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

@@ -12,6 +12,17 @@ import { DynamoNTS_RoutingModule } from './dynamo-nts-routing-module.service';
 import { DynamoNTS_EndpointParams } from '../_models/dynamo-nts-endpoint-params';
 import { dynamoNTS_GlobalSettings } from '../_constants';
 import { Dynamo_Log } from '@futdevpro/fsm-dynamo';
+import { DynamoNTS_GlobalService, DynamoNTS_GlobalServiceSettings } from './dynamo-nts-global.service';
+
+export interface DynamoNTS_CertificationSettings {
+  keyPath: FileSystem.PathLike,
+  certPath: FileSystem.PathLike,
+}
+
+export interface DynamoNTS_PortSettings {
+  httpPort?: number,
+  httpsPort?: number,
+}
 
 /**
  * This will be the MAIN service of our server project,
@@ -125,49 +136,26 @@ import { Dynamo_Log } from '@futdevpro/fsm-dynamo';
  */
 export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
 
-  /**
-   * Setup this in the setupAppParams(), which will be called first in the constuctor
-   * 
-   * @example
-   * 
-   * this.params = new DynamoNTS_AppParams({
-   *   name: 'Warbots Server',
-   *   title: warbotsTitleLog,
-   *   version: version,
-   *   dbName: 'warbots',
-   * });
-   */
-  protected params: DynamoNTS_AppParams;
+  private _params: DynamoNTS_AppParams;
+  protected get params(): DynamoNTS_AppParams { return this._params; }
   
   protected mongoose = Mongoose;
 
-  protected security: DynamoNTS_RouteSecurity;
+  private _security: DynamoNTS_RouteSecurity;
+  protected get security(): DynamoNTS_RouteSecurity { return this._security; }
 
-  /**
-   * setup this in the setupRoutingModules()
-   */
-  protected httpPort?: number;
-  /**
-   * setup this in the setupRoutingModules()
-   */
-  protected httpsPort?: number;
+  protected _ports: DynamoNTS_PortSettings;
+  protected get ports(): DynamoNTS_PortSettings { return this._ports; }
 
-  /**
-   * setup this in the setupRoutingModules()
-   */
-  protected cert?: {
-    keyPath: FileSystem.PathLike,
-    certPath: FileSystem.PathLike,
-  };
+  private _cert?: DynamoNTS_CertificationSettings;
+  protected get cert(): DynamoNTS_CertificationSettings { return this._cert; }
 
   protected openExpress: Express.Application;
   private secureExpress: Express.Application;
   protected httpsServer: Https.Server;
 
-  /**
-   * setup this in the setupRoutingModules()
-   */
-  protected routingModules: DynamoNTS_RoutingModule[];
+  private _routingModules: DynamoNTS_RoutingModule[];
+  protected get routingModules(): DynamoNTS_RoutingModule[] { return this._routingModules; }
 
   /**
    * setting this value to true, enables this service debug logs
@@ -178,30 +166,59 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
     super();
 
     try {
-      this.setupAppParams();
-      console.log(`\n\n\nStarting ${this.params.name}... \nVersion: ${this.params.version}`);
-      if (this.params.title) console.log(this.params.title);
+      this._params = this.getAppParams();
+      
+      if (this.overrideDynamoNTSGlobalSettings) {
+        this.overrideDynamoNTSGlobalSettings();        
+      } 
+      
+      DynamoNTS_GlobalService.setServices(this.getGlobalServiceCollection());
+      DynamoNTS_GlobalService.setParams(this.params);
+
+      this._ports = this.getPortSettings();      
+      if (this.getCertificationSettings) {
+        this._cert = this.getCertificationSettings();
+      }
+      this._routingModules = this.getRoutingModules();
+
+      if (this.createEntries) {
+        this.createEntries();
+      }
+
+      console.log(
+        `\n\n\nStarting ${this._params.name}... ` +
+        `\nVersion: ${this._params.version}`
+      );
+      if (this._params.title) {
+        console.log(this._params.title);
+      }
 
       this.startDB();
 
-      this.setGlobalServiceCollection();
+      this.getGlobalServiceCollection();
       this.debugLog = dynamoNTS_GlobalSettings.logSetup;
 
-      this.setupRoutingModules();
+      this.getRoutingModules();
       this.setSecurity();
           
-      if (0 < this.routingModules.length) {
+      if (this._routingModules?.length) {
         this.initExpresses();
         this.startExpresses();
 
-        if (this.security !== DynamoNTS_RouteSecurity.secure) {
+        if (this._security !== DynamoNTS_RouteSecurity.secure) {
           this.mountOpenRoutes();
         }
-        if (this.security !== DynamoNTS_RouteSecurity.open && this.cert) {
+        if (this._security !== DynamoNTS_RouteSecurity.open && this._cert) {
           this.mountSecureRoutes();
         }
 
-        if (this.debugLog) console.log(`\nRoutes mounted.... server using security: ${this.security}`);
+        if (this.debugLog) {
+          console.log(`\nRoutes mounted.... server using security: ${this._security}`);
+        }
+      }
+      
+      if (this.postProcess) { 
+        this.postProcess();
       }
     } catch (error) {
       Dynamo_Log.error('\nApplication start failed.\n', error);
@@ -221,7 +238,7 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
       });
 
     this.mongoose.connect(
-        this.params.dbUri, 
+        this._params.dbUri, 
         {
           useNewUrlParser: true,
           useUnifiedTopology: true 
@@ -233,15 +250,15 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
    * 
    */
   private initExpresses() {
-    if (this.security !== DynamoNTS_RouteSecurity.secure) {
-      if (!this.httpPort) {
+    if (this._security !== DynamoNTS_RouteSecurity.secure) {
+      if (!this._ports.httpPort) {
         let errorMsg: string =
           `\nYou have open routes, but httpPort is not set!` +
-          `\nsecurity: ${this.security}` +
+          `\nsecurity: ${this._security}` +
           `\nset httpPort in DynamoBEServer - setupRoutingModules() to enable secure routes.`;
         
         errorMsg += '\n\nThe routes setted to use open server:';
-        this.routingModules.forEach((module: DynamoNTS_RoutingModule) => {
+        this._routingModules.forEach((module: DynamoNTS_RoutingModule) => {
           if (module.security != DynamoNTS_RouteSecurity.secure) {
             errorMsg += `\n  ${module.route} (security: ${module.security}) \n  subroutes using open sever:`;
             module.endpoints.forEach((endpoint: DynamoNTS_EndpointParams) => {
@@ -264,11 +281,11 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
       this.initOpenExpress();
     }
 
-    if (this.security !== DynamoNTS_RouteSecurity.open) {
-      if (!this.cert || !this.httpsPort) {
+    if (this._security !== DynamoNTS_RouteSecurity.open) {
+      if (!this._cert || !this._ports.httpsPort) {
         let errorMsg: string =
           `\nYou have secure routes, but the certification paths or httpsPort are not set!` +
-          `\nsecurity: ${this.security}` +
+          `\nsecurity: ${this._security}` +
           `\nset...` +
           `\n  httpsPort and` +
           `\n  cert: {` +
@@ -278,7 +295,7 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
           `\nin DynamoBEServer - setupRoutingModules() to enable secure routes.`;
         
         errorMsg += '\n\nThe routes setted to use secure server:';
-        this.routingModules.forEach((module: DynamoNTS_RoutingModule) => {
+        this._routingModules.forEach((module: DynamoNTS_RoutingModule) => {
           if (module.security != DynamoNTS_RouteSecurity.open) {
             errorMsg += `\n  ${module.route} (security: ${module.security}) \n  subroutes using secure sever:`;
             module.endpoints.forEach((endpoint: DynamoNTS_EndpointParams) => {
@@ -320,8 +337,8 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
     this.secureExpress.use(BodyParser.json({ limit: '50mb' }));
 
     const options = {
-      key: FileSystem.readFileSync(this.cert.keyPath),
-      cert: FileSystem.readFileSync(this.cert.certPath),
+      key: FileSystem.readFileSync(this._cert.keyPath),
+      cert: FileSystem.readFileSync(this._cert.certPath),
     };
     this.httpsServer = Https.createServer(options, this.secureExpress);
   }
@@ -331,10 +348,10 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
    */
   private async startExpresses(): Promise<void> {
     try {
-      if (this.security !== DynamoNTS_RouteSecurity.open) {
+      if (this._security !== DynamoNTS_RouteSecurity.open) {
         this.httpsServer
-          .listen(this.httpsPort, 'localhost', 0, () => {
-            Dynamo_Log.success(`\nHTTPS (secure) server is listening on port ${this.httpsPort}\n`);
+          .listen(this._ports.httpsPort, 'localhost', 0, () => {
+            Dynamo_Log.success(`\nHTTPS (secure) server is listening on port ${this._ports.httpsPort}\n`);
           })
           .on('error', (error) => {
             Dynamo_Log.error(`\nHTTPS (secure) server ERROR`, error);
@@ -344,10 +361,10 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
           });
       }
 
-      if (this.security !== DynamoNTS_RouteSecurity.secure) {
+      if (this._security !== DynamoNTS_RouteSecurity.secure) {
         this.openExpress
-          .listen(this.httpPort, () => {
-            Dynamo_Log.success(`\nHTTP  (-open-) server is listening on port ${this.httpPort}\n`);
+          .listen(this._ports.httpPort, () => {
+            Dynamo_Log.success(`\nHTTP  (-open-) server is listening on port ${this._ports.httpPort}\n`);
           })
           .on('error', (error) => {
             Dynamo_Log.error(`\nHTTP  (-open-) server ERROR`, error);
@@ -365,11 +382,16 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
    * 
    */
   private mountSecureRoutes (): void {
-    this.routingModules.forEach((module: DynamoNTS_RoutingModule) => {
+    this._routingModules.forEach((module: DynamoNTS_RoutingModule) => {
       if (module.security !== DynamoNTS_RouteSecurity.open) {
-        if (this.debugLog) console.log(`route mount (secure): ${module.route}`);
-        const existingRoutes: DynamoNTS_RoutingModule[] = this.routingModules.filter(
-            (mod: DynamoNTS_RoutingModule) => mod.route === module.route);
+        if (this.debugLog) { 
+          console.log(`route mount (secure): ${module.route}`);
+        }
+        
+        const existingRoutes: DynamoNTS_RoutingModule[] = this._routingModules.filter(
+          (mod: DynamoNTS_RoutingModule) => mod.route === module.route
+        );
+
         if (1 < existingRoutes.length) {
           let error = new Error(`ROUTE DUPLICATION: ${module.route}`);
           let errorStack: string[] = error.stack.split('\n');
@@ -387,11 +409,16 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
    * 
    */
   private mountOpenRoutes (): void {
-    this.routingModules.forEach((module: DynamoNTS_RoutingModule) => {
+    this._routingModules.forEach((module: DynamoNTS_RoutingModule) => {
       if (module.security !== DynamoNTS_RouteSecurity.secure) {
-        if (this.debugLog) console.log(`route mount (open): ${module.route}`);
-        const existingRoutes: DynamoNTS_RoutingModule[] = this.routingModules.filter(
-            (mod: DynamoNTS_RoutingModule) => mod.route === module.route);
+        if (this.debugLog) {
+          console.log(`route mount (open): ${module.route}`);
+        }
+
+        const existingRoutes: DynamoNTS_RoutingModule[] = this._routingModules.filter(
+          (mod: DynamoNTS_RoutingModule) => mod.route === module.route
+        );
+
         if (1 < existingRoutes.length) {
           let error = new Error(`ROUTE DUPLICATION: ${module.route}`);
           let errorStack: string[] = error.stack.split('\n');
@@ -408,17 +435,18 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
   /**
    * 
    */
-  protected setSecurity(): void {
-    this.routingModules.forEach((module: DynamoNTS_RoutingModule) => {
-      if (!this.security) {
-        this.security = module.security;
-      } else if (this.security !== module.security) {
-        this.security = DynamoNTS_RouteSecurity.both;
+  private setSecurity(): void {
+    this._routingModules.forEach((module: DynamoNTS_RoutingModule) => {
+      if (!this._security) {
+        this._security = module.security;
+      } else if (this._security !== module.security) {
+        this._security = DynamoNTS_RouteSecurity.both;
       }
     });
   }
 
   /**
+   * #OUTDATED
    * Setting up App params, and preparing project global settings
    * You must setup app params in this function like this:
    * 
@@ -437,9 +465,15 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
    *   });
    * }
    */
-  abstract setupAppParams(): void;
+  abstract getAppParams(): DynamoNTS_AppParams;
 
   /**
+   * MISSING Description (TODO)
+   */
+  abstract overrideDynamoNTSGlobalSettings?(): void;
+
+  /**
+   * #OUTDATED
    * Setting up DBServices
    * You must setup globalServiceCollection and dbServices in this function
    * 
@@ -456,9 +490,20 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
    *   });
    * }
    */
-  abstract setGlobalServiceCollection(): void;
+  abstract getGlobalServiceCollection(): DynamoNTS_GlobalServiceSettings;
+  
+  /**
+   * MISSING Description (TODO)
+   */
+  abstract getPortSettings(): DynamoNTS_PortSettings;
+  
+  /**
+   * MISSING Description (TODO)
+   */
+  abstract getCertificationSettings?(): DynamoNTS_CertificationSettings;
 
   /**
+   * #OUTDATED
    * You must setup endpoints and required services in this function
    * 
    * @example
@@ -492,5 +537,15 @@ export abstract class DynamoNTS_App extends DynamoNTS_SingletonService {
    *   ];
    * }
    */
-  abstract setupRoutingModules(): void;
+  abstract getRoutingModules(): DynamoNTS_RoutingModule[];
+
+  /**
+   * MISSING Description (TODO)
+   */
+  createEntries?(): void;
+
+  /**
+   * MISSING Description (TODO)
+   */
+  postProcess?(): void;
 }

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

@@ -104,6 +104,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
    * use db-service update instead.
    * 
    * @param {string} id
+   * (using id from service.data, if not provided)
    * @param dontSetToService
    * 
    * @return {T} data: T
@@ -151,6 +152,7 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
   
   /**
    * returns data from database by dependencyId to the service
+   * (using id from service.data, if not provided)
    * @param dependencyId 
    */
   async getDataByDependencyId(dependencyId?: string, dontSetToService?: boolean): Promise<T> {
@@ -475,40 +477,40 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
    */
   async saveData(): Promise<void> {
     try {
-      if (this.data._id) {
-        // check if already exists
-        const dataExists: T = await this.getDataById(null, true);
+      if (!this.data._id && (!this.depKey || !this.data[this.depKey])) {
+        // if ID of dependencyID is not present, data not exists, create new data
+        this.data = await this.dataDBService.createData(this.data, this.issuer);
+        return;
+      }
+
+      // check if already exists
+      let dataExists: T = await this.getDataById(null, true);
+      if (dataExists) {
+        // if data exists do modify
+        this.data = await this.dataDBService.modifyData(this.data, this.issuer);
+        return;
+      }
+
+      if (this.depKey) {
+        if (!this.data[this.depKey]) {
+          throw new Dynamo_Error({ 
+            status: 417, 
+            errorCode: 'NTS-DS0-SD1',
+            addECToUserMsg: true,
+            message: `saveData was unsuccessful: dependency data id missing from data (key: ${this.depKey})`, 
+            userMessage: this.defaultErrorUserMsg
+          });
+        }
+
+        dataExists = await this.getDataByDependencyId(null, true);
+
         if (dataExists) {
           // if data exists do modify
           this.data = await this.dataDBService.modifyData(this.data, this.issuer);
+          return;
         } else {
-          // if data not exists check that dependency already exists for this
-          if (this.depKey) {
-            if (!this.data[this.depKey]) {
-              throw new Dynamo_Error({ 
-                status: 417, 
-                errorCode: 'NTS-DS0-SD1',
-                addECToUserMsg: true,
-                message: `saveData was unsuccessful: dependency data id missing from data (key: ${this.depKey})`, 
-                userMessage: this.defaultErrorUserMsg
-              });
-            }
-
-            /* const dependencyExists =  */
-            await this.getDependencyDataDBService().getDataById(this.data[this.depKey]).catch(error => {
-              if (error?.errorCode === 'NTS-DBS-GI1') {
-                throw new Dynamo_Error({ 
-                  status: 417, 
-                  errorCode: 'NTS-DS0-SD2',
-                  addECToUserMsg: true,
-                  message: `saveData was unsuccessful: dependency data not exists (key: ${this.depKey}, id: ${this.data[this.depKey]})`, 
-                  userMessage: this.defaultErrorUserMsg
-                });
-              } else {
-                throw error;
-              }
-            });
-            /* if (!dependencyExists) {
+          await this.getDependencyDataDBService().getDataById(this.data[this.depKey]).catch(error => {
+            if (error?.errorCode === 'NTS-DBS-GI1') {
               throw new Dynamo_Error({ 
                 status: 417, 
                 errorCode: 'NTS-DS0-SD2',
@@ -516,16 +518,20 @@ export class DynamoNTS_DataService<T extends Dynamo_Metadata> {
                 message: `saveData was unsuccessful: dependency data not exists (key: ${this.depKey}, id: ${this.data[this.depKey]})`, 
                 userMessage: this.defaultErrorUserMsg
               });
-            } */
-          }
-
-          // if data not exists create new data
-          this.data = await this.dataDBService.createData(this.data, this.issuer);
+            } else {
+              throw error;
+            }
+          });
         }
-      } else {
-        // if ID is not present, data not exists, create new data
-        this.data = await this.dataDBService.createData(this.data, this.issuer);
       }
+
+      // if data not exists check that dependency already exists for this
+      if (this.depKey) {
+      }
+
+      // if data not exists create new data
+      this.data = await this.dataDBService.createData(this.data, this.issuer);
+
     } catch (error) {
       if (['NTS-DS0-SD1', 'NTS-DS0-SD2'].includes(error?.errorCode)) {
         throw error;