@futdevpro/nts-dynamo 1.9.15 → 1.9.16

package/src/_services/core/global.service.ts

@@ -1,269 +1,270 @@
-
-
-import { Request, Response } from 'express';
-
-import { 
-  DynamoFM_Metadata, DynamoFM_DataModel_Params, DynamoFM_Log, DynamoFM_Error, DynamoFM_Array 
-} from '@futdevpro/fsm-dynamo';
-import { DynamoNTS_App_Params } from '../../_models/control-models/app-params.control-model';
-
-import { 
-  DynamoNTS_GlobalService_Settings 
-} from '../../_models/interfaces/global-service-settings.interface';
-
-import { DynamoNTS_AuthService } from './auth.service';
-/* import { DynamoNTS_DBServiceCollection } from './db-service-collection.service'; */
-import { DynamoNTS_DBService } from '../base/db.service';
-import { DynamoNTS_EmailService } from './email.service';
-import { DynamoNTS_Service_Collection } from './service-collection.service';
-/* import { DynamoNTS_EmailServiceCollection } from './email-service-collection.service'; */
-import { DynamoNTS_SingletonService } from '../base/singleton.service';
-import { DynamoNTS_globalSettings } from '../../_constants';
-
-/**
- * This is the main Global/Core Service Collection used by DynamoBE, 
- * you also can use this to access main services as 
- * dbServices, emailServices, or authService
- */
-export class DynamoNTS_GlobalService extends DynamoNTS_SingletonService {
-
-  static getInstance(): DynamoNTS_GlobalService {
-    return DynamoNTS_GlobalService.getSingletonInstance();
-  }
-
-  private static _params: DynamoNTS_App_Params;
-  static get params(): DynamoNTS_App_Params { 
-    return this._params; 
-  }
-
-  private static readonly _upSince: Date = new Date();
-  static get upSince(): Date { 
-    return this._upSince; 
-  }
-  static get upTime(): number { 
-    return +new Date() - +this._upSince; 
-  }
-
-  authService: DynamoNTS_AuthService;
-  dbServiceCollection: DynamoNTS_Service_Collection<DynamoNTS_DBService<any>>;
-  emailServiceCollection: DynamoNTS_Service_Collection<DynamoNTS_EmailService>; 
-
-  static globalErrorHandler?: (
-    err: any, 
-    req?: Request, 
-    res?: Response, 
-    issuer?: string
-  ) => Promise<void>;
-    
-  /**
-   * You need to setup global Services through this function
-   */
-  static async setServices(set: DynamoNTS_GlobalService_Settings): Promise<void> {
-    this.getInstance();
-
-    try {
-      this.instance.dbServiceCollection = {};
-      set.dbModels?.forEach((dbModel: DynamoFM_DataModel_Params): void => {
-        if (!dbModel.constructed) {
-          throw new DynamoFM_Error({
-            message: `DynamoNTS_GlobalService.setServices failed, ` +
-              `ERROR: dbModel is not constructed!`,
-            errorCode: 'NTS-GS0-SS1',
-            additionalContent: {
-              dbModel: dbModel,
-            },
-          });  
-        }
-
-        try {
-          this.instance.dbServiceCollection[dbModel.dataName] = new DynamoNTS_DBService(dbModel);
-        } catch (error) {
-          DynamoFM_Log.error(`Failed to create DynamoNTS_DBService (${dbModel.dataName}).`, error);
-          
-          throw new DynamoFM_Error({
-            message: `Failed to create DynamoNTS_DBService (${dbModel.dataName}).`, 
-            issuerService: 'DynamoNTS_GlobalService',
-            error: error,
-            additionalContent: {
-              dbModel: dbModel,
-            },
-          });
-        }
-      });
-
-      this.instance.authService = set.authService;
-      this.instance.emailServiceCollection = set.emailServiceCollection ?? {};
-      await DynamoFM_Array.asyncForEach(
-        Object.keys(this.instance.emailServiceCollection),
-        async (key: string): Promise<void> => {
-          await (
-            this.instance.emailServiceCollection[key] as DynamoNTS_EmailService
-          ).asyncPostConstruct();
-        }
-      );
-      
-      DynamoNTS_GlobalService.globalErrorHandler = 
-        set.errorHandler ?? 
-        (async (error: any): Promise<void> => {
-          DynamoFM_Log.warn(`globalErrorHandler not set!`);
-
-          if (DynamoNTS_globalSettings.logDetailedErrors) {
-            DynamoFM_Log.error(`ERROR:\n`, error);
-          }
-          
-          if (error?.flag?.includes?.('DYNAMO-ERROR-OBJECT')) {
-            DynamoFM_Log.error(`\nErrorMessage: ${(error as DynamoFM_Error)._message}`);
-            DynamoFM_Log.error(`ErrorCode: ${(error as DynamoFM_Error)._errorCode}`);
-          }
-        });
-    } catch (error) {
-      throw new DynamoFM_Error({
-        message: `Failed to setServices on DynamoNTS_GlobalService.`,
-        error: error,
-        errorCode: 'NTS-GS0-SS0',
-      });
-    }
-  }
-
-  static setParams(params: DynamoNTS_App_Params): void {
-    this._params = params;
-  }
-
-  /**
-   * 
-   * @returns 
-   */
-  static getAuthService(): DynamoNTS_AuthService {
-    if (!(this.instance?.authService as DynamoNTS_AuthService)?.authenticate_token) {
-      throw new Error(
-        `\n  Unique Authentication Service missing!` + 
-        `\n    Please create a Unique Authentication Service extending DynamoNTS_AuthService, ` + 
-        `\n      and Setup with DynamoNTS_GlobalServiceC.setServices(...)\n`
-      );
-    }
-
-    return this.instance.authService;
-  }
-
-  /**
-   * 
-   * @returns 
-   */
-  static getDBServiceCollection(): DynamoNTS_Service_Collection<DynamoNTS_DBService<any>> {
-    if (!this.instance?.dbServiceCollection) {
-      throw new Error(
-        `\n  Unique DataBase Service Collection missing!` + 
-        `\n    Please create a Unique DataBase Service Collection extending ` +
-          `DynamoNTS_DBServiceCollection, ` + 
-        `\n      and Setup with DynamoNTS_GlobalServiceC.setServices(...)\n`
-      );
-    }
-
-    return this.instance.dbServiceCollection;
-  }
-
-  /**
-   * 
-   * @param dataParams 
-   * @returns 
-   */
-  static getDBService<T extends DynamoFM_Metadata>(
-    dataParams: DynamoFM_DataModel_Params
-  ): DynamoNTS_DBService<T> {
-    return this.getDBServiceByKey<T>(dataParams.dataName);
-  }
-
-  /**
-   * 
-   * @param key 
-   * @returns 
-   */
-  static getDBServiceByKey<T extends DynamoFM_Metadata>(key: string): DynamoNTS_DBService<T> {
-    const collection = this.getDBServiceCollection();
-
-    if (collection[key]) {
-      return collection[key] as DynamoNTS_DBService<T>;
-    } else {
-      let keys: string = `${Object.keys(collection)}`;
-
-      keys = keys.replace(/,/g, '\n                ');
-
-      throw new Error(
-        `\n  DynamoNTS_GlobalService.getDBService failed, ERROR: ` +
-        `\n    no dbService on collection with this key: ${key}!` +
-        `\n      The available dbServices on collection:` +
-        `\n        ${keys}\n`
-      );
-    }
-  }
-
-  /**
-   * 
-   * @returns 
-   */
-  static getEmailServiceCollection(): DynamoNTS_Service_Collection<DynamoNTS_EmailService> {
-    if (!this.instance?.emailServiceCollection) {
-      throw new Error(
-        `\n  Unique Email Service Collection missing!` + 
-        `\n    Please create a Unique Email Service Collection extending ` +
-          `DynamoBEEmailServiceCollection, ` + 
-        `\n      and Setup with DynamoNTS_GlobalServiceC.setServices(...)\n`
-      );
-    }
-
-    return this.instance.emailServiceCollection;
-  }
-
-  /**
-   * 
-   * @returns 
-   */
-  /* static getSocketServiceCollection(): DynamoNTS_SocketServiceCollection {
-    if (!this.instance?.socketServiceCollection) {
-      throw new Error(
-        `\nUnique Socket Service Collection missing!` + 
-        `\nSocket Service Collection will only be created if there are Socket Services properly setted up ` +
-        `in the setupModules in the App using DynamoNTS_AppExtended, ` + 
-        `and Setup with "DynamoNTS_GlobalServiceC.setServices(...)"`);
-    }
-
-    return this.instance.socketServiceCollection;
-  } */
-
-  /**
-   * 
-   * @param name 
-   * @returns 
-   */
-  /* static getSocketServiceByName(name: string): DynamoNTS_SocketService<any> {
-    const collection: DynamoNTS_SocketServiceCollection = this.getSocketServiceCollection();
-    if (collection[name]) {
-      return collection[name];
-    } else {
-      let names: string = `${Object.keys(collection)}`;
-      names = names.replace(/,/g, '\n                ');
-
-      throw new Error(
-        `\nDynamoNTS_GlobalService.getSocketServiceByName failed, ERROR: 
-        no socketService on collection with this name: ${name}!
-        The available socketServices on collection:
-                ${names}\n`);
-    }
-  }
-
-  static attachNewSocketService(service: DynamoNTS_SocketService<any>): void {
-    const collection: DynamoNTS_SocketServiceCollection = this.getSocketServiceCollection();
-    if (!collection[service.name]) {
-      collection[service.name] = service;
-    } else {
-      let names: string = `${Object.keys(collection)}`;
-      names = names.replace(/,/g, '\n                ');
-
-      throw new Error(
-        `\nDynamoNTS_GlobalService.attachNewSocketService failed, ERROR: 
-        socketService name is already taken on collection with this name: ${service.name}!
-        The available socketServices on collection:
-                ${names}\n`);
-    }
-  } */
-}
+
+
+import { Request, Response } from 'express';
+
+import { 
+  DynamoFM_Metadata, DynamoFM_DataModel_Params, DynamoFM_Log, DynamoFM_Error, DynamoFM_Array 
+} from '@futdevpro/fsm-dynamo';
+import { DynamoNTS_App_Params } from '../../_models/control-models/app-params.control-model';
+
+import { 
+  DynamoNTS_GlobalService_Settings 
+} from '../../_models/interfaces/global-service-settings.interface';
+
+import { DynamoNTS_AuthService } from './auth.service';
+/* import { DynamoNTS_DBServiceCollection } from './db-service-collection.service'; */
+import { DynamoNTS_DBService } from '../base/db.service';
+import { DynamoNTS_EmailService } from './email.service';
+import { DynamoNTS_Service_Collection } from './service-collection.service';
+/* import { DynamoNTS_EmailServiceCollection } from './email-service-collection.service'; */
+import { DynamoNTS_SingletonService } from '../base/singleton.service';
+import { DynamoNTS_globalSettings } from '../../_constants';
+
+/**
+ * This is the main Global/Core Service Collection used by DynamoBE, 
+ * you also can use this to access main services as 
+ * dbServices, emailServices, or authService
+ */
+export class DynamoNTS_GlobalService extends DynamoNTS_SingletonService {
+
+  static getInstance(): DynamoNTS_GlobalService {
+    return DynamoNTS_GlobalService.getSingletonInstance();
+  }
+
+  private static _params: DynamoNTS_App_Params;
+  static get params(): DynamoNTS_App_Params { 
+    return this._params; 
+  }
+
+  private static readonly _upSince: Date = new Date();
+  static get upSince(): Date { 
+    return this._upSince; 
+  }
+  static get upTime(): number { 
+    return +new Date() - +this._upSince; 
+  }
+
+  authService: DynamoNTS_AuthService;
+  dbServiceCollection: DynamoNTS_Service_Collection<DynamoNTS_DBService<any>>;
+  emailServiceCollection: DynamoNTS_Service_Collection<DynamoNTS_EmailService>; 
+
+  static globalErrorHandler?: (
+    err: any, 
+    req?: Request, 
+    res?: Response, 
+    issuer?: string
+  ) => Promise<void>;
+    
+  /**
+   * You need to setup global Services through this function
+   */
+  static async setServices(set: DynamoNTS_GlobalService_Settings): Promise<void> {
+    this.getInstance();
+
+    try {
+      this.instance.dbServiceCollection = {};
+      set.dbModels?.forEach((dbModel: DynamoFM_DataModel_Params): void => {
+        if (!dbModel.constructed) {
+          throw new DynamoFM_Error({
+            message: `DynamoNTS_GlobalService.setServices failed, ` +
+              `ERROR: dbModel is not constructed!`,
+            errorCode: 'NTS-GS0-SS1',
+            additionalContent: {
+              dbModel: dbModel,
+            },
+          });  
+        }
+
+        try {
+          this.instance.dbServiceCollection[dbModel.dataName] = new DynamoNTS_DBService(dbModel);
+        } catch (error) {
+          DynamoFM_Log.error(`Failed to create DynamoNTS_DBService (${dbModel.dataName}).`, error);
+          
+          throw new DynamoFM_Error({
+            message: `Failed to create DynamoNTS_DBService (${dbModel.dataName}).`, 
+            issuerService: 'DynamoNTS_GlobalService',
+            error: error,
+            additionalContent: {
+              dbModel: dbModel,
+            },
+          });
+        }
+      });
+
+      this.instance.authService = set.authService;
+      this.instance.emailServiceCollection = set.emailServiceCollection ?? {};
+      await DynamoFM_Array.asyncForEach(
+        Object.keys(this.instance.emailServiceCollection),
+        async (key: string): Promise<void> => {
+          await (
+            this.instance.emailServiceCollection[key] as DynamoNTS_EmailService
+          ).asyncPostConstruct();
+        }
+      );
+      
+      DynamoNTS_GlobalService.globalErrorHandler = 
+        set.errorHandler ?? 
+        (async (error: any): Promise<void> => {
+          DynamoFM_Log.warn(`globalErrorHandler not set!`);
+
+          if (DynamoNTS_globalSettings.logDetailedErrors) {
+            DynamoFM_Log.error(`ERROR:\n`, error);
+          }
+          
+          if (error?.flag?.includes?.('DYNAMO-ERROR-OBJECT')) {
+            DynamoFM_Log.error(`\nErrorMessage: ${(error as DynamoFM_Error)._message}`);
+            DynamoFM_Log.error(`ErrorCode: ${(error as DynamoFM_Error)._errorCode}`);
+            DynamoFM_Log.error(`UserMessage: ${(error as DynamoFM_Error).__userMessage}`);
+          }
+        });
+    } catch (error) {
+      throw new DynamoFM_Error({
+        message: `Failed to setServices on DynamoNTS_GlobalService.`,
+        error: error,
+        errorCode: 'NTS-GS0-SS0',
+      });
+    }
+  }
+
+  static setParams(params: DynamoNTS_App_Params): void {
+    this._params = params;
+  }
+
+  /**
+   * 
+   * @returns 
+   */
+  static getAuthService(): DynamoNTS_AuthService {
+    if (!(this.instance?.authService as DynamoNTS_AuthService)?.authenticate_token) {
+      throw new Error(
+        `\n  Unique Authentication Service missing!` + 
+        `\n    Please create a Unique Authentication Service extending DynamoNTS_AuthService, ` + 
+        `\n      and Setup with DynamoNTS_GlobalServiceC.setServices(...)\n`
+      );
+    }
+
+    return this.instance.authService;
+  }
+
+  /**
+   * 
+   * @returns 
+   */
+  static getDBServiceCollection(): DynamoNTS_Service_Collection<DynamoNTS_DBService<any>> {
+    if (!this.instance?.dbServiceCollection) {
+      throw new Error(
+        `\n  Unique DataBase Service Collection missing!` + 
+        `\n    Please create a Unique DataBase Service Collection extending ` +
+          `DynamoNTS_DBServiceCollection, ` + 
+        `\n      and Setup with DynamoNTS_GlobalServiceC.setServices(...)\n`
+      );
+    }
+
+    return this.instance.dbServiceCollection;
+  }
+
+  /**
+   * 
+   * @param dataParams 
+   * @returns 
+   */
+  static getDBService<T extends DynamoFM_Metadata>(
+    dataParams: DynamoFM_DataModel_Params
+  ): DynamoNTS_DBService<T> {
+    return this.getDBServiceByKey<T>(dataParams.dataName);
+  }
+
+  /**
+   * 
+   * @param key 
+   * @returns 
+   */
+  static getDBServiceByKey<T extends DynamoFM_Metadata>(key: string): DynamoNTS_DBService<T> {
+    const collection = this.getDBServiceCollection();
+
+    if (collection[key]) {
+      return collection[key] as DynamoNTS_DBService<T>;
+    } else {
+      let keys: string = `${Object.keys(collection)}`;
+
+      keys = keys.replace(/,/g, '\n                ');
+
+      throw new Error(
+        `\n  DynamoNTS_GlobalService.getDBService failed, ERROR: ` +
+        `\n    no dbService on collection with this key: ${key}!` +
+        `\n      The available dbServices on collection:` +
+        `\n        ${keys}\n`
+      );
+    }
+  }
+
+  /**
+   * 
+   * @returns 
+   */
+  static getEmailServiceCollection(): DynamoNTS_Service_Collection<DynamoNTS_EmailService> {
+    if (!this.instance?.emailServiceCollection) {
+      throw new Error(
+        `\n  Unique Email Service Collection missing!` + 
+        `\n    Please create a Unique Email Service Collection extending ` +
+          `DynamoBEEmailServiceCollection, ` + 
+        `\n      and Setup with DynamoNTS_GlobalServiceC.setServices(...)\n`
+      );
+    }
+
+    return this.instance.emailServiceCollection;
+  }
+
+  /**
+   * 
+   * @returns 
+   */
+  /* static getSocketServiceCollection(): DynamoNTS_SocketServiceCollection {
+    if (!this.instance?.socketServiceCollection) {
+      throw new Error(
+        `\nUnique Socket Service Collection missing!` + 
+        `\nSocket Service Collection will only be created if there are Socket Services properly setted up ` +
+        `in the setupModules in the App using DynamoNTS_AppExtended, ` + 
+        `and Setup with "DynamoNTS_GlobalServiceC.setServices(...)"`);
+    }
+
+    return this.instance.socketServiceCollection;
+  } */
+
+  /**
+   * 
+   * @param name 
+   * @returns 
+   */
+  /* static getSocketServiceByName(name: string): DynamoNTS_SocketService<any> {
+    const collection: DynamoNTS_SocketServiceCollection = this.getSocketServiceCollection();
+    if (collection[name]) {
+      return collection[name];
+    } else {
+      let names: string = `${Object.keys(collection)}`;
+      names = names.replace(/,/g, '\n                ');
+
+      throw new Error(
+        `\nDynamoNTS_GlobalService.getSocketServiceByName failed, ERROR: 
+        no socketService on collection with this name: ${name}!
+        The available socketServices on collection:
+                ${names}\n`);
+    }
+  }
+
+  static attachNewSocketService(service: DynamoNTS_SocketService<any>): void {
+    const collection: DynamoNTS_SocketServiceCollection = this.getSocketServiceCollection();
+    if (!collection[service.name]) {
+      collection[service.name] = service;
+    } else {
+      let names: string = `${Object.keys(collection)}`;
+      names = names.replace(/,/g, '\n                ');
+
+      throw new Error(
+        `\nDynamoNTS_GlobalService.attachNewSocketService failed, ERROR: 
+        socketService name is already taken on collection with this name: ${service.name}!
+        The available socketServices on collection:
+                ${names}\n`);
+    }
+  } */
+}

