Skip to content

Commit a5d4e3e

Browse files
feat: Mirror the control/platform telemetry split into the public API
Stainless-Generated-From: c17d27f28be9726725d27bdae8d21b267c649f2c
1 parent 2af98bf commit a5d4e3e

10 files changed

Lines changed: 2634 additions & 154 deletions

File tree

api.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ Types:
9999
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserAPICallEvent</a></code>
100100
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserCallStack</a></code>
101101
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserCaptchaSolveResultEvent</a></code>
102+
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserCdpCommandEvent</a></code>
103+
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserCdpCommandMethod</a></code>
102104
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserCdpConnectEvent</a></code>
103105
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserCdpDisconnectEvent</a></code>
104106
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserConsoleErrorEvent</a></code>
@@ -120,6 +122,7 @@ Types:
120122
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserNetworkLoadingFailedEvent</a></code>
121123
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserNetworkRequestEvent</a></code>
122124
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserNetworkResponseEvent</a></code>
125+
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserPageCrashedEvent</a></code>
123126
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserPageDomContentLoadedEvent</a></code>
124127
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserPageLayoutSettledEvent</a></code>
125128
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserPageLayoutShiftEvent</a></code>
@@ -128,12 +131,15 @@ Types:
128131
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserPageNavigationEvent</a></code>
129132
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserPageNavigationSettledEvent</a></code>
130133
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserPageTabOpenedEvent</a></code>
134+
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserPlatformAPICallEvent</a></code>
131135
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserProxyErrorEvent</a></code>
132136
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserServiceCrashedEvent</a></code>
133137
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserSystemOomKillEvent</a></code>
134138
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryCategoriesConfig</a></code>
135139
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryCategoryConfig</a></code>
140+
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryCdpControlConfig</a></code>
136141
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryConfig</a></code>
142+
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryControlConfig</a></code>
137143
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryEvent</a></code>
138144
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryExportConfig</a></code>
139145
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryOtlpExportConfig</a></code>

src/resources/auth/connections.ts

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -549,12 +549,12 @@ export namespace ManagedAuth {
549549
* Per-category capture flags. The operational categories (control, connection,
550550
* system, captcha) are captured whenever telemetry is enabled; set one to
551551
* enabled=false to opt out. The CDP categories (console, network, page,
552-
* interaction) and screenshot are off by default; set enabled=true to opt in. On
553-
* create, provided categories layer onto the default set. On update, provided
554-
* categories merge onto the session's current config; when no telemetry is active
555-
* this falls back to the default set (matching create). If browser is omitted or
556-
* empty, the default set is used. A browser config that disables every category
557-
* stops capture on update and starts no capture on create.
552+
* interaction), screenshot and platform are off by default; set enabled=true to
553+
* opt in. On create, provided categories layer onto the default set. On update,
554+
* provided categories merge onto the session's current config; when no telemetry
555+
* is active this falls back to the default set (matching create). If browser is
556+
* omitted or empty, the default set is used. A browser config that disables every
557+
* category stops capture on update and starts no capture on create.
558558
*/
559559
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
560560

@@ -920,12 +920,12 @@ export namespace ManagedAuthBrowserConfig {
920920
* Per-category capture flags. The operational categories (control, connection,
921921
* system, captcha) are captured whenever telemetry is enabled; set one to
922922
* enabled=false to opt out. The CDP categories (console, network, page,
923-
* interaction) and screenshot are off by default; set enabled=true to opt in. On
924-
* create, provided categories layer onto the default set. On update, provided
925-
* categories merge onto the session's current config; when no telemetry is active
926-
* this falls back to the default set (matching create). If browser is omitted or
927-
* empty, the default set is used. A browser config that disables every category
928-
* stops capture on update and starts no capture on create.
923+
* interaction), screenshot and platform are off by default; set enabled=true to
924+
* opt in. On create, provided categories layer onto the default set. On update,
925+
* provided categories merge onto the session's current config; when no telemetry
926+
* is active this falls back to the default set (matching create). If browser is
927+
* omitted or empty, the default set is used. A browser config that disables every
928+
* category stops capture on update and starts no capture on create.
929929
*/
930930
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
931931

