@mapbox/mapbox-gl-style-spec 14.33.0 → 14.34.1-alpha.1

package/expression/definitions/config.ts

@@ -167,7 +167,7 @@ class Config implements Expression {
     serialize(): SerializedExpression {
         const res = ["config", this.key];
         if (this.scope) {
-            res.concat(this.scope);
+            res.push(this.scope);
         }
         return res;
     }

package/expression/expression_dependencies.ts

@@ -1,11 +1,13 @@
 import CompoundExpression from "./compound_expression";
 import Config from "./definitions/config";
+import ImageExpression from "./definitions/image";
 
 import type {Expression} from "./expression";
 
 export type ExpressionDependencies = {
     configDependencies: Set<string>;
     isIndoorDependent: boolean;
+    isImageDependent: boolean;
 };
 
 // Shared by every expression without config dependencies, which is the vast majority; read-only.
@@ -18,13 +20,14 @@ function collect(e: Expression, deps: ExpressionDependencies) {
         return; // `Config.eachChild` is a no-op
     }
     if (e instanceof CompoundExpression && e.name === 'is-active-floor') deps.isIndoorDependent = true;
+    if (e instanceof ImageExpression) deps.isImageDependent = true;
     e.eachChild(arg => { collect(arg, deps); });
 }
 
-// One traversal for both dependency kinds, and no per-node allocation: this runs for every
+// One traversal for all dependency kinds, and no per-node allocation: this runs for every
 // expression of every property of every layer at style load, so the walk dominates what it finds.
 export function getExpressionDependencies(e: Expression): ExpressionDependencies {
-    const deps = {configDependencies: NO_CONFIG_DEPENDENCIES, isIndoorDependent: false};
+    const deps = {configDependencies: NO_CONFIG_DEPENDENCIES, isIndoorDependent: false, isImageDependent: false};
     collect(e, deps);
     return deps;
 }

package/expression/index.ts

