@maptiler/sdk 3.0.0-rc.4 → 3.0.0

package/dist/src/MLAdapters/AttributionControl.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class AttributionControl extends maplibregl.AttributionControl {
     onAdd(map: SDKMap | MapMLGL): HTMLElement;
 }

package/dist/src/MLAdapters/BoxZoomHandler.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class BoxZoomHandler extends maplibregl.BoxZoomHandler {
     constructor(map: SDKMap | MapMLGL, options: {
         clickTolerance: number;

package/dist/src/MLAdapters/CanvasSource.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class CanvasSource extends maplibregl.CanvasSource {
     onAdd(map: SDKMap | MapMLGL): void;
 }

package/dist/src/MLAdapters/CooperativeGesturesHandler.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, GestureOptions, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class CooperativeGesturesHandler extends maplibregl.CooperativeGesturesHandler {
     constructor(map: SDKMap | MapMLGL, options: GestureOptions);
 }

package/dist/src/MLAdapters/FullscreenControl.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class FullscreenControl extends maplibregl.FullscreenControl {
     onAdd(map: SDKMap | MapMLGL): HTMLElement;
 }

package/dist/src/MLAdapters/GeoJSONSource.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class GeoJSONSource extends maplibregl.GeoJSONSource {
     onAdd(map: SDKMap | MapMLGL): void;
 }

package/dist/src/MLAdapters/GeolocateControl.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class GeolocateControl extends maplibregl.GeolocateControl {
     onAdd(map: SDKMap | MapMLGL): HTMLElement;
 }

package/dist/src/MLAdapters/ImageSource.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class ImageSource extends maplibregl.ImageSource {
     onAdd(map: SDKMap | MapMLGL): void;
 }

package/dist/src/MLAdapters/KeyboardHandler.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class KeyboardHandler extends maplibregl.KeyboardHandler {
     constructor(map: SDKMap | MapMLGL);
 }

package/dist/src/MLAdapters/LogoControl.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class LogoControl extends maplibregl.LogoControl {
     onAdd(map: SDKMap | MapMLGL): HTMLElement;
 }

package/dist/src/MLAdapters/MapMouseEvent.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class MapMouseEvent extends maplibregl.MapMouseEvent {
     constructor(type: string, map: SDKMap | MapMLGL, originalEvent: MouseEvent, data?: any);
 }

package/dist/src/MLAdapters/MapTouchEvent.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class MapTouchEvent extends maplibregl.MapTouchEvent {
     constructor(type: string, map: SDKMap | MapMLGL, originalEvent: TouchEvent);
 }

package/dist/src/MLAdapters/MapWheelEvent.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class MapWheelEvent extends maplibregl.MapWheelEvent {
     constructor(type: string, map: SDKMap | MapMLGL, originalEvent: WheelEvent);
 }

package/dist/src/MLAdapters/Marker.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class Marker extends maplibregl.Marker {
     addTo(map: SDKMap | MapMLGL): this;
 }

package/dist/src/MLAdapters/NavigationControl.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class NavigationControl extends maplibregl.NavigationControl {
     onAdd(map: SDKMap | MapMLGL): HTMLElement;
 }

package/dist/src/MLAdapters/Popup.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class Popup extends maplibregl.Popup {
     addTo(map: SDKMap | MapMLGL): this;
 }

package/dist/src/MLAdapters/RasterDEMTileSource.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class RasterDEMTileSource extends maplibregl.RasterDEMTileSource {
     onAdd(map: SDKMap | MapMLGL): void;
 }

package/dist/src/MLAdapters/RasterTileSource.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class RasterTileSource extends maplibregl.RasterTileSource {
     onAdd(map: SDKMap | MapMLGL): void;
 }

package/dist/src/MLAdapters/ScaleControl.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class ScaleControl extends maplibregl.ScaleControl {
     onAdd(map: SDKMap | MapMLGL): HTMLElement;
 }

package/dist/src/MLAdapters/ScrollZoomHandler.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class ScrollZoomHandler extends maplibregl.ScrollZoomHandler {
     constructor(map: SDKMap | MapMLGL, triggerRenderFrame: () => void);
 }

package/dist/src/MLAdapters/Style.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, StyleOptions } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class Style extends maplibregl.Style {
     constructor(map: SDKMap, options?: StyleOptions);
 }

package/dist/src/MLAdapters/TerrainControl.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class TerrainControl extends maplibregl.TerrainControl {
     onAdd(map: SDKMap | MapMLGL): HTMLElement;
 }

package/dist/src/MLAdapters/TwoFingersTouchPitchHandler.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class TwoFingersTouchPitchHandler extends maplibregl.TwoFingersTouchPitchHandler {
     constructor(map: SDKMap | MapMLGL);
 }

package/dist/src/MLAdapters/VectorTileSource.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class VectorTileSource extends maplibregl.VectorTileSource {
     onAdd(map: SDKMap | MapMLGL): void;
 }

package/dist/src/MLAdapters/VideoSource.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-
 export declare class VideoSource extends maplibregl.VideoSource {
     onAdd(map: SDKMap | MapMLGL): void;
 }

package/dist/src/Map.d.ts

@@ -4,7 +4,6 @@ import { SdkConfig } from './config';
 import { LanguageInfo } from './language';
 import { MinimapOptionsInput } from './Minimap';
 import { Telemetry } from './Telemetry';
-
 export type LoadWithTerrainEvent = {
     type: "loadWithTerrain";
     target: Map;
@@ -381,13 +380,13 @@ 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.

package/dist/src/MaptilerGeolocateControl.d.ts

@@ -1,5 +1,4 @@
 import { GeolocateControl } from './MLAdapters/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
@@ -18,4 +17,5 @@ export declare class MaptilerGeolocateControl extends GeolocateControl {
     _finishSetupUI: (supported: boolean) => void;
     _updateCircleRadius(): void;
     _onZoom: () => void;
+    _setErrorState(): void;
 }

package/dist/src/MaptilerLogoControl.d.ts

@@ -1,7 +1,6 @@
 import { LogoControlOptions as LogoControlOptionsML } from 'maplibre-gl';
 import { LogoControl } from './MLAdapters/LogoControl';
 import { Map as SDKMap } from './Map';
-
 type LogoControlOptions = LogoControlOptionsML & {
     logoURL?: string;
     linkURL?: string;

package/dist/src/MaptilerNavigationControl.d.ts

@@ -1,6 +1,5 @@
 import { NavigationControlOptions } from 'maplibre-gl';
 import { NavigationControl } from './MLAdapters/NavigationControl';
-
 type HTMLButtonElementPlus = HTMLButtonElement & {
     clickFunction: (e?: Event) => unknown;
 };

package/dist/src/MaptilerProjectionControl.d.ts

@@ -1,6 +1,5 @@
 import { Map as SDKMap } from './Map';
 import { IControl } from 'maplibre-gl';
-
 /**
  * A `MaptilerProjectionControl` control adds a button to switch from Mercator to Globe projection.
  */

package/dist/src/MaptilerTerrainControl.d.ts

@@ -1,6 +1,5 @@
 import { Map as SDKMap } from './Map';
 import { IControl } from 'maplibre-gl';
-
 /**
  * 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.

package/dist/src/Minimap.d.ts

@@ -1,7 +1,6 @@
 import { Map as SDKMap, MapOptions } from './Map';
 import { ControlPosition, CustomLayerInterface, FillLayerSpecification, FilterSpecification, IControl, LayerSpecification, LineLayerSpecification, SourceSpecification, StyleOptions, StyleSetterOptions, StyleSpecification, StyleSwapOptions } from 'maplibre-gl';
 import { MapStyleVariant, ReferenceMapStyle } from '@maptiler/client';
-
 export interface ParentRect {
     lineLayout: LineLayerSpecification["layout"];
     linePaint: LineLayerSpecification["paint"];

package/dist/src/Telemetry.d.ts

@@ -1,5 +1,4 @@
 import { Map as MapSDK } from './Map';
-
 /**
  * A Telemetry instance sends some usage and merics to a dedicated endpoint at MapTiler Cloud.
  */

package/dist/src/caching.d.ts

@@ -1,5 +1,4 @@
 import { ResourceType } from 'maplibre-gl';
-
 export declare const CACHE_API_AVAILABLE: boolean;
 export declare function localCacheTransformRequest(reqUrl: URL, resourceType?: ResourceType): string;
 export declare function registerLocalCacheProtocol(): void;

package/dist/src/config.d.ts

@@ -2,7 +2,6 @@ import { default as EventEmitter } from 'events';
 import { LanguageInfo } from './language';
 import { FetchFunction } from '@maptiler/client';
 import { Unit } from './unit';
-
 export declare const MAPTILER_SESSION_ID: string;
 /**
  * Configuration class for the SDK

package/dist/src/helpers/index.d.ts

@@ -1,6 +1,5 @@
 import { takeScreenshot } from './screenshot';
 import { addPolyline, addPolygon, addPoint, addHeatmap } from './vectorlayerhelpers';
-
 export type { ZoomStringValues, ZoomNumberValues, PropertyValues, CommonShapeLayerOptions, PolylineLayerOptions, PolygonLayerOptions, PointLayerOptions, HeatmapLayerOptions, } from './vectorlayerhelpers';
 /**
  * Helpers are a set of functions to facilitate the creation of sources and layers

package/dist/src/helpers/screenshot.d.ts

@@ -1,5 +1,4 @@
 import { Map as MapSDK } from '../Map';
-
 /**
  * Takes a screenshot (PNG file) of the curent map view.
  * Depending on the options, this function can automatically trigger a download of te file.

package/dist/src/helpers/stylehelper.d.ts

@@ -1,7 +1,6 @@
 import { DataDrivenPropertyValueSpecification, ExpressionSpecification } from 'maplibre-gl';
 import { ColorRamp } from '../colorramp';
 import { DataDrivenStyle, PropertyValues, ZoomNumberValues, ZoomStringValues } from './vectorlayerhelpers';
-
 export type ColorPalette = [string, string, string, string];
 export declare const colorPalettes: Array<ColorPalette>;
 export declare function getRandomColor(): string;

package/dist/src/helpers/vectorlayerhelpers.d.ts

@@ -1,7 +1,6 @@
 import { FeatureCollection } from 'geojson';
 import { Map as SDKMap } from '../Map';
 import { ColorRamp } from '../colorramp';
-
 /**
  * Array of string values that depend on zoom level
  */

package/dist/src/index.d.ts

@@ -1,5 +1,4 @@
 import { default as maplibregl } from 'maplibre-gl';
-
 export type * from 'maplibre-gl';
 /**
  * Get the version of MapTiler SDK
@@ -84,7 +83,7 @@ export { type AutomaticStaticMapOptions, type BoundedStaticMapOptions, type Buff
 export { getWebGLSupportError } from './tools';
 export { config, SdkConfig } from './config';
 export * from './language';
-export { type Unit } from './unit';
+export type { Unit } from './unit';
 export * from './Minimap';
 export * from './converters';
 export * from './colorramp';

package/dist/src/language.d.ts

@@ -1,5 +1,4 @@
 import { LanguageInfo } from '@maptiler/client';
-
 declare const Language: {
     readonly ALBANIAN: LanguageInfo;
     readonly AMHARIC: LanguageInfo;

package/dist/src/mapstyle.d.ts

@@ -1,5 +1,4 @@
 import { ReferenceMapStyle, MapStyleVariant } from '@maptiler/client';
-
 export declare function styleToStyle(style: string | ReferenceMapStyle | MapStyleVariant | maplibregl.StyleSpecification | null | undefined): {
     style: string | maplibregl.StyleSpecification;
     requiresUrlMonitoring: boolean;

package/dist/src/tools.d.ts

@@ -1,6 +1,5 @@
 import { default as maplibregl, RequestParameters, ResourceType, RequestTransformFunction } from 'maplibre-gl';
 import { Map as MapSDK } from './Map';
-
 export declare function enableRTL(): void;
 export declare function bindAll(fns: Array<string>, context: any): void;
 export declare function DOMcreate<K extends keyof HTMLElementTagNameMap>(tagName: K, className?: string, container?: HTMLElement): HTMLElementTagNameMap[K];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maptiler/sdk",
-  "version": "3.0.0-rc.4",
+  "version": "3.0.0",
   "description": "The Javascript & TypeScript map SDK tailored for MapTiler Cloud",
   "module": "dist/maptiler-sdk.mjs",
   "types": "dist/maptiler-sdk.d.ts",
@@ -37,35 +37,35 @@
     "biome": "biome check --max-diagnostics=1000",
     "biome:fix": "npx @biomejs/biome check --max-diagnostics=1000 --write",
     "doc": "rm -rf docs/* && typedoc --out docs && cp -r images docs/",
-    "test": "vitest run",
-    "build-css": "node scripts/replace-path-with-content.js src/style/style_template.css dist/tmp_maptiler-sdk.css && cat node_modules/maplibre-gl/dist/maplibre-gl.css dist/tmp_maptiler-sdk.css > dist/maptiler-sdk.css && rm dist/tmp_maptiler-sdk.css && cp dist/maptiler-sdk.css build/maptiler-sdk.css",
+    "test": "vitest run -c vite.config-test.ts",
+    "build-css": "mkdir -p dist build && node scripts/replace-path-with-content.js src/style/style_template.css dist/tmp_maptiler-sdk.css && cat node_modules/maplibre-gl/dist/maplibre-gl.css dist/tmp_maptiler-sdk.css > dist/maptiler-sdk.css && rm dist/tmp_maptiler-sdk.css && cp dist/maptiler-sdk.css build/maptiler-sdk.css",
     "build-umd": "tsc && NODE_ENV=production vite build -c vite.config-umd.ts",
     "build-es": "tsc && NODE_ENV=production vite build -c vite.config-es.ts",
     "build": "npm run build-es; npm run build-umd; npm run build-css",
     "make": "npm run biome:fix && npm run build",
+    "dev": "concurrently \"vite -c vite.config-dev.ts\" \"npm run dev-umd\"",
     "dev-umd": "npm run build-css && tsc && NODE_ENV=dev vite build -w -c vite.config-umd.ts",
-    "help": "vite build --help"
+    "ncu": "npx npm-check-updates"
   },
   "author": "MapTiler",
   "devDependencies": {
-    "@biomejs/biome": "1.8.3",
-    "@types/uuid": "^9.0.2",
+    "@biomejs/biome": "1.9.4",
+    "@types/uuid": "^10.0.0",
     "@types/xmldom": "^0.1.31",
     "@xmldom/xmldom": "^0.8.10",
-    "serve": "^14.2.0",
-    "terser": "^5.17.1",
-    "typedoc": "^0.24.8",
-    "typescript": "^5.1.6",
-    "vite": "^5.3.4",
-    "vite-plugin-dts": "^4.0.0-beta.0",
-    "vitest": "^0.34.2"
+    "concurrently": "^9.1.2",
+    "typedoc": "^0.27.6",
+    "typescript": "^5.7.2",
+    "vite": "^6.0.7",
+    "vite-plugin-dts": "^4.4.0",
+    "vitest": "^2.1.8"
   },
   "dependencies": {
     "@maplibre/maplibre-gl-style-spec": "^22.0.1",
     "@maptiler/client": "^2.2.0",
     "events": "^3.3.0",
-    "js-base64": "^3.7.4",
-    "maplibre-gl": "^5.0.0-pre.9",
-    "uuid": "^9.0.0"
+    "js-base64": "^3.7.7",
+    "maplibre-gl": "^5.0.0",
+    "uuid": "^11.0.4"
   }
 }

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-dev.ts

@@ -0,0 +1,27 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  plugins: [
+    {
+      name: 'url-override',
+      /**
+       * Changing logged URLs to include the path to the demo directory.
+       */
+      configureServer: (server) => {
+        const printUrls = server.printUrls;
+
+        server.printUrls = () => {
+          if (server.resolvedUrls !== null) {
+            for (const [key, value] of Object.entries(server.resolvedUrls)) {
+              for (let i = 0; i < value.length; i++) {
+                server.resolvedUrls[key][i] += "demos/index.html";
+              }
+            }
+          }
+
+          printUrls();
+        }
+      }
+    }
+  ],
+});

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: [],
+});