monkeybrain-runtime 1.0.0__py3-none-any.whl

services/pm/models/calibrations.py

@@ -0,0 +1,167 @@
+from datetime import date, datetime, timedelta
+from typing import Optional, Literal, List
+from pydantic import BaseModel, Field, model_validator
+
+from services.pm.models.calibration_point import CalibrationPoint
+from services.auth.models.users import UserEntry
+
+# ─────────────────────────────────────────────
+# LITERALS
+# ─────────────────────────────────────────────
+
+CalibrationStatus = Literal[
+    "Scheduled",
+    "In Progress",
+    "Completed",
+    "Passed",
+    "Failed",
+    "Overdue",
+    "Cancelled",
+]
+
+CalibrationType = Literal[
+    "Routine",
+    "Post-Repair",
+    "Validation",
+    "Verification",
+    "Emergency",
+]
+
+CalibrationStandard = Literal[
+    "NIST",
+    "ISO 17025",
+    "USP",
+    "EP",
+    "In-House",
+    "OEM",
+    "Other",
+]
+
+# ─────────────────────────────────────────────
+# BASE
+# ─────────────────────────────────────────────
+
+class CalibrationRecord(BaseModel):
+    record_id:                 str               = Field(..., min_length=1)
+    equipment_id:                str               = Field(..., min_length=1)
+    work_order_id:             Optional[str]     = None
+    instrument_tag:            Optional[str]     = None
+    instrument_range:          Optional[str]     = None
+    instrument_resolution:     Optional[str]     = None
+    calibration_type:          CalibrationType
+    status:                    CalibrationStatus = "Scheduled"
+    standard_used:             CalibrationStandard = "In-House"
+    certificate_no:            Optional[str]     = None
+    scheduled_date:            Optional[date]    = None
+    performed_date:            Optional[date]    = None
+    next_due_date:             Optional[date]    = None
+    calibration_interval_days: Optional[int]     = Field(None, gt=0)
+    performed_by:              Optional[str]        = None
+    reviewed_by:               Optional[str]        = None
+    approved_by:               Optional[str]        = None
+    reference_instrument:      Optional[str]     = None
+    reference_cert_no:         Optional[str]     = None
+    reference_expiry:          Optional[date]    = None
+    data_points:               List[CalibrationPoint] = Field(default_factory=list)
+    tolerance:                 Optional[float]   = Field(None, ge=0)
+    max_deviation_found:       Optional[float]   = None
+    unit:                      Optional[str]     = None
+    room_temp_celsius:         Optional[float]   = None
+    room_humidity_pct:         Optional[float]   = Field(None, ge=0, le=100)
+    out_of_tolerance:          bool              = False
+    corrective_action:         Optional[str]     = None
+    as_found_condition:        Optional[str]     = None
+    as_left_condition:         Optional[str]     = None
+    remarks:                   Optional[str]     = None
+    attachments:               List[str]         = Field(default_factory=list)
+    created_at:                datetime          = Field(default_factory=datetime.utcnow)
+    updated_at:                datetime          = Field(default_factory=datetime.utcnow)
+
+    @model_validator(mode="after")
+    def compute_max_deviation(self):
+        if self.data_points:
+            deviations = [abs(dp.deviation) for dp in self.data_points if dp.deviation is not None]
+            if deviations:
+                self.max_deviation_found = round(max(deviations), 6)
+        return self
+
+    @model_validator(mode="after")
+    def flag_out_of_tolerance(self):
+        if self.max_deviation_found is not None and self.tolerance is not None:
+            if self.max_deviation_found > self.tolerance:
+                self.out_of_tolerance = True
+        return self
+
+    @model_validator(mode="after")
+    def next_due_after_performed(self):
+        if self.performed_date and self.next_due_date:
+            if self.next_due_date <= self.performed_date:
+                raise ValueError("'next_due_date' must be after 'performed_date'.")
+        return self
+
+    @model_validator(mode="after")
+    def auto_next_due_date(self):
+        if self.performed_date and self.calibration_interval_days and not self.next_due_date:
+            self.next_due_date = self.performed_date + timedelta(days=self.calibration_interval_days)
+        return self
+
+    @model_validator(mode="after")
+    def passed_requires_data_points(self):
+        if self.status == "Passed" and not self.data_points:
+            raise ValueError("Status 'Passed' requires at least one calibration data point.")
+        return self
+
+# ─────────────────────────────────────────────
+# CREATE
+# ─────────────────────────────────────────────
+
+class CalibrationRecordCreate(CalibrationRecord):
+    pass
+
+# ─────────────────────────────────────────────
+# UPDATE
+# ─────────────────────────────────────────────
+
+class CalibrationRecordUpdate(BaseModel):
+    calibration_type:          Optional[CalibrationType]        = None
+    status:                    Optional[CalibrationStatus]      = None
+    standard_used:             Optional[CalibrationStandard]    = None
+    certificate_no:            Optional[str]                    = None
+    instrument_tag:            Optional[str]                    = None
+    instrument_range:          Optional[str]                    = None
+    instrument_resolution:     Optional[str]                    = None
+    scheduled_date:            Optional[date]                   = None
+    performed_date:            Optional[date]                   = None
+    next_due_date:             Optional[date]                   = None
+    calibration_interval_days: Optional[int]                    = Field(None, gt=0)
+    performed_by:              Optional[UserEntry]         = None
+    reviewed_by:               Optional[UserEntry]         = None
+    approved_by:               Optional[UserEntry]         = None
+    reference_instrument:      Optional[str]                    = None
+    reference_cert_no:         Optional[str]                    = None
+    reference_expiry:          Optional[date]                   = None
+    data_points:               Optional[List[CalibrationPoint]] = None
+    tolerance:                 Optional[float]                  = Field(None, ge=0)
+    unit:                      Optional[str]                    = None
+    room_temp_celsius:         Optional[float]                  = None
+    room_humidity_pct:         Optional[float]                  = Field(None, ge=0, le=100)
+    corrective_action:         Optional[str]                    = None
+    as_found_condition:        Optional[str]                    = None
+    as_left_condition:         Optional[str]                    = None
+    remarks:                   Optional[str]                    = None
+    attachments:               Optional[List[str]]              = None
+    updated_at:                datetime                         = Field(default_factory=datetime.utcnow)
+
+# ─────────────────────────────────────────────
+# RESPONSE & PAGINATION
+# ─────────────────────────────────────────────
+
+class CalibrationRecordResponse(CalibrationRecord):
+    class Config:
+        from_attributes = True
+
+class PaginatedCalibrationResponse(BaseModel):
+    total:     int
+    page:      int
+    page_size: int
+    results:   List[CalibrationRecordResponse]

