shrike 0.1.0

AT Protocol library for Rust
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

use std::collections::HashMap;

use serde::Deserialize;

/// A parsed Lexicon schema document.
#[derive(Debug, Deserialize)]
pub struct Schema {
    pub lexicon: u32,
    pub id: String,
    #[serde(default)]
    pub revision: Option<u32>,
    #[serde(default)]
    pub description: Option<String>,
    pub defs: HashMap<String, Def>,
}

/// A single named definition within a schema.
#[derive(Debug, Deserialize)]
#[serde(tag = "type")]
#[allow(clippy::enum_variant_names)]
pub enum Def {
    #[serde(rename = "record")]
    Record(RecordDef),
    #[serde(rename = "query")]
    Query(QueryDef),
    #[serde(rename = "procedure")]
    Procedure(ProcedureDef),
    #[serde(rename = "subscription")]
    Subscription(SubscriptionDef),
    #[serde(rename = "object")]
    Object(ObjectDef),
    #[serde(rename = "token")]
    Token(TokenDef),
    #[serde(rename = "string")]
    StringDef(StringTypeDef),
    #[serde(rename = "boolean")]
    BooleanDef(BooleanTypeDef),
    #[serde(rename = "integer")]
    IntegerDef(IntegerTypeDef),
    #[serde(rename = "bytes")]
    BytesDef(BytesTypeDef),
    #[serde(rename = "array")]
    ArrayDef(ArrayTypeDef),
    /// A definition type not yet modelled (e.g. future lexicon extensions).
    #[serde(other)]
    Unknown,
}

/// A record definition — the main type for AT Protocol records.
#[derive(Debug, Deserialize)]
pub struct RecordDef {
    #[serde(default)]
    pub key: Option<String>,
    pub record: ObjectDef,
    #[serde(default)]
    pub description: Option<String>,
}

/// An object definition with named properties.
#[derive(Debug, Deserialize)]
pub struct ObjectDef {
    #[serde(default)]
    pub required: Vec<String>,
    #[serde(default)]
    pub nullable: Vec<String>,
    #[serde(default)]
    pub properties: HashMap<String, FieldSchema>,
    #[serde(default)]
    pub description: Option<String>,
}

/// The schema for a single field within an object or array.
#[derive(Debug, Deserialize)]
#[serde(tag = "type")]
pub enum FieldSchema {
    #[serde(rename = "string")]
    String {
        #[serde(default, rename = "minLength")]
        min_length: Option<u64>,
        #[serde(default, rename = "maxLength")]
        max_length: Option<u64>,
        #[serde(default, rename = "maxGraphemes")]
        max_graphemes: Option<u64>,
        #[serde(default, rename = "knownValues")]
        known_values: Vec<String>,
        #[serde(default)]
        r#enum: Option<Vec<String>>,
        #[serde(default)]
        format: Option<String>,
        #[serde(default)]
        description: Option<String>,
        #[serde(default)]
        default: Option<String>,
        #[serde(default, rename = "const")]
        const_val: Option<String>,
    },
    #[serde(rename = "integer")]
    Integer {
        #[serde(default)]
        minimum: Option<i64>,
        #[serde(default)]
        maximum: Option<i64>,
        #[serde(default)]
        r#enum: Option<Vec<i64>>,
        #[serde(default)]
        default: Option<i64>,
        #[serde(default)]
        description: Option<String>,
    },
    #[serde(rename = "boolean")]
    Boolean {
        #[serde(default)]
        default: Option<bool>,
        #[serde(default)]
        description: Option<String>,
    },
    #[serde(rename = "bytes")]
    Bytes {
        #[serde(default, rename = "minLength")]
        min_length: Option<u64>,
        #[serde(default, rename = "maxLength")]
        max_length: Option<u64>,
        #[serde(default)]
        description: Option<String>,
    },
    #[serde(rename = "cid-link")]
    CidLink {
        #[serde(default)]
        description: Option<String>,
    },
    #[serde(rename = "blob")]
    Blob {
        #[serde(default)]
        accept: Option<Vec<String>>,
        #[serde(default, rename = "maxSize")]
        max_size: Option<u64>,
        #[serde(default)]
        description: Option<String>,
    },
    #[serde(rename = "array")]
    Array {
        items: Box<FieldSchema>,
        #[serde(default, rename = "minLength")]
        min_length: Option<u64>,
        #[serde(default, rename = "maxLength")]
        max_length: Option<u64>,
        #[serde(default)]
        description: Option<String>,
    },
    #[serde(rename = "object")]
    Object(ObjectDef),
    #[serde(rename = "ref")]
    Ref {
        #[serde(rename = "ref")]
        reference: String,
        #[serde(default)]
        description: Option<String>,
    },
    #[serde(rename = "union")]
    Union {
        refs: Vec<String>,
        #[serde(default)]
        closed: Option<bool>,
        #[serde(default)]
        description: Option<String>,
    },
    #[serde(rename = "unknown")]
    Unknown {
        #[serde(default)]
        description: Option<String>,
    },
}

