@trackunit/shared-utils 0.0.82 → 0.0.84

package/index.cjs.js

@@ -589,6 +589,31 @@ const geoJsonRectangularBoxPolygonSchema = zod.z
 });
 
 const EARTH_RADIUS = 6378137; // Earth’s mean radius in meters
+const isDoubleNestedCoords = (coords) => Array.isArray(coords) &&
+    Array.isArray(coords[0]) &&
+    Array.isArray(coords[0][0]) &&
+    typeof coords[0][0][0] === "number";
+const isSingleCoords = (coords) => typeof coords[0] === "number";
+/**
+ * @description Returns coordinates in consistent format
+ * @param inconsistentCoordinates Single point, array of points or nested array of points
+ * @returns GeoPoint[]
+ */
+const coordinatesToStandardFormat = (inconsistentCoordinates) => {
+    if (!inconsistentCoordinates) {
+        return [];
+    }
+    if (isSingleCoords(inconsistentCoordinates)) {
+        return [inconsistentCoordinates];
+    }
+    if (isDoubleNestedCoords(inconsistentCoordinates)) {
+        return inconsistentCoordinates[0] || [];
+    }
+    if (inconsistentCoordinates[0] && typeof inconsistentCoordinates[0][0] === "number") {
+        return inconsistentCoordinates;
+    }
+    return [];
+};
 /**
  * @description Extracts a point coordinate from a GeoJSON object.
  * @param geoObject A GeoJSON object.
@@ -605,7 +630,13 @@ const getPointCoordinateFromGeoJsonObject = (geoObject) => {
         Array.isArray(geoObject.coordinates) &&
         typeof geoObject.coordinates[0] === "number" &&
         typeof geoObject.coordinates[1] === "number") {
-        return { longitude: geoObject.coordinates[0], latitude: geoObject.coordinates[1] };
+        const [point] = coordinatesToStandardFormat(geoObject.coordinates);
+        if (point) {
+            return { latitude: point[1], longitude: point[0] };
+        }
+        else {
+            throw new Error(`Unable to extract point coordinate from ${JSON.stringify(geoObject)}`);
+        }
     }
     else {
         throw new Error(`Unable to extract point coordinate from ${JSON.stringify(geoObject)}`);
@@ -624,12 +655,8 @@ const getMultipleCoordinatesFromGeoJsonObject = (geoObject) => {
     else if ("geometry" in geoObject) {
         return getMultipleCoordinatesFromGeoJsonObject(geoObject.geometry);
     }
-    else if ("coordinates" in geoObject &&
-        Array.isArray(geoObject.coordinates) &&
-        Array.isArray(geoObject.coordinates[0])) {
-        // @ts-ignore - suppressImplicitAnyIndexErrors
-        // We would not be here if element was not an array.
-        return geoObject.coordinates.map(element => ({ longitude: element[0], latitude: element[1] }));
+    else if ("coordinates" in geoObject) {
+        return coordinatesToStandardFormat(geoObject.coordinates).map(([longitude, latitude]) => ({ longitude, latitude }));
     }
     else {
         throw new Error(`Unable to extract point coordinate from ${JSON.stringify(geoObject)}`);
@@ -716,6 +743,12 @@ const getGeoJsonPolygonFromBoundingBox = (boundingBox) => {
         ],
     };
 };
+/**
+ * @description Creates TU point coordinate from a GeoJSON Point.
+ */
+const getPointCoordinateFromGeoJsonPoint = (point) => {
+    return { latitude: point.coordinates[1], longitude: point.coordinates[0] };
+};
 
 /**
  * Group an array of items by a key.
@@ -1374,6 +1407,7 @@ exports.capitalize = capitalize;
 exports.convertBlobToBase64 = convertBlobToBase64;
 exports.convertMetersToYards = convertMetersToYards;
 exports.convertYardsToMeters = convertYardsToMeters;
+exports.coordinatesToStandardFormat = coordinatesToStandardFormat;
 exports.dateCompare = dateCompare;
 exports.deleteUndefinedKeys = deleteUndefinedKeys;
 exports.difference = difference;
@@ -1406,6 +1440,7 @@ exports.getGeoJsonPolygonFromBoundingBox = getGeoJsonPolygonFromBoundingBox;
 exports.getISOStringFromDate = getISOStringFromDate;
 exports.getMultipleCoordinatesFromGeoJsonObject = getMultipleCoordinatesFromGeoJsonObject;
 exports.getPointCoordinateFromGeoJsonObject = getPointCoordinateFromGeoJsonObject;
+exports.getPointCoordinateFromGeoJsonPoint = getPointCoordinateFromGeoJsonPoint;
 exports.getPolygonFromBbox = getPolygonFromBbox;
 exports.getPolygonFromPointAndRadius = getPolygonFromPointAndRadius;
 exports.getResizedDimensions = getResizedDimensions;

package/index.esm.js

@@ -587,6 +587,31 @@ const geoJsonRectangularBoxPolygonSchema = z
 });
 
 const EARTH_RADIUS = 6378137; // Earth’s mean radius in meters
+const isDoubleNestedCoords = (coords) => Array.isArray(coords) &&
+    Array.isArray(coords[0]) &&
+    Array.isArray(coords[0][0]) &&
+    typeof coords[0][0][0] === "number";
+const isSingleCoords = (coords) => typeof coords[0] === "number";
+/**
+ * @description Returns coordinates in consistent format
+ * @param inconsistentCoordinates Single point, array of points or nested array of points
+ * @returns GeoPoint[]
+ */
+const coordinatesToStandardFormat = (inconsistentCoordinates) => {
+    if (!inconsistentCoordinates) {
+        return [];
+    }
+    if (isSingleCoords(inconsistentCoordinates)) {
+        return [inconsistentCoordinates];
+    }
+    if (isDoubleNestedCoords(inconsistentCoordinates)) {
+        return inconsistentCoordinates[0] || [];
+    }
+    if (inconsistentCoordinates[0] && typeof inconsistentCoordinates[0][0] === "number") {
+        return inconsistentCoordinates;
+    }
+    return [];
+};
 /**
  * @description Extracts a point coordinate from a GeoJSON object.
  * @param geoObject A GeoJSON object.
@@ -603,7 +628,13 @@ const getPointCoordinateFromGeoJsonObject = (geoObject) => {
         Array.isArray(geoObject.coordinates) &&
         typeof geoObject.coordinates[0] === "number" &&
         typeof geoObject.coordinates[1] === "number") {
-        return { longitude: geoObject.coordinates[0], latitude: geoObject.coordinates[1] };
+        const [point] = coordinatesToStandardFormat(geoObject.coordinates);
+        if (point) {
+            return { latitude: point[1], longitude: point[0] };
+        }
+        else {
+            throw new Error(`Unable to extract point coordinate from ${JSON.stringify(geoObject)}`);
+        }
     }
     else {
         throw new Error(`Unable to extract point coordinate from ${JSON.stringify(geoObject)}`);
@@ -622,12 +653,8 @@ const getMultipleCoordinatesFromGeoJsonObject = (geoObject) => {
     else if ("geometry" in geoObject) {
         return getMultipleCoordinatesFromGeoJsonObject(geoObject.geometry);
     }
-    else if ("coordinates" in geoObject &&
-        Array.isArray(geoObject.coordinates) &&
-        Array.isArray(geoObject.coordinates[0])) {
-        // @ts-ignore - suppressImplicitAnyIndexErrors
-        // We would not be here if element was not an array.
-        return geoObject.coordinates.map(element => ({ longitude: element[0], latitude: element[1] }));
+    else if ("coordinates" in geoObject) {
+        return coordinatesToStandardFormat(geoObject.coordinates).map(([longitude, latitude]) => ({ longitude, latitude }));
     }
     else {
         throw new Error(`Unable to extract point coordinate from ${JSON.stringify(geoObject)}`);
@@ -714,6 +741,12 @@ const getGeoJsonPolygonFromBoundingBox = (boundingBox) => {
         ],
     };
 };
+/**
+ * @description Creates TU point coordinate from a GeoJSON Point.
+ */
+const getPointCoordinateFromGeoJsonPoint = (point) => {
+    return { latitude: point.coordinates[1], longitude: point.coordinates[0] };
+};
 
 /**
  * Group an array of items by a key.
@@ -1361,4 +1394,4 @@ const uuidv4 = () => {
  */
 const uuidv5 = (name, namespace) => v5(name, namespace);
 
