@map-colonies/mc-utils 3.1.0 → 3.3.0

package/dist/geo/geoHash.js

@@ -1,135 +1,135 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tileGenerator = exports.createGeoHashGenerator = exports.decodeGeoHash = void 0;
-const turf_1 = require("@turf/turf");
-const ngeohash = __importStar(require("ngeohash"));
-const tileOrigin_1 = require("../models/enums/geo/tileOrigin");
-const geoConvertor_1 = require("./geoConvertor");
-const bboxUtils_1 = require("./bboxUtils");
-const MAX_STANDARD_ZOOM = 21;
-const bboxIntersection = (bbox1, bbox2) => {
-    const minLon = Math.max(bbox1[0], bbox2[0]);
-    const minLat = Math.max(bbox1[1], bbox2[1]);
-    const maxLon = Math.min(bbox1[2], bbox2[2]);
-    const maxLat = Math.min(bbox1[3], bbox2[3]);
-    return [minLon, minLat, maxLon, maxLat];
-};
-const isSubHash = (hash, parent) => {
-    return hash.startsWith(parent);
-};
-function* geoHash(precision, maxPrecision, polygon, bbox, parentHash = '') {
-    // ngeohash bbox is a lat-lon array. we change turf bbox to it so it can be used.
-    const hashes = ngeohash.bboxes(bbox[1], bbox[0], bbox[3], bbox[2], precision);
-    if (hashes.length > 0) {
-        for (const hash of hashes) {
-            const hashBbox = (0, exports.decodeGeoHash)(hash);
-            const hashPoly = (0, turf_1.bboxPolygon)(hashBbox);
-            const intersection = (0, turf_1.intersect)(polygon, hashPoly);
-            if (intersection === null || !isSubHash(hash, parentHash)) {
-                continue;
-            }
-            const intArea = (0, turf_1.area)(intersection);
-            const hashArea = (0, turf_1.area)(hashPoly);
-            if (intArea == hashArea || precision == maxPrecision) {
-                yield hash;
-            }
-            else {
-                const subBbox = bboxIntersection(hashBbox, bbox);
-                yield* geoHash(precision + 1, maxPrecision, polygon, subBbox, hash);
-            }
-        }
-    }
-}
-/**
- * converts geohash string to its bbox in wgs84 degrees
- * @param geohash geohash string
- * @returns bbox of the supplied geohash
- */
-const decodeGeoHash = (geohash) => {
-    const bboxFromGeohash = ngeohash.decode_bbox(geohash);
-    // ngeohash.decode_bbox gives a lat-lon array. we change it to lon-lat so @turf can use it.
-    const lonLatBbox = [bboxFromGeohash[1], bboxFromGeohash[0], bboxFromGeohash[3], bboxFromGeohash[2]];
-    return lonLatBbox;
-};
-exports.decodeGeoHash = decodeGeoHash;
-/**
- * generates optimized geohash iterator for given polygon and target zoom level
- * @param polygon polygon to cover with geohashes
- * @param maxTileZoom target zoom level
- * @returns generator that yields the matching geohashes
- */
-const createGeoHashGenerator = (polygon, maxTileZoom = MAX_STANDARD_ZOOM) => {
-    let bbox = (0, turf_1.bbox)(polygon);
-    bbox = (0, bboxUtils_1.snapBBoxToTileGrid)(bbox, maxTileZoom);
-    //at this precision ea geo hash is a tile or smaller
-    /* eslint-disable @typescript-eslint/no-magic-numbers */
-    let zoomPrecision = Math.floor((2 / 5) * (maxTileZoom + 1));
-    const precisionMod = maxTileZoom % 5;
-    if (precisionMod > 0 && precisionMod <= 3) {
-        zoomPrecision++;
-    }
-    else if (precisionMod > 3) {
-        zoomPrecision += 2;
-    }
-    /* eslint-enable @typescript-eslint/no-magic-numbers */
-    return geoHash(1, zoomPrecision, polygon, bbox);
-};
-exports.createGeoHashGenerator = createGeoHashGenerator;
-/**
- * generate all tiles in supplied polygon
- * @param polygon polygon to cover with tiles
- * @param tileZoom target tiles zoom level
- * @param origin target tiles grid origin location (default ll)
- */
-async function* tileGenerator(polygon, tileZoom, origin = tileOrigin_1.TileOrigin.LOWER_LEFT) {
-    const hashGen = (0, exports.createGeoHashGenerator)(polygon, tileZoom);
-    for await (const hash of hashGen) {
-        const bbox = (0, exports.decodeGeoHash)(hash);
-        const minTile = (0, geoConvertor_1.degreesToTile)({
-            longitude: bbox[0],
-            latitude: bbox[1],
-        }, tileZoom, origin);
-        const maxTile = (0, geoConvertor_1.degreesToTile)({
-            longitude: bbox[2],
-            latitude: bbox[3],
-        }, tileZoom, origin);
-        const minX = Math.min(minTile.x, maxTile.x);
-        const maxX = minTile.x + maxTile.x - minX;
-        const minY = Math.min(minTile.y, maxTile.y);
-        const maxY = minTile.y + maxTile.y - minY;
-        for (let x = minX; x < maxX; x++) {
-            for (let y = minY; y < maxY; y++) {
-                yield await Promise.resolve({
-                    x,
-                    y,
-                    zoom: tileZoom,
-                });
-            }
-        }
-    }
-}
-exports.tileGenerator = tileGenerator;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tileGenerator = exports.createGeoHashGenerator = exports.decodeGeoHash = void 0;
+const turf_1 = require("@turf/turf");
+const ngeohash = __importStar(require("ngeohash"));
+const tileOrigin_1 = require("../models/enums/geo/tileOrigin");
+const geoConvertor_1 = require("./geoConvertor");
+const bboxUtils_1 = require("./bboxUtils");
+const MAX_STANDARD_ZOOM = 21;
+const bboxIntersection = (bbox1, bbox2) => {
+    const minLon = Math.max(bbox1[0], bbox2[0]);
+    const minLat = Math.max(bbox1[1], bbox2[1]);
+    const maxLon = Math.min(bbox1[2], bbox2[2]);
+    const maxLat = Math.min(bbox1[3], bbox2[3]);
+    return [minLon, minLat, maxLon, maxLat];
+};
+const isSubHash = (hash, parent) => {
+    return hash.startsWith(parent);
+};
+function* geoHash(precision, maxPrecision, polygon, bbox, parentHash = '') {
+    // ngeohash bbox is a lat-lon array. we change turf bbox to it so it can be used.
+    const hashes = ngeohash.bboxes(bbox[1], bbox[0], bbox[3], bbox[2], precision);
+    if (hashes.length > 0) {
+        for (const hash of hashes) {
+            const hashBbox = (0, exports.decodeGeoHash)(hash);
+            const hashPoly = (0, turf_1.bboxPolygon)(hashBbox);
+            const intersection = (0, turf_1.intersect)(polygon, hashPoly);
+            if (intersection === null || !isSubHash(hash, parentHash)) {
+                continue;
+            }
+            const intArea = (0, turf_1.area)(intersection);
+            const hashArea = (0, turf_1.area)(hashPoly);
+            if (intArea == hashArea || precision == maxPrecision) {
+                yield hash;
+            }
+            else {
+                const subBbox = bboxIntersection(hashBbox, bbox);
+                yield* geoHash(precision + 1, maxPrecision, polygon, subBbox, hash);
+            }
+        }
+    }
+}
+/**
+ * converts geohash string to its bbox in wgs84 degrees
+ * @param geohash geohash string
+ * @returns bbox of the supplied geohash
+ */
+const decodeGeoHash = (geohash) => {
+    const bboxFromGeohash = ngeohash.decode_bbox(geohash);
+    // ngeohash.decode_bbox gives a lat-lon array. we change it to lon-lat so @turf can use it.
+    const lonLatBbox = [bboxFromGeohash[1], bboxFromGeohash[0], bboxFromGeohash[3], bboxFromGeohash[2]];
+    return lonLatBbox;
+};
+exports.decodeGeoHash = decodeGeoHash;
+/**
+ * generates optimized geohash iterator for given polygon and target zoom level
+ * @param polygon polygon to cover with geohashes
+ * @param maxTileZoom target zoom level
+ * @returns generator that yields the matching geohashes
+ */
+const createGeoHashGenerator = (polygon, maxTileZoom = MAX_STANDARD_ZOOM) => {
+    let bbox = (0, turf_1.bbox)(polygon);
+    bbox = (0, bboxUtils_1.snapBBoxToTileGrid)(bbox, maxTileZoom);
+    //at this precision ea geo hash is a tile or smaller
+    /* eslint-disable @typescript-eslint/no-magic-numbers */
+    let zoomPrecision = Math.floor((2 / 5) * (maxTileZoom + 1));
+    const precisionMod = maxTileZoom % 5;
+    if (precisionMod > 0 && precisionMod <= 3) {
+        zoomPrecision++;
+    }
+    else if (precisionMod > 3) {
+        zoomPrecision += 2;
+    }
+    /* eslint-enable @typescript-eslint/no-magic-numbers */
+    return geoHash(1, zoomPrecision, polygon, bbox);
+};
+exports.createGeoHashGenerator = createGeoHashGenerator;
+/**
+ * generate all tiles in supplied polygon
+ * @param polygon polygon to cover with tiles
+ * @param tileZoom target tiles zoom level
+ * @param origin target tiles grid origin location (default ll)
+ */
+async function* tileGenerator(polygon, tileZoom, origin = tileOrigin_1.TileOrigin.LOWER_LEFT) {
+    const hashGen = (0, exports.createGeoHashGenerator)(polygon, tileZoom);
+    for await (const hash of hashGen) {
+        const bbox = (0, exports.decodeGeoHash)(hash);
+        const minTile = (0, geoConvertor_1.degreesToTile)({
+            longitude: bbox[0],
+            latitude: bbox[1],
+        }, tileZoom, origin);
+        const maxTile = (0, geoConvertor_1.degreesToTile)({
+            longitude: bbox[2],
+            latitude: bbox[3],
+        }, tileZoom, origin);
+        const minX = Math.min(minTile.x, maxTile.x);
+        const maxX = minTile.x + maxTile.x - minX;
+        const minY = Math.min(minTile.y, maxTile.y);
+        const maxY = minTile.y + maxTile.y - minY;
+        for (let x = minX; x < maxX; x++) {
+            for (let y = minY; y < maxY; y++) {
+                yield await Promise.resolve({
+                    x,
+                    y,
+                    zoom: tileZoom,
+                });
+            }
+        }
+    }
+}
+exports.tileGenerator = tileGenerator;
 //# sourceMappingURL=geoHash.js.map

