@maptiler/sdk 1.1.2 → 1.2.0

package/dist/maptiler-sdk.d.ts

@@ -1,14 +1,36 @@
 import * as maplibre_gl from 'maplibre-gl';
-import maplibre_gl__default, { MapOptions as MapOptions$1, StyleSpecification, ControlPosition, StyleOptions, RequestTransformFunction, Map as Map$1, LogoOptions as LogoOptions$1 } from 'maplibre-gl';
+import maplibre_gl__default, { StyleSpecification, ControlPosition, LineLayerSpecification, FillLayerSpecification, MapOptions as MapOptions$1, StyleSwapOptions, StyleOptions, LayerSpecification, SourceSpecification, CustomLayerInterface, FilterSpecification, StyleSetterOptions, RequestTransformFunction, Map as Map$1, LogoOptions as LogoOptions$1, IControl } from 'maplibre-gl';
 export * from 'maplibre-gl';
 import { FetchFunction, ReferenceMapStyle, MapStyleVariant } from '@maptiler/client';
 export { AutomaticStaticMapOptions, BBox, BoundedStaticMapOptions, CenteredStaticMapOptions, CoordinatesSearchOptions, GeocodingOptions, LanguageGeocoding, LanguageGeocodingString, MapStyle, MapStyleType, MapStyleVariant, Position, ReferenceMapStyle, ServiceError, coordinates, data, geocoding, geolocation, staticMaps } from '@maptiler/client';
 import EventEmitter from 'events';
