@futdevpro/fsm-dynamo 1.15.21 → 1.15.22

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

@@ -1,52 +1,52 @@
-
-import { DyFM_LocationCoordinates } from '../_models/loc-coordinates.interface';
-import { DyFM_Location } from './loc.util';
-
-describe('| DyFM_Location', () => {
-
-  describe('| getDistanceInKilometres', () => {
-    xit('should calculate the correct distance between two coordinates', () => {
-      const from: DyFM_LocationCoordinates = { latitude: 52.5200, longitude: 13.4050 }; // Berlin
-      const to: DyFM_LocationCoordinates = { latitude: 48.8566, longitude: 2.3522 }; // Paris
-
-      const distance = DyFM_Location.getDistanceInKilometres(from, to);
-
-      expect(distance).toBeCloseTo(878.7, 1); // Approximate distance in km
-    });
-
-    it('| should return 0 when the coordinates are the same', () => {
-      const from: DyFM_LocationCoordinates = { latitude: 52.5200, longitude: 13.4050 };
-
-      const distance = DyFM_Location.getDistanceInKilometres(from, from);
-
-      expect(distance).toBe(0);
-    });
-  });
-
-  describe('| getLocationDegByKilometers', () => {
-    it('| should calculate the correct degree change for latitude', () => {
-      const distanceInKm = 110.574; // 1 degree of latitude
-
-      const degreeChange = DyFM_Location.getLocationDegByKilometers('latitude', distanceInKm);
-
-      expect(degreeChange).toBeCloseTo(1, 5);
-    });
-
-    xit('should calculate the correct degree change for longitude', () => {
-      const distanceInKm = 111.320; // Approximate 1 degree of longitude at the equator
-      const latitude = 0; // Equator
-
-      const degreeChange = DyFM_Location.getLocationDegByKilometers('longitude', distanceInKm, latitude);
-
-      expect(degreeChange).toBeCloseTo(1, 5);
-    });
-
-    /* it('| should throw an error when calculating longitude without latitude', () => {
-      const distanceInKm = 111.320;
-
-      expect(() => {
-        DyFM_Location.getLocationDegByKilometers('longitude', distanceInKm);
-      }).toThrowError(DyFM_Error);
-    }); */
-  });
-});
+
+import { DyFM_LocationCoordinates } from '../_models/loc-coordinates.interface';
+import { DyFM_Location } from './loc.util';
+
+describe('| DyFM_Location', () => {
+
+  describe('| getDistanceInKilometres', () => {
+    xit('should calculate the correct distance between two coordinates', () => {
+      const from: DyFM_LocationCoordinates = { latitude: 52.5200, longitude: 13.4050 }; // Berlin
+      const to: DyFM_LocationCoordinates = { latitude: 48.8566, longitude: 2.3522 }; // Paris
+
+      const distance = DyFM_Location.getDistanceInKilometres(from, to);
+
+      expect(distance).toBeCloseTo(878.7, 1); // Approximate distance in km
+    });
+
+    it('| should return 0 when the coordinates are the same', () => {
+      const from: DyFM_LocationCoordinates = { latitude: 52.5200, longitude: 13.4050 };
+
+      const distance = DyFM_Location.getDistanceInKilometres(from, from);
+
+      expect(distance).toBe(0);
+    });
+  });
+
+  describe('| getLocationDegByKilometers', () => {
+    it('| should calculate the correct degree change for latitude', () => {
+      const distanceInKm = 110.574; // 1 degree of latitude
+
+      const degreeChange = DyFM_Location.getLocationDegByKilometers('latitude', distanceInKm);
+
+      expect(degreeChange).toBeCloseTo(1, 5);
+    });
+
+    xit('should calculate the correct degree change for longitude', () => {
+      const distanceInKm = 111.320; // Approximate 1 degree of longitude at the equator
+      const latitude = 0; // Equator
+
+      const degreeChange = DyFM_Location.getLocationDegByKilometers('longitude', distanceInKm, latitude);
+
+      expect(degreeChange).toBeCloseTo(1, 5);
+    });
+
+    /* it('| should throw an error when calculating longitude without latitude', () => {
+      const distanceInKm = 111.320;
+
+      expect(() => {
+        DyFM_Location.getLocationDegByKilometers('longitude', distanceInKm);
+      }).toThrowError(DyFM_Error);
+    }); */
+  });
+});

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

