backbone-events 0.5.1

//! Repository trait for Mail aggregate
//!
//! Generated by metaphor-schema. Do not edit manually.
//!
//! This trait defines the repository contract for the Mail aggregate.
//! Implementation is in the infrastructure layer.

use async_trait::async_trait;
use anyhow::Result;
use uuid::Uuid;

use crate::domain::entity::{Mail, EventIntervalKind, EventIntervalUnit, EventMailErrorKind, EventNotificationChannel};

/// Pagination parameters for list queries
#[derive(Debug, Clone, Default)]
pub struct MailPaginationParams {
    pub page: u32,
    pub per_page: u32,
}

impl MailPaginationParams {
    pub fn new(page: u32, per_page: u32) -> Self {
        Self { page, per_page }
    }

    pub fn offset(&self) -> u64 {
        ((self.page.saturating_sub(1)) * self.per_page) as u64
    }

    pub fn limit(&self) -> u64 {
        self.per_page as u64
    }
}

/// Paginated result for list queries
#[derive(Debug, Clone)]
pub struct MailPaginatedResult {
    pub data: Vec<Mail>,
    pub total: u64,
    pub page: u32,
    pub per_page: u32,
}

/// Filter parameters for list queries
#[derive(Debug, Clone, Default)]
pub struct MailFilter {
    pub event_id: Option<Uuid>,
    pub interval_unit: Option<EventIntervalUnit>,
    pub interval_kind: Option<EventIntervalKind>,
    pub notification_channel: Option<EventNotificationChannel>,
    pub mail_done: Option<bool>,
    pub last_registration_id: Option<Uuid>,
    pub template_ref: Option<Uuid>,
    pub template_kind: Option<String>,
    pub error_kind: Option<EventMailErrorKind>,
}

impl MailFilter {
    /// Check if any filter is set
    pub fn has_filters(&self) -> bool {
        self.event_id.is_some() || self.interval_unit.is_some() || self.interval_kind.is_some() || self.notification_channel.is_some() || self.mail_done.is_some() || self.last_registration_id.is_some() || self.template_ref.is_some() || self.template_kind.is_some() || self.error_kind.is_some()
    }
}

/// Repository trait for Mail aggregate
///
/// This trait defines the persistence contract for Mail entities.
/// Implementations should be in the infrastructure layer.
#[async_trait]
pub trait MailRepository: Send + Sync {

    // =========================================================================
    // Core CRUD Operations
    // =========================================================================

    /// Save a new mail entity
    async fn save(&self, entity: &Mail) -> Result<Mail>;

    /// Find mail by ID
    async fn find_by_id(&self, id: &str) -> Result<Option<Mail>>;

    /// Find all mail entities
    async fn find_all(&self) -> Result<Vec<Mail>>;

    /// Update mail by ID
    async fn update(&self, id: &str, entity: &Mail) -> Result<Option<Mail>>;

    /// Delete mail by ID
    async fn delete(&self, id: &str) -> Result<bool>;

    // =========================================================================
    // Pagination
    // =========================================================================

    /// List mail with pagination
    async fn list(&self, params: MailPaginationParams) -> Result<MailPaginatedResult>;

    /// List mail with pagination and filters
    async fn list_with_filters(&self, params: MailPaginationParams, filters: MailFilter) -> Result<MailPaginatedResult>;

    /// Count all mail entities
    async fn count(&self) -> Result<u64>;

    /// Count mail entities matching filters
    async fn count_with_filters(&self, filters: MailFilter) -> Result<u64>;

    /// Check if mail exists by ID
    async fn exists(&self, id: &str) -> Result<bool>;

    // =========================================================================
    // Soft Delete Operations
    // =========================================================================

    /// Soft delete mail by ID
    async fn soft_delete(&self, id: &str) -> Result<bool>;

    /// Restore soft-deleted mail by ID
    async fn restore(&self, id: &str) -> Result<Option<Mail>>;

    /// List soft-deleted mail entities
    async fn list_deleted(&self, params: MailPaginationParams) -> Result<MailPaginatedResult>;

    /// Empty trash (permanently delete all soft-deleted entities)
    async fn empty_trash(&self) -> Result<u64>;

    // =========================================================================
    // Bulk Operations
    // =========================================================================

    /// Bulk save mail entities
    async fn bulk_save(&self, entities: &[Mail]) -> Result<Vec<Mail>>;

    /// Bulk delete by IDs
    async fn bulk_delete(&self, ids: &[&str]) -> Result<u64>;
}