gtfs 4.0.2 → 4.1.0

package/CHANGELOG.md

@@ -5,6 +5,26 @@ 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.1.0] - 2023-02-25
+
+### Added
+
+- Support for Operational Data Standard (ODS) Files
+
+### Updated
+
+- Dependency updates
+
+## [4.0.3] - 2023-02-04
+
+### Changed
+
+- Updates to sqlite journal mode
+
+### Updated
+
+- Dependency updates
+
 ## [4.0.2] - 2023-01-15
 
 ### Changed

package/README.md

@@ -11,7 +11,7 @@
   <br /><br />
   <a href="https://www.npmjs.com/package/gtfs" rel="nofollow"><img src="https://img.shields.io/npm/v/gtfs.svg?style=flat" style="max-width: 100%;"></a>
   <a href="https://www.npmjs.com/package/gtfs" rel="nofollow"><img src="https://img.shields.io/npm/dm/gtfs.svg?style=flat" style="max-width: 100%;"></a>
-  <a href="https://github.com/BlinkTagInc/node-gtfs/actions?query=workflow%3A%22Node+CI%22"><img src="https://img.shields.io/github/workflow/status/BlinkTagInc/node-gtfs/Node%20CI.svg" alt="CircleCI" style="max-width: 100%;"></a>
+  <a href="https://github.com/BlinkTagInc/node-gtfs/actions?query=workflow%3A%22Node+CI%22"><img src="https://img.shields.io/github/actions/workflow/status/BlinkTagInc/node-gtfs/nodejs.yml?branch=master" style="max-width: 100%;"></a>
   <img src="https://img.shields.io/badge/License-MIT-yellow.svg">
   <br /><br />
   Import and Export GTFS transit data into SQLite. Query or change routes, stops, times, fares and more.
@@ -493,15 +493,29 @@ await exportGtfs(config);
 
 ## Query Methods
 
-This library includes many methods you can use in your project to query GTFS data.
+This library includes many methods you can use in your project to query GTFS data. In addition to standard static GTFS, `node-gtfs` supports the following extensions to GTFS:
 
