minotor 5.0.1 → 6.0.0

package/dist/stops/io.d.ts

@@ -1,4 +1,4 @@
 import { StopsMap as ProtoStopsMap } from './proto/stops.js';
-import { StopsMap } from './stops.js';
-export declare const serializeStopsMap: (stopsMap: StopsMap) => ProtoStopsMap;
-export declare const deserializeStopsMap: (protoStopsMap: ProtoStopsMap) => StopsMap;
+import { Stop } from './stops.js';
+export declare const serializeStopsMap: (stops: Stop[]) => ProtoStopsMap;
+export declare const deserializeStopsMap: (protoStopsMap: ProtoStopsMap) => Stop[];

package/dist/stops/proto/stops.d.ts

@@ -22,17 +22,10 @@ export interface Stop {
 }
 export interface StopsMap {
     version: string;
-    stops: {
-        [key: number]: Stop;
-    };
-}
-export interface StopsMap_StopsEntry {
-    key: number;
-    value: Stop | undefined;
+    stops: Stop[];
 }
 export declare const Stop: MessageFns<Stop>;
 export declare const StopsMap: MessageFns<StopsMap>;
-export declare const StopsMap_StopsEntry: MessageFns<StopsMap_StopsEntry>;
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
     [K in keyof T]?: DeepPartial<T[K]>;

package/dist/stops/stops.d.ts

@@ -15,10 +15,6 @@ export type Stop = {
     locationType: LocationType;
     platform?: Platform;
 };
-/**
- * Mapping internal StopIds to Stop objects.
- */
-export type StopsMap = Map<StopId, Stop>;
 /**
  * Mapping source stopIds to internal stopIds;
  */

package/dist/stops/stopsIndex.d.ts

@@ -1,16 +1,16 @@
-import { SourceStopId, Stop, StopId, StopsMap } from './stops.js';
+import { SourceStopId, Stop, StopId } from './stops.js';
 /**
  * The StopMap class provides functionality to search for public transport stops
  * by name or geographic location. It leverages text search and geospatial indexing
  * to efficiently find stops based on user queries.
  */
 export declare class StopsIndex {
-    private readonly stopsMap;
+    private readonly stops;
     private readonly sourceStopsMap;
     private readonly textIndex;
     private readonly geoIndex;
     private readonly stopPoints;
-    constructor(stopsMap: StopsMap);
+    constructor(stops: Stop[]);
     /**
      * Deserializes a binary representation of the stops.
      *

package/dist/timetable/io.d.ts

@@ -1,15 +1,15 @@
-import { Route as ProtoRoute, ServiceRoutesMap as ProtoServiceRoutesMap, StopsAdjacency as ProtoStopsAdjacency } from './proto/timetable.js';
+import { Route as ProtoRoute, ServiceRoute as ProtoServiceRoute, StopAdjacency as ProtoStopAdjacency } from './proto/timetable.js';
 import { Route } from './route.js';
-import { ServiceRouteId, ServiceRoutesMap, StopsAdjacency } from './timetable.js';
+import { ServiceRoute, ServiceRouteId, StopAdjacency } from './timetable.js';
 export type SerializedRoute = {
     stopTimes: Uint16Array;
     pickUpDropOffTypes: Uint8Array;
     stops: Uint32Array;
     serviceRouteId: ServiceRouteId;
 };
-export declare const serializeStopsAdjacency: (stopsAdjacency: StopsAdjacency) => ProtoStopsAdjacency;
+export declare const serializeStopsAdjacency: (stopsAdjacency: StopAdjacency[]) => ProtoStopAdjacency[];
 export declare const serializeRoutesAdjacency: (routesAdjacency: Route[]) => ProtoRoute[];
-export declare const serializeServiceRoutesMap: (serviceRoutesMap: ServiceRoutesMap) => ProtoServiceRoutesMap;
-export declare const deserializeStopsAdjacency: (protoStopsAdjacency: ProtoStopsAdjacency) => StopsAdjacency;
+export declare const serializeServiceRoutesMap: (serviceRoutes: ServiceRoute[]) => ProtoServiceRoute[];
+export declare const deserializeStopsAdjacency: (protoStopsAdjacency: ProtoStopAdjacency[]) => StopAdjacency[];
 export declare const deserializeRoutesAdjacency: (protoRoutesAdjacency: ProtoRoute[]) => Route[];
-export declare const deserializeServiceRoutesMap: (protoServiceRoutesMap: ProtoServiceRoutesMap) => ServiceRoutesMap;
+export declare const deserializeServiceRoutesMap: (protoServiceRoutes: ProtoServiceRoute[]) => ServiceRoute[];

package/dist/timetable/proto/timetable.d.ts

@@ -46,54 +46,32 @@ export interface Route {
      * Format: [stop1, stop2, stop3, etc.]
      */
     stops: Uint8Array;
-    serviceRouteId: string;
+    serviceRouteId: number;
 }
 export interface Transfer {
     destination: number;
     type: TransferType;
     minTransferTime?: number | undefined;
 }
