@wemap/osm 5.6.1 → 6.0.0

package/src/routers/Leg.js

@@ -1,113 +0,0 @@
-import { Coordinates, Network } from '@wemap/geo';
-
-import Step from './Step.js';
-
-class Leg {
-
-    /** @type {!string} can be WALK, BIKE, BUS, TRAM, CAR, FUNICULAR */
-    mode;
-
-    /** @type {!number} */
-    distance;
-
-    /** @type {!number} */
-    duration;
-
-    /** @type {?number} */
-    startTime = null;
-
-    /** @type {?number} */
-    endTime = null;
-
-    /** @type {!{name: ?string, coords: !Coordinates}} */
-    from;
-
-    /** @type {!{name: ?string, coords: !Coordinates}} */
-    to;
-
-    /** @type {!Coordinates[]} */
-    coords;
-
-    /** @type {?{name: !string, routeColor: ?string, routeTextColor: ?string, directionName: ?string}} */
-    transportInfo = null;
-
-    /** @type {?(Step[])} */
-    steps = null;
-
-    /**
-     * @returns {Network}
-     */
-    toNetwork() {
-        return Network.fromCoordinates([this.coords]);
-    }
-
-    /**
-     * @returns {object}
-     */
-    toJson() {
-        const output = {
-            mode: this.mode,
-            from: { coords: this.from.coords.toCompressedJson() },
-            to: { coords: this.to.coords.toCompressedJson() },
-            distance: this.distance,
-            duration: this.duration,
-            coords: this.coords.map(coords => coords.toCompressedJson())
-        };
-        if (this.from.name) {
-            output.from.name = this.from.name;
-        }
-        if (this.to.name) {
-            output.to.name = this.to.name;
-        }
-        if (this.startTime !== null) {
-            output.startTime = this.startTime;
-        }
-        if (this.endTime !== null) {
-            output.endTime = this.endTime;
-        }
-        if (this.transportInfo !== null) {
-            output.transportInfo = this.transportInfo;
-        }
-        if (this.steps !== null && this.steps.length > 0) {
-            output.steps = this.steps.map(step => step.toJson());
-        }
-        return output;
-    }
-
-
-    /**
-     * @param {object} json
-     * @returns {Leg}
-     */
-    static fromJson(json) {
-        const leg = new Leg();
-        leg.mode = json.mode;
-        leg.from = { coords: Coordinates.fromCompressedJson(json.from.coords) };
-        leg.to = { coords: Coordinates.fromCompressedJson(json.to.coords) };
-        leg.distance = json.distance;
-        leg.duration = json.duration;
-        leg.coords = json.coords.map(Coordinates.fromCompressedJson);
-        if (json.from.name) {
-            leg.from.name = json.from.name;
-        }
-        if (json.to.name) {
-            leg.to.name = json.to.name;
-        }
-        if (json.startTime) {
-            leg.startTime = json.startTime;
-        }
-        if (json.endTime) {
-            leg.endTime = json.endTime;
-        }
-        if (json.transportInfo) {
-            leg.transportInfo = json.transportInfo;
-        }
-        if (json.steps) {
-            leg.steps = json.steps.map(Step.fromJson);
-        }
-        return leg;
-    }
-
-}
-
-export default Leg;

package/src/routers/LevelChange.js

