backbone-bucket 0.3.1

Bucket Bounded Context: File Storage Module for Backbone Framework
Documentation
//! Repository trait for FileVersion aggregate
//!
//! Generated by metaphor-schema. Do not edit manually.
//!
//! This trait defines the repository contract for the FileVersion aggregate.
//! Implementation is in the infrastructure layer.

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

use crate::domain::entity::{FileVersion, FileVersionStatus, VersionType};

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

impl FileVersionPaginationParams {
    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 FileVersionPaginatedResult {
    pub data: Vec<FileVersion>,
    pub total: u64,
    pub page: u32,
    pub per_page: u32,
}

/// Filter parameters for list queries
#[derive(Debug, Clone, Default)]
pub struct FileVersionFilter {
    pub file_id: Option<Uuid>,
    pub version_number: Option<i32>,
    pub version_type: Option<VersionType>,
    pub storage_key: Option<String>,
    pub storage_backend: Option<String>,
    pub name: Option<String>,
    pub mime_type: Option<String>,
    pub checksum_md5: Option<String>,
    pub checksum_sha256: Option<String>,
    pub created_by_id: Option<Uuid>,
    pub change_summary: Option<String>,
    pub is_current: Option<bool>,
    pub restored_from_id: Option<Uuid>,
    pub status: Option<FileVersionStatus>,
    pub size_bytes: Option<i64>,
}

impl FileVersionFilter {
    /// Check if any filter is set
    pub fn has_filters(&self) -> bool {
        self.file_id.is_some() || self.version_number.is_some() || self.version_type.is_some() || self.storage_key.is_some() || self.storage_backend.is_some() || self.name.is_some() || self.mime_type.is_some() || self.checksum_md5.is_some() || self.checksum_sha256.is_some() || self.created_by_id.is_some() || self.change_summary.is_some() || self.is_current.is_some() || self.restored_from_id.is_some() || self.status.is_some() || self.size_bytes.is_some()
    }
}

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

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

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

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

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

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

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

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

    /// List file_version with pagination
    async fn list(&self, params: FileVersionPaginationParams) -> Result<FileVersionPaginatedResult>;

    /// List file_version with pagination and filters
    async fn list_with_filters(&self, params: FileVersionPaginationParams, filters: FileVersionFilter) -> Result<FileVersionPaginatedResult>;

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

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

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

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

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

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

    /// List soft-deleted file_version entities
    async fn list_deleted(&self, params: FileVersionPaginationParams) -> Result<FileVersionPaginatedResult>;

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

    // =========================================================================
    // Query by Unique Fields
    // =========================================================================

    /// Find file_version by storage_key
    async fn find_by_storage_key(&self, storage_key: &str) -> Result<Option<FileVersion>>;

    // =========================================================================
    // Existence Checks by Unique Fields
    // =========================================================================

    /// Check if file_version exists by storage_key
    async fn exists_by_storage_key(&self, storage_key: &str) -> Result<bool>;

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

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

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