@mapbox/mapbox-gl-style-spec 14.0.0-beta.1 → 14.0.0-beta.3

package/LICENSE.txt

@@ -0,0 +1,47 @@
+Copyright © 2021 - 2023 Mapbox, Inc. All rights reserved.
+
+The software and files in this repository (collectively, "Software") are
+licensed under the Mapbox TOS for use only with the relevant Mapbox product(s)
+listed at www.mapbox.com/pricing. This license allows developers with a
+current active Mapbox account to use and modify the authorized portions of the
+Software as needed for use only with the relevant Mapbox product(s) through
+their Mapbox account in accordance with the Mapbox TOS.  This license
+terminates automatically if a developer no longer has a Mapbox account in good
+standing or breaches the Mapbox TOS. For the license terms, please see the
+Mapbox TOS at https://www.mapbox.com/legal/tos/ which incorporates the Mapbox
+Product Terms at www.mapbox.com/legal/service-terms.  If this Software is a
+SDK, modifications that change or interfere with marked portions of the code
+related to billing, accounting, or data collection are not authorized and the
+SDK sends limited de-identified location and usage data which is used in
+accordance with the Mapbox TOS. [Updated 2023-01]
+
+-------------------------------------------------------------------------------
+
+Contains code from mapbox-gl-js v1.13 and earlier
+
+Version v1.13 of mapbox-gl-js and earlier are licensed under a BSD-3-Clause license
+
+Copyright (c) 2020, Mapbox
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+* Neither the name of Mapbox GL JS nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -57,3 +57,10 @@ Will validate the given style JSON and print errors to stdout. Provide a
 `--json` flag to get JSON output.
 
 To validate that a style can be uploaded to the Mapbox Styles API, use the `--mapbox-api-supported` flag.
