backbone-bucket 0.4.3

Bucket Bounded Context: File Storage Module for Backbone Framework
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use sqlx::FromRow;
use uuid::Uuid;

use super::VersionType;
use super::FileVersionStatus;
use super::AuditMetadata;

/// Strongly-typed ID for FileVersion
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(transparent)]
pub struct FileVersionId(pub Uuid);

impl FileVersionId {
    pub fn new(id: Uuid) -> Self { Self(id) }
    pub fn generate() -> Self { Self(Uuid::new_v4()) }
    pub fn into_inner(self) -> Uuid { self.0 }
}

impl std::fmt::Display for FileVersionId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl std::str::FromStr for FileVersionId {
    type Err = uuid::Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(Self(Uuid::parse_str(s)?))
    }
}

impl From<Uuid> for FileVersionId {
    fn from(id: Uuid) -> Self { Self(id) }
}

impl From<FileVersionId> for Uuid {
    fn from(id: FileVersionId) -> Self { id.0 }
}

impl AsRef<Uuid> for FileVersionId {
    fn as_ref(&self) -> &Uuid { &self.0 }
}

impl std::ops::Deref for FileVersionId {
    type Target = Uuid;
    fn deref(&self) -> &Self::Target { &self.0 }
}

#[derive(Debug, Clone, Serialize, Deserialize, FromRow)]
pub struct FileVersion {
    pub id: Uuid,
    pub file_id: Uuid,
    pub version_number: i32,
    pub version_type: VersionType,
    pub storage_key: String,
    pub storage_backend: String,
    pub name: String,
    pub mime_type: String,
    pub checksum_md5: Option<String>,
    pub checksum_sha256: Option<String>,
    pub created_by_id: Uuid,
    pub change_summary: Option<String>,
    pub is_current: bool,
    pub restored_from_id: Option<Uuid>,
    pub expires_at: Option<DateTime<Utc>>,
    pub status: FileVersionStatus,
    pub deleted_at: Option<DateTime<Utc>>,
    pub size_bytes: i64,
    #[serde(default)]
    #[sqlx(json)]
    pub metadata: AuditMetadata,
}

impl FileVersion {
    /// Create a builder for FileVersion
    pub fn builder() -> FileVersionBuilder {
        <FileVersionBuilder as Default>::default()
    }

    /// Create a new FileVersion with required fields
    pub fn new(file_id: Uuid, version_number: i32, version_type: VersionType, storage_key: String, storage_backend: String, name: String, mime_type: String, created_by_id: Uuid, is_current: bool, status: FileVersionStatus, size_bytes: i64) -> Self {
        Self {
            id: Uuid::new_v4(),
            file_id,
            version_number,
            version_type,
            storage_key,
            storage_backend,
            name,
            mime_type,
            checksum_md5: None,
            checksum_sha256: None,
            created_by_id,
            change_summary: None,
            is_current,
            restored_from_id: None,
            expires_at: None,
            status,
            deleted_at: None,
            size_bytes,
            metadata: AuditMetadata::default(),
        }
    }

    /// Get the entity's unique identifier
    pub fn id(&self) -> &Uuid {
        &self.id
    }

    /// Get a strongly-typed ID for this entity
    pub fn typed_id(&self) -> FileVersionId {
        FileVersionId(self.id)
    }

    /// Get when this entity was created
    pub fn created_at(&self) -> Option<&DateTime<Utc>> {
        self.metadata.created_at.as_ref()
    }

    /// Get when this entity was last updated
    pub fn updated_at(&self) -> Option<&DateTime<Utc>> {
        self.metadata.updated_at.as_ref()
    }

    /// Check if this entity is soft deleted
    pub fn is_deleted(&self) -> bool {
        self.metadata.deleted_at.is_some()
    }

    /// Check if this entity is active (not deleted)
    pub fn is_active(&self) -> bool {
        self.metadata.deleted_at.is_none()
    }

    /// Get when this entity was deleted
    pub fn deleted_at(&self) -> Option<&DateTime<Utc>> {
        self.metadata.deleted_at.as_ref()
    }

    /// Get who created this entity
    pub fn created_by(&self) -> Option<&Uuid> {
        self.metadata.created_by.as_ref()
    }

    /// Get who last updated this entity
    pub fn updated_by(&self) -> Option<&Uuid> {
        self.metadata.updated_by.as_ref()
    }

    /// Get who deleted this entity
    pub fn deleted_by(&self) -> Option<&Uuid> {
        self.metadata.deleted_by.as_ref()
    }

    /// Get the current status
    pub fn status(&self) -> &FileVersionStatus {
        &self.status
    }


    // ==========================================================
    // Fluent Setters (with_* for optional fields)
    // ==========================================================

    /// Set the checksum_md5 field (chainable)
    pub fn with_checksum_md5(mut self, value: String) -> Self {
        self.checksum_md5 = Some(value);
        self
    }

    /// Set the checksum_sha256 field (chainable)
    pub fn with_checksum_sha256(mut self, value: String) -> Self {
        self.checksum_sha256 = Some(value);
        self
    }

