From 5b862debf2ecc968326352da1b4308bf50502400 Mon Sep 17 00:00:00 2001 From: Gary <12258850+gtokman@users.noreply.github.com> Date: Sat, 14 Nov 2026 06:18:47 -0800 Subject: [PATCH] feat: add keyed transit agency clients Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> --- README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++--- index.test.ts | 20 ++++++++++++++++ index.ts | 16 +++++++++++++ package.json | 2 +- src/types.ts | 10 +++++++- 5 files changed, 106 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8a98436..cbcd09a 100644 --- a/README.md +++ b/README.md @@ -98,9 +98,10 @@ deployments. The hosted API also provides regional methods for PATH, NJ Transit Rail, NYC Ferry, Citi Bike, LIRR, Metro-North, MBTA, BART, King County Metro, CapMetro, Pace, Tri-Rail, Brightline, Denver RTD, Metro Transit, Pittsburgh Regional -Transit, MARTA, VIA, GCRTA, CATS, SacRT, MARC, UTA, JTA, Muni, Caltrain, Bay -Wheels, Divvy, Bluebikes, Capital Bikeshare, Biketown, Indego, and Metro Bike -Share: +Transit, MARTA, VIA, GCRTA, CATS, SacRT, MARC, UTA, JTA, Muni, Caltrain, +WMATA Metrorail, WMATA Metrobus, Sound Transit, Houston METRO, San Diego MTS, +Metra, TriMet, Metrolink, Bay Wheels, Divvy, Bluebikes, Capital Bikeshare, +Biketown, Indego, and Metro Bike Share: ```js const pathArrivals = await mta.path.arrivals({ station: "JSQ", direction: "to-ny" }); @@ -122,6 +123,14 @@ const caltrainDepartures = await mta.caltrain.departures({ stop: "San Francisco Caltrain Station", limit: 5, }); +const metrorailRoutes = await mta.wmataRail.routes(); +const metrobusRoutes = await mta.wmataBus.routes(); +const soundTransitRoutes = await mta.soundTransit.routes(); +const houstonMetroRoutes = await mta.houstonMetro.routes(); +const mtsRoutes = await mta.sdmts.routes(); +const metraRoutes = await mta.metra.routes(); +const trimetRoutes = await mta.trimet.routes(); +const metrolinkRoutes = await mta.metrolink.routes(); const divvyStations = await mta.divvy.stations({ lat: 41.88, lon: -87.63, @@ -268,6 +277,54 @@ override them. - `mta.brightline.departures(...)` - `mta.brightline.vehicles(...)` - `mta.brightline.alerts()` +- `mta.wmataRail.stops(...)` +- `mta.wmataRail.routes()` +- `mta.wmataRail.routeStops(...)` +- `mta.wmataRail.departures(...)` +- `mta.wmataRail.vehicles(...)` +- `mta.wmataRail.alerts()` +- `mta.wmataBus.stops(...)` +- `mta.wmataBus.routes()` +- `mta.wmataBus.routeStops(...)` +- `mta.wmataBus.departures(...)` +- `mta.wmataBus.vehicles(...)` +- `mta.wmataBus.alerts()` +- `mta.soundTransit.stops(...)` +- `mta.soundTransit.routes()` +- `mta.soundTransit.routeStops(...)` +- `mta.soundTransit.departures(...)` +- `mta.soundTransit.vehicles(...)` +- `mta.soundTransit.alerts()` +- `mta.houstonMetro.stops(...)` +- `mta.houstonMetro.routes()` +- `mta.houstonMetro.routeStops(...)` +- `mta.houstonMetro.departures(...)` +- `mta.houstonMetro.vehicles(...)` +- `mta.houstonMetro.alerts()` +- `mta.sdmts.stops(...)` +- `mta.sdmts.routes()` +- `mta.sdmts.routeStops(...)` +- `mta.sdmts.departures(...)` +- `mta.sdmts.vehicles(...)` +- `mta.sdmts.alerts()` +- `mta.metra.stops(...)` +- `mta.metra.routes()` +- `mta.metra.routeStops(...)` +- `mta.metra.departures(...)` +- `mta.metra.vehicles(...)` +- `mta.metra.alerts()` +- `mta.trimet.stops(...)` +- `mta.trimet.routes()` +- `mta.trimet.routeStops(...)` +- `mta.trimet.departures(...)` +- `mta.trimet.vehicles(...)` +- `mta.trimet.alerts()` +- `mta.metrolink.stops(...)` +- `mta.metrolink.routes()` +- `mta.metrolink.routeStops(...)` +- `mta.metrolink.departures(...)` +- `mta.metrolink.vehicles(...)` +- `mta.metrolink.alerts()` - `mta.bayWheels.stations(...)` - `mta.bayWheels.station(...)` - `mta.bayWheels.alerts()` diff --git a/index.test.ts b/index.test.ts index a082fc5..f3e5fd6 100644 --- a/index.test.ts +++ b/index.test.ts @@ -912,3 +912,23 @@ test("parseGtfsZip parses static GTFS csv files into a seed", () => { stopTimes: [{ trip_id: "L-trip", stop_id: "L08" }], }); }); + +test("constructs hosted clients for the newly added transit systems", async () => { + const { mta, requests } = createHostedTestClient(); + const clients = [ + [mta.wmataRail, "wmata-rail"], + [mta.wmataBus, "wmata-bus"], + [mta.soundTransit, "sound-transit"], + [mta.houstonMetro, "houston-metro"], + [mta.sdmts, "sdmts"], + [mta.metra, "metra"], + [mta.trimet, "trimet"], + [mta.metrolink, "metrolink"], + ] as const; + + for (const [client, slug] of clients) await client.stops(); + + expect(requests.map((request) => new URL(request.url).pathname)).toEqual( + clients.map(([, slug]) => `/api/v1/${slug}/stops`), + ); +}); diff --git a/index.ts b/index.ts index 556a68a..8600033 100644 --- a/index.ts +++ b/index.ts @@ -110,6 +110,14 @@ export class MTA { readonly jta: CommuterRailClient; readonly muni: CommuterRailClient; readonly caltrain: CommuterRailClient; + readonly wmataRail: CommuterRailClient; + readonly wmataBus: CommuterRailClient; + readonly soundTransit: CommuterRailClient; + readonly houstonMetro: CommuterRailClient; + readonly sdmts: CommuterRailClient; + readonly metra: CommuterRailClient; + readonly trimet: CommuterRailClient; + readonly metrolink: CommuterRailClient; readonly alerts: AlertsClient; readonly stops: StopsClient; readonly routes: RoutesClient; @@ -177,6 +185,14 @@ export class MTA { this.jta = new CommuterRailClient(this, "/api/v1/jta"); this.muni = new CommuterRailClient(this, "/api/v1/muni"); this.caltrain = new CommuterRailClient(this, "/api/v1/caltrain"); + this.wmataRail = new CommuterRailClient(this, "/api/v1/wmata-rail"); + this.wmataBus = new CommuterRailClient(this, "/api/v1/wmata-bus"); + this.soundTransit = new CommuterRailClient(this, "/api/v1/sound-transit"); + this.houstonMetro = new CommuterRailClient(this, "/api/v1/houston-metro"); + this.sdmts = new CommuterRailClient(this, "/api/v1/sdmts"); + this.metra = new CommuterRailClient(this, "/api/v1/metra"); + this.trimet = new CommuterRailClient(this, "/api/v1/trimet"); + this.metrolink = new CommuterRailClient(this, "/api/v1/metrolink"); this.alerts = new AlertsClient(this); this.stops = new StopsClient(this); this.routes = new RoutesClient(this); diff --git a/package.json b/package.json index 95d64db..a1a95c9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mta-js", - "version": "2.7.0", + "version": "2.8.0", "description": "A TypeScript client for MTA realtime feeds and the hosted MTA API.", "license": "MIT", "repository": { diff --git a/src/types.ts b/src/types.ts index 1b42763..6d7158e 100644 --- a/src/types.ts +++ b/src/types.ts @@ -393,7 +393,15 @@ export type CommuterRailMode = | "uta" | "jta" | "muni" - | "caltrain"; + | "caltrain" + | "wmata-rail" + | "wmata-bus" + | "sound-transit" + | "houston-metro" + | "sdmts" + | "metra" + | "trimet" + | "metrolink"; export type HostedArrivalDirection = "north" | "south" | "east" | "west" | "unknown" | "uptown" | "downtown"; export interface PathStation {