// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using Microsoft.TemplateEngine.Abstractions;
using Microsoft.TemplateSearch.Common.Abstractions;

namespace Microsoft.TemplateSearch.Common
{
    /// <summary>
    /// Results of the search performed by <see cref="TemplateSearchCoordinator"/>.
    /// </summary>
    public class SearchResult
    {
        internal SearchResult(
            ITemplateSearchProvider provider,
            bool success,
            string? errorMessage = null,
            IReadOnlyList<(ITemplatePackageInfo, IReadOnlyList<ITemplateInfo>)>? hits = null)
        {
            if (!success && string.IsNullOrWhiteSpace(errorMessage))
            {
                throw new ArgumentException($"{nameof(errorMessage)} cannot be empty when {nameof(success)} is false", nameof(errorMessage));
            }
            if (success && hits == null)
            {
                throw new ArgumentException($"{nameof(hits)} cannot be null when {nameof(success)} is true", nameof(hits));
            }
            Provider = provider ?? throw new ArgumentNullException(nameof(provider));
            Success = success;
            ErrorMessage = errorMessage;
            SearchHits = success ? hits! : [];
        }

        /// <summary>
        /// Gets <see cref="ITemplateSearchProvider"/> that performed the search.
        /// </summary>
        public ITemplateSearchProvider Provider { get; }

        /// <summary>
        /// <see langword="true"/> if search completed successfully.
        /// </summary>
        public bool Success { get; }

        /// <summary>
        /// Gets localized error message if the search failed.
        /// </summary>
        public string? ErrorMessage { get; }

        /// <summary>
        /// Gets search hits returned by <see cref="Provider"/>.
        /// </summary>
        public IReadOnlyList<(ITemplatePackageInfo PackageInfo, IReadOnlyList<ITemplateInfo> MatchedTemplates)> SearchHits { get; }
    }
}