dpp-domain 0.21.0

//! The compiled-in lens catalogue and the transforms it is built from.

use semver::Version;
use serde_json::Value;

use super::transform::{Lens, LensError};

/// The compiled-in lenses shipped with core, versioned alongside the schemas
/// they bridge.
pub(super) fn builtin_lenses() -> Vec<Lens> {
    vec![
        Lens::new(
            "battery",
            Version::new(1, 0, 0),
            Version::new(2, 0, 0),
            false,
            "EU Battery Regulation 2023/1542 Annex XIII v2.0.0: derives ratedEnergyWh (Wh) \
             from v1 ratedCapacityKwh (kWh); every other v2 field is an optional addition.",
            battery_v1_to_v2,
        ),
        // 🚨 v2.0.0 → v2.4.0 was a four-hop hole in the catalogue. Nothing
        // failed, because every one of those versions is listed in
        // `schema_compat.rs`'s expected refusals and refuses at 2.4.0 → 2.5.0
        // anyway — so the missing chain and the documented refusal produced the
        // same outcome, and the chain stayed invisible behind it. Each hop below
        // adds only optional fields: `required` is byte-identical across
        // v2.0.0–v2.4.0, and `batteryType` is the single addition at v2.5.0.
        Lens::new(
            "battery",
            Version::new(2, 0, 0),
            Version::new(2, 1, 0),
            false,
            "EU Battery Regulation 2023/1542 Art. 7(2) v2.1.0: drops the invented A-E \
             enumeration on carbonFootprintClass — Art. 7(2) defines no class labels — \
             and adds the ruleset id and version that produced a label, both optional. \
             Dropping an enumeration only widens what validates, so a v2.0.0 record \
             carrying a former class value stays valid; a record with no ruleset \
             recorded is one whose class came from a scale this crate cannot name, \
             which is a fact about that record rather than something to invent.",
            pass_through,
        ),
        Lens::new(
            "battery",
            Version::new(2, 1, 0),
            Version::new(2, 2, 0),
            false,
            "EU Battery Regulation 2023/1542 Annex VII Part A v2.2.0: adds stateOfHealth, \
             optional, alongside the flat stateOfHealthPct it cannot replace. Nothing to \
             carry forward — the flat figure is not one of Part A's parameters, so \
             deriving the parameter set from it would state a measurement nobody made.",
            pass_through,
        ),
        Lens::new(
            "battery",
            Version::new(2, 2, 0),
            Version::new(2, 3, 0),
            false,
            "EU Battery Regulation 2023/1542 Art. 8(1) v2.3.0: adds \
             recycledContentReportingYear, optional. Art. 8(1) wants the shares 'for each \
             battery model per year and per manufacturing plant', so a v2.2.0 record \
             carries a share with one of its two anchors missing. The year cannot be \
             inferred — placedOnMarketDate is when the battery was placed, not the year \
             the recycled content was reported for — so the absence is carried forward \
             rather than filled.",
            pass_through,
        ),
        Lens::new(
            "battery",
            Version::new(2, 3, 0),
            Version::new(2, 4, 0),
            false,
            "EU Battery Regulation 2023/1542 Annex VII Part B v2.4.0: adds \
             expectedLifetime, optional, and narrower than Part A — stationary storage \
             and LMT batteries only, not electric-vehicle ones. Distinct from \
             expectedLifetimeCycles, the model-level figure Annex XIII point 1(j) makes \
             public, which v2.3.0 already required and which is unchanged here.",
            pass_through,
        ),
        Lens::new(
            "battery",
            Version::new(2, 4, 0),
            Version::new(2, 5, 0),
            false,
            "EU Battery Regulation 2023/1542 Annex VI Part A point 2 (via Annex XIII \
             point 1(a)) v2.5.0: batteryType becomes required and closed. A v2.4.0 \
             record with no batteryType predates the mandate and cannot be upgraded \
             without inventing a value, so this hop refuses rather than default one.",
            battery_v2_4_to_v2_5,
        ),
        Lens::new(
            "battery",
            Version::new(2, 5, 0),
            Version::new(2, 6, 0),
            false,
            "EU Battery Regulation 2023/1542 Annex XIII point 4 v2.6.0: adds the \
             individual-battery tier — dynamicPerformance (4(a)), batteryStatus (4(c)) \
             and usageHistory (4(d)) — all optional, and relaxes \
             expectedLifetimeCycles out of required, since point 1(j) reaches \
             industrial batteries only where lifetime can be expressed in cycles. \
             Also splits Annex XIII point 1(n) into its two figures and point 1(o) \
             into cell and pack resistance; the 1(o) hop refuses rather than guess \
             which measurement a single stored value was.",
            battery_v2_5_to_v2_6,
        ),
        Lens::new(
            "electronics",
            Version::new(1, 1, 0),
            Version::new(1, 2, 0),
            false,
            "Regulation (EU) 2023/1670 Art. 1(1) v1.2.0: productCategory is narrowed to the \
             four device types the regulation actually enumerates (smartphone, other mobile \
             phone, cordless phone, slate tablet). A v1.1.0 record declaring one of the seven \
             removed values has no lawful category to upgrade into, so this hop refuses.",
            electronics_v1_1_to_v1_2,
        ),
        Lens::new(
            "steel",
            Version::new(1, 0, 0),
            Version::new(1, 1, 0),
            false,
            "Cross-product_group naming consistency: renames countryOfProduction to \
             countryOfOrigin. Pure rename, no information lost.",
            rename_country_of_production,
        ),
        Lens::new(
            "aluminium",
            Version::new(1, 0, 0),
            Version::new(1, 1, 0),
            false,
            "Cross-product_group naming consistency: renames countryOfProduction to \
             countryOfOrigin. Pure rename, no information lost.",
            rename_country_of_production,
        ),
        Lens::new(
            "construction",
            Version::new(1, 0, 0),
            Version::new(1, 1, 0),
            false,
            "Cross-product_group naming consistency: renames countryOfManufacture to \
             countryOfOrigin. Pure rename, no information lost.",
            rename_country_of_manufacture,
        ),
        Lens::new(
            "detergent",
            Version::new(1, 0, 0),
            Version::new(1, 1, 0),
            false,
            "Cross-product_group naming consistency: renames countryOfManufacture to \
             countryOfOrigin. Pure rename, no information lost.",
            rename_country_of_manufacture,
        ),
        Lens::new(
            "furniture",
            Version::new(1, 0, 0),
            Version::new(1, 1, 0),
            false,
            "Cross-product_group naming consistency: renames countryOfManufacture to \
             countryOfOrigin. Pure rename, no information lost.",
            rename_country_of_manufacture,
        ),
        Lens::new(
            "toy",
            Version::new(1, 0, 0),
            Version::new(1, 1, 0),
            false,
            "Cross-product_group naming consistency: renames countryOfManufacture to \
             countryOfOrigin. Pure rename, no information lost.",
            rename_country_of_manufacture,
        ),
        Lens::new(
            "textile",
            Version::new(1, 0, 0),
            Version::new(1, 1, 0),
            false,
            "v1.1.0 adds sixteen optional fields (SCIP/SVHC disclosure, per-fibre \
             origin, durability, microplastic shedding) and changes nothing that \
             already existed: the two versions declare identical `required` lists \
             and v1.1.0 removes no property. Purely additive, so the document \
             passes through untouched — but the lens must exist, because a chain \
             cannot cross a gap, and without it a v1.0.0 document has no path to \
             the current version and cannot be read at all.",
            identity,
        ),
        Lens::new(
            "textile",
            Version::new(1, 1, 0),
            Version::new(1, 2, 0),
            false,
            "Cross-product_group naming consistency: renames countryOfManufacturing to \
             countryOfOrigin. Pure rename, no information lost.",
            rename_country_of_manufacturing,
        ),
        Lens::new(
            "aluminium",
            Version::new(1, 1, 0),
            Version::new(1, 2, 0),
            false,
            "EN 18219:2026 clause 5.1: the unique product identifier becomes a union of the \
             clause 5 schemes, so a GTIN is no longer structurally required. A record \
             written against the previous version carried one, which is exactly a \
             scheme 1 identifier, so this hop wraps it rather than asking for anything \
             the record does not already have. Lossless and total.",
            gtin_to_product_identifier,
        ),
        Lens::new(
            "battery",
            Version::new(2, 6, 0),
            Version::new(2, 7, 0),
            false,
            "EN 18219:2026 clause 5.1: the unique product identifier becomes a union of the \
             clause 5 schemes, so a GTIN is no longer structurally required. A record \
             written against the previous version carried one, which is exactly a \
             scheme 1 identifier, so this hop wraps it rather than asking for anything \
             the record does not already have. Lossless and total.",
            gtin_to_product_identifier,
        ),
        Lens::new(
            "construction",
            Version::new(1, 1, 0),
            Version::new(1, 2, 0),
            false,
            "EN 18219:2026 clause 5.1: the unique product identifier becomes a union of the \
             clause 5 schemes, so a GTIN is no longer structurally required. A record \
             written against the previous version carried one, which is exactly a \
             scheme 1 identifier, so this hop wraps it rather than asking for anything \
             the record does not already have. Lossless and total.",
            gtin_to_product_identifier,
        ),
        Lens::new(
            "detergent",
            Version::new(1, 1, 0),
            Version::new(1, 2, 0),
            false,
            "EN 18219:2026 clause 5.1: the unique product identifier becomes a union of the \
             clause 5 schemes, so a GTIN is no longer structurally required. A record \
             written against the previous version carried one, which is exactly a \
             scheme 1 identifier, so this hop wraps it rather than asking for anything \
             the record does not already have. Lossless and total.",
            gtin_to_product_identifier,
        ),
        Lens::new(
            "electronics",
            Version::new(1, 3, 0),
            Version::new(1, 4, 0),
            false,
            "EN 18219:2026 clause 5.1: the unique product identifier becomes a union of the \
             clause 5 schemes, so a GTIN is no longer structurally required. A record \
             written against the previous version carried one, which is exactly a \
             scheme 1 identifier, so this hop wraps it rather than asking for anything \
             the record does not already have. Lossless and total.",
            gtin_to_product_identifier,
        ),
        Lens::new(
            "furniture",
            Version::new(1, 2, 0),
            Version::new(1, 3, 0),
            false,
            "EN 18219:2026 clause 5.1: the unique product identifier becomes a union of the \
             clause 5 schemes, so a GTIN is no longer structurally required. A record \
             written against the previous version carried one, which is exactly a \
             scheme 1 identifier, so this hop wraps it rather than asking for anything \
             the record does not already have. Lossless and total.",
            gtin_to_product_identifier,
        ),
        Lens::new(
            "mattress",
            Version::new(1, 0, 0),
            Version::new(1, 1, 0),
            false,
            "EN 18219:2026 clause 5.1: the unique product identifier becomes a union of the \
             clause 5 schemes, so a GTIN is no longer structurally required. A record \
             written against the previous version carried one, which is exactly a \
             scheme 1 identifier, so this hop wraps it rather than asking for anything \
             the record does not already have. Lossless and total.",
            gtin_to_product_identifier,
        ),
        Lens::new(
            "steel",
            Version::new(1, 1, 0),
            Version::new(1, 2, 0),
            false,
            "EN 18219:2026 clause 5.1: the unique product identifier becomes a union of the \
             clause 5 schemes, so a GTIN is no longer structurally required. A record \
             written against the previous version carried one, which is exactly a \
             scheme 1 identifier, so this hop wraps it rather than asking for anything \
             the record does not already have. Lossless and total.",
            gtin_to_product_identifier,
        ),
        Lens::new(
            "textile",
            Version::new(1, 2, 0),
            Version::new(1, 3, 0),
            false,
            "EN 18219:2026 clause 5.1: the unique product identifier becomes a union of the \
             clause 5 schemes, so a GTIN is no longer structurally required. A record \
             written against the previous version carried one, which is exactly a \
             scheme 1 identifier, so this hop wraps it rather than asking for anything \
             the record does not already have. Lossless and total.",
            gtin_to_product_identifier,
        ),
        Lens::new(
            "toy",
            Version::new(1, 1, 0),
            Version::new(1, 2, 0),
            false,
            "EN 18219:2026 clause 5.1: the unique product identifier becomes a union of the \
             clause 5 schemes, so a GTIN is no longer structurally required. A record \
             written against the previous version carried one, which is exactly a \
             scheme 1 identifier, so this hop wraps it rather than asking for anything \
             the record does not already have. Lossless and total.",
            gtin_to_product_identifier,
        ),
        Lens::new(
            "tyre",
            Version::new(1, 0, 0),
            Version::new(1, 1, 0),
            false,
            "EN 18219:2026 clause 5.1: the unique product identifier becomes a union of the \
             clause 5 schemes, so a GTIN is no longer structurally required. A record \
             written against the previous version carried one, which is exactly a \
             scheme 1 identifier, so this hop wraps it rather than asking for anything \
             the record does not already have. Lossless and total.",
            gtin_to_product_identifier,
        ),
        // ── Gaps that predate the identifier change and it exposed ─────────
        //
        // Each of these three hops was missing from the catalogue already. They
        // did no harm while a record's shape happened to survive the jump, and
        // `every_frozen_document_still_reads_through_from_stored` only fails on
        // a version whose *final* hop is missing — so a broken middle stayed
        // invisible until the identifier swap made the last hop mandatory for
        // every group. Adding them is not part of EN 18219; it is the debt the
        // swap surfaced.
        Lens::new(
            "electronics",
            Version::new(1, 0, 0),
            Version::new(1, 1, 0),
            false,
            "Regulation (EU) 2023/1669 v1.1.0: repairabilityScore becomes the structured \
             {overall, criteria} shape. A v1.0.0 record declaring the bare number it \
             specified is rewritten into that shape; one omitting the optional field \
             passes through, which is every record this crate ever produced, since the \
             Rust type never emitted the bare form.",
            electronics_v1_0_to_v1_1,
        ),
        Lens::new(
            "electronics",
            Version::new(1, 2, 0),
            Version::new(1, 3, 0),
            false,
            "Regulation (EU) 2023/1669 Annex IV point 5 v1.3.0: adds \
             repairabilityIndexInputs and indexScopeExclusion, both optional. Nothing \
             to carry forward — a v1.2.0 record is a v1.3.0 record that declares \
             neither, and declaring neither is a lawful answer rather than a gap.",
            pass_through,
        ),
        Lens::new(
            "furniture",
            Version::new(1, 1, 0),
            Version::new(1, 2, 0),
            true,
            "ESPR Working Plan 2025-2030 v1.2.0: productType no longer admits `mattress` \
             — the plan selects mattresses as a product group of their own, ranked and \
             dated separately. A furniture record declaring `mattress` describes a \
             product this group no longer covers, and there is no furniture type to \
             substitute, so the hop refuses rather than silently reclassifying it.",
            furniture_v1_1_to_v1_2,
        ),
    ]
}

