mobility-toolbox-js 2.0.0-beta.6 → 2.0.0-beta.62

package/common/utils/sortAndFilterDepartures.js

@@ -0,0 +1,58 @@
+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.
+ * @return {Array<Departure>} Return departures array.
+ * @private
+ */
+const sortAndfilterDepartures = (depObject, sortByMinArrivalTime = false, maxDepartureAge = 30) => {
+    const departures = Object.keys(depObject).map((k) => depObject[k]);
+    departures.sort((a, b) => 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 departureArray = [];
+    const platformsBoarding = [];
+    let previousDeparture = null;
+    for (let i = departures.length - 1; i >= 0; i -= 1) {
+        const departure = Object.assign({}, departures[i]);
+        const time = new Date(departure.time).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 (departure.state === 'BOARDING') {
+                if (!platformsBoarding.includes(departure.platform)) {
+                    platformsBoarding.push(departure.platform);
+                }
+                else {
+                    departure.state = 'HIDDEN';
+                }
+            }
+            // If two trains with the same line number and destinatin
+            // and a departure difference < 1 minute, hide the second one.
+            if (previousDeparture &&
+                departure.to[0] === previousDeparture.to[0] &&
+                Math.abs(time - previousDeparture.time) < 1000 &&
+                departure.line.name === previousDeparture.line.name) {
+                departure.state = 'HIDDEN';
+            }
+            if (/(STOP_CANCELLED|JOURNEY_CANCELLED)/.test(departure.state)) {
+                departure.cancelled = true;
+            }
+            previousDeparture = departure;
+            previousDeparture.time = time;
+            departureArray.unshift(departure);
+        }
+    }
+    return departureArray;
+};
+export default sortAndfilterDepartures;

package/common/utils/sortByDelay.d.ts

@@ -0,0 +1,3 @@
+declare const sortByDelay: (traj1: GeoJSONFeature, traj2: GeoJSONFeature) => number;
+export default sortByDelay;
+//# sourceMappingURL=sortByDelay.d.ts.map

package/common/utils/sortByDelay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortByDelay.d.ts","sourceRoot":"","sources":["../../../src/common/utils/sortByDelay.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,WAAW,oDAGd,MAoBF,CAAC;AAEF,eAAe,WAAW,CAAC"}

package/common/utils/sortByDelay.js

@@ -0,0 +1,20 @@
+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;
+    }
+    if (props2.cancelled && !props1.cancelled) {
+        return props1.delay < 180000 ? 1 : -1;
+    }
+    return props2.delay - props1.delay;
+};
+export default sortByDelay;

package/common/utils/timeUtils.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Get a Date object as UTC date string .
+ * ex: 2019 09 01
+ * @ignore
+ */
+export declare const getUTCDateString: (now?: Date) => string;
+/**
+ * Get the UTC time string of Date object.
+ * ex: 09:05:01.123
+ * @ignore
+ */
+export declare const getUTCTimeString: (date: Date) => string;
+/**
+ * Returns a string representation of a number, with a zero if the number is lower than 10.
+ * @ignore
+ */
+export declare const pad: (integer: number) => string;
+/**
+ * Returns a 'hh:mm' string from a time in ms.
+ * @param {Number} timeInMs Time in milliseconds.
+ * @ignore
+ */
+export declare const getHoursAndMinutes: (timeInMs: number) => string;
+//# sourceMappingURL=timeUtils.d.ts.map

package/common/utils/timeUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeUtils.d.ts","sourceRoot":"","sources":["../../../src/common/utils/timeUtils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,kBAAuB,MAOnD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,SAAU,IAAI,KAAG,MAKjC,CAAC;AAEd;;;GAGG;AACH,eAAO,MAAM,GAAG,YAAa,MAAM,KAAG,MACO,CAAC;AAE9C;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,aAAc,MAAM,KAAG,MAMrD,CAAC"}

package/{src/common → common}/utils/timeUtils.js

@@ -4,41 +4,36 @@
  * @ignore
  */
 export const getUTCDateString = (now = new Date()) => {
-  let month = (now.getUTCMonth() + 1).toString();
-  month = month.length === 1 ? `0${month}` : month;
-  let day = now.getUTCDate().toString();
-  day = day.length === 1 ? `0${day}` : day;
-
-  return [now.getUTCFullYear(), month, day].join('');
+    let month = (now.getUTCMonth() + 1).toString();
+    month = month.length === 1 ? `0${month}` : month;
+    let day = now.getUTCDate().toString();
+    day = day.length === 1 ? `0${day}` : day;
+    return [now.getUTCFullYear(), month, day].join('');
 };
