@futdevpro/fsm-dynamo 1.14.10 → 1.14.12

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

@@ -59,6 +59,17 @@ export class DyFM_Regions {
     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
@@ -73,6 +84,17 @@ export class DyFM_Regions {
     }
   }
 
+  /**
+   * 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
@@ -86,7 +108,18 @@ export class DyFM_Regions {
       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

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

@@ -33,6 +33,16 @@ export class DyFM_Location {
 
   /**
    * 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',

package/src/_modules/usage/_collections/usg-module-settings.const.ts

@@ -30,4 +30,4 @@ export interface DyFM_Usage_EndpointTypeSettings extends DyFM_ServiceEndpointTyp
   [DyFM_UsageRoute.closeSession]: DyFM_EndpointTypesContainer<DyFM_UsageSession, [ string ]>;
   [DyFM_UsageRoute.updateUsage]: DyFM_EndpointTypesContainer<DyFM_UsageSession, [ string, DyFM_UsageData[], DyFM_UsageData[] ]>;
   [DyFM_UsageRoute.getUsageData]: DyFM_EndpointTypesContainer<DyFM_DailyUsageData[], [ DyFM_RelativeDate ]>;
-}
+}

package/tsconfig.json

@@ -2,11 +2,11 @@
   "compilerOptions": {
     "incremental": false,                  
     "module": "commonjs",                 
-    "target": "es2022",                      
+    "target": "es2021",                      
     "lib": [
       "es6",
       "es2018",
-      "es2022",
+      "es2021",
       "dom"
     ],     
     "strict": false,

package/.eslintrc.json

@@ -1,155 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "es2021": true
-  },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended"
-  ],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": "latest"
-  },
-  "plugins": [
-    "@typescript-eslint",
-    "unused-imports"
-  ],
-  "rules": {
-    /**
-      WARNING!
-      If the rules have unknown json parse error, it wont work!
-      (even if have any property anywhere)
-    */
-    "no-warning-comments": [
-      "warn",
-      {
-        "terms": [ "todo", "fixme", "removable", "??" ],
-        "location": "anywhere"
-      }
-    ],
-    "indent": [
-      "warn",
-      2,
-      { "SwitchCase": 1 }
-    ],
-    "max-len": [
-      "warn",
-      {
-        "code": 100,
-        "comments": 120
-      }
-    ],
-    "comma-dangle": [
-      "warn",
-      {
-        "arrays": "always-multiline",
-        "objects": "always-multiline",
-        "imports": "never",
-        "exports": "never",
-        "functions": "only-multiline"
-      }
-    ],
-    "max-lines" : [
-      "warn",
-      1500
-    ],
-    "linebreak-style": "off",
-    /* [
-      "warn",
-      "unix"
-    ], */
-    "semi": [ "warn", "always" ],
-    "no-case-declarations": "off",
-    "no-unused-vars": "off",
-    "no-prototype-builtins": "off",
-    "padding-line-between-statements": [
-      "warn",
-      {
-        /** BREAK-LINE BEFORE */
-        "blankLine": "always",
-        "prev": "*",
-        "next": [
-          "return",
-          "throw",
-          "if",
-          "for",
-          "while",
-          "switch",
-          "case",
-          "default"
-        ]
-      },
-      {
-        /** BREAK-LINE AFTER */
-        "blankLine": "always",
-        "prev": [
-          "const",
-          "let",
-          "var",
-          "break"
-        ],
-        "next": "*"
-      },
-      { /** CAN FOLLOW (this must be after the BREAK-LINE AFTER and BREAK-LINE BEFORE) */
-        "blankLine": "any",
-        "prev": [
-          "const",
-          "let",
-          "var"
-        ],
-        "next": [
-          "const",
-          "let",
-          "var"
-        ]
-      },
-      { /** CAN FOLLOW (this must be after the BREAK-LINE AFTER and BREAK-LINE BEFORE) */
-        "blankLine": "any",
-        "prev": [
-          "case",
-          "default"
-        ],
-        "next": [
-          "case",
-          "default"
-        ]
-      }
-    ],
-    "no-extra-semi": "warn",
-    "prefer-const": "warn",
-    "quotes": [ 
-      "warn", 
-      "single",
-      { "allowTemplateLiterals": true } 
-    ],
-    /** PACKAGE ONLY SETTINGS START */
-    "brace-style": [
-      "warn",
-      "1tbs",
-      { "allowSingleLine": true }
-    ],
-    "object-curly-spacing": [ "warn", "always" ],
-    "array-bracket-spacing": [
-      "warn",
-      "always",
-      { "objectsInArrays": false, "arraysInArrays": false }
-    ],
-    "@typescript-eslint/ban-types": "off",
-    "@typescript-eslint/no-explicit-any": "off",
-    /** PACKAGE ONLY SETTINGS END */
-    /* "@typescript-eslint/no-explicit-any": "warn", */
-    "@typescript-eslint/quotes": [ 
-      "warn", 
-      "single",
-      { "allowTemplateLiterals": true } 
-    ],
-    "@typescript-eslint/no-unused-vars": "off",
-    "@typescript-eslint/explicit-function-return-type": [
-      "warn",
-      {
-        "allowTypedFunctionExpressions": false
-      }
-    ]
-  }
-}