appium-xcuitest-driver 10.3.0 → 10.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (257) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/build/lib/commands/active-app-info.d.ts +9 -0
  3. package/build/lib/commands/active-app-info.d.ts.map +1 -0
  4. package/build/lib/commands/active-app-info.js +14 -0
  5. package/build/lib/commands/active-app-info.js.map +1 -0
  6. package/build/lib/commands/alert.d.ts +42 -45
  7. package/build/lib/commands/alert.d.ts.map +1 -1
  8. package/build/lib/commands/alert.js +66 -62
  9. package/build/lib/commands/alert.js.map +1 -1
  10. package/build/lib/commands/app-management.d.ts +150 -153
  11. package/build/lib/commands/app-management.d.ts.map +1 -1
  12. package/build/lib/commands/app-management.js +300 -286
  13. package/build/lib/commands/app-management.js.map +1 -1
  14. package/build/lib/commands/app-strings.d.ts +14 -17
  15. package/build/lib/commands/app-strings.d.ts.map +1 -1
  16. package/build/lib/commands/app-strings.js +23 -24
  17. package/build/lib/commands/app-strings.js.map +1 -1
  18. package/build/lib/commands/appearance.d.ts +19 -22
  19. package/build/lib/commands/appearance.d.ts.map +1 -1
  20. package/build/lib/commands/appearance.js +56 -56
  21. package/build/lib/commands/appearance.js.map +1 -1
  22. package/build/lib/commands/audit.d.ts +22 -17
  23. package/build/lib/commands/audit.d.ts.map +1 -1
  24. package/build/lib/commands/audit.js +17 -18
  25. package/build/lib/commands/audit.js.map +1 -1
  26. package/build/lib/commands/battery.d.ts +11 -14
  27. package/build/lib/commands/battery.d.ts.map +1 -1
  28. package/build/lib/commands/battery.js +36 -37
  29. package/build/lib/commands/battery.js.map +1 -1
  30. package/build/lib/commands/biometric.d.ts +30 -33
  31. package/build/lib/commands/biometric.d.ts.map +1 -1
  32. package/build/lib/commands/biometric.js +42 -41
  33. package/build/lib/commands/biometric.js.map +1 -1
  34. package/build/lib/commands/certificate.d.ts +48 -45
  35. package/build/lib/commands/certificate.d.ts.map +1 -1
  36. package/build/lib/commands/certificate.js +218 -205
  37. package/build/lib/commands/certificate.js.map +1 -1
  38. package/build/lib/commands/clipboard.d.ts +19 -22
  39. package/build/lib/commands/clipboard.d.ts.map +1 -1
  40. package/build/lib/commands/clipboard.js +30 -30
  41. package/build/lib/commands/clipboard.js.map +1 -1
  42. package/build/lib/commands/condition.d.ts +49 -26
  43. package/build/lib/commands/condition.d.ts.map +1 -1
  44. package/build/lib/commands/condition.js +87 -86
  45. package/build/lib/commands/condition.js.map +1 -1
  46. package/build/lib/commands/content-size.d.ts +26 -29
  47. package/build/lib/commands/content-size.d.ts.map +1 -1
  48. package/build/lib/commands/content-size.js +36 -36
  49. package/build/lib/commands/content-size.js.map +1 -1
  50. package/build/lib/commands/context.d.ts +161 -108
  51. package/build/lib/commands/context.d.ts.map +1 -1
  52. package/build/lib/commands/context.js +530 -517
  53. package/build/lib/commands/context.js.map +1 -1
  54. package/build/lib/commands/deviceInfo.d.ts +9 -12
  55. package/build/lib/commands/deviceInfo.d.ts.map +1 -1
  56. package/build/lib/commands/deviceInfo.js +17 -18
  57. package/build/lib/commands/deviceInfo.js.map +1 -1
  58. package/build/lib/commands/element.d.ts +102 -105
  59. package/build/lib/commands/element.d.ts.map +1 -1
  60. package/build/lib/commands/element.js +337 -323
  61. package/build/lib/commands/element.js.map +1 -1
  62. package/build/lib/commands/execute.d.ts +24 -19
  63. package/build/lib/commands/execute.d.ts.map +1 -1
  64. package/build/lib/commands/execute.js +63 -62
  65. package/build/lib/commands/execute.js.map +1 -1
  66. package/build/lib/commands/file-movement.d.ts +77 -80
  67. package/build/lib/commands/file-movement.d.ts.map +1 -1
  68. package/build/lib/commands/file-movement.js +130 -124
  69. package/build/lib/commands/file-movement.js.map +1 -1
  70. package/build/lib/commands/find.d.ts +18 -21
  71. package/build/lib/commands/find.d.ts.map +1 -1
  72. package/build/lib/commands/find.js +158 -156
  73. package/build/lib/commands/find.js.map +1 -1
  74. package/build/lib/commands/general.d.ts +124 -116
  75. package/build/lib/commands/general.d.ts.map +1 -1
  76. package/build/lib/commands/general.js +248 -232
  77. package/build/lib/commands/general.js.map +1 -1
  78. package/build/lib/commands/geolocation.d.ts +43 -46
  79. package/build/lib/commands/geolocation.d.ts.map +1 -1
  80. package/build/lib/commands/geolocation.js +10 -11
  81. package/build/lib/commands/geolocation.js.map +1 -1
  82. package/build/lib/commands/gesture.d.ts +273 -276
  83. package/build/lib/commands/gesture.d.ts.map +1 -1
  84. package/build/lib/commands/gesture.js +506 -492
  85. package/build/lib/commands/gesture.js.map +1 -1
  86. package/build/lib/commands/increase-contrast.d.ts +20 -23
  87. package/build/lib/commands/increase-contrast.d.ts.map +1 -1
  88. package/build/lib/commands/increase-contrast.js +30 -30
  89. package/build/lib/commands/increase-contrast.js.map +1 -1
  90. package/build/lib/commands/iohid.d.ts +1370 -1373
  91. package/build/lib/commands/iohid.d.ts.map +1 -1
  92. package/build/lib/commands/iohid.js +30 -31
  93. package/build/lib/commands/iohid.js.map +1 -1
  94. package/build/lib/commands/keyboard.d.ts +29 -32
  95. package/build/lib/commands/keyboard.d.ts.map +1 -1
  96. package/build/lib/commands/keyboard.js +53 -51
  97. package/build/lib/commands/keyboard.js.map +1 -1
  98. package/build/lib/commands/keychains.d.ts +9 -12
  99. package/build/lib/commands/keychains.d.ts.map +1 -1
  100. package/build/lib/commands/keychains.js +13 -14
  101. package/build/lib/commands/keychains.js.map +1 -1
  102. package/build/lib/commands/localization.d.ts +16 -19
  103. package/build/lib/commands/localization.d.ts.map +1 -1
  104. package/build/lib/commands/localization.js +25 -26
  105. package/build/lib/commands/localization.js.map +1 -1
  106. package/build/lib/commands/location.d.ts +36 -39
  107. package/build/lib/commands/location.d.ts.map +1 -1
  108. package/build/lib/commands/location.js +99 -98
  109. package/build/lib/commands/location.js.map +1 -1
  110. package/build/lib/commands/lock.d.ts +21 -24
  111. package/build/lib/commands/lock.d.ts.map +1 -1
  112. package/build/lib/commands/lock.js +39 -38
  113. package/build/lib/commands/lock.js.map +1 -1
  114. package/build/lib/commands/log.d.ts +43 -37
  115. package/build/lib/commands/log.d.ts.map +1 -1
  116. package/build/lib/commands/log.js +174 -171
  117. package/build/lib/commands/log.js.map +1 -1
  118. package/build/lib/commands/memory.d.ts +9 -12
  119. package/build/lib/commands/memory.d.ts.map +1 -1
  120. package/build/lib/commands/memory.js +37 -38
  121. package/build/lib/commands/memory.js.map +1 -1
  122. package/build/lib/commands/navigation.d.ts +30 -33
  123. package/build/lib/commands/navigation.d.ts.map +1 -1
  124. package/build/lib/commands/navigation.js +92 -92
  125. package/build/lib/commands/navigation.js.map +1 -1
  126. package/build/lib/commands/notifications.d.ts +26 -29
  127. package/build/lib/commands/notifications.d.ts.map +1 -1
  128. package/build/lib/commands/notifications.js +53 -53
  129. package/build/lib/commands/notifications.js.map +1 -1
  130. package/build/lib/commands/pasteboard.d.ts +21 -24
  131. package/build/lib/commands/pasteboard.d.ts.map +1 -1
  132. package/build/lib/commands/pasteboard.js +37 -37
  133. package/build/lib/commands/pasteboard.js.map +1 -1
  134. package/build/lib/commands/pcap.d.ts +39 -26
  135. package/build/lib/commands/pcap.d.ts.map +1 -1
  136. package/build/lib/commands/pcap.js +81 -81
  137. package/build/lib/commands/pcap.js.map +1 -1
  138. package/build/lib/commands/performance.d.ts +63 -44
  139. package/build/lib/commands/performance.d.ts.map +1 -1
  140. package/build/lib/commands/performance.js +105 -105
  141. package/build/lib/commands/performance.js.map +1 -1
  142. package/build/lib/commands/permissions.d.ts +33 -36
  143. package/build/lib/commands/permissions.d.ts.map +1 -1
  144. package/build/lib/commands/permissions.js +66 -65
  145. package/build/lib/commands/permissions.js.map +1 -1
  146. package/build/lib/commands/proxy-helper.d.ts +12 -15
  147. package/build/lib/commands/proxy-helper.d.ts.map +1 -1
  148. package/build/lib/commands/proxy-helper.js +53 -54
  149. package/build/lib/commands/proxy-helper.js.map +1 -1
  150. package/build/lib/commands/record-audio.d.ts +49 -29
  151. package/build/lib/commands/record-audio.d.ts.map +1 -1
  152. package/build/lib/commands/record-audio.js +100 -104
  153. package/build/lib/commands/record-audio.js.map +1 -1
  154. package/build/lib/commands/recordscreen.d.ts +54 -18
  155. package/build/lib/commands/recordscreen.d.ts.map +1 -1
  156. package/build/lib/commands/recordscreen.js +127 -129
  157. package/build/lib/commands/recordscreen.js.map +1 -1
  158. package/build/lib/commands/screenshots.d.ts +14 -17
  159. package/build/lib/commands/screenshots.d.ts.map +1 -1
  160. package/build/lib/commands/screenshots.js +108 -107
  161. package/build/lib/commands/screenshots.js.map +1 -1
  162. package/build/lib/commands/simctl.d.ts +11 -14
  163. package/build/lib/commands/simctl.d.ts.map +1 -1
  164. package/build/lib/commands/simctl.js +23 -26
  165. package/build/lib/commands/simctl.js.map +1 -1
  166. package/build/lib/commands/source.d.ts +14 -17
  167. package/build/lib/commands/source.d.ts.map +1 -1
  168. package/build/lib/commands/source.js +40 -43
  169. package/build/lib/commands/source.js.map +1 -1
  170. package/build/lib/commands/timeouts.d.ts +44 -33
  171. package/build/lib/commands/timeouts.d.ts.map +1 -1
  172. package/build/lib/commands/timeouts.js +65 -63
  173. package/build/lib/commands/timeouts.js.map +1 -1
  174. package/build/lib/commands/web.d.ts +275 -197
  175. package/build/lib/commands/web.d.ts.map +1 -1
  176. package/build/lib/commands/web.js +866 -785
  177. package/build/lib/commands/web.js.map +1 -1
  178. package/build/lib/commands/xctest-record-screen.d.ts +63 -66
  179. package/build/lib/commands/xctest-record-screen.d.ts.map +1 -1
  180. package/build/lib/commands/xctest-record-screen.js +103 -102
  181. package/build/lib/commands/xctest-record-screen.js.map +1 -1
  182. package/build/lib/commands/xctest.d.ts +55 -51
  183. package/build/lib/commands/xctest.d.ts.map +1 -1
  184. package/build/lib/commands/xctest.js +116 -117
  185. package/build/lib/commands/xctest.js.map +1 -1
  186. package/build/lib/driver.d.ts +277 -1597
  187. package/build/lib/driver.d.ts.map +1 -1
  188. package/build/lib/driver.js +318 -235
  189. package/build/lib/driver.js.map +1 -1
  190. package/build/lib/execute-method-map.d.ts.map +1 -1
  191. package/build/lib/execute-method-map.js +9 -0
  192. package/build/lib/execute-method-map.js.map +1 -1
  193. package/lib/commands/active-app-info.js +12 -0
  194. package/lib/commands/alert.js +68 -65
  195. package/lib/commands/app-management.js +308 -301
  196. package/lib/commands/app-strings.js +24 -26
  197. package/lib/commands/appearance.js +54 -56
  198. package/lib/commands/audit.js +18 -20
  199. package/lib/commands/battery.js +35 -37
  200. package/lib/commands/biometric.js +44 -46
  201. package/lib/commands/certificate.js +226 -215
  202. package/lib/commands/clipboard.js +30 -32
  203. package/lib/commands/condition.js +98 -100
  204. package/lib/commands/content-size.js +36 -38
  205. package/lib/commands/context.js +495 -490
  206. package/lib/commands/deviceInfo.js +19 -20
  207. package/lib/commands/element.js +367 -357
  208. package/lib/commands/execute.js +72 -72
  209. package/lib/commands/file-movement.js +132 -134
  210. package/lib/commands/find.js +160 -159
  211. package/lib/commands/general.js +238 -231
  212. package/lib/commands/geolocation.js +6 -14
  213. package/lib/commands/gesture.js +525 -515
  214. package/lib/commands/increase-contrast.js +30 -32
  215. package/lib/commands/iohid.js +32 -34
  216. package/lib/commands/keyboard.js +49 -51
  217. package/lib/commands/keychains.js +12 -14
  218. package/lib/commands/localization.js +24 -26
  219. package/lib/commands/location.js +102 -104
  220. package/lib/commands/lock.js +38 -38
  221. package/lib/commands/log.js +197 -198
  222. package/lib/commands/memory.js +40 -42
  223. package/lib/commands/navigation.js +96 -100
  224. package/lib/commands/notifications.js +57 -59
  225. package/lib/commands/pasteboard.js +37 -39
  226. package/lib/commands/pcap.js +84 -86
  227. package/lib/commands/performance.js +132 -133
  228. package/lib/commands/permissions.js +67 -69
  229. package/lib/commands/proxy-helper.js +60 -61
  230. package/lib/commands/record-audio.js +115 -120
  231. package/lib/commands/recordscreen.js +145 -149
  232. package/lib/commands/screenshots.js +116 -116
  233. package/lib/commands/simctl.js +25 -29
  234. package/lib/commands/source.js +42 -46
  235. package/lib/commands/timeouts.js +59 -63
  236. package/lib/commands/web.js +932 -859
  237. package/lib/commands/xctest-record-screen.js +103 -105
  238. package/lib/commands/xctest.js +134 -139
  239. package/lib/driver.js +286 -235
  240. package/lib/execute-method-map.ts +9 -0
  241. package/npm-shrinkwrap.json +8 -8
  242. package/package.json +1 -1
  243. package/build/lib/commands/activeAppInfo.d.ts +0 -12
  244. package/build/lib/commands/activeAppInfo.d.ts.map +0 -1
  245. package/build/lib/commands/activeAppInfo.js +0 -15
  246. package/build/lib/commands/activeAppInfo.js.map +0 -1
  247. package/build/lib/commands/index.d.ts +0 -96
  248. package/build/lib/commands/index.d.ts.map +0 -1
  249. package/build/lib/commands/index.js +0 -100
  250. package/build/lib/commands/index.js.map +0 -1
  251. package/build/lib/cookies.d.ts +0 -15
  252. package/build/lib/cookies.d.ts.map +0 -1
  253. package/build/lib/cookies.js +0 -84
  254. package/build/lib/cookies.js.map +0 -1
  255. package/lib/commands/activeAppInfo.js +0 -14
  256. package/lib/commands/index.js +0 -95
  257. package/lib/cookies.js +0 -92
