gtfs 3.8.0 → 4.0.1

package/@types/index.d.ts

@@ -1,12 +1,10 @@
 import CsvParse = require('csv-parse');
-import * as Sqlite3 from 'sqlite';
-import { FeatureCollection, Geometry } from '@turf/helpers';
 
-export {}; // disable implicit exporting of types
+import Database = require('better-sqlite3');
 
-type Unpromise<T> = T extends Promise<infer U> ? U : T;
+import { FeatureCollection, Geometry } from '@turf/helpers';
 
-export type SqlDatabase = Unpromise<ReturnType<typeof Sqlite3.open>>;
+export {}; // disable implicit exporting of types
 
 export type SqlValue =
   | undefined
@@ -23,7 +21,7 @@ export type SqlSelect = string[];
 
 export type SqlOrderBy = Array<[string, 'ASC' | 'DESC']>;
 
-export type JoinTables = Array<JoinOptions>;
+export type JoinTables = JoinOptions[];
 
 export type SqlResults = Array<Record<string, any>>;
 
@@ -33,25 +31,26 @@ export type SqlTableName = string;
 
 export type Config = ExportConfig & ImportConfig;
 
-export type AdvancedQueryOptions = {
+export interface AdvancedQueryOptions {
   /**
-   * An advanced query
+   * Queries the database with support for table joins and custom tables and returns an array of data.
    */
   query?: SqlWhere;
   fields?: SqlSelect;
   orderBy?: SqlOrderBy;
-  join?: Array<JoinOptions>;
+  join?: JoinOptions[];
   options?: QueryOptions;
-};
+}
 
-export type JoinOptions = {
+export interface JoinOptions {
   /**
    * Options for joining, type
    */
   type?: 'LEFT OUTER' | 'INNER';
   table: string;
   on: string;
-};
+}
+
 interface VerboseConfig {
   /**
    * Whether or not to print output to the console. Defaults to true.
@@ -61,7 +60,7 @@ interface VerboseConfig {
 
 export interface DbConfig {
   /**
-   * A path to an SQLite database. Defaults to using an in-memory database.
+   * A path to a SQLite database. Defaults to using an in-memory database.
    */
   sqlitePath?: string;
 }
