@futdevpro/fsm-dynamo 1.5.51 → 1.5.55

package/package.json

@@ -1,25 +1,18 @@
 {
   "name": "@futdevpro/fsm-dynamo",
-  "version": "01.05.51",
+  "version": "01.05.55",
   "description": "Dynamic NodeTS (NodeJS-Typescript), MongoDB Backend System Framework by Future Development Ltd.",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-
+    "start": "npm run test-live",
     "deploy": "npm run build",
-    
-    "build": "npm run install-n-build",
-    "install-n-build": "npm i",
-    "postinstall-n-build": "npm run n-build",
-    "n-build": "npx tsc",
-    "postn-build": "npm publish",
-    
-    "build-tgz": "npm run install-n-build-tgz",
-    "install-n-build-tgz": "npm i",
-    "postinstall-n-build-tgz": "npm run n-build-tgz",
-    "n-build-tgz": "npx tsc",
-    "postn-build-tgz": "npm run pack-tgz",
-    "pack-tgz": "npm pack",
-    "postpack-tgz": "move ./*.tgz ../npm-tgz-collection"
+    "build": "npm run build-simple && jasmine && npm publish",
+    "build-tgz": "npm run build-simple && jasmine && npm pack && move ./*.tgz ../npm-tgz-collection",
+    "build-base": "rimraf ./lib && npm i && npx tsc",
+    "build-simple": "npm run build-base",
+    "build-clean": "rimraf ./node_modules && npm run build-base",
+    "test": "npm run build-simple && jasmine",
+    "test-live": "npm i && title Dynamo FSM Testing && nodemon --exec \"npm test\"",
+    "test-build": "npm run build-clean && jasmine"
   },
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -121,5 +114,11 @@
     "ts-node": "~8.10.2",
     "tslib": "~2.0.1",
     "typescript": "~3.9.7"
+  },
+  "devDependencies": {
+    "@types/jasmine": "^4.3.4",
+    "jasmine": "^5.0.2",
+    "nodemon": "^2.0.22",
+    "rimraf": "^5.0.1"
   }
 }

package/spec/support/jasmine.json

@@ -0,0 +1,16 @@
+{
+  "spec_dir": "lib/",
+  "spec_files": [
+    "**/*.spec.ts",
+    "**/*.spec.js",
+    "**/*[sS]pec.ts"
+  ],
+  "helpers": [
+    "helpers/**/*.ts",
+    "helpers/**/*.js"
+  ],
+  "env": {
+    "stopSpecOnExpectationFailure": false,
+    "random": true
+  }
+}

package/src/_constants/index.ts

@@ -1,8 +1,8 @@
 
 // CONSTANTS
-export * from './times';
-// Module Settings
-export * from './module-settings/test-module-settings';
-export * from './module-settings/usage-module-settings';
-export * from './module-settings/custom-data-module-settings';
+export * from './times.const';
+
+// MODULE SETTINGS
+export * from './module-settings';
+
 

package/src/_constants/module-settings/{custom-data-module-settings.ts → custom-data-module-settings.const.ts}

@@ -1,5 +1,5 @@
 
