transit-departures-widget 2.1.1 → 2.2.0

package/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.2.0] - 2024-03-07
+
+## Added
+
+- startDate and endDate config params
+
+## Updated
+
+ - Dependency updates
+
 ## [2.1.1] - 2023-12-04
 
 ## Fixed

package/README.md

@@ -93,11 +93,13 @@ Copy `config-sample.json` to `config.json` and then add your projects configurat
 | --------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------- |
 | [`agency`](#agency)                                 | object  | Information about the GTFS and GTFS-RT to be used.                                             |
 | [`beautify`](#beautify)                             | boolean | Whether or not to beautify the HTML output.                                                    |
+| [`endDAte`](#enddate)                         | string  | A date in YYYYMMDD format to use to filter calendar.txt service. Optional, defaults to using all service in specified GTFS.               |
 | [`locale`](#locale)                                 | string  | The 2-letter code of the language to use for the interface.                                    |
 | [`noHead`](#nohead)                                 | boolean | Whether or not to skip the header and footer of the HTML document.                             |
 | [`refreshIntervalSeconds`](#refreshIntervalSeconds) | integer | How often the widget should refresh departure data in seconds. Optional, defaults to 20 seconds. |
 | [`skipImport`](#skipimport)                         | boolean | Whether or not to skip importing GTFS data into SQLite.                                        |
 | [`sqlitePath`](#sqlitepath)                         | string  | A path to an SQLite database. Optional, defaults to using an in-memory database.               |
+| [`startDate`](#startdate)                         | string  | A date in YYYYMMDD format to use to filter calendar.txt service. Optional, defaults to using all service in specified GTFS.               |
 | [`templatePath`](#templatepath)                     | string  | Path to custom pug template for rendering widget.                                              |
 | [`timeFormat`](#timeFormat)                         | string  | The format (12hour or 24hour) for the "as of" display.                                         |
 
@@ -157,6 +159,14 @@ Copy `config-sample.json` to `config.json` and then add your projects configurat
     "beautify": false
 ```
 
+### endDate
+
+{Integer} A date in YYYYMMDD format to use to filter service_ids in calendar.txt. Useful in combination with `startDate` configuration option. Optional, if not specified, all services in GTFS will be used.
+
+```
+    "endDate": 20240401
+```
+
 ### locale
 
 {String} The 2-letter language code of the language to use for the interface. Current languages supported are Polish (`pl`) and English (`en`). Pull Requests welcome for translations to other languages. Defaults to `en` (English).
@@ -189,6 +199,14 @@ Copy `config-sample.json` to `config.json` and then add your projects configurat
     "skipImport": false
 ```
 
+### startDate
+
+{Integer} A date in YYYYMMDD format to use to filter service_ids in calendar.txt. Useful in combination with `endDate` configuration option. Optional, if not specified, all services in GTFS will be used.
+
+```
+    "startDate": 20240301
+```
+
 ### sqlitePath
 
 {String} A path to an SQLite database. Optional, defaults to using an in-memory database.

package/lib/utils.js

@@ -7,6 +7,29 @@ import sqlString from 'sqlstring-sqlite'
 import toposort from 'toposort'
 import i18n from 'i18n'
 
+/*
+ * Get calendars for a specified date range
+ */
+const getCalendarsForDateRange = (config) => {
+  const db = openDb(config)
+  let whereClause = ''
+  const whereClauses = []
+
+  if (config.endDate) {
+    whereClauses.push(`start_date <= ${sqlString.escape(config.endDate)}`)
+  }
+
+  if (config.startDate) {
+    whereClauses.push(`end_date >= ${sqlString.escape(config.startDate)}`)
+  }
+
+  if (whereClauses.length > 0) {
+    whereClause = `WHERE ${whereClauses.join(' AND ')}`
+  }
+
+  return db.prepare(`SELECT * FROM calendar ${whereClause}`).all()
+}
+
 /*
  * Format a route name.
  */
@@ -40,11 +63,15 @@ function getDirectionsForRoute(route, config) {
     'direction',
   ])
 
+  const calendars = getCalendarsForDateRange(config)
+
   // Else use the most common headsigns as directions from trips.txt file
   if (directions.length === 0) {
     const headsigns = db
       .prepare(
-        'SELECT direction_id, trip_headsign, count(*) AS count FROM trips WHERE route_id = ? GROUP BY direction_id, trip_headsign',
+        `SELECT direction_id, trip_headsign, count(*) AS count FROM trips WHERE route_id = ? AND service_id IN (${calendars
+          .map((calendar) => `'${calendar.service_id}'`)
+          .join(', ')}) GROUP BY direction_id, trip_headsign`,
       )
       .all(route.route_id)
 
@@ -105,9 +132,11 @@ function sortStopIdsBySequence(stoptimes) {
  */
 function getStopsForDirection(route, direction, config) {
   const db = openDb(config)
+  const calendars = getCalendarsForDateRange(config)
   const whereClause = formatWhereClauses({
     direction_id: direction.direction_id,
     route_id: route.route_id,
+    service_id: calendars.map((calendar) => calendar.service_id),
   })
   const stoptimes = db
     .prepare(
@@ -155,6 +184,8 @@ export function generateTransitDeparturesWidgetHtml(config) {
     updateFiles: false,
   })
 
+  const calendars = getCalendarsForDateRange(config)
+
   for (const route of routes) {
     route.route_full_name = formatRouteName(route)
 
@@ -174,7 +205,11 @@ export function generateTransitDeparturesWidgetHtml(config) {
       direction.stopIds = directionStops.map((stop) => stop.stop_id)
 
       const trips = getTrips(
-        { route_id: route.route_id, direction_id: direction.direction_id },
+        {
+          route_id: route.route_id,
+          direction_id: direction.direction_id,
+          service_id: calendars.map((calendar) => calendar.service_id),
+        },
         ['trip_id'],
       )
       direction.tripIds = trips.map((trip) => trip.trip_id)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "transit-departures-widget",
   "description": "Build a realtime transit departures tool from GTFS and GTFS-Realtime.",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "keywords": [
     "transit",
     "gtfs",
@@ -30,10 +30,10 @@
   "main": "index.js",
   "dependencies": {
     "copy-dir": "^1.3.0",
-    "express": "^4.18.2",
-    "gtfs": "^4.5.1",
+    "express": "^4.18.3",
+    "gtfs": "^4.7.2",
     "i18n": "^0.15.1",
-    "js-beautify": "^1.14.11",
+    "js-beautify": "^1.15.1",
     "lodash-es": "^4.17.21",
     "morgan": "^1.10.0",
     "pretty-error": "^4.0.0",
@@ -44,12 +44,12 @@
     "toposort": "^2.0.2",
     "untildify": "^5.0.0",
     "yargs": "^17.7.2",
-    "yoctocolors": "^1.0.0"
+    "yoctocolors": "^2.0.0"
   },
   "devDependencies": {
-    "husky": "^8.0.3",
-    "lint-staged": "^15.2.0",
-    "prettier": "^3.1.0"
+    "husky": "^9.0.11",
+    "lint-staged": "^15.2.2",
+    "prettier": "^3.2.5"
   },
   "engines": {
     "node": ">= 14.15.4"