@futdevpro/fsm-dynamo 1.5.38 → 1.5.43

package/src/_collections/_constants/country-subdivisions/viet-nam.json

@@ -0,0 +1,258 @@
+[
+	{
+		"name": "An Giang",
+		"code": "VN-44"
+	},
+	{
+		"name": "Bà Rịa–Vũng Tàu",
+		"code": "VN-43"
+	},
+	{
+		"name": "Bình Dương",
+		"code": "VN-57"
+	},
+	{
+		"name": "Bình Phước",
+		"code": "VN-58"
+	},
+	{
+		"name": "Bình Thuận",
+		"code": "VN-40"
+	},
+	{
+		"name": "Bình Định",
+		"code": "VN-31"
+	},
+	{
+		"name": "Bạc Liêu",
+		"code": "VN-55"
+	},
+	{
+		"name": "Bắc Giang",
+		"code": "VN-54"
+	},
+	{
+		"name": "Bắc Kạn",
+		"code": "VN-53"
+	},
+	{
+		"name": "Bắc Ninh",
+		"code": "VN-56"
+	},
+	{
+		"name": "Bến Tre",
+		"code": "VN-50"
+	},
+	{
+		"name": "Cao Bằng",
+		"code": "VN-04"
+	},
+	{
+		"name": "Cà Mau",
+		"code": "VN-59"
+	},
+	{
+		"name": "Cần Thơ",
+		"code": "VN-CT"
+	},
+	{
+		"name": "Gia Lai",
+		"code": "VN-30"
+	},
+	{
+		"name": "Hà Giang",
+		"code": "VN-03"
+	},
+	{
+		"name": "Hà Nam",
+		"code": "VN-63"
+	},
+	{
+		"name": "Hà Nội",
+		"code": "VN-HN"
+	},
+	{
+		"name": "Hà Tây",
+		"code": "VN-15"
+	},
+	{
+		"name": "Hà Tĩnh",
+		"code": "VN-23"
+	},
+	{
+		"name": "Hòa Bình",
+		"code": "VN-14"
+	},
+	{
+		"name": "Hưng Yên",
+		"code": "VN-66"
+	},
+	{
+		"name": "Hải Dương",
+		"code": "VN-61"
+	},
+	{
+		"name": "Hải Phòng",
+		"code": "VN-HP"
+	},
+	{
+		"name": "Hậu Giang",
+		"code": "VN-73"
+	},
+	{
+		"name": "Hồ Chí Minh",
+		"code": "VN-SG"
+	},
+	{
+		"name": "Khánh Hòa",
+		"code": "VN-34"
+	},
+	{
+		"name": "Kiên Giang",
+		"code": "VN-47"
+	},
+	{
+		"name": "Kon Tum",
+		"code": "VN-28"
+	},
+	{
+		"name": "Lai Châu",
+		"code": "VN-01"
+	},
+	{
+		"name": "Long An",
+		"code": "VN-41"
+	},
+	{
+		"name": "Lào Cai",
+		"code": "VN-02"
+	},
+	{
+		"name": "Lâm Đồng",
+		"code": "VN-35"
+	},
+	{
+		"name": "Lạng Sơn",
+		"code": "VN-09"
+	},
+	{
+		"name": "Nam Định",
+		"code": "VN-67"
+	},
+	{
+		"name": "Nghệ An",
+		"code": "VN-22"
+	},
+	{
+		"name": "Ninh Bình",
+		"code": "VN-18"
+	},
+	{
+		"name": "Ninh Thuận",
+		"code": "VN-36"
+	},
+	{
+		"name": "Phú Thọ",
+		"code": "VN-68"
+	},
+	{
+		"name": "Phú Yên",
+		"code": "VN-32"
+	},
+	{
+		"name": "Quảng Bình",
+		"code": "VN-24"
+	},
+	{
+		"name": "Quảng Nam",
+		"code": "VN-27"
+	},
+	{
+		"name": "Quảng Ngãi",
+		"code": "VN-29"
+	},
+	{
+		"name": "Quảng Ninh",
+		"code": "VN-13"
+	},
+	{
+		"name": "Quảng Trị",
+		"code": "VN-25"
+	},
+	{
+		"name": "Sóc Trăng",
+		"code": "VN-52"
+	},
+	{
+		"name": "Sơn La",
+		"code": "VN-05"
+	},
+	{
+		"name": "Thanh Hóa",
+		"code": "VN-21"
+	},
+	{
+		"name": "Thái Bình",
+		"code": "VN-20"
+	},
+	{
+		"name": "Thái Nguyên",
+		"code": "VN-69"
+	},
+	{
+		"name": "Thừa Thiên–Huế",
+		"code": "VN-26"
+	},
+	{
+		"name": "Tiền Giang",
+		"code": "VN-46"
+	},
+	{
+		"name": "Trà Vinh",
+		"code": "VN-51"
+	},
+	{
+		"name": "Tuyên Quang",
+		"code": "VN-07"
+	},
+	{
+		"name": "Tây Ninh",
+		"code": "VN-37"
+	},
+	{
+		"name": "Vĩnh Long",
+		"code": "VN-49"
+	},
+	{
+		"name": "Vĩnh Phúc",
+		"code": "VN-70"
+	},
+	{
+		"name": "Yên Bái",
+		"code": "VN-06"
+	},
+	{
+		"name": "Điện Biên",
+		"code": "VN-71"
+	},
+	{
+		"name": "Đà Nẵng",
+		"code": "VN-DN"
+	},
+	{
+		"name": "Đắk Lắk",
+		"code": "VN-33"
+	},
+	{
+		"name": "Đắk Nông",
+		"code": "VN-72"
+	},
+	{
+		"name": "Đồng Nai",
+		"code": "VN-39"
+	},
+	{
+		"name": "Đồng Tháp",
+		"code": "VN-45"
+	}
+]

