@map-colonies/mc-utils 2.0.0 → 2.0.1

package/dist/geo/tiles.js

@@ -1,247 +1,247 @@
-"use strict";
-var __values = (this && this.__values) || function(o) {
-    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
-    if (m) return m.call(o);
-    if (o && typeof o.length === "number") return {
-        next: function () {
-            if (o && i >= o.length) o = void 0;
-            return { value: o && o[i++], done: !o };
-        }
-    };
-    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.featureCollectionToTilesCount = exports.featureToTilesCount = exports.tileRangeToTilesCount = exports.tileToBbox = exports.degreesPerPixelToZoomLevel = exports.zoomLevelToResolutionMeter = exports.zoomLevelToResolutionDeg = exports.flipYAxis = exports.degreesPerPixel = exports.degreesPerTile = void 0;
-var turf_1 = require("@turf/turf");
-var bboxUtils_1 = require("./bboxUtils");
-var geoConvertor_1 = require("./geoConvertor");
-var zoomToResolutionDegMapper = {
-    /* eslint-disable @typescript-eslint/naming-convention */
-    0: 0.703125,
-    1: 0.3515625,
-    2: 0.17578125,
-    3: 0.087890625,
-    4: 0.0439453125,
-    5: 0.02197265625,
-    6: 0.010986328125,
-    7: 0.0054931640625,
-    8: 0.00274658203125,
-    9: 0.001373291015625,
-    10: 0.0006866455078125,
-    11: 0.00034332275390625,
-    12: 0.000171661376953125,
-    13: 0.0000858306884765625,
-    14: 0.0000429153442382812,
-    15: 0.0000214576721191406,
-    16: 0.0000107288360595703,
-    17: 0.00000536441802978516,
-    18: 0.00000268220901489258,
-    19: 0.00000134110450744629,
-    20: 0.000000670552253723145,
-    21: 0.000000335276126861572,
-    22: 0.000000167638063430786,
-    /* eslint-enable @typescript-eslint/naming-convention */
-};
-var zoomToResolutionMeterMapper = {
-    /* eslint-disable @typescript-eslint/naming-convention */
-    0: 78271.52,
-    1: 39135.76,
-    2: 19567.88,
-    3: 9783.94,
-    4: 4891.97,
-    5: 2445.98,
-    6: 1222.99,
-    7: 611.5,
-    8: 305.75,
-    9: 152.87,
-    10: 76.44,
-    11: 38.22,
-    12: 19.11,
-    13: 9.55,
-    14: 4.78,
-    15: 2.39,
-    16: 1.19,
-    17: 0.6,
-    18: 0.3,
-    19: 0.15,
-    20: 0.075,
-    21: 0.037,
-    22: 0.0185,
-    /* eslint-enable @typescript-eslint/naming-convention */
-};
-/**
- * calculates tile size (resolution) in degrees
- * @param zoomLevel zoom level of returned tile size
- * @returns tile size (resolution) in degrees
- */
-function degreesPerTile(zoomLevel) {
-    var latRange = 180;
-    return latRange / (1 << zoomLevel);
-}
-exports.degreesPerTile = degreesPerTile;
-/**
- * returns pixel size (resolution) in degrees
- * @param zoomLevel tile zoom level of returned tile pixel size
- * @returns pixel size (resolution) in degrees
- */
-function degreesPerPixel(zoomLevel) {
-    var tileSize = 256;
-    var tileRes = degreesPerTile(zoomLevel);
-    return tileRes / tileSize;
-}
-exports.degreesPerPixel = degreesPerPixel;
-/**
- * coverts tile coordinates between ll and ul
- * @param tile source tile
- * @returns converted tile
- */
-function flipYAxis(tile) {
-    var yTiles = 1 << tile.zoom;
-    return {
-        x: tile.x,
-        y: yTiles - tile.y - 1,
-        zoom: tile.zoom,
-    };
-}
-exports.flipYAxis = flipYAxis;
-/**
- * converts zoom level (integer) to matching resolution degree value
- * @param zoom zoom level in range of 0-22
- * @returns resolution represented in degrees, or undefined if zoom level is out of range
- */
-function zoomLevelToResolutionDeg(zoom) {
-    return zoomToResolutionDegMapper[zoom];
-}
-exports.zoomLevelToResolutionDeg = zoomLevelToResolutionDeg;
-/**
- * converts zoom level (integer) to matching resolution meter value
- * @param zoom zoom level in range of 0-22
- * @returns resolution represented in Meters, or undefined if zoom level is out of range
- */
-function zoomLevelToResolutionMeter(zoom) {
-    return zoomToResolutionMeterMapper[zoom];
-}
-exports.zoomLevelToResolutionMeter = zoomLevelToResolutionMeter;
-/**
- * converts pixel size (resolution) in degrees to matching zoom level (rounded down)
- * @param resolution pixel size (resolution) in degrees
- * @returns zoom level for given pixel size
- */
-function degreesPerPixelToZoomLevel(resolution) {
-    var MIN_ZOOM_LEVEL = 0;
-    // eslint-disable-next-line @typescript-eslint/no-magic-numbers
-    var zoomLevel = Math.floor(Math.log2(180 / (resolution * 256)));
-    if (zoomLevel < MIN_ZOOM_LEVEL) {
-        throw new Error("Invalid zoom level ".concat(zoomLevel, " for resolution ").concat(resolution));
-    }
-    return zoomLevel;
-}
-exports.degreesPerPixelToZoomLevel = degreesPerPixelToZoomLevel;
-/**
- * returns bbox of given tile
- * @param tile
- * @returns
- */
-function tileToBbox(tile) {
-    var minPoint = (0, geoConvertor_1.tileToDegrees)(tile);
-    var tileSize = degreesPerTile(tile.zoom);
-    return [minPoint.longitude, minPoint.latitude, minPoint.longitude + tileSize, minPoint.latitude + tileSize];
-}
-exports.tileToBbox = tileToBbox;
-/**
- * returns the batch area
- * @param ITileRange
- * @returns
- */
-function tileRangeToTilesCount(batch) {
-    return (batch.maxX - batch.minX) * (batch.maxY - batch.minY);
-}
-exports.tileRangeToTilesCount = tileRangeToTilesCount;
-/**
- * returns tiles amount of given feature and zoom ranges - based on 2:1 tile scheme
- * use the bboxToTileRange method and provide sanitized bbox coverage of tiles
- * @param feature
- * If feature's properties include attributes of "maxResolutionDeg" and "minResolutionDeg" or just one of them -
- * It will be converted to maxZoom and minZoom instead of default params to calculate
- * minResolutionDeg >= 0.703125
- * maxResolutionDeg <= 0.000000167638063430786
- * @param layerFootprint - referenced layer geometry to snap on the bbox
- * @param defaultMaxZoom optional - default is 22 - if maxResolutionDeg property was provided, the param will be ignored
- * @param defaultMinZoom optional - default is 0 - if minResolutionDeg property was provided, the param will be ignored
- * @returns tile count included on provided feature and zooms ranges
- */
-function featureToTilesCount(feature, defaultMaxZoom, defaultMinZoom) {
-    var _a, _b;
-    if (defaultMaxZoom === void 0) { defaultMaxZoom = 22; }
-    if (defaultMinZoom === void 0) { defaultMinZoom = 0; }
-    var tilesTotalAmount = 0;
-    if (defaultMaxZoom > 22 || defaultMinZoom < 0) {
-        throw new RangeError("Un supported zoom levels values, min-max zoom should be [0-22] but actual [".concat(defaultMinZoom, ":").concat(defaultMaxZoom, "]"));
-    }
-    if (defaultMinZoom > defaultMaxZoom) {
-        throw new RangeError("Illegal - defaultMinZoom[".concat(defaultMinZoom, "] is larger than defaultMaxZoom[").concat(defaultMaxZoom, "]"));
-    }
-    try {
-        var targetMaxZoom = ((_a = feature.properties) === null || _a === void 0 ? void 0 : _a.maxResolutionDeg) !== undefined && typeof feature.properties.maxResolutionDeg === 'number'
-            ? degreesPerPixelToZoomLevel(feature.properties.maxResolutionDeg)
-            : defaultMaxZoom;
-        var targetMinZoom = ((_b = feature.properties) === null || _b === void 0 ? void 0 : _b.minResolutionDeg) !== undefined && typeof feature.properties.minResolutionDeg === 'number'
-            ? degreesPerPixelToZoomLevel(feature.properties.minResolutionDeg)
-            : defaultMinZoom;
-        var sanitized = (0, bboxUtils_1.snapBBoxToTileGrid)((0, turf_1.bbox)(feature.geometry), targetMaxZoom);
-        for (var i = targetMinZoom; i <= targetMaxZoom; i++) {
-            var zoomTilesBatch = (0, bboxUtils_1.bboxToTileRange)(sanitized, i);
-            tilesTotalAmount += tileRangeToTilesCount(zoomTilesBatch);
-        }
-        return tilesTotalAmount;
-    }
-    catch (error) {
-        var message = "Error occurred while trying to calculate tiles amount - encodeFootprint error: ".concat(JSON.stringify(error));
-        throw new Error(message);
-    }
-}
-exports.featureToTilesCount = featureToTilesCount;
-/**
- * returns tiles amount of given featureCollection [each feature may include maxResolutionDeg and minResolutionDeg
- * if no resolutions in property will calculate all features with optional argument]
- * based on 2:1 tile scheme
- * use the bboxToTileRange method and provide sanitized bbox coverage of tiles
- * @param fc - FeatureCollection
- * foreach feature in featuresCollection features array:
- * If feature's properties include attributes of "maxResolutionDeg" and "minResolutionDeg" or just one of them -
- * It will be converted to maxZoom and minZoom instead of default params to calculate
- * minResolutionDeg >= 0.703125
- * maxResolutionDeg <= 0.000000167638063430786
- * for current feature in the array
- * @param defaultMaxZoom optional - default is 22 - if maxResolutionDeg property was provided, the param will be ignored
- * @param defaultMinZoom optional - default is 0 - if minResolutionDeg property was provided, the param will be ignored
- * @returns tile count included on provided feature and zooms ranges
- */
-function featureCollectionToTilesCount(fc, defaultMaxZoom, defaultMinZoom) {
-    var e_1, _a;
-    if (defaultMaxZoom === void 0) { defaultMaxZoom = 22; }
-    if (defaultMinZoom === void 0) { defaultMinZoom = 0; }
-    var tilesTotalAmount = 0;
-    try {
-        try {
-            for (var _b = __values(fc.features), _c = _b.next(); !_c.done; _c = _b.next()) {
-                var feature = _c.value;
-                tilesTotalAmount += featureToTilesCount(feature, defaultMaxZoom, defaultMinZoom);
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-        return tilesTotalAmount;
-    }
-    catch (error) {
-        var message = "Error occurred while trying to calculate tiles amount - encodeFootprint error: ".concat(JSON.stringify(error));
-        throw new Error(message);
-    }
-}
-exports.featureCollectionToTilesCount = featureCollectionToTilesCount;
+"use strict";
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.featureCollectionToTilesCount = exports.featureToTilesCount = exports.tileRangeToTilesCount = exports.tileToBbox = exports.degreesPerPixelToZoomLevel = exports.zoomLevelToResolutionMeter = exports.zoomLevelToResolutionDeg = exports.flipYAxis = exports.degreesPerPixel = exports.degreesPerTile = void 0;
+var turf_1 = require("@turf/turf");
+var bboxUtils_1 = require("./bboxUtils");
+var geoConvertor_1 = require("./geoConvertor");
+var zoomToResolutionDegMapper = {
+    /* eslint-disable @typescript-eslint/naming-convention */
+    0: 0.703125,
+    1: 0.3515625,
+    2: 0.17578125,
+    3: 0.087890625,
+    4: 0.0439453125,
+    5: 0.02197265625,
+    6: 0.010986328125,
+    7: 0.0054931640625,
+    8: 0.00274658203125,
+    9: 0.001373291015625,
+    10: 0.0006866455078125,
+    11: 0.00034332275390625,
+    12: 0.000171661376953125,
+    13: 0.0000858306884765625,
+    14: 0.0000429153442382812,
+    15: 0.0000214576721191406,
+    16: 0.0000107288360595703,
+    17: 0.00000536441802978516,
+    18: 0.00000268220901489258,
+    19: 0.00000134110450744629,
+    20: 0.000000670552253723145,
+    21: 0.000000335276126861572,
+    22: 0.000000167638063430786,
+    /* eslint-enable @typescript-eslint/naming-convention */
+};
+var zoomToResolutionMeterMapper = {
+    /* eslint-disable @typescript-eslint/naming-convention */
+    0: 78271.52,
+    1: 39135.76,
+    2: 19567.88,
+    3: 9783.94,
+    4: 4891.97,
+    5: 2445.98,
+    6: 1222.99,
+    7: 611.5,
+    8: 305.75,
+    9: 152.87,
+    10: 76.44,
+    11: 38.22,
+    12: 19.11,
+    13: 9.55,
+    14: 4.78,
+    15: 2.39,
+    16: 1.19,
+    17: 0.6,
+    18: 0.3,
+    19: 0.15,
+    20: 0.075,
+    21: 0.037,
+    22: 0.0185,
+    /* eslint-enable @typescript-eslint/naming-convention */
+};
+/**
+ * calculates tile size (resolution) in degrees
+ * @param zoomLevel zoom level of returned tile size
+ * @returns tile size (resolution) in degrees
+ */
+function degreesPerTile(zoomLevel) {
+    var latRange = 180;
+    return latRange / (1 << zoomLevel);
+}
+exports.degreesPerTile = degreesPerTile;
+/**
+ * returns pixel size (resolution) in degrees
+ * @param zoomLevel tile zoom level of returned tile pixel size
+ * @returns pixel size (resolution) in degrees
+ */
+function degreesPerPixel(zoomLevel) {
+    var tileSize = 256;
+    var tileRes = degreesPerTile(zoomLevel);
+    return tileRes / tileSize;
+}
+exports.degreesPerPixel = degreesPerPixel;
+/**
+ * coverts tile coordinates between ll and ul
+ * @param tile source tile
+ * @returns converted tile
+ */
+function flipYAxis(tile) {
+    var yTiles = 1 << tile.zoom;
+    return {
+        x: tile.x,
+        y: yTiles - tile.y - 1,
+        zoom: tile.zoom,
+    };
+}
+exports.flipYAxis = flipYAxis;
+/**
+ * converts zoom level (integer) to matching resolution degree value
+ * @param zoom zoom level in range of 0-22
+ * @returns resolution represented in degrees, or undefined if zoom level is out of range
+ */
+function zoomLevelToResolutionDeg(zoom) {
+    return zoomToResolutionDegMapper[zoom];
+}
+exports.zoomLevelToResolutionDeg = zoomLevelToResolutionDeg;
+/**
+ * converts zoom level (integer) to matching resolution meter value
+ * @param zoom zoom level in range of 0-22
+ * @returns resolution represented in Meters, or undefined if zoom level is out of range
+ */
+function zoomLevelToResolutionMeter(zoom) {
+    return zoomToResolutionMeterMapper[zoom];
+}
+exports.zoomLevelToResolutionMeter = zoomLevelToResolutionMeter;
+/**
+ * converts pixel size (resolution) in degrees to matching zoom level (rounded down)
+ * @param resolution pixel size (resolution) in degrees
+ * @returns zoom level for given pixel size
+ */
+function degreesPerPixelToZoomLevel(resolution) {
+    var MIN_ZOOM_LEVEL = 0;
+    // eslint-disable-next-line @typescript-eslint/no-magic-numbers
+    var zoomLevel = Math.floor(Math.log2(180 / (resolution * 256)));
+    if (zoomLevel < MIN_ZOOM_LEVEL) {
+        throw new Error("Invalid zoom level ".concat(zoomLevel, " for resolution ").concat(resolution));
+    }
+    return zoomLevel;
+}
+exports.degreesPerPixelToZoomLevel = degreesPerPixelToZoomLevel;
+/**
+ * returns bbox of given tile
+ * @param tile
+ * @returns
+ */
+function tileToBbox(tile) {
+    var minPoint = (0, geoConvertor_1.tileToDegrees)(tile);
+    var tileSize = degreesPerTile(tile.zoom);
+    return [minPoint.longitude, minPoint.latitude, minPoint.longitude + tileSize, minPoint.latitude + tileSize];
+}
+exports.tileToBbox = tileToBbox;
+/**
+ * returns the batch area
+ * @param ITileRange
+ * @returns
+ */
+function tileRangeToTilesCount(batch) {
+    return (batch.maxX - batch.minX) * (batch.maxY - batch.minY);
+}
+exports.tileRangeToTilesCount = tileRangeToTilesCount;
+/**
+ * returns tiles amount of given feature and zoom ranges - based on 2:1 tile scheme
+ * use the bboxToTileRange method and provide sanitized bbox coverage of tiles
+ * @param feature
+ * If feature's properties include attributes of "maxResolutionDeg" and "minResolutionDeg" or just one of them -
+ * It will be converted to maxZoom and minZoom instead of default params to calculate
+ * minResolutionDeg >= 0.703125
+ * maxResolutionDeg <= 0.000000167638063430786
+ * @param layerFootprint - referenced layer geometry to snap on the bbox
+ * @param defaultMaxZoom optional - default is 22 - if maxResolutionDeg property was provided, the param will be ignored
+ * @param defaultMinZoom optional - default is 0 - if minResolutionDeg property was provided, the param will be ignored
+ * @returns tile count included on provided feature and zooms ranges
+ */
+function featureToTilesCount(feature, defaultMaxZoom, defaultMinZoom) {
+    var _a, _b;
+    if (defaultMaxZoom === void 0) { defaultMaxZoom = 22; }
+    if (defaultMinZoom === void 0) { defaultMinZoom = 0; }
+    var tilesTotalAmount = 0;
+    if (defaultMaxZoom > 22 || defaultMinZoom < 0) {
+        throw new RangeError("Un supported zoom levels values, min-max zoom should be [0-22] but actual [".concat(defaultMinZoom, ":").concat(defaultMaxZoom, "]"));
+    }
+    if (defaultMinZoom > defaultMaxZoom) {
+        throw new RangeError("Illegal - defaultMinZoom[".concat(defaultMinZoom, "] is larger than defaultMaxZoom[").concat(defaultMaxZoom, "]"));
+    }
+    try {
+        var targetMaxZoom = ((_a = feature.properties) === null || _a === void 0 ? void 0 : _a.maxResolutionDeg) !== undefined && typeof feature.properties.maxResolutionDeg === 'number'
+            ? degreesPerPixelToZoomLevel(feature.properties.maxResolutionDeg)
+            : defaultMaxZoom;
+        var targetMinZoom = ((_b = feature.properties) === null || _b === void 0 ? void 0 : _b.minResolutionDeg) !== undefined && typeof feature.properties.minResolutionDeg === 'number'
+            ? degreesPerPixelToZoomLevel(feature.properties.minResolutionDeg)
+            : defaultMinZoom;
+        var sanitized = (0, bboxUtils_1.snapBBoxToTileGrid)((0, turf_1.bbox)(feature.geometry), targetMaxZoom);
+        for (var i = targetMinZoom; i <= targetMaxZoom; i++) {
+            var zoomTilesBatch = (0, bboxUtils_1.bboxToTileRange)(sanitized, i);
+            tilesTotalAmount += tileRangeToTilesCount(zoomTilesBatch);
+        }
+        return tilesTotalAmount;
+    }
+    catch (error) {
+        var message = "Error occurred while trying to calculate tiles amount - encodeFootprint error: ".concat(JSON.stringify(error));
+        throw new Error(message);
+    }
+}
+exports.featureToTilesCount = featureToTilesCount;
+/**
+ * returns tiles amount of given featureCollection [each feature may include maxResolutionDeg and minResolutionDeg
+ * if no resolutions in property will calculate all features with optional argument]
+ * based on 2:1 tile scheme
+ * use the bboxToTileRange method and provide sanitized bbox coverage of tiles
+ * @param fc - FeatureCollection
+ * foreach feature in featuresCollection features array:
+ * If feature's properties include attributes of "maxResolutionDeg" and "minResolutionDeg" or just one of them -
+ * It will be converted to maxZoom and minZoom instead of default params to calculate
+ * minResolutionDeg >= 0.703125
+ * maxResolutionDeg <= 0.000000167638063430786
+ * for current feature in the array
+ * @param defaultMaxZoom optional - default is 22 - if maxResolutionDeg property was provided, the param will be ignored
+ * @param defaultMinZoom optional - default is 0 - if minResolutionDeg property was provided, the param will be ignored
+ * @returns tile count included on provided feature and zooms ranges
+ */
+function featureCollectionToTilesCount(fc, defaultMaxZoom, defaultMinZoom) {
+    var e_1, _a;
+    if (defaultMaxZoom === void 0) { defaultMaxZoom = 22; }
+    if (defaultMinZoom === void 0) { defaultMinZoom = 0; }
+    var tilesTotalAmount = 0;
+    try {
+        try {
+            for (var _b = __values(fc.features), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var feature = _c.value;
+                tilesTotalAmount += featureToTilesCount(feature, defaultMaxZoom, defaultMinZoom);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return tilesTotalAmount;
+    }
+    catch (error) {
+        var message = "Error occurred while trying to calculate tiles amount - encodeFootprint error: ".concat(JSON.stringify(error));
+        throw new Error(message);
+    }
+}
+exports.featureCollectionToTilesCount = featureCollectionToTilesCount;
 //# sourceMappingURL=tiles.js.map

package/dist/geo/tilesGenerator.d.ts

@@ -1,3 +1,3 @@
-import { ITile, ITileRange } from '../models/interfaces/geo/iTile';
-export declare function tilesGenerator(rangeGen: Iterable<ITileRange>): Generator<ITile>;
+import { ITile, ITileRange } from '../models/interfaces/geo/iTile';
+export declare function tilesGenerator(rangeGen: Iterable<ITileRange>): Generator<ITile>;
 //# sourceMappingURL=tilesGenerator.d.ts.map