@applitools/core 4.52.0 → 4.53.0

package/CHANGELOG.md

@@ -1,5 +1,77 @@
 # Changelog
 
+## [4.53.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.52.0...js/core@4.53.0) (2025-11-19)
+
+
+### Features
+
+* disable heartbeats whenever no tests are running ([#3344](https://github.com/Applitools-Dev/sdk/issues/3344)) ([b66d28a](https://github.com/Applitools-Dev/sdk/commit/b66d28a7a382f26b68de70c8633c027cb4bdf225))
+
+
+### Bug Fixes
+
+* better nml error messages ([#3311](https://github.com/Applitools-Dev/sdk/issues/3311)) ([3deea01](https://github.com/Applitools-Dev/sdk/commit/3deea0130636c44573adc919b95c1c99e6d194f1))
+* fails to create test with coded dynamic region | AD-11074 ([#3361](https://github.com/Applitools-Dev/sdk/issues/3361)) ([7f8c8cd](https://github.com/Applitools-Dev/sdk/commit/7f8c8cd85c0cd2e5861cd33fbc29c465903258d5))
+* resolved an issue with `matchTimeout` changing `retryTimeout` ([f656f59](https://github.com/Applitools-Dev/sdk/commit/f656f59dbfb7c41fdb569fbc56d2e9daecefb854))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.14.0
+  #### Features
+
+  * disable heartbeats whenever no tests are running ([#3344](https://github.com/Applitools-Dev/sdk/issues/3344)) ([b66d28a](https://github.com/Applitools-Dev/sdk/commit/b66d28a7a382f26b68de70c8633c027cb4bdf225))
+* @applitools/nml-client bumped to 1.11.11
+  #### Bug Fixes
+
+  * better nml error messages ([#3311](https://github.com/Applitools-Dev/sdk/issues/3311)) ([3deea01](https://github.com/Applitools-Dev/sdk/commit/3deea0130636c44573adc919b95c1c99e6d194f1))
+
+
+
+* @applitools/logger bumped to 2.2.6
+
+* @applitools/dom-snapshot bumped to 4.15.1
+
+* @applitools/socket bumped to 1.3.7
+
+* @applitools/req bumped to 1.8.6
+
+* @applitools/image bumped to 1.2.5
+
+* @applitools/dom-capture bumped to 11.6.7
+
+* @applitools/driver bumped to 1.24.2
+
+* @applitools/spec-driver-webdriver bumped to 1.5.2
+
+* @applitools/spec-driver-selenium bumped to 1.7.8
+
+* @applitools/spec-driver-puppeteer bumped to 1.6.8
+
+* @applitools/screenshoter bumped to 3.12.9
+
+* @applitools/tunnel-client bumped to 1.11.4
+
+* @applitools/ufg-client bumped to 1.18.2
+
+* @applitools/core-base bumped to 1.30.0
+  #### Features
+
+  * disable heartbeats whenever no tests are running ([#3344](https://github.com/Applitools-Dev/sdk/issues/3344)) ([b66d28a](https://github.com/Applitools-Dev/sdk/commit/b66d28a7a382f26b68de70c8633c027cb4bdf225))
+
+
+  #### Bug Fixes
+
+  * fails to create test with coded dynamic region | AD-11074 ([#3361](https://github.com/Applitools-Dev/sdk/issues/3361)) ([7f8c8cd](https://github.com/Applitools-Dev/sdk/commit/7f8c8cd85c0cd2e5861cd33fbc29c465903258d5))
+  * resolved an issue with `matchTimeout` changing `retryTimeout` ([f656f59](https://github.com/Applitools-Dev/sdk/commit/f656f59dbfb7c41fdb569fbc56d2e9daecefb854))
+
+
+
+* @applitools/ec-client bumped to 1.12.13
+
+* @applitools/test-server bumped to 1.3.5
+
+
 ## [4.52.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.51.0...js/core@4.52.0) (2025-11-09)
 
 

package/dist/check.js

@@ -56,7 +56,7 @@ function makeCheck({ type: defaultType = 'classic', eyes, target: defaultTarget,
             !utils.types.isEmpty(settings.accessibilitySettings));
         (_h = settings.autProxy) !== null && _h !== void 0 ? _h : (settings.autProxy = eyes.test.eyesServer.proxy);
         (_j = settings.useDom) !== null && _j !== void 0 ? _j : (settings.useDom = false);
-        (_k = (_r = settings).retryTimeout) !== null && _k !== void 0 ? _k : (_r.retryTimeout = 0);
+        (_k = (_r = settings).matchTimeout) !== null && _k !== void 0 ? _k : (_r.matchTimeout = 0);
         settings.lazyLoad = settings.lazyLoad === true ? {} : settings.lazyLoad;
         if (settings.lazyLoad) {
             (_l = (_s = settings.lazyLoad).scrollLength) !== null && _l !== void 0 ? _l : (_s.scrollLength = defaults_1.DEFAULT_LAZY_LOAD.scrollLength);

package/dist/classic/check.js

@@ -55,16 +55,16 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
         let driver = undefined;
         if ((0, driver_1.isDriver)(target, spec)) {
             driver = await (0, driver_1.makeDriver)({ spec, driver: target, reset: target === defaultTarget, logger });
-            if (settings.retryTimeout) {
-                // when retry timeout is set, retry checking until it passes or timeout is reached. This will stall the client test execution until it passes or timeout is reached to prevent the test from continuing and changing the state of the app
-                logger.log(`Retry timeout is set to ${settings.retryTimeout}ms - will retry checking until it passes or timeout is reached`);
+            if (settings.matchTimeout) {
+                // when match timeout is set, retry checking until it passes or timeout is reached. This will stall the client test execution until it passes or timeout is reached to prevent the test from continuing and changing the state of the app
+                logger.log(`Match timeout is set to ${settings.matchTimeout}ms - will retry checking until it passes or timeout is reached`);
                 const start = Date.now();
                 const environmentLogger = logger.extend({ tags: [`environment-${utils.general.shortid()}`] });
                 // this getter actually open the eyes session if it's not already open
                 const baseEyes = await Promise.all(uniqueEnvironments.map(environment => getBaseEyes({ environment, driver, logger: environmentLogger })));
                 // if the test is new for any of the environments, we wait for the page to stabaliize before starting the checks. This should prevent us from creating a baseline with a loading spinner or something similar
                 if (baseEyes.map(baseEye => baseEye.test.isNew).some(isNew => isNew)) {
-                    await new Promise(resolve => setTimeout(resolve, settings.retryTimeout));
+                    await new Promise(resolve => setTimeout(resolve, settings.matchTimeout));
                 }
                 let asExpected = false, retries = 0;
                 do {
@@ -93,12 +93,12 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                             putInStorage(exactEnvironment, eyes, Promise.resolve());
                         });
                     }
-                } while (!asExpected && Date.now() - start < settings.retryTimeout);
+                } while (!asExpected && Date.now() - start < settings.matchTimeout);
             }
             else {
                 // generate base targets (images to be compared) and settings for each environment
                 const baseScreenshotsAndSettings = await generateBaseScreenshotsAndSettings(settings, uniqueEnvironments, eyes, logger, driver);
-                // when no retry timeout is set, queue all environment checks against the server without stalling the client test execution
+                // when no match timeout is set, queue all environment checks against the server without stalling the client test execution
                 baseScreenshotsAndSettings.forEach(({ exactEnvironment: environment, baseSetting, baseTarget }) => {
                     checkInTheBackground(environment, baseTarget, baseSetting);
                 });

package/dist/offline/run-offline-snapshots.js

@@ -339,8 +339,11 @@ async function runOfflineSnapshots(options) {
             logger: checkLogger,
             heartbeat: {
                 processId: '',
-                startPeriodicHeartbeatMessaging(settings) {
-                    logger.log('heartbeat is not used (offline)', settings);
+                acquire(settings) {
+                    logger.log('acquire | heartbeat is not used (offline)', settings);
+                },
+                release() {
+                    logger.log('release | heartbeat is not used (offline)');
                 },
             },
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.52.0",
+  "version": "4.53.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -79,20 +79,20 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.29.0",
-    "@applitools/dom-capture": "11.6.6",
-    "@applitools/dom-snapshot": "4.15.0",
-    "@applitools/driver": "1.24.1",
-    "@applitools/ec-client": "1.12.12",
-    "@applitools/logger": "2.2.5",
-    "@applitools/nml-client": "1.11.10",
-    "@applitools/req": "1.8.5",
-    "@applitools/screenshoter": "3.12.8",
+    "@applitools/core-base": "1.30.0",
+    "@applitools/dom-capture": "11.6.7",
+    "@applitools/dom-snapshot": "4.15.1",
+    "@applitools/driver": "1.24.2",
+    "@applitools/ec-client": "1.12.13",
+    "@applitools/logger": "2.2.6",
+    "@applitools/nml-client": "1.11.11",
+    "@applitools/req": "1.8.6",
+    "@applitools/screenshoter": "3.12.9",
     "@applitools/snippets": "2.7.0",
-    "@applitools/socket": "1.3.6",
-    "@applitools/spec-driver-webdriver": "1.5.1",
-    "@applitools/ufg-client": "1.18.1",
-    "@applitools/utils": "1.13.0",
+    "@applitools/socket": "1.3.7",
+    "@applitools/spec-driver-webdriver": "1.5.2",
+    "@applitools/ufg-client": "1.18.2",
+    "@applitools/utils": "1.14.0",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",
     "chalk": "4.1.2",
@@ -106,11 +106,11 @@
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.6.7",
-    "@applitools/spec-driver-selenium": "^1.7.7",
-    "@applitools/test-server": "^1.3.4",
+    "@applitools/spec-driver-puppeteer": "^1.6.8",
+    "@applitools/spec-driver-selenium": "^1.7.8",
+    "@applitools/test-server": "^1.3.5",
     "@applitools/test-utils": "^1.5.17",
-    "@applitools/tunnel-client": "^1.11.3",
+    "@applitools/tunnel-client": "^1.11.4",
     "@types/mocha": "^10.0.7",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",

package/types/classic/check-and-close.d.ts

@@ -17,7 +17,7 @@ export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target
     settings?: (BaseCheckSettings<utils.Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
         environments?: Environment[] | undefined;
     } & {
-        retryTimeout?: number | undefined;
+        matchTimeout?: number | undefined;
     } & BaseCloseSettings & {
         environments?: Environment[] | undefined;
     }) | undefined;

package/types/classic/types.d.ts

@@ -30,5 +30,5 @@ export type OpenSettings = AutomationCore.OpenSettings & {
     keepPlatformNameAsIs?: boolean;
 };
 export type CheckSettings<TSpec extends SpecType> = AutomationCore.CheckSettings<TSpec> & {
-    retryTimeout?: number;
+    matchTimeout?: number;
 };