@@ -1,65 +0,0 @@
-import { Level, GraphNode, GraphUtils } from '@wemap/geo';
-
-import OsmElement from '../model/OsmElement.js';
-
-class LevelChange {
-
-    /** @type {!string} [up|down] */
-    direction;
-
-    /** @type {!number} [-2, -1, 1, ...] */
-    difference;
-
-    /** @type {?string} [elevator|conveyor|stairs] */
-    type = null;
-
-    /**
-     * @param {GraphNode<OsmElement>} firstNode
-     * @param {GraphNode<OsmElement>} secondNode
-     * @returns {LevelChange}
-     */
-    static fromTwoNodes(firstNode, secondNode) {
-
-        const levelChange = new LevelChange();
-
-        const edge = GraphUtils.getEdgeByNodes(firstNode.edges, firstNode, secondNode);
-
-        if (edge.builtFrom.isElevator) {
-            levelChange.type = 'elevator';
-        } else if (edge.builtFrom.isConveying) {
-            levelChange.type = 'conveyor';
-        } else if (edge.builtFrom.areStairs) {
-            levelChange.type = 'stairs';
-        }
-
-        levelChange.difference = Level.diff(firstNode.coords.level, secondNode.coords.level);
-        levelChange.direction = levelChange.difference > 0 ? 'up' : 'down';
-
-        return levelChange;
-    }
-
-    /**
-     * @returns {object}
-     */
-    toJson() {
-        return {
-            direction: this.direction,
-            difference: this.difference,
-            type: this.type
-        };
-    }
-
-    /**
-     * @param {object} json
-     * @returns {LevelChange}
-     */
-    static fromJson(json) {
-        const levelChange = new LevelChange();
-        levelChange.direction = json.direction;
-        levelChange.difference = json.difference;
-        levelChange.type = json.type;
-        return levelChange;
-    }
-}
-
-export default LevelChange;

package/src/routers/RouterResponse.js

@@ -1,19 +0,0 @@
-import { Coordinates } from '@wemap/geo';
-
-import Itinerary from './Itinerary.js';
-class RouterResponse {
-
-    /** @type {!string} */
-    routerName;
-
-    /** @type {!Coordinates} */
-    from;
-
-    /** @type {!Coordinates} */
-    to;
-
-    /** @type {!(Itinerary[])} */
-    itineraries = [];
-}
-
-export default RouterResponse;

package/src/routers/RouterResponse.type.spec.js

@@ -1,24 +0,0 @@
-import chai from 'chai';
-
-import { Coordinates } from '@wemap/geo';
-
-import RouterResponse from './RouterResponse.js';
-
-import { verifyItineraryData } from './Itinerary.type.spec.js';
-
-const { expect } = chai;
-
-/**
- * @param {RouterResponse} routerResponse
- */
-export function verifyRouterResponseData(routerResponse) {
-
-    expect(routerResponse).instanceOf(RouterResponse);
-    expect(routerResponse.routerName).be.a('string');
-    expect(routerResponse.from).instanceOf(Coordinates);
-    expect(routerResponse.to).instanceOf(Coordinates);
-    expect(routerResponse.itineraries).be.an('array');
-    routerResponse.itineraries.forEach(verifyItineraryData);
-
-}
-

package/src/routers/Step.js

@@ -1,118 +0,0 @@
-import { Coordinates } from '@wemap/geo';
-
-import LevelChange from './LevelChange.js';
-
-class Step {
-
-    /** @type {!boolean} */
-    firstStep = false;
-
-    /** @type {!boolean} */
-    lastStep = false;
-
-    /** @type {!number} */
-    number;
-
-    /** @type {!Coordinates} */
-    coords = [];
-
-
-    /** @type {!number} */
-    angle;
-
-    /** @type {!number} */
-    previousBearing;
-
-    /** @type {!number} */
-    nextBearing;
-
-
-    /** @type {!number} */
-    distance;
-
-    /** @type {?number} */
-    duration = null;
-
-    /** @type {?string} */
-    name = null;
-
-
-    /** @type {?LevelChange} */
-    levelChange = null;
-
-    /** @type {?{?subwayEntrance: boolean, ?subwayEntranceRef: string}} */
-    extras = {};
-
-    /** @type {!number} */
-    _idCoordsInLeg = null;
-
-    /**
-     * @returns {object}
-     */
-    toJson() {
-        const output = {
-            number: this.number,
-            coords: this.coords.toCompressedJson(),
-            angle: this.angle,
-            previousBearing: this.previousBearing,
-            nextBearing: this.nextBearing,
-            distance: this.distance,
-            _idCoordsInLeg: this._idCoordsInLeg
-        };
-        if (this.firstStep) {
-            output.firstStep = true;
-        }
-        if (this.lastStep) {
-            output.lastStep = true;
-        }
-        if (this.duration !== null) {
-            output.duration = this.duration;
-        }
-        if (this.name !== null) {
-            output.name = this.name;
-        }
-        if (this.levelChange !== null) {
-            output.levelChange = this.levelChange.toJson();
-        }
-        if (this.extras && Object.keys(this.extras).length !== 0) {
-            output.extras = this.extras;
-        }
-        return output;
-    }
-
-    /**
-     * @param {object} json
-     * @returns {Step}
-     */
-    static fromJson(json) {
-        const step = new Step();
-        step.number = json.number;
-        step.coords = Coordinates.fromCompressedJson(json.coords);
-        step.angle = json.angle;
-        step.previousBearing = json.previousBearing;
-        step.nextBearing = json.nextBearing;
-        step.distance = json.distance;
-        step._idCoordsInLeg = json._idCoordsInLeg;
-        if (json.firstStep) {
-            step.firstStep = json.firstStep;
-        }
-        if (json.lastStep) {
-            step.lastStep = json.lastStep;
-        }
-        if (json.duration) {
-            step.duration = json.duration;
-        }
-        if (json.name) {
-            step.name = json.name;
-        }
-        if (json.levelChange) {
-            step.levelChange = LevelChange.fromJson(json.levelChange);
-        }
-        if (json.extras) {
-            step.extras = json.extras;
-        }
-        return step;
-    }
-}
-
-export default Step;

