maplibre-gl 2.0.0 → 2.0.4

package/build/generate-struct-arrays.ts

@@ -87,7 +87,7 @@ function createStructArrayType(name: string, layout: StructArrayLayout, includeS
             includeStructAccessors
         });
     } else {
-        arrayTypeEntries.add(`${layoutClass} as ${arrayClass}`);
+        arrayTypeEntries.add(`export class ${arrayClass} extends ${layoutClass} {}`);
     }
 }
 
@@ -428,12 +428,12 @@ fs.writeFileSync('src/data/array_types.ts',
 import assert from 'assert';
 import {Struct, StructArray} from '../util/struct_array';
 import {register} from '../util/web_worker_transfer';
-import Point from '../util/point';
+import Point from '@mapbox/point-geometry';
 
 ${layouts.map(emitStructArrayLayout).join('\n')}
 ${arraysWithStructAccessors.map(emitStructArray).join('\n')}
+${[...arrayTypeEntries].join('\n')}
 export {
-    ${layouts.map(layout => layout.className).join(',\n    ')},
-    ${[...arrayTypeEntries].join(',\n    ')}
+    ${layouts.map(layout => layout.className).join(',\n    ')}
 };
 `);

package/build/post-ts-build.js

@@ -35,6 +35,7 @@ console.log(`Starting bundling types`);
 const outputFile = "./dist/maplibre-gl.d.ts";
 child_process.execSync(`dts-bundle-generator --no-check --umd-module-name=maplibregl -o ${outputFile} ./src/index.ts`);
 let types = fs.readFileSync(outputFile, 'utf8');
+// Classes are not exported but should be since this is exported as UMD - fixing...
 types = types.replace(/declare class/g, "export declare class");
 fs.writeFileSync(outputFile, types);
 console.log(`Finished bundling types`);

package/build/release-notes.js

@@ -1,28 +1,12 @@
 #!/usr/bin/env node
 
 import * as fs from 'fs';
-import {execSync} from 'child_process';
 import * as ejs from 'ejs';
-import _ from 'lodash';
 import semver from 'semver';
 
 const changelogPath = 'CHANGELOG.md';
 const changelog = fs.readFileSync(changelogPath, 'utf8');
 
-let currentVersion = execSync('git describe --tags --match=v*.*.* --abbrev=0')
-    .toString()
-    .trim()
-    .replace('v', '');
-
-let gitTags = execSync('git tag --list v*.*.*')
-    .toString()
-    .split('\n')
-    .map(function(tag) {
-        tag = tag.replace('v', '').trim();
-        return semver.clean(tag);
-    });
-let previousVersion = semver.maxSatisfying(gitTags, "<" + currentVersion, { includePrerelease: false });
-
 /*
   Parse the raw changelog text and split it into individual releases.
 
@@ -33,7 +17,7 @@ let previousVersion = semver.maxSatisfying(gitTags, "<" + currentVersion, { incl
     - Groups the changelog content.
     - Ends when another "## x.x.x" is found.
 */
-const regex = /^## (\d+\.\d+\.\d+).*?\n(.+?)(?=\n^## \d+\.\d+\.\d+.*?\n)/gms;
+const regex = /^## (\d+\.\d+\.\d+.*?)\n(.+?)(?=\n^## \d+\.\d+\.\d+.*?\n)/gms;
 
 let releaseNotes = [];
 let match;
@@ -45,17 +29,8 @@ while (match = regex.exec(changelog)) {
     });
 }
 
-/*
-  Match the current tag with the most appropriate release notes.
-*/
-const versionsInReleaseNotes = _.map(releaseNotes, 'version');
-const bestReleaseNotesForCurrentVersion = semver.minSatisfying(versionsInReleaseNotes, ">=" + currentVersion);
-const currentReleaseNotes = _.find(releaseNotes, { version: bestReleaseNotesForCurrentVersion });
-
-if (!currentReleaseNotes) {
-    console.error('Could not find a release section satisfying %s in %s — did you forget to rename the "main" section to %s?', currentVersion, changelogPath, currentVersion.split("-")[0]);
-    process.exit(1); // eslint-disable-line no-process-exit
-}
+const latest = releaseNotes[0];
+const previous = releaseNotes[1];
 
 /*
   Fill and print the release notes template.
@@ -63,10 +38,10 @@ if (!currentReleaseNotes) {
 let templatedReleaseNotes;
 
 templatedReleaseNotes = ejs.render(fs.readFileSync('build/release-notes.md.ejs', 'utf8'), {
-    'CURRENTVERSION': currentVersion,
-    'PREVIOUSVERSION': previousVersion,
-    'CHANGELOG': currentReleaseNotes.changelog,
-    'isPrerelease': semver.prerelease(currentVersion)
+    'CURRENTVERSION': latest.version,
+    'PREVIOUSVERSION': previous.version,
+    'CHANGELOG': latest.changelog,
+    'isPrerelease': semver.prerelease(latest.version)
 });
 templatedReleaseNotes = templatedReleaseNotes.trimEnd();
 

package/dist/maplibre-gl.d.ts

@@ -1,190 +1,11 @@
 // Generated by dts-bundle-generator v6.1.0
 
+import Point from '@mapbox/point-geometry';
 import TinySDF from '@mapbox/tiny-sdf';
+import { VectorTileFeature, VectorTileLayer } from '@mapbox/vector-tile';
 import { mat2, mat4 } from 'gl-matrix';
 import { PotpackBox } from 'potpack';
 
-/**
- * A {@link Point} or an array of two numbers representing `x` and `y` screen coordinates in pixels.
- *
- * @typedef {(Point | [number, number])} PointLike
- * @example
- * var p1 = new maplibregl.Point(-77, 38); // a PointLike which is a Point
- * var p2 = [-77, 38]; // a PointLike which is an array of two numbers
- */
-export declare type PointLike = Point | [
-	number,
-	number
-];
-export declare class Point {
-	x: number;
-	y: number;
-	constructor(x: number, y: number);
-	/**
-	 * Clone this point, returning a new point that can be modified
-	 * without affecting the old one.
-	 * @returns {Point} the clone
-	 */
-	clone(): Point;
-	/**
-	 * Add this point's x & y coordinates to another point,
-	 * yielding a new point.
-	 * @param {Point} p the other point
-	 * @returns {Point} output point
-	 */
-	add(p: any): Point;
-	/**
-	 * Subtract this point's x & y coordinates to from point,
-	 * yielding a new point.
-	 * @param {Point} p the other point
-	 * @returns {Point} output point
-	 */
-	sub(p: any): Point;
-	/**
-	 * Multiply this point's x & y coordinates by point,
-	 * yielding a new point.
-	 * @param {Point} p the other point
-	 * @returns {Point} output point
-	 */
-	multByPoint(p: any): Point;
-	/**
-	 * Divide this point's x & y coordinates by point,
-	 * yielding a new point.
-	 * @param {Point} p the other point
-	 * @returns {Point} output point
-	 */
-	divByPoint(p: any): Point;
-	/**
-	 * Multiply this point's x & y coordinates by a factor,
-	 * yielding a new point.
-	 * @param {Point} k factor
-	 * @returns {Point} output point
-	 */
-	mult(k: any): Point;
-	/**
-	 * Divide this point's x & y coordinates by a factor,
-	 * yielding a new point.
-	 * @param {Point} k factor
-	 * @returns {Point} output point
-	 */
-	div(k: any): Point;
-	/**
-	 * Rotate this point around the 0, 0 origin by an angle a,
-	 * given in radians
-	 * @param {Number} a angle to rotate around, in radians
-	 * @returns {Point} output point
-	 */
-	rotate(a: any): Point;
-	/**
-	 * Rotate this point around p point by an angle a,
-	 * given in radians
-	 * @param {Number} a angle to rotate around, in radians
-	 * @param {Point} p Point to rotate around
-	 * @returns {Point} output point
-	 */
-	rotateAround(a: any, p: any): Point;
-	/**
-	 * Multiply this point by a 4x1 transformation matrix
-	 * @param {Array<Number>} m transformation matrix
-	 * @returns {Point} output point
-	 */
-	matMult(m: any): Point;
-	/**
-	 * Calculate this point but as a unit vector from 0, 0, meaning
-	 * that the distance from the resulting point to the 0, 0
-	 * coordinate will be equal to 1 and the angle from the resulting
-	 * point to the 0, 0 coordinate will be the same as before.
-	 * @returns {Point} unit vector point
-	 */
-	unit(): Point;
-	/**
-	 * Compute a perpendicular point, where the new y coordinate
-	 * is the old x coordinate and the new x coordinate is the old y
-	 * coordinate multiplied by -1
-	 * @returns {Point} perpendicular point
-	 */
-	perp(): Point;
-	/**
-	 * Return a version of this point with the x & y coordinates
-	 * rounded to integers.
-	 * @returns {Point} rounded point
-	 */
-	round(): Point;
-	/**
-	 * Return the magitude of this point: this is the Euclidean
-	 * distance from the 0, 0 coordinate to this point's x and y
-	 * coordinates.
-	 * @returns {Number} magnitude
-	 */
-	mag(): number;
-	/**
-	 * Judge whether this point is equal to another point, returning
-	 * true or false.
-	 * @param {Point} other the other point
-	 * @returns {boolean} whether the points are equal
-	 */
-	equals(other: any): boolean;
-	/**
-	 * Calculate the distance from this point to another point
-	 * @param {Point} p the other point
-	 * @returns {Number} distance
-	 */
-	dist(p: any): number;
-	/**
-	 * Calculate the distance from this point to another point,
-	 * without the square root step. Useful if you're comparing
-	 * relative distances.
-	 * @param {Point} p the other point
-	 * @returns {Number} distance
-	 */
-	distSqr(p: any): number;
-	/**
-	 * Get the angle from the 0, 0 coordinate to this point, in radians
-	 * coordinates.
-	 * @returns {Number} angle
-	 */
-	angle(): number;
-	/**
-	 * Get the angle from this point to another point, in radians
-	 * @param {Point} b the other point
-	 * @returns {Number} angle
-	 */
-	angleTo(b: any): number;
-	/**
-	 * Get the angle between this point and another point, in radians
-	 * @param {Point} b the other point
-	 * @returns {Number} angle
-	 */
-	angleWith(b: any): number;
-	angleWithSep(x: any, y: any): number;
-	_matMult(m: any): this;
-	_add(p: any): this;
-	_sub(p: any): this;
-	_mult(k: any): this;
-	_div(k: any): this;
-	_multByPoint(p: any): this;
-	_divByPoint(p: any): this;
-	_unit(): this;
-	_perp(): this;
-	_rotate(angle: any): this;
-	_rotateAround(angle: any, p: any): this;
-	_round(): this;
-	/**
-	 * Construct a point from an array if necessary, otherwise if the input
-	 * is already a Point, or an unknown type, return it unchanged
-	 * @param {Array<Number>|Point|*} a any kind of input value
-	 * @returns {Point} constructed point, or passed-through value.
-	 * @example
-	 * // this
-	 * var point = Point.convert([0, 1]);
-	 * // is equivalent to
-	 * var point = new Point(0, 1);
-	 */
-	static convert(a: PointLike | {
-		x: number;
-		y: number;
-	}): Point;
-}
 export declare type Callback<T> = (error?: Error | null, result?: T | null) => void;
 export declare type Cancelable = {
 	cancel: () => void;
@@ -1995,6 +1816,30 @@ export declare class FeatureIndexArray extends StructArrayLayout1ul2ui8 {
 	 */
 	get(index: number): FeatureIndexStruct;
 }
+export declare class CircleLayoutArray extends StructArrayLayout2i4 {
+}
+export declare class FillLayoutArray extends StructArrayLayout2i4 {
+}
+export declare class FillExtrusionLayoutArray extends StructArrayLayout2i4i12 {
+}
+export declare class LineLayoutArray extends StructArrayLayout2i4ub8 {
+}
+export declare class LineExtLayoutArray extends StructArrayLayout2f8 {
+}
+export declare class SymbolLayoutArray extends StructArrayLayout4i4ui4i24 {
+}
+export declare class SymbolDynamicLayoutArray extends StructArrayLayout3f12 {
+}
+export declare class SymbolOpacityArray extends StructArrayLayout1ul4 {
+}
+export declare class CollisionVertexArray extends StructArrayLayout2ub2f12 {
+}
+export declare class TriangleIndexArray extends StructArrayLayout3ui6 {
+}
+export declare class LineIndexArray extends StructArrayLayout2ui4 {
+}
+export declare class LineStripIndexArray extends StructArrayLayout1ui2 {
+}
 export declare type SerializedFeaturePositionMap = {
 	ids: Float64Array;
 	positions: Uint32Array;
@@ -2732,6 +2577,35 @@ export declare class ImageAtlas {
 	patchUpdatedImages(imageManager: ImageManager, texture: Texture): void;
 	patchUpdatedImage(position: ImagePosition, image: StyleImage, texture: Texture): void;
 }
+export declare type SerializedGrid = {
+	buffer: ArrayBuffer;
+};
+export declare class TransferableGridIndex {
+	cells: number[][];
+	arrayBuffer: ArrayBuffer;
+	d: number;
+	keys: number[];
+	bboxes: number[];
+	n: number;
+	extent: number;
+	padding: number;
+	scale: any;
+	uid: number;
+	min: number;
+	max: number;
+	constructor(extent: number | ArrayBuffer, n?: number, padding?: number);
+	insert(key: number, x1: number, y1: number, x2: number, y2: number): void;
+	_insertReadonly(): void;
+	_insertCell(x1: number, y1: number, x2: number, y2: number, cellIndex: number, uid: number): void;
+	query(x1: number, y1: number, x2: number, y2: number, intersectionTest?: Function): number[];
+	_queryCell(x1: number, y1: number, x2: number, y2: number, cellIndex: number, result: any, seenUids: any, intersectionTest: Function): void;
+	_forEachCell(x1: number, y1: number, x2: number, y2: number, fn: Function, arg1: any, arg2: any, intersectionTest: any): void;
+	_convertFromCellCoord(x: any): number;
+	_convertToCellCoord(x: any): number;
+	toArrayBuffer(): ArrayBuffer;
+	static serialize(grid: TransferableGridIndex, transferables?: Array<Transferable>): SerializedGrid;
+	static deserialize(serialized: SerializedGrid): TransferableGridIndex;
+}
 export declare class DictionaryCoder {
 	_stringToNumber: {
 		[_: string]: number;
@@ -4489,10 +4363,6 @@ export interface CustomLayerInterface {
 	*/
 	onRemove(map: Map, gl: WebGLRenderingContext): void;
 }
-export interface StyleLayer {
-	queryRadius?(bucket: Bucket): number;
-	queryIntersectsFeature?(queryGeometry: Array<Point>, feature: VectorTileFeature, featureState: FeatureState, geometry: Array<Array<Point>>, zoom: number, transform: Transform, pixelsToTileUnits: number, pixelPosMatrix: mat4): boolean | number;
-}
 declare abstract class StyleLayer extends Evented {
 	id: string;
 	metadata: unknown;
@@ -4512,6 +4382,8 @@ declare abstract class StyleLayer extends Evented {
 	_featureFilter: FeatureFilter;
 	readonly onAdd: ((map: Map) => void);
 	readonly onRemove: ((map: Map) => void);
+	queryRadius?(bucket: Bucket): number;
+	queryIntersectsFeature?(queryGeometry: Array<Point>, feature: VectorTileFeature, featureState: FeatureState, geometry: Array<Array<Point>>, zoom: number, transform: Transform, pixelsToTileUnits: number, pixelPosMatrix: mat4): boolean | number;
 	constructor(layer: LayerSpecification | CustomLayerInterface, properties: Readonly<{
 		layout?: Properties<any>;
 		paint?: Properties<any>;
@@ -5953,8 +5825,8 @@ export declare type SourceStatics = {
 export declare type SourceClass = {
 	new (...args: any): Source;
 } & SourceStatics;
-declare const getType: (name: string) => any;
-declare const setType: (name: string, type: new (...args: any) => Source) => void;
+declare const getSourceType: (name: string) => any;
+declare const setSourceType: (name: string, type: new (...args: any) => Source) => void;
 export declare class TileCache {
 	max: number;
 	data: {
@@ -7121,6 +6993,10 @@ export declare class TaskQueue {
 	run(timeStamp?: number): void;
 	clear(): void;
 }
+export declare type PointLike = Point | [
+	number,
+	number
+];
 export declare type RequireAtLeastOne<T> = {
 	[K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
 }[keyof T];
@@ -7542,7 +7418,7 @@ declare abstract class Camera extends Evented {
 	 * @memberof Map#
 	 * @param bounds Center these bounds in the viewport and use the highest
 	 *      zoom level up to and including `Map#getMaxZoom()` that fits them in the viewport.
-	 * @param {Object} [options] Options supports all properties from {@link AnimationOptions} and {@link CameraOptions} in addition to the fields below.
+	 * @param {FitBoundsOptions} [options] Options supports all properties from {@link AnimationOptions} and {@link CameraOptions} in addition to the fields below.
 	 * @param {number | PaddingOptions} [options.padding] The amount of padding in pixels to add to the given bounds.
 	 * @param {boolean} [options.linear=false] If `true`, the map transitions using
 	 *     {@link Map#easeTo}. If `false`, the map transitions using {@link Map#flyTo}. See
@@ -7669,7 +7545,7 @@ declare abstract class Camera extends Evented {
 	 * unless 'options' includes `essential: true`.
 	 *
 	 * @memberof Map#
-	 * @param {Object} options Options describing the destination and animation of the transition.
+	 * @param {FlyToOptions} options Options describing the destination and animation of the transition.
 	 *     Accepts {@link CameraOptions}, {@link AnimationOptions},
 	 *     and the following additional options.
 	 * @param {number} [options.curve=1.42] The zooming "curve" that will occur along the
@@ -10540,6 +10416,8 @@ declare const exported: {
 	 * The example below will be triggered for custom:// urls defined in the sources list in the style definitions.
 	 * The function passed will receive the request parameters and should call the callback with the resulting request,
 	 * for example a pbf vector tile, non-compressed, represented as ArrayBuffer.
+	 *
+	 * @function addProtocol
 	 * @param {string} customProtocol - the protocol to hook, for example 'custom'
 	 * @param {Function} loadFn - the function to use when trying to fetch a tile specified by the customProtocol
 	 * @example
@@ -10569,18 +10447,14 @@ declare const exported: {
 	addProtocol(customProtocol: string, loadFn: (requestParameters: RequestParameters, callback: ResponseCallback<any>) => Cancelable): void;
 	/**
 	 * Removes a previusly added protocol
+	 *
+	 * @function removeProtocol
 	 * @param {string} customProtocol - the custom protocol to remove registration for
 	 * @example
 	 * maplibregl.removeProtocol('custom');
 	 */
 	removeProtocol(customProtocol: string): void;
 };
-/**
- * The version of MapLibre GL JS in use as specified in `package.json`,
- * `CHANGELOG.md`, and the GitHub release.
- *
- * @var {string} version
- */
 /**
  * Test whether the browser supports MapLibre GL JS.
  *