wikijs 0.2.1

API bindings, CLI client and FUSE filesystem for Wiki.js written in 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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
use graphql_client::reqwest::post_graphql_blocking as post_graphql;
use reqwest::blocking::Client;
use serde::{Deserialize, Serialize};
use thiserror::Error;

use crate::common::{
    classify_response_error, classify_response_status_error, Date, Int,
    KnownErrorCodes, ResponseStatus, UnknownError,
};

#[derive(Clone, Error, Debug, PartialEq)]
pub enum AssetError {
    #[error("An unexpected error occurred during asset operation.")]
    AssetGenericError,
    #[error("An asset folder with the same name already exists.")]
    AssetFolderExists,
    #[error("You are not authorized to delete this asset.")]
    AssetDeleteForbidden,
    #[error("This asset does not exist or is invalid.")]
    AssetInvalid,
    #[error(
        "An asset with the same filename in the same folder already exists."
    )]
    AssetRenameCollision,
    #[error("You are not authorized to rename this asset.")]
    AssetRenameForbidden,
    #[error("The new asset filename is invalid.")]
    AssetRenameInvalid,
    #[error("The file extension cannot be changed on an existing asset.")]
    AssetRenameInvalidExt,
    #[error(
        "You are not authorized to rename this asset to the requested name."
    )]
    AssetRenameTargetForbidden,
    #[error("Unknown response error code: {code}: {message}")]
    UnknownErrorCode { code: i64, message: String },
    #[error("Unknown response error: {message}")]
    UnknownErrorMessage { message: String },
    #[error("Unknown response error.")]
    UnknownError,
}

impl From<i64> for AssetError {
    fn from(code: i64) -> Self {
        match code {
            2001 => AssetError::AssetGenericError,
            2002 => AssetError::AssetFolderExists,
            2003 => AssetError::AssetDeleteForbidden,
            2004 => AssetError::AssetInvalid,
            2005 => AssetError::AssetRenameCollision,
            2006 => AssetError::AssetRenameForbidden,
            2007 => AssetError::AssetRenameInvalid,
            2008 => AssetError::AssetRenameInvalidExt,
            2009 => AssetError::AssetRenameTargetForbidden,
            _ => AssetError::UnknownErrorCode {
                code,
                message: "Unknown error".to_string(),
            },
        }
    }
}

impl UnknownError for AssetError {
    fn unknown_error_code(code: i64, message: String) -> Self {
        AssetError::UnknownErrorCode { code, message }
    }
    fn unknown_error_message(message: String) -> Self {
        AssetError::UnknownErrorMessage { message }
    }
    fn unknown_error() -> Self {
        AssetError::UnknownError
    }
}

impl KnownErrorCodes for AssetError {
    fn known_error_codes() -> Vec<i64> {
        vec![2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009]
    }

    fn is_known_error_code(code: i64) -> bool {
        matches!(code, 2001..=2009)
    }
}

#[derive(Clone, Deserialize, Debug)]
pub struct AssetItem {
    pub id: Int,
    pub filename: String,
    pub ext: String,
    pub kind: AssetKind,
    pub mime: String,
    #[serde(rename = "fileSize")]
    pub file_size: Int,
    pub metadata: Option<String>,
    #[serde(rename = "createdAt")]
    pub created_at: Date,
    #[serde(rename = "updatedAt")]
    pub updated_at: Date,
    pub folder: Option<AssetFolder>,
    pub author: Option<Int>,
}

#[derive(Clone, Deserialize, Debug)]
pub struct AssetFolder {
    pub id: Int,
    pub slug: String,
    pub name: Option<String>,
}

#[derive(Clone, Serialize, Deserialize, Debug)]
pub enum AssetKind {
    IMAGE,
    BINARY,
    ALL,
}

impl ToString for AssetKind {
    fn to_string(&self) -> String {
        match self {
            AssetKind::IMAGE => "IMAGE".to_string(),
            AssetKind::BINARY => "BINARY".to_string(),
            AssetKind::ALL => "ALL".to_string(),
        }
    }
}

pub(crate) mod asset_list {
    use super::*;

    pub struct AssetList;

