axiomsync 1.0.0

Core data-processing engine for AxiomSync local retrieval runtime.
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

use serde::{Deserialize, Serialize};

use crate::uri::Scope;

pub const ONTOLOGY_SCHEMA_URI_V1: &str = "axiom://agent/ontology/schema.v1.json";
pub const DEFAULT_ONTOLOGY_SCHEMA_V1_JSON: &str = r#"{
  "version": 1,
  "object_types": [],
  "link_types": [],
  "action_types": [],
  "invariants": []
}"#;

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
#[serde(deny_unknown_fields)]
pub struct OntologySchemaV1 {
    pub version: u32,
    #[serde(default)]
    pub object_types: Vec<ObjectTypeDef>,
    #[serde(default)]
    pub link_types: Vec<LinkTypeDef>,
    #[serde(default)]
    pub action_types: Vec<ActionTypeDef>,
    #[serde(default)]
    pub invariants: Vec<InvariantDef>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
#[serde(deny_unknown_fields)]
pub struct ObjectTypeDef {
    pub id: String,
    #[serde(default)]
    pub uri_prefixes: Vec<String>,
    #[serde(default)]
    pub required_tags: Vec<String>,
    #[serde(default)]
    pub allowed_scopes: Vec<Scope>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct LinkTypeDef {
    pub id: String,
    #[serde(default)]
    pub from_types: Vec<String>,
    #[serde(default)]
    pub to_types: Vec<String>,
    #[serde(default = "default_link_min_arity")]
    pub min_arity: usize,
    #[serde(default = "default_link_max_arity")]
    pub max_arity: usize,
    #[serde(default)]
    pub symmetric: bool,
}

impl Default for LinkTypeDef {
    fn default() -> Self {
        Self {
            id: String::new(),
            from_types: Vec::new(),
            to_types: Vec::new(),
            min_arity: default_link_min_arity(),
            max_arity: default_link_max_arity(),
            symmetric: false,
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
#[serde(deny_unknown_fields)]
pub struct ActionTypeDef {
    pub id: String,
    pub input_contract: String,
    #[serde(default)]
    pub effects: Vec<String>,
    pub queue_event_type: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
#[serde(deny_unknown_fields)]
pub struct InvariantDef {
    pub id: String,
    pub rule: String,
    pub severity: String,
    pub message: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(deny_unknown_fields)]
pub struct OntologyActionRequestV1 {
    pub action_id: String,
    pub queue_event_type: String,
    #[serde(default)]
    pub input: serde_json::Value,
}

#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum OntologyJsonValueKind {
    Null,
    Boolean,
    Number,
    String,
    Array,
    Object,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct OntologyActionValidationReport {
    pub action_id: String,
    pub queue_event_type: String,
    pub input_contract: String,
    pub input_kind: OntologyJsonValueKind,
}

#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum OntologyInvariantCheckStatus {
    Pass,
    Fail,
}

#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum OntologyInvariantFailureKind {
    InvalidSeverity,
    UnsupportedRule,
    MissingTarget,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct OntologyInvariantCheckItem {
    pub id: String,
    pub severity: String,
    pub rule: String,
    pub message: String,
    pub status: OntologyInvariantCheckStatus,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub failure_kind: Option<OntologyInvariantFailureKind>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub failure_detail: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct OntologyInvariantCheckReport {
    pub total: usize,
    pub passed: usize,
    pub failed: usize,
    pub items: Vec<OntologyInvariantCheckItem>,
}

const fn default_link_min_arity() -> usize {
    2
}

const fn default_link_max_arity() -> usize {
    64
}