@tmlmobilidade/interfaces 20260126.1852.36 → 20260128.2248.28

package/dist/interfaces/dates/annotations.d.ts

@@ -19,6 +19,7 @@ declare class AnnotationsClass extends MongoCollectionClass<Annotation, CreateAn
         created_at: number & {
             __brand: "UnixTimestamp";
         };
+        created_by: string | null;
         is_locked: boolean;
         updated_at: number & {
             __brand: "UnixTimestamp";
@@ -26,7 +27,6 @@ declare class AnnotationsClass extends MongoCollectionClass<Annotation, CreateAn
         title: string;
         agency_ids: string[];
         dates: import("@tmlmobilidade/types").OperationalDate[];
-        created_by?: string | undefined;
         updated_by?: string | undefined;
         description?: string | undefined;
     }>[]>;

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

@@ -1 +1,2 @@
 export * from './annotations.js';
+export * from './periods.js';

package/dist/interfaces/dates/index.js

@@ -1 +1,2 @@
 export * from './annotations.js';
+export * from './periods.js';

package/dist/interfaces/dates/periods.d.ts

@@ -0,0 +1,38 @@
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { type CreatePeriodDto, type Period, type UpdatePeriodDto } from '@tmlmobilidade/types';
+import { IndexDescription } from 'mongodb';
+import { z } from 'zod';
+declare class PeriodsClass extends MongoCollectionClass<Period, CreatePeriodDto, UpdatePeriodDto> {
+    private static _instance;
+    protected createSchema: z.ZodSchema;
+    protected updateSchema: z.ZodSchema;
+    private constructor();
+    static getInstance(): Promise<PeriodsClass>;
+    /**
+     * Finds Period documents by agency ID.
+     *
+     * @param id - The agency ID to search for
+     * @returns A promise that resolves to an array of matching documents
+     */
+    findByAgencyId(id: string): Promise<import("mongodb").WithId<{
+        _id: string;
+        created_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        created_by: string | null;
+        is_locked: boolean;
+        updated_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        name: string;
+        updated_by?: string | undefined;
+        agency_id?: string | undefined;
+        color?: string | undefined;
+        dates?: import("@tmlmobilidade/types").OperationalDate[] | undefined;
+    }>[]>;
+    protected getCollectionIndexes(): IndexDescription[];
+    protected getCollectionName(): string;
+    protected getEnvName(): string;
+}
+export declare const periods: PeriodsClass;
+export {};

package/dist/interfaces/dates/periods.js

@@ -0,0 +1,41 @@
+/* * */
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { PeriodSchema, UpdatePeriodSchema } from '@tmlmobilidade/types';
+import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
+/* * */
+class PeriodsClass extends MongoCollectionClass {
+    static _instance;
+    createSchema = PeriodSchema;
+    updateSchema = UpdatePeriodSchema;
+    constructor() {
+        super();
+    }
+    static async getInstance() {
+        if (!PeriodsClass._instance) {
+            const instance = new PeriodsClass();
+            await instance.connect();
+            PeriodsClass._instance = instance;
+        }
+        return PeriodsClass._instance;
+    }
+    /**
+     * Finds Period documents by agency ID.
+     *
+     * @param id - The agency ID to search for
+     * @returns A promise that resolves to an array of matching documents
+     */
+    async findByAgencyId(id) {
+        return this.mongoCollection.find({ agency_id: id }).toArray();
+    }
+    getCollectionIndexes() {
+        return [];
+    }
+    getCollectionName() {
+        return 'periods';
+    }
+    getEnvName() {
+        return 'DATABASE_URI';
+    }
+}
+/* * */
+export const periods = AsyncSingletonProxy(PeriodsClass);

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

@@ -18,6 +18,7 @@ declare class GtfValidationsClass extends MongoCollectionClass<GtfsValidation, C
         created_at: number & {
             __brand: "UnixTimestamp";
         };
