minotor 11.2.3 → 11.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/CHANGELOG.md +3 -3
  2. package/README.md +27 -0
  3. package/dist/cli.mjs +300 -98
  4. package/dist/cli.mjs.map +1 -1
  5. package/dist/gtfs/parser.d.ts +3 -1
  6. package/dist/gtfs/routes.d.ts +1 -2
  7. package/dist/gtfs/trips.d.ts +2 -1
  8. package/dist/parser.cjs.js +225 -81
  9. package/dist/parser.cjs.js.map +1 -1
  10. package/dist/parser.d.ts +6 -2
  11. package/dist/parser.esm.js +224 -82
  12. package/dist/parser.esm.js.map +1 -1
  13. package/dist/router.cjs.js +1 -1
  14. package/dist/router.cjs.js.map +1 -1
  15. package/dist/router.d.ts +4 -3
  16. package/dist/router.esm.js +1 -1
  17. package/dist/router.esm.js.map +1 -1
  18. package/dist/router.umd.js +1 -1
  19. package/dist/router.umd.js.map +1 -1
  20. package/dist/routing/result.d.ts +1 -4
  21. package/dist/routing/route.d.ts +9 -5
  22. package/dist/timetable/route.d.ts +9 -5
  23. package/dist/timetable/timetable.d.ts +24 -3
  24. package/dist/transfers/__tests__/straightLineTransferGenerator.test.d.ts +1 -0
  25. package/dist/transfers/generator.d.ts +40 -0
  26. package/dist/transfers/straightLineTransferGenerator.d.ts +58 -0
  27. package/dist/utils/map.d.ts +10 -0
  28. package/package.json +1 -1
  29. package/src/__e2e__/router.test.ts +6 -2
  30. package/src/cli/minotor.ts +21 -1
  31. package/src/cli/repl.ts +6 -12
  32. package/src/gtfs/__tests__/parser.test.ts +29 -1
  33. package/src/gtfs/__tests__/routes.test.ts +4 -3
  34. package/src/gtfs/__tests__/transfers.test.ts +8 -8
  35. package/src/gtfs/__tests__/trips.test.ts +60 -24
  36. package/src/gtfs/parser.ts +50 -1
  37. package/src/gtfs/profiles/__tests__/extended.test.ts +2 -1
  38. package/src/gtfs/profiles/extended.ts +14 -14
  39. package/src/gtfs/profiles/standard.ts +11 -10
  40. package/src/gtfs/routes.ts +5 -2
  41. package/src/gtfs/transfers.ts +6 -5
  42. package/src/gtfs/trips.ts +7 -14
  43. package/src/parser.ts +20 -2
  44. package/src/router.ts +12 -6
  45. package/src/routing/__tests__/access.test.ts +14 -6
  46. package/src/routing/__tests__/plainRouter.test.ts +25 -23
  47. package/src/routing/__tests__/plotter.test.ts +8 -3
  48. package/src/routing/__tests__/rangeResult.test.ts +6 -2
  49. package/src/routing/__tests__/rangeRouter.test.ts +10 -6
  50. package/src/routing/__tests__/raptor.test.ts +15 -9
  51. package/src/routing/__tests__/result.test.ts +9 -4
  52. package/src/routing/__tests__/route.test.ts +3 -4
  53. package/src/routing/__tests__/router.test.ts +2 -1
  54. package/src/routing/access.ts +7 -4
  55. package/src/routing/plotter.ts +8 -3
  56. package/src/routing/raptor.ts +5 -5
  57. package/src/routing/result.ts +32 -14
  58. package/src/routing/route.ts +13 -10
  59. package/src/routing/state.ts +1 -1
  60. package/src/timetable/__tests__/io.test.ts +22 -10
  61. package/src/timetable/__tests__/route.test.ts +18 -24
  62. package/src/timetable/__tests__/timetable.test.ts +17 -11
  63. package/src/timetable/io.ts +30 -28
  64. package/src/timetable/route.ts +14 -7
  65. package/src/timetable/timetable.ts +77 -28
  66. package/src/transfers/README.md +97 -0
  67. package/src/transfers/__tests__/straightLineTransferGenerator.test.ts +204 -0
  68. package/src/transfers/generator.ts +45 -0
  69. package/src/transfers/straightLineTransferGenerator.ts +143 -0
  70. package/src/utils/map.ts +22 -0
