mobility-toolbox-js 2.0.0-beta.8 → 2.0.0-beta.80

package/src/common/api/api.js

@@ -1,64 +0,0 @@
-import qs from 'query-string';
-import BaseObject from 'ol/Object';
-
-/**
- * Common class to access to a geOps api.
- *
- * @example
- * import { API } from 'mobility-toolbox-js/api';
- *
- * const api = new API({
- *   url: [yourUrl],
- *   apiKey: [yourApiKey]
- * });
- *
- * @classproperty {string} url Url of the service.
- * @classproperty {string} apiKey Api key to access the service.
- */
-class API extends BaseObject {
-  constructor(options = {}) {
-    super();
-    /** @ignore */
-    this.url = options.url;
-
-    /** @ignore */
-    this.apiKey = options.apiKey;
-  }
-
-  /**
-   * Append the apiKey before sending the request.
-   * @ignore
-   */
-  fetch(path, params, config) {
-    // Clean requets parameters, removing undefined and null values.
-    const urlParams = { ...(params || {}), key: this.apiKey };
-    const clone = { ...urlParams };
-    Object.keys(urlParams).forEach(
-      (key) =>
-        (clone[key] === undefined || clone[key] === null) && delete clone[key],
-    );
-    if (!this.apiKey) {
-      // eslint-disable-next-line no-console
-      return Promise.reject(
-        new Error(`No apiKey defined for request to ${this.url}`),
-      );
-    }
-    return fetch(
-      `${this.url}${path || ''}?${qs.stringify(clone)}`,
-      config,
-    ).then((response) => {
-      try {
-        return response.json().then((data) => {
-          if (data.error) {
-            throw new Error(data.error);
-          }
-          return data;
-        });
-      } catch (err) {
-        return Promise.reject(new Error(err));
-      }
-    });
-  }
-}
-
-export default API;

package/src/common/api/api.test.js

@@ -1,68 +0,0 @@
-import fetch from 'jest-fetch-mock';
-import API from './api';
-
-let api;
-
-describe('API', () => {
-  beforeEach(() => {
-    global.fetch = fetch;
-    fetch.resetMocks();
-
-    api = new API({ url: 'https://foo.ch', apiKey: 'apiKey' });
-  });
-
-  describe('#fetch', () => {
-    test('should success', () => {
-      fetch.mockResponseOnce(JSON.stringify({ foo: 'bar' }));
-
-      return api
-        .fetch('/path', {
-          q: 'Bern',
-          fooUndefined: undefined,
-          fooNull: null,
-          fooEmpty: '',
-        })
-        .then((response) => {
-          // Correct url
-          expect(fetch.mock.calls[0][0]).toEqual(
-            'https://foo.ch/path?fooEmpty=&key=apiKey&q=Bern',
-          );
-
-          // Correct search result
-          expect(response).toEqual({ foo: 'bar' });
-        });
-    });
-
-    describe('should display error message', () => {
-      test('reject error', (done) => {
-        fetch.mockRejectOnce(new Error('Fake error message'));
-        return api.fetch().catch((err) => {
-          expect(err.name).toEqual('Error');
-          expect(err.message).toEqual('Fake error message');
-          done();
-        });
-      });
-
-      test('if the response is invalid json', (done) => {
-        fetch.mockResponseOnce('invalid json');
-
-        api.fetch().catch((err) => {
-          expect(err.name).toEqual('FetchError');
-          expect(err.message).toEqual(
-            'invalid json response body at  reason: Unexpected token i in JSON at position 0',
-          );
-          done();
-        });
-      });
-
-      test('if the response contains an error message', (done) => {
-        fetch.mockResponseOnce('{"error":"foo2"}');
-        api.fetch().catch((err) => {
-          expect(err.name).toEqual('Error');
-          expect(err.message).toEqual('foo2');
-          done();
-        });
-      });
-    });
-  });
-});

package/src/common/controls/Control.js

