@onkernel/sdk 0.55.0 → 0.58.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/CHANGELOG.md +34 -0
- package/api-promise.d.mts +1 -0
- package/api-promise.d.mts.map +1 -1
- package/api-promise.d.ts +1 -0
- package/api-promise.d.ts.map +1 -1
- package/api-promise.mjs +1 -0
- package/api-promise.mjs.map +1 -1
- package/client.d.mts +8 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +8 -2
- package/client.d.ts.map +1 -1
- package/client.js +6 -0
- package/client.js.map +1 -1
- package/client.mjs +6 -0
- package/client.mjs.map +1 -1
- package/core/api-promise.d.mts.map +1 -1
- package/core/api-promise.d.ts.map +1 -1
- package/core/api-promise.mjs.map +1 -1
- package/core/error.mjs.map +1 -1
- package/core/pagination.d.mts.map +1 -1
- package/core/pagination.d.ts.map +1 -1
- package/core/pagination.mjs.map +1 -1
- package/core/resource.d.mts.map +1 -1
- package/core/resource.d.ts.map +1 -1
- package/core/streaming.d.mts.map +1 -1
- package/core/streaming.d.ts.map +1 -1
- package/core/streaming.mjs.map +1 -1
- package/core/uploads.d.mts.map +1 -1
- package/core/uploads.d.ts.map +1 -1
- package/core/uploads.mjs.map +1 -1
- package/error.d.mts +1 -0
- package/error.d.mts.map +1 -1
- package/error.d.ts +1 -0
- package/error.d.ts.map +1 -1
- package/error.mjs +1 -0
- package/error.mjs.map +1 -1
- package/index.d.mts.map +1 -1
- package/index.d.ts.map +1 -1
- package/index.mjs.map +1 -1
- package/internal/decoders/line.mjs.map +1 -1
- package/internal/detect-platform.mjs.map +1 -1
- package/internal/headers.mjs.map +1 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.mjs.map +1 -1
- package/internal/request-options.d.mts.map +1 -1
- package/internal/request-options.d.ts.map +1 -1
- package/internal/shims.d.mts +6 -0
- package/internal/shims.d.mts.map +1 -1
- package/internal/shims.d.ts +6 -0
- package/internal/shims.d.ts.map +1 -1
- package/internal/to-file.d.mts.map +1 -1
- package/internal/to-file.d.ts.map +1 -1
- package/internal/to-file.mjs.map +1 -1
- package/internal/types.d.mts +4 -4
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +4 -4
- package/internal/types.d.ts.map +1 -1
- package/internal/uploads.d.mts.map +1 -1
- package/internal/uploads.d.ts.map +1 -1
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/base64.mjs.map +1 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.mjs.map +1 -1
- package/internal/utils/path.mjs.map +1 -1
- package/internal/utils/query.mjs.map +1 -1
- package/internal/utils/values.mjs.map +1 -1
- package/internal/utils.d.mts.map +1 -1
- package/internal/utils.d.ts.map +1 -1
- package/internal/utils.mjs.map +1 -1
- package/lib/browser-fetch.d.mts.map +1 -1
- package/lib/browser-fetch.d.ts.map +1 -1
- package/lib/browser-fetch.mjs.map +1 -1
- package/lib/browser-routing.d.mts.map +1 -1
- package/lib/browser-routing.d.ts.map +1 -1
- package/lib/browser-routing.mjs.map +1 -1
- package/package.json +1 -1
- package/pagination.d.mts +1 -0
- package/pagination.d.mts.map +1 -1
- package/pagination.d.ts +1 -0
- package/pagination.d.ts.map +1 -1
- package/pagination.mjs +1 -0
- package/pagination.mjs.map +1 -1
- package/resource.d.mts +1 -0
- package/resource.d.mts.map +1 -1
- package/resource.d.ts +1 -0
- package/resource.d.ts.map +1 -1
- package/resource.mjs +1 -0
- package/resource.mjs.map +1 -1
- package/resources/api-keys.d.mts +146 -0
- package/resources/api-keys.d.mts.map +1 -0
- package/resources/api-keys.d.ts +146 -0
- package/resources/api-keys.d.ts.map +1 -0
- package/resources/api-keys.js +81 -0
- package/resources/api-keys.js.map +1 -0
- package/resources/api-keys.mjs +77 -0
- package/resources/api-keys.mjs.map +1 -0
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts.map +1 -1
- package/resources/apps.mjs.map +1 -1
- package/resources/auth/auth.d.mts.map +1 -1
- package/resources/auth/auth.d.ts.map +1 -1
- package/resources/auth/auth.mjs.map +1 -1
- package/resources/auth/connections.d.mts +35 -5
- package/resources/auth/connections.d.mts.map +1 -1
- package/resources/auth/connections.d.ts +35 -5
- package/resources/auth/connections.d.ts.map +1 -1
- package/resources/auth/connections.mjs.map +1 -1
- package/resources/auth/index.d.mts.map +1 -1
- package/resources/auth/index.d.ts.map +1 -1
- package/resources/auth/index.mjs.map +1 -1
- package/resources/auth.d.mts.map +1 -1
- package/resources/auth.d.ts.map +1 -1
- package/resources/auth.mjs.map +1 -1
- package/resources/browser-pools.d.mts +33 -15
- package/resources/browser-pools.d.mts.map +1 -1
- package/resources/browser-pools.d.ts +33 -15
- package/resources/browser-pools.d.ts.map +1 -1
- package/resources/browser-pools.js.map +1 -1
- package/resources/browser-pools.mjs.map +1 -1
- package/resources/browsers/browsers.d.mts +144 -53
- package/resources/browsers/browsers.d.mts.map +1 -1
- package/resources/browsers/browsers.d.ts +144 -53
- package/resources/browsers/browsers.d.ts.map +1 -1
- package/resources/browsers/browsers.js +4 -14
- package/resources/browsers/browsers.js.map +1 -1
- package/resources/browsers/browsers.mjs +4 -14
- package/resources/browsers/browsers.mjs.map +1 -1
- package/resources/browsers/computer.d.mts.map +1 -1
- package/resources/browsers/computer.d.ts.map +1 -1
- package/resources/browsers/computer.mjs.map +1 -1
- package/resources/browsers/fs/fs.d.mts.map +1 -1
- package/resources/browsers/fs/fs.d.ts.map +1 -1
- package/resources/browsers/fs/fs.mjs.map +1 -1
- package/resources/browsers/fs/index.d.mts.map +1 -1
- package/resources/browsers/fs/index.d.ts.map +1 -1
- package/resources/browsers/fs/index.mjs.map +1 -1
- package/resources/browsers/fs/watch.d.mts.map +1 -1
- package/resources/browsers/fs/watch.d.ts.map +1 -1
- package/resources/browsers/fs/watch.mjs.map +1 -1
- package/resources/browsers/fs.d.mts.map +1 -1
- package/resources/browsers/fs.d.ts.map +1 -1
- package/resources/browsers/fs.mjs.map +1 -1
- package/resources/browsers/index.d.mts +2 -1
- package/resources/browsers/index.d.mts.map +1 -1
- package/resources/browsers/index.d.ts +2 -1
- package/resources/browsers/index.d.ts.map +1 -1
- package/resources/browsers/index.js +3 -1
- package/resources/browsers/index.js.map +1 -1
- package/resources/browsers/index.mjs +1 -0
- package/resources/browsers/index.mjs.map +1 -1
- package/resources/browsers/logs.d.mts.map +1 -1
- package/resources/browsers/logs.d.ts.map +1 -1
- package/resources/browsers/logs.mjs.map +1 -1
- package/resources/browsers/playwright.d.mts.map +1 -1
- package/resources/browsers/playwright.d.ts.map +1 -1
- package/resources/browsers/playwright.mjs.map +1 -1
- package/resources/browsers/process.d.mts.map +1 -1
- package/resources/browsers/process.d.ts.map +1 -1
- package/resources/browsers/process.mjs.map +1 -1
- package/resources/browsers/replays.d.mts.map +1 -1
- package/resources/browsers/replays.d.ts.map +1 -1
- package/resources/browsers/replays.mjs.map +1 -1
- package/resources/browsers/telemetry.d.mts +1230 -0
- package/resources/browsers/telemetry.d.mts.map +1 -0
- package/resources/browsers/telemetry.d.ts +1230 -0
- package/resources/browsers/telemetry.d.ts.map +1 -0
- package/resources/browsers/telemetry.js +45 -0
- package/resources/browsers/telemetry.js.map +1 -0
- package/resources/browsers/telemetry.mjs +41 -0
- package/resources/browsers/telemetry.mjs.map +1 -0
- package/resources/browsers.d.mts.map +1 -1
- package/resources/browsers.d.ts.map +1 -1
- package/resources/browsers.mjs.map +1 -1
- package/resources/credential-providers.d.mts.map +1 -1
- package/resources/credential-providers.d.ts.map +1 -1
- package/resources/credential-providers.mjs.map +1 -1
- package/resources/credentials.d.mts.map +1 -1
- package/resources/credentials.d.ts.map +1 -1
- package/resources/credentials.mjs.map +1 -1
- package/resources/deployments.d.mts.map +1 -1
- package/resources/deployments.d.ts.map +1 -1
- package/resources/deployments.mjs.map +1 -1
- package/resources/extensions.d.mts.map +1 -1
- package/resources/extensions.d.ts.map +1 -1
- package/resources/extensions.mjs.map +1 -1
- package/resources/index.d.mts +2 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/invocations.d.mts +18 -6
- package/resources/invocations.d.mts.map +1 -1
- package/resources/invocations.d.ts +18 -6
- package/resources/invocations.d.ts.map +1 -1
- package/resources/invocations.js.map +1 -1
- package/resources/invocations.mjs.map +1 -1
- package/resources/profiles.d.mts.map +1 -1
- package/resources/profiles.d.ts.map +1 -1
- package/resources/profiles.mjs.map +1 -1
- package/resources/projects/index.d.mts.map +1 -1
- package/resources/projects/index.d.ts.map +1 -1
- package/resources/projects/index.mjs.map +1 -1
- package/resources/projects/limits.d.mts +0 -15
- package/resources/projects/limits.d.mts.map +1 -1
- package/resources/projects/limits.d.ts +0 -15
- package/resources/projects/limits.d.ts.map +1 -1
- package/resources/projects/limits.js +2 -2
- package/resources/projects/limits.js.map +1 -1
- package/resources/projects/limits.mjs +2 -2
- package/resources/projects/limits.mjs.map +1 -1
- package/resources/projects/projects.d.mts +1 -2
- package/resources/projects/projects.d.mts.map +1 -1
- package/resources/projects/projects.d.ts +1 -2
- package/resources/projects/projects.d.ts.map +1 -1
- package/resources/projects/projects.js +6 -7
- package/resources/projects/projects.js.map +1 -1
- package/resources/projects/projects.mjs +6 -7
- package/resources/projects/projects.mjs.map +1 -1
- package/resources/projects.d.mts.map +1 -1
- package/resources/projects.d.ts.map +1 -1
- package/resources/projects.mjs.map +1 -1
- package/resources/proxies.d.mts +3 -1
- package/resources/proxies.d.mts.map +1 -1
- package/resources/proxies.d.ts +3 -1
- package/resources/proxies.d.ts.map +1 -1
- package/resources/proxies.mjs.map +1 -1
- package/resources.d.mts.map +1 -1
- package/resources.d.ts.map +1 -1
- package/resources.mjs.map +1 -1
- package/src/client.ts +24 -4
- package/src/resources/api-keys.ts +195 -0
- package/src/resources/auth/connections.ts +49 -5
- package/src/resources/browser-pools.ts +33 -16
- package/src/resources/browsers/browsers.ts +218 -69
- package/src/resources/browsers/index.ts +35 -2
- package/src/resources/browsers/telemetry.ts +1521 -0
- package/src/resources/index.ts +9 -2
- package/src/resources/invocations.ts +18 -7
- package/src/resources/projects/limits.ts +2 -20
- package/src/resources/projects/projects.ts +6 -7
- package/src/resources/proxies.ts +3 -1
- package/src/version.ts +1 -1
- package/streaming.d.mts +1 -0
- package/streaming.d.mts.map +1 -1
- package/streaming.d.ts +1 -0
- package/streaming.d.ts.map +1 -1
- package/streaming.mjs +1 -0
- package/streaming.mjs.map +1 -1
- package/uploads.d.mts +1 -0
- package/uploads.d.mts.map +1 -1
- package/uploads.d.ts +1 -0
- package/uploads.d.ts.map +1 -1
- package/uploads.mjs +1 -0
- package/uploads.mjs.map +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -51,6 +51,42 @@ import {
|
|
|
51
51
|
ReplayStopParams,
|
|
52
52
|
Replays,
|
|
53
53
|
} from './replays';
|
|
54
|
+
import * as TelemetryAPI from './telemetry';
|
|
55
|
+
import {
|
|
56
|
+
BrowserCallStack,
|
|
57
|
+
BrowserConsoleErrorEvent,
|
|
58
|
+
BrowserConsoleLogEvent,
|
|
59
|
+
BrowserEventContext,
|
|
60
|
+
BrowserEventSource,
|
|
61
|
+
BrowserHTTPHeaders,
|
|
62
|
+
BrowserInteractionClickEvent,
|
|
63
|
+
BrowserInteractionKeyEvent,
|
|
64
|
+
BrowserInteractionScrollSettledEvent,
|
|
65
|
+
BrowserMonitorDisconnectedEvent,
|
|
66
|
+
BrowserMonitorInitFailedEvent,
|
|
67
|
+
BrowserMonitorReconnectFailedEvent,
|
|
68
|
+
BrowserMonitorReconnectedEvent,
|
|
69
|
+
BrowserMonitorScreenshotEvent,
|
|
70
|
+
BrowserNetworkIdleEvent,
|
|
71
|
+
BrowserNetworkLoadingFailedEvent,
|
|
72
|
+
BrowserNetworkRequestEvent,
|
|
73
|
+
BrowserNetworkResponseEvent,
|
|
74
|
+
BrowserPageDomContentLoadedEvent,
|
|
75
|
+
BrowserPageLayoutSettledEvent,
|
|
76
|
+
BrowserPageLayoutShiftEvent,
|
|
77
|
+
BrowserPageLcpEvent,
|
|
78
|
+
BrowserPageLoadEvent,
|
|
79
|
+
BrowserPageNavigationEvent,
|
|
80
|
+
BrowserPageNavigationSettledEvent,
|
|
81
|
+
BrowserPageTabOpenedEvent,
|
|
82
|
+
BrowserTelemetryCategoriesConfig,
|
|
83
|
+
BrowserTelemetryCategoryConfig,
|
|
84
|
+
BrowserTelemetryConfig,
|
|
85
|
+
BrowserTelemetryEvent,
|
|
86
|
+
Telemetry as TelemetryAPITelemetry,
|
|
87
|
+
TelemetryStreamParams,
|
|
88
|
+
TelemetryStreamResponse,
|
|
89
|
+
} from './telemetry';
|
|
54
90
|
import * as FsAPI from './fs/fs';
|
|
55
91
|
import {
|
|
56
92
|
FCreateDirectoryParams,
|
|
@@ -82,6 +118,7 @@ import { browserFetch, type BrowserFetchInit } from '../../lib/browser-fetch';
|
|
|
82
118
|
* Create and manage browser sessions.
|
|
83
119
|
*/
|
|
84
120
|
export class Browsers extends APIResource {
|
|
121
|
+
telemetry: TelemetryAPI.Telemetry = new TelemetryAPI.Telemetry(this._client);
|
|
85
122
|
replays: ReplaysAPI.Replays = new ReplaysAPI.Replays(this._client);
|
|
86
123
|
fs: FsAPI.Fs = new FsAPI.Fs(this._client);
|
|
87
124
|
process: ProcessAPI.Process = new ProcessAPI.Process(this._client);
|
|
@@ -155,21 +192,6 @@ export class Browsers extends APIResource {
|
|
|
155
192
|
return this._client.getAPIList('/browsers', OffsetPagination<BrowserListResponse>, { query, ...options });
|
|
156
193
|
}
|
|
157
194
|
|
|
158
|
-
/**
|
|
159
|
-
* DEPRECATED: Use DELETE /browsers/{id} instead. Delete a persistent browser
|
|
160
|
-
* session by its persistent_id.
|
|
161
|
-
*
|
|
162
|
-
* @deprecated
|
|
163
|
-
*/
|
|
164
|
-
delete(params: BrowserDeleteParams, options?: RequestOptions): APIPromise<void> {
|
|
165
|
-
const { persistent_id } = params;
|
|
166
|
-
return this._client.delete('/browsers', {
|
|
167
|
-
query: { persistent_id },
|
|
168
|
-
...options,
|
|
169
|
-
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
170
|
-
});
|
|
171
|
-
}
|
|
172
|
-
|
|
173
195
|
/**
|
|
174
196
|
* Sends an HTTP request through Chrome's HTTP request stack, inheriting the
|
|
175
197
|
* browser's TLS fingerprint, cookies, proxy configuration, and headers. Returns a
|
|
@@ -242,17 +264,6 @@ export type BrowserListResponsesOffsetPagination = OffsetPagination<BrowserListR
|
|
|
242
264
|
|
|
243
265
|
export type ProfilesOffsetPagination = OffsetPagination<Profile>;
|
|
244
266
|
|
|
245
|
-
/**
|
|
246
|
-
* @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
|
|
247
|
-
* instead.
|
|
248
|
-
*/
|
|
249
|
-
export interface BrowserPersistence {
|
|
250
|
-
/**
|
|
251
|
-
* DEPRECATED: Unique identifier for the persistent browser session.
|
|
252
|
-
*/
|
|
253
|
-
id: string;
|
|
254
|
-
}
|
|
255
|
-
|
|
256
267
|
/**
|
|
257
268
|
* Browser pool this session was acquired from, if any.
|
|
258
269
|
*/
|
|
@@ -355,6 +366,13 @@ export interface BrowserCreateResponse {
|
|
|
355
366
|
*/
|
|
356
367
|
browser_live_view_url?: string;
|
|
357
368
|
|
|
369
|
+
/**
|
|
370
|
+
* Custom Chrome enterprise policy overrides that were applied to this browser
|
|
371
|
+
* session, if any. Echoed back for verification. Keys are Chrome enterprise policy
|
|
372
|
+
* names.
|
|
373
|
+
*/
|
|
374
|
+
chrome_policy?: { [key: string]: unknown };
|
|
375
|
+
|
|
358
376
|
/**
|
|
359
377
|
* When the browser session was soft-deleted. Only present for deleted sessions.
|
|
360
378
|
*/
|
|
@@ -371,12 +389,6 @@ export interface BrowserCreateResponse {
|
|
|
371
389
|
*/
|
|
372
390
|
kiosk_mode?: boolean;
|
|
373
391
|
|
|
374
|
-
/**
|
|
375
|
-
* @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
|
|
376
|
-
* instead.
|
|
377
|
-
*/
|
|
378
|
-
persistence?: BrowserPersistence;
|
|
379
|
-
|
|
380
392
|
/**
|
|
381
393
|
* Browser pool this session was acquired from, if any.
|
|
382
394
|
*/
|
|
@@ -393,10 +405,19 @@ export interface BrowserCreateResponse {
|
|
|
393
405
|
proxy_id?: string;
|
|
394
406
|
|
|
395
407
|
/**
|
|
396
|
-
*
|
|
408
|
+
* URL the session was asked to navigate to on creation, if any. Recorded for
|
|
409
|
+
* debugging. Navigation is fire-and-forget — the URL is dispatched to the browser
|
|
410
|
+
* without waiting for it to load, and any errors (DNS failure, bad status,
|
|
411
|
+
* timeout) are silently dropped. Captures what was requested, not what the browser
|
|
412
|
+
* actually loaded.
|
|
397
413
|
*/
|
|
398
414
|
start_url?: string;
|
|
399
415
|
|
|
416
|
+
/**
|
|
417
|
+
* Active telemetry configuration for the session, if any.
|
|
418
|
+
*/
|
|
419
|
+
telemetry?: TelemetryAPI.BrowserTelemetryConfig | null;
|
|
420
|
+
|
|
400
421
|
/**
|
|
401
422
|
* Session usage metrics.
|
|
402
423
|
*/
|
|
@@ -466,6 +487,13 @@ export interface BrowserRetrieveResponse {
|
|
|
466
487
|
*/
|
|
467
488
|
browser_live_view_url?: string;
|
|
468
489
|
|
|
490
|
+
/**
|
|
491
|
+
* Custom Chrome enterprise policy overrides that were applied to this browser
|
|
492
|
+
* session, if any. Echoed back for verification. Keys are Chrome enterprise policy
|
|
493
|
+
* names.
|
|
494
|
+
*/
|
|
495
|
+
chrome_policy?: { [key: string]: unknown };
|
|
496
|
+
|
|
469
497
|
/**
|
|
470
498
|
* When the browser session was soft-deleted. Only present for deleted sessions.
|
|
471
499
|
*/
|
|
@@ -482,12 +510,6 @@ export interface BrowserRetrieveResponse {
|
|
|
482
510
|
*/
|
|
483
511
|
kiosk_mode?: boolean;
|
|
484
512
|
|
|
485
|
-
/**
|
|
486
|
-
* @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
|
|
487
|
-
* instead.
|
|
488
|
-
*/
|
|
489
|
-
persistence?: BrowserPersistence;
|
|
490
|
-
|
|
491
513
|
/**
|
|
492
514
|
* Browser pool this session was acquired from, if any.
|
|
493
515
|
*/
|
|
@@ -504,10 +526,19 @@ export interface BrowserRetrieveResponse {
|
|
|
504
526
|
proxy_id?: string;
|
|
505
527
|
|
|
506
528
|
/**
|
|
507
|
-
*
|
|
529
|
+
* URL the session was asked to navigate to on creation, if any. Recorded for
|
|
530
|
+
* debugging. Navigation is fire-and-forget — the URL is dispatched to the browser
|
|
531
|
+
* without waiting for it to load, and any errors (DNS failure, bad status,
|
|
532
|
+
* timeout) are silently dropped. Captures what was requested, not what the browser
|
|
533
|
+
* actually loaded.
|
|
508
534
|
*/
|
|
509
535
|
start_url?: string;
|
|
510
536
|
|
|
537
|
+
/**
|
|
538
|
+
* Active telemetry configuration for the session, if any.
|
|
539
|
+
*/
|
|
540
|
+
telemetry?: TelemetryAPI.BrowserTelemetryConfig | null;
|
|
541
|
+
|
|
511
542
|
/**
|
|
512
543
|
* Session usage metrics.
|
|
513
544
|
*/
|
|
@@ -577,6 +608,13 @@ export interface BrowserUpdateResponse {
|
|
|
577
608
|
*/
|
|
578
609
|
browser_live_view_url?: string;
|
|
579
610
|
|
|
611
|
+
/**
|
|
612
|
+
* Custom Chrome enterprise policy overrides that were applied to this browser
|
|
613
|
+
* session, if any. Echoed back for verification. Keys are Chrome enterprise policy
|
|
614
|
+
* names.
|
|
615
|
+
*/
|
|
616
|
+
chrome_policy?: { [key: string]: unknown };
|
|
617
|
+
|
|
580
618
|
/**
|
|
581
619
|
* When the browser session was soft-deleted. Only present for deleted sessions.
|
|
582
620
|
*/
|
|
@@ -593,12 +631,6 @@ export interface BrowserUpdateResponse {
|
|
|
593
631
|
*/
|
|
594
632
|
kiosk_mode?: boolean;
|
|
595
633
|
|
|
596
|
-
/**
|
|
597
|
-
* @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
|
|
598
|
-
* instead.
|
|
599
|
-
*/
|
|
600
|
-
persistence?: BrowserPersistence;
|
|
601
|
-
|
|
602
634
|
/**
|
|
603
635
|
* Browser pool this session was acquired from, if any.
|
|
604
636
|
*/
|
|
@@ -615,10 +647,19 @@ export interface BrowserUpdateResponse {
|
|
|
615
647
|
proxy_id?: string;
|
|
616
648
|
|
|
617
649
|
/**
|
|
618
|
-
*
|
|
650
|
+
* URL the session was asked to navigate to on creation, if any. Recorded for
|
|
651
|
+
* debugging. Navigation is fire-and-forget — the URL is dispatched to the browser
|
|
652
|
+
* without waiting for it to load, and any errors (DNS failure, bad status,
|
|
653
|
+
* timeout) are silently dropped. Captures what was requested, not what the browser
|
|
654
|
+
* actually loaded.
|
|
619
655
|
*/
|
|
620
656
|
start_url?: string;
|
|
621
657
|
|
|
658
|
+
/**
|
|
659
|
+
* Active telemetry configuration for the session, if any.
|
|
660
|
+
*/
|
|
661
|
+
telemetry?: TelemetryAPI.BrowserTelemetryConfig | null;
|
|
662
|
+
|
|
622
663
|
/**
|
|
623
664
|
* Session usage metrics.
|
|
624
665
|
*/
|
|
@@ -688,6 +729,13 @@ export interface BrowserListResponse {
|
|
|
688
729
|
*/
|
|
689
730
|
browser_live_view_url?: string;
|
|
690
731
|
|
|
732
|
+
/**
|
|
733
|
+
* Custom Chrome enterprise policy overrides that were applied to this browser
|
|
734
|
+
* session, if any. Echoed back for verification. Keys are Chrome enterprise policy
|
|
735
|
+
* names.
|
|
736
|
+
*/
|
|
737
|
+
chrome_policy?: { [key: string]: unknown };
|
|
738
|
+
|
|
691
739
|
/**
|
|
692
740
|
* When the browser session was soft-deleted. Only present for deleted sessions.
|
|
693
741
|
*/
|
|
@@ -704,12 +752,6 @@ export interface BrowserListResponse {
|
|
|
704
752
|
*/
|
|
705
753
|
kiosk_mode?: boolean;
|
|
706
754
|
|
|
707
|
-
/**
|
|
708
|
-
* @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
|
|
709
|
-
* instead.
|
|
710
|
-
*/
|
|
711
|
-
persistence?: BrowserPersistence;
|
|
712
|
-
|
|
713
755
|
/**
|
|
714
756
|
* Browser pool this session was acquired from, if any.
|
|
715
757
|
*/
|
|
@@ -726,10 +768,19 @@ export interface BrowserListResponse {
|
|
|
726
768
|
proxy_id?: string;
|
|
727
769
|
|
|
728
770
|
/**
|
|
729
|
-
*
|
|
771
|
+
* URL the session was asked to navigate to on creation, if any. Recorded for
|
|
772
|
+
* debugging. Navigation is fire-and-forget — the URL is dispatched to the browser
|
|
773
|
+
* without waiting for it to load, and any errors (DNS failure, bad status,
|
|
774
|
+
* timeout) are silently dropped. Captures what was requested, not what the browser
|
|
775
|
+
* actually loaded.
|
|
730
776
|
*/
|
|
731
777
|
start_url?: string;
|
|
732
778
|
|
|
779
|
+
/**
|
|
780
|
+
* Active telemetry configuration for the session, if any.
|
|
781
|
+
*/
|
|
782
|
+
telemetry?: TelemetryAPI.BrowserTelemetryConfig | null;
|
|
783
|
+
|
|
733
784
|
/**
|
|
734
785
|
* Session usage metrics.
|
|
735
786
|
*/
|
|
@@ -778,6 +829,14 @@ export interface BrowserCurlResponse {
|
|
|
778
829
|
}
|
|
779
830
|
|
|
780
831
|
export interface BrowserCreateParams {
|
|
832
|
+
/**
|
|
833
|
+
* Custom Chrome enterprise policy overrides applied to this browser session. Keys
|
|
834
|
+
* are Chrome enterprise policy names; values must match their expected types.
|
|
835
|
+
* Blocked: kernel-managed policies (extensions, proxy, CDP/automation). See
|
|
836
|
+
* https://chromeenterprise.google/policies/
|
|
837
|
+
*/
|
|
838
|
+
chrome_policy?: { [key: string]: unknown };
|
|
839
|
+
|
|
781
840
|
/**
|
|
782
841
|
* List of browser extensions to load into the session. Provide each by id or name.
|
|
783
842
|
*/
|
|
@@ -806,12 +865,6 @@ export interface BrowserCreateParams {
|
|
|
806
865
|
*/
|
|
807
866
|
kiosk_mode?: boolean;
|
|
808
867
|
|
|
809
|
-
/**
|
|
810
|
-
* @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
|
|
811
|
-
* instead.
|
|
812
|
-
*/
|
|
813
|
-
persistence?: BrowserPersistence;
|
|
814
|
-
|
|
815
868
|
/**
|
|
816
869
|
* Profile selection for the browser session. Provide either id or name. If
|
|
817
870
|
* specified, the matching profile will be loaded into the browser session.
|
|
@@ -838,6 +891,15 @@ export interface BrowserCreateParams {
|
|
|
838
891
|
*/
|
|
839
892
|
stealth?: boolean;
|
|
840
893
|
|
|
894
|
+
/**
|
|
895
|
+
* Telemetry configuration for the browser session. Set enabled to true to start
|
|
896
|
+
* capture using VM defaults, or provide browser category settings. If omitted,
|
|
897
|
+
* null, set to an empty object ({}), set to enabled: false without browser
|
|
898
|
+
* category settings, or all four categories are explicitly disabled, capture is
|
|
899
|
+
* not started.
|
|
900
|
+
*/
|
|
901
|
+
telemetry?: BrowserCreateParams.Telemetry | null;
|
|
902
|
+
|
|
841
903
|
/**
|
|
842
904
|
* The number of seconds of inactivity before the browser session is terminated.
|
|
843
905
|
* Activity includes CDP connections and live view connections. Defaults to 60
|
|
@@ -864,6 +926,32 @@ export interface BrowserCreateParams {
|
|
|
864
926
|
viewport?: Shared.BrowserViewport;
|
|
865
927
|
}
|
|
866
928
|
|
|
929
|
+
export namespace BrowserCreateParams {
|
|
930
|
+
/**
|
|
931
|
+
* Telemetry configuration for the browser session. Set enabled to true to start
|
|
932
|
+
* capture using VM defaults, or provide browser category settings. If omitted,
|
|
933
|
+
* null, set to an empty object ({}), set to enabled: false without browser
|
|
934
|
+
* category settings, or all four categories are explicitly disabled, capture is
|
|
935
|
+
* not started.
|
|
936
|
+
*/
|
|
937
|
+
export interface Telemetry {
|
|
938
|
+
/**
|
|
939
|
+
* Per-category enable/disable flags. If enabled is true and browser is omitted or
|
|
940
|
+
* empty, the VM default category set is used. Explicitly disabling all four
|
|
941
|
+
* categories stops capture on update and starts no capture on create.
|
|
942
|
+
*/
|
|
943
|
+
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
|
|
944
|
+
|
|
945
|
+
/**
|
|
946
|
+
* Request shortcut for browser telemetry capture. True enables capture using VM
|
|
947
|
+
* defaults unless browser category settings are provided. False stops capture on
|
|
948
|
+
* update and starts no capture on create. enabled=false cannot be combined with
|
|
949
|
+
* browser category settings.
|
|
950
|
+
*/
|
|
951
|
+
enabled?: boolean;
|
|
952
|
+
}
|
|
953
|
+
}
|
|
954
|
+
|
|
867
955
|
export interface BrowserRetrieveParams {
|
|
868
956
|
/**
|
|
869
957
|
* When true, includes soft-deleted browser sessions in the lookup.
|
|
@@ -890,6 +978,15 @@ export interface BrowserUpdateParams {
|
|
|
890
978
|
*/
|
|
891
979
|
proxy_id?: string | null;
|
|
892
980
|
|
|
981
|
+
/**
|
|
982
|
+
* Telemetry configuration. Omit, set to null, or set to an empty object ({}) to
|
|
983
|
+
* leave the existing configuration unchanged. Set enabled to true to enable
|
|
984
|
+
* capture using VM defaults. Set enabled to false to stop capture. Provide browser
|
|
985
|
+
* category settings for per-category updates. Explicitly disabling all four
|
|
986
|
+
* categories also stops capture.
|
|
987
|
+
*/
|
|
988
|
+
telemetry?: BrowserUpdateParams.Telemetry | null;
|
|
989
|
+
|
|
893
990
|
/**
|
|
894
991
|
* Viewport configuration to apply to the browser session.
|
|
895
992
|
*/
|
|
@@ -897,6 +994,30 @@ export interface BrowserUpdateParams {
|
|
|
897
994
|
}
|
|
898
995
|
|
|
899
996
|
export namespace BrowserUpdateParams {
|
|
997
|
+
/**
|
|
998
|
+
* Telemetry configuration. Omit, set to null, or set to an empty object ({}) to
|
|
999
|
+
* leave the existing configuration unchanged. Set enabled to true to enable
|
|
1000
|
+
* capture using VM defaults. Set enabled to false to stop capture. Provide browser
|
|
1001
|
+
* category settings for per-category updates. Explicitly disabling all four
|
|
1002
|
+
* categories also stops capture.
|
|
1003
|
+
*/
|
|
1004
|
+
export interface Telemetry {
|
|
1005
|
+
/**
|
|
1006
|
+
* Per-category enable/disable flags. If enabled is true and browser is omitted or
|
|
1007
|
+
* empty, the VM default category set is used. Explicitly disabling all four
|
|
1008
|
+
* categories stops capture on update and starts no capture on create.
|
|
1009
|
+
*/
|
|
1010
|
+
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
|
|
1011
|
+
|
|
1012
|
+
/**
|
|
1013
|
+
* Request shortcut for browser telemetry capture. True enables capture using VM
|
|
1014
|
+
* defaults unless browser category settings are provided. False stops capture on
|
|
1015
|
+
* update and starts no capture on create. enabled=false cannot be combined with
|
|
1016
|
+
* browser category settings.
|
|
1017
|
+
*/
|
|
1018
|
+
enabled?: boolean;
|
|
1019
|
+
}
|
|
1020
|
+
|
|
900
1021
|
/**
|
|
901
1022
|
* Viewport configuration to apply to the browser session.
|
|
902
1023
|
*/
|
|
@@ -930,13 +1051,6 @@ export interface BrowserListParams extends OffsetPaginationParams {
|
|
|
930
1051
|
status?: 'active' | 'deleted' | 'all';
|
|
931
1052
|
}
|
|
932
1053
|
|
|
933
|
-
export interface BrowserDeleteParams {
|
|
934
|
-
/**
|
|
935
|
-
* Persistent browser identifier
|
|
936
|
-
*/
|
|
937
|
-
persistent_id: string;
|
|
938
|
-
}
|
|
939
|
-
|
|
940
1054
|
export interface BrowserCurlParams {
|
|
941
1055
|
/**
|
|
942
1056
|
* Target URL (must be http or https).
|
|
@@ -991,6 +1105,7 @@ export namespace BrowserLoadExtensionsParams {
|
|
|
991
1105
|
}
|
|
992
1106
|
}
|
|
993
1107
|
|
|
1108
|
+
Browsers.Telemetry = TelemetryAPITelemetry;
|
|
994
1109
|
Browsers.Replays = Replays;
|
|
995
1110
|
Browsers.Fs = Fs;
|
|
996
1111
|
Browsers.Process = Process;
|
|
@@ -1000,7 +1115,6 @@ Browsers.Playwright = Playwright;
|
|
|
1000
1115
|
|
|
1001
1116
|
export declare namespace Browsers {
|
|
1002
1117
|
export {
|
|
1003
|
-
type BrowserPersistence as BrowserPersistence,
|
|
1004
1118
|
type BrowserPoolRef as BrowserPoolRef,
|
|
1005
1119
|
type BrowserUsage as BrowserUsage,
|
|
1006
1120
|
type Profile as Profile,
|
|
@@ -1014,11 +1128,46 @@ export declare namespace Browsers {
|
|
|
1014
1128
|
type BrowserRetrieveParams as BrowserRetrieveParams,
|
|
1015
1129
|
type BrowserUpdateParams as BrowserUpdateParams,
|
|
1016
1130
|
type BrowserListParams as BrowserListParams,
|
|
1017
|
-
type BrowserDeleteParams as BrowserDeleteParams,
|
|
1018
1131
|
type BrowserCurlParams as BrowserCurlParams,
|
|
1019
1132
|
type BrowserLoadExtensionsParams as BrowserLoadExtensionsParams,
|
|
1020
1133
|
};
|
|
1021
1134
|
|
|
1135
|
+
export {
|
|
1136
|
+
TelemetryAPITelemetry as Telemetry,
|
|
1137
|
+
type BrowserCallStack as BrowserCallStack,
|
|
1138
|
+
type BrowserConsoleErrorEvent as BrowserConsoleErrorEvent,
|
|
1139
|
+
type BrowserConsoleLogEvent as BrowserConsoleLogEvent,
|
|
1140
|
+
type BrowserEventContext as BrowserEventContext,
|
|
1141
|
+
type BrowserEventSource as BrowserEventSource,
|
|
1142
|
+
type BrowserHTTPHeaders as BrowserHTTPHeaders,
|
|
1143
|
+
type BrowserInteractionClickEvent as BrowserInteractionClickEvent,
|
|
1144
|
+
type BrowserInteractionKeyEvent as BrowserInteractionKeyEvent,
|
|
1145
|
+
type BrowserInteractionScrollSettledEvent as BrowserInteractionScrollSettledEvent,
|
|
1146
|
+
type BrowserMonitorDisconnectedEvent as BrowserMonitorDisconnectedEvent,
|
|
1147
|
+
type BrowserMonitorInitFailedEvent as BrowserMonitorInitFailedEvent,
|
|
1148
|
+
type BrowserMonitorReconnectFailedEvent as BrowserMonitorReconnectFailedEvent,
|
|
1149
|
+
type BrowserMonitorReconnectedEvent as BrowserMonitorReconnectedEvent,
|
|
1150
|
+
type BrowserMonitorScreenshotEvent as BrowserMonitorScreenshotEvent,
|
|
1151
|
+
type BrowserNetworkIdleEvent as BrowserNetworkIdleEvent,
|
|
1152
|
+
type BrowserNetworkLoadingFailedEvent as BrowserNetworkLoadingFailedEvent,
|
|
1153
|
+
type BrowserNetworkRequestEvent as BrowserNetworkRequestEvent,
|
|
1154
|
+
type BrowserNetworkResponseEvent as BrowserNetworkResponseEvent,
|
|
1155
|
+
type BrowserPageDomContentLoadedEvent as BrowserPageDomContentLoadedEvent,
|
|
1156
|
+
type BrowserPageLayoutSettledEvent as BrowserPageLayoutSettledEvent,
|
|
1157
|
+
type BrowserPageLayoutShiftEvent as BrowserPageLayoutShiftEvent,
|
|
1158
|
+
type BrowserPageLcpEvent as BrowserPageLcpEvent,
|
|
1159
|
+
type BrowserPageLoadEvent as BrowserPageLoadEvent,
|
|
1160
|
+
type BrowserPageNavigationEvent as BrowserPageNavigationEvent,
|
|
1161
|
+
type BrowserPageNavigationSettledEvent as BrowserPageNavigationSettledEvent,
|
|
1162
|
+
type BrowserPageTabOpenedEvent as BrowserPageTabOpenedEvent,
|
|
1163
|
+
type BrowserTelemetryCategoriesConfig as BrowserTelemetryCategoriesConfig,
|
|
1164
|
+
type BrowserTelemetryCategoryConfig as BrowserTelemetryCategoryConfig,
|
|
1165
|
+
type BrowserTelemetryConfig as BrowserTelemetryConfig,
|
|
1166
|
+
type BrowserTelemetryEvent as BrowserTelemetryEvent,
|
|
1167
|
+
type TelemetryStreamResponse as TelemetryStreamResponse,
|
|
1168
|
+
type TelemetryStreamParams as TelemetryStreamParams,
|
|
1169
|
+
};
|
|
1170
|
+
|
|
1022
1171
|
export {
|
|
1023
1172
|
Replays as Replays,
|
|
1024
1173
|
type ReplayListResponse as ReplayListResponse,
|
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
export {
|
|
4
4
|
Browsers,
|
|
5
|
-
type BrowserPersistence,
|
|
6
5
|
type BrowserPoolRef,
|
|
7
6
|
type BrowserUsage,
|
|
8
7
|
type Profile,
|
|
@@ -15,7 +14,6 @@ export {
|
|
|
15
14
|
type BrowserRetrieveParams,
|
|
16
15
|
type BrowserUpdateParams,
|
|
17
16
|
type BrowserListParams,
|
|
18
|
-
type BrowserDeleteParams,
|
|
19
17
|
type BrowserCurlParams,
|
|
20
18
|
type BrowserLoadExtensionsParams,
|
|
21
19
|
type ProfilesOffsetPagination,
|
|
@@ -81,3 +79,38 @@ export {
|
|
|
81
79
|
type ReplayStartParams,
|
|
82
80
|
type ReplayStopParams,
|
|
83
81
|
} from './replays';
|
|
82
|
+
export {
|
|
83
|
+
Telemetry,
|
|
84
|
+
type BrowserCallStack,
|
|
85
|
+
type BrowserConsoleErrorEvent,
|
|
86
|
+
type BrowserConsoleLogEvent,
|
|
87
|
+
type BrowserEventContext,
|
|
88
|
+
type BrowserEventSource,
|
|
89
|
+
type BrowserHTTPHeaders,
|
|
90
|
+
type BrowserInteractionClickEvent,
|
|
91
|
+
type BrowserInteractionKeyEvent,
|
|
92
|
+
type BrowserInteractionScrollSettledEvent,
|
|
93
|
+
type BrowserMonitorDisconnectedEvent,
|
|
94
|
+
type BrowserMonitorInitFailedEvent,
|
|
95
|
+
type BrowserMonitorReconnectFailedEvent,
|
|
96
|
+
type BrowserMonitorReconnectedEvent,
|
|
97
|
+
type BrowserMonitorScreenshotEvent,
|
|
98
|
+
type BrowserNetworkIdleEvent,
|
|
99
|
+
type BrowserNetworkLoadingFailedEvent,
|
|
100
|
+
type BrowserNetworkRequestEvent,
|
|
101
|
+
type BrowserNetworkResponseEvent,
|
|
102
|
+
type BrowserPageDomContentLoadedEvent,
|
|
103
|
+
type BrowserPageLayoutSettledEvent,
|
|
104
|
+
type BrowserPageLayoutShiftEvent,
|
|
105
|
+
type BrowserPageLcpEvent,
|
|
106
|
+
type BrowserPageLoadEvent,
|
|
107
|
+
type BrowserPageNavigationEvent,
|
|
108
|
+
type BrowserPageNavigationSettledEvent,
|
|
109
|
+
type BrowserPageTabOpenedEvent,
|
|
110
|
+
type BrowserTelemetryCategoriesConfig,
|
|
111
|
+
type BrowserTelemetryCategoryConfig,
|
|
112
|
+
type BrowserTelemetryConfig,
|
|
113
|
+
type BrowserTelemetryEvent,
|
|
114
|
+
type TelemetryStreamResponse,
|
|
115
|
+
type TelemetryStreamParams,
|
|
116
|
+
} from './telemetry';
|