aidens-contracts 0.1.0

Versioned base contracts — shared primitive artifact shapes for AiDENs
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
use super::*;

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct AiDENsAppPlanV1 {
    pub app_id: String,
    pub profile_id: String,
    pub provider_required: bool,
    pub memory_mode: MemoryModeV1,
    pub receipt_level: ReportLevelV1,
    pub dangerous_auto_approval: bool,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub risk_disclosures: Vec<RiskDisclosureV1>,
    pub enabled_tool_bundles: Vec<String>,
    pub disabled_tool_bundles: Vec<String>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct AiDENsCompiledPlanV1 {
    pub plan_id: ArtifactId,
    pub plan: AiDENsAppPlanV1,
    pub provider_route: ProviderRouteReportV1,
    pub tool_exposure: ToolExposureSetV1,
    pub doctor: AiDENsDoctorReportV1,
    pub config_apply_receipt: ConfigApplyReportV1,
    pub parity_report: PlanRuntimeParityReportV1,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct AiDENsDoctorReportV1 {
    pub report_id: ArtifactId,
    pub app_id: String,
    pub sections: BTreeMap<String, Vec<RuntimeCapabilityTruthV1>>,
}

impl AiDENsDoctorReportV1 {
    pub fn new(
        app_id: impl Into<String>,
        sections: BTreeMap<String, Vec<RuntimeCapabilityTruthV1>>,
    ) -> Self {
        Self {
            report_id: display_only_unstable_id("doctor-report"),
            app_id: app_id.into(),
            sections,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "kebab-case")]
pub enum ApiHonestyOutcomeV1 {
    Honored,
    Rejected,
    Blocked,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct ApiHonestyReportV1 {
    pub receipt_id: ArtifactId,
    pub kind: ArtifactKindV1,
    pub surface: String,
    pub accepted_inputs: Vec<String>,
    pub honored_inputs: Vec<String>,
    pub rejected_inputs: Vec<String>,
    pub outcome: ApiHonestyOutcomeV1,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub reason_codes: Vec<String>,
    pub checked_at: DateTime<Utc>,
}

impl ApiHonestyReportV1 {
    pub fn honored(
        surface: impl Into<String>,
        accepted_inputs: Vec<String>,
        honored_inputs: Vec<String>,
    ) -> Self {
        Self {
            receipt_id: display_only_unstable_id("api-honesty"),
            kind: ArtifactKindV1::ApiHonesty,
            surface: surface.into(),
            accepted_inputs,
            honored_inputs,
            rejected_inputs: Vec::new(),
            outcome: ApiHonestyOutcomeV1::Honored,
            reason_codes: Vec::new(),
            checked_at: Utc::now(),
        }
    }

    pub fn rejected(
        surface: impl Into<String>,
        accepted_inputs: Vec<String>,
        rejected_inputs: Vec<String>,
        reason: impl Into<String>,
    ) -> Self {
        Self {
            receipt_id: display_only_unstable_id("api-honesty"),
            kind: ArtifactKindV1::ApiHonesty,
            surface: surface.into(),
            accepted_inputs,
            honored_inputs: Vec::new(),
            rejected_inputs,
            outcome: ApiHonestyOutcomeV1::Rejected,
            reason_codes: vec![reason.into()],
            checked_at: Utc::now(),
        }
    }

    pub fn blocked(
        surface: impl Into<String>,
        accepted_inputs: Vec<String>,
        rejected_inputs: Vec<String>,
        reason: impl Into<String>,
    ) -> Self {
        let mut receipt = Self::rejected(surface, accepted_inputs, rejected_inputs, reason);
        receipt.outcome = ApiHonestyOutcomeV1::Blocked;
        receipt
    }

    pub fn all_inputs_honored(&self) -> bool {
        self.outcome == ApiHonestyOutcomeV1::Honored
            && self
                .accepted_inputs
                .iter()
                .all(|input| self.honored_inputs.contains(input))
            && self.rejected_inputs.is_empty()
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct ConfigApplyReportV1 {
    pub receipt_id: ArtifactId,
    pub kind: ArtifactKindV1,
    pub app_id: String,
    pub config_source: String,
    pub provider_route: ProviderRouteReportV1,
    pub tool_exposure: ToolExposureSetV1,
    pub memory_mode: MemoryModeV1,
    pub receipt_level: ReportLevelV1,
    pub enabled_tool_bundles: Vec<String>,
    pub sandbox_root: Option<String>,
    pub applied: bool,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub reason_codes: Vec<String>,
    pub applied_at: DateTime<Utc>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct ConfigApplyReportDraftV1 {
    pub app_id: String,
    pub config_source: String,
    pub provider_route: ProviderRouteReportV1,
    pub tool_exposure: ToolExposureSetV1,
    pub memory_mode: MemoryModeV1,
    pub receipt_level: ReportLevelV1,
    pub enabled_tool_bundles: Vec<String>,
    pub sandbox_root: Option<String>,
    pub applied: bool,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub reason_codes: Vec<String>,
}

impl ConfigApplyReportV1 {
    pub fn new(draft: ConfigApplyReportDraftV1) -> Self {
        Self {
            receipt_id: display_only_unstable_id("config-apply"),
            kind: ArtifactKindV1::ConfigApply,
            app_id: draft.app_id,
            config_source: draft.config_source,
            provider_route: draft.provider_route,
            tool_exposure: draft.tool_exposure,
            memory_mode: draft.memory_mode,
            receipt_level: draft.receipt_level,
            enabled_tool_bundles: draft.enabled_tool_bundles,
            sandbox_root: draft.sandbox_root,
            applied: draft.applied,
            reason_codes: draft.reason_codes,
            applied_at: Utc::now(),
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "kebab-case")]
pub enum PlanRuntimeParityCheckKindV1 {
    ProviderRoute,
    ToolExposure,
    MemoryMode,
    ScaffoldState,
}

impl fmt::Display for PlanRuntimeParityCheckKindV1 {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(match self {
            Self::ProviderRoute => "provider-route",
            Self::ToolExposure => "tool-exposure",
            Self::MemoryMode => "memory-mode",
            Self::ScaffoldState => "scaffold-state",
        })
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct PlanRuntimeParityCheckV1 {
    pub check: PlanRuntimeParityCheckKindV1,
    pub expected: String,
    pub observed: String,
    pub passed: bool,
}

impl PlanRuntimeParityCheckV1 {
    pub fn new(
        check: PlanRuntimeParityCheckKindV1,
        expected: impl Into<String>,
        observed: impl Into<String>,
    ) -> Self {
        let expected = expected.into();
        let observed = observed.into();
        Self {
            check,
            passed: expected == observed,
            expected,
            observed,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct PlanRuntimeParityReportV1 {
    pub report_id: ArtifactId,
    pub kind: ArtifactKindV1,
    pub app_id: String,
    pub checks: Vec<PlanRuntimeParityCheckV1>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub mismatches: Vec<String>,
    pub generated_at: DateTime<Utc>,
}

impl PlanRuntimeParityReportV1 {
    pub fn new(app_id: impl Into<String>, checks: Vec<PlanRuntimeParityCheckV1>) -> Self {
        let mismatches = checks
            .iter()
            .filter(|check| !check.passed)
            .map(|check| {
                format!(
                    "{} expected '{}' but observed '{}'",
                    check.check, check.expected, check.observed
                )
            })
            .collect();
        Self {
            report_id: display_only_unstable_id("plan-runtime-parity"),
            kind: ArtifactKindV1::PlanRuntimeParity,
            app_id: app_id.into(),
            checks,
            mismatches,
            generated_at: Utc::now(),
        }
    }

    pub fn is_passing(&self) -> bool {
        self.mismatches.is_empty() && self.checks.iter().all(|check| check.passed)
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "kebab-case")]
pub enum CrateImplementationStatusV1 {
    Implemented,
    Partial,
    ScaffoldOnly,
}

impl fmt::Display for CrateImplementationStatusV1 {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(match self {
            Self::Implemented => "implemented",
            Self::Partial => "partial",
            Self::ScaffoldOnly => "scaffold-only",
        })
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct SourceBasisLockV1 {
    pub lock_id: ArtifactId,
    pub snapshot_date: String,
    pub source_archive: String,
    pub research_archive: String,
    pub extraction_root: String,
    pub workspace_crates: u32,
    pub rust_files: u32,
    pub approximate_rust_loc: u32,
    pub scaffold_only_files: u32,
    pub research_files: u32,
    pub locked_at: DateTime<Utc>,
}

impl SourceBasisLockV1 {
    pub fn current_20260426() -> Self {
        Self {
            lock_id: display_only_unstable_id("source-basis-lock"),
            snapshot_date: "2026-04-26".into(),
            source_archive: "libraries-source-clean-20260426.zip".into(),
            research_archive: "Full Provenance+ Research 4/24/26.zip".into(),
            extraction_root: "/mnt/data/aidens_20260426".into(),
            workspace_crates: 31,
            rust_files: 37,
            approximate_rust_loc: 5126,
            scaffold_only_files: 15,
            research_files: 52,
            locked_at: Utc::now(),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct CrateSurfaceStatusV1 {
    pub crate_name: String,
    pub status: CrateImplementationStatusV1,
    pub rust_files: u32,
    pub approximate_rust_loc: u32,
    pub note: String,
}

impl CrateSurfaceStatusV1 {
    pub fn new(
        crate_name: impl Into<String>,
        status: CrateImplementationStatusV1,
        rust_files: u32,
        approximate_rust_loc: u32,
        note: impl Into<String>,
    ) -> Self {
        Self {
            crate_name: crate_name.into(),
            status,
            rust_files,
            approximate_rust_loc,
            note: note.into(),
        }
    }

    pub fn allows_scaffold_marker(&self) -> bool {
        self.status == CrateImplementationStatusV1::ScaffoldOnly
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct ScaffoldSurfaceReportV1 {
    pub report_id: ArtifactId,
    pub generated_at: DateTime<Utc>,
    pub crates: Vec<CrateSurfaceStatusV1>,
}

impl ScaffoldSurfaceReportV1 {
    pub fn new(crates: Vec<CrateSurfaceStatusV1>) -> Self {
        Self {
            report_id: display_only_unstable_id("scaffold-surface-report"),
            generated_at: Utc::now(),
            crates,
        }
    }

    pub fn scaffold_only_crates(&self) -> Vec<&str> {
        self.crates
            .iter()
            .filter(|surface| surface.status == CrateImplementationStatusV1::ScaffoldOnly)
            .map(|surface| surface.crate_name.as_str())
            .collect()
    }

    pub fn allows_scaffold_marker_for(&self, crate_name: &str) -> bool {
        self.crates
            .iter()
            .find(|surface| surface.crate_name == crate_name)
            .is_some_and(CrateSurfaceStatusV1::allows_scaffold_marker)
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct FakeReadyFindingV1 {
    pub finding_id: ArtifactId,
    pub surface: String,
    pub pattern: String,
    pub reason: String,
    pub blocked: bool,
    pub found_at: DateTime<Utc>,
}

impl FakeReadyFindingV1 {
    pub fn blocking(
        surface: impl Into<String>,
        pattern: impl Into<String>,
        reason: impl Into<String>,
    ) -> Self {
        Self {
            finding_id: display_only_unstable_id("fake-ready-finding"),
            surface: surface.into(),
            pattern: pattern.into(),
            reason: reason.into(),
            blocked: true,
            found_at: Utc::now(),
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "kebab-case")]
pub enum SuperPassDispositionV1 {
    Pending,
    InProgress,
    Done,
    Blocked,
    Deferred,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct SuperPassStatusV1 {
    pub status_id: ArtifactId,
    pub current_pass: String,
    pub disposition: SuperPassDispositionV1,
    pub source_basis: SourceBasisLockV1,
    pub scaffold_report: ScaffoldSurfaceReportV1,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub fake_ready_findings: Vec<FakeReadyFindingV1>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub blockers: Vec<String>,
    pub updated_at: DateTime<Utc>,
}

impl SuperPassStatusV1 {
    pub fn new(
        current_pass: impl Into<String>,
        disposition: SuperPassDispositionV1,
        source_basis: SourceBasisLockV1,
        scaffold_report: ScaffoldSurfaceReportV1,
        fake_ready_findings: Vec<FakeReadyFindingV1>,
        blockers: Vec<String>,
    ) -> Self {
        Self {
            status_id: display_only_unstable_id("super-pass-status"),
            current_pass: current_pass.into(),
            disposition,
            source_basis,
            scaffold_report,
            fake_ready_findings,
            blockers,
            updated_at: Utc::now(),
        }
    }

    pub fn is_blocked(&self) -> bool {
        self.disposition == SuperPassDispositionV1::Blocked
            || !self.blockers.is_empty()
            || self
                .fake_ready_findings
                .iter()
                .any(|finding| finding.blocked)
    }
}

impl AiDENsAppPlanV1 {
    pub fn validate(&self) -> Result<(), String> {
        if self.app_id.trim().is_empty() {
            return Err("app_id must not be empty".into());
        }
        if self.dangerous_auto_approval {
            return Err("dangerous_auto_approval requires explicit advanced override".into());
        }
        Ok(())
    }

    pub fn human_summary(&self) -> String {
        format!(
            "{} [{}]: provider_required={}, memory_mode={}, receipt_level={}",
            self.app_id,
            self.profile_id,
            self.provider_required,
            self.memory_mode,
            self.receipt_level
        )
    }

    pub fn risk_summary(&self) -> String {
        if self.risk_disclosures.is_empty() {
            return "No risky capabilities are granted by default.".into();
        }
        self.risk_disclosures
            .iter()
            .map(|risk| {
                format!(
                    "{}: granted_by_default={}, permit_required={} ({})",
                    risk.risk_class, risk.granted_by_default, risk.permit_required, risk.reason
                )
            })
            .collect::<Vec<_>>()
            .join("; ")
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct RiskDisclosureV1 {
    pub risk_class: CanonicalToolSideEffectClass,
    pub granted_by_default: bool,
    pub permit_required: bool,
    pub reason: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "kebab-case")]
pub enum MemoryModeV1 {
    Disabled,
    Optional,
    Required,
}

impl fmt::Display for MemoryModeV1 {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(match self {
            Self::Disabled => "disabled",
            Self::Optional => "optional",
            Self::Required => "required",
        })
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "kebab-case")]
pub enum ReportLevelV1 {
    Minimal,
    Standard,
    Full,
}

impl fmt::Display for ReportLevelV1 {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(match self {
            Self::Minimal => "minimal",
            Self::Standard => "standard",
            Self::Full => "full",
        })
    }
}