@maptiler/sdk 3.2.0-rc.1 → 3.2.0

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

@@ -1,8 +1,5 @@
 import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
 import { Map as SDKMap } from '../Map';
-/**
- * @deprecated Please use MaptilerScaleControl from '@maptiler/sdk' instead.
- */
 export declare class ScaleControl extends maplibregl.ScaleControl {
     onAdd(map: SDKMap | MapMLGL): HTMLElement;
 }

package/dist/src/Map.d.ts

@@ -2,7 +2,7 @@ import { default as maplibregl, StyleSpecification, MapOptions as MapOptionsML,
 import { ReferenceMapStyle, MapStyleVariant } from '@maptiler/client';
 import { SdkConfig } from './config';
 import { LanguageInfo } from './language';
-import { MinimapOptionsInput } from './Minimap';
+import { MinimapOptionsInput } from './controls/Minimap';
 import { Telemetry } from './Telemetry';
 export type LoadWithTerrainEvent = {
     type: "loadWithTerrain";
@@ -125,12 +125,6 @@ export type MapOptions = Omit<MapOptionsML, "style" | "maplibreLogo"> & {
      * If not provided, the style takes precedence. If provided, overwrite the style.
      */
     projection?: ProjectionTypes;
-    /**
-     * Enable or disable all default controls. When false, no default controls will be added.
-     * Individual controls can still be added manually using addControl().
-     * @default true
-     */
-    defaultControls?: boolean;
 };
 /**
  * The Map class can be instanciated to display a map in a `<div>`
@@ -155,7 +149,6 @@ export declare class Map extends maplibregl.Map {
     private isStyleLocalized;
     private languageIsUpdated;
     constructor(options: MapOptions);
-    private checkControlsConfiguration;
     /**
      * Recreates the map instance with the same options.
      * Useful for WebGL context loss.

package/dist/src/config.d.ts

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

package/dist/src/{MaptilerGeolocateControl.d.ts → controls/MaptilerGeolocateControl.d.ts}

@@ -1,10 +1,4 @@
-import { GeolocateControlOptions, Map as MapMLGL } from 'maplibre-gl';
-import { GeolocateControl } from './MLAdapters/GeolocateControl';
-import { Map as SDKMap } from './Map';
-type MaptilerGeolocateControlOptions = GeolocateControlOptions & {
-    geolocateElement?: HTMLElement;
-    removeDefaultDOM?: boolean;
-};
+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
@@ -13,10 +7,6 @@ type MaptilerGeolocateControlOptions = GeolocateControlOptions & {
  */
 export declare class MaptilerGeolocateControl extends GeolocateControl {
     private lastUpdatedCenter;
-    private removeDefaultDOM;
-    private externalGeolocateElement?;
-    constructor(options?: MaptilerGeolocateControlOptions);
-    onAdd(map: SDKMap | MapMLGL): HTMLElement;
     /**
      * Update the camera location to center on the current position
      *
@@ -29,4 +19,3 @@ export declare class MaptilerGeolocateControl extends GeolocateControl {
     _onZoom: () => void;
     _setErrorState(): void;
 }
-export {};

package/dist/src/{MaptilerLogoControl.d.ts → controls/MaptilerLogoControl.d.ts}

@@ -1,10 +1,9 @@
 import { LogoControlOptions as LogoControlOptionsML } from 'maplibre-gl';
-import { LogoControl } from './MLAdapters/LogoControl';
-import { Map as SDKMap } from './Map';
+import { LogoControl } from '../MLAdapters/LogoControl';
+import { Map as SDKMap } from '../Map';
 type LogoControlOptions = LogoControlOptionsML & {
     logoURL?: string;
     linkURL?: string;
-    defaultControlsEnabled?: boolean;
 };
 /**
  * This LogoControl extends the MapLibre LogoControl but instead can use any image URL and
@@ -14,10 +13,7 @@ export declare class MaptilerLogoControl extends LogoControl {
     _compact: boolean;
     private logoURL;
     private linkURL;
-    private defaultControlsEnabled;
     constructor(options?: LogoControlOptions);
     onAdd(map: SDKMap): HTMLElement;
-    _createAnchor(): HTMLAnchorElement;
-    _externalControlsEnabled(): void;
 }
 export {};

package/dist/src/controls/MaptilerNavigationControl.d.ts

@@ -0,0 +1,17 @@
+import { NavigationControlOptions } from 'maplibre-gl';
+import { NavigationControl } from '../MLAdapters/NavigationControl';
+type HTMLButtonElementPlus = HTMLButtonElement & {
+    clickFunction: (e?: Event) => unknown;
+};
+export declare class MaptilerNavigationControl extends NavigationControl {
+    constructor(options?: NavigationControlOptions);
+    /**
+     * Overloading: the button now stores its click callback so that we can later on delete it and replace it
+     */
+    _createButton(className: string, fn: (e?: Event) => unknown): HTMLButtonElementPlus;
+    /**
+     * Overloading: Limit how flat the compass icon can get
+     */
+    _rotateCompassArrow: () => void;
+}
+export {};

package/dist/src/{MaptilerProjectionControl.d.ts → controls/MaptilerProjectionControl.d.ts}

@@ -1,9 +1,5 @@
-import { Map as SDKMap } from './Map';
+import { Map as SDKMap } from '../Map';
 import { IControl } from 'maplibre-gl';
-type MaptilerProjectionControlOptions = {
-    removeDefaultDOM?: boolean;
-    projectionElement?: HTMLElement;
-};
 /**
  * A `MaptilerProjectionControl` control adds a button to switch from Mercator to Globe projection.
  */
@@ -11,14 +7,8 @@ export declare class MaptilerProjectionControl implements IControl {
     map: SDKMap;
     container: HTMLElement;
     projectionButton: HTMLButtonElement;
-    private externalProjection?;
-    private options;
-    constructor(options?: MaptilerProjectionControlOptions);
     onAdd(map: SDKMap): HTMLElement;
     onRemove(): void;
-    private setupExternalElements;
     private toggleProjection;
-    private updateExternalTitle;
     private updateProjectionIcon;
 }
-export {};

package/dist/src/{MaptilerTerrainControl.d.ts → controls/MaptilerTerrainControl.d.ts}

@@ -1,25 +1,16 @@
-import { Map as SDKMap } from './Map';
+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.
  */
-type MaptilerTerrainControlOptions = {
-    removeDefaultDOM?: boolean;
-    terrainElement?: HTMLElement;
-};
 export declare class MaptilerTerrainControl implements IControl {
     _map: SDKMap;
     _container: HTMLElement;
     _terrainButton: HTMLButtonElement;
-    private externalTerrain?;
-    private options;
-    constructor(options?: MaptilerTerrainControlOptions);
+    constructor();
     onAdd(map: SDKMap): HTMLElement;
-    private setupInternalElements;
-    private setupExternalElements;
     onRemove(): void;
-    _toggleTerrain: () => void;
-    _updateTerrainIcon: () => void;
+    _toggleTerrain(): void;
+    _updateTerrainIcon(): void;
 }
-export {};

package/dist/src/{Minimap.d.ts → controls/Minimap.d.ts}

@@ -1,4 +1,4 @@
-import { Map as SDKMap, MapOptions } from './Map';
+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 {

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

@@ -0,0 +1,6 @@
+export * from './MaptilerGeolocateControl';
+export * from './MaptilerLogoControl';
+export * from './MaptilerTerrainControl';
+export * from './MaptilerNavigationControl';
+export * from './MaptilerProjectionControl';
+export * from './Minimap';

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

@@ -1,13 +1,3 @@
-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
- */
-export declare const helpers: {
-    addPolyline: typeof addPolyline;
-    addPolygon: typeof addPolygon;
-    addPoint: typeof addPoint;
-    addHeatmap: typeof addHeatmap;
-    takeScreenshot: typeof takeScreenshot;
-};
+export * from './screenshot';
+export * from './vectorlayerhelpers';
+export * from './stylehelper';

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

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

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

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

package/dist/src/index.d.ts

@@ -1,7 +1,8 @@
 import { default as maplibregl } from 'maplibre-gl';
 export type * from 'maplibre-gl';
 /**
- * Get the version of MapTiler SDK
+ * Get the version of MapTiler SDK, this is declared in the vite config
+ * to avoid importing the entire package.json
  */
 export declare function getVersion(): string;
 declare const MapMLGL: typeof maplibregl.Map;
@@ -73,19 +74,14 @@ export { TwoFingersTouchPitchHandler } from './MLAdapters/TwoFingersTouchPitchHa
 export { MapWheelEvent } from './MLAdapters/MapWheelEvent';
 export { MapTouchEvent } from './MLAdapters/MapTouchEvent';
 export { MapMouseEvent } from './MLAdapters/MapMouseEvent';
-export { Map, GeolocationType, type MapOptions, type LoadWithTerrainEvent, } from './Map';
-export * from './MaptilerGeolocateControl';
-export * from './MaptilerLogoControl';
-export * from './MaptilerTerrainControl';
-export * from './MaptilerNavigationControl';
-export * from './MaptilerProjectionControl';
-export * from './MaptilerScaleControl';
+export { Map, GeolocationType, type MapOptions, type LoadWithTerrainEvent } from './Map';
+export * from './controls';
 export { type AutomaticStaticMapOptions, type BoundedStaticMapOptions, type BufferToPixelDataFunction, type ByIdGeocodingOptions, type CenteredStaticMapOptions, type CommonForwardAndReverseGeocodingOptions, type CoordinateExport, type CoordinateGrid, type CoordinateId, type CoordinateSearch, type CoordinateSearchResult, type CoordinateTransformResult, type CoordinateTransformation, type Coordinates, type CoordinatesSearchOptions, type CoordinatesTransformOptions, type DefaultTransformation, type ElevationAtOptions, type ElevationBatchOptions, type FeatureHierarchy, type FetchFunction, type GeocodingFeature, type GeocodingOptions, type GeocodingSearchResult, type GeolocationInfoOptions, type GeolocationResult, type GetDataOptions, type LanguageGeocodingOptions, MapStyle, type MapStylePreset, type MapStyleType, MapStyleVariant, type PixelData, ReferenceMapStyle, type ReverseGeocodingOptions, ServiceError, type StaticMapBaseOptions, type StaticMapMarker, type TileJSON, type XYZ, bufferToPixelDataBrowser, circumferenceAtLatitude, coordinates, data, elevation, expandMapStyle, geocoding, geolocation, getBufferToPixelDataParser, getTileCache, mapStylePresetList, math, misc, staticMaps, styleToStyle, type LanguageInfo, areSameLanguages, toLanguageInfo, isLanguageInfo, getAutoLanguage, getLanguageInfoFromFlag, getLanguageInfoFromCode, getLanguageInfoFromKey, } from '@maptiler/client';
 export { getWebGLSupportError, displayWebGLContextLostWarning } from './tools';
 export { config, SdkConfig } from './config';
 export * from './language';
-export type { Unit } from './unit';
-export * from './Minimap';
+export type { Unit } from './types';
 export * from './converters';
-export * from './colorramp';
-export * from './helpers';
+export * as helpers from './helpers';
+export * from './ColorRamp';
+export * from './utils';

package/dist/src/tools.d.ts

@@ -2,8 +2,6 @@ import { default as maplibregl, RequestParameters, ResourceType, RequestTransfor
 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];
-export declare function DOMRemove(node: HTMLElement): void;
 /**
  * This function is meant to be used as transformRequest by any Map instance created.
  * It adds the session ID as well as the MapTiler Cloud key from the config to all the requests

package/dist/src/utils/dom.d.ts

@@ -0,0 +1,2 @@
+export declare function DOMcreate<K extends keyof HTMLElementTagNameMap>(tagName: K, className?: string, container?: HTMLElement): HTMLElementTagNameMap[K];
+export declare function DOMremove(node: HTMLElement): void;

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

@@ -0,0 +1 @@
+export * from './dom';

package/dist/vite.config-test.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vite').UserConfig;
+export default _default;

package/dist/vitest-setup-tests.d.ts

@@ -0,0 +1 @@
+export {};

package/eslint.config.mjs

@@ -27,6 +27,7 @@ export default tseslint.config(
       "@typescript-eslint/no-base-to-string": "warn",
       "@typescript-eslint/no-confusing-void-expression": "warn",
       "@typescript-eslint/no-explicit-any": "warn",
+      "@typescript-eslint/no-empty-function": "warn", // this is to satisfy maplibre-gl custom layer interface
       "@typescript-eslint/no-floating-promises": "warn",
       "@typescript-eslint/no-inferrable-types": "off",
       "@typescript-eslint/no-misused-promises": "warn",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maptiler/sdk",
-  "version": "3.2.0-rc.1",
+  "version": "3.2.0",
   "description": "The Javascript & TypeScript map SDK tailored for MapTiler Cloud",
   "author": "MapTiler",
   "module": "dist/maptiler-sdk.mjs",
@@ -38,9 +38,10 @@
     "prepare": "husky",
     "doc": "rm -rf docs/* && typedoc --out docs && cp -r images docs/",
     "ncu": "npx npm-check-updates",
-    "lint": "npx eslint src",
-    "lint:fix": "npx eslint src --fix",
-    "test": "vitest run -c vite.config-test.ts",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "test:watch": "vitest watch -c vite.config-test.ts --dom",
+    "test": "vitest run -c vite.config-test.ts --dom",
     "install:clean": "rm -rf build/ dist/ node_modules/ && npm ci",
     "dev": "concurrently \"vite -c vite.config-dev.ts\" \"npm run dev-umd\"",
     "dev-umd": "npm run build-css && tsc && NODE_ENV=development vite build -w -c vite.config-umd.ts",
@@ -54,14 +55,17 @@
     "*.ts": "npm run lint:fix"
   },
   "devDependencies": {
+    "@canvas/image-data": "^1.0.0",
     "@eslint/js": "^9.21.0",
     "@types/uuid": "^10.0.0",
     "@types/xmldom": "^0.1.31",
+    "@vitest/web-worker": "^3.0.9",
     "@xmldom/xmldom": "^0.8.10",
     "concurrently": "^9.1.2",
     "eslint": "^9.21.0",
     "eslint-config-prettier": "^10.0.2",
     "eslint-plugin-prettier": "^5.2.3",
+    "happy-dom": "^17.4.4",
     "husky": "^8.0.0",
     "lint-staged": "^15.4.3",
     "prettier": "3.5.2",
@@ -70,14 +74,14 @@
     "typescript-eslint": "^8.25.0",
     "vite": "^6.0.7",
     "vite-plugin-dts": "^4.5.0",
-    "vitest": "^2.1.8"
+    "vitest": "^3.0.9"
   },
   "dependencies": {
     "@maplibre/maplibre-gl-style-spec": "^23.0.0",
-    "@maptiler/client": "^2.2.0",
+    "@maptiler/client": "^2.3.2",
     "events": "^3.3.0",
     "js-base64": "^3.7.7",
-    "maplibre-gl": "^5.0.1",
+    "maplibre-gl": "^5.3.1",
     "uuid": "^11.0.5"
   }
 }

package/tsconfig.json

@@ -26,6 +26,9 @@
   },
   "include": [
     "src",
-    "./eslint.config.mjs"
+    "./eslint.config.mjs",
+    "test",
+    "./vite.config-test.ts",
+    "./vitest-setup-tests.ts"
   ],
 }

package/vite.config-dev.ts

@@ -1,9 +1,13 @@
 import { defineConfig } from "vitest/config";
+import packagejson from "./package.json";
 
 export default defineConfig({
   server: {
     port: 3000,
   },
+  define: {
+    __MT_SDK_VERSION__: JSON.stringify(packagejson.version),
+  },
   plugins: [
     {
       name: 'url-override',

package/vite.config-es.ts

@@ -1,6 +1,7 @@
 import { resolve } from 'path';
 import { defineConfig } from 'vite';
 import dts from 'vite-plugin-dts';
+import packagejson from "./package.json";
 
 const isProduction = process.env.NODE_ENV === "production";
 
@@ -43,6 +44,9 @@ export default defineConfig({
         globals: {},
       },
     },
+  },
+    define: {
+    __MT_SDK_VERSION__: JSON.stringify(packagejson.version),
   },
   plugins,
 })

package/vite.config-test.ts

@@ -1,4 +1,5 @@
 import { defineConfig } from "vitest/config";
+import packagejson from "./package.json";
 
 export default defineConfig({
   test: {
@@ -6,5 +7,11 @@ export default defineConfig({
     typecheck: {
       tsconfig: "./tsconfig.json",
     },
+    // environment: "jsdom",
+    globals: true,
+    setupFiles: ["@vitest/web-worker", "./vitest-setup-tests.ts"],
+  },
+  define: {
+    __MT_SDK_VERSION__: JSON.stringify(packagejson.version),
   },
 });

package/vite.config-umd.ts

@@ -1,5 +1,6 @@
 import { resolve } from 'path';
 import { defineConfig } from 'vite';
+import packagejson from "./package.json";
 
 const isProduction = process.env.NODE_ENV === "production";
 
@@ -17,5 +18,8 @@ export default defineConfig({
       formats: ['umd'],
     }
   },
+  define: {
+    __MT_SDK_VERSION__: JSON.stringify(packagejson.version),
+  },
   plugins: [],
 });

package/vitest-setup-tests.ts

@@ -0,0 +1,4 @@
+import ImageData from "@canvas/image-data";
+
+// @ts-expect-error: Global type missing
+global.ImageData = ImageData;

package/dist/src/MaptilerNavigationControl.d.ts

@@ -1,30 +0,0 @@
-import { NavigationControl } from './MLAdapters/NavigationControl';
-import { Map as MapMLGL, NavigationControlOptions } from 'maplibre-gl';
-import { Map as SDKMap } from './Map';
-type HTMLButtonElementPlus = HTMLButtonElement & {
-    clickFunction: (e?: Event) => unknown;
-};
-type MaptilerNavigationControlOptions = NavigationControlOptions & {
-    compassElement?: HTMLElement;
-    zoomInElement?: HTMLElement;
-    zoomOutElement?: HTMLElement;
-    removeDefaultDOM?: boolean;
-};
-export declare class MaptilerNavigationControl extends NavigationControl {
-    private externalCompass?;
-    private externalZoomIn?;
-    private externalZoomOut?;
-    private removeDefaultDOM?;
-    constructor(options?: MaptilerNavigationControlOptions);
-    onAdd(map: SDKMap | MapMLGL): HTMLElement;
-    private setupExternalElements;
-    /**
-     * Overloading: the button now stores its click callback so that we can later on delete it and replace it
-     */
-    _createButton(className: string, fn: (e?: Event) => unknown): HTMLButtonElementPlus;
-    /**
-     * Overloading: Limit how flat the compass icon can get
-     */
-    _rotateCompassArrow: () => void;
-}
-export {};

package/dist/src/MaptilerScaleControl.d.ts

@@ -1,15 +0,0 @@
-import { default as maplibregl, Map as MapMLGL, ScaleControlOptions } from 'maplibre-gl';
-import { Map as SDKMap } from './Map';
-type MaptilerScaleControlOptions = ScaleControlOptions & {
-    removeDefaultDOM?: boolean;
-    scaleElement?: HTMLElement;
-};
-export declare class MaptilerScaleControl extends maplibregl.ScaleControl {
-    private externalScale?;
-    private removeDefaultDOM?;
-    constructor(options?: MaptilerScaleControlOptions);
-    _onMove: () => void;
-    onAdd(map: SDKMap | MapMLGL): HTMLElement;
-    onRemove(): void;
-}
-export {};