@tmlmobilidade/interfaces/dist/interfaces/stops/stops.js

This package provides SDK-style connectors for interacting with databases (e.g., stops, plans, rides, alerts) and external providers (e.g., authentication, storage). It simplifies data access and integration across projects.

/* * */
import { MongoCollectionClass } from '../../common/mongo-collection.js';
import { CreateStopSchema, UpdateStopSchema } from '@tmlmobilidade/types';
import { asyncSingletonProxy } from '@tmlmobilidade/utils';
/* * */
class StopsClass extends MongoCollectionClass {
    static _instance;
    createSchema = CreateStopSchema;
    updateSchema = UpdateStopSchema;
    constructor() {
        super();
    }
    static async getInstance() {
        if (!StopsClass._instance) {
            const instance = new StopsClass();
            await instance.connect();
            StopsClass._instance = instance;
        }
        return StopsClass._instance;
    }
    /**
     * Override deleteById to prevent actual deletion of stop documents.
     * Stops cannot be deleted, only archived.
     * @param filter The filter used to select the document to "delete".
     * @returns A promise that rejects with an error indicating deletion is not allowed.
     */
    async deleteById() {
        throw new Error('Method not implemented. Stops cannot be deleted, only archived.');
    }
    /**
     * Override deleteOne to prevent actual deletion of stop documents.
     * Stops cannot be deleted, only archived.
     * @param filter The filter used to select the document to "delete".
     * @returns A promise that rejects with an error indicating deletion is not allowed.
     */
    async deleteOne() {
        throw new Error('Method not implemented. Stops cannot be deleted, only archived.');
    }
    /**
     * Override deleteMany to prevent actual deletion of stop documents.
     * Stops cannot be deleted, only archived.
     * @param filter The filter used to select the documents to "delete".
     * @returns A promise that rejects with an error indicating deletion is not allowed.
     */
    async deleteMany() {
        throw new Error('Method not implemented. Stops cannot be deleted, only archived.');
    }
    /**
     * Finds stop documents by municipality ID with optional pagination and sorting.
     * @param id The municipality ID to search for
     * @param perPage Optional number of documents per page for pagination
     * @param page Optional page number for pagination
     * @param sort Optional sort specification
     * @returns A promise that resolves to an array of matching stop documents
     */
    async findByMunicipalityId(id, perPage, page, sort) {
        const query = this.mongoCollection.find({ municipality_id: id });
        if (perPage)
            query.limit(perPage);
        if (page && perPage)
            query.skip(perPage * (page - 1));
        if (sort)
            query.sort(sort);
        return query.toArray();
    }
    /**
     * Finds multiple stop documents by their IDs.
     * @param ids Array of stop IDs to search for
     * @returns A promise that resolves to an array of matching stop documents
     */
    async findManyByIds(ids) {
        return this.mongoCollection.find({ _id: { $in: ids } }).toArray();
    }
    /**
     * Toogle the delete status of a document by its ID.
     * Stop documents are never truly deleted to preserve
     * data integrity and prevent ID reuse.
     * @param id The ID of the stop document to delete.
     * @param forceValue Optional boolean to explicitly set the deleted status.
     * @returns A promise that resolves to the result of the delete operation.
     */
    async toggleDeleteById(id, forceValue) {
        // Get the current document from the database
        const foundDoc = await this.findById(id);
        if (!foundDoc)
            throw new Error('Stop not found');
        // Determine the new deleted status
        const newDeletedStatus = forceValue !== undefined ? forceValue : !foundDoc.is_deleted;
        // If the document is deleted, we allow the operation even if it's locked
        await this.updateById(id, { is_deleted: newDeletedStatus }, { forceIfLocked: !newDeletedStatus && foundDoc.is_locked });
    }
    getCollectionIndexes() {
        return [
            { background: true, key: { name: 1 } },
        ];
    }
    getCollectionName() {
        return 'stops';
    }
    getEnvName() {
        return 'DATABASE_URI';
    }
}
/* * */
export const stops = asyncSingletonProxy(StopsClass);