quelch 0.5.0

Ingest data from Jira, Confluence, and more directly into Azure AI Search
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

pub mod confluence;
pub mod jira;

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

/// Cursor for tracking incremental sync position.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SyncCursor {
    /// Timestamp of the last synced document's update time.
    pub last_updated: DateTime<Utc>,
}

/// A document fetched from a source, ready for transformation and indexing.
#[derive(Debug, Clone)]
pub struct SourceDocument {
    /// Unique document ID (e.g., "test-jira-DO-1234").
    pub id: String,
    /// The content fields to index.
    pub fields: HashMap<String, serde_json::Value>,
    /// Timestamp of last modification in source.
    pub updated_at: DateTime<Utc>,
}

/// Result of a fetch operation — documents plus a new cursor position.
pub struct FetchResult {
    pub documents: Vec<SourceDocument>,
    pub cursor: SyncCursor,
    /// True if there are more pages to fetch.
    pub has_more: bool,
}

/// Trait implemented by each source connector (Jira, Confluence, etc.).
#[trait_variant::make(Send)]
pub trait SourceConnector: Sync {
    /// Human-readable source type name.
    fn source_type(&self) -> &str;

    /// The source name from config (used as identifier in state).
    fn source_name(&self) -> &str;

    /// The target Azure AI Search index name.
    fn index_name(&self) -> &str;

    /// Subsource identifiers — Jira project keys or Confluence space keys.
    fn subsources(&self) -> &[String];

    /// Fetch documents for a specific subsource since `cursor`.
    /// If cursor is None, fetch everything (initial full sync).
    async fn fetch_changes(
        &self,
        subsource: &str,
        cursor: Option<&SyncCursor>,
        batch_size: usize,
    ) -> anyhow::Result<FetchResult>;

    /// Fetch all document IDs currently in the source for a specific subsource.
    /// Used for detecting deletions.
    async fn fetch_all_ids(&self, subsource: &str) -> anyhow::Result<Vec<String>>;
}