@geospatial-sdk/openlayers 0.0.5-dev.17 → 0.0.5-dev.18

package/dist/map/register-events.d.ts

@@ -1,5 +1,5 @@
 import Map from "ol/Map";
-import { MapEvent, MapEventType } from "@geospatial-sdk/core";
+import { MapEventsByType } from "@geospatial-sdk/core";
 import { Coordinate } from "ol/coordinate";
 import TileWMS from "ol/source/TileWMS";
 import ImageWMS from "ol/source/ImageWMS";
@@ -8,5 +8,5 @@ import type { Feature } from "geojson";
 export declare function getFeaturesFromVectorSources(olMap: Map, pixel: Pixel): Feature[];
 export declare function getGFIUrl(source: TileWMS | ImageWMS, map: Map, coordinate: Coordinate): string | null;
 export declare function getFeaturesFromWmsSources(olMap: Map, coordinate: Coordinate): Promise<Feature[]>;
-export declare function listen(map: Map, event: MapEventType, callback: (event: MapEvent) => void): void;
+export declare function listen<T extends keyof MapEventsByType>(map: Map, eventType: T, callback: (event: MapEventsByType[T]) => void): void;
 //# sourceMappingURL=register-events.d.ts.map

package/dist/map/register-events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"register-events.d.ts","sourceRoot":"","sources":["../../lib/map/register-events.ts"],"names":[],"mappings":"AAAA,OAAO,GAA4B,MAAM,QAAQ,CAAC;AAClD,OAAO,EAIL,QAAQ,EACR,YAAY,EACb,MAAM,sBAAsB,CAAC;AAM9B,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,OAAO,MAAM,mBAAmB,CAAC;AACxC,OAAO,QAAQ,MAAM,oBAAoB,CAAC;AAE1C,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,KAAK,EAAE,OAAO,EAAqB,MAAM,SAAS,CAAC;AAK1D,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,GAAG,EACV,KAAK,EAAE,KAAK,GACX,OAAO,EAAE,CAOX;AAED,wBAAgB,SAAS,CACvB,MAAM,EAAE,OAAO,GAAG,QAAQ,EAC1B,GAAG,EAAE,GAAG,EACR,UAAU,EAAE,UAAU,GACrB,MAAM,GAAG,IAAI,CAWf;AAED,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,GAAG,EACV,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,OAAO,EAAE,CAAC,CA2BpB;AAyCD,wBAAgB,MAAM,CACpB,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,YAAY,EACnB,QAAQ,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,IAAI,QA6BpC"}
+{"version":3,"file":"register-events.d.ts","sourceRoot":"","sources":["../../lib/map/register-events.ts"],"names":[],"mappings":"AAAA,OAAO,GAA4B,MAAM,QAAQ,CAAC;AAClD,OAAO,EAIL,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAM9B,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,OAAO,MAAM,mBAAmB,CAAC;AACxC,OAAO,QAAQ,MAAM,oBAAoB,CAAC;AAE1C,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,KAAK,EAAE,OAAO,EAAqB,MAAM,SAAS,CAAC;AAK1D,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,GAAG,EACV,KAAK,EAAE,KAAK,GACX,OAAO,EAAE,CAOX;AAED,wBAAgB,SAAS,CACvB,MAAM,EAAE,OAAO,GAAG,QAAQ,EAC1B,GAAG,EAAE,GAAG,EACR,UAAU,EAAE,UAAU,GACrB,MAAM,GAAG,IAAI,CAWf;AAED,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,GAAG,EACV,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,OAAO,EAAE,CAAC,CA2BpB;AAyCD,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,eAAe,EACpD,GAAG,EAAE,GAAG,EACR,SAAS,EAAE,CAAC,EACZ,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,IAAI,QAgC9C"}

package/dist/map/register-events.js

@@ -83,29 +83,32 @@ function registerFeatureHoverEvent(map) {
     }));
     map.set(FeaturesHoverEventType, true);
 }
