@mailwoman/spatial 4.9.0 → 4.11.0

package/out/position.js

@@ -0,0 +1,169 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   This file contains types and utilities for working with geographic positions.
+ */
+import {} from "@googlemaps/google-maps-services-js";
+import { GeoPoint } from "@mailwoman/spatial";
+/**
+ * Orders the given coordinates as [longitude, latitude].
+ *
+ * This is useful when converting into GeoJSON format.
+ *
+ * @category GeoJSON
+ * @category Position
+ */
+export function orderCoordPairToGeoJSON([latitude, longitude]) {
+    return [longitude, latitude];
+}
+/**
+ * Orders the given coordinates as [latitude, longitude].
+ *
+ * This is useful when converting into Google Maps format.
+ *
+ * @category GeoJSON
+ * @category Position
+ */
+export function orderGeoJSONToCoordPair([longitude, latitude]) {
+    return [latitude, longitude];
+}
+/**
+ * Given an input which appears to be reversed GeoJSON coordinates (i.e. [latitude, longitude]),
+ * returns the coordinates in the correct order of [longitude, latitude].
+ *
+ * Note that this is a heuristic and is only accurate for North American coordinates.
+ *
+ * @category GeoJSON
+ * @category Position
+ */
+export function inferGeoJSONCoordOrder([coordA, coordB]) {
+    // Latitude values typically range from -90 to 90
+    const isCoordALat = coordA >= -90 && coordA <= 90;
+    const isCoordBLat = coordB >= -90 && coordB <= 90;
+    if (isCoordALat && !isCoordBLat) {
+        // coordA is latitude, coordB is longitude
+        return [coordB, coordA];
+    }
+    if (!isCoordALat && isCoordBLat) {
+        // coordB is latitude, coordA is longitude
+        return [coordA, coordB];
+    }
+    // In case both appear to be latitudes (unlikely) or longitudes (out of range for US),
+    // assume coordA is longitude and coordB is latitude as default.
+    return [coordA, coordB];
+}
+/**
+ * Type-predicate to determine if the given input is a GeoJSON Point geometry.
+ *
+ * @category Type Predicates
+ * @category GeoJSON
+ */
+export function isCoordPairLiteral(input) {
+    if (!Array.isArray(input))
+        return false;
+    if (input.length !== 2 && input.length !== 3)
+        return false;
+    return input.every((coord) => typeof coord === "number");
+}
+/**
+ * Type-predicate to determine if the given input is a {@linkcode LatLngLiteral} object.
+ *
+ * @category Position
+ * @category Type Predicates
+ * @see {@link https://developers.google.com/maps/documentation/javascript/reference/coordinates#LatLngLiteral Google Maps API Documentation}
+ */
+export function isGoogleMapsLatLngLiteral(input) {
+    if (!input || typeof input !== "object")
+        return false;
+    if (!Object.hasOwn(input, "lat") || !Object.hasOwn(input, "lng"))
+        return false;
+    return true;
+}
+/**
+ * Type-predicate to determine if the given input is a {@linkcode InternalPointCoordinates} object.
+ *
+ * @category Position
+ * @category Type Predicates
+ */
+export function isInterpolatedCoordinates(input) {
+    if (!input || typeof input !== "object")
+        return false;
+    if (!("x" in input))
+        return false;
+    if (!("y" in input))
+        return false;
+    return typeof input.x === "number" && typeof input.y === "number";
+}
+/**
+ * Given a longitude value, wraps it to the range of [-180, 180].
+ *
+ * This is useful when normalizing longitude values.
+ *
+ * @category Position
+ * @param longitude The longitude value to wrap.
+ */
+export function wrapLongitude(longitude) {
+    return ((((longitude + 180) % 360) + 360) % 360) - 180;
+}
+/**
+ * Given a latitude value, clamps it to the range of [-90, 90].
+ *
+ * This is useful when normalizing latitude values.
+ *
+ * @category Position
+ * @param value The latitude value to clamp.
+ */
+export function clampLatitude(value) {
+    return Math.min(90, Math.max(-90, value));
+}
+/**
+ * Conversion factors for converting between degrees and radians.
+ *
+ * @category Position
+ * @see {@link https://en.wikipedia.org/wiki/Radian Wikipedia: Radian}
+ * @see {@link https://en.wikipedia.org/wiki/Degree_(angle) Wikipedia: Degree (angle)}
+ */
+export const ConversionFactor = {
+    DegreesToRadians: (Math.PI / 180),
+    RadiansToDegrees: (180 / Math.PI),
+};
+/**
+ * Radius of the Earth in various units
+ */
+const RADII = {
+    km: 6371,
+    miles: 3958.8,
+    meters: 6371000,
+};
+/**
+ * Calculate the distance between two points on the Earth's surface.
+ *
+ * @category Position
+ * @param point1 The first point to calculate the distance from.
+ * @param point2 The second point to calculate the distance to.
+ * @param unit The unit of measurement to return the distance in.
+ *
+ * @returns The distance between the two points in the specified unit.
+ */
+export function haversine(point1, point2, unit = "km") {
+    const p1 = GeoPoint.from(point1);
+    const p2 = GeoPoint.from(point2);
+    if (!p1 || !p2)
+        return NaN;
+    const lat1 = p1.latitude;
+    const lon1 = p1.longitude;
+    const lat2 = p2.latitude;
+    const lon2 = p2.longitude;
+    const dLat = (lat2 - lat1) * ConversionFactor.DegreesToRadians;
+    const dLon = (lon2 - lon1) * ConversionFactor.DegreesToRadians;
+    const a = Math.pow(Math.sin(dLat / 2), 2) +
+        Math.cos(lat1 * ConversionFactor.DegreesToRadians) *
+            Math.cos(lat2 * ConversionFactor.DegreesToRadians) *
+            Math.pow(Math.sin(dLon / 2), 2);
+    const c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a));
+    const radius = RADII[unit];
+    return radius * c;
+}
+//# sourceMappingURL=position.js.map

