@tmlmobilidade/interfaces 20251103.1255.55 → 20251202.1821.43

package/dist/interfaces/auth/users.d.ts

@@ -0,0 +1,522 @@
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { type CreateUserDto, type UpdateUserDto, type User } from '@tmlmobilidade/types';
+import { type Filter, type FindOptions, type IndexDescription } from 'mongodb';
+import { z } from 'zod';
+declare class UsersClass extends MongoCollectionClass<User, CreateUserDto, UpdateUserDto> {
+    private static _instance;
+    protected createSchema: z.ZodSchema;
+    protected updateSchema: z.ZodSchema;
+    private constructor();
+    static getInstance(): Promise<UsersClass>;
+    /**
+     * Finds a user document by its email.
+     * @param email The email of the user to find.
+     * @param includePasswordHash - Whether to include the password hash in the result.
+     * @returns A promise that resolves to the matching user document or null if not found.
+     */
+    findByEmail(email: string, includePasswordHash?: boolean): Promise<{
+        password_hash: any;
+        permissions: ({
+            scope: "agencies";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+        } | {
+            scope: "alerts_scheduled";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+        } | {
+            scope: "alerts_realtime";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "rides";
+            action: "acceptance_change_status" | "acceptance_justify" | "acceptance_lock" | "acceptance_read" | "analsys_lock" | "analysis_lock" | "analysis_read" | "analysis_reprocess" | "analysis_update" | "audit_lock" | "audit_read" | "audit_update";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "sams";
+            action: "read";
+        } | {
+            scope: "gtfs_validations";
+            action: "create" | "read" | "request_approval";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "home";
+            action: "read_links" | "read_wiki";
+        } | {
+            scope: "organizations";
+            action: "create" | "update" | "delete" | "read";
+        } | {
+            scope: "performance";
+            action: "read";
+        } | {
+            scope: "plans";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock" | "read_controller" | "read_pcgi_legacy" | "update_controller" | "update_feed_info_dates" | "update_gtfs_plan" | "update_pcgi_legacy";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "roles";
+            action: "create" | "update" | "delete" | "read";
+        } | {
+            scope: "stops";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+            resources: {
+                municipality_ids: string[];
+                agency_ids: string[];
+            };
+        } | {
+            scope: "users";
+            action: "create" | "update" | "delete" | "read";
+        })[];
+        created_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        created_by?: string | undefined;
+        updated_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        updated_by?: string | undefined;
+        email: string;
+        email_verified: import("@tmlmobilidade/types").UnixTimestamp | null;
+        first_name: string;
+        last_name: string;
+        organization_id: string | null;
+        phone: string | null;
+        preferences: Record<string, Record<string, string | number | boolean | string[] | number[]>> | null;
+        role_ids: string[];
+        session_ids: string[];
+        verification_token_ids: string[];
+        _id: string;
+    }>;
+    /**
+     * Finds a user document by its ID.
+     * @param id The ID of the user document to find
+     * @param includePasswordHash Whether to include the password hash in the result
+     * @returns A promise that resolves to the matching user document or null if not found
+     */
+    findById(id: string, options?: FindOptions, includePasswordHash?: boolean): Promise<{
+        password_hash: any;
+        permissions: ({
+            scope: "agencies";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+        } | {
+            scope: "alerts_scheduled";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+        } | {
+            scope: "alerts_realtime";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "rides";
+            action: "acceptance_change_status" | "acceptance_justify" | "acceptance_lock" | "acceptance_read" | "analsys_lock" | "analysis_lock" | "analysis_read" | "analysis_reprocess" | "analysis_update" | "audit_lock" | "audit_read" | "audit_update";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "sams";
+            action: "read";
+        } | {
+            scope: "gtfs_validations";
+            action: "create" | "read" | "request_approval";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "home";
+            action: "read_links" | "read_wiki";
+        } | {
+            scope: "organizations";
+            action: "create" | "update" | "delete" | "read";
+        } | {
+            scope: "performance";
+            action: "read";
+        } | {
+            scope: "plans";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock" | "read_controller" | "read_pcgi_legacy" | "update_controller" | "update_feed_info_dates" | "update_gtfs_plan" | "update_pcgi_legacy";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "roles";
+            action: "create" | "update" | "delete" | "read";
+        } | {
+            scope: "stops";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+            resources: {
+                municipality_ids: string[];
+                agency_ids: string[];
+            };
+        } | {
+            scope: "users";
+            action: "create" | "update" | "delete" | "read";
+        })[];
+        created_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        created_by?: string | undefined;
+        updated_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        updated_by?: string | undefined;
+        email: string;
+        email_verified: import("@tmlmobilidade/types").UnixTimestamp | null;
+        first_name: string;
+        last_name: string;
+        organization_id: string | null;
+        phone: string | null;
+        preferences: Record<string, Record<string, string | number | boolean | string[] | number[]>> | null;
+        role_ids: string[];
+        session_ids: string[];
+        verification_token_ids: string[];
+        _id: string;
+    }>;
+    /**
+     * Finds users by their organization code.
+     * @param code The code of the organization to find users for.
+     * @param includePasswordHash Whether to include the password hash in the result.
+     * @returns A promise that resolves to the matching user documents or null if not found.
+     */
+    findByOrganization(id: string, includePasswordHash?: boolean): Promise<{
+        password_hash: any;
+        permissions: ({
+            scope: "agencies";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+        } | {
+            scope: "alerts_scheduled";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+        } | {
+            scope: "alerts_realtime";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "rides";
+            action: "acceptance_change_status" | "acceptance_justify" | "acceptance_lock" | "acceptance_read" | "analsys_lock" | "analysis_lock" | "analysis_read" | "analysis_reprocess" | "analysis_update" | "audit_lock" | "audit_read" | "audit_update";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "sams";
+            action: "read";
+        } | {
+            scope: "gtfs_validations";
+            action: "create" | "read" | "request_approval";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "home";
+            action: "read_links" | "read_wiki";
+        } | {
+            scope: "organizations";
+            action: "create" | "update" | "delete" | "read";
+        } | {
+            scope: "performance";
+            action: "read";
+        } | {
+            scope: "plans";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock" | "read_controller" | "read_pcgi_legacy" | "update_controller" | "update_feed_info_dates" | "update_gtfs_plan" | "update_pcgi_legacy";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "roles";
+            action: "create" | "update" | "delete" | "read";
+        } | {
+            scope: "stops";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+            resources: {
+                municipality_ids: string[];
+                agency_ids: string[];
+            };
+        } | {
+            scope: "users";
+            action: "create" | "update" | "delete" | "read";
+        })[];
+        created_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        created_by?: string | undefined;
+        updated_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        updated_by?: string | undefined;
+        email: string;
+        email_verified: import("@tmlmobilidade/types").UnixTimestamp | null;
+        first_name: string;
+        last_name: string;
+        organization_id: string | null;
+        phone: string | null;
+        preferences: Record<string, Record<string, string | number | boolean | string[] | number[]>> | null;
+        role_ids: string[];
+        session_ids: string[];
+        verification_token_ids: string[];
+        _id: string;
+    }[]>;
+    /**
+     * Finds a user by their role.
+     * @param role The role of the user to find.
+     * @returns A promise that resolves to the matching user document or null if not found.
+     */
+    findByRole(role: string, includePasswordHash?: boolean): Promise<{
+        password_hash: any;
+        permissions: ({
+            scope: "agencies";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+        } | {
+            scope: "alerts_scheduled";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+        } | {
+            scope: "alerts_realtime";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "rides";
+            action: "acceptance_change_status" | "acceptance_justify" | "acceptance_lock" | "acceptance_read" | "analsys_lock" | "analysis_lock" | "analysis_read" | "analysis_reprocess" | "analysis_update" | "audit_lock" | "audit_read" | "audit_update";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "sams";
+            action: "read";
+        } | {
+            scope: "gtfs_validations";
+            action: "create" | "read" | "request_approval";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "home";
+            action: "read_links" | "read_wiki";
+        } | {
+            scope: "organizations";
+            action: "create" | "update" | "delete" | "read";
+        } | {
+            scope: "performance";
+            action: "read";
+        } | {
+            scope: "plans";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock" | "read_controller" | "read_pcgi_legacy" | "update_controller" | "update_feed_info_dates" | "update_gtfs_plan" | "update_pcgi_legacy";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "roles";
+            action: "create" | "update" | "delete" | "read";
+        } | {
+            scope: "stops";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+            resources: {
+                municipality_ids: string[];
+                agency_ids: string[];
+            };
+        } | {
+            scope: "users";
+            action: "create" | "update" | "delete" | "read";
+        })[];
+        created_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        created_by?: string | undefined;
+        updated_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        updated_by?: string | undefined;
+        email: string;
+        email_verified: import("@tmlmobilidade/types").UnixTimestamp | null;
+        first_name: string;
+        last_name: string;
+        organization_id: string | null;
+        phone: string | null;
+        preferences: Record<string, Record<string, string | number | boolean | string[] | number[]>> | null;
+        role_ids: string[];
+        session_ids: string[];
+        verification_token_ids: string[];
+        _id: string;
+    }[]>;
+    /**
+     * Finds multiple documents matching the filter criteria
+     * with optional pagination and sorting.
+     * @param filter (Optional) filter criteria to match documents.
+     * @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 documents.
+     */
+    findMany(filter?: Filter<User>, options?: FindOptions): Promise<{
+        password_hash: any;
+        permissions: ({
+            scope: "agencies";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+        } | {
+            scope: "alerts_scheduled";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+        } | {
+            scope: "alerts_realtime";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "rides";
+            action: "acceptance_change_status" | "acceptance_justify" | "acceptance_lock" | "acceptance_read" | "analsys_lock" | "analysis_lock" | "analysis_read" | "analysis_reprocess" | "analysis_update" | "audit_lock" | "audit_read" | "audit_update";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "sams";
+            action: "read";
+        } | {
+            scope: "gtfs_validations";
+            action: "create" | "read" | "request_approval";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "home";
+            action: "read_links" | "read_wiki";
+        } | {
+            scope: "organizations";
+            action: "create" | "update" | "delete" | "read";
+        } | {
+            scope: "performance";
+            action: "read";
+        } | {
+            scope: "plans";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock" | "read_controller" | "read_pcgi_legacy" | "update_controller" | "update_feed_info_dates" | "update_gtfs_plan" | "update_pcgi_legacy";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "roles";
+            action: "create" | "update" | "delete" | "read";
+        } | {
+            scope: "stops";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+            resources: {
+                municipality_ids: string[];
+                agency_ids: string[];
+            };
+        } | {
+            scope: "users";
+            action: "create" | "update" | "delete" | "read";
+        })[];
+        created_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        created_by?: string | undefined;
+        updated_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        updated_by?: string | undefined;
+        email: string;
+        email_verified: import("@tmlmobilidade/types").UnixTimestamp | null;
+        first_name: string;
+        last_name: string;
+        organization_id: string | null;
+        phone: string | null;
+        preferences: Record<string, Record<string, string | number | boolean | string[] | number[]>> | null;
+        role_ids: string[];
+        session_ids: string[];
+        verification_token_ids: string[];
+        _id: string;
+    }[]>;
+    /**
+     * Finds a single document matching the filter criteria.
+     * @param filter Filter criteria to match the document.
+     * @returns A promise that resolves to the matching document or null if not found.
+     */
+    findOne(filter: Filter<User>): Promise<{
+        password_hash: any;
+        permissions: ({
+            scope: "agencies";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+        } | {
+            scope: "alerts_scheduled";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+        } | {
+            scope: "alerts_realtime";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "rides";
+            action: "acceptance_change_status" | "acceptance_justify" | "acceptance_lock" | "acceptance_read" | "analsys_lock" | "analysis_lock" | "analysis_read" | "analysis_reprocess" | "analysis_update" | "audit_lock" | "audit_read" | "audit_update";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "sams";
+            action: "read";
+        } | {
+            scope: "gtfs_validations";
+            action: "create" | "read" | "request_approval";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "home";
+            action: "read_links" | "read_wiki";
+        } | {
+            scope: "organizations";
+            action: "create" | "update" | "delete" | "read";
+        } | {
+            scope: "performance";
+            action: "read";
+        } | {
+            scope: "plans";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock" | "read_controller" | "read_pcgi_legacy" | "update_controller" | "update_feed_info_dates" | "update_gtfs_plan" | "update_pcgi_legacy";
+            resources: {
+                agency_ids: string[];
+            };
+        } | {
+            scope: "roles";
+            action: "create" | "update" | "delete" | "read";
+        } | {
+            scope: "stops";
+            action: "create" | "update" | "delete" | "read" | "toggle_lock";
+            resources: {
+                municipality_ids: string[];
+                agency_ids: string[];
+            };
+        } | {
+            scope: "users";
+            action: "create" | "update" | "delete" | "read";
+        })[];
+        created_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        created_by?: string | undefined;
+        updated_at: number & {
+            __brand: "UnixTimestamp";
+        };
+        updated_by?: string | undefined;
+        email: string;
+        email_verified: import("@tmlmobilidade/types").UnixTimestamp | null;
+        first_name: string;
+        last_name: string;
+        organization_id: string | null;
+        phone: string | null;
+        preferences: Record<string, Record<string, string | number | boolean | string[] | number[]>> | null;
+        role_ids: string[];
+        session_ids: string[];
+        verification_token_ids: string[];
+        _id: string;
+    }>;
+    protected getCollectionIndexes(): IndexDescription[];
+    protected getCollectionName(): string;
+    protected getEnvName(): string;
+    private sanitizeUser;
+}
+export declare const users: UsersClass;
+export {};

