memstead-schema 0.8.0

Schema types for Memstead — entity definitions, vocabulary, and validation rules. Internal library surface consumed by the memstead binaries — pre-1.0, experimental, no API stability promise.
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

//! Metadata fields every entity carries regardless of type.
//!
//! The loader prepends `type`, `created_date`, `last_modified` and appends
//! `tags` to each type's declared `metadata_fields`. Authors never write
//! these in YAML — redeclaring a base key is a load-time error.
//!
//! Canonical frontmatter order on write:
//! `type, created_date, last_modified, <type-specific>, tags`.

use crate::types::{FieldType, Filterable, MetadataFieldDef, Serialization};

/// Fields that appear before any type-specific metadata on disk.
pub fn prefix_fields() -> Vec<MetadataFieldDef> {
    vec![
        MetadataFieldDef {
            key: "type".to_string(),
            description: "Entity type discriminator — matches the schema type name.".to_string(),
            field_type: FieldType::String,
            default_value: None,
            enum_values: None,
            required: Some(true),
            legacy_optional: None,
            required_resolved: true,
            init_timestamp: false,
            auto_timestamp: false,
            serialization: Serialization::Default,
            filterable: Filterable::None,
        },
        MetadataFieldDef {
            key: "created_date".to_string(),
            description: "Date the entity was created — filled by the engine on create."
                .to_string(),
            field_type: FieldType::Date,
            default_value: None,
            enum_values: None,
            required: Some(true),
            legacy_optional: None,
            required_resolved: true,
            init_timestamp: true,
            auto_timestamp: false,
            serialization: Serialization::Default,
            // Engine-stamped, always a valid ISO date — the canonical
            // "entities created since X" axis. Range-filterable to match
            // `last_modified` and the `memstead_search` range_filters example.
            filterable: Filterable::Range,
        },
        MetadataFieldDef {
            key: "last_modified".to_string(),
            description: "Date of the most recent edit — filled by the engine on write."
                .to_string(),
            field_type: FieldType::Date,
            default_value: None,
            enum_values: None,
            required: Some(true),
            legacy_optional: None,
            required_resolved: true,
            init_timestamp: false,
            auto_timestamp: true,
            serialization: Serialization::Default,
            filterable: Filterable::Range,
        },
    ]
}

/// Fields that appear after type-specific metadata on disk.
pub fn suffix_fields() -> Vec<MetadataFieldDef> {
    vec![MetadataFieldDef {
        key: "tags".to_string(),
        description: "Free-form categorization tags — comma-separated on disk.".to_string(),
        field_type: FieldType::String,
        default_value: None,
        enum_values: None,
        required: None,
        legacy_optional: None,
        required_resolved: false,
        init_timestamp: false,
        auto_timestamp: false,
        serialization: Serialization::CsvArray,
        filterable: Filterable::Equality,
    }]
}

/// Every base metadata key. Used by the loader to reject YAML redeclarations
/// and by JSON-Schema generation to surface the implicit fields.
pub const BASE_KEYS: &[&str] = &["type", "created_date", "last_modified", "tags"];

pub fn is_base_key(key: &str) -> bool {
    BASE_KEYS.contains(&key)
}