@@ -75,6 +75,8 @@ export class StyleExpression {
     _enumValues?: {[_: string]: unknown} | null;
     configDependencies: Set<string>;
     isIndoorDependent: boolean;
+    // Whether the result depends on the available images passed to `evaluate`
+    isImageDependent: boolean;
 
     constructor(expression: Expression, propertySpec?: StylePropertySpecification | null, scope?: string | null, options?: ConfigOptions | null, iconImageUseTheme?: string | null) {
         this.expression = expression;
@@ -88,6 +90,7 @@ export class StyleExpression {
         const dependencies = expressionDependencies.getExpressionDependencies(expression);
         this.configDependencies = dependencies.configDependencies;
         this.isIndoorDependent = dependencies.isIndoorDependent;
+        this.isImageDependent = dependencies.isImageDependent;
     }
 
     evaluateWithoutErrorHandling(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapbox/mapbox-gl-style-spec",
-  "version": "14.33.0",
+  "version": "14.34.1-alpha.1",
   "description": "a specification for mapbox gl styles",
   "author": "Mapbox",
   "license": "SEE LICENSE IN LICENSE.txt",

package/reference/v8.json

@@ -196,7 +196,7 @@
     },
     "projection": {
       "type": "projection",
-      "doc": "The projection the map should be rendered in. Supported projections are Mercator, Globe, Albers, Equal Earth, Equirectangular (WGS84), Lambert conformal conic, Natural Earth, and Winkel Tripel. Terrain, sky and fog are supported by only Mercator and globe. CustomLayerInterface is not supported outside of Mercator.",
+      "doc": "The projection the map should be rendered in. Supported projections are Mercator, Globe, Albers, Equal Earth, Equirectangular (WGS84), Lambert conformal conic, Natural Earth, and Winkel Tripel. Terrain, sky and fog are supported by only Mercator and globe. CustomLayerInterface is supported by only Mercator and globe.",
       "example": {
         "name": "albers",
         "center": [-154, 50],
@@ -2486,7 +2486,6 @@
       "minimum": 0,
       "units": "meters",
       "doc": "The height of the procedural buildings.",
-      "transition": true,
       "private": true,
       "sdk-support": {
         "basic functionality": {
@@ -2511,7 +2510,6 @@
       "minimum": 0,
       "units": "meters",
       "doc": "The height with which to extrude the base of this layer. Must be less than or equal to `building-height`.",
-      "transition": true,
       "requires": [
         "building-height"
       ],
@@ -2544,7 +2542,6 @@
       "requires": [
         "lights"
       ],
-      "transition": true,
       "expression": {
         "interpolated": true,
         "parameters": [
@@ -2575,7 +2572,6 @@
       "requires": [
         "lights"
       ],
-      "transition": true,
       "expression": {
         "interpolated": true,
         "parameters": [
@@ -2602,7 +2598,6 @@
       "private": true,
       "default": false,
       "doc": "Flips the orientation of the roofs for the buildings. This only affects simple geometries. Namely buildings whose footprints form a quadrilateral. By default (false), the roof ridge takes the direction of the longer edge of the quadrilateral.",
-      "transition": true,
       "requires": [
         "building-roof-shape"
       ],
@@ -2946,7 +2941,6 @@
       "requires": [
         "line-z-offset"
       ],
-      "transition": true,
       "property-type": "data-driven"
     }
   },
@@ -10798,6 +10792,64 @@
         "interpolated": false
       },
       "property-type": "data-constant"
+    },
+    "raster-mask": {
+      "type": "string",
+      "required": false,
+      "experimental": true,
+      "private": true,
+      "doc": "The id of a `fill` layer in the same style whose polygons should clip this layer. Only the geometry is used: set `fill-opacity` to 0 to keep the layer invisible, but don't hide it with `visibility`, `minzoom` or `maxzoom`. To use a featureset from another import, see `raster-mask-import`. Elevated `fill` layers and `raster-elevation` are not supported. This layer is only drawn where the mask's data has loaded, and not at all if the mask can't be used.",
+      "example": "water",
+      "transition": false,
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.34.0"
+        }
+      },
+      "property-type": "data-constant"
+    },
+    "raster-mask-import": {
+      "type": "string",
+      "required": false,
+      "experimental": true,
+      "private": true,
+      "doc": "The id of an import of this style. When set, `raster-mask` is the id of a featureset of that import instead of a layer id, and the mask is made of the `fill` layers the featureset selects. If the featureset can't be found, or selects no `fill` layers, this layer is not drawn.",
+      "example": "basemap",
+      "transition": false,
+      "requires": [
+        "raster-mask"
+      ],
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.34.0"
+        }
+      },
+      "property-type": "data-constant"
+    },
+    "raster-mask-mode": {
+      "type": "enum",
+      "doc": "Whether this layer is drawn inside or outside the mask.",
+      "values": {
+        "clip-path-intersect": {
+          "doc": "Draw only where the mask layer's geometry covers the map."
+        },
+        "clip-path-exclude": {
+          "doc": "Draw only where the mask layer's geometry does not cover the map."
+        }
+      },
+      "default": "clip-path-intersect",
+      "experimental": true,
+      "private": true,
+      "transition": false,
+      "requires": [
+        "raster-mask"
+      ],
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.34.0"
+        }
+      },
+      "property-type": "data-constant"
     }
   },
   "paint_raster-particle": {

package/types.ts

@@ -716,8 +716,7 @@ export type LineLayerSpecification = {
          * @experimental This property is experimental and subject to change in future versions.
          */
         "line-width-unit"?: PropertyValueSpecification<"pixels" | "meters">,
-        "line-elevation-ground-scale"?: DataDrivenPropertyValueSpecification<number>,
-        "line-elevation-ground-scale-transition"?: TransitionSpecification
+        "line-elevation-ground-scale"?: DataDrivenPropertyValueSpecification<number>
     },
     "paint"?: {
         "line-opacity"?: DataDrivenPropertyValueSpecification<number>,
@@ -1166,15 +1165,10 @@ export type BuildingLayerSpecification = {
         "building-facade-window"?: DataDrivenPropertyValueSpecification<[number, number]>,
         "building-roof-shape"?: DataDrivenPropertyValueSpecification<"flat" | "hipped" | "gabled" | "parapet" | "mansard" | "skillion" | "pyramidal">,
         "building-height"?: DataDrivenPropertyValueSpecification<number>,
-        "building-height-transition"?: TransitionSpecification,
         "building-base"?: DataDrivenPropertyValueSpecification<number>,
-        "building-base-transition"?: TransitionSpecification,
         "building-flood-light-wall-radius"?: DataDrivenPropertyValueSpecification<number>,
-        "building-flood-light-wall-radius-transition"?: TransitionSpecification,
         "building-flood-light-ground-radius"?: DataDrivenPropertyValueSpecification<number>,
-        "building-flood-light-ground-radius-transition"?: TransitionSpecification,
-        "building-flip-roof-orientation"?: DataDrivenPropertyValueSpecification<boolean>,
-        "building-flip-roof-orientation-transition"?: TransitionSpecification
+        "building-flip-roof-orientation"?: DataDrivenPropertyValueSpecification<boolean>
     },
     "paint"?: {
         "building-opacity"?: PropertyValueSpecification<number>,
@@ -1272,7 +1266,19 @@ export type RasterLayerSpecification = {
         /**
          * @experimental This property is experimental and subject to change in future versions.
          */
-        "raster-elevation-reference"?: "sea" | "ground" | ExpressionSpecification
+        "raster-elevation-reference"?: "sea" | "ground" | ExpressionSpecification,
+        /**
+         * @experimental This property is experimental and subject to change in future versions.
+         */
+        "raster-mask"?: string,
+        /**
+         * @experimental This property is experimental and subject to change in future versions.
+         */
+        "raster-mask-import"?: string,
+        /**
+         * @experimental This property is experimental and subject to change in future versions.
+         */
+        "raster-mask-mode"?: "clip-path-intersect" | "clip-path-exclude"
     },
     "appearances"?: Array<AppearanceSpecification>
 };

package/validate/validate_layer.ts

@@ -107,6 +107,27 @@ export default function validateLayer(options: LayerValidatorOptions): Validatio
         }
     }
 
+    if (type === 'raster' && isObject(layer.paint)) {
+        const paint = layer.paint as Record<string, unknown>;
+        const maskId = unbundle(paint['raster-mask']);
+        const importId = unbundle(paint['raster-mask-import']);
+        if (isString(maskId) && maskId) {
+            if (isString(importId) && importId) {
+                // The featureset itself can only be checked once the import has loaded.
+                if (!(style.imports || []).some((i) => unbundle(i.id) === importId)) {
+                    errors.push(new ValidationError(`${key}.paint.raster-mask-import`, paint['raster-mask-import'], `import "${importId}" not found`));
+                }
+            } else {
+                const maskLayer = (style.layers || []).find((l) => unbundle(l.id) === maskId);
+                if (!maskLayer) {
+                    errors.push(new ValidationError(`${key}.paint.raster-mask`, paint['raster-mask'], `layer "${maskId}" not found`));
+                } else if (unbundle(maskLayer.type) !== 'fill') {
+                    errors.push(new ValidationError(`${key}.paint.raster-mask`, paint['raster-mask'], `layer "${maskId}" must be a "fill" layer`));
+                }
+            }
+        }
+    }
+
     errors = errors.concat(validateObject({
         key,
         value: layer,