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

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.
@@ -378,11 +381,18 @@ export declare class Map extends maplibregl.Map {
      */
     isGlobeProjection(): boolean;
     /**
-     * Uses the globe projection. Animated by default, it can be disabled
+     * Activate the globe projection.
      */
-    enableGlobeProjection(animate?: boolean): void;
+    enableGlobeProjection(): void;
     /**
-     * Uses the Mercator projection. Animated by default, it can be disabled
+     * Activate the mercator projection.
      */
-    enableMercatorProjection(animate?: boolean): void;
+    enableMercatorProjection(): 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/MaptilerGeolocateControl.d.ts

@@ -18,4 +18,5 @@ export declare class MaptilerGeolocateControl extends GeolocateControl {
     _finishSetupUI: (supported: boolean) => void;
     _updateCircleRadius(): void;
     _onZoom: () => void;
+    _setErrorState(): void;
 }

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.5",
   "description": "The Javascript & TypeScript map SDK tailored for MapTiler Cloud",
   "module": "dist/maptiler-sdk.mjs",
   "types": "dist/maptiler-sdk.d.ts",
@@ -65,7 +65,7 @@
     "@maptiler/client": "^2.2.0",
     "events": "^3.3.0",
     "js-base64": "^3.7.4",
-    "maplibre-gl": "^5.0.0-pre.9",
+    "maplibre-gl": "^5.0.0-pre.10",
     "uuid": "^9.0.0"
   }
 }

package/readme.md

@@ -136,7 +136,7 @@ The SDK hosted on our CDN is bundled as *[Universal Module Definition](https://g
   <body>
     <div id="map-container"></div>
   
-    <script src ="dist/maptiler-sdk.umd.js"></script>
+    <script src ="dist/maptiler-sdk.umd.min.js"></script>
     
     <script>
       // Add your MapTiler Cloud API key to the config
@@ -1103,7 +1103,40 @@ Turning off *zoom compensation* allows for more accurate adjustments to the visu
 
 All the other options are documented on [our reference page](https://docs.maptiler.com/sdk-js/api/helpers/#heatmap) and more examples are available [here](https://docs.maptiler.com/sdk-js/examples/?q=heatmap+helper).
 
-# Other helper
+# Other helpers
+## Convert GPX and KML to GeoJSON
+In the [Polyline helper section](#polyline-layer-helper) above, we have seen that one can feed the helper directly with a path to a GPX or KML file, that is then converted under the hood client-side into a GeoJSON `FeatureCollection` object. This conversion feature is also exposed and can be used as such:
+
+```ts
+import { gpx } from "@maptiler/sdk";
+
+// ... assuming inside an async function
+
+// Fetching the GPX file as a string:
+const gpxFilePath = "some_gps_trace.gpx";
+const gpxResponse = await fetch(gpxFilePath);
+const gpxStr = await res.text();
+
+// Converting the GPX payload into a GeoJSON FeatureCollection:
+const features = maptilersdk.gpx(gpxStr);
+```
+
+And for KML files:
+```ts
+import { kml } from "@maptiler/sdk";
+
+// ... assuming inside an async function
+
+// Fetching the KML file as a string:
+const kmlFilePath = "some_gps_trace.kml";
+const kmlResponse = await fetch(kmlFilePath);
+const kmlStr = await res.text();
+
+// Converting the KML payload into a GeoJSON FeatureCollection:
+const features = maptilersdk.gpx(kmlStr);
+```
+
+
 ## Take Screenshots, programmatically
 There are two different ways to create screenshot, corresponding to two very different usecases. Note that screenshots will not contain *DOM elements* such as `Marker` and `Popup`, since those are not part of the rendering context.
 

package/vite.config-umd.ts

@@ -2,26 +2,20 @@ import { resolve } from 'path';
 import { defineConfig } from 'vite';
 
 const isProduction = process.env.NODE_ENV === "production";
-const bundleFilename = isProduction ? "maptiler-sdk.umd.min.js" : "maptiler-sdk.umd.js"
-
-const plugins = [];
-
 
 export default defineConfig({
   mode: isProduction ? "production" : "development",
   build: {
     outDir: "build",
-    minify: isProduction,
+    minify: true,
     emptyOutDir: isProduction,
     sourcemap: true,
     lib: {
-      // Could also be a dictionary or array of multiple entry points
       entry: resolve(__dirname, 'src/index.ts'),
       name: 'maptilersdk',
-      // the proper extensions will be added
-      fileName: (format, entryName) => bundleFilename,
+      fileName: (format, entryName) => "maptiler-sdk.umd.min.js",
       formats: ['umd'],
     }
   },
-  plugins,
-})
+  plugins: [],
+});