@@ -1,144 +1,277 @@
1
- declare namespace _default {
1
+ /**
2
+ * @this {XCUITestDriver}
3
+ * @group Mobile Web Only
4
+ * @param {number|string|null} frame
5
+ * @returns {Promise<void>}
6
+ */
7
+ export function setFrame(this: import("../driver").XCUITestDriver, frame: number | string | null): Promise<void>;
8
+ export class setFrame {
2
9
  /**
3
10
  * @this {XCUITestDriver}
4
11
  * @group Mobile Web Only
5
- */
6
- function setFrame(this: import("../driver").XCUITestDriver, frame: any): Promise<void>;
7
- /**
8
- * @this {XCUITestDriver}
9
- * @group Mobile Web Only
10
- */
11
- function getCssProperty(this: import("../driver").XCUITestDriver, propertyName: any, el: any): Promise<any>;
12
- /**
13
- * Submit the form an element is in
14
- *
15
- * @param {string|Element} el - the element ID
16
- * @group Mobile Web Only
17
- * @this {XCUITestDriver}
18
- */
19
- function submit(this: import("../driver").XCUITestDriver, el: string | Element): Promise<void>;
20
- /**
21
- * @this {XCUITestDriver}
22
- * @group Mobile Web Only
23
- */
24
- function refresh(this: import("../driver").XCUITestDriver): Promise<void>;
25
- /**
26
- * @this {XCUITestDriver}
27
- * @group Mobile Web Only
28
- */
29
- function getUrl(this: import("../driver").XCUITestDriver): Promise<any>;
30
- /**
31
- * @this {XCUITestDriver}
32
- * @group Mobile Web Only
33
- */
34
- function title(this: import("../driver").XCUITestDriver): Promise<any>;
35
- /**
36
- * @this {XCUITestDriver}
37
- * @group Mobile Web Only
38
- */
39
- function getCookies(this: import("../driver").XCUITestDriver): Promise<any>;
40
- /**
41
- * @this {XCUITestDriver}
42
- * @group Mobile Web Only
43
- */
44
- function setCookie(this: import("../driver").XCUITestDriver, cookie: any): Promise<void>;
45
- /**
46
- * @this {XCUITestDriver}
47
- * @group Mobile Web Only
48
- */
49
- function deleteCookie(this: import("../driver").XCUITestDriver, cookieName: any): Promise<void>;
50
- /**
51
- * @this {XCUITestDriver}
52
- * @group Mobile Web Only
53
- */
54
- function deleteCookies(this: import("../driver").XCUITestDriver): Promise<void>;
55
- /**
56
- * @this {XCUITestDriver}
57
- */
58
- function findWebElementOrElements(this: import("../driver").XCUITestDriver, strategy: any, selector: any, many: any, ctx: any): Promise<any>;
59
- /**
60
- * @this {XCUITestDriver}
61
- * @param {number} x
62
- * @param {number} y
63
- */
64
- function clickWebCoords(this: import("../driver").XCUITestDriver, x: number, y: number): Promise<void>;
65
- /**
66
- * @this {XCUITestDriver}
67
- * @returns {Promise<boolean>}
68
- */
69
- function getSafariIsIphone(this: import("../driver").XCUITestDriver): Promise<boolean>;
70
- /**
71
- * @this {XCUITestDriver}
72
- * @returns {Promise<import('@appium/types').Size>}
73
- */
74
- function getSafariDeviceSize(this: import("../driver").XCUITestDriver): Promise<import("@appium/types").Size>;
75
- /**
76
- * @this {XCUITestDriver}
77
- * @returns {Promise<boolean>}
78
- */
79
- function getSafariIsNotched(this: import("../driver").XCUITestDriver): Promise<boolean>;
80
- /**
81
- * @this {XCUITestDriver}
82
- */
83
- function getExtraTranslateWebCoordsOffset(this: import("../driver").XCUITestDriver, wvPos: any, realDims: any): Promise<void>;
84
- /**
85
- * @this {XCUITestDriver}
86
- * @param {boolean} isIphone
87
- * @param {string} bannerVisibility
88
- * @returns {Promise<number>}
89
- */
90
- function getExtraNativeWebTapOffset(this: import("../driver").XCUITestDriver, isIphone: boolean, bannerVisibility: string): Promise<number>;
91
- /**
92
- * @this {XCUITestDriver}
93
- * @param {any} el
12
+ * @param {number|string|null} frame
94
13
  * @returns {Promise<void>}
95
14
  */
96
- function nativeWebTap(this: import("../driver").XCUITestDriver, el: any): Promise<void>;
97
- /**
98
- * @this {XCUITestDriver}
99
- * @param {number} x
100
- * @param {number} y
101
- * @returns {Promise<import('@appium/types').Position>}
102
- */
103
- function translateWebCoords(this: import("../driver").XCUITestDriver, x: number, y: number): Promise<import("@appium/types").Position>;
104
- /**
105
- * @this {XCUITestDriver}
106
- * @returns {Promise<boolean>}
107
- */
108
- function checkForAlert(this: import("../driver").XCUITestDriver): Promise<boolean>;
109
- /**
110
- * @param {Promise<any>} promise
111
- * @this {XCUITestDriver}
112
- */
113
- function waitForAtom(this: import("../driver").XCUITestDriver, promise: Promise<any>): Promise<any>;
114
- /**
115
- * @param {string} navType
116
- * @this {XCUITestDriver}
117
- */
118
- function mobileWebNav(this: import("../driver").XCUITestDriver, navType: string): Promise<void>;
119
- /**
120
- * @this {XCUITestDriver}
121
- * @returns {string} The base url which could be used to access WDA HTTP endpoints
122
- * FROM THE SAME DEVICE where WDA is running
123
- */
124
- function getWdaLocalhostRoot(this: import("../driver").XCUITestDriver): string;
15
+ constructor(this: import("../driver").XCUITestDriver, frame: number | string | null);
16
+ curWebFrames: any[] | undefined;
17
+ }
18
+ /**
19
+ * @this {XCUITestDriver}
20
+ * @group Mobile Web Only
21
+ * @param {string} propertyName
22
+ * @param {Element | string} el
23
+ * @returns {Promise<string>}
24
+ */
25
+ export function getCssProperty(this: import("../driver").XCUITestDriver, propertyName: string, el: Element | string): Promise<string>;
26
+ /**
27
+ * Submit the form an element is in
28
+ *
29
+ * @param {string|Element} el - the element ID
30
+ * @group Mobile Web Only
31
+ * @this {XCUITestDriver}
32
+ */
33
+ export function submit(this: import("../driver").XCUITestDriver, el: string | Element): Promise<void>;
34
+ /**
35
+ * @this {XCUITestDriver}
36
+ * @group Mobile Web Only
37
+ */
38
+ export function refresh(this: import("../driver").XCUITestDriver): Promise<void>;
39
+ /**
40
+ * @this {XCUITestDriver}
41
+ * @group Mobile Web Only
42
+ * @returns {Promise<string>}
43
+ */
44
+ export function getUrl(this: import("../driver").XCUITestDriver): Promise<string>;
45
+ /**
46
+ * @this {XCUITestDriver}
47
+ * @group Mobile Web Only
48
+ * @returns {Promise<string>}
49
+ */
50
+ export function title(this: import("../driver").XCUITestDriver): Promise<string>;
51
+ /**
52
+ * @this {XCUITestDriver}
53
+ * @group Mobile Web Only
54
+ * @returns {Promise<import('@appium/types').Cookie[]>}
55
+ */
56
+ export function getCookies(this: import("../driver").XCUITestDriver): Promise<import("@appium/types").Cookie[]>;
57
+ /**
58
+ * @this {XCUITestDriver}
59
+ * @group Mobile Web Only
60
+ * @param {import('@appium/types').Cookie} cookie
61
+ * @returns {Promise<void>}
62
+ */
63
+ export function setCookie(this: import("../driver").XCUITestDriver, cookie: import("@appium/types").Cookie): Promise<void>;
64
+ /**
65
+ * @this {XCUITestDriver}
66
+ * @param {string} cookieName
67
+ * @returns {Promise<void>}
68
+ * @group Mobile Web Only
69
+ */
70
+ export function deleteCookie(this: import("../driver").XCUITestDriver, cookieName: string): Promise<void>;
71
+ /**
72
+ * @this {XCUITestDriver}
73
+ * @group Mobile Web Only
74
+ * @returns {Promise<void>}
75
+ */
76
+ export function deleteCookies(this: import("../driver").XCUITestDriver): Promise<void>;
77
+ /**
78
+ * @this {XCUITestDriver}
79
+ * @param {Element | string} el
80
+ * @returns {Element | string}
81
+ */
82
+ export function cacheWebElement(this: import("../driver").XCUITestDriver, el: Element | string): Element | string;
83
+ /**
84
+ * @this {XCUITestDriver}
85
+ * @param {any} response
86
+ * @returns {any}
87
+ */
88
+ export function cacheWebElements(this: import("../driver").XCUITestDriver, response: any): any;
89
+ /**
90
+ * @param {string} atom
91
+ * @param {unknown[]} args
92
+ * @returns {Promise<any>}
93
+ * @privateRemarks This should return `Promise<T>` where `T` extends `unknown`, but that's going to cause a lot of things to break.
94
+ * @this {XCUITestDriver}
95
+ */
96
+ export function executeAtom(this: import("../driver").XCUITestDriver, atom: string, args: unknown[], alwaysDefaultFrame?: boolean): Promise<any>;
97
+ /**
98
+ * @this {XCUITestDriver}
99
+ * @param {string} atom
100
+ * @param {any[]} args
101
+ */
102
+ export function executeAtomAsync(this: import("../driver").XCUITestDriver, atom: string, args: any[]): Promise<any>;
103
+ export class executeAtomAsync {
125
104
  /**
126
- * Calibrates web to real coordinates translation.
127
- * This API can only be called from Safari web context.
128
- * It must load a custom page to the browser, and then restore
129
- * the original one, so don't call it if you can potentially
130
- * lose the current web app state.
131
- * The outcome of this API is then used in nativeWebTap mode.
132
- * The returned value could also be used to manually transform web coordinates
133
- * to real devices ones in client scripts.
134
- *
135
105
  * @this {XCUITestDriver}
136
- * @returns {Promise<import('../types').CalibrationData>}
106
+ * @param {string} atom
107
+ * @param {any[]} args
137
108
  */
138
- function mobileCalibrateWebToRealCoordinatesTranslation(this: import("../driver").XCUITestDriver): Promise<import("../types").CalibrationData>;
139
- /**
140
- * @typedef {Object} SafariOpts
141
- * @property {object} preferences An object containing Safari settings to be updated.
109
+ constructor(this: import("../driver").XCUITestDriver, atom: string, args: any[]);
110
+ asyncPromise: {
111
+ resolve: (thenableOrResult?: any) => void;
112
+ reject: (error?: any) => void;
113
+ };
114
+ }
115
+ /**
116
+ * @template {string} S
117
+ * @param {S|Element<S>} elOrId
118
+ * @returns {import('./types').AtomsElement<S>}
119
+ * @this {XCUITestDriver}
120
+ */
121
+ export function getAtomsElement<S extends string>(this: import("../driver").XCUITestDriver, elOrId: S | Element<S>): import("./types").AtomsElement<S>;
122
+ /**
123
+ * @param {readonly any[]} [args]
124
+ * @this {XCUITestDriver}
125
+ */
126
+ export function convertElementsForAtoms(this: import("../driver").XCUITestDriver, args?: readonly any[]): any;
127
+ /**
128
+ *
129
+ * @param {any} element
130
+ * @returns {string | undefined}
131
+ */
132
+ export function getElementId(element: any): string | undefined;
133
+ /**
134
+ * @param {any} element
135
+ * @returns {element is Element}
136
+ */
137
+ export function hasElementId(element: any): element is Element;
138
+ /**
139
+ * @this {XCUITestDriver}
140
+ * @param {string} strategy
141
+ * @param {string} selector
142
+ * @param {boolean} [many]
143
+ * @param {Element | string | null} [ctx]
144
+ * @returns {Promise<Element | Element[]>}
145
+ */
146
+ export function findWebElementOrElements(this: import("../driver").XCUITestDriver, strategy: string, selector: string, many?: boolean, ctx?: Element | string | null): Promise<Element | Element[]>;
147
+ /**
148
+ * @this {XCUITestDriver}
149
+ * @param {number} x
150
+ * @param {number} y
151
+ */
152
+ export function clickWebCoords(this: import("../driver").XCUITestDriver, x: number, y: number): Promise<void>;
153
+ /**
154
+ * @this {XCUITestDriver}
155
+ * @returns {Promise<boolean>}
156
+ */
157
+ export function getSafariIsIphone(this: import("../driver").XCUITestDriver): Promise<boolean>;
158
+ export class getSafariIsIphone {
159
+ _isSafariIphone: boolean | undefined;
160
+ }
161
+ /**
162
+ * @this {XCUITestDriver}
163
+ * @returns {Promise<import('@appium/types').Size>}
164
+ */
165
+ export function getSafariDeviceSize(this: import("../driver").XCUITestDriver): Promise<import("@appium/types").Size>;
166
+ /**
167
+ * @this {XCUITestDriver}
168
+ * @returns {Promise<boolean>}
169
+ */
170
+ export function getSafariIsNotched(this: import("../driver").XCUITestDriver): Promise<boolean>;
171
+ export class getSafariIsNotched {
172
+ _isSafariNotched: boolean | undefined;
173
+ }
174
+ /**
175
+ * @this {XCUITestDriver}
176
+ */
177
+ export function getExtraTranslateWebCoordsOffset(this: import("../driver").XCUITestDriver, wvPos: any, realDims: any): Promise<void>;
178
+ /**
179
+ * @this {XCUITestDriver}
180
+ * @param {boolean} isIphone
181
+ * @param {string} bannerVisibility
182
+ * @returns {Promise<number>}
183
+ */
184
+ export function getExtraNativeWebTapOffset(this: import("../driver").XCUITestDriver, isIphone: boolean, bannerVisibility: string): Promise<number>;
185
+ /**
186
+ * @this {XCUITestDriver}
187
+ * @param {any} el
188
+ * @returns {Promise<void>}
189
+ */
190
+ export function nativeWebTap(this: import("../driver").XCUITestDriver, el: any): Promise<void>;
191
+ /**
192
+ * @this {XCUITestDriver}
193
+ * @param {number} x
194
+ * @param {number} y
195
+ * @returns {Promise<import('@appium/types').Position>}
196
+ */
197
+ export function translateWebCoords(this: import("../driver").XCUITestDriver, x: number, y: number): Promise<import("@appium/types").Position>;
198
+ /**
199
+ * @this {XCUITestDriver}
200
+ * @returns {Promise<boolean>}
201
+ */
202
+ export function checkForAlert(this: import("../driver").XCUITestDriver): Promise<boolean>;
203
+ /**
204
+ * @param {Promise<any>} promise
205
+ * @this {XCUITestDriver}
206
+ */
207
+ export function waitForAtom(this: import("../driver").XCUITestDriver, promise: Promise<any>): Promise<any>;
208
+ /**
209
+ * @param {string} navType
210
+ * @this {XCUITestDriver}
211
+ */
212
+ export function mobileWebNav(this: import("../driver").XCUITestDriver, navType: string): Promise<void>;
213
+ /**
214
+ * @this {XCUITestDriver}
215
+ * @returns {string} The base url which could be used to access WDA HTTP endpoints
216
+ * FROM THE SAME DEVICE where WDA is running
217
+ */
218
+ export function getWdaLocalhostRoot(this: import("../driver").XCUITestDriver): string;
219
+ /**
220
+ * Calibrates web to real coordinates translation.
221
+ * This API can only be called from Safari web context.
222
+ * It must load a custom page to the browser, and then restore
223
+ * the original one, so don't call it if you can potentially
224
+ * lose the current web app state.
225
+ * The outcome of this API is then used in nativeWebTap mode.
226
+ * The returned value could also be used to manually transform web coordinates
227
+ * to real devices ones in client scripts.
228
+ *
229
+ * @this {XCUITestDriver}
230
+ * @returns {Promise<import('../types').CalibrationData>}
231
+ */
232
+ export function mobileCalibrateWebToRealCoordinatesTranslation(this: import("../driver").XCUITestDriver): Promise<import("../types").CalibrationData>;
233
+ export class mobileCalibrateWebToRealCoordinatesTranslation {
234
+ webviewCalibrationResult: {
235
+ offsetX: number;
236
+ offsetY: number;
237
+ pixelRatioX: number;
238
+ pixelRatioY: number;
239
+ };
240
+ }
241
+ /**
242
+ * @typedef {Object} SafariOpts
243
+ * @property {object} preferences An object containing Safari settings to be updated.
244
+ * The list of available setting names and their values could be retrieved by
245
+ * changing the corresponding Safari settings in the UI and then inspecting
246
+ * 'Library/Preferences/com.apple.mobilesafari.plist' file inside of
247
+ * com.apple.mobilesafari app container.
248
+ * The full path to the Mobile Safari's container could be retrieved from
249
+ * `xcrun simctl get_app_container <sim_udid> com.apple.mobilesafari data`
250
+ * command output.
251
+ * Use the `xcrun simctl spawn <sim_udid> defaults read <path_to_plist>` command
252
+ * to print the plist content to the Terminal.
253
+ */
254
+ /**
255
+ * Updates Mobile Safari preferences on an iOS Simulator
256
+ *
257
+ * @param {import('@appium/types').StringRecord} preferences - An object containing Safari settings to be updated.
258
+ * The list of available setting names and their values can be retrieved by changing the
259
+ * corresponding Safari settings in the UI and then inspecting
260
+ * `Library/Preferences/com.apple.mobilesafari.plist` file inside of the `com.apple.mobilesafari`
261
+ * app container within the simulator filesystem. The full path to Mobile Safari's container can
262
+ * be retrieved by running `xcrun simctl get_app_container <sim_udid> com.apple.mobilesafari
263
+ * data`. Use the `xcrun simctl spawn <sim_udid> defaults read <path_to_plist>` command to print
264
+ * the plist content to the Terminal.
265
+ *
266
+ * @group Simulator Only
267
+ * @returns {Promise<void>}
268
+ * @throws {Error} if run on a real device or if the preferences argument is invalid
269
+ * @this {XCUITestDriver}
270
+ */
271
+ export function mobileUpdateSafariPreferences(this: import("../driver").XCUITestDriver, preferences: import("@appium/types").StringRecord): Promise<void>;
272
+ export type SafariOpts = {
273
+ /**
274
+ * An object containing Safari settings to be updated.
142
275
  * The list of available setting names and their values could be retrieved by
143
276
  * changing the corresponding Safari settings in the UI and then inspecting
144
277
  * 'Library/Preferences/com.apple.mobilesafari.plist' file inside of
@@ -149,70 +282,15 @@ declare namespace _default {
149
282
  * Use the `xcrun simctl spawn <sim_udid> defaults read <path_to_plist>` command
150
283
  * to print the plist content to the Terminal.
151
284
  */
152
- /**
153
- * Updates Mobile Safari preferences on an iOS Simulator
154
- *
155
- * @param {import('@appium/types').StringRecord} preferences - An object containing Safari settings to be updated.
156
- * The list of available setting names and their values can be retrieved by changing the
157
- * corresponding Safari settings in the UI and then inspecting
158
- * `Library/Preferences/com.apple.mobilesafari.plist` file inside of the `com.apple.mobilesafari`
159
- * app container within the simulator filesystem. The full path to Mobile Safari's container can
160
- * be retrieved by running `xcrun simctl get_app_container <sim_udid> com.apple.mobilesafari
161
- * data`. Use the `xcrun simctl spawn <sim_udid> defaults read <path_to_plist>` command to print
162
- * the plist content to the Terminal.
163
- *
164
- * @group Simulator Only
165
- * @returns {Promise<void>}
166
- * @throws {Error} if run on a real device or if the preferences argument is invalid
167
- * @this {XCUITestDriver}
168
- */
169
- function mobileUpdateSafariPreferences(this: import("../driver").XCUITestDriver, preferences: import("@appium/types").StringRecord): Promise<void>;
170
- /**
171
- * @this {XCUITestDriver}
172
- */
173
- function _deleteCookie(this: import("../driver").XCUITestDriver, cookie: any): Promise<any>;
174
- /**
175
- * @this {XCUITestDriver}
176
- */
177
- function cacheWebElement(this: import("../driver").XCUITestDriver, el: any): any;
178
- /**
179
- * @this {XCUITestDriver}
180
- */
181
- function cacheWebElements(this: import("../driver").XCUITestDriver, response: any): any;
182
- /**
183
- * @param {string} atom
184
- * @param {unknown[]} args
185
- * @returns {Promise<any>}
186
- * @privateRemarks This should return `Promise<T>` where `T` extends `unknown`, but that's going to cause a lot of things to break.
187
- * @this {XCUITestDriver}
188
- */
189
- function executeAtom(this: import("../driver").XCUITestDriver, atom: string, args: unknown[], alwaysDefaultFrame?: boolean): Promise<any>;
190
- /**
191
- * @this {XCUITestDriver}
192
- * @param {string} atom
193
- * @param {any[]} args
194
- */
195
- function executeAtomAsync(this: import("../driver").XCUITestDriver, atom: string, args: any[]): Promise<any>;
196
- /**
197
- * @template {string} S
198
- * @param {S|Element<S>} elOrId
199
- * @returns {import('./types').AtomsElement<S>}
200
- * @this {XCUITestDriver}
201
- */
202
- function getAtomsElement<S extends string>(this: import("../driver").XCUITestDriver, elOrId: S | Element<S>): import("./types").AtomsElement<S>;
203
- /**
204
- * @param {readonly any[]} [args]
205
- * @this {XCUITestDriver}
206
- */
207
- function convertElementsForAtoms(this: import("../driver").XCUITestDriver, args?: readonly any[]): any;
208
- function getElementId(element: any): any;
209
- /**
210
- * @param {any} element
211
- * @returns {element is Element}
212
- */
213
- function hasElementId(element: any): element is Element;
214
- }
215
- export default _default;
285
+ preferences: object;
286
+ };
287
+ export type CookieOptions = {
288
+ expires?: string | undefined;
289
+ path?: string | undefined;
290
+ domain?: string | undefined;
291
+ secure?: boolean | undefined;
292
+ httpOnly?: boolean | undefined;
293
+ };
216
294
  export type XCUITestDriver = import("../driver").XCUITestDriver;
217
295
  export type Rect = import("@appium/types").Rect;
218
296
  export type Element<S extends string = string> = import("@appium/types").Element<S>;
@@ -1 +1 @@
1
- {"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../../../lib/commands/web.js"],"names":[],"mappings":";IA4HE;;;OAGG;IACH,uFAyBC;IACD;;;OAGG;IACH,4GAOC;IACD;;;;;;OAMG;IACH,8DAJW,MAAM,GAAC,OAAO,iBAWxB;IACD;;;OAGG;IACH,0EAMC;IACD;;;OAGG;IACH,wEAMC;IACD;;;OAGG;IACH,uEAMC;IACD;;;OAGG;IACH,4EAuBC;IACD;;;OAGG;IACH,yFAuBC;IACD;;;OAGG;IACH,gGAaC;IACD;;;OAGG;IACH,gFAOC;IAsHD;;OAEG;IACH,6IA0BC;IACD;;;;OAIG;IACH,qEAHW,MAAM,KACN,MAAM,iBAKhB;IACD;;;OAGG;IACH,sEAFa,OAAO,CAAC,OAAO,CAAC,CAc5B;IACD;;;OAGG;IACH,wEAFa,OAAO,CAAC,OAAO,eAAe,EAAE,IAAI,CAAC,CAajD;IACD;;;OAGG;IACH,uEAFa,OAAO,CAAC,OAAO,CAAC,CAqB5B;IACD;;OAEG;IACH,8HA0FC;IACD;;;;;OAKG;IACH,wFAJW,OAAO,oBACP,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAuB3B;IACD;;;;OAIG;IACH,oEAHW,GAAG,GACD,OAAO,CAAC,IAAI,CAAC,CAwBzB;IACD;;;;;OAKG;IACH,yEAJW,MAAM,KACN,MAAM,GACJ,OAAO,CAAC,OAAO,eAAe,EAAE,QAAQ,CAAC,CA4FrD;IACD;;;OAGG;IACH,kEAFa,OAAO,CAAC,OAAO,CAAC,CAI5B;IAED;;;OAGG;IACH,wEAHW,OAAO,CAAC,GAAG,CAAC,gBA+EtB;IAED;;;OAGG;IACH,yEAHW,MAAM,iBAUhB;IAED;;;;OAIG;IACH,wEAHa,MAAM,CAUlB;IAED;;;;;;;;;;;;OAYG;IACH,mGAFa,OAAO,CAAC,OAAO,UAAU,EAAE,eAAe,CAAC,CAgEvD;IAED;;;;;;;;;;;;OAYG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,8FAdW,OAAO,eAAe,EAAE,YAAY,GAUlC,OAAO,CAAC,IAAI,CAAC,CAczB;IAprBD;;OAEG;IACH,4FAGC;IACD;;OAEG;IACH,iFAaC;IACD;;OAEG;IACH,wFAaC;IACD;;;;;;OAMG;IACH,qEANW,MAAM,QACN,OAAO,EAAE,iCACP,OAAO,CAAC,GAAG,CAAC,CAQxB;IACD;;;;OAIG;IACH,0EAHW,MAAM,QACN,GAAG,EAAE,gBASf;IACD;;;;;OAKG;IACH,yBALsB,CAAC,SAAV,MAAQ,oDACV,CAAC,GAAC,OAAO,CAAC,CAAC,CAAC,GACV,OAAO,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,CAS7C;IACD;;;OAGG;IACH,kFAHW,SAAS,GAAG,EAAE,OAiBxB;IACD,yCAEC;IACD;;;OAGG;IACH,+BAHW,GAAG,GACD,OAAO,IAAI,OAAO,CAO9B;;;6BAumBU,OAAO,WAAW,EAAE,cAAc;mBAClC,OAAO,eAAe,EAAE,IAAI;oBAIlB,CAAC,SAAX,MAAQ,aACR,OAAO,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;6BAIlC,OAAO,wBAAwB,EAAE,cAAc"}
1
+ {"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../../../lib/commands/web.js"],"names":[],"mappings":"AAqDA;;;;;GAKG;AACH,0EAHW,MAAM,GAAC,MAAM,GAAC,IAAI,GAChB,OAAO,CAAC,IAAI,CAAC,CA2BzB;;IA/BD;;;;;OAKG;IACH,6DAHW,MAAM,GAAC,MAAM,GAAC,IAAI,EA4B5B;IAnBG,gCAAsB;;AAqB1B;;;;;;GAMG;AACH,uFAJW,MAAM,MACN,OAAO,GAAG,MAAM,GACd,OAAO,CAAC,MAAM,CAAC,CAS3B;AAED;;;;;;GAMG;AACH,qEAJW,MAAM,GAAC,OAAO,iBAWxB;AAED;;;GAGG;AACH,iFAMC;AAED;;;;GAIG;AACH,kEAFa,OAAO,CAAC,MAAM,CAAC,CAQ3B;AAED;;;;GAIG;AACH,iEAFa,OAAO,CAAC,MAAM,CAAC,CAQ3B;AAED;;;;GAIG;AACH,sEAFa,OAAO,CAAC,OAAO,eAAe,EAAE,MAAM,EAAE,CAAC,CAyBrD;AAED;;;;;GAKG;AACH,4EAHW,OAAO,eAAe,EAAE,MAAM,GAC5B,OAAO,CAAC,IAAI,CAAC,CAuBzB;AAED;;;;;GAKG;AACH,mFAJW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAgBzB;AAED;;;;GAIG;AACH,yEAFa,OAAO,CAAC,IAAI,CAAC,CASzB;AAED;;;;GAIG;AACH,8EAHW,OAAO,GAAG,MAAM,GACd,OAAO,GAAG,MAAM,CAe5B;AAED;;;;GAIG;AACH,qFAHW,GAAG,GACD,GAAG,CAef;AAED;;;;;;GAMG;AACH,4EANW,MAAM,QACN,OAAO,EAAE,iCACP,OAAO,CAAC,GAAG,CAAC,CAQxB;AAED;;;;GAIG;AACH,iFAHW,MAAM,QACN,GAAG,EAAE,gBASf;;IAZD;;;;OAIG;IACH,4DAHW,MAAM,QACN,GAAG,EAAE,EASf;IAJG;;;MAAqC;;AAMzC;;;;;GAKG;AACH,gCALsB,CAAC,SAAV,MAAQ,oDACV,CAAC,GAAC,OAAO,CAAC,CAAC,CAAC,GACV,OAAO,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,CAS7C;AAED;;;GAGG;AACH,yFAHW,SAAS,GAAG,EAAE,OAiBxB;AAED;;;;GAIG;AACH,sCAHW,GAAG,GACD,MAAM,GAAG,SAAS,CAI9B;AAED;;;GAGG;AACH,sCAHW,GAAG,GACD,OAAO,IAAI,OAAO,CAO9B;AAED;;;;;;;GAOG;AACH,6FANW,MAAM,YACN,MAAM,SACN,OAAO,QACP,OAAO,GAAG,MAAM,GAAG,IAAI,GACrB,OAAO,CAAC,OAAO,GAAG,OAAO,EAAE,CAAC,CA4BxC;AAED;;;;GAIG;AACH,4EAHW,MAAM,KACN,MAAM,iBAKhB;AAED;;;GAGG;AACH,6EAFa,OAAO,CAAC,OAAO,CAAC,CAc5B;;IANG,qCAAiE;;AAQrE;;;GAGG;AACH,+EAFa,OAAO,CAAC,OAAO,eAAe,EAAE,IAAI,CAAC,CAajD;AAED;;;GAGG;AACH,8EAFa,OAAO,CAAC,OAAO,CAAC,CAqB5B;;IAVO,sCAA4B;;AAYpC;;GAEG;AACH,qIA0FC;AAED;;;;;GAKG;AACH,+FAJW,OAAO,oBACP,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAuB3B;AAED;;;;GAIG;AACH,2EAHW,GAAG,GACD,OAAO,CAAC,IAAI,CAAC,CAwBzB;AAED;;;;;GAKG;AACH,gFAJW,MAAM,KACN,MAAM,GACJ,OAAO,CAAC,OAAO,eAAe,EAAE,QAAQ,CAAC,CA4FrD;AAED;;;GAGG;AACH,yEAFa,OAAO,CAAC,OAAO,CAAC,CAI5B;AAED;;;GAGG;AACH,+EAHW,OAAO,CAAC,GAAG,CAAC,gBA+EtB;AAED;;;GAGG;AACH,gFAHW,MAAM,iBAUhB;AAED;;;;GAIG;AACH,+EAHa,MAAM,CAUlB;AAED;;;;;;;;;;;;GAYG;AACH,0GAFa,OAAO,CAAC,OAAO,UAAU,EAAE,eAAe,CAAC,CAgEvD;;IAnBK;;;;;MAKC;;AAgBP;;;;;;;;;;;;GAYG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,qGAdW,OAAO,eAAe,EAAE,YAAY,GAUlC,OAAO,CAAC,IAAI,CAAC,CAczB;;;;;;;;;;;;;;iBAvCa,MAAM;;;;;;;;;6BAiLP,OAAO,WAAW,EAAE,cAAc;mBAClC,OAAO,eAAe,EAAE,IAAI;oBAIlB,CAAC,SAAX,MAAQ,aACR,OAAO,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;6BAIlC,OAAO,wBAAwB,EAAE,cAAc"}