@mapbox/mapbox-gl-style-spec 13.24.0-alpha.2 → 13.24.0-beta.1

package/.eslintrc

@@ -0,0 +1,10 @@
+{
+  "overrides": [
+    {
+      "files": ["rollup.config.js", "test.js"],
+      "rules": {
+        "flowtype/require-valid-file-annotation": "off"
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -1,17 +1,29 @@
-# 13.23.0
+## 13.24.0-beta.1
+### 🐞 Bug fixes
+
+* Fix error on `gl-style-validate` script. ([#11538](https://github.com/mapbox/mapbox-gl-js/pull/11538))
+* Allow the second argument to the `in` expression operator to be an empty string. ([#11547](https://github.com/mapbox/mapbox-gl-js/pull/11547))
+* Fix error on some valid `filter` expressions. ([#11475](https://github.com/mapbox/mapbox-gl-js/pull/11475))
+
+## 13.23.1
+### ✨ Features and improvements
+
+* Improve `coalesce` expressions to return a `ResolvedImage` when images are missing. ([#11371](https://github.com/mapbox/mapbox-gl-js/pull/11371))
+
+## 13.23.0
 
 ### ✨ Features and improvements
 
 * Add a `projection` root property that allows a non-mercator projection to be set as a style's default projection. ([#11124](https://github.com/mapbox/mapbox-gl-js/pull/11124))
 * Add support for using `["pitch"]` and `["distance-from-camera"]` expressions within the `filter` of a symbol layer. ([#10795](https://github.com/mapbox/mapbox-gl-js/pull/10795))
 
-# 13.22.0
+## 13.22.0
 
 ### ✨ Features and improvements
 
 * Added `protected` field to mapbox-api-supported validation. ([#10968](https://github.com/mapbox/mapbox-gl-js/pull/10968))
 
-# 13.21.0
+## 13.21.0
 
 ### ✨ Features and improvements
 * Add support for `text-writing-mode` property when using `symbol-placement: line` text labels. ([#10647](https://github.com/mapbox/mapbox-gl-js/pull/10647))

package/bin/gl-style-composite.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+
+// @flow
+/* eslint-disable no-process-exit */
+
+import fs from 'fs';
+import minimist from 'minimist';
+
+/* eslint import/no-unresolved: [error, { ignore: ['^@mapbox/mapbox-gl-style-spec$'] }] */
+/* $FlowFixMe[cannot-resolve-module] */
+import {format, composite} from '@mapbox/mapbox-gl-style-spec';
+
+const argv = minimist(process.argv.slice(2));
+
+if (argv.help || argv.h || (!argv._.length && process.stdin.isTTY)) {
+    help();
+    process.exit(0);
+}
+
+console.log(format(composite(JSON.parse(fs.readFileSync(argv._[0]).toString()))));
+
+function help() {
+    console.log('usage:');
+    console.log('  gl-style-composite style.json');
+}

package/bin/gl-style-format.js

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+
+// @flow
+/* eslint-disable no-process-exit */
+
+import fs from 'fs';
+import minimist from 'minimist';
+
+/* eslint import/no-unresolved: [error, { ignore: ['^@mapbox/mapbox-gl-style-spec$'] }] */
+/* $FlowFixMe[cannot-resolve-module] */
+import {format} from '@mapbox/mapbox-gl-style-spec';
+
+const argv = minimist(process.argv.slice(2));
+
+if (argv.help || argv.h || (!argv._.length && process.stdin.isTTY)) {
+    help();
+    process.exit(0);
+}
+
+console.log(format(JSON.parse(fs.readFileSync(argv._[0]).toString()), argv.space));
+
+function help() {
+    console.log('usage:');
+    console.log('  gl-style-format source.json > destination.json');
+    console.log('');
+    console.log('options:');
+    console.log('  --space <num>');
+    console.log('     Number of spaces in output (default "2")');
+    console.log('     Pass "0" for minified output.');
+}

package/bin/gl-style-migrate.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+
+// @flow
+/* eslint-disable no-process-exit */
+
+import fs from 'fs';
+import minimist from 'minimist';
+
+/* eslint import/no-unresolved: [error, { ignore: ['^@mapbox/mapbox-gl-style-spec$'] }] */
+/* $FlowFixMe[cannot-resolve-module] */
+import {format, migrate} from '@mapbox/mapbox-gl-style-spec';
+
+const argv = minimist(process.argv.slice(2));
+
+if (argv.help || argv.h || (!argv._.length && process.stdin.isTTY)) {
+    help();
+    process.exit(0);
+}
+
+console.log(format(migrate(JSON.parse(fs.readFileSync(argv._[0]).toString()))));
+
+function help() {
+    console.log('usage:');
+    console.log('  gl-style-migrate source.json > destination.json');
+}

package/bin/{gl-style-validate → gl-style-validate.js}

@@ -1,25 +1,32 @@
 #!/usr/bin/env node
 
+// @flow
+/* eslint-disable no-process-exit */
 
-var argv = require('minimist')(process.argv.slice(2), {
-        boolean: 'json',
-        boolean: 'mapbox-api-supported'
-    }),
-    validate = require('../').validate,
-    validateMapboxApiSupported = require('../').validateMapboxApiSupported
-    rw = require('rw'),
-    status = 0;
+import rw from 'rw';
+import minimist from 'minimist';
+
+/* eslint import/no-unresolved: [error, { ignore: ['^@mapbox/mapbox-gl-style-spec$'] }] */
+/* $FlowFixMe[cannot-resolve-module] */
+import {validate, validateMapboxApiSupported} from '@mapbox/mapbox-gl-style-spec';
+
+const argv = minimist(process.argv.slice(2), {
+    boolean: ['json', 'mapbox-api-supported'],
+});
+
+let status = 0;
 
 if (argv.help || argv.h || (!argv._.length && process.stdin.isTTY)) {
-    return help();
+    help();
+    process.exit(status);
 }
 
 if (!argv._.length) {
     argv._.push('/dev/stdin');
 }
 
-argv._.forEach(function(file) {
-    var errors;
+argv._.forEach((file) => {
+    let errors = [];
     if (argv['mapbox-api-supported']) {
         errors = validateMapboxApiSupported(rw.readFileSync(file, 'utf8'));
     } else {
@@ -29,7 +36,7 @@ argv._.forEach(function(file) {
         if (argv.json) {
             process.stdout.write(JSON.stringify(errors, null, 2));
         } else {
-            errors.forEach(function (e) {
+            errors.forEach((e) => {
                 console.log('%s:%d: %s', file, e.line, e.message);
             });
         }

package/deref.js

@@ -1,7 +1,10 @@
+// @flow
 
 import refProperties from './util/ref_properties.js';
 
-function deref(layer, parent) {
+import type {LayerSpecification} from './types.js';
+
+function deref(layer: LayerSpecification, parent: LayerSpecification): LayerSpecification {
     const result = {};
 
     for (const k in layer) {
@@ -12,15 +15,13 @@ function deref(layer, parent) {
 
     refProperties.forEach((k) => {
         if (k in parent) {
-            result[k] = parent[k];
+            result[k] = (parent: any)[k];
         }
     });
 
-    return result;
+    return ((result: any): LayerSpecification);
 }
 
-export default derefLayers;
-
 /**
  * Given an array of layers, some of which may contain `ref` properties
  * whose value is the `id` of another property, return a new array where
@@ -34,7 +35,7 @@ export default derefLayers;
  * @param {Array<Layer>} layers
  * @returns {Array<Layer>}
  */
-function derefLayers(layers) {
+export default function derefLayers(layers: Array<LayerSpecification>): Array<LayerSpecification> {
     layers = layers.slice();
 
     const map = Object.create(null);
@@ -44,7 +45,7 @@ function derefLayers(layers) {
 
     for (let i = 0; i < layers.length; i++) {
         if ('ref' in layers[i]) {
-            layers[i] = deref(layers[i], map[layers[i].ref]);
+            layers[i] = deref(layers[i], map[(layers[i]: any).ref]);
         }
     }
 

package/diff.js

@@ -1,7 +1,15 @@
+// @flow
 
 import isEqual from './util/deep_equal.js';
 
-const operations = {
+import type {StyleSpecification} from './types.js';
+
+type Command = {
+    command: string;
+    args: Array<any>;
+};
+
+export const operations: {[_: string]: string} = {
 
     /*
      * { command: 'setStyle', args: [stylesheet] }
@@ -330,7 +338,7 @@ function diffLayers(before, after, commands) {
  * @param {*} after stylesheet to compare to
  * @returns Array list of changes
  */
-function diffStyles(before, after) {
+export default function diffStyles(before: StyleSpecification, after: StyleSpecification): Array<Command> {
     if (!before) return [{command: operations.setStyle, args: [after]}];
 
     let commands = [];
@@ -388,7 +396,7 @@ function diffStyles(before, after) {
         const beforeLayers = [];
         if (before.layers) {
             before.layers.forEach((layer) => {
-                if (sourcesRemoved[layer.source]) {
+                if (layer.source && sourcesRemoved[layer.source]) {
                     commands.push({command: operations.removeLayer, args: [layer.id]});
                 } else {
                     beforeLayers.push(layer);
@@ -424,6 +432,3 @@ function diffStyles(before, after) {
 
     return commands;
 }
-
-export default diffStyles;
-export {operations};

package/dist/index.cjs

@@ -101,7 +101,7 @@
   	},
   	projection: {
   		type: "projection",
-  		doc: "The projection the map should be rendered in. Supported projections are Albers, Equal Earth, Equirectangular (WGS84), Lambert conformal conic, Mercator, Natural Earth, Globe, and Winkel Tripel. Terrain, fog, sky and CustomLayerInterface are not supported for projections other than mercator.",
+  		doc: "The projection the map should be rendered in. Supported projections are Albers, Equal Earth, Equirectangular (WGS84), Lambert conformal conic, Mercator, Natural Earth, and Winkel Tripel. Terrain, fog, sky and CustomLayerInterface are not supported for projections other than mercator.",
   		example: {
   			name: "albers",
   			center: [
@@ -3922,9 +3922,6 @@
   			},
   			winkelTripel: {
   				doc: "A Winkel Tripel projection."
-  			},
-  			globe: {
-  				doc: "A globe projection."
   			}
   		},
   		"default": "mercator",
@@ -9278,7 +9275,7 @@
           this.featureDistanceData = null;
       }
       id() {
-          return this.feature && 'id' in this.feature ? this.feature.id : null;
+          return this.feature && 'id' in this.feature && this.feature.id ? this.feature.id : null;
       }
       geometryType() {
           return this.feature ? typeof this.feature.type === 'number' ? geometryTypes[this.feature.type] : this.feature.type : null;
@@ -9631,6 +9628,8 @@
           canonical.y * EXTENT
       ];
       const tilePoints = [];
+      if (!geometry)
+          return tilePoints;
       for (const points of geometry) {
           for (const point of points) {
               const p = [
@@ -9650,6 +9649,8 @@
           canonical.y * EXTENT
       ];
       const tileLines = [];
+      if (!geometry)
+          return tileLines;
       for (const line of geometry) {
           const tileLine = [];
           for (const point of line) {
@@ -9686,6 +9687,9 @@
           -Infinity
       ];
       const canonical = ctx.canonicalID();
+      if (!canonical) {
+          return false;
+      }
       if (polygonGeometry.type === 'Polygon') {
           const tilePolygon = getTilePolygon(polygonGeometry.coordinates, polyBBox, canonical);
           const tilePoints = getTilePoints(ctx.geometry(), pointBBox, polyBBox, canonical);
@@ -9722,6 +9726,9 @@
           -Infinity
       ];
       const canonical = ctx.canonicalID();
+      if (!canonical) {
+          return false;
+      }
       if (polygonGeometry.type === 'Polygon') {
           const tilePolygon = getTilePolygon(polygonGeometry.coordinates, polyBBox, canonical);
           const tileLines = getTileLines(ctx.geometry(), lineBBox, polyBBox, canonical);
@@ -10526,17 +10533,17 @@
       evaluate(ctx) {
           let result = null;
           let argCount = 0;
-          let requestedImageName;
+          let firstImage;
           for (const arg of this.args) {
               argCount++;
               result = arg.evaluate(ctx);
               if (result && result instanceof ResolvedImage && !result.available) {
-                  if (!requestedImageName) {
-                      requestedImageName = result.name;
+                  if (!firstImage) {
+                      firstImage = result;
                   }
                   result = null;
                   if (argCount === this.args.length) {
-                      result = requestedImageName;
+                      return firstImage;
                   }
               }
               if (result !== null)
@@ -10686,7 +10693,7 @@
       evaluate(ctx) {
           const needle = this.needle.evaluate(ctx);
           const haystack = this.haystack.evaluate(ctx);
-          if (!haystack)
+          if (haystack == null)
               return false;
           if (!isValidNativeType(needle, [
                   'boolean',
@@ -12143,7 +12150,7 @@
           this._evaluator.globals = globals;
           this._evaluator.feature = feature;
           this._evaluator.featureState = featureState;
-          this._evaluator.canonical = canonical;
+          this._evaluator.canonical = canonical || null;
           this._evaluator.availableImages = availableImages || null;
           this._evaluator.formattedSection = formattedSection;
           this._evaluator.featureTileCoord = featureTileCoord || null;
@@ -12154,7 +12161,7 @@
           this._evaluator.globals = globals;
           this._evaluator.feature = feature || null;
           this._evaluator.featureState = featureState || null;
-          this._evaluator.canonical = canonical;
+          this._evaluator.canonical = canonical || null;
           this._evaluator.availableImages = availableImages || null;
           this._evaluator.formattedSection = formattedSection || null;
           this._evaluator.featureTileCoord = featureTileCoord || null;
@@ -13619,7 +13626,7 @@ ${ JSON.stringify(filterExp, null, 2) }
           const beforeLayers = [];
           if (before.layers) {
               before.layers.forEach(layer => {
-                  if (sourcesRemoved[layer.source]) {
+                  if (layer.source && sourcesRemoved[layer.source]) {
                       commands.push({
                           command: operations.removeLayer,
                           args: [layer.id]
@@ -13677,16 +13684,6 @@ ${ JSON.stringify(filterExp, null, 2) }
       }
   }
 
-  function validateConstants(options) {
-      const key = options.key;
-      const constants = options.value;
-      if (constants) {
-          return [new ValidationError(key, constants, 'constants have been deprecated as of v8')];
-      } else {
-          return [];
-      }
-  }
-
   function validateObject(options) {
       const key = options.key;
       const object = options.value;
@@ -13711,7 +13708,8 @@ ${ JSON.stringify(filterExp, null, 2) }
               validateElement = elementValidators['*'];
           } else if (elementSpecs['*']) {
               validateElement = validate;
-          } else {
+          }
+          if (!validateElement) {
               errors.push(new ValidationError(key, object[objectKey], `unknown property "${ objectKey }"`));
               continue;
           }
@@ -13756,7 +13754,8 @@ ${ JSON.stringify(filterExp, null, 2) }
           'type': arraySpec.value,
           'values': arraySpec.values,
           'minimum': arraySpec.minimum,
-          'maximum': arraySpec.maximum
+          'maximum': arraySpec.maximum,
+          function: undefined
       };
       if (styleSpec.$version < 7) {
           arrayElementSpec.function = arraySpec.function;
@@ -13893,11 +13892,15 @@ ${ JSON.stringify(filterExp, null, 2) }
               if (value[0].value === undefined) {
                   return [new ValidationError(key, value, 'object stop key must have value')];
               }
-              if (previousStopDomainZoom && previousStopDomainZoom > unbundle(value[0].zoom)) {
+              const nextStopDomainZoom = unbundle(value[0].zoom);
+              if (typeof nextStopDomainZoom !== 'number') {
+                  return [new ValidationError(key, value[0].zoom, 'stop zoom values must be numbers')];
+              }
+              if (previousStopDomainZoom && previousStopDomainZoom > nextStopDomainZoom) {
                   return [new ValidationError(key, value[0].zoom, 'stop zoom values must appear in ascending order')];
               }
-              if (unbundle(value[0].zoom) !== previousStopDomainZoom) {
-                  previousStopDomainZoom = unbundle(value[0].zoom);
+              if (nextStopDomainZoom !== previousStopDomainZoom) {
+                  previousStopDomainZoom = nextStopDomainZoom;
                   previousStopDomainValue = undefined;
                   stopDomainValues = {};
               }
@@ -13941,7 +13944,7 @@ ${ JSON.stringify(filterExp, null, 2) }
           } else if (type !== stopKeyType) {
               return [new ValidationError(options.key, reportValue, `${ type } stop domain type must match previous stop domain type ${ stopKeyType }`)];
           }
-          if (type !== 'number' && type !== 'string' && type !== 'boolean') {
+          if (type !== 'number' && type !== 'string' && type !== 'boolean' && typeof value !== 'number' && typeof value !== 'string' && typeof value !== 'boolean') {
               return [new ValidationError(options.key, reportValue, 'stop domain value must be a number, string, or boolean')];
           }
           if (type !== 'number' && functionType !== 'categorical') {
@@ -13951,10 +13954,10 @@ ${ JSON.stringify(filterExp, null, 2) }
               }
               return [new ValidationError(options.key, reportValue, message)];
           }
-          if (functionType === 'categorical' && type === 'number' && (!isFinite(value) || Math.floor(value) !== value)) {
-              return [new ValidationError(options.key, reportValue, `integer expected, found ${ value }`)];
+          if (functionType === 'categorical' && type === 'number' && (typeof value !== 'number' || !isFinite(value) || Math.floor(value) !== value)) {
+              return [new ValidationError(options.key, reportValue, `integer expected, found ${ String(value) }`)];
           }
-          if (functionType !== 'categorical' && type === 'number' && previousStopDomainValue !== undefined && value < previousStopDomainValue) {
+          if (functionType !== 'categorical' && type === 'number' && typeof value === 'number' && typeof previousStopDomainValue === 'number' && previousStopDomainValue !== undefined && value < previousStopDomainValue) {
               return [new ValidationError(options.key, reportValue, 'stop domain values must appear in ascending order')];
           } else {
               previousStopDomainValue = value;
@@ -14014,8 +14017,10 @@ ${ JSON.stringify(filterExp, null, 2) }
           'pitch',
           'distance-from-center'
       ]);
-      for (const param of options.valueSpec.expression.parameters) {
-          disallowedParameters.delete(param);
+      if (options.valueSpec && options.valueSpec.expression) {
+          for (const param of options.valueSpec.expression.parameters) {
+              disallowedParameters.delete(param);
+          }
       }
       if (disallowedParameters.size === 0) {
           return [];
@@ -14074,10 +14079,10 @@ ${ JSON.stringify(filterExp, null, 2) }
 
   function validateFilter(options) {
       if (isExpressionFilter(deepUnbundle(options.value))) {
-          const layerType = deepUnbundle(options.layerType);
+          const layerType = options.layerType || 'fill';
           return validateExpression(extend({}, options, {
               expressionContext: 'filter',
-              valueSpec: options.styleSpec[`filter_${ layerType || 'fill' }`]
+              valueSpec: options.styleSpec[`filter_${ layerType }`]
           }));
       } else {
           return validateNonExpressionFilter(options);
@@ -14265,7 +14270,8 @@ ${ JSON.stringify(filterExp, null, 2) }
                   parent = layer;
           });
           if (!parent) {
-              errors.push(new ValidationError(key, layer.ref, `ref layer "${ ref }" not found`));
+              if (typeof ref === 'string')
+                  errors.push(new ValidationError(key, layer.ref, `ref layer "${ ref }" not found`));
           } else if (parent.ref) {
               errors.push(new ValidationError(key, layer.ref, 'ref cannot reference another ref layer'));
           } else {
@@ -14321,6 +14327,7 @@ ${ JSON.stringify(filterExp, null, 2) }
                       layer,
                       key: options.key,
                       value: options.value,
+                      valueSpec: {},
                       style: options.style,
                       styleSpec: options.styleSpec,
                       objectElementValidators: {
@@ -14335,6 +14342,7 @@ ${ JSON.stringify(filterExp, null, 2) }
                       layer,
                       key: options.key,
                       value: options.value,
+                      valueSpec: {},
                       style: options.style,
                       styleSpec: options.styleSpec,
                       objectElementValidators: {
@@ -14553,7 +14561,7 @@ ${ JSON.stringify(filterExp, null, 2) }
           if (!source) {
               errors.push(new ValidationError(key, terrain.source, `source "${ terrain.source }" not found`));
           } else if (sourceType !== 'raster-dem') {
-              errors.push(new ValidationError(key, terrain.source, `terrain cannot be used with a source of type ${ sourceType }, it only be used with a "raster-dem" source type`));
+              errors.push(new ValidationError(key, terrain.source, `terrain cannot be used with a source of type ${ String(sourceType) }, it only be used with a "raster-dem" source type`));
           }
       }
       return errors;
@@ -14642,7 +14650,6 @@ ${ JSON.stringify(filterExp, null, 2) }
       'boolean': validateBoolean,
       'number': validateNumber,
       'color': validateColor,
-      'constants': validateConstants,
       'enum': validateEnum,
       'filter': validateFilter,
       'function': validateFunction,
@@ -14688,9 +14695,8 @@ ${ JSON.stringify(filterExp, null, 2) }
       return errors;
   }
 
-  function validateStyleMin(style, styleSpec = v8) {
-      let errors = [];
-      errors = errors.concat(validate({
+  function validateStyle(style, styleSpec = v8) {
+      const errors = validate({
           key: '',
           value: style,
           valueSpec: styleSpec.$root,
@@ -14698,38 +14704,13 @@ ${ JSON.stringify(filterExp, null, 2) }
           style,
           objectElementValidators: {
               glyphs: validateGlyphsURL,
-              '*'() {
-                  return [];
-              }
+              '*': () => []
           }
-      }));
-      if (style.constants) {
-          errors = errors.concat(validateConstants({
-              key: 'constants',
-              value: style.constants,
-              style,
-              styleSpec
-          }));
-      }
+      });
       return sortErrors(errors);
   }
-  validateStyleMin.source = wrapCleanErrors(validateSource);
-  validateStyleMin.light = wrapCleanErrors(validateLight);
-  validateStyleMin.terrain = wrapCleanErrors(validateTerrain);
-  validateStyleMin.fog = wrapCleanErrors(validateFog);
-  validateStyleMin.layer = wrapCleanErrors(validateLayer);
-  validateStyleMin.filter = wrapCleanErrors(validateFilter);
-  validateStyleMin.paintProperty = wrapCleanErrors(validatePaintProperty);
-  validateStyleMin.layoutProperty = wrapCleanErrors(validateLayoutProperty);
   function sortErrors(errors) {
-      return [].concat(errors).sort((a, b) => {
-          return a.line - b.line;
-      });
-  }
-  function wrapCleanErrors(inner) {
-      return function (...args) {
-          return sortErrors(inner.apply(this, args));
-      };
+      return errors.slice().sort((a, b) => a.line && b.line ? a.line - b.line : 0);
   }
 
   /* parser generated by jison 0.4.15 */
@@ -15402,14 +15383,14 @@ ${ JSON.stringify(filterExp, null, 2) }
       return style;
   }
 
-  function validateStyle(style, styleSpec = v8) {
+  function validateStyle$1(style, styleSpec = v8) {
       let s = style;
       try {
           s = readStyle(s);
       } catch (e) {
           return [e];
       }
-      return validateStyleMin(s, styleSpec);
+      return validateStyle(s, styleSpec);
   }
 
   const SUPPORTED_SPEC_VERSION = 8;
@@ -15518,7 +15499,7 @@ ${ JSON.stringify(filterExp, null, 2) }
       } catch (e) {
           return [e];
       }
-      let errors = validateStyleMin(s, v8).concat(getRootErrors(s, Object.keys(v8.$root)));
+      let errors = validateStyle(s, v8).concat(getRootErrors(s, Object.keys(v8.$root)));
       if (s.sources) {
           errors = errors.concat(getSourcesErrors(s.sources));
       }
@@ -15546,8 +15527,6 @@ ${ JSON.stringify(filterExp, null, 2) }
       eachLayer,
       eachProperty
   };
-  validateStyle.parsed = validateStyle;
-  validateStyle.latest = validateStyle;
 
   exports.Color = Color;
   exports.ParsingError = ParsingError$1;
@@ -15563,7 +15542,7 @@ ${ JSON.stringify(filterExp, null, 2) }
   exports.latest = v8;
   exports.migrate = migrate;
   exports.v8 = v8;
-  exports.validate = validateStyle;
+  exports.validate = validateStyle$1;
   exports.validateMapboxApiSupported = validateMapboxApiSupported;
   exports.visit = visit;