mobility-toolbox-js 2.3.10 → 2.4.0

package/src/common/mixins/UserInteractionsLayerMixin.test.js

@@ -1,227 +0,0 @@
-import VectorLayer from 'ol/layer/Vector';
-import VectorSource from 'ol/source/Vector';
-import BaseLayer from '../layers/LayerCommon';
-import mixin from './UserInteractionsLayerMixin';
-
-const olLayer = new VectorLayer({ source: new VectorSource() });
-
-const Layer = mixin(BaseLayer);
-
-describe('Layer', () => {
-  test('should initialize.', () => {
-    const layer = new Layer();
-    expect(layer).toBeInstanceOf(Layer);
-  });
-
-  test('should define default properties.', () => {
-    const layer = new Layer();
-    expect(layer).toBeInstanceOf(Layer);
-    expect(layer.userInteractions).toEqual(true);
-    expect(layer.userClickInteractions).toEqual(true);
-    expect(layer.userHoverInteractions).toEqual(true);
-    expect(layer.defaultUserInteractions).toBe(true);
-    expect(layer.userClickCallbacks).toEqual([]);
-    expect(layer.userHoverCallbacks).toEqual([]);
-    expect(layer.userClickEventsKeys).toEqual([]);
-    expect(layer.userHoverEventsKeys).toEqual([]);
-  });
-
-  test('should set userInteractionsXXX to false.', () => {
-    const options = {
-      userInteractions: false,
-      userClickInteractions: false,
-      userHoverInteractions: false,
-      defaultUserInteractions: false,
-    };
-    const layer = new Layer(options);
-    expect(layer).toBeInstanceOf(Layer);
-    expect(layer.userInteractions).toBe(false);
-    expect(layer.userClickInteractions).toBe(false);
-    expect(layer.userHoverInteractions).toBe(false);
-    expect(layer.defaultUserInteractions).toBe(false);
-  });
-
-  test('should set onClick using constructor', () => {
-    const fn = () => {};
-    const layer = new Layer({
-      onClick: fn,
-      onHover: fn,
-    });
-    expect(layer.userClickCallbacks[0]).toBe(fn);
-    expect(layer.userHoverCallbacks[0]).toBe(fn);
-    expect(layer.userClickEventsKeys.length).toBe(0);
-    expect(layer.userHoverEventsKeys.length).toBe(0);
-  });
-
-  describe('#attachToMap()', () => {
-    test('should not add events if no callbacks', () => {
-      const layer = new Layer({
-        olLayer,
-      });
-
-      expect(layer.map).toBe(undefined);
-      const obj = {};
-      layer.attachToMap(obj);
-      expect(layer.userClickEventsKeys.length).toBe(0);
-      expect(layer.userHoverEventsKeys.length).toBe(0);
-    });
-
-    test('should add events', () => {
-      const fn = () => {};
-      const layer = new Layer({
-        olLayer,
-        onClick: fn,
-        onHover: fn,
-      });
-
-      expect(layer.map).toBe(undefined);
-      const obj = {};
-      layer.attachToMap(obj);
-      expect(layer.userClickEventsKeys.length).toBe(1);
-      expect(layer.userHoverEventsKeys.length).toBe(1);
-    });
-  });
-
-  describe('#onClick()', () => {
-    test('adds function to callback array', () => {
-      const layer = new Layer();
-      const fn = jest.fn();
-      const fn2 = jest.fn();
-      layer.onClick(fn);
-      expect(layer.userClickCallbacks).toEqual([fn]);
-      layer.onClick(fn2);
-      expect(layer.userClickCallbacks).toEqual([fn, fn2]);
-      expect(layer.userClickEventsKeys.length).toBe(0);
-
-      layer.attachToMap({});
-      expect(layer.userClickEventsKeys.length).toBe(2);
-    });
-  });
-
-  describe('#onHover()', () => {
-    test('adds function to callback array', () => {
-      const layer = new Layer();
-      const fn = jest.fn();
-      const fn2 = jest.fn();
-      layer.onHover(fn);
-      expect(layer.userHoverCallbacks).toEqual([fn]);
-      layer.onHover(fn2);
-      expect(layer.userHoverCallbacks).toEqual([fn, fn2]);
-      expect(layer.userHoverEventsKeys.length).toBe(0);
-
-      layer.attachToMap({});
-      expect(layer.userHoverEventsKeys.length).toBe(2);
-    });
-  });
-
-  describe('#onUserClickCallback()', () => {
-    const evt = { type: 'signleclick', coordinate: [0, 0] };
-
-    const getFeatureInfo = (layer, features = []) => ({
-      features,
-      layer,
-      coordinate: evt.coordinate,
-      event: evt,
-    });
-
-    test('calls click callback functions', (done) => {
-      const layer = new Layer();
-      const goodFeatureInfo = getFeatureInfo(layer, [{ name: 'test' }]);
-      const fn = jest.fn();
-      const fn2 = jest.fn();
-      const spy = jest
-        .spyOn(layer, 'getFeatureInfoAtCoordinate')
-        .mockResolvedValue(goodFeatureInfo);
-      layer.onClick(fn);
-      layer.onClick(fn2);
-      layer.attachToMap({});
-      layer.onUserClickCallback(evt).then((featureInfo) => {
-        expect(spy).toHaveBeenCalledTimes(1);
-        expect(spy).toHaveBeenCalledWith(evt.coordinate);
-        expect(featureInfo).toBe(goodFeatureInfo);
-        expect(fn).toHaveBeenCalledTimes(1);
-        expect(fn.mock.calls[0][0]).toBe(goodFeatureInfo.features);
-        expect(fn.mock.calls[0][1]).toBe(goodFeatureInfo.layer);
-        expect(fn.mock.calls[0][2]).toBe(goodFeatureInfo.coordinate);
-        expect(fn2).toHaveBeenCalledTimes(1);
-        expect(fn2.mock.calls[0][0]).toBe(goodFeatureInfo.features);
-        expect(fn2.mock.calls[0][1]).toBe(goodFeatureInfo.layer);
-        expect(fn2.mock.calls[0][2]).toBe(goodFeatureInfo.coordinate);
-        done();
-      });
-    });
-
-    describe('returns empty feature info', () => {
-      test('if an error is thrown in click callback', (done) => {
-        const layer = new Layer();
-        layer.onClick(() => {
-          throw new Error('foo');
-        });
-        const goodFeatureInfo = getFeatureInfo(layer, [{ name: 'test' }]);
-        jest
-          .spyOn(layer, 'getFeatureInfoAtCoordinate')
-          .mockResolvedValue(goodFeatureInfo);
-        layer.attachToMap({});
-        layer.onUserClickCallback(evt).then((featureInfo) => {
-          expect(featureInfo).toEqual(getFeatureInfo(layer));
-          done();
-        });
-      });
-    });
-  });
-
-  describe('#onUserMoveCallback()', () => {
-    const evt = { type: 'pointermove', coordinate: [0, 0] };
-
-    const getFeatureInfo = (layer, features = []) => ({
-      features,
-      layer,
-      coordinate: evt.coordinate,
-      event: evt,
-    });
-
-    test('calls hover callback functions', (done) => {
-      const layer = new Layer();
-      const goodFeatureInfo = getFeatureInfo(layer, [{ name: 'test' }]);
-      const fn = jest.fn();
-      const fn2 = jest.fn();
-      const spy = jest
-        .spyOn(layer, 'getFeatureInfoAtCoordinate')
-        .mockResolvedValue(goodFeatureInfo);
-      layer.onHover(fn);
-      layer.onHover(fn2);
-      layer.attachToMap({});
-      layer.onUserMoveCallback(evt).then((featureInfo) => {
-        expect(spy).toHaveBeenCalledTimes(1);
-        expect(spy).toHaveBeenCalledWith(evt.coordinate);
-        expect(featureInfo).toBe(goodFeatureInfo);
-        expect(fn).toHaveBeenCalledTimes(1);
-        expect(fn.mock.calls[0][0]).toBe(goodFeatureInfo.features);
-        expect(fn.mock.calls[0][1]).toBe(goodFeatureInfo.layer);
-        expect(fn.mock.calls[0][2]).toBe(goodFeatureInfo.coordinate);
-        expect(fn2).toHaveBeenCalledTimes(1);
-        expect(fn2.mock.calls[0][0]).toBe(goodFeatureInfo.features);
-        expect(fn2.mock.calls[0][1]).toBe(goodFeatureInfo.layer);
-        expect(fn2.mock.calls[0][2]).toBe(goodFeatureInfo.coordinate);
-        done();
-      });
-    });
-
-    describe('returns empty feature info', () => {
-      test('if an error is thrown in hover callback', (done) => {
-        const layer = new Layer();
-        layer.onHover(() => {
-          throw new Error('foo');
-        });
-        jest
-          .spyOn(layer, 'getFeatureInfoAtCoordinate')
-          .mockResolvedValue(getFeatureInfo(layer, [{ name: 'test' }]));
-        layer.attachToMap({});
-        layer.onUserMoveCallback(evt).then((featureInfo) => {
-          expect(featureInfo).toEqual(getFeatureInfo(layer));
-          done();
-        });
-      });
-    });
-  });
-});