package/src/_collections/_constants/country-subdivisions/yemen.json

@@ -0,0 +1,86 @@
+[
+	{
+		"name": "'Adan",
+		"code": "YE-AD"
+	},
+	{
+		"name": "'Amrān",
+		"code": "YE-AM"
+	},
+	{
+		"name": "Abyān",
+		"code": "YE-AB"
+	},
+	{
+		"name": "Al Bayḑā'",
+		"code": "YE-BA"
+	},
+	{
+		"name": "Al Jawf",
+		"code": "YE-JA"
+	},
+	{
+		"name": "Al Mahrah",
+		"code": "YE-MR"
+	},
+	{
+		"name": "Al Maḩwīt",
+		"code": "YE-MW"
+	},
+	{
+		"name": "Al Ḩudaydah",
+		"code": "YE-HU"
+	},
+	{
+		"name": "Aḑ Ḑāli'",
+		"code": "YE-DA"
+	},
+	{
+		"name": "Dhamār",
+		"code": "YE-DH"
+	},
+	{
+		"name": "Ibb",
+		"code": "YE-IB"
+	},
+	{
+		"name": "Laḩij",
+		"code": "YE-LA"
+	},
+	{
+		"name": "Ma'rib",
+		"code": "YE-MA"
+	},
+	{
+		"name": "Raymah",
+		"code": "YE-RA"
+	},
+	{
+		"name": "Shabwah",
+		"code": "YE-SH"
+	},
+	{
+		"name": "Tā‘izz",
+		"code": "YE-TA"
+	},
+	{
+		"name": "Şan‘ā'",
+		"code": "YE-SA"
+	},
+	{
+		"name": "Şan‘ā'",
+		"code": "YE-SN"
+	},
+	{
+		"name": "Şā‘dah",
+		"code": "YE-SD"
+	},
+	{
+		"name": "Ḩajjah",
+		"code": "YE-HJ"
+	},
+	{
+		"name": "Ḩaḑramawt",
+		"code": "YE-HD"
+	}
+]

package/src/_collections/_constants/country-subdivisions/zambia.json