    /// Set the change_summary field (chainable)
    pub fn with_change_summary(mut self, value: String) -> Self {
        self.change_summary = Some(value);
        self
    }

    /// Set the restored_from_id field (chainable)
    pub fn with_restored_from_id(mut self, value: Uuid) -> Self {
        self.restored_from_id = Some(value);
        self
    }

    /// Set the expires_at field (chainable)
    pub fn with_expires_at(mut self, value: DateTime<Utc>) -> Self {
        self.expires_at = Some(value);
        self
    }

    // ==========================================================
    // Partial Update
    // ==========================================================

    /// Apply partial updates from a map of field name to JSON value
    pub fn apply_patch(&mut self, fields: std::collections::HashMap<String, serde_json::Value>) {
        for (key, value) in fields {
            match key.as_str() {
                "file_id" => {
                    if let Ok(v) = serde_json::from_value(value) { self.file_id = v; }
                }
                "version_number" => {
                    if let Ok(v) = serde_json::from_value(value) { self.version_number = v; }
                }
                "version_type" => {
                    if let Ok(v) = serde_json::from_value(value) { self.version_type = v; }
                }
                "storage_key" => {
                    if let Ok(v) = serde_json::from_value(value) { self.storage_key = v; }
                }
                "storage_backend" => {
                    if let Ok(v) = serde_json::from_value(value) { self.storage_backend = v; }
                }
                "name" => {
                    if let Ok(v) = serde_json::from_value(value) { self.name = v; }
                }
                "mime_type" => {
                    if let Ok(v) = serde_json::from_value(value) { self.mime_type = v; }
                }
                "checksum_md5" => {
                    if let Ok(v) = serde_json::from_value(value) { self.checksum_md5 = v; }
                }
                "checksum_sha256" => {
                    if let Ok(v) = serde_json::from_value(value) { self.checksum_sha256 = v; }
                }
                "created_by_id" => {
                    if let Ok(v) = serde_json::from_value(value) { self.created_by_id = v; }
                }
                "change_summary" => {
                    if let Ok(v) = serde_json::from_value(value) { self.change_summary = v; }
                }
                "is_current" => {
                    if let Ok(v) = serde_json::from_value(value) { self.is_current = v; }
                }
                "restored_from_id" => {
                    if let Ok(v) = serde_json::from_value(value) { self.restored_from_id = v; }
                }
                "expires_at" => {
                    if let Ok(v) = serde_json::from_value(value) { self.expires_at = v; }
                }
                "status" => {
                    if let Ok(v) = serde_json::from_value(value) { self.status = v; }
                }
                "size_bytes" => {
                    if let Ok(v) = serde_json::from_value(value) { self.size_bytes = v; }
                }
                _ => {} // ignore unknown fields
            }
        }
    }

}

impl super::Entity for FileVersion {
    type Id = Uuid;

    fn entity_id(&self) -> &Self::Id {
        &self.id
    }

    fn entity_type() -> &'static str {
        "FileVersion"
    }
}

impl backbone_core::PersistentEntity for FileVersion {
    fn write_protected_fields() -> &'static [&'static str] {
        &["deleted_at"]
    }
    fn entity_id(&self) -> String {
        self.id.to_string()
    }
    fn set_entity_id(&mut self, id: String) {
        if let Ok(uuid) = uuid::Uuid::parse_str(&id) {
            self.id = uuid;
        }
    }
    fn created_at(&self) -> Option<chrono::DateTime<chrono::Utc>> {
        self.metadata.created_at
    }
    fn set_created_at(&mut self, ts: chrono::DateTime<chrono::Utc>) {
        self.metadata.created_at = Some(ts);
    }
    fn updated_at(&self) -> Option<chrono::DateTime<chrono::Utc>> {
        self.metadata.updated_at
    }
    fn set_updated_at(&mut self, ts: chrono::DateTime<chrono::Utc>) {
        self.metadata.updated_at = Some(ts);
    }
    fn deleted_at(&self) -> Option<chrono::DateTime<chrono::Utc>> {
        self.metadata.deleted_at
    }
    fn set_deleted_at(&mut self, ts: Option<chrono::DateTime<chrono::Utc>>) {
        self.metadata.deleted_at = ts;
    }
}

impl backbone_orm::EntityRepoMeta for FileVersion {
    fn column_types() -> std::collections::HashMap<String, String> {
        let mut m = std::collections::HashMap::new();
        m.insert("id".to_string(), "uuid".to_string());
        m.insert("file_id".to_string(), "uuid".to_string());
        m.insert("created_by_id".to_string(), "uuid".to_string());
        m.insert("restored_from_id".to_string(), "uuid".to_string());
        m.insert("version_type".to_string(), "version_type".to_string());
        m.insert("status".to_string(), "file_version_status".to_string());
        m.insert("expires_at".to_string(), "timestamptz".to_string());
        m.insert("deleted_at".to_string(), "timestamptz".to_string());
        m
    }
    fn search_fields() -> &'static [&'static str] {
        &["storage_key", "storage_backend", "name", "mime_type"]
    }
    fn relations() -> &'static [(&'static str, &'static str, &'static str)] {
        &[("file", "stored_files", "fileId"), ("restoredFrom", "file_versions", "restoredFromId")]
    }
}