    pub const OPERATION_NAME: &str = "AssetList";
    pub const QUERY : & str = "query AssetList($folderId: Int!, $kind: AssetKind!) {\n  assets {\n    list (folderId: $folderId, kind: $kind) {\n      id\n      filename\n      ext\n      kind\n      mime\n      fileSize\n      metadata\n      createdAt\n      updatedAt\n      folder {\n        id\n        slug\n        name\n      }\n      author {\n        id\n      }\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables {
        #[serde(rename = "folderId")]
        pub folder_id: Int,
        pub kind: AssetKind,
    }

    impl Variables {}

    #[derive(Deserialize)]
    pub struct ResponseData {
        pub assets: Option<Assets>,
    }

    #[derive(Deserialize)]
    pub struct Assets {
        pub list: Option<Vec<Option<AssetItem>>>,
    }

    impl graphql_client::GraphQLQuery for AssetList {
        type Variables = Variables;
        type ResponseData = ResponseData;
        fn build_query(
            variables: Self::Variables,
        ) -> ::graphql_client::QueryBody<Self::Variables> {
            graphql_client::QueryBody {
                variables,
                query: QUERY,
                operation_name: OPERATION_NAME,
            }
        }
    }
}

// TODO an asset_get function might be interesting as well
pub fn asset_list(
    client: &Client,
    url: &str,
    folder_id: Int,
    kind: AssetKind,
) -> Result<Vec<AssetItem>, AssetError> {
    let variables = asset_list::Variables { folder_id, kind };
    let response =
        post_graphql::<asset_list::AssetList, _>(client, url, variables);
    if response.is_err() {
        return Err(AssetError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(assets) = data.assets {
            if let Some(list) = assets.list {
                return Ok(list
                    .into_iter()
                    .flatten()
                    .collect::<Vec<AssetItem>>());
            }
        }
    }
    Err(classify_response_error(response_body.errors))
}

pub mod asset_folder_list {
    use super::*;

    pub struct AssetFolderList;

    pub const OPERATION_NAME: &str = "AssetFolderList";
    pub const QUERY : & str = "query AssetFolderList($parentFolderId: Int!) {\n  assets {\n    folders (parentFolderId: $parentFolderId) {\n      id\n      slug\n      name\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables {
        #[serde(rename = "parentFolderId")]
        pub parent_folder_id: Int,
    }

    impl Variables {}

    #[derive(Deserialize)]
    pub struct ResponseData {
        pub assets: Option<Assets>,
    }

    #[derive(Deserialize)]
    pub struct Assets {
        pub folders: Option<Vec<Option<AssetFolder>>>,
    }

    impl graphql_client::GraphQLQuery for AssetFolderList {
        type Variables = Variables;
        type ResponseData = ResponseData;
        fn build_query(
            variables: Self::Variables,
        ) -> ::graphql_client::QueryBody<Self::Variables> {
            graphql_client::QueryBody {
                variables,
                query: QUERY,
                operation_name: OPERATION_NAME,
            }
        }
    }
}

pub fn asset_folder_list(
    client: &Client,
    url: &str,
    parent_folder_id: Int,
) -> Result<Vec<AssetFolder>, AssetError> {
    let variables = asset_folder_list::Variables { parent_folder_id };
    let response = post_graphql::<asset_folder_list::AssetFolderList, _>(
        client, url, variables,
    );
    if response.is_err() {
        return Err(AssetError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(assets) = data.assets {
            if let Some(folders) = assets.folders {
                return Ok(folders
                    .into_iter()
                    .flatten()
                    .collect::<Vec<AssetFolder>>());
            }
        }
    }
    Err(classify_response_error(response_body.errors))
}

pub mod asset_folder_create {

    use super::*;

    pub struct AssetFolderCreate;

    pub const OPERATION_NAME: &str = "AssetFolderCreate";
    pub const QUERY : & str = "mutation AssetFolderCreate(\n  $parentFolderId: Int!\n  $slug: String!\n  $name: String\n) {\n  assets {\n    createFolder(\n      parentFolderId: $parentFolderId\n      slug: $slug\n      name: $name\n    ) {\n      responseResult {\n        succeeded\n        errorCode\n        slug\n        message\n      }\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables {
        #[serde(rename = "parentFolderId")]
        pub parent_folder_id: Int,
        pub slug: String,
        pub name: Option<String>,
    }

    impl Variables {}

    #[derive(Deserialize)]
    pub struct ResponseData {
        pub assets: Option<Assets>,
    }

    #[derive(Deserialize)]
    pub struct Assets {
        #[serde(rename = "createFolder")]
        pub create_folder: Option<CreateFolder>,
    }

    #[derive(Deserialize)]
    pub struct CreateFolder {
        #[serde(rename = "responseResult")]
        pub response_result: Option<ResponseStatus>,
    }

    impl graphql_client::GraphQLQuery for AssetFolderCreate {
        type Variables = Variables;
        type ResponseData = ResponseData;
        fn build_query(
            variables: Self::Variables,
        ) -> ::graphql_client::QueryBody<Self::Variables> {
            graphql_client::QueryBody {
                variables,
                query: QUERY,
                operation_name: OPERATION_NAME,
            }
        }
    }
}