+        created_by: string | null;
         is_locked: boolean;
         updated_at: number & {
             __brand: "UnixTimestamp";
@@ -46,7 +47,6 @@ declare class GtfValidationsClass extends MongoCollectionClass<GtfsValidation, C
             feed_version?: string | null | undefined;
         };
         notification_sent: boolean;
-        created_by?: string | undefined;
         updated_by?: string | undefined;
         summary?: {
             messages: {
@@ -55,7 +55,7 @@ declare class GtfValidationsClass extends MongoCollectionClass<GtfsValidation, C
                 validation_id: string;
                 file_name: string;
                 rows: number[];
-                severity: "error" | "warning" | "ignore" | "forbidden";
+                severity: "error" | "ignore" | "warning" | "forbidden";
             }[];
             total_errors: number;
             total_warnings: number;

package/dist/interfaces/index.d.ts

@@ -8,6 +8,7 @@ export * from './gtfs-validations/index.js';
 export * from './locations/index.js';
 export * from './metrics/index.js';
 export * from './notifications/index.js';
+export * from './offer/index.js';
 export * from './organizations/index.js';
 export * from './pcgidb/index.js';
 export * from './plans/index.js';
@@ -16,5 +17,7 @@ export * from './rides/index.js';
 export * from './sams/index.js';
 export * from './simplified-apex/index.js';
 export * from './stops/index.js';
+export * from './ticketing/index.js';
 export * from './vehicle-events/index.js';
+export * from './vehicles/index.js';
 export * from './zones/index.js';

package/dist/interfaces/index.js

@@ -8,6 +8,7 @@ export * from './gtfs-validations/index.js';
 export * from './locations/index.js';
 export * from './metrics/index.js';
 export * from './notifications/index.js';
+export * from './offer/index.js';
 export * from './organizations/index.js';
 export * from './pcgidb/index.js';
 export * from './plans/index.js';
@@ -16,5 +17,7 @@ export * from './rides/index.js';
 export * from './sams/index.js';
 export * from './simplified-apex/index.js';
 export * from './stops/index.js';
+export * from './ticketing/index.js';
 export * from './vehicle-events/index.js';
+export * from './vehicles/index.js';
 export * from './zones/index.js';

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

@@ -0,0 +1,4 @@
+export * from './lines.js';
+export * from './patterns.js';
+export * from './routes.js';
+export * from './typologies.js';

package/dist/interfaces/offer/index.js

@@ -0,0 +1,4 @@
+export * from './lines.js';
+export * from './patterns.js';
+export * from './routes.js';
+export * from './typologies.js';

package/dist/interfaces/offer/lines.d.ts

@@ -0,0 +1,50 @@
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { type CreateLineDto, type Line, type UpdateLineDto } from '@tmlmobilidade/types';
+import { IndexDescription } from 'mongodb';
+import { z } from 'zod';
+declare class LinesClass extends MongoCollectionClass<Line, CreateLineDto, UpdateLineDto> {
+    private static _instance;
+    protected createSchema: z.ZodSchema;
+    protected updateSchema: z.ZodSchema;
+    private constructor();
+    static getInstance(): Promise<LinesClass>;
+    /**
+     * Finds Line documents by agency IDs.
+     *
+     * @param ids - The agency IDs to search for
+    //  * @returns A promise that resolves to an array of matching documents
+     */
+    findByAgencyIds(ids: string[]): Promise<import("mongodb").WithId<{
+        _id: string;
+        created_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        created_by: string | null;
+        is_locked: boolean;
+        updated_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        code: string;
+        name: string;
+        agency_id: string;
+        interchange: "0" | "1" | "2";
+        is_circular_line: boolean;
+        is_continuous_line: boolean;
+        is_school_line: boolean;
+        onboard_fare_ids: string[] | null;
+        prepaid_fare_id: string | null;
+        transport_type: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "11" | "12";
+        typology: string | null;
+        updated_by?: string | undefined;
+        routes?: {
+            _id: string;
+            code: string;
+            name: string;
+        }[] | undefined;
+    }>[]>;
+    protected getCollectionIndexes(): IndexDescription[];
+    protected getCollectionName(): string;
+    protected getEnvName(): string;
+}
+export declare const lines: LinesClass;
+export {};

package/dist/interfaces/offer/lines.js

@@ -0,0 +1,41 @@
+/* * */
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { CreateLineSchema, UpdateLineSchema } from '@tmlmobilidade/types';
+import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
+/* * */
+class LinesClass extends MongoCollectionClass {
+    static _instance;
+    createSchema = CreateLineSchema;
+    updateSchema = UpdateLineSchema;
+    constructor() {
+        super();
+    }
+    static async getInstance() {
+        if (!LinesClass._instance) {
+            const instance = new LinesClass();
+            await instance.connect();
+            LinesClass._instance = instance;
+        }
+        return LinesClass._instance;
+    }
+    /**
+     * Finds Line documents by agency IDs.
+     *
+     * @param ids - The agency IDs to search for
+    //  * @returns A promise that resolves to an array of matching documents
+     */
+    async findByAgencyIds(ids) {
+        return this.mongoCollection.find({ agency_id: { $in: ids } }).toArray();
+    }
+    getCollectionIndexes() {
+        return [];
+    }
+    getCollectionName() {
+        return 'lines';
+    }
+    getEnvName() {
+        return 'DATABASE_URI';
+    }
+}
+/* * */
+export const lines = AsyncSingletonProxy(LinesClass);

package/dist/interfaces/offer/patterns.d.ts

@@ -0,0 +1,176 @@
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { type CreatePatternDto, type Pattern, type UpdatePatternDto } from '@tmlmobilidade/types';
+import { IndexDescription } from 'mongodb';
+import { z } from 'zod';
+declare class PatternsClass extends MongoCollectionClass<Pattern, CreatePatternDto, UpdatePatternDto> {
+    private static _instance;
+    protected createSchema: z.ZodSchema;
+    protected updateSchema: z.ZodSchema;
+    private constructor();
+    static getInstance(): Promise<PatternsClass>;
+    /**
+     * Finds Pattern documents by line ID.
+     *
+     * @param lineId - The line ID to search for
+     * @returns A promise that resolves to an array of matching documents
+     */
+    findByLineId(lineId: string): Promise<import("mongodb").WithId<{
+        _id: string;
+        created_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        created_by: string | null;
+        is_locked: boolean;
+        updated_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        code: string;
+        line_id: string;
+        headsign: string;
+        route_id: string;
+        destination: string;
+        direction: "0" | "1";
+        origin: string;
+        rules: {
+            operatingMode: import("@tmlmobilidade/types").OPERATING_MODE;
+            timePoints: string[];
+            _id?: string | undefined;
+            name?: string | undefined;
+            periodIds?: string[] | undefined;
+            weekdays?: (1 | 2 | 3 | 5 | 4 | 6 | 7)[] | undefined;
+            holidays?: {
+                mode: "ignore";
+            } | {
+                mode: "all";
+            } | {
+                mode: "specific";
+                ids: string[];
+            } | undefined;
+            events?: string[] | undefined;
+            travelTime?: string | undefined;
+        }[];
+        updated_by?: string | undefined;
+        path?: {
+            _id: string;
+            stop_id: string;
+            allow_drop_off: boolean;
+            allow_pickup: boolean;
+            distance_delta: number | null;
+            timepoint: boolean;
+            zones?: string[] | undefined;
+            stop?: {
+                _id: string;
+                created_at: number & {
+                    __brand: "UnixTimestamp";
+                };
+                created_by: string | null;
+                is_locked: boolean;
+                updated_at: number & {
+                    __brand: "UnixTimestamp";
+                };
+                name: string;
+                short_name: string;
+                latitude: number;
+                longitude: number;
+                comments: ({
+                    created_at: number & {
+                        __brand: "UnixTimestamp";
+                    };
+                    created_by: string | null;
+                    updated_at: number & {
+                        __brand: "UnixTimestamp";
+                    };
+                    message: string;
+                    type: "note";
+                    _id?: string | undefined;
+                    updated_by?: string | undefined;
+                } | {
+                    created_at: number & {
+                        __brand: "UnixTimestamp";
+                    };
+                    created_by: string | null;
+                    updated_at: number & {
+                        __brand: "UnixTimestamp";
+                    };
+                    type: "field_changed";
+                    field: string;
+                    _id?: string | undefined;
+                    updated_by?: string | undefined;
+                    metadata?: Record<string, unknown> | null | undefined;
+                    curr_value?: any;
+                    prev_value?: any;
+                } | {
+                    created_at: number & {
+                        __brand: "UnixTimestamp";
+                    };
+                    created_by: string | null;
+                    updated_at: number & {
+                        __brand: "UnixTimestamp";
+                    };
+                    type: "crud";
+                    action: "create" | "update" | "delete" | "archive" | "restore";
+                    _id?: string | undefined;
+                    updated_by?: string | undefined;
+                })[];
+                has_bench: "unknown" | "available" | "unavailable";
+                has_network_map: "unknown" | "available" | "unavailable";
+                has_schedules: "unknown" | "available" | "unavailable";
+                has_shelter: "unknown" | "available" | "unavailable";
+                has_stop_sign: "unknown" | "available" | "unavailable";
+                municipality_id: string;
+                parish_id: string | null;
+                shelter_code: string | null;
+                shelter_maintainer: string | null;
+                is_deleted: boolean;
+                jurisdiction: "unknown" | "ip" | "municipality" | "other";
+                legacy_id: string | null;
+                lifecycle_status: "draft" | "active" | "inactive" | "provisional" | "seasonal" | "voided";
+                new_name: string | null;
+                tts_name: string;
+                district_id: string;
+                locality_id: string | null;
+                bench_status: "unknown" | "not_applicable" | "missing" | "damaged" | "ok";
+                electricity_status: "unknown" | "available" | "unavailable";
+                pole_status: "unknown" | "not_applicable" | "missing" | "damaged" | "ok";
+                road_type: "unknown" | "complementary_itinerary" | "highway" | "main_itinerary" | "national_road" | "regional_road" | "secondary_road";
+                shelter_frame_size: [number, number] | null;
+                shelter_installation_date: import("@tmlmobilidade/types").UnixTimestamp | null;
+                shelter_make: string | null;
+                shelter_model: string | null;
+                shelter_status: "unknown" | "not_applicable" | "missing" | "damaged" | "ok";
+                last_infrastructure_check: import("@tmlmobilidade/types").UnixTimestamp | null;
+                last_infrastructure_maintenance: import("@tmlmobilidade/types").UnixTimestamp | null;
+                last_schedules_check: import("@tmlmobilidade/types").UnixTimestamp | null;
+                last_schedules_maintenance: import("@tmlmobilidade/types").UnixTimestamp | null;
+                connections: ("ferry" | "light_rail" | "subway" | "train" | "boat" | "airport" | "bike_sharing" | "bike_parking" | "car_parking")[];
+                facilities: ("school" | "fire_station" | "health_clinic" | "historic_building" | "hospital" | "police_station" | "shopping" | "transit_office" | "university" | "beach")[];
+                equipment: ("pip" | "mupi" | "mini_pip")[];
+                has_mupi: "unknown" | "available" | "unavailable";
+                file_ids: string[];
+                image_ids: string[];
+                observations: string | null;
+                updated_by?: string | undefined;
+            } | null | undefined;
+        }[] | undefined;
+        shape?: {
+            geojson: {
+                type: string;
+                geometry: {
+                    type: string;
+                    coordinates: number[][];
+                };
+                properties?: {} | undefined;
+            };
+            extension: number;
+        } | undefined;
+        presets?: {
+            dwell_time: number;
+            velocity: number;
+        } | undefined;
+    }>[]>;
+    protected getCollectionIndexes(): IndexDescription[];
+    protected getCollectionName(): string;
+    protected getEnvName(): string;
+}
+export declare const patterns: PatternsClass;
+export {};

package/dist/interfaces/offer/patterns.js

@@ -0,0 +1,41 @@
+/* * */
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { CreatePatternSchema, UpdatePatternSchema } from '@tmlmobilidade/types';
+import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
+/* * */
+class PatternsClass extends MongoCollectionClass {
+    static _instance;
+    createSchema = CreatePatternSchema;
+    updateSchema = UpdatePatternSchema;
+    constructor() {
+        super();
+    }
+    static async getInstance() {
+        if (!PatternsClass._instance) {
+            const instance = new PatternsClass();
+            await instance.connect();
+            PatternsClass._instance = instance;
+        }
+        return PatternsClass._instance;
+    }
+    /**
+     * Finds Pattern documents by line ID.
+     *
+     * @param lineId - The line ID to search for
+     * @returns A promise that resolves to an array of matching documents
+     */
+    async findByLineId(lineId) {
+        return this.mongoCollection.find({ line_id: lineId }).toArray();
+    }
+    getCollectionIndexes() {
+        return [];
+    }
+    getCollectionName() {
+        return 'patterns';
+    }
+    getEnvName() {
+        return 'DATABASE_URI';
+    }
+}
+/* * */
+export const patterns = AsyncSingletonProxy(PatternsClass);

package/dist/interfaces/offer/routes.d.ts

@@ -0,0 +1,45 @@
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { type CreateRouteDto, type Route, type UpdateRouteDto } from '@tmlmobilidade/types';
+import { IndexDescription } from 'mongodb';
+import { z } from 'zod';
+declare class RoutesClass extends MongoCollectionClass<Route, CreateRouteDto, UpdateRouteDto> {
+    private static _instance;
+    protected createSchema: z.ZodSchema;
+    protected updateSchema: z.ZodSchema;
+    private constructor();
+    static getInstance(): Promise<RoutesClass>;
+    /**
+     * Finds Route documents by line ID.
+     *
+     * @param lineId - The line ID to search for
+     * @returns A promise that resolves to an array of matching documents
+     */
+    findByLineId(lineId: string): Promise<import("mongodb").WithId<{
+        _id: string;
+        created_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        created_by: string | null;
+        is_locked: boolean;
+        updated_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        code: string;
+        name: string;
+        line_id: string;
+        path_type: "0" | "1" | "2";
+        updated_by?: string | undefined;
+        patterns?: {
+            _id: string;
+            code: string;
+            line_id: string;
+            headsign: string;
+            route_id: string;
+        }[] | undefined;
+    }>[]>;
+    protected getCollectionIndexes(): IndexDescription[];
+    protected getCollectionName(): string;
+    protected getEnvName(): string;
+}
+export declare const routes: RoutesClass;
+export {};

package/dist/interfaces/offer/routes.js

@@ -0,0 +1,41 @@
+/* * */
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { CreateRouteSchema, UpdateRouteSchema } from '@tmlmobilidade/types';
+import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
+/* * */
+class RoutesClass extends MongoCollectionClass {
+    static _instance;
+    createSchema = CreateRouteSchema;
+    updateSchema = UpdateRouteSchema;
+    constructor() {
+        super();
+    }
+    static async getInstance() {
+        if (!RoutesClass._instance) {
+            const instance = new RoutesClass();
+            await instance.connect();
+            RoutesClass._instance = instance;
+        }
+        return RoutesClass._instance;
+    }
+    /**
+     * Finds Route documents by line ID.
+     *
+     * @param lineId - The line ID to search for
+     * @returns A promise that resolves to an array of matching documents
+     */
+    async findByLineId(lineId) {
+        return this.mongoCollection.find({ line_id: lineId }).toArray();
+    }
+    getCollectionIndexes() {
+        return [];
+    }
+    getCollectionName() {
+        return 'routes';
+    }
+    getEnvName() {
+        return 'DATABASE_URI';
+    }
+}
+/* * */
+export const routes = AsyncSingletonProxy(RoutesClass);

package/dist/interfaces/offer/typologies.d.ts

@@ -0,0 +1,41 @@
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { type CreateTypologyDto, type Typology, type UpdateTypologyDto } from '@tmlmobilidade/types';
+import { IndexDescription } from 'mongodb';
+import { z } from 'zod';
+declare class TypologiesClass extends MongoCollectionClass<Typology, CreateTypologyDto, UpdateTypologyDto> {
+    private static _instance;
+    protected createSchema: z.ZodSchema;
+    protected updateSchema: z.ZodSchema;
+    private constructor();
+    static getInstance(): Promise<TypologiesClass>;
+    /**
+     * Finds Typology documents by agency IDs.
+     *
+     * @param ids - The agency IDs to search for
+    //  * @returns A promise that resolves to an array of matching documents
+     */
+    findByAgencyIds(ids: string[]): Promise<import("mongodb").WithId<{
+        _id: string;
+        created_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        created_by: string | null;
+        is_locked: boolean;
+        updated_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        code: string;
+        name: string;
+        agency_ids: string[];
+        color: string;
+        default_onboard_fare_ids: string[] | null;
+        default_prepaid_fare_id: string | null;
+        text_color: string;
+        updated_by?: string | undefined;
+    }>[]>;
+    protected getCollectionIndexes(): IndexDescription[];
+    protected getCollectionName(): string;
+    protected getEnvName(): string;
+}
+export declare const typologies: TypologiesClass;
+export {};

package/dist/interfaces/offer/typologies.js

@@ -0,0 +1,41 @@
+/* * */
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { CreateTypologySchema, UpdateTypologySchema } from '@tmlmobilidade/types';
+import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
+/* * */
+class TypologiesClass extends MongoCollectionClass {
+    static _instance;
+    createSchema = CreateTypologySchema;
+    updateSchema = UpdateTypologySchema;
+    constructor() {
+        super();
+    }
+    static async getInstance() {
+        if (!TypologiesClass._instance) {
+            const instance = new TypologiesClass();
+            await instance.connect();
+            TypologiesClass._instance = instance;
+        }
+        return TypologiesClass._instance;
+    }
+    /**
+     * Finds Typology documents by agency IDs.
+     *
+     * @param ids - The agency IDs to search for
+    //  * @returns A promise that resolves to an array of matching documents
+     */
+    async findByAgencyIds(ids) {
+        return this.mongoCollection.find({ agency_ids: { $in: ids } }).toArray();
+    }
+    getCollectionIndexes() {
+        return [];
+    }
+    getCollectionName() {
+        return 'typologies';
+    }
+    getEnvName() {
+        return 'DATABASE_URI';
+    }
+}
+/* * */
+export const typologies = AsyncSingletonProxy(TypologiesClass);

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

@@ -19,6 +19,7 @@ declare class PlansClass extends MongoCollectionClass<Plan, CreatePlanDto, Updat
         created_at: number & {
             __brand: "UnixTimestamp";
         };
+        created_by: string | null;
         is_locked: boolean;
         updated_at: number & {
             __brand: "UnixTimestamp";
@@ -61,7 +62,6 @@ declare class PlansClass extends MongoCollectionClass<Plan, CreatePlanDto, Updat
         pcgi_legacy: {
             operation_plan_id: string | null;
         };
-        created_by?: string | undefined;
         updated_by?: string | undefined;
     }>[]>;
     protected getCollectionIndexes(): IndexDescription[];