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
659
660
661
662
663
664
665
666
667
668
669
670
671
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, KnownErrorCodes, ResponseStatus, UnknownError,
};
use crate::user::UserMinimal;

#[derive(Clone, Error, Debug, PartialEq)]
pub enum GroupError {
    #[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 GroupError {
    fn from(code: i64) -> Self {
        GroupError::UnknownErrorCode {
            code,
            message: "Unknown error".to_string(),
        }
    }
}

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

impl KnownErrorCodes for GroupError {
    fn known_error_codes() -> Vec<i64> {
        Vec::new()
    }

    fn is_known_error_code(_code: i64) -> bool {
        false
    }
}

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

#[derive(Clone, Deserialize, Debug)]
pub struct GroupMinimal {
    pub id: Int,
    pub name: String,
    #[serde(rename = "isSystem")]
    pub is_system: Boolean,
    #[serde(rename = "userCount")]
    pub user_count: Option<Int>,
    #[serde(rename = "createdAt")]
    pub created_at: Date,
    #[serde(rename = "updatedAt")]
    pub updated_at: Date,
}

#[derive(Clone, Deserialize, Debug)]
pub struct Group {
    pub id: Int,
    pub name: String,
    #[serde(rename = "isSystem")]
    pub is_system: Boolean,
    #[serde(rename = "redirectOnLogin")]
    pub redirect_on_login: Option<String>,
    pub permissions: Vec<String>,
    pub page_rules: Option<Vec<Option<PageRule>>>,
    pub users: Option<Vec<UserMinimal>>,
    #[serde(rename = "createdAt")]
    pub created_at: Date,
    #[serde(rename = "updatedAt")]
    pub updated_at: Date,
}

#[derive(Clone, Deserialize, Debug)]
pub struct PageRule {
    pub id: String,
    pub deny: Boolean,
    pub r#match: PageRuleMatch,
    pub roles: Vec<String>,
    pub path: String,
    pub locales: Vec<String>,
}

#[derive(Clone, Deserialize, Serialize, Debug)]
pub struct PageRuleInput {
    pub id: String,
    pub deny: Boolean,
    pub r#match: PageRuleMatch,
    pub roles: Vec<String>,
    pub path: String,
    pub locales: Vec<String>,
}

#[derive(Clone, Deserialize, Serialize, Debug)]
pub enum PageRuleMatch {
    START,
    EXACT,
    END,
    REGEX,
    TAG,
}

pub mod group_list {
    use super::*;

    pub struct GroupList;

