Payload validation and parsing with zod

Server/package.json

@@ -39,7 +39,8 @@
 		"jsonschema": "^1.4.1",
 		"jsonwebtoken": "^9.0.0",
 		"morgan": "^1.10.0",
-		"winston": "^3.8.2"
+		"winston": "^3.8.2",
+		"zod": "^3.22.2"
 	},
 	"devDependencies": {
 		"@types/dotenv": "^8.2.0",
@@ -55,4 +56,4 @@
 		"ts-node": "^10.9.1",
 		"typescript": "^5.1.6"
 	}
-}
+}

Server/src/models/api.app.ts

@@ -1,65 +1,32 @@
 import { PointOfInterest, Position, Vehicle } from "./api"
-import { GeoJSON } from "geojson"
+import { z } from "zod"
 
 // TODO: seperate the types
-/** @see {isInitResponseApp} ts-auto-guard:type-guard */
-export type InitResponseApp = {
-	trackId: number
-	trackName: string
-	trackPath: GeoJSON.FeatureCollection
-	trackLength: number
-	pointsOfInterest: PointOfInterest[]
-} // FullTrack & {pointsOfInterest: PointOfInterest[];};
+export const InitResponseApp = z.object({
+	trackId: z.number(),
+	trackName: z.string(),
+	trackPath: z.any(), //TODO: What kind of FeatureCollection? old ->GeoJSON.FeatureCollection
+	trackLength: z.number(),
+	pointsOfInterest: PointOfInterest.array()
+}) // FullTrack & {pointsOfInterest: PointOfInterest[];};
 
 // TODO: change to just BareTrack.
-/** @see {isTrackListEntryApp} ts-auto-guard:type-guard */
-export type TrackListEntryApp = {
-	id: number // Positive integer to uniquely identify track
-	name: string // E.g. "Malente-Lütjenburg"
-}
+export const TrackListEntryApp = z.object({
+	id: z.number(), // Positive integer to uniquely identify track
+	name: z.string() // E.g. "Malente-Lütjenburg"
+})
 
 // TODO: simplify to just Position, without wrapping.
-/** @see {isInitRequestApp} ts-auto-guard:type-guard */
-export type InitRequestApp = {
+export const InitRequestApp = z.object({
 	pos: Position
-}
+})
 
-// export enum POIType {
-//     None = 0,
-//     LevelCrossing = 1,
-//     LesserLevelCrossing = 2,
-//     Picnic = 3,
-//     TrackEnd = 4,
-// }
-
-/** @see {isUpdateRequestApp} ts-auto-guard:type-guard */
-export interface UpdateRequestApp {
-	vehicleId: number // vehicle id of user
-	pos?: Position // the current position of user
-	speed?: number // Speed in km/h
-	heading?: number // Heading of the vehicle between 0 and 359
-}
-
-/** @see {isUpdateResponseApp} ts-auto-guard:type-guard */
-export interface UpdateResponseApp {
-	pos: Position // The current position as measured by vehicle
-	heading: number // Heading of the vehicle between 0 and 359
-	vehiclesNearUser: VehicleApp[] // Vehicles that should be marked on the map
-	percentagePositionOnTrack: number // Percentage (0-100) e.g. 0% Malente; 100% Lütjenburg
-	speed: number // Speed in km/h
-	passingPosition?: Position // Only set if needed
-}
-
-/** @see {isGetUidApp} ts-auto-guard:type-guard */
-export interface GetUidApp {
-	vehicleName: string
-	trackId: number
-}
-
-/** @see {isReturnUidApp} ts-auto-guard:type-guard */
-export interface ReturnUidApp {
-	vehicleId: number
-}
+export const UpdateRequestApp = z.object({
+	vehicleId: z.number(), // vehicle id of user
+	pos: Position.optional(), // the current position of user
+	speed: z.number().optional(), // Speed in km/h
+	heading: z.number().optional() // Heading of the vehicle between 0 and 359
+})
 
 //================ new
 