+
+## License
+
+This project uses the standard Mapbox license, which is designed to provide flexibility for our customers and a sustained foundation for the development of our technology. Please consult LICENSE.txt for its specific details.
+
+We understand that the Mapbox Style Specification embodied in this module may be useful in a wide variety of projects. If you are interested in using this module in a manner not expressly permitted by its license, please do not hesitate to contact legal@mapbox.com with details of what you have in mind.
+```

package/bin/gl-style-composite.js

@@ -6,9 +6,9 @@
 import fs from 'fs';
 import minimist from 'minimist';
 
-/* eslint import/no-unresolved: [error, { ignore: ['^@mapbox/mapbox-gl-style-spec-private$'] }] */
+/* eslint import/no-unresolved: [error, { ignore: ['^@mapbox/mapbox-gl-style-spec$'] }] */
 /* $FlowFixMe[cannot-resolve-module] */
-import {format, composite} from '@mapbox/mapbox-gl-style-spec-private';
+import {format, composite} from '@mapbox/mapbox-gl-style-spec';
 
 const argv = minimist(process.argv.slice(2));
 

package/bin/gl-style-format.js

@@ -6,9 +6,9 @@
 import fs from 'fs';
 import minimist from 'minimist';
 
-/* eslint import/no-unresolved: [error, { ignore: ['^@mapbox/mapbox-gl-style-spec-private$'] }] */
+/* eslint import/no-unresolved: [error, { ignore: ['^@mapbox/mapbox-gl-style-spec$'] }] */
 /* $FlowFixMe[cannot-resolve-module] */
-import {format} from '@mapbox/mapbox-gl-style-spec-private';
+import {format} from '@mapbox/mapbox-gl-style-spec';
 
 const argv = minimist(process.argv.slice(2));
 

package/bin/gl-style-migrate.js

@@ -6,9 +6,9 @@
 import fs from 'fs';
 import minimist from 'minimist';
 
-/* eslint import/no-unresolved: [error, { ignore: ['^@mapbox/mapbox-gl-style-spec-private$'] }] */
+/* eslint import/no-unresolved: [error, { ignore: ['^@mapbox/mapbox-gl-style-spec$'] }] */
 /* $FlowFixMe[cannot-resolve-module] */
-import {format, migrate} from '@mapbox/mapbox-gl-style-spec-private';
+import {format, migrate} from '@mapbox/mapbox-gl-style-spec';
 
 const argv = minimist(process.argv.slice(2));
 

package/bin/gl-style-validate.js

@@ -6,9 +6,9 @@
 import rw from 'rw';
 import minimist from 'minimist';
 
-/* eslint import/no-unresolved: [error, { ignore: ['^@mapbox/mapbox-gl-style-spec-private$'] }] */
+/* eslint import/no-unresolved: [error, { ignore: ['^@mapbox/mapbox-gl-style-spec$'] }] */
 /* $FlowFixMe[cannot-resolve-module] */
-import {validate, validateMapboxApiSupported} from '@mapbox/mapbox-gl-style-spec-private';
+import {validate, validateMapboxApiSupported} from '@mapbox/mapbox-gl-style-spec';
 
 const argv = minimist(process.argv.slice(2), {
     boolean: ['json', 'mapbox-api-supported'],

package/diff.js

@@ -2,7 +2,7 @@
 
 import isEqual from './util/deep_equal.js';
 
-import type {StyleSpecification, SourceSpecification, LayerSpecification} from './types.js';
+import type {StyleSpecification, ImportSpecification, SourceSpecification, LayerSpecification} from './types.js';
 
 type Sources = { [string]: SourceSpecification };
 
@@ -131,7 +131,17 @@ export const operations: {[_: string]: string} = {
     /*
      *  { command: 'setProjection', args: [projectionProperties] }
      */
-    setProjection: 'setProjection'
+    setProjection: 'setProjection',
+
+    /*
+     *  { command: 'addImport', args: [importProperties] }
+     */
+    addImport: 'addImport',
+
+    /*
+     *  { command: 'removeImport', args: [importId] }
+     */
+    removeImport: 'removeImport'
 };
 
 function addSource(sourceId: string, after: Sources, commands: Array<Command>) {
@@ -335,6 +345,17 @@ function diffLayers(before: Array<LayerSpecification>, after: Array<LayerSpecifi
     }
 }
 
+function diffImports(before: Array<ImportSpecification> = [], after: Array<ImportSpecification> = [], commands: Array<Command>) {
+    // no diff for the imports, must remove then add
+    for (const beforeImport of before) {
+        commands.push({command: operations.removeImport, args: [beforeImport.id]});
+    }
+
+    for (const afterImport of after) {
+        commands.push({command: operations.addImport, args: [afterImport]});
+    }
+}
+
 /**
  * Diff two stylesheet
  *
@@ -445,6 +466,8 @@ export default function diffStyles(before: StyleSpecification, after: StyleSpeci
         // Handle changes to `layers`
         diffLayers(beforeLayers, after.layers, commands);
 
+        // Handle changes to `imports`
+        diffImports(before.imports, after.imports, commands);
     } catch (e) {
         // fall back to setStyle
         console.warn('Unable to compute style diff:', e);

package/dist/index.cjs

@@ -153,6 +153,7 @@
   	glyphs: {
   		type: "string",
   		doc: "A URL template for loading signed-distance-field glyph sets in PBF format. The URL must include `{fontstack}` and `{range}` tokens. This property is required if any layer uses the `text-field` layout property. The URL must be absolute, containing the [scheme, authority and path components](https://en.wikipedia.org/wiki/URL#Syntax).",
+  		"default": "mapbox://fonts/mapbox/{fontstack}/{range}.pbf",
   		example: "mapbox://fonts/mapbox/{fontstack}/{range}.pbf"
   	},
   	transition: {
@@ -290,6 +291,14 @@
   			210,
   			30
   		],
+  		minimum: [
+  			0,
+  			0
+  		],
+  		maximum: [
+  			360,
+  			90
+  		],
   		length: 2,
   		value: "number",
   		"property-type": "data-constant",
@@ -303,7 +312,7 @@
   		doc: "Direction of the light source specified as [a azimuthal angle, p polar angle] where a indicates the azimuthal angle of the light relative to north (in degrees and proceeding clockwise), and p indicates polar angle of the light (from 0°, directly above, to 180°, directly below).",
   		example: [
   			90,
-  			80
+  			40
   		]
   	},
   	color: {
@@ -1726,6 +1735,37 @@
   		},
   		"property-type": "data-constant"
   	},
+  	"symbol-z-elevate": {
+  		type: "boolean",
+  		"default": false,
+  		doc: "Position symbol on buildings (both fill extrusions and models) roof tops. In order to have minimal impact on performance, this is supported only when `fill-extrusion-height` is not zoom-dependent and not edited after initial bucket creation. For fading in buildings when zooming in, fill-extrusion-vertical-scale should be used and symbols would raise with building roofs. Symbols are sorted by elevation, except in case when `viewport-y` sorting or `symbol-sort-key` are applied.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.0.0",
+  				android: "11.0.0",
+  				ios: "11.0.0"
+  			}
+  		},
+  		requires: [
+  			{
+  				"symbol-placement": [
+  					"point"
+  				]
+  			},
+  			{
+  				"symbol-z-order": [
+  					"auto"
+  				]
+  			}
+  		],
+  		expression: {
+  			interpolated: false,
+  			parameters: [
+  				"zoom"
+  			]
+  		},
+  		"property-type": "data-constant"
+  	},
   	"icon-allow-overlap": {
   		type: "boolean",
   		"default": false,
@@ -4567,6 +4607,34 @@
   				ios: "10.6.0"
   			}
   		}
+  	},
+  	"vertical-range": {
+  		type: "array",
+  		"default": [
+  			0,
+  			0
+  		],
+  		minimum: 0,
+  		length: 2,
+  		value: "number",
+  		"property-type": "data-constant",
+  		transition: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		doc: "Specify the vertical range, measured in meters, over which the fog should gradually fade out. When both parameters are set to zero, the fog will be rendered without any vertical constraints.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.0.0",
+  				android: "11.0.0",
+  				ios: "11.0.0"
+  			}
+  		}
   	}
   };
   var camera = {
@@ -5082,7 +5150,7 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		doc: "Emission strength",
+  		doc: "Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when `lights` root property is defined.",
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -5414,7 +5482,28 @@
   	},
   	"line-gradient": {
   		type: "color",
-  		doc: "Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify `\"lineMetrics\": true`.",
+  		doc: "A gradient used to color a line feature at various distances along its length. Defined using a `step` or `interpolate` expression which outputs a color for each corresponding `line-progress` input value. `line-progress` is a percentage of the line feature's total length as measured on the webmercator projected coordinate plane (a `number` between `0` and `1`).  Can only be used with GeoJSON sources that specify `\"lineMetrics\": true`.",
+  		example: [
+  			"interpolate",
+  			[
+  				"linear"
+  			],
+  			[
+  				"line-progress"
+  			],
+  			0,
+  			"blue",
+  			0.1,
+  			"royalblue",
+  			0.3,
+  			"cyan",
+  			0.5,
+  			"lime",
+  			0.7,
+  			"yellow",
+  			1,
+  			"red"
+  		],
   		transition: false,
   		requires: [
   			{
@@ -5487,7 +5576,7 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		doc: "Emission strength",
+  		doc: "Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when `lights` root property is defined.",
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -5901,7 +5990,7 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		doc: "Emission strength",
+  		doc: "Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when `lights` root property is defined.",
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -6114,7 +6203,7 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		doc: "Emission strength",
+  		doc: "Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when `lights` root property is defined.",
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -6142,7 +6231,7 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		doc: "Emission strength",
+  		doc: "Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when `lights` root property is defined.",
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -6684,6 +6773,9 @@
   		value: "number",
   		"property-type": "data-constant",
   		transition: true,
+  		requires: [
+  			"raster-color"
+  		],
   		expression: {
   			interpolated: true,
   			parameters: [
@@ -6715,6 +6807,9 @@
   		value: "number",
   		"property-type": "data-constant",
   		transition: true,
+  		requires: [
+  			"raster-color"
+  		],
   		expression: {
   			interpolated: true,
   			parameters: [
@@ -7116,7 +7211,7 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		doc: "Emission strength",
+  		doc: "Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when `lights` root property is defined.",
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -7731,6 +7826,25 @@
   			}
   		},
   		transition: true
+  	},
+  	"model-cutoff-fade-range": {
+  		type: "number",
+  		"default": 0,
+  		minimum: 0,
+  		maximum: 1,
+  		doc: "This parameter defines the range for the fade-out effect before an automatic content cutoff  on pitched map views. The automatic cutoff range is calculated according to the minimum required zoom level of the source and layer. The fade range is expressed in relation to the height of the map view. A value of 1.0 indicates that the content is faded to the same extent as the map's height in pixels, while a value close to zero represents a sharp cutoff. When the value is set to 0.0, the cutoff is completely disabled. Note: The property has no effect on the map if terrain is enabled.",
+  		transition: false,
+  		expression: {
+  			interpolated: false
+  		},
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.0.0",
+  				android: "11.0.0",
+  				ios: "11.0.0"
+  			}
+  		},
+  		"property-type": "data-constant"
   	}
   };
   var transition = {
@@ -7892,7 +8006,7 @@
   		doc: "Radius of a fill extrusion edge in meters. If not zero, rounds extrusion edges for a smoother appearance.",
   		"sdk-support": {
   			"basic functionality": {
-  				js: "v2.10.0",
+  				js: "3.0.0",
   				android: "10.7.0",
   				ios: "10.7.0"
   			},
@@ -8256,7 +8370,7 @@
   		doc: "Controls the intensity of shading near ground and concave angles between walls. Default value 0.0 disables ambient occlusion and values around 0.3 provide the most plausible results for buildings.",
   		"sdk-support": {
   			"basic functionality": {
-  				js: "2.10.0",
+  				js: "3.0.0",
   				android: "10.7.0",
   				ios: "10.7.0"
   			}
@@ -8281,7 +8395,7 @@
   		],
   		"sdk-support": {
   			"basic functionality": {
-  				js: "2.10.0",
+  				js: "3.0.0",
   				android: "10.7.0",
   				ios: "10.7.0"
   			}
@@ -8508,7 +8622,7 @@
   		transition: false,
   		"sdk-support": {
   			"basic functionality": {
-  				js: "2.15.0",
+  				js: "3.0.0",
   				android: "10.10.0",
   				ios: "10.10.0"
   			}
@@ -8519,6 +8633,25 @@
   				"zoom"
   			]
   		}
+  	},
+  	"fill-extrusion-cutoff-fade-range": {
+  		type: "number",
+  		"default": 0,
+  		minimum: 0,
+  		maximum: 1,
+  		doc: "This parameter defines the range for the fade-out effect before an automatic content cutoff  on pitched map views. The automatic cutoff range is calculated according to the minimum required zoom level of the source and layer. The fade range is expressed in relation to the height of the map view. A value of 1.0 indicates that the content is faded to the same extent as the map's height in pixels, while a value close to zero represents a sharp cutoff. When the value is set to 0.0, the cutoff is completely disabled. Note: The property has no effect on the map if terrain is enabled.",
+  		transition: false,
+  		expression: {
+  			interpolated: false
+  		},
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.0.0",
+  				android: "11.0.0",
+  				ios: "11.0.0"
+  			}
+  		},
+  		"property-type": "data-constant"
   	}
   },
   	paint_line: paint_line,
