gtfs 4.10.4 → 4.11.0

package/CHANGELOG.md

@@ -5,6 +5,20 @@ 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.11.0] - 2024-06-01
+
+### Added
+
+- Support for [GTFS Flex](https://mobilitydata.org/🎉-gtfs-flex-is-officially-adopted-everything-you-need-to-know/)
+- Support for [booking_rules.txt](https://gtfs.org/schedule/reference/#booking_rulestxt)
+- Support for [location_groups.txt](https://gtfs.org/schedule/reference/#location_groupstxt)
+- Support for [location_group_stops.txt](https://gtfs.org/schedule/reference/#location_group_stopstxt)
+- Add `rule_priority` field to `fare_leg_rules.txt`
+
+### Updated
+
+- Dependency updates
+
 ## [4.10.4] - 2024-05-14
 
 ### Updated

package/README.md

@@ -166,7 +166,7 @@ Copy `config-sample.json` to `config.json` and then add your projects configurat
 | --------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [`agencies`](#agencies)                 | array             | An array of GTFS files to be imported, and which files to exclude.                                                                                                  |
 | [`csvOptions`](#csvOptions)             | object            | Options passed to `csv-parse` for parsing GTFS CSV files. Optional.                                                                                                 |
-| [`db`](#db)                             | database instance | An existing database instance to use instead of relying on node-gtfs to connect. Optional.                                                                         |
+| [`db`](#db)                             | database instance | An existing database instance to use instead of relying on node-gtfs to connect. Optional.                                                                          |
 | [`downloadTimeout`](#downloadtimeout)   | integer           | The number of milliseconds to wait before throwing an error when downloading GTFS. Optional.                                                                        |
 | [`exportPath`](#exportPath)             | string            | A path to a directory to put exported GTFS files. Optional, defaults to `gtfs-export/<agency_name>`.                                                                |
 | [`ignoreDuplicates`](#ignoreduplicates) | boolean           | Whether or not to ignore unique constraints on ids when importing GTFS, such as `trip_id`, `calendar_id`. Optional, defaults to false.                              |
@@ -668,7 +668,7 @@ const routes = getRoutes(
   {}, // No query filters
   ['route_id', 'route_short_name', 'route_color'], // Only return these fields
   [['route_short_name', 'ASC']], // Sort by this field and direction
-  { db: db } // Options for the query. Can specify which database to use if more than one are open
+  { db: db }, // Options for the query. Can specify which database to use if more than one are open
 );
 
 closeDb(db);
@@ -690,7 +690,7 @@ const trips = getTrips(
   {
     route_id: '123',
   },
-  ['trip_id']
+  ['trip_id'],
 );
 
 closeDb(db);
@@ -770,6 +770,22 @@ const attributions = getAttributions({
 });
 ```
 
+#### getBookingRules(query, fields, sortBy, options)
+
+Returns an array of booking rules that match query parameters. [Details on booking_rules.txt](https://gtfs.org/schedule/reference/#booking_rulestxt)
+
+```js
+import { getBookingRules } from 'gtfs';
+
+// Get all booking rules
+const bookingRules = getBookingRules();
+
+// Get a specific booking rule
+const bookingRules = getBookingRules({
+  booking_rule_id: '1234',
+});
+```
+
 #### getRoutes(query, fields, sortBy, options)
 
 Returns an array of routes that match query parameters. [Details on routes.txt](https://gtfs.org/schedule/reference/#routestxt)
@@ -794,7 +810,7 @@ const routes = getRoutes(
     stop_id: '70011',
   },
   [],
-  [['stop_name', 'ASC']]
+  [['stop_name', 'ASC']],
 );
 ```
 
@@ -846,7 +862,7 @@ const stops = getStops({
 const stops = getStops(
   {
     stop_lat: 37.58764,
-    stop_lon: -122.36265
+    stop_lon: -122.36265,
   },
   [],
   [],
@@ -875,11 +891,11 @@ const stopsGeojson = getStopsAsGeoJSON({
 const stopsGeojson = getStopsAsGeoJSON(
   {
     stop_lat: 37.58764,
-    stop_lon: -122.36265
+    stop_lon: -122.36265,
   },
   {
-    bounding_box_side_m: 1000
-  }
+    bounding_box_side_m: 1000,
+  },
 );
 ```
 
@@ -904,7 +920,7 @@ const stoptimes = getStoptimes(
     trip_id: '37a',
   },
   [],
-  [['stop_sequence', 'ASC']]
+  [['stop_sequence', 'ASC']],
 );
 
 // Get all stoptimes for a specific stop and service_id
@@ -1176,6 +1192,38 @@ import { getLevels } from 'gtfs';
 const levels = getLevels();
 ```
 
+#### getLocationGroups(query, fields, sortBy, options)
+
+Returns an array of location groups that match query parameters. [Details on location_groups.txt](https://gtfs.org/schedule/reference/#location_groupstxt)
+
+```js
+import { getLocationGroups } from 'gtfs';
+
+// Get all location groups
+const locationGroups = getLocationGroups();
+
+// Get a specific location group
+const locationGroups = getLocationGroups({
+  location_group_id: '1234',
+});
+```
+
+#### getLocationGroupStops(query, fields, sortBy, options)
+
+Returns an array of location group stops that match query parameters. [Details on location_group_stops.txt](https://gtfs.org/schedule/reference/#location_group_stopstxt)
+
+```js
+import { getLocationGroupStops } from 'gtfs';
+
+// Get all location group stops
+const locationGroupStops = getLocationGroupStops();
+
+// Get location group stops for a specific stop_id
+const locationGroups = getLocationGroupStops({
+  stop_id: '1234',
+});
+```
+
 #### getPathways(query, fields, sortBy, options)
 
 Returns an array of pathways that match query parameters. [Details on pathways.txt](https://gtfs.org/schedule/reference/#pathwaystxt)

package/lib/advancedQuery.js

@@ -30,7 +30,7 @@ export function advancedQuery(table, advancedQueryOptions) {
   const orderByClause = formatOrderByClause(queryOptions.orderBy);
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${joinClause} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${joinClause} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/geojson-utils.js

@@ -42,7 +42,7 @@ function consolidateShapes(shapes) {
       }
 
       return memo;
-    }, [])
+    }, []),
   );
 
   const consolidatedLineStrings = [];
@@ -90,7 +90,7 @@ function formatProperties(properties) {
 
   if (properties.routes) {
     formattedProperties.routes = properties.routes.map((route) =>
-      formatProperties(route)
+      formatProperties(route),
     );
   }
 
@@ -99,7 +99,7 @@ function formatProperties(properties) {
 
 export function shapesToGeoJSONFeatures(shapes, properties = {}) {
   const shapeGroups = Object.values(groupBy(shapes, 'shape_id')).map(
-    (shapeGroup) => sortBy(shapeGroup, 'shape_pt_sequence')
+    (shapeGroup) => sortBy(shapeGroup, 'shape_pt_sequence'),
   );
   const lineStrings = consolidateShapes(shapeGroups);
 
@@ -109,8 +109,8 @@ export function shapesToGeoJSONFeatures(shapes, properties = {}) {
         type: 'LineString',
         coordinates: lineString,
       },
-      formatProperties(properties)
-    )
+      formatProperties(properties),
+    ),
   );
 }
 
@@ -121,8 +121,8 @@ export function stopsToGeoJSON(stops) {
         type: 'Point',
         coordinates: [stop.stop_lon, stop.stop_lat],
       },
-      formatProperties(omit(stop, ['stop_lat', 'stop_lon']))
-    )
+      formatProperties(omit(stop, ['stop_lat', 'stop_lon'])),
+    ),
   );
 
   return featureCollection(features);

package/lib/gtfs/agencies.js

@@ -16,7 +16,7 @@ export function getAgencies(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(agency.filenameBase);
@@ -26,7 +26,7 @@ export function getAgencies(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/areas.js

@@ -21,7 +21,7 @@ export function getAreas(query = {}, fields = [], orderBy = [], options = {}) {
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/attributions.js

@@ -16,7 +16,7 @@ export function getAttributions(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(attributions.filenameBase);
@@ -26,7 +26,7 @@ export function getAttributions(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/booking-rules.js

@@ -0,0 +1,32 @@
+import sqlString from 'sqlstring-sqlite';
+
+import { openDb } from '../db.js';
+
+import {
+  formatOrderByClause,
+  formatSelectClause,
+  formatWhereClauses,
+} from '../utils.js';
+import bookingRules from '../../models/gtfs/booking-rules.js';
+
+/*
+ * Returns an array of all booking rules that match the query parameters.
+ */
+export function getBookingRules(
+  query = {},
+  fields = [],
+  orderBy = [],
+  options = {},
+) {
+  const db = options.db ?? openDb();
+  const tableName = sqlString.escapeId(bookingRules.filenameBase);
+  const selectClause = formatSelectClause(fields);
+  const whereClause = formatWhereClauses(query);
+  const orderByClause = formatOrderByClause(orderBy);
+
+  return db
+    .prepare(
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
+    )
+    .all();
+}

package/lib/gtfs/calendar-dates.js

@@ -16,7 +16,7 @@ export function getCalendarDates(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(calendarDates.filenameBase);
@@ -26,7 +26,7 @@ export function getCalendarDates(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/calendars.js

@@ -16,7 +16,7 @@ export function getCalendars(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(calendars.filenameBase);
@@ -26,7 +26,7 @@ export function getCalendars(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/fare-attributes.js

@@ -16,7 +16,7 @@ export function getFareAttributes(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(fareAttributes.filenameBase);
@@ -26,7 +26,7 @@ export function getFareAttributes(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/fare-leg-rules.js

@@ -16,7 +16,7 @@ export function getFareLegRules(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(fareLegRules.filenameBase);
@@ -26,7 +26,7 @@ export function getFareLegRules(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/fare-products.js

@@ -16,7 +16,7 @@ export function getFareProducts(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(fareProducts.filenameBase);
@@ -26,7 +26,7 @@ export function getFareProducts(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/fare-rules.js

@@ -16,7 +16,7 @@ export function getFareRules(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(fareRules.filenameBase);
@@ -26,7 +26,7 @@ export function getFareRules(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/fare-transfer-rules.js

@@ -16,7 +16,7 @@ export function getFareTransferRules(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(fareTransferRules.filenameBase);
@@ -26,7 +26,7 @@ export function getFareTransferRules(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/feed-info.js

@@ -16,7 +16,7 @@ export function getFeedInfo(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(feedInfo.filenameBase);
@@ -26,7 +26,7 @@ export function getFeedInfo(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/frequencies.js

@@ -16,7 +16,7 @@ export function getFrequencies(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(frequencies.filenameBase);
@@ -26,7 +26,7 @@ export function getFrequencies(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/levels.js

@@ -21,7 +21,7 @@ export function getLevels(query = {}, fields = [], orderBy = [], options = {}) {
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/location-group-stops.js

@@ -0,0 +1,32 @@
+import sqlString from 'sqlstring-sqlite';
+
+import { openDb } from '../db.js';
+
+import {
+  formatOrderByClause,
+  formatSelectClause,
+  formatWhereClauses,
+} from '../utils.js';
+import locationGroupStops from '../../models/gtfs/location-group-stops.js';
+
+/*
+ * Returns an array of all location group stops that match the query parameters.
+ */
+export function getLocationGroupStops(
+  query = {},
+  fields = [],
+  orderBy = [],
+  options = {},
+) {
+  const db = options.db ?? openDb();
+  const tableName = sqlString.escapeId(locationGroupStops.filenameBase);
+  const selectClause = formatSelectClause(fields);
+  const whereClause = formatWhereClauses(query);
+  const orderByClause = formatOrderByClause(orderBy);
+
+  return db
+    .prepare(
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
+    )
+    .all();
+}

package/lib/gtfs/location-groups.js

@@ -0,0 +1,32 @@
+import sqlString from 'sqlstring-sqlite';
+
+import { openDb } from '../db.js';
+
+import {
+  formatOrderByClause,
+  formatSelectClause,
+  formatWhereClauses,
+} from '../utils.js';
+import locationGroups from '../../models/gtfs/location-groups.js';
+
+/*
+ * Returns an array of all location groups that match the query parameters.
+ */
+export function getLocationGroups(
+  query = {},
+  fields = [],
+  orderBy = [],
+  options = {},
+) {
+  const db = options.db ?? openDb();
+  const tableName = sqlString.escapeId(locationGroups.filenameBase);
+  const selectClause = formatSelectClause(fields);
+  const whereClause = formatWhereClauses(query);
+  const orderByClause = formatOrderByClause(orderBy);
+
+  return db
+    .prepare(
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
+    )
+    .all();
+}

package/lib/gtfs/pathways.js

@@ -16,7 +16,7 @@ export function getPathways(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(pathways.filenameBase);
@@ -26,7 +26,7 @@ export function getPathways(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/routes.js

@@ -18,7 +18,7 @@ function buildStoptimeSubquery(query) {
 
 function buildTripSubquery(query) {
   return `SELECT DISTINCT route_id FROM trips WHERE trip_id IN (${buildStoptimeSubquery(
-    query
+    query,
   )})`;
 }
 
@@ -37,7 +37,7 @@ export function getRoutes(query = {}, fields = [], orderBy = [], options = {}) {
   const stoptimeQuery = pick(query, ['stop_id']);
 
   const whereClauses = Object.entries(routeQuery).map(([key, value]) =>
-    formatWhereClause(key, value)
+    formatWhereClause(key, value),
   );
 
   if (Object.values(stoptimeQuery).length > 0) {
@@ -50,7 +50,7 @@ export function getRoutes(query = {}, fields = [], orderBy = [], options = {}) {
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/shapes.js

@@ -48,7 +48,7 @@ export function getShapes(query = {}, fields = [], orderBy = [], options = {}) {
   ]);
 
   const whereClauses = Object.entries(shapeQuery).map(([key, value]) =>
-    formatWhereClause(key, value)
+    formatWhereClause(key, value),
   );
 
   if (Object.values(tripQuery).length > 0) {
@@ -61,7 +61,7 @@ export function getShapes(query = {}, fields = [], orderBy = [], options = {}) {
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }
@@ -93,17 +93,17 @@ export function getShapesAsGeoJSON(query = {}, options = {}) {
       shapeQuery,
       ['shape_id', 'shape_pt_sequence', 'shape_pt_lon', 'shape_pt_lat'],
       [],
-      options
+      options,
     );
     const routeAttributes = getRouteAttributes(
       { route_id: route.route_id },
       [],
       [],
-      options
+      options,
     );
 
     const agency = agencies.find(
-      (agency) => agency.agency_id === route.agency_id
+      (agency) => agency.agency_id === route.agency_id,
     );
 
     const geojsonProperties = {

package/lib/gtfs/stop-areas.js

@@ -16,7 +16,7 @@ export function getStopAreas(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(stopAreas.filenameBase);
@@ -26,7 +26,7 @@ export function getStopAreas(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/stop-times.js

@@ -16,7 +16,7 @@ export function getStoptimes(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(stopTimes.filenameBase);
@@ -26,7 +26,7 @@ export function getStoptimes(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }

package/lib/gtfs/transfers.js

@@ -16,7 +16,7 @@ export function getTransfers(
   query = {},
   fields = [],
   orderBy = [],
-  options = {}
+  options = {},
 ) {
   const db = options.db ?? openDb();
   const tableName = sqlString.escapeId(transfers.filenameBase);
@@ -26,7 +26,7 @@ export function getTransfers(
 
   return db
     .prepare(
-      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`,
     )
     .all();
 }