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

# =============================================================================
# Domain: Catalog
# Entity: Attribute + AttributeValue
# Description: Reusable variant axes (e.g. Color, Size) and their option values (Red, M).
# Adopted from VINSTEKNIK's variant/variant_unit model — kept as a GLOBAL reusable registry
# with the presentation metadata a storefront/POS needs (swatch hex, icon, i18n label). Commerce
# attributes (price/stock) are deliberately NOT here; those live in projections/promo/inventory.
#
# Tenancy: none, by design (ADR-0029). The module is tenant-agnostic and reusable —
# it ships no scoping column and no fence declaration. A composing backend-service
# that wants these tables org-scoped declares them in its tenancy.yaml; the
# decorator installs org_unit_id, the RLS policy, and the org-scoped per-unit
# indexes (the code uniques and the listing indexes) at composition time.
# =============================================================================

models:
  - name: Attribute
    collection: attributes
    description: "Reusable variant axis (e.g. Color, Size, Material)"

    fields:
      id:
        type: uuid
        attributes: ["@id", "@default(uuid)"]
        description: "Unique attribute identifier"

      code:
        type: string
        attributes: ["@required", "@max(40)"]
        description: "Short unique code (e.g. color, size)"

      name:
        type: string
        attributes: ["@required", "@max(100)"]
        description: "Display name (e.g. Warna, Ukuran)"

      attribute_type:
        type: AttributeType
        attributes: ["@default(other)"]
        description: "Kind of axis (drives UI: swatch for color, chips for size)"

      status:
        type: CatalogStatus
        attributes: ["@default(active)"]
        description: "Lifecycle status"

      metadata:
        type: Metadata
        attributes: ["@audit_metadata"]
        description: "Audit metadata (created_at, updated_at, deleted_at, created_by, updated_by, deleted_by)"

    relations:
      values:
        type: AttributeValue[]
        attributes: ["@one_to_many"]
        description: "Option values for this axis"
        inverse: attribute

    indexes:
      # No tenancy indexes (ADR-0029): the module is tenant-agnostic. The per-unit
      # code unique and the listing indexes are installed by the composing service's
      # tenancy decorator (org_unit_id-leading), not declared here.

  - name: AttributeValue
    collection: attribute_values
    description: "An option value of an Attribute (e.g. Red, Size M) with display metadata"

    fields:
      id:
        type: uuid
        attributes: ["@id", "@default(uuid)"]
        description: "Unique value identifier"

      attribute_id:
        type: uuid
        attributes: ["@required", "@foreign_key(Attribute.id)"]
        description: "Owning attribute (axis)"

      code:
        type: string
        attributes: ["@required", "@max(40)"]
        description: "Short code, unique within the attribute (e.g. red, m)"

      label:
        type: string
        attributes: ["@required", "@max(100)"]
        description: "Display label (e.g. Merah)"

      label_en:
        type: string?
        attributes: ["@max(100)"]
        description: "English label (e.g. Red) — Indonesia-first + English"

      swatch_hex:
        type: string?
        attributes: ["@max(10)"]
        description: "Color swatch hex (for color axes, e.g. #FF0000)"

      icon:
        type: string?
        attributes: ["@max(255)"]
        description: "Optional icon reference"

      sort_order:
        type: int
        attributes: ["@default(0)"]
        description: "Display order within the attribute"

      status:
        type: CatalogStatus
        attributes: ["@default(active)"]
        description: "Lifecycle status"

      metadata:
        type: Metadata
        attributes: ["@audit_metadata"]
        description: "Audit metadata (created_at, updated_at, deleted_at, created_by, updated_by, deleted_by)"

    relations:
      attribute:
        type: Attribute
        attributes: ["@one", "@foreign_key(attribute_id)"]
        description: "Owning axis"
        inverse: values

    indexes:
      # No tenancy indexes (ADR-0029): the module is tenant-agnostic. The per-unit
      # (attribute_id, code) unique and the listing indexes are installed by the
      # composing service's tenancy decorator (org_unit_id-leading), not declared here.

# =============================================================================
# Enums
# =============================================================================

enums:
  - name: AttributeType
    description: "Kind of variant axis (drives storefront/POS rendering)"
    variants:
      - name: color
        description: "Color axis (renders as a swatch; uses swatch_hex)"
      - name: size
        description: "Size axis (renders as chips)"
      - name: material
        description: "Material / bahan"
      - name: style
        description: "Style / model"
      - name: capacity
        description: "Capacity / volume / power"
      - name: other
        description: "Other / custom"
        default: true