@turf/difference 7.0.0-alpha.0 → 7.0.0-alpha.110

package/README.md

@@ -52,26 +52,21 @@ Returns **([Feature][5]<([Polygon][3] | [MultiPolygon][4])> | null)** a Polygon
 
 [5]: https://tools.ietf.org/html/rfc7946#section-3.2
 
-<!-- This file is automatically generated. Please don't edit it directly:
-if you find an error, edit the source file (likely index.js), and re-run
-./scripts/generate-readmes in the turf project. -->
+<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 
 ---
 
-This module is part of the [Turfjs project](http://turfjs.org/), an open source
-module collection dedicated to geographic algorithms. It is maintained in the
-[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
-PRs and issues.
+This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.
 
 ### Installation
 
-Install this module individually:
+Install this single module individually:
 
 ```sh
 $ npm install @turf/difference
 ```
 
-Or install the Turf module that includes it as a function:
+Or install the all-encompassing @turf/turf module that includes all modules as functions:
 
 ```sh
 $ npm install @turf/turf

package/dist/cjs/index.cjs

@@ -0,0 +1,30 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+var _polygonclipping = require('polygon-clipping'); var _polygonclipping2 = _interopRequireDefault(_polygonclipping);
+var _helpers = require('@turf/helpers');
+var _meta = require('@turf/meta');
+function difference(features) {
+  const geoms = [];
+  _meta.geomEach.call(void 0, features, (geom) => {
+    geoms.push(geom.coordinates);
+  });
+  if (geoms.length < 2) {
+    throw new Error("Must have at least two features");
+  }
+  const properties = features.features[0].properties || {};
+  const differenced = _polygonclipping2.default.difference(geoms[0], ...geoms.slice(1));
+  if (differenced.length === 0)
+    return null;
+  if (differenced.length === 1)
+    return _helpers.polygon.call(void 0, differenced[0], properties);
+  return _helpers.multiPolygon.call(void 0, differenced, properties);
+}
+__name(difference, "difference");
+var turf_difference_default = difference;
+
+
+
+exports.default = turf_difference_default; exports.difference = difference;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";;;;AACA,OAAO,qBAA+B;AACtC,SAAS,SAAS,oBAAoB;AACtC,SAAS,gBAAgB;AAmCzB,SAAS,WACP,UACwC;AACxC,QAAM,QAAqB,CAAC;AAE5B,WAAS,UAAU,CAAC,SAAS;AAC3B,UAAM,KAAK,KAAK,WAAmB;AAAA,EACrC,CAAC;AAED,MAAI,MAAM,SAAS,GAAG;AACpB,UAAM,IAAI,MAAM,iCAAiC;AAAA,EACnD;AAEA,QAAM,aAAa,SAAS,SAAS,CAAC,EAAE,cAAc,CAAC;AAEvD,QAAM,cAAc,gBAAgB,WAAW,MAAM,CAAC,GAAG,GAAG,MAAM,MAAM,CAAC,CAAC;AAC1E,MAAI,YAAY,WAAW;AAAG,WAAO;AACrC,MAAI,YAAY,WAAW;AAAG,WAAO,QAAQ,YAAY,CAAC,GAAG,UAAU;AACvE,SAAO,aAAa,aAAa,UAAU;AAC7C;AAnBS;AAsBT,IAAO,0BAAQ","sourcesContent":["import { Polygon, MultiPolygon, Feature, FeatureCollection } from \"geojson\";\nimport polygonClipping, { Geom } from \"polygon-clipping\";\nimport { polygon, multiPolygon } from \"@turf/helpers\";\nimport { geomEach } from \"@turf/meta\";\n\n/**\n * Finds the difference between multiple {@link Polygon|polygons} by clipping the subsequent polygon from the first.\n *\n * @name difference\n * @param {FeatureCollection<Polygon|MultiPolygon>} features input Polygon features\n * @returns {Feature<Polygon|MultiPolygon>|null} a Polygon or MultiPolygon feature showing the area of `polygon1` excluding the area of `polygon2` (if empty returns `null`)\n * @example\n * var polygon1 = turf.polygon([[\n *   [128, -26],\n *   [141, -26],\n *   [141, -21],\n *   [128, -21],\n *   [128, -26]\n * ]], {\n *   \"fill\": \"#F00\",\n *   \"fill-opacity\": 0.1\n * });\n * var polygon2 = turf.polygon([[\n *   [126, -28],\n *   [140, -28],\n *   [140, -20],\n *   [126, -20],\n *   [126, -28]\n * ]], {\n *   \"fill\": \"#00F\",\n *   \"fill-opacity\": 0.1\n * });\n *\n * var difference = turf.difference(turf.featureCollection([polygon1, polygon2]));\n *\n * //addToMap\n * var addToMap = [polygon1, polygon2, difference];\n */\nfunction difference(\n  features: FeatureCollection<Polygon | MultiPolygon>\n): Feature<Polygon | MultiPolygon> | null {\n  const geoms: Array<Geom> = [];\n\n  geomEach(features, (geom) => {\n    geoms.push(geom.coordinates as Geom);\n  });\n\n  if (geoms.length < 2) {\n    throw new Error(\"Must have at least two features\");\n  }\n\n  const properties = features.features[0].properties || {};\n\n  const differenced = polygonClipping.difference(geoms[0], ...geoms.slice(1));\n  if (differenced.length === 0) return null;\n  if (differenced.length === 1) return polygon(differenced[0], properties);\n  return multiPolygon(differenced, properties);\n}\n\nexport { difference };\nexport default difference;\n"]}

package/dist/{es/index.js → cjs/index.d.ts}

@@ -1,6 +1,4 @@
-import polygonClipping from 'polygon-clipping';
-import { polygon, multiPolygon } from '@turf/helpers';
-import { geomEach } from '@turf/meta';
+import { FeatureCollection, Polygon, MultiPolygon, Feature } from 'geojson';
 
 /**
  * Finds the difference between multiple {@link Polygon|polygons} by clipping the subsequent polygon from the first.
@@ -35,23 +33,6 @@ import { geomEach } from '@turf/meta';
  * //addToMap
  * var addToMap = [polygon1, polygon2, difference];
  */
-function difference(features) {
-  const geoms = [];
+declare function difference(features: FeatureCollection<Polygon | MultiPolygon>): Feature<Polygon | MultiPolygon> | null;
 
-  geomEach(features, (geom) => {
-    geoms.push(geom.coordinates);
-  });
-
-  if (geoms.length < 2) {
-    throw new Error("Must have at least two features");
-  }
-
-  var properties = features.features[0].properties || {};
-
-  var differenced = polygonClipping.difference(geoms[0], ...geoms.slice(1));
-  if (differenced.length === 0) return null;
-  if (differenced.length === 1) return polygon(differenced[0], properties);
-  return multiPolygon(differenced, properties);
-}
-
-export default difference;
+export { difference as default, difference };

package/dist/esm/index.d.mts

@@ -0,0 +1,38 @@
+import { FeatureCollection, Polygon, MultiPolygon, Feature } from 'geojson';
+
+/**
+ * Finds the difference between multiple {@link Polygon|polygons} by clipping the subsequent polygon from the first.
+ *
+ * @name difference
+ * @param {FeatureCollection<Polygon|MultiPolygon>} features input Polygon features
+ * @returns {Feature<Polygon|MultiPolygon>|null} a Polygon or MultiPolygon feature showing the area of `polygon1` excluding the area of `polygon2` (if empty returns `null`)
+ * @example
+ * var polygon1 = turf.polygon([[
+ *   [128, -26],
+ *   [141, -26],
+ *   [141, -21],
+ *   [128, -21],
+ *   [128, -26]
+ * ]], {
+ *   "fill": "#F00",
+ *   "fill-opacity": 0.1
+ * });
+ * var polygon2 = turf.polygon([[
+ *   [126, -28],
+ *   [140, -28],
+ *   [140, -20],
+ *   [126, -20],
+ *   [126, -28]
+ * ]], {
+ *   "fill": "#00F",
+ *   "fill-opacity": 0.1
+ * });
+ *
+ * var difference = turf.difference(turf.featureCollection([polygon1, polygon2]));
+ *
+ * //addToMap
+ * var addToMap = [polygon1, polygon2, difference];
+ */
+declare function difference(features: FeatureCollection<Polygon | MultiPolygon>): Feature<Polygon | MultiPolygon> | null;
+
+export { difference as default, difference };

package/dist/esm/index.mjs

@@ -0,0 +1,30 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+import polygonClipping from "polygon-clipping";
+import { polygon, multiPolygon } from "@turf/helpers";
+import { geomEach } from "@turf/meta";
+function difference(features) {
+  const geoms = [];
+  geomEach(features, (geom) => {
+    geoms.push(geom.coordinates);
+  });
+  if (geoms.length < 2) {
+    throw new Error("Must have at least two features");
+  }
+  const properties = features.features[0].properties || {};
+  const differenced = polygonClipping.difference(geoms[0], ...geoms.slice(1));
+  if (differenced.length === 0)
+    return null;
+  if (differenced.length === 1)
+    return polygon(differenced[0], properties);
+  return multiPolygon(differenced, properties);
+}
+__name(difference, "difference");
+var turf_difference_default = difference;
+export {
+  turf_difference_default as default,
+  difference
+};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { Polygon, MultiPolygon, Feature, FeatureCollection } from \"geojson\";\nimport polygonClipping, { Geom } from \"polygon-clipping\";\nimport { polygon, multiPolygon } from \"@turf/helpers\";\nimport { geomEach } from \"@turf/meta\";\n\n/**\n * Finds the difference between multiple {@link Polygon|polygons} by clipping the subsequent polygon from the first.\n *\n * @name difference\n * @param {FeatureCollection<Polygon|MultiPolygon>} features input Polygon features\n * @returns {Feature<Polygon|MultiPolygon>|null} a Polygon or MultiPolygon feature showing the area of `polygon1` excluding the area of `polygon2` (if empty returns `null`)\n * @example\n * var polygon1 = turf.polygon([[\n *   [128, -26],\n *   [141, -26],\n *   [141, -21],\n *   [128, -21],\n *   [128, -26]\n * ]], {\n *   \"fill\": \"#F00\",\n *   \"fill-opacity\": 0.1\n * });\n * var polygon2 = turf.polygon([[\n *   [126, -28],\n *   [140, -28],\n *   [140, -20],\n *   [126, -20],\n *   [126, -28]\n * ]], {\n *   \"fill\": \"#00F\",\n *   \"fill-opacity\": 0.1\n * });\n *\n * var difference = turf.difference(turf.featureCollection([polygon1, polygon2]));\n *\n * //addToMap\n * var addToMap = [polygon1, polygon2, difference];\n */\nfunction difference(\n  features: FeatureCollection<Polygon | MultiPolygon>\n): Feature<Polygon | MultiPolygon> | null {\n  const geoms: Array<Geom> = [];\n\n  geomEach(features, (geom) => {\n    geoms.push(geom.coordinates as Geom);\n  });\n\n  if (geoms.length < 2) {\n    throw new Error(\"Must have at least two features\");\n  }\n\n  const properties = features.features[0].properties || {};\n\n  const differenced = polygonClipping.difference(geoms[0], ...geoms.slice(1));\n  if (differenced.length === 0) return null;\n  if (differenced.length === 1) return polygon(differenced[0], properties);\n  return multiPolygon(differenced, properties);\n}\n\nexport { difference };\nexport default difference;\n"],"mappings":";;;;AACA,OAAO,qBAA+B;AACtC,SAAS,SAAS,oBAAoB;AACtC,SAAS,gBAAgB;AAmCzB,SAAS,WACP,UACwC;AACxC,QAAM,QAAqB,CAAC;AAE5B,WAAS,UAAU,CAAC,SAAS;AAC3B,UAAM,KAAK,KAAK,WAAmB;AAAA,EACrC,CAAC;AAED,MAAI,MAAM,SAAS,GAAG;AACpB,UAAM,IAAI,MAAM,iCAAiC;AAAA,EACnD;AAEA,QAAM,aAAa,SAAS,SAAS,CAAC,EAAE,cAAc,CAAC;AAEvD,QAAM,cAAc,gBAAgB,WAAW,MAAM,CAAC,GAAG,GAAG,MAAM,MAAM,CAAC,CAAC;AAC1E,MAAI,YAAY,WAAW;AAAG,WAAO;AACrC,MAAI,YAAY,WAAW;AAAG,WAAO,QAAQ,YAAY,CAAC,GAAG,UAAU;AACvE,SAAO,aAAa,aAAa,UAAU;AAC7C;AAnBS;AAsBT,IAAO,0BAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/difference",
-  "version": "7.0.0-alpha.0",
+  "version": "7.0.0-alpha.110+1411d63a7",
   "description": "turf difference module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -20,41 +20,52 @@
     "turf",
     "gis"
   ],
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "type": "commonjs",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.mjs",
+  "types": "dist/cjs/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "import": "./dist/es/index.js",
-      "require": "./dist/js/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
+      }
     }
   },
-  "types": "index.d.ts",
   "sideEffects": false,
   "files": [
-    "dist",
-    "index.d.ts"
+    "dist"
   ],
   "scripts": {
-    "bench": "node -r esm bench.js",
-    "build": "rollup -c ../../rollup.config.js && echo '{\"type\":\"module\"}' > dist/es/package.json",
-    "docs": "node ../../scripts/generate-readmes",
-    "test": "npm-run-all test:*",
-    "test:tape": "node -r esm test.js"
+    "bench": "tsx bench.ts",
+    "build": "tsup --config ../../tsup.config.ts",
+    "docs": "tsx ../../scripts/generate-readmes.ts",
+    "test": "npm-run-all --npm-path npm test:*",
+    "test:tape": "tsx test.ts"
   },
   "devDependencies": {
-    "benchmark": "*",
-    "glob": "*",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "rollup": "*",
-    "tape": "*",
-    "write-json-file": "*"
+    "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
+    "benchmark": "^2.1.4",
+    "glob": "^10.3.10",
+    "load-json-file": "^7.0.1",
+    "npm-run-all": "^4.1.5",
+    "tape": "^5.7.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "typescript": "^5.2.2",
+    "write-json-file": "^5.0.0"
   },
   "dependencies": {
-    "@turf/helpers": "^7.0.0-alpha.0",
-    "@turf/meta": "^7.0.0-alpha.0",
-    "polygon-clipping": "^0.15.3"
+    "@turf/helpers": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/meta": "^7.0.0-alpha.110+1411d63a7",
+    "polygon-clipping": "^0.15.3",
+    "tslib": "^2.6.2"
   },
-  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
+  "gitHead": "1411d63a74c275c9216fe48e9d3cb2d48a359068"
 }

package/dist/es/package.json

@@ -1 +0,0 @@
-{"type":"module"}

package/dist/js/index.js

@@ -1,64 +0,0 @@
-'use strict';
-
-var polygonClipping = require('polygon-clipping');
-var helpers = require('@turf/helpers');
-var meta = require('@turf/meta');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var polygonClipping__default = /*#__PURE__*/_interopDefaultLegacy(polygonClipping);
-
-/**
- * Finds the difference between multiple {@link Polygon|polygons} by clipping the subsequent polygon from the first.
- *
- * @name difference
- * @param {FeatureCollection<Polygon|MultiPolygon>} features input Polygon features
- * @returns {Feature<Polygon|MultiPolygon>|null} a Polygon or MultiPolygon feature showing the area of `polygon1` excluding the area of `polygon2` (if empty returns `null`)
- * @example
- * var polygon1 = turf.polygon([[
- *   [128, -26],
- *   [141, -26],
- *   [141, -21],
- *   [128, -21],
- *   [128, -26]
- * ]], {
- *   "fill": "#F00",
- *   "fill-opacity": 0.1
- * });
- * var polygon2 = turf.polygon([[
- *   [126, -28],
- *   [140, -28],
- *   [140, -20],
- *   [126, -20],
- *   [126, -28]
- * ]], {
- *   "fill": "#00F",
- *   "fill-opacity": 0.1
- * });
- *
- * var difference = turf.difference(turf.featureCollection([polygon1, polygon2]));
- *
- * //addToMap
- * var addToMap = [polygon1, polygon2, difference];
- */
-function difference(features) {
-  const geoms = [];
-
-  meta.geomEach(features, (geom) => {
-    geoms.push(geom.coordinates);
-  });
-
-  if (geoms.length < 2) {
-    throw new Error("Must have at least two features");
-  }
-
-  var properties = features.features[0].properties || {};
-
-  var differenced = polygonClipping__default['default'].difference(geoms[0], ...geoms.slice(1));
-  if (differenced.length === 0) return null;
-  if (differenced.length === 1) return helpers.polygon(differenced[0], properties);
-  return helpers.multiPolygon(differenced, properties);
-}
-
-module.exports = difference;
-module.exports.default = difference;

package/index.d.ts

@@ -1,8 +0,0 @@
-import { Polygon, MultiPolygon, Feature, FeatureCollection } from "geojson";
-
-/**
- * http://turfjs.org/docs/#difference
- */
-export default function difference(
-  features: FeatureCollection<Polygon | MultiPolygon>
-): Feature<Polygon | MultiPolygon> | null;