namespace GB5Shared.Storage
{
    /// <summary>
    /// Context object passed to <see cref="StoragePathResolver.Resolve"/> when building the physical
    /// storage path from a template. All token values must be set by the caller before resolving.
    /// </summary>
    public class StoragePathContext
    {
        /// <summary>Tenant/client identifier (LoginDTO.ClientId).</summary>
        public string ClientId { get; set; } = string.Empty;

        /// <summary>
        /// Human-readable entity type code (e.g., "EMPLOYEE", "PO", "INVOICE").
        /// Used in directory partitioning — keep short and filesystem-safe.
        /// </summary>
        public string ObjectTypeCode { get; set; } = string.Empty;

        /// <summary>Entity instance ID (e.g., EmployeeId, PurchaseOrderId).</summary>
        public int ObjectId { get; set; }

        /// <summary>Year component of the file date (for year-partitioned layouts).</summary>
        public int Year { get; set; }

        /// <summary>Month component (1–12) of the file date.</summary>
        public int Month { get; set; }

        /// <summary>
        /// Opaque unique identifier for this specific file (GUID-based, no guessable pattern).
        /// Used as the file name segment so the physical name is never user-controlled.
        /// </summary>
        public string AttachmentId { get; set; } = string.Empty;

        /// <summary>File extension including the leading dot, e.g. ".pdf", ".jpg".</summary>
        public string Ext { get; set; } = string.Empty;

        /// <summary>Document type code for optional category-based partitioning.</summary>
        public string DocumentTypeCode { get; set; } = string.Empty;
    }
}