maplibre-gl 3.5.1 → 3.5.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "maplibre-gl",
   "description": "BSD licensed community fork of mapbox-gl, a WebGL interactive maps library",
-  "version": "3.5.1",
+  "version": "3.5.2",
   "main": "dist/maplibre-gl.js",
   "style": "dist/maplibre-gl.css",
   "license": "BSD-3-Clause",
@@ -20,12 +20,12 @@
     "@mapbox/unitbezier": "^0.0.1",
     "@mapbox/vector-tile": "^1.3.1",
     "@mapbox/whoots-js": "^3.1.0",
-    "@maplibre/maplibre-gl-style-spec": "^19.3.2",
-    "@types/geojson": "^7946.0.11",
-    "@types/mapbox__point-geometry": "^0.1.2",
-    "@types/mapbox__vector-tile": "^1.3.1",
-    "@types/pbf": "^3.0.3",
-    "@types/supercluster": "^7.1.1",
+    "@maplibre/maplibre-gl-style-spec": "^19.3.3",
+    "@types/geojson": "^7946.0.12",
+    "@types/mapbox__point-geometry": "^0.1.3",
+    "@types/mapbox__vector-tile": "^1.3.3",
+    "@types/pbf": "^3.0.4",
+    "@types/supercluster": "^7.1.2",
     "earcut": "^2.2.4",
     "geojson-vt": "^3.2.1",
     "gl-matrix": "^3.4.3",
@@ -52,41 +52,42 @@
     "@types/benchmark": "^2.1.3",
     "@types/cssnano": "^5.0.0",
     "@types/d3": "^7.4.1",
-    "@types/diff": "^5.0.6",
-    "@types/earcut": "^2.1.2",
-    "@types/eslint": "^8.44.4",
-    "@types/gl": "^6.0.3",
+    "@types/diff": "^5.0.7",
+    "@types/earcut": "^2.1.3",
+    "@types/eslint": "^8.44.6",
+    "@types/geojson-vt": "3.2.3",
+    "@types/gl": "^6.0.4",
     "@types/glob": "^8.1.0",
     "@types/jest": "^29.5.3",
     "@types/jsdom": "^21.1.3",
-    "@types/minimist": "^1.2.3",
-    "@types/murmurhash-js": "^1.0.4",
+    "@types/minimist": "^1.2.4",
+    "@types/murmurhash-js": "^1.0.5",
     "@types/nise": "^1.4.2",
     "@types/node": "^20.8.3",
-    "@types/offscreencanvas": "^2019.7.1",
+    "@types/offscreencanvas": "^2019.7.2",
     "@types/pixelmatch": "^5.2.4",
-    "@types/pngjs": "^6.0.2",
-    "@types/react": "^18.2.28",
+    "@types/pngjs": "^6.0.3",
+    "@types/react": "^18.2.31",
     "@types/react-dom": "^18.2.13",
-    "@types/request": "^2.48.10",
-    "@types/shuffle-seed": "^1.1.0",
+    "@types/request": "^2.48.11",
+    "@types/shuffle-seed": "^1.1.1",
     "@types/window-or-global": "^1.0.4",
-    "@typescript-eslint/eslint-plugin": "^6.7.5",
-    "@typescript-eslint/parser": "^6.7.5",
+    "@typescript-eslint/eslint-plugin": "^6.8.0",
+    "@typescript-eslint/parser": "^6.8.0",
     "address": "^2.0.1",
     "benchmark": "^2.1.4",
     "canvas": "^2.11.2",
     "cssnano": "^6.0.1",
     "d3": "^7.8.5",
     "d3-queue": "^3.0.7",
-    "devtools-protocol": "^0.0.1209236",
+    "devtools-protocol": "^0.0.1212569",
     "diff": "^5.1.0",
     "dts-bundle-generator": "^8.0.1",
