libfj 0.10.0

An unofficial collection of APIs used in FreeJam games and mods
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
315
316
317
318
319
320
321

use serde::{Deserialize, Serialize};

pub mod order {
    pub const ASCENDING: &str = "ascending";
    pub const DESCENDING: &str = "descending";
    pub(super) fn default() -> &'static str {
        ASCENDING
    }
}

pub mod sort {
    pub const CPU_POWER: &str = "cpuPower";
    pub const FIRE_POWER: &str = "firePower";
    pub const ENGINE_POWER: &str = "enginePower";
    pub const PRICE: &str = "price";
    pub const DATE: &str = "date";
    pub const CLUSTER_COUNT: &str = "clusterCount";
    pub const VIEWS: &str = "views";
    pub const MOST_PURCHASED: &str = "mostPurchased";
    pub const DEFAULT: &str = "default";
    pub(super) fn default() -> &'static str {
        DEFAULT
    }
}

pub mod moderation {
    pub const NO_FILTER: &str = "none";
    pub const NEEDS_MODERATION: &str = "needsModeration";
    pub const MODERATED: &str = "moderatedOnly";
    pub(super) fn default() -> &'static str {
        NO_FILTER
    }
}

#[derive(Deserialize, Serialize, Debug, Clone)]
pub struct ErrorPayload {
    #[serde(rename = "error")]
    pub error: isize,
    #[serde(rename = "errorMessage")]
    pub error_message: String,
}

// search endpoint

#[derive(Deserialize, Serialize, Clone)]
pub struct SearchPayload {
    #[serde(rename = "text")]
    pub text: Option<String>,
    #[serde(rename = "baseCpuMinimum")]
    pub base_minimum_cpu: Option<isize>,
    #[serde(rename = "baseCpuMaximum")]
    pub base_maximum_cpu: Option<isize>,
    #[serde(rename = "weaponCpuMinimum")]
    pub weapon_minimum_cpu: Option<isize>,
    #[serde(rename = "weaponCpuMaximum")]
    pub weapon_maximum_cpu: Option<isize>,
    #[serde(rename = "cosmeticCpuMinimum")]
    pub cosmetic_minimum_cpu: Option<isize>,
    #[serde(rename = "cosmeticCpuMaximum")]
    pub cosmetic_maximum_cpu: Option<isize>,
    #[serde(rename = "clusterMinimum")]
    pub cluster_minimum: Option<isize>,
    #[serde(rename = "clusterMaximum")]
    pub cluster_maximum: Option<isize>,
    #[serde(rename = "dateMinimum")]
    pub date_minimum: Option<String>,
    #[serde(rename = "dateMaximum")]
    pub date_maximum: Option<String>,
    #[serde(rename = "purchasedOnly")]
    pub purchased_only: Option<bool>,
    #[serde(rename = "creatorId")]
    pub creator_id: Option<String>, // GUID
    #[serde(rename = "page")]
    pub page: Option<isize>,
    #[serde(rename = "count")]
    pub count: Option<isize>,
    #[serde(rename = "sortBy", default="sort::default")]
    pub sort_by: &'static str,
    #[serde(rename = "orderBy", default="order::default")]
    pub order_by: &'static str,
    #[serde(rename = "modFilter", default="moderation::default")]
    pub moderation_filter: &'static str,
}

impl Default for SearchPayload {
    fn default() -> Self {
        Self {
            text: None,
            base_minimum_cpu: None,
            base_maximum_cpu: None,
            weapon_minimum_cpu: None,
            weapon_maximum_cpu: None,
            cosmetic_minimum_cpu: None,
            cosmetic_maximum_cpu: None,
            cluster_minimum: None,
            cluster_maximum: None,
            date_minimum: None,
            date_maximum: None,
            purchased_only: None,
            creator_id: None,
            page: None,
            count: None,
            sort_by: sort::DEFAULT,
            order_by: order::ASCENDING,
            moderation_filter: moderation::NO_FILTER,
        }
    }
}

#[derive(Deserialize, Serialize, Clone, Debug)]
pub struct SearchResponse {
    #[serde(rename = "results")]
    pub results: Vec<SearchResponseItem>,
}

#[derive(Deserialize, Serialize, Clone, Debug)]
pub struct SearchResponseItem {
    #[serde(rename = "robot")]
    pub robot: RobotInfo,
    #[serde(rename = "prices")]
    pub prices: Vec<RobotPrice>,
    #[serde(rename = "purchased")]
    pub purchased: bool,
    #[serde(rename = "downloaded")]
    pub downloaded: bool,
}

