/* 
 *                                dbMango
 *
 * Copyright 2025 Deutsche Bank AG
 * SPDX-License-Identifier: Apache-2.0
 *
 * 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.
 */
using Rms.Risk.Mango.Pivot.Core;

namespace Rms.Risk.Mango.Pivot.UI.Services;

public class SharedPivotDef
{
    public required string   SharedBy    { get; init; }
    public required DateTime SharedAtUTC { get; init; }
    public required string   Collection  { get; init; }

    public required PivotDefinition PivotDef { get; init; }
        
    // NewtonsoftJson can't deserialize interface, so using custom serialization instead
    public string? /*FilterExpressionTree.ExpressionGroup*/ ExtraFilter { get; init; } 
}

public interface IPivotSharingService
{
    /// <summary>
    /// Exports the pivot definition to a CSV file.
    /// </summary>
    /// <returns>URL that can be used for file retrieval</returns>
    Task<string> ExportToCsv(string        destFileName, string fileContents);
    /// <summary>
    /// Publishes a pivot definition to the shared location. Other user can extract it using <see cref="GetSharedPivot"/> method.
    /// </summary>
    /// <returns>sharedPivotId for <see cref="GetSharedPivot"/></returns>
    Task<string> SharePivot(SharedPivotDef def);
    /// <summary>
    /// Retrieves a shared pivot definition by its ID. See <see cref="SharePivot"/>.
    /// </summary>
    /// <param name="sharedPivotId">ID from <see cref="SharePivot"/></param>
    Task<SharedPivotDef?> GetSharedPivot(string sharedPivotId);
}