gtfs 4.10.1 → 4.10.3

package/.github/workflows/nodejs.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ 18, 20 ]
+        node: [ 20, 21 ]
     name: Use Node.js ${{ matrix.node }}
     steps:
       - uses: actions/checkout@v4

package/@types/index.d.ts

@@ -160,6 +160,11 @@ export function openDb(config: DbConfig): Database.Database;
  */
 export function closeDb(db?: Database.Database): void;
 
+/**
+ * Deletes the specified database.
+ */
+export function deleteDb(db?: Database.Database): void;
+
 /**
  * Returns an array of agencies that match query parameters.
  */

package/CHANGELOG.md

@@ -5,6 +5,28 @@ 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.10.3] - 2024-05-12
+
+### Added
+
+- Additional GTFS-RT vehiclePosition fields
+- deleteDb method
+
+### Updated
+
+- Dependency updates
+
+## [4.10.2] - 2024-04-02
+
+### Added
+
+- Better error message for `gtfsrealtime-update` command
+- Support additional fields for vehiclePosition GTFS-Realtime data
+
+### Updated
+
+- Dependency updates
+
 ## [4.10.1] - 2024-03-29
 
 ### Updated

package/README.md

@@ -636,6 +636,20 @@ const db = openDb(config);
 closeDb(db);
 ```
 
+### Deleting a Database
+
+You can use `deleteDb` to delete a sqlite3 database from the filesystem.
+
+```js
+import { deleteDb, openDb } from 'gtfs';
+const db = openDb(config);
+
+// Do some stuff here
+
+// Delete the database
+deleteDb(db);
+```
+
 ### 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`:
