@carrismetropolitana/api-types 1.0.0

package/src/api/metrics.ts

@@ -0,0 +1,18 @@
+interface ByHour {
+	hour: number
+	qty: number
+}
+
+interface ByDay {
+	by_hour: ByHour[]
+	day: string
+	qty: number
+}
+
+export interface DemandMetrics {
+	by_day: ByDay[]
+	end_date: string
+	item_id: string
+	start_date: string
+	total_qty: number
+};

package/src/api/network.ts

@@ -0,0 +1,173 @@
+/* * */
+
+import type { Feature, LineString } from 'geojson';
+
+/* * */
+
+export interface Line {
+	color: string
+	district_ids: string[]
+	facilities: string[]
+	id: string
+	locality_ids: string[]
+	long_name: string
+	municipality_ids: string[]
+	pattern_ids: string[]
+	region_ids: string[]
+	route_ids: string[]
+	short_name: string
+	stop_ids: string[]
+	text_color: string
+	tts_name: string
+}
+
+/* * */
+
+export interface Route {
+	color: string
+	district_ids: string[]
+	facilities: string[]
+	id: string
+	line_id: string
+	locality_ids: string[]
+	long_name: string
+	municipality_ids: string[]
+	pattern_ids: string[]
+	region_ids: string[]
+	short_name: string
+	stop_ids: string[]
+	text_color: string
+	tts_name: string
+}
+
+/* * */
+
+export interface Pattern {
+	color: string
+	district_ids: string[]
+	facilities: string[]
+	headsign: string
+	id: string
+	line_id: string
+	locality_ids: string[]
+	long_name: string
+	municipality_ids: string[]
+	path: Waypoint[]
+	region_ids: string[]
+	route_id: string[]
+	shape_id: string
+	short_name: string
+	text_color: string
+	trips: Trip[]
+	tts_headsign: string
+	valid_on: string[]
+	version_id: string
+}
+
+export interface Waypoint {
+	allow_drop_off: boolean
+	allow_pickup: boolean
+	distance: number
+	distance_delta: number
+	stop_id: string
+	stop_sequence: number
+}
+
+export interface Trip {
+	schedule: Arrival[]
+	service_ids: string[]
+	trip_group_id: string
+	trip_ids: string[]
+	valid_on: string[]
+	version_id: string
+}
+
+export interface Arrival {
+	arrival_time: string
+	arrival_time_24h: string
+	stop_id: string
+	stop_sequence: number
+}
+
+/* * */
+
+export interface Shape {
+	extension: number
+	geojson: Feature<LineString>
+	points: ShapePoint[]
+	shape_id: string
+}
+
+export interface ShapePoint {
+	shape_dist_traveled: number
+	shape_pt_lat: number
+	shape_pt_lon: number
+	shape_pt_sequence: number
+}
+
+/* * */
+
+export interface Stop {
+	district_id: string
+	facilities: string[]
+	id: string
+	lat: number
+	line_ids: string[]
+	locality_id: string
+	lon: number
+	long_name: string
+	municipality_id: string
+	operational_status: StopOperationalStatus
+	pattern_ids: string[]
+	region_id: string
+	route_ids: string[]
+	short_name: string
+	tts_name: string
+	wheelchair_boarding: boolean
+}
+
+export enum StopOperationalStatus {
+	active = 'active',
+	seasonal = 'seasonal',
+	voided = 'voided',
+}
+
+/* * */
+
+export interface Date {
+	day_type: DateDayType
+	description: string
+	holiday: boolean
+	id: string
+	period_id: string
+}
+
+export enum DateDayType {
+	saturday = 'saturday',
+	sundayHoliday = 'sunday_holiday',
+	weekday = 'weekday',
+}
+
+/* * */
+
+export interface Period {
+	dates: string[]
+	id: string
+	name: string
+	valid_on: string[]
+	valid_ranges: DateRange[]
+}
+
+/* * */
+
+export interface Archive {
+	agency_id: string
+	id: string
+	valid_range: DateRange
+}
+
+/* * */
+export interface DateRange {
+	end?: string
+	start: string
+}

