bobby-browser-client 0.17.0

Typed HTTP client and /v1 wire types for the Bobby Browser runtime
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

//! Challenge detection and solving types for captchas, MFA, and verification flows.

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "camelCase")]
pub enum ChallengeType {
    RecaptchaV2Checkbox,
    RecaptchaV3,
    TextCaptcha,
    ImageGridCaptcha,
    MfaCodeEntry,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct ChallengeDetection {
    pub challenge_type: ChallengeType,
    pub confidence: f32,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub region: Option<ChallengeRegion>,
    #[serde(default)]
    pub blocking: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hints: Option<ChallengeDetectionHints>,
}

#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct ChallengeRegion {
    pub x: f32,
    pub y: f32,
    pub width: f32,
    pub height: f32,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct ChallengeDetectionHints {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target_field_purpose: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub instruction_text: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct DetectChallengeIntent {
    pub purpose: String,
    #[serde(default)]
    pub hints: DetectChallengeHints,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "camelCase")]
pub struct DetectChallengeHints {
    /// Restrict classification to a page region (CSS pixels, viewport-relative).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub region: Option<ChallengeRegion>,
    /// Deadline for the whole detection, including provider retries.
    #[serde(default = "default_detect_timeout_ms")]
    pub timeout_ms: u64,
}

impl Default for DetectChallengeHints {
    fn default() -> Self {
        Self {
            region: None,
            timeout_ms: default_detect_timeout_ms(),
        }
    }
}

fn default_detect_timeout_ms() -> u64 {
    15_000
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct SolveChallengeIntent {
    pub purpose: String,
    #[serde(default)]
    pub hints: SolveChallengeHints,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "camelCase")]
pub struct SolveChallengeHints {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub region: Option<ChallengeRegion>,
    #[serde(default = "default_solve_timeout_ms")]
    pub timeout_ms: u64,
}

impl Default for SolveChallengeHints {
    fn default() -> Self {
        Self {
            region: None,
            timeout_ms: default_solve_timeout_ms(),
        }
    }
}

fn default_solve_timeout_ms() -> u64 {
    30_000
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(tag = "kind", rename_all = "camelCase")]
pub enum SolveStep {
    Click {
        x: f32,
        y: f32,
    },
    TypeText {
        text: String,
        target_field_purpose: String,
    },
    WaitAndReassess {
        ms: u64,
    },
}