@trackunit/geo-json-utils 0.0.1

package/src/GeoJsonUtils.d.ts

@@ -0,0 +1,73 @@
+import { GeoJsonBbox, GeoJsonLinearRing, GeoJsonMultiPolygon, GeoJsonPoint, GeoJsonPolygon, GeoJsonPosition } from "./GeoJsonSchemas";
+import { TuGeoJsonPolygonNoHoles } from "./TuGeoJsonSchemas";
+export declare const EARTH_RADIUS = 6378137;
+interface TuCoordinate {
+    longitude: number;
+    latitude: number;
+}
+interface TuBoundingBox {
+    nw: TuCoordinate;
+    se: TuCoordinate;
+}
+/**
+ * @description Creates a polygon (with no holes) from a bounding box.
+ */
+export declare const getPolygonFromBbox: (bbox: GeoJsonBbox) => TuGeoJsonPolygonNoHoles;
+/**
+ * @description Creates a bounding box from a GeoJSON Polygon.
+ */
+export declare const getBboxFromGeoJsonPolygon: (polygon: GeoJsonPolygon) => GeoJsonBbox | null;
+/**
+ * @description Creates a round polygon from a point and a radius.
+ */
+export declare const getPolygonFromPointAndRadius: (point: GeoJsonPoint, radius: number) => GeoJsonPolygon;
+/**
+ * @description Creates a TU bounding box from a GeoJson Polygon.
+ */
+export declare const getBoundingBoxFromGeoJsonPolygon: (polygon: GeoJsonPolygon) => TuBoundingBox | null;
+/**
+ * @description Creates a GeoJSON Polygon from a TU bounding box.
+ */
+export declare const getGeoJsonPolygonFromBoundingBox: (boundingBox: TuBoundingBox) => GeoJsonPolygon;
+/**
+ * @description Creates TU point coordinate from a GeoJSON Point.
+ */
+export declare const getPointCoordinateFromGeoJsonPoint: (point: GeoJsonPoint) => TuCoordinate;
+/**
+ * @description Gets the extreme point of a polygon in a given direction.
+ * @param {object} params - The parameters object
+ * @param {GeoJsonPolygon} params.polygon - The polygon to get the extreme point from
+ * @param {("top" | "right" | "bottom" | "left")} params.direction - The direction to get the extreme point in
+ * @returns {GeoJsonPoint} The extreme point in the given direction
+ */
+export declare const getExtremeGeoJsonPointFromPolygon: ({ polygon, direction, }: {
+    polygon: GeoJsonPolygon;
+    direction: "top" | "right" | "bottom" | "left";
+}) => GeoJsonPoint | null;
+/**
+ * Checks if a position is inside a linear ring. On edge is considered inside.
+ */
+export declare const isGeoJsonPositionInLinearRing: ({ position, linearRing, }: {
+    position: GeoJsonPosition;
+    linearRing: GeoJsonLinearRing;
+}) => boolean | null;
+/**
+ * @description Checks if a point is inside a polygon.
+ */
+export declare const isGeoJsonPointInPolygon: ({ point, polygon, }: {
+    point: GeoJsonPoint;
+    polygon: GeoJsonPolygon;
+}) => boolean | null;
+/**
+ * Checks if polygon1 is fully contained within polygon2
+ */
+export declare const isFullyContainedInGeoJsonPolygon: (polygon1: GeoJsonPolygon, polygon2: GeoJsonPolygon) => boolean | null;
+/**
+ * @description Gets the intersection between two GeoJSON polygons. If one polygon is fully contained within the other,
+ * returns the contained polygon. Otherwise returns a MultiPolygon representing the intersection.
+ * @param polygon1 The first polygon to check intersection
+ * @param polygon2 The second polygon to check intersection
+ * @returns {(GeoJsonMultiPolygon | GeoJsonPolygon)} The intersection as either a Polygon (if one contains the other) or MultiPolygon
+ */
+export declare const getGeoJsonPolygonIntersection: (polygon1: GeoJsonPolygon, polygon2: GeoJsonPolygon) => GeoJsonMultiPolygon | GeoJsonPolygon | null;
+export {};

package/src/TUGeoJsonObjectBridgeUtils.d.ts

