@applitools/eyes-webdriverio 5.36.0 → 5.36.2

package/CHANGELOG.md

@@ -10,6 +10,24 @@
 
 
 
+## 5.36.2 - 2022/10/8
+
+### Features
+- Applied client's user-agent by default to resource requests in ufg mode
+### Bug fixes
+- Fixed bug when error was thrown when coded region wasn't found using selector
+- Fixed wrong signature of `closeBatch` function
+- Blank missed frames src in ufg
+- Fix an issue when ufg related requests were not sent through the proxy
+- Fixed issue with logs not being saved/written
+
+## 5.36.1 - 2022/10/4
+
+### Features
+### Bug fixes
+- Fixed the issue with screenshots being taken on chrome-emulated devices
+- Fixed issue that prevented Target.webview() from being called
+
 ## 5.36.0 - 2022/9/29
 
 ### Features

package/README.md

@@ -31,6 +31,8 @@
         * [Accessiblity Regions](#accessiblity-regions)
         * [Scroll root element](#scroll-root-element)
         * [Variation group ID](#variation-group-id)
+        * [Lazy loading](#lazy-loading-lazyload)
+        * [WebView](#webview-webview)
         * [Other checkSettings configuration](#other-checksettings-configuration)
   * [close](#close)
 - [Runners](#runners)
@@ -375,6 +377,22 @@ Other details:
 - 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)
 - 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
 
+##### WebView (`webview`)
+
+When working with native apps that have webviews, it's possible to capture their contents in a check command.
+
+You do this by specifying it in the check settings like so:
+
+```js
+// the SDK will automatically switch to the first available web view
+eyes.check(Target.webview())
+
+// they can also specify the webview id (if it's static and they know what it is)
+eyes.check(Target.webview('webview-id'))
+```
+
+After the check command, the SDK will switch the driver back to the app context that it was prior to performing the check.
+
 ###### Other checkSettings configuration
 
 <!-- TODO add explanation -->

package/dist/api.js

@@ -26,7 +26,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BatchClose = exports.Target = exports.CheckSettings = exports.Configuration = exports.Eyes = exports.By = void 0;
+exports.closeBatch = exports.BatchClose = exports.Target = exports.CheckSettings = exports.Configuration = exports.Eyes = exports.By = void 0;
 const core_1 = require("@applitools/core");
 const api = __importStar(require("@applitools/eyes-api"));
 const spec = __importStar(require("@applitools/spec-driver-webdriverio"));
@@ -54,3 +54,4 @@ class BatchClose extends api.BatchClose {
 }
 exports.BatchClose = BatchClose;
 BatchClose._spec = sdk;
+exports.closeBatch = api.closeBatch(sdk);

package/dist/service.js

@@ -63,7 +63,7 @@ class EyesService {
     beforeSession(config) {
         this._appName = this._eyes.configuration.appName;
         if (config.enableEyesLogs) {
-            this._eyes.configuration.logs = { type: 'console' };
+            this._eyes.setLogHandler({ type: 'console' });
         }
     }
     before() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-webdriverio",
-  "version": "5.36.0",
+  "version": "5.36.2",
   "description": "Applitools Eyes SDK for WebdriverIO",
   "keywords": [
     "eyes-webdriverio",
@@ -116,17 +116,17 @@
     }
   },
   "dependencies": {
-    "@applitools/core": "1.1.0",
-    "@applitools/eyes-api": "1.8.0",
-    "@applitools/spec-driver-webdriverio": "1.3.0"
+    "@applitools/core": "1.1.5",
+    "@applitools/eyes-api": "1.8.5",
+    "@applitools/spec-driver-webdriverio": "1.4.0"
   },
   "devDependencies": {
     "@applitools/api-extractor": "1.2.11",
     "@applitools/bongo": "^2.2.0",
-    "@applitools/scripts": "1.1.0",
+    "@applitools/scripts": "1.2.0",
     "@applitools/sdk-coverage-tests": "^2.3.20",
-    "@applitools/sdk-shared": "0.9.14",
-    "@applitools/test-utils": "1.5.1",
+    "@applitools/sdk-shared": "0.9.15",
+    "@applitools/test-utils": "1.5.2",
     "@types/mocha": "^9.1.1",
     "@types/node": "12",
     "@typescript-eslint/eslint-plugin": "^5.27.0",

package/types/index.d.ts

@@ -45,7 +45,7 @@ export class Eyes {
     setViewportSize(size: RectangleSizePlain): Promise<void>;
     getScrollRootElement(): Element | EyesSelector<Selector>;
     setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): void;
-    setLogHandler(handler: LogHandler): void;
+    setLogHandler(handler: LogHandlerPlain | LogHandler): void;
     getLogHandler(): LogHandler;
     setCutProvider(cutProvider: CutProvider): void;
     setImageCut(cutProvider: CutProvider): void;
@@ -406,7 +406,7 @@ export class Configuration implements Required<ConfigurationPlain> {
     addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
     addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
     addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
-    addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: IosVersionPlain): Configuration;
+    addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
     get visualGridOptions(): { [key: string]: any; };
     set visualGridOptions(visualGridOptions: { [key: string]: any; });
     getVisualGridOptions(): { [key: string]: any; };
@@ -554,6 +554,7 @@ export const Target: {
     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;
     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;
     shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
+    webview(option?: string | boolean): CheckSettings;
 };
 export class BatchClose {
     static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }): Promise<void>;
@@ -564,6 +565,7 @@ export class BatchClose {
     setApiKey(apiKey: string): BatchClose;
     setProxy(proxy: ProxySettingsPlain): BatchClose;
 }
+export const closeBatch: (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }) => Promise<void>;
 export type AccessibilityGuidelinesVersionPlain = "WCAG_2_0" | "WCAG_2_1";
 export enum AccessibilityGuidelinesVersion {
     WCAG_2_0 = 'WCAG_2_0',
@@ -748,11 +750,10 @@ export enum AndroidDeviceName {
     Xiaomi_Redmi_Note_11 = 'Xiaomi Redmi Note 11',
     Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro'
 }
-export type AndroidVersionPlain = "latest" | "latest-1" | "latest-2";
+export type AndroidVersionPlain = "latest" | "latest-1";
 export enum AndroidVersion {
     LATEST = 'latest',
-    ONE_VERSION_BACK = 'latest-1',
-    TWO_VERSIONS_BACK = 'latest-2'
+    ONE_VERSION_BACK = 'latest-1'
 }
 export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColor" | "Strict" | "Exact";
 export enum MatchLevel {
@@ -1169,7 +1170,7 @@ export class Region implements Required<RegionPlain> {
 }
 export type DesktopBrowserInfo = { name?: BrowserTypePlain; width: number; height: number; };
 export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }; };
-export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: IosVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
+export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
 export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
 export type RunnerOptionsPlain = { testConcurrency?: number; };
 export class RunnerOptionsFluent {
@@ -1376,7 +1377,7 @@ export type EyesSelector<TSelector = never> = string | TSelector | { selector: s
 export class Logger {
     constructor(options?: { show?: boolean; label?: string; handler?: LogHandlerPlain; });
     constructor(show?: boolean);
-    getLogHandler(): LogHandler;
+    getLogHandler(): LogHandler | FileLogHandler | ConsoleLogHandler;
     setLogHandler(handler: LogHandlerPlain): void;
     verbose(...messages: Array<any>): void;
     log(...messages: Array<any>): void;
@@ -1388,7 +1389,6 @@ export class Logger {
     tag(name: string, value: any): void;
     extend(label?: string): Logger;
 }
-export function closeBatch(spec: BatchCloseSpec): (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }) => Promise<void>;
 export abstract class EyesRunner {
     getAllTestResults(throwErr?: boolean): Promise<TestResultsSummary>;
 }