@@ -0,0 +1,38 @@
+[
+	{
+		"name": "Central",
+		"code": "ZM-02"
+	},
+	{
+		"name": "Copperbelt",
+		"code": "ZM-08"
+	},
+	{
+		"name": "Eastern",
+		"code": "ZM-03"
+	},
+	{
+		"name": "Luapula",
+		"code": "ZM-04"
+	},
+	{
+		"name": "Lusaka",
+		"code": "ZM-09"
+	},
+	{
+		"name": "North-Western",
+		"code": "ZM-06"
+	},
+	{
+		"name": "Northern",
+		"code": "ZM-05"
+	},
+	{
+		"name": "Southern",
+		"code": "ZM-07"
+	},
+	{
+		"name": "Western",
+		"code": "ZM-01"
+	}
+]

package/src/_collections/_constants/country-subdivisions/zimbabwe.json

@@ -0,0 +1,42 @@
+[
+	{
+		"name": "Bulawayo",
+		"code": "ZW-BU"
+	},
+	{
+		"name": "Harare",
+		"code": "ZW-HA"
+	},
+	{
+		"name": "Manicaland",
+		"code": "ZW-MA"
+	},
+	{
+		"name": "Mashonaland Central",
+		"code": "ZW-MC"
+	},
+	{
+		"name": "Mashonaland East",
+		"code": "ZW-ME"
+	},
+	{
+		"name": "Mashonaland West",
+		"code": "ZW-MW"
+	},
+	{
+		"name": "Masvingo",
+		"code": "ZW-MV"
+	},
+	{
+		"name": "Matabeleland North",
+		"code": "ZW-MN"
+	},
+	{
+		"name": "Matabeleland South",
+		"code": "ZW-MS"
+	},
+	{
+		"name": "Midlands",
+		"code": "ZW-MI"
+	}
+]

package/src/_collections/_tools/dynamo-location.ts

@@ -0,0 +1,46 @@
+
+import { Dynamo_Error } from '../../_models/control-models/dynamo-error';
+import { LocationCoordinates } from '../../_models/control-models/location-coordinates';
+import { Dynamo_Trigonometry } from './dynamo-trigonometry';
+
+export class Dynamo_Location {
+  
+  static getDistanceInKilometres(
+    from: LocationCoordinates,
+    to: LocationCoordinates
+  ): number {
+
+    const R = 6371; // kilometres
+    const φ1 = Dynamo_Trigonometry.angleToRadians(from.latitude);
+    const φ2 = Dynamo_Trigonometry.angleToRadians(to.latitude);
+    const Δφ = Dynamo_Trigonometry.angleToRadians(to.latitude - from.latitude);
+    const Δλ = Dynamo_Trigonometry.angleToRadians(to.longitude - from.longitude);
+
+    const a = Math.sin(Δφ / 2) * Math.sin(Δφ / 2) +
+              Math.cos(φ1) * Math.cos(φ2) *
+              Math.sin(Δλ / 2) * Math.sin(Δλ / 2);
+    const c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a));
+
+    return R * c;
+  }
+
+  static getLocationDegByKilometers(latiOrLong: 'latitude' | 'longitude', distanceInKm: number, latitude?: number): number {
+    if (latiOrLong === 'latitude') {
+      return distanceInKm / 110.574;
+    } else {
+      if (latitude) {
+        return distanceInKm / (Math.cos(Dynamo_Trigonometry.angleToRadians(latitude)) * 111.320);
+      } else {
+        throw new Dynamo_Error({ 
+          status: 417, 
+          errorCode: 'FSM-DSS-505',
+          addECToUserMsg: true,
+          message: `When using getLocationDegByKilometers for longitude, you need to give latitude! (latiOrLong: ${latiOrLong}, distanceInKm: ${distanceInKm}, latitude: ${latitude})`,
+          userMessage: `We encountered an uncought BackEnd Error, please contact the responsible development team.`
+        });
+      }
+    }
+  }
+}
+
+

package/src/_collections/_tools/dynamo-log.ts

