fix issue #22, remove unneeded files (bower, travis, readme-imgs), fi…

…x readme

.npmignore

@@ -1,2 +1,3 @@
 node_modules
-debug
+debug
+readme-imgs

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2020, Andrii Heonia
+Copyright (c) 2014-2024, Andrii Heonia
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,6 +1,4 @@
-Hull.js - JavaScript library that builds concave hull by set of points.
-
-[![Build Status](https://travis-ci.org/AndriiHeonia/hull.svg?branch=master)](https://travis-ci.org/AndriiHeonia/hull)
+Hull.js is a JavaScript library that builds concave hull by the set of points.
 
 ## Examples
 
@@ -51,9 +49,13 @@ This library relies on ES6. The ES6 features used are:
 You may use [polyfills](https://www.npmjs.com/package/core-js) for `Set` and compile with [babel](https://babeljs.io/) to continue to support old browsers.
 
 ## Development
-	npm install             # install dependencies
-	npm test                # build dist file and run tests
-	npm run-script watch    # watch ./src dir and rebuild dist file
+	npm install     # install dependencies
+	npm test        # build dist file and run tests
+	npm run watch   # watch ./src dir and rebuild dist file
+
+## TypeScript
+
+You can find TypeScript type definitions [here](https://www.npmjs.com/package/@types/hull.js). Keep in mind that type definitions are not maintained by the author of this library and the latest versions might not match. At the same time, this library is not actively maintained since 2015 and contains only minor changes, so even the older d.ts file should work fine.
 
 ## Contribute
 
@@ -76,38 +78,46 @@ If you want to get involved with Hull.js development, just use <a href="https://
 
 ## Changelog
 
+<details>
+    <summary>Expand</summary>
+
+### 1.0.7 - 03.05.2024
+This release squashes former 1.0.3, 1.0.4, 1.0.5 and 1.0.6 releases into one reasonable commit with the following minor changes:
+- Fix issue with formatting when users pass less than 4 points as an input.
+- Remove bower and travis files as they are deprecated.
 ### 1.0.2 — 26.09.2021
 - Clean up .gitignore.
 - Add "debug" folder to .npmignore to reduce tarball size.
 ### 1.0.1 — 24.10.2020
-Introduce fix that avoids hitting stack size limit on large arrays.
+- Fix that avoids hitting stack size limit on large arrays.
 ### 1.0.0 — 28.06.2019
 - Change language level to ES6.
 - Performance improvements.
 ### 0.2.11 — 05.05.2019
-Return the first point as the last point when fewer than 4 unique points are provided.
+- Minor changes: return the first point as the last point when fewer than 4 unique points are provided.
 ### 0.2.10 — 04.09.2016
-Fix missing "var" declaration.
+- Minor changes: fix missing "var" declaration.
 ### 0.2.9 — 28.07.2016
 - Fix modification of the initial array.
 - Add filtration of the duplicates.
 ### 0.2.8 — 01.04.2016
-Add edgeSkipList to increase performance of the highly accurate shapes (with the small `concavity` number) + refactoring.
+- Add edgeSkipList to increase performance of the highly accurate shapes (with the small `concavity` number) + some refactoring.
 ### 0.2.7 — 01.05.2015
-Fix bower.json.
+- Minor changes: fix bower.json.
 ### 0.2.6 — 01.05.2015
-Fix bower.json.
+- Minor changes: fix bower.json.
 ### 0.2.5 — 01.05.2015
-Bower support.
+- Minor changes: Bower support.
 ### 0.2.4 — 23.03.2015
-Minor fixes (copyrights).
+- Minor changes: copyrights.
 ### 0.2.3 — 04.02.2015
-Minor fixes (readme, package.json).
+- Minor changes: readme, package.json.
 ### 0.2.2 — 04.02.2015
-Configurable point formats, now you can use points like `{x: 10, y: 10}` and `{lat: 52, lng: 82}`.
+- Configurable point format, now you can use points like `{x: 10, y: 10}` and `{lat: 52, lng: 82}`.
 ### 0.2.1 — 21.10.2014
-Some minor updates (doc, package.json, etc.).
+- Minor changes: doc, package.json, etc.
 ### 0.2.0 — 20.10.2014
-Second version with better performance inspired by <a href="http://www.it.uu.se/edu/course/homepage/projektTDB/ht13/project10/Project-10-report.pdf" target="_blank">this</a> article.
+- Second version with better performance inspired by <a href="http://www.it.uu.se/edu/course/homepage/projektTDB/ht13/project10/Project-10-report.pdf" target="_blank">this</a> article.
 ### 0.1.0 — 06.09.2014
-First version based on Delaunay triangulation.
+- First version based on Delaunay triangulation.
+</details>

dist/hull.js

@@ -154,8 +154,8 @@ function grid(points, cellSize) {
 module.exports = grid;
 },{}],4:[function(require,module,exports){
 /*
- (c) 2014-2020, Andrii Heonia
- Hull.js, a JavaScript library for concave hull generation by set of points.
+ (c) 2014, Andrii Heonia
+ Hull.js, a JavaScript library for concave hull generation by the set of points.
  https://github.com/AndriiHeonia/hull
 */
 
@@ -321,7 +321,8 @@ function hull(pointset, concavity, format) {
     const points = _filterDuplicates(_sortByX(formatUtil.toXy(pointset, format)));
 
     if (points.length < 4) {
-        return points.concat([points[0]]);
+        const concave = points.concat([points[0]]);
+        return format ? formatUtil.fromXy(concave, format) : concave;
     }
 
     const occupiedArea = _occupiedArea(points);
@@ -341,11 +342,7 @@ function hull(pointset, concavity, format) {
         convex, Math.pow(maxEdgeLen, 2),
         maxSearchArea, grid(innerPoints, cellSize), new Set());
 
-    if (format) {
-        return formatUtil.fromXy(concave, format);
-    } else {
-        return concave;
-    }
+    return format ? formatUtil.fromXy(concave, format) : concave;
 }
 
 const MAX_CONCAVE_ANGLE_COS = Math.cos(90 / (180 / Math.PI)); // angle = 90 deg

package.json

@@ -1,7 +1,7 @@
 {
     "name": "hull.js",
-    "version": "1.0.2",
-    "description": "JavaScript library that builds concave hulls (shapes) by set of points",
+    "version": "1.0.7",
+    "description": "JavaScript library that builds concave hulls (shapes) by the set of points",
     "homepage": "https://github.com/AndriiHeonia/hull",
     "keywords": [
         "geometry",
@@ -10,7 +10,7 @@
         "alpha-shape",
         "algorithm"
     ],
-    "author": "Andrii Heonia <[email protected]>",
+    "author": "Andrii Heonia",
     "repository": {
         "type": "git",
         "url": "git://github.com/AndriiHeonia/hull.git"

src/hull.js

@@ -1,6 +1,6 @@
 /*
- (c) 2014-2021, Andrii Heonia
- Hull.js, a JavaScript library for concave hull generation by set of points.
+ (c) 2014, Andrii Heonia
+ Hull.js, a JavaScript library for concave hull generation by the set of points.
  https://github.com/AndriiHeonia/hull
 */
 
@@ -166,7 +166,8 @@ function hull(pointset, concavity, format) {
     const points = _filterDuplicates(_sortByX(formatUtil.toXy(pointset, format)));
 
     if (points.length < 4) {
-        return points.concat([points[0]]);
+        const concave = points.concat([points[0]]);
+        return format ? formatUtil.fromXy(concave, format) : concave;
     }
 
     const occupiedArea = _occupiedArea(points);
@@ -186,11 +187,7 @@ function hull(pointset, concavity, format) {
         convex, Math.pow(maxEdgeLen, 2),
         maxSearchArea, grid(innerPoints, cellSize), new Set());
 
-    if (format) {
-        return formatUtil.fromXy(concave, format);
-    } else {
-        return concave;
-    }
+    return format ? formatUtil.fromXy(concave, format) : concave;
 }
 
 const MAX_CONCAVE_ANGLE_COS = Math.cos(90 / (180 / Math.PI)); // angle = 90 deg

test/hull.js

@@ -15,9 +15,16 @@ module.exports = function() {
     });
 
     it('should return concave hull with lngs and lats', function() {
-        const points = [{lng:-0.206792373176235, lat:51.4911165465815 }, {lng:-0.207062672933557, lat:51.4915703125214 }, {lng:-0.207465840096923, lat:51.4912077781219 }, {lng:-0.210193421020222, lat:51.4918159814458 }, {lng:-0.214944392455692, lat:51.4929945001276 }, {lng:-0.208133371509344, lat:51.4910830915252 }, {lng:-0.214162055384851, lat:51.4905275966855 }, {lng:-0.208161917730384, lat:51.4903551232517 }, {lng:-0.209680931181673, lat:51.4901894811742 }, {lng:-0.212571431609104, lat:51.4903145141462 }, {lng:-0.216849005460861, lat:51.4921781720221}];
-        const expected = [{lng: -0.206792373176235, lat: 51.4911165465815 }, {lng: -0.207062672933557, lat: 51.4915703125214 }, {lng: -0.207465840096923, lat: 51.4912077781219 }, {lng: -0.210193421020222, lat: 51.4918159814458 }, {lng: -0.214944392455692, lat: 51.4929945001276 }, {lng: -0.216849005460861, lat: 51.4921781720221 }, {lng: -0.214162055384851, lat: 51.4905275966855 }, {lng: -0.212571431609104, lat: 51.4903145141462 }, {lng: -0.209680931181673, lat: 51.4901894811742 }, {lng: -0.208161917730384, lat: 51.4903551232517 }, {lng: -0.208133371509344, lat: 51.4910830915252 }, {lng: -0.206792373176235, lat: 51.4911165465815}];
+        let points,
+            expected;
+
+        points = [{lng:-0.206792373176235, lat:51.4911165465815 }, {lng:-0.207062672933557, lat:51.4915703125214 }, {lng:-0.207465840096923, lat:51.4912077781219 }, {lng:-0.210193421020222, lat:51.4918159814458 }, {lng:-0.214944392455692, lat:51.4929945001276 }, {lng:-0.208133371509344, lat:51.4910830915252 }, {lng:-0.214162055384851, lat:51.4905275966855 }, {lng:-0.208161917730384, lat:51.4903551232517 }, {lng:-0.209680931181673, lat:51.4901894811742 }, {lng:-0.212571431609104, lat:51.4903145141462 }, {lng:-0.216849005460861, lat:51.4921781720221}];
+        expected = [{lng: -0.206792373176235, lat: 51.4911165465815 }, {lng: -0.207062672933557, lat: 51.4915703125214 }, {lng: -0.207465840096923, lat: 51.4912077781219 }, {lng: -0.210193421020222, lat: 51.4918159814458 }, {lng: -0.214944392455692, lat: 51.4929945001276 }, {lng: -0.216849005460861, lat: 51.4921781720221 }, {lng: -0.214162055384851, lat: 51.4905275966855 }, {lng: -0.212571431609104, lat: 51.4903145141462 }, {lng: -0.209680931181673, lat: 51.4901894811742 }, {lng: -0.208161917730384, lat: 51.4903551232517 }, {lng: -0.208133371509344, lat: 51.4910830915252 }, {lng: -0.206792373176235, lat: 51.4911165465815}];
         assert.deepEqual(hull(points, 0.0011, ['.lng', '.lat']), expected);
+
+        points = [{lat: 10, lng: 10}, {lat: 100, lng: 10}, {lat: 100, lng: 100}];
+        expected = [{lat: 10, lng: 10}, {lat: 100, lng: 10}, {lat: 100, lng: 100}, {lat: 10, lng: 10}];
+        assert.deepEqual(hull(points, 10, ['.lng', '.lat']), expected);
     });
 
     it('should append the first point', function() {