@mailwoman/spatial 4.9.0 → 4.10.0

package/out/geometries/polygon.js

@@ -0,0 +1,94 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { ResourceError } from "@mailwoman/core/errors";
+/**
+ * Predicate for checking if a GeoJSON object is a `Polygon` geometry.
+ */
+export function isPolygonLiteral(input) {
+    if (typeof input !== "object" || input === null)
+        return false;
+    return "type" in input && input.type === "Polygon" && "coordinates" in input && Array.isArray(input.coordinates);
+}
+/**
+ * Predicate for checking if a polygon geometry is a solid, i.e. it has no holes.
+ */
+export function isSolidPolygonPath(input) {
+    return input.coordinates.length === 1;
+}
+/**
+ * Predicate for checking if a GeoJSON object is a `MultiPolygon` geometry.
+ */
+/**
+ * Given a polygon geometry, return an OSM filter string.
+ *
+ * This is useful when working with the Overpass API.
+ */
+export function polygonToOSMFilter(input) {
+    if (!isPolygonLiteral(input))
+        return "";
+    const [exteriorRing] = input.coordinates;
+    const filter = exteriorRing.map(([lon, lat]) => `${lat} ${lon}`).join(" ");
+    return `poly:'${filter}'`;
+}
+/**
+ * Tags returned by the Overpass API for a node.
+ *
+ * @category OSM
+ */
+export var OSMNodeTag;
+(function (OSMNodeTag) {
+    OSMNodeTag["HouseNumber"] = "addr:housenumber";
+    OSMNodeTag["PostCode"] = "addr:postcode";
+    OSMNodeTag["Street"] = "addr:street";
+    OSMNodeTag["State"] = "addr:state";
+    OSMNodeTag["City"] = "addr:city";
+    OSMNodeTag["Website"] = "website";
+    OSMNodeTag["Email"] = "email";
+    OSMNodeTag["Phone"] = "phone";
+    OSMNodeTag["Shop"] = "shop";
+    OSMNodeTag["Brand"] = "brand";
+    OSMNodeTag["Cuisine"] = "cuisine";
+    OSMNodeTag["Name"] = "name";
+    OSMNodeTag["Healthcare"] = "healthcare";
+    OSMNodeTag["Office"] = "office";
+    OSMNodeTag["Amenity"] = "amenity";
+})(OSMNodeTag || (OSMNodeTag = {}));
+export const ForbiddenResidentialOSMNodeTags = new Set([
+    OSMNodeTag.Shop,
+    OSMNodeTag.Brand,
+    OSMNodeTag.Cuisine,
+    OSMNodeTag.Office,
+    OSMNodeTag.Healthcare,
+]);
+/**
+ * Given an OSM element, attempts to infer if the result is a residential address.
+ */
+export function isResidentialElement(element) {
+    for (const key in element.tags) {
+        if (ForbiddenResidentialOSMNodeTags.has(key))
+            return false;
+    }
+    if (element.tags[OSMNodeTag.Amenity] === "restaurant")
+        return false;
+    return true;
+}
+export function fetchOSMElementViaOverpassAPI(input) {
+    const filter = polygonToOSMFilter(input);
+    const url = new URL("http://overpass-api.de/api/interpreter");
+    url.searchParams.set("data", `[out:json];(node['addr:housenumber'](${filter}););out body;>;out skel qt;`);
+    return fetch(url)
+        .then((response) => {
+        if (!response.ok)
+            throw ResourceError.from(response.status, response.statusText, "osm", "overpass-api", "fetch");
+        return response;
+    })
+        .then((response) => response.json())
+        .then((body) => body.elements)
+        .catch((error) => {
+        throw ResourceError.wrap(error, "osm", "overpass-api", "fetch");
+    });
+}
+//# sourceMappingURL=polygon.js.map

