@accelint/geo 0.5.1 → 0.6.1

package/dist/coordinates/latlon/internal/pipes/simpler.d.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2025 Hypergiant Galactic Systems Inc. All rights reserved.
+ * Copyright 2026 Hypergiant Galactic Systems Inc. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
  * of the License at https://www.apache.org/licenses/LICENSE-2.0
@@ -13,15 +13,28 @@
 import { Tokens } from "../lexer.js";
 
 //#region src/coordinates/latlon/internal/pipes/simpler.d.ts
+
 /**
  * Create a simplified pattern string - numbers = 'N', bearings = 'B' - to
  * allow for simpler pattern matching.
  *
- * @remarks
- * pure function
+ * @param tokens - Array of coordinate tokens to simplify.
+ * @returns Simplified pattern string where 'N' = number and 'B' = bearing.
+ *
+ * @example
+ * ```typescript
+ * simpler(['45', '30', 'N', '/', '122', '15', 'W']);
+ * // 'NNBNNNB'
+ * ```
  *
  * @example
- * simplify(tokens); // 'NNNBNNNB' or similar
+ * ```typescript
+ * simpler(['45', 'N']);
+ * // 'NB'
+ * ```
+ *
+ * @remarks
+ * pure function
  */
 declare const simpler: (tokens: Tokens) => string;
 //#endregion

package/dist/coordinates/latlon/internal/pipes/simpler.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2025 Hypergiant Galactic Systems Inc. All rights reserved.
+ * Copyright 2026 Hypergiant Galactic Systems Inc. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
  * of the License at https://www.apache.org/licenses/LICENSE-2.0
@@ -16,11 +16,23 @@
 * Create a simplified pattern string - numbers = 'N', bearings = 'B' - to
 * allow for simpler pattern matching.
 *
-* @remarks
-* pure function
+* @param tokens - Array of coordinate tokens to simplify.
+* @returns Simplified pattern string where 'N' = number and 'B' = bearing.
+*
+* @example
+* ```typescript
+* simpler(['45', '30', 'N', '/', '122', '15', 'W']);
+* // 'NNBNNNB'
+* ```
 *
 * @example
-* simplify(tokens); // 'NNNBNNNB' or similar
+* ```typescript
+* simpler(['45', 'N']);
+* // 'NB'
+* ```
+*
+* @remarks
+* pure function
 */
 const simpler = (tokens) => tokens.map((t) => /\d/.test(t) ? "N" : "B").join("");
 

package/dist/coordinates/latlon/internal/pipes/simpler.js.map

