mobility-toolbox-js 1.6.4-beta.1 → 1.6.4

package/api/routing/RoutingAPI.js

@@ -32,7 +32,7 @@ class RoutingAPI extends API {
    *
    * @param {RoutingSearchParams} params Request parameters. See [Routing service documentation](https://developer.geops.io/apis/routing/).
    * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @returns {Promise<GeoJSONFeatureCollection>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
+   * @return {Promise<GeoJSONFeatureCollection>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
    */
   route(params, abortController = new AbortController()) {
     return this.fetch('', params, {

package/api/stops/StopsAPI.js

@@ -29,7 +29,7 @@ class StopsAPI extends API {
    *
    * @param {StopsSearchParams} params Request parameters. See [Stops service documentation](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
    * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @returns {Promise<Array<GeoJSONFeature>>} An array of GeoJSON features with coordinates in [EPSG:4326](http://epsg.io/4326).
+   * @return {Promise<Array<GeoJSONFeature>>} An array of GeoJSON features with coordinates in [EPSG:4326](http://epsg.io/4326).
    */
   search(params, abortController = {}) {
     return this.fetch('', params, {

package/api/trajserv/TrajservAPI.js

@@ -33,7 +33,7 @@ class TrajservAPI extends API {
    *
    * @param {GetTrajectoryByIdParams} params Request parameters. See [Realtime service documentation](https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/#/default/get_trajectorybyid).
    * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @returns {Promise<TrajservTrajectory>} A trajectory.
+   * @return {Promise<TrajservTrajectory>} A trajectory.
    */
   fetchTrajectoryById(params, abortController = {}) {
     return this.fetch(`/trajectorybyid`, params, {
@@ -46,7 +46,7 @@ class TrajservAPI extends API {
    *
    * @param {GetTrajectoriesParams} params Request parameters. See [Realtime service documentation](https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/#/default/get_trajectory_collection).
    * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @returns {Promise<Array<Trajectory>>} A list of trajectories.
+   * @return {Promise<Array<Trajectory>>} A list of trajectories.
    */
   fetchTrajectories(params, abortController = {}) {
     return this.fetch(`/trajectory_collection`, params, {
@@ -61,7 +61,7 @@ class TrajservAPI extends API {
    *
    * @param {GetTrajectoryStationsParams} params Request parameters. See [Realtime service documentation](https://developer.geops.io/apis/5dcbd5c9a256d90001cf1360/#/default/get_trajstations).
    * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @returns {Promise<Array<TrajectoryStation>>} A list of stations.
+   * @return {Promise<Array<TrajectoryStation>>} A list of stations.
    */
   fetchTrajectoryStations(params, abortController = {}) {
     return this.fetch(`/trajstations`, params, {

package/api/trajserv/TrajservAPIUtils.js

@@ -2,7 +2,7 @@ import { LineString } from 'ol/geom';
 
 /**
  * Translate the response date object into a readable object.
- * @returns {Date[]}
+ * @return {Date[]}
  * @ignore
  */
 const translateDates = (dates = []) => {
@@ -21,7 +21,7 @@ const translateDates = (dates = []) => {
 
 /**
  * Translate the trajstations response into a readable object.
- * @returns {Object} returns a readable object
+ * @return {Object} returns a readable object
  * @private
  */
 export const translateTrajStationsResp = (data) => {
@@ -125,7 +125,7 @@ export const translateTrajStationsResp = (data) => {
 
 /**
  * Translate the trajectory_collection response into a js usable object.
- * @returns {Array} returns an array of trajectories.
+ * @return {Array} returns an array of trajectories.
  * @ignore
  */
 export const translateTrajCollResponse = (features = []) => {

package/api/tralis/TralisAPI.js

@@ -65,7 +65,8 @@ class TralisAPI {
     /** @ignore */
     this.prefix = options.prefix || '';
 
-    this.isUpdateBboxOnMoveEnd = options.isUpdateBboxOnMoveEnd || false;
+    /** @ignore */
+    this.onOpen = this.onOpen.bind(this);
   }
 
   defineProperties(options) {
@@ -80,7 +81,7 @@ class TralisAPI {
     const conn = new WebSocketConnector();
 
     if (apiKey) {
-      url = `${url}?key=${apiKey}`;
+      url = `${url || 'wss://tralis-tracker-api.geops.io/ws'}?key=${apiKey}`;
     }
 
     Object.defineProperties(this, {
@@ -151,16 +152,8 @@ class TralisAPI {
 
   open() {
     this.close();
-    this.conn.connect(this.url);
-
-    // Register BBOX and PROJECTION messages on open.
-    if (this.conn.connecting) {
-      this.conn.websocket.addEventListener('open', () => {
-        this.onOpen();
-      });
-    } else {
-      this.onOpen();
-    }
+    // Register BBOX and PROJECTION messages must be send before previous subscriptions.
+    this.conn.connect(this.url, this.onOpen);
 
     // Register reconnection on close.
     this.conn.websocket.onclose = () => {
@@ -202,7 +195,7 @@ class TralisAPI {
       window.clearInterval(this.pingInterval);
       /** @ignore */
       this.pingInterval = setInterval(() => {
-        this.send('PING');
+        this.conn.send('PING');
       }, this.pingIntervalMs);
     }
   }
@@ -264,7 +257,7 @@ class TralisAPI {
    *
    * @param {Object} depObject The object containing departures by id.
    * @param {boolean} [sortByMinArrivalTime=false] If true sort departures by arrival time.
-   * @returns {Array<departure>} Return departures array.
+   * @return {Array<departure>} Return departures array.
    * @private
    */
   filterDepartures(depObject, sortByMinArrivalTime = false) {
@@ -396,7 +389,7 @@ class TralisAPI {
    *
    * @param {number} uic UIC of the station.
    * @param {TralisMode} mode Tralis mode.
-   * @returns {Promise<Station>} A station.
+   * @return {Promise<Station>} A station.
    */
   getStation(uic, mode) {
     const params = {
@@ -419,7 +412,7 @@ class TralisAPI {
    * Update the model's station list for a given mode and a bbox.
    *
    * @param {TralisMode} mode Tralis mode.
-   * @returns {Promise<Array<Station>>} An array of stations.
+   * @return {Promise<Array<Station>>} An array of stations.
    */
   getStations(mode) {
     const stations = [];
@@ -448,7 +441,6 @@ class TralisAPI {
    * One message pro station.
    *
    * @param {TralisMode} mode Tralis mode.
-   * @param {number[4]} bbox The extent where to request.
    * @param {function(station: Station)} onMessage Function called on each message of the channel.
    */
   subscribeStations(mode, onMessage) {
@@ -507,14 +499,15 @@ class TralisAPI {
    *
    * @param {TralisMode} mode Tralis mode.
    * @param {function(trajectory: TralisTrajectory)} onMessage Function called on each message of the channel.
+   * @param {boolean} quiet If true, the subscription will not send GET and SUB requests to the websocket.
    */
-  subscribeTrajectory(mode, onMessage) {
+  subscribeTrajectory(mode, onMessage, quiet = false) {
     this.unsubscribeTrajectory(onMessage);
     this.subscribe(
       `trajectory${getModeSuffix(mode, TralisModes)}`,
       onMessage,
       null,
-      this.isUpdateBboxOnMoveEnd,
+      quiet,
     );
   }
 
@@ -531,14 +524,15 @@ class TralisAPI {
    *
    * @param {TralisMode} mode Tralis mode.
    * @param {function(response: { content: Vehicle })} onMessage Function called on each message of the channel.
+   * @param {boolean} quiet If true, the subscription will not send GET and SUB requests to the websocket.
    */
-  subscribeDeletedVehicles(mode, onMessage) {
+  subscribeDeletedVehicles(mode, onMessage, quiet = false) {
     this.unsubscribeDeletedVehicles(onMessage);
     this.subscribe(
       `deleted_vehicles${getModeSuffix(mode, TralisModes)}`,
       onMessage,
       null,
-      this.isUpdateBboxOnMoveEnd,
+      quiet,
     );
   }
 
@@ -555,11 +549,21 @@ class TralisAPI {
    *
    * @param {string} id A vehicle id.
    * @param {TralisMode} mode Tralis mode.
-   * @returns {Promise<FullTrajectory>} Return a full trajectory.
+   * @param {string} generalizationLevel The generalization level to request. Can be one of 5 (more generalized), 10, 30, 100, undefined (less generalized).
+   * @return {Promise<FullTrajectory>} Return a full trajectory.
    */
-  getFullTrajectory(id, mode) {
+  getFullTrajectory(id, mode, generalizationLevel) {
+    const channel = [`full_trajectory${getModeSuffix(mode, TralisModes)}`];
+    if (id) {
+      channel.push(id);
+    }
+
+    if ((!mode || mode === TralisModes.TOPOGRAPHIC) && generalizationLevel) {
+      channel.push(`gen${generalizationLevel}`);
+    }
+
     const params = {
-      channel: `full_trajectory${getModeSuffix(mode, TralisModes)}_${id}`,
+      channel: channel.join('_'),
     };
 
     return new Promise((resolve) => {
@@ -576,11 +580,12 @@ class TralisAPI {
    *
    * @param {string[]} ids List of vehicles ids.
    * @param {TralisMode} mode Tralis mode.
-   * @returns {Promise<Array<FullTrajectory>>} Return an array of full trajectories.
+   * @param {string} generalizationLevel The generalization level to request. Can be one of '', 'gen5', 'gen10', 'gen30', 'gen100'.
+   * @return {Promise<Array<FullTrajectory>>} Return an array of full trajectories.
    */
-  getFullTrajectories(ids, mode) {
+  getFullTrajectories(ids, mode, generalizationLevel) {
     const promises = ids.map((id) => {
-      return this.getFullTrajectory(id, mode);
+      return this.getFullTrajectory(id, mode, generalizationLevel);
     });
     return Promise.all(promises);
   }
@@ -621,7 +626,7 @@ class TralisAPI {
    * Get the list of stops for this vehicle.
    *
    * @param {string} id A vehicle id.
-   * @returns {Promise<StopSequence>} Returns a stop sequence object.
+   * @return {Promise<StopSequence>} Returns a stop sequence object.
    */
   getStopSequence(id) {
     const params = {
@@ -652,7 +657,7 @@ class TralisAPI {
    * Get a list of stops for a list of vehicles.
    *
    * @param {string[]} ids List of vehicles ids.
-   * @returns {Promise<Array<StopSequence>>} Return an array of stop sequences.
+   * @return {Promise<Array<StopSequence>>} Return an array of stop sequences.
    */
   getStopSequences(ids) {
     const promises = ids.map((id) => {

package/api/tralis/TralisAPI.test.js

@@ -0,0 +1,75 @@
+import { TralisAPI, TralisModes } from '..';
+
+describe('TralisAPI', () => {
+  let tralisAPI;
+  let get;
+
+  beforeEach(() => {
+    get = jest.fn((params, cb) => {
+      cb({ content: 'content' });
+    });
+    tralisAPI = new TralisAPI();
+    tralisAPI.conn = {
+      get,
+    };
+  });
+
+  describe('#getFullTrajectory() calls fullTrajectory channel', () => {
+    test('without parameters', (done) => {
+      tralisAPI.getFullTrajectory().then(() => {
+        expect(get.mock.calls.length).toBe(1);
+        expect(get.mock.calls[0][0]).toEqual({
+          channel: 'full_trajectory',
+        });
+        done();
+      });
+    });
+
+    [null, TralisModes.TOPOGRAPHIC].forEach((mode) => {
+      describe(`using mode ${mode}`, () => {
+        test('using id', (done) => {
+          tralisAPI.getFullTrajectory('foo', mode).then(() => {
+            expect(get.mock.calls.length).toBe(1);
+            expect(get.mock.calls[0][0]).toEqual({
+              channel: 'full_trajectory_foo',
+            });
+            done();
+          });
+        });
+
+        test('using id and generalizationLevel param', (done) => {
+          tralisAPI.getFullTrajectory('foo', mode, 5).then(() => {
+            expect(get.mock.calls.length).toBe(1);
+            expect(get.mock.calls[0][0]).toEqual({
+              channel: 'full_trajectory_foo_gen5',
+            });
+            done();
+          });
+        });
+      });
+    });
+
+    describe('using schematic mode ', () => {
+      test('using id', (done) => {
+        tralisAPI.getFullTrajectory('foo', TralisModes.SCHEMATIC).then(() => {
+          expect(get.mock.calls.length).toBe(1);
+          expect(get.mock.calls[0][0]).toEqual({
+            channel: 'full_trajectory_schematic_foo',
+          });
+          done();
+        });
+      });
+      test("doesn't use generalizationLevel param", (done) => {
+        tralisAPI
+          .getFullTrajectory('foo', TralisModes.SCHEMATIC, 10)
+          .then(() => {
+            expect(get.mock.calls.length).toBe(1);
+            expect(get.mock.calls[0][0]).toEqual({
+              channel: 'full_trajectory_schematic_foo',
+            });
+            done();
+          });
+      });
+    });
+  });
+});

package/api/tralis/WebSocketConnector.js

@@ -82,7 +82,7 @@ class WebSocketConnector {
    * @param {string} params.channel Channel name
    * @param {string} [params.args] Request arguments
    * @param {Number} [params.id] Request identifier
-   * @returns {string} request string
+   * @return {string} request string
    * @private
    */
   static getRequestString(method, params) {
@@ -95,9 +95,11 @@ class WebSocketConnector {
   /**
    * (Re)connect the websocket.
    *
+   * @param {strin} url Websocket url.
+   * @param {function} onOpen Callback called when the websocket connection is opened and before subscriptions of previous subscriptions.
    * @private
    */
-  connect(url) {
+  connect(url, onOpen = () => {}) {
     if (this.websocket && !this.closed) {
       this.websocket.close();
     }
@@ -107,9 +109,11 @@ class WebSocketConnector {
 
     if (!this.open) {
       this.websocket.addEventListener('open', () => {
+        onOpen();
         this.subscribePreviousSubscriptions();
       });
     } else {
+      onOpen();
       this.subscribePreviousSubscriptions();
     }
   }
@@ -124,6 +128,7 @@ class WebSocketConnector {
       this.websocket.onclose = null;
       this.websocket.close();
       this.websocket = null;
+      this.messagesOnOpen = [];
     }
   }
 
@@ -148,6 +153,9 @@ class WebSocketConnector {
           this.messagesOnOpen = [];
           send();
         });
+        this.websocket.addEventListener('close', () => {
+          this.messagesOnOpen = [];
+        });
       }
     } else if (!this.messagesOnOpen.includes(message)) {
       send();
@@ -160,7 +168,7 @@ class WebSocketConnector {
    * @param {Object} params Parameters for the websocket get request
    * @param {function} cb callback on listen
    * @param {function} errorCb Callback on error
-   * @returns {{onMessage: function, errorCb: function}} Object with onMessage and error callbacks
+   * @return {{onMessage: function, errorCb: function}} Object with onMessage and error callbacks
    * @private
    */
   listen(params, cb, errorCb) {
@@ -260,7 +268,6 @@ class WebSocketConnector {
         this.send(`GET ${reqStr}`);
         this.send(`SUB ${reqStr}`);
       }
-
       this.subscribed[reqStr] = true;
     }
   }
@@ -307,6 +314,13 @@ class WebSocketConnector {
    * After an auto reconnection we need to re-subscribe to the channels.
    */
   subscribePreviousSubscriptions() {
+    // Before to subscribe previous subscriptions we make sure they
+    // are all defined as unsubscribed, because this code is asynchrone
+    // and a subscription could have been added in between.
+    Object.keys(this.subscribed).forEach((key) => {
+      this.subscribed[key] = false;
+    });
+
     // Subscribe all previous subscriptions.
     [...this.subscriptions].forEach((s) => {
       this.subscribe(s.params, s.cb, s.errorCb, s.quiet);

package/api/tralis/WebSocketConnector.test.js

@@ -28,6 +28,31 @@ describe('WebSocketConnector', () => {
       });
     });
 
+    describe('#close', () => {
+      test('should close the websocket and clear some property', async () => {
+        // eslint-disable-next-line no-unused-vars
+        const client = new Connector();
+        const subsc2 = {
+          params: 'foo',
+          cb: () => {},
+          errorCb: () => {},
+          quiet: false,
+        };
+        client.subscriptions = [subsc2];
+        client.messagesOnOpen = ['GET foo'];
+        client.connect(`ws://foo:1234`);
+        client.websocket.addEventListener = jest.fn();
+        client.websocket.removeEventListener = jest.fn();
+        client.websocket.close = jest.fn();
+        await server.connected;
+        expect(client.websocket).toBeDefined();
+        expect(client.messagesOnOpen).toEqual(['GET foo']);
+        client.close();
+        expect(client.messagesOnOpen).toEqual([]);
+        expect(client.websocket).toBeNull();
+      });
+    });
+
     describe('#connect', () => {
       test('create a new WebSocket.', async () => {
         const client = new Connector();
@@ -50,23 +75,44 @@ describe('WebSocketConnector', () => {
         expect(client.websocket.readyState).toBe(WebSocket.CONNECTING);
       });
 
-      test('subscribe previous subscriptions on open', async () => {
+      test('call onOpen function', async () => {
+        const onOpen = jest.fn();
         const client = new Connector();
         client.subscribe = jest.fn();
-        client.connect(`ws://foo:1234`);
+        client.connect(`ws://foo:1234`, onOpen);
         await server.connected;
         expect(client.websocket.readyState).toBe(WebSocket.OPEN);
+        expect(onOpen).toHaveBeenCalledTimes(1);
+      });
+
+      test('subscribe previous subscriptions on open (quiet or not)', async () => {
+        const client = new Connector();
+        client.subscribe = jest.fn();
+        client.send = jest.fn();
         const subsc = {
           params: 'foo',
           cb: () => {},
           errorCb: () => {},
           quiet: true,
         };
-        client.subscriptions = [subsc];
+        const subsc2 = {
+          params: 'foo',
+          cb: () => {},
+          errorCb: () => {},
+          quiet: false,
+        };
+        client.subscriptions = [subsc, subsc2];
+
+        client.connect(`ws://foo:1234`);
+        await server.connected;
+        expect(client.websocket.readyState).toBe(WebSocket.OPEN);
+        expect(client.subscribe).toHaveBeenCalledTimes(2);
+        client.subscribe.mockReset();
+
         client.connect(`ws://foo:12345`);
         await server2.connected;
         expect(client.websocket.readyState).toBe(WebSocket.OPEN);
-        expect(client.subscribe).toHaveBeenCalledTimes(1);
+        expect(client.subscribe).toHaveBeenCalledTimes(2);
         expect(client.subscribe).toHaveBeenCalledWith(
           subsc.params,
           subsc.cb,
@@ -74,6 +120,66 @@ describe('WebSocketConnector', () => {
           subsc.quiet,
         );
       });
+
+      test('send GET and SUB for not quiet previous subscriptions', async () => {
+        const client = new Connector();
+        client.send = jest.fn();
+        const subsc = {
+          params: { channel: 'foo' },
+          cb: () => {},
+          errorCb: () => {},
+          quiet: false,
+        };
+        client.subscriptions = [subsc];
+
+        client.connect(`ws://foo:1234`);
+        client.websocket.addEventListener = jest.fn();
+        client.websocket.removeEventListener = jest.fn();
+        await server.connected;
+        expect(client.websocket.readyState).toBe(WebSocket.OPEN);
+        expect(client.send).toHaveBeenCalledTimes(2);
+        expect(client.send.mock.calls[0]).toEqual(['GET foo']);
+        expect(client.send.mock.calls[1]).toEqual(['SUB foo']);
+        client.send.mockReset();
+
+        client.connect(`ws://foo:12345`);
+        client.websocket.addEventListener = jest.fn();
+        client.websocket.removeEventListener = jest.fn();
+        await server2.connected;
+        expect(client.websocket.readyState).toBe(WebSocket.OPEN);
+        // not quiet subscriptions will send GET and SUB requests.
+        expect(client.send).toHaveBeenCalledTimes(2);
+        expect(client.send.mock.calls[0]).toEqual(['GET foo']);
+        expect(client.send.mock.calls[1]).toEqual(['SUB foo']);
+      });
+
+      test('doesn\t send GET and SUB for quiet previous subscriptions', async () => {
+        const client = new Connector();
+        client.send = jest.fn();
+        const subsc = {
+          params: { channel: 'foo' },
+          cb: () => {},
+          errorCb: () => {},
+          quiet: true,
+        };
+        client.subscriptions = [subsc];
+
+        client.connect(`ws://foo:1234`);
+        client.websocket.addEventListener = jest.fn();
+        client.websocket.removeEventListener = jest.fn();
+        await server.connected;
+        expect(client.websocket.readyState).toBe(WebSocket.OPEN);
+        expect(client.send).toHaveBeenCalledTimes(0);
+        client.send.mockReset();
+
+        client.connect(`ws://foo:12345`);
+        client.websocket.addEventListener = jest.fn();
+        client.websocket.removeEventListener = jest.fn();
+        await server2.connected;
+        expect(client.websocket.readyState).toBe(WebSocket.OPEN);
+        // not quiet subscriptions will send GET and SUB requests.
+        expect(client.send).toHaveBeenCalledTimes(0);
+      });
     });
 
     describe('#subscribe', () => {
@@ -199,7 +305,11 @@ describe('WebSocketConnector', () => {
         client.subscribe(params2, cb2);
         expect(client.subscriptions.length).toBe(3);
         expect(client.websocket.removeEventListener).toBeCalledTimes(2);
-        expect(client.websocket.addEventListener).toBeCalledTimes(9);
+        expect(
+          client.websocket.addEventListener.mock.calls.filter(
+            (c) => c[0] === 'message',
+          ).length,
+        ).toBe(5);
 
         client.unsubscribe('foo');
         expect(client.subscriptions.length).toBe(1);

package/common/Tracker.js

@@ -123,7 +123,7 @@ export default class Tracker {
 
   /**
    * Return the trajectories.
-   * @returns {array<trajectory>} trajectories
+   * @return {array<trajectory>} trajectories
    */
   getTrajectories() {
     return this.trajectories || [];
@@ -203,6 +203,8 @@ export default class Tracker {
     for (let i = (this.trajectories || []).length - 1; i >= 0; i -= 1) {
       const traj = this.trajectories[i];
 
+      this.trajectories[i].rendered = false;
+
       // We simplify the traj object
       const { geometry, timeIntervals, timeOffset } = traj;
 
@@ -293,16 +295,26 @@ export default class Tracker {
           return p * pixelRatio;
         });
 
-        // Trajectory with pixel (i.e. within map extent) will be in renderedTrajectories.
-        this.trajectories[i].rendered = true;
-        this.renderedTrajectories.push(this.trajectories[i]);
-        const vehicleImg = this.style(traj, viewState);
+        if (
+          px[0] < 0 ||
+          px[0] > this.canvas.width ||
+          px[1] < 0 ||
+          px[1] > this.canvas.height
+        ) {
+          // eslint-disable-next-line no-continue
+          continue;
+        }
 
+        const vehicleImg = this.style(traj, viewState);
         if (!vehicleImg) {
           // eslint-disable-next-line no-continue
           continue;
         }
 
+        // Trajectory with pixel (i.e. within map extent) will be in renderedTrajectories.
+        this.trajectories[i].rendered = true;
+        this.renderedTrajectories.push(this.trajectories[i]);
+
         const imgWidth = vehicleImg.width;
         const imgHeight = vehicleImg.height;
 

package/common/layers/Layer.js

@@ -186,7 +186,7 @@ export default class Layer extends Observable {
    * Get a layer property.
    *
    * @param {string} name Property name.
-   * @returns {property} Property
+   * @return {property} Property
    */
   get(name) {
     return this.properties[name];
@@ -239,7 +239,7 @@ export default class Layer extends Observable {
   /**
    * Returns an array with visible child layers
    *
-   * @returns {Layer[]} Visible children
+   * @return {Layer[]} Visible children
    */
   getVisibleChildren() {
     return this.children.filter((child) => child.visible);
@@ -248,7 +248,7 @@ export default class Layer extends Observable {
   /**
    * Checks whether the layer has child layers with visible set to True
    *
-   * @returns {boolean} True if the layer has visible child layers
+   * @return {boolean} True if the layer has visible child layers
    * @deprecated
    */
   hasVisibleChildren() {
@@ -259,7 +259,7 @@ export default class Layer extends Observable {
    * Checks whether the layer has any child layers with visible equal to the input parameter
    *
    * @param {boolean} visible The state to check the childlayers against
-   * @returns {boolean} True if the layer has children with the given visibility
+   * @return {boolean} True if the layer has children with the given visibility
    */
   hasChildren(visible) {
     return !!this.children.find((child) => child.visible === visible);
@@ -302,7 +302,7 @@ export default class Layer extends Observable {
    *
    * @param {ol/coordinate~Coordinate} coordinate Coordinate.
    * @param {Object} options Some options. See child classes to see which are supported.
-   * @returns {Promise<FeatureInfo>} An empty response.
+   * @return {Promise<FeatureInfo>} An empty response.
    */
   // eslint-disable-next-line no-unused-vars
   getFeatureInfoAtCoordinate(coordinate, options) {

package/common/mixins/CopyrightMixin.js

@@ -9,7 +9,7 @@ export class CopyrightInterface {
   /**
    * Return an array of layer's copyright.
    *
-   * @returns {String[]} A list of copyrights to render.
+   * @return {String[]} A list of copyrights to render.
    */
   getCopyrights() {}
 }