package/out/geometries/polygon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"polygon.js","sourceRoot":"","sources":["../../geometries/polygon.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAuGtD;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAsC,KAAc;IACnF,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAA;IAE7D,OAAO,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,aAAa,IAAI,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;AACjH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAqB;IACvD,OAAO,KAAK,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,CAAA;AACtC,CAAC;AAaD;;GAEG;AAEH;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAqB;IACvD,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,CAAA;IAEvC,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,WAAW,CAAA;IAExC,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAE1E,OAAO,SAAS,MAAM,GAAG,CAAA;AAC1B,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,UAgBX;AAhBD,WAAY,UAAU;IACrB,8CAAgC,CAAA;IAChC,wCAA0B,CAAA;IAC1B,oCAAsB,CAAA;IACtB,kCAAoB,CAAA;IACpB,gCAAkB,CAAA;IAClB,iCAAmB,CAAA;IACnB,6BAAe,CAAA;IACf,6BAAe,CAAA;IACf,2BAAa,CAAA;IACb,6BAAe,CAAA;IACf,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,uCAAyB,CAAA;IACzB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;AACpB,CAAC,EAhBW,UAAU,KAAV,UAAU,QAgBrB;AAED,MAAM,CAAC,MAAM,+BAA+B,GAA4B,IAAI,GAAG,CAAa;IAC3F,UAAU,CAAC,IAAI;IACf,UAAU,CAAC,KAAK;IAChB,UAAU,CAAC,OAAO;IAClB,UAAU,CAAC,MAAM;IACjB,UAAU,CAAC,UAAU;CACrB,CAAC,CAAA;AAsBF;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAA2B;IAC/D,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,+BAA+B,CAAC,GAAG,CAAC,GAAiB,CAAC;YAAE,OAAO,KAAK,CAAA;IACzE,CAAC;IAED,IAAI,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,YAAY;QAAE,OAAO,KAAK,CAAA;IAEnE,OAAO,IAAI,CAAA;AACZ,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,KAAqB;IAClE,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAA;IAExC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,wCAAwC,CAAC,CAAA;IAC7D,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,wCAAwC,MAAM,6BAA6B,CAAC,CAAA;IAEzG,OAAO,KAAK,CAAC,GAAG,CAAC;SACf,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QAClB,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,CAAC,CAAA;QAEhH,OAAO,QAAQ,CAAA;IAChB,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAsC,CAAC;SACvE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC;SAC7B,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QAChB,MAAM,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,CAAC,CAAA;IAChE,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/out/google/index.d.ts

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

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

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

package/out/google/index.js

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

package/out/google/index.js.map

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

package/out/google/place-id.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Google Place ID utilities.
+ */
+import type { Tagged } from "type-fest";
+/**
+ * A Place ID uniquely identifies a place in the Google Places database and on Google Maps.
+ *
+ * The length of the identifier may vary. Generally, the identifier is a 27-character string,
+ * however, more specific places may have longer identifiers.
+ *
+ * Place IDs appear to be base64-encoded strings, delimited by underscores and dashes.
+ *
+ * Note that Place IDs do change. Consider a them stale after a few days.
+ *
+ * @category Google
+ * @category Geocoding
+ * @type {string}
+ * @minLength 1
+ * @pattern ^[A-Za-z0-9_-]+$
+ * @title Google Place ID
+ */
+export type GooglePlaceID = Tagged<string, "GooglePlaceID">;
+/**
+ * Pattern for validating a Google Place ID.
+ */
+export declare const GOOGLE_PLACE_ID_PATTERN: RegExp;
+/**
+ * Type-predicate for checking if a value appears to be a valid Google Place ID.
+ *
+ * @category Google
+ * @category Geocoding
+ * @internal
+ */
+export declare function isGooglePlaceID(input: string): input is GooglePlaceID;
+//# sourceMappingURL=place-id.d.ts.map

package/out/google/place-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"place-id.d.ts","sourceRoot":"","sources":["../../google/place-id.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAEvC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;AAE3D;;GAEG;AACH,eAAO,MAAM,uBAAuB,QAAqB,CAAA;AAEzD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,aAAa,CAErE"}

package/out/google/place-id.js

@@ -0,0 +1,22 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Google Place ID utilities.
+ */
+/**
+ * Pattern for validating a Google Place ID.
+ */
+export const GOOGLE_PLACE_ID_PATTERN = /^[A-Za-z0-9_-]+$/;
+/**
+ * Type-predicate for checking if a value appears to be a valid Google Place ID.
+ *
+ * @category Google
+ * @category Geocoding
+ * @internal
+ */
+export function isGooglePlaceID(input) {
+    return GOOGLE_PLACE_ID_PATTERN.test(input.toString());
+}
+//# sourceMappingURL=place-id.js.map

package/out/google/place-id.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"place-id.js","sourceRoot":"","sources":["../../google/place-id.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAuBH;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,kBAAkB,CAAA;AAEzD;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,KAAa;IAC5C,OAAO,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;AACtD,CAAC"}

package/out/h3/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import type { Tagged } from "type-fest";
+import { GeoPoint, type PointLiteral } from "../geometries/point.js";
+/**
+ * A H3 cell index, full 64 bits.
+ *
+ * @type {string}
+ * @title H3 Cell Index
+ * @pattern ^[0-9a-f]{15}$
+ */
+export type H3Cell = Tagged<string, "H3Cell">;
+export declare function isH3Cell(value: string): value is H3Cell;
+/**
+ * A H3 cell index, shortened to 48 bits.
+ *
+ * @type {string}
+ * @title H3 Cell Index (Short)
+ * @pattern ^[0-9a-f]{12}$
+ */
+export type H3CellShort = Tagged<string, "H3CellShort">;
+/**
+ * Given a full H3 cell index, shorten it to 48 bits.
+ */
+export declare function shortenH3Cell(cell: H3Cell): H3CellShort;
+/**
+ * Given a short cell address, expand it to a full H3 cell index.
+ */
+export declare function expandH3Cell(h3CellShort: H3CellShort, resolution?: number): H3Cell;
+/**
+ * Given a geographic point, return a short cell address.
+ */
+export declare function shortCellToPoint(shortCell: H3CellShort, resolution?: number): GeoPoint;
+export declare function cellToPointLiteral(cell: H3Cell): PointLiteral;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../h3/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAE,QAAQ,EAAE,KAAK,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAEpE;;;;;;GAMG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;AAE7C,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAEvD;AAED;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;AAEvD;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAYvD;AAKD;;GAEG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE,UAAU,SAAK,GAAG,MAAM,CAa9E;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,SAAK,GAAG,QAAQ,CAOlF;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAO7D"}

package/out/h3/index.js

@@ -0,0 +1,57 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { cellToLatLng } from "h3-js";
+import { GeoPoint } from "../geometries/point.js";
+export function isH3Cell(value) {
+    return /^[0-9a-f]{15}$/.test(value);
+}
+/**
+ * Given a full H3 cell index, shorten it to 48 bits.
+ */
+export function shortenH3Cell(cell) {
+    // ...and convert it to a 48-bit cell address.
+    const cellBigInt = BigInt(`0x${cell}`);
+    // 8 f 2 aa 84 5a 18 ac 6b
+    //     aa 84 5a 18 ac 6b
+    // Extract the cell address without the resolution
+    const h3CellShortBigInt = cellBigInt & 0xfffffffffffffn;
+    const h3CellShortHex = h3CellShortBigInt.toString(16);
+    return h3CellShortHex;
+}
+//2 aa 84 5a 18 ac 6b
+// 8 f2 aa 84 5a 18 ac 6b
+/**
+ * Given a short cell address, expand it to a full H3 cell index.
+ */
+export function expandH3Cell(h3CellShort, resolution = 15) {
+    // Convert the short cell address back to BigInt
+    const h3CellShortBigInt = BigInt(`0x${h3CellShort}`);
+    const resolutionHex = resolution.toString(16);
+    // Reassemble the H3 cell index portion...
+    const cellBigInt = h3CellShortBigInt << BigInt(8 * (15 - resolution));
+    // Back to a string...
+    const partialCell = cellBigInt.toString(16);
+    // Finally, we add the resolution back to the cell index.
+    const cell = `8${resolutionHex}${partialCell}`;
+    return cell;
+}
+/**
+ * Given a geographic point, return a short cell address.
+ */
+export function shortCellToPoint(shortCell, resolution = 15) {
+    const cell = expandH3Cell(shortCell, resolution);
+    // Convert the H3 cell index back to latitude and longitude
+    const [latitude, longitude] = cellToLatLng(cell);
+    return new GeoPoint([longitude, latitude]);
+}
+export function cellToPointLiteral(cell) {
+    const [latitude, longitude] = cellToLatLng(cell);
+    return {
+        type: "Point",
+        coordinates: [longitude, latitude],
+    };
+}
+//# sourceMappingURL=index.js.map

package/out/h3/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../h3/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AAEpC,OAAO,EAAE,QAAQ,EAAqB,MAAM,wBAAwB,CAAA;AAWpE,MAAM,UAAU,QAAQ,CAAC,KAAa;IACrC,OAAO,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACpC,CAAC;AAWD;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY;IACzC,8CAA8C;IAC9C,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,CAAA;IACtC,0BAA0B;IAC1B,wBAAwB;IAExB,kDAAkD;IAClD,MAAM,iBAAiB,GAAG,UAAU,GAAG,gBAAgB,CAAA;IAEvD,MAAM,cAAc,GAAG,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IAErD,OAAO,cAA6B,CAAA;AACrC,CAAC;AAED,qBAAqB;AAErB,yBAAyB;AACzB;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,WAAwB,EAAE,UAAU,GAAG,EAAE;IACrE,gDAAgD;IAChD,MAAM,iBAAiB,GAAG,MAAM,CAAC,KAAK,WAAW,EAAE,CAAC,CAAA;IAEpD,MAAM,aAAa,GAAG,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IAC7C,0CAA0C;IAC1C,MAAM,UAAU,GAAG,iBAAiB,IAAI,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,UAAU,CAAC,CAAC,CAAA;IACrE,sBAAsB;IACtB,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IAC3C,yDAAyD;IACzD,MAAM,IAAI,GAAG,IAAI,aAAa,GAAG,WAAW,EAAE,CAAA;IAE9C,OAAO,IAAc,CAAA;AACtB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,SAAsB,EAAE,UAAU,GAAG,EAAE;IACvE,MAAM,IAAI,GAAG,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;IAEhD,2DAA2D;IAC3D,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IAEhD,OAAO,IAAI,QAAQ,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAA;AAC3C,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC9C,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IAEhD,OAAO;QACN,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;KAClC,CAAA;AACF,CAAC"}

package/out/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+export * from "./bbox.js";
+export * from "./countries/index.js";
+export * from "./feature.js";
+export * from "./geometries/index.js";
+export * from "./google/index.js";
+export * from "./h3/index.js";
+export * from "./objects.js";
+export * from "./position.js";
+export * from "./projection.js";
+export * from "./regions/index.js";
+//# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,WAAW,CAAA;AACzB,cAAc,sBAAsB,CAAA;AACpC,cAAc,cAAc,CAAA;AAC5B,cAAc,uBAAuB,CAAA;AACrC,cAAc,mBAAmB,CAAA;AACjC,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA"}

package/out/index.js

@@ -0,0 +1,16 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+export * from "./bbox.js";
+export * from "./countries/index.js";
+export * from "./feature.js";
+export * from "./geometries/index.js";
+export * from "./google/index.js";
+export * from "./h3/index.js";
+export * from "./objects.js";
+export * from "./position.js";
+export * from "./projection.js";
+export * from "./regions/index.js";
+//# sourceMappingURL=index.js.map

package/out/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,WAAW,CAAA;AACzB,cAAc,sBAAsB,CAAA;AACpC,cAAc,cAAc,CAAA;AAC5B,cAAc,uBAAuB,CAAA;AACrC,cAAc,mBAAmB,CAAA;AACjC,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA"}

package/out/objects.d.ts

@@ -0,0 +1,93 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { type BBox2DLiteral, type BBox3DLiteral } from "./bbox.js";
+/**
+ * GeoJSON object types.
+ */
+export type GeometryType = "Point" | "MultiPoint" | "LineString" | "MultiLineString" | "Polygon" | "MultiPolygon" | "GeometryCollection" | "FeatureCollection";
+/**
+ * Shadow enum-like record of valid GeoJSON object types.
+ */
+export declare const GeometryType: {
+    readonly Point: "Point";
+    readonly MultiPoint: "MultiPoint";
+    readonly LineString: "LineString";
+    readonly MultiLineString: "MultiLineString";
+    readonly Polygon: "Polygon";
+    readonly MultiPolygon: "MultiPolygon";
+    readonly GeometryCollection: "GeometryCollection";
+    readonly FeatureCollection: "FeatureCollection";
+};
+/**
+ * The base GeoJSON object.
+ *
+ * The GeoJSON specification also allows foreign members
+ * (https://tools.ietf.org/html/rfc7946#section-6.1) to be included in the object.
+ *
+ * @see {@link https://tools.ietf.org/html/rfc7946#section-3 GeoJSON Object}
+ * @title Geo Object
+ * @public
+ */
+export interface GeoObjectLiteral {
+    /**
+     * Specifies the type of GeoJSON object.
+     */
+    type: GeometryType;
+    /**
+     * A unique identifier for the feature, such as a UUID, a serial number, or a name.
+     */
+    id?: string | number | undefined | null;
+    /**
+     * A bounding box of the coordinate range of the object's Geometries, Features, or Feature
+     * Collections.
+     *
+     * This is useful when defining the extent of a GeoJSON object, i.e. the minimum and maximum
+     * coordinates of the object's Geometries, Features, or Feature Collections.
+     *
+     * @see {@link https://tools.ietf.org/html/rfc7946#section-5 GeoJSON Bounding Boxes}
+     */
+    bbox?: BBox2DLiteral | BBox3DLiteral;
+    /**
+     * Coordinate reference system for GeoJSON objects.
+     *
+     * @see {@link https://tools.ietf.org/html/rfc7946#section-4 Coordinate Reference Systems}
+     * @title Coordinate Reference System
+     */
+    crs?: {
+        type: "name";
+        properties: {
+            /**
+             * The name of the coordinate reference system.
+             *
+             * @default "EPSG:4326"
+             */
+            name: string;
+        };
+    };
+}
+/**
+ * Abstract base-class for all GeoJSON class constructors.
+ */
+export declare abstract class GeoObject implements GeoObjectLiteral {
+    /**
+     * The JSON literal type of the GeoJSON object.
+     */
+    abstract type: GeometryType;
+    /**
+     * A bounding box of the coordinate range of the object's Geometries, Features, or Feature.
+     *
+     * @see {@linkcode BBox2DLiteral} for 2-dimensional bounding boxes.
+     * @see {@linkcode BBox3DLiteral} for 3-dimensional bounding boxes.
+     * @see
+     */
+    bbox?: BBox2DLiteral | BBox3DLiteral;
+    protected constructor(bbox?: BBox2DLiteral | BBox3DLiteral);
+    /**
+     * Predicate to determine if the GeoJSON object is 2-dimensional.
+     */
+    is2D(): boolean;
+}
+//# sourceMappingURL=objects.d.ts.map

package/out/objects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.d.ts","sourceRoot":"","sources":["../objects.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,aAAa,EAAY,MAAM,WAAW,CAAA;AAE5E;;GAEG;AACH,MAAM,MAAM,YAAY,GACrB,OAAO,GACP,YAAY,GACZ,YAAY,GACZ,iBAAiB,GACjB,SAAS,GACT,cAAc,GACd,oBAAoB,GACpB,mBAAmB,CAAA;AAEtB;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;;;CASsB,CAAA;AAE/C;;;;;;;;;GASG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,IAAI,EAAE,YAAY,CAAA;IAElB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAA;IAEvC;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,aAAa,GAAG,aAAa,CAAA;IAEpC;;;;;OAKG;IACH,GAAG,CAAC,EAAE;QACL,IAAI,EAAE,MAAM,CAAA;QAEZ,UAAU,EAAE;YACX;;;;eAIG;YACH,IAAI,EAAE,MAAM,CAAA;SACZ,CAAA;KACD,CAAA;CACD;AAED;;GAEG;AACH,8BAAsB,SAAU,YAAW,gBAAgB;IAC1D;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAA;IAE3B;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,aAAa,GAAG,aAAa,CAAA;IAEpC,SAAS,aAAa,IAAI,CAAC,EAAE,aAAa,GAAG,aAAa;IAI1D;;OAEG;IACI,IAAI;CAGX"}

package/out/objects.js

@@ -0,0 +1,42 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { is2DBBox } from "./bbox.js";
+/**
+ * Shadow enum-like record of valid GeoJSON object types.
+ */
+export const GeometryType = {
+    Point: "Point",
+    MultiPoint: "MultiPoint",
+    LineString: "LineString",
+    MultiLineString: "MultiLineString",
+    Polygon: "Polygon",
+    MultiPolygon: "MultiPolygon",
+    GeometryCollection: "GeometryCollection",
+    FeatureCollection: "FeatureCollection",
+};
+/**
+ * Abstract base-class for all GeoJSON class constructors.
+ */
+export class GeoObject {
+    /**
+     * A bounding box of the coordinate range of the object's Geometries, Features, or Feature.
+     *
+     * @see {@linkcode BBox2DLiteral} for 2-dimensional bounding boxes.
+     * @see {@linkcode BBox3DLiteral} for 3-dimensional bounding boxes.
+     * @see
+     */
+    bbox;
+    constructor(bbox) {
+        this.bbox = bbox;
+    }
+    /**
+     * Predicate to determine if the GeoJSON object is 2-dimensional.
+     */
+    is2D() {
+        return is2DBBox(this.bbox);
+    }
+}
+//# sourceMappingURL=objects.js.map

package/out/objects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.js","sourceRoot":"","sources":["../objects.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAA0C,QAAQ,EAAE,MAAM,WAAW,CAAA;AAe5E;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B,KAAK,EAAE,OAAO;IACd,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE,YAAY;IACxB,eAAe,EAAE,iBAAiB;IAClC,OAAO,EAAE,SAAS;IAClB,YAAY,EAAE,cAAc;IAC5B,kBAAkB,EAAE,oBAAoB;IACxC,iBAAiB,EAAE,mBAAmB;CACQ,CAAA;AAsD/C;;GAEG;AACH,MAAM,OAAgB,SAAS;IAM9B;;;;;;OAMG;IACH,IAAI,CAAgC;IAEpC,YAAsB,IAAoC;QACzD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IACjB,CAAC;IAED;;OAEG;IACI,IAAI;QACV,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;CACD"}

package/out/position.d.ts

@@ -0,0 +1,176 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   This file contains types and utilities for working with geographic positions.
+ */
+import { type LatLngLiteral } from "@googlemaps/google-maps-services-js";
+import { type GeoPointInput } from "@mailwoman/spatial";
+/**
+ * An ordered pair of coordinates in the form of [longitude, latitude].
+ *
+ * Note that unlike the typical order, GeoJSON coordinates are in the order of [longitude, latitude]
+ * to match the order of [x, y] in Cartesian coordinates.
+ *
+ * @category Position
+ * @category GeoJSON
+ * @see {@linkcode Coordinates3D} for 3D coordinates.
+ */
+export type Coordinates2D = [
+    /**
+     * The longitude of the point, i.e. the x-coordinate.
+     *
+     * @minimum -180
+     * @maximum 180
+     */
+    longitude: number,
+    /**
+     * The latitude of the point, i.e. the y-coordinate.
+     *
+     * @minimum -90
+     * @maximum 90
+     */
+    latitude: number
+];
+/**
+ * Orders the given coordinates as [longitude, latitude].
+ *
+ * This is useful when converting into GeoJSON format.
+ *
+ * @category GeoJSON
+ * @category Position
+ */
+export declare function orderCoordPairToGeoJSON([latitude, longitude]: [number, number]): Coordinates2D;
+/**
+ * Orders the given coordinates as [latitude, longitude].
+ *
+ * This is useful when converting into Google Maps format.
+ *
+ * @category GeoJSON
+ * @category Position
+ */
+export declare function orderGeoJSONToCoordPair([longitude, latitude]: Coordinates2D): [number, number];
+/**
+ * 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 declare function inferGeoJSONCoordOrder([coordA, coordB]: [number, number]): Coordinates2D;
+/**
+ * An ordered triple of coordinates in the form of [longitude, latitude, altitude].
+ *
+ * @category Position
+ * @category GeoJSON
+ * @see {@linkcode Coordinates2D} for 2D coordinates.
+ */
+export type Coordinates3D = [
+    /**
+     * The longitude of the point, i.e. the x-coordinate.
+     *
+     * @minimum -180
+     * @maximum 180
+     */
+    longitude: number,
+    /**
+     * The latitude of the point, i.e. the y-coordinate.
+     *
+     * @minimum -90
+     * @maximum 90
+     */
+    latitude: number,
+    /**
+     * The altitude of the point, i.e. the z-coordinate.
+     */
+    altitude: number
+];
+/**
+ * A record of internal coordinates, typically used by the US Census.
+ */
+export type InternalPointCoordinates = {
+    /**
+     * Internal Longitude (X) Coordinates
+     *
+     * @minimum -180
+     * @maximum 180
+     */
+    x: number;
+    /**
+     * Internal Latitude (Y) Coordinates
+     *
+     * @minimum -90
+     * @maximum 90
+     */
+    y: number;
+};
+/**
+ * Type-predicate to determine if the given input is a GeoJSON Point geometry.
+ *
+ * @category Type Predicates
+ * @category GeoJSON
+ */
+export declare function isCoordPairLiteral(input: unknown): input is [number, number] | [number, number, 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 declare function isGoogleMapsLatLngLiteral(input: unknown): input is LatLngLiteral;
+/**
+ * Type-predicate to determine if the given input is a {@linkcode InternalPointCoordinates} object.
+ *
+ * @category Position
+ * @category Type Predicates
+ */
+export declare function isInterpolatedCoordinates(input: unknown): input is InternalPointCoordinates;
+/**
+ * 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 declare function wrapLongitude(longitude: number): number;
+/**
+ * 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 declare function clampLatitude(value: number): number;
+/**
+ * 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 declare const ConversionFactor: {
+    readonly DegreesToRadians: 0.01745329251;
+    readonly RadiansToDegrees: 57.2957795131;
+};
+/**
+ * Available conversion units for the radius of the Earth.
+ */
+export type EarthRadiusUnit = "km" | "miles" | "meters";
+/**
+ * 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 declare function haversine(point1: GeoPointInput, point2: GeoPointInput, unit?: EarthRadiusUnit): number;
+//# sourceMappingURL=position.d.ts.map

package/out/position.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"position.d.ts","sourceRoot":"","sources":["../position.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,qCAAqC,CAAA;AACxE,OAAO,EAAY,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAEjE;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,GAAG;IAC3B;;;;;OAKG;IACH,SAAS,EAAE,MAAM;IACjB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM;CAChB,CAAA;AAED;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,aAAa,CAE9F;AAED;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAE9F;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,aAAa,CAkBxF;AAED;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG;IAC3B;;;;;OAKG;IACH,SAAS,EAAE,MAAM;IACjB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACtC;;;;;OAKG;IACH,CAAC,EAAE,MAAM,CAAA;IACT;;;;;OAKG;IACH,CAAC,EAAE,MAAM,CAAA;CACT,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAMvG;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAMhF;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,wBAAwB,CAO3F;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEnD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;+BACoB,aAAa;+BACb,aAAa;CACpD,CAAA;AAEV;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,IAAI,GAAG,OAAO,GAAG,QAAQ,CAAA;AAWvD;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,GAAE,eAAsB,GAAG,MAAM,CAyB5G"}