zynk-schema 0.1.3

Canonical in-memory schema representation for Zynk bindings and generators
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

use serde::{Deserialize, Serialize};
use serde_json::Value;

use crate::TypeRef;

/// Supported endpoint surfaces. These map to Zynk's stable wire routes.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum EndpointKind {
    Rpc,
    Channel,
    Upload,
    Static,
    Ws,
}

/// A callable parameter exposed to generated clients.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Param {
    pub source_name: String,
    pub wire_name: String,
    pub ty: TypeRef,
    pub required: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub default: Option<Value>,
}

impl Param {
    pub fn new(
        source_name: impl Into<String>,
        wire_name: impl Into<String>,
        ty: TypeRef,
        required: bool,
    ) -> Self {
        Self {
            source_name: source_name.into(),
            wire_name: wire_name.into(),
            ty,
            required,
            default: None,
        }
    }
}

/// One server endpoint in the Zynk API graph.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Endpoint {
    pub name: String,
    pub kind: EndpointKind,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub module: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub doc: Option<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub params: Vec<Param>,
    pub returns: TypeRef,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub channel_item: Option<TypeRef>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_param: Option<String>,
    #[serde(default)]
    pub multi_file: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_size: Option<u64>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub allowed_types: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub server_events: Vec<Param>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub client_events: Vec<Param>,
}

impl Endpoint {
    pub fn new(name: impl Into<String>, kind: EndpointKind, returns: TypeRef) -> Self {
        Self {
            name: name.into(),
            kind,
            module: None,
            doc: None,
            params: Vec::new(),
            returns,
            channel_item: None,
            file_param: None,
            multi_file: false,
            max_size: None,
            allowed_types: Vec::new(),
            server_events: Vec::new(),
            client_events: Vec::new(),
        }
    }
}