@turf/mask 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -6,12 +6,12 @@
 
 Takes any type of [polygon][1] and an optional mask and returns a [polygon][1] exterior ring with holes.
 
-**Parameters**
+### Parameters
 
--   `polygon` **([FeatureCollection][2] \| [Feature][3]<([Polygon][4] \| [MultiPolygon][5])>)** GeoJSON Polygon used as interior rings or holes.
--   `mask` **[Feature][3]<[Polygon][4]>?** GeoJSON Polygon used as the exterior ring (if undefined, the world extent is used)
+*   `polygon` **([FeatureCollection][2] | [Feature][3]<([Polygon][4] | [MultiPolygon][5])>)** GeoJSON Polygon used as interior rings or holes.
+*   `mask` **[Feature][3]<[Polygon][4]>?** GeoJSON Polygon used as the exterior ring (if undefined, the world extent is used)
 
-**Examples**
+### Examples
 
 ```javascript
 var polygon = turf.polygon([[[112, -21], [116, -36], [146, -39], [153, -24], [133, -10], [112, -21]]]);
@@ -23,7 +23,7 @@ var masked = turf.mask(polygon, mask);
 var addToMap = [masked]
 ```
 
-Returns **[Feature][3]&lt;[Polygon][4]>** Masked Polygon (exterior ring with holes).
+Returns **[Feature][3]<[Polygon][4]>** Masked Polygon (exterior ring with holes).
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 

package/dist/es/index.js

@@ -1,8 +1,5 @@
-import rbush from 'rbush';
-import union from '@turf/union';
-import { polygon, featureCollection } from '@turf/helpers';
-import turfBBox from '@turf/bbox';
-import { flattenEach } from '@turf/meta';
+import { polygon, multiPolygon } from '@turf/helpers';
+import polygonClipping from 'polygon-clipping';
 
 /**
  * Takes any type of {@link Polygon|polygon} and an optional mask and returns a {@link Polygon|polygon} exterior ring with holes.
@@ -20,67 +17,42 @@ import { flattenEach } from '@turf/meta';
  * //addToMap
  * var addToMap = [masked]
  */
