@mapbox/mapbox-gl-style-spec 14.6.0-beta.1 → 14.7.0-beta.1

package/reference/v8.json

@@ -200,6 +200,65 @@
         "spruce1-lod1": "asset://spruce1-lod1.glb",
         "spruce1-lod2": "asset://spruce1-lod2.glb"
       }
+    },
+   "featuresets": {
+      "experimental": true,
+      "type": "featuresets",
+      "doc": "Defines sets of features for querying, interaction, and feature state manipulation.",
+      "example": {
+        "poi": {
+          "selectors": [
+            {
+              "layer": "poi",
+              "properties": {
+                "type": ["get", "type"],
+                "name": ["get", "name"],
+                "brand": "ABC"
+              }
+            }
+          ]
+        }
+      }
+    }
+  },
+  "featuresets": {
+    "experimental": true,
+    "*": {
+      "type": "featureset",
+      "doc": "Defines a combined set of features from one or more underlying layers within the current style. Features in a style featureset can be queried, interacted with, and their states can be queried and updated."
+    }
+  },
+  "featureset": {
+    "experimental": true,
+    "selectors": {
+      "type": "array",
+      "value": "selector",
+      "doc": "A collection of categorized selectors."
+    }
+  },
+  "selector": {
+    "experimental": true,
+    "layer": {
+      "type": "string",
+      "doc": "The ID of a layer that exists in the current style.",
+      "required": true
+    },
+    "properties": {
+      "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": {
+      "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."
+    }
+  },
+  "selectorProperty": {
+    "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."
     }
   },
   "model": {
@@ -424,9 +483,6 @@
       "default": false,
       "doc": "Enable/Disable shadow casting for this light",
       "transition": false,
-      "expression": {
-        "interpolated": false
-      },
       "property-type": "data-constant",
       "sdk-support": {
         "basic functionality": {
@@ -512,7 +568,7 @@
           "doc": "The position of the light source is aligned to the rotation of the map."
         },
         "viewport": {
-          "doc": "The position of the light source is aligned to the rotation of the viewport."
+          "doc": "The position of the light source is aligned to the rotation of the viewport. If terrain is enabled, performance regressions may occur in certain scenarios, particularly on lower-end hardware. Ensure that you test your target scenarios on the appropriate hardware to verify performance."
         }
       },
       "property-type": "data-constant",
@@ -1485,6 +1541,24 @@
       },
       "property-type": "data-constant",
       "experimental": true
+    },
+    "clip-layer-scope": {
+      "type": "array",
+      "value": "string",
+      "default": [],
+      "doc": "Removes content from layers with the specified scope. By default all layers are affected. For example specifying `basemap` will only remove content from the Mapbox Standard style layers which have the same scope",
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.6.0",
+          "android": "11.7.0",
+          "ios": "11.7.0"
+        }
+      },
+      "expression": {
+        "interpolated": false
+      },
+      "property-type": "data-constant",
+      "experimental": true
     }
   },
   "layout_fill": {
@@ -1661,7 +1735,6 @@
     "fill-extrusion-edge-radius": {
       "type": "number",
       "experimental": true,
-      "private": true,
       "default": 0,
       "minimum": 0,
       "maximum": 1,
@@ -5392,6 +5465,30 @@
         ]
       },
       "property-type": "data-constant"
