gtfs 4.1.1 → 4.2.0

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).
 
+## [4.2.0] - 2023-04-13
+
+### Updated
+
+- Add route_attributes to getShapesAsGeoJSON() function as geojson properties
+- Add stop_attributes to getStopsAsGeoJSON() function as geojson properties
+- Support for multi-column primary keys
+
 ## [4.1.1] - 2023-04-12
 
 ### Added

package/README.md

@@ -692,7 +692,7 @@ const stops = getStops({
 
 #### getStopsAsGeoJSON(query, options)
 
-Returns geoJSON object of stops that match query parameters. All valid queries for `getStops()` work for `getStopsAsGeoJSON()`.
+Returns geoJSON object of stops that match query parameters. Stops will include all properties of each stop from stops.txt and stop_attributes.txt if present. All valid queries for `getStops()` work for `getStopsAsGeoJSON()`.
 
 ```js
 import { getStopsAsGeoJSON } from 'gtfs';
@@ -804,7 +804,7 @@ const shapes = getShapes({
 
 #### getShapesAsGeoJSON(query, options)
 
-Returns a geoJSON object of shapes that match query parameters. All valid queries for `getShapes()` work for `getShapesAsGeoJSON()`.
+Returns a geoJSON object of shapes that match query parameters. Shapes will include all properties of each route from routes.txt and route_attributes.txt if present. All valid queries for `getShapes()` work for `getShapesAsGeoJSON()`.
 
 ```js
 import { getShapesAsGeoJSON } from 'gtfs';

package/lib/gtfs/shapes.js

@@ -14,6 +14,7 @@ import { shapesToGeoJSONFeatures } from '../geojson-utils.js';
 import shapes from '../../models/gtfs/shapes.js';
 import { getAgencies } from './agencies.js';
 import { getRoutes } from './routes.js';
+import { getRouteAttributes } from '../gtfs-plus/route-attributes.js';
 
 function buildTripSubquery(query) {
   const whereClause = formatWhereClauses(query);
@@ -92,6 +93,12 @@ export function getShapesAsGeoJSON(query = {}, options = {}) {
       [],
       options
     );
+    const routeAttributes = getRouteAttributes(
+      { route_id: route.route_id },
+      [],
+      [],
+      options
+    );
 
     const agency = agencies.find(
       (agency) => agency.agency_id === route.agency_id
@@ -101,6 +108,7 @@ export function getShapesAsGeoJSON(query = {}, options = {}) {
       agency_name: agency ? agency.agency_name : undefined,
       shape_id: query.shape_id,
       ...route,
+      ...(routeAttributes?.[0] || []),
     };
     features.push(...shapesToGeoJSONFeatures(shapes, geojsonProperties));
   }

package/lib/gtfs/stops.js

@@ -12,6 +12,7 @@ import {
 import { stopsToGeoJSON } from '../geojson-utils.js';
 import stops from '../../models/gtfs/stops.js';
 import { getAgencies } from './agencies.js';
+import { getStopAttributes } from '../gtfs-plus/stop-attributes.js';
 
 function buildTripSubquery(query) {
   const whereClause = formatWhereClauses(query);
@@ -89,12 +90,17 @@ export function getStopsAsGeoJSON(query = {}, options = {}) {
       .prepare(`SELECT * FROM routes WHERE route_id IN (${routeSubquery})`)
       .all(stop.stop_id);
 
+    const stopAttributes = getStopAttributes({ stop_id: stop.stop_id });
+
     stop.routes = orderBy(routes, (route) =>
       Number.parseInt(route.route_short_name, 10)
     );
     stop.agency_name = agencies[0].agency_name;
 
-    return stop;
+    return {
+      ...stop,
+      ...(stopAttributes?.[0] || []),
+    };
   });
 
   // Exclude stops not part of any route

package/lib/import.js

@@ -329,13 +329,23 @@ const createTables = (db) => {
         check = `CHECK( ${column.name} <= ${column.max} )`;
       }
 
-      const primary = column.primary ? 'PRIMARY KEY' : '';
       const required = column.required ? 'NOT NULL' : '';
       const columnDefault = column.default ? 'DEFAULT ' + column.default : '';
       const columnCollation = column.nocase ? 'COLLATE NOCASE' : '';
-      return `${column.name} ${column.type} ${check} ${primary} ${required} ${columnDefault} ${columnCollation}`;
+      return `${column.name} ${column.type} ${check} ${required} ${columnDefault} ${columnCollation}`;
     });
 
+    // Find Primary Key fields
+    const primaryColumns = model.schema.filter((column) => column.primary);
+
+    if (primaryColumns.length > 0) {
+      columns.push(
+        `PRIMARY KEY (${primaryColumns
+          .map((column) => column.name)
+          .join(', ')})`
+      );
+    }
+
     db.prepare(`DROP TABLE IF EXISTS ${model.filenameBase};`).run();
 
     db.prepare(

package/models/gtfs/agency.js

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

package/models/gtfs/attributions.js

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

package/models/gtfs/calendar-dates.js

@@ -1,22 +1,17 @@
 const model = {
   filenameBase: 'calendar_dates',
   schema: [
-    {
-      name: 'id',
-      type: 'integer',
-      primary: true,
-    },
     {
       name: 'service_id',
       type: 'varchar(255)',
       required: true,
-      index: true,
+      primary: true,
     },
     {
       name: 'date',
       type: 'integer',
       required: true,
-      index: true,
+      primary: true,
     },
     {
       name: 'exception_type',

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

@@ -8,19 +8,23 @@ const model = {
     {
       name: 'network_id',
       type: 'varchar(255)',
+      primary: true,
     },
     {
       name: 'from_area_id',
       type: 'varchar(255)',
+      primary: true,
     },
     {
       name: 'to_area_id',
       type: 'varchar(255)',
+      primary: true,
     },
     {
       name: 'fare_product_id',
       type: 'varchar(255)',
       required: true,
+      primary: true,
     },
   ],
 };

package/models/gtfs/fare-products.js

@@ -11,6 +11,11 @@ const model = {
       name: 'fare_product_name',
       type: 'varchar(255)',
     },
+    {
+      name: 'fare_media_id',
+      type: 'varchar(255)',
+      primary: true,
+    },
     {
       name: 'amount',
       type: 'real',

package/models/gtfs/fare-rules.js

@@ -1,11 +1,6 @@
 const model = {
   filenameBase: 'fare_rules',
   schema: [
-    {
-      name: 'id',
-      type: 'integer',
-      primary: true,
-    },
     {
       name: 'fare_id',
       type: 'varchar(255)',

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

@@ -4,15 +4,18 @@ const model = {
     {
       name: 'from_leg_group_id',
       type: 'varchar(255)',
+      primary: true,
     },
     {
       name: 'to_leg_group_id',
       type: 'varchar(255)',
+      primary: true,
     },
     {
       name: 'transfer_count',
       type: 'integer',
       min: -1,
+      primary: true,
     },
     {
       name: 'transfer_id',
@@ -22,6 +25,7 @@ const model = {
       name: 'duration_limit',
       type: 'integer',
       min: 0,
+      primary: true,
     },
     {
       name: 'duration_limit_type',
@@ -34,10 +38,12 @@ const model = {
       type: 'integer',
       min: 0,
       max: 2,
+      required: true,
     },
     {
       name: 'fare_product_id',
       type: 'varchar(255)',
+      primary: true,
     },
   ],
 };

package/models/gtfs/feed-info.js

@@ -1,11 +1,6 @@
 const model = {
   filenameBase: 'feed_info',
   schema: [
-    {
-      name: 'id',
-      type: 'integer',
-      primary: true,
-    },
     {
       name: 'feed_publisher_name',
       type: 'varchar(255)',

package/models/gtfs/frequencies.js

@@ -1,21 +1,17 @@
 const model = {
   filenameBase: 'frequencies',
   schema: [
-    {
-      name: 'id',
-      type: 'integer',
-      primary: true,
-    },
     {
       name: 'trip_id',
       type: 'varchar(255)',
       required: true,
-      index: true,
+      primary: true,
     },
     {
       name: 'start_time',
       type: 'varchar(255)',
       required: true,
+      primary: true,
     },
     {
       name: 'start_timestamp',

package/models/gtfs/shapes.js

@@ -1,16 +1,11 @@
 const model = {
   filenameBase: 'shapes',
   schema: [
-    {
-      name: 'id',
-      type: 'integer',
-      primary: true,
-    },
     {
       name: 'shape_id',
       type: 'varchar(255)',
       required: true,
-      index: true,
+      primary: true,
     },
     {
       name: 'shape_pt_lat',
@@ -30,6 +25,7 @@ const model = {
       name: 'shape_pt_sequence',
       type: 'integer',
       required: true,
+      primary: true,
       min: 0,
     },
     {

package/models/gtfs/stop-times.js

@@ -1,16 +1,11 @@
 const model = {
   filenameBase: 'stop_times',
   schema: [
-    {
-      name: 'id',
-      type: 'integer',
-      primary: true,
-    },
     {
       name: 'trip_id',
       type: 'varchar(255)',
       required: true,
-      index: true,
+      primary: true,
     },
     {
       name: 'arrival_time',
@@ -39,8 +34,8 @@ const model = {
       name: 'stop_sequence',
       type: 'integer',
       required: true,
+      primary: true,
       min: 0,
-      index: true,
     },
     {
       name: 'stop_headsign',

package/models/gtfs/transfers.js

@@ -1,44 +1,42 @@
 const model = {
   filenameBase: 'transfers',
   schema: [
-    {
-      name: 'id',
-      type: 'integer',
-      primary: true,
-    },
     {
       name: 'from_stop_id',
       type: 'varchar(255)',
-      index: true,
+      primary: true,
     },
     {
       name: 'to_stop_id',
       type: 'varchar(255)',
-      index: true,
+      primary: true,
     },
     {
       name: 'from_route_id',
       type: 'varchar(255)',
+      primary: true,
     },
     {
       name: 'to_route_id',
       type: 'varchar(255)',
+      primary: true,
     },
     {
       name: 'from_trip_id',
       type: 'varchar(255)',
+      primary: true,
     },
     {
       name: 'to_trip_id',
       type: 'varchar(255)',
+      primary: true,
     },
     {
       name: 'transfer_type',
       type: 'integer',
       min: 0,
       max: 5,
-      required: false,
-      default: 0
+      default: 0,
     },
     {
       name: 'min_transfer_time',

package/models/gtfs/translations.js

@@ -1,24 +1,22 @@
 const model = {
   filenameBase: 'translations',
   schema: [
-    {
-      name: 'id',
-      type: 'integer',
-      primary: true,
-    },
     {
       name: 'table_name',
       type: 'varchar(255)',
+      primary: true,
       required: true,
     },
     {
       name: 'field_name',
       type: 'varchar(255)',
+      primary: true,
       required: true,
     },
     {
       name: 'language',
       type: 'varchar(255)',
+      primary: true,
       required: true,
     },
     {
@@ -29,14 +27,17 @@ const model = {
     {
       name: 'record_id',
       type: 'varchar(255)',
+      primary: true,
     },
     {
       name: 'record_sub_id',
       type: 'varchar(255)',
+      primary: true,
     },
     {
       name: 'field_value',
       type: 'varchar(2047)',
+      primary: true,
     },
   ],
 };

package/models/gtfs-plus/directions.js

@@ -3,23 +3,18 @@ const model = {
   nonstandard: true,
   extension: 'gtfs-plus',
   schema: [
-    {
-      name: 'id',
-      type: 'integer',
-      primary: true,
-    },
     {
       name: 'route_id',
       type: 'varchar(255)',
       required: true,
-      index: true,
+      primary: true,
     },
     {
       name: 'direction_id',
       type: 'integer',
       min: 0,
       max: 1,
-      index: true,
+      primary: true,
     },
     {
       name: 'direction',

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

@@ -3,16 +3,11 @@ const model = {
   nonstandard: true,
   extension: 'gtfs-plus',
   schema: [
-    {
-      name: 'id',
-      type: 'integer',
-      primary: true,
-    },
     {
       name: 'stop_id',
       type: 'varchar(255)',
       required: true,
-      index: true,
+      primary: true,
     },
     {
       name: 'accessibility_id',

package/models/gtfs-realtime/service-alert-targets.js

@@ -7,7 +7,6 @@ const model = {
       type: 'varchar(255)',
       required: true,
       primary: true,
-      index: true,
       source: 'parent.id',
     },
     {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "description": "Import GTFS transit data into SQLite and query routes, stops, times, fares and more",
   "keywords": [
     "transit",

package/test/mocha/advanced-query.js

@@ -57,14 +57,14 @@ describe('advancedQuery():', () => {
     const results = advancedQuery('stop_times', advancedQueryOptions);
 
     const expectedResults = [
-      { trip_id: '329', arrival_time: '9:09:00' },
-      { trip_id: '329', arrival_time: '8:52:00' },
-      { trip_id: '329', arrival_time: '8:44:00' },
-      { trip_id: '329', arrival_time: '8:35:00' },
-      { trip_id: '329', arrival_time: '8:27:00' },
-      { trip_id: '329', arrival_time: '8:16:00' },
-      { trip_id: '329', arrival_time: '8:03:00' },
       { trip_id: '329', arrival_time: '7:56:00' },
+      { trip_id: '329', arrival_time: '8:03:00' },
+      { trip_id: '329', arrival_time: '8:16:00' },
+      { trip_id: '329', arrival_time: '8:27:00' },
+      { trip_id: '329', arrival_time: '8:35:00' },
+      { trip_id: '329', arrival_time: '8:44:00' },
+      { trip_id: '329', arrival_time: '8:52:00' },
+      { trip_id: '329', arrival_time: '9:09:00' },
     ];
 
     should.exist(results);

package/test/mocha/get-agencies.js

@@ -28,7 +28,6 @@ describe('getAgencies():', () => {
     const results = getAgencies();
 
     const expectedResult = {
-      id: 1,
       agency_id: 'CT',
       agency_name: 'Caltrain',
       agency_url: 'http://www.caltrain.com',
@@ -54,7 +53,6 @@ describe('getAgencies():', () => {
     });
 
     const expectedResult = {
-      id: 1,
       agency_id: 'CT',
       agency_name: 'Caltrain',
       agency_url: 'http://www.caltrain.com',

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

@@ -38,28 +38,24 @@ describe('getCalendarDates():', () => {
 
     const expectedResults = [
       {
-        id: 2,
         service_id: 'CT-16APR-Caltrain-Weekday-01',
         date: 20161124,
         exception_type: 2,
         holiday_name: null,
       },
       {
-        id: 4,
         service_id: 'CT-16APR-Caltrain-Weekday-01',
         date: 20160905,
         exception_type: 2,
         holiday_name: null,
       },
       {
-        id: 6,
         service_id: 'CT-16APR-Caltrain-Weekday-01',
         date: 20160704,
         exception_type: 2,
         holiday_name: null,
       },
       {
-        id: 8,
         service_id: 'CT-16APR-Caltrain-Weekday-01',
         date: 20160530,
         exception_type: 2,

package/test/mocha/open-db.js

@@ -83,7 +83,6 @@ describe('openDb():', () => {
     );
 
     const expectedResult = {
-      id: 1424,
       shape_id: 'cal_sf_tam',
       shape_pt_lat: 37.45375587083584,
       shape_pt_lon: -122.18063950538635,