import 'package:im_app/domain/entities/favorite.dart';

/// 收藏仓储接口
///
/// ## 职责
/// - StorageSdkApi ↔ Domain Favorite 映射
/// - CRUD 操作（通过 StorageSdkApi，不直接接触 DB）
/// - 所有公开接口只接受 Domain 实体，Companion 转换完全内聚在 Impl
///
/// ## 数据流
/// ```
/// 写入：Domain Favorite → _toCompanion() → StorageSdkApi → DB
/// 读取：DB row (DriftFavorite) → _toEntity() → Domain Favorite
/// 监听：DB 变化 → stream → Domain Favorite → UI
/// ```
abstract class FavoriteRepository {
  // ── 监听 ─────────────────────────────────────────────────────────────────

  /// 监听所有收藏，DB 变化自动反映
  Stream<List<Favorite>> watchAll();

  /// 监听指定收藏
  Stream<Favorite?> watchById(int id);

  /// 监听指定 parentId 的收藏
  Stream<List<Favorite>> watchByParentId(String parentId);

  // ── 读取 ─────────────────────────────────────────────────────────────────

  /// 读取所有收藏
  Future<List<Favorite>> getAll();

  /// 读取指定收藏，不存在返回 null
  Future<Favorite?> getById(int id);

  /// 读取指定 parentId 的所有收藏
  Future<List<Favorite>> getByParentId(String parentId);

  /// 读取未上传的收藏
  Future<List<Favorite>> getUnuploaded();

  // ── 写入 ─────────────────────────────────────────────────────────────────

  /// 插入或替换收藏
  Future<void> insertOrReplace(Favorite favorite);

  /// 批量插入或替换收藏
  Future<void> insertOrReplaceAll(List<Favorite> favorites);

  /// 更新收藏
  Future<void> update(Favorite favorite);

  // ── 删除 ─────────────────────────────────────────────────────────────────

  /// 删除指定收藏
  Future<void> delete(int id);

  /// 删除指定 parentId 的所有收藏
  Future<void> deleteByParentId(String parentId);

  /// 清空所有收藏
  Future<void> clear();
}
