Interface UserService

Service interface for managing users.

interface UserService {
    createHouseholdUser(username: string, password: string): Promise<User>;
    deleteHouseholdUser(id: UserID): Promise<void>;
    getHouseholdUsers(): Promise<User[]>;
    getUser(id: UserID): Promise<User | null>;
    getUserByUsername(username: string): Promise<User | null>;
    resetAdminPassword(resetCode: string, password: string): Promise<User>;
    updateHouseholdUsername(id: UserID, username: string): Promise<User>;
    updatePassword(id: UserID, password: string): Promise<User>;
}

Implemented by

UserServiceImpl

Index

Methods

createHouseholdUser deleteHouseholdUser getHouseholdUsers getUser getUserByUsername resetAdminPassword updateHouseholdUsername updatePassword

Methods

createHouseholdUser

createHouseholdUser(username: string, password: string): Promise<User>
Creates a new household user with the given username and password.
Parameters
- username: string
  The username of the new user.
- password: string
  The password of the new user.
Returns Promise<User>
A promise that resolves to the newly created user.
- Defined in src/domain/ports/UserService.ts:56

deleteHouseholdUser

deleteHouseholdUser(id: UserID): Promise<void>
Deletes an existing household user by their unique identifier.
Parameters
- id: UserID
  The unique identifier of the household user to delete.
Returns Promise<void>
A promise that resolves once the household user has been removed.
- Defined in src/domain/ports/UserService.ts:64

getHouseholdUsers

getHouseholdUsers(): Promise<User[]>
Retrieves all household users.

Returns Promise<User[]>
A promise that resolves to an array of household users.
- Defined in src/domain/ports/UserService.ts:13

getUser

getUser(id: UserID): Promise<User | null>
Retrieves a single user by their unique identifier.
Parameters
- id: UserID
  The unique identifier of the user.
Returns Promise<User | null>
A promise that resolves to the user if found, or null otherwise.
- Defined in src/domain/ports/UserService.ts:21

getUserByUsername

getUserByUsername(username: string): Promise<User | null>
Retrieves a single user by their unique username.
Parameters
- username: string
  The unique username of the user.
Returns Promise<User | null>
A promise that resolves to the user if found, or null otherwise.
- Defined in src/domain/ports/UserService.ts:29

resetAdminPassword

resetAdminPassword(resetCode: string, password: string): Promise<User>
Resets the admin's password using a valid reset code.
Parameters
- resetCode: string
  The reset code issued for password recovery.
- password: string
  The new password to assign to the admin.
Returns Promise<User>
A promise that resolves to the updated admin user.
- Defined in src/domain/ports/UserService.ts:73

updateHouseholdUsername

updateHouseholdUsername(id: UserID, username: string): Promise<User>
Updates the username of a household user.
Parameters
- id: UserID
  The unique identifier of the household user.
- username: string
  The new username to assign.
Returns Promise<User>
A promise that resolves to the updated user.
- Defined in src/domain/ports/UserService.ts:38

updatePassword

updatePassword(id: UserID, password: string): Promise<User>
Updates the password of a user.
Parameters
- id: UserID
  The unique identifier of the user.
- password: string
  The new password to set.
Returns Promise<User>
A promise that resolves to the updated user.
- Defined in src/domain/ports/UserService.ts:47