@applitools/core 4.23.0 → 4.24.0

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # Changelog
 
+## [4.24.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.23.1...js/core@4.24.0) (2024-11-12)
+
+
+### Features
+
+* add an option to keep the navigation bar for android devices ([#2608](https://github.com/Applitools-Dev/sdk/issues/2608)) ([e7647e0](https://github.com/Applitools-Dev/sdk/commit/e7647e0105a7aa47e6bf3b20ab033f1e389ca849))
+
+
+### Dependencies
+
+* @applitools/driver bumped to 1.20.0
+  #### Features
+
+  * add an option to keep the navigation bar for android devices ([#2608](https://github.com/Applitools-Dev/sdk/issues/2608)) ([e7647e0](https://github.com/Applitools-Dev/sdk/commit/e7647e0105a7aa47e6bf3b20ab033f1e389ca849))
+* @applitools/screenshoter bumped to 3.10.0
+  #### Features
+
+  * add an option to keep the navigation bar for android devices ([#2608](https://github.com/Applitools-Dev/sdk/issues/2608)) ([e7647e0](https://github.com/Applitools-Dev/sdk/commit/e7647e0105a7aa47e6bf3b20ab033f1e389ca849))
+
+
+
+* @applitools/dom-snapshot bumped to 4.11.9
+
+* @applitools/spec-driver-webdriver bumped to 1.1.20
+
+* @applitools/spec-driver-selenium bumped to 1.5.91
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.20
+
+* @applitools/nml-client bumped to 1.8.18
+
+* @applitools/ec-client bumped to 1.9.14
+
+
+## [4.23.1](https://github.com/Applitools-Dev/sdk/compare/js/core@4.23.0...js/core@4.23.1) (2024-11-09)
+
+
+### Bug Fixes
+
+* overcome dom snapshot's failure to download resource from browser ([#2610](https://github.com/Applitools-Dev/sdk/issues/2610)) ([47d46fb](https://github.com/Applitools-Dev/sdk/commit/47d46fbe3baab12d5153f6617ab60142a8a215cf))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.8
+  #### Bug Fixes
+
+  * overcome dom snapshot's failure to download resource from browser ([#2610](https://github.com/Applitools-Dev/sdk/issues/2610)) ([47d46fb](https://github.com/Applitools-Dev/sdk/commit/47d46fbe3baab12d5153f6617ab60142a8a215cf))
+
 ## [4.23.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.22.1...js/core@4.23.0) (2024-11-07)
 
 

package/dist/automation/utils/take-screenshot.js

@@ -27,7 +27,7 @@ exports.takeScreenshot = void 0;
 const utils = __importStar(require("@applitools/utils"));
 const { takeScreenshot: legacyTakeScreenshot } = require('@applitools/screenshoter');
 async function takeScreenshot({ driver, settings, logger, }) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     const environment = await driver.getEnvironment();
     return legacyTakeScreenshot({
         driver,
@@ -55,6 +55,7 @@ async function takeScreenshot({ driver, settings, logger, }) {
         logger,
         regionsToCalculate: settings.regionsToCalculate,
         captureStatusBar: settings.captureStatusBar,
+        keepNavigationBar: (_d = settings.mobileOptions) === null || _d === void 0 ? void 0 : _d.keepNavigationBar,
     });
 }
 exports.takeScreenshot = takeScreenshot;

package/dist/check.js

@@ -34,8 +34,8 @@ const chalk_1 = __importDefault(require("chalk"));
 function makeCheck({ type: defaultType = 'classic', eyes, target: defaultTarget, spec, logger: mainLogger, }) {
     let stepIndex = 0;
     return async function check({ type = defaultType, target = defaultTarget, settings, config, logger = mainLogger, } = {}) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
-        var _q, _r, _s, _t;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+        var _r, _s, _t, _u, _v;
         logger = logger.extend(mainLogger, { tags: [`check-${type}-${utils.general.shortid()}`] });
         settings = { ...config === null || config === void 0 ? void 0 : config.screenshot, ...config === null || config === void 0 ? void 0 : config.check, ...settings };
         (_a = settings.fully) !== null && _a !== void 0 ? _a : (settings.fully = !settings.region && (!settings.frames || settings.frames.length === 0));
@@ -54,15 +54,18 @@ function makeCheck({ type: defaultType = 'classic', eyes, target: defaultTarget,
             !utils.types.isEmpty(settings.layoutRegions));
         (_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 = (_q = settings).retryTimeout) !== null && _k !== void 0 ? _k : (_q.retryTimeout = 0);
+        (_k = (_r = settings).retryTimeout) !== null && _k !== void 0 ? _k : (_r.retryTimeout = 0);
         settings.lazyLoad = settings.lazyLoad === true ? {} : settings.lazyLoad;
         if (settings.lazyLoad) {
-            (_l = (_r = settings.lazyLoad).scrollLength) !== null && _l !== void 0 ? _l : (_r.scrollLength = 300);
-            (_m = (_s = settings.lazyLoad).waitingTime) !== null && _m !== void 0 ? _m : (_s.waitingTime = 2000);
-            (_o = (_t = settings.lazyLoad).maxAmountToScroll) !== null && _o !== void 0 ? _o : (_t.maxAmountToScroll = 15000);
+            (_l = (_s = settings.lazyLoad).scrollLength) !== null && _l !== void 0 ? _l : (_s.scrollLength = 300);
+            (_m = (_t = settings.lazyLoad).waitingTime) !== null && _m !== void 0 ? _m : (_t.waitingTime = 2000);
+            (_o = (_u = settings.lazyLoad).maxAmountToScroll) !== null && _o !== void 0 ? _o : (_u.maxAmountToScroll = 15000);
         }
         settings.stepIndex = stepIndex++;
         (_p = settings.waitBetweenStitches) !== null && _p !== void 0 ? _p : (settings.waitBetweenStitches = utils.types.isObject(settings.lazyLoad) ? settings.lazyLoad.waitingTime : 100);
+        if (settings.mobileOptions) {
+            (_q = (_v = settings.mobileOptions).keepNavigationBar) !== null && _q !== void 0 ? _q : (_v.keepNavigationBar = false);
+        }
         if (settings.matchLevel === 'Content') {
             logger.console.log(chalk_1.default.yellow(lang.matchLevelContentDeprecatedWarning));
         }

package/dist/ufg/utils/take-dom-snapshot.js

@@ -146,27 +146,26 @@ function extractCrossFrames({ snapshot, parent = null, logger, }) {
     });
     logger.log(...(snapshot.crossFrames
         ? [
-            `frames paths for ${JSON.stringify(snapshot.crossFrames)}:`,
+            `dom snapshot - frames paths for ${JSON.stringify(snapshot.crossFrames)}:`,
             crossFrames.map(selector => ({
                 // we don't want `selector.parentSnapshot` to be logged - the size of it can be huge
                 cdtNode: selector.cdtNode,
                 reference: selector.reference,
             })),
         ]
-        : ['no cross frames found']));
+        : ['dom snapshot - no cross frames found']));
     return crossFrames;
 }
 function logSnapshot(logger, snapshot) {
     try {
-        logger.log(`dom snapshot cdt length: ${snapshot.cdt.length}`);
-        logger.log(`blobs urls (${snapshot.blobs.length}):`, JSON.stringify(snapshot.blobs.map(({ url }) => url)));
-        logger.log(`resource urls (${snapshot.resourceUrls.length}):`, JSON.stringify(snapshot.resourceUrls));
-        logger.log(`cdt nodes with data-applitools-selector: ${JSON.stringify(snapshot.cdt.filter(node => { var _a; return (_a = node.attributes) === null || _a === void 0 ? void 0 : _a.some(attr => attr.name === 'data-applitools-selector'); }))}`);
-        logger.log('safeSelectors:', snapshot.safeSelectors);
+        logger.log(`dom snapshot - cdt length: ${snapshot.cdt.length}`);
+        logger.log(`dom snapshot - blobs urls (${snapshot.blobs.length}):`, JSON.stringify(snapshot.blobs.map(({ url }) => url)));
+        logger.log(`dom snapshot - resource urls (${snapshot.resourceUrls.length}):`, JSON.stringify(snapshot.resourceUrls));
+        logger.log(`dom snapshot - cdt nodes with data-applitools-selector: ${JSON.stringify(snapshot.cdt.filter(node => { var _a; return (_a = node.attributes) === null || _a === void 0 ? void 0 : _a.some(attr => attr.name === 'data-applitools-selector'); }))}`);
+        logger.log('dom snapshot - safeSelectors:', snapshot.safeSelectors);
+        logger.log('dom snapshot - warnings:', snapshot.warnings);
     }
     catch (err) {
-        logger.error(`error while logging cdt`, err);
+        logger.error(`error while logging dom snapshot`, err);
     }
-    if (snapshot.error)
-        logger.error('snapshot error:', snapshot.error);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.23.0",
+  "version": "4.24.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -76,16 +76,16 @@
   "dependencies": {
     "@applitools/core-base": "1.19.2",
     "@applitools/dom-capture": "11.5.1",
-    "@applitools/dom-snapshot": "4.11.7",
-    "@applitools/driver": "1.19.7",
-    "@applitools/ec-client": "1.9.13",
+    "@applitools/dom-snapshot": "4.11.9",
+    "@applitools/driver": "1.20.0",
+    "@applitools/ec-client": "1.9.14",
     "@applitools/logger": "2.0.19",
-    "@applitools/nml-client": "1.8.17",
+    "@applitools/nml-client": "1.8.18",
     "@applitools/req": "1.7.3",
-    "@applitools/screenshoter": "3.9.5",
+    "@applitools/screenshoter": "3.10.0",
     "@applitools/snippets": "2.6.2",
     "@applitools/socket": "1.1.19",
-    "@applitools/spec-driver-webdriver": "1.1.19",
+    "@applitools/spec-driver-webdriver": "1.1.20",
     "@applitools/ufg-client": "1.14.0",
     "@applitools/utils": "1.7.5",
     "@types/ws": "8.5.5",
@@ -100,8 +100,8 @@
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.4.19",
-    "@applitools/spec-driver-selenium": "^1.5.90",
+    "@applitools/spec-driver-puppeteer": "^1.4.20",
+    "@applitools/spec-driver-selenium": "^1.5.91",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
     "@applitools/tunnel-client": "^1.5.9",

package/types/automation/types.d.ts

@@ -128,6 +128,9 @@ export type LazyLoadOptions = {
     waitingTime?: number;
     maxAmountToScroll?: number;
 };
+export type MobileOptions = {
+    keepNavigationBar?: boolean;
+};
 export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.ImageSettings<Region | ElementReference<TSpec>> {
     webview?: boolean | string;
     frames?: (ContextReference<TSpec> | {
@@ -149,6 +152,7 @@ export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.Ima
     lazyLoad?: boolean | LazyLoadOptions;
     sendDom?: boolean;
     captureStatusBar?: boolean;
+    mobileOptions?: MobileOptions;
 }
 export type LocateSettings<TLocator extends string, TSpec extends SpecType> = BaseCore.LocateSettings<TLocator, Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;
 export type LocateTextSettings<TPattern extends string, TSpec extends SpecType> = BaseCore.LocateTextSettings<TPattern, Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;

package/types/ufg/utils/take-dom-snapshot.d.ts

@@ -23,7 +23,7 @@ export type RawDomSnapshot = {
     srcAttr: string | null;
     scriptVersion: string;
     safeSelectors?: (CommonSelector | null)[];
-    error?: string;
+    warnings?: string[];
 };
 export type DomSnapshotSettings<TSpec extends SpecType> = {
     disableBrowserFetching?: boolean;