//
// Copyright Amazon.com Inc. or its affiliates.
// All Rights Reserved.
//
// SPDX-License-Identifier: Apache-2.0
//

/// Errors associated with operations provided by Amplify
///
/// - Tag: CoreError
public enum CoreError {

    /// A related operation performed on `List` resulted in an error.
    ///
    /// - Tag: CoreError.listOperation
    case listOperation(ErrorDescription, RecoverySuggestion, Error? = nil)
    
    /// A client side validation error occured.
    ///
    /// - Tag: CoreError.clientValidation
    case clientValidation(ErrorDescription, RecoverySuggestion, Error? = nil)
}

extension CoreError: AmplifyError {
    /// - Tag: CoreError.errorDescription
    public var errorDescription: ErrorDescription {
        switch self {
        case .listOperation(let errorDescription, _, _),
             .clientValidation(let errorDescription, _, _):
            return errorDescription
        }
    }

    /// - Tag: CoreError.recoverySuggestion
    public var recoverySuggestion: RecoverySuggestion {
        switch self {
        case .listOperation(_, let recoverySuggestion, _),
             .clientValidation(_, let recoverySuggestion, _):
            return recoverySuggestion
        }
    }

    /// - Tag: CoreError.underlyingError
    public var underlyingError: Error? {
        switch self {
        case .listOperation(_, _, let underlyingError),
             .clientValidation(_, _, let underlyingError):
            return underlyingError
        }
    }

    /// - Tag: CoreError.init
    public init(
        errorDescription: ErrorDescription = "An unknown error occurred",
        recoverySuggestion: RecoverySuggestion = "(Ignored)",
        error: Error
    ) {
        if let error = error as? Self {
            self = error
        } else {
            self = .clientValidation(errorDescription, recoverySuggestion, error)
        }
    }

}