@geospatial-sdk/openlayers 0.0.5-dev.48 → 0.0.5-dev.50

package/dist/map/create-map.d.ts

@@ -3,7 +3,7 @@ import Map from "ol/Map.js";
 import View from "ol/View.js";
 import Layer from "ol/layer/Layer.js";
 export declare function createLayer(layerModel: MapContextLayer): Promise<Layer>;
-export declare function updateLayerInMap(map: Map, layerModel: MapContextLayer, layerPosition: number, previousLayer: MapContextLayer): void;
+export declare function updateLayerInMap(map: Map, layerModel: MapContextLayer, layerPosition: number, previousLayerModel: MapContextLayer): void;
 export declare function createView(viewModel: MapContextView | null, map: Map): View;
 /**
  * Create an OpenLayers map from a context; optionally specify a target (root element) for the map

package/dist/map/create-map.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-map.d.ts","sourceRoot":"","sources":["../../lib/map/create-map.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,eAAe,EACf,cAAc,EAEf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,GAAG,MAAM,WAAW,CAAC;AAC5B,OAAO,IAAI,MAAM,YAAY,CAAC;AAC9B,OAAO,KAAK,MAAM,mBAAmB,CAAC;AA6CtC,wBAAsB,WAAW,CAAC,UAAU,EAAE,eAAe,GAAG,OAAO,CAAC,KAAK,CAAC,CAyN7E;AAED,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,GAAG,EACR,UAAU,EAAE,eAAe,EAC3B,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,eAAe,QAgB/B;AAED,wBAAgB,UAAU,CAAC,SAAS,EAAE,cAAc,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,IAAI,CAkC3E;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,UAAU,EACnB,MAAM,CAAC,EAAE,MAAM,GAAG,WAAW,GAC5B,OAAO,CAAC,GAAG,CAAC,CAKd;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CACvC,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,UAAU,GAClB,OAAO,CAAC,GAAG,CAAC,CAQd"}
+{"version":3,"file":"create-map.d.ts","sourceRoot":"","sources":["../../lib/map/create-map.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,eAAe,EACf,cAAc,EAEf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,GAAG,MAAM,WAAW,CAAC;AAC5B,OAAO,IAAI,MAAM,YAAY,CAAC;AAC9B,OAAO,KAAK,MAAM,mBAAmB,CAAC;AAsCtC,wBAAsB,WAAW,CAAC,UAAU,EAAE,eAAe,GAAG,OAAO,CAAC,KAAK,CAAC,CAyN7E;AAED,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,GAAG,EACR,UAAU,EAAE,eAAe,EAC3B,aAAa,EAAE,MAAM,EACrB,kBAAkB,EAAE,eAAe,QAgBpC;AAED,wBAAgB,UAAU,CAAC,SAAS,EAAE,cAAc,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,IAAI,CAkC3E;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,UAAU,EACnB,MAAM,CAAC,EAAE,MAAM,GAAG,WAAW,GAC5B,OAAO,CAAC,GAAG,CAAC,CAKd;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CACvC,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,UAAU,GAClB,OAAO,CAAC,GAAG,CAAC,CAQd"}

package/dist/map/create-map.js

@@ -19,18 +19,9 @@ import { OgcApiEndpoint, WfsEndpoint, WmtsEndpoint, } from "@camptocamp/ogc-clie
 import { MapboxVectorLayer } from "ol-mapbox-style";
 import { handleEndpointError, tileLoadErrorCatchFunction, } from "./handle-errors.js";
 import VectorTile from "ol/source/VectorTile.js";
-import { canDoIncrementalUpdate } from "./layer-update.js";
+import { canDoIncrementalUpdate, updateLayerProperties, } from "./layer-update.js";
 const GEOJSON = new GeoJSON();
 const WFS_MAX_FEATURES = 10000;
-function updateLayerProperties(layerModel, olLayer) {
-    typeof layerModel.visibility !== "undefined" &&
-        olLayer.setVisible(layerModel.visibility);
-    typeof layerModel.opacity !== "undefined" &&
-        olLayer.setOpacity(layerModel.opacity);
-    typeof layerModel.attributions !== "undefined" &&
-        olLayer.getSource()?.setAttributions(layerModel.attributions);
-    olLayer.set("label", layerModel.label);
-}
 export async function createLayer(layerModel) {
     const { type } = layerModel;
     let layer;
@@ -229,12 +220,12 @@ export async function createLayer(layerModel) {
     updateLayerProperties(layerModel, layer);
     return layer;
 }
-export function updateLayerInMap(map, layerModel, layerPosition, previousLayer) {
+export function updateLayerInMap(map, layerModel, layerPosition, previousLayerModel) {
     const layers = map.getLayers();
     const updatedLayer = layers.item(layerPosition);
     // if an incremental update is possible, do it to avoid costly layer recreation
-    if (canDoIncrementalUpdate(previousLayer, layerModel)) {
-        updateLayerProperties(layerModel, updatedLayer);
+    if (canDoIncrementalUpdate(previousLayerModel, layerModel)) {
+        updateLayerProperties(layerModel, updatedLayer, previousLayerModel);
         return;
     }
     // dispose and recreate layer

package/dist/map/layer-update.d.ts

@@ -1,4 +1,5 @@
 import { MapContextLayer } from "@geospatial-sdk/core";
+import Layer from "ol/layer/Layer.js";
 /**
  * Incremental update is possible only if certain properties are changed: opacity,
  * visibility, zIndex, etc.
@@ -10,4 +11,12 @@ import { MapContextLayer } from "@geospatial-sdk/core";
  * @return Returns `true` if the only properties changed are the updatable ones
  */
 export declare function canDoIncrementalUpdate(oldLayer: MapContextLayer, newLayer: MapContextLayer): boolean;
