@maptiler/sdk 1.0.5 → 1.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maptiler/sdk",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "The Javascript & TypeScript map SDK tailored for MapTiler Cloud",
   "module": "dist/maptiler-sdk.mjs",
   "types": "dist/maptiler-sdk.d.ts",

package/src/Map.ts

@@ -10,7 +10,7 @@ import { v4 as uuidv4 } from "uuid";
 import { ReferenceMapStyle, MapStyleVariant } from "@maptiler/client";
 import { config } from "./config";
 import { defaults } from "./defaults";
-import { CustomLogoControl } from "./CustomLogoControl";
+import { MaptilerLogoControl } from "./MaptilerLogoControl";
 import { enableRTL } from "./tools";
 import {
   getBrowserLanguage,
@@ -19,10 +19,10 @@ import {
   LanguageString,
 } from "./language";
 import { styleToStyle } from "./mapstyle";
-import { TerrainControl } from "./TerrainControl";
+import { MaptilerTerrainControl } from "./MaptilerTerrainControl";
 import { MaptilerNavigationControl } from "./MaptilerNavigationControl";
 import { geolocation } from "@maptiler/client";
-import { CustomGeolocateControl } from "./CustomGeolocateControl";
+import { MaptilerGeolocateControl } from "./MaptilerGeolocateControl";
 
 // StyleSwapOptions is not exported by Maplibre, but we can redefine it (used for setStyle)
 export type TransformStyleFunction = (
@@ -323,7 +323,7 @@ export class Map extends maplibregl.Map {
         const logoURL: string = tileJsonContent.logo;
 
         this.addControl(
-          new CustomLogoControl({ logoURL }),
+          new MaptilerLogoControl({ logoURL }),
           options.logoPosition
         );
 
@@ -332,7 +332,7 @@ export class Map extends maplibregl.Map {
           this.addControl(new maplibregl.AttributionControl(options));
         }
       } else if (options.maptilerLogo) {
-        this.addControl(new CustomLogoControl(), options.logoPosition);
+        this.addControl(new MaptilerLogoControl(), options.logoPosition);
       }
 
       // the other controls at init time but be after
@@ -376,7 +376,7 @@ export class Map extends maplibregl.Map {
 
         this.addControl(
           // new maplibregl.GeolocateControl({
-          new CustomGeolocateControl({
+          new MaptilerGeolocateControl({
             positionOptions: {
               enableHighAccuracy: true,
               maximumAge: 0,
@@ -401,7 +401,7 @@ export class Map extends maplibregl.Map {
             ? "top-right"
             : options.terrainControl
         ) as ControlPosition;
-        this.addControl(new TerrainControl(), position);
+        this.addControl(new MaptilerTerrainControl(), position);
       }
 
       // By default, no fullscreen control

package/src/{CustomGeolocateControl.ts → MaptilerGeolocateControl.ts}

@@ -6,7 +6,13 @@ const GeolocateControl = maplibregl.GeolocateControl;
 const Marker = maplibregl.Marker;
 const LngLat = maplibregl.LngLat;
 
-export class CustomGeolocateControl extends GeolocateControl {
+/**
+ * The MaptilerGeolocateControl is an extension of the original GeolocateControl
+ * with a few changes. In this version, the active mode persists as long as the
+ * location is still centered. This means it's robust to rotation, pitch and zoom.
+ *
+ */
+export class MaptilerGeolocateControl extends GeolocateControl {
   private lastUpdatedCenter = new LngLat(0, 0);
 
   /**

package/src/{CustomLogoControl.ts → MaptilerLogoControl.ts}

@@ -1,8 +1,9 @@
 import maplibregl from "maplibre-gl";
+import type { LogoOptions as LogoOptionsML } from "maplibre-gl";
 import { defaults } from "./defaults";
 import { Map } from "./Map";
 
-type LogoOptions = maplibregl.LogoOptions & {
+type LogoOptions = LogoOptionsML & {
   logoURL?: string;
   linkURL?: string;
 };
@@ -11,7 +12,7 @@ type LogoOptions = maplibregl.LogoOptions & {
  * 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 CustomLogoControl extends maplibregl.LogoControl {
+export class MaptilerLogoControl extends maplibregl.LogoControl {
   private logoURL = "";
   private linkURL = "";
 

package/src/{TerrainControl.ts → MaptilerTerrainControl.ts}

@@ -4,20 +4,10 @@ import { Map } from "./Map";
 import maplibregl from "maplibre-gl";
 
 /**
- * An `TerrainControl` control adds a button to turn terrain on and off.
- *
- * @implements {IControl}
- * @param {Object} [options]
- * @param {string} [options.id] The ID of the raster-dem source to use.
- * @param {Object} [options.options]
- * @param {number} [options.options.exaggeration]
- * @example
- * var map = new maplibregl.Map({TerrainControl: false})
- *     .addControl(new maplibregl.TerrainControl({
- *         source: "terrain"
- *     }));
+ * 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.
  */
-export class TerrainControl implements maplibregl.IControl {
+export class MaptilerTerrainControl implements maplibregl.IControl {
   _map: Map;
   _container: HTMLElement;
   _terrainButton: HTMLButtonElement;

package/src/index.ts

@@ -97,6 +97,10 @@ export {
 import { Map, GeolocationType } from "./Map";
 import type { MapOptions } from "./Map";
 
+import { MaptilerGeolocateControl } from "./MaptilerGeolocateControl";
+import { MaptilerLogoControl } from "./MaptilerLogoControl";
+import { MaptilerTerrainControl } from "./MaptilerTerrainControl";
+
 // importing client functions to expose them as part of the SDK
 import type {
   BBox,
@@ -168,4 +172,7 @@ export {
   Point,
   ReferenceMapStyle,
   MapStyleVariant,
+  MaptilerGeolocateControl,
+  MaptilerLogoControl,
+  MaptilerTerrainControl,
 };