-
 /**
  * Get the UTC time string of Date object.
  * ex: 09:05:01.123
  * @ignore
  */
-export const getUTCTimeString = (date) =>
-  [
+export const getUTCTimeString = (date) => [
     date.getUTCHours(),
     date.getUTCMinutes(),
     `${date.getUTCSeconds()}.${date.getUTCMilliseconds()}`,
-  ].join(':');
-
+].join(':');
 /**
  * Returns a string representation of a number, with a zero if the number is lower than 10.
  * @ignore
  */
-export const pad = (integer) => (integer < 10 ? `0${integer}` : integer);
-
+export const pad = (integer) => integer < 10 ? `0${integer}` : `${integer}`;
 /**
  * Returns a 'hh:mm' string from a time in ms.
  * @param {Number} timeInMs Time in milliseconds.
  * @ignore
  */
 export const getHoursAndMinutes = (timeInMs) => {
-  if (!timeInMs || timeInMs <= 0) {
-    return '';
-  }
-  const date = new Date(timeInMs);
-  return `${pad(date.getHours())}:${pad(date.getMinutes())}`;
+    if (!timeInMs || timeInMs <= 0) {
+        return '';
+    }
+    const date = new Date(timeInMs);
+    return `${pad(date.getHours())}:${pad(date.getMinutes())}`;
 };

package/iife.d.ts

@@ -0,0 +1,3 @@
+export default mbt;
+import mbt from "./index";
+//# sourceMappingURL=iife.d.ts.map

package/iife.d.ts.map

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

package/{src/iife.js → iife.js}

@@ -1,7 +1,5 @@
 import mbt from './index';
-
 if (typeof window !== 'undefined') {
-  window.mbt = mbt
-};
-
+    window.mbt = mbt;
+}
 export default mbt;

package/index.d.ts

@@ -0,0 +1,10 @@
+export * as ol from "./ol";
+export * as mapbox from "./mapbox";
+declare namespace _default {
+    export { ol };
+    export { mapbox };
+}
+export default _default;
+import * as ol from "./ol";
+import * as mapbox from "./mapbox";
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

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

package/index.js

@@ -0,0 +1,10 @@
+import * as ol from './ol';
+import * as mapbox from './mapbox';
+import * as ol_1 from './ol';
+export { ol_1 as ol };
+import * as mapbox_1 from './mapbox';
+export { mapbox_1 as mapbox };
+export default {
+    ol,
+    mapbox,
+};

package/mapbox/controls/CopyrightControl.d.ts

@@ -0,0 +1,29 @@
+import CopyrightControlCommon from '../../common/controls/CopyrightControlCommon';
+/**
+ * Display layer's copyrights.
+ *
+ * @example
+ * import { Map } from 'mapbox-gl';
+ * import { CopyrightControl } from 'mobility-toolbox-js/mapbox';
+ *
+ * const map = new Map({
+ *   container: 'map',
+ *   style: `https://maps.geops.io/styles/travic_v2/style.json?key=${window.apiKey}`,
+ * });
+ *
+ * const control = new CopyrightControl();
+ * control.attachToMap(map);
+ *
+ *
+ * @see <a href="/example/mb-copyright">Mapbox copyright example</a>
+ *
+ * @extends {CopyrightControlCommon}
+ */
+declare class CopyrightControl extends CopyrightControlCommon {
+    constructor(options: any);
+    activate(): void;
+    deactivate(): void;
+    getCopyrights(): any[];
+}
+export default CopyrightControl;
+//# sourceMappingURL=CopyrightControl.d.ts.map

package/mapbox/controls/CopyrightControl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CopyrightControl.d.ts","sourceRoot":"","sources":["../../../src/mapbox/controls/CopyrightControl.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,MAAM,8CAA8C,CAAC;AAGlF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,cAAM,gBAAiB,SAAQ,sBAAsB;gBACvC,OAAO,EAAE,GAAG;IAKxB,QAAQ;IASR,UAAU;IASV,aAAa;CAGd;AAED,eAAe,gBAAgB,CAAC"}

package/mapbox/controls/CopyrightControl.js

