@mapbox/mapbox-gl-style-spec 14.9.2 → 14.10.0

package/group_by_layout.ts

@@ -24,7 +24,15 @@ function stringify(obj: any) {
 function getKey(layer: LayerSpecification) {
     let key = '';
     for (const k of refProperties) {
-        key += `/${stringify((layer as any)[k])}`;
+        // Ignore minzoom and maxzoom for model layers so that multiple model layers
+        // referencing the same source (but with different zoom ranges) produce the same
+        // key. This ensures they get grouped into a single bucket, preventing a scenario
+        // where shared node data is serialized twice and triggers an assert in struct_array.ts.
+        if (layer.type === 'model' && (k === 'minzoom' || k === 'maxzoom')) {
+            continue;
+        } else {
+            key += `/${stringify((layer as any)[k])}`;
+        }
     }
     return key;
 }

package/package.json

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

package/reference/v8.json

@@ -220,6 +220,13 @@
       "experimental": true,
       "type": "featuresets",
       "doc": "Defines sets of features for querying, interaction, and state management on the map, referencing individual layers or subsets of layers within the map's style.",
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.9.0",
+          "android": "11.9.0",
+          "ios": "11.9.0"
+        }
+      },
       "example": {
         "poi": {
           "selectors": [
@@ -246,10 +253,12 @@
   "featureset": {
     "experimental": true,
     "metadata": {
+      "experimental": true,
       "type": "*",
       "doc": "Arbitrary properties useful to track with the stylesheet, but do not influence rendering. Properties should be prefixed to avoid collisions, like 'mapbox:'."
     },
     "selectors": {
+      "experimental": true,
       "type": "array",
       "value": "selector",
       "doc": "A collection of categorized selectors."
@@ -258,24 +267,35 @@
   "selector": {
     "experimental": true,
     "layer": {
+      "experimental": true,
       "type": "string",
       "doc": "The ID of a layer that exists in the current style.",
       "required": true
     },
     "properties": {
+      "experimental": true,
       "type": "selectorProperty",
       "required": false,
       "doc": "Properties accessible to the end user through queried feautures. If properties are empty, no feature properties are exposed. If undefined, all original feature properties will be accessible."
     },
     "featureNamespace": {
+      "experimental": true,
       "type": "string",
       "required": false,
       "doc": "An optional field that represents the feature namespace defined by the selector within a featureset to which this feature belongs. If the underlying source is the same for multiple selectors within a featureset, the same featureNamespace should be used across those selectors."
+    },
+    "_uniqueFeatureID": {
+      "experimental": true,
+      "type": "boolean",
+      "private": true,
+      "required": false,
+      "doc": "Internal flag used for standard style, in case multiple features sharing the same featureId, only one feature will be returned for feature query."
     }
   },
   "selectorProperty": {
     "experimental": true,
     "*": {
+      "experimental": true,
       "type": "*",
       "doc": "The value of the property. It can be an expression that generates the returned value from the feature, or a constant value specifying the returned value."
     }
@@ -1713,6 +1733,31 @@
       },
       "property-type": "data-driven"
     },
+    "circle-elevation-reference": {
+      "type": "enum",
+      "doc": "Selects the base of circle-elevation. Some modes might require precomputed elevation data in the tileset.",
+      "values": {
+        "none": {
+          "doc": "Elevated rendering is disabled."
+        },
+        "hd-road-markup": {
+          "doc": "Elevated rendering is enabled. Use this mode to describe additive and stackable features that should exist only on top of road polygons."
+        }
+      },
+      "default": "none",
+      "experimental": true,
+      "transition": false,
+      "sdk-support": {
+        "basic functionality": {
+          "android": "11.11.0",
+          "ios": "11.11.0"
+        }
+      },
+      "expression": {
+        "interpolated": false
+      },
+      "property-type": "data-constant"
+    },
     "visibility": {
       "type": "enum",
       "values": {
@@ -10165,8 +10210,8 @@
   },
   "promoteId": {
     "*": {
-      "type": "string",
-      "doc": "A name of a feature property to use as ID for feature state."
+      "type": "*",
+      "doc": "A feature property name to use as the ID, or an expression to evaluate as the ID for feature state."
     }
   }
 }

package/types.ts

@@ -8,7 +8,7 @@ export type FormattedSpecification = string;
 
 export type ResolvedImageSpecification = string;
 
-export type PromoteIdSpecification = {[_: string]: string} | string;
+export type PromoteIdSpecification = {[_: string]: string | ExpressionSpecification} | string | ExpressionSpecification;
 
 export type FilterSpecification =
     | ExpressionSpecification
@@ -274,7 +274,13 @@ export type FeaturesetsSpecification = {
  * @experimental This is experimental and subject to change in future versions.
  */
 export type FeaturesetSpecification = {
+    /**
+     * @experimental This property is experimental and subject to change in future versions.
+     */
     "metadata"?: unknown,
+    /**
+     * @experimental This property is experimental and subject to change in future versions.
+     */
     "selectors"?: Array<SelectorSpecification>
 }
 
@@ -282,15 +288,31 @@ export type FeaturesetSpecification = {
  * @experimental This is experimental and subject to change in future versions.
  */
 export type SelectorSpecification = {
+    /**
+     * @experimental This property is experimental and subject to change in future versions.
+     */
     "layer": string,
+    /**
+     * @experimental This property is experimental and subject to change in future versions.
+     */
     "properties"?: SelectorPropertySpecification,
-    "featureNamespace"?: string
+    /**
+     * @experimental This property is experimental and subject to change in future versions.
+     */
+    "featureNamespace"?: string,
+    /**
+     * @experimental This property is experimental and subject to change in future versions.
+     */
+    "_uniqueFeatureID"?: boolean
 }
 
 /**
  * @experimental This is experimental and subject to change in future versions.
  */
 export type SelectorPropertySpecification = {
+    /**
+     * @experimental This property is experimental and subject to change in future versions.
+     */
     [_: string]: unknown
 }
 
@@ -730,6 +752,10 @@ export type CircleLayerSpecification = {
     "filter"?: FilterSpecification,
     "layout"?: {
         "circle-sort-key"?: DataDrivenPropertyValueSpecification<number>,
+        /**
+         * @experimental This property is experimental and subject to change in future versions.
+         */
+        "circle-elevation-reference"?: "none" | "hd-road-markup" | ExpressionSpecification,
         "visibility"?: "visible" | "none" | ExpressionSpecification
     },
     "paint"?: {

package/validate/validate_property.ts

@@ -5,7 +5,7 @@ import {isFunction} from '../function/index';
 import {unbundle, deepUnbundle} from '../util/unbundle_jsonlint';
 import {supportsLightExpression, supportsPropertyExpression, supportsZoomExpression} from '../util/properties';
 import {isGlobalPropertyConstant, isFeatureConstant, isStateConstant} from '../expression/is_constant';
-import {createPropertyExpression} from '../expression/index';
+import {createPropertyExpression, isExpression} from '../expression/index';
 
 import type {ValidationOptions} from './validate';
 
@@ -28,6 +28,30 @@ export default function validateProperty(options: PropertyValidationOptions, pro
 
     const useThemeMatch = propertyKey.match(/^(.*)-use-theme$/);
     if (propertyType === 'paint' && useThemeMatch && layerSpec[useThemeMatch[1]]) {
+        if (isExpression(value)) {
+            const errors = [];
+            return errors.concat(validate({
+                key: options.key,
+                value,
+                valueSpec: {
+                    "type": "string",
+                    "expression": {
+                        "interpolated": false,
+                        "parameters": [
+                            "zoom",
+                            "feature"
+                        ]
+                    },
+                    "property-type": "data-driven"
+                },
+                style,
+                styleSpec,
+                // @ts-expect-error - TS2353 - Object literal may only specify known properties, and 'expressionContext' does not exist in type 'ValidationOptions'.
+                expressionContext: 'property',
+                propertyType,
+                propertyKey
+            }));
+        }
         return validate({
             key,
             value,

package/validate/validate_source.ts

@@ -1,10 +1,12 @@
 import {default as ValidationError, ValidationWarning} from '../error/validation_error';
-import {unbundle} from '../util/unbundle_jsonlint';
+import {unbundle, deepUnbundle} from '../util/unbundle_jsonlint';
 import validateObject from './validate_object';
 import validateEnum from './validate_enum';
 import validateExpression from './validate_expression';
 import validateString from './validate_string';
 import getType from '../util/get_type';
+import {createExpression} from '../expression/index';
+import * as isConstant from '../expression/is_constant';
 
 import type {StyleReference} from '../reference/latest';
 import type {ValidationOptions} from './validate';
@@ -125,10 +127,28 @@ function validatePromoteId({
 }: Partial<ValidationOptions>) {
     if (getType(value) === 'string') {
         return validateString({key, value});
+    } else if (Array.isArray(value)) {
+        const errors = [];
+        const unbundledValue = deepUnbundle(value);
+        const expression = createExpression(unbundledValue);
+        if (expression.result === 'error') {
+            expression.value.forEach((err) => {
+                errors.push(new ValidationError(`${key}${err.key}`, null, `${err.message}`));
+            });
+        }
+
+        // @ts-expect-error - TS2339: Property 'expression' does not exist on type 'ParsingError[] | StyleExpression'.
+        const parsed = expression.value.expression;
+        const onlyFeatureDependent = isConstant.isGlobalPropertyConstant(parsed, ['zoom', 'heatmap-density', 'line-progress', 'raster-value', 'sky-radial-progress', 'accumulated', 'is-supported-script', 'pitch', 'distance-from-center', 'measure-light', 'raster-particle-speed']);
+        if (!onlyFeatureDependent) {
+            errors.push(new ValidationError(`${key}`, null, 'promoteId expression should be only feature dependent'));
+        }
+
+        return errors;
     } else {
         const errors = [];
         for (const prop in value) {
-            errors.push(...validateString({key: `${key}.${prop}`, value: value[prop]}));
+            errors.push(...validatePromoteId({key: `${key}.${prop}`, value: value[prop]}));
         }
         return errors;
     }

package/validate_mapbox_api_supported.ts

@@ -40,9 +40,9 @@ function getSourceErrors(source: any, i: number): Array<ValidationError> {
 
     /*
      * Inlined sources are not supported by the Mapbox Styles API, so only
-     * "type", "url", and "tileSize" properties are valid
+     * "type", "url", and "tileSize", "promoteId" properties are valid
      */
-    const sourceKeys = ['type', 'url', 'tileSize'];
+    const sourceKeys = ['type', 'url', 'tileSize', 'promoteId'];
     errors.push(...getAllowedKeyErrors(source, sourceKeys, 'source'));
 
     /*