@tmlmobilidade/types 20260320.1741.37 → 20260320.2238.33

package/dist/pcgi/index.d.ts

@@ -3,3 +3,4 @@ export * from './pcgi-apex-refund.js';
 export * from './pcgi-apex-sale.js';
 export * from './pcgi-apex-validation.js';
 export * from './pcgi-transaction-entity.js';
+export * from './pcgi-vehicle-event.js';

package/dist/pcgi/index.js

@@ -3,3 +3,4 @@ export * from './pcgi-apex-refund.js';
 export * from './pcgi-apex-sale.js';
 export * from './pcgi-apex-validation.js';
 export * from './pcgi-transaction-entity.js';
+export * from './pcgi-vehicle-event.js';

package/dist/pcgi/pcgi-vehicle-event.d.ts

@@ -0,0 +1,49 @@
+/**
+ * PCGI Vehicle Event
+ */
+export interface PcgiVehicleEvent {
+    _id: string;
+    content: {
+        entity: {
+            _id: string;
+            vehicle: {
+                agencyId: string;
+                currentStatus: string;
+                occupancyStatus: string;
+                operationPlanId: string;
+                position: {
+                    bearing: number;
+                    latitude: number;
+                    longitude: number;
+                    odometer: number;
+                    speed: number;
+                };
+                stopId: string;
+                timestamp: number;
+                trigger: {
+                    activity: string;
+                    door: string;
+                };
+                trip: {
+                    lineId: string;
+                    patternId: string;
+                    routeId: string;
+                    scheduleRelationship: string;
+                    tripId: string;
+                };
+                vehicle: {
+                    _id: string;
+                    blockId: string;
+                    driverId: string;
+                    shiftId: string;
+                };
+            };
+        }[];
+        header: {
+            gtfsRealtimeVersion: string;
+            incrementality: string;
+            timestamp: number;
+        };
+    };
+    millis: number;
+}

package/dist/pcgi/pcgi-vehicle-event.js

@@ -0,0 +1,2 @@
+/* * */
+export {};

package/dist/vehicle-events/clickhouse-vehicle-event.d.ts

@@ -1,44 +1,23 @@
 import { z } from 'zod';
