@tmlmobilidade/interfaces 20250901.2108.42 → 20250902.1310.34

package/dist/src/interfaces/agencies/index.d.ts

@@ -0,0 +1 @@
+export * from './agencies.js';

package/dist/src/interfaces/agencies/index.js

@@ -0,0 +1 @@
+export * from './agencies.js';

package/dist/src/interfaces/alerts/index.d.ts

@@ -0,0 +1,2 @@
+export * from './alerts-realtime.js';
+export * from './alerts.js';

package/dist/src/interfaces/alerts/index.js

@@ -0,0 +1,2 @@
+export * from './alerts-realtime.js';
+export * from './alerts.js';

package/dist/src/interfaces/auth/index.d.ts

@@ -0,0 +1,4 @@
+export * from './roles.js';
+export * from './sessions.js';
+export * from './users.js';
+export * from './verification-tokens.js';

package/dist/src/interfaces/auth/index.js

@@ -0,0 +1,4 @@
+export * from './roles.js';
+export * from './sessions.js';
+export * from './users.js';
+export * from './verification-tokens.js';

package/dist/src/interfaces/files/index.d.ts

@@ -0,0 +1 @@
+export * from './files.js';

package/dist/src/interfaces/files/index.js

@@ -0,0 +1 @@
+export * from './files.js';

package/dist/src/interfaces/gtfs-validations/index.d.ts

@@ -0,0 +1 @@
+export * from './gtfs-validations.js';

package/dist/src/interfaces/gtfs-validations/index.js

@@ -0,0 +1 @@
+export * from './gtfs-validations.js';

package/dist/src/interfaces/index.d.ts

@@ -1,26 +1,14 @@
-export * from './agencies/agencies.interface.js';
-export * from './alerts/alerts-realtime.interface.js';
-export * from './alerts/alerts.interface.js';
-export * from './auth/roles.interface.js';
-export * from './auth/sessions.interface.js';
-export * from './auth/users.interface.js';
-export * from './auth/verification-tokens.interface.js';
-export * from './files/files.interface.js';
-export * from './gtfs-validations/gtfs-validations.interface.js';
-export * from './locations/locations.interface.js';
-export * from './organizations/organizations.interface.js';
-export * from './plans/plans.interface.js';
-export * from './proposedChanges/proposedChanges.interface.js';
-export * from './rides/hashed-shapes.interface.js';
-export * from './rides/hashed-trips.interface.js';
-export * from './rides/rides.interface.js';
-export * from './simplified-apex/sams.interface.js';
-export * from './simplified-apex/simplified-apex-inspection-decisions.interface.js';
-export * from './simplified-apex/simplified-apex-inspections.interface.js';
-export * from './simplified-apex/simplified-apex-locations.interface.js';
-export * from './simplified-apex/simplified-apex-on-board-refunds.interface.js';
-export * from './simplified-apex/simplified-apex-on-board-sales.interface.js';
-export * from './simplified-apex/simplified-apex-validations.interface.js';
-export * from './stops/stops.interface.js';
-export * from './vehicle-events/vehicle-events.interface.js';
-export * from './zones/zones.interface.js';
+export * from './agencies/index.js';
+export * from './alerts/index.js';
+export * from './auth/index.js';
+export * from './files/index.js';
+export * from './gtfs-validations/index.js';
+export * from './locations/index.js';
+export * from './organizations/index.js';
+export * from './plans/index.js';
+export * from './proposed-changes/index.js';
+export * from './rides/index.js';
+export * from './simplified-apex/index.js';
+export * from './stops/index.js';
+export * from './vehicle-events/index.js';
+export * from './zones/index.js';

package/dist/src/interfaces/index.js

