@tmlmobilidade/interfaces 20251031.1051.3 → 20251202.1817.5

package/dist/interfaces/pcgidb/pcgidb-validations.d.ts

@@ -0,0 +1,17 @@
+import { type Collection } from 'mongodb';
+declare class PCGIDBValidationsClass {
+    LocationEntity: Collection;
+    ValidationEntity: Collection;
+    /**
+     * Establishes a connection to the Mongo database and initializes the collection.
+     * @throws If connection fails.
+     */
+    connect(): Promise<void>;
+    /**
+     * Sets up an SSH Tunnel, if required, and returns the appropriate database URL.
+     * @throws If required environment variables are missing or if the tunnel setup fails.
+     */
+    getPcgidbValidationsConnectionString(): Promise<string>;
+}
+export declare const pcgidbValidations: PCGIDBValidationsClass;
+export {};

package/dist/interfaces/pcgidb/pcgidb-validations.js

@@ -0,0 +1,129 @@
+/* * */
+import { Logger } from '@tmlmobilidade/logger';
+import { MongoConnector } from '@tmlmobilidade/mongo';
+import { SshTunnelService } from '@tmlmobilidade/ssh';
+/* * */
+let GLOBAL_PCGIDB_TUNNEL_INSTANCE;
+/* * */
+class PCGIDBValidationsClass {
+    //
+    LocationEntity;
+    ValidationEntity;
+    /**
+     * Establishes a connection to the Mongo database and initializes the collection.
+     * @throws If connection fails.
+     */
+    async connect() {
+        //
+        //
+        // Setup SSH Tunnel, if required
+        const pcgidbValidationsConnectionString = await this.getPcgidbValidationsConnectionString();
+        //
+        // Get the database URI from environment variables
+        const mongoClientOptions = {
+            connectTimeoutMS: 10_000,
+            directConnection: true,
+            maxPoolSize: 20,
+            minPoolSize: 2,
+            readPreference: 'secondaryPreferred',
+            serverSelectionTimeoutMS: 10_000,
+        };
+        Logger.info('Connecting to PCGIDB Validations...');
+        try {
+            // Connect to the MongoDB database
+            const mongoConnector = new MongoConnector(pcgidbValidationsConnectionString, mongoClientOptions);
+            await mongoConnector.connect();
+            // Setup collections
+            this.LocationEntity = mongoConnector.client.db('LocationManagement').collection('locationEntity');
+            this.ValidationEntity = mongoConnector.client.db('ValidationsManagement').collection('validationEntity');
+            // Log success message
+            Logger.success('Connected to PCGIDB Validations successfully.');
+        }
+        catch (error) {
+            throw new Error('Error connecting to PCGIDB Validations:', { cause: error });
+        }
+    }
+    /**
+     * Sets up an SSH Tunnel, if required, and returns the appropriate database URL.
+     * @throws If required environment variables are missing or if the tunnel setup fails.
+     */
+    async getPcgidbValidationsConnectionString() {
+        //
+        //
+        // Check if the required PCGIDB environment variables are set.
+        if (!process.env.PCGIDB_VALIDATIONS_USER || !process.env.PCGIDB_VALIDATIONS_PASSWORD) {
+            throw new Error('Missing PCGIDB_VALIDATIONS_USER or PCGIDB_VALIDATIONS_PASSWORD environment variable.');
+        }
+        if (!process.env.PCGIDB_VALIDATIONS_ADDRESS || !process.env.PCGIDB_VALIDATIONS_PORT) {
+            throw new Error('Missing PCGIDB_VALIDATIONS_ADDRESS or PCGIDB_VALIDATIONS_PORT environment variable.');
+        }
+        //
+        // Check if the SSH Tunnel is required based on the environment.
+        // In 'production' and 'staging', we assume direct connection is used.
+        if (process.env.ENVIRONMENT === 'production' || process.env.ENVIRONMENT === 'staging') {
+            return `mongodb://${process.env.PCGIDB_VALIDATIONS_USER}:${process.env.PCGIDB_VALIDATIONS_PASSWORD}@${process.env.PCGIDB_VALIDATIONS_ADDRESS}:${process.env.PCGIDB_VALIDATIONS_PORT}/`;
+        }
+        //
+        // If we're here, then the SSH Tunnel is to be used.
+        // Check if the required SSH Tunnel environment variables are set.
+        if (!process.env.PCGIDB_VALIDATIONS_ADDRESS || !process.env.PCGIDB_VALIDATIONS_PORT) {
+            throw new Error('Missing PCGIDB_VALIDATIONS_ADDRESS or PCGIDB_VALIDATIONS_PORT environment variable.');
+        }
+        if (!process.env.PCGIDB_TUNNEL_LOCAL_PORT) {
+            throw new Error('Missing PCGIDB_TUNNEL_LOCAL_PORT environment variable.');
+        }
+        if (!process.env.PCGIDB_TUNNEL_SSH_HOST || !process.env.PCGIDB_TUNNEL_SSH_USERNAME) {
+            throw new Error('Missing PCGIDB_TUNNEL_SSH_HOST or PCGIDB_TUNNEL_SSH_USERNAME environment variable.');
+        }
+        //
+        // Setup the SSH Tunnel connection configuration
+        const sshConfig = {
+            forwardOptions: {
+                dstAddr: process.env.PCGIDB_VALIDATIONS_ADDRESS,
+                dstPort: Number(process.env.PCGIDB_VALIDATIONS_PORT),
+                srcAddr: 'localhost',
+                srcPort: Number(process.env.PCGIDB_TUNNEL_LOCAL_PORT),
+            },
+            serverOptions: {
+                port: Number(process.env.PCGIDB_TUNNEL_LOCAL_PORT),
+            },
+            sshOptions: {
+                /**
+                 * Using SSH Agent for authentication.
+                 * Ensure that your SSH key is added to the SSH agent beforehand.
+                 * @see https://developer.1password.com/docs/ssh/agent/compatibility/#ssh-auth-sock
+                 */
+                agent: process.env.SSH_AUTH_SOCK,
+                host: process.env.PCGIDB_TUNNEL_SSH_HOST,
+                keepaliveCountMax: 3, // Retry 3 times before closing the connection
+                keepaliveInterval: 10000, // Send keep-alive every 10 seconds
+                port: 22,
+                username: process.env.PCGIDB_TUNNEL_SSH_USERNAME,
+            },
+            tunnelOptions: {
+                autoClose: false,
+                reconnectOnError: true,
+            },
+        };
+        const sshOptions = {
+            maxRetries: 3,
+        };
+        //
+        // Actually create the SSH Tunnel connection
+        if (!GLOBAL_PCGIDB_TUNNEL_INSTANCE) {
+            GLOBAL_PCGIDB_TUNNEL_INSTANCE = new SshTunnelService(sshConfig, sshOptions);
+        }
+        Logger.info('Setting up SSH Tunnel for PCGIDB Validations...');
+        const sshTunnelConnection = await GLOBAL_PCGIDB_TUNNEL_INSTANCE.connect();
+        //
+        // Construct the PCGIDB connection string using the SSH Tunnel local address
+        const localAddress = sshTunnelConnection.address();
+        if (!localAddress || typeof localAddress !== 'object') {
+            throw new Error('Failed to retrieve the SSH tunnel address for PCGIDB Validations.');
+        }
+        return `mongodb://${process.env.PCGIDB_VALIDATIONS_USER}:${process.env.PCGIDB_VALIDATIONS_PASSWORD}@localhost:${localAddress.port}/`;
+        //
+    }
+}
+/* * */
+export const pcgidbValidations = new PCGIDBValidationsClass();

