@maptiler/sdk 3.0.0 → 3.0.2

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

@@ -1,5 +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);
+    constructor(type: string, map: SDKMap | MapMLGL, originalEvent: MouseEvent, data?: Record<string, unknown>);
 }

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";
@@ -130,6 +130,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 {
+    private options;
     readonly telemetry: Telemetry;
     private isTerrainEnabled;
     private terrainExaggeration;
@@ -148,6 +149,11 @@ export declare class Map extends maplibregl.Map {
     private isStyleLocalized;
     private languageIsUpdated;
     constructor(options: MapOptions);
+    /**
+     * Recreates the map instance with the same options.
+     * Useful for WebGL context loss.
+     */
+    recreate(): void;
     /**
      * Set the duration (millisec) of the terrain animation for growing or flattening.
      * Must be positive. (Built-in default: `1000` milliseconds)

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
@@ -45,7 +45,7 @@ declare class SdkConfig extends EventEmitter {
      * - 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.
+     * In addition, each official module will be added to a list, alongside its version number.
      */
     telemetry: boolean;
     /**

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

@@ -1,4 +1,4 @@
-import { GeolocateControl } from './MLAdapters/GeolocateControl';
+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

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

@@ -1,6 +1,6 @@
 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;

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

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

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

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

@@ -1,4 +1,4 @@
-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

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,18 +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 { 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 } from './tools';
+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
@@ -45,9 +43,9 @@ export declare function getWebGLSupportError(): string | null;
  */
 export declare function displayNoWebGlWarning(container: HTMLElement | string): void;
 /**
- * Display an error message in the Map div if WebGL2 is not supported
+ * Display a warning message in the Map div if the WebGL context was lost
  */
-export declare function displayWebGLContextLostWarning(container: HTMLElement | string): void;
+export declare function displayWebGLContextLostWarning(map: MapSDK): void;
 /**
  * In a text-field style property (as an object, not a string) the languages that are specified as
  * ["get", "name:XX"] are replaced by the proved replacer (also an object).
@@ -82,7 +80,5 @@ export declare function findLanguageStr(str: string): Array<string | null>;
 export declare function findLanguageObj(origExpr: maplibregl.ExpressionSpecification): Array<string | null>;
 export declare function computeLabelsLocalizationMetrics(layers: maplibregl.LayerSpecification[], map: MapSDK): {
     unlocalized: number;
-    localized: {
-        [k: string]: number;
-    };
+    localized: Record<string, number>;
 };

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

@@ -0,0 +1,61 @@
+// @ts-check
+
+import tseslint from "typescript-eslint";
+import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";
+
+export default tseslint.config(
+  // https://typescript-eslint.io/getting-started/typed-linting/
+  tseslint.configs.strictTypeChecked,
+  tseslint.configs.stylisticTypeChecked,
+  tseslint.configs.recommendedTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  // https://github.com/prettier/eslint-plugin-prettier
+  eslintPluginPrettierRecommended,
+  //
+  {
+    rules: {
+      "@typescript-eslint/array-type": "off",
+      "@typescript-eslint/consistent-indexed-object-style": "warn",
+      "@typescript-eslint/consistent-type-definitions": "off",
+      "@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",
+      "@typescript-eslint/no-unnecessary-boolean-literal-compare": "off",
+      "@typescript-eslint/no-unnecessary-condition": "warn",
+      "@typescript-eslint/no-unnecessary-type-arguments": "off",
+      "@typescript-eslint/no-unnecessary-type-assertion": "off",
+      "@typescript-eslint/no-unnecessary-type-parameters": "warn",
+      "@typescript-eslint/no-unused-vars": "warn",
+      "@typescript-eslint/no-unsafe-argument": "warn",
+      "@typescript-eslint/no-unsafe-assignment": "warn",
+      "@typescript-eslint/no-unsafe-call": "warn",
+      "@typescript-eslint/no-unsafe-enum-comparison": "off",
+      "@typescript-eslint/no-unsafe-member-access": "warn",
+      "@typescript-eslint/no-unsafe-return": "warn",
+      "@typescript-eslint/no-non-null-assertion": "warn",
+      "@typescript-eslint/non-nullable-type-assertion-style": "warn",
+      "@typescript-eslint/prefer-for-of": "off",
+      "@typescript-eslint/prefer-nullish-coalescing": "warn",
+      "@typescript-eslint/prefer-optional-chain": "off",
+      "@typescript-eslint/prefer-return-this-type": "off",
+      "@typescript-eslint/prefer-string-starts-ends-with": "warn",
+      "@typescript-eslint/restrict-plus-operands": "warn",
+      "@typescript-eslint/restrict-template-expressions": "warn",
+      "@typescript-eslint/related-getter-setter-pairs": "off",
+      "@typescript-eslint/unbound-method": "warn",
+      "@typescript-eslint/use-unknown-in-catch-callback-variable": "warn",
+    },
+  },
+  //
+);

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@maptiler/sdk",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "The Javascript & TypeScript map SDK tailored for MapTiler Cloud",
+  "author": "MapTiler",
   "module": "dist/maptiler-sdk.mjs",
   "types": "dist/maptiler-sdk.d.ts",
   "style": "dist/maptiler-sdk.css",
@@ -34,38 +35,53 @@
     "url": "https://github.com/maptiler/maptiler-sdk-js.git"
   },
   "scripts": {
-    "biome": "biome check --max-diagnostics=1000",
-    "biome:fix": "npx @biomejs/biome check --max-diagnostics=1000 --write",
+    "prepare": "husky",
     "doc": "rm -rf docs/* && typedoc --out docs && cp -r images docs/",
-    "test": "vitest run -c vite.config-test.ts",
+    "ncu": "npx npm-check-updates",
+    "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",
     "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",
-    "ncu": "npx npm-check-updates"
+    "make": "npm run install:clean && npm run build"
+  },
+  "lint-staged": {
+    "*.ts": "npm run lint:fix"
   },
-  "author": "MapTiler",
   "devDependencies": {
-    "@biomejs/biome": "1.9.4",
+    "@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",
     "typedoc": "^0.27.6",
-    "typescript": "^5.7.2",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.25.0",
     "vite": "^6.0.7",
-    "vite-plugin-dts": "^4.4.0",
-    "vitest": "^2.1.8"
+    "vite-plugin-dts": "^4.5.0",
+    "vitest": "^3.0.9"
   },
   "dependencies": {
-    "@maplibre/maplibre-gl-style-spec": "^22.0.1",
+    "@maplibre/maplibre-gl-style-spec": "^23.0.0",
     "@maptiler/client": "^2.2.0",
     "events": "^3.3.0",
     "js-base64": "^3.7.7",
-    "maplibre-gl": "^5.0.0",
-    "uuid": "^11.0.4"
+    "maplibre-gl": "^5.0.1",
+    "uuid": "^11.0.5"
   }
 }

package/tsconfig.json

@@ -5,23 +5,30 @@
     "target": "es2021",
     "useDefineForClassFields": true,
     "module": "ESNext",
-    "lib": ["es2021", "DOM", "DOM.Iterable"],
+    "lib": [
+      "es2021",
+      "DOM",
+      "DOM.Iterable"
+    ],
     "skipLibCheck": true,
-
     /* Bundler mode */
     "resolveJsonModule": true,
     "isolatedModules": true,
     "noEmit": true,
-
     /* Linting */
     "strict": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "noFallthroughCasesInSwitch": true,
-
-
     "declaration": true,
     "allowSyntheticDefaultImports": true,
+    "allowJs": true,
   },
-  "include": ["src"]
+  "include": [
+    "src",
+    "./eslint.config.mjs",
+    "test",
+    "./vite.config-test.ts",
+    "./vitest-setup-tests.ts"
+  ],
 }

package/vite.config-dev.ts

@@ -1,6 +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/biome.json

@@ -1,50 +0,0 @@
-{
-  "files": {
-    "include": ["./src/**/*.js", "./src/**/*.ts"],
-    "ignore": ["dist", "build"]
-  },
-  "organizeImports": {
-    "enabled": false
-  },
-  "formatter": {
-    "indentStyle": "space",
-    "indentWidth": 2,
-    "lineWidth": 120
-  },
-  "javascript": {
-    "formatter": {
-      "arrowParentheses": "always",
-      "bracketSameLine": false,
-      "bracketSpacing": true,
-      "jsxQuoteStyle": "double",
-      "quoteProperties": "asNeeded",
-      "semicolons": "always",
-      "trailingCommas": "all"
-    }
-  },
-  "json": {
-    "formatter": {
-      "trailingCommas": "none"
-    }
-  },
-  "linter": {
-    "rules": {
-      "style": {
-        "noInferrableTypes": "off"
-      },
-      "suspicious": {
-        "noExplicitAny": {
-          "level": "off"
-        }
-      },
-      "complexity": {
-        "noUselessTernary": {
-          "level": "off"
-        },
-        "useOptionalChain": {
-          "level": "off"
-        }
-      }
-    }
-  }
-}