@futdevpro/nts-dynamo 1.9.15 → 1.9.17

package/src/_models/control-models/index.ts

@@ -1,13 +1,13 @@
-
-
-// MODELS
-export * from './api-call-params.control-model';
-export * from './app-params.control-model';
-export * from './endpoint-params.control-model';
-export * from './socket-client-service-params.control-model';
-export * from './socket-event.control-model';
-
-// these are using socket.io therefore they are not included in the service index
-// export * from './socket-server-service-params.control-model';
-// export * from './socket-presence.control-model';
-
+
+
+// MODELS
+export * from './api-call-params.control-model';
+export * from './app-params.control-model';
+export * from './endpoint-params.control-model';
+export * from './socket-client-service-params.control-model';
+export * from './socket-event.control-model';
+
+// these are using socket.io therefore they are not included in the service index
+// export * from './socket-server-service-params.control-model';
+// export * from './socket-presence.control-model';
+

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

@@ -1,28 +1,28 @@
-
-import * as SocketIO from 'socket.io-client';
-
-import { second } from '@futdevpro/fsm-dynamo';
-
-/**
- * socket handling and clarification is under development
- */
-export class DynamoNTS_SocketClientService_Params {
-  service: string;
-  name: string;
-  address?: string = 'ws://localhost';
-  port: number;
-  reconnectDelay?: number = second * 10;
-  reconnect?: boolean = true;
-  socketOptions?: Partial<SocketIO.ManagerOptions & SocketIO.SocketOptions>;
-
-  constructor(
-    set: DynamoNTS_SocketClientService_Params
-  ) {
-    Object.assign(this, set);
-
-    this.reconnect = !!this.reconnectDelay;
-    if (this.socketOptions?.autoConnect || this.socketOptions?.reconnection) {
-      this.reconnect = false;
-    }
-  }
-}
+
+import * as SocketIO from 'socket.io-client';
+
+import { second } from '@futdevpro/fsm-dynamo';
+
+/**
+ * socket handling and clarification is under development
+ */
+export class DynamoNTS_SocketClientService_Params {
+  service: string;
+  name: string;
+  address?: string = 'ws://localhost';
+  port: number;
+  reconnectDelay?: number = second * 10;
+  reconnect?: boolean = true;
+  socketOptions?: Partial<SocketIO.ManagerOptions & SocketIO.SocketOptions>;
+
+  constructor(
+    set: DynamoNTS_SocketClientService_Params
+  ) {
+    Object.assign(this, set);
+
+    this.reconnect = !!this.reconnectDelay;
+    if (this.socketOptions?.autoConnect || this.socketOptions?.reconnection) {
+      this.reconnect = false;
+    }
+  }
+}

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

