Class PermissionsModule

Permissions Module

Role-based access control and permission checking.

Remarks

This module is pending backend implementation. All methods will throw NotImplementedError until the backend endpoints are available.

Index

Constructors

Methods

hasPermission hasPermissions getUserPermissions getAllPermissions canAccessResource getResourcePermissions getUserRoles getAllRoles

Constructors

constructor

new PermissionsModule(client: HttpClient): PermissionsModule
Parameters
- client: HttpClient
Returns PermissionsModule
- Defined in packages/core/src/permissions/index.ts:37

Methods

hasPermission

hasPermission(permission: string): Promise<boolean>
Check if current user has a specific permission
Parameters
- permission: string
  Permission name to check
Returns Promise<boolean>
True if user has the permission

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/permissions/index.ts:45

hasPermissions

hasPermissions(
permissions: string[],
requireAll?: boolean,
): Promise<HasPermissionsResponse>
Check if current user has multiple permissions
Parameters
- permissions: string[]
  Array of permission names to check
- requireAll: boolean = true
  If true, user must have all permissions. If false, any permission is sufficient.
Returns Promise<HasPermissionsResponse>
Permission check results

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/permissions/index.ts:59

getUserPermissions

getUserPermissions(): Promise<UserPermissions>
Get all permissions for the current user

Returns Promise<UserPermissions>
User permissions including roles

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/permissions/index.ts:70

getAllPermissions

getAllPermissions(): Promise<Permission[]>
Get all available permissions in the system

Returns Promise<Permission[]>
Array of all permissions

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/permissions/index.ts:81

canAccessResource

canAccessResource(
    resourceType: string,
    resourceId: string,
    action: PermissionAction,
): Promise<boolean>
Check if current user can access a specific resource
Parameters
- resourceType: string
  Type of resource (e.g., "project", "file")
- resourceId: string
  ID of the resource
- action: PermissionAction
  Action to check (e.g., "read", "update")
Returns Promise<boolean>
True if user can access the resource

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/permissions/index.ts:95

getResourcePermissions

getResourcePermissions(
resourceType: string,
resourceId: string,
): Promise<ResourcePermission>
Get permissions for a specific resource
Parameters
- resourceType: string
  Type of resource
- resourceId: string
  ID of the resource
Returns Promise<ResourcePermission>
Resource permissions

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/permissions/index.ts:117

getUserRoles

getUserRoles(): Promise<GetUserRolesResponse>
Get roles assigned to the current user

Returns Promise<GetUserRolesResponse>
User roles

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/permissions/index.ts:131

getAllRoles

getAllRoles(): Promise<Role[]>
Get all available roles in the system

Returns Promise<Role[]>
Array of all roles

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/permissions/index.ts:142