@tmlmobilidade/interfaces 20251031.1051.3 → 20251202.1817.5

package/dist/{src/interfaces → interfaces}/file-exports/file-exports.js

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* * */
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { FileExportSchema, UpdateFileExportSchema } from '@tmlmobilidade/types';
 import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
 /* * */
@@ -33,7 +33,7 @@ class FileExportsClass extends MongoCollectionClass {
         ];
     }
     getCollectionName() {
-        return 'file_exports';
+        return 'exports';
     }
     getEnvName() {
         return 'DATABASE_URI';

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

@@ -1,4 +1,4 @@
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { CreateFileDto, File, UpdateFileDto } from '@tmlmobilidade/types';
 import { DeleteOptions, DeleteResult, IndexDescription, InsertOneOptions, WithId } from 'mongodb';
 import { Readable } from 'node:stream';

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

@@ -1,11 +1,11 @@
 /* * */
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { StorageFactory } from '../../providers/index.js';
-import { HttpException, HttpStatus } from '@tmlmobilidade/lib';
+import { HttpException, HttpStatus } from '@tmlmobilidade/consts';
+import { Files } from '@tmlmobilidade/files';
+import { generateRandomString } from '@tmlmobilidade/strings';
 import { CreateFileSchema, FileSchema, UpdateFileSchema } from '@tmlmobilidade/types';
 import { AsyncSingletonProxy, convertObject } from '@tmlmobilidade/utils';
-import { generateRandomString } from '@tmlmobilidade/utils';
-import { Files } from '@tmlmobilidade/utils';
 /* * */
 class FilesClass extends MongoCollectionClass {
     static _instance;
@@ -15,37 +15,7 @@ class FilesClass extends MongoCollectionClass {
     storageService;
     constructor() {
         super();
-        switch (process.env.TML_INTERFACE_FILES_STORAGE_TYPE) {
-            case 'aws':
-                if (!process.env.AWS_ACCESS_KEY_ID || !process.env.AWS_BUCKET_NAME || !process.env.AWS_SECRET_ACCESS_KEY) {
-                    throw new Error('AWS_ACCESS_KEY_ID, AWS_BUCKET_NAME, and AWS_SECRET_ACCESS_KEY must be set');
-                }
-                this.bucketName = process.env.AWS_BUCKET_NAME;
-                this.storageService = StorageFactory.create({
-                    aws_config: {
-                        access_key_id: process.env.AWS_ACCESS_KEY_ID,
-                        bucket_name: process.env.AWS_BUCKET_NAME,
-                        secret_access_key: process.env.AWS_SECRET_ACCESS_KEY,
-                    },
-                    type: 'aws',
-                });
-                break;
-            case 'cloudflare':
-                if (!process.env.CLOUDFLARE_ACCESS_KEY_ID || !process.env.CLOUDFLARE_BUCKET_NAME || !process.env.CLOUDFLARE_SECRET_ACCESS_KEY) {
-                    throw new Error('CLOUDFLARE_ACCESS_KEY_ID, CLOUDFLARE_BUCKET_NAME, and CLOUDFLARE_SECRET_ACCESS_KEY must be set');
-                }
-                this.bucketName = process.env.CLOUDFLARE_BUCKET_NAME;
-                this.storageService = StorageFactory.create({
-                    cloudflare_config: {
-                        access_key_id: process.env.CLOUDFLARE_ACCESS_KEY_ID,
-                        bucket_name: process.env.CLOUDFLARE_BUCKET_NAME,
-                        endpoint: `https://${process.env.CLOUDFLARE_ACCOUNT_ID}.r2.cloudflarestorage.com`,
-                        region: 'auto',
-                        secret_access_key: process.env.CLOUDFLARE_SECRET_ACCESS_KEY,
-                    },
-                    type: 'cloudflare',
-                });
-                break;
+        switch (process.env.STORAGE_TYPE) {
             case 'oci':
                 if (!process.env.OCI_BUCKET_NAME || !process.env.OCI_FINGERPRINT || !process.env.OCI_NAMESPACE || !process.env.OCI_PRIVATE_KEY || !process.env.OCI_REGION || !process.env.OCI_TENANCY || !process.env.OCI_USER) {
                     throw new Error('OCI_BUCKET_NAME, OCI_FINGERPRINT, OCI_NAMESPACE, OCI_PRIVATE_KEY, OCI_REGION, OCI_TENANCY, and OCI_USER must be set');
@@ -65,7 +35,7 @@ class FilesClass extends MongoCollectionClass {
                 });
                 break;
             default:
-                throw new Error(`Invalid storage type: ${process.env.TML_INTERFACE_FILES_STORAGE_TYPE}`);
+                throw new Error(`Invalid storage type: ${process.env.STORAGE_TYPE}`);
         }
     }
     static async getInstance() {

package/dist/{src/interfaces → interfaces}/gtfs-validations/gtfs-validations.d.ts

@@ -1,4 +1,4 @@
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { CreateGtfsValidationDto, GtfsValidation, UpdateGtfsValidationDto } from '@tmlmobilidade/types';
 import { IndexDescription } from 'mongodb';
 import { z } from 'zod';
@@ -23,7 +23,7 @@ declare class GtfValidationsClass extends MongoCollectionClass<GtfsValidation, C
             __brand: "UnixTimestamp";
         };
         file_id: string;
-        feeder_status: "error" | "waiting" | "processing" | "complete";
+        feeder_status: "waiting" | "processing" | "complete" | "error" | "skipped";
         gtfs_agency: {
             agency_id: string;
             agency_name: string;
@@ -52,10 +52,10 @@ declare class GtfValidationsClass extends MongoCollectionClass<GtfsValidation, C
             messages: {
                 message: string;
                 field: string;
+                validation_id: string;
                 file_name: string;
                 rows: number[];
                 severity: "error" | "warning" | "ignore" | "forbidden";
-                validation_id: string;
             }[];
             total_errors: number;
             total_warnings: number;

package/dist/{src/interfaces → interfaces}/gtfs-validations/gtfs-validations.js

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

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

@@ -8,6 +8,7 @@ export * from './locations/index.js';
 export * from './metrics/index.js';
 export * from './notifications/index.js';
 export * from './organizations/index.js';
+export * from './pcgidb/index.js';
 export * from './plans/index.js';
 export * from './proposed-changes/index.js';
 export * from './rides/index.js';

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

@@ -8,6 +8,7 @@ export * from './locations/index.js';
 export * from './metrics/index.js';
 export * from './notifications/index.js';
 export * from './organizations/index.js';
+export * from './pcgidb/index.js';
 export * from './plans/index.js';
 export * from './proposed-changes/index.js';
 export * from './rides/index.js';

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

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

package/dist/interfaces/locations/index.js

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

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

@@ -1,4 +1,4 @@
-import { Census, District, DistrictDocument, Locality, LocalityDocument, Location, Municipality, MunicipalityDocument, Parish, ParishDocument } from '@tmlmobilidade/types';
+import { type CensusFeature, type District, type Locality, type Location, type Municipality, type Parish } from '@tmlmobilidade/types';
 import { Filter, FindOptions, WithId } from 'mongodb';
 declare class LocationsClass {
     private static _instance;
@@ -6,26 +6,26 @@ declare class LocationsClass {
     private mongoConnector;
     private constructor();
     static getInstance(): Promise<LocationsClass>;
-    countCensus: (filter?: Filter<Census>) => Promise<number>;
+    countCensus: (filter?: Filter<CensusFeature>) => Promise<number>;
     countDistricts: (filter?: Filter<District>) => Promise<number>;
     countLocalities: (filter?: Filter<Locality>) => Promise<number>;
     countMunicipalities: (filter?: Filter<Municipality>) => Promise<number>;
     countParishes: (filter?: Filter<Parish>) => Promise<number>;
-    findCensus: (filter?: Filter<Census>, options?: FindOptions<Census>) => Promise<WithId<Census>[]>;
-    findDistricts: (filter?: Filter<District>, options?: FindOptions<DistrictDocument>) => Promise<District[]>;
-    findLocalities: (filter?: Filter<Locality>, options?: FindOptions<LocalityDocument>) => Promise<Locality[]>;
-    findMunicipalities: (filter?: Filter<Municipality>, options?: FindOptions<MunicipalityDocument>) => Promise<Municipality[]>;
-    findParishes: (filter?: Filter<Parish>, options?: FindOptions<ParishDocument>) => Promise<Parish[]>;
-    findCensusById: (id: string, options?: FindOptions<Census>) => Promise<null | WithId<Census>>;
-    findDistrictById: (id: string, options?: FindOptions<DistrictDocument>) => Promise<District | null>;
-    findLocalityById: (id: string, options?: FindOptions<LocalityDocument>) => Promise<Locality | null>;
-    findMunicipalityById: (id: string, options?: FindOptions<MunicipalityDocument>) => Promise<Municipality | null>;
-    findParishById: (id: string, options?: FindOptions<ParishDocument>) => Promise<null | Parish>;
-    findMunicipalitiesByGeo: (lat: number, lon: number, options?: FindOptions<MunicipalityDocument>) => Promise<Municipality | null>;
-    findParishesByGeo: (lat: number, lon: number, options?: FindOptions<ParishDocument>) => Promise<null | Parish>;
-    findDistrictsByGeo: (lat: number, lon: number, options?: FindOptions<DistrictDocument>) => Promise<District | null>;
-    findLocalitiesByGeo: (lat: number, lon: number, options?: FindOptions<LocalityDocument>) => Promise<Locality | null>;
-    findCensusByGeo: (lat: number, lon: number, options?: FindOptions<Census>) => Promise<null | WithId<Census>>;
+    findCensus: (filter?: Filter<CensusFeature>, options?: FindOptions) => Promise<WithId<CensusFeature>[]>;
+    findDistricts: (filter?: Filter<District>, options?: FindOptions) => Promise<District[]>;
+    findLocalities: (filter?: Filter<Locality>, options?: FindOptions) => Promise<Locality[]>;
+    findMunicipalities: (filter?: Filter<Municipality>, options?: FindOptions) => Promise<Municipality[]>;
+    findParishes: (filter?: Filter<Parish>, options?: FindOptions) => Promise<Parish[]>;
+    findCensusById: (id: string, options?: FindOptions) => Promise<null | WithId<CensusFeature>>;
+    findDistrictById: (id: string, options?: FindOptions) => Promise<District | null>;
+    findLocalityById: (id: string, options?: FindOptions) => Promise<Locality | null>;
+    findMunicipalityById: (id: string, options?: FindOptions) => Promise<Municipality | null>;
+    findParishById: (id: string, options?: FindOptions) => Promise<null | Parish>;
+    findMunicipalitiesByGeo: (lat: number, lon: number, options?: FindOptions) => Promise<Municipality | null>;
+    findParishesByGeo: (lat: number, lon: number, options?: FindOptions) => Promise<null | Parish>;
+    findDistrictsByGeo: (lat: number, lon: number, options?: FindOptions) => Promise<District | null>;
+    findLocalitiesByGeo: (lat: number, lon: number, options?: FindOptions) => Promise<Locality | null>;
+    findCensusByGeo: (lat: number, lon: number, options?: FindOptions) => Promise<null | WithId<CensusFeature>>;
     findLocationByGeo(lat: number, lon: number, { census }?: {
         census?: boolean;
     }): Promise<Location>;

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

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable perfectionist/sort-classes */
-import { MongoConnector } from '@tmlmobilidade/connectors';
-import { HttpException, HttpStatus } from '@tmlmobilidade/lib';
+import { HttpException, HttpStatus } from '@tmlmobilidade/consts';
+import { MongoConnector } from '@tmlmobilidade/mongo';
 import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
 /* * */
 class LocationsClass {
@@ -105,7 +105,7 @@ class LocationsClass {
         const locality = await this.findLocalitiesByGeo(lat, lon, { projection: { _id: 1, properties: 1 } });
         const _census = census ? await this.findCensusByGeo(lat, lon, { projection: { _id: 1, properties: 1 } }) : undefined;
         return {
-            census: _census,
+            census: { ..._census.properties, _id: _census._id },
             district: district,
             latitude: lat,
             locality: locality,

package/dist/interfaces/locations/municipalities.d.ts

@@ -0,0 +1,13 @@
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { type Municipality } from '@tmlmobilidade/types';
+import { type IndexDescription } from 'mongodb';
+declare class MunicipalitiesClass extends MongoCollectionClass<Municipality, Municipality, Municipality> {
+    private static _instance;
+    private constructor();
+    static getInstance(): Promise<MunicipalitiesClass>;
+    protected getCollectionIndexes(): IndexDescription[];
+    protected getCollectionName(): string;
+    protected getEnvName(): string;
+}
+export declare const municipalities: MunicipalitiesClass;
+export {};

package/dist/interfaces/locations/municipalities.js

@@ -0,0 +1,29 @@
+/* * */
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
+/* * */
+class MunicipalitiesClass extends MongoCollectionClass {
+    static _instance;
+    constructor() {
+        super();
+    }
+    static async getInstance() {
+        if (!MunicipalitiesClass._instance) {
+            const instance = new MunicipalitiesClass();
+            await instance.connect();
+            MunicipalitiesClass._instance = instance;
+        }
+        return MunicipalitiesClass._instance;
+    }
+    getCollectionIndexes() {
+        return [];
+    }
+    getCollectionName() {
+        return 'municipalities';
+    }
+    getEnvName() {
+        return 'DATABASE_URI';
+    }
+}
+/* * */
+export const municipalities = AsyncSingletonProxy(MunicipalitiesClass);

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

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

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

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

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

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

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

@@ -1,11 +1,11 @@
 /* * */
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { roles } from '../auth/roles.js';
+import { users } from '../auth/users.js';
+import { getAppConfig } from '@tmlmobilidade/consts';
 import { sendNotificationEmail } from '@tmlmobilidade/emails';
-import { getAppConfig } from '@tmlmobilidade/lib';
 import { NotificationSchema, UpdateNotificationSchema } from '@tmlmobilidade/types';
 import { AsyncSingletonProxy, mergeObjects } from '@tmlmobilidade/utils';
-import { roles } from '../auth/roles.js';
-import { users } from '../auth/users.js';
 /* * */
 class NotificationsClass extends MongoCollectionClass {
     static _instance;
@@ -107,7 +107,7 @@ class NotificationsClass extends MongoCollectionClass {
      */
     getNotificationPermission(permissions, topic) {
         const permission = permissions.get(`notifications:${topic}`);
-        return permission?.resource?.send_mail ?? false;
+        return permission['resource']?.send_mail ?? false;
     }
 }
 export const notifications = AsyncSingletonProxy(NotificationsClass);

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

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

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

@@ -1,11 +1,11 @@
 /* * */
-import { MongoCollectionClass } from '../../mongo-collection.js';
-import { OrganizationSchema, UpdateOrganizationSchema } from '@tmlmobilidade/types';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { CreateOrganizationSchema, OrganizationSchema, UpdateOrganizationSchema } from '@tmlmobilidade/types';
 import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
 /* * */
 class OrganizationsClass extends MongoCollectionClass {
     static _instance;
-    createSchema = OrganizationSchema;
+    createSchema = CreateOrganizationSchema;
     updateSchema = UpdateOrganizationSchema;
     constructor() {
         super();

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

@@ -0,0 +1,3 @@
+export * from './pcgidb-legacy.js';
+export * from './pcgidb-ticketing.js';
+export * from './pcgidb-validations.js';

package/dist/interfaces/pcgidb/index.js

@@ -0,0 +1,3 @@
+export * from './pcgidb-legacy.js';
+export * from './pcgidb-ticketing.js';
+export * from './pcgidb-validations.js';

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

@@ -0,0 +1,19 @@
+import { type Collection } from 'mongodb';
+declare class PCGIDBLegacyClass {
+    LocationEntity: Collection;
+    SalesEntity: Collection;
+    ValidationEntity: Collection;
+    VehicleEvents: 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.
+     */
+    getPcgidbLegacyConnectionString(): Promise<string>;
+}
+export declare const pcgidbLegacy: PCGIDBLegacyClass;
+export {};

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

@@ -0,0 +1,133 @@
+/* * */
+import { Logger } from '@tmlmobilidade/logger';
+import { MongoConnector } from '@tmlmobilidade/mongo';
+import { SshTunnelService } from '@tmlmobilidade/ssh';
+/* * */
+let GLOBAL_PCGIDB_TUNNEL_INSTANCE;
+/* * */
+class PCGIDBLegacyClass {
+    //
+    LocationEntity;
+    SalesEntity;
+    ValidationEntity;
+    VehicleEvents;
+    /**
+     * Establishes a connection to the Mongo database and initializes the collection.
+     * @throws If connection fails.
+     */
+    async connect() {
+        //
+        //
+        // Setup SSH Tunnel, if required
+        const pcgidbLegacyConnectionString = await this.getPcgidbLegacyConnectionString();
+        //
+        // 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 Legacy...');
+        try {
+            // Connect to the MongoDB database
+            const mongoConnector = new MongoConnector(pcgidbLegacyConnectionString, mongoClientOptions);
+            await mongoConnector.connect();
+            // Setup collections
+            this.LocationEntity = mongoConnector.client.db('LocationManagement').collection('locationEntity');
+            this.SalesEntity = mongoConnector.client.db('SalesManagement').collection('salesEntity');
+            this.ValidationEntity = mongoConnector.client.db('ValidationsManagement').collection('validationEntity');
+            this.VehicleEvents = mongoConnector.client.db('CoreManagement').collection('VehicleEvents');
+            // Log success message
+            Logger.success('Connected to PCGIDB Legacy successfully.');
+        }
+        catch (error) {
+            throw new Error('Error connecting to PCGIDB Legacy:', { 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 getPcgidbLegacyConnectionString() {
+        //
+        //
+        // Check if the required PCGIDB environment variables are set.
+        if (!process.env.PCGIDB_LEGACY_USER || !process.env.PCGIDB_LEGACY_PASSWORD) {
+            throw new Error('Missing PCGIDB_LEGACY_USER or PCGIDB_LEGACY_PASSWORD environment variable.');
+        }
+        if (!process.env.PCGIDB_LEGACY_ADDRESS || !process.env.PCGIDB_LEGACY_PORT) {
+            throw new Error('Missing PCGIDB_LEGACY_ADDRESS or PCGIDB_LEGACY_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_LEGACY_USER}:${process.env.PCGIDB_LEGACY_PASSWORD}@${process.env.PCGIDB_LEGACY_ADDRESS}:${process.env.PCGIDB_LEGACY_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_LEGACY_ADDRESS || !process.env.PCGIDB_LEGACY_PORT) {
+            throw new Error('Missing PCGIDB_LEGACY_ADDRESS or PCGIDB_LEGACY_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_LEGACY_ADDRESS,
+                dstPort: Number(process.env.PCGIDB_LEGACY_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 Legacy...');
+        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 Legacy.');
+        }
+        return `mongodb://${process.env.PCGIDB_LEGACY_USER}:${process.env.PCGIDB_LEGACY_PASSWORD}@localhost:${localAddress.port}/`;
+        //
+    }
+}
+/* * */
+export const pcgidbLegacy = new PCGIDBLegacyClass();

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

@@ -0,0 +1,16 @@
+import { type Collection } from 'mongodb';
+declare class PCGIDBTicketingClass {
+    SalesEntity: 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.
+     */
+    getPcgidbTicketingConnectionString(): Promise<string>;
+}
+export declare const pcgidbTicketing: PCGIDBTicketingClass;
+export {};

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

@@ -0,0 +1,127 @@
+/* * */
+import { Logger } from '@tmlmobilidade/logger';
+import { MongoConnector } from '@tmlmobilidade/mongo';
+import { SshTunnelService } from '@tmlmobilidade/ssh';
+/* * */
+let GLOBAL_PCGIDB_TUNNEL_INSTANCE;
+/* * */
+class PCGIDBTicketingClass {
+    //
+    SalesEntity;
+    /**
+     * Establishes a connection to the Mongo database and initializes the collection.
+     * @throws If connection fails.
+     */
+    async connect() {
+        //
+        //
+        // Setup SSH Tunnel, if required
+        const pcgidbTicketingConnectionString = await this.getPcgidbTicketingConnectionString();
+        //
+        // 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 Ticketing...');
+        try {
+            // Connect to the MongoDB database
+            const mongoConnector = new MongoConnector(pcgidbTicketingConnectionString, mongoClientOptions);
+            await mongoConnector.connect();
+            // Setup collections
+            this.SalesEntity = mongoConnector.client.db('SalesManagement').collection('salesEntity');
+            // Log success message
+            Logger.success('Connected to PCGIDB Ticketing successfully.');
+        }
+        catch (error) {
+            throw new Error('Error connecting to PCGIDB Ticketing:', { 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 getPcgidbTicketingConnectionString() {
+        //
+        //
+        // Check if the required PCGIDB environment variables are set.
+        if (!process.env.PCGIDB_TICKETING_USER || !process.env.PCGIDB_TICKETING_PASSWORD) {
+            throw new Error('Missing PCGIDB_TICKETING_USER or PCGIDB_TICKETING_PASSWORD environment variable.');
+        }
+        if (!process.env.PCGIDB_TICKETING_ADDRESS || !process.env.PCGIDB_TICKETING_PORT) {
+            throw new Error('Missing PCGIDB_TICKETING_ADDRESS or PCGIDB_TICKETING_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_TICKETING_USER}:${process.env.PCGIDB_TICKETING_PASSWORD}@${process.env.PCGIDB_TICKETING_ADDRESS}:${process.env.PCGIDB_TICKETING_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_TICKETING_ADDRESS || !process.env.PCGIDB_TICKETING_PORT) {
+            throw new Error('Missing PCGIDB_TICKETING_ADDRESS or PCGIDB_TICKETING_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_TICKETING_ADDRESS,
+                dstPort: Number(process.env.PCGIDB_TICKETING_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 Ticketing...');
+        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 Ticketing.');
+        }
+        return `mongodb://${process.env.PCGIDB_TICKETING_USER}:${process.env.PCGIDB_TICKETING_PASSWORD}@localhost:${localAddress.port}/`;
+        //
+    }
+}
+/* * */
+export const pcgidbTicketing = new PCGIDBTicketingClass();