@applitools/eyes 1.29.3 → 1.30.0

package/CHANGELOG.md

@@ -1,5 +1,153 @@
 # Changelog
 
+## [1.30.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-v1.29.4...js/eyes@1.30.0) (2024-12-31)
+
+
+### Features
+
+* ability to download side by side with highlighted diffs (2419) ([#2530](https://github.com/Applitools-Dev/sdk/issues/2530)) ([e06ce69](https://github.com/Applitools-Dev/sdk/commit/e06ce699f30e9e444ac58dafdf5989ff1c96ca1c))
+* 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))
+* add chrome emulation devices ([#2559](https://github.com/Applitools-Dev/sdk/issues/2559)) ([0499aaf](https://github.com/Applitools-Dev/sdk/commit/0499aaf3bb809d2ac0105b4493e6f6bb8730ea3f))
+* capture status bar ([#2571](https://github.com/Applitools-Dev/sdk/issues/2571)) ([5e1c75e](https://github.com/Applitools-Dev/sdk/commit/5e1c75ef9cf34af80f08806a3bceaf06a94f2780))
+* disable broker url cache ([#2428](https://github.com/Applitools-Dev/sdk/issues/2428)) ([cb8d5fe](https://github.com/Applitools-Dev/sdk/commit/cb8d5fefb13d3ab42984d2bd4d4ac3d4e10646b0))
+* dynamic regions ([#2538](https://github.com/Applitools-Dev/sdk/issues/2538)) ([d8b5c48](https://github.com/Applitools-Dev/sdk/commit/d8b5c48fb35f9789c702447314dc72b4f415ade1))
+* html report for playwright ([#2576](https://github.com/Applitools-Dev/sdk/issues/2576)) ([f93f164](https://github.com/Applitools-Dev/sdk/commit/f93f164a289f5676bcc9d650e5e3d90b8e6a6920))
+* ios 18 devices enum ([#2584](https://github.com/Applitools-Dev/sdk/issues/2584)) ([8eab653](https://github.com/Applitools-Dev/sdk/commit/8eab653f99733839bdec43d86089edc35abcf8e8))
+* logger masking  ([#2640](https://github.com/Applitools-Dev/sdk/issues/2640)) ([bd69d21](https://github.com/Applitools-Dev/sdk/commit/bd69d21f6341447b1acdb042f4ee1a6328d7428f))
+* offline cli with config ([#2646](https://github.com/Applitools-Dev/sdk/issues/2646)) ([0589dc4](https://github.com/Applitools-Dev/sdk/commit/0589dc429a0c94451e957932106f258dadfd88cc))
+* remove Android NMG API ([#2566](https://github.com/Applitools-Dev/sdk/issues/2566)) ([750c0f0](https://github.com/Applitools-Dev/sdk/commit/750c0f0263e5ff06f86055e7ba0c3fb47cadb620))
+
+
+### Bug Fixes
+
+* don't pass RectangleSize to core ([#2673](https://github.com/Applitools-Dev/sdk/issues/2673)) ([47653ea](https://github.com/Applitools-Dev/sdk/commit/47653eae44d4c9693cc84e9209bb08f8d070c4af))
+* offline cli chalk error ([c7c659a](https://github.com/Applitools-Dev/sdk/commit/c7c659aa889080f2fc7763152db2447211fe1487))
+* organize configuration alphabetically and add getters and setters ([684490d](https://github.com/Applitools-Dev/sdk/commit/684490d8d85d1dd0f07bafdcc38febfcf7c58d08))
+* trigger playwright release ([1d3ea3e](https://github.com/Applitools-Dev/sdk/commit/1d3ea3e4d2059c12d8013f04c18f5facffbc5846))
+* trigger release ([c97dbfc](https://github.com/Applitools-Dev/sdk/commit/c97dbfc89245f374917702a867b87f2794155e54))
+* update ios devices enums ([9b4614f](https://github.com/Applitools-Dev/sdk/commit/9b4614f09bbbe42cf99824d76893f9067aab2cc4))
+
+
+### Code Refactoring
+
+* start linting "no-floating-promises" (wip) ([#2539](https://github.com/Applitools-Dev/sdk/issues/2539)) ([51b91cb](https://github.com/Applitools-Dev/sdk/commit/51b91cb15603f7d68e4bd6a16eb0f80e3f380295))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.7.7
+  #### Bug Fixes
+
+  * shim process execution functions for browser environment ([#2698](https://github.com/Applitools-Dev/sdk/issues/2698)) ([8d77db4](https://github.com/Applitools-Dev/sdk/commit/8d77db48e1c7fd54cad92c89a819a924255e5868))
+* @applitools/logger bumped to 2.1.0
+  #### Features
+
+  * logger masking  ([#2640](https://github.com/Applitools-Dev/sdk/issues/2640)) ([bd69d21](https://github.com/Applitools-Dev/sdk/commit/bd69d21f6341447b1acdb042f4ee1a6328d7428f))
+
+
+
+* @applitools/dom-snapshot bumped to 4.11.13
+  #### Bug Fixes
+
+  * code scanning issue ([#2687](https://github.com/Applitools-Dev/sdk/issues/2687)) ([f301056](https://github.com/Applitools-Dev/sdk/commit/f301056cccfc9cc0c21ceedbd521d8f4b054f058))
+
+
+
+* @applitools/socket bumped to 1.2.0
+  #### Features
+
+  * logger masking  ([#2640](https://github.com/Applitools-Dev/sdk/issues/2640)) ([bd69d21](https://github.com/Applitools-Dev/sdk/commit/bd69d21f6341447b1acdb042f4ee1a6328d7428f))
+
+
+
+* @applitools/core-base bumped to 1.22.0
+  #### Features
+
+  * deterministic output in offline execution ([#2711](https://github.com/Applitools-Dev/sdk/issues/2711)) ([5e8c7ca](https://github.com/Applitools-Dev/sdk/commit/5e8c7ca43c98e7ba6aed0c1a66c5a60b4001aeff))
+  * logger masking  ([#2640](https://github.com/Applitools-Dev/sdk/issues/2640)) ([bd69d21](https://github.com/Applitools-Dev/sdk/commit/bd69d21f6341447b1acdb042f4ee1a6328d7428f))
+
+
+
+* @applitools/req bumped to 1.7.6
+
+* @applitools/image bumped to 1.1.16
+
+* @applitools/dom-capture bumped to 11.5.3
+  #### Bug Fixes
+
+  * code scanning issue ([#2687](https://github.com/Applitools-Dev/sdk/issues/2687)) ([f301056](https://github.com/Applitools-Dev/sdk/commit/f301056cccfc9cc0c21ceedbd521d8f4b054f058))
+* @applitools/driver bumped to 1.20.2
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.22
+
+* @applitools/tunnel-client bumped to 1.6.0
+  #### Features
+
+  * logger masking  ([#2640](https://github.com/Applitools-Dev/sdk/issues/2640)) ([bd69d21](https://github.com/Applitools-Dev/sdk/commit/bd69d21f6341447b1acdb042f4ee1a6328d7428f))
+
+
+
+* @applitools/ec-client bumped to 1.10.0
+  #### Features
+
+  * logger masking  ([#2640](https://github.com/Applitools-Dev/sdk/issues/2640)) ([bd69d21](https://github.com/Applitools-Dev/sdk/commit/bd69d21f6341447b1acdb042f4ee1a6328d7428f))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.1.22
+
+* @applitools/spec-driver-selenium bumped to 1.5.93
+
+* @applitools/screenshoter bumped to 3.10.2
+
+* @applitools/nml-client bumped to 1.8.21
+
+* @applitools/ufg-client bumped to 1.16.0
+  #### Features
+
+  * deterministic output in offline execution ([#2711](https://github.com/Applitools-Dev/sdk/issues/2711)) ([5e8c7ca](https://github.com/Applitools-Dev/sdk/commit/5e8c7ca43c98e7ba6aed0c1a66c5a60b4001aeff))
+
+
+  #### Bug Fixes
+
+  * code scanning issue ([#2687](https://github.com/Applitools-Dev/sdk/issues/2687)) ([f301056](https://github.com/Applitools-Dev/sdk/commit/f301056cccfc9cc0c21ceedbd521d8f4b054f058))
+
+
+
+* @applitools/core bumped to 4.28.0
+  #### Features
+
+  * deterministic output in offline execution ([#2711](https://github.com/Applitools-Dev/sdk/issues/2711)) ([5e8c7ca](https://github.com/Applitools-Dev/sdk/commit/5e8c7ca43c98e7ba6aed0c1a66c5a60b4001aeff))
+  * logger masking  ([#2640](https://github.com/Applitools-Dev/sdk/issues/2640)) ([bd69d21](https://github.com/Applitools-Dev/sdk/commit/bd69d21f6341447b1acdb042f4ee1a6328d7428f))
+
+
+  #### Bug Fixes
+
+  * take snapshots with coded regions on pages that has cross origin frames ([#2705](https://github.com/Applitools-Dev/sdk/issues/2705)) ([5972fec](https://github.com/Applitools-Dev/sdk/commit/5972fec890a1454a9f96c4eddcf17634e72111aa))
+
+
+
+
+## [1.29.4](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.29.3...js/eyes@1.29.4) (2024-12-22)
+
+
+### Dependencies
+
+* @applitools/core-base bumped to 1.21.1
+  #### Bug Fixes
+
+  * add regions round up to the client set regions as well coded one ([#2413](https://github.com/Applitools-Dev/sdk/issues/2413)) ([85d4d2d](https://github.com/Applitools-Dev/sdk/commit/85d4d2ddd0166802c7ca9a5c11a1f52962284a5b))
+* @applitools/ec-client bumped to 1.9.18
+
+* @applitools/core bumped to 4.27.1
+  #### Bug Fixes
+
+  * add env variable for universal host name to use different conventions of localhost ([#2689](https://github.com/Applitools-Dev/sdk/issues/2689)) ([24d6713](https://github.com/Applitools-Dev/sdk/commit/24d671313dba0bba00e2f86875920e0431cf1234))
+  * add regions round up to the client set regions as well coded one ([#2413](https://github.com/Applitools-Dev/sdk/issues/2413)) ([85d4d2d](https://github.com/Applitools-Dev/sdk/commit/85d4d2ddd0166802c7ca9a5c11a1f52962284a5b))
+
+
+
+
 ## [1.29.3](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.29.2...js/eyes@1.29.3) (2024-12-18)
 
 

package/dist/Eyes.js

@@ -46,7 +46,7 @@ class Eyes {
         return this.constructor._sdk;
     }
     static async getExecutionCloudUrl(config) {
-        const { core } = (0, SDK_1.initSDK)(this._sdk);
+        const { core } = (0, SDK_1.initSDK)(this._sdk, config === null || config === void 0 ? void 0 : config.maskLog);
         const client = await core.getECClient({
             settings: {
                 proxy: config === null || config === void 0 ? void 0 : config.proxy,
@@ -59,7 +59,7 @@ class Eyes {
     static async setViewportSize(driver, size) {
         var _a;
         const { core } = (0, SDK_1.initSDK)(this._sdk);
-        await ((_a = core.setViewportSize) === null || _a === void 0 ? void 0 : _a.call(core, { target: driver, size }));
+        await ((_a = core.setViewportSize) === null || _a === void 0 ? void 0 : _a.call(core, { target: driver, size: { width: size.width, height: size.height } }));
     }
     static setMobileCapabilities(capabilities, config) {
         var _a, _b;
@@ -92,7 +92,8 @@ class Eyes {
         this._state = {};
         this._events = new Map();
         this._handlers = new SessionEventHandlers_1.SessionEventHandlers();
-        const sdk = (0, SDK_1.initSDK)(this._sdk);
+        const maskLog = utils.types.instanceOf(runnerOrConfig, Runners_1.EyesRunner) ? runnerOrConfig._maskLog : false;
+        const sdk = (0, SDK_1.initSDK)(this._sdk, maskLog);
         this._spec = sdk.spec;
         this._core = sdk.core;
         if (utils.types.instanceOf(runnerOrConfig, Runners_1.EyesRunner)) {
@@ -205,7 +206,10 @@ class Eyes {
             config.open.testName = testNameOrViewportSize;
         if (utils.types.has(viewportSizeOrSessionType, ['width', 'height'])) {
             (_e = (_g = config.open).environment) !== null && _e !== void 0 ? _e : (_g.environment = {});
-            config.open.environment.viewportSize = viewportSizeOrSessionType;
+            config.open.environment.viewportSize = {
+                width: viewportSizeOrSessionType.width,
+                height: viewportSizeOrSessionType.height,
+            };
         }
         if (utils.types.isEnumValue(sessionType, SessionType_1.SessionTypeEnum))
             config.open.sessionType = sessionType;
@@ -447,6 +451,7 @@ class Eyes {
     async setViewportSize(size) {
         var _a, _b;
         utils.guard.notNull(size, { name: 'size' });
+        size = { width: size.width, height: size.height }; // ensure no extra props, and convert getters to enumerable props
         if (!this._driver) {
             this._config.setViewportSize(size);
         }

package/dist/Runners.js

@@ -33,10 +33,12 @@ const TestResultsSummary_1 = require("./output/TestResultsSummary");
 const utils = __importStar(require("@applitools/utils"));
 class EyesRunner {
     constructor(options) {
+        var _a;
         /** @internal */
         this._managerSettings = {};
         /** @internal */
         this._getResultsSettings = {};
+        this._maskLog = (_a = options === null || options === void 0 ? void 0 : options.maskLog) !== null && _a !== void 0 ? _a : false;
         if (options) {
             this._managerSettings = {
                 concurrency: options.testConcurrency,

package/dist/SDK.js

@@ -26,7 +26,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.initSDK = void 0;
 const core_1 = require("@applitools/core");
 const utils = __importStar(require("@applitools/utils"));
-function initSDK(options) {
+function initSDK(options, maskLog) {
+    if (options)
+        options.maskLog = maskLog;
     return {
         core: getCoreWithCache(options),
         spec: options === null || options === void 0 ? void 0 : options.spec,

package/dist/input/Configuration.js

@@ -968,7 +968,7 @@ class ConfigurationData {
         this._config.viewportSize = viewportSize;
     }
     getViewportSize() {
-        return this.viewportSize && new RectangleSize_1.RectangleSizeData(this.viewportSize);
+        return this.viewportSize && new RectangleSize_1.RectangleSizeData(this.viewportSize); // this is not a copy constructor, the RectangleSizeData saves the reference
     }
     setViewportSize(viewportSize) {
         this.viewportSize = viewportSize;
@@ -1050,7 +1050,10 @@ class ConfigurationData {
                     os: this.hostOS,
                     displayOs: this.hostOSInfo,
                     deviceName: this.deviceInfo,
-                    viewportSize: this.viewportSize,
+                    viewportSize: this.viewportSize && {
+                        width: this.viewportSize.width,
+                        height: this.viewportSize.height,
+                    },
                 }),
                 branchName: this.branchName,
                 parentBranchName: this.parentBranchName,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes",
-  "version": "1.29.3",
+  "version": "1.30.0",
   "keywords": [
     "applitools",
     "eyes",
@@ -46,13 +46,13 @@
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/core": "4.27.0",
-    "@applitools/logger": "2.0.20",
-    "@applitools/utils": "1.7.6",
+    "@applitools/core": "4.28.0",
+    "@applitools/logger": "2.1.0",
+    "@applitools/utils": "1.7.7",
     "chalk": "4.1.2"
   },
   "devDependencies": {
-    "@applitools/req": "^1.7.5",
+    "@applitools/req": "^1.7.6",
     "@types/node": "^12.20.55"
   },
   "engines": {

package/types/Eyes.d.ts

@@ -39,7 +39,9 @@ export declare class Eyes<TSpec extends Core.SpecType = Core.SpecType> {
     private _spec?;
     private _events;
     private _handlers;
-    static getExecutionCloudUrl(config?: Configuration): Promise<string>;
+    static getExecutionCloudUrl(config?: Configuration & {
+        maskLog?: boolean;
+    }): Promise<string>;
     static setViewportSize(driver: unknown, size: RectangleSize): Promise<void>;
     static setMobileCapabilities<TCapabilities extends Record<string, any>>(capabilities: TCapabilities, config?: Configuration): TCapabilities;
     constructor(runner?: EyesRunner, config?: Configuration<TSpec>);

package/types/Runners.d.ts

@@ -5,6 +5,7 @@ import { TestResultsSummaryData } from './output/TestResultsSummary';
 export declare abstract class EyesRunner {
     private _core?;
     private _manager?;
+    readonly _maskLog: boolean;
     abstract readonly type: 'classic' | 'ufg';
     /** @internal */
     protected readonly _managerSettings: Core.ManagerSettings;

package/types/SDK.d.ts

@@ -3,9 +3,10 @@ export interface SDK<TSpec extends SpecType = SpecType> {
     spec?: SpecDriver<TSpec>;
     agentId?: string;
     environment?: Record<string, any>;
+    maskLog?: boolean;
     makeCore?: typeof makeDefaultCore;
 }
-export declare function initSDK<TSpec extends SpecType = SpecType>(options?: SDK<TSpec>): {
+export declare function initSDK<TSpec extends SpecType = SpecType>(options?: SDK<TSpec>, maskLog?: boolean): {
     core: Core<TSpec, 'classic' | 'ufg'>;
     spec?: SpecDriver<TSpec>;
 };

package/types/input/RunnerOptions.d.ts

@@ -4,6 +4,7 @@ export type RunnerOptions = {
     /** @internal */
     legacyConcurrency?: number;
     removeDuplicateTests?: boolean;
+    maskLog?: boolean;
 };
 /** @deprecated */
 export declare class RunnerOptionsFluent {