@futdevpro/fsm-dynamo 1.0.11 → 1.0.13

package/nodemon.json

@@ -0,0 +1,6 @@
+{
+  "watch": ["src"],
+  "ext": ".ts,.js",
+  "ignore": [],
+  "exec": "ts-node ./src/index.ts"
+}

package/package.json

@@ -1,48 +1,45 @@
-{
-  "name": "@futdevpro/fsm-dynamo",
-  "version": "01.00.11",
-  "type": "module",
-  "main": "./public-api.js",
-  "module": "./public-api.js",
-  "types": "./public-api.d.ts",
-  "typings": "./public-api.d.ts",
-  "exports": {
-    "./data-models": {
-      "default": "./data-models.js",
-      "module": "./data-models.js",
-      "types": "./data-models.d.ts",
-      "typings": "./data-models.d.ts"
-    },
-    "./package.json": {
-      "default": "./package.json"
-    },
-    ".": {
-      "default": "./public-api.js",
-      "types": "./public-api.d.ts",
-      "esm2020": "./esm2020/futdevpro-fsm-dynamo.mjs",
-      "es2020": "./fesm2020/futdevpro-fsm-dynamo.mjs",
-      "es2015": "./fesm2015/futdevpro-fsm-dynamo.mjs",
-      "node": "./fesm2015/futdevpro-fsm-dynamo.mjs"
-    }
-  },
-  "typesVersions": {
-    "*": {
-      "data-models": [
-        "data-models.d.ts"
-      ]
-    }
-  },
-  "peerDependencies": {
-    "@angular/common": "~13.3.11",
-    "@angular/core": "~13.3.11"
-  },
-  "dependencies": {
-    "tslib": "~2.4.0",
-    "typescript": "~4.6.4"
-  },
-  "es2020": "fesm2020/futdevpro-fsm-dynamo.mjs",
-  "esm2020": "esm2020/futdevpro-fsm-dynamo.mjs",
-  "fesm2020": "fesm2020/futdevpro-fsm-dynamo.mjs",
-  "fesm2015": "fesm2015/futdevpro-fsm-dynamo.mjs",
-  "sideEffects": false
-}
+{
+  "name": "@futdevpro/fsm-dynamo",
+  "version": "01.00.13",
+  "description": "Dynamic NodeTS (NodeJS-Typescript), MongoDB Backend System Framework by Future Development Ltd.",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "npx tsc",
+    "postbuild": "npm publish"
+  },
+  "main": "./lib/index.js",
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "typings": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "typings": "./lib/index.d.ts",
+      "module": "./lib/index.js",
+      "default": "./lib/index.js"
+    },
+    "./data-model": {
+      "types": "./lib/data-model.index.d.ts",
+      "typings": "./lib/data-model.index.d.ts",
+      "module": "./lib/data-model.index.js",
+      "default": "./lib/data-model.index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "data-model": [
+        "lib/data-model.d.ts"
+      ]
+    }
+  },
+  "keywords": [],
+  "author": "Future Development Program Ltd.",
+  "license": "ISC",
+  "homepage": "https:/futdevpro.hu/projects/dynamo",
+  "dependencies": {
+    "@types/node": "~14.0.27",
+    "ts-node": "~8.10.2",
+    "tslib": "~2.0.1",
+    "typescript": "~3.9.7"
+  }
+}

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

@@ -0,0 +1,15 @@
+
+import { DynamoModuleSettings } from '../../_models/control-models/dynamo-module-settings';
+
+export const testModuleSettings: DynamoModuleSettings = {
+  mainRoute: '/test',
+  endPoints: {
+    testGet: '/test-get',
+    testPost: '/test-post',
+    testPut: '/test-put',
+    testPatch: '/test-patch',
+    testDelete: '/test-delete',
+    getCustomData: '/custom/get/:customId',
+    modifyCustomData: '/custom/post'
+  }
+};

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