package/out/position.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"position.js","sourceRoot":"","sources":["../position.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAsB,MAAM,qCAAqC,CAAA;AACxE,OAAO,EAAE,QAAQ,EAAsB,MAAM,oBAAoB,CAAA;AA6BjE;;;;;;;GAOG;AACH,MAAM,UAAU,uBAAuB,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAmB;IAC9E,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAA;AAC7B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,uBAAuB,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAgB;IAC3E,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;AAC7B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CAAC,CAAC,MAAM,EAAE,MAAM,CAAmB;IACxE,iDAAiD;IACjD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,EAAE,IAAI,MAAM,IAAI,EAAE,CAAA;IACjD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,EAAE,IAAI,MAAM,IAAI,EAAE,CAAA;IAEjD,IAAI,WAAW,IAAI,CAAC,WAAW,EAAE,CAAC;QACjC,0CAA0C;QAC1C,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxB,CAAC;IAED,IAAI,CAAC,WAAW,IAAI,WAAW,EAAE,CAAC;QACjC,0CAA0C;QAC1C,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxB,CAAC;IAED,sFAAsF;IACtF,gEAAgE;IAChE,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AACxB,CAAC;AAkDD;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAChD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IAEvC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IAE1D,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAA;AACzD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,yBAAyB,CAAC,KAAc;IACvD,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAErD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IAE9E,OAAO,IAAI,CAAA;AACZ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,KAAc;IACvD,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAErD,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IACjC,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IAEjC,OAAO,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ,CAAA;AAClE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,SAAiB;IAC9C,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAA;AACvD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa;IAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAA;AAC1C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B,gBAAgB,EAAE,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAA6B;IAC7D,gBAAgB,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAA6B;CACpD,CAAA;AAOV;;GAEG;AACH,MAAM,KAAK,GAAG;IACb,EAAE,EAAE,IAAI;IACR,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,OAAO;CACoC,CAAA;AAEpD;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS,CAAC,MAAqB,EAAE,MAAqB,EAAE,OAAwB,IAAI;IACnG,MAAM,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAChC,MAAM,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAEhC,IAAI,CAAC,EAAE,IAAI,CAAC,EAAE;QAAE,OAAO,GAAG,CAAA;IAE1B,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CAAA;IACxB,MAAM,IAAI,GAAG,EAAE,CAAC,SAAS,CAAA;IACzB,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CAAA;IACxB,MAAM,IAAI,GAAG,EAAE,CAAC,SAAS,CAAA;IAEzB,MAAM,IAAI,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,gBAAgB,CAAC,gBAAgB,CAAA;IAE9D,MAAM,IAAI,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,gBAAgB,CAAC,gBAAgB,CAAA;IAE9D,MAAM,CAAC,GACN,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;QAC/B,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,gBAAgB,CAAC,gBAAgB,CAAC;YACjD,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,gBAAgB,CAAC,gBAAgB,CAAC;YAClD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAEjC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACxD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAA;IAE1B,OAAO,MAAM,GAAG,CAAC,CAAA;AAClB,CAAC"}

