/
protocol.pdl
1474 lines (1272 loc) · 26.7 KB
/
protocol.pdl
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
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (c) Microsoft Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Exactly one of the optional fields must be present.
type SerializedValue
n?: number
b?: boolean
s?: string
v?: enum
null
undefined
NaN
Infinity
-Infinity
-0
# String representation of the Date.
d?: string
# Regular expression pattern and flags.
r?: object
p: string
f: string
a?: SerializedValue[]
# Object with keys and values.
o?: object[]
k: string
v: SerializedValue
# An index in the handles array from SerializedArgument.
h?: number
# Represents a value with handle references.
type SerializedArgument
value: SerializedValue
handles: Channel[]
type AXNode
role: string
name: string
valueString?: string
valueNumber?: number
description?: string
keyshortcuts?: string
roledescription?: string
valuetext?: string
disabled?: boolean
expanded?: boolean
focused?: boolean
modal?: boolean
multiline?: boolean
multiselectable?: boolean
readonly?: boolean
required?: boolean
selected?: boolean
checked?: enum
checked
unchecked
mixed
pressed?: enum
pressed
released
mixed
level?: number
valuemin?: number
valuemax?: number
autocomplete?: string
haspopup?: string
invalid?: string
orientation?: string
children?: AXNode[]
type SerializedError
error?: object
message: string
name: string
stack?: string
value?: SerializedValue
interface Playwright
initializer
chromium: BrowserType
firefox: BrowserType
webkit: BrowserType
electron?: Electron
deviceDescriptors: object[]
name: string
descriptor: object
userAgent: string
viewport: object
width: number
height: number
deviceScaleFactor: number
isMobile: boolean
hasTouch: boolean
selectors: Selectors
interface Selectors
command register
parameters
name: string
source: string
options: object
contentScript?: boolean
command createSelector
parameters
name: string
handle: ElementHandle
returns
value?: string
interface BrowserType
initializer
executablePath: string
name: string
command connect
parameters
wsEndpoint: string
slowMo?: number
timeout?: number
returns
browser: Browser
command launch
parameters
executablePath?: string
args?: string[]
ignoreAllDefaultArgs?: boolean
ignoreDefaultArgs?: string[]
handleSIGINT?: boolean
handleSIGTERM?: boolean
handleSIGHUP?: boolean
timeout?: number
env?: object[]
name: string
value: string
headless?: boolean
devtools?: boolean
proxy?: object
server: string
bypass?: string
username?: string
password?: string
downloadsPath?: string
slowMo?: number
returns
browser: Browser
command launchServer
parameters
executablePath?: string
args?: string[]
ignoreAllDefaultArgs?: boolean
ignoreDefaultArgs?: string[]
handleSIGINT?: boolean
handleSIGTERM?: boolean
handleSIGHUP?: boolean
timeout?: number
env?: object[]
name: string
value: string
headless?: boolean
devtools?: boolean
proxy?: object
server: string
bypass?: string
username?: string
password?: string
downloadsPath?: string
port?: number
returns
server: BrowserServer
command launchPersistentContext
parameters
userDataDir: string
executablePath?: string
args?: string[]
ignoreAllDefaultArgs?: boolean
ignoreDefaultArgs?: string[]
handleSIGINT?: boolean
handleSIGTERM?: boolean
handleSIGHUP?: boolean
timeout?: number
env?: object[]
name: string
value: string
headless?: boolean
devtools?: boolean
proxy?: object
server: string
bypass?: string
username?: string
password?: string
downloadsPath?: string
slowMo?: number
noDefaultViewport?: boolean
viewport?: object
width: number
height: number
ignoreHTTPSErrors?: boolean
javaScriptEnabled?: boolean
bypassCSP?: boolean
userAgent?: string
locale?: string
timezoneId?: string
geolocation?: object
longitude: number
latitude: number
accuracy?: number
permissions?: string[]
extraHTTPHeaders?: object[]
name: string
value: string
offline?: boolean
httpCredentials?: object
username: string
password: string
deviceScaleFactor?: number
isMobile?: boolean
hasTouch?: boolean
colorScheme?: enum
dark
light
no-preference
acceptDownloads?: boolean
returns
context: BrowserContext
interface BrowserServer
initializer
wsEndpoint: string
pid: number
event close
command close
command kill
interface Browser
event close
command close
command newContext
parameters
noDefaultViewport?: boolean
viewport?: object
width: number
height: number
ignoreHTTPSErrors?: boolean
javaScriptEnabled?: boolean
bypassCSP?: boolean
userAgent?: string
locale?: string
timezoneId?: string
geolocation?: object
longitude: number
latitude: number
accuracy?: number
permissions?: string[]
extraHTTPHeaders?: object[]
name: string
value: string
offline?: boolean
httpCredentials?: object
username: string
password: string
deviceScaleFactor?: number
isMobile?: boolean
hasTouch?: boolean
colorScheme?: enum
dark
light
no-preference
acceptDownloads?: boolean
returns
context: BrowserContext
command crNewBrowserCDPSession
returns
session: CDPSession
command crStartTracing
parameters
page?: Page
path?: string
screenshots?: boolean
categories?: string[]
command crStopTracing
returns
binary: binary
interface BrowserContext
event bindingCall
parameters
binding: BindingCall
event close
event page
parameters
page: Page
event route
parameters
route: Route
request: Request
command addCookies
parameters
cookies: object[]
name: string
value: string
url?: string
domain?: string
path?: string
expires?: number
httpOnly?: boolean
secure?: boolean
sameSite?: enum
Strict
Lax
None
command addInitScript
parameters
source: string
command clearCookies
command clearPermissions
command close
command cookies
parameters
urls: string[]
returns
cookies: object[]
name: string
value: string
domain: string
path: string
expires: number
httpOnly: boolean
secure: boolean
sameSite: enum
Strict
Lax
None
command exposeBinding
parameters
name: string
command grantPermissions
parameters
permissions: string[]
origin?: string
command newPage
returns
page: Page
command setDefaultNavigationTimeoutNoReply
parameters
timeout: number
command setDefaultTimeoutNoReply
parameters
timeout: number
command setExtraHTTPHeaders
parameters
headers: object[]
name: string
value: string
command setGeolocation
parameters
geolocation?: object
longitude: number
latitude: number
accuracy?: number
command setHTTPCredentials
parameters
httpCredentials?: object
username: string
password: string
command setNetworkInterceptionEnabled
parameters
enabled: boolean
command setOffline
parameters
offline: boolean
event crBackgroundPage
parameters
page: Page
event crServiceWorker
parameters
worker: Worker
command crNewCDPSession
parameters
page: Page
returns
session: CDPSession
interface Page
initializer
mainFrame: Frame
viewportSize?: object
width: number
height: number
isClosed: boolean
event bindingCall
parameters
binding: BindingCall
event close
event console
parameters
message: ConsoleMessage
event crash
event dialog
parameters
dialog: Dialog
event download
parameters
download: Download
event domcontentloaded
event fileChooser
parameters
element: ElementHandle
isMultiple: boolean
event frameAttached
parameters
frame: Frame
event frameDetached
parameters
frame: Frame
event load
event pageError
parameters
error: SerializedError
event popup
parameters
page: Page
event request
parameters
request: Request
event requestFailed
parameters
request: Request
failureText?: string
event requestFinished
parameters
request: Request
event response
parameters
response: Response
event route
parameters
route: Route
request: Request
event worker
parameters
worker: Worker
command setDefaultNavigationTimeoutNoReply
parameters
timeout: number
command setDefaultTimeoutNoReply
parameters
timeout: number
command setFileChooserInterceptedNoReply
parameters
intercepted: boolean
command addInitScript
parameters
source: string
command close
parameters
runBeforeUnload?: boolean
command emulateMedia
parameters
media?: enum
screen
print
colorScheme?: enum
dark
light
no-preference
command exposeBinding
parameters
name: string
command goBack
parameters
timeout?: number
waitUntil?: enum
load
domcontentloaded
networkidle
returns
response?: Response
command goForward
parameters
timeout?: number
waitUntil?: enum
load
domcontentloaded
networkidle
returns
response?: Response
command opener
returns
page?: Page
command reload
parameters
timeout?: number
waitUntil?: enum
load
domcontentloaded
networkidle
returns
response?: Response
command screenshot
parameters
timeout?: number
type?: enum
png
jpeg
path?: string
quality?: number
omitBackground?: boolean
fullPage?: boolean
clip?: object
width: number
height: number
x: number
y: number
returns
binary: binary
command setExtraHTTPHeaders
parameters
headers: object[]
name: string
value: string
command setNetworkInterceptionEnabled
parameters
enabled: boolean
command setViewportSize
parameters
viewportSize: object
width: number
height: number
command keyboardDown
parameters
key: string
command keyboardUp
parameters
key: string
command keyboardInsertText
parameters
text: string
command keyboardType
parameters
text: string
delay?: number
command keyboardPress
parameters
key: string
delay?: number
command mouseMove
parameters
x: number
y: number
steps?: number
command mouseDown
parameters
button?: enum
left
right
middle
clickCount?: number
command mouseUp
parameters
button?: enum
left
right
middle
clickCount?: number
command mouseClick
parameters
x: number
y: number
delay?: number
button?: enum
left
right
middle
clickCount?: number
command accessibilitySnapshot
parameters
interestingOnly?: boolean
root?: ElementHandle
returns
rootAXNode?: AXNode
command pdf
parameters
scale?: number
displayHeaderFooter?: boolean
headerTemplate?: string
footerTemplate?: string
printBackground?: boolean
landscape?: boolean
pageRanges?: string
format?: string
width?: string
height?: string
preferCSSPageSize?: boolean
margin?: object
top?: string
bottom?: string
left?: string
right?: string
returns
pdf: binary
command crStartJSCoverage
parameters
resetOnNavigation?: boolean
reportAnonymousScripts?: boolean
command crStopJSCoverage
returns
entries: object[]
url: string
scriptId: string
source?: string
functions: object[]
functionName: string
isBlockCoverage: boolean
ranges: object[]
startOffset: number
endOffset: number
count: number
command crStartCSSCoverage
parameters
resetOnNavigation?: boolean
command crStopCSSCoverage
returns
entries: object[]
url: string
text?: string
ranges: object[]
start: number
end: number
command bringToFront
interface Frame
initializer
url: string
name: string
parentFrame?: Frame
loadStates: enum[]
load
domcontentloaded
networkidle
event loadstate
parameters
add?: enum
load
domcontentloaded
networkidle
remove?: enum
load
domcontentloaded
networkidle
event navigated
parameters
url: string
name: string
newDocument?: object
request?: Request
error?: string
command evalOnSelector
parameters
selector: string
expression: string
isFunction: boolean
arg: SerializedArgument
returns
value: SerializedValue
command evalOnSelectorAll
parameters
selector: string
expression: string
isFunction: boolean
arg: SerializedArgument
returns
value: SerializedValue
command addScriptTag
parameters
url?: string
content?: string
type?: string
returns
element: ElementHandle
command addStyleTag
parameters
url?: string
content?: string
returns
element: ElementHandle
command check
parameters
selector: string
force?: boolean
noWaitAfter?: boolean
timeout?: number
command click
parameters
selector: string
force?: boolean
noWaitAfter?: boolean
modifiers?: enum[]
Alt
Control
Meta
Shift
position?: object
x: number
y: number
delay?: number
button?: enum
left
right
middle
clickCount?: number
timeout?: number
command content
returns
value: string
command dblclick
parameters
selector: string
force?: boolean
modifiers?: enum[]
Alt
Control
Meta
Shift
position?: object
x: number
y: number
delay?: number
button?: enum
left
right
middle
timeout?: number
command dispatchEvent
parameters
selector: string
type: string
eventInit: SerializedArgument
timeout?: number
command evaluateExpression
parameters
expression: string
isFunction: boolean
arg: SerializedArgument
returns
value: SerializedValue
command evaluateExpressionHandle
parameters
expression: string
isFunction: boolean
arg: SerializedArgument
returns
handle: JSHandle
command fill
parameters
selector: string
value: string
timeout?: number
noWaitAfter?: boolean
command focus
parameters
selector: string
timeout?: number
command frameElement
returns
element: ElementHandle
command getAttribute
parameters
selector: string
name: string
timeout?: number
returns
value?: string
command goto
parameters
url: string
timeout?: number
waitUntil?: enum
load
domcontentloaded
networkidle
referer?: string
returns
response?: Response
command hover
parameters
selector: string
force?: boolean
modifiers?: enum[]
Alt
Control
Meta
Shift
position?: object
x: number
y: number
timeout?: number
command innerHTML
parameters
selector: string
timeout?: number
returns
value: string
command innerText
parameters
selector: string
timeout?: number
returns
value: string
command press
parameters
selector: string
key: string
delay?: number
noWaitAfter?: boolean
timeout?: number
command querySelector
parameters
selector: string
returns
element?: ElementHandle
command querySelectorAll
parameters
selector: string
returns
elements: ElementHandle[]
command selectOption
parameters
selector: string
elements?: ElementHandle[]
options?: object[]
value?: string
label?: string
index?: number
timeout?: number
noWaitAfter?: boolean
returns
values: string[]
command setContent
parameters
html: string
timeout?: number
waitUntil?: enum
load
domcontentloaded
networkidle
command setInputFiles
parameters
selector: string
files: object[]
name: string
mimeType: string
buffer: string
timeout?: number
noWaitAfter?: boolean
command textContent
parameters
selector: string
timeout?: number
returns
value?: string
command title
returns
value: string
command type
parameters
selector: string
text: string
delay?: number
noWaitAfter?: boolean
timeout?: number
command uncheck
parameters
selector: string
force?: boolean
noWaitAfter?: boolean