-    "eslint": "^8.51.0",
+    "eslint": "^8.52.0",
     "eslint-config-mourner": "^3.0.0",
     "eslint-plugin-html": "^7.1.0",
     "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-jest": "^27.4.2",
+    "eslint-plugin-jest": "^27.4.3",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-tsdoc": "0.2.17",
     "expect": "^29.7.0",
@@ -100,7 +101,7 @@
     "json-stringify-pretty-compact": "^4.0.0",
     "minimist": "^1.2.8",
     "mock-geolocation": "^1.0.11",
-    "nise": "^5.1.4",
+    "nise": "^5.1.5",
     "npm-font-open-sans": "^1.1.0",
     "npm-run-all": "^4.1.5",
     "pdf-merger-js": "^4.3.0",
@@ -120,7 +121,7 @@
     "shuffle-seed": "^1.1.6",
     "source-map-explorer": "^2.5.3",
     "st": "^3.0.0",
-    "stylelint": "^15.10.3",
+    "stylelint": "^15.11.0",
     "stylelint-config-standard": "^34.0.0",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",

package/src/data/bucket/symbol_bucket.ts

@@ -86,7 +86,7 @@ export type SymbolFeature = {
     sourceLayerIndex: number;
     geometry: Array<Array<Point>>;
     properties: any;
-    type: 'Point' | 'LineString' | 'Polygon';
+    type: 'Unknown' | 'Point' | 'LineString' | 'Polygon';
     id?: any;
 };
 

package/src/data/bucket.ts

