@applitools/core 4.33.0 → 4.35.0

package/CHANGELOG.md

@@ -1,5 +1,99 @@
 # Changelog
 
+## [4.35.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.34.0...js/core@4.35.0) (2025-03-31)
+
+
+### Features
+
+* add accessibility field to screenshot ([#2815](https://github.com/Applitools-Dev/sdk/issues/2815)) ([3d111f3](https://github.com/Applitools-Dev/sdk/commit/3d111f354c5eedeb8914f18318ccecce5fd13002))
+
+
+### 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
+
+
+## [4.34.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.33.0...js/core@4.34.0) (2025-03-30)
+
+
+### 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))
+
+
+### 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/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/socket bumped to 1.2.3
+
+* @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/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/logger bumped to 2.1.2
+
+* @applitools/req bumped to 1.7.9
+
+* @applitools/image bumped to 1.1.18
+
+* @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/spec-driver-puppeteer bumped to 1.4.26
+
+* @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/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/ec-client bumped to 1.10.7
+
+
 ## [4.33.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.32.2...js/core@4.33.0) (2025-03-13)
 
 

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

@@ -43,7 +43,15 @@ async function takeScreenshot({ driver, settings, logger, }) {
         hideCaret: settings.hideCaret,
         scrollingMode: (_c = (_b = settings.stitchMode) === null || _b === void 0 ? void 0 : _b.toLowerCase()) !== null && _c !== void 0 ? _c : 'scroll',
         overlap: settings.overlap,
-        wait: settings.waitBeforeCapture,
+        wait: async () => {
+            var _a;
+            if (typeof settings.waitBeforeCapture === 'number') {
+                await utils.general.sleep(settings.waitBeforeCapture);
+            }
+            else if (settings.waitBeforeCapture) {
+                await ((_a = driver.executeUserFunction) === null || _a === void 0 ? void 0 : _a.call(driver, settings.waitBeforeCapture));
+            }
+        },
         framed: environment.isNative,
         lazyLoad: settings.lazyLoad,
         stabilization: settings.normalization && {

package/dist/check.js

@@ -51,7 +51,8 @@ function makeCheck({ type: defaultType = 'classic', eyes, target: defaultTarget,
             settings.enablePatterns ||
             settings.useDom ||
             !utils.types.isEmpty(settings.dynamicRegions) ||
-            !utils.types.isEmpty(settings.layoutRegions));
+            !utils.types.isEmpty(settings.layoutRegions) ||
+            !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);

package/dist/classic/check-and-close.js

@@ -127,6 +127,9 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                     settings: { ...eyes.test.eyesServer, supportedEnvironmentsUrl: eyes.test.supportedEnvironmentsUrl },
                     logger,
                 });
+                if (typeof settings.waitBeforeCapture === 'function') {
+                    throw new Error('providing functions to waitBeforeCapture is not supported in NML - please use a number instead');
+                }
                 const screenshots = await nmlClient.takeScreenshots({
                     settings: {
                         environments: uniqueEnvironments,
@@ -139,12 +142,17 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                         waitBetweenStitches: settings.waitBetweenStitches,
                         lazyLoad: settings.lazyLoad,
                         name: settings.name,
+                        sendDom: settings.sendDom,
                     },
                     logger,
                 });
                 screenshots.forEach(({ environment, ...baseTarget }) => {
+                    var _a, _b;
                     exactEnvironments.push(environment);
-                    baseTargets.push({ ...baseTarget, isTransformed: true });
+                    if ((_a = baseTarget.dom) === null || _a === void 0 ? void 0 : _a.error) {
+                        logger.warn('could not fetch DOM: ' + baseTarget.dom.error);
+                    }
+                    baseTargets.push({ ...baseTarget, dom: (_b = baseTarget.dom) === null || _b === void 0 ? void 0 : _b.url, isTransformed: true });
                     baseSettings.push(getBaseCheckSettings({ calculatedRegions: [] }));
                 });
             }

package/dist/classic/check.js

@@ -324,6 +324,9 @@ async function takeNMLScreenshot({ driver, settings, environments, logger, eyes,
         },
     });
     const calculate = elementReferences.calculate;
