// Type definitions for supercluster 3.0
// Project: https://github.com/mapbox/supercluster
// Definitions by: Denis Carriere <https://github.com/DenisCarriere>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

import * as GeoJSON from 'geojson';

export as namespace supercluster;

export interface Options {
    /**
     * Minimum zoom level at which clusters are generated.
     */
    minZoom?: number;
    /**
     * Maximum zoom level at which clusters are generated.
     */
    maxZoom?: number;
    /**
     * Cluster radius, in pixels.
     */
    radius?: number;
    /**
     * (Tiles) Tile extent. Radius is calculated relative to this value.
     */
    extent?: number;
    /**
     * Size of the KD-tree leaf node. Affects performance.
     */
    nodeSize?: number;
    /**
     * Whether timing info should be logged.
     */
    log?: boolean;
    /**
     * a reduce function for calculating custom cluster properties
     *
     * @example
     * function (accumulated, props) { accumulated.sum += props.sum; }
     */
    reduce?: (accumulated: any, props: any) => void;
    /**
     * initial properties of a cluster (before running the reducer)
     *
     * @example
     * function () { return {sum: 0}; }
     */
    initial?: () => any;
    /**
     * properties to use for individual points when running the reducer
     *
     * @example
     * function (props) { return {sum: props.my_value}; }
     */
    map?: (props: any) => any;
}

export class Supercluster {
    /**
     * Loads an array of GeoJSON.Feature objects. Each feature's geometry must be a GeoJSON.Point. Once loaded, index is immutable.
     */
    load(points: Points): Supercluster;
    /**
     * For the given bbox array ([westLng, southLat, eastLng, northLat]) and integer zoom, returns an array of clusters and points as GeoJSON.Feature objects.
     */
    getClusters(bbox: BBox, zoom: number): Clusters;

    /**
     * For a given zoom and x/y coordinates, returns a geojson-vt-compatible JSON tile object with cluster/point features.
     */
    getTile(z: number, x: number, y: number): Tile;

    /**
     * Returns the children of a cluster (on the next zoom level) given its id (cluster_id value from feature properties) and zoom the cluster was from.
     */
    getChildren(clusterId: number, clusterZoom: number): Clusters;

    /**
     * Returns all the points of a cluster (given its cluster_id and zoom),
     * with pagination support: limit is the number of points to return (set to Infinity for all points),
     * and offset is the amount of points to skip (for pagination).
     */
    getLeaves(clusterId: number, clusterZoom: number, limit?: number, offset?: number): Clusters;

    /**
     * Returns the zoom on which the cluster expands into several children (useful for "click to zoom" feature), given the cluster's cluster_id and zoom.
     */
    getClusterExpansionZoom(clusterId: number, clusterZoom: number): number;
}

/**
 * A very fast JavaScript library for geospatial point clustering for browsers and Node.
 */
export default function supercluster(options: Options): Supercluster;

export type Point = GeoJSON.Feature<GeoJSON.Point>;
export type Points = Point[];
export type Clusters = Cluster[];
export type TileFeatures = TileFeature[];
export type BBox = [number, number, number, number];
export interface ClusterProperties {
    cluster?: boolean;
    cluster_id?: number;
    point_count?: number;
    point_count_abbreviated?: number;
    sum?: number;
    [key: string]: any;
}
export interface Cluster extends Point {
    properties: ClusterProperties;
}
export interface TileFeature {
    type: 1;
    geometry: Array<[number, number]>;
    tags: ClusterProperties;
}
export interface Tile {
    features: TileFeatures;
}