@applitools/eyes-browser 1.5.20 → 1.5.22

package/CHANGELOG.md

@@ -1,5 +1,65 @@
 # Changelog
 
+## [1.5.22](https://github.com/Applitools-Dev/sdk/compare/js/eyes-browser@1.5.21...js/eyes-browser@1.5.22) (2026-01-19)
+
+
+### Dependencies
+
+* @applitools/driver bumped to 1.25.0
+  #### Features
+
+  * multi-page support - FLD-3827 ([#3410](https://github.com/Applitools-Dev/sdk/issues/3410)) ([a55b982](https://github.com/Applitools-Dev/sdk/commit/a55b9827c2218c11da5ed61b38bf12a70ce4c8db))
+* @applitools/spec-driver-puppeteer bumped to 1.7.0
+  #### Features
+
+  * multi-page support - FLD-3827 ([#3410](https://github.com/Applitools-Dev/sdk/issues/3410)) ([a55b982](https://github.com/Applitools-Dev/sdk/commit/a55b9827c2218c11da5ed61b38bf12a70ce4c8db))
+
+
+
+* @applitools/core bumped to 4.55.0
+  #### Features
+
+  * multi-page support - FLD-3827 ([#3410](https://github.com/Applitools-Dev/sdk/issues/3410)) ([a55b982](https://github.com/Applitools-Dev/sdk/commit/a55b9827c2218c11da5ed61b38bf12a70ce4c8db))
+
+
+
+* @applitools/dom-snapshot bumped to 4.15.6
+
+* @applitools/spec-driver-webdriver bumped to 1.5.5
+
+* @applitools/spec-driver-selenium bumped to 1.7.11
+
+* @applitools/screenshoter bumped to 3.12.12
+
+* @applitools/nml-client bumped to 1.11.15
+
+* @applitools/ec-client bumped to 1.12.17
+
+* @applitools/eyes bumped to 1.38.0
+  #### Features
+
+  * multi-page support - FLD-3827 ([#3410](https://github.com/Applitools-Dev/sdk/issues/3410)) ([a55b982](https://github.com/Applitools-Dev/sdk/commit/a55b9827c2218c11da5ed61b38bf12a70ce4c8db))
+
+
+
+
+## [1.5.21](https://github.com/Applitools-Dev/sdk/compare/js/eyes-browser@1.5.20...js/eyes-browser@1.5.21) (2026-01-14)
+
+
+### Dependencies
+
+* @applitools/core bumped to 4.54.3
+  #### Bug Fixes
+
+  * `close`/`getResults` race condition ([#3450](https://github.com/Applitools-Dev/sdk/issues/3450)) ([2e5437d](https://github.com/Applitools-Dev/sdk/commit/2e5437dcfde6fda58d76227659ee249bfa3885a7))
+* @applitools/eyes bumped to 1.37.0
+  #### Features
+
+  * expose buildId in BatchInfo type | FLD-4020 ([#3466](https://github.com/Applitools-Dev/sdk/issues/3466)) ([7868ba0](https://github.com/Applitools-Dev/sdk/commit/7868ba08de9a9d348c42d8eac5a953dce44844d0))
+
+
+
+
 ## [1.5.20](https://github.com/Applitools-Dev/sdk/compare/js/eyes-browser@1.5.19...js/eyes-browser@1.5.20) (2026-01-11)
 
 

package/dist/index.js

@@ -71874,6 +71874,14 @@ var require_driver = __commonJS({
         }
         return normalizedRegion;
       }
+      async bringToFront() {
+        var _a, _b;
+        try {
+          await ((_b = (_a = this._spec).bringToFront) === null || _b === void 0 ? void 0 : _b.call(_a, this.target));
+        } catch (error) {
+          this._logger.warn("Unable to bringToFront the current context due to the error", error);
+        }
+      }
       async getRegionInViewport(context, region) {
         await context.focus();
         return context.getRegionInViewport(region);
@@ -89225,20 +89233,23 @@ var require_close2 = __commonJS({
           logger.log('Command "close" starting filler tests for environments', settings.environments);
           await Promise.all(uniqueEnvironments.map((environment) => eyes.getBaseEyes({ settings: { environment }, logger })));
         }
-        eyes.storage.forEach(async (item) => {
-          var _a2, _b;
-          try {
-            const [eyes2] = await Promise.all([item.eyes, ...item.jobs]);
+        eyes.storage.forEach((item) => {
+          const closePromise = (async () => {
+            var _a2, _b;
             try {
-              await eyes2.close({ settings, logger });
+              const [eyes2] = await Promise.all([item.eyes, ...item.jobs]);
+              try {
+                await eyes2.close({ settings, logger });
+              } catch (error) {
+                logger.warn('Command "close" received an error during performing, trying to perform abort instead', error);
+                await eyes2.abort({ settings, logger });
+              }
             } catch (error) {
-              logger.warn('Command "close" received an error during performing, trying to perform abort instead', error);
-              await eyes2.abort({ settings, logger });
+              logger.warn('Command "close" received an error during waiting for eyes instances in background', error);
+              await ((_b = (_a2 = error.info) === null || _a2 === void 0 ? void 0 : _a2.eyes) === null || _b === void 0 ? void 0 : _b.abort({ settings, logger }));
             }
-          } catch (error) {
-            logger.warn('Command "close" received an error during waiting for eyes instances in background', error);
-            await ((_b = (_a2 = error.info) === null || _a2 === void 0 ? void 0 : _a2.eyes) === null || _b === void 0 ? void 0 : _b.abort({ settings, logger }));
-          }
+          })();
+          item.jobs.push(closePromise);
         });
       };
     }
@@ -95713,7 +95724,7 @@ creating temp style for access.`), r3 = Zh(e3);
               function B2(e3) {
                 return n4.defaultView && n4.defaultView.frameElement && n4.defaultView.frameElement.getAttribute(e3);
               }
-            }(t3).then((e3) => (h2.log("processPage end"), e3.scriptVersion = "4.15.5", e3));
+            }(t3).then((e3) => (h2.log("processPage end"), e3.scriptVersion = "4.15.6", e3));
           }, window[x], "domSnapshotResult");
           return function(e3) {
             try {
@@ -96513,9 +96524,10 @@ var require_to_safe_check_settings = __commonJS({
             const { region, ...options } = utils34.types.has(reference, "region") ? reference : { region: reference };
             if (isRegion(region))
               return reference;
-            const { originalSelector, safeSelector } = selectors.calculate.shift();
-            if (!safeSelector)
+            const selectorInfo = selectors.calculate.shift();
+            if (!(selectorInfo === null || selectorInfo === void 0 ? void 0 : selectorInfo.safeSelector))
               return [];
+            const { originalSelector, safeSelector } = selectorInfo;
             return {
               region: safeSelector,
               regionId: utils34.types.isString(originalSelector) ? originalSelector : originalSelector === null || originalSelector === void 0 ? void 0 : originalSelector.selector,
@@ -96546,7 +96558,7 @@ var require_to_generated_selectors = __commonJS({
     init_setInterval();
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.toGeneratedSelectors = void 0;
-    function toGeneratedSelectors({ elementReferences, logger, transformElementReference }) {
+    function toGeneratedSelectors({ elementReferences, logger, transformElementReference, logDeprecations }) {
       var _a, _b, _c;
       const elementReferencesToMark = [
         (_a = elementReferences.target) !== null && _a !== void 0 ? _a : [],
@@ -96593,7 +96605,8 @@ var require_to_generated_selectors = __commonJS({
               safeSelector: isError ? null : safeSelector
             };
           });
-        } else {
+        } else if (target || scrolling || calculate.length) {
+          logDeprecations("toGeneratedSelectors: `transformElementReference` was unexpectedly called.");
           target = elementReferences.target && transformElementReference(elementReferences.target);
           scrolling = elementReferences.scrolling && transformElementReference(elementReferences.scrolling);
           calculate = ((_c2 = elementReferences.calculate) !== null && _c2 !== void 0 ? _c2 : []).map((elementReference) => {
@@ -96691,6 +96704,7 @@ var require_take_snapshots2 = __commonJS({
         const { elementReferencesToMark, getGeneratedSelectors } = (0, to_generated_selectors_1.toGeneratedSelectors)({
           elementReferences,
           logger,
+          logDeprecations,
           // dead code - `transformElementReference` was used for NMG but it's not longer used anywhere
           transformElementReference: (elementReference) => {
             var _a2;
@@ -96741,6 +96755,7 @@ var require_take_snapshots2 = __commonJS({
             }
           }
         } else {
+          logDeprecations("takeSnapshots: taking native snapshots is no longer supported. How did you reach this message? (dead code)");
           const nmlClient = await core.getNMLClient({
             driver,
             settings: { ...account.eyesServer, supportedEnvironmentsUrl: account.supportedEnvironmentsUrl },
@@ -96787,6 +96802,18 @@ var require_take_snapshots2 = __commonJS({
           title,
           userAgent
         }));
+        function logDeprecations(...args) {
+          core.logEvent({
+            settings: {
+              level: "Error",
+              event: {
+                type: "SDK.unreachableCodeReached",
+                message: args.join(" ")
+              },
+              ...account.eyesServer
+            }
+          });
+        }
       };
     }
     exports.makeTakeSnapshots = makeTakeSnapshots;
@@ -119464,6 +119491,7 @@ var require_check4 = __commonJS({
           logger.console.log(chalk_1.default.yellow(lang.matchLevelContentDeprecatedWarning));
         }
         const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, reset: target === defaultTarget, logger }) : null;
+        await (driver === null || driver === void 0 ? void 0 : driver.bringToFront());
         const typedEyes = await eyes.getTypedEyes({ type, logger });
         return typedEyes.check({ target: driver !== null && driver !== void 0 ? driver : target, settings, logger });
       };
@@ -121127,7 +121155,7 @@ var require_package3 = __commonJS({
   "../core/package.json"(exports, module) {
     module.exports = {
       name: "@applitools/core",
-      version: "4.54.2",
+      version: "4.55.0",
       homepage: "https://applitools.com",
       bugs: {
         url: "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -126499,6 +126527,9 @@ var require_spec_driver3 = __commonJS({
         },
         async executeBrowserCommands(driver, commands2) {
           return socket.request("Driver.executeBrowserCommands", { driver, commands: commands2 });
+        },
+        async bringToFront(driver) {
+          return socket.request("Driver.bringToFront", { driver });
         }
       };
       spec = addDefaultCommands(spec);
@@ -128043,7 +128074,7 @@ var require_package4 = __commonJS({
   "../eyes/package.json"(exports, module) {
     module.exports = {
       name: "@applitools/eyes",
-      version: "1.36.20",
+      version: "1.38.0",
       keywords: [
         "applitools",
         "eyes",
@@ -128073,6 +128104,10 @@ var require_package4 = __commonJS({
           types: "./types/index.d.ts",
           default: "./dist/index.js"
         },
+        "./SettingsWithPage": {
+          types: "./types/SettingsWithPage.d.ts",
+          default: "./dist/SettingsWithPage.js"
+        },
         "./dist/*": "./dist/*.js",
         "./package.json": "./package.json"
       },
@@ -129710,13 +129745,15 @@ var BatchInfoData = class {
     utils13.guard.isString(batch.sequenceName, { name: "sequenceName", strict: false });
     utils13.guard.isBoolean(batch.notifyOnCompletion, { name: "notifyOnCompletion", strict: false });
     utils13.guard.isArray(batch.properties, { name: "properties", strict: false });
+    utils13.guard.isString(batch.buildId, { name: "buildId", strict: false });
     this._batch = {
       id: (_b = (_a = batch.id) != null ? _a : utils13.general.getEnvValue("BATCH_ID")) != null ? _b : `generated-${utils13.general.guid()}`,
       name: (_c = batch.name) != null ? _c : utils13.general.getEnvValue("BATCH_NAME"),
       sequenceName: (_d = batch.sequenceName) != null ? _d : utils13.general.getEnvValue("BATCH_SEQUENCE"),
       startedAt: (_e = batch.startedAt) != null ? _e : /* @__PURE__ */ new Date(),
       notifyOnCompletion: (_g = (_f = batch.notifyOnCompletion) != null ? _f : utils13.general.getEnvValue("BATCH_NOTIFY", "boolean")) != null ? _g : false,
-      properties: batch.properties
+      properties: batch.properties,
+      buildId: batch.buildId
     };
   }
   get id() {
@@ -129810,6 +129847,20 @@ var BatchInfoData = class {
     this.properties.push(property);
     return this;
   }
+  get buildId() {
+    return this._batch.buildId;
+  }
+  set buildId(buildId) {
+    utils13.guard.isString(buildId, { name: "buildId", strict: false });
+    this._batch.buildId = buildId;
+  }
+  getBuildId() {
+    return this.buildId;
+  }
+  setBuildId(buildId) {
+    this.buildId = buildId;
+    return this;
+  }
   /** @internal */
   toObject() {
     return this._batch;
@@ -130243,6 +130294,11 @@ var CheckSettingsAutomationFluent = class extends CheckSettingsBaseFluent {
     return utils14.types.isNumber(value) || utils14.types.isString(value) || this._isElementReference(value);
   }
   region(region) {
+    if (utils14.types.isPlainObject(region) && utils14.types.has(region, "page")) {
+      const { page, ...regionWithoutPage } = region;
+      this._settings.page = page;
+      region = regionWithoutPage;
+    }
     if (this._isSelectorReference(region) && this._isSelectorReference(this._settings.region) && utils14.types.has(this._settings.region, "selector")) {
       let lastSelector = this._settings.region;
       while (lastSelector.shadow)
@@ -130270,7 +130326,15 @@ var CheckSettingsAutomationFluent = class extends CheckSettingsBaseFluent {
     return this;
   }
   frame(contextOrFrame, scrollRootElement) {
+    let page;
+    if (utils14.types.isPlainObject(contextOrFrame) && utils14.types.has(contextOrFrame, "page")) {
+      page = contextOrFrame.page;
+    }
     const context = this._isFrameReference(contextOrFrame) || this._isSelectorReference(contextOrFrame) ? { frame: contextOrFrame, scrollRootElement } : contextOrFrame;
+    if (page) {
+      ;
+      this._settings.page = page;
+    }
     if (!this._settings.frames)
       this._settings.frames = [];
     this._settings.frames.push(context);
@@ -130391,7 +130455,7 @@ var CheckSettingsAutomationFluent = class extends CheckSettingsBaseFluent {
   toJSON() {
     var _a, _b, _c, _d, _e, _f, _g, _h;
     return {
-      target: void 0,
+      target: this._settings.page,
       settings: utils14.general.removeUndefinedProps({
         name: this._settings.name,
         region: this._settings.region ? this.toCoreRegion(this._settings.region) : this._settings.region,
@@ -133349,7 +133413,11 @@ var Eyes = class {
     return this.check({ name, region: selector, timeout, fully: true });
   }
   async checkRegion(imageOrRegion, regionOrName, nameOrTimeout, ignoreMismatch = false) {
-    return utils32.types.has(imageOrRegion, ["x", "y", "width", "height"]) ? this.check({ region: imageOrRegion, name: regionOrName, timeout: nameOrTimeout }) : this.check(
+    return utils32.types.has(imageOrRegion, ["x", "y", "width", "height"]) ? this.check({
+      region: imageOrRegion,
+      name: regionOrName,
+      timeout: nameOrTimeout
+    }) : this.check(
       { image: imageOrRegion },
       { region: regionOrName, name: nameOrTimeout, ignoreMismatch }
     );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-browser",
-  "version": "1.5.20",
+  "version": "1.5.22",
   "keywords": [
     "applitools",
     "browser",
@@ -48,7 +48,7 @@
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/eyes": "1.36.20"
+    "@applitools/eyes": "1.38.0"
   },
   "devDependencies": {
     "@types/node": "^12.20.55",

package/types/Eyes.d.ts

@@ -26,7 +26,8 @@ import { ValidationResult } from './output/ValidationResult';
 import { SessionEventHandler, SessionEventHandlers } from './SessionEventHandlers';
 import { EyesRunner } from './Runners';
 import { Logger } from './Logger';
-export declare class Eyes<TSpec extends Core.SpecType = Core.SpecType> {
+export { CheckSettingsOptIn } from './input/CheckSettings';
+export declare class Eyes<TSpec extends Core.SpecType = Core.SpecType, TCheckSettingsWithAutomation extends CheckSettingsAutomation<TSpec> = CheckSettingsAutomation<TSpec>> {
     protected static readonly _sdk: SDK<Core.SpecType>;
     protected get _sdk(): SDK<TSpec>;
     private _logger;
@@ -102,7 +103,7 @@ export declare class Eyes<TSpec extends Core.SpecType = Core.SpecType> {
     open(appName?: string, testName?: string, viewportSize?: RectangleSize, sessionType?: SessionType): Promise<void>;
     check(name: string, checkSettings: CheckSettingsImageFluent | CheckSettingsAutomationFluent<TSpec>): Promise<MatchResultData>;
     check(target: Image, checkSettings?: CheckSettingsImage): Promise<MatchResultData>;
-    check(checkSettings?: CheckSettingsAutomation<TSpec>): Promise<MatchResultData>;
+    check(checkSettings?: TCheckSettingsWithAutomation): Promise<MatchResultData>;
     /** @deprecated */
     checkWindow(name?: string, timeout?: number, fully?: boolean): Promise<MatchResultData>;
     /** @deprecated */

package/types/SettingsWithPage.d.ts

@@ -0,0 +1 @@
+export { CheckSettingsOptIn as CheckSettings, RegionReferenceWithPage as RegionReference } from './input/CheckSettings';

package/types/input/BatchInfo.d.ts

@@ -6,6 +6,7 @@ export type BatchInfo = {
     startedAt?: Date | string;
     notifyOnCompletion?: boolean;
     properties?: PropertyData[];
+    buildId?: string;
 };
 export declare class BatchInfoData implements Required<BatchInfo> {
     private _batch;
@@ -38,6 +39,10 @@ export declare class BatchInfoData implements Required<BatchInfo> {
     setProperties(properties: PropertyData[]): this;
     addProperty(name: string, value: string): this;
     addProperty(prop: PropertyData): this;
+    get buildId(): string;
+    set buildId(buildId: string);
+    getBuildId(): string;
+    setBuildId(buildId: string): this;
     /** @internal */
     toObject(): BatchInfo;
     /** @internal */

package/types/input/CheckSettings.d.ts

@@ -82,7 +82,7 @@ type LayoutBreakpoints = boolean | number[] | {
     heightBreakpoints: boolean;
     reload?: boolean;
 };
-export type CheckSettingsAutomation<TSpec extends Core.SpecType> = CheckSettingsBase<RegionReference<TSpec>> & {
+export type CheckSettingsAutomation<TSpec extends Core.SpecType, TRegionReference = RegionReference<TSpec>> = CheckSettingsBase<TRegionReference> & {
     frames?: (ContextReference<TSpec> | FrameReference<TSpec>)[];
     webview?: boolean | string;
     scrollRootElement?: ElementReference<TSpec>;
@@ -108,6 +108,31 @@ export type CheckSettingsAutomation<TSpec extends Core.SpecType> = CheckSettings
     waitBeforeCapture?: number | (() => Promise<void>);
     lazyLoad?: boolean | LazyLoadOptions;
 };
+/**
+ * All available opt-in properties for CheckSettings.
+ * Platforms can selectively include these properties as needed.
+ *
+ * @template TSpec - The spec type for the platform
+ */
+type CheckSettingsWithPage<TSpec extends Core.SpecType> = {
+    page?: TSpec['driver'];
+};
+export type RegionReferenceWithPage<TSpec extends Core.SpecType> = (Region & {
+    page?: TSpec['driver'];
+}) | {
+    selector: TSpec['selector'] | string;
+    page?: TSpec['driver'];
+} | ElementReference<TSpec>;
+/**
+ * Opt-in properties for multi-page context support.
+ * Platforms that support multi-page contexts (Playwright, Puppeteer) should include this.
+ *
+ * @template TSpec - The spec type for the platform
+ * @template TKeys - Optional array of property keys to include. If not specified, only 'page' is included.
+ *
+ */
+export type CheckSettingsOptIn<TSpec extends Core.SpecType, TKeys extends readonly (keyof CheckSettingsWithPage<TSpec>)[] = ['page']> = Pick<CheckSettingsWithPage<TSpec>, TKeys[number]>;
+export type CheckSettingsAutomationWithOptIn<TSpec extends Core.SpecType> = CheckSettingsAutomation<TSpec, RegionReferenceWithPage<TSpec>> & CheckSettingsOptIn<TSpec, ['page']>;
 export declare class CheckSettingsBaseFluent<TRegion = never> {
     protected _settings: CheckSettingsBase<TRegion>;
     protected parent?: this;
@@ -192,16 +217,17 @@ export declare class CheckSettingsImageFluent extends CheckSettingsBaseFluent {
         settings: Core.CheckSettings<never, 'classic'>;
     };
 }
-export declare class CheckSettingsAutomationFluent<TSpec extends Core.SpecType = Core.SpecType> extends CheckSettingsBaseFluent<RegionReference<TSpec>> {
+export declare class CheckSettingsAutomationFluent<TSpec extends Core.SpecType = Core.SpecType, TCheckSettingsWithAutomation extends CheckSettingsAutomation<TSpec> = CheckSettingsAutomation<TSpec>> extends CheckSettingsBaseFluent<RegionReference<TSpec>> {
     protected _settings: CheckSettingsAutomation<TSpec>;
     protected static readonly _spec: Core.SpecDriver<Core.SpecType>;
     protected _spec: Core.SpecDriver<TSpec>;
     protected _isElementReference(value: any): value is ElementReference<TSpec>;
     protected _isSelectorReference(selector: any): selector is SelectorReference<TSpec>;
     protected _isFrameReference(value: any): value is FrameReference<TSpec>;
-    constructor(settings?: CheckSettingsAutomation<TSpec> | CheckSettingsAutomationFluent<TSpec>);
+    constructor(settings?: CheckSettingsAutomationFluent<TSpec>);
+    constructor(settings?: TCheckSettingsWithAutomation);
     /** @internal */
-    constructor(settings?: CheckSettingsAutomation<TSpec> | CheckSettingsAutomationFluent<TSpec>, spec?: Core.SpecDriver<TSpec>, parent?: CheckSettingsAutomationFluent<TSpec>);
+    constructor(settings?: TCheckSettingsWithAutomation | CheckSettingsAutomationFluent<TSpec>, spec?: Core.SpecDriver<TSpec>, parent?: CheckSettingsAutomationFluent<TSpec>);
     region(region: RegionReference<TSpec>): this;
     shadow(selector: SelectorReference<TSpec>): typeof this;
     frame(context: ContextReference<TSpec>): this;
@@ -252,7 +278,7 @@ export declare class CheckSettingsAutomationFluent<TSpec extends Core.SpecType =
     };
     /** @internal */
     toJSON(): {
-        target: undefined;
+        target: TSpec['driver'] | undefined;
         settings: Core.CheckSettings<TSpec, 'classic'> & Core.CheckSettings<TSpec, 'ufg'>;
     };
 }
@@ -264,7 +290,7 @@ export type TargetImage = {
     url(imageUrl: URL | string): CheckSettingsImageFluent;
 };
 export declare const TargetImage: TargetImage;
-export type TargetAutomation<TSpec extends Core.SpecType = Core.SpecType> = {
+export type TargetAutomationBase<TSpec extends Core.SpecType = Core.SpecType> = {
     /** @internal */
     spec: Core.SpecDriver<TSpec>;
     window(): CheckSettingsAutomationFluent<TSpec>;
@@ -274,7 +300,8 @@ export type TargetAutomation<TSpec extends Core.SpecType = Core.SpecType> = {
     shadow(selector: SelectorReference<TSpec>): CheckSettingsAutomationFluent<TSpec>;
     webview(webview?: string | boolean): CheckSettingsAutomationFluent<TSpec>;
 };
-export declare const TargetAutomation: TargetAutomation<Core.SpecType>;
+export type TargetAutomation<TSpec extends Core.SpecType = Core.SpecType> = TargetAutomationBase<TSpec>;
+export declare const TargetAutomation: TargetAutomationBase<Core.SpecType>;
 export type Target<TSpec extends Core.SpecType = Core.SpecType> = TargetImage & TargetAutomation<TSpec>;
 export declare const Target: Target<Core.SpecType>;
 export {};