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

package/ol/controls/StopFinderControl.js

@@ -0,0 +1,59 @@
+"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 });
+var proj_1 = require("ol/proj");
+var Control_1 = require("../../common/controls/Control");
+var StopFinderMixin_1 = require("../../common/mixins/StopFinderMixin");
+/**
+ * Search stations.
+ *
+ * @example
+ * import { Map } from 'ol';
+ * import { StopFinderControl } from 'mobility-toolbox-js/ol';
+ *
+ * const map = new Map({
+ *   target: 'map',
+ * });
+ *
+ * const control = new StopFinderControl({
+ *   apiKey: [yourApiKey]
+ * });
+ *
+ * control.attachToMap(map);
+ *
+ *
+ * @see <a href="/example/ol-search">Openlayers search example</a>
+ *
+ * @extends {Control}
+ * @implements {StopFinderInterface}
+ */
+var StopFinderControl = /** @class */ (function (_super) {
+    __extends(StopFinderControl, _super);
+    function StopFinderControl() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * @private
+     */
+    StopFinderControl.prototype.onSuggestionClick = function (_a) {
+        var geometry = _a.geometry;
+        var coord = (0, proj_1.fromLonLat)(geometry.coordinates);
+        this.map.getView().setCenter(coord);
+    };
+    return StopFinderControl;
+}((0, StopFinderMixin_1.default)(Control_1.default)));
+exports.default = StopFinderControl;

package/ol/controls/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StopFinderControl = exports.RoutingControl = exports.CopyrightControl = void 0;
+var CopyrightControl_1 = require("./CopyrightControl");
+Object.defineProperty(exports, "CopyrightControl", { enumerable: true, get: function () { return CopyrightControl_1.default; } });
+var RoutingControl_1 = require("./RoutingControl");
+Object.defineProperty(exports, "RoutingControl", { enumerable: true, get: function () { return RoutingControl_1.default; } });
+var StopFinderControl_1 = require("./StopFinderControl");
+Object.defineProperty(exports, "StopFinderControl", { enumerable: true, get: function () { return StopFinderControl_1.default; } });

package/ol/index.js

@@ -0,0 +1,21 @@
+"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 });
+__exportStar(require("../api"), exports);
+__exportStar(require("../common"), exports);
+__exportStar(require("./controls"), exports);
+__exportStar(require("./layers"), exports);
+__exportStar(require("./styles"), exports);

package/ol/layers/Layer.js

