@maptiler/sdk 3.1.0-rc1 → 3.1.0-rc3

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';
 import { CubemapDefinition, CubemapLayer, CubemapLayerConstructorOptions } from './custom-layers/CubemapLayer';
 import { GradientDefinition, RadialGradientLayer, RadialGradientLayerOptions } from './custom-layers/RadialGradientLayer';
@@ -164,6 +164,8 @@ export declare class Map extends maplibregl.Map {
     private isStyleLocalized;
     private languageIsUpdated;
     constructor(options: MapOptions);
+    private initSpace;
+    private initHalo;
     /**
      * 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,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/custom-layers/extractCustomLayerStyle.d.ts

@@ -14,5 +14,4 @@ export interface IExtractCustomLayerStyleOptions {
     map: MapSDK;
     property: "halo" | "space";
 }
-export type CustomLayerDefinitionType = CubemapLayerConstructorOptions | RadialGradientLayerOptions | null;
-export default function extractCustomLayerStyle(options: IExtractCustomLayerStyleOptions): CustomLayerDefinitionType;
+export default function extractCustomLayerStyle<T extends CubemapLayerConstructorOptions | RadialGradientLayerOptions | null>(options: IExtractCustomLayerStyleOptions): T | null;

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;
@@ -74,17 +75,13 @@ 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 './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

@@ -35,7 +35,7 @@ export default tseslint.config(
       "@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-unnecessary-type-parameters": "off", // as we are a lib, types serve as documentation
       "@typescript-eslint/no-unused-vars": "warn",
       "@typescript-eslint/no-unsafe-argument": "warn",
       "@typescript-eslint/no-unsafe-assignment": "warn",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maptiler/sdk",
-  "version": "3.1.0rc1",
+  "version": "3.1.0rc3",
   "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,16 +55,19 @@
     "*.ts": "npm run lint:fix"
   },
   "devDependencies": {
+    "@canvas/image-data": "^1.0.0",
     "@eslint/js": "^9.21.0",
     "@types/color-convert": "^2.0.4",
     "@types/color-name": "^2.0.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",
@@ -72,7 +76,7 @@
     "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",

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;