-Most methods accept three optional arguments: `query`, `fields`, `sortBy` and `options`.
+- [GTFS-Realtime](https://gtfs.org/realtime/) - Realtime alerts, vehicle positions and predictions
+- [GTFS-Ride](https://gtfsride.org) - Passenger counts
+- [Operational Data Standard (ODS)](https://docs.calitp.org/operational-data-standard/) - Deadheads and personnel info
+- [GTFS-Timetables](https://gtfstohtml.com) - Information for creating human-readable timetables
 
-For more advanced queries, you can use `advancedQuery` or any query method from [better-sqlite3](#raw-sqlite-query).
+There are also methods for retrieving stops and shapes in geoJSON format.
 
-You need to run `openDb(config)` before using any query methods.
+Most query methods accept three optional arguments: `query`, `fields`, `sortBy` and `options`.
 
-#### Query
+For more advanced queries, you can use `advancedQuery` or raw SQL queries using query method from [better-sqlite3](#raw-sqlite-query).
+
+### Setup
+
+To use any of the query methods, first open the database before making any queries:
+
+```js
+import { openDb } from 'gtfs';
+const db = openDb(config);
+```
+
+### Examples
 
 For example, to get a list of all routes with just `route_id`, `route_short_name` and `route_color` sorted by `route_short_name`:
 
@@ -558,21 +572,9 @@ const stops = getStops(
 );
 ```
 
-### Setup
-
-Include this library.
-
-```js
-import { openDb } from 'gtfs';
-```
-
-Open database before making any queries
-
-```js
-const db = openDb(config);
-```
+### Static GTFS Files
 
-### getAgencies(query, fields, sortBy, options)
+#### getAgencies(query, fields, sortBy, options)
 
 Returns an array of agencies that match query parameters. [Details on agency.txt](https://gtfs.org/schedule/reference/#agencytxt)
 
@@ -588,7 +590,7 @@ const agencies = getAgencies({
 });
 ```
 
-### getAreas(query, fields, sortBy, options)
+#### getAreas(query, fields, sortBy, options)
 
 Returns an array of areas that match query parameters. [Details on areas.txt](https://gtfs.org/schedule/reference/#areastxt)
 
@@ -604,7 +606,7 @@ const areas = getAreas({
 });
 ```
 
-### getAttributions(query, fields, sortBy, options)
+#### getAttributions(query, fields, sortBy, options)
 
 Returns an array of attributions that match query parameters. [Details on attributions.txt](https://gtfs.org/schedule/reference/#attributionstxt)
 
@@ -620,7 +622,7 @@ const attributions = getAttributions({
 });
 ```
 
-### getRoutes(query, fields, sortBy, options)
+#### getRoutes(query, fields, sortBy, options)
 
 Returns an array of routes that match query parameters. [Details on routes.txt](https://gtfs.org/schedule/reference/#routestxt)
 
@@ -648,7 +650,7 @@ const routes = getRoutes(
 );
 ```
 
-### getStops(query, fields, sortBy, options)
+#### getStops(query, fields, sortBy, options)
 
 Returns an array of stops that match query parameters. [Details on stops.txt](https://gtfs.org/schedule/reference/#stopstxt)
 
@@ -688,7 +690,7 @@ const stops = getStops({
 });
 ```
 
-### getStopsAsGeoJSON(query, options)
+#### getStopsAsGeoJSON(query, options)
 
 Returns geoJSON object of stops that match query parameters. All valid queries for `getStops()` work for `getStopsAsGeoJSON()`.
 
@@ -704,7 +706,7 @@ const stopsGeojson = getStopsAsGeoJSON({
 });
 ```
 
-### getStoptimes(query, fields, sortBy, options)
+#### getStoptimes(query, fields, sortBy, options)
 
 Returns an array of stop_times that match query parameters. [Details on stop_times.txt](https://gtfs.org/schedule/reference/#stop_timestxt)
 
@@ -735,7 +737,7 @@ const stoptimes = getStoptimes({
 });
 ```
 
-### getTrips(query, fields, sortBy, options)
+#### getTrips(query, fields, sortBy, options)
 
 Returns an array of trips that match query parameters. [Details on trips.txt](https://gtfs.org/schedule/reference/#tripstxt)
 
@@ -765,7 +767,7 @@ const trips = getTrips({
 });
 ```
 
-### getShapes(query, fields, sortBy, options)
+#### getShapes(query, fields, sortBy, options)
 
 Returns an array of shapes that match query parameters. [Details on shapes.txt](https://gtfs.org/schedule/reference/#shapestxt)
 
@@ -800,7 +802,7 @@ const shapes = getShapes({
 });
 ```
 
-### getShapesAsGeoJSON(query, options)
+#### getShapesAsGeoJSON(query, options)
 
 Returns a geoJSON object of shapes that match query parameters. All valid queries for `getShapes()` work for `getShapesAsGeoJSON()`.
 
@@ -831,7 +833,7 @@ const shapesGeojson = getShapesAsGeoJSON({
 });
 ```
 
-### getCalendars(query, fields, sortBy, options)
+#### getCalendars(query, fields, sortBy, options)
 
 Returns an array of calendars that match query parameters. [Details on calendar.txt](https://gtfs.org/schedule/reference/#calendartxt)
 
@@ -847,7 +849,7 @@ const calendars = getCalendars({
 });
 ```
 
-### getCalendarDates(query, fields, sortBy, options)
+#### getCalendarDates(query, fields, sortBy, options)
 
 Returns an array of calendar_dates that match query parameters. [Details on calendar_dates.txt](https://gtfs.org/schedule/reference/#calendar_datestxt)
 
@@ -863,7 +865,7 @@ const calendarDates = getCalendarDates({
 });
 ```
 
-### getFareAttributes(query, fields, sortBy, options)
+#### getFareAttributes(query, fields, sortBy, options)
 
 Returns an array of fare_attributes that match query parameters. [Details on fare_attributes.txt](https://gtfs.org/schedule/reference/#fare_attributestxt)
 
@@ -879,7 +881,7 @@ const fareAttributes = getFareAttributes({
 });
 ```
 
-### getFareLegRules(query, fields, sortBy, options)
+#### getFareLegRules(query, fields, sortBy, options)
 
 Returns an array of fare_leg_rules that match query parameters. [Details on fare_leg_rules.txt](https://gtfs.org/schedule/reference/#fare_leg_rulestxt)
 
@@ -895,7 +897,7 @@ const fareLegRules = getFareLegRules({
 });
 ```
 
-### getFareProducts(query, fields, sortBy, options)
+#### getFareProducts(query, fields, sortBy, options)
 
 Returns an array of fare_products that match query parameters. [Details on fare_products.txt](https://gtfs.org/schedule/reference/#fare_productstxt)
 
@@ -911,7 +913,7 @@ const fareProducts = getFareProducts({
 });
 ```
 
-### getFareRules(query, fields, sortBy, options)
+#### getFareRules(query, fields, sortBy, options)
 
 Returns an array of fare_rules that match query parameters. [Details on fare_rules.txt](https://gtfs.org/schedule/reference/#fare_rulestxt)
 
@@ -927,7 +929,7 @@ const fareRules = getFareRules({
 });
 ```
 
-### getFareTransferRules(query, fields, sortBy, options)
+#### getFareTransferRules(query, fields, sortBy, options)
 
 Returns an array of fare_transfer_rules that match query parameters. [Details on fare_transfer_rules.txt](https://gtfs.org/schedule/reference/#fare_transfer_rulestxt)
 
@@ -943,7 +945,7 @@ const fareTransferRules = getFareTransferRules({
 });
 ```
 
-### getFeedInfo(query, fields, sortBy, options)
+#### getFeedInfo(query, fields, sortBy, options)
 
 Returns an array of feed_info that match query parameters. [Details on feed_info.txt](https://gtfs.org/schedule/reference/#feed_infotxt)
 
@@ -954,7 +956,7 @@ import { getFeedInfo } from 'gtfs';
 const feedInfo = getFeedInfo();
 ```
 
-### getFrequencies(query, fields, sortBy, options)
+#### getFrequencies(query, fields, sortBy, options)
 
 Returns an array of frequencies that match query parameters. [Details on frequencies.txt](https://gtfs.org/schedule/reference/#frequenciestxt)
 
@@ -970,7 +972,7 @@ const frequencies = getFrequencies({
 });
 ```
 
-### getLevels(query, fields, sortBy, options)
+#### getLevels(query, fields, sortBy, options)
 
 Returns an array of levels that match query parameters. [Details on levels.txt](https://gtfs.org/schedule/reference/#levelstxt)
 
@@ -981,7 +983,7 @@ import { getLevels } from 'gtfs';
 const levels = getLevels();
 ```
 
-### getPathways(query, fields, sortBy, options)
+#### getPathways(query, fields, sortBy, options)
 
 Returns an array of pathways that match query parameters. [Details on pathways.txt](https://gtfs.org/schedule/reference/#pathwaystxt)
 
@@ -992,7 +994,7 @@ import { getPathways } from 'gtfs';
 const pathways = getPathways();
 ```
 
-### getTransfers(query, fields, sortBy, options)
+#### getTransfers(query, fields, sortBy, options)
 
 Returns an array of transfers that match query parameters. [Details on transfers.txt](https://gtfs.org/schedule/reference/#transferstxt)
 
@@ -1008,7 +1010,7 @@ const transfers = getTransfers({
 });
 ```
 
-### getTranslations(query, fields, sortBy, options)
+#### getTranslations(query, fields, sortBy, options)
 
 Returns an array of translations that match query parameters. [Details on translations.txt](https://gtfs.org/schedule/reference/#translationstxt)
 
@@ -1019,7 +1021,7 @@ import { getTranslations } from 'gtfs';
 const translations = getTranslations();
 ```
 
-### getStopAreas(query, fields, sortBy, options)
+#### getStopAreas(query, fields, sortBy, options)
 
 Returns an array of stop_areas that match query parameters. [Details on stop_areas.txt](https://gtfs.org/schedule/reference/#stop_areastxt)
 
@@ -1030,45 +1032,9 @@ import { getStopAreas } from 'gtfs';
 const stopAreas = getStopAreas();
 ```
 
-### getDirections(query, fields, sortBy, options)
-
-Returns an array of directions that match query parameters. This is for the non-standard `directions.txt` file. [Details on directions.txt](https://trilliumtransit.com/gtfs/reference/#directions)
-
-```js
-import { getDirections } from 'gtfs';
-
-// Get all directions
-const directions = getDirections();
-
-// Get directions for a specific route
-const directions = getDirections({
-  route_id: '1234',
-});
-
-// Get directions for a specific route and direction
-const directions = getDirections({
-  route_id: '1234',
-  direction_id: 1,
-});
-```
-
-### getStopAttributes(query, fields, sortBy, options)
-
-Returns an array of stop_attributes that match query parameters. This is for the non-standard `stop_attributes.txt` file. [Details on stop_attributes.txt](https://trilliumtransit.com/gtfs/reference/#stop_attributes)
-
-```js
-import { getStopAttributes } from 'gtfs';
-
-// Get all stop attributes
-const stopAttributes = getStopAttributes();
-
-// Get stop attributes for specific stop
-const stopAttributes = getStopAttributes({
-  stop_id: '1234',
-});
-```
+### GTFS-Timetables files
 
-### getTimetables(query, fields, sortBy, options)
+#### getTimetables(query, fields, sortBy, options)
 
 Returns an array of timetables that match query parameters. This is for the non-standard `timetables.txt` file used in GTFS-to-HTML. [Details on timetables.txt](https://gtfstohtml.com/docs/timetables)
 
@@ -1084,7 +1050,7 @@ const timetables = getTimetables({
 });
 ```
 
-### getTimetableStopOrders(query, fields, sortBy, options)
+#### getTimetableStopOrders(query, fields, sortBy, options)
 
 Returns an array of timetable_stop_orders that match query parameters. This is for the non-standard `timetable_stop_order.txt` file used in GTFS-to-HTML. [Details on timetable_stop_order.txt](https://gtfstohtml.com/docs/timetable-stop-order)
 
@@ -1100,7 +1066,7 @@ const timetableStopOrders = getTimetableStopOrders({
 });
 ```
 
-### getTimetablePages(query, fields, sortBy, options)
+#### getTimetablePages(query, fields, sortBy, options)
 
 Returns an array of timetable_pages that match query parameters. This is for the non-standard `timetable_pages.txt` file used in GTFS-to-HTML. [Details on timetable_pages.txt](https://gtfstohtml.com/docs/timetable-pages)
 
@@ -1116,7 +1082,7 @@ const timetablePages = getTimetablePages({
 });
 ```
 
-### getTimetableNotes(query, fields, sortBy, options)
+#### getTimetableNotes(query, fields, sortBy, options)
 
 Returns an array of timetable_notes that match query parameters. This is for the non-standard `timetable_notes.txt` file used in GTFS-to-HTML. [Details on timetable_notes.txt](https://gtfstohtml.com/docs/timetable-notes)
 
@@ -1132,7 +1098,7 @@ const timetableNotes = getTimetableNotes({
 });
 ```
 
-### getTimetableNotesReferences(query, fields, sortBy, options)
+#### getTimetableNotesReferences(query, fields, sortBy, options)
 
 Returns an array of timetable_notes_references that match query parameters. This is for the non-standard `timetable_notes_references.txt` file used in GTFS-to-HTML. [Details on timetable_notes_references.txt](https://gtfstohtml.com/docs/timetable-notes-references)
 
@@ -1148,20 +1114,13 @@ const timetableNotesReferences = getTimetableNotesReferences({
 });
 ```
 
-### getTripsDatedVehicleJourneys(query, fields, sortBy, options)
-
-Returns an array of trips_dated_vehicle_journey that match query parameters. This is for the non-standard `trips_dated_vehicle_journey.txt` file. [Details on trips_dated_vehicle_journey.txt](https://www.trafiklab.se/api/trafiklab-apis/gtfs-regional/extra-files/)
-
-```js
-import { getTripsDatedVehicleJourneys } from 'gtfs';
+### GTFS-Realtime
 
-// Get all timetable_stop_orders
-const tripsDatedVehicleJourneys = getTripsDatedVehicleJourneys();
-```
+In order to use GTFS-Realtime query methods, you must first configure GTFS Realtime import in node-gtfs
 
-### getServiceAlerts(query, fields, sortBy, options)
+#### getServiceAlerts(query, fields, sortBy, options)
 
-Returns an array of GTFS Realtime service alerts that match query parameters. This only works if you configure GTFS Realtime import in node-gtfs. [Details on Service Alerts](https://gtfs.org/realtime/feed-entities/service-alerts/)
+Returns an array of GTFS Realtime service alerts that match query parameters. [Details on Service Alerts](https://gtfs.org/realtime/feed-entities/service-alerts/)
 
 ```js
 import { getServiceAlerts } from 'gtfs';
@@ -1170,9 +1129,9 @@ import { getServiceAlerts } from 'gtfs';
 const serviceAlerts = getServiceAlerts();
 ```
 
-### getTripUpdates(query, fields, sortBy, options)
+#### getTripUpdates(query, fields, sortBy, options)
 
-Returns an array of GTFS Realtime trip updates that match query parameters. This only works if you configure GTFS Realtime import in node-gtfs. [Details on Trip Updates](https://gtfs.org/realtime/feed-entities/trip-updates/)
+Returns an array of GTFS Realtime trip updates that match query parameters. [Details on Trip Updates](https://gtfs.org/realtime/feed-entities/trip-updates/)
 
 ```js
 import { getTripUpdates } from 'gtfs';
@@ -1181,9 +1140,9 @@ import { getTripUpdates } from 'gtfs';
 const tripUpdates = getTripUpdates();
 ```
 
-### getStopTimesUpdates(query, fields, sortBy, options)
+#### getStopTimesUpdates(query, fields, sortBy, options)
 
-Returns an array of GTFS Realtime stop time updates that match query parameters. This only works if you configure GTFS Realtime import in node-gtfs. [Details on Stop Time Updates](https://gtfs.org/realtime/feed-entities/trip-updates/#stoptimeupdate)
+Returns an array of GTFS Realtime stop time updates that match query parameters. [Details on Stop Time Updates](https://gtfs.org/realtime/feed-entities/trip-updates/#stoptimeupdate)
 
 ```js
 import { getStopTimesUpdates } from 'gtfs';
@@ -1192,9 +1151,9 @@ import { getStopTimesUpdates } from 'gtfs';
 const stopTimesUpdates = getStopTimesUpdates();
 ```
 
-### getVehiclePositions(query, fields, sortBy, options)
+#### getVehiclePositions(query, fields, sortBy, options)
 
-Returns an array of GTFS Realtime vehicle positions that match query parameters. This only works if you configure GTFS Realtime import in node-gtfs. [Details on Vehicle Positions](https://gtfs.org/realtime/feed-entities/vehicle-positions/)
+Returns an array of GTFS Realtime vehicle positions that match query parameters. [Details on Vehicle Positions](https://gtfs.org/realtime/feed-entities/vehicle-positions/)
 
 ```js
 import { getVehiclePositions } from 'gtfs';
@@ -1203,7 +1162,214 @@ import { getVehiclePositions } from 'gtfs';
 const vehiclePositions = getVehiclePositions();
 ```
 
-### advancedQuery(table, advancedQueryOptions)
+### GTFS-Ride Files
+
+#### getBoardAlights(query, fields, sortBy, options)
+
+Returns an array of board_alight that match query parameters. [Details on board_alight.txt](http://gtfsride.org/specification#board_alighttxt)
+
+```js
+import { getBoardAlights } from 'gtfs';
+
+// Get all board_alight
+const boardAlights = getBoardAlights();
+
+// Get board_alight for a specific trip
+const boardAlights = getBoardAlights({
+  trip_id: '123',
+});
+```
+
+#### getRideFeedInfos(query, fields, sortBy, options)
+
+Returns an array of ride_feed_info that match query parameters. [Details on ride_feed_info.txt](http://gtfsride.org/specification#ride_feed_infotxt)
+
+```js
+import { getRideFeedInfos } from 'gtfs';
+
+// Get all ride_feed_info
+const rideFeedInfos = getRideFeedInfos();
+```
+
+#### getRiderTrips(query, fields, sortBy, options)
+
+Returns an array of rider_trip that match query parameters. [Details on rider_trip.txt](http://gtfsride.org/specification#rider_triptxt)
+
+```js
+import { getRiderTrips } from 'gtfs';
+
+// Get all rider_trip
+const riderTrips = getRiderTrips();
+
+// Get rider_trip for a specific trip
+const riderTrips = getRiderTrips({
+  trip_id: '123',
+});
+```
+
+#### getRiderships(query, fields, sortBy, options)
+
+Returns an array of ridership that match query parameters. [Details on ridership.txt](http://gtfsride.org/specification#ridershiptxt)
+
+```js
+import { getRiderships } from 'gtfs';
+
+// Get all ridership
+const riderships = getRiderships();
+
+// Get ridership for a specific route
+const riderships = getRiderships({
+  route_id: '123',
+});
+```
+
+#### getTripCapacities(query, fields, sortBy, options)
+
+Returns an array of trip_capacity that match query parameters. [Details on trip_capacity.txt](http://gtfsride.org/specification#trip_capacitytxt)
+
+```js
+import { getTripCapacities } from 'gtfs';
+
+// Get all trip_capacity
+const tripCapacities = getTripCapacities();
+
+// Get trip_capacity for a specific trip
+const tripCapacities = getTripCapacities({
+  trip_id: '123',
+});
+```
+
+### Operational Data Standard (ODS) Files
+
+#### getDeadheads(query, fields, sortBy, options)
+
+Returns an array of deadheads that match query parameters. [Details on deadheads.txt](https://docs.calitp.org/operational-data-standard/spec/#deadheadstxt)
+
+```js
+import { getDeadheads } from 'gtfs';
+
+// Get all deadheads
+const deadheads = getDeadheads();
+
+// Get deadheads for a specific block
+const deadheads = getDeadheads({
+  block_id: '123',
+});
+```
+
+#### getDeadheadTimes(query, fields, sortBy, options)
+
+Returns an array of deadhead_times that match query parameters. [Details on deadhead_times.txt](https://docs.calitp.org/operational-data-standard/spec/#deadhead_timestxt)
+
+```js
+import { getDeadheadTimes } from 'gtfs';
+
+// Get all deadhead_times
+const deadheadTimes = getDeadheadTimes();
+
+// Get deadhead_times for a specific deadhead
+const deadheadTimes = getDeadheadTimes({
+  deadhead_id: '123',
+});
+```
+
+#### getOpsLocations(query, fields, sortBy, options)
+
+Returns an array of ops_locations that match query parameters. [Details on ops_locations.txt](https://docs.calitp.org/operational-data-standard/spec/#ops_locationstxt)
+
+```js
+import { getOpsLocations } from 'gtfs';
+
+// Get all ops_locations
+const opsLocations = getOpsLocations();
+
+// Get a specific ops_locations
+const opsLocations = getOpsLocations({
+  ops_location_id: '123',
+});
+```
+
+#### getRunsPieces(query, fields, sortBy, options)
+
+Returns an array of runs_pieces that match query parameters. [Details on runs_pieces.txt](https://docs.calitp.org/operational-data-standard/spec/#runs_piecestxt)
+
+```js
+import { getRunsPieces } from 'gtfs';
+
+// Get all runs_pieces
+const runsPieces = getRunsPieces();
+```
+
+#### getRunEvents(query, fields, sortBy, options)
+
+Returns an array of run_events that match query parameters. [Details on run_events.txt](https://docs.calitp.org/operational-data-standard/spec/#run_eventstxt)
+
+```js
+import { getRunEvents } from 'gtfs';
+
+// Get all run_events
+const runEvents = runEvents();
+
+// Get a run_events for a specific piece
+const runEvents = runEvents({
+  piece_id: '123',
+});
+```
+
+### Non-standard GTFS Files
+
+#### getDirections(query, fields, sortBy, options)
+
+Returns an array of directions that match query parameters. This is for the non-standard `directions.txt` file. [Details on directions.txt](https://trilliumtransit.com/gtfs/reference/#directions)
+
+```js
+import { getDirections } from 'gtfs';
+
+// Get all directions
+const directions = getDirections();
+
+// Get directions for a specific route
+const directions = getDirections({
+  route_id: '1234',
+});
+
+// Get directions for a specific route and direction
+const directions = getDirections({
+  route_id: '1234',
+  direction_id: 1,
+});
+```
+
+#### getStopAttributes(query, fields, sortBy, options)
+
+Returns an array of stop_attributes that match query parameters. This is for the non-standard `stop_attributes.txt` file. [Details on stop_attributes.txt](https://trilliumtransit.com/gtfs/reference/#stop_attributes)
+
+```js
+import { getStopAttributes } from 'gtfs';
+
+// Get all stop attributes
+const stopAttributes = getStopAttributes();
+
+// Get stop attributes for specific stop
+const stopAttributes = getStopAttributes({
+  stop_id: '1234',
+});
+```
+
+#### getTripsDatedVehicleJourneys(query, fields, sortBy, options)
+
+Returns an array of trips_dated_vehicle_journey that match query parameters. This is for the non-standard `trips_dated_vehicle_journey.txt` file. [Details on trips_dated_vehicle_journey.txt](https://www.trafiklab.se/api/trafiklab-apis/gtfs-regional/extra-files/)
+
+```js
+import { getTripsDatedVehicleJourneys } from 'gtfs';
+
+// Get all trips_dated_vehicle_journey
+const tripsDatedVehicleJourneys = getTripsDatedVehicleJourneys();
+```
+
+### Advanced Query Methods
+
+#### advancedQuery(table, advancedQueryOptions)
 
 Queries the database with support for table joins and custom tables and returns an array of data.
 
@@ -1228,7 +1394,7 @@ const advancedQueryOptions = {
 const stoptimes = advancedQuery('stop_times', advancedQueryOptions);
 ```
 
-### Raw SQLite Query
+#### Raw SQLite Query
 
 Use the `openDb` function to get the db object, and then use any query method from [better-sqlite3](https://github.com/WiseLibs/better-sqlite3) to query GTFS data.
 

package/lib/db.js

@@ -37,9 +37,8 @@ export function openDb(config) {
 }
 
 export function setupDb(db) {
-  db.pragma('journal_mode = WAL');
+  db.pragma('journal_mode = OFF');
   db.pragma('synchronous = OFF');
-  db.pragma('locking_mode = EXCLUSIVE');
   db.pragma('temp_store = MEMORY');
 }
 

package/lib/gtfs-realtime/service-alerts.js

@@ -11,7 +11,7 @@ import serviceAlerts from '../../models/gtfs-realtime/service-alerts.js';
 import serviceAlertTargets from '../../models/gtfs-realtime/service-alert-targets.js';
 
 /*
- * Returns an array of all serivce alerts that match the query parameters.
+ * Returns an array of all service alerts that match the query parameters.
  */
 export function getServiceAlerts(
   query = {},

package/lib/gtfs.js

@@ -51,6 +51,13 @@ import { getTripUpdates } from './gtfs-realtime/trip-updates.js';
 import { getVehiclePositions } from './gtfs-realtime/vehicle-positions.js';
 import { getServiceAlerts } from './gtfs-realtime/service-alerts.js';
 
+// ODS Filenames
+import { getDeadheads } from './ods/deadheads.js';
+import { getDeadheadTimes } from './ods/deadhead-times.js';
+import { getOpsLocations } from './ods/ops-locations.js';
+import { getRunEvents } from './ods/run-events.js';
+import { getRunsPieces } from './ods/runs-pieces.js';
+
 // Expose database connection
 import { openDb, closeDb } from './db.js';
 
@@ -186,6 +193,21 @@ export { _getVehiclePositions as getVehiclePositions };
 const _getServiceAlerts = getServiceAlerts;
 export { _getServiceAlerts as getServiceAlerts };
 
+const _getDeadheads = getDeadheads;
+export { _getDeadheads as getDeadheads };
+
+const _getDeadheadTimes = getDeadheadTimes;
+export { _getDeadheadTimes as getDeadheadTimes };
+
+const _getOpsLocations = getOpsLocations;
+export { _getOpsLocations as getOpsLocations };
+
+const _getRunEvents = getRunEvents;
+export { _getRunEvents as getRunEvents };
+
+const _getRunsPieces = getRunsPieces;
+export { _getRunsPieces as getRunsPieces };
+
 const _openDb = openDb;
 export { _openDb as openDb };
 const _closeDb = closeDb;

package/lib/ods/deadhead-times.js

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

package/lib/ods/deadheads.js

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

package/lib/ods/ops-locations.js

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

package/lib/ods/run-events.js

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

package/lib/ods/runs-pieces.js

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

package/models/models.js

@@ -42,6 +42,12 @@ import vehiclePositions from './gtfs-realtime/vehicle-positions.js';
 import serviceAlerts from './gtfs-realtime/service-alerts.js';
 import serviceAlertTargets from './gtfs-realtime/service-alert-targets.js';
 
+import deadheadTimes from './ods/deadhead-times.js';
+import deadheads from './ods/deadheads.js';
+import opsLocations from './ods/ops-locations.js';
+import runEvents from './ods/run-events.js';
+import runsPieces from './ods/runs-pieces.js';
+
 const models = [
   agency,
   areas,
@@ -83,6 +89,11 @@ const models = [
   vehiclePositions,
   serviceAlerts,
   serviceAlertTargets,
+  deadheadTimes,
+  deadheads,
+  opsLocations,
+  runEvents,
+  runsPieces,
 ];
 
 export default models;

package/models/ods/deadhead-times.js

@@ -0,0 +1,60 @@
+const model = {
+  filenameBase: 'deadhead_times',
+  nonstandard: true,
+  extension: 'ods',
+  schema: [
+    {
+      name: 'id',
+      type: 'integer',
+      primary: true,
+    },
+    {
+      name: 'deadhead_id',
+      type: 'varchar(255)',
+      required: true,
+      index: true,
+    },
+    {
+      name: 'arrival_time',
+      type: 'varchar(255)',
+      required: true,
+    },
+    {
+      name: 'arrival_timestamp',
+      type: 'integer',
+      index: true,
+    },
+    {
+      name: 'departure_time',
+      type: 'varchar(255)',
+      required: true,
+    },
+    {
+      name: 'departure_timestamp',
+      type: 'integer',
+      index: true,
+    },
+    {
+      name: 'ops_location_id',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'stop_id',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'location_sequence',
+      type: 'integer',
+      required: true,
+      min: 0,
+      index: true,
+    },
+    {
+      name: 'shape_dist_traveled',
+      type: 'real',
+      min: 0,
+    },
+  ],
+};
+
+export default model;

package/models/ods/deadheads.js

@@ -0,0 +1,51 @@
+const model = {
+  filenameBase: 'deadheads',
+  nonstandard: true,
+  extension: 'ods',
+  schema: [
+    {
+      name: 'deadhead_id',
+      type: 'varchar(255)',
+      primary: true,
+      required: true,
+    },
+    {
+      name: 'service_id',
+      type: 'varchar(255)',
+      required: true,
+    },
+    {
+      name: 'block_id',
+      type: 'varchar(255)',
+      required: true,
+      index: true,
+    },
+    {
+      name: 'shape_id',
+      type: 'varchar(255)',
+      index: true,
+    },
+    {
+      name: 'to_trip_id',
+      type: 'varchar(255)',
+      index: true,
+    },
+    {
+      name: 'from_trip_id',
+      type: 'varchar(255)',
+      index: true,
+    },
+    {
+      name: 'to_deadhead_id',
+      type: 'varchar(255)',
+      index: true,
+    },
+    {
+      name: 'from_deadhead_id',
+      type: 'varchar(255)',
+      index: true,
+    },
+  ],
+};
+
+export default model;

package/models/ods/ops-locations.js

@@ -0,0 +1,44 @@
+const model = {
+  filenameBase: 'ops_locations',
+  nonstandard: true,
+  extension: 'ods',
+  schema: [
+    {
+      name: 'ops_location_id',
+      type: 'varchar(255)',
+      primary: true,
+      required: true,
+    },
+    {
+      name: 'ops_location_code',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'ops_location_name',
+      type: 'varchar(255)',
+      required: true,
+      nocase: true,
+    },
+    {
+      name: 'ops_location_desc',
+      type: 'varchar(255)',
+      nocase: true,
+    },
+    {
+      name: 'ops_location_lat',
+      type: 'real',
+      required: true,
+      min: -90,
+      max: 90,
+    },
+    {
+      name: 'ops_location_lon',
+      type: 'real',
+      required: true,
+      min: -180,
+      max: 180,
+    },
+  ],
+};
+
+export default model;

package/models/ods/run-events.js

@@ -0,0 +1,65 @@
+const model = {
+  filenameBase: 'run_event',
+  nonstandard: true,
+  extension: 'ods',
+  schema: [
+    {
+      name: 'run_event_id',
+      type: 'varchar(255)',
+      primary: true,
+      required: true,
+    },
+    {
+      name: 'piece_id',
+      type: 'varchar(255)',
+      required: true,
+    },
+    {
+      name: 'event_type',
+      type: 'integer',
+      required: true,
+      min: 0,
+      index: true,
+    },
+    {
+      name: 'event_name',
+      type: 'varchar(255)',
+      nocase: true,
+    },
+    {
+      name: 'event_time',
+      type: 'varchar(255)',
+      required: true,
+    },
+    {
+      name: 'event_duration',
+      type: 'integer',
+      required: true,
+      min: 0,
+    },
+    {
+      name: 'event_from_location_type',
+      type: 'integer',
+      min: 0,
+      max: 1,
+      index: true,
+    },
+    {
+      name: 'event_from_location_id',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'event_to_location_type',
+      type: 'integer',
+      min: 0,
+      max: 1,
+      index: true,
+    },
+    {
+      name: 'event_to_location_id',
+      type: 'varchar(255)',
+    },
+  ],
+};
+
+export default model;

package/models/ods/runs-pieces.js

@@ -0,0 +1,58 @@
+const model = {
+  filenameBase: 'runs_pieces',
+  nonstandard: true,
+  extension: 'ods',
+  schema: [
+    {
+      name: 'run_id',
+      type: 'varchar(255)',
+      required: true,
+    },
+    {
+      name: 'piece_id',
+      type: 'varchar(255)',
+      primary: true,
+      required: true,
+    },
+    {
+      name: 'start_type',
+      type: 'integer',
+      required: true,
+      min: 0,
+      max: 2,
+      index: true,
+    },
+    {
+      name: 'start_trip_id',
+      type: 'varchar(255)',
+      required: true,
+      index: true,
+    },
+    {
+      name: 'start_trip_position',
+      type: 'integer',
+      min: 0,
+    },
+    {
+      name: 'end_type',
+      type: 'integer',
+      required: true,
+      min: 0,
+      max: 2,
+      index: true,
+    },
+    {
+      name: 'end_trip_id',
+      type: 'varchar(255)',
+      required: true,
+      index: true,
+    },
+    {
+      name: 'end_trip_position',
+      type: 'integer',
+      min: 0,
+    },
+  ],
+};
+
+export default model;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Import GTFS transit data into SQLite and query routes, stops, times, fares and more",
   "keywords": [
     "transit",
@@ -74,10 +74,10 @@
   },
   "dependencies": {
     "@turf/helpers": "^6.5.0",
-    "better-sqlite3": "^8.0.1",
-    "csv-parse": "^5.3.3",
-    "csv-stringify": "^6.2.3",
-    "gtfs-realtime-bindings": "^0.0.6",
+    "better-sqlite3": "^8.1.0",
+    "csv-parse": "^5.3.5",
+    "csv-stringify": "^6.2.4",
+    "gtfs-realtime-bindings": "^1.1.1",
     "lodash-es": "^4.17.21",
     "long": "^5.2.1",
     "node-fetch": "^3.3.0",
@@ -91,18 +91,18 @@
     "tmp-promise": "^3.0.3",
     "untildify": "^4.0.0",
     "unzipper": "^0.10.11",
-    "yargs": "^17.6.2",
+    "yargs": "^17.7.1",
     "yoctocolors": "^1.0.0"
   },
   "devDependencies": {
     "@types/better-sqlite3": "^7.6.3",
     "dtslint": "^4.2.1",
-    "eslint": "^8.32.0",
+    "eslint": "^8.34.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-config-xo": "^0.43.1",
     "husky": "^8.0.3",
     "mocha": "^10.2.0",
-    "prettier": "^2.8.3",
+    "prettier": "^2.8.4",
     "pretty-quick": "^3.1.3",
     "should": "^13.2.3"
   },