@mapbox/mapbox-gl-style-spec 14.11.0 → 14.12.0

package/dist/index.d.ts

@@ -280,57 +280,114 @@ type FogSpecification = {
 	"vertical-range-transition"?: TransitionSpecification;
 };
 type SnowSpecification = {
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"density"?: PropertyValueSpecification<number>;
 	"density-transition"?: TransitionSpecification;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"intensity"?: PropertyValueSpecification<number>;
 	"intensity-transition"?: TransitionSpecification;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"color"?: PropertyValueSpecification<ColorSpecification>;
 	"color-transition"?: TransitionSpecification;
 	"color-use-theme"?: PropertyValueSpecification<string>;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"opacity"?: PropertyValueSpecification<number>;
 	"opacity-transition"?: TransitionSpecification;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"vignette"?: PropertyValueSpecification<number>;
 	"vignette-transition"?: TransitionSpecification;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"vignette-color"?: PropertyValueSpecification<ColorSpecification>;
 	"vignette-color-transition"?: TransitionSpecification;
 	"vignette-color-use-theme"?: PropertyValueSpecification<string>;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"center-thinning"?: PropertyValueSpecification<number>;
 	"center-thinning-transition"?: TransitionSpecification;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"direction"?: PropertyValueSpecification<[
 		number,
 		number
 	]>;
 	"direction-transition"?: TransitionSpecification;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"flake-size"?: PropertyValueSpecification<number>;
 	"flake-size-transition"?: TransitionSpecification;
 };
 type RainSpecification = {
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"density"?: PropertyValueSpecification<number>;
 	"density-transition"?: TransitionSpecification;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"intensity"?: PropertyValueSpecification<number>;
 	"intensity-transition"?: TransitionSpecification;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"color"?: PropertyValueSpecification<ColorSpecification>;
 	"color-transition"?: TransitionSpecification;
 	"color-use-theme"?: PropertyValueSpecification<string>;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"opacity"?: PropertyValueSpecification<number>;
 	"opacity-transition"?: TransitionSpecification;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"vignette"?: PropertyValueSpecification<number>;
 	"vignette-transition"?: TransitionSpecification;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"vignette-color"?: PropertyValueSpecification<ColorSpecification>;
 	"vignette-color-transition"?: TransitionSpecification;
 	"vignette-color-use-theme"?: PropertyValueSpecification<string>;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"center-thinning"?: PropertyValueSpecification<number>;
 	"center-thinning-transition"?: TransitionSpecification;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"direction"?: PropertyValueSpecification<[
 		number,
 		number
 	]>;
 	"direction-transition"?: TransitionSpecification;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"droplet-size"?: PropertyValueSpecification<[
 		number,
 		number
 	]>;
 	"droplet-size-transition"?: TransitionSpecification;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
 	"distortion-strength"?: PropertyValueSpecification<number>;
 	"distortion-strength-transition"?: TransitionSpecification;
 };
@@ -432,6 +489,12 @@ type VectorSourceSpecification = {
 		number,
 		number
 	];
+	"extra_bounds"?: Array<[
+		number,
+		number,
+		number,
+		number
+	]>;
 	"scheme"?: "xyz" | "tms";
 	"minzoom"?: number;
 	"maxzoom"?: number;
@@ -450,6 +513,12 @@ type RasterSourceSpecification = {
 		number,
 		number
 	];
+	"extra_bounds"?: Array<[
+		number,
+		number,
+		number,
+		number
+	]>;
 	"minzoom"?: number;
 	"maxzoom"?: number;
 	"tileSize"?: number;
@@ -468,6 +537,12 @@ type RasterDEMSourceSpecification = {
 		number,
 		number
 	];
+	"extra_bounds"?: Array<[
+		number,
+		number,
+		number,
+		number
+	]>;
 	"minzoom"?: number;
 	"maxzoom"?: number;
 	"tileSize"?: number;
@@ -486,6 +561,12 @@ type RasterArraySourceSpecification = {
 		number,
 		number
 	];
+	"extra_bounds"?: Array<[
+		number,
+		number,
+		number,
+		number
+	]>;
 	"minzoom"?: number;
 	"maxzoom"?: number;
 	"tileSize"?: number;
