backbone-inventory 0.17.3

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

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

use crate::domain::entity::{PurchaseReceipt, DocStatus, GlPostingState};

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

impl PurchaseReceiptPaginationParams {
    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 PurchaseReceiptPaginatedResult {
    pub data: Vec<PurchaseReceipt>,
    pub total: u64,
    pub page: u32,
    pub per_page: u32,
}

/// Filter parameters for list queries
#[derive(Debug, Clone, Default)]
pub struct PurchaseReceiptFilter {
    pub receipt_number: Option<String>,
    pub branch_id: Option<Uuid>,
    pub supplier_id: Option<Uuid>,
    pub source_po_id: Option<Uuid>,
    pub warehouse_id: Option<Uuid>,
    pub currency: Option<String>,
    pub inventory_account_id: Option<Uuid>,
    pub grir_account_id: Option<Uuid>,
    pub transfer_id: Option<Uuid>,
    pub status: Option<DocStatus>,
    pub posting_state: Option<GlPostingState>,
    pub journal_id: Option<Uuid>,
    pub accounting_post_id: Option<Uuid>,
    pub notes: Option<String>,
}

impl PurchaseReceiptFilter {
    /// Check if any filter is set
    pub fn has_filters(&self) -> bool {
        self.receipt_number.is_some() || self.branch_id.is_some() || self.supplier_id.is_some() || self.source_po_id.is_some() || self.warehouse_id.is_some() || self.currency.is_some() || self.inventory_account_id.is_some() || self.grir_account_id.is_some() || self.transfer_id.is_some() || self.status.is_some() || self.posting_state.is_some() || self.journal_id.is_some() || self.accounting_post_id.is_some() || self.notes.is_some()
    }
}

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

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

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

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

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

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

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

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

    /// List purchase_receipt with pagination
    async fn list(&self, params: PurchaseReceiptPaginationParams) -> Result<PurchaseReceiptPaginatedResult>;

    /// List purchase_receipt with pagination and filters
    async fn list_with_filters(&self, params: PurchaseReceiptPaginationParams, filters: PurchaseReceiptFilter) -> Result<PurchaseReceiptPaginatedResult>;

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

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

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

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

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

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

    /// List soft-deleted purchase_receipt entities
    async fn list_deleted(&self, params: PurchaseReceiptPaginationParams) -> Result<PurchaseReceiptPaginatedResult>;

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

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

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

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