@wemap/positioning 2.7.13 → 14.0.0-0

package/src/PositioningHandler.js

@@ -1,237 +0,0 @@
-/* eslint-disable max-statements */
-import EventType from './events/EventType';
-import PdrProvider from './providers/pose/pdr/PdrProvider';
-import GnssWifiPdrProvider from './providers/pose/GnssWifiPdrProvider';
-import PoseProvider from './providers/pose/PoseProvider';
-import PositioningOptions from './PositioningOptions';
-import InclinationProvider from './providers/others/InclinationProvider';
-import Logger from '@wemap/logger';
-import ArCoreAbsoluteProvider from './providers/pose/ArCoreAbsoluteProvider';
-import GnssWifiProvider from './providers/position/GnssWifiProvider';
-import NoProviderFoundError from './errors/NoProviderFoundError';
-import Availability from './events/Availability';
-import RelativeAttitudeProvider from './providers/attitude/RelativeAttitudeProvider';
-import AbsoluteAttitudeProvider from './providers/attitude/AbsoluteAttitudeProvider';
-
-/**
- * @private
- */
-class PositioningHandler {
-
-    providerInstances = [];
-
-    /**
-     * Constructor of PositioningHandler
-     * @public
-     */
-    constructor() {
-
-    }
-
-    /**
-     * Start to listen events
-     * @param {EventType[]} eventsType array of events to subscribe
-     * @param {Function} onEvent Callback on events, first and only parameter is a: {@link ProviderEvent[]}.
-     * @param {Function} onError Callback on errors, first and only parameter is a: {@link ProviderError[]}.
-     * @param {PositioningOptions} options
-     * @returns {Number} an id to stop or interact with
-     */
-    start(eventsType, onEvent, onError, options) {
-
-        this.options = Object.assign({}, PositioningOptions, options);
-
-        try {
-            const providerClass = PositioningHandler.findProvider(eventsType, this.options);
-            const provider = Reflect.construct(providerClass, [onEvent, onError, this.options]);
-            this.providerInstances[provider.id] = provider;
-            provider.start();
-
-            return {
-                id: provider.id,
-                name: provider.name,
-                useCameraNatively: provider.useCameraNatively
-            };
-        } catch (e) {
-            onError(e);
-            return null;
-        }
-    }
-
-    /**
-     * @private
-     */
-    static findProvider(eventsType, _options) {
-
-        const options = Object.assign({}, PositioningOptions, _options);
-
-        let availability = Availability.yes();
-        const canUse = (provider) => {
-            availability = provider.checkAvailability(options);
-            return availability.isSupported;
-        };
-
-        const wantInclination = eventsType.length === 1
-            && eventsType.includes(EventType.Inclination);
-
-        if (wantInclination) {
-            if (canUse(InclinationProvider)) {
-                return InclinationProvider;
-            }
-            throw availability.reason;
-        }
-
-        const wantPoseProvider = [EventType.AbsolutePosition, EventType.AbsoluteAttitude]
-            .every(elem => eventsType.includes(elem)) && eventsType.length === 2;
-
-        if (wantPoseProvider) {
-
-            if (options.waitInputPosition) {
-                if (canUse(ArCoreAbsoluteProvider)) {
-                    return ArCoreAbsoluteProvider;
-                }
-                if (canUse(PdrProvider)) {
-                    return PdrProvider;
-                }
-
-                throw availability.reason;
-            }
-
-            if (canUse(GnssWifiPdrProvider)) {
-                return GnssWifiPdrProvider;
-            }
-
-            if (canUse(PoseProvider)) {
-                return PoseProvider;
-            }
-
-            if (!options.optionalEvents.includes(EventType.AbsoluteAttitude)) {
-                throw availability.reason;
-            }
-
-            if (canUse(GnssWifiProvider)) {
-                return GnssWifiProvider;
-            }
-
-            throw availability.reason;
-        }
-
-        const wantAbsoluteAttitude = eventsType.length === 1
-            && eventsType.includes(EventType.AbsoluteAttitude);
-
-        if (wantAbsoluteAttitude) {
-            if (canUse(AbsoluteAttitudeProvider)) {
-                return AbsoluteAttitudeProvider;
-            }
-            throw availability.reason;
-        }
-
-
-        const wantRelativeAttitude = eventsType.length === 1
-            && eventsType.includes(EventType.RelativeAttitude);
-
-        if (wantRelativeAttitude) {
-            if (!options.waitInputHeading) {
-                throw new NoProviderFoundError();
-            }
-            if (canUse(RelativeAttitudeProvider)) {
-                return RelativeAttitudeProvider;
-            }
-            throw availability.reason;
-        }
-
-        throw new NoProviderFoundError();
-    }
-
-    /**
-     * @public
-     */
-    stop(providerId) {
-        this.providerInstances[providerId].stop();
-        delete this.providerInstances[providerId];
-    }
-
-    /**
-     * @public
-     */
-    setPosition(id, position) {
-        const provider = this.providerInstances[id];
-        if (!provider) {
-            throw new Error('Unknown provider');
-        }
-        if (!provider.setPosition) {
-            Logger.warn('Cannot set position to ' + provider.constructor.name);
-            return;
-        }
-        provider.setPosition(position);
-    }
-
-    /**
-     * @public
-     */
-    setHeading(id, heading) {
-        const provider = this.providerInstances[id];
-        if (!provider) {
-            throw new Error('Unknown provider');
-        }
-        if (!provider.setHeading) {
-            Logger.warn('Cannot set heading to ' + provider.constructor.name);
-            return;
-        }
-        provider.setHeading(heading);
-    }
-
-    /**
-     * @public
-     */
-    setItinerary(id, itinerary) {
-        const provider = this.providerInstances[id];
-        if (!provider) {
-            throw new Error('Unknown provider');
-        }
-        if (!provider.setItinerary) {
-            Logger.warn('Cannot set itinerary to ' + provider.constructor.name);
-            return;
-        }
-        provider.setItinerary(itinerary);
-    }
-
-    /**
-     * @public
-     */
-    setNetwork(id, network) {
-        const provider = this.providerInstances[id];
-        if (!provider) {
-            throw new Error('Unknown provider');
-        }
-        if (!provider.setNetwork) {
-            Logger.warn('Cannot set network to ' + provider.constructor.name);
-            return;
-        }
-        provider.setNetwork(network);
-    }
-
-    /**
-     * @public
-     */
-    enableBarcodeScanner(id) {
-        const provider = this.providerInstances[id];
-        if (!(provider instanceof ArCoreAbsoluteProvider)) {
-            throw new Error('Not available. ArCore not started');
-        }
-        provider.enableBarcodeScanner();
-    }
-
-    /**
-     * @public
-     */
-    disableBarcodeScanner(id) {
-        const provider = this.providerInstances[id];
-        if (!(provider instanceof ArCoreAbsoluteProvider)) {
-            throw new Error('Not available. ArCore not started');
-        }
-        provider.disableBarcodeScanner();
-    }
-
-}
-
-export default PositioningHandler;