package/src/common/mixins/UserInteractionsLayerMixin.ts

@@ -1,352 +0,0 @@
-/* eslint-disable no-empty-function,@typescript-eslint/no-empty-function */
-/* eslint-disable no-useless-constructor,@typescript-eslint/no-useless-constructor */
-/* eslint-disable no-unused-vars,@typescript-eslint/no-unused-vars */
-/* eslint-disable class-methods-use-this */
-/* eslint-disable max-classes-per-file */
-import { fromLonLat } from 'ol/proj';
-import { unByKey } from 'ol/Observable';
-import { EventsKey } from 'ol/events';
-import { ObjectEvent } from 'ol/Object';
-import { Coordinate } from 'ol/coordinate';
-import { MapBrowserEvent, MapEvent } from 'ol';
-import BaseEvent from 'ol/events/Event';
-import { AnyMap, CommonLayerClass, UserInteractionCallback } from '../../types';
-import LayerCommon from '../layers/LayerCommon';
-
-export type UserInteractionsLayerMixinOptions = {
-  userInteractions?: boolean;
-  userClickInteractions?: boolean;
-  userHoverInteractions?: boolean;
-  defaultUserInteractions?: boolean;
-  onClick?: UserInteractionCallback;
-  onHover?: UserInteractionCallback;
-};
-
-/**
- * UserInteractionsLayerInterface.
- */
-export class UserInteractionsLayerInterface {
-  /*
-   * Constructor
-
-   * @param {Object} options Layer options.
-   * @param {string} options.userInteractions If true, it listens for user mouse hover and click event.
-   * @param {string} options.userClickInteractions If true, it listens for user click event.
-   * @param {string} options.userHoverInteractions If true, it listens for user mouse over event.
-   * @param {string} options.defaultUserInteractions  If true, it adds default listeners for user mouse hover and click event.
-   */
-  constructor(options = {}) {}
-
-  /**
-   * Initialize the layer adding user interactions.
-   *
-   * @param {ol/Map~Map} map
-   */
-  attachToMap(map: AnyMap) {}
-
-  /**
-   * Terminate the layer unsubscribing user interactions.
-   */
-  detachFromMap() {}
-
-  /**
-   * Activate map listeners events.
-   */
-  activateUserInteractions() {}
-
-  /**
-   * Deactivate map listeners events.
-   */
-  deactivateUserInteractions() {}
-
-  /**
-   * Subscribe on user:click event.
-   */
-  onClick(callback: UserInteractionCallback) {}
-
-  /**
-   * Subscribe on user:hover event.
-   */
-  onHover(callback: UserInteractionCallback) {}
-
-  /**
-   * Unsubscribe on user:click event.
-   */
-  unClick(callback: UserInteractionCallback) {}
-
-  /**
-   * Unsubscribe on user:hover event.
-   */
-  unHover(callback: UserInteractionCallback) {}
-}
-
-/**
- * Mixin for UserInteractionsLayerInterface. It provide onClick and onHover functions.
- *
- * @param {Class} Base A class to extend with {UserInteractionsLayerInterface} functionnalities.
- * @return {Class}  A class that implements {UserInteractionsLayerInterface} class and extends Base;
- * @private
- */
-function UserInteractionsLayerMixin<T extends CommonLayerClass>(
-  Base: T,
-): T & typeof LayerCommon {
-  // @ts-ignore
-  return class extends Base {
-    userInteractions: boolean;
-
-    userClickInteractions: boolean;
-
-    userHoverInteractions: boolean;
-
-    defaultUserInteractions: boolean;
-
-    userClickCallbacks: UserInteractionCallback[];
-
-    userHoverCallbacks: UserInteractionCallback[];
-
-    userClickEventsKeys: EventsKey[];
-
-    userHoverEventsKeys: EventsKey[];
-
-    onFeatureClick?: UserInteractionCallback;
-
-    onFeatureHover?: UserInteractionCallback;
-
-    constructor(options: UserInteractionsLayerMixinOptions = {}) {
-      super(options);
-
-      const {
-        userInteractions = true,
-        userClickInteractions = true,
-        userHoverInteractions = true,
-        defaultUserInteractions = true,
-      } = options;
-
-      this.userInteractions = userInteractions;
-      this.userClickInteractions = userClickInteractions;
-      this.userHoverInteractions = userHoverInteractions;
-      this.defaultUserInteractions = defaultUserInteractions;
-      this.userClickCallbacks = [];
-      this.userHoverCallbacks = [];
-      this.userClickEventsKeys = [];
-      this.userHoverEventsKeys = [];
-      this.onUserClickCallback = this.onUserClickCallback.bind(this);
-      this.onUserMoveCallback = this.onUserMoveCallback.bind(this);
-
-      // Add mouse event callbacks
-      const { onClick, onHover } = options;
-
-      if (this.userInteractions && this.userClickInteractions && onClick) {
-        this.onClick(onClick);
-      }
-
-      if (this.userInteractions && this.userHoverInteractions && onHover) {
-        this.onHover(onHover);
-      }
-    }
-
-    attachToMap(map: AnyMap) {
-      super.attachToMap(map);
-
-      if (
-        this.userInteractions &&
-        this.defaultUserInteractions &&
-        this.userClickInteractions &&
-        this.onFeatureClick
-      ) {
-        this.onClick(this.onFeatureClick);
-      }
-
-      if (
-        this.userInteractions &&
-        this.defaultUserInteractions &&
-        this.userHoverInteractions &&
-        this.onFeatureHover
-      ) {
-        this.onHover(this.onFeatureHover);
-      }
-      this.listenEvents();
-    }
-
-    detachFromMap() {
-      this.unlistenEvents();
-      super.detachFromMap();
-    }
-
-    listenEvents() {
-      this.unlistenEvents();
-      this.userClickCallbacks.forEach((callback) => {
-        this.userClickEventsKeys.push(
-          this.on(
-            // @ts-ignore
-            'user:click',
-            ({
-              target: { features, layer, coordinate, event },
-            }: ObjectEvent) => {
-              callback(features, layer, coordinate, event);
-            },
-          ),
-        );
-      });
-      this.userHoverCallbacks.forEach((callback) => {
-        this.userHoverEventsKeys.push(
-          this.on(
-            // @ts-ignore
-            'user:hover',
-            ({
-              target: { features, layer, coordinate, event },
-            }: ObjectEvent) => {
-              callback(features, layer, coordinate, event);
-            },
-          ),
-        );
-      });
-    }
-
-    unlistenEvents() {
-      unByKey(this.userClickEventsKeys);
-      unByKey(this.userHoverEventsKeys);
-      this.userClickEventsKeys = [];
-      this.userHoverEventsKeys = [];
-    }
-
-    /**
-     * Listens to click events on the layer.
-     * @param {function} callback Callback function, called with the clicked
-     *   features,
-     *   the layer instance and the click event.
-     */
-    onClick(callback: UserInteractionCallback) {
-      this.userClickCallbacks.push(callback);
-      this.activateUserInteractions();
-      if (this.map) {
-        // If the layer is already attached to the map we reload the events
-        this.listenEvents();
-      }
-    }
-
-    /**
-     * Listens to hover events on the layer.
-     * @param {function} callback Callback function, called with the clicked
-     *   features, the layer instance and the click event.
-     */
-    onHover(callback: UserInteractionCallback) {
-      this.userHoverCallbacks.push(callback);
-      this.activateUserInteractions();
-      if (this.map) {
-        // If the layer is already attached to the map we reload the events
-        this.listenEvents();
-      }
-    }
-
-    /**
-     * Unlistens to click events on the layer.
-     * @param {function} callback Callback function, called with the clicked
-     *   features,
-     *   the layer instance and the click event.
-     */
-    unClick(callback: UserInteractionCallback) {
-      const index = this.userClickCallbacks.indexOf(callback);
-      if (index !== -1) {
-        return;
-      }
-      this.userClickCallbacks = this.userClickCallbacks.slice(index, 1);
-
-      if (this.map) {
-        // If the layer is already attached to the map we reload the events
-        this.listenEvents();
-      }
-    }
-
-    /**
-     * Unlistens to hover events on the layer.
-     * @param {function} callback Callback function, called with the clicked
-     *   features, the layer instance and the click event.
-     */
-    unHover(callback: UserInteractionCallback) {
-      const index = this.userHoverCallbacks.indexOf(callback);
-      if (index !== -1) {
-        return;
-      }
-      this.userHoverCallbacks = this.userHoverCallbacks.slice(index, 1);
-
-      if (this.map) {
-        // If the layer is already attached to the map we reload the events
-        this.listenEvents();
-      }
-    }
-
-    /**
-     * Function triggered when the user click the map.
-     * @private
-     */
-    onUserClickCallback(
-      evt:
-        | { coordinate: Coordinate }
-        | mapboxgl.MapLayerMouseEvent
-        | maplibregl.MapMouseEvent,
-    ) {
-      const coordinate =
-        (evt as { coordinate: Coordinate }).coordinate ||
-        fromLonLat(
-          (
-            evt as mapboxgl.MapLayerMouseEvent | maplibregl.MapMouseEvent
-          ).lngLat.toArray() as Coordinate,
-        );
-      const emptyFeatureInfo = {
-        features: [],
-        layer: this,
-        coordinate,
-        event: evt,
-      };
-      return this.getFeatureInfoAtCoordinate(coordinate)
-        .then((featureInfo) => {
-          const event = new BaseEvent('user:click');
-          event.target = featureInfo;
-          this.dispatchEvent(event);
-          return featureInfo;
-        })
-        .catch(() => emptyFeatureInfo);
-    }
-
-    /**
-     * Function triggered when the user move the cursor.
-     * @private
-     */
-    onUserMoveCallback(
-      evt:
-        | { coordinate: Coordinate }
-        | mapboxgl.MapLayerMouseEvent
-        | maplibregl.MapMouseEvent,
-    ) {
-      const coordinate =
-        (evt as { coordinate: Coordinate }).coordinate ||
-        fromLonLat(
-          (
-            evt as mapboxgl.MapLayerMouseEvent | maplibregl.MapMouseEvent
-          ).lngLat.toArray() as Coordinate,
-        );
-      const emptyFeatureInfo = {
-        features: [],
-        layer: this,
-        coordinate,
-        event: evt,
-      };
-
-      return this.getFeatureInfoAtCoordinate(coordinate)
-        .then((featureInfo) => {
-          const event = new BaseEvent('user:hover');
-          event.target = featureInfo;
-          this.dispatchEvent(event);
-          return featureInfo;
-        })
-        .catch(() => emptyFeatureInfo);
-    }
-
-    activateUserInteractions() {}
-
-    deactivateUserInteractions() {}
-  };
-}
-
-export default UserInteractionsLayerMixin;