package/out/projection.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+/**
+ * A coordinate system used to represent the Earth's surface.
+ *
+ * @category Geo
+ */
+export declare enum CoordinateProjection {
+    /**
+     * Coordinate system used in Google Earth and GSP systems.
+     *
+     * It represents Earth as a three-dimensional ellipsoid.
+     */
+    WGS84 = "4326",
+    /**
+     * North American Datum 1983, a geodetic reference system used in the TIGER/Line data.
+     */
+    NAD83 = "4269"
+}
+//# sourceMappingURL=projection.d.ts.map

package/out/projection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"projection.d.ts","sourceRoot":"","sources":["../projection.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AACH,oBAAY,oBAAoB;IAC/B;;;;OAIG;IACH,KAAK,SAAS;IACd;;OAEG;IACH,KAAK,SAAS;CACd"}

package/out/projection.js

@@ -0,0 +1,24 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+/**
+ * A coordinate system used to represent the Earth's surface.
+ *
+ * @category Geo
+ */
+export var CoordinateProjection;
+(function (CoordinateProjection) {
+    /**
+     * Coordinate system used in Google Earth and GSP systems.
+     *
+     * It represents Earth as a three-dimensional ellipsoid.
+     */
+    CoordinateProjection["WGS84"] = "4326";
+    /**
+     * North American Datum 1983, a geodetic reference system used in the TIGER/Line data.
+     */
+    CoordinateProjection["NAD83"] = "4269";
+})(CoordinateProjection || (CoordinateProjection = {}));
+//# sourceMappingURL=projection.js.map

package/out/projection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projection.js","sourceRoot":"","sources":["../projection.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AACH,MAAM,CAAN,IAAY,oBAWX;AAXD,WAAY,oBAAoB;IAC/B;;;;OAIG;IACH,sCAAc,CAAA;IACd;;OAEG;IACH,sCAAc,CAAA;AACf,CAAC,EAXW,oBAAoB,KAApB,oBAAoB,QAW/B"}

package/out/regions/codes.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+/**
+ * M.49 region codes for continents.
+ */
+export declare const RegionCodes: readonly ["AF", "AN", "AS", "EU", "NA", "OC", "SA"];
+/**
+ * M.49 region code for a specific continent.
+ *
+ * @public
+ */
+export type RegionCode = (typeof RegionCodes)[number];
+/**
+ * Continent codes to their full names.
+ *
+ * @internal
+ */
+export declare const RegionCodeToNameRecord: {
+    readonly AF: "Africa";
+    readonly AN: "Antarctica";
+    readonly AS: "Asia";
+    readonly EU: "Europe";
+    readonly NA: "North America";
+    readonly OC: "Oceania";
+    readonly SA: "South America";
+};
+//# sourceMappingURL=codes.d.ts.map

package/out/regions/codes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codes.d.ts","sourceRoot":"","sources":["../../regions/codes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;GAEG;AACH,eAAO,MAAM,WAAW,qDASc,CAAA;AAEtC;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAA;AAErD;;;;GAIG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;CAQgB,CAAA"}

package/out/regions/codes.js

@@ -0,0 +1,33 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+/**
+ * M.49 region codes for continents.
+ */
+export const RegionCodes = [
+    // ---
+    "AF",
+    "AN",
+    "AS",
+    "EU",
+    "NA",
+    "OC",
+    "SA",
+];
+/**
+ * Continent codes to their full names.
+ *
+ * @internal
+ */
+export const RegionCodeToNameRecord = {
+    AF: "Africa",
+    AN: "Antarctica",
+    AS: "Asia",
+    EU: "Europe",
+    NA: "North America",
+    OC: "Oceania",
+    SA: "South America",
+};
+//# sourceMappingURL=codes.js.map

package/out/regions/codes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codes.js","sourceRoot":"","sources":["../../regions/codes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IAC1B,MAAM;IACN,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;CACiC,CAAA;AAStC;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACrC,EAAE,EAAE,QAAQ;IACZ,EAAE,EAAE,YAAY;IAChB,EAAE,EAAE,MAAM;IACV,EAAE,EAAE,QAAQ;IACZ,EAAE,EAAE,eAAe;IACnB,EAAE,EAAE,SAAS;IACb,EAAE,EAAE,eAAe;CAC+B,CAAA"}

