-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathbrowsers.ts
More file actions
959 lines (839 loc) · 26.6 KB
/
browsers.ts
File metadata and controls
959 lines (839 loc) · 26.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../../core/resource';
import * as Shared from '../shared';
import * as ComputerAPI from './computer';
import {
Computer,
ComputerBatchParams,
ComputerCaptureScreenshotParams,
ComputerClickMouseParams,
ComputerDragMouseParams,
ComputerGetMousePositionResponse,
ComputerMoveMouseParams,
ComputerPressKeyParams,
ComputerReadClipboardResponse,
ComputerScrollParams,
ComputerSetCursorVisibilityParams,
ComputerSetCursorVisibilityResponse,
ComputerTypeTextParams,
ComputerWriteClipboardParams,
} from './computer';
import * as LogsAPI from './logs';
import { LogStreamParams, Logs } from './logs';
import * as PlaywrightAPI from './playwright';
import { Playwright, PlaywrightExecuteParams, PlaywrightExecuteResponse } from './playwright';
import * as ProcessAPI from './process';
import {
Process,
ProcessExecParams,
ProcessExecResponse,
ProcessKillParams,
ProcessKillResponse,
ProcessResizeParams,
ProcessResizeResponse,
ProcessSpawnParams,
ProcessSpawnResponse,
ProcessStatusParams,
ProcessStatusResponse,
ProcessStdinParams,
ProcessStdinResponse,
ProcessStdoutStreamParams,
ProcessStdoutStreamResponse,
} from './process';
import * as ReplaysAPI from './replays';
import {
ReplayDownloadParams,
ReplayListResponse,
ReplayStartParams,
ReplayStartResponse,
ReplayStopParams,
Replays,
} from './replays';
import * as FsAPI from './fs/fs';
import {
FCreateDirectoryParams,
FDeleteDirectoryParams,
FDeleteFileParams,
FDownloadDirZipParams,
FFileInfoParams,
FFileInfoResponse,
FListFilesParams,
FListFilesResponse,
FMoveParams,
FReadFileParams,
FSetFilePermissionsParams,
FUploadParams,
FUploadZipParams,
FWriteFileParams,
Fs,
} from './fs/fs';
import { APIPromise } from '../../core/api-promise';
import { OffsetPagination, type OffsetPaginationParams, PagePromise } from '../../core/pagination';
import { type Uploadable } from '../../core/uploads';
import { buildHeaders } from '../../internal/headers';
import { RequestOptions } from '../../internal/request-options';
import { multipartFormRequestOptions } from '../../internal/uploads';
import { path } from '../../internal/utils/path';
/**
* Create and manage browser sessions.
*/
export class Browsers extends APIResource {
replays: ReplaysAPI.Replays = new ReplaysAPI.Replays(this._client);
fs: FsAPI.Fs = new FsAPI.Fs(this._client);
process: ProcessAPI.Process = new ProcessAPI.Process(this._client);
logs: LogsAPI.Logs = new LogsAPI.Logs(this._client);
computer: ComputerAPI.Computer = new ComputerAPI.Computer(this._client);
playwright: PlaywrightAPI.Playwright = new PlaywrightAPI.Playwright(this._client);
/**
* Create a new browser session from within an action.
*
* @example
* ```ts
* const browser = await client.browsers.create();
* ```
*/
create(
body: BrowserCreateParams | null | undefined = {},
options?: RequestOptions,
): APIPromise<BrowserCreateResponse> {
return this._client.post('/browsers', { body, ...options });
}
/**
* Get information about a browser session.
*
* @example
* ```ts
* const browser = await client.browsers.retrieve(
* 'htzv5orfit78e1m2biiifpbv',
* );
* ```
*/
retrieve(
id: string,
query: BrowserRetrieveParams | null | undefined = {},
options?: RequestOptions,
): APIPromise<BrowserRetrieveResponse> {
return this._client.get(path`/browsers/${id}`, { query, ...options });
}
/**
* Update a browser session.
*
* @example
* ```ts
* const browser = await client.browsers.update(
* 'htzv5orfit78e1m2biiifpbv',
* );
* ```
*/
update(id: string, body: BrowserUpdateParams, options?: RequestOptions): APIPromise<BrowserUpdateResponse> {
return this._client.patch(path`/browsers/${id}`, { body, ...options });
}
/**
* List all browser sessions with pagination support. Use status parameter to
* filter by session state.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const browserListResponse of client.browsers.list()) {
* // ...
* }
* ```
*/
list(
query: BrowserListParams | null | undefined = {},
options?: RequestOptions,
): PagePromise<BrowserListResponsesOffsetPagination, BrowserListResponse> {
return this._client.getAPIList('/browsers', OffsetPagination<BrowserListResponse>, { query, ...options });
}
/**
* DEPRECATED: Use DELETE /browsers/{id} instead. Delete a persistent browser
* session by its persistent_id.
*
* @deprecated
*/
delete(params: BrowserDeleteParams, options?: RequestOptions): APIPromise<void> {
const { persistent_id } = params;
return this._client.delete('/browsers', {
query: { persistent_id },
...options,
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
});
}
/**
* Delete a browser session by ID
*
* @example
* ```ts
* await client.browsers.deleteByID(
* 'htzv5orfit78e1m2biiifpbv',
* );
* ```
*/
deleteByID(id: string, options?: RequestOptions): APIPromise<void> {
return this._client.delete(path`/browsers/${id}`, {
...options,
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
});
}
/**
* Loads one or more unpacked extensions and restarts Chromium on the browser
* instance.
*
* @example
* ```ts
* await client.browsers.loadExtensions('id', {
* extensions: [
* {
* name: 'name',
* zip_file: fs.createReadStream('path/to/file'),
* },
* ],
* });
* ```
*/
loadExtensions(id: string, body: BrowserLoadExtensionsParams, options?: RequestOptions): APIPromise<void> {
return this._client.post(
path`/browsers/${id}/extensions`,
multipartFormRequestOptions(
{ body, ...options, headers: buildHeaders([{ Accept: '*/*' }, options?.headers]) },
this._client,
),
);
}
}
export type BrowserListResponsesOffsetPagination = OffsetPagination<BrowserListResponse>;
export type ProfilesOffsetPagination = OffsetPagination<Profile>;
/**
* @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
* instead.
*/
export interface BrowserPersistence {
/**
* DEPRECATED: Unique identifier for the persistent browser session.
*/
id: string;
}
/**
* Browser pool this session was acquired from, if any.
*/
export interface BrowserPoolRef {
/**
* Browser pool ID
*/
id: string;
/**
* Browser pool name, if set
*/
name?: string;
}
/**
* Session usage metrics.
*/
export interface BrowserUsage {
/**
* Time in milliseconds the session was actively running.
*/
uptime_ms: number;
}
/**
* Browser profile metadata.
*/
export interface Profile {
/**
* Unique identifier for the profile
*/
id: string;
/**
* Timestamp when the profile was created
*/
created_at: string;
/**
* Timestamp when the profile was last used
*/
last_used_at?: string;
/**
* Optional, easier-to-reference name for the profile
*/
name?: string | null;
/**
* Timestamp when the profile was last updated
*/
updated_at?: string;
}
export interface BrowserCreateResponse {
/**
* Websocket URL for Chrome DevTools Protocol connections to the browser session
*/
cdp_ws_url: string;
/**
* When the browser session was created.
*/
created_at: string;
/**
* Whether the browser session is running in headless mode.
*/
headless: boolean;
/**
* Unique identifier for the browser session
*/
session_id: string;
/**
* Whether the browser session is running in stealth mode.
*/
stealth: boolean;
/**
* The number of seconds of inactivity before the browser session is terminated.
*/
timeout_seconds: number;
/**
* Websocket URL for WebDriver BiDi connections to the browser session
*/
webdriver_ws_url: string;
/**
* Remote URL for live viewing the browser session. Only available for non-headless
* browsers.
*/
browser_live_view_url?: string;
/**
* When the browser session was soft-deleted. Only present for deleted sessions.
*/
deleted_at?: string;
/**
* Whether GPU acceleration is enabled for the browser session (only supported for
* headful sessions).
*/
gpu?: boolean;
/**
* Whether the browser session is running in kiosk mode.
*/
kiosk_mode?: boolean;
/**
* @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
* instead.
*/
persistence?: BrowserPersistence;
/**
* Browser pool this session was acquired from, if any.
*/
pool?: BrowserPoolRef;
/**
* Browser profile metadata.
*/
profile?: Profile;
/**
* ID of the proxy associated with this browser session, if any.
*/
proxy_id?: string;
/**
* Session usage metrics.
*/
usage?: BrowserUsage;
/**
* Initial browser window size in pixels with optional refresh rate. If omitted,
* image defaults apply (1920x1080@25). For GPU images, the default is
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
* presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
* Viewports outside this list may exhibit unstable live view or recording
* behavior. If refresh_rate is not provided, it will be automatically determined
* based on the resolution (higher resolutions use lower refresh rates to keep
* bandwidth reasonable).
*/
viewport?: Shared.BrowserViewport;
}
export interface BrowserRetrieveResponse {
/**
* Websocket URL for Chrome DevTools Protocol connections to the browser session
*/
cdp_ws_url: string;
/**
* When the browser session was created.
*/
created_at: string;
/**
* Whether the browser session is running in headless mode.
*/
headless: boolean;
/**
* Unique identifier for the browser session
*/
session_id: string;
/**
* Whether the browser session is running in stealth mode.
*/
stealth: boolean;
/**
* The number of seconds of inactivity before the browser session is terminated.
*/
timeout_seconds: number;
/**
* Websocket URL for WebDriver BiDi connections to the browser session
*/
webdriver_ws_url: string;
/**
* Remote URL for live viewing the browser session. Only available for non-headless
* browsers.
*/
browser_live_view_url?: string;
/**
* When the browser session was soft-deleted. Only present for deleted sessions.
*/
deleted_at?: string;
/**
* Whether GPU acceleration is enabled for the browser session (only supported for
* headful sessions).
*/
gpu?: boolean;
/**
* Whether the browser session is running in kiosk mode.
*/
kiosk_mode?: boolean;
/**
* @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
* instead.
*/
persistence?: BrowserPersistence;
/**
* Browser pool this session was acquired from, if any.
*/
pool?: BrowserPoolRef;
/**
* Browser profile metadata.
*/
profile?: Profile;
/**
* ID of the proxy associated with this browser session, if any.
*/
proxy_id?: string;
/**
* Session usage metrics.
*/
usage?: BrowserUsage;
/**
* Initial browser window size in pixels with optional refresh rate. If omitted,
* image defaults apply (1920x1080@25). For GPU images, the default is
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
* presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
* Viewports outside this list may exhibit unstable live view or recording
* behavior. If refresh_rate is not provided, it will be automatically determined
* based on the resolution (higher resolutions use lower refresh rates to keep
* bandwidth reasonable).
*/
viewport?: Shared.BrowserViewport;
}
export interface BrowserUpdateResponse {
/**
* Websocket URL for Chrome DevTools Protocol connections to the browser session
*/
cdp_ws_url: string;
/**
* When the browser session was created.
*/
created_at: string;
/**
* Whether the browser session is running in headless mode.
*/
headless: boolean;
/**
* Unique identifier for the browser session
*/
session_id: string;
/**
* Whether the browser session is running in stealth mode.
*/
stealth: boolean;
/**
* The number of seconds of inactivity before the browser session is terminated.
*/
timeout_seconds: number;
/**
* Websocket URL for WebDriver BiDi connections to the browser session
*/
webdriver_ws_url: string;
/**
* Remote URL for live viewing the browser session. Only available for non-headless
* browsers.
*/
browser_live_view_url?: string;
/**
* When the browser session was soft-deleted. Only present for deleted sessions.
*/
deleted_at?: string;
/**
* Whether GPU acceleration is enabled for the browser session (only supported for
* headful sessions).
*/
gpu?: boolean;
/**
* Whether the browser session is running in kiosk mode.
*/
kiosk_mode?: boolean;
/**
* @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
* instead.
*/
persistence?: BrowserPersistence;
/**
* Browser pool this session was acquired from, if any.
*/
pool?: BrowserPoolRef;
/**
* Browser profile metadata.
*/
profile?: Profile;
/**
* ID of the proxy associated with this browser session, if any.
*/
proxy_id?: string;
/**
* Session usage metrics.
*/
usage?: BrowserUsage;
/**
* Initial browser window size in pixels with optional refresh rate. If omitted,
* image defaults apply (1920x1080@25). For GPU images, the default is
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
* presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
* Viewports outside this list may exhibit unstable live view or recording
* behavior. If refresh_rate is not provided, it will be automatically determined
* based on the resolution (higher resolutions use lower refresh rates to keep
* bandwidth reasonable).
*/
viewport?: Shared.BrowserViewport;
}
export interface BrowserListResponse {
/**
* Websocket URL for Chrome DevTools Protocol connections to the browser session
*/
cdp_ws_url: string;
/**
* When the browser session was created.
*/
created_at: string;
/**
* Whether the browser session is running in headless mode.
*/
headless: boolean;
/**
* Unique identifier for the browser session
*/
session_id: string;
/**
* Whether the browser session is running in stealth mode.
*/
stealth: boolean;
/**
* The number of seconds of inactivity before the browser session is terminated.
*/
timeout_seconds: number;
/**
* Websocket URL for WebDriver BiDi connections to the browser session
*/
webdriver_ws_url: string;
/**
* Remote URL for live viewing the browser session. Only available for non-headless
* browsers.
*/
browser_live_view_url?: string;
/**
* When the browser session was soft-deleted. Only present for deleted sessions.
*/
deleted_at?: string;
/**
* Whether GPU acceleration is enabled for the browser session (only supported for
* headful sessions).
*/
gpu?: boolean;
/**
* Whether the browser session is running in kiosk mode.
*/
kiosk_mode?: boolean;
/**
* @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
* instead.
*/
persistence?: BrowserPersistence;
/**
* Browser pool this session was acquired from, if any.
*/
pool?: BrowserPoolRef;
/**
* Browser profile metadata.
*/
profile?: Profile;
/**
* ID of the proxy associated with this browser session, if any.
*/
proxy_id?: string;
/**
* Session usage metrics.
*/
usage?: BrowserUsage;
/**
* Initial browser window size in pixels with optional refresh rate. If omitted,
* image defaults apply (1920x1080@25). For GPU images, the default is
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
* presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
* Viewports outside this list may exhibit unstable live view or recording
* behavior. If refresh_rate is not provided, it will be automatically determined
* based on the resolution (higher resolutions use lower refresh rates to keep
* bandwidth reasonable).
*/
viewport?: Shared.BrowserViewport;
}
export interface BrowserCreateParams {
/**
* List of browser extensions to load into the session. Provide each by id or name.
*/
extensions?: Array<Shared.BrowserExtension>;
/**
* If true, enables GPU acceleration for the browser session. Requires Start-Up or
* Enterprise plan and headless=false.
*/
gpu?: boolean;
/**
* If true, launches the browser using a headless image (no VNC/GUI). Defaults to
* false.
*/
headless?: boolean;
/**
* action invocation ID
*/
invocation_id?: string;
/**
* If true, launches the browser in kiosk mode to hide address bar and tabs in live
* view.
*/
kiosk_mode?: boolean;
/**
* @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
* instead.
*/
persistence?: BrowserPersistence;
/**
* Profile selection for the browser session. Provide either id or name. If
* specified, the matching profile will be loaded into the browser session.
* Profiles must be created beforehand.
*/
profile?: Shared.BrowserProfile;
/**
* Optional proxy to associate to the browser session. Must reference a proxy
* belonging to the caller's org.
*/
proxy_id?: string;
/**
* If true, launches the browser in stealth mode to reduce detection by anti-bot
* mechanisms.
*/
stealth?: boolean;
/**
* The number of seconds of inactivity before the browser session is terminated.
* Activity includes CDP connections and live view connections. Defaults to 60
* seconds. Minimum allowed is 10 seconds. Maximum allowed is 259200 (72 hours). We
* check for inactivity every 5 seconds, so the actual timeout behavior you will
* see is +/- 5 seconds around the specified value.
*/
timeout_seconds?: number;
/**
* Initial browser window size in pixels with optional refresh rate. If omitted,
* image defaults apply (1920x1080@25). For GPU images, the default is
* 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
* Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
* 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
* presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
* 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
* 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
* Viewports outside this list may exhibit unstable live view or recording
* behavior. If refresh_rate is not provided, it will be automatically determined
* based on the resolution (higher resolutions use lower refresh rates to keep
* bandwidth reasonable).
*/
viewport?: Shared.BrowserViewport;
}
export interface BrowserRetrieveParams {
/**
* When true, includes soft-deleted browser sessions in the lookup.
*/
include_deleted?: boolean;
}
export interface BrowserUpdateParams {
/**
* If true, stealth browsers connect directly instead of using the default stealth
* proxy.
*/
disable_default_proxy?: boolean;
/**
* Profile to load into the browser session. Only allowed if the session does not
* already have a profile loaded.
*/
profile?: Shared.BrowserProfile;
/**
* ID of the proxy to use. Omit to leave unchanged, set to empty string to remove
* proxy.
*/
proxy_id?: string | null;
/**
* Viewport configuration to apply to the browser session.
*/
viewport?: BrowserUpdateParams.Viewport;
}
export namespace BrowserUpdateParams {
/**
* Viewport configuration to apply to the browser session.
*/
export interface Viewport extends Shared.BrowserViewport {
/**
* If true, allow the viewport change even when a live view or recording/replay is
* active. Active recordings will be gracefully stopped and restarted at the new
* resolution as separate segments. If false (default), the resize is refused when
* a live view or recording is active.
*/
force?: boolean;
}
}
export interface BrowserListParams extends OffsetPaginationParams {
/**
* Deprecated: Use status=all instead. When true, includes soft-deleted browser
* sessions in the results alongside active sessions.
*/
include_deleted?: boolean;
/**
* Search browsers by session ID, profile ID, or proxy ID.
*/
query?: string;
/**
* Filter sessions by status. "active" returns only active sessions (default),
* "deleted" returns only soft-deleted sessions, "all" returns both.
*/
status?: 'active' | 'deleted' | 'all';
}
export interface BrowserDeleteParams {
/**
* Persistent browser identifier
*/
persistent_id: string;
}
export interface BrowserLoadExtensionsParams {
/**
* List of extensions to upload and activate
*/
extensions: Array<BrowserLoadExtensionsParams.Extension>;
}
export namespace BrowserLoadExtensionsParams {
export interface Extension {
/**
* Folder name to place the extension under /home/kernel/extensions/<name>
*/
name: string;
/**
* Zip archive containing an unpacked Chromium extension (must include
* manifest.json)
*/
zip_file: Uploadable;
}
}
Browsers.Replays = Replays;
Browsers.Fs = Fs;
Browsers.Process = Process;
Browsers.Logs = Logs;
Browsers.Computer = Computer;
Browsers.Playwright = Playwright;
export declare namespace Browsers {
export {
type BrowserPersistence as BrowserPersistence,
type BrowserPoolRef as BrowserPoolRef,
type BrowserUsage as BrowserUsage,
type Profile as Profile,
type BrowserCreateResponse as BrowserCreateResponse,
type BrowserRetrieveResponse as BrowserRetrieveResponse,
type BrowserUpdateResponse as BrowserUpdateResponse,
type BrowserListResponse as BrowserListResponse,
type BrowserListResponsesOffsetPagination as BrowserListResponsesOffsetPagination,
type BrowserCreateParams as BrowserCreateParams,
type BrowserRetrieveParams as BrowserRetrieveParams,
type BrowserUpdateParams as BrowserUpdateParams,
type BrowserListParams as BrowserListParams,
type BrowserDeleteParams as BrowserDeleteParams,
type BrowserLoadExtensionsParams as BrowserLoadExtensionsParams,
};
export {
Replays as Replays,
type ReplayListResponse as ReplayListResponse,
type ReplayStartResponse as ReplayStartResponse,
type ReplayDownloadParams as ReplayDownloadParams,
type ReplayStartParams as ReplayStartParams,
type ReplayStopParams as ReplayStopParams,
};
export {
Fs as Fs,
type FFileInfoResponse as FFileInfoResponse,
type FListFilesResponse as FListFilesResponse,
type FCreateDirectoryParams as FCreateDirectoryParams,
type FDeleteDirectoryParams as FDeleteDirectoryParams,
type FDeleteFileParams as FDeleteFileParams,
type FDownloadDirZipParams as FDownloadDirZipParams,
type FFileInfoParams as FFileInfoParams,
type FListFilesParams as FListFilesParams,
type FMoveParams as FMoveParams,
type FReadFileParams as FReadFileParams,
type FSetFilePermissionsParams as FSetFilePermissionsParams,
type FUploadParams as FUploadParams,
type FUploadZipParams as FUploadZipParams,
type FWriteFileParams as FWriteFileParams,
};
export {
Process as Process,
type ProcessExecResponse as ProcessExecResponse,
type ProcessKillResponse as ProcessKillResponse,
type ProcessResizeResponse as ProcessResizeResponse,
type ProcessSpawnResponse as ProcessSpawnResponse,
type ProcessStatusResponse as ProcessStatusResponse,
type ProcessStdinResponse as ProcessStdinResponse,
type ProcessStdoutStreamResponse as ProcessStdoutStreamResponse,
type ProcessExecParams as ProcessExecParams,
type ProcessKillParams as ProcessKillParams,
type ProcessResizeParams as ProcessResizeParams,
type ProcessSpawnParams as ProcessSpawnParams,
type ProcessStatusParams as ProcessStatusParams,
type ProcessStdinParams as ProcessStdinParams,
type ProcessStdoutStreamParams as ProcessStdoutStreamParams,
};
export { Logs as Logs, type LogStreamParams as LogStreamParams };
export {
Computer as Computer,
type ComputerGetMousePositionResponse as ComputerGetMousePositionResponse,
type ComputerReadClipboardResponse as ComputerReadClipboardResponse,
type ComputerSetCursorVisibilityResponse as ComputerSetCursorVisibilityResponse,
type ComputerBatchParams as ComputerBatchParams,
type ComputerCaptureScreenshotParams as ComputerCaptureScreenshotParams,
type ComputerClickMouseParams as ComputerClickMouseParams,
type ComputerDragMouseParams as ComputerDragMouseParams,
type ComputerMoveMouseParams as ComputerMoveMouseParams,
type ComputerPressKeyParams as ComputerPressKeyParams,
type ComputerScrollParams as ComputerScrollParams,
type ComputerSetCursorVisibilityParams as ComputerSetCursorVisibilityParams,
type ComputerTypeTextParams as ComputerTypeTextParams,
type ComputerWriteClipboardParams as ComputerWriteClipboardParams,
};
export {
Playwright as Playwright,
type PlaywrightExecuteResponse as PlaywrightExecuteResponse,
type PlaywrightExecuteParams as PlaywrightExecuteParams,
};
}