@applitools/eyes 1.30.0 → 1.31.0

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # Changelog
 
+## [1.31.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.30.0...js/eyes@1.31.0) (2025-01-13)
+
+
+### Features
+
+* jsonFilePath in offline mode ([#2734](https://github.com/Applitools-Dev/sdk/issues/2734)) ([2f9fbe8](https://github.com/Applitools-Dev/sdk/commit/2f9fbe8fc3c5212db6b7cc58a98b041c3ffd5572))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.14
+  #### Bug Fixes
+
+  * remove side-eyes and fix code scanning issues ([#2712](https://github.com/Applitools-Dev/sdk/issues/2712)) ([cda98e4](https://github.com/Applitools-Dev/sdk/commit/cda98e4748c73cd97c11f646a2b5e26ff9416892))
+
+
+
+* @applitools/snippets bumped to 2.6.4
+  #### Bug Fixes
+
+  * remove side-eyes and fix code scanning issues ([#2712](https://github.com/Applitools-Dev/sdk/issues/2712)) ([cda98e4](https://github.com/Applitools-Dev/sdk/commit/cda98e4748c73cd97c11f646a2b5e26ff9416892))
+* @applitools/dom-capture bumped to 11.5.4
+  #### Bug Fixes
+
+  * remove side-eyes and fix code scanning issues ([#2712](https://github.com/Applitools-Dev/sdk/issues/2712)) ([cda98e4](https://github.com/Applitools-Dev/sdk/commit/cda98e4748c73cd97c11f646a2b5e26ff9416892))
+* @applitools/driver bumped to 1.20.3
+
+* @applitools/spec-driver-webdriver bumped to 1.1.23
+
+* @applitools/spec-driver-selenium bumped to 1.5.94
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.23
+
+* @applitools/screenshoter bumped to 3.10.3
+
+* @applitools/nml-client bumped to 1.8.22
+
+* @applitools/ec-client bumped to 1.10.1
+
+* @applitools/core bumped to 4.29.0
+  #### Features
+
+  * jsonFilePath in offline mode ([#2734](https://github.com/Applitools-Dev/sdk/issues/2734)) ([2f9fbe8](https://github.com/Applitools-Dev/sdk/commit/2f9fbe8fc3c5212db6b7cc58a98b041c3ffd5572))
+
+
+  #### Bug Fixes
+
+  * support batching tests in distributed env - close batch only when required ([#2733](https://github.com/Applitools-Dev/sdk/issues/2733)) ([2e59e4a](https://github.com/Applitools-Dev/sdk/commit/2e59e4a76edcc02b8888dfc78a42749bae76f79c))
+
+
+
+
 ## [1.30.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-v1.29.4...js/eyes@1.30.0) (2024-12-31)
 
 

package/dist/Eyes.js

@@ -58,7 +58,7 @@ class Eyes {
     }
     static async setViewportSize(driver, size) {
         var _a;
-        const { core } = (0, SDK_1.initSDK)(this._sdk);
+        const { core } = (0, SDK_1.initSDK)(this._sdk, true);
         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) {
@@ -92,7 +92,7 @@ class Eyes {
         this._state = {};
         this._events = new Map();
         this._handlers = new SessionEventHandlers_1.SessionEventHandlers();
-        const maskLog = utils.types.instanceOf(runnerOrConfig, Runners_1.EyesRunner) ? runnerOrConfig._maskLog : false;
+        const maskLog = utils.types.instanceOf(runnerOrConfig, Runners_1.EyesRunner) ? runnerOrConfig._maskLog : undefined;
         const sdk = (0, SDK_1.initSDK)(this._sdk, maskLog);
         this._spec = sdk.spec;
         this._core = sdk.core;

package/dist/SDK.js

@@ -23,19 +23,19 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initSDK = void 0;
+exports.getCoreWithCache = exports.initSDK = void 0;
 const core_1 = require("@applitools/core");
 const utils = __importStar(require("@applitools/utils"));
 function initSDK(options, maskLog) {
     if (options)
         options.maskLog = maskLog;
     return {
-        core: getCoreWithCache(options),
+        core: (0, exports.getCoreWithCache)(options),
         spec: options === null || options === void 0 ? void 0 : options.spec,
     };
 }
 exports.initSDK = initSDK;
-const getCoreWithCache = utils.general.cachify(getCore);
+exports.getCoreWithCache = utils.general.cachify(getCore);
 function getCore({ makeCore = core_1.makeCore, ...options } = {}) {
     var _a;
     (_a = options.agentId) !== null && _a !== void 0 ? _a : (options.agentId = `js/eyes/${require('../package.json').version}`);

package/dist/cli/cli.js

@@ -29,6 +29,10 @@ void yargs_1.default
                 description: 'path to configuration file (applitools.config.js / applitools.config.ts)',
                 type: 'string',
             },
+            jsonFilePath: {
+                description: 'path to json file with the test results',
+                type: 'string',
+            },
         })
             .fail((_msg, err, _yargs) => {
             if (err) {

package/dist/input/Configuration.js

@@ -483,6 +483,26 @@ class ConfigurationData {
         this.gitMergeBaseTimestamp = gitMergeBaseTimestamp;
         return this;
     }
+    get latestCommitInfo() {
+        return this._config.latestCommitInfo;
+    }
+    set latestCommitInfo(latestCommitInfo) {
+        if (latestCommitInfo) {
+            utils.guard.isString(latestCommitInfo.sha, { name: 'latestCommitInfo.sha' });
+            // TODO implement utils.guard.isISODate (didn't do it to avoid releasing utils and then all packages for this small thing)
+            utils.guard.custom(latestCommitInfo.timestamp, (timestamp) => isISODate(timestamp), {
+                name: 'latestCommitInfo.timestamp',
+            });
+        }
+        this._config.latestCommitInfo = latestCommitInfo;
+    }
+    getLatestCommitInfo() {
+        return this.latestCommitInfo;
+    }
+    setLatestCommitInfo(latestCommitInfo) {
+        this.latestCommitInfo = latestCommitInfo;
+        return this;
+    }
     get hideCaret() {
         return this._config.hideCaret;
     }
@@ -1062,6 +1082,7 @@ class ConfigurationData {
                 ignoreBaseline: this.ignoreBaseline,
                 gitBranchingTimestamp: this.gitMergeBaseTimestamp,
                 ignoreGitBranching: this.ignoreGitMergeBase,
+                latestCommitInfo: this.latestCommitInfo,
                 saveDiffs: this.saveDiffs,
                 keepBatchOpen: this.dontCloseBatches,
                 disableBrokerUrlCache: this.disableNMLUrlCache,
@@ -1133,3 +1154,7 @@ class ConfigurationData {
     }
 }
 exports.ConfigurationData = ConfigurationData;
+// TODO: should be in utils
+function isISODate(str) {
+    return /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\+\d{2}:\d{2})?/.test(str);
+}

package/dist/input/LatestCommitInfo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes",
-  "version": "1.30.0",
+  "version": "1.31.0",
   "keywords": [
     "applitools",
     "eyes",
@@ -46,7 +46,7 @@
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/core": "4.28.0",
+    "@applitools/core": "4.29.0",
     "@applitools/logger": "2.1.0",
     "@applitools/utils": "1.7.7",
     "chalk": "4.1.2"

package/types/SDK.d.ts

@@ -10,3 +10,10 @@ export declare function initSDK<TSpec extends SpecType = SpecType>(options?: SDK
     core: Core<TSpec, 'classic' | 'ufg'>;
     spec?: SpecDriver<TSpec>;
 };
+export declare const getCoreWithCache: typeof getCore & {
+    getCachedValues(): Core<SpecType, "classic" | "ufg">[];
+    setCachedValue(key: any, value: Core<SpecType, "classic" | "ufg">): void;
+    clearCache(): void;
+};
+declare function getCore<TSpec extends SpecType = SpecType>({ makeCore, ...options }?: SDK<TSpec>): Core<TSpec, 'classic' | 'ufg'>;
+export {};

package/types/input/Configuration.d.ts

@@ -18,6 +18,7 @@ import { AUTProxySettings } from './AUTProxySettings';
 import { BatchInfo, BatchInfoData } from './BatchInfo';
 import { PropertyData, PropertyDataData } from './PropertyData';
 import { ImageMatchSettings } from './ImageMatchSettings';
+import { LatestCommitInfo } from './LatestCommitInfo';
 export type Configuration<TSpec extends Core.SpecType = Core.SpecType> = {
     accessibilityValidation?: AccessibilitySettings;
     agentId?: string;
@@ -49,6 +50,7 @@ export type Configuration<TSpec extends Core.SpecType = Core.SpecType> = {
     environmentName?: string;
     forceFullPageScreenshot?: boolean;
     gitMergeBaseTimestamp?: string;
+    latestCommitInfo?: LatestCommitInfo;
     hideCaret?: boolean;
     hideScrollbars?: boolean;
     hostApp?: string;
@@ -234,6 +236,10 @@ export declare class ConfigurationData<TSpec extends Core.SpecType = Core.SpecTy
     set gitMergeBaseTimestamp(gitMergeBaseTimestamp: string);
     getGitMergeBaseTimestamp(): string;
     setGitMergeBaseTimestamp(gitMergeBaseTimestamp: string): this;
+    get latestCommitInfo(): LatestCommitInfo;
+    set latestCommitInfo(latestCommitInfo: LatestCommitInfo);
+    getLatestCommitInfo(): LatestCommitInfo;
+    setLatestCommitInfo(latestCommitInfo: LatestCommitInfo): this;
     get hideCaret(): boolean;
     set hideCaret(hideCaret: boolean);
     getHideCaret(): boolean;

package/types/input/LatestCommitInfo.d.ts

@@ -0,0 +1,4 @@
+export type LatestCommitInfo = {
+    timestamp: string;
+    sha: string;
+};