aves-kea 0.5.0

Specialized knowledge domain for the Aves async application runtime
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
158
159
160
161
162
163
164
165

//! Typed RPC, actor, and broadcast messages for the Knowledge domain.

use serde::{Deserialize, Serialize};
use tokio::sync::oneshot;

use aves::bus::BusRpcContext;
use aves::utils::uuid::SpectaUuid;

use super::KnowledgeDomain;
use super::types::{
    CanvasDashboard, CanvasDashboardDeleteResult, CanvasDashboardLookup, CanvasDashboardSummaryList,
    CreateCanvasDashboardRequest, CreateKnowledgeRequest, DataList, DataObject, DeleteCanvasDashboardRequest,
    DeleteKnowledgeRequest, DeleteKnowledgeResult, GetCanvasDashboardRequest, GetKnowledgeRequest, KnowledgeError,
    KnowledgeRecord, KnowledgeRecordList, KnowledgeSearchOutcome, ListCanvasDashboardsRequest, ListDataRequest,
    ListKnowledgeRequest, SearchKnowledgeRequest, UpdateCanvasDashboardRequest, UpdateKnowledgeRequest,
    UpsertDataRequest, VaultKnowledgeTree,
};

/// Knowledge domain request wrapper.
///
/// Wraps a payload with telemetry context and reply channel for
/// request/response patterns through the event bus.
pub struct KnowledgeRequest {
    /// The request payload.
    pub payload: KnowledgeRequestPayload,
    /// Reply channel for the response.
    pub reply_to: oneshot::Sender<Result<KnowledgeResponse, KnowledgeError>>,
}

/// Payload variants for knowledge requests.
#[aves::bus_requests(marker = KnowledgeDomain, context = BusRpcContext, root_error = KnowledgeError, domain_error = KnowledgeError)]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum KnowledgeRequestPayload {
    /// Create a Markdown note in the active directory.
    #[operation(name = "createKnowledge", kind = "mutation", response = KnowledgeCreatedOutput, response_variant = "KnowledgeCreated")]
    CreateKnowledge { request: CreateKnowledgeRequest },

    /// List the directory's lightweight navigation tree.
    #[operation(name = "listKnowledgeTree", kind = "query", response = KnowledgeTreeListedOutput, response_variant = "KnowledgeTreeListed")]
    ListKnowledgeTree,

    /// List knowledge with optional filters and query text.
    #[operation(name = "listKnowledge", kind = "query", response = KnowledgeListedOutput, response_variant = "KnowledgeListed")]
    ListKnowledge { request: ListKnowledgeRequest },

    /// Get a note by its relative path.
    #[operation(name = "getKnowledge", kind = "query", response = KnowledgeFoundOutput, response_variant = "KnowledgeFound")]
    GetKnowledge { request: GetKnowledgeRequest },

    /// Update an existing directory note.
    #[operation(name = "updateKnowledge", kind = "mutation", response = KnowledgeUpdatedOutput, response_variant = "KnowledgeUpdated")]
    UpdateKnowledge { request: UpdateKnowledgeRequest },

    /// Delete a note by its relative path.
    #[operation(name = "deleteKnowledge", kind = "mutation", response = KnowledgeDeletedOutput, response_variant = "KnowledgeDeleted")]
    DeleteKnowledge { request: DeleteKnowledgeRequest },

    /// Search directory notes with TurboVault.
    #[operation(name = "searchKnowledge", kind = "query", response = KnowledgeSearchedOutput, response_variant = "KnowledgeSearched")]
    SearchKnowledge { request: SearchKnowledgeRequest },

    /// Replace the JSON object at an exact, case-sensitive key or create it.
    #[operation(name = "upsertData", kind = "mutation", response = DataUpsertedOutput, response_variant = "DataUpserted")]
    UpsertData { request: UpsertDataRequest },

    /// List keys by last-write date with pagination.
    #[operation(name = "listData", kind = "query", response = DataListedOutput, response_variant = "DataListed")]
    ListData { request: ListDataRequest },

    /// Read the JSON object at an exact key.
    #[operation(name = "getData", kind = "query", response = DataFoundOutput, response_variant = "DataFound")]
    GetData { key: String },

    /// Delete an existing JSON object by exact key.
    #[operation(name = "deleteData", kind = "mutation", response = DataDeletedOutput, response_variant = "DataDeleted")]
    DeleteData { key: String },

    /// Create a file-backed Canvas dashboard.
    #[operation(name = "createCanvasDashboard", kind = "mutation", response = CanvasDashboardCreatedOutput, response_variant = "CanvasDashboardCreated")]
    CreateCanvasDashboard { request: CreateCanvasDashboardRequest },

    /// Get a file-backed Canvas dashboard by id.
    #[operation(name = "getCanvasDashboard", kind = "query", response = CanvasDashboardFoundOutput, response_variant = "CanvasDashboardFound")]
    GetCanvasDashboard { request: GetCanvasDashboardRequest },

    /// Replace a file-backed Canvas dashboard.
    #[operation(name = "updateCanvasDashboard", kind = "mutation", response = CanvasDashboardUpdatedOutput, response_variant = "CanvasDashboardUpdated")]
    UpdateCanvasDashboard { request: UpdateCanvasDashboardRequest },

    /// Delete a file-backed Canvas dashboard by id.
    #[operation(name = "deleteCanvasDashboard", kind = "mutation", response = CanvasDashboardDeletedOutput, response_variant = "CanvasDashboardDeleted")]
    DeleteCanvasDashboard { request: DeleteCanvasDashboardRequest },

    /// List file-backed Canvas dashboard summaries.
    #[operation(name = "listCanvasDashboards", kind = "query", response = CanvasDashboardListedOutput, response_variant = "CanvasDashboardListed")]
    ListCanvasDashboards { request: ListCanvasDashboardsRequest },

    /// Reopens the active directory after a Knowledge root change.
    #[serde(skip)]
    KnowledgeConfigChanged,

    /// Runs maintenance on the already-open Knowledge Data database during shutdown.
    #[serde(skip)]
    StopRuntime,
}

