@futdevpro/fsm-dynamo 1.5.23 → 1.5.27

package/src/_collections/dynamo-shared.service.ts

@@ -1,10 +1,10 @@
 
 import { day, hour, month, week, year } from '../_constants/times';
 import { LogStyle } from '../_enums/log-style.enum';
-import { DynamoBEError } from '../_models/control-models/dynamobe-error';
+import { Dynamo_Error } from '../_models/control-models/dynamo-error';
 import { LocationCoordinates } from '../_models/control-models/location-coordinates';
 
-export class D_Shared {
+export class Dynamo_Shared {
 
   /**
    * returns remapped object list by path list
@@ -185,7 +185,7 @@ export class D_Shared {
       if (latitude) {
         return distanceInKm / (Math.cos(this.toRadians(latitude)) * 111.320);
       } else {
-        throw new DynamoBEError({ status: 417, message: 'When using getLocationDegByKilometers for longitude, you need to give latitude!' });
+        throw new Dynamo_Error({ status: 417, message: 'When using getLocationDegByKilometers for longitude, you need to give latitude!' });
       }
     }
   }
@@ -264,4 +264,8 @@ export class D_Shared {
       console.warn(`${LogStyle.yellow}${LogStyle.bright}${message}${LogStyle.reset}`);
     }
   }
+
+  static delay(ms: number): Promise<void> {
+    return new Promise(resolve => setTimeout(resolve, ms) );
+  }
 }

package/src/_constants/module-settings/test-module-settings.ts

@@ -1,7 +1,7 @@
 
-import { DynamoModuleSettings } from '../../_models/control-models/dynamo-module-settings';
+import { DynamoNTS_ModuleSettings } from '../../_models/control-models/dynamo-nts-module-settings';
 
-export const testModuleSettings: DynamoModuleSettings = {
+export const testModuleSettings: DynamoNTS_ModuleSettings = {
   mainRoute: '/test',
   endPoints: {
     testGet: '/test-get',

package/src/_constants/module-settings/usage-module-settings.ts

@@ -1,7 +1,7 @@
 
-import { DynamoModuleSettings } from '../../_models/control-models/dynamo-module-settings';
+import { DynamoNTS_ModuleSettings } from '../../_models/control-models/dynamo-nts-module-settings';
 
-export const usageModuleSettings: DynamoModuleSettings = {
+export const usageModuleSettings: DynamoNTS_ModuleSettings = {
   mainRoute: '/usage',
   endPoints: {
     newSession: '/new-session',

package/src/_models/control-models/{daily-usage-data.ts → dynamo-daily-usage-data.ts}

@@ -1,14 +1,14 @@
 
-import { DynamoUsageSession } from "../data-models/usage-session";
+import { Dynamo_UsageSession } from "../data-models/dynamo-usage-session";
 
-export class DailyUsageData {
+export class Dynamo_DailyUsageData {
   date?: string;
   totalVisitTime?: number = 0;
   averageVisitTime?: number = 0;
   visitorsHun?: number = 0;
   visitorsElse?: number = 0;
 
-  visitations?: DynamoUsageSession[] = [];
+  visitations?: Dynamo_UsageSession[] = [];
 
   constructor(
     set?: {
@@ -18,7 +18,7 @@ export class DailyUsageData {
       visitorsHun?: number,
       visitorsElse?: number,
 
-      visitations?: DynamoUsageSession[],
+      visitations?: Dynamo_UsageSession[],
     }
   ) {
     if (set) {

package/src/_models/control-models/{dynamobe-error.ts → dynamo-error.ts}

@@ -1,68 +1,78 @@
 
 
-export class DynamoBEError {
-  flag = 'DYNAMO-BE ERROR OBJECT';
+export class Dynamo_Error {
+  flag = 'DYNAMO ERROR OBJECT';
   handled: boolean;
   status: number;
-  errors: any[] = [];
+  errorCode: string;
+
   error: any;
+  errors: any[] = [];
+
+  message: string;
   messages: string[] = [];
+
+  userMessage: string;
   userMessages: string[] = [];
 
   constructor(
-    set: {
+    set?: {
       handled?: boolean;
       status?: number,
+      errorCode?: string;
+
+      error?: any,
+      errors?: any[],
+
       message?: string,
       messages?: string[],
+
       userMessage?: string,
-      error?: any,
+      userMessages?: string[],
+      addECToUserMsg?: boolean,
+      
       consoleLog?: boolean,
     }
   ) {
     this.handled = !!set.handled;
-    if (set.status) {
-      this.status = set.status;
-    }
-    this.status = set?.error?.status ? set.error.status : set.status;
 
-    if (set?.error?.errors) {
-      this.errors = this.errors.concat(set?.error?.errors);
-    }
-    if (set?.error?.messages) {
-      this.messages = this.messages.concat(set?.error?.messages);
-    }
-    if (set?.error?.userMessages) {
-      this.userMessages = this.userMessages.concat(set?.error?.userMessages);
-    }
+    if (set) {
+      this.status = set.status ?? set?.error?.status;
+      this.errorCode = set.errorCode ?? set?.error?.errorCode;
 
-    if (set.error) {
-      if (set.error instanceof DynamoBEError) {
-        this.errors.push(set.error.error);
-      } else {
+      if (set.error) {
         if (set.error.error) {
           this.errors.push(set.error.error);
         }
-        this.errors.push(set.error);
-      }
-      if (set.error.message) {
-        this.messages.push(set.error.message);
-      }
-      if (set.error.status) {
-        this.status = set.error.status;
+        if (set.error.errors) {
+          this.errors.push(...set.error.errors);
+        }
+
+        if (set.error.message) {
+          this.messages.push(set.error.message);
+        }
+        if (set.error.messages) {
+          this.messages.push(...set.error.messages);
+        }
+
+        if (set.error.userMessage) {
+          this.userMessages.push(set.error.userMessage);
+        }
+        if (set.error.userMessages) {
+          this.userMessages.push(...set.error.userMessages);
+        }
       }
     }
-    if (set.message) {
-      this.messages.push(set.message)
-    }
-    if (set.messages) {
-      this.messages.push(...set.messages)
-    }
-    if (set.userMessage) {
-      this.userMessages.push(set.userMessage)
+
+    this.error = set?.error ?? this.errors[0];
+    this.message = set?.message ?? this.messages[0];
+    this.userMessage = set?.userMessage ?? this.userMessages[0];
+    if (set.addECToUserMsg) {
+      this.userMessage += `\nErrorCode: ${this.errorCode}`
     }
+
     if (set.consoleLog) {
-      console.log(this);
+      console.error(this);
     }
   }
 }

package/src/_models/control-models/{dynamobe-data-params.ts → dynamo-nts-data-params.ts}

@@ -1,18 +1,18 @@
 
 import { DataModelType } from '../../_enums';
-import { DynamoBEDataPropertyParams } from './dynamobe-data-property-params';
+import { DynamoNTS_DataPropertyParams } from './dynamo-nts-data-property-params';
 
-export class DynamoBEDataParams {
+export class DynamoNTS_DataParams {
   dataName: string;
   modelType?: DataModelType;
   dbName: string;
-  modelParams: DynamoBEDataPropertyParams[];
+  modelParams: DynamoNTS_DataPropertyParams[];
 
   constructor(
     set: {
       dataName: string,
       modelType?: DataModelType,
-      modelParams: DynamoBEDataPropertyParams[],
+      modelParams: DynamoNTS_DataPropertyParams[],
     }
   ) {
     this.dataName = set.dataName;

package/src/_models/control-models/{dynamobe-data-property-params.ts → dynamo-nts-data-property-params.ts}

@@ -1,5 +1,5 @@
 
-export class DynamoBEDataPropertyParams {
+export class DynamoNTS_DataPropertyParams {
   key?: string;
   type?: 'string' | 'number' | 'boolean' | 'Date' | 'object' | string;
 
@@ -13,7 +13,7 @@ export class DynamoBEDataPropertyParams {
   minlength?: number;
   maxlength?: number;
 
-  subObjectParams?: DynamoBEDataPropertyParams[] = [];
+  subObjectParams?: DynamoNTS_DataPropertyParams[] = [];
 
   additionalValidators?: ((data: any) => void)[];
 
@@ -32,7 +32,7 @@ export class DynamoBEDataPropertyParams {
       minlength?: number,
       maxlength?: number,
 
-      subObjectParams?: DynamoBEDataPropertyParams[],
+      subObjectParams?: DynamoNTS_DataPropertyParams[],
 
       additionalValidators?: ((data: any) => void)[],
     }

package/src/_models/control-models/{dynamo-module-settings.ts → dynamo-nts-module-settings.ts}

@@ -1,5 +1,5 @@
 
-export interface DynamoModuleSettings {
+export interface DynamoNTS_ModuleSettings {
   mainRoute: string;
 
   endPoints: {

package/src/_models/control-models/dynamo-poll.ts

@@ -0,0 +1,80 @@
+import { Subscription, timer } from 'rxjs';
+
+/**
+ * DynamoFSM_Poll is a predefined class is
+ * for polling a specific endpoint
+ * waiting a specific result
+ */
+export class Dynamo_Poll<T> {
+  poll: Subscription;
+  running: boolean;
+  private pollDo: (...args) => Promise<T>;
+  private pollWhile: (res: T) => boolean;
+  private pollEnd: (res: T) => void;
+  private args?: unknown[];
+  private pollDelay?: number;
+  private pollPeriod?: number;
+  private stopOnFail?: boolean;
+
+  constructor(
+    set: {
+      pollDo: (...args) => Promise<T>,
+      pollWhile: (res: T) => boolean,
+      pollEnd: (res: T) => void,
+      args?: unknown[],
+      pollDelay?: number,
+      pollPeriod?: number,
+      stopOnFail?: boolean,
+    }
+  ) {
+    this.pollDo = set.pollDo;
+    this.pollWhile = set.pollWhile;
+    this.pollEnd = set.pollEnd;
+    this.args = set.args;
+    this.pollDelay = set.pollDelay ? set.pollDelay : 0;
+    if (set.pollPeriod === 0) {
+      console.error('DYNAMO ERROR: creating polls with 0ms period is not supported! (it will reset to 1000ms (1s))', new Error());
+    }
+    this.pollPeriod = set.pollPeriod ? set.pollPeriod : 1000;
+    if (this.pollPeriod < 300) {
+      console.warn('DYNAMO WARNING: creating polls with less than 300ms period is not recommended!');
+    }
+    this.stopOnFail = set.stopOnFail;
+    this.startPoll(this.args);
+  }
+
+  private startPoll(...args: unknown[]): void {
+    this.poll = timer(this.pollDelay, this.pollPeriod).subscribe(() => {
+      this.pollDo(...args).then((res: T) => {
+        if (!this.pollWhile(res)) {
+          this.end(res);
+        }
+      }).catch((error) => {
+        console.error('DYNAMO ERROR: \nDynamoPoll: pollDo was UNSUCCESSFUL', error, '\n\n', new Error());
+        if (this.stopOnFail) {
+          this.stop();
+        }
+      });
+    });
+    this.running = true;
+  }
+
+  restartPoll(args?: unknown[]): void {
+    if (args) {
+      this.startPoll(args);
+    } else {
+      this.startPoll(this.args);
+    }
+  }
+
+  stop(): void {
+    this.poll.unsubscribe();
+    this.running = false;
+  }
+
+  end(result: T): void {
+    this.poll.unsubscribe();
+    this.pollEnd(result);
+    this.running = false;
+  }
+}

package/src/_models/control-models/{usage-action.ts → dynamo-usage-action.ts}

@@ -1,5 +1,5 @@
 
-export class DynamoUsageAction {
+export class Dynamo_UsageAction {
   action?: string;
   time?: Date;
 

package/src/_models/control-models/{usage-data.ts → dynamo-usage-data.ts}

@@ -1,18 +1,18 @@
 
-import { DynamoUsageAction } from './usage-action';
+import { Dynamo_UsageAction } from './dynamo-usage-action';
 
-export class DynamoUsageData {
+export class Dynamo_UsageData {
   page?: string;
   opened?: Date;
   timeSpentOnPage?: number;
-  actions?: DynamoUsageAction[] = [];
+  actions?: Dynamo_UsageAction[] = [];
 
   constructor(
     set?: {
       page?: string,
       opened?: Date;
       timeSpentOnPage?: number,
-      actions?: DynamoUsageAction[],
+      actions?: Dynamo_UsageAction[],
     }
   ) {
     if (set) {

package/src/_models/data-models/{custom-data.ts → dynamo-custom-data.ts}

@@ -1,8 +1,8 @@
 
-import { DynamoBEDataParams } from '../control-models/dynamobe-data-params';
-import { Metadata } from './metadata';
+import { DynamoNTS_DataParams } from '../control-models/dynamo-nts-data-params';
+import { Dynamo_Metadata } from './dynamo-metadata';
 
-export class CustomData extends Metadata {
+export class Dynamo_CustomData extends Dynamo_Metadata {
   data?: string;
 
   constructor(
@@ -32,7 +32,7 @@ export class CustomData extends Metadata {
   }
 }
 
-export const customDataModelParams = new DynamoBEDataParams({
+export const customDataModelParams = new DynamoNTS_DataParams({
   dataName: 'customData',
   modelParams: [
     { key: 'data', type: 'string', required: true },

package/src/_models/data-models/{metadata.ts → dynamo-metadata.ts}

@@ -1,7 +1,8 @@
 
 
-export class Metadata {
+export class Dynamo_Metadata {
   _id?: string;
+
   __created?: Date;
   __createdBy?: string;
   __lastModified?: Date;
@@ -11,15 +12,17 @@ export class Metadata {
   constructor(
     set?: {
       _id?: string,
+
       __created?: Date,
       __createdBy?: string,
       __lastModified?: Date,
       __lastModifiedBy?: string,
       __v?: number;
-    } | Metadata
+    } | Dynamo_Metadata
   ){
     if (set) {
       this._id = set._id ? set._id : undefined;
+
       this.__created = set.__created ? set.__created : undefined;
       this.__createdBy = set.__createdBy ? set.__createdBy : undefined;
       this.__lastModified = set.__lastModified ? set.__lastModified : undefined;

package/src/_models/data-models/{usage-session.ts → dynamo-usage-session.ts}

@@ -1,10 +1,10 @@
 
 import { GeoIpLocation } from '../control-models/geo-ip-location';
-import { Metadata } from './metadata';
-import { DynamoUsageData } from '../control-models/usage-data';
-import { DynamoBEDataParams } from '../control-models/dynamobe-data-params';
+import { Dynamo_Metadata } from './dynamo-metadata';
+import { Dynamo_UsageData } from '../control-models/dynamo-usage-data';
+import { DynamoNTS_DataParams } from '../control-models/dynamo-nts-data-params';
 
-export class DynamoUsageSession extends Metadata {
+export class Dynamo_UsageSession extends Dynamo_Metadata {
   date?: string;
   sessionStart?: Date;
   sessionEnd?: Date;
@@ -12,7 +12,7 @@ export class DynamoUsageSession extends Metadata {
   issuer?: string;
   locationData?: GeoIpLocation;
 
-  usageData?: DynamoUsageData[];
+  usageData?: Dynamo_UsageData[];
   totalSessionTime?: number;
   loggedInAs?: string;
 
@@ -27,7 +27,7 @@ export class DynamoUsageSession extends Metadata {
       issuer?: string,
       locationData?: GeoIpLocation,
 
-      usageData?: DynamoUsageData[],
+      usageData?: Dynamo_UsageData[],
       totalSessionTime?: number,
       loggedInAs?: string,
 
@@ -65,7 +65,7 @@ export class DynamoUsageSession extends Metadata {
   }
 }
 
-export const usageSessionModelParams = new DynamoBEDataParams({
+export const usageSessionModelParams = new DynamoNTS_DataParams({
   dataName: 'usageSession',
   modelParams: [
     { key: 'date', type: 'string',

package/src/_models/index.ts

@@ -1,16 +1,17 @@
 
 // MODELS
   // Control models
-export * from './control-models/daily-usage-data';
-export * from './control-models/dynamobe-data-params';
-export * from './control-models/dynamobe-data-property-params';
-export * from './control-models/dynamobe-error';
+export * from './control-models/dynamo-daily-usage-data';
+export * from './control-models/dynamo-nts-data-params';
+export * from './control-models/dynamo-nts-data-property-params';
+export * from './control-models/dynamo-error';
 export * from './control-models/geo-ip-location';
 export * from './control-models/location-coordinates';
-export * from './control-models/usage-action';
-export * from './control-models/usage-data';
+export * from './control-models/dynamo-usage-action';
+export * from './control-models/dynamo-usage-data';
+export * from './control-models/dynamo-poll';
   // Data models
-export * from './data-models/custom-data';
-export * from './data-models/metadata';
-export * from './data-models/usage-session';
+export * from './data-models/dynamo-custom-data';
+export * from './data-models/dynamo-metadata';
+export * from './data-models/dynamo-usage-session';
 

package/src/_modules/data-modules.index.ts

@@ -1,9 +1,9 @@
 
 // DATA MODULE
-export * from '../_models/data-models/metadata';
-export * from '../_models/control-models/dynamobe-data-params';
-export * from '../_models/control-models/dynamobe-data-property-params';
-export * from '../_models/control-models/dynamobe-error';
+export * from '../_models/data-models/dynamo-metadata';
+export * from '../_models/control-models/dynamo-nts-data-params';
+export * from '../_models/control-models/dynamo-nts-data-property-params';
+export * from '../_models/control-models/dynamo-error';
 export * from '../_enums/data-model-type.enum';
 
 

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

@@ -1,5 +1,5 @@
 
 // ERROR MODULE
-export * from '../_models/control-models/dynamobe-error';
+export * from '../_models/control-models/dynamo-error';
 
 

package/src/_modules/shared-service.index.ts

@@ -3,6 +3,7 @@
 export * from '../_collections/dynamo-shared.service';
 export * from '../_constants/times';
 export * from '../_enums/log-style.enum';
-export * from '../_models/control-models/dynamobe-error';
+export * from '../_models/control-models/dynamo-error';
 export * from '../_models/control-models/location-coordinates';
 export * from '../_models/control-models/geo-ip-location';
+export * from '../_models/control-models/dynamo-poll';

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

@@ -1,6 +1,6 @@
 
 // TEST MODULE
-export * from '../_models/data-models/custom-data';
+export * from '../_models/data-models/dynamo-custom-data';
 export * from '../_constants/module-settings/test-module-settings';
 
 

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

@@ -1,9 +1,9 @@
 
 // USAGE MODULE
-export * from '../_models/data-models/usage-session';
+export * from '../_models/data-models/dynamo-usage-session';
 export * from '../_constants/module-settings/usage-module-settings';
-export * from '../_models/control-models/usage-data';
-export * from '../_models/control-models/daily-usage-data';
-export * from '../_models/control-models/usage-action';
+export * from '../_models/control-models/dynamo-usage-data';
+export * from '../_models/control-models/dynamo-daily-usage-data';
+export * from '../_models/control-models/dynamo-usage-action';