services/pm/models/checklists.py

@@ -0,0 +1,117 @@
+from __future__ import annotations
+
+from datetime import datetime, timezone
+from typing import Optional
+
+from pydantic import BaseModel, Field, model_validator
+
+
+def utc_now() -> datetime:
+    return datetime.now(timezone.utc)
+
+
+def ensure_utc(dt: Optional[datetime]) -> Optional[datetime]:
+    if dt is None:
+        return None
+    if dt.tzinfo is None:
+        return dt.replace(tzinfo=timezone.utc)
+    return dt.astimezone(timezone.utc)
+
+
+class ChecklistItem(BaseModel):
+    item_id: str = Field(..., min_length=1)
+    work_order_id: str = Field(..., min_length=1)
+    title: str = Field(..., min_length=1)
+    description: Optional[str] = None
+    assigned_to: Optional[str] = None
+    due_at: Optional[datetime] = None
+    is_completed: bool = False
+    completed_at: Optional[datetime] = None
+    created_at: datetime = Field(default_factory=utc_now)
+    updated_at: datetime = Field(default_factory=utc_now)
+
+    @model_validator(mode="after")
+    def normalize_and_validate(self) -> "ChecklistItem":
+        self.due_at = ensure_utc(self.due_at)
+        self.completed_at = ensure_utc(self.completed_at)
+        self.created_at = ensure_utc(self.created_at)
+        self.updated_at = ensure_utc(self.updated_at)
+        if self.completed_at and not self.is_completed:
+            raise ValueError("completed_at can only be set when is_completed is true")
+        if self.is_completed and self.completed_at is None:
+            self.completed_at = utc_now()
+        return self
+
+
+class ChecklistItemCreate(ChecklistItem):
+    pass
+
+
+class ChecklistItemUpdate(BaseModel):
+    work_order_id: Optional[str] = Field(None, min_length=1)
+    title: Optional[str] = Field(None, min_length=1)
+    description: Optional[str] = None
+    assigned_to: Optional[str] = None
+    due_at: Optional[datetime] = None
+    is_completed: Optional[bool] = None
+    completed_at: Optional[datetime] = None
+    updated_at: datetime = Field(default_factory=utc_now)
+
+    @model_validator(mode="after")
+    def normalize_datetimes(self) -> "ChecklistItemUpdate":
+        self.due_at = ensure_utc(self.due_at)
+        self.completed_at = ensure_utc(self.completed_at)
+        self.updated_at = ensure_utc(self.updated_at)
+        return self
+
+
+class Checklist(BaseModel):
+    checklist_id: str = Field(..., min_length=1)
+    title: str = Field(..., min_length=1)
+    description: Optional[str] = None
+    owner_id: Optional[str] = None
+    process_definition_id: Optional[str] = None
+    tags: list[str] = Field(default_factory=list)
+    items: list[ChecklistItem] = Field(default_factory=list)
+    is_archived: bool = False
+    created_at: datetime = Field(default_factory=utc_now)
+    updated_at: datetime = Field(default_factory=utc_now)
+
+    @model_validator(mode="after")
+    def normalize_datetimes(self) -> "Checklist":
+        self.created_at = ensure_utc(self.created_at)
+        self.updated_at = ensure_utc(self.updated_at)
+        return self
+
+
+class ChecklistCreate(Checklist):
+    pass
+
+
+class ChecklistUpdate(BaseModel):
+    title: Optional[str] = Field(None, min_length=1)
+    description: Optional[str] = None
+    owner_id: Optional[str] = None
+    work_order_id: Optional[str] = None
+    process_definition_id: Optional[str] = None
+    tags: Optional[list[str]] = None
+    items: Optional[list[ChecklistItem]] = None
+    is_archived: Optional[bool] = None
+    updated_at: datetime = Field(default_factory=utc_now)
+
+    @model_validator(mode="after")
+    def normalize_datetimes(self) -> "ChecklistUpdate":
+        self.updated_at = ensure_utc(self.updated_at)
+        return self
+
+
+class ChecklistResponse(Checklist):
+    class Config:
+        from_attributes = True
+
+
+class PaginatedChecklistResponse(BaseModel):
+    total: int
+    page: int
+    page_size: int
+    results: list[ChecklistResponse]

