minotor 1.0.7 → 2.0.0

package/src/stops/proto/stops.ts

@@ -62,27 +62,29 @@ export function locationTypeToJSON(object: LocationType): string {
 
 export interface Stop {
   name: string;
+  sourceStopId: string;
   lat?: number | undefined;
   lon?: number | undefined;
-  children: string[];
-  parent?: string | undefined;
+  children: number[];
+  parent?: number | undefined;
   locationType: LocationType;
   platform?: string | undefined;
 }
 
 export interface StopsMap {
   version: string;
-  stops: { [key: string]: Stop };
+  stops: { [key: number]: Stop };
 }
 
 export interface StopsMap_StopsEntry {
-  key: string;
+  key: number;
   value: Stop | undefined;
 }
 
 function createBaseStop(): Stop {
   return {
     name: "",
+    sourceStopId: "",
     lat: undefined,
     lon: undefined,
     children: [],
@@ -97,23 +99,28 @@ export const Stop: MessageFns<Stop> = {
     if (message.name !== "") {
       writer.uint32(10).string(message.name);
     }
+    if (message.sourceStopId !== "") {
+      writer.uint32(18).string(message.sourceStopId);
+    }
     if (message.lat !== undefined) {
-      writer.uint32(17).double(message.lat);
+      writer.uint32(25).double(message.lat);
     }
     if (message.lon !== undefined) {
-      writer.uint32(25).double(message.lon);
+      writer.uint32(33).double(message.lon);
     }
+    writer.uint32(42).fork();
     for (const v of message.children) {
-      writer.uint32(34).string(v!);
+      writer.uint32(v);
     }
+    writer.join();
     if (message.parent !== undefined) {
-      writer.uint32(42).string(message.parent);
+      writer.uint32(48).uint32(message.parent);
     }
     if (message.locationType !== 0) {
-      writer.uint32(48).int32(message.locationType);
+      writer.uint32(56).int32(message.locationType);
     }
     if (message.platform !== undefined) {
-      writer.uint32(58).string(message.platform);
+      writer.uint32(66).string(message.platform);
     }
     return writer;
   },
@@ -134,11 +141,11 @@ export const Stop: MessageFns<Stop> = {
           continue;
         }
         case 2: {
-          if (tag !== 17) {
+          if (tag !== 18) {
             break;
           }
 
-          message.lat = reader.double();
+          message.sourceStopId = reader.string();
           continue;
         }
         case 3: {
@@ -146,35 +153,53 @@ export const Stop: MessageFns<Stop> = {
             break;
           }
 
-          message.lon = reader.double();
+          message.lat = reader.double();
           continue;
         }
         case 4: {
-          if (tag !== 34) {
+          if (tag !== 33) {
             break;
           }
 
-          message.children.push(reader.string());
+          message.lon = reader.double();
           continue;
         }
         case 5: {
-          if (tag !== 42) {
-            break;
+          if (tag === 40) {
+            message.children.push(reader.uint32());
+
+            continue;
           }
 
-          message.parent = reader.string();
-          continue;
+          if (tag === 42) {
+            const end2 = reader.uint32() + reader.pos;
+            while (reader.pos < end2) {
+              message.children.push(reader.uint32());
+            }
+
+            continue;
+          }
+
+          break;
         }
         case 6: {
           if (tag !== 48) {
             break;
           }
 
-          message.locationType = reader.int32() as any;
+          message.parent = reader.uint32();
           continue;
         }
         case 7: {
-          if (tag !== 58) {
+          if (tag !== 56) {
+            break;
+          }
+
+          message.locationType = reader.int32() as any;
+          continue;
+        }
+        case 8: {
+          if (tag !== 66) {
             break;
           }
 
@@ -193,10 +218,11 @@ export const Stop: MessageFns<Stop> = {
   fromJSON(object: any): Stop {
     return {
       name: isSet(object.name) ? globalThis.String(object.name) : "",
+      sourceStopId: isSet(object.sourceStopId) ? globalThis.String(object.sourceStopId) : "",
       lat: isSet(object.lat) ? globalThis.Number(object.lat) : undefined,
       lon: isSet(object.lon) ? globalThis.Number(object.lon) : undefined,
-      children: globalThis.Array.isArray(object?.children) ? object.children.map((e: any) => globalThis.String(e)) : [],
-      parent: isSet(object.parent) ? globalThis.String(object.parent) : undefined,
+      children: globalThis.Array.isArray(object?.children) ? object.children.map((e: any) => globalThis.Number(e)) : [],
+      parent: isSet(object.parent) ? globalThis.Number(object.parent) : undefined,
       locationType: isSet(object.locationType) ? locationTypeFromJSON(object.locationType) : 0,
       platform: isSet(object.platform) ? globalThis.String(object.platform) : undefined,
     };
@@ -207,6 +233,9 @@ export const Stop: MessageFns<Stop> = {
     if (message.name !== "") {
       obj.name = message.name;
     }
+    if (message.sourceStopId !== "") {
+      obj.sourceStopId = message.sourceStopId;
+    }
     if (message.lat !== undefined) {
       obj.lat = message.lat;
     }
@@ -214,10 +243,10 @@ export const Stop: MessageFns<Stop> = {
       obj.lon = message.lon;
     }
     if (message.children?.length) {
-      obj.children = message.children;
+      obj.children = message.children.map((e) => Math.round(e));
     }
     if (message.parent !== undefined) {
-      obj.parent = message.parent;
+      obj.parent = Math.round(message.parent);
     }
     if (message.locationType !== 0) {
       obj.locationType = locationTypeToJSON(message.locationType);
@@ -234,6 +263,7 @@ export const Stop: MessageFns<Stop> = {
   fromPartial<I extends Exact<DeepPartial<Stop>, I>>(object: I): Stop {
     const message = createBaseStop();
     message.name = object.name ?? "";
+    message.sourceStopId = object.sourceStopId ?? "";
     message.lat = object.lat ?? undefined;
     message.lon = object.lon ?? undefined;
     message.children = object.children?.map((e) => e) || [];
@@ -298,8 +328,8 @@ export const StopsMap: MessageFns<StopsMap> = {
     return {
       version: isSet(object.version) ? globalThis.String(object.version) : "",
       stops: isObject(object.stops)
-        ? Object.entries(object.stops).reduce<{ [key: string]: Stop }>((acc, [key, value]) => {
-          acc[key] = Stop.fromJSON(value);
+        ? Object.entries(object.stops).reduce<{ [key: number]: Stop }>((acc, [key, value]) => {
+          acc[globalThis.Number(key)] = Stop.fromJSON(value);
           return acc;
         }, {})
         : {},
@@ -329,9 +359,9 @@ export const StopsMap: MessageFns<StopsMap> = {
   fromPartial<I extends Exact<DeepPartial<StopsMap>, I>>(object: I): StopsMap {
     const message = createBaseStopsMap();
     message.version = object.version ?? "";
-    message.stops = Object.entries(object.stops ?? {}).reduce<{ [key: string]: Stop }>((acc, [key, value]) => {
+    message.stops = Object.entries(object.stops ?? {}).reduce<{ [key: number]: Stop }>((acc, [key, value]) => {
       if (value !== undefined) {
-        acc[key] = Stop.fromPartial(value);
+        acc[globalThis.Number(key)] = Stop.fromPartial(value);
       }
       return acc;
     }, {});
@@ -340,13 +370,13 @@ export const StopsMap: MessageFns<StopsMap> = {
 };
 
 function createBaseStopsMap_StopsEntry(): StopsMap_StopsEntry {
-  return { key: "", value: undefined };
+  return { key: 0, value: undefined };
 }
 
 export const StopsMap_StopsEntry: MessageFns<StopsMap_StopsEntry> = {
   encode(message: StopsMap_StopsEntry, writer: BinaryWriter = new BinaryWriter()): BinaryWriter {
-    if (message.key !== "") {
-      writer.uint32(10).string(message.key);
+    if (message.key !== 0) {
+      writer.uint32(8).uint32(message.key);
     }
     if (message.value !== undefined) {
       Stop.encode(message.value, writer.uint32(18).fork()).join();
@@ -362,11 +392,11 @@ export const StopsMap_StopsEntry: MessageFns<StopsMap_StopsEntry> = {
       const tag = reader.uint32();
       switch (tag >>> 3) {
         case 1: {
-          if (tag !== 10) {
+          if (tag !== 8) {
             break;
           }
 
-          message.key = reader.string();
+          message.key = reader.uint32();
           continue;
         }
         case 2: {
@@ -388,15 +418,15 @@ export const StopsMap_StopsEntry: MessageFns<StopsMap_StopsEntry> = {
 
   fromJSON(object: any): StopsMap_StopsEntry {
     return {
-      key: isSet(object.key) ? globalThis.String(object.key) : "",
+      key: isSet(object.key) ? globalThis.Number(object.key) : 0,
       value: isSet(object.value) ? Stop.fromJSON(object.value) : undefined,
     };
   },
 
   toJSON(message: StopsMap_StopsEntry): unknown {
     const obj: any = {};
-    if (message.key !== "") {
-      obj.key = message.key;
+    if (message.key !== 0) {
+      obj.key = Math.round(message.key);
     }
     if (message.value !== undefined) {
       obj.value = Stop.toJSON(message.value);
@@ -409,7 +439,7 @@ export const StopsMap_StopsEntry: MessageFns<StopsMap_StopsEntry> = {
   },
   fromPartial<I extends Exact<DeepPartial<StopsMap_StopsEntry>, I>>(object: I): StopsMap_StopsEntry {
     const message = createBaseStopsMap_StopsEntry();
-    message.key = object.key ?? "";
+    message.key = object.key ?? 0;
     message.value = (object.value !== undefined && object.value !== null) ? Stop.fromPartial(object.value) : undefined;
     return message;
   },

package/src/stops/stops.ts

@@ -1,4 +1,8 @@
-export type StopId = string;
+// A stop ID defined in the source of the transit data (e.g. GTFS)
+export type SourceStopId = string;
+// An internally indexed StopId
+export type StopId = number;
+
 export type Platform = string;
 export type Latitude = number;
 export type Longitude = number;
@@ -12,6 +16,7 @@ export type LocationType =
 
 export type Stop = {
   id: StopId;
+  sourceStopId: SourceStopId;
   name: string;
   lat?: Latitude;
   lon?: Longitude;
@@ -21,4 +26,11 @@ export type Stop = {
   platform?: Platform;
 };
 
+/**
+ * Mapping internal StopIds to Stop objects.
+ */
 export type StopsMap = Map<StopId, Stop>;
+/**
+ * Mapping source stopIds to internal stopIds;
+ */
+export type SourceStopsMap = Map<SourceStopId, StopId>;

package/src/stops/stopsIndex.ts

@@ -6,7 +6,13 @@ import { addAll, createIndex, search, SearchResult } from 'slimsearch';
 import { generateAccentVariants } from './i18n.js';
 import { deserializeStopsMap, serializeStopsMap } from './io.js';
 import { StopsMap as ProtoStopsMap } from './proto/stops.js';
-import { Stop, StopId, StopsMap } from './stops.js';
+import {
+  SourceStopId,
+  SourceStopsMap,
+  Stop,
+  StopId,
+  StopsMap,
+} from './stops.js';
 
 type StopPoint = { id: StopId; lat: number; lon: number };
 
@@ -17,19 +23,24 @@ type StopPoint = { id: StopId; lat: number; lon: number };
  */
 export class StopsIndex {
   private readonly stopsMap: StopsMap;
+  private readonly sourceStopsMap: SourceStopsMap;
   private readonly textIndex;
   private readonly geoIndex: KDTree;
   private readonly stopPoints: StopPoint[];
 
   constructor(stopsMap: StopsMap) {
     this.stopsMap = stopsMap;
+    this.sourceStopsMap = new Map<SourceStopId, StopId>();
+    for (const [id, stop] of stopsMap.entries()) {
+      this.sourceStopsMap.set(stop.sourceStopId, id);
+    }
     this.textIndex = createIndex({
       fields: ['name'],
       storeFields: ['id'],
       searchOptions: { prefix: true, fuzzy: 0.2 },
       processTerm: generateAccentVariants,
     });
-    const stopsSet = new Map<string, { id: StopId; name: string }>();
+    const stopsSet = new Map<StopId, { id: StopId; name: string }>();
     for (const [id, stop] of stopsMap.entries()) {
       const effectiveStopId = stop.parent ?? id;
       if (!stopsSet.has(effectiveStopId)) {
@@ -86,6 +97,15 @@ export class StopsIndex {
     return writer.finish();
   }
 
+  /**
+   * Returns the number of stops in the index.
+   *
+   * @returns The total number of stops.
+   */
+  size(): number {
+    return this.stopsMap.size;
+  }
+
   /**
    * Finds stops by their name using a text search.
    *
@@ -95,7 +115,7 @@ export class StopsIndex {
    */
   findStopsByName(query: string, maxResults = 5): Stop[] {
     const results = search(this.textIndex, query).map(
-      (result: SearchResult) => this.stopsMap.get(result.id as string) as Stop,
+      (result: SearchResult) => this.stopsMap.get(result.id as number) as Stop,
     );
     return results.slice(0, maxResults);
   }
@@ -129,16 +149,37 @@ export class StopsIndex {
   }
 
   /**
-   * Finds a stop by its ID.
+   * Finds a stop by its internal ID.
    *
-   * @param id - The ID of the stop to search for.
+   * @param id - The internal ID of the stop to search for.
    * @returns The Stop object that matches the specified ID, or undefined if not found.
    */
   findStopById(id: StopId): Stop | undefined {
     return this.stopsMap.get(id);
   }
 
-  equivalentStops(id: StopId): StopId[] {
+  /**
+   * Finds a stop by its ID in the transit data source (e.g. GTFS).
+   *
+   * @param id - The source ID of the stop to search for.
+   * @returns The Stop object that matches the specified ID, or undefined if not found.
+   */
+  findStopBySourceStopId(sourceStopId: SourceStopId): Stop | undefined {
+    const stopId = this.sourceStopsMap.get(sourceStopId);
+    if (stopId === undefined) {
+      return;
+    }
+    return this.findStopById(stopId);
+  }
+
+  /**
+   * Find ids of all sibling stops.
+   */
+  equivalentStops(sourceId: SourceStopId): Stop[] {
+    const id = this.sourceStopsMap.get(sourceId);
+    if (id === undefined) {
+      return [];
+    }
     const stop = this.stopsMap.get(id);
     if (!stop) {
       return [];
@@ -146,6 +187,8 @@ export class StopsIndex {
     const equivalentStops = stop.parent
       ? (this.stopsMap.get(stop.parent)?.children ?? [])
       : stop.children;
-    return Array.from(new Set([id, ...equivalentStops]));
+    return Array.from(new Set([id, ...equivalentStops])).map(
+      (stopId) => this.stopsMap.get(stopId) as Stop,
+    );
   }
 }

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

@@ -20,18 +20,18 @@ import {
 describe('timetable io', () => {
   const stopsAdjacency: StopsAdjacency = new Map([
     [
-      'stop1',
+      1,
       {
-        transfers: [{ destination: 'stop2', type: 'RECOMMENDED' }],
+        transfers: [{ destination: 2, type: 'RECOMMENDED' }],
         routes: ['route1'],
       },
     ],
     [
-      'stop2',
+      2,
       {
         transfers: [
           {
-            destination: 'stop1',
+            destination: 1,
             type: 'GUARANTEED',
             minTransferTime: Duration.fromMinutes(3),
           },
@@ -44,18 +44,15 @@ describe('timetable io', () => {
     [
       'route1',
       {
-        stopTimes: [
-          {
-            arrival: Time.fromSeconds(1000),
-            departure: Time.fromSeconds(1010),
-            pickUpType: 'REGULAR',
-            dropOffType: 'REGULAR',
-          },
-        ],
-        stops: ['stop1', 'stop2'],
+        stopTimes: new Uint32Array([
+          Time.fromHMS(0, 16, 40).toSeconds(),
+          Time.fromHMS(0, 16, 50).toSeconds(),
+        ]),
+        pickUpDropOffTypes: new Uint8Array([0, 0]), // REGULAR
+        stops: new Uint32Array([1, 2]),
         stopIndices: new Map([
-          ['stop1', 0],
-          ['stop2', 1],
+          [1, 0],
+          [2, 1],
         ]),
         serviceRouteId: 'gtfs1',
       },
@@ -63,18 +60,15 @@ describe('timetable io', () => {
     [
       'route2',
       {
-        stopTimes: [
-          {
-            arrival: Time.fromSeconds(2000),
-            departure: Time.fromSeconds(2010),
-            pickUpType: 'REGULAR',
-            dropOffType: 'REGULAR',
-          },
-        ],
-        stops: ['stop2', 'stop1'],
+        stopTimes: new Uint32Array([
+          Time.fromHMS(0, 33, 20).toSeconds(),
+          Time.fromHMS(0, 33, 30).toSeconds(),
+        ]),
+        pickUpDropOffTypes: new Uint8Array([0, 0]), // REGULAR
+        stops: new Uint32Array([2, 1]),
         stopIndices: new Map([
-          ['stop2', 0],
-          ['stop1', 1],
+          [2, 0],
+          [1, 1],
         ]),
         serviceRouteId: 'gtfs2',
       },
@@ -84,17 +78,16 @@ describe('timetable io', () => {
     ['gtfs1', { type: 'RAIL', name: 'Route 1' }],
     ['gtfs2', { type: 'RAIL', name: 'Route 2' }],
   ]);
-
   const stopsAdjacencyProto = {
     stops: {
-      stop1: {
-        transfers: [{ destination: 'stop2', type: 0 }],
+      '1': {
+        transfers: [{ destination: 2, type: 0 }],
         routes: ['route1'],
       },
-      stop2: {
+      '2': {
         transfers: [
           {
-            destination: 'stop1',
+            destination: 1,
             type: 1,
             minTransferTime: 180,
           },
@@ -107,27 +100,25 @@ describe('timetable io', () => {
   const routesAdjacencyProto = {
     routes: {
       route1: {
-        stopTimes: [
-          {
-            arrival: 1000,
-            departure: 1010,
-            pickUpType: undefined,
-            dropOffType: undefined,
-          },
-        ],
-        stops: ['stop1', 'stop2'],
+        stopTimes: new Uint8Array(
+          new Uint32Array([
+            Time.fromHMS(0, 16, 40).toSeconds(),
+            Time.fromHMS(0, 16, 50).toSeconds(),
+          ]).buffer,
+        ),
+        pickUpDropOffTypes: new Uint8Array([0, 0]), // REGULAR
+        stops: new Uint8Array(new Uint32Array([1, 2]).buffer),
         serviceRouteId: 'gtfs1',
       },
       route2: {
-        stopTimes: [
-          {
-            arrival: 2000,
-            departure: 2010,
-            pickUpType: undefined,
-            dropOffType: undefined,
-          },
-        ],
-        stops: ['stop2', 'stop1'],
+        stopTimes: new Uint8Array(
+          new Uint32Array([
+            Time.fromHMS(0, 33, 20).toSeconds(),
+            Time.fromHMS(0, 33, 30).toSeconds(),
+          ]).buffer,
+        ),
+        pickUpDropOffTypes: new Uint8Array([0, 0]), // REGULAR
+        stops: new Uint8Array(new Uint32Array([2, 1]).buffer),
         serviceRouteId: 'gtfs2',
       },
     },