@driveup/schema 0.2.6 → 0.2.9

package/lib/user/user.entity.d.ts

@@ -1,17 +1,17 @@
+import { Activity, User } from '@driveup/common';
+import { AccountStatus, Address, Language, Person, SelectedProfile } from '@driveup/shared';
 import { EntityManager } from 'typeorm';
-import { AccountStatus, Language, ProfileType, SelectedProfile } from '@driveup/shared';
-import { User, Activity, Address, Person } from '@driveup/common';
-import { CountryEntity } from '../system/country/country.entity';
+import { AgentEntity } from '../profile/agent/agent.entity';
 import { CompanyEntity } from '../profile/company/company.entity';
-import { InstructorEntity } from '../profile/instructor/instructor.entity';
 import { CompanyInstructorEntity } from '../profile/company/instructor/instructor.entity';
-import { AgentEntity } from '../profile/agent/agent.entity';
+import { InstructorEntity } from '../profile/instructor/instructor.entity';
 import { StudentEntity } from '../profile/student/student.entity';
-import { UserNotificationEntity } from './notification.entity';
+import { CountryEntity } from '../system/country/country.entity';
+import { TrackableEntity } from '../utils/trackable';
+import { UserAlertEntity } from './alert.entity';
 import { UserDeviceEntity } from './device.entity';
+import { UserNotificationEntity } from './notification.entity';
 import { UserTicketEntity } from './ticket.entity';
-import { UserAlertEntity } from './alert.entity';
-import { TrackableEntity } from '../utils/trackable';
 /**
  * User entity representing a user in the system.
  * Extends TrackableEntity to track creation and update information.
@@ -53,16 +53,6 @@ export declare class UserEntity extends TrackableEntity<User> {
      * Physical address of the user
      */
     address: Address;
-    /**
-     * The currently active/selected profile (Student, Agent, or Company)
-     */
-    selectedProfile: SelectedProfile;
-    /**
-     * Firebase Cloud Messaging tokens associated with the user's devices
-     * Used for sending push notifications to the user's devices
-     * @todo Consider using Device.signature instead and potentially remove this property
-     */
-    fcmTokens: string[];
     /**
      * Unique identifier (UUID) for the user
      * Automatically generated on creation
@@ -72,6 +62,18 @@ export declare class UserEntity extends TrackableEntity<User> {
      * Timezone of the user (default: 'Europe/Zurich')
      */
     timezone: string;
+    /**
+     * This flag indicates whether the user has ever logged in successfully
+     * If the value is true, then the phone number of the account must never be changed
+     */
+    identityConfirmed: boolean;
+    /**
+     * The last selected profile (Student, Agent, or Company)
+     * The same property is part of user device an is priorized over this one
+     * Used to remember which profile the user last used when logging in
+     * Update this property only when user explicitly switches profile
+     */
+    selectedProfile: SelectedProfile;
     /**
      * Timestamp of the user's last activity in the system
      */
