/*
 * Copyright (c) 2024 New Vector Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.element.android.features.login.impl.qrcode

import io.element.android.libraries.matrix.api.auth.qrlogin.MatrixQrCodeLoginData
import io.element.android.libraries.matrix.api.auth.qrlogin.QrCodeLoginStep
import io.element.android.libraries.matrix.api.core.SessionId
import kotlinx.coroutines.flow.StateFlow

/**
 * Helper to handle the QR code login flow after the QR code data has been provided.
 */
interface QrCodeLoginManager {
    /**
     * The current QR code login step.
     */
    val currentLoginStep: StateFlow<QrCodeLoginStep>

    /**
     * Authenticate using the provided [qrCodeLoginData].
     * @param qrCodeLoginData the QR code login data from the scanned QR code.
     * @return the logged in [SessionId] if the authentication was successful or a failure result.
     */
    suspend fun authenticate(qrCodeLoginData: MatrixQrCodeLoginData): Result<SessionId>

    fun reset()
}