package/src/routers/Utils.js

@@ -1,54 +0,0 @@
-import { diffAngle } from '@wemap/maths';
-
-import Itinerary from './Itinerary.js';
-
-/**
- * @param {Itinerary} itinerary
- */
-export function generateStepsMetadata(itinerary) {
-
-    let counter = 1;
-
-    itinerary.legs.forEach((leg, legId) => {
-        leg.steps.forEach((step, stepId) => {
-
-            if (counter === 1) {
-                step.firstStep = true;
-            }
-            if (legId === itinerary.legs.length - 1
-                && stepId === leg.steps.length - 1) {
-                step.lastStep = true;
-            }
-
-            step.number = counter++;
-
-
-            /*
-             * Generate previousBearing, nextBearing and angle
-             */
-
-            let coordsBeforeStep;
-            if (step._idCoordsInLeg > 0) {
-                coordsBeforeStep = leg.coords[step._idCoordsInLeg - 1];
-            } else if (legId === 0) {
-                coordsBeforeStep = itinerary.from;
-            } else {
-                coordsBeforeStep = itinerary.legs[legId - 1].to.coords;
-            }
-
-            let coordsAfterStep;
-            if (step._idCoordsInLeg !== leg.coords.length - 1) {
-                coordsAfterStep = leg.coords[step._idCoordsInLeg + 1];
-            } else if (legId === itinerary.legs.length - 1) {
-                coordsAfterStep = itinerary.to;
-            } else {
-                coordsAfterStep = itinerary.legs[legId + 1].from.coords;
-            }
-
-            step.previousBearing = coordsBeforeStep.bearingTo(step.coords);
-            step.nextBearing = step.coords.bearingTo(coordsAfterStep);
-            step.angle = diffAngle(step.previousBearing, step.nextBearing + Math.PI);
-
-        });
-    });
-}

package/src/routers/cityway/CitywayUtils.js

