// =============================================================================
// GB5 Framework — Report Orchestration Enums
// Namespace : GB5Shared.Enums.ReportOrchestration
// Purpose   : Shared enum definitions used across orchestrator, resolver,
//             endpoints, and DAL layers. Values align with DB TINYINT columns.
// =============================================================================

namespace GB5Shared.Enums.ReportOrchestration
{
    // -------------------------------------------------------------------------
    // DataSourceType  — maps to MREPORTCONFIG.DATASOURCETYPE (TINYINT)
    //                   and MSERVERCONFIG resolution logic.
    // -------------------------------------------------------------------------
    /// <summary>
    /// Identifies which physical database the query should execute against.
    /// Mirrors MREPORTCONFIG.DATASOURCETYPE column values.
    /// </summary>
    public enum DataSourceType : byte
    {
        /// <summary>Live OLTP database. Uses LoginDTO.ServerConfigId directly.</summary>
        Oltp = 0,

        /// <summary>
        /// Dedicated reporting/analytics database (pre-aggregated, denormalised).
        /// Resolved via MSERVERCONFIG.REPORTSERVERCONFIGID.
        /// Falls back to OLTP when REPORTSERVERCONFIGID = -1.
        /// </summary>
        ReportDb = 1,

        /// <summary>
        /// Historical archive database (partitioned, immutable after write).
        /// Resolved via MSERVERCONFIG.ARCHIVESERVERCONFIGID.
        /// Falls back to OLTP when ARCHIVESERVERCONFIGID = -1.
        /// </summary>
        ArchiveDb = 2,

        /// <summary>
        /// Orchestrator selects the source automatically based on
        /// MREPORTDATASOURCERULE entries for this report.
        /// Evaluated in RULEPRIORITY order; defaults to OLTP if no rule matches.
        /// </summary>
        Auto = 3
    }

    // -------------------------------------------------------------------------
    // ReportCallType  — identifies which path the orchestrator takes
    // -------------------------------------------------------------------------
    /// <summary>
    /// Discriminates the call path so the orchestrator applies the correct
    /// resolution, execution, and export strategy.
    /// Derived from MMenu.REPORTTYPE.
    /// </summary>
    public enum ReportCallType : byte
    {
        /// <summary>
        /// Standard report: MREPORT → MWEBSERVICE URI → module endpoint.
        /// Supports full orchestration (datasource, async, export, cache).
        /// MMenu REPORTTYPE = 1 or 2.
        /// </summary>
        StandardReport = 1,

        /// <summary>
        /// Analysis report: MANALYSIS → MANALYSISQUERY → dynamic SQL.
        /// Executed directly by AnalysisDAL against resolved connection.
        /// MMenu REPORTTYPE = 0 or 3.
        /// </summary>
        AnalysisReport = 0,

        /// <summary>
        /// Direct API call (select list, get-record, interactive form data).
        /// Bypasses orchestration entirely — zero overhead path.
        /// </summary>
        Direct = 99
    }

    // -------------------------------------------------------------------------
    // AsyncMode  — maps to MREPORTCONFIG.ASYNCMODE (TINYINT)
    // -------------------------------------------------------------------------
    /// <summary>
    /// Controls whether a report executes synchronously (stream to browser)
    /// or asynchronously (submitted as SysJob; result delivered to My Reports).
    /// Mirrors MREPORTCONFIG.ASYNCMODE column values.
    /// </summary>
    public enum AsyncMode : byte
    {
        /// <summary>
        /// Orchestrator decides: if request date range in days exceeds
        /// MREPORTCONFIG.ASYNCTHRESHOLDDAYS → async; otherwise sync.
        /// </summary>
        Auto = 0,

        /// <summary>Always submit as SysJob regardless of date range.</summary>
        AlwaysAsync = 1,

        /// <summary>Always execute synchronously. Use for small reference reports.</summary>
        AlwaysSync = 2,