+import { FeatureCollection } from 'geojson';
 
 /**
  * Languages. Note that not all the languages of this list are available but the compatibility list may be expanded in the future.
  */
 declare const Language: {
+    /**
+     * The visitor language mode concatenates the prefered language from the user settings and the "default name".
+     * Note: The "default name" is equivalent to OSM's `{name}`, which can be the most recognized names a global
+     * scale or the local name.
+     * This mode is helpful in the context where a user needs to access both the local names and the names in their
+     * own language, for instance when traveling abroad, where signs likely to be only available in the local language.
+     */
+    readonly VISITOR: "visitor";
+    /**
+     * The visitor language mode concatenates English and the "default name".
+     * Note: The "default name" is equivalent to OSM's `{name}`, which can be the most recognized names a global
+     * scale or the local name.
+     * This mode is helpful in the context where a user needs to access both the local names and the names in their
+     * own language, for instance when traveling abroad, where signs likely to be only available in the local language.
+     */
+    readonly VISITOR_ENGLISH: "visitor_en";
+    /**
+     * Language as the style is designed. Not that this is the default state and one
+     * the language has been changed to another than `STYLE`, then it cannot be set back to `STYLE`.
+     */
+    readonly STYLE: "style";
     /**
      * AUTO mode uses the language of the browser
      */
@@ -22,85 +44,97 @@ declare const Language: {
     /**
      * Default fallback languages that uses latin charaters
      */
-    readonly LATIN: "latin";
+    readonly LATIN: "name:latin";
     /**
      * Default fallback languages that uses non-latin charaters
      */
-    readonly NON_LATIN: "nonlatin";
+    readonly NON_LATIN: "name:nonlatin";
     /**
      * Labels are in their local language, when available
      */
-    readonly LOCAL: "";
-    readonly ALBANIAN: "sq";
-    readonly AMHARIC: "am";
-    readonly ARABIC: "ar";
-    readonly ARMENIAN: "hy";
-    readonly AZERBAIJANI: "az";
-    readonly BASQUE: "eu";
-    readonly BELORUSSIAN: "be";
-    readonly BOSNIAN: "bs";
-    readonly BRETON: "br";
-    readonly BULGARIAN: "bg";
-    readonly CATALAN: "ca";
-    readonly CHINESE: "zh";
-    readonly CORSICAN: "co";
-    readonly CROATIAN: "hr";
-    readonly CZECH: "cs";
-    readonly DANISH: "da";
-    readonly DUTCH: "nl";
-    readonly ENGLISH: "en";
-    readonly ESPERANTO: "eo";
-    readonly ESTONIAN: "et";
-    readonly FINNISH: "fi";
-    readonly FRENCH: "fr";
-    readonly FRISIAN: "fy";
-    readonly GEORGIAN: "ka";
-    readonly GERMAN: "de";
-    readonly GREEK: "el";
-    readonly HEBREW: "he";
-    readonly HINDI: "hi";
-    readonly HUNGARIAN: "hu";
-    readonly ICELANDIC: "is";
-    readonly INDONESIAN: "id";
-    readonly IRISH: "ga";
-    readonly ITALIAN: "it";
-    readonly JAPANESE: "ja";
-    readonly JAPANESE_HIRAGANA: "ja-Hira";
-    readonly JAPANESE_KANA: "ja_kana";
-    readonly JAPANESE_LATIN: "ja_rm";
-    readonly JAPANESE_2018: "ja-Latn";
-    readonly KANNADA: "kn";
-    readonly KAZAKH: "kk";
-    readonly KOREAN: "ko";
-    readonly KOREAN_LATIN: "ko-Latn";
-    readonly KURDISH: "ku";
-    readonly ROMAN_LATIN: "la";
-    readonly LATVIAN: "lv";
-    readonly LITHUANIAN: "lt";
-    readonly LUXEMBOURGISH: "lb";
-    readonly MACEDONIAN: "mk";
-    readonly MALAYALAM: "ml";
-    readonly MALTESE: "mt";
-    readonly NORWEGIAN: "no";
-    readonly OCCITAN: "oc";
-    readonly POLISH: "pl";
-    readonly PORTUGUESE: "pt";
-    readonly ROMANIAN: "ro";
-    readonly ROMANSH: "rm";
-    readonly RUSSIAN: "ru";
-    readonly SCOTTISH_GAELIC: "gd";
-    readonly SERBIAN_CYRILLIC: "sr";
-    readonly SERBIAN_LATIN: "sr-Latn";
-    readonly SLOVAK: "sk";
-    readonly SLOVENE: "sl";
-    readonly SPANISH: "es";
-    readonly SWEDISH: "sv";
-    readonly TAMIL: "ta";
-    readonly TELUGU: "te";
-    readonly THAI: "th";
-    readonly TURKISH: "tr";
-    readonly UKRAINIAN: "uk";
-    readonly WELSH: "cy";
+    readonly LOCAL: "name";
+    /**
+     * International name
+     */
+    readonly INTERNATIONAL: "name_int";
+    readonly ALBANIAN: "name:sq";
+    readonly AMHARIC: "name:am";
+    readonly ARABIC: "name:ar";
+    readonly ARMENIAN: "name:hy";
+    readonly AZERBAIJANI: "name:az";
+    readonly BASQUE: "name:eu";
+    readonly BELORUSSIAN: "name:be";
+    readonly BENGALI: "name:bn";
+    readonly BOSNIAN: "name:bs";
+    readonly BRETON: "name:br";
+    readonly BULGARIAN: "name:bg";
+    readonly CATALAN: "name:ca";
+    readonly CHINESE: "name:zh";
+    readonly TRADITIONAL_CHINESE: "name:zh-Hant";
+    readonly SIMPLIFIED_CHINESE: "name:zh-Hans";
+    readonly CORSICAN: "name:co";
+    readonly CROATIAN: "name:hr";
+    readonly CZECH: "name:cs";
+    readonly DANISH: "name:da";
+    readonly DUTCH: "name:nl";
+    readonly ENGLISH: "name:en";
+    readonly ESPERANTO: "name:eo";
+    readonly ESTONIAN: "name:et";
+    readonly FINNISH: "name:fi";
+    readonly FRENCH: "name:fr";
+    readonly FRISIAN: "name:fy";
+    readonly GEORGIAN: "name:ka";
+    readonly GERMAN: "name:de";
+    readonly GREEK: "name:el";
+    readonly HEBREW: "name:he";
+    readonly HINDI: "name:hi";
+    readonly HUNGARIAN: "name:hu";
+    readonly ICELANDIC: "name:is";
+    readonly INDONESIAN: "name:id";
+    readonly IRISH: "name:ga";
+    readonly ITALIAN: "name:it";
+    readonly JAPANESE: "name:ja";
+    readonly JAPANESE_HIRAGANA: "name:ja-Hira";
+    readonly JAPANESE_KANA: "name:ja_kana";
+    readonly JAPANESE_LATIN: "name:ja_rm";
+    readonly JAPANESE_2018: "name:ja-Latn";
+    readonly KANNADA: "name:kn";
+    readonly KAZAKH: "name:kk";
+    readonly KOREAN: "name:ko";
+    readonly KOREAN_LATIN: "name:ko-Latn";
+    readonly KURDISH: "name:ku";
+    readonly ROMAN_LATIN: "name:la";
+    readonly LATVIAN: "name:lv";
+    readonly LITHUANIAN: "name:lt";
+    readonly LUXEMBOURGISH: "name:lb";
+    readonly MACEDONIAN: "name:mk";
+    readonly MALAYALAM: "name:ml";
+    readonly MALTESE: "name:mt";
+    readonly NORWEGIAN: "name:no";
+    readonly OCCITAN: "name:oc";
+    readonly PERSIAN: "name:fa";
+    readonly POLISH: "name:pl";
+    readonly PORTUGUESE: "name:pt";
+    readonly PUNJABI: "name:pa";
+    readonly WESTERN_PUNJABI: "name:pnb";
+    readonly ROMANIAN: "name:ro";
+    readonly ROMANSH: "name:rm";
+    readonly RUSSIAN: "name:ru";
+    readonly SCOTTISH_GAELIC: "name:gd";
+    readonly SERBIAN_CYRILLIC: "name:sr";
+    readonly SERBIAN_LATIN: "name:sr-Latn";
+    readonly SLOVAK: "name:sk";
+    readonly SLOVENE: "name:sl";
+    readonly SPANISH: "name:es";
+    readonly SWEDISH: "name:sv";
+    readonly TAMIL: "name:ta";
+    readonly TELUGU: "name:te";
+    readonly THAI: "name:th";
+    readonly TURKISH: "name:tr";
+    readonly UKRAINIAN: "name:uk";
+    readonly URDU: "name:ur";
+    readonly VIETNAMIAN_LATIN: "name:vi";
+    readonly WELSH: "name:cy";
 };
 /**
  * Type representing the key of the Language object
@@ -121,12 +155,12 @@ declare class SdkConfig extends EventEmitter {
     /**
      * The primary language. By default, the language of the web browser is used.
      */
-    primaryLanguage: LanguageString | null;
+    primaryLanguage: LanguageString;
     /**
      * The secondary language, to overwrite the default language defined in the map style.
      * This settings is highly dependant on the style compatibility and may not work in most cases.
      */
-    secondaryLanguage: LanguageString | null;
+    secondaryLanguage?: LanguageString;
     /**
      * Setting on whether of not the SDK runs with a session logic.
      * A "session" is started at the initialization of the SDK and finished when the browser
@@ -171,6 +205,41 @@ declare class SdkConfig extends EventEmitter {
 }
 declare const config: SdkConfig;
 
+/**
+ * This is an extension adds support for adding a minimap to one of the map's control containers.
+ */
+
+interface ParentRect {
+    lineLayout: LineLayerSpecification["layout"];
+    linePaint: LineLayerSpecification["paint"];
+    fillPaint: FillLayerSpecification["paint"];
+}
+interface MinimapOptionsInput {
+    /**
+     * Style of the map. Can be:
+     * - a full style URL (possibly with API key)
+     * - a shorthand with only the MapTIler style name (eg. `"streets-v2"`)
+     * - a longer form with the prefix `"maptiler://"` (eg. `"maptiler://streets-v2"`)
+     */
+    style?: ReferenceMapStyle | MapStyleVariant | StyleSpecification | string;
+    /**
+     * Set the zoom difference between the parent and the minimap
+     * If the parent is zoomed to 10 and the minimap is zoomed to 8, the zoomAdjust should be 2
+     * Default: -4
+     */
+    zoomAdjust?: number;
+    /** Set a zoom of the minimap and don't allow any future changes */
+    lockZoom?: number;
+    /** Adjust the pitch only if the user requests */
+    pitchAdjust?: boolean;
+    /** Set CSS properties of the container using object key-values */
+    containerStyle?: Record<string, string>;
+    /** Set the position of the minimap at either "top-left", "top-right", "bottom-left", or "bottom-right" */
+    position?: ControlPosition;
+    /** Set the parentRect fill and/or line options */
+    parentRect?: ParentRect;
+}
+
 type LoadWithTerrainEvent = {
     type: "loadWithTerrain";
     target: Map;
@@ -179,11 +248,6 @@ type LoadWithTerrainEvent = {
         exaggeration: number;
     };
 };
-type TransformStyleFunction = (previous: StyleSpecification, next: StyleSpecification) => StyleSpecification;
-type StyleSwapOptions = {
-    diff?: boolean;
-    transformStyle?: TransformStyleFunction;
-};
 declare const GeolocationType: {
     POINT: "POINT";
     COUNTRY: "COUNTRY";
@@ -249,6 +313,15 @@ type MapOptions = Omit<MapOptions$1, "style" | "maplibreLogo"> & {
      * Show the full screen control. (default: `false`, will show if `true`)
      */
     fullscreenControl?: boolean | ControlPosition;
+    /**
+     * Display a minimap in a user defined corner of the map. (default: `bottom-left` corner)
+     * If set to true, the map will assume it is a minimap and forego the attribution control.
+     */
+    minimap?: boolean | ControlPosition | MinimapOptionsInput;
+    /**
+     * attributionControl
+     */
+    forceNoAttributionControl?: boolean;
     /**
      * Method to position the map at a given geolocation. Only if:
      * - `hash` is `false`
@@ -277,9 +350,11 @@ declare class Map extends maplibre_gl__default.Map {
     private isTerrainEnabled;
     private terrainExaggeration;
     private primaryLanguage;
-    private secondaryLanguage;
     private terrainGrowing;
     private terrainFlattening;
+    private minimap?;
+    private forceLanguageUpdate;
+    private languageAlwaysBeenStyle;
     constructor(options: MapOptions);
     /**
      * Awaits for _this_ Map instance to be "loaded" and returns a Promise to the Map.
@@ -302,38 +377,138 @@ declare class Map extends maplibre_gl__default.Map {
      * - a full style URL (possibly with API key)
      * - a shorthand with only the MapTIler style name (eg. `"streets-v2"`)
      * - a longer form with the prefix `"maptiler://"` (eg. `"maptiler://streets-v2"`)
-     * @param style
-     * @param options
-     * @returns
      */
-    setStyle(style: ReferenceMapStyle | MapStyleVariant | StyleSpecification | string, options?: StyleSwapOptions & StyleOptions): this;
+    setStyle(style: null | ReferenceMapStyle | MapStyleVariant | StyleSpecification | string, options?: StyleSwapOptions & StyleOptions): this;
     /**
-     * Define the primary language of the map. Note that not all the languages shorthands provided are available.
-     * This function is a short for `.setPrimaryLanguage()`
-     * @param language
+     * Adds a [MapLibre style layer](https://maplibre.org/maplibre-style-spec/layers)
+     * to the map's style.
+     *
+     * A layer defines how data from a specified source will be styled. Read more about layer types
+     * and available paint and layout properties in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/layers).
+     *
+     * @param layer - The layer to add,
+     * conforming to either the MapLibre Style Specification's [layer definition](https://maplibre.org/maplibre-style-spec/layers) or,
+     * less commonly, the {@link CustomLayerInterface} specification.
+     * The MapLibre Style Specification's layer definition is appropriate for most layers.
+     *
+     * @param beforeId - The ID of an existing layer to insert the new layer before,
+     * resulting in the new layer appearing visually beneath the existing layer.
+     * If this argument is not specified, the layer will be appended to the end of the layers array
+     * and appear visually above all other layers.
+     *
+     * @returns `this`
      */
-    setLanguage(language?: LanguageString): any;
+    addLayer(layer: (LayerSpecification & {
+        source?: string | SourceSpecification;
+    }) | CustomLayerInterface, beforeId?: string): this;
+    /**
+     * Moves a layer to a different z-position.
+     *
+     * @param id - The ID of the layer to move.
+     * @param beforeId - The ID of an existing layer to insert the new layer before. When viewing the map, the `id` layer will appear beneath the `beforeId` layer. If `beforeId` is omitted, the layer will be appended to the end of the layers array and appear above all other layers on the map.
+     * @returns `this`
+     *
+     * @example
+     * Move a layer with ID 'polygon' before the layer with ID 'country-label'. The `polygon` layer will appear beneath the `country-label` layer on the map.
+     * ```ts
+     * map.moveLayer('polygon', 'country-label');
+     * ```
+     */
+    moveLayer(id: string, beforeId?: string): this;
+    /**
+     * Removes the layer with the given ID from the map's style.
+     *
+     * An {@link ErrorEvent} will be fired if the image parameter is invald.
+     *
+     * @param id - The ID of the layer to remove
+     * @returns `this`
+     *
+     * @example
+     * If a layer with ID 'state-data' exists, remove it.
+     * ```ts
+     * if (map.getLayer('state-data')) map.removeLayer('state-data');
+     * ```
+     */
+    removeLayer(id: string): this;
+    /**
+     * Sets the zoom extent for the specified style layer. The zoom extent includes the
+     * [minimum zoom level](https://maplibre.org/maplibre-style-spec/layers/#minzoom)
+     * and [maximum zoom level](https://maplibre.org/maplibre-style-spec/layers/#maxzoom))
+     * at which the layer will be rendered.
+     *
+     * Note: For style layers using vector sources, style layers cannot be rendered at zoom levels lower than the
+     * minimum zoom level of the _source layer_ because the data does not exist at those zoom levels. If the minimum
+     * zoom level of the source layer is higher than the minimum zoom level defined in the style layer, the style
+     * layer will not be rendered at all zoom levels in the zoom range.
+     */
+    setLayerZoomRange(layerId: string, minzoom: number, maxzoom: number): this;
+    /**
+     * Sets the filter for the specified style layer.
+     *
+     * Filters control which features a style layer renders from its source.
+     * Any feature for which the filter expression evaluates to `true` will be
+     * rendered on the map. Those that are false will be hidden.
+     *
+     * Use `setFilter` to show a subset of your source data.
+     *
+     * To clear the filter, pass `null` or `undefined` as the second parameter.
+     */
+    setFilter(layerId: string, filter?: FilterSpecification | null, options?: StyleSetterOptions): this;
+    /**
+     * Sets the value of a paint property in the specified style layer.
+     *
+     * @param layerId - The ID of the layer to set the paint property in.
+     * @param name - The name of the paint property to set.
+     * @param value - The value of the paint property to set.
+     * Must be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/).
+     * @param options - Options object.
+     * @returns `this`
+     * @example
+     * ```ts
+     * map.setPaintProperty('my-layer', 'fill-color', '#faafee');
+     * ```
+     */
+    setPaintProperty(layerId: string, name: string, value: any, options?: StyleSetterOptions): this;
+    /**
+     * Sets the value of a layout property in the specified style layer.
+     * Layout properties define how the layer is styled.
+     * Layout properties for layers of the same type are documented together.
+     * Layers of different types have different layout properties.
+     * See the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/) for the complete list of layout properties.
+     * @param layerId - The ID of the layer to set the layout property in.
+     * @param name - The name of the layout property to set.
+     * @param value - The value of the layout property to set.
+     * Must be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/).
+     * @param options - Options object.
+     * @returns `this`
+     */
+    setLayoutProperty(layerId: string, name: string, value: any, options?: StyleSetterOptions): this;
+    /**
+     * Sets the value of the style's glyphs property.
+     *
+     * @param glyphsUrl - Glyph URL to set. Must conform to the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/glyphs/).
+     * @param options - Options object.
+     * @returns `this`
+     * @example
+     * ```ts
+     * map.setGlyphs('https://demotiles.maplibre.org/font/{fontstack}/{range}.pbf');
+     * ```
+     */
+    setGlyphs(glyphsUrl: string | null, options?: StyleSetterOptions): this;
+    private getStyleLanguage;
     /**
      * Define the primary language of the map. Note that not all the languages shorthands provided are available.
-     * @param language
      */
-    setPrimaryLanguage(language?: LanguageString): void;
+    setLanguage(language: LanguageString | string): void;
     /**
-     * Define the secondary language of the map. Note that this is not supported by all the map styles
-     * Note that most styles do not allow a secondary language and this function only works if the style allows (no force adding)
-     * @param language
+     * Define the primary language of the map. Note that not all the languages shorthands provided are available.
      */
-    setSecondaryLanguage(language?: LanguageString): void;
+    private setPrimaryLanguage;
     /**
      * Get the primary language
      * @returns
      */
     getPrimaryLanguage(): LanguageString;
-    /**
-     * Get the secondary language
-     * @returns
-     */
-    getSecondaryLanguage(): LanguageString;
     /**
      * Get the exaggeration factor applied to the terrain
      * @returns
@@ -347,8 +522,6 @@ declare class Map extends maplibre_gl__default.Map {
     private growTerrain;
     /**
      * Enables the 3D terrain visualization
-     * @param exaggeration
-     * @returns
      */
     enableTerrain(exaggeration?: number): void;
     /**
@@ -361,14 +534,11 @@ declare class Map extends maplibre_gl__default.Map {
      * the method `.enableTerrain()` will be called.
      * If `animate` is `true`, the terrain transformation will be animated in the span of 1 second.
      * If `animate` is `false`, no animated transition to the newly defined exaggeration.
-     * @param exaggeration
-     * @param animate
      */
     setTerrainExaggeration(exaggeration: number, animate?: boolean): void;
     /**
      * Perform an action when the style is ready. It could be at the moment of calling this method
      * or later.
-     * @param cb
      */
     private onStyleReady;
     fitToIpBounds(): Promise<void>;
@@ -378,7 +548,6 @@ declare class Map extends maplibre_gl__default.Map {
      * Get the SDK config object.
      * This is convenient to dispatch the SDK configuration to externally built layers
      * that do not directly have access to the SDK configuration but do have access to a Map instance.
-     * @returns
      */
     getSdkConfig(): SdkConfig;
     /**
@@ -399,6 +568,10 @@ declare class Map extends maplibre_gl__default.Map {
      *  map.setTransformRequest((url: string, resourceType: string) => {});
      */
     setTransformRequest(transformRequest: RequestTransformFunction): this;
+    /**
+     * Loads an image. This is an async equivalent of `Map.loadImage`
+     */
+    loadImageAsync(url: string): Promise<HTMLImageElement | ImageBitmap | null | undefined>;
 }
 
 /**
@@ -551,10 +724,10 @@ declare class MaptilerGeolocateControl extends GeolocateControl {
      * @param {Position} position the Geolocation API Position
      * @private
      */
-    _updateCamera(position: GeolocationPosition): void;
-    _setupUI(supported: boolean): void;
+    _updateCamera: (position: GeolocationPosition) => void;
+    _setupUI: (supported: boolean) => void;
     _updateCircleRadius(): void;
-    _onZoom(): void;
+    _onZoom: () => void;
 }
 
 type LogoOptions = LogoOptions$1 & {
@@ -566,6 +739,7 @@ type LogoOptions = LogoOptions$1 & {
  * any link URL. By default this is using MapTiler logo and URL.
  */
 declare class MaptilerLogoControl extends LogoControl {
+    _compact: boolean;
     private logoURL;
     private linkURL;
     constructor(options?: LogoOptions);
@@ -576,7 +750,7 @@ declare class MaptilerLogoControl extends LogoControl {
  * A `MaptilerTerrainControl` control adds a button to turn terrain on and off
  * by triggering the terrain logic that is already deployed in the Map object.
  */
-declare class MaptilerTerrainControl implements maplibregl.IControl {
+declare class MaptilerTerrainControl implements IControl {
     _map: Map;
     _container: HTMLElement;
     _terrainButton: HTMLButtonElement;
@@ -588,18 +762,18 @@ declare class MaptilerTerrainControl implements maplibregl.IControl {
 }
 
 type HTMLButtonElementPlus = HTMLButtonElement & {
-    clickFunction: (e?: any) => unknown;
+    clickFunction: (e?: Event) => unknown;
 };
 declare class MaptilerNavigationControl extends NavigationControl {
     constructor();
     /**
      * Overloading: the button now stores its click callback so that we can later on delete it and replace it
      */
-    _createButton(className: string, fn: (e?: any) => unknown): HTMLButtonElementPlus;
+    _createButton(className: string, fn: (e?: Event) => unknown): HTMLButtonElementPlus;
     /**
      * Overloading: Limit how flat the compass icon can get
      */
-    _rotateCompassArrow(): void;
+    _rotateCompassArrow: () => void;
 }
 
 /**
@@ -612,8 +786,6 @@ declare class MaptilerNavigationControl extends NavigationControl {
 type Matrix2 = [number, number, number, number];
 /**
  * a point
- * @param x
- * @param y
  */
 declare class Point {
     x: number;
@@ -734,13 +906,13 @@ declare class Point {
      * @param {Point} other the other point
      * @return {boolean} whether the points are equal
      */
-    equals(other: any): boolean;
+    equals(other: Point): boolean;
     /**
      * Calculate the distance from this point to another point
      * @param {Point} p the other point
      * @return {Number} distance
      */
-    dist(p: any): number;
+    dist(p: Point): number;
     /**
      * Calculate the distance from this point to another point,
      * without the square root step. Useful if you're comparing
@@ -748,7 +920,7 @@ declare class Point {
      * @param {Point} p the other point
      * @return {Number} distance
      */
-    distSqr(p: any): number;
+    distSqr(p: Point): number;
     /**
      * Get the angle from the 0, 0 coordinate to this point, in radians
      * coordinates.
@@ -782,7 +954,919 @@ declare class Point {
     static convert(a: Point | Array<number>): Point;
 }
 
-declare const setRTLTextPlugin: (url: string, callback: (error?: Error) => void, deferred?: boolean) => void;
+interface Link {
+    href: string | null;
+}
+interface XMLProperties {
+    links?: Link[];
+}
+interface PlacemarkProperties {
+    name?: string;
+    address?: string;
+    styleUrl?: string;
+    description?: string;
+    styleHash?: string;
+    styleMapHash?: Record<string, string | null>;
+    timespan?: {
+        begin: string;
+        end: string;
+    };
+    timestamp?: string;
+    stroke?: string;
+    "stroke-opacity"?: number;
+    "stroke-width"?: number;
+    fill?: string;
+    "fill-opacity"?: number;
+    visibility?: string;
+    icon?: string;
+    coordTimes?: (string | null)[] | (string | null)[][];
+}
+/**
+ * create a function that converts a string to XML
+ * https://developer.mozilla.org/en-US/docs/Web/API/DOMParser
+ */
+declare function str2xml(str: string): Document;
+/**
+ * Check one of the top level child node is of a given type ("gpx", "kml").
+ * The check is not case sensitive.
+ * @param doc
+ * @param nodeName
+ * @returns
+ */
+declare function hasChildNodeWithName(doc: Document, nodeName: string): boolean;
+/**
+ * create a function that converts a XML to a string
+ * https://developer.mozilla.org/en-US/docs/Web/API/XMLSerializer
+ */
+declare function xml2str(node: Node): string;
+/**
+ * Given a XML document using the GPX spec, return GeoJSON
+ */
+declare function gpx(doc: string | Document): GeoJSON.FeatureCollection;
+/**
+ * Given a XML document using the KML spec, return GeoJSON
+ */
+declare function kml(doc: string | Document, xml2string?: (node: Node) => string): GeoJSON.FeatureCollection;
+declare function gpxOrKml(doc: string | Document): GeoJSON.FeatureCollection | null;
+
+type RgbaColor = [number, number, number] | [number, number, number, number];
+type ColorStop = {
+    /**
+     * The "value" at which this ColorStop should be applied.
+     */
+    value: number;
+    /**
+     * RGB[A] - Array of 3-4 numbers. 0-255 per channel.
+     */
+    color: RgbaColor;
+};
+/**
+ * A RGBA color as per the array definition
+ */
+type ArrayColor = [number, number, number, number];
+/**
+ * A color ramp stop as per array definition
+ */
+type ArrayColorRampStop = [
+    /**
+     * Real world value in a real world unit
+     */
+    number,
+    /**
+     * Color RGBA
+     */
+    ArrayColor
+];
+/**
+ * A color ramp as per array definition
+ */
+type ArrayColorRamp = Array<ArrayColorRampStop>;
+type ColorRampOptions = {
+    /**
+     * The value the colorramp starts
+     */
+    min?: number;
+    /**
+     * The value the colorramp ends
+     */
+    max?: number;
+    /**
+     * Some color stops to copy from
+     */
+    stops?: Array<ColorStop>;
+};
+declare class ColorRamp extends Array<ColorStop> {
+    /**
+     * Converts a array-definition color ramp definition into a usable ColorRamp instance.
+     * Note: units are not converted and may need to to be converted beforehand (eg. kelvin to centigrade)
+     * @param cr
+     * @returns
+     */
+    static fromArrayDefinition(cr: ArrayColorRamp): ColorRamp;
+    private min;
+    private max;
+    constructor(options?: ColorRampOptions);
+    setStops(stops: Array<ColorStop>, options?: {
+        clone?: boolean;
+    }): ColorRamp;
+    scale(min: number, max: number, options?: {
+        clone?: boolean;
+    }): ColorRamp;
+    at(pos: number): ColorStop;
+    clone(): ColorRamp;
+    getRawColorStops(): Array<ColorStop>;
+    reverse(options?: {
+        clone?: boolean;
+    }): ColorRamp;
+    getBounds(): {
+        min: number;
+        max: number;
+    };
+    getColor(value: number, options?: {
+        smooth?: boolean;
+    }): RgbaColor;
+    /**
+     * Get the color as an hexadecimal string
+     */
+    getColorHex(value: number, options?: {
+        smooth?: boolean;
+        withAlpha?: boolean;
+    }): string;
+    /**
+     * Get the color of the color ramp at a relative position in [0, 1]
+     */
+    getColorRelative(value: number, options?: {
+        smooth?: boolean;
+    }): RgbaColor;
+    getCanvasStrip(options?: {
+        horizontal?: boolean;
+        size?: number;
+        smooth?: boolean;
+    }): HTMLCanvasElement;
+    /**
+     * Apply a non-linear ressampling. This will create a new instance of ColorRamp with the same bounds.
+     */
+    resample(method: "ease-in-square" | "ease-out-square" | "ease-in-sqrt" | "ease-out-sqrt" | "ease-in-exp" | "ease-out-exp", samples?: number): ColorRamp;
+    /**
+     * Makes a clone of this color ramp that is fully transparant at the begining of their range
+     */
+    transparentStart(): ColorRamp;
+    /**
+     * Check if this color ramp has a transparent start
+     */
+    hasTransparentStart(): boolean;
+}
+/**
+ * This is a collection of built-in color ramps. They are all defined in the range [0, 1]
+ * but can be scaled or reversed to fit specific usages.
+ */
+declare const ColorRampCollection: {
+    /**
+     * A fully transparent [0, 0, 0, 0] colorramp to hide data.
+     * Defined in interval [0, 1], without unit.
+     */
+    NULL: ColorRamp;
+    GRAY: ColorRamp;
+    /**
+     * Classic jet color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    JET: ColorRamp;
+    /**
+     * Classic HSV color ramp (hue, saturation, value).
+     * Defined in interval [0, 1], without unit.
+     */
+    HSV: ColorRamp;
+    /**
+     * Classic hot color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    HOT: ColorRamp;
+    /**
+     * Classic spring color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    SPRING: ColorRamp;
+    /**
+     * Classic summer color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    SUMMER: ColorRamp;
+    /**
+     * Classic autommn color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    AUTOMN: ColorRamp;
+    /**
+     * Classic winter color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    WINTER: ColorRamp;
+    /**
+     * Classic bone color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    BONE: ColorRamp;
+    /**
+     * Classic copper color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    COPPER: ColorRamp;
+    /**
+     * Classic greys color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    GREYS: ColorRamp;
+    /**
+     * Classic yignbu color ramp (blue to light yellow).
+     * Defined in interval [0, 1], without unit.
+     */
+    YIGNBU: ColorRamp;
+    /**
+     * Classic greens color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    GREENS: ColorRamp;
+    /**
+     * Classic yiorrd color ramp (red to light yellow).
+     * Defined in interval [0, 1], without unit.
+     */
+    YIORRD: ColorRamp;
+    /**
+     * Classic blue-red color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    BLUERED: ColorRamp;
+    /**
+     * Classic rdbu color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    RDBU: ColorRamp;
+    /**
+     * Classic picnic color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    PICNIC: ColorRamp;
+    /**
+     * Classic rainbow color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    RAINBOW: ColorRamp;
+    /**
+     * Classic Portland color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    PORTLAND: ColorRamp;
+    /**
+     * Classic blackbody color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    BLACKBODY: ColorRamp;
+    /**
+     * Classic earth color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    EARTH: ColorRamp;
+    /**
+     * Classic electric color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    ELECTRIC: ColorRamp;
+    /**
+     * Classic viridis color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    VIRIDIS: ColorRamp;
+    /**
+     * Classic inferno color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    INFERNO: ColorRamp;
+    /**
+     * Classic magma color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    MAGMA: ColorRamp;
+    /**
+     * Classic plasma color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    PLASMA: ColorRamp;
+    /**
+     * Classic warm color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    WARM: ColorRamp;
+    /**
+     * Classic cool color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    COOL: ColorRamp;
+    /**
+     * Classic rainboz soft color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    RAINBOW_SOFT: ColorRamp;
+    /**
+     * Classic bathymetry color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    BATHYMETRY: ColorRamp;
+    /**
+     * Classic cdom color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    CDOM: ColorRamp;
+    /**
+     * Classic chlorophyll color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    CHLOROPHYLL: ColorRamp;
+    /**
+     * Classic density color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    DENSITY: ColorRamp;
+    /**
+     * Classic freesurface blue color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    FREESURFACE_BLUE: ColorRamp;
+    /**
+     * Classic freesurface red color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    FREESURFACE_RED: ColorRamp;
+    /**
+     * Classic oxygen color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    OXYGEN: ColorRamp;
+    /**
+     * Classic par color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    PAR: ColorRamp;
+    /**
+     * Classic phase color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    PHASE: ColorRamp;
+    /**
+     * Classic salinity color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    SALINITY: ColorRamp;
+    /**
+     * Classic temperature color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    TEMPERATURE: ColorRamp;
+    /**
+     * Classic turbidity color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    TURBIDITY: ColorRamp;
+    /**
+     * Classic velocity blue color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    VELOCITY_BLUE: ColorRamp;
+    /**
+     * Classic velocity green color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    VELOCITY_GREEN: ColorRamp;
+    /**
+     * Classic cube helix color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    CUBEHELIX: ColorRamp;
+    /**
+     * The cividis color ramp is color blind friendly.
+     * Read more here https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0199239
+     * Defined in interval [0, 1], without unit.
+     */
+    CIVIDIS: ColorRamp;
+    /**
+     * Classic turbo color ramp.
+     * This is a luminance-constant alternative to the jet, making it more
+     * clor-blind friendly.
+     * Defined in interval [0, 1], without unit.
+     */
+    TURBO: ColorRamp;
+    /**
+     * The rocket color ramp is perceptually uniform, which makes it more
+     * color bliend friendly than the classic magma color ramp.
+     * Defined in interval [0, 1], without unit.
+     */
+    ROCKET: ColorRamp;
+    /**
+     * The mako color ramp is perceptually uniform and can be seen as
+     * a color blind friendly alternative to bathymetry or yignbu.
+     * Defined in interval [0, 1], without unit.
+     */
+    MAKO: ColorRamp;
+};
+
+/**
+ * Array of string values that depend on zoom level
+ */
+type ZoomStringValues = Array<{
+    /**
+     * Zoom level
+     */
+    zoom: number;
+    /**
+     * Value for the given zoom level
+     */
+    value: string;
+}>;
+/**
+ *
+ * Array of number values that depend on zoom level
+ */
+type ZoomNumberValues = Array<{
+    /**
+     * Zoom level
+     */
+    zoom: number;
+    /**
+     * Value for the given zoom level
+     */
+    value: number;
+}>;
+type PropertyValues = Array<{
+    /**
+     * Value of the property (input)
+     */
+    propertyValue: number;
+    /**
+     * Value to associate it with (output)
+     */
+    value: number;
+}>;
+type CommonShapeLayerOptions = {
+    /**
+     * ID to give to the layer.
+     * If not provided, an auto-generated ID of the for "maptiler-layer-xxxxxx" will be auto-generated,
+     * with "xxxxxx" being a random string.
+     */
+    layerId?: string;
+    /**
+     * ID to give to the geojson source.
+     * If not provided, an auto-generated ID of the for "maptiler-source-xxxxxx" will be auto-generated,
+     * with "xxxxxx" being a random string.
+     */
+    sourceId?: string;
+    /**
+     * A geojson Feature collection or a URL to a geojson or the UUID of a MapTiler Cloud dataset.
+     */
+    data: FeatureCollection | string;
+    /**
+     * The ID of an existing layer to insert the new layer before, resulting in the new layer appearing
+     * visually beneath the existing layer. If this argument is not specified, the layer will be appended
+     * to the end of the layers array and appear visually above all other layers.
+     */
+    beforeId?: string;
+    /**
+     * Zoom level at which it starts to show.
+     * Default: `0`
+     */
+    minzoom?: number;
+    /**
+     * Zoom level after which it no longer show.
+     * Default: `22`
+     */
+    maxzoom?: number;
+    /**
+     * Whether or not to add an outline.
+     * Default: `false`
+     */
+    outline?: boolean;
+    /**
+     * Color of the outline. This is can be a constant color string or a definition based on zoom levels.
+     * Applies only if `.outline` is `true`.
+     * Default: `white`
+     */
+    outlineColor?: string | ZoomStringValues;
+    /**
+     * Width of the outline (relative to screen-space). This is can be a constant width or a definition based on zoom levels.
+     * Applies only if `.outline` is `true`.
+     * Default: `1`
+     */
+    outlineWidth?: number | ZoomNumberValues;
+    /**
+     * Opacity of the outline. This is can be a constant opacity in [0, 1] or a definition based on zoom levels
+     * Applies only if `.outline` is `true`.
+     * Default: `1`
+     */
+    outlineOpacity?: number | ZoomNumberValues;
+};
+type PolylineLayerOptions = CommonShapeLayerOptions & {
+    /**
+     * Color of the line (or polyline). This is can be a constant color string or a definition based on zoom levels.
+     * Default: a color randomly pick from a list
+     */
+    lineColor?: string | ZoomStringValues;
+    /**
+     * Width of the line (relative to screen-space). This is can be a constant width or a definition based on zoom levels
+     * Default: `3`
+     */
+    lineWidth?: number | ZoomNumberValues;
+    /**
+     * Opacity of the line. This is can be a constant opacity in [0, 1] or a definition based on zoom levels.
+     * Default: `1`
+     */
+    lineOpacity?: number | ZoomNumberValues;
+    /**
+     * How blury the line is, with `0` being no blur and `10` and beyond being quite blurry.
+     * Default: `0`
+     */
+    lineBlur?: number | ZoomNumberValues;
+    /**
+     * Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.
+     * Default: `0`
+     */
+    lineGapWidth?: number | ZoomNumberValues;
+    /**
+     * Sequence of line and void to create a dash pattern. The unit is the line width so that
+     * a dash array value of `[3, 1]` will create a segment worth 3 times the width of the line,
+     * followed by a spacing worth 1 time the line width, and then repeat.
+     *
+     * Alternatively, this property can be a string made of underscore and whitespace characters
+     * such as `"___ _ "` and internaly this will be translated into [3, 1, 1, 1]. Note that
+     * this way of describing dash arrays with a string only works for integer values.
+     *
+     * Dash arrays can contain more than 2 element to create more complex patters. For instance
+     * a dash array value of [3, 2, 1, 2] will create the following sequence:
+     * - a segment worth 3 times the width
+     * - a spacing worth 2 times the width
+     * - a segment worth 1 times the width
+     * - a spacing worth 2 times the width
+     * - repeat
+     *
+     * Default: no dash pattern
+     */
+    lineDashArray?: Array<number> | string;
+    /**
+     * The display of line endings for both the line and the outline (if `.outline` is `true`)
+     * - "butt": A cap with a squared-off end which is drawn to the exact endpoint of the line.
+     * - "round": A cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.
+     * - "square": A cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.
+     * Default: "round"
+     */
+    lineCap?: "butt" | "round" | "square";
+    /**
+     * The display of lines when joining for both the line and the outline (if `.outline` is `true`)
+     * - "bevel": A join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.
+     * - "round": A join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.
+     * - "miter": A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet.
+     * Default: "round"
+     */
+    lineJoin?: "bevel" | "round" | "miter";
+    /**
+     * How blury the outline is, with `0` being no blur and `10` and beyond being quite blurry.
+     * Applies only if `.outline` is `true`.
+     * Default: `0`
+     */
+    outlineBlur?: number | ZoomNumberValues;
+};
+type PolygonLayerOptions = CommonShapeLayerOptions & {
+    /**
+     * Color of the polygon. This is can be a constant color string or a definition based on zoom levels.
+     * Default: a color randomly pick from a list
+     */
+    fillColor?: string | ZoomStringValues;
+    /**
+     * Opacity of the polygon. This is can be a constant opacity in [0, 1] or a definition based on zoom levels
+     * Default: `1`
+     */
+    fillOpacity?: ZoomNumberValues;
+    /**
+     * Position of the outline with regard to the polygon edge (when `.outline` is `true`)
+     * Default: `"center"`
+     */
+    outlinePosition: "center" | "inside" | "outside";
+    /**
+     * Sequence of line and void to create a dash pattern. The unit is the line width so that
+     * a dash array value of `[3, 1]` will create a segment worth 3 times the width of the line,
+     * followed by a spacing worth 1 time the line width, and then repeat.
+     *
+     * Alternatively, this property can be a string made of underscore and whitespace characters
+     * such as `"___ _ "` and internaly this will be translated into [3, 1, 1, 1]. Note that
+     * this way of describing dash arrays with a string only works for integer values.
+     *
+     * Dash arrays can contain more than 2 element to create more complex patters. For instance
+     * a dash array value of [3, 2, 1, 2] will create the following sequence:
+     * - a segment worth 3 times the width
+     * - a spacing worth 2 times the width
+     * - a segment worth 1 times the width
+     * - a spacing worth 2 times the width
+     * - repeat
+     *
+     * Default: no dash pattern
+     */
+    outlineDashArray?: Array<number> | string;
+    /**
+     * The display of line endings for both the line and the outline (if `.outline` is `true`)
+     * - "butt": A cap with a squared-off end which is drawn to the exact endpoint of the line.
+     * - "round": A cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.
+     * - "square": A cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.
+     * Default: "round"
+     */
+    outlineCap?: "butt" | "round" | "square";
+    /**
+     * The display of lines when joining for both the line and the outline (if `.outline` is `true`)
+     * - "bevel": A join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.
+     * - "round": A join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.
+     * - "miter": A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet.
+     * Default: "round"
+     */
+    outlineJoin?: "bevel" | "round" | "miter";
+    /**
+     * The pattern is an image URL to be put as a repeated background pattern of the polygon.
+     * Default: `null` (no pattern, `fillColor` will be used)
+     */
+    pattern?: string | null;
+    /**
+     * How blury the outline is, with `0` being no blur and `10` and beyond being quite blurry.
+     * Applies only if `.outline` is `true`.
+     * Default: `0`
+     */
+    outlineBlur?: number | ZoomNumberValues;
+};
+type PointLayerOptions = CommonShapeLayerOptions & {
+    /**
+     * Can be a unique point color as a string (CSS color such as "#FF0000" or "red").
+     * Alternatively, the color can be a ColorRamp with a range.
+     * In case of `.cluster` being `true`, the range of the ColorRamp will be addressed with the number of elements in
+     * the cluster. If `.cluster` is `false`, the color will be addressed using the value of the `.property`.
+     * If no `.property` is given but `.pointColor` is a ColorRamp, the chosen color is the one at the lower bound of the ColorRamp.
+     * Default: a color randomly pick from a list
+     */
+    pointColor?: string | ColorRamp;
+    /**
+     * Radius of the points. Can be a fixed size or a value dependant on the zoom.
+     * If `.pointRadius` is not provided, the radius will depend on the size of each cluster (if `.cluster` is `true`)
+     * or on the value of each point (if `.property` is provided and `.pointColor` is a ColorRamp).
+     * The radius will be between `.minPointRadius` and `.maxPointRadius`
+     */
+    pointRadius?: number | ZoomNumberValues;
+    /**
+     * The minimum point radius posible.
+     * Default: `10`
+     */
+    minPointRadius?: number;
+    /**
+     * The maximum point radius posible.
+     * Default: `40`
+     */
+    maxPointRadius?: number;
+    /**
+     * The point property to observe and apply the radius and color upon.
+     * This is ignored if `.cluster` is `true` as the observed value will be fiorced to being the number
+     * of elements in each cluster.
+     *
+     * Default: none
+     */
+    property?: string;
+    /**
+     * Opacity of the point or icon. This is can be a constant opacity in [0, 1] or a definition based on zoom levels.
+     * Alternatively, if not provided but the `.pointColor` is a ColorRamp, the opacity will be extracted from tha alpha
+     * component if present.
+     * Default: `1`
+     */
+    pointOpacity?: number | ZoomNumberValues;
+    /**
+     * If `true`, the points will keep their circular shape align with the wiewport.
+     * If `false`, the points will be like flatten on the map. This difference shows
+     * when the map is tilted.
+     * Default: `true`
+     */
+    alignOnViewport?: boolean;
+    /**
+     * Whether the points should cluster
+     */
+    cluster?: boolean;
+    /**
+     * Shows a label with the numerical value id `true`.
+     * If `.cluster` is `true`, the value will be the numebr of elements in the cluster.
+     *
+     *
+     * Default: `true` if `cluster` or `dataDrivenStyleProperty` are used, `false` otherwise.
+     */
+    showLabel?: boolean;
+    /**
+     * text color used for the number elements in each cluster.
+     * Applicable only when `cluster` is `true`.
+     * Default: `#000000` (black)
+     */
+    labelColor?: string;
+    /**
+     * text size used for the number elements in each cluster.
+     * Applicable only when `cluster` is `true`.
+     * Default: `12`
+     */
+    labelSize?: number;
+    /**
+     * Only if `.cluster` is `false`.
+     * If the radius is driven by a property, then it will also scale by zoomming if `.zoomCompensation` is `true`.
+     * If `false`, the radius will not adapt according to the zoom level.
+     * Default: `true`
+     */
+    zoomCompensation?: boolean;
+};
+type HeatmapLayerOptions = {
+    /**
+     * ID to give to the layer.
+     * If not provided, an auto-generated ID of the for "maptiler-layer-xxxxxx" will be auto-generated,
+     * with "xxxxxx" being a random string.
+     */
+    layerId?: string;
+    /**
+     * ID to give to the geojson source.
+     * If not provided, an auto-generated ID of the for "maptiler-source-xxxxxx" will be auto-generated,
+     * with "xxxxxx" being a random string.
+     */
+    sourceId?: string;
+    /**
+     * A geojson Feature collection or a URL to a geojson or the UUID of a MapTiler Cloud dataset.
+     */
+    data: FeatureCollection | string;
+    /**
+     * The ID of an existing layer to insert the new layer before, resulting in the new layer appearing
+     * visually beneath the existing layer. If this argument is not specified, the layer will be appended
+     * to the end of the layers array and appear visually above all other layers.
+     */
+    beforeId?: string;
+    /**
+     * Zoom level at which it starts to show.
+     * Default: `0`
+     */
+    minzoom?: number;
+    /**
+     * Zoom level after which it no longer show.
+     * Default: `22`
+     */
+    maxzoom?: number;
+    /**
+     * The ColorRamp instance to use for visualization. The color ramp is expected to be defined in the
+     * range `[0, 1]` or else will be forced to this range.
+     * Default: `ColorRampCollection.TURBO`
+     */
+    colorRamp?: ColorRamp;
+    /**
+     * Use a property to apply a weight to each data point. Using a property requires also using
+     * the options `.propertyValueWeight` or otherwise will be ignored.
+     * Default: none, the points will all have a weight of `1`.
+     */
+    property?: string;
+    /**
+     * The weight to give to each data point. If of type `PropertyValueWeights`, then the options `.property`
+     * must also be provided. If used a number, all data points will be weighted by the same number (which is of little interest)
+     */
+    weight?: PropertyValues | number;
+    /**
+     * The radius (in screenspace) can be:
+     * - a fixed number that will be constant across zoom level
+     * - of type `ZoomNumberValues` to be ramped accoding to zoom level (`.zoomCompensation` will then be ignored)
+     * - of type `PropertyValues` to be driven by the value of a property.
+     *   If so, the option `.property` must be provided and will still be resized according to zoom level,
+     *   unless the option `.zoomCompensation` is set to `false`.
+     *
+     * Default:
+     */
+    radius?: number | ZoomNumberValues | PropertyValues;
+    /**
+     * The opacity can be a fixed value or zoom-driven.
+     * Default: fades-in 0.25z after minzoom and fade-out 0.25z before maxzoom
+     */
+    opacity?: number | ZoomNumberValues;
+    /**
+     * The intensity is zoom-dependent. By default, the intensity is going to be scaled by zoom to preserve
+     * a natural aspect or the data distribution.
+     */
+    intensity?: number | ZoomNumberValues;
+    /**
+     * If the radius is driven by a property, then it will also scale by zoomming if `.zoomCompensation` is `true`.
+     * If `false`, the radius will not adapt according to the zoom level.
+     * Default: `true`
+     */
+    zoomCompensation?: boolean;
+};
+/**
+ * Add a polyline to the map from various sources and with builtin styling.
+ * Compatible sources:
+ * - gpx content as string
+ * - gpx file from URL
+ * - kml content from string
+ * - kml from url
+ * - geojson from url
+ * - geojson content as string
+ * - geojson content as JS object
+ * - uuid of a MapTiler Cloud dataset
+ *
+ * The method also gives the possibility to add an outline layer (if `options.outline` is `true`)
+ * and if so , the returned property `polylineOutlineLayerId` will be a string. As a result, two layers
+ * would be added.
+ *
+ * The default styling creates a line layer of constant width of 3px, the color will be randomly picked
+ * from a curated list of colors and the opacity will be 1.
+ * If the outline is enabled, the outline width is of 1px at all zoom levels, the color is white and
+ * the opacity is 1.
+ *
+ * Those style properties can be changed and ramped according to zoom level using an easier syntax.
+ *
+ */
+declare function addPolyline(
+/**
+ * Map instance to add a polyline layer to
+ */
+map: Map, 
+/**
+ * Options related to adding a polyline layer
+ */
+options: PolylineLayerOptions, 
+/**
+ * When the polyline data is loaded from a distant source, these options are propagated to the call of `fetch`
+ */
+fetchOptions?: RequestInit): Promise<{
+    polylineLayerId: string;
+    polylineOutlineLayerId: string;
+    polylineSourceId: string;
+}>;
+/**
+ * Add a polygon with styling options.
+ */
+declare function addPolygon(map: Map, options: PolygonLayerOptions): {
+    /**
+     * ID of the fill layer
+     */
+    polygonLayerId: string;
+    /**
+     * ID of the outline layer (will be `""` if no outline)
+     */
+    polygonOutlineLayerId: string;
+    /**
+     * ID of the source that contains the data
+     */
+    polygonSourceId: string;
+};
+/**
+ * Add a point layer from a GeoJSON source (or an existing sourceId) with many styling options
+ */
+declare function addPoint(
+/**
+ * The Map instance to add a point layer to
+ */
+map: Map, options: PointLayerOptions): {
+    /**
+     * ID of the unclustered point layer
+     */
+    pointLayerId: string;
+    /**
+     * ID of the clustered point layer (empty if `cluster` options id `false`)
+     */
+    clusterLayerId: string;
+    /**
+     * ID of the layer that shows the count of elements in each cluster (empty if `cluster` options id `false`)
+     */
+    labelLayerId: string;
+    /**
+     * ID of the data source
+     */
+    pointSourceId: string;
+};
+/**
+ * Add a polyline witgh optional outline from a GeoJSON object
+ */
+declare function addHeatmap(
+/**
+ * Map instance to add a heatmap layer to
+ */
+map: Map, options: HeatmapLayerOptions): {
+    /**
+     * ID of the heatmap layer
+     */
+    heatmapLayerId: string;
+    /**
+     * ID of the data source
+     */
+    heatmapSourceId: string;
+};
+
+/**
+ * Helpers are a set of functions to facilitate the creation of sources and layers
+ */
+declare const helpers: {
+    addPolyline: typeof addPolyline;
+    addPolygon: typeof addPolygon;
+    addPoint: typeof addPoint;
+    addHeatmap: typeof addHeatmap;
+};
+
+declare const setRTLTextPlugin: (url: string, callback: (error?: Error | undefined) => void, deferred?: boolean | undefined) => void;
 declare const getRTLTextPluginStatus: () => string;
 declare const prewarm: () => void;
 declare const clearPrewarmedResources: () => void;
@@ -790,8 +1874,8 @@ declare const version: string;
 declare const workerCount: number;
 declare const maxParallelImageRequests: number;
 declare const workerUrl: string;
-declare const addProtocol: (customProtocol: string, loadFn: (requestParameters: maplibre_gl.RequestParameters, callback: maplibre_gl.ResponseCallback<any>) => maplibre_gl.Cancelable) => void;
-declare const removeProtocol: (customProtocol: string) => void;
+declare const addProtocol: typeof maplibre_gl__default.addProtocol;
+declare const removeProtocol: typeof maplibre_gl__default.removeProtocol;
 
 declare const NavigationControlMLGL: typeof maplibre_gl.NavigationControl;
 type NavigationControlMLGL = InstanceType<typeof NavigationControlMLGL>;
@@ -840,4 +1924,4 @@ type VideoSourceMLGL = InstanceType<typeof VideoSourceMLGL>;
 declare const MapMLGL: typeof maplibre_gl.Map;
 type MapMLGL = InstanceType<typeof MapMLGL>;
 
-export { AJAXError, AttributionControl, AttributionControlMLGL, CanvasSource, CanvasSourceMLGL, Evented, FullscreenControl, FullscreenControlMLGL, GeoJSONSource, GeoJSONSourceMLGL, GeolocateControl, GeolocateControlMLGL, GeolocationType, ImageSource, ImageSourceMLGL, Language, LanguageKey, LanguageString, LngLat, LngLatBounds, LoadWithTerrainEvent, LogoControl, LogoControlMLGL, Map, MapMLGL, MapOptions, MaptilerGeolocateControl, MaptilerLogoControl, MaptilerNavigationControl, MaptilerTerrainControl, Marker, MarkerMLGL, Matrix2, MercatorCoordinate, NavigationControl, NavigationControlMLGL, Point, Popup, PopupMLGL, RasterDEMTileSource, RasterDEMTileSourceMLGL, RasterTileSource, RasterTileSourceMLGL, ScaleControl, ScaleControlMLGL, SdkConfig, Style, StyleMLGL, TerrainControl, TerrainControlMLGL, Unit, VectorTileSource, VectorTileSourceMLGL, VideoSource, VideoSourceMLGL, addProtocol, clearPrewarmedResources, config, getRTLTextPluginStatus, maxParallelImageRequests, prewarm, removeProtocol, setRTLTextPlugin, version, workerCount, workerUrl };
+export { AJAXError, ArrayColor, ArrayColorRamp, ArrayColorRampStop, AttributionControl, AttributionControlMLGL, CanvasSource, CanvasSourceMLGL, ColorRamp, ColorRampCollection, ColorRampOptions, ColorStop, CommonShapeLayerOptions, Evented, FullscreenControl, FullscreenControlMLGL, GeoJSONSource, GeoJSONSourceMLGL, GeolocateControl, GeolocateControlMLGL, GeolocationType, HeatmapLayerOptions, ImageSource, ImageSourceMLGL, Language, LanguageKey, LanguageString, Link, LngLat, LngLatBounds, LoadWithTerrainEvent, LogoControl, LogoControlMLGL, Map, MapMLGL, MapOptions, MaptilerGeolocateControl, MaptilerLogoControl, MaptilerNavigationControl, MaptilerTerrainControl, Marker, MarkerMLGL, Matrix2, MercatorCoordinate, MinimapOptionsInput, NavigationControl, NavigationControlMLGL, PlacemarkProperties, Point, PointLayerOptions, PolygonLayerOptions, PolylineLayerOptions, Popup, PopupMLGL, PropertyValues, RasterDEMTileSource, RasterDEMTileSourceMLGL, RasterTileSource, RasterTileSourceMLGL, RgbaColor, ScaleControl, ScaleControlMLGL, SdkConfig, Style, StyleMLGL, TerrainControl, TerrainControlMLGL, Unit, VectorTileSource, VectorTileSourceMLGL, VideoSource, VideoSourceMLGL, XMLProperties, ZoomNumberValues, ZoomStringValues, addProtocol, clearPrewarmedResources, config, getRTLTextPluginStatus, gpx, gpxOrKml, hasChildNodeWithName, helpers, kml, maxParallelImageRequests, prewarm, removeProtocol, setRTLTextPlugin, str2xml, version, workerCount, workerUrl, xml2str };