agent-tui-usecases 1.1.0

Use cases and ports for agent-tui terminal automation
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

//! Session repository port.

use std::collections::HashMap;
use std::sync::Arc;
use std::time::Duration;

use crate::domain::RestartOutput;
use crate::domain::core::CursorPosition;
use crate::domain::session_types::SessionId;
use crate::domain::session_types::SessionInfo;
use crate::domain::session_types::TerminalSize;

use super::SessionError;

#[derive(Debug, Clone)]
pub struct LivePreviewSnapshot {
    pub cols: u16,
    pub rows: u16,
    pub seq: String,
    pub stream_seq: u64,
}

#[derive(Debug, Clone, Copy, Default)]
pub struct StreamCursor {
    pub seq: u64,
}

#[derive(Debug, Clone)]
pub struct StreamRead {
    pub data: Vec<u8>,
    pub next_cursor: StreamCursor,
    pub latest_cursor: StreamCursor,
    pub dropped_bytes: u64,
    pub closed: bool,
}

pub trait StreamWaiter: Send + Sync {
    fn wait(&self, timeout: Option<Duration>) -> bool;
}

pub type StreamWaiterHandle = Arc<dyn StreamWaiter>;

pub trait SessionOps: Send + Sync {
    fn update(&self) -> Result<(), SessionError>;
    fn screen_text(&self) -> String;
    fn screen_render(&self) -> String;
    fn screen_render_compact(&self) -> String;
    fn terminal_write(&self, data: &[u8]) -> Result<(), SessionError>;
    fn terminal_try_read(&self, buf: &mut [u8], timeout_ms: i32) -> Result<usize, SessionError>;
    fn stream_read(
        &self,
        cursor: &mut StreamCursor,
        max_bytes: usize,
        timeout_ms: i32,
    ) -> Result<StreamRead, SessionError>;
    fn stream_subscribe(&self) -> StreamWaiterHandle;
    fn keystroke(&self, key: &str) -> Result<(), SessionError>;
    fn type_text(&self, text: &str) -> Result<(), SessionError>;
    fn keydown(&self, key: &str) -> Result<(), SessionError>;
    fn keyup(&self, key: &str) -> Result<(), SessionError>;
    fn is_running(&self) -> bool;
    fn resize(&self, size: TerminalSize) -> Result<(), SessionError>;
    fn cursor(&self) -> CursorPosition;
    fn session_id(&self) -> SessionId;
    fn command(&self) -> String;
    fn size(&self) -> TerminalSize;
    fn live_preview_snapshot(&self) -> LivePreviewSnapshot;
}

pub type SessionHandle = Arc<dyn SessionOps>;

#[allow(clippy::too_many_arguments)]
pub trait SessionRepository: Send + Sync {
    fn spawn(
        &self,
        command: &str,
        args: &[String],
        cwd: Option<&str>,
        env: Option<&HashMap<String, String>>,
        session_id: Option<SessionId>,
        size: TerminalSize,
    ) -> Result<(SessionId, u32), SessionError>;

    fn get(&self, session_id: &SessionId) -> Result<SessionHandle, SessionError>;
    fn active(&self) -> Result<SessionHandle, SessionError>;
    fn resolve(&self, session_id: Option<&SessionId>) -> Result<SessionHandle, SessionError>;
    fn set_active(&self, session_id: &SessionId) -> Result<(), SessionError>;
    fn list(&self) -> Vec<SessionInfo>;
    fn kill(&self, session_id: &SessionId) -> Result<(), SessionError>;
    fn restart(&self, session_id: Option<&SessionId>) -> Result<RestartOutput, SessionError>;
    fn session_count(&self) -> usize;
    fn active_session_id(&self) -> Option<SessionId>;
}