minotor 1.0.1 → 1.0.3

package/.prettierignore

@@ -0,0 +1 @@
+proto/

package/CHANGELOG.md

@@ -1,6 +1,6 @@
-## [1.0.1](https://github.com/aubryio/minotor/compare/v1.0.0...v1.0.1) (2025-02-03)
+## [1.0.3](https://github.com/aubryio/minotor/compare/v1.0.2...v1.0.3) (2025-02-09)
 
 
 ### Bug Fixes
 
-* trigger new version after fixing types export ([b14dccc](https://github.com/aubryio/minotor/commit/b14dccc37b607fb9e06814bed9bd9795e47e6f5c))
+* split parser and router modules for better bundling ([#8](https://github.com/aubryio/minotor/issues/8)) ([6c89814](https://github.com/aubryio/minotor/commit/6c89814a336b3557458cd193b92bc8ffca4a79c1))

package/dist/cli/minotor.d.ts

@@ -1,4 +1,4 @@
-import { GtfsProfile } from '../index.js';
+import { GtfsProfile } from '../parser.js';
 export type GtfsVariant = string;
 export type Config = {
     [config: GtfsVariant]: GtfsProfile;

package/dist/cli/utils.d.ts

@@ -1,3 +1,3 @@
-import { Result, Route } from '../index.js';
+import { Result, Route } from '../router.js';
 export declare const prettyPrintRoute: (route: Route) => void;
 export declare const plotGraphToDotFile: (result: Result, filePath: string) => void;

package/dist/{bundle.cjs.js → parser.cjs.js}

@@ -12134,7 +12134,7 @@ const StopTimes = {
 function createBaseRoute() {
     return { stopTimes: [], stops: [], serviceRouteId: "" };
 }
-const Route$1 = {
+const Route = {
     encode(message, writer = new BinaryWriter()) {
         for (const v of message.stopTimes) {
             StopTimes.encode(v, writer.uint32(10).fork()).join();
@@ -12207,7 +12207,7 @@ const Route$1 = {
         return obj;
     },
     create(base) {
-        return Route$1.fromPartial(base !== null && base !== undefined ? base : {});
+        return Route.fromPartial(base !== null && base !== undefined ? base : {});
     },
     fromPartial(object) {
         var _a, _b, _c;
@@ -12257,7 +12257,7 @@ const RoutesAdjacency = {
         return {
             routes: isObject(object.routes)
                 ? Object.entries(object.routes).reduce((acc, [key, value]) => {
-                    acc[key] = Route$1.fromJSON(value);
+                    acc[key] = Route.fromJSON(value);
                     return acc;
                 }, {})
                 : {},
@@ -12270,7 +12270,7 @@ const RoutesAdjacency = {
             if (entries.length > 0) {
                 obj.routes = {};
                 entries.forEach(([k, v]) => {
-                    obj.routes[k] = Route$1.toJSON(v);
+                    obj.routes[k] = Route.toJSON(v);
                 });
             }
         }
@@ -12284,7 +12284,7 @@ const RoutesAdjacency = {
         const message = createBaseRoutesAdjacency();
         message.routes = Object.entries((_a = object.routes) !== null && _a !== undefined ? _a : {}).reduce((acc, [key, value]) => {
             if (value !== undefined) {
-                acc[key] = Route$1.fromPartial(value);
+                acc[key] = Route.fromPartial(value);
             }
             return acc;
         }, {});
@@ -12300,7 +12300,7 @@ const RoutesAdjacency_RoutesEntry = {
             writer.uint32(10).string(message.key);
         }
         if (message.value !== undefined) {
-            Route$1.encode(message.value, writer.uint32(18).fork()).join();
+            Route.encode(message.value, writer.uint32(18).fork()).join();
         }
         return writer;
     },
@@ -12322,7 +12322,7 @@ const RoutesAdjacency_RoutesEntry = {
                     if (tag !== 18) {
                         break;
                     }
-                    message.value = Route$1.decode(reader, reader.uint32());
+                    message.value = Route.decode(reader, reader.uint32());
                     continue;
                 }
             }
@@ -12336,7 +12336,7 @@ const RoutesAdjacency_RoutesEntry = {
     fromJSON(object) {
         return {
             key: isSet(object.key) ? globalThis.String(object.key) : "",
-            value: isSet(object.value) ? Route$1.fromJSON(object.value) : undefined,
+            value: isSet(object.value) ? Route.fromJSON(object.value) : undefined,
         };
     },
     toJSON(message) {
@@ -12345,7 +12345,7 @@ const RoutesAdjacency_RoutesEntry = {
             obj.key = message.key;
         }
         if (message.value !== undefined) {
-            obj.value = Route$1.toJSON(message.value);
+            obj.value = Route.toJSON(message.value);
         }
         return obj;
     },
@@ -12356,7 +12356,7 @@ const RoutesAdjacency_RoutesEntry = {
         var _a;
         const message = createBaseRoutesAdjacency_RoutesEntry();
         message.key = (_a = object.key) !== null && _a !== undefined ? _a : "";
-        message.value = (object.value !== undefined && object.value !== null) ? Route$1.fromPartial(object.value) : undefined;
+        message.value = (object.value !== undefined && object.value !== null) ? Route.fromPartial(object.value) : undefined;
         return message;
     },
 };
@@ -16080,428 +16080,6 @@ const chGtfsProfile = {
     platformParser,
 };
 
-class Plotter {
-    constructor(result) {
-        this.result = result;
-    }
-    /**
-     * Plots the path three as a DOT for debugging purposes.
-     *
-     * @returns A string representing the DOT graph of the path tree.
-     */
-    plotDotGraph() {
-        const earliestArrivalsPerRound = this.result.earliestArrivalsPerRound;
-        const dotParts = [
-            'digraph PathTree {',
-            '  graph [overlap=false];',
-            '  node [shape=ellipse style=filled fillcolor=lightgrey];',
-        ];
-        earliestArrivalsPerRound.forEach((arrivalsInRound, round) => {
-            arrivalsInRound.forEach((tripLeg) => {
-                const { origin, leg } = tripLeg;
-                if (!leg)
-                    return; // Skip if leg is undefined
-                const fromStop = this.result['stopsIndex'].findStopById(leg.from.id);
-                const toStop = this.result['stopsIndex'].findStopById(leg.to.id);
-                const originStop = this.result['stopsIndex'].findStopById(origin);
-                if (fromStop && toStop && originStop) {
-                    const fromName = fromStop.platform
-                        ? `${fromStop.name} (Pl. ${fromStop.platform})`
-                        : fromStop.name;
-                    const toName = toStop.platform
-                        ? `${toStop.name} (Pl. ${toStop.platform})`
-                        : toStop.name;
-                    const originName = originStop.platform
-                        ? `${originStop.name} (Pl. ${originStop.platform})`
-                        : originStop.name;
-                    const isVehicle = 'route' in leg;
-                    const routeLabelContent = isVehicle
-                        ? `${leg.route.name}\n${leg.departureTime.toString()} - ${leg.arrivalTime.toString()}`
-                        : leg.minTransferTime
-                            ? leg.minTransferTime.toString()
-                            : '';
-                    const intermediateNode = `IntermediateNode${fromStop.id}_${toStop.id}`;
-                    const lineColor = isVehicle ? '' : ', color="red", fontcolor="red"';
-                    const labelColor = isVehicle ? '' : ' fontcolor="red"';
-                    dotParts.push(`  "${fromName} (Origin: ${originName}) [R${round}]\n(${fromStop.id})" -> "${intermediateNode}" [shape=point${lineColor}];`);
-                    dotParts.push(`  "${intermediateNode}" [label="${routeLabelContent}" shape=rect style=filled fillcolor=white${labelColor} border=0];`);
-                    dotParts.push(`  "${intermediateNode}" -> "${toName} (Origin: ${originName}) [R${round}]\n(${toStop.id})" [${lineColor.replace(', ', '')}];`);
-                }
-            });
-        });
-        dotParts.push('}');
-        return dotParts.join('\n');
-    }
-}
-
-class Query {
-    constructor(builder) {
-        this.from = builder.fromValue;
-        this.to = builder.toValue;
-        this.departureTime = builder.departureTimeValue;
-        this.options = builder.optionsValue;
-    }
-}
-Query.Builder = class {
-    constructor() {
-        // lastDepartureTimeValue?: Date;
-        // via: StopId[] = [];
-        this.optionsValue = {
-            maxTransfers: 5,
-            minTransferTime: Duration.fromSeconds(120),
-            transportModes: ALL_TRANSPORT_MODES,
-        };
-    }
-    from(from) {
-        this.fromValue = from;
-        return this;
-    }
-    to(to) {
-        this.toValue = Array.isArray(to) ? to : [to];
-        return this;
-    }
-    departureTime(departureTime) {
-        this.departureTimeValue = departureTime;
-        return this;
-    }
-    maxTransfers(maxTransfers) {
-        this.optionsValue.maxTransfers = maxTransfers;
-        return this;
-    }
-    minTransferTime(minTransferTime) {
-        this.optionsValue.minTransferTime = minTransferTime;
-        return this;
-    }
-    transportModes(transportModes) {
-        this.optionsValue.transportModes = transportModes;
-        return this;
-    }
-    build() {
-        return new Query(this);
-    }
-};
-
-class Route {
-    constructor(legs) {
-        if (legs.length === 0) {
-            throw new Error('There must be at least one leg in a route');
-        }
-        this.legs = legs;
-    }
-    departureTime() {
-        const cumulativeTransferTime = Duration.zero();
-        for (let i = 0; i < this.legs.length; i++) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            const leg = this.legs[i];
-            if ('departureTime' in leg) {
-                return leg.departureTime.minus(cumulativeTransferTime);
-            }
-            if ('minTransferTime' in leg && leg.minTransferTime) {
-                cumulativeTransferTime.add(leg.minTransferTime);
-            }
-        }
-        throw new Error('No vehicle leg found in route');
-    }
-    arrivalTime() {
-        let lastVehicleArrivalTime = Time.origin();
-        const totalTransferTime = Duration.zero();
-        let vehicleLegFound = false;
-        for (let i = this.legs.length - 1; i >= 0; i--) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            const leg = this.legs[i];
-            if ('arrivalTime' in leg && !vehicleLegFound) {
-                lastVehicleArrivalTime = leg.arrivalTime;
-                vehicleLegFound = true;
-            }
-            else if ('minTransferTime' in leg &&
-                leg.minTransferTime &&
-                vehicleLegFound) {
-                totalTransferTime.add(leg.minTransferTime);
-            }
-        }
-        if (!vehicleLegFound) {
-            throw new Error('No vehicle leg found in route');
-        }
-        return lastVehicleArrivalTime.plus(totalTransferTime);
-    }
-    totalDuration() {
-        if (this.legs.length === 0)
-            return Duration.zero();
-        return this.arrivalTime().diff(this.departureTime());
-    }
-    print() {
-        return this.legs
-            .map((leg, index) => {
-            var _a, _b;
-            if ('route' in leg) {
-                return `Leg ${index + 1}: ${leg.from.name} to ${leg.to.name}
-            via route ${leg.route.type} ${leg.route.name},
-            departs at ${leg.departureTime.toString()}, arrives at ${leg.arrivalTime.toString()}`;
-            }
-            return `Leg ${index + 1}: Transfer from ${leg.from.name} to ${leg.to.name},
-            minimum transfer time: ${(_b = (_a = leg.minTransferTime) === null || _a === undefined ? undefined : _a.toString()) !== null && _b !== undefined ? _b : 'not specified'}`;
-        })
-            .join('\n');
-    }
-}
-
-class Result {
-    constructor(query, earliestArrivals, earliestArrivalsPerRound, stopsIndex) {
-        this.query = query;
-        this.earliestArrivals = earliestArrivals;
-        this.earliestArrivalsPerRound = earliestArrivalsPerRound;
-        this.stopsIndex = stopsIndex;
-    }
-    /**
-     * Reconstructs the best route to a stop.
-     * (to any stop reachable in less time / transfers than the destination(s) of the query)
-     *
-     * @param to The destination stop. Defaults to the destination of the original query.
-     * @returns a route to the destination stop if it exists.
-     */
-    bestRoute(to) {
-        var _a, _b, _c;
-        const destinationList = Array.isArray(to) ? to : to ? [to] : this.query.to;
-        const destinations = destinationList.flatMap((destination) => this.stopsIndex.equivalentStops(destination));
-        let fastestDestination = undefined;
-        let fastestTime = undefined;
-        for (const destination of destinations) {
-            const arrivalTime = this.earliestArrivals.get(destination);
-            if (arrivalTime !== undefined) {
-                if (fastestTime === undefined ||
-                    arrivalTime.time.toSeconds() < fastestTime.time.toSeconds()) {
-                    fastestDestination = destination;
-                    fastestTime = arrivalTime;
-                }
-            }
-        }
-        if (!fastestDestination || !fastestTime) {
-            return undefined;
-        }
-        const route = [];
-        let currentStop = fastestDestination;
-        let round = fastestTime.legNumber;
-        while (fastestTime.origin !== currentStop) {
-            const tripLeg = (_a = this.earliestArrivalsPerRound[round]) === null || _a === undefined ? undefined : _a.get(currentStop);
-            if (!(tripLeg === null || tripLeg === undefined ? undefined : tripLeg.leg)) {
-                throw new Error(`No leg found for a trip leg: start stop=${(_c = (_b = tripLeg === null || tripLeg === undefined ? undefined : tripLeg.leg) === null || _b === undefined ? undefined : _b.from.id) !== null && _c !== undefined ? _c : 'unknown'}, end stop=${currentStop}, round=${round}, origin=${fastestTime.origin}`);
-            }
-            route.unshift(tripLeg.leg);
-            currentStop = tripLeg.leg.from.id;
-            if ('route' in tripLeg.leg) {
-                round -= 1;
-            }
-        }
-        return new Route(route);
-    }
-    /**
-     * Returns the arrival time at any stop reachable in less time / transfers than the destination(s) of the query)
-     *
-     * @param stop The target stop for which to return the arrival time.
-     * @param maxTransfers The optional maximum number of transfers allowed.
-     * @returns The arrival time if the target stop is reachable, otherwise undefined.
-     */
-    arrivalAt(stop, maxTransfers) {
-        const equivalentStops = this.stopsIndex.equivalentStops(stop);
-        let earliestArrival = undefined;
-        const relevantArrivals = maxTransfers !== undefined
-            ? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                this.earliestArrivalsPerRound[maxTransfers - 1]
-            : this.earliestArrivals;
-        for (const equivalentStop of equivalentStops) {
-            const arrivalTime = relevantArrivals.get(equivalentStop);
-            if (arrivalTime !== undefined) {
-                if (earliestArrival === undefined ||
-                    arrivalTime.time.toSeconds() < earliestArrival.time.toSeconds()) {
-                    earliestArrival = arrivalTime;
-                }
-            }
-        }
-        return earliestArrival;
-    }
-}
-
-const UNREACHED = Time.infinity();
-class Router {
-    constructor(timetable, stopsIndex) {
-        this.timetable = timetable;
-        this.stopsIndex = stopsIndex;
-    }
-    /**
-     * Evaluates possible transfers for a given query on a transport
-     * network, updating the earliest arrivals at various stops and marking new
-     * stops that can be reached through these transfers.
-     */
-    considerTransfers(query, markedStops, arrivalsAtCurrentRound, earliestArrivals, round) {
-        var _a, _b, _c, _d;
-        const { options } = query;
-        const newlyMarkedStops = new Set();
-        for (const stop of markedStops) {
-            for (const transfer of this.timetable.getTransfers(stop)) {
-                let transferTime;
-                if (transfer.minTransferTime) {
-                    transferTime = transfer.minTransferTime;
-                }
-                else if (transfer.type === 'IN_SEAT') {
-                    transferTime = Duration.zero();
-                }
-                else {
-                    transferTime = options.minTransferTime;
-                }
-                const arrivalAfterTransfer = arrivalsAtCurrentRound
-                    .get(stop)
-                    .time.plus(transferTime);
-                const originalArrival = (_b = (_a = arrivalsAtCurrentRound.get(transfer.destination)) === null || _a === undefined ? undefined : _a.time) !== null && _b !== undefined ? _b : UNREACHED;
-                if (arrivalAfterTransfer.toSeconds() < originalArrival.toSeconds()) {
-                    const origin = (_d = (_c = arrivalsAtCurrentRound.get(stop)) === null || _c === undefined ? undefined : _c.origin) !== null && _d !== undefined ? _d : stop;
-                    arrivalsAtCurrentRound.set(transfer.destination, {
-                        time: arrivalAfterTransfer,
-                        legNumber: round,
-                        origin: origin,
-                        leg: {
-                            from: this.stopsIndex.findStopById(stop),
-                            to: this.stopsIndex.findStopById(transfer.destination),
-                            minTransferTime: transfer.minTransferTime,
-                        },
-                    });
-                    earliestArrivals.set(transfer.destination, {
-                        time: arrivalAfterTransfer,
-                        legNumber: round,
-                        origin: origin,
-                    });
-                    newlyMarkedStops.add(transfer.destination);
-                }
-            }
-        }
-        for (const newStop of newlyMarkedStops) {
-            markedStops.add(newStop);
-        }
-    }
-    /**
-     * The main Raptor algorithm implementation.
-     *
-     * @param query The query containing the main parameters for the routing.
-     * @returns A result object containing data structures allowing to reconstruct routes and .
-     */
-    route(query) {
-        var _a, _b, _c, _d, _e, _f, _g;
-        const { from, to, departureTime, options } = query;
-        // Consider children or siblings of the "from" stop as potential origins
-        const origins = this.stopsIndex.equivalentStops(from);
-        // Consider children or siblings of the "to" stop(s) as potential destinations
-        const destinations = to.flatMap((destination) => this.stopsIndex.equivalentStops(destination));
-        const earliestArrivals = new Map();
-        const earliestArrivalsWithoutAnyLeg = new Map();
-        const earliestArrivalsPerRound = [earliestArrivalsWithoutAnyLeg];
-        // Stops that have been improved at round k-1
-        const markedStops = new Set();
-        for (const originStop of origins) {
-            markedStops.add(originStop);
-            earliestArrivals.set(originStop, {
-                time: departureTime,
-                legNumber: 0,
-                origin: originStop,
-            });
-            earliestArrivalsWithoutAnyLeg.set(originStop, {
-                time: departureTime,
-                legNumber: 0,
-                origin: originStop,
-            });
-        }
-        // on the first round we need to first consider transfers to discover all possible route origins
-        this.considerTransfers(query, markedStops, earliestArrivalsWithoutAnyLeg, earliestArrivals, 0);
-        for (let round = 1; round <= options.maxTransfers + 1; round++) {
-            const arrivalsAtCurrentRound = new Map();
-            earliestArrivalsPerRound.push(arrivalsAtCurrentRound);
-            const arrivalsAtPreviousRound = earliestArrivalsPerRound[round - 1];
-            // Routes that contain at least one stop reached with at least round - 1 legs
-            // together with corresponding hop on stop index (earliest marked stop)
-            const reachableRoutes = this.timetable.findReachableRoutes(markedStops, options.transportModes);
-            markedStops.clear();
-            // for each route that can be reached with at least round - 1 trips
-            for (const [routeId, hopOnStop] of reachableRoutes.entries()) {
-                const route = this.timetable.getRoute(routeId);
-                let currentTrip = undefined;
-                const hopOnIndex = route.stopIndices.get(hopOnStop);
-                // for each stops in the route starting with the hop-on one
-                for (let i = hopOnIndex; i < route.stops.length; i++) {
-                    const currentStop = route.stops[i];
-                    const stopNumbers = route.stops.length;
-                    if (currentTrip !== undefined) {
-                        const currentStopTimes = route.stopTimes[currentTrip.trip * stopNumbers + i];
-                        const earliestArrivalAtCurrentStop = (_b = (_a = earliestArrivals.get(currentStop)) === null || _a === undefined ? undefined : _a.time) !== null && _b !== undefined ? _b : UNREACHED;
-                        let arrivalToImprove = earliestArrivalAtCurrentStop;
-                        if (destinations.length > 0) {
-                            const earliestArrivalsAtDestinations = [];
-                            // if multiple destinations are specified, the target pruning
-                            // should compare to the earliest arrival at any of them
-                            for (const destinationStop of destinations) {
-                                const earliestArrivalAtDestination = (_d = (_c = earliestArrivals.get(destinationStop)) === null || _c === undefined ? undefined : _c.time) !== null && _d !== undefined ? _d : UNREACHED;
-                                earliestArrivalsAtDestinations.push(earliestArrivalAtDestination);
-                            }
-                            const earliestArrivalAtDestination = Time.min(...earliestArrivalsAtDestinations);
-                            arrivalToImprove = Time.min(earliestArrivalAtCurrentStop, earliestArrivalAtDestination);
-                        }
-                        if (currentStopTimes.dropOffType !== 'NOT_AVAILABLE' &&
-                            currentStopTimes.arrival.toSeconds() <
-                                arrivalToImprove.toSeconds()) {
-                            const bestHopOnStopIndex = route.stopIndices.get(currentTrip.bestHopOnStop);
-                            const bestHopOnStopTimes = route.stopTimes[currentTrip.trip * stopNumbers + bestHopOnStopIndex];
-                            arrivalsAtCurrentRound.set(currentStop, {
-                                time: currentStopTimes.arrival,
-                                legNumber: round,
-                                origin: currentTrip.origin,
-                                leg: {
-                                    from: this.stopsIndex.findStopById(currentTrip.bestHopOnStop),
-                                    to: this.stopsIndex.findStopById(currentStop),
-                                    departureTime: bestHopOnStopTimes.departure,
-                                    arrivalTime: currentStopTimes.arrival,
-                                    route: this.timetable.getServiceRoute(route.serviceRouteId),
-                                },
-                            });
-                            earliestArrivals.set(currentStop, {
-                                time: currentStopTimes.arrival,
-                                legNumber: round,
-                                origin: currentTrip.origin,
-                            });
-                            markedStops.add(currentStop);
-                        }
-                    }
-                    // check if we can catch a previous trip at the current stop
-                    // if there was no current trip, find the first one reachable
-                    const earliestArrivalOnPreviousRound = (_e = arrivalsAtPreviousRound.get(currentStop)) === null || _e === undefined ? undefined : _e.time;
-                    if (earliestArrivalOnPreviousRound !== undefined &&
-                        (currentTrip === undefined ||
-                            earliestArrivalOnPreviousRound.toSeconds() <=
-                                route.stopTimes[currentTrip.trip * stopNumbers + i].departure.toSeconds())) {
-                        const earliestTrip = this.timetable.findEarliestTrip(route, currentStop, currentTrip === null || currentTrip === undefined ? undefined : currentTrip.trip, earliestArrivalOnPreviousRound);
-                        if (earliestTrip !== undefined) {
-                            currentTrip = {
-                                trip: earliestTrip,
-                                // we need to keep track of the best hop-on stop to reconstruct the route at the end
-                                bestHopOnStop: currentStop,
-                                origin: (_g = (_f = arrivalsAtPreviousRound.get(currentStop)) === null || _f === undefined ? undefined : _f.origin) !== null && _g !== undefined ? _g : currentStop,
-                            };
-                        }
-                    }
-                }
-            }
-            this.considerTransfers(query, markedStops, arrivalsAtCurrentRound, earliestArrivals, round);
-            if (markedStops.size === 0)
-                break;
-        }
-        return new Result(query, earliestArrivals, earliestArrivalsPerRound, this.stopsIndex);
-    }
-}
-
 exports.GtfsParser = GtfsParser;
-exports.Plotter = Plotter;
-exports.Query = Query;
-exports.Result = Result;
-exports.Route = Route;
-exports.Router = Router;
-exports.StopsIndex = StopsIndex;
-exports.Time = Time;
-exports.Timetable = Timetable;
 exports.chGtfsProfile = chGtfsProfile;
-//# sourceMappingURL=bundle.cjs.js.map
+//# sourceMappingURL=parser.cjs.js.map