/// A schema step that added only optional fields: the document is already valid
/// under the later version, so it passes through untouched.
///
/// Not redundant. `upcast_str_toward` walks a chain of lenses, and a missing
/// step breaks the whole chain — a document two versions behind cannot reach the
/// current version through a gap, even when the gap itself requires no change.
fn identity(v: &Value) -> Result<Value, LensError> {
    Ok(v.clone())
}

/// Renames a top-level JSON key to `countryOfOrigin`, leaving every other
/// field untouched. Shared by the country-of-origin naming-unification lenses
/// above — each product group's old key differs, so the key name is a parameter.
fn rename_country_field(v: &Value, old_key: &str) -> Result<Value, LensError> {
    let mut out = v.clone();
    let obj = out
        .as_object_mut()
        .ok_or_else(|| LensError("product_group data must be a JSON object".to_owned()))?;
    if let Some(val) = obj.remove(old_key) {
        obj.insert("countryOfOrigin".to_owned(), val);
    }
    Ok(out)
}

fn rename_country_of_production(v: &Value) -> Result<Value, LensError> {
    rename_country_field(v, "countryOfProduction")
}

fn rename_country_of_manufacture(v: &Value) -> Result<Value, LensError> {
    rename_country_field(v, "countryOfManufacture")
}

fn rename_country_of_manufacturing(v: &Value) -> Result<Value, LensError> {
    rename_country_field(v, "countryOfManufacturing")
}

