gtfs 3.5.1 → 3.6.1

package/README.md

@@ -62,17 +62,16 @@ or
 ```js
 import { importGtfs } from 'gtfs';
 import { readFile } from 'fs/promises';
+
 const config = JSON.parse(
   await readFile(new URL('./config.json', import.meta.url))
 );
 
-importGtfs(config)
-  .then(() => {
-    console.log('Import Successful');
-  })
-  .catch((err) => {
-    console.error(err);
-  });
+try {
+  await importGtfs(config);
+} catch (error) {
+  console.error(error);
+}
 ```
 
 ### Example Applications
@@ -94,6 +93,10 @@ importGtfs(config)
     <td><img src="https://github.com/BlinkTagInc/gtfs-tts/raw/main/docs/images/gtfs-tts-logo.svg" alt="GTFS-TTS" width="200"></td>
     <td><a href="https://github.com/blinktaginc/gtfs-tts">GTFS-Text-to-Speech</a> app tests GTFS stop name pronunciation for text-to-speech. It uses `node-gtfs` for loading stop names from GTFS data.</td>
   </tr>
+  <tr>
+    <td><img src="https://github.com/BlinkTagInc/transit-arrivals-widget/raw/master/docs/images/transit-arrivals-widget-logo.svg" alt="Transit Arrivals Widget" width="200"></td>
+    <td><a href="https://github.com/BlinkTagInc/transit-arrivals-widget">Transit Arrivals Widget</a> creates a realtime transit arrivals tool from GTFS and GTFS-RT data.</td>
+  </tr>
 </table>
 
 ## Command-Line Usage
@@ -312,7 +315,7 @@ const config = {
   },
 };
 
-importGtfs(config);
+await importGtfs(config);
 ```
 
 ## `gtfs-import` Script
@@ -339,13 +342,7 @@ const config = JSON.parse(
   await readFile(new URL('./config.json', import.meta.url))
 );
 
-importGtfs(config)
-  .then(() => {
-    console.log('Import Successful');
-  })
-  .catch((err) => {
-    console.error(err);
-  });
+await importGtfs(config);
 ```
 
 Configuration can be a JSON object in your code
@@ -363,13 +360,7 @@ const config = {
   ],
 };
 
-importGtfs(config)
-  .then(() => {
-    console.log('Import Successful');
-  })
-  .catch((err) => {
-    console.error(err);
-  });
+await importGtfs(config);
 ```
 
 ## `gtfsrealtime-update` Script
@@ -396,13 +387,7 @@ const config = JSON.parse(
   await readFile(new URL('./config.json', import.meta.url))
 );
 
-updateGtfsRealtime(config)
-  .then(() => {
-    console.log('Update Successful');
-  })
-  .catch((err) => {
-    console.error(err);
-  });
+await updateGtfsRealtime(config);
 ```
 
 ## `gtfs-export` Script
@@ -454,13 +439,7 @@ const config = {
   ],
 };
 
-exportGtfs(config)
-  .then(() => {
-    console.log('Export Successful');
-  })
-  .catch((err) => {
-    console.error(err);
-  });
+await exportGtfs(config);
 ```
 
 ## Query Methods
@@ -549,14 +528,30 @@ Queries agencies and returns a promise. The result of the promise is an array of
 import { getAgencies } from 'gtfs';
 
 // Get all agencies
-getAgencies();
+const agencies = await getAgencies();
 
 // Get a specific agency
-getAgencies({
+const agencies = await getAgencies({
   agency_id: 'caltrain',
 });
 ```
 
+### getAreas(query, fields, sortBy)
+
+Queries areas and returns a promise. The result of the promise is an array of areas.
+
+```js
+import { getAreas } from 'gtfs';
+
+// Get all areas
+const areas = await getAreas();
+
+// Get a specific area
+const areas = await getAreas({
+  area_id: 'area1',
+});
+```
+
 ### getAttributions(query, fields, sortBy)
 
 Queries attributions and returns a promise. The result of the promise is an array of attributions.