package/src/api/vehicles.ts

@@ -0,0 +1,128 @@
+/* * */
+
+export interface Vehicle {
+	agency_id: string
+	bearing?: number
+	bikes_allowed: boolean
+	block_id?: string
+	capacity_seated?: number
+	capacity_standing?: number
+	capacity_total?: number
+	current_status?: VehicleCurrentStatus
+	direction_id?: number
+	emission_class?: VehicleEmissionClass
+	event_id?: string
+	id: string
+	lat?: number
+	license_plate?: string
+	line_id: string
+	lon?: number
+	make?: string
+	model?: string
+	occupancy_estimated?: number
+	occupancy_status?: VehicleOccupancyStatus
+	owner?: string
+	pattern_id: string
+	propulsion?: VehiclePropulsion
+	registration_date?: string
+	route_id?: string
+	schedule_relationship?: VehicleScheduleRelationship
+	shift_id?: string
+	speed?: number
+	stop_id?: string
+	timestamp?: number
+	trip_id?: string
+	wheelchair_accessible: boolean
+}
+
+/* * */
+
+export enum VehicleEmissionClass {
+	euro1 = 'euro_1',
+	euro2 = 'euro_2',
+	euro3 = 'euro_3',
+	euro4 = 'euro_4',
+	euro5 = 'euro_5',
+	euro6 = 'euro_6',
+};
+
+export function convertVehicleEmissionClassCode(emissionClassCode: string): undefined | VehicleEmissionClass {
+	switch (emissionClassCode) {
+		case '1':
+			return VehicleEmissionClass.euro1;
+		case '2':
+			return VehicleEmissionClass.euro2;
+		case '3':
+			return VehicleEmissionClass.euro3;
+		case '4':
+			return VehicleEmissionClass.euro4;
+		case '5':
+			return VehicleEmissionClass.euro5;
+		case '6':
+			return VehicleEmissionClass.euro6;
+		default:
+			return undefined;
+	}
+}
+
+/* * */
+
+export enum VehiclePropulsion {
+	biodiesel = 'biodiesel',
+	diesel = 'diesel',
+	electricity = 'electricity',
+	gasoline = 'gasoline',
+	hybrid = 'hybrid',
+	lpgAuto = 'lpg_auto',
+	mixture = 'mixture',
+	natural_gas = 'natural_gas',
+}
+
+export function convertVehiclePropulsionCode(propulsionCode: string): undefined | VehiclePropulsion {
+	switch (propulsionCode) {
+		case '1':
+			return VehiclePropulsion.gasoline;
+		case '2':
+			return VehiclePropulsion.diesel;
+		case '3':
+			return VehiclePropulsion.lpgAuto;
+		case '4':
+			return VehiclePropulsion.mixture;
+		case '5':
+			return VehiclePropulsion.biodiesel;
+		case '6':
+			return VehiclePropulsion.electricity;
+		case '7':
+			return VehiclePropulsion.hybrid;
+		case '8':
+			return VehiclePropulsion.natural_gas;
+		default:
+			return undefined;
+	}
+}
+
+/* * */
+
+export enum VehicleCurrentStatus {
+	in_transit_to = 'in_transit_to',
+	incoming_at = 'incoming_at',
+	stopped_at = 'stopped_at',
+}
+
+/* * */
+
+export enum VehicleScheduleRelationship {
+	added = 'added',
+	canceled = 'canceled',
+	scheduled = 'scheduled',
+	unscheduled = 'unscheduled',
+}
+
+/* * */
+
+export enum VehicleOccupancyStatus {
+	empty = 'empty',
+	full = 'full',
+	seats_available = 'seats_available',
+	standing_only = 'standing_only',
+}

package/src/gtfs/core.ts

@@ -0,0 +1 @@
+export * from 'gtfs-types';

package/src/gtfs/extended.ts

