webdriverio 9.4.4 → 9.5.0

package/build/commands/browser/mock.d.ts

@@ -37,7 +37,7 @@ export declare const SESSION_MOCKS: Record<string, Set<WebDriverInterception>>;
         const strictMock = await browser.mock('**', {
             // mock all json responses
             statusCode: 200,
-            headers: { 'Content-Type': 'application/json' },
+            requestHeaders: { 'Content-Type': 'application/json' },
             responseHeaders: { 'Cache-Control': 'no-cache' },
             postData: 'foobar'
         })
@@ -45,7 +45,7 @@ export declare const SESSION_MOCKS: Record<string, Set<WebDriverInterception>>;
         // comparator function
         const apiV1Mock = await browser.mock('**' + '/api/v1', {
             statusCode: (statusCode) => statusCode >= 200 && statusCode <= 203,
-            headers: (headers) => headers['Authorization'] && headers['Authorization'].startsWith('Bearer '),
+            requestHeaders: (headers) => headers['Authorization'] && headers['Authorization'].startsWith('Bearer '),
             responseHeaders: (headers) => headers['Impersonation'],
             postData: (data) => typeof data === 'string' && data.includes('foo')
         })
@@ -99,7 +99,7 @@ export declare const SESSION_MOCKS: Record<string, Set<WebDriverInterception>>;
  * @param {String}              url                             url to mock
  * @param {MockFilterOptions=}  filterOptions                   filter mock resource by additional options
  * @param {String|Function=}    filterOptions.method            filter resource by HTTP method
- * @param {Object|Function=}    filterOptions.headers           filter resource by specific request headers
+ * @param {Object|Function=}    filterOptions.requestHeaders    filter resource by specific request headers
  * @param {Object|Function=}    filterOptions.responseHeaders   filter resource by specific response headers
  * @param {String|Function=}    filterOptions.postData          filter resource by request postData
  * @param {Number|Function=}    filterOptions.statusCode        filter resource by response statusCode

package/build/commands/browser.d.ts

@@ -42,4 +42,9 @@ export * from './browser/touchAction.js';
 export * from './browser/uploadFile.js';
 export * from './browser/url.js';
 export * from './browser/waitUntil.js';
+/**
+ * Add it to the Browser scope, but not to the docs by providing a different folder
+ */
+export * from './mobile/swipe.js';
+export * from './mobile/tap.js';
 //# sourceMappingURL=browser.d.ts.map

package/build/commands/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../src/commands/browser.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,sBAAsB,CAAA;AACpC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,oBAAoB,CAAA;AAClC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA;AACvC,cAAc,2BAA2B,CAAA;AACzC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,2BAA2B,CAAA;AACzC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,sBAAsB,CAAA;AACpC,cAAc,qBAAqB,CAAA;AACnC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,kCAAkC,CAAA;AAChD,cAAc,6BAA6B,CAAA;AAC3C,cAAc,qBAAqB,CAAA;AACnC,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,0BAA0B,CAAA;AACxC,cAAc,uBAAuB,CAAA;AACrC,cAAc,0BAA0B,CAAA;AACxC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,0BAA0B,CAAA;AACxC,cAAc,yBAAyB,CAAA;AACvC,cAAc,kBAAkB,CAAA;AAChC,cAAc,wBAAwB,CAAA"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../src/commands/browser.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,sBAAsB,CAAA;AACpC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,oBAAoB,CAAA;AAClC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA;AACvC,cAAc,2BAA2B,CAAA;AACzC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,2BAA2B,CAAA;AACzC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,sBAAsB,CAAA;AACpC,cAAc,qBAAqB,CAAA;AACnC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,kCAAkC,CAAA;AAChD,cAAc,6BAA6B,CAAA;AAC3C,cAAc,qBAAqB,CAAA;AACnC,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,0BAA0B,CAAA;AACxC,cAAc,uBAAuB,CAAA;AACrC,cAAc,0BAA0B,CAAA;AACxC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,0BAA0B,CAAA;AACxC,cAAc,yBAAyB,CAAA;AACvC,cAAc,kBAAkB,CAAA;AAChC,cAAc,wBAAwB,CAAA;AACtC;;GAEG;AACH,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA"}

package/build/commands/element/scrollIntoView.d.ts

