backbone-inventory 0.17.2

Inventory: stock ledger of record (SLE) + moving-average valuation; emits COGS/asset AccountingPost (Delivery/Receipt -> GL)
Documentation
//! StockReconciliationItem 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::StockReconciliationItem;
use crate::domain::entity::AuditMetadata;

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

/// Request DTO for creating a new StockReconciliationItem
///
/// 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 CreateStockReconciliationItemDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "reconciliation_id")]
    pub reconciliation_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "item_id")]
    pub item_id: Uuid,
    #[serde(alias = "counted_qty")]
    pub counted_qty: Decimal,
    #[serde(alias = "counted_rate")]
    pub counted_rate: Decimal,
    #[serde(alias = "qty_difference")]
    pub qty_difference: Decimal,
    #[serde(alias = "value_difference")]
    pub value_difference: Decimal,
}

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

/// Request DTO for full update of a StockReconciliationItem
///
/// 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 UpdateStockReconciliationItemDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "reconciliation_id")]
    pub reconciliation_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "item_id")]
    pub item_id: Uuid,
    #[serde(alias = "counted_qty")]
    pub counted_qty: Decimal,
    #[serde(alias = "counted_rate")]
    pub counted_rate: Decimal,
    #[serde(alias = "qty_difference")]
    pub qty_difference: Decimal,
    #[serde(alias = "value_difference")]
    pub value_difference: Decimal,
}

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

/// Request DTO for partial update of a StockReconciliationItem
///
/// 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 PatchStockReconciliationItemDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "reconciliation_id")]
    pub reconciliation_id: Option<Uuid>,
    #[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>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "counted_qty")]
    pub counted_qty: Option<Decimal>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "counted_rate")]
    pub counted_rate: Option<Decimal>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "qty_difference")]
    pub qty_difference: Option<Decimal>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "value_difference")]
    pub value_difference: Option<Decimal>,
}

impl PatchStockReconciliationItemDto {
    /// Check if any field is set
    pub fn has_changes(&self) -> bool {
        self.reconciliation_id.is_some() || self.item_id.is_some() || self.counted_qty.is_some() || self.counted_rate.is_some() || self.qty_difference.is_some() || self.value_difference.is_some()
    }
}

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

/// Response DTO for StockReconciliationItem 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 StockReconciliationItemResponseDto {
    #[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 reconciliation_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub item_id: Uuid,
    pub counted_qty: Decimal,
    pub counted_rate: Decimal,
    pub qty_difference: Decimal,
    pub value_difference: Decimal,
    pub metadata: AuditMetadata,
}

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

/// Paginated list response for StockReconciliationItem 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 StockReconciliationItemListResponseDto {
    /// List of items
    pub items: Vec<StockReconciliationItemResponseDto>,
    /// 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 StockReconciliationItemListResponseDto {
    /// Create a new list response from items and pagination info
    pub fn new(items: Vec<StockReconciliationItemResponseDto>, 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 StockReconciliationItemSummaryDto {
    pub id: Uuid,
    pub reconciliation_id: Uuid,
    pub item_id: Uuid,
    pub counted_qty: Decimal,
    pub created_at: Option<DateTime<Utc>>,
}

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

impl From<StockReconciliationItem> for StockReconciliationItemResponseDto {
    fn from(entity: StockReconciliationItem) -> Self {
        Self {
            id: entity.id,
            reconciliation_id: entity.reconciliation_id,
            item_id: entity.item_id,
            counted_qty: entity.counted_qty,
            counted_rate: entity.counted_rate,
            qty_difference: entity.qty_difference,
            value_difference: entity.value_difference,
            metadata: entity.metadata,
        }
    }
}

impl From<StockReconciliationItem> for StockReconciliationItemSummaryDto {
    fn from(entity: StockReconciliationItem) -> Self {
        let created_at = backbone_core::PersistentEntity::created_at(&entity);
        Self {
            id: entity.id,
            reconciliation_id: entity.reconciliation_id,
            item_id: entity.item_id,
            counted_qty: entity.counted_qty,
            created_at,
        }
    }
}

impl From<CreateStockReconciliationItemDto> for StockReconciliationItem {
    fn from(dto: CreateStockReconciliationItemDto) -> Self {
        Self {
            id: Uuid::new_v4(),
            reconciliation_id: dto.reconciliation_id,
            item_id: dto.item_id,
            counted_qty: dto.counted_qty,
            counted_rate: dto.counted_rate,
            qty_difference: dto.qty_difference,
            value_difference: dto.value_difference,
            metadata: AuditMetadata::default(),
        }
    }
}

impl From<&StockReconciliationItem> for StockReconciliationItemResponseDto {
    fn from(entity: &StockReconciliationItem) -> Self {
        Self {
            id: entity.id.clone(),
            reconciliation_id: entity.reconciliation_id.clone(),
            item_id: entity.item_id.clone(),
            counted_qty: entity.counted_qty.clone(),
            counted_rate: entity.counted_rate.clone(),
            qty_difference: entity.qty_difference.clone(),
            value_difference: entity.value_difference.clone(),
            metadata: entity.metadata.clone(),
        }
    }
}

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

impl backbone_core::ApplyUpdateDto<UpdateStockReconciliationItemDto> for StockReconciliationItem {
    fn apply_update(mut self, dto: UpdateStockReconciliationItemDto) -> backbone_core::ServiceResult<Self> {
        self.reconciliation_id = dto.reconciliation_id;
        self.item_id = dto.item_id;
        self.counted_qty = dto.counted_qty;
        self.counted_rate = dto.counted_rate;
        self.qty_difference = dto.qty_difference;
        self.value_difference = dto.value_difference;
        Ok(self)
    }
}

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

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