@@ -0,0 +1,60 @@
+
+import { LogStyle } from '../../_enums/log-style.enum';
+
+export class Dynamo_Log {
+
+  static setLogStyle(styles: LogStyle[]): void {
+    let styleSets = '';
+    styles.forEach((style: LogStyle) => {
+      styleSets += style;
+    });
+    console.log(styleSets);
+  }
+  static resetLogStyle(): void {
+    console.log(LogStyle.reset);
+  }
+
+  static logStyle(input: string, styles: LogStyle[], dontReset?: boolean): string {
+    let result = '';
+    styles.forEach((style: LogStyle) => {
+      result += style;
+    });
+    result += input;
+    if (!dontReset) {
+      result += LogStyle.reset;
+    }
+    return result;
+  }
+
+  static logSuccess(message: string, ...optionalParams: any[]): void {
+    if (0 < optionalParams.length) {
+      console.error(`${LogStyle.green}${LogStyle.bright}${message}`, ...optionalParams, LogStyle.reset);
+    } else {
+      console.error(`${LogStyle.green}${LogStyle.bright}${message}${LogStyle.reset}`);
+    }
+  }
+
+  static logError(message: string, ...optionalParams: any[]): void {
+    if (0 < optionalParams.length) {
+      console.error(`${LogStyle.red}${LogStyle.bright}${message}`, ...optionalParams, LogStyle.reset);
+    } else {
+      console.error(`${LogStyle.red}${LogStyle.bright}${message}${LogStyle.reset}`);
+    }
+  }
+
+  static logWarning(message: string, ...optionalParams: any[]): void {
+    if (0 < optionalParams.length) {
+      console.warn(`${LogStyle.yellow}${LogStyle.bright}${message}`, ...optionalParams, LogStyle.reset);
+    } else {
+      console.warn(`${LogStyle.yellow}${LogStyle.bright}${message}${LogStyle.reset}`);
+    }
+  }
+
+  static removeLogStyles(message: string): string {
+    for (let styleKey of Object(LogStyle)) {
+      message = message.replace(new RegExp(LogStyle[styleKey], 'g'), '');
+    }
+    return message;
+  }
+}
+

package/src/_collections/_tools/dynamo-random.ts

@@ -0,0 +1,64 @@
+
+import { RandomWeight } from '../../_models/control-models/random-weight';
+
+export class Dynamo_Random {
+  static getRandomWeightedInt(min: number, max: number, weights: RandomWeight<number>[]): number {
+    weights = weights.sort((a, b) => b.chance - a.chance);
+    let weightChanceSum = 0;
+    weights.forEach(weight => weightChanceSum += weight.chance);
+    if (1 < weightChanceSum) {
+      weights.forEach(weights => weights.chance = weights.chance / weightChanceSum);
+    }
+  
+    const randomChance: number = Math.random();
+    let result: number;
+    let chancer = 0;
+    for (let i = 0; i < weights.length && result === undefined; i++) {
+      chancer += weights[i].chance;
+      if (randomChance < chancer) {
+        result = weights[i].result;
+      }
+    }
+  
+    if (result !== undefined) {
+      return result;
+    } else {
+      return this.getRandomInt(min, max);
+    }
+  }
+  
+  static getRandomInt(min: number, max: number): number {
+    return min + Math.round((max - min) * Math.random());
+  }
+  
+  static getRandomListElement<T>(list: T[]): T {
+    if (0 < list.length) {
+      return list[this.getRandomInt(0, list.length - 1)];
+    } else {
+      return null;
+    }
+  }
+  
+  static getRandomWeighted<T>(weights: RandomWeight<T>[]): T {
+    if (!weights?.length) {
+      return null;
+    }
+  
+    weights = weights.sort((a, b) => b.chance - a.chance);
+    let weightChanceSum = 0;
+    weights.forEach(weight => weightChanceSum += weight.chance);
+    weights.forEach(weights => weights.chance = weights.chance / weightChanceSum);
+  
+    const randomChance: number = Math.random();
+    let result: T;
+    let chancer = 0;
+    for (let i = 0; i < weights.length && result === undefined; i++) {
+      chancer += weights[i].chance;
+      if (randomChance < chancer) {
+        result = weights[i].result;
+      }
+    }
+  
+    return result
+  }
+}