package/src/PositioningHandler.spec.js

@@ -1,294 +0,0 @@
-import chai from 'chai';
-
-import PositioningHandler from './PositioningHandler';
-import EventType from './events/EventType';
-import InclinationProvider from './providers/others/InclinationProvider';
-import GnssWifiPdrProvider from './providers/pose/GnssWifiPdrProvider';
-import PoseProvider from './providers/pose/PoseProvider';
-import PdrProvider from './providers/pose/pdr/PdrProvider';
-import ArCoreAbsoluteProvider from './providers/pose/ArCoreAbsoluteProvider';
-import GnssWifiProvider from './providers/position/GnssWifiProvider';
-import ArCoreProvider from './providers/pose/ArCoreProvider';
-import { ProvidersName } from './providers/ProvidersList';
-import AskImuOnDesktopError from './errors/AskImuOnDesktopError';
-import ContainsIgnoredProviderError from './errors/ContainsIgnoredProviderError';
-import AbsoluteAttitudeProvider from './providers/attitude/AbsoluteAttitudeProvider';
-import NoProviderFoundError from './errors/NoProviderFoundError';
-import RelativeAttitudeProvider from './providers/attitude/RelativeAttitudeProvider';
-
-const expect = chai.expect;
-
-function fakeUserAgent(userAgent) {
-    global.navigator = { userAgent };
-}
-
-function fakeNativeInterface(arcore = true) {
-    // We have to clear the cache here
-    ArCoreProvider._nativeProvider = null;
-
-    global.WemapProvidersAndroid = {
-        getArCoreProvider: () => {
-            return { checkAvailability: () => arcore };
-        }
-    };
-}
-
-function fakeGeolocation() {
-    navigator.__defineGetter__('geolocation', () => {
-        return { watchPosition: () => { } };
-    });
-}
-
-function config(userAgent, nativeInterface = false, arcore = false) {
-    if (userAgent) {
-        fakeUserAgent(userAgent);
-    }
-    if (nativeInterface) {
-        fakeNativeInterface(arcore);
-    } else {
-        delete global.WemapProvidersAndroid;
-    }
-    fakeGeolocation();
-}
-
-const CHROME_ANDROID_USER_AGENT = 'Mozilla/5.0 (Linux; Android 9; SM-G960F Build/PPR1.180610.011; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/74.0.3729.157 Mobile Safari/537.36';
-
-const CHROME_DESKTOP_USER_AGENT = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36';
-
-describe('PositioningHandler#findProvider', () => {
-
-    it('Inclination Desktop', () => {
-        config(CHROME_DESKTOP_USER_AGENT);
-
-        expect(
-            () => PositioningHandler.findProvider([EventType.Inclination])
-        ).to.throw(AskImuOnDesktopError);
-    });
-
-    it('Inclination Mobile', () => {
-        config(CHROME_ANDROID_USER_AGENT);
-        const provider = PositioningHandler.findProvider([EventType.Inclination]);
-        expect(provider).to.be.equals(InclinationProvider);
-    });
-
-    it('Pose Desktop', () => {
-        config(CHROME_DESKTOP_USER_AGENT);
-        expect(
-            () => PositioningHandler.findProvider([EventType.AbsolutePosition, EventType.AbsoluteAttitude])
-        ).to.throw(AskImuOnDesktopError);
-    });
-
-    it('Pose without PDR Desktop', () => {
-        config(CHROME_DESKTOP_USER_AGENT);
-        expect(
-            () => PositioningHandler.findProvider(
-                [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-                { ignoreProviders: [PdrProvider] }
-            )
-        ).to.throw(AskImuOnDesktopError);
-    });
-
-    it('Pose without ArCore Desktop', () => {
-        config(CHROME_DESKTOP_USER_AGENT);
-        expect(
-            () => PositioningHandler.findProvider(
-                [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-                { ignoreProviders: [ArCoreProvider] }
-            )
-        ).to.throw(AskImuOnDesktopError);
-    });
-
-    it('Pose with optional attitude Desktop', () => {
-        config(CHROME_DESKTOP_USER_AGENT);
-        expect(
-            () => PositioningHandler.findProvider([EventType.AbsolutePosition, EventType.AbsoluteAttitude])
-        ).to.throw(AskImuOnDesktopError);
-    });
-
-    it('Pose with optional attitude without PDR Desktop', () => {
-        config(CHROME_DESKTOP_USER_AGENT);
-        const provider = PositioningHandler.findProvider(
-            [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-            {
-                ignoreProviders: [ProvidersName.Pdr],
-                optionalEvents: [EventType.AbsoluteAttitude]
-            }
-        );
-        expect(provider).to.be.equals(GnssWifiProvider);
-    });
-
-    it('Pose with optional attitude without ArCore Desktop', () => {
-        config(CHROME_DESKTOP_USER_AGENT);
-        const provider = PositioningHandler.findProvider(
-            [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-            {
-                ignoreProviders: [ProvidersName.ArCore],
-                optionalEvents: [EventType.AbsoluteAttitude]
-            }
-        );
-        expect(provider).to.be.equals(GnssWifiProvider);
-    });
-
-    it('Pose with optional attitude without PDR and ArCore Desktop', () => {
-        config(CHROME_DESKTOP_USER_AGENT);
-        const provider = PositioningHandler.findProvider(
-            [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-            {
-                ignoreProviders: [ProvidersName.Pdr, ProvidersName.ArCore],
-                optionalEvents: [EventType.AbsoluteAttitude]
-            }
-        );
-        expect(provider).to.be.equals(GnssWifiProvider);
-    });
-
-    it('Pose Mobile Web', () => {
-        config(CHROME_ANDROID_USER_AGENT);
-        const provider = PositioningHandler.findProvider([EventType.AbsolutePosition, EventType.AbsoluteAttitude]);
-        expect(provider).to.be.equals(GnssWifiPdrProvider);
-    });
-
-    it('Pose without PDR Mobile Web', () => {
-        config(CHROME_ANDROID_USER_AGENT);
-        const provider = PositioningHandler.findProvider(
-            [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-            { ignoreProviders: [ProvidersName.Pdr] }
-        );
-        expect(provider).to.be.equals(PoseProvider);
-    });
-
-    it('Pose without ArCore Mobile Web', () => {
-        config(CHROME_ANDROID_USER_AGENT);
-        const provider = PositioningHandler.findProvider(
-            [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-            { ignoreProviders: [ProvidersName.ArCore] }
-        );
-        expect(provider).to.be.equals(GnssWifiPdrProvider);
-    });
-
-    it('Pose without PDR and ArCore Mobile Web', () => {
-        config(CHROME_ANDROID_USER_AGENT);
-        const provider = PositioningHandler.findProvider(
-            [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-            { ignoreProviders: [ProvidersName.Pdr, ProvidersName.ArCore] }
-        );
-        expect(provider).to.be.equals(PoseProvider);
-    });
-
-    it('Pose with waitInputPosition Mobile Web', () => {
-        config(CHROME_ANDROID_USER_AGENT);
-        const provider = PositioningHandler.findProvider(
-            [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-            { waitInputPosition: true }
-        );
-        expect(provider).to.be.equals(PdrProvider);
-    });
-
-    it('Pose with waitInputPosition Mobile Native with ArCore', () => {
-        config(CHROME_ANDROID_USER_AGENT, true, true);
-        const provider = PositioningHandler.findProvider(
-            [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-            { waitInputPosition: true }
-        );
-        expect(provider).to.be.equals(ArCoreAbsoluteProvider);
-    });
-
-    it('Pose with waitInputPosition Mobile Native without ArCore', () => {
-        config(CHROME_ANDROID_USER_AGENT, true, false);
-        const provider = PositioningHandler.findProvider(
-            [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-            {
-                waitInputPosition: true,
-                ignoreProviders: [ProvidersName.ArCore]
-            }
-        );
-        expect(provider).to.be.equals(PdrProvider);
-    });
-
-    it('Pose with waitInputPosition without PDR Mobile Web', () => {
-        config(CHROME_ANDROID_USER_AGENT, false);
-        expect(
-            () => PositioningHandler.findProvider(
-                [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-                {
-                    waitInputPosition: true,
-                    ignoreProviders: [ProvidersName.Pdr]
-                }
-            )
-        ).to.throw(ContainsIgnoredProviderError);
-    });
-
-    it('Pose with waitInputPosition without ArCore Mobile Native', () => {
-        config(CHROME_ANDROID_USER_AGENT, true, true);
-        const provider = PositioningHandler.findProvider(
-            [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-            {
-                waitInputPosition: true,
-                ignoreProviders: [ProvidersName.ArCore]
-            }
-        );
-        expect(provider).to.be.equals(PdrProvider);
-    });
-
-    it('Pose without GnssWifi Desktop', () => {
-        config(CHROME_DESKTOP_USER_AGENT, false);
-        expect(
-            () => PositioningHandler.findProvider(
-                [EventType.AbsolutePosition, EventType.AbsoluteAttitude],
-                {
-                    ignoreProviders: [ProvidersName.GnssWifi],
-                    optionalEvents: [EventType.AbsoluteAttitude]
-                }
-            )
-        ).to.throw(ContainsIgnoredProviderError);
-    });
-
-    it('Absolute Attitude Desktop', () => {
-        config(CHROME_DESKTOP_USER_AGENT);
-        expect(
-            () => PositioningHandler.findProvider([EventType.AbsoluteAttitude])
-        ).to.throw(AskImuOnDesktopError);
-    });
-
-
-    it('Absolute Attitude Web', () => {
-        config(CHROME_ANDROID_USER_AGENT);
-        const provider = PositioningHandler.findProvider([EventType.AbsoluteAttitude]);
-        expect(provider).to.be.equals(AbsoluteAttitudeProvider);
-    });
-
-
-    it('Relative Attitude Desktop without waitInputHeading', () => {
-        config(CHROME_DESKTOP_USER_AGENT);
-        expect(
-            () => PositioningHandler.findProvider([EventType.RelativeAttitude])
-        ).to.throw(NoProviderFoundError);
-    });
-
-    it('Relative Attitude Desktop', () => {
-        config(CHROME_DESKTOP_USER_AGENT);
-        expect(() => PositioningHandler.findProvider(
-            [EventType.RelativeAttitude],
-            { waitInputHeading: true })
-        ).to.throw(AskImuOnDesktopError);
-    });
-
-    it('Relative Attitude Web without waitInputHeading', () => {
-        config(CHROME_ANDROID_USER_AGENT);
-        expect(
-            () => PositioningHandler.findProvider([EventType.RelativeAttitude])
-        ).to.throw(NoProviderFoundError);
-    });
-
-
-    it('Relative Attitude Web', () => {
-        config(CHROME_ANDROID_USER_AGENT);
-        const provider = PositioningHandler.findProvider(
-            [EventType.RelativeAttitude],
-            { waitInputHeading: true }
-        );
-        expect(provider).to.be.equals(RelativeAttitudeProvider);
-    });
-
-});
-
-delete global.navigator;

package/src/PositioningOptions.js

@@ -1,34 +0,0 @@
-const PositioningOptions = {
-
-    /**
-     * Does provider have to wait an input position to start
-     * @see PositioningHandler#setPosition()
-     */
-    waitInputPosition: false,
-
-    /**
-     * Does provider have to wait an input heading to start
-     * @see PositioningHandler#setHeading()
-     */
-    waitInputHeading: false,
-
-    /**
-     * Does provider will use map to
-     * @see PositioningHandler#setItinerary()
-     */
-    useMapMatching: false,
-
-    /**
-     * Providers listed here will not be used by PositioningHandler
-     * List of {@link Provider#name}
-     */
-    ignoreProviders: [],
-
-    /**
-     * Define the list of EventType that are optionals
-     * List of {@link EventType}
-     */
-    optionalEvents: []
-};
-
-export default PositioningOptions;

package/src/errors/AskImuOnDesktopError.js

@@ -1,9 +0,0 @@
-const DEFAULT_MESSAGE = 'It seems that you ask for IMU events on a desktop browser';
-
-class AskImuOnDesktopError extends Error {
-    constructor(message) {
-        super(message || DEFAULT_MESSAGE);
-    }
-}
-
-export default AskImuOnDesktopError;

package/src/errors/ContainsIgnoredProviderError.js

@@ -1,9 +0,0 @@
-const DEFAULT_MESSAGE = 'Contains ignored provider';
-
-class ContainsIgnoredProviderError extends Error {
-    constructor(message) {
-        super(message || DEFAULT_MESSAGE);
-    }
-}
-
-export default ContainsIgnoredProviderError;

package/src/errors/GeolocationApiMissingError.js

@@ -1,9 +0,0 @@
-const DEFAULT_MESSAGE = 'Geolocation api is missing';
-
-class GeolocationApiMissingError extends Error {
-    constructor(message) {
-        super(message || DEFAULT_MESSAGE);
-    }
-}
-
-export default GeolocationApiMissingError;

package/src/errors/GeolocationPermissionDeniedError.js

@@ -1,9 +0,0 @@
-const DEFAULT_MESSAGE = 'Geolocation permission denied';
-
-class GeolocationPermissionDeniedError extends Error {
-    constructor(message) {
-        super(message || DEFAULT_MESSAGE);
-    }
-}
-
-export default GeolocationPermissionDeniedError;

package/src/errors/GeolocationPositionUnavailableError.js

@@ -1,9 +0,0 @@
-const DEFAULT_MESSAGE = 'Geolocation position unavailable';
-
-class GeolocationPositionUnavailableError extends Error {
-    constructor(message) {
-        super(message || DEFAULT_MESSAGE);
-    }
-}
-
-export default GeolocationPositionUnavailableError;

package/src/errors/IpResolveServerError.js

@@ -1,9 +0,0 @@
-const DEFAULT_MESSAGE = 'IP Resolver failed';
-
-class IpResolveServerError extends Error {
-    constructor(message) {
-        super(message || DEFAULT_MESSAGE);
-    }
-}
-
-export default IpResolveServerError;

package/src/errors/MissingAccelerometerError.js

@@ -1,11 +0,0 @@
-const DEFAULT_MESSAGE = 'Impossible to retrieve Acceleration data';
-
-import MissingSensorError from './MissingSensorError';
-
-class MissingAccelerometerError extends MissingSensorError {
-    constructor(message) {
-        super(message || DEFAULT_MESSAGE);
-    }
-}
-
-export default MissingAccelerometerError;

package/src/errors/MissingArCoreError.js

@@ -1,9 +0,0 @@
-const DEFAULT_MESSAGE = 'ARCore is missing';
-
-class MissingArCoreError extends Error {
-    constructor(message) {
-        super(message || DEFAULT_MESSAGE);
-    }
-}
-
-export default MissingArCoreError;

package/src/errors/MissingGyroscopeError.js

@@ -1,11 +0,0 @@
-const DEFAULT_MESSAGE = 'Impossible to retrieve Angular Rate data';
-
-import MissingSensorError from './MissingSensorError';
-
-class MissingGyroscopeError extends MissingSensorError {
-    constructor(message) {
-        super(message || DEFAULT_MESSAGE);
-    }
-}
-
-export default MissingGyroscopeError;

package/src/errors/MissingMagnetometerError.js

@@ -1,9 +0,0 @@
-import MissingSensorError from './MissingSensorError';
-
-class MissingMagnetometerError extends MissingSensorError {
-    constructor(message) {
-        super(message);
-    }
-}
-
-export default MissingMagnetometerError;

package/src/errors/MissingNativeInterfaceError.js

@@ -1,9 +0,0 @@
-const DEFAULT_MESSAGE = 'Native interface is missing';
-
-class MissingNativeInterfaceError extends Error {
-    constructor(message) {
-        super(message || DEFAULT_MESSAGE);
-    }
-}
-
-export default MissingNativeInterfaceError;