namespace GB5Shared.DTO.PubSub
{
    /// <summary>
    /// Rich event wrapper published to Dapr pubsub.
    /// Carries TOUTBOX metadata (EventTypeId, TenantId, ObjectId) alongside
    /// the entity payload so EventSub subscribers can identify the event and
    /// resolve the correct MACTION rows without an extra DB lookup.
    /// Published by OutBox.PublishPendingEventsAsync on topic "EVENTTYPEID:{id}".
    /// </summary>
    public class OutboxEventMessage
    {
        /// <summary>FK to MEVENTTYPE — identifies what happened.</summary>
        public int EventTypeId  { get; set; }

        /// <summary>FK to entity type (ENTITYID on MEVENTTYPE).</summary>
        public int ObjectTypeId { get; set; }

        /// <summary>PK of the saved entity (e.g. TaskId).</summary>
        public int ObjectId     { get; set; }

        /// <summary>Tenant that owns the event (TOUTBOX.TENANTID).</summary>
        public int TenantId     { get; set; }

        /// <summary>UserId who triggered the original business event (TOUTBOX.USERID).</summary>
        public int UserId       { get; set; }

        /// <summary>Serialised entity DTO (TOUTBOX.PAYLOAD).</summary>
        public string Payload   { get; set; } = "{}";

        /// <summary>Correlation key from TOUTBOX — links all downstream rows to the originating outbox event.</summary>
        public string CorrelationKey { get; set; } = string.Empty;

        /// <summary>
        /// The MSERVER connection name (LoginDTO.ConnectionDatabaseName) used by the publisher.
        /// Carried in the message so the framework subscriber can connect to the exact same
        /// tenant database without re-deriving it from MSERVERCONFIG — which can have multiple
        /// active records for the same ClientId and return the wrong database.
        /// When set, EventSubBLL uses this directly and skips the MSERVERCONFIG lookup entirely.
        /// </summary>
        public string ConnectionName { get; set; } = string.Empty;

        /// <summary>
        /// JSON-serialized array of <see cref="GB5Shared.ChangeTracking.ChangeRecordDTO"/>.
        /// Set by BLL on UPDATE operations only; null for INSERT (full snapshot is in TEVENTLOG.DATA).
        /// EventLogSubBLL deserializes this and writes individual rows to TEVENTLOGCHANGE.
        /// Example: [{"FieldName":"Amount","OldValue":"1000","NewValue":"5000"}]
        /// </summary>
        public string? Changes { get; set; }

        /// <summary>GUID of the originating header row (TOUTBOX.HEADERROWGUID). Nullable.</summary>
        public Guid? HeaderRowGuid { get; set; }

        /// <summary>
        /// Full LoginDTO serialised as JSON — carries the complete session context of the user
        /// who triggered the event (WorkOUId, RoleId, BranchId, timezone, formats, etc.).
        /// Populated by <c>BaseEntityAppService.ExecuteSaveAsync</c> on the direct Dapr publish path.
        /// Defaults to <c>"{}"</c> on the outbox background-retry path where login state is
        /// unavailable; subscribers must handle both forms gracefully.
        /// <para>WipApprovalId and RequestUrl are server-side-only and are excluded by [JsonIgnore].</para>
        /// </summary>
        public string LoginJson { get; set; } = "{}";

        /// <summary>
        /// Pipeline context serialised as JSON — carries EntityId, ObjectId, EventTypeId,
        /// caller-supplied Facts (e.g. ParentTaskId, WIP bypass flag), and the DB_ENRICH bag
        /// values written by qualifier rules (e.g. ReportingToEmployeeId, DepartmentId).
        /// Also includes WorkflowInfo (mode, id, config) resolved during the save pipeline.
        /// Populated by <c>BaseEntityAppService.ExecuteSaveAsync</c> on the direct Dapr publish path.
        /// Defaults to a minimal JSON object on the outbox background-retry path.
        /// </summary>
        public string ContextJson { get; set; } = "{}";

        /// <summary>
        /// W3C <c>traceparent</c> of the publisher's span (direct-publish or outbox-relay
        /// producer activity). Carried in the message body itself — rather than relying on
        /// Dapr/broker-level metadata propagation, which varies by pubsub component and
        /// CloudEvent wrapping mode — so <c>EventActionSubscribeController</c> can always
        /// reconstruct the correct parent <see cref="System.Diagnostics.ActivityContext"/> via
        /// <c>DaprEventTracing.StartSubscribeActivity</c> and Zipkin/Jaeger stitch the
        /// publish → subscribe spans together across the service boundary.
        /// </summary>
        public string? TraceParent { get; set; }

        /// <summary>W3C <c>tracestate</c> accompanying <see cref="TraceParent"/>, if any.</summary>
        public string? TraceState { get; set; }
    }
}