@turf/shortest-path 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -7,17 +7,18 @@
 Returns the shortest [path][1] from [start][2] to [end][2] without colliding with
 any [Feature][3] in [ obstacles][4]
 
-**Parameters**
+### Parameters
 
--   `start` **[Coord][5]** point
--   `end` **[Coord][5]** point
--   `options` **[Object][6]** optional parameters (optional, default `{}`)
-    -   `options.obstacles` **([Geometry][7] \| [Feature][8] \| [FeatureCollection][9]<[Polygon][10]>)?** areas which path cannot travel
-    -   `options.minDistance` **[number][11]?** minimum distance between shortest path and obstacles
-    -   `options.units` **[string][12]** unit in which resolution & minimum distance will be expressed in; it can be degrees, radians, miles, kilometers, ... (optional, default `'kilometers'`)
-    -   `options.resolution` **[number][11]** distance between matrix points on which the path will be calculated (optional, default `100`)
+*   `start` **[Coord][5]** point
+*   `end` **[Coord][5]** point
+*   `options` **[Object][6]** optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.obstacles` **([Geometry][7] | [Feature][8] | [FeatureCollection][9]<[Polygon][10]>)?** areas which path cannot travel
+    *   `options.minDistance` **[number][11]?** minimum distance between shortest path and obstacles
+    *   `options.units` **[string][12]** unit in which resolution & minimum distance will be expressed in; it can be degrees, radians, miles, kilometers, ... (optional, default `'kilometers'`)
+    *   `options.resolution` **[number][11]** distance between matrix points on which the path will be calculated (optional, default `100`)
+
+### Examples
 
 ```javascript
 var start = [-5, -6];
