mako_engine/

types.rs

//! Semantic domain type wrappers for identifiers used across all MaKo process families.
//!
//! All types in this module wrap `Box<str>` rather than `String` — they are
//! **immutable** identifiers that are never mutated after construction.
//! `Box<str>` is one pointer word smaller than `String` on the stack and avoids
//! the extra capacity bookkeeping.
//!
//! ## Why newtypes instead of `String`?
//!
//! Domain commands and events have many identifier fields:
//!
//! ```text
//! ReceiveUtilmd {
//!     sender:        String,  // GLN
//!     receiver:      String,  // GLN
//!     location_id:   String,  // MaLo / EIC
//!     document_date: String,  // YYYYMMDD
//!     message_ref:   String,  // EDIFACT reference
//! }
//! ```
//!
//! Passing `location_id` where `sender` is expected is a compile-time no-op
//! when all fields are `String`. Typed wrappers turn that into a type error.
//!
//! ## Construction
//!
//! All types implement `From<String>` and `From<&str>` for ergonomic
//! construction without `.into()` gymnastics:
//!
//! ```rust
//! use mako_engine::types::{MaLo, MarktpartnerCode};
//!
//! let malo:   MaLo             = MaLo::new("51238696012");
//! let sender: MarktpartnerCode = MarktpartnerCode::new("9900123456789");
//! ```
//!
//! ## These are wire-boundary types, not validated value objects
//!
//! The wrappers carry no format or check-digit validation: a message arriving
//! over AS4 may hold a malformed identifier, and the process must be able to
//! represent it in order to reject it with a precise, citable error. Validation
//! belongs one layer in, where `rubo4e::identifiers::{MaloId, MeloId,
//! MarktpartnerId}` provide the check-digit-validated domain value objects.
//! Treat a value of this module's types as "whatever the counterparty sent",
//! never as "a valid MaLo".
//!
//! ## Serde
//!
//! All types serialize/deserialize as plain JSON strings, keeping event
//! payloads human-readable in SlateDB and log output.

use serde::{Deserialize, Serialize};
use std::fmt;