@@ -75,7 +74,7 @@ export interface ExportConfig extends DbConfig, VerboseConfig {
 
 export interface ImportConfig extends DbConfig, VerboseConfig {
   /**
-   * An array of GTFS files to be imported.
+   * An array of agencies with GTFS files to be imported.
    */
   agencies: Array<{
     /**
@@ -118,11 +117,11 @@ export interface ImportConfig extends DbConfig, VerboseConfig {
 }
 
 export interface QueryOptions {
-  db?: SqlDatabase;
+  db?: Database.Database;
 }
 
 /**
- * Use exportGtfs() in your code to run an export of a GTFS file specified in a config.json file.
+ * Use exportGtfs() in your code to run an export of a GTFS from SQLite specified in a config.json file.
  */
 export function exportGtfs(config: ExportConfig): Promise<void>;
 
@@ -137,62 +136,67 @@ export function importGtfs(config: ImportConfig): Promise<void>;
 export function updateGtfsRealtime(config: ImportConfig): Promise<void>;
 
 /**
- * Open database before making any queries.
+ * Opens the database specified in the config object.
  */
-export function openDb(config: DbConfig): Promise<SqlDatabase>;
+export function openDb(config: DbConfig): Database.Database;
 
 /**
- * Closes open database.
+ * Closes the specified database.
  */
-export function closeDb(db?: SqlDatabase): Promise<void>;
+export function closeDb(db?: Database.Database): void;
 
 /**
- * Get open database. Throws error if no database is open.
+ * Returns an array of agencies that match query parameters.
  */
-export function getDb(config?: DbConfig): Promise<SqlDatabase>;
+export function getAgencies(
+  query?: SqlWhere,
+  fields?: SqlSelect,
+  sortBy?: SqlOrderBy,
+  options?: QueryOptions
+): SqlResults;
 
 /**
- * Queries agencies and returns a promise for an array of agencies.
+ * Returns an array of areas that match query parameters.
  */
-export function getAgencies(
+export function getAreas(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries attributions and returns a promise for an array of attributions.
+ * Returns an array of attributions that match query parameters.
  */
 export function getAttributions(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries routes and returns a promise for an array of routes.
+ * Returns an array of routes that match query parameters.
  */
 export function getRoutes(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries stops and returns a promise for an array of stops.
+ * Returns an array of stops that match query parameters.
  */
 export function getStops(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries stops and returns a promise for an geoJSON object of stops.
+ * Returns geoJSON object of stops that match query parameters.
  * All valid queries for `getStops()` work for `getStopsAsGeoJSON()`.
  */
 export function getStopsAsGeoJSON(
@@ -201,310 +205,315 @@ export function getStopsAsGeoJSON(
 ): Promise<FeatureCollection<Geometry, { [name: string]: any }>>;
 
 /**
- * Queries `stop_times` and returns a promise for an array of stop_times.
+ * Returns an array of stop_times that match query parameters.
  */
 export function getStoptimes(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries trips and returns a promise for an array of trips.
+ * Returns an array of trips that match query parameters.
  */
 export function getTrips(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries shapes and returns a promise for an array of shapes.
+ * Returns an array of shapes that match query parameters.
  */
 export function getShapes(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries shapes and returns a promise for an geoJSON object of shapes.
+ * Returns a geoJSON object of shapes that match query parameters.
  * All valid queries for `getShapes()` work for `getShapesAsGeoJSON()`.
  */
 export function getShapesAsGeoJSON(
   query?: SqlWhere,
   options?: QueryOptions
-): Promise<FeatureCollection<Geometry, { [name: string]: any }>>;
+): FeatureCollection<Geometry, { [name: string]: any }>;
 
 /**
- * Queries calendars and returns a promise for an array of calendars.
+ * Returns an array of calendars that match query parameters.
  */
 export function getCalendars(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries calendar_dates and returns a promise for an array of calendar_dates.
+ * Returns an array of calendar_dates that match query parameters.
  */
 export function getCalendarDates(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries fare_attributes and returns a promise for an array of fare_attributes.
+ * Returns an array of fare_attributes that match query parameters.
  */
 export function getFareAttributes(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries fare_rules and returns a promise for an array of fare_rules.
+ * Returns an array of fare_leg_rules that match query parameters.
  */
-export function getFareRules(
+export function getFareLegRules(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries feed_info and returns a promise for an array of feed_infos.
+ * Returns an array of fare_products that match query parameters.
  */
-export function getFeedInfo(
+export function getFareProducts(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries frequencies and returns a promise for an array of frequencies.
+ * Returns an array of fare_rules that match query parameters.
  */
-export function getFrequencies(
+export function getFareRules(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries levels and returns a promise for an array of levels.
+ * Returns an array of fare_transfer_rules that match query parameters.
  */
-export function getLevels(
+export function getFareTransferRules(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries pathways and returns a promise for an array of pathways.
+ * Returns an array of feed_info that match query parameters.
  */
-export function getPathways(
+export function getFeedInfo(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries transfers and returns a promise for an array of transfers.
+ * Returns an array of frequencies that match query parameters.
  */
-export function getTransfers(
+export function getFrequencies(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries translations and returns a promise for an array of translations.
+ * Returns an array of levels that match query parameters.
  */
-export function getTranslations(
+export function getLevels(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries directions and returns a promise for an array of directions.
- * These are from the non-standard `directions.txt` file.
+ * Returns an array of pathways that match query parameters.
  */
-export function getDirections(
+export function getPathways(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries stop_attributes and returns a promise for an array of stop_attributes.
- * These are from the non-standard `stop_attributes.txt` file.
+ * Returns an array of transfers that match query parameters.
  */
-export function getStopAttributes(
+export function getTransfers(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries timetables and returns a promise for an array of timetables.
- * These are from the non-standard `timetables.txt` file.
+ * Returns an array of translations that match query parameters.
  */
-export function getTimetables(
+export function getTranslations(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries timetable_stop_orders and returns a promise for an array of timetable_stop_orders.
- * These are from the non-standard `timetable_stop_order.txt` file.
+ * Returns an array of stop_areas that match query parameters.
  */
-export function getTimetableStopOrders(
+export function getStopAreas(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries timetable_pages and returns a promise for an array of timetable_pages.
- * These are from the non-standard `timetable_pages.txt` file.
+ * Returns an array of directions that match query parameters.
+ * This is for the non-standard `directions.txt` file.
  */
-export function getTimetablePages(
+export function getDirections(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries timetable_notes and returns a promise for an array of timetable_notes.
- * These are from the non-standard `timetable_notes.txt` file.
+ * Returns an array of stop_attributes that match query parameters.
+ * This is for the non-standard `stop_attributes.txt` file.
  */
-export function getTimetableNotes(
+export function getStopAttributes(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries timetable_notes_references and returns a promise for an array of timetable_notes references.
- * These are from the non-standard `timetable_notes_references.txt` file.
+ * Returns an array of timetables that match query parameters.
+ * This is for the non-standard `timetables.txt` file used in GTFS-to-HTML.
  */
-export function getTimetableNotesReferences(
+export function getTimetables(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries board-alights and returns a promise for an array of board-alights.
+ * Returns an array of timetable_stop_orders that match query parameters.
+ * This is for the non-standard `timetable_stop_order.txt` file used in GTFS-to-HTML.
  */
-export function getBoardAlights(
+export function getTimetableStopOrders(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries ride-feed-info and returns a promise for an array of ride-feed-info.
+ * Returns an array of timetable_pages that match query parameters.
+ * This is for the non-standard `timetable_pages.txt` file used in GTFS-to-HTML.
  */
-export function getRideFeedInfos(
+export function getTimetablePages(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries rider trips and returns a promise for an array of rider trips.
+ * Returns an array of timetable_notes that match query parameters.
+ * This is for the non-standard `timetable_notes.txt` file used in GTFS-to-HTML.
  */
-export function getRiderTrips(
+export function getTimetableNotes(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries riderships and returns a promise for an array of riderships.
+ * Returns an array of timetable_notes_references that match query parameters.
+ * This is for the non-standard `timetable_notes_references.txt` file used in GTFS-to-HTML.
  */
-export function getRiderships(
+export function getTimetableNotesReferences(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries trip-capacities and returns a promise for an array of trip-capacities.
+ * Returns an array of trips_dated_vehicle_journey that match query parameters.
+ * This is for the non-standard `trips_dated_vehicle_journey.txt` file.
  */
-export function getTripCapacities(
+export function getTripsDatedVehicleJourneys(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries trip-capacities and returns a promise for an array of service-alerts.
+ * Returns an array of GTFS Realtime service alerts that match query parameters.
+ * This only works if you configure GTFS Realtime import in node-gtfs.
  */
 export function getServiceAlerts(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries trip-capacities and returns a promise for an array of trip-updates.
+ * Returns an array of GTFS Realtime trip updates that match query parameters.
+ * This only works if you configure GTFS Realtime import in node-gtfs.
  */
 export function getTripUpdates(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries trip-capacities and returns a promise for an array of vehicle-positions.
+ * Returns an array of GTFS Realtime stop time updates that match query parameters.
+ * This only works if you configure GTFS Realtime import in node-gtfs.
  */
-export function getVehiclePositions(
+export function getStopTimesUpdates(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
- * Queries trip-capacities and returns a promise for an array of stop-times-updates.
+ * Returns an array of GTFS Realtime vehicle positions that match query parameters.
+ * This only works if you configure GTFS Realtime import in node-gtfs.
  */
-export function getStopTimesUpdates(
+export function getVehiclePositions(
   query?: SqlWhere,
   fields?: SqlSelect,
   sortBy?: SqlOrderBy,
   options?: QueryOptions
-): Promise<SqlResults>;
+): SqlResults;
 
 /**
  * Runs an advanced query.
@@ -512,20 +521,4 @@ export function getStopTimesUpdates(
 export function advancedQuery(
   table?: SqlTableName,
   advancedQueryOptions?: AdvancedQueryOptions
-): Promise<SqlResults>;
-
-/**
- * Runs an raw query retuning all rows.
- */
-export function runRawQuery(
-  sql?: SqlQueryString,
-  options?: QueryOptions
-): Promise<SqlResults>;
-
-/**
- * Executing an raw query.
- */
-export function execRawQuery(
-  sql?: SqlQueryString,
-  options?: QueryOptions
-): Promise<any>;
+): SqlResults;

package/@types/tests.ts

@@ -1,4 +1,11 @@
-import { Config, exportGtfs, getAgencies, getDb, getShapesAsGeoJSON, importGtfs, openDb } from "gtfs";
+import {
+  Config,
+  exportGtfs,
+  getAgencies,
+  getShapesAsGeoJSON,
+  importGtfs,
+  openDb,
+} from 'gtfs';
 
 /**
  * This is type-checked (but not executed) by dtslint.
@@ -6,21 +13,19 @@ import { Config, exportGtfs, getAgencies, getDb, getShapesAsGeoJSON, importGtfs,
  */
 
 (async () => {
-    const config: Config = {
-        agencies: [{ path: "example.zip" }],
-        verbose: false,
-    };
+  const config: Config = {
+    agencies: [{ path: 'example.zip' }],
+    verbose: false,
+  };
 
-    await importGtfs(config); // $ExpectType void
+  await importGtfs(config); // $ExpectType void
 
-    await exportGtfs(config); // $ExpectType void
+  await exportGtfs(config); // $ExpectType void
 
-    await openDb(config); // $ExpectType Database<Database, Statement>
+  openDb(config); // $ExpectType Database
 
-    await getDb(); // $ExpectType Database<Database, Statement>
+  const results = getAgencies();
+  results[0]; // $ExpectType Record<string, any>
 
-    const results = await getAgencies();
-    results[0]; // $ExpectType Record<string, any>
-
-    await getShapesAsGeoJSON(); // $ExpectType FeatureCollection<Geometry, { [name: string]: any; }>
+  getShapesAsGeoJSON(); // $ExpectType FeatureCollection<Geometry, { [name: string]: any; }>
 })();

package/CHANGELOG.md

@@ -5,6 +5,24 @@ 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.0.1] - 2022-12-31
+
+### Updated
+
+- Update types info
+- Improved readme
+- Improved queries
+
+## [4.0.0] - 2022-12-30
+
+### Changed
+
+- Use better-sqlite3 library
+- Make all query methods synchronous
+- Remove `runRawQuery` (use Raw SQLite query instead)
+- Remove `execRawQuery` (use Raw SQLite query instead)
+- Remove `getDb` (use `openDb` instead)
+
 ## [3.8.0] - 2022-12-22
 
 ### Updated