1use chrono::{DateTime, Utc};
4pub use kival_types::ObjectListOrder;
5use kival_types::{MembershipRole, ObjectRole};
6use schemars::JsonSchema;
7use serde::{Deserialize, Deserializer, Serialize, de};
8use serde_json::Value;
9use uuid::Uuid;
10
11use crate::{ArchiveListStatus, ArchiveStatus, ListParams};
12
13#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
15pub struct ObjectListParams {
16 pub limit: Option<i64>,
18
19 pub cursor: Option<String>,
21
22 #[serde(default)]
24 pub status: ArchiveListStatus,
25
26 #[serde(default)]
28 pub order: ObjectListOrder,
29
30 pub favorited: Option<bool>,
32
33 pub pinned: Option<bool>,
35}
36
37impl Default for ObjectListParams {
38 fn default() -> Self {
39 Self {
40 limit: None,
41 cursor: None,
42 status: ArchiveListStatus::Active,
43 order: ObjectListOrder::Created,
44 favorited: None,
45 pinned: None,
46 }
47 }
48}
49
50impl ObjectListParams {
51 #[must_use]
53 pub fn limit(&self) -> i64 {
54 ListParams { limit: self.limit, cursor: self.cursor.clone() }.limit()
55 }
56}
57
58#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
60#[serde(deny_unknown_fields)]
61pub struct CreateObjectRequest {
62 pub title: String,
64
65 #[serde(default)]
67 pub body: String,
68
69 #[serde(default = "empty_object")]
71 #[schemars(with = "std::collections::BTreeMap<String, Value>")]
72 pub metadata: Value,
73}
74
75#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
77#[serde(deny_unknown_fields)]
78pub struct UpdateObjectRequest {
79 pub expected_current_version_id: Uuid,
83
84 #[serde(
86 default,
87 skip_serializing_if = "Option::is_none",
88 deserialize_with = "deserialize_non_null_option"
89 )]
90 pub title: Option<String>,
91
92 #[serde(
94 default,
95 skip_serializing_if = "Option::is_none",
96 deserialize_with = "deserialize_non_null_option"
97 )]
98 pub body: Option<String>,
99
100 #[serde(
102 default,
103 skip_serializing_if = "Option::is_none",
104 deserialize_with = "deserialize_non_null_option"
105 )]
106 pub metadata: Option<Value>,
107}
108
109fn deserialize_non_null_option<'de, D, T>(deserializer: D) -> Result<Option<T>, D::Error>
114where
115 D: Deserializer<'de>,
116 T: Deserialize<'de>,
117{
118 Option::<T>::deserialize(deserializer)?
119 .map(Some)
120 .ok_or_else(|| de::Error::custom("null is not allowed; omit the field instead"))
121}
122
123#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
125pub struct ObjectResource {
126 pub id: Uuid,
128
129 pub workspace_id: Uuid,
131
132 pub current_version_id: Option<Uuid>,
134
135 pub title: String,
137
138 pub status: ArchiveStatus,
140
141 pub created_by: Option<Uuid>,
143
144 pub archived_by: Option<Uuid>,
146
147 pub created_at: DateTime<Utc>,
149
150 pub updated_at: DateTime<Utc>,
152
153 pub archived_at: Option<DateTime<Utc>>,
155}
156
157#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
159pub struct ObjectListItem {
160 #[serde(flatten)]
162 pub object: ObjectResource,
163
164 #[serde(skip_serializing_if = "Option::is_none")]
166 pub updated_by_username: Option<String>,
167
168 #[serde(skip_serializing_if = "Option::is_none")]
170 pub updated_by_display_name: Option<String>,
171
172 #[serde(skip_serializing_if = "Option::is_none")]
174 pub updated_by_workspace_role: Option<MembershipRole>,
175
176 #[serde(skip_serializing_if = "Option::is_none")]
178 pub updated_by_object_role: Option<ObjectRole>,
179
180 pub connection_count: i64,
182
183 pub unresolved_thread_count: i64,
185
186 pub favorited: bool,
188
189 pub pinned: bool,
191
192 pub pinned_at: Option<DateTime<Utc>>,
194}
195
196impl std::ops::Deref for ObjectListItem {
197 type Target = ObjectResource;
198
199 fn deref(&self) -> &Self::Target {
200 &self.object
201 }
202}
203
204#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
206pub struct ObjectVersion {
207 pub id: Uuid,
209
210 pub object_id: Uuid,
212
213 pub version_number: i64,
215
216 pub title: String,
218
219 pub body: String,
221
222 #[schemars(with = "std::collections::BTreeMap<String, Value>")]
224 pub metadata: Value,
225
226 pub created_by: Option<Uuid>,
228
229 #[serde(skip_serializing_if = "Option::is_none")]
231 pub created_by_username: Option<String>,
232
233 #[serde(skip_serializing_if = "Option::is_none")]
235 pub created_by_display_name: Option<String>,
236
237 #[serde(skip_serializing_if = "Option::is_none")]
239 pub created_by_workspace_role: Option<MembershipRole>,
240
241 #[serde(skip_serializing_if = "Option::is_none")]
243 pub created_by_object_role: Option<ObjectRole>,
244
245 pub created_at: DateTime<Utc>,
247}
248
249#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
251#[serde(deny_unknown_fields)]
252pub struct ReuseObjectAttachmentRequest {
253 pub source_attachment_id: Uuid,
255
256 pub version_id: Option<Uuid>,
258}
259
260#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
262pub struct UploadObjectAttachmentParams {
263 pub version_id: Option<Uuid>,
265
266 pub name: Option<String>,
268
269 pub media_type: Option<String>,
271
272 pub metadata: Option<String>,
274}
275
276#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
278pub struct ObjectAttachment {
279 pub id: Uuid,
281
282 pub workspace_id: Uuid,
284
285 pub object_id: Uuid,
287
288 #[serde(skip_serializing_if = "Option::is_none")]
290 pub version_id: Option<Uuid>,
291
292 pub content_ref: String,
294
295 pub size_bytes: u64,
297
298 #[serde(skip_serializing_if = "Option::is_none")]
302 pub source_attachment_id: Option<Uuid>,
303
304 #[serde(skip_serializing_if = "Option::is_none")]
306 pub name: Option<String>,
307
308 #[serde(skip_serializing_if = "Option::is_none")]
310 pub media_type: Option<String>,
311
312 #[schemars(with = "std::collections::BTreeMap<String, Value>")]
314 pub metadata: Value,
315
316 pub created_by: Option<Uuid>,
318
319 pub created_at: DateTime<Utc>,
321}
322
323#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
325pub struct ObjectAttachmentResponse {
326 pub attachment: ObjectAttachment,
328}
329
330#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
332pub struct ObjectResponse {
333 pub object: ObjectResource,
335
336 #[serde(skip_serializing_if = "Option::is_none")]
338 pub current_version: Option<ObjectVersion>,
339
340 pub effective_role: ObjectRole,
343}
344
345#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
347pub struct ObjectVersionResponse {
348 pub version: ObjectVersion,
350}
351
352#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
354pub struct ObjectVersionWikilink {
355 pub raw_target: String,
357
358 #[serde(skip_serializing_if = "Option::is_none")]
360 pub display_text: Option<String>,
361
362 #[serde(skip_serializing_if = "Option::is_none")]
364 pub target_object_id: Option<Uuid>,
365}
366
367#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
369pub struct ObjectVersionWikilinksResponse {
370 pub items: Vec<ObjectVersionWikilink>,
372}
373
374fn empty_object() -> Value {
376 Value::Object(serde_json::Map::new())
377}