@futdevpro/nts-dynamo 1.9.15 → 1.9.16

package/src/_models/control-models/socket-presence.control-model.ts

@@ -1,207 +1,207 @@
-
-import { 
-  DynamoFM_AnyError, DynamoFM_Error, DynamoFM_Error_Settings, DynamoFM_Log 
-} from '@futdevpro/fsm-dynamo';
-import * as SocketIO from 'socket.io';
-
-/**
- * socket handling and clarification is under development
- */
-export class DynamoNTS_SocketPresence {
-  /** 
-   * this is the presence ID which is used to getand handle the presence 
-   * usually the service master identifier such as userID
-   * */
-  issuerId: string;
-  serviceName?: string = 'unknown';
-  onDestroy?: (issuerId: string) => void = (): void => {};
-  
-  defaultErrorUserMsg?: string = 
-    `We encountered an unhandled Socket Error, ` +
-    `\nplease contact the responsible development team.`; 
-  
-  sockets: SocketIO.Socket[] = [];
-  
-  constructor(
-    set: {
-      /** 
-       * this is the presence ID which is used to get and set handle the presence/sockets
-       * usually the service master identifier such as userID
-       * */
-      issuerId: string,
-      serviceName?: string,
-      onDestroy?: (issuerId: string) => void,
-
-      defaultErrorUserMsg?: string,
-      sockets: SocketIO.Socket[],
-
-      /**
-       * this is the issuer ID which is used to register data changes,
-       * usually the main master identifier such as accountID
-       */
-      issuer: string,
-    }
-  ) {
-    if (!set?.issuerId) {
-      throw new DynamoFM_Error({ 
-        ...this._getDefaultErrorSettings(
-          'constructor',
-          new Error(
-            `trying to create DynamoNTS_SocketPresence without a valid issuerId!` +
-            `\nset: ${JSON.stringify(set)}`
-          ),
-          set?.issuer
-        ),
-
-        errorCode: 'NTS-SD0-C00',
-      });
-    }
-
-    this.issuerId = set.issuerId;
-    
-    if (set.serviceName) {
-      this.serviceName = set.serviceName;
-    }
-
-    if (set.onDestroy) {
-      this.onDestroy = set.onDestroy;
-    }
-
-    if (set.defaultErrorUserMsg) {
-      this.defaultErrorUserMsg = set.defaultErrorUserMsg;
-    }
-
-    if (!set?.sockets?.length) {
-      throw new DynamoFM_Error({ 
-        ...this._getDefaultErrorSettings(
-          'constructor',
-          new Error(
-            `trying to create DynamoNTS_SocketPresence without a single active socket!` +
-            `\nissuerId: ${this.issuerId}`
-          ),
-          set?.issuer
-        ),
-
-        errorCode: 'NTS-SD0-C01',
-      });
-    }
-
-    this.sockets = set.sockets;
-  }
-
-  /**
-   * Emits event on all sockets
-   * @param event 
-   * @param content 
-   */
-  emitEvent?(event: string, content: any, issuer: string): void {
-    /* let anyFailed: boolean = false; */
-    const errors: any = [];
-    const inactiveSockets: SocketIO.Socket[] = [];
-
-    this.sockets.forEach((socket: SocketIO.Socket, index: number) => {
-      if (!socket.connected) {
-        DynamoFM_Log.warn(
-          `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!` +
-          `\nERROR: socket[${socket.id}] is not connected! (it will be removed...)`
-        );
-
-        /* errors.push(
-          new DynamoFM_Error({
-            status: 500,
-            errorCode: 'NTS-SPC-EE1',
-            addECToUserMsg: true,
-            message: 
-            `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!`+
-            `\nERROR: socket[${socket.id}] is not connected!`,
-            userMessage: 'We encountered an unhandled Server Error, please contact the responsible development team.',
-          })
-        ); */
-
-        inactiveSockets.push(socket);
-        socket?.disconnect(true);
-      }
-    });
-
-    /* this.sockets.forEach((socket: SocketIO.Socket, index: number) => {
-      if (!socket) {
-        return;
-      }
-      if (inactiveSockets.includes(socket) || !socket?.connected) {
-        socket.TRY RECONNECT
-      } */
-
-    this.sockets = this.sockets.filter(
-      (socket): boolean => !inactiveSockets.includes(socket) && socket?.connected
-    );
-
-    this.sockets.forEach((socket: SocketIO.Socket, index: number): void => {
-      const success: boolean = socket.emit(event, content, (error): void => {
-        DynamoFM_Log.error(
-          `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!(0)` +
-          `\nerror:`, error
-        );
-        errors.push(error);
-      });
-
-      if (!success) {
-        DynamoFM_Log.error(
-          `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!(1)`
-        );
-      }
-    });
-
-    if (0 < errors.length) {
-      throw new DynamoFM_Error({
-        ...this._getDefaultErrorSettings(
-          'emitEvent',
-          new Error(
-            `Emitting event '${event}' on socket(s)(${this.serviceName}) failed!`+
-            `\n${errors.length} errors occured!`
-          ),
-          issuer
-        ),
-
-        status: 500,
-        errorCode: 'NTS-SPC-EE2',
-        additionalContent: {
-          inactiveSockets: inactiveSockets,
-          errors: errors,
-        },
-      });
-
-    } else if (this.sockets.length === 0) {
-      throw new DynamoFM_Error({
-        ...this._getDefaultErrorSettings(
-          'emitEvent',
-          new Error(
-            `Emitting event '${event}' on socket(s)(${this.serviceName}) failed!`+ 
-            `\n  No more sockets left connected!`
-          ),
-          issuer
-        ),
-
-        status: 404,
-        errorCode: 'NTS-SPC-EE3',
-      });
-    }
-  }
-  
-  private _getDefaultErrorSettings(
-    fnName: string, 
-    error: DynamoFM_AnyError, 
-    issuer: string
-  ): DynamoFM_Error_Settings {
-    return {
-      status: (error as DynamoFM_Error)?.___status ?? 406,
-      message: (error as Error)?.message ?? `${fnName} was UNSUCCESFUL (NTS; ${this.serviceName})`,
-      userMessage: (error as DynamoFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
-      issuerService: this.serviceName + ` (${this?.constructor?.name}-DynamoNTS_SocketPresence)`,
-      addECToUserMsg: !(error as DynamoFM_Error)?.__userMessage,
-      issuer: issuer,
-      error: error,
-    };
-  }
-
-}
-
+
+import { 
+  DynamoFM_AnyError, DynamoFM_Error, DynamoFM_Error_Settings, DynamoFM_Log 
+} from '@futdevpro/fsm-dynamo';
+import * as SocketIO from 'socket.io';
+
+/**
+ * socket handling and clarification is under development
+ */
+export class DynamoNTS_SocketPresence {
+  /** 
+   * this is the presence ID which is used to getand handle the presence 
+   * usually the service master identifier such as userID
+   * */
+  issuerId: string;
+  serviceName?: string = 'unknown';
+  onDestroy?: (issuerId: string) => void = (): void => {};
+  
+  defaultErrorUserMsg?: string = 
+    `We encountered an unhandled Socket Error, ` +
+    `\nplease contact the responsible development team.`; 
+  
+  sockets: SocketIO.Socket[] = [];
+  
+  constructor(
+    set: {
+      /** 
+       * this is the presence ID which is used to get and set handle the presence/sockets
+       * usually the service master identifier such as userID
+       * */
+      issuerId: string,
+      serviceName?: string,
+      onDestroy?: (issuerId: string) => void,
+
+      defaultErrorUserMsg?: string,
+      sockets: SocketIO.Socket[],
+
+      /**
+       * this is the issuer ID which is used to register data changes,
+       * usually the main master identifier such as accountID
+       */
+      issuer: string,
+    }
+  ) {
+    if (!set?.issuerId) {
+      throw new DynamoFM_Error({ 
+        ...this._getDefaultErrorSettings(
+          'constructor',
+          new Error(
+            `trying to create DynamoNTS_SocketPresence without a valid issuerId!` +
+            `\nset: ${JSON.stringify(set)}`
+          ),
+          set?.issuer
+        ),
+
+        errorCode: 'NTS-SD0-C00',
+      });
+    }
+
+    this.issuerId = set.issuerId;
+    
+    if (set.serviceName) {
+      this.serviceName = set.serviceName;
+    }
+
+    if (set.onDestroy) {
+      this.onDestroy = set.onDestroy;
+    }
+
+    if (set.defaultErrorUserMsg) {
+      this.defaultErrorUserMsg = set.defaultErrorUserMsg;
+    }
+
+    if (!set?.sockets?.length) {
+      throw new DynamoFM_Error({ 
+        ...this._getDefaultErrorSettings(
+          'constructor',
+          new Error(
+            `trying to create DynamoNTS_SocketPresence without a single active socket!` +
+            `\nissuerId: ${this.issuerId}`
+          ),
+          set?.issuer
+        ),
+
+        errorCode: 'NTS-SD0-C01',
+      });
+    }
+
+    this.sockets = set.sockets;
+  }
+
+  /**
+   * Emits event on all sockets
+   * @param event 
+   * @param content 
+   */
+  emitEvent?(event: string, content: any, issuer: string): void {
+    /* let anyFailed: boolean = false; */
+    const errors: any = [];
+    const inactiveSockets: SocketIO.Socket[] = [];
+
+    this.sockets.forEach((socket: SocketIO.Socket, index: number) => {
+      if (!socket.connected) {
+        DynamoFM_Log.warn(
+          `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!` +
+          `\nERROR: socket[${socket.id}] is not connected! (it will be removed...)`
+        );
+
+        /* errors.push(
+          new DynamoFM_Error({
+            status: 500,
+            errorCode: 'NTS-SPC-EE1',
+            addECToUserMsg: true,
+            message: 
+            `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!`+
+            `\nERROR: socket[${socket.id}] is not connected!`,
+            userMessage: 'We encountered an unhandled Server Error, please contact the responsible development team.',
+          })
+        ); */
+
+        inactiveSockets.push(socket);
+        socket?.disconnect(true);
+      }
+    });
+
+    /* this.sockets.forEach((socket: SocketIO.Socket, index: number) => {
+      if (!socket) {
+        return;
+      }
+      if (inactiveSockets.includes(socket) || !socket?.connected) {
+        socket.TRY RECONNECT
+      } */
+
+    this.sockets = this.sockets.filter(
+      (socket): boolean => !inactiveSockets.includes(socket) && socket?.connected
+    );
+
+    this.sockets.forEach((socket: SocketIO.Socket, index: number): void => {
+      const success: boolean = socket.emit(event, content, (error): void => {
+        DynamoFM_Log.error(
+          `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!(0)` +
+          `\nerror:`, error
+        );
+        errors.push(error);
+      });
+
+      if (!success) {
+        DynamoFM_Log.error(
+          `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!(1)`
+        );
+      }
+    });
+
+    if (0 < errors.length) {
+      throw new DynamoFM_Error({
+        ...this._getDefaultErrorSettings(
+          'emitEvent',
+          new Error(
+            `Emitting event '${event}' on socket(s)(${this.serviceName}) failed!`+
+            `\n${errors.length} errors occured!`
+          ),
+          issuer
+        ),
+
+        status: 500,
+        errorCode: 'NTS-SPC-EE2',
+        additionalContent: {
+          inactiveSockets: inactiveSockets,
+          errors: errors,
+        },
+      });
+
+    } else if (this.sockets.length === 0) {
+      throw new DynamoFM_Error({
+        ...this._getDefaultErrorSettings(
+          'emitEvent',
+          new Error(
+            `Emitting event '${event}' on socket(s)(${this.serviceName}) failed!`+ 
+            `\n  No more sockets left connected!`
+          ),
+          issuer
+        ),
+
+        status: 404,
+        errorCode: 'NTS-SPC-EE3',
+      });
+    }
+  }
+  
+  private _getDefaultErrorSettings(
+    fnName: string, 
+    error: DynamoFM_AnyError, 
+    issuer: string
+  ): DynamoFM_Error_Settings {
+    return {
+      status: (error as DynamoFM_Error)?.___status ?? 406,
+      message: (error as Error)?.message ?? `${fnName} was UNSUCCESFUL (NTS; ${this.serviceName})`,
+      userMessage: (error as DynamoFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      issuerService: this.serviceName + ` (${this?.constructor?.name}-DynamoNTS_SocketPresence)`,
+      addECToUserMsg: !(error as DynamoFM_Error)?.__userMessage,
+      issuer: issuer,
+      error: error,
+    };
+  }
+
+}
+

package/src/_models/control-models/socket-server-service-params.control-model.ts

@@ -1,20 +1,20 @@
-
-import { DynamoNTS_globalSettings } from '../../_constants/global-settings.const';
-import { DynamoNTS_SocketSecurity } from '../../_enums/socket-security.enum';
-
-/**
- * socket handling and clarification is under development
- */
-export class DynamoNTS_SocketServerService_Params<T = any> {
-  name: string;
-  port: number;
-  security?: DynamoNTS_SocketSecurity;
-
-  constructor(
-    set: DynamoNTS_SocketServerService_Params<T>
-  ) {
-    this.name = set.name;
-    this.port = set.port;
-    this.security = set.security ? set.security : DynamoNTS_globalSettings.defaultSocketSecurity;
-  }
-}
+
+import { DynamoNTS_globalSettings } from '../../_constants/global-settings.const';
+import { DynamoNTS_SocketSecurity } from '../../_enums/socket-security.enum';
+
+/**
+ * socket handling and clarification is under development
+ */
+export class DynamoNTS_SocketServerService_Params<T = any> {
+  name: string;
+  port: number;
+  security?: DynamoNTS_SocketSecurity;
+
+  constructor(
+    set: DynamoNTS_SocketServerService_Params<T>
+  ) {
+    this.name = set.name;
+    this.port = set.port;
+    this.security = set.security ? set.security : DynamoNTS_globalSettings.defaultSocketSecurity;
+  }
+}

package/src/_models/control-models/system-control.control-model.ts

@@ -1,12 +1,12 @@
-
-
-
-export class DynamoNTS_SystemControl {
-  init: boolean = false;
-  started: boolean = false;
-
-  getReady(): boolean {
-    return this.init ? this.started : true;
-  }
-}
-
+
+
+
+export class DynamoNTS_SystemControl {
+  init: boolean = false;
+  started: boolean = false;
+
+  getReady(): boolean {
+    return this.init ? this.started : true;
+  }
+}
+

package/src/_models/index.ts

@@ -1,9 +1,9 @@
-
-// INTERFACES
-export * from './interfaces';
-
-// CONTROL MODELS
-export * from './control-models';
-
-// TYPES
-export * from './types';
+
+// INTERFACES
+export * from './interfaces';
+
+// CONTROL MODELS
+export * from './control-models';
+
+// TYPES
+export * from './types';

package/src/_models/interfaces/certification-settings.interface.ts

@@ -1,7 +1,7 @@
-
-import * as FileSystem from 'fs';
-
-export interface DynamoNTS_Certification_Settings {
-  keyPath: FileSystem.PathLike,
-  certPath: FileSystem.PathLike,
-}
+
+import * as FileSystem from 'fs';
+
+export interface DynamoNTS_Certification_Settings {
+  keyPath: FileSystem.PathLike,
+  certPath: FileSystem.PathLike,
+}

package/src/_models/interfaces/global-service-settings.interface.ts

@@ -1,45 +1,45 @@
-
-
-
-
-import { Request, Response } from 'express';
-
-import { DynamoFM_DataModel_Params } from '@futdevpro/fsm-dynamo';
-
-import { DynamoNTS_Service_Collection } from '../../_services/core/service-collection.service';
-import { DynamoNTS_EmailService } from '../../_services/core/email.service';
-import { DynamoNTS_AuthService } from '../../_services/core/auth.service';
-
-
-export interface DynamoNTS_GlobalService_Settings {
-  /**
-   * You need to setup your Own Auth Service extending the DynamoNTS_AuthService class
-   */
-  authService: DynamoNTS_AuthService,
-
-  /**
-   * You can setup your Own Email Service extending the DynamoNTS_EmailServiceCollection class
-   */
-  emailServiceCollection?: DynamoNTS_Service_Collection<DynamoNTS_EmailService>,
-
-  /**
-   * you can setup data tables by passing a DynamoFM_DataModel_Params list at this point 
-   */
-  dbModels?: DynamoFM_DataModel_Params[],
-
-  /**
-   * you can setup other services by passing a DynamoNTS_SingletonService list at this point
-   */
-  /* simpleServicesCollection?: DynamoNTS_SimpleServiceCollection, */
-
-  /**
-   * you can setup socket services by passing a DynamoNTS_SocketServiceCollection list at this point
-   */
-  /* socketServiceCollection?: DynamoNTS_SocketServiceCollection, */
-
-  /**
-   * you can setup global error handler by passing a function at this point
-   */
-  errorHandler?: (err: any, req?: Request, res?: Response, issuer?: string) => Promise<void>,
-}
-
+
+
+
+
+import { Request, Response } from 'express';
+
+import { DynamoFM_DataModel_Params } from '@futdevpro/fsm-dynamo';
+
+import { DynamoNTS_Service_Collection } from '../../_services/core/service-collection.service';
+import { DynamoNTS_EmailService } from '../../_services/core/email.service';
+import { DynamoNTS_AuthService } from '../../_services/core/auth.service';
+
+
+export interface DynamoNTS_GlobalService_Settings {
+  /**
+   * You need to setup your Own Auth Service extending the DynamoNTS_AuthService class
+   */
+  authService: DynamoNTS_AuthService,
+
+  /**
+   * You can setup your Own Email Service extending the DynamoNTS_EmailServiceCollection class
+   */
+  emailServiceCollection?: DynamoNTS_Service_Collection<DynamoNTS_EmailService>,
+
+  /**
+   * you can setup data tables by passing a DynamoFM_DataModel_Params list at this point 
+   */
+  dbModels?: DynamoFM_DataModel_Params[],
+
+  /**
+   * you can setup other services by passing a DynamoNTS_SingletonService list at this point
+   */
+  /* simpleServicesCollection?: DynamoNTS_SimpleServiceCollection, */
+
+  /**
+   * you can setup socket services by passing a DynamoNTS_SocketServiceCollection list at this point
+   */
+  /* socketServiceCollection?: DynamoNTS_SocketServiceCollection, */
+
+  /**
+   * you can setup global error handler by passing a function at this point
+   */
+  errorHandler?: (err: any, req?: Request, res?: Response, issuer?: string) => Promise<void>,
+}
+