browsr-types 0.4.0

Shared data models and schemas for Browsr browser automation flows.
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

use crate::Commands;
use async_trait::async_trait;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ListSequencesQuery {
    pub limit: Option<usize>,
    pub offset: Option<usize>,
    pub favourites_only: Option<bool>,
    pub search: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ListSequencesResult {
    pub sequences: Vec<BrowserSequence>,
    pub total: usize,
}

#[async_trait]
pub trait BrowserSequenceStore: Send + Sync + std::fmt::Debug {
    async fn create_sequence(&self, seq: NewBrowserSequence) -> anyhow::Result<BrowserSequence>;
    async fn append_step(&self, step: NewBrowserStep) -> anyhow::Result<BrowserStep>;
    async fn add_observation(
        &self,
        obs: NewBrowserObservation,
    ) -> anyhow::Result<BrowserObservation>;
    async fn add_screenshot(&self, shot: NewBrowserScreenshot)
    -> anyhow::Result<BrowserScreenshot>;
    async fn list_steps(
        &self,
        sequence_id: &str,
        limit: Option<usize>,
    ) -> anyhow::Result<Vec<BrowserStep>>;
    async fn list_observations(
        &self,
        sequence_id: &str,
        limit: Option<usize>,
    ) -> anyhow::Result<Vec<BrowserObservation>>;
    async fn list_sequences(
        &self,
        query: ListSequencesQuery,
    ) -> anyhow::Result<ListSequencesResult>;
    async fn get_sequence(&self, id: &str) -> anyhow::Result<Option<BrowserSequence>>;
    async fn delete_sequence(&self, id: &str) -> anyhow::Result<()>;
    async fn set_favourite(&self, id: &str, favourite: bool) -> anyhow::Result<()>;
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct BrowserSequence {
    pub id: String,
    pub goal: Option<String>,
    pub task_id: Option<String>,
    pub thread_id: Option<String>,
    pub favourite: bool,
    pub created_at: chrono::DateTime<chrono::Utc>,
    pub updated_at: chrono::DateTime<chrono::Utc>,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct BrowserStep {
    pub id: String,
    pub browser_sequence_id: String,
    pub commands: Vec<Commands>,
    pub reason: Option<String>,
    pub thread_id: Option<String>,
    pub task_id: Option<String>,
    pub run_id: Option<String>,
    pub success: bool,
    pub thinking: Option<String>,
    pub evaluation_previous_goal: Option<String>,
    pub memory: Option<String>,
    pub next_goal: Option<String>,
    pub action_result: Option<serde_json::Value>,
    pub created_at: chrono::DateTime<chrono::Utc>,
    pub updated_at: chrono::DateTime<chrono::Utc>,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct BrowserObservationData {
    pub success: bool,
    pub state_text: Option<String>,
    pub dom_snapshot: Option<serde_json::Value>,
    pub screenshot: Option<serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct BrowserObservation {
    pub id: i64,
    pub thread_id: String,
    pub task_id: String,
    pub run_id: String,
    pub sequence_id: String,
    pub observation: BrowserObservationData,
    pub created_at: chrono::DateTime<chrono::Utc>,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct BrowserScreenshot {
    pub id: i64,
    pub thread_id: String,
    pub task_id: String,
    pub run_id: String,
    pub sequence_id: String,
    pub screenshot: serde_json::Value,
    pub created_at: chrono::DateTime<chrono::Utc>,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct NewBrowserSequence {
    pub id: String,
    pub goal: Option<String>,
    pub task_id: Option<String>,
    pub thread_id: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct NewBrowserStep {
    pub id: String,
    pub browser_sequence_id: String,
    pub commands: Vec<Commands>,
    pub reason: Option<String>,
    pub thread_id: Option<String>,
    pub task_id: Option<String>,
    pub run_id: Option<String>,
    pub thinking: Option<String>,
    pub evaluation_previous_goal: Option<String>,
    pub memory: Option<String>,
    pub next_goal: Option<String>,
    pub success: bool,
    pub action_result: Option<serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct NewBrowserObservation {
    pub thread_id: String,
    pub task_id: String,
    pub run_id: String,
    pub sequence_id: String,
    pub observation: BrowserObservationData,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct NewBrowserScreenshot {
    pub thread_id: String,
    pub task_id: String,
    pub run_id: String,
    pub sequence_id: String,
    pub screenshot: serde_json::Value,
}

impl BrowserObservationData {
    pub fn success(state_text: Option<String>, dom_snapshot: Option<serde_json::Value>) -> Self {
        Self {
            success: true,
            state_text,
            dom_snapshot,
            screenshot: None,
        }
    }
}