gtfs-to-html 2.6.3 → 2.6.4

package/CHANGELOG.md

@@ -5,6 +5,14 @@ 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.6.4] - 2024-04-30
+
+### Updated
+- Upated Mapbox GL
+
+### Added
+- `startDate` and `endDate` config.json parameters
+
 ## [2.6.3] - 2024-04-22
 
 ### Updated

package/lib/utils.js

@@ -542,7 +542,27 @@ const convertRouteToTimetablePage = (
 const convertRoutesToTimetablePages = (config) => {
   const db = openDb(config);
   const routes = getRoutes();
-  const calendars = getCalendars();
+
+  let whereClause = '';
+  const whereClauses = [];
+
+  if (config.endDate) {
+    whereClauses.push(
+      `start_date <= ${sqlString.escape(toGTFSDate(moment(config.endDate)))}`,
+    );
+  }
+
+  if (config.startDate) {
+    whereClauses.push(
+      `end_date >= ${sqlString.escape(toGTFSDate(moment(config.startDate)))}`,
+    );
+  }
+
+  if (whereClauses.length > 0) {
+    whereClause = `WHERE ${whereClauses.join(' AND ')}`;
+  }
+
+  const calendars = db.prepare(`SELECT * FROM calendar ${whereClause}`).all();
 
   // Find all calendar dates with service_ids not present in `calendar.txt`.
   const serviceIds = calendars.map((calendar) => calendar.service_id);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs-to-html",
-  "version": "2.6.3",
+  "version": "2.6.4",
   "private": false,
   "description": "Build human readable transit timetables as HTML, PDF or CSV from GTFS",
   "keywords": [

package/views/default/overview_full.pug

@@ -6,9 +6,9 @@ block extraHeader
   if config.showMap
     script(src="https://unpkg.com/jquery@3.7.1/dist/jquery.min.js" crossorigin="anonymous")
     script(src="https://unpkg.com/lodash@4.17.21/lodash.min.js" crossorigin="anonymous")
-    script(src="https://api.mapbox.com/mapbox-gl-js/v3.1.0/mapbox-gl.js")
+    script(src="https://api.mapbox.com/mapbox-gl-js/v3.3.0/mapbox-gl.js")
     script.
       mapboxgl.accessToken = '#{config.mapboxAccessToken}';
     script(src=`${config.assetPath}js/system-map.js`)
 
-    link(href="https://api.mapbox.com/mapbox-gl-js/v3.1.0/mapbox-gl.css" rel="stylesheet")
+    link(href="https://api.mapbox.com/mapbox-gl-js/v3.3.0/mapbox-gl.css" rel="stylesheet")

package/views/default/timetablepage_full.pug

@@ -9,10 +9,10 @@ block extraHeader
     script(src=`${config.assetPath}js/timetable-menu.js`)
 
   if config.showMap
-    script(src="https://api.mapbox.com/mapbox-gl-js/v3.1.0/mapbox-gl.js")
+    script(src="https://api.mapbox.com/mapbox-gl-js/v3.3.0/mapbox-gl.js")
     script.
       mapboxgl.accessToken = '#{config.mapboxAccessToken}';
     script(src=`${config.assetPath}js/timetable-map.js`)
 
-    link(href="https://api.mapbox.com/mapbox-gl-js/v3.1.0/mapbox-gl.css" rel="stylesheet")
+    link(href="https://api.mapbox.com/mapbox-gl-js/v3.3.0/mapbox-gl.css" rel="stylesheet")
 

package/www/docs/configuration.md

@@ -25,6 +25,7 @@ All files starting with `config*.json` are .gitignored - so you can create multi
 | [`debug`](#debug)                                               | boolean          | Enable logging of SQL queries and other info.                                                    |
 | [`defaultOrientation`](#defaultorientation)                     | string           | Specify timetable orientation, when not specified in `timetables.txt`.                           |
 | [`effectiveDate`](#effectivedate)                               | string           | A date to print at the top of the timetable.                                                     |
+| [`endDate`](#enddate)                                        | string           | A date in ISO 8601 format to use to control which calendars are used for the timetables.                |
 | [`interpolatedStopSymbol`](#interpolatedstopsymbol)             | string           | The symbol used to indicate that a timepoint isn't fixed, but just interpolated.                 |
 | [`interpolatedStopText`](#interpolatedstoptext)                 | string           | The text used to describe a timepoint isn't fixed, but just interpolated.                        |
 | [`linkStopUrls`](#linkStopurls)                                 | boolean          | Whether or not to hyperlink timetable stop names to the `stop_url` defined in `stops.txt`.       |
@@ -56,6 +57,7 @@ All files starting with `config*.json` are .gitignored - so you can create multi
 | [`skipImport`](#skipimport)                                     | boolean          | Whether or not to skip importing GTFS data into SQLite.                                          |
 | [`sortingAlgorithm`](#sortingalgorithm)                         | string           | Defines the trip-sorting algorithm.                                                              |
 | [`sqlitePath`](#sqlitepath)                                     | string           | A path to an SQLite database. Optional, defaults to using an in-memory database.                 |
+| [`startDate`](#startdate)                                     | string           | A date in ISO 8601 format to use to control which calendars are used for the timetables.                |
 | [`templatePath`](#templatepath)                                 | string           | Path to custom pug template for rendering timetable.                                             |
 | [`timeFormat`](#timeformat)                                     | string           | A string defining time format in moment.js style.                                                |
 | [`useParentStation`](#useparentstation)                         | boolean          | Whether or not to use a stop's `parent_station`.                                                 |
@@ -231,6 +233,16 @@ API along with your API token.
 "effectiveDate": "July 8, 2015"
 ```
 
+### endDate
+
+\{String\} A date in ISO 8601 format to use to control which calendars are used for the timetables. Can be used with [startDate](#startdate) configuration options. Can be formatted as `YYYY-MM-DD` or `YYYYMMDD`.
+
+Optional, defaults to using all available calendars if not defined. Overridden by `start_date` and `end_date` defined in `timetables.txt`.
+
+```json
+"endDate": "2024-04-01"
+```
+
 ### interpolatedStopSymbol
 
 \{String\} The symbol used to indicate that a timepoint isn't fixed, but just interpolated. Defaults to `•`. To avoid having this symbol used in timetables, set it to `null`.
@@ -505,6 +517,16 @@ The default trip-sorting algorithm is `common`.
 "sqlitePath": "/tmp/gtfs"
 ```
 
+### startDate
+
+\{String\} A date in ISO 8601 format to use to control which calendars are used for the timetables. Can be used with [endDate](#enddate) configuration options. Can be formatted as `YYYY-MM-DD` or `YYYYMMDD`.
+
+Optional, defaults to using all available calendars if not defined. Overridden by `start_date` and `end_date` defined in `timetables.txt`.
+
+```json
+"startDate": "2024-03-01"
+```
+
 ### templatePath
 
 \{String\} Path to a folder containing (pug)[https://pugjs.org/] template for rendering timetables. This is optional. Defaults to using the templates provided in `views/default`. All files within the `/views/custom` folder will be .gitignored, so you can copy the `views/default` folder to `views/custom/myagency` and make any modifications needed. Any custom views folder should contain pug templates called `timetablepage.pug`, `timetablepage_full.pug`, `overview.pug`, and `overview_full.pug`.

package/www/docs/quick-start.md

@@ -19,7 +19,7 @@ gtfs-to-html
 
 `configPath`
 
-Allows specifying a path to a configuration json file. By default, `gtfs-to-html` will look for a `config.json` file in the directory it is being run from.
+Allows specifying a path to a configuration json file. By default, `gtfs-to-html` will look for a `config.json` file in the directory it is being run from. [See all configuration options](https://gtfstohtml.com/docs/configuration)
 ```bash
 gtfs-to-html --configPath /path/to/your/custom-config.json
 ```
@@ -29,6 +29,10 @@ Skips importing GTFS into SQLite. Useful if you are rerunning with an unchanged
 ```bash
 gtfs-to-html --skipImport
 ```
+### Customizing the output
+
+You can create your own template to completely customize the HTML output using [custom templates](https://gtfstohtml.com/docs/custom-templates).
+
 ### Processing very large GTFS files.
 
 By default, node has a memory limit of 512 MB or 1 GB. If you have a very large GTFS file and want to use the option `showOnlyTimepoint` = `false` you may need to allocate more memory. Use the `max-old-space-size` option. For example to allocate 4 GB:
@@ -120,27 +124,13 @@ Once running, you can view the HTML in your browser at [localhost:3000](http://l
 
 ## Usage as a hosted web app
 
-A [hosted version of GTFS-to-HTML as a service](https://run.gtfstohtml.com) allows you to use it entirely within your browser - no downloads or command line necessary.
+A [hosted version of GTFS-to-HTML as a service](https://run.gtfstohtml.com) allows you to use it entirely within your browser - no downloads or command line necessary. Currently, it is limited to relatively small GTFS files and doesn't offer support for [Custom Templates](/docs/custom-templates).
 
 It provides:
 
 - a web-based interface for finding GTFS feeds or ability to enter your own URL
 - support for adding [custom configuration](/docs/configuration) as JSON
-- creation of HTML timetables as a downloadable .zip file
+- creation of HTML or PDF timetables as a downloadable .zip file
 - a preview of all timetables generated directly in your browser
 
-[run.gtfstohtml.com](https://run.gtfstohtml.com)
-
-Currently, it is limited to relatively small GTFS files and doesn't offer support for [Custom Templates](/docs/custom-templates).
-
-## Troubleshooting
-
-### SQLite3 unable to be installed with `Failed to exec install script`
-
-For an error like:
-`lifecycle sqlite3@5.0.0~install: Failed to exec install script`
-
-Try installing `gtfs-to-html` using the following flags:
-```bash
-npm install --unsafe-perm --allow-root -g
-```
+[run.gtfstohtml.com](https://run.gtfstohtml.com)