@@ -1,4 +1,5 @@
1
1
  import { Stop } from '../stops/stops.js';
2
+ import type { PickUpDropOffTypeString } from '../timetable/route.js';
2
3
  import {
3
4
  Duration,
4
5
  DURATION_ZERO,
@@ -7,13 +8,15 @@ import {
7
8
  TIME_ORIGIN,
8
9
  timeToString,
9
10
  } from '../timetable/time.js';
10
- import { ServiceRouteInfo, TransferType } from '../timetable/timetable.js';
11
-
12
- export type PickUpDropOffType =
13
- | 'REGULAR'
14
- | 'NOT_AVAILABLE'
15
- | 'MUST_PHONE_AGENCY'
16
- | 'MUST_COORDINATE_WITH_DRIVER';
11
+ import type {
12
+ RouteTypeString,
13
+ TransferTypeString,
14
+ } from '../timetable/timetable.js';
15
+
16
+ export type ServiceRouteInfo = {
17
+ type: RouteTypeString;
18
+ name: string;
19
+ };
17
20
 
18
21
  export type BaseLeg = {
19
22
  from: Stop;
@@ -26,15 +29,15 @@ export type Access = BaseLeg & {
26
29
 
27
30
  export type Transfer = BaseLeg & {
28
31
  minTransferTime?: Duration;
29
- type: TransferType;
32
+ type: TransferTypeString;
30
33
  };
31
34
 
32
35
  export type VehicleLeg = BaseLeg & {
33
36
  route: ServiceRouteInfo;
34
37
  departureTime: Time;
35
38
  arrivalTime: Time;
36
- pickUpType: PickUpDropOffType;
37
- dropOffType: PickUpDropOffType;
39
+ pickUpType: PickUpDropOffTypeString;
40
+ dropOffType: PickUpDropOffTypeString;
38
41
  };
39
42
 
40
43
  export type Leg = Transfer | Access | VehicleLeg;
@@ -33,7 +33,7 @@ export type VehicleEdge = TripStop & {
33
33
  export type TransferEdge = {
34
34
  arrival: Time;
35
35
  from: StopId;
36
- to: StopId; // TODO remove
36
+ to: StopId;
37
37
  type: TransferType;
38
38
  minTransferTime?: Duration;
39
39
  };
@@ -11,22 +11,28 @@ import {
11
11
  serializeStopsAdjacency,
12
12
  serializeTripTransfers,
13
13
  } from '../io.js';
14
- import { REGULAR, Route } from '../route.js';
14
+ import { PickUpDropOffTypes, Route } from '../route.js';
15
15
  import { timeFromHMS } from '../time.js';
16
- import { ServiceRoute, StopAdjacency, TripStop } from '../timetable.js';
16
+ import {
17
+ RouteTypes,
18
+ ServiceRoute,
19
+ StopAdjacency,
20
+ TransferTypes,
21
+ TripStop,
22
+ } from '../timetable.js';
17
23
  import { encode } from '../tripStopId.js';
18
24
 
19
25
  describe('Timetable IO', () => {
20
26
  const stopsAdjacency: StopAdjacency[] = [
21
27
  {
22
- transfers: [{ destination: 2, type: 'RECOMMENDED' }],
28
+ transfers: [{ destination: 2, type: TransferTypes.RECOMMENDED }],
23
29
  routes: [0],
24
30
  },
25
31
  {
26
32
  transfers: [
27
33
  {
28
34
  destination: 1,
29
- type: 'GUARANTEED',
35
+ type: TransferTypes.GUARANTEED,
30
36
  minTransferTime: 3,
31
37
  },
32
38
  ],
@@ -37,21 +43,21 @@ describe('Timetable IO', () => {
37
43
  new Route(
38
44
  0,
39
45
  new Uint16Array([timeFromHMS(16, 40, 0), timeFromHMS(16, 50, 0)]),
40
- new Uint8Array([REGULAR, REGULAR]),
46
+ new Uint8Array([PickUpDropOffTypes.REGULAR, PickUpDropOffTypes.REGULAR]),
41
47
  new Uint32Array([1, 2]),
42
48
  0,
43
49
  ),
44
50
  new Route(
45
51
  1,
46
52
  new Uint16Array([timeFromHMS(15, 20, 0), timeFromHMS(15, 30, 0)]),
47
- new Uint8Array([REGULAR, REGULAR]),
53
+ new Uint8Array([PickUpDropOffTypes.REGULAR, PickUpDropOffTypes.REGULAR]),
48
54
  new Uint32Array([2, 1]),
49
55
  1,
50
56
  ),
51
57
  ];
52
58
  const routes: ServiceRoute[] = [
53
- { type: 'RAIL', name: 'Route 1', routes: [0] },
54
- { type: 'RAIL', name: 'Route 2', routes: [1] },
59
+ { type: RouteTypes.RAIL, name: 'Route 1', routes: [0] },
60
+ { type: RouteTypes.RAIL, name: 'Route 2', routes: [1] },
55
61
  ];
56
62
  const stopsAdjacencyProto = [
57
63
  {
@@ -76,7 +82,10 @@ describe('Timetable IO', () => {
76
82
  new Uint16Array([timeFromHMS(16, 40, 0), timeFromHMS(16, 50, 0)])
77
83
  .buffer,
78
84
  ),
79
- pickupDropOffTypes: new Uint8Array([REGULAR, REGULAR]),
85
+ pickupDropOffTypes: new Uint8Array([
86
+ PickUpDropOffTypes.REGULAR,
87
+ PickUpDropOffTypes.REGULAR,
88
+ ]),
80
89
  stops: new Uint8Array(new Uint32Array([1, 2]).buffer),
81
90
  serviceRouteId: 0,
82
91
  },
@@ -85,7 +94,10 @@ describe('Timetable IO', () => {
85
94
  new Uint16Array([timeFromHMS(15, 20, 0), timeFromHMS(15, 30, 0)])
86
95
  .buffer,
87
96
  ),
88
- pickupDropOffTypes: new Uint8Array([REGULAR, REGULAR]),
97
+ pickupDropOffTypes: new Uint8Array([
98
+ PickUpDropOffTypes.REGULAR,
99
+ PickUpDropOffTypes.REGULAR,
100
+ ]),
89
101
  stops: new Uint8Array(new Uint32Array([2, 1]).buffer),
90
102
  serviceRouteId: 1,
91
103
  },
@@ -2,13 +2,7 @@ import assert from 'node:assert';
2
2
  import { describe, it } from 'node:test';
3
3
 
4
4
  import { encodePickUpDropOffTypes } from '../../gtfs/trips.js';
5
- import {
6
- MUST_COORDINATE_WITH_DRIVER,
7
- MUST_PHONE_AGENCY,
8
- NOT_AVAILABLE,
9
- REGULAR,
10
- Route,
11
- } from '../route.js';
5
+ import { PickUpDropOffTypes, Route } from '../route.js';
12
6
  import { TIME_ORIGIN, timeFromHMS } from '../time.js';
13
7
 
14
8
  describe('Route', () => {
@@ -33,25 +27,25 @@ describe('Route', () => {
33
27
  const pickupDropOffTypes = encodePickUpDropOffTypes(
34
28
  [
35
29
  // Trip 0
36
- REGULAR,
37
- NOT_AVAILABLE,
30
+ PickUpDropOffTypes.REGULAR,
31
+ PickUpDropOffTypes.NOT_AVAILABLE,
38
32
  // Trip 1
39
- REGULAR,
40
- REGULAR,
33
+ PickUpDropOffTypes.REGULAR,
34
+ PickUpDropOffTypes.REGULAR,
41
35
  // Trip 2
42
- MUST_PHONE_AGENCY,
43
- MUST_COORDINATE_WITH_DRIVER,
36
+ PickUpDropOffTypes.MUST_PHONE_AGENCY,
37
+ PickUpDropOffTypes.MUST_COORDINATE_WITH_DRIVER,
44
38
  ],
45
39
  [
46
40
  // Trip 0
47
- REGULAR,
48
- REGULAR,
41
+ PickUpDropOffTypes.REGULAR,
42
+ PickUpDropOffTypes.REGULAR,
49
43
  // Trip 1
50
- REGULAR,
51
- REGULAR,
44
+ PickUpDropOffTypes.REGULAR,
45
+ PickUpDropOffTypes.REGULAR,
52
46
  // Trip 2
53
- REGULAR,
54
- REGULAR,
47
+ PickUpDropOffTypes.REGULAR,
48
+ PickUpDropOffTypes.REGULAR,
55
49
  ],
56
50
  );
57
51
 
@@ -159,17 +153,17 @@ describe('Route', () => {
159
153
  describe('pickUpTypeFrom', () => {
160
154
  it('should return REGULAR pickup type for trip 0 at stop index 0', () => {
161
155
  const pickUpType = route.pickUpTypeFrom(0, 0);
162
- assert.strictEqual(pickUpType, REGULAR);
156
+ assert.strictEqual(pickUpType, PickUpDropOffTypes.REGULAR);
163
157
  });
164
158
 
165
159
  it('should return NOT_AVAILABLE pickup type for trip 0 at stop index 1', () => {
166
160
  const pickUpType = route.pickUpTypeFrom(1, 0);
167
- assert.strictEqual(pickUpType, NOT_AVAILABLE);
161
+ assert.strictEqual(pickUpType, PickUpDropOffTypes.NOT_AVAILABLE);
168
162
  });
169
163
 
170
164
  it('should return MUST_PHONE_AGENCY pickup type for trip 2 at stop index 0', () => {
171
165
  const pickUpType = route.pickUpTypeFrom(0, 2);
172
- assert.strictEqual(pickUpType, MUST_PHONE_AGENCY);
166
+ assert.strictEqual(pickUpType, PickUpDropOffTypes.MUST_PHONE_AGENCY);
173
167
  });
174
168
 
175
169
  it('should throw error for invalid stop index', () => {
@@ -190,12 +184,12 @@ describe('Route', () => {
190
184
  describe('dropOffTypeAt', () => {
191
185
  it('should return REGULAR drop off type for trip 0 at stop index 0', () => {
192
186
  const dropOffType = route.dropOffTypeAt(0, 0);
193
- assert.strictEqual(dropOffType, REGULAR);
187
+ assert.strictEqual(dropOffType, PickUpDropOffTypes.REGULAR);
194
188
  });
195
189
 
196
190
  it('should return REGULAR drop off type for trip 1 at stop index 1', () => {
197
191
  const dropOffType = route.dropOffTypeAt(1, 1);
198
- assert.strictEqual(dropOffType, REGULAR);
192
+ assert.strictEqual(dropOffType, PickUpDropOffTypes.REGULAR);
199
193
  });
200
194
 
201
195
  it('should throw error for invalid stop index', () => {
@@ -1,13 +1,15 @@
1
1
  import assert from 'node:assert';
2
2
  import { describe, it } from 'node:test';
3
3
 
4
- import { NOT_AVAILABLE, Route } from '../route.js';
4
+ import { PickUpDropOffTypes, Route } from '../route.js';
5
5
  import { timeFromHMS } from '../time.js';
6
6
  import {
7
7
  RouteType,
8
+ RouteTypes,
8
9
  ServiceRoute,
9
10
  StopAdjacency,
10
11
  Timetable,
12
+ TransferTypes,
11
13
  TripStop,
12
14
  TripTransfers,
13
15
  } from '../timetable.js';
@@ -17,14 +19,14 @@ describe('Timetable', () => {
17
19
  const stopsAdjacency: StopAdjacency[] = [
18
20
  { routes: [] },
19
21
  {
20
- transfers: [{ destination: 2, type: 'RECOMMENDED' }],
22
+ transfers: [{ destination: 2, type: TransferTypes.RECOMMENDED }],
21
23
  routes: [0, 1],
22
24
  },
23
25
  {
24
26
  transfers: [
25
27
  {
26
28
  destination: 1,
27
- type: 'GUARANTEED',
29
+ type: TransferTypes.GUARANTEED,
28
30
  minTransferTime: 3,
29
31
  },
30
32
  ],
@@ -50,7 +52,7 @@ describe('Timetable', () => {
50
52
  id: 2,
51
53
  arrivalTime: timeFromHMS(17, 20, 0),
52
54
  departureTime: timeFromHMS(17, 30, 0),
53
- pickUpType: NOT_AVAILABLE,
55
+ pickUpType: PickUpDropOffTypes.NOT_AVAILABLE,
54
56
  },
55
57
  ],
56
58
  },
@@ -92,8 +94,8 @@ describe('Timetable', () => {
92
94
  });
93
95
  const routesAdjacency = [route1, route2];
94
96
  const routes: ServiceRoute[] = [
95
- { type: 'RAIL', name: 'Route 1', routes: [0] },
96
- { type: 'RAIL', name: 'Route 2', routes: [1] },
97
+ { type: RouteTypes.RAIL, name: 'Route 1', routes: [0] },
98
+ { type: RouteTypes.RAIL, name: 'Route 2', routes: [1] },
97
99
  ];
98
100
 
99
101
  const sampleTimetable: Timetable = new Timetable(
@@ -191,7 +193,7 @@ describe('Timetable', () => {
191
193
 
192
194
  const railRoutes = sampleTimetable.findReachableRoutes(
193
195
  fromStops,
194
- new Set<RouteType>(['RAIL']),
196
+ new Set<RouteType>([RouteTypes.RAIL]),
195
197
  );
196
198
  assert.strictEqual(railRoutes.size, 2);
197
199
  assert.deepStrictEqual(
@@ -204,14 +206,18 @@ describe('Timetable', () => {
204
206
 
205
207
  const busRoutes = sampleTimetable.findReachableRoutes(
206
208
  fromStops,
207
- new Set<RouteType>(['BUS']),
209
+ new Set<RouteType>([RouteTypes.BUS]),
208
210
  );
209
211
  assert.strictEqual(busRoutes.size, 0);
210
212
  assert.deepStrictEqual(busRoutes, new Map());
211
213
 
212
214
  const multiModeRoutes = sampleTimetable.findReachableRoutes(
213
215
  fromStops,
214
- new Set<RouteType>(['RAIL', 'BUS', 'SUBWAY']),
216
+ new Set<RouteType>([
217
+ RouteTypes.RAIL,
218
+ RouteTypes.BUS,
219
+ RouteTypes.SUBWAY,
220
+ ]),
215
221
  );
216
222
  assert.strictEqual(multiModeRoutes.size, 2);
217
223
  });
@@ -685,7 +691,7 @@ describe('Timetable', () => {
685
691
  id: 0,
686
692
  arrivalTime: timeFromHMS(9, 0, 0),
687
693
  departureTime: timeFromHMS(9, 0, 0),
688
- pickUpType: NOT_AVAILABLE,
694
+ pickUpType: PickUpDropOffTypes.NOT_AVAILABLE,
689
695
  },
690
696
  {
691
697
  id: 1,
@@ -731,7 +737,7 @@ describe('Timetable', () => {
731
737
  ];
732
738
 
733
739
  const ffbtServiceRoutes = [
734
- { type: 'BUS' as const, name: 'Route 2', routes: [FFBT_ROUTE_ID] },
740
+ { type: RouteTypes.BUS, name: 'Route 2', routes: [FFBT_ROUTE_ID] },
735
741
  ];
736
742
 
737
743
  const ffbtTimetable = new Timetable(
@@ -9,11 +9,13 @@ import {
9
9
  import { Route } from './route.js';
10
10
  import {
11
11
  RouteType,
12
+ RouteTypes,
12
13
  ServiceRoute,
13
14
  ServiceRouteId,
14
15
  StopAdjacency,
15
16
  Transfer,
16
17
  TransferType,
18
+ TransferTypes,
17
19
  TripStop,
18
20
  TripTransfers,
19
21
  } from './timetable.js';
@@ -255,13 +257,13 @@ const parseTransferType = (type: ProtoTransferType): TransferType => {
255
257
  case ProtoTransferType.TRANSFER_TYPE_UNSPECIFIED:
256
258
  throw new Error('Unspecified protobuf transfer type.');
257
259
  case ProtoTransferType.TRANSFER_TYPE_RECOMMENDED_TRANSFER_POINT:
258
- return 'RECOMMENDED';
260
+ return TransferTypes.RECOMMENDED;
259
261
  case ProtoTransferType.TRANSFER_TYPE_TIMED_TRANSFER:
260
- return 'GUARANTEED';
262
+ return TransferTypes.GUARANTEED;
261
263
  case ProtoTransferType.TRANSFER_TYPE_REQUIRES_MINIMAL_TIME:
262
- return 'REQUIRES_MINIMAL_TIME';
264
+ return TransferTypes.REQUIRES_MINIMAL_TIME;
263
265
  case ProtoTransferType.TRANSFER_TYPE_IN_SEAT_TRANSFER:
264
- return 'IN_SEAT';
266
+ return TransferTypes.IN_SEAT;
265
267
  case ProtoTransferType.UNRECOGNIZED:
266
268
  throw new Error('Unrecognized protobuf transfer type.');
267
269
  }
@@ -269,13 +271,13 @@ const parseTransferType = (type: ProtoTransferType): TransferType => {
269
271
 
270
272
  const serializeTransferType = (type: TransferType): ProtoTransferType => {
271
273
  switch (type) {
272
- case 'RECOMMENDED':
274
+ case TransferTypes.RECOMMENDED:
273
275
  return ProtoTransferType.TRANSFER_TYPE_RECOMMENDED_TRANSFER_POINT;
274
- case 'GUARANTEED':
276
+ case TransferTypes.GUARANTEED:
275
277
  return ProtoTransferType.TRANSFER_TYPE_TIMED_TRANSFER;
276
- case 'REQUIRES_MINIMAL_TIME':
278
+ case TransferTypes.REQUIRES_MINIMAL_TIME:
277
279
  return ProtoTransferType.TRANSFER_TYPE_REQUIRES_MINIMAL_TIME;
278
- case 'IN_SEAT':
280
+ case TransferTypes.IN_SEAT:
279
281
  return ProtoTransferType.TRANSFER_TYPE_IN_SEAT_TRANSFER;
280
282
  }
281
283
  };
@@ -285,25 +287,25 @@ const parseRouteType = (type: ProtoRouteType): RouteType => {
285
287
  case ProtoRouteType.ROUTE_TYPE_UNSPECIFIED:
286
288
  throw new Error('Unspecified protobuf route type.');
287
289
  case ProtoRouteType.ROUTE_TYPE_TRAM:
288
- return 'TRAM';
290
+ return RouteTypes.TRAM;
289
291
  case ProtoRouteType.ROUTE_TYPE_SUBWAY:
290
- return 'SUBWAY';
292
+ return RouteTypes.SUBWAY;
291
293
  case ProtoRouteType.ROUTE_TYPE_RAIL:
292
- return 'RAIL';
294
+ return RouteTypes.RAIL;
293
295
  case ProtoRouteType.ROUTE_TYPE_BUS:
294
- return 'BUS';
296
+ return RouteTypes.BUS;
295
297
  case ProtoRouteType.ROUTE_TYPE_FERRY:
296
- return 'FERRY';
298
+ return RouteTypes.FERRY;
297
299
  case ProtoRouteType.ROUTE_TYPE_CABLE_TRAM:
298
- return 'CABLE_TRAM';
300
+ return RouteTypes.CABLE_TRAM;
299
301
  case ProtoRouteType.ROUTE_TYPE_AERIAL_LIFT:
300
- return 'AERIAL_LIFT';
302
+ return RouteTypes.AERIAL_LIFT;
301
303
  case ProtoRouteType.ROUTE_TYPE_FUNICULAR:
302
- return 'FUNICULAR';
304
+ return RouteTypes.FUNICULAR;
303
305
  case ProtoRouteType.ROUTE_TYPE_TROLLEYBUS:
304
- return 'TROLLEYBUS';
306
+ return RouteTypes.TROLLEYBUS;
305
307
  case ProtoRouteType.ROUTE_TYPE_MONORAIL:
306
- return 'MONORAIL';
308
+ return RouteTypes.MONORAIL;
307
309
  case ProtoRouteType.UNRECOGNIZED:
308
310
  default:
309
311
  throw new Error('Unrecognized protobuf route type.');
@@ -312,25 +314,25 @@ const parseRouteType = (type: ProtoRouteType): RouteType => {
312
314
 
313
315
  const serializeRouteType = (type: RouteType): ProtoRouteType => {
314
316
  switch (type) {
315
- case 'TRAM':
317
+ case RouteTypes.TRAM:
316
318
  return ProtoRouteType.ROUTE_TYPE_TRAM;
317
- case 'SUBWAY':
319
+ case RouteTypes.SUBWAY:
318
320
  return ProtoRouteType.ROUTE_TYPE_SUBWAY;
319
- case 'RAIL':
321
+ case RouteTypes.RAIL:
320
322
  return ProtoRouteType.ROUTE_TYPE_RAIL;
321
- case 'BUS':
323
+ case RouteTypes.BUS:
322
324
  return ProtoRouteType.ROUTE_TYPE_BUS;
323
- case 'FERRY':
325
+ case RouteTypes.FERRY:
324
326
  return ProtoRouteType.ROUTE_TYPE_FERRY;
325
- case 'CABLE_TRAM':
327
+ case RouteTypes.CABLE_TRAM:
326
328
  return ProtoRouteType.ROUTE_TYPE_CABLE_TRAM;
327
- case 'AERIAL_LIFT':
329
+ case RouteTypes.AERIAL_LIFT:
328
330
  return ProtoRouteType.ROUTE_TYPE_AERIAL_LIFT;
329
- case 'FUNICULAR':
331
+ case RouteTypes.FUNICULAR:
330
332
  return ProtoRouteType.ROUTE_TYPE_FUNICULAR;
331
- case 'TROLLEYBUS':
333
+ case RouteTypes.TROLLEYBUS:
332
334
  return ProtoRouteType.ROUTE_TYPE_TROLLEYBUS;
333
- case 'MONORAIL':
335
+ case RouteTypes.MONORAIL:
334
336
  return ProtoRouteType.ROUTE_TYPE_MONORAIL;
335
337
  }
336
338
  };
@@ -11,12 +11,19 @@ import { ServiceRouteId } from './timetable.js';
11
11
  */
12
12
  export type RouteId = number;
13
13
 
14
- export type RawPickUpDropOffType = 0 | 1 | 2 | 3;
14
+ export const PickUpDropOffTypes = {
15
+ REGULAR: 0,
16
+ NOT_AVAILABLE: 1,
17
+ MUST_PHONE_AGENCY: 2,
18
+ MUST_COORDINATE_WITH_DRIVER: 3,
19
+ } as const;
15
20
 
16
- export const REGULAR = 0;
17
- export const NOT_AVAILABLE = 1;
18
- export const MUST_PHONE_AGENCY = 2;
19
- export const MUST_COORDINATE_WITH_DRIVER = 3;
21
+ export type PickUpDropOffType =
22
+ (typeof PickUpDropOffTypes)[keyof typeof PickUpDropOffTypes];
23
+
24
+ export type PickUpDropOffTypeString = keyof typeof PickUpDropOffTypes;
25
+
26
+ export type RawPickUpDropOffType = PickUpDropOffType;
20
27
 
21
28
  /*
22
29
  * A trip route index corresponds to the index of a given trip in a route.
@@ -182,8 +189,8 @@ export class Route {
182
189
  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
183
190
  const stop = trip.stops[stopIndex]!;
184
191
  const globalIndex = tripIndex * numStops + stopIndex;
185
- const pickUp = stop.pickUpType ?? REGULAR;
186
- const dropOff = stop.dropOffType ?? REGULAR;
192
+ const pickUp = stop.pickUpType ?? PickUpDropOffTypes.REGULAR;
193
+ const dropOff = stop.dropOffType ?? PickUpDropOffTypes.REGULAR;
187
194
  const byteIndex = Math.floor(globalIndex / 2);
188
195
  const isSecondPair = globalIndex % 2 === 1;
189
196
 
@@ -13,13 +13,26 @@ import {
13
13
  serializeTripTransfers,
14
14
  } from './io.js';
15
15
  import { Timetable as ProtoTimetable } from './proto/v1/timetable.js';
16
- import { NOT_AVAILABLE } from './route.js';
17
- import { Route, RouteId, StopRouteIndex, TripRouteIndex } from './route.js';
16
+ import {
17
+ PickUpDropOffTypes,
18
+ Route,
19
+ RouteId,
20
+ StopRouteIndex,
21
+ TripRouteIndex,
22
+ } from './route.js';
18
23
  import { Duration, DURATION_ZERO, Time, TIME_ORIGIN } from './time.js';
19
24
  import { encode, TripStopId } from './tripStopId.js';
20
25
 
21
- export type TransferType = // TODO use number to represent that.
22
- 'RECOMMENDED' | 'GUARANTEED' | 'REQUIRES_MINIMAL_TIME' | 'IN_SEAT';
26
+ export const TransferTypes = {
27
+ RECOMMENDED: 1,
28
+ GUARANTEED: 2,
29
+ REQUIRES_MINIMAL_TIME: 3,
30
+ IN_SEAT: 4,
31
+ } as const;
32
+
33
+ export type TransferType = (typeof TransferTypes)[keyof typeof TransferTypes];
34
+
35
+ export type TransferTypeString = keyof typeof TransferTypes;
23
36
 
24
37
  export type Transfer = {
25
38
  destination: StopId;
@@ -42,17 +55,22 @@ export type TripTransfers = Map<TripStopId, TripStop[]>;
42
55
 
43
56
  export type ServiceRouteId = number;
44
57
 
45
- export type RouteType =
46
- | 'TRAM'
47
- | 'SUBWAY'
48
- | 'RAIL'
49
- | 'BUS'
50
- | 'FERRY'
51
- | 'CABLE_TRAM'
52
- | 'AERIAL_LIFT'
53
- | 'FUNICULAR'
54
- | 'TROLLEYBUS'
55
- | 'MONORAIL';
58
+ export const RouteTypes = {
59
+ TRAM: 1,
60
+ SUBWAY: 2,
61
+ RAIL: 3,
62
+ BUS: 4,
63
+ FERRY: 5,
64
+ CABLE_TRAM: 6,
65
+ AERIAL_LIFT: 7,
66
+ FUNICULAR: 8,
67
+ TROLLEYBUS: 9,
68
+ MONORAIL: 10,
69
+ } as const;
70
+
71
+ export type RouteType = (typeof RouteTypes)[keyof typeof RouteTypes];
72
+
73
+ export type RouteTypeString = keyof typeof RouteTypes;
56
74
 
57
75
  // A service refers to a collection of trips that are displayed to riders as a single service.
58
76
  // As opposed to a route which consists of the subset of trips from a service which shares the same list of stops.
@@ -64,18 +82,9 @@ export type ServiceRoute = {
64
82
  };
65
83
  export type ServiceRouteInfo = Omit<ServiceRoute, 'routes'>;
66
84
 
67
- export const ALL_TRANSPORT_MODES: Set<RouteType> = new Set([
68
- 'TRAM',
69
- 'SUBWAY',
70
- 'RAIL',
71
- 'BUS',
72
- 'FERRY',
73
- 'CABLE_TRAM',
74
- 'AERIAL_LIFT',
75
- 'FUNICULAR',
76
- 'TROLLEYBUS',
77
- 'MONORAIL',
78
- ]);
85
+ export const ALL_TRANSPORT_MODES: Set<RouteType> = new Set(
86
+ Object.values(RouteTypes),
87
+ );
79
88
 
80
89
  const EMPTY_TRIP_BOARDINGS: TripStop[] = [];
81
90
 
@@ -367,7 +376,7 @@ export class Timetable {
367
376
 
368
377
  for (let t = earliestTrip; t < (beforeTrip ?? nbTrips); t++) {
369
378
  const pickup = route.pickUpTypeFrom(stopIndex, t);
370
- if (pickup === NOT_AVAILABLE) {
379
+ if (pickup === PickUpDropOffTypes.NOT_AVAILABLE) {
371
380
  continue;
372
381
  }
373
382
  if (fromTripStop === undefined) {
@@ -413,3 +422,43 @@ export class Timetable {
413
422
  return guaranteedTripTransfers;
414
423
  }
415
424
  }
425
+
426
+ export const routeTypeToString = (type: RouteType): RouteTypeString => {
427
+ switch (type) {
428
+ case RouteTypes.TRAM:
429
+ return 'TRAM';
430
+ case RouteTypes.SUBWAY:
431
+ return 'SUBWAY';
432
+ case RouteTypes.RAIL:
433
+ return 'RAIL';
434
+ case RouteTypes.BUS:
435
+ return 'BUS';
436
+ case RouteTypes.FERRY:
437
+ return 'FERRY';
438
+ case RouteTypes.CABLE_TRAM:
439
+ return 'CABLE_TRAM';
440
+ case RouteTypes.AERIAL_LIFT:
441
+ return 'AERIAL_LIFT';
442
+ case RouteTypes.FUNICULAR:
443
+ return 'FUNICULAR';
444
+ case RouteTypes.TROLLEYBUS:
445
+ return 'TROLLEYBUS';
446
+ case RouteTypes.MONORAIL:
447
+ return 'MONORAIL';
448
+ }
449
+ };
450
+
451
+ export const transferTypeToString = (
452
+ type: TransferType,
453
+ ): TransferTypeString => {
454
+ switch (type) {
455
+ case TransferTypes.RECOMMENDED:
456
+ return 'RECOMMENDED';
457
+ case TransferTypes.GUARANTEED:
458
+ return 'GUARANTEED';
459
+ case TransferTypes.REQUIRES_MINIMAL_TIME:
460
+ return 'REQUIRES_MINIMAL_TIME';
461
+ case TransferTypes.IN_SEAT:
462
+ return 'IN_SEAT';
463
+ }
464
+ };