@@ -0,0 +1,12 @@
+
+import { DynamoModuleSettings } from '../../_models/control-models/dynamo-module-settings';
+
+export const usageModuleSettings: DynamoModuleSettings = {
+  mainRoute: '/usage',
+  endPoints: {
+    newSession: '/new-session',
+    closeSession: '/close-session/:sessionId',
+    updateUsage:  '/update/:sessionId',
+    getAllUsageData: '/get/all',
+  }
+};

package/src/_constants/times.ts

@@ -0,0 +1,8 @@
+
+export const second = 1000;
+export const minute = second * 60;
+export const hour = minute * 60;
+export const day = hour * 24;
+export const week = day * 7;
+export const month = day * 30.4368499;
+export const year = day * 365.242199;

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

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

package/src/_models/control-models/dynamo-module-settings.ts

@@ -0,0 +1,8 @@
+
+export interface DynamoModuleSettings {
+  mainRoute: string;
+
+  endPoints: {
+    [endpoint: string]: string
+  };
+}

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

@@ -0,0 +1,19 @@
+
+import { DynamoBEDataPropertyParams } from './dynamobe-data-property-params';
+
+export class DynamoBEDataParams {
+  dataName: string;
+  dbName: string;
+  modelParams: DynamoBEDataPropertyParams[];
+
+  constructor(
+    set: {
+      dataName: string,
+      modelParams: DynamoBEDataPropertyParams[],
+    }
+  ) {
+    this.dataName = set.dataName;
+    this.dbName = set.dataName.charAt(0).toUpperCase() + set.dataName.slice(1);
+    this.modelParams = set.modelParams ? set.modelParams : [];
+  }
+}

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

