@turf/clusters 7.0.0-alpha.2 → 7.0.0

package/README.md

@@ -182,26 +182,21 @@ Returns **any** The value that results from the reduction.
 
 [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-<!-- 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/clusters
 ```
 
-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,127 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+var _meta = require('@turf/meta');
+var _helpers = require('@turf/helpers');
+function getCluster(geojson, filter) {
+  if (!geojson)
+    throw new Error("geojson is required");
+  if (geojson.type !== "FeatureCollection")
+    throw new Error("geojson must be a FeatureCollection");
+  if (filter === void 0 || filter === null)
+    throw new Error("filter is required");
+  var features = [];
+  _meta.featureEach.call(void 0, geojson, function(feature) {
+    if (applyFilter(feature.properties, filter))
+      features.push(feature);
+  });
+  return _helpers.featureCollection.call(void 0, features);
+}
+__name(getCluster, "getCluster");
+function clusterEach(geojson, property, callback) {
+  if (!geojson)
+    throw new Error("geojson is required");
+  if (geojson.type !== "FeatureCollection")
+    throw new Error("geojson must be a FeatureCollection");
+  if (property === void 0 || property === null)
+    throw new Error("property is required");
+  var bins = createBins(geojson, property);
+  var values = Object.keys(bins);
+  for (var index = 0; index < values.length; index++) {
+    var value = values[index];
+    var bin = bins[value];
+    var features = [];
+    for (var i = 0; i < bin.length; i++) {
+      features.push(geojson.features[bin[i]]);
+    }
+    callback(_helpers.featureCollection.call(void 0, features), value, index);
+  }
+}
+__name(clusterEach, "clusterEach");
+function clusterReduce(geojson, property, callback, initialValue) {
+  var previousValue = initialValue;
+  clusterEach(
+    geojson,
+    property,
+    function(cluster, clusterValue, currentIndex) {
+      if (currentIndex === 0 && initialValue === void 0)
+        previousValue = cluster;
+      else
+        previousValue = callback(
+          previousValue,
+          cluster,
+          clusterValue,
+          currentIndex
+        );
+    }
+  );
+  return previousValue;
+}
+__name(clusterReduce, "clusterReduce");
+function createBins(geojson, property) {
+  var bins = {};
+  _meta.featureEach.call(void 0, geojson, function(feature, i) {
+    var properties = feature.properties || {};
+    if (Object.prototype.hasOwnProperty.call(properties, String(property))) {
+      var value = properties[property];
+      if (Object.prototype.hasOwnProperty.call(bins, value))
+        bins[value].push(i);
+      else
+        bins[value] = [i];
+    }
+  });
+  return bins;
+}
+__name(createBins, "createBins");
+function applyFilter(properties, filter) {
+  if (properties === void 0)
+    return false;
+  var filterType = typeof filter;
+  if (filterType === "number" || filterType === "string")
+    return Object.prototype.hasOwnProperty.call(properties, filter);
+  else if (Array.isArray(filter)) {
+    for (var i = 0; i < filter.length; i++) {
+      if (!applyFilter(properties, filter[i]))
+        return false;
+    }
+    return true;
+  } else {
+    return propertiesContainsFilter(properties, filter);
+  }
+}
+__name(applyFilter, "applyFilter");
+function propertiesContainsFilter(properties, filter) {
+  var keys = Object.keys(filter);
+  for (var i = 0; i < keys.length; i++) {
+    var key = keys[i];
+    if (properties[key] !== filter[key])
+      return false;
+  }
+  return true;
+}
+__name(propertiesContainsFilter, "propertiesContainsFilter");
+function filterProperties(properties, keys) {
+  if (!keys)
+    return {};
+  if (!keys.length)
+    return {};
+  var newProperties = {};
+  for (var i = 0; i < keys.length; i++) {
+    var key = keys[i];
+    if (Object.prototype.hasOwnProperty.call(properties, key))
+      newProperties[key] = properties[key];
+  }
+  return newProperties;
+}
+__name(filterProperties, "filterProperties");
+
+
+
+
+
+
+
+
+exports.applyFilter = applyFilter; exports.clusterEach = clusterEach; exports.clusterReduce = clusterReduce; exports.createBins = createBins; exports.filterProperties = filterProperties; exports.getCluster = getCluster; exports.propertiesContainsFilter = propertiesContainsFilter;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";;;;AAMA,SAAS,mBAAmB;AAC5B,SAAS,yBAAyB;AA+BlC,SAAS,WAGP,SAAkC,QAAsC;AAExE,MAAI,CAAC;AAAS,UAAM,IAAI,MAAM,qBAAqB;AACnD,MAAI,QAAQ,SAAS;AACnB,UAAM,IAAI,MAAM,qCAAqC;AACvD,MAAI,WAAW,UAAa,WAAW;AACrC,UAAM,IAAI,MAAM,oBAAoB;AAGtC,MAAI,WAA4B,CAAC;AACjC,cAAkB,SAAS,SAAU,SAAS;AAC5C,QAAI,YAAY,QAAQ,YAAY,MAAM;AAAG,eAAS,KAAK,OAAO;AAAA,EACpE,CAAC;AACD,SAAO,kBAAkB,QAAQ;AACnC;AAjBS;AAoET,SAAS,YAIP,SACA,UACA,UAKM;AAEN,MAAI,CAAC;AAAS,UAAM,IAAI,MAAM,qBAAqB;AACnD,MAAI,QAAQ,SAAS;AACnB,UAAM,IAAI,MAAM,qCAAqC;AACvD,MAAI,aAAa,UAAa,aAAa;AACzC,UAAM,IAAI,MAAM,sBAAsB;AAGxC,MAAI,OAAO,WAAW,SAAS,QAAQ;AACvC,MAAI,SAAS,OAAO,KAAK,IAAI;AAC7B,WAAS,QAAQ,GAAG,QAAQ,OAAO,QAAQ,SAAS;AAClD,QAAI,QAAQ,OAAO,KAAK;AACxB,QAAI,MAAM,KAAK,KAAK;AACpB,QAAI,WAAW,CAAC;AAChB,aAAS,IAAI,GAAG,IAAI,IAAI,QAAQ,KAAK;AACnC,eAAS,KAAK,QAAQ,SAAS,IAAI,CAAC,CAAC,CAAC;AAAA,IACxC;AACA,aAAS,kBAAkB,QAAQ,GAAG,OAAO,KAAK;AAAA,EACpD;AACF;AA/BS;AAiGT,SAAS,cAIP,SACA,UACA,UAMA,cACM;AACN,MAAI,gBAAgB;AACpB;AAAA,IACE;AAAA,IACA;AAAA,IACA,SAAU,SAAS,cAAc,cAAc;AAC7C,UAAI,iBAAiB,KAAK,iBAAiB;AACzC,wBAAgB;AAAA;AAEhB,wBAAgB;AAAA,UACd;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,IACJ;AAAA,EACF;AACA,SAAO;AACT;AA/BS;AAkDT,SAAS,WACP,SACA,UACA;AACA,MAAI,OAAiC,CAAC;AAEtC,cAAY,SAAS,SAAU,SAAS,GAAG;AACzC,QAAI,aAAa,QAAQ,cAAc,CAAC;AACxC,QAAI,OAAO,UAAU,eAAe,KAAK,YAAY,OAAO,QAAQ,CAAC,GAAG;AACtE,UAAI,QAAQ,WAAW,QAAQ;AAC/B,UAAI,OAAO,UAAU,eAAe,KAAK,MAAM,KAAK;AAClD,aAAK,KAAK,EAAE,KAAK,CAAC;AAAA;AACf,aAAK,KAAK,IAAI,CAAC,CAAC;AAAA,IACvB;AAAA,EACF,CAAC;AACD,SAAO;AACT;AAhBS;AA0BT,SAAS,YAAY,YAAiB,QAAa;AACjD,MAAI,eAAe;AAAW,WAAO;AACrC,MAAI,aAAa,OAAO;AAGxB,MAAI,eAAe,YAAY,eAAe;AAC5C,WAAO,OAAO,UAAU,eAAe,KAAK,YAAY,MAAM;AAAA,WAEvD,MAAM,QAAQ,MAAM,GAAG;AAC9B,aAAS,IAAI,GAAG,IAAI,OAAO,QAAQ,KAAK;AACtC,UAAI,CAAC,YAAY,YAAY,OAAO,CAAC,CAAC;AAAG,eAAO;AAAA,IAClD;AACA,WAAO;AAAA,EAET,OAAO;AACL,WAAO,yBAAyB,YAAY,MAAM;AAAA,EACpD;AACF;AAjBS;AAgCT,SAAS,yBAAyB,YAAiB,QAAsB;AACvE,MAAI,OAAO,OAAO,KAAK,MAAM;AAC7B,WAAS,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK;AACpC,QAAI,MAAM,KAAK,CAAC;AAChB,QAAI,WAAW,GAAG,MAAM,OAAO,GAAG;AAAG,aAAO;AAAA,EAC9C;AACA,SAAO;AACT;AAPS;AAoBT,SAAS,iBACP,YACA,MACK;AACL,MAAI,CAAC;AAAM,WAAO,CAAC;AACnB,MAAI,CAAC,KAAK;AAAQ,WAAO,CAAC;AAE1B,MAAI,gBAAqC,CAAC;AAC1C,WAAS,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK;AACpC,QAAI,MAAM,KAAK,CAAC;AAChB,QAAI,OAAO,UAAU,eAAe,KAAK,YAAY,GAAG;AACtD,oBAAc,GAAG,IAAI,WAAW,GAAG;AAAA,EACvC;AACA,SAAO;AACT;AAdS","sourcesContent":["import {\n  Feature,\n  FeatureCollection,\n  GeoJsonProperties,\n  GeometryObject,\n} from \"geojson\";\nimport { featureEach } from \"@turf/meta\";\nimport { featureCollection } from \"@turf/helpers\";\n\n/**\n * Get Cluster\n *\n * @name getCluster\n * @param {FeatureCollection} geojson GeoJSON Features\n * @param {*} filter Filter used on GeoJSON properties to get Cluster\n * @returns {FeatureCollection} Single Cluster filtered by GeoJSON Properties\n * @example\n * var geojson = turf.featureCollection([\n *     turf.point([0, 0], {'marker-symbol': 'circle'}),\n *     turf.point([2, 4], {'marker-symbol': 'star'}),\n *     turf.point([3, 6], {'marker-symbol': 'star'}),\n *     turf.point([5, 1], {'marker-symbol': 'square'}),\n *     turf.point([4, 2], {'marker-symbol': 'circle'})\n * ]);\n *\n * // Create a cluster using K-Means (adds `cluster` to GeoJSON properties)\n * var clustered = turf.clustersKmeans(geojson);\n *\n * // Retrieve first cluster (0)\n * var cluster = turf.getCluster(clustered, {cluster: 0});\n * //= cluster\n *\n * // Retrieve cluster based on custom properties\n * turf.getCluster(clustered, {'marker-symbol': 'circle'}).length;\n * //= 2\n * turf.getCluster(clustered, {'marker-symbol': 'square'}).length;\n * //= 1\n */\nfunction getCluster<\n  G extends GeometryObject,\n  P extends GeoJsonProperties = GeoJsonProperties,\n>(geojson: FeatureCollection<G, P>, filter: any): FeatureCollection<G, P> {\n  // Validation\n  if (!geojson) throw new Error(\"geojson is required\");\n  if (geojson.type !== \"FeatureCollection\")\n    throw new Error(\"geojson must be a FeatureCollection\");\n  if (filter === undefined || filter === null)\n    throw new Error(\"filter is required\");\n\n  // Filter Features\n  var features: Feature<G, P>[] = [];\n  featureEach<G, P>(geojson, function (feature) {\n    if (applyFilter(feature.properties, filter)) features.push(feature);\n  });\n  return featureCollection(features);\n}\n\n/**\n * Callback for clusterEach\n *\n * @callback clusterEachCallback\n * @param {FeatureCollection} [cluster] The current cluster being processed.\n * @param {*} [clusterValue] Value used to create cluster being processed.\n * @param {number} [currentIndex] The index of the current element being processed in the array.Starts at index 0\n * @returns {void}\n */\n\n/**\n * clusterEach\n *\n * @name clusterEach\n * @param {FeatureCollection} geojson GeoJSON Features\n * @param {string|number} property GeoJSON property key/value used to create clusters\n * @param {Function} callback a method that takes (cluster, clusterValue, currentIndex)\n * @returns {void}\n * @example\n * var geojson = turf.featureCollection([\n *     turf.point([0, 0]),\n *     turf.point([2, 4]),\n *     turf.point([3, 6]),\n *     turf.point([5, 1]),\n *     turf.point([4, 2])\n * ]);\n *\n * // Create a cluster using K-Means (adds `cluster` to GeoJSON properties)\n * var clustered = turf.clustersKmeans(geojson);\n *\n * // Iterate over each cluster\n * turf.clusterEach(clustered, 'cluster', function (cluster, clusterValue, currentIndex) {\n *     //= cluster\n *     //= clusterValue\n *     //= currentIndex\n * })\n *\n * // Calculate the total number of clusters\n * var total = 0\n * turf.clusterEach(clustered, 'cluster', function () {\n *     total++;\n * });\n *\n * // Create an Array of all the values retrieved from the 'cluster' property\n * var values = []\n * turf.clusterEach(clustered, 'cluster', function (cluster, clusterValue) {\n *     values.push(clusterValue);\n * });\n */\nfunction clusterEach<\n  G extends GeometryObject,\n  P extends GeoJsonProperties = GeoJsonProperties,\n>(\n  geojson: FeatureCollection<G, P>,\n  property: number | string,\n  callback: (\n    cluster: FeatureCollection<G, P>,\n    clusterValue?: any,\n    currentIndex?: number\n  ) => void\n): void {\n  // Validation\n  if (!geojson) throw new Error(\"geojson is required\");\n  if (geojson.type !== \"FeatureCollection\")\n    throw new Error(\"geojson must be a FeatureCollection\");\n  if (property === undefined || property === null)\n    throw new Error(\"property is required\");\n\n  // Create clusters based on property values\n  var bins = createBins(geojson, property);\n  var values = Object.keys(bins);\n  for (var index = 0; index < values.length; index++) {\n    var value = values[index];\n    var bin = bins[value];\n    var features = [];\n    for (var i = 0; i < bin.length; i++) {\n      features.push(geojson.features[bin[i]]);\n    }\n    callback(featureCollection(features), value, index);\n  }\n}\n\n/**\n * Callback for clusterReduce\n *\n * The first time the callback function is called, the values provided as arguments depend\n * on whether the reduce method has an initialValue argument.\n *\n * If an initialValue is provided to the reduce method:\n *  - The previousValue argument is initialValue.\n *  - The currentValue argument is the value of the first element present in the array.\n *\n * If an initialValue is not provided:\n *  - The previousValue argument is the value of the first element present in the array.\n *  - The currentValue argument is the value of the second element present in the array.\n *\n * @callback clusterReduceCallback\n * @param {*} [previousValue] The accumulated value previously returned in the last invocation\n * of the callback, or initialValue, if supplied.\n * @param {FeatureCollection} [cluster] The current cluster being processed.\n * @param {*} [clusterValue] Value used to create cluster being processed.\n * @param {number} [currentIndex] The index of the current element being processed in the\n * array. Starts at index 0, if an initialValue is provided, and at index 1 otherwise.\n */\n\n/**\n * Reduce clusters in GeoJSON Features, similar to Array.reduce()\n *\n * @name clusterReduce\n * @param {FeatureCollection} geojson GeoJSON Features\n * @param {string|number} property GeoJSON property key/value used to create clusters\n * @param {Function} callback a method that takes (previousValue, cluster, clusterValue, currentIndex)\n * @param {*} [initialValue] Value to use as the first argument to the first call of the callback.\n * @returns {*} The value that results from the reduction.\n * @example\n * var geojson = turf.featureCollection([\n *     turf.point([0, 0]),\n *     turf.point([2, 4]),\n *     turf.point([3, 6]),\n *     turf.point([5, 1]),\n *     turf.point([4, 2])\n * ]);\n *\n * // Create a cluster using K-Means (adds `cluster` to GeoJSON properties)\n * var clustered = turf.clustersKmeans(geojson);\n *\n * // Iterate over each cluster and perform a calculation\n * var initialValue = 0\n * turf.clusterReduce(clustered, 'cluster', function (previousValue, cluster, clusterValue, currentIndex) {\n *     //=previousValue\n *     //=cluster\n *     //=clusterValue\n *     //=currentIndex\n *     return previousValue++;\n * }, initialValue);\n *\n * // Calculate the total number of clusters\n * var total = turf.clusterReduce(clustered, 'cluster', function (previousValue) {\n *     return previousValue++;\n * }, 0);\n *\n * // Create an Array of all the values retrieved from the 'cluster' property\n * var values = turf.clusterReduce(clustered, 'cluster', function (previousValue, cluster, clusterValue) {\n *     return previousValue.concat(clusterValue);\n * }, []);\n */\nfunction clusterReduce<\n  G extends GeometryObject,\n  P extends GeoJsonProperties = GeoJsonProperties,\n>(\n  geojson: FeatureCollection<G, P>,\n  property: number | string,\n  callback: (\n    previousValue: any | undefined,\n    cluster: FeatureCollection<G, P>,\n    clusterValue?: any,\n    currentIndex?: number\n  ) => void,\n  initialValue?: any\n): void {\n  var previousValue = initialValue;\n  clusterEach(\n    geojson,\n    property,\n    function (cluster, clusterValue, currentIndex) {\n      if (currentIndex === 0 && initialValue === undefined)\n        previousValue = cluster;\n      else\n        previousValue = callback(\n          previousValue,\n          cluster,\n          clusterValue,\n          currentIndex\n        );\n    }\n  );\n  return previousValue;\n}\n\n/**\n * Create Bins\n *\n * @private\n * @param {FeatureCollection} geojson GeoJSON Features\n * @param {string|number} property Property values are used to create bins\n * @returns {Object} bins with Feature IDs\n * @example\n * var geojson = turf.featureCollection([\n *     turf.point([0, 0], {cluster: 0, foo: 'null'}),\n *     turf.point([2, 4], {cluster: 1, foo: 'bar'}),\n *     turf.point([5, 1], {0: 'foo'}),\n *     turf.point([3, 6], {cluster: 1}),\n * ]);\n * createBins(geojson, 'cluster');\n * //= { '0': [ 0 ], '1': [ 1, 3 ] }\n */\nfunction createBins(\n  geojson: FeatureCollection<any>,\n  property: string | number\n) {\n  var bins: Record<string, number[]> = {};\n\n  featureEach(geojson, function (feature, i) {\n    var properties = feature.properties || {};\n    if (Object.prototype.hasOwnProperty.call(properties, String(property))) {\n      var value = properties[property];\n      if (Object.prototype.hasOwnProperty.call(bins, value))\n        bins[value].push(i);\n      else bins[value] = [i];\n    }\n  });\n  return bins;\n}\n\n/**\n * Apply Filter\n *\n * @private\n * @param {*} properties Properties\n * @param {*} filter Filter\n * @returns {boolean} applied Filter to properties\n */\nfunction applyFilter(properties: any, filter: any) {\n  if (properties === undefined) return false;\n  var filterType = typeof filter;\n\n  // String & Number\n  if (filterType === \"number\" || filterType === \"string\")\n    return Object.prototype.hasOwnProperty.call(properties, filter);\n  // Array\n  else if (Array.isArray(filter)) {\n    for (var i = 0; i < filter.length; i++) {\n      if (!applyFilter(properties, filter[i])) return false;\n    }\n    return true;\n    // Object\n  } else {\n    return propertiesContainsFilter(properties, filter);\n  }\n}\n\n/**\n * Properties contains filter (does not apply deepEqual operations)\n *\n * @private\n * @param {*} properties Properties\n * @param {Object} filter Filter\n * @returns {boolean} does filter equal Properties\n * @example\n * propertiesContainsFilter({foo: 'bar', cluster: 0}, {cluster: 0})\n * //= true\n * propertiesContainsFilter({foo: 'bar', cluster: 0}, {cluster: 1})\n * //= false\n */\nfunction propertiesContainsFilter(properties: any, filter: any): boolean {\n  var keys = Object.keys(filter);\n  for (var i = 0; i < keys.length; i++) {\n    var key = keys[i];\n    if (properties[key] !== filter[key]) return false;\n  }\n  return true;\n}\n\n/**\n * Filter Properties\n *\n * @private\n * @param {*} properties Properties\n * @param {Array<string>} keys Used to filter Properties\n * @returns {*} filtered Properties\n * @example\n * filterProperties({foo: 'bar', cluster: 0}, ['cluster'])\n * //= {cluster: 0}\n */\nfunction filterProperties(\n  properties: Record<string, any>,\n  keys: string[]\n): any {\n  if (!keys) return {};\n  if (!keys.length) return {};\n\n  var newProperties: Record<string, any> = {};\n  for (var i = 0; i < keys.length; i++) {\n    var key = keys[i];\n    if (Object.prototype.hasOwnProperty.call(properties, key))\n      newProperties[key] = properties[key];\n  }\n  return newProperties;\n}\n\nexport {\n  getCluster,\n  clusterEach,\n  clusterReduce,\n  createBins,\n  applyFilter,\n  propertiesContainsFilter,\n  filterProperties,\n};\n// No default export!\n"]}

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

@@ -1,5 +1,5 @@
-import { featureEach } from "@turf/meta";
-import { featureCollection } from "@turf/helpers";
+import { GeometryObject, GeoJsonProperties, FeatureCollection } from 'geojson';
+
 /**
  * Get Cluster
  *
@@ -29,22 +29,7 @@ import { featureCollection } from "@turf/helpers";
  * turf.getCluster(clustered, {'marker-symbol': 'square'}).length;
  * //= 1
  */
-export function getCluster(geojson, filter) {
-    // Validation
-    if (!geojson)
-        throw new Error("geojson is required");
-    if (geojson.type !== "FeatureCollection")
-        throw new Error("geojson must be a FeatureCollection");
-    if (filter === undefined || filter === null)
-        throw new Error("filter is required");
-    // Filter Features
-    var features = [];
-    featureEach(geojson, function (feature) {
-        if (applyFilter(feature.properties, filter))
-            features.push(feature);
-    });
-    return featureCollection(features);
-}
+declare function getCluster<G extends GeometryObject, P extends GeoJsonProperties = GeoJsonProperties>(geojson: FeatureCollection<G, P>, filter: any): FeatureCollection<G, P>;
 /**
  * Callback for clusterEach
  *
@@ -93,27 +78,7 @@ export function getCluster(geojson, filter) {
  *     values.push(clusterValue);
  * });
  */
-export function clusterEach(geojson, property, callback) {
-    // Validation
-    if (!geojson)
-        throw new Error("geojson is required");
-    if (geojson.type !== "FeatureCollection")
-        throw new Error("geojson must be a FeatureCollection");
-    if (property === undefined || property === null)
-        throw new Error("property is required");
-    // Create clusters based on property values
-    var bins = createBins(geojson, property);
-    var values = Object.keys(bins);
-    for (var index = 0; index < values.length; index++) {
-        var value = values[index];
-        var bin = bins[value];
-        var features = [];
-        for (var i = 0; i < bin.length; i++) {
-            features.push(geojson.features[bin[i]]);
-        }
-        callback(featureCollection(features), value, index);
-    }
-}
+declare function clusterEach<G extends GeometryObject, P extends GeoJsonProperties = GeoJsonProperties>(geojson: FeatureCollection<G, P>, property: number | string, callback: (cluster: FeatureCollection<G, P>, clusterValue?: any, currentIndex?: number) => void): void;
 /**
  * Callback for clusterReduce
  *
@@ -177,16 +142,7 @@ export function clusterEach(geojson, property, callback) {
  *     return previousValue.concat(clusterValue);
  * }, []);
  */
-export function clusterReduce(geojson, property, callback, initialValue) {
-    var previousValue = initialValue;
-    clusterEach(geojson, property, function (cluster, clusterValue, currentIndex) {
-        if (currentIndex === 0 && initialValue === undefined)
-            previousValue = cluster;
-        else
-            previousValue = callback(previousValue, cluster, clusterValue, currentIndex);
-    });
-    return previousValue;
-}
+declare function clusterReduce<G extends GeometryObject, P extends GeoJsonProperties = GeoJsonProperties>(geojson: FeatureCollection<G, P>, property: number | string, callback: (previousValue: any | undefined, cluster: FeatureCollection<G, P>, clusterValue?: any, currentIndex?: number) => void, initialValue?: any): void;
 /**
  * Create Bins
  *
@@ -204,20 +160,7 @@ export function clusterReduce(geojson, property, callback, initialValue) {
  * createBins(geojson, 'cluster');
  * //= { '0': [ 0 ], '1': [ 1, 3 ] }
  */
-export function createBins(geojson, property) {
-    var bins = {};
-    featureEach(geojson, function (feature, i) {
-        var properties = feature.properties || {};
-        if (Object.prototype.hasOwnProperty.call(properties, String(property))) {
-            var value = properties[property];
-            if (Object.prototype.hasOwnProperty.call(bins, value))
-                bins[value].push(i);
-            else
-                bins[value] = [i];
-        }
-    });
-    return bins;
-}
+declare function createBins(geojson: FeatureCollection<any>, property: string | number): Record<string, number[]>;
 /**
  * Apply Filter
  *
@@ -226,26 +169,7 @@ export function createBins(geojson, property) {
  * @param {*} filter Filter
  * @returns {boolean} applied Filter to properties
  */
-export function applyFilter(properties, filter) {
-    if (properties === undefined)
-        return false;
-    var filterType = typeof filter;
-    // String & Number
-    if (filterType === "number" || filterType === "string")
-        return Object.prototype.hasOwnProperty.call(properties, filter);
-    // Array
-    else if (Array.isArray(filter)) {
-        for (var i = 0; i < filter.length; i++) {
-            if (!applyFilter(properties, filter[i]))
-                return false;
-        }
-        return true;
-        // Object
-    }
-    else {
-        return propertiesContainsFilter(properties, filter);
-    }
-}
+declare function applyFilter(properties: any, filter: any): boolean;
 /**
  * Properties contains filter (does not apply deepEqual operations)
  *
@@ -259,15 +183,7 @@ export function applyFilter(properties, filter) {
  * propertiesContainsFilter({foo: 'bar', cluster: 0}, {cluster: 1})
  * //= false
  */
-export function propertiesContainsFilter(properties, filter) {
-    var keys = Object.keys(filter);
-    for (var i = 0; i < keys.length; i++) {
-        var key = keys[i];
-        if (properties[key] !== filter[key])
-            return false;
-    }
-    return true;
-}
+declare function propertiesContainsFilter(properties: any, filter: any): boolean;
 /**
  * Filter Properties
  *
@@ -279,16 +195,6 @@ export function propertiesContainsFilter(properties, filter) {
  * filterProperties({foo: 'bar', cluster: 0}, ['cluster'])
  * //= {cluster: 0}
  */
-export function filterProperties(properties, keys) {
-    if (!keys)
-        return {};
-    if (!keys.length)
-        return {};
-    var newProperties = {};
-    for (var i = 0; i < keys.length; i++) {
-        var key = keys[i];
-        if (Object.prototype.hasOwnProperty.call(properties, key))
-            newProperties[key] = properties[key];
-    }
-    return newProperties;
-}
+declare function filterProperties(properties: Record<string, any>, keys: string[]): any;
+
+export { applyFilter, clusterEach, clusterReduce, createBins, filterProperties, getCluster, propertiesContainsFilter };

package/dist/{js → esm}/index.d.ts

@@ -1,4 +1,5 @@
-import { FeatureCollection, GeometryObject } from "geojson";
+import { GeometryObject, GeoJsonProperties, FeatureCollection } from 'geojson';
+
 /**
  * Get Cluster
  *
@@ -28,7 +29,7 @@ import { FeatureCollection, GeometryObject } from "geojson";
  * turf.getCluster(clustered, {'marker-symbol': 'square'}).length;
  * //= 1
  */
-export declare function getCluster<G extends GeometryObject, P = any>(geojson: FeatureCollection<G, P>, filter: any): FeatureCollection<G, P>;
+declare function getCluster<G extends GeometryObject, P extends GeoJsonProperties = GeoJsonProperties>(geojson: FeatureCollection<G, P>, filter: any): FeatureCollection<G, P>;
 /**
  * Callback for clusterEach
  *
@@ -77,7 +78,7 @@ export declare function getCluster<G extends GeometryObject, P = any>(geojson: F
  *     values.push(clusterValue);
  * });
  */
-export declare function clusterEach<G extends GeometryObject, P = any>(geojson: FeatureCollection<G, P>, property: number | string, callback: (cluster: FeatureCollection<G, P>, clusterValue?: any, currentIndex?: number) => void): void;
+declare function clusterEach<G extends GeometryObject, P extends GeoJsonProperties = GeoJsonProperties>(geojson: FeatureCollection<G, P>, property: number | string, callback: (cluster: FeatureCollection<G, P>, clusterValue?: any, currentIndex?: number) => void): void;
 /**
  * Callback for clusterReduce
  *
@@ -141,7 +142,7 @@ export declare function clusterEach<G extends GeometryObject, P = any>(geojson:
  *     return previousValue.concat(clusterValue);
  * }, []);
  */
-export declare function clusterReduce<G extends GeometryObject, P = any>(geojson: FeatureCollection<G, P>, property: number | string, callback: (previousValue: any | undefined, cluster: FeatureCollection<G, P>, clusterValue?: any, currentIndex?: number) => void, initialValue?: any): void;
+declare function clusterReduce<G extends GeometryObject, P extends GeoJsonProperties = GeoJsonProperties>(geojson: FeatureCollection<G, P>, property: number | string, callback: (previousValue: any | undefined, cluster: FeatureCollection<G, P>, clusterValue?: any, currentIndex?: number) => void, initialValue?: any): void;
 /**
  * Create Bins
  *
@@ -159,7 +160,7 @@ export declare function clusterReduce<G extends GeometryObject, P = any>(geojson
  * createBins(geojson, 'cluster');
  * //= { '0': [ 0 ], '1': [ 1, 3 ] }
  */
-export declare function createBins(geojson: FeatureCollection<any>, property: string | number): Record<string, number[]>;
+declare function createBins(geojson: FeatureCollection<any>, property: string | number): Record<string, number[]>;
 /**
  * Apply Filter
  *
@@ -168,7 +169,7 @@ export declare function createBins(geojson: FeatureCollection<any>, property: st
  * @param {*} filter Filter
  * @returns {boolean} applied Filter to properties
  */
-export declare function applyFilter(properties: any, filter: any): boolean;
+declare function applyFilter(properties: any, filter: any): boolean;
 /**
  * Properties contains filter (does not apply deepEqual operations)
  *
@@ -182,7 +183,7 @@ export declare function applyFilter(properties: any, filter: any): boolean;
  * propertiesContainsFilter({foo: 'bar', cluster: 0}, {cluster: 1})
  * //= false
  */
-export declare function propertiesContainsFilter(properties: any, filter: any): boolean;
+declare function propertiesContainsFilter(properties: any, filter: any): boolean;
 /**
  * Filter Properties
  *
@@ -194,4 +195,6 @@ export declare function propertiesContainsFilter(properties: any, filter: any):
  * filterProperties({foo: 'bar', cluster: 0}, ['cluster'])
  * //= {cluster: 0}
  */
-export declare function filterProperties(properties: Record<string, any>, keys: string[]): any;
+declare function filterProperties(properties: Record<string, any>, keys: string[]): any;
+
+export { applyFilter, clusterEach, clusterReduce, createBins, filterProperties, getCluster, propertiesContainsFilter };

package/dist/esm/index.js

@@ -0,0 +1,127 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+import { featureEach } from "@turf/meta";
+import { featureCollection } from "@turf/helpers";
+function getCluster(geojson, filter) {
+  if (!geojson)
+    throw new Error("geojson is required");
+  if (geojson.type !== "FeatureCollection")
+    throw new Error("geojson must be a FeatureCollection");
+  if (filter === void 0 || filter === null)
+    throw new Error("filter is required");
+  var features = [];
+  featureEach(geojson, function(feature) {
+    if (applyFilter(feature.properties, filter))
+      features.push(feature);
+  });
+  return featureCollection(features);
+}
+__name(getCluster, "getCluster");
+function clusterEach(geojson, property, callback) {
+  if (!geojson)
+    throw new Error("geojson is required");
+  if (geojson.type !== "FeatureCollection")
+    throw new Error("geojson must be a FeatureCollection");
+  if (property === void 0 || property === null)
+    throw new Error("property is required");
+  var bins = createBins(geojson, property);
+  var values = Object.keys(bins);
+  for (var index = 0; index < values.length; index++) {
+    var value = values[index];
+    var bin = bins[value];
+    var features = [];
+    for (var i = 0; i < bin.length; i++) {
+      features.push(geojson.features[bin[i]]);
+    }
+    callback(featureCollection(features), value, index);
+  }
+}
+__name(clusterEach, "clusterEach");
+function clusterReduce(geojson, property, callback, initialValue) {
+  var previousValue = initialValue;
+  clusterEach(
+    geojson,
+    property,
+    function(cluster, clusterValue, currentIndex) {
+      if (currentIndex === 0 && initialValue === void 0)
+        previousValue = cluster;
+      else
+        previousValue = callback(
+          previousValue,
+          cluster,
+          clusterValue,
+          currentIndex
+        );
+    }
+  );
+  return previousValue;
+}
+__name(clusterReduce, "clusterReduce");
+function createBins(geojson, property) {
+  var bins = {};
+  featureEach(geojson, function(feature, i) {
+    var properties = feature.properties || {};
+    if (Object.prototype.hasOwnProperty.call(properties, String(property))) {
+      var value = properties[property];
+      if (Object.prototype.hasOwnProperty.call(bins, value))
+        bins[value].push(i);
+      else
+        bins[value] = [i];
+    }
+  });
+  return bins;
+}
+__name(createBins, "createBins");
+function applyFilter(properties, filter) {
+  if (properties === void 0)
+    return false;
+  var filterType = typeof filter;
+  if (filterType === "number" || filterType === "string")
+    return Object.prototype.hasOwnProperty.call(properties, filter);
+  else if (Array.isArray(filter)) {
+    for (var i = 0; i < filter.length; i++) {
+      if (!applyFilter(properties, filter[i]))
+        return false;
+    }
+    return true;
+  } else {
+    return propertiesContainsFilter(properties, filter);
+  }
+}
+__name(applyFilter, "applyFilter");
+function propertiesContainsFilter(properties, filter) {
+  var keys = Object.keys(filter);
+  for (var i = 0; i < keys.length; i++) {
+    var key = keys[i];
+    if (properties[key] !== filter[key])
+      return false;
+  }
+  return true;
+}
+__name(propertiesContainsFilter, "propertiesContainsFilter");
+function filterProperties(properties, keys) {
+  if (!keys)
+    return {};
+  if (!keys.length)
+    return {};
+  var newProperties = {};
+  for (var i = 0; i < keys.length; i++) {
+    var key = keys[i];
+    if (Object.prototype.hasOwnProperty.call(properties, key))
+      newProperties[key] = properties[key];
+  }
+  return newProperties;
+}
+__name(filterProperties, "filterProperties");
+export {
+  applyFilter,
+  clusterEach,
+  clusterReduce,
+  createBins,
+  filterProperties,
+  getCluster,
+  propertiesContainsFilter
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["import {\n  Feature,\n  FeatureCollection,\n  GeoJsonProperties,\n  GeometryObject,\n} from \"geojson\";\nimport { featureEach } from \"@turf/meta\";\nimport { featureCollection } from \"@turf/helpers\";\n\n/**\n * Get Cluster\n *\n * @name getCluster\n * @param {FeatureCollection} geojson GeoJSON Features\n * @param {*} filter Filter used on GeoJSON properties to get Cluster\n * @returns {FeatureCollection} Single Cluster filtered by GeoJSON Properties\n * @example\n * var geojson = turf.featureCollection([\n *     turf.point([0, 0], {'marker-symbol': 'circle'}),\n *     turf.point([2, 4], {'marker-symbol': 'star'}),\n *     turf.point([3, 6], {'marker-symbol': 'star'}),\n *     turf.point([5, 1], {'marker-symbol': 'square'}),\n *     turf.point([4, 2], {'marker-symbol': 'circle'})\n * ]);\n *\n * // Create a cluster using K-Means (adds `cluster` to GeoJSON properties)\n * var clustered = turf.clustersKmeans(geojson);\n *\n * // Retrieve first cluster (0)\n * var cluster = turf.getCluster(clustered, {cluster: 0});\n * //= cluster\n *\n * // Retrieve cluster based on custom properties\n * turf.getCluster(clustered, {'marker-symbol': 'circle'}).length;\n * //= 2\n * turf.getCluster(clustered, {'marker-symbol': 'square'}).length;\n * //= 1\n */\nfunction getCluster<\n  G extends GeometryObject,\n  P extends GeoJsonProperties = GeoJsonProperties,\n>(geojson: FeatureCollection<G, P>, filter: any): FeatureCollection<G, P> {\n  // Validation\n  if (!geojson) throw new Error(\"geojson is required\");\n  if (geojson.type !== \"FeatureCollection\")\n    throw new Error(\"geojson must be a FeatureCollection\");\n  if (filter === undefined || filter === null)\n    throw new Error(\"filter is required\");\n\n  // Filter Features\n  var features: Feature<G, P>[] = [];\n  featureEach<G, P>(geojson, function (feature) {\n    if (applyFilter(feature.properties, filter)) features.push(feature);\n  });\n  return featureCollection(features);\n}\n\n/**\n * Callback for clusterEach\n *\n * @callback clusterEachCallback\n * @param {FeatureCollection} [cluster] The current cluster being processed.\n * @param {*} [clusterValue] Value used to create cluster being processed.\n * @param {number} [currentIndex] The index of the current element being processed in the array.Starts at index 0\n * @returns {void}\n */\n\n/**\n * clusterEach\n *\n * @name clusterEach\n * @param {FeatureCollection} geojson GeoJSON Features\n * @param {string|number} property GeoJSON property key/value used to create clusters\n * @param {Function} callback a method that takes (cluster, clusterValue, currentIndex)\n * @returns {void}\n * @example\n * var geojson = turf.featureCollection([\n *     turf.point([0, 0]),\n *     turf.point([2, 4]),\n *     turf.point([3, 6]),\n *     turf.point([5, 1]),\n *     turf.point([4, 2])\n * ]);\n *\n * // Create a cluster using K-Means (adds `cluster` to GeoJSON properties)\n * var clustered = turf.clustersKmeans(geojson);\n *\n * // Iterate over each cluster\n * turf.clusterEach(clustered, 'cluster', function (cluster, clusterValue, currentIndex) {\n *     //= cluster\n *     //= clusterValue\n *     //= currentIndex\n * })\n *\n * // Calculate the total number of clusters\n * var total = 0\n * turf.clusterEach(clustered, 'cluster', function () {\n *     total++;\n * });\n *\n * // Create an Array of all the values retrieved from the 'cluster' property\n * var values = []\n * turf.clusterEach(clustered, 'cluster', function (cluster, clusterValue) {\n *     values.push(clusterValue);\n * });\n */\nfunction clusterEach<\n  G extends GeometryObject,\n  P extends GeoJsonProperties = GeoJsonProperties,\n>(\n  geojson: FeatureCollection<G, P>,\n  property: number | string,\n  callback: (\n    cluster: FeatureCollection<G, P>,\n    clusterValue?: any,\n    currentIndex?: number\n  ) => void\n): void {\n  // Validation\n  if (!geojson) throw new Error(\"geojson is required\");\n  if (geojson.type !== \"FeatureCollection\")\n    throw new Error(\"geojson must be a FeatureCollection\");\n  if (property === undefined || property === null)\n    throw new Error(\"property is required\");\n\n  // Create clusters based on property values\n  var bins = createBins(geojson, property);\n  var values = Object.keys(bins);\n  for (var index = 0; index < values.length; index++) {\n    var value = values[index];\n    var bin = bins[value];\n    var features = [];\n    for (var i = 0; i < bin.length; i++) {\n      features.push(geojson.features[bin[i]]);\n    }\n    callback(featureCollection(features), value, index);\n  }\n}\n\n/**\n * Callback for clusterReduce\n *\n * The first time the callback function is called, the values provided as arguments depend\n * on whether the reduce method has an initialValue argument.\n *\n * If an initialValue is provided to the reduce method:\n *  - The previousValue argument is initialValue.\n *  - The currentValue argument is the value of the first element present in the array.\n *\n * If an initialValue is not provided:\n *  - The previousValue argument is the value of the first element present in the array.\n *  - The currentValue argument is the value of the second element present in the array.\n *\n * @callback clusterReduceCallback\n * @param {*} [previousValue] The accumulated value previously returned in the last invocation\n * of the callback, or initialValue, if supplied.\n * @param {FeatureCollection} [cluster] The current cluster being processed.\n * @param {*} [clusterValue] Value used to create cluster being processed.\n * @param {number} [currentIndex] The index of the current element being processed in the\n * array. Starts at index 0, if an initialValue is provided, and at index 1 otherwise.\n */\n\n/**\n * Reduce clusters in GeoJSON Features, similar to Array.reduce()\n *\n * @name clusterReduce\n * @param {FeatureCollection} geojson GeoJSON Features\n * @param {string|number} property GeoJSON property key/value used to create clusters\n * @param {Function} callback a method that takes (previousValue, cluster, clusterValue, currentIndex)\n * @param {*} [initialValue] Value to use as the first argument to the first call of the callback.\n * @returns {*} The value that results from the reduction.\n * @example\n * var geojson = turf.featureCollection([\n *     turf.point([0, 0]),\n *     turf.point([2, 4]),\n *     turf.point([3, 6]),\n *     turf.point([5, 1]),\n *     turf.point([4, 2])\n * ]);\n *\n * // Create a cluster using K-Means (adds `cluster` to GeoJSON properties)\n * var clustered = turf.clustersKmeans(geojson);\n *\n * // Iterate over each cluster and perform a calculation\n * var initialValue = 0\n * turf.clusterReduce(clustered, 'cluster', function (previousValue, cluster, clusterValue, currentIndex) {\n *     //=previousValue\n *     //=cluster\n *     //=clusterValue\n *     //=currentIndex\n *     return previousValue++;\n * }, initialValue);\n *\n * // Calculate the total number of clusters\n * var total = turf.clusterReduce(clustered, 'cluster', function (previousValue) {\n *     return previousValue++;\n * }, 0);\n *\n * // Create an Array of all the values retrieved from the 'cluster' property\n * var values = turf.clusterReduce(clustered, 'cluster', function (previousValue, cluster, clusterValue) {\n *     return previousValue.concat(clusterValue);\n * }, []);\n */\nfunction clusterReduce<\n  G extends GeometryObject,\n  P extends GeoJsonProperties = GeoJsonProperties,\n>(\n  geojson: FeatureCollection<G, P>,\n  property: number | string,\n  callback: (\n    previousValue: any | undefined,\n    cluster: FeatureCollection<G, P>,\n    clusterValue?: any,\n    currentIndex?: number\n  ) => void,\n  initialValue?: any\n): void {\n  var previousValue = initialValue;\n  clusterEach(\n    geojson,\n    property,\n    function (cluster, clusterValue, currentIndex) {\n      if (currentIndex === 0 && initialValue === undefined)\n        previousValue = cluster;\n      else\n        previousValue = callback(\n          previousValue,\n          cluster,\n          clusterValue,\n          currentIndex\n        );\n    }\n  );\n  return previousValue;\n}\n\n/**\n * Create Bins\n *\n * @private\n * @param {FeatureCollection} geojson GeoJSON Features\n * @param {string|number} property Property values are used to create bins\n * @returns {Object} bins with Feature IDs\n * @example\n * var geojson = turf.featureCollection([\n *     turf.point([0, 0], {cluster: 0, foo: 'null'}),\n *     turf.point([2, 4], {cluster: 1, foo: 'bar'}),\n *     turf.point([5, 1], {0: 'foo'}),\n *     turf.point([3, 6], {cluster: 1}),\n * ]);\n * createBins(geojson, 'cluster');\n * //= { '0': [ 0 ], '1': [ 1, 3 ] }\n */\nfunction createBins(\n  geojson: FeatureCollection<any>,\n  property: string | number\n) {\n  var bins: Record<string, number[]> = {};\n\n  featureEach(geojson, function (feature, i) {\n    var properties = feature.properties || {};\n    if (Object.prototype.hasOwnProperty.call(properties, String(property))) {\n      var value = properties[property];\n      if (Object.prototype.hasOwnProperty.call(bins, value))\n        bins[value].push(i);\n      else bins[value] = [i];\n    }\n  });\n  return bins;\n}\n\n/**\n * Apply Filter\n *\n * @private\n * @param {*} properties Properties\n * @param {*} filter Filter\n * @returns {boolean} applied Filter to properties\n */\nfunction applyFilter(properties: any, filter: any) {\n  if (properties === undefined) return false;\n  var filterType = typeof filter;\n\n  // String & Number\n  if (filterType === \"number\" || filterType === \"string\")\n    return Object.prototype.hasOwnProperty.call(properties, filter);\n  // Array\n  else if (Array.isArray(filter)) {\n    for (var i = 0; i < filter.length; i++) {\n      if (!applyFilter(properties, filter[i])) return false;\n    }\n    return true;\n    // Object\n  } else {\n    return propertiesContainsFilter(properties, filter);\n  }\n}\n\n/**\n * Properties contains filter (does not apply deepEqual operations)\n *\n * @private\n * @param {*} properties Properties\n * @param {Object} filter Filter\n * @returns {boolean} does filter equal Properties\n * @example\n * propertiesContainsFilter({foo: 'bar', cluster: 0}, {cluster: 0})\n * //= true\n * propertiesContainsFilter({foo: 'bar', cluster: 0}, {cluster: 1})\n * //= false\n */\nfunction propertiesContainsFilter(properties: any, filter: any): boolean {\n  var keys = Object.keys(filter);\n  for (var i = 0; i < keys.length; i++) {\n    var key = keys[i];\n    if (properties[key] !== filter[key]) return false;\n  }\n  return true;\n}\n\n/**\n * Filter Properties\n *\n * @private\n * @param {*} properties Properties\n * @param {Array<string>} keys Used to filter Properties\n * @returns {*} filtered Properties\n * @example\n * filterProperties({foo: 'bar', cluster: 0}, ['cluster'])\n * //= {cluster: 0}\n */\nfunction filterProperties(\n  properties: Record<string, any>,\n  keys: string[]\n): any {\n  if (!keys) return {};\n  if (!keys.length) return {};\n\n  var newProperties: Record<string, any> = {};\n  for (var i = 0; i < keys.length; i++) {\n    var key = keys[i];\n    if (Object.prototype.hasOwnProperty.call(properties, key))\n      newProperties[key] = properties[key];\n  }\n  return newProperties;\n}\n\nexport {\n  getCluster,\n  clusterEach,\n  clusterReduce,\n  createBins,\n  applyFilter,\n  propertiesContainsFilter,\n  filterProperties,\n};\n// No default export!\n"],"mappings":";;;;AAMA,SAAS,mBAAmB;AAC5B,SAAS,yBAAyB;AA+BlC,SAAS,WAGP,SAAkC,QAAsC;AAExE,MAAI,CAAC;AAAS,UAAM,IAAI,MAAM,qBAAqB;AACnD,MAAI,QAAQ,SAAS;AACnB,UAAM,IAAI,MAAM,qCAAqC;AACvD,MAAI,WAAW,UAAa,WAAW;AACrC,UAAM,IAAI,MAAM,oBAAoB;AAGtC,MAAI,WAA4B,CAAC;AACjC,cAAkB,SAAS,SAAU,SAAS;AAC5C,QAAI,YAAY,QAAQ,YAAY,MAAM;AAAG,eAAS,KAAK,OAAO;AAAA,EACpE,CAAC;AACD,SAAO,kBAAkB,QAAQ;AACnC;AAjBS;AAoET,SAAS,YAIP,SACA,UACA,UAKM;AAEN,MAAI,CAAC;AAAS,UAAM,IAAI,MAAM,qBAAqB;AACnD,MAAI,QAAQ,SAAS;AACnB,UAAM,IAAI,MAAM,qCAAqC;AACvD,MAAI,aAAa,UAAa,aAAa;AACzC,UAAM,IAAI,MAAM,sBAAsB;AAGxC,MAAI,OAAO,WAAW,SAAS,QAAQ;AACvC,MAAI,SAAS,OAAO,KAAK,IAAI;AAC7B,WAAS,QAAQ,GAAG,QAAQ,OAAO,QAAQ,SAAS;AAClD,QAAI,QAAQ,OAAO,KAAK;AACxB,QAAI,MAAM,KAAK,KAAK;AACpB,QAAI,WAAW,CAAC;AAChB,aAAS,IAAI,GAAG,IAAI,IAAI,QAAQ,KAAK;AACnC,eAAS,KAAK,QAAQ,SAAS,IAAI,CAAC,CAAC,CAAC;AAAA,IACxC;AACA,aAAS,kBAAkB,QAAQ,GAAG,OAAO,KAAK;AAAA,EACpD;AACF;AA/BS;AAiGT,SAAS,cAIP,SACA,UACA,UAMA,cACM;AACN,MAAI,gBAAgB;AACpB;AAAA,IACE;AAAA,IACA;AAAA,IACA,SAAU,SAAS,cAAc,cAAc;AAC7C,UAAI,iBAAiB,KAAK,iBAAiB;AACzC,wBAAgB;AAAA;AAEhB,wBAAgB;AAAA,UACd;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,IACJ;AAAA,EACF;AACA,SAAO;AACT;AA/BS;AAkDT,SAAS,WACP,SACA,UACA;AACA,MAAI,OAAiC,CAAC;AAEtC,cAAY,SAAS,SAAU,SAAS,GAAG;AACzC,QAAI,aAAa,QAAQ,cAAc,CAAC;AACxC,QAAI,OAAO,UAAU,eAAe,KAAK,YAAY,OAAO,QAAQ,CAAC,GAAG;AACtE,UAAI,QAAQ,WAAW,QAAQ;AAC/B,UAAI,OAAO,UAAU,eAAe,KAAK,MAAM,KAAK;AAClD,aAAK,KAAK,EAAE,KAAK,CAAC;AAAA;AACf,aAAK,KAAK,IAAI,CAAC,CAAC;AAAA,IACvB;AAAA,EACF,CAAC;AACD,SAAO;AACT;AAhBS;AA0BT,SAAS,YAAY,YAAiB,QAAa;AACjD,MAAI,eAAe;AAAW,WAAO;AACrC,MAAI,aAAa,OAAO;AAGxB,MAAI,eAAe,YAAY,eAAe;AAC5C,WAAO,OAAO,UAAU,eAAe,KAAK,YAAY,MAAM;AAAA,WAEvD,MAAM,QAAQ,MAAM,GAAG;AAC9B,aAAS,IAAI,GAAG,IAAI,OAAO,QAAQ,KAAK;AACtC,UAAI,CAAC,YAAY,YAAY,OAAO,CAAC,CAAC;AAAG,eAAO;AAAA,IAClD;AACA,WAAO;AAAA,EAET,OAAO;AACL,WAAO,yBAAyB,YAAY,MAAM;AAAA,EACpD;AACF;AAjBS;AAgCT,SAAS,yBAAyB,YAAiB,QAAsB;AACvE,MAAI,OAAO,OAAO,KAAK,MAAM;AAC7B,WAAS,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK;AACpC,QAAI,MAAM,KAAK,CAAC;AAChB,QAAI,WAAW,GAAG,MAAM,OAAO,GAAG;AAAG,aAAO;AAAA,EAC9C;AACA,SAAO;AACT;AAPS;AAoBT,SAAS,iBACP,YACA,MACK;AACL,MAAI,CAAC;AAAM,WAAO,CAAC;AACnB,MAAI,CAAC,KAAK;AAAQ,WAAO,CAAC;AAE1B,MAAI,gBAAqC,CAAC;AAC1C,WAAS,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK;AACpC,QAAI,MAAM,KAAK,CAAC;AAChB,QAAI,OAAO,UAAU,eAAe,KAAK,YAAY,GAAG;AACtD,oBAAc,GAAG,IAAI,WAAW,GAAG;AAAA,EACvC;AACA,SAAO;AACT;AAdS;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/clusters",
-  "version": "7.0.0-alpha.2",
+  "version": "7.0.0",
   "description": "turf clusters module",
   "author": "Turf Authors",
   "contributors": [
@@ -26,44 +26,49 @@
     "clusters",
     "clustering"
   ],
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "type": "module",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./dist/js/index.d.ts",
-      "import": "./dist/es/index.js",
-      "require": "./dist/js/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
     }
   },
-  "types": "dist/js/index.d.ts",
   "sideEffects": false,
   "files": [
     "dist"
   ],
   "scripts": {
-    "bench": "tsx bench.js",
-    "build": "npm-run-all build:*",
-    "build:es": "tsc --outDir dist/es --module esnext --declaration false && echo '{\"type\":\"module\"}' > dist/es/package.json",
-    "build:js": "tsc",
-    "docs": "tsx ../../scripts/generate-readmes",
-    "test": "npm-run-all test:*",
-    "test:tape": "tsx test.js",
-    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
+    "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",
+    "test:types": "tsc --esModuleInterop --module node16 --moduleResolution node16 --noEmit --strict types.ts"
   },
   "devDependencies": {
-    "@types/tape": "*",
-    "benchmark": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "tslint": "*",
-    "tsx": "*",
-    "typescript": "*"
+    "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
+    "benchmark": "^2.1.4",
+    "npm-run-all": "^4.1.5",
+    "tape": "^5.7.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@turf/helpers": "^7.0.0-alpha.2",
-    "@turf/meta": "^7.0.0-alpha.2",
-    "tslib": "^2.3.0"
+    "@turf/helpers": "^7.0.0",
+    "@turf/meta": "^7.0.0",
+    "tslib": "^2.6.2"
   },
-  "gitHead": "dd35b52725945b4fa29a98d9a550733e06cc222e"
+  "gitHead": "3d3a7917025fbabe191dbddbc89754b86f9c7739"
 }

package/dist/es/package.json

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

package/dist/js/index.js

@@ -1,303 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const meta_1 = require("@turf/meta");
-const helpers_1 = require("@turf/helpers");
-/**
- * Get Cluster
- *
- * @name getCluster
- * @param {FeatureCollection} geojson GeoJSON Features
- * @param {*} filter Filter used on GeoJSON properties to get Cluster
- * @returns {FeatureCollection} Single Cluster filtered by GeoJSON Properties
- * @example
- * var geojson = turf.featureCollection([
- *     turf.point([0, 0], {'marker-symbol': 'circle'}),
- *     turf.point([2, 4], {'marker-symbol': 'star'}),
- *     turf.point([3, 6], {'marker-symbol': 'star'}),
- *     turf.point([5, 1], {'marker-symbol': 'square'}),
- *     turf.point([4, 2], {'marker-symbol': 'circle'})
- * ]);
- *
- * // Create a cluster using K-Means (adds `cluster` to GeoJSON properties)
- * var clustered = turf.clustersKmeans(geojson);
- *
- * // Retrieve first cluster (0)
- * var cluster = turf.getCluster(clustered, {cluster: 0});
- * //= cluster
- *
- * // Retrieve cluster based on custom properties
- * turf.getCluster(clustered, {'marker-symbol': 'circle'}).length;
- * //= 2
- * turf.getCluster(clustered, {'marker-symbol': 'square'}).length;
- * //= 1
- */
-function getCluster(geojson, filter) {
-    // Validation
-    if (!geojson)
-        throw new Error("geojson is required");
-    if (geojson.type !== "FeatureCollection")
-        throw new Error("geojson must be a FeatureCollection");
-    if (filter === undefined || filter === null)
-        throw new Error("filter is required");
-    // Filter Features
-    var features = [];
-    meta_1.featureEach(geojson, function (feature) {
-        if (applyFilter(feature.properties, filter))
-            features.push(feature);
-    });
-    return helpers_1.featureCollection(features);
-}
-exports.getCluster = getCluster;
-/**
- * Callback for clusterEach
- *
- * @callback clusterEachCallback
- * @param {FeatureCollection} [cluster] The current cluster being processed.
- * @param {*} [clusterValue] Value used to create cluster being processed.
- * @param {number} [currentIndex] The index of the current element being processed in the array.Starts at index 0
- * @returns {void}
- */
-/**
- * clusterEach
- *
- * @name clusterEach
- * @param {FeatureCollection} geojson GeoJSON Features
- * @param {string|number} property GeoJSON property key/value used to create clusters
- * @param {Function} callback a method that takes (cluster, clusterValue, currentIndex)
- * @returns {void}
- * @example
- * var geojson = turf.featureCollection([
- *     turf.point([0, 0]),
- *     turf.point([2, 4]),
- *     turf.point([3, 6]),
- *     turf.point([5, 1]),
- *     turf.point([4, 2])
- * ]);
- *
- * // Create a cluster using K-Means (adds `cluster` to GeoJSON properties)
- * var clustered = turf.clustersKmeans(geojson);
- *
- * // Iterate over each cluster
- * turf.clusterEach(clustered, 'cluster', function (cluster, clusterValue, currentIndex) {
- *     //= cluster
- *     //= clusterValue
- *     //= currentIndex
- * })
- *
- * // Calculate the total number of clusters
- * var total = 0
- * turf.clusterEach(clustered, 'cluster', function () {
- *     total++;
- * });
- *
- * // Create an Array of all the values retrieved from the 'cluster' property
- * var values = []
- * turf.clusterEach(clustered, 'cluster', function (cluster, clusterValue) {
- *     values.push(clusterValue);
- * });
- */
-function clusterEach(geojson, property, callback) {
-    // Validation
-    if (!geojson)
-        throw new Error("geojson is required");
-    if (geojson.type !== "FeatureCollection")
-        throw new Error("geojson must be a FeatureCollection");
-    if (property === undefined || property === null)
-        throw new Error("property is required");
-    // Create clusters based on property values
-    var bins = createBins(geojson, property);
-    var values = Object.keys(bins);
-    for (var index = 0; index < values.length; index++) {
-        var value = values[index];
-        var bin = bins[value];
-        var features = [];
-        for (var i = 0; i < bin.length; i++) {
-            features.push(geojson.features[bin[i]]);
-        }
-        callback(helpers_1.featureCollection(features), value, index);
-    }
-}
-exports.clusterEach = clusterEach;
-/**
- * Callback for clusterReduce
- *
- * The first time the callback function is called, the values provided as arguments depend
- * on whether the reduce method has an initialValue argument.
- *
- * If an initialValue is provided to the reduce method:
- *  - The previousValue argument is initialValue.
- *  - The currentValue argument is the value of the first element present in the array.
- *
- * If an initialValue is not provided:
- *  - The previousValue argument is the value of the first element present in the array.
- *  - The currentValue argument is the value of the second element present in the array.
- *
- * @callback clusterReduceCallback
- * @param {*} [previousValue] The accumulated value previously returned in the last invocation
- * of the callback, or initialValue, if supplied.
- * @param {FeatureCollection} [cluster] The current cluster being processed.
- * @param {*} [clusterValue] Value used to create cluster being processed.
- * @param {number} [currentIndex] The index of the current element being processed in the
- * array. Starts at index 0, if an initialValue is provided, and at index 1 otherwise.
- */
-/**
- * Reduce clusters in GeoJSON Features, similar to Array.reduce()
- *
- * @name clusterReduce
- * @param {FeatureCollection} geojson GeoJSON Features
- * @param {string|number} property GeoJSON property key/value used to create clusters
- * @param {Function} callback a method that takes (previousValue, cluster, clusterValue, currentIndex)
- * @param {*} [initialValue] Value to use as the first argument to the first call of the callback.
- * @returns {*} The value that results from the reduction.
- * @example
- * var geojson = turf.featureCollection([
- *     turf.point([0, 0]),
- *     turf.point([2, 4]),
- *     turf.point([3, 6]),
- *     turf.point([5, 1]),
- *     turf.point([4, 2])
- * ]);
- *
- * // Create a cluster using K-Means (adds `cluster` to GeoJSON properties)
- * var clustered = turf.clustersKmeans(geojson);
- *
- * // Iterate over each cluster and perform a calculation
- * var initialValue = 0
- * turf.clusterReduce(clustered, 'cluster', function (previousValue, cluster, clusterValue, currentIndex) {
- *     //=previousValue
- *     //=cluster
- *     //=clusterValue
- *     //=currentIndex
- *     return previousValue++;
- * }, initialValue);
- *
- * // Calculate the total number of clusters
- * var total = turf.clusterReduce(clustered, 'cluster', function (previousValue) {
- *     return previousValue++;
- * }, 0);
- *
- * // Create an Array of all the values retrieved from the 'cluster' property
- * var values = turf.clusterReduce(clustered, 'cluster', function (previousValue, cluster, clusterValue) {
- *     return previousValue.concat(clusterValue);
- * }, []);
- */
-function clusterReduce(geojson, property, callback, initialValue) {
-    var previousValue = initialValue;
-    clusterEach(geojson, property, function (cluster, clusterValue, currentIndex) {
-        if (currentIndex === 0 && initialValue === undefined)
-            previousValue = cluster;
-        else
-            previousValue = callback(previousValue, cluster, clusterValue, currentIndex);
-    });
-    return previousValue;
-}
-exports.clusterReduce = clusterReduce;
-/**
- * Create Bins
- *
- * @private
- * @param {FeatureCollection} geojson GeoJSON Features
- * @param {string|number} property Property values are used to create bins
- * @returns {Object} bins with Feature IDs
- * @example
- * var geojson = turf.featureCollection([
- *     turf.point([0, 0], {cluster: 0, foo: 'null'}),
- *     turf.point([2, 4], {cluster: 1, foo: 'bar'}),
- *     turf.point([5, 1], {0: 'foo'}),
- *     turf.point([3, 6], {cluster: 1}),
- * ]);
- * createBins(geojson, 'cluster');
- * //= { '0': [ 0 ], '1': [ 1, 3 ] }
- */
-function createBins(geojson, property) {
-    var bins = {};
-    meta_1.featureEach(geojson, function (feature, i) {
-        var properties = feature.properties || {};
-        if (Object.prototype.hasOwnProperty.call(properties, String(property))) {
-            var value = properties[property];
-            if (Object.prototype.hasOwnProperty.call(bins, value))
-                bins[value].push(i);
-            else
-                bins[value] = [i];
-        }
-    });
-    return bins;
-}
-exports.createBins = createBins;
-/**
- * Apply Filter
- *
- * @private
- * @param {*} properties Properties
- * @param {*} filter Filter
- * @returns {boolean} applied Filter to properties
- */
-function applyFilter(properties, filter) {
-    if (properties === undefined)
-        return false;
-    var filterType = typeof filter;
-    // String & Number
-    if (filterType === "number" || filterType === "string")
-        return Object.prototype.hasOwnProperty.call(properties, filter);
-    // Array
-    else if (Array.isArray(filter)) {
-        for (var i = 0; i < filter.length; i++) {
-            if (!applyFilter(properties, filter[i]))
-                return false;
-        }
-        return true;
-        // Object
-    }
-    else {
-        return propertiesContainsFilter(properties, filter);
-    }
-}
-exports.applyFilter = applyFilter;
-/**
- * Properties contains filter (does not apply deepEqual operations)
- *
- * @private
- * @param {*} properties Properties
- * @param {Object} filter Filter
- * @returns {boolean} does filter equal Properties
- * @example
- * propertiesContainsFilter({foo: 'bar', cluster: 0}, {cluster: 0})
- * //= true
- * propertiesContainsFilter({foo: 'bar', cluster: 0}, {cluster: 1})
- * //= false
- */
-function propertiesContainsFilter(properties, filter) {
-    var keys = Object.keys(filter);
-    for (var i = 0; i < keys.length; i++) {
-        var key = keys[i];
-        if (properties[key] !== filter[key])
-            return false;
-    }
-    return true;
-}
-exports.propertiesContainsFilter = propertiesContainsFilter;
-/**
- * Filter Properties
- *
- * @private
- * @param {*} properties Properties
- * @param {Array<string>} keys Used to filter Properties
- * @returns {*} filtered Properties
- * @example
- * filterProperties({foo: 'bar', cluster: 0}, ['cluster'])
- * //= {cluster: 0}
- */
-function filterProperties(properties, keys) {
-    if (!keys)
-        return {};
-    if (!keys.length)
-        return {};
-    var newProperties = {};
-    for (var i = 0; i < keys.length; i++) {
-        var key = keys[i];
-        if (Object.prototype.hasOwnProperty.call(properties, key))
-            newProperties[key] = properties[key];
-    }
-    return newProperties;
-}
-exports.filterProperties = filterProperties;