@geospatial-sdk/core 0.0.5-dev.46 → 0.0.5-dev.48

package/lib/utils/map-context.test.ts

@@ -2,14 +2,12 @@ import { describe } from "vitest";
 import {
   addLayerToContext,
   changeLayerPositionInContext,
-  getLayerHash,
   getLayerPosition,
-  isLayerSame,
-  isLayerSameAndUnchanged,
   removeLayerFromContext,
   replaceLayerInContext,
+  updateLayerInContext,
 } from "./map-context.js";
-import { MapContext } from "../model/index.js";
+import { MapContext, MapContextLayer } from "../model/index.js";
 import {
   SAMPLE_CONTEXT,
   SAMPLE_LAYER1,
@@ -18,307 +16,6 @@ import {
 } from "../../fixtures/map-context.fixtures.js";
 
 describe("Map context utils", () => {
-  describe("isLayerSame", () => {
-    describe("layers with id", () => {
-      it("compares non-strictly by id", () => {
-        expect(
-          isLayerSame(
-            { ...SAMPLE_LAYER1, id: "a" },
-            { ...SAMPLE_LAYER1, id: "b" },
-          ),
-        ).toBe(false);
-        expect(
-          isLayerSame(
-            { ...SAMPLE_LAYER1, id: "ab" },
-            { ...SAMPLE_LAYER2, id: "ab" },
-          ),
-        ).toBe(true);
-        expect(
-          isLayerSame(
-            { ...SAMPLE_LAYER1, id: 1 },
-            { ...SAMPLE_LAYER2, id: "01" },
-          ),
-        ).toBe(true);
-        expect(
-          isLayerSame({ ...SAMPLE_LAYER1, id: 1 }, { ...SAMPLE_LAYER2, id: 1 }),
-        ).toBe(true);
-        expect(
-          isLayerSame({ ...SAMPLE_LAYER1, id: 1 }, { ...SAMPLE_LAYER1, id: 2 }),
-        ).toBe(false);
-      });
-    });
-    describe("layers without id", () => {
-      it("compares by properties", () => {
-        expect(isLayerSame(SAMPLE_LAYER1, SAMPLE_LAYER1)).toBe(true);
-        expect(
-          isLayerSame(SAMPLE_LAYER1, { ...SAMPLE_LAYER1, name: "abc" }),
-        ).toBe(false);
-        expect(
-          isLayerSame(
-            {
-              ...SAMPLE_LAYER1,
-              url: "http://abc.org",
-              name: SAMPLE_LAYER1.name,
-            },
-            { ...SAMPLE_LAYER1, url: "http://abc.org" },
-          ),
-        ).toBe(true);
-        expect(isLayerSame(SAMPLE_LAYER1, SAMPLE_LAYER2)).toBe(false);
-      });
-      it("ignores extras prop", () => {
-        expect(
-          isLayerSame(SAMPLE_LAYER1, {
-            ...SAMPLE_LAYER1,
-            extras: { otherProp: "abc" },
-          }),
-        ).toBe(true);
-        expect(
-          isLayerSame(SAMPLE_LAYER1, {
-            ...SAMPLE_LAYER1,
-            extras: undefined,
-          }),
-        ).toBe(true);
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        const { extras, ...layer } = SAMPLE_LAYER1;
-        expect(isLayerSame(SAMPLE_LAYER1, layer)).toBe(true);
-      });
-    });
-    describe("layers with and without id", () => {
-      it("compares by properties", () => {
-        expect(
-          isLayerSame(SAMPLE_LAYER1, { ...SAMPLE_LAYER1, id: "123" }),
-        ).toBe(false);
-        expect(
-          isLayerSame(
-            { ...SAMPLE_LAYER1, id: "123" },
-            { id: "123", ...SAMPLE_LAYER1, name: SAMPLE_LAYER1.name },
-          ),
-        ).toBe(true);
-      });
-    });
-  });
-
-  describe("isLayerSameAndUnchanged", () => {
-    describe("layers with id and version", () => {
-      it("compares non-strictly by id and version field", () => {
-        expect(
-          isLayerSameAndUnchanged(
-            { ...SAMPLE_LAYER1, id: "ab", version: 2 },
-            { ...SAMPLE_LAYER2, id: "ab", version: 2 },
-          ),
-        ).toBe(true);
-        expect(
-          isLayerSameAndUnchanged(
-            { ...SAMPLE_LAYER1, id: "ab", version: 2 },
-            { ...SAMPLE_LAYER1, id: "ab", version: 1 },
-          ),
-        ).toBe(false);
-        expect(
-          isLayerSameAndUnchanged(
-            { ...SAMPLE_LAYER1, id: 1 },
-            { ...SAMPLE_LAYER1, id: "01", version: 3 },
-          ),
-        ).toBe(false);
-      });
-    });
-    describe("layers with id and both without version", () => {
-      it("compares by properties, including extras", () => {
-        expect(
-          isLayerSameAndUnchanged(
-            { ...SAMPLE_LAYER1, id: "a" },
-            { ...SAMPLE_LAYER1, id: "b" },
-          ),
-        ).toBe(false);
-        expect(
-          isLayerSameAndUnchanged(
-            { ...SAMPLE_LAYER1, id: "a" },
-            { ...SAMPLE_LAYER2, id: "a" },
-          ),
-        ).toBe(false);
-        expect(
-          isLayerSameAndUnchanged(
-            { ...SAMPLE_LAYER1, id: "a" },
-            { ...SAMPLE_LAYER1, id: "a" },
-          ),
-        ).toBe(true);
-        expect(
-          isLayerSameAndUnchanged(
-            { ...SAMPLE_LAYER2, id: "b", extras: { hello: "world" } },
-            { ...SAMPLE_LAYER2, id: "b", extras: { hello: "world" } },
-          ),
-        ).toBe(true);
-        expect(
-          isLayerSameAndUnchanged(
-            { ...SAMPLE_LAYER2, id: "b", extras: { hello: "world" } },
-            { ...SAMPLE_LAYER2, id: "b", extras: { foo: "bar" } },
-          ),
-        ).toBe(false);
-      });
-    });
-    describe("layers without id", () => {
-      it("compares by properties, including extras", () => {
-        expect(isLayerSameAndUnchanged(SAMPLE_LAYER1, SAMPLE_LAYER1)).toBe(
-          true,
-        );
-        expect(
-          isLayerSameAndUnchanged(SAMPLE_LAYER1, {
-            ...SAMPLE_LAYER1,
-            name: "abc",
-          }),
-        ).toBe(false);
-        expect(
-          isLayerSameAndUnchanged(
-            {
-              ...SAMPLE_LAYER1,
-              url: "http://abc.org",
-              name: SAMPLE_LAYER1.name,
-            },
-            { ...SAMPLE_LAYER1, url: "http://abc.org" },
-          ),
-        ).toBe(true);
-        expect(
-          isLayerSameAndUnchanged(
-            {
-              ...SAMPLE_LAYER1,
-              opacity: 1,
-            },
-            SAMPLE_LAYER1,
-          ),
-        ).toBe(false);
-        expect(isLayerSameAndUnchanged(SAMPLE_LAYER1, SAMPLE_LAYER2)).toBe(
-          false,
-        );
-      });
-      it("takes into account extras prop", () => {
-        expect(
-          isLayerSameAndUnchanged(SAMPLE_LAYER1, {
-            ...SAMPLE_LAYER1,
-            extras: { otherProp: "abc" },
-          }),
-        ).toBe(false);
-        expect(
-          isLayerSameAndUnchanged(SAMPLE_LAYER1, {
-            ...SAMPLE_LAYER1,
-            extras: undefined,
-          }),
-        ).toBe(false);
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        const { extras, ...layer } = SAMPLE_LAYER1;
-        expect(isLayerSameAndUnchanged(SAMPLE_LAYER1, layer)).toBe(false);
-      });
-    });
-    describe("layers with and without id", () => {
-      it("compares by properties", () => {
-        expect(
-          isLayerSameAndUnchanged(SAMPLE_LAYER1, {
-            ...SAMPLE_LAYER1,
-            id: "123",
-          }),
-        ).toBe(false);
-        expect(
-          isLayerSameAndUnchanged(
-            { ...SAMPLE_LAYER1, id: "123" },
-            { id: "123", ...SAMPLE_LAYER1, name: SAMPLE_LAYER1.name },
-          ),
-        ).toBe(true);
-      });
-    });
-  });
-
-  describe("getLayerHash", () => {
-    it("works with serializable entities", () => {
-      expect(
-        getLayerHash({
-          ...SAMPLE_LAYER1,
-          extras: {
-            array: [11, 22, null, undefined],
-            object: {},
-            undef: undefined,
-          },
-        }),
-      ).toBeTypeOf("string");
-    });
-    it("ignores extra property by default", () => {
-      expect(
-        getLayerHash({
-          ...SAMPLE_LAYER1,
-          extras: {
-            array: [11, 22, null, undefined],
-            object: {},
-          },
-        }),
-      ).toEqual(
-        getLayerHash({
-          ...SAMPLE_LAYER1,
-          extras: { hello: "world" },
-        }),
-      );
-    });
-    it("works with non-serializable entities (but they are ignored)", () => {
-      const hash = getLayerHash(
-        {
-          ...SAMPLE_LAYER1,
-          extras: {
-            func: () => 123,
-            canvas: document.createElement("canvas"),
-          },
-        },
-        true,
-      );
-      expect(hash).toBeTypeOf("string");
-      expect(hash).toEqual(
-        getLayerHash(
-          {
-            ...SAMPLE_LAYER1,
-            extras: {
-              func: () => 456,
-              canvas: document.createElement("div"),
-            },
-          },
-          true,
-        ),
-      );
-      expect(hash).not.toEqual(
-        getLayerHash(
-          {
-            ...SAMPLE_LAYER1,
-            extras: {},
-          },
-          true,
-        ),
-      );
-    });
-    it("does not take into account properties order", () => {
-      expect(
-        getLayerHash(
-          {
-            type: "wms",
-            url: "http://abc.org/wms",
-            name: "myLayer",
-            extras: {
-              array: [1, 2, 3],
-              object: {},
-            },
-          },
-          true,
-        ),
-      ).toEqual(
-        getLayerHash(
-          {
-            extras: {
-              array: [1, 2, 3],
-              object: {},
-            },
-            url: "http://abc.org/wms",
-            type: "wms",
-            name: "myLayer",
-          },
-          true,
-        ),
-      );
-    });
-  });
-
   describe("getLayerPosition", () => {
     it("returns the index of the layer in the context", () => {
       const context: MapContext = {
@@ -393,4 +90,78 @@ describe("Map context utils", () => {
       expect(newContext.layers).toEqual([SAMPLE_LAYER2, SAMPLE_LAYER1]);
     });
   });
+
+  describe("updateLayerInContext", () => {
+    it("updates properties of a layer in the context (without id)", () => {
+      const context: MapContext = {
+        ...SAMPLE_CONTEXT,
+        layers: [SAMPLE_LAYER1, SAMPLE_LAYER2],
+      };
+      const newContext = updateLayerInContext(context, SAMPLE_LAYER1, {
+        opacity: 0.8,
+        visibility: false,
+      });
+      expect(newContext.layers).toHaveLength(2);
+      expect(newContext.layers[0]).toEqual({
+        ...SAMPLE_LAYER1,
+        opacity: 0.8,
+        visibility: false,
+      });
+      expect(newContext.layers[1]).toBe(SAMPLE_LAYER2);
+    });
+    it("does not modify the original context", () => {
+      const context: MapContext = {
+        ...SAMPLE_CONTEXT,
+        layers: [SAMPLE_LAYER1, SAMPLE_LAYER2],
+      };
+      const newContext = updateLayerInContext(context, SAMPLE_LAYER1, {
+        opacity: 0.8,
+        visibility: false,
+      });
+      expect(newContext).not.toBe(context);
+      expect(newContext.layers).not.toBe(context.layers);
+    });
+    it("updates properties of a layer with id in the context", () => {
+      const context: MapContext = {
+        ...SAMPLE_CONTEXT,
+        layers: [
+          SAMPLE_LAYER1,
+          SAMPLE_LAYER2,
+          { ...SAMPLE_LAYER3, id: "myLayer", version: 3 },
+        ],
+      };
+      const newContext = updateLayerInContext(
+        context,
+        // this is an empty layer that should not be used because we should track the layer by id in the context
+        {
+          id: "myLayer",
+        } as MapContextLayer,
+        {
+          opacity: 0.8,
+          visibility: false,
+        },
+      );
+      expect(newContext.layers).toHaveLength(3);
+      expect(newContext.layers[2]).toEqual({
+        ...SAMPLE_LAYER3,
+        id: "myLayer",
+        version: 4,
+        opacity: 0.8,
+        visibility: false,
+      });
+      expect(newContext.layers[0]).toBe(SAMPLE_LAYER1);
+      expect(newContext.layers[1]).toBe(SAMPLE_LAYER2);
+    });
+    it("changes the context ref even if the layer is not found (the layers array is untouched)", () => {
+      const context: MapContext = {
+        ...SAMPLE_CONTEXT,
+        layers: [SAMPLE_LAYER1, SAMPLE_LAYER2],
+      };
+      const newContext = updateLayerInContext(context, SAMPLE_LAYER3, {
+        opacity: 0.8,
+      });
+      expect(newContext).not.toBe(context);
+      expect(newContext.layers).toBe(context.layers);
+    });
+  });
 });

package/lib/utils/map-context.ts

@@ -1,36 +1,5 @@
 import { MapContext, MapContextLayer } from "../model/index.js";
-import { getHash } from "./hash.js";
-
-export function getLayerHash(
-  layer: MapContextLayer,
-  includeExtras = false,
-): string {
-  return getHash(layer, includeExtras ? [] : ["extras"]);
-}
-
-export function isLayerSame(
-  layerA: MapContextLayer,
-  layerB: MapContextLayer,
-): boolean {
-  if ("id" in layerA && "id" in layerB) {
-    return layerA.id == layerB.id;
-  }
-  return getLayerHash(layerA) === getLayerHash(layerB);
-}
-
-export function isLayerSameAndUnchanged(
-  layerA: MapContextLayer,
-  layerB: MapContextLayer,
-): boolean {
-  if (
-    "id" in layerA &&
-    "id" in layerB &&
-    ("version" in layerA || "version" in layerB)
-  ) {
-    return layerA.id == layerB.id && layerA.version == layerB.version;
-  }
-  return getLayerHash(layerA, true) === getLayerHash(layerB, true);
-}
+import { isLayerSame, updateLayer } from "./map-context-layer.js";
 
 export function getLayerPosition(
   context: MapContext,
@@ -42,10 +11,10 @@ export function getLayerPosition(
 /**
  * Adds a layer to the context at a specific position or at the end if no position is specified.
  *
- * @param {MapContext} context - The current map context.
- * @param {MapContextLayer} layerModel - The layer to be added.
- * @param {number} [position] - The position at which to add the layer. If not specified, the layer is added at the end.
- * @returns {MapContext} - The new map context with the added layer.
+ * @param context The current map context.
+ * @param layerModel The layer to be added.
+ * @param [position] The position at which to add the layer. If not specified, the layer is added at the end.
+ * @returns The new map context with the added layer.
  */
 
 export function addLayerToContext(
@@ -65,9 +34,9 @@ export function addLayerToContext(
 /**
  * Removes a layer from the context.
  *
- * @param {MapContext} context - The current map context.
- * @param {MapContextLayer} layerModel - The layer to be removed.
- * @returns {MapContext} - The new map context without the removed layer.
+ * @param context The current map context.
+ * @param layerModel The layer to be removed.
+ * @returns The new map context without the removed layer.
  */
 
 export function removeLayerFromContext(
@@ -85,10 +54,10 @@ export function removeLayerFromContext(
 /**
  * Replaces a layer in the context with a new layer.
  *
- * @param {MapContext} context - The current map context.
- * @param {MapContextLayer} layerModel - The layer to be replaced.
- * @param {MapContextLayer} replacement - The new layer that will replace the old one.
- * @returns {MapContext} - The new map context with the replaced layer.
+ * @param context The current map context.
+ * @param layerModel The layer to be replaced.
+ * @param replacement The new layer that will replace the old one.
+ * @returns The new map context with the replaced layer.
  */
 
 export function replaceLayerInContext(
@@ -104,13 +73,41 @@ export function replaceLayerInContext(
   return newContext;
 }
 
+/**
+ * Updates an existing layer in the context by applying partial changes.
+ *
+ * Note: setting a property to `undefined` in the partial layer updates will remove that
+ * property from the existing layer.
+ *
+ * @param context The current map context.
+ * @param layerModel The layer to be updated.
+ * @param layerUpdates A partial layer object containing the properties to update on the existing layer.
+ * @returns The new map context with the updated layer.
+ */
+
+export function updateLayerInContext(
+  context: MapContext,
+  layerModel: MapContextLayer,
+  layerUpdates: Partial<MapContextLayer>,
+): MapContext {
+  const position = getLayerPosition(context, layerModel);
+  if (position >= 0) {
+    const existing = context.layers[position];
+    const updated = updateLayer(existing, layerUpdates);
+    return replaceLayerInContext(context, layerModel, updated);
+  }
+  // we're building a new context so that the reference is changed anyway; this is done to be
+  // consistent with other utilities that always change the context reference even if the layer wasn't found
+  return { ...context };
+}
+
 /**
  * Changes the position of a layer in the context.
  *
- * @param {MapContext} context - The current map context.
- * @param {MapContextLayer} layerModel - The layer whose position is to be changed.
- * @param {number} position - The new position for the layer.
- * @returns {MapContext} - The new map context with the layer moved to the new position.
+ * @param context The current map context.
+ * @param layerModel The layer whose position is to be changed.
+ * @param position The new position for the layer.
+ * @returns The new map context with the layer moved to the new position.
  */
 
 export function changeLayerPositionInContext(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geospatial-sdk/core",
-  "version": "0.0.5-dev.46+b8d315e",
+  "version": "0.0.5-dev.48+a6a661d",
   "description": "Core functions and models for the SDK",
   "author": "Olivia <olivia.guyot@camptocamp.com>",
   "homepage": "",
@@ -22,7 +22,7 @@
     "test": "vitest",
     "build": "tsc"
   },
-  "gitHead": "b8d315eaf71bccb50823f6e11c18c045ab1b6c5d",
+  "gitHead": "a6a661d277224d3e0acef7e2df817a3c5b7360e1",
   "dependencies": {
     "proj4": "^2.9.2"
   },