@@ -1,27 +1,14 @@
-/* * */
-export * from './agencies/agencies.interface.js';
-export * from './alerts/alerts-realtime.interface.js';
-export * from './alerts/alerts.interface.js';
-export * from './auth/roles.interface.js';
-export * from './auth/sessions.interface.js';
-export * from './auth/users.interface.js';
-export * from './auth/verification-tokens.interface.js';
-export * from './files/files.interface.js';
-export * from './gtfs-validations/gtfs-validations.interface.js';
-export * from './locations/locations.interface.js';
-export * from './organizations/organizations.interface.js';
-export * from './plans/plans.interface.js';
-export * from './proposedChanges/proposedChanges.interface.js';
-export * from './rides/hashed-shapes.interface.js';
-export * from './rides/hashed-trips.interface.js';
-export * from './rides/rides.interface.js';
-export * from './simplified-apex/sams.interface.js';
-export * from './simplified-apex/simplified-apex-inspection-decisions.interface.js';
-export * from './simplified-apex/simplified-apex-inspections.interface.js';
-export * from './simplified-apex/simplified-apex-locations.interface.js';
-export * from './simplified-apex/simplified-apex-on-board-refunds.interface.js';
-export * from './simplified-apex/simplified-apex-on-board-sales.interface.js';
-export * from './simplified-apex/simplified-apex-validations.interface.js';
-export * from './stops/stops.interface.js';
-export * from './vehicle-events/vehicle-events.interface.js';
-export * from './zones/zones.interface.js';
+export * from './agencies/index.js';
+export * from './alerts/index.js';
+export * from './auth/index.js';
+export * from './files/index.js';
+export * from './gtfs-validations/index.js';
+export * from './locations/index.js';
+export * from './organizations/index.js';
+export * from './plans/index.js';
+export * from './proposed-changes/index.js';
+export * from './rides/index.js';
+export * from './simplified-apex/index.js';
+export * from './stops/index.js';
+export * from './vehicle-events/index.js';
+export * from './zones/index.js';

package/dist/src/interfaces/locations/index.d.ts

@@ -0,0 +1 @@
+export * from './locations.js';

package/dist/src/interfaces/locations/index.js

@@ -0,0 +1 @@
+export * from './locations.js';

package/dist/src/interfaces/organizations/index.d.ts

@@ -0,0 +1 @@
+export * from './organizations.js';

package/dist/src/interfaces/organizations/index.js

@@ -0,0 +1 @@
+export * from './organizations.js';

package/dist/src/interfaces/plans/index.d.ts

@@ -0,0 +1 @@
+export * from './plans.js';

package/dist/src/interfaces/plans/index.js

@@ -0,0 +1 @@
+export * from './plans.js';

package/dist/src/interfaces/proposed-changes/index.d.ts

@@ -0,0 +1 @@
+export * from './proposed-changes.js';

package/dist/src/interfaces/proposed-changes/index.js

@@ -0,0 +1 @@
+export * from './proposed-changes.js';

package/dist/src/interfaces/rides/index.d.ts

@@ -0,0 +1,4 @@
+export * from './hashed-shapes.js';
+export * from './hashed-trips.js';
+export * from './ride-annotations.js';
+export * from './rides.js';

package/dist/src/interfaces/rides/index.js

@@ -0,0 +1,4 @@
+export * from './hashed-shapes.js';
+export * from './hashed-trips.js';
+export * from './ride-annotations.js';
+export * from './rides.js';

package/dist/src/interfaces/rides/ride-annotations.d.ts

