papers-zotero 0.3.1

Rust client for the Zotero personal research library API
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

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

use super::common::*;

/// A Zotero saved search.
///
/// Saved searches store a set of conditions that can be used to dynamically
/// find items matching specific criteria.
///
/// # Example
///
/// ```json
/// {
///     "key": "ABCD1234",
///     "version": 100,
///     "library": { "type": "user", "id": 16916553, "name": "mattmg", "links": {} },
///     "links": { "self": { "href": "..." } },
///     "data": {
///         "key": "ABCD1234",
///         "version": 100,
///         "name": "Recent ML papers",
///         "conditions": [
///             { "condition": "tag", "operator": "is", "value": "ML" },
///             { "condition": "dateAdded", "operator": "isAfter", "value": "2024-01-01" }
///         ]
///     }
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SavedSearch {
    pub key: String,
    pub version: u64,
    pub library: Library,
    #[serde(default)]
    pub links: HashMap<String, LinkEntry>,
    pub data: SearchData,
}

/// Saved search data payload.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SearchData {
    pub key: String,
    pub version: u64,
    pub name: String,
    #[serde(default)]
    pub conditions: Vec<SearchCondition>,
}

/// A single condition in a saved search.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SearchCondition {
    pub condition: String,
    pub operator: String,
    pub value: String,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_deserialize_search() {
        let json = r#"{
            "key": "ABCD1234",
            "version": 100,
            "library": { "type": "user", "id": 1, "name": "test", "links": {} },
            "links": {},
            "data": {
                "key": "ABCD1234",
                "version": 100,
                "name": "Test Search",
                "conditions": [
                    { "condition": "tag", "operator": "is", "value": "ML" }
                ]
            }
        }"#;
        let search: SavedSearch = serde_json::from_str(json).unwrap();
        assert_eq!(search.key, "ABCD1234");
        assert_eq!(search.data.name, "Test Search");
        assert_eq!(search.data.conditions.len(), 1);
        assert_eq!(search.data.conditions[0].condition, "tag");
    }
}