profile-runtime 0.1.0

Canonical effective constitution and profile composition runtime for the local-first AI systems stack
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use stack_ids::{
    ApplicabilityContextId, CompiledObligationSetId, CompositionConflictSetId,
    CompositionReceiptId, CompositionRuleSetId, ContentDigest, EffectiveConstitutionId,
    PolicyImpactDiffId, ProfileExceptionBundleId, ProfileSetId,
};

use crate::rules::{CompiledObligationKindV1, FoldClassV1};

pub const COMPOSITION_RECEIPT_V1_SCHEMA: &str = "composition_receipt_v1";
pub const EFFECTIVE_CONSTITUTION_V1_SCHEMA: &str = "effective_constitution_v1";
pub const COMPILED_OBLIGATION_SET_V1_SCHEMA: &str = "compiled_obligation_set_v1";
pub const COMPOSITION_CONFLICT_SET_V1_SCHEMA: &str = "composition_conflict_set_v1";
pub const POLICY_IMPACT_DIFF_V1_SCHEMA: &str = "policy_impact_diff_v1";

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct CompositionReceiptV1 {
    pub schema_version: String,
    pub composition_receipt_id: CompositionReceiptId,
    pub applicability_context_ref: ApplicabilityContextId,
    pub profile_set_ref: ProfileSetId,
    pub composition_rule_set_ref: CompositionRuleSetId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub effective_constitution_ref: Option<EffectiveConstitutionId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub compiled_obligation_set_ref: Option<CompiledObligationSetId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub composition_conflict_set_ref: Option<CompositionConflictSetId>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub degradation_markers: Vec<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub execution_context_ref: Option<String>,
    pub replay_handle: String,
    pub normalized_input_digest: ContentDigest,
    pub generated_at: String,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ConstitutionModeV1 {
    Normal,
    Incident,
    AdvisoryOnly,
    Blocked,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct EffectiveConstitutionV1 {
    pub schema_version: String,
    pub effective_constitution_id: EffectiveConstitutionId,
    pub applicability_context_ref: ApplicabilityContextId,
    pub profile_set_ref: ProfileSetId,
    pub composition_rule_set_ref: CompositionRuleSetId,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub base_law_refs: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub doctrine_refs: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub admitted_profile_refs: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub admitted_exception_refs: Vec<ProfileExceptionBundleId>,
    pub current_mode_classification: ConstitutionModeV1,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub hard_block_summary: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub active_warning_summary: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub approval_requirements: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub disclosure_obligations: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub residency_obligations: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tenancy_obligations: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub assurance_obligations: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub monitoring_obligations: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub continuity_obligations: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub effect_obligations: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub delegation_obligations: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub replay_obligations: Vec<String>,
    pub valid_as_of: String,
    pub recorded_as_of: String,
    pub explanation_summary: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct CompiledObligationEntryV1 {
    pub obligation_entry_id: String,
    pub obligation_family: String,
    pub obligation_key: String,
    pub output_kind: CompiledObligationKindV1,
    pub fold_class: FoldClassV1,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub string_values: Vec<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub numeric_value: Option<i64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub expiry_at: Option<String>,
    pub blocking: bool,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub source_profile_refs: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub source_exception_refs: Vec<ProfileExceptionBundleId>,
    pub explanation: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct BlockEntryV1 {
    pub block_key: String,
    pub reason: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub source_profile_refs: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub admissible_exception_classes: Vec<String>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct CompiledObligationSetV1 {
    pub schema_version: String,
    pub compiled_obligation_set_id: CompiledObligationSetId,
    pub effective_constitution_ref: EffectiveConstitutionId,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub obligation_entries: Vec<CompiledObligationEntryV1>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub block_entries: Vec<BlockEntryV1>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub required_approvals: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub required_checks: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub required_monitors: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub required_evidence_obligations: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub required_disclosure_obligations: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub required_rollback_obligations: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub required_compensation_obligations: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub required_post_hoc_review_obligations: Vec<String>,
    pub promotion_eligibility_summary: String,
    pub release_eligibility_summary: String,
    pub effect_eligibility_summary: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub unresolved_dependency_refs: Vec<String>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct CompositionConflictV1 {
    pub obligation_family: String,
    pub obligation_key: String,
    pub conflict_class: String,
    pub blocking: bool,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub source_profile_refs: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub implicated_values: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub admissible_exception_classes: Vec<String>,
    pub review_path: String,
    pub explanation: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct CompositionConflictSetV1 {
    pub schema_version: String,
    pub composition_conflict_set_id: CompositionConflictSetId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub effective_constitution_ref: Option<EffectiveConstitutionId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub composition_receipt_ref: Option<CompositionReceiptId>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub conflicts: Vec<CompositionConflictV1>,
    pub blocking: bool,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct PolicyImpactDiffV1 {
    pub schema_version: String,
    pub policy_impact_diff_id: PolicyImpactDiffId,
    pub from_effective_constitution_ref: EffectiveConstitutionId,
    pub to_effective_constitution_ref: EffectiveConstitutionId,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub changed_obligation_families: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub unchanged_obligation_families: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub newly_blocked_paths: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub newly_admitted_paths: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub changed_approval_behavior: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub changed_monitoring_behavior: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub changed_disclosure_behavior: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub changed_residency_behavior: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub changed_incident_behavior: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub migration_consequences: Vec<String>,
    pub simulation_only: bool,
    pub explanation_summary: String,
}