transit-departures-widget 2.4.0 → 2.4.2

package/lib/utils.js

@@ -1,329 +0,0 @@
-import { fileURLToPath } from 'url'
-import { dirname, join } from 'path'
-import { openDb, getDirections, getRoutes, getStops, getTrips } from 'gtfs'
-import { groupBy, last, maxBy, size, sortBy, uniqBy } from 'lodash-es'
-import { renderFile } from './file-utils.js'
-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.
- */
-function formatRouteName(route) {
-  let routeName = ''
-
-  if (route.route_short_name !== null) {
-    routeName += route.route_short_name
-  }
-
-  if (route.route_short_name !== null && route.route_long_name !== null) {
-    routeName += ' - '
-  }
-
-  if (route.route_long_name !== null) {
-    routeName += route.route_long_name
-  }
-
-  return routeName
-}
-
-/*
- * Get directions for a route
- */
-function getDirectionsForRoute(route, config) {
-  const db = openDb(config)
-
-  // Lookup direction names from non-standard directions.txt file
-  const directions = getDirections({ route_id: route.route_id }, [
-    'direction_id',
-    '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 = ? AND service_id IN (${calendars
-          .map((calendar) => `'${calendar.service_id}'`)
-          .join(', ')}) GROUP BY direction_id, trip_headsign`,
-      )
-      .all(route.route_id)
-
-    for (const group of Object.values(groupBy(headsigns, 'direction_id'))) {
-      const mostCommonHeadsign = maxBy(group, 'count')
-      directions.push({
-        direction_id: mostCommonHeadsign.direction_id,
-        direction: i18n.__('To {{{headsign}}}', {
-          headsign: mostCommonHeadsign.trip_headsign,
-        }),
-      })
-    }
-  }
-
-  return directions
-}
-
-/*
- * Sort an array of stoptimes by stop_sequence using a directed graph
- */
-function sortStopIdsBySequence(stoptimes) {
-  const stoptimesGroupedByTrip = groupBy(stoptimes, 'trip_id')
-
-  // First, try using a directed graph to determine stop order.
-  try {
-    const stopGraph = []
-
-    for (const tripStoptimes of Object.values(stoptimesGroupedByTrip)) {
-      const sortedStopIds = sortBy(tripStoptimes, 'stop_sequence').map(
-        (stoptime) => stoptime.stop_id,
-      )
-
-      for (const [index, stopId] of sortedStopIds.entries()) {
-        if (index === sortedStopIds.length - 1) {
-          continue
-        }
-
-        stopGraph.push([stopId, sortedStopIds[index + 1]])
-      }
-    }
-
-    return toposort(stopGraph)
-  } catch {
-    // Ignore errors and move to next strategy.
-  }
-
-  // Finally, fall back to using the stop order from the trip with the most stoptimes.
-  const longestTripStoptimes = maxBy(
-    Object.values(stoptimesGroupedByTrip),
-    (stoptimes) => size(stoptimes),
-  )
-
-  return longestTripStoptimes.map((stoptime) => stoptime.stop_id)
-}
-
-/*
- * Get stops in order for a route and direction
- */
-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(
-      `SELECT stop_id, stop_sequence, trip_id FROM stop_times WHERE trip_id IN (SELECT trip_id FROM trips ${whereClause}) ORDER BY stop_sequence ASC`,
-    )
-    .all()
-
-  const sortedStopIds = sortStopIdsBySequence(stoptimes)
-
-  const deduplicatedStopIds = sortedStopIds.reduce((memo, stopId) => {
-    // Remove duplicated stop_ids in a row
-    if (last(memo) !== stopId) {
-      memo.push(stopId)
-    }
-
-    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',
-    'stop_name',
-    'stop_code',
-    'parent_station',
-  ])
-
-  return deduplicatedStopIds.map((stopId) =>
-    stops.find((stop) => stop.stop_id === stopId),
-  )
-}
-
-/*
- * Generate HTML for transit departures widget.
- */
-export function generateTransitDeparturesWidgetHtml(config) {
-  i18n.configure({
-    directory: join(dirname(fileURLToPath(import.meta.url)), '..', 'locales'),
-    defaultLocale: config.locale,
-    updateFiles: false,
-  })
-
-  const templateVars = {
-    __: i18n.__,
-    config,
-  }
-  return renderFile('widget', templateVars, config)
-}
-
-/*
- * Generate JSON of routes and stops for transit departures widget.
- */
-export function generateTransitDeparturesWidgetJson(config) {
-  const routes = getRoutes()
-  const stops = []
-  const filteredRoutes = []
-  const calendars = getCalendarsForDateRange(config)
-
-  for (const route of routes) {
-    route.route_full_name = formatRouteName(route)
-
-    const directions = getDirectionsForRoute(route, config)
-
-    // Filter out routes with no directions
-    if (directions.length === 0) {
-      config.logWarning(
-        `route_id ${route.route_id} has no directions - skipping`,
-      )
-      continue
-    }
-
-    for (const direction of directions) {
-      const directionStops = getStopsForDirection(route, direction, config)
-      stops.push(...directionStops)
-      direction.stopIds = directionStops.map((stop) => stop.stop_id)
-
-      const trips = getTrips(
-        {
-          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)
-    }
-
-    route.directions = directions
-    filteredRoutes.push(route)
-  }
-
-  // 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),
-  )
-
-  // 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'],
-  )
-
-  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')
-
-  return {
-    routes: removeNulls(sortedRoutes),
-    stops: removeNulls(sortedStops),
-  }
-}
-
-/*
- * Remove null values from array or object
- */
-function removeNulls(data) {
-  if (Array.isArray(data)) {
-    return data
-      .map(removeNulls)
-      .filter((item) => item !== null && item !== undefined)
-  } else if (typeof data === 'object' && data !== null) {
-    return Object.entries(data).reduce((acc, [key, value]) => {
-      const cleanedValue = removeNulls(value)
-      if (cleanedValue !== null && cleanedValue !== undefined) {
-        acc[key] = cleanedValue
-      }
-      return acc
-    }, {})
-  } else {
-    return data
-  }
-}
-
-/*
- * Initialize configuration with defaults.
- */
-export function setDefaultConfig(initialConfig) {
-  const defaults = {
-    beautify: false,
-    noHead: false,
-    refreshIntervalSeconds: 20,
-    skipImport: false,
-    timeFormat: '12hour',
-  }
-
-  return Object.assign(defaults, initialConfig)
-}
-
-export function formatWhereClause(key, value) {
-  if (Array.isArray(value)) {
-    let whereClause = `${sqlString.escapeId(key)} IN (${value
-      .filter((v) => v !== null)
-      .map((v) => sqlString.escape(v))
-      .join(', ')})`
-
-    if (value.includes(null)) {
-      whereClause = `(${whereClause} OR ${sqlString.escapeId(key)} IS NULL)`
-    }
-
-    return whereClause
-  }
-
-  if (value === null) {
-    return `${sqlString.escapeId(key)} IS NULL`
-  }
-
-  return `${sqlString.escapeId(key)} = ${sqlString.escape(value)}`
-}
-
-export function formatWhereClauses(query) {
-  if (Object.keys(query).length === 0) {
-    return ''
-  }
-
-  const whereClauses = Object.entries(query).map(([key, value]) =>
-    formatWhereClause(key, value),
-  )
-  return `WHERE ${whereClauses.join(' AND ')}`
-}

package/locales/en.json

@@ -1,20 +0,0 @@
-{
-  "Realtime Departures": "Realtime Departures",
-  "By Stop": "By Stop",
-  "By Route": "By Route",
-  "Search by stop name or stop code": "Search by stop name or stop code",
-  "all": "all",
-  "Invalid stop code": "Invalid stop code",
-  "Get Departures": "Get Departures",
-  "Choose a route": "Choose a route",
-  "Choose a direction": "Choose a direction",
-  "Choose a stop": "Choose a stop",
-  "Loading": "Loading",
-  "Unknown Stop": "Unknown Stop",
-  "As of": "As of",
-  "Stop Code": "Stop Code",
-  "min": "min",
-  "No upcoming departures": "No upcoming departures",
-  "Unable to fetch departures": "Unable to fetch departures",
-  "To {{{headsign}}}": "To {{{headsign}}}"
-}

package/locales/pl.json

@@ -1,20 +0,0 @@
-{
-  "Realtime Departures": "Przyjazdy w czasie rzeczywistym",
-  "By Stop": "Wg przystanku",
-  "By Route": "Wg linii",
-  "Search by stop name or stop code": "Wyszukaj po nazwie przystanku lub jego identyfikatorze",
-  "all": "wszystkie",
-  "Invalid stop code": "Nieprawidłowy identyfikator przystanku",
-  "Get Departures": "Uzyskaj przyjazdy",
-  "Choose a route": "Wybierz linię",
-  "Choose a direction": "Wybierz kierunek",
-  "Choose a stop": "Wybierz przystanek",
-  "Loading": "Ładowanie",
-  "Unknown Stop": "Nieznany przystanek",
-  "As of": "Aktualizacja",
-  "Stop Code": "Przystanek",
-  "min": "min",
-  "No upcoming departures": "Brak nadchodzących przyjazdów",
-  "Unable to fetch departures": "Nie można było pobrać przyjazdów",
-  "To {{{headsign}}}": "Do {{{headsign}}}"
-}

package/public/css/transit-departures-widget-styles.css

@@ -1,200 +0,0 @@
-/* General Styles */
-
-body {
-  font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
-  font-size: 14px;
-  line-height: 1.4;
-  color: #333333;
-  background-color: #ffffff;
-}
-
-.transit-departures-widget {
-  max-width: 600px;
-}
-
-.transit-departures-widget .hidden-form {
-  display: none;
-}
-
-.transit-departures-widget .stop-code-invalid {
-  display: none;
-  color: #821515;
-  padding-bottom: 10px;
-}
-
-.transit-departures-widget .departure-results {
-  display: none;
-  margin-top: 25px;
-}
-
-.transit-departures-widget .departure-results-none {
-  display: none;
-  margin-top: 10px;
-}
-
-.transit-departures-widget .departure-results-error {
-  display: none;
-  margin-top: 10px;
-  color: #821515;
-}
-
-.transit-departures-widget .departure-results-stop,
-.transit-departures-widget .departure-results-stop-unknown {
-  font-size: 24px;
-  line-height: 1;
-}
-
-.transit-departures-widget .departure-result {
-  background-color: #eee;
-  display: flex;
-  align-items: center;
-  justify-content: space-between;
-  margin-top: 8px;
-}
-
-.transit-departures-widget .departure-results-header {
-  display: flex;
-  justify-content: space-between;
-  align-items: flex-end;
-}
-
-.transit-departures-widget .departure-results-fetchtime {
-  flex-shrink: 0;
-  font-size: 12px;
-  margin-left: 8px;
-  padding: 0 0 0 15px;
-  border: none;
-  background-color: transparent;
-  background-image: url('../img/refresh.svg');
-  background-repeat: no-repeat;
-  background-size: 12px 12px;
-  background-position-y: 1px;
-}
-
-.transit-departures-widget .departure-results-fetchtime:hover {
-  text-decoration: underline;
-}
-
-.transit-departures-widget .departure-result-route-name {
-  display: flex;
-  align-items: center;
-  line-height: 1;
-}
-
-.transit-departures-widget .departure-result-route-direction {
-  font-size: 22px;
-  margin-top: 2px;
-}
-
-.transit-departures-widget .departure-result-route-circle {
-  margin: 5px 9px 5px;
-  width: 30px;
-  height: 30px;
-  border-radius: 50%;
-  line-height: 30px;
-  text-align: center;
-  flex-shrink: 0;
-  overflow: hidden;
-}
-
-.transit-departures-widget .departure-result-times {
-  display: flex;
-  align-items: stretch;
-  flex-shrink: 0;
-  align-self: stretch;
-}
-
-.transit-departures-widget .departure-result-time-container {
-  padding: 0 5px;
-  width: 76px;
-  border-left: 1px solid #ddd;
-  align-self: stretch;
-  display: flex;
-  align-items: center;
-  justify-content: center;
-  flex-shrink: 0;
-  flex-grow: 0;
-}
-
-.transit-departures-widget .departure-result-time {
-  font-size: 24px;
-}
-
-.transit-departures-widget .departure-result-time-label {
-  font-size: 14px;
-  padding-left: 2px;
-}
-
-.transit-departures-widget .loader,
-.transit-departures-widget .loader:after {
-  border-radius: 50%;
-  width: 10em;
-  height: 10em;
-}
-
-.transit-departures-widget .loader {
-  margin: 20px auto;
-  font-size: 10px;
-  position: relative;
-  text-indent: -9999em;
-  border-top: 1.1em solid rgba(79, 79, 79, 0.2);
-  border-right: 1.1em solid rgba(79, 79, 79, 0.2);
-  border-bottom: 1.1em solid rgba(79, 79, 79, 0.2);
-  border-left: 1.1em solid #4f4f4f;
-  -webkit-transform: translateZ(0);
-  -ms-transform: translateZ(0);
-  transform: translateZ(0);
-  -webkit-animation: transitDeparturesWidgetLoader 1.1s infinite linear;
-  animation: transitDeparturesWidgetLoader 1.1s infinite linear;
-  display: none;
-}
-
-@-webkit-keyframes transitDeparturesWidgetLoader {
-  0% {
-    -webkit-transform: rotate(0deg);
-    transform: rotate(0deg);
-  }
-  100% {
-    -webkit-transform: rotate(360deg);
-    transform: rotate(360deg);
-  }
-}
-
-@keyframes transitDeparturesWidgetLoader {
-  0% {
-    -webkit-transform: rotate(0deg);
-    transform: rotate(0deg);
-  }
-  100% {
-    -webkit-transform: rotate(360deg);
-    transform: rotate(360deg);
-  }
-}
-
-.autocomplete {
-  background: white;
-  z-index: 1000;
-  overflow: auto;
-  box-sizing: border-box;
-  border: 1px solid rgba(0, 0, 0, 0.125);
-}
-
-.autocomplete * {
-  font: inherit;
-}
-
-.autocomplete > div {
-  padding: 4px 4px;
-}
-
-.autocomplete .group {
-  background: #eee;
-}
-
-.autocomplete > div:hover:not(.group),
-.autocomplete > div.selected {
-  background: #007bff;
-  color: #fff;
-  font-weight: bold;
-  cursor: pointer;
-}

package/public/img/refresh.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" x="0px" y="0px" viewBox="0 0 256 256" style="enable-background:new 0 0 256 256;" xml:space="preserve"><path d="M226.74,199.28c-0.76,0.48-1.68,0.49-2.46,0.04l-16.82-9.7l-1.08,1.29c-19.26,23.11-47.55,36.37-77.61,36.37  c-48.57,0-90.32-34.6-99.26-82.27c-0.43-2.31,0.18-4.68,1.69-6.5c1.53-1.85,3.78-2.91,6.18-2.91H50.9c3.77,0,6.98,2.59,7.81,6.3  c3.49,15.69,12.32,29.94,24.87,40.12c12.73,10.33,28.78,16.02,45.21,16.02c19.4,0,37.57-7.62,51.17-21.45l1.81-1.84l-15.56-8.98  c-0.78-0.45-1.22-1.25-1.19-2.15c0.03-0.9,0.54-1.67,1.35-2.05l53.59-25.73c0.71-0.35,1.52-0.32,2.21,0.08  c0.69,0.4,1.12,1.08,1.18,1.88l4.51,59.27C227.92,197.99,227.5,198.81,226.74,199.28z"></path><path d="M226.03,119.33c-1.53,1.85-3.78,2.91-6.18,2.91h-13.51c-3.77,0-6.98-2.59-7.81-6.3c-3.49-15.69-12.32-29.94-24.87-40.12  c-12.73-10.33-28.78-16.02-45.21-16.02c-19.4,0-37.57,7.62-51.17,21.45l-1.81,1.84l15.56,8.98c0.78,0.45,1.22,1.25,1.19,2.15  c-0.03,0.9-0.54,1.67-1.35,2.05L37.29,122c-0.71,0.35-1.52,0.32-2.21-0.08c-0.69-0.4-1.12-1.08-1.18-1.88l-4.51-59.27  c-0.07-0.9,0.35-1.72,1.11-2.2s1.68-0.49,2.46-0.04l16.82,9.7l1.08-1.29c19.26-23.11,47.55-36.37,77.61-36.37  c48.57,0,90.32,34.6,99.26,82.27C228.15,115.14,227.54,117.51,226.03,119.33z"></path></svg>