@@ -0,0 +1,48 @@
+import CopyrightControlCommon from '../../common/controls/CopyrightControlCommon';
+import { getMapboxMapCopyrights } from '../../common/utils';
+/**
+ * Display layer's copyrights.
+ *
+ * @example
+ * import { Map } from 'mapbox-gl';
+ * import { CopyrightControl } from 'mobility-toolbox-js/mapbox';
+ *
+ * const map = new Map({
+ *   container: 'map',
+ *   style: `https://maps.geops.io/styles/travic_v2/style.json?key=${window.apiKey}`,
+ * });
+ *
+ * const control = new CopyrightControl();
+ * control.attachToMap(map);
+ *
+ *
+ * @see <a href="/example/mb-copyright">Mapbox copyright example</a>
+ *
+ * @extends {CopyrightControlCommon}
+ */
+class CopyrightControl extends CopyrightControlCommon {
+    constructor(options) {
+        super(options);
+        this.render = this.render.bind(this);
+    }
+    activate() {
+        super.activate();
+        if (this.map) {
+            this.map.on('sourcedata', this.render);
+            this.map.on('styledata', this.render);
+            this.map.on('idle', this.render);
+        }
+    }
+    deactivate() {
+        if (this.map) {
+            this.map.off('sourcedata', this.render);
+            this.map.off('styledata', this.render);
+            this.map.off('idle', this.render);
+        }
+        super.deactivate();
+    }
+    getCopyrights() {
+        return getMapboxMapCopyrights(this.map);
+    }
+}
+export default CopyrightControl;

package/mapbox/controls/index.d.ts

@@ -0,0 +1,2 @@
+export { default as CopyrightControl } from "./CopyrightControl";
+//# sourceMappingURL=index.d.ts.map

package/mapbox/controls/index.d.ts.map

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

package/mapbox/controls/index.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/prefer-default-export
+export { default as CopyrightControl } from './CopyrightControl';

package/mapbox/index.d.ts

@@ -0,0 +1,6 @@
+export * from "../api";
+export * from "../common";
+export * from "./controls";
+export * from "./layers";
+export * from "./utils";
+//# sourceMappingURL=index.d.ts.map

package/mapbox/index.d.ts.map

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

package/mapbox/index.js

@@ -0,0 +1,5 @@
+export * from '../api';
+export * from '../common';
+export * from './controls';
+export * from './layers';
+export * from './utils';

package/mapbox/layers/Layer.d.ts

@@ -0,0 +1,59 @@
+import { EventsKey } from 'ol/events';
+import LayerCommon, { LayerCommonOptions } from '../../common/layers/LayerCommon';
+import { AnyMapboxMap, UserInteractionCallback } from '../../types';
+declare const Layer_base: typeof LayerCommon;
+/**
+ * A class representing a layer to display on an OpenLayers map.
+ *
+ * @example
+ * import { Layer } from 'mobility-toolbox-js/ol';
+ *
+ * const layer = new Layer({
+ *   olLayer: ...,
+ * });
+ *
+ * @see <a href="/example/ol-map">Map example</a>
+ *
+ * @classproperty {ol/Map~Map} map - The map where the layer is displayed.
+ * @extends {Layer}
+ */
+declare class Layer extends Layer_base {
+    options: LayerCommonOptions;
+    onChangeVisibleKey?: EventsKey;
+    userInteractions?: boolean;
+    userClickInteractions?: boolean;
+    userHoverInteractions?: boolean;
+    userClickCallbacks?: UserInteractionCallback[];
+    userHoverCallbacks?: UserInteractionCallback[];
+    onUserClickCallback: () => void;
+    onUserMoveCallback: () => void;
+    /**
+     * Initialize the layer and listen to user events.
+     * @param {mapboxgl.Map|maplibregl.Map} map
+     */
+    attachToMap(map: AnyMapboxMap): void;
+    detachFromMap(): void;
+    activateUserInteractions(): void;
+    deactivateUserInteractions(): void;
+    /**
+     * Toggle listeners needed when a layer is avisible or not.
+     * @private
+     */
+    toggleVisibleListeners(): void;
+    /**
+     * Returns the current extent in mercator coordinates.
+     */
+    getMercatorExtent(): import("ol/extent").Extent;
+    /**
+     * Returns the equivalent zoom in Openlayers.
+     */
+    getOlZoom(): any;
+    /**
+     * Create a copy of the Layer.
+     * @param {Object} newOptions Options to override
+     * @return {Layer} A Layer
+     */
+    clone(newOptions: LayerCommonOptions): Layer;
+}
+export default Layer;
+//# sourceMappingURL=Layer.d.ts.map