-function mask(polygon$$1, mask) {
+function mask(polygon, mask) {
   // Define mask
   var maskPolygon = createMask(mask);
 
-  // Define polygon
-  var separated = separatePolygons(polygon$$1);
-  var polygonOuters = separated[0];
-  var polygonInners = separated[1];
+  var polygonOuters = null;
+  if (polygon.type === "FeatureCollection") polygonOuters = unionFc(polygon);
+  else
+    polygonOuters = createGeomFromPolygonClippingOutput(
+      polygonClipping.union(polygon.geometry.coordinates)
+    );
 
-  // Union Outers & Inners
-  polygonOuters = unionPolygons(polygonOuters);
-  polygonInners = unionPolygons(polygonInners);
+  polygonOuters.geometry.coordinates.forEach(function (contour) {
+    maskPolygon.geometry.coordinates.push(contour[0]);
+  });
 
-  // Create masked area
-  var masked = buildMask(maskPolygon, polygonOuters, polygonInners);
-  return masked;
+  return maskPolygon;
 }
 
-/**
- * Build Mask
- *
- * @private
- * @param {Feature<Polygon>} maskPolygon Mask Outer
- * @param {FeatureCollection<Polygon>} polygonOuters Polygon Outers
- * @param {FeatureCollection<Polygon>} polygonInners Polygon Inners
- * @returns {Feature<Polygon>} Feature Polygon
- */
-function buildMask(maskPolygon, polygonOuters, polygonInners) {
-  var coordinates = [];
-  coordinates.push(maskPolygon.geometry.coordinates[0]);
-
-  flattenEach(polygonOuters, function (feature) {
-    coordinates.push(feature.geometry.coordinates[0]);
-  });
-
-  flattenEach(polygonInners, function (feature) {
-    coordinates.push(feature.geometry.coordinates[0]);
-  });
-  return polygon(coordinates);
+function unionFc(fc) {
+  var unioned =
+    fc.features.length === 2
+      ? polygonClipping.union(
+          fc.features[0].geometry.coordinates,
+          fc.features[1].geometry.coordinates
+        )
+      : polygonClipping.union.apply(
+          polygonClipping,
+          fc.features.map(function (f) {
+            return f.geometry.coordinates;
+          })
+        );
+  return createGeomFromPolygonClippingOutput(unioned);
 }
 
-/**
- * Separate Polygons to inners & outers
- *
- * @private
- * @param {FeatureCollection|Feature<Polygon|MultiPolygon>} poly GeoJSON Feature
- * @returns {Array<FeatureCollection<Polygon>, FeatureCollection<Polygon>>} Outer & Inner lines
- */
-function separatePolygons(poly) {
-  var outers = [];
-  var inners = [];
-  flattenEach(poly, function (feature) {
-    var coordinates = feature.geometry.coordinates;
-    var featureOuter = coordinates[0];
-    var featureInner = coordinates.slice(1);
-    outers.push(polygon([featureOuter]));
-    featureInner.forEach(function (inner) {
-      inners.push(polygon([inner]));
-    });
-  });
-  return [featureCollection(outers), featureCollection(inners)];
+function createGeomFromPolygonClippingOutput(unioned) {
+  return multiPolygon(unioned);
 }
 
 /**
@@ -104,92 +76,4 @@ function createMask(mask) {
   return polygon(coordinates);
 }
 
-/**
- * Union Polygons
- *
- * @private
- * @param {FeatureCollection<Polygon>} polygons collection of polygons
- * @returns {FeatureCollection<Polygon>} polygons only apply union if they collide
- */
-function unionPolygons(polygons) {
-  if (polygons.features.length <= 1) return polygons;
-
-  var tree = createIndex(polygons);
-  var results = [];
-  var removed = {};
-
-  flattenEach(polygons, function (currentFeature, currentIndex) {
-    // Exclude any removed features
-    if (removed[currentIndex]) return true;
-
-    // Don't search for itself
-    tree.remove({ index: currentIndex }, filterByIndex);
-    removed[currentIndex] = true;
-
-    // Keep applying the union operation until no more overlapping features
-    while (true) {
-      var bbox = turfBBox(currentFeature);
-      var search = tree.search({
-        minX: bbox[0],
-        minY: bbox[1],
-        maxX: bbox[2],
-        maxY: bbox[3],
-      });
-      if (search.length > 0) {
-        var polys = search.map(function (item) {
-          removed[item.index] = true;
-          tree.remove({ index: item.index }, filterByIndex);
-          return item.geojson;
-        });
-
-        for (var i = 0, l = polys.length; i < l; i++) {
-          currentFeature = union(currentFeature, polys[i]);
-        }
-      }
-      // Done
-      if (search.length === 0) break;
-    }
-    results.push(currentFeature);
-  });
-
-  return featureCollection(results);
-}
-
-/**
- * Filter by Index - RBush helper function
- *
- * @private
- * @param {Object} a remove item
- * @param {Object} b search item
- * @returns {boolean} true if matches
- */
-function filterByIndex(a, b) {
-  return a.index === b.index;
-}
-
-/**
- * Create RBush Tree Index
- *
- * @private
- * @param {FeatureCollection<any>} features GeoJSON FeatureCollection
- * @returns {RBush} RBush Tree
- */
-function createIndex(features) {
-  var tree = rbush();
-  var load = [];
-  flattenEach(features, function (feature, index) {
-    var bbox = turfBBox(feature);
-    load.push({
-      minX: bbox[0],
-      minY: bbox[1],
-      maxX: bbox[2],
-      maxY: bbox[3],
-      geojson: feature,
-      index: index,
-    });
-  });
-  tree.load(load);
-  return tree;
-}
-
 export default mask;

package/dist/js/index.js

@@ -1,12 +1,11 @@
 'use strict';
 
-function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
-
-var rbush = _interopDefault(require('rbush'));
-var union = _interopDefault(require('@turf/union'));
 var helpers = require('@turf/helpers');
-var turfBBox = _interopDefault(require('@turf/bbox'));
-var meta = require('@turf/meta');
+var polygonClipping = require('polygon-clipping');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var polygonClipping__default = /*#__PURE__*/_interopDefaultLegacy(polygonClipping);
 
 /**
  * Takes any type of {@link Polygon|polygon} and an optional mask and returns a {@link Polygon|polygon} exterior ring with holes.
@@ -28,63 +27,38 @@ function mask(polygon, mask) {
   // Define mask
   var maskPolygon = createMask(mask);
 
-  // Define polygon
-  var separated = separatePolygons(polygon);
-  var polygonOuters = separated[0];
-  var polygonInners = separated[1];
+  var polygonOuters = null;
+  if (polygon.type === "FeatureCollection") polygonOuters = unionFc(polygon);
+  else
+    polygonOuters = createGeomFromPolygonClippingOutput(
+      polygonClipping__default['default'].union(polygon.geometry.coordinates)
+    );
 
-  // Union Outers & Inners
-  polygonOuters = unionPolygons(polygonOuters);
-  polygonInners = unionPolygons(polygonInners);
+  polygonOuters.geometry.coordinates.forEach(function (contour) {
+    maskPolygon.geometry.coordinates.push(contour[0]);
+  });
 
-  // Create masked area
-  var masked = buildMask(maskPolygon, polygonOuters, polygonInners);
-  return masked;
+  return maskPolygon;
 }
 
-/**
- * Build Mask
- *
- * @private
- * @param {Feature<Polygon>} maskPolygon Mask Outer
- * @param {FeatureCollection<Polygon>} polygonOuters Polygon Outers
- * @param {FeatureCollection<Polygon>} polygonInners Polygon Inners
- * @returns {Feature<Polygon>} Feature Polygon
- */
-function buildMask(maskPolygon, polygonOuters, polygonInners) {
-  var coordinates = [];
-  coordinates.push(maskPolygon.geometry.coordinates[0]);
-
-  meta.flattenEach(polygonOuters, function (feature) {
-    coordinates.push(feature.geometry.coordinates[0]);
-  });
-
-  meta.flattenEach(polygonInners, function (feature) {
-    coordinates.push(feature.geometry.coordinates[0]);
-  });
-  return helpers.polygon(coordinates);
+function unionFc(fc) {
+  var unioned =
+    fc.features.length === 2
+      ? polygonClipping__default['default'].union(
+          fc.features[0].geometry.coordinates,
+          fc.features[1].geometry.coordinates
+        )
+      : polygonClipping__default['default'].union.apply(
+          polygonClipping__default['default'],
+          fc.features.map(function (f) {
+            return f.geometry.coordinates;
+          })
+        );
+  return createGeomFromPolygonClippingOutput(unioned);
 }
 
-/**
- * Separate Polygons to inners & outers
- *
- * @private
- * @param {FeatureCollection|Feature<Polygon|MultiPolygon>} poly GeoJSON Feature
- * @returns {Array<FeatureCollection<Polygon>, FeatureCollection<Polygon>>} Outer & Inner lines
- */
-function separatePolygons(poly) {
-  var outers = [];
-  var inners = [];
-  meta.flattenEach(poly, function (feature) {
-    var coordinates = feature.geometry.coordinates;
-    var featureOuter = coordinates[0];
-    var featureInner = coordinates.slice(1);
-    outers.push(helpers.polygon([featureOuter]));
-    featureInner.forEach(function (inner) {
-      inners.push(helpers.polygon([inner]));
-    });
-  });
-  return [helpers.featureCollection(outers), helpers.featureCollection(inners)];
+function createGeomFromPolygonClippingOutput(unioned) {
+  return helpers.multiPolygon(unioned);
 }
 
 /**
@@ -108,92 +82,5 @@ function createMask(mask) {
   return helpers.polygon(coordinates);
 }
 
-/**
- * Union Polygons
- *
- * @private
- * @param {FeatureCollection<Polygon>} polygons collection of polygons
- * @returns {FeatureCollection<Polygon>} polygons only apply union if they collide
- */
-function unionPolygons(polygons) {
-  if (polygons.features.length <= 1) return polygons;
-
-  var tree = createIndex(polygons);
-  var results = [];
-  var removed = {};
-
-  meta.flattenEach(polygons, function (currentFeature, currentIndex) {
-    // Exclude any removed features
-    if (removed[currentIndex]) return true;
-
-    // Don't search for itself
-    tree.remove({ index: currentIndex }, filterByIndex);
-    removed[currentIndex] = true;
-
-    // Keep applying the union operation until no more overlapping features
-    while (true) {
-      var bbox = turfBBox(currentFeature);
-      var search = tree.search({
-        minX: bbox[0],
-        minY: bbox[1],
-        maxX: bbox[2],
-        maxY: bbox[3],
-      });
-      if (search.length > 0) {
-        var polys = search.map(function (item) {
-          removed[item.index] = true;
-          tree.remove({ index: item.index }, filterByIndex);
-          return item.geojson;
-        });
-
-        for (var i = 0, l = polys.length; i < l; i++) {
-          currentFeature = union(currentFeature, polys[i]);
-        }
-      }
-      // Done
-      if (search.length === 0) break;
-    }
-    results.push(currentFeature);
-  });
-
-  return helpers.featureCollection(results);
-}
-
-/**
- * Filter by Index - RBush helper function
- *
- * @private
- * @param {Object} a remove item
- * @param {Object} b search item
- * @returns {boolean} true if matches
- */
-function filterByIndex(a, b) {
-  return a.index === b.index;
-}
-
-/**
- * Create RBush Tree Index
- *
- * @private
- * @param {FeatureCollection<any>} features GeoJSON FeatureCollection
- * @returns {RBush} RBush Tree
- */
-function createIndex(features) {
-  var tree = rbush();
-  var load = [];
-  meta.flattenEach(features, function (feature, index) {
-    var bbox = turfBBox(feature);
-    load.push({
-      minX: bbox[0],
-      minY: bbox[1],
-      maxX: bbox[2],
-      maxY: bbox[3],
-      geojson: feature,
-      index: index,
-    });
-  });
-  tree.load(load);
-  return tree;
-}
-
 module.exports = mask;
+module.exports.default = mask;

package/index.d.ts

@@ -1,9 +1,4 @@
-import {
-  Feature,
-  Polygon,
-  MultiPolygon,
-  FeatureCollection,
-} from "@turf/helpers";
+import { Feature, Polygon, MultiPolygon, FeatureCollection } from "geojson";
 
 /**
  * http://turfjs.org/docs/#mask

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/mask",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf mask module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -12,6 +12,7 @@
     "type": "git",
     "url": "git://github.com/Turfjs/turf.git"
   },
+  "funding": "https://opencollective.com/turf",
   "publishConfig": {
     "access": "public"
   },
@@ -41,7 +42,7 @@
     "docs": "node ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
     "test:tape": "node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
     "benchmark": "*",
@@ -53,11 +54,8 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/bbox": "^6.4.0",
-    "@turf/helpers": "^6.4.0",
-    "@turf/meta": "^6.4.0",
-    "@turf/union": "^6.4.0",
-    "rbush": "^2.0.1"
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "polygon-clipping": "^0.15.3"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }