helm-schema-ir 0.0.4

Generate an accurate JSON schema for any helm chart
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

use std::collections::{BTreeMap, BTreeSet};

use super::{ContractDocument, ContractUse};
use crate::contract_signal_builder::derive_schema_signals_from_contract_parts;
use helm_schema_core::ContractSchemaSignals;

/// Finalized contract artifact derived from one canonical normalized contract.
///
/// Stable inspection rows and schema-lowering signals come from the same
/// normalized contract uses, so downstream callers do not need to re-finalize
/// a [`super::ContractIr`] separately or hop through another wrapper type.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct FinalizedContract {
    uses: Vec<ContractUse>,
    schema_signals: ContractSchemaSignals,
}

impl FinalizedContract {
    #[expect(
        clippy::too_many_arguments,
        reason = "each parameter is one interpreter fact channel; a struct would mirror the same fields without adding an invariant"
    )]
    pub(in crate::contract) fn new(
        normalized_uses: Vec<ContractUse>,
        type_hints: &BTreeMap<String, BTreeSet<String>>,
        guarded_type_hints: &BTreeMap<String, BTreeSet<String>>,
        fallback_type_hints: &BTreeMap<String, BTreeSet<String>>,
        guarded_fallback_type_hints: &BTreeMap<String, BTreeSet<String>>,
        shape_erased_value_paths: &BTreeSet<String>,
        string_contract_value_paths: &BTreeSet<String>,
        range_modes: &crate::range_modes::RangeModes,
        values_default_sources: BTreeSet<crate::ValuesDefaultSource>,
        values_root_overlay_prefixes: BTreeSet<String>,
        values_program_wrappers: BTreeSet<helm_schema_core::ValuesProgramWrapper>,
        values_program_wrapper_exclusions: BTreeSet<String>,
        fail_conditions: &[crate::eval_effect::FailCapture],
        dependency_values_root_fragments: &BTreeSet<String>,
    ) -> Self {
        let schema_signals = derive_schema_signals_from_contract_parts(
            &normalized_uses,
            type_hints,
            guarded_type_hints,
            fallback_type_hints,
            guarded_fallback_type_hints,
            shape_erased_value_paths,
            string_contract_value_paths,
            range_modes,
            fail_conditions,
            dependency_values_root_fragments,
        )
        .with_values_default_sources(values_default_sources)
        .with_root_overlay_fail_implications(values_root_overlay_prefixes)
        .with_values_program_wrappers(values_program_wrappers)
        .with_values_program_wrapper_exclusions(values_program_wrapper_exclusions);

        Self {
            uses: normalized_uses,
            schema_signals,
        }
    }

    /// Returns normalized contract uses in stable inspection order.
    #[must_use]
    pub fn uses(&self) -> &[ContractUse] {
        &self.uses
    }

    /// Returns path-local facts prepared for schema lowering.
    #[must_use]
    pub fn schema_signals(&self) -> &ContractSchemaSignals {
        &self.schema_signals
    }

    /// Builds the versioned inspection document for this contract.
    #[must_use]
    pub fn document(&self) -> ContractDocument {
        ContractDocument::from_contract_uses(self.uses.clone())
    }

    /// Consumes the contract and returns its schema-lowering signals.
    #[must_use]
    pub fn into_schema_signals(self) -> ContractSchemaSignals {
        self.schema_signals
    }
}