axgf-rs 0.1.0

Reference implementation of the Axiom Genealogy Format (AXGF) 1.0 — a stateless JSON-boundary library for creating, validating, importing, exporting, and converting genealogy bundles (GEDCOM 5.5.1 supported).
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

// SPDX-License-Identifier: Apache-2.0
//! Typed representation of the AXGF [`Person`] entity, mirroring
//! `#/$defs/person` in the schema and SPEC §4.1.

use serde::{Deserialize, Serialize};

use super::common::{AiHypothesis, AxgfDate, AxgfName, BaseEntity, DocumentLink, Extra};

/// A person's gender declaration.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Gender {
    /// One of `M`, `F`, `NB`, `U` (unknown).
    pub value: String,
    /// Optional explanatory note.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub note: Option<String>,
    /// Forward-compatible extras.
    #[serde(flatten)]
    pub extra: Extra,
}

/// Identity block (name, alternate names, gender, is-living flag, visibility).
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Identity {
    /// Primary display name.
    pub name: AxgfName,
    /// Alternate names (birth name, aliases, transliterations, …).
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub names: Vec<AxgfName>,
    /// Gender information.
    pub gender: Gender,
    /// Whether the person is currently living (drives privacy handling).
    pub is_living: bool,
    /// Visibility level: `public | members | contributors | private`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub visibility: Option<String>,
    /// Forward-compatible extras.
    #[serde(flatten)]
    pub extra: Extra,
}

/// Vital event block (birth or death), attached directly to a Person.
/// A first-class [`crate::model::event::Event`] MAY additionally exist and
/// be linked via `event_id`.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Vital {
    /// Date of the event.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub date: Option<AxgfDate>,
    /// Referenced [`crate::model::place::Place`] UUID.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub place_id: Option<String>,
    /// Death-specific: cause of death (unused for birth).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub cause: Option<String>,
    /// Overall confidence in \[0.0, 1.0\].
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub confidence: Option<f64>,
    /// Referenced [`crate::model::source::Source`] UUID.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source_id: Option<String>,
    /// Referenced first-class [`crate::model::event::Event`] UUID.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub event_id: Option<String>,
    /// Forward-compatible extras.
    #[serde(flatten)]
    pub extra: Extra,
}

/// AI metadata attached to a Person. Mirrors `person.ai`.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct PersonAi {
    /// Relative path to the Markdown vault page for this person.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub vault_page: Option<String>,
    /// Embedding model identifier.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub embedding_model: Option<String>,
    /// Last time the embedding was recomputed.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub embedding_updated_at: Option<String>,
    /// Machine-generated hypotheses about this person.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub hypotheses: Vec<AiHypothesis>,
    /// Forward-compatible extras.
    #[serde(flatten)]
    pub extra: Extra,
}

/// A Person entity. See SPEC §4.1 for the full field-by-field contract.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Person {
    /// Base entity fields (`id`, `type`, `axgf_version`, timestamps, …).
    #[serde(flatten)]
    pub base: BaseEntity,
    /// Identity block (name, gender, visibility).
    pub identity: Identity,
    /// Birth vitals.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub birth: Option<Vital>,
    /// Death vitals.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub death: Option<Vital>,
    /// Free-form biography.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub bio: Option<String>,
    /// Free-form notes.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub notes: Option<String>,
    /// Documents attached to this person.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub documents: Vec<DocumentLink>,
    /// AI metadata.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ai: Option<PersonAi>,
    /// Forward-compatible extras — anything else the spec adds later.
    #[serde(flatten)]
    pub extra: Extra,
}