@accelint/geo 0.5.1 → 0.6.0

package/dist/coordinates/mgrs/parser.js

@@ -17,7 +17,40 @@ import Mgrs from "geodesy/mgrs";
 
 //#region src/coordinates/mgrs/parser.ts
 const PATTERN_PARTS = /^((?:..?)?)(\w?)\s*((?:\w{2})?)\s*(?:(\d+(?:\.\d*)?)?)\s*(?:(\d+(?:\.\d*)?)?)$/i;
+/**
+* Creates a parse error result with a formatted error message.
+*
+* @param message - The error message describing what went wrong.
+* @returns Parse results tuple with empty data array and error message array.
+*
+* @example
+* ```typescript
+* error('Invalid UTM zone');
+* // [[], ['Invalid UTM zone; expected format DDZ AA DDD DDD.']]
+* ```
+*/
 const error = (message) => [[], [`${violation(message)}; expected format DDZ AA DDD DDD.`]];
+/**
+* Validates MGRS coordinate input and returns detailed error messages for invalid formats.
+*
+* Checks UTM zone number, latitude band letter, 100K meter square identification, and
+* numerical location components. Returns specific error messages for each validation failure.
+*
+* @param input - The MGRS coordinate string to validate.
+* @returns Parse results with detailed error messages for validation failures.
+*
+* @example
+* ```typescript
+* detailedErrors('99Z AA 12345 67890');
+* // [[], ['Invalid UTM zone number (99) found in grid zone designation; expected format DDZ AA DDD DDD.']]
+* ```
+*
+* @example
+* ```typescript
+* detailedErrors('31U BF 12345 67890');
+* // Valid format, parsed successfully
+* ```
+*/
 function detailedErrors(input) {
 	if (!input) return error("No input provided");
 	const [utm, bnd, hkm, east, north] = (input.trim().replace(/\s+/g, " ").match(PATTERN_PARTS) ?? []).slice(1);
@@ -27,6 +60,29 @@ function detailedErrors(input) {
 	if (!(east && north && +east > 0 && +north > 0)) return error(`Invalid numerical location (${[east, north].join()}) found`);
 	return error("Uncaught error condition.");
 }
+/**
+* Parses a Military Grid Reference System (MGRS) coordinate string into latitude/longitude values.
+*
+* Converts MGRS coordinates to UTM, then to latitude/longitude decimal degrees. Returns
+* detailed error messages for invalid MGRS formats including zone numbers, band letters,
+* square identification, and numerical locations.
+*
+* @param _format - Format parameter (unused, MGRS has fixed format).
+* @param input - The MGRS coordinate string to parse (e.g., '31U BF 12345 67890').
+* @returns Parse results with coordinate values or detailed error messages.
+*
+* @example
+* ```typescript
+* parseMGRS(null, '31U BF 12345 67890');
+* // [[['48.123456', 'N'], ['11.234567', 'E']], []]
+* ```
+*
+* @example
+* ```typescript
+* parseMGRS(null, 'invalid');
+* // [[], ['Invalid UTM zone number found...']]
+* ```
+*/
 function parseMGRS(_format, input) {
 	try {
 		const point = Mgrs.parse(input).toUtm().toLatLon();

package/dist/coordinates/mgrs/parser.js.map

@@ -1 +1 @@
-{"version":3,"file":"parser.js","names":[],"sources":["../../../src/coordinates/mgrs/parser.ts"],"sourcesContent":["/*\n * Copyright 2024 Hypergiant Galactic Systems Inc. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport Mgrs from 'geodesy/mgrs';\nimport { type ParseResults, parse } from '../latlon/internal/parse';\nimport { violation } from '../latlon/internal/violation';\n\ntype Match = [string, string, string, string, string];\n\nconst PATTERN_PARTS =\n  /^((?:..?)?)(\\w?)\\s*((?:\\w{2})?)\\s*(?:(\\d+(?:\\.\\d*)?)?)\\s*(?:(\\d+(?:\\.\\d*)?)?)$/i;\n\nconst error = (message: string) =>\n  [\n    [],\n    [`${violation(message)}; expected format DDZ AA DDD DDD.`],\n  ] as ParseResults;\n\nfunction detailedErrors(input: string) {\n  if (!input) {\n    return error('No input provided');\n  }\n\n  const [utm, bnd, hkm, east, north] = (\n    input.trim().replace(/\\s+/g, ' ').match(PATTERN_PARTS) ?? []\n  ).slice(1) as Match;\n\n  if (!utm || +utm > 60 || +utm < 1) {\n    return error(\n      `Invalid UTM zone number (${utm}) found in grid zone designation`,\n    );\n  }\n\n  if (!/[C-HJ-NP-X]/i.test(bnd)) {\n    return error(\n      `Invalid Latitude band letter (${bnd}) found in grid zone designation`,\n    );\n  }\n\n  if (!/^[A-HJ-NP-Z]*$/i.test(hkm)) {\n    return error(`Invalid 100K m square identification (${hkm}) found`);\n  }\n\n  if (!(east && north && +east > 0 && +north > 0)) {\n    return error(`Invalid numerical location (${[east, north].join()}) found`);\n  }\n\n  return error('Uncaught error condition.');\n}\n\n// biome-ignore lint/suspicious/noExplicitAny: Format is unused\nexport function parseMGRS(_format: any, input: string) {\n  try {\n    const point = Mgrs.parse(input).toUtm().toLatLon();\n\n    return parse(`${point.lat} / ${point.lon}`, 'LATLON');\n  } catch (_e) {\n    return detailedErrors(input);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAkBA,MAAM,gBACJ;AAEF,MAAM,SAAS,YACb,CACE,EAAE,EACF,CAAC,GAAG,UAAU,QAAQ,CAAC,mCAAmC,CAC3D;AAEH,SAAS,eAAe,OAAe;AACrC,KAAI,CAAC,MACH,QAAO,MAAM,oBAAoB;CAGnC,MAAM,CAAC,KAAK,KAAK,KAAK,MAAM,UAC1B,MAAM,MAAM,CAAC,QAAQ,QAAQ,IAAI,CAAC,MAAM,cAAc,IAAI,EAAE,EAC5D,MAAM,EAAE;AAEV,KAAI,CAAC,OAAO,CAAC,MAAM,MAAM,CAAC,MAAM,EAC9B,QAAO,MACL,4BAA4B,IAAI,kCACjC;AAGH,KAAI,CAAC,eAAe,KAAK,IAAI,CAC3B,QAAO,MACL,iCAAiC,IAAI,kCACtC;AAGH,KAAI,CAAC,kBAAkB,KAAK,IAAI,CAC9B,QAAO,MAAM,yCAAyC,IAAI,SAAS;AAGrE,KAAI,EAAE,QAAQ,SAAS,CAAC,OAAO,KAAK,CAAC,QAAQ,GAC3C,QAAO,MAAM,+BAA+B,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS;AAG5E,QAAO,MAAM,4BAA4B;;AAI3C,SAAgB,UAAU,SAAc,OAAe;AACrD,KAAI;EACF,MAAM,QAAQ,KAAK,MAAM,MAAM,CAAC,OAAO,CAAC,UAAU;AAElD,SAAO,MAAM,GAAG,MAAM,IAAI,KAAK,MAAM,OAAO,SAAS;UAC9C,IAAI;AACX,SAAO,eAAe,MAAM"}
+{"version":3,"file":"parser.js","names":[],"sources":["../../../src/coordinates/mgrs/parser.ts"],"sourcesContent":["/*\n * Copyright 2024 Hypergiant Galactic Systems Inc. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport Mgrs from 'geodesy/mgrs';\nimport { type ParseResults, parse } from '../latlon/internal/parse';\nimport { violation } from '../latlon/internal/violation';\n\ntype Match = [string, string, string, string, string];\n\nconst PATTERN_PARTS =\n  /^((?:..?)?)(\\w?)\\s*((?:\\w{2})?)\\s*(?:(\\d+(?:\\.\\d*)?)?)\\s*(?:(\\d+(?:\\.\\d*)?)?)$/i;\n\n/**\n * Creates a parse error result with a formatted error message.\n *\n * @param message - The error message describing what went wrong.\n * @returns Parse results tuple with empty data array and error message array.\n *\n * @example\n * ```typescript\n * error('Invalid UTM zone');\n * // [[], ['Invalid UTM zone; expected format DDZ AA DDD DDD.']]\n * ```\n */\nconst error = (message: string) =>\n  [\n    [],\n    [`${violation(message)}; expected format DDZ AA DDD DDD.`],\n  ] as ParseResults;\n\n/**\n * Validates MGRS coordinate input and returns detailed error messages for invalid formats.\n *\n * Checks UTM zone number, latitude band letter, 100K meter square identification, and\n * numerical location components. Returns specific error messages for each validation failure.\n *\n * @param input - The MGRS coordinate string to validate.\n * @returns Parse results with detailed error messages for validation failures.\n *\n * @example\n * ```typescript\n * detailedErrors('99Z AA 12345 67890');\n * // [[], ['Invalid UTM zone number (99) found in grid zone designation; expected format DDZ AA DDD DDD.']]\n * ```\n *\n * @example\n * ```typescript\n * detailedErrors('31U BF 12345 67890');\n * // Valid format, parsed successfully\n * ```\n */\nfunction detailedErrors(input: string) {\n  if (!input) {\n    return error('No input provided');\n  }\n\n  const [utm, bnd, hkm, east, north] = (\n    input.trim().replace(/\\s+/g, ' ').match(PATTERN_PARTS) ?? []\n  ).slice(1) as Match;\n\n  if (!utm || +utm > 60 || +utm < 1) {\n    return error(\n      `Invalid UTM zone number (${utm}) found in grid zone designation`,\n    );\n  }\n\n  if (!/[C-HJ-NP-X]/i.test(bnd)) {\n    return error(\n      `Invalid Latitude band letter (${bnd}) found in grid zone designation`,\n    );\n  }\n\n  if (!/^[A-HJ-NP-Z]*$/i.test(hkm)) {\n    return error(`Invalid 100K m square identification (${hkm}) found`);\n  }\n\n  if (!(east && north && +east > 0 && +north > 0)) {\n    return error(`Invalid numerical location (${[east, north].join()}) found`);\n  }\n\n  return error('Uncaught error condition.');\n}\n\n/**\n * Parses a Military Grid Reference System (MGRS) coordinate string into latitude/longitude values.\n *\n * Converts MGRS coordinates to UTM, then to latitude/longitude decimal degrees. Returns\n * detailed error messages for invalid MGRS formats including zone numbers, band letters,\n * square identification, and numerical locations.\n *\n * @param _format - Format parameter (unused, MGRS has fixed format).\n * @param input - The MGRS coordinate string to parse (e.g., '31U BF 12345 67890').\n * @returns Parse results with coordinate values or detailed error messages.\n *\n * @example\n * ```typescript\n * parseMGRS(null, '31U BF 12345 67890');\n * // [[['48.123456', 'N'], ['11.234567', 'E']], []]\n * ```\n *\n * @example\n * ```typescript\n * parseMGRS(null, 'invalid');\n * // [[], ['Invalid UTM zone number found...']]\n * ```\n */\n// biome-ignore lint/suspicious/noExplicitAny: Format is unused\nexport function parseMGRS(_format: any, input: string) {\n  try {\n    const point = Mgrs.parse(input).toUtm().toLatLon();\n\n    return parse(`${point.lat} / ${point.lon}`, 'LATLON');\n  } catch (_e) {\n    return detailedErrors(input);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAkBA,MAAM,gBACJ;;;;;;;;;;;;;AAcF,MAAM,SAAS,YACb,CACE,EAAE,EACF,CAAC,GAAG,UAAU,QAAQ,CAAC,mCAAmC,CAC3D;;;;;;;;;;;;;;;;;;;;;;AAuBH,SAAS,eAAe,OAAe;AACrC,KAAI,CAAC,MACH,QAAO,MAAM,oBAAoB;CAGnC,MAAM,CAAC,KAAK,KAAK,KAAK,MAAM,UAC1B,MAAM,MAAM,CAAC,QAAQ,QAAQ,IAAI,CAAC,MAAM,cAAc,IAAI,EAAE,EAC5D,MAAM,EAAE;AAEV,KAAI,CAAC,OAAO,CAAC,MAAM,MAAM,CAAC,MAAM,EAC9B,QAAO,MACL,4BAA4B,IAAI,kCACjC;AAGH,KAAI,CAAC,eAAe,KAAK,IAAI,CAC3B,QAAO,MACL,iCAAiC,IAAI,kCACtC;AAGH,KAAI,CAAC,kBAAkB,KAAK,IAAI,CAC9B,QAAO,MAAM,yCAAyC,IAAI,SAAS;AAGrE,KAAI,EAAE,QAAQ,SAAS,CAAC,OAAO,KAAK,CAAC,QAAQ,GAC3C,QAAO,MAAM,+BAA+B,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS;AAG5E,QAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;AA2B3C,SAAgB,UAAU,SAAc,OAAe;AACrD,KAAI;EACF,MAAM,QAAQ,KAAK,MAAM,MAAM,CAAC,OAAO,CAAC,UAAU;AAElD,SAAO,MAAM,GAAG,MAAM,IAAI,KAAK,MAAM,OAAO,SAAS;UAC9C,IAAI;AACX,SAAO,eAAe,MAAM"}

package/dist/coordinates/mgrs/system.d.ts

@@ -13,6 +13,37 @@
 import { CoordinateSystem } from "../latlon/internal/coordinate-system.js";
 
 //#region src/coordinates/mgrs/system.d.ts
+
+/**
+ * Military Grid Reference System (MGRS) coordinate system implementation.
+ *
+ * Provides parsing, conversion, and formatting for MGRS coordinates. MGRS is a geocoordinate
+ * standard used by NATO militaries for locating points on Earth, based on the UTM coordinate
+ * system. Format: Grid Zone Designation + 100km Square ID + Numerical Location (e.g., '31U BF 12345 67890').
+ *
+ * @property name - Human-readable name: 'Military Grid Reference System'.
+ * @property parse - Parses MGRS coordinate strings into latitude/longitude values.
+ * @property toFloat - Converts coordinate component with bearing to signed float value.
+ * @property toFormat - Formats latitude/longitude pair back to MGRS coordinate string.
+ *
+ * @example
+ * ```typescript
+ * systemMGRS.parse(null, '31U BF 12345 67890');
+ * // [[['48.123456', 'N'], ['11.234567', 'E']], []]
+ * ```
+ *
+ * @example
+ * ```typescript
+ * systemMGRS.toFormat('LATLON', [48.123456, 11.234567]);
+ * // '31U BF 12345 67890'
+ * ```
+ *
+ * @example
+ * ```typescript
+ * systemMGRS.toFloat(['48.123456', 'N']);
+ * // 48.123456
+ * ```
+ */
 declare const systemMGRS: CoordinateSystem;
 //#endregion
 export { systemMGRS };

package/dist/coordinates/mgrs/system.js

@@ -16,6 +16,36 @@ import { parseMGRS } from "./parser.js";
 import { LatLon } from "geodesy/mgrs";
 
 //#region src/coordinates/mgrs/system.ts
+/**
+* Military Grid Reference System (MGRS) coordinate system implementation.
+*
+* Provides parsing, conversion, and formatting for MGRS coordinates. MGRS is a geocoordinate
+* standard used by NATO militaries for locating points on Earth, based on the UTM coordinate
+* system. Format: Grid Zone Designation + 100km Square ID + Numerical Location (e.g., '31U BF 12345 67890').
+*
+* @property name - Human-readable name: 'Military Grid Reference System'.
+* @property parse - Parses MGRS coordinate strings into latitude/longitude values.
+* @property toFloat - Converts coordinate component with bearing to signed float value.
+* @property toFormat - Formats latitude/longitude pair back to MGRS coordinate string.
+*
+* @example
+* ```typescript
+* systemMGRS.parse(null, '31U BF 12345 67890');
+* // [[['48.123456', 'N'], ['11.234567', 'E']], []]
+* ```
+*
+* @example
+* ```typescript
+* systemMGRS.toFormat('LATLON', [48.123456, 11.234567]);
+* // '31U BF 12345 67890'
+* ```
+*
+* @example
+* ```typescript
+* systemMGRS.toFloat(['48.123456', 'N']);
+* // 48.123456
+* ```
+*/
 const systemMGRS = {
 	name: "Military Grid Reference System",
 	parse: parseMGRS,

package/dist/coordinates/mgrs/system.js.map

@@ -1 +1 @@
-{"version":3,"file":"system.js","names":["systemMGRS: CoordinateSystem"],"sources":["../../../src/coordinates/mgrs/system.ts"],"sourcesContent":["// __private-exports\n/*\n * Copyright 2024 Hypergiant Galactic Systems Inc. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport { LatLon } from 'geodesy/mgrs';\nimport { type Compass, type Format, SYMBOL_PATTERNS } from '../latlon/internal';\nimport { parseMGRS } from './parser';\nimport type { CoordinateSystem } from '../latlon/internal/coordinate-system';\n\nexport const systemMGRS: CoordinateSystem = {\n  name: 'Military Grid Reference System',\n\n  parse: parseMGRS,\n\n  toFloat(arg) {\n    const [num, bear] = arg as [string, Compass];\n\n    return (\n      Number.parseFloat(num) *\n      (SYMBOL_PATTERNS.NEGATIVE_BEARINGS.test(bear) ? -1 : 1)\n    );\n  },\n\n  toFormat(format: Format, [left, right]: [number, number]) {\n    const { LAT, LON } = Object.fromEntries([\n      [format.slice(0, 3), left],\n      [format.slice(3), right],\n    ]) as Record<'LAT' | 'LON', number>;\n\n    const latlon = new LatLon(LAT, LON);\n\n    return latlon.toUtm().toMgrs().toString();\n  },\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAkBA,MAAaA,aAA+B;CAC1C,MAAM;CAEN,OAAO;CAEP,QAAQ,KAAK;EACX,MAAM,CAAC,KAAK,QAAQ;AAEpB,SACE,OAAO,WAAW,IAAI,IACrB,gBAAgB,kBAAkB,KAAK,KAAK,GAAG,KAAK;;CAIzD,SAAS,QAAgB,CAAC,MAAM,QAA0B;EACxD,MAAM,EAAE,KAAK,QAAQ,OAAO,YAAY,CACtC,CAAC,OAAO,MAAM,GAAG,EAAE,EAAE,KAAK,EAC1B,CAAC,OAAO,MAAM,EAAE,EAAE,MAAM,CACzB,CAAC;AAIF,SAFe,IAAI,OAAO,KAAK,IAAI,CAErB,OAAO,CAAC,QAAQ,CAAC,UAAU;;CAE5C"}
+{"version":3,"file":"system.js","names":["systemMGRS: CoordinateSystem"],"sources":["../../../src/coordinates/mgrs/system.ts"],"sourcesContent":["// __private-exports\n/*\n * Copyright 2024 Hypergiant Galactic Systems Inc. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport { LatLon } from 'geodesy/mgrs';\nimport { type Compass, type Format, SYMBOL_PATTERNS } from '../latlon/internal';\nimport { parseMGRS } from './parser';\nimport type { CoordinateSystem } from '../latlon/internal/coordinate-system';\n\n/**\n * Military Grid Reference System (MGRS) coordinate system implementation.\n *\n * Provides parsing, conversion, and formatting for MGRS coordinates. MGRS is a geocoordinate\n * standard used by NATO militaries for locating points on Earth, based on the UTM coordinate\n * system. Format: Grid Zone Designation + 100km Square ID + Numerical Location (e.g., '31U BF 12345 67890').\n *\n * @property name - Human-readable name: 'Military Grid Reference System'.\n * @property parse - Parses MGRS coordinate strings into latitude/longitude values.\n * @property toFloat - Converts coordinate component with bearing to signed float value.\n * @property toFormat - Formats latitude/longitude pair back to MGRS coordinate string.\n *\n * @example\n * ```typescript\n * systemMGRS.parse(null, '31U BF 12345 67890');\n * // [[['48.123456', 'N'], ['11.234567', 'E']], []]\n * ```\n *\n * @example\n * ```typescript\n * systemMGRS.toFormat('LATLON', [48.123456, 11.234567]);\n * // '31U BF 12345 67890'\n * ```\n *\n * @example\n * ```typescript\n * systemMGRS.toFloat(['48.123456', 'N']);\n * // 48.123456\n * ```\n */\nexport const systemMGRS: CoordinateSystem = {\n  name: 'Military Grid Reference System',\n\n  parse: parseMGRS,\n\n  toFloat(arg) {\n    const [num, bear] = arg as [string, Compass];\n\n    return (\n      Number.parseFloat(num) *\n      (SYMBOL_PATTERNS.NEGATIVE_BEARINGS.test(bear) ? -1 : 1)\n    );\n  },\n\n  toFormat(format: Format, [left, right]: [number, number]) {\n    const { LAT, LON } = Object.fromEntries([\n      [format.slice(0, 3), left],\n      [format.slice(3), right],\n    ]) as Record<'LAT' | 'LON', number>;\n\n    const latlon = new LatLon(LAT, LON);\n\n    return latlon.toUtm().toMgrs().toString();\n  },\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgDA,MAAaA,aAA+B;CAC1C,MAAM;CAEN,OAAO;CAEP,QAAQ,KAAK;EACX,MAAM,CAAC,KAAK,QAAQ;AAEpB,SACE,OAAO,WAAW,IAAI,IACrB,gBAAgB,kBAAkB,KAAK,KAAK,GAAG,KAAK;;CAIzD,SAAS,QAAgB,CAAC,MAAM,QAA0B;EACxD,MAAM,EAAE,KAAK,QAAQ,OAAO,YAAY,CACtC,CAAC,OAAO,MAAM,GAAG,EAAE,EAAE,KAAK,EAC1B,CAAC,OAAO,MAAM,EAAE,EAAE,MAAM,CACzB,CAAC;AAIF,SAFe,IAAI,OAAO,KAAK,IAAI,CAErB,OAAO,CAAC,QAAQ,CAAC,UAAU;;CAE5C"}

package/dist/coordinates/utm/parser.d.ts

@@ -13,6 +13,30 @@
 import { ParseResults } from "../latlon/internal/parse.js";
 
 //#region src/coordinates/utm/parser.d.ts
+
+/**
+ * Parses UTM (Universal Transverse Mercator) coordinate string into lat/lon format.
+ *
+ * Accepts UTM coordinates in format "ZZ N|S EEEEE NNNNN" where ZZ is zone (1-60),
+ * N|S is hemisphere, EEEEE is easting, and NNNNN is northing. Converts to
+ * latitude/longitude using the geodesy library.
+ *
+ * @param _format - Unused format parameter (kept for interface compatibility).
+ * @param input - UTM coordinate string to parse.
+ * @returns ParseResults with lat/lon tokens or error messages.
+ *
+ * @example
+ * ```typescript
+ * parseUTM(null, '18N 585628 4511644');
+ * // [['40.7128', '/', '-74.0060'], []]
+ * ```
+ *
+ * @example
+ * ```typescript
+ * parseUTM(null, '65N 585628 4511644');
+ * // [[], ['[ERROR] Invalid Zone number (65) found; expected format ZZ N|S DDD DDD.']]
+ * ```
+ */
 declare function parseUTM(_format: any, input: string): ParseResults;
 //#endregion
 export { parseUTM };

package/dist/coordinates/utm/parser.js

@@ -17,7 +17,40 @@ import Utm from "geodesy/utm";
 
 //#region src/coordinates/utm/parser.ts
 const PATTERN_PARTS = /^((?:..)?)\s*(\w?)\s*(?:(\d+(?:\.\d*)?)?)\s*(?:(\d+(?:\.\d*)?)?)$/i;
+/**
+* Creates a ParseResults error tuple with formatted message.
+*
+* @param message - Error message describing the parsing failure.
+* @returns ParseResults tuple with empty tokens array and formatted error message.
+*
+* @example
+* ```typescript
+* error('Invalid Zone number (65) found');
+* // [[], ['[ERROR] Invalid Zone number (65) found; expected format ZZ N|S DDD DDD.']]
+* ```
+*/
 const error = (message) => [[], [`${violation(message)}; expected format ZZ N|S DDD DDD.`]];
+/**
+* Validates UTM coordinate components and returns detailed error messages.
+*
+* Checks zone number (1-60), latitude band letter (N/S), easting, and northing values
+* for validity and returns specific error messages for each invalid component.
+*
+* @param input - UTM coordinate string to validate.
+* @returns ParseResults with empty tokens and detailed error message.
+*
+* @example
+* ```typescript
+* detailedErrors('65N 585628 4511644');
+* // [[], ['[ERROR] Invalid Zone number (65) found; expected format ZZ N|S DDD DDD.']]
+* ```
+*
+* @example
+* ```typescript
+* detailedErrors('18X 585628 4511644');
+* // [[], ['[ERROR] Invalid Latitude band letter (X) found; expected format ZZ N|S DDD DDD.']]
+* ```
+*/
 function detailedErrors(input) {
 	const [zone, band, east, north] = (input.trim().replace(/\s+/g, " ").match(PATTERN_PARTS) ?? []).slice(1);
 	if (!zone || +zone > 60 || +zone < 1) return error(`Invalid Zone number (${zone}) found`);
@@ -26,6 +59,29 @@ function detailedErrors(input) {
 	if (!(north || +north >= 0)) return error(`Invalid Northing number (${north ?? ""}) found`);
 	return error("Uncaught error condition.");
 }
+/**
+* Parses UTM (Universal Transverse Mercator) coordinate string into lat/lon format.
+*
+* Accepts UTM coordinates in format "ZZ N|S EEEEE NNNNN" where ZZ is zone (1-60),
+* N|S is hemisphere, EEEEE is easting, and NNNNN is northing. Converts to
+* latitude/longitude using the geodesy library.
+*
+* @param _format - Unused format parameter (kept for interface compatibility).
+* @param input - UTM coordinate string to parse.
+* @returns ParseResults with lat/lon tokens or error messages.
+*
+* @example
+* ```typescript
+* parseUTM(null, '18N 585628 4511644');
+* // [['40.7128', '/', '-74.0060'], []]
+* ```
+*
+* @example
+* ```typescript
+* parseUTM(null, '65N 585628 4511644');
+* // [[], ['[ERROR] Invalid Zone number (65) found; expected format ZZ N|S DDD DDD.']]
+* ```
+*/
 function parseUTM(_format, input) {
 	try {
 		const normalized = input.trim().replace(/^(\d{1,2})([NS])\s+/i, "$1 $2 ");

package/dist/coordinates/utm/parser.js.map

@@ -1 +1 @@
-{"version":3,"file":"parser.js","names":[],"sources":["../../../src/coordinates/utm/parser.ts"],"sourcesContent":["/*\n * Copyright 2024 Hypergiant Galactic Systems Inc. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport Utm from 'geodesy/utm';\nimport { type ParseResults, parse } from '../latlon/internal/parse';\nimport { violation } from '../latlon/internal/violation';\n\ntype Match = [string, string, string, string];\n\nconst PATTERN_PARTS =\n  /^((?:..)?)\\s*(\\w?)\\s*(?:(\\d+(?:\\.\\d*)?)?)\\s*(?:(\\d+(?:\\.\\d*)?)?)$/i;\n\nconst error = (message: string) =>\n  [\n    [],\n    [`${violation(message)}; expected format ZZ N|S DDD DDD.`],\n  ] as ParseResults;\n\nfunction detailedErrors(input: string) {\n  const [zone, band, east, north] = (\n    input.trim().replace(/\\s+/g, ' ').match(PATTERN_PARTS) ?? []\n  ).slice(1) as Match;\n\n  if (!zone || +zone > 60 || +zone < 1) {\n    return error(`Invalid Zone number (${zone}) found`);\n  }\n\n  if (!/[NS]/i.test(band)) {\n    return error(`Invalid Latitude band letter (${band}) found`);\n  }\n\n  if (!(east || +east >= 0)) {\n    return error(`Invalid Easting number (${east ?? ''}) found`);\n  }\n\n  if (!(north || +north >= 0)) {\n    return error(`Invalid Northing number (${north ?? ''}) found`);\n  }\n\n  return error('Uncaught error condition.');\n}\n\n// biome-ignore lint/suspicious/noExplicitAny: Format is unused\nexport function parseUTM(_format: any, input: string) {\n  try {\n    // Preprocess: ensure space between zone and hemisphere for geodesy parser\n    // Convert \"18N 585628 4511644\" to \"18 N 585628 4511644\"\n    // The geodesy library requires 4 space-separated elements\n    const normalized = input.trim().replace(/^(\\d{1,2})([NS])\\s+/i, '$1 $2 ');\n\n    const utm = Utm.parse(normalized);\n    const latlon = utm.toLatLon();\n\n    return parse(`${latlon.lat} / ${latlon.lon}`, 'LATLON');\n  } catch (_) {\n    return detailedErrors(input);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAkBA,MAAM,gBACJ;AAEF,MAAM,SAAS,YACb,CACE,EAAE,EACF,CAAC,GAAG,UAAU,QAAQ,CAAC,mCAAmC,CAC3D;AAEH,SAAS,eAAe,OAAe;CACrC,MAAM,CAAC,MAAM,MAAM,MAAM,UACvB,MAAM,MAAM,CAAC,QAAQ,QAAQ,IAAI,CAAC,MAAM,cAAc,IAAI,EAAE,EAC5D,MAAM,EAAE;AAEV,KAAI,CAAC,QAAQ,CAAC,OAAO,MAAM,CAAC,OAAO,EACjC,QAAO,MAAM,wBAAwB,KAAK,SAAS;AAGrD,KAAI,CAAC,QAAQ,KAAK,KAAK,CACrB,QAAO,MAAM,iCAAiC,KAAK,SAAS;AAG9D,KAAI,EAAE,QAAQ,CAAC,QAAQ,GACrB,QAAO,MAAM,2BAA2B,QAAQ,GAAG,SAAS;AAG9D,KAAI,EAAE,SAAS,CAAC,SAAS,GACvB,QAAO,MAAM,4BAA4B,SAAS,GAAG,SAAS;AAGhE,QAAO,MAAM,4BAA4B;;AAI3C,SAAgB,SAAS,SAAc,OAAe;AACpD,KAAI;EAIF,MAAM,aAAa,MAAM,MAAM,CAAC,QAAQ,wBAAwB,SAAS;EAGzE,MAAM,SADM,IAAI,MAAM,WAAW,CACd,UAAU;AAE7B,SAAO,MAAM,GAAG,OAAO,IAAI,KAAK,OAAO,OAAO,SAAS;UAChD,GAAG;AACV,SAAO,eAAe,MAAM"}
+{"version":3,"file":"parser.js","names":[],"sources":["../../../src/coordinates/utm/parser.ts"],"sourcesContent":["/*\n * Copyright 2024 Hypergiant Galactic Systems Inc. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport Utm from 'geodesy/utm';\nimport { type ParseResults, parse } from '../latlon/internal/parse';\nimport { violation } from '../latlon/internal/violation';\n\ntype Match = [string, string, string, string];\n\nconst PATTERN_PARTS =\n  /^((?:..)?)\\s*(\\w?)\\s*(?:(\\d+(?:\\.\\d*)?)?)\\s*(?:(\\d+(?:\\.\\d*)?)?)$/i;\n\n/**\n * Creates a ParseResults error tuple with formatted message.\n *\n * @param message - Error message describing the parsing failure.\n * @returns ParseResults tuple with empty tokens array and formatted error message.\n *\n * @example\n * ```typescript\n * error('Invalid Zone number (65) found');\n * // [[], ['[ERROR] Invalid Zone number (65) found; expected format ZZ N|S DDD DDD.']]\n * ```\n */\nconst error = (message: string) =>\n  [\n    [],\n    [`${violation(message)}; expected format ZZ N|S DDD DDD.`],\n  ] as ParseResults;\n\n/**\n * Validates UTM coordinate components and returns detailed error messages.\n *\n * Checks zone number (1-60), latitude band letter (N/S), easting, and northing values\n * for validity and returns specific error messages for each invalid component.\n *\n * @param input - UTM coordinate string to validate.\n * @returns ParseResults with empty tokens and detailed error message.\n *\n * @example\n * ```typescript\n * detailedErrors('65N 585628 4511644');\n * // [[], ['[ERROR] Invalid Zone number (65) found; expected format ZZ N|S DDD DDD.']]\n * ```\n *\n * @example\n * ```typescript\n * detailedErrors('18X 585628 4511644');\n * // [[], ['[ERROR] Invalid Latitude band letter (X) found; expected format ZZ N|S DDD DDD.']]\n * ```\n */\nfunction detailedErrors(input: string) {\n  const [zone, band, east, north] = (\n    input.trim().replace(/\\s+/g, ' ').match(PATTERN_PARTS) ?? []\n  ).slice(1) as Match;\n\n  if (!zone || +zone > 60 || +zone < 1) {\n    return error(`Invalid Zone number (${zone}) found`);\n  }\n\n  if (!/[NS]/i.test(band)) {\n    return error(`Invalid Latitude band letter (${band}) found`);\n  }\n\n  if (!(east || +east >= 0)) {\n    return error(`Invalid Easting number (${east ?? ''}) found`);\n  }\n\n  if (!(north || +north >= 0)) {\n    return error(`Invalid Northing number (${north ?? ''}) found`);\n  }\n\n  return error('Uncaught error condition.');\n}\n\n/**\n * Parses UTM (Universal Transverse Mercator) coordinate string into lat/lon format.\n *\n * Accepts UTM coordinates in format \"ZZ N|S EEEEE NNNNN\" where ZZ is zone (1-60),\n * N|S is hemisphere, EEEEE is easting, and NNNNN is northing. Converts to\n * latitude/longitude using the geodesy library.\n *\n * @param _format - Unused format parameter (kept for interface compatibility).\n * @param input - UTM coordinate string to parse.\n * @returns ParseResults with lat/lon tokens or error messages.\n *\n * @example\n * ```typescript\n * parseUTM(null, '18N 585628 4511644');\n * // [['40.7128', '/', '-74.0060'], []]\n * ```\n *\n * @example\n * ```typescript\n * parseUTM(null, '65N 585628 4511644');\n * // [[], ['[ERROR] Invalid Zone number (65) found; expected format ZZ N|S DDD DDD.']]\n * ```\n */\n// biome-ignore lint/suspicious/noExplicitAny: Format is unused\nexport function parseUTM(_format: any, input: string) {\n  try {\n    // Preprocess: ensure space between zone and hemisphere for geodesy parser\n    // Convert \"18N 585628 4511644\" to \"18 N 585628 4511644\"\n    // The geodesy library requires 4 space-separated elements\n    const normalized = input.trim().replace(/^(\\d{1,2})([NS])\\s+/i, '$1 $2 ');\n\n    const utm = Utm.parse(normalized);\n    const latlon = utm.toLatLon();\n\n    return parse(`${latlon.lat} / ${latlon.lon}`, 'LATLON');\n  } catch (_) {\n    return detailedErrors(input);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAkBA,MAAM,gBACJ;;;;;;;;;;;;;AAcF,MAAM,SAAS,YACb,CACE,EAAE,EACF,CAAC,GAAG,UAAU,QAAQ,CAAC,mCAAmC,CAC3D;;;;;;;;;;;;;;;;;;;;;;AAuBH,SAAS,eAAe,OAAe;CACrC,MAAM,CAAC,MAAM,MAAM,MAAM,UACvB,MAAM,MAAM,CAAC,QAAQ,QAAQ,IAAI,CAAC,MAAM,cAAc,IAAI,EAAE,EAC5D,MAAM,EAAE;AAEV,KAAI,CAAC,QAAQ,CAAC,OAAO,MAAM,CAAC,OAAO,EACjC,QAAO,MAAM,wBAAwB,KAAK,SAAS;AAGrD,KAAI,CAAC,QAAQ,KAAK,KAAK,CACrB,QAAO,MAAM,iCAAiC,KAAK,SAAS;AAG9D,KAAI,EAAE,QAAQ,CAAC,QAAQ,GACrB,QAAO,MAAM,2BAA2B,QAAQ,GAAG,SAAS;AAG9D,KAAI,EAAE,SAAS,CAAC,SAAS,GACvB,QAAO,MAAM,4BAA4B,SAAS,GAAG,SAAS;AAGhE,QAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;AA2B3C,SAAgB,SAAS,SAAc,OAAe;AACpD,KAAI;EAIF,MAAM,aAAa,MAAM,MAAM,CAAC,QAAQ,wBAAwB,SAAS;EAGzE,MAAM,SADM,IAAI,MAAM,WAAW,CACd,UAAU;AAE7B,SAAO,MAAM,GAAG,OAAO,IAAI,KAAK,OAAO,OAAO,SAAS;UAChD,GAAG;AACV,SAAO,eAAe,MAAM"}

package/dist/coordinates/utm/system.d.ts

@@ -13,6 +13,27 @@
 import { CoordinateSystem } from "../latlon/internal/coordinate-system.js";
 
 //#region src/coordinates/utm/system.d.ts
+
+/**
+ * Universal Transverse Mercator (UTM) coordinate system implementation.
+ *
+ * Provides parsing, conversion, and formatting for UTM coordinates. UTM divides
+ * the Earth into 60 zones, each 6 degrees of longitude wide, using a transverse
+ * Mercator projection. Coordinates are expressed as zone number, hemisphere (N/S),
+ * easting, and northing values.
+ *
+ * @example
+ * ```typescript
+ * systemUTM.parse(null, '18N 585628 4511644');
+ * // [['40.7128', '/', '-74.0060'], []]
+ * ```
+ *
+ * @example
+ * ```typescript
+ * systemUTM.toFormat('LATLON', [40.7128, -74.0060]);
+ * // '18N 585628 4511644'
+ * ```
+ */
 declare const systemUTM: CoordinateSystem;
 //#endregion
 export { systemUTM };

package/dist/coordinates/utm/system.js

@@ -16,6 +16,26 @@ import { parseUTM } from "./parser.js";
 import { LatLon } from "geodesy/utm";
 
 //#region src/coordinates/utm/system.ts
+/**
+* Universal Transverse Mercator (UTM) coordinate system implementation.
+*
+* Provides parsing, conversion, and formatting for UTM coordinates. UTM divides
+* the Earth into 60 zones, each 6 degrees of longitude wide, using a transverse
+* Mercator projection. Coordinates are expressed as zone number, hemisphere (N/S),
+* easting, and northing values.
+*
+* @example
+* ```typescript
+* systemUTM.parse(null, '18N 585628 4511644');
+* // [['40.7128', '/', '-74.0060'], []]
+* ```
+*
+* @example
+* ```typescript
+* systemUTM.toFormat('LATLON', [40.7128, -74.0060]);
+* // '18N 585628 4511644'
+* ```
+*/
 const systemUTM = {
 	name: "Universal Transverse Mercator",
 	parse: parseUTM,

package/dist/coordinates/utm/system.js.map

@@ -1 +1 @@
-{"version":3,"file":"system.js","names":["systemUTM: CoordinateSystem"],"sources":["../../../src/coordinates/utm/system.ts"],"sourcesContent":["// __private-exports\n/*\n * Copyright 2024 Hypergiant Galactic Systems Inc. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport { LatLon } from 'geodesy/utm';\nimport { type Compass, type Format, SYMBOL_PATTERNS } from '../latlon/internal';\nimport { parseUTM } from './parser';\nimport type { CoordinateSystem } from '../latlon/internal/coordinate-system';\n\nexport const systemUTM: CoordinateSystem = {\n  name: 'Universal Transverse Mercator',\n\n  parse: parseUTM,\n\n  toFloat(arg) {\n    const [num, bear] = arg as [string, Compass];\n\n    return (\n      Number.parseFloat(num) *\n      (SYMBOL_PATTERNS.NEGATIVE_BEARINGS.test(bear) ? -1 : 1)\n    );\n  },\n\n  toFormat(format: Format, [left, right]: [number, number]) {\n    const { LAT, LON } = Object.fromEntries([\n      [format.slice(0, 3), left],\n      [format.slice(3), right],\n    ]) as Record<'LAT' | 'LON', number>;\n\n    const latlon = new LatLon(LAT, LON);\n    const utm = latlon.toUtm();\n\n    // Format UTM coordinates manually to ensure correct format\n    // Expected format: \"18N 585628 4511644\" (zone hemisphere easting northing)\n    const zone = utm.zone.toString().padStart(2, '0');\n    const hemisphere = utm.hemisphere;\n    const easting = Math.round(utm.easting).toString();\n    const northing = Math.round(utm.northing).toString();\n\n    return `${zone}${hemisphere} ${easting} ${northing}`;\n  },\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAkBA,MAAaA,YAA8B;CACzC,MAAM;CAEN,OAAO;CAEP,QAAQ,KAAK;EACX,MAAM,CAAC,KAAK,QAAQ;AAEpB,SACE,OAAO,WAAW,IAAI,IACrB,gBAAgB,kBAAkB,KAAK,KAAK,GAAG,KAAK;;CAIzD,SAAS,QAAgB,CAAC,MAAM,QAA0B;EACxD,MAAM,EAAE,KAAK,QAAQ,OAAO,YAAY,CACtC,CAAC,OAAO,MAAM,GAAG,EAAE,EAAE,KAAK,EAC1B,CAAC,OAAO,MAAM,EAAE,EAAE,MAAM,CACzB,CAAC;EAGF,MAAM,MADS,IAAI,OAAO,KAAK,IAAI,CAChB,OAAO;AAS1B,SAAO,GALM,IAAI,KAAK,UAAU,CAAC,SAAS,GAAG,IAAI,GAC9B,IAAI,WAIK,GAHZ,KAAK,MAAM,IAAI,QAAQ,CAAC,UAAU,CAGX,GAFtB,KAAK,MAAM,IAAI,SAAS,CAAC,UAAU;;CAIvD"}
+{"version":3,"file":"system.js","names":["systemUTM: CoordinateSystem"],"sources":["../../../src/coordinates/utm/system.ts"],"sourcesContent":["// __private-exports\n/*\n * Copyright 2024 Hypergiant Galactic Systems Inc. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport { LatLon } from 'geodesy/utm';\nimport { type Compass, type Format, SYMBOL_PATTERNS } from '../latlon/internal';\nimport { parseUTM } from './parser';\nimport type { CoordinateSystem } from '../latlon/internal/coordinate-system';\n\n/**\n * Universal Transverse Mercator (UTM) coordinate system implementation.\n *\n * Provides parsing, conversion, and formatting for UTM coordinates. UTM divides\n * the Earth into 60 zones, each 6 degrees of longitude wide, using a transverse\n * Mercator projection. Coordinates are expressed as zone number, hemisphere (N/S),\n * easting, and northing values.\n *\n * @example\n * ```typescript\n * systemUTM.parse(null, '18N 585628 4511644');\n * // [['40.7128', '/', '-74.0060'], []]\n * ```\n *\n * @example\n * ```typescript\n * systemUTM.toFormat('LATLON', [40.7128, -74.0060]);\n * // '18N 585628 4511644'\n * ```\n */\nexport const systemUTM: CoordinateSystem = {\n  name: 'Universal Transverse Mercator',\n\n  parse: parseUTM,\n\n  toFloat(arg) {\n    const [num, bear] = arg as [string, Compass];\n\n    return (\n      Number.parseFloat(num) *\n      (SYMBOL_PATTERNS.NEGATIVE_BEARINGS.test(bear) ? -1 : 1)\n    );\n  },\n\n  toFormat(format: Format, [left, right]: [number, number]) {\n    const { LAT, LON } = Object.fromEntries([\n      [format.slice(0, 3), left],\n      [format.slice(3), right],\n    ]) as Record<'LAT' | 'LON', number>;\n\n    const latlon = new LatLon(LAT, LON);\n    const utm = latlon.toUtm();\n\n    // Format UTM coordinates manually to ensure correct format\n    // Expected format: \"18N 585628 4511644\" (zone hemisphere easting northing)\n    const zone = utm.zone.toString().padStart(2, '0');\n    const hemisphere = utm.hemisphere;\n    const easting = Math.round(utm.easting).toString();\n    const northing = Math.round(utm.northing).toString();\n\n    return `${zone}${hemisphere} ${easting} ${northing}`;\n  },\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCA,MAAaA,YAA8B;CACzC,MAAM;CAEN,OAAO;CAEP,QAAQ,KAAK;EACX,MAAM,CAAC,KAAK,QAAQ;AAEpB,SACE,OAAO,WAAW,IAAI,IACrB,gBAAgB,kBAAkB,KAAK,KAAK,GAAG,KAAK;;CAIzD,SAAS,QAAgB,CAAC,MAAM,QAA0B;EACxD,MAAM,EAAE,KAAK,QAAQ,OAAO,YAAY,CACtC,CAAC,OAAO,MAAM,GAAG,EAAE,EAAE,KAAK,EAC1B,CAAC,OAAO,MAAM,EAAE,EAAE,MAAM,CACzB,CAAC;EAGF,MAAM,MADS,IAAI,OAAO,KAAK,IAAI,CAChB,OAAO;AAS1B,SAAO,GALM,IAAI,KAAK,UAAU,CAAC,SAAS,GAAG,IAAI,GAC9B,IAAI,WAIK,GAHZ,KAAK,MAAM,IAAI,QAAQ,CAAC,UAAU,CAGX,GAFtB,KAAK,MAAM,IAAI,SAAS,CAAC,UAAU;;CAIvD"}

package/dist/index.d.ts

@@ -10,6 +10,8 @@
  * governing permissions and limitations under the License.
  */
 
+import { CoordinateInput, CoordinateInternalValue, CoordinateObject, CoordinateTuple, LatLonTuple, LonLatTuple, isCoordinateObject, isCoordinateTuple, normalizeObjectToLatLon, tupleToLatLon } from "./coordinates/latlon/internal/normalize.js";
+import { isFiniteNumber, validateNumericCoordinate, validateSignedRange } from "./coordinates/latlon/internal/validate.js";
 import { coordinateSystems, createCoordinate } from "./coordinates/coordinate.js";
 import { FormatOptions, createFormatter } from "./coordinates/latlon/internal/format.js";
 import { formatDecimalDegrees } from "./coordinates/latlon/decimal-degrees/formatter.js";
@@ -21,4 +23,4 @@ import { parseDegreesMinutesSeconds } from "./coordinates/latlon/degrees-minutes
 import { getOrdinal } from "./coordinates/latlon/internal/ordinal.js";
 import { parseMGRS } from "./coordinates/mgrs/parser.js";
 import { parseUTM } from "./coordinates/utm/parser.js";
-export { type FormatOptions, coordinateSystems, createCoordinate, createFormatter, formatDecimalDegrees, formatDegreesDecimalMinutes, formatDegreesMinutesSeconds, getOrdinal, parseDecimalDegrees, parseDegreesDecimalMinutes, parseDegreesMinutesSeconds, parseMGRS, parseUTM };
+export { type CoordinateInput, type CoordinateInternalValue, type CoordinateObject, type CoordinateTuple, type FormatOptions, type LatLonTuple, type LonLatTuple, coordinateSystems, createCoordinate, createFormatter, formatDecimalDegrees, formatDegreesDecimalMinutes, formatDegreesMinutesSeconds, getOrdinal, isCoordinateObject, isCoordinateTuple, isFiniteNumber, normalizeObjectToLatLon, parseDecimalDegrees, parseDegreesDecimalMinutes, parseDegreesMinutesSeconds, parseMGRS, parseUTM, tupleToLatLon, validateNumericCoordinate, validateSignedRange };

package/dist/index.js

@@ -11,6 +11,8 @@
  */
 
 
+import { isCoordinateObject, isCoordinateTuple, normalizeObjectToLatLon, tupleToLatLon } from "./coordinates/latlon/internal/normalize.js";
+import { isFiniteNumber, validateNumericCoordinate, validateSignedRange } from "./coordinates/latlon/internal/validate.js";
 import { parseDecimalDegrees } from "./coordinates/latlon/decimal-degrees/parser.js";
 import { parseDegreesDecimalMinutes } from "./coordinates/latlon/degrees-decimal-minutes/parser.js";
 import { parseDegreesMinutesSeconds } from "./coordinates/latlon/degrees-minutes-seconds/parser.js";
@@ -23,4 +25,4 @@ import { formatDecimalDegrees } from "./coordinates/latlon/decimal-degrees/forma
 import { formatDegreesDecimalMinutes } from "./coordinates/latlon/degrees-decimal-minutes/formatter.js";
 import { formatDegreesMinutesSeconds } from "./coordinates/latlon/degrees-minutes-seconds/formatter.js";
 
-export { coordinateSystems, createCoordinate, createFormatter, formatDecimalDegrees, formatDegreesDecimalMinutes, formatDegreesMinutesSeconds, getOrdinal, parseDecimalDegrees, parseDegreesDecimalMinutes, parseDegreesMinutesSeconds, parseMGRS, parseUTM };
+export { coordinateSystems, createCoordinate, createFormatter, formatDecimalDegrees, formatDegreesDecimalMinutes, formatDegreesMinutesSeconds, getOrdinal, isCoordinateObject, isCoordinateTuple, isFiniteNumber, normalizeObjectToLatLon, parseDecimalDegrees, parseDegreesDecimalMinutes, parseDegreesMinutesSeconds, parseMGRS, parseUTM, tupleToLatLon, validateNumericCoordinate, validateSignedRange };

package/dist/patterning.d.ts

@@ -7,7 +7,9 @@
  * pure function
  *
  * @example
+ * ```typescript
  * capture(/a/, /b/, /c/) === /(abc)/
+ * ```
  */
 declare const capture: (...p: RegExp[]) => RegExp;
 /**
@@ -22,7 +24,9 @@ declare const capture: (...p: RegExp[]) => RegExp;
  * pure function
  *
  * @example
+ * ```typescript
  * fromTemplate({ a: /alpha/, b: /beta/, ' ': / / }, 'a b') === /^alpha beta$/
+ * ```
  *
  */
 declare const fromTemplate: (dict: Record<string, RegExp>, template: string) => RegExp;
@@ -34,7 +38,9 @@ declare const fromTemplate: (dict: Record<string, RegExp>, template: string) =>
  * pure function
  *
  * @example
- * capture(/a/, /b/, /c/) === /(?:abc)/
+ * ```typescript
+ * group(/a/, /b/, /c/) === /(?:abc)/
+ * ```
  */
 declare const group: (...p: RegExp[]) => RegExp;
 /**
@@ -46,7 +52,9 @@ declare const group: (...p: RegExp[]) => RegExp;
  * pure function
  *
  * @example
+ * ```typescript
  * merge(/a/, /b/, /c/) === /abc/
+ * ```
  */
 declare const merge: (...all: RegExp[]) => RegExp;
 /**
@@ -57,7 +65,9 @@ declare const merge: (...all: RegExp[]) => RegExp;
  * pure function
  *
  * @example
- * capture(/a/, /b/, /c/) === /(?:abc)?/
+ * ```typescript
+ * optional(/a/, /b/, /c/) === /(?:abc)?/
+ * ```
  */
 declare const optional: (...p: RegExp[]) => RegExp;
 //#endregion

package/dist/patterning.js

@@ -20,7 +20,9 @@
 * pure function
 *
 * @example
+* ```typescript
 * capture(/a/, /b/, /c/) === /(abc)/
+* ```
 */
 const capture = (...p) => /* @__PURE__ */ new RegExp(`(${merge(...p).source})`);
 /**
@@ -35,7 +37,9 @@ const capture = (...p) => /* @__PURE__ */ new RegExp(`(${merge(...p).source})`);
 * pure function
 *
 * @example
+* ```typescript
 * fromTemplate({ a: /alpha/, b: /beta/, ' ': / / }, 'a b') === /^alpha beta$/
+* ```
 *
 */
 const fromTemplate = (dict, template) => merge(/^/, ...(template.match(/(\s+)|([^\s]+)/g) ?? []).map((t) => dict[t] ?? /* @__PURE__ */ new RegExp(`_MISS_${t}_MISS_`)), /$/);
@@ -47,7 +51,9 @@ const fromTemplate = (dict, template) => merge(/^/, ...(template.match(/(\s+)|([
 * pure function
 *
 * @example
-* capture(/a/, /b/, /c/) === /(?:abc)/
+* ```typescript
+* group(/a/, /b/, /c/) === /(?:abc)/
+* ```
 */
 const group = (...p) => /* @__PURE__ */ new RegExp(`(?:${merge(...p).source})`);
 /**
@@ -59,7 +65,9 @@ const group = (...p) => /* @__PURE__ */ new RegExp(`(?:${merge(...p).source})`);
 * pure function
 *
 * @example
+* ```typescript
 * merge(/a/, /b/, /c/) === /abc/
+* ```
 */
 const merge = (...all) => all.reduce((acc, next) => new RegExp(acc?.source + next.source));
 /**
@@ -70,7 +78,9 @@ const merge = (...all) => all.reduce((acc, next) => new RegExp(acc?.source + nex
 * pure function
 *
 * @example
-* capture(/a/, /b/, /c/) === /(?:abc)?/
+* ```typescript
+* optional(/a/, /b/, /c/) === /(?:abc)?/
+* ```
 */
 const optional = (...p) => /* @__PURE__ */ new RegExp(`(?:${merge(...p).source})?`);
 

package/dist/patterning.js.map

@@ -1 +1 @@
-{"version":3,"file":"patterning.js","names":[],"sources":["../src/patterning.ts"],"sourcesContent":["// __private-exports\n/*\n * Copyright 2024 Hypergiant Galactic Systems Inc. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\n/**\n * Create a \"capturing\" group with the pattern provided by all arguments\n * merged into a single regex.\n *\n * @remarks\n * pure function\n *\n * @example\n * capture(/a/, /b/, /c/) === /(abc)/\n */\nexport const capture = (...p: RegExp[]) =>\n  new RegExp(`(${merge(...p).source})`);\n\n/**\n * Create a pattern using a template string and dict(ionary) of terms.\n *\n * @param dict an object with keys/properties that are RegExp objects that will\n * be used in the template string\n * @param template the definition of the pattern to build using the dict(ionary)\n * patterns\n *\n * @remarks\n * pure function\n *\n * @example\n * fromTemplate({ a: /alpha/, b: /beta/, ' ': / / }, 'a b') === /^alpha beta$/\n *\n */\nexport const fromTemplate = (dict: Record<string, RegExp>, template: string) =>\n  merge(\n    /^/,\n    ...(template.match(/(\\s+)|([^\\s]+)/g) ?? []).map(\n      (t) => dict[t as keyof typeof dict] ?? new RegExp(`_MISS_${t}_MISS_`),\n    ),\n    /$/,\n  );\n\n/**\n * Create a \"non-capturing\" group with the pattern provided by all arguments\n * merged into a single regex.\n *\n * @remarks\n * pure function\n *\n * @example\n * capture(/a/, /b/, /c/) === /(?:abc)/\n */\nexport const group = (...p: RegExp[]) =>\n  new RegExp(`(?:${merge(...p).source})`);\n\n/**\n * Concatenate all of the provided patterns into a single pattern; each\n * subsequent argument is joined with the previous with no \"qualifier\" between\n * them.\n *\n * @remarks\n * pure function\n *\n * @example\n * merge(/a/, /b/, /c/) === /abc/\n */\nexport const merge = (...all: RegExp[]) =>\n  all.reduce((acc, next) => new RegExp(acc?.source + next.source));\n\n/**\n * Create an \"optional\" \"non-capturing\" group with the pattern provided by all\n * arguments merged into a single regex.\n *\n * @remarks\n * pure function\n *\n * @example\n * capture(/a/, /b/, /c/) === /(?:abc)?/\n */\nexport const optional = (...p: RegExp[]) =>\n  new RegExp(`(?:${merge(...p).source})?`);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAuBA,MAAa,WAAW,GAAG,sBACzB,IAAI,OAAO,IAAI,MAAM,GAAG,EAAE,CAAC,OAAO,GAAG;;;;;;;;;;;;;;;;AAiBvC,MAAa,gBAAgB,MAA8B,aACzD,MACE,KACA,IAAI,SAAS,MAAM,kBAAkB,IAAI,EAAE,EAAE,KAC1C,MAAM,KAAK,sBAA2B,IAAI,OAAO,SAAS,EAAE,QAAQ,CACtE,EACD,IACD;;;;;;;;;;;AAYH,MAAa,SAAS,GAAG,sBACvB,IAAI,OAAO,MAAM,MAAM,GAAG,EAAE,CAAC,OAAO,GAAG;;;;;;;;;;;;AAazC,MAAa,SAAS,GAAG,QACvB,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS,KAAK,OAAO,CAAC;;;;;;;;;;;AAYlE,MAAa,YAAY,GAAG,sBAC1B,IAAI,OAAO,MAAM,MAAM,GAAG,EAAE,CAAC,OAAO,IAAI"}
+{"version":3,"file":"patterning.js","names":[],"sources":["../src/patterning.ts"],"sourcesContent":["// __private-exports\n/*\n * Copyright 2024 Hypergiant Galactic Systems Inc. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\n/**\n * Create a \"capturing\" group with the pattern provided by all arguments\n * merged into a single regex.\n *\n * @remarks\n * pure function\n *\n * @example\n * ```typescript\n * capture(/a/, /b/, /c/) === /(abc)/\n * ```\n */\nexport const capture = (...p: RegExp[]) =>\n  new RegExp(`(${merge(...p).source})`);\n\n/**\n * Create a pattern using a template string and dict(ionary) of terms.\n *\n * @param dict an object with keys/properties that are RegExp objects that will\n * be used in the template string\n * @param template the definition of the pattern to build using the dict(ionary)\n * patterns\n *\n * @remarks\n * pure function\n *\n * @example\n * ```typescript\n * fromTemplate({ a: /alpha/, b: /beta/, ' ': / / }, 'a b') === /^alpha beta$/\n * ```\n *\n */\nexport const fromTemplate = (dict: Record<string, RegExp>, template: string) =>\n  merge(\n    /^/,\n    ...(template.match(/(\\s+)|([^\\s]+)/g) ?? []).map(\n      (t) => dict[t as keyof typeof dict] ?? new RegExp(`_MISS_${t}_MISS_`),\n    ),\n    /$/,\n  );\n\n/**\n * Create a \"non-capturing\" group with the pattern provided by all arguments\n * merged into a single regex.\n *\n * @remarks\n * pure function\n *\n * @example\n * ```typescript\n * group(/a/, /b/, /c/) === /(?:abc)/\n * ```\n */\nexport const group = (...p: RegExp[]) =>\n  new RegExp(`(?:${merge(...p).source})`);\n\n/**\n * Concatenate all of the provided patterns into a single pattern; each\n * subsequent argument is joined with the previous with no \"qualifier\" between\n * them.\n *\n * @remarks\n * pure function\n *\n * @example\n * ```typescript\n * merge(/a/, /b/, /c/) === /abc/\n * ```\n */\nexport const merge = (...all: RegExp[]) =>\n  all.reduce((acc, next) => new RegExp(acc?.source + next.source));\n\n/**\n * Create an \"optional\" \"non-capturing\" group with the pattern provided by all\n * arguments merged into a single regex.\n *\n * @remarks\n * pure function\n *\n * @example\n * ```typescript\n * optional(/a/, /b/, /c/) === /(?:abc)?/\n * ```\n */\nexport const optional = (...p: RegExp[]) =>\n  new RegExp(`(?:${merge(...p).source})?`);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,MAAa,WAAW,GAAG,sBACzB,IAAI,OAAO,IAAI,MAAM,GAAG,EAAE,CAAC,OAAO,GAAG;;;;;;;;;;;;;;;;;;AAmBvC,MAAa,gBAAgB,MAA8B,aACzD,MACE,KACA,IAAI,SAAS,MAAM,kBAAkB,IAAI,EAAE,EAAE,KAC1C,MAAM,KAAK,sBAA2B,IAAI,OAAO,SAAS,EAAE,QAAQ,CACtE,EACD,IACD;;;;;;;;;;;;;AAcH,MAAa,SAAS,GAAG,sBACvB,IAAI,OAAO,MAAM,MAAM,GAAG,EAAE,CAAC,OAAO,GAAG;;;;;;;;;;;;;;AAezC,MAAa,SAAS,GAAG,QACvB,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS,KAAK,OAAO,CAAC;;;;;;;;;;;;;AAclE,MAAa,YAAY,GAAG,sBAC1B,IAAI,OAAO,MAAM,MAAM,GAAG,EAAE,CAAC,OAAO,IAAI"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@accelint/geo",
   "description": "A collection of JavaScript functions for working with coordinates and geospatial data.",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "author": "https://hypergiant.com",
   "$schema": "https://json.schemastore.org/package",
   "dependencies": {
@@ -39,6 +39,7 @@
     "./coordinates/latlon/internal/format": "./dist/coordinates/latlon/internal/format.js",
     "./coordinates/latlon/internal/in-range": "./dist/coordinates/latlon/internal/in-range.js",
     "./coordinates/latlon/internal/lexer": "./dist/coordinates/latlon/internal/lexer.js",
+    "./coordinates/latlon/internal/normalize": "./dist/coordinates/latlon/internal/normalize.js",
     "./coordinates/latlon/internal/ordinal": "./dist/coordinates/latlon/internal/ordinal.js",
     "./coordinates/latlon/internal/parse": "./dist/coordinates/latlon/internal/parse.js",
     "./coordinates/latlon/internal/parse-format": "./dist/coordinates/latlon/internal/parse-format.js",
@@ -49,6 +50,7 @@
     "./coordinates/latlon/internal/pipes/fix-dividers": "./dist/coordinates/latlon/internal/pipes/fix-dividers.js",
     "./coordinates/latlon/internal/pipes/genome": "./dist/coordinates/latlon/internal/pipes/genome.js",
     "./coordinates/latlon/internal/pipes/simpler": "./dist/coordinates/latlon/internal/pipes/simpler.js",
+    "./coordinates/latlon/internal/validate": "./dist/coordinates/latlon/internal/validate.js",
     "./coordinates/latlon/internal/violation": "./dist/coordinates/latlon/internal/violation.js",
     "./coordinates/mgrs/parser": "./dist/coordinates/mgrs/parser.js",
     "./coordinates/mgrs/system": "./dist/coordinates/mgrs/system.js",