/// Response types for knowledge operations.
#[aves::bus_responses]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum KnowledgeResponse {
    /// Internal signal that the directory's visible records changed.
    #[serde(skip)]
    KnowledgeRecordsChanged,
    /// Internal acknowledgement for Knowledge database maintenance.
    #[serde(skip)]
    RuntimeStopped,
    /// Created knowledge.
    KnowledgeCreated { knowledge: KnowledgeRecord },
    /// Retrieved knowledge, if present.
    KnowledgeFound { knowledge: KnowledgeRecord },
    /// Updated knowledge.
    KnowledgeUpdated { knowledge: KnowledgeRecord },
    /// Hard-delete result.
    KnowledgeDeleted { result: DeleteKnowledgeResult },
    /// Listed knowledge.
    KnowledgeListed(KnowledgeRecordList),
    /// Listed lightweight navigation tree entries.
    KnowledgeTreeListed { entries: VaultKnowledgeTree },
    /// Vault search response.
    KnowledgeSearched(KnowledgeSearchOutcome),
    /// Stored JSON object after a successful replacement.
    DataUpserted { data: DataObject },
    /// Stored JSON object for an exact key.
    DataFound { data: DataObject },
    /// Page of JSON object keys and write timestamps.
    DataListed { data: DataList },
    /// Confirmed deletion of an existing key.
    DataDeleted { key: String },
    /// Created Canvas dashboard.
    CanvasDashboardCreated { dashboard: CanvasDashboard },
    /// Retrieved Canvas dashboard, if present.
    CanvasDashboardFound { dashboard: CanvasDashboardLookup },
    /// Updated Canvas dashboard.
    CanvasDashboardUpdated { dashboard: CanvasDashboard },
    /// Canvas dashboard deletion result.
    CanvasDashboardDeleted {
        id: SpectaUuid,
        result: CanvasDashboardDeleteResult,
    },
    /// Listed Canvas dashboard summaries.
    CanvasDashboardListed { dashboards: CanvasDashboardSummaryList },
}

/// Events broadcast by the knowledge domain.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum KnowledgeBroadcast {
    /// The visible Knowledge record set changed and clients should refresh it.
    RecordsChanged,
    /// A Canvas dashboard was created.
    CanvasDashboardCreated { dashboard_id: SpectaUuid },
    /// A Canvas dashboard was updated.
    CanvasDashboardUpdated { dashboard_id: SpectaUuid },
    /// A Canvas dashboard was deleted.
    CanvasDashboardDeleted { dashboard_id: SpectaUuid },
}