Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 60 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" });
Expand All @@ -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,
Expand Down Expand Up @@ -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()`
Expand Down
20 changes: 20 additions & 0 deletions index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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`),
);
});
16 changes: 16 additions & 0 deletions index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
10 changes: 9 additions & 1 deletion src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Loading