maplibre-gl 3.0.0 → 3.1.0

package/dist/maplibre-gl.d.ts

@@ -82,7 +82,7 @@ export declare const enum ResourceType {
 	Tile = "Tile",
 	Unknown = "Unknown"
 }
-export type RequestTransformFunction = (url: string, resourceType?: ResourceType) => RequestParameters;
+export type RequestTransformFunction = (url: string, resourceType?: ResourceType) => RequestParameters | undefined;
 export declare class RequestManager {
 	_transformRequestFn: RequestTransformFunction;
 	constructor(transformRequestFn?: RequestTransformFunction);
@@ -937,32 +937,32 @@ export declare class VertexBuffer {
 	constructor(context: Context, array: StructArray, attributes: ReadonlyArray<StructArrayMember>, dynamicDraw?: boolean);
 	bind(): void;
 	updateData(array: StructArray): void;
-	enableAttributes(gl: WebGL2RenderingContext, program: Program<any>): void;
+	enableAttributes(gl: WebGLRenderingContext | WebGL2RenderingContext, program: Program<any>): void;
 	/**
 	 * Set the attribute pointers in a WebGL context
 	 * @param gl The WebGL context
 	 * @param program The active WebGL program
 	 * @param vertexOffset Index of the starting vertex of the segment
 	 */
-	setVertexAttribPointers(gl: WebGL2RenderingContext, program: Program<any>, vertexOffset?: number | null): void;
+	setVertexAttribPointers(gl: WebGLRenderingContext | WebGL2RenderingContext, program: Program<any>, vertexOffset?: number | null): void;
 	/**
 	 * Destroy the GL buffer bound to the given WebGL context
 	 */
 	destroy(): void;
 }
-export type BlendFuncConstant = typeof WebGL2RenderingContext.ZERO | typeof WebGL2RenderingContext.ONE | typeof WebGL2RenderingContext.SRC_COLOR | typeof WebGL2RenderingContext.ONE_MINUS_SRC_COLOR | typeof WebGL2RenderingContext.DST_COLOR | typeof WebGL2RenderingContext.ONE_MINUS_DST_COLOR | typeof WebGL2RenderingContext.SRC_ALPHA | typeof WebGL2RenderingContext.ONE_MINUS_SRC_ALPHA | typeof WebGL2RenderingContext.DST_ALPHA | typeof WebGL2RenderingContext.ONE_MINUS_DST_ALPHA | typeof WebGL2RenderingContext.CONSTANT_COLOR | typeof WebGL2RenderingContext.ONE_MINUS_CONSTANT_COLOR | typeof WebGL2RenderingContext.CONSTANT_ALPHA | typeof WebGL2RenderingContext.ONE_MINUS_CONSTANT_ALPHA | typeof WebGL2RenderingContext.BLEND_COLOR;
+export type BlendFuncConstant = WebGLRenderingContextBase["ZERO"] | WebGLRenderingContextBase["ONE"] | WebGLRenderingContextBase["SRC_COLOR"] | WebGLRenderingContextBase["ONE_MINUS_SRC_COLOR"] | WebGLRenderingContextBase["DST_COLOR"] | WebGLRenderingContextBase["ONE_MINUS_DST_COLOR"] | WebGLRenderingContextBase["SRC_ALPHA"] | WebGLRenderingContextBase["ONE_MINUS_SRC_ALPHA"] | WebGLRenderingContextBase["DST_ALPHA"] | WebGLRenderingContextBase["ONE_MINUS_DST_ALPHA"] | WebGLRenderingContextBase["CONSTANT_COLOR"] | WebGLRenderingContextBase["ONE_MINUS_CONSTANT_COLOR"] | WebGLRenderingContextBase["CONSTANT_ALPHA"] | WebGLRenderingContextBase["ONE_MINUS_CONSTANT_ALPHA"] | WebGLRenderingContextBase["BLEND_COLOR"];
 export type BlendFuncType = [
 	BlendFuncConstant,
 	BlendFuncConstant
 ];
-export type BlendEquationType = typeof WebGL2RenderingContext.FUNC_ADD | typeof WebGL2RenderingContext.FUNC_SUBTRACT | typeof WebGL2RenderingContext.FUNC_REVERSE_SUBTRACT;
+export type BlendEquationType = WebGLRenderingContextBase["FUNC_ADD"] | WebGLRenderingContextBase["FUNC_SUBTRACT"] | WebGLRenderingContextBase["FUNC_REVERSE_SUBTRACT"];
 export type ColorMaskType = [
 	boolean,
 	boolean,
 	boolean,
 	boolean
 ];
-export type CompareFuncType = typeof WebGL2RenderingContext.NEVER | typeof WebGL2RenderingContext.LESS | typeof WebGL2RenderingContext.EQUAL | typeof WebGL2RenderingContext.LEQUAL | typeof WebGL2RenderingContext.GREATER | typeof WebGL2RenderingContext.NOTEQUAL | typeof WebGL2RenderingContext.GEQUAL | typeof WebGL2RenderingContext.ALWAYS;
+export type CompareFuncType = WebGLRenderingContextBase["NEVER"] | WebGLRenderingContextBase["LESS"] | WebGLRenderingContextBase["EQUAL"] | WebGLRenderingContextBase["LEQUAL"] | WebGLRenderingContextBase["GREATER"] | WebGLRenderingContextBase["NOTEQUAL"] | WebGLRenderingContextBase["GEQUAL"] | WebGLRenderingContextBase["ALWAYS"];
 export type DepthMaskType = boolean;
 export type DepthRangeType = [
 	number,
@@ -974,7 +974,7 @@ export type StencilFuncType = {
 	ref: number;
 	mask: number;
 };
-export type StencilOpConstant = typeof WebGL2RenderingContext.KEEP | typeof WebGL2RenderingContext.ZERO | typeof WebGL2RenderingContext.REPLACE | typeof WebGL2RenderingContext.INCR | typeof WebGL2RenderingContext.INCR_WRAP | typeof WebGL2RenderingContext.DECR | typeof WebGL2RenderingContext.DECR_WRAP | typeof WebGL2RenderingContext.INVERT;
+export type StencilOpConstant = WebGLRenderingContextBase["KEEP"] | WebGLRenderingContextBase["ZERO"] | WebGLRenderingContextBase["REPLACE"] | WebGLRenderingContextBase["INCR"] | WebGLRenderingContextBase["INCR_WRAP"] | WebGLRenderingContextBase["DECR"] | WebGLRenderingContextBase["DECR_WRAP"] | WebGLRenderingContextBase["INVERT"];
 export type StencilOpType = [
 	StencilOpConstant,
 	StencilOpConstant,
@@ -988,32 +988,32 @@ export type ViewportType = [
 	number
 ];
 export type StencilTestGL = {
-	func: typeof WebGL2RenderingContext.NEVER;
+	func: WebGLRenderingContextBase["NEVER"];
 	mask: 0;
 } | {
-	func: typeof WebGL2RenderingContext.LESS;
+	func: WebGLRenderingContextBase["LESS"];
 	mask: number;
 } | {
-	func: typeof WebGL2RenderingContext.EQUAL;
+	func: WebGLRenderingContextBase["EQUAL"];
 	mask: number;
 } | {
-	func: typeof WebGL2RenderingContext.LEQUAL;
+	func: WebGLRenderingContextBase["LEQUAL"];
 	mask: number;
 } | {
-	func: typeof WebGL2RenderingContext.GREATER;
+	func: WebGLRenderingContextBase["GREATER"];
 	mask: number;
 } | {
-	func: typeof WebGL2RenderingContext.NOTEQUAL;
+	func: WebGLRenderingContextBase["NOTEQUAL"];
 	mask: number;
 } | {
-	func: typeof WebGL2RenderingContext.GEQUAL;
+	func: WebGLRenderingContextBase["GEQUAL"];
 	mask: number;
 } | {
-	func: typeof WebGL2RenderingContext.ALWAYS;
+	func: WebGLRenderingContextBase["ALWAYS"];
 	mask: 0;
 };
-export type CullFaceModeType = typeof WebGL2RenderingContext.FRONT | typeof WebGL2RenderingContext.BACK | typeof WebGL2RenderingContext.FRONT_AND_BACK;
-export type FrontFaceType = typeof WebGL2RenderingContext.CW | typeof WebGL2RenderingContext.CCW;
+export type CullFaceModeType = WebGLRenderingContextBase["FRONT"] | WebGLRenderingContextBase["BACK"] | WebGLRenderingContextBase["FRONT_AND_BACK"];
+export type FrontFaceType = WebGLRenderingContextBase["CW"] | WebGLRenderingContextBase["CCW"];
 export interface IValue<T> {
 	current: T;
 	default: T;
@@ -1023,7 +1023,7 @@ export interface IValue<T> {
 	set(value: T): void;
 }
 export declare class BaseValue<T> implements IValue<T> {
-	gl: WebGL2RenderingContext;
+	gl: WebGLRenderingContext | WebGL2RenderingContext;
 	current: T;
 	default: T;
 	dirty: boolean;
@@ -1141,7 +1141,7 @@ export declare class BindElementBuffer extends BaseValue<WebGLBuffer> {
 	getDefault(): WebGLBuffer;
 	set(v?: WebGLBuffer | null): void;
 }
-export declare class BindVertexArray extends BaseValue<WebGLVertexArrayObject> {
+export declare class BindVertexArray extends BaseValue<WebGLVertexArrayObject | null> {
 	getDefault(): WebGLVertexArrayObject | null;
 	set(v: WebGLVertexArrayObject | null): void;
 }
@@ -1223,7 +1223,7 @@ export type ClearArgs = {
 	stencil?: number;
 };
 export declare class Context {
-	gl: WebGL2RenderingContext;
+	gl: WebGLRenderingContext | WebGL2RenderingContext;
 	currentNumAttributes: number;
 	maxTextureSize: number;
 	clearColor: ClearColor;
@@ -1262,7 +1262,7 @@ export declare class Context {
 	HALF_FLOAT?: GLenum;
 	RGBA16F?: GLenum;
 	RGB16F?: GLenum;
-	constructor(gl: WebGL2RenderingContext);
+	constructor(gl: WebGLRenderingContext | WebGL2RenderingContext);
 	setDefault(): void;
 	setDirty(): void;
 	createIndexBuffer(array: TriangleIndexArray | LineIndexArray | LineStripIndexArray, dynamicDraw?: boolean): IndexBuffer;
@@ -1286,7 +1286,7 @@ export type UniformLocations = {
 	[_: string]: WebGLUniformLocation;
 };
 declare abstract class Uniform<T> {
-	gl: WebGL2RenderingContext;
+	gl: WebGLRenderingContext | WebGL2RenderingContext;
 	location: WebGLUniformLocation;
 	current: T;
 	constructor(context: Context, location: WebGLUniformLocation);
@@ -1474,9 +1474,9 @@ export interface StyleImageInterface {
 	 */
 	onRemove?: () => void;
 }
-export type TextureFormat = typeof WebGL2RenderingContext.RGBA | typeof WebGL2RenderingContext.ALPHA;
-export type TextureFilter = typeof WebGL2RenderingContext.LINEAR | typeof WebGL2RenderingContext.LINEAR_MIPMAP_NEAREST | typeof WebGL2RenderingContext.NEAREST;
-export type TextureWrap = typeof WebGL2RenderingContext.REPEAT | typeof WebGL2RenderingContext.CLAMP_TO_EDGE | typeof WebGL2RenderingContext.MIRRORED_REPEAT;
+export type TextureFormat = WebGLRenderingContextBase["RGBA"] | WebGLRenderingContextBase["ALPHA"];
+export type TextureFilter = WebGLRenderingContextBase["LINEAR"] | WebGLRenderingContextBase["LINEAR_MIPMAP_NEAREST"] | WebGLRenderingContextBase["NEAREST"];
+export type TextureWrap = WebGLRenderingContextBase["REPEAT"] | WebGLRenderingContextBase["CLAMP_TO_EDGE"] | WebGLRenderingContextBase["MIRRORED_REPEAT"];
 export type EmptyImage = {
 	width: number;
 	height: number;
@@ -2692,6 +2692,7 @@ export declare class SourceCache extends Evented {
 		[_ in any]: ReturnType<typeof setTimeout>;
 	};
 	_maxTileCacheSize: number;
+	_maxTileCacheZoomLevels: number;
 	_paused: boolean;
 	_shouldReloadOnResume: boolean;
 	_coveredTiles: {
@@ -3496,7 +3497,7 @@ export declare class Painter {
 		matrix: mat4;
 		renderTime: number;
 	};
-	constructor(gl: WebGL2RenderingContext, transform: Transform);
+	constructor(gl: WebGLRenderingContext | WebGL2RenderingContext, transform: Transform);
 	resize(width: number, height: number, pixelRatio: number): void;
 	setup(): void;
 	clearStencil(): void;
@@ -4276,7 +4277,7 @@ export type TerrainPreludeUniformsType = {
 	"u_terrain_unpack": Uniform4f;
 	"u_terrain_exaggeration": Uniform1f;
 };
-export type DrawMode = typeof WebGL2RenderingContext.LINES | typeof WebGL2RenderingContext.TRIANGLES | typeof WebGL2RenderingContext.LINE_STRIP;
+export type DrawMode = WebGLRenderingContextBase["LINES"] | WebGLRenderingContextBase["TRIANGLES"] | WebGL2RenderingContext["LINE_STRIP"];
 export declare class Program<Us extends UniformBindings> {
 	program: WebGLProgram;
 	attributes: {
@@ -4832,7 +4833,7 @@ export interface Bucket {
 	 */
 	destroy(): void;
 }
-export type CustomRenderMethod = (gl: WebGL2RenderingContext, matrix: mat4) => void;
+export type CustomRenderMethod = (gl: WebGLRenderingContext | WebGL2RenderingContext, matrix: mat4) => void;
 /**
  * Interface for custom style layers. This is a specification for
  * implementers to model: it is not an exported method or class.
@@ -4871,7 +4872,7 @@ export type CustomRenderMethod = (gl: WebGL2RenderingContext, matrix: mat4) => v
  *
  *         const fragmentSource = `
  *         void main() {
- *             gl_FragColor = vec4(1.0, 0.0, 0.0, 1.0);
+ *             fragColor = vec4(1.0, 0.0, 0.0, 1.0);
  *         }`;
  *
  *         const vertexShader = gl.createShader(gl.VERTEX_SHADER);
@@ -4931,7 +4932,7 @@ export interface CustomLayerInterface {
 	 * @memberof CustomLayerInterface
 	 * @instance
 	 * @name render
-	 * @param {WebGL2RenderingContext} gl The map's gl context.
+	 * @param {WebGLRenderingContext | WebGL2RenderingContext} gl The map's gl context.
 	 * @param {Array<number>} matrix The map's camera matrix. It projects spherical mercator
 	 * coordinates to gl coordinates. The spherical mercator coordinate `[0, 0]` represents the
 	 * top left corner of the mercator world and `[1, 1]` represents the bottom right corner. When
@@ -4967,9 +4968,9 @@ export interface CustomLayerInterface {
 	 * @instance
 	 * @name onAdd
 	 * @param {Map} map The Map this custom layer was just added to.
-	 * @param {WebGL2RenderingContext} gl The gl context for the map.
+	 * @param {WebGLRenderingContext | WebGL2RenderingContext} gl The gl context for the map.
 	 */
-	onAdd?(map: Map, gl: WebGL2RenderingContext): void;
+	onAdd?(map: Map, gl: WebGLRenderingContext | WebGL2RenderingContext): void;
 	/**
 	 * Optional method called when the layer has been removed from the Map with {@link Map#removeLayer}. This
 	 * gives the layer a chance to clean up gl resources and event listeners.
@@ -4979,9 +4980,9 @@ export interface CustomLayerInterface {
 	 * @instance
 	 * @name onRemove
 	 * @param {Map} map The Map this custom layer was just added to.
-	 * @param {WebGL2RenderingContext} gl The gl context for the map.
+	 * @param {WebGLRenderingContext | WebGL2RenderingContext} gl The gl context for the map.
 	 */
-	onRemove?(map: Map, gl: WebGL2RenderingContext): void;
+	onRemove?(map: Map, gl: WebGLRenderingContext | WebGL2RenderingContext): void;
 }
 declare abstract class StyleLayer extends Evented {
 	id: string;
@@ -7080,6 +7081,8 @@ export type MapEvent =
  * If `layerId` is included as the second argument in {@link Map#on}, the event listener will fire only
  * when the point that is clicked twice contains a visible portion of the specified layer.
  *
+ * **Note:** Under normal conditions, this event will be preceded by two {@link Map.event:click} events.
+ *
  * @event dblclick
  * @memberof Map
  * @instance
@@ -8581,6 +8584,7 @@ export type MapOptions = {
 	pitch?: number;
 	renderWorldCopies?: boolean;
 	maxTileCacheSize?: number;
+	maxTileCacheZoomLevels?: number;
 	transformRequest?: RequestTransformFunction;
 	transformCameraUpdate?: CameraUpdateTransformFunction;
 	locale?: any;
@@ -8642,6 +8646,7 @@ export declare class Map extends Camera {
 	_vertices: boolean;
 	_canvas: HTMLCanvasElement;
 	_maxTileCacheSize: number;
+	_maxTileCacheZoomLevels: number;
 	_frame: Cancelable;
 	_styleDirty: boolean;
 	_sourcesDirty: boolean;
@@ -9170,7 +9175,7 @@ export declare class Map extends Camera {
 	 * @param {FilterSpecification} [options.filter] (optional) A [filter](https://maplibre.org/maplibre-style-spec/layers/#filter)
 	 * to limit query results.
 	 * @param {Array<string>} [options.availableImages] (optional) An array of string representing the available images
-	 * @param {boolean} [options.validate=true] (optional) Whether to check if the [options.filter] conforms to the MapLibre GL Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
+	 * @param {boolean} [options.validate=true] (optional) Whether to check if the [options.filter] conforms to the MapLibre Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
 	 *
 	 * @returns {Array<MapGeoJSONFeature>} An array of MapGeoJSONFeature objects.
 	 *
@@ -9245,7 +9250,7 @@ export declare class Map extends Camera {
 	 * to query. *For vector tile sources, this parameter is required.* For GeoJSON sources, it is ignored.
 	 * @param {Array} [parameters.filter] A [filter](https://maplibre.org/maplibre-style-spec/layers/#filter)
 	 * to limit query results.
-	 * @param {boolean} [parameters.validate=true] Whether to check if the [parameters.filter] conforms to the MapLibre GL Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
+	 * @param {boolean} [parameters.validate=true] Whether to check if the [parameters.filter] conforms to the MapLibre Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
 	 *
 	 * @returns {Array<MapGeoJSONFeature>} An array of MapGeoJSONFeature objects.
 	 *
@@ -9804,7 +9809,7 @@ export declare class Map extends Camera {
 	 * @param {Array | null | undefined} filter The filter, conforming to the MapLibre Style Specification's
 	 * [filter definition](https://maplibre.org/maplibre-style-spec/layers/#filter).  If `null` or `undefined` is provided, the function removes any existing filter from the layer.
 	 * @param {Object} [options] Options object.
-	 * @param {boolean} [options.validate=true] Whether to check if the filter conforms to the MapLibre GL Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
+	 * @param {boolean} [options.validate=true] Whether to check if the filter conforms to the MapLibre Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
 	 * @returns {Map} `this`
 	 *
 	 * @example
@@ -9835,7 +9840,7 @@ export declare class Map extends Camera {
 	 * @param {*} value The value of the paint property to set.
 	 * Must be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/).
 	 * @param {Object} [options] Options object.
-	 * @param {boolean} [options.validate=true] Whether to check if `value` conforms to the MapLibre GL Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
+	 * @param {boolean} [options.validate=true] Whether to check if `value` conforms to the MapLibre Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
 	 * @returns {Map} `this`
 	 * @example
 	 * map.setPaintProperty('my-layer', 'fill-color', '#faafee');
@@ -9858,7 +9863,7 @@ export declare class Map extends Camera {
 	 * @param {string} name The name of the layout property to set.
 	 * @param {*} value The value of the layout property. Must be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/).
 	 * @param {Object} [options] Options object.
-	 * @param {boolean} [options.validate=true] Whether to check if `value` conforms to the MapLibre GL Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
+	 * @param {boolean} [options.validate=true] Whether to check if `value` conforms to the MapLibre Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
 	 * @returns {Map} `this`
 	 * @example
 	 * map.setLayoutProperty('my-layer', 'visibility', 'none');
@@ -9877,7 +9882,7 @@ export declare class Map extends Camera {
 	 *
 	 * @param glyphsUrl Glyph URL to set. Must conform to the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/glyphs/).
 	 * @param {StyleSetterOptions} [options] Options object.
-	 * @param {boolean} [options.validate=true] Whether to check if the filter conforms to the MapLibre GL Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
+	 * @param {boolean} [options.validate=true] Whether to check if the filter conforms to the MapLibre Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
 	 * @returns {Map} `this`
 	 * @example
 	 * map.setGlyphs('https://demotiles.maplibre.org/font/{fontstack}/{range}.pbf');
@@ -9927,7 +9932,7 @@ export declare class Map extends Camera {
 	 *
 	 * @param spriteUrl Sprite URL to set.
 	 * @param {StyleSetterOptions} [options] Options object.
-	 * @param {boolean} [options.validate=true] Whether to check if the filter conforms to the MapLibre GL Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
+	 * @param {boolean} [options.validate=true] Whether to check if the filter conforms to the MapLibre Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
 	 * @returns {Map} `this`
 	 * @example
 	 * map.setSprite('YOUR_SPRITE_URL');
@@ -9938,7 +9943,7 @@ export declare class Map extends Camera {
 	 *
 	 * @param light Light properties to set. Must conform to the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/#light).
 	 * @param {Object} [options] Options object.
-	 * @param {boolean} [options.validate=true] Whether to check if the filter conforms to the MapLibre GL Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
+	 * @param {boolean} [options.validate=true] Whether to check if the filter conforms to the MapLibre Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.
 	 * @returns {Map} `this`
 	 * @example
 	 * var layerVisibility = map.getLayoutProperty('my-layer', 'visibility');
@@ -10956,6 +10961,7 @@ declare const exported: {
 	config: {
 		MAX_PARALLEL_IMAGE_REQUESTS: number;
 		MAX_PARALLEL_IMAGE_REQUESTS_PER_FRAME: number;
+		MAX_TILE_CACHE_ZOOM_LEVELS: number;
 		REGISTERED_PROTOCOLS: {
 			[x: string]: (requestParameters: RequestParameters, callback: ResponseCallback<any>) => Cancelable;
 		};