junobuild-collections 0.5.2

The types and rules to define collections.
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

use crate::types::interface::SetRule;
use crate::types::rules::Memory;
use crate::types::rules::Permission::{Controllers, Managed, Public};
use junobuild_shared::rate::constants::DEFAULT_RATE_CONFIG;

pub const COLLECTION_USER_KEY: &str = "#user";
pub const COLLECTION_LOG_KEY: &str = "#log";
pub const COLLECTION_USER_USAGE_KEY: &str = "#user-usage";
pub const COLLECTION_USER_WEBAUTHN_KEY: &str = "#user-webauthn";
pub const COLLECTION_USER_WEBAUTHN_INDEX_KEY: &str = "#user-webauthn-index";
pub const COLLECTION_AUTOMATION_TOKEN_KEY: &str = "#automation-token";
pub const COLLECTION_AUTOMATION_WORKFLOW_KEY: &str = "#automation-workflow";

const COLLECTION_USER_DEFAULT_RULE: SetRule = SetRule {
    read: Managed,
    // ❗Managed, BUT an assertion prevents the user from updating the entry.
    write: Managed,
    memory: Some(Memory::Stable),
    mutable_permissions: Some(false),
    max_size: None,
    max_capacity: None,
    max_changes_per_user: None,
    version: None,
    rate_config: Some(DEFAULT_RATE_CONFIG),
};

pub const COLLECTION_LOG_DEFAULT_RULE: SetRule = SetRule {
    read: Controllers,
    write: Controllers,
    memory: Some(Memory::Stable),
    mutable_permissions: Some(false),
    max_size: None,
    max_capacity: Some(100),
    max_changes_per_user: None,
    version: None,
    rate_config: None,
};

pub const COLLECTION_USER_USAGE_DEFAULT_RULE: SetRule = SetRule {
    read: Controllers,
    write: Controllers,
    memory: Some(Memory::Stable),
    mutable_permissions: Some(false),
    max_size: None,
    max_capacity: None,
    max_changes_per_user: None,
    version: None,
    rate_config: None,
};

pub const COLLECTION_USER_WEBAUTHN_DEFAULT_RULE: SetRule = SetRule {
    // ℹ️ Public because this is required to retrieve the public key for the passkey
    // when users sign in again through navigator.credentials.get. Public keys are by definition
    // public, and the rawId is the unique identifier provided by WebAuthn, which is not secret by definition either.
    read: Public,
    // ❗Managed, BUT an assertion prevents it to be edited.
    write: Managed,
    memory: Some(Memory::Stable),
    mutable_permissions: Some(false),
    max_size: None,
    max_capacity: None,
    max_changes_per_user: None,
    version: None,
    rate_config: None,
};

pub const COLLECTION_USER_WEBAUTHN_INDEX_DEFAULT_RULE: SetRule = SetRule {
    // Created and read through internal hooks. We do not have an assertion at the moment that would
    // prevent a controller to set the document themselves.
    read: Controllers,
    write: Controllers,
    memory: Some(Memory::Stable),
    mutable_permissions: Some(false),
    max_size: None,
    max_capacity: None,
    max_changes_per_user: None,
    version: None,
    rate_config: None,
};

pub const COLLECTION_AUTOMATION_TOKEN_DEFAULT_RULE: SetRule = SetRule {
    // Created and read through internal hooks. Write is restricted to Satellites themselves.
    read: Controllers,
    write: Controllers,
    memory: Some(Memory::Stable),
    mutable_permissions: Some(false),
    max_size: None,
    max_capacity: None,
    max_changes_per_user: None,
    version: None,
    rate_config: None,
};

pub const COLLECTION_AUTOMATION_WORKFLOW_DEFAULT_RULE: SetRule = SetRule {
    // Created through internal hooks. Write is restricted to Satellites themselves.
    // Read allowed for controllers.
    read: Controllers,
    write: Controllers,
    memory: Some(Memory::Stable),
    mutable_permissions: Some(false),
    max_size: None,
    max_capacity: None,
    max_changes_per_user: None,
    version: None,
    rate_config: None,
};

pub const DEFAULT_DB_COLLECTIONS: [(&str, SetRule); 7] = [
    (COLLECTION_USER_KEY, COLLECTION_USER_DEFAULT_RULE),
    (COLLECTION_LOG_KEY, COLLECTION_LOG_DEFAULT_RULE),
    (
        COLLECTION_USER_USAGE_KEY,
        COLLECTION_USER_USAGE_DEFAULT_RULE,
    ),
    (
        COLLECTION_USER_WEBAUTHN_KEY,
        COLLECTION_USER_WEBAUTHN_DEFAULT_RULE,
    ),
    (
        COLLECTION_USER_WEBAUTHN_INDEX_KEY,
        COLLECTION_USER_WEBAUTHN_INDEX_DEFAULT_RULE,
    ),
    (
        COLLECTION_AUTOMATION_TOKEN_KEY,
        COLLECTION_AUTOMATION_TOKEN_DEFAULT_RULE,
    ),
    (
        COLLECTION_AUTOMATION_WORKFLOW_KEY,
        COLLECTION_AUTOMATION_WORKFLOW_DEFAULT_RULE,
    ),
];