@maptiler/sdk 3.1.0-rc1 → 3.2.0-rc.1

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

@@ -4,8 +4,6 @@ import { SdkConfig } from './config';
 import { LanguageInfo } from './language';
 import { MinimapOptionsInput } from './Minimap';
 import { Telemetry } from './Telemetry';
-import { CubemapDefinition, CubemapLayer, CubemapLayerConstructorOptions } from './custom-layers/CubemapLayer';
-import { GradientDefinition, RadialGradientLayer, RadialGradientLayerOptions } from './custom-layers/RadialGradientLayer';
 export type LoadWithTerrainEvent = {
     type: "loadWithTerrain";
     target: Map;
@@ -128,25 +126,18 @@ export type MapOptions = Omit<MapOptionsML, "style" | "maplibreLogo"> & {
      */
     projection?: ProjectionTypes;
     /**
-     * Turn on/off spacebox.
-     *
-     * Default: { color: "#1D29F1" }
+     * 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
      */
-    space?: CubemapLayerConstructorOptions | boolean;
-    halo?: RadialGradientLayerOptions | boolean;
+    defaultControls?: boolean;
 };
 /**
  * The Map class can be instanciated to display a map in a `<div>`
  */
 export declare class Map extends maplibregl.Map {
-    readonly telemetry: Telemetry;
-    private space?;
-    private halo?;
-    getSpace(): CubemapLayer | undefined;
-    setSpace(space: CubemapDefinition): void;
-    getHalo(): RadialGradientLayer | undefined;
-    setHalo(halo: GradientDefinition): void;
     private options;
+    readonly telemetry: Telemetry;
     private isTerrainEnabled;
     private terrainExaggeration;
     private primaryLanguage;
@@ -164,6 +155,7 @@ 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/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/index.d.ts

@@ -73,12 +73,13 @@ 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 { 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 { 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';

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

package/eslint.config.mjs

@@ -27,7 +27,6 @@ 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.1.0rc1",
+  "version": "3.2.0-rc.1",
   "description": "The Javascript & TypeScript map SDK tailored for MapTiler Cloud",
   "author": "MapTiler",
   "module": "dist/maptiler-sdk.mjs",
@@ -55,8 +55,6 @@
   },
   "devDependencies": {
     "@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",
     "@xmldom/xmldom": "^0.8.10",
@@ -78,7 +76,6 @@
     "@maplibre/maplibre-gl-style-spec": "^23.0.0",
     "@maptiler/client": "^2.2.0",
     "events": "^3.3.0",
-    "gl-matrix": "^3.4.3",
     "js-base64": "^3.7.7",
     "maplibre-gl": "^5.0.1",
     "uuid": "^11.0.5"

package/.editorconfig

@@ -1,13 +0,0 @@
-# EditorConfig is awesome: https://EditorConfig.org
-
-# top-most EditorConfig file
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = LF
-charset = utf-8
-trim_trailing_whitespace = false
-insert_final_newline = true
-max_line_length = 180

package/dist/src/custom-layers/CubemapLayer/CubemapLayer.d.ts

@@ -1,29 +0,0 @@
-import { CustomLayerInterface, CustomRenderMethodInput } from 'maplibre-gl';
-import { Map as MapSDK } from '../../Map';
-import { WebGLContext } from '../../utils/webgl-utils';
-import { CubemapDefinition, CubemapLayerConstructorOptions } from './types';
-declare class CubemapLayer implements CustomLayerInterface {
-    id: string;
-    type: CustomLayerInterface["type"];
-    renderingMode: CustomLayerInterface["renderingMode"];
-    private map;
-    private faces?;
-    private useCubemapTexture;
-    private currentFadeOpacity;
-    private cubeMapNeedsUpdate;
-    private bgColor;
-    private gl;
-    private cubemap?;
-    private texture?;
-    constructor(cubemapConfig: CubemapLayerConstructorOptions | true);
-    updateCubemap(): void;
-    onAdd(map: MapSDK, gl: WebGLRenderingContext | WebGL2RenderingContext): void;
-    onRemove(_map: MapSDK, gl: WebGLRenderingContext | WebGL2RenderingContext): void;
-    prerender(gl: WebGLContext, _options: CustomRenderMethodInput): void;
-    private animateIn;
-    render(gl: WebGLRenderingContext | WebGL2RenderingContext, _options: CustomRenderMethodInput): void;
-    setCubemap(cubemap: CubemapDefinition): void;
-    show(): void;
-    hide(): void;
-}
-export { CubemapLayer };

package/dist/src/custom-layers/CubemapLayer/constants.d.ts

@@ -1,3 +0,0 @@
-declare const VERTICES: number[];
-declare const INDICES: number[];
-export { VERTICES, INDICES };

package/dist/src/custom-layers/CubemapLayer/index.d.ts

@@ -1,2 +0,0 @@
-export * from './CubemapLayer';
-export * from './types';

package/dist/src/custom-layers/CubemapLayer/loadCubemapTexture.d.ts

@@ -1,6 +0,0 @@
-import { CubemapFaces } from './types';
-export declare function loadCubemapTexture({ gl, faces, onLoadedCallback }: {
-    gl: WebGLRenderingContext | WebGL2RenderingContext;
-    faces?: CubemapFaces;
-    onLoadedCallback?: () => void;
-}): WebGLTexture | undefined;

package/dist/src/custom-layers/CubemapLayer/types.d.ts

@@ -1,37 +0,0 @@
-export declare enum CubemapImagesPresets {
-    UNIVERSE_DARK = "universe-dark"
-}
-export type CubemapLayerConstructorOptions = CubemapDefinition & {};
-export type CubemapDefinition = {
-    path: {
-        baseUrl: string;
-        format?: "png" | "jpg" | "webp";
-    };
-    faces?: never;
-    preset?: never;
-    color?: string;
-} | {
-    faces: CubemapFaces;
-    path?: never;
-    preset?: never;
-    color?: string;
-} | {
-    preset: string;
-    path?: never;
-    faces?: never;
-    color?: string;
-} | {
-    color: string;
-    path?: never;
-    faces?: never;
-    preset?: never;
-};
-export declare enum CubemapFaceNames {
-    POSITIVE_X = "pX",
-    NEGATIVE_X = "nX",
-    POSITIVE_Y = "pY",
-    NEGATIVE_Y = "nY",
-    POSITIVE_Z = "pZ",
-    NEGATIVE_Z = "nZ"
-}
-export type CubemapFaces = Record<CubemapFaceNames, string>;

package/dist/src/custom-layers/RadialGradientLayer/RadialGradientLayer.d.ts

@@ -1,23 +0,0 @@
-import { CustomLayerInterface, CustomRenderMethodInput } from 'maplibre-gl';
-import { Map as MapSDK } from '../../Map';
-import { GradientDefinition, RadialGradientLayerOptions } from './types';
-export declare class RadialGradientLayer implements CustomLayerInterface {
-    id: string;
-    type: CustomLayerInterface["type"];
-    renderingMode: CustomLayerInterface["renderingMode"];
-    private gradient;
-    private scale;
-    private map;
-    private plane?;
-    constructor(gradient: RadialGradientLayerOptions | boolean);
-    onAdd(map: MapSDK, gl: WebGLRenderingContext | WebGL2RenderingContext): void;
-    onRemove(_map: MapSDK, gl: WebGLRenderingContext | WebGL2RenderingContext): void;
-    prerender(_gl: WebGLRenderingContext | WebGL2RenderingContext, _options: CustomRenderMethodInput): void;
-    render(gl: WebGLRenderingContext | WebGL2RenderingContext, options: CustomRenderMethodInput): void;
-    /**
-     * Value settings methods
-     */
-    setGradient(gradient: GradientDefinition): void;
-    show(): void;
-    hide(): void;
-}

package/dist/src/custom-layers/RadialGradientLayer/index.d.ts

@@ -1,2 +0,0 @@
-export * from './RadialGradientLayer';
-export * from './types';

package/dist/src/custom-layers/RadialGradientLayer/types.d.ts

@@ -1,11 +0,0 @@
-import { Object3D } from '../../utils/webgl-utils';
-export type Color = string;
-export type GradientStop = number;
-export type RadialGradientLayerOptions = GradientDefinition;
-export type GradientDefinition = {
-    stops: Array<[GradientStop, Color]>;
-    scale: number;
-};
-export type GradientAttributeKey = "vertexPosition";
-export type GradientUniformKey = "stopsNumber" | "stops" | "colors";
-export type GradientPlaneObject3D = Pick<Object3D<GradientAttributeKey, GradientUniformKey>, "shaderProgram" | "programInfo" | "positionBuffer">;

package/dist/src/custom-layers/extractCustomLayerStyle.d.ts

@@ -1,18 +0,0 @@
-import { Map as MapSDK } from '../Map';
-import { StyleSpecification } from 'maplibre-gl';
-import { CubemapLayerConstructorOptions, RadialGradientLayerOptions } from 'custom-layers';
-export type StyleSpecificationWithMetaData = StyleSpecification & {
-    metadata?: {
-        "maptiler:copyright": string;
-        maptiler?: {
-            halo: RadialGradientLayerOptions;
-            space: CubemapLayerConstructorOptions;
-        };
-    };
-};
-export interface IExtractCustomLayerStyleOptions {
-    map: MapSDK;
-    property: "halo" | "space";
-}
-export type CustomLayerDefinitionType = CubemapLayerConstructorOptions | RadialGradientLayerOptions | null;
-export default function extractCustomLayerStyle(options: IExtractCustomLayerStyleOptions): CustomLayerDefinitionType;

package/dist/src/custom-layers/index.d.ts

@@ -1,5 +0,0 @@
-import { RadialGradientLayer } from './RadialGradientLayer';
-import { CubemapLayer } from './CubemapLayer';
-export { RadialGradientLayer, CubemapLayer };
-export * from './RadialGradientLayer/types';
-export * from './CubemapLayer/types';

package/dist/src/utils/geo-utils.d.ts

@@ -1,6 +0,0 @@
-import { LngLat } from 'maplibre-gl';
-declare function getAntipode(lngLat: LngLat): {
-    lat: number;
-    lng: number;
-};
-export { getAntipode };

package/dist/src/utils/math-utils.d.ts

@@ -1,4 +0,0 @@
-declare function minMax(value: number, min: number, max: number): number;
-declare function normalize(value: number, min: number, max: number): number;
-declare function diagonalOfSquare(side: number): number;
-export { minMax, normalize, diagonalOfSquare };

package/dist/src/utils/webgl-utils.d.ts

@@ -1,49 +0,0 @@
-export type WebGLContext = WebGLRenderingContext | WebGL2RenderingContext;
-/**
- * Load a shader from a source string
- */
-export declare function loadShader({ gl, type, source }: {
-    gl: WebGLContext;
-    type: GLenum;
-    source: string;
-}): WebGLShader;
-/**
- * Create a set of shaders (vertex and fragment) and link them into a program
- *
- * @param gl WebGL context
- * @param vertexShaderSource Vertex shader source code
- * @param fragmentShaderSource Fragment shader source code
- *
- * @returns WebGL program
- */
-export declare function createShadersSetProgram({ gl, vertexShaderSource, fragmentShaderSource }: {
-    gl: WebGLContext;
-    vertexShaderSource: string;
-    fragmentShaderSource: string;
-}): WebGLProgram;
-/**
- * null-free version of getUniformLocation
- */
-export declare function getUniformLocation(gl: WebGLRenderingContext | WebGL2RenderingContext, program: WebGLProgram, name: string): WebGLUniformLocation;
-export type Object3D<Attribute extends string, Uniform extends string> = {
-    shaderProgram: WebGLProgram;
-    programInfo: {
-        attributesLocations: Record<Attribute, number>;
-        uniformsLocations: Record<Uniform, WebGLUniformLocation>;
-    };
-    positionBuffer: WebGLBuffer;
-    indexBuffer?: WebGLBuffer;
-    indexBufferLength?: number;
-};
-export declare function createObject3D<Attribute extends string, Uniform extends string>({ gl, vertexShaderSource, fragmentShaderSource, attributesKeys, uniformsKeys, vertices, indices, }: {
-    gl: WebGLContext;
-    vertexShaderSource: string;
-    fragmentShaderSource: string;
-    attributesKeys: readonly Attribute[];
-    uniformsKeys: readonly Uniform[];
-    vertices: Array<number>;
-    indices?: Array<number>;
-}): Object3D<Attribute, Uniform>;
-export type Vec4 = [number, number, number, number];
-export declare function parseColorStringToVec4(color?: string): Vec4;
-export declare function degreesToRadians(degrees: number): number;