@trackunit/shared-utils 0.0.85 → 0.0.86

package/src/GeoJson/GeoJsonSchemas.d.ts

@@ -1,176 +0,0 @@
-import { z } from "zod";
-/**
- * A Position is an array of coordinates. [x, y]
- * https://tools.ietf.org/html/rfc7946#section-3.1.1
- */
-export declare const geoJsonPositionSchema: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
-export type GeoJsonPosition = z.infer<typeof geoJsonPositionSchema>;
-/**
- * Point geometry object.
- * https://tools.ietf.org/html/rfc7946#section-3.1.2
- */
-export declare const geoJsonPointSchema: z.ZodObject<{
-    type: z.ZodLiteral<"Point">;
-    coordinates: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
-}, "strict", z.ZodTypeAny, {
-    type: "Point";
-    coordinates: [number, number];
-}, {
-    type: "Point";
-    coordinates: [number, number];
-}>;
-export type GeoJsonPoint = z.infer<typeof geoJsonPointSchema>;
-/**
- * MultiPoint geometry object.
- *  https://tools.ietf.org/html/rfc7946#section-3.1.3
- */
-export declare const geoJsonMultiPointSchema: z.ZodObject<{
-    type: z.ZodLiteral<"MultiPoint">;
-    coordinates: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">;
-}, "strict", z.ZodTypeAny, {
-    type: "MultiPoint";
-    coordinates: [number, number][];
-}, {
-    type: "MultiPoint";
-    coordinates: [number, number][];
-}>;
-export type GeoJsonMultiPoint = z.infer<typeof geoJsonMultiPointSchema>;
-/**
- * LineString geometry object.
- * Minimum length of 2 positions.
- * https://tools.ietf.org/html/rfc7946#section-3.1.4
- */
-export declare const geoJsonLineStringSchema: z.ZodObject<{
-    type: z.ZodLiteral<"LineString">;
-    coordinates: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">;
-}, "strict", z.ZodTypeAny, {
-    type: "LineString";
-    coordinates: [number, number][];
-}, {
-    type: "LineString";
-    coordinates: [number, number][];
-}>;
-export type GeoJsonLineString = z.infer<typeof geoJsonLineStringSchema>;
-/**
- * MultiLineString geometry object.
- * https://tools.ietf.org/html/rfc7946#section-3.1.5
- */
-export declare const geoJsonMultiLineStringSchema: z.ZodObject<{
-    type: z.ZodLiteral<"MultiLineString">;
-    coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
-}, "strict", z.ZodTypeAny, {
-    type: "MultiLineString";
-    coordinates: [number, number][][];
-}, {
-    type: "MultiLineString";
-    coordinates: [number, number][][];
-}>;
-export type GeoJsonMultiLineString = z.infer<typeof geoJsonMultiLineStringSchema>;
-/**
- * Helper type for reuse across polygon schemas.
- *
- * - A linear ring is a closed LineString with four or more positions.
- * - The first and last positions are equivalent, and they MUST contain
-      identical values; their representation SHOULD also be identical
- * - A linear ring is the boundary of a surface or the boundary of a
-      hole in a surface
- * - A linear ring MUST follow the right-hand rule with respect to the
-      area it bounds, i.e., exterior rings are counterclockwise, and
-      holes are clockwise
- */
-export declare const geoJsonLinearRingSchema: z.ZodEffects<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, [number, number][], [number, number][]>;
-export type GeoJsonLinearRing = z.infer<typeof geoJsonLinearRingSchema>;
-/**
- * Polygon geometry object.
- * https://tools.ietf.org/html/rfc7946#section-3.1.6
- */
-export declare const geoJsonPolygonSchema: 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][][];
-}>;
-export type GeoJsonPolygon = z.infer<typeof geoJsonPolygonSchema>;
-/**
- * MultiPolygon geometry object.
- * https://tools.ietf.org/html/rfc7946#section-3.1.7
- */
-export declare const geoJsonMultiPolygonSchema: z.ZodObject<{
-    type: z.ZodLiteral<"MultiPolygon">;
-    coordinates: z.ZodArray<z.ZodArray<z.ZodEffects<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, [number, number][], [number, number][]>, "many">, "many">;
-}, "strict", z.ZodTypeAny, {
-    type: "MultiPolygon";
-    coordinates: [number, number][][][];
-}, {
-    type: "MultiPolygon";
-    coordinates: [number, number][][][];
-}>;
-export type GeoJsonMultiPolygon = z.infer<typeof geoJsonMultiPolygonSchema>;
-export declare const geoJsonGeometrySchema: z.ZodUnion<[z.ZodObject<{
-    type: z.ZodLiteral<"Point">;
-    coordinates: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
-}, "strict", z.ZodTypeAny, {
-    type: "Point";
-    coordinates: [number, number];
-}, {
-    type: "Point";
-    coordinates: [number, number];
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"MultiPoint">;
-    coordinates: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">;
-}, "strict", z.ZodTypeAny, {
-    type: "MultiPoint";
-    coordinates: [number, number][];
-}, {
-    type: "MultiPoint";
-    coordinates: [number, number][];
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"LineString">;
-    coordinates: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">;
-}, "strict", z.ZodTypeAny, {
-    type: "LineString";
-    coordinates: [number, number][];
-}, {
-    type: "LineString";
-    coordinates: [number, number][];
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"MultiLineString">;
-    coordinates: z.ZodArray<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, "many">;
-}, "strict", z.ZodTypeAny, {
-    type: "MultiLineString";
-    coordinates: [number, number][][];
-}, {
-    type: "MultiLineString";
-    coordinates: [number, number][][];
-}>, 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][][];
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"MultiPolygon">;
-    coordinates: z.ZodArray<z.ZodArray<z.ZodEffects<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, [number, number][], [number, number][]>, "many">, "many">;
-}, "strict", z.ZodTypeAny, {
-    type: "MultiPolygon";
-    coordinates: [number, number][][][];
-}, {
-    type: "MultiPolygon";
-    coordinates: [number, number][][][];
-}>]>;
-export type GeoJsonGeometry = z.infer<typeof geoJsonGeometrySchema>;
-/**
- * 2D bounding box of the GeoJSON object.
- * The value of the Bbox member is an array of length 4.
- *
- * [min_lon, min_lat, max_lon, max_lat]
- */
-export declare const geoJsonBboxSchema: z.ZodEffects<z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>, [number, number, number, number], [number, number, number, number]>;
-export type GeoJsonBbox = z.infer<typeof geoJsonBboxSchema>;

package/src/GeoJson/GeoJsonUtils.d.ts

@@ -1,73 +0,0 @@
-import { GeoJsonBbox, GeoJsonLinearRing, GeoJsonMultiPolygon, GeoJsonPoint, GeoJsonPolygon, GeoJsonPosition } from "./GeoJsonSchemas";
-import { TuGeoJsonPolygonNoHoles } from "./TuGeoJsonSchemas";
-export declare const EARTH_RADIUS = 6378137;
-interface PointCoordinate {
-    longitude: number;
-    latitude: number;
-}
-interface BoundingBox {
-    nw: PointCoordinate;
-    se: PointCoordinate;
-}
-/**
- * @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) => BoundingBox | null;
-/**
- * @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;
-/**
- * @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/GeoJson/TUGeoJsonObjectBridgeUtils.d.ts

@@ -1,33 +0,0 @@
-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/GeoJson/TuGeoJsonSchemas.d.ts

@@ -1,58 +0,0 @@
-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>;