@@ -32,7 +33,7 @@ var path = turf.shortestPath(start, end, options);
 var addToMap = [start, end, options.obstacles, path];
 ```
 
-Returns **[Feature][8]&lt;[LineString][13]>** shortest path between start and end
+Returns **[Feature][8]<[LineString][13]>** shortest path between start and end
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4
 

package/dist/es/index.js

@@ -5,7 +5,7 @@ import scale from '@turf/transform-scale';
 import cleanCoords from '@turf/clean-coords';
 import bboxPolygon from '@turf/bbox-polygon';
 import { getCoord, getType, getGeom } from '@turf/invariant';
-import { point, isNumber, lineString, isObject, featureCollection, feature } from '@turf/helpers';
+import { isObject, featureCollection, isNumber, point, feature, lineString } from '@turf/helpers';
 
 // javascript-astar 0.4.1
 // http://github.com/bgrins/javascript-astar

package/dist/js/index.js

@@ -1,16 +1,23 @@
 'use strict';
 
-function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
-
-var bbox = _interopDefault(require('@turf/bbox'));
-var booleanPointInPolygon = _interopDefault(require('@turf/boolean-point-in-polygon'));
-var distance = _interopDefault(require('@turf/distance'));
-var scale = _interopDefault(require('@turf/transform-scale'));
-var cleanCoords = _interopDefault(require('@turf/clean-coords'));
-var bboxPolygon = _interopDefault(require('@turf/bbox-polygon'));
+var bbox = require('@turf/bbox');
+var booleanPointInPolygon = require('@turf/boolean-point-in-polygon');
+var distance = require('@turf/distance');
+var scale = require('@turf/transform-scale');
+var cleanCoords = require('@turf/clean-coords');
+var bboxPolygon = require('@turf/bbox-polygon');
 var invariant = require('@turf/invariant');
 var helpers = require('@turf/helpers');
 
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var bbox__default = /*#__PURE__*/_interopDefaultLegacy(bbox);
+var booleanPointInPolygon__default = /*#__PURE__*/_interopDefaultLegacy(booleanPointInPolygon);
+var distance__default = /*#__PURE__*/_interopDefaultLegacy(distance);
+var scale__default = /*#__PURE__*/_interopDefaultLegacy(scale);
+var cleanCoords__default = /*#__PURE__*/_interopDefaultLegacy(cleanCoords);
+var bboxPolygon__default = /*#__PURE__*/_interopDefaultLegacy(bboxPolygon);
+
 // javascript-astar 0.4.1
 // http://github.com/bgrins/javascript-astar
 // Freely distributable under the MIT License.
@@ -471,9 +478,9 @@ function shortestPath(start, end, options) {
   var collection = obstacles;
   collection.features.push(start);
   collection.features.push(end);
-  var box = bbox(scale(bboxPolygon(bbox(collection)), 1.15)); // extend 15%
+  var box = bbox__default['default'](scale__default['default'](bboxPolygon__default['default'](bbox__default['default'](collection)), 1.15)); // extend 15%
   if (!resolution) {
-    var width = distance([box[0], box[1]], [box[2], box[1]], options);
+    var width = distance__default['default']([box[0], box[1]], [box[2], box[1]], options);
     resolution = width / 100;
   }
   collection.features.pop();
@@ -484,9 +491,9 @@ function shortestPath(start, end, options) {
   var east = box[2];
   var north = box[3];
 
-  var xFraction = resolution / distance([west, south], [east, south], options);
+  var xFraction = resolution / distance__default['default']([west, south], [east, south], options);
   var cellWidth = xFraction * (east - west);
-  var yFraction = resolution / distance([west, south], [west, north], options);
+  var yFraction = resolution / distance__default['default']([west, south], [west, north], options);
   var cellHeight = yFraction * (north - south);
 
   var bboxHorizontalSide = east - west;
@@ -523,13 +530,13 @@ function shortestPath(start, end, options) {
       // map point's coords
       pointMatrixRow.push(currentX + "|" + currentY);
       // set closest points
-      var distStart = distance(pt, start);
+      var distStart = distance__default['default'](pt, start);
       // if (distStart < minDistStart) {
       if (!isInsideObstacle && distStart < minDistStart) {
         minDistStart = distStart;
         closestToStart = { x: c, y: r };
       }
-      var distEnd = distance(pt, end);
+      var distEnd = distance__default['default'](pt, end);
       // if (distEnd < minDistEnd) {
       if (!isInsideObstacle && distEnd < minDistEnd) {
         minDistEnd = distEnd;
@@ -570,7 +577,7 @@ function shortestPath(start, end, options) {
   // path.push(end.geometry.coordinates);
   // ---------------------------------------
 
-  return cleanCoords(helpers.lineString(path));
+  return cleanCoords__default['default'](helpers.lineString(path));
 }
 
 /**
@@ -583,7 +590,7 @@ function shortestPath(start, end, options) {
  */
 function isInside(pt, polygons) {
   for (var i = 0; i < polygons.features.length; i++) {
-    if (booleanPointInPolygon(pt, polygons.features[i])) {
+    if (booleanPointInPolygon__default['default'](pt, polygons.features[i])) {
       return true;
     }
   }
@@ -591,3 +598,4 @@ function isInside(pt, polygons) {
 }
 
 module.exports = shortestPath;
+module.exports.default = shortestPath;

package/index.d.ts

@@ -1,11 +1,5 @@
-import {
-  Polygon,
-  Feature,
-  FeatureCollection,
-  Coord,
-  LineString,
-  Units,
-} from "@turf/helpers";
+import { Polygon, Feature, FeatureCollection, LineString } from "geojson";
+import { Coord, Units } from "@turf/helpers";
 
 /**
  * http://turfjs.org/docs/#shortestpath

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/shortest-path",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf shortest-path module",
   "author": "Turf Authors",
   "contributors": [
@@ -16,6 +16,7 @@
     "type": "git",
     "url": "git://github.com/Turfjs/turf.git"
   },
+  "funding": "https://opencollective.com/turf",
   "publishConfig": {
     "access": "public"
   },
@@ -45,10 +46,10 @@
     "docs": "node ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
     "test:tape": "node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
-    "@turf/truncate": "^6.4.0",
+    "@turf/truncate": "^7.0.0-alpha.0",
     "benchmark": "*",
     "load-json-file": "*",
     "npm-run-all": "*",
@@ -57,15 +58,15 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/bbox": "^6.4.0",
-    "@turf/bbox-polygon": "^6.4.0",
-    "@turf/boolean-point-in-polygon": "^6.4.0",
-    "@turf/clean-coords": "^6.4.0",
-    "@turf/distance": "^6.4.0",
-    "@turf/helpers": "^6.4.0",
-    "@turf/invariant": "^6.4.0",
-    "@turf/meta": "^6.4.0",
-    "@turf/transform-scale": "^6.4.0"
+    "@turf/bbox": "^7.0.0-alpha.0",
+    "@turf/bbox-polygon": "^7.0.0-alpha.0",
+    "@turf/boolean-point-in-polygon": "^7.0.0-alpha.0",
+    "@turf/clean-coords": "^7.0.0-alpha.0",
+    "@turf/distance": "^7.0.0-alpha.0",
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/invariant": "^7.0.0-alpha.0",
+    "@turf/meta": "^7.0.0-alpha.0",
+    "@turf/transform-scale": "^7.0.0-alpha.0"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }