@maptiler/sdk 1.0.10 → 1.0.12

package/package.json

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

package/readme.md

@@ -1,5 +1,5 @@
-
 <p align="center">
+  <a href="https://docs.maptiler.com/sdk-js/">official page →</a><br>
   <img src="images/maptiler-sdk-logo.svg" width="400px">
 </p>
 
@@ -372,11 +372,12 @@ Again, it will only apply `ENGLISH` as the language of this specific map instanc
 
 The list of supported languages is built-in and can be found [here](src/language.ts). In addition, there are spacial language *flags*:
 - `Language.AUTO` **[DEFAULT]** uses the language defined in the web browser
+- `Language.STYLE_LOCK` to strictly use the language defined in the style. Prevents any further language update
 - `Language.LOCAL` uses the language local to each country
 - `Language.LATIN` uses a default with latin characters
 - `Language.NON_LATIN` uses a default with non-latin characters
 
-Whenever a label is not supported in the defined language, it falls back to `Language.LATIN`.
+Whenever a label is not supported in the defined language, it falls back to `Language.LOCAL`.
 
 Here is a sample of some compatible languages:
 ![](images/screenshots/multilang.gif)

package/src/Map.ts

@@ -99,7 +99,14 @@ export type MapOptions = Omit<MapOptionsML, "style" | "maplibreLogo"> & {
   apiKey?: string;
 
   /**
-   * Shows the MapTiler logo if `true`. Note that the logo is always displayed on free plan.
+   * Shows or hides the MapTiler logo in the bottom left corner.
+   *
+   * For paid plans:
+   * - `true` shows MapTiler logo
+   * - `false` hodes MapTiler logo
+   * - default: `false` (hide)
+   *
+   * For free plans: MapTiler logo always shows, regardless of the value.
    */
   maptilerLogo?: boolean;
 
@@ -579,6 +586,13 @@ export class Map extends maplibregl.Map {
    * @param language
    */
   setPrimaryLanguage(language: LanguageString = defaults.primaryLanguage) {
+    if (this.primaryLanguage === Language.STYLE_LOCK) {
+      console.warn(
+        "The language cannot be changed because this map has been instantiated with the STYLE_LOCK language flag."
+      );
+      return;
+    }
+
     if (!isLanguageSupported(language as string)) {
       return;
     }
@@ -610,7 +624,7 @@ export class Map extends maplibregl.Map {
         "case",
         ["has", langStr],
         ["get", langStr],
-        ["get", "name:latin"],
+        ["get", "name"],
       ];
 
       for (let i = 0; i < layers.length; i += 1) {
@@ -744,6 +758,14 @@ export class Map extends maplibregl.Map {
    * @param language
    */
   setSecondaryLanguage(language: LanguageString = defaults.secondaryLanguage) {
+    // Using the lock flag as a primaty language also applies to the secondary
+    if (this.primaryLanguage === Language.STYLE_LOCK) {
+      console.warn(
+        "The language cannot be changed because this map has been instantiated with the STYLE_LOCK language flag."
+      );
+      return;
+    }
+
     if (!isLanguageSupported(language as string)) {
       return;
     }

package/src/index.ts

@@ -134,6 +134,7 @@ import { TerrainControl } from "./TerrainControl";
 import { MaptilerGeolocateControl } from "./MaptilerGeolocateControl";
 import { MaptilerLogoControl } from "./MaptilerLogoControl";
 import { MaptilerTerrainControl } from "./MaptilerTerrainControl";
+import { MaptilerNavigationControl } from "./MaptilerNavigationControl";
 
 // importing client functions to expose them as part of the SDK
 import type {
@@ -227,4 +228,5 @@ export {
   MaptilerGeolocateControl,
   MaptilerLogoControl,
   MaptilerTerrainControl,
+  MaptilerNavigationControl,
 };

package/src/language.ts

@@ -7,6 +7,13 @@ const Language = {
    */
   AUTO: "auto",
 
+  /**
+   * STYLE is a custom flag to keep the language of the map as defined into the style.
+   * If STYLE is set in the constructor, then further modification of the language
+   * with `.setLanguage()` is not possible.
+   */
+  STYLE_LOCK: "style_lock",
+
   /**
    * Default fallback languages that uses latin charaters
    */