minotor 1.0.7 → 2.0.0

package/src/routing/query.ts

@@ -1,11 +1,11 @@
-import { StopId } from '../stops/stops.js';
+import { SourceStopId } from '../stops/stops.js';
 import { Duration } from '../timetable/duration.js';
 import { Time } from '../timetable/time.js';
 import { ALL_TRANSPORT_MODES, RouteType } from '../timetable/timetable.js';
 
 export class Query {
-  from: StopId;
-  to: StopId[];
+  from: SourceStopId;
+  to: SourceStopId[];
   departureTime: Time;
   lastDepartureTime?: Time;
   options: {
@@ -22,8 +22,8 @@ export class Query {
   }
 
   static Builder = class {
-    fromValue!: StopId;
-    toValue: StopId[] = [];
+    fromValue!: SourceStopId;
+    toValue: SourceStopId[] = [];
     departureTimeValue!: Time;
     // lastDepartureTimeValue?: Date;
     // via: StopId[] = [];
@@ -37,12 +37,12 @@ export class Query {
       transportModes: ALL_TRANSPORT_MODES,
     };
 
-    from(from: StopId): this {
+    from(from: SourceStopId): this {
       this.fromValue = from;
       return this;
     }
 
-    to(to: StopId | StopId[]): this {
+    to(to: SourceStopId | SourceStopId[]): this {
       this.toValue = Array.isArray(to) ? to : [to];
       return this;
     }

package/src/routing/result.ts

@@ -1,4 +1,4 @@
-import { StopId } from '../stops/stops.js';
+import { SourceStopId, StopId } from '../stops/stops.js';
 import { StopsIndex } from '../stops/stopsIndex.js';
 import { Query } from './query.js';
 import { Leg, Route } from './route.js';
@@ -29,7 +29,7 @@ export class Result {
    * @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?: StopId | StopId[]): Route | undefined {
+  bestRoute(to?: SourceStopId | SourceStopId[]): Route | undefined {
     const destinationList = Array.isArray(to) ? to : to ? [to] : this.query.to;
     const destinations = destinationList.flatMap((destination) =>
       this.stopsIndex.equivalentStops(destination),
@@ -38,13 +38,13 @@ export class Result {
     let fastestDestination: StopId | undefined = undefined;
     let fastestTime: ReachingTime | undefined = undefined;
     for (const destination of destinations) {
-      const arrivalTime = this.earliestArrivals.get(destination);
+      const arrivalTime = this.earliestArrivals.get(destination.id);
       if (arrivalTime !== undefined) {
         if (
           fastestTime === undefined ||
           arrivalTime.time.toSeconds() < fastestTime.time.toSeconds()
         ) {
-          fastestDestination = destination;
+          fastestDestination = destination.id;
           fastestTime = arrivalTime;
         }
       }
@@ -81,7 +81,10 @@ export class Result {
    * @param maxTransfers The optional maximum number of transfers allowed.
    * @returns The arrival time if the target stop is reachable, otherwise undefined.
    */
-  arrivalAt(stop: StopId, maxTransfers?: number): ReachingTime | undefined {
+  arrivalAt(
+    stop: SourceStopId,
+    maxTransfers?: number,
+  ): ReachingTime | undefined {
     const equivalentStops = this.stopsIndex.equivalentStops(stop);
     let earliestArrival: ReachingTime | undefined = undefined;
 
@@ -92,7 +95,7 @@ export class Result {
         : this.earliestArrivals;
 
     for (const equivalentStop of equivalentStops) {
-      const arrivalTime = relevantArrivals.get(equivalentStop);
+      const arrivalTime = relevantArrivals.get(equivalentStop.id);
       if (arrivalTime !== undefined) {
         if (
           earliestArrival === undefined ||

package/src/routing/route.ts

@@ -3,6 +3,12 @@ import { Duration } from '../timetable/duration.js';
 import { Time } from '../timetable/time.js';
 import { ServiceRoute, TransferType } from '../timetable/timetable.js';
 
+export type PickUpDropOffType =
+  | 'REGULAR'
+  | 'NOT_AVAILABLE'
+  | 'MUST_PHONE_AGENCY'
+  | 'MUST_COORDINATE_WITH_DRIVER';
+
 export type BaseLeg = {
   from: Stop;
   to: Stop;
@@ -17,6 +23,11 @@ export type VehicleLeg = BaseLeg & {
   route: ServiceRoute;
   departureTime: Time;
   arrivalTime: Time;
+  // TODO support pick up and drop off types
+  /*
+  pickUpType: PickUpDropOffType;
+  dropOffType: PickUpDropOffType;
+  */
 };
 
 export type Leg = Transfer | VehicleLeg;

package/src/routing/router.ts

@@ -3,7 +3,7 @@ import { StopId } from '../stops/stops.js';
 import { StopsIndex } from '../stops/stopsIndex.js';
 import { Duration } from '../timetable/duration.js';
 import { Time } from '../timetable/time.js';
-import { Timetable } from '../timetable/timetable.js';
+import { NOT_AVAILABLE, Timetable } from '../timetable/timetable.js';
 import { Query } from './query.js';
 import { Result } from './result.js';
 import { Leg } from './route.js';
@@ -113,16 +113,16 @@ export class Router {
     const markedStops = new Set<StopId>();
 
     for (const originStop of origins) {
-      markedStops.add(originStop);
-      earliestArrivals.set(originStop, {
+      markedStops.add(originStop.id);
+      earliestArrivals.set(originStop.id, {
         time: departureTime,
         legNumber: 0,
-        origin: originStop,
+        origin: originStop.id,
       });
-      earliestArrivalsWithoutAnyLeg.set(originStop, {
+      earliestArrivalsWithoutAnyLeg.set(originStop.id, {
         time: departureTime,
         legNumber: 0,
-        origin: originStop,
+        origin: originStop.id,
       });
     }
     // on the first round we need to first consider transfers to discover all possible route origins
@@ -150,13 +150,17 @@ export class Router {
         const route = this.timetable.getRoute(routeId)!;
         let currentTrip: CurrentTrip | undefined = undefined;
         const hopOnIndex = route.stopIndices.get(hopOnStop)!;
-        // for each stops in the route starting with the hop-on one
+        // for each stop 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 currentArrivalIndex =
+              (currentTrip.trip * stopNumbers + i) * 2;
+            const currentArrivalTime = Time.fromSeconds(
+              route.stopTimes[currentArrivalIndex]!,
+            );
+            const currentDropOffType = route.pickUpDropOffTypes[i * 2 + 1];
             const earliestArrivalAtCurrentStop =
               earliestArrivals.get(currentStop)?.time ?? UNREACHED;
             let arrivalToImprove = earliestArrivalAtCurrentStop;
@@ -166,7 +170,7 @@ export class Router {
               // should compare to the earliest arrival at any of them
               for (const destinationStop of destinations) {
                 const earliestArrivalAtDestination =
-                  earliestArrivals.get(destinationStop)?.time ?? UNREACHED;
+                  earliestArrivals.get(destinationStop.id)?.time ?? UNREACHED;
                 earliestArrivalsAtDestinations.push(
                   earliestArrivalAtDestination,
                 );
@@ -180,19 +184,19 @@ export class Router {
               );
             }
             if (
-              currentStopTimes.dropOffType !== 'NOT_AVAILABLE' &&
-              currentStopTimes.arrival.toSeconds() <
-                arrivalToImprove.toSeconds()
+              currentDropOffType !== NOT_AVAILABLE &&
+              currentArrivalTime.toSeconds() < arrivalToImprove.toSeconds()
             ) {
               const bestHopOnStopIndex = route.stopIndices.get(
                 currentTrip.bestHopOnStop,
               )!;
-              const bestHopOnStopTimes =
-                route.stopTimes[
-                  currentTrip.trip * stopNumbers + bestHopOnStopIndex
-                ]!;
+              const bestHopOnStopDepartureIndex =
+                currentTrip.trip * stopNumbers * 2 + bestHopOnStopIndex * 2 + 1;
+              const bestHopOnDepartureTime = Time.fromSeconds(
+                route.stopTimes[bestHopOnStopDepartureIndex]!,
+              );
               arrivalsAtCurrentRound.set(currentStop, {
-                time: currentStopTimes.arrival,
+                time: currentArrivalTime,
                 legNumber: round,
                 origin: currentTrip.origin,
                 leg: {
@@ -200,13 +204,13 @@ export class Router {
                     currentTrip.bestHopOnStop,
                   )!,
                   to: this.stopsIndex.findStopById(currentStop)!,
-                  departureTime: bestHopOnStopTimes.departure,
-                  arrivalTime: currentStopTimes.arrival,
+                  departureTime: bestHopOnDepartureTime,
+                  arrivalTime: currentArrivalTime,
                   route: this.timetable.getServiceRoute(route.serviceRouteId)!,
                 },
               });
               earliestArrivals.set(currentStop, {
-                time: currentStopTimes.arrival,
+                time: currentArrivalTime,
                 legNumber: round,
                 origin: currentTrip.origin,
               });
@@ -221,9 +225,7 @@ export class Router {
             earliestArrivalOnPreviousRound !== undefined &&
             (currentTrip === undefined ||
               earliestArrivalOnPreviousRound.toSeconds() <=
-                route.stopTimes[
-                  currentTrip.trip * stopNumbers + i
-                ]!.departure.toSeconds())
+                route.stopTimes[(currentTrip.trip * stopNumbers + i) * 2]!)
           ) {
             const earliestTrip = this.timetable.findEarliestTrip(
               route,

package/src/stops/__tests__/io.test.ts

@@ -7,33 +7,34 @@ import { StopsMap } from '../stops.js';
 describe('stops io', () => {
   const stopsMap: StopsMap = new Map([
     [
-      'stop1',
+      1,
       {
-        id: 'stop1',
+        id: 1,
+        sourceStopId: 'stop1',
         name: 'Stop 1',
         lat: 40.712776,
         lon: -74.005974,
-        children: ['stop2'],
-        parent: 'parentStop',
+        children: [2],
+        parent: 3,
         locationType: 'SIMPLE_STOP_OR_PLATFORM',
         platform: 'Platform 1',
       },
     ],
     [
-      'stop2',
+      2,
       {
-        id: 'stop2',
+        id: 2,
+        sourceStopId: 'stop2',
         name: 'Stop 2',
         lat: 34.052235,
         lon: -118.243683,
         children: [],
-        parent: 'stop1',
+        parent: 1,
         locationType: 'STATION',
         platform: 'Platform 2',
       },
     ],
   ]);
-
   it('should serialize and deserialize stops correctly', () => {
     const serializedData = serializeStopsMap(stopsMap);
     const deserializedStopsMap = deserializeStopsMap(serializedData);

package/src/stops/__tests__/stopFinder.test.ts

@@ -5,9 +5,10 @@ import { StopsMap } from '../stops.js';
 import { StopsIndex } from '../stopsIndex.js';
 const mockStops: StopsMap = new Map([
   [
-    '8587255',
+    1,
     {
-      id: '8587255',
+      id: 1,
+      sourceStopId: '8587255',
       name: 'Fribourg, Tilleul/Cathédrale',
       lat: 46.8061375857565,
       lon: 7.16145029437328,
@@ -16,9 +17,10 @@ const mockStops: StopsMap = new Map([
     },
   ],
   [
-    '8592383',
+    2,
     {
-      id: '8592383',
+      id: 2,
+      sourceStopId: '8592383',
       name: 'Fribourg, Neuveville/Court-Ch.',
       lat: 46.8042990960992,
       lon: 7.16060587800609,
@@ -27,9 +29,10 @@ const mockStops: StopsMap = new Map([
     },
   ],
   [
-    '8592386',
+    3,
     {
-      id: '8592386',
+      id: 3,
+      sourceStopId: '8592386',
       name: 'Fribourg, Petit-St-Jean',
       lat: 46.8035550740648,
       lon: 7.16806189486532,
@@ -38,50 +41,54 @@ const mockStops: StopsMap = new Map([
     },
   ],
   [
-    'Parent8504100',
+    4,
     {
-      id: 'Parent8504100',
+      id: 4,
+      sourceStopId: 'Parent8504100',
       name: 'Fribourg/Freiburg',
       lat: 46.8031492395272,
       lon: 7.15104780338173,
-      children: ['8504100:0:1', '8504100:0:1AB', '8504100:0:2'],
+      children: [5, 6, 7],
       locationType: 'STATION',
     },
   ],
   [
-    '8504100:0:1',
+    5,
     {
-      id: '8504100:0:1',
+      id: 5,
+      sourceStopId: '8504100:0:1',
       name: 'Fribourg/Freiburg',
       lat: 46.8031492395272,
       lon: 7.15104780338173,
       children: [],
       locationType: 'SIMPLE_STOP_OR_PLATFORM',
-      parent: 'Parent8504100',
+      parent: 4,
     },
   ],
   [
-    '8504100:0:1AB',
+    6,
     {
-      id: '8504100:0:1AB',
+      id: 6,
+      sourceStopId: '8504100:0:1AB',
       name: 'Fribourg/Freiburg',
       lat: 46.8031492395272,
       lon: 7.15104780338173,
       children: [],
       locationType: 'SIMPLE_STOP_OR_PLATFORM',
-      parent: 'Parent8504100',
+      parent: 4,
     },
   ],
   [
-    '8504100:0:2',
+    7,
     {
-      id: '8504100:0:2',
+      id: 7,
+      sourceStopId: '8504100:0:2',
       name: 'Fribourg/Freiburg',
       lat: 46.8031492395272,
       lon: 7.15104780338173,
       children: [],
       locationType: 'SIMPLE_STOP_OR_PLATFORM',
-      parent: 'Parent8504100',
+      parent: 4,
     },
   ],
 ]);
@@ -98,25 +105,25 @@ describe('StopFinder', () => {
       const results = stopFinder.findStopsByName(
         'Fribourg, Tilleul/Cathédrale',
       );
-      assert.strictEqual(results[0]?.id, '8587255');
+      assert.strictEqual(results[0]?.id, 1);
     });
 
     it('should not include children stops', () => {
       const results = stopFinder.findStopsByName('Fribourg/Freiburg', 2);
-      assert.strictEqual(results[0]?.id, 'Parent8504100');
-      assert.strictEqual(results[1]?.id, '8587255');
+      assert.strictEqual(results[0]?.id, 4);
+      assert.strictEqual(results[1]?.id, 1);
     });
 
     it('should find stops by partial name', () => {
       const results = stopFinder.findStopsByName('Cathédrale');
       assert.strictEqual(results.length, 1);
-      assert.strictEqual(results[0]?.id, '8587255');
+      assert.strictEqual(results[0]?.id, 1);
     });
 
     it('should find stops by name with accents', () => {
       const results = stopFinder.findStopsByName('Cathedrale');
       assert.strictEqual(results.length, 1);
-      assert.strictEqual(results[0]?.id, '8587255');
+      assert.strictEqual(results[0]?.id, 1);
     });
 
     it('should return an empty array if no stops match the query', () => {
@@ -129,22 +136,22 @@ describe('StopFinder', () => {
     it('should find stops by geographic location', () => {
       const results = stopFinder.findStopsByLocation(46.8061, 7.1614, 1);
       assert.strictEqual(results.length, 1);
-      assert.strictEqual(results[0]?.id, '8587255');
+      assert.strictEqual(results[0]?.id, 1);
     });
 
     it('should find multiple stops within the radius', () => {
       const results = stopFinder.findStopsByLocation(46.8, 7.16, 10, 0.75);
       assert.strictEqual(results.length, 3);
-      assert.strictEqual(results[0]?.id, '8592383');
-      assert.strictEqual(results[1]?.id, '8587255');
-      assert.strictEqual(results[2]?.id, '8592386');
+      assert.strictEqual(results[0]?.id, 2);
+      assert.strictEqual(results[1]?.id, 1);
+      assert.strictEqual(results[2]?.id, 3);
     });
 
     it('should find the N closest stops', () => {
       const results = stopFinder.findStopsByLocation(46.8, 7.16, 2, 10);
       assert.strictEqual(results.length, 2);
-      assert.strictEqual(results[0]?.id, '8592383');
-      assert.strictEqual(results[1]?.id, '8587255');
+      assert.strictEqual(results[0]?.id, 2);
+      assert.strictEqual(results[1]?.id, 1);
     });
 
     it('should return an empty array if no stops are within the radius', () => {
@@ -165,20 +172,22 @@ describe('StopFinder', () => {
   describe('equivalentStops', () => {
     it('should find equivalent stops for a given stop ID', () => {
       const equivalentStops = stopFinder.equivalentStops('8504100:0:1');
-      assert.deepStrictEqual(equivalentStops, [
-        '8504100:0:1',
-        '8504100:0:1AB',
-        '8504100:0:2',
-      ]);
+      assert.deepStrictEqual(
+        equivalentStops.map((stop) => stop.id),
+        [5, 6, 7],
+      );
     });
 
     it('should return the same stop ID in an array if no equivalents', () => {
       const equivalentStops = stopFinder.equivalentStops('8587255');
-      assert.deepStrictEqual(equivalentStops, ['8587255']);
+      assert.deepStrictEqual(
+        equivalentStops.map((stop) => stop.id),
+        [1],
+      );
     });
 
     it('should return an empty array for non-existent stop ID', () => {
-      const equivalentStops = stopFinder.equivalentStops('nonexistent');
+      const equivalentStops = stopFinder.equivalentStops('999');
       assert.deepStrictEqual(equivalentStops, []);
     });
   });

package/src/stops/io.ts

@@ -3,12 +3,13 @@ import {
   Stop as ProtoStop,
   StopsMap as ProtoStopsMap,
 } from './proto/stops.js';
-import { LocationType, Stop, StopId, StopsMap } from './stops.js';
+import { LocationType, Stop, StopsMap } from './stops.js';
 
-const CURRENT_VERSION = '0.0.1';
+const CURRENT_VERSION = '0.0.2';
 const serializeStop = (stop: Stop): ProtoStop => {
   return {
     name: stop.name,
+    sourceStopId: stop.sourceStopId,
     lat: stop.lat,
     lon: stop.lon,
     children: stop.children,
@@ -24,16 +25,17 @@ export const serializeStopsMap = (stopsMap: StopsMap): ProtoStopsMap => {
     stops: {},
   };
 
-  stopsMap.forEach((value: Stop, key: string) => {
+  stopsMap.forEach((value: Stop, key: number) => {
     protoStopsMap.stops[key] = serializeStop(value);
   });
 
   return protoStopsMap;
 };
 
-const deserializeStop = (stopId: StopId, protoStop: ProtoStop): Stop => {
+const deserializeStop = (stopId: number, protoStop: ProtoStop): Stop => {
   return {
     id: stopId,
+    sourceStopId: protoStop.sourceStopId,
     name: protoStop.name,
     lat: protoStop.lat,
     lon: protoStop.lon,
@@ -51,7 +53,8 @@ export const deserializeStopsMap = (protoStopsMap: ProtoStopsMap): StopsMap => {
   const stopsMap: StopsMap = new Map();
 
   Object.entries(protoStopsMap.stops).forEach(([key, value]) => {
-    stopsMap.set(key, deserializeStop(key, value));
+    const intKey = parseInt(key, 10);
+    stopsMap.set(intKey, deserializeStop(intKey, value));
   });
 
   return stopsMap;

package/src/stops/proto/stops.proto

@@ -12,15 +12,16 @@ enum LocationType {
 
 message Stop {
   string name = 1;
-  optional double lat = 2;
-  optional double lon = 3;
-  repeated string children = 4;
-  optional string parent = 5;
-  LocationType locationType = 6;
-  optional string platform = 7;
+  string sourceStopId = 2;
+  optional double lat = 3;
+  optional double lon = 4;
+  repeated uint32 children = 5;
+  optional uint32 parent = 6;
+  LocationType locationType = 7;
+  optional string platform = 8;
 }
 
 message StopsMap {
   string version = 1;
-  map<string, Stop> stops = 2;
+  map<uint32, Stop> stops = 2;
 }