@@ -1121,12 +1121,12 @@ export namespace ManagedAuthCreateRequest {
11211121
* Per-category capture flags. The operational categories (control, connection,
11221122
* system, captcha) are captured whenever telemetry is enabled; set one to
11231123
* enabled=false to opt out. The CDP categories (console, network, page,
1124-
* interaction) and screenshot are off by default; set enabled=true to opt in. On
1125-
* create, provided categories layer onto the default set. On update, provided
1126-
* categories merge onto the session's current config; when no telemetry is active
1127-
* this falls back to the default set (matching create). If browser is omitted or
1128-
* empty, the default set is used. A browser config that disables every category
1129-
* stops capture on update and starts no capture on create.
1124+
* interaction), screenshot and platform are off by default; set enabled=true to
1125+
* opt in. On create, provided categories layer onto the default set. On update,
1126+
* provided categories merge onto the session's current config; when no telemetry
1127+
* is active this falls back to the default set (matching create). If browser is
1128+
* omitted or empty, the default set is used. A browser config that disables every
1129+
* category stops capture on update and starts no capture on create.
11301130
*/
11311131
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
11321132

@@ -1417,12 +1417,12 @@ export namespace ManagedAuthUpdateRequest {
14171417
* Per-category capture flags. The operational categories (control, connection,
14181418
* system, captcha) are captured whenever telemetry is enabled; set one to
14191419
* enabled=false to opt out. The CDP categories (console, network, page,
1420-
* interaction) and screenshot are off by default; set enabled=true to opt in. On
1421-
* create, provided categories layer onto the default set. On update, provided
1422-
* categories merge onto the session's current config; when no telemetry is active
1423-
* this falls back to the default set (matching create). If browser is omitted or
1424-
* empty, the default set is used. A browser config that disables every category
1425-
* stops capture on update and starts no capture on create.
1420+
* interaction), screenshot and platform are off by default; set enabled=true to
1421+
* opt in. On create, provided categories layer onto the default set. On update,
1422+
* provided categories merge onto the session's current config; when no telemetry
1423+
* is active this falls back to the default set (matching create). If browser is
1424+
* omitted or empty, the default set is used. A browser config that disables every
1425+
* category stops capture on update and starts no capture on create.
14261426
*/
14271427
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
14281428

@@ -2072,12 +2072,12 @@ export namespace ConnectionCreateParams {
20722072
* Per-category capture flags. The operational categories (control, connection,
20732073
* system, captcha) are captured whenever telemetry is enabled; set one to
20742074
* enabled=false to opt out. The CDP categories (console, network, page,
2075-
* interaction) and screenshot are off by default; set enabled=true to opt in. On
2076-
* create, provided categories layer onto the default set. On update, provided
2077-
* categories merge onto the session's current config; when no telemetry is active
2078-
* this falls back to the default set (matching create). If browser is omitted or
2079-
* empty, the default set is used. A browser config that disables every category
2080-
* stops capture on update and starts no capture on create.
2075+
* interaction), screenshot and platform are off by default; set enabled=true to
2076+
* opt in. On create, provided categories layer onto the default set. On update,
2077+
* provided categories merge onto the session's current config; when no telemetry
2078+
* is active this falls back to the default set (matching create). If browser is
2079+
* omitted or empty, the default set is used. A browser config that disables every
2080+
* category stops capture on update and starts no capture on create.
20812081
*/
20822082
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
20832083

@@ -2280,12 +2280,12 @@ export namespace ConnectionUpdateParams {
22802280
* Per-category capture flags. The operational categories (control, connection,
22812281
* system, captcha) are captured whenever telemetry is enabled; set one to
22822282
* enabled=false to opt out. The CDP categories (console, network, page,
2283-
* interaction) and screenshot are off by default; set enabled=true to opt in. On
2284-
* create, provided categories layer onto the default set. On update, provided
2285-
* categories merge onto the session's current config; when no telemetry is active
2286-
* this falls back to the default set (matching create). If browser is omitted or
2287-
* empty, the default set is used. A browser config that disables every category
2288-
* stops capture on update and starts no capture on create.
2283+
* interaction), screenshot and platform are off by default; set enabled=true to
2284+
* opt in. On create, provided categories layer onto the default set. On update,
2285+
* provided categories merge onto the session's current config; when no telemetry
2286+
* is active this falls back to the default set (matching create). If browser is
2287+
* omitted or empty, the default set is used. A browser config that disables every
2288+
* category stops capture on update and starts no capture on create.
22892289
*/
22902290
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
22912291