package/src/_services/core/service-collection.service.ts

@@ -1,5 +1,5 @@
-import { DynamoNTS_SingletonService } from '../base/singleton.service';
-
-export class DynamoNTS_Service_Collection<T> extends DynamoNTS_SingletonService {
-  [service: string]: T;
-}
+import { DynamoNTS_SingletonService } from '../base/singleton.service';
+
+export class DynamoNTS_Service_Collection<T> extends DynamoNTS_SingletonService {
+  [service: string]: T;
+}

package/src/_services/index.ts

@@ -1,23 +1,23 @@
-
-
-
-// SERVICES
-export * from './core/api.service';
-export * from './server/app.server';
-export * from './core/auth.service';
-export * from './route/controller.service';
-export * from './base/data.service';
-export * from './base/db.service';
-export * from './core/email.service';
-export * from './core/global.service';
-export * from './route/controller.service';
-export * from './route/routing-module.service';
-export * from './core/service-collection.service';
-export * from './shared.static-service';
-export * from './base/singleton.service';
-
-// these are using socket.io therefore they are not included in the service index
-// export * from './app-extended.server';
-// export * from './socket-client.service';
-// export * from './socket-server.service';
-
+
+
+
+// SERVICES
+export * from './core/api.service';
+export * from './server/app.server';
+export * from './core/auth.service';
+export * from './route/controller.service';
+export * from './base/data.service';
+export * from './base/db.service';
+export * from './core/email.service';
+export * from './core/global.service';
+export * from './route/controller.service';
+export * from './route/routing-module.service';
+export * from './core/service-collection.service';
+export * from './shared.static-service';
+export * from './base/singleton.service';
+
+// these are using socket.io therefore they are not included in the service index
+// export * from './app-extended.server';
+// export * from './socket-client.service';
+// export * from './socket-server.service';
+