@@ -18420,7 +18553,15 @@ ${ JSON.stringify(filterExp, null, 2) }
       /*
        *  { command: 'setProjection', args: [projectionProperties] }
        */
-      setProjection: 'setProjection'
+      setProjection: 'setProjection',
+      /*
+       *  { command: 'addImport', args: [importProperties] }
+       */
+      addImport: 'addImport',
+      /*
+       *  { command: 'removeImport', args: [importId] }
+       */
+      removeImport: 'removeImport'
   };
   function addSource(sourceId, after, commands) {
       commands.push({
@@ -18683,6 +18824,21 @@ ${ JSON.stringify(filterExp, null, 2) }
           }
       }
   }
+  function diffImports(before = [], after = [], commands) {
+      // no diff for the imports, must remove then add
+      for (const beforeImport of before) {
+          commands.push({
+              command: operations.removeImport,
+              args: [beforeImport.id]
+          });
+      }
+      for (const afterImport of after) {
+          commands.push({
+              command: operations.addImport,
+              args: [afterImport]
+          });
+      }
+  }
   /**
    * Diff two stylesheet
    *
@@ -18835,6 +18991,8 @@ ${ JSON.stringify(filterExp, null, 2) }
           }
           // Handle changes to `layers`
           diffLayers(beforeLayers, after.layers, commands);
+          // Handle changes to `imports`
+          diffImports(before.imports, after.imports, commands);
       } catch (e) {
           // fall back to setStyle
           console.warn('Unable to compute style diff:', e);
@@ -19423,7 +19581,7 @@ ${ JSON.stringify(filterExp, null, 2) }
       }
       const errors = [];
       if (options.layerType === 'symbol') {
-          if (propertyKey === 'text-field' && style && !style.glyphs) {
+          if (propertyKey === 'text-field' && style && !style.glyphs && !style.imports) {
               errors.push(new ValidationError(key, value, 'use of "text-field" requires a style "glyphs" property'));
           }
           if (propertyKey === 'text-font' && isFunction(deepUnbundle(value)) && unbundle(value.type) === 'identity') {