/// Builder for FileVersion entity
///
/// Provides a fluent API for constructing FileVersion instances.
/// System fields (id, metadata, timestamps) are auto-initialized.
#[derive(Debug, Clone, Default)]
pub struct FileVersionBuilder {
    file_id: Option<Uuid>,
    version_number: Option<i32>,
    version_type: Option<VersionType>,
    storage_key: Option<String>,
    storage_backend: Option<String>,
    name: Option<String>,
    mime_type: Option<String>,
    checksum_md5: Option<String>,
    checksum_sha256: Option<String>,
    created_by_id: Option<Uuid>,
    change_summary: Option<String>,
    is_current: Option<bool>,
    restored_from_id: Option<Uuid>,
    expires_at: Option<DateTime<Utc>>,
    status: Option<FileVersionStatus>,
    size_bytes: Option<i64>,
}

impl FileVersionBuilder {
    /// Set the file_id field (required)
    pub fn file_id(mut self, value: Uuid) -> Self {
        self.file_id = Some(value);
        self
    }

    /// Set the version_number field (required)
    pub fn version_number(mut self, value: i32) -> Self {
        self.version_number = Some(value);
        self
    }

    /// Set the version_type field (required)
    pub fn version_type(mut self, value: VersionType) -> Self {
        self.version_type = Some(value);
        self
    }

    /// Set the storage_key field (required)
    pub fn storage_key(mut self, value: String) -> Self {
        self.storage_key = Some(value);
        self
    }

    /// Set the storage_backend field (default: `"local".to_string()`)
    pub fn storage_backend(mut self, value: String) -> Self {
        self.storage_backend = Some(value);
        self
    }

    /// Set the name field (required)
    pub fn name(mut self, value: String) -> Self {
        self.name = Some(value);
        self
    }

    /// Set the mime_type field (required)
    pub fn mime_type(mut self, value: String) -> Self {
        self.mime_type = Some(value);
        self
    }

    /// Set the checksum_md5 field (optional)
    pub fn checksum_md5(mut self, value: String) -> Self {
        self.checksum_md5 = Some(value);
        self
    }

    /// Set the checksum_sha256 field (optional)
    pub fn checksum_sha256(mut self, value: String) -> Self {
        self.checksum_sha256 = Some(value);
        self
    }

    /// Set the created_by_id field (required)
    pub fn created_by_id(mut self, value: Uuid) -> Self {
        self.created_by_id = Some(value);
        self
    }

    /// Set the change_summary field (optional)
    pub fn change_summary(mut self, value: String) -> Self {
        self.change_summary = Some(value);
        self
    }

    /// Set the is_current field (default: `false`)
    pub fn is_current(mut self, value: bool) -> Self {
        self.is_current = Some(value);
        self
    }

    /// Set the restored_from_id field (optional)
    pub fn restored_from_id(mut self, value: Uuid) -> Self {
        self.restored_from_id = Some(value);
        self
    }

    /// Set the expires_at field (optional)
    pub fn expires_at(mut self, value: DateTime<Utc>) -> Self {
        self.expires_at = Some(value);
        self
    }

    /// Set the status field (default: `FileVersionStatus::default()`)
    pub fn status(mut self, value: FileVersionStatus) -> Self {
        self.status = Some(value);
        self
    }

    /// Set the size_bytes field (required)
    pub fn size_bytes(mut self, value: i64) -> Self {
        self.size_bytes = Some(value);
        self
    }

    /// Build the FileVersion entity
    ///
    /// Returns Err if any required field without a default is missing.
    pub fn build(self) -> Result<FileVersion, String> {
        let file_id = self.file_id.ok_or_else(|| "file_id is required".to_string())?;
        let version_number = self.version_number.ok_or_else(|| "version_number is required".to_string())?;
        let version_type = self.version_type.ok_or_else(|| "version_type is required".to_string())?;
        let storage_key = self.storage_key.ok_or_else(|| "storage_key is required".to_string())?;
        let name = self.name.ok_or_else(|| "name is required".to_string())?;
        let mime_type = self.mime_type.ok_or_else(|| "mime_type is required".to_string())?;
        let created_by_id = self.created_by_id.ok_or_else(|| "created_by_id is required".to_string())?;
        let size_bytes = self.size_bytes.ok_or_else(|| "size_bytes is required".to_string())?;

        Ok(FileVersion {
            id: Uuid::new_v4(),
            file_id,
            version_number,
            version_type,
            storage_key,
            storage_backend: self.storage_backend.unwrap_or("local".to_string()),
            name,
            mime_type,
            checksum_md5: self.checksum_md5,
            checksum_sha256: self.checksum_sha256,
            created_by_id,
            change_summary: self.change_summary,
            is_current: self.is_current.unwrap_or(false),
            restored_from_id: self.restored_from_id,
            expires_at: self.expires_at,
            status: self.status.unwrap_or_default(),
            deleted_at: None,
            size_bytes,
            metadata: AuditMetadata::default(),
        })
    }
}