@@ -1 +1 @@
-{"version":3,"file":"simpler.js","names":[],"sources":["../../../../../src/coordinates/latlon/internal/pipes/simpler.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 type { Tokens } from '../lexer';\n\n/**\n * Create a simplified pattern string - numbers = 'N', bearings = 'B' - to\n * allow for simpler pattern matching.\n *\n * @remarks\n * pure function\n *\n * @example\n * simplify(tokens); // 'NNNBNNNB' or similar\n */\nexport const simpler = (tokens: Tokens) =>\n  tokens.map((t) => (/\\d/.test(t) ? 'N' : 'B')).join('');\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAyBA,MAAa,WAAW,WACtB,OAAO,KAAK,MAAO,KAAK,KAAK,EAAE,GAAG,MAAM,IAAK,CAAC,KAAK,GAAG"}
+{"version":3,"file":"simpler.js","names":[],"sources":["../../../../../src/coordinates/latlon/internal/pipes/simpler.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 type { Tokens } from '../lexer';\n\n/**\n * Create a simplified pattern string - numbers = 'N', bearings = 'B' - to\n * allow for simpler pattern matching.\n *\n * @param tokens - Array of coordinate tokens to simplify.\n * @returns Simplified pattern string where 'N' = number and 'B' = bearing.\n *\n * @example\n * ```typescript\n * simpler(['45', '30', 'N', '/', '122', '15', 'W']);\n * // 'NNBNNNB'\n * ```\n *\n * @example\n * ```typescript\n * simpler(['45', 'N']);\n * // 'NB'\n * ```\n *\n * @remarks\n * pure function\n */\nexport const simpler = (tokens: Tokens) =>\n  tokens.map((t) => (/\\d/.test(t) ? 'N' : 'B')).join('');\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCA,MAAa,WAAW,WACtB,OAAO,KAAK,MAAO,KAAK,KAAK,EAAE,GAAG,MAAM,IAAK,CAAC,KAAK,GAAG"}

package/dist/coordinates/latlon/internal/validate.d.ts

@@ -0,0 +1,75 @@
+//#region src/coordinates/latlon/internal/validate.d.ts
+/**
+ * Checks if a value is a finite number (not NaN, not Infinity, not -Infinity).
+ *
+ * @param value - The numeric value to check
+ * @returns True if the value is a finite number, false otherwise
+ *
+ * @example
+ * ```typescript
+ * isFiniteNumber(42);        // true
+ * isFiniteNumber(NaN);       // false
+ * isFiniteNumber(Infinity);  // false
+ * ```
+ */
+declare function isFiniteNumber(value: number): boolean;
+/**
+ * Validates that a value is within a signed range (-limit to +limit).
+ *
+ * @param label - The label for error messages (used as-is for range errors,
+ *                lowercased for "Invalid" errors)
+ * @param value - The numeric value to validate
+ * @param limit - The absolute limit (validates -limit to +limit)
+ * @returns Error message string if validation fails, undefined if valid
+ *
+ * @example
+ * ```typescript
+ * validateSignedRange('Latitude', 45, 90);
+ * // => undefined
+ * ```
+ *
+ * @example
+ * ```typescript
+ * validateSignedRange('Latitude', 95, 90);
+ * // => '[ERROR] Latitude value (95) is outside valid range (-90 to 90).'
+ * ```
+ *
+ * @example
+ * ```typescript
+ * validateSignedRange('Longitude', NaN, 180);
+ * // => '[ERROR] Invalid longitude value (NaN); expected a finite number.'
+ * ```
+ */
+declare function validateSignedRange(label: string, value: number, limit: number): string | undefined;
+/**
+ * Validates numeric latitude and longitude coordinate values.
+ *
+ * @param lat - The latitude value to validate (must be -90 to 90)
+ * @param lon - The longitude value to validate (must be -180 to 180)
+ * @returns Array of error message strings, empty if all validations pass
+ *
+ * @example
+ * ```typescript
+ * validateNumericCoordinate(45.5, -122.6);
+ * // => []
+ * ```
+ *
+ * @example
+ * ```typescript
+ * validateNumericCoordinate(91, -122.6);
+ * // => ['[ERROR] Latitude value (91) is outside valid range (-90 to 90).']
+ * ```
+ *
+ * @example
+ * ```typescript
+ * validateNumericCoordinate(NaN, 200);
+ * // => [
+ * //   '[ERROR] Invalid latitude value (NaN); expected a finite number.',
+ * //   '[ERROR] Longitude value (200) is outside valid range (-180 to 180).'
+ * // ]
+ * ```
+ */
+declare function validateNumericCoordinate(lat: number, lon: number): string[];
+//#endregion
+export { isFiniteNumber, validateNumericCoordinate, validateSignedRange };
+//# sourceMappingURL=validate.d.ts.map

package/dist/coordinates/latlon/internal/validate.js

@@ -0,0 +1,105 @@
+/*
+ * Copyright 2026 Hypergiant Galactic Systems Inc. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+
+import { violation } from "./violation.js";
+
+//#region src/coordinates/latlon/internal/validate.ts
+const LAT_LIMIT = 90;
+const LON_LIMIT = 180;
+/**
+* Checks if a value is a finite number (not NaN, not Infinity, not -Infinity).
+*
+* @param value - The numeric value to check
+* @returns True if the value is a finite number, false otherwise
+*
+* @example
+* ```typescript
+* isFiniteNumber(42);        // true
+* isFiniteNumber(NaN);       // false
+* isFiniteNumber(Infinity);  // false
+* ```
+*/
+function isFiniteNumber(value) {
+	return typeof value === "number" && Number.isFinite(value);
+}
+/**
+* Validates that a value is within a signed range (-limit to +limit).
+*
+* @param label - The label for error messages (used as-is for range errors,
+*                lowercased for "Invalid" errors)
+* @param value - The numeric value to validate
+* @param limit - The absolute limit (validates -limit to +limit)
+* @returns Error message string if validation fails, undefined if valid
+*
+* @example
+* ```typescript
+* validateSignedRange('Latitude', 45, 90);
+* // => undefined
+* ```
+*
+* @example
+* ```typescript
+* validateSignedRange('Latitude', 95, 90);
+* // => '[ERROR] Latitude value (95) is outside valid range (-90 to 90).'
+* ```
+*
+* @example
+* ```typescript
+* validateSignedRange('Longitude', NaN, 180);
+* // => '[ERROR] Invalid longitude value (NaN); expected a finite number.'
+* ```
+*/
+function validateSignedRange(label, value, limit) {
+	if (!isFiniteNumber(value)) return violation(`Invalid ${label.toLowerCase()} value (${value}); expected a finite number.`);
+	if (value < -limit || value > limit) return violation(`${label} value (${value}) is outside valid range (-${limit} to ${limit}).`);
+}
+/**
+* Validates numeric latitude and longitude coordinate values.
+*
+* @param lat - The latitude value to validate (must be -90 to 90)
+* @param lon - The longitude value to validate (must be -180 to 180)
+* @returns Array of error message strings, empty if all validations pass
+*
+* @example
+* ```typescript
+* validateNumericCoordinate(45.5, -122.6);
+* // => []
+* ```
+*
+* @example
+* ```typescript
+* validateNumericCoordinate(91, -122.6);
+* // => ['[ERROR] Latitude value (91) is outside valid range (-90 to 90).']
+* ```
+*
+* @example
+* ```typescript
+* validateNumericCoordinate(NaN, 200);
+* // => [
+* //   '[ERROR] Invalid latitude value (NaN); expected a finite number.',
+* //   '[ERROR] Longitude value (200) is outside valid range (-180 to 180).'
+* // ]
+* ```
+*/
+function validateNumericCoordinate(lat, lon) {
+	const errors = [];
+	const latError = validateSignedRange("Latitude", lat, LAT_LIMIT);
+	if (latError) errors.push(latError);
+	const lonError = validateSignedRange("Longitude", lon, LON_LIMIT);
+	if (lonError) errors.push(lonError);
+	return errors;
+}
+
+//#endregion
+export { isFiniteNumber, validateNumericCoordinate, validateSignedRange };
+//# sourceMappingURL=validate.js.map

package/dist/coordinates/latlon/internal/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","names":["errors: string[]"],"sources":["../../../../src/coordinates/latlon/internal/validate.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 { violation } from './violation';\n\nconst LAT_LIMIT = 90;\nconst LON_LIMIT = 180;\n\n/**\n * Checks if a value is a finite number (not NaN, not Infinity, not -Infinity).\n *\n * @param value - The numeric value to check\n * @returns True if the value is a finite number, false otherwise\n *\n * @example\n * ```typescript\n * isFiniteNumber(42);        // true\n * isFiniteNumber(NaN);       // false\n * isFiniteNumber(Infinity);  // false\n * ```\n */\nexport function isFiniteNumber(value: number): boolean {\n  return typeof value === 'number' && Number.isFinite(value);\n}\n\n/**\n * Validates that a value is within a signed range (-limit to +limit).\n *\n * @param label - The label for error messages (used as-is for range errors,\n *                lowercased for \"Invalid\" errors)\n * @param value - The numeric value to validate\n * @param limit - The absolute limit (validates -limit to +limit)\n * @returns Error message string if validation fails, undefined if valid\n *\n * @example\n * ```typescript\n * validateSignedRange('Latitude', 45, 90);\n * // => undefined\n * ```\n *\n * @example\n * ```typescript\n * validateSignedRange('Latitude', 95, 90);\n * // => '[ERROR] Latitude value (95) is outside valid range (-90 to 90).'\n * ```\n *\n * @example\n * ```typescript\n * validateSignedRange('Longitude', NaN, 180);\n * // => '[ERROR] Invalid longitude value (NaN); expected a finite number.'\n * ```\n */\nexport function validateSignedRange(\n  label: string,\n  value: number,\n  limit: number,\n): string | undefined {\n  if (!isFiniteNumber(value)) {\n    return violation(\n      `Invalid ${label.toLowerCase()} value (${value}); expected a finite number.`,\n    );\n  }\n\n  if (value < -limit || value > limit) {\n    return violation(\n      `${label} value (${value}) is outside valid range (-${limit} to ${limit}).`,\n    );\n  }\n}\n\n/**\n * Validates numeric latitude and longitude coordinate values.\n *\n * @param lat - The latitude value to validate (must be -90 to 90)\n * @param lon - The longitude value to validate (must be -180 to 180)\n * @returns Array of error message strings, empty if all validations pass\n *\n * @example\n * ```typescript\n * validateNumericCoordinate(45.5, -122.6);\n * // => []\n * ```\n *\n * @example\n * ```typescript\n * validateNumericCoordinate(91, -122.6);\n * // => ['[ERROR] Latitude value (91) is outside valid range (-90 to 90).']\n * ```\n *\n * @example\n * ```typescript\n * validateNumericCoordinate(NaN, 200);\n * // => [\n * //   '[ERROR] Invalid latitude value (NaN); expected a finite number.',\n * //   '[ERROR] Longitude value (200) is outside valid range (-180 to 180).'\n * // ]\n * ```\n */\nexport function validateNumericCoordinate(lat: number, lon: number): string[] {\n  const errors: string[] = [];\n\n  const latError = validateSignedRange('Latitude', lat, LAT_LIMIT);\n  if (latError) {\n    errors.push(latError);\n  }\n\n  const lonError = validateSignedRange('Longitude', lon, LON_LIMIT);\n  if (lonError) {\n    errors.push(lonError);\n  }\n\n  return errors;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAcA,MAAM,YAAY;AAClB,MAAM,YAAY;;;;;;;;;;;;;;AAelB,SAAgB,eAAe,OAAwB;AACrD,QAAO,OAAO,UAAU,YAAY,OAAO,SAAS,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8B5D,SAAgB,oBACd,OACA,OACA,OACoB;AACpB,KAAI,CAAC,eAAe,MAAM,CACxB,QAAO,UACL,WAAW,MAAM,aAAa,CAAC,UAAU,MAAM,8BAChD;AAGH,KAAI,QAAQ,CAAC,SAAS,QAAQ,MAC5B,QAAO,UACL,GAAG,MAAM,UAAU,MAAM,6BAA6B,MAAM,MAAM,MAAM,IACzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCL,SAAgB,0BAA0B,KAAa,KAAuB;CAC5E,MAAMA,SAAmB,EAAE;CAE3B,MAAM,WAAW,oBAAoB,YAAY,KAAK,UAAU;AAChE,KAAI,SACF,QAAO,KAAK,SAAS;CAGvB,MAAM,WAAW,oBAAoB,aAAa,KAAK,UAAU;AACjE,KAAI,SACF,QAAO,KAAK,SAAS;AAGvB,QAAO"}

package/dist/coordinates/latlon/internal/violation.d.ts

@@ -1,4 +1,22 @@
 //#region src/coordinates/latlon/internal/violation.d.ts
+/**
+ * Formats an error message with a standard [ERROR] prefix.
+ *
+ * @param s - The error message string to format.
+ * @returns Formatted error string with [ERROR] prefix.
+ *
+ * @example
+ * ```typescript
+ * violation('Invalid coordinate value.');
+ * // '[ERROR] Invalid coordinate value.'
+ * ```
+ *
+ * @example
+ * ```typescript
+ * violation('Degrees value (91) exceeds max value (90).');
+ * // '[ERROR] Degrees value (91) exceeds max value (90).'
+ * ```
+ */
 declare const violation: (s: string) => string;
 //#endregion
 export { violation };

package/dist/coordinates/latlon/internal/violation.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2025 Hypergiant Galactic Systems Inc. All rights reserved.
+ * Copyright 2026 Hypergiant Galactic Systems Inc. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
  * of the License at https://www.apache.org/licenses/LICENSE-2.0
@@ -12,6 +12,24 @@
 
 
 //#region src/coordinates/latlon/internal/violation.ts
+/**
+* Formats an error message with a standard [ERROR] prefix.
+*
+* @param s - The error message string to format.
+* @returns Formatted error string with [ERROR] prefix.
+*
+* @example
+* ```typescript
+* violation('Invalid coordinate value.');
+* // '[ERROR] Invalid coordinate value.'
+* ```
+*
+* @example
+* ```typescript
+* violation('Degrees value (91) exceeds max value (90).');
+* // '[ERROR] Degrees value (91) exceeds max value (90).'
+* ```
+*/
 const violation = (s) => `[ERROR] ${s}`;
 
 //#endregion

package/dist/coordinates/latlon/internal/violation.js.map

@@ -1 +1 @@
-{"version":3,"file":"violation.js","names":[],"sources":["../../../../src/coordinates/latlon/internal/violation.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\nexport const violation = (s: string) => `[ERROR] ${s}`;\n"],"mappings":";;;;;;;;;;;;;;AAaA,MAAa,aAAa,MAAc,WAAW"}
+{"version":3,"file":"violation.js","names":[],"sources":["../../../../src/coordinates/latlon/internal/violation.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 * Formats an error message with a standard [ERROR] prefix.\n *\n * @param s - The error message string to format.\n * @returns Formatted error string with [ERROR] prefix.\n *\n * @example\n * ```typescript\n * violation('Invalid coordinate value.');\n * // '[ERROR] Invalid coordinate value.'\n * ```\n *\n * @example\n * ```typescript\n * violation('Degrees value (91) exceeds max value (90).');\n * // '[ERROR] Degrees value (91) exceeds max value (90).'\n * ```\n */\nexport const violation = (s: string) => `[ERROR] ${s}`;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,MAAa,aAAa,MAAc,WAAW"}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2025 Hypergiant Galactic Systems Inc. All rights reserved.
+ * Copyright 2026 Hypergiant Galactic Systems Inc. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
  * of the License at https://www.apache.org/licenses/LICENSE-2.0
@@ -13,6 +13,30 @@
 import { ParseResults } from "../latlon/internal/parse.js";
 
 //#region src/coordinates/mgrs/parser.d.ts
+
+/**
+ * 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...']]
+ * ```
+ */
 declare function parseMGRS(_format: any, input: string): ParseResults;
 //#endregion
 export { parseMGRS };

package/dist/coordinates/mgrs/parser.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2025 Hypergiant Galactic Systems Inc. All rights reserved.
+ * Copyright 2026 Hypergiant Galactic Systems Inc. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
  * of the License at https://www.apache.org/licenses/LICENSE-2.0
@@ -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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2025 Hypergiant Galactic Systems Inc. All rights reserved.
+ * Copyright 2026 Hypergiant Galactic Systems Inc. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
  * of the License at https://www.apache.org/licenses/LICENSE-2.0
@@ -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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2025 Hypergiant Galactic Systems Inc. All rights reserved.
+ * Copyright 2026 Hypergiant Galactic Systems Inc. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
  * of the License at https://www.apache.org/licenses/LICENSE-2.0
@@ -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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2025 Hypergiant Galactic Systems Inc. All rights reserved.
+ * Copyright 2026 Hypergiant Galactic Systems Inc. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
  * of the License at https://www.apache.org/licenses/LICENSE-2.0
@@ -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 };