mobility-toolbox-js 2.0.0 → 2.0.1-beta.13

package/common/trackerConfig.test.js

@@ -1,25 +1,23 @@
-import { getTypeIndex } from './trackerConfig';
-
-describe('trackerConfig', () => {
-  describe('#getTypeIndex()', () => {
+import { getTypeIndex } from "./trackerConfig";
+describe("trackerConfig", () => {
+  describe("#getTypeIndex()", () => {
     test("retrurn the type is it's not a string", () => {
-      const obj = { foo: 'foo' };
+      const obj = { foo: "foo" };
       expect(getTypeIndex(obj)).toBe(obj);
       expect(getTypeIndex(0)).toBe(0);
       expect(getTypeIndex(null)).toBe(null);
-      expect(getTypeIndex(undefined)).toBe(undefined);
+      expect(getTypeIndex(void 0)).toBe(void 0);
     });
-
-    test('find good index for new tracker values', () => {
-      expect(getTypeIndex('tram')).toBe(0);
-      expect(getTypeIndex('subway')).toBe(1);
-      expect(getTypeIndex('bus')).toBe(3);
-      expect(getTypeIndex('ferry')).toBe(4);
-      expect(getTypeIndex('cablecar')).toBe(5);
-      expect(getTypeIndex('gondola')).toBe(6);
-      expect(getTypeIndex('funicular')).toBe(7);
-      expect(getTypeIndex('coach')).toBe(8);
-      expect(getTypeIndex('rail')).toBe(9);
+    test("find good index for new tracker values", () => {
+      expect(getTypeIndex("tram")).toBe(0);
+      expect(getTypeIndex("subway")).toBe(1);
+      expect(getTypeIndex("bus")).toBe(3);
+      expect(getTypeIndex("ferry")).toBe(4);
+      expect(getTypeIndex("cablecar")).toBe(5);
+      expect(getTypeIndex("gondola")).toBe(6);
+      expect(getTypeIndex("funicular")).toBe(7);
+      expect(getTypeIndex("coach")).toBe(8);
+      expect(getTypeIndex("rail")).toBe(9);
     });
   });
 });

package/common/typedefs.js

@@ -1,23 +0,0 @@
-/**
- * @typedef {function} FilterFunction
- * @param {Object} vehicle Vehicle to filter.
- */
-
-/**
- * @typedef {Object} ViewState
- * @property {number} time A time in ms.
- * @property {number[2]} center A center in mercator coordinate.
- * @property {number[4]} extent An Extent in mercator coordinates.
- * @property {number[2]} size A size ([width, height]).
- * @property {number} rotation A rotation in radians.
- * @property {number} resolution A resolution.
- * @property {number} zoom A zoom level.
- * @property {number} pixelRatio A pixel ratio.
- */
-
-/**
- * @typedef {Object} FeatureInfo
- * @property {Layer} layer A layer.
- * @property {ol/Feature~Feature[]} features  An array of features.
- * @property {number[2]} coordinate The coordinate where to find the featue.
- */

package/common/utils/createTrackerFilters.js

@@ -1,45 +1,25 @@
-/**
- * Return a filter functions based on some parameters of a vehicle.
- *
- * @param {string|Array<string>} line - A list of vehicle's name to filter. Names can be separated by a comma. Ex: 'S1,S2,S3'
- * @param {string|Array<string} route - A list of vehicle's route (contained in routeIdentifier property) to filter. Indentifiers can be separated by a comma. Ex: 'id1,id2,id3'
- * @param {string|Array<string} operator  A list of vehicle's operator to filter. Operators can be separated by a comma. Ex: 'SBB,DB'
- * @param {Regexp} regexLine - A regex aplly of vehcile's name.
- * @private
- */
 const createFilters = (line, route, operator, regexLine) => {
   const filterList = [];
-
   if (!line && !route && !operator && !regexLine) {
     return null;
   }
-
   if (regexLine) {
-    const regexLineList =
-      typeof regexLine === 'string' ? [regexLine] : regexLine;
+    const regexLineList = typeof regexLine === "string" ? [regexLine] : regexLine;
     const lineFilter = (item) => {
-      const name =
-        item.properties.name ||
-        (item.properties.line && item.properties.line.name) ||
-        '';
+      const name = item.properties.name || item.properties.line && item.properties.line.name || "";
       if (!name) {
         return false;
       }
-      return regexLineList.some((regexStr) =>
-        new RegExp(regexStr, 'i').test(name),
-      );
+      return regexLineList.some((regexStr) => new RegExp(regexStr, "i").test(name));
     };
     filterList.push(lineFilter);
   }
-
   if (line) {
-    const lineFiltersList = typeof line === 'string' ? line.split(',') : line;
-    const lineList = lineFiltersList.map((l) =>
-      l.replace(/\s+/g, '').toUpperCase(),
-    );
+    const lineFiltersList = typeof line === "string" ? line.split(",") : line;
+    const lineList = lineFiltersList.map((l) => l.replace(/\s+/g, "").toUpperCase());
     const lineFilter = (item) => {
       const { line: linee, name } = item.properties;
-      const lineName = (name || (linee && linee.name) || '').toUpperCase();
+      const lineName = (name || linee && linee.name || "").toUpperCase();
       if (!lineName) {
         return false;
       }
@@ -47,33 +27,23 @@ const createFilters = (line, route, operator, regexLine) => {
     };
     filterList.push(lineFilter);
   }
-
   if (route) {
-    const routes = typeof route === 'string' ? route.split(',') : route;
+    const routes = typeof route === "string" ? route.split(",") : route;
     const routeList = routes.map((item) => parseInt(item, 10));
     const routeFilter = (item) => {
-      const routeId = parseInt(
-        item.properties.routeIdentifier.split('.')[0],
-        10,
-      );
+      const routeId = parseInt(item.properties.routeIdentifier.split(".")[0], 10);
       return routeList.includes(routeId);
     };
     filterList.push(routeFilter);
   }
-
   if (operator) {
-    const operatorList = typeof operator === 'string' ? [operator] : operator;
-    const operatorFilter = (item) =>
-      operatorList.some((op) =>
-        new RegExp(op, 'i').test(item.properties.operator),
-      );
+    const operatorList = typeof operator === "string" ? [operator] : operator;
+    const operatorFilter = (item) => operatorList.some((op) => new RegExp(op, "i").test(item.properties.operator));
     filterList.push(operatorFilter);
   }
-
   if (!filterList.length) {
     return null;
   }
-
   return (t) => {
     for (let i = 0; i < filterList.length; i += 1) {
       if (!filterList[i](t)) {
@@ -83,5 +53,4 @@ const createFilters = (line, route, operator, regexLine) => {
     return true;
   };
 };
-
 export default createFilters;

package/common/utils/createTrackerFilters.test.js

@@ -1,93 +1,77 @@
-import createTrackerFilters from './createTrackerFilters';
-
+import createTrackerFilters from "./createTrackerFilters";
 const u1 = {
   properties: {
-    routeIdentifier: '001.000827.004:7',
-    operator: 'FoO',
+    routeIdentifier: "001.000827.004:7",
+    operator: "FoO",
     line: {
-      name: 'U1',
-    },
-  },
+      name: "U1"
+    }
+  }
 };
 const ireta = {
   properties: {
-    routeIdentifier: '0022.000827.004:7',
-    operator: 'BAR',
+    routeIdentifier: "0022.000827.004:7",
+    operator: "BAR",
     line: {
-      name: 'IRETA',
-    },
-  },
+      name: "IRETA"
+    }
+  }
 };
 const arb = {
   properties: {
-    routeIdentifier: '00333.000827.004:7',
-    operator: 'qux',
+    routeIdentifier: "00333.000827.004:7",
+    operator: "qux",
     line: {
-      name: 'ARB',
-    },
-  },
+      name: "ARB"
+    }
+  }
 };
-
 const trajectories = [u1, ireta, arb];
-
-describe('#createTrackerFilter()', () => {
-  test('returns null', () => {
+describe("#createTrackerFilter()", () => {
+  test("returns null", () => {
     const filterFunc = createTrackerFilters();
     expect(filterFunc).toBe(null);
   });
-
-  describe('using line', () => {
-    test('as string', () => {
-      const filterFunc = createTrackerFilters('u1,foo');
+  describe("using line", () => {
+    test("as string", () => {
+      const filterFunc = createTrackerFilters("u1,foo");
       expect(trajectories.filter(filterFunc)).toEqual([u1]);
     });
-
-    test('as array of string', () => {
-      const filterFunc = createTrackerFilters(['u1', 'foo', 'IRETA']);
+    test("as array of string", () => {
+      const filterFunc = createTrackerFilters(["u1", "foo", "IRETA"]);
       expect(trajectories.filter(filterFunc)).toEqual([u1, ireta]);
     });
   });
-
-  describe('using route identifier', () => {
-    test('as string', () => {
-      const filterFunc = createTrackerFilters(null, '1,foo');
+  describe("using route identifier", () => {
+    test("as string", () => {
+      const filterFunc = createTrackerFilters(null, "1,foo");
       expect(trajectories.filter(filterFunc)).toEqual([u1]);
     });
-
-    test('as array of string', () => {
-      const filterFunc = createTrackerFilters(null, ['22', 'foo', '1']);
+    test("as array of string", () => {
+      const filterFunc = createTrackerFilters(null, ["22", "foo", "1"]);
       expect(trajectories.filter(filterFunc)).toEqual([u1, ireta]);
     });
   });
-
-  describe('using operator', () => {
-    test('as string', () => {
-      const filterFunc = createTrackerFilters(null, null, 'foo');
+  describe("using operator", () => {
+    test("as string", () => {
+      const filterFunc = createTrackerFilters(null, null, "foo");
       expect(trajectories.filter(filterFunc)).toEqual([u1]);
     });
-
-    test('as array of string', () => {
-      const filterFunc = createTrackerFilters(null, null, ['bar', 'foo', '1']);
+    test("as array of string", () => {
+      const filterFunc = createTrackerFilters(null, null, ["bar", "foo", "1"]);
       expect(trajectories.filter(filterFunc)).toEqual([u1, ireta]);
     });
   });
-
-  describe('using regexLine', () => {
-    test('as string', () => {
-      const filterFunc = createTrackerFilters(
-        null,
-        null,
-        null,
-        '^(S|R$|RE|PE|D|IRE|RB|TER)',
-      );
+  describe("using regexLine", () => {
+    test("as string", () => {
+      const filterFunc = createTrackerFilters(null, null, null, "^(S|R$|RE|PE|D|IRE|RB|TER)");
       expect(trajectories.filter(filterFunc)).toEqual([ireta]);
     });
-
-    test('as array of string', () => {
+    test("as array of string", () => {
       const filterFunc = createTrackerFilters(null, null, null, [
-        '^IR',
-        '^ARB$',
-        'foo',
+        "^IR",
+        "^ARB$",
+        "foo"
       ]);
       expect(trajectories.filter(filterFunc)).toEqual([ireta, arb]);
     });

package/common/utils/getMapboxMapCopyrights.js

@@ -1,32 +1,19 @@
-import removeDuplicate from './removeDuplicate';
-
-/**
- * Return the copyright a Mapbox map.
- * @param {mapboxgl.Map} map A Mapbox map
- * @ignore
- */
+import removeDuplicate from "./removeDuplicate";
 const getMapboxMapCopyrights = (map) => {
   if (!map || !map.style) {
     return [];
   }
   const { sourceCaches } = map.style;
   let copyrights = [];
-
   Object.values(sourceCaches).forEach((sourceCache) => {
     if (sourceCache.used) {
       const source = sourceCache.getSource();
-      const attribution =
-        source.attribution || (source.options && source.options.attribution);
-
+      const attribution = source.attribution || source.options && source.options.attribution;
       if (attribution) {
-        copyrights = copyrights.concat(
-          attribution.replace(/&copy;/g, '©').split(/(<a.*?<\/a>)/),
-        );
+        copyrights = copyrights.concat(attribution.replace(/&copy;/g, "\xA9").split(/(<a.*?<\/a>)/));
       }
     }
   });
-
   return removeDuplicate(copyrights);
 };
-
 export default getMapboxMapCopyrights;

package/common/utils/getMapboxMapCopyrights.test.js

@@ -1,47 +1,40 @@
-import getMapboxMapCopyrights from './getMapboxMapCopyrights';
-
-describe('getMapboxMapCopyrights()', () => {
-  test('returns an empty array if map is not defined', () => {
+import getMapboxMapCopyrights from "./getMapboxMapCopyrights";
+describe("getMapboxMapCopyrights()", () => {
+  test("returns an empty array if map is not defined", () => {
     expect(getMapboxMapCopyrights().length).toBe(0);
   });
-
-  test('returns an empty array if map.style is not defined', () => {
+  test("returns an empty array if map.style is not defined", () => {
     expect(getMapboxMapCopyrights({}).length).toBe(0);
   });
-
-  test('returns non depluicated copyrights in an array', () => {
-    expect(
-      getMapboxMapCopyrights({
-        style: {
-          sourceCaches: {
-            used: {
-              used: true,
-              getSource() {
-                return {
-                  attribution:
-                    '<a href="https://www.openmaptiles.org/" target="_blank">© OpenMapTiles</a> <a href="https://www.openstreetmap.org/about/" target="_blank">&copy; OpenStreetMap contributors</a>',
-                };
-              },
-            },
-            'not used': {
-              used: false,
-            },
-            'also used': {
-              used: true,
-              getSource() {
-                return {
-                  attribution:
-                    '<a href="https://www.openmaptiles.org/" target="_blank">&copy; OpenMapTiles</a> <a href="https://www.imagico.de/" target="_blank">&copy; imagico</a>',
-                };
-              },
-            },
+  test("returns non depluicated copyrights in an array", () => {
+    expect(getMapboxMapCopyrights({
+      style: {
+        sourceCaches: {
+          used: {
+            used: true,
+            getSource() {
+              return {
+                attribution: '<a href="https://www.openmaptiles.org/" target="_blank">\xA9 OpenMapTiles</a> <a href="https://www.openstreetmap.org/about/" target="_blank">&copy; OpenStreetMap contributors</a>'
+              };
+            }
           },
-        },
-      }),
-    ).toEqual([
-      '<a href="https://www.openmaptiles.org/" target="_blank">© OpenMapTiles</a>',
-      '<a href="https://www.openstreetmap.org/about/" target="_blank">© OpenStreetMap contributors</a>',
-      '<a href="https://www.imagico.de/" target="_blank">© imagico</a>',
+          "not used": {
+            used: false
+          },
+          "also used": {
+            used: true,
+            getSource() {
+              return {
+                attribution: '<a href="https://www.openmaptiles.org/" target="_blank">&copy; OpenMapTiles</a> <a href="https://www.imagico.de/" target="_blank">&copy; imagico</a>'
+              };
+            }
+          }
+        }
+      }
+    })).toEqual([
+      '<a href="https://www.openmaptiles.org/" target="_blank">\xA9 OpenMapTiles</a>',
+      '<a href="https://www.openstreetmap.org/about/" target="_blank">\xA9 OpenStreetMap contributors</a>',
+      '<a href="https://www.imagico.de/" target="_blank">\xA9 imagico</a>'
     ]);
   });
 });

package/common/utils/getMapboxStyleUrl.js

@@ -1,12 +1,4 @@
-import qs from 'query-string';
-
-/**
- * Return the styleUrl with apiKey parameters set.
- * @param {string} apiKey apiKey value for the mapbox request.
- * @param {string} apiKeyName parameter name for apiKey in the mapbox request.
- * @param {string} styleUrl mapbox styleUrl value.
- * @ignore
- */
+import qs from "query-string";
 const getMapboxStyleUrl = (apiKey, apiKeyName, styleUrl) => {
   if (apiKey === false) {
     return styleUrl;
@@ -16,7 +8,6 @@ const getMapboxStyleUrl = (apiKey, apiKeyName, styleUrl) => {
     return styleUrl;
   }
   if (!apiKey) {
-    // eslint-disable-next-line no-console
     console.warn(`No apiKey is defined for request to ${styleUrl}`);
     return null;
   }
@@ -24,9 +15,8 @@ const getMapboxStyleUrl = (apiKey, apiKeyName, styleUrl) => {
     ...parsedStyle,
     query: {
       ...parsedStyle.query,
-      [apiKeyName]: apiKey,
-    },
+      [apiKeyName]: apiKey
+    }
   });
 };
-
 export default getMapboxStyleUrl;

package/common/utils/getVehiclePosition.js

@@ -1,23 +1,12 @@
-import GeomType from 'ol/geom/GeometryType';
-
-/**
- * Interpolate or not the vehicle position from a trajectory at a specific date.
- *
- * @param {number} now Current date to interpolate a position with. In ms.
- * @param {TralisTrajectory} trajectory The trajectory to interpolate.
- * @param {boolean} noInterpolate If true, the vehicle position is not interpolated on each render but only once.
- * @returns
- */
+import GeomType from "ol/geom/GeometryType";
 const getVehiclePosition = (now, trajectory, noInterpolate) => {
   const {
     time_intervals: timeIntervals,
     olGeometry: geometry,
-    coordinate,
+    coordinate
   } = trajectory.properties;
-
   let coord;
   let rotation;
-
   if (noInterpolate && coordinate) {
     coord = coordinate;
   } else if (geometry.getType() === GeomType.POINT) {
@@ -26,30 +15,17 @@ const getVehiclePosition = (now, trajectory, noInterpolate) => {
     const intervals = timeIntervals || [[]];
     const firstInterval = intervals[0];
     const lastInterval = intervals[intervals.length - 1];
-
-    // Between the last time interval of a trajectory event and the beginning
-    // of the new trajectory event, there is few seconds, can be 6 to 30
-    // seconds (that's why the vehicle jumps sometimes).
-    // So we make the choice here to display the last (or the first) position
-    // of an trajectory event instead of removing them, if the current date is
-    // outside the time intervals we display the vehicle at the last (or first) position known.
     if (now < firstInterval[0]) {
-      // Display first position known.
       [, , rotation] = firstInterval;
       coord = geometry.getFirstCoordinate();
     } else if (now > lastInterval[0]) {
-      // Display last position known.
       [, , rotation] = lastInterval;
       coord = geometry.getLastCoordinate();
     } else {
-      // Interpolate position using time intervals.
       for (let j = 0; j < intervals.length - 1; j += 1) {
-        // Rotation only available in tralis layer.
         const [start, startFrac] = intervals[j];
         const [end, endFrac] = intervals[j + 1];
-
         if (start <= now && now <= end) {
-          // interpolate position inside the time interval.
           const timeFrac = Math.min((now - start) / (end - start), 1);
           const geomFrac = timeFrac * (endFrac - startFrac) + startFrac;
           coord = geometry.getCoordinateAt(geomFrac);
@@ -59,14 +35,8 @@ const getVehiclePosition = (now, trajectory, noInterpolate) => {
       }
     }
   } else {
-    // eslint-disable-next-line no-console
-    console.error(
-      'This geometry type is not supported. Only Point or LineString are. Current geometry: ',
-      geometry,
-    );
+    console.error("This geometry type is not supported. Only Point or LineString are. Current geometry: ", geometry);
   }
-
   return { coord, rotation };
 };
-
 export default getVehiclePosition;

package/common/utils/index.js

@@ -1,6 +1,5 @@
-export { default as getMapboxStyleUrl } from './getMapboxStyleUrl';
-export { default as getMapboxMapCopyrights } from './getMapboxMapCopyrights';
-export { default as removeDuplicate } from './removeDuplicate';
-export * from './timeUtils';
-export * from '../styles';
-export { default as sortByDelay } from './sortByDelay';
+export { default as getMapboxStyleUrl } from "./getMapboxStyleUrl";
+export { default as getMapboxMapCopyrights } from "./getMapboxMapCopyrights";
+export { default as removeDuplicate } from "./removeDuplicate";
+export * from "./timeUtils";
+export { default as sortByDelay } from "./sortByDelay";

package/common/utils/removeDuplicate.js

@@ -1,22 +1,8 @@
-/**
- * This function remove duplicates lower case string value of an array.
- * It removes also null, undefined or non string values.
- *
- * @param {array} array Array of values.
- * @ignore
- */
 const removeDuplicate = (array) => {
-  const arrWithoutEmptyValues = array.filter(
-    (val) => val !== undefined && val !== null && val.trim && val.trim(),
-  );
-  const lowerCasesValues = arrWithoutEmptyValues.map((str) =>
-    str.toLowerCase(),
-  );
+  const arrWithoutEmptyValues = array.filter((val) => val !== void 0 && val !== null && val.trim && val.trim());
+  const lowerCasesValues = arrWithoutEmptyValues.map((str) => str.toLowerCase());
   const uniqueLowerCaseValues = [...new Set(lowerCasesValues)];
-  const uniqueValues = uniqueLowerCaseValues.map((uniqueStr) =>
-    arrWithoutEmptyValues.find((str) => str.toLowerCase() === uniqueStr),
-  );
+  const uniqueValues = uniqueLowerCaseValues.map((uniqueStr) => arrWithoutEmptyValues.find((str) => str.toLowerCase() === uniqueStr));
   return uniqueValues;
 };
-
 export default removeDuplicate;

package/common/utils/removeDuplicate.test.js

@@ -1,22 +1,19 @@
-import removeDuplicate from './removeDuplicate';
-
-describe('removeDuplicate()', () => {
-  test('removes duplicates', () => {
-    expect(
-      removeDuplicate([
-        'a',
-        ' ',
-        '   ',
-        'b',
-        'a',
-        undefined,
-        null,
-        'A',
-        0,
-        'c',
-        'b',
-        'B',
-      ]),
-    ).toEqual(['a', 'b', 'c']);
+import removeDuplicate from "./removeDuplicate";
+describe("removeDuplicate()", () => {
+  test("removes duplicates", () => {
+    expect(removeDuplicate([
+      "a",
+      " ",
+      "   ",
+      "b",
+      "a",
+      void 0,
+      null,
+      "A",
+      0,
+      "c",
+      "b",
+      "B"
+    ])).toEqual(["a", "b", "c"]);
   });
 });

package/common/utils/sortByDelay.js

@@ -1,23 +1,18 @@
 const sortByDelay = (traj1, traj2) => {
   const props1 = traj1.properties;
   const props2 = traj2.properties;
-
   if (props1.delay === null && props2.delay !== null) {
     return 1;
   }
   if (props2.delay === null && props1.delay !== null) {
     return -1;
   }
-
-  // We put cancelled train inbetween green and yellow trains
-  // >=180000ms corresponds to yellow train
   if (props1.cancelled && !props2.cancelled) {
-    return props2.delay < 180000 ? -1 : 1;
+    return props2.delay < 18e4 ? -1 : 1;
   }
   if (props2.cancelled && !props1.cancelled) {
-    return props1.delay < 180000 ? 1 : -1;
+    return props1.delay < 18e4 ? 1 : -1;
   }
   return props2.delay - props1.delay;
 };
-
 export default sortByDelay;