@@ -0,0 +1,97 @@
+
+import { DynamoBEError } from './dynamobe-error';
+
+export class DynamoBEDataPropertyParams {
+  key?: string;
+  type?: 'string' | 'number' | 'boolean' | 'Date' | 'object' | string;
+
+  unique?: boolean;
+  required?: boolean;
+  index?: boolean;
+
+  isDependencyHook?: boolean;
+  dependencyName?: string;
+
+  minlength?: number;
+  maxlength?: number;
+
+  subObjectParams?: DynamoBEDataPropertyParams[] = [];
+
+  additionalValidators?: ((data: any) => void)[];
+
+  constructor(
+    set: {
+      key: string,
+      type: 'string' | 'number' | 'boolean' | 'Date' | 'object' | string,
+
+      unique?: boolean,
+      required?: boolean,
+      index?: boolean,
+
+      isDependencyHook?: boolean,
+      dependencyDBServiceName?: string,
+
+      minlength?: number,
+      maxlength?: number,
+
+      subObjectParams?: DynamoBEDataPropertyParams[],
+
+      additionalValidators?: ((data: any) => void)[],
+    }
+  ) {
+    if (set) {
+      this.key = set.key;
+      this.type = set.type;
+
+      if (this.getBEType) {
+        if (set?.subObjectParams) {
+          this.subObjectParams = set.subObjectParams;
+        } else {
+          console.log('DYNAMO ERROR: \n subObjectParams missing', '\n\n', new Error());
+          throw new DynamoBEError({ message: 'subObjectParams missing' });
+        }
+      }
+
+      if (set.isDependencyHook) {
+        if (set.dependencyDBServiceName) {
+          this.isDependencyHook = set.isDependencyHook;
+          this.dependencyName = set.dependencyDBServiceName;
+        } else {
+          this.isDependencyHook = set.isDependencyHook;
+          console.log('DYNAMO ERROR: \n dependencyDBServiceName missing for dependencyHook', '\n\n', new Error());
+        }
+      }
+      this.unique = set.unique;
+      this.required = set.required;
+      this.index = set.index;
+      this.minlength = set.minlength;
+      this.maxlength = set.maxlength;
+      this.additionalValidators = set.additionalValidators;
+    } 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 'string':
+        return String;
+      case 'number':
+        return Number;
+      case 'boolean':
+        return Boolean;
+      case 'Date':
+        return Date;
+      case '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/dynamobe-error.ts

@@ -0,0 +1,200 @@
+
+
+export class DynamoBEError {
+  flag = 'DYNAMO-BE ERROR OBJECT';
+  handled: boolean;
+  status: number;
+  errors: any[] = [];
+  error: any;
+  messages: string[] = [];
+  userMessages: string[] = [];
+
+  constructor(
+    set: {
+      handled?: boolean;
+      status?: number,
+      message?: string,
+      messages?: string[],
+      userMessage?: string,
+      error?: any,
+      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.error) {
+      if (set.error instanceof DynamoBEError) {
+        this.errors.push(set.error.error);
+      } else {
+        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.message) {
+      this.messages.push(set.message)
+    }
+    if (set.messages) {
+      this.messages.push(...set.messages)
+    }
+    if (set.userMessage) {
+      this.userMessages.push(set.userMessage)
+    }
+    if (set.consoleLog) {
+      console.log(this);
+    }
+  }
+}
+
+/*
+
+//                  //
+// RESPONSE STATUS  //
+//                  //
+
+1XX informational response
+
+  100 Continue
+  101 Switching Protocols
+  102 Processing
+  103 Early Hints
+
+
+2XX success
+
+  200 OK
+  201 Created
+  202 Accepted
+  203 Non-Authoritative Information
+  204 No Content
+  205 Reset Content
+  206 Partial Content 
+  207 Multi-Status
+  208 Already Reported
+  226 IM Used
+
+  
+3XX redirection
+
+  300 Multiple Choices
+  301 Moved Permanently
+  302 Found
+  303 See Other
+  304 Not Modified
+  305 Use Proxy
+  306 Switch Proxy
+  307 Temporary Redirect
+  308 Permanent Redirect
+
+
+4XX client errors
+
+  400 Bad Request
+  401 Unauthorized
+  402 Payment Required
+  403 Forbidden
+  404 Not Found
+  405 Method Not Allowed
+  406 Not Acceptable
+  407 Proxy Authentication Required
+  408 Request Timeout
+  409 Conflict
+  410 Gone
+  411 Length Required
+  412 Precondition Failed
+  413 Payload Too Large 
+  414 URI Too Long
+  415 Unsupported Media Type
+  416 Range Not Satisfiable
+  417 Expectation Failed
+  418 I'm a teapot
+  421 Misdirected Request
+  422 Unprocessable Entity
+  423 Locked
+  424 Failed Dependency
+  425 Too Early
+  426 Upgrade Required
+  428 Precondition Required
+  429 Too Many Requests
+  431 Request Header Fields Too Large
+  451 Unavailable For Legal Reasons
+
+
+5XX server errors
+
+  500 Internal Server Error
+  501 Not Implemented
+  502 Bad Gateway
+  503 Service Unavailable
+  504 Gateway Timeout
+  505 HTTP Version Not Supported
+  506 Variant Also Negotiates
+  507 Insufficient Storage
+  508 Loop Detected 
+  510 Not Extended
+  511 Network Authentication Required
+
+
+Unofficial codes
+
+  103 Checkpoint
+  218 This is fine (Apache Web Server)
+  419 Page Expired (Laravel Framework)
+  420 Enhance Your Calm (Twitter)
+  430 Request Header Fields Too Large (Shopify)
+  450 Blocked by Windows Parental Controls (Microsoft)
+  498 Invalid Token (Esri)
+  499 Token Required (Esri)
+  509 Bandwidth Limit Exceeded (Apache Web Server/cPanel)
+  526 Invalid SSL Certificate
+  529 Site is overloaded
+  530 Site is frozen
+  598 (Informal convention) Network read timeout error
+
+  440 Login Time-out
+  449 Retry With
+  451 Redirect
+
+  444 No Response
+  494 Request header too large
+  495 SSL Certificate Error
+  496 SSL Certificate Required
+  497 HTTP Request Sent to HTTPS Port
+  499 Client Closed Request
+
+  520 Web Server Returned an Unknown Error
+  521 Web Server Is Down
+  522 Connection Timed Out
+  523 Origin Is Unreachable
+  524 A Timeout Occurred
+  525 SSL Handshake Failed
+  526 Invalid SSL Certificate
+  527 Railgun Error
+
+  530
+
+  460
+  463
+
+*/

package/src/_models/control-models/geo-ip-location.ts

@@ -0,0 +1,26 @@
+
+export interface GeoIpLocation {
+  /** [ <low bound of IP block>, <high bound of IP block> ] */
+  range: [number, number];
+  /** 2 letter ISO-3166-1 country code https://www.iban.com/country-codes */
+  country: string;
+  /**
+   * Up to 3 alphanumeric variable length characters as ISO 3166-2 code
+   * For US states this is the 2 letter state
+   * For the United Kingdom this could be ENG as a country like “England
+   * FIPS 10-4 subcountry code
+   */
+  region: string;
+  /** 1 if the country is a member state of the European Union, 0 otherwise. */
+  eu: '1' | '0';
+  /** "Country/Zone" Timezone from IANA Time Zone Database */
+  timezone: string;
+  /** This is the full city name */
+  city: string;
+  /** The latitude and longitude of the city */
+  ll: [number, number];
+  /** Metro code */
+  metro: number;
+  /** The approximate accuracy radius (km), around the latitude and longitude */
+  area: number;
+}

package/src/_models/control-models/location-coordinates.ts

@@ -0,0 +1,5 @@
+
+export interface LocationCoordinates {
+  longitude: number;
+  latitude: number;
+}

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

@@ -0,0 +1,18 @@
+
+export class DynamoUsageAction {
+  action?: string;
+  time?: Date;
+
+  constructor(
+    set?: {
+      action?: string,
+      time?: Date,
+    }
+  ) {
+    if (set) {
+      this.action = set.action;
+      this.time = set.time;
+    }
+  }
+}
+

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

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

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

@@ -0,0 +1,41 @@
+
+import { DynamoBEDataParams } from '../control-models/dynamobe-data-params';
+import { Metadata } from './metadata';
+
+export class CustomData extends Metadata {
+  data?: string;
+
+  constructor(
+    set?: {
+      _id?: string,
+
+      data?: string,
+      
+      __v?: number,
+      __created?: Date,
+      __createdBy?: string,
+      __lastModified?: Date,
+      __lastModifiedBy?: string,
+    }
+  ) {
+    super({
+      _id: set?._id,
+      __v: set?.__v,
+      __created: set?.__created,
+      __createdBy: set?.__createdBy,
+      __lastModified: set?.__lastModified,
+      __lastModifiedBy: set?.__lastModifiedBy,
+    })
+    if (set) {
+      this.data = set.data;
+    }
+  }
+}
+
+export const customDataModelParams = new DynamoBEDataParams({
+  dataName: 'customData',
+  modelParams: [
+    { key: 'data', type: 'string', required: true },
+  ]
+})
+

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

@@ -0,0 +1,30 @@
+
+
+export class Metadata {
+  _id?: string;
+  __created?: Date;
+  __createdBy?: string;
+  __lastModified?: Date;
+  __lastModifiedBy?: string;
+  __v?: number;
+
+  constructor(
+    set?: {
+      _id?: string,
+      __created?: Date,
+      __createdBy?: string,
+      __lastModified?: Date,
+      __lastModifiedBy?: string,
+      __v?: number;
+    } | Metadata
+  ){
+    if (set) {
+      this._id = set._id;
+      this.__created = set.__created;
+      this.__createdBy = set.__createdBy;
+      this.__lastModified = set.__lastModified;
+      this.__lastModifiedBy = set.__lastModifiedBy;
+      this.__v = set.__v;
+    }
+  }
+}