gtfs 4.1.0 → 4.1.1

package/@types/index.d.ts

@@ -383,6 +383,17 @@ export function getStopAreas(
   options?: QueryOptions
 ): SqlResults;
 
+/**
+ * Returns an array of calendar_attributes that match query parameters.
+ * This is for the non-standard `calendar_attributes.txt` file.
+ */
+export function getCalendarAttributes(
+  query?: SqlWhere,
+  fields?: SqlSelect,
+  sortBy?: SqlOrderBy,
+  options?: QueryOptions
+): SqlResults;
+
 /**
  * Returns an array of directions that match query parameters.
  * This is for the non-standard `directions.txt` file.
@@ -394,6 +405,17 @@ export function getDirections(
   options?: QueryOptions
 ): SqlResults;
 
+/**
+ * Returns an array of route_attributes that match query parameters.
+ * This is for the non-standard `route_attributes.txt` file.
+ */
+export function getRouteAttributes(
+  query?: SqlWhere,
+  fields?: SqlSelect,
+  sortBy?: SqlOrderBy,
+  options?: QueryOptions
+): SqlResults;
+
 /**
  * Returns an array of stop_attributes that match query parameters.
  * This is for the non-standard `stop_attributes.txt` file.

package/CHANGELOG.md

@@ -5,6 +5,16 @@ 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).
 
+## [4.1.1] - 2023-04-12
+
+### Added
+
+- Support for GTFS+ Files
+
+### Updated
+
+- Dependency updates
+
 ## [4.1.0] - 2023-02-25
 
 ### Added

package/README.md

@@ -1162,8 +1162,82 @@ import { getVehiclePositions } from 'gtfs';
 const vehiclePositions = getVehiclePositions();
 ```
 
+### GTFS+ Files
+
+#### getCalendarAttributes(query, fields, sortBy, options)
+
+Returns an array of calendar_attributes that match query parameters.
+
+```js
+import { getCalendarAttributes } from 'gtfs';
+
+// Get all calendar attributes
+const calendarAttributes = getCalendarAttributes();
+
+// Get calendar attributes for specific service
+const calendarAttributes = getCalendarAttributes({
+  service_id: '1234',
+});
+```
+
+#### getDirections(query, fields, sortBy, options)
+
+Returns an array of directions that match query parameters.
+
+```js
+import { getDirections } from 'gtfs';
+
+// Get all directions
+const directions = getDirections();
+
+// Get directions for a specific route
+const directions = getDirections({
+  route_id: '1234',
+});
+
+// Get directions for a specific route and direction
+const directions = getDirections({
+  route_id: '1234',
+  direction_id: 1,
+});
+```
+
+#### getRouteAttributes(query, fields, sortBy, options)
+
+Returns an array of route_attributes that match query parameters.
+
+```js
+import { getRouteAttributes } from 'gtfs';
+
+// Get all route attributes
+const routeAttributes = getRouteAttributes();
+
+// Get route attributes for specific route
+const routeAttributes = getRouteAttributes({
+  route_id: '1234',
+});
+```
+
+#### getStopAttributes(query, fields, sortBy, options)
+
+Returns an array of stop_attributes that match query parameters.
+
+```js
+import { getStopAttributes } from 'gtfs';
+
+// Get all stop attributes
+const stopAttributes = getStopAttributes();
+
+// Get stop attributes for specific stop
+const stopAttributes = getStopAttributes({
+  stop_id: '1234',
+});
+```
+
 ### GTFS-Ride Files
 
+See full [documentation of GTFS Ride](https://gtfsride.org).
+
 #### getBoardAlights(query, fields, sortBy, options)
 
 Returns an array of board_alight that match query parameters. [Details on board_alight.txt](http://gtfsride.org/specification#board_alighttxt)
@@ -1316,45 +1390,7 @@ const runEvents = runEvents({
 });
 ```
 
-### Non-standard GTFS Files
-
-#### getDirections(query, fields, sortBy, options)
-
-Returns an array of directions that match query parameters. This is for the non-standard `directions.txt` file. [Details on directions.txt](https://trilliumtransit.com/gtfs/reference/#directions)
-
-```js
-import { getDirections } from 'gtfs';
-
-// Get all directions
-const directions = getDirections();
-
-// Get directions for a specific route
-const directions = getDirections({
-  route_id: '1234',
-});
-
-// Get directions for a specific route and direction
-const directions = getDirections({
-  route_id: '1234',
-  direction_id: 1,
-});
-```
-
-#### getStopAttributes(query, fields, sortBy, options)
-
-Returns an array of stop_attributes that match query parameters. This is for the non-standard `stop_attributes.txt` file. [Details on stop_attributes.txt](https://trilliumtransit.com/gtfs/reference/#stop_attributes)
-
-```js
-import { getStopAttributes } from 'gtfs';
-
-// Get all stop attributes
-const stopAttributes = getStopAttributes();
-
-// Get stop attributes for specific stop
-const stopAttributes = getStopAttributes({
-  stop_id: '1234',
-});
-```
+### Other Non-standard GTFS Files
 
 #### getTripsDatedVehicleJourneys(query, fields, sortBy, options)
 

package/lib/gtfs-plus/calendar-attributes.js

@@ -0,0 +1,32 @@
+import sqlString from 'sqlstring-sqlite';
+
+import { openDb } from '../db.js';
+
+import {
+  formatOrderByClause,
+  formatSelectClause,
+  formatWhereClauses,
+} from '../utils.js';
+import calendarAttributes from '../../models/gtfs-plus/calendar-attributes.js';
+
+/*
+ * Returns an array of all calendar_attributes that match the query parameters.
+ */
+export function getCalendarAttributes(
+  query = {},
+  fields = [],
+  orderBy = [],
+  options = {}
+) {
+  const db = options.db ?? openDb();
+  const tableName = sqlString.escapeId(calendarAttributes.filenameBase);
+  const selectClause = formatSelectClause(fields);
+  const whereClause = formatWhereClauses(query);
+  const orderByClause = formatOrderByClause(orderBy);
+
+  return db
+    .prepare(
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+    )
+    .all();
+}

