Class SecureRbacService

Service class responsible for handling Role-Based Access Control (RBAC) operations.

Hierarchy

SecureRbacService

Constructors

constructor

new SecureRbacService(prisma): SecureRbacService
Parameters
- prisma: PrismaService
Returns SecureRbacService
- Defined in src/rbac/service/rbac.service.ts:15

Properties

`Private` `Readonly` prisma

prisma: PrismaService

Methods

asignPermissionToRole

asignPermissionToRole(assignPermissionToRoleDto): Promise<void>
Parameters
- assignPermissionToRoleDto: AssignPermissionToRoleDto
Returns Promise<void>
- Defined in src/rbac/service/rbac.service.ts:221

assignRoleToUser

assignRoleToUser(assignRoleToUser): Promise<void>
Assigns a role to a user.
Parameters
- assignRoleToUser: AssignRoleToUserDto
  
  The data for assigning the role to the user.
Returns Promise<void>
A promise that resolves when the role is assigned to the user successfully.

Throws
If the user or role with the specified ID is not found.

Throws
If the user already has the specified role.
- Defined in src/rbac/service/rbac.service.ts:416

createPermission

createPermission(permissionDto): Promise<GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {}>
Creates a new permission.
Parameters
- permissionDto: PermissionDto
  
  The data for creating the new permission.
Returns Promise<GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {}>
A promise that resolves to the created Permission object.

Throws
If the permission with the same name already exists.
- Defined in src/rbac/service/rbac.service.ts:33

createRole

createRole(roleDto): Promise<GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {}>
Creates a new role.
Parameters
- roleDto: RoleDto
  
  The data for creating the new role.
Returns Promise<GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {}>
A promise that resolves to the created Role object.

Throws
If the role with the same name already exists.
- Defined in src/rbac/service/rbac.service.ts:131

deactivePermission

deactivePermission(permissionId): Promise<void>
Deactivate a Permission by its ID.
Parameters
- permissionId: number
  
  The ID of the role to delete.
Returns Promise<void>
A promise that resolves when the role is deleted successfully.

Throws
If the role with the specified ID is not found.

Throws
If the role has already been deleted.
- Defined in src/rbac/service/rbac.service.ts:174

deactiveRole

deactiveRole(roleId): Promise<void>
Deletes a role by its ID.
Parameters
- roleId: number
  
  The ID of the role to delete.
Returns Promise<void>
A promise that resolves when the role is deleted successfully.

Throws
If the role with the specified ID is not found.

Throws
If the role has already been deleted.
- Defined in src/rbac/service/rbac.service.ts:361

deletePermission

deletePermission(permissionId): Promise<void>
Parameters
- permissionId: number
Returns Promise<void>
- Defined in src/rbac/service/rbac.service.ts:208

deleteRole

deleteRole(roleId): Promise<void>
Parameters
- roleId: number
Returns Promise<void>
- Defined in src/rbac/service/rbac.service.ts:394

getPermissionById

getPermissionById(id): Promise<GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {}>
Retrieves a permission by its ID.
Parameters
- id: number
  
  The ID of the permission to retrieve.
Returns Promise<GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {}>
A promise that resolves to the Permission object with the given ID.

Throws
If the permission with the specified ID is not found.
- Defined in src/rbac/service/rbac.service.ts:55

getPermissions

getPermissions(): Promise<(GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {})[]>
Retrieves a list of all permissions.

Returns Promise<(GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {})[]>
A promise that resolves to an array of Permission objects.
- Defined in src/rbac/service/rbac.service.ts:22

getPermissionsForUser

getPermissionsForUser(userId): Promise<(GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {})[]>
Retrieves a list of permissions assigned to a user.
Parameters
- userId: number
  
  The ID of the user.
Returns Promise<(GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {})[]>
A promise that resolves to an array of Permission objects.
- Defined in src/rbac/service/rbac.service.ts:499

getRoleById

getRoleById(roleId): Promise<GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {}>
Retrieves a role by its ID.
Parameters
- roleId: number
  
  The ID of the role to retrieve.
Returns Promise<GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {}>
A promise that resolves to the Role object with the given ID.

Throws
If the role with the specified ID is not found.
- Defined in src/rbac/service/rbac.service.ts:113

getRoles

getRoles(): Promise<(GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {})[]>
Retrieves a list of all roles.

Returns Promise<(GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {})[]>
A promise that resolves to an array of Role objects.
- Defined in src/rbac/service/rbac.service.ts:102

hasPermission

hasPermission(userId, requiredPermissions): Promise<boolean>
Checks if a user has specific permissions.
Parameters
- userId: number
  
  The ID of the user.
- requiredPermissions: string[]
  
  An array of permission names required for access.
Returns Promise<boolean>
A promise that resolves to true if the user has all the required permissions; otherwise, false.
- Defined in src/rbac/service/rbac.service.ts:543

hasRoles

hasRoles(userId, requiredRoles): Promise<boolean>
Checks if a user has specific roles.
Parameters
- userId: any
  
  The ID of the user.
- requiredRoles: string[]
  
  An array of role names required for access.
Returns Promise<boolean>
A promise that resolves to true if the user has all the required roles; otherwise, false.
- Defined in src/rbac/service/rbac.service.ts:519

reactivatePermission

reactivatePermission(permissionId): Promise<void>
Parameters
- permissionId: number
Returns Promise<void>
- Defined in src/rbac/service/rbac.service.ts:189

reactivateRole

reactivateRole(roleId): Promise<void>
Parameters
- roleId: number
Returns Promise<void>
- Defined in src/rbac/service/rbac.service.ts:376

removePermissionFromRole

