dpp-domain 0.13.0

EU Digital Product Passport domain types, port traits, and open-core boundary
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

//! [`SectorDescriptor`] — a single sector's catalog entry.

use serde::{Deserialize, Serialize};

use super::regime::Regime;
use super::status::RegulatoryStatus;

/// A single sector's catalog entry — the canonical record every component
/// (schema registry, plugin host, passport model) resolves against.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SectorDescriptor {
    /// Canonical sector key, e.g. `"battery"`, `"unsold-goods"`. Matches the
    /// schema-registry sector key and the plugin's `meta().sector`.
    pub key: String,
    /// Human-readable title.
    pub title: String,
    /// Regulatory status — gates whether determinations are binding.
    pub status: RegulatoryStatus,
    /// Which EU legal instrument family this sector derives from.
    ///
    /// Orthogonal to [`Self::status`]: the regime says *which law*, the status
    /// says *whether it binds yet*. Determination gating must never branch on
    /// this field.
    pub regime: Regime,
    /// EU legal instrument(s) this sector derives from.
    pub legal_basis: Vec<String>,
    /// ISO-8601 date the **passport obligation** applies from, when known.
    ///
    /// Scope note: this is when the DPP itself becomes mandatory. It is **not**
    /// the determination gate and must not be used as one — a regulation may
    /// bind long before its passport is required (see [`RegulatoryStatus`]).
    /// Where a sector carries several obligations with different dates, this
    /// records the earliest that binds an in-scope operator; the manifest
    /// `notes` carry the rest.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dpp_applies_from: Option<String>,
    /// Minimum data retention in years required by the applicable act.
    pub retention_years: u32,
    /// Schema versions available for this sector (semver strings).
    pub schema_versions: Vec<String>,
    /// The schema version applicable to *new* passports in this sector right
    /// now. Decouples "current" from "latest embedded" so a future schema can
    /// ship embedded without becoming current until its act is in force. Must
    /// be one of `schema_versions`.
    pub current_schema_version: String,
    /// Product categories *within* this sector — sub-types a plugin may branch
    /// on, never dispatch keys. See `DATA-MODEL.md` §3.5.
    #[serde(default)]
    pub product_categories: Vec<String>,
    /// Per-field [`Disclosure`](crate::domain::identity::Disclosure) class for
    /// this sector's data: field name → class; unlisted fields default to
    /// public. Not an ordering — a class names which audiences may see the
    /// field, and the audiences do not nest. Universal conformity fields
    /// (signatures, audit trails) are folded in by the access-policy engine, so
    /// they are not repeated per sector here.
    #[serde(default, skip_serializing_if = "std::collections::HashMap::is_empty")]
    pub disclosure: std::collections::HashMap<String, crate::domain::identity::Disclosure>,
    /// Plugin that handles this sector (crate / filename stem, e.g.
    /// `"sector-battery"`). `None` if no plugin is bound yet.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub plugin: Option<String>,
    /// Free-text regulatory note (effective dates, scope, caveats).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub notes: Option<String>,
}