@turf/concave 7.0.0-alpha.1 → 7.0.0-alpha.111

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/concave",
-  "version": "7.0.0-alpha.1",
+  "version": "7.0.0-alpha.111+08576cb50",
   "description": "turf concave module",
   "author": "Turf Authors",
   "contributors": [
@@ -33,53 +33,58 @@
     "concave",
     "geometry"
   ],
-  "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",
     ".": {
-      "types": "./dist/js/index.d.ts",
-      "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": "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/tape": "*",
-    "@types/topojson-client": "^3.0.0",
-    "@types/topojson-server": "^3.0.0",
-    "benchmark": "*",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "tslint": "*",
-    "tsx": "*",
-    "typescript": "*",
-    "write-json-file": "*"
+    "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
+    "@types/topojson-client": "3.1.3",
+    "@types/topojson-server": "3.0.3",
+    "benchmark": "^2.1.4",
+    "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/clone": "^7.0.0-alpha.1",
-    "@turf/distance": "^7.0.0-alpha.1",
-    "@turf/helpers": "^7.0.0-alpha.1",
-    "@turf/invariant": "^7.0.0-alpha.1",
-    "@turf/meta": "^7.0.0-alpha.1",
-    "@turf/tin": "^7.0.0-alpha.1",
+    "@turf/clone": "^7.0.0-alpha.111+08576cb50",
+    "@turf/distance": "^7.0.0-alpha.111+08576cb50",
+    "@turf/helpers": "^7.0.0-alpha.111+08576cb50",
+    "@turf/invariant": "^7.0.0-alpha.111+08576cb50",
+    "@turf/meta": "^7.0.0-alpha.111+08576cb50",
+    "@turf/tin": "^7.0.0-alpha.111+08576cb50",
     "topojson-client": "3.x",
     "topojson-server": "3.x",
-    "tslib": "^2.3.0"
+    "tslib": "^2.6.2"
   },
-  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
+  "gitHead": "08576cb50376e0199aea02dbd887e3af83672246"
 }

package/dist/es/index.js

@@ -1,82 +0,0 @@
-import distance from "@turf/distance";
-import { feature, featureCollection } from "@turf/helpers";
-import { featureEach } from "@turf/meta";
-import tin from "@turf/tin";
-import dissolve from "./lib/turf-dissolve.js";
-/**
- * Takes a set of {@link Point|points} and returns a concave hull Polygon or MultiPolygon.
- * Internally, this uses [turf-tin](https://github.com/Turfjs/turf-tin) to generate geometries.
- *
- * @name concave
- * @param {FeatureCollection<Point>} points input points
- * @param {Object} [options={}] Optional parameters
- * @param {number} [options.maxEdge=Infinity] the length (in 'units') of an edge necessary for part of the
- * hull to become concave.
- * @param {string} [options.units='kilometers'] can be degrees, radians, miles, or kilometers
- * @returns {Feature<(Polygon|MultiPolygon)>|null} a concave hull (null value is returned if unable to compute hull)
- * @example
- * var points = turf.featureCollection([
- *   turf.point([-63.601226, 44.642643]),
- *   turf.point([-63.591442, 44.651436]),
- *   turf.point([-63.580799, 44.648749]),
- *   turf.point([-63.573589, 44.641788]),
- *   turf.point([-63.587665, 44.64533]),
- *   turf.point([-63.595218, 44.64765])
- * ]);
- * var options = {units: 'miles', maxEdge: 1};
- *
- * var hull = turf.concave(points, options);
- *
- * //addToMap
- * var addToMap = [points, hull]
- */
-function concave(points, options = {}) {
-    const maxEdge = options.maxEdge || Infinity;
-    const cleaned = removeDuplicates(points);
-    const tinPolys = tin(cleaned);
-    // calculate length of all edges and area of all triangles
-    // and remove triangles that fail the max length test
-    tinPolys.features = tinPolys.features.filter((triangle) => {
-        const pt1 = triangle.geometry.coordinates[0][0];
-        const pt2 = triangle.geometry.coordinates[0][1];
-        const pt3 = triangle.geometry.coordinates[0][2];
-        const dist1 = distance(pt1, pt2, options);
-        const dist2 = distance(pt2, pt3, options);
-        const dist3 = distance(pt1, pt3, options);
-        return dist1 <= maxEdge && dist2 <= maxEdge && dist3 <= maxEdge;
-    });
-    if (tinPolys.features.length < 1) {
-        return null;
-    }
-    // merge the adjacent triangles
-    const dissolved = dissolve(tinPolys);
-    // geojson-dissolve always returns a MultiPolygon
-    if (dissolved.coordinates.length === 1) {
-        dissolved.coordinates = dissolved.coordinates[0];
-        dissolved.type = "Polygon";
-    }
-    return feature(dissolved);
-}
-/**
- * Removes duplicated points in a collection returning a new collection
- *
- * @private
- * @param {FeatureCollection<Point>} points to be cleaned
- * @returns {FeatureCollection<Point>} cleaned set of points
- */
-function removeDuplicates(points) {
-    const cleaned = [];
-    const existing = {};
-    featureEach(points, (pt) => {
-        if (!pt.geometry) {
-            return;
-        }
-        const key = pt.geometry.coordinates.join("-");
-        if (!Object.prototype.hasOwnProperty.call(existing, key)) {
-            cleaned.push(pt);
-            existing[key] = true;
-        }
-    });
-    return featureCollection(cleaned);
-}
-export default concave;