macro_rules! domain_id {
    (
        $(#[$attr:meta])*
        $name:ident,
        $doc:literal
    ) => {
        $(#[$attr])*
        #[doc = $doc]
        #[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
        #[serde(transparent)]
        pub struct $name(Box<str>);

        impl $name {
            /// Construct a new identifier from any string-like value.
            #[must_use]
            pub fn new(s: impl Into<Box<str>>) -> Self {
                Self(s.into())
            }

            /// Borrow the underlying string slice.
            #[must_use]
            pub fn as_str(&self) -> &str {
                &self.0
            }
        }

        impl fmt::Display for $name {
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                f.write_str(&self.0)
            }
        }

        impl From<String> for $name {
            fn from(s: String) -> Self {
                Self(s.into_boxed_str())
            }
        }

        impl From<&str> for $name {
            fn from(s: &str) -> Self {
                Self(s.into())
            }
        }

        impl From<$name> for String {
            fn from(id: $name) -> Self {
                id.0.into()
            }
        }

        impl AsRef<str> for $name {
            fn as_ref(&self) -> &str {
                &self.0
            }
        }
    };
}

domain_id!(
    /// Marktlokations-ID (MaLo).
    ///
    /// Identifies a supply point for electricity or gas in the German energy
    /// market. A well-formed MaLo-ID is **11 digits**, the eleventh being a BDEW
    /// check digit over the first ten.
    ///
    /// This wrapper does **not** verify that: it is the wire-boundary type, and
    /// an inbound message carrying a malformed ID must still be representable so
    /// the process can reject it with a precise error. Use
    /// `rubo4e::identifiers::MaloId` for the validated domain value.
    MaLo,
    "Marktlokations-ID — supply point identifier (11 digits incl. BDEW check digit)"
);

domain_id!(
    /// Messlokations-ID (MeLo).
    ///
    /// Identifies a metering point in the WiM (Wechselprozesse im Messwesen)
    /// process family. Distinct from a MaLo — one supply point may have
    /// multiple metering points.
    ///
    /// A well-formed MeLo-ID is **33 characters**: a two-letter ISO 3166-1
    /// country code followed by 31 alphanumerics. Unvalidated here for the same
    /// wire-boundary reason as [`MaLo`]; the validated value object is
    /// `rubo4e::identifiers::MeloId`.
    MeLo,
    "Messlokations-ID — metering point identifier (33 chars, country-code prefixed)"
);

domain_id!(
    /// Market-participant identifier (Marktpartner-Code).
    ///
    /// Identifies a trading partner in the German energy market. Three code
    /// schemes are in active use:
    ///
    /// | Scheme | Digits | EDIFACT DE 3055 | Typical holders |
    /// |--------|--------|-----------------|-----------------|
    /// | **BDEW code** | 13 numeric | `"293"` | Suppliers (LFN), DSOs (NB/VNB), MSBs, BKVs — the dominant scheme |
    /// | **GLN** (GS1) | 13 numeric | `"9"` | Global GS1 scheme; rare in German MaKo |
    /// | **EIC** (ENTSO-E) | 16 alphanumeric | `"305"` | TSOs (ÜNB), Regelzonen, cross-border |
    ///
    /// Used as `sender` and `receiver` in EDIFACT message headers and as
    /// domain party identifiers in all MaKo process commands. The numeric
    /// value is stored without the agency qualifier — use
    /// `edi_energy::AgencyCode` when rendering outbound NAD segments.
    MarktpartnerCode,
    "Marktpartner-Code — BDEW code (293), GS1 GLN (9), or EIC (305) market-participant identifier"
);

domain_id!(
    /// EDIFACT message reference.
    ///
    /// Corresponds to the BGM/C106 reference number in UTILMD, APERAK,
    /// MSCONS, and REMADV messages. Used to correlate responses back to the
    /// originating message and to detect duplicate deliveries.
    MessageRef,
    "EDIFACT message reference (BGM/C106 document number)"
);

domain_id!(
    /// Geräte-ID / Zählernummer.
    ///
    /// Identifies a physical metering device in the WiM Gerätewechsel
    /// process. Assigned by the Messstellenbetreiber; format varies by
    /// device manufacturer.
    DeviceId,
    "Geräte-ID — physical metering device identifier (Zählernummer)"
);

domain_id!(
    /// Bilanzkreisverantwortlicher-ID (BKV).
    ///
    /// Identifies the balance circle responsible party in MaBiS billing
    /// processes. Used in Prüfmitteilung and billing settlement messages.
    BkvId,
    "Bilanzkreisverantwortlicher-ID — balance circle responsible party"
);

domain_id!(
    /// Übertragungsnetzbetreiber-ID (ÜNB).
    ///
    /// Identifies the transmission grid operator. Kept for use in contexts
    /// outside MaBiS billing (e.g. GaBi Gas, Redispatch).
    UenbId,
    "Übertragungsnetzbetreiber-ID — transmission grid operator identifier"
);

domain_id!(
    /// Bilanzkoordinator-ID (BIKO).
    ///
    /// Identifies the Bilanzkoordinator in MaBiS processes. The BIKO is the
    /// central actor in Bilanzkreisabrechnung Strom: it assigns every
    /// Datenstatus (BK6-24-174 Anlage 3 Kap. 3.8.3), sends the
    /// `Abrechnungssummenzeitreihe` to BKV, NB and ÜNB, and forwards the
    /// `Prüfmitteilung` between them.
    ///
    /// The Prüfmitteilung itself carries **no Frist** — Kap. 9.8.2 Nr. 1 leaves
    /// the cell empty and the receiving party „kann" answer. What bounds it is
    /// the clearing window of Kap. 3.10 Tabelle 2. The two genuine 1-Werktag
    /// obligations are the BIKO's own: forwarding a Prüfmitteilung (Kap. 9.8.2
    /// Nr. 3) and dispatching the Datenstatus (Kap. 9.9.2 Nr. 1). See
    /// `mako_mabis::fristen`.
    BikoId,
    "Bilanzkoordinator-ID — balance coordinator identifier (BIKO)"
);

domain_id!(
    /// Abrechnungszeitraum (billing period).
    ///
    /// Represents the billing period as a string in `YYYYMM` or `YYYYMMDD–YYYYMMDD`
    /// format, depending on the context and AHB version. Kept as an opaque
    /// string rather than a date range to avoid coupling to a specific calendar
    /// representation.
    BillingPeriod,
    "Abrechnungszeitraum — billing period identifier string"
);

// ── MeteredInterval ───────────────────────────────────────────────────────────

/// One decoded metered value from an MSCONS `SG9`/`SG10` group.
///
/// # Why this lives here
///
/// Both MSCONS-receiving workflows — `mako-gpke`'s Strom Messwerte and
/// `mako-geli-gas`'s Gas Messdaten — need to carry the values they received to
/// the ERP, and `makod` decodes them from one `MsconsMessage` shape for both.
/// A type per crate would be two decoders that drift; this is the one both
/// depend on already.
///
/// # What is kept raw
///
/// `qualifier` is `SG10 QTY` DE 6063 exactly as it arrived — `220` Wahrer Wert,
/// `67` Ersatzwert, `Z18` Vorläufiger Wert (MSCONS AHB 3.1g §11.2). The
/// translation into the quality vocabulary the ERP and `edmd` share is
/// [`MeteredInterval::quality`], applied when the payload is built. An inbound
/// value stays representable so a message carrying an unexpected qualifier can
/// still be recorded and refused, rather than being coerced at the boundary.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct MeteredInterval {
    /// `SG9 PIA` DE 7140 — the OBIS register the value belongs to.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub obis_code: Option<String>,
    /// `SG6 LOC+172` DE 3225 — the Messlokation, when the series names one.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub melo_id: Option<String>,
    /// `SG10 DTM+163` — interval start, RFC 3339.
    pub dtm_from: String,
    /// `SG10 DTM+164` — interval end, RFC 3339.
    pub dtm_to: String,
    /// `SG10 QTY` DE 6060 — the quantity, as written on the wire.
    ///
    /// A string, not a float: `[906]` allows three decimal places and a
    /// settlement quantity must not acquire a binary rounding error in transit.
    pub quantity: String,
    /// `SG10 QTY` DE 6411 — the unit, normally `KWH`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub unit: Option<String>,
    /// `SG10 QTY` DE 6063, verbatim.
    pub qualifier: String,
}

