using System.Collections.Generic;

namespace FrameworkDAL.DTO.EIPConversation
{
    /// <summary>
    /// Declared on a flow step to control how an API response is parsed and presented.
    /// Flow authors set this alongside ApiConfig on CALL_API steps or on standalone PRESENT steps.
    /// </summary>
    public class EIPResponseFormatDTO
    {
        /// <summary>
        /// How to present the data: TABLE | CARD | LIST | TEXT.
        /// TEXT means pass the raw string through ResponseMessage only (no structured data built).
        /// </summary>
        public string Type { get; set; } = "TEXT";

        /// <summary>
        /// Dot-notation path into the stored variable to reach the array or object.
        /// Example: "Body.Items", "Data.Result", "Body".
        /// Empty/null → use the root of the stored JSON directly.
        /// </summary>
        public string? DataPath { get; set; }

        /// <summary>
        /// Fields to display and their order. When null/empty, the engine auto-derives up to 8
        /// fields from the first row's JSON properties.
        /// </summary>
        public List<EIPFieldDefinitionDTO>? Fields { get; set; }

        /// <summary>Maximum rows to include in Rows. Prevents flooding the UI. Default 20.</summary>
        public int MaxRows { get; set; } = 20;

        /// <summary>For CARD: JSON property name to use as the card title.</summary>
        public string? TitleField { get; set; }
    }
}