nodedb-types 0.4.0

Portable type definitions shared between NodeDB Origin and NodeDB-Lite
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

// SPDX-License-Identifier: Apache-2.0

//! FTS index/delete sync messages (client → server / server → client).
//!
//! `FtsIndexMsg` carries one document's text content from a Lite client to
//! Origin for full-text indexing. `FtsDeleteMsg` removes a document from
//! Origin's inverted index.
//!
//! Wire opcodes:
//! - `0xA6` — `FtsIndex`    (Lite → Origin)
//! - `0xA7` — `FtsIndexAck` (Origin → Lite)
//! - `0xA8` — `FtsDelete`   (Lite → Origin)
//! - `0xA9` — `FtsDeleteAck` (Origin → Lite)

use serde::{Deserialize, Serialize};

use crate::sync::wire::ack_status::AckStatus;

/// FTS index request (Lite → Origin, 0xA6).
///
/// Requests that Origin index the concatenated text of a document into its
/// inverted BM25 index. Origin allocates a surrogate for `(collection, doc_id)`
/// and calls `InvertedIndex::index_document` on the Data Plane.
#[derive(
    Debug, Clone, Serialize, Deserialize, zerompk::ToMessagePack, zerompk::FromMessagePack,
)]
pub struct FtsIndexMsg {
    /// Lite instance ID (for routing and dedup).
    pub lite_id: String,
    /// Target collection name.
    pub collection: String,
    /// External document identifier.
    pub doc_id: String,
    /// Concatenated text to index (all string fields joined by space).
    pub text: String,
    /// Monotonic batch ID (Lite-assigned, per-document). Used for ACK correlation.
    pub batch_id: u64,
    /// Stable identity of the originating producer. 0 for legacy clients.
    #[serde(default)]
    pub producer_id: u64,
    /// Monotonic epoch counter incremented on every producer restart.
    #[serde(default)]
    pub epoch: u64,
    /// Per-stream monotonic sequence number within the epoch.
    #[serde(default)]
    pub seq: u64,
}

/// FTS index acknowledgment (Origin → Lite, 0xA7).
#[derive(
    Debug, Clone, Serialize, Deserialize, zerompk::ToMessagePack, zerompk::FromMessagePack,
)]
pub struct FtsIndexAckMsg {
    /// Collection acknowledged.
    pub collection: String,
    /// Document ID from the originating `FtsIndexMsg`.
    pub doc_id: String,
    /// Batch ID from the originating `FtsIndexMsg`.
    pub batch_id: u64,
    /// `true` if the document was successfully indexed on Origin.
    pub accepted: bool,
    /// Rejection detail when `accepted == false`.
    #[serde(default)]
    pub reject_reason: Option<String>,
    /// Highest sequence number from this producer that has been durably applied.
    #[serde(default)]
    pub applied_seq: u64,
    /// Idempotency outcome of the acknowledged message.
    #[serde(default)]
    pub status: AckStatus,
}

/// FTS delete request (Lite → Origin, 0xA8).
///
/// Removes the document identified by `doc_id` from Origin's inverted index.
#[derive(
    Debug, Clone, Serialize, Deserialize, zerompk::ToMessagePack, zerompk::FromMessagePack,
)]
pub struct FtsDeleteMsg {
    /// Lite instance ID.
    pub lite_id: String,
    /// Target collection name.
    pub collection: String,
    /// External document identifier to remove.
    pub doc_id: String,
    /// Monotonic batch ID for ACK correlation.
    pub batch_id: u64,
    /// Stable identity of the originating producer. 0 for legacy clients.
    #[serde(default)]
    pub producer_id: u64,
    /// Monotonic epoch counter incremented on every producer restart.
    #[serde(default)]
    pub epoch: u64,
    /// Per-stream monotonic sequence number within the epoch.
    #[serde(default)]
    pub seq: u64,
}

/// FTS delete acknowledgment (Origin → Lite, 0xA9).
#[derive(
    Debug, Clone, Serialize, Deserialize, zerompk::ToMessagePack, zerompk::FromMessagePack,
)]
pub struct FtsDeleteAckMsg {
    /// Collection acknowledged.
    pub collection: String,
    /// Document ID from the originating `FtsDeleteMsg`.
    pub doc_id: String,
    /// Batch ID from the originating `FtsDeleteMsg`.
    pub batch_id: u64,
    /// `true` if the document was successfully removed from Origin's index.
    pub accepted: bool,
    /// Rejection detail when `accepted == false`.
    #[serde(default)]
    pub reject_reason: Option<String>,
    /// Highest sequence number from this producer that has been durably applied.
    #[serde(default)]
    pub applied_seq: u64,
    /// Idempotency outcome of the acknowledged message.
    #[serde(default)]
    pub status: AckStatus,
}