feat: Add support for timeframes.txt (#158)

@types/index.d.ts

@@ -368,6 +368,16 @@ export function getPathways(
   options?: QueryOptions,
 ): SqlResults;
 
+/**
+ * Returns an array of timeframes that match query parameters.
+ */
+export function getTimeframes(
+  query?: SqlWhere,
+  fields?: SqlSelect,
+  sortBy?: SqlOrderBy,
+  options?: QueryOptions,
+): SqlResults;
+
 /**
  * Returns an array of transfers that match query parameters.
  */

README.md

@@ -1144,6 +1144,17 @@ import { getPathways } from 'gtfs';
 const pathways = getPathways();
 ```
 
+#### getTimeframes(query, fields, sortBy, options)
+
+Returns an array of timeframes that match query parameters. [Details on timeframes.txt](https://gtfs.org/schedule/reference/#timeframestxt)
+
+```js
+import { getTimeframes } from 'gtfs';
+
+// Get all timeframes
+const timeframes = getTimeframes();
+```
+
 #### getTransfers(query, fields, sortBy, options)
 
 Returns an array of transfers that match query parameters. [Details on transfers.txt](https://gtfs.org/schedule/reference/#transferstxt)

lib/gtfs.js

@@ -24,6 +24,7 @@ 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 { getTimeframes } from './gtfs/timeframes.js';
 import { getTransfers } from './gtfs/transfers.js';
 import { getTranslations } from './gtfs/translations.js';
 import { getTrips } from './gtfs/trips.js';
@@ -134,6 +135,9 @@ export { _getStopsAsGeoJSON as getStopsAsGeoJSON };
 const _getStoptimes = getStoptimes;
 export { _getStoptimes as getStoptimes };
 
+const _getTimeframes = getTimeframes;
+export { _getTimeframes as getTimeframes };
+
 const _getTransfers = getTransfers;
 export { _getTransfers as getTransfers };
 

lib/gtfs/timeframes.js

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

models/gtfs/timesframes.js

@@ -0,0 +1,28 @@
+const model = {
+  filenameBase: 'timesframes',
+  schema: [
+    {
+      name: 'timeframe_group_id',
+      type: 'varchar(255)',
+      required: true,
+      primary: true,
+      prefix: true,
+    },
+    {
+      name: 'start_time',
+      type: 'varchar(255)',
+      default: null,
+    },
+    {
+      name: 'end_time',
+      type: 'varchar(255)',
+      default: null,
+    },
+    {
+      name: 'service_id',
+      type: 'varchar(255)',
+    },
+  ],
+};
+
+export default model;

models/models.js

@@ -17,6 +17,7 @@ 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 timeframes from '../models/gtfs/timesframes.js';
 import transfers from '../models/gtfs/transfers.js';
 import translations from '../models/gtfs/translations.js';
 import trips from '../models/gtfs/trips.js';
@@ -71,6 +72,7 @@ const models = [
   stopAreas,
   stopTimes,
   stops,
+  timeframes,
   transfers,
   translations,
   trips,

test/mocha/get-timeframes.js

@@ -0,0 +1,28 @@
+/* eslint-env mocha */
+
+import should from 'should';
+
+import config from '../test-config.js';
+import { openDb, closeDb, importGtfs, getTimeframes } from '../../index.js';
+
+describe('getTimeframes():', () => {
+  before(async () => {
+    openDb(config);
+    await importGtfs(config);
+  });
+
+  after(() => {
+    const db = openDb(config);
+    closeDb(db);
+  });
+
+  it('should return empty array if no timeframes', () => {
+    const timeframeGroupId = 'not_real';
+
+    const results = getTimeframes({
+      timeframe_group_id: timeframeGroupId,
+    });
+    should.exists(results);
+    results.should.have.length(0);
+  });
+})