package/dist/{src/interfaces → interfaces}/plans/plans.d.ts

@@ -1,4 +1,4 @@
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { type CreatePlanDto, type Plan, type UpdatePlanDto } from '@tmlmobilidade/types';
 import { IndexDescription } from 'mongodb';
 import { z } from 'zod';
@@ -44,17 +44,23 @@ declare class PlansClass extends MongoCollectionClass<Plan, CreatePlanDto, Updat
             feed_start_date?: import("@tmlmobilidade/types").OperationalDate | null | undefined;
             feed_version?: string | null | undefined;
         };
-        controller: {
-            status: "error" | "waiting" | "processing" | "complete";
-            last_hash: string | null;
-            timestamp: import("@tmlmobilidade/types").UnixTimestamp | null;
+        apps: {
+            controller: {
+                status: "waiting" | "processing" | "complete" | "error" | "skipped";
+                last_hash: string | null;
+                timestamp: import("@tmlmobilidade/types").UnixTimestamp | null;
+            };
+            merger: {
+                status: "waiting" | "processing" | "complete" | "error" | "skipped";
+                last_hash: string | null;
+                timestamp: import("@tmlmobilidade/types").UnixTimestamp | null;
+            };
         };
         hash: string;
         operation_file_id: string;
         pcgi_legacy: {
             operation_plan_id: string | null;
         };
-        status_merger: "error" | "waiting" | "processing" | "complete";
         created_by?: string | undefined;
         updated_by?: string | undefined;
     }>[]>;

