element-ios/RiotSwiftUI/Modules/Authentication/Common/Service/MatrixSDK/LoginParameters.swift

//
// Copyright 2022 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.
//

import Foundation

/// A `DictionaryEncodable` type that can be used as the parameters of a login request.
protocol LoginParameters: DictionaryEncodable {
    var type: String { get }
}

/// The parameters used for a login request with a token.
struct LoginTokenParameters: LoginParameters {
    let type = kMXLoginFlowTypeToken
    let token: String
}

/// The parameters used for a login request with an ID and password.
struct LoginPasswordParameters: LoginParameters {
    let id: Identifier
    let password: String
    let type: String = kMXLoginFlowTypePassword
    let deviceDisplayName: String?
    let deviceID: String?
    
    enum CodingKeys: String, CodingKey {
        case id = "identifier"
        case password
        case type
        case deviceDisplayName = "initial_device_display_name"
        case deviceID = "device_id"
    }
    
    enum ThreePIDMedium: String { case email, msisdn }
    
    enum Identifier: Encodable {
        case user(String)
        case thirdParty(medium: ThreePIDMedium, address: String)
        case phone(country: String, phone: String)
        
        private enum Constants {
            static let typeKey = "type"
            static let userType = "m.id.user"
            static let thirdPartyType = "m.id.thirdparty"
            static let phoneType = "m.id.phone"
            
            static let userKey = "user"
            
            static let mediumKey = "medium"
            static let addressKey = "address"
            
            static let countryKey = "country"
            static let phoneKey = "phone"
        }
        
        var dictionary: [String: String] {
            switch self {
            case .user(let user):
                return [
                    Constants.typeKey: Constants.userType,
                    Constants.userKey: user
                ]
            case .thirdParty(let medium, let address):
                return [
                    Constants.typeKey: Constants.thirdPartyType,
                    Constants.mediumKey: medium.rawValue,
                    Constants.addressKey: address
                ]
            case .phone(let country, let phone):
                return [
                    Constants.typeKey: Constants.phoneType,
                    Constants.countryKey: country,
                    Constants.phoneKey: phone
                ]
            }
        }
        
        func encode(to encoder: Encoder) throws {
            var container = encoder.singleValueContainer()
            try container.encode(dictionary)
        }
    }
}

/// The parameters used when checking that the user has confirmed their email in order to reset their password.
struct CheckResetPasswordParameters: DictionaryEncodable {
    /// Authentication parameters
    let auth: AuthenticationParameters
    /// The new password
    let newPassword: String
    /// The sign out of all devices flag
    let signoutAllDevices: Bool
    
    enum CodingKeys: String, CodingKey {
        case auth
        case newPassword = "new_password"
        case signoutAllDevices = "logout_devices"
    }
    
    init(clientSecret: String, sessionID: String, newPassword: String, signoutAllDevices: Bool) {
        auth = AuthenticationParameters.resetPasswordParameters(clientSecret: clientSecret, sessionID: sessionID)
        self.newPassword = newPassword
        self.signoutAllDevices = signoutAllDevices
    }
}