@mapbox/mapbox-gl-style-spec 14.4.0-beta.1 → 14.5.0-beta.1

package/reference/v8.json

@@ -109,6 +109,10 @@
       "type": "camera",
       "doc": "Global setting to control additional camera intrinsics parameters, e.g. projection type (perspective / orthographic)."
     },
+    "color-theme": {
+      "type": "colorTheme",
+      "doc": "A global modifier for the colors of the style."
+    },
     "imports": {
       "type": "array",
       "value": "import",
@@ -239,6 +243,10 @@
     "default": {
       "type": "*",
       "doc": "Default configuration value for this option.",
+      "property-type": "data-constant",
+      "expression": {
+        "interpolated": false
+      },
       "required": true
     },
     "type": {
@@ -857,6 +865,7 @@
     }
   },
   "source_raster_array": {
+    "experimental": true,
     "type": {
       "required": true,
       "type": "enum",
@@ -1004,11 +1013,21 @@
     "generateId": {
       "type": "boolean",
       "default": false,
-      "doc": "Whether to generate ids for the geojson features. When enabled, the `feature.id` property will be auto assigned based on its index in the `features` array, over-writing any previous values."
+      "doc": "Whether to generate ids for the GeoJSON features. When enabled, the `feature.id` property will be auto assigned based on its index in the `features` array, over-writing any previous values."
     },
     "promoteId": {
       "type": "promoteId",
       "doc": "A property to use as a feature id (for feature state). Either a property name, or an object of the form `{<sourceLayer>: <propertyName>}`."
+    },
+    "dynamic": {
+      "type": "boolean",
+      "default": false,
+      "doc": "Whether to optimize this source for frequent data updates (e.g. animating features).",
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.4.0"
+        }
+      }
     }
   },
   "source_video": {
@@ -1180,6 +1199,7 @@
           }
         },
         "raster-particle": {
+          "experimental": true,
           "doc": "Particle animation driven by textures such as wind maps.",
           "sdk-support": {
             "basic functionality": {
@@ -1201,6 +1221,7 @@
         },
         "model": {
           "doc": "A 3D model",
+          "experimental": true,
           "sdk-support": {
             "basic functionality": {
               "js": "3.0.0",
@@ -1238,6 +1259,17 @@
               "ios": "11.0.0"
             }
           }
+        },
+        "clip": {
+          "doc": "Layer that removes 3D content from map.",
+          "sdk-support": {
+            "basic functionality": {
+              "js": "3.5.0",
+              "android": "11.5.0",
+              "ios": "11.5.0"
+            },
+            "experimental": true
+          }
         }
       },
       "doc": "Rendering type of this layer.",
@@ -1292,6 +1324,7 @@
     }
   },
   "layout": [
+    "layout_clip",
     "layout_fill",
     "layout_line",
     "layout_circle",
@@ -1426,6 +1459,34 @@
         }]
     }
   },
+  "layout_clip": {
+    "clip-layer-types": {
+      "type": "array",
+      "value": "enum",
+      "values": {
+        "model": {
+          "doc": "If present the clip layer would remove all 3d model layers below it. Currently only instanced models (e.g. trees) are removed."
+        },
+        "symbol": {
+          "doc": "If present the clip layer would remove all symbol layers below it."
+        }
+      },
+      "default": [],
+      "doc": "Layer types that will also be removed if fallen below this clip layer.",
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.5.0",
+          "android": "11.5.0",
+          "ios": "11.5.0"
+        }
+      },
+      "expression": {
+        "interpolated": false
+      },
+      "property-type": "data-constant",
+      "experimental": true
+    }
+  },
   "layout_fill": {
     "fill-sort-key": {
       "type": "number",
@@ -1599,6 +1660,7 @@
     },
     "fill-extrusion-edge-radius": {
       "type": "number",
+      "experimental": true,
       "private": true,
       "default": 0,
       "minimum": 0,
@@ -1773,6 +1835,32 @@
       },
       "property-type": "data-driven"
     },
+    "line-z-offset": {
+      "type": "number",
+      "experimental": true,
+      "doc": "Vertical offset from ground, in meters. Defaults to 0. Not supported for globe projection at the moment.",
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.5.0",
+          "android": "11.5.0",
+          "ios": "11.5.0"
+        },
+        "data-driven styling": {
+          "js": "3.5.0",
+          "android": "11.5.0",
+          "ios": "11.5.0"
+        }
+      },
+      "expression": {
+        "interpolated": false,
+        "parameters": [
+          "zoom",
+          "feature",
+          "line-progress"
+        ]
+      },
+      "property-type": "data-driven"
+    },
     "visibility": {
       "type": "enum",
       "values": {
@@ -4817,6 +4905,17 @@
       "property-type": "data-constant"
     }
   },
