element-x-ios/ElementX/Sources/Services/UserSession/UserSessionStoreProtocol.swift

//
// Copyright 2025 Element Creations Ltd.
// Copyright 2022-2025 New Vector Ltd.
//
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
// Please see LICENSE files in the repository root for full details.
//

import Foundation
import MatrixRustSDK

enum UserSessionStoreError: Error {
    case unknownAccount
    case failedRestoringLogin
    case failedSettingUpSession
    case failedSettingUpClientProxy(Error)
}

// sourcery: AutoMockable
protocol UserSessionStoreProtocol {
    /// Deletes all data stored in the shared container and keychain
    func reset()
    
    /// Whether or not there are sessions in the store.
    var hasSessions: Bool { get }
    
    /// All the user IDs managed by the store.
    var userIDs: [String] { get }
    
    /// Returns the delegate that should handle any changes to a `Client`'s `Session`.
    var clientSessionDelegate: ClientSessionDelegate { get }
    
    /// Restores the session of the given account. If this fails, the account's credentials and data are deleted.
    func restoreUserSession(userID: String) async -> Result<UserSessionProtocol, UserSessionStoreError>
    
    /// Creates a user session for a new client from the SDK along with the passphrase used for the data stores.
    func userSession(for client: ClientProtocol, sessionDirectories: SessionDirectories, passphrase: Data) async -> Result<UserSessionProtocol, UserSessionStoreError>
    
    /// Logs out of the specified session.
    func logout(userSession: UserSessionProtocol)
}