-export interface StopsAdjacency {
-    stops: {
-        [key: number]: StopsAdjacency_StopAdjacency;
-    };
-}
-export interface StopsAdjacency_StopAdjacency {
+export interface StopAdjacency {
     transfers: Transfer[];
     routes: number[];
 }
-export interface StopsAdjacency_StopsEntry {
-    key: number;
-    value: StopsAdjacency_StopAdjacency | undefined;
-}
 export interface ServiceRoute {
     type: RouteType;
     name: string;
     routes: number[];
 }
-export interface ServiceRoutesMap {
-    routes: {
-        [key: string]: ServiceRoute;
-    };
-}
-export interface ServiceRoutesMap_RoutesEntry {
-    key: string;
-    value: ServiceRoute | undefined;
-}
 export interface Timetable {
     version: string;
-    stopsAdjacency: StopsAdjacency | undefined;
+    stopsAdjacency: StopAdjacency[];
     routesAdjacency: Route[];
-    routes: ServiceRoutesMap | undefined;
+    serviceRoutes: ServiceRoute[];
 }
 export declare const Route: MessageFns<Route>;
 export declare const Transfer: MessageFns<Transfer>;
-export declare const StopsAdjacency: MessageFns<StopsAdjacency>;
-export declare const StopsAdjacency_StopAdjacency: MessageFns<StopsAdjacency_StopAdjacency>;
-export declare const StopsAdjacency_StopsEntry: MessageFns<StopsAdjacency_StopsEntry>;
+export declare const StopAdjacency: MessageFns<StopAdjacency>;
 export declare const ServiceRoute: MessageFns<ServiceRoute>;
-export declare const ServiceRoutesMap: MessageFns<ServiceRoutesMap>;
-export declare const ServiceRoutesMap_RoutesEntry: MessageFns<ServiceRoutesMap_RoutesEntry>;
 export declare const Timetable: MessageFns<Timetable>;
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {

package/dist/timetable/timetable.d.ts

@@ -7,29 +7,29 @@ export type Transfer = {
     type: TransferType;
     minTransferTime?: Duration;
 };
-export type StopsAdjacency = Map<StopId, {
+export type StopAdjacency = {
     transfers: Transfer[];
     routes: RouteId[];
-}>;
-export type ServiceRouteId = string;
+};
+export type ServiceRouteId = number;
 export type RouteType = 'TRAM' | 'SUBWAY' | 'RAIL' | 'BUS' | 'FERRY' | 'CABLE_TRAM' | 'AERIAL_LIFT' | 'FUNICULAR' | 'TROLLEYBUS' | 'MONORAIL';
-type ServiceRoute = {
+export type ServiceRoute = {
     type: RouteType;
     name: string;
     routes: RouteId[];
 };
 export type ServiceRouteInfo = Omit<ServiceRoute, 'routes'>;
-export type ServiceRoutesMap = Map<ServiceRouteId, ServiceRoute>;
 export declare const ALL_TRANSPORT_MODES: Set<RouteType>;
-export declare const CURRENT_VERSION = "0.0.5";
+export declare const CURRENT_VERSION = "0.0.6";
 /**
  * The internal transit timetable format.
  */
 export declare class Timetable {
     private readonly stopsAdjacency;
     private readonly routesAdjacency;
-    private readonly routes;
-    constructor(stopsAdjacency: StopsAdjacency, routesAdjacency: Route[], routes: ServiceRoutesMap);
+    private readonly serviceRoutes;
+    private readonly activeStops;
+    constructor(stopsAdjacency: StopAdjacency[], routesAdjacency: Route[], routes: ServiceRoute[]);
     /**
      * Serializes the Timetable into a binary array.
      *
@@ -43,6 +43,15 @@ export declare class Timetable {
      * @returns The deserialized Timetable object.
      */
     static fromData(data: Uint8Array): Timetable;
+    /**
+     * Checks if the given stop is active on the timetable.
+     * An active stop is a stop reached by a route that is active on the timetable
+     * or by a transfer reachable from an active route.
+     *
+     * @param stopId - The ID of the stop to check.
+     * @returns True if the stop is active, false otherwise.
+     */
+    isActive(stopId: StopId): boolean;
     /**
      * Retrieves the route associated with the given route ID.
      *
@@ -85,4 +94,3 @@ export declare class Timetable {
      */
     findReachableRoutes(fromStops: Set<StopId>, transportModes?: Set<RouteType>): Map<Route, StopId>;
 }
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "minotor",
-  "version": "5.0.1",
+  "version": "6.0.0",
   "description": "A lightweight client-side transit routing library.",
   "keywords": [
     "minotor",

package/src/__e2e__/timetable/stops.bin

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:5d50ecc83be66f6fcd413a1316fd368adcae73980f1b237d9afd3c8395c88937
-size 5718250
+oid sha256:9d01e1988e595441682589f20612343670f6c01d18df037c389d0946a4ca6e61
+size 5121353

package/src/__e2e__/timetable/timetable.bin

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:0be82b0986ef67a97e400991a8fafdf0a616d0ca26292b10a4c5681b9f200eaf
-size 18488714
+oid sha256:c2ba83dc99279de7efd87f05c5b49c16f4dbf509e6c3f77af8f98b3273afb9e2
+size 18173715

package/src/cli/minotor.ts

@@ -67,11 +67,10 @@ program
         log.setDefaultLevel(log.levels.ERROR);
       }
       const parser = new GtfsParser(gtfsPath, profiles[options.profileName]);
-      const { timetable, stopsIndex } = await parser.parse(
-        new Date(options.date),
-      );
-      fs.writeFileSync(options.timetableOutputPath, timetable.serialize());
+      const stopsIndex = await parser.parseStops();
       fs.writeFileSync(options.stopsOutputPath, stopsIndex.serialize());
+      const timetable = await parser.parseTimetable(new Date(options.date));
+      fs.writeFileSync(options.timetableOutputPath, timetable.serialize());
     },
   );
 

package/src/gtfs/__tests__/parser.test.ts

@@ -21,9 +21,8 @@ describe('GTFS parser', () => {
   });
 
   it('should correctly parse timetable from GTFS feed', async () => {
-    const { timetable, stopsIndex } = await parser.parse(
-      new Date('2007-01-10'),
-    );
+    const timetable = await parser.parseTimetable(new Date('2007-01-10'));
+    const stopsIndex = await parser.parseStops();
 
     const furCreekResId =
       stopsIndex.findStopBySourceStopId('FUR_CREEK_RES')?.id;
@@ -33,7 +32,7 @@ describe('GTFS parser', () => {
 
     const route = timetable.getRoute(3);
     assert(route);
-    assert.strictEqual(route.serviceRoute(), 'AB');
+    assert.strictEqual(route.serviceRoute(), 2);
     const beattyAirportId =
       stopsIndex.findStopBySourceStopId('BEATTY_AIRPORT')?.id;
     const bullfrogId = stopsIndex.findStopBySourceStopId('BULLFROG')?.id;
@@ -48,8 +47,8 @@ describe('GTFS parser', () => {
 
     const routes = timetable.routesPassingThrough(furCreekResId);
     assert.strictEqual(routes.length, 2);
-    assert.strictEqual(routes[0]?.serviceRoute(), 'BFC');
-    assert.strictEqual(routes[1]?.serviceRoute(), 'BFC');
+    assert.strictEqual(routes[0]?.serviceRoute(), 3);
+    assert.strictEqual(routes[1]?.serviceRoute(), 3);
 
     const serviceRoute = timetable.getServiceRouteInfo(route);
     assert(serviceRoute);

package/src/gtfs/__tests__/routes.test.ts

@@ -24,7 +24,6 @@ describe('GTFS routes parser', () => {
             {
               type: 'BUS',
               name: 'B1',
-              routes: [],
             },
           ],
           [
@@ -32,7 +31,6 @@ describe('GTFS routes parser', () => {
             {
               type: 'TRAM',
               name: 'T1',
-              routes: [],
             },
           ],
         ]),
@@ -56,7 +54,6 @@ describe('GTFS routes parser', () => {
             {
               type: 'BUS',
               name: 'B1',
-              routes: [],
             },
           ],
         ]),

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

@@ -2,8 +2,7 @@ import assert from 'node:assert';
 import { Readable } from 'node:stream';
 import { describe, it } from 'node:test';
 
-import { StopId } from '../../stops/stops.js';
-import { indexStops, ParsedStopsMap, parseStops } from '../stops.js';
+import { parseStops } from '../stops.js';
 
 describe('GTFS stops parser', () => {
   describe('parseStops', () => {
@@ -114,126 +113,4 @@ describe('GTFS stops parser', () => {
       assert.equal(childStop2.platform, '2');
     });
   });
-
-  describe('indexStops', () => {
-    it('should correctly index parsed stops', () => {
-      const parsedStopsMap: ParsedStopsMap = new Map();
-
-      parsedStopsMap.set('Parent8504100', {
-        id: 0,
-        sourceStopId: 'Parent8504100',
-        name: 'Fribourg/Freiburg',
-        lat: 46.8031492395272,
-        lon: 7.15104780338173,
-        locationType: 'STATION',
-        children: [1, 2],
-      });
-
-      parsedStopsMap.set('8504100:0:1', {
-        id: 1,
-        sourceStopId: '8504100:0:1',
-        name: 'Fribourg/Freiburg',
-        lat: 46.8018210323626,
-        lon: 7.14993389242926,
-        locationType: 'SIMPLE_STOP_OR_PLATFORM',
-        children: [],
-        parent: 0,
-        platform: '1',
-        parentSourceId: 'Parent8504100',
-      });
-
-      parsedStopsMap.set('8504100:0:2', {
-        id: 2,
-        sourceStopId: '8504100:0:2',
-        name: 'Fribourg/Freiburg',
-        lat: 46.8010031847878,
-        lon: 7.14920625704902,
-        locationType: 'SIMPLE_STOP_OR_PLATFORM',
-        children: [],
-        parent: 0,
-        platform: '2',
-        parentSourceId: 'Parent8504100',
-      });
-
-      const indexedStops = indexStops(parsedStopsMap);
-
-      assert.equal(indexedStops.size, 3);
-
-      const station = indexedStops.get(0);
-      assert.ok(station);
-      assert.equal(station.sourceStopId, 'Parent8504100');
-      assert.deepEqual(station.children, [1, 2]);
-
-      const platform1 = indexedStops.get(1);
-      assert.ok(platform1);
-      assert.equal(platform1.sourceStopId, '8504100:0:1');
-      assert.equal(platform1.platform, '1');
-      assert.equal(platform1.parent, 0);
-
-      const platform2 = indexedStops.get(2);
-      assert.ok(platform2);
-      assert.equal(platform2.sourceStopId, '8504100:0:2');
-      assert.equal(platform2.platform, '2');
-      assert.equal(platform2.parent, 0);
-    });
-
-    it('should filter stops based on validStops set', () => {
-      const parsedStopsMap: ParsedStopsMap = new Map();
-
-      parsedStopsMap.set('Parent8504100', {
-        id: 0,
-        sourceStopId: 'Parent8504100',
-        name: 'Fribourg/Freiburg',
-        lat: 46.8031492395272,
-        lon: 7.15104780338173,
-        locationType: 'STATION',
-        children: [1, 2, 3],
-      });
-
-      parsedStopsMap.set('8504100:0:1', {
-        id: 1,
-        sourceStopId: '8504100:0:1',
-        name: 'Fribourg/Freiburg',
-        lat: 46.8018210323626,
-        lon: 7.14993389242926,
-        locationType: 'SIMPLE_STOP_OR_PLATFORM',
-        children: [],
-        parent: 0,
-        parentSourceId: 'Parent8504100',
-      });
-
-      parsedStopsMap.set('8504100:0:2', {
-        id: 2,
-        sourceStopId: '8504100:0:2',
-        name: 'Fribourg/Freiburg',
-        lat: 46.8010031847878,
-        lon: 7.14920625704902,
-        locationType: 'SIMPLE_STOP_OR_PLATFORM',
-        children: [],
-        parent: 0,
-        parentSourceId: 'Parent8504100',
-      });
-
-      parsedStopsMap.set('8504100:0:3', {
-        id: 3,
-        sourceStopId: '8504100:0:3',
-        name: 'Fribourg/Freiburg',
-        lat: 46.8,
-        lon: 7.14,
-        locationType: 'SIMPLE_STOP_OR_PLATFORM',
-        children: [],
-        parent: 0,
-        parentSourceId: 'Parent8504100',
-      });
-      const validStops = new Set<StopId>([1, 2]);
-
-      const indexedStops = indexStops(parsedStopsMap, validStops);
-
-      assert.equal(indexedStops.size, 3);
-      assert.ok(indexedStops.has(0));
-      assert.ok(indexedStops.has(1));
-      assert.ok(indexedStops.has(2));
-      assert.ok(!indexedStops.has(3));
-    });
-  });
 });

package/src/gtfs/__tests__/transfers.test.ts

@@ -3,7 +3,7 @@ import { Readable } from 'node:stream';
 import { describe, it } from 'node:test';
 
 import { Duration } from '../../timetable/duration.js';
-import { ParsedStopsMap } from '../stops.js';
+import { GtfsStopsMap } from '../stops.js';
 import { parseTransfers } from '../transfers.js';
 
 describe('GTFS transfers parser', () => {
@@ -16,7 +16,7 @@ describe('GTFS transfers parser', () => {
     mockedStream.push('"1100097","8014447","2","240"\n');
     mockedStream.push(null);
 
-    const stopsMap: ParsedStopsMap = new Map([
+    const stopsMap: GtfsStopsMap = new Map([
       [
         '1100084',
         {
@@ -95,7 +95,7 @@ describe('GTFS transfers parser', () => {
     mockedStream.push('"1100097","8014447","5","240"\n');
     mockedStream.push(null);
 
-    const stopsMap: ParsedStopsMap = new Map([
+    const stopsMap: GtfsStopsMap = new Map([
       [
         '1100084',
         {
@@ -150,7 +150,7 @@ describe('GTFS transfers parser', () => {
     mockedStream.push('"1100084","8014440","2","180"\n');
     mockedStream.push(null);
 
-    const stopsMap: ParsedStopsMap = new Map([
+    const stopsMap: GtfsStopsMap = new Map([
       [
         '1100084',
         {
@@ -185,7 +185,7 @@ describe('GTFS transfers parser', () => {
     mockedStream.push('"1100084","8014440","2","180"\n');
     mockedStream.push(null);
 
-    const stopsMap: ParsedStopsMap = new Map([
+    const stopsMap: GtfsStopsMap = new Map([
       [
         '1100084',
         {
@@ -220,7 +220,7 @@ describe('GTFS transfers parser', () => {
     mockedStream.push('"1100084","8014440:0:1","2"\n');
     mockedStream.push(null);
 
-    const stopsMap: ParsedStopsMap = new Map([
+    const stopsMap: GtfsStopsMap = new Map([
       [
         '1100084',
         {
@@ -266,7 +266,7 @@ describe('GTFS transfers parser', () => {
     );
     mockedStream.push(null);
 
-    const stopsMap: ParsedStopsMap = new Map();
+    const stopsMap: GtfsStopsMap = new Map();
 
     const transfers = await parseTransfers(mockedStream, stopsMap);
     assert.deepEqual(transfers, new Map());