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
646
647
648
649
650
651
652
653
654
655
656
657
658
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, Boolean, Date,
    Int, KeyValuePair, KeyValuePairInput, KnownErrorCodes, ResponseStatus,
    UnknownError,
};

#[derive(Clone, Debug, Error, PartialEq)]
pub enum CommentError {
    #[error("An unexpected error occurred.")]
    CommentGenericError,
    #[error("You are not authorized to post a comment on this page.")]
    CommentPostForbidden,
    #[error("Comment content is missing or too short.")]
    CommentContentMissing,
    #[error("You are not authorized to manage comments on this page.")]
    CommentManageForbidden,
    #[error("This comment does not exist.")]
    CommentNotFound,
    #[error("You are not authorized to view comments for this page.")]
    CommentViewForbidden,
    #[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 CommentError {
    fn from(code: i64) -> Self {
        match code {
            8001 => CommentError::CommentGenericError,
            8002 => CommentError::CommentPostForbidden,
            8003 => CommentError::CommentContentMissing,
            8004 => CommentError::CommentManageForbidden,
            8005 => CommentError::CommentNotFound,
            8006 => CommentError::CommentViewForbidden,
            _ => CommentError::UnknownErrorCode {
                code,
                message: "Unknown error".to_string(),
            },
        }
    }
}

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

impl KnownErrorCodes for CommentError {
    fn known_error_codes() -> Vec<i64> {
        vec![8001, 8002, 8003, 8004, 8005, 8006]
    }

    fn is_known_error_code(code: i64) -> bool {
        (8001..=8006).contains(&code)
    }
}

#[derive(Clone, Deserialize)]
pub struct Comment {
    pub id: Int,
    pub content: String,
    pub render: String,
    #[serde(rename = "authorId")]
    pub author_id: Int,
    #[serde(rename = "authorName")]
    pub author_name: String,
    #[serde(rename = "authorEmail")]
    pub author_email: String,
    #[serde(rename = "authorIP")]
    pub author_ip: String,
    #[serde(rename = "createdAt")]
    pub created_at: Date,
    #[serde(rename = "updatedAt")]
    pub updated_at: Date,
}

#[derive(Clone, Deserialize, Debug)]
pub struct CommentProvider {
    #[serde(rename = "isEnabled")]
    pub is_enabled: Boolean,
    pub key: String,
    pub title: String,
    pub description: Option<String>,
    pub logo: Option<String>,
    pub website: Option<String>,
    #[serde(rename = "isAvailable")]
    pub is_available: Option<Boolean>,
    pub config: Option<Vec<Option<KeyValuePair>>>,
}

#[derive(Clone, Serialize, Debug)]
pub struct CommentProviderInput {
    #[serde(rename = "isEnabled")]
    pub is_enabled: Boolean,
    pub key: String,
    pub config: Option<Vec<Option<KeyValuePairInput>>>,
}

#[derive(Clone, Deserialize, Debug)]
pub struct CommentCreateResponse {
    #[serde(rename = "responseResult")]
    pub response_result: Option<ResponseStatus>,
    pub id: Option<Int>,
}

#[derive(Clone, Deserialize, Debug)]
pub struct CommentUpdateResponse {
    #[serde(rename = "responseResult")]
    pub response_result: Option<ResponseStatus>,
    pub render: Option<String>,
}

pub mod comment_list {
    use super::*;

    pub struct CommentList;

