@tmlmobilidade/types 20250325.1729.12

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

@@ -0,0 +1,76 @@
+import { type UnixTimestamp } from './common.js';
+import { z } from 'zod';
+export declare const VehicleEventSchema: z.ZodObject<z.objectUtil.extendShape<{
+    _id: z.ZodString;
+    created_at: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">>>;
+    updated_at: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">>>;
+}, {
+    agency_id: z.ZodString;
+    driver_id: z.ZodString;
+    event_id: z.ZodString;
+    extra_trip_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    latitude: z.ZodNumber;
+    longitude: z.ZodNumber;
+    odometer: z.ZodNumber;
+    pattern_id: z.ZodString;
+    received_at: z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">;
+    stop_id: z.ZodString;
+    trigger_activity: z.ZodString;
+    trigger_door: z.ZodString;
+    trip_id: z.ZodString;
+    vehicle_id: z.ZodString;
+}>, "strict", z.ZodTypeAny, {
+    _id: string;
+    agency_id: string;
+    pattern_id: string;
+    received_at: number & {
+        __brand: "UnixTimestamp";
+    } & z.BRAND<"UnixTimestamp">;
+    stop_id: string;
+    trip_id: string;
+    vehicle_id: string;
+    latitude: number;
+    longitude: number;
+    driver_id: string;
+    event_id: string;
+    odometer: number;
+    trigger_activity: string;
+    trigger_door: string;
+    created_at?: (number & {
+        __brand: "UnixTimestamp";
+    } & z.BRAND<"UnixTimestamp">) | null | undefined;
+    updated_at?: (number & {
+        __brand: "UnixTimestamp";
+    } & z.BRAND<"UnixTimestamp">) | null | undefined;
+    extra_trip_id?: string | null | undefined;
+}, {
+    _id: string;
+    agency_id: string;
+    pattern_id: string;
+    received_at: number;
+    stop_id: string;
+    trip_id: string;
+    vehicle_id: string;
+    latitude: number;
+    longitude: number;
+    driver_id: string;
+    event_id: string;
+    odometer: number;
+    trigger_activity: string;
+    trigger_door: string;
+    created_at?: number | null | undefined;
+    updated_at?: number | 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.
+ */
+export interface VehicleEvent extends Omit<z.infer<typeof VehicleEventSchema>, 'created_at' | 'received_at' | 'updated_at'> {
+    created_at: UnixTimestamp;
+    received_at: UnixTimestamp;
+    updated_at: UnixTimestamp;
+}

package/dist/src/vehicle-event.js

@@ -0,0 +1,20 @@
+/* * */
+import { DocumentSchema, validateUnixTimestamp } from './common.js';
+import { z } from 'zod';
+/* * */
+export const VehicleEventSchema = DocumentSchema.extend({
+    agency_id: z.string(),
+    driver_id: z.string(),
+    event_id: z.string(),
+    extra_trip_id: z.string().nullish(),
+    latitude: z.number(),
+    longitude: z.number(),
+    odometer: z.number(),
+    pattern_id: z.string(),
+    received_at: z.number().transform(validateUnixTimestamp).brand('UnixTimestamp'),
+    stop_id: z.string(),
+    trigger_activity: z.string(),
+    trigger_door: z.string(),
+    trip_id: z.string(),
+    vehicle_id: z.string(),
+}).strict();

package/dist/src/zone.d.ts

@@ -0,0 +1,120 @@
+import { type GeoJSON } from 'geojson';
+import { z } from 'zod';
+export declare const ZoneSchema: z.ZodObject<z.objectUtil.extendShape<{
+    _id: z.ZodString;
+    created_at: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodEffects<z.ZodNumber, import("./common.js").UnixTimestamp, number>, "UnixTimestamp">>>;
+    updated_at: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodEffects<z.ZodNumber, import("./common.js").UnixTimestamp, number>, "UnixTimestamp">>>;
+}, {
+    border_color: z.ZodString;
+    border_opacity: z.ZodNumber;
+    border_width: z.ZodNumber;
+    code: z.ZodString;
+    created_at: z.ZodDate;
+    fill_color: z.ZodString;
+    fill_opacity: z.ZodNumber;
+    geojson: z.ZodRecord<z.ZodString, z.ZodAny>;
+    is_locked: z.ZodBoolean;
+    name: z.ZodString;
+}>, "strict", z.ZodTypeAny, {
+    _id: string;
+    created_at: Date;
+    code: string;
+    is_locked: boolean;
+    name: string;
+    border_color: string;
+    border_opacity: number;
+    border_width: number;
+    fill_color: string;
+    fill_opacity: number;
+    geojson: Record<string, any>;
+    updated_at?: (number & {
+        __brand: "UnixTimestamp";
+    } & z.BRAND<"UnixTimestamp">) | null | undefined;
+}, {
+    _id: string;
+    created_at: Date;
+    code: string;
+    is_locked: boolean;
+    name: string;
+    border_color: string;
+    border_opacity: number;
+    border_width: number;
+    fill_color: string;
+    fill_opacity: number;
+    geojson: Record<string, any>;
+    updated_at?: number | null | undefined;
+}>;
+export declare const CreateZoneSchema: z.ZodObject<Omit<z.objectUtil.extendShape<{
+    _id: z.ZodString;
+    created_at: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodEffects<z.ZodNumber, import("./common.js").UnixTimestamp, number>, "UnixTimestamp">>>;
+    updated_at: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodEffects<z.ZodNumber, import("./common.js").UnixTimestamp, number>, "UnixTimestamp">>>;
+}, {
+    border_color: z.ZodString;
+    border_opacity: z.ZodNumber;
+    border_width: z.ZodNumber;
+    code: z.ZodString;
+    created_at: z.ZodDate;
+    fill_color: z.ZodString;
+    fill_opacity: z.ZodNumber;
+    geojson: z.ZodRecord<z.ZodString, z.ZodAny>;
+    is_locked: z.ZodBoolean;
+    name: z.ZodString;
+}>, "_id" | "created_at" | "updated_at">, "strict", z.ZodTypeAny, {
+    code: string;
+    is_locked: boolean;
+    name: string;
+    border_color: string;
+    border_opacity: number;
+    border_width: number;
+    fill_color: string;
+    fill_opacity: number;
+    geojson: Record<string, any>;
+}, {
+    code: string;
+    is_locked: boolean;
+    name: string;
+    border_color: string;
+    border_opacity: number;
+    border_width: number;
+    fill_color: string;
+    fill_opacity: number;
+    geojson: Record<string, any>;
+}>;
+export declare const UpdateZoneSchema: z.ZodObject<{
+    code: z.ZodOptional<z.ZodString>;
+    is_locked: z.ZodOptional<z.ZodBoolean>;
+    name: z.ZodOptional<z.ZodString>;
+    border_color: z.ZodOptional<z.ZodString>;
+    border_opacity: z.ZodOptional<z.ZodNumber>;
+    border_width: z.ZodOptional<z.ZodNumber>;
+    fill_color: z.ZodOptional<z.ZodString>;
+    fill_opacity: z.ZodOptional<z.ZodNumber>;
+    geojson: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strict", z.ZodTypeAny, {
+    code?: string | undefined;
+    is_locked?: boolean | undefined;
+    name?: string | undefined;
+    border_color?: string | undefined;
+    border_opacity?: number | undefined;
+    border_width?: number | undefined;
+    fill_color?: string | undefined;
+    fill_opacity?: number | undefined;
+    geojson?: Record<string, any> | undefined;
+}, {
+    code?: string | undefined;
+    is_locked?: boolean | undefined;
+    name?: string | undefined;
+    border_color?: string | undefined;
+    border_opacity?: number | undefined;
+    border_width?: number | undefined;
+    fill_color?: string | undefined;
+    fill_opacity?: number | undefined;
+    geojson?: Record<string, any> | undefined;
+}>;
+export type Zone = Omit<z.infer<typeof ZoneSchema>, 'geojson'> & {
+    geojson: GeoJSON;
+};
+export type CreateZoneDto = Omit<z.infer<typeof CreateZoneSchema>, 'geojson'> & {
+    geojson: GeoJSON;
+};
+export type UpdateZoneDto = Partial<CreateZoneDto>;

package/dist/src/zone.js

@@ -0,0 +1,16 @@
+import { DocumentSchema } from './common.js';
+import { z } from 'zod';
+export const ZoneSchema = DocumentSchema.extend({
+    border_color: z.string(),
+    border_opacity: z.number(),
+    border_width: z.number(),
+    code: z.string(),
+    created_at: z.coerce.date(),
+    fill_color: z.string(),
+    fill_opacity: z.number(),
+    geojson: z.record(z.any()), // TODO: Validate GeoJSON
+    is_locked: z.boolean(),
+    name: z.string(),
+}).strict();
+export const CreateZoneSchema = ZoneSchema.omit({ _id: true, created_at: true, updated_at: true });
+export const UpdateZoneSchema = CreateZoneSchema.partial();

package/package.json

@@ -0,0 +1,51 @@
+{
+	"name": "@tmlmobilidade/types",
+	"version": "20250325.1729.12",
+	"author": "João de Vasconcelos & Jusi Monteiro",
+	"license": "AGPL-3.0-or-later",
+	"homepage": "https://github.com/tmlmobilidade/services#readme",
+	"bugs": {
+		"url": "https://github.com/tmlmobilidade/services/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/tmlmobilidade/services.git"
+	},
+	"keywords": [
+		"public transit",
+		"tml",
+		"transportes metropolitanos de lisboa",
+		"services"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"module": "dist/src/index.js",
+	"files": [
+		"dist/"
+	],
+	"types": "dist/index.d.ts",
+	"scripts": {
+		"build": "rimraf ./dist && tsc && resolve-tspaths",
+		"clean": "sh cleanup.sh",
+		"lint": "eslint && tsc --noEmit",
+		"lint:fix": "eslint --fix"
+	},
+	"dependencies": {
+		"geojson": "0.5.0",
+		"luxon": "3.5.0",
+		"mongodb": "6.15.0",
+		"zod": "3.24.2"
+	},
+	"devDependencies": {
+		"@carrismetropolitana/eslint": "20250303.2009.45",
+		"@tmlmobilidade/tsconfig": "*",
+		"@types/luxon": "3.4.2",
+		"@types/node": "22.13.13",
+		"resolve-tspaths": "0.8.23",
+		"rimraf": "6.0.1",
+		"turbo": "2.4.4",
+		"typescript": "5.8.2"
+	}
+}