@@ -1,74 +1,74 @@
-
-import { DyFM_Error } from '../../../_models/control-models/error.control-model';
-import { DyFM_Trigonometry } from '../../../_collections/utils/math/trigonometry.util';
-import {
-  DyFM_LocationCoordinates
-} from '../_models/loc-coordinates.interface';
-
-/**
- * Helper utilities for geographic calculations.
- */
-export class DyFM_Location {
-  /**
-   * Calculates the distance between two coordinates using the haversine formula.
-   */
-  static getDistanceInKilometres(
-    from: DyFM_LocationCoordinates,
-    to: DyFM_LocationCoordinates
-  ): number {
-
-    const R = 6371; // kilometres
-    const φ1 = DyFM_Trigonometry.angleToRadians(from.latitude);
-    const φ2 = DyFM_Trigonometry.angleToRadians(to.latitude);
-    const Δφ = DyFM_Trigonometry.angleToRadians(to.latitude - from.latitude);
-    const Δλ = DyFM_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;
-  }
-
-  /**
-   * Converts a distance in kilometers to degree difference for latitude or longitude.
-   * @param latiOrLong The direction to convert to degrees.
-   * @param distanceInKm The distance in kilometers.
-   * @param latitude The latitude to use for the conversion.
-   * @returns The degree difference.
-   * 
-   * @example
-   * ```ts
-   * const degreeChange = DyFM_Location.getLocationDegByKilometers('latitude', 110.574);
-   * console.log(degreeChange); // 1
-   * ```
-   */
-  static getLocationDegByKilometers(
-    latiOrLong: 'latitude' | 'longitude',
-    distanceInKm: number,
-    latitude?: number
-  ): number {
-    if (latiOrLong === 'latitude') {
-      return distanceInKm / 110.574;
-    } else {
-      if (latitude) {
-        return distanceInKm / (Math.cos(DyFM_Trigonometry.angleToRadians(latitude)) * 111.320);
-      } else {
-        throw new DyFM_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.`,
-        });
-      }
-    }
-  }
-}
-
-
+
+import { DyFM_Error } from '../../../_models/control-models/error.control-model';
+import { DyFM_Trigonometry } from '../../../_collections/utils/math/trigonometry.util';
+import {
+  DyFM_LocationCoordinates
+} from '../_models/loc-coordinates.interface';
+
+/**
+ * Helper utilities for geographic calculations.
+ */
+export class DyFM_Location {
+  /**
+   * Calculates the distance between two coordinates using the haversine formula.
+   */
+  static getDistanceInKilometres(
+    from: DyFM_LocationCoordinates,
+    to: DyFM_LocationCoordinates
+  ): number {
+
+    const R = 6371; // kilometres
+    const φ1 = DyFM_Trigonometry.angleToRadians(from.latitude);
+    const φ2 = DyFM_Trigonometry.angleToRadians(to.latitude);
+    const Δφ = DyFM_Trigonometry.angleToRadians(to.latitude - from.latitude);
+    const Δλ = DyFM_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;
+  }
+
+  /**
+   * Converts a distance in kilometers to degree difference for latitude or longitude.
+   * @param latiOrLong The direction to convert to degrees.
+   * @param distanceInKm The distance in kilometers.
+   * @param latitude The latitude to use for the conversion.
+   * @returns The degree difference.
+   * 
+   * @example
+   * ```ts
+   * const degreeChange = DyFM_Location.getLocationDegByKilometers('latitude', 110.574);
+   * console.log(degreeChange); // 1
+   * ```
+   */
+  static getLocationDegByKilometers(
+    latiOrLong: 'latitude' | 'longitude',
+    distanceInKm: number,
+    latitude?: number
+  ): number {
+    if (latiOrLong === 'latitude') {
+      return distanceInKm / 110.574;
+    } else {
+      if (latitude) {
+        return distanceInKm / (Math.cos(DyFM_Trigonometry.angleToRadians(latitude)) * 111.320);
+      } else {
+        throw new DyFM_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/_modules/location/_enums/loc-region.enum.ts

@@ -1,14 +1,14 @@
-
-
-
-/**
- * Continents and large geographic regions.
- */
-export enum DyFM_Region {
-  europe = 'Europe',
-  asia = 'Asia',
-  africa = 'Africa',
-  oceania = 'Oceania',
-  americas = 'Americas',
-}
-
+
+
+
+/**
+ * Continents and large geographic regions.
+ */
+export enum DyFM_Region {
+  europe = 'Europe',
+  asia = 'Asia',
+  africa = 'Africa',
+  oceania = 'Oceania',
+  americas = 'Americas',
+}
+

package/src/_modules/location/_enums/loc-sub-region.enum.ts

@@ -1,31 +1,31 @@
-
-
-
-/**
- * List of geographic subregions.
- */
-export enum DyFM_SubRegion {
-  northernEurope = 'Northern Europe',
-  southernEurope = 'Southern Europe',
-  westernEurope = 'Western Europe',
-  easternEurope = 'Eastern Europe',
-
-  northernAfrica = 'Northern Africa',
-  subSaharanAfrica = 'Sub-Saharan Africa',
-
-  northernAmerica = 'Northern America',
-  latinAmericaAndTheCaribbean = 'Latin America and the Caribbean',
-
-  southEasternAsia = 'South-eastern Asia',
-  easternAsia = 'Eastern Asia',
-  southernAsia = 'Southern Asia',
-  
-  westernAsia = 'Western Asia',
-  centralAsia = 'Central Asia',
-
-  australiaAndNewZealand = 'Australia and New Zealand',
-  melanesia = 'Melanesia',
-  micronesia = 'Micronesia',
-  polynesia = 'Polynesia',
-}
-
+
+
+
+/**
+ * List of geographic subregions.
+ */
+export enum DyFM_SubRegion {
+  northernEurope = 'Northern Europe',
+  southernEurope = 'Southern Europe',
+  westernEurope = 'Western Europe',
+  easternEurope = 'Eastern Europe',
+
+  northernAfrica = 'Northern Africa',
+  subSaharanAfrica = 'Sub-Saharan Africa',
+
+  northernAmerica = 'Northern America',
+  latinAmericaAndTheCaribbean = 'Latin America and the Caribbean',
+
+  southEasternAsia = 'South-eastern Asia',
+  easternAsia = 'Eastern Asia',
+  southernAsia = 'Southern Asia',
+  
+  westernAsia = 'Western Asia',
+  centralAsia = 'Central Asia',
+
+  australiaAndNewZealand = 'Australia and New Zealand',
+  melanesia = 'Melanesia',
+  micronesia = 'Micronesia',
+  polynesia = 'Polynesia',
+}
+

package/src/_modules/location/_enums/loc-subdivision-region-type.enum.ts

@@ -1,47 +1,47 @@
-
-
-/**
- * Types of administrative divisions.
- */
-export enum DyFM_SubdivisionRegionType {
-  parish,                 // smaller church administrative region
-  emirate,               // territories ruled by an emir
-  province,              // first-level subdivision in many countries
-  dependency,            // territories dependent on another state
-  county,                // common administrative unit
-  city,                  // incorporated municipality
-  region,                // generic region type
-  state,                 // first-level political subdivision
-  territory,             // land under a jurisdiction
-  autonomousRepublic,    // self-governing republic inside a country
-  municipate,            // municipality-like entity
-  rayon,                 // district used in some post-Soviet states
-  division,              // general division level
-  district,              // smaller subdivision within a state
-  governorate,           // province headed by a governor
-  department,            // used in several countries like France
-  specialMunicipality,   // municipality with special status
-  federalDistrict,       // district under federal jurisdiction
-  island,                // geographic island region
-  town,                  // small urban area
-  oblast,                // administrative region in Slavic countries
-  commune,               // community-level division
-  prefecture,            // prefectural region as in Japan
-  economicPrefecture,    // economic focused prefecture
-  canton,                // administrative division, e.g., Switzerland
-  autonomousRegion,      // region with high autonomy
-  specialAdministrativeRegion, // SAR like Hong Kong
-  capitalDistrict,       // district for capital
-  geographicalRegion,    // purely geographic region
-  capitalCity,           // denotes the capital city
-  ruralMunicipality,     // rural municipality
-  urbanMunicipality,     // urban municipality
-  autonomousCommunity,   // e.g., Spain's communities
-  autonomousCity,        // autonomous city
-  administration,
-  regionalState,
-  metropolitanRegion,
-  overseasCollectivity,
-  // ... reduce specials // non-finished
-} 
-
+
+
+/**
+ * Types of administrative divisions.
+ */
+export enum DyFM_SubdivisionRegionType {
+  parish,                 // smaller church administrative region
+  emirate,               // territories ruled by an emir
+  province,              // first-level subdivision in many countries
+  dependency,            // territories dependent on another state
+  county,                // common administrative unit
+  city,                  // incorporated municipality
+  region,                // generic region type
+  state,                 // first-level political subdivision
+  territory,             // land under a jurisdiction
+  autonomousRepublic,    // self-governing republic inside a country
+  municipate,            // municipality-like entity
+  rayon,                 // district used in some post-Soviet states
+  division,              // general division level
+  district,              // smaller subdivision within a state
+  governorate,           // province headed by a governor
+  department,            // used in several countries like France
+  specialMunicipality,   // municipality with special status
+  federalDistrict,       // district under federal jurisdiction
+  island,                // geographic island region
+  town,                  // small urban area
+  oblast,                // administrative region in Slavic countries
+  commune,               // community-level division
+  prefecture,            // prefectural region as in Japan
+  economicPrefecture,    // economic focused prefecture
+  canton,                // administrative division, e.g., Switzerland
+  autonomousRegion,      // region with high autonomy
+  specialAdministrativeRegion, // SAR like Hong Kong
+  capitalDistrict,       // district for capital
+  geographicalRegion,    // purely geographic region
+  capitalCity,           // denotes the capital city
+  ruralMunicipality,     // rural municipality
+  urbanMunicipality,     // urban municipality
+  autonomousCommunity,   // e.g., Spain's communities
+  autonomousCity,        // autonomous city
+  administration,
+  regionalState,
+  metropolitanRegion,
+  overseasCollectivity,
+  // ... reduce specials // non-finished
+} 
+

package/src/_modules/location/_models/loc-coordinates.interface.ts

@@ -1,7 +1,7 @@
-
-
-/** Geographic coordinates with longitude and latitude. */
-export interface DyFM_LocationCoordinates {
-  longitude: number;
-  latitude: number;
-}
+
+
+/** Geographic coordinates with longitude and latitude. */
+export interface DyFM_LocationCoordinates {
+  longitude: number;
+  latitude: number;
+}

package/src/_modules/location/_models/loc-country-division.interface.ts

@@ -1,8 +1,8 @@
-
-
-
-export interface DyFM_CountryDivision {
-  iso: string;
-  code: string;
-  name: string;
-}
+
+
+
+export interface DyFM_CountryDivision {
+  iso: string;
+  code: string;
+  name: string;
+}

package/src/_modules/location/_models/loc-country-iso.interface.ts

@@ -1,23 +1,23 @@
-
-
-import { DyFM_Region } from '../_enums/loc-region.enum';
-import { DyFM_SubRegion } from '../_enums/loc-sub-region.enum';
-import { DyFM_CountryDivision } from './loc-country-division.interface';
-
-
-
-export interface DyFM_CountryISO {
-  name: string;
-  iso2: string;
-  iso3: string;
-  countryCode: string;
-  fullIso: string;
-  region: DyFM_Region;
-  regionCode: string;
-  subRegion: DyFM_SubRegion;
-  subRegionCode: string;
-  subdivisionRegion: string;
-  subdivisionRegionCode: string;
-  phoneCode?: string;
-  divisions?: DyFM_CountryDivision[];
-}
+
+
+import { DyFM_Region } from '../_enums/loc-region.enum';
+import { DyFM_SubRegion } from '../_enums/loc-sub-region.enum';
+import { DyFM_CountryDivision } from './loc-country-division.interface';
+
+
+
+export interface DyFM_CountryISO {
+  name: string;
+  iso2: string;
+  iso3: string;
+  countryCode: string;
+  fullIso: string;
+  region: DyFM_Region;
+  regionCode: string;
+  subRegion: DyFM_SubRegion;
+  subRegionCode: string;
+  subdivisionRegion: string;
+  subdivisionRegionCode: string;
+  phoneCode?: string;
+  divisions?: DyFM_CountryDivision[];
+}

package/src/_modules/location/_models/loc-country-phone-code.interface.ts

@@ -1,9 +1,9 @@
-
-
-
-export interface DyFM_CountryPhoneCode {
-  iso: string;
-  country: string;
-  code: string;
-}
-
+
+
+
+export interface DyFM_CountryPhoneCode {
+  iso: string;
+  country: string;
+  code: string;
+}
+

package/src/_modules/location/_models/loc-division-collection.interface.ts

@@ -1,12 +1,12 @@
-
-
-
-export interface DyFM_Division_Collection {
-  [iso2: string]: {
-    name: string;
-    divisions: {
-      [divisionCode: string]: string
-    }
-  }
-}
-
+
+
+
+export interface DyFM_Division_Collection {
+  [iso2: string]: {
+    name: string;
+    divisions: {
+      [divisionCode: string]: string
+    }
+  }
+}
+

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

@@ -1,9 +1,9 @@
-import { DyFM_SubdivisionRegionType } from '../_enums/loc-subdivision-region-type.enum';
-import { DyFM_CountryISO } from './loc-country-iso.interface';
-
-
-export interface DyFM_SubdivisionRegionData extends DyFM_CountryISO {  
-  type?: DyFM_SubdivisionRegionType;
-}
-
-
+import { DyFM_SubdivisionRegionType } from '../_enums/loc-subdivision-region-type.enum';
+import { DyFM_CountryISO } from './loc-country-iso.interface';
+
+
+export interface DyFM_SubdivisionRegionData extends DyFM_CountryISO {  
+  type?: DyFM_SubdivisionRegionType;
+}
+
+

package/src/_modules/location/_models/loc-geo-ip-location.interface.ts

@@ -1,27 +1,27 @@
-
-
-export interface DyFM_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;
-}
+
+
+export interface DyFM_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;
+}