+  "colorTheme": {
+    "data": {
+      "type": "string",
+      "doc": "Expects a base64 encoded PNG image which represents a cube strip LUT. The height of the image cannot exceed 32 pixels and the width must be equal to the height squared.",
+      "transition": false,
+      "property-type": "data-constant",
+      "expression": {
+        "interpolated": false
+      }
+    }
+  },
   "light": {
     "anchor": {
       "type": "enum",
@@ -5563,6 +5662,7 @@
     "fill-extrusion-ambient-occlusion-wall-radius": {
       "property-type": "data-constant",
       "type": "number",
+      "experimental": true,
       "default": 3.0,
       "minimum": 0,
       "expression": {
@@ -5588,6 +5688,7 @@
     "fill-extrusion-ambient-occlusion-ground-radius": {
       "property-type": "data-constant",
       "type": "number",
+      "experimental": true,
       "default": 3.0,
       "minimum": 0,
       "expression": {
@@ -5612,6 +5713,7 @@
     "fill-extrusion-ambient-occlusion-ground-attenuation": {
       "property-type": "data-constant",
       "type": "number",
+      "experimental": true,
       "default": 0.69,
       "minimum": 0.0,
       "maximum": 1.0,
@@ -5637,6 +5739,7 @@
     "fill-extrusion-flood-light-color": {
       "property-type": "data-constant",
       "type": "color",
+      "experimental": true,
       "default": "#ffffff",
       "doc": "The color of the flood light effect on the walls of the extruded buildings.",
       "requires": [
@@ -5661,6 +5764,7 @@
     "fill-extrusion-flood-light-intensity": {
       "property-type": "data-constant",
       "type": "number",
+      "experimental": true,
       "default": 0.0,
       "minimum": 0.0,
       "maximum": 1.0,
@@ -5687,6 +5791,7 @@
     "fill-extrusion-flood-light-wall-radius": {
       "property-type": "data-driven",
       "type": "number",
+      "experimental": true,
       "units": "meters",
       "default": 0,
       "minimum": 0,
@@ -5718,6 +5823,7 @@
     "fill-extrusion-flood-light-ground-radius": {
       "property-type": "data-driven",
       "type": "number",
+      "experimental": true,
       "units": "meters",
       "default": 0,
       "doc": "The extent of the flood light effect on the ground beneath the extruded buildings in meters.",
@@ -5748,6 +5854,7 @@
     "fill-extrusion-flood-light-ground-attenuation": {
       "property-type": "data-constant",
       "type": "number",
+      "experimental": true,
       "default": 0.69,
       "minimum": 0.0,
       "maximum": 1.0,
@@ -5773,6 +5880,7 @@
     "fill-extrusion-vertical-scale": {
       "property-type": "data-constant",
       "type": "number",
+      "experimental": true,
       "default": 1.0,
       "minimum": 0.0,
       "doc": "A global multiplier that can be used to scale base, height, AO, and flood light of the fill extrusions.",
@@ -5795,6 +5903,7 @@
       "property-type": "data-constant",
       "type": "boolean",
       "default": true,
+      "experimental": true,
       "doc": "Indicates whether top edges should be rounded when fill-extrusion-edge-radius has a value greater than 0. If false, rounded edges are only applied to the sides. Default is true.",
       "requires": [
         "fill-extrusion-edge-radius"
@@ -6311,6 +6420,29 @@
         ]
       },
       "property-type": "data-driven"
+    },
+    "line-occlusion-opacity": {
+      "type": "number",
+      "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": {
+          "js": "3.5.0",
+          "android": "11.5.0",
+          "ios": "11.5.0"
+        }
+      },
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom"
+        ]
+      },
+      "transition": true,
+      "property-type": "data-constant"
     }
   },
   "paint_circle": {
@@ -6834,6 +6966,39 @@
       },
       "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.",
+      "type": "number",
+      "default": 1.0,
+      "minimum": 0,
+      "maximum": 1,
+      "transition": true,
+      "requires": [
+        "icon-image"
+      ],
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.5.0",
+          "android": "11.5.0",
+          "ios": "11.6.0"
+        },
+        "data-driven styling": {
+          "js": "3.5.0",
+          "android": "11.5.0",
+          "ios": "11.6.0"
+        }
+      },
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "feature",
+          "feature-state",
+          "measure-light"
+        ]
+      },
+      "property-type": "data-driven"
+    },
     "icon-emissive-strength": {
       "type": "number",
       "default": 1,
@@ -7150,6 +7315,39 @@
       },
       "property-type": "data-driven"
     },
+    "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.",
+      "default": 1.0,
+      "minimum": 0,
+      "maximum": 1,
+      "transition": true,
+      "requires": [
+        "text-field"
+      ],
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.5.0",
+          "android": "11.5.0",
+          "ios": "11.6.0"
+        },
+        "data-driven styling": {
+          "js": "3.5.0",
+          "android": "11.5.0",
+          "ios": "11.6.0"
+        }
+      },
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "feature",
+          "feature-state",
+          "measure-light"
+        ]
+      },
+      "property-type": "data-driven"
+    },
     "text-color": {
       "type": "color",
       "doc": "The color with which the text will be drawn.",
@@ -7711,6 +7909,7 @@
     "raster-array-band": {
       "type": "string",
       "required": false,
+      "experimental": true,
       "property-type": "data-constant",
       "transition": false,
       "requires": [
@@ -7734,6 +7933,7 @@
       "default": 0,
       "minimum": 0,
       "transition": true,
+      "experimental": true,
       "sdk-support": {
         "basic functionality": {
           "js": "3.1.0",
@@ -8691,6 +8891,29 @@
         }
       },
       "property-type": "data-constant"
+    },
+    "model-front-cutoff": {
+      "type": "array",
+      "private": true,
+      "value": "number",
+      "property-type": "data-constant",
+      "transition": false,
+      "expression": {
+        "interpolated": true,
+        "parameters": ["zoom"]
+      },
+      "length": 3,
+      "default": [0.0, 0.0, 1.0],
+      "minimum": [0.0, 0.0, 0.0],
+      "maximum": [1.0, 1.0, 1.0],
+      "doc": "An array for configuring the fade-out effect for the front cutoff of content on pitched map views. It contains three values: start, range and final opacity. The start parameter defines the point at which the fade-out effect begins, with smaller values causing the effect to start earlier. The range parameter specifies how long the fade-out effect will last. A value of 0.0 for range makes content disappear immediately without a fade-out effect. The final opacity determines content opacity at the end of the fade-out effect. A value of 1.0 for final opacity means that the cutoff is completely disabled.",
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.5.0",
+          "android": "11.5.0",
+          "ios": "11.5.0"
+        }
+      }
     }
   },
   "transition": {

package/rollup.config.js

@@ -1,12 +1,10 @@
-// @noflow
-
 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 {flow} from '../../build/rollup_plugins.js';
+import esbuild from 'rollup-plugin-esbuild';
 
 // Build es modules?
 const esm = 'esm' in process.env;
@@ -15,7 +13,7 @@ import {fileURLToPath} from 'url';
 const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
 const config = [{
-    input: `${__dirname}/style-spec.js`,
+    input: `${__dirname}style-spec.ts`,
     output: {
         name: 'mapboxGlStyleSpecification',
         file: `${__dirname}/dist/${esm ? 'index.es.js' : 'index.cjs'}`,
@@ -23,34 +21,18 @@ const config = [{
         sourcemap: true
     },
     plugins: [
-        {
-            name: 'dep-checker',
-            resolveId(source, importer) {
-                // Some users reference modules within style-spec package directly, instead of the bundle
-                // This means that files within the style-spec package should NOT import files from the parent mapbox-gl-js tree.
-                // This check will cause the build to fail on CI allowing these issues to be caught.
-                if (importer && !importer.includes('node_modules')) {
-                    const resolvedPath = path.join(importer, source);
-                    const fromRoot = path.relative(__dirname, resolvedPath);
-                    if (fromRoot.length > 2 && fromRoot.slice(0, 2) === '..') {
-                        throw new Error(`Module ${importer} imports ${source} from outside the style-spec package root directory.`);
-                    }
-                }
-
-                return null;
-            }
-        },
         // https://github.com/zaach/jison/issues/351
         replace({
+            preventAssignment: true,
             include: /\/jsonlint-lines-primitives\/lib\/jsonlint.js/,
             delimiters: ['', ''],
             values: {
                 '_token_stack:': ''
             }
         }),
-        flow(),
+        esbuild({tsconfig: `${__dirname}/../../tsconfig.json`}),
         json(),
-        unassert(),
+        unassert({include: ['*.js', '**/*.js', '*.ts', '**/*.ts']}),
         resolve({
             browser: true,
             preferBuiltins: false
@@ -58,4 +40,5 @@ const config = [{
         commonjs()
     ]
 }];
+
 export default config;

package/{style-spec.js → style-spec.ts}

@@ -1,45 +1,43 @@
-// @flow
-
 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'>;
 
 export type ExpressionSpecification = {
     interpolated: boolean,
-    parameters: ExpressionParameters,
-    relaxZoomRestriction: boolean
+    parameters?: ExpressionParameters,
+    relaxZoomRestriction?: boolean
 }
 
 export type StylePropertySpecification = {
     type: 'number',
     'property-type': ExpressionType,
     expression?: ExpressionSpecification,
-    transition: boolean,
+    transition?: boolean,
     default?: number
 } | {
     type: 'string',
     'property-type': ExpressionType,
     expression?: ExpressionSpecification,
-    transition: boolean,
+    transition?: boolean,
     default?: string,
     tokens?: boolean
 } | {
     type: 'boolean',
     'property-type': ExpressionType,
     expression?: ExpressionSpecification,
-    transition: boolean,
+    transition?: boolean,
     default?: boolean
 } | {
     type: 'enum',
     'property-type': ExpressionType,
     expression?: ExpressionSpecification,
-    values: {[_: string]: {}},
-    transition: boolean,
+    values: {[_: string]: unknown},
+    transition?: boolean,
     default?: string
 } | {
     type: 'color',
     'property-type': ExpressionType,
     expression?: ExpressionSpecification,
-    transition: boolean,
+    transition?: boolean,
     default?: string,
     overridable: boolean
 } | {
@@ -48,7 +46,7 @@ export type StylePropertySpecification = {
     'property-type': ExpressionType,
     expression?: ExpressionSpecification,
     length?: number,
-    transition: boolean,
+    transition?: boolean,
     default?: Array<number>
 } | {
     type: 'array',
@@ -56,36 +54,36 @@ export type StylePropertySpecification = {
     'property-type': ExpressionType,
     expression?: ExpressionSpecification,
     length?: number,
-    transition: boolean,
+    transition?: boolean,
     default?: Array<string>
 } | {
     type: 'resolvedImage',
     'property-type': ExpressionType,
     expression?: ExpressionSpecification,
-    transition: boolean,
+    transition?: boolean,
     default?: string
 };
 
 import v8 from './reference/v8.json';
-import latest from './reference/latest.js';
-import format from './format.js';
-import migrate from './migrate.js';
-import composite from './composite.js';
-import derefLayers from './deref.js';
-import diff from './diff.js';
-import ValidationError from './error/validation_error.js';
-import ParsingError from './error/parsing_error.js';
-import {StyleExpression, isExpression, createExpression, createPropertyExpression, normalizePropertyExpression, ZoomConstantExpression, ZoomDependentExpression, StylePropertyFunction} from './expression/index.js';
-import featureFilter, {isExpressionFilter} from './feature_filter/index.js';
+import latest from './reference/latest';
+import format from './format';
+import migrate from './migrate';
+import composite from './composite';
+import derefLayers from './deref';
+import diff from './diff';
+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.js';
-import Color from './util/color.js';
-import {createFunction, isFunction} from './function/index.js';
-import convertFunction from './function/convert.js';
-import {eachSource, eachLayer, eachProperty} from './visit.js';
+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.js';
-import validateMapboxApiSupported from './validate_mapbox_api_supported.js';
+import validate from './validate_style';
+import validateMapboxApiSupported from './validate_mapbox_api_supported';
 
 const expression = {
     StyleExpression,

package/test.js

@@ -1,16 +1,17 @@
 #!/usr/bin/env node
-// @noflow
 /* eslint-disable no-process-exit */
 
 import fs from 'fs';
 import {execSync} from 'child_process';
 import {createRequire} from 'module';
 
+// @ts-expect-error - TS2345 - Argument of type 'Buffer' is not assignable to parameter of type 'string'.
 const packageJson = JSON.parse(fs.readFileSync('./package.json'));
 
-process.on('unhandledRejection', error => {
+process.on('unhandledRejection', (error) => {
     // don't log `error` directly, because errors from child_process.execSync
     // contain an (undocumented) `envPairs` with environment variable values
+    // @ts-expect-error - TS2339 - Property 'message' does not exist on type 'unknown'.
     console.log(error.message || 'unhandledRejection');
     process.exit(1);
 });

package/types/config_options.ts

@@ -0,0 +1,13 @@
+import type {Expression} from '../expression/expression';
+
+export type ConfigOptionValue = {
+  default: Expression;
+  value?: Expression;
+  values?: Array<unknown>;
+  minValue?: number;
+  maxValue?: number;
+  stepValue?: number;
+  type?: 'string' | 'number' | 'boolean' | 'color';
+};
+
+export type ConfigOptions = Map<string, ConfigOptionValue>;

package/types/lut.ts

@@ -0,0 +1,7 @@
+export type LUT = {
+  image: {
+    width: number;
+    height: number;
+    data: Uint8Array;
+  };
+};

package/types/tile_id.ts

@@ -0,0 +1,5 @@
+export type CanonicalTileID = {
+  z: number;
+  x: number;
+  y: number;
+};