mobility-toolbox-js 2.0.0-beta.45 → 2.0.0-beta.47

package/common/controls/CopyrightControlCommon.js

@@ -0,0 +1,34 @@
+/* eslint-disable max-classes-per-file */
+import ControlCommon from './ControlCommon';
+/**
+ * A class representing a copyright control to display on map.
+ * This class only draw an html element, with an empty string in it.
+ * Use subclasses to use it in an ol or mapbox map.
+ */
+class CopyrightControlCommon extends ControlCommon {
+    render() {
+        if (!this.element) {
+            return;
+        }
+        this.element.innerHTML = this.active
+            ? this.getCopyrights().join(' | ')
+            : '';
+    }
+    createDefaultElement() {
+        this.element = document.createElement('div');
+        this.element.id = 'mbt-copyright';
+        Object.assign(this.element.style, {
+            position: 'absolute',
+            bottom: 0,
+            right: 0,
+            fontSize: '.8rem',
+            padding: '0 10px',
+        });
+    }
+    getCopyrights() {
+        // eslint-disable-next-line no-console
+        console.error('The getCopyrights() function must be implemented in subclasses.', this);
+        return [];
+    }
+}
+export default CopyrightControlCommon;

package/common/controls/StopFinderControlCommon.d.ts

@@ -0,0 +1,54 @@
+import { FeatureCollection } from '@turf/helpers';
+import { Feature } from 'geojson';
+import { StopsAPI } from '../../api';
+import { StopsAPIOptions } from '../../api/StopsAPI';
+import { StopsParameters } from '../../types';
+import ControlCommon, { ControlCommonOptions } from './ControlCommon';
+export declare type StopFinderControlCommonOptions = ControlCommonOptions & StopsAPIOptions & {
+    placeholder?: string;
+    apiParams: StopsParameters;
+};
+/**
+ * A class representing a stop finder control to display on map.
+ * This class only draw the html elements.
+ * The geographic logic must be implemented by subclasses.
+ */
+declare class StopFinderControlCommon extends ControlCommon {
+    apiParams: StopsParameters;
+    placeholder: string;
+    api: StopsAPI;
+    abortController?: AbortController;
+    suggestionsElt?: HTMLElement;
+    inputElt?: HTMLInputElement;
+    clearElt?: HTMLDivElement;
+    /**
+     * 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/).
+     */
+    constructor(options: StopFinderControlCommonOptions);
+    render(featureCollection?: FeatureCollection): void;
+    createDefaultElement(): void;
+    /**
+     * 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).
+     */
+    search(q: string, abortController: AbortController): Promise<void>;
+    /**
+     * To be defined in inherited class
+     */
+    onSuggestionClick(suggestion: Feature): void;
+    /**
+     * Clear the search field and close the control.
+     */
+    clear(): void;
+}
+export default StopFinderControlCommon;
+//# sourceMappingURL=StopFinderControlCommon.d.ts.map

package/common/controls/StopFinderControlCommon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StopFinderControlCommon.d.ts","sourceRoot":"","sources":["../../../src/common/controls/StopFinderControlCommon.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,aAAa,EAAE,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAEtE,oBAAY,8BAA8B,GAAG,oBAAoB,GAC/D,eAAe,GAAG;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,eAAe,CAAC;CAC5B,CAAC;AAEJ;;;;GAIG;AACH,cAAM,uBAAwB,SAAQ,aAAa;IACjD,SAAS,EAAE,eAAe,CAAC;IAE3B,WAAW,EAAE,MAAM,CAAC;IAEpB,GAAG,EAAE,QAAQ,CAAC;IAEd,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC,cAAc,CAAC,EAAE,WAAW,CAAC;IAE7B,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAE5B,QAAQ,CAAC,EAAE,cAAc,CAAC;IAE1B;;;;;;;;OAQG;gBACS,OAAO,EAAE,8BAA8B;IAenD,MAAM,CAAC,iBAAiB,CAAC,EAAE,iBAAiB;IAwB5C,oBAAoB;IAuDpB;;;;;;OAMG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe;IAsBlD;;OAEG;IAEH,iBAAiB,CAAC,UAAU,EAAE,OAAO;IAErC;;OAEG;IACH,KAAK;CASN;AAED,eAAe,uBAAuB,CAAC"}

