dtcs 0.1.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

//! Root transformation contract document.

use indexmap::IndexMap;
use serde::{Deserialize, Serialize};
use serde_json::Value;

use super::{
    Expression, Function, Input, Lineage, Metadata, Output, Rule, SemanticAction,
    TransformationSemantics, Versioning,
};

/// Supported DTCS specification versions for this implementation.
pub const SUPPORTED_DTCS_VERSIONS: &[&str] = &["1.0.0", "1.0.0-draft"];

/// A DTCS Transformation Contract — the canonical root object.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TransformationContract {
    /// DTCS specification version.
    pub dtcs_version: String,
    /// Stable contract identifier.
    pub id: String,
    /// Human-readable contract name.
    pub name: String,
    /// Contract version.
    pub version: String,
    /// Optional metadata.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub metadata: Option<Metadata>,
    /// Declared inputs.
    #[serde(default)]
    pub inputs: Vec<Input>,
    /// Declared outputs.
    #[serde(default)]
    pub outputs: Vec<Output>,
    /// Semantic actions.
    #[serde(default)]
    pub semantic_actions: Vec<SemanticAction>,
    /// Expressions.
    #[serde(default)]
    pub expressions: Vec<Expression>,
    /// Functions.
    #[serde(default)]
    pub functions: Vec<Function>,
    /// Rules.
    #[serde(default)]
    pub rules: Vec<Rule>,
    /// Lineage metadata.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub lineage: Option<Lineage>,
    /// Versioning metadata.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub versioning: Option<Versioning>,
    /// Semantic flags.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub semantics: Option<TransformationSemantics>,
    /// Vendor extension fields preserved verbatim.
    #[serde(default, flatten)]
    pub extensions: IndexMap<String, Value>,
}

impl TransformationContract {
    /// Validates the contract and returns a diagnostic report.
    #[must_use]
    pub fn validate(&self) -> crate::ValidationReport {
        crate::validate(self)
    }

    /// Returns all declared schema field names across inputs and outputs.
    #[must_use]
    pub fn declared_field_names(&self) -> Vec<String> {
        let mut names = Vec::new();
        for input in &self.inputs {
            if let Some(schema) = &input.schema {
                for field in &schema.fields {
                    names.push(field.name.clone());
                }
            }
        }
        for output in &self.outputs {
            if let Some(schema) = &output.schema {
                for field in &schema.fields {
                    names.push(field.name.clone());
                }
            }
        }
        names
    }

    /// Returns all declared input and output identifiers.
    #[must_use]
    pub fn interface_ids(&self) -> Vec<String> {
        self.inputs
            .iter()
            .map(|i| i.id.clone())
            .chain(self.outputs.iter().map(|o| o.id.clone()))
            .collect()
    }
}