@@ -0,0 +1,284 @@
+/* * */
+
+import { GTFSBool } from 'gtfs-types';
+import * as GtfsCore from 'gtfs-types';
+
+/* * */
+
+/**
+ * Type for GTFS routes.txt file.
+ */
+export interface Route extends GtfsCore.Route {
+	line_id: string
+	line_long_name: string
+	line_short_name: string
+}
+
+/**
+ * Type for GTFS calendar_dates.txt file.
+ */
+export interface CalendarDate extends GtfsCore.CalendarDates {
+	day_type: string
+	holiday: string
+	period: string
+}
+
+/**
+ * Type for GTFS dates.txt file.
+ */
+export interface Date {
+	date: string
+	day_type: string
+	description: string
+	holiday: string
+	period: string
+}
+
+/**
+ * Type for GTFS periods.txt file.
+ */
+export interface Period {
+	period_id: string
+	period_name: string
+}
+
+/**
+ * Type for GTFS trips.txt file.
+ */
+export interface Trip extends GtfsCore.Trip {
+	calendar_desc: string
+	pattern_id: string
+}
+
+/**
+ * Type for GTFS stop_times.txt file.
+ */
+export type StopTime = GtfsCore.StopTime;
+
+/**
+ * Type for GTFS shapes.txt file.
+ */
+export type Shape = GtfsCore.Shapes;
+
+/**
+ * Type for GTFS stops.txt file.
+ */
+export interface Stop extends GtfsCore.Stop {
+	airport: boolean
+	bike_parking: boolean
+	bike_sharing: boolean
+	boat: boolean
+	car_parking: boolean
+	district_id: string
+	district_name: string
+	light_rail: boolean
+	locality: string
+	municipality_id: string
+	municipality_name: string
+	near_fire_station: boolean
+	near_health_clinic: boolean
+	near_historic_building: boolean
+	near_hospital: boolean
+	near_police_station: boolean
+	near_school: boolean
+	near_shopping: boolean
+	near_transit_office: boolean
+	near_university: boolean
+	operational_status: string
+	parish_id: null
+	parish_name: null
+	region_id: string
+	region_name: string
+	stop_id: string
+	stop_lat: number
+	stop_lon: number
+	stop_name: string
+	stop_short_name: string
+	subway: boolean
+	train: boolean
+	tts_stop_name: string
+	wheelchair_boarding: GtfsCore.WheelchairBoardingType
+}
+
+/**
+ * Type for GTFS vehicles.txt file.
+ */
+export interface Vehicle {
+	agency_id: string
+	bikes_allowed: GTFSBool
+	capacity_seated: number
+	capacity_standing: number
+	emission_class: string
+	license_plate: string
+	make: string
+	model: string
+	owner: string
+	passenger_counting: GTFSBool
+	propulsion: string
+	registration_date: string
+	vehicle_id: string
+	wheelchair_accessible: GTFSBool
+}
+
+/* * */
+
+export interface VehicleEvent {
+	content: VehicleEventContent
+	millis: number
+}
+
+export interface VehicleEventContent {
+	entity: VehicleEventEntity[]
+	header: GtfsCore.FeedHeader
+}
+
+export interface VehicleEventEntity {
+	_id: string
+	vehicle: VehiclePosition
+}
+
+export interface VehiclePosition {
+	agencyId: string
+	currentStatus: GtfsCore.VehicleStopStatus
+	operationPlanId: string
+	passengerCounting: VehiclePositionPassengerCounting
+	position: GtfsCore.Position
+	stopId: string
+	timestamp: number
+	trigger: VehiclePositionTrigger
+	trip: VehiclePositionTrip
+	vehicle: VehiclePositionVehicle
+}
+
+export interface VehiclePositionTrigger {
+	activity: string
+	door: string
+}
+
+export interface VehiclePositionTrip {
+	lineId: string
+	patternId: string
+	routeId: string
+	scheduleRelationship: GtfsCore.TripScheduleRelationship
+	tripId: string
+}
+
+export interface VehiclePositionVehicle {
+	_id: string
+	blockId: string
+	driverId: string
+	shiftId: string
+}
+
+export interface VehiclePositionPassengerCounting {
+	counting: VehiclePositionPassengerCountingCount[]
+}
+
+export interface VehiclePositionPassengerCountingCount {
+	classId: 'adult' | 'children'
+	incoming: number
+	outgoing: number
+}
+
+/* * */
+
+/**
+ * GTFS Realtime Feed Message Types
+ */
+export interface FeedHeader {
+	gtfsRealtimeVersion: '2.0'
+	incrementality: 'FULL_DATASET'
+	timestamp: number
+}
+
+export interface TranslatedString {
+	translation: Translation[]
+}
+
+/**
+ * A translation of a string. Exactly one of text or file must be present.
+ * The language field must be a valid BCP 47 language tag.
+ *
+ * More info: https://gtfs.org/realtime/reference/#message-translation
+ *
+ * @param language - The language of the text. Must be a valid BCP 47 language tag.
+ * @param text - The translated text.
+ *
+ */
+interface Translation {
+	language: string
+	text: string
+}
+
+export interface TranslatedImage {
+	localizedImage: LocalizedImage[]
+}
+
+/**
+ * A localized image. At least one translation must be provided.
+ * The image type must be a valid MIME type. The URL must be a valid URL.
+ * The language field must be a valid BCP 47 language tag.
+ *
+ * More info: https://gtfs.org/realtime/reference/#message-localizedimage
+ *
+ * @param language - The language of the image. Must be a valid BCP 47 language tag.
+ * @param mediaType - The MIME type of the image.
+ * @param url - The URL of the image.
+ *
+ */
+interface LocalizedImage {
+	language: string
+	mediaType: string
+	url: string
+}
+
+/**
+ * POSIX time (i.e., number of seconds since January 1st 1970 00:00:00 UTC). If start or end is missing,
+ * the interval starts at minus or plus infinity. If a TimeRange is provided, either start or end must
+ * be provided - both fields cannot be empty.
+ *
+ * Here, it is expected that a TimeRange object will always be provided with a start value.
+ *
+ * More info: https://gtfs.org/realtime/reference/#message-timerange
+ *
+ * @param start - Start time in POSIX time.
+ * @param end - End time in POSIX time. If not provided, the interval ends at plus infinity.
+ *
+ */
+export interface TimeRange {
+	end?: number
+	start: number
+}
+
+/**
+ * A selector for an entity in a GTFS feed. The values of the fields should correspond to the appropriate fields in the GTFS feed.
+ * At least one specifier must be given. If several are given, they should be interpreted as being joined by the logical AND operator.
+ * Additionally, the combination of specifiers must match the corresponding information in the GTFS feed.
+ * In other words, in order for an alert to apply to an entity in GTFS it must match all of the provided EntitySelector fields.
+ * For example, an EntitySelector that includes the fields route_id: "5" and route_type: "3" applies only
+ * to the route_id: "5" bus - it does not apply to any other routes of route_type: "3". If a producer wants an alert
+ * to apply to route_id: "5" as well as route_type: "3", it should provide two separate EntitySelectors,
+ * one referencing route_id: "5" and another referencing route_type: "3".
+ *
+ * More info: https://gtfs.org/realtime/reference/#message-entityselector
+ *
+ * @param agencyId - The agency_id of the agency that operates the entity. Required if the entity is not identified by a specific route_id.
+ * @param lineId - The line_id of the line that the entity belongs to. Non-standard.
+ * @param routeId - The route_id of the route that the entity belongs to.
+ * @param stopId - The stop_id of the stop that the entity is associated with. Optional.
+ * @param tripId - The trip_id of the trip that the entity belongs to. Required if the entity is not identified by route_id.
+ *
+ */
+export interface EntitySelector {
+	agencyId?: string
+	lineId?: string // Non-standard
+	routeId?: string
+	stopId?: string
+	tripId?: string
+}
+
+/* * */
+
+export function convertGTFSBoolToBoolean(value: GTFSBool): boolean {
+	return Number(value) === GTFSBool.YES ? true : false;
+}