package/dist/{src/interfaces → interfaces}/plans/plans.js

@@ -1,5 +1,5 @@
 /* * */
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { PlanSchema, UpdatePlanSchema } from '@tmlmobilidade/types';
 import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
 /* * */

package/dist/{src/interfaces → interfaces}/proposed-changes/proposed-changes.d.ts

@@ -1,4 +1,4 @@
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { CreateProposedChangeDto, ProposedChange, UpdateProposedChangeDto } from '@tmlmobilidade/types';
 import { IndexDescription } from 'mongodb';
 import { z } from 'zod';

package/dist/{src/interfaces → interfaces}/proposed-changes/proposed-changes.js

@@ -1,5 +1,5 @@
 // /* * */
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { ProposedChangeSchema, UpdateProposedChangeSchema } from '@tmlmobilidade/types';
 import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
 /* * */

package/dist/{src/interfaces → interfaces}/rides/hashed-shapes.d.ts

@@ -1,4 +1,4 @@
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { HashedShape } from '@tmlmobilidade/types';
 import { IndexDescription } from 'mongodb';
 import { z } from 'zod';

package/dist/{src/interfaces → interfaces}/rides/hashed-shapes.js

@@ -1,5 +1,5 @@
 /* * */
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { DocumentSchema } from '@tmlmobilidade/types';
 import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
 /* * */

package/dist/{src/interfaces → interfaces}/rides/hashed-trips.d.ts

@@ -1,4 +1,4 @@
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { HashedTrip } from '@tmlmobilidade/types';
 import { IndexDescription } from 'mongodb';
 import { z } from 'zod';

package/dist/{src/interfaces → interfaces}/rides/hashed-trips.js

@@ -1,5 +1,5 @@
 /* * */
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { DocumentSchema } from '@tmlmobilidade/types';
 import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
 /* * */

package/dist/{src/interfaces → interfaces}/rides/pipelines.d.ts