/// Battery `v1.0.0 → v2.0.0`: pass all fields through, and derive `ratedEnergyWh`
/// (watt-hours) from `ratedCapacityKwh` (kilowatt-hours) when present. Lossless —
/// v2 is a strict superset whose only computable field from v1 data is the
/// watt-hour restatement of the kilowatt-hour rating.
fn battery_v1_to_v2(v1: &Value) -> Result<Value, LensError> {
    let mut out = v1.clone();
    let obj = out
        .as_object_mut()
        .ok_or_else(|| LensError("battery product_group data must be a JSON object".to_owned()))?;
    if let Some(kwh) = obj.get("ratedCapacityKwh").and_then(Value::as_f64)
        && !obj.contains_key("ratedEnergyWh")
    {
        // Restate kWh as Wh, stripping f64 noise (e.g. 100.00000000000001 → 100.0)
        // while keeping up to 6 real decimals.
        let wh = (kwh * 1000.0 * 1_000_000.0).round() / 1_000_000.0;
        obj.insert("ratedEnergyWh".to_owned(), serde_json::json!(wh));
    }
    Ok(out)
}

/// Battery `v2.4.0 → v2.5.0`: passes every field through unchanged. Refuses,
/// rather than defaulting a value, when `batteryType` is absent or not a
/// string — the field becomes required at v2.5.0, and a record written before
/// the mandate existed cannot be made to satisfy it without inventing a
/// category the manufacturer never declared.
fn battery_v2_4_to_v2_5(v: &Value) -> Result<Value, LensError> {
    let obj = v
        .as_object()
        .ok_or_else(|| LensError("battery product_group data must be a JSON object".to_owned()))?;
    match obj.get("batteryType") {
        Some(Value::String(_)) => Ok(v.clone()),
        _ => Err(LensError(
            "batteryType is required from v2.5.0 (EU 2023/1542 Annex VI Part A point 2 \
             via Annex XIII point 1(a)); this record predates the mandate and has none, \
             so it cannot be upgraded"
                .to_owned(),
        )),
    }
}