@@ -0,0 +1,63 @@
+import { MongoCollectionClass } from '../../mongo-collection.js';
+import { CreateRideAnnotationDto, RideAnnotation, UpdateRideAnnotationDto } from '@tmlmobilidade/types';
+import { IndexDescription } from 'mongodb';
+import { z } from 'zod';
+declare class RideAnnotationsClass extends MongoCollectionClass<RideAnnotation, CreateRideAnnotationDto, UpdateRideAnnotationDto> {
+    private static _instance;
+    protected createSchema: z.ZodSchema;
+    protected updateSchema: z.ZodSchema;
+    private constructor();
+    static getInstance(): Promise<RideAnnotationsClass>;
+    /**
+     * Finds ride documents by Ride ID.
+     * @param rideId - The Ride ID to search for.
+     * @returns A promise that resolves to an array of matching ride documents.
+     */
+    findByRideId(rideId: string): Promise<import("mongodb").WithId<{
+        _id: string;
+        is_locked: boolean;
+        acceptance: {
+            _id: string;
+            status: "accepted" | "justification_required" | "under_review" | "rejected";
+            created_by: string | null;
+            analysis_summary: Record<string, "error" | "pass" | "fail" | "skip"> | null;
+            mode: "manual" | "auto";
+            created_at?: (number & {
+                __brand: "UnixTimestamp";
+            } & z.BRAND<"UnixTimestamp">) | null | undefined;
+            updated_at?: (number & {
+                __brand: "UnixTimestamp";
+            } & z.BRAND<"UnixTimestamp">) | null | undefined;
+        }[];
+        justification: {
+            comments: {
+                _id: string;
+                text: string;
+                user_id: string;
+                created_at?: (number & {
+                    __brand: "UnixTimestamp";
+                } & z.BRAND<"UnixTimestamp">) | null | undefined;
+                updated_at?: (number & {
+                    __brand: "UnixTimestamp";
+                } & z.BRAND<"UnixTimestamp">) | null | undefined;
+            }[];
+            file_ids: string[];
+            pto_message: string;
+        } | null;
+        overrides: {
+            trip_id: string | null;
+        } | null;
+        ride_id: string;
+        created_at?: (number & {
+            __brand: "UnixTimestamp";
+        } & z.BRAND<"UnixTimestamp">) | null | undefined;
+        updated_at?: (number & {
+            __brand: "UnixTimestamp";
+        } & z.BRAND<"UnixTimestamp">) | null | undefined;
+    }>[]>;
+    protected getCollectionIndexes(): IndexDescription[];
+    protected getCollectionName(): string;
+    protected getEnvName(): string;
+}
+export declare const rideAnnotations: RideAnnotationsClass;
+export {};

package/dist/src/interfaces/rides/ride-annotations.js

@@ -0,0 +1,48 @@
+/* * */
+import { MongoCollectionClass } from '../../mongo-collection.js';
+import { RideAnnotationSchema, UpdateRideAnnotationSchema } from '@tmlmobilidade/types';
+import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
+/* * */
+class RideAnnotationsClass extends MongoCollectionClass {
+    static _instance;
+    createSchema = RideAnnotationSchema;
+    updateSchema = UpdateRideAnnotationSchema;
+    constructor() {
+        super();
+    }
+    static async getInstance() {
+        if (!RideAnnotationsClass._instance) {
+            const instance = new RideAnnotationsClass();
+            await instance.connect();
+            RideAnnotationsClass._instance = instance;
+        }
+        return RideAnnotationsClass._instance;
+    }
+    /**
+     * Finds ride documents by Ride ID.
+     * @param rideId - The Ride ID to search for.
+     * @returns A promise that resolves to an array of matching ride documents.
+     */
+    async findByRideId(rideId) {
+        return this.mongoCollection.find({ ride_id: rideId }).toArray();
+    }
+    getCollectionIndexes() {
+        /**
+         * IMPORTANT:
+         * Automatic sorting (ESLint) of keys in the JS objects should be disabled.
+         * The order of keys in a compound index is very important and should be
+         * carefully considered based on the cardinality of each key.
+         */
+        return [
+            { background: true, key: { ride_id: 1 } },
+        ];
+    }
+    getCollectionName() {
+        return 'ride_annotations';
+    }
+    getEnvName() {
+        return 'DATABASE_URI';
+    }
+}
+/* * */
+export const rideAnnotations = AsyncSingletonProxy(RideAnnotationsClass);

package/dist/src/interfaces/simplified-apex/index.d.ts