@@ -40,7 +40,7 @@ export type BucketFeature = {
     sourceLayerIndex: number;
     geometry: Array<Array<Point>>;
     properties: any;
-    type: 1 | 2 | 3;
+    type: 0 | 1 | 2 | 3;
     id?: any;
     readonly patterns: {
         [_: string]: {

package/src/data/evaluation_feature.ts

@@ -1,21 +1,9 @@
 import {loadGeometry} from './load_geometry';
 import type Point from '@mapbox/point-geometry';
 import type {VectorTileFeature} from '@mapbox/vector-tile';
+import type {Feature} from '@maplibre/maplibre-gl-style-spec';
 
-type EvaluationFeature = {
-    readonly type: 1 | 2 | 3 | 'Unknown' | 'Point' | 'MultiPoint' | 'LineString' | 'MultiLineString' | 'Polygon' | 'MultiPolygon';
-    readonly id?: any;
-    readonly properties: {[_: string]: any};
-    readonly patterns?: {
-        [_: string]: {
-            'min': string;
-            'mid': string;
-            'max': string;
-        };
-    };
-    geometry: Array<Array<Point>>;
-};
-
+type EvaluationFeature = Feature & { geometry: Array<Array<Point>> };
 /**
  * Construct a new feature based on a VectorTileFeature for expression evaluation, the geometry of which
  * will be loaded based on necessity.

package/src/gl/webgl2.ts

@@ -5,7 +5,7 @@ export function isWebGL2(
     if (cache.has(gl)) {
         return cache.get(gl);
     } else {
-        const value = gl.getParameter(gl.VERSION).startsWith('WebGL 2.0');
+        const value = gl.getParameter(gl.VERSION)?.startsWith('WebGL 2.0');
         cache.set(gl, value);
         return value;
     }

package/src/source/geojson_worker_source.ts

@@ -4,8 +4,8 @@ import {RequestPerformance} from '../util/performance';
 import rewind from '@mapbox/geojson-rewind';
 import {GeoJSONWrapper} from './geojson_wrapper';
 import vtpbf from 'vt-pbf';
-import Supercluster, {type Options, type ClusterProperties} from 'supercluster';
-import geojsonvt from 'geojson-vt';
+import Supercluster, {type Options as SuperclusterOptions, type ClusterProperties} from 'supercluster';
+import geojsonvt, {type Options as GeoJSONVTOptions} from 'geojson-vt';
 import {VectorTileWorkerSource} from './vector_tile_worker_source';
 import {createExpression} from '@maplibre/maplibre-gl-style-spec';
 
@@ -32,8 +32,8 @@ export type LoadGeoJSONParameters = {
     dataDiff?: GeoJSONSourceDiff;
     source: string;
     cluster: boolean;
-    superclusterOptions?: Options<any, any>;
-    geojsonVtOptions?: any;
+    superclusterOptions?: SuperclusterOptions<any, any>;
+    geojsonVtOptions?: GeoJSONVTOptions;
     clusterProperties?: ClusterProperties;
     filter?: Array<unknown>;
     promoteId?: string;
@@ -41,48 +41,13 @@ export type LoadGeoJSONParameters = {
 
 export type LoadGeoJSON = (params: LoadGeoJSONParameters, callback: ResponseCallback<any>) => Cancelable;
 
-export interface GeoJSONIndex {
-    getTile(z: number, x: number, y: number): any;
-    // supercluster methods
-    getClusterExpansionZoom(clusterId: number): number;
-    getChildren(clusterId: number): Array<GeoJSON.Feature>;
-    getLeaves(clusterId: number, limit: number, offset: number): Array<GeoJSON.Feature>;
-}
-
-function loadGeoJSONTile(params: WorkerTileParameters, callback: LoadVectorDataCallback): (() => void) | void {
-    const canonical = params.tileID.canonical;
-
-    if (!this._geoJSONIndex) {
-        return callback(null, null);  // we couldn't load the file
-    }
-
-    const geoJSONTile = this._geoJSONIndex.getTile(canonical.z, canonical.x, canonical.y);
-    if (!geoJSONTile) {
-        return callback(null, null); // nothing in the given tile
-    }
-
-    const geojsonWrapper = new GeoJSONWrapper(geoJSONTile.features);
-
-    // Encode the geojson-vt tile into binary vector tile form.  This
-    // is a convenience that allows `FeatureIndex` to operate the same way
-    // across `VectorTileSource` and `GeoJSONSource` data.
-    let pbf = vtpbf(geojsonWrapper);
-    if (pbf.byteOffset !== 0 || pbf.byteLength !== pbf.buffer.byteLength) {
-        // Compatibility with node Buffer (https://github.com/mapbox/pbf/issues/35)
-        pbf = new Uint8Array(pbf);
-    }
-
-    callback(null, {
-        vectorTile: geojsonWrapper,
-        rawData: pbf.buffer
-    });
-}
+type GeoJSONIndex = ReturnType<typeof geojsonvt> | Supercluster;
 
 /**
  * The {@link WorkerSource} implementation that supports {@link GeoJSONSource}.
  * This class is designed to be easily reused to support custom source types
  * for data formats that can be parsed/converted into an in-memory GeoJSON
- * representation.  To do so, create it with
+ * representation. To do so, create it with
  * `new GeoJSONWorkerSource(actor, layerIndex, customLoadGeoJSONFunction)`.
  * For a full example, see [mapbox-gl-topojson](https://github.com/developmentseed/mapbox-gl-topojson).
  */
@@ -101,12 +66,41 @@ export class GeoJSONWorkerSource extends VectorTileWorkerSource {
      * See {@link GeoJSONWorkerSource#loadGeoJSON}.
      */
     constructor(actor: Actor, layerIndex: StyleLayerIndex, availableImages: Array<string>, loadGeoJSON?: LoadGeoJSON | null) {
-        super(actor, layerIndex, availableImages, loadGeoJSONTile);
+        super(actor, layerIndex, availableImages);
+        this.loadVectorData = this.loadGeoJSONTile;
         if (loadGeoJSON) {
             this.loadGeoJSON = loadGeoJSON;
         }
     }
 
+    loadGeoJSONTile(params: WorkerTileParameters, callback: LoadVectorDataCallback): (() => void) | void {
+        const canonical = params.tileID.canonical;
+
+        if (!this._geoJSONIndex) {
+            return callback(null, null);  // we couldn't load the file
+        }
+
+        const geoJSONTile = this._geoJSONIndex.getTile(canonical.z, canonical.x, canonical.y);
+        if (!geoJSONTile) {
+            return callback(null, null); // nothing in the given tile
+        }
+
+        const geojsonWrapper = new GeoJSONWrapper(geoJSONTile.features);
+        // Encode the geojson-vt tile into binary vector tile form.  This
+        // is a convenience that allows `FeatureIndex` to operate the same way
+        // across `VectorTileSource` and `GeoJSONSource` data.
+        let pbf = vtpbf(geojsonWrapper);
+        if (pbf.byteOffset !== 0 || pbf.byteLength !== pbf.buffer.byteLength) {
+            // Compatibility with node Buffer (https://github.com/mapbox/pbf/issues/35)
+            pbf = new Uint8Array(pbf);
+        }
+
+        callback(null, {
+            vectorTile: geojsonWrapper,
+            rawData: pbf.buffer
+        });
+    }
+
     /**
      * Fetches (if appropriate), parses, and index geojson data into tiles. This
      * preparatory method must be called before {@link GeoJSONWorkerSource#loadTile}
@@ -264,7 +258,7 @@ export class GeoJSONWorkerSource extends VectorTileWorkerSource {
         clusterId: number;
     }, callback: Callback<number>) {
         try {
-            callback(null, this._geoJSONIndex.getClusterExpansionZoom(params.clusterId));
+            callback(null, (this._geoJSONIndex as Supercluster).getClusterExpansionZoom(params.clusterId));
         } catch (e) {
             callback(e);
         }
@@ -274,7 +268,7 @@ export class GeoJSONWorkerSource extends VectorTileWorkerSource {
         clusterId: number;
     }, callback: Callback<Array<GeoJSON.Feature>>) {
         try {
-            callback(null, this._geoJSONIndex.getChildren(params.clusterId));
+            callback(null, (this._geoJSONIndex as Supercluster).getChildren(params.clusterId));
         } catch (e) {
             callback(e);
         }
@@ -286,7 +280,7 @@ export class GeoJSONWorkerSource extends VectorTileWorkerSource {
         offset: number;
     }, callback: Callback<Array<GeoJSON.Feature>>) {
         try {
-            callback(null, this._geoJSONIndex.getLeaves(params.clusterId, params.limit, params.offset));
+            callback(null, (this._geoJSONIndex as Supercluster).getLeaves(params.clusterId, params.limit, params.offset));
         } catch (e) {
             callback(e);
         }

package/src/source/geojson_wrapper.ts

@@ -4,26 +4,16 @@ import mvt from '@mapbox/vector-tile';
 import type {VectorTileFeature, VectorTileLayer, VectorTile} from '@mapbox/vector-tile';
 const toGeoJSON = mvt.VectorTileFeature.prototype.toGeoJSON;
 import {EXTENT} from '../data/extent';
+import type {TileFeature, AnyProps} from 'supercluster';
+import type {Feature as GeoJSONVTFeature} from 'geojson-vt';
 
-// The feature type used by geojson-vt and supercluster. Should be extracted to
-// global type and used in module definitions for those two modules.
-export type Feature = {
-    type: 1;
-    id: any;
-    tags: {[_: string]: string | number | boolean};
-    geometry: Array<[number, number]>;
-} | {
-    type: 2 | 3;
-    id: any;
-    tags: {[_: string]: string | number | boolean};
-    geometry: Array<Array<[number, number]>>;
-};
+export type Feature = TileFeature<AnyProps, AnyProps> | GeoJSONVTFeature;
 
 class FeatureWrapper implements VectorTileFeature {
     _feature: Feature;
 
     extent: number;
-    type: 1 | 2 | 3;
+    type: Feature['type'];
     id: number;
     properties: {[_: string]: string | number | boolean};
 
@@ -40,7 +30,7 @@ class FeatureWrapper implements VectorTileFeature {
         // vector tile spec only supports integer values for feature ids --
         // allowing non-integer values here results in a non-compliant PBF
         // that causes an exception when it is parsed with vector-tile-js
-        if ('id' in feature && !isNaN(feature.id)) {
+        if ('id' in feature && !isNaN(feature.id as any)) {
             this.id = parseInt(feature.id, 10);
         }
     }

package/src/source/worker.test.ts

@@ -6,10 +6,11 @@ import {WorkerGlobalScopeInterface} from '../util/web_worker';
 import {CanonicalTileID, OverscaledTileID} from './tile_id';
 import {TileParameters, WorkerSource, WorkerTileCallback, WorkerTileParameters} from './worker_source';
 import {plugin as globalRTLTextPlugin} from './rtl_text_plugin';
+import {ActorTarget} from '../util/actor';
 
 const _self = {
     addEventListener() {}
-} as any as WorkerGlobalScopeInterface;
+} as any as WorkerGlobalScopeInterface & ActorTarget;
 
 class WorkerSourceMock implements WorkerSource {
     availableImages: string[];

package/src/source/worker.ts

@@ -1,4 +1,4 @@
-import {Actor} from '../util/actor';
+import {Actor, ActorTarget} from '../util/actor';
 import {StyleLayerIndex} from '../style/style_layer_index';
 import {VectorTileWorkerSource} from './vector_tile_worker_source';
 import {RasterDEMTileWorkerSource} from './raster_dem_tile_worker_source';
@@ -24,7 +24,7 @@ import type {PluginState} from './rtl_text_plugin';
  * The Worker class responsidble for background thread related execution
  */
 export default class Worker {
-    self: WorkerGlobalScopeInterface;
+    self: WorkerGlobalScopeInterface & ActorTarget;
     actor: Actor;
     layerIndexes: {[_: string]: StyleLayerIndex};
     availableImages: {[_: string]: Array<string>};
@@ -47,7 +47,7 @@ export default class Worker {
     };
     referrer: string;
 
-    constructor(self: WorkerGlobalScopeInterface) {
+    constructor(self: WorkerGlobalScopeInterface & ActorTarget) {
         this.self = self;
         this.actor = new Actor(self, this);
 
@@ -222,13 +222,13 @@ export default class Worker {
         return layerIndexes;
     }
 
-    getWorkerSource(mapId: string, type: string, source: string) {
+    getWorkerSource(mapId: string, sourceType: string, sourceName: string): WorkerSource {
         if (!this.workerSources[mapId])
             this.workerSources[mapId] = {};
-        if (!this.workerSources[mapId][type])
-            this.workerSources[mapId][type] = {};
+        if (!this.workerSources[mapId][sourceType])
+            this.workerSources[mapId][sourceType] = {};
 
-        if (!this.workerSources[mapId][type][source]) {
+        if (!this.workerSources[mapId][sourceType][sourceName]) {
             // use a wrapped actor so that we can attach a target mapId param
             // to any messages invoked by the WorkerSource
             const actor = {
@@ -236,10 +236,10 @@ export default class Worker {
                     this.actor.send(type, data, callback, mapId);
                 }
             };
-            this.workerSources[mapId][type][source] = new (this.workerSourceTypes[type] as any)((actor as any), this.getLayerIndex(mapId), this.getAvailableImages(mapId));
+            this.workerSources[mapId][sourceType][sourceName] = new (this.workerSourceTypes[sourceType] as any)((actor as any), this.getLayerIndex(mapId), this.getAvailableImages(mapId));
         }
 
-        return this.workerSources[mapId][type][source];
+        return this.workerSources[mapId][sourceType][sourceName];
     }
 
     getDEMWorkerSource(mapId: string, source: string) {

package/src/style/style.test.ts

@@ -68,6 +68,7 @@ class StubMap extends Evented {
     }
 
     setTerrain() { }
+    getTerrain() { }
 }
 
 const getStubMap = () => new StubMap() as any;
@@ -2564,3 +2565,29 @@ describe('Style#hasTransitions', () => {
         });
     });
 });
+
+describe('Style#serialize', () => {
+    test('include terrain property when map has 3D terrain', done => {
+        const styleJson = createStyleJSON({terrain: {
+            source: 'terrainSource',
+            exaggeration: 1
+        }});
+        const style = new Style(getStubMap());
+        style.loadJSON(styleJson);
+
+        style.on('style.load', () => {
+            expect(style.serialize().terrain).toBe(styleJson.terrian);
+            done();
+        });
+    });
+
+    test('do not include terrain property when map does not have 3D terrain', done => {
+        const style = new Style(getStubMap());
+        style.loadJSON(createStyleJSON());
+
+        style.on('style.load', () => {
+            expect(style.serialize().terrain).toBeUndefined();
+            done();
+        });
+    });
+});

package/src/style/style.ts

@@ -1215,6 +1215,7 @@ export class Style extends Evented {
 
         const sources = mapObject(this.sourceCaches, (source) => source.serialize());
         const layers = this._serializeByIds(this._order);
+        const terrain = this.map.getTerrain() || undefined;
         const myStyleSheet = this.stylesheet;
 
         return filterObject({
@@ -1230,7 +1231,8 @@ export class Style extends Evented {
             glyphs: myStyleSheet.glyphs,
             transition: myStyleSheet.transition,
             sources,
-            layers
+            layers,
+            terrain
         },
         (value) => { return value !== undefined; });
     }

package/src/util/actor.test.ts

@@ -1,4 +1,4 @@
-import {Actor} from './actor';
+import {Actor, ActorTarget} from './actor';
 import {workerFactory} from './web_worker';
 import {MessageBus} from '../../test/unit/lib/web_worker_mock';
 
@@ -33,18 +33,19 @@ describe('Actor', () => {
                 this.self = self;
                 this.actor = new Actor(self, this);
             }
-            test(mapId, params, callback) {
+            getTile(mapId, params, callback) {
                 setTimeout(callback, 0, null, params);
             }
+            getWorkerSource() { return null; }
         });
 
         const worker = workerFactory();
 
-        const m1 = new Actor(worker, {}, '1');
-        const m2 = new Actor(worker, {}, '2');
+        const m1 = new Actor(worker, {} as any, '1');
+        const m2 = new Actor(worker, {} as any, '2');
 
         let callbackCount = 0;
-        m1.send('test', {value: 1729}, (err, response) => {
+        m1.send('getTile', {value: 1729}, (err, response) => {
             expect(err).toBeFalsy();
             expect(response).toEqual({value: 1729});
             callbackCount++;
@@ -52,7 +53,7 @@ describe('Actor', () => {
                 done();
             }
         });
-        m2.send('test', {value: 4104}, (err, response) => {
+        m2.send('getTile', {value: 4104}, (err, response) => {
             expect(err).toBeFalsy();
             expect(response).toEqual({value: 4104});
             callbackCount++;
@@ -72,18 +73,19 @@ describe('Actor', () => {
                 this.self = self;
                 this.actor = workerActor = new Actor(self, this);
             }
+            getWorkerSource() { return null; }
         });
 
         const worker = workerFactory();
 
         new Actor(worker, {
             test () { done(); }
-        }, '1');
+        } as any, '1');
         new Actor(worker, {
             test () {
                 done('test failed');
             }
-        }, '2');
+        } as any, '2');
 
         workerActor.send('test', {}, () => {}, '1');
     });
@@ -97,7 +99,7 @@ describe('Actor', () => {
                 expect([type, callback, useCapture]).toEqual(this._addEventListenerArgs);
                 done();
             }
-        }, {}, null);
+        } as ActorTarget, {} as any, null);
         actor.remove();
     });