Skip to content
Merged
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
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,9 @@ 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, Bay Wheels, Divvy, and Bluebikes:
Pace, Tri-Rail, Brightline, Denver RTD, Metro Transit, Pittsburgh Regional
Transit, MARTA, VIA, GCRTA, CATS, SacRT, MARC, UTA, JTA, 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 @@ -113,6 +115,12 @@ const metroNorthDepartures = await mta.metroNorth.departures({
stop: "Grand Central",
limit: 5,
});
const rtdRoutes = await mta.rtd.routes();
const divvyStations = await mta.divvy.stations({
lat: 41.88,
lon: -87.63,
limit: 5,
});
```

## Direct MTA Feeds
Expand Down
52 changes: 52 additions & 0 deletions index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -782,6 +782,35 @@ test("hosted regional rail methods use exact URLs", async () => {
expectRegionalBearerHeaders(requests);
});

test("hosted new commuter rail clients use exact URLs", async () => {
const { mta, requests } = createHostedTestClient();
const clients = [
[mta.rtd, "rtd"],
[mta.metroTransit, "metro-transit"],
[mta.prt, "prt"],
[mta.marta, "marta"],
[mta.via, "via"],
[mta.gcrta, "gcrta"],
[mta.cats, "cats"],
[mta.sacrt, "sacrt"],
[mta.marc, "marc"],
[mta.uta, "uta"],
[mta.jta, "jta"],
] as const;

for (const [client] of clients) {
await client.departures({ stop: "station", limit: 3 });
}

expect(requests.map((request) => request.url)).toEqual(
clients.map(
([, slug]) =>
`https://api.example.com/api/v1/${slug}/departures?stop=station&limit=3`,
),
);
expectRegionalBearerHeaders(requests);
});