-export function listen(map, event, callback) {
-    switch (event) {
+export function listen(map, eventType, callback) {
+    switch (eventType) {
         case FeaturesClickEventType:
             registerFeatureClickEvent(map);
             // we're using a custom event type here so we need to cast to unknown first
-            map.on(event, (event) => {
+            map.on(eventType, (event) => {
                 callback(event);
             });
             break;
         case FeaturesHoverEventType:
             registerFeatureHoverEvent(map);
             // see comment above
-            map.on(event, (event) => {
+            map.on(eventType, (event) => {
                 callback(event);
             });
             break;
         case MapClickEventType:
             map.on("click", (event) => {
                 const coordinate = toLonLat(event.pixel, map.getView().getProjection());
-                callback({ coordinate });
+                callback({
+                    type: "map-click",
+                    coordinate,
+                });
             });
             break;
         default:
-            throw new Error(`Unrecognized event type: ${event}`);
+            throw new Error(`Unrecognized event type: ${eventType}`);
     }
 }

package/lib/map/register-events.test.ts

@@ -190,7 +190,10 @@ describe("event registration", () => {
       map.dispatchEvent(createMapEvent(map, "click"));
     });
     it("registers the event on the map", () => {
-      expect(callback).toHaveBeenCalledWith({ coordinate: toLonLat([10, 10]) });
+      expect(callback).toHaveBeenCalledWith({
+        coordinate: toLonLat([10, 10]),
+        type: "map-click",
+      });
     });
   });
 });

package/lib/map/register-events.ts

@@ -3,8 +3,7 @@ import {
   FeaturesClickEventType,
   FeaturesHoverEventType,
   MapClickEventType,
-  MapEvent,
-  MapEventType,
+  MapEventsByType,
 } from "@geospatial-sdk/core";
 import { toLonLat } from "ol/proj";
 import GeoJSON from "ol/format/GeoJSON";
@@ -121,24 +120,24 @@ function registerFeatureHoverEvent(map: Map) {
   map.set(FeaturesHoverEventType, true);
 }
 
-export function listen(
+export function listen<T extends keyof MapEventsByType>(
   map: Map,
-  event: MapEventType,
-  callback: (event: MapEvent) => void,
+  eventType: T,
+  callback: (event: MapEventsByType[T]) => void,
 ) {
-  switch (event) {
+  switch (eventType) {
     case FeaturesClickEventType:
       registerFeatureClickEvent(map);
       // we're using a custom event type here so we need to cast to unknown first
-      map.on(event as unknown as MapObjectEventTypes, (event) => {
-        callback(event as unknown as MapEvent);
+      map.on(eventType as unknown as MapObjectEventTypes, (event) => {
+        (callback as (event: unknown) => void)(event);
       });
       break;
     case FeaturesHoverEventType:
       registerFeatureHoverEvent(map);
       // see comment above
-      map.on(event as unknown as MapObjectEventTypes, (event) => {
-        callback(event as unknown as MapEvent);
+      map.on(eventType as unknown as MapObjectEventTypes, (event) => {
+        (callback as (event: unknown) => void)(event);
       });
       break;
     case MapClickEventType:
@@ -147,10 +146,13 @@ export function listen(
           event.pixel,
           map.getView().getProjection(),
         ) as [number, number];
-        callback({ coordinate });
+        (callback as (event: unknown) => void)({
+          type: "map-click",
+          coordinate,
+        });
       });
       break;
     default:
-      throw new Error(`Unrecognized event type: ${event}`);
+      throw new Error(`Unrecognized event type: ${eventType}`);
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geospatial-sdk/openlayers",
-  "version": "0.0.5-dev.17+e758ce3",
+  "version": "0.0.5-dev.18+6f12b0b",
   "description": "OpenLayers-related utilities",
   "keywords": [
     "ol",
@@ -37,9 +37,9 @@
     "ol": ">6.x"
   },
   "dependencies": {
-    "@geospatial-sdk/core": "^0.0.5-dev.17+e758ce3",
+    "@geospatial-sdk/core": "^0.0.5-dev.18+6f12b0b",
     "chroma-js": "^2.4.2",
     "lodash.throttle": "^4.1.1"
   },
-  "gitHead": "e758ce3d88f26443f0680907277ae4fde3c748f9"
+  "gitHead": "6f12b0b59e2794a24b27940c9c62dd279e2120e8"
 }