@mapbox/mapbox-gl-style-spec 14.1.0 → 14.2.0-beta.1

package/composite.js

@@ -1,3 +1,4 @@
+// @noflow
 
 export default function (style) {
     const styleIDs = [];

package/dist/index.cjs

@@ -587,12 +587,12 @@
   	},
   	url: {
   		type: "string",
-  		doc: "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<Tileset ID>`."
+  		doc: "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<Tileset ID>`. Required if `tiles` is not provided."
   	},
   	tiles: {
   		type: "array",
   		value: "string",
-  		doc: "An array of one or more tile source URLs, as in the TileJSON spec."
+  		doc: "An array of one or more tile source URLs, as in the TileJSON spec. Required if `url` is not provided."
   	},
   	bounds: {
   		type: "array",
@@ -666,12 +666,12 @@
   	},
   	url: {
   		type: "string",
-  		doc: "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<Tileset ID>`."
+  		doc: "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<Tileset ID>`. Required if `tiles` is not provided."
   	},
   	tiles: {
   		type: "array",
   		value: "string",
-  		doc: "An array of one or more tile source URLs, as in the TileJSON spec."
+  		doc: "An array of one or more tile source URLs, as in the TileJSON spec. Required if `url` is not provided."
   	},
   	bounds: {
   		type: "array",
@@ -747,12 +747,12 @@
   	},
   	url: {
   		type: "string",
-  		doc: "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<Tileset ID>`."
+  		doc: "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<Tileset ID>`. Required if `tiles` is not provided."
   	},
   	tiles: {
   		type: "array",
   		value: "string",
-  		doc: "An array of one or more tile source URLs, as in the TileJSON spec."
+  		doc: "An array of one or more tile source URLs, as in the TileJSON spec. Required if `url` is not provided."
   	},
   	bounds: {
   		type: "array",
@@ -828,12 +828,12 @@
   	},
   	url: {
   		type: "string",
-  		doc: "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<Tileset ID>`."
+  		doc: "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<Tileset ID>`. Required if `tiles` is not provided."
   	},
   	tiles: {
   		type: "array",
   		value: "string",
-  		doc: "An array of one or more tile source URLs, as in the TileJSON spec."
+  		doc: "An array of one or more tile source URLs, as in the TileJSON spec. Required if `url` is not provided."
   	},
   	bounds: {
   		type: "array",
@@ -1186,7 +1186,7 @@
   	},
   	"source-layer": {
   		type: "string",
-  		doc: "Layer to use from a vector tile source. Required for vector tile sources; prohibited for all other source types, including GeoJSON sources."
+  		doc: "Layer to use from a vector tile source. Required for vector and raster-array sources; prohibited for all other source types, including GeoJSON sources."
   	},
   	slot: {
   		type: "string",
@@ -6891,7 +6891,12 @@
   		required: false,
   		"property-type": "data-constant",
   		transition: false,
-  		doc: "Displayed band of raster array source layer",
+  		requires: [
+  			{
+  				source: "raster-array"
+  			}
+  		],
+  		doc: "Displayed band of raster array source layer. Defaults to the first band if not set.",
   		example: "band-name",
   		"sdk-support": {
   			"basic functionality": {
@@ -8305,12 +8310,6 @@
   		},
   		transition: true,
   		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.",
-  		requires: [
-  			"lights",
-  			{
-  				"!": "fill-extrusion-flood-light-intensity"
-  			}
-  		],
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -8334,10 +8333,7 @@
   		transition: true,
   		doc: "Shades area near ground and concave angles between walls where the radius defines only vertical impact. Default value 3.0 corresponds to height of one floor and brings the most plausible results for buildings. This property works only with legacy light. When 3D lights are enabled `fill-extrusion-ambient-occlusion-wall-radius` and `fill-extrusion-ambient-occlusion-ground-radius` are used instead.",
   		requires: [
-  			"fill-extrusion-edge-radius",
-  			{
-  				"!": "fill-extrusion-flood-light-intensity"
-  			}
+  			"fill-extrusion-edge-radius"
   		],
   		"sdk-support": {
   			"basic functionality": {
@@ -8362,10 +8358,7 @@
   		doc: "Shades area near ground and concave angles between walls where the radius defines only vertical impact. Default value 3.0 corresponds to height of one floor and brings the most plausible results for buildings.",
   		requires: [
   			"lights",
-  			"fill-extrusion-edge-radius",
-  			{
-  				"!": "fill-extrusion-flood-light-intensity"
-  			}
+  			"fill-extrusion-edge-radius"
   		],
   		"sdk-support": {
   			"basic functionality": {
@@ -8389,10 +8382,7 @@
   		transition: true,
   		doc: "The extent of the ambient occlusion effect on the ground beneath the extruded buildings in meters.",
   		requires: [
-  			"lights",
-  			{
-  				"!": "fill-extrusion-flood-light-intensity"
-  			}
+  			"lights"
   		],
   		"sdk-support": {
   			"basic functionality": {
@@ -8410,10 +8400,7 @@
   		maximum: 1,
   		doc: "Provides a control to futher fine-tune the look of the ambient occlusion on the ground beneath the extruded buildings. Lower values give the effect a more solid look while higher values make it smoother.",
   		requires: [
-  			"lights",
-  			{
-  				"!": "fill-extrusion-flood-light-intensity"
-  			}
+  			"lights"
   		],
   		transition: true,
   		expression: {
@@ -8436,10 +8423,7 @@
   		"default": "#ffffff",
   		doc: "The color of the flood light effect on the walls of the extruded buildings.",
   		requires: [
-  			"lights",
-  			{
-  				"!": "fill-extrusion-ambient-occlusion-intensity"
-  			}
+  			"lights"
   		],
   		transition: true,
   		expression: {
@@ -8465,10 +8449,7 @@
   		maximum: 1,
   		doc: "The intensity of the flood light color.",
   		requires: [
-  			"lights",
-  			{
-  				"!": "fill-extrusion-ambient-occlusion-intensity"
-  			}
+  			"lights"
   		],
   		transition: true,
   		expression: {
@@ -8494,10 +8475,7 @@
   		minimum: 0,
   		doc: "The extent of the flood light effect on the walls of the extruded buildings in meters.",
   		requires: [
-  			"lights",
-  			{
-  				"!": "fill-extrusion-ambient-occlusion-intensity"
-  			}
+  			"lights"
   		],
   		transition: true,
   		expression: {
@@ -8525,13 +8503,9 @@
   		type: "number",
   		units: "meters",
   		"default": 0,
-  		minimum: 0,
   		doc: "The extent of the flood light effect on the ground beneath the extruded buildings in meters.",
   		requires: [
-  			"lights",
-  			{
-  				"!": "fill-extrusion-ambient-occlusion-intensity"
-  			}
+  			"lights"
   		],
   		transition: true,
   		expression: {
@@ -8562,10 +8536,7 @@
   		maximum: 1,
   		doc: "Provides a control to futher fine-tune the look of the flood light on the ground beneath the extruded buildings. Lower values give the effect a more solid look while higher values make it smoother.",
   		requires: [
-  			"lights",
-  			{
-  				"!": "fill-extrusion-ambient-occlusion-intensity"
-  			}
+  			"lights"
   		],
   		transition: true,
   		expression: {
@@ -8631,7 +8602,7 @@
   		"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.",
+  		doc: "This parameter defines the range for the fade-out effect before an automatic content cutoff on pitched map views. Fade out is implemented by scaling down and removing buildings in the fade range in a staggered fashion. Opacity is not changed. 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
@@ -8772,6 +8743,7 @@
       }(passedObj, '', 0);
   }
 
+  //        
   function sortKeysBy(obj, reference) {
       const result = {};
       for (const key in reference) {
@@ -10045,6 +10017,7 @@
       });
   }
 
+  //        
   function eachLayout(layer, callback) {
       for (const k in layer) {
           if (k.indexOf('layout') === 0) {
@@ -11549,8 +11522,6 @@
   var Color$1 = Color;
 
   //      
-  // Flow type declarations for Intl cribbed from
-  // https://github.com/facebook/flow/issues/1270
   class Collator {
       constructor(caseSensitive, diacriticSensitive, locale) {
           if (caseSensitive)
@@ -12315,7 +12286,7 @@
       'Polygon'
   ];
   class EvaluationContext {
-      constructor(options) {
+      constructor(scope, options) {
           this.globals = null;
           this.feature = null;
           this.featureState = null;
@@ -12325,6 +12296,7 @@
           this.canonical = null;
           this.featureTileCoord = null;
           this.featureDistanceData = null;
+          this.scope = scope;
           this.options = options;
       }
       id() {
@@ -12424,7 +12396,7 @@
               overloadIndex++;
               // Use a fresh context for each attempted signature so that, if
               // we eventually succeed, we haven't polluted `context.errors`.
-              signatureContext = new ParsingContext$1(context.registry, context.path, null, context.scope, undefined, context.options);
+              signatureContext = new ParsingContext$1(context.registry, context.path, null, context.scope, undefined, context._scope, context.options);
               // First parse all the args, potentially coercing to the
               // types expected by this overload.
               const parsedArgs = [];
@@ -14553,13 +14525,14 @@
       // implementations to infer argument types: Expression#parse() need not
       // check that the output type of the parsed expression matches
       // `expectedType`.
-      constructor(registry, path = [], expectedType, scope = new Scope$1(), errors = [], options) {
+      constructor(registry, path = [], expectedType, scope = new Scope$1(), errors = [], _scope, options) {
           this.registry = registry;
           this.path = path;
           this.key = path.map(part => `[${ part }]`).join('');
           this.scope = scope;
           this.errors = errors;
           this.expectedType = expectedType;
+          this._scope = _scope;
           this.options = options;
       }
       /**
@@ -14624,7 +14597,7 @@
                   // parsed/compiled result. Expressions that expect an image should
                   // not be resolved here so we can later get the available images.
                   if (!(parsed instanceof Literal$1) && parsed.type.kind !== 'resolvedImage' && isConstant(parsed)) {
-                      const ec = new EvaluationContext$1(this.options);
+                      const ec = new EvaluationContext$1(this._scope, this.options);
                       try {
                           parsed = new Literal$1(parsed.type, parsed.evaluate(ec));
                       } catch (e) {
@@ -14658,7 +14631,7 @@
       concat(index, expectedType, bindings) {
           const path = typeof index === 'number' ? this.path.concat(index) : this.path;
           const scope = bindings ? this.scope.concat(bindings) : this.scope;
-          return new ParsingContext(this.registry, path, expectedType || null, scope, this.errors, this.options);
+          return new ParsingContext(this.registry, path, expectedType || null, scope, this.errors, this._scope, this.options);
       }
       /**
        * Push a parsing (or type checking) error into the `this.errors`
@@ -16270,16 +16243,28 @@
       }
       return value;
   }
+  const FQIDSeparator = '\x1F';
   function getConfig(ctx, key, scope) {
-      if (scope.length) {
-          key += `\u{1f}${ scope }`;
-      }
+      // Create a fully qualified key from the requested scope
+      // and the scope from the current evaluation context
+      key = [
+          key,
+          scope,
+          ctx.scope
+      ].filter(Boolean).join(FQIDSeparator);
       const config = ctx.getConfig(key);
       if (!config)
           return null;
       const {type, value, values, minValue, maxValue, stepValue} = config;
       const defaultValue = config.default.evaluate(ctx);
-      let result = value ? value.evaluate(ctx) : defaultValue;
+      let result = defaultValue;
+      if (value) {
+          // temporarily override scope to parent to evaluate config expressions passed from the parent
+          const originalScope = ctx.scope;
+          ctx.scope = (originalScope || '').split(FQIDSeparator).slice(1).join(FQIDSeparator);
+          result = value.evaluate(ctx);
+          ctx.scope = originalScope;
+      }
       if (type)
           result = coerceValue(type, result);
       if (value !== undefined && result !== undefined && values && !values.includes(result)) {
@@ -16418,7 +16403,7 @@
           overloads: [
               [
                   [StringType],
-                  (ctx, [key]) => getConfig(ctx, key.evaluate(ctx), '')
+                  (ctx, [key]) => getConfig(ctx, key.evaluate(ctx))
               ],
               [
                   [
@@ -16945,6 +16930,7 @@
       return !!spec.expression && spec.expression.interpolated;
   }
 
+  //        
   function isFunction(value) {
       return typeof value === 'object' && value !== null && !Array.isArray(value);
   }
@@ -17192,10 +17178,10 @@
   }
 
   class StyleExpression {
-      constructor(expression, propertySpec, options) {
+      constructor(expression, propertySpec, scope, options) {
           this.expression = expression;
           this._warningHistory = {};
-          this._evaluator = new EvaluationContext$1(options);
+          this._evaluator = new EvaluationContext$1(scope, options);
           this._defaultValue = propertySpec ? getDefaultValue(propertySpec) : null;
           this._enumValues = propertySpec && propertySpec.type === 'enum' ? propertySpec.values : null;
       }
@@ -17252,14 +17238,14 @@
    *
    * @private
    */
-  function createExpression(expression, propertySpec, options) {
-      const parser = new ParsingContext$1(definitions, [], propertySpec ? getExpectedType(propertySpec) : undefined, undefined, undefined, options);
+  function createExpression(expression, propertySpec, scope, options) {
+      const parser = new ParsingContext$1(definitions, [], propertySpec ? getExpectedType(propertySpec) : undefined, undefined, undefined, scope, options);
       // For string-valued properties, coerce to string at the top level rather than asserting.
       const parsed = parser.parse(expression, undefined, undefined, undefined, propertySpec && propertySpec.type === 'string' ? { typeAnnotation: 'coerce' } : undefined);
       if (!parsed) {
           return error(parser.errors);
       }
-      return success(new StyleExpression(parsed, propertySpec, options));
+      return success(new StyleExpression(parsed, propertySpec, scope, options));
   }
   class ZoomConstantExpression {
       constructor(kind, expression, isLightConstant) {
@@ -17300,8 +17286,8 @@
           }
       }
   }
-  function createPropertyExpression(expression, propertySpec, options) {
-      expression = createExpression(expression, propertySpec, options);
+  function createPropertyExpression(expression, propertySpec, scope, options) {
+      expression = createExpression(expression, propertySpec, scope, options);
       if (expression.result === 'error') {
           return expression;
       }
@@ -17355,11 +17341,11 @@
           };
       }
   }
-  function normalizePropertyExpression(value, specification, options) {
+  function normalizePropertyExpression(value, specification, scope, options) {
       if (isFunction(value)) {
           return new StylePropertyFunction(value, specification);
       } else if (isExpression(value) || Array.isArray(value) && value.length > 0) {
-          const expression = createPropertyExpression(value, specification, options);
+          const expression = createPropertyExpression(value, specification, scope, options);
           if (expression.result === 'error') {
               // this should have been caught in validation
               throw new Error(expression.value.map(err => `${ err.key }: ${ err.message }`).join(', '));
@@ -18376,6 +18362,7 @@ ${ JSON.stringify(filterExp, null, 2) }
       return style;
   }
 
+  //        
   /**
    * Migrate a Mapbox GL Style to the latest version.
    *
@@ -18405,6 +18392,7 @@ ${ JSON.stringify(filterExp, null, 2) }
       return style;
   }
 
+  //        
   function composite (style) {
       const styleIDs = [];
       const sourceIDs = [];
@@ -19963,7 +19951,7 @@ ${ JSON.stringify(filterExp, null, 2) }
               'raster-dem'
           ].includes(type)) {
           if (!value.url && !value.tiles) {
-              errors.push(new ValidationError(key, value, 'Either "url" or "tiles" is required.'));
+              errors.push(new ValidationWarning(key, value, 'Either "url" or "tiles" is required.'));
           }
       }
       switch (type) {
@@ -21530,6 +21518,7 @@ ${ JSON.stringify(filterExp, null, 2) }
 
   var jsonlint = /*@__PURE__*/getDefaultExportFromCjs(jsonlint$1);
 
+  //        
   function readStyle(style) {
       if (style instanceof String || typeof style === 'string' || style instanceof Buffer) {
           try {