dtcs 0.7.0

Reference implementation of the Data Transformation Contract Standard (DTCS)
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

//! Extension validation phase (SPEC Chapters 9 ยง10, 21).

use crate::diagnostics::{codes, DiagnosticCategory};
use crate::model::{
    ExtensionCompatibility, RegistryCategory, RegistryDocument, TransformationContract,
};
use crate::registry;

use super::context::{
    is_namespaced_identifier, is_vendor_namespaced_identifier, ValidationContext,
};

pub(crate) fn validate_extensions(
    ctx: &mut ValidationContext,
    contract: &TransformationContract,
    registry: &RegistryDocument,
) {
    validate_extension_keys(ctx, contract, registry);
}

/// Validates extension and unknown top-level fields captured by serde flatten.
pub fn validate_extension_keys(
    ctx: &mut ValidationContext,
    contract: &TransformationContract,
    registry: &RegistryDocument,
) {
    for key in contract.extensions.keys() {
        if key == "extensions" {
            if contract.extensions.get(key).is_some_and(|v| v.is_object()) {
                ctx.error(
                    codes::INVALID_EXTENSION,
                    DiagnosticCategory::Structure,
                    "vendor keys must be flattened at the contract level, not nested under 'extensions'",
                    Some(key),
                    Some("Use vendor:fieldName at the top level instead of an extensions wrapper"),
                );
            }
            continue;
        }
        if matches!(key.as_str(), "input" | "output")
            && contract.extensions.get(key).is_some_and(|v| v.is_array())
        {
            let suggestion = if key == "input" { "inputs" } else { "outputs" };
            ctx.error(
                codes::UNKNOWN_FIELD,
                DiagnosticCategory::Structure,
                format!("unknown top-level field '{key}'"),
                Some(key),
                Some(&format!("Did you mean '{suggestion}'?")),
            );
            continue;
        }
        if !is_namespaced_identifier(key) {
            ctx.error(
                codes::UNKNOWN_FIELD,
                DiagnosticCategory::Structure,
                format!("unknown top-level field '{key}'"),
                Some(key),
                Some("Check for typos in standard field names such as inputs or outputs"),
            );
            continue;
        }
        if !is_vendor_namespaced_identifier(key) {
            ctx.error(
                codes::INVALID_EXTENSION,
                DiagnosticCategory::Structure,
                format!("extension key '{key}' must use a vendor namespace"),
                Some(key),
                Some("Use vendor:fieldName for contract-level extensions; dtcs: is reserved"),
            );
            continue;
        }

        // Full-id match first, then namespace prefix.
        if let Some(entry) = registry::resolve(registry, key) {
            check_mandatory_support(ctx, key, entry);
            continue;
        }
        if let Some(namespace) = key.split_once(':').map(|(prefix, _)| prefix) {
            if let Some(entry) = registry::resolve(registry, namespace) {
                if entry.category == RegistryCategory::ExtensionNamespace {
                    check_mandatory_support(ctx, key, entry);
                }
            }
        }
    }
}

fn check_mandatory_support(
    ctx: &mut ValidationContext,
    key: &str,
    entry: &crate::model::RegistryEntry,
) {
    let mandatory = entry.compatibility == Some(ExtensionCompatibility::Mandatory);
    if mandatory && !entry.supported {
        ctx.error(
            codes::UNSUPPORTED_EXTENSION,
            DiagnosticCategory::Extension,
            format!("unsupported mandatory extension '{key}'"),
            Some(key),
            Some("Use a supported extension or remove the mandatory requirement"),
        );
    }
}