@@ -1,146 +0,0 @@
-import BaseObject from 'ol/Object';
-
-/**
- * A class representing a control to display on map.
- *
- * @example
- * const control = new Control();
- *
- * @classproperty {ol/Map~Map|mapboxgl.Map} map - The map which the control refers to.
- * @classproperty {boolean} active - Active the control.
- * @classproperty {HTMLElement} element - The HTML element used to render the control.
- * @classproperty {HTMLElement} target - The HTML element where to render the element property. Default is the map's element. Read only.
- */
-class Control extends BaseObject {
-  /**
-   * Constructor
-   *
-   * @param {Object} [options] Control options.
-   * @param {boolean} [options.active = true] Whether the control is active or not.
-   * @param {HTMLElement} [options.element] The HTML element used to render the control.
-   * @param {HTMLElement} [options.target] The HTML element where to render the element property. Default is the map's element.
-   * @param {function} [options.render] Render function called whenever the control needs to be rerendered.
-   */
-  constructor(options = {}) {
-    super(options);
-    this.defineProperties(options);
-
-    const { active } = {
-      active: options.active !== false,
-      ...options,
-    };
-
-    /**
-     * @ignore
-     */
-    this.active = active;
-  }
-
-  /**
-   * Define control's properties.
-   *
-   * @private
-   */
-  defineProperties(options) {
-    const { target, element, render } = {
-      ...options,
-    };
-
-    Object.defineProperties(this, {
-      active: {
-        get: () => this.get('active'),
-        set: (newActive) => {
-          this.set('active', newActive);
-          if (newActive) {
-            this.activate();
-          } else {
-            this.deactivate();
-          }
-          this.render();
-        },
-      },
-      map: {
-        get: () => this.get('map'),
-        set: (map) => {
-          // Remove previous node.
-          if (this.map && this.element && this.element.parentNode) {
-            this.element.parentNode.removeChild(this.element);
-          }
-
-          // Clean listeners
-          this.deactivate();
-
-          this.set('map', map);
-
-          if (this.map) {
-            // Add new node
-            const targett =
-              this.target ||
-              (this.map.getTargetElement && this.map.getTargetElement()) ||
-              (this.map.getContainer && this.map.getContainer());
-
-            if (!this.element) {
-              this.createDefaultElement();
-            }
-
-            if (this.element) {
-              targett.appendChild(this.element);
-            }
-
-            // Add listeners
-            if (this.active) {
-              this.activate();
-            }
-          }
-          this.render();
-        },
-      },
-      target: {
-        value: target,
-      },
-      element: {
-        value: element,
-        writable: true,
-      },
-      render: {
-        /** @ignore */
-        value: render || this.render,
-        writable: true,
-      },
-    });
-  }
-
-  /**
-   * Add listeners then renders the control.
-   * To be defined in inherited classes.
-   */
-  activate() {
-    this.deactivate();
-  }
-
-  /**
-   * Remove listeners added by activate() function then renders the control.
-   * To be defined in inherited classes.
-   */
-  // eslint-disable-next-line class-methods-use-this
-  deactivate() {}
-
-  /**
-   * The default render function. It renders content in the HTML element.
-   * To be defined in inherited classes.
-   *
-   * @private
-   */
-  render() {}
-
-  /**
-   * The default element to display if this.element is not defined.
-   * To be defined in inherited classes.
-   *
-   * @private
-   */
-  // eslint-disable-next-line class-methods-use-this
-  createDefaultElement() {}
-}
-
-export default Control;

package/src/common/controls/Control.test.js

@@ -1,98 +0,0 @@
-import Control from './Control';
-
-describe('Control', () => {
-  test('should be activated by default', () => {
-    const control = new Control();
-    expect(control.active).toBe(true);
-  });
-
-  test('should not be activated if set to false in the options', () => {
-    const control = new Control({ active: false });
-    expect(control.active).toBe(false);
-  });
-
-  test('should call activate/deactivate when active is set to true/false', () => {
-    const control = new Control();
-    const spy1 = jest.spyOn(control, 'activate');
-    const spy2 = jest.spyOn(control, 'deactivate');
-    const spy3 = jest.spyOn(control, 'render');
-    control.active = false;
-    expect(spy1).toBeCalledTimes(0);
-    expect(spy2).toBeCalledTimes(1);
-    expect(spy3).toBeCalledTimes(1);
-    control.active = true;
-    expect(spy1).toBeCalledTimes(1);
-    expect(spy2).toBeCalledTimes(2);
-    expect(spy3).toBeCalledTimes(2);
-  });
-
-  test('should append/remove the element to the map container when map is set', () => {
-    const element = document.createElement('div');
-    const target = document.createElement('div');
-    const control = new Control({
-      element,
-    });
-    const spy1 = jest.spyOn(control, 'activate');
-    const spy2 = jest.spyOn(control, 'deactivate');
-    const spy3 = jest.spyOn(control, 'render');
-    control.map = {
-      getContainer() {
-        return target;
-      },
-    };
-    expect(target.childNodes[0]).toBe(element);
-    expect(spy1).toBeCalledTimes(1);
-    expect(spy2).toBeCalledTimes(2);
-    expect(spy3).toBeCalledTimes(1);
-
-    control.map = null;
-    expect(target.childNodes[0]).toBe();
-    expect(spy1).toBeCalledTimes(1);
-    expect(spy2).toBeCalledTimes(3);
-    expect(spy3).toBeCalledTimes(2);
-  });
-
-  test('should append/remove the element to the target property when map is set', () => {
-    const element = document.createElement('div');
-    const target = document.createElement('div');
-    const control = new Control({
-      target,
-      element,
-    });
-    const spy1 = jest.spyOn(control, 'activate');
-    const spy2 = jest.spyOn(control, 'deactivate');
-    const spy3 = jest.spyOn(control, 'render');
-    control.map = {};
-    expect(target.childNodes[0]).toBe(element);
-    expect(spy1).toBeCalledTimes(1);
-    expect(spy2).toBeCalledTimes(2);
-    expect(spy3).toBeCalledTimes(1);
-
-    control.map = null;
-    expect(target.childNodes[0]).toBe();
-    expect(spy1).toBeCalledTimes(1);
-    expect(spy2).toBeCalledTimes(3);
-    expect(spy3).toBeCalledTimes(2);
-  });
-
-  test('set a custom render method', () => {
-    const spy = jest.fn();
-    // eslint-disable-next-line no-unused-vars
-    const control = new Control({
-      render: spy,
-    });
-    expect(spy).toBeCalledTimes(1);
-  });
-
-  test('pass function params to custom render method', () => {
-    const spy = jest.fn();
-    // eslint-disable-next-line no-unused-vars
-    const control = new Control({
-      render: spy,
-    });
-    control.render('foo', 'bar');
-    expect(spy).toBeCalledTimes(2);
-    expect(spy.mock.calls[1][0]).toBe('foo');
-    expect(spy.mock.calls[1][1]).toBe('bar');
-  });
-});

package/src/common/index.js

@@ -1,5 +0,0 @@
-export { default as Tracker } from './Tracker';
-export * as trackerConfig from './trackerConfig';
-
-export * from './utils';
-export * from './styles';