project.py 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316
  1. from datetime import datetime
  2. from pydantic import BaseModel, field_validator
  3. def _validate_project_url(value: str | None) -> str | None:
  4. """Reject anything that isn't an http(s) URL — the URL is rendered as a
  5. clickable `<a href>` so a `javascript:` / `data:` / `file:` value would be
  6. an XSS vector even with React's default escaping (#1155)."""
  7. if value is None:
  8. return value
  9. trimmed = value.strip()
  10. if not trimmed:
  11. return None
  12. lowered = trimmed.lower()
  13. if not (lowered.startswith("http://") or lowered.startswith("https://")):
  14. raise ValueError("url must start with http:// or https://")
  15. return trimmed
  16. class ProjectCreate(BaseModel):
  17. """Schema for creating a new project."""
  18. name: str
  19. description: str | None = None
  20. color: str | None = None
  21. target_count: int | None = None
  22. target_parts_count: int | None = None
  23. target_sets: int | None = None # Copies-per-file target (#1897)
  24. notes: str | None = None
  25. tags: str | None = None
  26. due_date: datetime | None = None
  27. priority: str = "normal"
  28. budget: float | None = None
  29. parent_id: int | None = None # For sub-projects
  30. url: str | None = None
  31. @field_validator("url")
  32. @classmethod
  33. def _check_url(cls, v: str | None) -> str | None:
  34. return _validate_project_url(v)
  35. class ProjectUpdate(BaseModel):
  36. """Schema for updating a project."""
  37. name: str | None = None
  38. description: str | None = None
  39. color: str | None = None
  40. status: str | None = None # active, completed, archived
  41. target_count: int | None = None
  42. target_parts_count: int | None = None
  43. target_sets: int | None = None # Copies-per-file target (#1897)
  44. notes: str | None = None
  45. tags: str | None = None
  46. due_date: datetime | None = None
  47. priority: str | None = None
  48. budget: float | None = None
  49. parent_id: int | None = None
  50. url: str | None = None
  51. @field_validator("url")
  52. @classmethod
  53. def _check_url(cls, v: str | None) -> str | None:
  54. return _validate_project_url(v)
  55. class ProjectStats(BaseModel):
  56. """Statistics for a project."""
  57. total_archives: int = 0 # Number of archive records
  58. total_items: int = 0 # Sum of quantities (total items printed)
  59. completed_prints: int = 0 # Sum of quantities for completed prints
  60. failed_prints: int = 0 # Sum of quantities for failed prints
  61. queued_prints: int = 0
  62. in_progress_prints: int = 0
  63. total_print_time_hours: float = 0.0
  64. total_filament_grams: float = 0.0
  65. progress_percent: float | None = None # Based on target_count (plates)
  66. parts_progress_percent: float | None = None # Based on target_parts_count
  67. # Cost tracking (Phase 6)
  68. estimated_cost: float = 0.0 # Based on filament cost
  69. total_energy_kwh: float = 0.0
  70. total_energy_cost: float = 0.0
  71. remaining_prints: int | None = None # target_count - total_archives
  72. remaining_parts: int | None = None # target_parts_count - completed_prints
  73. # BOM stats (Phase 7)
  74. bom_total_items: int = 0
  75. bom_completed_items: int = 0
  76. bom_cost: float = 0.0 # Total cost of BOM items (sum of unit_price * quantity_needed)
  77. class ProjectChildPreview(BaseModel):
  78. """Minimal project data for child preview."""
  79. id: int
  80. name: str
  81. color: str | None
  82. status: str
  83. progress_percent: float | None = None
  84. class ProjectResponse(BaseModel):
  85. """Schema for project response."""
  86. id: int
  87. name: str
  88. description: str | None
  89. color: str | None
  90. status: str
  91. target_count: int | None
  92. target_parts_count: int | None = None
  93. target_sets: int | None = None # Copies-per-file target (#1897)
  94. notes: str | None = None
  95. attachments: list | None = None
  96. tags: str | None = None
  97. due_date: datetime | None = None
  98. priority: str = "normal"
  99. budget: float | None = None
  100. is_template: bool = False
  101. template_source_id: int | None = None
  102. parent_id: int | None = None
  103. parent_name: str | None = None # For display
  104. children: list[ProjectChildPreview] = []
  105. created_at: datetime
  106. updated_at: datetime
  107. stats: ProjectStats | None = None
  108. url: str | None = None
  109. cover_image_filename: str | None = None
  110. class Config:
  111. from_attributes = True
  112. class ProjectFileProgress(BaseModel):
  113. """Completed-run count for one library file inside a project (#1897)."""
  114. file_id: int
  115. completed_count: int
  116. class ArchivePreview(BaseModel):
  117. """Minimal archive data for project preview."""
  118. id: int
  119. print_name: str | None
  120. thumbnail_path: str | None
  121. status: str
  122. filament_type: str | None = None
  123. filament_color: str | None = None
  124. class ProjectListResponse(BaseModel):
  125. """Schema for project list item (lighter weight)."""
  126. id: int
  127. name: str
  128. description: str | None
  129. color: str | None
  130. status: str
  131. target_count: int | None
  132. target_parts_count: int | None = None
  133. target_sets: int | None = None # Copies-per-file target (#1897); the shared edit dialog needs it
  134. budget: float | None = None
  135. # The edit dialog is shared with the project detail page and seeds its fields
  136. # from whichever project object it is handed, so the list payload has to carry
  137. # everything the dialog edits — otherwise a save from the list view submits a
  138. # blank tags field and a default priority over the stored values (#2536).
  139. tags: str | None = None
  140. due_date: datetime | None = None
  141. priority: str = "normal"
  142. created_at: datetime
  143. # Quick stats
  144. archive_count: int = 0 # Number of print jobs
  145. total_items: int = 0 # Sum of quantities (total items printed, including failed)
  146. completed_count: int = 0 # Sum of quantities for completed prints only
  147. failed_count: int = 0 # Sum of quantities for failed prints
  148. queue_count: int = 0
  149. progress_percent: float | None = None
  150. # Preview of archives (up to 5)
  151. archives: list[ArchivePreview] = []
  152. # #1155: card-level metadata
  153. url: str | None = None
  154. cover_image_filename: str | None = None
  155. class Config:
  156. from_attributes = True
  157. class BatchAddArchives(BaseModel):
  158. """Schema for batch adding archives to a project."""
  159. archive_ids: list[int]
  160. class BatchAddQueueItems(BaseModel):
  161. """Schema for batch adding queue items to a project."""
  162. queue_item_ids: list[int]
  163. # Phase 7: BOM Schemas - Tracks sourced/purchased parts
  164. class BOMItemCreate(BaseModel):
  165. """Schema for creating a BOM item."""
  166. name: str
  167. quantity_needed: int = 1
  168. unit_price: float | None = None
  169. sourcing_url: str | None = None
  170. archive_id: int | None = None
  171. stl_filename: str | None = None
  172. remarks: str | None = None
  173. class BOMItemUpdate(BaseModel):
  174. """Schema for updating a BOM item."""
  175. name: str | None = None
  176. quantity_needed: int | None = None
  177. quantity_acquired: int | None = None
  178. unit_price: float | None = None
  179. sourcing_url: str | None = None
  180. archive_id: int | None = None
  181. stl_filename: str | None = None
  182. remarks: str | None = None
  183. class BOMItemResponse(BaseModel):
  184. """Schema for BOM item response."""
  185. id: int
  186. project_id: int
  187. name: str
  188. quantity_needed: int
  189. quantity_acquired: int
  190. unit_price: float | None
  191. sourcing_url: str | None
  192. archive_id: int | None
  193. archive_name: str | None = None
  194. stl_filename: str | None
  195. remarks: str | None
  196. sort_order: int
  197. is_complete: bool = False
  198. created_at: datetime
  199. updated_at: datetime
  200. class Config:
  201. from_attributes = True
  202. # Phase 9: Timeline Schemas
  203. class TimelineEvent(BaseModel):
  204. """Schema for a timeline event."""
  205. event_type: str # archive_added, queue_started, queue_completed, status_changed, note_updated
  206. timestamp: datetime
  207. title: str
  208. description: str | None = None
  209. metadata: dict | None = None # Additional event-specific data
  210. # Phase 10: Import/Export Schemas
  211. class BOMItemExport(BaseModel):
  212. """Schema for exporting a BOM item."""
  213. name: str
  214. quantity_needed: int
  215. quantity_acquired: int
  216. unit_price: float | None
  217. sourcing_url: str | None
  218. stl_filename: str | None
  219. remarks: str | None
  220. class LinkedFolderExport(BaseModel):
  221. """Schema for exporting a linked library folder."""
  222. name: str
  223. class ProjectExport(BaseModel):
  224. """Schema for exporting a project."""
  225. name: str
  226. description: str | None
  227. color: str | None
  228. status: str
  229. target_count: int | None
  230. target_parts_count: int | None
  231. target_sets: int | None = None
  232. notes: str | None
  233. tags: str | None
  234. due_date: datetime | None
  235. priority: str
  236. budget: float | None
  237. bom_items: list[BOMItemExport] = []
  238. linked_folders: list[LinkedFolderExport] = []
  239. class ProjectImport(BaseModel):
  240. """Schema for importing a project."""
  241. name: str
  242. description: str | None = None
  243. color: str | None = None
  244. status: str = "active"
  245. target_count: int | None = None
  246. target_parts_count: int | None = None
  247. target_sets: int | None = None
  248. notes: str | None = None
  249. tags: str | None = None
  250. due_date: datetime | None = None
  251. priority: str = "normal"
  252. budget: float | None = None
  253. bom_items: list[BOMItemExport] = []
  254. linked_folders: list[LinkedFolderExport] = []