@onkernel/sdk 0.73.0 → 0.75.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 +29 -0
- package/package.json +1 -1
- package/resources/api-keys.d.mts +2 -1
- package/resources/api-keys.d.mts.map +1 -1
- package/resources/api-keys.d.ts +2 -1
- package/resources/api-keys.d.ts.map +1 -1
- package/resources/api-keys.js +2 -1
- package/resources/api-keys.js.map +1 -1
- package/resources/api-keys.mjs +2 -1
- package/resources/api-keys.mjs.map +1 -1
- package/resources/apps.d.mts +3 -1
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +3 -1
- package/resources/apps.d.ts.map +1 -1
- package/resources/browser-pools.d.mts +107 -72
- package/resources/browser-pools.d.mts.map +1 -1
- package/resources/browser-pools.d.ts +107 -72
- package/resources/browser-pools.d.ts.map +1 -1
- package/resources/browser-pools.js +3 -1
- package/resources/browser-pools.js.map +1 -1
- package/resources/browser-pools.mjs +3 -1
- package/resources/browser-pools.mjs.map +1 -1
- package/resources/browsers/browsers.d.mts +40 -40
- package/resources/browsers/browsers.d.ts +40 -40
- package/resources/browsers/telemetry.d.mts +13 -4
- package/resources/browsers/telemetry.d.mts.map +1 -1
- package/resources/browsers/telemetry.d.ts +13 -4
- package/resources/browsers/telemetry.d.ts.map +1 -1
- package/resources/browsers/telemetry.js +4 -4
- package/resources/browsers/telemetry.mjs +4 -4
- package/resources/deployments.d.mts +14 -5
- package/resources/deployments.d.mts.map +1 -1
- package/resources/deployments.d.ts +14 -5
- package/resources/deployments.d.ts.map +1 -1
- package/resources/extensions.d.mts +24 -0
- package/resources/extensions.d.mts.map +1 -1
- package/resources/extensions.d.ts +24 -0
- package/resources/extensions.d.ts.map +1 -1
- package/resources/invocations.d.mts +8 -8
- package/resources/invocations.d.ts +8 -8
- package/resources/shared.d.mts +8 -8
- package/resources/shared.d.ts +8 -8
- package/src/resources/api-keys.ts +2 -1
- package/src/resources/apps.ts +3 -1
- package/src/resources/browser-pools.ts +112 -72
- package/src/resources/browsers/browsers.ts +40 -40
- package/src/resources/browsers/telemetry.ts +14 -4
- package/src/resources/deployments.ts +14 -5
- package/src/resources/extensions.ts +27 -0
- package/src/resources/invocations.ts +8 -8
- package/src/resources/shared.ts +8 -8
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/shared.d.mts
CHANGED
|
@@ -62,14 +62,14 @@ export interface BrowserProfile {
|
|
|
62
62
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
63
63
|
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
|
|
64
64
|
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
|
|
65
|
-
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For
|
|
66
|
-
* presets use one of these resolutions with refresh rates
|
|
67
|
-
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
68
|
-
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
69
|
-
* Viewports outside this list may exhibit unstable live view
|
|
70
|
-
* behavior. If refresh_rate is not provided, it will be automatically
|
|
71
|
-
* based on the resolution (higher resolutions use lower refresh rates
|
|
72
|
-
* bandwidth reasonable).
|
|
65
|
+
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For
|
|
66
|
+
* GPU images, recommended presets use one of these resolutions with refresh rates
|
|
67
|
+
* 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
68
|
+
* 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
69
|
+
* 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view
|
|
70
|
+
* or recording behavior. If refresh_rate is not provided, it will be automatically
|
|
71
|
+
* determined based on the resolution (higher resolutions use lower refresh rates
|
|
72
|
+
* to keep bandwidth reasonable).
|
|
73
73
|
*/
|
|
74
74
|
export interface BrowserViewport {
|
|
75
75
|
/**
|
package/resources/shared.d.ts
CHANGED
|
@@ -62,14 +62,14 @@ export interface BrowserProfile {
|
|
|
62
62
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
63
63
|
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
|
|
64
64
|
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
|
|
65
|
-
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For
|
|
66
|
-
* presets use one of these resolutions with refresh rates
|
|
67
|
-
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
68
|
-
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
69
|
-
* Viewports outside this list may exhibit unstable live view
|
|
70
|
-
* behavior. If refresh_rate is not provided, it will be automatically
|
|
71
|
-
* based on the resolution (higher resolutions use lower refresh rates
|
|
72
|
-
* bandwidth reasonable).
|
|
65
|
+
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For
|
|
66
|
+
* GPU images, recommended presets use one of these resolutions with refresh rates
|
|
67
|
+
* 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
68
|
+
* 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
69
|
+
* 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view
|
|
70
|
+
* or recording behavior. If refresh_rate is not provided, it will be automatically
|
|
71
|
+
* determined based on the resolution (higher resolutions use lower refresh rates
|
|
72
|
+
* to keep bandwidth reasonable).
|
|
73
73
|
*/
|
|
74
74
|
export interface BrowserViewport {
|
|
75
75
|
/**
|
package/src/resources/apps.ts
CHANGED
|
@@ -47,7 +47,9 @@ export interface AppListResponse {
|
|
|
47
47
|
deployment: string;
|
|
48
48
|
|
|
49
49
|
/**
|
|
50
|
-
* Environment variables configured for this app version
|
|
50
|
+
* Environment variables configured for this app version. Values are redacted for
|
|
51
|
+
* API key, OAuth, and managed-auth callers, which receive every key with an empty
|
|
52
|
+
* string value. Only dashboard sessions receive the actual values.
|
|
51
53
|
*/
|
|
52
54
|
env_vars: { [key: string]: string };
|
|
53
55
|
|
|
@@ -48,7 +48,9 @@ export class BrowserPools extends APIResource {
|
|
|
48
48
|
/**
|
|
49
49
|
* Updates the configuration used to create browsers in the pool. As with creation,
|
|
50
50
|
* save_changes on the pool profile is ignored (not rejected); pooled browsers
|
|
51
|
-
* never persist changes back to the profile.
|
|
51
|
+
* never persist changes back to the profile. To clear the profile reference, send
|
|
52
|
+
* `profile: { "id": "" }`. Clearing the profile also disables
|
|
53
|
+
* `refresh_on_profile_update`.
|
|
52
54
|
*
|
|
53
55
|
* @example
|
|
54
56
|
* ```ts
|
|
@@ -186,10 +188,26 @@ export interface BrowserPool {
|
|
|
186
188
|
*/
|
|
187
189
|
created_at: string;
|
|
188
190
|
|
|
191
|
+
/**
|
|
192
|
+
* Resolved extension IDs attached to the pool, in configured load order. Empty
|
|
193
|
+
* when no extensions are attached. Authoritative for programmatic consumers; the
|
|
194
|
+
* extensions inside `browser_pool_config` reflect the configured selector (echoed
|
|
195
|
+
* as sent on create).
|
|
196
|
+
*/
|
|
197
|
+
extension_ids: Array<string>;
|
|
198
|
+
|
|
189
199
|
/**
|
|
190
200
|
* Browser pool name, if set
|
|
191
201
|
*/
|
|
192
202
|
name?: string;
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* Resolved profile ID the pool is attached to. Omitted when no profile is
|
|
206
|
+
* attached. Authoritative for programmatic consumers; the profile inside
|
|
207
|
+
* `browser_pool_config` reflects the configured selector (echoed as sent on
|
|
208
|
+
* create).
|
|
209
|
+
*/
|
|
210
|
+
profile_id?: string;
|
|
193
211
|
}
|
|
194
212
|
|
|
195
213
|
export namespace BrowserPool {
|
|
@@ -241,12 +259,11 @@ export namespace BrowserPool {
|
|
|
241
259
|
name?: string;
|
|
242
260
|
|
|
243
261
|
/**
|
|
244
|
-
* Profile
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
249
|
-
* rejected, so callers reusing a single-session profile object will not error.
|
|
262
|
+
* Profile configuration for browsers in a pool. Provide either id or name.
|
|
263
|
+
* Profiles must be created beforehand. Unlike single browser sessions, pools load
|
|
264
|
+
* the profile read-only and never persist changes back to it, so save_changes is
|
|
265
|
+
* omitted here. Any save_changes value sent on a pool profile is silently ignored
|
|
266
|
+
* rather than rejected.
|
|
250
267
|
*/
|
|
251
268
|
profile?: BrowserPoolConfig.Profile;
|
|
252
269
|
|
|
@@ -256,6 +273,13 @@ export namespace BrowserPool {
|
|
|
256
273
|
*/
|
|
257
274
|
proxy_id?: string;
|
|
258
275
|
|
|
276
|
+
/**
|
|
277
|
+
* When true, flush idle browsers when the profile the pool uses is updated, so
|
|
278
|
+
* pool browsers pick up the latest profile data. Requires a profile to be set on
|
|
279
|
+
* the pool.
|
|
280
|
+
*/
|
|
281
|
+
refresh_on_profile_update?: boolean;
|
|
282
|
+
|
|
259
283
|
/**
|
|
260
284
|
* Optional URL to navigate to when a new browser is warmed into the pool.
|
|
261
285
|
* Best-effort: failures to navigate do not fail pool fill. Only applied to
|
|
@@ -282,26 +306,25 @@ export namespace BrowserPool {
|
|
|
282
306
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
283
307
|
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
|
|
284
308
|
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
|
|
285
|
-
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For
|
|
286
|
-
* presets use one of these resolutions with refresh rates
|
|
287
|
-
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
288
|
-
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
289
|
-
* Viewports outside this list may exhibit unstable live view
|
|
290
|
-
* behavior. If refresh_rate is not provided, it will be automatically
|
|
291
|
-
* based on the resolution (higher resolutions use lower refresh rates
|
|
292
|
-
* bandwidth reasonable).
|
|
309
|
+
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For
|
|
310
|
+
* GPU images, recommended presets use one of these resolutions with refresh rates
|
|
311
|
+
* 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
312
|
+
* 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
313
|
+
* 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view
|
|
314
|
+
* or recording behavior. If refresh_rate is not provided, it will be automatically
|
|
315
|
+
* determined based on the resolution (higher resolutions use lower refresh rates
|
|
316
|
+
* to keep bandwidth reasonable).
|
|
293
317
|
*/
|
|
294
318
|
viewport?: Shared.BrowserViewport;
|
|
295
319
|
}
|
|
296
320
|
|
|
297
321
|
export namespace BrowserPoolConfig {
|
|
298
322
|
/**
|
|
299
|
-
* Profile
|
|
300
|
-
*
|
|
301
|
-
*
|
|
302
|
-
*
|
|
303
|
-
*
|
|
304
|
-
* rejected, so callers reusing a single-session profile object will not error.
|
|
323
|
+
* Profile configuration for browsers in a pool. Provide either id or name.
|
|
324
|
+
* Profiles must be created beforehand. Unlike single browser sessions, pools load
|
|
325
|
+
* the profile read-only and never persist changes back to it, so save_changes is
|
|
326
|
+
* omitted here. Any save_changes value sent on a pool profile is silently ignored
|
|
327
|
+
* rather than rejected.
|
|
305
328
|
*/
|
|
306
329
|
export interface Profile {
|
|
307
330
|
/**
|
|
@@ -438,14 +461,14 @@ export interface BrowserPoolAcquireResponse {
|
|
|
438
461
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
439
462
|
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
|
|
440
463
|
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
|
|
441
|
-
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For
|
|
442
|
-
* presets use one of these resolutions with refresh rates
|
|
443
|
-
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
444
|
-
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
445
|
-
* Viewports outside this list may exhibit unstable live view
|
|
446
|
-
* behavior. If refresh_rate is not provided, it will be automatically
|
|
447
|
-
* based on the resolution (higher resolutions use lower refresh rates
|
|
448
|
-
* bandwidth reasonable).
|
|
464
|
+
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For
|
|
465
|
+
* GPU images, recommended presets use one of these resolutions with refresh rates
|
|
466
|
+
* 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
467
|
+
* 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
468
|
+
* 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view
|
|
469
|
+
* or recording behavior. If refresh_rate is not provided, it will be automatically
|
|
470
|
+
* determined based on the resolution (higher resolutions use lower refresh rates
|
|
471
|
+
* to keep bandwidth reasonable).
|
|
449
472
|
*/
|
|
450
473
|
viewport?: Shared.BrowserViewport;
|
|
451
474
|
}
|
|
@@ -495,12 +518,11 @@ export interface BrowserPoolCreateParams {
|
|
|
495
518
|
name?: string;
|
|
496
519
|
|
|
497
520
|
/**
|
|
498
|
-
* Profile
|
|
499
|
-
*
|
|
500
|
-
*
|
|
501
|
-
*
|
|
502
|
-
*
|
|
503
|
-
* rejected, so callers reusing a single-session profile object will not error.
|
|
521
|
+
* Profile configuration for browsers in a pool. Provide either id or name.
|
|
522
|
+
* Profiles must be created beforehand. Unlike single browser sessions, pools load
|
|
523
|
+
* the profile read-only and never persist changes back to it, so save_changes is
|
|
524
|
+
* omitted here. Any save_changes value sent on a pool profile is silently ignored
|
|
525
|
+
* rather than rejected.
|
|
504
526
|
*/
|
|
505
527
|
profile?: BrowserPoolCreateParams.Profile;
|
|
506
528
|
|
|
@@ -510,6 +532,13 @@ export interface BrowserPoolCreateParams {
|
|
|
510
532
|
*/
|
|
511
533
|
proxy_id?: string;
|
|
512
534
|
|
|
535
|
+
/**
|
|
536
|
+
* When true, flush idle browsers when the profile the pool uses is updated, so
|
|
537
|
+
* pool browsers pick up the latest profile data. Requires a profile to be set on
|
|
538
|
+
* the pool.
|
|
539
|
+
*/
|
|
540
|
+
refresh_on_profile_update?: boolean;
|
|
541
|
+
|
|
513
542
|
/**
|
|
514
543
|
* Optional URL to navigate to when a new browser is warmed into the pool.
|
|
515
544
|
* Best-effort: failures to navigate do not fail pool fill. Only applied to
|
|
@@ -536,26 +565,25 @@ export interface BrowserPoolCreateParams {
|
|
|
536
565
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
537
566
|
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
|
|
538
567
|
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
|
|
539
|
-
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For
|
|
540
|
-
* presets use one of these resolutions with refresh rates
|
|
541
|
-
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
542
|
-
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
543
|
-
* Viewports outside this list may exhibit unstable live view
|
|
544
|
-
* behavior. If refresh_rate is not provided, it will be automatically
|
|
545
|
-
* based on the resolution (higher resolutions use lower refresh rates
|
|
546
|
-
* bandwidth reasonable).
|
|
568
|
+
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For
|
|
569
|
+
* GPU images, recommended presets use one of these resolutions with refresh rates
|
|
570
|
+
* 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
571
|
+
* 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
572
|
+
* 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view
|
|
573
|
+
* or recording behavior. If refresh_rate is not provided, it will be automatically
|
|
574
|
+
* determined based on the resolution (higher resolutions use lower refresh rates
|
|
575
|
+
* to keep bandwidth reasonable).
|
|
547
576
|
*/
|
|
548
577
|
viewport?: Shared.BrowserViewport;
|
|
549
578
|
}
|
|
550
579
|
|
|
551
580
|
export namespace BrowserPoolCreateParams {
|
|
552
581
|
/**
|
|
553
|
-
* Profile
|
|
554
|
-
*
|
|
555
|
-
*
|
|
556
|
-
*
|
|
557
|
-
*
|
|
558
|
-
* rejected, so callers reusing a single-session profile object will not error.
|
|
582
|
+
* Profile configuration for browsers in a pool. Provide either id or name.
|
|
583
|
+
* Profiles must be created beforehand. Unlike single browser sessions, pools load
|
|
584
|
+
* the profile read-only and never persist changes back to it, so save_changes is
|
|
585
|
+
* omitted here. Any save_changes value sent on a pool profile is silently ignored
|
|
586
|
+
* rather than rejected.
|
|
559
587
|
*/
|
|
560
588
|
export interface Profile {
|
|
561
589
|
/**
|
|
@@ -581,8 +609,12 @@ export interface BrowserPoolUpdateParams {
|
|
|
581
609
|
chrome_policy?: { [key: string]: unknown };
|
|
582
610
|
|
|
583
611
|
/**
|
|
584
|
-
* Whether to discard all idle browsers and rebuild
|
|
585
|
-
* to false.
|
|
612
|
+
* Whether to discard all idle browsers and rebuild them immediately with the new
|
|
613
|
+
* configuration. Defaults to false. Only browsers that are idle when the update
|
|
614
|
+
* runs are rebuilt. A browser that is in use during the update keeps its original
|
|
615
|
+
* configuration, and if it is later released with `reuse: true` it returns to the
|
|
616
|
+
* pool with that stale configuration until it is discarded (by this flag on a
|
|
617
|
+
* later update, or by flushing the pool).
|
|
586
618
|
*/
|
|
587
619
|
discard_all_idle?: boolean;
|
|
588
620
|
|
|
@@ -615,12 +647,11 @@ export interface BrowserPoolUpdateParams {
|
|
|
615
647
|
name?: string;
|
|
616
648
|
|
|
617
649
|
/**
|
|
618
|
-
* Profile
|
|
619
|
-
*
|
|
620
|
-
*
|
|
621
|
-
*
|
|
622
|
-
*
|
|
623
|
-
* rejected, so callers reusing a single-session profile object will not error.
|
|
650
|
+
* Profile configuration for browsers in a pool. Provide either id or name.
|
|
651
|
+
* Profiles must be created beforehand. Unlike single browser sessions, pools load
|
|
652
|
+
* the profile read-only and never persist changes back to it, so save_changes is
|
|
653
|
+
* omitted here. Any save_changes value sent on a pool profile is silently ignored
|
|
654
|
+
* rather than rejected.
|
|
624
655
|
*/
|
|
625
656
|
profile?: BrowserPoolUpdateParams.Profile;
|
|
626
657
|
|
|
@@ -630,6 +661,13 @@ export interface BrowserPoolUpdateParams {
|
|
|
630
661
|
*/
|
|
631
662
|
proxy_id?: string;
|
|
632
663
|
|
|
664
|
+
/**
|
|
665
|
+
* When true, flush idle browsers when the profile the pool uses is updated, so
|
|
666
|
+
* pool browsers pick up the latest profile data. Requires a profile to be set on
|
|
667
|
+
* the pool.
|
|
668
|
+
*/
|
|
669
|
+
refresh_on_profile_update?: boolean;
|
|
670
|
+
|
|
633
671
|
/**
|
|
634
672
|
* Number of browsers to maintain in the pool. The maximum size is determined by
|
|
635
673
|
* your organization's pooled sessions limit (the sum of all pool sizes cannot
|
|
@@ -663,26 +701,25 @@ export interface BrowserPoolUpdateParams {
|
|
|
663
701
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
664
702
|
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
|
|
665
703
|
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
|
|
666
|
-
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For
|
|
667
|
-
* presets use one of these resolutions with refresh rates
|
|
668
|
-
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
669
|
-
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
670
|
-
* Viewports outside this list may exhibit unstable live view
|
|
671
|
-
* behavior. If refresh_rate is not provided, it will be automatically
|
|
672
|
-
* based on the resolution (higher resolutions use lower refresh rates
|
|
673
|
-
* bandwidth reasonable).
|
|
704
|
+
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For
|
|
705
|
+
* GPU images, recommended presets use one of these resolutions with refresh rates
|
|
706
|
+
* 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
707
|
+
* 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
708
|
+
* 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view
|
|
709
|
+
* or recording behavior. If refresh_rate is not provided, it will be automatically
|
|
710
|
+
* determined based on the resolution (higher resolutions use lower refresh rates
|
|
711
|
+
* to keep bandwidth reasonable).
|
|
674
712
|
*/
|
|
675
713
|
viewport?: Shared.BrowserViewport;
|
|
676
714
|
}
|
|
677
715
|
|
|
678
716
|
export namespace BrowserPoolUpdateParams {
|
|
679
717
|
/**
|
|
680
|
-
* Profile
|
|
681
|
-
*
|
|
682
|
-
*
|
|
683
|
-
*
|
|
684
|
-
*
|
|
685
|
-
* rejected, so callers reusing a single-session profile object will not error.
|
|
718
|
+
* Profile configuration for browsers in a pool. Provide either id or name.
|
|
719
|
+
* Profiles must be created beforehand. Unlike single browser sessions, pools load
|
|
720
|
+
* the profile read-only and never persist changes back to it, so save_changes is
|
|
721
|
+
* omitted here. Any save_changes value sent on a pool profile is silently ignored
|
|
722
|
+
* rather than rejected.
|
|
686
723
|
*/
|
|
687
724
|
export interface Profile {
|
|
688
725
|
/**
|
|
@@ -752,7 +789,10 @@ export interface BrowserPoolReleaseParams {
|
|
|
752
789
|
|
|
753
790
|
/**
|
|
754
791
|
* Whether to reuse the browser instance or destroy it and create a new one.
|
|
755
|
-
* Defaults to true.
|
|
792
|
+
* Defaults to true. A reused browser keeps the configuration it was created with,
|
|
793
|
+
* so it does not pick up pool configuration changes made while it was in use.
|
|
794
|
+
* Release with `reuse: false`, or flush the pool afterward, to rebuild it with the
|
|
795
|
+
* current configuration.
|
|
756
796
|
*/
|
|
757
797
|
reuse?: boolean;
|
|
758
798
|
}
|
|
@@ -459,14 +459,14 @@ export interface BrowserCreateResponse {
|
|
|
459
459
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
460
460
|
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
|
|
461
461
|
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
|
|
462
|
-
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For
|
|
463
|
-
* presets use one of these resolutions with refresh rates
|
|
464
|
-
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
465
|
-
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
466
|
-
* Viewports outside this list may exhibit unstable live view
|
|
467
|
-
* behavior. If refresh_rate is not provided, it will be automatically
|
|
468
|
-
* based on the resolution (higher resolutions use lower refresh rates
|
|
469
|
-
* bandwidth reasonable).
|
|
462
|
+
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For
|
|
463
|
+
* GPU images, recommended presets use one of these resolutions with refresh rates
|
|
464
|
+
* 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
465
|
+
* 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
466
|
+
* 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view
|
|
467
|
+
* or recording behavior. If refresh_rate is not provided, it will be automatically
|
|
468
|
+
* determined based on the resolution (higher resolutions use lower refresh rates
|
|
469
|
+
* to keep bandwidth reasonable).
|
|
470
470
|
*/
|
|
471
471
|
viewport?: Shared.BrowserViewport;
|
|
472
472
|
}
|
|
@@ -591,14 +591,14 @@ export interface BrowserRetrieveResponse {
|
|
|
591
591
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
592
592
|
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
|
|
593
593
|
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
|
|
594
|
-
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For
|
|
595
|
-
* presets use one of these resolutions with refresh rates
|
|
596
|
-
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
597
|
-
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
598
|
-
* Viewports outside this list may exhibit unstable live view
|
|
599
|
-
* behavior. If refresh_rate is not provided, it will be automatically
|
|
600
|
-
* based on the resolution (higher resolutions use lower refresh rates
|
|
601
|
-
* bandwidth reasonable).
|
|
594
|
+
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For
|
|
595
|
+
* GPU images, recommended presets use one of these resolutions with refresh rates
|
|
596
|
+
* 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
597
|
+
* 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
598
|
+
* 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view
|
|
599
|
+
* or recording behavior. If refresh_rate is not provided, it will be automatically
|
|
600
|
+
* determined based on the resolution (higher resolutions use lower refresh rates
|
|
601
|
+
* to keep bandwidth reasonable).
|
|
602
602
|
*/
|
|
603
603
|
viewport?: Shared.BrowserViewport;
|
|
604
604
|
}
|
|
@@ -723,14 +723,14 @@ export interface BrowserUpdateResponse {
|
|
|
723
723
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
724
724
|
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
|
|
725
725
|
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
|
|
726
|
-
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For
|
|
727
|
-
* presets use one of these resolutions with refresh rates
|
|
728
|
-
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
729
|
-
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
730
|
-
* Viewports outside this list may exhibit unstable live view
|
|
731
|
-
* behavior. If refresh_rate is not provided, it will be automatically
|
|
732
|
-
* based on the resolution (higher resolutions use lower refresh rates
|
|
733
|
-
* bandwidth reasonable).
|
|
726
|
+
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For
|
|
727
|
+
* GPU images, recommended presets use one of these resolutions with refresh rates
|
|
728
|
+
* 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
729
|
+
* 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
730
|
+
* 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view
|
|
731
|
+
* or recording behavior. If refresh_rate is not provided, it will be automatically
|
|
732
|
+
* determined based on the resolution (higher resolutions use lower refresh rates
|
|
733
|
+
* to keep bandwidth reasonable).
|
|
734
734
|
*/
|
|
735
735
|
viewport?: Shared.BrowserViewport;
|
|
736
736
|
}
|
|
@@ -855,14 +855,14 @@ export interface BrowserListResponse {
|
|
|
855
855
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
856
856
|
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
|
|
857
857
|
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
|
|
858
|
-
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For
|
|
859
|
-
* presets use one of these resolutions with refresh rates
|
|
860
|
-
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
861
|
-
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
862
|
-
* Viewports outside this list may exhibit unstable live view
|
|
863
|
-
* behavior. If refresh_rate is not provided, it will be automatically
|
|
864
|
-
* based on the resolution (higher resolutions use lower refresh rates
|
|
865
|
-
* bandwidth reasonable).
|
|
858
|
+
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For
|
|
859
|
+
* GPU images, recommended presets use one of these resolutions with refresh rates
|
|
860
|
+
* 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
861
|
+
* 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
862
|
+
* 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view
|
|
863
|
+
* or recording behavior. If refresh_rate is not provided, it will be automatically
|
|
864
|
+
* determined based on the resolution (higher resolutions use lower refresh rates
|
|
865
|
+
* to keep bandwidth reasonable).
|
|
866
866
|
*/
|
|
867
867
|
viewport?: Shared.BrowserViewport;
|
|
868
868
|
}
|
|
@@ -992,14 +992,14 @@ export interface BrowserCreateParams {
|
|
|
992
992
|
* image defaults apply (1920x1080@25). For GPU images, the default is
|
|
993
993
|
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
|
|
994
994
|
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
|
|
995
|
-
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For
|
|
996
|
-
* presets use one of these resolutions with refresh rates
|
|
997
|
-
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
998
|
-
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
999
|
-
* Viewports outside this list may exhibit unstable live view
|
|
1000
|
-
* behavior. If refresh_rate is not provided, it will be automatically
|
|
1001
|
-
* based on the resolution (higher resolutions use lower refresh rates
|
|
1002
|
-
* bandwidth reasonable).
|
|
995
|
+
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For
|
|
996
|
+
* GPU images, recommended presets use one of these resolutions with refresh rates
|
|
997
|
+
* 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800,
|
|
998
|
+
* 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250,
|
|
999
|
+
* 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view
|
|
1000
|
+
* or recording behavior. If refresh_rate is not provided, it will be automatically
|
|
1001
|
+
* determined based on the resolution (higher resolutions use lower refresh rates
|
|
1002
|
+
* to keep bandwidth reasonable).
|
|
1003
1003
|
*/
|
|
1004
1004
|
viewport?: Shared.BrowserViewport;
|
|
1005
1005
|
}
|
|
@@ -14,10 +14,10 @@ import { path } from '../../internal/utils/path';
|
|
|
14
14
|
*/
|
|
15
15
|
export class Telemetry extends APIResource {
|
|
16
16
|
/**
|
|
17
|
-
* Reads a page of telemetry events for the browser session
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
17
|
+
* Reads a page of telemetry events for the browser session. To page through
|
|
18
|
+
* results, pass the X-Next-Offset value from the previous response as offset and
|
|
19
|
+
* repeat while X-Has-More is true. Returns an empty list when telemetry data is
|
|
20
|
+
* unavailable.
|
|
21
21
|
*
|
|
22
22
|
* @example
|
|
23
23
|
* ```ts
|
|
@@ -2076,6 +2076,16 @@ export interface TelemetryEventsParams extends OffsetPaginationParams {
|
|
|
2076
2076
|
| 'monitor'
|
|
2077
2077
|
>;
|
|
2078
2078
|
|
|
2079
|
+
/**
|
|
2080
|
+
* Read direction. asc (default) reads oldest first, starting from since or the
|
|
2081
|
+
* offset cursor. desc reads newest first: each request returns one page of up to
|
|
2082
|
+
* limit records ending at the offset cursor (or until, or the newest archived
|
|
2083
|
+
* event); combining desc with since is rejected with a 400. In either direction
|
|
2084
|
+
* the category filter applies within the page, so a filtered page may be empty
|
|
2085
|
+
* while X-Has-More is true.
|
|
2086
|
+
*/
|
|
2087
|
+
order?: string;
|
|
2088
|
+
|
|
2079
2089
|
/**
|
|
2080
2090
|
* Start of the window: an RFC-3339 timestamp, or a duration like 5m meaning that
|
|
2081
2091
|
* long ago. Defaults to 5m. Ignored when offset is set.
|
|
@@ -159,7 +159,9 @@ export namespace DeploymentStateEvent {
|
|
|
159
159
|
entrypoint_rel_path?: string;
|
|
160
160
|
|
|
161
161
|
/**
|
|
162
|
-
* Environment variables configured for this deployment
|
|
162
|
+
* Environment variables configured for this deployment. Values are redacted for
|
|
163
|
+
* API key, OAuth, and managed-auth callers, which receive every key with an empty
|
|
164
|
+
* string value. Only dashboard sessions receive the actual values.
|
|
163
165
|
*/
|
|
164
166
|
env_vars?: { [key: string]: string };
|
|
165
167
|
|
|
@@ -205,7 +207,9 @@ export interface DeploymentCreateResponse {
|
|
|
205
207
|
entrypoint_rel_path?: string;
|
|
206
208
|
|
|
207
209
|
/**
|
|
208
|
-
* Environment variables configured for this deployment
|
|
210
|
+
* Environment variables configured for this deployment. Values are redacted for
|
|
211
|
+
* API key, OAuth, and managed-auth callers, which receive every key with an empty
|
|
212
|
+
* string value. Only dashboard sessions receive the actual values.
|
|
209
213
|
*/
|
|
210
214
|
env_vars?: { [key: string]: string };
|
|
211
215
|
|
|
@@ -250,7 +254,9 @@ export interface DeploymentRetrieveResponse {
|
|
|
250
254
|
entrypoint_rel_path?: string;
|
|
251
255
|
|
|
252
256
|
/**
|
|
253
|
-
* Environment variables configured for this deployment
|
|
257
|
+
* Environment variables configured for this deployment. Values are redacted for
|
|
258
|
+
* API key, OAuth, and managed-auth callers, which receive every key with an empty
|
|
259
|
+
* string value. Only dashboard sessions receive the actual values.
|
|
254
260
|
*/
|
|
255
261
|
env_vars?: { [key: string]: string };
|
|
256
262
|
|
|
@@ -295,7 +301,9 @@ export interface DeploymentListResponse {
|
|
|
295
301
|
entrypoint_rel_path?: string;
|
|
296
302
|
|
|
297
303
|
/**
|
|
298
|
-
* Environment variables configured for this deployment
|
|
304
|
+
* Environment variables configured for this deployment. Values are redacted for
|
|
305
|
+
* API key, OAuth, and managed-auth callers, which receive every key with an empty
|
|
306
|
+
* string value. Only dashboard sessions receive the actual values.
|
|
299
307
|
*/
|
|
300
308
|
env_vars?: { [key: string]: string };
|
|
301
309
|
|
|
@@ -361,7 +369,8 @@ export namespace DeploymentFollowResponse {
|
|
|
361
369
|
version: string;
|
|
362
370
|
|
|
363
371
|
/**
|
|
364
|
-
* Environment variables configured for this app version
|
|
372
|
+
* Environment variables configured for this app version. Not currently populated
|
|
373
|
+
* on streamed app_version_summary events.
|
|
365
374
|
*/
|
|
366
375
|
env_vars?: { [key: string]: string };
|
|
367
376
|
}
|
|
@@ -147,6 +147,15 @@ export interface ExtensionListResponse {
|
|
|
147
147
|
*/
|
|
148
148
|
size_bytes: number;
|
|
149
149
|
|
|
150
|
+
/**
|
|
151
|
+
* SHA-256 checksum, encoded as lowercase hexadecimal, of the exact uploaded
|
|
152
|
+
* extension archive bytes. This is not a normalized checksum of the extension
|
|
153
|
+
* contents; archive metadata, file ordering, and compression can change the
|
|
154
|
+
* checksum for otherwise identical contents. Omitted for legacy rows and
|
|
155
|
+
* server-repackaged Chrome Web Store extensions.
|
|
156
|
+
*/
|
|
157
|
+
checksum?: string | null;
|
|
158
|
+
|
|
150
159
|
/**
|
|
151
160
|
* Timestamp when the extension was last used
|
|
152
161
|
*/
|
|
@@ -178,6 +187,15 @@ export interface ExtensionGetResponse {
|
|
|
178
187
|
*/
|
|
179
188
|
size_bytes: number;
|
|
180
189
|
|
|
190
|
+
/**
|
|
191
|
+
* SHA-256 checksum, encoded as lowercase hexadecimal, of the exact uploaded
|
|
192
|
+
* extension archive bytes. This is not a normalized checksum of the extension
|
|
193
|
+
* contents; archive metadata, file ordering, and compression can change the
|
|
194
|
+
* checksum for otherwise identical contents. Omitted for legacy rows and
|
|
195
|
+
* server-repackaged Chrome Web Store extensions.
|
|
196
|
+
*/
|
|
197
|
+
checksum?: string | null;
|
|
198
|
+
|
|
181
199
|
/**
|
|
182
200
|
* Timestamp when the extension was last used
|
|
183
201
|
*/
|
|
@@ -209,6 +227,15 @@ export interface ExtensionUploadResponse {
|
|
|
209
227
|
*/
|
|
210
228
|
size_bytes: number;
|
|
211
229
|
|
|
230
|
+
/**
|
|
231
|
+
* SHA-256 checksum, encoded as lowercase hexadecimal, of the exact uploaded
|
|
232
|
+
* extension archive bytes. This is not a normalized checksum of the extension
|
|
233
|
+
* contents; archive metadata, file ordering, and compression can change the
|
|
234
|
+
* checksum for otherwise identical contents. Omitted for legacy rows and
|
|
235
|
+
* server-repackaged Chrome Web Store extensions.
|
|
236
|
+
*/
|
|
237
|
+
checksum?: string | null;
|
|
238
|
+
|
|
212
239
|
/**
|
|
213
240
|
* Timestamp when the extension was last used
|
|
214
241
|
*/
|