@applitools/eyes-webdriverio 5.40.2 → 5.41.1

package/CHANGELOG.md

@@ -10,6 +10,18 @@
 
 
 
+## 5.41.1 - 2023/2/6
+
+### Features
+### Bug fixes
+- Fix instability when getting information to connect to the NML
+
+## 5.41.0 - 2023/2/1
+
+### Features
+- Add NML support for Android
+### Bug fixes
+
 ## 5.40.2 - 2023/1/27
 
 ### Features

package/dist/legacy.js

@@ -17,6 +17,7 @@ class By {
     static attributeValue(attr, value) {
         return new By(`*[${attr}="${value}"]`);
     }
+    // @ts-ignore
     static name(name) {
         return By.attributeValue('name', name);
     }

package/dist/service.js

@@ -33,8 +33,10 @@ if (!process.env.APPLITOOLS_WEBDRIVERIO_MAJOR_VERSION) {
         process.env.APPLITOOLS_WEBDRIVERIO_MAJOR_VERSION = major;
     }
     catch {
+        // NOTE: ignore error
     }
 }
+// TODO have to be removed
 const sdk = (0, core_1.makeCore)({
     agentId: `eyes-webdriverio-service/${require('../package.json').version}`,
     spec,
@@ -75,6 +77,7 @@ class EyesService {
             await this._eyesOpen();
             return this._eyes.check(title, checkSettings);
         });
+        // deprecated, alias of eyesCheck
         browser.addCommand('eyesCheckWindow', async (...args) => {
             return browser.eyesCheck(...args);
         });
@@ -88,6 +91,7 @@ class EyesService {
             this._eyes.getConfiguration().clearProperties();
         });
         browser.addCommand('eyesGetTestResults', async () => {
+            // because `afterTest` executes after `afterEach`, this is the way to get results in `afterEach` or `it`
             await this._eyesClose();
             return this._testResults;
         });