@@ -5,9 +5,7 @@ import type { CustomScrollIntoViewOptions } from '../../types.js';
  *
  * :::info
  *
- * Scrolling for Mobile Native Apps is done based on native mobile gestures. It is only supported for the following drivers:
- * - [appium-uiautomator2-driver](https://github.com/appium/appium-uiautomator2-driver/blob/master/docs/android-mobile-gestures.md#mobile-scrollgesture) for Android
- * - [appium-xcuitest-driver](https://appium.github.io/appium-xcuitest-driver/latest/reference/execute-methods/#mobile-scroll) for iOS
+ * Scrolling for Mobile Native Apps is done based on the mobile `swipe` command.
  *
  * :::
  *
@@ -29,18 +27,26 @@ import type { CustomScrollIntoViewOptions } from '../../types.js';
         // scroll to a specific element in the default scrollable element for Android or iOS for a maximum of 10 scrolls
         await elem.scrollIntoView();
         // Scroll to the left in the scrollable element called '#scrollable' for a maximum of 5 scrolls
-        await elem.scrollIntoView({ direction: 'left', maxScrolls: 5, scrollableElement: $('#scrollable') });
+        await elem.scrollIntoView({
+            direction: 'left',
+            maxScrolls: 5,
+            scrollableElement: $('#scrollable')
+        });
     });
  * </example>
  *
  * @alias element.scrollIntoView
  * @param {object|boolean=} options                   options for `Element.scrollIntoView()`. Default for desktop/mobile web: <br/> `{ block: 'start', inline: 'nearest' }` <br /> Default for Mobile Native App <br /> `{ maxScrolls: 10, scrollDirection: 'down' }`
+ * @rowInfo Desktop/Mobile Web Only
  * @param {string=}         options.behavior          See [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView). <br /><strong>WEB-ONLY</strong> (Desktop/Mobile)
  * @param {string=}         options.block             See [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView). <br /><strong>WEB-ONLY</strong> (Desktop/Mobile)
  * @param {string=}         options.inline            See [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView). <br /><strong>WEB-ONLY</strong> (Desktop/Mobile)
- * @param {string=}         options.direction         Can be one of `down`, `up`, `left` or `right`, default is `down`. <br /><strong>MOBILE-NATIVE-APP-ONLY</strong>
+ * @rowInfo Mobile Native App Only
+ * @param {string=}         options.direction         Can be one of `down`, `up`, `left` or `right`, default is `up`. <br /><strong>MOBILE-NATIVE-APP-ONLY</strong>
  * @param {number=}         options.maxScrolls        The max amount of scrolls until it will stop searching for the element, default is `10`. <br /><strong>MOBILE-NATIVE-APP-ONLY</strong>
+ * @param {number=}         options.duration          The duration in milliseconds for the swipe. Default is `1500` ms. The lower the value, the faster the swipe.<br /><strong>MOBILE-NATIVE-APP-ONLY</strong>
  * @param {Element=}        options.scrollableElement Element that is used to scroll within. If no element is provided it will use the following selector for iOS `-ios predicate string:type == "XCUIElementTypeApplication"` and the following for Android `//android.widget.ScrollView'`. If more elements match the default selector, then by default it will pick the first matching element. <br /> <strong>MOBILE-NATIVE-APP-ONLY</strong>
+ * @param {number=}         options.percent           The percentage of the (default) scrollable element to swipe. This is a value between 0 and 1. Default is `0.95`.<br /><strong>NEVER</strong> swipe from the exact top|bottom|left|right of the screen, you might trigger for example the notification bar or other OS/App features which can lead to unexpected results.<br /> <strong>MOBILE-NATIVE-APP-ONLY</strong>
  * @uses protocol/execute
  * @type utility
  *

