Class BaseUsersService<U, UR>

A UsersService is a component of your application's backend that provides programmatic access to the Users API. It typically includes methods for creating, retrieving, updating, and deleting user entities, as well as managing user permissions and roles.

Type Parameters

U extends BaseUser = BaseUser
UR extends BaseUserToRole = BaseUserToRole

Constructors

constructor

new BaseUsersService(): BaseUsersService<U, UR>
Type Parameters
- U extends BaseUser = BaseUser
- UR extends BaseUserToRole = BaseUserToRole
Returns BaseUsersService<U, UR>

Properties

`Protected` `Readonly`dataSource

dataSource: DataSource

`Protected` `Readonly`idService

idService: IdService

`Protected` `Readonly`invitationStatusChangesService

invitationStatusChangesService: InvitationStatusChangesService

Accessors

repository

get repository(): Repository
Returns Repository
- Defined in libs/core/src/modules/users/users.service.ts:82

`Protected`userToRoleRepository

get userToRoleRepository(): Repository<UR>
Returns Repository<UR>
- Defined in libs/core/src/modules/users/users.service.ts:86

Methods

activate

activate(id: string, ctx: BaseServiceMethodContext): Promise
Parameters
- id: string
- ctx: BaseServiceMethodContext
Returns Promise
- Defined in libs/core/src/modules/users/users.service.ts:835

`Protected`applyFilterToQuery

applyFilterToQuery(query: SelectQueryBuilder, filter: UsersFilter): void
Apply UsersFilter to typeorm query builder
Parameters
- query: SelectQueryBuilder
- filter: UsersFilter
Returns void
- Defined in libs/core/src/modules/users/users.service.ts:270

`Protected`applyOrderByToQuery

applyOrderByToQuery(query: SelectQueryBuilder, orderBy: UsersOrderBy): void
Apply UsersOrderBy to typeorm query builder
Parameters
- query: SelectQueryBuilder
- orderBy: UsersOrderBy
Returns void
- Defined in libs/core/src/modules/users/users.service.ts:394

approve

approve(id: string, ctx: BaseServiceMethodContext): Promise
Parameters
- id: string
- ctx: BaseServiceMethodContext
Returns Promise
- Defined in libs/core/src/modules/users/users.service.ts:803

changePassword

changePassword(
opts: ChangePasswordOptions,
ctx: BaseServiceMethodContext,
): Promise<boolean>
Change user password if old password is correct
Parameters
- opts: ChangePasswordOptions
- ctx: BaseServiceMethodContext
Returns Promise<boolean>
Throws
if ether old password or new password is not provided

Throws
if old password is incorrect

Throws
if new password is the same as old password

Throws
if user with provided id is not found
- Defined in libs/core/src/modules/users/users.service.ts:862

create

create(
__namedParameters: CreateUserOptions,
ctx: BaseServiceMethodContext,
): Promise
Create new user
Parameters
- __namedParameters: CreateUserOptions
- ctx: BaseServiceMethodContext
Returns Promise
Throws
if user with given email is already registered

Throws
if failed to create user
- Defined in libs/core/src/modules/users/users.service.ts:546

delete

delete(id: string, ctx: BaseServiceMethodContext): Promise<void>
Delete user by id
Parameters
- id: string
- ctx: BaseServiceMethodContext
Returns Promise<void>
- Defined in libs/core/src/modules/users/users.service.ts:914

disable

disable(id: string, ctx: BaseServiceMethodContext): Promise
Parameters
- id: string
- ctx: BaseServiceMethodContext
Returns Promise
- Defined in libs/core/src/modules/users/users.service.ts:842

`Protected`generateEntityId

generateEntityId(): string
Generate id for new User entity

Returns string
Example
```
'hcu:xxxxx'
```
- Defined in libs/core/src/modules/users/users.service.ts:529

`Protected`generateUserToRoleEntityId

generateUserToRoleEntityId(): string
Generate id for new UserToRole entity

Returns string
Example
```
'hcurol:xxxxx'
```
- Defined in libs/core/src/modules/users/users.service.ts:537

getMany

getMany(
__namedParameters: FetchUsersOptions,
ctx: BaseServiceMethodContext,
): Promise<[U[], ListMeta]>
Get users list with given options
Parameters
- __namedParameters: FetchUsersOptions
- ctx: BaseServiceMethodContext
Returns Promise<[U[], ListMeta]>
- Defined in libs/core/src/modules/users/users.service.ts:238

getOne

getOne(id: string): Promise<MaybeNull>
Get user with given id
Parameters
- id: string
Returns Promise<MaybeNull>
- Defined in libs/core/src/modules/users/users.service.ts:151

getOneBy

getOneBy(opts: GetUserByOptions): Promise<MaybeNull>
Get user with given options
Parameters
- opts: GetUserByOptions
 options to find user
Returns Promise<MaybeNull>
- user entity or null
- Defined in libs/core/src/modules/users/users.service.ts:101

getOneByEmail

getOneByEmail(email: string): Promise<MaybeNull>
Get user with given email
Parameters
- email: string
Returns Promise<MaybeNull>
- Defined in libs/core/src/modules/users/users.service.ts:160

