turboclaude-protocol 0.3.0

Shared protocol types and definitions for TurboClaude REST and Agent SDKs
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
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
//! Permission update types and definitions
//!
//! Provides types for dynamic permission changes during agent sessions.
//! Matches the Python SDK implementation (types.py:56-108).

use serde::{Deserialize, Serialize};

/// Permission behavior for rule-based updates
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum PermissionBehavior {
    /// Allow the action
    Allow,

    /// Deny the action
    Deny,

    /// Ask for permission
    Ask,
}

/// Destination for permission updates
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub enum PermissionUpdateDestination {
    /// Update user settings
    UserSettings,

    /// Update project settings
    ProjectSettings,

    /// Update local settings
    LocalSettings,

    /// Update session only (non-persistent)
    Session,
}

/// Permission rule value
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct PermissionRuleValue {
    /// Tool name for the rule
    #[serde(rename = "toolName")]
    pub tool_name: String,

    /// Optional rule content (regex pattern or other constraint)
    #[serde(rename = "ruleContent", skip_serializing_if = "Option::is_none")]
    pub rule_content: Option<String>,
}

impl PermissionRuleValue {
    /// Create a new permission rule
    pub fn new(tool_name: impl Into<String>) -> Self {
        Self {
            tool_name: tool_name.into(),
            rule_content: None,
        }
    }

    /// Set the rule content
    pub fn with_rule_content(mut self, content: impl Into<String>) -> Self {
        self.rule_content = Some(content.into());
        self
    }
}

/// Add rules update
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct AddRulesUpdate {
    /// Rules to add
    pub rules: Vec<PermissionRuleValue>,

    /// Behavior for the rules
    pub behavior: PermissionBehavior,

    /// Optional destination
    #[serde(skip_serializing_if = "Option::is_none")]
    pub destination: Option<PermissionUpdateDestination>,
}

/// Replace rules update
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct ReplaceRulesUpdate {
    /// Rules to replace with
    pub rules: Vec<PermissionRuleValue>,

    /// Behavior for the rules
    pub behavior: PermissionBehavior,

    /// Optional destination
    #[serde(skip_serializing_if = "Option::is_none")]
    pub destination: Option<PermissionUpdateDestination>,
}

/// Remove rules update
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct RemoveRulesUpdate {
    /// Rules to remove
    pub rules: Vec<PermissionRuleValue>,

    /// Optional destination
    #[serde(skip_serializing_if = "Option::is_none")]
    pub destination: Option<PermissionUpdateDestination>,
}

/// Set mode update
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct SetModeUpdate {
    /// Permission mode to set
    pub mode: crate::types::PermissionMode,

    /// Optional destination
    #[serde(skip_serializing_if = "Option::is_none")]
    pub destination: Option<PermissionUpdateDestination>,
}

/// Add directories update
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct AddDirectoriesUpdate {
    /// Directories to add
    pub directories: Vec<String>,

    /// Optional destination
    #[serde(skip_serializing_if = "Option::is_none")]
    pub destination: Option<PermissionUpdateDestination>,
}

/// Remove directories update
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct RemoveDirectoriesUpdate {
    /// Directories to remove
    pub directories: Vec<String>,

    /// Optional destination
    #[serde(skip_serializing_if = "Option::is_none")]
    pub destination: Option<PermissionUpdateDestination>,
}

/// Permission update type
///
/// Represents dynamic permission changes during an agent session.
/// Matches Python SDK implementation (types.py:56-108).
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(tag = "type", rename_all = "camelCase")]
pub enum PermissionUpdate {
    /// Add permission rules
    AddRules(AddRulesUpdate),

    /// Replace permission rules
    ReplaceRules(ReplaceRulesUpdate),

    /// Remove permission rules
    RemoveRules(RemoveRulesUpdate),

    /// Set permission mode
    SetMode(SetModeUpdate),

    /// Add allowed directories
    AddDirectories(AddDirectoriesUpdate),

