backbone-catalog 0.7.0

//! Brand 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::Brand;
use crate::domain::entity::AuditMetadata;
use crate::domain::entity::CatalogStatus;

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

/// Request DTO for creating a new Brand
///
/// 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 CreateBrandDto {
    #[cfg_attr(feature = "validation", validate(length(max = 40)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub code: String,
    #[cfg_attr(feature = "validation", validate(length(max = 150)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub name: String,
    #[cfg_attr(feature = "validation", validate(length(max = 500)))]
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "short_description")]
    pub short_description: Option<String>,
    #[cfg_attr(feature = "validation", validate(length(max = 2000)))]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[cfg_attr(feature = "validation", validate(length(max = 500)))]
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "logo_url")]
    pub logo_url: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    #[serde(alias = "sort_order")]
    pub sort_order: i32,
    pub status: CatalogStatus,
}

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

/// Request DTO for full update of a Brand
///
/// 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 UpdateBrandDto {
    #[cfg_attr(feature = "validation", validate(length(max = 40)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub code: String,
    #[cfg_attr(feature = "validation", validate(length(max = 150)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub name: String,
    #[cfg_attr(feature = "validation", validate(length(max = 500)))]
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "short_description")]
    pub short_description: Option<String>,
    #[cfg_attr(feature = "validation", validate(length(max = 2000)))]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[cfg_attr(feature = "validation", validate(length(max = 500)))]
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "logo_url")]
    pub logo_url: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    #[serde(alias = "sort_order")]
    pub sort_order: i32,
    pub status: CatalogStatus,
}

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

/// Request DTO for partial update of a Brand
///
/// 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 PatchBrandDto {
    #[cfg_attr(feature = "validation", validate(length(max = 40)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub code: Option<String>,
    #[cfg_attr(feature = "validation", validate(length(max = 150)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[cfg_attr(feature = "validation", validate(length(max = 500)))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "short_description")]
    pub short_description: Option<String>,
    #[cfg_attr(feature = "validation", validate(length(max = 2000)))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[cfg_attr(feature = "validation", validate(length(max = 500)))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "logo_url")]
    pub logo_url: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "sort_order")]
    pub sort_order: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<CatalogStatus>,
}

impl PatchBrandDto {
    /// Check if any field is set
    pub fn has_changes(&self) -> bool {
        self.code.is_some() || self.name.is_some() || self.short_description.is_some() || self.description.is_some() || self.logo_url.is_some() || self.sort_order.is_some() || self.status.is_some()
    }
}

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

/// Response DTO for Brand 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 BrandResponseDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub code: String,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub name: String,
    pub short_description: Option<String>,
    pub description: Option<String>,
    pub logo_url: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    pub sort_order: i32,
    pub status: CatalogStatus,
    pub metadata: AuditMetadata,
}

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

/// Paginated list response for Brand 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 BrandListResponseDto {
    /// List of items
    pub items: Vec<BrandResponseDto>,
    /// 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 BrandListResponseDto {
    /// Create a new list response from items and pagination info
    pub fn new(items: Vec<BrandResponseDto>, 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 BrandSummaryDto {
    pub id: Uuid,
    pub code: String,
    pub name: String,
    pub short_description: Option<String>,
    pub created_at: Option<DateTime<Utc>>,
}

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

impl From<Brand> for BrandResponseDto {
    fn from(entity: Brand) -> Self {
        Self {
            id: entity.id,
            code: entity.code,
            name: entity.name,
            short_description: entity.short_description,
            description: entity.description,
            logo_url: entity.logo_url,
            sort_order: entity.sort_order,
            status: entity.status,
            metadata: entity.metadata,
        }
    }
}

impl From<Brand> for BrandSummaryDto {
    fn from(entity: Brand) -> Self {
        let created_at = backbone_core::PersistentEntity::created_at(&entity);
        Self {
            id: entity.id,
            code: entity.code,
            name: entity.name,
            short_description: entity.short_description,
            created_at,
        }
    }
}

impl From<CreateBrandDto> for Brand {
    fn from(dto: CreateBrandDto) -> Self {
        Self {
            id: Uuid::new_v4(),
            code: dto.code,
            name: dto.name,
            short_description: dto.short_description,
            description: dto.description,
            logo_url: dto.logo_url,
            sort_order: dto.sort_order,
            status: dto.status,
            metadata: AuditMetadata::default(),
        }
    }
}

impl From<&Brand> for BrandResponseDto {
    fn from(entity: &Brand) -> Self {
        Self {
            id: entity.id.clone(),
            code: entity.code.clone(),
            name: entity.name.clone(),
            short_description: entity.short_description.clone(),
            description: entity.description.clone(),
            logo_url: entity.logo_url.clone(),
            sort_order: entity.sort_order.clone(),
            status: entity.status.clone(),
            metadata: entity.metadata.clone(),
        }
    }
}

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

impl backbone_core::ApplyUpdateDto<UpdateBrandDto> for Brand {
    fn apply_update(mut self, dto: UpdateBrandDto) -> backbone_core::ServiceResult<Self> {
        self.code = dto.code;
        self.name = dto.name;
        self.short_description = dto.short_description;
        self.description = dto.description;
        self.logo_url = dto.logo_url;
        self.sort_order = dto.sort_order;
        self.status = dto.status;
        Ok(self)
    }
}

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

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