${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;rClass McRaptorAlgorithm
Index
Constructors
Methods
Constructors
constructor
- new McRaptorAlgorithm(
    trips: Trip[],
    transfers: Record<StopID, Transfer[]>,
    interchange: Interchange,
): McRaptorAlgorithmInitializes the routing engine with transit data.
-Parameters
- trips: Trip[]
List of all transit trips.
- - transfers: Record<StopID, Transfer[]>
Graph of walking connections between stops.
- - interchange: Interchange
Minimum transfer times for each stop.
-
Returns McRaptorAlgorithm
- trips: Trip[]
Methods
get
- getOptimizedJourneys(
    origin: string,
    destination: string,
    departureTime: number,
): Journey[]Calculates optimal journeys for a specific departure time.
-Parameters
- origin: string
The starting Stop ID.
- - destination: string
The destination Stop ID.
- - departureTime: number
The exact departure time.
-
Returns Journey[]
A list of optimal Journey objects.
- - origin: string
get
- getOptimizedJourneysInRange(
    origin: string,
    destination: string,
    startTime: number,
    range: number,
): Journey[]Finds the best journeys within a time window, filtering for Pareto optimality across all departures.
-Parameters
- origin: string
The starting Stop ID.
- - destination: string
The destination Stop ID.
- - startTime: number
The start of the departure window.
- - range: number
The duration of the window to search (e.g. 3600s).
-
Returns Journey[]
A deduplicated list of the best journeys found in the time range.
- - origin: string
run
Executes the McRAPTOR algorithm to find all non-dominated paths to the destination.
-Parameters
- origin: string
The starting Stop ID.
- - destination: string
The destination Stop ID.
- - departureTime: number
The time of departure.
-
Returns Bag
A Bag containing Pareto-optimal labels for the destination.
-- origin: string
set
Sets the penalty multiplier for walking (default is 1).
-Parameters
- penalty: number
The multiplier for walking duration cost.
-
Returns void
- penalty: number
Class Bag
A container for Labels at a specific stop that maintains a Pareto frontier. -Only keeps labels that are not dominated by any other label in the bag.
-Index
Methods
add
Attempts to add a label to the bag.
-Parameters
- newLabel: Label
Returns boolean
True if the label was added (it was non-dominated), False otherwise.
-
is
Checks if the bag is empty.
-Returns boolean
merge
Merges another bag's labels into this one.
-Parameters
- otherBag: Bag
Returns boolean
True if the merge resulted in any changes to this bag.
-
Class Label
Represents a state or arrival at a specific stop in the routing graph. -Used to trace back the path and store performance metrics.
-Index
Constructors
Properties
Methods
Constructors
constructor
- new Label(
    arrivalTime: number,
    walkingDistance: number,
    transferCount: number,
    parent?: Label | null,
    trip?: Trip | null,
    transfer?: Transfer | null,
    stop?: string | null,
    enterTime?: number,
    stopIndex?: number,
): LabelParameters
- arrivalTime: number
Time of arrival at this stop.
- - walkingDistance: number
Cumulative walking distance in meters.
- - transferCount: number
Number of transfers taken so far.
- - parent: Label | null = null
The previous label in the chain (used for backtracking).
- - trip: Trip | null = null
The trip taken to reach this state (if applicable).
- - transfer: Transfer | null = null
The transfer used to reach this state (if applicable).
- - stop: string | null = null
The ID of the current stop.
- - enterTime: number = 0
Time when the passenger boarded the vehicle.
- - stopIndex: number = -1
Index of the current stop in the trip's sequence.
-
Returns Label
- arrivalTime: number
Properties
arrival
arrivalTime: number
Time of arrival at this stop.
-enter
enterTime: number = 0
Time when the passenger boarded the vehicle.
-parent
The previous label in the chain (used for backtracking).
-stop
stop: string | null = null
The ID of the current stop.
-stop
stopIndex: number = -1
Index of the current stop in the trip's sequence.
-transfer
The transfer used to reach this state (if applicable).
-transfer
transferCount: number
Number of transfers taken so far.
-trip
The trip taken to reach this state (if applicable).
-walking
walkingDistance: number
Cumulative walking distance in meters.
-
diff --git a/docs/functions/routes_api.activeRemindersForToken.html b/docs/functions/routes_api.activeRemindersForToken.html
deleted file mode 100644
index af2db27..0000000
--- a/docs/functions/routes_api.activeRemindersForToken.html
+++ /dev/null
@@ -1,3 +0,0 @@
-
diff --git a/docs/functions/routes_api.getAllPredictions.html b/docs/functions/routes_api.getAllPredictions.html
deleted file mode 100644
index 8b3990a..0000000
--- a/docs/functions/routes_api.getAllPredictions.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getAllRideRoutes.html b/docs/functions/routes_api.getAllRideRoutes.html
deleted file mode 100644
index 23cfae4..0000000
--- a/docs/functions/routes_api.getAllRideRoutes.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getAllRideStops.html b/docs/functions/routes_api.getAllRideStops.html
deleted file mode 100644
index ba9acd2..0000000
--- a/docs/functions/routes_api.getAllRideStops.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getAllRoutes.html b/docs/functions/routes_api.getAllRoutes.html
deleted file mode 100644
index f764bd9..0000000
--- a/docs/functions/routes_api.getAllRoutes.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getAllStops.html b/docs/functions/routes_api.getAllStops.html
deleted file mode 100644
index c997411..0000000
--- a/docs/functions/routes_api.getAllStops.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getBuildingLocations.html b/docs/functions/routes_api.getBuildingLocations.html
deleted file mode 100644
index bd10bd4..0000000
--- a/docs/functions/routes_api.getBuildingLocations.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getBusPositions.html b/docs/functions/routes_api.getBusPositions.html
deleted file mode 100644
index 4f304a7..0000000
--- a/docs/functions/routes_api.getBusPositions.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getBusPredictions.html b/docs/functions/routes_api.getBusPredictions.html
deleted file mode 100644
index 8e85c0b..0000000
--- a/docs/functions/routes_api.getBusPredictions.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getBusPredictionsLegacy.html b/docs/functions/routes_api.getBusPredictionsLegacy.html
deleted file mode 100644
index bb8f4b8..0000000
--- a/docs/functions/routes_api.getBusPredictionsLegacy.html
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/functions/routes_api.getFrontendData.html b/docs/functions/routes_api.getFrontendData.html
deleted file mode 100644
index cd99eab..0000000
--- a/docs/functions/routes_api.getFrontendData.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
Function getFrontendData
Returns aggregated data for the frontend, including route configs and metadata.
-Parameters
- req: Request
Express request
- - res: Response
Express response
-
Returns void
JSON object with
-routes(array of route details) andmetadata.- req: Request
diff --git a/docs/functions/routes_api.getNearestStops.html b/docs/functions/routes_api.getNearestStops.html
deleted file mode 100644
index e360e8b..0000000
--- a/docs/functions/routes_api.getNearestStops.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getRidePositions.html b/docs/functions/routes_api.getRidePositions.html
deleted file mode 100644
index 9c4abad..0000000
--- a/docs/functions/routes_api.getRidePositions.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getRidePredictions.html b/docs/functions/routes_api.getRidePredictions.html
deleted file mode 100644
index a91929a..0000000
--- a/docs/functions/routes_api.getRidePredictions.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getRideStopPredictions.html b/docs/functions/routes_api.getRideStopPredictions.html
deleted file mode 100644
index ca779c0..0000000
--- a/docs/functions/routes_api.getRideStopPredictions.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getRouteCache.html b/docs/functions/routes_api.getRouteCache.html
deleted file mode 100644
index 5e3222b..0000000
--- a/docs/functions/routes_api.getRouteCache.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getRouteColor.html b/docs/functions/routes_api.getRouteColor.html
deleted file mode 100644
index 2b49c96..0000000
--- a/docs/functions/routes_api.getRouteColor.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getRouteColors.html b/docs/functions/routes_api.getRouteColors.html
deleted file mode 100644
index 25a616d..0000000
--- a/docs/functions/routes_api.getRouteColors.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getRouteInfoVersion.html b/docs/functions/routes_api.getRouteInfoVersion.html
deleted file mode 100644
index 5623b6d..0000000
--- a/docs/functions/routes_api.getRouteInfoVersion.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getRouteInformation.html b/docs/functions/routes_api.getRouteInformation.html
deleted file mode 100644
index a583c28..0000000
--- a/docs/functions/routes_api.getRouteInformation.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
Function getRouteInformation
Returns static route metadata including names, images, and colors.
-Parameters
- req: Request
Express request
- - res: Response
Express response
-
Returns void
JSON object containing
-routeIdToName,routeImages,metadata, androuteColors.- req: Request
Function getSelectableRoutes
Returns a list of all selectable routes with their names and colors.
-Parameters
- req: Request
Express request
- - res: Response
Express response
-
Returns void
JSON object with a
-bustime-responsecontaining a list of routes.- req: Request
diff --git a/docs/functions/routes_api.getStartupMessages.html b/docs/functions/routes_api.getStartupMessages.html
deleted file mode 100644
index df88d25..0000000
--- a/docs/functions/routes_api.getStartupMessages.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getStopPredictions.html b/docs/functions/routes_api.getStopPredictions.html
deleted file mode 100644
index ff7f2ec..0000000
--- a/docs/functions/routes_api.getStopPredictions.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getVehicleImage.html b/docs/functions/routes_api.getVehicleImage.html
deleted file mode 100644
index d7d2c1c..0000000
--- a/docs/functions/routes_api.getVehicleImage.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.getVehiclePositions.html b/docs/functions/routes_api.getVehiclePositions.html
deleted file mode 100644
index bb3d311..0000000
--- a/docs/functions/routes_api.getVehiclePositions.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.modifyReminders.html b/docs/functions/routes_api.modifyReminders.html
deleted file mode 100644
index 7d03dcd..0000000
--- a/docs/functions/routes_api.modifyReminders.html
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/functions/routes_api.notifyMeLater.html b/docs/functions/routes_api.notifyMeLater.html
deleted file mode 100644
index 7035476..0000000
--- a/docs/functions/routes_api.notifyMeLater.html
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/functions/routes_api.planJourney.html b/docs/functions/routes_api.planJourney.html
deleted file mode 100644
index 73be18d..0000000
--- a/docs/functions/routes_api.planJourney.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.saveGraph.html b/docs/functions/routes_api.saveGraph.html
deleted file mode 100644
index 2dbfb87..0000000
--- a/docs/functions/routes_api.saveGraph.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/routes_api.setReminder.html b/docs/functions/routes_api.setReminder.html
deleted file mode 100644
index 0903168..0000000
--- a/docs/functions/routes_api.setReminder.html
+++ /dev/null
@@ -1,3 +0,0 @@
-
diff --git a/docs/functions/routes_api.swapToken.html b/docs/functions/routes_api.swapToken.html
deleted file mode 100644
index d624bfc..0000000
--- a/docs/functions/routes_api.swapToken.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
Function swapToken
Parameters
- req: Request
Express request,
-SwapTokenBodyin the body - res: Response
Express response, error message as string if error occurs
-Upon responding with 200, future calls to /setReminder, /unsetReminder, and /activeReminders -will need the new token
-
Returns void
- req: Request
diff --git a/docs/functions/services_graphBuilder.findNearestStops.html b/docs/functions/services_graphBuilder.findNearestStops.html
deleted file mode 100644
index 845e914..0000000
--- a/docs/functions/services_graphBuilder.findNearestStops.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Function findNearestStops
- findNearestStops(
    lat: number,
    lon: number,
    k?: number,
): {
    distance: number;
    lat: number;
    lon: number;
    name: string;
    stpid: string;
}[]Finds the nearest k stops to a given coordinate.
-Parameters
- lat: number
- lon: number
- k: number = 2
Returns { distance: number; lat: number; lon: number; name: string; stpid: string }[]
diff --git a/docs/functions/services_graphBuilder.rebuildGraph.html b/docs/functions/services_graphBuilder.rebuildGraph.html
deleted file mode 100644
index eef8bcb..0000000
--- a/docs/functions/services_graphBuilder.rebuildGraph.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/services_graphBuilder.saveGraphState.html b/docs/functions/services_graphBuilder.saveGraphState.html
deleted file mode 100644
index 36d84c0..0000000
--- a/docs/functions/services_graphBuilder.saveGraphState.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/services_graphBuilder.sortPreds.html b/docs/functions/services_graphBuilder.sortPreds.html
deleted file mode 100644
index d9e28f5..0000000
--- a/docs/functions/services_graphBuilder.sortPreds.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Function sortPreds
Sorts every prediction list contained in
-xby arrival timestampParameters
- x: Record<string, Prediction[]>
Returns void
diff --git a/docs/functions/services_journey.planJourney.html b/docs/functions/services_journey.planJourney.html
deleted file mode 100644
index c3c51ec..0000000
--- a/docs/functions/services_journey.planJourney.html
+++ /dev/null
@@ -1,8 +0,0 @@
-
Function planJourney
- planJourney(
    oLat: number,
    oLon: number,
    dLat: number,
    dLon: number,
    time: number,
    options: { range?: number; walkingPenalty?: number },
): Promise<
    (
        | {
            arrivalTime: number;
            criteria: {
                arrivalTime: number;
                transferCount: number;
                walkingDistance: number;
            };
            departureTime: number;
            legs: any[];
        }
        | null
    )[],
>Plans a journey between two coordinates using the McRaptor algorithm.
-Parameters
- oLat: number
Origin latitude
- - oLon: number
Origin longitude
- - dLat: number
Destination latitude
- - dLon: number
Destination longitude
- - time: number
Start time in seconds since midnight
- - options: { range?: number; walkingPenalty?: number }
Optional parameters for walking penalty and search range
-
Returns Promise<
    (
        | {
            arrivalTime: number;
            criteria: {
                arrivalTime: number;
                transferCount: number;
                walkingDistance: number;
            };
            departureTime: number;
            legs: any[];
        }
        | null
    )[],
> - oLat: number
diff --git a/docs/functions/services_mbus.fetchPredictions.html b/docs/functions/services_mbus.fetchPredictions.html
deleted file mode 100644
index b8b7d84..0000000
--- a/docs/functions/services_mbus.fetchPredictions.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/services_mbus.fetchRoutes.html b/docs/functions/services_mbus.fetchRoutes.html
deleted file mode 100644
index 3a62cea..0000000
--- a/docs/functions/services_mbus.fetchRoutes.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/services_metadata.getAllRouteConfig.html b/docs/functions/services_metadata.getAllRouteConfig.html
deleted file mode 100644
index 68c8d0c..0000000
--- a/docs/functions/services_metadata.getAllRouteConfig.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/services_metadata.getRouteColor.html b/docs/functions/services_metadata.getRouteColor.html
deleted file mode 100644
index 4a6765a..0000000
--- a/docs/functions/services_metadata.getRouteColor.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/services_metadata.getRouteImage.html b/docs/functions/services_metadata.getRouteImage.html
deleted file mode 100644
index 1bfc935..0000000
--- a/docs/functions/services_metadata.getRouteImage.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/services_reminder.eventsEqual.html b/docs/functions/services_reminder.eventsEqual.html
deleted file mode 100644
index 0f538f6..0000000
--- a/docs/functions/services_reminder.eventsEqual.html
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/functions/services_reminder.infoToUseForRoute.html b/docs/functions/services_reminder.infoToUseForRoute.html
deleted file mode 100644
index 6677cfb..0000000
--- a/docs/functions/services_reminder.infoToUseForRoute.html
+++ /dev/null
@@ -1 +0,0 @@
-
Function infoToUseForRoute
- infoToUseForRoute(
    rtid: string,
):
    | {
        predsByStopId: Record<string, Prediction[]>;
        predsByVid: Record<string, Prediction[]>;
        reminderSubscriptions: ReminderSubscriptions;
    }
    | nullParameters
- rtid: string
Returns
    | {
        predsByStopId: Record<string, Prediction[]>;
        predsByVid: Record<string, Prediction[]>;
        reminderSubscriptions: ReminderSubscriptions;
    }
    | null
diff --git a/docs/functions/services_reminderTypes.baseEvent.html b/docs/functions/services_reminderTypes.baseEvent.html
deleted file mode 100644
index ad93406..0000000
--- a/docs/functions/services_reminderTypes.baseEvent.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/services_reminderTypes.delayEvent.html b/docs/functions/services_reminderTypes.delayEvent.html
deleted file mode 100644
index 1207c39..0000000
--- a/docs/functions/services_reminderTypes.delayEvent.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Function delayEvent
- delayEvent(
    x: { currPred: number; prevPred: number; rtid: string; stpid: string },
): DelayEventfactory
-Parameters
- x: { currPred: number; prevPred: number; rtid: string; stpid: string }
Returns DelayEvent
diff --git a/docs/functions/services_reminderTypes.fromKey.html b/docs/functions/services_reminderTypes.fromKey.html
deleted file mode 100644
index 426b120..0000000
--- a/docs/functions/services_reminderTypes.fromKey.html
+++ /dev/null
@@ -1 +0,0 @@
-
Function registrationToken
Parameters
- x: string
Returns RegistrationToken
diff --git a/docs/functions/services_reminderTypes.thresholdEvent.html b/docs/functions/services_reminderTypes.thresholdEvent.html
deleted file mode 100644
index af4ff72..0000000
--- a/docs/functions/services_reminderTypes.thresholdEvent.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Function thresholdEvent
diff --git a/docs/functions/services_ride.fetchPatterns.html b/docs/functions/services_ride.fetchPatterns.html
deleted file mode 100644
index 6850074..0000000
--- a/docs/functions/services_ride.fetchPatterns.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/services_ride.fetchPredictions.html b/docs/functions/services_ride.fetchPredictions.html
deleted file mode 100644
index 32d4c42..0000000
--- a/docs/functions/services_ride.fetchPredictions.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/services_ride.fetchRoutes.html b/docs/functions/services_ride.fetchRoutes.html
deleted file mode 100644
index 21a65e6..0000000
--- a/docs/functions/services_ride.fetchRoutes.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/state_transitState.setCachedGraph.html b/docs/functions/state_transitState.setCachedGraph.html
deleted file mode 100644
index 63000ff..0000000
--- a/docs/functions/state_transitState.setCachedGraph.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Function setCachedGraph
- setCachedGraph(
    newGraph: {
        interchange: Interchange;
        transfers: TransfersByOrigin;
        trips: Trip[];
    },
): voidUpdates the cached graph.
-Parameters
- newGraph: { interchange: Interchange; transfers: TransfersByOrigin; trips: Trip[] }
Returns void
diff --git a/docs/functions/state_transitState.setCachedStopLocations.html b/docs/functions/state_transitState.setCachedStopLocations.html
deleted file mode 100644
index 9bbf317..0000000
--- a/docs/functions/state_transitState.setCachedStopLocations.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/walking_loadMap.haversine.html b/docs/functions/walking_loadMap.haversine.html
deleted file mode 100644
index 79efb48..0000000
--- a/docs/functions/walking_loadMap.haversine.html
+++ /dev/null
@@ -1,7 +0,0 @@
-
Function haversine
Calculates the great-circle distance between two points using the Haversine formula.
-Parameters
- aLat: number
Latitude of point A.
- - aLon: number
Longitude of point A.
- - bLat: number
Latitude of point B.
- - bLon: number
Longitude of point B.
-
Returns number
Distance in meters.
-- aLat: number
Function loadMap
Loads and parses the GraphML map file into a usable graph structure.
--
-
- Performs the following steps: -
-
-
- Reads the XML file. -
- Extracts Nodes (lat/lon). -
- Extracts Edges (filtering for walkable types like 'footway', 'path'). -
- Parses edge geometry (WKT) if available. -
- Prunes disconnected components, keeping only the largest connected subgraph. -
-
-
-
Returns { graph: Map<string, GraphMLEdge[]>; nodes: Map<string, GraphMLNode> }
An object containing the map of Nodes and the Adjacency List (graph).
-
Function buildStopNodeMap
Maps a list of bus stops to their nearest nodes on the street graph. -This optimizes future lookups by caching the StopID -> NodeID relationship.
-Parameters
- locations: Record<string, { lat: number; lon: number }>
A map of StopID to {lat, lon}.
-
Returns void
- locations: Record<string, { lat: number; lon: number }>
Function ensureCacheForStops
- ensureCacheForStops(
    stopIds: Set<string>,
    stopLocations: Record<string, { lat: number; lon: number }>,
): Promise<void>Ensures walking paths between all provided stops are calculated and cached. -Fetches missing paths in parallel and updates the disk cache.
-Parameters
- stopIds: Set<string>
Set of stop IDs to verify.
- - stopLocations: Record<string, { lat: number; lon: number }>
Map of Stop ID to coordinates.
-
Returns Promise<void>
- stopIds: Set<string>
Function getCachedWalk
Retrieves a cached walking path between two stops.
-Parameters
- originId: string
Origin Stop ID.
- - destId: string
Destination Stop ID.
-
Returns WalkingResponse | undefined
Cached walking data or undefined.
-- originId: string
Function getWalkingDistancesFrom
- getWalkingDistancesFrom(
    lat: number,
    lon: number,
    destLat?: number,
    destLon?: number,
): { duration: number; stopId: string }[]Optimized method to get walking distances from an origin to ALL known bus stops. -Optionally includes a direct walk to a specific destination point. -Uses a single Dijkstra pass with early termination and LRU Cache.
-Parameters
- lat: number
Origin latitude.
- - lon: number
Origin longitude.
- OptionaldestLat: number(Optional) Destination latitude for direct walk.
-OptionaldestLon: number(Optional) Destination longitude for direct walk.
-
Returns { duration: number; stopId: string }[]
- lat: number
Function getWalkingResponse
- getWalkingResponse(
    originLat: number,
    originLon: number,
    destLat: number,
    destLon: number,
): Promise<WalkingResponse>Calculates a detailed walking path between two coordinates using A*. -Includes path geometry for rendering.
-Parameters
- originLat: number
Latitude of origin.
- - originLon: number
Longitude of origin.
- - destLat: number
Latitude of destination.
- - destLon: number
Longitude of destination.
-
Returns Promise<WalkingResponse>
- originLat: number
diff --git a/docs/index.html b/docs/index.html
deleted file mode 100644
index e44630e..0000000
--- a/docs/index.html
+++ /dev/null
@@ -1,39 +0,0 @@
-
mbus-backend
- 
-
-
- Maizebus Backend
-
-
- 
- Backend service for the Magic Bus application. Handles real-time bus tracking, route management, and multi-modal journey planning (bus + walking) using the McRaptor algorithm. -
-Setup
First, obtain an API key for the Magic Bus backend from the official Magic Bus Website.
-Then, define the MBUS_API_KEY environment variable with your API key.
To install dependencies, run npm i
(WIP) Firebase (Push Notifications) Setup
Create a Firebase project if you haven't already, and set FIREBASE_PROJECT_ID to its id. Follow the steps
-here to create a service
-account key file. Place this file into secrets/ and point GOOGLE_APPLICATION_CREDENTIALS to it.
-(you can do this temporarily with export GOOGLE_APPLICATION_CREDENTIALS="./secrets/your-filename.json")
Some additional resources for iOS here. Make -sure that the firebase project is configured with the same app id as xcode.
-Running the Backend
To run the backend, run npm start.
By default, the service runs on port 3000. To define a port for the service to run on, define an environment variable called PORT before running the backend.
Documentation
This project uses TSDoc for code documentation. -To compile the static documentation:
-npm run docs
-The documentation is served at http://localhost:3000/docs or this link.
Tests
This project uses Vitest for fast unit and integration testing.
--
-
- Run all tests:
npm test
- - Run stress tests:
npm run stress-test
-
An example of passing the tests is below.
-
-Contributing
Before submitting a pull request to main, please make sure you pass all the tests and can compile docs. If you believe some of the tests faulty or no longer needed after your commit, please contact Andrew Yu or Ryan Lu on Slack.
-Interface Journey
Represents a complete transit journey consisting of multiple legs.
-interface Journey {
    criteria: {
        arrivalTime: number;
        transferCount: number;
        walkingDistance: number;
    };
    legs: JourneyLeg[];
}
    criteria: {
        arrivalTime: number;
        transferCount: number;
        walkingDistance: number;
    };
    legs: JourneyLeg[];
}
Interface JourneyLeg
Represents a single segment of a journey, either a transit trip or a walking transfer.
-interface JourneyLeg {
    destination: string;
    destinationID: string;
    duration: number;
    endTime: number;
    origin: string;
    originID: string;
    rt?: string;
    startTime: number;
    stopTimes?: StopTime[];
    transfer?: Transfer;
    trip?: Trip;
    type: "Trip" | "Transfer";
}
    destination: string;
    destinationID: string;
    duration: number;
    endTime: number;
    origin: string;
    originID: string;
    rt?: string;
    startTime: number;
    stopTimes?: StopTime[];
    transfer?: Transfer;
    trip?: Trip;
    type: "Trip" | "Transfer";
}
Index
Properties
destination
-destination
Interface Leg
Abstract representation of a connection between two stops.
-Hierarchy (View Summary)
Index
Properties
Interface StopTime
Represents a scheduled stop event within a trip (GTFS StopTime).
-interface StopTime {
    arrivalTime: number;
    departureTime: number;
    dropOff: boolean;
    heursticCost?: number;
    isExtrapolated?: boolean;
    pickUp: boolean;
    rt?: string;
    stop: string;
}
    arrivalTime: number;
    departureTime: number;
    dropOff: boolean;
    heursticCost?: number;
    isExtrapolated?: boolean;
    pickUp: boolean;
    rt?: string;
    stop: string;
}
Index
Properties
Properties
arrival
arrivalTime: number
departure
departureTime: number
drop
dropOff: boolean
Whether passengers can alight from the vehicle here.
-Optionalheurstic
heursticCost?: number
Optional pre-calculated cost for routing heuristics.
-Optionalis
isExtrapolated?: boolean
If the stop is predicted or not.
-pick
pickUp: boolean
Whether passengers can board the vehicle here.
-Optionalrt
rt?: string
Real-time status string (if available).
-stop
stop: string
The ID of the stop.
-Interface TimetableLeg
A specific segment of a scheduled trip with fixed times.
-interface TimetableLeg {
    destination: string;
    origin: string;
    stopTimes: StopTime[];
    trip: Trip;
}
    destination: string;
    origin: string;
    stopTimes: StopTime[];
    trip: Trip;
}
Hierarchy (View Summary)
- Leg
- TimetableLeg
Index
Properties
Interface Transfer
A walking connection between two stops with a defined duration.
-interface Transfer {
    destination: string;
    duration: number;
    endTime: number;
    origin: string;
    startTime: number;
}
    destination: string;
    duration: number;
    endTime: number;
    origin: string;
    startTime: number;
}
Hierarchy (View Summary)
- Leg
- Transfer
Index
Properties
diff --git a/docs/interfaces/walking_walkingMap.BatchWalkingResult.html b/docs/interfaces/walking_walkingMap.BatchWalkingResult.html
deleted file mode 100644
index 7995faa..0000000
--- a/docs/interfaces/walking_walkingMap.BatchWalkingResult.html
+++ /dev/null
@@ -1,8 +0,0 @@
-
Interface BatchWalkingResult
Result of a batch query from a single origin node to multiple destinations.
-interface BatchWalkingResult {
    distanceToNode: number;
    nearestNodeId: string;
    nodeDistances: Map<string, number>;
}
    distanceToNode: number;
    nearestNodeId: string;
    nodeDistances: Map<string, number>;
}
Index
Properties
Properties
distance
distanceToNode: number
The straight-line distance from the origin coordinates to the street node.
-nearest
nearestNodeId: string
The ID of the street node closest to the origin coordinates.
-node
nodeDistances: Map<string, number>
A map of NodeID -> Distance (in meters) for all reachable nodes.
-Interface WalkingResponse
Standard response for a single point-to-point walking query.
-interface WalkingResponse {
    distance: number;
    duration: number;
    path_coords: { lat: number; lon: number }[];
}
    distance: number;
    duration: number;
    path_coords: { lat: number; lon: number }[];
}
Index
Properties
diff --git a/docs/modules/app.html b/docs/modules/app.html
deleted file mode 100644
index baf826b..0000000
--- a/docs/modules/app.html
+++ /dev/null
@@ -1 +0,0 @@
-
Module app
Module jobs
Functions
diff --git a/docs/modules/raptor_McStructs.html b/docs/modules/raptor_McStructs.html
deleted file mode 100644
index 77efccd..0000000
--- a/docs/modules/raptor_McStructs.html
+++ /dev/null
@@ -1 +0,0 @@
-
Module raptor/types
Interfaces
Module routes/api
Variables
Functions
- activeRemindersForToken
- getAllPredictions
- getAllRideRoutes
- getAllRideStops
- getAllRoutes
- getAllStops
- getBuildingLocations
- getBusPositions
- getBusPredictions
- getBusPredictionsLegacy
- getFrontendData
- getKeyStops
- getNearestStops
- getRidePositions
- getRidePredictions
- getRideStopPredictions
- getRouteCache
- getRouteColor
- getRouteColors
- getRouteInformation
- getRouteInfoVersion
- getSelectableRoutes
- getStartupInfo
- getStartupMessages
- getStopPredictions
- getVehicleImage
- getVehiclePositions
- modifyReminders
- notifyMeLater
- planJourney
- saveGraph
- setReminder
- swapToken
- unsetReminder
Module services/graphBuilder
Module services/journey
Functions
Module services/mbus
diff --git a/docs/modules/services_reminder.html b/docs/modules/services_reminder.html
deleted file mode 100644
index e60ffda..0000000
--- a/docs/modules/services_reminder.html
+++ /dev/null
@@ -1 +0,0 @@
-
Module services/reminder
Type Aliases
References
- baseEvent → baseEvent
- BaseEvent → BaseEvent
- delayEvent → delayEvent
- DelayEvent → DelayEvent
- fromKey → fromKey
- Key → Key
- registrationToken → registrationToken
- RegistrationToken → RegistrationToken
- sameBaseEvent → sameBaseEvent
- thresholdEvent → thresholdEvent
- ThresholdEvent → ThresholdEvent
- toKey → toKey
Module services/reminderTypes
Module services/ride
Module state/transitState
Type Aliases
Variables
Module types
Type Aliases
Module walking/types
Type Aliases
Module walking/walkingMap
Interfaces
Type Alias Criteria
Defines the optimization metrics used to compare different journey options.
-type Criteria = {
    arrivalTime: number;
    transferCount: number;
    walkingDistance: number;
}
    arrivalTime: number;
    transferCount: number;
    walkingDistance: number;
}
Index
Properties
Type Alias Duration
Duration: number
A span of time measured in seconds.
-
diff --git a/docs/types/raptor_types.StopID.html b/docs/types/raptor_types.StopID.html
deleted file mode 100644
index eec8b94..0000000
--- a/docs/types/raptor_types.StopID.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Type Alias StopID
StopID: string
Unique identifier for a transit stop (e.g., "NRW").
-Type Alias Time
Time: number
Time represented as seconds since midnight. -Values may exceed 86400 (24 hours) for trips extending into the next day.
-
diff --git a/docs/types/raptor_types.TripID.html b/docs/types/raptor_types.TripID.html
deleted file mode 100644
index ae31e00..0000000
--- a/docs/types/raptor_types.TripID.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Type Alias TripID
TripID: string
Unique identifier for a GTFS trip.
-Type Alias PostThreshold
Waiting for the bus indicated by vid to be at the stop indicated by stpid. Logic for what notification to send
-is complicated by arrival times sometimes skipping DUE, see ReminderSubscriptons.process for details.
type PostThreshold = {
    event: BaseEvent;
    stage: 1;
    vid: string;
    vidPredPrev: number | null;
}
    event: BaseEvent;
    stage: 1;
    vid: string;
    vidPredPrev: number | null;
}
Index
Properties
Type Alias PreThreshold
Waiting for a prediction of the right event to have a arrival timestamp that is at or after mustBeAfter and an
-arrival time less than thresh. A bus is xx minutes from the stop notification is then sent. To handle delayed and
-disappeared notifications, a candidateVid is set to the soonest arriving bus that arrives after mustbeAfter.
type PreThreshold = {
    candidateVid: string | null;
    candidateVidPredPrev: number | null;
    event: BaseEvent;
    mustBeAfter: number;
    stage: 0;
    thresh: number;
}
    candidateVid: string | null;
    candidateVidPredPrev: number | null;
    event: BaseEvent;
    mustBeAfter: number;
    stage: 0;
    thresh: number;
}
Index
Properties
Properties
candidate
candidateVid: string | null
stores the bus that'll likely trigger the threshold notification, being only a candidate this can change -as things are updated and such a change won't trigger a disappeared notification
-candidate
candidateVidPredPrev: number | null
minutes
-event
must
mustBeAfter: number
unix epoch milliseconds
-stage
stage: 0
thresh
thresh: number
minutes
-Type Alias BaseEvent
BaseEvent: CoreEvent & { __brand: "event" }
Type Alias DelayEvent
DelayEvent: CoreEvent & {
    __brand: "delayEvent";
    currPred: number;
    prevPred: number;
}
    __brand: "delayEvent";
    currPred: number;
    prevPred: number;
}
diff --git a/docs/types/services_reminderTypes.RegistrationToken.html b/docs/types/services_reminderTypes.RegistrationToken.html
deleted file mode 100644
index a46cd40..0000000
--- a/docs/types/services_reminderTypes.RegistrationToken.html
+++ /dev/null
@@ -1 +0,0 @@
-
Type Alias RegistrationToken
RegistrationToken: string & { __brand: "registrationToken" }
Type Alias ThresholdEvent
ThresholdEvent: CoreEvent & { __brand: "thresholdEvent"; threshold: number }
Type Alias Prediction
Prediction: {
    prdctdn: string;
    prdtm: number;
    rt: string;
    stpid: string;
    vid: string;
} & Record<string, any>
    prdctdn: string;
    prdtm: number;
    rt: string;
    stpid: string;
    vid: string;
} & Record<string, any>
Represents a bus prediction.
-
diff --git a/docs/types/walking_types.GraphMLNode.html b/docs/types/walking_types.GraphMLNode.html
deleted file mode 100644
index f225f2c..0000000
--- a/docs/types/walking_types.GraphMLNode.html
+++ /dev/null
@@ -1,8 +0,0 @@
-
Type Alias GraphMLNode
Represents a node in the street graph derived from GraphML.
-
diff --git a/docs/variables/routes_api.default.html b/docs/variables/routes_api.default.html
deleted file mode 100644
index b90e1b3..0000000
--- a/docs/variables/routes_api.default.html
+++ /dev/null
@@ -1,3 +0,0 @@
-
Variable defaultConst
default: Router = ...
Express router for the MBus API v3. -Handles routes for static data, state debugging, journey planning, and startup info.
-Variable staticDataConst
staticData: any = metadata
Raw static metadata from JSON.
-Variable rideReminderSubscriptionsConst
rideReminderSubscriptions: ReminderSubscriptions = ...
diff --git a/docs/variables/services_reminder.universityReminderSubscriptions.html b/docs/variables/services_reminder.universityReminderSubscriptions.html
deleted file mode 100644
index b19565d..0000000
--- a/docs/variables/services_reminder.universityReminderSubscriptions.html
+++ /dev/null
@@ -1 +0,0 @@
-
Variable universityReminderSubscriptionsConst
universityReminderSubscriptions: ReminderSubscriptions = ...
Variable cachedGraph
cachedGraph: {
    interchange: Interchange;
    transfers: TransfersByOrigin;
    trips: Trip[];
} = ...
    interchange: Interchange;
    transfers: TransfersByOrigin;
    trips: Trip[];
} = ...
The current transit graph used for routing.
-Type Declaration
interchange: Interchange
transfers: TransfersByOrigin
trips: Trip[]
Variable cachedPredsByStopIdConst
Predictions indexed by stop ID.
-Variable cachedPredsByVidConst
Predictions indexed by vehicle ID.
-Variable cachedRidePredsByStopIdConst
Predictions indexed by ride stop ID.
-Variable cachedRidePredsByVidConst
Predictions indexed by ride vehicle ID.
-Variable cachedRideRoutesConst
cachedRideRoutes: Record<string, any> = {}
Cache of route patterns and static data for the ride.
-Variable cachedRideStopLocations
cachedRideStopLocations: Record<
    string,
    { lat: number; lon: number; name: string },