removePermissionFromRole(removePermissionFromRoleDto): Promise<void>
Removes permissions from a role based on the provided DTO.
Parameters
- removePermissionFromRoleDto: AssignPermissionToRoleDto
  
  The DTO containing roleId and permissionIds.
Returns Promise<void>

Async

Throws
If the role or permission is not found.

Throws
If a permission is not associated with the role.
- Defined in src/rbac/service/rbac.service.ts:266

revokeRoleOfUser

revokeRoleOfUser(revokeRoleOfUserDto): Promise<void>
Disconnects a role from a user based on the provided DTO.
Parameters
- revokeRoleOfUserDto: AssignRoleToUserDto
  
  The DTO containing userId and roleId.
Returns Promise<void>

Async

Throws
If the user or role is not found.

Throws
If the user doesn't have the specified role.
- Defined in src/rbac/service/rbac.service.ts:466

updatePermission

updatePermission(id, updatePermissionDto): Promise<GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {}>
Updates a permission by its ID.
Parameters
- id: number
  
  The ID of the permission to update.
- updatePermissionDto: PermissionDto
  
  The data for updating the permission.
Returns Promise<GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {}>
A promise that resolves to the updated Permission object.

Throws
If the permission with the specified ID is not found.
- Defined in src/rbac/service/rbac.service.ts:71

updatePermissionsToRoles

updatePermissionsToRoles(updatePermissionToRoleDto): Promise<void>
Updates a role by its ID.
Parameters
- updatePermissionToRoleDto: AssignPermissionToRoleDto
  
  The data for updating the role.
Returns Promise<void>

Throws
If the role with the specified ID is not found.
- Defined in src/rbac/service/rbac.service.ts:308

updateRole

updateRole(roleId, updateRoleDto): Promise<GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {}>
Parameters
- roleId: number
- updateRoleDto: RoleDto
Returns Promise<GetResult<{
    createdAt: Date;
    deletedAt: Date;
    id: number;
    name: string;
    updatedAt: Date;
}, unknown> & {}>
- Defined in src/rbac/service/rbac.service.ts:149

Class SecureRbacService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

prisma: PrismaService

Returns SecureRbacService

Properties

Private Readonly prisma

Methods

asignPermissionToRole

Parameters

assignPermissionToRoleDto: AssignPermissionToRoleDto

Returns Promise<void>

assignRoleToUser

Parameters

assignRoleToUser: AssignRoleToUserDto

Returns Promise<void>

Throws

Throws

createPermission

Parameters

permissionDto: PermissionDto

Returns Promise<GetResult<{ createdAt: Date; deletedAt: Date; id: number; name: string; updatedAt: Date; }, unknown> & {}>

Throws

createRole

Parameters

roleDto: RoleDto

Returns Promise<GetResult<{ createdAt: Date; deletedAt: Date; id: number; name: string; updatedAt: Date; }, unknown> & {}>

Throws

deactivePermission

Parameters

permissionId: number

Returns Promise<void>

Throws

Throws

deactiveRole

Parameters

roleId: number

Returns Promise<void>

Throws

Throws

deletePermission

Parameters

permissionId: number

Returns Promise<void>

deleteRole

Parameters

roleId: number

Returns Promise<void>

getPermissionById

Parameters

id: number

Returns Promise<GetResult<{ createdAt: Date; deletedAt: Date; id: number; name: string; updatedAt: Date; }, unknown> & {}>

Throws

getPermissions

Returns Promise<(GetResult<{ createdAt: Date; deletedAt: Date; id: number; name: string; updatedAt: Date; }, unknown> & {})[]>

getPermissionsForUser

Parameters

userId: number

Returns Promise<(GetResult<{ createdAt: Date; deletedAt: Date; id: number; name: string; updatedAt: Date; }, unknown> & {})[]>

getRoleById

Parameters

roleId: number

Returns Promise<GetResult<{ createdAt: Date; deletedAt: Date; id: number; name: string; updatedAt: Date; }, unknown> & {}>

Throws

getRoles

Returns Promise<(GetResult<{ createdAt: Date; deletedAt: Date; id: number; name: string; updatedAt: Date; }, unknown> & {})[]>

hasPermission

Parameters

userId: number

requiredPermissions: string[]

Returns Promise<boolean>

hasRoles

Parameters

userId: any

`Private` `Readonly` prisma

Returns Promise<GetResult<{
createdAt: Date;
deletedAt: Date;
id: number;
name: string;
updatedAt: Date;
}, unknown> & {}>

Returns Promise<GetResult<{
createdAt: Date;
deletedAt: Date;
id: number;
name: string;
updatedAt: Date;
}, unknown> & {}>

Returns Promise<GetResult<{
createdAt: Date;
deletedAt: Date;
id: number;
name: string;
updatedAt: Date;
}, unknown> & {}>

Returns Promise<(GetResult<{
createdAt: Date;
deletedAt: Date;
id: number;
name: string;
updatedAt: Date;
}, unknown> & {})[]>

Returns Promise<(GetResult<{
createdAt: Date;
deletedAt: Date;
id: number;
name: string;
updatedAt: Date;
}, unknown> & {})[]>

Returns Promise<GetResult<{
createdAt: Date;
deletedAt: Date;
id: number;
name: string;
updatedAt: Date;
}, unknown> & {}>

Returns Promise<(GetResult<{
createdAt: Date;
deletedAt: Date;
id: number;
name: string;
updatedAt: Date;
}, unknown> & {})[]>

Returns Promise<GetResult<{
createdAt: Date;
deletedAt: Date;
id: number;
name: string;
updatedAt: Date;
}, unknown> & {}>

Returns Promise<GetResult<{
createdAt: Date;
deletedAt: Date;
id: number;
name: string;
updatedAt: Date;
}, unknown> & {}>