@applitools/eyes-webdriverio 5.36.0 → 5.36.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.
package/CHANGELOG.md CHANGED
@@ -10,6 +10,13 @@
10
10
 
11
11
 
12
12
 
13
+ ## 5.36.1 - 2022/10/4
14
+
15
+ ### Features
16
+ ### Bug fixes
17
+ - Fixed the issue with screenshots being taken on chrome-emulated devices
18
+ - Fixed issue that prevented Target.webview() from being called
19
+
13
20
  ## 5.36.0 - 2022/9/29
14
21
 
15
22
  ### Features
package/README.md CHANGED
@@ -31,6 +31,8 @@
31
31
  * [Accessiblity Regions](#accessiblity-regions)
32
32
  * [Scroll root element](#scroll-root-element)
33
33
  * [Variation group ID](#variation-group-id)
34
+ * [Lazy loading](#lazy-loading-lazyload)
35
+ * [WebView](#webview-webview)
34
36
  * [Other checkSettings configuration](#other-checksettings-configuration)
35
37
  * [close](#close)
36
38
  - [Runners](#runners)
@@ -375,6 +377,22 @@ Other details:
375
377
  - The SDK will repeatedly scroll the page using the `scrollLength` until either the page cannot be scrolled further or the `maxAmountToScroll` has been reached (whichever happens first)
376
378
  - If more time is needed for additional content to load, then increase the waitingTime to a value higher than 500 milliseconds. If better performance is desired and additional content lazily loads faster than the default waitingTime, then reduce it to a value below 500 milliseconds
377
379
 
380
+ ##### WebView (`webview`)
381
+
382
+ When working with native apps that have webviews, it's possible to capture their contents in a check command.
383
+
384
+ You do this by specifying it in the check settings like so:
385
+
386
+ ```js
387
+ // the SDK will automatically switch to the first available web view
388
+ eyes.check(Target.webview())
389
+
390
+ // they can also specify the webview id (if it's static and they know what it is)
391
+ eyes.check(Target.webview('webview-id'))
392
+ ```
393
+
394
+ After the check command, the SDK will switch the driver back to the app context that it was prior to performing the check.
395
+
378
396
  ###### Other checkSettings configuration
379
397
 
380
398
  <!-- TODO add explanation -->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-webdriverio",
3
- "version": "5.36.0",
3
+ "version": "5.36.1",
4
4
  "description": "Applitools Eyes SDK for WebdriverIO",
5
5
  "keywords": [
6
6
  "eyes-webdriverio",
@@ -116,14 +116,14 @@
116
116
  }
117
117
  },
118
118
  "dependencies": {
119
- "@applitools/core": "1.1.0",
120
- "@applitools/eyes-api": "1.8.0",
121
- "@applitools/spec-driver-webdriverio": "1.3.0"
119
+ "@applitools/core": "1.1.2",
120
+ "@applitools/eyes-api": "1.8.2",
121
+ "@applitools/spec-driver-webdriverio": "1.3.1"
122
122
  },
123
123
  "devDependencies": {
124
124
  "@applitools/api-extractor": "1.2.11",
125
125
  "@applitools/bongo": "^2.2.0",
126
- "@applitools/scripts": "1.1.0",
126
+ "@applitools/scripts": "1.2.0",
127
127
  "@applitools/sdk-coverage-tests": "^2.3.20",
128
128
  "@applitools/sdk-shared": "0.9.14",
129
129
  "@applitools/test-utils": "1.5.1",
package/types/index.d.ts CHANGED
@@ -406,7 +406,7 @@ export class Configuration implements Required<ConfigurationPlain> {
406
406
  addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
407
407
  addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
408
408
  addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
409
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: IosVersionPlain): Configuration;
409
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
410
410
  get visualGridOptions(): { [key: string]: any; };
411
411
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
412
412
  getVisualGridOptions(): { [key: string]: any; };
@@ -554,6 +554,7 @@ export const Target: {
554
554
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); }): CheckSettings;
555
555
  frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })), scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
556
556
  shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
557
+ webview(option?: string | boolean): CheckSettings;
557
558
  };
558
559
  export class BatchClose {
559
560
  static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }): Promise<void>;
@@ -748,11 +749,10 @@ export enum AndroidDeviceName {
748
749
  Xiaomi_Redmi_Note_11 = 'Xiaomi Redmi Note 11',
749
750
  Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro'
750
751
  }
751
- export type AndroidVersionPlain = "latest" | "latest-1" | "latest-2";
752
+ export type AndroidVersionPlain = "latest" | "latest-1";
752
753
  export enum AndroidVersion {
753
754
  LATEST = 'latest',
754
- ONE_VERSION_BACK = 'latest-1',
755
- TWO_VERSIONS_BACK = 'latest-2'
755
+ ONE_VERSION_BACK = 'latest-1'
756
756
  }
757
757
  export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColor" | "Strict" | "Exact";
758
758
  export enum MatchLevel {
@@ -1169,7 +1169,7 @@ export class Region implements Required<RegionPlain> {
1169
1169
  }
1170
1170
  export type DesktopBrowserInfo = { name?: BrowserTypePlain; width: number; height: number; };
1171
1171
  export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }; };
1172
- export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: IosVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1172
+ export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1173
1173
  export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1174
1174
  export type RunnerOptionsPlain = { testConcurrency?: number; };
1175
1175
  export class RunnerOptionsFluent {