package/out/regions/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+export * from "./codes.js";
+export * from "./names.js";
+//# sourceMappingURL=index.d.ts.map

package/out/regions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../regions/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA"}

package/out/regions/index.js

@@ -0,0 +1,8 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+export * from "./codes.js";
+export * from "./names.js";
+//# sourceMappingURL=index.js.map

package/out/regions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../regions/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA"}

package/out/regions/names.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+/**
+ * A list of geographic regions, i.e. continents.
+ *
+ * @category Geographic
+ */
+export declare const RegionNames: readonly ["Africa", "Antarctica", "Asia", "Europe", "North America", "Oceania", "South America"];
+/**
+ * A region of the world, i.e. a continent.
+ *
+ * @category Geographic
+ * @title Geographic Region
+ * @public
+ */
+export type RegionName = (typeof RegionNames)[number];
+//# sourceMappingURL=names.d.ts.map

package/out/regions/names.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"names.d.ts","sourceRoot":"","sources":["../../regions/names.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AACH,eAAO,MAAM,WAAW,kGAQc,CAAA;AAEtC;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAA"}

package/out/regions/names.js

@@ -0,0 +1,20 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+/**
+ * A list of geographic regions, i.e. continents.
+ *
+ * @category Geographic
+ */
+export const RegionNames = [
+    "Africa",
+    "Antarctica",
+    "Asia",
+    "Europe",
+    "North America",
+    "Oceania",
+    "South America",
+];
+//# sourceMappingURL=names.js.map

package/out/regions/names.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"names.js","sourceRoot":"","sources":["../../regions/names.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IAC1B,QAAQ;IACR,YAAY;IACZ,MAAM;IACN,QAAQ;IACR,eAAe;IACf,SAAS;IACT,eAAe;CACsB,CAAA"}

package/out/sdk/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+export * from "./well-known-text.js";
+//# sourceMappingURL=index.d.ts.map

package/out/sdk/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../sdk/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,sBAAsB,CAAA"}

package/out/sdk/index.js

@@ -0,0 +1,7 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+export * from "./well-known-text.js";
+//# sourceMappingURL=index.js.map

package/out/sdk/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../sdk/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,sBAAsB,CAAA"}

package/out/sdk/well-known-text.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Provides functions for parsing and converting extended Well-Known text and binary data.
+ */
+import type { GeometryCollection, GeometryLiteral } from "@mailwoman/spatial";
+/**
+ * Given an extended Well-Known Binary (EWKB) buffer, parse it into a GeoJSON geometry object.
+ *
+ * @category Geo
+ */
+export declare function wellKnownGeometryToGeoJSON<T = GeometryLiteral>(extendedWellKnownBinary: Buffer): T;
+/**
+ * Given an extended Well-Known-Text, parse it into a GeoJSON geometry object.
+ *
+ * @category Geo
+ */
+export declare function wellKnownGeometryToGeoJSON<T = GeometryLiteral>(wellKnownText: string): T;
+/**
+ * Given an extended Well-Known-Text, parse it into a GeoJSON geometry object.
+ *
+ * @category Geo
+ */
+export declare function wellKnownGeometryToGeoJSON<T = GeometryLiteral>(input: Buffer | string): T;
+/**
+ * Given a GeoJSON geometry object, convert it to an well-known binary (EWKB) buffer.
+ *
+ * @category Geo
+ * @returns A hex-encoded EWKB string or WKB buffer.
+ */
+export declare function geometryToWKB(geometry: GeometryLiteral | GeometryCollection): Buffer<ArrayBufferLike>;
+/**
+ * Given a GeoJSON geometry object, convert it to an extended well-known binary (EWKB) buffer.
+ *
+ * @category Geo
+ * @returns A buffer representing the EWKB.
+ */
+export declare function geometryToEWKB(geometry: GeometryLiteral | GeometryCollection): Buffer<ArrayBufferLike>;
+/**
+ * Given a GeoJSON geometry object, convert it to an extended well-known binary (EWKB) buffer.
+ *
+ * @category Geo
+ * @returns A hex-encoded string representing the EWKB.
+ */
+export declare function geometryToEWKH(geometry: GeometryLiteral | GeometryCollection): string;
+/**
+ * Given a GeoJSON geometry object, convert it to an extended well-known text (EWKT) string.
+ *
+ * @category Geo
+ */
+export declare function geometryToWKT(geometry: GeometryLiteral | GeometryCollection): string;
+/**
+ * Given a GeoJSON geometry object, convert it to a SQL geometry string.
+ *
+ * This is useful for composing SQL queries that require geometry literals.
+ *
+ * @category Geo
+ */
+export declare function geometryToSQL<T extends GeometryLiteral | GeometryCollection>(geometry: T | null | undefined): () => string;
+//# sourceMappingURL=well-known-text.d.ts.map

