gtfs 4.6.0 → 4.7.0

package/CHANGELOG.md

@@ -5,6 +5,16 @@ 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).
 
+## [4.7.0] - 2024-02-09
+
+### Added
+
+- Added `bounding_box_side_m` option to `getStops` and `getStopsAsGeoJSON` to find all stops within a bounding box.
+
+### Updated
+
+- Dependency updates
+
 ## [4.6.0] - 2024-01-17
 
 ### Changed

package/README.md

@@ -737,6 +737,24 @@ const stops = getStops({
 const stops = getStops({
   shape_id: 'cal_sf_tam',
 });
+
+/*
+ * `getStops` allows passing a `bounding_box_side_m` value in the options
+ * parameter object. If included, it will return all stops within a square
+ * bounding box around the `stop_lat` and `stop_lon` parameters passed to
+ * the query using the size in meters specified.
+ */
+const stops = getStops(
+  {
+    stop_lat: 37.58764,
+    stop_lon: -122.36265
+  },
+  [],
+  [],
+  {
+    bounding_box_side_m: 1000
+  }
+);
 ```
 
 #### getStopsAsGeoJSON(query, options)
@@ -753,6 +771,17 @@ const stopsGeojson = getStopsAsGeoJSON();
 const stopsGeojson = getStopsAsGeoJSON({
   route_id: 'Lo-16APR',
 });
+
+// Get all stops within a 1000m bounding box as geoJSON
+const stopsGeojson = getStopsAsGeoJSON(
+  {
+    stop_lat: 37.58764,
+    stop_lon: -122.36265
+  },
+  {
+    bounding_box_side_m: 1000
+  }
+);
 ```
 
 #### getStoptimes(query, fields, sortBy, options)

package/lib/gtfs/stops.js

@@ -7,6 +7,7 @@ import {
   formatOrderByClause,
   formatSelectClause,
   formatWhereClause,
+  formatWhereClauseBoundingBox,
   formatWhereClauses,
 } from '../utils.js';
 import { stopsToGeoJSON } from '../geojson-utils.js';
@@ -21,7 +22,7 @@ function buildTripSubquery(query) {
 
 function buildStoptimeSubquery(query) {
   return `SELECT DISTINCT stop_id FROM stop_times WHERE trip_id IN (${buildTripSubquery(
-    query
+    query,
   )})`;
 }
 
@@ -39,13 +40,21 @@ export function getStops(query = {}, fields = [], orderBy = [], options = {}) {
   let whereClause = '';
   const orderByClause = formatOrderByClause(orderBy);
 
-  const stopQuery = omit(query, [
+  const stopQueryOmitKeys = [
     'route_id',
     'trip_id',
     'service_id',
     'direction_id',
     'shape_id',
-  ]);
+  ];
+
+  // If bounding_box_side_m is defined, search for stops inside a bounding box so omit `stop_lat` and `stop_lon`.
+  if (options.bounding_box_side_m !== undefined) {
+    stopQueryOmitKeys.push('stop_lat', 'stop_lon');
+  }
+
+  let stopQuery = omit(query, stopQueryOmitKeys);
+
   const tripQuery = pick(query, [
     'route_id',
     'trip_id',
@@ -55,9 +64,23 @@ export function getStops(query = {}, fields = [], orderBy = [], options = {}) {
   ]);
 
   const whereClauses = Object.entries(stopQuery).map(([key, value]) =>
-    formatWhereClause(key, value)
+    formatWhereClause(key, value),
   );
 
+  if (
+    options.bounding_box_side_m !== undefined &&
+    query.stop_lat !== undefined &&
+    query.stop_lon !== undefined
+  ) {
+    whereClauses.push(
+      formatWhereClauseBoundingBox(
+        query.stop_lat,
+        query.stop_lon,
+        options.bounding_box_side_m,
+      ),
+    );
+  }
+
   if (Object.values(tripQuery).length > 0) {
     whereClauses.push(`stop_id IN (${buildStoptimeSubquery(tripQuery)})`);
   }
@@ -68,7 +91,7 @@ export function getStops(query = {}, fields = [], orderBy = [], options = {}) {
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }
@@ -96,7 +119,7 @@ export function getStopsAsGeoJSON(query = {}, options = {}) {
     const stopAttributes = getStopAttributes({ stop_id: stop.stop_id });
 
     stop.routes = orderBy(routes, (route) =>
-      Number.parseInt(route.route_short_name, 10)
+      Number.parseInt(route.route_short_name, 10),
     );
     stop.agency_name = agencies[0].agency_name;
 

package/lib/utils.js

@@ -12,7 +12,7 @@ export function validateConfigForImport(config) {
   for (const [index, agency] of config.agencies.entries()) {
     if (!agency.path && !agency.url) {
       throw new Error(
-        `No Agency \`url\` or \`path\` specified in config for agency index ${index}.`
+        `No Agency \`url\` or \`path\` specified in config for agency index ${index}.`,
       );
     }
   }
@@ -75,7 +75,7 @@ export function formatSelectClause(fields) {
 
   const selectItem = Object.entries(fields)
     .map(
-      (key) => `${sqlString.escapeId(key[0])} AS ${sqlString.escapeId(key[1])}`
+      (key) => `${sqlString.escapeId(key[0])} AS ${sqlString.escapeId(key[1])}`,
     )
     .join(', ');
   return `SELECT ${selectItem}`;
@@ -86,12 +86,48 @@ export function formatJoinClause(joinObject) {
     .map(
       (data) =>
         `${data.type ? data.type + ' JOIN' : 'INNER JOIN'} ${sqlString.escapeId(
-          data.table
-        )} ON ${data.on}`
+          data.table,
+        )} ON ${data.on}`,
     )
     .join(' ');
 }
 
+function degree2radian(angle) {
+  return (angle * Math.PI) / 180;
+}
+
+function radian2degree(angle) {
+  return (angle / Math.PI) * 180;
+}
+
+/*
+ * Search inside GPS coordinates boundary box
+ * Distance unit: meters
+ * */
+export function formatWhereClauseBoundingBox(
+  latitudeDegree,
+  longitudeDegree,
+  boundingBoxSideMeters,
+) {
+  const earthRadius = 6371000;
+  latitudeDegree = parseFloat(latitudeDegree);
+  longitudeDegree = parseFloat(longitudeDegree);
+
+  const latitudeRadian = degree2radian(latitudeDegree);
+  const radiusFromLatitude = Math.cos(latitudeRadian) * earthRadius;
+
+  // `boundingBoxSideMeters` is divided by 2 we are centering the coordinates in the middle of this square
+  const deltaLatitude = radian2degree(boundingBoxSideMeters / 2 / earthRadius);
+  const deltaLongitude = radian2degree(
+    boundingBoxSideMeters / 2 / radiusFromLatitude,
+  );
+
+  let query = `stop_lat BETWEEN ${latitudeDegree - deltaLatitude} AND ${latitudeDegree + deltaLatitude}`;
+  query += ` AND stop_lon BETWEEN ${longitudeDegree - deltaLongitude} AND ${longitudeDegree + deltaLongitude}`;
+
+  return query;
+}
+
 export function formatWhereClause(key, value) {
   if (Array.isArray(value)) {
     let whereClause = `${sqlString.escapeId(key)} IN (${value
@@ -119,7 +155,7 @@ export function formatWhereClauses(query) {
   }
 
   const whereClauses = Object.entries(query).map(([key, value]) =>
-    formatWhereClause(key, value)
+    formatWhereClause(key, value),
   );
   return `WHERE ${whereClauses.join(' AND ')}`;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs",
-  "version": "4.6.0",
+  "version": "4.7.0",
   "description": "Import GTFS transit data into SQLite and query routes, stops, times, fares and more",
   "keywords": [
     "transit",
@@ -58,7 +58,8 @@
     "Daniel Sörlöv",
     "Ali Zarghami <alizarghami@gmail.com>",
     "David Abell",
-    "Matthias Feist <matze@matf.de>"
+    "Matthias Feist <matze@matf.de>",
+    "Oliv4945"
   ],
   "type": "module",
   "main": "index.js",
@@ -73,7 +74,7 @@
   },
   "dependencies": {
     "@turf/helpers": "^6.5.0",
-    "better-sqlite3": "^9.3.0",
+    "better-sqlite3": "^9.4.0",
     "csv-parse": "^5.5.3",
     "csv-stringify": "^6.4.5",
     "gtfs-realtime-bindings": "^1.1.1",
@@ -94,10 +95,10 @@
     "yoctocolors": "^1.0.0"
   },
   "devDependencies": {
-    "husky": "^8.0.3",
-    "lint-staged": "^15.2.0",
-    "mocha": "^10.2.0",
-    "prettier": "^3.2.4",
+    "husky": "^9.0.10",
+    "lint-staged": "^15.2.2",
+    "mocha": "^10.3.0",
+    "prettier": "^3.2.5",
     "should": "^13.2.3"
   },
   "engines": {

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

@@ -64,4 +64,24 @@ describe('getStopsAsGeoJSON(): ', () => {
     should.exist(geojson.features[0].geometry.coordinates);
     geojson.features[0].geometry.coordinates.length.should.equal(2);
   });
+
+  it('should return geojson with specific stops for bounding box query', () => {
+    const distance = 100;
+    const stopLatitude = 37.709538;
+    const stopLongitude = -122.401586;
+
+    const geojson = getStopsAsGeoJSON(
+      {
+        stop_lat: stopLatitude,
+        stop_lon: stopLongitude,
+      },
+      { bounding_box_side_m: distance },
+    );
+
+    should.exist(geojson);
+    geojson.type.should.equal('FeatureCollection');
+    geojson.features.length.should.equal(2);
+    should.exist(geojson.features[0].geometry.coordinates);
+    geojson.features[0].geometry.coordinates.length.should.equal(2);
+  });
 });

package/test/mocha/get-stops.js

@@ -92,7 +92,7 @@ describe('getStops():', () => {
         route_id: routeId,
       },
       [],
-      [['stop_id', 'ASC']]
+      [['stop_id', 'ASC']],
     );
 
     const expectedStopIds = [
@@ -127,7 +127,7 @@ describe('getStops():', () => {
     for (const [idx, stop] of results.entries()) {
       expectedStopIds[idx].should.equal(
         stop.stop_id,
-        'The order of stops are expected to be the same'
+        'The order of stops are expected to be the same',
       );
     }
   });
@@ -142,7 +142,7 @@ describe('getStops():', () => {
         direction_id: directionId,
       },
       [],
-      [['stop_id', 'ASC']]
+      [['stop_id', 'ASC']],
     );
 
     const expectedStopIds = [
@@ -165,7 +165,7 @@ describe('getStops():', () => {
     for (const [idx, stop] of results.entries()) {
       expectedStopIds[idx].should.equal(
         stop.stop_id,
-        'The order of stops are expected to be the same'
+        'The order of stops are expected to be the same',
       );
     }
   });
@@ -178,7 +178,7 @@ describe('getStops():', () => {
         trip_id: tripId,
       },
       [],
-      [['stop_id', 'ASC']]
+      [['stop_id', 'ASC']],
     );
 
     const expectedStopIds = [
@@ -213,7 +213,7 @@ describe('getStops():', () => {
     for (const [idx, stop] of results.entries()) {
       expectedStopIds[idx].should.equal(
         stop.stop_id,
-        'The order of stops are expected to be the same'
+        'The order of stops are expected to be the same',
       );
     }
   });
@@ -226,7 +226,7 @@ describe('getStops():', () => {
         shape_id: shapeId,
       },
       [],
-      [['stop_id', 'ASC']]
+      [['stop_id', 'ASC']],
     );
 
     const expectedStopIds = [
@@ -262,8 +262,82 @@ describe('getStops():', () => {
     for (const [idx, stop] of results.entries()) {
       expectedStopIds[idx].should.equal(
         stop.stop_id,
-        'The order of stops are expected to be the same'
+        'The order of stops are expected to be the same',
       );
     }
   });
+
+  it('should return array of stops for bounding box query', () => {
+    const distance = 100;
+    const stopLatitude = 37.709538;
+    const stopLongitude = -122.401586;
+
+    const results = getStops(
+      {
+        stop_lat: stopLatitude,
+        stop_lon: stopLongitude,
+      },
+      [],
+      [],
+      { bounding_box_side_m: distance },
+    );
+
+    const expectedResult = [
+      {
+        stop_id: 'ctba',
+        stop_code: null,
+        stop_name: 'Bayshore Caltrain',
+        tts_stop_name: null,
+        stop_desc: null,
+        stop_lat: 37.709544,
+        stop_lon: -122.401318,
+        zone_id: null,
+        stop_url: 'http://www.caltrain.com/stations/bayshorestation.html',
+        location_type: 1,
+        parent_station: null,
+        stop_timezone: null,
+        wheelchair_boarding: 1,
+        level_id: null,
+        platform_code: null,
+      },
+      {
+        stop_id: '70032',
+        stop_code: '70032',
+        stop_name: 'Bayshore Caltrain',
+        tts_stop_name: null,
+        stop_desc: null,
+        stop_lat: 37.709544,
+        stop_lon: -122.40198,
+        zone_id: '1',
+        stop_url: 'http://www.caltrain.com/stations/bayshorestation.html',
+        location_type: 0,
+        parent_station: 'ctba',
+        stop_timezone: null,
+        wheelchair_boarding: 1,
+        level_id: null,
+        platform_code: 'SB',
+      },
+      {
+        stop_id: '70031',
+        stop_code: '70031',
+        stop_name: 'Bayshore Caltrain',
+        tts_stop_name: null,
+        stop_desc: null,
+        stop_lat: 37.709537,
+        stop_lon: -122.401586,
+        zone_id: '1',
+        stop_url: 'http://www.caltrain.com/stations/bayshorestation.html',
+        location_type: 0,
+        parent_station: 'ctba',
+        stop_timezone: null,
+        wheelchair_boarding: 1,
+        level_id: null,
+        platform_code: 'NB',
+      },
+    ];
+
+    should.exist(results);
+    results.length.should.equal(3);
+    results.should.match(expectedResult);
+  });
 });