gtfs-to-html 2.12.12 → 2.12.13

package/dist/index.d.ts

@@ -1,123 +1,127 @@
-import { ConfigAgency, Timetable, Route, Trip, Stop, TimetablePage } from 'gtfs';
-export { GtfsError, GtfsErrorCategory, GtfsErrorCode, GtfsWarning, GtfsWarningCode, ImportReport, formatGtfsError, isGtfsError, isGtfsValidationError } from 'gtfs';
+import { ConfigAgency, GtfsError, GtfsErrorCategory, GtfsErrorCode, GtfsWarning, GtfsWarningCode, ImportReport, Route, Stop, Timetable, TimetablePage, Trip, formatGtfsError, isGtfsError, isGtfsValidationError } from "gtfs";
 
+//#region src/types/config.d.ts
 interface Config {
-    agencies: ConfigAgency[];
-    assetPath?: string;
-    sqlitePath?: string;
-    allowEmptyTimetables?: boolean;
-    beautify?: boolean;
-    coordinatePrecision?: number;
-    dateFormat?: string;
-    daysShortStrings?: string[];
-    daysStrings?: string[];
-    defaultOrientation?: string;
-    effectiveDate?: string;
-    endDate?: string;
-    groupTimetablesIntoPages?: boolean;
-    interpolatedStopSymbol?: string;
-    interpolatedStopText?: string;
-    linkStopUrls?: boolean;
-    mapStyleUrl?: string;
-    menuType?: 'none' | 'simple' | 'jump' | 'radio';
-    noDropoffSymbol?: string;
-    noDropoffText?: string;
-    noHead?: boolean;
-    noPickupSymbol?: string;
-    noPickupText?: string;
-    noRegularServiceDaysText?: string;
-    noServiceSymbol?: string;
-    noServiceText?: string;
-    outputFormat?: 'html' | 'pdf' | 'csv';
-    overwriteExistingFiles?: boolean;
-    outputPath?: string;
-    requestDropoffSymbol?: string;
-    requestDropoffText?: string;
-    requestPickupSymbol?: string;
-    requestPickupText?: string;
-    serviceNotProvidedOnText?: string;
-    serviceProvidedOnText?: string;
-    showArrivalOnDifference?: number;
-    showCalendarExceptions?: boolean;
-    showDuplicateTrips?: boolean;
-    showMap?: boolean;
-    showOnlyTimepoint?: boolean;
-    showRouteTitle?: boolean;
-    showStopCity?: boolean;
-    showStopDescription?: boolean;
-    showStoptimesForRequestStops?: boolean;
-    skipImport?: boolean;
-    sortingAlgorithm?: string;
-    startDate?: string;
-    templatePath?: string;
-    timeFormat?: string;
-    useParentStation?: boolean;
-    verbose?: boolean;
-    zipOutput?: boolean;
-    logFunction?: (text: string) => void;
+  agencies: ConfigAgency[];
+  assetPath?: string;
+  sqlitePath?: string;
+  allowEmptyTimetables?: boolean;
+  beautify?: boolean;
+  coordinatePrecision?: number;
+  dateFormat?: string;
+  daysShortStrings?: string[];
+  daysStrings?: string[];
+  defaultOrientation?: string;
+  effectiveDate?: string;
+  endDate?: string;
+  groupTimetablesIntoPages?: boolean;
+  interpolatedStopSymbol?: string;
+  interpolatedStopText?: string;
+  linkStopUrls?: boolean;
+  mapStyleUrl?: string;
+  menuType?: 'none' | 'simple' | 'jump' | 'radio';
+  noDropoffSymbol?: string;
+  noDropoffText?: string;
+  noHead?: boolean;
+  noPickupSymbol?: string;
+  noPickupText?: string;
+  noRegularServiceDaysText?: string;
+  noServiceSymbol?: string;
+  noServiceText?: string;
+  outputFormat?: 'html' | 'pdf' | 'csv';
+  overwriteExistingFiles?: boolean;
+  outputPath?: string;
+  requestDropoffSymbol?: string;
+  requestDropoffText?: string;
+  requestPickupSymbol?: string;
+  requestPickupText?: string;
+  serviceNotProvidedOnText?: string;
+  serviceProvidedOnText?: string;
+  showArrivalOnDifference?: number;
+  showCalendarExceptions?: boolean;
+  showDuplicateTrips?: boolean;
+  showMap?: boolean;
+  showOnlyTimepoint?: boolean;
+  showRouteTitle?: boolean;
+  showStopCity?: boolean;
+  showStopDescription?: boolean;
+  showStoptimesForRequestStops?: boolean;
+  skipImport?: boolean;
+  sortingAlgorithm?: string;
+  startDate?: string;
+  templatePath?: string;
+  timeFormat?: string;
+  useParentStation?: boolean;
+  verbose?: boolean;
+  zipOutput?: boolean;
+  logFunction?: (text: string) => void;
 }