impl MeteredInterval {
    /// The MSCONS DE 6063 qualifier in the quality vocabulary the ERP event
    /// and `edmd` share.
    ///
    /// | DE 6063 | MSCONS AHB 3.1g | Quality |
    /// |---|---|---|
    /// | `220` | Wahrer Wert | `MEASURED` |
    /// | `67` | Ersatzwert | `SUBSTITUTED` |
    /// | `Z18` | Vorläufiger Wert | `PRELIMINARY` |
    ///
    /// Anything else is `UNKNOWN`, which downstream treats as not billable —
    /// the safe reading for a qualifier this release does not know.
    #[must_use]
    pub fn quality(&self) -> &'static str {
        match self.qualifier.as_str() {
            "220" => "MEASURED",
            "67" => "SUBSTITUTED",
            "Z18" => "PRELIMINARY",
            _ => "UNKNOWN",
        }
    }
}

// ── Pruefidentifikator ────────────────────────────────────────────────────────

/// A validated BDEW process-type code (Prüfidentifikator, PID).
///
/// Prüfidentifikatoren are 5-digit decimal codes in the range `10000–99999`
/// that identify the business process variant of an EDI@Energy message
/// (e.g. `55001` for GPKE Lieferbeginn, `11001` for WiM Zählerstand).
///
/// Energy commodity — used for commodity-aware PID routing.
///
/// Several AHBs are Sparte-neutral, so the same Prüfidentifikator carries a
/// Strom and a Gas process: INSRPT 23001/23003/23004/23008, the WiM ORDERS
/// 17001/17002/17009 and their ORDRSP answers, REQOTE 35001 / QUOTES 15001, and
/// the IFTSTA Statusmeldungen. The Sparte is not in the message body — it is
/// the Sparte of the **interchange recipient's MP-ID** (BDEW Allgemeine
/// Festlegungen §2.13: every MP-ID covers exactly one Sparte). The ingest layer
/// resolves it there and supplies it to [`PidRouter::route_with_sparte`].
///
/// The two Sparten differ in more than routing:
///
/// | | Strom | Gas |
/// |---|---|---|
/// | APERAK | positive **and** negative; 45 min for UTILMD/ORDERS, sonst nächster Werktag 12:00 | **negative only**; nächster Werktag 12:00 (Folgeprozess) / 3 WT (Initialprozess) |
/// | CONTRL | only on a syntactically broken APERAK | on **every** APERAK |
/// | WiM Zuordnungszeitpunkt | 00:00 Uhr | **06:00 Uhr** (Gastag) |
/// | WiM Antwort-Codeliste | `S_00xx` | `G_00xx` |
///
/// The WiM *Antwortfristen* are identical in both (3 / 5 / 7 / 1 Werktage).
///
/// [`PidRouter::route_with_sparte`]: crate::pid_router::PidRouter::route_with_sparte
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Sparte {
    /// Electricity (Strom) — BK6-24-174 GPKE, BK6-22-024 WiM Strom.
    Strom,
    /// Natural gas (Gas) — BK7-24-01-009 GeLi Gas 3.0 / AWH WiM Gas 2.0.
    Gas,
}

impl fmt::Display for Sparte {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Strom => write!(f, "Strom"),
            Self::Gas => write!(f, "Gas"),
        }
    }
}

