minotor 4.0.0 → 5.0.1

package/src/gtfs/parser.ts

@@ -2,13 +2,13 @@ import log from 'loglevel';
 import { DateTime } from 'luxon';
 import StreamZip from 'node-stream-zip';
 
-import { Platform, StopId } from '../stops/stops.js';
+import { StopId } from '../stops/stops.js';
 import { StopsIndex } from '../stops/stopsIndex.js';
 import { RouteType, Timetable } from '../timetable/timetable.js';
 import { standardProfile } from './profiles/standard.js';
 import { parseRoutes } from './routes.js';
 import { parseCalendar, parseCalendarDates, ServiceIds } from './services.js';
-import { indexStops, parseStops, StopEntry } from './stops.js';
+import { indexStops, parseStops } from './stops.js';
 import { parseTransfers, TransfersMap } from './transfers.js';
 import {
   buildStopsAdjacencyStructure,
@@ -27,7 +27,6 @@ const TRANSFERS_FILE = 'transfers.txt';
 
 export type GtfsProfile = {
   routeTypeParser: (routeType: number) => Maybe<RouteType>;
-  platformParser?: (stopEntry: StopEntry) => Maybe<Platform>;
 };
 
 export class GtfsParser {
@@ -62,10 +61,7 @@ export class GtfsParser {
     log.info(`Parsing ${STOPS_FILE}`);
     const stopsStart = performance.now();
     const stopsStream = await zip.stream(STOPS_FILE);
-    const parsedStops = await parseStops(
-      stopsStream,
-      this.profile.platformParser,
-    );
+    const parsedStops = await parseStops(stopsStream);
     const stopsEnd = performance.now();
     log.info(
       `${parsedStops.size} parsed stops. (${(stopsEnd - stopsStart).toFixed(2)}ms)`,
@@ -138,12 +134,13 @@ export class GtfsParser {
     );
     const stopsAdjacency = buildStopsAdjacencyStructure(
       validStopIds,
+      validGtfsRoutes,
       routesAdjacency,
       transfers,
     );
     const stopTimesEnd = performance.now();
     log.info(
-      `${routesAdjacency.size} valid unique routes. (${(stopTimesEnd - stopTimesStart).toFixed(2)}ms)`,
+      `${routesAdjacency.length} valid unique routes. (${(stopTimesEnd - stopTimesStart).toFixed(2)}ms)`,
     );
 
     log.info(`Removing unused stops.`);
@@ -187,9 +184,7 @@ export class GtfsParser {
     log.info(`Parsing ${STOPS_FILE}`);
     const stopsStart = performance.now();
     const stopsStream = await zip.stream(STOPS_FILE);
-    const stops = indexStops(
-      await parseStops(stopsStream, this.profile.platformParser),
-    );
+    const stops = indexStops(await parseStops(stopsStream));
     const stopsEnd = performance.now();
 
     log.info(

package/src/gtfs/profiles/__tests__/ch.test.ts

@@ -4,34 +4,6 @@ import { describe, it } from 'node:test';
 import { chGtfsProfile } from '../ch.js';
 
 describe('The swiss GTFS feed parser', () => {
-  it('should extract the platform number from a stop entry', () => {
-    assert.ok(chGtfsProfile.platformParser);
-    assert.equal(
-      chGtfsProfile.platformParser({
-        stop_id: '8504100:0:1',
-        stop_name: 'Fribourg/Freiburg',
-        stop_lat: 46.8018210323626,
-        stop_lon: 7.14993389242926,
-        location_type: 1,
-        parent_station: 'Parent8504100',
-      }),
-      '1',
-    );
-  });
-  it('should not extract any platform number when not specified', () => {
-    assert.ok(chGtfsProfile.platformParser);
-    assert.equal(
-      chGtfsProfile.platformParser({
-        stop_id: 'Parent8587255',
-        stop_name: 'Fribourg, Tilleul/Cathédrale',
-        stop_lat: 46.8061375857565,
-        stop_lon: 7.16145029437328,
-        location_type: 1,
-        parent_station: '',
-      }),
-      undefined,
-    );
-  });
   it('should convert the SBB route type to GTFS route type', () => {
     assert.ok(chGtfsProfile.routeTypeParser);
     assert.equal(chGtfsProfile.routeTypeParser(106), 'RAIL');

package/src/gtfs/profiles/ch.ts

@@ -1,23 +1,7 @@
-import { Platform } from '../../stops/stops.js';
 import { RouteType } from '../../timetable/timetable.js';
 import { GtfsProfile } from '../parser.js';
-import { StopEntry } from '../stops.js';
 import { Maybe } from '../utils.js';
 
-/**
- * Parses the platform number from a stop entry.
- * @param stopEntry The stop entry.
- * @returns The platform corresponding to this stop.
- */
-const platformParser = (stopEntry: StopEntry): Maybe<Platform> => {
-  const stopId = stopEntry.stop_id;
-  const stopParts = stopId.split(':');
-  if (stopParts.length > 2) {
-    return stopParts[2];
-  }
-  return undefined;
-};
-
 /**
  * Parses the SBB extended route type and returns the corresponding basic GTFS route type.
  * @param routeType The SBB route type to parse.
@@ -44,6 +28,7 @@ const routeTypeParser = (routeType: number): Maybe<RouteType> => {
       return 'FERRY'; // Boat
     case 900: // Tram
       return 'TRAM'; // Tram
+    case 116: // ??? train TODO figure out what this means
     case 117: // Special train
     case 102: // International train
     case 104: // Car train
@@ -55,7 +40,6 @@ const routeTypeParser = (routeType: number): Maybe<RouteType> => {
     case 100: // No guaranteed train
     case 106: // Regional train
     case 109: // Urban train
-    case 116: // ??? train TODO figure out what this means
       return 'RAIL'; // Train
     case 1100: // Aircraft
     case 1500: // Taxi
@@ -66,5 +50,4 @@ const routeTypeParser = (routeType: number): Maybe<RouteType> => {
 
 export const chGtfsProfile: GtfsProfile = {
   routeTypeParser,
-  platformParser,
 };

package/src/gtfs/profiles/standard.ts

@@ -1,7 +1,4 @@
-import { Platform } from '../../stops/stops.js';
 import { GtfsProfile } from '../parser.js';
-import { StopEntry } from '../stops.js';
-import { Maybe } from '../utils.js';
 
 export const standardProfile: GtfsProfile = {
   routeTypeParser: (routeType: number) => {
@@ -30,10 +27,4 @@ export const standardProfile: GtfsProfile = {
         return undefined;
     }
   },
-  platformParser: (stopEntry: StopEntry): Maybe<Platform> => {
-    if (stopEntry.platform_code) {
-      return stopEntry.platform_code;
-    }
-    return undefined;
-  },
 };

package/src/gtfs/routes.ts

@@ -42,6 +42,7 @@ export const parseRoutes = async (
     routes.set(line.route_id, {
       name: line.route_short_name,
       type: routeType,
+      routes: [],
     });
   }
   return routes;

package/src/gtfs/stops.ts

@@ -8,7 +8,7 @@ import {
   StopId,
   StopsMap,
 } from '../stops/stops.js';
-import { Maybe, parseCsv } from './utils.js';
+import { parseCsv } from './utils.js';
 
 export type GtfsLocationType =
   | 0 // simple stop or platform (can also be empty)
@@ -40,7 +40,6 @@ export type ParsedStopsMap = Map<SourceStopId, ParsedStop>;
  */
 export const parseStops = async (
   stopsStream: NodeJS.ReadableStream,
-  platformParser?: (stopEntry: StopEntry) => Maybe<Platform>,
 ): Promise<ParsedStopsMap> => {
   const parsedStops = new Map<SourceStopId, ParsedStop>();
   let i = 0;
@@ -59,19 +58,10 @@ export const parseStops = async (
       locationType: line.location_type
         ? parseGtfsLocationType(line.location_type)
         : 'SIMPLE_STOP_OR_PLATFORM',
+      ...(line.platform_code && { platform: line.platform_code }),
       children: [],
       ...(line.parent_station && { parentSourceId: line.parent_station }),
     };
-    if (platformParser) {
-      try {
-        const platform = platformParser(line);
-        if (platform) {
-          stop.platform = platform;
-        }
-      } catch {
-        console.info(`Could not parse platform for stop ${line.stop_id}.`);
-      }
-    }
     parsedStops.set(line.stop_id, stop);
     i = i + 1;
   }

package/src/gtfs/trips.ts

@@ -6,10 +6,8 @@ import {
   NOT_AVAILABLE,
   REGULAR,
   Route,
-  RouteId,
 } from '../timetable/route.js';
 import {
-  RoutesAdjacency,
   ServiceRouteId,
   ServiceRoutesMap,
   StopsAdjacency,
@@ -169,13 +167,13 @@ const finalizeRouteFromBuilder = (builder: RouteBuilder): SerializedRoute => {
  *
  * @param tripsStream The readable stream containing the trips data.
  * @param serviceIds A mapping of service IDs to corresponding route IDs.
- * @param routeIds A mapping of route IDs to route details.
+ * @param serviceRoutes A mapping of route IDs to route details.
  * @returns A mapping of trip IDs to corresponding route IDs.
  */
 export const parseTrips = async (
   tripsStream: NodeJS.ReadableStream,
   serviceIds: ServiceIds,
-  routeIds: ServiceRoutesMap,
+  serviceRoutes: ServiceRoutesMap,
 ): Promise<TripIdsMap> => {
   const trips: TripIdsMap = new Map();
   for await (const rawLine of parseCsv(tripsStream, ['stop_sequence'])) {
@@ -184,7 +182,7 @@ export const parseTrips = async (
       // The trip doesn't correspond to an active service
       continue;
     }
-    if (!routeIds.get(line.route_id)) {
+    if (!serviceRoutes.get(line.route_id)) {
       // The trip doesn't correspond to a supported route
       continue;
     }
@@ -195,23 +193,27 @@ export const parseTrips = async (
 
 export const buildStopsAdjacencyStructure = (
   validStops: Set<StopId>,
-  routes: RoutesAdjacency,
+  serviceRoutes: ServiceRoutesMap,
+  routes: Route[],
   transfersMap: TransfersMap,
 ): StopsAdjacency => {
   const stopsAdjacency: StopsAdjacency = new Map();
-  for (const routeId of routes.keys()) {
-    const route = routes.get(routeId);
-    if (!route) {
-      throw new Error(`Route ${routeId} not found`);
-    }
+  routes.forEach((route, index) => {
     for (const stop of route.stopsIterator()) {
       if (!stopsAdjacency.get(stop) && validStops.has(stop)) {
         stopsAdjacency.set(stop, { routes: [], transfers: [] });
       }
 
-      stopsAdjacency.get(stop)?.routes.push(routeId);
+      stopsAdjacency.get(stop)?.routes.push(index);
     }
-  }
+    const serviceRoute = serviceRoutes.get(route.serviceRoute());
+    if (!serviceRoute) {
+      throw new Error(
+        `Service route ${route.serviceRoute()} not found for route ${index}.`,
+      );
+    }
+    serviceRoute.routes.push(index);
+  });
   for (const [stop, transfers] of transfersMap) {
     const s = stopsAdjacency.get(stop);
     if (s) {
@@ -239,7 +241,7 @@ export const parseStopTimes = async (
   stopsMap: ParsedStopsMap,
   validTripIds: TripIdsMap,
   validStopIds: Set<StopId>,
-): Promise<RoutesAdjacency> => {
+): Promise<Route[]> => {
   /**
    * Adds a trip to the appropriate route builder
    */
@@ -296,7 +298,8 @@ export const parseStopTimes = async (
     dropOffTypes = [];
   };
 
-  const routeBuilders: Map<RouteId, RouteBuilder> = new Map();
+  type BuilderRouteId = string;
+  const routeBuilders: Map<BuilderRouteId, RouteBuilder> = new Map();
 
   let previousSeq = 0;
   let stops: StopId[] = [];
@@ -355,11 +358,10 @@ export const parseStopTimes = async (
     addTrip(currentTripId);
   }
 
-  const routesAdjacency: RoutesAdjacency = new Map<RouteId, Route>();
-  for (const [routeId, routeBuilder] of routeBuilders) {
+  const routesAdjacency: Route[] = [];
+  for (const [, routeBuilder] of routeBuilders) {
     const routeData = finalizeRouteFromBuilder(routeBuilder);
-    routesAdjacency.set(
-      routeId,
+    routesAdjacency.push(
       new Route(
         routeData.stopTimes,
         routeData.pickUpDropOffTypes,

package/src/router.ts

@@ -12,7 +12,7 @@ import { Duration } from './timetable/duration.js';
 import { Time } from './timetable/time.js';
 import type {
   RouteType,
-  ServiceRoute,
+  ServiceRouteInfo,
   TransferType,
 } from './timetable/timetable.js';
 import { Timetable } from './timetable/timetable.js';
@@ -34,7 +34,7 @@ export type {
   LocationType,
   ReachingTime,
   RouteType,
-  ServiceRoute,
+  ServiceRouteInfo,
   SourceStopId,
   Stop,
   StopId,

package/src/routing/__tests__/route.test.ts

@@ -4,7 +4,7 @@ import { describe, it } from 'node:test';
 import { Stop } from '../../stops/stops.js';
 import { Duration } from '../../timetable/duration.js';
 import { Time } from '../../timetable/time.js';
-import { ServiceRoute, TransferType } from '../../timetable/timetable.js';
+import { ServiceRouteInfo, TransferType } from '../../timetable/timetable.js';
 import { Route } from '../route.js';
 
 describe('Route', () => {
@@ -40,12 +40,12 @@ describe('Route', () => {
     children: [],
   };
 
-  const serviceRoute: ServiceRoute = {
+  const serviceRoute: ServiceRouteInfo = {
     type: 'BUS',
     name: 'Route 1',
   };
 
-  const serviceRoute2: ServiceRoute = {
+  const serviceRoute2: ServiceRouteInfo = {
     type: 'RAIL',
     name: 'Route 2',
   };