germanic 0.2.3

Schema-validated binary data for AI agents. JSON to .grm compiler with zero-copy FlatBuffers.
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
//! # Dynamic FlatBuffer Builder
//!
//! Builds FlatBuffer bytes at runtime from a SchemaDefinition + JSON data.
//!
//! ## Architecture
//!
//! ```text
//! ┌─────────────────────────────────────────────────────────────────┐
//! │                  DYNAMIC FLATBUFFER BUILDING                    │
//! ├─────────────────────────────────────────────────────────────────┤
//! │                                                                 │
//! │  SchemaDefinition        JSON data         FlatBufferBuilder    │
//! │  ┌──────────────┐       ┌──────────┐      ┌──────────────┐    │
//! │  │ fields[0..n] │       │ values   │      │              │    │
//! │  │ with types   │ ──┐   │          │ ──┐   │ push_slot()  │    │
//! │  │ and order    │   │   │          │   │   │ per field    │    │
//! │  └──────────────┘   │   └──────────┘   │   └──────────────┘    │
//! │                     │                  │          │             │
//! │                     └──────┬───────────┘          │             │
//! │                            │                      ▼             │
//! │                    ┌───────▼────────┐     ┌──────────────┐     │
//! │                    │  build_table() │     │  .grm bytes  │     │
//! │                    │  (recursive)   │────►│              │     │
//! │                    └────────────────┘     └──────────────┘     │
//! │                                                                 │
//! │  vtable slot = 4 + (2 × field_index)                           │
//! │                                                                 │
//! └─────────────────────────────────────────────────────────────────┘
//! ```

use crate::dynamic::schema_def::{FieldDefinition, FieldType, SchemaDefinition};
use crate::error::GermanicError;
use flatbuffers::FlatBufferBuilder;
use indexmap::IndexMap;

/// Builds FlatBuffer bytes from a schema definition and JSON data.
///
/// Returns the raw FlatBuffer payload (WITHOUT .grm header).
/// The caller wraps it with GrmHeader to produce the final .grm file.
pub fn build_flatbuffer(
    schema: &SchemaDefinition,
    data: &serde_json::Value,
) -> Result<Vec<u8>, GermanicError> {
    let obj = data
        .as_object()
        .ok_or_else(|| GermanicError::General("Root data must be a JSON object".into()))?;

    let mut builder = FlatBufferBuilder::with_capacity(1024);

    let root = build_table(&mut builder, &schema.fields, obj)?;

    builder.finish_minimal(root);
    Ok(builder.finished_data().to_vec())
}

/// A field value prepared for insertion into the FlatBuffer.
///
/// Offset types are stored as raw u32 values to avoid lifetime issues
/// with FlatBufferBuilder's generic WIPOffset types. All WIPOffset<T>
/// variants are simple u32 wrappers, so this is safe.
enum PreparedField {
    /// Field not in data and no default — skip (not in vtable).
    Absent,
    /// String offset (raw u32 from WIPOffset).
    Offset(u32),
    /// Boolean value + default.
    Bool(bool, bool),
    /// 32-bit integer value + default.
    Int(i32, i32),
    /// 32-bit float value + default.
    Float(f32, f32),
}

/// Recursively builds a FlatBuffer table from field definitions and JSON data.
///
/// CRITICAL: Must follow inside-out order:
/// 1. Strings and vectors (offsets to buffer end)
/// 2. Nested tables (which themselves follow the same pattern)
/// 3. Then the current table's vtable slots
fn build_table(
    builder: &mut FlatBufferBuilder<'_>,
    fields: &IndexMap<String, FieldDefinition>,
    data: &serde_json::Map<String, serde_json::Value>,
) -> Result<flatbuffers::WIPOffset<flatbuffers::TableFinishedWIPOffset>, GermanicError> {
    // Phase 1: Pre-create all offset values (strings, vectors, nested tables)
    // We must create these BEFORE starting the table.
    let mut prepared: IndexMap<String, PreparedField> = IndexMap::new();

    for (name, def) in fields {
        let value = data.get(name);
        let prep = prepare_field(builder, def, value)?;
        prepared.insert(name.clone(), prep);
    }

    // Phase 2: Start table and push slots
    let table_start = builder.start_table();

    for (index, (name, _def)) in fields.iter().enumerate() {
        let voffset = 4 + (2 * index) as u16;
        let prep = &prepared[name];

        match prep {
            PreparedField::Absent => {
                // Field not in data and no default — skip (not in vtable)
            }
            PreparedField::Offset(raw) => {
                builder.push_slot_always::<flatbuffers::WIPOffset<&str>>(
                    voffset,
                    flatbuffers::WIPOffset::new(*raw),
                );
            }
            PreparedField::Bool(val, default) => {
                builder.push_slot::<bool>(voffset, *val, *default);
            }
            PreparedField::Int(val, default) => {
                builder.push_slot::<i32>(voffset, *val, *default);
            }
            PreparedField::Float(val, default) => {
                builder.push_slot::<f32>(voffset, *val, *default);
            }
        }
    }

    Ok(builder.end_table(table_start))
}

