orion/models/database/inventory_transaction.py

# models/database/inventory_transaction.py
"""
Inventory Transaction Model - Audit trail for all stock movements.

This model tracks every change to inventory quantities, providing:
- Complete audit trail for compliance and debugging
- Order-linked transactions for traceability
- Support for different transaction types (reserve, fulfill, adjust, etc.)

All stock movements should create a transaction record.
"""

from datetime import UTC, datetime
from enum import Enum

from sqlalchemy import (
    Column,
    DateTime,
    Enum as SQLEnum,
    ForeignKey,
    Index,
    Integer,
    String,
    Text,
)
from sqlalchemy.orm import relationship

from app.core.database import Base


class TransactionType(str, Enum):
    """Types of inventory transactions."""

    # Order-related
    RESERVE = "reserve"  # Stock reserved for order
    FULFILL = "fulfill"  # Reserved stock consumed (shipped)
    RELEASE = "release"  # Reserved stock released (cancelled)

    # Manual adjustments
    ADJUST = "adjust"  # Manual adjustment (+/-)
    SET = "set"  # Set to exact quantity

    # Imports
    IMPORT = "import"  # Initial import/sync

    # Returns
    RETURN = "return"  # Stock returned from customer


class InventoryTransaction(Base):
    """
    Audit log for inventory movements.

    Every change to inventory quantity creates a transaction record,
    enabling complete traceability of stock levels over time.
    """

    __tablename__ = "inventory_transactions"

    id = Column(Integer, primary_key=True, index=True)

    # Core references
    vendor_id = Column(Integer, ForeignKey("vendors.id"), nullable=False, index=True)
    product_id = Column(Integer, ForeignKey("products.id"), nullable=False, index=True)
    inventory_id = Column(
        Integer, ForeignKey("inventory.id"), nullable=True, index=True
    )

    # Transaction details
    transaction_type = Column(
        SQLEnum(TransactionType), nullable=False, index=True
    )
    quantity_change = Column(Integer, nullable=False)  # Positive = add, negative = remove

    # Quantities after transaction (snapshot)
    quantity_after = Column(Integer, nullable=False)
    reserved_after = Column(Integer, nullable=False, default=0)

    # Location context
    location = Column(String, nullable=True)
    warehouse = Column(String, nullable=True)

    # Order reference (for order-related transactions)
    order_id = Column(Integer, ForeignKey("orders.id"), nullable=True, index=True)
    order_number = Column(String, nullable=True)

    # Audit fields
    reason = Column(Text, nullable=True)  # Human-readable reason
    created_by = Column(String, nullable=True)  # User/system that created
    created_at = Column(
        DateTime(timezone=True),
        default=lambda: datetime.now(UTC),
        nullable=False,
        index=True,
    )

    # Relationships
    vendor = relationship("Vendor")
    product = relationship("Product")
    inventory = relationship("Inventory")
    order = relationship("Order")

    # Indexes for common queries
    __table_args__ = (
        Index("idx_inv_tx_vendor_product", "vendor_id", "product_id"),
        Index("idx_inv_tx_vendor_created", "vendor_id", "created_at"),
        Index("idx_inv_tx_order", "order_id"),
        Index("idx_inv_tx_type_created", "transaction_type", "created_at"),
    )

    def __repr__(self) -> str:
        return (
            f"<InventoryTransaction {self.id}: "
            f"{self.transaction_type.value} {self.quantity_change:+d} "
            f"for product {self.product_id}>"
        )

    @classmethod
    def create_transaction(
        cls,
        vendor_id: int,
        product_id: int,
        transaction_type: TransactionType,
        quantity_change: int,
        quantity_after: int,
        reserved_after: int = 0,
        inventory_id: int | None = None,
        location: str | None = None,
        warehouse: str | None = None,
        order_id: int | None = None,
        order_number: str | None = None,
        reason: str | None = None,
        created_by: str | None = None,
    ) -> "InventoryTransaction":
        """
        Factory method to create a transaction record.

        Args:
            vendor_id: Vendor ID
            product_id: Product ID
            transaction_type: Type of transaction
            quantity_change: Change in quantity (positive = add, negative = remove)
            quantity_after: Total quantity after this transaction
            reserved_after: Reserved quantity after this transaction
            inventory_id: Optional inventory record ID
            location: Optional location
            warehouse: Optional warehouse
            order_id: Optional order ID (for order-related transactions)
            order_number: Optional order number for display
            reason: Optional human-readable reason
            created_by: Optional user/system identifier

        Returns:
            InventoryTransaction instance (not yet added to session)
        """
        return cls(
            vendor_id=vendor_id,
            product_id=product_id,
            inventory_id=inventory_id,
            transaction_type=transaction_type,
            quantity_change=quantity_change,
            quantity_after=quantity_after,
            reserved_after=reserved_after,
            location=location,
            warehouse=warehouse,
            order_id=order_id,
            order_number=order_number,
            reason=reason,
            created_by=created_by,
        )