package/dist/es/lib/turf-dissolve.js

@@ -1,70 +0,0 @@
-import clone from "@turf/clone";
-import { isObject } from "@turf/helpers";
-import { getType } from "@turf/invariant";
-import { flattenEach } from "@turf/meta";
-import lineDissolve from "./turf-line-dissolve.js";
-import polygonDissolve from "./turf-polygon-dissolve.js";
-/**
- * Transform function: attempts to dissolve geojson objects where possible
- * [GeoJSON] -> GeoJSON geometry
- *
- * @private
- * @param {FeatureCollection<LineString|MultiLineString|Polygon|MultiPolygon>} geojson Features to dissolved
- * @param {Object} [options={}] Optional parameters
- * @param {boolean} [options.mutate=false] Prevent input mutation
- * @returns {Feature<MultiLineString|MultiPolygon>} Dissolved Features
- */
-function dissolve(geojson, options = {}) {
-    // Optional parameters
-    options = options || {};
-    if (!isObject(options)) {
-        throw new Error("options is invalid");
-    }
-    const mutate = options.mutate;
-    // Validation
-    if (getType(geojson) !== "FeatureCollection") {
-        throw new Error("geojson must be a FeatureCollection");
-    }
-    if (!geojson.features.length) {
-        throw new Error("geojson is empty");
-    }
-    // Clone geojson to avoid side effects
-    // Topojson modifies in place, so we need to deep clone first
-    if (mutate === false || mutate === undefined) {
-        geojson = clone(geojson);
-    }
-    // Assert homogenity
-    const type = getHomogenousType(geojson);
-    if (!type) {
-        throw new Error("geojson must be homogenous");
-    }
-    // Data => Typescript hack
-    const data = geojson;
-    switch (type) {
-        case "LineString":
-            return lineDissolve(data, options);
-        case "Polygon":
-            return polygonDissolve(data, options);
-        default:
-            throw new Error(type + " is not supported");
-    }
-}
-/**
- * Checks if GeoJSON is Homogenous
- *
- * @private
- * @param {GeoJSON} geojson GeoJSON
- * @returns {string|null} Homogenous type or null if multiple types
- */
-function getHomogenousType(geojson) {
-    const types = {};
-    flattenEach(geojson, (feature) => {
-        types[feature.geometry.type] = true;
-    });
-    const keys = Object.keys(types);
-    if (keys.length === 1) {
-        return keys[0];
-    }
-    return null;
-}
-export default dissolve;

package/dist/es/lib/turf-line-dissolve.js

