browserrig 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (167) hide show
  1. browserrig/__init__.py +158 -0
  2. browserrig/activity/__init__.py +5 -0
  3. browserrig/activity/models.py +93 -0
  4. browserrig/activity/plugin.py +247 -0
  5. browserrig/activity/state.py +16 -0
  6. browserrig/agent.py +55 -0
  7. browserrig/browser/__init__.py +33 -0
  8. browserrig/browser/base.py +70 -0
  9. browserrig/browser/chrome.py +242 -0
  10. browserrig/browser/config.py +119 -0
  11. browserrig/browser/downloads.py +128 -0
  12. browserrig/browser/favicon.py +119 -0
  13. browserrig/browser/frame.py +227 -0
  14. browserrig/browser/frames.py +116 -0
  15. browserrig/browser/images.py +23 -0
  16. browserrig/browser/input.py +147 -0
  17. browserrig/browser/models.py +8 -0
  18. browserrig/browser/plugin.py +44 -0
  19. browserrig/browser/process.py +144 -0
  20. browserrig/browser/setup.py +12 -0
  21. browserrig/browser/tab.py +311 -0
  22. browserrig/browser/tabs.py +366 -0
  23. browserrig/browser/worlds.py +64 -0
  24. browserrig/choreography/__init__.py +31 -0
  25. browserrig/choreography/events.py +133 -0
  26. browserrig/choreography/plugin.py +75 -0
  27. browserrig/choreography/scenes.py +167 -0
  28. browserrig/choreography/stage.py +53 -0
  29. browserrig/choreography/tabstrip.py +112 -0
  30. browserrig/completion.py +184 -0
  31. browserrig/composition.py +108 -0
  32. browserrig/core/__init__.py +61 -0
  33. browserrig/core/errors.py +18 -0
  34. browserrig/core/geometry.py +149 -0
  35. browserrig/core/ids.py +10 -0
  36. browserrig/core/kinds.py +180 -0
  37. browserrig/core/options.py +7 -0
  38. browserrig/core/tools.py +32 -0
  39. browserrig/events.py +665 -0
  40. browserrig/files/__init__.py +25 -0
  41. browserrig/files/config.py +13 -0
  42. browserrig/files/containers.py +200 -0
  43. browserrig/files/content.py +65 -0
  44. browserrig/files/data.py +80 -0
  45. browserrig/files/documents.py +248 -0
  46. browserrig/files/formats.py +84 -0
  47. browserrig/files/imaging.py +138 -0
  48. browserrig/files/kinds.py +78 -0
  49. browserrig/files/models.py +71 -0
  50. browserrig/files/reading.py +382 -0
  51. browserrig/files/spreadsheets.py +417 -0
  52. browserrig/files/system.py +204 -0
  53. browserrig/files/text.py +64 -0
  54. browserrig/files/xlsx.py +53 -0
  55. browserrig/handoff/__init__.py +4 -0
  56. browserrig/handoff/changes.py +48 -0
  57. browserrig/handoff/models.py +31 -0
  58. browserrig/handoff/plugin.py +308 -0
  59. browserrig/handoff/state.py +21 -0
  60. browserrig/input/__init__.py +35 -0
  61. browserrig/input/controller.py +69 -0
  62. browserrig/input/keyboard.py +267 -0
  63. browserrig/input/motor.py +118 -0
  64. browserrig/input/mouse.py +346 -0
  65. browserrig/input/pointer.py +84 -0
  66. browserrig/input/presenter.py +49 -0
  67. browserrig/input/target.py +67 -0
  68. browserrig/input/wheel.py +40 -0
  69. browserrig/kinds.py +33 -0
  70. browserrig/nudges/__init__.py +3 -0
  71. browserrig/nudges/plugin.py +295 -0
  72. browserrig/nudges/state.py +23 -0
  73. browserrig/observation/__init__.py +53 -0
  74. browserrig/observation/capture.py +374 -0
  75. browserrig/observation/changes.py +63 -0
  76. browserrig/observation/config.py +12 -0
  77. browserrig/observation/content.py +176 -0
  78. browserrig/observation/delta.py +69 -0
  79. browserrig/observation/dom.py +97 -0
  80. browserrig/observation/extraction/__init__.py +335 -0
  81. browserrig/observation/extraction/accessibility.py +62 -0
  82. browserrig/observation/extraction/document.py +471 -0
  83. browserrig/observation/extraction/elements.py +676 -0
  84. browserrig/observation/extraction/semantics.py +351 -0
  85. browserrig/observation/extraction/styles.py +30 -0
  86. browserrig/observation/extraction/visibility.py +108 -0
  87. browserrig/observation/find.py +152 -0
  88. browserrig/observation/handle.py +170 -0
  89. browserrig/observation/images.py +243 -0
  90. browserrig/observation/marks.py +157 -0
  91. browserrig/observation/models.py +230 -0
  92. browserrig/observation/plugin.py +413 -0
  93. browserrig/observation/redirects.py +40 -0
  94. browserrig/observation/references.py +47 -0
  95. browserrig/observation/render.py +291 -0
  96. browserrig/observation/renderer.py +76 -0
  97. browserrig/observation/state.py +37 -0
  98. browserrig/pacing/__init__.py +5 -0
  99. browserrig/pacing/plugin.py +22 -0
  100. browserrig/py.typed +0 -0
  101. browserrig/readiness/__init__.py +25 -0
  102. browserrig/readiness/config.py +12 -0
  103. browserrig/readiness/dom.py +83 -0
  104. browserrig/readiness/downloads.py +30 -0
  105. browserrig/readiness/hooks.py +27 -0
  106. browserrig/readiness/models.py +13 -0
  107. browserrig/readiness/plugin.py +170 -0
  108. browserrig/readiness/policies.py +43 -0
  109. browserrig/readiness/state.py +20 -0
  110. browserrig/readiness/strategy.py +30 -0
  111. browserrig/readiness/wait.py +238 -0
  112. browserrig/scripts/README.md +39 -0
  113. browserrig/scripts/__init__.py +186 -0
  114. browserrig/scripts/content.js +526 -0
  115. browserrig/scripts/cursor.js +57 -0
  116. browserrig/scripts/element.js +82 -0
  117. browserrig/scripts/find.js +377 -0
  118. browserrig/scripts/focused.js +15 -0
  119. browserrig/scripts/lib/composed.js +21 -0
  120. browserrig/scripts/lib/elements.js +9 -0
  121. browserrig/scripts/lib/geometry.js +13 -0
  122. browserrig/scripts/lib/hit.js +84 -0
  123. browserrig/scripts/lib/markdown.js +32 -0
  124. browserrig/scripts/lib/scroll.js +226 -0
  125. browserrig/scripts/lib/secret.js +74 -0
  126. browserrig/scripts/lib/visibility.js +42 -0
  127. browserrig/scripts/models.py +153 -0
  128. browserrig/scripts/owner_hits.js +4 -0
  129. browserrig/scripts/owner_scroll.js +7 -0
  130. browserrig/scripts/owner_size.js +11 -0
  131. browserrig/scripts/page_facts.js +9 -0
  132. browserrig/scripts/reset.js +4 -0
  133. browserrig/scripts/scroll.js +5 -0
  134. browserrig/scripts/secret_field.js +7 -0
  135. browserrig/scripts/secret_focus.js +31 -0
  136. browserrig/scripts/seed.js +13 -0
  137. browserrig/scripts/stability.js +140 -0
  138. browserrig/scripts/tab_strip.js +27 -0
  139. browserrig/scripts/viewport.js +3 -0
  140. browserrig/secrets/__init__.py +5 -0
  141. browserrig/secrets/models.py +90 -0
  142. browserrig/secrets/origin.py +95 -0
  143. browserrig/secrets/plugin.py +397 -0
  144. browserrig/secrets/redaction.py +107 -0
  145. browserrig/secrets/state.py +6 -0
  146. browserrig/secrets/totp.py +62 -0
  147. browserrig/terminal.py +120 -0
  148. browserrig/tools/__init__.py +51 -0
  149. browserrig/tools/chains.py +55 -0
  150. browserrig/tools/dialogs.py +23 -0
  151. browserrig/tools/effects.py +8 -0
  152. browserrig/tools/execution.py +333 -0
  153. browserrig/tools/files.py +411 -0
  154. browserrig/tools/find.py +125 -0
  155. browserrig/tools/forms.py +76 -0
  156. browserrig/tools/intents.py +82 -0
  157. browserrig/tools/javascript.py +37 -0
  158. browserrig/tools/keyboard.py +126 -0
  159. browserrig/tools/mouse.py +224 -0
  160. browserrig/tools/navigation.py +189 -0
  161. browserrig/tools/scrolling.py +39 -0
  162. browserrig/tools/tabs.py +81 -0
  163. browserrig/tools/targeting.py +59 -0
  164. browserrig-0.1.0.dist-info/METADATA +174 -0
  165. browserrig-0.1.0.dist-info/RECORD +167 -0
  166. browserrig-0.1.0.dist-info/WHEEL +4 -0
  167. browserrig-0.1.0.dist-info/licenses/LICENSE +21 -0
