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

package/diff.js

@@ -134,14 +134,24 @@ export const operations: {[_: string]: string} = {
     setProjection: 'setProjection',
 
     /*
-     *  { command: 'addImport', args: [importProperties] }
+     *  { command: 'addImport', args: [import] }
      */
     addImport: 'addImport',
 
     /*
      *  { command: 'removeImport', args: [importId] }
      */
-    removeImport: 'removeImport'
+    removeImport: 'removeImport',
+
+    /*
+     *  { command: 'setImportUrl', args: [importId, styleUrl] }
+     */
+    setImportUrl: 'setImportUrl',
+
+    /*
+     *  { command: 'setImportData', args: [importId, stylesheet] }
+     */
+    setImportData: 'setImportData'
 };
 
 function addSource(sourceId: string, after: Sources, commands: Array<Command>) {
@@ -226,12 +236,12 @@ function diffLayerPropertyChanges(before: any, after: any, commands: Array<Comma
     }
 }
 
-function pluckId(layer: LayerSpecification) {
-    return layer.id;
+function pluckId<T: {id: string}>(item: T): string {
+    return item.id;
 }
 
-function indexById(group: {[string]: LayerSpecification}, layer: LayerSpecification) {
-    group[layer.id] = layer;
+function indexById<T: {id: string}>(group: {[string]: T}, item: T): {[id: string]: T} {
+    group[item.id] = item;
     return group;
 }
 
@@ -345,14 +355,72 @@ 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]});
+export function diffImports(before: Array<ImportSpecification> = [], after: Array<ImportSpecification> = [], commands: Array<Command>) {
+    before = before || [];
+    after = after || [];
+
+    // order imports by id
+    const beforeOrder = before.map(pluckId);
+    const afterOrder = after.map(pluckId);
+
+    // index imports by id
+    const beforeIndex = before.reduce(indexById, {});
+    const afterIndex = after.reduce(indexById, {});
+
+    // track order of imports as if they have been mutated
+    const tracker = beforeOrder.slice();
+
+    let i, d, importId, insertBefore;
+
+    // remove imports
+    for (i = 0, d = 0; i < beforeOrder.length; i++) {
+        importId = beforeOrder[i];
+        if (!afterIndex.hasOwnProperty(importId)) {
+            commands.push({command: operations.removeImport, args: [importId]});
+            tracker.splice(tracker.indexOf(importId, d), 1);
+        } else {
+            // limit where in tracker we need to look for a match
+            d++;
+        }
+    }
+
+    // add/reorder imports
+    for (i = 0, d = 0; i < afterOrder.length; i++) {
+        // work backwards as insert is before an existing import
+        importId = afterOrder[afterOrder.length - 1 - i];
+
+        if (tracker[tracker.length - 1 - i] === importId) continue;
+
+        if (beforeIndex.hasOwnProperty(importId)) {
+            // remove the import before we insert at the correct position
+            commands.push({command: operations.removeImport, args: [importId]});
+            tracker.splice(tracker.lastIndexOf(importId, tracker.length - d), 1);
+        } else {
+            // limit where in tracker we need to look for a match
+            d++;
+        }
+
+        // add import at correct position
+        insertBefore = tracker[tracker.length - i];
+        commands.push({command: operations.addImport, args: [afterIndex[importId], insertBefore]});
+        tracker.splice(tracker.length - i, 0, importId);
     }
 
+    // update imports
     for (const afterImport of after) {
-        commands.push({command: operations.addImport, args: [afterImport]});
+        const beforeImport = beforeIndex[afterImport.id];
+        if (!beforeImport || isEqual(beforeImport, afterImport)) continue;
+
+        if (!isEqual(beforeImport.url, afterImport.url)) {
+            commands.push({command: operations.setImportUrl, args: [afterImport.id, afterImport.url]});
+        }
+
+        const beforeData = beforeImport && beforeImport.data;
+        const afterData = afterImport.data;
+
+        if (!isEqual(beforeData, afterData)) {
+            commands.push({command: operations.setImportData, args: [afterImport.id, afterData]});
+        }
     }
 }
 