@@ -2458,12 +2458,12 @@ export namespace ConnectionLoginParams {
24582458
* Per-category capture flags. The operational categories (control, connection,
24592459
* system, captcha) are captured whenever telemetry is enabled; set one to
24602460
* enabled=false to opt out. The CDP categories (console, network, page,
2461-
* interaction) and screenshot are off by default; set enabled=true to opt in. On
2462-
* create, provided categories layer onto the default set. On update, provided
2463-
* categories merge onto the session's current config; when no telemetry is active
2464-
* this falls back to the default set (matching create). If browser is omitted or
2465-
* empty, the default set is used. A browser config that disables every category
2466-
* stops capture on update and starts no capture on create.
2461+
* interaction), screenshot and platform are off by default; set enabled=true to
2462+
* opt in. On create, provided categories layer onto the default set. On update,
2463+
* provided categories merge onto the session's current config; when no telemetry
2464+
* is active this falls back to the default set (matching create). If browser is
2465+
* omitted or empty, the default set is used. A browser config that disables every
2466+
* category stops capture on update and starts no capture on create.
24672467
*/
24682468
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
24692469

src/resources/browser-pools.ts

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -679,12 +679,12 @@ export namespace BrowserPoolCreateParams {
679679
* Per-category capture flags. The operational categories (control, connection,
680680
* system, captcha) are captured whenever telemetry is enabled; set one to
681681
* enabled=false to opt out. The CDP categories (console, network, page,
682-
* interaction) and screenshot are off by default; set enabled=true to opt in. On
683-
* create, provided categories layer onto the default set. On update, provided
684-
* categories merge onto the session's current config; when no telemetry is active
685-
* this falls back to the default set (matching create). If browser is omitted or
686-
* empty, the default set is used. A browser config that disables every category
687-
* stops capture on update and starts no capture on create.
682+
* interaction), screenshot and platform are off by default; set enabled=true to
683+
* opt in. On create, provided categories layer onto the default set. On update,
684+
* provided categories merge onto the session's current config; when no telemetry
685+
* is active this falls back to the default set (matching create). If browser is
686+
* omitted or empty, the default set is used. A browser config that disables every
687+
* category stops capture on update and starts no capture on create.
688688
*/
689689
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
690690

@@ -930,12 +930,12 @@ export namespace BrowserPoolUpdateParams {
930930
* Per-category capture flags. The operational categories (control, connection,
931931
* system, captcha) are captured whenever telemetry is enabled; set one to
932932
* enabled=false to opt out. The CDP categories (console, network, page,
933-
* interaction) and screenshot are off by default; set enabled=true to opt in. On
934-
* create, provided categories layer onto the default set. On update, provided
935-
* categories merge onto the session's current config; when no telemetry is active
936-
* this falls back to the default set (matching create). If browser is omitted or
937-
* empty, the default set is used. A browser config that disables every category
938-
* stops capture on update and starts no capture on create.
933+
* interaction), screenshot and platform are off by default; set enabled=true to
934+
* opt in. On create, provided categories layer onto the default set. On update,
935+
* provided categories merge onto the session's current config; when no telemetry
936+
* is active this falls back to the default set (matching create). If browser is
937+
* omitted or empty, the default set is used. A browser config that disables every
938+
* category stops capture on update and starts no capture on create.
939939
*/
940940
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
941941

@@ -1098,12 +1098,12 @@ export namespace BrowserPoolAcquireParams {
10981098
* Per-category capture flags. The operational categories (control, connection,
10991099
* system, captcha) are captured whenever telemetry is enabled; set one to
11001100
* enabled=false to opt out. The CDP categories (console, network, page,
1101-
* interaction) and screenshot are off by default; set enabled=true to opt in. On
1102-
* create, provided categories layer onto the default set. On update, provided
1103-
* categories merge onto the session's current config; when no telemetry is active
1104-
* this falls back to the default set (matching create). If browser is omitted or
1105-
* empty, the default set is used. A browser config that disables every category
1106-
* stops capture on update and starts no capture on create.
1101+
* interaction), screenshot and platform are off by default; set enabled=true to
1102+
* opt in. On create, provided categories layer onto the default set. On update,
1103+
* provided categories merge onto the session's current config; when no telemetry
1104+
* is active this falls back to the default set (matching create). If browser is
1105+
* omitted or empty, the default set is used. A browser config that disables every
1106+
* category stops capture on update and starts no capture on create.
11071107
*/
11081108
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
11091109

0 commit comments

Comments
 (0)