gtfs 3.3.0 → 3.3.1

package/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.3.1] - 2022-04-29
+
+### Added
+
+- Add support for querying by shape_id
+
 ## [3.3.0] - 2022-04-26
 
 ### Changed

package/README.md

@@ -569,7 +569,7 @@ getStops({
 `getStops` allows passing a `route_id` in the query and it will query trips and stoptimes to find all stops served by that `route_id`.
 
 ```js
-import { getRoutes } from 'gtfs';
+import { getStops } from 'gtfs';
 
 // Get all stops for a specific route
 getStops({
@@ -580,7 +580,7 @@ getStops({
 `getStops` allows passing a `trip_id` in the query and it will query stoptimes to find all stops on that `trip_id`.
 
 ```js
-import { getRoutes } from 'gtfs';
+import { getStops } from 'gtfs';
 
 // Get all stops for a specific trip
 getStops({
@@ -588,6 +588,17 @@ getStops({
 });
 ```
 
+`getStops` allows passing a `shape_id` in the query and it will query trips and stoptimes to find all stops that use that `shape_id`.
+
+```js
+import { getStops } from 'gtfs';
+
+// Get all stops for a specific trip
+getStops({
+  shape_id: 'cal_sf_tam',
+});
+```
+
 ### getStopsAsGeoJSON(query)
 
 Queries stops and returns a promise. The result of the promise is an geoJSON object of stops. All valid queries for `getStops()` work for `getStopsAsGeoJSON()`.
@@ -718,23 +729,28 @@ Returns geoJSON of shapes.
 ```js
 import { getShapesAsGeoJSON } from 'gtfs';
 
-// Get geoJSON of all stops in an agency
+// Get geoJSON of all routes in an agency
 getShapesAsGeoJSON();
 
-// Get geoJSON of stops along a specific route
+// Get geoJSON of shapes for a specific route
 getShapesAsGeoJSON({
   route_id: 'Lo-16APR',
 });
 
-// Get geoJSON of stops for a specific trip
+// Get geoJSON of shapes for a specific trip
 getShapesAsGeoJSON({
   trip_id: '37a',
 });
 
-// Get geoJSON of stops for a specific `service_id`
+// Get geoJSON of shapes for a specific `service_id`
 getShapesAsGeoJSON({
   service_id: 'CT-16APR-Caltrain-Sunday-02',
 });
+
+// Get geoJSON of shapes for a specific `shape_id`
+getShapesAsGeoJSON({
+  shape_id: 'cal_sf_tam',
+});
 ```
 
 ### getCalendars(query, fields, sortBy)

package/lib/gtfs/shapes.js

@@ -101,11 +101,12 @@ export async function getShapesAsGeoJSON(query = {}, options = {}) {
         (agency) => agency.agency_id === route.agency_id
       );
 
-      const routeProperties = {
+      const geojsonProperties = {
         agency_name: agency ? agency.agency_name : undefined,
+        shape_id: query.shape_id,
         ...route,
       };
-      features.push(...shapesToGeoJSONFeatures(shapes, routeProperties));
+      features.push(...shapesToGeoJSONFeatures(shapes, geojsonProperties));
     })
   );
 

package/lib/gtfs/stops.js

@@ -47,12 +47,14 @@ export async function getStops(
     'trip_id',
     'service_id',
     'direction_id',
+    'shape_id',
   ]);
   const tripQuery = pick(query, [
     'route_id',
     'trip_id',
     'service_id',
     'direction_id',
+    'shape_id',
   ]);
 
   const whereClauses = Object.entries(stopQuery).map(([key, value]) =>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "description": "Import GTFS transit data into SQLite and query routes, stops, times, fares and more",
   "keywords": [
     "transit",

package/test/mocha/get-shapes-as-geojson.js

@@ -75,4 +75,19 @@ describe('getShapesAsGeoJSON():', () => {
     geojson.features[0].geometry.coordinates[0].length.should.equal(2);
     geojson.features[0].properties.route_color.should.startWith('#');
   });
+
+  it('should return geojson with shapes for a specific shapeId', async () => {
+    const shapeId = 'cal_sf_tam';
+
+    const geojson = await getShapesAsGeoJSON({
+      shape_id: shapeId,
+    });
+
+    should.exist(geojson);
+    geojson.type.should.equal('FeatureCollection');
+    geojson.features.length.should.equal(3);
+    should.exist(geojson.features[0].geometry.coordinates);
+    geojson.features[0].geometry.coordinates[0].length.should.equal(2);
+    geojson.features[0].properties.route_color.should.startWith('#');
+  });
 });

package/test/mocha/get-shapes.js

@@ -209,4 +209,32 @@ describe('getShapes():', () => {
     results.length.should.equal(713);
     results.should.containEql(expectedResult);
   });
+
+  it('should return array of shapes for specific shape_id', async () => {
+    const shapeId = 'cal_sf_tam';
+    const results = await getShapes(
+      {
+        shape_id: shapeId,
+      },
+      [
+        'shape_id',
+        'shape_pt_lat',
+        'shape_pt_lon',
+        'shape_pt_sequence',
+        'shape_dist_traveled',
+      ]
+    );
+
+    const expectedResult = {
+      shape_id: 'cal_sf_tam',
+      shape_pt_lat: 37.682971245836484,
+      shape_pt_lon: -122.39507675170898,
+      shape_pt_sequence: 88,
+      shape_dist_traveled: null,
+    };
+
+    should.exist(results);
+    results.length.should.equal(401);
+    results.should.containEql(expectedResult);
+  });
 });

package/test/mocha/get-stops-as-geojson.js

@@ -56,4 +56,18 @@ describe('getStopsAsGeoJSON(): ', () => {
     should.exist(geojson.features[0].geometry.coordinates);
     geojson.features[0].geometry.coordinates.length.should.equal(2);
   });
+
+  it('should return geojson with stops if they exist for a specific shapeId', async () => {
+    const shapeId = 'cal_sf_tam';
+
+    const geojson = await getStopsAsGeoJSON({
+      shape_id: shapeId,
+    });
+
+    should.exist(geojson);
+    geojson.type.should.equal('FeatureCollection');
+    geojson.features.length.should.equal(25);
+    should.exist(geojson.features[0].geometry.coordinates);
+    geojson.features[0].geometry.coordinates.length.should.equal(2);
+  });
 });

package/test/mocha/get-stops.js

@@ -217,4 +217,53 @@ describe('getStops():', () => {
       );
     }
   });
+
+  it('should return array of stops if it exists for a specific shape_id', async () => {
+    const shapeId = 'cal_sf_tam';
+
+    const results = await getStops(
+      {
+        shape_id: shapeId,
+      },
+      [],
+      [['stop_id', 'ASC']]
+    );
+
+    const expectedStopIds = [
+      '70012',
+      '70021',
+      '70022',
+      '70032',
+      '70042',
+      '70052',
+      '70062',
+      '70082',
+      '70092',
+      '70102',
+      '70112',
+      '70122',
+      '70132',
+      '70142',
+      '70162',
+      '70172',
+      '70192',
+      '70202',
+      '70212',
+      '70222',
+      '70232',
+      '70242',
+      '70252',
+      '70262',
+      '70272',
+    ];
+
+    should.exist(results);
+    results.length.should.equal(25);
+    for (const [idx, stop] of results.entries()) {
+      expectedStopIds[idx].should.equal(
+        stop.stop_id,
+        'The order of stops are expected to be the same'
+      );
+    }
+  });
 });