@mapbox/mapbox-gl-style-spec 13.28.0 → 14.0.0-beta.2

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/data/extent.js

@@ -0,0 +1,18 @@
+// @flow
+
+/**
+ * The maximum value of a coordinate in the internal tile coordinate system. Coordinates of
+ * all source features normalized to this extent upon load.
+ *
+ * The value is a consequence of the following:
+ *
+ * * Vertex buffer store positions as signed 16 bit integers.
+ * * One bit is lost for signedness to support tile buffers.
+ * * One bit is lost because the line vertex buffer used to pack 1 bit of other data into the int.
+ * * One bit is lost to support features extending past the extent on the right edge of the tile.
+ * * This leaves us with 2^13 = 8192
+ *
+ * @private
+ * @readonly
+ */
+export default 8192;

package/deref.js

@@ -38,7 +38,7 @@ function deref(layer: LayerSpecification, parent: LayerSpecification): LayerSpec
 export default function derefLayers(layers: Array<LayerSpecification>): Array<LayerSpecification> {
     layers = layers.slice();
 
-    const map = Object.create(null);
+    const map: Object = Object.create(null);
     for (let i = 0; i < layers.length; i++) {
         map[layers[i].id] = layers[i];
     }

package/diff.js

@@ -2,7 +2,9 @@
 
 import isEqual from './util/deep_equal.js';
 
-import type {StyleSpecification} from './types.js';
+import type {StyleSpecification, SourceSpecification, LayerSpecification} from './types.js';
+
+type Sources = { [string]: SourceSpecification };
 
 type Command = {
     command: string;
@@ -116,27 +118,37 @@ export const operations: {[_: string]: string} = {
      */
     setFog: 'setFog',
 
+    /*
+     *  { command: 'setCamera', args: [cameraProperties] }
+     */
+    setCamera: 'setCamera',
+
+    /*
+     *  { command: 'setLights', args: [{light-3d},...] }
+     */
+    setLights: 'setLights',
+
     /*
      *  { command: 'setProjection', args: [projectionProperties] }
      */
     setProjection: 'setProjection'
 };
 
-function addSource(sourceId, after, commands) {
+function addSource(sourceId: string, after: Sources, commands: Array<Command>) {
     commands.push({command: operations.addSource, args: [sourceId, after[sourceId]]});
 }
 
-function removeSource(sourceId, commands, sourcesRemoved) {
+function removeSource(sourceId: string, commands: Array<Command>, sourcesRemoved: {[string]: true}) {
     commands.push({command: operations.removeSource, args: [sourceId]});
     sourcesRemoved[sourceId] = true;
 }
 
-function updateSource(sourceId, after, commands, sourcesRemoved) {
+function updateSource(sourceId: string, after: Sources, commands: Array<Command>, sourcesRemoved: {[string]: true}) {
     removeSource(sourceId, commands, sourcesRemoved);
     addSource(sourceId, after, commands);
 }
 
-function canUpdateGeoJSON(before, after, sourceId) {
+function canUpdateGeoJSON(before: Sources, after: Sources, sourceId: string) {
     let prop;
     for (prop in before[sourceId]) {
         if (!before[sourceId].hasOwnProperty(prop)) continue;
@@ -153,7 +165,7 @@ function canUpdateGeoJSON(before, after, sourceId) {
     return true;
 }
 
-function diffSources(before, after, commands, sourcesRemoved) {
+function diffSources(before: Sources, after: Sources, commands: Array<Command>, sourcesRemoved: {[string]: true}) {
     before = before || {};
     after = after || {};
 
@@ -170,11 +182,12 @@ function diffSources(before, after, commands, sourcesRemoved) {
     // look for sources to add/update
     for (sourceId in after) {
         if (!after.hasOwnProperty(sourceId)) continue;
+        const source = after[sourceId];
         if (!before.hasOwnProperty(sourceId)) {
             addSource(sourceId, after, commands);
-        } else if (!isEqual(before[sourceId], after[sourceId])) {
-            if (before[sourceId].type === 'geojson' && after[sourceId].type === 'geojson' && canUpdateGeoJSON(before, after, sourceId)) {
-                commands.push({command: operations.setGeoJSONSourceData, args: [sourceId, after[sourceId].data]});
+        } else if (!isEqual(before[sourceId], source)) {
+            if (before[sourceId].type === 'geojson' && source.type === 'geojson' && canUpdateGeoJSON(before, after, sourceId)) {
+                commands.push({command: operations.setGeoJSONSourceData, args: [sourceId, source.data]});
             } else {
                 // no update command, must remove then add
                 updateSource(sourceId, after, commands, sourcesRemoved);
@@ -183,7 +196,7 @@ function diffSources(before, after, commands, sourcesRemoved) {
     }
 }
 
-function diffLayerPropertyChanges(before, after, commands, layerId, klass, command) {
+function diffLayerPropertyChanges(before: any, after: any, commands: Array<Command>, layerId: string, klass: ?string, command: string) {
     before = before || {};
     after = after || {};
 
@@ -203,15 +216,16 @@ function diffLayerPropertyChanges(before, after, commands, layerId, klass, comma
     }
 }
 
-function pluckId(layer) {
+function pluckId(layer: LayerSpecification) {
     return layer.id;
 }
-function indexById(group, layer) {
+
+function indexById(group: {[string]: LayerSpecification}, layer: LayerSpecification) {
     group[layer.id] = layer;
     return group;
 }
 
-function diffLayers(before, after, commands) {
+function diffLayers(before: Array<LayerSpecification>, after: Array<LayerSpecification>, commands: Array<Command>) {
     before = before || [];
     after = after || [];
 
@@ -227,9 +241,9 @@ function diffLayers(before, after, commands) {
     const tracker = beforeOrder.slice();
 
     // layers that have been added do not need to be diffed
-    const clean = Object.create(null);
+    const clean: Object = Object.create(null);
 
-    let i, d, layerId, beforeLayer, afterLayer, insertBeforeLayerId, prop;
+    let i, d, layerId, beforeLayer: LayerSpecification, afterLayer: LayerSpecification, insertBeforeLayerId, prop;
 
     // remove layers
     for (i = 0, d = 0; i < beforeOrder.length; i++) {
@@ -277,6 +291,7 @@ function diffLayers(before, after, commands) {
 
         // If source, source-layer, or type have changes, then remove the layer
         // and add it back 'from scratch'.
+        // $FlowFixMe[prop-missing] - there is no `source-layer` in background and sky layers
         if (!isEqual(beforeLayer.source, afterLayer.source) || !isEqual(beforeLayer['source-layer'], afterLayer['source-layer']) || !isEqual(beforeLayer.type, afterLayer.type)) {
             commands.push({command: operations.removeLayer, args: [layerId]});
             // we add the layer back at the same position it was already in, so
@@ -378,6 +393,12 @@ export default function diffStyles(before: StyleSpecification, after: StyleSpeci
         if (!isEqual(before.projection, after.projection)) {
             commands.push({command: operations.setProjection, args: [after.projection]});
         }
+        if (!isEqual(before.lights, after.lights)) {
+            commands.push({command: operations.setLights, args: [after.lights]});
+        }
+        if (!isEqual(before.camera, after.camera)) {
+            commands.push({command: operations.setCamera, args: [after.camera]});
+        }
 
         // Handle changes to `sources`
         // If a source is to be removed, we also--before the removeSource