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
pub mod state {
use crate::db::types::config::DbConfig;
use crate::{DelDoc, SetDoc};
use candid::CandidType;
use ic_stable_structures::StableBTreeMap;
use junobuild_collections::types::core::CollectionKey;
use junobuild_collections::types::rules::Rules;
use junobuild_shared::rate::types::RateTokenStore;
use junobuild_shared::types::core::{Blob, Key};
use junobuild_shared::types::memory::Memory;
use junobuild_shared::types::state::{Timestamp, UserId, Version};
use serde::{Deserialize, Serialize};
use std::collections::{BTreeMap, HashMap};
pub type Collection = BTreeMap<Key, Doc>;
pub type DbHeap = HashMap<CollectionKey, Collection>;
pub type DbStable = StableBTreeMap<StableKey, Doc, Memory>;
#[derive(CandidType, Serialize, Deserialize, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct StableKey {
pub collection: CollectionKey,
pub key: Key,
}
#[derive(CandidType, Serialize, Deserialize, Clone)]
pub struct DbHeapState {
pub db: DbHeap,
pub rules: Rules,
pub config: Option<DbConfig>,
}
#[derive(Default, Clone)]
pub struct DbRuntimeState {
pub rate_tokens: RateTokenStore,
}
/// Represents a document in a collection's store.
///
/// This struct defines the structure of a document stored in a collection. It includes the following fields:
/// - `owner`: The `UserId` representing the owner of the document.
/// - `data`: A `Blob` containing the document's data.
/// - `description`: An optional `String` providing additional document description, limited to 1024 characters.
/// - `created_at`: A `u64` timestamp for the document's creation.
/// - `updated_at`: A `u64` timestamp for the document's last update.
/// - `version`: A `u64` number for the document's version. The field is optional for backwards compatibility but, will be populated to 1 on the first create or update.
///
/// This struct is used to store and manage documents within a collection's store.
#[derive(CandidType, Serialize, Deserialize, Clone)]
pub struct Doc {
pub owner: UserId,
pub data: Blob,
pub description: Option<String>,
pub created_at: Timestamp,
pub updated_at: Timestamp,
pub version: Option<Version>,
}
#[derive(CandidType, Serialize, Deserialize, Clone)]
pub struct DocContext<T> {
pub collection: CollectionKey,
pub key: Key,
pub data: T,
}
#[derive(CandidType, Serialize, Deserialize, Clone)]
pub struct DocUpsert {
pub before: Option<Doc>,
pub after: Doc,
}
#[derive(CandidType, Serialize, Deserialize, Clone)]
pub struct DocAssertSet {
pub current: Option<Doc>,
pub proposed: SetDoc,
}
#[derive(CandidType, Serialize, Deserialize, Clone)]
pub struct DocAssertDelete {
pub current: Option<Doc>,
pub proposed: DelDoc,
}
}
pub mod config {
use candid::{CandidType, Deserialize};
use junobuild_shared::types::config::ConfigMaxMemorySize;
use junobuild_shared::types::state::{Timestamp, Version};
use serde::Serialize;
pub type DbConfigMaxMemorySize = ConfigMaxMemorySize;
#[derive(Default, CandidType, Serialize, Deserialize, Clone)]
pub struct DbConfig {
pub max_memory_size: Option<DbConfigMaxMemorySize>,
pub version: Option<Version>,
pub created_at: Option<Timestamp>,
pub updated_at: Option<Timestamp>,
}
}
pub mod interface {
use crate::db::types::config::DbConfigMaxMemorySize;
use candid::CandidType;
use junobuild_shared::types::core::Blob;
use junobuild_shared::types::state::Version;
use serde::{Deserialize, Serialize};
/// Parameters for setting a document.
///
/// This struct, `SetDoc`, is used to specify the parameters for setting or updating a document in a collection's store.
/// It includes the following fields:
/// - `data`: A `Blob` containing the new data for the document.
/// - `description`: An optional `String` providing additional description for the document. This field is optional.
/// - `version`: An optional `u64` version representing the last version of the document to ensure
/// update consistency. This field is optional - i.e. first time a document is saved, it can be left empty but following updates require the current version to be passed.
///
/// `SetDoc` is used to provide parameters for setting or updating a document in the collection's store.
#[derive(Default, CandidType, Serialize, Deserialize, Clone)]
pub struct SetDoc {
pub data: Blob,
pub description: Option<String>,
pub version: Option<Version>,
}
/// Parameters for deleting a document.
///
/// This struct, `DelDoc`, is used to specify the parameters for deleting a document from a collection's store.
/// It includes the following field:
/// - `version`: An optional `u64` version representing the last version of the document to ensure
/// deletion consistency. This field is optional.
///
/// `DelDoc` is used to provide deletion parameters when removing a document.
#[derive(Default, CandidType, Serialize, Deserialize, Clone)]
pub struct DelDoc {
pub version: Option<Version>,
}
/// Parameters for setting the datastore configuration.
///
/// This struct includes the following fields:
/// - `max_memory_size`: An optional `DbConfigMaxMemorySize` representing the maximum memory size allowed for the datastore.
/// - `version`: An optional `Version` used for version control to ensure update consistency. If specified, it must match the current configuration version to apply the update.
///
/// `SetDbConfig` ensures that configuration updates are applied in a consistent and controlled manner.
#[derive(Default, CandidType, Serialize, Deserialize, Clone)]
pub struct SetDbConfig {
pub max_memory_size: Option<DbConfigMaxMemorySize>,
pub version: Option<Version>,
}
}
pub mod store {
pub struct AssertSetDocOptions {
pub with_assert_rate: bool,
}
}