getOneByEmailOrFail

getOneByEmailOrFail(email: string, ctx: BaseServiceMethodContext): Promise
Get user with given email
Parameters
- email: string
- ctx: BaseServiceMethodContext
Returns Promise
Throws
NotFoundException if user not found
- Defined in libs/core/src/modules/users/users.service.ts:229

getOneByOrFail

getOneByOrFail(
opts: GetUserByOptions,
ctx: BaseServiceMethodContext,
): Promise
Get user with given options or throw an error
Parameters
- opts: GetUserByOptions
 options to find user
- ctx: BaseServiceMethodContext
 context of the request
Returns Promise
- user entity
Throws
NotFoundException if user not found

Throws
BadRequestException if options are empty
- Defined in libs/core/src/modules/users/users.service.ts:196

getOneOrFail

getOneOrFail(id: string, ctx: BaseServiceMethodContext): Promise
Get user with given id
Parameters
- id: string
- ctx: BaseServiceMethodContext
Returns Promise
Throws
NotFoundException if user not found
- Defined in libs/core/src/modules/users/users.service.ts:170

isExistsById

isExistsById(id: string): Promise<boolean>
Check if user with given id exists
Parameters
- id: string
Returns Promise<boolean>
- Defined in libs/core/src/modules/users/users.service.ts:521

isExistsByToken

isExistsByToken(
accessToken: string,
ctx: BaseServiceMethodContext,
): Promise<boolean>
Check if user with given jwt access token exists
Parameters
- accessToken: string
- ctx: BaseServiceMethodContext
Returns Promise<boolean>
- Defined in libs/core/src/modules/users/users.service.ts:486

isUniqueEmail

isUniqueEmail(__namedParameters: IsUniqueEmailOptions): Promise<boolean>
Check if user with given email is unique
Parameters
- __namedParameters: IsUniqueEmailOptions
Returns Promise<boolean>
- Defined in libs/core/src/modules/users/users.service.ts:471

onModuleInit

onModuleInit(): void
Returns void
- Defined in libs/core/src/modules/users/users.service.ts:90

reject

reject(id: string, ctx: BaseServiceMethodContext): Promise
Parameters
- id: string
- ctx: BaseServiceMethodContext
Returns Promise
- Defined in libs/core/src/modules/users/users.service.ts:819

sync

sync(
__namedParameters: SyncUserOptions,
ctx: BaseServiceMethodContext,
): Promise
Sync user from external source If user with given id exists, then update it, otherwise create new one
Parameters
- __namedParameters: SyncUserOptions
- ctx: BaseServiceMethodContext
Returns Promise
- Defined in libs/core/src/modules/users/users.service.ts:620

update

update(
__namedParameters: UpdateUserOptions,
ctx: BaseServiceMethodContext,
): Promise
Update user
Parameters
- __namedParameters: UpdateUserOptions
- ctx: BaseServiceMethodContext
Returns Promise
- Defined in libs/core/src/modules/users/users.service.ts:657

updateLastSeen

updateLastSeen(userId: string): Promise<void>
Parameters
- userId: string
Returns Promise<void>
- Defined in libs/core/src/modules/users/users.service.ts:849

Class BaseUsersService<U, UR>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns BaseUsersService<U, UR>

Properties

Protected ReadonlydataSource

Protected ReadonlyidService

Protected ReadonlyinvitationStatusChangesService

Protected ReadonlyjwtConfig

Protectedlogger

Protected ReadonlyloggerFactory

Accessors

repository

Returns Repository<U>

ProtecteduserToRoleRepository

Returns Repository<UR>

Methods

activate

Parameters

Returns Promise<U>

ProtectedapplyFilterToQuery

Parameters

Returns void

ProtectedapplyOrderByToQuery

Parameters

Returns void

approve

Parameters

Returns Promise<U>

changePassword

Parameters

Returns Promise<boolean>

Throws

Throws

Throws

Throws

create

Parameters

Returns Promise<U>

Throws

Throws

delete

Parameters

Returns Promise<void>

disable

Parameters

Returns Promise<U>

ProtectedgenerateEntityId

Returns string

Example

ProtectedgenerateUserToRoleEntityId

Returns string

Example

getMany

Parameters

Returns Promise<[U[], ListMeta]>

getOne

Parameters

Returns Promise<MaybeNull<U>>

getOneBy

Parameters

Returns Promise<MaybeNull<U>>

getOneByEmail

Parameters

Returns Promise<MaybeNull<U>>

getOneByEmailOrFail

Parameters

Returns Promise<U>

Throws

getOneByOrFail

Parameters

Returns Promise<U>

Throws

`Protected` `Readonly`dataSource

`Protected` `Readonly`idService

`Protected` `Readonly`invitationStatusChangesService

`Protected` `Readonly`jwtConfig

`Protected`logger

`Protected` `Readonly`loggerFactory

`Protected`userToRoleRepository

`Protected`applyFilterToQuery

`Protected`applyOrderByToQuery

`Protected`generateEntityId

`Protected`generateUserToRoleEntityId