package/lib/{non-standard → gtfs-plus}/directions.js

@@ -7,7 +7,7 @@ import {
   formatSelectClause,
   formatWhereClauses,
 } from '../utils.js';
-import directions from '../../models/non-standard/directions.js';
+import directions from '../../models/gtfs-plus/directions.js';
 
 /*
  * Returns an array of all directions that match the query parameters.

package/lib/gtfs-plus/route-attributes.js

@@ -0,0 +1,32 @@
+import sqlString from 'sqlstring-sqlite';
+
+import { openDb } from '../db.js';
+
+import {
+  formatOrderByClause,
+  formatSelectClause,
+  formatWhereClauses,
+} from '../utils.js';
+import routeAttributes from '../../models/gtfs-plus/route-attributes.js';
+
+/*
+ * Returns an array of all route_attributes that match the query parameters.
+ */
+export function getRouteAttributes(
+  query = {},
+  fields = [],
+  orderBy = [],
+  options = {}
+) {
+  const db = options.db ?? openDb();
+  const tableName = sqlString.escapeId(routeAttributes.filenameBase);
+  const selectClause = formatSelectClause(fields);
+  const whereClause = formatWhereClauses(query);
+  const orderByClause = formatOrderByClause(orderBy);
+
+  return db
+    .prepare(
+      `${selectClause} FROM ${tableName} ${whereClause} ${orderByClause};`
+    )
+    .all();
+}

package/lib/{non-standard → gtfs-plus}/stop-attributes.js

@@ -7,7 +7,7 @@ import {
   formatSelectClause,
   formatWhereClauses,
 } from '../utils.js';
