backbone-catalog 0.7.0

Canonical product/service identity: Item, Item Group, UOM (Indonesia-first)
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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use sqlx::FromRow;
use uuid::Uuid;
use rust_decimal::Decimal;

use super::ItemType;
use super::CatalogStatus;
use super::AuditMetadata;

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

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

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

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

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

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

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

#[derive(Debug, Clone, Serialize, Deserialize, FromRow)]
pub struct Item {
    pub id: Uuid,
    pub item_code: String,
    pub name: String,
    pub description: Option<String>,
    pub barcode: Option<String>,
    pub brand_id: Option<Uuid>,
    pub item_group_id: Uuid,
    pub default_uom_id: Uuid,
    pub item_type: ItemType,
    pub is_sales_item: bool,
    pub is_purchase_item: bool,
    pub is_stock_item: bool,
    pub has_variants: bool,
    pub hsn_code: Option<String>,
    pub sni: Option<String>,
    pub is_taxable: bool,
    pub weight_per_unit: Option<Decimal>,
    pub shelf_life_days: Option<i32>,
    pub standard_cost: Option<Decimal>,
    pub tags: serde_json::Value,
    pub data: serde_json::Value,
    pub status: CatalogStatus,
    #[serde(default)]
    #[sqlx(json)]
    pub metadata: AuditMetadata,
}

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

    /// Create a new Item with required fields
    pub fn new(item_code: String, name: String, item_group_id: Uuid, default_uom_id: Uuid, item_type: ItemType, is_sales_item: bool, is_purchase_item: bool, is_stock_item: bool, has_variants: bool, is_taxable: bool, tags: serde_json::Value, data: serde_json::Value, status: CatalogStatus) -> Self {
        Self {
            id: Uuid::new_v4(),
            item_code,
            name,
            description: None,
            barcode: None,
            brand_id: None,
            item_group_id,
            default_uom_id,
            item_type,
            is_sales_item,
            is_purchase_item,
            is_stock_item,
            has_variants,
            hsn_code: None,
            sni: None,
            is_taxable,
            weight_per_unit: None,
            shelf_life_days: None,
            standard_cost: None,
            tags,
            data,
            status,
            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) -> ItemId {
        ItemId(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) -> &CatalogStatus {
        &self.status
    }


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

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

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

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

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

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

    /// Set the weight_per_unit field (chainable)
    pub fn with_weight_per_unit(mut self, value: Decimal) -> Self {
        self.weight_per_unit = Some(value);
        self
    }

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

    /// Set the standard_cost field (chainable)
    pub fn with_standard_cost(mut self, value: Decimal) -> Self {
        self.standard_cost = 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() {
                "item_code" => {
                    if let Ok(v) = serde_json::from_value(value) { self.item_code = v; }
                }
                "name" => {
                    if let Ok(v) = serde_json::from_value(value) { self.name = v; }
                }
                "description" => {
                    if let Ok(v) = serde_json::from_value(value) { self.description = v; }
                }
                "barcode" => {
                    if let Ok(v) = serde_json::from_value(value) { self.barcode = v; }
                }
                "brand_id" => {
                    if let Ok(v) = serde_json::from_value(value) { self.brand_id = v; }
                }
                "item_group_id" => {
                    if let Ok(v) = serde_json::from_value(value) { self.item_group_id = v; }
                }
                "default_uom_id" => {
                    if let Ok(v) = serde_json::from_value(value) { self.default_uom_id = v; }
                }
                "item_type" => {
                    if let Ok(v) = serde_json::from_value(value) { self.item_type = v; }
                }
                "is_sales_item" => {
                    if let Ok(v) = serde_json::from_value(value) { self.is_sales_item = v; }
                }
                "is_purchase_item" => {
                    if let Ok(v) = serde_json::from_value(value) { self.is_purchase_item = v; }
                }
                "is_stock_item" => {
                    if let Ok(v) = serde_json::from_value(value) { self.is_stock_item = v; }
                }
                "has_variants" => {
                    if let Ok(v) = serde_json::from_value(value) { self.has_variants = v; }
                }
                "hsn_code" => {
                    if let Ok(v) = serde_json::from_value(value) { self.hsn_code = v; }
                }
                "sni" => {
                    if let Ok(v) = serde_json::from_value(value) { self.sni = v; }
                }
                "is_taxable" => {
                    if let Ok(v) = serde_json::from_value(value) { self.is_taxable = v; }
                }
                "weight_per_unit" => {
                    if let Ok(v) = serde_json::from_value(value) { self.weight_per_unit = v; }
                }
                "shelf_life_days" => {
                    if let Ok(v) = serde_json::from_value(value) { self.shelf_life_days = v; }
                }
                "standard_cost" => {
                    if let Ok(v) = serde_json::from_value(value) { self.standard_cost = v; }
                }
                "tags" => {
                    if let Ok(v) = serde_json::from_value(value) { self.tags = v; }
                }
                "data" => {
                    if let Ok(v) = serde_json::from_value(value) { self.data = v; }
                }
                "status" => {
                    if let Ok(v) = serde_json::from_value(value) { self.status = v; }
                }
                _ => {} // ignore unknown fields
            }
        }
    }

    // <<< CUSTOM METHODS START >>>
    // <<< CUSTOM METHODS END >>>
}

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

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

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