package/dist/index.cjs

@@ -5150,7 +5150,10 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		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.",
+  		doc: "Controls the intensity of light emitted on the source features.",
+  		requires: [
+  			"lights"
+  		],
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -5576,7 +5579,10 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		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.",
+  		doc: "Controls the intensity of light emitted on the source features.",
+  		requires: [
+  			"lights"
+  		],
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -5990,7 +5996,10 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		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.",
+  		doc: "Controls the intensity of light emitted on the source features.",
+  		requires: [
+  			"lights"
+  		],
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -6203,7 +6212,10 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		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.",
+  		doc: "Controls the intensity of light emitted on the source features.",
+  		requires: [
+  			"lights"
+  		],
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -6231,7 +6243,10 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		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.",
+  		doc: "Controls the intensity of light emitted on the source features.",
+  		requires: [
+  			"lights"
+  		],
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -7002,7 +7017,7 @@
   		"default": 335,
   		minimum: 0,
   		maximum: 359,
-  		doc: "The direction of the light source used to generate the hillshading with 0 as the top of the viewport if `hillshade-illumination-anchor` is set to `viewport` and due north if `hillshade-illumination-anchor` is set to `map`.",
+  		doc: "The direction of the light source used to generate the hillshading with 0 as the top of the viewport if `hillshade-illumination-anchor` is set to `viewport` and due north if `hillshade-illumination-anchor` is set to `map` and no 3d lights enabled. If `hillshade-illumination-anchor` is set to `map` and 3d lights enabled, the direction from 3d lights is used instead.",
   		transition: false,
   		"sdk-support": {
   			"basic functionality": {
@@ -7237,7 +7252,10 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		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.",
+  		doc: "Controls the intensity of light emitted on the source features.",
+  		requires: [
+  			"lights"
+  		],
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -7544,7 +7562,8 @@
   			interpolated: true,
   			parameters: [
   				"feature",
-  				"feature-state"
+  				"feature-state",
+  				"zoom"
   			]
   		},
   		"sdk-support": {
@@ -7609,7 +7628,8 @@
   			interpolated: true,
   			parameters: [
   				"feature",
-  				"feature-state"
+  				"feature-state",
+  				"zoom"
   			]
   		},
   		"sdk-support": {
@@ -7637,7 +7657,8 @@
   			parameters: [
   				"feature",
   				"feature-state",
-  				"measure-light"
+  				"measure-light",
+  				"zoom"
   			]
   		},
   		"sdk-support": {
@@ -8392,6 +8413,12 @@
   		},
   		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",
@@ -8415,7 +8442,10 @@
   		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 light is enabled `fill-extrusion-ambient-occlusion-wall-radius` and `fill-extrusion-ambient-occlusion-ground-radius` are used instead.",
   		requires: [
-  			"fill-extrusion-edge-radius"
+  			"fill-extrusion-edge-radius",
+  			{
+  				"!": "fill-extrusion-flood-light-intensity"
+  			}
   		],
   		"sdk-support": {
   			"basic functionality": {
@@ -8437,9 +8467,13 @@
   			]
   		},
   		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 3D light, i.e. when `lights` root property is defined.",
+  		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: [
-  			"fill-extrusion-edge-radius"
+  			"lights",
+  			"fill-extrusion-edge-radius",
+  			{
+  				"!": "fill-extrusion-flood-light-intensity"
+  			}
   		],
   		"sdk-support": {
   			"basic functionality": {
@@ -8461,7 +8495,13 @@
   			]
   		},
   		transition: true,
-  		doc: "The extent of the ambient occlusion effect on the ground beneath the extruded buildings in meters. This property works only with 3D light, i.e. when `lights` root property is defined.",
+  		doc: "The extent of the ambient occlusion effect on the ground beneath the extruded buildings in meters.",
+  		requires: [
+  			"lights",
+  			{
+  				"!": "fill-extrusion-flood-light-intensity"
+  			}
+  		],
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -8476,7 +8516,13 @@
   		"default": 0.69,
   		minimum: 0,
   		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. This property works only with 3D light, i.e. when `lights` root property is defined.",
+  		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"
+  			}
+  		],
   		transition: true,
   		expression: {
   			interpolated: true,
@@ -8496,7 +8542,13 @@
   		"property-type": "data-constant",
   		type: "color",
   		"default": "#ffffff",
-  		doc: "The color of the flood light effect on the walls of the extruded buildings. This property works only with 3D light, i.e. when `lights` root property is defined.",
+  		doc: "The color of the flood light effect on the walls of the extruded buildings.",
+  		requires: [
+  			"lights",
+  			{
+  				"!": "fill-extrusion-ambient-occlusion-intensity"
+  			}
+  		],
   		transition: true,
   		expression: {
   			interpolated: true,
@@ -8519,7 +8571,13 @@
   		"default": 0,
   		minimum: 0,
   		maximum: 1,
-  		doc: "The intensity of the flood light color. This property works only with 3D light, i.e. when `lights` root property is defined.",
+  		doc: "The intensity of the flood light color.",
+  		requires: [
+  			"lights",
+  			{
+  				"!": "fill-extrusion-ambient-occlusion-intensity"
+  			}
+  		],
   		transition: true,
   		expression: {
   			interpolated: true,
@@ -8542,7 +8600,13 @@
   		units: "meters",
   		"default": 0,
   		minimum: 0,
-  		doc: "The extent of the flood light effect on the walls of the extruded buildings in meters. This property works only with 3D light, i.e. when `lights` root property is defined.",
+  		doc: "The extent of the flood light effect on the walls of the extruded buildings in meters.",
+  		requires: [
+  			"lights",
+  			{
+  				"!": "fill-extrusion-ambient-occlusion-intensity"
+  			}
+  		],
   		transition: true,
   		expression: {
   			interpolated: true,
@@ -8570,7 +8634,13 @@
   		units: "meters",
   		"default": 0,
   		minimum: 0,
-  		doc: "The extent of the flood light effect on the ground beneath the extruded buildings in meters. This property works only with 3D light, i.e. when `lights` root property is defined.",
+  		doc: "The extent of the flood light effect on the ground beneath the extruded buildings in meters.",
+  		requires: [
+  			"lights",
+  			{
+  				"!": "fill-extrusion-ambient-occlusion-intensity"
+  			}
+  		],
   		transition: true,
   		expression: {
   			interpolated: true,
@@ -8598,7 +8668,13 @@
   		"default": 0.69,
   		minimum: 0,
   		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. This property works only with 3D light, i.e. when `lights` root property is defined.",
+  		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"
+  			}
+  		],
   		transition: true,
   		expression: {
   			interpolated: true,
@@ -18579,13 +18655,21 @@ ${ JSON.stringify(filterExp, null, 2) }
        */
       setProjection: 'setProjection',
       /*
-       *  { command: 'addImport', args: [importProperties] }
+       *  { command: 'addImport', args: [import] }
        */
       addImport: 'addImport',
       /*
        *  { command: 'removeImport', args: [importId] }
        */
-      removeImport: 'removeImport'
+      removeImport: 'removeImport',
+      /*
+       *  { command: 'setImportUrl', args: [importId, styleUrl] }
+       */
+      setImportUrl: 'setImportUrl',
+      /*
+       *  { command: 'setImportData', args: [importId, stylesheet] }
+       */
+      setImportData: 'setImportData'
   };
   function addSource(sourceId, after, commands) {
       commands.push({
@@ -18695,11 +18779,11 @@ ${ JSON.stringify(filterExp, null, 2) }
           }
       }
   }
-  function pluckId(layer) {
-      return layer.id;
+  function pluckId(item) {
+      return item.id;
   }
-  function indexById(group, layer) {
-      group[layer.id] = layer;
+  function indexById(group, item) {
+      group[item.id] = item;
       return group;
   }
   function diffLayers(before, after, commands) {
@@ -18849,18 +18933,84 @@ ${ 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]
-          });
+      before = before || [];
+      after = after || [];
+      // order imports by id
+      const beforeOrder = before.map(pluckId);
+      const afterOrder = after.map(pluckId);
+      // index imports by id
+      const beforeIndex = before.reduce(indexById, {});
+      const afterIndex = after.reduce(indexById, {});
+      // track order of imports as if they have been mutated
+      const tracker = beforeOrder.slice();
+      let i, d, importId, insertBefore;
+      // remove imports
+      for (i = 0, d = 0; i < beforeOrder.length; i++) {
+          importId = beforeOrder[i];
+          if (!afterIndex.hasOwnProperty(importId)) {
+              commands.push({
+                  command: operations.removeImport,
+                  args: [importId]
+              });
+              tracker.splice(tracker.indexOf(importId, d), 1);
+          } else {
+              // limit where in tracker we need to look for a match
+              d++;
+          }
       }
-      for (const afterImport of after) {
+      // add/reorder imports
+      for (i = 0, d = 0; i < afterOrder.length; i++) {
+          // work backwards as insert is before an existing import
+          importId = afterOrder[afterOrder.length - 1 - i];
+          if (tracker[tracker.length - 1 - i] === importId)
+              continue;
+          if (beforeIndex.hasOwnProperty(importId)) {
+              // remove the import before we insert at the correct position
+              commands.push({
+                  command: operations.removeImport,
+                  args: [importId]
+              });
+              tracker.splice(tracker.lastIndexOf(importId, tracker.length - d), 1);
+          } else {
+              // limit where in tracker we need to look for a match
+              d++;
+          }
+          // add import at correct position
+          insertBefore = tracker[tracker.length - i];
           commands.push({
               command: operations.addImport,
-              args: [afterImport]
+              args: [
+                  afterIndex[importId],
+                  insertBefore
+              ]
           });
+          tracker.splice(tracker.length - i, 0, importId);
+      }
+      // update imports
+      for (const afterImport of after) {
+          const beforeImport = beforeIndex[afterImport.id];
+          if (!beforeImport || deepEqual(beforeImport, afterImport))
+              continue;
+          if (!deepEqual(beforeImport.url, afterImport.url)) {
+              commands.push({
+                  command: operations.setImportUrl,
+                  args: [
+                      afterImport.id,
+                      afterImport.url
+                  ]
+              });
+          }
+          const beforeData = beforeImport && beforeImport.data;
+          const afterData = afterImport.data;
+          if (!deepEqual(beforeData, afterData)) {
+              commands.push({
+                  command: operations.setImportData,
+                  args: [
+                      afterImport.id,
+                      afterData
+                  ]
+              });
+          }
       }
   }
   /**
@@ -19040,6 +19190,8 @@ ${ JSON.stringify(filterExp, null, 2) }
           }
       }
   }
+  class ValidationWarning extends ValidationError {
+  }
 
   //      
   // Note: Do not inherit from Error. It breaks when transpiling to ES5.
@@ -19080,7 +19232,7 @@ ${ JSON.stringify(filterExp, null, 2) }
               validateElement = validate;
           }
           if (!validateElement) {
-              errors.push(new ValidationError(key, object[objectKey], `unknown property "${ objectKey }"`));
+              errors.push(new ValidationWarning(key, object[objectKey], `unknown property "${ objectKey }"`));
               continue;
           }
           errors = errors.concat(validateElement({
@@ -19596,7 +19748,7 @@ ${ JSON.stringify(filterExp, null, 2) }
       }
       const valueSpec = options.valueSpec || layerSpec[propertyKey];
       if (!valueSpec) {
-          return [new ValidationError(key, value, `unknown property "${ propertyKey }"`)];
+          return [new ValidationWarning(key, value, `unknown property "${ propertyKey }"`)];
       }
       let tokenMatch;
       if (getType(value) === 'string' && supportsPropertyExpression(valueSpec) && !valueSpec.tokens && (tokenMatch = /^{([^}]+)}$/.exec(value))) {
@@ -19616,8 +19768,8 @@ ${ JSON.stringify(filterExp, null, 2) }
               // Performance related style spec limitation: zoom and light expressions are not allowed for e.g. trees.
               const expression = createPropertyExpression(deepUnbundle(value), valueSpec);
               const expressionObj = expression.value.expression || expression.value._styleExpression.expression;
-              if (expressionObj && (!isGlobalPropertyConstant(expressionObj, ['zoom']) || !isGlobalPropertyConstant(expressionObj, ['measure-light']))) {
-                  errors.push(new ValidationError(key, value, `${ propertyKey } does not support zoom or measure-light expressions when the model layer source is vector tile or GeoJSON.`));
+              if (expressionObj && !isGlobalPropertyConstant(expressionObj, ['measure-light'])) {
+                  errors.push(new ValidationError(key, value, `${ propertyKey } does not support measure-light expressions when the model layer source is vector tile or GeoJSON.`));
               }
           }
       }
@@ -19980,7 +20132,9 @@ ${ JSON.stringify(filterExp, null, 2) }
       }
       const styleSpec = options.styleSpec;
       const lightSpec = styleSpec['light-3d'];
+      const key = options.key;
       const style = options.style;
+      const lights = options.style.lights;
       for (const key of [
               'type',
               'id'
@@ -19990,6 +20144,16 @@ ${ JSON.stringify(filterExp, null, 2) }
               return errors;
           }
       }
+      if (light.type && lights) {
+          for (let i = 0; i < options.arrayIndex; i++) {
+              const lightType = unbundle(light.type);
+              const otherLight = lights[i];
+              if (unbundle(otherLight.type) === lightType) {
+                  // $FlowFixMe[prop-missing] - id.__line__ is added dynamically during the readStyle step
+                  errors.push(new ValidationError(key, light.id, `duplicate light type "${ light.type }", previously defined at line ${ otherLight.id.__line__ }`));
+              }
+          }
+      }
       const lightType = `properties_light_${ light['type'] }`;
       if (!(lightType in styleSpec)) {
           errors = errors.concat([new ValidationError('light-3d', light, `Invalid light type ${ light['type'] }`)]);
@@ -20032,7 +20196,7 @@ ${ JSON.stringify(filterExp, null, 2) }
                       styleSpec
                   }));
               } else {
-                  errors = errors.concat([new ValidationError(key, light[key], `unknown property "${ key }"`)]);
+                  errors = errors.concat([new ValidationWarning(key, light[key], `unknown property "${ key }"`)]);
               }
           }
       }
@@ -20073,7 +20237,7 @@ ${ JSON.stringify(filterExp, null, 2) }
                   styleSpec
               }));
           } else {
-              errors = errors.concat([new ValidationError(key, terrain[key], `unknown property "${ key }"`)]);
+              errors = errors.concat([new ValidationWarning(key, terrain[key], `unknown property "${ key }"`)]);
           }
       }
       if (!terrain.source) {
@@ -20123,7 +20287,7 @@ ${ JSON.stringify(filterExp, null, 2) }
                   styleSpec
               }));
           } else {
-              errors = errors.concat([new ValidationError(key, fog[key], `unknown property "${ key }"`)]);
+              errors = errors.concat([new ValidationWarning(key, fog[key], `unknown property "${ key }"`)]);
           }
       }
       return errors;
@@ -21487,6 +21651,9 @@ ${ JSON.stringify(filterExp, null, 2) }
           }
       };
       validateImports(imports);
+      if (imports.length !== new Set(imports.map(i => i.id)).size) {
+          errors.push(new ValidationError(null, null, 'Duplicate ids of imports'));
+      }
       return {
           errors,
           sourcesCount