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

package/common/mixins/StopFinderMixin.js

@@ -0,0 +1,198 @@
+"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 __());
+    };
+})();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StopFinderInterface = void 0;
+/* eslint-disable no-empty-function */
+/* eslint-disable no-useless-constructor */
+/* eslint-disable class-methods-use-this */
+/* eslint-disable max-classes-per-file */
+var api_1 = require("../../api");
+/**
+ * StopFinder control interface.
+ *
+ * @classproperty {StopsSearchParams} apiParams - Default request parameters used by the search method. See [Stops service documentation](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
+ */
+var StopFinderInterface = /** @class */ (function () {
+    /**
+     * Constructor.
+     *
+     * @param {Object} options Map options
+     * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/). See StopsAPI.
+     * @param {string} [options.url='https://api.geops.io/tracker/v1'] Stops service url. See StopsAPI.
+     * @param {string} [options.placeholder='Search for a stop...'] Input field placeholder.
+     * @param {StopsSearchParams} [options.apiParams={ limit: 20 }] Request parameters. See [Stops service documentation](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
+     */
+    // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-useless-constructor, @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function
+    function StopFinderInterface(options) {
+        if (options === void 0) { options = {}; }
+    }
+    /**
+     * Launch a search.
+     *
+     * @param {String} query The query to search for.
+     * @param {AbortController} abortController Abort controller used to cancel the request.
+     * @return {Promise<Array<GeoJSONFeature>>} An array of GeoJSON features with coordinates in [EPSG:4326](http://epsg.io/4326).
+     */
+    // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
+    StopFinderInterface.prototype.search = function (query, abortController) { };
+    return StopFinderInterface;
+}());
+exports.StopFinderInterface = StopFinderInterface;
+/**
+ * Mixin for StopFinderInterface.
+ *
+ * @param {Class} Base  A class to extend with {StopFinderInterface} functionnalities.
+ * @return {Class}  A class that implements <StopFinderInterface> class and extends Base;
+ * @private
+ */
+var StopFinderMixin = function (Base) {
+    return /** @class */ (function (_super) {
+        __extends(class_1, _super);
+        function class_1(options) {
+            if (options === void 0) { options = {}; }
+            var _this = _super.call(this, options) || this;
+            var apiParams = options.apiParams, apiKey = options.apiKey, url = options.url;
+            _this.apiParams = __assign({ limit: 20 }, (apiParams || {}));
+            _this.placeholder = options.placeholder || 'Search for a stop...';
+            var apiOptions = { apiKey: apiKey };
+            if (url) {
+                apiOptions.url = url;
+            }
+            _this.api = new api_1.StopsAPI(apiOptions);
+            _this.abortController = new AbortController();
+            return _this;
+        }
+        class_1.prototype.render = function (featureCollection) {
+            var _this = this;
+            var suggestions = (featureCollection === null || featureCollection === void 0 ? void 0 : featureCollection.features) || [];
+            if (!this.suggestionsElt) {
+                return;
+            }
+            this.suggestionsElt.style.display = suggestions.length ? 'block' : 'none';
+            this.suggestionsElt.innerHTML = '';
+            suggestions.forEach(function (suggestion) {
+                var properties = suggestion.properties;
+                var suggElt = document.createElement('div');
+                suggElt.innerHTML = properties.name;
+                suggElt.onclick = function () {
+                    _this.onSuggestionClick(suggestion);
+                };
+                Object.assign(suggElt.style, {
+                    padding: '5px 12px',
+                });
+                _this.suggestionsElt.appendChild(suggElt);
+            });
+        };
+        class_1.prototype.createDefaultElement = function () {
+            var _this = this;
+            /**
+             * Define a default element.
+             */
+            this.element = document.createElement('div');
+            this.element.id = 'mbt-search';
+            Object.assign(this.element.style, {
+                position: 'absolute',
+                top: 0,
+                left: '50px',
+                margin: '10px',
+                display: 'flex',
+                flexDirection: 'column',
+                width: '320px',
+            });
+            // Create input element
+            this.inputElt = document.createElement('input');
+            this.inputElt.type = 'text';
+            this.inputElt.placeholder = this.placeholder;
+            this.inputElt.autoComplete = 'off';
+            this.inputElt.onkeyup = function (evt) {
+                _this.abortController.abort();
+                _this.abortController = new AbortController();
+                _this.search(evt.target.value, _this.abortController);
+            };
+            Object.assign(this.inputElt.style, {
+                padding: '10px 30px 10px 10px',
+            });
+            this.element.appendChild(this.inputElt);
+            // Create suggestions list element
+            this.suggestionsElt = document.createElement('div');
+            Object.assign(this.suggestionsElt.style, {
+                backgroundColor: 'white',
+                overflowY: 'auto',
+                cursor: 'pointer',
+            });
+            this.element.appendChild(this.suggestionsElt);
+            this.clearElt = document.createElement('div');
+            Object.assign(this.clearElt.style, {
+                display: 'none',
+                position: 'absolute',
+                right: '0',
+                padding: '0 10px',
+                fontSize: '200%',
+                cursor: 'pointer',
+            });
+            this.clearElt.innerHTML = '×';
+            this.clearElt.onclick = function () { return _this.clear(); };
+            this.element.appendChild(this.clearElt);
+        };
+        class_1.prototype.search = function (q, abortController) {
+            var _this = this;
+            if (q !== undefined || q !== null) {
+                this.apiParams.q = q;
+            }
+            if (this.clearElt) {
+                this.clearElt.style.display = 'block';
+            }
+            return this.api
+                .search(this.apiParams, abortController)
+                .then(function (data) {
+                _this.render(data);
+            })
+                .catch(function () {
+                _this.render();
+            });
+        };
+        /**
+         * To be defined in inherited class
+         */
+        // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
+        class_1.prototype.onSuggestionClick = function (suggestion) { };
+        /**
+         * Clear the search field and close the control.
+         */
+        class_1.prototype.clear = function () {
+            if (!this.suggestionsElt) {
+                return;
+            }
+            this.inputElt.value = '';
+            this.suggestionsElt.innerHTML = '';
+            this.clearElt.style.display = 'none';
+        };
+        return class_1;
+    }(Base));
+};
+exports.default = StopFinderMixin;