impl backbone_core::PersistentEntity for Item {
    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 Item {
    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("brand_id".to_string(), "uuid".to_string());
        m.insert("item_group_id".to_string(), "uuid".to_string());
        m.insert("default_uom_id".to_string(), "uuid".to_string());
        m.insert("item_type".to_string(), "item_type".to_string());
        m.insert("status".to_string(), "catalog_status".to_string());
        m
    }
    fn search_fields() -> &'static [&'static str] {
        &["item_code", "name"]
    }
    fn relations() -> &'static [(&'static str, &'static str, &'static str)] {
        &[("itemGroup", "item_groups", "itemGroupId"), ("brand", "brands", "brandId"), ("defaultUom", "uoms", "defaultUomId")]
    }
}

/// Builder for Item entity
///
/// Provides a fluent API for constructing Item instances.
/// System fields (id, metadata, timestamps) are auto-initialized.
#[derive(Debug, Clone, Default)]
pub struct ItemBuilder {
    item_code: Option<String>,
    name: Option<String>,
    description: Option<String>,
    barcode: Option<String>,
    brand_id: Option<Uuid>,
    item_group_id: Option<Uuid>,
    default_uom_id: Option<Uuid>,
    item_type: Option<ItemType>,
    is_sales_item: Option<bool>,
    is_purchase_item: Option<bool>,
    is_stock_item: Option<bool>,
    has_variants: Option<bool>,
    hsn_code: Option<String>,
    sni: Option<String>,
    is_taxable: Option<bool>,
    weight_per_unit: Option<Decimal>,
    shelf_life_days: Option<i32>,
    standard_cost: Option<Decimal>,
    tags: Option<serde_json::Value>,
    data: Option<serde_json::Value>,
    status: Option<CatalogStatus>,
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    /// Set the tags field (default: `serde_json::json!([])`)
    pub fn tags(mut self, value: serde_json::Value) -> Self {
        self.tags = Some(value);
        self
    }

    /// Set the data field (default: `serde_json::json!({})`)
    pub fn data(mut self, value: serde_json::Value) -> Self {
        self.data = Some(value);
        self
    }

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

    /// Build the Item entity
    ///
    /// Returns Err if any required field without a default is missing.
    pub fn build(self) -> Result<Item, String> {
        let item_code = self.item_code.ok_or_else(|| "item_code is required".to_string())?;
        let name = self.name.ok_or_else(|| "name is required".to_string())?;
        let item_group_id = self.item_group_id.ok_or_else(|| "item_group_id is required".to_string())?;
        let default_uom_id = self.default_uom_id.ok_or_else(|| "default_uom_id is required".to_string())?;

        Ok(Item {
            id: Uuid::new_v4(),
            item_code,
            name,
            description: self.description,
            barcode: self.barcode,
            brand_id: self.brand_id,
            item_group_id,
            default_uom_id,
            item_type: self.item_type.unwrap_or_default(),
            is_sales_item: self.is_sales_item.unwrap_or(true),
            is_purchase_item: self.is_purchase_item.unwrap_or(true),
            is_stock_item: self.is_stock_item.unwrap_or(true),
            has_variants: self.has_variants.unwrap_or(false),
            hsn_code: self.hsn_code,
            sni: self.sni,
            is_taxable: self.is_taxable.unwrap_or(true),
            weight_per_unit: self.weight_per_unit,
            shelf_life_days: self.shelf_life_days,
            standard_cost: self.standard_cost,
            tags: self.tags.unwrap_or(serde_json::json!([])),
            data: self.data.unwrap_or(serde_json::json!({})),
            status: self.status.unwrap_or_default(),
            metadata: AuditMetadata::default(),
        })
    }
}