-import { Dynamo_RouteSettings } from '../../_models/control-models/dynamo-route-settings';
+import { Dynamo_RouteSettings } from '../../_models/interfaces/route-settings.interface';
 
 export const customDataModuleSettings: Dynamo_RouteSettings = {
   mainRoute: '/custom',

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

@@ -0,0 +1,8 @@
+
+
+// MODULE SETTINGS
+export * from './test-module-settings.const';
+export * from './usage-module-settings.const';
+export * from './custom-data-module-settings.const';
+
+

package/src/_constants/module-settings/{test-module-settings.ts → test-module-settings.const.ts}

@@ -1,5 +1,5 @@
 
-import { Dynamo_RouteSettings } from '../../_models/control-models/dynamo-route-settings';
+import { Dynamo_RouteSettings } from '../../_models/interfaces/route-settings.interface';
 
 export const testModuleSettings: Dynamo_RouteSettings = {
   mainRoute: '/test',

package/src/_constants/module-settings/{usage-module-settings.ts → usage-module-settings.const.ts}

@@ -1,5 +1,5 @@
 
-import { Dynamo_RouteSettings } from '../../_models/control-models/dynamo-route-settings';
+import { Dynamo_RouteSettings } from '../../_models/interfaces/route-settings.interface';
 
 export const usageModuleSettings: Dynamo_RouteSettings = {
   mainRoute: '/usage',

package/src/_enums/index.ts

@@ -1,6 +1,10 @@
 
 // ENUMS
-export * from './log-style.enum';
+export * from './basic-property-type.enum';
 export * from './data-model-type.enum';
+export * from './log-style.enum';
+export * from './region.enum';
+export * from './sub-region.enum';
+export * from './subdivision-region-type.enum';
 
 

package/src/{_models/control-models/division-region-data.ts → _enums/subdivision-region-type.enum.ts}

@@ -1,8 +1,3 @@
-import { CountryISO } from './country-iso';
-
-export interface SubdivisionRegionData extends CountryISO {  
-  type?: SubdivisionRegionType;
-}
 
 
 export enum SubdivisionRegionType {

package/src/_models/control-models/daily-usage-data.control-model.ts

@@ -0,0 +1,21 @@
+
+import { Dynamo_UsageSession } from "../data-models/usage-session.data-model";
+
+export type D_DailyUsageData = Dynamo_DailyUsageData;
+export class Dynamo_DailyUsageData {
+  date?: string;
+  totalVisitTime?: number = 0;
+  averageVisitTime?: number = 0;
+  visitorsHun?: number = 0;
+  visitorsElse?: number = 0;
+
+  visitations?: Dynamo_UsageSession[] = [];
+
+  constructor(
+    set?: Dynamo_DailyUsageData
+  ) {
+    if (set) {
+      Object.assign(this, set);
+    }
+  }
+}

package/src/_models/control-models/data-params.control-model.ts

@@ -0,0 +1,27 @@
+
+import { DataModelType } from '../../_enums';
+import { Dynamo_DataPropertyParams } from './data-property-params.control-model';
+
+export type D_DataParams = Dynamo_DataParams;
+export class Dynamo_DataParams {
+  dataName: string;
+  modelType?: DataModelType;
+  dbName?: string;
+  modelParams?: Dynamo_DataPropertyParams[] = [];
+
+  /** format info */
+  logicalBreakpoints?: number[] = []; 
+
+  constructor(
+    set: Dynamo_DataParams
+  ) {
+    if (!set?.modelType || set?.modelType == DataModelType.dataModel) {
+      set.modelType = DataModelType.dataModel;
+      set.dbName = set.dataName.charAt(0).toUpperCase() + set.dataName.slice(1);
+    }
+
+    if (set) {
+      Object.assign(this, set);
+    }
+  }
+}

package/src/_models/control-models/data-property-params.control-model.ts

@@ -0,0 +1,84 @@
+import { BasicPropertyType } from '../../_enums/basic-property-type.enum';
+
+export type D_DataPropertyParams = Dynamo_DataPropertyParams;
+export type D_DPropPs = Dynamo_DataPropertyParams;
+/**
+ * This will be used for setting up db. DataServices also uses this to prehook tools, as db service and dependency db service.
+ */
+export class Dynamo_DataPropertyParams {
+  key: string;
+  type: BasicPropertyType | string;
+
+  unique?: boolean;
+  required?: boolean;
+  index?: boolean;
+
+  isDependencyHook?: boolean;
+  /**
+   * This will be used to prehook dependency db service to data service by dataName from dependency data's DynamoNTS_DataPropertyParams
+   * Use the dependency data's DynamoNTS_DataPropertyParams.
+   * 
+   * @example
+   * dependencyName: accountModelParams.dataName
+   */
+  dependencyDataName?: string;
+
+  minlength?: number;
+  maxlength?: number;
+
+  subObjectParams?: Dynamo_DataPropertyParams[] = [];
+
+  additionalValidators?: ((data: any) => void)[] = [];
+
+  constructor(
+    set: Dynamo_DataPropertyParams
+  ) {
+    if (set) {
+      if (!set.key || !set.type) {
+        console.log(
+          `DYNAMO ERROR: ` +
+          `\n key or type is missing from DynamoBEDataPropertyParams`, 
+          '\n\n', new Error()
+        );
+      }
+      if (set.isDependencyHook && !set.dependencyDataName) {
+        console.log(
+          `DYNAMO ERROR: ` +
+          `\n dependencyName missing for dependencyHook from DynamoBEDataPropertyParams (${set.key})`, 
+          '\n\n', new Error()
+        );
+      }
+      
+      Object.assign(this, set);
+    } else {
+      console.log(
+        'DYNAMO ERROR: ' +
+        '\nMISSING DynamoBEDataPropertyParams constructor input', 
+        '\n\n', new Error()
+      );
+    }
+  }
+
+  // tslint:disable-next-line: ban-types
+  getBEType?(): String | Number | Boolean | Object | Function | Array<any> | Date {
+    switch (this.type) {
+      case BasicPropertyType.string:
+        return String;
+      case BasicPropertyType.number:
+        return Number;
+      case BasicPropertyType.boolean:
+        return Boolean;
+      case BasicPropertyType.date:
+        return Date;
+      case BasicPropertyType.object:
+      default:
+        if (this.type?.includes('[]')) {
+          return Array;
+        } else if (this.type?.includes('=>') || this.type?.includes('function')) {
+          return Function;
+        } else {
+          return Object;
+        }
+    }
+  }
+}

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

@@ -1,7 +1,8 @@
 
 
+export type D_Error = Dynamo_Error;
 export class Dynamo_Error {
-  flag = 'DYNAMO ERROR OBJECT';
+  readonly flag = 'DYNAMO ERROR OBJECT';
   handled: boolean;
   status: number;
 

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

@@ -0,0 +1,11 @@
+
+// CONTROL MODELS
+export * from './daily-usage-data.control-model';
+export * from './data-params.control-model';
+export * from './data-property-params.control-model';
+export * from './error.control-model';
+export * from './poll.control-model';
+export * from './range-value.control-model';
+export * from '../interfaces/route-settings.interface';
+export * from './usage-action.control-model';
+export * from './usage-data.control-model';

package/src/_models/control-models/{dynamo-poll.ts → poll.control-model.ts}

@@ -1,6 +1,7 @@
 import { Subscription, timer } from 'rxjs';
-import { Dynamo_Error } from './dynamo-error';
+import { Dynamo_Error } from './error.control-model';
 
+export type D_Poll<T> = Dynamo_Poll<T>;
 /**
  * DynamoFSM_Poll is a predefined class is
  * for polling a specific endpoint

package/src/_models/control-models/{dynamo-range-value.ts → range-value.control-model.ts}

@@ -1,6 +1,7 @@
 
 
-
+export type D_RangeValue<T> = Dynamo_RangeValue<T>;
+export type D_RangeV<T> = Dynamo_RangeValue<T>;
 export class Dynamo_RangeValue<T> {
   from: T;
   to: T;

package/src/_models/control-models/usage-action.control-model.ts

@@ -0,0 +1,15 @@
+
+export type D_UsageAction = Dynamo_UsageAction;;
+export class Dynamo_UsageAction {
+  action?: string;
+  time?: Date;
+
+  constructor(
+    set?: Dynamo_UsageAction
+  ) {
+    if (set) {
+      Object.assign(this, set);
+    }
+  }
+}
+

package/src/_models/control-models/usage-data.control-model.ts

@@ -0,0 +1,20 @@
+
+import { Dynamo_UsageAction } from './usage-action.control-model';
+
+export type D_UsageData = Dynamo_UsageData;
+export type D_UsageD = Dynamo_UsageData;
+export class Dynamo_UsageData {
+  page?: string;
+  opened?: Date;
+  timeSpentOnPage?: number;
+  actions?: Dynamo_UsageAction[] = [];
+
+  constructor(
+    set?: Dynamo_UsageData
+  ) {
+    if (set) {
+      Object.assign(this, set)
+    }
+  }
+}
+

package/src/_models/data-models/custom-data.data-model.ts

@@ -0,0 +1,27 @@
+
+import { Dynamo_DataParams } from '../control-models/data-params.control-model';
+import { Dynamo_Metadata } from './metadata.data-model';
+
+export type D_CustomData = Dynamo_CustomData;
+export type D_CustomD = Dynamo_CustomData;
+export class Dynamo_CustomData extends Dynamo_Metadata {
+  data?: string;
+
+  constructor(
+    set?: Dynamo_CustomData
+  ) {
+    super(set);
+
+    if (set) {
+      Object.assign(this, set);
+    }
+  }
+}
+
+export const customDataModelParams = new Dynamo_DataParams({
+  dataName: 'customData',
+  modelParams: [
+    { key: 'data', type: 'string', required: true },
+  ]
+})
+

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

@@ -0,0 +1,5 @@
+
+// DATA MODELS
+export * from './custom-data.data-model';
+export * from './metadata.data-model';
+export * from './usage-session.data-model';

package/src/_models/data-models/metadata.data-model.ts

@@ -0,0 +1,25 @@
+
+
+export type D_Metadata = Dynamo_Metadata;
+export type D_MetaD = Dynamo_Metadata;
+export class Dynamo_Metadata {
+  _id?: string;
+
+  __created?: Date;
+  __createdBy?: string;
+  __lastModified?: Date;
+  __lastModifiedBy?: string;
+  __v?: number;
+
+  constructor(
+    set?: Dynamo_Metadata
+  ){
+    if (set) {
+      if (!set._id && set._id !== undefined) { 
+        delete set._id;
+      }
+
+      Object.assign(this, set);
+    }
+  }
+}

package/src/_models/data-models/usage-session.data-model.ts

@@ -0,0 +1,52 @@
+
+import { Dynamo_Metadata } from './metadata.data-model';
+import { Dynamo_UsageData } from '../control-models/usage-data.control-model';
+import { Dynamo_DataParams } from '../control-models/data-params.control-model';
+import { GeoIpLocation } from '../interfaces/location/geo-ip-location.interface';
+
+export type D_UsageSession = Dynamo_UsageSession;
+export class Dynamo_UsageSession extends Dynamo_Metadata {
+  date?: string;
+  sessionStart?: Date;
+  sessionEnd?: Date;
+  address?: string;
+  issuer?: string;
+  locationData?: GeoIpLocation;
+
+  usageData?: Dynamo_UsageData[] = [];
+  totalSessionTime?: number;
+  loggedInAs?: string;
+
+  constructor(
+    set?: Dynamo_UsageSession
+  ) {
+    super(set);
+
+    if (set) {
+      if (!set.date && set.sessionStart) {
+        set.date = set.sessionStart.toISOString().substring(0, 10);
+      }
+
+      Object.assign(this, set);
+    }
+  }
+}
+
+export const usageSessionModelParams = new Dynamo_DataParams({
+  dataName: 'usageSession',
+  modelParams: [
+    { key: 'date', type: 'string',
+      required: true, index: true
+    },
+    { key: 'sessionStart', type: 'Date',
+      required: true, index: true
+    },
+    { key: 'sessionEnd', type: 'Date' },
+    { key: 'address', type: 'string' },
+    { key: 'issuer', type: 'string' },
+    { key: 'locationData', type: 'IpApiLocation' },
+    { key: 'usageData', type: 'UsageData[]' },
+    { key: 'totalSessionTime', type: 'number' },
+    { key: 'loggedInAs', type: 'string' },
+  ]
+})

package/src/_models/index.ts

@@ -1,24 +1,12 @@
 
 // MODELS
-  // Control models
-export * from './control-models/country-iso';
-export * from './control-models/country-phone-code';
-export * from './control-models/dynamo-daily-usage-data';
-export * from './control-models/dynamo-error';
-export * from './control-models/dynamo-data-params';
-export * from './control-models/dynamo-data-property-params';
-export * from './control-models/dynamo-route-settings';
-export * from './control-models/dynamo-poll';
-export * from './control-models/dynamo-range-value';
-export * from './control-models/dynamo-usage-action';
-export * from './control-models/dynamo-usage-data';
-export * from './control-models/geo-ip-location';
-export * from './control-models/location-coordinates';
-export * from './control-models/random-weight';
-export * from './control-models/division-collection';
-export * from './control-models/division-region-data';
-  // Data models
-export * from './data-models/dynamo-custom-data';
-export * from './data-models/dynamo-metadata';
-export * from './data-models/dynamo-usage-session';
+
+// CONTROL MODELS
+export * from './control-models';
+
+// DATA MODELS
+export * from './data-models';
+
+// INTERFACES
+export * from './interfaces';
 

package/src/_models/interfaces/index.ts

@@ -0,0 +1,7 @@
+
+// INTERFACES
+export * from './random-weight.interface';
+export * from './route-settings.interface';
+
+// LOCATION INTERFACES
+export * from './location';

package/src/_models/{control-models/country-iso.ts → interfaces/location/country-iso.interface.ts}

@@ -1,6 +1,8 @@
-import { Region } from '../../_enums/region.enum';
-import { SubRegion } from '../../_enums/sub-region.enum';
-import { CountryDivision } from './country-division';
+
+
+import { Region } from '../../../_enums/region.enum';
+import { SubRegion } from '../../../_enums/sub-region.enum';
+import { CountryDivision } from './country-division.interface';
 
 export interface CountryISO {
   name: string;

package/src/_models/interfaces/location/division-region-data.interface.ts

@@ -0,0 +1,8 @@
+import { SubdivisionRegionType } from '../../../_enums/subdivision-region-type.enum';
+import { CountryISO } from './country-iso.interface';
+
+export interface SubdivisionRegionData extends CountryISO {  
+  type?: SubdivisionRegionType;
+}
+
+

package/src/_models/interfaces/location/index.ts

@@ -0,0 +1,10 @@
+
+
+// LOCATION INTERFACES
+export * from './country-division.interface';
+export * from './country-iso.interface';
+export * from './country-phone-code.interface';
+export * from './division-collection.interface';
+export * from './division-region-data.interface';
+export * from './geo-ip-location.interface';
+export * from './location-coordinates.interface';

package/src/_models/{control-models/dynamo-route-settings.ts → interfaces/route-settings.interface.ts}

@@ -1,4 +1,6 @@
 
+export type D_RouteSettings = Dynamo_RouteSettings;
+export type D_RouteS = Dynamo_RouteSettings;
 export interface Dynamo_RouteSettings {
   mainRoute: string;
 

package/src/_modules/collections.index.ts

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

package/src/_modules/constants.index.ts

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

package/src/_modules/custom-data-module.index.ts

@@ -1,6 +1,6 @@
 
 // CUSTOM-DATA MODULE
-export * from '../_models/data-models/dynamo-custom-data';
-export * from '../_constants/module-settings/custom-data-module-settings';
+export * from '../_models/data-models/custom-data.data-model';
+export * from '../_constants/module-settings/custom-data-module-settings.const';
 
 

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

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

package/src/_modules/enums.index.ts

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

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

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

package/src/_modules/models.index.ts

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

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

@@ -1,9 +1,9 @@
 
 // SHARED SERVICE MODULE
-export * from '../_collections/_tools/dynamo-shared.service';
-export * from '../_constants/times';
+export * from '../_utils/shared.static-service';
+export * from '../_constants/times.const';
 export * from '../_enums/log-style.enum';
-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';
+export * from '../_models/control-models/error.control-model';
+export * from '../_models/control-models/poll.control-model';
+export * from '../_models/interfaces/location/location-coordinates.interface';
+export * from '../_models/interfaces/location/geo-ip-location.interface';

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

@@ -1,5 +1,5 @@
 
 // TEST MODULE
-export * from '../_constants/module-settings/test-module-settings';
+export * from '../_constants/module-settings/test-module-settings.const';
 
 

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

@@ -1,9 +1,9 @@
 
 // USAGE MODULE
-export * from '../_models/data-models/dynamo-usage-session';
-export * from '../_constants/module-settings/usage-module-settings';
-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';
+export * from '../_models/data-models/usage-session.data-model';
+export * from '../_constants/module-settings/usage-module-settings.const';
+export * from '../_models/control-models/usage-data.control-model';
+export * from '../_models/control-models/daily-usage-data.control-model';
+export * from '../_models/control-models/usage-action.control-model';