mobility-toolbox-js 3.6.13 → 3.6.14-beta.0

package/common/utils/debounceTimeTableMessages.d.ts

@@ -0,0 +1,12 @@
+import type { WebSocketAPIMessageCallback } from '../../api/WebSocketAPI';
+import type { RealtimeDeparture, RealtimeDepartureExtended } from '../../types';
+/**
+ * This function returns a WebSocket api callback, and call the onCallsUpdate function with the list of current calls and arrival to display.
+ * @param {function(calls: RealtimeDepartureExtended[])} onCallsUpdate callback when timetable  changes, called after 100 ms
+ * @param {boolean} [sortByMinArrivalTime = true] Sort calls by arrival time
+ * @param {number} [maxDepartureAge = 30] max departure age of calls in minutes
+ * @param {number} [timeout = 100] debounce timeout in ms
+ * @private
+ */
+declare const debounceTimeTableMessages: (onCallsUpdate: (departures: RealtimeDepartureExtended[]) => unknown, sortByMinArrivalTime?: boolean, maxDepartureAge?: number, timeout?: number) => WebSocketAPIMessageCallback<RealtimeDeparture>;
+export default debounceTimeTableMessages;

package/common/utils/debounceTimeTableMessages.js

@@ -0,0 +1,28 @@
+import sortAndfilterTimetableCall from './sortAndFilterTimetableCall';
+/**
+ * This function returns a WebSocket api callback, and call the onCallsUpdate function with the list of current calls and arrival to display.
+ * @param {function(calls: RealtimeDepartureExtended[])} onCallsUpdate callback when timetable  changes, called after 100 ms
+ * @param {boolean} [sortByMinArrivalTime = true] Sort calls by arrival time
+ * @param {number} [maxDepartureAge = 30] max departure age of calls in minutes
+ * @param {number} [timeout = 100] debounce timeout in ms
+ * @private
+ */
+const debounceTimeTableMessages = (onCallsUpdate, sortByMinArrivalTime = false, maxDepartureAge = 30, timeout = 100) => {
+    const callUpdateTimeout = {};
+    const callObject = {};
+    return (data) => {
+        const { content: call, source } = data;
+        if (callUpdateTimeout[source]) {
+            window.clearTimeout(callUpdateTimeout[source]);
+        }
+        if (!call) {
+            return;
+        }
+        callObject[call.call_id] = call;
+        callUpdateTimeout[source] = window.setTimeout(() => {
+            const calls = sortAndfilterTimetableCall(callObject, sortByMinArrivalTime || false, maxDepartureAge);
+            onCallsUpdate(calls);
+        }, timeout);
+    };
+};
+export default debounceTimeTableMessages;

package/common/utils/sortAndFilterTimetableCall.d.ts

@@ -0,0 +1,16 @@
+import type { RealtimeAPIDeparturesById } from '../../api/RealtimeAPI';
+import type { RealtimeDepartureExtended } from '../../types';
+/**
+ * This function sort Departures by arrival time and filter out unwanted departures:
+ *  - when dparture time is in the past
+ *  - when departure are duplicated
+ *  - when departure is not in the next 30 min
+ *
+ * @param {Object} depObject The object containing departures by id.
+ * @param {boolean} [sortByMinArrivalTime=false] If true sort departures by arrival time.
+ * @param {number} [maxDepartureAge=30] The maximum departure age in minutes.
+ * @return {RealtimeDeparture[]} Return departures array.
+ * @private
+ */
+declare const sortAndfilterTimetableCall: (depObject: RealtimeAPIDeparturesById, sortByMinArrivalTime?: boolean, maxDepartureAge?: number) => RealtimeDepartureExtended[];
+export default sortAndfilterTimetableCall;

package/common/utils/sortAndFilterTimetableCall.js

@@ -0,0 +1,70 @@
+import compareDepartures from './compareDepartures';
+/**
+ * This function sort Departures by arrival time and filter out unwanted departures:
+ *  - when dparture time is in the past
+ *  - when departure are duplicated
+ *  - when departure is not in the next 30 min
+ *
+ * @param {Object} depObject The object containing departures by id.
+ * @param {boolean} [sortByMinArrivalTime=false] If true sort departures by arrival time.
+ * @param {number} [maxDepartureAge=30] The maximum departure age in minutes.
+ * @return {RealtimeDeparture[]} Return departures array.
+ * @private
+ */
+const sortAndfilterTimetableCall = (depObject, sortByMinArrivalTime = false, maxDepartureAge = 30) => {
+    var _a;
+    const calls = Object.keys(depObject).map((k) => {
+        return depObject[k];
+    });
+    calls.sort((a, b) => {
+        return compareDepartures(a, b, sortByMinArrivalTime);
+    });
+    const futureDate = new Date();
+    futureDate.setMinutes(futureDate.getMinutes() + maxDepartureAge);
+    const future = futureDate.getTime();
+    const pastDate = new Date();
+    pastDate.setMinutes(pastDate.getMinutes() - maxDepartureAge);
+    const past = pastDate.getTime();
+    const callsArray = [];
+    const platformsBoarding = [];
+    let previousCall = null;
+    for (let i = calls.length - 1; i >= 0; i -= 1) {
+        const call = Object.assign({}, calls[i]);
+        const chosenTime = (_a = call.time) !== null && _a !== void 0 ? _a : call.arrivalTime;
+        if (!chosenTime) {
+            // eslint-disable-next-line no-console
+            console.warn('Call without time found, skipping it.', call);
+            continue;
+        }
+        const time = new Date(chosenTime).getTime();
+        // Only show departures within the next 30 minutes
+        if (time > past && time < future) {
+            // If 2 trains are boarding at the same platform,
+            // remove the older one.
+            if (call.state === 'BOARDING') {
+                if (call.platform && !platformsBoarding.includes(call.platform)) {
+                    platformsBoarding.push(call.platform);
+                }
+                else {
+                    call.state = 'HIDDEN';
+                }
+            }
+            // If two trains with the same line number and destinatin
+            // and a departure difference < 1 minute, hide the second one.
+            if (previousCall &&
+                call.to[0] === previousCall.to[0] &&
+                Math.abs(time - (previousCall.time || 0)) < 1000 &&
+                call.line.name === previousCall.line.name) {
+                call.state = 'HIDDEN';
+            }
+            if (/(STOP_CANCELLED|JOURNEY_CANCELLED)/.test(call.state)) {
+                call.cancelled = true;
+            }
+            previousCall = call;
+            previousCall.time = time;
+            callsArray.unshift(call);
+        }
+    }
+    return callsArray;
+};
+export default sortAndfilterTimetableCall;

package/package.json

@@ -2,7 +2,7 @@
   "name": "mobility-toolbox-js",
   "license": "MIT",
   "description": "Toolbox for JavaScript applications in the domains of mobility and logistics.",
-  "version": "3.6.13",
+  "version": "3.6.14-beta.0",
   "homepage": "https://mobility-toolbox-js.geops.io/",
   "exports": {
     ".": "./index.js",