package/common/{mixins/StopFinderMixin.js → controls/StopFinderControlCommon.js}

@@ -1,14 +1,11 @@
-/* eslint-disable no-empty-function */
-/* eslint-disable no-useless-constructor */
-/* eslint-disable class-methods-use-this */
-/* eslint-disable max-classes-per-file */
 import { StopsAPI } from '../../api';
+import ControlCommon from './ControlCommon';
 /**
- * StopFinder control interface.
- *
- * @classproperty {StopsSearchParams} apiParams - Default request parameters used by the search method. See [Stops service documentation](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
+ * A class representing a stop finder control to display on map.
+ * This class only draw the html elements.
+ * The geographic logic must be implemented by subclasses.
  */
-export class StopFinderInterface {
+class StopFinderControlCommon extends ControlCommon {
     /**
      * Constructor.
      *
@@ -18,27 +15,7 @@ export class StopFinderInterface {
      * @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
-    constructor(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
-    search(query, abortController) { }
-}
-/**
- * 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
- */
-const StopFinderMixin = (Base) => class extends Base {
-    constructor(options = {}) {
+    constructor(options) {
         super(options);
         const { apiParams, apiKey, url } = options;
         this.apiParams = Object.assign({ limit: 20 }, (apiParams || {}));
@@ -58,16 +35,17 @@ const StopFinderMixin = (Base) => class extends Base {
         this.suggestionsElt.style.display = suggestions.length ? 'block' : 'none';
         this.suggestionsElt.innerHTML = '';
         suggestions.forEach((suggestion) => {
-            const { properties } = suggestion;
+            var _a, _b;
             const suggElt = document.createElement('div');
-            suggElt.innerHTML = properties.name;
+            suggElt.innerHTML = (_a = suggestion === null || suggestion === void 0 ? void 0 : suggestion.properties) === null || _a === void 0 ? void 0 : _a.name;
             suggElt.onclick = () => {
+                // @ts-ignore
                 this.onSuggestionClick(suggestion);
             };
             Object.assign(suggElt.style, {
                 padding: '5px 12px',
             });
-            this.suggestionsElt.appendChild(suggElt);
+            (_b = this.suggestionsElt) === null || _b === void 0 ? void 0 : _b.appendChild(suggElt);
         });
     }
     createDefaultElement() {
@@ -89,10 +67,12 @@ const StopFinderMixin = (Base) => class extends Base {
         this.inputElt = document.createElement('input');
         this.inputElt.type = 'text';
         this.inputElt.placeholder = this.placeholder;
-        this.inputElt.autoComplete = 'off';
+        this.inputElt.autocomplete = 'off';
         this.inputElt.onkeyup = (evt) => {
-            this.abortController.abort();
+            var _a;
+            (_a = this.abortController) === null || _a === void 0 ? void 0 : _a.abort();
             this.abortController = new AbortController();
+            // @ts-ignore
             this.search(evt.target.value, this.abortController);
         };
         Object.assign(this.inputElt.style, {
@@ -120,6 +100,13 @@ const StopFinderMixin = (Base) => class extends Base {
         this.clearElt.onclick = () => this.clear();
         this.element.appendChild(this.clearElt);
     }
+    /**
+     * 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).
+     */
     search(q, abortController) {
         if (q !== undefined || q !== null) {
             this.apiParams.q = q;
@@ -128,7 +115,7 @@ const StopFinderMixin = (Base) => class extends Base {
             this.clearElt.style.display = 'block';
         }
         return this.api
-            .search(this.apiParams, abortController)
+            .search(this.apiParams, abortController && { signal: abortController.signal })
             .then((data) => {
             this.render(data);
         })
@@ -145,12 +132,12 @@ const StopFinderMixin = (Base) => class extends Base {
      * Clear the search field and close the control.
      */
     clear() {
-        if (!this.suggestionsElt) {
+        if (!this.suggestionsElt || !this.inputElt || !this.clearElt) {
             return;
         }
         this.inputElt.value = '';
         this.suggestionsElt.innerHTML = '';
         this.clearElt.style.display = 'none';
     }
-};
-export default StopFinderMixin;
+}
+export default StopFinderControlCommon;

package/common/layers/{Layer.d.ts → LayerCommon.d.ts}

@@ -1,3 +1,19 @@
+import BaseObject from 'ol/Object';
+import type { AnyMap, LayerGetFeatureInfoOptions, LayerGetFeatureInfoResponse } from '../../types';
+export declare type LayerCommonOptions = {
+    key?: string;
+    name?: string;
+    group?: string;
+    copyrights?: string[];
+    children?: Layer[];
+    visible?: Boolean;
+    disabled?: Boolean;
+    hitTolerance?: Number;
+    properties?: {
+        [x: string]: any;
+    };
+    map?: AnyMap;
+};
 /**
  * A class representing a layer to display on map.
  *
@@ -17,6 +33,19 @@
  * @classproperty {ol/Map~Map|mapboxgl.Map} map - The map where the layer is displayed.
  */
 export default class Layer extends BaseObject {
+    key?: string;
+    name?: string;
+    group?: string;
+    copyrights?: string[];
+    children?: Layer[];
+    visible?: boolean;
+    disabled?: boolean;
+    hitTolerance?: number;
+    properties?: {
+        [x: string]: any;
+    };
+    map?: AnyMap;
+    parent?: Layer;
     /**
      * Constructor
      *
@@ -30,34 +59,19 @@ export default class Layer extends BaseObject {
      * @param {number} [options.hitTolerance=5] Hit-detection tolerance in css pixels. Pixels inside the radius around the given position will be checked for features.
      * @param {Object} [options.properties={}] Application-specific layer properties.
      */
-    constructor(options?: {
-        key?: string | undefined;
-        name?: string | undefined;
-        copyrights?: string[] | undefined;
-        children?: Layer[] | undefined;
-        visible?: boolean | undefined;
-        disabled?: boolean | undefined;
-        hitTolerance?: number | undefined;
-        properties?: Object | undefined;
-    });
-    visible: boolean;
-    group: any;
-    copyrights: string[] | undefined;
-    children: Layer[] | undefined;
+    constructor(options?: LayerCommonOptions);
     /**
      * Define layer's properties that needs custom get and set.
      *
      * @ignore
      */
-    defineProperties(options: any): void;
+    defineProperties(options?: LayerCommonOptions): void;
     /**
      * Initialize the layer with the map passed in parameters.
      *
      * @param {ol/Map~Map|mapboxgl.Map} map A map.
      */
-    attachToMap(map: any): void;
-    /** @ignore */
-    map: any;
+    attachToMap(map: AnyMap): void;
     /**
      * Terminate what was initialized in init function. Remove layer, events...
      */
@@ -70,11 +84,10 @@ export default class Layer extends BaseObject {
      * @param {Object} options Some options. See child classes to see which are supported.
      * @return {Promise<FeatureInfo>} An empty response.
      */
-    getFeatureInfoAtCoordinate(coordinate: any, options: Object): Promise<FeatureInfo>;
+    getFeatureInfoAtCoordinate(coordinate: number[], options?: LayerGetFeatureInfoOptions): Promise<LayerGetFeatureInfoResponse>;
     /**
      * Return the an array containing all the descendants of the layer in a flat array. Including the current layer.
      */
     flat(): any[];
 }
-import BaseObject from "ol/Object";
-//# sourceMappingURL=Layer.d.ts.map
+//# sourceMappingURL=LayerCommon.d.ts.map

package/common/layers/LayerCommon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LayerCommon.d.ts","sourceRoot":"","sources":["../../../src/common/layers/LayerCommon.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,WAAW,CAAC;AAInC,OAAO,KAAK,EACV,MAAM,EACN,0BAA0B,EAC1B,2BAA2B,EAC5B,MAAM,aAAa,CAAC;AAErB,oBAAY,kBAAkB,GAAG;IAC/B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,UAAU;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,UAAU,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAElC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,MAAM,CAAC,EAAE,KAAK,CAAC;IAEf;;;;;;;;;;;;OAYG;gBACS,OAAO,GAAE,kBAAuB;IAkC5C;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,GAAE,kBAAuB;IA2IjD;;;;OAIG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM;IAYvB;;OAEG;IAEH,aAAa;IAKb;;;;;;;OAOG;IAEH,0BAA0B,CACxB,UAAU,EAAE,MAAM,EAAE,EAEpB,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,2BAA2B,CAAC;IAgBvC;;OAEG;IACH,IAAI;CAGL"}

package/common/layers/{Layer.js → LayerCommon.js}

@@ -1,5 +1,6 @@
 import BaseObject from 'ol/Object';
 import { v4 as uuid } from 'uuid';
+import BaseEvent from 'ol/events/Event';
 import getLayersAsFlatArray from '../utils/getLayersAsFlatArray';
 /**
  * A class representing a layer to display on map.
@@ -36,13 +37,16 @@ export default class Layer extends BaseObject {
     constructor(options = {}) {
         super();
         this.defineProperties(options);
-        this.setProperties(options.properties);
+        if (options.properties) {
+            this.setProperties(options.properties);
+        }
         this.visible = options.visible === undefined ? true : !!options.visible;
         this.group = options.group;
         this.copyrights = options.copyrights;
         this.children = options.children;
         // Listen for group visiblity change
         // if a layer from a group is newly visible we hide the others.
+        /* @ts-ignore */
         this.on(`change:visible:group`, (evt) => {
             // We hide layer of the same group
             if (this.group === evt.target.group &&
@@ -61,7 +65,7 @@ export default class Layer extends BaseObject {
      *
      * @ignore
      */
-    defineProperties(options) {
+    defineProperties(options = {}) {
         const { name, key, properties, hitTolerance } = Object.assign({}, options);
         const uid = uuid();
         Object.defineProperties(this, {
@@ -122,10 +126,9 @@ export default class Layer extends BaseObject {
                             while (higherParent.parent) {
                                 higherParent = higherParent.parent;
                             }
-                            higherParent.dispatchEvent({
-                                type: `change:visible:group`,
-                                target: this,
-                            });
+                            const evt = new BaseEvent(`change:visible:group`);
+                            evt.target = this;
+                            higherParent.dispatchEvent(evt);
                         }
                     }
                     else if (!this.visible) {
@@ -139,6 +142,7 @@ export default class Layer extends BaseObject {
                         // If the parent has no more visible child we also hide it.
                         if (this.parent &&
                             this.parent.visible &&
+                            this.parent.children &&
                             !this.parent.children.find((child) => child.visible)) {
                             this.parent.visible = false;
                         }
@@ -161,7 +165,7 @@ export default class Layer extends BaseObject {
                 set: (newValue) => {
                     (this.children || []).forEach((child) => {
                         // eslint-disable-next-line no-param-reassign
-                        child.parent = null;
+                        child.parent = undefined;
                     });
                     if (Array.isArray(newValue)) {
                         newValue.forEach((child) => {
@@ -204,7 +208,7 @@ export default class Layer extends BaseObject {
     // eslint-disable-next-line class-methods-use-this
     detachFromMap() {
         /** @ignore */
-        this.map = null;
+        this.map = undefined;
     }
     /**
      * Request feature information for a given coordinate.
@@ -215,7 +219,9 @@ export default class Layer extends BaseObject {
      * @return {Promise<FeatureInfo>} An empty response.
      */
     // eslint-disable-next-line no-unused-vars,@typescript-eslint/no-unused-vars
-    getFeatureInfoAtCoordinate(coordinate, options) {
+    getFeatureInfoAtCoordinate(coordinate, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    options) {
         // eslint-disable-next-line no-console
         console.error('getFeatureInfoAtCoordinate must be implemented by inheriting layers', this.key);
         // This layer returns no feature info.