@applitools/eyes 1.36.20 → 1.38.0

package/CHANGELOG.md

@@ -1,5 +1,61 @@
 # Changelog
 
+## [1.38.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.37.0...js/eyes@1.38.0) (2026-01-19)
+
+
+### Features
+
+* multi-page support - FLD-3827 ([#3410](https://github.com/Applitools-Dev/sdk/issues/3410)) ([a55b982](https://github.com/Applitools-Dev/sdk/commit/a55b9827c2218c11da5ed61b38bf12a70ce4c8db))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.15.6
+
+* @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-webdriver bumped to 1.5.5
+
+* @applitools/spec-driver-selenium bumped to 1.7.11
+
+* @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/screenshoter bumped to 3.12.12
+
+* @applitools/nml-client bumped to 1.11.15
+
+* @applitools/ec-client bumped to 1.12.17
+
+* @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))
+
+
+
+
+## [1.37.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.36.20...js/eyes@1.37.0) (2026-01-14)
+
+
+### 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))
+
+
+### 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))
+
 ## [1.36.20](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.36.19...js/eyes@1.36.20) (2026-01-11)
 
 

package/dist/Eyes.js

@@ -291,7 +291,11 @@ class Eyes {
     }
     async checkRegion(imageOrRegion, regionOrName, nameOrTimeout, ignoreMismatch = false) {
         return utils.types.has(imageOrRegion, ['x', 'y', 'width', 'height'])
-            ? this.check({ region: imageOrRegion, name: regionOrName, timeout: nameOrTimeout })
+            ? this.check({
+                region: imageOrRegion,
+                name: regionOrName,
+                timeout: nameOrTimeout,
+            })
             : this.check({ image: imageOrRegion }, { region: regionOrName, name: nameOrTimeout, ignoreMismatch });
     }
     /** @deprecated */

package/dist/SettingsWithPage.js

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

package/dist/input/BatchInfo.js

@@ -37,6 +37,7 @@ class BatchInfoData {
         utils.guard.isString(batch.sequenceName, { name: 'sequenceName', strict: false });
         utils.guard.isBoolean(batch.notifyOnCompletion, { name: 'notifyOnCompletion', strict: false });
         utils.guard.isArray(batch.properties, { name: 'properties', strict: false });
+        utils.guard.isString(batch.buildId, { name: 'buildId', strict: false });
         this._batch = {
             id: (_b = (_a = batch.id) !== null && _a !== void 0 ? _a : utils.general.getEnvValue('BATCH_ID')) !== null && _b !== void 0 ? _b : `generated-${utils.general.guid()}`,
             name: (_c = batch.name) !== null && _c !== void 0 ? _c : utils.general.getEnvValue('BATCH_NAME'),
@@ -44,6 +45,7 @@ class BatchInfoData {
             startedAt: (_e = batch.startedAt) !== null && _e !== void 0 ? _e : new Date(),
             notifyOnCompletion: (_g = (_f = batch.notifyOnCompletion) !== null && _f !== void 0 ? _f : utils.general.getEnvValue('BATCH_NOTIFY', 'boolean')) !== null && _g !== void 0 ? _g : false,
             properties: batch.properties,
+            buildId: batch.buildId,
         };
     }
     get id() {
@@ -137,6 +139,20 @@ class BatchInfoData {
         this.properties.push(property);
         return this;
     }
+    get buildId() {
+        return this._batch.buildId;
+    }
+    set buildId(buildId) {
+        utils.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;

package/dist/input/CheckSettings.js

@@ -458,6 +458,12 @@ class CheckSettingsAutomationFluent extends CheckSettingsBaseFluent {
         return self;
     }
     region(region) {
+        // Extract page if present (opt-in for multi-page contexts)
+        if (utils.types.isPlainObject(region) && utils.types.has(region, 'page')) {
+            const { page, ...regionWithoutPage } = region;
+            this._settings.page = page;
+            region = regionWithoutPage;
+        }
         if (this._isSelectorReference(region) &&
             this._isSelectorReference(this._settings.region) &&
             utils.types.has(this._settings.region, 'selector')) {
@@ -489,9 +495,20 @@ class CheckSettingsAutomationFluent extends CheckSettingsBaseFluent {
         return this;
     }
     frame(contextOrFrame, scrollRootElement) {
+        // Extract page if present in object form
+        let page;
+        if (utils.types.isPlainObject(contextOrFrame) && utils.types.has(contextOrFrame, 'page')) {
+            page = contextOrFrame.page;
+        }
+        // Normalize to ContextReference
         const context = this._isFrameReference(contextOrFrame) || this._isSelectorReference(contextOrFrame)
             ? { frame: contextOrFrame, scrollRootElement }
             : contextOrFrame;
+        // Set page if provided (opt-in for multi-page contexts)
+        if (page) {
+            ;
+            this._settings.page = page;
+        }
         if (!this._settings.frames)
             this._settings.frames = [];
         this._settings.frames.push(context);
@@ -616,7 +633,7 @@ class CheckSettingsAutomationFluent extends CheckSettingsBaseFluent {
     toJSON() {
         var _a, _b, _c, _d, _e, _f, _g, _h;
         return {
-            target: undefined,
+            target: this._settings.page,
             settings: utils.general.removeUndefinedProps({
                 name: this._settings.name,
                 region: this._settings.region ? this.toCoreRegion(this._settings.region) : this._settings.region,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes",
-  "version": "1.36.20",
+  "version": "1.38.0",
   "keywords": [
     "applitools",
     "eyes",
@@ -30,6 +30,10 @@
       "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"
   },
@@ -46,7 +50,7 @@
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/core": "4.54.2",
+    "@applitools/core": "4.55.0",
     "@applitools/logger": "2.2.7",
     "@applitools/utils": "1.14.1",
     "chalk": "4.1.2",

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 {};