Enable typescript strict mode (#2126)

* bezier-spline * clusters-dbscan and clusters-kmeans, but they both need new DefinitelyTyped updates * kind of speculative fixes for polygonize * Enforce strict mode * turf-clusters-kmeans by way of skmeans types * types Co-authored-by: Matt Fedderly <[email protected]>
Turfjs · Jun 23, 2021 · 3249a8b · 3249a8b
1 parent dde1570
commit 3249a8b
Show file tree

Hide file tree

Showing 16 changed files with 112 additions and 77 deletions.
diff --git a/packages/turf-bezier-spline/index.ts b/packages/turf-bezier-spline/index.ts
@@ -44,7 +44,7 @@ function bezier<P = Properties>(
   const resolution = options.resolution || 10000;
   const sharpness = options.sharpness || 0.85;
 
-  const coords = [];
+  const coords: [number, number][] = [];
   const points = getGeom(line).coordinates.map((pt) => {
     return { x: pt[0], y: pt[1] };
   });

diff --git a/packages/turf-boolean-equal/package.json b/packages/turf-boolean-equal/package.json
@@ -52,6 +52,7 @@
     "test:tape": "ts-node -r esm test.js"
   },
   "devDependencies": {
+    "@types/geojson-equality": "^0.2.0",
     "@types/tape": "*",
     "benchmark": "*",
     "boolean-shapely": "*",

diff --git a/packages/turf-boolean-overlap/index.ts b/packages/turf-boolean-overlap/index.ts
@@ -48,7 +48,7 @@ export default function booleanOverlap(
 
   // features must be not equal
   const equality = new GeojsonEquality({ precision: 6 });
-  if (equality.compare(feature1, feature2)) return false;
+  if (equality.compare(feature1 as any, feature2 as any)) return false;
 
   let overlap = 0;
 

diff --git a/packages/turf-boolean-overlap/package.json b/packages/turf-boolean-overlap/package.json
@@ -51,6 +51,7 @@
     "test:tape": "ts-node -r esm test.js"
   },
   "devDependencies": {
+    "@types/geojson-equality": "^0.2.0",
     "@types/tape": "*",
     "benchmark": "*",
     "boolean-shapely": "*",

diff --git a/packages/turf-clusters-dbscan/index.ts b/packages/turf-clusters-dbscan/index.ts
@@ -11,10 +11,10 @@ import {
 import clustering from "density-clustering";
 
 export type Dbscan = "core" | "edge" | "noise";
-export interface DbscanProps extends Properties {
+export type DbscanProps = Properties & {
   dbscan?: Dbscan;
   cluster?: number;
-}
+};
 
 /**
  * Takes a set of {@link Point|points} and partition them into clusters according to {@link DBSCAN's|https://en.wikipedia.org/wiki/DBSCAN} data clustering algorithm.
@@ -91,7 +91,7 @@ function clustersDbscan(
     else noisePoint.properties.dbscan = "noise";
   });
 
-  return points;
+  return points as FeatureCollection<Point, DbscanProps>;
 }
 
 export default clustersDbscan;
diff --git a/packages/turf-clusters-dbscan/package.json b/packages/turf-clusters-dbscan/package.json
@@ -56,6 +56,7 @@
   "devDependencies": {
     "@turf/centroid": "^6.4.0",
     "@turf/clusters": "^6.4.0",
+    "@types/density-clustering": "^1.3.0",
     "@types/tape": "*",
     "benchmark": "*",
     "chromatism": "*",

diff --git a/packages/turf-clusters-kmeans/index.ts b/packages/turf-clusters-kmeans/index.ts
@@ -55,11 +55,7 @@ function clustersKmeans(
   var initialCentroids = data.slice(0, options.numberOfClusters);
 
   // create skmeans clusters
-  var skmeansResult = skmeans(
-    data,
-    options.numberOfClusters,
-    initialCentroids as any // typings are slightly wrong here
-  );
+  var skmeansResult = skmeans(data, options.numberOfClusters, initialCentroids);
 
   // store centroids {clusterId: [number, number]}
   var centroids: Record<string, number[]> = {};

diff --git a/packages/turf-clusters-kmeans/package.json b/packages/turf-clusters-kmeans/package.json
@@ -56,6 +56,7 @@
     "@turf/centroid": "^6.4.0",
     "@turf/clusters": "^6.4.0",
     "@turf/random": "^6.4.0",
+    "@types/skmeans": "^0.11.2",
     "@types/tape": "*",
     "benchmark": "*",
     "chromatism": "*",

diff --git a/packages/turf-polygonize/index.ts b/packages/turf-polygonize/index.ts
@@ -39,8 +39,8 @@ export default function polygonize<T extends LineString | MultiLineString>(
   graph.deleteCutEdges();
 
   // 3. Get all holes and shells
-  const holes = [],
-    shells = [];
+  const holes: EdgeRing[] = [],
+    shells: EdgeRing[] = [];
 
   graph
     .getEdgeRings()

diff --git a/packages/turf-polygonize/lib/Edge.ts b/packages/turf-polygonize/lib/Edge.ts
@@ -7,12 +7,12 @@ import EdgeRing from "./EdgeRing";
  * This class is inspired by GEOS's geos::operation::polygonize::PolygonizeDirectedEdge
  */
 export default class Edge {
-  public label: number;
-  public symetric: Edge;
+  public label?: number;
+  public symetric?: Edge;
   public from: Node;
   public to: Node;
-  public next: Edge;
-  public ring: EdgeRing;
+  public next?: Edge;
+  public ring?: EdgeRing;
 
   /**
    * Creates or get the symetric Edge.
@@ -32,7 +32,7 @@ export default class Edge {
    * @param {Node} from - start node of the Edge
    * @param {Node} to - end node of the edge
    */
-  constructor(from, to) {
+  constructor(from: Node, to: Node) {
     this.from = from; //< start
     this.to = to; //< End
 
@@ -61,7 +61,7 @@ export default class Edge {
    * @param {Edge} edge - Another Edge
    * @returns {boolean} - True if Edges are equal, False otherwise
    */
-  isEqual(edge) {
+  isEqual(edge: Edge) {
     return this.from.id === edge.from.id && this.to.id === edge.to.id;
   }
 
@@ -88,7 +88,7 @@ export default class Edge {
    *          0 if the Edges are colinear,
    *          1 otherwise
    */
-  compareTo(edge) {
+  compareTo(edge: Edge) {
     return orientationIndex(
       edge.from.coordinates,
       edge.to.coordinates,

diff --git a/packages/turf-polygonize/lib/EdgeRing.ts b/packages/turf-polygonize/lib/EdgeRing.ts
@@ -4,7 +4,15 @@ import {
   envelopeContains,
   coordinatesEqual,
 } from "./util";
-import { multiPoint, polygon, point, Polygon, Feature } from "@turf/helpers";
+import {
+  multiPoint,
+  polygon,
+  point,
+  Polygon,
+  Feature,
+  Point,
+  Position,
+} from "@turf/helpers";
 import envelope from "@turf/envelope";
 import booleanPointInPolygon from "@turf/boolean-point-in-polygon";
 import Edge from "./Edge";
@@ -18,13 +26,13 @@ import Edge from "./Edge";
  */
 export default class EdgeRing {
   private edges: Edge[];
-  private polygon: Feature<
+  private polygon?: Feature<
     Polygon,
     {
       [name: string]: any;
     }
   >;
-  private envelope: Feature<
+  private envelope?: Feature<
     Polygon,
     {
       [name: string]: any;
@@ -43,9 +51,7 @@ export default class EdgeRing {
    * @memberof EdgeRing
    * @param {Edge} edge - Edge to be inserted
    */
-  push(edge) {
-    // Emulate Array getter ([]) behaviour
-    this[this.edges.length] = edge;
+  push(edge: Edge) {
     this.edges.push(edge);
     this.polygon = this.envelope = undefined;
   }
@@ -57,7 +63,7 @@ export default class EdgeRing {
    * @param {number} i - Index
    * @returns {Edge} - Edge in the i position
    */
-  get(i) {
+  get(i: number) {
     return this.edges[i];
   }
 
@@ -77,7 +83,7 @@ export default class EdgeRing {
    * @memberof EdgeRing
    * @param {Function} f - The same function to be passed to Array.prototype.forEach
    */
-  forEach(f) {
+  forEach(f: (edge: Edge, index: number, array: Edge[]) => void) {
     this.edges.forEach(f);
   }
 
@@ -88,7 +94,7 @@ export default class EdgeRing {
    * @param {Function} f - The same function to be passed to Array.prototype.map
    * @returns {Array} - The mapped values in the function
    */
-  map(f) {
+  map<T>(f: (edge: Edge, index: number, array: Edge[]) => T): T[] {
     return this.edges.map(f);
   }
 
@@ -99,7 +105,7 @@ export default class EdgeRing {
    * @param {Function} f - The same function to be passed to Array.prototype.some
    * @returns {boolean} - True if an Edge check the condition
    */
-  some(f) {
+  some(f: (edge: Edge, index: number, array: Edge[]) => boolean) {
     return this.edges.some(f);
   }
 
@@ -182,7 +188,10 @@ export default class EdgeRing {
    */
   getEnvelope() {
     if (this.envelope) return this.envelope;
-    return (this.envelope = envelope(this.toPolygon()));
+    return (this.envelope = envelope(this.toPolygon()) as Feature<
+      Polygon,
+      { [name: string]: any }
+    >);
   }
 
   /**
@@ -193,10 +202,13 @@ export default class EdgeRing {
    *
    * @returns {EdgeRing} - EdgeRing which contains the testEdgeRing
    */
-  static findEdgeRingContaining(testEdgeRing, shellList) {
+  static findEdgeRingContaining(
+    testEdgeRing: EdgeRing,
+    shellList: EdgeRing[]
+  ): EdgeRing | undefined {
     const testEnvelope = testEdgeRing.getEnvelope();
 
-    let minEnvelope, minShell;
+    let minEnvelope: Feature<Polygon>, minShell: EdgeRing | undefined;
     shellList.forEach((shell) => {
       const tryEnvelope = shell.getEnvelope();
 
@@ -206,12 +218,18 @@ export default class EdgeRing {
       if (envelopeIsEqual(tryEnvelope, testEnvelope)) return;
 
       if (envelopeContains(tryEnvelope, testEnvelope)) {
-        const testPoint = testEdgeRing
-          .map((edge) => edge.from.coordinates)
-          .find(
-            (pt) =>
-              !shell.some((edge) => coordinatesEqual(pt, edge.from.coordinates))
-          );
+        const testEdgeRingCoordinates = testEdgeRing.map(
+          (edge) => edge.from.coordinates
+        );
+
+        let testPoint: Position | undefined;
+        for (const pt of testEdgeRingCoordinates) {
+          if (
+            !shell.some((edge) => coordinatesEqual(pt, edge.from.coordinates))
+          ) {
+            testPoint = pt;
+          }
+        }
 
         if (testPoint && shell.inside(point(testPoint))) {
           if (!minShell || envelopeContains(minEnvelope, tryEnvelope))
@@ -229,7 +247,7 @@ export default class EdgeRing {
    * @param {Feature<Point>} pt - Point to check if it is inside the edgeRing
    * @returns {boolean} - True if it is inside, False otherwise
    */
-  inside(pt) {
+  inside(pt: Feature<Point>) {
     return booleanPointInPolygon(pt, this.toPolygon());
   }
 }
diff --git a/packages/turf-polygonize/lib/Graph.ts b/packages/turf-polygonize/lib/Graph.ts
@@ -8,6 +8,7 @@ import {
   LineString,
   MultiLineString,
   Feature,
+  GeoJSONObject,
 } from "@turf/helpers";
 
 /**
@@ -16,7 +17,7 @@ import {
  * @param {GeoJSON} geoJson - input geoJson.
  * @throws {Error} if geoJson is invalid.
  */
-function validateGeoJson(geoJson) {
+function validateGeoJson(geoJson: GeoJSONObject) {
   if (!geoJson) throw new Error("No geojson passed");
 
   if (
@@ -153,8 +154,8 @@ export default class Graph {
 
     // Cut-edges (bridges) are edges where both edges have the same label
     this.edges.forEach((edge) => {
-      if (edge.label === edge.symetric.label) {
-        this.removeEdge(edge.symetric);
+      if (edge.label === edge.symetric!.label) {
+        this.removeEdge(edge.symetric!);
         this.removeEdge(edge);
       }
     });
@@ -177,7 +178,7 @@ export default class Graph {
       node.getOuterEdges().forEach((edge, i) => {
         node.getOuterEdge(
           (i === 0 ? node.getOuterEdges().length : i) - 1
-        ).symetric.next = edge;
+        ).symetric!.next = edge;
       });
     }
   }
@@ -205,7 +206,7 @@ export default class Graph {
 
       if (de.label === label) outDE = de;
 
-      if (sym.label === label) inDE = sym;
+      if (sym!.label === label) inDE = sym;
 
       if (!outDE || !inDE)
         // This edge is not in edgering
@@ -234,17 +235,17 @@ export default class Graph {
    * @returns {Edge[]} edges that start rings
    */
   _findLabeledEdgeRings() {
-    const edgeRingStarts = [];
+    const edgeRingStarts: Edge[] = [];
     let label = 0;
     this.edges.forEach((edge) => {
-      if (edge.label >= 0) return;
+      if (edge.label! >= 0) return;
 
       edgeRingStarts.push(edge);
 
       let e = edge;
       do {
         e.label = label;
-        e = e.next;
+        e = e.next!;
       } while (!edge.isEqual(e));
 
       label++;
@@ -269,11 +270,11 @@ export default class Graph {
     this._findLabeledEdgeRings().forEach((edge) => {
       // convertMaximalToMinimalEdgeRings
       this._findIntersectionNodes(edge).forEach((node) => {
-        this._computeNextCCWEdges(node, edge.label);
+        this._computeNextCCWEdges(node, edge.label!);
       });
     });
 
-    const edgeRingList = [];
+    const edgeRingList: EdgeRing[] = [];
 
     // find all edgerings
     this.edges.forEach((edge) => {
@@ -302,7 +303,7 @@ export default class Graph {
 
       if (degree > 1) intersectionNodes.push(edge.from);
 
-      edge = edge.next;
+      edge = edge.next!;
     } while (!startEdge.isEqual(edge));
 
     return intersectionNodes;
@@ -321,7 +322,7 @@ export default class Graph {
     do {
       edgeRing.push(edge);
       edge.ring = edgeRing;
-      edge = edge.next;
+      edge = edge.next!;
     } while (!startEdge.isEqual(edge));
 
     return edgeRing;