airbrowser-client 1.2.4 → 1.3.0
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.
- package/.openapi-generator/FILES +14 -31
- package/README.md +46 -65
- package/api.ts +807 -1256
- package/dist/api.d.ts +666 -1064
- package/dist/api.js +546 -636
- package/dist/esm/api.d.ts +666 -1064
- package/dist/esm/api.js +545 -635
- package/docs/BrowserApi.md +288 -340
- package/docs/{UrlData.md → BrowsersRequest.md} +5 -5
- package/docs/ClickRequest.md +5 -5
- package/docs/ConsoleLogsRequest.md +2 -2
- package/docs/CreateBrowserRequest.md +38 -0
- package/docs/DetectCoordinatesRequest.md +5 -1
- package/docs/{FormField.md → DialogRequest.md} +7 -7
- package/docs/EmulateRequest.md +32 -0
- package/docs/{ExecuteData.md → ExecuteScriptRequest.md} +5 -5
- package/docs/FillFormRequest.md +2 -2
- package/docs/GenericResponse.md +24 -0
- package/docs/GuiClickRequest.md +30 -0
- package/docs/GuiHoverXyRequest.md +24 -0
- package/docs/GuiPressKeysXyRequest.md +26 -0
- package/docs/GuiTypeXyRequest.md +26 -0
- package/docs/HistoryRequest.md +1 -1
- package/docs/MouseRequest.md +5 -5
- package/docs/{NavigateRequest.md → NavigateBrowserRequest.md} +5 -5
- package/docs/NetworkLogsRequest.md +2 -2
- package/docs/PerformanceRequest.md +2 -2
- package/docs/PressKeysRequest.md +4 -4
- package/docs/ResizeRequest.md +2 -2
- package/docs/ScrollRequest.md +32 -0
- package/docs/SelectRequest.md +7 -7
- package/docs/SnapshotRequest.md +2 -2
- package/docs/TabsRequest.md +4 -4
- package/docs/TakeScreenshotRequest.md +20 -0
- package/docs/TypeTextRequest.md +26 -0
- package/docs/UploadFileRequest.md +3 -3
- package/docs/WaitElementRequest.md +5 -5
- package/package.json +1 -1
- package/docs/ActionResult.md +0 -26
- package/docs/AttributeResponse.md +0 -26
- package/docs/BrowserConfig.md +0 -36
- package/docs/BrowserCreated.md +0 -26
- package/docs/BrowserCreationData.md +0 -22
- package/docs/BrowserInfoResponse.md +0 -26
- package/docs/BrowserList.md +0 -26
- package/docs/BrowserListData.md +0 -22
- package/docs/CheckElementRequest.md +0 -24
- package/docs/CombinedDialogRequest.md +0 -22
- package/docs/CombinedEmulateRequest.md +0 -32
- package/docs/CombinedGuiClickRequest.md +0 -30
- package/docs/CombinedScrollRequest.md +0 -32
- package/docs/ContentData.md +0 -24
- package/docs/ContentResponse.md +0 -26
- package/docs/DetectCoordinatesResult.md +0 -44
- package/docs/ElementDataRequest.md +0 -26
- package/docs/ExecuteRequest.md +0 -22
- package/docs/ExecuteResponse.md +0 -26
- package/docs/LogsResponse.md +0 -26
- package/docs/PoolStatusResponse.md +0 -26
- package/docs/ScreenshotData.md +0 -22
- package/docs/ScreenshotResponse.md +0 -26
- package/docs/SuccessResponse.md +0 -26
- package/docs/TypeRequest.md +0 -26
- package/docs/UrlResponse.md +0 -26
- package/docs/WhatIsVisibleResult.md +0 -34
package/.openapi-generator/FILES
CHANGED
|
@@ -6,46 +6,33 @@ api.ts
|
|
|
6
6
|
base.ts
|
|
7
7
|
common.ts
|
|
8
8
|
configuration.ts
|
|
9
|
-
docs/ActionResult.md
|
|
10
|
-
docs/AttributeResponse.md
|
|
11
9
|
docs/BaseResponse.md
|
|
12
10
|
docs/BrowserApi.md
|
|
13
|
-
docs/
|
|
14
|
-
docs/BrowserCreated.md
|
|
15
|
-
docs/BrowserCreationData.md
|
|
16
|
-
docs/BrowserInfoResponse.md
|
|
17
|
-
docs/BrowserList.md
|
|
18
|
-
docs/BrowserListData.md
|
|
19
|
-
docs/CheckElementRequest.md
|
|
11
|
+
docs/BrowsersRequest.md
|
|
20
12
|
docs/ClickRequest.md
|
|
21
|
-
docs/CombinedDialogRequest.md
|
|
22
|
-
docs/CombinedEmulateRequest.md
|
|
23
|
-
docs/CombinedGuiClickRequest.md
|
|
24
|
-
docs/CombinedScrollRequest.md
|
|
25
13
|
docs/ConsoleLogsRequest.md
|
|
26
|
-
docs/
|
|
27
|
-
docs/ContentResponse.md
|
|
14
|
+
docs/CreateBrowserRequest.md
|
|
28
15
|
docs/CreateProfileRequest.md
|
|
29
16
|
docs/DetectCoordinatesRequest.md
|
|
30
|
-
docs/
|
|
31
|
-
docs/
|
|
17
|
+
docs/DialogRequest.md
|
|
18
|
+
docs/EmulateRequest.md
|
|
32
19
|
docs/ErrorResponse.md
|
|
33
|
-
docs/
|
|
34
|
-
docs/ExecuteRequest.md
|
|
35
|
-
docs/ExecuteResponse.md
|
|
20
|
+
docs/ExecuteScriptRequest.md
|
|
36
21
|
docs/FillFormRequest.md
|
|
37
|
-
docs/
|
|
22
|
+
docs/GenericResponse.md
|
|
23
|
+
docs/GuiClickRequest.md
|
|
24
|
+
docs/GuiHoverXyRequest.md
|
|
25
|
+
docs/GuiPressKeysXyRequest.md
|
|
26
|
+
docs/GuiTypeXyRequest.md
|
|
38
27
|
docs/HealthApi.md
|
|
39
28
|
docs/HealthStatus.md
|
|
40
29
|
docs/HistoryRequest.md
|
|
41
|
-
docs/LogsResponse.md
|
|
42
30
|
docs/MouseRequest.md
|
|
43
|
-
docs/
|
|
31
|
+
docs/NavigateBrowserRequest.md
|
|
44
32
|
docs/NetworkLogsRequest.md
|
|
45
33
|
docs/PerformanceRequest.md
|
|
46
34
|
docs/PoolApi.md
|
|
47
35
|
docs/PoolScaled.md
|
|
48
|
-
docs/PoolStatusResponse.md
|
|
49
36
|
docs/PressKeysRequest.md
|
|
50
37
|
docs/ProfileInfo.md
|
|
51
38
|
docs/ProfileListData.md
|
|
@@ -55,18 +42,14 @@ docs/ProfilesApi.md
|
|
|
55
42
|
docs/ResizeRequest.md
|
|
56
43
|
docs/ScaleData.md
|
|
57
44
|
docs/ScalePool.md
|
|
58
|
-
docs/
|
|
59
|
-
docs/ScreenshotResponse.md
|
|
45
|
+
docs/ScrollRequest.md
|
|
60
46
|
docs/SelectRequest.md
|
|
61
47
|
docs/SnapshotRequest.md
|
|
62
|
-
docs/SuccessResponse.md
|
|
63
48
|
docs/TabsRequest.md
|
|
64
|
-
docs/
|
|
49
|
+
docs/TakeScreenshotRequest.md
|
|
50
|
+
docs/TypeTextRequest.md
|
|
65
51
|
docs/UploadFileRequest.md
|
|
66
|
-
docs/UrlData.md
|
|
67
|
-
docs/UrlResponse.md
|
|
68
52
|
docs/WaitElementRequest.md
|
|
69
|
-
docs/WhatIsVisibleResult.md
|
|
70
53
|
git_push.sh
|
|
71
54
|
index.ts
|
|
72
55
|
package.json
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## airbrowser-client@1.
|
|
1
|
+
## airbrowser-client@1.3.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install airbrowser-client@1.
|
|
39
|
+
npm install airbrowser-client@1.3.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -51,42 +51,40 @@ All URIs are relative to */api/v1*
|
|
|
51
51
|
|
|
52
52
|
Class | Method | HTTP request | Description
|
|
53
53
|
------------ | ------------- | ------------- | -------------
|
|
54
|
-
*BrowserApi* | [**
|
|
54
|
+
*BrowserApi* | [**browsers**](docs/BrowserApi.md#browsers) | **POST** /browser/browsers | Admin: list all, get info, or close all browsers
|
|
55
|
+
*BrowserApi* | [**checkElement**](docs/BrowserApi.md#checkelement) | **GET** /browser/{browser_id}/check_element | Check if element exists or is visible
|
|
55
56
|
*BrowserApi* | [**click**](docs/BrowserApi.md#click) | **POST** /browser/{browser_id}/click | Click element
|
|
56
|
-
*BrowserApi* | [**
|
|
57
|
-
*BrowserApi* | [**
|
|
58
|
-
*BrowserApi* | [**
|
|
59
|
-
*BrowserApi* | [**
|
|
60
|
-
*BrowserApi* | [**
|
|
61
|
-
*BrowserApi* | [**
|
|
62
|
-
*BrowserApi* | [**
|
|
63
|
-
*BrowserApi* | [**emulate**](docs/BrowserApi.md#emulate) | **POST** /browser/{browser_id}/emulate | Manage device emulation: set, clear, or list_devices
|
|
64
|
-
*BrowserApi* | [**executeScript**](docs/BrowserApi.md#executescript) | **POST** /browser/{browser_id}/execute | Execute JavaScript
|
|
57
|
+
*BrowserApi* | [**closeBrowser**](docs/BrowserApi.md#closebrowser) | **DELETE** /browser/{browser_id}/close_browser | Close browser instance
|
|
58
|
+
*BrowserApi* | [**consoleLogs**](docs/BrowserApi.md#consolelogs) | **POST** /browser/{browser_id}/console_logs | Console logs: get or clear
|
|
59
|
+
*BrowserApi* | [**createBrowser**](docs/BrowserApi.md#createbrowser) | **POST** /browser/create_browser | Create browser instance with optional persistent profile
|
|
60
|
+
*BrowserApi* | [**detectCoordinates**](docs/BrowserApi.md#detectcoordinates) | **POST** /browser/{browser_id}/detect_coordinates | Detect element coordinates using vision
|
|
61
|
+
*BrowserApi* | [**dialog**](docs/BrowserApi.md#dialog) | **POST** /browser/{browser_id}/dialog | Dialogs: get, accept, dismiss
|
|
62
|
+
*BrowserApi* | [**emulate**](docs/BrowserApi.md#emulate) | **POST** /browser/{browser_id}/emulate | Emulation: set, clear, list_devices
|
|
63
|
+
*BrowserApi* | [**executeScript**](docs/BrowserApi.md#executescript) | **POST** /browser/{browser_id}/execute_script | Execute JavaScript
|
|
65
64
|
*BrowserApi* | [**fillForm**](docs/BrowserApi.md#fillform) | **POST** /browser/{browser_id}/fill_form | Fill multiple form fields
|
|
66
|
-
*BrowserApi* | [**
|
|
67
|
-
*BrowserApi* | [**
|
|
68
|
-
*BrowserApi* | [**
|
|
69
|
-
*BrowserApi* | [**
|
|
70
|
-
*BrowserApi* | [**
|
|
71
|
-
*BrowserApi* | [**
|
|
72
|
-
*BrowserApi* | [**
|
|
73
|
-
*BrowserApi* | [**history**](docs/BrowserApi.md#history) | **POST** /browser/{browser_id}/history |
|
|
74
|
-
*BrowserApi* | [**
|
|
75
|
-
*BrowserApi* | [**
|
|
76
|
-
*BrowserApi* | [**
|
|
77
|
-
*BrowserApi* | [**
|
|
78
|
-
*BrowserApi* | [**
|
|
79
|
-
*BrowserApi* | [**pressKeys**](docs/BrowserApi.md#presskeys) | **POST** /browser/{browser_id}/press_keys | Press keys on an element
|
|
65
|
+
*BrowserApi* | [**getContent**](docs/BrowserApi.md#getcontent) | **GET** /browser/{browser_id}/get_content | Get page HTML
|
|
66
|
+
*BrowserApi* | [**getElementData**](docs/BrowserApi.md#getelementdata) | **GET** /browser/{browser_id}/get_element_data | Get element text, attribute, or property
|
|
67
|
+
*BrowserApi* | [**getUrl**](docs/BrowserApi.md#geturl) | **GET** /browser/{browser_id}/get_url | Get current URL
|
|
68
|
+
*BrowserApi* | [**guiClick**](docs/BrowserApi.md#guiclick) | **POST** /browser/{browser_id}/gui_click | GUI click by selector or coordinates
|
|
69
|
+
*BrowserApi* | [**guiHoverXy**](docs/BrowserApi.md#guihoverxy) | **POST** /browser/{browser_id}/gui_hover_xy | GUI hover at coordinates
|
|
70
|
+
*BrowserApi* | [**guiPressKeysXy**](docs/BrowserApi.md#guipresskeysxy) | **POST** /browser/{browser_id}/gui_press_keys_xy | Press keys at coordinates (click to focus, then send keys)
|
|
71
|
+
*BrowserApi* | [**guiTypeXy**](docs/BrowserApi.md#guitypexy) | **POST** /browser/{browser_id}/gui_type_xy | GUI type at coordinates - clicks then types text
|
|
72
|
+
*BrowserApi* | [**history**](docs/BrowserApi.md#history) | **POST** /browser/{browser_id}/history | History: back, forward, or refresh
|
|
73
|
+
*BrowserApi* | [**mouse**](docs/BrowserApi.md#mouse) | **POST** /browser/{browser_id}/mouse | Mouse: hover or drag
|
|
74
|
+
*BrowserApi* | [**navigateBrowser**](docs/BrowserApi.md#navigatebrowser) | **POST** /browser/{browser_id}/navigate | Navigate to URL
|
|
75
|
+
*BrowserApi* | [**networkLogs**](docs/BrowserApi.md#networklogs) | **POST** /browser/{browser_id}/network_logs | Network logs: get or clear
|
|
76
|
+
*BrowserApi* | [**performance**](docs/BrowserApi.md#performance) | **POST** /browser/{browser_id}/performance | Performance: start_trace, stop_trace, metrics, analyze
|
|
77
|
+
*BrowserApi* | [**pressKeys**](docs/BrowserApi.md#presskeys) | **POST** /browser/{browser_id}/press_keys | Press keyboard keys
|
|
80
78
|
*BrowserApi* | [**resize**](docs/BrowserApi.md#resize) | **POST** /browser/{browser_id}/resize | Resize viewport
|
|
81
|
-
*BrowserApi* | [**scroll**](docs/BrowserApi.md#scroll) | **POST** /browser/{browser_id}/scroll | Scroll to element/
|
|
79
|
+
*BrowserApi* | [**scroll**](docs/BrowserApi.md#scroll) | **POST** /browser/{browser_id}/scroll | Scroll to element/coords or by delta
|
|
82
80
|
*BrowserApi* | [**select**](docs/BrowserApi.md#select) | **POST** /browser/{browser_id}/select | Select dropdown: select option or get options
|
|
83
|
-
*BrowserApi* | [**
|
|
84
|
-
*BrowserApi* | [**
|
|
85
|
-
*BrowserApi* | [**
|
|
86
|
-
*BrowserApi* | [**typeText**](docs/BrowserApi.md#typetext) | **POST** /browser/{browser_id}/type | Type text into
|
|
87
|
-
*BrowserApi* | [**uploadFile**](docs/BrowserApi.md#uploadfile) | **POST** /browser/{browser_id}/upload_file | Upload
|
|
88
|
-
*BrowserApi* | [**waitElement**](docs/BrowserApi.md#waitelement) | **POST** /browser/{browser_id}/wait_element | Wait for element to
|
|
89
|
-
*BrowserApi* | [**whatIsVisible**](docs/BrowserApi.md#whatisvisible) | **
|
|
81
|
+
*BrowserApi* | [**snapshot**](docs/BrowserApi.md#snapshot) | **POST** /browser/{browser_id}/snapshot | DOM or accessibility snapshot
|
|
82
|
+
*BrowserApi* | [**tabs**](docs/BrowserApi.md#tabs) | **POST** /browser/{browser_id}/tabs | Tabs: list, new, switch, close, current
|
|
83
|
+
*BrowserApi* | [**takeScreenshot**](docs/BrowserApi.md#takescreenshot) | **POST** /browser/{browser_id}/screenshot | Take screenshot
|
|
84
|
+
*BrowserApi* | [**typeText**](docs/BrowserApi.md#typetext) | **POST** /browser/{browser_id}/type | Type text into element
|
|
85
|
+
*BrowserApi* | [**uploadFile**](docs/BrowserApi.md#uploadfile) | **POST** /browser/{browser_id}/upload_file | Upload file to input
|
|
86
|
+
*BrowserApi* | [**waitElement**](docs/BrowserApi.md#waitelement) | **POST** /browser/{browser_id}/wait_element | Wait for element to be visible or hidden
|
|
87
|
+
*BrowserApi* | [**whatIsVisible**](docs/BrowserApi.md#whatisvisible) | **POST** /browser/{browser_id}/what_is_visible | AI page analysis - what\'s visible
|
|
90
88
|
*HealthApi* | [**healthCheck**](docs/HealthApi.md#healthcheck) | **GET** /health/ | Check the health status of the browser pool
|
|
91
89
|
*HealthApi* | [**prometheusMetrics**](docs/HealthApi.md#prometheusmetrics) | **GET** /health/metrics | Get Prometheus-style metrics for monitoring
|
|
92
90
|
*PoolApi* | [**scalePool**](docs/PoolApi.md#scalepool) | **POST** /pool/scale | Scale the browser pool to a new maximum size
|
|
@@ -99,43 +97,30 @@ Class | Method | HTTP request | Description
|
|
|
99
97
|
|
|
100
98
|
### Documentation For Models
|
|
101
99
|
|
|
102
|
-
- [ActionResult](docs/ActionResult.md)
|
|
103
|
-
- [AttributeResponse](docs/AttributeResponse.md)
|
|
104
100
|
- [BaseResponse](docs/BaseResponse.md)
|
|
105
|
-
- [
|
|
106
|
-
- [BrowserCreated](docs/BrowserCreated.md)
|
|
107
|
-
- [BrowserCreationData](docs/BrowserCreationData.md)
|
|
108
|
-
- [BrowserInfoResponse](docs/BrowserInfoResponse.md)
|
|
109
|
-
- [BrowserList](docs/BrowserList.md)
|
|
110
|
-
- [BrowserListData](docs/BrowserListData.md)
|
|
111
|
-
- [CheckElementRequest](docs/CheckElementRequest.md)
|
|
101
|
+
- [BrowsersRequest](docs/BrowsersRequest.md)
|
|
112
102
|
- [ClickRequest](docs/ClickRequest.md)
|
|
113
|
-
- [CombinedDialogRequest](docs/CombinedDialogRequest.md)
|
|
114
|
-
- [CombinedEmulateRequest](docs/CombinedEmulateRequest.md)
|
|
115
|
-
- [CombinedGuiClickRequest](docs/CombinedGuiClickRequest.md)
|
|
116
|
-
- [CombinedScrollRequest](docs/CombinedScrollRequest.md)
|
|
117
103
|
- [ConsoleLogsRequest](docs/ConsoleLogsRequest.md)
|
|
118
|
-
- [
|
|
119
|
-
- [ContentResponse](docs/ContentResponse.md)
|
|
104
|
+
- [CreateBrowserRequest](docs/CreateBrowserRequest.md)
|
|
120
105
|
- [CreateProfileRequest](docs/CreateProfileRequest.md)
|
|
121
106
|
- [DetectCoordinatesRequest](docs/DetectCoordinatesRequest.md)
|
|
122
|
-
- [
|
|
123
|
-
- [
|
|
107
|
+
- [DialogRequest](docs/DialogRequest.md)
|
|
108
|
+
- [EmulateRequest](docs/EmulateRequest.md)
|
|
124
109
|
- [ErrorResponse](docs/ErrorResponse.md)
|
|
125
|
-
- [
|
|
126
|
-
- [ExecuteRequest](docs/ExecuteRequest.md)
|
|
127
|
-
- [ExecuteResponse](docs/ExecuteResponse.md)
|
|
110
|
+
- [ExecuteScriptRequest](docs/ExecuteScriptRequest.md)
|
|
128
111
|
- [FillFormRequest](docs/FillFormRequest.md)
|
|
129
|
-
- [
|
|
112
|
+
- [GenericResponse](docs/GenericResponse.md)
|
|
113
|
+
- [GuiClickRequest](docs/GuiClickRequest.md)
|
|
114
|
+
- [GuiHoverXyRequest](docs/GuiHoverXyRequest.md)
|
|
115
|
+
- [GuiPressKeysXyRequest](docs/GuiPressKeysXyRequest.md)
|
|
116
|
+
- [GuiTypeXyRequest](docs/GuiTypeXyRequest.md)
|
|
130
117
|
- [HealthStatus](docs/HealthStatus.md)
|
|
131
118
|
- [HistoryRequest](docs/HistoryRequest.md)
|
|
132
|
-
- [LogsResponse](docs/LogsResponse.md)
|
|
133
119
|
- [MouseRequest](docs/MouseRequest.md)
|
|
134
|
-
- [
|
|
120
|
+
- [NavigateBrowserRequest](docs/NavigateBrowserRequest.md)
|
|
135
121
|
- [NetworkLogsRequest](docs/NetworkLogsRequest.md)
|
|
136
122
|
- [PerformanceRequest](docs/PerformanceRequest.md)
|
|
137
123
|
- [PoolScaled](docs/PoolScaled.md)
|
|
138
|
-
- [PoolStatusResponse](docs/PoolStatusResponse.md)
|
|
139
124
|
- [PressKeysRequest](docs/PressKeysRequest.md)
|
|
140
125
|
- [ProfileInfo](docs/ProfileInfo.md)
|
|
141
126
|
- [ProfileListData](docs/ProfileListData.md)
|
|
@@ -144,18 +129,14 @@ Class | Method | HTTP request | Description
|
|
|
144
129
|
- [ResizeRequest](docs/ResizeRequest.md)
|
|
145
130
|
- [ScaleData](docs/ScaleData.md)
|
|
146
131
|
- [ScalePool](docs/ScalePool.md)
|
|
147
|
-
- [
|
|
148
|
-
- [ScreenshotResponse](docs/ScreenshotResponse.md)
|
|
132
|
+
- [ScrollRequest](docs/ScrollRequest.md)
|
|
149
133
|
- [SelectRequest](docs/SelectRequest.md)
|
|
150
134
|
- [SnapshotRequest](docs/SnapshotRequest.md)
|
|
151
|
-
- [SuccessResponse](docs/SuccessResponse.md)
|
|
152
135
|
- [TabsRequest](docs/TabsRequest.md)
|
|
153
|
-
- [
|
|
136
|
+
- [TakeScreenshotRequest](docs/TakeScreenshotRequest.md)
|
|
137
|
+
- [TypeTextRequest](docs/TypeTextRequest.md)
|
|
154
138
|
- [UploadFileRequest](docs/UploadFileRequest.md)
|
|
155
|
-
- [UrlData](docs/UrlData.md)
|
|
156
|
-
- [UrlResponse](docs/UrlResponse.md)
|
|
157
139
|
- [WaitElementRequest](docs/WaitElementRequest.md)
|
|
158
|
-
- [WhatIsVisibleResult](docs/WhatIsVisibleResult.md)
|
|
159
140
|
|
|
160
141
|
|
|
161
142
|
<a id="documentation-for-authorization"></a>
|