/// Prepares a single field value for FlatBuffer insertion.
fn prepare_field(
    builder: &mut FlatBufferBuilder<'_>,
    def: &FieldDefinition,
    value: Option<&serde_json::Value>,
) -> Result<PreparedField, GermanicError> {
    let Some(value) = value else {
        // Field not present — check for default
        return Ok(match &def.default {
            Some(d) => match def.field_type {
                FieldType::String => PreparedField::Offset(builder.create_string(d).value()),
                FieldType::Bool => PreparedField::Bool(d.parse().unwrap_or(false), false),
                FieldType::Int => PreparedField::Int(d.parse().unwrap_or(0), 0),
                FieldType::Float => PreparedField::Float(d.parse().unwrap_or(0.0), 0.0),
                _ => PreparedField::Absent,
            },
            None => PreparedField::Absent,
        });
    };

    match def.field_type {
        FieldType::String => {
            let s = value.as_str().unwrap_or("");
            Ok(PreparedField::Offset(builder.create_string(s).value()))
        }

        FieldType::Bool => {
            let v = value.as_bool().unwrap_or(false);
            let default: bool = def
                .default
                .as_ref()
                .and_then(|d| d.parse().ok())
                .unwrap_or(false);
            Ok(PreparedField::Bool(v, default))
        }

        FieldType::Int => {
            let v64 = value.as_i64().unwrap_or(0);
            if v64 > i32::MAX as i64 || v64 < i32::MIN as i64 {
                return Err(GermanicError::General(format!(
                    "Integer overflow: {} exceeds i32 range [{}, {}]",
                    v64,
                    i32::MIN,
                    i32::MAX
                )));
            }
            let v = v64 as i32;
            let default: i32 = def
                .default
                .as_ref()
                .and_then(|d| d.parse().ok())
                .unwrap_or(0);
            Ok(PreparedField::Int(v, default))
        }

        FieldType::Float => {
            let v64 = value.as_f64().unwrap_or(0.0);
            let v = v64 as f32;
            if v.is_infinite() && v64.is_finite() {
                return Err(GermanicError::General(format!(
                    "Float overflow: {} exceeds f32 range",
                    v64
                )));
            }
            let default: f32 = def
                .default
                .as_ref()
                .and_then(|d| d.parse().ok())
                .unwrap_or(0.0);
            Ok(PreparedField::Float(v, default))
        }

        FieldType::StringArray => match value.as_array() {
            Some(arr) if !arr.is_empty() => {
                let offsets: Vec<_> = arr
                    .iter()
                    .map(|v| builder.create_string(v.as_str().unwrap_or("")))
                    .collect();
                let vec_offset = builder.create_vector(&offsets);
                Ok(PreparedField::Offset(vec_offset.value()))
            }
            _ => Ok(PreparedField::Absent),
        },

        FieldType::IntArray => match value.as_array() {
            Some(arr) if !arr.is_empty() => {
                let mut values = Vec::with_capacity(arr.len());
                for v in arr {
                    let v64 = v.as_i64().unwrap_or(0);
                    if v64 > i32::MAX as i64 || v64 < i32::MIN as i64 {
                        return Err(GermanicError::General(format!(
                            "Integer overflow in array element: {} exceeds i32 range [{}, {}]",
                            v64,
                            i32::MIN,
                            i32::MAX
                        )));
                    }
                    values.push(v64 as i32);
                }
                let vec_offset = builder.create_vector(&values);
                Ok(PreparedField::Offset(vec_offset.value()))
            }
            _ => Ok(PreparedField::Absent),
        },

        FieldType::Table => {
            let nested_fields = def.fields.as_ref().ok_or_else(|| {
                GermanicError::General("Table field has no nested field definitions".into())
            })?;

            match value.as_object() {
                Some(obj) => {
                    let table_offset = build_table(builder, nested_fields, obj)?;
                    Ok(PreparedField::Offset(table_offset.value()))
                }
                None => Ok(PreparedField::Absent),
            }
        }
    }
}

// ============================================================================
// TESTS
// ============================================================================

#[cfg(test)]
mod tests {
    use super::*;
    use crate::dynamic::schema_def::*;
    use indexmap::IndexMap;