@@ -1,104 +0,0 @@
-import clone from "@turf/clone";
-import { isObject, lineString, multiLineString } from "@turf/helpers";
-import { getType } from "@turf/invariant";
-import { lineReduce } from "@turf/meta";
-/**
- * Merges all connected (non-forking, non-junctioning) line strings into single lineStrings.
- * [LineString] -> LineString|MultiLineString
- *
- * @param {FeatureCollection<LineString|MultiLineString>} geojson Lines to dissolve
- * @param {Object} [options={}] Optional parameters
- * @param {boolean} [options.mutate=false] Prevent input mutation
- * @returns {Feature<LineString|MultiLineString>} Dissolved lines
- */
-function lineDissolve(geojson, options = {}) {
-    // Optional parameters
-    options = options || {};
-    if (!isObject(options)) {
-        throw new Error("options is invalid");
-    }
-    const mutate = options.mutate;
-    // Validation
-    if (getType(geojson) !== "FeatureCollection") {
-        throw new Error("geojson must be a FeatureCollection");
-    }
-    if (!geojson.features.length) {
-        throw new Error("geojson is empty");
-    }
-    // Clone geojson to avoid side effects
-    if (mutate === false || mutate === undefined) {
-        geojson = clone(geojson);
-    }
-    const result = [];
-    const lastLine = lineReduce(geojson, (previousLine, currentLine) => {
-        // Attempt to merge this LineString with the other LineStrings, updating
-        // the reference as it is merged with others and grows.
-        const merged = mergeLineStrings(previousLine, currentLine);
-        // Accumulate the merged LineString
-        if (merged) {
-            return merged;
-            // Put the unmerged LineString back into the list
-        }
-        else {
-            result.push(previousLine);
-            return currentLine;
-        }
-    });
-    // Append the last line
-    if (lastLine) {
-        result.push(lastLine);
-    }
-    // Return null if no lines were dissolved
-    if (!result.length) {
-        return null;
-        // Return LineString if only 1 line was dissolved
-    }
-    else if (result.length === 1) {
-        return result[0];
-        // Return MultiLineString if multiple lines were dissolved with gaps
-    }
-    else {
-        return multiLineString(result.map((line) => {
-            return line.coordinates;
-        }));
-    }
-}
-// [Number, Number] -> String
-function coordId(coord) {
-    return coord[0].toString() + "," + coord[1].toString();
-}
-/**
- * LineString, LineString -> LineString
- *
- * @private
- * @param {Feature<LineString>} a line1
- * @param {Feature<LineString>} b line2
- * @returns {Feature<LineString>|null} Merged LineString
- */
-function mergeLineStrings(a, b) {
-    const coords1 = a.geometry.coordinates;
-    const coords2 = b.geometry.coordinates;
-    const s1 = coordId(coords1[0]);
-    const e1 = coordId(coords1[coords1.length - 1]);
-    const s2 = coordId(coords2[0]);
-    const e2 = coordId(coords2[coords2.length - 1]);
-    // TODO: handle case where more than one of these is true!
-    let coords;
-    if (s1 === e2) {
-        coords = coords2.concat(coords1.slice(1));
-    }
-    else if (s2 === e1) {
-        coords = coords1.concat(coords2.slice(1));
-    }
-    else if (s1 === s2) {
-        coords = coords1.slice(1).reverse().concat(coords2);
-    }
-    else if (e1 === e2) {
-        coords = coords1.concat(coords2.reverse().slice(1));
-    }
-    else {
-        return null;
-    }
-    return lineString(coords);
-}
-export default lineDissolve;

package/dist/es/lib/turf-polygon-dissolve.js

@@ -1,35 +0,0 @@
-import clone from "@turf/clone";
-import { geometryCollection } from "@turf/helpers";
-import { getType } from "@turf/invariant";
-import { flattenEach } from "@turf/meta";
-import { merge } from "topojson-client";
-import { topology } from "topojson-server";
-/**
- * Dissolves all overlapping (Multi)Polygon
- *
- * @param {FeatureCollection<Polygon|MultiPolygon>} geojson Polygons to dissolve
- * @param {Object} [options={}] Optional parameters
- * @param {boolean} [options.mutate=false] Prevent input mutation
- * @returns {Feature<Polygon|MultiPolygon>} Dissolved Polygons
- */
-export default function polygonDissolve(geojson, options = {}) {
-    // Validation
-    if (getType(geojson) !== "FeatureCollection") {
-        throw new Error("geojson must be a FeatureCollection");
-    }
-    if (!geojson.features.length) {
-        throw new Error("geojson is empty");
-    }
-    // Clone geojson to avoid side effects
-    // Topojson modifies in place, so we need to deep clone first
-    if (options.mutate === false || options.mutate === undefined) {
-        geojson = clone(geojson);
-    }
-    const geoms = [];
-    flattenEach(geojson, (feature) => {
-        geoms.push(feature.geometry);
-    });
-    const topo = topology({ geoms: geometryCollection(geoms).geometry });
-    const merged = merge(topo, topo.objects.geoms.geometries);
-    return merged;
-}