services/pm/models/cleaning.py

@@ -0,0 +1,203 @@
+from datetime import date, datetime
+from typing import Optional, Literal, List
+from pydantic import BaseModel, Field, model_validator
+
+from services.assets.models.material import MaterialUsed
+from services.auth.models.users import UserEntry
+
+# ─────────────────────────────────────────────
+# LITERALS
+# ─────────────────────────────────────────────
+
+CleaningStatus = Literal[
+    "Scheduled",
+    "In Progress",
+    "Completed",
+    "Verified",
+    "Failed",
+    "Cancelled",
+    "Pre-Production",
+    "Post-Production"
+]
+
+CleaningMethod = Literal[
+    "CIP",
+    "COP",
+    "Manual",
+    "Automated",
+    "Spray Wash",
+    "Ultrasonic",
+    "Other",
+]
+
+CleaningType = Literal[
+    "Routine",
+    "Deep Clean",
+    "Post-Production",
+    "Pre-Production",
+    "Changeover",
+    "Validation",
+    "Sanitization"
+]
+
+VerificationMethod = Literal[
+    "Visual Inspection",
+    "Swab Test",
+    "Rinse Sample",
+    "TOC Analysis",
+    "HPLC",
+    "pH Test",
+    "Conductivity",
+    "None",
+]
+
+# ─────────────────────────────────────────────
+# BASE
+# ─────────────────────────────────────────────
+
+class CleaningRecord(BaseModel):
+    record_id:             str              = Field(..., min_length=1)
+    equipment_id:            str              = Field(..., min_length=1)
+    work_order_id:         Optional[str]    = None
+    batch_execution_record_id: Optional[str] = None
+    batch_id:              Optional[str]    = None
+    process_definition_id: Optional[str]    = None
+    process_step_id:       Optional[str]    = None
+    instruction_template_id: Optional[str]  = None
+    instruction_step_sequence: Optional[int] = Field(default=None, ge=1)
+    cleaning_requirement_id: Optional[str]  = None
+    cleaning_type:         CleaningType
+    cleaning_method:       CleaningMethod
+    status:                CleaningStatus   = "Scheduled"
+    scheduled_start:       Optional[datetime] = None
+    scheduled_end:         Optional[datetime] = None
+    actual_start:          Optional[datetime] = None
+    actual_end:            Optional[datetime] = None
+    performed_by:          Optional[str] = None
+    verified_by:           Optional[str] = None
+    approved_by:           Optional[str] = None
+    chemicals_used:        List[MaterialUsed]   = Field(default_factory=list)
+    water_type:            Optional[str]    = None
+    water_volume_liters:   Optional[float]  = Field(None, gt=0)
+    verification_method:   VerificationMethod = "Visual Inspection"
+    verification_result:   Optional[str]    = None
+    residue_limit_ppm:     Optional[float]  = Field(None, ge=0)
+    residue_found_ppm:     Optional[float]  = Field(None, ge=0)
+    previous_product:      Optional[str]    = None
+    current_product:       Optional[str]    = None
+    batch_no:              Optional[str]    = None
+    room_temp_celsius:     Optional[float]  = None
+    room_humidity_pct:     Optional[float]  = Field(None, ge=0, le=100)
+    remarks:               Optional[str]    = None
+    attachments:           List[str]        = Field(default_factory=list)
+    created_at:            datetime         = Field(default_factory=datetime.utcnow)
+    updated_at:            datetime         = Field(default_factory=datetime.utcnow)
+
+    @model_validator(mode="after")
+    def actual_end_after_start(self):
+        if self.actual_start and self.actual_end:
+            if self.actual_end < self.actual_start:
+                raise ValueError("'actual_end' cannot be before 'actual_start'.")
+        return self
+
+    @model_validator(mode="after")
+    def scheduled_end_after_start(self):
+        if self.scheduled_start and self.scheduled_end:
+            if self.scheduled_end < self.scheduled_start:
+                raise ValueError("'scheduled_end' cannot be before 'scheduled_start'.")
+        return self
+
+    @model_validator(mode="after")
+    def residue_within_limit(self):
+        if (
+            self.residue_found_ppm is not None
+            and self.residue_limit_ppm is not None
+            and self.status == "Verified"
+        ):
+            if self.residue_found_ppm > self.residue_limit_ppm:
+                raise ValueError(
+                    f"Residue found ({self.residue_found_ppm} ppm) exceeds limit "
+                    f"({self.residue_limit_ppm} ppm) — cannot mark as Verified."
+                )
+        return self
+
+    @model_validator(mode="after")
+    def verified_required_cleaning_has_gmp_evidence(self):
+        if self.status == "Verified" and self.cleaning_requirement_id:
+            missing = []
+            if not self.actual_start or not self.actual_end:
+                missing.append("actual_start/actual_end")
+            if not self.performed_by:
+                missing.append("performed_by")
+            if not self.verified_by:
+                missing.append("verified_by")
+            if not self.approved_by:
+                missing.append("approved_by")
+            if not self.attachments:
+                missing.append("attachments")
+            if self.verification_result != "Pass":
+                missing.append("verification_result=Pass")
+            if missing:
+                raise ValueError(f"verified required cleaning records must include {', '.join(missing)}.")
+        return self
+
+# ─────────────────────────────────────────────
+# CREATE
+# ─────────────────────────────────────────────
+
+class CleaningRecordCreate(CleaningRecord):
+    pass
+
+# ─────────────────────────────────────────────
+# UPDATE
+# ─────────────────────────────────────────────
+
+class CleaningRecordUpdate(BaseModel):
+    equipment_id:           Optional[str]                  = None
+    work_order_id:          Optional[str]                  = None
+    batch_execution_record_id: Optional[str]               = None
+    batch_id:               Optional[str]                  = None
+    process_definition_id:  Optional[str]                  = None
+    process_step_id:        Optional[str]                  = None
+    instruction_template_id: Optional[str]                 = None
+    instruction_step_sequence: Optional[int]               = Field(default=None, ge=1)
+    cleaning_requirement_id: Optional[str]                 = None
+    cleaning_type:        Optional[CleaningType]         = None
+    cleaning_method:      Optional[CleaningMethod]       = None
+    status:               Optional[CleaningStatus]       = None
+    scheduled_start:      Optional[datetime]             = None
+    scheduled_end:        Optional[datetime]             = None
+    actual_start:         Optional[datetime]             = None
+    actual_end:           Optional[datetime]             = None
+    performed_by:         Optional[List[UserEntry]] = None
+    verified_by:          Optional[UserEntry]       = None
+    approved_by:          Optional[UserEntry]       = None
+    chemicals_used:       Optional[List[MaterialUsed]]   = None
+    water_type:           Optional[str]                  = None
+    water_volume_liters:  Optional[float]                = Field(None, gt=0)
+    verification_method:  Optional[VerificationMethod]   = None
+    verification_result:  Optional[str]                  = None
+    residue_limit_ppm:    Optional[float]                = Field(None, ge=0)
+    residue_found_ppm:    Optional[float]                = Field(None, ge=0)
+    previous_product:     Optional[str]                  = None
+    next_product:         Optional[str]                  = None
+    batch_no:             Optional[str]                  = None
+    room_temp_celsius:    Optional[float]                = None
+    room_humidity_pct:    Optional[float]                = Field(None, ge=0, le=100)
+    remarks:              Optional[str]                  = None
+    attachments:          Optional[List[str]]            = None
+    updated_at:           datetime                       = Field(default_factory=datetime.utcnow)
+
+# ─────────────────────────────────────────────
+# RESPONSE & PAGINATION
+# ─────────────────────────────────────────────
+
+class CleaningRecordResponse(CleaningRecord):
+    class Config:
+        from_attributes = True
+
+class PaginatedCleaningRecordResponse(BaseModel):
+    total:     int
+    page:      int
+    page_size: int
+    results:   List[CleaningRecordResponse]