/// Battery `v2.5.0 → v2.6.0`: additions pass through, one key is renamed, and
/// one **refuses**.
///
/// The additive half is straightforward. `dynamicPerformance`, `batteryStatus`
/// and `usageHistory` are optional, and `expectedLifetimeCycles` only *stops*
/// being required, which no existing record can fail. Absence stays absent —
/// materialising an empty point-4 block would assert that the battery reported
/// measurements it never reported.
///
/// **`roundTripEfficiencyPct` and `internalResistanceMohm` are carried
/// verbatim.** Annex XIII splits each into a pair at v2.6.0 — 1(n) into the
/// initial figure and the one at 50 % of cycle-life, 1(o) into cell and pack —
/// but neither legacy value can be assigned to a half of its pair. The first
/// was documented against "50% state of charge", a condition 1(n) does not
/// state; the second cannot say whether it was the cell or the pack. Both keys
/// therefore survive into v2.6.0 under their own names, marked legacy, and the
/// successor fields carry new declarations only. Moving a value would invent
/// the very distinction the split exists to record.
fn battery_v2_5_to_v2_6(v: &Value) -> Result<Value, LensError> {
    if !v.is_object() {
        return Err(LensError(
            "battery product_group data must be a JSON object".to_owned(),
        ));
    }
    Ok(v.clone())
}