        /// <summary>
        /// Apply tenant/module/role policy rules from MREPORTPOLICY.
        /// Falls back to Auto if no policy matches.
        /// </summary>
        PolicyBased = 3
    }

    // -------------------------------------------------------------------------
    // ExportFormat  — maps to MREPORTCONFIG.ALLOWEDEXPORTFORMATS values
    // -------------------------------------------------------------------------
    /// <summary>
    /// Supported export formats. Stored as TINYINT; comma-separated list
    /// in MREPORTCONFIG.ALLOWEDEXPORTFORMATS controls which are available
    /// for each report.
    /// </summary>
    public enum ExportFormat : byte
    {
        /// <summary>In-browser grid (no file generated).</summary>
        Grid = 0,

        /// <summary>PDF via Puppeteer/shared browser instance.</summary>
        Pdf = 1,

        /// <summary>Excel (.xlsx) via EPPlus/ClosedXML.</summary>
        Excel = 2,

        /// <summary>Comma-separated values (.csv).</summary>
        Csv = 3,

        /// <summary>JSON payload (for API consumers / embeddable widgets).</summary>
        Json = 4
    }

    // -------------------------------------------------------------------------
    // PivotEngine  — maps to MREPORTCONFIG.PIVOTENGINE (TINYINT)
    // -------------------------------------------------------------------------
    /// <summary>
    /// Controls where pivot transformation occurs.
    /// Mirrors MREPORTCONFIG.PIVOTENGINE column values.
    /// </summary>
    public enum PivotEngine : byte
    {
        /// <summary>No pivot. Flat grid data returned as-is.</summary>
        None = 0,

        /// <summary>
        /// Server-side pivot via DataPivotEngine before export.
        /// Required when exporting to PDF/Excel (client cannot pivot).
        /// </summary>
        Backend = 1,

        /// <summary>
        /// Raw flat data returned to Angular frontend; pivot rendered in browser.
        /// Only valid for Grid export format.
        /// </summary>
        Frontend = 2
    }

    // -------------------------------------------------------------------------
    // ReportCategory  — maps to MREPORTCONFIG.REPORTCATEGORY (TINYINT)
    // -------------------------------------------------------------------------
    /// <summary>
    /// Semantic categorisation of a report. Drives UI grouping, icon selection,
    /// and default datasource suggestions during configuration.
    /// </summary>
    public enum ReportCategory : byte
    {
        /// <summary>Day-to-day transactional report. Default datasource: OLTP.</summary>
        Operational = 0,

        /// <summary>Trend, variance, or drill-down report. Default datasource: ReportDB.</summary>
        Analytical = 1,

        /// <summary>KPI / scorecard report. Default datasource: ReportDB.</summary>
        Kpi = 2,

        /// <summary>Historical data report. Default datasource: ArchiveDB.</summary>
        Archive = 3,

        /// <summary>Recurring scheduled report. Executed via SysJob.</summary>
        Scheduled = 4
    }

    // -------------------------------------------------------------------------
    // DatabaseProviderType — derived from LoginDTO.DatabaseType (byte)
    //                        and MSERVERCONFIG.DATABASETYPE (TINYINT)
    // -------------------------------------------------------------------------
    /// <summary>
    /// The RDBMS provider. Used by IReportConnectionResolver to instantiate
    /// the correct IDbConnection implementation.
    /// Values align with MSERVERCONFIG.DATABASETYPE column.
    /// </summary>
    public enum DatabaseProviderType : byte
    {
        /// <summary>Microsoft SQL Server (SqlConnection).</summary>
        SqlServer = 0,

        /// <summary>Oracle Database (OracleConnection).</summary>
        Oracle = 1,

        /// <summary>PostgreSQL (NpgsqlConnection).</summary>
        PostgreSql = 2,

        /// <summary>MySQL / MariaDB (MySqlConnection).</summary>
        MySql = 3
    }
}