backbone-accounting 0.18.3

GL, journals, ledger, reconciliation (extracted from bersihir)
Documentation
//! Repository trait for Reconciliation aggregate
//!
//! Generated by metaphor-schema. Do not edit manually.
//!
//! This trait defines the repository contract for the Reconciliation aggregate.
//! Implementation is in the infrastructure layer.

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

use crate::domain::entity::{Reconciliation, ReconciliationStatus, ReconciliationType};

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

impl ReconciliationPaginationParams {
    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 ReconciliationPaginatedResult {
    pub data: Vec<Reconciliation>,
    pub total: u64,
    pub page: u32,
    pub per_page: u32,
}

/// Filter parameters for list queries
#[derive(Debug, Clone, Default)]
pub struct ReconciliationFilter {
    pub reconciliation_number: Option<String>,
    pub account_id: Option<Uuid>,
    pub account_number: Option<String>,
    pub account_name: Option<String>,
    pub reconciliation_type: Option<ReconciliationType>,
    pub previous_reconciliation_id: Option<Uuid>,
    pub is_balanced: Option<bool>,
    pub status: Option<ReconciliationStatus>,
    pub started_by: Option<Uuid>,
    pub completed_by: Option<Uuid>,
    pub reviewed_by: Option<Uuid>,
    pub has_adjusting_entries: Option<bool>,
    pub statement_source: Option<String>,
    pub statement_file_url: Option<String>,
    pub notes: Option<String>,
    pub discrepancy_notes: Option<String>,
}

impl ReconciliationFilter {
    /// Check if any filter is set
    pub fn has_filters(&self) -> bool {
        self.reconciliation_number.is_some() || self.account_id.is_some() || self.account_number.is_some() || self.account_name.is_some() || self.reconciliation_type.is_some() || self.previous_reconciliation_id.is_some() || self.is_balanced.is_some() || self.status.is_some() || self.started_by.is_some() || self.completed_by.is_some() || self.reviewed_by.is_some() || self.has_adjusting_entries.is_some() || self.statement_source.is_some() || self.statement_file_url.is_some() || self.notes.is_some() || self.discrepancy_notes.is_some()
    }
}

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

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

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

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

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

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

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

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

    /// List reconciliation with pagination
    async fn list(&self, params: ReconciliationPaginationParams) -> Result<ReconciliationPaginatedResult>;

    /// List reconciliation with pagination and filters
    async fn list_with_filters(&self, params: ReconciliationPaginationParams, filters: ReconciliationFilter) -> Result<ReconciliationPaginatedResult>;

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

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

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

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

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

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

    /// List soft-deleted reconciliation entities
    async fn list_deleted(&self, params: ReconciliationPaginationParams) -> Result<ReconciliationPaginatedResult>;

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

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

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

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