gtfs 4.18.3 → 4.18.4

package/dist/index.d.ts

@@ -2,6 +2,70 @@ import { Options } from 'csv-parse';
 import Database$1, { Database } from 'better-sqlite3';
 import { FeatureCollection } from 'geojson';
 
+declare enum GtfsErrorCategory {
+    CONFIG = "config",
+    DOWNLOAD = "download",
+    ZIP = "zip",
+    VALIDATION = "validation",
+    DATABASE = "database",
+    PARSE = "parse",
+    QUERY = "query",
+    INTERNAL = "internal"
+}
+/**
+ * Error codes are a public API contract and must remain stable across
+ * minor/patch releases.
+ */
+declare enum GtfsErrorCode {
+    GTFS_DOWNLOAD_HTTP = "GTFS_DOWNLOAD_HTTP",
+    GTFS_DOWNLOAD_FAILED = "GTFS_DOWNLOAD_FAILED",
+    GTFS_ZIP_INVALID = "GTFS_ZIP_INVALID",
+    GTFS_REQUIRED_FIELD_MISSING = "GTFS_REQUIRED_FIELD_MISSING",
+    GTFS_INVALID_DATE = "GTFS_INVALID_DATE",
+    GTFS_CONFIG_INVALID = "GTFS_CONFIG_INVALID",
+    DB_OPEN_FAILED = "DB_OPEN_FAILED",
+    GTFS_DB_OPERATION_FAILED = "GTFS_DB_OPERATION_FAILED",
+    GTFS_JSON_INVALID = "GTFS_JSON_INVALID",
+    GTFS_UNSUPPORTED_FILE_TYPE = "GTFS_UNSUPPORTED_FILE_TYPE",
+    GTFS_CSV_PARSE_FAILED = "GTFS_CSV_PARSE_FAILED",
+    GTFS_QUERY_INVALID = "GTFS_QUERY_INVALID"
+}
+declare enum GtfsWarningCode {
+    GTFS_DUPLICATE_PRIMARY_KEY = "GTFS_DUPLICATE_PRIMARY_KEY"
+}
+interface GtfsWarning {
+    code: GtfsWarningCode;
+    message: string;
+    details?: Record<string, unknown>;
+}
+interface ImportReport {
+    errors: GtfsError[];
+    warnings: GtfsWarning[];
+    errorCountsByCode: Partial<Record<GtfsErrorCode, number>>;
+    warningCountsByCode: Partial<Record<GtfsWarningCode, number>>;
+}
+interface GtfsErrorOptions {
+    code: GtfsErrorCode;
+    category: GtfsErrorCategory;
+    isOperational?: boolean;
+    statusCode?: number;
+    details?: Record<string, unknown>;
+    cause?: unknown;
+}
+declare class GtfsError extends Error {
+    code: GtfsErrorCode;
+    category: GtfsErrorCategory;
+    isOperational: boolean;
+    statusCode?: number;
+    details?: Record<string, unknown>;
+    constructor(message: string, options: GtfsErrorOptions);
+}
+declare function isGtfsError(error: unknown): error is GtfsError;
+declare function isGtfsValidationError(error: unknown): error is GtfsError;
+declare function formatGtfsError(error: unknown, options?: {
+    verbosity: 'user' | 'developer';
+}): string;
+
 type UnixTimestamp = number;
 type TableNames = 'agency' | 'stops' | 'routes' | 'trips' | 'stop_times' | 'calendar' | 'calendar_dates' | 'fare_attributes' | 'fare_rules' | 'timeframes' | 'rider_categories' | 'fare_media' | 'fare_products' | 'fare_leg_rules' | 'fare_leg_join_rules' | 'fare_transfer_rules' | 'areas' | 'stop_areas' | 'networks' | 'route_networks' | 'shapes' | 'frequencies' | 'transfers' | 'pathways' | 'levels' | 'location_groups' | 'location_group_stops' | 'locations' | 'booking_rules' | 'translations' | 'feed_info' | 'attributions';
 interface BaseConfigAgency {
@@ -113,6 +177,13 @@ interface Config {
      * @defaultValue false
      */
     ignoreErrors?: boolean;
+    /**
+     * Whether or not to return a structured import report from `importGtfs`.
+     * Useful when `ignoreErrors` is enabled and you want to inspect collected errors/warnings.
+     *
+     * @defaultValue false
+     */
+    includeImportReport?: boolean;
     /**
      * An array of GTFS files to be imported, and which files to exclude.
      */
@@ -733,6 +804,7 @@ interface StopAttribute {
  *
  * @param initialConfig
  */
+declare function importGtfs(initialConfig: Config): Promise<ImportReport>;
 declare function importGtfs(initialConfig: Config): Promise<void>;
 
 /**
@@ -905,4 +977,4 @@ declare function getRunEvents<Fields extends keyof RunEvent>(query?: SqlWhere, f
 
 declare function getRunsPieces<Fields extends keyof RunPiece>(query?: SqlWhere, fields?: Fields[], orderBy?: SqlOrderBy, options?: QueryOptions): QueryResult<RunPiece, Fields>[];
 
-export { type Agency, type Area, type Attribution, type BoardAlight, type BookingRule, type Calendar, type CalendarAttribute, type CalendarDate, type Config, type ConfigAgency, type Deadhead, type DeadheadTime, type Direction, type FareAttribute, type FareLegRule, type FareMedia, type FareProduct, type FareRule, type FareTransferRule, type FeedInfo, type Frequency, type JoinOptions, type Level, type Location, type LocationGroup, type LocationGroupStop, type Model, type ModelColumn, type Network, type OpsLocation, type Pathway, type QueryOptions, type QueryResult, type RideFeedInfo, type RiderCategory, type RiderTrip, type Ridership, type Route, type RouteAttribute, type RouteNetwork, type RunEvent, type RunPiece, type ServiceAlert, type Shape, type SqlOrderBy, type SqlValue, type SqlWhere, type Stop, type StopArea, type StopAttribute, type StopTime, type StopTimeUpdate, type TableNames, type Timeframe, type Timetable, type TimetableNote, type TimetableNotesReference, type TimetablePage, type TimetableStopOrder, type Transfer, type Translation, type Trip, type TripCapacity, type TripUpdate, type TripsDatedVehicleJourney, type UnixTimestamp, type VehiclePosition, advancedQuery, closeDb, deleteDb, exportGtfs, generateFolderName, getAgencies, getAreas, getAttributions, getBoardAlights, getBookingRules, getCalendarAttributes, getCalendarDates, getCalendars, getDeadheadTimes, getDeadheads, getDirections, getFareAttributes, getFareLegRules, getFareMedia, getFareProducts, getFareRules, getFareTransferRules, getFeedInfo, getFrequencies, getLevels, getLocationGroupStops, getLocationGroups, getLocations, getNetworks, getOpsLocations, getPathways, getRideFeedInfo, getRiderCategories, getRiderTrips, getRidership, getRouteAttributes, getRouteNetworks, getRoutes, getRunEvents, getRunsPieces, getServiceAlerts, getServiceIdsByDate, getShapes, getShapesAsGeoJSON, getStopAreas, getStopAttributes, getStopTimeUpdates, getStops, getStopsAsGeoJSON, getStoptimes, getTimeframes, getTimetableNotes, getTimetableNotesReferences, getTimetablePages, getTimetableStopOrders, getTimetables, getTransfers, getTranslations, getTripCapacities, getTripUpdates, getTrips, getTripsDatedVehicleJourneys, getVehiclePositions, importGtfs, openDb, prepDirectory, untildify, unzip, updateGtfsRealtime };
+export { type Agency, type Area, type Attribution, type BoardAlight, type BookingRule, type Calendar, type CalendarAttribute, type CalendarDate, type Config, type ConfigAgency, type Deadhead, type DeadheadTime, type Direction, type FareAttribute, type FareLegRule, type FareMedia, type FareProduct, type FareRule, type FareTransferRule, type FeedInfo, type Frequency, GtfsError, GtfsErrorCategory, GtfsErrorCode, type GtfsWarning, GtfsWarningCode, type ImportReport, type JoinOptions, type Level, type Location, type LocationGroup, type LocationGroupStop, type Model, type ModelColumn, type Network, type OpsLocation, type Pathway, type QueryOptions, type QueryResult, type RideFeedInfo, type RiderCategory, type RiderTrip, type Ridership, type Route, type RouteAttribute, type RouteNetwork, type RunEvent, type RunPiece, type ServiceAlert, type Shape, type SqlOrderBy, type SqlValue, type SqlWhere, type Stop, type StopArea, type StopAttribute, type StopTime, type StopTimeUpdate, type TableNames, type Timeframe, type Timetable, type TimetableNote, type TimetableNotesReference, type TimetablePage, type TimetableStopOrder, type Transfer, type Translation, type Trip, type TripCapacity, type TripUpdate, type TripsDatedVehicleJourney, type UnixTimestamp, type VehiclePosition, advancedQuery, closeDb, deleteDb, exportGtfs, formatGtfsError, generateFolderName, getAgencies, getAreas, getAttributions, getBoardAlights, getBookingRules, getCalendarAttributes, getCalendarDates, getCalendars, getDeadheadTimes, getDeadheads, getDirections, getFareAttributes, getFareLegRules, getFareMedia, getFareProducts, getFareRules, getFareTransferRules, getFeedInfo, getFrequencies, getLevels, getLocationGroupStops, getLocationGroups, getLocations, getNetworks, getOpsLocations, getPathways, getRideFeedInfo, getRiderCategories, getRiderTrips, getRidership, getRouteAttributes, getRouteNetworks, getRoutes, getRunEvents, getRunsPieces, getServiceAlerts, getServiceIdsByDate, getShapes, getShapesAsGeoJSON, getStopAreas, getStopAttributes, getStopTimeUpdates, getStops, getStopsAsGeoJSON, getStoptimes, getTimeframes, getTimetableNotes, getTimetableNotesReferences, getTimetablePages, getTimetableStopOrders, getTimetables, getTransfers, getTranslations, getTripCapacities, getTripUpdates, getTrips, getTripsDatedVehicleJourneys, getVehiclePositions, importGtfs, isGtfsError, isGtfsValidationError, openDb, prepDirectory, untildify, unzip, updateGtfsRealtime };