@turf/convex 7.0.0-alpha.2 → 7.1.0-alpha.7

package/README.md

@@ -58,26 +58,21 @@ Returns **[Feature][9]<[Polygon][10]>** a convex hull
 
 [10]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 
-<!-- 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/convex
 ```
 
-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,25 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }// index.ts
+var _helpers = require('@turf/helpers');
+var _meta = require('@turf/meta');
+var _concaveman = require('concaveman'); var _concaveman2 = _interopRequireDefault(_concaveman);
+function convex(geojson, options = {}) {
+  options.concavity = options.concavity || Infinity;
+  const points = [];
+  _meta.coordEach.call(void 0, geojson, (coord) => {
+    points.push([coord[0], coord[1]]);
+  });
+  if (!points.length) {
+    return null;
+  }
+  const convexHull = _concaveman2.default.call(void 0, points, options.concavity);
+  if (convexHull.length > 3) {
+    return _helpers.polygon.call(void 0, [convexHull]);
+  }
+  return null;
+}
+var turf_convex_default = convex;
+
+
+
+exports.convex = convex; exports.default = turf_convex_default;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";AACA,SAAqB,eAAe;AACpC,SAAS,iBAAiB;AAC1B,OAAO,gBAAgB;AA8BvB,SAAS,OACP,SACA,UAGI,CAAC,GACuB;AAE5B,UAAQ,YAAY,QAAQ,aAAa;AAGzC,QAAM,SAAqB,CAAC;AAG5B,YAAU,SAAS,CAAC,UAAU;AAC5B,WAAO,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;AAAA,EAClC,CAAC;AACD,MAAI,CAAC,OAAO,QAAQ;AAClB,WAAO;AAAA,EACT;AAEA,QAAM,aAAa,WAAW,QAAQ,QAAQ,SAAS;AAGvD,MAAI,WAAW,SAAS,GAAG;AACzB,WAAO,QAAQ,CAAC,UAAU,CAAC;AAAA,EAC7B;AACA,SAAO;AACT;AAGA,IAAO,sBAAQ","sourcesContent":["import { Feature, GeoJsonProperties, Polygon } from \"geojson\";\nimport { AllGeoJSON, polygon } from \"@turf/helpers\";\nimport { coordEach } from \"@turf/meta\";\nimport concaveman from \"concaveman\";\n\n/**\n * Takes a {@link Feature} or a {@link FeatureCollection} and returns a convex hull {@link Polygon}.\n *\n * Internally this uses\n * the [convex-hull](https://github.com/mikolalysenko/convex-hull) module that implements a\n * [monotone chain hull](http://en.wikibooks.org/wiki/Algorithm_Implementation/Geometry/Convex_hull/Monotone_chain).\n *\n * @name convex\n * @param {GeoJSON} geojson input Feature or FeatureCollection\n * @param {Object} [options={}] Optional parameters\n * @param {number} [options.concavity=Infinity] 1 - thin shape. Infinity - convex hull.\n * @param {Object} [options.properties={}] Translate Properties to Feature\n * @returns {Feature<Polygon>} a convex hull\n * @example\n * var points = turf.featureCollection([\n *   turf.point([10.195312, 43.755225]),\n *   turf.point([10.404052, 43.8424511]),\n *   turf.point([10.579833, 43.659924]),\n *   turf.point([10.360107, 43.516688]),\n *   turf.point([10.14038, 43.588348]),\n *   turf.point([10.195312, 43.755225])\n * ]);\n *\n * var hull = turf.convex(points);\n *\n * //addToMap\n * var addToMap = [points, hull]\n */\nfunction convex<P extends GeoJsonProperties = GeoJsonProperties>(\n  geojson: AllGeoJSON,\n  options: {\n    concavity?: number;\n    properties?: P;\n  } = {}\n): Feature<Polygon, P> | null {\n  // Default parameters\n  options.concavity = options.concavity || Infinity;\n\n  // Container\n  const points: number[][] = [];\n\n  // Convert all points to flat 2D coordinate Array\n  coordEach(geojson, (coord) => {\n    points.push([coord[0], coord[1]]);\n  });\n  if (!points.length) {\n    return null;\n  }\n\n  const convexHull = concaveman(points, options.concavity);\n\n  // Convex hull should have at least 3 different vertices in order to create a valid polygon\n  if (convexHull.length > 3) {\n    return polygon([convexHull]);\n  }\n  return null;\n}\n\nexport { convex };\nexport default convex;\n"]}

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

@@ -1,6 +1,6 @@
-import { polygon } from "@turf/helpers";
-import { coordEach } from "@turf/meta";
-import concaveman from "concaveman";
+import { GeoJsonProperties, Feature, Polygon } from 'geojson';
+import { AllGeoJSON } from '@turf/helpers';
+
 /**
  * Takes a {@link Feature} or a {@link FeatureCollection} and returns a convex hull {@link Polygon}.
  *
@@ -29,22 +29,9 @@ import concaveman from "concaveman";
  * //addToMap
  * var addToMap = [points, hull]
  */
-export default function convex(geojson, options = {}) {
-    // Default parameters
-    options.concavity = options.concavity || Infinity;
-    // Container
-    const points = [];
-    // Convert all points to flat 2D coordinate Array
-    coordEach(geojson, (coord) => {
-        points.push([coord[0], coord[1]]);
-    });
-    if (!points.length) {
-        return null;
-    }
-    const convexHull = concaveman(points, options.concavity);
-    // Convex hull should have at least 3 different vertices in order to create a valid polygon
-    if (convexHull.length > 3) {
-        return polygon([convexHull]);
-    }
-    return null;
-}
+declare function convex<P extends GeoJsonProperties = GeoJsonProperties>(geojson: AllGeoJSON, options?: {
+    concavity?: number;
+    properties?: P;
+}): Feature<Polygon, P> | null;
+
+export { convex, convex as default };

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

@@ -1,5 +1,6 @@
-import { Feature, GeoJsonProperties, Polygon } from "geojson";
-import { AllGeoJSON } from "@turf/helpers";
+import { GeoJsonProperties, Feature, Polygon } from 'geojson';
+import { AllGeoJSON } from '@turf/helpers';
+
 /**
  * Takes a {@link Feature} or a {@link FeatureCollection} and returns a convex hull {@link Polygon}.
  *
@@ -28,7 +29,9 @@ import { AllGeoJSON } from "@turf/helpers";
  * //addToMap
  * var addToMap = [points, hull]
  */
-export default function convex<P = GeoJsonProperties>(geojson: AllGeoJSON, options?: {
+declare function convex<P extends GeoJsonProperties = GeoJsonProperties>(geojson: AllGeoJSON, options?: {
     concavity?: number;
     properties?: P;
 }): Feature<Polygon, P> | null;
+
+export { convex, convex as default };

package/dist/esm/index.js

@@ -0,0 +1,25 @@
+// index.ts
+import { polygon } from "@turf/helpers";
+import { coordEach } from "@turf/meta";
+import concaveman from "concaveman";
+function convex(geojson, options = {}) {
+  options.concavity = options.concavity || Infinity;
+  const points = [];
+  coordEach(geojson, (coord) => {
+    points.push([coord[0], coord[1]]);
+  });
+  if (!points.length) {
+    return null;
+  }
+  const convexHull = concaveman(points, options.concavity);
+  if (convexHull.length > 3) {
+    return polygon([convexHull]);
+  }
+  return null;
+}
+var turf_convex_default = convex;
+export {
+  convex,
+  turf_convex_default as default
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { Feature, GeoJsonProperties, Polygon } from \"geojson\";\nimport { AllGeoJSON, polygon } from \"@turf/helpers\";\nimport { coordEach } from \"@turf/meta\";\nimport concaveman from \"concaveman\";\n\n/**\n * Takes a {@link Feature} or a {@link FeatureCollection} and returns a convex hull {@link Polygon}.\n *\n * Internally this uses\n * the [convex-hull](https://github.com/mikolalysenko/convex-hull) module that implements a\n * [monotone chain hull](http://en.wikibooks.org/wiki/Algorithm_Implementation/Geometry/Convex_hull/Monotone_chain).\n *\n * @name convex\n * @param {GeoJSON} geojson input Feature or FeatureCollection\n * @param {Object} [options={}] Optional parameters\n * @param {number} [options.concavity=Infinity] 1 - thin shape. Infinity - convex hull.\n * @param {Object} [options.properties={}] Translate Properties to Feature\n * @returns {Feature<Polygon>} a convex hull\n * @example\n * var points = turf.featureCollection([\n *   turf.point([10.195312, 43.755225]),\n *   turf.point([10.404052, 43.8424511]),\n *   turf.point([10.579833, 43.659924]),\n *   turf.point([10.360107, 43.516688]),\n *   turf.point([10.14038, 43.588348]),\n *   turf.point([10.195312, 43.755225])\n * ]);\n *\n * var hull = turf.convex(points);\n *\n * //addToMap\n * var addToMap = [points, hull]\n */\nfunction convex<P extends GeoJsonProperties = GeoJsonProperties>(\n  geojson: AllGeoJSON,\n  options: {\n    concavity?: number;\n    properties?: P;\n  } = {}\n): Feature<Polygon, P> | null {\n  // Default parameters\n  options.concavity = options.concavity || Infinity;\n\n  // Container\n  const points: number[][] = [];\n\n  // Convert all points to flat 2D coordinate Array\n  coordEach(geojson, (coord) => {\n    points.push([coord[0], coord[1]]);\n  });\n  if (!points.length) {\n    return null;\n  }\n\n  const convexHull = concaveman(points, options.concavity);\n\n  // Convex hull should have at least 3 different vertices in order to create a valid polygon\n  if (convexHull.length > 3) {\n    return polygon([convexHull]);\n  }\n  return null;\n}\n\nexport { convex };\nexport default convex;\n"],"mappings":";AACA,SAAqB,eAAe;AACpC,SAAS,iBAAiB;AAC1B,OAAO,gBAAgB;AA8BvB,SAAS,OACP,SACA,UAGI,CAAC,GACuB;AAE5B,UAAQ,YAAY,QAAQ,aAAa;AAGzC,QAAM,SAAqB,CAAC;AAG5B,YAAU,SAAS,CAAC,UAAU;AAC5B,WAAO,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;AAAA,EAClC,CAAC;AACD,MAAI,CAAC,OAAO,QAAQ;AAClB,WAAO;AAAA,EACT;AAEA,QAAM,aAAa,WAAW,QAAQ,QAAQ,SAAS;AAGvD,MAAI,WAAW,SAAS,GAAG;AACzB,WAAO,QAAQ,CAAC,UAAU,CAAC;AAAA,EAC7B;AACA,SAAO;AACT;AAGA,IAAO,sBAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/convex",
-  "version": "7.0.0-alpha.2",
+  "version": "7.1.0-alpha.7+0ce6ecca0",
   "description": "turf convex module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -20,48 +20,53 @@
     "turf",
     "gis"
   ],
-  "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"
+    "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": {
-    "@types/concaveman": "^1.1.3",
-    "@types/tape": "*",
-    "benchmark": "*",
-    "glob": "*",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "tslint": "*",
-    "tsx": "*",
-    "typescript": "*",
-    "write-json-file": "*"
+    "@types/benchmark": "^2.1.5",
+    "@types/concaveman": "^1.1.6",
+    "@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.2",
-    "@turf/meta": "^7.0.0-alpha.2",
+    "@turf/helpers": "^7.1.0-alpha.7+0ce6ecca0",
+    "@turf/meta": "^7.1.0-alpha.7+0ce6ecca0",
     "concaveman": "^1.2.1",
-    "tslib": "^2.3.0"
+    "tslib": "^2.6.2"
   },
-  "gitHead": "dd35b52725945b4fa29a98d9a550733e06cc222e"
+  "gitHead": "0ce6ecca05829690270fec6d6bed2003495fe0ea"
 }

package/dist/es/package.json

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

package/dist/js/index.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const helpers_1 = require("@turf/helpers");
-const meta_1 = require("@turf/meta");
-const concaveman_1 = tslib_1.__importDefault(require("concaveman"));
-/**
- * Takes a {@link Feature} or a {@link FeatureCollection} and returns a convex hull {@link Polygon}.
- *
- * Internally this uses
- * the [convex-hull](https://github.com/mikolalysenko/convex-hull) module that implements a
- * [monotone chain hull](http://en.wikibooks.org/wiki/Algorithm_Implementation/Geometry/Convex_hull/Monotone_chain).
- *
- * @name convex
- * @param {GeoJSON} geojson input Feature or FeatureCollection
- * @param {Object} [options={}] Optional parameters
- * @param {number} [options.concavity=Infinity] 1 - thin shape. Infinity - convex hull.
- * @param {Object} [options.properties={}] Translate Properties to Feature
- * @returns {Feature<Polygon>} a convex hull
- * @example
- * var points = turf.featureCollection([
- *   turf.point([10.195312, 43.755225]),
- *   turf.point([10.404052, 43.8424511]),
- *   turf.point([10.579833, 43.659924]),
- *   turf.point([10.360107, 43.516688]),
- *   turf.point([10.14038, 43.588348]),
- *   turf.point([10.195312, 43.755225])
- * ]);
- *
- * var hull = turf.convex(points);
- *
- * //addToMap
- * var addToMap = [points, hull]
- */
-function convex(geojson, options = {}) {
-    // Default parameters
-    options.concavity = options.concavity || Infinity;
-    // Container
-    const points = [];
-    // Convert all points to flat 2D coordinate Array
-    meta_1.coordEach(geojson, (coord) => {
-        points.push([coord[0], coord[1]]);
-    });
-    if (!points.length) {
-        return null;
-    }
-    const convexHull = concaveman_1.default(points, options.concavity);
-    // Convex hull should have at least 3 different vertices in order to create a valid polygon
-    if (convexHull.length > 3) {
-        return helpers_1.polygon([convexHull]);
-    }
-    return null;
-}
-exports.default = convex;