theway-contract 0.1.7

theway shared leaf contract — raw session persistence interfaces, persisted DAG snapshots, sidecar models, and path layout; no engine, protocol, or runtime dependencies.
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

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

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

use super::{ExtensionLifecycleEvent, ExtensionPermission, ExtensionScope, ExtensionSourceLayer};

#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, schemars::JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExtensionCatalogStatus {
    Effective,
    Shadowed,
    Rejected,
    Blocked,
    Disabled,
    Faulted,
}

/// Client-neutral catalog record. It intentionally omits executable engine
/// values and secret-bearing provider configuration.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, schemars::JsonSchema)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct ExtensionCatalogEntry {
    pub extension_id: String,
    pub version: String,
    pub source: ExtensionSourceLayer,
    pub scope: ExtensionScope,
    pub priority: i32,
    pub status: ExtensionCatalogStatus,
    #[serde(default)]
    pub permissions: Vec<ExtensionPermission>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reason_code: Option<ExtensionDiagnosticCode>,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, schemars::JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExtensionDiagnosticSeverity {
    Info,
    Warning,
    Error,
}

#[derive(
    Clone,
    Copy,
    Debug,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    Hash,
    Serialize,
    Deserialize,
    schemars::JsonSchema,
)]
#[serde(rename_all = "snake_case")]
pub enum ExtensionDiagnosticCode {
    ManifestInvalid,
    Shadowed,
    TrustRequired,
    PermissionDenied,
    LoadFailed,
    HookFailed,
    HookTimedOut,
    Cancelled,
    ResourceLimit,
    CircuitOpened,
    Unloaded,
    ReloadPending,
    StateMigrationFailed,
    PersistenceFailed,
    QueueOverflow,
    LifecycleStatus,
    ContractViolation,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ExtensionDiagnosticSensitivity {
    Public,
    Sensitive,
}

/// Structured diagnostic. Sensitive detail values are discarded when added;
/// serialization exposes only their field names in `redactedFields`.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, schemars::JsonSchema)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct ExtensionDiagnostic {
    pub extension_id: String,
    pub code: ExtensionDiagnosticCode,
    pub severity: ExtensionDiagnosticSeverity,
    pub message: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub session_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub event: Option<ExtensionLifecycleEvent>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub sequence: Option<u64>,
    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
    pub details: BTreeMap<String, Value>,
    #[serde(default, skip_serializing_if = "BTreeSet::is_empty")]
    pub redacted_fields: BTreeSet<String>,
}

impl ExtensionDiagnostic {
    pub fn new(
        extension_id: impl Into<String>,
        code: ExtensionDiagnosticCode,
        severity: ExtensionDiagnosticSeverity,
        message: impl Into<String>,
    ) -> Self {
        Self {
            extension_id: extension_id.into(),
            code,
            severity,
            message: message.into(),
            session_id: None,
            event: None,
            sequence: None,
            details: BTreeMap::new(),
            redacted_fields: BTreeSet::new(),
        }
    }

    pub fn add_detail(
        &mut self,
        key: impl Into<String>,
        value: Value,
        sensitivity: ExtensionDiagnosticSensitivity,
    ) {
        let key = key.into();
        match sensitivity {
            ExtensionDiagnosticSensitivity::Public => {
                self.redacted_fields.remove(&key);
                self.details.insert(key, value);
            }
            ExtensionDiagnosticSensitivity::Sensitive => {
                self.details.remove(&key);
                self.redacted_fields.insert(key);
            }
        }
    }
}