about summary refs log tree commit diff stats
path: root/crates/rocie-server/src/storage/sql/product_parent.rs
blob: 15ed578c23bf1adbf6237315e75e5c9dc560b058 (plain) (blame)
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
// rocie - An enterprise grocery management system
//
// Copyright (C) 2026 Benedikt Peetz <benedikt.peetz@b-peetz.de>
// SPDX-License-Identifier: GPL-3.0-or-later
//
// This file is part of Rocie.
//
// You should have received a copy of the License along with this program.
// If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>.

use serde::{Deserialize, Serialize};
use utoipa::ToSchema;

use crate::storage::sql::mk_id;

/// The grouping system for products.
///
/// Every Product can have a related parent, and every parent can have a parent themselves.
/// As such, the products list constructs a DAG.
#[derive(Clone, ToSchema, Serialize, Deserialize)]
pub(crate) struct ProductParent {
    /// The id of the product parent.
    pub(crate) id: ProductParentId,

    /// The optional id of the parent of this product parent.
    ///
    /// This must not form a cycle.
    #[schema(nullable = false)]
    pub(crate) parent: Option<ProductParentId>,

    /// The name of the product parent.
    ///
    /// This should be globally unique, to make searching easier for the user.
    pub(crate) name: String,

    /// An optional description of this product parent.
    #[schema(nullable = false)]
    pub(super) description: Option<String>,
}

mk_id!(ProductParentId and ProductParentIdStub);