@@ -565,10 +560,10 @@ Queries attributions and returns a promise. The result of the promise is an arra
 import { getAttributions } from 'gtfs';
 
 // Get all attributions
-getAttributions();
+const attributions = await getAttributions();
 
 // Get a specific attribution
-getAttributions({
+const attributions = await getAttributions({
   attribution_id: '123',
 });
 ```
@@ -581,10 +576,10 @@ Queries routes and returns a promise. The result of the promise is an array of r
 import { getRoutes } from 'gtfs';
 
 // Get all routes, sorted by route_short_name
-getRoutes({}, [], [['route_short_name', 'ASC']]);
+const routes = await getRoutes({}, [], [['route_short_name', 'ASC']]);
 
 // Get a specific route
-getRoutes({
+const routes = await getRoutes({
   route_id: 'Lo-16APR',
 });
 ```
@@ -595,7 +590,7 @@ getRoutes({
 import { getRoutes } from 'gtfs';
 
 // Get routes that serve a specific stop, sorted by `stop_name`.
-getRoutes(
+const routes = await getRoutes(
   {
     stop_id: '70011',
   },
@@ -612,43 +607,34 @@ Queries stops and returns a promise. The result of the promise is an array of st
 import { getStops } from 'gtfs';
 
 // Get all stops
-getStops();
+const stops = await getStops();
 
 // Get a specific stop by stop_id
-getStops({
+const stops = await getStops({
   stop_id: '70011',
 });
-```
-
-`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 { getStops } from 'gtfs';
 
-// Get all stops for a specific route
-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`.
+ */
+const stops = await getStops({
   route_id: 'Lo-16APR',
 });
-```
-
-`getStops` allows passing a `trip_id` in the query and it will query stoptimes to find all stops on that `trip_id`.
-
-```js
-import { getStops } from 'gtfs';
 
-// Get all stops for a specific trip
-getStops({
+/*
+ * `getStops` allows passing a `trip_id` in the query and it will query
+ * stoptimes to find all stops on that `trip_id`.
+ */
+const stops = await getStops({
   trip_id: '37a',
 });
-```
-
-`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({
+/*
+ * `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`.
+ */
+const stops = await getStops({
   shape_id: 'cal_sf_tam',
 });
 ```
@@ -661,10 +647,10 @@ Queries stops and returns a promise. The result of the promise is an geoJSON obj
 import { getStopsAsGeoJSON } from 'gtfs';
 
 // Get all stops for an agency as geoJSON
-getStopsAsGeoJSON();
+const stopsGeojson = await getStopsAsGeoJSON();
 
 // Get all stops for a specific route as geoJSON
-getStopsAsGeoJSON({
+const stopsGeojson = await getStopsAsGeoJSON({
   route_id: 'Lo-16APR',
 });
 ```
@@ -677,15 +663,15 @@ Queries `stop_times` and returns a promise. The result of the promise is an arra
 import { getStoptimes } from 'gtfs';
 
 // Get all stoptimes
-getStoptimes();
+const stoptimes = await getStoptimes();
 
 // Get all stoptimes for a specific stop
-getStoptimes({
+const stoptimes = await getStoptimes({
   stop_id: '70011',
 });
 
 // Get all stoptimes for a specific trip, sorted by stop_sequence
-getStoptimes(
+const stoptimes = await getStoptimes(
   {
     trip_id: '37a',
   },
@@ -694,7 +680,7 @@ getStoptimes(
 );
 
 // Get all stoptimes for a specific stop and service_id
-getStoptimes({
+const stoptimes = await getStoptimes({
   stop_id: '70011',
   service_id: 'CT-16APR-Caltrain-Weekday-01',
 });
@@ -708,22 +694,22 @@ Queries trips and returns a promise. The result of the promise is an array of tr
 import { getTrips } from 'gtfs';
 
 // Get all trips
-getTrips();
+const trips = await getTrips();
 
 // Get trips for a specific route and direction
-getTrips({
+const trips = await getTrips({
   route_id: 'Lo-16APR',
   direction_id: 0
 });
 
 // Get trips for direction '' or null
-getTrips({
+const trips = await getTrips({
   route_id: 'Lo-16APR',
   direction_id: null
 });
 
 // Get trips for a specific route and direction limited by a service_id
-getTrips({
+const trips = await getTrips({
   route_id: 'Lo-16APR',
   direction_id: 0,
   service_id: '
@@ -738,7 +724,7 @@ Queries shapes and returns a promise. The result of the promise is an array of s
 import { getShapes } from 'gtfs';
 
 // Get all shapes for an agency
-getShapes();
+const shapes = await getShapes();
 ```
 
 `getShapes` allows passing a `route_id` in the query and it will query trips to find all shapes served by that `route_id`.
@@ -747,30 +733,24 @@ getShapes();
 import { getShapes } from 'gtfs';
 
 // Get all shapes for a specific route and direction
-getShapes({
+const shapes = await getShapes({
   route_id: 'Lo-16APR',
 });
-```
-
-`getShapes` allows passing a `trip_id` in the query and it will query trips to find all shapes served by that `trip_id`.
 
-```js
-import { getShapes } from 'gtfs';
-
-// Get all shapes for a specific trip_id
-getShapes({
+/*
+ * `getShapes` allows passing a `trip_id` in the query and it will query
+ * trips to find all shapes served by that `trip_id`.
+ */
+const shapes = await getShapes({
   trip_id: '37a',
 });
-```
-
-`getShapes` allows passing a `service_id` in the query and it will query trips to find all shapes served by that `service_id`.
-
-```js
-import { getShapes } from 'gtfs';
 
-// Get all shapes for a specific service_id
-.etShapes({
-  service_id: 'CT-16APR-Caltrain-Sunday-02'
+/*
+ * `getShapes` allows passing a `service_id` in the query and it will query
+ * trips to find all shapes served by that `service_id`.
+ */
+const shapes = await getShapes({
+  service_id: 'CT-16APR-Caltrain-Sunday-02',
 });
 ```
 
@@ -778,31 +758,29 @@ import { getShapes } from 'gtfs';
 
 Queries shapes and returns a promise. The result of the promise is an geoJSON object of shapes. All valid queries for `getShapes()` work for `getShapesAsGeoJSON()`.
 
-Returns geoJSON of shapes.
-
 ```js
 import { getShapesAsGeoJSON } from 'gtfs';
 
 // Get geoJSON of all routes in an agency
-getShapesAsGeoJSON();
+const shapesGeojson = await getShapesAsGeoJSON();
 
 // Get geoJSON of shapes for a specific route
-getShapesAsGeoJSON({
+const shapesGeojson = await getShapesAsGeoJSON({
   route_id: 'Lo-16APR',
 });
 
 // Get geoJSON of shapes for a specific trip
-getShapesAsGeoJSON({
+const shapesGeojson = await getShapesAsGeoJSON({
   trip_id: '37a',
 });
 
 // Get geoJSON of shapes for a specific `service_id`
-getShapesAsGeoJSON({
+const shapesGeojson = await getShapesAsGeoJSON({
   service_id: 'CT-16APR-Caltrain-Sunday-02',
 });
 
 // Get geoJSON of shapes for a specific `shape_id`
-getShapesAsGeoJSON({
+const shapesGeojson = await getShapesAsGeoJSON({
   shape_id: 'cal_sf_tam',
 });
 ```
@@ -815,10 +793,10 @@ Queries calendars and returns a promise. The result of the promise is an array o
 import { getCalendars } from 'gtfs';
 
 // Get all calendars for an agency
-getCalendars();
+const calendars = await getCalendars();
 
 // Get calendars for a specific `service_id`
-getCalendars({
+const calendars = await getCalendars({
   service_id: 'CT-16APR-Caltrain-Sunday-02',
 });
 ```
@@ -831,10 +809,10 @@ Queries calendar_dates and returns a promise. The result of the promise is an ar
 import { getCalendarDates } from 'gtfs';
 
 // Get all calendar_dates for an agency
-getCalendarDates();
+const calendarDates = await getCalendarDates();
 
 // Get calendar_dates for a specific `service_id`
-getCalendarDates({
+const calendarDates = await getCalendarDates({
   service_id: 'CT-16APR-Caltrain-Sunday-02',
 });
 ```
@@ -847,14 +825,46 @@ Queries fare_attributes and returns a promise. The result of the promise is an a
 import { getFareAttributes } from 'gtfs';
 
 // Get all `fare_attributes` for an agency
-getFareAttributes();
+const fareAttributes = await getFareAttributes();
 
 // Get `fare_attributes` for a specific `fare_id`
-getFareAttributes({
+const fareAttributes = await getFareAttributes({
   fare_id: '123',
 });
 ```
 
+### getFareLegRules(query, fields, sortBy)
+
+Queries fare leg rules and returns a promise. The result of the promise is an array of fare leg rules.
+
+```js
+import { getFareLegRules } from 'gtfs';
+
+// Get all fare leg rules
+const fareLegRules = await getFareLegRules();
+
+// Get fare leg rules for a specific fare product
+const fareLegRules = await getFareLegRules({
+  fare_product_id: 'product1',
+});
+```
+
+### getFareProducts(query, fields, sortBy)
+
+Queries fare products and returns a promise. The result of the promise is an array of fare products.
+
+```js
+import { getFareProducts } from 'gtfs';
+
+// Get all fare products
+const fareProducts = await getFareProducts();
+
+// Get a specific fare product
+const fareProducts = await getFareProducts({
+  fare_product_id: 'product1',
+});
+```
+
 ### getFareRules(query, fields, sortBy)
 
 Queries fare_rules and returns a promise. The result of the promise is an array of fare_rules.
@@ -863,14 +873,30 @@ Queries fare_rules and returns a promise. The result of the promise is an array
 import { getFareRules } from 'gtfs';
 
 // Get all `fare_rules` for an agency
-getFareRules();
+const fareRules = await getFareRules();
 
 // Get fare_rules for a specific route
-getFareRules({
+const fareRules = await getFareRules({
   route_id: 'Lo-16APR',
 });
 ```
 
+### getFareTransferRules(query, fields, sortBy)
+
+Queries fare transfer rules and returns a promise. The result of the promise is an array of fare transfer rules.
+
+```js
+import { getFareTransferRules } from 'gtfs';
+
+// Get all fare transfer rules
+const fareTransferRules = await getFareTransferRules();
+
+// Get a all fare transfer rules for a specific fare product
+const fareTransferRules = await getFareTransferRules({
+  fare_product_id: 'product1',
+});
+```
+
 ### getFeedInfo(query, fields, sortBy)
 
 Queries feed_info and returns a promise. The result of the promise is an array of feed_infos.
@@ -879,7 +905,7 @@ Queries feed_info and returns a promise. The result of the promise is an array o
 import { getFeedInfo } from 'gtfs';
 
 // Get feed_info
-getFeedInfo();
+const feedInfo = await getFeedInfo();
 ```
 
 ### getFrequencies(query, fields, sortBy)
@@ -890,10 +916,10 @@ Queries frequencies and returns a promise. The result of the promise is an array
 import { getFrequencies } from 'gtfs';
 
 // Get all frequencies
-getFrequencies();
+const frequencies = await getFrequencies();
 
 // Get frequencies for a specific trip
-getFrequencies({
+const frequencies = await getFrequencies({
   trip_id: '1234',
 });
 ```
@@ -905,8 +931,8 @@ Queries levels and returns a promise. The result of the promise is an array of l
 ```js
 import { getLevels } from 'gtfs';
 
-// Get levels
-getLevels();
+// Get all levels
+const levels = await getLevels();
 ```
 
 ### getPathways(query, fields, sortBy)
@@ -916,8 +942,8 @@ Queries pathways and returns a promise. The result of the promise is an array of
 ```js
 import { getPathways } from 'gtfs';
 
-// Get pathways
-getPathways();
+// Get all pathways
+const pathways = await getPathways();
 ```
 
 ### getTransfers(query, fields, sortBy)
@@ -928,10 +954,10 @@ Queries transfers and returns a promise. The result of the promise is an array o
 import { getTransfers } from 'gtfs';
 
 // Get all transfers
-getTransfers();
+const transfers = await getTransfers();
 
 // Get transfers for a specific stop
-getTransfers({
+const transfers = await getTransfers({
   from_stop_id: '1234',
 });
 ```
@@ -943,8 +969,8 @@ Queries translations and returns a promise. The result of the promise is an arra
 ```js
 import { getTranslations } from 'gtfs';
 
-// Get translations
-getTranslations();
+// Get all translations
+const translations = await getTranslations();
 ```
 
 ### getDirections(query, fields, sortBy)
@@ -955,20 +981,31 @@ Queries directions and returns a promise. The result of the promise is an array
 import { getDirections } from 'gtfs';
 
 // Get all directions
-getDirections();
+const directions = await getDirections();
 
 // Get directions for a specific route
-getDirections({
+const directions = await getDirections({
   route_id: '1234',
 });
 
 // Get directions for a specific route and direction
-getDirections({
+const directions = await getDirections({
   route_id: '1234',
   direction_id: 1,
 });
 ```
 
+### getStopAreas(query, fields, sortBy)
+
+Queries stop areas and returns a promise. The result of the promise is an array of stop areas.
+
+```js
+import { getStopAreas } from 'gtfs';
+
+// Get all stop areas
+const stopAreas = await getStopAreas();
+```
+
 ### getStopAttributes(query, fields, sortBy)
 
 Queries stop_attributes and returns a promise. The result of the promise is an array of stop_attributes. These are from the non-standard `stop_attributes.txt` file. See [documentation and examples of this file](https://gtfstohtml.com/docs/stop-attributes).
@@ -977,10 +1014,10 @@ Queries stop_attributes and returns a promise. The result of the promise is an a
 import { getStopAttributes } from 'gtfs';
 
 // Get all stop attributes
-getStopAttributes();
+const stopAttributes = await getStopAttributes();
 
 // Get stop attributes for specific stop
-getStopAttributes({
+const stopAttributes = await getStopAttributes({
   stop_id: '1234',
 });
 ```
@@ -993,10 +1030,10 @@ Queries timetables and returns a promise. The result of the promise is an array
 import { getTimetables } from 'gtfs';
 
 // Get all timetables for an agency
-getTimetables();
+const timetables = await getTimetables();
 
 // Get a specific timetable
-getTimetables({
+const timetables = await getTimetables({
   timetable_id: '1',
 });
 ```
@@ -1009,10 +1046,10 @@ Queries timetable_stop_orders and returns a promise. The result of the promise i
 import { getTimetableStopOrders } from 'gtfs';
 
 // Get all timetable_stop_orders
-getTimetableStopOrders();
+const timetableStopOrders = await getTimetableStopOrders();
 
 // Get timetable_stop_orders for a specific timetable
-getTimetableStopOrders({
+const timetableStopOrders = await getTimetableStopOrders({
   timetable_id: '1',
 });
 ```
@@ -1025,10 +1062,10 @@ Queries timetable_pages and returns a promise. The result of the promise is an a
 import { getTimetablePages } from 'gtfs';
 
 // Get all timetable_pages for an agency
-getTimetablePages();
+const timetablePages = await getTimetablePages();
 
 // Get a specific timetable_page
-getTimetablePages({
+const timetablePages = await getTimetablePages({
   timetable_page_id: '2',
 });
 ```
@@ -1041,10 +1078,10 @@ Queries timetable_notes and returns a promise. The result of the promise is an a
 import { getTimetableNotes } from 'gtfs';
 
 // Get all timetable_notes for an agency
-getTimetableNotes();
+const timetableNotes = await getTimetableNotes();
 
 // Get a specific timetable_note
-getTimetableNotes({
+const timetableNotes = await getTimetableNotes({
   note_id: '1',
 });
 ```
@@ -1057,10 +1094,10 @@ Queries timetable_notes_references and returns a promise. The result of the prom
 import { getTimetableNotesReferences } from 'gtfs';
 
 // Get all timetable_notes_references for an agency
-getTimetableNotesReferences();
+const timetableNotesReferences = await getTimetableNotesReferences();
 
 // Get all timetable_notes_references for a specific timetable
-getTimetableNotesReferences({
+const timetableNotesReferences = await getTimetableNotesReferences({
   timetable_id: '4',
 });
 ```
@@ -1073,7 +1110,7 @@ Queries trips_dated_vehicle_journey and returns a promise. The result of the pro
 import { getTripsDatedVehicleJourneys } from 'gtfs';
 
 // Get all timetable_stop_orders
-getTripsDatedVehicleJourneys();
+const tripsDatedVehicleJourneys = await getTripsDatedVehicleJourneys();
 ```
 
 ### getServiceAlerts(query, fields, sortBy)
@@ -1085,7 +1122,7 @@ These are only valid if you use GTFS-Realtime and have imported Service Alert da
 import { getServiceAlerts } from 'gtfs';
 
 // Get service alerts
-getServiceAlerts();
+const serviceAlerts = await getServiceAlerts();
 ```
 
 ### getTripUpdates(query, fields, sortBy)
@@ -1097,7 +1134,7 @@ These are only valid if you use GTFS-Realtime and have imported Trip Update data
 import { getTripUpdates } from 'gtfs';
 
 // Get all trip updates
-getTripUpdates();
+const tripUpdates = await getTripUpdates();
 ```
 
 ### getStopTimesUpdates(query, fields, sortBy)
@@ -1109,7 +1146,7 @@ These are only valid if you use GTFS-Realtime and have imported Trip Update data
 import { getStopTimesUpdates } from 'gtfs';
 
 // Get all stop times updates
-getStopTimesUpdates();
+const stopTimesUpdates = await getStopTimesUpdates();
 ```
 
 ### getVehiclePositions(query, fields, sortBy)
@@ -1121,7 +1158,7 @@ These are only valid if you use GTFS-Realtime and have imported Vehicle Position
 import { getVehiclePositions } from 'gtfs';
 
 // Get all vehicle position data
-getVehiclePositions();
+const vehiclePositions = await getVehiclePositions();
 ```
 
 ### advancedQuery(table, advancedQueryOptions)
@@ -1146,8 +1183,9 @@ const advancedQueryOptions = {
     },
   ],
 };
+
 // Perform a custom query
-advancedQuery('stop_times', advancedQueryOptions);
+const stoptimes = await advancedQuery('stop_times', advancedQueryOptions);
 ```
 
 ### runRawQuery(query)
@@ -1159,7 +1197,9 @@ The result of the promise is an array the selected data.
 import { runRawQuery } from 'gtfs';
 
 // Perform a raw query
-runRawQuery('SELECT * FROM stop_times WHERE stop_sequence="1"');
+const stoptimes = await runRawQuery(
+  'SELECT * FROM stop_times WHERE stop_sequence="1"'
+);
 ```
 
 ### execRawQuery(query)
@@ -1170,7 +1210,7 @@ Executes a statement. Returns a promise containing the result of the execute.
 import { execRawQuery } from 'gtfs';
 
 // Purge trips table
-execRawQuery('DELETE FROM trips');
+await execRawQuery('DELETE FROM trips');
 ```
 
 ## Contributing