@@ -1,240 +0,0 @@
-/* eslint-disable max-depth */
-/* eslint-disable max-statements */
-import { Coordinates } from '@wemap/geo';
-import Logger from '@wemap/logger';
-
-import Itinerary from '../Itinerary.js';
-import Leg from '../Leg.js';
-import RouterResponse from '../RouterResponse.js';
-import Step from '../Step.js';
-import { generateStepsMetadata } from '../Utils.js';
-
-/**
- * @param {object} json
- * @returns {Coordinates}
- */
-export function jsonToCoordinates(json) {
-    return new Coordinates(json.Lat, json.Long);
-}
-
-/**
- * @param {string} jsonDate
- * @returns {number}
- */
-function jsonDateToTimestamp(jsonDate) {
-    const [dateStr, timeStr] = jsonDate.split(' ');
-    const [dayStr, monthStr, yearStr] = dateStr.split('/');
-    const [hoursStr, minutesStr, secondsStr] = timeStr.split(':');
-    const date = new Date(
-        Number(yearStr), Number(monthStr) - 1, Number(dayStr),
-        Number(hoursStr), Number(minutesStr), Number(secondsStr)
-    );
-    return date.getTime();
-}
-
-/**
- * @param {string} wktGeometry
- * @returns {Coordinates[]}
- */
-function parseWKTGeometry(wktGeometry) {
-    const tmpCoordsStr = wktGeometry.match(/LINESTRING \((.*)\)/i);
-    if (!tmpCoordsStr) {
-        return null;
-    }
-    return tmpCoordsStr[1].split(',').map(str => {
-        const sp = str.trim().split(' ');
-        return new Coordinates(Number(sp[1]), Number(sp[0]));
-    });
-}
-
-/**
- * @param {string} iso8601Duration
- * @see https://stackoverflow.com/a/29153059/2239938
- */
-function parseDuration(iso8601Duration) {
-    const iso8601DurationRegex = /(-)?P(?:([.,\d]+)Y)?(?:([.,\d]+)M)?(?:([.,\d]+)W)?(?:([.,\d]+)D)?T(?:([.,\d]+)H)?(?:([.,\d]+)M)?(?:([.,\d]+)S)?/;
-
-    var matches = iso8601Duration.match(iso8601DurationRegex);
-
-    // const sign = typeof matches[1] === 'undefined' ? '+' : '-',
-    const years = typeof matches[2] === 'undefined' ? 0 : Number(matches[2]);
-    const months = typeof matches[3] === 'undefined' ? 0 : Number(matches[3]);
-    const weeks = typeof matches[4] === 'undefined' ? 0 : Number(matches[4]);
-    const days = typeof matches[5] === 'undefined' ? 0 : Number(matches[5]);
-    const hours = typeof matches[6] === 'undefined' ? 0 : Number(matches[6]);
-    const minutes = typeof matches[7] === 'undefined' ? 0 : Number(matches[7]);
-    const seconds = typeof matches[8] === 'undefined' ? 0 : Number(matches[8]);
-
-    return seconds
-        + minutes * 60
-        + hours * 3600
-        + days * 86400
-        + weeks * (86400 * 7)
-        + months * (86400 * 30)
-        + years * (86400 * 365.25);
-}
-
-/**
- * Generate multi itineraries from Cityway JSON
- * @param {object} json JSON file provided by Cityway.
- * @returns {?RouterResponse}
- * @example https://preprod.api.lia2.cityway.fr/journeyplanner/api/opt/PlanTrips/json?DepartureLatitude=49.51509388236216&DepartureLongitude=0.09341749619366316&ArrivalLatitude=49.5067090188444&ArrivalLongitude=0.1694842115417831&DepartureType=COORDINATES&ArrivalType=COORDINATES
- */
-export function createRouterResponseFromJson(json) {
-
-    if (json.StatusCode !== 200 || !json.Data || !json.Data.length) {
-        return null;
-    }
-
-    const routerResponse = new RouterResponse();
-    routerResponse.routerName = 'cityway';
-
-
-    // Do not know if it the best approach, but it works...
-    const allJsonTrips = json.Data.reduce((acc, dataObj) => {
-        acc.push(...dataObj.response.trips.Trip);
-        return acc;
-    }, []);
-
-    for (const trip of allJsonTrips) {
-
-        const itinerary = new Itinerary();
-
-        itinerary.duration = parseDuration(trip.Duration);
-        itinerary.startTime = jsonDateToTimestamp(trip.Departure.Time);
-        itinerary.from = jsonToCoordinates(trip.Departure.Site.Position);
-        itinerary.endTime = jsonDateToTimestamp(trip.Arrival.Time);
-        itinerary.to = jsonToCoordinates(trip.Arrival.Site.Position);
-        routerResponse.itineraries.push(itinerary);
-
-        for (const jsonSection of trip.sections.Section) {
-
-            const jsonLeg = jsonSection.Leg ? jsonSection.Leg : jsonSection.PTRide;
-
-            const leg = new Leg();
-
-            leg.mode = jsonLeg.TransportMode;
-            leg.duration = parseDuration(jsonLeg.Duration);
-            leg.startTime = jsonDateToTimestamp(jsonLeg.Departure.Time);
-            leg.endTime = jsonDateToTimestamp(jsonLeg.Arrival.Time);
-            leg.coords = [];
-
-            if (leg.mode === 'WALK' || leg.mode === 'BICYCLE') {
-
-                leg.from = {
-                    name: jsonLeg.Departure.Site.Name,
-                    coords: jsonToCoordinates(jsonLeg.Departure.Site.Position)
-                };
-                leg.to = {
-                    name: jsonLeg.Arrival.Site.Name,
-                    coords: jsonToCoordinates(jsonLeg.Arrival.Site.Position)
-                };
-
-                leg.steps = [];
-                for (const jsonPathLink of jsonLeg.pathLinks.PathLink) {
-                    const step = new Step();
-                    let stepCoords;
-                    if (jsonPathLink.Geometry) {
-                        stepCoords = parseWKTGeometry(jsonPathLink.Geometry);
-                    } else {
-                        stepCoords = [leg.from.coords, leg.to.coords];
-                    }
-                    step.coords = stepCoords[0];
-                    step._idCoordsInLeg = leg.coords.length;
-                    stepCoords.forEach((coords, idx) => {
-                        if (
-                            idx !== 0
-                            || leg.coords.length === 0
-                            || !leg.coords[leg.coords.length - 1].equalsTo(coords)
-                        ) {
-                            leg.coords.push(coords);
-                        }
-                    });
-
-
-                    step.name = jsonPathLink.Departure.Site.Name;
-                    step.levelChange = null;
-
-                    step.distance = jsonPathLink.Distance;
-
-                    leg.steps.push(step);
-                }
-
-            } else if (leg.mode === 'BUS' || leg.mode === 'TRAMWAY' || leg.mode === 'FUNICULAR') {
-
-                leg.from = {
-                    name: jsonLeg.Departure.StopPlace.Name,
-                    coords: jsonToCoordinates(jsonLeg.Departure.StopPlace.Position)
-                };
-                leg.to = {
-                    name: jsonLeg.Arrival.StopPlace.Name,
-                    coords: jsonToCoordinates(jsonLeg.Arrival.StopPlace.Position)
-                };
-
-                let transportName = jsonLeg.Line.Number;
-                if (leg.mode === 'TRAMWAY') {
-                    leg.mode = 'TRAM';
-                    // In order to remove the "TRAM " prefix.
-                    transportName = transportName.substr(5);
-                }
-
-                leg.transportInfo = {
-                    name: transportName,
-                    routeColor: jsonLeg.Line.Color,
-                    routeTextColor: jsonLeg.Line.TextColor,
-                    directionName: jsonLeg.Destination
-                };
-
-                for (const jsonStep of jsonLeg.steps.Step) {
-                    const stepCoords = parseWKTGeometry(jsonStep.Geometry);
-                    stepCoords.forEach((coords, idx) => {
-                        if (
-                            idx !== 0
-                            || leg.coords.length === 0
-                            || !leg.coords[leg.coords.length - 1].equalsTo(coords)
-                        ) {
-                            leg.coords.push(coords);
-                        }
-                    });
-                }
-
-                const legStep = new Step();
-                legStep.coords = leg.coords[0];
-                legStep._idCoordsInLeg = 0;
-                legStep.name = jsonLeg.Line.Name;
-                legStep.levelChange = null;
-                legStep.distance = jsonLeg.Distance;
-                leg.steps = [legStep];
-            } else {
-                Logger.warn(`[CitywayParser] Unknown leg mode: ${leg.mode}`);
-            }
-
-            leg.distance = leg.coords.reduce((acc, coords, idx, arr) => {
-                if (idx === 0) {
-                    return acc;
-                }
-                return acc + arr[idx - 1].distanceTo(coords);
-            }, 0);
-
-            itinerary.legs.push(leg);
-
-        }
-
-        itinerary.distance = itinerary.coords.reduce((acc, coords, idx, arr) => {
-            if (idx === 0) {
-                return acc;
-            }
-            return acc + arr[idx - 1].distanceTo(coords);
-        }, 0);
-
-        // All legs have to be parsed before computing steps metadata
-        generateStepsMetadata(itinerary);
-    }
-
-    routerResponse.from = routerResponse.itineraries[0].from;
-    routerResponse.to = routerResponse.itineraries[routerResponse.itineraries.length - 1].to;
-
-    return routerResponse;
-}
-
-