faf-rust-sdk 2.0.0

Rust SDK for FAF (Foundational AI-context Format) - IANA-registered application/vnd.faf+yaml
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

//! Type definitions for FAF format

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Complete FAF file structure
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FafData {
    pub faf_version: String,
    pub project: Project,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub ai_score: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub ai_confidence: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub ai_tldr: Option<HashMap<String, String>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub instant_context: Option<InstantContext>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub context_quality: Option<ContextQuality>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub stack: Option<Stack>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub human_context: Option<HumanContext>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub preferences: Option<Preferences>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub state: Option<State>,

    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<String>,
}

/// Project metadata
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Project {
    pub name: String,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub goal: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub main_language: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub approach: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub license: Option<String>,
}

/// Instant context for AI
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct InstantContext {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub what_building: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub tech_stack: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub deployment: Option<String>,

    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub key_files: Vec<String>,

    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub commands: HashMap<String, String>,
}

/// Technical stack
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Stack {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub frontend: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub backend: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub database: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub infrastructure: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub build_tool: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub testing: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub cicd: Option<String>,
}

/// Context quality metrics
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ContextQuality {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub slots_filled: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub confidence: Option<String>,

    #[serde(default)]
    pub handoff_ready: bool,

    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub missing_context: Vec<String>,
}

/// Human context - the 6 W's
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HumanContext {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub who: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub what: Option<String>,

    #[serde(rename = "why", skip_serializing_if = "Option::is_none")]
    pub why_field: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub how: Option<String>,

    #[serde(rename = "where", skip_serializing_if = "Option::is_none")]
    pub where_field: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub when: Option<String>,
}

/// Development preferences
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Preferences {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quality_bar: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub testing: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub documentation: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub code_style: Option<String>,
}

/// Project state
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct State {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub phase: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub focus: Option<String>,

    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub milestones: Vec<String>,
}