/// Electronics `v1.1.0 → v1.2.0`: passes every field through unchanged.
/// Refuses, rather than dropping or substituting the record's own category,
/// when `productCategory` is not one of the four device types Regulation
/// (EU) 2023/1670 Art. 1(1) actually enumerates — a record declaring
/// `laptop`, `tv`, or any of the other removed values was written against a
/// category this product group never had a lawful basis for, and there is no value
/// to substitute that would not misdescribe the product.
fn electronics_v1_1_to_v1_2(v: &Value) -> Result<Value, LensError> {
    const VALID: [&str; 4] = [
        "smartphone",
        "other-mobile-phone",
        "cordless-phone",
        "tablet",
    ];
    let obj = v.as_object().ok_or_else(|| {
        LensError("electronics product_group data must be a JSON object".to_owned())
    })?;
    match obj.get("productCategory") {
        Some(Value::String(s)) if VALID.contains(&s.as_str()) => Ok(v.clone()),
        _ => Err(LensError(
            "productCategory is not one of the four device types Regulation (EU) 2023/1670 \
             Art. 1(1) enumerates (smartphone, other-mobile-phone, cordless-phone, tablet); \
             this record predates the narrowing and cannot be upgraded"
                .to_owned(),
        )),
    }
}

/// Every product group's hop to the EN 18219 clause 5 identifier: rewrites the
/// record's `gtin` as a scheme 1 `productIdentifier`, in place.
///
/// Shared by all eleven groups because the change is the same one in each — the
/// field is the same, the scheme it maps to is the same, and a per-group copy
/// would be eleven chances to diverge on a transform with no group-specific
/// content.
///
/// **Total, not lossy.** Every record written against a previous version
/// carries a `gtin` — it was required — and a GTIN *is* a scheme 1 identifier,
/// so there is nothing to invent and nothing to drop. A record reaching here
/// without one was never valid against the version it claims, and refusing is
/// the honest answer: the alternative is inventing an identifier for a product.
///
/// The key keeps `gtin`'s position so a diff of the derived view against the
/// original reads as a substitution rather than a move.
fn gtin_to_product_identifier(v: &Value) -> Result<Value, LensError> {
    let Some(object) = v.as_object() else {
        return Err(LensError(
            "product group data must be a JSON object".to_owned(),
        ));
    };
    let Some(gtin) = object.get("gtin") else {
        return Err(LensError(
            "this version required a gtin and the record carries none, so there is \
             no scheme 1 identifier to derive and none may be invented"
                .to_owned(),
        ));
    };

    let mut out = serde_json::Map::with_capacity(object.len());
    for (key, value) in object {
        if key == "gtin" {
            out.insert(
                "productIdentifier".to_owned(),
                serde_json::json!({ "scheme": "gs1", "gtin": gtin }),
            );
        } else {
            out.insert(key.clone(), value.clone());
        }
    }
    Ok(Value::Object(out))
}