#[derive(Deserialize, Serialize, Clone, Debug)]
pub struct RobotInfo {
    #[serde(rename = "id")]
    pub id: String, // GUID
    #[serde(rename = "name")]
    pub name: String,
    #[serde(rename = "parentId")]
    pub parent_id: Option<String>, // GUID?
    #[serde(rename = "creatorId")]
    pub creator_id: String, // GUID
    #[serde(rename = "creatorName")]
    pub creator_name: String,
    #[serde(rename = "created")]
    pub created: String, // date
    #[serde(rename = "image")]
    pub image: Option<String>, // url
    #[serde(rename = "baseCpu")]
    pub base_cpu: isize,
    #[serde(rename = "weaponCpu")]
    pub weapon_cpu: isize,
    #[serde(rename = "cosmeticCpu")]
    pub cosmetic_cpu: isize,
    #[serde(rename = "clusterCount")]
    pub cluster_count: isize,
    #[serde(rename = "blockCounts")]
    pub block_counts: std::collections::HashMap<usize, usize>,
    #[serde(rename = "materialsUsed")]
    pub materials_used: std::collections::HashSet<isize>,
    #[serde(rename = "minimumOffsetX")]
    pub minimum_offset_x: f64,
    #[serde(rename = "minimumOffsetY")]
    pub minimum_offset_y: f64,
    #[serde(rename = "minimumOffsetZ")]
    pub minimum_offset_z: f64,
    #[serde(rename = "maximumOffsetX")]
    pub maximum_offset_x: f64,
    #[serde(rename = "maximumOffsetY")]
    pub maximum_offset_y: f64,
    #[serde(rename = "maximumOffsetZ")]
    pub maximum_offset_z: f64,
    // TODO additional fields
    // these seem to always be null so it is not worth deserializing them
    // and adding some placeholder type might cause them to break in the future
    // #[serde(rename = "colourPallet")]
    // #[serde(rename = "materialPalette")]
    // #[serde(rename = "materialPalette")]
    // #[serde(rename = "cosmeticBlockVariantPalette")]
    #[serde(rename = "version")]
    pub version: usize,
}

impl std::string::ToString for RobotInfo {
    fn to_string(&self) -> String {
        format!("{} ({}) by {} ({})", &self.name, &self.id, &self.creator_name, &self.creator_id)
    }
}

#[derive(Deserialize, Serialize, Clone, Debug)]
pub struct RobotPrice {
    #[serde(rename = "currency")]
    pub currency: isize,
    #[serde(rename = "amount")]
    pub amount: isize,
}

// create robot endpoint

#[derive(Deserialize, Serialize, Clone, Debug)]
pub struct CreateRobotPayload {
    #[serde(rename = "name")]
    pub name: String,
    #[serde(rename = "data")]
    pub data: String, // base64
    #[serde(rename = "image")]
    pub image: String, // base64??
    #[serde(rename = "baseCpu")]
    pub base_cpu: isize,
    #[serde(rename = "weaponCpu")]
    pub weapon_cpu: isize,
    #[serde(rename = "cosmeticCpu")]
    pub cosmetic_cpu: isize,
    #[serde(rename = "clusterCount")]
    pub cluster_count: isize,
    #[serde(rename = "blockCounts")]
    pub block_counts: std::collections::HashMap<usize, usize>,
    #[serde(rename = "materialsUsed")]
    pub materials_used: std::collections::HashSet<isize>,
    #[serde(rename = "minimumOffsetX")]
    pub minimum_offset_x: f64,
    #[serde(rename = "minimumOffsetY")]
    pub minimum_offset_y: f64,
    #[serde(rename = "minimumOffsetZ")]
    pub minimum_offset_z: f64,
    #[serde(rename = "maximumOffsetX")]
    pub maximum_offset_x: f64,
    #[serde(rename = "maximumOffsetY")]
    pub maximum_offset_y: f64,
    #[serde(rename = "maximumOffsetZ")]
    pub maximum_offset_z: f64,
}

#[derive(Deserialize, Serialize, Clone, Debug)]
pub struct CreateRobotResponse {
    #[serde(rename = "header")]
    pub header: RobotInfo,
}

// factory info endpoint

// (no payload -- this is a GET request)

#[derive(Deserialize, Serialize, Clone, Debug)]
pub struct FactoryInfoResponse {
    #[serde(rename = "robotCount")]
    pub robot_count: isize,
    #[serde(rename = "robotLimit")]
    pub robot_limit: isize,
    #[serde(rename = "publishedRobotCount")]
    pub published_robot_count: isize,
    #[serde(rename = "publishedRobotLimit")]
    pub published_robot_limit: isize,
}

// publish robot endpoint

#[derive(Deserialize, Serialize, Clone, Debug)]
pub struct PublishRobotPayload {
    #[serde(rename = "name")]
    pub name: String,
    #[serde(rename = "description")]
    pub description: String,
    #[serde(rename = "techPoints")]
    pub techpoints: isize,
    #[serde(rename = "bloxCoin")]
    pub bloxcoin: isize,
}

#[derive(Deserialize, Serialize, Clone, Debug)]
pub struct PublishRobotResponse {
    #[serde(rename = "header")]
    pub header: RobotInfo,
    #[serde(rename = "data")]
    pub data: String, // base64
}

// get my robots endpoint

// (no payload -- this is a GET request)

#[derive(Deserialize, Serialize, Clone, Debug)]
pub struct MyRobotsResponse {
    #[serde(rename = "vehicles")]
    pub vehicles: Vec<RobotInfo>,
}

// get robot endpoint

// (no payload -- this is a GET request)

#[derive(Deserialize, Serialize, Clone, Debug)]
pub struct GetRobotResponse {
    #[serde(rename = "header")]
    pub header: RobotInfo,
    #[serde(rename = "data")]
    pub data: String, // base64
    #[serde(rename = "description")]
    pub description: String,
    #[serde(rename = "created")]
    pub created: String, // date
    #[serde(rename = "moderated")]
    pub moderated: bool,
}

// moderate robot endpoint

#[derive(Deserialize, Serialize, Clone, Debug)]
pub struct ModerateRobotPayload {
    #[serde(rename = "approve")]
    pub approve: bool,
    #[serde(rename = "reason")]
    pub reason: String,
}

// (no response)

// report robot endpoint

#[derive(Deserialize, Serialize, Clone, Debug)]
pub struct ReportRobotPayload {
    #[serde(rename = "reason")]
    pub reason: String,
}

// (no response)