pub fn asset_folder_create(
    client: &Client,
    url: &str,
    parent_folder_id: Int,
    slug: String,
    name: Option<String>,
) -> Result<(), AssetError> {
    let variables = asset_folder_create::Variables {
        parent_folder_id,
        slug,
        name,
    };
    let response = post_graphql::<asset_folder_create::AssetFolderCreate, _>(
        client, url, variables,
    );
    if response.is_err() {
        return Err(AssetError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(assets) = data.assets {
            if let Some(create_folder) = assets.create_folder {
                if let Some(response_result) = create_folder.response_result {
                    if response_result.succeeded {
                        return Ok(());
                    } else {
                        return Err(classify_response_status_error(
                            response_result,
                        ));
                    }
                }
            }
        }
    }
    Err(classify_response_error(response_body.errors))
}

pub mod asset_rename {
    use super::*;

    pub struct AssetRename;

    pub const OPERATION_NAME: &str = "AssetRename";
    pub const QUERY : & str = "mutation AssetRename($id: Int!, $filename: String!) {\n  assets {\n    renameAsset(id: $id, filename: $filename) {\n      responseResult {\n        succeeded\n        errorCode\n        slug\n        message\n      }\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables {
        pub id: Int,
        pub filename: String,
    }

    impl Variables {}

    #[derive(Deserialize)]
    pub struct ResponseData {
        pub assets: Option<Assets>,
    }

    #[derive(Deserialize)]
    pub struct Assets {
        #[serde(rename = "renameAsset")]
        pub rename_asset: Option<RenameAsset>,
    }
    #[derive(Deserialize)]
    pub struct RenameAsset {
        #[serde(rename = "responseResult")]
        pub response_result: Option<ResponseStatus>,
    }

    impl graphql_client::GraphQLQuery for AssetRename {
        type Variables = Variables;
        type ResponseData = ResponseData;
        fn build_query(
            variables: Self::Variables,
        ) -> ::graphql_client::QueryBody<Self::Variables> {
            graphql_client::QueryBody {
                variables,
                query: QUERY,
                operation_name: OPERATION_NAME,
            }
        }
    }
}

pub fn asset_rename(
    client: &Client,
    url: &str,
    id: Int,
    filename: String,
) -> Result<(), AssetError> {
    let variables = asset_rename::Variables { id, filename };
    let response =
        post_graphql::<asset_rename::AssetRename, _>(client, url, variables);
    if response.is_err() {
        return Err(AssetError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(assets) = data.assets {
            if let Some(rename_asset) = assets.rename_asset {
                if let Some(response_result) = rename_asset.response_result {
                    if response_result.succeeded {
                        return Ok(());
                    } else {
                        return Err(classify_response_status_error(
                            response_result,
                        ));
                    }
                }
            }
        }
    }
    Err(classify_response_error(response_body.errors))
}

pub mod asset_delete {
    use super::*;

    pub struct AssetDelete;

    pub const OPERATION_NAME: &str = "AssetDelete";
    pub const QUERY : & str = "mutation AssetDelete($id: Int!) {\n  assets {\n    deleteAsset(id: $id) {\n      responseResult {\n        succeeded\n        errorCode\n        slug\n        message\n      }\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables {
        pub id: Int,
    }

    impl Variables {}

    #[derive(Deserialize)]
    pub struct ResponseData {
        pub assets: Option<Assets>,
    }

    #[derive(Deserialize)]
    pub struct Assets {
        #[serde(rename = "deleteAsset")]
        pub delete_asset: Option<DeleteAsset>,
    }

    #[derive(Deserialize)]
    pub struct DeleteAsset {
        #[serde(rename = "responseResult")]
        pub response_result: Option<ResponseStatus>,
    }

    impl graphql_client::GraphQLQuery for AssetDelete {
        type Variables = Variables;
        type ResponseData = ResponseData;
        fn build_query(
            variables: Self::Variables,
        ) -> ::graphql_client::QueryBody<Self::Variables> {
            graphql_client::QueryBody {
                variables,
                query: QUERY,
                operation_name: OPERATION_NAME,
            }
        }
    }
}