package/dist/geo/geoIntersection.d.ts

@@ -1,20 +1,20 @@
-import { Feature, FeatureCollection, MultiPolygon, Polygon } from '@turf/turf';
-/**
- * tuft intersect supported footprint types
- */
-declare type Footprint = Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>;
-/**
- * return the intersection footprint of all specified footprints or null when there is no intersection
- * @param footprints footprint list to intersect
- * @returns intersection footprint or null
- */
-declare const multiIntersect: (footprints: Footprint[]) => Footprint | null;
-/**
- * indicates if 2 object of type FeatureCollection are equal by validating properties and features array (order not important)
- * @param fc1 first featureCollection to compare equal
- * @param fc2 second featureCollection to compare equal
- * @returns true if same featureCollection, false if not
- */
-declare const featureCollectionBooleanEqual: (fc1: FeatureCollection, fc2: FeatureCollection) => boolean;
-export { multiIntersect, featureCollectionBooleanEqual, Footprint };
+import { Feature, FeatureCollection, MultiPolygon, Polygon } from '@turf/turf';
+/**
+ * tuft intersect supported footprint types
+ */
+declare type Footprint = Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>;
+/**
+ * return the intersection footprint of all specified footprints or null when there is no intersection
+ * @param footprints footprint list to intersect
+ * @returns intersection footprint or null
+ */
+declare const multiIntersect: (footprints: Footprint[]) => Footprint | null;
+/**
+ * indicates if 2 object of type FeatureCollection are equal by validating properties and features array (order not important)
+ * @param fc1 first featureCollection to compare equal
+ * @param fc2 second featureCollection to compare equal
+ * @returns true if same featureCollection, false if not
+ */
+declare const featureCollectionBooleanEqual: (fc1: FeatureCollection, fc2: FeatureCollection) => boolean;
+export { multiIntersect, featureCollectionBooleanEqual, Footprint };
 //# sourceMappingURL=geoIntersection.d.ts.map