@@ -107,9 +111,9 @@ class EyesService {
     beforeTest(test) {
         var _a, _b, _c;
         const configuration = this._eyes.getConfiguration();
-        configuration.setTestName((_a = test.title) !== null && _a !== void 0 ? _a : test.description);
+        configuration.setTestName((_a = test.title) !== null && _a !== void 0 ? _a : test.description); // test.title is for mocha, and test.description is for jasmine
         if (!this._appName) {
-            configuration.setAppName((_b = test.parent) !== null && _b !== void 0 ? _b : (_c = test.fullName) === null || _c === void 0 ? void 0 : _c.replace(` ${test.description}`, ''));
+            configuration.setAppName((_b = test.parent) !== null && _b !== void 0 ? _b : (_c = test.fullName) === null || _c === void 0 ? void 0 : _c.replace(` ${test.description}`, '')); // test.parent is for mocha, and test.id is for jasmine
         }
         if (!configuration.getViewportSize()) {
             configuration.setViewportSize({ width: 800, height: 600 });
@@ -117,6 +121,8 @@ class EyesService {
         this._eyes.setConfiguration(configuration);
     }
     async afterTest() {
+        // the next line is required because if we set an element in one test, then the following test
+        // will say that the element is not attached to the page (because different browsers are used)
         this._eyes.getConfiguration().setScrollRootElement(null);
         await this._eyesClose();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-webdriverio",
-  "version": "5.40.2",
+  "version": "5.41.1",
   "description": "Applitools Eyes SDK for WebdriverIO",
   "keywords": [
     "eyes-webdriverio",
@@ -88,73 +88,54 @@
     "types"
   ],
   "scripts": {
-    "lint": "eslint '**/*.ts'",
-    "build": "ttsc --project tsconfig.build.v$([ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ] && echo ${APPLITOOLS_WEBDRIVERIO_VERSION%%.*} || echo 8).json",
+    "lint": "node ../../node_modules/.bin/eslint '**/*.ts'",
+    "build": "node ../../node_modules/.bin/ttsc --project tsconfig.build.v$([ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ] && echo ${APPLITOOLS_WEBDRIVERIO_VERSION%%.*} || echo 8).json",
     "generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes.webdriverio.javascript5'",
     "test": "yarn test:service && yarn test:coverage",
     "test:sanity": "echo 'create sanity suite'",
     "test:service": "mocha ./test/service/unit/*.spec.js && wdio run ./test/service/wdio.conf.js && wdio run ./test/service/no-config/wdio.no-config.conf.js && wdio run ./test/service/vg/wdio.vg.conf.js",
-    "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-webdriverio-5' APPLITOOLS_BATCH_ID=$(uuidgen) XUNIT_FILE=coverage-test-report.xml mocha --config .mocharc.cvg.js",
+    "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-webdriverio-5' APPLITOOLS_BATCH_ID=$(uuidgen) mocha --config .mocharc.cvg.js",
     "test:coverage:wd": "APPLITOOLS_WEBDRIVERIO_PROTOCOL=wd yarn test:coverage",
     "test:coverage:cdp": "APPLITOOLS_WEBDRIVERIO_PROTOCOL=cdp yarn test:coverage",
     "report": "coverage-tests report https://raw.githubusercontent.com/applitools/sdk.coverage.tests/master/js/config.js --name 'eyes.webdriverio.javascript5'",
     "setup": "yarn docker:setup",
-    "docker:setup": "node ../scripts/scripts/generate-docker-compose-config.js && docker-compose up -d",
+    "docker:setup": "node ../../scripts/generate-docker-compose-config.js && docker-compose up -d",
     "docker:teardown": "docker-compose down",
     "upgrade:framework": "if [ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ]; then packagejson=`cat package.json`; NODE_VERSION=${NODE_VERSION:-$(node -v)} yarn upgrade --no-lockfile webdriverio@$APPLITOOLS_WEBDRIVERIO_VERSION webdriver@$APPLITOOLS_WEBDRIVERIO_VERSION @types/node@${NODE_VERSION%%.*}; echo \"$packagejson\" > package.json; fi",
     "deps": "bongo deps",
     "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio(node:14) wdio(node:12) wdio(protocol:cdp) wdio(framework:6) wdio(framework:5)'",
-    "gh:test:links": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio+cdp wdio@6 wdio@5' -f links='types test-utils sdk-shared eyes-sdk-core visual-grid-client eyes-api spec-driver-webdriverio utils driver snippets screenshoter'",
+    "gh:test:links": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio+cdp wdio@6 wdio@5' -f links='types test-utils eyes-sdk-core visual-grid-client eyes-api spec-driver-webdriverio utils driver snippets screenshoter'",
     "gh:publish": "gh workflow run publish-webdriverio.yml --ref $(git rev-parse --abbrev-ref HEAD)",
-    "preversion": "bongo preversion --verifyPendingChanges && yarn build",
+    "preversion": "bongo preversion --verifyPendingChanges",
     "version": "bongo version --withPendingChanges",
     "postversion": "bongo postversion"
   },
-  "husky": {
-    "hooks": {
-      "pre-push": "yarn bongo lint"
-    }
-  },
   "dependencies": {
-    "@applitools/core": "1.4.5",
-    "@applitools/eyes-api": "1.13.0",
-    "@applitools/spec-driver-webdriverio": "1.4.21"
+    "@applitools/core": "1.4.7",
+    "@applitools/eyes-api": "1.13.2",
+    "@applitools/spec-driver-webdriverio": "1.4.23"
   },
   "devDependencies": {
     "@applitools/api-extractor": "1.2.11",
     "@applitools/bongo": "^2.2.2",
-    "@applitools/scripts": "1.2.0",
     "@applitools/sdk-coverage-tests": "^2.7.10",
-    "@applitools/sdk-shared": "0.9.15",
-    "@applitools/test-utils": "1.5.9",
+    "@applitools/test-utils": "1.5.12",
     "@types/mocha": "^9.1.1",
     "@types/node": "16",
-    "@typescript-eslint/eslint-plugin": "^5.27.0",
-    "@typescript-eslint/parser": "^5.27.0",
     "@wdio/cli": "^8.2.2",
     "@wdio/dot-reporter": "^8.0.14",
     "@wdio/globals": "^8.2.2",
     "@wdio/local-runner": "^8.2.2",
     "@wdio/mocha-framework": "^8.2.1",
     "chromedriver": "^109.0.0",
-    "eslint": "^8.16.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-mocha-no-only": "^1.1.1",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
     "expect-webdriverio": "^4.0.1",
     "geckodriver": "^1.20.0",
-    "husky": "^4.3.8",
     "mocha": "^9.2.2",
-    "prettier": "^2.6.2",
-    "spec-xunit-file": "0.0.1-3",
-    "ts-node": "^10.8.0",
-    "ttypescript": "^1.5.13",
-    "typescript": "^4.9.4",
+    "mocha-multi": "^1.1.7",
     "webdriverio": "^8.2.2"
   },
   "peerDependencies": {
-    "webdriverio": "5.0.0 - 8.x.x"
+    "webdriverio": ">=5.0.0"
   },
   "engines": {
     "node": ">=12.13.0"

package/types/index.d.ts

@@ -204,7 +204,7 @@ export type ConfigurationPlain = {
     disableBrowserFetching?: undefined | boolean;
 };
 export class Configuration implements Required<ConfigurationPlain> {
-    constructor(config?: undefined | ConfigurationPlain, spec?: undefined | { isElement(element: any): element is Element; isSelector(selector: any): selector is Selector; });
+    constructor(config?: undefined | ConfigurationPlain, spec?: undefined | {});
     get appName(): string;
     set appName(appName: string);
     getAppName(): string;
@@ -249,7 +249,7 @@ export class Configuration implements Required<ConfigurationPlain> {
     set proxy(proxy: ProxySettingsPlain);
     getProxy(): ProxySettings;
     setProxy(proxy: ProxySettingsPlain): Configuration;
-    setProxy(url: string, username?: undefined | string, password?: undefined | string, isHttpOnly?: undefined | boolean): Configuration;
+    setProxy(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean): Configuration;
     setProxy(isEnabled: false): Configuration;
     get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
     set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
@@ -435,7 +435,7 @@ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
     lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
 };
 export class CheckSettingsAutomation {
-    constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: undefined | { isElement(value: any): value is Element; isSelector(value: any): value is Selector; });
+    constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: undefined | {});
     region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
     shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
     frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
@@ -754,7 +754,7 @@ export enum TestResultsStatus {
 export class EyesError extends Error {
 }
 export class TestFailedError extends EyesError {
-    constructor(message: string, results?: undefined | TestResultsPlain);
+    constructor(message: string, results: TestResultsPlain);
     constructor(results: TestResultsPlain);
     get testResults(): TestResultsPlain;
     getTestResults(): TestResults;
@@ -1196,10 +1196,10 @@ export class PropertyData implements Required<PropertyDataPlain> {
     getValue(): string;
     setValue(value: string): void;
 }
-export type ProxySettingsPlain = { url: string; username?: undefined | string; password?: undefined | string; isHttpOnly?: undefined | boolean; };
+export type ProxySettingsPlain = { url: string; username?: undefined | string; password?: undefined | string; };
 export class ProxySettings implements Required<ProxySettingsPlain> {
     constructor(proxy: ProxySettingsPlain);
-    constructor(url: string, username?: undefined | string, password?: undefined | string, isHttpOnly?: undefined | boolean);
+    constructor(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean);
     get url(): string;
     getUri(): string;
     getUrl(): string;
@@ -1426,7 +1426,7 @@ export class TestResults implements Required<TestResultsPlain> {
     isPassed(): boolean;
     delete(): Promise<void>;
 }
-export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo; };
+export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo); };
 export class TestResultContainer implements Required<TestResultContainerPlain> {
     get testResults(): TestResultsPlain;
     getTestResults(): TestResults;
@@ -1482,7 +1482,7 @@ export class ClassicRunner extends EyesRunner {
 }
 export class VisualGridRunner extends EyesRunner {
     constructor(options?: undefined | RunnerOptionsPlain);
-    get testConcurrency(): number;
+    get testConcurrency(): undefined | number;
 }
 export abstract class SessionEventHandler {
     abstract initStarted(): any;
@@ -1514,14 +1514,14 @@ export class RemoteSessionEventHandler extends SessionEventHandler {
     set serverUrl(serverUrl: string);
     getServerUrl(): string;
     setServerUrl(serverUrl: string): void;
-    get accessKey(): string;
-    set accessKey(accessKey: string);
-    getAccessKey(): string;
+    get accessKey(): undefined | string;
+    set accessKey(accessKey: undefined | string);
+    getAccessKey(): undefined | string;
     setAccessKey(accessKey: string): void;
-    get timeout(): number;
-    set timeout(timeout: number);
+    get timeout(): undefined | number;
+    set timeout(timeout: undefined | number);
     setTimeout(timeout: number): void;
-    getTimeout(): number;
+    getTimeout(): undefined | number;
     initStarted(): void;
     initEnded(): void;
     setSizeWillStart(): void;

package/types/service.d.ts

@@ -1,4 +1,4 @@
-import { ConfigurationPlain } from './api';
+import { ConfigurationPlain } from './index';
 interface EyesServiceOptions extends ConfigurationPlain {
     useVisualGrid?: boolean;
     concurrency?: number;