    fn minimal_schema() -> SchemaDefinition {
        let mut fields = IndexMap::new();
        fields.insert(
            "name".into(),
            FieldDefinition {
                field_type: FieldType::String,
                required: true,
                default: None,
                fields: None,
            },
        );
        SchemaDefinition {
            schema_id: "test.v1".into(),
            version: 1,
            fields,
        }
    }

    #[test]
    fn test_build_minimal() {
        let schema = minimal_schema();
        let data = serde_json::json!({ "name": "Hello" });
        let bytes = build_flatbuffer(&schema, &data).unwrap();
        assert!(!bytes.is_empty());
    }

    #[test]
    fn test_build_with_bool() {
        let mut fields = IndexMap::new();
        fields.insert(
            "name".into(),
            FieldDefinition {
                field_type: FieldType::String,
                required: true,
                default: None,
                fields: None,
            },
        );
        fields.insert(
            "active".into(),
            FieldDefinition {
                field_type: FieldType::Bool,
                required: false,
                default: Some("false".into()),
                fields: None,
            },
        );

        let schema = SchemaDefinition {
            schema_id: "test.v1".into(),
            version: 1,
            fields,
        };

        let data = serde_json::json!({ "name": "Test", "active": true });
        let bytes = build_flatbuffer(&schema, &data).unwrap();
        assert!(!bytes.is_empty());
    }

    #[test]
    fn test_build_with_nested() {
        let mut addr_fields = IndexMap::new();
        addr_fields.insert(
            "street".into(),
            FieldDefinition {
                field_type: FieldType::String,
                required: true,
                default: None,
                fields: None,
            },
        );
        addr_fields.insert(
            "city".into(),
            FieldDefinition {
                field_type: FieldType::String,
                required: true,
                default: None,
                fields: None,
            },
        );

        let mut fields = IndexMap::new();
        fields.insert(
            "name".into(),
            FieldDefinition {
                field_type: FieldType::String,
                required: true,
                default: None,
                fields: None,
            },
        );
        fields.insert(
            "address".into(),
            FieldDefinition {
                field_type: FieldType::Table,
                required: true,
                default: None,
                fields: Some(addr_fields),
            },
        );

        let schema = SchemaDefinition {
            schema_id: "test.v1".into(),
            version: 1,
            fields,
        };

        let data = serde_json::json!({
            "name": "Test",
            "address": {
                "street": "Main St",
                "city": "Berlin"
            }
        });

        let bytes = build_flatbuffer(&schema, &data).unwrap();
        assert!(!bytes.is_empty());
        assert!(bytes.len() > 20);
    }

    #[test]
    fn test_build_int_overflow_rejected() {
        let mut fields = IndexMap::new();
        fields.insert(
            "count".into(),
            FieldDefinition {
                field_type: FieldType::Int,
                required: true,
                default: None,
                fields: None,
            },
        );

        let schema = SchemaDefinition {
            schema_id: "test.v1".into(),
            version: 1,
            fields,
        };

        let data = serde_json::json!({ "count": 3_000_000_000_i64 });
        let result = build_flatbuffer(&schema, &data);
        assert!(result.is_err());
        assert!(
            result.unwrap_err().to_string().contains("Integer overflow"),
            "Must report integer overflow"
        );
    }

    #[test]
    fn test_build_int_negative_overflow_rejected() {
        let mut fields = IndexMap::new();
        fields.insert(
            "count".into(),
            FieldDefinition {
                field_type: FieldType::Int,
                required: true,
                default: None,
                fields: None,
            },
        );

        let schema = SchemaDefinition {
            schema_id: "test.v1".into(),
            version: 1,
            fields,
        };

        let data = serde_json::json!({ "count": -3_000_000_000_i64 });
        let result = build_flatbuffer(&schema, &data);
        assert!(result.is_err());
    }

    #[test]
    fn test_build_with_string_array() {
        let mut fields = IndexMap::new();
        fields.insert(
            "name".into(),
            FieldDefinition {
                field_type: FieldType::String,
                required: true,
                default: None,
                fields: None,
            },
        );
        fields.insert(
            "tags".into(),
            FieldDefinition {
                field_type: FieldType::StringArray,
                required: false,
                default: None,
                fields: None,
            },
        );

        let schema = SchemaDefinition {
            schema_id: "test.v1".into(),
            version: 1,
            fields,
        };

        let data = serde_json::json!({ "name": "Test", "tags": ["a", "b", "c"] });
        let bytes = build_flatbuffer(&schema, &data).unwrap();
        assert!(!bytes.is_empty());
    }
}