backbone-inventory 0.10.2

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

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

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

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

impl DeliveryNotePaginationParams {
    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 DeliveryNotePaginatedResult {
    pub data: Vec<DeliveryNote>,
    pub total: u64,
    pub page: u32,
    pub per_page: u32,
}

/// Filter parameters for list queries
#[derive(Debug, Clone, Default)]
pub struct DeliveryNoteFilter {
    pub delivery_number: Option<String>,
    pub branch_id: Option<Uuid>,
    pub customer_id: Option<Uuid>,
    pub source_so_id: Option<Uuid>,
    pub warehouse_id: Option<Uuid>,
    pub cogs_account_id: Option<Uuid>,
    pub inventory_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 DeliveryNoteFilter {
    /// Check if any filter is set
    pub fn has_filters(&self) -> bool {
        self.delivery_number.is_some() || self.branch_id.is_some() || self.customer_id.is_some() || self.source_so_id.is_some() || self.warehouse_id.is_some() || self.cogs_account_id.is_some() || self.inventory_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 DeliveryNote aggregate
///
/// This trait defines the persistence contract for DeliveryNote entities.
/// Implementations should be in the infrastructure layer.
#[async_trait]
pub trait DeliveryNoteRepository: Send + Sync {

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

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

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

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

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

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

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

    /// List delivery_note with pagination
    async fn list(&self, params: DeliveryNotePaginationParams) -> Result<DeliveryNotePaginatedResult>;

    /// List delivery_note with pagination and filters
    async fn list_with_filters(&self, params: DeliveryNotePaginationParams, filters: DeliveryNoteFilter) -> Result<DeliveryNotePaginatedResult>;

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

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

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

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

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

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

    /// List soft-deleted delivery_note entities
    async fn list_deleted(&self, params: DeliveryNotePaginationParams) -> Result<DeliveryNotePaginatedResult>;

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

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

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

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