services/pm/models/downtime.py

@@ -0,0 +1,109 @@
+from pydantic import BaseModel, Field, field_validator, model_validator
+from typing import Optional
+from datetime import datetime
+from enum import Enum
+import uuid
+
+# ─────────────────────────────────────────────
+# ENUMS (match your TS types)
+# ─────────────────────────────────────────────
+
+class DowntimeCategory(str, Enum):
+    MECHANICAL_FAILURE = "Mechanical Failure"
+    ELECTRICAL_FAULT = "Electrical Fault"
+    PLANNED_MAINTENANCE = "Planned Maintenance"
+    SOFTWARE_ERROR = "Software Error"
+    OPERATOR_ERROR = "Operator Error"
+    MATERIAL_SHORTAGE = "Material Shortage"
+    QUALITY_ISSUE = "Quality Issue"
+    EXTERNAL = "External"
+
+
+class DowntimeStatus(str, Enum):
+    ACTIVE = "Active"
+    RESOLVED = "Resolved"
+    SCHEDULED = "Scheduled"
+
+
+# ─────────────────────────────────────────────
+# MAIN MODEL (DB Model)
+# ─────────────────────────────────────────────
+
+class DowntimeLog(BaseModel):
+    id: str = Field(default_factory=lambda: str(uuid.uuid4()))
+
+    machine_id: Optional[str] = None
+    equipment_id: Optional[str] = None
+    machine_name: Optional[str] = None
+    line_id: Optional[str] = None
+
+    start_time: datetime
+    end_time: Optional[datetime] = None
+
+    duration_minutes: Optional[int] = None  # computed
+
+    category: DowntimeCategory
+    cause: Optional[str] = None
+    status: DowntimeStatus = DowntimeStatus.ACTIVE
+
+    responsible_team: Optional[str] = None
+    linked_work_order: Optional[str] = None
+    linked_maintenance_id: Optional[str] = None
+
+    notes: Optional[str] = None
+
+    created_at: datetime = Field(default_factory=datetime.utcnow)
+    updated_at: Optional[datetime] = None
+
+    # ─────────────────────────────────────────
+    # VALIDATION
+    # ─────────────────────────────────────────
+
+    @model_validator(mode="after")
+    def validate_and_compute(self):
+        # Ensure end_time is after start_time
+        if self.end_time and self.end_time < self.start_time:
+            raise ValueError("end_time must be after start_time")
+
+        # Compute duration
+        if self.start_time and self.end_time:
+            delta = self.end_time - self.start_time
+            self.duration_minutes = int(delta.total_seconds() // 60)
+
+        return self
+    
+
+class DowntimeLogCreate(DowntimeLog):
+    pass
+
+class DowntimeLogUpdate(BaseModel):
+    machine_id: Optional[str] = None
+    equipment_id: Optional[str] = None
+    machine_name: Optional[str] = None
+    line_id: Optional[str] = None
+
+    start_time: datetime
+    end_time: Optional[datetime] = None
+
+    duration_minutes: Optional[int] = None  # computed
+
+    category: DowntimeCategory
+    cause: Optional[str] = None
+    status: DowntimeStatus = DowntimeStatus.ACTIVE
+
+    responsible_team: Optional[str] = None
+    linked_work_order: Optional[str] = None
+    linked_maintenance_id: Optional[str] = None
+
+    notes: Optional[str] = None
+    updated_at: Optional[datetime] = None
+
+class DowntimeLogResponse(DowntimeLog):
+    class Config:
+        from_attributes = True
+
+class PaginatedDowntimeResponse(BaseModel):
+    total: int
+    page: int
+    page_size: int
+    results: list[DowntimeLog]