Class RolesDAO

Hierarchy (View Summary)

BaseDAO
- RolesDAO

Implements

IRolesDAO

Index

Constructors

Properties

Methods

assignPermissionToRole createRole deleteRoleById deleteRoleByName executeQuery executeQueryMultiple getAllRoles getPermissionsByRoleId getPermissionsByRoleName getRoleById getRoleByName mapCacheError mapError mapPostgresError revokePermissionFromRole scalar

Constructors

constructor

new RolesDAO(dbClient: IDbClient): RolesDAO
Protected constructor to enforce singleton usage via getInstance.
Parameters
- dbClient: IDbClient
Returns RolesDAO
Overrides BaseDAO.constructor
- Defined in src/dao/db/RolesDAO.ts:18

Properties

`Protected` `Readonly`db

Methods

assignPermissionToRole

assignPermissionToRole(roleId: number, permissionId: number): Promise<boolean>
Assign a permission to a role.

Calls Assign_permission_to_role DB function and returns boolean result.
Parameters
- roleId: number
  Role ID
- permissionId: number
  Permission ID
Returns Promise<boolean>
true when assigned, false otherwise
Implementation of IRolesDAO.assignPermissionToRole
- Defined in src/dao/db/RolesDAO.ts:114

createRole

createRole(roleName: string): Promise<Role | null>
Create a new role by name.

Calls the DB function Create_role and returns the created Role or null.
Parameters
- roleName: string
  Role name (uppercasing may be applied in DB call)
Returns Promise<Role | null>
The created Role or null
Implementation of IRolesDAO.createRole
- Defined in src/dao/db/RolesDAO.ts:30

deleteRoleById

deleteRoleById(roleId: number): Promise<boolean>
Delete a role by its numeric ID.

Calls Delete_role_by_id DB function and returns boolean result.
Parameters
- roleId: number
  Numeric ID of the role to delete
Returns Promise<boolean>
true when deleted, false otherwise
Implementation of IRolesDAO.deleteRoleById
- Defined in src/dao/db/RolesDAO.ts:44

deleteRoleByName

deleteRoleByName(roleName: string): Promise<boolean>
Delete a role by its name.

Calls Delete_role_by_name DB function and returns boolean result.
Parameters
- roleName: string
  Name of the role to delete
Returns Promise<boolean>
true when deleted, false otherwise
Implementation of IRolesDAO.deleteRoleByName
- Defined in src/dao/db/RolesDAO.ts:62

`Protected`executeQuery

executeQuery<T>(query: string, params?: any[]): Promise<T | null>
Type Parameters
- T
Parameters
- query: string
- Optionalparams: any[]
Returns Promise<T | null>
Inherited from BaseDAO.executeQuery
- Defined in src/dao/db/BaseDao.ts:83

`Protected`executeQueryMultiple

executeQueryMultiple<T>(query: string, params?: any[]): Promise<T[]>
Type Parameters
- T
Parameters
- query: string
- Optionalparams: any[]
Returns Promise<T[]>
Inherited from BaseDAO.executeQueryMultiple
- Defined in src/dao/db/BaseDao.ts:97

getAllRoles

getAllRoles(): Promise<Role[] | null>
Retrieve all roles.

Returns Promise<Role[] | null>
Array of Role or null if none
Implementation of IRolesDAO.getAllRoles
- Defined in src/dao/db/RolesDAO.ts:77

getPermissionsByRoleId

getPermissionsByRoleId(roleId: number): Promise<Permission[] | null>
Get permissions assigned to a role by role ID.
Parameters
- roleId: number
  Role ID
Returns Promise<Permission[] | null>
Array of Permission, or empty array if none
Implementation of IRolesDAO.getPermissionsByRoleId
- Defined in src/dao/db/RolesDAO.ts:157

getPermissionsByRoleName

getPermissionsByRoleName(roleName: string): Promise<Permission[] | null>
Get permissions assigned to a role by role name.
Parameters
- roleName: string
  Role name
Returns Promise<Permission[] | null>
Array of Permission, or empty array if none
Implementation of IRolesDAO.getPermissionsByRoleName
- Defined in src/dao/db/RolesDAO.ts:170

getRoleById

getRoleById(roleId: number): Promise<Role | null>
Get role by its ID.
Parameters
- roleId: number
  Numeric ID of the role
Returns Promise<Role | null>
Role or null if not found
Implementation of IRolesDAO.getRoleById
- Defined in src/dao/db/RolesDAO.ts:99

getRoleByName

getRoleByName(roleName: string): Promise<Role | null>
Get role by its name.
Parameters
- roleName: string
  Name of the role to look up
Returns Promise<Role | null>
Role or null if not found
Implementation of IRolesDAO.getRoleByName
- Defined in src/dao/db/RolesDAO.ts:87

`Protected`mapCacheError

mapCacheError(error: any): DaoError
Parameters
- error: any
Returns DaoError
Inherited from BaseDAO.mapCacheError
- Defined in src/dao/db/BaseDao.ts:47

`Protected`mapError

mapError(error: any): DaoError
Parameters
- error: any
Returns DaoError
Inherited from BaseDAO.mapError
- Defined in src/dao/db/BaseDao.ts:60

`Protected`mapPostgresError

mapPostgresError(error: any): DaoError
Parameters
- error: any
Returns DaoError
Inherited from BaseDAO.mapPostgresError
- Defined in src/dao/db/BaseDao.ts:16

revokePermissionFromRole

revokePermissionFromRole(roleId: number, permissionId: number): Promise<boolean>
Revoke a permission from a role.

Calls Revoke_permission_from_role DB function and returns boolean result.
Parameters
- roleId: number
  Role ID
- permissionId: number
  Permission ID
Returns Promise<boolean>
true when revoked, false otherwise
Implementation of IRolesDAO.revokePermissionFromRole
- Defined in src/dao/db/RolesDAO.ts:136

`Protected`scalar

scalar<T = any>(query: string, params?: any[]): Promise<T>
Type Parameters
- T = any
Parameters
- query: string
- Optionalparams: any[]
Returns Promise<T>
Inherited from BaseDAO.scalar
- Defined in src/dao/db/BaseDao.ts:109