    /// Remove allowed directories
    RemoveDirectories(RemoveDirectoriesUpdate),
}

impl PermissionUpdate {
    /// Create an add rules update
    pub fn add_rules(rules: Vec<PermissionRuleValue>, behavior: PermissionBehavior) -> Self {
        Self::AddRules(AddRulesUpdate {
            rules,
            behavior,
            destination: None,
        })
    }

    /// Create a replace rules update
    pub fn replace_rules(rules: Vec<PermissionRuleValue>, behavior: PermissionBehavior) -> Self {
        Self::ReplaceRules(ReplaceRulesUpdate {
            rules,
            behavior,
            destination: None,
        })
    }

    /// Create a remove rules update
    pub fn remove_rules(rules: Vec<PermissionRuleValue>) -> Self {
        Self::RemoveRules(RemoveRulesUpdate {
            rules,
            destination: None,
        })
    }

    /// Create a set mode update
    pub fn set_mode(mode: crate::types::PermissionMode) -> Self {
        Self::SetMode(SetModeUpdate {
            mode,
            destination: None,
        })
    }

    /// Create an add directories update
    pub fn add_directories(directories: Vec<String>) -> Self {
        Self::AddDirectories(AddDirectoriesUpdate {
            directories,
            destination: None,
        })
    }

    /// Create a remove directories update
    pub fn remove_directories(directories: Vec<String>) -> Self {
        Self::RemoveDirectories(RemoveDirectoriesUpdate {
            directories,
            destination: None,
        })
    }

    /// Set the destination for this update
    pub fn with_destination(mut self, destination: PermissionUpdateDestination) -> Self {
        match &mut self {
            Self::AddRules(u) => u.destination = Some(destination),
            Self::ReplaceRules(u) => u.destination = Some(destination),
            Self::RemoveRules(u) => u.destination = Some(destination),
            Self::SetMode(u) => u.destination = Some(destination),
            Self::AddDirectories(u) => u.destination = Some(destination),
            Self::RemoveDirectories(u) => u.destination = Some(destination),
        }
        self
    }

    /// Get the destination for this update
    pub fn destination(&self) -> Option<PermissionUpdateDestination> {
        match self {
            Self::AddRules(u) => u.destination,
            Self::ReplaceRules(u) => u.destination,
            Self::RemoveRules(u) => u.destination,
            Self::SetMode(u) => u.destination,
            Self::AddDirectories(u) => u.destination,
            Self::RemoveDirectories(u) => u.destination,
        }
    }

