backbone-bucket 0.3.0

Bucket Bounded Context: File Storage Module for Backbone Framework
Documentation
//! ConversionJob DTOs (Data Transfer Objects)
//!
//! Generated by metaphor-schema. Do not edit manually.
//!
//! DTOs provide a clean separation between domain entities and API
//! representations, with validation and OpenAPI documentation support.

use serde::{Deserialize, Serialize};
use uuid::Uuid;
use chrono::{DateTime, Utc};

#[cfg(feature = "openapi")]
#[cfg(feature = "openapi")]
use utoipa::ToSchema;

#[cfg(feature = "validation")]
use validator::Validate;

use crate::domain::entity::ConversionJob;
use crate::domain::entity::AuditMetadata;
use crate::domain::entity::ConversionStatus;

// =============================================================================
// Create DTO
// =============================================================================

/// Request DTO for creating a new ConversionJob
///
/// Used in POST requests to create new entities.
/// Excludes auto-generated fields (id, created_at, updated_at, deleted_at).
#[derive(Debug, Clone, Deserialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[cfg_attr(feature = "validation", derive(Validate))]
#[serde(rename_all = "camelCase")]
pub struct CreateConversionJobDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "source_file_id")]
    pub source_file_id: Uuid,
    #[cfg_attr(feature = "validation", validate(length(max = 50)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(alias = "target_format")]
    pub target_format: String,
    pub status: ConversionStatus,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "conversion_options")]
    pub conversion_options: Option<serde_json::Value>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "result_file_id")]
    pub result_file_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    pub progress: i32,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "error_message")]
    pub error_message: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "started_at")]
    pub started_at: Option<DateTime<Utc>>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "completed_at")]
    pub completed_at: Option<DateTime<Utc>>,
}

// =============================================================================
// Update DTO
// =============================================================================

/// Request DTO for full update of a ConversionJob
///
/// Used in PUT requests for full entity replacement.
/// All fields are required (except auto-generated ones).
#[derive(Debug, Clone, Deserialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[cfg_attr(feature = "validation", derive(Validate))]
#[serde(rename_all = "camelCase")]
pub struct UpdateConversionJobDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "source_file_id")]
    pub source_file_id: Uuid,
    #[cfg_attr(feature = "validation", validate(length(max = 50)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(alias = "target_format")]
    pub target_format: String,
    pub status: ConversionStatus,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "conversion_options")]
    pub conversion_options: Option<serde_json::Value>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "result_file_id")]
    pub result_file_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    pub progress: i32,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "error_message")]
    pub error_message: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "started_at")]
    pub started_at: Option<DateTime<Utc>>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "completed_at")]
    pub completed_at: Option<DateTime<Utc>>,
}

// =============================================================================
// Patch DTO
// =============================================================================

/// Request DTO for partial update of a ConversionJob
///
/// Used in PATCH requests for partial updates.
/// All fields are optional - only provided fields will be updated.
#[derive(Debug, Clone, Default, Deserialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[cfg_attr(feature = "validation", derive(Validate))]
#[serde(rename_all = "camelCase")]
pub struct PatchConversionJobDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "source_file_id")]
    pub source_file_id: Option<Uuid>,
    #[cfg_attr(feature = "validation", validate(length(max = 50)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "target_format")]
    pub target_format: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<ConversionStatus>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "conversion_options")]
    pub conversion_options: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "result_file_id")]
    pub result_file_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub progress: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "error_message")]
    pub error_message: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "started_at")]
    pub started_at: Option<DateTime<Utc>>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "completed_at")]
    pub completed_at: Option<DateTime<Utc>>,
}

impl PatchConversionJobDto {
    /// Check if any field is set
    pub fn has_changes(&self) -> bool {
        self.source_file_id.is_some() || self.target_format.is_some() || self.status.is_some() || self.conversion_options.is_some() || self.result_file_id.is_some() || self.progress.is_some() || self.error_message.is_some() || self.started_at.is_some() || self.completed_at.is_some()
    }
}

// =============================================================================
// Response DTO
// =============================================================================

/// Response DTO for ConversionJob entity
///
/// Used in API responses for single entity.
/// Includes all fields including metadata.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct ConversionJobResponseDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub source_file_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub target_format: String,
    pub status: ConversionStatus,
    pub conversion_options: Option<serde_json::Value>,
    pub result_file_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    pub progress: i32,
    pub error_message: Option<String>,
    pub started_at: Option<DateTime<Utc>>,
    pub completed_at: Option<DateTime<Utc>>,
    pub metadata: AuditMetadata,
}

// =============================================================================
// List Response DTO
// =============================================================================