package/dist/geo/geoIntersection.js

@@ -1,71 +1,71 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.featureCollectionBooleanEqual = exports.multiIntersect = void 0;
-const turf_1 = require("@turf/turf");
-const lodash_1 = __importDefault(require("lodash"));
-const featuresCustomizer = (objectValue, otherValue) => {
-    // compare features
-    // https://lodash.com/docs/4.17.15#find
-    if (!lodash_1.default.isEqual(objectValue.length, otherValue.length)) {
-        return false;
-    }
-    for (let i = 0; i < objectValue.length; i++) {
-        const isFeatureContained = lodash_1.default.find(otherValue, objectValue[i]);
-        if (isFeatureContained === undefined) {
-            return false;
-        }
-    }
-    for (let i = 0; i < otherValue.length; i++) {
-        const isFeatureContained = lodash_1.default.find(objectValue, otherValue[i]);
-        if (isFeatureContained === undefined) {
-            return false;
-        }
-    }
-    return true;
-};
-const featureCollectionCustomized = (objectValue, otherValue) => {
-    // compare type
-    if (!lodash_1.default.isEqual(objectValue.type, otherValue.type)) {
-        return false;
-    }
-    // compare features
-    const isFeaturesEqual = lodash_1.default.isEqualWith(objectValue.features, otherValue.features, featuresCustomizer);
-    return isFeaturesEqual;
-};
-/**
- * return the intersection footprint of all specified footprints or null when there is no intersection
- * @param footprints footprint list to intersect
- * @returns intersection footprint or null
- */
-const multiIntersect = (footprints) => {
-    if (footprints.length === 0) {
-        return null;
-    }
-    else if (footprints.length === 1) {
-        return footprints[0];
-    }
-    let intersection = footprints[0];
-    for (let i = 1; i < footprints.length; i++) {
-        const curIntersection = (0, turf_1.intersect)(intersection, footprints[i]);
-        if (curIntersection === null) {
-            return null;
-        }
-        intersection = curIntersection;
-    }
-    return intersection;
-};
-exports.multiIntersect = multiIntersect;
-/**
- * indicates if 2 object of type FeatureCollection are equal by validating properties and features array (order not important)
- * @param fc1 first featureCollection to compare equal
- * @param fc2 second featureCollection to compare equal
- * @returns true if same featureCollection, false if not
- */
-const featureCollectionBooleanEqual = (fc1, fc2) => {
-    return lodash_1.default.isEqualWith(fc1, fc2, featureCollectionCustomized);
-};
-exports.featureCollectionBooleanEqual = featureCollectionBooleanEqual;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.featureCollectionBooleanEqual = exports.multiIntersect = void 0;
+const turf_1 = require("@turf/turf");
+const lodash_1 = __importDefault(require("lodash"));
+const featuresCustomizer = (objectValue, otherValue) => {
+    // compare features
+    // https://lodash.com/docs/4.17.15#find
+    if (!lodash_1.default.isEqual(objectValue.length, otherValue.length)) {
+        return false;
+    }
+    for (let i = 0; i < objectValue.length; i++) {
+        const isFeatureContained = lodash_1.default.find(otherValue, objectValue[i]);
+        if (isFeatureContained === undefined) {
+            return false;
+        }
+    }
+    for (let i = 0; i < otherValue.length; i++) {
+        const isFeatureContained = lodash_1.default.find(objectValue, otherValue[i]);
+        if (isFeatureContained === undefined) {
+            return false;
+        }
+    }
+    return true;
+};
+const featureCollectionCustomized = (objectValue, otherValue) => {
+    // compare type
+    if (!lodash_1.default.isEqual(objectValue.type, otherValue.type)) {
+        return false;
+    }
+    // compare features
+    const isFeaturesEqual = lodash_1.default.isEqualWith(objectValue.features, otherValue.features, featuresCustomizer);
+    return isFeaturesEqual;
+};
+/**
+ * return the intersection footprint of all specified footprints or null when there is no intersection
+ * @param footprints footprint list to intersect
+ * @returns intersection footprint or null
+ */
+const multiIntersect = (footprints) => {
+    if (footprints.length === 0) {
+        return null;
+    }
+    else if (footprints.length === 1) {
+        return footprints[0];
+    }
+    let intersection = footprints[0];
+    for (let i = 1; i < footprints.length; i++) {
+        const curIntersection = (0, turf_1.intersect)(intersection, footprints[i]);
+        if (curIntersection === null) {
+            return null;
+        }
+        intersection = curIntersection;
+    }
+    return intersection;
+};
+exports.multiIntersect = multiIntersect;
+/**
+ * indicates if 2 object of type FeatureCollection are equal by validating properties and features array (order not important)
+ * @param fc1 first featureCollection to compare equal
+ * @param fc2 second featureCollection to compare equal
+ * @returns true if same featureCollection, false if not
+ */
+const featureCollectionBooleanEqual = (fc1, fc2) => {
+    return lodash_1.default.isEqualWith(fc1, fc2, featureCollectionCustomized);
+};
+exports.featureCollectionBooleanEqual = featureCollectionBooleanEqual;
 //# sourceMappingURL=geoIntersection.js.map