@@ -0,0 +1,180 @@
+"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 });
+var Observable_1 = require("ol/Observable");
+var Layer_1 = require("../../common/layers/Layer");
+var UserInteractionsLayerMixin_1 = require("../../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}
+ */
+var Layer = /** @class */ (function (_super) {
+    __extends(Layer, _super);
+    /**
+     * Constructor.
+     *
+     * @param {Object} options
+     * @param {ol/layer/Layer~Layer} options.olLayer The layer (required).
+     * @param {string} [options.name=uuid()] Layer name. Default use a generated uuid.
+     * @param {string} [options.key=uuid().toLowerCase()] Layer key, will use options.name.toLowerCase() if not specified.
+     * @param {string} [options.copyright=undefined] Copyright-Statement.
+     * @param {Array<Layer>} [options.children=[]] Sublayers.
+     * @param {Object} [options.properties={}] Application-specific layer properties.
+     * @param {boolean} [options.visible=true] If true this layer is the currently visible layer on the map.
+     */
+    function Layer(options) {
+        var _this = _super.call(this, options) || this;
+        if (_this.olLayer) {
+            _this.olLayer.setVisible(_this.visible);
+        }
+        return _this;
+    }
+    /**
+     * Define layer's properties.
+     *
+     * @ignore
+     */
+    Layer.prototype.defineProperties = function (options) {
+        _super.prototype.defineProperties.call(this, options);
+        Object.defineProperties(this, {
+            olLayer: { value: options.olLayer, writable: true },
+            olListenersKeys: {
+                value: [],
+            },
+        });
+    };
+    /**
+     * Initialize the layer and listen to feature clicks.
+     * @param {ol/Map~Map} map
+     */
+    Layer.prototype.attachToMap = function (map) {
+        var _this = this;
+        var _a, _b, _c, _d;
+        _super.prototype.attachToMap.call(this, map);
+        if (!this.map) {
+            return;
+        }
+        if (this.olLayer &&
+            !((_c = (_b = (_a = this.map) === null || _a === void 0 ? void 0 : _a.getLayers()) === null || _b === void 0 ? void 0 : _b.getArray()) === null || _c === void 0 ? void 0 : _c.includes(this.olLayer))) {
+            this.map.addLayer(this.olLayer);
+        }
+        this.olListenersKeys.push(this.on('change:visible', function () {
+            if (_this.olLayer) {
+                _this.olLayer.setVisible(_this.visible);
+            }
+        }));
+        this.olListenersKeys.push(this.map.getLayers().on('remove', function (evt) {
+            if (evt.element === _this.olLayer) {
+                _this.detachFromMap();
+            }
+        }));
+        this.toggleVisibleListeners();
+        this.olListenersKeys.push(this.on('change:visible', this.toggleVisibleListeners));
+        // We set the copyright to the source used by the layer.
+        if (this.copyrights && this.olLayer) {
+            var attributions_1 = this.copyrights || [];
+            if (this.olLayer.getLayers) {
+                this.olLayer
+                    .getLayers()
+                    .getArray()
+                    .forEach(function (layer) {
+                    var _a;
+                    (_a = layer.getSource()) === null || _a === void 0 ? void 0 : _a.setAttributions(attributions_1);
+                });
+            }
+            else if (this.olLayer.getSource) {
+                (_d = this.olLayer.getSource()) === null || _d === void 0 ? void 0 : _d.setAttributions(attributions_1);
+            }
+        }
+    };
+    /**
+     * Terminate what was initialized in init function. Remove layer, events...
+     */
+    Layer.prototype.detachFromMap = function () {
+        var _a, _b, _c;
+        this.deactivateUserInteractions();
+        (0, Observable_1.unByKey)(this.olListenersKeys);
+        if (this.olLayer &&
+            ((_c = (_b = (_a = this.map) === null || _a === void 0 ? void 0 : _a.getLayers()) === null || _b === void 0 ? void 0 : _b.getArray()) === null || _c === void 0 ? void 0 : _c.includes(this.olLayer))) {
+            this.map.removeLayer(this.olLayer);
+        }
+        _super.prototype.detachFromMap.call(this);
+    };
+    Layer.prototype.activateUserInteractions = function () {
+        this.deactivateUserInteractions();
+        if (this.map &&
+            this.userInteractions &&
+            this.userClickInteractions &&
+            this.userClickCallbacks.length) {
+            this.singleClickListenerKey = this.map.on('singleclick', this.onUserClickCallback);
+            this.olListenersKeys.push(this.singleClickListenerKey);
+        }
+        if (this.map &&
+            this.userInteractions &&
+            this.userHoverInteractions &&
+            this.userHoverCallbacks.length) {
+            this.pointerMoveListenerKey = this.map.on('pointermove', this.onUserMoveCallback);
+        }
+    };
+    Layer.prototype.deactivateUserInteractions = function () {
+        (0, Observable_1.unByKey)([this.pointerMoveListenerKey, this.singleClickListenerKey]);
+    };
+    /**
+     * Toggle listeners needed when a layer is avisible or not.
+     * @private
+     */
+    Layer.prototype.toggleVisibleListeners = function () {
+        if (this.visible) {
+            this.activateUserInteractions();
+        }
+        else {
+            this.deactivateUserInteractions();
+        }
+    };
+    /**
+     * Create a copy of the Layer.
+     * @param {Object} newOptions Options to override
+     * @return {Layer} A Layer
+     */
+    Layer.prototype.clone = function (newOptions) {
+        return new Layer(__assign(__assign({}, this.options), newOptions));
+    };
+    return Layer;
+}((0, UserInteractionsLayerMixin_1.default)(Layer_1.default)));
+exports.default = Layer;

package/ol/layers/MapboxLayer.js

@@ -0,0 +1,137 @@
+"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 });
+/* eslint-disable no-underscore-dangle */
+var mapbox_gl_1 = require("mapbox-gl");
+var Layer_1 = require("./Layer");
+var MapboxLayerMixin_1 = require("../../common/mixins/MapboxLayerMixin");
+var utils_1 = require("../../common/utils");
+/**
+ * A class representing Mapboxlayer to display on BasicMap
+ *
+ * @example
+ * import { MapboxLayer } from 'mobility-toolbox-js/ol';
+ *
+ * const layer = new MapboxLayer({
+ *   url: 'https://maps.geops.io/styles/travic_v2/style.json',
+ *   apikey: 'yourApiKey',
+ * });
+ *
+ * @classproperty {ol/Map~Map} map - The map where the layer is displayed.
+ * @extends {Layer}
+ */
+var MapboxLayer = /** @class */ (function (_super) {
+    __extends(MapboxLayer, _super);
+    function MapboxLayer() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Initialize the layer and listen to feature clicks.
+     * @param {ol/Map~Map} map
+     */
+    MapboxLayer.prototype.attachToMap = function (map) {
+        var _this = this;
+        _super.prototype.attachToMap.call(this, map);
+        if (!this.map || this.mbMap) {
+            return;
+        }
+        this.olListenersKeys.push(this.map.on('change:size', function () {
+            try {
+                if (_this.mbMap) {
+                    _this.mbMap.resize();
+                }
+            }
+            catch (err) {
+                // ignore render errors
+                // eslint-disable-next-line no-console
+                console.warn(err);
+            }
+        }));
+    };
+    /**
+     * Create the mapbox map.
+     * @private
+     */
+    MapboxLayer.prototype.loadMbMap = function () {
+        var _this = this;
+        // If the map hasn't been resized, the center could be [NaN,NaN].
+        // We set default good value for the mapbox map, to avoid the app crashes.
+        var _a = this.map.getView().getCenter(), x = _a[0], y = _a[1];
+        if (!x || !y) {
+            x = 0;
+            y = 0;
+        }
+        // Options the last render run did happen. If something changes
+        // we have to render again
+        /** @ignore */
+        this.renderState = {
+            center: [x, y],
+            zoom: null,
+            rotation: null,
+            visible: null,
+            opacity: null,
+            size: [0, 0],
+        };
+        _super.prototype.loadMbMap.call(this);
+        this.mbMap.once('load', function () {
+            var _a;
+            _this.mbMap.resize();
+            /** @ignore */
+            _this.copyrights = (0, utils_1.getMapboxMapCopyrights)(_this.mbMap) || [];
+            (_a = _this.olLayer.getSource()) === null || _a === void 0 ? void 0 : _a.setAttributions(_this.copyrights);
+        });
+        var mapboxCanvas = this.mbMap.getCanvas();
+        if (mapboxCanvas) {
+            if (this.options.tabIndex) {
+                mapboxCanvas.setAttribute('tabindex', this.options.tabIndex);
+            }
+            else {
+                // With a tabIndex='-1' the mouse events works but the map is not focused when we click on it
+                // so we remove completely the tabIndex attribute.
+                mapboxCanvas.removeAttribute('tabindex');
+            }
+        }
+    };
+    MapboxLayer.prototype.getOlLayerRender = function () {
+        return (0, utils_1.getMapboxRender)(this);
+    };
+    // eslint-disable-next-line class-methods-use-this
+    MapboxLayer.prototype.getMapboxMapClass = function () {
+        return mapbox_gl_1.Map;
+    };
+    /**
+     * Create a copy of the MapboxLayer.
+     * @param {Object} newOptions Options to override
+     * @return {MapboxLayer} A MapboxLayer
+     */
+    MapboxLayer.prototype.clone = function (newOptions) {
+        return new MapboxLayer(__assign(__assign({}, this.options), newOptions));
+    };
+    return MapboxLayer;
+}((0, MapboxLayerMixin_1.default)(Layer_1.default)));
+exports.default = MapboxLayer;