package/build/commands/element/scrollIntoView.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scrollIntoView.d.ts","sourceRoot":"","sources":["../../../src/commands/element/scrollIntoView.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,2BAA2B,EAA+B,MAAM,gBAAgB,CAAA;AAK9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,wBAAsB,cAAc,CAChC,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,GAAE,2BAA2B,GAAG,OAA+C,GACvF,OAAO,CAAC,IAAI,GAAC,OAAO,CAAC,CA6EvB"}
+{"version":3,"file":"scrollIntoView.d.ts","sourceRoot":"","sources":["../../../src/commands/element/scrollIntoView.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,2BAA2B,EAA+B,MAAM,gBAAgB,CAAA;AAK9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,wBAAsB,cAAc,CAChC,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,GAAE,2BAA2B,GAAG,OAA+C,GACvF,OAAO,CAAC,IAAI,GAAC,OAAO,CAAC,CA6EvB"}

package/build/commands/element.d.ts

@@ -59,5 +59,6 @@ export * from './element/waitUntil.js';
 export * from './mobile/dragAndDrop.js';
 export * from './mobile/longPress.js';
 export * from './mobile/pinch.js';
+export * from './mobile/tap.js';
 export * from './mobile/zoom.js';
 //# sourceMappingURL=element.d.ts.map

package/build/commands/element.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"element.d.ts","sourceRoot":"","sources":["../../src/commands/element.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,cAAc,yBAAyB,CAAA;AACvC,cAAc,oBAAoB,CAAA;AAClC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,0BAA0B,CAAA;AACxC,cAAc,sBAAsB,CAAA;AACpC,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,yBAAyB,CAAA;AACvC;;GAEG;AAEH,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,0BAA0B,CAAA;AACxC,cAAc,sBAAsB,CAAA;AACpC,cAAc,yBAAyB,CAAA;AACvC,cAAc,sBAAsB,CAAA;AACpC,cAAc,uBAAuB,CAAA;AACrC,cAAc,0BAA0B,CAAA;AACxC,cAAc,0BAA0B,CAAA;AACxC,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA;AACpC,cAAc,yBAAyB,CAAA;AACvC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,uBAAuB,CAAA;AACrC,cAAc,qBAAqB,CAAA;AACnC,cAAc,0BAA0B,CAAA;AACxC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,sBAAsB,CAAA;AACpC,cAAc,qBAAqB,CAAA;AACnC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,4BAA4B,CAAA;AAC1C,cAAc,kCAAkC,CAAA;AAChD,cAAc,uBAAuB,CAAA;AACrC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,2BAA2B,CAAA;AACzC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,wBAAwB,CAAA;AACtC;;GAEG;AACH,cAAc,yBAAyB,CAAA;AACvC,cAAc,uBAAuB,CAAA;AACrC,cAAc,mBAAmB,CAAA;AACjC,cAAc,kBAAkB,CAAA"}
+{"version":3,"file":"element.d.ts","sourceRoot":"","sources":["../../src/commands/element.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,cAAc,yBAAyB,CAAA;AACvC,cAAc,oBAAoB,CAAA;AAClC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,0BAA0B,CAAA;AACxC,cAAc,sBAAsB,CAAA;AACpC,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,yBAAyB,CAAA;AACvC;;GAEG;AAEH,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,0BAA0B,CAAA;AACxC,cAAc,sBAAsB,CAAA;AACpC,cAAc,yBAAyB,CAAA;AACvC,cAAc,sBAAsB,CAAA;AACpC,cAAc,uBAAuB,CAAA;AACrC,cAAc,0BAA0B,CAAA;AACxC,cAAc,0BAA0B,CAAA;AACxC,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA;AACpC,cAAc,yBAAyB,CAAA;AACvC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,uBAAuB,CAAA;AACrC,cAAc,qBAAqB,CAAA;AACnC,cAAc,0BAA0B,CAAA;AACxC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,sBAAsB,CAAA;AACpC,cAAc,qBAAqB,CAAA;AACnC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,4BAA4B,CAAA;AAC1C,cAAc,kCAAkC,CAAA;AAChD,cAAc,uBAAuB,CAAA;AACrC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,2BAA2B,CAAA;AACzC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,wBAAwB,CAAA;AACtC;;GAEG;AACH,cAAc,yBAAyB,CAAA;AACvC,cAAc,uBAAuB,CAAA;AACrC,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,kBAAkB,CAAA"}

package/build/commands/mobile/dragAndDrop.d.ts

@@ -31,5 +31,6 @@ export {};
  * @param {Element|DragAndDropCoordinate}   target            destination element or object with x and y properties
  * @param {DragAndDropOptions=}             options           dragAndDrop command options
  * @param {Number=}                         options.duration  how long the drag should take place
+ * @mobileElement
  */
 //# sourceMappingURL=dragAndDrop.d.ts.map

package/build/commands/mobile/dragAndDrop.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dragAndDrop.d.ts","sourceRoot":"","sources":["../../../src/commands/mobile/dragAndDrop.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG"}
+{"version":3,"file":"dragAndDrop.d.ts","sourceRoot":"","sources":["../../../src/commands/mobile/dragAndDrop.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG"}

package/build/commands/mobile/longPress.d.ts

@@ -33,6 +33,7 @@ import type { LongPressOptions } from '../../types.js';
  * @param {number=}           options.x         Number (optional)
  * @param {number=}           options.y         Number (optional)
  * @param {number=}           options.duration  Duration of the press in ms, default is 1500 ms <br /><strong>MOBILE-ONLY</strong>
+ * @mobileElement
  */
 export declare function longPress(this: WebdriverIO.Element, options?: Partial<LongPressOptions>): Promise<void>;
 //# sourceMappingURL=longPress.d.ts.map

package/build/commands/mobile/longPress.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"longPress.d.ts","sourceRoot":"","sources":["../../../src/commands/mobile/longPress.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,SAAS,CACrB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,iBAwBtC"}
+{"version":3,"file":"longPress.d.ts","sourceRoot":"","sources":["../../../src/commands/mobile/longPress.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,SAAS,CACrB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,iBAwBtC"}

package/build/commands/mobile/pinch.d.ts

@@ -26,6 +26,7 @@ import type { PinchAndZoomOptions } from '../../types.js';
  * @param {PinchOptions=} options           pinch options (optional)
  * @param {number=}       options.duration  The duration in millisecond of how fast the pinch should be executed, minimal is 500 ms and max is 10000 ms. The default is 1500 ms (1.5 seconds) (optional)
  * @param {number=}       options.scale     The scale of how big the pinch should be according to the screen. Valid values must be float numbers in range 0..1, where 1.0 is 100% (optional)
+ * @mobileElement
  */
 export declare function pinch(this: WebdriverIO.Element, options?: Partial<PinchAndZoomOptions>): Promise<unknown>;
 //# sourceMappingURL=pinch.d.ts.map

package/build/commands/mobile/pinch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pinch.d.ts","sourceRoot":"","sources":["../../../src/commands/mobile/pinch.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAGzD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,KAAK,CACvB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,GAAE,OAAO,CAAC,mBAAmB,CAAM,oBAuB7C"}
+{"version":3,"file":"pinch.d.ts","sourceRoot":"","sources":["../../../src/commands/mobile/pinch.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAGzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,KAAK,CACvB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,GAAE,OAAO,CAAC,mBAAmB,CAAM,oBAuB7C"}

package/build/commands/mobile/scrollIntoView.d.ts

@@ -5,9 +5,7 @@ export {};
  *
  * :::info
  *
- * Scrolling for Mobile Native Apps is done based on native mobile gestures. It is only supported for the following drivers:
- * - [appium-uiautomator2-driver](https://github.com/appium/appium-uiautomator2-driver/blob/master/docs/android-mobile-gestures.md#mobile-scrollgesture) for Android
- * - [appium-xcuitest-driver](https://appium.github.io/appium-xcuitest-driver/latest/reference/execute-methods/#mobile-scroll) for iOS
+ * Scrolling for Mobile Native Apps is done based on the mobile `swipe` command.
  *
  * :::
  *
@@ -29,20 +27,28 @@ export {};
         // scroll to a specific element in the default scrollable element for Android or iOS for a maximum of 10 scrolls
         await elem.scrollIntoView();
         // Scroll to the left in the scrollable element called '#scrollable' for a maximum of 5 scrolls
-        await elem.scrollIntoView({ direction: 'left', maxScrolls: 5, scrollableElement: $('#scrollable') });
+        await elem.scrollIntoView({
+            direction: 'left',
+            maxScrolls: 5,
+            scrollableElement: $('#scrollable')
+        });
     });
  * </example>
  *
  * @alias element.scrollIntoView
  * @param {object|boolean=} options                   options for `Element.scrollIntoView()`. Default for desktop/mobile web: <br/> `{ block: 'start', inline: 'nearest' }` <br /> Default for Mobile Native App <br /> `{ maxScrolls: 10, scrollDirection: 'down' }`
+ * @rowInfo Desktop/Mobile Web Only
  * @param {string=}         options.behavior          See [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView). <br /><strong>WEB-ONLY</strong> (Desktop/Mobile)
  * @param {string=}         options.block             See [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView). <br /><strong>WEB-ONLY</strong> (Desktop/Mobile)
  * @param {string=}         options.inline            See [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView). <br /><strong>WEB-ONLY</strong> (Desktop/Mobile)
- * @param {string=}         options.direction         Can be one of `down`, `up`, `left` or `right`, default is `down`. <br /><strong>MOBILE-NATIVE-APP-ONLY</strong>
+ * @rowInfo Mobile Native App Only
+ * @param {string=}         options.direction         Can be one of `down`, `up`, `left` or `right`, default is `up`. <br /><strong>MOBILE-NATIVE-APP-ONLY</strong>
  * @param {number=}         options.maxScrolls        The max amount of scrolls until it will stop searching for the element, default is `10`. <br /><strong>MOBILE-NATIVE-APP-ONLY</strong>
+ * @param {number=}         options.duration          The duration in milliseconds for the swipe. Default is `1500` ms. The lower the value, the faster the swipe.<br /><strong>MOBILE-NATIVE-APP-ONLY</strong>
  * @param {Element=}        options.scrollableElement Element that is used to scroll within. If no element is provided it will use the following selector for iOS `-ios predicate string:type == "XCUIElementTypeApplication"` and the following for Android `//android.widget.ScrollView'`. If more elements match the default selector, then by default it will pick the first matching element. <br /> <strong>MOBILE-NATIVE-APP-ONLY</strong>
+ * @param {number=}         options.percent           The percentage of the (default) scrollable element to swipe. This is a value between 0 and 1. Default is `0.95`.<br /><strong>NEVER</strong> swipe from the exact top|bottom|left|right of the screen, you might trigger for example the notification bar or other OS/App features which can lead to unexpected results.<br /> <strong>MOBILE-NATIVE-APP-ONLY</strong>
  * @uses protocol/execute
  * @type utility
- *
+ * @skipUsage
  */
 //# sourceMappingURL=scrollIntoView.d.ts.map

package/build/commands/mobile/scrollIntoView.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scrollIntoView.d.ts","sourceRoot":"","sources":["../../../src/commands/mobile/scrollIntoView.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG"}
+{"version":3,"file":"scrollIntoView.d.ts","sourceRoot":"","sources":["../../../src/commands/mobile/scrollIntoView.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG"}

package/build/commands/mobile/swipe.d.ts

@@ -0,0 +1,64 @@
+import type { SwipeOptions } from '../../types.js';
+/**
+ *
+ * Swipe in a specific direction within viewport or element for Desktop/Mobile Web <strong>AND</strong> Mobile Native Apps.
+ *
+ * :::info
+ *
+ * Swiping for Mobile Native Apps is based on the W3C-actions protocol, simulating a finger press and movement.
+ * This is different from the [`mobile: scrollGesture`](https://github.com/appium/appium-uiautomator2-driver/blob/master/docs/android-mobile-gestures.md#mobile-scrollgesture) for Android
+ * or [`mobile: scroll`](https://appium.github.io/appium-xcuitest-driver/latest/reference/execute-methods/#mobile-scroll) for iOS command which is based on the Appium Driver protocol and is
+ * only available for mobile platforms in the NATIVE context.
+ *
+ * :::
+ *
+ * :::caution Swiping based on coordinates
+ *
+ * Avoid using `from` and `to` options unless absolutely necessary. These are device-specific and may not work consistently across devices.
+ * Use the `scrollableElement` option for reliable swipes within an element.
+ *
+ * :::
+ *
+ * <example>
+    :swipe.js
+    it('should execute a default swipe', async () => {
+        // Default will be a swipe from the bottom to the top, meaning it will swipe UP
+        await browser.swipe();
+    });
+ * </example>
+ *
+ * <example>
+    :swipe.with.options.js
+    it('should execute a swipe with options', async () => {
+        await browser.swipe({
+            direction: 'left',                  // Swipe from right to left
+            duration: 5000,                     // Last for 5 seconds
+            percent: 0.5,                       // Swipe 50% of the scrollableElement
+            scrollableElement: $('~carousel'),  // The element to swipe within
+        })
+    });
+ * </example>
+ *
+ * @alias element.scrollIntoView
+ * @param {object|boolean=} options                   options for `Element.scrollIntoView()`. Default for desktop/mobile web: <br/> `{ block: 'start', inline: 'nearest' }` <br /> Default for Mobile Native App <br /> `{ maxScrolls: 10, scrollDirection: 'down' }`
+ * @param {string=}         options.direction         Can be one of `down`, `up`, `left` or `right`, default is `up`. <br /><strong>MOBILE-NATIVE-APP-ONLY</strong>
+ * @rowInfo Down    ::<strong>Starting Point:</strong><br/>You place your finger towards the top of the screen.<br/><strong>Movement:</strong><br/>You slide your finger downwards towards the bottom of the screen.<br/><strong>Action:</strong><br/>This also varies by context:<br />- On the home screen or in applications, it typically scrolls the content upwards.<br />- From the top edge, it often opens the notifications panel or quick settings.<br />- In browsers or reading apps, it can be used to scroll through content.
+ * @rowInfo Left    ::<strong>Starting Point:</strong><br/>You place your finger on the right side of the screen.<br/><strong>Movement:</strong><br/>You slide your finger horizontally to the left.><br/><strong>Action:</strong><br/>The response to this gesture depends on the application:<br />- It can move to the next item in a carousel or a set of images.<br />- In a navigation context, it might go back to the previous page or close the current view.<br />- On the home screen, it usually switches to the next virtual desktop or screen.
+ * @rowInfo Right   ::<strong>Starting Point:</strong><br/>You place your finger on the left side of the screen.<br/><strong>Movement:</strong><br/>You slide your finger horizontally to the right.<br/><strong>Action:</strong><br/>Similar to swiping left, but in the opposite direction:<br />-- It often moves to the previous item in a carousel or gallery.<br />- Can be used to open side menus or navigation drawers in apps.<br />- On the home screen, it typically switches to the previous virtual desktop.
+ * @rowInfo Up      ::<strong>Starting Point:</strong><br/>You place your finger towards the bottom of the screen.<br/><strong>Movement:</strong><br/>You slide your finger upwards towards the top of the screen.><br/><strong>Action:</strong><br/>Depending on the context, different actions can occur:<br />- On the home screen or in a list, this usually scrolls the content downwards.<br />- In a full-screen app, it might open additional options or the app drawer.<br />- On certain interfaces, it could trigger a 'refresh' action or open a search bar.
+ * @param {number=}         options.duration          The duration in milliseconds for the swipe. Default is `1500` ms. The lower the value, the faster the swipe.
+ * @param {Element=}        options.scrollableElement Element that is used to swipe within. If no element is provided it will use the following selector for iOS `-ios predicate string:type == "XCUIElementTypeApplication"` and the following for Android `//android.widget.ScrollView'`. If more elements match the default selector, then by default it will pick the first matching element. <br /> <strong>MOBILE-NATIVE-APP-ONLY</strong>
+ * @param {number=}         options.percent           The percentage of the (default) scrollable element to swipe. This is a value between 0 and 1. Default is `0.95`.<br /><strong>NEVER</strong> swipe from the exact top|bottom|left|right of the screen, you might trigger for example the notification bar or other OS/App features which can lead to unexpected results.<br />This has no effect if `from` and `to` are provided.
+ * @rowInfo The below values <strong>ONLY</strong> have an effect if the `scrollableElement` is <strong>NOT</strong> provided, otherwise they are ignored.
+ * @param {object=}         options.from              The x and y coordinates of the start of the swipe. If a `scrollableElement` is provided, then these coordinates have no effect.
+ * @param {number=}         options.from.x            The x-coordinate of the start of the swipe.
+ * @param {number=}         options.from.y            The y-coordinate of the start of the swipe.
+ * @param {object=}         options.to                The x and y coordinates of the end of the swipe. If a `scrollableElement` is provided, then these coordinates have no effect.
+ * @param {number=}         options.to.x              The x-coordinate of the end of the swipe.
+ * @param {number=}         options.to.y              The y-coordinate of the end of the swipe.
+ * @uses protocol/execute
+ * @type utility
+ * @skipUsage
+ */
+export declare function swipe(this: WebdriverIO.Browser, options?: SwipeOptions): Promise<void | unknown>;
+//# sourceMappingURL=swipe.d.ts.map

package/build/commands/mobile/swipe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swipe.d.ts","sourceRoot":"","sources":["../../../src/commands/mobile/swipe.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAM,MAAM,gBAAgB,CAAA;AAUtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,wBAAsB,KAAK,CACvB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,CAAC,EAAE,YAAY,GACvB,OAAO,CAAC,IAAI,GAAC,OAAO,CAAC,CAuBvB"}

package/build/commands/mobile/tap.d.ts

@@ -0,0 +1,84 @@
+import type { TapOptions } from '../../types.js';
+/**
+ *
+ * Performs a tap gesture on:
+ * - or the given element. It will **automatically scroll** if it can't be found.
+ * - or the screen on a mobile device by providing `x` and `y` coordinates
+ *
+ * Internally it uses:
+ * - Element tap:
+ *      - the `click` command for Web environments (Chrome/Safari browsers, or hybrid apps)
+ *      - the Android [`mobile: clickGesture`](https://github.com/appium/appium-uiautomator2-driver/blob/master/docs/android-mobile-gestures.md#mobile-clickgesture)
+ * or iOS [`mobile: tap`](https://appium.github.io/appium-xcuitest-driver/latest/reference/execute-methods/#mobile-tap) for Natives apps, including the `scrollIntoView`
+ * command for automatic scrolling
+ * - Screen tap:
+ *      - the `action` command for Web environments (Chrome/Safari browsers, or hybrid apps)
+ *      - the Android [`mobile: clickGesture`](https://github.com/appium/appium-uiautomator2-driver/blob/master/docs/android-mobile-gestures.md#mobile-clickgesture)
+ * or iOS [`mobile: tap`](https://appium.github.io/appium-xcuitest-driver/latest/reference/execute-methods/#mobile-tap) for Natives apps
+ *
+ * This difference makes the `tap` command a more reliable alternative to the `click` command for mobile apps.
+ *
+ * For Native Apps, this command differs from the `click` command as it will <strong>automatically swipe</strong> to the element using the `scrollIntoView command`,
+ * which is not supported for native apps with the `click` command. In hybrid apps or web environments, automatic scrolling is supported for both `click` and `tap` commands.
+ *
+ * :::caution For Screen taps
+ *
+ * If you want to tap on a specific coordinate on the screen and you use a screenshot to determine the coordinates, remember that the
+ * the coordinates for iOS are based on the device's screen size, and not the screenshot size. The screenshot size is larger due to the device pixel ratio.
+ * The average device pixel ratio until the iPhone 8 and the current iPads is 2, for iPhones from the iPhone X the ratio is 3. This means that the screenshot
+ * size is 2 or 3 times larger than the device's screen size which means that ff you find the coordinates on the screenshot, divide them by the device pixel
+ * ratio to get the correct screen coordinates. For example:
+ *
+ * ```js
+ * const screenshotCoordinates = { x: 600, y: 900 };
+ * const dpr = 3; // Example for iPhone 16
+ * const screenCoordinates = {
+ *     x: screenshotCoordinates.x / dpr,
+ *     y: screenshotCoordinates.y / dpr
+ * };
+ * await browser.tap(screenCoordinates);
+ * ```
+ *
+ * :::
+ *
+ * <example>
+    :element.tap.example.js
+    it('should be able to tap an on element', async () => {
+        const elem = $('~myElement')
+        // It will automatically scroll to the element if it's not already in the viewport
+        await elem.tap()
+    })
+ * </example>
+ *
+ * <example>
+    :element.tap.scroll.options.example.js
+    it('should be able to swipe right 3 times in a custom scroll areas to an element and tap on the element', async () => {
+        const elem = $('~myElement')
+        // Swipe right 3 times in the custom scrollable element to find the element
+        await elem.tap({
+            direction: 'right',
+            maxScrolls: 3,
+            scrollableElement: $('#scrollable')
+        })
+    })
+ * </example>
+ *
+ * <example>
+    :screen.tap.example.js
+    it('should be able to tap on screen coordinates', async () => {
+        await browser.tap({ x: 200, y: 400 })
+    })
+ * </example>
+ *
+ * @param {TapOptions=} options                     Tap options (optional)
+ * @rowInfo Element tap options
+ * @param {number=}     options.x                   Number (optional, mandatory if y is set) <br /><strong>Only for SCREEN tap, not for ELEMENT tap</strong>
+ * @param {number=}     options.y                   Number (optional, mandatory if x is set) <br /><strong>Only for SCREEN tap, not for ELEMENT tap</strong>
+ * @rowInfo Screen tap options
+ * @param {string=}     options.direction           Can be one of `down`, `up`, `left` or `right`, default is `down`. <br /><strong>Only for ELEMENT tap, not for SCREEN tap</strong><br /><strong>MOBILE-NATIVE-APP-ONLY</strong>
+ * @param {number=}     options.maxScrolls          The max amount of scrolls until it will stop searching for the element, default is `10`. <br /><strong>Only for ELEMENT tap, not for SCREEN tap</strong><br /><strong>MOBILE-NATIVE-APP-ONLY</strong>
+ * @param {Element=}    options.scrollableElement   Element that is used to scroll within. If no element is provided it will use the following selector for iOS `-ios predicate string:type == "XCUIElementTypeApplication"` and the following for Android `//android.widget.ScrollView'`. If more elements match the default selector, then by default it will pick the first matching element. <br /><strong>Only for ELEMENT tap, not for SCREEN tap</strong><br /><strong>MOBILE-NATIVE-APP-ONLY</strong>
+ * @skipUsage
+ */
+export declare function tap(this: WebdriverIO.Browser | WebdriverIO.Element, options?: TapOptions): Promise<unknown>;
+//# sourceMappingURL=tap.d.ts.map

package/build/commands/mobile/tap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tap.d.ts","sourceRoot":"","sources":["../../../src/commands/mobile/tap.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAA+B,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAG7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgFG;AACH,wBAAsB,GAAG,CACrB,IAAI,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,EAC/C,OAAO,CAAC,EAAE,UAAU,oBAqBvB"}

package/build/commands/mobile/zoom.d.ts

@@ -26,6 +26,7 @@ import type { PinchAndZoomOptions } from '../../types.js';
  * @param {PinchAndZoomOptions=}    options           Zoom options (optional)
  * @param {number=}                 options.duration  The duration in millisecond of how fast the zoom should be executed, minimal is 500 ms and max is 10000 ms. The default is 1500 ms (1.5 seconds) (optional)
  * @param {number=}                 options.scale     The scale of how big the zoom should be according to the screen. Valid values must be float numbers in range 0..1, where 1.0 is 100% (optional)
+ * @mobileElement
  */
 export declare function zoom(this: WebdriverIO.Element, options?: Partial<PinchAndZoomOptions>): Promise<unknown>;
 //# sourceMappingURL=zoom.d.ts.map

package/build/commands/mobile/zoom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zoom.d.ts","sourceRoot":"","sources":["../../../src/commands/mobile/zoom.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAGzD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,IAAI,CACtB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,GAAE,OAAO,CAAC,mBAAmB,CAAM,oBAuB7C"}
+{"version":3,"file":"zoom.d.ts","sourceRoot":"","sources":["../../../src/commands/mobile/zoom.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAGzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,IAAI,CACtB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,GAAE,OAAO,CAAC,mBAAmB,CAAM,oBAuB7C"}

package/build/commands/mobile.d.ts

@@ -1,5 +1,6 @@
 export * from './mobile/dragAndDrop.js';
 export * from './mobile/longPress.js';
 export * from './mobile/pinch.js';
+export * from './mobile/tap.js';
 export * from './mobile/zoom.js';
 //# sourceMappingURL=mobile.d.ts.map

package/build/commands/mobile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mobile.d.ts","sourceRoot":"","sources":["../../src/commands/mobile.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,uBAAuB,CAAA;AACrC,cAAc,mBAAmB,CAAA;AACjC,cAAc,kBAAkB,CAAA"}
+{"version":3,"file":"mobile.d.ts","sourceRoot":"","sources":["../../src/commands/mobile.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,uBAAuB,CAAA;AACrC,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,kBAAkB,CAAA"}