vize_musea 0.151.0

Musea - Component gallery and documentation for Vize Vue components
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

use serde::{Deserialize, Serialize};
use serde_json::Value;
use vize_carton::{FxHashMap, String};

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DesignToken {
    pub value: Value,
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub token_type: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub attributes: Option<Value>,
    #[serde(rename = "$tier", skip_serializing_if = "Option::is_none")]
    pub tier: Option<String>,
    #[serde(rename = "$reference", skip_serializing_if = "Option::is_none")]
    pub reference: Option<String>,
    #[serde(rename = "$resolvedValue", skip_serializing_if = "Option::is_none")]
    pub resolved_value: Option<Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TokenCategory {
    pub name: String,
    #[serde(default)]
    pub tokens: FxHashMap<String, DesignToken>,
    #[serde(skip_serializing_if = "Vec::is_empty", default)]
    pub subcategories: Vec<TokenCategory>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct FlattenedToken {
    pub name: String,
    pub path: String,
    pub category_path: Vec<String>,
    pub value: Value,
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub token_type: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ResolvedTokens {
    pub categories: Vec<TokenCategory>,
    pub token_map: FxHashMap<String, DesignToken>,
    pub token_count: u32,
    pub primitive_count: u32,
    pub semantic_count: u32,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ValidationResult {
    pub valid: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}

#[derive(Debug, Clone, thiserror::Error)]
pub enum TokenError {
    #[error("Failed to read token path: {message}")]
    Io { message: String },
    #[error("Invalid token JSON: {message}")]
    Json { message: String },
    #[error("Expected token categories JSON array")]
    ExpectedCategories,
}

pub type TokenResult<T> = Result<T, TokenError>;