transit-departures-widget 2.0.0 → 2.1.1

package/CHANGELOG.md

@@ -5,6 +5,34 @@ 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.1.1] - 2023-12-04
+
+## Fixed
+
+- Fix for routes with no directions
+
+## Updated
+
+ - Dependency updates
+
+## [2.1.0] - 2023-09-13
+
+## Changed
+
+- Remove last stop of each route
+- Improved autocomplete sorting
+- Use stop_code as value in autocomplete
+- Populate route dropdown on page load
+
+## Fixed
+
+- Fix for grouping child stops
+- Handle case with no departures
+
+## Updated
+
+ - Dependency updates
+
 ## [2.0.0] - 2023-09-14
 
 ## Changed

package/README.md

@@ -52,9 +52,10 @@ An demo of the widget is available at https://transit-departures-widget.blinktag
 
 ## Current Usage
 
-The following transit agencies use `transit-departures-widget` as the departures tool on their websites:
+The following transit agencies use `transit-departures-widget` on their websites:
 
 - [Marin Transit](https://marintransit.org/)
+- [MVgo](https://mvgo.org/)
 
 ## Command Line Usage
 

package/lib/utils.js

@@ -126,6 +126,9 @@ function getStopsForDirection(route, direction, config) {
     return memo
   }, [])
 
+  // Remove last stop of route since boarding is not allowed
+  deduplicatedStopIds.pop()
+
   // Fetch stop details
   const stops = getStops({ stop_id: deduplicatedStopIds }, [
     'stop_id',
@@ -162,7 +165,7 @@ export function generateTransitDeparturesWidgetHtml(config) {
       config.logWarning(
         `route_id ${route.route_id} has no directions - skipping`,
       )
-      return
+      continue
     }
 
     for (const direction of directions) {
@@ -181,23 +184,29 @@ export function generateTransitDeparturesWidgetHtml(config) {
     filteredRoutes.push(route)
   }
 
-  // Sort twice to handle integers with alphabetical characters, such as ['14', '14L', '14X']
+  // Sort routes twice to handle integers with alphabetical characters, such as ['14', '14L', '14X']
   const sortedRoutes = sortBy(
     sortBy(filteredRoutes, (route) => route.route_short_name?.toLowerCase()),
     (route) => Number.parseInt(route.route_short_name, 10),
   )
 
-  // Sort unique list of stops and indicate parent stations
-  const sortedStops = sortBy(uniqBy(stops, 'stop_id'), 'stop_name')
-  const parentStationIds = new Set(
-    sortedStops.map((stop) => stop.parent_station),
+  // Get Parent Station Stops
+  const parentStationIds = new Set(stops.map((stop) => stop.parent_station))
+
+  const parentStationStops = getStops(
+    { stop_id: Array.from(parentStationIds) },
+    ['stop_id', 'stop_name', 'stop_code', 'parent_station'],
   )
 
-  for (const stop of sortedStops) {
-    if (parentStationIds.has(stop.stop_id)) {
+  stops.push(
+    ...parentStationStops.map((stop) => {
       stop.is_parent_station = true
-    }
-  }
+      return stop
+    }),
+  )
+
+  // Sort unique list of stops
+  const sortedStops = sortBy(uniqBy(stops, 'stop_id'), 'stop_name')
 
   const templateVars = {
     __: i18n.__,

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.0.0",
+  "version": "2.1.1",
   "keywords": [
     "transit",
     "gtfs",
@@ -31,9 +31,9 @@
   "dependencies": {
     "copy-dir": "^1.3.0",
     "express": "^4.18.2",
-    "gtfs": "^4.4.3",
+    "gtfs": "^4.5.1",
     "i18n": "^0.15.1",
-    "js-beautify": "^1.14.9",
+    "js-beautify": "^1.14.11",
     "lodash-es": "^4.17.21",
     "morgan": "^1.10.0",
     "pretty-error": "^4.0.0",
@@ -48,8 +48,8 @@
   },
   "devDependencies": {
     "husky": "^8.0.3",
-    "lint-staged": "^13.2.3",
-    "prettier": "^3.0.1"
+    "lint-staged": "^15.2.0",
+    "prettier": "^3.1.0"
   },
   "engines": {
     "node": ">= 14.15.4"

package/public/js/transit-departures-widget.js

@@ -1,7 +1,7 @@
 /* global window, $, jQuery, _, Pbf, FeedMessage, alert, accessibleAutocomplete,  */
 /* eslint no-var: "off", no-unused-vars: "off", no-alert: "off" */
 
-function setuptransitDeparturesWidget(routes, stops, config) {
+function setupTransitDeparturesWidget(routes, stops, config) {
   let departuresResponse
   let departuresTimeout
   let initialStop
@@ -65,6 +65,15 @@ function setuptransitDeparturesWidget(routes, stops, config) {
   }
 
   jQuery(($) => {
+    // Populate dropdown with all routes
+    $('#departure_route').append(
+      routes.map((route) => {
+        return $('<option>')
+          .attr('value', route.route_id)
+          .text(route.route_full_name)
+      }),
+    )
+
     // Read URL parameters on load
     readUrlWithParameters()
 
@@ -85,7 +94,7 @@ function setuptransitDeparturesWidget(routes, stops, config) {
         return
       }
 
-      initialStop = stop.stop_name
+      initialStop = stop.stop_code || stop.stop_name
 
       // Wait for bootstrap js to initialize before triggering click
       setTimeout(() => {
@@ -112,20 +121,25 @@ function setuptransitDeparturesWidget(routes, stops, config) {
       $('#loading').hide()
     }
 
-    function renderStopInfo(stop) {
-      if (stop) {
+    function renderStopInfo(selectedStops) {
+      if (selectedStops && selectedStops.length > 0) {
         $('#departure_results .departure-results-stop-unknown').hide()
         $('#departure_results .departure-results-stop')
-          .text(stop.stop_name)
+          .text(selectedStops[0].stop_name)
           .show()
       } else {
         $('#departure_results .departure-results-stop').hide()
         $('#departure_results .departure-results-stop-unknown').show()
       }
 
-      if (stop && stop.stop_code) {
+      if (
+        selectedStops &&
+        selectedStops.length === 1 &&
+        selectedStops[0].stop_code &&
+        !selectedStops[0].is_parent_station
+      ) {
         $('#departure_results .departure-results-stop-code').text(
-          stop.stop_code,
+          selectedStops[0].stop_code,
         )
         $('#departure_results .departure-results-stop-code-container').show()
       } else {
@@ -169,17 +183,12 @@ function setuptransitDeparturesWidget(routes, stops, config) {
         .appendTo(routeNameDiv)
 
       const sortedDepartures = _.take(
-        _.sortBy(
-          departureGroup,
-          (departure) => departure.stoptime.departure.time,
-        ),
+        _.sortBy(departureGroup, (departure) => departure.time),
         3,
       )
 
       for (const departure of sortedDepartures) {
-        const minutes = formatMinutes(
-          departure.stoptime.departure.time - Date.now() / 1000,
-        )
+        const minutes = formatMinutes(departure.time - Date.now() / 1000)
         const minutesLabel = $(
           '#departure_results .departure-results-container',
         ).data('minutes-label')
@@ -199,8 +208,8 @@ function setuptransitDeparturesWidget(routes, stops, config) {
       return div
     }
 
-    function renderResults(stop, departures) {
-      renderStopInfo(stop)
+    function renderResults(selectedStops, departures) {
+      renderStopInfo(selectedStops)
 
       if (departures.length === 0) {
         $('#departure_results .departure-results-container').hide()
@@ -234,22 +243,54 @@ function setuptransitDeparturesWidget(routes, stops, config) {
       $('#departure_results').show()
     }
 
-    function renderError(stop) {
-      renderStopInfo(stop)
+    function renderError(selectedStops) {
+      renderStopInfo(selectedStops)
       $('#departure_results .departure-results-error').show()
 
       hideLoading()
       $('#departure_results').show()
     }
 
-    function selectStop({ stopId, stopName, directionId, routeId }) {
+    function findStops(stopId, stopName) {
+      let selectedStops
+      if (stopId !== undefined) {
+        const selectedStop = stops.find((stop) => stop.stop_id === stopId)
+
+        if (selectedStop) {
+          selectedStops = [selectedStop]
+        }
+      } else {
+        selectedStops = stops.filter(
+          (stop) =>
+            stop.stop_id === stopName ||
+            stop.stop_code === stopName ||
+            stop.stop_name === stopName,
+        )
+      }
+
+      if (selectedStops) {
+        // Use parent stop if it exists
+        for (const stop of selectedStops) {
+          if (stop.parent_station !== null) {
+            const parentStationStop = stops.find(
+              (s) => s.stop_id === stop.parent_station,
+            )
+            if (parentStationStop) {
+              return [parentStationStop]
+            }
+          }
+        }
+
+        return selectedStops
+      }
+
+      // No stops found
+      return undefined
+    }
+
+    function selectParameters({ stopId, stopName, directionId, routeId }) {
       $('.stop-code-invalid').hide()
-      const stop = stops.find(
-        (stop) =>
-          stop.stop_id === stopId ||
-          stop.stop_name === stopName ||
-          stop.stop_code === stopName,
-      )
+      const selectedStops = findStops(stopId, stopName)
       const route = routes.find((route) => route.route_id === routeId)
       const direction = route
         ? route.directions.find(
@@ -258,12 +299,12 @@ function setuptransitDeparturesWidget(routes, stops, config) {
           )
         : undefined
 
-      if (!stop) {
+      if (!selectedStops || selectedStops.length === 0) {
         $('.stop-code-invalid').show()
         return
       }
 
-      selectedParameters = { stop, direction, route }
+      selectedParameters = { selectedStops, direction, route }
 
       resetResults()
       showLoading()
@@ -299,7 +340,7 @@ function setuptransitDeparturesWidget(routes, stops, config) {
       }
     }
 
-    function filterDepartures(departures, { stop, direction, route }) {
+    function filterDepartures(departures, { selectedStops, direction, route }) {
       // Remove departure information for last stoptime by stop_sequence if it has any
       const cleanedDepartures = departures.map((departure) => {
         const stopTimeUpdates = departure?.trip_update?.stop_time_update
@@ -312,6 +353,13 @@ function setuptransitDeparturesWidget(routes, stops, config) {
         return departure
       })
 
+      const selectedStopIds = selectedStops.flatMap((stop) => {
+        return stop.is_parent_station
+          ? stops
+              .filter((s) => s.parent_station === stop.stop_id)
+              .map((stop) => stop.stop_id)
+          : [stop.stop_id]
+      })
       const filteredDepartures = []
 
       for (const departure of cleanedDepartures) {
@@ -335,7 +383,7 @@ function setuptransitDeparturesWidget(routes, stops, config) {
 
           filteredDeparture.route = route
           filteredDeparture.direction = direction
-        } else if (stop) {
+        } else if (selectedStops && selectedStops.length > 0) {
           if (
             !departure ||
             !departure.trip_update ||
@@ -350,31 +398,24 @@ function setuptransitDeparturesWidget(routes, stops, config) {
           )
         }
 
-        filteredDeparture.stoptime =
-          departure.trip_update.stop_time_update.find(
-            (stopTimeUpdate) => stopTimeUpdate.stop_id === stop.stop_id,
-          )
+        const stoptime = departure.trip_update.stop_time_update.find(
+          (stopTimeUpdate) => selectedStopIds.includes(stopTimeUpdate.stop_id),
+        )
 
-        if (
-          !filteredDeparture.stoptime ||
-          !filteredDeparture.stoptime.departure
-        ) {
+        if (!stoptime || (!stoptime.arrival && !stoptime.departure)) {
           continue
         }
 
+        filteredDeparture.time =
+          stoptime.departure?.time ?? stoptime.arrival?.time
+
         // Hide departures more than 90 minutes in the future
-        if (
-          filteredDeparture.stoptime.departure.time - Date.now() / 1000 >
-          90 * 60
-        ) {
+        if (filteredDeparture.time - Date.now() / 1000 > 90 * 60) {
           continue
         }
 
         // Hide departures more than 1 minute in the past
-        if (
-          filteredDeparture.stoptime.departure.time - Date.now() / 1000 <
-          -60
-        ) {
+        if (filteredDeparture.time - Date.now() / 1000 < -60) {
           continue
         }
 
@@ -386,7 +427,7 @@ function setuptransitDeparturesWidget(routes, stops, config) {
 
     async function updateDepartures(forceRefresh) {
       try {
-        const { stop, direction, route } = selectedParameters
+        const { selectedStops, direction, route } = selectedParameters
         // Use existing data if less than the refresh interval seconds old
         const minimumAge = Date.now() - config.refreshIntervalSeconds * 1000
         if (
@@ -396,8 +437,8 @@ function setuptransitDeparturesWidget(routes, stops, config) {
         ) {
           const departures = await fetchTripUpdates()
 
-          // Don't use new departure info if nothing is returned.
-          if (!departures || departures.length === 0) {
+          // Don't use new departure info if nothing is returned
+          if (!departures) {
             console.error('No departures returned')
             return
           }
@@ -406,20 +447,20 @@ function setuptransitDeparturesWidget(routes, stops, config) {
         }
 
         renderResults(
-          stop,
+          selectedStops,
           filterDepartures(departuresResponse.departures, {
-            stop,
+            selectedStops,
             direction,
             route,
           }),
         )
 
-        if (stop.stop_id) {
-          updateUrlWithStop(stop)
+        if (selectedStops && selectedStops.length > 0) {
+          updateUrlWithStop(selectedStops[0])
         }
       } catch (error) {
         console.error(error)
-        renderError(selectedParameters?.stop)
+        renderError(selectedParameters?.selectedStops)
       }
     }
 
@@ -527,7 +568,7 @@ function setuptransitDeparturesWidget(routes, stops, config) {
       const directionId = $('#real_time_departures #departure_direction').val()
       const stopId = $(event.target).val()
 
-      selectStop({
+      selectParameters({
         stopId,
         routeId,
         directionId,
@@ -545,7 +586,7 @@ function setuptransitDeparturesWidget(routes, stops, config) {
         return
       }
 
-      selectStop({
+      selectParameters({
         stopName,
       })
     })
@@ -562,20 +603,31 @@ function setuptransitDeparturesWidget(routes, stops, config) {
       id: 'departure_stop_code',
       source(query, populateResults) {
         const filteredResults = stops.filter((stop) => {
+          // Don't list child stations
+          if (stop.parent_station !== null) {
+            return false
+          }
+
           if (stop.stop_code?.startsWith(query.trim())) {
             return true
           }
 
           return stop.stop_name?.toLowerCase().includes(query.toLowerCase())
         })
-        populateResults(filteredResults)
+        const sortedResults = _.sortBy(filteredResults, (stop) =>
+          stop.stop_name?.toLowerCase().startsWith(query.toLowerCase().trim())
+            ? 0
+            : 1,
+        )
+        populateResults(sortedResults)
       },
       minLength: 2,
       autoselect: true,
       placeholder: $('#departure_stop_code_container').data('placeholder'),
       showNoOptionsFound: false,
       templates: {
-        inputValue: (result) => result && result.stop_name,
+        inputValue: (result) =>
+          result && (result.stop_code || result.stop_name),
         suggestion(result) {
           if (!result) {
             return
@@ -603,7 +655,9 @@ function setuptransitDeparturesWidget(routes, stops, config) {
           return
         }
 
-        $('#departure_stop_code').val(selectedStop.stop_name)
+        $('#departure_stop_code').val(
+          selectedStop.stop_code || selectedStop.stop_name,
+        )
         $('#stop_form').trigger('submit')
       },
       defaultValue: initialStop,

package/views/widget/widget.pug

@@ -23,8 +23,6 @@
         .form-group.select
           select.form-control#departure_route(name="route")
             option(value="")= __('Choose a route')
-            each route in routes
-              option(value=route.route_id)= route.route_full_name
         
         .form-group.select
           select.form-control#departure_direction(name="direction" disabled)
@@ -59,5 +57,5 @@ script.
       refreshIntervalSeconds: #{config.refreshIntervalSeconds},
       timeFormat: '#{config.timeFormat}'
     }
-    setuptransitDeparturesWidget(routes, stops, config);
+    setupTransitDeparturesWidget(routes, stops, config);
   })()