package/src/_collections/_tools/dynamo-regions.ts

@@ -0,0 +1,60 @@
+
+import * as ISOs from '../_constants/country-codes-ISO-3166.json';
+import * as PhoneCodes from '../_constants/country-phone-codes.json';
+import * as Subdivisions from '../_constants/country-sub-divisions-ISO-3166.json';
+import { Region } from '../../_enums/region.enum';
+import { Dynamo_Error } from '../../_models';
+import { CountryPhoneCode } from '../../_models/control-models/country-phone-code';
+import { JSONListify } from './utilities';
+import { CountryISO } from '../../_models/control-models/country-iso';
+import { SubdivisionCollection } from '../../_models/control-models/subdivision-collection';
+
+export class Dynamo_Regions {
+
+  static ISOs: CountryISO[] = Dynamo_Regions.getAllCountryISO();
+  static phoneCodes: CountryPhoneCode[] = Dynamo_Regions.getAllPhoneCodes();
+  static subdivisions: SubdivisionCollection = Dynamo_Regions.getSubdivisionCollection();
+
+  private static getAllCountryISO(): CountryISO[] {
+    return JSONListify(ISOs);
+  }
+  private static getAllPhoneCodes(): CountryPhoneCode[] {
+    return JSONListify(PhoneCodes);
+  }
+  private static getSubdivisionCollection(): SubdivisionCollection {
+    return Subdivisions as SubdivisionCollection;
+  }
+
+  static iso1ToCountryIso(iso1: string): CountryISO {
+    const country: CountryISO = this.ISOs.find(iso => iso.iso2 == iso1);
+    if (!country) {
+      throw new Dynamo_Error({ 
+        message: `Cannot find ISO-3166 code for this: ${iso1}` 
+      });
+    } else {
+      return country;
+    }
+  }
+
+  static iso1ToRegion(iso1: string): Region {
+    const region: Region = this.ISOs.find(iso => iso.iso2 == iso1).region;
+    if (!region) {
+      throw new Dynamo_Error({ 
+        message: `Cannot find ISO-3166 code for this: ${iso1}` 
+      });
+    } else {
+      return region;
+    }
+  }
+
+  static iso1ToPhoneCode(iso1: string): CountryPhoneCode {
+    const phoneCode: CountryPhoneCode = this.phoneCodes.find(code => code.iso == iso1);
+    if (!phoneCode) {
+      throw new Dynamo_Error({ 
+        message: `Cannot find ISO-3166 code for this: ${iso1}` 
+      });
+    } else {
+      return phoneCode;
+    }
+  }
+}

package/src/_collections/_tools/dynamo-round-list.ts

@@ -0,0 +1,42 @@
+
+
+export class Dynamo_RoundList {  
+  static getOutboundedIndex(listLength: number, outboundIndex: number): number {
+    if (!(0 < listLength)) {
+      throw new Error('roundListPlusIndex failed. list is empty!');
+    }
+  
+    if (outboundIndex < 0) {
+      outboundIndex = outboundIndex % listLength;
+      outboundIndex = listLength + outboundIndex;
+    }
+    if (listLength <= outboundIndex) {
+      outboundIndex = outboundIndex % listLength;
+    }
+  
+    return outboundIndex;
+  }
+  
+  static getIndexOpposite(length: number, oppositeOf: number): number {
+    const plusIndex = oppositeOf + Math.round(length / 2);
+    const res = this.getOutboundedIndex(length, plusIndex);
+  
+    return res;
+  }
+  
+  static getListIndex<T>(list: T[], outboundIndex: number): T {
+    return list[this.getOutboundedIndex(list.length, outboundIndex)];
+  }
+  
+  static getListOpposite<T>(list: T[], oppositeOf: T): T {
+    return list[this.getIndexOpposite(list.length, list.indexOf(oppositeOf))];
+  }
+  
+  static getLast<T>(list: T[]): T {
+    if (0 < list.length) {
+      return list[list.length - 1];
+    } else {
+      return null;
+    }
+  }
+}