/// Electronics `v1.0.0 → v1.1.0`: rewrites a bare-number `repairabilityScore`
/// into the structured `{ overall, criteria }` shape v1.1.0 specifies.
///
/// The field is optional, and this crate's type never produced the bare form —
/// v1.0.0 declared it and the Rust struct did not follow. So the common case is
/// a record that simply has no score, which passes straight through.
fn electronics_v1_0_to_v1_1(v: &Value) -> Result<Value, LensError> {
    let Some(object) = v.as_object() else {
        return Err(LensError(
            "electronics product group data must be a JSON object".to_owned(),
        ));
    };
    let mut out = object.clone();
    if let Some(score) = object.get("repairabilityScore")
        && let Some(overall) = score.as_f64()
    {
        out.insert(
            "repairabilityScore".to_owned(),
            serde_json::json!({ "overall": overall }),
        );
    }
    Ok(Value::Object(out))
}

/// Furniture `v1.1.0 → v1.2.0`: refuses a record whose `productType` is
/// `mattress`, which v1.2.0 removed.
///
/// Lossy and refusing rather than lossy and guessing: a mattress is not a
/// furniture type any more, and no other value describes the same product.
fn furniture_v1_1_to_v1_2(v: &Value) -> Result<Value, LensError> {
    let Some(object) = v.as_object() else {
        return Err(LensError(
            "furniture product group data must be a JSON object".to_owned(),
        ));
    };
    if object.get("productType").and_then(Value::as_str) == Some("mattress") {
        return Err(LensError(
            "productType is 'mattress', which v1.2.0 removed because the ESPR \
             working plan ranks mattresses as their own product group; no \
             furniture type describes this product and none may be substituted"
                .to_owned(),
        ));
    }
    Ok(v.clone())
}

/// A hop that adds only optional fields: the record is already valid at the new
/// version and there is nothing to derive.
fn pass_through(v: &Value) -> Result<Value, LensError> {
    if !v.is_object() {
        return Err(LensError(
            "product group data must be a JSON object".to_owned(),
        ));
    }
    Ok(v.clone())
}