package/dist/es/package.json

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

package/dist/js/index.js

@@ -1,85 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const distance_1 = tslib_1.__importDefault(require("@turf/distance"));
-const helpers_1 = require("@turf/helpers");
-const meta_1 = require("@turf/meta");
-const tin_1 = tslib_1.__importDefault(require("@turf/tin"));
-const turf_dissolve_1 = tslib_1.__importDefault(require("./lib/turf-dissolve"));
-/**
- * Takes a set of {@link Point|points} and returns a concave hull Polygon or MultiPolygon.
- * Internally, this uses [turf-tin](https://github.com/Turfjs/turf-tin) to generate geometries.
- *
- * @name concave
- * @param {FeatureCollection<Point>} points input points
- * @param {Object} [options={}] Optional parameters
- * @param {number} [options.maxEdge=Infinity] the length (in 'units') of an edge necessary for part of the
- * hull to become concave.
- * @param {string} [options.units='kilometers'] can be degrees, radians, miles, or kilometers
- * @returns {Feature<(Polygon|MultiPolygon)>|null} a concave hull (null value is returned if unable to compute hull)
- * @example
- * var points = turf.featureCollection([
- *   turf.point([-63.601226, 44.642643]),
- *   turf.point([-63.591442, 44.651436]),
- *   turf.point([-63.580799, 44.648749]),
- *   turf.point([-63.573589, 44.641788]),
- *   turf.point([-63.587665, 44.64533]),
- *   turf.point([-63.595218, 44.64765])
- * ]);
- * var options = {units: 'miles', maxEdge: 1};
- *
- * var hull = turf.concave(points, options);
- *
- * //addToMap
- * var addToMap = [points, hull]
- */
-function concave(points, options = {}) {
-    const maxEdge = options.maxEdge || Infinity;
-    const cleaned = removeDuplicates(points);
-    const tinPolys = tin_1.default(cleaned);
-    // calculate length of all edges and area of all triangles
-    // and remove triangles that fail the max length test
-    tinPolys.features = tinPolys.features.filter((triangle) => {
-        const pt1 = triangle.geometry.coordinates[0][0];
-        const pt2 = triangle.geometry.coordinates[0][1];
-        const pt3 = triangle.geometry.coordinates[0][2];
-        const dist1 = distance_1.default(pt1, pt2, options);
-        const dist2 = distance_1.default(pt2, pt3, options);
-        const dist3 = distance_1.default(pt1, pt3, options);
-        return dist1 <= maxEdge && dist2 <= maxEdge && dist3 <= maxEdge;
-    });
-    if (tinPolys.features.length < 1) {
-        return null;
-    }
-    // merge the adjacent triangles
-    const dissolved = turf_dissolve_1.default(tinPolys);
-    // geojson-dissolve always returns a MultiPolygon
-    if (dissolved.coordinates.length === 1) {
-        dissolved.coordinates = dissolved.coordinates[0];
-        dissolved.type = "Polygon";
-    }
-    return helpers_1.feature(dissolved);
-}
-/**
- * Removes duplicated points in a collection returning a new collection
- *
- * @private
- * @param {FeatureCollection<Point>} points to be cleaned
- * @returns {FeatureCollection<Point>} cleaned set of points
- */
-function removeDuplicates(points) {
-    const cleaned = [];
-    const existing = {};
-    meta_1.featureEach(points, (pt) => {
-        if (!pt.geometry) {
-            return;
-        }
-        const key = pt.geometry.coordinates.join("-");
-        if (!Object.prototype.hasOwnProperty.call(existing, key)) {
-            cleaned.push(pt);
-            existing[key] = true;
-        }
-    });
-    return helpers_1.featureCollection(cleaned);
-}
-exports.default = concave;

package/dist/js/lib/turf-dissolve.d.ts

