backbone-inventory 0.17.2

//! Bin DTOs (Data Transfer Objects)
//!
//! Generated by metaphor-schema. Do not edit manually.
//!
//! DTOs provide a clean separation between domain entities and API
//! representations, with OpenAPI documentation support.

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

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

use crate::domain::entity::Bin;
use crate::domain::entity::AuditMetadata;

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

/// Request DTO for creating a new Bin
///
/// 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))]
#[serde(rename_all = "camelCase")]
pub struct CreateBinDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "item_id")]
    pub item_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "warehouse_id")]
    pub warehouse_id: Uuid,
    #[serde(alias = "actual_qty")]
    pub actual_qty: Decimal,
    #[serde(alias = "reserved_qty")]
    pub reserved_qty: Decimal,
    #[serde(alias = "valuation_rate")]
    pub valuation_rate: Decimal,
    #[serde(alias = "stock_value")]
    pub stock_value: Decimal,
}

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

/// Request DTO for full update of a Bin
///
/// 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))]
#[serde(rename_all = "camelCase")]
pub struct UpdateBinDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "item_id")]
    pub item_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "warehouse_id")]
    pub warehouse_id: Uuid,
}

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

/// Request DTO for partial update of a Bin
///
/// 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))]
#[serde(rename_all = "camelCase")]
pub struct PatchBinDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "item_id")]
    pub item_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "warehouse_id")]
    pub warehouse_id: Option<Uuid>,
}

impl PatchBinDto {
    /// Check if any field is set
    pub fn has_changes(&self) -> bool {
        self.item_id.is_some() || self.warehouse_id.is_some()
    }
}

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

/// Response DTO for Bin 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 BinResponseDto {
    #[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 item_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub warehouse_id: Uuid,
    pub actual_qty: Decimal,
    pub reserved_qty: Decimal,
    pub valuation_rate: Decimal,
    pub stock_value: Decimal,
    pub metadata: AuditMetadata,
}

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

/// Paginated list response for Bin 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 BinListResponseDto {
    /// List of items
    pub items: Vec<BinResponseDto>,
    /// 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 BinListResponseDto {
    /// Create a new list response from items and pagination info
    pub fn new(items: Vec<BinResponseDto>, 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 BinSummaryDto {
    pub id: Uuid,
    pub item_id: Uuid,
    pub warehouse_id: Uuid,
    pub actual_qty: Decimal,
    pub created_at: Option<DateTime<Utc>>,
}

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

impl From<Bin> for BinResponseDto {
    fn from(entity: Bin) -> Self {
        Self {
            id: entity.id,
            item_id: entity.item_id,
            warehouse_id: entity.warehouse_id,
            actual_qty: entity.actual_qty,
            reserved_qty: entity.reserved_qty,
            valuation_rate: entity.valuation_rate,
            stock_value: entity.stock_value,
            metadata: entity.metadata,
        }
    }
}

impl From<Bin> for BinSummaryDto {
    fn from(entity: Bin) -> Self {
        let created_at = backbone_core::PersistentEntity::created_at(&entity);
        Self {
            id: entity.id,
            item_id: entity.item_id,
            warehouse_id: entity.warehouse_id,
            actual_qty: entity.actual_qty,
            created_at,
        }
    }
}

impl From<CreateBinDto> for Bin {
    fn from(dto: CreateBinDto) -> Self {
        Self {
            id: Uuid::new_v4(),
            item_id: dto.item_id,
            warehouse_id: dto.warehouse_id,
            actual_qty: dto.actual_qty,
            reserved_qty: dto.reserved_qty,
            valuation_rate: dto.valuation_rate,
            stock_value: dto.stock_value,
            metadata: AuditMetadata::default(),
        }
    }
}

impl From<&Bin> for BinResponseDto {
    fn from(entity: &Bin) -> Self {
        Self {
            id: entity.id.clone(),
            item_id: entity.item_id.clone(),
            warehouse_id: entity.warehouse_id.clone(),
            actual_qty: entity.actual_qty.clone(),
            reserved_qty: entity.reserved_qty.clone(),
            valuation_rate: entity.valuation_rate.clone(),
            stock_value: entity.stock_value.clone(),
            metadata: entity.metadata.clone(),
        }
    }
}

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

impl backbone_core::ApplyUpdateDto<UpdateBinDto> for Bin {
    fn apply_update(mut self, dto: UpdateBinDto) -> backbone_core::ServiceResult<Self> {
        self.item_id = dto.item_id;
        self.warehouse_id = dto.warehouse_id;
        Ok(self)
    }
}

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

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