mobility-toolbox-js 2.0.0-beta.34 → 2.0.0-beta.37

package/ol/controls/CopyrightControl.js

@@ -1,24 +1,7 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-var Layer_1 = require("ol/layer/Layer");
-var Control_1 = require("../../common/controls/Control");
-var CopyrightMixin_1 = require("../../common/mixins/CopyrightMixin");
-var removeDuplicate_1 = require("../../common/utils/removeDuplicate");
+import { inView } from 'ol/layer/Layer';
+import Control from '../../common/controls/Control';
+import mixin from '../../common/mixins/CopyrightMixin';
+import removeDuplicate from '../../common/utils/removeDuplicate';
 /**
  * Display layer's copyrights.
  *
@@ -38,45 +21,42 @@ var removeDuplicate_1 = require("../../common/utils/removeDuplicate");
  * @extends {Control}
  * @implements {CopyrightInterface}
  */
-var CopyrightControl = /** @class */ (function (_super) {
-    __extends(CopyrightControl, _super);
-    function CopyrightControl(options) {
-        var _this = _super.call(this, options) || this;
-        _this.onPostRender = _this.onPostRender.bind(_this);
-        return _this;
+class CopyrightControl extends mixin(Control) {
+    constructor(options) {
+        super(options);
+        this.onPostRender = this.onPostRender.bind(this);
     }
-    CopyrightControl.prototype.getCopyrights = function () {
-        var _this = this;
+    getCopyrights() {
         if (!this.frameState) {
             return [];
         }
-        var copyrights = [];
+        let copyrights = [];
         // This code loop comes mainly from ol.
-        this.frameState.layerStatesArray.forEach(function (layerState) {
-            var layer = layerState.layer;
-            if ((0, Layer_1.inView)(layerState, _this.frameState.viewState) &&
+        this.frameState.layerStatesArray.forEach((layerState) => {
+            const { layer } = layerState;
+            if (inView(layerState, this.frameState.viewState) &&
                 layer &&
                 layer.getSource &&
                 layer.getSource() &&
                 layer.getSource().getAttributions()) {
-                copyrights = copyrights.concat(layer.getSource().getAttributions()(_this.frameState));
+                copyrights = copyrights.concat(layer.getSource().getAttributions()(this.frameState));
             }
         });
-        return (0, removeDuplicate_1.default)(copyrights);
-    };
-    CopyrightControl.prototype.activate = function () {
-        _super.prototype.activate.call(this);
+        return removeDuplicate(copyrights);
+    }
+    activate() {
+        super.activate();
         if (this.map) {
             this.map.on('postrender', this.onPostRender);
         }
-    };
-    CopyrightControl.prototype.deactivate = function () {
+    }
+    deactivate() {
         if (this.map) {
             this.map.un('postrender', this.onPostRender);
         }
-        _super.prototype.deactivate.call(this);
-    };
-    CopyrightControl.prototype.onPostRender = function (evt) {
+        super.deactivate();
+    }
+    onPostRender(evt) {
         if (this.map && this.element) {
             /**
              * @ignore
@@ -84,7 +64,6 @@ var CopyrightControl = /** @class */ (function (_super) {
             this.frameState = evt.frameState;
             this.render();
         }
-    };
-    return CopyrightControl;
-}((0, CopyrightMixin_1.default)(Control_1.default)));
-exports.default = CopyrightControl;
+    }
+}
+export default CopyrightControl;

package/ol/controls/CopyrightControl.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CopyrightControl.test.d.ts.map

package/ol/controls/CopyrightControl.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CopyrightControl.test.d.ts","sourceRoot":"","sources":["../../../src/ol/controls/CopyrightControl.test.js"],"names":[],"mappings":""}

package/ol/controls/CopyrightControl.test.js

@@ -0,0 +1,177 @@
+import View from 'ol/View';
+import Tile from 'ol/Tile';
+import TileLayer from 'ol/layer/Tile';
+import TileSource from 'ol/source/Tile';
+import { createXYZ } from 'ol/tilegrid';
+import { Map } from 'ol';
+import Layer from '../layers/Layer';
+import CopyrightControl from './CopyrightControl';
+const tileLoadFunction = () => {
+    const tile = new Tile([0, 0, -1], 2 /* LOADED */);
+    tile.getImage = () => {
+        const image = new Image();
+        image.width = 256;
+        image.height = 256;
+        return image;
+    };
+    return tile;
+};
+const getOLTileLayer = () => {
+    const layer = new TileLayer({
+        source: new TileSource({
+            projection: 'EPSG:3857',
+            tileGrid: createXYZ(),
+        }),
+    });
+    layer.getSource().getTile = tileLoadFunction;
+    return layer;
+};
+const getLayer = (copyrights, visible = true) => new Layer({
+    visible,
+    copyrights,
+    olLayer: getOLTileLayer(),
+});
+describe('CopyrightControl', () => {
+    let map;
+    beforeEach(() => {
+        const target = document.createElement('div');
+        document.body.appendChild(target);
+        map = new Map({
+            target,
+            view: new View({
+                center: [0, 0],
+                zoom: 0,
+            }),
+        });
+        getLayer(true, 'bar').attachToMap(map);
+        map.setSize([200, 200]);
+        map.renderSync();
+    });
+    afterEach(() => {
+        if (map) {
+            map.setTarget(null);
+            map = null;
+        }
+    });
+    test('should be activate by default', () => {
+        const control = new CopyrightControl();
+        expect(control.active).toBe(true);
+    });
+    test('renders a string copyright', () => {
+        const control = new CopyrightControl();
+        control.attachToMap(map);
+        expect(control.element.innerHTML).toBe('');
+        getLayer('copyright').attachToMap(map);
+        map.renderSync();
+        expect(control.element.innerHTML).toBe('copyright');
+    });
+    test('renders an array of copyrights', () => {
+        const control = new CopyrightControl();
+        control.attachToMap(map);
+        expect(control.element.innerHTML).toBe('');
+        getLayer(['copyright 1', 'copyright 2']).attachToMap(map);
+        map.renderSync();
+        expect(control.element.innerHTML).toBe('copyright 1 | copyright 2');
+    });
+    test('renders unique copyrights', () => {
+        const control = new CopyrightControl();
+        control.attachToMap(map);
+        expect(control.element.innerHTML).toBe('');
+        getLayer(['copyright 1', 'copyright 2']).attachToMap(map);
+        getLayer('copyright 1').attachToMap(map);
+        getLayer(['copyright 2']).attachToMap(map);
+        map.renderSync();
+        expect(control.element.innerHTML).toBe('copyright 1 | copyright 2');
+    });
+    test("doesn't render copyright of an hidden layer", () => {
+        const control = new CopyrightControl();
+        control.attachToMap(map);
+        expect(control.element.innerHTML).toBe('');
+        const layer1 = getLayer('copyright hidden', false);
+        layer1.attachToMap(map);
+        const layer2 = getLayer('copyright', true);
+        layer2.attachToMap(map);
+        map.renderSync();
+        expect(control.element.innerHTML).toBe('copyright');
+        // the we update visibility of both layers
+        layer1.visible = true;
+        map.renderSync();
+        layer2.visible = false;
+        map.renderSync();
+        expect(control.element.innerHTML).toBe('copyright hidden');
+    });
+    test('should activate the control on construction then deactivate it', () => {
+        getLayer('copyright 1').attachToMap(map);
+        const control = new CopyrightControl({ active: true });
+        control.attachToMap(map);
+        map.renderSync();
+        expect(control.element.parentNode).toBe(map.getTargetElement());
+        // Should be activated by default.
+        expect(control.active).toBe(true);
+        expect(control.element.innerHTML).toBe('copyright 1');
+        // on deactivation
+        control.active = false;
+        map.renderSync();
+        expect(control.element.innerHTML).toBe('');
+    });
+    test('should deactivate the control on constrcution then activate it', () => {
+        getLayer('copyright 1').attachToMap(map);
+        const control = new CopyrightControl({ active: false });
+        control.attachToMap(map);
+        map.renderSync();
+        expect(control.element.parentNode).toBe(map.getTargetElement());
+        // Should be activated by default.
+        expect(control.active).toBe(false);
+        map.renderSync();
+        expect(control.element.innerHTML).toBe('');
+        // on deactivation
+        control.active = true;
+        map.renderSync();
+        expect(control.element.innerHTML).toBe('copyright 1');
+    });
+    test('should add copyrights in the map container element then remove it.', () => {
+        getLayer('copyright value').attachToMap(map);
+        map.renderSync();
+        const control = new CopyrightControl();
+        // Add control
+        control.attachToMap(map);
+        expect(control.element.parentNode).toBe(map.getTargetElement());
+        // Remove control
+        control.detachFromMap();
+        expect(control.element.parentNode).toBe(null);
+    });
+    test('should add copyrights in the target element then remove it.', () => {
+        getLayer(['copyright value']).attachToMap(map);
+        map.renderSync();
+        const target = document.createElement('div');
+        target.setAttribute('id', 'copyright');
+        document.body.appendChild(target);
+        const control = new CopyrightControl({
+            target: document.getElementById('copyright'),
+        });
+        // Add control
+        control.attachToMap(map);
+        expect(control.element.parentNode).toBe(target);
+        // Remove control
+        control.detachFromMap();
+        expect(control.element.parentNode).toBe(null);
+    });
+    test('renders custom copyrights with the render method ', () => {
+        const control = new CopyrightControl({
+            active: true,
+            render() {
+                if (!this.element) {
+                    return;
+                }
+                this.element.innerHTML = this.active
+                    ? this.getCopyrights().join(', ')
+                    : '';
+            },
+        });
+        control.attachToMap(map);
+        getLayer(['copyright 1', 'copyright 2', 'copyright 3']).attachToMap(map);
+        map.renderSync();
+        // Add control
+        expect(control.element.innerHTML).toBe('copyright 1, copyright 2, copyright 3');
+    });
+});

package/ol/controls/RoutingControl.d.ts

@@ -93,7 +93,7 @@ declare class RoutingControl extends Control implements RoutingInterface {
      */
     private onModifyStart;
     /** @ignore */
-    apiChangeListener: () => Promise<any>;
+    apiChangeListener: () => Promise<any[]> | Promise<void | Feature<import("ol/geom/Geometry").default>> | Promise<Feature<import("ol/geom/Geometry").default> | null> | null;
     /**
      * Adds/Replaces a viaPoint to the viaPoints array and redraws route:
      *   Adds a viaPoint at end of array by default.
@@ -104,7 +104,7 @@ declare class RoutingControl extends Control implements RoutingInterface {
      * @param {number} [index=-1] Integer representing the index of the added viaPoint. If not specified, the viaPoint is added at the end of the array.
      * @param {number} [overwrite=0] Marks the number of viaPoints that are removed at the specified index on add.
      */
-    addViaPoint(coordinatesOrString: any, index?: number, overwrite?: number): void;
+    addViaPoint(coordinatesOrString: any, index?: number | undefined, overwrite?: number | undefined): void;
     /**
      * Removes a viaPoint at the passed array index and redraws route
      * By default the last viaPoint is removed.
@@ -144,9 +144,9 @@ declare class RoutingControl extends Control implements RoutingInterface {
         viaPoint: any;
         oldRoute: any;
         segmentIndex: number;
-    };
+    } | undefined;
     /** @ignore */
-    element: HTMLButtonElement;
+    element: HTMLButtonElement | undefined;
     /**
      * Create the interaction used to modify vertexes of features.
      * @private
@@ -170,11 +170,12 @@ declare class RoutingControl extends Control implements RoutingInterface {
      */
     private removeListeners;
     /** @ignore */
-    format: GeoJSON;
+    format: GeoJSON | undefined;
     /** @ignore */
     graphsResolutions: any;
 }
 import Control from "../../common/controls/Control";
 import { RoutingAPI } from "../../api";
+import { Feature } from "ol";
 import { GeoJSON } from "ol/format";
 //# sourceMappingURL=RoutingControl.d.ts.map

package/ol/controls/RoutingControl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RoutingControl.d.ts","sourceRoot":"","sources":["../../../src/ol/controls/RoutingControl.js"],"names":[],"mappings":";AAiDA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wDAFgB,gBAAgB;IAoH9B;;;;OAIG;IACH,oCAMC;IA5HD,0BA+GC;IAlFC,qDAAqD;IACrD,iBAAoB;IAEpB,cAAc;IACd,YAAgD;IAEhD,cAAc;IACd,SAA+B;IAE/B,cAAc;IACd,gBAAsC;IAEtC,cAAc;IACd,sBAAsD;IAEtD,cAAc;IACd,qBAAuD;IAEvD,cAAc;IACd,0BAAiE;IAEjE,cAAc;IACd,qBAA0B;IAE1B,cAAc;IACd,wBAA0B;IAE1B,cAAc;IACd,YAA4B;IAE5B,cAAc;IACd,iBAAqD;IAErD,cAAc;IACd,gBAAkB;IAElB,cAAc;IACd,iBAA0E;IAE1E,cAAc;IACd,gBAEE;IAEF,cAAc;IACd,kBAKI;IAEJ,cAAc;IACd,kBAUI;IAEJ,cAAc;IACd,iBAAmB;IAoXrB;;;;;OAKG;IACH,mBAeC;IA4CD;;;;;OAKG;IACH,oBAqBC;IArED;;;;OAIG;IACH,sBAmCC;IAxaC,cAAc;IACd,sCAA+C;IAmBjD;;;;;;;;;OASG;IACH,8CAHW,MAAM,cACN,MAAM,QAchB;IAED;;;;OAIG;IACH,uBAFW,MAAM,QAYhB;IAED;;;OAGG;IACH,8BAFW,MAAM,MAAM,MAAM,CAAC,CAAC,QAS9B;IAED;;OAEG;IACH,cASC;IAED;;;OAGG;IACH,sBAeC;IAED;;;;;;OAMG;IACH,kBA0HC;IAED;;;;OAIG;IACH,qBAkHC;IA2DC,cAAc;IACd;;;;MAIC;IAsCD,cAAc;IACd,2BAA+C;IAYjD;;;OAGG;IACH,gCA8BC;IA7BC;;;OAGG;IAEH,0BAoBE;IAMJ;;;OAGG;IACH,qBAOC;IAFC,cAAc;IACd,mBAAgE;IAGlE;;;OAGG;IACH,wBAEC;IAKG,cAAc;IACd,gBAEE;IAEF,cAAc;IACd,uBAGC;CA2BN"}
+{"version":3,"file":"RoutingControl.d.ts","sourceRoot":"","sources":["../../../src/ol/controls/RoutingControl.js"],"names":[],"mappings":";AAiDA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wDAFgB,gBAAgB;IAoH9B;;;;OAIG;IACH,oCAMC;IA5HD,0BA+GC;IAlFC,qDAAqD;IACrD,iBAAoB;IAEpB,cAAc;IACd,YAAgD;IAEhD,cAAc;IACd,SAA+B;IAE/B,cAAc;IACd,gBAAsC;IAEtC,cAAc;IACd,sBAAsD;IAEtD,cAAc;IACd,qBAAuD;IAEvD,cAAc;IACd,0BAAiE;IAEjE,cAAc;IACd,qBAA0B;IAE1B,cAAc;IACd,wBAA0B;IAE1B,cAAc;IACd,YAA4B;IAE5B,cAAc;IACd,iBAAqD;IAErD,cAAc;IACd,gBAAkB;IAElB,cAAc;IACd,iBAA0E;IAE1E,cAAc;IACd,gBAEE;IAEF,cAAc;IACd,kBAKI;IAEJ,cAAc;IACd,kBAUI;IAEJ,cAAc;IACd,iBAAmB;IAoXrB;;;;;OAKG;IACH,mBAeC;IA4CD;;;;;OAKG;IACH,oBAqBC;IArED;;;;OAIG;IACH,sBAmCC;IAxaC,cAAc;IACd,2KAA+C;IAmBjD;;;;;;;;;OASG;IACH,wGAYC;IAED;;;;OAIG;IACH,uBAFW,MAAM,QAYhB;IAED;;;OAGG;IACH,8BAFW,MAAM,MAAM,MAAM,CAAC,CAAC,QAS9B;IAED;;OAEG;IACH,cASC;IAED;;;OAGG;IACH,sBAeC;IAED;;;;;;OAMG;IACH,kBA0HC;IAED;;;;OAIG;IACH,qBAkHC;IA2DC,cAAc;IACd;;;;kBAIC;IAsCD,cAAc;IACd,uCAA+C;IAYjD;;;OAGG;IACH,gCA8BC;IA7BC;;;OAGG;IAEH,0BAoBE;IAMJ;;;OAGG;IACH,qBAOC;IAFC,cAAc;IACd,mBAAgE;IAGlE;;;OAGG;IACH,wBAEC;IAKG,cAAc;IACd,4BAEE;IAEF,cAAc;IACd,uBAGC;CA2BN"}