/// # Serde representation
///
/// Serialises as a plain JSON number (`u32`), matching the wire format of
/// `edi_energy::Pruefidentifikator` (which is also `#[serde(transparent)]`
/// over `u32`). Stored event payloads are therefore fully compatible with both
/// representations — no migration needed.
///
/// # Why this lives in `mako-engine` and not `edi-energy`
///
/// Domain event structs and workflow state must only depend on `mako-engine`,
/// not on the stateless parsing library `edi-energy`. Moving the PID type here
/// removes the `edi-energy` dependency from all domain crates.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
#[serde(transparent)]
pub struct Pruefidentifikator(u32);

impl Pruefidentifikator {
    /// The inclusive lower bound of the valid PID range.
    pub const MIN: u32 = 10_000;
    /// The inclusive upper bound of the valid PID range.
    pub const MAX: u32 = 99_999;

    /// Construct a `Pruefidentifikator`, validating that `code` is in range.
    ///
    /// # Errors
    ///
    /// Returns an error string if `code < 10000` or `code > 99999`.
    pub fn new(code: u32) -> Result<Self, String> {
        if (Self::MIN..=Self::MAX).contains(&code) {
            Ok(Self(code))
        } else {
            Err(format!(
                "invalid Pruefidentifikator {code}: must be a 5-digit code in 10000–99999"
            ))
        }
    }

    /// Construct a `Pruefidentifikator` in const context.
    ///
    /// Intended for typed PID constants:
    ///
    /// ```rust
    /// use mako_engine::types::Pruefidentifikator;
    /// const BESTELLUNG_PID: Pruefidentifikator = Pruefidentifikator::const_new(17007);
    /// ```
    ///
    /// # Panics
    ///
    /// Panics at **compile time** (const evaluation) when `code` is outside
    /// `10000–99999`, so an out-of-range constant cannot build.
    #[must_use]
    pub const fn const_new(code: u32) -> Self {
        assert!(
            code >= Self::MIN && code <= Self::MAX,
            "invalid Pruefidentifikator: must be a 5-digit code in 10000-99999"
        );
        Self(code)
    }

    /// Returns the numeric code.
    #[must_use]
    pub const fn as_u32(self) -> u32 {
        self.0
    }
}

impl fmt::Display for Pruefidentifikator {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:05}", self.0)
    }
}

impl std::str::FromStr for Pruefidentifikator {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        s.parse::<u32>()
            .map_err(|_| format!("Pruefidentifikator is not a decimal integer: {s:?}"))
            .and_then(Self::new)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn malo_roundtrip_display_and_serde() {
        let m = MaLo::new("DE00123456789012345678901234567890");
        assert_eq!(m.to_string(), "DE00123456789012345678901234567890");
        let v = serde_json::to_value(&m).unwrap();
        assert_eq!(v, json!("DE00123456789012345678901234567890"));
        let back: MaLo = serde_json::from_value(v).unwrap();
        assert_eq!(back, m);
    }

    #[test]
    fn from_string_and_str() {
        let from_string: MarktpartnerCode = MarktpartnerCode::from(String::from("4012345000009"));
        let from_str: MarktpartnerCode = MarktpartnerCode::from("4012345000009");
        assert_eq!(from_string, from_str);
    }

    #[test]
    fn into_string() {
        let mid = MessageRef::new("UTILMD-2025-001");
        let s: String = mid.into();
        assert_eq!(s, "UTILMD-2025-001");
    }

    #[test]
    fn distinct_types_are_not_interchangeable() {
        // This test is a compile-time proof: the following would NOT compile:
        // let malo: MaLo = MeLo::new("X");
        // let _: MaLo = MarktpartnerCode::new("X");
        let malo_val = MaLo::new("A");
        let messlokation = MeLo::new("A");
        // Different types even though same inner value:
        let _: MaLo = malo_val;
        let _: MeLo = messlokation;
    }

    #[test]
    fn pruefidentifikator_const_new_and_structural_match() {
        const BESTELLUNG: Pruefidentifikator = Pruefidentifikator::const_new(17007);
        const ABBESTELLUNG: Pruefidentifikator = Pruefidentifikator::const_new(17008);
        assert_eq!(BESTELLUNG.as_u32(), 17007);
        // Typed constants must be usable directly as match patterns
        // (structural equality via derived PartialEq/Eq on a plain u32 field).
        let got = Pruefidentifikator::new(17008).unwrap();
        let label = match got {
            BESTELLUNG => "bestellung",
            ABBESTELLUNG => "abbestellung",
            _ => "other",
        };
        assert_eq!(label, "abbestellung");
    }

    #[test]
    fn as_str_and_as_ref() {
        let g = MarktpartnerCode::new("4012345000009");
        assert_eq!(g.as_str(), "4012345000009");
        let s: &str = g.as_ref();
        assert_eq!(s, "4012345000009");
    }
}