corsa_client 0.1.0

Typed stdio API client bindings for typescript-go
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

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

use super::{DocumentIdentifier, ProjectHandle, SnapshotHandle};

/// Per-file snapshot delta grouped by operation kind.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct FileChangeSummary {
    /// Files whose contents changed but whose identity stayed the same.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub changed: Vec<DocumentIdentifier>,
    /// Newly created files that should enter the snapshot graph.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub created: Vec<DocumentIdentifier>,
    /// Deleted files that should be removed from the snapshot graph.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub deleted: Vec<DocumentIdentifier>,
}

/// Change payload accepted by `updateSnapshot`.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(untagged)]
pub enum FileChanges {
    /// Apply an incremental file-by-file delta.
    Summary(FileChangeSummary),
    #[serde(rename_all = "camelCase")]
    /// Discard all prior file state and force a full invalidation.
    InvalidateAll {
        /// When `true`, the server invalidates all tracked file state.
        invalidate_all: bool,
    },
}

/// Parameters passed to [`ApiClient::update_snapshot`](crate::ApiClient::update_snapshot).
///
/// # Examples
///
/// ```
/// use corsa_client::{DocumentIdentifier, FileChangeSummary, FileChanges, UpdateSnapshotParams};
///
/// let params = UpdateSnapshotParams {
///     open_project: Some("/workspace/tsconfig.json".into()),
///     file_changes: Some(FileChanges::Summary(FileChangeSummary {
///         changed: vec![DocumentIdentifier::from("/workspace/main.ts")],
///         created: Vec::new(),
///         deleted: Vec::new(),
///     })),
/// };
///
/// assert_eq!(params.open_project.as_deref(), Some("/workspace/tsconfig.json"));
/// ```
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct UpdateSnapshotParams {
    /// Preferred project to open eagerly, usually a `tsconfig` path.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub open_project: Option<String>,
    /// Incremental file invalidation payload, or `None` for a no-op refresh.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_changes: Option<FileChanges>,
}

/// Snapshot changes scoped to a single project.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ProjectFileChanges {
    /// Files inside the project that changed contents.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub changed_files: Vec<String>,
    /// Files inside the project that were removed.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub deleted_files: Vec<String>,
}

/// Project-level delta information returned by tsgo.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SnapshotChanges {
    /// Project-scoped change details keyed by project handle.
    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
    pub changed_projects: BTreeMap<ProjectHandle, ProjectFileChanges>,
    /// Projects removed from the snapshot as part of the update.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub removed_projects: Vec<ProjectHandle>,
}

/// Raw response returned by `updateSnapshot`.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct UpdateSnapshotResponse {
    /// Newly created or refreshed snapshot handle.
    pub snapshot: SnapshotHandle,
    /// Projects currently known inside the snapshot.
    pub projects: Vec<super::ProjectResponse>,
    /// Project-level delta information when the server computed it.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub changes: Option<SnapshotChanges>,
}