gtfs 4.13.4 → 4.14.1

package/dist/index.d.ts

@@ -2,7 +2,26 @@ import CsvParse from 'csv-parse';
 import Database from 'better-sqlite3';
 import { FeatureCollection } from 'geojson';
 
-interface IConfig {
+interface ConfigAgency {
+    exclude?: string[];
+    url?: string;
+    path?: string;
+    headers?: Record<string, string>;
+    realtimeAlerts?: {
+        url: string;
+        headers?: Record<string, string>;
+    };
+    realtimeTripUpdates?: {
+        url: string;
+        headers?: Record<string, string>;
+    };
+    realtimeVehiclePositions?: {
+        url: string;
+        headers?: Record<string, string>;
+    };
+    prefix?: string;
+}
+interface Config {
     db?: Database.Database;
     sqlitePath?: string;
     ignoreDuplicates?: boolean;
@@ -11,15 +30,7 @@ interface IConfig {
     csvOptions?: CsvParse.Options;
     exportPath?: string;
     ignoreErrors?: boolean;
-    agencies: {
-        exclude?: string[];
-        url?: string;
-        path?: string;
-        headers?: Record<string, string>;
-        realtimeHeaders?: Record<string, string>;
-        realtimeUrls?: string[];
-        prefix?: string;
-    }[];
+    agencies: ConfigAgency[];
     verbose?: boolean;
     logFunction?: (message: string) => void;
 }
@@ -37,11 +48,282 @@ interface QueryOptions {
     bounding_box_side_m?: number;
 }
 type SqlResults = Array<Record<string, any>>;
+interface Agency {
+    agency_id?: string;
+    agency_name: string;
+    agency_url: string;
+    agency_timezone: string;
+    agency_lang?: string;
+    agency_phone?: string;
+    agency_fare_url?: string;
+    agency_email?: string;
+}
+interface Area {
+    area_id: string;
+    area_name?: string;
+}
+interface Attribution {
+    attribution_id?: string;
+    agency_id?: string;
+    route_id?: string;
+    trip_id?: string;
+    organization_name: string;
+    is_producer?: 0 | 1;
+    is_operator?: 0 | 1;
+    is_authority?: 0 | 1;
+    attribution_url?: string;
+    attribution_email?: string;
+    attribution_phone?: string;
+}
+interface BookingRule {
+    booking_rule_id: string;
+    booking_type: 0 | 1 | 2;
+    prior_notice_duration_min?: number;
+    prior_notice_duration_max?: number;
+    prior_notice_last_day?: number;
+    prior_notice_last_time?: string;
+    prior_notice_last_timestamp?: number;
+    prior_notice_start_day?: number;
+    prior_notice_start_time?: string;
+    prior_notice_start_timestamp?: number;
+    prior_notice_service_id?: string;
+    message?: string;
+    pickup_message?: string;
+    drop_off_message?: string;
+    phone_number?: string;
+    info_url?: string;
+    booking_url?: string;
+}
+interface Calendar {
+    service_id: string;
+    monday: 0 | 1;
+    tuesday: 0 | 1;
+    wednesday: 0 | 1;
+    thursday: 0 | 1;
+    friday: 0 | 1;
+    saturday: 0 | 1;
+    sunday: 0 | 1;
+    start_date: number;
+    end_date: number;
+}
+interface CalendarDate {
+    service_id: string;
+    date: number;
+    exception_type: 1 | 2;
+    holiday_name?: string;
+}
+interface FareAttribute {
+    fare_id: string;
+    price: number;
+    currency_type: string;
+    payment_method: 0 | 1;
+    transfers: 0 | 1 | 2;
+    agency_id?: string;
+    transfer_duration?: number;
+}
+interface FareLegRule {
+    leg_group_id?: string;
+    network_id?: string;
+    from_area_id?: string;
+    to_area_id?: string;
+    from_timeframe_group_id?: string;
+    to_timeframe_group_id?: string;
+    fare_product_id: string;
+    rule_priority?: number;
+}
+interface FareMedia {
+    fare_media_id: string;
+    fare_media_name?: string;
+    fare_media_type: 0 | 1 | 2 | 3 | 4;
+}
+interface FareProduct {
+    fare_product_id: string;
+    fare_product_name?: string;
+    fare_media_id?: string;
+    amount: number;
+    currency: string;
+}
+interface FareRule {
+    fare_id: string;
+    route_id?: string;
+    origin_id?: string;
+    destination_id?: string;
+    contains_id?: string;
+}
+interface FareTransferRule {
+    from_leg_group_id?: string;
+    to_leg_group_id?: string;
+    transfer_count?: number;
+    duration_limit: number;
+    duration_limit_type?: 0 | 1 | 2 | 3;
+    fare_transfer_type: 0 | 1 | 2;
+    fare_product_id?: string;
+}
+interface FeedInfo {
+    feed_publisher_name: string;
+    feed_publisher_url: string;
+    feed_lang: string;
+    default_lang?: string;
+    feed_start_date?: number;
+    feed_end_date?: number;
+    feed_version?: string;
+    feed_contact_email?: string;
+    feed_contact_url?: string;
+}
+interface Frequency {
+    trip_id: string;
+    start_time: string;
+    start_timestamp: number;
+    end_time: string;
+    end_timestamp: number;
+    headway_secs: number;
+    exact_times?: 0 | 1;
+}
+interface Level {
+    level_id: string;
+    level_index: number;
+    level_name?: string;
+}
+interface LocationGroupStop {
+    location_group_id: string;
+    stop_id: string;
+}
+interface LocationGroup {
+    location_group_id: string;
+    location_group_name?: string;
+}
+interface Location {
+    geojson: string;
+}
+interface Network {
+    network_id: string;
+    network_name?: string;
+}
+interface Pathway {
+    pathway_id: string;
+    from_stop_id: string;
+    to_stop_id: string;
+    pathway_mode: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+    is_bidirectional: 0 | 1;
+    length?: number;
+    traversal_time?: number;
+    stair_count?: number;
+    max_slope?: number;
+    min_width?: number;
+    signposted_as?: string;
+    reversed_signposted_as?: string;
+}
+interface RouteNetwork {
+    network_id: string;
+    route_id: string;
+}
+interface Route {
+    route_id: string;
+    agency_id?: string;
+    route_short_name?: string;
+    route_long_name?: string;
+    route_desc?: string;
+    route_type: number;
+    route_url?: string;
+    route_color?: string;
+    route_text_color?: string;
+    route_sort_order?: number;
+    continuous_pickup?: 0 | 1 | 2 | 3;
+    continuous_drop_off?: 0 | 1 | 2 | 3;
+    network_id?: string;
+}
+interface Shape {
+    shape_id: string;
+    shape_pt_lat: number;
+    shape_pt_lon: number;
+    shape_pt_sequence: number;
+    shape_dist_traveled?: number;
+}
+interface StopArea {
+    area_id: string;
+    stop_id: string;
+}
+interface StopTime {
+    trip_id: string;
+    arrival_time?: string;
+    arrival_timestamp?: number;
+    departure_time?: string;
+    departure_timestamp?: number;
+    location_group_id?: string;
+    location_id?: string;
+    stop_id?: string;
+    stop_sequence: number;
+    stop_headsign?: string;
+    start_pickup_drop_off_window?: string;
+    start_pickup_drop_off_window_timestamp?: number;
+    pickup_type?: 0 | 1 | 2 | 3;
+    drop_off_type?: 0 | 1 | 2 | 3;
+    continuous_pickup?: 0 | 1 | 2 | 3;
+    continuous_drop_off?: 0 | 1 | 2 | 3;
+    shape_dist_traveled?: number;
+    timepoint?: 0 | 1;
+    pickup_booking_rule_id?: string;
+    drop_off_booking_rule_id?: string;
+}
+interface Stop {
+    stop_id: string;
+    stop_code?: string;
+    stop_name?: string;
+    tts_stop_name?: string;
+    stop_desc?: string;
+    stop_lat?: number;
+    stop_lon?: number;
+    zone_id?: string;
+    stop_url?: string;
+    location_type?: 0 | 1 | 2 | 3 | 4;
+    parent_station?: string;
+    stop_timezone?: string;
+    wheelchair_boarding?: 0 | 1 | 2;
+    level_id?: string;
+    platform_code?: string;
+}
+interface Timeframe {
+    timeframe_group_id: string;
+    start_time?: string;
+    end_time?: string;
+    service_id: string;
+}
+interface Transfer {
+    from_stop_id?: string;
+    to_stop_id?: string;
+    from_route_id?: string;
+    to_route_id?: string;
+    from_trip_id?: string;
+    to_trip_id?: string;
+    transfer_type: 0 | 1 | 2 | 3 | 4 | 5;
+    min_transfer_time?: number;
+}
+interface Translation {
+    table_name: string;
+    field_name: string;
+    language: string;
+    translation: string;
+    record_id?: string;
+    record_sub_id?: string;
+    field_value?: string;
+}
+interface Trip {
+    route_id: string;
+    service_id: string;
+    trip_id: string;
+    trip_headsign?: string;
+    trip_short_name?: string;
+    direction_id?: 0 | 1;
+    block_id?: string;
+    shape_id?: string;
+    wheelchair_accessible?: 0 | 1 | 2;
+    bikes_allowed?: 0 | 1 | 2;
+}
 
-declare function importGtfs(initialConfig: IConfig): Promise<void>;
-declare function updateGtfsRealtime(initialConfig: IConfig): Promise<void>;
+declare function importGtfs(initialConfig: Config): Promise<void>;
+declare function updateGtfsRealtime(initialConfig: Config): Promise<void>;
 
-declare const exportGtfs: (initialConfig: IConfig) => Promise<void>;
+declare const exportGtfs: (initialConfig: Config) => Promise<void>;
 
 declare function openDb(config?: {
     db?: Database.Database;
@@ -59,67 +341,67 @@ declare function advancedQuery(table: string, advancedQueryOptions: {
     options?: QueryOptions;
 }): Array<Record<string, any>>;
 
-declare function getAgencies(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getAgencies(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Agency[];
 
-declare function getAreas(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getAreas(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Area[];
 
-declare function getAttributions(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getAttributions(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Attribution[];
 
-declare function getBookingRules(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getBookingRules(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): BookingRule[];
 
-declare function getCalendarDates(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getCalendarDates(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): CalendarDate[];
 
-declare function getCalendars(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getCalendars(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Calendar[];
 
-declare function getFareAttributes(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getFareAttributes(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): FareAttribute[];
 
-declare function getFareLegRules(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getFareLegRules(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): FareLegRule[];
 
-declare function getFareMedia(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getFareMedia(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): FareMedia[];
 
-declare function getFareProducts(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getFareProducts(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): FareProduct[];
 
-declare function getFareRules(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getFareRules(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): FareRule[];
 
-declare function getFareTransferRules(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getFareTransferRules(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): FareTransferRule[];
 
-declare function getFeedInfo(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getFeedInfo(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): FeedInfo[];
 
-declare function getFrequencies(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getFrequencies(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Frequency[];
 
-declare function getLevels(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getLevels(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Level[];
 
-declare function getLocationGroups(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getLocationGroups(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): LocationGroup[];
 
-declare function getLocationGroupStops(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getLocationGroupStops(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): LocationGroupStop[];
 
-declare function getLocations(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getLocations(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Location[];
 
-declare function getNetworks(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getNetworks(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Network[];
 
-declare function getPathways(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getPathways(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Pathway[];
 
-declare function getRouteNetworks(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getRouteNetworks(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): RouteNetwork[];
 
-declare function getRoutes(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getRoutes(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Route[];
 
-declare function getShapes(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getShapes(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Shape[];
 declare function getShapesAsGeoJSON(query?: SqlWhere, options?: QueryOptions): FeatureCollection;
 
-declare function getStopAreas(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getStopAreas(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): StopArea[];
 
-declare function getStops(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getStops(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Stop[];
 declare function getStopsAsGeoJSON(query?: SqlWhere, options?: QueryOptions): FeatureCollection;
 
-declare function getStoptimes(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getStoptimes(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): StopTime[];
 
-declare function getTimeframes(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getTimeframes(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Timeframe[];
 
-declare function getTransfers(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getTransfers(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Transfer[];
 
-declare function getTranslations(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getTranslations(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Translation[];
 
-declare function getTrips(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;
+declare function getTrips(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): Trip[];
 
 declare function getCalendarAttributes(query?: SqlWhere, fields?: SqlSelect, orderBy?: SqlOrderBy, options?: QueryOptions): SqlResults;