@@ -1,150 +1,150 @@
-
-import { DynamoFM_Array, DynamoFM_Log } from '@futdevpro/fsm-dynamo';
-import { DynamoNTS_globalSettings } from '../../_constants/global-settings.const';
-import { DynamoNTS_SocketEventKey } from '../../_enums/http/socket-event-type.enum';
-
-
-export type DynamoNTS_SocketEventPreprocessTask<T = any, R = any> = 
-  (content?: T, issuer?: string) => Promise<R>;
-export type DynamoNTS_SocketEventTask<T> = (content?: T, issuer?: string) => Promise<void>;
-
-/**
- * socket handling and clarification is under development
- */
-export class DynamoNTS_SocketEvent<T>{
-  socketName?: string;
-  eventKey: DynamoNTS_SocketEventKey | string;
-  serviceName?: string;
-  
-  preProcessess?: DynamoNTS_SocketEventPreprocessTask<any, any>[];
-  tasks?: DynamoNTS_SocketEventTask<T>[];
-
-  logEvent?: boolean;
-  logEventContent?: boolean;
-
-  constructor(
-    set: {
-      /**
-       * naming the socket will help to follow events on service,
-       * if not set, the eventKey will be used
-       */
-      name?: string,
-      /**
-       * define socket event type such as; 
-       * connection, connect, disconnect, message, error, or anything else
-       */
-      eventKey: DynamoNTS_SocketEventKey | string,
-      /**
-       * serviceName is the name of the service that will be used for logging
-       */
-      serviceName?: string,
-      /**
-       * preprocesses are the functions the service needs to run before the actual function,
-       * these can be used for authentications, or translating data
-       * 
-       * the last function in the array should return the content in the type(T) of the socket<T>
-       */
-      preProcessess?: DynamoNTS_SocketEventPreprocessTask<any, any>[],
-      /**
-       * tasks are the functions the service needs to run
-       */
-      tasks?: DynamoNTS_SocketEventTask<T>[],
-      /**
-       * logEvent will create a log for the event triggered
-       */
-      logEvent?: boolean,
-      /**
-       * logEventContent will create a log for the event triggered with the content
-       */
-      logEventContent?: boolean,
-    }
-  ) {
-    try {
-      this.socketName = set.name ?? set.eventKey;
-      this.eventKey = set.eventKey;
-      this.serviceName = set.serviceName ?? 'UnkwownSocketService';
-
-      this.preProcessess = set.preProcessess ?? [];
-      this.tasks = set.tasks ?? [];
-
-      if (set.logEvent !== undefined) {
-        this.logEvent = set.logEvent;
-      } else if (this.eventKey === DynamoNTS_SocketEventKey.subscribe) {
-        this.logEvent = false;
-      } else if (
-        ([ 
-          DynamoNTS_SocketEventKey.connection, 
-          DynamoNTS_SocketEventKey.connect,
-          DynamoNTS_SocketEventKey.disconnect,
-        ] as string[]).includes(this.eventKey)
-      ) {
-        this.logEvent = DynamoNTS_globalSettings.logMainSocketEvents || 
-          DynamoNTS_globalSettings.logAllSocketEvent;
-      } else {
-        this.logEvent = DynamoNTS_globalSettings.logAllSocketEvent;
-      }
-      this.logEventContent = set.logEventContent !== undefined ? 
-        set.logEventContent : DynamoNTS_globalSettings.logSocketEventContent;
-    } catch (error) {
-      DynamoFM_Log.error(
-        `\nSocket Event params setup failed (${this.serviceName}): ${set.eventKey}`, 
-        error
-      );
-
-      throw error;
-    }
-  }
-
-  /**
-   * 
-   * @returns 
-   */
-  private async getPreLog(content: T, issuer?: string): Promise<void> {
-    try {
-      if (this.logEventContent && this.eventKey !== DynamoNTS_SocketEventKey.connection) {
-        DynamoFM_Log.log(
-          `--->   incoming socket(${this.serviceName}) event: ${this.eventKey};
-          \ncontent:`, content
-        );
-      } else {
-        DynamoFM_Log.log(`--->   incoming socket(${this.serviceName}) event: ${this.eventKey}...`);
-      }
-    } catch (error) {
-      DynamoFM_Log.error(`PreLog failed... (socket:  ${this.serviceName})`, error);
-    }
-  }
-
-  /**
-   * 
-   * @returns 
-   */
-  async executeEventTasks(content?: T, issuer?: string): Promise<void> {
-    try {        
-      if (this.logEvent || this.logEventContent) {
-        await this.getPreLog(content, issuer);
-      }
-
-      await DynamoFM_Array.asyncForEach(
-        this.preProcessess, 
-        async (preProcess: DynamoNTS_SocketEventPreprocessTask<any, any>) => {
-          content = await preProcess(content);
-        }
-      );
-
-      await DynamoFM_Array.asyncForEach(this.tasks, async (task: DynamoNTS_SocketEventTask<T>) => {
-        await task(content, issuer);
-      });
-    } catch (error) {
-      DynamoFM_Log.error(
-        `Socket Event tasks failed to execute on ${this.serviceName}.... (${this.eventKey})`, 
-        error, 
-        'content:', 
-        content
-      );
-    }
-  }
-}
-
-
-
-
+
+import { DynamoFM_Array, DynamoFM_Log } from '@futdevpro/fsm-dynamo';
+import { DynamoNTS_globalSettings } from '../../_constants/global-settings.const';
+import { DynamoNTS_SocketEventKey } from '../../_enums/http/socket-event-type.enum';
+
+
+export type DynamoNTS_SocketEventPreprocessTask<T = any, R = any> = 
+  (content?: T, issuer?: string) => Promise<R>;
+export type DynamoNTS_SocketEventTask<T> = (content?: T, issuer?: string) => Promise<void>;
+
+/**
+ * socket handling and clarification is under development
+ */
+export class DynamoNTS_SocketEvent<T>{
+  socketName?: string;
+  eventKey: DynamoNTS_SocketEventKey | string;
+  serviceName?: string;
+  
+  preProcessess?: DynamoNTS_SocketEventPreprocessTask<any, any>[];
+  tasks?: DynamoNTS_SocketEventTask<T>[];
+
+  logEvent?: boolean;
+  logEventContent?: boolean;
+
+  constructor(
+    set: {
+      /**
+       * naming the socket will help to follow events on service,
+       * if not set, the eventKey will be used
+       */
+      name?: string,
+      /**
+       * define socket event type such as; 
+       * connection, connect, disconnect, message, error, or anything else
+       */
+      eventKey: DynamoNTS_SocketEventKey | string,
+      /**
+       * serviceName is the name of the service that will be used for logging
+       */
+      serviceName?: string,
+      /**
+       * preprocesses are the functions the service needs to run before the actual function,
+       * these can be used for authentications, or translating data
+       * 
+       * the last function in the array should return the content in the type(T) of the socket<T>
+       */
+      preProcessess?: DynamoNTS_SocketEventPreprocessTask<any, any>[],
+      /**
+       * tasks are the functions the service needs to run
+       */
+      tasks?: DynamoNTS_SocketEventTask<T>[],
+      /**
+       * logEvent will create a log for the event triggered
+       */
+      logEvent?: boolean,
+      /**
+       * logEventContent will create a log for the event triggered with the content
+       */
+      logEventContent?: boolean,
+    }
+  ) {
+    try {
+      this.socketName = set.name ?? set.eventKey;
+      this.eventKey = set.eventKey;
+      this.serviceName = set.serviceName ?? 'UnkwownSocketService';
+
+      this.preProcessess = set.preProcessess ?? [];
+      this.tasks = set.tasks ?? [];
+
+      if (set.logEvent !== undefined) {
+        this.logEvent = set.logEvent;
+      } else if (this.eventKey === DynamoNTS_SocketEventKey.subscribe) {
+        this.logEvent = false;
+      } else if (
+        ([ 
+          DynamoNTS_SocketEventKey.connection, 
+          DynamoNTS_SocketEventKey.connect,
+          DynamoNTS_SocketEventKey.disconnect,
+        ] as string[]).includes(this.eventKey)
+      ) {
+        this.logEvent = DynamoNTS_globalSettings.logMainSocketEvents || 
+          DynamoNTS_globalSettings.logAllSocketEvent;
+      } else {
+        this.logEvent = DynamoNTS_globalSettings.logAllSocketEvent;
+      }
+      this.logEventContent = set.logEventContent !== undefined ? 
+        set.logEventContent : DynamoNTS_globalSettings.logSocketEventContent;
+    } catch (error) {
+      DynamoFM_Log.error(
+        `\nSocket Event params setup failed (${this.serviceName}): ${set.eventKey}`, 
+        error
+      );
+
+      throw error;
+    }
+  }
+
+  /**
+   * 
+   * @returns 
+   */
+  private async getPreLog(content: T, issuer?: string): Promise<void> {
+    try {
+      if (this.logEventContent && this.eventKey !== DynamoNTS_SocketEventKey.connection) {
+        DynamoFM_Log.log(
+          `--->   incoming socket(${this.serviceName}) event: ${this.eventKey};
+          \ncontent:`, content
+        );
+      } else {
+        DynamoFM_Log.log(`--->   incoming socket(${this.serviceName}) event: ${this.eventKey}...`);
+      }
+    } catch (error) {
+      DynamoFM_Log.error(`PreLog failed... (socket:  ${this.serviceName})`, error);
+    }
+  }
+
+  /**
+   * 
+   * @returns 
+   */
+  async executeEventTasks(content?: T, issuer?: string): Promise<void> {
+    try {        
+      if (this.logEvent || this.logEventContent) {
+        await this.getPreLog(content, issuer);
+      }
+
+      await DynamoFM_Array.asyncForEach(
+        this.preProcessess, 
+        async (preProcess: DynamoNTS_SocketEventPreprocessTask<any, any>) => {
+          content = await preProcess(content);
+        }
+      );
+
+      await DynamoFM_Array.asyncForEach(this.tasks, async (task: DynamoNTS_SocketEventTask<T>) => {
+        await task(content, issuer);
+      });
+    } catch (error) {
+      DynamoFM_Log.error(
+        `Socket Event tasks failed to execute on ${this.serviceName}.... (${this.eventKey})`, 
+        error, 
+        'content:', 
+        content
+      );
+    }
+  }
+}
+
+
+
+