src/domain/interfaces/IRoleRepository.ts - gitverse - tm-project/rbac-react-system

src/domain/interfaces/IRoleRepository.ts
40 строк2 KB
Artem
chore: release v1.0.4
30 ноя 2025, 22:51
30 ноя 2025, 22:51f6f509c
/**
 * rbac-react-system v1.0.4
 * Copyright (c) 2025 TM Project
 * Licensed under the MIT License
 */

import { Role } from '../entities'

/**
 * Интерфейс репозитория для доступа к данным о ролях.
 * Реализации могут использовать REST API, GraphQL, LocalStorage и другие источники данных.
 */
export interface IRoleRepository {
  /**
   * Находит роль по её уникальному идентификатору.
   * @param {string} roleId - Уникальный идентификатор роли.
   * @returns {Promise<Role | null>} Промис, разрешающийся объектом роли или null, если роль не найдена.
   */
  findRoleById(roleId: string): Promise<Role | null>

  /**
   * Возвращает все роли, назначенные конкретному пользователю.
   * @param {string} userId - Уникальный идентификатор пользователя.
   * @returns {Promise<Role[]>} Промис, разрешающийся массивом объектов ролей.
   */
  getUserRoles(userId: string): Promise<Role[]>

  /**
   * Возвращает все роли, которые наследуются указанной ролью (через свойство inheritedRoles).
   * @param {string} roleId - Уникальный идентификатор роли, для которой запрашиваются наследуемые роли.
   * @returns {Promise<Role[]>} Промис, разрешающийся массивом объектов наследуемых ролей.
   */
  getInheritedRoles(roleId: string): Promise<Role[]>

  /**
   * Возвращает все доступные роли в системе.
   * @returns {Promise<Role[]>} Промис, разрешающийся массивом всех объектов ролей.
   */
  getAllRoles(): Promise<Role[]>
}