+/**
+ * Will apply generic properties to the layer; if a previous layer model is provided,
+ * only changed properties will be updated (to avoid costly change events in OpenLayers)
+ * @param layerModel
+ * @param olLayer
+ * @param previousLayerModel
+ */
+export declare function updateLayerProperties(layerModel: MapContextLayer, olLayer: Layer, previousLayerModel?: MapContextLayer): void;
 //# sourceMappingURL=layer-update.d.ts.map

package/dist/map/layer-update.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"layer-update.d.ts","sourceRoot":"","sources":["../../lib/map/layer-update.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAahE;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,eAAe,EACzB,QAAQ,EAAE,eAAe,GACxB,OAAO,CAIT"}
+{"version":3,"file":"layer-update.d.ts","sourceRoot":"","sources":["../../lib/map/layer-update.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEhE,OAAO,KAAK,MAAM,mBAAmB,CAAC;AAYtC;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,eAAe,EACzB,QAAQ,EAAE,eAAe,GACxB,OAAO,CAIT;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,eAAe,EAC3B,OAAO,EAAE,KAAK,EACd,kBAAkB,CAAC,EAAE,eAAe,QA6BrC"}

package/dist/map/layer-update.js

@@ -23,3 +23,37 @@ export function canDoIncrementalUpdate(oldLayer, newLayer) {
     const newHash = getHash(newLayer, UPDATABLE_PROPERTIES);
     return oldHash === newHash;
 }
+/**
+ * Will apply generic properties to the layer; if a previous layer model is provided,
+ * only changed properties will be updated (to avoid costly change events in OpenLayers)
+ * @param layerModel
+ * @param olLayer
+ * @param previousLayerModel
+ */
+export function updateLayerProperties(layerModel, olLayer, previousLayerModel) {
+    function shouldApplyProperty(prop) {
+        // if the new layer model does not define that property, skip it
+        // (setting or resetting it to a default value would be counter-intuitive)
+        if (!(prop in layerModel) || typeof layerModel[prop] === "undefined")
+            return false;
+        // if a previous model is provided and the value did not change in the new layer model, skip it
+        if (previousLayerModel && layerModel[prop] === previousLayerModel[prop]) {
+            return false;
+        }
+        // any other case: apply the property
+        return true;
+    }
+    if (shouldApplyProperty("visibility")) {
+        olLayer.setVisible(layerModel.visibility);
+    }
+    if (shouldApplyProperty("opacity")) {
+        olLayer.setOpacity(layerModel.opacity);
+    }
+    if (shouldApplyProperty("attributions")) {
+        olLayer.getSource()?.setAttributions(layerModel.attributions);
+    }
+    if (shouldApplyProperty("label")) {
+        olLayer.set("label", layerModel.label);
+    }
+    // TODO: z-index
+}

package/lib/map/create-map.ts

@@ -36,21 +36,14 @@ import {
   tileLoadErrorCatchFunction,
 } from "./handle-errors.js";
 import VectorTile from "ol/source/VectorTile.js";
-import { canDoIncrementalUpdate } from "./layer-update.js";
+import {
+  canDoIncrementalUpdate,
+  updateLayerProperties,
+} from "./layer-update.js";
 
 const GEOJSON = new GeoJSON();
 const WFS_MAX_FEATURES = 10000;
 
-function updateLayerProperties(layerModel: MapContextLayer, olLayer: Layer) {
-  typeof layerModel.visibility !== "undefined" &&
-    olLayer.setVisible(layerModel.visibility);
-  typeof layerModel.opacity !== "undefined" &&
-    olLayer.setOpacity(layerModel.opacity);
-  typeof layerModel.attributions !== "undefined" &&
-    olLayer.getSource()?.setAttributions(layerModel.attributions);
-  olLayer.set("label", layerModel.label);
-}
-
 export async function createLayer(layerModel: MapContextLayer): Promise<Layer> {
   const { type } = layerModel;
   let layer: Layer | undefined;
@@ -274,14 +267,14 @@ export function updateLayerInMap(
   map: Map,
   layerModel: MapContextLayer,
   layerPosition: number,
-  previousLayer: MapContextLayer,
+  previousLayerModel: MapContextLayer,
 ) {
   const layers = map.getLayers();
   const updatedLayer = layers.item(layerPosition) as Layer;
 
   // if an incremental update is possible, do it to avoid costly layer recreation
-  if (canDoIncrementalUpdate(previousLayer, layerModel)) {
-    updateLayerProperties(layerModel, updatedLayer);
+  if (canDoIncrementalUpdate(previousLayerModel, layerModel)) {
+    updateLayerProperties(layerModel, updatedLayer, previousLayerModel);
     return;
   }
 

package/lib/map/layer-update.test.ts

@@ -1,5 +1,12 @@
-import { canDoIncrementalUpdate } from "./layer-update.js";
+import {
+  canDoIncrementalUpdate,
+  updateLayerProperties,
+} from "./layer-update.js";
 import { MapContextLayer } from "@geospatial-sdk/core";
+import Layer from "ol/layer/Layer.js";
+import { Source } from "ol/source.js";
+import { SAMPLE_LAYER1 } from "@geospatial-sdk/core/fixtures/map-context.fixtures.js";
+import VectorSource from "ol/source/Vector.js";
 
 describe("Layer update utils", () => {
   describe("canDoIncrementalUpdate", () => {
@@ -42,4 +49,67 @@ describe("Layer update utils", () => {
       expect(canDoIncrementalUpdate(oldLayer, newLayer)).toBe(false);
     });
   });
+
+  describe("updateLayerProperties", () => {
+    let olLayer: Layer;
+    let olSource: Source;
+
+    beforeEach(() => {
+      olSource = new VectorSource({});
+      olLayer = new Layer({ source: olSource });
+      vi.spyOn(olLayer, "setVisible");
+      vi.spyOn(olLayer, "setOpacity");
+      vi.spyOn(olLayer, "set");
+      vi.spyOn(olSource, "setAttributions");
+    });
+
+    it("applies the properties defined in the layer model", () => {
+      const layerModel = {
+        ...SAMPLE_LAYER1,
+        visibility: false,
+        opacity: 0.7,
+        attributions: "hello world",
+        label: "Test Layer",
+      } as MapContextLayer;
+      updateLayerProperties(layerModel, olLayer);
+      expect(olLayer.setVisible).toHaveBeenCalledWith(false);
+      expect(olLayer.setOpacity).toHaveBeenCalledWith(0.7);
+      expect(olLayer.set).toHaveBeenCalledWith("label", "Test Layer");
+      expect(olSource.setAttributions).toHaveBeenCalledWith("hello world");
+    });
+
+    it("does not apply properties not defined in the layer model", () => {
+      const layerModel = {
+        type: "wms",
+        url: "http://abc.org/wms",
+        name: "myLayer",
+        label: "Test Layer",
+      } as MapContextLayer;
+      updateLayerProperties(layerModel, olLayer);
+      expect(olLayer.setVisible).not.toHaveBeenCalled();
+      expect(olLayer.setOpacity).not.toHaveBeenCalled();
+      expect(olSource.setAttributions).not.toHaveBeenCalled();
+      expect(olLayer.set).toHaveBeenCalledWith("label", "Test Layer");
+    });
+
+    it("applies properties if they have changed compared to the previous model and they are defined in the new model", () => {
+      const layerModel = {
+        ...SAMPLE_LAYER1,
+        opacity: 0.9,
+        attributions: "hello world",
+        label: "Test Layer",
+      } as MapContextLayer;
+      const prevLayerModel = {
+        ...SAMPLE_LAYER1,
+        visibility: true,
+        opacity: 0.7,
+        attributions: "hello world (old)",
+      } as MapContextLayer;
+      updateLayerProperties(layerModel, olLayer, prevLayerModel);
+      expect(olLayer.setVisible).not.toHaveBeenCalled();
+      expect(olLayer.setOpacity).toHaveBeenCalledWith(0.9);
+      expect(olSource.setAttributions).toHaveBeenCalledWith("hello world");
+      expect(olLayer.set).toHaveBeenCalledWith("label", "Test Layer");
+    });
+  });
 });

package/lib/map/layer-update.ts

@@ -1,5 +1,6 @@
 import { getHash, MapContextLayer } from "@geospatial-sdk/core";
 import { MapContextBaseLayer } from "@geospatial-sdk/core/lib/model/map-context.js";
+import Layer from "ol/layer/Layer.js";
 
 const UPDATABLE_PROPERTIES: (keyof MapContextBaseLayer)[] = [
   "opacity",
@@ -29,3 +30,44 @@ export function canDoIncrementalUpdate(
   const newHash = getHash(newLayer, UPDATABLE_PROPERTIES);
   return oldHash === newHash;
 }
+
+/**
+ * Will apply generic properties to the layer; if a previous layer model is provided,
+ * only changed properties will be updated (to avoid costly change events in OpenLayers)
+ * @param layerModel
+ * @param olLayer
+ * @param previousLayerModel
+ */
+export function updateLayerProperties(
+  layerModel: MapContextLayer,
+  olLayer: Layer,
+  previousLayerModel?: MapContextLayer,
+) {
+  function shouldApplyProperty(prop: keyof MapContextBaseLayer): boolean {
+    // if the new layer model does not define that property, skip it
+    // (setting or resetting it to a default value would be counter-intuitive)
+    if (!(prop in layerModel) || typeof layerModel[prop] === "undefined")
+      return false;
+
+    // if a previous model is provided and the value did not change in the new layer model, skip it
+    if (previousLayerModel && layerModel[prop] === previousLayerModel[prop]) {
+      return false;
+    }
+
+    // any other case: apply the property
+    return true;
+  }
+  if (shouldApplyProperty("visibility")) {
+    olLayer.setVisible(layerModel.visibility!);
+  }
+  if (shouldApplyProperty("opacity")) {
+    olLayer.setOpacity(layerModel.opacity!);
+  }
+  if (shouldApplyProperty("attributions")) {
+    olLayer.getSource()?.setAttributions(layerModel.attributions);
+  }
+  if (shouldApplyProperty("label")) {
+    olLayer.set("label", layerModel.label);
+  }
+  // TODO: z-index
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geospatial-sdk/openlayers",
-  "version": "0.0.5-dev.48+a6a661d",
+  "version": "0.0.5-dev.50+c8ee5e3",
   "description": "OpenLayers-related utilities",
   "keywords": [
     "ol",
@@ -37,10 +37,10 @@
     "ol": ">6.x"
   },
   "dependencies": {
-    "@geospatial-sdk/core": "^0.0.5-dev.48+a6a661d",
+    "@geospatial-sdk/core": "^0.0.5-dev.50+c8ee5e3",
     "chroma-js": "^2.4.2",
     "lodash.throttle": "^4.1.1",
     "ol-mapbox-style": "12.4.0"
   },
-  "gitHead": "a6a661d277224d3e0acef7e2df817a3c5b7360e1"
+  "gitHead": "c8ee5e32059a06e056a5723987baf5e2574bf784"
 }