geo-coordinates-parser 1.6.5 → 1.7.0

package/README.md

@@ -72,6 +72,9 @@ Formats used for testing can be be accessed with:
 convert.formats
 ```
 
+**Please note that decimal precision needs to be reasonable. The maximum decimal places allowed in DMS, for example, is three (3). DMS coordinates with four decimal places in seconds are measuring position at a precision of less than 
+10mm, which is way beyond what even the best professional GPS devices can provide.**
+
 **Please add coordinate formats that throw an error in the Github Issues.**
 
 **CAUTION!!!**

package/dist/cjs/converter.d.ts

@@ -2,13 +2,21 @@ export default converter;
 /**
  * Function for converting coordinates in a variety of formats to decimal coordinates
  * @param {string} coordsString The coordinates string to convert
- * @param {number} decimalPlaces The number of decimal places for converted coordinates; default is 5
- * @returns {object} { verbatimCoordinates, decimalCoordinates, decimalLatitude, decimalLongitude }
+ * @param {number} [decimalPlaces] The number of decimal places for converted coordinates; default is 5
+ * @returns {{verbatimCoordinates: string, decimalCoordinates: string, decimalLatitude: string, decimalLongitude: string, closeEnough: function(string): boolean, toCoordinateFormat: toCoordinateFormat}}
  */
-declare function converter(coordsString: string, decimalPlaces: number): object;
+declare function converter(coordsString: string, decimalPlaces?: number | undefined): {
+    verbatimCoordinates: string;
+    decimalCoordinates: string;
+    decimalLatitude: string;
+    decimalLongitude: string;
+    closeEnough: (arg0: string) => boolean;
+    toCoordinateFormat: typeof toCoordinateFormat;
+};
 declare namespace converter {
     export { to };
 }
+import toCoordinateFormat from './toCoordinateFormat.js';
 declare const to: Readonly<{
     DMS: "DMS";
     DM: "DM";

package/dist/cjs/converter.js

@@ -10,8 +10,8 @@ const toCoordinateFormat_js_1 = __importDefault(require("./toCoordinateFormat.js
 /**
  * Function for converting coordinates in a variety of formats to decimal coordinates
  * @param {string} coordsString The coordinates string to convert
- * @param {number} decimalPlaces The number of decimal places for converted coordinates; default is 5
- * @returns {object} { verbatimCoordinates, decimalCoordinates, decimalLatitude, decimalLongitude }
+ * @param {number} [decimalPlaces] The number of decimal places for converted coordinates; default is 5
+ * @returns {{verbatimCoordinates: string, decimalCoordinates: string, decimalLatitude: string, decimalLongitude: string, closeEnough: function(string): boolean, toCoordinateFormat: toCoordinateFormat}}
  */
 function converter(coordsString, decimalPlaces) {
     //TODO add exact match to entered string, so that it can be used to filter out superflous text around it
@@ -25,7 +25,24 @@ function converter(coordsString, decimalPlaces) {
     let lngdir = "";
     let match = [];
     let matchSuccess = false;
-    if (regex_js_1.dd_re.test(coordsString)) {
+    if (regex_js_1.dm_numbers.test(coordsString)) {
+        match = regex_js_1.dm_numbers.exec(coordsString);
+        matchSuccess = checkMatch(match);
+        if (matchSuccess) {
+            ddLat = Math.abs(match[1]) + match[2] / 60;
+            if (Number(match[1]) < 0) {
+                ddLat *= -1;
+            }
+            ddLng = Math.abs(match[3]) + match[4] / 60;
+            if (Number(match[3]) < 0) {
+                ddLng *= -1;
+            }
+        }
+        else {
+            throw new Error("invalid coordinate format");
+        }
+    }
+    else if (regex_js_1.dd_re.test(coordsString)) {
         match = regex_js_1.dd_re.exec(coordsString);
         matchSuccess = checkMatch(match);
         if (matchSuccess) {
@@ -141,20 +158,20 @@ function converter(coordsString, decimalPlaces) {
         if (matchSuccess) {
             ddLat = Math.abs(parseInt(match[2]));
             if (match[4]) {
-                ddLat += match[4] / 60;
+                ddLat += match[4].replace(',', '.') / 60;
             }
             if (match[6]) {
-                ddLat += match[6] / 3600;
+                ddLat += match[6].replace(',', '.') / 3600;
             }
             if (parseInt(match[2]) < 0) {
                 ddLat = -1 * ddLat;
             }
             ddLng = Math.abs(parseInt(match[10]));
             if (match[12]) {
-                ddLng += match[12] / 60;
+                ddLng += match[12].replace(',', '.') / 60;
             }
             if (match[14]) {
-                ddLng += match[14] / 3600;
+                ddLng += match[14].replace(',', '.') / 3600;
             }
             if (parseInt(match[10]) < 0) {
                 ddLng = -1 * ddLng;

package/dist/cjs/regex.d.ts

@@ -1,3 +1,4 @@
+export const dm_numbers: RegExp;
 export const dd_re: RegExp;
 export const dms_periods: RegExp;
 export const dms_abbr: RegExp;

package/dist/cjs/regex.js

@@ -1,7 +1,10 @@
 "use strict";
 //Coordinates pattern matching regex
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.coords_other = exports.dms_abbr = exports.dms_periods = exports.dd_re = void 0;
+exports.coords_other = exports.dms_abbr = exports.dms_periods = exports.dd_re = exports.dm_numbers = void 0;
+//DM as numbers only - see issue #15
+const dm_numbers = /([+-]?[0-8]?[0-9])\s+([0-5]?[0-9]\.\d{3,})[\s,]{1,}([+-]?[0-1]?[0-9]?[0-9])\s+([0-5]?[0-9]\.\d{3,})/;
+exports.dm_numbers = dm_numbers;
 //decimal degrees
 const dd_re = /(NORTH|SOUTH|[NS])?[\s]*([+-]?[0-8]?[0-9](?:[\.,]\d{3,}))[\s]*([•º°]?)[\s]*(NORTH|SOUTH|[NS])?[\s]*[,/;]?[\s]*(EAST|WEST|[EW])?[\s]*([+-]?[0-1]?[0-9]?[0-9](?:[\.,]\d{3,}))[\s]*([•º°]?)[\s]*(EAST|WEST|[EW])?/i;
 exports.dd_re = dd_re;

package/dist/cjs/tests/test.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const converter_js_1 = __importDefault(require("../converter.js"));
-const testformats_js_1 = __importDefault(require("../testformats.js"));
+const testformats_js_1 = __importDefault(require("./testformats.js"));
 const failFormats_js_1 = __importDefault(require("./failFormats.js"));
 let allPassed = true;
 //FORMATS THAT SHOULD BE CONVERTED

package/dist/cjs/tests/testIndividual.js

@@ -6,7 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const converter_js_1 = __importDefault(require("../converter.js"));
 //const test = '26°44S 29°46E'
 //const test = '00.00, 01.00'
-const test = `8°83S 35°67E`;
+//const test = `45°5'46.8134"N, 18°30'36.7124"E`
+//const test = `50 8.2914,-5 2.4447`
+//const test = `8°83S 35°67E`
+const test = `N 48° 30,6410', E 18° 57,4583'`;
 try {
     let converted = (0, converter_js_1.default)(test);
     console.log(converted);

package/dist/cjs/tests/testformats.js

@@ -342,6 +342,27 @@ const otherFormats = [
         verbatimLongitude: 'E 23.23.23',
         decimalLatitude: -27.759444,
         decimalLongitude: 23.38972222
+    },
+    {
+        verbatimCoordinates: '53 16.3863,4 52.8171',
+        verbatimLatitude: '53 16.3863',
+        verbatimLongitude: '4 52.8171',
+        decimalLatitude: 53.273105,
+        decimalLongitude: 4.88029
+    },
+    {
+        verbatimCoordinates: '50 8.2914,-5 2.4447',
+        verbatimLatitude: '50 8.2914',
+        verbatimLongitude: '-5 2.4447',
+        decimalLatitude: 50.13819,
+        decimalLongitude: -5.040745
+    },
+    {
+        verbatimCoordinates: `N 48° 30,6410', E 18° 57,4583'`,
+        verbatimLatitude: `N 48° 30,6410'`,
+        verbatimLongitude: `E 18° 57,4583'`,
+        decimalLatitude: 48.51068,
+        decimalLongitude: 18.95764
     }
 ];
 function getAllTestFormats() {

package/dist/cjs/toCoordinateFormat.d.ts

@@ -1,6 +1,7 @@
 export default toCoordinateFormat;
 /**
  * Converts decimalCoordinates to other formats commonly used
- * @param {*} format Either DMS or DM
+ * @param {string} format Either DMS or DM
+ * @returns {string}
  */
-declare function toCoordinateFormat(format: any): any;
+declare function toCoordinateFormat(format: string): string;

package/dist/cjs/toCoordinateFormat.js

@@ -3,7 +3,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * Converts decimalCoordinates to other formats commonly used
- * @param {*} format Either DMS or DM
+ * @param {string} format Either DMS or DM
+ * @returns {string}
  */
 function toCoordinateFormat(format) {
     if (!['DMS', 'DM', 'DD'].includes(format))

package/dist/mjs/converter.d.ts

@@ -2,13 +2,21 @@ export default converter;
 /**
  * Function for converting coordinates in a variety of formats to decimal coordinates
  * @param {string} coordsString The coordinates string to convert
- * @param {number} decimalPlaces The number of decimal places for converted coordinates; default is 5
- * @returns {object} { verbatimCoordinates, decimalCoordinates, decimalLatitude, decimalLongitude }
+ * @param {number} [decimalPlaces] The number of decimal places for converted coordinates; default is 5
+ * @returns {{verbatimCoordinates: string, decimalCoordinates: string, decimalLatitude: string, decimalLongitude: string, closeEnough: function(string): boolean, toCoordinateFormat: toCoordinateFormat}}
  */
-declare function converter(coordsString: string, decimalPlaces: number): object;
+declare function converter(coordsString: string, decimalPlaces?: number | undefined): {
+    verbatimCoordinates: string;
+    decimalCoordinates: string;
+    decimalLatitude: string;
+    decimalLongitude: string;
+    closeEnough: (arg0: string) => boolean;
+    toCoordinateFormat: typeof toCoordinateFormat;
+};
 declare namespace converter {
     export { to };
 }
+import toCoordinateFormat from './toCoordinateFormat.js';
 declare const to: Readonly<{
     DMS: "DMS";
     DM: "DM";

package/dist/mjs/converter.js

@@ -1,12 +1,12 @@
 //function for converting coordinates from a string to decimal and verbatim
 //this is just a comment
-import { dd_re, dms_periods, dms_abbr, coords_other } from './regex.js';
+import { dm_numbers, dd_re, dms_periods, dms_abbr, coords_other } from './regex.js';
 import toCoordinateFormat from './toCoordinateFormat.js';
 /**
  * Function for converting coordinates in a variety of formats to decimal coordinates
  * @param {string} coordsString The coordinates string to convert
- * @param {number} decimalPlaces The number of decimal places for converted coordinates; default is 5
- * @returns {object} { verbatimCoordinates, decimalCoordinates, decimalLatitude, decimalLongitude }
+ * @param {number} [decimalPlaces] The number of decimal places for converted coordinates; default is 5
+ * @returns {{verbatimCoordinates: string, decimalCoordinates: string, decimalLatitude: string, decimalLongitude: string, closeEnough: function(string): boolean, toCoordinateFormat: toCoordinateFormat}}
  */
 function converter(coordsString, decimalPlaces) {
     //TODO add exact match to entered string, so that it can be used to filter out superflous text around it
@@ -20,7 +20,24 @@ function converter(coordsString, decimalPlaces) {
     let lngdir = "";
     let match = [];
     let matchSuccess = false;
-    if (dd_re.test(coordsString)) {
+    if (dm_numbers.test(coordsString)) {
+        match = dm_numbers.exec(coordsString);
+        matchSuccess = checkMatch(match);
+        if (matchSuccess) {
+            ddLat = Math.abs(match[1]) + match[2] / 60;
+            if (Number(match[1]) < 0) {
+                ddLat *= -1;
+            }
+            ddLng = Math.abs(match[3]) + match[4] / 60;
+            if (Number(match[3]) < 0) {
+                ddLng *= -1;
+            }
+        }
+        else {
+            throw new Error("invalid coordinate format");
+        }
+    }
+    else if (dd_re.test(coordsString)) {
         match = dd_re.exec(coordsString);
         matchSuccess = checkMatch(match);
         if (matchSuccess) {
@@ -136,20 +153,20 @@ function converter(coordsString, decimalPlaces) {
         if (matchSuccess) {
             ddLat = Math.abs(parseInt(match[2]));
             if (match[4]) {
-                ddLat += match[4] / 60;
+                ddLat += match[4].replace(',', '.') / 60;
             }
             if (match[6]) {
-                ddLat += match[6] / 3600;
+                ddLat += match[6].replace(',', '.') / 3600;
             }
             if (parseInt(match[2]) < 0) {
                 ddLat = -1 * ddLat;
             }
             ddLng = Math.abs(parseInt(match[10]));
             if (match[12]) {
-                ddLng += match[12] / 60;
+                ddLng += match[12].replace(',', '.') / 60;
             }
             if (match[14]) {
-                ddLng += match[14] / 3600;
+                ddLng += match[14].replace(',', '.') / 3600;
             }
             if (parseInt(match[10]) < 0) {
                 ddLng = -1 * ddLng;

package/dist/mjs/regex.d.ts

@@ -1,3 +1,4 @@
+export const dm_numbers: RegExp;
 export const dd_re: RegExp;
 export const dms_periods: RegExp;
 export const dms_abbr: RegExp;

package/dist/mjs/regex.js

@@ -1,4 +1,6 @@
 //Coordinates pattern matching regex
+//DM as numbers only - see issue #15
+const dm_numbers = /([+-]?[0-8]?[0-9])\s+([0-5]?[0-9]\.\d{3,})[\s,]{1,}([+-]?[0-1]?[0-9]?[0-9])\s+([0-5]?[0-9]\.\d{3,})/;
 //decimal degrees
 const dd_re = /(NORTH|SOUTH|[NS])?[\s]*([+-]?[0-8]?[0-9](?:[\.,]\d{3,}))[\s]*([•º°]?)[\s]*(NORTH|SOUTH|[NS])?[\s]*[,/;]?[\s]*(EAST|WEST|[EW])?[\s]*([+-]?[0-1]?[0-9]?[0-9](?:[\.,]\d{3,}))[\s]*([•º°]?)[\s]*(EAST|WEST|[EW])?/i;
 //degrees minutes seconds with '.' as separator - gives array with 15 values
@@ -7,4 +9,4 @@ const dms_periods = /(NORTH|SOUTH|[NS])?\s*([+-]?[0-8]?[0-9])\s*(\.)\s*([0-5]?[0
 const dms_abbr = /(NORTH|SOUTH|[NS])?\s*([+-]?[0-8]?[0-9])\s*(D(?:EG)?(?:REES)?)\s*([0-5]?[0-9])\s*(M(?:IN)?(?:UTES)?)\s*((?:[0-5]?[0-9])(?:[\.,]\d{1,3})?)?\s*(S(?:EC)?(?:ONDS)?)?\s*(NORTH|SOUTH|[NS])?(?:\s*[,/;]\s*|\s*)(EAST|WEST|[EW])?\s*([+-]?[0-1]?[0-9]?[0-9])\s*(D(?:EG)?(?:REES)?)\s*([0-5]?[0-9])\s*(M(?:IN)?(?:UTES)?)\s*((?:[0-5]?[0-9])(?:[\.,]\d{1,3})?)?\s*(S(?:EC)?(?:ONDS)?)\s*(EAST|WEST|[EW])?/i;
 //everything else - gives array of 17 values 
 const coords_other = /(NORTH|SOUTH|[NS])?\s*([+-]?[0-8]?[0-9])\s*([•º°\.:]|D(?:EG)?(?:REES)?)?\s*,?([0-5]?[0-9](?:[\.,]\d{1,})?)?\s*(['′´’\.:]|M(?:IN)?(?:UTES)?)?\s*,?((?:[0-5]?[0-9])(?:[\.,]\d{1,3})?)?\s*(''|′′|’’|´´|["″”\.])?\s*(NORTH|SOUTH|[NS])?(?:\s*[,/;]\s*|\s*)(EAST|WEST|[EW])?\s*([+-]?[0-1]?[0-9]?[0-9])\s*([•º°\.:]|D(?:EG)?(?:REES)?)?\s*,?([0-5]?[0-9](?:[\.,]\d{1,})?)?\s*(['′´’\.:]|M(?:IN)?(?:UTES)?)?\s*,?((?:[0-5]?[0-9])(?:[\.,]\d{1,3})?)?\s*(''|′′|´´|’’|["″”\.])?\s*(EAST|WEST|[EW])?/i;
-export { dd_re, dms_periods, dms_abbr, coords_other };
+export { dm_numbers, dd_re, dms_periods, dms_abbr, coords_other };

package/dist/mjs/tests/test.js

@@ -1,5 +1,5 @@
 import convert from '../converter.js';
-import testFormats from '../testformats.js';
+import testFormats from './testformats.js';
 import failingFormats from './failFormats.js';
 let allPassed = true;
 //FORMATS THAT SHOULD BE CONVERTED

package/dist/mjs/tests/testIndividual.js

@@ -1,7 +1,10 @@
 import convert from '../converter.js';
 //const test = '26°44S 29°46E'
 //const test = '00.00, 01.00'
-const test = `8°83S 35°67E`;
+//const test = `45°5'46.8134"N, 18°30'36.7124"E`
+//const test = `50 8.2914,-5 2.4447`
+//const test = `8°83S 35°67E`
+const test = `N 48° 30,6410', E 18° 57,4583'`;
 try {
     let converted = convert(test);
     console.log(converted);

package/dist/mjs/tests/testformats.js

@@ -340,6 +340,27 @@ const otherFormats = [
         verbatimLongitude: 'E 23.23.23',
         decimalLatitude: -27.759444,
         decimalLongitude: 23.38972222
+    },
+    {
+        verbatimCoordinates: '53 16.3863,4 52.8171',
+        verbatimLatitude: '53 16.3863',
+        verbatimLongitude: '4 52.8171',
+        decimalLatitude: 53.273105,
+        decimalLongitude: 4.88029
+    },
+    {
+        verbatimCoordinates: '50 8.2914,-5 2.4447',
+        verbatimLatitude: '50 8.2914',
+        verbatimLongitude: '-5 2.4447',
+        decimalLatitude: 50.13819,
+        decimalLongitude: -5.040745
+    },
+    {
+        verbatimCoordinates: `N 48° 30,6410', E 18° 57,4583'`,
+        verbatimLatitude: `N 48° 30,6410'`,
+        verbatimLongitude: `E 18° 57,4583'`,
+        decimalLatitude: 48.51068,
+        decimalLongitude: 18.95764
     }
 ];
 function getAllTestFormats() {

package/dist/mjs/toCoordinateFormat.d.ts

@@ -1,6 +1,7 @@
 export default toCoordinateFormat;
 /**
  * Converts decimalCoordinates to other formats commonly used
- * @param {*} format Either DMS or DM
+ * @param {string} format Either DMS or DM
+ * @returns {string}
  */
-declare function toCoordinateFormat(format: any): any;
+declare function toCoordinateFormat(format: string): string;

package/dist/mjs/toCoordinateFormat.js

@@ -1,7 +1,8 @@
 //borrowed from https://www.codegrepper.com/code-examples/javascript/javascript+converting+latitude+longitude+to+gps+coordinates
 /**
  * Converts decimalCoordinates to other formats commonly used
- * @param {*} format Either DMS or DM
+ * @param {string} format Either DMS or DM
+ * @returns {string}
  */
 function toCoordinateFormat(format) {
     if (!['DMS', 'DM', 'DD'].includes(format))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geo-coordinates-parser",
-  "version": "1.6.5",
+  "version": "1.7.0",
   "description": "A Javascript function for reading a variety of coordinate formats and converting to decimal numbers. Builds on other efforts by returning the verbatim coordinates and the decimal coordinates all in one object.",
   "type": "module",
   "main": "./dist/cjs/merge.js",
@@ -12,6 +12,7 @@
     }
   },
   "scripts": {
+    "prepack": "npm run build",
     "build": "rd /s /q dist && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json && fixup.bat",
     "test": "node test.js"
   },