using VberZero.BaseSystem.MultiTenancy;
using VberZero.BaseSystem.Users;

namespace VberZero.Authorization.Users;

/// <summary>
/// 定义外部授权源。
/// </summary>
public interface IExternalAuthenticationSource
{
    /// <summary>
    /// 身份验证源的唯一名称。
    /// 此源名称设置为 <see cref="User.AuthenticationSource"/>
    /// 如果用户通过此身份验证源进行身份验证
    /// </summary>
    string Name { get; }

    /// <summary>
    /// 用于尝试通过此来源对用户进行身份验证。
    /// </summary>
    /// <param name="userNameOrEmailOrPhone"></param>
    /// <param name="plainPassword"></param>
    /// <param name="tenant"></param>
    /// <returns>True，表示此使用已通过此源进行身份验证</returns>
    Task<bool> TryAuthenticateAsync(string userNameOrEmailOrPhone, string plainPassword, Tenant? tenant);

    /// <summary>
    /// 此方法是通过此源进行身份验证的用户，该用户尚不存在。 因此，源应该创建用户和填充属性。
    /// </summary>
    /// <param name="userNameOrEmailPhone"></param>
    /// <param name="tenant"></param>
    /// <returns>新创建的用户</returns>
    Task<User> CreateUserAsync(string userNameOrEmailPhone, Tenant? tenant);

    /// <summary>
    /// 在现有用户通过此源进行身份验证后调用此方法。 它可用于通过源更新用户的某些属性。
    /// </summary>
    /// <param name="user"></param>
    /// <param name="tenant"></param>
    Task UpdateUserAsync(User user, Tenant? tenant);
}