-import stopAttributes from '../../models/non-standard/stop-attributes.js';
+import stopAttributes from '../../models/gtfs-plus/stop-attributes.js';
 
 /*
  * Returns an array of all stop attributes that match the query parameters.

package/lib/gtfs.js

@@ -28,9 +28,13 @@ import { getTransfers } from './gtfs/transfers.js';
 import { getTranslations } from './gtfs/translations.js';
 import { getTrips } from './gtfs/trips.js';
 
+// GTFS Plus Filenames
+import { getCalendarAttributes } from './gtfs-plus/calendar-attributes.js';
+import { getDirections } from './gtfs-plus/directions.js';
+import { getRouteAttributes } from './gtfs-plus/route-attributes.js';
+import { getStopAttributes } from './gtfs-plus/stop-attributes.js';
+
 // Non-standard GTFS Filenames
-import { getDirections } from './non-standard/directions.js';
-import { getStopAttributes } from './non-standard/stop-attributes.js';
 import { getTimetables } from './non-standard/timetables.js';
 import { getTimetableStopOrders } from './non-standard/timetable-stop-order.js';
 import { getTimetablePages } from './non-standard/timetable-pages.js';
@@ -139,9 +143,15 @@ export { _getTrips as getTrips };
 const _getTranslations = getTranslations;
 export { _getTranslations as getTranslations };
 
+const _getCalendarAttributes = getCalendarAttributes;
+export { _getCalendarAttributes as getCalendarAttributes };
+
 const _getDirections = getDirections;
 export { _getDirections as getDirections };
 
+const _getRouteAttributes = getRouteAttributes;
+export { _getRouteAttributes as getRouteAttributes };
+
 const _getStopAttributes = getStopAttributes;
 export { _getStopAttributes as getStopAttributes };
 

package/models/gtfs-plus/calendar-attributes.js

@@ -0,0 +1,20 @@
+const model = {
+  filenameBase: 'calendar_attributes',
+  nonstandard: true,
+  extension: 'gtfs-plus',
+  schema: [
+    {
+      name: 'service_id',
+      type: 'varchar(255)',
+      primary: true,
+    },
+    {
+      name: 'service_description',
+      type: 'varchar(255)',
+      required: true,
+      nocase: true,
+    },
+  ],
+};
+
+export default model;

package/models/{non-standard → gtfs-plus}/directions.js

@@ -1,6 +1,7 @@
 const model = {
   filenameBase: 'directions',
   nonstandard: true,
+  extension: 'gtfs-plus',
   schema: [
     {
       name: 'id',

package/models/gtfs-plus/route-attributes.js

@@ -0,0 +1,32 @@
+const model = {
+  filenameBase: 'route_attributes',
+  nonstandard: true,
+  extension: 'gtfs-plus',
+  schema: [
+    {
+      name: 'route_id',
+      type: 'varchar(255)',
+      primary: true,
+    },
+    {
+      name: 'category',
+      type: 'integer',
+      min: 0,
+      required: true,
+    },
+    {
+      name: 'subcategory',
+      type: 'integer',
+      min: 101,
+      required: true,
+    },
+    {
+      name: 'running_way',
+      type: 'integer',
+      min: 1,
+      required: true,
+    },
+  ],
+};
+
+export default model;

package/models/{non-standard → gtfs-plus}/stop-attributes.js

@@ -1,6 +1,7 @@
 const model = {
   filenameBase: 'stop_attributes',
   nonstandard: true,
+  extension: 'gtfs-plus',
   schema: [
     {
       name: 'id',
@@ -13,6 +14,19 @@ const model = {
       required: true,
       index: true,
     },
+    {
+      name: 'accessibility_id',
+      type: 'integer',
+      min: 0,
+    },
+    {
+      name: 'cardinal_direction',
+      type: 'varchar(255)',
+    },
+    {
+      name: 'relative_position',
+      type: 'varchar(255)',
+    },
     {
       name: 'stop_city',
       type: 'varchar(255)',

package/models/models.js

@@ -21,8 +21,6 @@ import transfers from '../models/gtfs/transfers.js';
 import translations from '../models/gtfs/translations.js';
 import trips from '../models/gtfs/trips.js';
 
-import directions from '../models/non-standard/directions.js';
-import stopAttributes from '../models/non-standard/stop-attributes.js';
 import timetables from '../models/non-standard/timetables.js';
 import timetablePages from '../models/non-standard/timetable-pages.js';
 import timetableStopOrder from '../models/non-standard/timetable-stop-order.js';
@@ -30,6 +28,11 @@ import timetableNotes from '../models/non-standard/timetable-notes.js';
 import timetableNotesReferences from '../models/non-standard/timetable-notes-references.js';
 import tripsDatedVehicleJourney from '../models/non-standard/trips-dated-vehicle-journey.js';
 
+import calendarAttributes from '../models/gtfs-plus/calendar-attributes.js';
+import directions from '../models/gtfs-plus/directions.js';
+import routeAttributes from '../models/gtfs-plus/route-attributes.js';
+import stopAttributes from '../models/gtfs-plus/stop-attributes.js';
+
 import boardAlight from '../models/gtfs-ride/board-alight.js';
 import riderTrip from '../models/gtfs-ride/rider-trip.js';
 import ridership from '../models/gtfs-ride/ridership.js';
@@ -71,14 +74,16 @@ const models = [
   transfers,
   translations,
   trips,
-  directions,
-  stopAttributes,
   timetables,
   timetablePages,
   timetableStopOrder,
   timetableNotes,
   timetableNotesReferences,
   tripsDatedVehicleJourney,
+  calendarAttributes,
+  directions,
+  routeAttributes,
+  stopAttributes,
   boardAlight,
   rideFeedInfo,
   riderTrip,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "Import GTFS transit data into SQLite and query routes, stops, times, fares and more",
   "keywords": [
     "transit",
@@ -74,13 +74,13 @@
   },
   "dependencies": {
     "@turf/helpers": "^6.5.0",
-    "better-sqlite3": "^8.1.0",
-    "csv-parse": "^5.3.5",
-    "csv-stringify": "^6.2.4",
+    "better-sqlite3": "^8.3.0",
+    "csv-parse": "^5.3.6",
+    "csv-stringify": "^6.3.0",
     "gtfs-realtime-bindings": "^1.1.1",
     "lodash-es": "^4.17.21",
     "long": "^5.2.1",
-    "node-fetch": "^3.3.0",
+    "node-fetch": "^3.3.1",
     "pluralize": "^8.0.0",
     "pretty-error": "^4.0.0",
     "promise-map-series": "^0.3.0",
@@ -95,14 +95,14 @@
     "yoctocolors": "^1.0.0"
   },
   "devDependencies": {
-    "@types/better-sqlite3": "^7.6.3",
+    "@types/better-sqlite3": "^7.6.4",
     "dtslint": "^4.2.1",
-    "eslint": "^8.34.0",
-    "eslint-config-prettier": "^8.6.0",
+    "eslint": "^8.38.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-config-xo": "^0.43.1",
     "husky": "^8.0.3",
     "mocha": "^10.2.0",
-    "prettier": "^2.8.4",
+    "prettier": "^2.8.7",
     "pretty-quick": "^3.1.3",
     "should": "^13.2.3"
   },

package/test/mocha/get-calendar-attributes.js

@@ -0,0 +1,33 @@
+/* eslint-env mocha */
+
+import should from 'should';
+
+import config from '../test-config.js';
+import {
+  openDb,
+  closeDb,
+  importGtfs,
+  getCalendarAttributes,
+} from '../../index.js';
+
+describe('getCalendarAttributes():', () => {
+  before(async () => {
+    openDb(config);
+    await importGtfs(config);
+  });
+
+  after(() => {
+    const db = openDb(config);
+    closeDb(db);
+  });
+
+  it('should return empty array if no calendar attributes', () => {
+    const serviceId = 'fake-service-id';
+
+    const results = getCalendarAttributes({
+      service_id: serviceId,
+    });
+    should.exists(results);
+    results.should.have.length(0);
+  });
+});

package/test/mocha/get-route-attributes.js

@@ -0,0 +1,33 @@
+/* eslint-env mocha */
+
+import should from 'should';
+
+import config from '../test-config.js';
+import {
+  openDb,
+  closeDb,
+  importGtfs,
+  getRouteAttributes,
+} from '../../index.js';
+
+describe('getRouteAttributes():', () => {
+  before(async () => {
+    openDb(config);
+    await importGtfs(config);
+  });
+
+  after(() => {
+    const db = openDb(config);
+    closeDb(db);
+  });
+
+  it('should return empty array if no route attributes', () => {
+    const routeId = 'fake-route-id';
+
+    const results = getRouteAttributes({
+      route_id: routeId,
+    });
+    should.exists(results);
+    results.should.have.length(0);
+  });
+});