@maptiler/sdk 3.0.0-rc.3 → 3.0.0-rc.4

package/dist/src/Map.d.ts

@@ -3,6 +3,7 @@ import { ReferenceMapStyle, MapStyleVariant } from '@maptiler/client';
 import { SdkConfig } from './config';
 import { LanguageInfo } from './language';
 import { MinimapOptionsInput } from './Minimap';
+import { Telemetry } from './Telemetry';
 
 export type LoadWithTerrainEvent = {
     type: "loadWithTerrain";
@@ -130,6 +131,7 @@ export type MapOptions = Omit<MapOptionsML, "style" | "maplibreLogo"> & {
  * The Map class can be instanciated to display a map in a `<div>`
  */
 export declare class Map extends maplibregl.Map {
+    readonly telemetry: Telemetry;
     private isTerrainEnabled;
     private terrainExaggeration;
     private primaryLanguage;
@@ -145,6 +147,7 @@ export declare class Map extends maplibregl.Map {
     private curentProjection;
     private originalLabelStyle;
     private isStyleLocalized;
+    private languageIsUpdated;
     constructor(options: MapOptions);
     /**
      * Set the duration (millisec) of the terrain animation for growing or flattening.
@@ -385,4 +388,11 @@ export declare class Map extends maplibregl.Map {
      * Uses the Mercator projection. Animated by default, it can be disabled
      */
     enableMercatorProjection(animate?: boolean): void;
+    /**
+     * Returns `true` is the language was ever updated, meaning changed
+     * from what is delivered in the style.
+     * Returns `false` if language in use is the language from the style
+     * and has never been changed.
+     */
+    isLanguageUpdated(): boolean;
 }

package/dist/src/Telemetry.d.ts

@@ -0,0 +1,22 @@
+import { Map as MapSDK } from './Map';
+
+/**
+ * A Telemetry instance sends some usage and merics to a dedicated endpoint at MapTiler Cloud.
+ */
+export declare class Telemetry {
+    private map;
+    private registeredModules;
+    /**
+     *
+     * @param map : a Map instance
+     * @param delay : a delay in milliseconds after which the payload is sent to MapTiler cloud (cannot be less than 1000ms)
+     */
+    constructor(map: MapSDK, delay?: number);
+    /**
+     * Register a module to the telemetry system of the SDK.
+     * The arguments `name` and `version` likely come from the package.json
+     * of each module.
+     */
+    registerModule(name: string, version: string): void;
+    private preparePayload;
+}

package/dist/src/config.d.ts

@@ -31,6 +31,24 @@ declare class SdkConfig extends EventEmitter {
      * Works only for requests to the MapTiler Cloud API when sessions are enabled.
      */
     caching: boolean;
+    /**
+     * Telemetry is enabled by default but can be opted-out by setting this value to `false`.
+     * The telemetry is very valuable to the team at MapTiler because it shares information
+     * about where to add the extra effort. It also helps spotting some incompatibility issues
+     * that may arise between the SDK and a specific version of a module.
+     *
+     * It consists in sending metrics about usage of the following features:
+     * - SDK version [string]
+     * - API key [string]
+     * - MapTiler sesion ID (if opted-in) [string]
+     * - if tile caching is enabled [boolean]
+     * - if language specified at initialization [boolean]
+     * - if terrain is activated at initialization [boolean]
+     * - if globe projection is activated at initialization [boolean]
+     *
+     * In addition, each official module will be add added to a list, alongside its version number.
+     */
+    telemetry: boolean;
     /**
      * Unit to be used
      */

package/dist/src/defaults.d.ts

@@ -5,6 +5,7 @@ declare const defaults: {
     maptilerLogoURL: string;
     maptilerURL: string;
     maptilerApiHost: string;
+    telemetryURL: string;
     rtlPluginURL: string;
     primaryLanguage: import('@maptiler/client').LanguageInfo;
     secondaryLanguage: import('@maptiler/client').LanguageInfo;

package/package.json

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