gtfs 4.17.5 → 4.17.7

package/README.md

@@ -151,14 +151,14 @@ Copy `config-sample.json` to `config.json` and then add your projects configurat
 | option                                                            | type              | description                                                                                                                                                         |
 | ----------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [`agencies`](#agencies)                                           | array             | An array of GTFS files to be imported, and which files to exclude.                                                                                                  |
-| [`csvOptions`](#csvOptions)                                       | object            | Options passed to `csv-parse` for parsing GTFS CSV files. Optional.                                                                                                 |
+| [`csvOptions`](#csvoptions)                                       | object            | Options passed to `csv-parse` for parsing GTFS CSV files. Optional.                                                                                                 |
 | [`db`](#db)                                                       | database instance | An existing database instance to use instead of relying on node-gtfs to connect. Optional.                                                                          |
 | [`downloadTimeout`](#downloadtimeout)                             | integer           | The number of milliseconds to wait before throwing an error when downloading GTFS. Optional.                                                                        |
-| [`exportPath`](#exportPath)                                       | string            | A path to a directory to put exported GTFS files. Optional, defaults to `gtfs-export/<agency_name>`.                                                                |
+| [`exportPath`](#exportpath)                                       | string            | A path to a directory to put exported GTFS files. Optional, defaults to `gtfs-export/<agency_name>`.                                                                |
 | [`gtfsRealtimeExpirationSeconds`](#gtfsrealtimeexpirationseconds) | integer           | Amount of time in seconds to allow GTFS-Realtime data to be stored in database before allowing to be deleted. Optional, defaults to 0.                              |
 | [`ignoreDuplicates`](#ignoreduplicates)                           | boolean           | Whether or not to ignore unique constraints on ids when importing GTFS, such as `trip_id`, `calendar_id`. Optional, defaults to false.                              |
-| [`ignoreErrors`](#ignoreerrors)                                   | boolean           | Whether or not to ignore errors during the import process. If true, when importing multiple agencies, failed agencies will be skipped. Optional, defaults to false. |
-| [`sqlitePath`](#sqlitePath)                                       | string            | A path to an SQLite database. Optional, defaults to using an in-memory database.                                                                                    |
+| [`ignoreErrors`](#ignoreerrors)                                   | boolean           | Whether or not to ignore errors during the import process. If true, failed files will be skipped while the rest are processed. Optional, defaults to false. |
+| [`sqlitePath`](#sqlitepath)                                       | string            | A path to an SQLite database. Optional, defaults to using an in-memory database.                                                                                    |
 | [`verbose`](#verbose)                                             | boolean           | Whether or not to print output to the console. Optional, defaults to true.                                                                                          |
 
 ### agencies
@@ -431,7 +431,28 @@ importGtfs({
 
 ### ignoreErrors
 
-{Boolean} When importing GTFS from multiple agencies, if you don't want node-GTFS to throw an error and instead skip failed GTFS importants proceed to the next agency. Defaults to `false`.
+{Boolean} Controls error handling behavior during GTFS import. When `true`, the import process will continue even when encountering errors, logging them instead of stopping execution. Defaults to `false`.
+
+**When enabled, `ignoreErrors` will:**
+- Continue processing other GTFS files when one file fails
+- Log error messages instead of throwing exceptions
+- Skip problematic records within files while importing valid ones
+- Handle various error types including:
+  - Invalid CSV data or malformed records
+  - JSON parsing errors (for GeoJSON files)
+  - Database constraint violations
+  - File read/write errors
+  - GTFS-Realtime API failures
+
+**Use cases:**
+- Importing from multiple GTFS sources where some may have data quality issues
+- Processing large datasets where minor errors shouldn't halt the entire import
+- Development/testing scenarios where you want to see all errors at once
+
+**⚠️ Important considerations:**
+- Errors are logged but not thrown, so you may miss critical data issues
+- Partial imports may result in incomplete or inconsistent data
+- Consider using the `exclude` config option to skip problematic files entirely instead of ignoring errors
 
 ```json
 {
@@ -951,8 +972,8 @@ const stoptimes = getStoptimes({
 });
 
 /*
- * `getStoptimes` allows passing a `date` in the query to return
- * only stoptimes for a specific day.
+ * `getStoptimes` allows passing a `date` in the query to return only
+ * stoptimes for a specific service date.
  */
 const stoptimes = getStoptimes({
   stop_id: '70011',
@@ -963,7 +984,7 @@ const stoptimes = getStoptimes({
  * `getStoptimes` allows passing a `start_time` and/or and 
  * `end_time` in the query to return only stoptimes after 
  * start_time and before end_time. This can be combined with the 
- * `date` parameter to get upcoming stoptimes
+ * `date` parameter to get upcoming stoptimes.
  */
 const stoptimes = getStoptimes({
   stop_id: '70011',
@@ -971,6 +992,32 @@ const stoptimes = getStoptimes({
   start_time: '11:30:00',
   end_time: '11:45:00'
 });
+
+/*
+ * ⚠️ By default, when using the `date` parameter in a query, it will NOT
+ * include stoptimes for trips whose service date is the previous day but
+ * whose stoptimes occur after midnight (i.e., times greater than 24:00:00
+ * in GTFS, such as 25:15:00 for 1:15 AM the next day).
+ *
+ * To retrieve all stoptimes for a calendar date including those from 
+ * trips assigned to the previous service date but occurring after 
+ * midnight:
+ *   1. Call `getStoptimes` with the target date:
+ *   2. Call `getStoptimes` with the previous date and `start_time: '24:00:00'`:
+ *   3. Combine both results for a complete set of stoptimes for July 5th.
+ *
+ * This approach ensures you include:
+ *   - All stoptimes for trips whose service date is July 4th but whose 
+ * stoptimes occur after midnight (i.e., in the early hours of July 5th)
+ *   - All stoptimes for trips whose service date is July 5th (which can 
+ * include trips with stoptimes that occur on July 6th after midnight )
+ */
+const stoptimesToday = getStoptimes({ date: 20240705 });
+const stoptimesYesterdayAfterMidnight = getStoptimes({ date: 20240704, start_time: '24:00:00' })
+const mergedStoptimes = [
+  ...stoptimesToday,
+  ...stoptimesYesterdayAfterMidnight
+];
 ```
 
 #### getTrips(query, fields, sortBy, options)
@@ -1001,6 +1048,15 @@ const trips = getTrips({
   direction_id: 0,
   service_id: '
 });
+
+/*
+ * `getTrips` allows passing a `date` in the query to return only trips 
+ * for a specific service date.
+ */
+const trips = getTrips({
+  route_id: 'Bu-16APR',
+  date: 20170416
+});
 ```
 
 #### getShapes(query, fields, sortBy, options)

package/dist/bin/gtfs-export.js

@@ -13,10 +13,10 @@ import PrettyError from "pretty-error";
 // src/lib/file-utils.ts
 import path from "path";
 import { existsSync } from "fs";
+import { homedir } from "os";
 import { mkdir, readFile, rm } from "fs/promises";
 import { omit, snakeCase } from "lodash-es";
 import sanitize from "sanitize-filename";
-import untildify from "untildify";
 import StreamZip from "node-stream-zip";
 
 // src/lib/log-utils.ts
@@ -60,6 +60,7 @@ function formatError(error) {
 }
 
 // src/lib/file-utils.ts
+var homeDirectory = homedir();
 async function getConfig(argv2) {
   let config;
   let data;
@@ -106,17 +107,17 @@ function generateFolderName(folderName) {
   }
   return snakeCase(sanitize(folderName));
 }
+function untildify(pathWithTilde) {
+  return homeDirectory ? pathWithTilde.replace(/^~(?=$|\/|\\)/, homeDirectory) : pathWithTilde;
+}
 
 // src/lib/import-gtfs.ts
 import path2 from "path";
 import { createReadStream, existsSync as existsSync2, lstatSync } from "fs";
 import { cp, readdir, rename, readFile as readFile2, rm as rm2, writeFile } from "fs/promises";
 import { parse } from "csv-parse";
-import pluralize2 from "pluralize";
 import stripBomStream from "strip-bom-stream";
 import { temporaryDirectory } from "tempy";
-import Timer from "timer-machine";
-import untildify3 from "untildify";
 import mapSeries2 from "promise-map-series";
 
 // src/models/models.ts
@@ -4078,10 +4079,9 @@ var vehicles = {
 
 // src/lib/db.ts
 import Database from "better-sqlite3";
-import untildify2 from "untildify";
 var dbs = {};
 function setupDb(sqlitePath) {
-  const db = new Database(untildify2(sqlitePath));
+  const db = new Database(untildify(sqlitePath));
   db.pragma("journal_mode = OFF");
   db.pragma("synchronous = OFF");
   db.pragma("temp_store = MEMORY");
@@ -4128,7 +4128,6 @@ import {
 import { feature, featureCollection } from "@turf/helpers";
 
 // src/lib/import-gtfs-realtime.ts
-import pluralize from "pluralize";
 import GtfsRealtimeBindings from "gtfs-realtime-bindings";
 import mapSeries from "promise-map-series";
 import { get } from "lodash-es";
@@ -4158,16 +4157,17 @@ function formatCurrency(value, currency) {
   const fractionPart = parts.find((part) => part.type === "fraction")?.value ?? "";
   return `${integerPart}${fractionPart !== "" ? `.${fractionPart}` : ""}`;
 }
+function pluralize(singularWord, pluralWord, count) {
+  return count === 1 ? singularWord : pluralWord;
+}
 
 // src/lib/export.ts
 import path3 from "path";
 import { writeFile as writeFile2 } from "fs/promises";
 import { without, compact as compact2 } from "lodash-es";
-import pluralize3 from "pluralize";
 import { stringify } from "csv-stringify";
 import sqlString2 from "sqlstring-sqlite";
 import mapSeries3 from "promise-map-series";
-import untildify4 from "untildify";
 var getAgencies = (db, config) => {
   try {
     return db.prepare("SELECT agency_name FROM agency;").all();
@@ -4197,15 +4197,15 @@ var exportGtfs = async (initialConfig) => {
     );
   }
   log(config)(
-    `Starting GTFS export for ${pluralize3(
+    `Starting GTFS export for ${pluralize(
       "agency",
-      agencyCount,
-      true
+      "agencies",
+      agencyCount
     )} using SQLite database at ${config.sqlitePath}`
   );
   const folderName = generateFolderName(agencies[0].agency_name);
   const defaultExportPath = path3.join(process.cwd(), "gtfs-export", folderName);
-  const exportPath = untildify4(config.exportPath || defaultExportPath);
+  const exportPath = untildify(config.exportPath || defaultExportPath);
   await prepDirectory(exportPath);
   const modelsToExport = Object.values(models_exports).filter(
     (model) => model.extension !== "gtfs-realtime"
@@ -4273,7 +4273,7 @@ var exportGtfs = async (initialConfig) => {
   }
   log(config)(`Completed GTFS export to ${exportPath}`);
   log(config)(
-    `Completed GTFS export for ${pluralize3("agency", agencyCount, true)}
+    `Completed GTFS export for ${pluralize("agency", "agencies", agencyCount)}
 `
   );
 };
@@ -4295,6 +4295,10 @@ import { omit as omit5, orderBy, pick as pick3 } from "lodash-es";
 import { omit as omit6 } from "lodash-es";
 import sqlString4 from "sqlstring-sqlite";
 
+// src/lib/gtfs/trips.ts
+import { omit as omit7 } from "lodash-es";
+import sqlString5 from "sqlstring-sqlite";
+
 // src/bin/gtfs-export.ts
 var pe = new PrettyError();
 var argv = yargs(hideBin(process.argv)).usage("Usage: $0 --configPath ./config.json").help().option("c", {