/// Paginated list response for ConversionJob entities
///
/// Used in API responses for list endpoints.
/// Includes pagination metadata.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct ConversionJobListResponseDto {
    /// List of items
    pub items: Vec<ConversionJobResponseDto>,
    /// Total number of items (across all pages)
    pub total: u64,
    /// Current page number (1-indexed)
    pub page: u32,
    /// Number of items per page
    pub per_page: u32,
    /// Total number of pages
    pub total_pages: u32,
    /// Whether there is a next page
    pub has_next: bool,
    /// Whether there is a previous page
    pub has_prev: bool,
}

impl ConversionJobListResponseDto {
    /// Create a new list response from items and pagination info
    pub fn new(items: Vec<ConversionJobResponseDto>, total: u64, page: u32, per_page: u32) -> Self {
        let total_pages = if per_page > 0 {
            ((total as f64) / (per_page as f64)).ceil() as u32
        } else {
            0
        };
        Self {
            items,
            total,
            page,
            per_page,
            total_pages,
            has_next: page < total_pages,
            has_prev: page > 1,
        }
    }
}

/// Summary DTO for list views (compact version)
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct ConversionJobSummaryDto {
    pub id: Uuid,
    pub source_file_id: Uuid,
    pub target_format: String,
    pub status: ConversionStatus,
    pub created_at: Option<DateTime<Utc>>,
}

// =============================================================================
// Conversions
// =============================================================================

impl From<ConversionJob> for ConversionJobResponseDto {
    fn from(entity: ConversionJob) -> Self {
        Self {
            id: entity.id,
            source_file_id: entity.source_file_id,
            target_format: entity.target_format,
            status: entity.status,
            conversion_options: entity.conversion_options,
            result_file_id: entity.result_file_id,
            progress: entity.progress,
            error_message: entity.error_message,
            started_at: entity.started_at,
            completed_at: entity.completed_at,
            metadata: entity.metadata,
        }
    }
}

impl From<ConversionJob> for ConversionJobSummaryDto {
    fn from(entity: ConversionJob) -> Self {
        let created_at = backbone_core::PersistentEntity::created_at(&entity);
        Self {
            id: entity.id,
            source_file_id: entity.source_file_id,
            target_format: entity.target_format,
            status: entity.status,
            created_at,
        }
    }
}

impl From<CreateConversionJobDto> for ConversionJob {
    fn from(dto: CreateConversionJobDto) -> Self {
        Self {
            id: Uuid::new_v4(),
            source_file_id: dto.source_file_id,
            target_format: dto.target_format,
            status: dto.status,
            conversion_options: dto.conversion_options,
            result_file_id: dto.result_file_id,
            progress: dto.progress,
            error_message: dto.error_message,
            started_at: dto.started_at,
            completed_at: dto.completed_at,
            metadata: AuditMetadata::default(),
        }
    }
}

impl From<&ConversionJob> for ConversionJobResponseDto {
    fn from(entity: &ConversionJob) -> Self {
        Self {
            id: entity.id.clone(),
            source_file_id: entity.source_file_id.clone(),
            target_format: entity.target_format.clone(),
            status: entity.status.clone(),
            conversion_options: entity.conversion_options.clone(),
            result_file_id: entity.result_file_id.clone(),
            progress: entity.progress.clone(),
            error_message: entity.error_message.clone(),
            started_at: entity.started_at.clone(),
            completed_at: entity.completed_at.clone(),
            metadata: entity.metadata.clone(),
        }
    }
}

impl backbone_core::FromCreateDto<CreateConversionJobDto> for ConversionJob {
    fn from_create_dto(dto: CreateConversionJobDto) -> backbone_core::ServiceResult<Self> {
        Ok(ConversionJob::from(dto))
    }
}

impl backbone_core::ApplyUpdateDto<UpdateConversionJobDto> for ConversionJob {
    fn apply_update(mut self, dto: UpdateConversionJobDto) -> backbone_core::ServiceResult<Self> {
        self.source_file_id = dto.source_file_id;
        self.target_format = dto.target_format;
        self.status = dto.status;
        self.conversion_options = dto.conversion_options;
        self.result_file_id = dto.result_file_id;
        self.progress = dto.progress;
        self.error_message = dto.error_message;
        self.started_at = dto.started_at;
        self.completed_at = dto.completed_at;
        Ok(self)
    }
}

// =============================================================================
// Custom DTOs
// =============================================================================

// <<< CUSTOM DTOs
// Add custom DTOs specific to ConversionJob here.
// This section will be preserved during regeneration.
// >>> END CUSTOM DTOs