package/out/sdk/well-known-text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"well-known-text.d.ts","sourceRoot":"","sources":["../../sdk/well-known-text.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAG7E;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,GAAG,eAAe,EAAE,uBAAuB,EAAE,MAAM,GAAG,CAAC,CAAA;AACnG;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,GAAG,eAAe,EAAE,aAAa,EAAE,MAAM,GAAG,CAAC,CAAA;AACzF;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,GAAG,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,CAAA;AAK1F;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,eAAe,GAAG,kBAAkB,2BAE3E;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,eAAe,GAAG,kBAAkB,2BAE5E;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,eAAe,GAAG,kBAAkB,UAE5E;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,eAAe,GAAG,kBAAkB,GAAG,MAAM,CAEpF;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,eAAe,GAAG,kBAAkB,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,gBAM3G"}

package/out/sdk/well-known-text.js

@@ -0,0 +1,61 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Provides functions for parsing and converting extended Well-Known text and binary data.
+ */
+import wkx from "wkx";
+export function wellKnownGeometryToGeoJSON(input) {
+    return wkx.Geometry.parse(input).toGeoJSON();
+}
+/**
+ * Given a GeoJSON geometry object, convert it to an well-known binary (EWKB) buffer.
+ *
+ * @category Geo
+ * @returns A hex-encoded EWKB string or WKB buffer.
+ */
+export function geometryToWKB(geometry) {
+    return wkx.Geometry.parseGeoJSON(geometry).toWkb();
+}
+/**
+ * Given a GeoJSON geometry object, convert it to an extended well-known binary (EWKB) buffer.
+ *
+ * @category Geo
+ * @returns A buffer representing the EWKB.
+ */
+export function geometryToEWKB(geometry) {
+    return wkx.Geometry.parseGeoJSON(geometry).toEwkb();
+}
+/**
+ * Given a GeoJSON geometry object, convert it to an extended well-known binary (EWKB) buffer.
+ *
+ * @category Geo
+ * @returns A hex-encoded string representing the EWKB.
+ */
+export function geometryToEWKH(geometry) {
+    return geometryToEWKB(geometry).toString("hex");
+}
+/**
+ * Given a GeoJSON geometry object, convert it to an extended well-known text (EWKT) string.
+ *
+ * @category Geo
+ */
+export function geometryToWKT(geometry) {
+    return wkx.Geometry.parseGeoJSON(geometry).toWkt();
+}
+/**
+ * Given a GeoJSON geometry object, convert it to a SQL geometry string.
+ *
+ * This is useful for composing SQL queries that require geometry literals.
+ *
+ * @category Geo
+ */
+export function geometryToSQL(geometry) {
+    return () => {
+        if (!geometry)
+            return `NULL`;
+        return /* sql */ `GeomFromEWKB('${geometryToEWKH(geometry)}')`;
+    };
+}
+//# sourceMappingURL=well-known-text.js.map

package/out/sdk/well-known-text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"well-known-text.js","sourceRoot":"","sources":["../../sdk/well-known-text.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,GAAG,MAAM,KAAK,CAAA;AAoBrB,MAAM,UAAU,0BAA0B,CAAsB,KAAsB;IACrF,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,EAAO,CAAA;AAClD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,QAA8C;IAC3E,OAAO,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAA;AACnD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,QAA8C;IAC5E,OAAO,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,CAAA;AACpD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,QAA8C;IAC5E,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;AAChD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,QAA8C;IAC3E,OAAO,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAA;AACnD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAiD,QAA8B;IAC3G,OAAO,GAAG,EAAE;QACX,IAAI,CAAC,QAAQ;YAAE,OAAO,MAAM,CAAA;QAE5B,OAAO,SAAS,CAAC,iBAAiB,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAA;IAC/D,CAAC,CAAA;AACF,CAAC"}