@tmlmobilidade/utils 20250628.1632.4 → 20250628.1640.52

package/dist/src/geo/get-geofence-on-point.d.ts

@@ -0,0 +1,17 @@
+import { type Feature, type Point, type Polygon } from 'geojson';
+/**
+ * Create a geofence around a given point with a given radius in meters (default is 50 meters).
+ * @param point A GeoJSON Point representation of the point to create the geofence around.
+ * @param radius The distance in meters to calculate the geofence radius. Default is 50 meters.
+ * @param steps The number of steps to use for the buffer. Default is 16.
+ * @returns The GeoJSON Feature of a Polygon.
+ */
+export declare function getGeofenceOnPoint(point: Feature<Point>, radius?: number, steps?: number): Feature<Polygon>;
+/**
+ * Create a geofence around a given position with a given radius in meters (default is 50 meters).
+ * @param position A tuple representing the coordinates of the point to create the geofence around.
+ * @param radius The distance in meters to calculate the geofence radius. Default is 50 meters.
+ * @param steps The number of steps to use for the buffer. Default is 16.
+ * @returns The GeoJSON Feature of a Polygon.
+ */
+export declare function getGeofenceOnPosition(position: [number, number], radius?: number, steps?: number): Feature<Polygon>;

package/dist/src/geo/get-geofence-on-point.js

@@ -0,0 +1,46 @@
+/* * */
+import { EARTH_RADIUS } from './constants.js';
+import { toFeatureFromObject, toPointFromPositions } from './conversions.js';
+import { polygon } from '@turf/helpers';
+/**
+ * Create a geofence around a given point with a given radius in meters (default is 50 meters).
+ * @param point A GeoJSON Point representation of the point to create the geofence around.
+ * @param radius The distance in meters to calculate the geofence radius. Default is 50 meters.
+ * @param steps The number of steps to use for the buffer. Default is 16.
+ * @returns The GeoJSON Feature of a Polygon.
+ */
+export function getGeofenceOnPoint(point, radius = 50, steps = 16) {
+    // Extract the center coordinates from the point
+    const [centerLon, centerLat] = point.geometry.coordinates;
+    // Set the angle size based on the number of steps
+    const angleStep = (2 * Math.PI) / steps;
+    // Set an empty array to hold the coordinates of the polygon vertices
+    const coords = [];
+    // Calculate the coordinates of the polygon vertices
+    for (let i = 0; i < steps; i++) {
+        const angle = i * angleStep;
+        const dx = radius * Math.cos(angle);
+        const dy = radius * Math.sin(angle);
+        const newLat = centerLat + (dy / EARTH_RADIUS) * (180 / Math.PI);
+        const newLng = centerLon + (dx / (EARTH_RADIUS * Math.cos((centerLat * Math.PI) / 180))) * (180 / Math.PI);
+        coords.push([newLng, newLat]);
+    }
+    // Close the polygon by adding the first coordinate to the end
+    coords.push(coords[0]);
+    // Return the polygon feature
+    return polygon([coords]);
+}
+/**
+ * Create a geofence around a given position with a given radius in meters (default is 50 meters).
+ * @param position A tuple representing the coordinates of the point to create the geofence around.
+ * @param radius The distance in meters to calculate the geofence radius. Default is 50 meters.
+ * @param steps The number of steps to use for the buffer. Default is 16.
+ * @returns The GeoJSON Feature of a Polygon.
+ */
+export function getGeofenceOnPosition(position, radius = 50, steps = 16) {
+    // Create a point feature from the coordinates
+    const newPoint = toPointFromPositions(position);
+    const newFeature = toFeatureFromObject(newPoint);
+    // Call the getGeofenceOnPoint function to create the geofence
+    return getGeofenceOnPoint(newFeature, radius, steps);
+}

package/dist/src/geo/index.d.ts

@@ -2,4 +2,5 @@ export * from './chunk-line.js';
 export * from './constants.js';
 export * from './conversions.js';
 export * from './cut-line-at-length.js';
+export * from './get-geofence-on-point.js';
 export * from './measurements.js';

package/dist/src/geo/index.js

@@ -2,4 +2,5 @@ export * from './chunk-line.js';
 export * from './constants.js';
 export * from './conversions.js';
 export * from './cut-line-at-length.js';
+export * from './get-geofence-on-point.js';
 export * from './measurements.js';

package/dist/src/geo/is-point-in-polygon.d.ts

@@ -0,0 +1,9 @@
+import { type Feature, type Point, type Polygon, type Position } from 'geojson';
+/**
+ * Check if a point is inside a polygon using the ray-casting algorithm.
+ * @param point A GeoJSON Point representation of the point to check.
+ * @param geofence A GeoJSON Polygon representation of the geofence.
+ * @returns A boolean indicating if the point is inside the polygon.
+ * @see https://en.wikipedia.org/wiki/Point_in_polygon#Ray_casting_algorithm
+ */
+export declare function isPointInPolygon(point: Feature<Point> | Position, polygon: Feature<Polygon>): boolean;

package/dist/src/geo/is-point-in-polygon.js

@@ -0,0 +1,37 @@
+/* * */
+/**
+ * Check if a point is inside a polygon using the ray-casting algorithm.
+ * @param point A GeoJSON Point representation of the point to check.
+ * @param geofence A GeoJSON Polygon representation of the geofence.
+ * @returns A boolean indicating if the point is inside the polygon.
+ * @see https://en.wikipedia.org/wiki/Point_in_polygon#Ray_casting_algorithm
+ */
+export function isPointInPolygon(point, polygon) {
+    //
+    const pt = Array.isArray(point) ? point : point.geometry.coordinates;
+    const [x, y] = pt;
+    const ring = polygon.geometry.coordinates[0]; // Outer ring only
+    let inside = false;
+    for (let i = 0, j = ring.length - 1; i < ring.length; j = i++) {
+        const xi = ring[i][0], yi = ring[i][1];
+        const xj = ring[j][0], yj = ring[j][1];
+        const intersectsVertically = (yi > y) !== (yj > y);
+        const edgeSlope = (xj - xi) / (yj - yi + 1e-10); // slope of the edge
+        const xIntersect = edgeSlope * (y - yi) + xi;
+        const isToRight = x < xIntersect;
+        const intersects = intersectsVertically && isToRight;
+        if (intersects)
+            inside = !inside;
+    }
+    return inside;
+}
+// /**
+//  * Check if a point is inside a geofence polygon.
+//  * @param point A GeoJSON Point representation of the point to check.
+//  * @param geofence A GeoJSON Polygon representation of the geofence.
+//  * @returns A boolean indicating if the point is inside the geofence polygon.
+//  */
+// export function isInsideGeofence(point: Position, geofence: Feature<Polygon>): boolean {
+// 	// Check if the point is inside the polygon
+// 	return isPointInPolygon(point, geofence);
+// }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/utils",
-	"version": "20250628.1632.4",
+	"version": "20250628.1640.52",
 	"author": "João de Vasconcelos & Jusi Monteiro",
 	"license": "AGPL-3.0-or-later",
 	"homepage": "https://github.com/tmlmobilidade/services#readme",