@@ -664,13 +745,24 @@ type FillLayerSpecification = {
 		"fill-translate-transition"?: TransitionSpecification;
 		"fill-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
 		"fill-pattern"?: DataDrivenPropertyValueSpecification<ResolvedImageSpecification>;
+		"fill-pattern-cross-fade"?: PropertyValueSpecification<number>;
+		"fill-pattern-cross-fade-transition"?: TransitionSpecification;
 		"fill-emissive-strength"?: PropertyValueSpecification<number>;
 		"fill-emissive-strength-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"fill-z-offset"?: DataDrivenPropertyValueSpecification<number>;
 		"fill-z-offset-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"fill-bridge-guard-rail-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
 		"fill-bridge-guard-rail-color-transition"?: TransitionSpecification;
 		"fill-bridge-guard-rail-color-use-theme"?: PropertyValueSpecification<string>;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"fill-tunnel-structure-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
 		"fill-tunnel-structure-color-transition"?: TransitionSpecification;
 		"fill-tunnel-structure-color-use-theme"?: PropertyValueSpecification<string>;
@@ -732,6 +824,8 @@ type LineLayerSpecification = {
 		"line-blur-transition"?: TransitionSpecification;
 		"line-dasharray"?: DataDrivenPropertyValueSpecification<Array<number>>;
 		"line-pattern"?: DataDrivenPropertyValueSpecification<ResolvedImageSpecification>;
+		"line-pattern-cross-fade"?: PropertyValueSpecification<number>;
+		"line-pattern-cross-fade-transition"?: TransitionSpecification;
 		"line-gradient"?: ExpressionSpecification;
 		"line-gradient-use-theme"?: PropertyValueSpecification<string>;
 		"line-trim-offset"?: [
@@ -745,6 +839,9 @@ type LineLayerSpecification = {
 			number,
 			number
 		]>;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"line-trim-color"?: PropertyValueSpecification<ColorSpecification>;
 		"line-trim-color-transition"?: TransitionSpecification;
 		"line-trim-color-use-theme"?: PropertyValueSpecification<string>;
@@ -862,7 +959,7 @@ type SymbolLayerSpecification = {
 		]>;
 		"icon-translate-transition"?: TransitionSpecification;
 		"icon-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
-		"icon-image-cross-fade"?: DataDrivenPropertyValueSpecification<number>;
+		"icon-image-cross-fade"?: PropertyValueSpecification<number>;
 		"icon-image-cross-fade-transition"?: TransitionSpecification;
 		"text-opacity"?: DataDrivenPropertyValueSpecification<number>;
 		"text-opacity-transition"?: TransitionSpecification;
@@ -888,6 +985,9 @@ type SymbolLayerSpecification = {
 		"icon-color-contrast"?: ExpressionSpecification;
 		"icon-color-brightness-min"?: ExpressionSpecification;
 		"icon-color-brightness-max"?: ExpressionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"symbol-z-offset"?: DataDrivenPropertyValueSpecification<number>;
 		"symbol-z-offset-transition"?: TransitionSpecification;
 	};
@@ -994,6 +1094,8 @@ type FillExtrusionLayerSpecification = {
 		"fill-extrusion-translate-transition"?: TransitionSpecification;
 		"fill-extrusion-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
 		"fill-extrusion-pattern"?: DataDrivenPropertyValueSpecification<ResolvedImageSpecification>;
+		"fill-extrusion-pattern-cross-fade"?: PropertyValueSpecification<number>;
+		"fill-extrusion-pattern-cross-fade-transition"?: TransitionSpecification;
 		"fill-extrusion-height"?: DataDrivenPropertyValueSpecification<number>;
 		"fill-extrusion-height-transition"?: TransitionSpecification;
 		"fill-extrusion-base"?: DataDrivenPropertyValueSpecification<number>;
@@ -1011,23 +1113,50 @@ type FillExtrusionLayerSpecification = {
 		"fill-extrusion-ambient-occlusion-intensity-transition"?: TransitionSpecification;
 		"fill-extrusion-ambient-occlusion-radius"?: PropertyValueSpecification<number>;
 		"fill-extrusion-ambient-occlusion-radius-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"fill-extrusion-ambient-occlusion-wall-radius"?: PropertyValueSpecification<number>;
 		"fill-extrusion-ambient-occlusion-wall-radius-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"fill-extrusion-ambient-occlusion-ground-radius"?: PropertyValueSpecification<number>;
 		"fill-extrusion-ambient-occlusion-ground-radius-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"fill-extrusion-ambient-occlusion-ground-attenuation"?: PropertyValueSpecification<number>;
 		"fill-extrusion-ambient-occlusion-ground-attenuation-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"fill-extrusion-flood-light-color"?: PropertyValueSpecification<ColorSpecification>;
 		"fill-extrusion-flood-light-color-transition"?: TransitionSpecification;
 		"fill-extrusion-flood-light-color-use-theme"?: PropertyValueSpecification<string>;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"fill-extrusion-flood-light-intensity"?: PropertyValueSpecification<number>;
 		"fill-extrusion-flood-light-intensity-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"fill-extrusion-flood-light-wall-radius"?: DataDrivenPropertyValueSpecification<number>;
 		"fill-extrusion-flood-light-wall-radius-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"fill-extrusion-flood-light-ground-radius"?: DataDrivenPropertyValueSpecification<number>;
 		"fill-extrusion-flood-light-ground-radius-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"fill-extrusion-flood-light-ground-attenuation"?: PropertyValueSpecification<number>;
 		"fill-extrusion-flood-light-ground-attenuation-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"fill-extrusion-vertical-scale"?: PropertyValueSpecification<number>;
 		"fill-extrusion-vertical-scale-transition"?: TransitionSpecification;
 		/**
@@ -1037,11 +1166,87 @@ type FillExtrusionLayerSpecification = {
 		"fill-extrusion-cutoff-fade-range"?: ExpressionSpecification;
 		"fill-extrusion-emissive-strength"?: DataDrivenPropertyValueSpecification<number>;
 		"fill-extrusion-emissive-strength-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"fill-extrusion-line-width"?: DataDrivenPropertyValueSpecification<number>;
 		"fill-extrusion-line-width-transition"?: TransitionSpecification;
 		"fill-extrusion-cast-shadows"?: boolean;
 	};
 };
+type BuildingLayerSpecification = {
+	"id": string;
+	"type": "building";
+	"metadata"?: unknown;
+	"source": string;
+	"source-layer"?: string;
+	"slot"?: string;
+	"minzoom"?: number;
+	"maxzoom"?: number;
+	"filter"?: FilterSpecification;
+	"layout"?: {
+		"visibility"?: "visible" | "none" | ExpressionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
+		"building-roof-shape"?: DataDrivenPropertyValueSpecification<"flat" | "hipped" | "gabled" | "parapet" | "mansard" | "skillion" | "pyramidal">;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
+		"building-height"?: DataDrivenPropertyValueSpecification<number>;
+		"building-height-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
+		"building-base"?: DataDrivenPropertyValueSpecification<number>;
+		"building-base-transition"?: TransitionSpecification;
+	};
+	"paint"?: {
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
+		"building-opacity"?: PropertyValueSpecification<number>;
+		"building-opacity-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
+		"building-ambient-occlusion-wall-intensity"?: PropertyValueSpecification<number>;
+		"building-ambient-occlusion-wall-intensity-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
+		"building-ambient-occlusion-ground-intensity"?: PropertyValueSpecification<number>;
+		"building-ambient-occlusion-ground-intensity-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
+		"building-ambient-occlusion-ground-radius"?: PropertyValueSpecification<number>;
+		"building-ambient-occlusion-ground-radius-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
+		"building-ambient-occlusion-ground-attenuation"?: PropertyValueSpecification<number>;
+		"building-ambient-occlusion-ground-attenuation-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
+		"building-vertical-scale"?: PropertyValueSpecification<number>;
+		"building-vertical-scale-transition"?: TransitionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
+		"building-cast-shadows"?: boolean;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
+		"building-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
+		"building-color-use-theme"?: PropertyValueSpecification<string>;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
+		"building-emissive-strength"?: DataDrivenPropertyValueSpecification<number>;
+	};
+};
 type RasterLayerSpecification = {
 	"id": string;
 	"type": "raster";
@@ -1090,6 +1295,9 @@ type RasterLayerSpecification = {
 		 * @experimental This property is experimental and subject to change in future versions.
 		 */
 		"raster-array-band"?: string;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
 		"raster-elevation"?: PropertyValueSpecification<number>;
 		"raster-elevation-transition"?: TransitionSpecification;
 	};
@@ -1310,7 +1518,7 @@ type ClipLayerSpecification = {
 	};
 	"paint"?: never;
 };
-type LayerSpecification = FillLayerSpecification | LineLayerSpecification | SymbolLayerSpecification | CircleLayerSpecification | HeatmapLayerSpecification | FillExtrusionLayerSpecification | RasterLayerSpecification | RasterParticleLayerSpecification | HillshadeLayerSpecification | ModelLayerSpecification | BackgroundLayerSpecification | SkyLayerSpecification | SlotLayerSpecification | ClipLayerSpecification;
+type LayerSpecification = FillLayerSpecification | LineLayerSpecification | SymbolLayerSpecification | CircleLayerSpecification | HeatmapLayerSpecification | FillExtrusionLayerSpecification | BuildingLayerSpecification | RasterLayerSpecification | RasterParticleLayerSpecification | HillshadeLayerSpecification | ModelLayerSpecification | BackgroundLayerSpecification | SkyLayerSpecification | SlotLayerSpecification | ClipLayerSpecification;
 /**
  * Given an array of layers, some of which may contain `ref` properties
  * whose value is the `id` of another property, return a new array where
@@ -1327,7 +1535,7 @@ type LayerSpecification = FillLayerSpecification | LineLayerSpecification | Symb
 export function derefLayers(layers: Array<LayerSpecification>): Array<LayerSpecification>;
 type Command = {
 	command: string;
-	args: Array<any>;
+	args: unknown[];
 };
 /**
  * Diff two stylesheet
@@ -1352,8 +1560,8 @@ export declare class ValidationError {
 	message: string;
 	identifier: string | null | undefined;
 	line: number | null | undefined;
-	constructor(key: string | null | undefined, value: {
-		__line__: number;
+	constructor(key: string | null | undefined, value: (string | number | boolean) & {
+		__line__?: number;
 	} | null | undefined, message: string, identifier?: string | null);
 }
 export declare class ParsingError {
@@ -1528,7 +1736,7 @@ declare class ImageVariant {
 	constructor(id: string | ImageIdSpec, options?: RasterizationOptions);
 	toString(): StringifiedImageVariant;
 	static parse(str: StringifiedImageVariant): ImageVariant | null;
-	scaleSelf(factor: number): this;
+	scaleSelf(factor: number, yFactor?: number): this;
 }
 declare class ResolvedImage {
 	primaryId: ImageId;
@@ -1678,12 +1886,12 @@ declare class EvaluationContext {
 		[_: string]: Color | null | undefined;
 	};
 	constructor(scope?: string | null, options?: ConfigOptions | null);
-	id(): number | null;
+	id(): string | number | null;
 	geometryType(): null | string;
 	geometry(): Array<Array<Point>> | null | undefined;
 	canonicalID(): null | CanonicalTileID;
 	properties(): {
-		[key: string]: any;
+		readonly [key: string]: unknown;
 	};
 	measureLight(_: string): number;
 	distanceFromCenter(): number;
@@ -1713,13 +1921,9 @@ type InterpolationType = {
 };
 interface Feature {
 	readonly type: 0 | 1 | 2 | 3 | "Unknown" | "Point" | "LineString" | "Polygon";
-	readonly id?: number | null;
-	readonly properties: {
-		[_: string]: any;
-	};
-	readonly patterns?: {
-		[_: string]: string;
-	};
+	readonly id?: string | number | null;
+	readonly properties: Record<PropertyKey, unknown>;
+	readonly patterns?: Record<PropertyKey, string[]>;
 	readonly geometry?: Array<Array<Point>>;
 }
 type FeatureState = {
@@ -1907,6 +2111,10 @@ type ValidationErrors = ReadonlyArray<ValidationError$1>;
  *   var errors = validate(style);
  */
 declare function validateStyle(style: StyleSpecification | string | Buffer, styleSpec?: StyleReference): ValidationErrors;
+type MapboxStyleSpecification = StyleSpecification & {
+	visibility?: "public" | "private";
+	protected?: boolean;
+};
 /**
  * Validate a Mapbox GL style against the style specification and check for
  * compatibility with the Mapbox Styles API.
@@ -1917,7 +2125,7 @@ declare function validateStyle(style: StyleSpecification | string | Buffer, styl
  *   var validateMapboxApiSupported = require('mapbox-gl-style-spec/lib/validate_style_mapbox_api_supported.js');
  *   var errors = validateMapboxApiSupported(style);
  */
-export function validateMapboxApiSupported(style: any, styleSpec?: any): ValidationErrors;
+export function validateMapboxApiSupported(style: MapboxStyleSpecification, styleSpec?: StyleReference): ValidationErrors;
 type ExpressionType = "data-driven" | "color-ramp" | "data-constant" | "constant";
 type ExpressionParameters = Array<"zoom" | "feature" | "feature-state" | "heatmap-density" | "line-progress" | "raster-value" | "sky-radial-progress" | "pitch" | "distance-from-center" | "measure-light" | "raster-particle-speed">;
 type ExpressionSpecification$1 = {