package/common/mixins/UserInteractionsLayerMixin.js

@@ -0,0 +1,225 @@
+"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 });
+exports.UserInteractionsLayerInterface = void 0;
+/* eslint-disable no-empty-function,@typescript-eslint/no-empty-function */
+/* eslint-disable no-useless-constructor,@typescript-eslint/no-useless-constructor */
+/* eslint-disable no-unused-vars,@typescript-eslint/no-unused-vars */
+/* eslint-disable class-methods-use-this */
+/* eslint-disable max-classes-per-file */
+var proj_1 = require("ol/proj");
+var Observable_1 = require("ol/Observable");
+/**
+ * UserInteractionsLayerInterface.
+ */
+var UserInteractionsLayerInterface = /** @class */ (function () {
+    /*
+     * Constructor
+  
+     * @param {Object} options Layer options.
+     * @param {string} options.userInteractions If true, it listens for user mouse hover and click event.
+     * @param {string} options.userClickInteractions If true, it listens for user click event.
+     * @param {string} options.userHoverInteractions If true, it listens for user mouse over event.
+     * @param {string} options.defaultUserInteractions  If true, it adds default listeners for user mouse hover and click event.
+     */
+    function UserInteractionsLayerInterface(options) {
+        if (options === void 0) { options = {}; }
+    }
+    /**
+     * Initialize the layer adding user interactions.
+     *
+     * @param {ol/Map~Map} map
+     */
+    UserInteractionsLayerInterface.prototype.attachToMap = function (map) { };
+    /**
+     * Terminate the layer unsubscribing user interactions.
+     */
+    UserInteractionsLayerInterface.prototype.detachFromMap = function () { };
+    /**
+     * Activate map listeners events.
+     */
+    UserInteractionsLayerInterface.prototype.activateUserInteractions = function () { };
+    /**
+     * Deactivaet map listeners events.
+     */
+    UserInteractionsLayerInterface.prototype.deactivateUserInteractions = function () { };
+    /**
+     * Terminate the layer unsubscribing user interactions.
+     */
+    UserInteractionsLayerInterface.prototype.onClick = function (callback) { };
+    /**
+     * Terminate the layer unsubscribing user interactions.
+     */
+    UserInteractionsLayerInterface.prototype.onHover = function (callback) { };
+    return UserInteractionsLayerInterface;
+}());
+exports.UserInteractionsLayerInterface = UserInteractionsLayerInterface;
+/**
+ * Mixin for UserInteractionsLayerInterface. It provide onClick and onHover functions.
+ *
+ * @param {Class} Base A class to extend with {UserInteractionsLayerInterface} functionnalities.
+ * @return {Class}  A class that implements {UserInteractionsLayerInterface} class and extends Base;
+ * @private
+ */
+var UserInteractionsLayerMixin = function (Base) {
+    return /** @class */ (function (_super) {
+        __extends(class_1, _super);
+        function class_1(options) {
+            if (options === void 0) { options = {}; }
+            var _this = _super.call(this, options) || this;
+            var _a = options.userInteractions, userInteractions = _a === void 0 ? true : _a, _b = options.userClickInteractions, userClickInteractions = _b === void 0 ? true : _b, _c = options.userHoverInteractions, userHoverInteractions = _c === void 0 ? true : _c, _d = options.defaultUserInteractions, defaultUserInteractions = _d === void 0 ? true : _d;
+            _this.userInteractions = userInteractions;
+            _this.userClickInteractions = userClickInteractions;
+            _this.userHoverInteractions = userHoverInteractions;
+            _this.defaultUserInteractions = defaultUserInteractions;
+            _this.userClickCallbacks = [];
+            _this.userHoverCallbacks = [];
+            _this.userClickEventsKeys = [];
+            _this.userHoverEventsKeys = [];
+            _this.onUserClickCallback = _this.onUserClickCallback.bind(_this);
+            _this.onUserMoveCallback = _this.onUserMoveCallback.bind(_this);
+            // Add mouse event callbacks
+            var onClick = options.onClick, onHover = options.onHover;
+            if (_this.userInteractions && _this.userClickInteractions && onClick) {
+                _this.onClick(onClick);
+            }
+            if (_this.userInteractions && _this.userHoverInteractions && onHover) {
+                _this.onHover(onHover);
+            }
+            return _this;
+        }
+        class_1.prototype.attachToMap = function (map, options) {
+            _super.prototype.attachToMap.call(this, map, options);
+            if (this.userInteractions &&
+                this.defaultUserInteractions &&
+                this.userClickInteractions &&
+                this.onFeatureClick) {
+                this.onClick(this.onFeatureClick);
+            }
+            if (this.userInteractions &&
+                this.defaultUserInteractions &&
+                this.userHoverInteractions &&
+                this.onFeatureHover) {
+                this.onHover(this.onFeatureHover);
+            }
+            this.listenEvents();
+        };
+        class_1.prototype.detachFromMap = function () {
+            this.unlistenEvents();
+            _super.prototype.detachFromMap.call(this);
+        };
+        class_1.prototype.listenEvents = function () {
+            var _this = this;
+            this.unlistenEvents();
+            this.userClickCallbacks.forEach(function (callback) {
+                _this.userClickEventsKeys.push(_this.on('user:click', function (_a) {
+                    var _b = _a.target, features = _b.features, layer = _b.layer, coordinate = _b.coordinate;
+                    callback(features, layer, coordinate);
+                }));
+            });
+            this.userHoverCallbacks.forEach(function (callback) {
+                _this.userHoverEventsKeys.push(_this.on('user:hover', function (_a) {
+                    var _b = _a.target, features = _b.features, layer = _b.layer, coordinate = _b.coordinate, event = _b.event;
+                    callback(features, layer, coordinate, event);
+                }));
+            });
+        };
+        class_1.prototype.unlistenEvents = function () {
+            (0, Observable_1.unByKey)(this.userClickEventsKeys);
+            (0, Observable_1.unByKey)(this.userHoverEventsKeys);
+            this.userClickEventsKeys = [];
+            this.userHoverEventsKeys = [];
+        };
+        /**
+         * Listens to click events on the layer.
+         * @param {function} callback Callback function, called with the clicked
+         *   features,
+         *   the layer instance and the click event.
+         */
+        class_1.prototype.onClick = function (callback) {
+            this.userClickCallbacks.push(callback);
+            this.activateUserInteractions();
+            if (this.map) {
+                // If the layer is already attached to the map we reload the events
+                this.listenEvents();
+            }
+        };
+        /**
+         * Listens to hover events on the layer.
+         * @param {function} callback Callback function, called with the clicked
+         *   features, the layer instance and the click event.
+         */
+        class_1.prototype.onHover = function (callback) {
+            this.userHoverCallbacks.push(callback);
+            this.activateUserInteractions();
+            if (this.map) {
+                // If the layer is already attached to the map we reload the events
+                this.listenEvents();
+            }
+        };
+        /**
+         * Function triggered when the user click the map.
+         * @private
+         */
+        class_1.prototype.onUserClickCallback = function (evt) {
+            var _this = this;
+            var coordinate = evt.coordinate || (0, proj_1.fromLonLat)(evt.lngLat.toArray());
+            var emptyFeatureInfo = {
+                features: [],
+                layer: this,
+                coordinate: coordinate,
+                event: evt,
+            };
+            return this.getFeatureInfoAtCoordinate(coordinate)
+                .then(function (featureInfo) {
+                _this.dispatchEvent({
+                    type: 'user:click',
+                    target: featureInfo,
+                });
+                return featureInfo;
+            })
+                .catch(function () { return emptyFeatureInfo; });
+        };
+        /**
+         * Function triggered when the user move the cursor.
+         * @private
+         */
+        class_1.prototype.onUserMoveCallback = function (evt) {
+            var _this = this;
+            var coordinate = evt.coordinate || (0, proj_1.fromLonLat)(evt.lngLat.toArray());
+            var emptyFeatureInfo = {
+                features: [],
+                layer: this,
+                coordinate: coordinate,
+                event: evt,
+            };
+            return this.getFeatureInfoAtCoordinate(coordinate)
+                .then(function (featureInfo) {
+                _this.dispatchEvent({
+                    type: 'user:hover',
+                    target: featureInfo,
+                });
+                return featureInfo;
+            })
+                .catch(function () { return emptyFeatureInfo; });
+        };
+        class_1.prototype.activateUserInteractions = function () { };
+        class_1.prototype.deactivateUserInteractions = function () { };
+        return class_1;
+    }(Base));
+};
+exports.default = UserInteractionsLayerMixin;

package/common/styles/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.realtimeSimpleStyle = exports.realtimeDelayStyle = exports.realtimeDefaultStyle = void 0;
+var realtimeDefaultStyle_1 = require("./realtimeDefaultStyle");
+Object.defineProperty(exports, "realtimeDefaultStyle", { enumerable: true, get: function () { return realtimeDefaultStyle_1.default; } });
+var realtimeDelayStyle_1 = require("./realtimeDelayStyle");
+Object.defineProperty(exports, "realtimeDelayStyle", { enumerable: true, get: function () { return realtimeDelayStyle_1.default; } });
+var realtimeSimpleStyle_1 = require("./realtimeSimpleStyle");
+Object.defineProperty(exports, "realtimeSimpleStyle", { enumerable: true, get: function () { return realtimeSimpleStyle_1.default; } });
+__exportStar(require("./realtimeDefaultStyle"), exports);