-export { DateTimeFormat, EARTH_RADIUS, HoursAndMinutesFormat, align, alphabeticallySort, arrayLengthCompare, arrayNotEmpty, booleanCompare, capitalize, convertBlobToBase64, convertMetersToYards, convertYardsToMeters, dateCompare, deleteUndefinedKeys, difference, doNothing, enumFromValue, enumFromValueTypesafe, enumOrUndefinedFromValue, exhaustiveCheck, filterByMultiple, formatAddress, formatCoordinates, fuzzySearch, geoJsonBboxSchema, geoJsonGeometrySchema, geoJsonLineStringSchema, geoJsonLinearRingSchema, geoJsonMultiLineStringSchema, geoJsonMultiPointSchema, geoJsonMultiPolygonSchema, geoJsonPointSchema, geoJsonPolygonNoHolesSchema, geoJsonPolygonSchema, geoJsonPositionSchema, geoJsonRectangularBoxPolygonSchema, getBoundingBoxFromGeoJsonPolygon, getDifferenceBetweenDates, getEndOfDay, getFirstLevelObjectPropertyDifferences, getGeoJsonPolygonFromBoundingBox, getISOStringFromDate, getMultipleCoordinatesFromGeoJsonObject, getPointCoordinateFromGeoJsonObject, getPolygonFromBbox, getPolygonFromPointAndRadius, getResizedDimensions, getStartOfDay, groupBy, groupTinyDataToOthers, hourIntervals, intersection, isArrayEqual, isSorted, isUUID, isValidImage, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, objectEntries, objectFromEntries, objectKeys, objectValues, pick, removeLeftPadding, resizeBlob, resizeImage, size, stringCompare, stringCompareFromKey, stringNaturalCompare, stripHiddenCharacters, titleCase, toID, toIDs, toUUID, trimIds, trimPath, truthy, unionArraysByKey, uuidv3, uuidv4, uuidv5 };
+export { DateTimeFormat, EARTH_RADIUS, HoursAndMinutesFormat, align, alphabeticallySort, arrayLengthCompare, arrayNotEmpty, booleanCompare, capitalize, convertBlobToBase64, convertMetersToYards, convertYardsToMeters, coordinatesToStandardFormat, dateCompare, deleteUndefinedKeys, difference, doNothing, enumFromValue, enumFromValueTypesafe, enumOrUndefinedFromValue, exhaustiveCheck, filterByMultiple, formatAddress, formatCoordinates, fuzzySearch, geoJsonBboxSchema, geoJsonGeometrySchema, geoJsonLineStringSchema, geoJsonLinearRingSchema, geoJsonMultiLineStringSchema, geoJsonMultiPointSchema, geoJsonMultiPolygonSchema, geoJsonPointSchema, geoJsonPolygonNoHolesSchema, geoJsonPolygonSchema, geoJsonPositionSchema, geoJsonRectangularBoxPolygonSchema, getBoundingBoxFromGeoJsonPolygon, getDifferenceBetweenDates, getEndOfDay, getFirstLevelObjectPropertyDifferences, getGeoJsonPolygonFromBoundingBox, getISOStringFromDate, getMultipleCoordinatesFromGeoJsonObject, getPointCoordinateFromGeoJsonObject, getPointCoordinateFromGeoJsonPoint, getPolygonFromBbox, getPolygonFromPointAndRadius, getResizedDimensions, getStartOfDay, groupBy, groupTinyDataToOthers, hourIntervals, intersection, isArrayEqual, isSorted, isUUID, isValidImage, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, objectEntries, objectFromEntries, objectKeys, objectValues, pick, removeLeftPadding, resizeBlob, resizeImage, size, stringCompare, stringCompareFromKey, stringNaturalCompare, stripHiddenCharacters, titleCase, toID, toIDs, toUUID, trimIds, trimPath, truthy, unionArraysByKey, uuidv3, uuidv4, uuidv5 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/shared-utils",
-  "version": "0.0.82",
+  "version": "0.0.84",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/GeoJson/GeoJsonUtils.d.ts

@@ -8,14 +8,21 @@ interface BoundingBox {
     nw: PointCoordinate;
     se: PointCoordinate;
 }
+export type GeoPoint = [number, number];
 interface GeoJSONGeometry {
     type?: unknown;
-    coordinates?: number[] | number[][] | null;
+    coordinates?: GeoPoint | GeoPoint[] | GeoPoint[][] | null;
 }
 interface GeoJsonFeature {
     type?: unknown;
     geometry?: GeoJSONGeometry | null;
 }
+/**
+ * @description Returns coordinates in consistent format
+ * @param inconsistentCoordinates Single point, array of points or nested array of points
+ * @returns GeoPoint[]
+ */
+export declare const coordinatesToStandardFormat: (inconsistentCoordinates: GeoPoint | GeoPoint[] | GeoPoint[][] | null | undefined) => GeoPoint[];
 /**
  * @description Extracts a point coordinate from a GeoJSON object.
  * @param geoObject A GeoJSON object.
@@ -45,4 +52,8 @@ export declare const getBoundingBoxFromGeoJsonPolygon: (polygon: GeoJsonPolygon)
  * @description Creates a GeoJSON Polygon from a TU bounding box.
  */
 export declare const getGeoJsonPolygonFromBoundingBox: (boundingBox: BoundingBox) => GeoJsonPolygon;
+/**
+ * @description Creates TU point coordinate from a GeoJSON Point.
+ */
+export declare const getPointCoordinateFromGeoJsonPoint: (point: GeoJsonPoint) => PointCoordinate;
 export {};