@applitools/eyes-images 4.23.37 → 4.24.0

package/CHANGELOG.md

@@ -1,5 +1,158 @@
 # Changelog
 
+## [4.24.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-images@4.23.38...js/eyes-images@4.24.0) (2023-11-21)
+
+
+### 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))
+
+
+### 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/socket bumped to 1.1.13
+
+* @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/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))
+
+
+
+* @applitools/spec-driver-selenium bumped to 1.5.64
+
+* @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/screenshoter bumped to 3.8.16
+
+* @applitools/tunnel-client bumped to 1.3.1
+
+* @applitools/ec-client bumped to 1.7.16
+
+* @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/logger bumped to 2.0.13
+
+* @applitools/req bumped to 1.6.3
+
+* @applitools/image bumped to 1.1.8
+
+* @applitools/driver bumped to 1.15.1
+
+* @applitools/nml-client bumped to 1.5.16
+
+* @applitools/ufg-client bumped to 1.9.8
+
+* @applitools/eyes bumped to 1.12.0
+  #### 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))
+
+
+
+
+## [4.23.38](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-images@4.23.37...js/eyes-images@4.23.38) (2023-11-07)
+
+
+### 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/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/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/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/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))
+
+
+
+* @applitools/screenshoter bumped to 3.8.15
+
+* @applitools/nml-client bumped to 1.5.15
+
+* @applitools/ec-client bumped to 1.7.15
+
+* @applitools/eyes bumped to 1.11.4
+  #### 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))
+
+
+
+
 ## [4.23.37](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-images@4.23.36...js/eyes-images@4.23.37) (2023-10-30)
 
 

package/dist/api.js

@@ -27,9 +27,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.closeBatch = exports.BatchClose = exports.Target = exports.CheckSettings = exports.CheckSettingsImage = exports.CheckSettingsAutomation = exports.Configuration = exports.Eyes = void 0;
+const extract_environment_1 = require("./extract-environment");
 const eyes = __importStar(require("@applitools/eyes"));
 __exportStar(require("@applitools/eyes"), exports);
-const sdk = { agentId: `eyes.images.javascript/${require('../package.json').version}` };
+const sdk = {
+    agentId: `eyes.images.javascript/${require('../package.json').version}`,
+    environment: (0, extract_environment_1.extractEnvironment)(),
+};
 class Eyes extends eyes.Eyes {
 }
 exports.Eyes = Eyes;

package/dist/extract-environment.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractEnvironment = void 0;
+function extractEnvironment() {
+    let sdk = undefined;
+    try {
+        const { name, version } = require('../package.json');
+        sdk = { lang: 'js', name, currentVersion: version };
+    }
+    catch {
+        // NOTE: ignore error
+    }
+    return { sdk };
+}
+exports.extractEnvironment = extractEnvironment;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-images",
-  "version": "4.23.37",
+  "version": "4.24.0",
   "description": "The simplest implementation of Applitools Eyes SDK, uploads images for validation",
   "keywords": [
     "eyes-images",
@@ -40,12 +40,12 @@
     "test:coverage": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(uuidgen).log\" APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-images' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage run --top-level mocha './test/generated-coverage/*.spec.js' --parallel --jobs ${MOCHA_JOBS:-15}"
   },
   "dependencies": {
-    "@applitools/eyes": "1.11.3"
+    "@applitools/eyes": "1.12.0"
   },
   "devDependencies": {
     "@applitools/api-extractor": "^1.2.22",
-    "@applitools/bongo": "^5.7.0",
-    "@applitools/generic": "^3.5.0",
+    "@applitools/bongo": "^5.7.6",
+    "@applitools/generic": "^3.5.2",
     "@applitools/test-utils": "^1.5.17",
     "@types/node": "^12.20.55"
   },

package/types/index.d.ts

@@ -35,14 +35,7 @@ export class Eyes {
     open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | SessionTypePlain): Promise<void>;
     check(name: string, checkSettings: CheckSettingsAutomation): Promise<MatchResult>;
     check(name: string, checkSettings: CheckSettingsImage): Promise<MatchResult>;
-    check(target: {
-        image: string | Buffer | URL;
-        name?: undefined | string;
-        dom?: undefined | string;
-        locationInViewport?: undefined | LocationPlain;
-        locationInView?: undefined | LocationPlain;
-        fullViewSize?: undefined | RectangleSizePlain;
-    }, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
+    check(target: Image, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
     check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
     checkWindow(name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
     checkFrame(element: number, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
@@ -100,6 +93,7 @@ export class Eyes {
     abort(): Promise<TestResults>;
     abortAsync(): Promise<void>;
     abortIfNotClosed(): Promise<TestResultsPlain>;
+    getResults(throwErr?: undefined | boolean): Promise<Array<TestResults>>;
     getViewportSize(): Promise<RectangleSize>;
     setViewportSize(size: RectangleSizePlain): Promise<void>;
     getScrollRootElement(): EyesSelector<never>;
@@ -628,22 +622,8 @@ export class CheckSettingsAutomation {
     variationGroupId(variationGroupId: string): CheckSettingsAutomation;
 }
 export class CheckSettingsImage {
-    constructor(settings?: undefined | CheckSettingsImage, target?: undefined | {
-        image: string | Buffer | URL;
-        name?: undefined | string;
-        dom?: undefined | string;
-        locationInViewport?: undefined | LocationPlain;
-        locationInView?: undefined | LocationPlain;
-        fullViewSize?: undefined | RectangleSizePlain;
-    });
-    constructor(settings?: undefined | CheckSettingsImagePlain, target?: undefined | {
-        image: string | Buffer | URL;
-        name?: undefined | string;
-        dom?: undefined | string;
-        locationInViewport?: undefined | LocationPlain;
-        locationInView?: undefined | LocationPlain;
-        fullViewSize?: undefined | RectangleSizePlain;
-    });
+    constructor(settings?: undefined | CheckSettingsImage, target?: undefined | Image);
+    constructor(settings?: undefined | CheckSettingsImagePlain, target?: undefined | Image);
     image(image: string): CheckSettingsImage;
     image(image: Buffer): CheckSettingsImage;
     image(image: URL): CheckSettingsImage;
@@ -1122,6 +1102,14 @@ export class BatchInfo implements Required<BatchInfoPlain> {
     addProperty(name: string, value: string): BatchInfo;
     addProperty(prop: PropertyDataPlain): BatchInfo;
 }
+export type Image = {
+    image: string | Buffer | URL;
+    name?: undefined | string;
+    dom?: undefined | string;
+    locationInViewport?: undefined | LocationPlain;
+    locationInView?: undefined | LocationPlain;
+    fullViewSize?: undefined | RectangleSizePlain;
+};
 export type CheckSettingsImagePlain = {
     name?: undefined | string;
     region?: undefined | RegionPlain;