browserrig/events.py ADDED
@@ -0,0 +1,665 @@
1
+ from dataclasses import dataclass, field
2
+ from enum import StrEnum
3
+ from time import monotonic
4
+ from typing import Literal
5
+
6
+ from harnessed.events import DurableEvent, TransientEvent
7
+
8
+ from .core import (
9
+ ActionKind,
10
+ ActivityKind,
11
+ ActivityOutcome,
12
+ CursorStyle,
13
+ FileSource,
14
+ ReadinessPhase,
15
+ ReadinessStage,
16
+ ReadinessStatus,
17
+ )
18
+
19
+
20
+ class EventKind(StrEnum):
21
+ """Stable wire tags, independent of Python class names."""
22
+
23
+ CONNECTED = "browser.connected"
24
+ DISCONNECTED = "browser.disconnected"
25
+ TAB_OPENED = "browser.tab.opened"
26
+ TAB_ACTIVATED = "browser.tab.activated"
27
+ TAB_CLOSED = "browser.tab.closed"
28
+ TAB_UPDATED = "browser.tab.updated"
29
+ NAVIGATION_STARTED = "browser.navigation.started"
30
+ NAVIGATION_COMMITTED = "browser.navigation.committed"
31
+ DIALOG_OPENED = "browser.dialog.opened"
32
+ DIALOG_HANDLED = "browser.dialog.handled"
33
+ DOWNLOAD_COMPLETED = "browser.download.completed"
34
+ DOWNLOAD_STARTED = "browser.download.started"
35
+ DOWNLOAD_FAILED = "browser.download.failed"
36
+ DOWNLOAD_CANCELED = "browser.download.canceled"
37
+ DOWNLOAD_PROGRESS = "browser.download.progress"
38
+ FILES_LISTED = "browser.files.listed"
39
+ FILE_READ_STARTED = "browser.files.read.started"
40
+ FILE_READ_FINISHED = "browser.files.read.finished"
41
+ FILE_READ_FAILED = "browser.files.read.failed"
42
+ FILE_WRITTEN = "browser.files.written"
43
+ FILE_OPENED = "browser.files.opened"
44
+ FILES_UPLOADED = "browser.files.uploaded"
45
+ FILE_TRANSFER = "browser.files.transfer"
46
+ ACTION_STARTED = "browser.action.started"
47
+ ACTION_FINISHED = "browser.action.finished"
48
+ ACTION_FAILED = "browser.action.failed"
49
+ READINESS_STARTED = "browser.readiness.started"
50
+ READINESS_READY = "browser.readiness.ready"
51
+ READINESS_DEGRADED = "browser.readiness.degraded"
52
+ READINESS_FAILED = "browser.readiness.failed"
53
+ READINESS_CANCELLED = "browser.readiness.cancelled"
54
+ OBSERVATION_CAPTURED = "browser.observation.captured"
55
+ NUDGE_QUEUED = "browser.nudge.queued"
56
+ NUDGE_INCLUDED = "browser.nudge.included"
57
+ NUDGE_EXPIRED = "browser.nudge.expired"
58
+ SECRET_ENTERED = "browser.secret.entered"
59
+ ACTIVITY_STARTED = "browser.activity.started"
60
+ ACTIVITY_FINISHED = "browser.activity.finished"
61
+ HANDOFF_REQUESTED = "browser.handoff.requested"
62
+ HANDOFF_FINISHED = "browser.handoff.finished"
63
+ CURSOR_MOVED = "browser.cursor.moved"
64
+ CURSOR_STATE = "browser.cursor.state"
65
+ CURSOR_STYLE = "browser.cursor.style"
66
+ CURSOR_ENTERED = "browser.cursor.entered"
67
+ TAB_PRESSED = "browser.tab.pressed"
68
+ POINTER_PRESSED = "browser.pointer.pressed"
69
+ POINTER_RELEASED = "browser.pointer.released"
70
+ KEY_PRESSED = "browser.key.pressed"
71
+ KEYBOARD_VISIBILITY = "browser.keyboard.visibility"
72
+ SCROLLED = "browser.scrolled"
73
+ HIGHLIGHT_ELEMENT = "browser.element.highlight"
74
+ WAITING = "browser.waiting"
75
+ BAR_TYPED = "browser.bar.typed"
76
+ FIND_BAR = "browser.find.bar"
77
+ FIND_RESULTS = "browser.find.results"
78
+
79
+
80
+ @dataclass(frozen=True, slots=True, kw_only=True)
81
+ class BrowserEvent(DurableEvent):
82
+ browser_id: str = ""
83
+ target_id: str = ""
84
+ document_id: str = ""
85
+ at: float = field(default_factory=monotonic)
86
+
87
+
88
+ @dataclass(frozen=True, slots=True, kw_only=True)
89
+ class LiveEvent(TransientEvent):
90
+ """Live presentation detail that is streamed to subscribers but never persisted."""
91
+
92
+ browser_id: str = ""
93
+ target_id: str = ""
94
+ document_id: str = ""
95
+ at: float = field(default_factory=monotonic)
96
+
97
+
98
+ @dataclass(frozen=True, slots=True, kw_only=True)
99
+ class InputEvent(LiveEvent):
100
+ action_id: str = ""
101
+
102
+
103
+ @dataclass(frozen=True, slots=True)
104
+ class CursorMovedEvent(InputEvent):
105
+ from_position: tuple[float, float]
106
+ to_position: tuple[float, float]
107
+ control_point_1: tuple[float, float]
108
+ control_point_2: tuple[float, float]
109
+ duration: float
110
+ easing: Literal["easeInOutCubic"] = "easeInOutCubic"
111
+ type: Literal[EventKind.CURSOR_MOVED] = field(
112
+ default=EventKind.CURSOR_MOVED, kw_only=True
113
+ )
114
+
115
+
116
+ @dataclass(frozen=True, slots=True)
117
+ class CursorStateEvent(InputEvent):
118
+ x: float
119
+ y: float
120
+ buttons: int = 0
121
+ type: Literal[EventKind.CURSOR_STATE] = field(
122
+ default=EventKind.CURSOR_STATE, kw_only=True
123
+ )
124
+
125
+
126
+ @dataclass(frozen=True, slots=True)
127
+ class CursorStyleEvent(InputEvent):
128
+ """The CSS cursor under the pointer changed, for example to a hand over a link."""
129
+
130
+ style: CursorStyle
131
+ type: Literal[EventKind.CURSOR_STYLE] = field(
132
+ default=EventKind.CURSOR_STYLE, kw_only=True
133
+ )
134
+
135
+
136
+ @dataclass(frozen=True, slots=True)
137
+ class PointerPressedEvent(InputEvent):
138
+ x: float
139
+ y: float
140
+ click_count: int
141
+ button: str = "left"
142
+ type: Literal[EventKind.POINTER_PRESSED] = field(
143
+ default=EventKind.POINTER_PRESSED, kw_only=True
144
+ )
145
+
146
+
147
+ @dataclass(frozen=True, slots=True)
148
+ class PointerReleasedEvent(InputEvent):
149
+ x: float
150
+ y: float
151
+ click_count: int
152
+ button: str = "left"
153
+ type: Literal[EventKind.POINTER_RELEASED] = field(
154
+ default=EventKind.POINTER_RELEASED, kw_only=True
155
+ )
156
+
157
+
158
+ @dataclass(frozen=True, slots=True)
159
+ class KeyPressedEvent(InputEvent):
160
+ key: str
161
+ modifiers: tuple[str, ...] = ()
162
+ duration: float = 0
163
+ type: Literal[EventKind.KEY_PRESSED] = field(
164
+ default=EventKind.KEY_PRESSED, kw_only=True
165
+ )
166
+
167
+
168
+ @dataclass(frozen=True, slots=True)
169
+ class KeyboardVisibilityEvent(InputEvent):
170
+ visible: bool
171
+ type: Literal[EventKind.KEYBOARD_VISIBILITY] = field(
172
+ default=EventKind.KEYBOARD_VISIBILITY, kw_only=True
173
+ )
174
+
175
+
176
+ @dataclass(frozen=True, slots=True)
177
+ class ScrolledEvent(InputEvent):
178
+ x: float
179
+ y: float
180
+ delta_x: float
181
+ delta_y: float
182
+ duration: float
183
+ type: Literal[EventKind.SCROLLED] = field(default=EventKind.SCROLLED, kw_only=True)
184
+
185
+
186
+ @dataclass(frozen=True, slots=True)
187
+ class DownloadProgressedEvent(LiveEvent):
188
+ """Byte progress reported by the browser; completion is only a separate durable event."""
189
+
190
+ download_id: str
191
+ received_bytes: int
192
+ total_bytes: int | None = None
193
+ type: Literal[EventKind.DOWNLOAD_PROGRESS] = field(
194
+ default=EventKind.DOWNLOAD_PROGRESS, kw_only=True
195
+ )
196
+
197
+
198
+ @dataclass(frozen=True, slots=True)
199
+ class TabUpdatedEvent(LiveEvent):
200
+ """What a viewer's tab strip shows for one tab, sent whenever any field changes.
201
+
202
+ `favicon` is a `data:` URI loaded through the browser, or empty when the page has
203
+ none. A loading tab keeps its previous icon until the new page settles.
204
+ """
205
+
206
+ url: str
207
+ title: str
208
+ loading: bool
209
+ favicon: str = ""
210
+ type: Literal[EventKind.TAB_UPDATED] = field(
211
+ default=EventKind.TAB_UPDATED, kw_only=True
212
+ )
213
+
214
+
215
+ @dataclass(frozen=True, slots=True)
216
+ class ConnectedEvent(BrowserEvent):
217
+ owned_process: bool
218
+ type: Literal[EventKind.CONNECTED] = field(
219
+ default=EventKind.CONNECTED, kw_only=True
220
+ )
221
+
222
+
223
+ @dataclass(frozen=True, slots=True)
224
+ class DisconnectedEvent(BrowserEvent):
225
+ type: Literal[EventKind.DISCONNECTED] = field(
226
+ default=EventKind.DISCONNECTED, kw_only=True
227
+ )
228
+
229
+
230
+ @dataclass(frozen=True, slots=True)
231
+ class TabOpenedEvent(BrowserEvent):
232
+ url: str
233
+ opener_id: str = ""
234
+ type: Literal[EventKind.TAB_OPENED] = field(
235
+ default=EventKind.TAB_OPENED, kw_only=True
236
+ )
237
+
238
+
239
+ @dataclass(frozen=True, slots=True)
240
+ class TabActivatedEvent(BrowserEvent):
241
+ type: Literal[EventKind.TAB_ACTIVATED] = field(
242
+ default=EventKind.TAB_ACTIVATED, kw_only=True
243
+ )
244
+
245
+
246
+ @dataclass(frozen=True, slots=True)
247
+ class TabClosedEvent(BrowserEvent):
248
+ type: Literal[EventKind.TAB_CLOSED] = field(
249
+ default=EventKind.TAB_CLOSED, kw_only=True
250
+ )
251
+
252
+
253
+ @dataclass(frozen=True, slots=True)
254
+ class NavigationStartedEvent(BrowserEvent):
255
+ """`typed` is what a person would enter in the address bar to get to `url`.
256
+
257
+ It drops the scheme of web URLs; for a search it is the query itself.
258
+ """
259
+
260
+ url: str
261
+ typed: str = ""
262
+ type: Literal[EventKind.NAVIGATION_STARTED] = field(
263
+ default=EventKind.NAVIGATION_STARTED, kw_only=True
264
+ )
265
+
266
+
267
+ @dataclass(frozen=True, slots=True)
268
+ class NavigationCommittedEvent(BrowserEvent):
269
+ url: str
270
+ type: Literal[EventKind.NAVIGATION_COMMITTED] = field(
271
+ default=EventKind.NAVIGATION_COMMITTED, kw_only=True
272
+ )
273
+
274
+
275
+ @dataclass(frozen=True, slots=True)
276
+ class DialogOpenedEvent(BrowserEvent):
277
+ kind: str
278
+ message: str
279
+ type: Literal[EventKind.DIALOG_OPENED] = field(
280
+ default=EventKind.DIALOG_OPENED, kw_only=True
281
+ )
282
+
283
+
284
+ @dataclass(frozen=True, slots=True)
285
+ class DialogHandledEvent(BrowserEvent):
286
+ accepted: bool
287
+ type: Literal[EventKind.DIALOG_HANDLED] = field(
288
+ default=EventKind.DIALOG_HANDLED, kw_only=True
289
+ )
290
+
291
+
292
+ @dataclass(frozen=True, slots=True)
293
+ class DownloadCompletedEvent(BrowserEvent):
294
+ download_id: str
295
+ filename: str
296
+ size: int
297
+ type: Literal[EventKind.DOWNLOAD_COMPLETED] = field(
298
+ default=EventKind.DOWNLOAD_COMPLETED, kw_only=True
299
+ )
300
+
301
+
302
+ @dataclass(frozen=True, slots=True)
303
+ class DownloadStartedEvent(BrowserEvent):
304
+ download_id: str
305
+ filename: str
306
+ url: str
307
+ type: Literal[EventKind.DOWNLOAD_STARTED] = field(
308
+ default=EventKind.DOWNLOAD_STARTED, kw_only=True
309
+ )
310
+
311
+
312
+ @dataclass(frozen=True, slots=True)
313
+ class DownloadFailedEvent(BrowserEvent):
314
+ download_id: str
315
+ reason: str
316
+ type: Literal[EventKind.DOWNLOAD_FAILED] = field(
317
+ default=EventKind.DOWNLOAD_FAILED, kw_only=True
318
+ )
319
+
320
+
321
+ @dataclass(frozen=True, slots=True)
322
+ class DownloadCanceledEvent(BrowserEvent):
323
+ download_id: str
324
+ type: Literal[EventKind.DOWNLOAD_CANCELED] = field(
325
+ default=EventKind.DOWNLOAD_CANCELED, kw_only=True
326
+ )
327
+
328
+
329
+ @dataclass(frozen=True, slots=True)
330
+ class FilesListedEvent(BrowserEvent):
331
+ directory: str
332
+ entries: int
333
+ offset: int = 0
334
+ next_offset: int | None = None
335
+ type: Literal[EventKind.FILES_LISTED] = field(
336
+ default=EventKind.FILES_LISTED, kw_only=True
337
+ )
338
+
339
+
340
+ @dataclass(frozen=True, slots=True)
341
+ class FileReadStartedEvent(BrowserEvent):
342
+ """A read was requested; extraction and OCR may take seconds before it finishes."""
343
+
344
+ read_id: str
345
+ path: str
346
+ page_number: int | None = None
347
+ sheet: str | None = None
348
+ cell_range: str | None = None
349
+ member: str | None = None
350
+ ocr: bool | None = None
351
+ offset: int = 0
352
+ type: Literal[EventKind.FILE_READ_STARTED] = field(
353
+ default=EventKind.FILE_READ_STARTED, kw_only=True
354
+ )
355
+
356
+
357
+ @dataclass(frozen=True, slots=True)
358
+ class FileReadFinishedEvent(BrowserEvent):
359
+ read_id: str
360
+ path: str
361
+ format: str
362
+ status: str
363
+ characters: int
364
+ offset: int = 0
365
+ next_offset: int | None = None
366
+ page_number: int | None = None
367
+ page_count: int | None = None
368
+ sheet: str | None = None
369
+ member: str | None = None
370
+ type: Literal[EventKind.FILE_READ_FINISHED] = field(
371
+ default=EventKind.FILE_READ_FINISHED, kw_only=True
372
+ )
373
+
374
+
375
+ @dataclass(frozen=True, slots=True)
376
+ class FileReadFailedEvent(BrowserEvent):
377
+ read_id: str
378
+ path: str
379
+ reason: str
380
+ type: Literal[EventKind.FILE_READ_FAILED] = field(
381
+ default=EventKind.FILE_READ_FAILED, kw_only=True
382
+ )
383
+
384
+
385
+ @dataclass(frozen=True, slots=True)
386
+ class FileWrittenEvent(BrowserEvent):
387
+ path: str
388
+ size: int
389
+ created: bool
390
+ type: Literal[EventKind.FILE_WRITTEN] = field(
391
+ default=EventKind.FILE_WRITTEN, kw_only=True
392
+ )
393
+
394
+
395
+ @dataclass(frozen=True, slots=True)
396
+ class FileOpenedEvent(BrowserEvent):
397
+ """A file was opened in the tab identified by `target_id`."""
398
+
399
+ path: str
400
+ source: FileSource
401
+ download_id: str = ""
402
+ type: Literal[EventKind.FILE_OPENED] = field(
403
+ default=EventKind.FILE_OPENED, kw_only=True
404
+ )
405
+
406
+
407
+ @dataclass(frozen=True, slots=True)
408
+ class FilesUploadedEvent(BrowserEvent):
409
+ paths: tuple[str, ...]
410
+ ref: str
411
+ type: Literal[EventKind.FILES_UPLOADED] = field(
412
+ default=EventKind.FILES_UPLOADED, kw_only=True
413
+ )
414
+
415
+
416
+ @dataclass(frozen=True, slots=True)
417
+ class ActionStartedEvent(BrowserEvent):
418
+ action_id: str
419
+ kind: ActionKind
420
+ type: Literal[EventKind.ACTION_STARTED] = field(
421
+ default=EventKind.ACTION_STARTED, kw_only=True
422
+ )
423
+
424
+
425
+ @dataclass(frozen=True, slots=True, kw_only=True)
426
+ class PageState:
427
+ url: str
428
+ document_id: str
429
+ fingerprint: str = ""
430
+ scroll_y: float = 0
431
+
432
+
433
+ @dataclass(frozen=True, slots=True)
434
+ class ActionFinishedEvent(BrowserEvent):
435
+ action_id: str
436
+ kind: ActionKind
437
+ before: PageState
438
+ after_url: str
439
+ prepared_scroll: bool = False
440
+ expects_change: bool = False
441
+ type: Literal[EventKind.ACTION_FINISHED] = field(
442
+ default=EventKind.ACTION_FINISHED, kw_only=True
443
+ )
444
+
445
+
446
+ @dataclass(frozen=True, slots=True)
447
+ class ActionFailedEvent(BrowserEvent):
448
+ action_id: str
449
+ kind: ActionKind
450
+ dispatched: bool
451
+ reason: str
452
+ type: Literal[EventKind.ACTION_FAILED] = field(
453
+ default=EventKind.ACTION_FAILED, kw_only=True
454
+ )
455
+
456
+
457
+ @dataclass(frozen=True, slots=True)
458
+ class ReadinessStartedEvent(BrowserEvent):
459
+ readiness_id: str
460
+ phase: ReadinessPhase
461
+ stage: ReadinessStage = field(default=ReadinessStage.ONGOING, kw_only=True)
462
+ type: Literal[EventKind.READINESS_STARTED] = field(
463
+ default=EventKind.READINESS_STARTED, kw_only=True
464
+ )
465
+
466
+
467
+ @dataclass(frozen=True, slots=True, kw_only=True)
468
+ class ReadinessEndedEvent(BrowserEvent):
469
+ readiness_id: str
470
+ phase: ReadinessPhase
471
+ stage: ReadinessStage = field(default=ReadinessStage.ONGOING, kw_only=True)
472
+ duration: float
473
+ reason: str = ""
474
+ timed_out: bool = False
475
+
476
+
477
+ @dataclass(frozen=True, slots=True)
478
+ class ReadyEvent(ReadinessEndedEvent):
479
+ type: Literal[EventKind.READINESS_READY] = field(
480
+ default=EventKind.READINESS_READY, kw_only=True
481
+ )
482
+
483
+
484
+ @dataclass(frozen=True, slots=True)
485
+ class ReadinessDegradedEvent(ReadinessEndedEvent):
486
+ type: Literal[EventKind.READINESS_DEGRADED] = field(
487
+ default=EventKind.READINESS_DEGRADED, kw_only=True
488
+ )
489
+
490
+
491
+ @dataclass(frozen=True, slots=True)
492
+ class ReadinessFailedEvent(ReadinessEndedEvent):
493
+ type: Literal[EventKind.READINESS_FAILED] = field(
494
+ default=EventKind.READINESS_FAILED, kw_only=True
495
+ )
496
+
497
+
498
+ @dataclass(frozen=True, slots=True)
499
+ class ReadinessCancelledEvent(ReadinessEndedEvent):
500
+ type: Literal[EventKind.READINESS_CANCELLED] = field(
501
+ default=EventKind.READINESS_CANCELLED, kw_only=True
502
+ )
503
+
504
+
505
+ @dataclass(frozen=True, slots=True)
506
+ class ObservationCapturedEvent(BrowserEvent):
507
+ observation_id: str
508
+ url: str
509
+ fingerprint: str
510
+ scroll_y: float
511
+ readiness: ReadinessStatus
512
+ type: Literal[EventKind.OBSERVATION_CAPTURED] = field(
513
+ default=EventKind.OBSERVATION_CAPTURED, kw_only=True
514
+ )
515
+
516
+
517
+ @dataclass(frozen=True, slots=True)
518
+ class NudgeQueuedEvent(BrowserEvent):
519
+ nudge_id: str
520
+ key: str
521
+ text: str
522
+ cause_id: str
523
+ type: Literal[EventKind.NUDGE_QUEUED] = field(
524
+ default=EventKind.NUDGE_QUEUED, kw_only=True
525
+ )
526
+
527
+
528
+ @dataclass(frozen=True, slots=True)
529
+ class NudgeIncludedEvent(BrowserEvent):
530
+ nudge_ids: tuple[str, ...]
531
+ request_id: str
532
+ type: Literal[EventKind.NUDGE_INCLUDED] = field(
533
+ default=EventKind.NUDGE_INCLUDED, kw_only=True
534
+ )
535
+
536
+
537
+ @dataclass(frozen=True, slots=True)
538
+ class NudgeExpiredEvent(BrowserEvent):
539
+ nudge_id: str
540
+ type: Literal[EventKind.NUDGE_EXPIRED] = field(
541
+ default=EventKind.NUDGE_EXPIRED, kw_only=True
542
+ )
543
+
544
+
545
+ @dataclass(frozen=True, slots=True)
546
+ class SecretEnteredEvent(BrowserEvent):
547
+ """Names the secrets typed and where; values are never part of an event."""
548
+
549
+ names: tuple[str, ...]
550
+ origin: str
551
+ type: Literal[EventKind.SECRET_ENTERED] = field(
552
+ default=EventKind.SECRET_ENTERED, kw_only=True
553
+ )
554
+
555
+
556
+ @dataclass(frozen=True, slots=True)
557
+ class HandoffRequestedEvent(BrowserEvent):
558
+ handoff_id: str
559
+ reason: str
560
+ expected_state: str = ""
561
+ source: Literal["tool", "pause"] = "tool"
562
+ call_id: str = ""
563
+ type: Literal[EventKind.HANDOFF_REQUESTED] = field(
564
+ default=EventKind.HANDOFF_REQUESTED, kw_only=True
565
+ )
566
+
567
+
568
+ type HandoffStatus = Literal[
569
+ "done", "declined", "timeout", "cancelled", "failed", "resumed"
570
+ ]
571
+
572
+
573
+ @dataclass(frozen=True, slots=True)
574
+ class HandoffFinishedEvent(BrowserEvent):
575
+ handoff_id: str
576
+ status: HandoffStatus
577
+ note: str = ""
578
+ changes: tuple[str, ...] = ()
579
+ source: Literal["tool", "pause"] = "tool"
580
+ call_id: str = ""
581
+ type: Literal[EventKind.HANDOFF_FINISHED] = field(
582
+ default=EventKind.HANDOFF_FINISHED, kw_only=True
583
+ )
584
+
585
+
586
+ @dataclass(frozen=True, slots=True)
587
+ class ActivityStartedEvent(BrowserEvent):
588
+ interval_id: str
589
+ kind: ActivityKind
590
+ cause_id: str
591
+ epoch_id: str = ""
592
+ type: Literal[EventKind.ACTIVITY_STARTED] = field(
593
+ default=EventKind.ACTIVITY_STARTED, kw_only=True
594
+ )
595
+
596
+ def __post_init__(self) -> None:
597
+ object.__setattr__(self, "kind", ActivityKind(self.kind))
598
+
599
+
600
+ @dataclass(frozen=True, slots=True)
601
+ class ActivityFinishedEvent(BrowserEvent):
602
+ interval_id: str
603
+ kind: ActivityKind
604
+ cause_id: str
605
+ started_at: float
606
+ outcome: ActivityOutcome
607
+ epoch_id: str = ""
608
+ reason: str = ""
609
+ type: Literal[EventKind.ACTIVITY_FINISHED] = field(
610
+ default=EventKind.ACTIVITY_FINISHED, kw_only=True
611
+ )
612
+
613
+ def __post_init__(self) -> None:
614
+ object.__setattr__(self, "kind", ActivityKind(self.kind))
615
+ object.__setattr__(self, "outcome", ActivityOutcome(self.outcome))
616
+
617
+
618
+ BROWSER_EVENTS = (
619
+ ConnectedEvent,
620
+ DisconnectedEvent,
621
+ TabOpenedEvent,
622
+ TabActivatedEvent,
623
+ TabClosedEvent,
624
+ NavigationStartedEvent,
625
+ NavigationCommittedEvent,
626
+ DialogOpenedEvent,
627
+ DialogHandledEvent,
628
+ DownloadCompletedEvent,
629
+ DownloadStartedEvent,
630
+ DownloadFailedEvent,
631
+ DownloadCanceledEvent,
632
+ DownloadProgressedEvent,
633
+ )
634
+ FILE_EVENTS = (
635
+ FilesListedEvent,
636
+ FileReadStartedEvent,
637
+ FileReadFinishedEvent,
638
+ FileReadFailedEvent,
639
+ FileWrittenEvent,
640
+ FileOpenedEvent,
641
+ )
642
+ UPLOAD_EVENTS = (FilesUploadedEvent,)
643
+ ACTION_EVENTS = (ActionStartedEvent, ActionFinishedEvent, ActionFailedEvent)
644
+ READINESS_EVENTS = (
645
+ ReadinessStartedEvent,
646
+ ReadyEvent,
647
+ ReadinessDegradedEvent,
648
+ ReadinessFailedEvent,
649
+ ReadinessCancelledEvent,
650
+ )
651
+ NUDGE_EVENTS = (NudgeQueuedEvent, NudgeIncludedEvent, NudgeExpiredEvent)
652
+ SECRET_EVENTS = (SecretEnteredEvent,)
653
+ HANDOFF_EVENTS = (HandoffRequestedEvent, HandoffFinishedEvent)
654
+ ACTIVITY_EVENTS = (ActivityStartedEvent, ActivityFinishedEvent)
655
+ TAB_STRIP_EVENTS = (TabUpdatedEvent,)
656
+ INPUT_EVENTS = (
657
+ CursorMovedEvent,
658
+ CursorStateEvent,
659
+ CursorStyleEvent,
660
+ PointerPressedEvent,
661
+ PointerReleasedEvent,
662
+ KeyPressedEvent,
663
+ KeyboardVisibilityEvent,
664
+ ScrolledEvent,
665
+ )
@@ -0,0 +1,25 @@
1
+ from .config import FileSystemOptions
2
+ from .kinds import FileExtension
3
+ from .models import (
4
+ Download,
5
+ DownloadState,
6
+ FileContent,
7
+ FileEntry,
8
+ FileListing,
9
+ FileSystemState,
10
+ FileSystemView,
11
+ )
12
+ from .system import FileSystem
13
+
14
+ __all__ = [
15
+ "Download",
16
+ "DownloadState",
17
+ "FileContent",
18
+ "FileExtension",
19
+ "FileEntry",
20
+ "FileListing",
21
+ "FileSystem",
22
+ "FileSystemOptions",
23
+ "FileSystemState",
24
+ "FileSystemView",
25
+ ]
@@ -0,0 +1,13 @@
1
+ from pathlib import Path
2
+
3
+ from pydantic import Field
4
+
5
+ from browserrig.core import Options
6
+
7
+
8
+ class FileSystemOptions(Options):
9
+ directory: Path | None = None
10
+ max_file_bytes: int = Field(default=50_000_000, ge=1)
11
+ max_expanded_bytes: int = Field(default=200_000_000, ge=1)
12
+ max_archive_depth: int = Field(default=8, ge=1, le=32)
13
+ ocr: bool = True