@@ -1338,11 +1352,13 @@ const timetableNotesReferences = getTimetableNotesReferences({
 
 ### GTFS-Realtime
 
-In order to use GTFS-Realtime query methods, you must first configure GTFS Realtime import in node-gtfs
+In order to use GTFS-Realtime query methods, you must first run the [GTFS-Realtime update script or function](#gtfsrealtime-update-script) to pull data into your database.
 
 #### getServiceAlerts(query, fields, sortBy, options)
 
-Returns an array of GTFS Realtime service alerts that match query parameters. [Details on Service Alerts](https://gtfs.org/realtime/feed-entities/service-alerts/)
+Returns an array of GTFS Realtime service alerts that match query parameters. Note that this does not refresh the data from GTFS-Realtime feeds, it only fetches what is stored in the database. In order to fetch the latest service alerts from GTFS-Realtime feeds and store in your database, use the [GTFS-Realtime update script or function](#gtfsrealtime-update-script).
+
+[More details on Service Alerts](https://gtfs.org/realtime/feed-entities/service-alerts/)
 
 ```js
 import { getServiceAlerts } from 'gtfs';
@@ -1353,7 +1369,9 @@ const serviceAlerts = getServiceAlerts();
 
 #### getTripUpdates(query, fields, sortBy, options)
 
-Returns an array of GTFS Realtime trip updates that match query parameters. [Details on Trip Updates](https://gtfs.org/realtime/feed-entities/trip-updates/)
+Returns an array of GTFS Realtime trip updates that match query parameters. Note that this does not refresh the data from GTFS-Realtime feeds, it only fetches what is stored in the database. In order to fetch the latest trip updates from GTFS-Realtime feeds and store in your database, use the [GTFS-Realtime update script or function](#gtfsrealtime-update-script).
+
+[More details on Trip Updates](https://gtfs.org/realtime/feed-entities/trip-updates/)
 
 ```js
 import { getTripUpdates } from 'gtfs';
@@ -1364,7 +1382,9 @@ const tripUpdates = getTripUpdates();
 
 #### getStopTimeUpdates(query, fields, sortBy, options)
 
-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)
+Returns an array of GTFS Realtime stop time updates that match query parameters. Note that this does not refresh the data from GTFS-Realtime feeds, it only fetches what is stored in the database. In order to fetch the latest stop time updates from GTFS-Realtime feeds and store in your database, use the [GTFS-Realtime update script or function](#gtfsrealtime-update-script).
+
+[More details on Stop Time Updates](https://gtfs.org/realtime/feed-entities/trip-updates/#stoptimeupdate)
 
 ```js
 import { getStopTimeUpdates } from 'gtfs';
@@ -1375,7 +1395,9 @@ const stopTimeUpdates = getStopTimeUpdates();
 
 #### getVehiclePositions(query, fields, sortBy, options)
 
-Returns an array of GTFS Realtime vehicle positions that match query parameters. [Details on Vehicle Positions](https://gtfs.org/realtime/feed-entities/vehicle-positions/)
+Returns an array of GTFS Realtime vehicle positions that match query parameters. Note that this does not refresh the data from GTFS-Realtime feeds, it only fetches what is stored in the database. In order to fetch the latest vehicle positions from GTFS-Realtime feeds and store in your database, use the [GTFS-Realtime update script or function](#gtfsrealtime-update-script).
+
+[More details on Vehicle Positions](https://gtfs.org/realtime/feed-entities/vehicle-positions/)
 
 ```js
 import { getVehiclePositions } from 'gtfs';

package/lib/db.js

@@ -1,3 +1,5 @@
+import fs from 'fs';
+
 import Database from 'better-sqlite3';
 import untildify from 'untildify';
 
@@ -64,3 +66,27 @@ export function closeDb(db) {
   db.close();
   delete dbs[db.name];
 }
+
+export function deleteDb(db) {
+  if (Object.keys(dbs).length === 0) {
+    throw new Error(
+      'No database connection. Call `openDb(config)` before using any methods.',
+    );
+  }
+
+  if (!db) {
+    if (Object.keys(dbs).length > 1) {
+      throw new Error(
+        'Multiple database connections. Pass the db you want to delete as a parameter to `deleteDb`.',
+      );
+    }
+
+    db = dbs[Object.keys(dbs)[0]];
+  }
+
+  db.close();
+
+  fs.unlinkSync(db.name);
+
+  delete dbs[db.name];
+}

package/lib/gtfs.js

@@ -67,7 +67,7 @@ import { getRunEvents } from './ods/run-events.js';
 import { getRunsPieces } from './ods/runs-pieces.js';
 
 // Expose database connection
-import { openDb, closeDb } from './db.js';
+import { deleteDb, openDb, closeDb } from './db.js';
 
 // Advanced Query
 import { advancedQuery } from './advancedQuery.js';
@@ -238,6 +238,8 @@ const _openDb = openDb;
 export { _openDb as openDb };
 const _closeDb = closeDb;
 export { _closeDb as closeDb };
+const _deleteDb = deleteDb;
+export { _deleteDb as deleteDb };
 
 const _advancedQuery = advancedQuery;
 export { _advancedQuery as advancedQuery };

package/lib/import.js

@@ -107,22 +107,39 @@ function getDescendantProp(obj, desc, defaultvalue) {
   return obj;
 }
 
-const markRealtimeDataStale = (config, log) => {
-  const db = openDb(config);
+const markRealtimeDataStale = (config) => {
+  const log = _log(config);
+  const logError = _logError(config);
 
-  log(`Marking GTFS-Realtime data as stale..`);
-  db.prepare(`UPDATE vehicle_positions SET is_updated=0`).run();
-  db.prepare(`UPDATE trip_updates SET is_updated=0`).run();
-  db.prepare(`UPDATE stop_time_updates SET is_updated=0`).run();
-  db.prepare(`UPDATE service_alerts SET is_updated=0`).run();
-  db.prepare(`UPDATE service_alert_targets SET is_updated=0`).run();
-  log(`Marked GTFS-Realtime data as stale\r`, true);
+  try {
+    const db = openDb(config);
+
+    log(`Marking GTFS-Realtime data as stale`);
+    db.prepare(`UPDATE vehicle_positions SET is_updated=0`).run();
+    db.prepare(`UPDATE trip_updates SET is_updated=0`).run();
+    db.prepare(`UPDATE stop_time_updates SET is_updated=0`).run();
+    db.prepare(`UPDATE service_alerts SET is_updated=0`).run();
+    db.prepare(`UPDATE service_alert_targets SET is_updated=0`).run();
+    log(`Marked GTFS-Realtime data as stale\r`, true);
+  } catch (error) {
+    if (
+      error instanceof Error &&
+      error.code === 'SQLITE_ERROR' &&
+      error.message?.startsWith('no such table')
+    ) {
+      logError(
+        'Run `gtfs-import` before running the `gtfsrealtime-update` command to set up tables.',
+      );
+      throw error;
+    }
+  }
 };
 
-const cleanStaleRealtimeData = (config, log) => {
+const cleanStaleRealtimeData = (config) => {
+  const log = _log(config);
   const db = openDb(config);
 
-  log(`Cleaning stale GTFS-RT data..`);
+  log(`Cleaning stale GTFS-RT data`);
   db.prepare(`DELETE FROM vehicle_positions WHERE is_updated=0`).run();
   db.prepare(`DELETE FROM trip_updates WHERE is_updated=0`).run();
   db.prepare(`DELETE FROM stop_time_updates WHERE is_updated=0`).run();
@@ -708,7 +725,7 @@ export async function updateGtfsRealtime(initialConfig) {
       )} using SQLite database at ${config.sqlitePath}`,
     );
 
-    markRealtimeDataStale(config, log);
+    markRealtimeDataStale(config);
 
     await Promise.all(
       config.agencies.map(async (agency) => {
@@ -729,7 +746,7 @@ export async function updateGtfsRealtime(initialConfig) {
       }),
     );
 
-    cleanStaleRealtimeData(config, log);
+    cleanStaleRealtimeData(config);
     log(
       `Completed GTFS-Realtime refresh for ${pluralize(
         'agencies',

package/models/gtfs-realtime/vehicle-positions.js

@@ -39,6 +39,12 @@ const model = {
       source: 'vehicle.position.speed',
       default: null,
     },
+    {
+      name: 'current_stop_sequence',
+      type: 'integer',
+      source: 'vehicle.currentStopSequence',
+      default: null,
+    },
     {
       name: 'trip_id',
       type: 'varchar(255)',
@@ -46,6 +52,44 @@ const model = {
       source: 'vehicle.trip.tripId',
       default: null,
     },
+    {
+      name: 'trip_start_date',
+      type: 'varchar(255)',
+      index: true,
+      source: 'vehicle.trip.startDate',
+      default: null,
+    },
+    {
+      name: 'trip_start_time',
+      type: 'varchar(255)',
+      index: true,
+      source: 'vehicle.trip.startTime',
+      default: null,
+    },
+    {
+      name: 'congestion_level',
+      type: 'varchar(255)',
+      source: 'vehicle.congestionLevel',
+      default: null,
+    },
+    {
+      name: 'occupancy_status',
+      type: 'varchar(255)',
+      source: 'vehicle.occupancyStatus',
+      default: null,
+    },
+    {
+      name: 'occupancy_percentage',
+      type: 'integer',
+      source: 'vehicle.occupancyPercentage',
+      default: null,
+    },
+    {
+      name: 'vehicle_stop_status',
+      type: 'varchar(255)',
+      source: 'vehicle.vehicleStopStatus',
+      default: null,
+    },
     {
       name: 'vehicle_id',
       type: 'varchar(255)',
@@ -53,6 +97,24 @@ const model = {
       source: 'vehicle.vehicle.id',
       default: null,
     },
+    {
+      name: 'vehicle_label',
+      type: 'varchar(255)',
+      source: 'vehicle.vehicle.label',
+      default: null,
+    },
+    {
+      name: 'vehicle_license_plate',
+      type: 'varchar(255)',
+      source: 'vehicle.vehicle.licensePlate',
+      default: null,
+    },
+    {
+      name: 'vehicle_wheelchair_accessible',
+      type: 'varchar(255)',
+      source: 'vehicle.vehicle.wheelchairAccessible',
+      default: null,
+    },
     {
       name: 'timestamp',
       type: 'varchar(255)',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs",
-  "version": "4.10.1",
+  "version": "4.10.3",
   "description": "Import GTFS transit data into SQLite and query routes, stops, times, fares and more",
   "keywords": [
     "transit",
@@ -77,7 +77,7 @@
   },
   "dependencies": {
     "@turf/helpers": "^6.5.0",
-    "better-sqlite3": "^9.4.3",
+    "better-sqlite3": "^10.0.0",
     "csv-parse": "^5.5.5",
     "csv-stringify": "^6.4.6",
     "gtfs-realtime-bindings": "^1.1.1",

package/test/mocha/delete-db.js

@@ -0,0 +1,62 @@
+/* eslint-env mocha */
+
+import fs from 'fs';
+
+import config from '../test-config.js';
+import { deleteDb, openDb, importGtfs } from '../../index.js';
+
+const db2Config = {
+  agencies: [
+    {
+      ...config.agencies[0],
+      exclude: ['shapes'],
+    },
+  ],
+  verbose: false,
+  sqlitePath: './tmpdb2',
+};
+
+const db3Config = {
+  agencies: [
+    {
+      ...config.agencies[0],
+      exclude: ['shapes'],
+    },
+  ],
+  verbose: false,
+  sqlitePath: './tmpdb3',
+};
+
+describe('openDb():', () => {
+  before(async () => {});
+
+  after(() => {
+    // Delete extra databases
+    fs.rmSync(db2Config.sqlitePath, { force: true });
+    fs.rmSync(db3Config.sqlitePath, { force: true });
+  });
+
+  it('should allow deleting a database', async () => {
+    const db2 = openDb(db2Config);
+    await importGtfs(db2Config);
+
+    const db3 = openDb(db3Config);
+    await importGtfs(db3Config);
+
+    db2.name.should.equal('./tmpdb2');
+    db3.name.should.equal('./tmpdb3');
+
+    fs.existsSync(db2Config.sqlitePath).should.equal(true);
+    fs.existsSync(db3Config.sqlitePath).should.equal(true);
+
+    deleteDb(db2);
+
+    fs.existsSync(db2Config.sqlitePath).should.equal(false);
+    fs.existsSync(db3Config.sqlitePath).should.equal(true);
+
+    deleteDb(db3);
+
+    fs.existsSync(db2Config.sqlitePath).should.equal(false);
+    fs.existsSync(db3Config.sqlitePath).should.equal(false);
+  });
+});