webdriver-bidi.d.ts 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977
  1. /**
  2. * Copyright 2024 Google LLC.
  3. * Copyright (c) Microsoft Corporation.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. /**
  18. * THIS FILE IS AUTOGENERATED by cddlconv 0.1.5.
  19. * Run `node tools/generate-bidi-types.mjs` to regenerate.
  20. * @see https://github.com/w3c/webdriver-bidi/blob/master/index.bs
  21. */
  22. export type Event = {
  23. type: 'event';
  24. } & EventData & Extensible;
  25. export type Command = {
  26. id: JsUint;
  27. } & CommandData & Extensible;
  28. export type CommandResponse = {
  29. type: 'success';
  30. id: JsUint;
  31. result: ResultData;
  32. } & Extensible;
  33. export type EventData = BrowsingContextEvent | LogEvent | NetworkEvent | ScriptEvent;
  34. export type CommandData = BrowserCommand | BrowsingContextCommand | InputCommand | NetworkCommand | ScriptCommand | SessionCommand | StorageCommand;
  35. export type ResultData = BrowsingContextResult | EmptyResult | NetworkResult | ScriptResult | SessionResult | StorageResult;
  36. export type EmptyParams = Extensible;
  37. export type Message = CommandResponse | ErrorResponse | Event;
  38. export type ErrorResponse = {
  39. type: 'error';
  40. id: JsUint | null;
  41. error: ErrorCode;
  42. message: string;
  43. stacktrace?: string;
  44. } & Extensible;
  45. export type EmptyResult = Extensible;
  46. export type Extensible = {
  47. [key: string]: any;
  48. };
  49. /**
  50. * Must be between `-9007199254740991` and `9007199254740991`, inclusive.
  51. */
  52. export type JsInt = number;
  53. /**
  54. * Must be between `0` and `9007199254740991`, inclusive.
  55. */
  56. export type JsUint = number;
  57. export declare const enum ErrorCode {
  58. InvalidArgument = "invalid argument",
  59. InvalidSelector = "invalid selector",
  60. InvalidSessionId = "invalid session id",
  61. MoveTargetOutOfBounds = "move target out of bounds",
  62. NoSuchAlert = "no such alert",
  63. NoSuchElement = "no such element",
  64. NoSuchFrame = "no such frame",
  65. NoSuchHandle = "no such handle",
  66. NoSuchHistoryEntry = "no such history entry",
  67. NoSuchIntercept = "no such intercept",
  68. NoSuchNode = "no such node",
  69. NoSuchRequest = "no such request",
  70. NoSuchScript = "no such script",
  71. NoSuchStoragePartition = "no such storage partition",
  72. NoSuchUserContext = "no such user context",
  73. SessionNotCreated = "session not created",
  74. UnableToCaptureScreen = "unable to capture screen",
  75. UnableToCloseBrowser = "unable to close browser",
  76. UnableToSetCookie = "unable to set cookie",
  77. UnableToSetFileInput = "unable to set file input",
  78. UnderspecifiedStoragePartition = "underspecified storage partition",
  79. UnknownCommand = "unknown command",
  80. UnknownError = "unknown error",
  81. UnsupportedOperation = "unsupported operation"
  82. }
  83. export type SessionCommand = Session.End | Session.New | Session.Status | Session.Subscribe | Session.Unsubscribe;
  84. export declare namespace Session {
  85. type ProxyConfiguration = Session.AutodetectProxyConfiguration | Session.DirectProxyConfiguration | Session.ManualProxyConfiguration | Session.PacProxyConfiguration | Session.SystemProxyConfiguration | Record<string, never>;
  86. }
  87. export type SessionResult = Session.NewResult | Session.StatusResult;
  88. export declare namespace Session {
  89. type CapabilitiesRequest = {
  90. alwaysMatch?: Session.CapabilityRequest;
  91. firstMatch?: [...Session.CapabilityRequest[]];
  92. };
  93. }
  94. export declare namespace Session {
  95. type CapabilityRequest = {
  96. acceptInsecureCerts?: boolean;
  97. browserName?: string;
  98. browserVersion?: string;
  99. platformName?: string;
  100. proxy?: Session.ProxyConfiguration;
  101. webSocketUrl?: boolean;
  102. } & Extensible;
  103. }
  104. export declare namespace Session {
  105. type AutodetectProxyConfiguration = {
  106. proxyType: 'autodetect';
  107. } & Extensible;
  108. }
  109. export declare namespace Session {
  110. type DirectProxyConfiguration = {
  111. proxyType: 'direct';
  112. } & Extensible;
  113. }
  114. export declare namespace Session {
  115. type ManualProxyConfiguration = {
  116. proxyType: 'manual';
  117. ftpProxy?: string;
  118. httpProxy?: string;
  119. sslProxy?: string;
  120. } & ({} | Session.SocksProxyConfiguration) & {
  121. noProxy?: [...string[]];
  122. } & Extensible;
  123. }
  124. export declare namespace Session {
  125. type SocksProxyConfiguration = {
  126. socksProxy: string;
  127. /**
  128. * Must be between `0` and `255`, inclusive.
  129. */
  130. socksVersion: number;
  131. };
  132. }
  133. export declare namespace Session {
  134. type PacProxyConfiguration = {
  135. proxyType: 'pac';
  136. proxyAutoconfigUrl: string;
  137. } & Extensible;
  138. }
  139. export declare namespace Session {
  140. type SystemProxyConfiguration = {
  141. proxyType: 'system';
  142. } & Extensible;
  143. }
  144. export declare namespace Session {
  145. type SubscriptionRequest = {
  146. events: [string, ...string[]];
  147. contexts?: [
  148. BrowsingContext.BrowsingContext,
  149. ...BrowsingContext.BrowsingContext[]
  150. ];
  151. };
  152. }
  153. export declare namespace Session {
  154. type Status = {
  155. method: 'session.status';
  156. params: EmptyParams;
  157. };
  158. }
  159. export declare namespace Session {
  160. type StatusResult = {
  161. ready: boolean;
  162. message: string;
  163. };
  164. }
  165. export declare namespace Session {
  166. type New = {
  167. method: 'session.new';
  168. params: Session.NewParameters;
  169. };
  170. }
  171. export declare namespace Session {
  172. type NewParameters = {
  173. capabilities: Session.CapabilitiesRequest;
  174. };
  175. }
  176. export declare namespace Session {
  177. type NewResult = {
  178. sessionId: string;
  179. capabilities: {
  180. acceptInsecureCerts: boolean;
  181. browserName: string;
  182. browserVersion: string;
  183. platformName: string;
  184. setWindowRect: boolean;
  185. userAgent: string;
  186. proxy?: Session.ProxyConfiguration;
  187. webSocketUrl?: string;
  188. } & Extensible;
  189. };
  190. }
  191. export declare namespace Session {
  192. type End = {
  193. method: 'session.end';
  194. params: EmptyParams;
  195. };
  196. }
  197. export declare namespace Session {
  198. type Subscribe = {
  199. method: 'session.subscribe';
  200. params: Session.SubscriptionRequest;
  201. };
  202. }
  203. export declare namespace Session {
  204. type Unsubscribe = {
  205. method: 'session.unsubscribe';
  206. params: Session.SubscriptionRequest;
  207. };
  208. }
  209. export type BrowserCommand = Browser.Close | Browser.CreateUserContext | Browser.GetUserContexts | Browser.RemoveUserContext;
  210. export type BrowserResult = Browser.CreateUserContextResult | Browser.GetUserContextsResult;
  211. export declare namespace Browser {
  212. type UserContext = string;
  213. }
  214. export declare namespace Browser {
  215. type UserContextInfo = {
  216. userContext: Browser.UserContext;
  217. };
  218. }
  219. export declare namespace Browser {
  220. type Close = {
  221. method: 'browser.close';
  222. params: EmptyParams;
  223. };
  224. }
  225. export declare namespace Browser {
  226. type CreateUserContext = {
  227. method: 'browser.createUserContext';
  228. params: EmptyParams;
  229. };
  230. }
  231. export declare namespace Browser {
  232. type CreateUserContextResult = Browser.UserContextInfo;
  233. }
  234. export declare namespace Browser {
  235. type GetUserContexts = {
  236. method: 'browser.getUserContexts';
  237. params: EmptyParams;
  238. };
  239. }
  240. export declare namespace Browser {
  241. type GetUserContextsResult = {
  242. userContexts: [Browser.UserContextInfo, ...Browser.UserContextInfo[]];
  243. };
  244. }
  245. export declare namespace Browser {
  246. type RemoveUserContext = {
  247. method: 'browser.removeUserContext';
  248. params: Browser.RemoveUserContextParameters;
  249. };
  250. }
  251. export declare namespace Browser {
  252. type RemoveUserContextParameters = {
  253. userContext: Browser.UserContext;
  254. };
  255. }
  256. export type BrowsingContextCommand = BrowsingContext.Activate | BrowsingContext.CaptureScreenshot | BrowsingContext.Close | BrowsingContext.Create | BrowsingContext.GetTree | BrowsingContext.HandleUserPrompt | BrowsingContext.LocateNodes | BrowsingContext.Navigate | BrowsingContext.Print | BrowsingContext.Reload | BrowsingContext.SetViewport | BrowsingContext.TraverseHistory;
  257. export type BrowsingContextEvent = BrowsingContext.ContextCreated | BrowsingContext.ContextDestroyed | BrowsingContext.DomContentLoaded | BrowsingContext.DownloadWillBegin | BrowsingContext.FragmentNavigated | BrowsingContext.Load | BrowsingContext.NavigationAborted | BrowsingContext.NavigationFailed | BrowsingContext.NavigationStarted | BrowsingContext.UserPromptClosed | BrowsingContext.UserPromptOpened;
  258. export type BrowsingContextResult = BrowsingContext.CaptureScreenshotResult | BrowsingContext.CreateResult | BrowsingContext.GetTreeResult | BrowsingContext.LocateNodesResult | BrowsingContext.NavigateResult | BrowsingContext.PrintResult | BrowsingContext.TraverseHistoryResult;
  259. export declare namespace BrowsingContext {
  260. type BrowsingContext = string;
  261. }
  262. export declare namespace BrowsingContext {
  263. type InfoList = [...BrowsingContext.Info[]];
  264. }
  265. export declare namespace BrowsingContext {
  266. type Info = {
  267. children: BrowsingContext.InfoList | null;
  268. context: BrowsingContext.BrowsingContext;
  269. url: string;
  270. userContext: Browser.UserContext;
  271. parent?: BrowsingContext.BrowsingContext | null;
  272. };
  273. }
  274. export declare namespace BrowsingContext {
  275. type Locator = BrowsingContext.CssLocator | BrowsingContext.InnerTextLocator | BrowsingContext.XPathLocator;
  276. }
  277. export declare namespace BrowsingContext {
  278. type CssLocator = {
  279. type: 'css';
  280. value: string;
  281. };
  282. }
  283. export declare namespace BrowsingContext {
  284. type InnerTextLocator = {
  285. type: 'innerText';
  286. value: string;
  287. ignoreCase?: boolean;
  288. matchType?: 'full' | 'partial';
  289. maxDepth?: JsUint;
  290. };
  291. }
  292. export declare namespace BrowsingContext {
  293. type XPathLocator = {
  294. type: 'xpath';
  295. value: string;
  296. };
  297. }
  298. export declare namespace BrowsingContext {
  299. type Navigation = string;
  300. }
  301. export declare namespace BrowsingContext {
  302. type NavigationInfo = {
  303. context: BrowsingContext.BrowsingContext;
  304. navigation: BrowsingContext.Navigation | null;
  305. timestamp: JsUint;
  306. url: string;
  307. };
  308. }
  309. export declare namespace BrowsingContext {
  310. const enum ReadinessState {
  311. None = "none",
  312. Interactive = "interactive",
  313. Complete = "complete"
  314. }
  315. }
  316. export declare namespace BrowsingContext {
  317. type Activate = {
  318. method: 'browsingContext.activate';
  319. params: BrowsingContext.ActivateParameters;
  320. };
  321. }
  322. export declare namespace BrowsingContext {
  323. type ActivateParameters = {
  324. context: BrowsingContext.BrowsingContext;
  325. };
  326. }
  327. export declare namespace BrowsingContext {
  328. type CaptureScreenshotParameters = {
  329. context: BrowsingContext.BrowsingContext;
  330. /**
  331. * @defaultValue `"viewport"`
  332. */
  333. origin?: 'viewport' | 'document';
  334. format?: BrowsingContext.ImageFormat;
  335. clip?: BrowsingContext.ClipRectangle;
  336. };
  337. }
  338. export declare namespace BrowsingContext {
  339. type CaptureScreenshot = {
  340. method: 'browsingContext.captureScreenshot';
  341. params: BrowsingContext.CaptureScreenshotParameters;
  342. };
  343. }
  344. export declare namespace BrowsingContext {
  345. type ImageFormat = {
  346. type: string;
  347. /**
  348. * Must be between `0` and `1`, inclusive.
  349. */
  350. quality?: number;
  351. };
  352. }
  353. export declare namespace BrowsingContext {
  354. type ClipRectangle = BrowsingContext.BoxClipRectangle | BrowsingContext.ElementClipRectangle;
  355. }
  356. export declare namespace BrowsingContext {
  357. type ElementClipRectangle = {
  358. type: 'element';
  359. element: Script.SharedReference;
  360. };
  361. }
  362. export declare namespace BrowsingContext {
  363. type BoxClipRectangle = {
  364. type: 'box';
  365. x: number;
  366. y: number;
  367. width: number;
  368. height: number;
  369. };
  370. }
  371. export declare namespace BrowsingContext {
  372. type CaptureScreenshotResult = {
  373. data: string;
  374. };
  375. }
  376. export declare namespace BrowsingContext {
  377. type Close = {
  378. method: 'browsingContext.close';
  379. params: BrowsingContext.CloseParameters;
  380. };
  381. }
  382. export declare namespace BrowsingContext {
  383. type CloseParameters = {
  384. context: BrowsingContext.BrowsingContext;
  385. /**
  386. * @defaultValue `false`
  387. */
  388. promptUnload?: boolean;
  389. };
  390. }
  391. export declare namespace BrowsingContext {
  392. type Create = {
  393. method: 'browsingContext.create';
  394. params: BrowsingContext.CreateParameters;
  395. };
  396. }
  397. export declare namespace BrowsingContext {
  398. const enum CreateType {
  399. Tab = "tab",
  400. Window = "window"
  401. }
  402. }
  403. export declare namespace BrowsingContext {
  404. type CreateParameters = {
  405. type: BrowsingContext.CreateType;
  406. referenceContext?: BrowsingContext.BrowsingContext;
  407. /**
  408. * @defaultValue `false`
  409. */
  410. background?: boolean;
  411. userContext?: Browser.UserContext;
  412. };
  413. }
  414. export declare namespace BrowsingContext {
  415. type CreateResult = {
  416. context: BrowsingContext.BrowsingContext;
  417. };
  418. }
  419. export declare namespace BrowsingContext {
  420. type GetTree = {
  421. method: 'browsingContext.getTree';
  422. params: BrowsingContext.GetTreeParameters;
  423. };
  424. }
  425. export declare namespace BrowsingContext {
  426. type GetTreeParameters = {
  427. maxDepth?: JsUint;
  428. root?: BrowsingContext.BrowsingContext;
  429. };
  430. }
  431. export declare namespace BrowsingContext {
  432. type GetTreeResult = {
  433. contexts: BrowsingContext.InfoList;
  434. };
  435. }
  436. export declare namespace BrowsingContext {
  437. type HandleUserPrompt = {
  438. method: 'browsingContext.handleUserPrompt';
  439. params: BrowsingContext.HandleUserPromptParameters;
  440. };
  441. }
  442. export declare namespace BrowsingContext {
  443. type HandleUserPromptParameters = {
  444. context: BrowsingContext.BrowsingContext;
  445. accept?: boolean;
  446. userText?: string;
  447. };
  448. }
  449. export declare namespace BrowsingContext {
  450. type LocateNodesParameters = {
  451. context: BrowsingContext.BrowsingContext;
  452. locator: BrowsingContext.Locator;
  453. /**
  454. * Must be greater than or equal to `1`.
  455. */
  456. maxNodeCount?: JsUint;
  457. serializationOptions?: Script.SerializationOptions;
  458. startNodes?: [Script.SharedReference, ...Script.SharedReference[]];
  459. };
  460. }
  461. export declare namespace BrowsingContext {
  462. type LocateNodes = {
  463. method: 'browsingContext.locateNodes';
  464. params: BrowsingContext.LocateNodesParameters;
  465. };
  466. }
  467. export declare namespace BrowsingContext {
  468. type LocateNodesResult = {
  469. nodes: [...Script.NodeRemoteValue[]];
  470. };
  471. }
  472. export declare namespace BrowsingContext {
  473. type Navigate = {
  474. method: 'browsingContext.navigate';
  475. params: BrowsingContext.NavigateParameters;
  476. };
  477. }
  478. export declare namespace BrowsingContext {
  479. type NavigateParameters = {
  480. context: BrowsingContext.BrowsingContext;
  481. url: string;
  482. wait?: BrowsingContext.ReadinessState;
  483. };
  484. }
  485. export declare namespace BrowsingContext {
  486. type NavigateResult = {
  487. navigation: BrowsingContext.Navigation | null;
  488. url: string;
  489. };
  490. }
  491. export declare namespace BrowsingContext {
  492. type Print = {
  493. method: 'browsingContext.print';
  494. params: BrowsingContext.PrintParameters;
  495. };
  496. }
  497. export declare namespace BrowsingContext {
  498. type PrintParameters = {
  499. context: BrowsingContext.BrowsingContext;
  500. /**
  501. * @defaultValue `false`
  502. */
  503. background?: boolean;
  504. margin?: BrowsingContext.PrintMarginParameters;
  505. /**
  506. * @defaultValue `"portrait"`
  507. */
  508. orientation?: 'portrait' | 'landscape';
  509. page?: BrowsingContext.PrintPageParameters;
  510. pageRanges?: [...(JsUint | string)[]];
  511. /**
  512. * Must be between `0.1` and `2`, inclusive.
  513. *
  514. * @defaultValue `1`
  515. */
  516. scale?: number;
  517. /**
  518. * @defaultValue `true`
  519. */
  520. shrinkToFit?: boolean;
  521. };
  522. }
  523. export declare namespace BrowsingContext {
  524. type PrintMarginParameters = {
  525. /**
  526. * Must be greater than or equal to `0`.
  527. *
  528. * @defaultValue `1`
  529. */
  530. bottom?: number;
  531. /**
  532. * Must be greater than or equal to `0`.
  533. *
  534. * @defaultValue `1`
  535. */
  536. left?: number;
  537. /**
  538. * Must be greater than or equal to `0`.
  539. *
  540. * @defaultValue `1`
  541. */
  542. right?: number;
  543. /**
  544. * Must be greater than or equal to `0`.
  545. *
  546. * @defaultValue `1`
  547. */
  548. top?: number;
  549. };
  550. }
  551. export declare namespace BrowsingContext {
  552. type PrintPageParameters = {
  553. /**
  554. * Must be greater than or equal to `0.0352`.
  555. *
  556. * @defaultValue `27.94`
  557. */
  558. height?: number;
  559. /**
  560. * Must be greater than or equal to `0.0352`.
  561. *
  562. * @defaultValue `21.59`
  563. */
  564. width?: number;
  565. };
  566. }
  567. export declare namespace BrowsingContext {
  568. type PrintResult = {
  569. data: string;
  570. };
  571. }
  572. export declare namespace BrowsingContext {
  573. type Reload = {
  574. method: 'browsingContext.reload';
  575. params: BrowsingContext.ReloadParameters;
  576. };
  577. }
  578. export declare namespace BrowsingContext {
  579. type ReloadParameters = {
  580. context: BrowsingContext.BrowsingContext;
  581. ignoreCache?: boolean;
  582. wait?: BrowsingContext.ReadinessState;
  583. };
  584. }
  585. export declare namespace BrowsingContext {
  586. type SetViewport = {
  587. method: 'browsingContext.setViewport';
  588. params: BrowsingContext.SetViewportParameters;
  589. };
  590. }
  591. export declare namespace BrowsingContext {
  592. type SetViewportParameters = {
  593. context: BrowsingContext.BrowsingContext;
  594. viewport?: BrowsingContext.Viewport | null;
  595. /**
  596. * Must be greater than `0`.
  597. */
  598. devicePixelRatio?: number | null;
  599. };
  600. }
  601. export declare namespace BrowsingContext {
  602. type Viewport = {
  603. width: JsUint;
  604. height: JsUint;
  605. };
  606. }
  607. export declare namespace BrowsingContext {
  608. type TraverseHistory = {
  609. method: 'browsingContext.traverseHistory';
  610. params: BrowsingContext.TraverseHistoryParameters;
  611. };
  612. }
  613. export declare namespace BrowsingContext {
  614. type TraverseHistoryParameters = {
  615. context: BrowsingContext.BrowsingContext;
  616. delta: JsInt;
  617. };
  618. }
  619. export declare namespace BrowsingContext {
  620. type TraverseHistoryResult = Record<string, never>;
  621. }
  622. export declare namespace BrowsingContext {
  623. type ContextCreated = {
  624. method: 'browsingContext.contextCreated';
  625. params: BrowsingContext.Info;
  626. };
  627. }
  628. export declare namespace BrowsingContext {
  629. type ContextDestroyed = {
  630. method: 'browsingContext.contextDestroyed';
  631. params: BrowsingContext.Info;
  632. };
  633. }
  634. export declare namespace BrowsingContext {
  635. type NavigationStarted = {
  636. method: 'browsingContext.navigationStarted';
  637. params: BrowsingContext.NavigationInfo;
  638. };
  639. }
  640. export declare namespace BrowsingContext {
  641. type FragmentNavigated = {
  642. method: 'browsingContext.fragmentNavigated';
  643. params: BrowsingContext.NavigationInfo;
  644. };
  645. }
  646. export declare namespace BrowsingContext {
  647. type DomContentLoaded = {
  648. method: 'browsingContext.domContentLoaded';
  649. params: BrowsingContext.NavigationInfo;
  650. };
  651. }
  652. export declare namespace BrowsingContext {
  653. type Load = {
  654. method: 'browsingContext.load';
  655. params: BrowsingContext.NavigationInfo;
  656. };
  657. }
  658. export declare namespace BrowsingContext {
  659. type DownloadWillBegin = {
  660. method: 'browsingContext.downloadWillBegin';
  661. params: BrowsingContext.NavigationInfo;
  662. };
  663. }
  664. export declare namespace BrowsingContext {
  665. type NavigationAborted = {
  666. method: 'browsingContext.navigationAborted';
  667. params: BrowsingContext.NavigationInfo;
  668. };
  669. }
  670. export declare namespace BrowsingContext {
  671. type NavigationFailed = {
  672. method: 'browsingContext.navigationFailed';
  673. params: BrowsingContext.NavigationInfo;
  674. };
  675. }
  676. export declare namespace BrowsingContext {
  677. type UserPromptClosed = {
  678. method: 'browsingContext.userPromptClosed';
  679. params: BrowsingContext.UserPromptClosedParameters;
  680. };
  681. }
  682. export declare namespace BrowsingContext {
  683. type UserPromptClosedParameters = {
  684. context: BrowsingContext.BrowsingContext;
  685. accepted: boolean;
  686. userText?: string;
  687. };
  688. }
  689. export declare namespace BrowsingContext {
  690. type UserPromptOpened = {
  691. method: 'browsingContext.userPromptOpened';
  692. params: BrowsingContext.UserPromptOpenedParameters;
  693. };
  694. }
  695. export declare namespace BrowsingContext {
  696. type UserPromptOpenedParameters = {
  697. context: BrowsingContext.BrowsingContext;
  698. type: 'alert' | 'confirm' | 'prompt' | 'beforeunload';
  699. message: string;
  700. defaultValue?: string;
  701. };
  702. }
  703. export type NetworkCommand = Network.AddIntercept | Network.ContinueRequest | Network.ContinueResponse | Network.ContinueWithAuth | Network.FailRequest | Network.ProvideResponse | Network.RemoveIntercept;
  704. export type NetworkEvent = Network.AuthRequired | Network.BeforeRequestSent | Network.FetchError | Network.ResponseCompleted | Network.ResponseStarted;
  705. export type NetworkResult = Network.AddInterceptResult;
  706. export declare namespace Network {
  707. type AuthChallenge = {
  708. scheme: string;
  709. realm: string;
  710. };
  711. }
  712. export declare namespace Network {
  713. type AuthCredentials = {
  714. type: 'password';
  715. username: string;
  716. password: string;
  717. };
  718. }
  719. export declare namespace Network {
  720. type BaseParameters = {
  721. context: BrowsingContext.BrowsingContext | null;
  722. isBlocked: boolean;
  723. navigation: BrowsingContext.Navigation | null;
  724. redirectCount: JsUint;
  725. request: Network.RequestData;
  726. timestamp: JsUint;
  727. intercepts?: [Network.Intercept, ...Network.Intercept[]];
  728. };
  729. }
  730. export declare namespace Network {
  731. type BytesValue = Network.StringValue | Network.Base64Value;
  732. }
  733. export declare namespace Network {
  734. type StringValue = {
  735. type: 'string';
  736. value: string;
  737. };
  738. }
  739. export declare namespace Network {
  740. type Base64Value = {
  741. type: 'base64';
  742. value: string;
  743. };
  744. }
  745. export declare namespace Network {
  746. const enum SameSite {
  747. Strict = "strict",
  748. Lax = "lax",
  749. None = "none"
  750. }
  751. }
  752. export declare namespace Network {
  753. type Cookie = {
  754. name: string;
  755. value: Network.BytesValue;
  756. domain: string;
  757. path: string;
  758. size: JsUint;
  759. httpOnly: boolean;
  760. secure: boolean;
  761. sameSite: Network.SameSite;
  762. expiry?: JsUint;
  763. } & Extensible;
  764. }
  765. export declare namespace Network {
  766. type CookieHeader = {
  767. name: string;
  768. value: Network.BytesValue;
  769. };
  770. }
  771. export declare namespace Network {
  772. type FetchTimingInfo = {
  773. timeOrigin: number;
  774. requestTime: number;
  775. redirectStart: number;
  776. redirectEnd: number;
  777. fetchStart: number;
  778. dnsStart: number;
  779. dnsEnd: number;
  780. connectStart: number;
  781. connectEnd: number;
  782. tlsStart: number;
  783. requestStart: number;
  784. responseStart: number;
  785. responseEnd: number;
  786. };
  787. }
  788. export declare namespace Network {
  789. type Header = {
  790. name: string;
  791. value: Network.BytesValue;
  792. };
  793. }
  794. export declare namespace Network {
  795. type Initiator = {
  796. type: 'parser' | 'script' | 'preflight' | 'other';
  797. columnNumber?: JsUint;
  798. lineNumber?: JsUint;
  799. stackTrace?: Script.StackTrace;
  800. request?: Network.Request;
  801. };
  802. }
  803. export declare namespace Network {
  804. type Intercept = string;
  805. }
  806. export declare namespace Network {
  807. type Request = string;
  808. }
  809. export declare namespace Network {
  810. type RequestData = {
  811. request: Network.Request;
  812. url: string;
  813. method: string;
  814. headers: [...Network.Header[]];
  815. cookies: [...Network.Cookie[]];
  816. headersSize: JsUint;
  817. bodySize: JsUint | null;
  818. timings: Network.FetchTimingInfo;
  819. };
  820. }
  821. export declare namespace Network {
  822. type ResponseContent = {
  823. size: JsUint;
  824. };
  825. }
  826. export declare namespace Network {
  827. type ResponseData = {
  828. url: string;
  829. protocol: string;
  830. status: JsUint;
  831. statusText: string;
  832. fromCache: boolean;
  833. headers: [...Network.Header[]];
  834. mimeType: string;
  835. bytesReceived: JsUint;
  836. headersSize: JsUint | null;
  837. bodySize: JsUint | null;
  838. content: Network.ResponseContent;
  839. authChallenges?: [...Network.AuthChallenge[]];
  840. };
  841. }
  842. export declare namespace Network {
  843. type SetCookieHeader = {
  844. name: string;
  845. value: Network.BytesValue;
  846. domain?: string;
  847. httpOnly?: boolean;
  848. expiry?: string;
  849. maxAge?: JsInt;
  850. path?: string;
  851. sameSite?: Network.SameSite;
  852. secure?: boolean;
  853. };
  854. }
  855. export declare namespace Network {
  856. type UrlPattern = Network.UrlPatternPattern | Network.UrlPatternString;
  857. }
  858. export declare namespace Network {
  859. type UrlPatternPattern = {
  860. type: 'pattern';
  861. protocol?: string;
  862. hostname?: string;
  863. port?: string;
  864. pathname?: string;
  865. search?: string;
  866. };
  867. }
  868. export declare namespace Network {
  869. type UrlPatternString = {
  870. type: 'string';
  871. pattern: string;
  872. };
  873. }
  874. export declare namespace Network {
  875. type AddInterceptParameters = {
  876. phases: [Network.InterceptPhase, ...Network.InterceptPhase[]];
  877. contexts?: [
  878. BrowsingContext.BrowsingContext,
  879. ...BrowsingContext.BrowsingContext[]
  880. ];
  881. urlPatterns?: [...Network.UrlPattern[]];
  882. };
  883. }
  884. export declare namespace Network {
  885. type AddIntercept = {
  886. method: 'network.addIntercept';
  887. params: Network.AddInterceptParameters;
  888. };
  889. }
  890. export declare namespace Network {
  891. const enum InterceptPhase {
  892. BeforeRequestSent = "beforeRequestSent",
  893. ResponseStarted = "responseStarted",
  894. AuthRequired = "authRequired"
  895. }
  896. }
  897. export declare namespace Network {
  898. type AddInterceptResult = {
  899. intercept: Network.Intercept;
  900. };
  901. }
  902. export declare namespace Network {
  903. type ContinueRequest = {
  904. method: 'network.continueRequest';
  905. params: Network.ContinueRequestParameters;
  906. };
  907. }
  908. export declare namespace Network {
  909. type ContinueRequestParameters = {
  910. request: Network.Request;
  911. body?: Network.BytesValue;
  912. cookies?: [...Network.CookieHeader[]];
  913. headers?: [...Network.Header[]];
  914. method?: string;
  915. url?: string;
  916. };
  917. }
  918. export declare namespace Network {
  919. type ContinueResponse = {
  920. method: 'network.continueResponse';
  921. params: Network.ContinueResponseParameters;
  922. };
  923. }
  924. export declare namespace Network {
  925. type ContinueResponseParameters = {
  926. request: Network.Request;
  927. cookies?: [...Network.SetCookieHeader[]];
  928. credentials?: Network.AuthCredentials;
  929. headers?: [...Network.Header[]];
  930. reasonPhrase?: string;
  931. statusCode?: JsUint;
  932. };
  933. }
  934. export declare namespace Network {
  935. type ContinueWithAuth = {
  936. method: 'network.continueWithAuth';
  937. params: Network.ContinueWithAuthParameters;
  938. };
  939. }
  940. export declare namespace Network {
  941. type ContinueWithAuthParameters = {
  942. request: Network.Request;
  943. } & (Network.ContinueWithAuthCredentials | Network.ContinueWithAuthNoCredentials);
  944. }
  945. export declare namespace Network {
  946. type ContinueWithAuthCredentials = {
  947. action: 'provideCredentials';
  948. credentials: Network.AuthCredentials;
  949. };
  950. }
  951. export declare namespace Network {
  952. type ContinueWithAuthNoCredentials = {
  953. action: 'default' | 'cancel';
  954. };
  955. }
  956. export declare namespace Network {
  957. type FailRequest = {
  958. method: 'network.failRequest';
  959. params: Network.FailRequestParameters;
  960. };
  961. }
  962. export declare namespace Network {
  963. type FailRequestParameters = {
  964. request: Network.Request;
  965. };
  966. }
  967. export declare namespace Network {
  968. type ProvideResponse = {
  969. method: 'network.provideResponse';
  970. params: Network.ProvideResponseParameters;
  971. };
  972. }
  973. export declare namespace Network {
  974. type ProvideResponseParameters = {
  975. request: Network.Request;
  976. body?: Network.BytesValue;
  977. cookies?: [...Network.SetCookieHeader[]];
  978. headers?: [...Network.Header[]];
  979. reasonPhrase?: string;
  980. statusCode?: JsUint;
  981. };
  982. }
  983. export declare namespace Network {
  984. type RemoveIntercept = {
  985. method: 'network.removeIntercept';
  986. params: Network.RemoveInterceptParameters;
  987. };
  988. }
  989. export declare namespace Network {
  990. type RemoveInterceptParameters = {
  991. intercept: Network.Intercept;
  992. };
  993. }
  994. export type ScriptEvent = Script.Message | Script.RealmCreated | Script.RealmDestroyed;
  995. export declare namespace Network {
  996. type AuthRequiredParameters = Network.BaseParameters & {
  997. response: Network.ResponseData;
  998. };
  999. }
  1000. export declare namespace Network {
  1001. type BeforeRequestSentParameters = Network.BaseParameters & {
  1002. initiator: Network.Initiator;
  1003. };
  1004. }
  1005. export declare namespace Network {
  1006. type FetchErrorParameters = Network.BaseParameters & {
  1007. errorText: string;
  1008. };
  1009. }
  1010. export declare namespace Network {
  1011. type ResponseCompletedParameters = Network.BaseParameters & {
  1012. response: Network.ResponseData;
  1013. };
  1014. }
  1015. export declare namespace Network {
  1016. type ResponseStartedParameters = Network.BaseParameters & {
  1017. response: Network.ResponseData;
  1018. };
  1019. }
  1020. export type ScriptCommand = Script.AddPreloadScript | Script.CallFunction | Script.Disown | Script.Evaluate | Script.GetRealms | Script.RemovePreloadScript;
  1021. export type ScriptResult = Script.AddPreloadScriptResult | Script.EvaluateResult | Script.GetRealmsResult;
  1022. export declare namespace Network {
  1023. type AuthRequired = {
  1024. method: 'network.authRequired';
  1025. params: Network.AuthRequiredParameters;
  1026. };
  1027. }
  1028. export declare namespace Network {
  1029. type BeforeRequestSent = {
  1030. method: 'network.beforeRequestSent';
  1031. params: Network.BeforeRequestSentParameters;
  1032. };
  1033. }
  1034. export declare namespace Network {
  1035. type FetchError = {
  1036. method: 'network.fetchError';
  1037. params: Network.FetchErrorParameters;
  1038. };
  1039. }
  1040. export declare namespace Network {
  1041. type ResponseCompleted = {
  1042. method: 'network.responseCompleted';
  1043. params: Network.ResponseCompletedParameters;
  1044. };
  1045. }
  1046. export declare namespace Network {
  1047. type ResponseStarted = {
  1048. method: 'network.responseStarted';
  1049. params: Network.ResponseStartedParameters;
  1050. };
  1051. }
  1052. export declare namespace Script {
  1053. type Channel = string;
  1054. }
  1055. export declare namespace Script {
  1056. type EvaluateResultSuccess = {
  1057. type: 'success';
  1058. result: Script.RemoteValue;
  1059. realm: Script.Realm;
  1060. };
  1061. }
  1062. export declare namespace Script {
  1063. type ExceptionDetails = {
  1064. columnNumber: JsUint;
  1065. exception: Script.RemoteValue;
  1066. lineNumber: JsUint;
  1067. stackTrace: Script.StackTrace;
  1068. text: string;
  1069. };
  1070. }
  1071. export declare namespace Script {
  1072. type ChannelValue = {
  1073. type: 'channel';
  1074. value: Script.ChannelProperties;
  1075. };
  1076. }
  1077. export declare namespace Script {
  1078. type ChannelProperties = {
  1079. channel: Script.Channel;
  1080. serializationOptions?: Script.SerializationOptions;
  1081. ownership?: Script.ResultOwnership;
  1082. };
  1083. }
  1084. export declare namespace Script {
  1085. type EvaluateResult = Script.EvaluateResultSuccess | Script.EvaluateResultException;
  1086. }
  1087. export declare namespace Script {
  1088. type EvaluateResultException = {
  1089. type: 'exception';
  1090. exceptionDetails: Script.ExceptionDetails;
  1091. realm: Script.Realm;
  1092. };
  1093. }
  1094. export declare namespace Script {
  1095. type Handle = string;
  1096. }
  1097. export declare namespace Script {
  1098. type InternalId = string;
  1099. }
  1100. export declare namespace Script {
  1101. type ListLocalValue = [...Script.LocalValue[]];
  1102. }
  1103. export declare namespace Script {
  1104. type LocalValue = Script.RemoteReference | Script.PrimitiveProtocolValue | Script.ChannelValue | Script.ArrayLocalValue | Script.DateLocalValue | Script.MapLocalValue | Script.ObjectLocalValue | Script.RegExpLocalValue | Script.SetLocalValue;
  1105. }
  1106. export declare namespace Script {
  1107. type ArrayLocalValue = {
  1108. type: 'array';
  1109. value: Script.ListLocalValue;
  1110. };
  1111. }
  1112. export declare namespace Script {
  1113. type DateLocalValue = {
  1114. type: 'date';
  1115. value: string;
  1116. };
  1117. }
  1118. export declare namespace Script {
  1119. type MappingLocalValue = [
  1120. ...[Script.LocalValue | string, Script.LocalValue][]
  1121. ];
  1122. }
  1123. export declare namespace Script {
  1124. type MapLocalValue = {
  1125. type: 'map';
  1126. value: Script.MappingLocalValue;
  1127. };
  1128. }
  1129. export declare namespace Script {
  1130. type ObjectLocalValue = {
  1131. type: 'object';
  1132. value: Script.MappingLocalValue;
  1133. };
  1134. }
  1135. export declare namespace Script {
  1136. type RegExpValue = {
  1137. pattern: string;
  1138. flags?: string;
  1139. };
  1140. }
  1141. export declare namespace Script {
  1142. type RegExpLocalValue = {
  1143. type: 'regexp';
  1144. value: Script.RegExpValue;
  1145. };
  1146. }
  1147. export declare namespace Script {
  1148. type SetLocalValue = {
  1149. type: 'set';
  1150. value: Script.ListLocalValue;
  1151. };
  1152. }
  1153. export declare namespace Script {
  1154. type PreloadScript = string;
  1155. }
  1156. export declare namespace Script {
  1157. type Realm = string;
  1158. }
  1159. export declare namespace Script {
  1160. type PrimitiveProtocolValue = Script.UndefinedValue | Script.NullValue | Script.StringValue | Script.NumberValue | Script.BooleanValue | Script.BigIntValue;
  1161. }
  1162. export declare namespace Script {
  1163. type UndefinedValue = {
  1164. type: 'undefined';
  1165. };
  1166. }
  1167. export declare namespace Script {
  1168. type NullValue = {
  1169. type: 'null';
  1170. };
  1171. }
  1172. export declare namespace Script {
  1173. type StringValue = {
  1174. type: 'string';
  1175. value: string;
  1176. };
  1177. }
  1178. export declare namespace Script {
  1179. type SpecialNumber = 'NaN' | '-0' | 'Infinity' | '-Infinity';
  1180. }
  1181. export declare namespace Script {
  1182. type NumberValue = {
  1183. type: 'number';
  1184. value: number | Script.SpecialNumber;
  1185. };
  1186. }
  1187. export declare namespace Script {
  1188. type BooleanValue = {
  1189. type: 'boolean';
  1190. value: boolean;
  1191. };
  1192. }
  1193. export declare namespace Script {
  1194. type BigIntValue = {
  1195. type: 'bigint';
  1196. value: string;
  1197. };
  1198. }
  1199. export declare namespace Script {
  1200. type RealmInfo = Script.WindowRealmInfo | Script.DedicatedWorkerRealmInfo | Script.SharedWorkerRealmInfo | Script.ServiceWorkerRealmInfo | Script.WorkerRealmInfo | Script.PaintWorkletRealmInfo | Script.AudioWorkletRealmInfo | Script.WorkletRealmInfo;
  1201. }
  1202. export declare namespace Script {
  1203. type BaseRealmInfo = {
  1204. realm: Script.Realm;
  1205. origin: string;
  1206. };
  1207. }
  1208. export declare namespace Script {
  1209. type WindowRealmInfo = Script.BaseRealmInfo & {
  1210. type: 'window';
  1211. context: BrowsingContext.BrowsingContext;
  1212. sandbox?: string;
  1213. };
  1214. }
  1215. export declare namespace Script {
  1216. type DedicatedWorkerRealmInfo = Script.BaseRealmInfo & {
  1217. type: 'dedicated-worker';
  1218. owners: [Script.Realm];
  1219. };
  1220. }
  1221. export declare namespace Script {
  1222. type SharedWorkerRealmInfo = Script.BaseRealmInfo & {
  1223. type: 'shared-worker';
  1224. };
  1225. }
  1226. export declare namespace Script {
  1227. type ServiceWorkerRealmInfo = Script.BaseRealmInfo & {
  1228. type: 'service-worker';
  1229. };
  1230. }
  1231. export declare namespace Script {
  1232. type WorkerRealmInfo = Script.BaseRealmInfo & {
  1233. type: 'worker';
  1234. };
  1235. }
  1236. export declare namespace Script {
  1237. type PaintWorkletRealmInfo = Script.BaseRealmInfo & {
  1238. type: 'paint-worklet';
  1239. };
  1240. }
  1241. export declare namespace Script {
  1242. type AudioWorkletRealmInfo = Script.BaseRealmInfo & {
  1243. type: 'audio-worklet';
  1244. };
  1245. }
  1246. export declare namespace Script {
  1247. type WorkletRealmInfo = Script.BaseRealmInfo & {
  1248. type: 'worklet';
  1249. };
  1250. }
  1251. export declare namespace Script {
  1252. type RealmType = 'window' | 'dedicated-worker' | 'shared-worker' | 'service-worker' | 'worker' | 'paint-worklet' | 'audio-worklet' | 'worklet';
  1253. }
  1254. export declare namespace Script {
  1255. type ListRemoteValue = [...Script.RemoteValue[]];
  1256. }
  1257. export declare namespace Script {
  1258. type MappingRemoteValue = [
  1259. ...[Script.RemoteValue | string, Script.RemoteValue][]
  1260. ];
  1261. }
  1262. export declare namespace Script {
  1263. type RemoteValue = Script.PrimitiveProtocolValue | Script.SymbolRemoteValue | Script.ArrayRemoteValue | Script.ObjectRemoteValue | Script.FunctionRemoteValue | Script.RegExpRemoteValue | Script.DateRemoteValue | Script.MapRemoteValue | Script.SetRemoteValue | Script.WeakMapRemoteValue | Script.WeakSetRemoteValue | Script.GeneratorRemoteValue | Script.ErrorRemoteValue | Script.ProxyRemoteValue | Script.PromiseRemoteValue | Script.TypedArrayRemoteValue | Script.ArrayBufferRemoteValue | Script.NodeListRemoteValue | Script.HtmlCollectionRemoteValue | Script.NodeRemoteValue | Script.WindowProxyRemoteValue;
  1264. }
  1265. export declare namespace Script {
  1266. type RemoteReference = Script.SharedReference | Script.RemoteObjectReference;
  1267. }
  1268. export declare namespace Script {
  1269. type SharedReference = {
  1270. sharedId: Script.SharedId;
  1271. handle?: Script.Handle;
  1272. } & Extensible;
  1273. }
  1274. export declare namespace Script {
  1275. type RemoteObjectReference = {
  1276. handle: Script.Handle;
  1277. sharedId?: Script.SharedId;
  1278. } & Extensible;
  1279. }
  1280. export declare namespace Script {
  1281. type SymbolRemoteValue = {
  1282. type: 'symbol';
  1283. handle?: Script.Handle;
  1284. internalId?: Script.InternalId;
  1285. };
  1286. }
  1287. export declare namespace Script {
  1288. type ArrayRemoteValue = {
  1289. type: 'array';
  1290. handle?: Script.Handle;
  1291. internalId?: Script.InternalId;
  1292. value?: Script.ListRemoteValue;
  1293. };
  1294. }
  1295. export declare namespace Script {
  1296. type ObjectRemoteValue = {
  1297. type: 'object';
  1298. handle?: Script.Handle;
  1299. internalId?: Script.InternalId;
  1300. value?: Script.MappingRemoteValue;
  1301. };
  1302. }
  1303. export declare namespace Script {
  1304. type FunctionRemoteValue = {
  1305. type: 'function';
  1306. handle?: Script.Handle;
  1307. internalId?: Script.InternalId;
  1308. };
  1309. }
  1310. export declare namespace Script {
  1311. type RegExpRemoteValue = {
  1312. handle?: Script.Handle;
  1313. internalId?: Script.InternalId;
  1314. } & Script.RegExpLocalValue;
  1315. }
  1316. export declare namespace Script {
  1317. type DateRemoteValue = {
  1318. handle?: Script.Handle;
  1319. internalId?: Script.InternalId;
  1320. } & Script.DateLocalValue;
  1321. }
  1322. export declare namespace Script {
  1323. type MapRemoteValue = {
  1324. type: 'map';
  1325. handle?: Script.Handle;
  1326. internalId?: Script.InternalId;
  1327. value?: Script.MappingRemoteValue;
  1328. };
  1329. }
  1330. export declare namespace Script {
  1331. type SetRemoteValue = {
  1332. type: 'set';
  1333. handle?: Script.Handle;
  1334. internalId?: Script.InternalId;
  1335. value?: Script.ListRemoteValue;
  1336. };
  1337. }
  1338. export declare namespace Script {
  1339. type WeakMapRemoteValue = {
  1340. type: 'weakmap';
  1341. handle?: Script.Handle;
  1342. internalId?: Script.InternalId;
  1343. };
  1344. }
  1345. export declare namespace Script {
  1346. type WeakSetRemoteValue = {
  1347. type: 'weakset';
  1348. handle?: Script.Handle;
  1349. internalId?: Script.InternalId;
  1350. };
  1351. }
  1352. export declare namespace Script {
  1353. type GeneratorRemoteValue = {
  1354. type: 'generator';
  1355. handle?: Script.Handle;
  1356. internalId?: Script.InternalId;
  1357. };
  1358. }
  1359. export declare namespace Script {
  1360. type ErrorRemoteValue = {
  1361. type: 'error';
  1362. handle?: Script.Handle;
  1363. internalId?: Script.InternalId;
  1364. };
  1365. }
  1366. export declare namespace Script {
  1367. type ProxyRemoteValue = {
  1368. type: 'proxy';
  1369. handle?: Script.Handle;
  1370. internalId?: Script.InternalId;
  1371. };
  1372. }
  1373. export declare namespace Script {
  1374. type PromiseRemoteValue = {
  1375. type: 'promise';
  1376. handle?: Script.Handle;
  1377. internalId?: Script.InternalId;
  1378. };
  1379. }
  1380. export declare namespace Script {
  1381. type TypedArrayRemoteValue = {
  1382. type: 'typedarray';
  1383. handle?: Script.Handle;
  1384. internalId?: Script.InternalId;
  1385. };
  1386. }
  1387. export declare namespace Script {
  1388. type ArrayBufferRemoteValue = {
  1389. type: 'arraybuffer';
  1390. handle?: Script.Handle;
  1391. internalId?: Script.InternalId;
  1392. };
  1393. }
  1394. export declare namespace Script {
  1395. type NodeListRemoteValue = {
  1396. type: 'nodelist';
  1397. handle?: Script.Handle;
  1398. internalId?: Script.InternalId;
  1399. value?: Script.ListRemoteValue;
  1400. };
  1401. }
  1402. export declare namespace Script {
  1403. type HtmlCollectionRemoteValue = {
  1404. type: 'htmlcollection';
  1405. handle?: Script.Handle;
  1406. internalId?: Script.InternalId;
  1407. value?: Script.ListRemoteValue;
  1408. };
  1409. }
  1410. export declare namespace Script {
  1411. type NodeRemoteValue = {
  1412. type: 'node';
  1413. sharedId?: Script.SharedId;
  1414. handle?: Script.Handle;
  1415. internalId?: Script.InternalId;
  1416. value?: Script.NodeProperties;
  1417. };
  1418. }
  1419. export declare namespace Script {
  1420. type NodeProperties = {
  1421. nodeType: JsUint;
  1422. childNodeCount: JsUint;
  1423. attributes?: {
  1424. [key: string]: string;
  1425. };
  1426. children?: [...Script.NodeRemoteValue[]];
  1427. localName?: string;
  1428. mode?: 'open' | 'closed';
  1429. namespaceURI?: string;
  1430. nodeValue?: string;
  1431. shadowRoot?: Script.NodeRemoteValue | null;
  1432. };
  1433. }
  1434. export declare namespace Script {
  1435. type WindowProxyRemoteValue = {
  1436. type: 'window';
  1437. value: Script.WindowProxyProperties;
  1438. handle?: Script.Handle;
  1439. internalId?: Script.InternalId;
  1440. };
  1441. }
  1442. export declare namespace Script {
  1443. type WindowProxyProperties = {
  1444. context: BrowsingContext.BrowsingContext;
  1445. };
  1446. }
  1447. export declare namespace Script {
  1448. const enum ResultOwnership {
  1449. Root = "root",
  1450. None = "none"
  1451. }
  1452. }
  1453. export declare namespace Script {
  1454. type SerializationOptions = {
  1455. /**
  1456. * @defaultValue `0`
  1457. */
  1458. maxDomDepth?: JsUint | null;
  1459. /**
  1460. * @defaultValue `null`
  1461. */
  1462. maxObjectDepth?: JsUint | null;
  1463. /**
  1464. * @defaultValue `"none"`
  1465. */
  1466. includeShadowTree?: 'none' | 'open' | 'all';
  1467. };
  1468. }
  1469. export declare namespace Script {
  1470. type SharedId = string;
  1471. }
  1472. export declare namespace Script {
  1473. type StackFrame = {
  1474. columnNumber: JsUint;
  1475. functionName: string;
  1476. lineNumber: JsUint;
  1477. url: string;
  1478. };
  1479. }
  1480. export declare namespace Script {
  1481. type StackTrace = {
  1482. callFrames: [...Script.StackFrame[]];
  1483. };
  1484. }
  1485. export declare namespace Script {
  1486. type Source = {
  1487. realm: Script.Realm;
  1488. context?: BrowsingContext.BrowsingContext;
  1489. };
  1490. }
  1491. export declare namespace Script {
  1492. type RealmTarget = {
  1493. realm: Script.Realm;
  1494. };
  1495. }
  1496. export declare namespace Script {
  1497. type ContextTarget = {
  1498. context: BrowsingContext.BrowsingContext;
  1499. sandbox?: string;
  1500. };
  1501. }
  1502. export declare namespace Script {
  1503. type Target = Script.ContextTarget | Script.RealmTarget;
  1504. }
  1505. export declare namespace Script {
  1506. type AddPreloadScript = {
  1507. method: 'script.addPreloadScript';
  1508. params: Script.AddPreloadScriptParameters;
  1509. };
  1510. }
  1511. export declare namespace Script {
  1512. type AddPreloadScriptParameters = {
  1513. functionDeclaration: string;
  1514. arguments?: [...Script.ChannelValue[]];
  1515. contexts?: [
  1516. BrowsingContext.BrowsingContext,
  1517. ...BrowsingContext.BrowsingContext[]
  1518. ];
  1519. sandbox?: string;
  1520. };
  1521. }
  1522. export declare namespace Script {
  1523. type AddPreloadScriptResult = {
  1524. script: Script.PreloadScript;
  1525. };
  1526. }
  1527. export declare namespace Script {
  1528. type Disown = {
  1529. method: 'script.disown';
  1530. params: Script.DisownParameters;
  1531. };
  1532. }
  1533. export declare namespace Script {
  1534. type DisownParameters = {
  1535. handles: [...Script.Handle[]];
  1536. target: Script.Target;
  1537. };
  1538. }
  1539. export declare namespace Script {
  1540. type CallFunctionParameters = {
  1541. functionDeclaration: string;
  1542. awaitPromise: boolean;
  1543. target: Script.Target;
  1544. arguments?: [...Script.LocalValue[]];
  1545. resultOwnership?: Script.ResultOwnership;
  1546. serializationOptions?: Script.SerializationOptions;
  1547. this?: Script.LocalValue;
  1548. /**
  1549. * @defaultValue `false`
  1550. */
  1551. userActivation?: boolean;
  1552. };
  1553. }
  1554. export declare namespace Script {
  1555. type CallFunction = {
  1556. method: 'script.callFunction';
  1557. params: Script.CallFunctionParameters;
  1558. };
  1559. }
  1560. export declare namespace Script {
  1561. type Evaluate = {
  1562. method: 'script.evaluate';
  1563. params: Script.EvaluateParameters;
  1564. };
  1565. }
  1566. export declare namespace Script {
  1567. type EvaluateParameters = {
  1568. expression: string;
  1569. target: Script.Target;
  1570. awaitPromise: boolean;
  1571. resultOwnership?: Script.ResultOwnership;
  1572. serializationOptions?: Script.SerializationOptions;
  1573. /**
  1574. * @defaultValue `false`
  1575. */
  1576. userActivation?: boolean;
  1577. };
  1578. }
  1579. export declare namespace Script {
  1580. type GetRealms = {
  1581. method: 'script.getRealms';
  1582. params: Script.GetRealmsParameters;
  1583. };
  1584. }
  1585. export declare namespace Script {
  1586. type GetRealmsParameters = {
  1587. context?: BrowsingContext.BrowsingContext;
  1588. type?: Script.RealmType;
  1589. };
  1590. }
  1591. export declare namespace Script {
  1592. type GetRealmsResult = {
  1593. realms: [...Script.RealmInfo[]];
  1594. };
  1595. }
  1596. export declare namespace Script {
  1597. type RemovePreloadScript = {
  1598. method: 'script.removePreloadScript';
  1599. params: Script.RemovePreloadScriptParameters;
  1600. };
  1601. }
  1602. export declare namespace Script {
  1603. type RemovePreloadScriptParameters = {
  1604. script: Script.PreloadScript;
  1605. };
  1606. }
  1607. export declare namespace Script {
  1608. type MessageParameters = {
  1609. channel: Script.Channel;
  1610. data: Script.RemoteValue;
  1611. source: Script.Source;
  1612. };
  1613. }
  1614. export declare namespace Script {
  1615. type RealmCreated = {
  1616. method: 'script.realmCreated';
  1617. params: Script.RealmInfo;
  1618. };
  1619. }
  1620. export declare namespace Script {
  1621. type Message = {
  1622. method: 'script.message';
  1623. params: Script.MessageParameters;
  1624. };
  1625. }
  1626. export declare namespace Script {
  1627. type RealmDestroyed = {
  1628. method: 'script.realmDestroyed';
  1629. params: Script.RealmDestroyedParameters;
  1630. };
  1631. }
  1632. export declare namespace Script {
  1633. type RealmDestroyedParameters = {
  1634. realm: Script.Realm;
  1635. };
  1636. }
  1637. export type StorageCommand = Storage.DeleteCookies | Storage.GetCookies | Storage.SetCookie;
  1638. export type StorageResult = Storage.DeleteCookiesResult | Storage.GetCookiesResult | Storage.SetCookieResult;
  1639. export declare namespace Storage {
  1640. type PartitionKey = {
  1641. userContext?: string;
  1642. sourceOrigin?: string;
  1643. } & Extensible;
  1644. }
  1645. export declare namespace Storage {
  1646. type GetCookies = {
  1647. method: 'storage.getCookies';
  1648. params: Storage.GetCookiesParameters;
  1649. };
  1650. }
  1651. export declare namespace Storage {
  1652. type CookieFilter = {
  1653. name?: string;
  1654. value?: Network.BytesValue;
  1655. domain?: string;
  1656. path?: string;
  1657. size?: JsUint;
  1658. httpOnly?: boolean;
  1659. secure?: boolean;
  1660. sameSite?: Network.SameSite;
  1661. expiry?: JsUint;
  1662. } & Extensible;
  1663. }
  1664. export declare namespace Storage {
  1665. type BrowsingContextPartitionDescriptor = {
  1666. type: 'context';
  1667. context: BrowsingContext.BrowsingContext;
  1668. };
  1669. }
  1670. export declare namespace Storage {
  1671. type StorageKeyPartitionDescriptor = {
  1672. type: 'storageKey';
  1673. userContext?: string;
  1674. sourceOrigin?: string;
  1675. } & Extensible;
  1676. }
  1677. export declare namespace Storage {
  1678. type PartitionDescriptor = Storage.BrowsingContextPartitionDescriptor | Storage.StorageKeyPartitionDescriptor;
  1679. }
  1680. export declare namespace Storage {
  1681. type GetCookiesParameters = {
  1682. filter?: Storage.CookieFilter;
  1683. partition?: Storage.PartitionDescriptor;
  1684. };
  1685. }
  1686. export declare namespace Storage {
  1687. type GetCookiesResult = {
  1688. cookies: [...Network.Cookie[]];
  1689. partitionKey: Storage.PartitionKey;
  1690. };
  1691. }
  1692. export declare namespace Storage {
  1693. type SetCookie = {
  1694. method: 'storage.setCookie';
  1695. params: Storage.SetCookieParameters;
  1696. };
  1697. }
  1698. export declare namespace Storage {
  1699. type PartialCookie = {
  1700. name: string;
  1701. value: Network.BytesValue;
  1702. domain: string;
  1703. path?: string;
  1704. httpOnly?: boolean;
  1705. secure?: boolean;
  1706. sameSite?: Network.SameSite;
  1707. expiry?: JsUint;
  1708. } & Extensible;
  1709. }
  1710. export declare namespace Storage {
  1711. type SetCookieParameters = {
  1712. cookie: Storage.PartialCookie;
  1713. partition?: Storage.PartitionDescriptor;
  1714. };
  1715. }
  1716. export declare namespace Storage {
  1717. type SetCookieResult = {
  1718. partitionKey: Storage.PartitionKey;
  1719. };
  1720. }
  1721. export declare namespace Storage {
  1722. type DeleteCookies = {
  1723. method: 'storage.deleteCookies';
  1724. params: Storage.DeleteCookiesParameters;
  1725. };
  1726. }
  1727. export declare namespace Storage {
  1728. type DeleteCookiesParameters = {
  1729. filter?: Storage.CookieFilter;
  1730. partition?: Storage.PartitionDescriptor;
  1731. };
  1732. }
  1733. export declare namespace Storage {
  1734. type DeleteCookiesResult = {
  1735. partitionKey: Storage.PartitionKey;
  1736. };
  1737. }
  1738. export type LogEvent = Log.EntryAdded;
  1739. export declare namespace Log {
  1740. const enum Level {
  1741. Debug = "debug",
  1742. Info = "info",
  1743. Warn = "warn",
  1744. Error = "error"
  1745. }
  1746. }
  1747. export declare namespace Log {
  1748. type Entry = Log.GenericLogEntry | Log.ConsoleLogEntry | Log.JavascriptLogEntry;
  1749. }
  1750. export declare namespace Log {
  1751. type BaseLogEntry = {
  1752. level: Log.Level;
  1753. source: Script.Source;
  1754. text: string | null;
  1755. timestamp: JsUint;
  1756. stackTrace?: Script.StackTrace;
  1757. };
  1758. }
  1759. export declare namespace Log {
  1760. type GenericLogEntry = Log.BaseLogEntry & {
  1761. type: string;
  1762. };
  1763. }
  1764. export declare namespace Log {
  1765. type ConsoleLogEntry = Log.BaseLogEntry & {
  1766. type: 'console';
  1767. method: string;
  1768. args: [...Script.RemoteValue[]];
  1769. };
  1770. }
  1771. export declare namespace Log {
  1772. type JavascriptLogEntry = Log.BaseLogEntry & {
  1773. type: 'javascript';
  1774. };
  1775. }
  1776. export declare namespace Log {
  1777. type EntryAdded = {
  1778. method: 'log.entryAdded';
  1779. params: Log.Entry;
  1780. };
  1781. }
  1782. export type InputCommand = Input.PerformActions | Input.ReleaseActions | Input.SetFiles;
  1783. export declare namespace Input {
  1784. type ElementOrigin = {
  1785. type: 'element';
  1786. element: Script.SharedReference;
  1787. };
  1788. }
  1789. export declare namespace Input {
  1790. type PerformActionsParameters = {
  1791. context: BrowsingContext.BrowsingContext;
  1792. actions: [...Input.SourceActions[]];
  1793. };
  1794. }
  1795. export declare namespace Input {
  1796. type NoneSourceActions = {
  1797. type: 'none';
  1798. id: string;
  1799. actions: [...Input.NoneSourceAction[]];
  1800. };
  1801. }
  1802. export declare namespace Input {
  1803. type KeySourceActions = {
  1804. type: 'key';
  1805. id: string;
  1806. actions: [...Input.KeySourceAction[]];
  1807. };
  1808. }
  1809. export declare namespace Input {
  1810. type PointerSourceActions = {
  1811. type: 'pointer';
  1812. id: string;
  1813. parameters?: Input.PointerParameters;
  1814. actions: [...Input.PointerSourceAction[]];
  1815. };
  1816. }
  1817. export declare namespace Input {
  1818. type PerformActions = {
  1819. method: 'input.performActions';
  1820. params: Input.PerformActionsParameters;
  1821. };
  1822. }
  1823. export declare namespace Input {
  1824. type SourceActions = Input.NoneSourceActions | Input.KeySourceActions | Input.PointerSourceActions | Input.WheelSourceActions;
  1825. }
  1826. export declare namespace Input {
  1827. type NoneSourceAction = Input.PauseAction;
  1828. }
  1829. export declare namespace Input {
  1830. type KeySourceAction = Input.PauseAction | Input.KeyDownAction | Input.KeyUpAction;
  1831. }
  1832. export declare namespace Input {
  1833. const enum PointerType {
  1834. Mouse = "mouse",
  1835. Pen = "pen",
  1836. Touch = "touch"
  1837. }
  1838. }
  1839. export declare namespace Input {
  1840. type PointerParameters = {
  1841. /**
  1842. * @defaultValue `"mouse"`
  1843. */
  1844. pointerType?: Input.PointerType;
  1845. };
  1846. }
  1847. export declare namespace Input {
  1848. type WheelSourceActions = {
  1849. type: 'wheel';
  1850. id: string;
  1851. actions: [...Input.WheelSourceAction[]];
  1852. };
  1853. }
  1854. export declare namespace Input {
  1855. type PointerSourceAction = Input.PauseAction | Input.PointerDownAction | Input.PointerUpAction | Input.PointerMoveAction;
  1856. }
  1857. export declare namespace Input {
  1858. type WheelSourceAction = Input.PauseAction | Input.WheelScrollAction;
  1859. }
  1860. export declare namespace Input {
  1861. type PauseAction = {
  1862. type: 'pause';
  1863. duration?: JsUint;
  1864. };
  1865. }
  1866. export declare namespace Input {
  1867. type KeyDownAction = {
  1868. type: 'keyDown';
  1869. value: string;
  1870. };
  1871. }
  1872. export declare namespace Input {
  1873. type KeyUpAction = {
  1874. type: 'keyUp';
  1875. value: string;
  1876. };
  1877. }
  1878. export declare namespace Input {
  1879. type PointerUpAction = {
  1880. type: 'pointerUp';
  1881. button: JsUint;
  1882. };
  1883. }
  1884. export declare namespace Input {
  1885. type PointerDownAction = {
  1886. type: 'pointerDown';
  1887. button: JsUint;
  1888. } & Input.PointerCommonProperties;
  1889. }
  1890. export declare namespace Input {
  1891. type PointerMoveAction = {
  1892. type: 'pointerMove';
  1893. x: JsInt;
  1894. y: JsInt;
  1895. duration?: JsUint;
  1896. origin?: Input.Origin;
  1897. } & Input.PointerCommonProperties;
  1898. }
  1899. export declare namespace Input {
  1900. type WheelScrollAction = {
  1901. type: 'scroll';
  1902. x: JsInt;
  1903. y: JsInt;
  1904. deltaX: JsInt;
  1905. deltaY: JsInt;
  1906. duration?: JsUint;
  1907. /**
  1908. * @defaultValue `"viewport"`
  1909. */
  1910. origin?: Input.Origin;
  1911. };
  1912. }
  1913. export declare namespace Input {
  1914. type PointerCommonProperties = {
  1915. /**
  1916. * @defaultValue `1`
  1917. */
  1918. width?: JsUint;
  1919. /**
  1920. * @defaultValue `1`
  1921. */
  1922. height?: JsUint;
  1923. /**
  1924. * @defaultValue `0`
  1925. */
  1926. pressure?: number;
  1927. /**
  1928. * @defaultValue `0`
  1929. */
  1930. tangentialPressure?: number;
  1931. /**
  1932. * Must be between `0` and `359`, inclusive.
  1933. *
  1934. * @defaultValue `0`
  1935. */
  1936. twist?: number;
  1937. /**
  1938. * Must be between `0` and `1.5707963267948966`, inclusive.
  1939. *
  1940. * @defaultValue `0`
  1941. */
  1942. altitudeAngle?: number;
  1943. /**
  1944. * Must be between `0` and `6.283185307179586`, inclusive.
  1945. *
  1946. * @defaultValue `0`
  1947. */
  1948. azimuthAngle?: number;
  1949. };
  1950. }
  1951. export declare namespace Input {
  1952. type Origin = 'viewport' | 'pointer' | Input.ElementOrigin;
  1953. }
  1954. export declare namespace Input {
  1955. type ReleaseActions = {
  1956. method: 'input.releaseActions';
  1957. params: Input.ReleaseActionsParameters;
  1958. };
  1959. }
  1960. export declare namespace Input {
  1961. type ReleaseActionsParameters = {
  1962. context: BrowsingContext.BrowsingContext;
  1963. };
  1964. }
  1965. export declare namespace Input {
  1966. type SetFiles = {
  1967. method: 'input.setFiles';
  1968. params: Input.SetFilesParameters;
  1969. };
  1970. }
  1971. export declare namespace Input {
  1972. type SetFilesParameters = {
  1973. context: BrowsingContext.BrowsingContext;
  1974. element: Script.SharedReference;
  1975. files: [...string[]];
  1976. };
  1977. }