package/dist/interfaces/auth/users.js

@@ -0,0 +1,118 @@
+/* * */
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
+import { PermissionCatalog, UpdateUserSchema, UserSchema } from '@tmlmobilidade/types';
+import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
+/* * */
+class UsersClass extends MongoCollectionClass {
+    static _instance;
+    createSchema = UserSchema;
+    updateSchema = UpdateUserSchema;
+    constructor() {
+        super();
+    }
+    static async getInstance() {
+        if (!UsersClass._instance) {
+            const instance = new UsersClass();
+            await instance.connect();
+            UsersClass._instance = instance;
+        }
+        return UsersClass._instance;
+    }
+    /**
+     * Finds a user document by its email.
+     * @param email The email of the user to find.
+     * @param includePasswordHash - Whether to include the password hash in the result.
+     * @returns A promise that resolves to the matching user document or null if not found.
+     */
+    async findByEmail(email, includePasswordHash = false) {
+        const foundUser = await this.mongoCollection.findOne({ email: { $eq: email } });
+        if (!foundUser)
+            return null;
+        if (includePasswordHash)
+            return foundUser;
+        return this.sanitizeUser(foundUser);
+    }
+    /**
+     * Finds a user document by its ID.
+     * @param id The ID of the user document to find
+     * @param includePasswordHash Whether to include the password hash in the result
+     * @returns A promise that resolves to the matching user document or null if not found
+     */
+    async findById(id, options, includePasswordHash = false) {
+        const foundUser = await this.mongoCollection.findOne({ _id: id }, options);
+        if (!foundUser)
+            return null;
+        if (includePasswordHash)
+            return foundUser;
+        return this.sanitizeUser(foundUser);
+    }
+    /**
+     * Finds users by their organization code.
+     * @param code The code of the organization to find users for.
+     * @param includePasswordHash Whether to include the password hash in the result.
+     * @returns A promise that resolves to the matching user documents or null if not found.
+     */
+    async findByOrganization(id, includePasswordHash = false) {
+        const foundUsers = await this.mongoCollection.find({ organization_id: { $in: [id] } }).toArray();
+        if (includePasswordHash)
+            return foundUsers;
+        return foundUsers.map(item => this.sanitizeUser(item));
+    }
+    /**
+     * Finds a user by their role.
+     * @param role The role of the user to find.
+     * @returns A promise that resolves to the matching user document or null if not found.
+     */
+    async findByRole(role, includePasswordHash = false) {
+        const foundUsers = await this.mongoCollection.find({ role_ids: { $in: [role] } }).toArray();
+        if (includePasswordHash)
+            return foundUsers;
+        return foundUsers.map(item => this.sanitizeUser(item));
+    }
+    /**
+     * Finds multiple documents matching the filter criteria
+     * with optional pagination and sorting.
+     * @param filter (Optional) filter criteria to match documents.
+     * @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 documents.
+     */
+    async findMany(filter, options) {
+        const foundUsers = await this.mongoCollection.find(filter ?? {}, options).toArray();
+        return foundUsers.map(item => this.sanitizeUser(item));
+    }
+    /**
+     * Finds a single document matching the filter criteria.
+     * @param filter Filter criteria to match the document.
+     * @returns A promise that resolves to the matching document or null if not found.
+     */
+    async findOne(filter) {
+        const foundUser = await this.mongoCollection.findOne(filter);
+        if (!foundUser)
+            return null;
+        return this.sanitizeUser(foundUser);
+    }
+    getCollectionIndexes() {
+        return [
+            { background: true, key: { email: 1 }, unique: true },
+            { background: true, key: { 'profile.first_name': 1, 'profile.last_name': 1 } },
+            { background: true, key: { session_ids: 1 } },
+            { background: true, key: { role_ids: 1 } },
+        ];
+    }
+    getCollectionName() {
+        return 'users';
+    }
+    getEnvName() {
+        return 'DATABASE_URI';
+    }
+    sanitizeUser(user) {
+        return {
+            ...user,
+            password_hash: null,
+            permissions: PermissionCatalog.sanitize(user.permissions),
+        };
+    }
+}
+export const users = AsyncSingletonProxy(UsersClass);

package/dist/{src/interfaces → interfaces}/auth/verification-tokens.d.ts

@@ -1,4 +1,4 @@
-import { MongoCollectionClass } from '../../mongo-collection.js';
+import { MongoCollectionClass } from '../../common/mongo-collection.js';
 import { CreateVerificationTokenDto, UpdateVerificationTokenDto, VerificationToken } from '@tmlmobilidade/types';
 import { IndexDescription } from 'mongodb';
 import { z } from 'zod';
@@ -29,7 +29,7 @@ declare class VerificationTokensClass extends MongoCollectionClass<VerificationT
         user_id: string;
         created_by?: string | undefined;
         updated_by?: string | undefined;
-    }> | null>;
+    }>>;
     protected getCollectionIndexes(): IndexDescription[];
     protected getCollectionName(): string;
     protected getEnvName(): string;

package/dist/{src/interfaces → interfaces}/auth/verification-tokens.js

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

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

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