@@ -1,5 +1,5 @@
-import { AggregationPipeline } from '../../aggregation-pipeline.js';
-import { Ride, RideAcceptanceStatus, RideAnalysisGradeWithNone, RideDelayStatus, RideOperationalStatus, RideSeenStatus, UnixTimestamp } from '@tmlmobilidade/types';
+import { AggregationPipeline } from '../../common/aggregation-pipeline.js';
+import { DelayStatus, OperationalStatus, Ride, RideAcceptanceStatus, RideAnalysisGradeWithNone, SeenStatus, UnixTimestamp } from '@tmlmobilidade/types';
 /**
  * Creates MongoDB aggregation pipeline stages to calculate and categorize delay statuses.
  *
@@ -18,8 +18,8 @@ import { Ride, RideAcceptanceStatus, RideAnalysisGradeWithNone, RideDelayStatus,
  */
 export declare function ridesPipelineDelayStatus({ filter }?: {
     filter?: {
-        end_delay_status?: RideDelayStatus[];
-        start_delay_status?: RideDelayStatus[];
+        end_delay_status?: DelayStatus[];
+        start_delay_status?: DelayStatus[];
     };
 }): AggregationPipeline<Ride>;
 /**
@@ -45,7 +45,7 @@ export declare function ridesPipelineDelayStatus({ filter }?: {
  */
 export declare function ridesPipelineOperationalStatus({ filter }?: {
     filter?: {
-        operational_status?: RideOperationalStatus[];
+        operational_status?: OperationalStatus[];
     };
 }): AggregationPipeline<Ride>;
 /**
@@ -70,7 +70,7 @@ export declare function ridesPipelineOperationalStatus({ filter }?: {
  */
 export declare function ridesPipelineSeenStatus({ filter }?: {
     filter?: {
-        seen_status?: RideSeenStatus[];
+        seen_status?: SeenStatus[];
     };
 }): AggregationPipeline<Ride>;
 interface RidesPipelineFilter {
@@ -82,11 +82,11 @@ interface RidesPipelineFilter {
     analysis_transaction_sequentiality?: RideAnalysisGradeWithNone[];
     date_end: UnixTimestamp;
     date_start: UnixTimestamp;
-    delay_statuses?: RideDelayStatus[];
+    delay_statuses?: DelayStatus[];
     line_ids?: string[];
-    operational_statuses?: RideOperationalStatus[];
+    operational_statuses?: OperationalStatus[];
     search?: string;
-    seen_statuses?: RideSeenStatus[];
+    seen_statuses?: SeenStatus[];
     stop_ids?: string[];
 }
 /**

package/dist/{src/interfaces → interfaces}/rides/pipelines.js

@@ -1,4 +1,4 @@
-import { Dates } from '@tmlmobilidade/utils';
+import { Dates } from '@tmlmobilidade/dates';
 /**
  * Creates MongoDB aggregation pipeline stages to calculate and categorize delay statuses.
  *
@@ -310,8 +310,26 @@ export function ridesBatchAggregationPipeline({ ...filter }) {
         { field: 'analysis_ended_at_last_stop_grade', path: 'analysis.ENDED_AT_LAST_STOP.grade' },
         { field: 'analysis_expected_apex_validation_interval', path: 'analysis.EXPECTED_APEX_VALIDATION_INTERVAL.grade' },
         { field: 'analysis_simple_three_vehicle_events_grade', path: 'analysis.SIMPLE_THREE_VEHICLE_EVENTS.grade' },
+        { field: 'analysis_transaction_sequentiality', path: 'analysis.TRANSACTION_SEQUENTIALITY.grade' },
     ];
-    analysisFilters.forEach(({ field, path }) => filter[field] && pipeline.push({ $match: { [path]: { $in: filter[field] } } }));
+    analysisFilters.forEach(({ field, path }) => {
+        if (!filter[field])
+            return;
+        if (filter[field].includes('none')) {
+            // When 'none' is included, set the field to 'none' if it doesn't exist, then match on the filter array
+            pipeline.push({
+                $addFields: {
+                    [path]: { $ifNull: [`$${path}`, 'none'] },
+                },
+            });
+        }
+        // Match documents where the field value is in the filter array
+        pipeline.push({
+            $match: {
+                [path]: { $in: filter[field] },
+            },
+        });
+    });
     // Stage 7: Filter by acceptance status
     // Only applies filter if acceptance_status is provided and doesn't include 'none'
     if (filter.acceptance_status && filter.acceptance_status.length > 0 && !filter.acceptance_status.includes('none')) {

package/dist/{src/interfaces → interfaces}/rides/ride-acceptances.d.ts

@@ -1,4 +1,4 @@
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { CreateRideAcceptanceDto, RideAcceptance, UpdateRideAcceptanceDto } from '@tmlmobilidade/types';
 import { IndexDescription, InsertOneOptions, UpdateOptions } from 'mongodb';
 import { z } from 'zod';

package/dist/{src/interfaces → interfaces}/rides/ride-acceptances.js

@@ -1,8 +1,9 @@
 /* * */
-import { MongoCollectionClass } from '../../mongo-collection.js';
-import { HttpException, HttpStatus } from '@tmlmobilidade/lib';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { HttpException, HttpStatus } from '@tmlmobilidade/consts';
+import { Dates } from '@tmlmobilidade/dates';
 import { RideAcceptanceSchema, UpdateRideAcceptanceSchema } from '@tmlmobilidade/types';
-import { AsyncSingletonProxy, compareObjects, Dates, flattenObject } from '@tmlmobilidade/utils';
+import { AsyncSingletonProxy, compareObjects, flattenObject } from '@tmlmobilidade/utils';
 /* * */
 class RideAcceptanceClass extends MongoCollectionClass {
     static _instance;