@applitools/eyes 1.32.7 → 1.33.1

package/CHANGELOG.md

@@ -1,5 +1,110 @@
 # Changelog
 
+## [1.33.1](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.33.0...js/eyes@1.33.1) (2025-03-31)
+
+
+### Dependencies
+
+* @applitools/nml-client bumped to 1.9.0
+  #### Features
+
+  * add accessibility field to screenshot ([#2815](https://github.com/Applitools-Dev/sdk/issues/2815)) ([3d111f3](https://github.com/Applitools-Dev/sdk/commit/3d111f354c5eedeb8914f18318ccecce5fd13002))
+* @applitools/core-base bumped to 1.23.0
+  #### Features
+
+  * add accessibility field to screenshot ([#2815](https://github.com/Applitools-Dev/sdk/issues/2815)) ([3d111f3](https://github.com/Applitools-Dev/sdk/commit/3d111f354c5eedeb8914f18318ccecce5fd13002))
+* @applitools/ec-client bumped to 1.10.8
+
+* @applitools/core bumped to 4.35.0
+  #### Features
+
+  * add accessibility field to screenshot ([#2815](https://github.com/Applitools-Dev/sdk/issues/2815)) ([3d111f3](https://github.com/Applitools-Dev/sdk/commit/3d111f354c5eedeb8914f18318ccecce5fd13002))
+
+
+
+
+## [1.33.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.32.7...js/eyes@1.33.0) (2025-03-30)
+
+
+### Features
+
+* allow fully to be sent from the configuration object ([#2867](https://github.com/Applitools-Dev/sdk/issues/2867)) ([e8e7fbc](https://github.com/Applitools-Dev/sdk/commit/e8e7fbcb545e9bab899691d8d136b69f4a67e0d8))
+* allow sending callback functions to waitBeforeCapture ([#2780](https://github.com/Applitools-Dev/sdk/issues/2780)) ([4caa2e8](https://github.com/Applitools-Dev/sdk/commit/4caa2e8ae055d3dd48164eeceaa4c691eeadcdd4))
+* offline results state granularity ([#2872](https://github.com/Applitools-Dev/sdk/issues/2872)) ([c5f6e4e](https://github.com/Applitools-Dev/sdk/commit/c5f6e4ed87c4855704ce1a6c568393a35b677c1d))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.8.0
+  #### Features
+
+  * allow sending callback functions to waitBeforeCapture ([#2780](https://github.com/Applitools-Dev/sdk/issues/2780)) ([4caa2e8](https://github.com/Applitools-Dev/sdk/commit/4caa2e8ae055d3dd48164eeceaa4c691eeadcdd4))
+* @applitools/logger bumped to 2.1.2
+
+* @applitools/dom-snapshot bumped to 4.11.17
+  #### Bug Fixes
+
+  * input range value render issue - add input range to need map list ([#2866](https://github.com/Applitools-Dev/sdk/issues/2866)) ([6b3c113](https://github.com/Applitools-Dev/sdk/commit/6b3c113ab3068fc89b3d3917a12fc51bad66ca97))
+
+
+
+* @applitools/core-base bumped to 1.22.3
+  #### Bug Fixes
+
+  * reject openCheckAndClose on request failures ([#2870](https://github.com/Applitools-Dev/sdk/issues/2870)) ([1d12d60](https://github.com/Applitools-Dev/sdk/commit/1d12d60991e8f222002273d5447702158f1cba84))
+
+
+
+* @applitools/req bumped to 1.7.9
+
+* @applitools/image bumped to 1.1.18
+
+* @applitools/driver bumped to 1.21.0
+  #### Features
+
+  * allow sending callback functions to waitBeforeCapture ([#2780](https://github.com/Applitools-Dev/sdk/issues/2780)) ([4caa2e8](https://github.com/Applitools-Dev/sdk/commit/4caa2e8ae055d3dd48164eeceaa4c691eeadcdd4))
+
+
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.26
+
+* @applitools/screenshoter bumped to 3.11.0
+  #### Features
+
+  * allow sending callback functions to waitBeforeCapture ([#2780](https://github.com/Applitools-Dev/sdk/issues/2780)) ([4caa2e8](https://github.com/Applitools-Dev/sdk/commit/4caa2e8ae055d3dd48164eeceaa4c691eeadcdd4))
+
+
+
+* @applitools/socket bumped to 1.2.3
+
+* @applitools/dom-capture bumped to 11.5.5
+
+* @applitools/spec-driver-webdriver bumped to 1.2.1
+
+* @applitools/spec-driver-selenium bumped to 1.5.97
+
+* @applitools/nml-client bumped to 1.8.27
+
+* @applitools/tunnel-client bumped to 1.6.4
+
+* @applitools/ufg-client bumped to 1.16.8
+
+* @applitools/ec-client bumped to 1.10.7
+
+* @applitools/core bumped to 4.34.0
+  #### Features
+
+  * allow sending callback functions to waitBeforeCapture ([#2780](https://github.com/Applitools-Dev/sdk/issues/2780)) ([4caa2e8](https://github.com/Applitools-Dev/sdk/commit/4caa2e8ae055d3dd48164eeceaa4c691eeadcdd4))
+  * offline results state granularity ([#2872](https://github.com/Applitools-Dev/sdk/issues/2872)) ([c5f6e4e](https://github.com/Applitools-Dev/sdk/commit/c5f6e4ed87c4855704ce1a6c568393a35b677c1d))
+
+
+  #### Bug Fixes
+
+  * reject openCheckAndClose on request failures ([#2870](https://github.com/Applitools-Dev/sdk/issues/2870)) ([1d12d60](https://github.com/Applitools-Dev/sdk/commit/1d12d60991e8f222002273d5447702158f1cba84))
+
+
+
+
 ## [1.32.7](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.32.6...js/eyes@1.32.7) (2025-03-13)
 
 

package/dist/cli/cli.js

@@ -21,10 +21,15 @@ void yargs_1.default
                 type: 'string',
             },
             failOnDiff: {
-                description: 'should exit process with non-zero exit code, thereby failing the CI job',
+                description: 'should exit process with non-zero exit code on visual diffs, thereby failing the CI job',
                 type: 'boolean',
                 default: false,
             },
+            failOnError: {
+                description: 'should exit process with non-zero exit code on errors, thereby failing the CI job',
+                type: 'boolean',
+                default: true,
+            },
             configPath: {
                 description: 'path to configuration file (applitools.config.js / applitools.config.ts)',
                 type: 'string',

package/dist/input/Configuration.js

@@ -1017,7 +1017,12 @@ class ConfigurationData {
         return this._config.waitBeforeCapture;
     }
     set waitBeforeCapture(waitBeforeCapture) {
-        utils.guard.isInteger(waitBeforeCapture, { name: 'waitBeforeCapture', gt: 0 });
+        if (utils.types.isNumber(waitBeforeCapture)) {
+            utils.guard.isInteger(waitBeforeCapture, { name: 'waitBeforeCapture', gt: 0 });
+        }
+        else {
+            utils.guard.isFunction(waitBeforeCapture, { name: 'waitBeforeCapture' });
+        }
         this._config.waitBeforeCapture = waitBeforeCapture;
     }
     getWaitBeforeCapture() {
@@ -1041,13 +1046,27 @@ class ConfigurationData {
         this.waitBeforeScreenshots = waitBeforeScreenshots;
         return this;
     }
+    get fully() {
+        return this._config.fully;
+    }
+    set fully(fully) {
+        utils.guard.isBoolean(fully, { name: 'fully' });
+        this._config.fully = fully;
+    }
+    getFully() {
+        return this.fully;
+    }
+    setFully(fully) {
+        this.fully = fully;
+        return this;
+    }
     /** @internal */
     toObject() {
         return this._config;
     }
     /** @internal */
     toJSON() {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
         return utils.general.toJSON({
             open: utils.general.removeUndefinedProps({
                 eyesServerUrl: this.serverUrl,
@@ -1088,7 +1107,7 @@ class ConfigurationData {
                 disableBrokerUrlCache: this.disableNMLUrlCache,
             }),
             screenshot: utils.general.removeUndefinedProps({
-                fully: this.forceFullPageScreenshot,
+                fully: (_a = this.fully) !== null && _a !== void 0 ? _a : this.forceFullPageScreenshot,
                 scrollRootElement: this.scrollRootElement,
                 stitchMode: this.stitchMode,
                 hideScrollbars: this.hideScrollbars,
@@ -1101,14 +1120,14 @@ class ConfigurationData {
                     rotation: this.rotation,
                     scaleRatio: this.scaleRatio,
                 }),
-                debugImages: ((_a = this.debugScreenshots) === null || _a === void 0 ? void 0 : _a.save) && utils.types.has(this.debugScreenshots, 'path')
+                debugImages: ((_b = this.debugScreenshots) === null || _b === void 0 ? void 0 : _b.save) && utils.types.has(this.debugScreenshots, 'path')
                     ? this.debugScreenshots
                     : undefined,
                 captureStatusBar: this.captureStatusBar,
                 mobileOptions: this.mobileOptions,
             }),
             check: utils.general.removeUndefinedProps({
-                environments: (_b = this.browsersInfo) === null || _b === void 0 ? void 0 : _b.map(browserInfo => {
+                environments: (_c = this.browsersInfo) === null || _c === void 0 ? void 0 : _c.map(browserInfo => {
                     if (utils.types.has(browserInfo, 'iosDeviceInfo') &&
                         utils.types.has(browserInfo.iosDeviceInfo, 'iosVersion')) {
                         const { iosVersion, ...iosDeviceInfo } = browserInfo.iosDeviceInfo;
@@ -1120,27 +1139,27 @@ class ConfigurationData {
                 layoutBreakpoints: utils.types.isDefined(this.layoutBreakpoints)
                     ? utils.types.has(this.layoutBreakpoints, 'breakpoints')
                         ? this.layoutBreakpoints
-                        : { breakpoints: (_c = this.layoutBreakpoints) !== null && _c !== void 0 ? _c : false }
+                        : { breakpoints: (_d = this.layoutBreakpoints) !== null && _d !== void 0 ? _d : false }
                     : undefined,
                 disableBrowserFetching: this.disableBrowserFetching,
                 autProxy: this.autProxy,
                 sendDom: this.sendDom,
                 retryTimeout: this.matchTimeout,
-                matchLevel: (_d = this.defaultMatchSettings) === null || _d === void 0 ? void 0 : _d.matchLevel,
-                ignoreCaret: (_e = this.defaultMatchSettings) === null || _e === void 0 ? void 0 : _e.ignoreCaret,
-                ignoreDisplacements: (_f = this.defaultMatchSettings) === null || _f === void 0 ? void 0 : _f.ignoreDisplacements,
-                enablePatterns: (_g = this.defaultMatchSettings) === null || _g === void 0 ? void 0 : _g.enablePatterns,
-                accessibilitySettings: ((_h = this.defaultMatchSettings) === null || _h === void 0 ? void 0 : _h.accessibilitySettings) && {
+                matchLevel: (_e = this.defaultMatchSettings) === null || _e === void 0 ? void 0 : _e.matchLevel,
+                ignoreCaret: (_f = this.defaultMatchSettings) === null || _f === void 0 ? void 0 : _f.ignoreCaret,
+                ignoreDisplacements: (_g = this.defaultMatchSettings) === null || _g === void 0 ? void 0 : _g.ignoreDisplacements,
+                enablePatterns: (_h = this.defaultMatchSettings) === null || _h === void 0 ? void 0 : _h.enablePatterns,
+                accessibilitySettings: ((_j = this.defaultMatchSettings) === null || _j === void 0 ? void 0 : _j.accessibilitySettings) && {
                     level: this.defaultMatchSettings.accessibilitySettings.level,
                     version: this.defaultMatchSettings.accessibilitySettings.guidelinesVersion,
                 },
-                useDom: (_j = this.defaultMatchSettings) === null || _j === void 0 ? void 0 : _j.useDom,
-                ignoreRegions: (_k = this.defaultMatchSettings) === null || _k === void 0 ? void 0 : _k.ignoreRegions,
-                contentRegions: (_l = this.defaultMatchSettings) === null || _l === void 0 ? void 0 : _l.contentRegions,
-                layoutRegions: (_m = this.defaultMatchSettings) === null || _m === void 0 ? void 0 : _m.layoutRegions,
-                strictRegions: (_o = this.defaultMatchSettings) === null || _o === void 0 ? void 0 : _o.strictRegions,
-                floatingRegions: (_p = this.defaultMatchSettings) === null || _p === void 0 ? void 0 : _p.floatingRegions,
-                accessibilityRegions: (_q = this.defaultMatchSettings) === null || _q === void 0 ? void 0 : _q.accessibilityRegions,
+                useDom: (_k = this.defaultMatchSettings) === null || _k === void 0 ? void 0 : _k.useDom,
+                ignoreRegions: (_l = this.defaultMatchSettings) === null || _l === void 0 ? void 0 : _l.ignoreRegions,
+                contentRegions: (_m = this.defaultMatchSettings) === null || _m === void 0 ? void 0 : _m.contentRegions,
+                layoutRegions: (_o = this.defaultMatchSettings) === null || _o === void 0 ? void 0 : _o.layoutRegions,
+                strictRegions: (_p = this.defaultMatchSettings) === null || _p === void 0 ? void 0 : _p.strictRegions,
+                floatingRegions: (_q = this.defaultMatchSettings) === null || _q === void 0 ? void 0 : _q.floatingRegions,
+                accessibilityRegions: (_r = this.defaultMatchSettings) === null || _r === void 0 ? void 0 : _r.accessibilityRegions,
             }),
             close: utils.general.removeUndefinedProps({
                 updateBaselineIfDifferent: this.saveFailedTests,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes",
-  "version": "1.32.7",
+  "version": "1.33.1",
   "keywords": [
     "applitools",
     "eyes",
@@ -46,13 +46,13 @@
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/core": "4.33.0",
-    "@applitools/logger": "2.1.1",
-    "@applitools/utils": "1.7.8",
+    "@applitools/core": "4.35.0",
+    "@applitools/logger": "2.1.2",
+    "@applitools/utils": "1.8.0",
     "chalk": "4.1.2"
   },
   "devDependencies": {
-    "@applitools/req": "^1.7.8",
+    "@applitools/req": "^1.7.9",
     "@types/node": "^12.20.55"
   },
   "engines": {

package/types/input/CheckSettings.d.ts

@@ -100,7 +100,7 @@ export type CheckSettingsAutomation<TSpec extends Core.SpecType> = CheckSettings
         beforeCaptureScreenshot: string;
     };
     timeout?: number;
-    waitBeforeCapture?: number;
+    waitBeforeCapture?: number | (() => Promise<void>);
     lazyLoad?: boolean | LazyLoadOptions;
 };
 export declare class CheckSettingsBaseFluent<TRegion = never> {
@@ -232,7 +232,7 @@ export declare class CheckSettingsAutomationFluent<TSpec extends Core.SpecType =
     }): this;
     useSystemScreenshot(useSystemScreenshot?: boolean): this;
     timeout(timeout: number): typeof this;
-    waitBeforeCapture(waitBeforeCapture: number): typeof this;
+    waitBeforeCapture(waitBeforeCapture: number | (() => Promise<void>)): typeof this;
     lazyLoad(options?: LazyLoadOptions | boolean): typeof this;
     densityMetrics(options: DensityMetrics): typeof this;
     stitchMode(stitchMode: StitchMode): typeof this;

package/types/input/Configuration.d.ts

@@ -48,7 +48,9 @@ export type Configuration<TSpec extends Core.SpecType = Core.SpecType> = {
     dontCloseBatches?: boolean;
     enablePatterns?: boolean;
     environmentName?: string;
+    /** @deprecated use fully instead */
     forceFullPageScreenshot?: boolean;
+    fully?: boolean;
     gitMergeBaseTimestamp?: string;
     latestCommitInfo?: LatestCommitInfo;
     hideCaret?: boolean;
@@ -91,7 +93,7 @@ export type Configuration<TSpec extends Core.SpecType = Core.SpecType> = {
     useDom?: boolean;
     viewportSize?: RectangleSize;
     visualGridOptions?: Record<string, any>;
-    waitBeforeCapture?: number;
+    waitBeforeCapture?: number | (() => Promise<void>);
     waitBeforeScreenshots?: number;
 };
 export declare class ConfigurationData<TSpec extends Core.SpecType = Core.SpecType> implements Required<Configuration<TSpec>> {
@@ -414,14 +416,18 @@ export declare class ConfigurationData<TSpec extends Core.SpecType = Core.SpecTy
         [key: string]: any;
     }): this;
     setVisualGridOption(key: string, value: any): this;
-    get waitBeforeCapture(): number;
-    set waitBeforeCapture(waitBeforeCapture: number);
-    getWaitBeforeCapture(): number;
-    setWaitBeforeCapture(waitBeforeCapture: number): this;
+    get waitBeforeCapture(): number | (() => Promise<void>);
+    set waitBeforeCapture(waitBeforeCapture: number | (() => Promise<void>));
+    getWaitBeforeCapture(): number | (() => Promise<void>);
+    setWaitBeforeCapture(waitBeforeCapture: number | (() => Promise<void>)): this;
     get waitBeforeScreenshots(): number;
     set waitBeforeScreenshots(waitBeforeScreenshots: number);
     getWaitBeforeScreenshots(): number;
     setWaitBeforeScreenshots(waitBeforeScreenshots: number): this;
+    get fully(): boolean;
+    set fully(fully: boolean);
+    getFully(): boolean;
+    setFully(fully: boolean): this;
     /** @internal */
     toObject(): Configuration<TSpec>;
     /** @internal */