@@ -0,0 +1,33 @@
+import { GeoJsonPosition } from "./GeoJsonSchemas";
+interface PointCoordinate {
+    longitude: number;
+    latitude: number;
+}
+interface GeoJSONGeometry {
+    type?: unknown;
+    coordinates?: GeoJsonPosition | GeoJsonPosition[] | GeoJsonPosition[][] | 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 {GeoJsonPosition[]} Array of standardized coordinates
+ */
+export declare const coordinatesToStandardFormat: (inconsistentCoordinates: GeoJsonPosition | GeoJsonPosition[] | GeoJsonPosition[][] | null | undefined) => [number, number][];
+/**
+ * @description Extracts a point coordinate from a GeoJSON object.
+ * @param geoObject A GeoJSON object.
+ * @returns {PointCoordinate} A point coordinate.
+ */
+export declare const getPointCoordinateFromGeoJsonObject: (geoObject: GeoJsonFeature | GeoJSONGeometry | undefined | null) => PointCoordinate | undefined;
+/**
+ * @description Extracts multiple point coordinates from a GeoJSON object.
+ * @param geoObject A GeoJSON object.
+ * @returns {PointCoordinate[]} An array of point coordinates.
+ * @example getMultipleCoordinatesFromGeoJsonObject({ type: "Point", coordinates: [1, 2] }) // [{ longitude: 1, latitude: 2 }]
+ */
+export declare const getMultipleCoordinatesFromGeoJsonObject: (geoObject: GeoJsonFeature | GeoJSONGeometry | undefined | null) => PointCoordinate[] | undefined;
+export {};

package/src/TuGeoJsonSchemas.d.ts

@@ -0,0 +1,58 @@
+import { z } from "zod";
+/**
+ * Polygon geometry object that explicitly disallows holes.
+ *
+ * Same as geoJsonPolygonSchema but type disallows holes by
+ * using tuple of one single linear ring instead of an array.
+ */
+export declare const tuGeoJsonPolygonNoHolesSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Polygon">;
+    coordinates: z.ZodTuple<[z.ZodEffects<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, [number, number][], [number, number][]>], null>;
+}, "strict", z.ZodTypeAny, {
+    type: "Polygon";
+    coordinates: [[number, number][]];
+}, {
+    type: "Polygon";
+    coordinates: [[number, number][]];
+}>;
+export type TuGeoJsonPolygonNoHoles = z.infer<typeof tuGeoJsonPolygonNoHolesSchema>;
+/**
+ * Point radius object.
+ * For when you wish to define an area by a point and a radius.
+ *
+ * radius is in meters
+ */
+export declare const tuGeoJsonPointRadiusSchema: z.ZodObject<{
+    type: z.ZodLiteral<"PointRadius">;
+    coordinates: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
+    radius: z.ZodNumber;
+}, "strict", z.ZodTypeAny, {
+    type: "PointRadius";
+    coordinates: [number, number];
+    radius: number;
+}, {
+    type: "PointRadius";
+    coordinates: [number, number];
+    radius: number;
+}>;
+export type TuGeoJsonPointRadius = z.infer<typeof tuGeoJsonPointRadiusSchema>;
+/**
+ * A Polygon with exactly 5 points and 4 horizontal/vertical sides that form a normal rectangular box.
+ */
+export declare const tuGeoJsonRectangularBoxPolygonSchema: z.ZodEffects<z.ZodObject<{
+    type: z.ZodLiteral<"Polygon">;
+    coordinates: z.ZodArray<z.ZodEffects<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, [number, number][], [number, number][]>, "many">;
+}, "strict", z.ZodTypeAny, {
+    type: "Polygon";
+    coordinates: [number, number][][];
+}, {
+    type: "Polygon";
+    coordinates: [number, number][][];
+}>, {
+    type: "Polygon";
+    coordinates: [number, number][][];
+}, {
+    type: "Polygon";
+    coordinates: [number, number][][];
+}>;
+export type TuGeoJsonRectangularBoxPolygon = z.infer<typeof tuGeoJsonRectangularBoxPolygonSchema>;

package/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./GeoJsonSchemas";
+export * from "./GeoJsonUtils";
+export * from "./TUGeoJsonObjectBridgeUtils";
+export * from "./TuGeoJsonSchemas";