@@ -0,0 +1,7 @@
+export * from './sams.js';
+export * from './simplified-apex-inspection-decisions.js';
+export * from './simplified-apex-inspections.js';
+export * from './simplified-apex-locations.js';
+export * from './simplified-apex-on-board-refunds.js';
+export * from './simplified-apex-on-board-sales.js';
+export * from './simplified-apex-validations.js';

package/dist/src/interfaces/simplified-apex/index.js

@@ -0,0 +1,7 @@
+export * from './sams.js';
+export * from './simplified-apex-inspection-decisions.js';
+export * from './simplified-apex-inspections.js';
+export * from './simplified-apex-locations.js';
+export * from './simplified-apex-on-board-refunds.js';
+export * from './simplified-apex-on-board-sales.js';
+export * from './simplified-apex-validations.js';

package/dist/src/interfaces/simplified-apex/{sams.interface.d.ts → sams.d.ts}

@@ -1,16 +1,16 @@
 import { MongoCollectionClass } from '../../mongo-collection.js';
-import { type CreateUniqueSamDto, type UniqueSam, type UpdateUniqueSamDto } from '@tmlmobilidade/types';
+import { type CreateSamDto, type Sam, type UpdateSamDto } from '@tmlmobilidade/types';
 import { IndexDescription } from 'mongodb';
 import { z } from 'zod';