package/dist/geo/index.d.ts

@@ -1,9 +1,9 @@
-export * from './bboxUtils';
-export * from './geoConvertor';
-export * from './geoHash';
-export * from './geoIntersection';
-export * from './tileBatcher';
-export * from './tileRanger';
-export * from './tiles';
-export * from './tilesGenerator';
+export * from './bboxUtils';
+export * from './geoConvertor';
+export * from './geoHash';
+export * from './geoIntersection';
+export * from './tileBatcher';
+export * from './tileRanger';
+export * from './tiles';
+export * from './tilesGenerator';
 //# sourceMappingURL=index.d.ts.map

package/dist/geo/index.js

@@ -1,25 +1,25 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./bboxUtils"), exports);
-__exportStar(require("./geoConvertor"), exports);
-__exportStar(require("./geoHash"), exports);
-__exportStar(require("./geoIntersection"), exports);
-__exportStar(require("./tileBatcher"), exports);
-__exportStar(require("./tileRanger"), exports);
-__exportStar(require("./tiles"), exports);
-__exportStar(require("./tilesGenerator"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./bboxUtils"), exports);
+__exportStar(require("./geoConvertor"), exports);
+__exportStar(require("./geoHash"), exports);
+__exportStar(require("./geoIntersection"), exports);
+__exportStar(require("./tileBatcher"), exports);
+__exportStar(require("./tileRanger"), exports);
+__exportStar(require("./tiles"), exports);
+__exportStar(require("./tilesGenerator"), exports);
 //# sourceMappingURL=index.js.map

package/dist/geo/tileBatcher.d.ts

@@ -1,9 +1,9 @@
-import { ITileRange } from '../models/interfaces/geo/iTile';
-/**
- * split collection of tile ranges to batches based on tile count
- * @param batchSize amount of tile per batch
- * @param ranges iterable collection of tile ranges
- */
-declare function tileBatchGenerator(batchSize: number, ranges: AsyncGenerator<ITileRange>): AsyncGenerator<ITileRange[]>;
-export { tileBatchGenerator };
+import { ITileRange } from '../models/interfaces/geo/iTile';
+/**
+ * split collection of tile ranges to batches based on tile count
+ * @param batchSize amount of tile per batch
+ * @param ranges iterable collection of tile ranges
+ */
+declare function tileBatchGenerator(batchSize: number, ranges: AsyncGenerator<ITileRange>): AsyncGenerator<ITileRange[]>;
+export { tileBatchGenerator };
 //# sourceMappingURL=tileBatcher.d.ts.map