    pub const OPERATION_NAME: &str = "CommentList";
    pub const QUERY : & str = "query CommentList($locale: String!, $path: String!) {\n  comments {\n    list(locale: $locale, path: $path) {\n      id\n      content\n      render\n      authorId\n      authorName\n      authorEmail\n      authorIP\n      createdAt\n      updatedAt\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables {
        pub locale: String,
        pub path: String,
    }

    impl Variables {}

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

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

    impl graphql_client::GraphQLQuery for CommentList {
        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 comment_list(
    client: &Client,
    url: &str,
    locale: String,
    path: String,
) -> Result<Vec<Comment>, CommentError> {
    let variables = comment_list::Variables { locale, path };
    let response =
        post_graphql::<comment_list::CommentList, _>(client, url, variables);
    if response.is_err() {
        return Err(CommentError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(comments) = data.comments {
            return Ok(comments.list.into_iter().flatten().collect());
        }
    }
    Err(classify_response_error::<CommentError>(
        response_body.errors,
    ))
}

pub mod comment_provider_list {
    use super::*;

    pub struct CommentProviderList;

    pub const OPERATION_NAME: &str = "CommentProviderList";
    pub const QUERY : & str = "query CommentProviderList {\n  comments {\n    providers {\n      isEnabled\n      key\n      title\n      description\n      logo\n      website\n      isAvailable\n      config {\n        key\n        value\n      }\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables;

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

    #[derive(Deserialize)]
    pub struct Comments {
        pub providers: Option<Vec<Option<CommentProvider>>>,
    }

    impl graphql_client::GraphQLQuery for CommentProviderList {
        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 comment_provider_list(
    client: &Client,
    url: &str,
) -> Result<Vec<CommentProvider>, CommentError> {
    let variables = comment_provider_list::Variables {};
    let response = post_graphql::<comment_provider_list::CommentProviderList, _>(
        client, url, variables,
    );
    if response.is_err() {
        return Err(CommentError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(comments) = data.comments {
            if let Some(providers) = comments.providers {
                return Ok(providers.into_iter().flatten().collect());
            }
        }
    }
    Err(classify_response_error::<CommentError>(
        response_body.errors,
    ))
}

pub mod comment_get {
    use super::*;

    pub struct CommentGet;

    pub const OPERATION_NAME: &str = "CommentGet";
    pub const QUERY : & str = "query CommentGet($id: Int!) {\n  comments {\n    single (id: $id) {\n      id\n      content\n      render\n      authorId\n      authorName\n      authorEmail\n      authorIP\n      createdAt\n      updatedAt\n    }\n  }\n}\n" ;

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

    impl Variables {}

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

    #[derive(Deserialize)]
    pub struct Comments {
        pub single: Option<Comment>,
    }

    impl graphql_client::GraphQLQuery for CommentGet {
        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 comment_get(
    client: &Client,
    url: &str,
    id: Int,
) -> Result<Comment, CommentError> {
    let variables = comment_get::Variables { id };
    let response =
        post_graphql::<comment_get::CommentGet, _>(client, url, variables);
    if response.is_err() {
        return Err(CommentError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(comments) = data.comments {
            if let Some(comment) = comments.single {
                return Ok(comment);
            }
        }
    }
    Err(classify_response_error::<CommentError>(
        response_body.errors,
    ))
}

pub mod comment_provider_update {
    use super::*;

    pub struct CommentProviderUpdate;

    pub const OPERATION_NAME: &str = "CommentProviderUpdate";
    pub const QUERY : & str = "mutation CommentProviderUpdate($providers: [CommentProviderInput]) {\n  comments {\n    updateProviders(providers: $providers) {\n      responseResult {\n        succeeded\n        errorCode\n        slug\n        message\n      }\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables {
        pub providers: Option<Vec<Option<CommentProviderInput>>>,
    }

    impl Variables {}

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

    #[derive(Deserialize)]
    pub struct Comments {
        #[serde(rename = "updateProviders")]
        pub update_providers: Option<UpdateProviders>,
    }

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

    impl graphql_client::GraphQLQuery for CommentProviderUpdate {
        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 comment_provider_update(
    client: &Client,
    url: &str,
    providers: Vec<CommentProviderInput>,
) -> Result<(), CommentError> {
    let variables = comment_provider_update::Variables {
        providers: Some(providers.into_iter().map(Some).collect()),
    };
    let response = post_graphql::<
        comment_provider_update::CommentProviderUpdate,
        _,
    >(client, url, variables);
    if response.is_err() {
        return Err(CommentError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(comments) = data.comments {
            if let Some(update_providers) = comments.update_providers {
                if let Some(response_result) = update_providers.response_result
                {
                    if response_result.succeeded {
                        return Ok(());
                    } else {
                        return Err(classify_response_status_error::<
                            CommentError,
                        >(response_result));
                    }
                }
            }
        }
    }
    Err(classify_response_error::<CommentError>(
        response_body.errors,
    ))
}

pub mod comment_create {
    use super::*;

    pub struct CommentCreate;

    pub const OPERATION_NAME: &str = "CommentCreate";
    pub const QUERY : & str = "mutation CommentCreate(\n  $pageId: Int!\n  $replyTo: Int\n  $content: String!\n  $guestName: String\n  $guestEmail: String\n) {\n  comments {\n    create (\n      pageId: $pageId\n      replyTo: $replyTo\n      content: $content\n      guestName: $guestName\n      guestEmail: $guestEmail\n    ) {\n      responseResult {\n        succeeded\n        errorCode\n        slug\n        message\n      }\n      id\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables {
        #[serde(rename = "pageId")]
        pub page_id: Int,
        #[serde(rename = "replyTo")]
        pub reply_to: Option<Int>,
        pub content: String,
        #[serde(rename = "guestName")]
        pub guest_name: Option<String>,
        #[serde(rename = "guestEmail")]
        pub guest_email: Option<String>,
    }

    impl Variables {}

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

    #[derive(Deserialize)]
    pub struct Comments {
        pub create: Option<CommentCreateResponse>,
    }

    impl graphql_client::GraphQLQuery for CommentCreate {
        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 comment_create(
    client: &Client,
    url: &str,
    page_id: Int,
    reply_to: Option<Int>,
    content: String,
    guest_name: Option<String>,
    guest_email: Option<String>,
) -> Result<(), CommentError> {
    let variables = comment_create::Variables {
        page_id,
        reply_to,
        content,
        guest_name,
        guest_email,
    };
    let response = post_graphql::<comment_create::CommentCreate, _>(
        client, url, variables,
    );
    if response.is_err() {
        return Err(CommentError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(comments) = data.comments {
            if let Some(create) = comments.create {
                if let Some(response_result) = create.response_result {
                    if response_result.succeeded {
                        // TODO check if this does really not return an id
                        return Ok(());
                    } else {
                        return Err(classify_response_status_error::<
                            CommentError,
                        >(response_result));
                    }
                }
            }
        }
    }
    Err(classify_response_error::<CommentError>(
        response_body.errors,
    ))
}

pub mod comment_update {
    use super::*;

    pub struct CommentUpdate;

    pub const OPERATION_NAME: &str = "CommentUpdate";
    pub const QUERY : & str = "mutation CommentUpdate($id: Int!, $content: String!) {\n  comments {\n    update (id: $id, content: $content) {\n      responseResult {\n        succeeded\n        errorCode\n        slug\n        message\n      }\n      render\n    }\n  }\n}\n" ;

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

    impl Variables {}

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

    #[derive(Deserialize)]
    pub struct Comments {
        pub update: Option<CommentUpdateResponse>,
    }

    impl graphql_client::GraphQLQuery for CommentUpdate {
        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 comment_update(
    client: &Client,
    url: &str,
    id: Int,
    content: String,
) -> Result<(), CommentError> {
    let variables = comment_update::Variables { id, content };
    let response = post_graphql::<comment_update::CommentUpdate, _>(
        client, url, variables,
    );
    if response.is_err() {
        return Err(CommentError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(comments) = data.comments {
            if let Some(update) = comments.update {
                if let Some(response_result) = update.response_result {
                    if response_result.succeeded {
                        return Ok(());
                    } else {
                        return Err(classify_response_status_error::<
                            CommentError,
                        >(response_result));
                    }
                }
            }
        }
    }
    Err(classify_response_error::<CommentError>(
        response_body.errors,
    ))
}

pub mod comment_delete {
    use super::*;

    pub struct CommentDelete;

    pub const OPERATION_NAME: &str = "CommentDelete";
    pub const QUERY : & str = "mutation CommentDelete($id: Int!) {\n  comments {\n    delete (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 comments: Option<Comments>,
    }

    #[derive(Deserialize)]
    pub struct Comments {
        pub delete: Option<Delete>,
    }

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

    impl graphql_client::GraphQLQuery for CommentDelete {
        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 comment_delete(
    client: &Client,
    url: &str,
    id: Int,
) -> Result<(), CommentError> {
    let variables = comment_delete::Variables { id };
    let response = post_graphql::<comment_delete::CommentDelete, _>(
        client, url, variables,
    );
    if response.is_err() {
        return Err(CommentError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(comments) = data.comments {
            if let Some(delete) = comments.delete {
                if let Some(response_result) = delete.response_result {
                    if response_result.succeeded {
                        return Ok(());
                    } else {
                        return Err(classify_response_status_error::<
                            CommentError,
                        >(response_result));
                    }
                }
            }
        }
    }
    Err(classify_response_error::<CommentError>(
        response_body.errors,
    ))
}