-declare class UniqueSamsClass extends MongoCollectionClass<UniqueSam, CreateUniqueSamDto, UpdateUniqueSamDto> {
+declare class SamsClass extends MongoCollectionClass<Sam, CreateSamDto, UpdateSamDto> {
     private static _instance;
     protected createSchema: z.ZodSchema;
     protected updateSchema: z.ZodSchema;
     private constructor();
-    static getInstance(): Promise<UniqueSamsClass>;
+    static getInstance(): Promise<SamsClass>;
     protected getCollectionIndexes(): IndexDescription[];
     protected getCollectionName(): string;
     protected getEnvName(): string;
 }
-export declare const uniqueSams: UniqueSamsClass;
+export declare const uniqueSams: SamsClass;
 export {};

package/dist/src/interfaces/simplified-apex/{sams.interface.js → sams.js}

@@ -1,22 +1,22 @@
 /* * */
 import { MongoCollectionClass } from '../../mongo-collection.js';
-import { UniqueSamSchema, UpdateUniqueSamSchema } from '@tmlmobilidade/types';
+import { SamSchema, UpdateSamSchema } from '@tmlmobilidade/types';
 import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
 /* * */
-class UniqueSamsClass extends MongoCollectionClass {
+class SamsClass extends MongoCollectionClass {
     static _instance;
-    createSchema = UniqueSamSchema;
-    updateSchema = UpdateUniqueSamSchema;
+    createSchema = SamSchema;
+    updateSchema = UpdateSamSchema;
     constructor() {
         super();
     }
     static async getInstance() {
-        if (!UniqueSamsClass._instance) {
-            const instance = new UniqueSamsClass();
+        if (!SamsClass._instance) {
+            const instance = new SamsClass();
             await instance.connect();
-            UniqueSamsClass._instance = instance;
+            SamsClass._instance = instance;
         }
-        return UniqueSamsClass._instance;
+        return SamsClass._instance;
     }
     getCollectionIndexes() {
         return [
@@ -33,4 +33,4 @@ class UniqueSamsClass extends MongoCollectionClass {
     }
 }
 /* * */
-export const uniqueSams = AsyncSingletonProxy(UniqueSamsClass);
+export const uniqueSams = AsyncSingletonProxy(SamsClass);

package/dist/src/interfaces/stops/index.d.ts

@@ -0,0 +1 @@
+export * from './stops.js';

package/dist/src/interfaces/stops/index.js

@@ -0,0 +1 @@
+export * from './stops.js';

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

@@ -0,0 +1 @@
+export * from './vehicle-events.js';

package/dist/src/interfaces/vehicle-events/index.js

@@ -0,0 +1 @@
+export * from './vehicle-events.js';

package/dist/src/interfaces/zones/index.d.ts

@@ -0,0 +1 @@
+export * from './zones.js';

package/dist/src/interfaces/zones/index.js

@@ -0,0 +1 @@
+export * from './zones.js';

package/dist/src/interfaces/zones/{zones.interface.d.ts → zones.d.ts}

@@ -10,23 +10,20 @@ declare class ZonesClass extends MongoCollectionClass<Zone, CreateZoneDto, Updat
     static getInstance(): Promise<ZonesClass>;
     /**
      * Finds a zone document by its code.
-     *
-     * @param code - The code of the zone to find
+     * @param code The code of the zone to find
      * @returns A promise that resolves to the matching zone document or null if not found
      */
     findByCode(code: string): Promise<import("mongodb").WithId<Zone> | null>;
     /**
      * Finds a zone document by its name.
-     *
-     * @param name - The name of the zone to find
+     * @param name The name of the zone to find
      * @returns A promise that resolves to the matching zone document or null if not found
      */
     findByName(name: string): Promise<import("mongodb").WithId<Zone> | null>;
     /**
      * Updates a zone document by its code.
-     *
-     * @param code - The code of the zone to update.
-     * @param updateFields - The fields to update in the zone document.
+     * @param code The code of the zone to update.
+     * @param updateFields The fields to update in the zone document.
      * @returns A promise that resolves to the result of the update operation.
      */
     updateByCode(code: string, updateFields: Partial<Zone>): Promise<import("mongodb").UpdateResult<Zone>>;

package/dist/src/interfaces/zones/{zones.interface.js → zones.js}

@@ -20,8 +20,7 @@ class ZonesClass extends MongoCollectionClass {
     }
     /**
      * Finds a zone document by its code.
-     *
-     * @param code - The code of the zone to find
+     * @param code The code of the zone to find
      * @returns A promise that resolves to the matching zone document or null if not found
      */
     async findByCode(code) {
@@ -29,8 +28,7 @@ class ZonesClass extends MongoCollectionClass {
     }
     /**
      * Finds a zone document by its name.
-     *
-     * @param name - The name of the zone to find
+     * @param name The name of the zone to find
      * @returns A promise that resolves to the matching zone document or null if not found
      */
     async findByName(name) {
@@ -38,9 +36,8 @@ class ZonesClass extends MongoCollectionClass {
     }
     /**
      * Updates a zone document by its code.
-     *
-     * @param code - The code of the zone to update.
-     * @param updateFields - The fields to update in the zone document.
+     * @param code The code of the zone to update.
+     * @param updateFields The fields to update in the zone document.
      * @returns A promise that resolves to the result of the update operation.
      */
     async updateByCode(code, updateFields) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/interfaces",
-	"version": "20250901.2108.42",
+	"version": "20250902.1310.34",
 	"author": "João de Vasconcelos & Jusi Monteiro",
 	"license": "AGPL-3.0-or-later",
 	"homepage": "https://github.com/tmlmobilidade/services#readme",
@@ -36,8 +36,8 @@
 		"lint:fix": "eslint --fix"
 	},
 	"dependencies": {
-		"@aws-sdk/client-s3": "3.876.0",
-		"@aws-sdk/s3-request-presigner": "3.876.0",
+		"@aws-sdk/client-s3": "3.879.0",
+		"@aws-sdk/s3-request-presigner": "3.879.0",
 		"@tmlmobilidade/connectors": "*",
 		"@tmlmobilidade/emails": "*",
 		"@tmlmobilidade/lib": "*",
@@ -47,7 +47,7 @@
 		"bcryptjs": "3.0.2",
 		"luxon": "3.7.1",
 		"mongodb": "6.19.0",
-		"nodemailer": "7.0.5",
+		"nodemailer": "7.0.6",
 		"oci-common": "2.116.1",
 		"oci-objectstorage": "2.116.1",
 		"zod": "3.25.76"