    /// Validate the update
    ///
    /// Returns `Ok(())` if the update is valid, or an error message if not.
    pub fn validate(&self) -> Result<(), String> {
        match self {
            Self::AddRules(u) => {
                if u.rules.is_empty() {
                    return Err("AddRules update must have at least one rule".to_string());
                }
                for rule in &u.rules {
                    if rule.tool_name.is_empty() {
                        return Err("Rule tool_name cannot be empty".to_string());
                    }
                }
                Ok(())
            }
            Self::ReplaceRules(u) => {
                if u.rules.is_empty() {
                    return Err("ReplaceRules update must have at least one rule".to_string());
                }
                for rule in &u.rules {
                    if rule.tool_name.is_empty() {
                        return Err("Rule tool_name cannot be empty".to_string());
                    }
                }
                Ok(())
            }
            Self::RemoveRules(u) => {
                if u.rules.is_empty() {
                    return Err("RemoveRules update must have at least one rule".to_string());
                }
                for rule in &u.rules {
                    if rule.tool_name.is_empty() {
                        return Err("Rule tool_name cannot be empty".to_string());
                    }
                }
                Ok(())
            }
            Self::SetMode(_) => Ok(()),
            Self::AddDirectories(u) => {
                if u.directories.is_empty() {
                    return Err(
                        "AddDirectories update must have at least one directory".to_string()
                    );
                }
                for dir in &u.directories {
                    if dir.is_empty() {
                        return Err("Directory path cannot be empty".to_string());
                    }
                }
                Ok(())
            }
            Self::RemoveDirectories(u) => {
                if u.directories.is_empty() {
                    return Err(
                        "RemoveDirectories update must have at least one directory".to_string()
                    );
                }
                for dir in &u.directories {
                    if dir.is_empty() {
                        return Err("Directory path cannot be empty".to_string());
                    }
                }
                Ok(())
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::types::PermissionMode;

    #[test]
    fn test_permission_rule_value() {
        let rule = PermissionRuleValue::new("bash").with_rule_content(".*");

        assert_eq!(rule.tool_name, "bash");
        assert_eq!(rule.rule_content, Some(".*".to_string()));
    }

    #[test]
    fn test_add_rules_update() {
        let rules = vec![
            PermissionRuleValue::new("bash"),
            PermissionRuleValue::new("file_editor"),
        ];

        let update = PermissionUpdate::add_rules(rules, PermissionBehavior::Allow)
            .with_destination(PermissionUpdateDestination::Session);

        assert!(matches!(update, PermissionUpdate::AddRules(_)));
        assert_eq!(
            update.destination(),
            Some(PermissionUpdateDestination::Session)
        );
        assert!(update.validate().is_ok());
    }

    #[test]
    fn test_set_mode_update() {
        let update = PermissionUpdate::set_mode(PermissionMode::BypassPermissions)
            .with_destination(PermissionUpdateDestination::ProjectSettings);

        assert!(matches!(update, PermissionUpdate::SetMode(_)));
        assert!(update.validate().is_ok());
    }

    #[test]
    fn test_add_directories_update() {
        let dirs = vec!["/home/user/project".to_string()];
        let update = PermissionUpdate::add_directories(dirs);

        assert!(matches!(update, PermissionUpdate::AddDirectories(_)));
        assert!(update.validate().is_ok());
    }

    #[test]
    fn test_validation_empty_rules() {
        let update = PermissionUpdate::add_rules(vec![], PermissionBehavior::Allow);
        assert!(update.validate().is_err());
    }

    #[test]
    fn test_validation_empty_directories() {
        let update = PermissionUpdate::add_directories(vec![]);
        assert!(update.validate().is_err());
    }

    #[test]
    fn test_validation_empty_tool_name() {
        let rules = vec![PermissionRuleValue::new("")];
        let update = PermissionUpdate::add_rules(rules, PermissionBehavior::Allow);
        assert!(update.validate().is_err());
    }

    #[test]
    fn test_serialization_add_rules() {
        let rules = vec![PermissionRuleValue::new("bash")];
        let update = PermissionUpdate::add_rules(rules, PermissionBehavior::Allow);

        let json = serde_json::to_string(&update).unwrap();
        assert!(json.contains("addRules"));
        assert!(json.contains("bash"));

        let deserialized: PermissionUpdate = serde_json::from_str(&json).unwrap();
        assert_eq!(update, deserialized);
    }

    #[test]
    fn test_serialization_set_mode() {
        let update = PermissionUpdate::set_mode(PermissionMode::AcceptEdits);

        let json = serde_json::to_string(&update).unwrap();
        assert!(json.contains("setMode"));

        let deserialized: PermissionUpdate = serde_json::from_str(&json).unwrap();
        assert_eq!(update, deserialized);
    }

    #[test]
    fn test_serialization_with_destination() {
        let rules = vec![PermissionRuleValue::new("bash")];
        let update = PermissionUpdate::add_rules(rules, PermissionBehavior::Allow)
            .with_destination(PermissionUpdateDestination::Session);

        let json = serde_json::to_string(&update).unwrap();
        assert!(json.contains("destination"));
        assert!(json.contains("session"));

        let deserialized: PermissionUpdate = serde_json::from_str(&json).unwrap();
        assert_eq!(update, deserialized);
    }
}