/// A query (XRPC GET) definition.
#[derive(Debug, Deserialize)]
pub struct QueryDef {
    #[serde(default)]
    pub parameters: Option<ParamsDef>,
    #[serde(default)]
    pub output: Option<BodyDef>,
    #[serde(default)]
    pub description: Option<String>,
    #[serde(default)]
    pub errors: Vec<ErrorDef>,
}

/// A procedure (XRPC POST) definition.
#[derive(Debug, Deserialize)]
pub struct ProcedureDef {
    #[serde(default)]
    pub input: Option<BodyDef>,
    #[serde(default)]
    pub output: Option<BodyDef>,
    #[serde(default)]
    pub description: Option<String>,
    #[serde(default)]
    pub errors: Vec<ErrorDef>,
}

/// A subscription definition.
#[derive(Debug, Deserialize)]
pub struct SubscriptionDef {
    #[serde(default)]
    pub parameters: Option<ParamsDef>,
    #[serde(default)]
    pub message: Option<MessageDef>,
    #[serde(default)]
    pub description: Option<String>,
    #[serde(default)]
    pub errors: Vec<ErrorDef>,
}

/// A request or response body.
#[derive(Debug, Deserialize)]
pub struct BodyDef {
    pub encoding: String,
    #[serde(default)]
    pub schema: Option<FieldSchema>,
    #[serde(default)]
    pub description: Option<String>,
}

/// Query/subscription parameter definitions.
///
/// These have `"type": "params"` in the JSON but are structurally similar to
/// objects with `properties` and `required`.
#[derive(Debug, Deserialize)]
pub struct ParamsDef {
    #[serde(default)]
    pub required: Vec<String>,
    #[serde(default)]
    pub properties: HashMap<String, FieldSchema>,
    #[serde(default)]
    pub description: Option<String>,
}

/// A subscription message definition.
#[derive(Debug, Deserialize)]
pub struct MessageDef {
    #[serde(default)]
    pub schema: Option<FieldSchema>,
    #[serde(default)]
    pub description: Option<String>,
}

/// An error that an endpoint can return.
#[derive(Debug, Deserialize)]
pub struct ErrorDef {
    pub name: String,
    #[serde(default)]
    pub description: Option<String>,
}

/// A token definition (an opaque string constant).
#[derive(Debug, Deserialize)]
pub struct TokenDef {
    #[serde(default)]
    pub description: Option<String>,
}

/// A top-level string type definition.
#[derive(Debug, Deserialize)]
pub struct StringTypeDef {
    #[serde(default)]
    pub description: Option<String>,
    #[serde(default, rename = "knownValues")]
    pub known_values: Vec<String>,
}

/// A top-level boolean type definition.
#[derive(Debug, Deserialize)]
pub struct BooleanTypeDef {
    #[serde(default)]
    pub description: Option<String>,
}

/// A top-level integer type definition.
#[derive(Debug, Deserialize)]
pub struct IntegerTypeDef {
    #[serde(default)]
    pub description: Option<String>,
}

/// A top-level bytes type definition.
#[derive(Debug, Deserialize)]
pub struct BytesTypeDef {
    #[serde(default)]
    pub description: Option<String>,
}

/// A top-level array type definition.
#[derive(Debug, Deserialize)]
pub struct ArrayTypeDef {
    pub items: FieldSchema,
    #[serde(default)]
    pub description: Option<String>,
}

/// Split a ref string into (target_nsid, def_name), resolving relative refs against
/// the given context NSID.
///
/// Examples:
/// - `"#replyRef"` with context `"app.bsky.feed.post"` → `("app.bsky.feed.post", "replyRef")`
/// - `"com.atproto.repo.defs#commitMeta"` → `("com.atproto.repo.defs", "commitMeta")`
/// - `"com.atproto.repo.strongRef"` → `("com.atproto.repo.strongRef", "main")`
pub fn split_ref<'a>(context_nsid: &str, reference: &'a str) -> (String, &'a str) {
    if let Some(def_name) = reference.strip_prefix('#') {
        (context_nsid.to_owned(), def_name)
    } else if let Some(hash_pos) = reference.rfind('#') {
        (reference[..hash_pos].to_owned(), &reference[hash_pos + 1..])
    } else {
        (reference.to_owned(), "main")
    }
}