-
+//#endregion
+//#region src/types/timetable.d.ts
 interface FormattedTimetable extends Timetable {
-    route_ids: string[];
-    trip_ids: string[];
-    routes: Route[];
-    orderedTrips: Trip[];
-    stops: Stop[];
-    service_ids?: string[];
-    warnings?: string[];
-    has_continues_as_route?: boolean;
-    has_continues_from_route?: boolean;
+  route_ids: string[];
+  trip_ids: string[];
+  routes: Route[];
+  orderedTrips: Trip[];
+  stops: Stop[];
+  service_ids?: string[];
+  warnings?: string[];
+  has_continues_as_route?: boolean;
+  has_continues_from_route?: boolean;
 }
-
+//#endregion
+//#region src/types/timetable-page.d.ts
 interface FormattedTimetablePage extends TimetablePage {
-    timetables: FormattedTimetable[];
-    routes: Route[];
-    relativePath?: string;
+  timetables: FormattedTimetable[];
+  routes: Route[];
+  relativePath?: string;
 }
-
+//#endregion
+//#region src/lib/gtfs-to-html.d.ts
 declare const gtfsToHtml: (initialConfig: Config) => Promise<string>;
-
+//#endregion
+//#region src/lib/errors.d.ts
 declare enum GtfsToHtmlErrorCategory {
-    CONFIG = "config",
-    DATABASE = "database",
-    GTFS = "gtfs",
-    FILE_SYSTEM = "file_system",
-    TEMPLATE = "template",
-    QUERY = "query",
-    VALIDATION = "validation",
-    INTERNAL = "internal"
+  CONFIG = "config",
+  DATABASE = "database",
+  GTFS = "gtfs",
+  FILE_SYSTEM = "file_system",
+  TEMPLATE = "template",
+  QUERY = "query",
+  VALIDATION = "validation",
+  INTERNAL = "internal"
 }
 /**
  * Error codes are a public API contract and should remain stable.
  */
 declare enum GtfsToHtmlErrorCode {
-    CONFIG_INVALID = "GTFS_TO_HTML_CONFIG_INVALID",
-    CONFIG_FILE_NOT_FOUND = "GTFS_TO_HTML_CONFIG_FILE_NOT_FOUND",
-    CONFIG_PARSE_FAILED = "GTFS_TO_HTML_CONFIG_PARSE_FAILED",
-    CONFIG_DATE_INVALID = "GTFS_TO_HTML_CONFIG_DATE_INVALID",
-    CONFIG_MISSING_AGENCIES = "GTFS_TO_HTML_CONFIG_MISSING_AGENCIES",
-    DATABASE_OPEN_FAILED = "GTFS_TO_HTML_DATABASE_OPEN_FAILED",
-    GTFS_IMPORT_FAILED = "GTFS_TO_HTML_GTFS_IMPORT_FAILED",
-    FILE_SYSTEM_WRITE_FAILED = "GTFS_TO_HTML_FILE_SYSTEM_WRITE_FAILED",
-    OUTPUT_DIRECTORY_NOT_EMPTY = "GTFS_TO_HTML_OUTPUT_DIRECTORY_NOT_EMPTY",
-    QUERY_RESULT_NOT_FOUND = "GTFS_TO_HTML_QUERY_RESULT_NOT_FOUND",
-    QUERY_RESULT_AMBIGUOUS = "GTFS_TO_HTML_QUERY_RESULT_AMBIGUOUS",
-    QUERY_INVALID = "GTFS_TO_HTML_QUERY_INVALID",
-    TIMETABLE_GENERATION_FAILED = "GTFS_TO_HTML_TIMETABLE_GENERATION_FAILED"
+  CONFIG_INVALID = "GTFS_TO_HTML_CONFIG_INVALID",
+  CONFIG_FILE_NOT_FOUND = "GTFS_TO_HTML_CONFIG_FILE_NOT_FOUND",
+  CONFIG_PARSE_FAILED = "GTFS_TO_HTML_CONFIG_PARSE_FAILED",
+  CONFIG_DATE_INVALID = "GTFS_TO_HTML_CONFIG_DATE_INVALID",
+  CONFIG_MISSING_AGENCIES = "GTFS_TO_HTML_CONFIG_MISSING_AGENCIES",
+  DATABASE_OPEN_FAILED = "GTFS_TO_HTML_DATABASE_OPEN_FAILED",
+  GTFS_IMPORT_FAILED = "GTFS_TO_HTML_GTFS_IMPORT_FAILED",
+  FILE_SYSTEM_WRITE_FAILED = "GTFS_TO_HTML_FILE_SYSTEM_WRITE_FAILED",
+  OUTPUT_DIRECTORY_NOT_EMPTY = "GTFS_TO_HTML_OUTPUT_DIRECTORY_NOT_EMPTY",
+  QUERY_RESULT_NOT_FOUND = "GTFS_TO_HTML_QUERY_RESULT_NOT_FOUND",
+  QUERY_RESULT_AMBIGUOUS = "GTFS_TO_HTML_QUERY_RESULT_AMBIGUOUS",
+  QUERY_INVALID = "GTFS_TO_HTML_QUERY_INVALID",
+  TIMETABLE_GENERATION_FAILED = "GTFS_TO_HTML_TIMETABLE_GENERATION_FAILED"
 }
 interface GtfsToHtmlErrorOptions {
-    code: GtfsToHtmlErrorCode;
-    category: GtfsToHtmlErrorCategory;
-    isOperational?: boolean;
-    details?: Record<string, unknown>;
-    cause?: unknown;
+  code: GtfsToHtmlErrorCode;
+  category: GtfsToHtmlErrorCategory;
+  isOperational?: boolean;
+  details?: Record<string, unknown>;
+  cause?: unknown;
 }
 declare class GtfsToHtmlError extends Error {
-    code: GtfsToHtmlErrorCode;
-    category: GtfsToHtmlErrorCategory;
-    isOperational: boolean;
-    details?: Record<string, unknown>;
-    constructor(message: string, options: GtfsToHtmlErrorOptions);
+  code: GtfsToHtmlErrorCode;
+  category: GtfsToHtmlErrorCategory;
+  isOperational: boolean;
+  details?: Record<string, unknown>;
+  constructor(message: string, options: GtfsToHtmlErrorOptions);
 }
 declare function isGtfsToHtmlError(error: unknown): error is GtfsToHtmlError;
 /**
@@ -125,7 +129,8 @@ declare function isGtfsToHtmlError(error: unknown): error is GtfsToHtmlError;
  */
 declare function isGtfsParsingError(error: unknown): boolean;
 declare function formatGtfsToHtmlError(error: unknown, options?: {
-    verbosity: 'user' | 'developer';
+  verbosity: 'user' | 'developer';
 }): string;
-
-export { type Config, type FormattedTimetable, type FormattedTimetablePage, GtfsToHtmlError, GtfsToHtmlErrorCategory, GtfsToHtmlErrorCode, gtfsToHtml as default, formatGtfsToHtmlError, isGtfsParsingError, isGtfsToHtmlError };
+//#endregion
+export { type Config, type FormattedTimetable, type FormattedTimetablePage, GtfsError, GtfsErrorCategory, GtfsErrorCode, GtfsToHtmlError, GtfsToHtmlErrorCategory, GtfsToHtmlErrorCode, type GtfsWarning, GtfsWarningCode, type ImportReport, gtfsToHtml as default, formatGtfsError, formatGtfsToHtmlError, isGtfsError, isGtfsParsingError, isGtfsToHtmlError, isGtfsValidationError };
+//# sourceMappingURL=index.d.ts.map