-export declare const ClickHouseVehicleEventSchema: z.ZodObject<Omit<Omit<{
+export declare const ClickHouseVehicleEventSchema: z.ZodObject<{
     _id: z.ZodString;
-    created_at: z.ZodEffects<z.ZodNumber, import("../_common/index.js").UnixTimestamp, number>;
-    created_by: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    is_locked: z.ZodDefault<z.ZodBoolean>;
-    updated_at: z.ZodEffects<z.ZodNumber, import("../_common/index.js").UnixTimestamp, number>;
-    updated_by: z.ZodOptional<z.ZodString>;
-}, "created_by" | "is_locked" | "updated_by"> & {
     agency_id: z.ZodString;
-    current_status: z.ZodEnum<["INCOMING_AT", "STOPPED_AT", "IN_TRANSIT_TO"]>;
-    driver_id: z.ZodString;
-    event_id: z.ZodString;
-    extra_trip_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    created_at: z.ZodEffects<z.ZodNumber, import("../_common/index.js").UnixTimestamp, number>;
     latitude: z.ZodNumber;
     longitude: z.ZodNumber;
-    odometer: z.ZodNumber;
-    pattern_id: z.ZodString;
-    position: z.ZodObject<{
-        geohash: z.ZodString;
-        h3: z.ZodString;
-        latitude: z.ZodNumber;
-        longitude: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        geohash: string;
-        h3: string;
-        latitude: number;
-        longitude: number;
-    }, {
-        geohash: string;
-        h3: string;
-        latitude: number;
-        longitude: number;
-    }>;
     received_at: z.ZodEffects<z.ZodNumber, import("../_common/index.js").UnixTimestamp, number>;
-    stop_id: z.ZodString;
-    trigger_activity: z.ZodString;
-    trigger_door: z.ZodString;
     trip_id: z.ZodString;
     vehicle_id: z.ZodString;
-}, "position"> & {
+    bearing: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    current_status: z.ZodDefault<z.ZodNullable<z.ZodEnum<["INCOMING_AT", "STOPPED_AT", "IN_TRANSIT_TO"]>>>;
+    door: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    driver_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    extra_trip_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    odometer: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    pattern_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    speed: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    stop_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+} & {
     h3_1: z.ZodString;
     h3_2: z.ZodString;
     h3_3: z.ZodString;
@@ -71,9 +50,6 @@ export declare const ClickHouseVehicleEventSchema: z.ZodObject<Omit<Omit<{
     created_at: number & {
         __brand: "UnixTimestamp";
     };
-    updated_at: number & {
-        __brand: "UnixTimestamp";
-    };
     latitude: number;
     longitude: number;
     geohash_2: string;
@@ -100,30 +76,29 @@ export declare const ClickHouseVehicleEventSchema: z.ZodObject<Omit<Omit<{
     h3_11: string;
     h3_12: string;
     agency_id: string;
-    pattern_id: string;
+    pattern_id: string | null;
     received_at: number & {
         __brand: "UnixTimestamp";
     };
-    stop_id: string;
+    stop_id: string | null;
     trip_id: string;
     vehicle_id: string;
-    event_id: string;
     plan_id: string;
     route_id: string;
     operational_date: string & {
         __brand: "OperationalDate";
     };
-    odometer: number;
-    current_status: "INCOMING_AT" | "STOPPED_AT" | "IN_TRANSIT_TO";
+    bearing: number | null;
+    odometer: number | null;
+    speed: number | null;
+    current_status: "INCOMING_AT" | "STOPPED_AT" | "IN_TRANSIT_TO" | null;
     hour: number;
-    driver_id: string;
-    trigger_activity: string;
-    trigger_door: string;
-    extra_trip_id?: string | null | undefined;
+    door: string | null;
+    driver_id: string | null;
+    extra_trip_id: string | null;
 }, {
     _id: string;
     created_at: number;
-    updated_at: number;
     latitude: number;
     longitude: number;
     geohash_2: string;
@@ -150,21 +125,21 @@ export declare const ClickHouseVehicleEventSchema: z.ZodObject<Omit<Omit<{
     h3_11: string;
     h3_12: string;
     agency_id: string;
-    pattern_id: string;
     received_at: number;
-    stop_id: string;
     trip_id: string;
     vehicle_id: string;
-    event_id: string;
     plan_id: string;
     route_id: string;
     operational_date: string;
-    odometer: number;
-    current_status: "INCOMING_AT" | "STOPPED_AT" | "IN_TRANSIT_TO";
     hour: number;
-    driver_id: string;
-    trigger_activity: string;
-    trigger_door: string;
+    pattern_id?: string | null | undefined;
+    stop_id?: string | null | undefined;
+    bearing?: number | null | undefined;
+    odometer?: number | null | undefined;
+    speed?: number | null | undefined;
+    current_status?: "INCOMING_AT" | "STOPPED_AT" | "IN_TRANSIT_TO" | null | undefined;
+    door?: string | null | undefined;
+    driver_id?: string | null | undefined;
     extra_trip_id?: string | null | undefined;
 }>;
 /**

package/dist/vehicle-events/clickhouse-vehicle-event.js

@@ -1,9 +1,9 @@
 /* * */
 import { ExtendedPositionSchema, OperationalDateSchema } from '../_common/index.js';
-import { z } from 'zod';
 import { SimplifiedVehicleEventSchema } from './simplified-vehicle-event.js';
+import { z } from 'zod';
 /* * */
-export const ClickHouseVehicleEventSchema = SimplifiedVehicleEventSchema.omit({ position: true }).extend({
+export const ClickHouseVehicleEventSchema = SimplifiedVehicleEventSchema.extend({
     hour: z.number().min(0).max(23),
     operational_date: OperationalDateSchema,
     plan_id: z.string(),

package/dist/vehicle-events/index.d.ts

@@ -1,3 +1,4 @@
 export * from './clickhouse-vehicle-event.js';
 export * from './gtfs-rt-vehicle-event-extended.js';
+export * from './raw-vehicle-event.js';
 export * from './simplified-vehicle-event.js';

package/dist/vehicle-events/index.js

@@ -1,3 +1,4 @@
 export * from './clickhouse-vehicle-event.js';
 export * from './gtfs-rt-vehicle-event-extended.js';
+export * from './raw-vehicle-event.js';
 export * from './simplified-vehicle-event.js';

package/dist/vehicle-events/raw-vehicle-event.d.ts

@@ -0,0 +1,68 @@
+import { z } from 'zod';
+export declare const RawVehicleEventSchema: z.ZodObject<{
+    _id: z.ZodString;
+    agency_id: z.ZodString;
+    created_at: z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>;
+    entity_id: z.ZodString;
+    raw: z.ZodAny;
+    received_at: z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>;
+    version: z.ZodEnum<["default"]>;
+}, "strip", z.ZodTypeAny, {
+    _id: string;
+    created_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    agency_id: string;
+    received_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    entity_id: string;
+    version: "default";
+    raw?: any;
+}, {
+    _id: string;
+    created_at: number;
+    agency_id: string;
+    received_at: number;
+    entity_id: string;
+    version: "default";
+    raw?: any;
+}>;
+/**
+ * Vehicle Events are produced by the vehicle's on-board computer on a regular schedule
+ * or whenever a significant event occurs. These events are used to track the vehicle's
+ * location, speed, and status, as well as the current service being provided by the vehicle.
+ * These events are based on the GTFS-RT specification but extended with additional fields
+ * specific to TML's needs.
+ */
+export type RawVehicleEvent = z.infer<typeof RawVehicleEventSchema>;
+export declare const HashableRawVehicleEventSchema: z.ZodObject<Omit<{
+    _id: z.ZodString;
+    agency_id: z.ZodString;
+    created_at: z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>;
+    entity_id: z.ZodString;
+    raw: z.ZodAny;
+    received_at: z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>;
+    version: z.ZodEnum<["default"]>;
+}, "_id" | "received_at">, "strip", z.ZodTypeAny, {
+    created_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    agency_id: string;
+    entity_id: string;
+    version: "default";
+    raw?: any;
+}, {
+    created_at: number;
+    agency_id: string;
+    entity_id: string;
+    version: "default";
+    raw?: any;
+}>;
+/**
+ * A HashableRawVehicleEvent is a RawVehicleEvent without the _id and received_at fields,
+ * which are not relevant for hashing purposes. This type is used to create a unique hash
+ * for each vehicle event based on its content, allowing us to identify duplicate events
+ * and avoid storing them multiple times in the database.
+ */
+export type HashableRawVehicleEvent = z.infer<typeof HashableRawVehicleEventSchema>;

package/dist/vehicle-events/raw-vehicle-event.js

@@ -0,0 +1,18 @@
+/* * */
+import { UnixTimeStampSchema } from '../_common/unix-timestamp.js';
+import { z } from 'zod';
+/* * */
+export const RawVehicleEventSchema = z.object({
+    _id: z.string(),
+    agency_id: z.string(),
+    created_at: UnixTimeStampSchema,
+    entity_id: z.string(),
+    raw: z.any(),
+    received_at: UnixTimeStampSchema,
+    version: z.enum(['default']),
+});
+/* * */
+export const HashableRawVehicleEventSchema = RawVehicleEventSchema.omit({
+    _id: true,
+    received_at: true,
+});

package/dist/vehicle-events/simplified-vehicle-event.d.ts

@@ -1,105 +1,69 @@
 import { z } from 'zod';
-export declare const SimplifiedVehicleEventSchema: z.ZodObject<Omit<{
+export declare const SimplifiedVehicleEventSchema: z.ZodObject<{
     _id: z.ZodString;
-    created_at: z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>;
-    created_by: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    is_locked: z.ZodDefault<z.ZodBoolean>;
-    updated_at: z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>;
-    updated_by: z.ZodOptional<z.ZodString>;
-}, "created_by" | "is_locked" | "updated_by"> & {
     agency_id: z.ZodString;
-    current_status: z.ZodEnum<["INCOMING_AT", "STOPPED_AT", "IN_TRANSIT_TO"]>;
-    driver_id: z.ZodString;
-    event_id: z.ZodString;
-    extra_trip_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    created_at: z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>;
     latitude: z.ZodNumber;
     longitude: z.ZodNumber;
-    odometer: z.ZodNumber;
-    pattern_id: z.ZodString;
-    position: z.ZodObject<{
-        geohash: z.ZodString;
-        h3: z.ZodString;
-        latitude: z.ZodNumber;
-        longitude: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        geohash: string;
-        h3: string;
-        latitude: number;
-        longitude: number;
-    }, {
-        geohash: string;
-        h3: string;
-        latitude: number;
-        longitude: number;
-    }>;
     received_at: z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>;
-    stop_id: z.ZodString;
-    trigger_activity: z.ZodString;
-    trigger_door: z.ZodString;
     trip_id: z.ZodString;
     vehicle_id: z.ZodString;
+    bearing: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    current_status: z.ZodDefault<z.ZodNullable<z.ZodEnum<["INCOMING_AT", "STOPPED_AT", "IN_TRANSIT_TO"]>>>;
+    door: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    driver_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    extra_trip_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    odometer: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    pattern_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    speed: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    stop_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     _id: string;
     created_at: number & {
         __brand: "UnixTimestamp";
     };
-    updated_at: number & {
-        __brand: "UnixTimestamp";
-    };
     latitude: number;
     longitude: number;
     agency_id: string;
-    pattern_id: string;
+    pattern_id: string | null;
     received_at: number & {
         __brand: "UnixTimestamp";
     };
-    stop_id: string;
+    stop_id: string | null;
     trip_id: string;
     vehicle_id: string;
-    event_id: string;
-    odometer: number;
-    current_status: "INCOMING_AT" | "STOPPED_AT" | "IN_TRANSIT_TO";
-    position: {
-        geohash: string;
-        h3: string;
-        latitude: number;
-        longitude: number;
-    };
-    driver_id: string;
-    trigger_activity: string;
-    trigger_door: string;
-    extra_trip_id?: string | null | undefined;
+    bearing: number | null;
+    odometer: number | null;
+    speed: number | null;
+    current_status: "INCOMING_AT" | "STOPPED_AT" | "IN_TRANSIT_TO" | null;
+    door: string | null;
+    driver_id: string | null;
+    extra_trip_id: string | null;
 }, {
     _id: string;
     created_at: number;
-    updated_at: number;
     latitude: number;
     longitude: number;
     agency_id: string;
-    pattern_id: string;
     received_at: number;
-    stop_id: string;
     trip_id: string;
     vehicle_id: string;
-    event_id: string;
-    odometer: number;
-    current_status: "INCOMING_AT" | "STOPPED_AT" | "IN_TRANSIT_TO";
-    position: {
-        geohash: string;
-        h3: string;
-        latitude: number;
-        longitude: number;
-    };
-    driver_id: string;
-    trigger_activity: string;
-    trigger_door: string;
+    pattern_id?: string | null | undefined;
+    stop_id?: string | null | undefined;
+    bearing?: number | null | undefined;
+    odometer?: number | null | undefined;
+    speed?: number | null | undefined;
+    current_status?: "INCOMING_AT" | "STOPPED_AT" | "IN_TRANSIT_TO" | null | undefined;
+    door?: string | null | undefined;
+    driver_id?: string | null | undefined;
     extra_trip_id?: string | null | undefined;
 }>;
 /**
- * Vehicle Events are produced by the vehicle's on-board computer on a regular schedule
- * or whenever a significant event occurs. These events are used to track the vehicle's
- * location, speed, and status, as well as the current service being provided by the vehicle.
- * These events are based on the GTFS-RT specification but extended with additional fields
- * specific to TML's needs.
+ * Simplified Vehicle Events are data structures that represent the essential
+ * information about a vehicle's status and location at a given time. They are derived
+ * from the raw vehicle events produced by the vehicle's on-board computer, but they
+ * have been processed and simplified to include only the most relevant fields for analysis
+ * and reporting purposes. These events are used to track the vehicle's location, speed
+ * and status, as well as the current service being provided by the vehicle.
  */
 export type SimplifiedVehicleEvent = z.infer<typeof SimplifiedVehicleEventSchema>;

package/dist/vehicle-events/simplified-vehicle-event.js

@@ -1,26 +1,26 @@
 /* * */
-import { DocumentSchema } from '../_common/document.js';
-import { PositionSchema } from '../_common/position.js';
 import { UnixTimeStampSchema } from '../_common/unix-timestamp.js';
 import { z } from 'zod';
 /* * */
-export const SimplifiedVehicleEventSchema = DocumentSchema
-    .omit({ created_by: true, is_locked: true, updated_by: true })
-    .extend({
+export const SimplifiedVehicleEventSchema = z.object({
+    //
+    // Required Fields
+    _id: z.string(),
     agency_id: z.string(),
-    current_status: z.enum(['INCOMING_AT', 'STOPPED_AT', 'IN_TRANSIT_TO']),
-    driver_id: z.string(),
-    event_id: z.string(),
-    extra_trip_id: z.string().nullish(),
+    created_at: UnixTimeStampSchema,
     latitude: z.number(),
     longitude: z.number(),
-    odometer: z.number(),
-    pattern_id: z.string(),
-    position: PositionSchema,
     received_at: UnixTimeStampSchema,
-    stop_id: z.string(),
-    trigger_activity: z.string(),
-    trigger_door: z.string(),
     trip_id: z.string(),
     vehicle_id: z.string(),
+    // Optional Fields
+    bearing: z.number().nullable().default(null),
+    current_status: z.enum(['INCOMING_AT', 'STOPPED_AT', 'IN_TRANSIT_TO']).nullable().default(null),
+    door: z.string().nullable().default(null),
+    driver_id: z.string().nullable().default(null),
+    extra_trip_id: z.string().nullable().default(null),
+    odometer: z.number().nullable().default(null),
+    pattern_id: z.string().nullable().default(null),
+    speed: z.number().nullable().default(null),
+    stop_id: z.string().nullable().default(null),
 });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/types",
-	"version": "20260320.1741.37",
+	"version": "20260320.2238.33",
 	"author": {
 		"email": "iso@tmlmobilidade.pt",
 		"name": "TML-ISO"