backbone-bucket 0.2.1

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
//! Public events for Bucket module
//!
//! Generated by metaphor-schema. Do not edit manually.
//!
//! These events are published by this module for other modules to subscribe to.
//! Events are the primary mechanism for cross-module communication.

use serde::{Deserialize, Serialize};
use chrono::{DateTime, Utc};

use super::types::*;

// ============================================================================
// ACCESSLOG EVENTS
// ============================================================================

/// Event published when a AccessLog is created
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccessLogCreatedEvent {
    pub id: AccessLogId,
    pub data: AccessLogDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a AccessLog is updated
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccessLogUpdatedEvent {
    pub id: AccessLogId,
    pub data: AccessLogDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a AccessLog is deleted
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccessLogDeletedEvent {
    pub id: AccessLogId,
    pub occurred_at: DateTime<Utc>,
}

// ============================================================================
// BUCKET EVENTS
// ============================================================================

/// Event published when a Bucket is created
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BucketCreatedEvent {
    pub id: BucketId,
    pub data: BucketDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a Bucket is updated
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BucketUpdatedEvent {
    pub id: BucketId,
    pub data: BucketDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a Bucket is deleted
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BucketDeletedEvent {
    pub id: BucketId,
    pub occurred_at: DateTime<Utc>,
}

// ============================================================================
// CONTENTHASH EVENTS
// ============================================================================

/// Event published when a ContentHash is created
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ContentHashCreatedEvent {
    pub id: ContentHashId,
    pub data: ContentHashDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a ContentHash is updated
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ContentHashUpdatedEvent {
    pub id: ContentHashId,
    pub data: ContentHashDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a ContentHash is deleted
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ContentHashDeletedEvent {
    pub id: ContentHashId,
    pub occurred_at: DateTime<Utc>,
}

// ============================================================================
// CONVERSIONJOB EVENTS
// ============================================================================

/// Event published when a ConversionJob is created
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConversionJobCreatedEvent {
    pub id: ConversionJobId,
    pub data: ConversionJobDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a ConversionJob is updated
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConversionJobUpdatedEvent {
    pub id: ConversionJobId,
    pub data: ConversionJobDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a ConversionJob is deleted
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConversionJobDeletedEvent {
    pub id: ConversionJobId,
    pub occurred_at: DateTime<Utc>,
}

// ============================================================================
// FILECOMMENT EVENTS
// ============================================================================

/// Event published when a FileComment is created
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileCommentCreatedEvent {
    pub id: FileCommentId,
    pub data: FileCommentDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a FileComment is updated
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileCommentUpdatedEvent {
    pub id: FileCommentId,
    pub data: FileCommentDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a FileComment is deleted
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileCommentDeletedEvent {
    pub id: FileCommentId,
    pub occurred_at: DateTime<Utc>,
}

// ============================================================================
// FILELOCK EVENTS
// ============================================================================

/// Event published when a FileLock is created
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileLockCreatedEvent {
    pub id: FileLockId,
    pub data: FileLockDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a FileLock is updated
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileLockUpdatedEvent {
    pub id: FileLockId,
    pub data: FileLockDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a FileLock is deleted
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileLockDeletedEvent {
    pub id: FileLockId,
    pub occurred_at: DateTime<Utc>,
}

// ============================================================================
// FILESHARE EVENTS
// ============================================================================

/// Event published when a FileShare is created
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileShareCreatedEvent {
    pub id: FileShareId,
    pub data: FileShareDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a FileShare is updated
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileShareUpdatedEvent {
    pub id: FileShareId,
    pub data: FileShareDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a FileShare is deleted
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileShareDeletedEvent {
    pub id: FileShareId,
    pub occurred_at: DateTime<Utc>,
}

// ============================================================================
// FILEVERSION EVENTS
// ============================================================================

/// Event published when a FileVersion is created
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileVersionCreatedEvent {
    pub id: FileVersionId,
    pub data: FileVersionDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a FileVersion is updated
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileVersionUpdatedEvent {
    pub id: FileVersionId,
    pub data: FileVersionDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a FileVersion is deleted
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileVersionDeletedEvent {
    pub id: FileVersionId,
    pub occurred_at: DateTime<Utc>,
}

// ============================================================================
// PROCESSINGJOB EVENTS
// ============================================================================

/// Event published when a ProcessingJob is created
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ProcessingJobCreatedEvent {
    pub id: ProcessingJobId,
    pub data: ProcessingJobDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a ProcessingJob is updated
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ProcessingJobUpdatedEvent {
    pub id: ProcessingJobId,
    pub data: ProcessingJobDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a ProcessingJob is deleted
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ProcessingJobDeletedEvent {
    pub id: ProcessingJobId,
    pub occurred_at: DateTime<Utc>,
}

// ============================================================================
// STOREDFILE EVENTS
// ============================================================================

/// Event published when a StoredFile is created
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StoredFileCreatedEvent {
    pub id: StoredFileId,
    pub data: StoredFileDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a StoredFile is updated
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StoredFileUpdatedEvent {
    pub id: StoredFileId,
    pub data: StoredFileDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a StoredFile is deleted
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StoredFileDeletedEvent {
    pub id: StoredFileId,
    pub occurred_at: DateTime<Utc>,
}

// ============================================================================
// THUMBNAIL EVENTS
// ============================================================================

/// Event published when a Thumbnail is created
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ThumbnailCreatedEvent {
    pub id: ThumbnailId,
    pub data: ThumbnailDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a Thumbnail is updated
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ThumbnailUpdatedEvent {
    pub id: ThumbnailId,
    pub data: ThumbnailDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a Thumbnail is deleted
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ThumbnailDeletedEvent {
    pub id: ThumbnailId,
    pub occurred_at: DateTime<Utc>,
}

// ============================================================================
// UPLOADSESSION EVENTS
// ============================================================================

/// Event published when a UploadSession is created
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UploadSessionCreatedEvent {
    pub id: UploadSessionId,
    pub data: UploadSessionDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a UploadSession is updated
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UploadSessionUpdatedEvent {
    pub id: UploadSessionId,
    pub data: UploadSessionDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a UploadSession is deleted
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UploadSessionDeletedEvent {
    pub id: UploadSessionId,
    pub occurred_at: DateTime<Utc>,
}

// ============================================================================
// USERQUOTA EVENTS
// ============================================================================

/// Event published when a UserQuota is created
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UserQuotaCreatedEvent {
    pub id: UserQuotaId,
    pub data: UserQuotaDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a UserQuota is updated
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UserQuotaUpdatedEvent {
    pub id: UserQuotaId,
    pub data: UserQuotaDto,
    pub occurred_at: DateTime<Utc>,
}

/// Event published when a UserQuota is deleted
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UserQuotaDeletedEvent {
    pub id: UserQuotaId,
    pub occurred_at: DateTime<Utc>,
}

// ============================================================================
// MODULE EVENT ENUM
// ============================================================================

/// All events published by Bucket module
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type")]
pub enum BucketEvent {
    AccessLogCreated(AccessLogCreatedEvent),
    AccessLogUpdated(AccessLogUpdatedEvent),
    AccessLogDeleted(AccessLogDeletedEvent),
    BucketCreated(BucketCreatedEvent),
    BucketUpdated(BucketUpdatedEvent),
    BucketDeleted(BucketDeletedEvent),
    ContentHashCreated(ContentHashCreatedEvent),
    ContentHashUpdated(ContentHashUpdatedEvent),
    ContentHashDeleted(ContentHashDeletedEvent),
    ConversionJobCreated(ConversionJobCreatedEvent),
    ConversionJobUpdated(ConversionJobUpdatedEvent),
    ConversionJobDeleted(ConversionJobDeletedEvent),
    FileCommentCreated(FileCommentCreatedEvent),
    FileCommentUpdated(FileCommentUpdatedEvent),
    FileCommentDeleted(FileCommentDeletedEvent),
    FileLockCreated(FileLockCreatedEvent),
    FileLockUpdated(FileLockUpdatedEvent),
    FileLockDeleted(FileLockDeletedEvent),
    FileShareCreated(FileShareCreatedEvent),
    FileShareUpdated(FileShareUpdatedEvent),
    FileShareDeleted(FileShareDeletedEvent),
    FileVersionCreated(FileVersionCreatedEvent),
    FileVersionUpdated(FileVersionUpdatedEvent),
    FileVersionDeleted(FileVersionDeletedEvent),
    ProcessingJobCreated(ProcessingJobCreatedEvent),
    ProcessingJobUpdated(ProcessingJobUpdatedEvent),
    ProcessingJobDeleted(ProcessingJobDeletedEvent),
    StoredFileCreated(StoredFileCreatedEvent),
    StoredFileUpdated(StoredFileUpdatedEvent),
    StoredFileDeleted(StoredFileDeletedEvent),
    ThumbnailCreated(ThumbnailCreatedEvent),
    ThumbnailUpdated(ThumbnailUpdatedEvent),
    ThumbnailDeleted(ThumbnailDeletedEvent),
    UploadSessionCreated(UploadSessionCreatedEvent),
    UploadSessionUpdated(UploadSessionUpdatedEvent),
    UploadSessionDeleted(UploadSessionDeletedEvent),
    UserQuotaCreated(UserQuotaCreatedEvent),
    UserQuotaUpdated(UserQuotaUpdatedEvent),
    UserQuotaDeleted(UserQuotaDeletedEvent),
}

/// Metadata for module events
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BucketEventMetadata {
    pub module: &'static str,
    pub version: &'static str,
}

impl Default for BucketEventMetadata {
    fn default() -> Self {
        Self {
            module: "bucket",
            version: "1.0",
        }
    }
}

// ============================================================================
// CUSTOM EVENTS
// ============================================================================

// <<< CUSTOM EVENTS START >>>
// Add custom public events here
// <<< CUSTOM EVENTS END >>>