@maptiler/sdk 1.0.7 → 1.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maptiler/sdk",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "The Javascript & TypeScript map SDK tailored for MapTiler Cloud",
   "module": "dist/maptiler-sdk.mjs",
   "types": "dist/maptiler-sdk.d.ts",
@@ -62,7 +62,7 @@
     "typescript": "^4.8.4"
   },
   "dependencies": {
-    "@maptiler/client": "^1.1.3",
+    "@maptiler/client": "^1.3.0",
     "events": "^3.3.0",
     "js-base64": "^3.7.4",
     "maplibre-gl": "^3.0.0-pre.3",

package/readme.md

@@ -165,10 +165,13 @@ Here is the full list:
   - `MapStyle.STREETS.DARK` (variant)
   - `MapStyle.STREETS.LIGHT` (variant)
   - `MapStyle.STREETS.PASTEL` (variant)
-- `MapStyle.OUTDOOR` reference style for adventure
-- `MapStyle.WINTER` reference style for winter adventure
 - `MapStyle.SATELLITE` reference style satellite and airborne imagery (no variants)
 - `MapStyle.HYBRID` reference style satellite and airborne imagery with labels (no variants)
+- `MapStyle.OUTDOOR` reference style for adventure
+- `MapStyle.WINTER` reference style for winter adventure
+- `MapStyle.DATAVIZ`, the perfect style for data visualization, with very little noise
+  - `MapStyle.DATAVIZ.DARK` (variant)
+  - `MapStyle.DATAVIZ.LIGHT` (variant)
 - `MapStyle.BASIC` reference style for minimalist design and general purpose
   - `MapStyle.BASIC.DARK` (variant)
   - `MapStyle.BASIC.LIGHT` (variant)
@@ -189,9 +192,7 @@ Here is the full list:
   - `MapStyle.TONER.LITE` (variant)
   - `MapStyle.TONER.LINES` (variant)
 - `MapStyle.OPENSTREETMAP` (reference style, this one does not have any variants)
-- `MapStyle.DATAVIZ`, the perfect style for data visualization, with very little noise
-  - `MapStyle.DATAVIZ.DARK` (variant)
-  - `MapStyle.DATAVIZ.LIGHT` (variant)
+
 
 All reference styles (instances of `ReferenceMapStyle`) and style variants (instances of `MapStyleVariant`) have methods to know the alternative styles and variant that belong to the same reference style (`.getVariants()`). This is handy to provide a default/dark/light alternative color scheme, yet preserving the same level of details as in the reference style. Read more about about [ReferenceMapStyle](docsmd/classes/ReferenceMapStyle.md) and [MapStyleVariant](docsmd/classes/MapStyleVariant.md).
 </details>  
@@ -508,9 +509,12 @@ In the following static map functions, the `option` object features a `style` pr
 - `MapStyle.STREETS`, reference style for navigation and city exploration
   - `MapStyle.STREETS.DARK` (variant)
   - `MapStyle.STREETS.LIGHT` (variant)
+  - `MapStyle.STREETS.NIGHT` (variant)
   - `MapStyle.STREETS.PASTEL` (variant)
 - `MapStyle.OUTDOOR` reference style for adventure
+  - `MapStyle.OUTDOOR.DARK` (variant)
 - `MapStyle.WINTER` reference style for winter adventure
+  - `MapStyle.WINTER.DARK` (variant)
 - `MapStyle.SATELLITE` reference style satellite and airborne imagery (no variants)
 - `MapStyle.HYBRID` reference style satellite and airborne imagery with labels (no variants)
 - `MapStyle.BASIC` reference style for minimalist design and general purpose

package/src/AttributionControl.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre AttributionControl to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class AttributionControl extends maplibregl.AttributionControl {
+  onAdd(map: Map | MapMLGL) {
+    return super.onAdd(map as MapMLGL);
+  }
+}

package/src/CanvasSource.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre CanvasSource to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class CanvasSource extends maplibregl.CanvasSource {
+  onAdd(map: Map | MapMLGL) {
+    super.onAdd(map as MapMLGL);
+  }
+}

package/src/FullscreenControl.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre FullscreenControl to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class FullscreenControl extends maplibregl.FullscreenControl {
+  onAdd(map: Map | MapMLGL) {
+    return super.onAdd(map as MapMLGL);
+  }
+}

package/src/GeoJSONSource.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre GeoJSONSource to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class GeoJSONSource extends maplibregl.GeoJSONSource {
+  onAdd(map: Map | MapMLGL) {
+    super.onAdd(map as MapMLGL);
+  }
+}

package/src/GeolocateControl.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre GeolocateControl to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class GeolocateControl extends maplibregl.GeolocateControl {
+  onAdd(map: Map | MapMLGL) {
+    return super.onAdd(map as MapMLGL);
+  }
+}

package/src/ImageSource.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre ImageSource to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class ImageSource extends maplibregl.ImageSource {
+  onAdd(map: Map | MapMLGL) {
+    super.onAdd(map as MapMLGL);
+  }
+}

package/src/LogoControl.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre LogoControl to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class LogoControl extends maplibregl.LogoControl {
+  onAdd(map: Map | MapMLGL) {
+    return super.onAdd(map as MapMLGL);
+  }
+}

package/src/Map.ts

@@ -23,6 +23,9 @@ import { MaptilerTerrainControl } from "./MaptilerTerrainControl";
 import { MaptilerNavigationControl } from "./MaptilerNavigationControl";
 import { geolocation } from "@maptiler/client";
 import { MaptilerGeolocateControl } from "./MaptilerGeolocateControl";
+import { AttributionControl } from "./AttributionControl";
+import { ScaleControl } from "./ScaleControl";
+import { FullscreenControl } from "./FullscreenControl";
 
 // StyleSwapOptions is not exported by Maplibre, but we can redefine it (used for setStyle)
 export type TransformStyleFunction = (
@@ -136,16 +139,12 @@ export type MapOptions = Omit<MapOptionsML, "style" | "maplibreLogo"> & {
  * The Map class can be instanciated to display a map in a `<div>`
  */
 export class Map extends maplibregl.Map {
-  private languageShouldUpdate = false;
-  private isStyleInitialized = false;
   private isTerrainEnabled = false;
   private terrainExaggeration = 1;
+  private primaryLanguage: LanguageString | null = null;
+  private secondaryLanguage: LanguageString | null = null;
 
   constructor(options: MapOptions) {
-    // if (options.language) {
-    //   config.primaryLanguage = options.language;
-    // }
-
     if (options.apiKey) {
       config.apiKey = options.apiKey;
     }
@@ -197,11 +196,15 @@ export class Map extends maplibregl.Map {
       },
     });
 
+    this.primaryLanguage = options.language ?? config.primaryLanguage;
+    this.secondaryLanguage = config.secondaryLanguage;
+
     // Map centering and geolocation
     this.once("styledata", async () => {
       // Not using geolocation centering if...
 
-      if (options.geolocate === false) {
+      // the geolcoate option is not provided or is falsy
+      if (!options.geolocate) {
         return;
       }
 
@@ -271,40 +274,10 @@ export class Map extends maplibregl.Map {
       }
     });
 
-    // Check if language has been modified and. If so, it will be updated during the next lifecycle step
-    this.on("styledataloading", () => {
-      this.languageShouldUpdate =
-        !!config.primaryLanguage || !!config.secondaryLanguage;
-    });
-
-    // To flag if the language was already initialized at build time
-    // so that the language optionnaly passed in constructor is
-    // considered only once and at instanciation time.
-    let initLanguageFromConstructor = true;
-
     // If the config includes language changing, we must update the map language
     this.on("styledata", () => {
-      // If the language is set as a constructor options,
-      // This prevails on the language from the config.
-      if (options.language && initLanguageFromConstructor) {
-        this.setPrimaryLanguage(options.language);
-      } else if (
-        config.primaryLanguage &&
-        (this.languageShouldUpdate || !this.isStyleInitialized)
-      ) {
-        this.setPrimaryLanguage(config.primaryLanguage);
-      }
-
-      if (
-        config.secondaryLanguage &&
-        (this.languageShouldUpdate || !this.isStyleInitialized)
-      ) {
-        this.setSecondaryLanguage(config.secondaryLanguage);
-      }
-
-      this.languageShouldUpdate = false;
-      this.isStyleInitialized = true;
-      initLanguageFromConstructor = false;
+      this.setPrimaryLanguage(this.primaryLanguage);
+      this.setSecondaryLanguage(this.secondaryLanguage);
     });
 
     // this even is in charge of reaplying the terrain elevation after the
@@ -360,7 +333,7 @@ export class Map extends maplibregl.Map {
 
         // if attribution in option is `false` but the the logo shows up in the tileJson, then the attribution must show anyways
         if (options.attributionControl === false) {
-          this.addControl(new maplibregl.AttributionControl(options));
+          this.addControl(new AttributionControl(options));
         }
       } else if (options.maptilerLogo) {
         this.addControl(new MaptilerLogoControl(), options.logoPosition);
@@ -378,7 +351,7 @@ export class Map extends maplibregl.Map {
             : options.scaleControl
         ) as ControlPosition;
 
-        const scaleControl = new maplibregl.ScaleControl({ unit: config.unit });
+        const scaleControl = new ScaleControl({ unit: config.unit });
         this.addControl(scaleControl, position);
         config.on("unit", (unit) => {
           scaleControl.setUnit(unit);
@@ -445,7 +418,7 @@ export class Map extends maplibregl.Map {
             : options.fullscreenControl
         ) as ControlPosition;
 
-        this.addControl(new maplibregl.FullscreenControl({}), position);
+        this.addControl(new FullscreenControl({}), position);
       }
     });
 
@@ -495,6 +468,8 @@ export class Map extends maplibregl.Map {
       return;
     }
 
+    this.primaryLanguage = language;
+
     this.onStyleReady(() => {
       if (language === Language.AUTO) {
         return this.setPrimaryLanguage(getBrowserLanguage());
@@ -649,7 +624,7 @@ export class Map extends maplibregl.Map {
   }
 
   /**
-   * Define the secondary language of the map.
+   * 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
    */
@@ -658,6 +633,8 @@ export class Map extends maplibregl.Map {
       return;
     }
 
+    this.secondaryLanguage = language;
+
     this.onStyleReady(() => {
       if (language === Language.AUTO) {
         return this.setSecondaryLanguage(getBrowserLanguage());
@@ -780,6 +757,22 @@ export class Map extends maplibregl.Map {
     });
   }
 
+  /**
+   * Get the primary language
+   * @returns
+   */
+  getPrimaryLanguage(): LanguageString {
+    return this.primaryLanguage;
+  }
+
+  /**
+   * Get the secondary language
+   * @returns
+   */
+  getSecondaryLanguage(): LanguageString {
+    return this.secondaryLanguage;
+  }
+
   /**
    * Get the exaggeration factor applied to the terrain
    * @returns

package/src/MaptilerGeolocateControl.ts

@@ -1,8 +1,8 @@
 import type { LngLatLike } from "maplibre-gl";
 import maplibregl from "maplibre-gl";
+import { GeolocateControl } from "./GeolocateControl";
 import { DOMcreate } from "./tools";
 
-const GeolocateControl = maplibregl.GeolocateControl;
 const Marker = maplibregl.Marker;
 const LngLat = maplibregl.LngLat;
 

package/src/MaptilerLogoControl.ts

@@ -2,6 +2,7 @@ import maplibregl from "maplibre-gl";
 import type { LogoOptions as LogoOptionsML } from "maplibre-gl";
 import { defaults } from "./defaults";
 import { Map } from "./Map";
+import { LogoControl } from "./LogoControl";
 
 type LogoOptions = LogoOptionsML & {
   logoURL?: string;
@@ -12,7 +13,7 @@ type LogoOptions = LogoOptionsML & {
  * This LogoControl extends the MapLibre LogoControl but instead can use any image URL and
  * any link URL. By default this is using MapTiler logo and URL.
  */
-export class MaptilerLogoControl extends maplibregl.LogoControl {
+export class MaptilerLogoControl extends LogoControl {
   private logoURL = "";
   private linkURL = "";
 

package/src/MaptilerNavigationControl.ts

@@ -1,10 +1,10 @@
-import maplibregl from "maplibre-gl";
+import { NavigationControl } from "./NavigationControl";
 
 type HTMLButtonElementPlus = HTMLButtonElement & {
   clickFunction: (e?: any) => unknown;
 };
 
-export class MaptilerNavigationControl extends maplibregl.NavigationControl {
+export class MaptilerNavigationControl extends NavigationControl {
   constructor() {
     super({
       showCompass: true,

package/src/Marker.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre Marker to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class Marker extends maplibregl.Marker {
+  addTo(map: Map | MapMLGL): this {
+    return super.addTo(map as MapMLGL);
+  }
+}

package/src/NavigationControl.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre NavigationControl to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class NavigationControl extends maplibregl.NavigationControl {
+  onAdd(map: Map | MapMLGL) {
+    return super.onAdd(map as MapMLGL);
+  }
+}

package/src/Popup.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre Popup to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class Popup extends maplibregl.Popup {
+  addTo(map: Map | MapMLGL): this {
+    return super.addTo(map as MapMLGL);
+  }
+}

package/src/RasterDEMTileSource.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre RasterDEMTileSource to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class RasterDEMTileSource extends maplibregl.RasterDEMTileSource {
+  onAdd(map: Map | MapMLGL) {
+    super.onAdd(map as MapMLGL);
+  }
+}

package/src/RasterTileSource.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre RasterTileSource to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class RasterTileSource extends maplibregl.RasterTileSource {
+  onAdd(map: Map | MapMLGL) {
+    super.onAdd(map as MapMLGL);
+  }
+}

package/src/ScaleControl.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre ScaleControl to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class ScaleControl extends maplibregl.ScaleControl {
+  onAdd(map: Map | MapMLGL) {
+    return super.onAdd(map as MapMLGL);
+  }
+}

package/src/Style.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre Style to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL, StyleOptions } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class Style extends maplibregl.Style {
+  constructor(map: Map, options: StyleOptions = {}) {
+    super(map as MapMLGL, options);
+  }
+}

package/src/TerrainControl.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre TerrainControl to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class TerrainControl extends maplibregl.TerrainControl {
+  onAdd(map: Map | MapMLGL) {
+    return super.onAdd(map as MapMLGL);
+  }
+}

package/src/VectorTileSource.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre VectorTileSource to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class VectorTileSource extends maplibregl.VectorTileSource {
+  onAdd(map: Map | MapMLGL) {
+    super.onAdd(map as MapMLGL);
+  }
+}

package/src/VideoSource.ts

@@ -0,0 +1,13 @@
+/**
+ * This is an extension of MapLibre VideoSource to make it fully type compatible with the SDK
+ */
+
+import maplibregl from "maplibre-gl";
+import type { Map as MapMLGL } from "maplibre-gl";
+import { Map } from "./Map";
+
+export class VideoSource extends maplibregl.VideoSource {
+  onAdd(map: Map | MapMLGL) {
+    super.onAdd(map as MapMLGL);
+  }
+}