> = {}
    string,
    { lat: number; lon: number; name: string },
> = {}
Variable cachedRoutesConst
cachedRoutes: Record<string, any> = {}
Cache of route patterns and static data.
-Variable cachedStopLocations
cachedStopLocations: Record<string, { lat: number; lon: number; name: string }> = {}
Cache of stop locations (lat/lon).
-Variable curBusPositionsConst
curBusPositions: { buses: any[] } = ...
Current positions of all buses.
-Type Declaration
buses: any[]
Variable curRidePositionsConst
curRidePositions: { buses: any[] } = ...
Current positions of all ride buses.
-Type Declaration
buses: any[]
Variable rideStopIdToNameConst
rideStopIdToName: Record<string, string> = {}
Map of ride stop IDs to their human-readable names.
-Variable routeTimingCacheConst
routeTimingCache: Record<
    string,
    Record<
        string,
        Record<string, { diff: number; rtdir: string; rtNext: string }>,
    >,
> = ...
    string,
    Record<
        string,
        Record<string, { diff: number; rtdir: string; rtNext: string }>,
    >,
> = ...
Cache of timing differences between stops for extrapolation.
-Variable stopIdToNameConst
stopIdToName: Record<string, string> = {}
Map of stop IDs to their human-readable names.
-Variable tatripidToRtConst
tatripidToRt: Record<string, string> = {}
Map of trip IDs to route names.
-Variable validRideRoutesConst
validRideRoutes: Set<string> = ...
Set of currently valid ride route IDs.
-Variable validRoutesConst
validRoutes: Set<string> = ...
Set of currently valid route IDs.
-
Implementation of the McRAPTOR (Multi-Criteria Round-Based Public Transit Routing) algorithm. -Optimizes for arrival time, walking distance, and number of transfers.
-