@applitools/eyes 1.11.3 → 1.12.0

package/CHANGELOG.md

@@ -1,5 +1,149 @@
 # Changelog
 
+## [1.12.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes@1.11.4...js/eyes@1.12.0) (2023-11-21)
+
+
+### Features
+
+* added `enableEyesLogs` configuration to the eyes service ([639ca8a](https://github.com/applitools/eyes.sdk.javascript1/commit/639ca8a021008d06fc09d19ca58ac3d00a18e4c3))
+* added `useExecutionCloud` configuration to the eyes service ([#2033](https://github.com/applitools/eyes.sdk.javascript1/issues/2033)) ([639ca8a](https://github.com/applitools/eyes.sdk.javascript1/commit/639ca8a021008d06fc09d19ca58ac3d00a18e4c3))
+
+
+### Bug Fixes
+
+* error to unknown type in exception ([#2035](https://github.com/applitools/eyes.sdk.javascript1/issues/2035)) ([16d78c3](https://github.com/applitools/eyes.sdk.javascript1/commit/16d78c3cce90a5cb50cc2aa4e9ab6a58b7b93f89))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.6.3
+  #### Bug Fixes
+
+  * don't throw error for missing configuration file ([#2034](https://github.com/applitools/eyes.sdk.javascript1/issues/2034)) ([d084e7b](https://github.com/applitools/eyes.sdk.javascript1/commit/d084e7bf6e1727e3969622b4e597881f18241eb3))
+* @applitools/logger bumped to 2.0.13
+
+* @applitools/req bumped to 1.6.3
+
+* @applitools/image bumped to 1.1.8
+
+* @applitools/dom-snapshot bumped to 4.7.14
+  #### Bug Fixes
+
+  * preserve css declarations order in dom-snapshot ([#2037](https://github.com/applitools/eyes.sdk.javascript1/issues/2037)) ([1381851](https://github.com/applitools/eyes.sdk.javascript1/commit/1381851d46f28ea7e7724025c4eab33c81c4e144))
+* @applitools/spec-driver-webdriver bumped to 1.0.50
+  #### Bug Fixes
+
+  * send devtool commands in chromium ([#2039](https://github.com/applitools/eyes.sdk.javascript1/issues/2039)) ([ff42043](https://github.com/applitools/eyes.sdk.javascript1/commit/ff42043c3d9f110eb7b22ab1a8448d77859923b4))
+
+
+
+* @applitools/spec-driver-puppeteer bumped to 1.3.0
+  #### Features
+
+  * added notification about outdated sdk version ([#2012](https://github.com/applitools/eyes.sdk.javascript1/issues/2012)) ([0f0a646](https://github.com/applitools/eyes.sdk.javascript1/commit/0f0a6462a56e7c97f9a22173c3b63af91e220adb))
+
+
+
+* @applitools/core-base bumped to 1.7.3
+  #### Bug Fixes
+
+  * remove connection timeout in case of a long running tasks ([#2006](https://github.com/applitools/eyes.sdk.javascript1/issues/2006)) ([49a596a](https://github.com/applitools/eyes.sdk.javascript1/commit/49a596ac1b022a66b5c07ecfee458cc061891ce0))
+  * return result when error in the ufg ([#2020](https://github.com/applitools/eyes.sdk.javascript1/issues/2020)) ([28cdcc5](https://github.com/applitools/eyes.sdk.javascript1/commit/28cdcc5a859641d0edde032165c5068fcc580c8d))
+
+
+
+* @applitools/socket bumped to 1.1.13
+
+* @applitools/spec-driver-selenium bumped to 1.5.64
+
+* @applitools/driver bumped to 1.15.1
+
+* @applitools/screenshoter bumped to 3.8.16
+
+* @applitools/nml-client bumped to 1.5.16
+
+* @applitools/tunnel-client bumped to 1.3.1
+
+* @applitools/ufg-client bumped to 1.9.8
+
+* @applitools/ec-client bumped to 1.7.16
+
+* @applitools/core bumped to 4.2.0
+  #### Features
+
+  * added notification about outdated sdk version ([#2012](https://github.com/applitools/eyes.sdk.javascript1/issues/2012)) ([0f0a646](https://github.com/applitools/eyes.sdk.javascript1/commit/0f0a6462a56e7c97f9a22173c3b63af91e220adb))
+  * log driver environment info to splank ([#2023](https://github.com/applitools/eyes.sdk.javascript1/issues/2023)) ([11d0546](https://github.com/applitools/eyes.sdk.javascript1/commit/11d0546e76962b4c231e140b0229b8402da27f69))
+
+
+  #### Bug Fixes
+
+  * return result when error in the ufg ([#2020](https://github.com/applitools/eyes.sdk.javascript1/issues/2020)) ([28cdcc5](https://github.com/applitools/eyes.sdk.javascript1/commit/28cdcc5a859641d0edde032165c5068fcc580c8d))
+
+
+
+
+## [1.11.4](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes@1.11.3...js/eyes@1.11.4) (2023-11-07)
+
+
+### Bug Fixes
+
+* fixed issue when w3c properties were added to legacy capabilities object in `Eyes.setMobileCapabilities` method ([94d785f](https://github.com/applitools/eyes.sdk.javascript1/commit/94d785f0428df101c207d6f09a55c46f2bdbf19e))
+
+
+### Dependencies
+
+* @applitools/dom-shared bumped to 1.0.11
+  #### Bug Fixes
+
+  * (java/eyes-appium-java5): fix incorrect stitchMode mapping in checkSettings ([c70428e](https://github.com/applitools/eyes.sdk.javascript1/commit/c70428ec83e26b8b5e398ff11814f8376ca97d56))
+* @applitools/dom-capture bumped to 11.2.4
+  #### Bug Fixes
+
+  * (java/eyes-appium-java5): fix incorrect stitchMode mapping in checkSettings ([c70428e](https://github.com/applitools/eyes.sdk.javascript1/commit/c70428ec83e26b8b5e398ff11814f8376ca97d56))
+
+
+
+* @applitools/dom-snapshot bumped to 4.7.13
+  #### Bug Fixes
+
+  * (java/eyes-appium-java5): fix incorrect stitchMode mapping in checkSettings ([c70428e](https://github.com/applitools/eyes.sdk.javascript1/commit/c70428ec83e26b8b5e398ff11814f8376ca97d56))
+  * handled duplicated style properties in inline style tags ([#2014](https://github.com/applitools/eyes.sdk.javascript1/issues/2014)) ([2f8bada](https://github.com/applitools/eyes.sdk.javascript1/commit/2f8bada9cd44c65a69e54cbd08f57534632f12d2))
+
+
+
+* @applitools/driver bumped to 1.15.0
+  #### Features
+
+  * added warning when driver used with capabilities that may conflict with applitools lib workflow ([#2011](https://github.com/applitools/eyes.sdk.javascript1/issues/2011)) ([081006d](https://github.com/applitools/eyes.sdk.javascript1/commit/081006d879894db03a2713129b66586496b6eb02))
+* @applitools/screenshoter bumped to 3.8.15
+
+* @applitools/nml-client bumped to 1.5.15
+
+* @applitools/ufg-client bumped to 1.9.7
+  #### Bug Fixes
+
+  * added retries on ufg requests that respond with 503 status code ([7d78917](https://github.com/applitools/eyes.sdk.javascript1/commit/7d78917d559fa182c6723ca34cef2118cf08a036))
+* @applitools/spec-driver-webdriver bumped to 1.0.49
+
+* @applitools/spec-driver-selenium bumped to 1.5.63
+
+* @applitools/spec-driver-puppeteer bumped to 1.2.5
+
+* @applitools/ec-client bumped to 1.7.15
+
+* @applitools/core bumped to 4.1.0
+  #### Features
+
+  * added warning when driver used with capabilities that may conflict with applitools lib workflow ([#2011](https://github.com/applitools/eyes.sdk.javascript1/issues/2011)) ([081006d](https://github.com/applitools/eyes.sdk.javascript1/commit/081006d879894db03a2713129b66586496b6eb02))
+
+
+  #### Bug Fixes
+
+  * fixed issue that caused dom snapshots to be taken for different viewport sizes when layout breakpoints were explicitly turned off ([4121876](https://github.com/applitools/eyes.sdk.javascript1/commit/4121876189f133b6023cfea52ca91c02c31079fb))
+
+
+
+
 ## [1.11.3](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes@1.11.2...js/eyes@1.11.3) (2023-10-30)
 
 

package/dist/Eyes.js

@@ -75,9 +75,11 @@ class Eyes {
                 url.password = config.proxy.password;
             envs.APPLITOOLS_PROXY_URL = url.toString();
         }
+        const isW3C = Object.keys(capabilities).some(capability => capability.includes(':'));
+        const prefix = isW3C ? 'appium:' : '';
         return Object.assign(capabilities, {
-            'appium:optionalIntentArguments': `--es APPLITOOLS '${JSON.stringify(envs)}'`,
-            'appium:processArguments': JSON.stringify({
+            [`${prefix}optionalIntentArguments`]: `--es APPLITOOLS '${JSON.stringify(envs)}'`,
+            [`${prefix}processArguments`]: JSON.stringify({
                 args: [],
                 env: {
                     DYLD_INSERT_LIBRARIES: '@executable_path/Frameworks/Applitools_iOS.xcframework/ios-arm64/Applitools_iOS.framework/Applitools_iOS:@executable_path/Frameworks/Applitools_iOS.xcframework/ios-arm64_x86_64-simulator/Applitools_iOS.framework/Applitools_iOS',
@@ -373,35 +375,13 @@ class Eyes {
         }, Promise.resolve([]));
     }
     async close(throwErr = true) {
-        var _a;
         if (this._config.isDisabled)
             return null;
         if (!this.isOpen)
             throw new EyesError_1.EyesError('Eyes not open');
-        try {
-            const config = this._config.toJSON();
-            await this._eyes.close({ config });
-            const [result] = await this._eyes.getResults({ settings: { throwErr } });
-            return new TestResults_1.TestResultsData({ result, core: this._core });
-        }
-        catch (err) {
-            if ((_a = err.info) === null || _a === void 0 ? void 0 : _a.result) {
-                const result = new TestResults_1.TestResultsData({ result: err.info.result, core: this._core });
-                if (err.reason === 'test failed') {
-                    throw new TestFailedError_1.TestFailedError(err.message, result);
-                }
-                else if (err.reason === 'test different') {
-                    throw new DiffsFoundError_1.DiffsFoundError(err.message, result);
-                }
-                else if (err.reason === 'test new') {
-                    throw new NewTestError_1.NewTestError(err.message, result);
-                }
-            }
-            throw err;
-        }
-        finally {
-            this._eyes = undefined;
-        }
+        await this.closeAsync();
+        const [result] = await this.getResults(throwErr);
+        return result;
     }
     async closeAsync() {
         var _a;
@@ -432,6 +412,33 @@ class Eyes {
     async abortIfNotClosed() {
         return this.abort();
     }
+    async getResults(throwErr = false) {
+        var _a;
+        if (this._config.isDisabled)
+            return null;
+        try {
+            const results = await this._eyes.getResults({ settings: { throwErr } });
+            return results.map(result => new TestResults_1.TestResultsData({ result, core: this._core }));
+        }
+        catch (error) {
+            if ((_a = error.info) === null || _a === void 0 ? void 0 : _a.result) {
+                const result = new TestResults_1.TestResultsData({ result: error.info.result, core: this._core });
+                if (error.reason === 'test failed') {
+                    throw new TestFailedError_1.TestFailedError(error.message, result);
+                }
+                else if (error.reason === 'test different') {
+                    throw new DiffsFoundError_1.DiffsFoundError(error.message, result);
+                }
+                else if (error.reason === 'test new') {
+                    throw new NewTestError_1.NewTestError(error.message, result);
+                }
+            }
+            throw error;
+        }
+        finally {
+            this._eyes = undefined;
+        }
+    }
     // #region CONFIG
     async getViewportSize() {
         var _a;

package/dist/output/TestResultContainer.js

@@ -15,7 +15,10 @@ class TestResultContainerData {
         return this.testResults && new TestResults_1.TestResultsData({ result: this.testResults, core: this._core });
     }
     get exception() {
-        return this._container.error;
+        if (!this._container.error || this._container.error instanceof Error)
+            return this._container.error;
+        else
+            return new Error(String(this._container.error));
     }
     getException() {
         return this.exception;
@@ -29,9 +32,9 @@ class TestResultContainerData {
     /** @internal */
     toObject() {
         return {
-            testResults: this._container.result,
-            exception: this._container.error,
-            browserInfo: this._container.environment.requested,
+            testResults: this.testResults,
+            exception: this.exception,
+            browserInfo: this.browserInfo,
         };
     }
     /** @internal */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes",
-  "version": "1.11.3",
+  "version": "1.12.0",
   "keywords": [
     "applitools",
     "eyes",
@@ -45,12 +45,12 @@
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/core": "4.0.2",
-    "@applitools/logger": "2.0.12",
-    "@applitools/utils": "1.6.2"
+    "@applitools/core": "4.2.0",
+    "@applitools/logger": "2.0.13",
+    "@applitools/utils": "1.6.3"
   },
   "devDependencies": {
-    "@applitools/req": "^1.6.2",
+    "@applitools/req": "^1.6.3",
     "@types/node": "^12.20.55"
   },
   "engines": {

package/types/Eyes.d.ts

@@ -141,6 +141,7 @@ export declare class Eyes<TSpec extends Core.SpecType = Core.SpecType> {
     abortAsync(): Promise<void>;
     /** @deprecated */
     abortIfNotClosed(): Promise<TestResults>;
+    getResults(throwErr?: boolean): Promise<TestResultsData[]>;
     getViewportSize(): Promise<RectangleSizeData>;
     setViewportSize(size: RectangleSize): Promise<void>;
     getScrollRootElement(): TSpec['element'] | EyesSelector<TSpec['selector']>;

package/types/index.d.ts

@@ -22,6 +22,7 @@ export { NewTestError } from './errors/NewTestError';
 export { AccessibilityMatchSettings as AccessibilityMatchSettingsPlain, AccessibilityMatchSettingsData as AccessibilityMatchSettings, } from './input/AccessibilityMatchSettings';
 export { AccessibilitySettings } from './input/AccessibilitySettings';
 export { BatchInfo as BatchInfoPlain, BatchInfoData as BatchInfo } from './input/BatchInfo';
+export { Image } from './input/Image';
 export { CheckSettingsImage as CheckSettingsImagePlain, CheckSettingsImageFluent as CheckSettingsImage, CheckSettingsAutomation as CheckSettingsAutomationPlain, CheckSettingsAutomationFluent as CheckSettingsAutomation, TargetImage, TargetAutomation, Target, } from './input/CheckSettings';
 export { Configuration as ConfigurationPlain, ConfigurationData as Configuration } from './input/Configuration';
 export { CutProvider as CutProviderPlain, CutProviderData as CutProvider, FixedCutProviderData as FixedCutProvider, UnscaledFixedCutProviderData as UnscaledFixedCutProvider, } from './input/CutProvider';