pub fn asset_delete(
    client: &Client,
    url: &str,
    id: Int,
) -> Result<(), AssetError> {
    let variables = asset_delete::Variables { id };
    let response =
        post_graphql::<asset_delete::AssetDelete, _>(client, url, variables);
    if response.is_err() {
        return Err(AssetError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(assets) = data.assets {
            if let Some(delete_asset) = assets.delete_asset {
                if let Some(response_result) = delete_asset.response_result {
                    if response_result.succeeded {
                        return Ok(());
                    } else {
                        return Err(classify_response_status_error(
                            response_result,
                        ));
                    }
                }
            }
        }
    }
    Err(classify_response_error(response_body.errors))
}

pub mod asset_temp_upload_flush {
    use super::*;

    pub struct AssetTempUploadFlush;

    pub const OPERATION_NAME: &str = "AssetTempUploadFlush";
    pub const QUERY : & str = "mutation AssetTempUploadFlush {\n  assets {\n    flushTempUploads {\n      responseResult {\n        succeeded\n        errorCode\n        slug\n        message\n      }\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables;

    #[derive(Deserialize)]
    pub struct ResponseData {
        pub assets: Option<Assets>,
    }

    #[derive(Deserialize)]
    pub struct Assets {
        #[serde(rename = "flushTempUploads")]
        pub flush_temp_uploads: Option<FlushTempUploads>,
    }

    #[derive(Deserialize)]
    pub struct FlushTempUploads {
        #[serde(rename = "responseResult")]
        pub response_result: Option<ResponseStatus>,
    }

    impl graphql_client::GraphQLQuery for AssetTempUploadFlush {
        type Variables = asset_temp_upload_flush::Variables;
        type ResponseData = asset_temp_upload_flush::ResponseData;
        fn build_query(
            variables: Self::Variables,
        ) -> ::graphql_client::QueryBody<Self::Variables> {
            graphql_client::QueryBody {
                variables,
                query: asset_temp_upload_flush::QUERY,
                operation_name: asset_temp_upload_flush::OPERATION_NAME,
            }
        }
    }
}

pub fn asset_temp_upload_flush(
    client: &Client,
    url: &str,
) -> Result<(), AssetError> {
    let variables = asset_temp_upload_flush::Variables;
    let response = post_graphql::<
        asset_temp_upload_flush::AssetTempUploadFlush,
        _,
    >(client, url, variables);
    if response.is_err() {
        return Err(AssetError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(assets) = data.assets {
            if let Some(flush_temp_uploads) = assets.flush_temp_uploads {
                if let Some(response_result) =
                    flush_temp_uploads.response_result
                {
                    if response_result.succeeded {
                        return Ok(());
                    } else {
                        return Err(classify_response_status_error(
                            response_result,
                        ));
                    }
                }
            }
        }
    }
    Err(classify_response_error(response_body.errors))
}

pub fn asset_download(
    client: &Client,
    url: &str,
    path: String,
) -> Result<Vec<u8>, AssetError> {
    let response = client.get(format!("{}/{}", url, path).as_str()).send();
    if response.is_err() {
        return Err(AssetError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if response_body.status().is_success() {
        return Ok(response_body.bytes().unwrap().to_vec());
    }
    Err(AssetError::UnknownError)
}

pub fn asset_upload(
    client: &Client,
    url: &str,
    folder: Int,
    name: String,
    data: Vec<u8>,
) -> Result<(), AssetError> {
    // NOTE: we can also set the mime type like this, but apparently it
    //       also works without it.
    // let part = match reqwest::blocking::multipart::Part::bytes(data)
    //     .file_name(name)
    //     .mime_str("image/jpeg") {
    //         Ok(part) => part,
    //         Err(_) => return Err(AssetError::UnknownError),
    //     };
    let part = reqwest::blocking::multipart::Part::bytes(data).file_name(name);
    let form = reqwest::blocking::multipart::Form::new()
        .text("mediaUpload", format!("{{\"folderId\":{}}}", folder))
        .part("mediaUpload", part);
    let response = client
        .post(format!("{}/u", url).as_str())
        .multipart(form)
        .send();
    if response.is_err() {
        return Err(AssetError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if response_body.status().is_success() {
        return Ok(());
    }
    Err(AssetError::UnknownError)
}