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

src/domain/interfaces/IUserRepository.ts

35 строк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 { User } from '../entities'

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

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

  /**
   * Обновляет данные пользователя.
   * @param {string} userId - Уникальный идентификатор пользователя.
   * @param {Partial<User>} userData - Частичные данные пользователя для обновления.
   * @returns {Promise<User>} Промис, разрешающийся обновлённым объектом пользователя.
   */
  updateUser(userId: string, userData: Partial<User>): Promise<User>
}