/**
 * DomainDAO接口定义
 */

import { Domain } from '../models/Domain';
import { DomainQuery } from './common';

/**
 * DomainDAO接口，定义了域名数据访问层的功能
 */
export interface DomainDAO {
  /**
   * 初始化DAO
   * @returns Promise<void>
   */
  initialize(): Promise<void>;

  /**
   * 关闭DAO
   * @returns Promise<void>
   */
  close(): Promise<void>;

  /**
   * 创建域名记录
   * @param domain 域名对象
   * @returns Promise<Domain> 创建后的域名，包含ID
   */
  create(domain: Domain): Promise<Domain>;

  /**
   * 根据ID获取域名
   * @param id 域名ID
   * @returns Promise<Domain | null> 查询到的域名或null
   */
  findById(id: string): Promise<Domain | null>;

  /**
   * 根据名称获取域名
   * @param name 域名名称
   * @returns Promise<Domain | null> 查询到的域名或null
   */
  findByName(name: string): Promise<Domain | null>;

  /**
   * 根据条件查询域名列表
   * @param query 查询条件
   * @param skip 跳过的记录数
   * @param limit 返回的最大记录数
   * @param sort 排序条件
   * @param projection 投影，指定要返回的字段
   * @returns Promise<Domain[]> 查询结果数组
   */
  find(query?: DomainQuery, skip?: number, limit?: number, sort?: Record<string, 1 | -1>, projection?: Record<string, 1 | 0>): Promise<Domain[]>;

  /**
   * 更新域名
   * @param id 域名ID
   * @param domain 要更新的数据
   * @returns Promise<Domain | null> 更新后的域名或null
   */
  update(id: string, domain: Partial<Domain>): Promise<Domain | null>;

  /**
   * 删除域名
   * @param id 域名ID
   * @returns Promise<boolean> 是否删除成功
   */
  delete(id: string): Promise<boolean>;

  /**
   * 批量创建域名
   * @param domains 域名列表
   * @returns Promise<Domain[]> 创建后的域名列表
   */
  bulkCreate(domains: Domain[]): Promise<Domain[]>;
}