+    },
+    "fill-z-offset": {
+      "type": "number",
+      "doc": "Specifies an uniform elevation in meters. Note: If the value is zero, the layer will be rendered on the ground. Non-zero values will elevate the layer from the sea level, which can cause it to be rendered below the terrain.",
+      "default": 0,
+      "minimum": 0,
+      "transition": true,
+      "experimental": true,
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.7.0"
+        },
+        "data-driven styling": {
+          "js": "3.7.0"
+        }
+      },
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "feature"
+        ]
+      },
+      "property-type": "data-driven"
     }
   },
   "paint_fill-extrusion": {
@@ -5615,7 +5712,6 @@
     "fill-extrusion-ambient-occlusion-intensity": {
       "property-type": "data-constant",
       "type": "number",
-      "private": true,
       "default": 0.0,
       "minimum": 0,
       "maximum": 1,
@@ -5638,7 +5734,6 @@
     "fill-extrusion-ambient-occlusion-radius": {
       "property-type": "data-constant",
       "type": "number",
-      "private": true,
       "default": 3.0,
       "minimum": 0,
       "expression": {
@@ -5827,7 +5922,7 @@
       "experimental": true,
       "units": "meters",
       "default": 0,
-      "doc": "The extent of the flood light effect on the ground beneath the extruded buildings in meters.",
+      "doc": "The extent of the flood light effect on the ground beneath the extruded buildings in meters. Note: this experimental property is evaluated once per tile, during tile initialization. Changing the property value could trigger tile reload. The `feature-state` styling is deprecated and will get removed soon.",
       "requires": [
         "lights"
       ],
@@ -5968,7 +6063,53 @@
         ]
       },
       "property-type": "data-constant"
-   }
+    },
+    "fill-extrusion-line-width": {
+      "type": "number",
+      "default": 0,
+      "minimum": 0,
+      "transition": true,
+      "experimental": true,
+      "units": "meters",
+      "doc": "If a non-zero value is provided, it sets the fill-extrusion layer into wall rendering mode. The value is used to render the feature with the given width over the outlines of the geometry. Note: This property is experimental and some other fill-extrusion properties might not be supported with non-zero line width.",
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.7.0",
+          "android": "11.7.0",
+          "ios": "11.7.0"
+
+        },
+        "data-driven styling": {
+          "js": "3.7.0",
+          "android": "11.7.0",
+          "ios": "11.7.0"
+        }
+      },
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "feature",
+          "feature-state",
+          "measure-light"
+        ]
+      },
+      "property-type": "data-driven"
+    },
+    "fill-extrusion-cast-shadows": {
+      "type": "boolean",
+      "default": true,
+      "doc": "Enable/Disable shadow casting for this layer",
+      "transition": false,
+      "sdk-support": {
+          "basic functionality": {
+          "js": "3.7.0",
+          "android": "11.8.0",
+          "ios": "11.8.0"
+        }
+      },
+      "property-type": "data-constant"
+    }
   },
   "paint_line": {
     "line-opacity": {
@@ -6493,7 +6634,6 @@
       "default": 0,
       "minimum": 0,
       "maximum": 1,
-      "experimental": true,
       "doc": "Opacity multiplier (multiplies line-opacity value) of the line part that is occluded by 3D objects. Value 0 hides occluded part, value 1 means the same opacity as non-occluded part. The property is not supported when `line-opacity` has data-driven styling.",
       "sdk-support": {
         "basic functionality": {
@@ -7034,11 +7174,11 @@
       "property-type": "data-driven"
     },
     "icon-occlusion-opacity": {
-      "doc": "The opacity at which the icon will be drawn in case of being depth occluded. Not supported on globe zoom levels. Absent value means behavior prior to this property introduction.",
+      "doc": "The opacity at which the icon will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only.",
       "type": "number",
       "minimum": 0,
       "maximum": 1,
-      "default": 1,
+      "default": 0,
       "transition": true,
       "requires": [
         "icon-image"
@@ -7384,10 +7524,10 @@
     },
     "text-occlusion-opacity": {
       "type": "number",
-      "doc": "The opacity at which the text will be drawn in case of being depth occluded. Not supported on globe zoom levels. Absent value means behavior prior to this property introduction.",
+      "doc": "The opacity at which the text will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only.",
       "minimum": 0,
       "maximum": 1,
-      "default": 1,
+      "default": 0,
       "transition": true,
       "requires": [
         "text-field"
@@ -7679,6 +7819,62 @@
         "interpolated": false
       },
       "property-type": "data-constant"
+    },
+    "symbol-z-offset": {
+      "type": "number",
+      "doc": "Specifies an uniform elevation from the ground, in meters.",
+      "default": 0,
+      "minimum": 0,
+      "transition": true,
+      "experimental": true,
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.7.0",
+          "android": "11.7.0",
+          "ios": "11.7.0"
+        },
+        "data-driven styling": {
+          "js": "3.7.0",
+          "android": "11.7.0",
+          "ios": "11.7.0"
+        }
+      },
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "feature"
+        ]
+      },
+      "property-type": "data-driven"
+    },
+    "symbol-elevation-reference": {
+      "type": "enum",
+      "doc": "Selects the base of symbol-elevation.",
+      "values": {
+        "sea": {
+          "doc": "Elevate symbols relative to the sea level."
+        },
+        "ground": {
+          "doc": "Elevate symbols relative to the ground's height below them."
+        }
+      },
+      "default": "ground",
+      "experimental": true,
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.7.0",
+          "android": "11.7.0",
+          "ios": "11.7.0"
+        }
+      },
+      "expression": {
+        "interpolated": false,
+        "parameters": [
+          "zoom"
+        ]
+      },
+      "property-type": "data-constant"
     }
   },
   "paint_raster": {
@@ -8142,6 +8338,27 @@
         }
       },
       "property-type": "data-constant"
