Class BaseUserToRolesService<UTR>`Abstract`

User to Roles service that provides methods to fetch, create and sync user to roles relations

Type Parameters

UTR extends BaseUserToRole = BaseUserToRole

Index

Constructors

Properties

dataSource idService logger loggerFactory

Accessors

Methods

applyFilterToQuery applyOrderByToQuery checkExpired checkPending create delete generateEntityId getAdminIds getMany getOne getOneBy getOneByOrFail getOneOrFail onModuleInit sync update

Constructors

constructor

new BaseUserToRolesService<UTR extends BaseUserToRole = BaseUserToRole>(): BaseUserToRolesService<
UTR,
>
Type Parameters
- UTR extends BaseUserToRole = BaseUserToRole
Returns BaseUserToRolesService<UTR>

Properties

`Protected` `Readonly`dataSource

dataSource: DataSource

`Protected` `Readonly`idService

idService: IdService

`Protected`logger

logger: WinstonLogger

`Protected` `Readonly`loggerFactory

loggerFactory: WinstonLoggerFactory

Accessors

repository

get repository(): Repository<UTR>
Returns Repository<UTR>
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:56

Methods

`Protected`applyFilterToQuery

applyFilterToQuery(
    query: SelectQueryBuilder<UTR>,
    filter: UserToRolesFilter,
    ctx: BaseServiceMethodContext,
): void
Parameters
- query: SelectQueryBuilder<UTR>
- filter: UserToRolesFilter
- ctx: BaseServiceMethodContext
Returns void
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:224

`Protected`applyOrderByToQuery

applyOrderByToQuery(
query: SelectQueryBuilder<UTR>,
orderBy: UserToRolesOrderBy,
): void
Parameters
- query: SelectQueryBuilder<UTR>
- orderBy: UserToRolesOrderBy
Returns void
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:357

checkExpired

checkExpired(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:324

checkPending

checkPending(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:340

create

create(
opts: CreateUserToRoleOptions,
ctx: BaseServiceMethodContext,
): Promise<UTR>
Create user to role relation
Parameters
- opts: CreateUserToRoleOptions
  options to create user to role relation
- ctx: BaseServiceMethodContext
  service method context
Returns Promise<UTR>
- created user to role relation
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:139

delete

delete(id: string, ctx: BaseServiceMethodContext): Promise<void>
Delete user to role relation by id
Parameters
- id: string
  user to role id to delete
- ctx: BaseServiceMethodContext
  service method context
Returns Promise<void>
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:461

`Protected`generateEntityId

generateEntityId(): string
Returns string
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:129

getAdminIds

getAdminIds(organizationId: string): Promise<string[]>
Get list of admin ids (superadmin, orgadmin, orgobserver)
Parameters
- organizationId: string
  organization id where to search for admins
Returns Promise<string[]>
- list of admin ids
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:402

getMany

getMany(
opts: FetchUserToRolesOptions,
ctx: BaseServiceMethodContext,
): Promise<[UTR[], ListMeta]>
Get user to roles relations
Parameters
- opts: FetchUserToRolesOptions
  list options
- ctx: BaseServiceMethodContext
  service method context
Returns Promise<[UTR[], ListMeta]>
- list of user to roles relations and list meta
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:194

getOne

getOne(id: string): Promise<MaybeNull<UTR>>
Fetch user to roles relation by id
Parameters
- id: string
  ID of the user to role relation
Returns Promise<MaybeNull<UTR>>
- user to role relation
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:117

getOneBy

getOneBy(opts: GetUserToRoleByOptions): Promise<MaybeNull<UTR>>
Fetch user to role relation by options
Parameters
- opts: GetUserToRoleByOptions
  options to fetch user to role relation
Returns Promise<MaybeNull<UTR>>
- user to role relation
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:71

getOneByOrFail

getOneByOrFail(
opts: GetUserToRoleByOptions,
ctx: BaseServiceMethodContext,
): Promise<UTR>
Fetch user to role relation by options or throw an exception if not found
Parameters
- opts: GetUserToRoleByOptions
  options to fetch user to role relation
- ctx: BaseServiceMethodContext
  service method context
Returns Promise<UTR>
- user to role relation
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:94

getOneOrFail

getOneOrFail(id: string, ctx: BaseServiceMethodContext): Promise<UTR>
Parameters
- id: string
- ctx: BaseServiceMethodContext
Returns Promise<UTR>
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:123

onModuleInit

onModuleInit(): void
Returns void
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:60

sync

sync(opts: SyncUserToRoleOptions, ctx: BaseServiceMethodContext): Promise<UTR>
Sync user to role relation
Parameters
- opts: SyncUserToRoleOptions
  options to sync user to role relation
- ctx: BaseServiceMethodContext
  service method context
Returns Promise<UTR>
- synced user to role relation
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:424

update

update(
opts: UpdateUserToRoleOptions,
ctx: BaseServiceMethodContext,
): Promise<UTR>
Update user to role relation
Parameters
- opts: UpdateUserToRoleOptions
  options to update user to role relation
- ctx: BaseServiceMethodContext
  service method context
Returns Promise<UTR>
- updated user to role relation
- Defined in src/modules/user-to-roles/user-to-roles.service.ts:167