backbone-bucket 0.4.4

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::ShareType;
use super::SharePermission;
use super::ShareStatus;
use super::AuditMetadata;

use super::*;

use crate::domain::state_machine::{FileShareStateMachine, FileShareState, StateMachineError};

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

impl FileShareId {
    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 FileShareId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

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

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

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

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

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

#[derive(Debug, Clone, Serialize, Deserialize, FromRow)]
pub struct FileShare {
    pub id: Uuid,
    pub file_id: Uuid,
    pub owner_id: Uuid,
    pub token: String,
    pub share_type: ShareType,
    pub permission: SharePermission,
    pub shared_with: Vec<Uuid>,
    pub password_hash: Option<String>,
    pub max_downloads: Option<i32>,
    pub download_count: i32,
    pub expires_at: Option<DateTime<Utc>>,
    pub(crate) status: ShareStatus,
    pub revoked_at: Option<DateTime<Utc>>,
    pub revoked_by: Option<Uuid>,
    pub message: Option<String>,
    #[serde(default)]
    #[sqlx(json)]
    pub metadata: AuditMetadata,
}

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

    /// Create a new FileShare with required fields
    pub fn new(file_id: Uuid, owner_id: Uuid, token: String, share_type: ShareType, permission: SharePermission, shared_with: Vec<Uuid>, download_count: i32, status: ShareStatus) -> Self {
        Self {
            id: Uuid::new_v4(),
            file_id,
            owner_id,
            token,
            share_type,
            permission,
            shared_with,
            password_hash: None,
            max_downloads: None,
            download_count,
            expires_at: None,
            status,
            revoked_at: None,
            revoked_by: None,
            message: None,
            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) -> FileShareId {
        FileShareId(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) -> &ShareStatus {
        &self.status
    }


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

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

    /// Set the max_downloads field (chainable)
    pub fn with_max_downloads(mut self, value: i32) -> Self {
        self.max_downloads = 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
    }

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

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

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

    // ==========================================================
    // State Machine
    // ==========================================================

    /// Transition to a new state via the status state machine.
    ///
    /// Returns `Err` if the transition is not permitted from the current state.
    /// Use this method instead of assigning `self.status` directly.
    pub fn transition_to(&mut self, new_state: FileShareState) -> Result<(), StateMachineError> {
        let current = self.status.to_string().parse::<FileShareState>()?;
        let mut sm = FileShareStateMachine::from_state(current);
        sm.transition_to_state(new_state)?;
        self.status = new_state.to_string().parse::<ShareStatus>()
            .map_err(|e| StateMachineError::InvalidState(e.to_string()))?;
        Ok(())
    }

    // ==========================================================
    // 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; }
                }
                "owner_id" => {
                    if let Ok(v) = serde_json::from_value(value) { self.owner_id = v; }
                }
                "token" => {
                    if let Ok(v) = serde_json::from_value(value) { self.token = v; }
                }
                "share_type" => {
                    if let Ok(v) = serde_json::from_value(value) { self.share_type = v; }
                }
                "permission" => {
                    if let Ok(v) = serde_json::from_value(value) { self.permission = v; }
                }
                "shared_with" => {
                    if let Ok(v) = serde_json::from_value(value) { self.shared_with = v; }
                }
                "password_hash" => {
                    if let Ok(v) = serde_json::from_value(value) { self.password_hash = v; }
                }
                "max_downloads" => {
                    if let Ok(v) = serde_json::from_value(value) { self.max_downloads = v; }
                }
                "download_count" => {
                    if let Ok(v) = serde_json::from_value(value) { self.download_count = v; }
                }
                "expires_at" => {
                    if let Ok(v) = serde_json::from_value(value) { self.expires_at = v; }
                }
                "revoked_at" => {
                    if let Ok(v) = serde_json::from_value(value) { self.revoked_at = v; }
                }
                "revoked_by" => {
                    if let Ok(v) = serde_json::from_value(value) { self.revoked_by = v; }
                }
                "message" => {
                    if let Ok(v) = serde_json::from_value(value) { self.message = v; }
                }
                _ => {} // ignore unknown fields
            }
        }
    }

}

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

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

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

impl backbone_core::PersistentEntity for FileShare {
    fn write_protected_fields() -> &'static [&'static str] {
        &["password_hash"]
    }
    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 FileShare {
    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("owner_id".to_string(), "uuid".to_string());
        m.insert("share_type".to_string(), "share_type".to_string());
        m.insert("permission".to_string(), "share_permission".to_string());
        m.insert("status".to_string(), "share_status".to_string());
        m.insert("expires_at".to_string(), "timestamptz".to_string());
        m.insert("revoked_at".to_string(), "timestamptz".to_string());
        m
    }
    fn search_fields() -> &'static [&'static str] {
        &["token"]
    }
    fn secret_fields() -> &'static [&'static str] {
        &["passwordHash"]
    }
    fn relations() -> &'static [(&'static str, &'static str, &'static str)] {
        &[("file", "stored_files", "fileId")]
    }
}

/// Builder for FileShare entity
///
/// Provides a fluent API for constructing FileShare instances.
/// System fields (id, metadata, timestamps) are auto-initialized.
#[derive(Debug, Clone, Default)]
pub struct FileShareBuilder {
    file_id: Option<Uuid>,
    owner_id: Option<Uuid>,
    token: Option<String>,
    share_type: Option<ShareType>,
    permission: Option<SharePermission>,
    shared_with: Option<Vec<Uuid>>,
    password_hash: Option<String>,
    max_downloads: Option<i32>,
    download_count: Option<i32>,
    expires_at: Option<DateTime<Utc>>,
    status: Option<ShareStatus>,
    revoked_at: Option<DateTime<Utc>>,
    revoked_by: Option<Uuid>,
    message: Option<String>,
}

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

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

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

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

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

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

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

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

    /// Set the download_count field (default: `0`)
    pub fn download_count(mut self, value: i32) -> Self {
        self.download_count = 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: `ShareStatus::default()`)
    pub fn status(mut self, value: ShareStatus) -> Self {
        self.status = Some(value);
        self
    }

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

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

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

    /// Build the FileShare entity
    ///
    /// Returns Err if any required field without a default is missing.
    pub fn build(self) -> Result<FileShare, String> {
        let file_id = self.file_id.ok_or_else(|| "file_id is required".to_string())?;
        let owner_id = self.owner_id.ok_or_else(|| "owner_id is required".to_string())?;
        let token = self.token.ok_or_else(|| "token is required".to_string())?;
        let shared_with = self.shared_with.ok_or_else(|| "shared_with is required".to_string())?;

        Ok(FileShare {
            id: Uuid::new_v4(),
            file_id,
            owner_id,
            token,
            share_type: self.share_type.unwrap_or_default(),
            permission: self.permission.unwrap_or_default(),
            shared_with,
            password_hash: self.password_hash,
            max_downloads: self.max_downloads,
            download_count: self.download_count.unwrap_or(0),
            expires_at: self.expires_at,
            status: self.status.unwrap_or_default(),
            revoked_at: self.revoked_at,
            revoked_by: self.revoked_by,
            message: self.message,
            metadata: AuditMetadata::default(),
        })
    }
}

// This file's extension (hand-written; ADR-0031).
#[path = "file_share.ext.rs"]
mod file_share_ext;
pub use file_share_ext::*;