aven-core 0.1.28

Core library for the Aven local-first task manager
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

use anyhow::Result;
use serde_json::Value;
use sqlx::SqliteConnection;

use crate::db::insert_change;
use crate::workspaces::Workspace;

pub mod op_type {
    pub const CREATE_TASK: &str = "create_task";
    pub const SET_FIELD: &str = "set_field";
    pub const RESOLVE_FIELD: &str = "resolve_field";
    pub const LABEL_ADD: &str = "label_add";
    pub const LABEL_REMOVE: &str = "label_remove";
    pub const NOTE_ADD: &str = "note_add";
    pub const NOTE_EDIT: &str = "note_edit";
    pub const NOTE_DELETE: &str = "note_delete";
    pub const DEPENDENCY_ADD: &str = "dependency_add";
    pub const DEPENDENCY_REMOVE: &str = "dependency_remove";
    pub const RELATED_ADD: &str = "related_add";
    pub const RELATED_REMOVE: &str = "related_remove";
    pub const EPIC_LINK_ADD: &str = "epic_link_add";
    pub const EPIC_LINK_REMOVE: &str = "epic_link_remove";
    pub const ATTACHMENT_ADD: &str = "attachment_add";
    pub const ATTACHMENT_DELETE: &str = "attachment_delete";
    pub const CREATE_PROJECT: &str = "create_project";
    pub const SET_PROJECT_METADATA: &str = "set_project_metadata";
    pub const PROJECT_DELETE: &str = "project_delete";
    pub const CREATE_LABEL: &str = "create_label";
    pub const SET_LABEL_NAME: &str = "set_label_name";
    pub const LABEL_DELETE: &str = "label_delete";
    pub const LABEL_RESTORE: &str = "label_restore";
    pub const CREATE_WORKSPACE: &str = "create_workspace";
    pub const SET_WORKSPACE_FIELD: &str = "set_workspace_field";
    pub const CREATE_RECURRENCE_SERIES: &str = "create_recurrence_series";
    pub const UPDATE_RECURRENCE_TEMPLATE: &str = "update_recurrence_template";
    pub const PROJECT_RECURRENCE_OCCURRENCE: &str = "project_recurrence_occurrence";
    pub const RESOLVE_RECURRENCE_OCCURRENCE: &str = "resolve_recurrence_occurrence";
    pub const SET_RECURRENCE_STATE: &str = "set_recurrence_state";
    pub const CREATE_METADATA_FIELD: &str = "create_metadata_field";
    pub const SET_METADATA_FIELD: &str = "set_metadata_field";
    pub const SET_TASK_METADATA: &str = "set_task_metadata";
    pub const REMOVE_TASK_METADATA: &str = "remove_task_metadata";
    pub const SET_RECURRENCE_METADATA: &str = "set_recurrence_metadata";
    pub const REMOVE_RECURRENCE_METADATA: &str = "remove_recurrence_metadata";
    pub const OPEN_RECURRENCE_PAUSE: &str = "open_recurrence_pause";
    pub const CLOSE_RECURRENCE_PAUSE: &str = "close_recurrence_pause";
    pub const STOP_RECURRENCE_SERIES: &str = "stop_recurrence_series";
}

pub enum ChangeEntity {
    Task,
    Project,
    Label,
    MetadataField,
    #[allow(dead_code)]
    Workspace,
    RecurrenceSeries,
}

impl ChangeEntity {
    pub const fn as_str(&self) -> &'static str {
        match self {
            Self::Task => "task",
            Self::Project => "project",
            Self::Label => "label",
            Self::MetadataField => "metadata_field",
            Self::Workspace => "workspace",
            Self::RecurrenceSeries => "recurrence_series",
        }
    }
}

/// Builder for change payload JSON produced by operations.
///
/// Use `.workspace(&workspace)` to seed workspace_id and workspace_key,
/// then chain `.set(key, value)` for each payload field.
///
/// Example:
/// ```ignore
/// ChangePayload::workspace(&workspace)
///     .set("title", draft.title)
///     .set("project_id", project.id)
///     .into_value()
/// ```
pub struct ChangePayload {
    map: serde_json::Map<String, serde_json::Value>,
}

impl ChangePayload {
    pub fn workspace(workspace: &Workspace) -> Self {
        let mut map = serde_json::Map::new();
        map.insert(
            "workspace_id".to_string(),
            Value::String(workspace.id.to_string()),
        );
        map.insert(
            "workspace_key".to_string(),
            Value::String(workspace.key.clone()),
        );
        Self { map }
    }

    pub fn set(mut self, key: &str, value: impl serde::Serialize) -> Self {
        self.map.insert(
            key.to_string(),
            serde_json::to_value(value).expect("change payload value serialization"),
        );
        self
    }

    pub fn into_value(self) -> Value {
        Value::Object(self.map)
    }
}

/// Insert a change-log row using a `ChangeEntity` and pre-built `ChangePayload`.
///
/// This wrapper always passes `None` for `base_version`. Task field-level
/// operations that need version tracking for conflict detection use
/// `insert_change` directly through `mutation.rs`.
pub(crate) async fn append_change(
    conn: &mut SqliteConnection,
    entity: ChangeEntity,
    entity_id: &str,
    field: Option<&str>,
    op_type: &'static str,
    payload: ChangePayload,
) -> Result<String> {
    insert_change(
        conn,
        entity.as_str(),
        entity_id,
        field,
        op_type,
        payload.into_value(),
        None,
    )
    .await
}