@futdevpro/fsm-dynamo 1.15.17 → 1.15.20

package/src/_modules/location/_collections/assets/country-subdivisions/zambia.json

@@ -1,38 +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"
-	}
+[
+	{
+		"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/_modules/location/_collections/assets/country-subdivisions/zimbabwe.json

@@ -1,42 +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"
-	}
+[
+	{
+		"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/_modules/location/_collections/loc-country-divisions.const.ts

@@ -1,11 +1,11 @@
-
-
-
-
-import { DyFM_CountryDivision } from '../_models/loc-country-division.interface';
-import { DyFM_Regions } from './loc-regions.util';
-
-/** List of country subdivisions indexed by ISO-3166 codes. */
-export const DyFM_countryDivisions: DyFM_CountryDivision[] =
-  DyFM_Regions?.divisions ?? [];
+
+
+
+
+import { DyFM_CountryDivision } from '../_models/loc-country-division.interface';
+import { DyFM_Regions } from './loc-regions.util';
+
+/** List of country subdivisions indexed by ISO-3166 codes. */
+export const DyFM_countryDivisions: DyFM_CountryDivision[] =
+  DyFM_Regions?.divisions ?? [];
   

package/src/_modules/location/_collections/loc-country-isos.const.ts

@@ -1,8 +1,8 @@
-
-
-
-import { DyFM_CountryISO } from '../_models/loc-country-iso.interface';
-import { DyFM_Regions } from './loc-regions.util';
-
-export const DyFM_countryISOs: DyFM_CountryISO[] = DyFM_Regions?.countryISOs ?? [];
-
+
+
+
+import { DyFM_CountryISO } from '../_models/loc-country-iso.interface';
+import { DyFM_Regions } from './loc-regions.util';
+
+export const DyFM_countryISOs: DyFM_CountryISO[] = DyFM_Regions?.countryISOs ?? [];
+

package/src/_modules/location/_collections/loc-regions.util.spec.ts

@@ -1,61 +1,61 @@
-
-import { DyFM_Region } from '../_enums/loc-region.enum';
-import { DyFM_CountryDivision } from '../_models/loc-country-division.interface';
-import { DyFM_CountryISO } from '../_models/loc-country-iso.interface';
-import { DyFM_CountryPhoneCode } from '../_models/loc-country-phone-code.interface';
-import { DyFM_Regions } from './loc-regions.util';
-
-describe('| DyFM_Regions', () => {
-  it('| should get all country ISOs', () => {
-    const countryISOs: DyFM_CountryISO[] = DyFM_Regions.countryISOs;
-    expect(countryISOs).toBeDefined();
-    expect(countryISOs.length).toBeGreaterThan(0);
-  });
-
-  it('| should get all phone codes', () => {
-    const phoneCodes: DyFM_CountryPhoneCode[] = DyFM_Regions.phoneCodes;
-    expect(phoneCodes).toBeDefined();
-    expect(phoneCodes.length).toBeGreaterThan(0);
-  });
-
-  it('| should get all divisions', () => {
-    const divisions: DyFM_CountryDivision[] = DyFM_Regions.divisions;
-    expect(divisions).toBeDefined();
-    expect(divisions.length).toBeGreaterThan(0);
-  });
-
-  it('| should convert ISO to country ISO', () => {
-    const iso2 = 'US';
-    const countryISO: DyFM_CountryISO = DyFM_Regions.isoToCountryIso(iso2);
-    expect(countryISO).toBeDefined();
-    expect(countryISO.iso2).toBe(iso2);
-  });
-
-  /* it('| should throw error if ISO not found in isoToCountryIso', () => {
-    const iso2 = 'XX';
-    expect(() => DyFM_Regions.isoToCountryIso(iso2)).toThrowError(DyFM_Error);
-  });
- */
-  it('| should convert ISO to region', () => {
-    const iso2 = 'US';
-    const region: DyFM_Region = DyFM_Regions.isoToRegion(iso2);
-    expect(region).toBeDefined();
-  });
-
-  /* it('| should throw error if ISO not found in isoToRegion', () => {
-    const iso2 = 'XX';
-    expect(() => DyFM_Regions.isoToRegion(iso2)).toThrowError(DyFM_Error);
-  }); */
-
-  it('| should convert ISO to phone code', () => {
-    const iso2 = 'US';
-    const phoneCode: DyFM_CountryPhoneCode = DyFM_Regions.isoToPhoneCode(iso2);
-    expect(phoneCode).toBeDefined();
-    expect(phoneCode.iso).toBe(iso2);
-  });
-
-  /* it('| should throw error if ISO not found in isoToPhoneCode', () => {
-    const iso2 = 'XX';
-    expect(() => DyFM_Regions.isoToPhoneCode(iso2)).toThrowError(DyFM_Error);
-  }); */
-});
+
+import { DyFM_Region } from '../_enums/loc-region.enum';
+import { DyFM_CountryDivision } from '../_models/loc-country-division.interface';
+import { DyFM_CountryISO } from '../_models/loc-country-iso.interface';
+import { DyFM_CountryPhoneCode } from '../_models/loc-country-phone-code.interface';
+import { DyFM_Regions } from './loc-regions.util';
+
+describe('| DyFM_Regions', () => {
+  it('| should get all country ISOs', () => {
+    const countryISOs: DyFM_CountryISO[] = DyFM_Regions.countryISOs;
+    expect(countryISOs).toBeDefined();
+    expect(countryISOs.length).toBeGreaterThan(0);
+  });
+
+  it('| should get all phone codes', () => {
+    const phoneCodes: DyFM_CountryPhoneCode[] = DyFM_Regions.phoneCodes;
+    expect(phoneCodes).toBeDefined();
+    expect(phoneCodes.length).toBeGreaterThan(0);
+  });
+
+  it('| should get all divisions', () => {
+    const divisions: DyFM_CountryDivision[] = DyFM_Regions.divisions;
+    expect(divisions).toBeDefined();
+    expect(divisions.length).toBeGreaterThan(0);
+  });
+
+  it('| should convert ISO to country ISO', () => {
+    const iso2 = 'US';
+    const countryISO: DyFM_CountryISO = DyFM_Regions.isoToCountryIso(iso2);
+    expect(countryISO).toBeDefined();
+    expect(countryISO.iso2).toBe(iso2);
+  });
+
+  /* it('| should throw error if ISO not found in isoToCountryIso', () => {
+    const iso2 = 'XX';
+    expect(() => DyFM_Regions.isoToCountryIso(iso2)).toThrowError(DyFM_Error);
+  });
+ */
+  it('| should convert ISO to region', () => {
+    const iso2 = 'US';
+    const region: DyFM_Region = DyFM_Regions.isoToRegion(iso2);
+    expect(region).toBeDefined();
+  });
+
+  /* it('| should throw error if ISO not found in isoToRegion', () => {
+    const iso2 = 'XX';
+    expect(() => DyFM_Regions.isoToRegion(iso2)).toThrowError(DyFM_Error);
+  }); */
+
+  it('| should convert ISO to phone code', () => {
+    const iso2 = 'US';
+    const phoneCode: DyFM_CountryPhoneCode = DyFM_Regions.isoToPhoneCode(iso2);
+    expect(phoneCode).toBeDefined();
+    expect(phoneCode.iso).toBe(iso2);
+  });
+
+  /* it('| should throw error if ISO not found in isoToPhoneCode', () => {
+    const iso2 = 'XX';
+    expect(() => DyFM_Regions.isoToPhoneCode(iso2)).toThrowError(DyFM_Error);
+  }); */
+});

package/src/_modules/location/_collections/loc-regions.util.ts

@@ -1,137 +1,137 @@
-
-/* const ISOs = [];
-const PhoneCodes = [];
-const Divisions = []; */
-import * as ISOs from './assets/country-codes-ISO-3166.json';
-
-import * as PhoneCodes from './assets/country-phone-codes.json';
-import * as Divisions from './assets/country-divisions-ISO-3166-all-list.json';
-
-import { DyFM_Region } from '../_enums/loc-region.enum';
-import { 
-  DyFM_CountryPhoneCode 
-} from '../_models/loc-country-phone-code.interface';
-import { DyFM_CountryISO } from '../_models/loc-country-iso.interface';
-import { DyFM_CountryDivision } from '../_models/loc-country-division.interface';
-
-import { DyFM_Object } from '../../../_collections/utils/object.util';
-import { DyFM_Error } from '../../../_models/control-models/error.control-model';
-
-
-/**
- * Static utilities for retrieving country and region information
- * from bundled ISO datasets.
- */
-export class DyFM_Regions {
-  /* static divisions: DivisionCollection = DyFM_Regions.getSubdivisionCollection(); */
-  static readonly divisions: DyFM_CountryDivision[] = DyFM_Regions.getAllDivisions();
-  static readonly phoneCodes: DyFM_CountryPhoneCode[] = DyFM_Regions.getAllPhoneCodes();
-  static readonly countryISOs: DyFM_CountryISO[] = DyFM_Regions.getAllCountryISO();
-
-  private static getAllDivisions(): DyFM_CountryDivision[] {
-    if (!Divisions) throw new DyFM_Error({ message: 'Cannot find ISO-3166 JSON file.' });
-
-    return DyFM_Object.JSONListify(Divisions);
-  }
-  private static getAllPhoneCodes(): DyFM_CountryPhoneCode[] {
-    if (!PhoneCodes) throw new DyFM_Error({ message: 'Cannot find ISO-3166 JSON file.' });
-    
-    return DyFM_Object.JSONListify(PhoneCodes);
-  }
-
-  /*  private static getSubdivisionCollection(): DivisionCollection {
-    return Divisions as DivisionCollection;
-  } */
-  private static getAllCountryISO(): DyFM_CountryISO[] {
-    if (!ISOs) throw new DyFM_Error({ message: 'Cannot find ISO-3166 JSON file.' });
-
-    const result: DyFM_CountryISO[] = DyFM_Object.JSONListify(ISOs);
-
-    result.forEach((iso: DyFM_CountryISO): void => {
-      iso.phoneCode = this.phoneCodes.find(
-        (pc: DyFM_CountryPhoneCode): boolean => pc.iso === iso.iso2
-      )?.code;
-      iso.divisions = this.divisions.filter(
-        (d: DyFM_CountryDivision): boolean => d.iso === iso.iso2
-      );
-    });
-
-    return result;
-  }
-
-  /**
-   * Converts an ISO-3166 code to a country ISO object.
-   * @param iso2 The ISO-3166 code to convert.
-   * @returns The country ISO object.
-   * 
-   * @example
-   * ```ts
-   * const country: DyFM_CountryISO = DyFM_Regions.isoToCountryIso('US');
-   * console.log(country.name); // United States
-   * ```
-   */
-  static isoToCountryIso(iso2: string): DyFM_CountryISO {
-    const country: DyFM_CountryISO = this.countryISOs.find(
-      (iso: DyFM_CountryISO): boolean => iso.iso2 == iso2
-    );
-
-    if (!country) {
-      throw new DyFM_Error({ 
-        message: `Cannot find ISO-3166 code for this: ${iso2}`,
-      });
-    } else {
-      return country;
-    }
-  }
-
-  /**
-   * Converts an ISO-3166 code to a region.
-   * @param iso2 The ISO-3166 code to convert.
-   * @returns The region.
-   * 
-   * @example
-   * ```ts
-   * const region: DyFM_Region = DyFM_Regions.isoToRegion('US');
-   * console.log(region); // North America
-   * ```
-   */
-  static isoToRegion(iso2: string): DyFM_Region {
-    const region: DyFM_Region = this.countryISOs.find(
-      (iso: DyFM_CountryISO): boolean => iso.iso2 == iso2
-    )?.region;
-
-    if (!region) {
-      throw new DyFM_Error({ 
-        message: `Cannot find ISO-3166 code for this: ${iso2}`,
-      });
-    } else {
-      return region;
-    }
-  }
-  
-  /**
-   * Converts an ISO-3166 code to a phone code.
-   * @param iso2 The ISO-3166 code to convert.
-   * @returns The phone code.
-   * 
-   * @example
-   * ```ts
-   * const phoneCode: DyFM_CountryPhoneCode = DyFM_Regions.isoToPhoneCode('US');
-   * console.log(phoneCode.code); // +1
-   * ```
-   */
-  static isoToPhoneCode(iso2: string): DyFM_CountryPhoneCode {
-    const phoneCode: DyFM_CountryPhoneCode = this.phoneCodes.find(
-      (code: DyFM_CountryPhoneCode): boolean => code.iso == iso2
-    );
-
-    if (!phoneCode) {
-      throw new DyFM_Error({ 
-        message: `Cannot find ISO-3166 code for this: ${iso2}`,
-      });
-    } else {
-      return phoneCode;
-    }
-  }
-}
-
+
+/* const ISOs = [];
+const PhoneCodes = [];
+const Divisions = []; */
+import * as ISOs from './assets/country-codes-ISO-3166.json';
+
+import * as PhoneCodes from './assets/country-phone-codes.json';
+import * as Divisions from './assets/country-divisions-ISO-3166-all-list.json';
+
+import { DyFM_Region } from '../_enums/loc-region.enum';
+import { 
+  DyFM_CountryPhoneCode 
+} from '../_models/loc-country-phone-code.interface';
+import { DyFM_CountryISO } from '../_models/loc-country-iso.interface';
+import { DyFM_CountryDivision } from '../_models/loc-country-division.interface';
+
+import { DyFM_Object } from '../../../_collections/utils/object.util';
+import { DyFM_Error } from '../../../_models/control-models/error.control-model';
+
+
+/**
+ * Static utilities for retrieving country and region information
+ * from bundled ISO datasets.
+ */
+export class DyFM_Regions {
+  /* static divisions: DivisionCollection = DyFM_Regions.getSubdivisionCollection(); */
+  static readonly divisions: DyFM_CountryDivision[] = DyFM_Regions.getAllDivisions();
+  static readonly phoneCodes: DyFM_CountryPhoneCode[] = DyFM_Regions.getAllPhoneCodes();
+  static readonly countryISOs: DyFM_CountryISO[] = DyFM_Regions.getAllCountryISO();
+
+  private static getAllDivisions(): DyFM_CountryDivision[] {
+    if (!Divisions) throw new DyFM_Error({ message: 'Cannot find ISO-3166 JSON file.' });
+
+    return DyFM_Object.JSONListify(Divisions);
+  }
+  private static getAllPhoneCodes(): DyFM_CountryPhoneCode[] {
+    if (!PhoneCodes) throw new DyFM_Error({ message: 'Cannot find ISO-3166 JSON file.' });
+    
+    return DyFM_Object.JSONListify(PhoneCodes);
+  }
+
+  /*  private static getSubdivisionCollection(): DivisionCollection {
+    return Divisions as DivisionCollection;
+  } */
+  private static getAllCountryISO(): DyFM_CountryISO[] {
+    if (!ISOs) throw new DyFM_Error({ message: 'Cannot find ISO-3166 JSON file.' });
+
+    const result: DyFM_CountryISO[] = DyFM_Object.JSONListify(ISOs);
+
+    result.forEach((iso: DyFM_CountryISO): void => {
+      iso.phoneCode = this.phoneCodes.find(
+        (pc: DyFM_CountryPhoneCode): boolean => pc.iso === iso.iso2
+      )?.code;
+      iso.divisions = this.divisions.filter(
+        (d: DyFM_CountryDivision): boolean => d.iso === iso.iso2
+      );
+    });
+
+    return result;
+  }
+
+  /**
+   * Converts an ISO-3166 code to a country ISO object.
+   * @param iso2 The ISO-3166 code to convert.
+   * @returns The country ISO object.
+   * 
+   * @example
+   * ```ts
+   * const country: DyFM_CountryISO = DyFM_Regions.isoToCountryIso('US');
+   * console.log(country.name); // United States
+   * ```
+   */
+  static isoToCountryIso(iso2: string): DyFM_CountryISO {
+    const country: DyFM_CountryISO = this.countryISOs.find(
+      (iso: DyFM_CountryISO): boolean => iso.iso2 == iso2
+    );
+
+    if (!country) {
+      throw new DyFM_Error({ 
+        message: `Cannot find ISO-3166 code for this: ${iso2}`,
+      });
+    } else {
+      return country;
+    }
+  }
+
+  /**
+   * Converts an ISO-3166 code to a region.
+   * @param iso2 The ISO-3166 code to convert.
+   * @returns The region.
+   * 
+   * @example
+   * ```ts
+   * const region: DyFM_Region = DyFM_Regions.isoToRegion('US');
+   * console.log(region); // North America
+   * ```
+   */
+  static isoToRegion(iso2: string): DyFM_Region {
+    const region: DyFM_Region = this.countryISOs.find(
+      (iso: DyFM_CountryISO): boolean => iso.iso2 == iso2
+    )?.region;
+
+    if (!region) {
+      throw new DyFM_Error({ 
+        message: `Cannot find ISO-3166 code for this: ${iso2}`,
+      });
+    } else {
+      return region;
+    }
+  }
+  
+  /**
+   * Converts an ISO-3166 code to a phone code.
+   * @param iso2 The ISO-3166 code to convert.
+   * @returns The phone code.
+   * 
+   * @example
+   * ```ts
+   * const phoneCode: DyFM_CountryPhoneCode = DyFM_Regions.isoToPhoneCode('US');
+   * console.log(phoneCode.code); // +1
+   * ```
+   */
+  static isoToPhoneCode(iso2: string): DyFM_CountryPhoneCode {
+    const phoneCode: DyFM_CountryPhoneCode = this.phoneCodes.find(
+      (code: DyFM_CountryPhoneCode): boolean => code.iso == iso2
+    );
+
+    if (!phoneCode) {
+      throw new DyFM_Error({ 
+        message: `Cannot find ISO-3166 code for this: ${iso2}`,
+      });
+    } else {
+      return phoneCode;
+    }
+  }
+}
+