package/src/trino/index.ts

@@ -0,0 +1,101 @@
+export interface TrinoValidations {
+    id: string;
+    createdat?: string;
+    rawloaddate?: string;
+    rawloaddateiso?: string;
+    issignaturecorrect?: boolean;
+    isfraud?: boolean;
+    batchid?: string;
+    operator?: string;
+    csvtransaction?: string;
+    apextransactiontype?: number;
+    apextransactionversion?: string;
+    transactionid?: string;
+    transactiongroupid?: string;
+    transactiondate?: string;
+    apexversion?: string;
+    vivaversion?: string;
+    technicalparametersversion?: string;
+    commercialofferversion?: string;
+    networkversion?: string;
+    actionlistsversion?: string;
+    operatorlongid?: string;
+    networkid?: string;
+    channelid?: string;
+    deviceid?: string;
+    cardtypeid?: string;
+    cardphysicaltype?: number;
+    cardnetworkid?: string;
+    cardissuer?: number;
+    cardnumber?: bigint;
+    cardserialnumber?: string;
+    operationplanid?: string;
+    vehicleplanid?: string;
+    vehicleid?: number;
+    driverplanid?: string;
+    timetableid?: string;
+    unfoldingid?: string;
+    validatorid?: number;
+    zonelongid?: string;
+    routelongid?: string;
+    runlongid?: string;
+    stoplongid?: string;
+    validationtype?: number;
+    productlongid?: string;
+    tickloaddate?: string;
+    tickloadmachcode?: number;
+    tickloadnumbdaily?: number;
+    unitsquantity?: number;
+    unitsremaining?: number;
+    contractnumber?: number;
+    eventtype?: number;
+    validationstatus?: number;
+    whitelistitemid?: string;
+    calendarid?: string;
+    validityperiodid?: string;
+    spatialvaliditylongid?: string;
+    productmatrixelementid?: string;
+    validationdatalongid?: string;
+    profilesusedcount?: number;
+    profilelongid?: string;
+    amounttodebit?: number;
+    greylistitemscount?: number;
+    greylistitemid?: string;
+    signeddata?: string;
+    mac?: string;
+    blockid?: string;
+    dutyid?: string;
+    journeyid?: string;
+    extrajourneyid?: string;
+    linelongid?: string;
+    patternlongid?: string;
+    isok?: boolean;
+    isunique?: boolean;
+    errorlist?: string;
+    signeddatafields_raw?: string;
+    signeddatafields_eventbinaryread?: string;
+    signeddatafields_eventbinarywritten?: string;
+    signeddatafields_contractbinaryread?: string;
+    signeddatafields_contractbinarywritten?: string;
+    signeddatafields_environmentbinaryread?: string;
+    signeddatafields_environmentbinarywritten?: string;
+    macdatafields_raw?: string;
+    macdatafields_interruptedstatus?: number;
+    macdatafields_macversion?: number;
+    macdatafields_binarydatamask?: number;
+    macdatafields_sammodel?: number;
+    macdatafields_samworkingmode?: number;
+    macdatafields_samtypeversion?: number;
+    macdatafields_fullmacflag?: number;
+    macdatafields_samserialnumber?: bigint;
+    macdatafields_bruteforcecounter?: string;
+    macdatafields_asecountervalue?: number;
+    macdatafields_ticcountervalue?: number;
+    macdatafields_ticcounterceiling?: number;
+    macdatafields_rldupdcountervalue?: number;
+    macdatafields_rldupdcounterceiling?: number;
+    macdatafields_transactioncounter?: number;
+    outofboundstype?: number;
+    outofboundsstoplongid?: string;
+    isreprocessed?: boolean;
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+	"extends": "@carrismetropolitana/api-tsconfig/base.json",
+	"compilerOptions": {
+		"baseUrl": ".",
+		"outDir": "dist",
+		"paths": {
+			"@/*": ["./src/*"]
+		},
+		"rootDir": "src"
+	},
+	"include": ["src"],
+	"exclude": ["node_modules", "dist"]
+}