    pub const OPERATION_NAME: &str = "GroupList";
    pub const QUERY : & str = "query GroupList($filter: String, $orderBy: String) {\n  groups {\n    list (filter: $filter, orderBy: $orderBy) {\n      id\n      name\n      isSystem\n      userCount\n      createdAt\n      updatedAt\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables {
        pub filter: Option<String>,
        #[serde(rename = "orderBy")]
        pub order_by: Option<String>,
    }

    impl Variables {}

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

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

    impl graphql_client::GraphQLQuery for GroupList {
        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 group_list(
    client: &Client,
    url: &str,
    filter: Option<String>,
    order_by: Option<String>,
) -> Result<Vec<GroupMinimal>, GroupError> {
    let variables = group_list::Variables { filter, order_by };
    let response =
        post_graphql::<group_list::GroupList, _>(client, url, variables);
    if response.is_err() {
        return Err(GroupError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(groups) = data.groups {
            if let Some(list) = groups.list {
                return Ok(list.into_iter().flatten().collect());
            }
        }
    }
    Err(classify_response_error::<GroupError>(response_body.errors))
}

pub mod group_get {
    use super::*;

    pub struct GroupGet;

    pub const OPERATION_NAME: &str = "GroupGet";
    pub const QUERY : & str = "query GroupGet($id: Int!) {\n  groups {\n    single(id: $id) {\n      id\n      name\n      isSystem\n      redirectOnLogin\n      permissions\n      pageRules\n      users\n      createdAt\n      updatedAt\n    }\n  }\n}\n" ;

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

    impl Variables {}

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

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

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

pub mod group_create {
    use super::*;

    pub struct GroupCreate;

    pub const OPERATION_NAME: &str = "GroupCreate";
    pub const QUERY : & str = "mutation GroupCreate($name: String!) {\n  groups {\n    create(name: $name) {\n      responseResult {\n        succeeded\n        errorCode\n        slug\n        message\n      }\n      group {\n        id\n        name\n        isSystem\n        redirectOnLogin\n        permissions\n        pageRules\n        users\n        createdAt\n        updatedAt\n      }\n    }\n  }\n}\n" ;

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

    impl Variables {}

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

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

    impl graphql_client::GraphQLQuery for GroupCreate {
        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 group_create(
    client: &Client,
    url: &str,
    name: String,
) -> Result<(), GroupError> {
    let variables = group_create::Variables { name };
    let response =
        post_graphql::<group_create::GroupCreate, _>(client, url, variables);
    if response.is_err() {
        return Err(GroupError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(groups) = data.groups {
            if let Some(create) = groups.create {
                if create.response_result.succeeded {
                    // TODO check that this really does not return a group
                    return Ok(());
                }
                return Err(GroupError::UnknownErrorCode {
                    code: create.response_result.error_code,
                    message: create
                        .response_result
                        .message
                        .unwrap_or("Unknown error".to_string()),
                });
            }
        }
    }
    Err(classify_response_error::<GroupError>(response_body.errors))
}

pub mod group_update {
    use super::*;

    pub struct GroupUpdate;

    pub const OPERATION_NAME: &str = "GroupUpdate";
    pub const QUERY : & str = "mutation GroupUpdate(\n  $id: Int!\n  $name: String!\n  $redirectOnLogin: String!\n  $permissions: [String]!\n  $pageRules: [PageRuleInput]!\n) {\n  groups {\n    update(\n      id: $id\n      name: $name\n      redirectOnLogin: $redirectOnLogin\n      permissions: $permissions\n      pageRules: $pageRules \n    ) {\n      responseResult {\n        succeeded\n        errorCode\n        slug\n        message\n      }\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables {
        pub id: Int,
        pub name: String,
        #[serde(rename = "redirectOnLogin")]
        pub redirect_on_login: String,
        pub permissions: Vec<Option<String>>,
        #[serde(rename = "pageRules")]
        pub page_rules: Vec<Option<PageRuleInput>>,
    }

    impl Variables {}

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

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

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

    impl graphql_client::GraphQLQuery for GroupUpdate {
        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 group_update(
    client: &Client,
    url: &str,
    id: Int,
    name: String,
    redirect_on_login: String,
    permissions: Vec<String>,
    page_rules: Vec<PageRuleInput>,
) -> Result<(), GroupError> {
    let variables = group_update::Variables {
        id,
        name,
        redirect_on_login,
        permissions: permissions.into_iter().map(Some).collect(),
        page_rules: page_rules.into_iter().map(Some).collect(),
    };
    let response =
        post_graphql::<group_update::GroupUpdate, _>(client, url, variables);
    if response.is_err() {
        return Err(GroupError::UnknownErrorMessage {
            message: response.err().unwrap().to_string(),
        });
    }
    let response_body = response.unwrap();
    if let Some(data) = response_body.data {
        if let Some(groups) = data.groups {
            if let Some(update) = groups.update {
                if let Some(response_result) = update.response_result {
                    if response_result.succeeded {
                        return Ok(());
                    } else {
                        return Err(
                            classify_response_status_error::<GroupError>(
                                response_result,
                            ),
                        );
                    }
                }
            }
        }
    }
    Err(classify_response_error::<GroupError>(response_body.errors))
}

pub mod group_delete {
    use super::*;

    pub struct GroupDelete;

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

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

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

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

pub mod group_user_assign {
    use super::*;

    pub struct GroupUserAssign;

    pub const OPERATION_NAME: &str = "GroupUserAssign";
    pub const QUERY : & str = "mutation GroupUserAssign(\n  $groupId: Int!\n  $userId: Int!\n) {\n  groups {\n    assignUser(\n      groupId: $groupId\n      userId: $userId\n    ) {\n      responseResult {\n        succeeded\n        errorCode\n        slug\n        message\n      }\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables {
        #[serde(rename = "groupId")]
        pub group_id: Int,
        #[serde(rename = "userId")]
        pub user_id: Int,
    }

    impl Variables {}

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

    #[derive(Deserialize)]
    pub struct Groups {
        #[serde(rename = "assignUser")]
        pub assign_user: Option<AssignUser>,
    }

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

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

pub mod group_user_unassign {
    use super::*;

    pub struct GroupUserUnassign;

    pub const OPERATION_NAME: &str = "GroupUserUnassign";
    pub const QUERY : & str = "mutation GroupUserUnassign(\n  $groupId: Int!\n  $userId: Int!\n) {\n  groups {\n    unassignUser(\n      groupId: $groupId\n      userId: $userId\n    ) {\n      responseResult {\n        succeeded\n        errorCode\n        slug\n        message\n      }\n    }\n  }\n}\n" ;

    #[derive(Serialize)]
    pub struct Variables {
        #[serde(rename = "groupId")]
        pub group_id: Int,
        #[serde(rename = "userId")]
        pub user_id: Int,
    }

    impl Variables {}

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

    #[derive(Deserialize)]
    pub struct Groups {
        #[serde(rename = "unassignUser")]
        pub unassign_user: Option<UnassignUser>,
    }

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

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