@@ -68,8 +35,27 @@ export interface ReturnUidApp {
  * if it is heading towards a user.
  * TODO: replace with a specific API
  */
-/** @see {isVehicleApp} ts-auto-guard:type-guard */
-export interface VehicleApp extends Vehicle {
-	id: number
-	headingTowardsUser?: boolean // Is the other vehicle heading towards the user?
-}
+export const VehicleApp = Vehicle.extend({
+	id: z.number(),
+	headingTowardsUser: z.boolean().optional() // Is the other vehicle heading towards the user?
+})
+
+//================ new
+
+export const UpdateResponseApp = z.object({
+	pos: Position, // The current position as measured by vehicle
+	heading: z.number(), // Heading of the vehicle between 0 and 359
+	vehiclesNearUser: VehicleApp.array(), // Vehicles that should be marked on the map
+	percentagePositionOnTrack: z.number(), // Percentage (0-100) e.g. 0% Malente; 100% Lütjenburg
+	speed: z.number(), // Speed in km/h
+	passingPosition: Position.optional() // Only set if needed
+})
+
+export const GetUidApp = z.object({
+	vehicleName: z.string(),
+	trackId: z.number()
+})
+
+export const ReturnUidApp = z.object({
+	vehicleId: z.number()
+})

Server/src/models/api.tracker.ts

@@ -1,64 +1,62 @@
-/** @see {isUplinkTracker} ts-auto-guard:type-guard */
-export type UplinkTracker = {
-	end_device_ids: EndDeviceIdsTracker
-	received_at: string
-	uplink_message: UplinkMessageTracker
-}
+import { z } from "zod"
+
+export const EndDeviceIdsTracker = z.object({
+	device_id: z.string()
+})
 
-/** @see {isEndDevoceIdsTracker} ts-auto-guard:type-guard */
-export type EndDeviceIdsTracker = {
-	device_id: string
-}
+export const DecodedPayloadTracker = z.object({
+	batV: z.number(),
+	fixFailed: z.boolean(),
+	headingDeg: z.number(),
+	inTrip: z.boolean(),
+	latitudeDeg: z.number(),
+	longitudeDeg: z.number(),
+	speedKmph: z.number(),
+	type: z.string()
+})
 
-/** @see {isUplinkMessageTracker} ts-auto-guard:type-guard */
-export type UplinkMessageTracker = {
-	f_port: number
+export const UplinkMessageTracker = z.object({
+	f_port: z.number(),
 	decoded_payload: DecodedPayloadTracker
-}
+})
 
-/** @see {isDecodedPayloadTracker} ts-auto-guard:type-guard */
-export type DecodedPayloadTracker = {
-	batV: number
-	fixFailed: boolean
-	headingDeg: number
-	inTrip: boolean
-	latitudeDeg: number
-	longitudeDeg: number
-	speedKmph: number
-	type: string
-}
+export const UplinkTracker = z.object({
+	end_device_ids: EndDeviceIdsTracker,
+	received_at: z.string(),
+	uplink_message: UplinkMessageTracker
+})
 
-export type UplinkLteTracker = {
-	SerNo: number
-	IMEI: string
-	ICCID: string
-	ProdId: number
-	FW: string
-	Records: LteRecord[]
-}
+export const LteRecord = z.object({
+	SeqNo: z.number(),
+	Reason: z.number(),
+	DateUTC: z.string(),
+	Fields: z.any() // list of heterogenous objects depending on FType
+})
 
-export type LteRecord = {
-	SeqNo: number
-	Reason: number
-	DateUTC: string
-	Fields: any // list of heterogenous objects depending on FType
-}
+export const LteRecordField0 = z.object({
+	GpsUTC: z.string(),
+	Lat: z.number(),
+	Long: z.number(),
+	Alt: z.number(),
+	Spd: z.number(),
+	SpdAcc: z.number(),
+	Head: z.number(),
+	PDOP: z.number(),
+	PosAcc: z.number(),
+	GpsStat: z.number(),
+	FType: z.literal(0)
+})
 
-export type LteRecordField0 = {
-	GpsUTC: string
-	Lat: number
-	Long: number
-	Alt: number
-	Spd: number
-	SpdAcc: number
-	Head: number
-	PDOP: number
-	PosAcc: number
-	GpsStat: number
-	FType: 0
-}
+export const LteRecordField6 = z.object({
+	AnalogueData: z.any(), // object with numbers as keys ("1": probably battery voltage (x100), "3": probably temperature (x100), "4": probably GSM signal)
+	FType: z.literal(6)
+})
 
-export type LteRecordField6 = {
-	AnalogueData: any // object with numbers as keys ("1": probably battery voltage (x100), "3": probably temperature (x100), "4": probably GSM signal)
-	FType: 6
-}
+export const UplinkLteTracker = z.object({
+	SerNo: z.number(),
+	IMEI: z.string(),
+	ICCID: z.string(),
+	ProdId: z.number(),
+	FW: z.string(),
+	Records: z.array(LteRecord)
+})