+    },
+    "raster-particle-elevation": {
+      "type": "number",
+      "doc": "Specifies an uniform elevation from the ground, in meters.",
+      "default": 0,
+      "minimum": 0,
+      "transition": true,
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.7.0",
+          "android": "11.7.0",
+          "ios": "11.7.0"
+        }
+      },
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom"
+        ]
+      },
+      "property-type": "data-constant"
     }
   },
   "paint_hillshade": {
@@ -8809,9 +9026,6 @@
       "default": true,
       "doc": "Enable/Disable shadow casting for this layer",
       "transition": false,
-      "expression": {
-        "interpolated": false
-      },
       "sdk-support": {
           "basic functionality": {
           "js": "3.0.0",
@@ -8826,9 +9040,6 @@
       "default": true,
       "doc": "Enable/Disable shadow receiving for this layer",
       "transition": false,
-      "expression": {
-        "interpolated": false
-      },
       "sdk-support": {
           "basic functionality": {
           "js": "3.0.0",

package/rollup.config.js

@@ -1,15 +1,14 @@
-import path from 'path';
 import replace from '@rollup/plugin-replace';
 import resolve from '@rollup/plugin-node-resolve';
 import commonjs from '@rollup/plugin-commonjs';
 import unassert from 'rollup-plugin-unassert';
 import json from '@rollup/plugin-json';
 import esbuild from 'rollup-plugin-esbuild';
+import {fileURLToPath} from 'url';
 
 // Build es modules?
 const esm = 'esm' in process.env;
 
-import {fileURLToPath} from 'url';
 const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
 const config = [{

package/style-spec.ts

@@ -26,8 +26,9 @@ export type StylePropertySpecification = {
     'property-type': ExpressionType,
     expression?: ExpressionSpecification,
     transition?: boolean,
+    overridable?: boolean,
     default?: boolean,
-    tokens: never
+    tokens?: never
 } | {
     type: 'enum',
     'property-type': ExpressionType,
@@ -82,13 +83,11 @@ import ValidationError from './error/validation_error';
 import ParsingError from './error/parsing_error';
 import {StyleExpression, isExpression, createExpression, createPropertyExpression, normalizePropertyExpression, ZoomConstantExpression, ZoomDependentExpression, StylePropertyFunction} from './expression/index';
 import featureFilter, {isExpressionFilter} from './feature_filter/index';
-
 import convertFilter from './feature_filter/convert';
 import Color from './util/color';
 import {createFunction, isFunction} from './function/index';
 import convertFunction from './function/convert';
 import {eachSource, eachLayer, eachProperty} from './visit';
-
 import validate from './validate_style';
 import validateMapboxApiSupported from './validate_mapbox_api_supported';
 

package/types.ts

@@ -1,5 +1,6 @@
 // Generated code; do not edit. Edit build/generate-typed-style-spec.ts instead.
-/* eslint-disable */
+
+import type {UnionToIntersection} from './union-to-intersection';
 
 export type ColorSpecification = string;
 
@@ -71,7 +72,8 @@ export type DataDrivenPropertyValueSpecification<T> =
     | CameraFunctionSpecification<T>
     | SourceFunctionSpecification<T>
     | CompositeFunctionSpecification<T>
-    | ExpressionSpecification;
+    | ExpressionSpecification
+    | (T extends Array<infer U> ? Array<U | ExpressionSpecification> : never);
 
 export type StyleSpecification = {
     "version": 8,
@@ -96,7 +98,11 @@ export type StyleSpecification = {
     "transition"?: TransitionSpecification,
     "projection"?: ProjectionSpecification,
     "layers": Array<LayerSpecification>,
-    "models"?: ModelsSpecification
+    "models"?: ModelsSpecification,
+    /**
+     * @experimental This property is experimental and subject to change in future versions.
+     */
+    "featuresets"?: FeaturesetsSpecification
 }
 
 export type SourcesSpecification = {
@@ -181,6 +187,36 @@ export type OptionSpecification = {
     "metadata"?: unknown
 }
 
+/**
+ * @experimental This is experimental and subject to change in future versions.
+ */
+export type FeaturesetsSpecification = {
+    [_: string]: FeaturesetSpecification
+}
+
+/**
+ * @experimental This is experimental and subject to change in future versions.
+ */
+export type FeaturesetSpecification = {
+    "selectors"?: Array<SelectorSpecification>
+}
+
+/**
+ * @experimental This is experimental and subject to change in future versions.
+ */
+export type SelectorSpecification = {
+    "layer": string,
+    "properties"?: SelectorPropertySpecification,
+    "featureNamespace"?: string
+}
+
+/**
+ * @experimental This is experimental and subject to change in future versions.
+ */
+export type SelectorPropertySpecification = {
+    [_: string]: unknown
+}
+
 export type VectorSourceSpecification = {
     "type": "vector",
     "url"?: string,
@@ -311,7 +347,7 @@ export type DirectionalLightSpecification = {
         "color-transition"?: TransitionSpecification,
         "intensity"?: PropertyValueSpecification<number>,
         "intensity-transition"?: TransitionSpecification,
-        "cast-shadows"?: ExpressionSpecification,
+        "cast-shadows"?: boolean,
         "shadow-intensity"?: PropertyValueSpecification<number>,
         "shadow-intensity-transition"?: TransitionSpecification
     },
@@ -364,7 +400,9 @@ export type FillLayerSpecification = {
         "fill-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">,
         "fill-pattern"?: DataDrivenPropertyValueSpecification<ResolvedImageSpecification>,
         "fill-emissive-strength"?: PropertyValueSpecification<number>,
-        "fill-emissive-strength-transition"?: TransitionSpecification
+        "fill-emissive-strength-transition"?: TransitionSpecification,
+        "fill-z-offset"?: DataDrivenPropertyValueSpecification<number>,
+        "fill-z-offset-transition"?: TransitionSpecification
     }
 }
 
@@ -542,7 +580,13 @@ export type SymbolLayerSpecification = {
         "icon-color-saturation"?: ExpressionSpecification,
         "icon-color-contrast"?: ExpressionSpecification,
         "icon-color-brightness-min"?: ExpressionSpecification,
-        "icon-color-brightness-max"?: ExpressionSpecification
+        "icon-color-brightness-max"?: ExpressionSpecification,
+        "symbol-z-offset"?: DataDrivenPropertyValueSpecification<number>,
+        "symbol-z-offset-transition"?: TransitionSpecification,
+        /**
+         * @experimental This property is experimental and subject to change in future versions.
+         */
+        "symbol-elevation-reference"?: PropertyValueSpecification<"sea" | "ground">
     }
 }
 
@@ -699,7 +743,10 @@ export type FillExtrusionLayerSpecification = {
         "fill-extrusion-rounded-roof"?: PropertyValueSpecification<boolean>,
         "fill-extrusion-cutoff-fade-range"?: ExpressionSpecification,
         "fill-extrusion-emissive-strength"?: PropertyValueSpecification<number>,
-        "fill-extrusion-emissive-strength-transition"?: TransitionSpecification
+        "fill-extrusion-emissive-strength-transition"?: TransitionSpecification,
+        "fill-extrusion-line-width"?: DataDrivenPropertyValueSpecification<number>,
+        "fill-extrusion-line-width-transition"?: TransitionSpecification,
+        "fill-extrusion-cast-shadows"?: boolean
     }
 }
 
@@ -789,7 +836,9 @@ export type RasterParticleLayerSpecification = {
         "raster-particle-speed-factor-transition"?: TransitionSpecification,
         "raster-particle-fade-opacity-factor"?: PropertyValueSpecification<number>,
         "raster-particle-fade-opacity-factor-transition"?: TransitionSpecification,
-        "raster-particle-reset-rate-factor"?: number
+        "raster-particle-reset-rate-factor"?: number,
+        "raster-particle-elevation"?: PropertyValueSpecification<number>,
+        "raster-particle-elevation-transition"?: TransitionSpecification
     }
 }
 
@@ -870,8 +919,8 @@ export type ModelLayerSpecification = {
         "model-color-mix-intensity"?: DataDrivenPropertyValueSpecification<number>,
         "model-color-mix-intensity-transition"?: TransitionSpecification,
         "model-type"?: "common-3d" | "location-indicator",
-        "model-cast-shadows"?: ExpressionSpecification,
-        "model-receive-shadows"?: ExpressionSpecification,
+        "model-cast-shadows"?: boolean,
+        "model-receive-shadows"?: boolean,
         "model-ambient-occlusion-intensity"?: PropertyValueSpecification<number>,
         "model-ambient-occlusion-intensity-transition"?: TransitionSpecification,
         "model-emissive-strength"?: DataDrivenPropertyValueSpecification<number>,
@@ -994,7 +1043,11 @@ export type ClipLayerSpecification = {
         /**
          * @experimental This property is experimental and subject to change in future versions.
          */
-        "clip-layer-types"?: ExpressionSpecification
+        "clip-layer-types"?: ExpressionSpecification,
+        /**
+         * @experimental This property is experimental and subject to change in future versions.
+         */
+        "clip-layer-scope"?: ExpressionSpecification
     },
     "paint"?: never
 }
@@ -1020,6 +1073,10 @@ export type LayerSpecification =
     | SlotLayerSpecification
     | ClipLayerSpecification;
 
+export type LayoutSpecification = UnionToIntersection<NonNullable<LayerSpecification['layout']>>;
+
+export type PaintSpecification = UnionToIntersection<NonNullable<LayerSpecification['paint']>>;
+
 // Aliases for easier migration from @types/mapbox-gl
 
 export type Layer = Pick<
@@ -1118,39 +1175,14 @@ export type SlotLayer = SlotLayerSpecification;
 export type ClipLayer = ClipLayerSpecification;
 
 /**
- * @deprecated
+ * @deprecated Use `LayoutSpecification` instead.
  */
-export type AnyLayout =
-    | FillLayout
-    | LineLayout
-    | SymbolLayout
-    | CircleLayout
-    | HeatmapLayout
-    | FillExtrusionLayout
-    | RasterLayout
-    | RasterParticleLayout
-    | HillshadeLayout
-    | ModelLayout
-    | BackgroundLayout
-    | SkyLayout
-    | ClipLayout;
+export type AnyLayout = LayoutSpecification;
 
 /**
- * @deprecated
+ * @deprecated Use `PaintSpecification` instead.
  */
-export type AnyPaint =
-    | FillPaint
-    | LinePaint
-    | SymbolPaint
-    | CirclePaint
-    | HeatmapPaint
-    | FillExtrusionPaint
-    | RasterPaint
-    | RasterParticlePaint
-    | HillshadePaint
-    | ModelPaint
-    | BackgroundPaint
-    | SkyPaint;
+export type AnyPaint = PaintSpecification;
 
 /**
  * @deprecated Use `ExpressionSpecification` instead.

package/union-to-intersection.ts

@@ -0,0 +1,4 @@
+export type UnionToIntersection<U> =
+    (U extends any ? (k: U) => void : never) extends (k: infer I) => void ?
+    {[K in keyof I]: I[K]} :
+    never;

package/util/color.ts

@@ -1,5 +1,6 @@
 import {parseCSSColor} from 'csscolorparser';
 import {number as lerp} from './interpolate';
+
 import type {LUT} from '../types/lut';
 
 /**

package/util/color_spaces.ts

@@ -1,5 +1,4 @@
 import Color from './color';
-
 import {number as interpolateNumber} from './interpolate';
 
 type LABColor = {

package/util/deep_equal.ts

@@ -3,7 +3,7 @@
  *
  * @private
  */
-function deepEqual(a?: unknown | null, b?: unknown | null): boolean {
+function deepEqual(a?: unknown, b?: unknown): boolean {
     if (Array.isArray(a)) {
         if (!Array.isArray(b) || a.length !== b.length) return false;
         for (let i = 0; i < a.length; i++) {

package/util/geometry_util.ts

@@ -1,7 +1,6 @@
-import type Point from '@mapbox/point-geometry';
 import quickselect from 'quickselect';
 
-type GeoJSONPosition = [number, number] | [number, number, number];
+import type Point from '@mapbox/point-geometry';
 
 // minX, minY, maxX, maxY
 export type BBox = [number, number, number, number];

package/validate/validate.ts

@@ -1,9 +1,7 @@
 import extend from '../util/extend';
-import ValidationError from '../error/validation_error';
 import {unbundle, deepUnbundle} from '../util/unbundle_jsonlint';
 import {isExpression} from '../expression/index';
 import {isFunction} from '../function/index';
-
 import validateImport from './validate_import';
 import validateFunction from './validate_function';
 import validateExpression from './validate_expression';
@@ -25,10 +23,11 @@ import validateString from './validate_string';
 import validateFormatted from './validate_formatted';
 import validateImage from './validate_image';
 import validateProjection from './validate_projection';
+import getType from '../util/get_type';
 
 import type {StyleReference} from '../reference/latest';
 import type {StyleSpecification} from '../types';
-import getType from '../util/get_type';
+import type ValidationError from '../error/validation_error';
 
 const VALIDATORS = {
     '*'() {

package/validate/validate_expression.ts

@@ -1,5 +1,4 @@
 import ValidationError from '../error/validation_error';
-
 import {createExpression, createPropertyExpression} from '../expression/index';
 import {deepUnbundle} from '../util/unbundle_jsonlint';
 import {isStateConstant, isGlobalPropertyConstant, isFeatureConstant} from '../expression/is_constant';