@maptiler/sdk 3.0.1 → 3.2.0-rc.1

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/MLAdapters/ScaleControl.d.ts

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

@@ -125,11 +125,18 @@ 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>`
  */
 export declare class Map extends maplibregl.Map {
+    private options;
     readonly telemetry: Telemetry;
     private isTerrainEnabled;
     private terrainExaggeration;
@@ -148,6 +155,12 @@ 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.
+     */
+    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/MaptilerGeolocateControl.d.ts

@@ -1,4 +1,10 @@
+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;
+};
 /**
  * The MaptilerGeolocateControl is an extension of the original GeolocateControl
  * with a few changes. In this version, the active mode persists as long as the
@@ -7,6 +13,10 @@ import { GeolocateControl } from './MLAdapters/GeolocateControl';
  */
 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
      *
@@ -19,3 +29,4 @@ export declare class MaptilerGeolocateControl extends GeolocateControl {
     _onZoom: () => void;
     _setErrorState(): void;
 }
+export {};

package/dist/src/MaptilerLogoControl.d.ts

@@ -4,6 +4,7 @@ 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
@@ -13,7 +14,10 @@ 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/MaptilerNavigationControl.d.ts

@@ -1,10 +1,23 @@
-import { NavigationControlOptions } from 'maplibre-gl';
 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 {
-    constructor(options?: NavigationControlOptions);
+    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
      */

package/dist/src/MaptilerProjectionControl.d.ts

@@ -1,5 +1,9 @@
 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.
  */
@@ -7,8 +11,14 @@ 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/MaptilerScaleControl.d.ts

@@ -0,0 +1,15 @@
+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 {};

package/dist/src/MaptilerTerrainControl.d.ts

@@ -4,13 +4,22 @@ 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;
-    constructor();
+    private externalTerrain?;
+    private options;
+    constructor(options?: MaptilerTerrainControlOptions);
     onAdd(map: SDKMap): HTMLElement;
+    private setupInternalElements;
+    private setupExternalElements;
     onRemove(): void;
-    _toggleTerrain(): void;
-    _updateTerrainIcon(): void;
+    _toggleTerrain: () => void;
+    _updateTerrainIcon: () => void;
 }
+export {};

package/dist/src/config.d.ts

@@ -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/index.d.ts

@@ -79,8 +79,9 @@ export * from './MaptilerLogoControl';
 export * from './MaptilerTerrainControl';
 export * from './MaptilerNavigationControl';
 export * from './MaptilerProjectionControl';
+export * from './MaptilerScaleControl';
 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';

package/dist/src/tools.d.ts

@@ -3,7 +3,7 @@ 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;
+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 +45,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 +82,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/eslint.config.mjs

@@ -0,0 +1,60 @@
+// @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-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.1",
+  "version": "3.2.0-rc.1",
   "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,28 +35,39 @@
     "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/",
+    "ncu": "npx npm-check-updates",
+    "lint": "npx eslint src",
+    "lint:fix": "npx eslint src --fix",
     "test": "vitest run -c vite.config-test.ts",
+    "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=development 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",
+    "@eslint/js": "^9.21.0",
     "@types/uuid": "^10.0.0",
     "@types/xmldom": "^0.1.31",
     "@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",
+    "husky": "^8.0.0",
+    "lint-staged": "^15.4.3",
+    "prettier": "3.5.2",
     "typedoc": "^0.27.6",
     "typescript": "^5.7.3",
+    "typescript-eslint": "^8.25.0",
     "vite": "^6.0.7",
     "vite-plugin-dts": "^4.5.0",
     "vitest": "^2.1.8"

package/tsconfig.json

@@ -5,23 +5,27 @@
     "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"
+  ],
 }

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"
-        }
-      }
-    }
-  }
-}