@@ -88,12 +90,16 @@ export declare class UserEntity extends TrackableEntity<User> {
      * Instructor profiles
      */
     instructorProfiles: Promise<InstructorEntity[]>;
+    /**
+     * Company instructor profiles
+     */
+    companyInstructors: Promise<CompanyInstructorEntity[]>;
     /**
      * User country
      */
     country: Promise<CountryEntity>;
     /**
-     * Registred devices
+     * Registered devices
      */
     devices: Promise<UserDeviceEntity[]>;
     /**
@@ -129,118 +135,124 @@ export declare class UserEntity extends TrackableEntity<User> {
      */
     toPerson(): Person;
     /**
-     * Updates the last activity timestamp of the user to the current date and saves it.
-     * Used to track when the user was last active in the system.
-     * @returns The updated user entity
-     */
-    updateActivity(): Promise<UserEntity>;
-    /**
-     * Check if user last activity is overdated
-     * @returns
+     * Remove suffix from phone number if the account is closed
+     * @returns phone number that should be returned to ui
      */
-    isActivityOverdated(now: Date): boolean;
+    getPhone(): string;
+    hasPushNotificationsEnabled(): Promise<boolean>;
+    /**************************** profiles ****************************/
     /**
-     * Retrieves the user's student profile if it exists, excluding closed profiles
-     * @returns The student profile or null if not found
+     * Retrieves the user's student profile if it exists
+     * User can have only one student profile which can be active or pending
+     * @returns The student profile
      */
-    getStudentProfile(): Promise<StudentEntity>;
+    getStudent(manager?: EntityManager): Promise<StudentEntity>;
     /**
-     * Retrieves the user's active student profile
-     * @returns The active student profile or null if not found
+     * Retrieves the user's agent profile if it exists
+     * User can have only one agent profile which can be active or pending
+     * @returns The agent profile
      */
-    getActiveStudentProfile(): Promise<StudentEntity>;
+    getAgent(manager?: EntityManager): Promise<AgentEntity>;
     /**
-     * Retrieves the user's agent profile if it exists, excluding closed profiles
-     * @returns The agent profile or null if not found
+     * Retrieves the user's instructor profile if it exists
+     * User can have only one instructor profile which can be active or pending
+     * @returns The agent profile
      */
-    getAgentProfile(): Promise<AgentEntity>;
+    getInstructor(manager?: EntityManager): Promise<InstructorEntity>;
     /**
-     * Retrieves the user's active agent profile
-     * @returns The active agent profile or null if not found
+     * Get user company instructor profile
+     * @param company Company entity (required)
+     * @param manager EntityManager
+     * @returns CompanyInstructorEntity
      */
-    getActiveAgentProfile(): Promise<AgentEntity>;
+    getCompanyInstructor(company: CompanyEntity, manager?: EntityManager): Promise<CompanyInstructorEntity>;
+    getCompanyInstructorById(id?: number, manager?: EntityManager): Promise<CompanyInstructorEntity>;
+    /************************* company profile *************************/
+    getCompany(companyId: number): Promise<CompanyEntity>;
     /**
      * Checks if the user belongs to a specific company.
      *
      * @param companyId - The ID of the company to check against.
+     * @param status - (Optional) The account status to filter by. Defaults to `AccountStatus.Active`.
      * @returns A promise that resolves to `true` if the user belongs to the specified company, otherwise `false`.
      */
-    belongsToCompany(companyId: number): Promise<boolean>;
+    belongsToCompany(companyId: number, status?: AccountStatus): Promise<boolean>;
+    /************************* profile handlers *************************/
     /**
-     * Checks if the user has at least one active profile (student, agent, or instructor)
-     * @returns True if the user has an active profile, false otherwise
-     */
-    hasActiveProfile(manager?: EntityManager): Promise<boolean>;
-    /**
-     * Retrieves the next active profile based on priority (Company > Agent > Student)
-     * Used when the user removes their currently selected profile
-     * @returns Object containing profile type and ID, or null if no active profile exists
-     */
-    getNextProfile(): Promise<{
-        type: ProfileType;
-        id: number;
-    }>;
-    /**
-     * Retrieves the entity for the user's currently selected profile
-     * @returns The selected profile entity (Student, Agent, or CompanyInstructor) or null
+     * Delete any pending profiles of the account
      */
-    getSelectedProfile(): Promise<StudentEntity | AgentEntity | CompanyInstructorEntity>;
+    deletePendingProfiles(): Promise<void>;
+    /***************************** profile *****************************/
     /**
-     * Retrieves the selected student profile if currently selected
-     * @returns The student entity or null if not selected or not found
+     *
+     * @param device UserDeviceEntity
+     * @returns SelectedProfile
      */
-    getSelectedStudent(): Promise<StudentEntity>;
+    getSelectedProfile(device?: UserDeviceEntity): SelectedProfile;
     /**
-     * Retrieves the selected agent profile if currently selected
-     * @returns The agent entity or null if not selected or not found
+     * Reset selected profile for the user
+     * @param guid
+     * @returns UserEntity
      */
-    getSelectedAgent(): Promise<AgentEntity>;
+    resetSelectedProfile(guid?: string): Promise<this>;
     /**
-     * Retrieves the selected company profile if currently selected
-     * @returns The company entity or null if not selected or not found
+     * Select student profile for the user
+     * @param student
+     * @param guid
+     * @returns UserEntity
      */
-    getSelectedCompany(): Promise<CompanyEntity>;
+    selectStudent(student: StudentEntity, guid?: string): Promise<this>;
     /**
-     * Retrieves the instructor profile for the user in the currently selected company
-     * @returns The company instructor entity or undefined if no company is selected
+     * Select agent profile for the user
+     * @param agent
+     * @param guid
+     * @returns UserEntity
      */
-    getSelectedInstructor(): Promise<CompanyInstructorEntity>;
+    selectAgent(agent: AgentEntity, guid?: string): Promise<this>;
     /**
-     * Get the instructor profile for the user in the specified company, regardless of the profile status (pending, invited, etc...)
-     * @param company - The company to get the instructor profile for
-     * @returns The instructor profile for the user in the specified company
+     * Select company instructor profile for the user
+     * @param instructor
+     * @param guid
+     * @returns UserEntity
      */
-    getInstructor(company: CompanyEntity): Promise<CompanyInstructorEntity>;
+    selectInstructor(instructor: CompanyInstructorEntity, guid?: string): Promise<this>;
     /**
-     * Remove suffix from phone number if the account is closed
-     * @returns phone number that should be returned to ui
+     * Check if user has at least one active profile
+     * @param manager EntityManager
+     * @returns boolean
      */
-    getPhone(): string;
-    hasPushNotificationsEnabled(): boolean;
+    hasActiveProfile(manager?: EntityManager): Promise<boolean>;
     /**
-     * Get the pending company profile for the user
+     * Select next active profile for the user
+     * @param guid Device guid
+     * @returns true if a profile was selected, false otherwise
      */
-    getPendingCompany(manager?: EntityManager): Promise<CompanyEntity>;
+    selectNextActiveProfile(guid?: string): Promise<SelectedProfile>;
     /**
-     * Get the pending student profile for the user
-     * @param manager EntityManager - optional transaction manager to use in a transaction
+     * Helper to select profile and update device if guid provided
+     * @param profile
+     * @param guid
+     * @returns UserEntity
      */
-    getPendingStudent(manager?: EntityManager): Promise<StudentEntity>;
+    private selectProfile;
+    /***************************** activities *****************************/
     /**
-     * Get the pending agent profile for the user
+     * Check if user last activity is overdated
+     * @returns
      */
-    getPendingAgent(manager?: EntityManager): Promise<AgentEntity>;
+    isActivityOverdated(days?: number): boolean;
     /**
-     * Delete any pending profiles of the account
+     * Updates the last activity timestamp of the user to the current date and saves it.
+     * Used to track when the user was last active in the system.
+     * @returns The updated user entity
      */
-    deletePendingProfiles(): Promise<void>;
+    updateActivity(): Promise<UserEntity>;
     /**
      * Retrieves all tracked activities for this user (creation and update timestamps)
      * @returns Array of Activity objects filtered to exclude null values
      */
     getActivities(): Promise<Activity[]>;
-    getProfileName(): string;
-    getLanguageName(): string;
+    /***************************** logs *****************************/
     /**
      * Log user event
      * @param event Event type