gtfs 3.4.0 → 3.6.0

package/lib/db.js

@@ -1,13 +1,14 @@
 import sqlite3 from 'sqlite3';
 import { open } from 'sqlite';
 import { setDefaultConfig } from './utils.js';
+import untildify from 'untildify';
 const dbs = {};
 
 export async function openDb(initialConfig) {
   const config = setDefaultConfig(initialConfig);
   if (!dbs[config.sqlitePath]) {
     dbs[config.sqlitePath] = await open({
-      filename: config.sqlitePath,
+      filename: untildify(config.sqlitePath),
       driver: sqlite3.Database,
     });
   }

package/lib/gtfs/areas.js

@@ -0,0 +1,30 @@
+import sqlString from 'sqlstring-sqlite';
+
+import { getDb } from '../db.js';
+
+import {
+  formatOrderByClause,
+  formatSelectClause,
+  formatWhereClauses,
+} from '../utils.js';
+import areas from '../../models/gtfs/areas.js';
+
+/*
+ * Returns an array of all areas that match the query parameters.
+ */
+export async function getAreas(
+  query = {},
+  fields = [],
+  orderBy = [],
+  options = {}
+) {
+  const db = options.db ?? (await getDb());
+  const tableName = sqlString.escapeId(areas.filenameBase);
+  const selectClause = formatSelectClause(fields);
+  const whereClause = formatWhereClauses(query);
+  const orderByClause = formatOrderByClause(orderBy);
+
+  return db.all(
+    `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+  );
+}

package/lib/gtfs/fare-leg-rules.js

@@ -0,0 +1,30 @@
+import sqlString from 'sqlstring-sqlite';
+
+import { getDb } from '../db.js';
+
+import {
+  formatOrderByClause,
+  formatSelectClause,
+  formatWhereClauses,
+} from '../utils.js';
+import fareLegRules from '../../models/gtfs/fare-leg-rules.js';
+
+/*
+ * Returns an array of all fare leg rules that match the query parameters.
+ */
+export async function getFareLegRules(
+  query = {},
+  fields = [],
+  orderBy = [],
+  options = {}
+) {
+  const db = options.db ?? (await getDb());
+  const tableName = sqlString.escapeId(fareLegRules.filenameBase);
+  const selectClause = formatSelectClause(fields);
+  const whereClause = formatWhereClauses(query);
+  const orderByClause = formatOrderByClause(orderBy);
+
+  return db.all(
+    `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+  );
+}

package/lib/gtfs/fare-products.js

@@ -0,0 +1,30 @@
+import sqlString from 'sqlstring-sqlite';
+
+import { getDb } from '../db.js';
+
+import {
+  formatOrderByClause,
+  formatSelectClause,
+  formatWhereClauses,
+} from '../utils.js';
+import fareProducts from '../../models/gtfs/fare-products.js';
+
+/*
+ * Returns an array of all fare products that match the query parameters.
+ */
+export async function getFareProducts(
+  query = {},
+  fields = [],
+  orderBy = [],
+  options = {}
+) {
+  const db = options.db ?? (await getDb());
+  const tableName = sqlString.escapeId(fareProducts.filenameBase);
+  const selectClause = formatSelectClause(fields);
+  const whereClause = formatWhereClauses(query);
+  const orderByClause = formatOrderByClause(orderBy);
+
+  return db.all(
+    `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+  );
+}

package/lib/gtfs/fare-transfer-rules.js

@@ -0,0 +1,30 @@
+import sqlString from 'sqlstring-sqlite';
+
+import { getDb } from '../db.js';
+
+import {
+  formatOrderByClause,
+  formatSelectClause,
+  formatWhereClauses,
+} from '../utils.js';
+import fareTransferRules from '../../models/gtfs/fare-transfer-rules.js';
+
+/*
+ * Returns an array of all fare transfer rules that match the query parameters.
+ */
+export async function getFareTransferRules(
+  query = {},
+  fields = [],
+  orderBy = [],
+  options = {}
+) {
+  const db = options.db ?? (await getDb());
+  const tableName = sqlString.escapeId(fareTransferRules.filenameBase);
+  const selectClause = formatSelectClause(fields);
+  const whereClause = formatWhereClauses(query);
+  const orderByClause = formatOrderByClause(orderBy);
+
+  return db.all(
+    `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+  );
+}

package/lib/gtfs/stop-areas.js

@@ -0,0 +1,30 @@
+import sqlString from 'sqlstring-sqlite';
+
+import { getDb } from '../db.js';
+
+import {
+  formatOrderByClause,
+  formatSelectClause,
+  formatWhereClauses,
+} from '../utils.js';
+import stopAreas from '../../models/gtfs/stop-areas.js';
+
+/*
+ * Returns an array of all stop areas that match the query parameters.
+ */
+export async function getStopAreas(
+  query = {},
+  fields = [],
+  orderBy = [],
+  options = {}
+) {
+  const db = options.db ?? (await getDb());
+  const tableName = sqlString.escapeId(stopAreas.filenameBase);
+  const selectClause = formatSelectClause(fields);
+  const whereClause = formatWhereClauses(query);
+  const orderByClause = formatOrderByClause(orderBy);
+
+  return db.all(
+    `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+  );
+}

package/lib/gtfs.js

@@ -6,17 +6,22 @@ import exportGtfs from './export.js';
 
 // Standard GTFS Filenames
 import { getAgencies } from './gtfs/agencies.js';
+import { getAreas } from './gtfs/areas.js';
 import { getAttributions } from './gtfs/attributions.js';
 import { getCalendarDates } from './gtfs/calendar-dates.js';
 import { getCalendars } from './gtfs/calendars.js';
 import { getFareAttributes } from './gtfs/fare-attributes.js';
+import { getFareLegRules } from './gtfs/fare-leg-rules.js';
+import { getFareProducts } from './gtfs/fare-products.js';
 import { getFareRules } from './gtfs/fare-rules.js';
+import { getFareTransferRules } from './gtfs/fare-transfer-rules.js';
 import { getFeedInfo } from './gtfs/feed-info.js';
 import { getFrequencies } from './gtfs/frequencies.js';
 import { getLevels } from './gtfs/levels.js';
 import { getPathways } from './gtfs/pathways.js';
 import { getRoutes } from './gtfs/routes.js';
 import { getShapes, getShapesAsGeoJSON } from './gtfs/shapes.js';
+import { getStopAreas } from './gtfs/stop-areas.js';
 import { getStops, getStopsAsGeoJSON } from './gtfs/stops.js';
 import { getStoptimes } from './gtfs/stop-times.js';
 import { getTransfers } from './gtfs/transfers.js';
@@ -60,6 +65,9 @@ export { _exportGtfs as exportGtfs };
 const _getAgencies = getAgencies;
 export { _getAgencies as getAgencies };
 
+const _getAreas = getAreas;
+export { _getAreas as getAreas };
+
 const _getAttributions = getAttributions;
 export { _getAttributions as getAttributions };
 
@@ -72,9 +80,18 @@ export { _getCalendars as getCalendars };
 const _getFareAttributes = getFareAttributes;
 export { _getFareAttributes as getFareAttributes };
 
+const _getFareLegRules = getFareLegRules;
+export { _getFareLegRules as getFareLegRules };
+
+const _getFareProducts = getFareProducts;
+export { _getFareProducts as getFareProducts };
+
 const _getFareRules = getFareRules;
 export { _getFareRules as getFareRules };
 
+const _getFareTransferRules = getFareTransferRules;
+export { _getFareTransferRules as getFareTransferRules };
+
 const _getFeedInfo = getFeedInfo;
 export { _getFeedInfo as getFeedInfo };
 
@@ -95,6 +112,9 @@ export { _getShapes as getShapes };
 const _getShapesAsGeoJSON = getShapesAsGeoJSON;
 export { _getShapesAsGeoJSON as getShapesAsGeoJSON };
 
+const _getStopAreas = getStopAreas;
+export { _getStopAreas as getStopAreas };
+
 const _getStops = getStops;
 export { _getStops as getStops };
 const _getStopsAsGeoJSON = getStopsAsGeoJSON;

package/lib/log-utils.js

@@ -1,7 +1,7 @@
 import { clearLine, cursorTo } from 'node:readline';
 import PrettyError from 'pretty-error';
 import { noop } from 'lodash-es';
-import chalk from 'chalk';
+import * as colors from 'yoctocolors';
 
 const pe = new PrettyError();
 pe.start();
@@ -60,17 +60,18 @@ export function logError(config) {
  * Format console warning text
  */
 export function formatWarning(text) {
-  return `${chalk.yellow.underline('Warning')}${chalk.yellow(
-    ':'
-  )} ${chalk.yellow(text)}`;
+  const warningMessage = `${colors.underline('Warning')}: ${text}`;
+  return colors.yellow(warningMessage);
 }
 
 /*
  * Format console error text
  */
 export function formatError(error) {
-  const message = error instanceof Error ? error.message : error;
-  return `${chalk.red.underline('Error')}${chalk.red(':')} ${chalk.red(
-    message.replace('Error: ', '')
+  const messageText = error instanceof Error ? error.message : error;
+  const errorMessage = `${colors.underline('Error')}: ${messageText.replace(
+    'Error: ',
+    ''
   )}`;
+  return colors.red(errorMessage);
 }

package/models/gtfs/areas.js

@@ -0,0 +1,17 @@
+const model = {
+  filenameBase: 'areas',
+  schema: [
+    {
+      name: 'area_id',
+      type: 'varchar(255)',
+      required: true,
+      primary: true,
+    },
+    {
+      name: 'area_name',
+      type: 'varchar(255)',
+    },
+  ],
+};
+
+export default model;

package/models/gtfs/attributions.js

@@ -1,14 +1,10 @@
 const model = {
   filenameBase: 'attributions',
   schema: [
-    {
-      name: 'id',
-      type: 'integer',
-      primary: true,
-    },
     {
       name: 'attribution_id',
       type: 'varchar(255)',
+      primary: true,
     },
     {
       name: 'agency_id',

package/models/gtfs/fare-leg-rules.js

@@ -0,0 +1,28 @@
+const model = {
+  filenameBase: 'fare_leg_rules',
+  schema: [
+    {
+      name: 'leg_group_id',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'network_id',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'from_area_id',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'to_area_id',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'fare_product_id',
+      type: 'varchar(255)',
+      required: true,
+    },
+  ],
+};
+
+export default model;

package/models/gtfs/fare-products.js

@@ -0,0 +1,27 @@
+const model = {
+  filenameBase: 'fare_products',
+  schema: [
+    {
+      name: 'fare_product_id',
+      type: 'varchar(255)',
+      required: true,
+      primary: true,
+    },
+    {
+      name: 'fare_product_name',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'amount',
+      type: 'real',
+      required: true,
+    },
+    {
+      name: 'currency',
+      type: 'varchar(255)',
+      required: true,
+    },
+  ],
+};
+
+export default model;

package/models/gtfs/fare-rules.js

@@ -10,12 +10,10 @@ const model = {
       name: 'fare_id',
       type: 'varchar(255)',
       required: true,
-      index: true,
     },
     {
       name: 'route_id',
       type: 'varchar(255)',
-      index: true,
     },
     {
       name: 'origin_id',

package/models/gtfs/fare-transfer-rules.js

@@ -0,0 +1,45 @@
+const model = {
+  filenameBase: 'fare_transfer_rules',
+  schema: [
+    {
+      name: 'from_leg_group_id',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'to_leg_group_id',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'transfer_count',
+      type: 'integer',
+      min: -1,
+    },
+    {
+      name: 'transfer_id',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'duration_limit',
+      type: 'integer',
+      min: 0,
+    },
+    {
+      name: 'duration_limit_type',
+      type: 'integer',
+      min: 0,
+      max: 3,
+    },
+    {
+      name: 'fare_transfer_type',
+      type: 'integer',
+      min: 0,
+      max: 2,
+    },
+    {
+      name: 'fare_product_id',
+      type: 'varchar(255)',
+    },
+  ],
+};
+
+export default model;

package/models/gtfs/levels.js

@@ -5,6 +5,7 @@ const model = {
       name: 'level_id',
       type: 'varchar(255)',
       primary: true,
+      required: true,
     },
     {
       name: 'level_index',

package/models/gtfs/pathways.js

@@ -5,6 +5,7 @@ const model = {
       name: 'pathway_id',
       type: 'varchar(255)',
       primary: true,
+      required: true,
     },
     {
       name: 'from_stop_id',
@@ -33,6 +34,7 @@ const model = {
     {
       name: 'length',
       type: 'real',
+      min: 0,
     },
     {
       name: 'traversal_time',

package/models/gtfs/routes.js

@@ -5,6 +5,7 @@ const model = {
       name: 'route_id',
       type: 'varchar(255)',
       primary: true,
+      required: true,
     },
     {
       name: 'agency_id',
@@ -64,6 +65,10 @@ const model = {
       min: 0,
       max: 3,
     },
+    {
+      name: 'network_id',
+      type: 'varchar(255)',
+    },
   ],
 };
 

package/models/gtfs/stop-areas.js

@@ -0,0 +1,17 @@
+const model = {
+  filenameBase: 'stop_areas',
+  schema: [
+    {
+      name: 'area_id',
+      type: 'varchar(255)',
+      required: true,
+    },
+    {
+      name: 'stop_id',
+      type: 'varchar(255)',
+      required: true,
+    },
+  ],
+};
+
+export default model;

package/models/gtfs/stops.js

@@ -5,6 +5,7 @@ const model = {
       name: 'stop_id',
       type: 'varchar(255)',
       primary: true,
+      required: true,
     },
     {
       name: 'stop_code',

package/models/gtfs/transfers.js

@@ -9,20 +9,35 @@ const model = {
     {
       name: 'from_stop_id',
       type: 'varchar(255)',
-      required: true,
       index: true,
     },
     {
       name: 'to_stop_id',
       type: 'varchar(255)',
-      required: true,
       index: true,
     },
+    {
+      name: 'from_route_id',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'to_route_id',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'from_trip_id',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'to_trip_id',
+      type: 'varchar(255)',
+    },
     {
       name: 'transfer_type',
       type: 'integer',
       min: 0,
-      max: 3,
+      max: 5,
+      required: true,
     },
     {
       name: 'min_transfer_time',

package/models/gtfs/trips.js

@@ -1,11 +1,6 @@
 const model = {
   filenameBase: 'trips',
   schema: [
-    {
-      name: 'trip_id',
-      type: 'varchar(255)',
-      primary: true,
-    },
     {
       name: 'route_id',
       type: 'varchar(255)',
@@ -18,6 +13,12 @@ const model = {
       required: true,
       index: true,
     },
+    {
+      name: 'trip_id',
+      type: 'varchar(255)',
+      primary: true,
+      required: true,
+    },
     {
       name: 'trip_headsign',
       type: 'varchar(255)',

package/models/models.js

@@ -1,15 +1,20 @@
 import agency from '../models/gtfs/agency.js';
+import areas from '../models/gtfs/areas.js';
 import attributions from '../models/gtfs/attributions.js';
 import calendarDates from '../models/gtfs/calendar-dates.js';
 import calendar from '../models/gtfs/calendar.js';
 import fareAttributes from '../models/gtfs/fare-attributes.js';
+import fareLegRules from '../models/gtfs/fare-leg-rules.js';
+import fareProducts from '../models/gtfs/fare-products.js';
 import fareRules from '../models/gtfs/fare-rules.js';
+import fareTransferRules from '../models/gtfs/fare-transfer-rules.js';
 import feedInfo from '../models/gtfs/feed-info.js';
 import frequencies from '../models/gtfs/frequencies.js';
 import levels from '../models/gtfs/levels.js';
 import pathways from '../models/gtfs/pathways.js';
 import routes from '../models/gtfs/routes.js';
 import shapes from '../models/gtfs/shapes.js';
+import stopAreas from '../models/gtfs/stop-areas.js';
 import stopTimes from '../models/gtfs/stop-times.js';
 import stops from '../models/gtfs/stops.js';
 import transfers from '../models/gtfs/transfers.js';
@@ -39,17 +44,22 @@ import serviceAlertTargets from './gtfs-realtime/service-alert-targets.js';
 
 const models = [
   agency,
+  areas,
   attributions,
   calendarDates,
   calendar,
   fareAttributes,
+  fareLegRules,
+  fareProducts,
   fareRules,
+  fareTransferRules,
   feedInfo,
   frequencies,
   levels,
   pathways,
   routes,
   shapes,
+  stopAreas,
   stopTimes,
   stops,
   transfers,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs",
-  "version": "3.4.0",
+  "version": "3.6.0",
   "description": "Import GTFS transit data into SQLite and query routes, stops, times, fares and more",
   "keywords": [
     "transit",
@@ -72,35 +72,35 @@
   },
   "dependencies": {
     "@turf/helpers": "^6.5.0",
-    "chalk": "^5.0.1",
-    "csv-parse": "^5.1.0",
-    "csv-stringify": "^6.1.0",
+    "csv-parse": "^5.3.0",
+    "csv-stringify": "^6.2.0",
     "gtfs-realtime-bindings": "^0.0.6",
     "lodash-es": "^4.17.21",
     "long": "^5.2.0",
-    "node-fetch": "^3.2.6",
+    "node-fetch": "^3.2.10",
     "pluralize": "^8.0.0",
     "pretty-error": "^4.0.0",
     "promise-map-series": "^0.3.0",
     "recursive-copy": "^2.0.14",
     "sanitize-filename": "^1.6.3",
-    "sqlite": "^4.1.1",
-    "sqlite3": "^5.0.8",
+    "sqlite": "^4.1.2",
+    "sqlite3": "^5.0.11",
     "sqlstring-sqlite": "^0.1.1",
     "strip-bom-stream": "^5.0.0",
     "tmp-promise": "^3.0.3",
     "untildify": "^4.0.0",
     "unzipper": "^0.10.11",
-    "yargs": "^17.5.1"
+    "yargs": "^17.5.1",
+    "yoctocolors": "^1.0.0"
   },
   "devDependencies": {
     "dtslint": "^4.2.1",
-    "eslint": "^8.17.0",
+    "eslint": "^8.21.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-config-xo": "^0.41.0",
     "husky": "^8.0.1",
     "mocha": "^10.0.0",
-    "prettier": "^2.6.2",
+    "prettier": "^2.7.1",
     "pretty-quick": "^3.1.3",
     "should": "^13.2.3"
   },