@@ -1,15 +0,0 @@
-import { Feature, FeatureCollection, LineString, MultiLineString, MultiPolygon, Polygon } from "geojson";
-/**
- * Transform function: attempts to dissolve geojson objects where possible
- * [GeoJSON] -> GeoJSON geometry
- *
- * @private
- * @param {FeatureCollection<LineString|MultiLineString|Polygon|MultiPolygon>} geojson Features to dissolved
- * @param {Object} [options={}] Optional parameters
- * @param {boolean} [options.mutate=false] Prevent input mutation
- * @returns {Feature<MultiLineString|MultiPolygon>} Dissolved Features
- */
-declare function dissolve(geojson: FeatureCollection<LineString | MultiLineString | Polygon | MultiPolygon>, options?: {
-    mutate?: boolean;
-}): Feature<LineString | MultiLineString | Polygon | MultiPolygon> | null;
-export default dissolve;

package/dist/js/lib/turf-dissolve.js

@@ -1,73 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const clone_1 = tslib_1.__importDefault(require("@turf/clone"));
-const helpers_1 = require("@turf/helpers");
-const invariant_1 = require("@turf/invariant");
-const meta_1 = require("@turf/meta");
-const turf_line_dissolve_1 = tslib_1.__importDefault(require("./turf-line-dissolve"));
-const turf_polygon_dissolve_1 = tslib_1.__importDefault(require("./turf-polygon-dissolve"));
-/**
- * Transform function: attempts to dissolve geojson objects where possible
- * [GeoJSON] -> GeoJSON geometry
- *
- * @private
- * @param {FeatureCollection<LineString|MultiLineString|Polygon|MultiPolygon>} geojson Features to dissolved
- * @param {Object} [options={}] Optional parameters
- * @param {boolean} [options.mutate=false] Prevent input mutation
- * @returns {Feature<MultiLineString|MultiPolygon>} Dissolved Features
- */
-function dissolve(geojson, options = {}) {
-    // Optional parameters
-    options = options || {};
-    if (!helpers_1.isObject(options)) {
-        throw new Error("options is invalid");
-    }
-    const mutate = options.mutate;
-    // Validation
-    if (invariant_1.getType(geojson) !== "FeatureCollection") {
-        throw new Error("geojson must be a FeatureCollection");
-    }
-    if (!geojson.features.length) {
-        throw new Error("geojson is empty");
-    }
-    // Clone geojson to avoid side effects
-    // Topojson modifies in place, so we need to deep clone first
-    if (mutate === false || mutate === undefined) {
-        geojson = clone_1.default(geojson);
-    }
-    // Assert homogenity
-    const type = getHomogenousType(geojson);
-    if (!type) {
-        throw new Error("geojson must be homogenous");
-    }
-    // Data => Typescript hack
-    const data = geojson;
-    switch (type) {
-        case "LineString":
-            return turf_line_dissolve_1.default(data, options);
-        case "Polygon":
-            return turf_polygon_dissolve_1.default(data, options);
-        default:
-            throw new Error(type + " is not supported");
-    }
-}
-/**
- * Checks if GeoJSON is Homogenous
- *
- * @private
- * @param {GeoJSON} geojson GeoJSON
- * @returns {string|null} Homogenous type or null if multiple types
- */
-function getHomogenousType(geojson) {
-    const types = {};
-    meta_1.flattenEach(geojson, (feature) => {
-        types[feature.geometry.type] = true;
-    });
-    const keys = Object.keys(types);
-    if (keys.length === 1) {
-        return keys[0];
-    }
-    return null;
-}
-exports.default = dissolve;

package/dist/js/lib/turf-line-dissolve.d.ts

@@ -1,14 +0,0 @@
-import { Feature, FeatureCollection, LineString, MultiLineString } from "geojson";
-/**
- * Merges all connected (non-forking, non-junctioning) line strings into single lineStrings.
- * [LineString] -> LineString|MultiLineString
- *
- * @param {FeatureCollection<LineString|MultiLineString>} geojson Lines to dissolve
- * @param {Object} [options={}] Optional parameters
- * @param {boolean} [options.mutate=false] Prevent input mutation
- * @returns {Feature<LineString|MultiLineString>} Dissolved lines
- */
-declare function lineDissolve(geojson: FeatureCollection<LineString | MultiLineString>, options?: {
-    mutate?: boolean;
-}): Feature<LineString | MultiLineString> | null;
-export default lineDissolve;