feat(tile): add geojson

Cargo.toml

@@ -12,7 +12,5 @@ documentation = "https://docs.rs/supercluster"
 repository = "https://github.com/chargetrip/supercluster-rust"
 
 [dependencies]
-serde = { version = "1.0.193", features = ["derive"] }
-
-[dev-dependencies]
-serde_json = "1.0.108"
+geojson = "0.24.1"
+serde_json = "1.0.113"

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Chargetrip
+Copyright (c) 2024 Chargetrip
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -16,11 +16,11 @@ This crate is deeply inspired by Mapbox's supercluster [JS package](https://www.
 
 ## Features
 
-- `load(points)`: Loads an array of [GeoJSON Feature](https://tools.ietf.org/html/rfc7946#section-3.2) objects. Each feature's `geometry` must be a [GeoJSON Point](https://tools.ietf.org/html/rfc7946#section-3.1.2).
+- `load(points)`: Loads a [FeatureCollection](https://datatracker.ietf.org/doc/html/rfc7946#section-3.3) Object. Each feature should be a [Feature Object](https://datatracker.ietf.org/doc/html/rfc7946#section-3.2).
 
-- `get_clusters(bbox, zoom)`: For the given `bbox` array (`[west_lng, south_lat, east_lng, north_lat]`) and `zoom`, returns an array of clusters and points as [GeoJSON Feature](https://tools.ietf.org/html/rfc7946#section-3.2) objects.
+- `get_clusters(bbox, zoom)`: For the given `bbox` array (`[west_lng, south_lat, east_lng, north_lat]`) and `zoom`, returns an array of clusters and points as [Feature Object](https://datatracker.ietf.org/doc/html/rfc7946#section-3.2) objects.
 
-- `get_tile(z, x, y)`: For a given zoom and x/y coordinates, returns a [geojson-vt](https://github.com/mapbox/geojson-vt)-compatible JSON tile object with cluster/point features.
+- `get_tile(z, x, y)`: For a given zoom and x/y coordinates, returns a [FeatureCollection](https://datatracker.ietf.org/doc/html/rfc7946#section-3.3) Object.
 
 - `get_children(cluster_id)`: Returns the children of a cluster (on the next zoom level) given its id (`cluster_id` value from feature properties).
 
@@ -58,8 +58,7 @@ cargo add supercluster
 ```
 
 ```rust
-extern crate supercluster;
-
+use geojson::FeatureCollection;
 use supercluster::{ Supercluster, Options };
 
 fn main() {
@@ -75,11 +74,18 @@ fn main() {
   // Create a new instance with the specified configuration settings
   let mut cluster = Supercluster::new(options);
 
-  // Load the input GeoJSON points into the Supercluster instance
-  let points = Vec::new(); // your points
-  let index = cluster.load(points);
+  // Load a FeatureCollection Object into the Supercluster instance
+
+  // [GeoJSON Format Specification § 5](https://tools.ietf.org/html/rfc7946#section-5)
+  let feature_collection = FeatureCollection {
+    bbox: None,
+    // [GeoJSON Format Specification § 3.2](https://datatracker.ietf.org/doc/html/rfc7946#section-3.2)
+    features: vec![],
+    foreign_members: None,
+  };
+  let index = cluster.load(feature_collection);
 
-  // Retrieve a vector of features within a tile at the given zoom level and tile coordinates
+  // Retrieve a FeatureCollection Object within a tile at the given zoom level and tile coordinates
   let tile = index.get_tile(0, 0.0, 0.0).expect("cannot get a tile");
 
   ...
@@ -106,7 +112,7 @@ Run [clippy](https://github.com/rust-lang/rust-clippy):
 cargo clippy --all-targets --all-features -- -D warnings
 ```
 
-Run [lint](https://github.com/rust-lang/rustfmt):
+Run [rustfmt](https://github.com/rust-lang/rustfmt):
 
 ```bash
 cargo fmt

src/kdbush.rs

@@ -1,22 +1,22 @@
-/// Array of coordinates with longitude as first value and latitude as second one
+/// Array of coordinates with longitude as first value and latitude as second one.
 type Point = [f64; 2];
 
-/// A very fast static spatial index for 2D points based on a flat KD-tree
+/// A very fast static spatial index for 2D points based on a flat KD-tree.
 #[derive(Clone, Debug)]
 pub struct KDBush {
-    /// Node size for the KD-tree. Determines the number of points in a leaf node
+    /// Node size for the KD-tree. Determines the number of points in a leaf node.
     pub node_size: usize,
 
-    /// A list of point IDs used to reference points in the KD-tree
+    /// A list of point IDs used to reference points in the KD-tree.
     pub ids: Vec<usize>,
 
-    /// A flat array containing the X and Y coordinates of all points in interleaved order
+    /// A flat array containing the X and Y coordinates of all points in interleaved order.
     pub coords: Vec<f64>,
 
-    /// A list of 2D points represented as an array of [longitude, latitude] coordinates
+    /// A list of 2D points represented as an array of [longitude, latitude] coordinates.
     pub points: Vec<Point>,
 
-    /// A list of additional data associated with the points (e.g., properties)
+    /// A list of additional data associated with the points (e.g., properties).
     pub data: Vec<f64>,
 }