test("hosted regional bike methods use exact URLs", async () => {
const { mta, requests } = createHostedTestClient();

Expand All @@ -795,6 +824,29 @@ test("hosted regional bike methods use exact URLs", async () => {
expectRegionalBearerHeaders(requests);
});

test("hosted new bike share clients use exact URLs", async () => {
const { mta, requests } = createHostedTestClient();
const clients = [
[mta.capitalBikeshare, "capital-bikeshare"],
[mta.biketown, "biketown"],
[mta.indego, "indego"],
[mta.metroBikeShare, "metro-bike-share"],
] as const;

for (const [client] of clients) {
await client.stations({ lat: 41.88, lon: -87.63, limit: 5 });
await client.station({ id: "X" });
}

expect(requests.map((request) => request.url)).toEqual(
clients.flatMap(([, slug]) => [
`https://api.example.com/api/v1/${slug}/stations?lat=41.88&lon=-87.63&limit=5`,
`https://api.example.com/api/v1/${slug}/stations/X`,
]),
);
expectRegionalBearerHeaders(requests);
});

test("regional bike share response types accept hosted systems", () => {
const station: CitiBikeStation = {
id: "sf123",
Expand Down
30 changes: 30 additions & 0 deletions index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ export class MTA {
readonly bayWheels: CitiBikeClient;
readonly divvy: CitiBikeClient;
readonly bluebikes: CitiBikeClient;
readonly capitalBikeshare: CitiBikeClient;
readonly biketown: CitiBikeClient;
readonly indego: CitiBikeClient;
readonly metroBikeShare: CitiBikeClient;
readonly lirr: CommuterRailClient;
readonly metroNorth: CommuterRailClient;
readonly mbta: CommuterRailClient;
Expand All @@ -93,6 +97,17 @@ export class MTA {
readonly pace: CommuterRailClient;
readonly triRail: CommuterRailClient;
readonly brightline: CommuterRailClient;
readonly rtd: CommuterRailClient;
readonly metroTransit: CommuterRailClient;
readonly prt: CommuterRailClient;
readonly marta: CommuterRailClient;
readonly via: CommuterRailClient;
readonly gcrta: CommuterRailClient;
readonly cats: CommuterRailClient;
readonly sacrt: CommuterRailClient;
readonly marc: CommuterRailClient;
readonly uta: CommuterRailClient;
readonly jta: CommuterRailClient;
readonly alerts: AlertsClient;
readonly stops: StopsClient;
readonly routes: RoutesClient;
Expand Down Expand Up @@ -134,6 +149,10 @@ export class MTA {
this.bayWheels = new CitiBikeClient(this, "/api/v1/bay-wheels");
this.divvy = new CitiBikeClient(this, "/api/v1/divvy");
this.bluebikes = new CitiBikeClient(this, "/api/v1/bluebikes");
this.capitalBikeshare = new CitiBikeClient(this, "/api/v1/capital-bikeshare");
this.biketown = new CitiBikeClient(this, "/api/v1/biketown");
this.indego = new CitiBikeClient(this, "/api/v1/indego");
this.metroBikeShare = new CitiBikeClient(this, "/api/v1/metro-bike-share");
this.lirr = new CommuterRailClient(this, "/api/v1/lirr");
this.metroNorth = new CommuterRailClient(this, "/api/v1/metro-north");
this.mbta = new CommuterRailClient(this, "/api/v1/mbta");
Expand All @@ -143,6 +162,17 @@ export class MTA {
this.pace = new CommuterRailClient(this, "/api/v1/pace");
this.triRail = new CommuterRailClient(this, "/api/v1/tri-rail");
this.brightline = new CommuterRailClient(this, "/api/v1/brightline");
this.rtd = new CommuterRailClient(this, "/api/v1/rtd");
this.metroTransit = new CommuterRailClient(this, "/api/v1/metro-transit");
this.prt = new CommuterRailClient(this, "/api/v1/prt");
this.marta = new CommuterRailClient(this, "/api/v1/marta");
this.via = new CommuterRailClient(this, "/api/v1/via");
this.gcrta = new CommuterRailClient(this, "/api/v1/gcrta");
this.cats = new CommuterRailClient(this, "/api/v1/cats");
this.sacrt = new CommuterRailClient(this, "/api/v1/sacrt");
this.marc = new CommuterRailClient(this, "/api/v1/marc");
this.uta = new CommuterRailClient(this, "/api/v1/uta");
this.jta = new CommuterRailClient(this, "/api/v1/jta");
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.5.0",
"version": "2.6.0",
"description": "A TypeScript client for MTA realtime feeds and the hosted MTA API.",
"license": "MIT",
"repository": {
Expand Down
53 changes: 48 additions & 5 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,18 @@ export type CommuterRailMode =
| "capmetro"
| "pace"
| "tri-rail"
| "brightline";
| "brightline"
| "rtd"
| "metro-transit"
| "prt"
| "marta"
| "via"
| "gcrta"
| "cats"
| "sacrt"
| "marc"
| "uta"
| "jta";
export type HostedArrivalDirection = "north" | "south" | "east" | "west" | "unknown" | "uptown" | "downtown";

export interface PathStation {
Expand Down Expand Up @@ -714,8 +725,24 @@ export interface CitiBikeStation {
isReturning: boolean;
lastReported?: string;
distanceMeters?: number;
mode: "citi-bike" | "bay-wheels" | "divvy" | "bluebikes";
source: "citi-bike-gbfs" | "bay-wheels-gbfs" | "divvy-gbfs" | "bluebikes-gbfs";
mode:
| "citi-bike"
| "bay-wheels"
| "divvy"
| "bluebikes"
| "capital-bikeshare"
| "biketown"
| "indego"
| "metro-bike-share";
source:
| "citi-bike-gbfs"
| "bay-wheels-gbfs"
| "divvy-gbfs"
| "bluebikes-gbfs"
| "capital-bikeshare-gbfs"
| "biketown-gbfs"
| "indego-gbfs"
| "metro-bike-share-gbfs";
}

export interface CitiBikeAlert {
Expand All @@ -728,8 +755,24 @@ export interface CitiBikeAlert {
url?: string;
times: { start?: string; end?: string }[];
lastUpdated?: string;
mode: "citi-bike" | "bay-wheels" | "divvy" | "bluebikes";
source: "citi-bike-gbfs" | "bay-wheels-gbfs" | "divvy-gbfs" | "bluebikes-gbfs";
mode:
| "citi-bike"
| "bay-wheels"
| "divvy"
| "bluebikes"
| "capital-bikeshare"
| "biketown"
| "indego"
| "metro-bike-share";
source:
| "citi-bike-gbfs"
| "bay-wheels-gbfs"
| "divvy-gbfs"
| "bluebikes-gbfs"
| "capital-bikeshare-gbfs"
| "biketown-gbfs"
| "indego-gbfs"
| "metro-bike-share-gbfs";
}

export interface CitiBikeStationsQuery {
Expand Down
Loading