package/mapbox/layers/Layer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Layer.d.ts","sourceRoot":"","sources":["../../../src/mapbox/layers/Layer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAGtC,OAAO,WAAW,EAAE,EAClB,kBAAkB,EACnB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;;AAEpE;;;;;;;;;;;;;;GAcG;AACH,cAAM,KAAM,SAAQ,UAAkC;IACpD,OAAO,EAAG,kBAAkB,CAAC;IAE7B,kBAAkB,CAAC,EAAE,SAAS,CAAC;IAI/B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,kBAAkB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAE/C,kBAAkB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAE/C,mBAAmB,EAAG,MAAM,IAAI,CAAC;IAEjC,kBAAkB,EAAG,MAAM,IAAI,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,GAAG,EAAE,YAAY;IAiB7B,aAAa;IASb,wBAAwB;IAqBxB,0BAA0B;IAO1B;;;OAGG;IACH,sBAAsB;IAQtB;;OAEG;IACH,iBAAiB;IASjB;;OAEG;IACH,SAAS;IAIT;;;;OAIG;IACH,KAAK,CAAC,UAAU,EAAE,kBAAkB;CAGrC;AACD,eAAe,KAAK,CAAC"}

package/mapbox/layers/Layer.js

@@ -0,0 +1,101 @@
+import { unByKey } from 'ol/Observable';
+import { transformExtent } from 'ol/proj';
+import LayerCommon from '../../common/layers/LayerCommon';
+import userInteractionsMixin from '../../common/mixins/UserInteractionsLayerMixin';
+/**
+ * A class representing a layer to display on an OpenLayers map.
+ *
+ * @example
+ * import { Layer } from 'mobility-toolbox-js/ol';
+ *
+ * const layer = new Layer({
+ *   olLayer: ...,
+ * });
+ *
+ * @see <a href="/example/ol-map">Map example</a>
+ *
+ * @classproperty {ol/Map~Map} map - The map where the layer is displayed.
+ * @extends {Layer}
+ */
+class Layer extends userInteractionsMixin(LayerCommon) {
+    /**
+     * Initialize the layer and listen to user events.
+     * @param {mapboxgl.Map|maplibregl.Map} map
+     */
+    attachToMap(map) {
+        super.attachToMap(map);
+        if (!this.map) {
+            return;
+        }
+        if (this.userInteractions) {
+            this.toggleVisibleListeners();
+            this.onChangeVisibleKey = this.on(
+            // @ts-ignore
+            'change:visible', this.toggleVisibleListeners);
+        }
+    }
+    detachFromMap() {
+        if (this.map) {
+            this.deactivateUserInteractions();
+            // @ts-ignore
+            unByKey(this.onChangeVisibleKey);
+        }
+        super.detachFromMap();
+    }
+    activateUserInteractions() {
+        var _a, _b;
+        this.deactivateUserInteractions();
+        if (this.map &&
+            this.userInteractions &&
+            this.userClickInteractions &&
+            ((_a = this.userClickCallbacks) === null || _a === void 0 ? void 0 : _a.length)) {
+            this.map.on('click', this.onUserClickCallback);
+        }
+        if (this.map &&
+            this.userInteractions &&
+            this.userHoverInteractions &&
+            ((_b = this.userHoverCallbacks) === null || _b === void 0 ? void 0 : _b.length)) {
+            this.map.on('mousemove', this.onUserMoveCallback);
+        }
+    }
+    deactivateUserInteractions() {
+        if (this.map) {
+            this.map.off('mousemove', this.onUserMoveCallback);
+            this.map.off('click', this.onUserClickCallback);
+        }
+    }
+    /**
+     * Toggle listeners needed when a layer is avisible or not.
+     * @private
+     */
+    toggleVisibleListeners() {
+        if (this.visible) {
+            this.activateUserInteractions();
+        }
+        else {
+            this.deactivateUserInteractions();
+        }
+    }
+    /**
+     * Returns the current extent in mercator coordinates.
+     */
+    getMercatorExtent() {
+        const bounds = this.map.getBounds().toArray();
+        return transformExtent([...bounds[0], ...bounds[1]], 'EPSG:4326', 'EPSG:3857');
+    }
+    /**
+     * Returns the equivalent zoom in Openlayers.
+     */
+    getOlZoom() {
+        return this.map.getZoom() + 1;
+    }
+    /**
+     * Create a copy of the Layer.
+     * @param {Object} newOptions Options to override
+     * @return {Layer} A Layer
+     */
+    clone(newOptions) {
+        return new Layer(Object.assign(Object.assign({}, this.options), newOptions));
+    }
+}
+export default Layer;