+    if (typeof settings.waitBeforeCapture === 'function') {
+        throw new Error('providing functions to waitBeforeCapture is not supported in NML - please use a number instead');
+    }
     const screenshots = await nmlClient.takeScreenshots({
         settings: {
             environments: environments,
@@ -339,10 +342,12 @@ async function takeNMLScreenshot({ driver, settings, environments, logger, eyes,
             region: elementReferences.target,
             selectorsToFindRegionsFor: calculate.map(({ name }) => name),
             scrollRootElement: elementReferences.scrolling,
+            sendDom: settings.sendDom,
         },
         logger,
     });
     return screenshots.map(({ calculateRegions, ...baseTarget }) => {
+        var _a, _b;
         const aggregateCalculatedRegions = [];
         calculate.forEach(({ reference }, index) => {
             const regions = calculateRegions === null || calculateRegions === void 0 ? void 0 : calculateRegions[index];
@@ -353,8 +358,11 @@ async function takeNMLScreenshot({ driver, settings, environments, logger, eyes,
                 logger.log(`Regions "${reference}" was not found in the screenshot`);
             }
         });
+        if ((_a = baseTarget.dom) === null || _a === void 0 ? void 0 : _a.error) {
+            logger.warn('could not fetch DOM: ' + baseTarget.dom.error);
+        }
         return {
-            baseTarget: { ...baseTarget, isTransformed: true },
+            baseTarget: { ...baseTarget, dom: (_b = baseTarget.dom) === null || _b === void 0 ? void 0 : _b.url, isTransformed: true },
             baseSetting: getBaseCheckSettings({
                 calculatedRegions: aggregateCalculatedRegions,
             }),

package/dist/get-eyes-results.js

@@ -24,7 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeGetEyesResults = void 0;
-const test_error_1 = require("./errors/test-error");
+const core_base_1 = require("@applitools/core-base");
 const utils = __importStar(require("@applitools/utils"));
 function makeGetEyesResults({ eyes, logger: mainLogger, }) {
     return async function getEyesResults({ settings, logger = mainLogger, } = {}) {
@@ -35,7 +35,7 @@ function makeGetEyesResults({ eyes, logger: mainLogger, }) {
             results.forEach(result => {
                 var _a;
                 if (result.status !== 'Passed')
-                    throw (_a = result === null || result === void 0 ? void 0 : result.reason) !== null && _a !== void 0 ? _a : new test_error_1.TestError(result);
+                    throw (_a = result === null || result === void 0 ? void 0 : result.reason) !== null && _a !== void 0 ? _a : new core_base_1.TestError(result);
             });
         }
         return results;

package/dist/get-manager-results.js

@@ -24,7 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeGetManagerResults = void 0;
-const test_error_1 = require("./errors/test-error");
+const core_base_1 = require("@applitools/core-base");
 const internal_error_1 = require("./errors/internal-error");
 const separate_duplicate_results_1 = require("./utils/separate-duplicate-results");
 const utils = __importStar(require("@applitools/utils"));
@@ -40,7 +40,7 @@ function makeGetManagerResults({ core, storage, logger: mainLogger, }) {
                         var _a;
                         return ({
                             result,
-                            error: result.status !== 'Passed' ? (_a = result.reason) !== null && _a !== void 0 ? _a : new test_error_1.TestError(result) : undefined,
+                            error: result.status !== 'Passed' ? (_a = result.reason) !== null && _a !== void 0 ? _a : new core_base_1.TestError(result) : undefined,
                             userTestId: result.userTestId,
                             environment: result.environment,
                         });

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

@@ -77,7 +77,10 @@ async function runOfflineSnapshots(options) {
         totalTime: Date.now() - startTime,
         jsonFilePath: options.jsonFilePath,
     });
-    if (!isSuccess && options.failOnDiff) {
+    if (!isSuccess.onErrors && options.failOnError) {
+        throw new Error(outputStr);
+    }
+    else if (!isSuccess.onDiffs && options.failOnDiff) {
         throw new Error(outputStr);
     }
     else {
@@ -155,7 +158,11 @@ async function runOfflineSnapshots(options) {
             await eyes.close({ settings: closeSettings });
         }
         else {
-            await eyes.abort();
+            await eyes.abort({
+                settings: {
+                    reason: 'internal',
+                },
+            });
         }
         logger.log('done running test', testPath);
         return { batchId: openSettings.batch.id, results: (await eyes.getResults({ logger }))[0] };
@@ -236,7 +243,7 @@ exports.runOfflineSnapshots = runOfflineSnapshots;
 function uniq(arr) {
     return [...new Set(arr)];
 }
-function processResults({ testResults, totalTime, saveNewTests = true, failOnDiff = true, jsonFilePath, }) {
+function processResults({ testResults, totalTime, saveNewTests = true, jsonFilePath, }) {
     let outputStr = '\n';
     const pluralize = utils.general.pluralize;
     const testResultsWithErrors = testResults.filter(r => r && r.reason);
@@ -319,16 +326,9 @@ function processResults({ testResults, totalTime, saveNewTests = true, failOnDif
     // if (Number(testConcurrency) === 5) {
     //   outputStr += `\n${concurrencyMsg}\n`
     // }
-    let isSuccess;
-    if (errors.length) {
-        isSuccess = false;
-    }
-    else if (failOnDiff) {
-        isSuccess = !warnForUnsavedNewTests && passedOrNew.length && !unresolvedOrFailed.length;
-    }
-    else {
-        isSuccess = true;
-    }
+    const isSuccess = { onErrors: true, onDiffs: true };
+    isSuccess.onErrors = !errors.length;
+    isSuccess.onDiffs = !!(!warnForUnsavedNewTests && passedOrNew.length && !unresolvedOrFailed.length);
     return {
         outputStr,
         isSuccess,

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

@@ -141,8 +141,8 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
         if (utils.types.isNumber(settings.waitBeforeCapture)) {
             await utils.general.sleep(settings.waitBeforeCapture);
         }
-        else {
-            await ((_b = settings.waitBeforeCapture) === null || _b === void 0 ? void 0 : _b.call(settings));
+        else if (settings.waitBeforeCapture) {
+            await ((_b = driver.executeUserFunction) === null || _b === void 0 ? void 0 : _b.call(driver, settings.waitBeforeCapture));
         }
     }
     function calculateBreakpoint({ breakpoints, value }) {

package/dist/universal/spec-driver.js

@@ -151,9 +151,33 @@ function makeSpec({ socket, spec, }) {
         async reload(driver) {
             return socket.request('Driver.reload', { driver });
         },
+        async isUserFunction(ref) {
+            return utils.types.has(ref, 'applitools-ref-id');
+        },
+        async executeUserFunction(userFunction) {
+            return socket.request('Driver.executeUserFunction', userFunction);
+        },
     };
+    // add default commands to spec (if not already there) such as `isUserFunction`
+    spec = addDefaultCommands(spec);
     return spec.reduce((spec, name) => {
         return Object.assign(spec, { [name]: commands[name] });
     }, {});
 }
 exports.makeSpec = makeSpec;
+// returns a new clone of the spec commands array with additional commands universal can support even if the spec doesn't
+function addDefaultCommands(spec) {
+    const defaultCommands = [
+        {
+            command: 'isUserFunction',
+            dependsOn: ['executeUserFunction'],
+        },
+    ];
+    const commands = spec.slice();
+    defaultCommands.forEach(({ command, dependsOn }) => {
+        if (!commands.includes(command) && dependsOn.every(dep => commands.includes(dep))) {
+            commands.push(command);
+        }
+    });
+    return commands;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.33.0",
+  "version": "4.35.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -75,20 +75,20 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.22.2",
-    "@applitools/dom-capture": "11.5.4",
-    "@applitools/dom-snapshot": "4.11.16",
-    "@applitools/driver": "1.20.5",
-    "@applitools/ec-client": "1.10.6",
-    "@applitools/logger": "2.1.1",
-    "@applitools/nml-client": "1.8.26",
-    "@applitools/req": "1.7.8",
-    "@applitools/screenshoter": "3.10.7",
+    "@applitools/core-base": "1.23.0",
+    "@applitools/dom-capture": "11.5.5",
+    "@applitools/dom-snapshot": "4.11.17",
+    "@applitools/driver": "1.21.0",
+    "@applitools/ec-client": "1.10.8",
+    "@applitools/logger": "2.1.2",
+    "@applitools/nml-client": "1.9.0",
+    "@applitools/req": "1.7.9",
+    "@applitools/screenshoter": "3.11.0",
     "@applitools/snippets": "2.6.4",
-    "@applitools/socket": "1.2.2",
-    "@applitools/spec-driver-webdriver": "1.2.0",
-    "@applitools/ufg-client": "1.16.7",
-    "@applitools/utils": "1.7.8",
+    "@applitools/socket": "1.2.3",
+    "@applitools/spec-driver-webdriver": "1.2.1",
+    "@applitools/ufg-client": "1.16.8",
+    "@applitools/utils": "1.8.0",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",
     "chalk": "4.1.2",
@@ -101,11 +101,11 @@
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.4.25",
-    "@applitools/spec-driver-selenium": "^1.5.96",
+    "@applitools/spec-driver-puppeteer": "^1.4.26",
+    "@applitools/spec-driver-selenium": "^1.5.97",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
-    "@applitools/tunnel-client": "^1.6.3",
+    "@applitools/tunnel-client": "^1.6.4",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",
     "@types/semver": "^7.5.8",

package/types/automation/types.d.ts

@@ -147,7 +147,7 @@ export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.Ima
         top?: number;
         bottom?: number;
     };
-    waitBeforeCapture?: number;
+    waitBeforeCapture?: number | (() => Promise<void>);
     waitBetweenStitches?: number;
     lazyLoad?: boolean | LazyLoadOptions;
     sendDom?: boolean;

package/types/offline/run-offline-snapshots.d.ts

@@ -5,6 +5,7 @@ import type { SpecType } from '@applitools/driver';
 export type OfflineSnapshotsSettings = EyesServerSettings & {
     offlineLocationPath: string;
     failOnDiff: boolean;
+    failOnError: boolean;
     config: Config<SpecType, 'ufg'>;
     logger?: Logger;
     jsonFilePath?: string;

package/types/universal/spec-driver.d.ts

@@ -4,9 +4,12 @@ export type Driver = Ref;
 export type Context = Ref;
 export type Element = Ref;
 export type Selector = string | CommonSelector | Ref;
-export type PrimarySpecType = SpecType<Driver, Context, Element, Selector>;
+export type UserFunction = Ref;
+export type PrimarySpecType = SpecType<Driver, Context, Element, Selector, never, UserFunction>;
 export type SpecDriver = BaseSpecDriver<PrimarySpecType>;
+type CommandName = keyof UniversalSpecDriver<PrimarySpecType>;
 export declare function makeSpec({ socket, spec, }: {
     socket: ServerSocket<PrimarySpecType, any>;
-    spec: (keyof UniversalSpecDriver<PrimarySpecType>)[];
+    spec: CommandName[];
 }): SpecDriver;
+export {};

package/types/universal/types.d.ts

@@ -192,5 +192,7 @@ export interface UniversalSpecDriver<T extends SpecType> {
     reload(options: {
         driver: T['driver'];
     }): Promise<void>;
+    isUserFunction(ref: any): Promise<boolean>;
+    executeUserFunction(userFunction: Ref): Promise<any>;
 }
 export {};

package/dist/errors/test-error.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestError = void 0;
-const core_base_1 = require("@applitools/core-base");
-class TestError extends core_base_1.CoreError {
-    constructor(result) {
-        if (result.status === 'Failed') {
-            super(`Test '${result.name}' of '${result.appName}' is failed! See details at ${result.url}`, {
-                reason: 'test failed',
-                result,
-            });
-        }
-        else if (result.status === 'Unresolved') {
-            if (result.isNew) {
-                super(`Test '${result.name}' of '${result.appName}' is new! Please approve the new baseline at ${result.url}`, {
-                    reason: 'test new',
-                    result,
-                });
-            }
-            else {
-                super(`Test '${result.name}' of '${result.appName}' detected differences! See details at: ${result.url}`, {
-                    reason: 'test different',
-                    result,
-                });
-            }
-        }
-        else {
-            super('');
-        }
-    }
-}
-exports.TestError = TestError;

package/types/errors/test-error.d.ts

@@ -1,5 +0,0 @@
-import type { TestResult } from '@applitools/core-base';
-import { CoreError } from '@applitools/core-base';
-export declare class TestError extends CoreError {
-    constructor(result: TestResult);
-}