Merge pull request #2942 from ziegler-daniel/bugfix/issue-2941

@turf/shortest-path Allow polygon feature as obstacle for shortestPath (#2941)

Author: smallsaucepan

packages/turf-shortest-path/index.ts

@@ -81,6 +81,11 @@ function shortestPath(
     if (obstacles.features.length === 0) {
       return lineString([startCoord, endCoord]);
     }
+  } else if (
+    obstacles.type === "Feature" &&
+    obstacles.geometry.type === "Polygon"
+  ) {
+    obstacles = featureCollection([obstacles]);
   } else if (obstacles.type === "Polygon") {
     obstacles = featureCollection([feature(getGeom(obstacles))]);
   } else {

packages/turf-shortest-path/test.ts

@@ -55,3 +55,29 @@ test("turf-shortest-path", (t) => {
   }
   t.end();
 });
+
+test("turf-shortest-path -- with polygon feature as obstacle", (t) => {
+  const filename = "simple.json";
+  const geojson = loadJsonFileSync(directories.in + filename);
+
+  const start = geojson.features.shift();
+  const end = geojson.features.shift();
+  const obstacle = geojson.features.shift();
+
+  const path = truncate(
+    shortestPath(start, end, {
+      obstacles: obstacle,
+    })
+  );
+  path.properties["stroke"] = "#F00";
+  path.properties["stroke-width"] = 5;
+
+  const results = featureCollection([]);
+  results.features.push(obstacle);
+  results.features.push(point(getCoord(start), start.properties));
+  results.features.push(point(getCoord(end), end.properties));
+  results.features.push(path);
+
+  t.deepEqual(results, loadJsonFileSync(directories.out + filename), "simple");
+  t.end();
+});

packages/turf-shortest-path/types.ts

@@ -1,11 +1,22 @@
-import { point, featureCollection, polygon } from "@turf/helpers";
+import { point, feature, featureCollection, polygon } from "@turf/helpers";
 import { shortestPath } from "./index.js";
 
 const start = point([-5, -6]);
 const end = point([9, -6]);
 
 shortestPath(start.geometry, end.geometry.coordinates);
 shortestPath(start, end);
+shortestPath(start, end, {
+  obstacles: polygon([
+    [
+      [0, -7],
+      [5, -7],
+      [5, -3],
+      [0, -3],
+      [0, -7],
+    ],
+  ]).geometry,
+});
 shortestPath(start, end, {
   obstacles: polygon([
     [