using DocumentService.Application.Common.DTOs;
using DocumentService.Application.ExtractZugferd;

namespace DocumentService.Client.Interfaces;

/// <summary>
/// Client for ZUGFeRD operations (detection, extraction).
/// </summary>
public interface IZugferdClient
{
    /// <summary>
    /// Checks whether a PDF contains a ZUGFeRD XML attachment (multipart).
    /// </summary>
    /// <param name="pdfStream">PDF file stream</param>
    /// <param name="cancellationToken">Cancellation token</param>
    /// <returns>ZUGFeRD check result</returns>
    Task<ZugferdCheckResult> HasZugferdAsync(Stream pdfStream, CancellationToken cancellationToken = default);

    /// <summary>
    /// Checks whether a PDF contains a ZUGFeRD XML attachment (Base64).
    /// </summary>
    /// <param name="pdfBytes">PDF file as byte array</param>
    /// <param name="cancellationToken">Cancellation token</param>
    /// <returns>ZUGFeRD check result</returns>
    Task<ZugferdCheckResult> HasZugferdAsync(byte[] pdfBytes, CancellationToken cancellationToken = default);

    /// <summary>
    /// Extracts the ZUGFeRD XML from a PDF and returns the raw XML stream (multipart).
    /// </summary>
    /// <param name="pdfStream">PDF file stream</param>
    /// <param name="cancellationToken">Cancellation token</param>
    /// <returns>ZUGFeRD XML content as stream</returns>
    Task<Stream> ExtractZugferdAsync(Stream pdfStream, CancellationToken cancellationToken = default);

    /// <summary>
    /// Extracts the ZUGFeRD XML from a PDF and returns the raw XML stream (Base64).
    /// </summary>
    /// <param name="pdfBytes">PDF file as byte array</param>
    /// <param name="cancellationToken">Cancellation token</param>
    /// <returns>ZUGFeRD XML content as stream</returns>
    Task<Stream> ExtractZugferdAsync(byte[] pdfBytes, CancellationToken cancellationToken = default);

    /// <summary>
    /// Extracts ZUGFeRD metadata and XML content as a structured result (multipart).
    /// </summary>
    /// <param name="pdfStream">PDF file stream</param>
    /// <param name="cancellationToken">Cancellation token</param>
    /// <returns>Structured ZUGFeRD extraction result</returns>
    Task<ZugferdExtractionResult> ExtractZugferdAsResultAsync(Stream pdfStream, CancellationToken cancellationToken = default);

    /// <summary>
    /// Extracts ZUGFeRD metadata and XML content as a structured result (Base64).
    /// </summary>
    /// <param name="pdfBytes">PDF file as byte array</param>
    /// <param name="cancellationToken">Cancellation token</param>
    /// <returns>Structured ZUGFeRD extraction result</returns>
    Task<ZugferdExtractionResult> ExtractZugferdAsResultAsync(byte[] pdfBytes, CancellationToken cancellationToken = default);
}