@applitools/eyes-browser 1.5.15 → 1.5.16

package/package.json

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

package/types/enums/AndroidMultiDeviceTarget.d.ts

@@ -0,0 +1,9 @@
+import { AndroidDeviceTarget } from '../input/AndroidDeviceTarget';
+export declare const AndroidMultiDeviceTarget: {
+    readonly Galaxy_S25: AndroidDeviceTarget;
+    readonly Galaxy_S25_Ultra: AndroidDeviceTarget;
+    readonly Pixel_9: AndroidDeviceTarget;
+};
+export type AndroidDeviceTargetKeys = keyof typeof AndroidMultiDeviceTarget;
+export type AndroidDeviceTargetValues = AndroidDeviceTarget;
+export type AndroidDeviceTargetNames = 'Galaxy S25' | 'Galaxy S25 Ultra' | 'Pixel 9';

package/types/enums/IosDeviceName.d.ts

@@ -4,12 +4,17 @@ export declare enum IosDeviceNameEnum {
     iPad_10 = "iPad (10th generation)",
     iPad_mini_6 = "iPad mini (6th generation)",
     iPad_Air_4 = "iPad Air (4th generation)",
+    iPad_Air_11_inch_M3 = "iPad Air 11-inch (M3)",
+    iPad_Air_13_inch_M3 = "iPad Air 13-inch (M3)",
+    iPad_A16 = "iPad (A16)",
     /** @deprecated use {@link iPad_Pro_12_9_inch_3 } instead */
     iPad_Pro_3 = "iPad Pro (12.9-inch) (3rd generation)",
-    iPad_Pro_12_9_inch_3 = "iPad Pro (12.9-inch) (3rd generation)",
     /** @deprecated use {@link iPad_Pro_11_inch_4 } instead */
     iPad_Pro_4 = "iPad Pro (11-inch) (4th generation)",
     iPad_Pro_11_inch_4 = "iPad Pro (11-inch) (4th generation)",
+    iPad_Pro_11_inch_M5 = "iPad Pro 11-inch (M5)",
+    iPad_Pro_13_inch_M5 = "iPad Pro 13-inch (M5)",
+    iPad_Pro_12_9_inch_3 = "iPad Pro (12.9-inch) (3rd generation)",
     iPhone_SE_2 = "iPhone SE (2nd generation)",
     iPhone_SE_3 = "iPhone SE (3rd generation)",
     iPhone_XR = "iPhone XR",
@@ -38,6 +43,10 @@ export declare enum IosDeviceNameEnum {
     iPhone_16 = "iPhone 16",
     iPhone_16_Pro_Max = "iPhone 16 Pro Max",
     iPhone_16_Pro = "iPhone 16 Pro",
-    iPhone_16_Plus = "iPhone 16 Plus"
+    iPhone_16_Plus = "iPhone 16 Plus",
+    iPhone_17 = "iPhone 17",
+    iPhone_17_Pro = "iPhone 17 Pro",
+    iPhone_17_Pro_Max = "iPhone 17 Pro Max",
+    iPhone_Air = "iPhone Air"
 }
 export type IosDeviceName = `${IosDeviceNameEnum}`;

package/types/enums/IosMultiDeviceTarget.d.ts

@@ -1,39 +1,42 @@
-export declare enum IosMultiDeviceTargetEnum {
-    iPhone_SE_1 = "iPhone SE (1st generation)",
-    iPhone_SE_2 = "iPhone SE (2nd generation)",
-    iPhone_SE_3 = "iPhone SE (3rd generation)",
-    iPhone_6 = "iPhone 6",
-    iPhone_6_Plus = "iPhone 6 Plus",
-    iPhone_7 = "iPhone 7",
-    iPhone_7_Plus = "iPhone 7 Plus",
-    iPhone_8 = "iPhone 8",
-    iPhone_8_Plus = "iPhone 8 Plus",
-    iPhone_X = "iPhone X",
-    iPhone_XR = "iPhone XR",
-    iPhone_Xs = "iPhone Xs",
-    iPhone_Xs_Max = "iPhone Xs Max",
-    iPhone_11 = "iPhone 11",
-    iPhone_11_Pro = "iPhone 11 Pro",
-    iPhone_11_Pro_Max = "iPhone 11 Pro Max",
-    iPhone_12 = "iPhone 12",
-    iPhone_12_mini = "iPhone 12 mini",
-    iPhone_12_Pro = "iPhone 12 Pro",
-    iPhone_12_Pro_Max = "iPhone 12 Pro Max",
-    iPhone_13 = "iPhone 13",
-    iPhone_13_mini = "iPhone 13 mini",
-    iPhone_13_Pro = "iPhone 13 Pro",
-    iPhone_13_Pro_Max = "iPhone 13 Pro Max",
-    iPhone_14 = "iPhone 14",
-    iPhone_14_Pro = "iPhone 14 Pro",
-    iPhone_14_Plus = "iPhone 14 Plus",
-    iPhone_14_Pro_Max = "iPhone 14 Pro Max",
-    iPhone_15 = "iPhone 15",
-    iPhone_15_Pro = "iPhone 15 Pro",
-    iPhone_15_Plus = "iPhone 15 Plus",
-    iPhone_15_Pro_Max = "iPhone 15 Pro Max",
-    iPhone_16 = "iPhone 16",
-    iPhone_16_Pro = "iPhone 16 Pro",
-    iPhone_16_Plus = "iPhone 16 Plus",
-    iPhone_16_Pro_Max = "iPhone 16 Pro Max"
-}
-export type IosMultiDeviceTarget = `${IosMultiDeviceTargetEnum}`;
+import { IosDeviceTarget } from '../input/IosDeviceTarget';
+export declare const IosMultiDeviceTarget: {
+    readonly iPhone_SE_1: IosDeviceTarget;
+    readonly iPhone_SE_2: IosDeviceTarget;
+    readonly iPhone_SE_3: IosDeviceTarget;
+    readonly iPhone_6: IosDeviceTarget;
+    readonly iPhone_6_Plus: IosDeviceTarget;
+    readonly iPhone_7: IosDeviceTarget;
+    readonly iPhone_7_Plus: IosDeviceTarget;
+    readonly iPhone_8: IosDeviceTarget;
+    readonly iPhone_8_Plus: IosDeviceTarget;
+    readonly iPhone_X: IosDeviceTarget;
+    readonly iPhone_XR: IosDeviceTarget;
+    readonly iPhone_Xs: IosDeviceTarget;
+    readonly iPhone_Xs_Max: IosDeviceTarget;
+    readonly iPhone_11: IosDeviceTarget;
+    readonly iPhone_11_Pro: IosDeviceTarget;
+    readonly iPhone_11_Pro_Max: IosDeviceTarget;
+    readonly iPhone_12: IosDeviceTarget;
+    readonly iPhone_12_mini: IosDeviceTarget;
+    readonly iPhone_12_Pro: IosDeviceTarget;
+    readonly iPhone_12_Pro_Max: IosDeviceTarget;
+    readonly iPhone_13: IosDeviceTarget;
+    readonly iPhone_13_mini: IosDeviceTarget;
+    readonly iPhone_13_Pro: IosDeviceTarget;
+    readonly iPhone_13_Pro_Max: IosDeviceTarget;
+    readonly iPhone_14: IosDeviceTarget;
+    readonly iPhone_14_Pro: IosDeviceTarget;
+    readonly iPhone_14_Plus: IosDeviceTarget;
+    readonly iPhone_14_Pro_Max: IosDeviceTarget;
+    readonly iPhone_15: IosDeviceTarget;
+    readonly iPhone_15_Pro: IosDeviceTarget;
+    readonly iPhone_15_Plus: IosDeviceTarget;
+    readonly iPhone_15_Pro_Max: IosDeviceTarget;
+    readonly iPhone_16: IosDeviceTarget;
+    readonly iPhone_16_Pro: IosDeviceTarget;
+    readonly iPhone_16_Plus: IosDeviceTarget;
+    readonly iPhone_16_Pro_Max: IosDeviceTarget;
+};
+export type IosDeviceTargetKeys = keyof typeof IosMultiDeviceTarget;
+export type IosDeviceTargetValues = IosDeviceTarget;
+export type IosDeviceTargetNames = 'iPhone SE (1st generation)' | 'iPhone SE (2nd generation)' | 'iPhone SE (3rd generation)' | 'iPhone 6' | 'iPhone 6 Plus' | 'iPhone 7' | 'iPhone 7 Plus' | 'iPhone 8' | 'iPhone 8 Plus' | 'iPhone X' | 'iPhone XR' | 'iPhone Xs' | 'iPhone Xs Max' | 'iPhone 11' | 'iPhone 11 Pro' | 'iPhone 11 Pro Max' | 'iPhone 12' | 'iPhone 12 mini' | 'iPhone 12 Pro' | 'iPhone 12 Pro Max' | 'iPhone 13' | 'iPhone 13 mini' | 'iPhone 13 Pro' | 'iPhone 13 Pro Max' | 'iPhone 14' | 'iPhone 14 Pro' | 'iPhone 14 Plus' | 'iPhone 14 Pro Max' | 'iPhone 15' | 'iPhone 15 Pro' | 'iPhone 15 Plus' | 'iPhone 15 Pro Max' | 'iPhone 16' | 'iPhone 16 Pro' | 'iPhone 16 Plus' | 'iPhone 16 Pro Max';

package/types/index.d.ts

@@ -3,6 +3,10 @@ export { CorsIframeHandle as CorsIframeHandlePlain, CorsIframeHandleEnum as Cors
 export { DeviceName as DeviceNamePlain, DeviceNameEnum as DeviceName } from './enums/DeviceName';
 export { FailureReport as FailureReportPlain, FailureReportEnum as FailureReport } from './enums/FailureReport';
 export { IosDeviceName as IosDeviceNamePlain, IosDeviceNameEnum as IosDeviceName } from './enums/IosDeviceName';
+export { IosMultiDeviceTarget, IosDeviceTargetNames, IosDeviceTargetKeys, IosDeviceTargetValues, } from './enums/IosMultiDeviceTarget';
+export { AndroidMultiDeviceTarget, AndroidDeviceTargetNames, AndroidDeviceTargetKeys, AndroidDeviceTargetValues, } from './enums/AndroidMultiDeviceTarget';
+export { IosDeviceTarget } from './input/IosDeviceTarget';
+export { AndroidDeviceTarget } from './input/AndroidDeviceTarget';
 export { IosVersion as IosVersionPlain, IosVersionEnum as IosVersion } from './enums/IosVersion';
 export { MatchLevel as MatchLevelPlain, MatchLevelEnum as MatchLevel } from './enums/MatchLevel';
 export { ScreenOrientation as ScreenOrientationPlain, ScreenOrientationEnum as ScreenOrientation, } from './enums/ScreenOrientation';
@@ -37,7 +41,7 @@ export { PropertyData as PropertyDataPlain, PropertyDataData as PropertyData } f
 export { ProxySettings as ProxySettingsPlain, ProxySettingsData as ProxySettings } from './input/ProxySettings';
 export { RectangleSize as RectangleSizePlain, RectangleSizeData as RectangleSize } from './input/RectangleSize';
 export { Region as RegionPlain, LegacyRegion as LegacyRegionPlain, RegionData as Region } from './input/Region';
-export { DesktopBrowserInfo, ChromeEmulationInfo, IOSDeviceInfo, IOSMultiDeviceInfo } from './input/RenderInfo';
+export { DesktopBrowserInfo, ChromeEmulationInfo, IOSDeviceInfo, IOSMultiDeviceInfo, AndroidMultiDeviceInfo, } from './input/RenderInfo';
 export { RunnerOptions as RunnerOptionsPlain, RunnerOptionsFluent, RunnerOptionsFluentInit as RunnerOptions, } from './input/RunnerOptions';
 export { VisualLocatorSettings } from './input/VisualLocatorSettings';
 export { ApiUrls as ApiUrlsPlain, ApiUrlsData as ApiUrls } from './output/ApiUrls';

package/types/input/AndroidDeviceTarget.d.ts

@@ -0,0 +1,35 @@
+import { ScreenOrientationEnum as ScreenOrientation } from '../enums/ScreenOrientation';
+/**
+ * Represents an Android device target with optional orientation configuration.
+ * This class provides a fluent API for specifying device orientation.
+ */
+export declare class AndroidDeviceTarget {
+    readonly deviceName: string;
+    private screenOrientation?;
+    constructor(deviceName: string);
+    /**
+     * Sets the device orientation to landscape.
+     * @returns this instance for method chaining
+     */
+    landscape(): this;
+    /**
+     * Sets the device orientation to portrait.
+     * @returns this instance for method chaining
+     */
+    portrait(): this;
+    /**
+     * Gets the configured orientation for this device target.
+     * @returns the screen orientation, or undefined if not set
+     */
+    getOrientation(): ScreenOrientation | undefined;
+    /**
+     * Gets the device name.
+     * @returns the device name string
+     */
+    getDeviceName(): string;
+    /**
+     * String representation of this device target.
+     * @returns the device name
+     */
+    toString(): string;
+}

package/types/input/Configuration.d.ts

@@ -5,7 +5,10 @@ import { StitchMode, StitchModeEnum } from '../enums/StitchMode';
 import { MatchLevel, MatchLevelEnum } from '../enums/MatchLevel';
 import { BrowserType } from '../enums/BrowserType';
 import { DeviceName } from '../enums/DeviceName';
-import { IosMultiDeviceTarget } from '../enums/IosMultiDeviceTarget';
+import type { IosDeviceTargetNames } from '../enums/IosMultiDeviceTarget';
+import type { AndroidDeviceTargetNames } from '../enums/AndroidMultiDeviceTarget';
+import { IosDeviceTarget } from './IosDeviceTarget';
+import { AndroidDeviceTarget } from './AndroidDeviceTarget';
 import { ScreenOrientation } from '../enums/ScreenOrientation';
 import { AccessibilitySettings } from './AccessibilitySettings';
 import { RenderInfo, RenderInfoLegacy } from './RenderInfo';
@@ -19,6 +22,7 @@ import { BatchInfo, BatchInfoData } from './BatchInfo';
 import { PropertyData, PropertyDataData } from './PropertyData';
 import { ImageMatchSettings } from './ImageMatchSettings';
 import { LatestCommitInfo } from './LatestCommitInfo';
+type MultiDeviceTargetTypes = IosDeviceTargetNames | AndroidDeviceTargetNames | IosDeviceTarget | AndroidDeviceTarget;
 export type Configuration<TSpec extends Core.SpecType = Core.SpecType> = {
     accessibilityValidation?: AccessibilitySettings;
     agentId?: string;
@@ -149,7 +153,39 @@ export declare class ConfigurationData<TSpec extends Core.SpecType = Core.SpecTy
     addBrowser(browserInfo: RenderInfoLegacy): this;
     addBrowser(width: number, height: number, name?: BrowserType): this;
     addDeviceEmulation(deviceName: DeviceName, screenOrientation?: ScreenOrientation): this;
-    addMultiDeviceTarget(deviceName: IosMultiDeviceTarget): this;
+    /**
+     * Add iOS and/or Android devices for multi-device testing.
+     *
+     * @param devices - Device targets. Supports three formats:
+     *   - Plain strings: `'iPhone 13'`, `'Galaxy S25'`
+     *   - Enum values: `IosMultiDeviceTarget.iPhone_13`, `AndroidMultiDeviceTarget.Galaxy_S25`
+     *   - Fluent API: `IosMultiDeviceTarget.iPhone_13.landscape()`, `AndroidMultiDeviceTarget.Galaxy_S25.portrait()`
+     *
+     * @example
+     * ```typescript
+     * // Plain strings (backward compatible)
+     * config.addMultiDeviceTarget('iPhone 13', 'Galaxy S25')
+     *
+     * // Enum values
+     * config.addMultiDeviceTarget(IosMultiDeviceTarget.iPhone_13, AndroidMultiDeviceTargetEnum.Galaxy_S25)
+     *
+     * // Fluent API with orientation
+     * config.addMultiDeviceTarget(
+     *   IosMultiDeviceTarget.iPhone_13.landscape(),
+     *   AndroidMultiDeviceTarget.Galaxy_S25.portrait()
+     * )
+     *
+     * // Mix all three styles
+     * config.addMultiDeviceTarget(
+     *   'iPhone 14',
+     *   IosMultiDeviceTarget.iPhone_15,
+     *   IosMultiDeviceTarget.iPhone_16.landscape()
+     * )
+     * ```
+     */
+    addMultiDeviceTarget(...devices: MultiDeviceTargetTypes[]): this;
+    private _isIosDevice;
+    private _isAndroidDevice;
     get captureStatusBar(): boolean;
     set captureStatusBar(captureStatusBar: boolean);
     getCaptureStatusBar(): boolean;
@@ -435,3 +471,4 @@ export declare class ConfigurationData<TSpec extends Core.SpecType = Core.SpecTy
     /** @internal */
     toString(): string;
 }
+export {};

package/types/input/IosDeviceTarget.d.ts

@@ -0,0 +1,35 @@
+import { ScreenOrientationEnum as ScreenOrientation } from '../enums/ScreenOrientation';
+/**
+ * Represents an iOS device target with optional orientation configuration.
+ * This class provides a fluent API for specifying device orientation.
+ */
+export declare class IosDeviceTarget {
+    readonly deviceName: string;
+    private screenOrientation?;
+    constructor(deviceName: string);
+    /**
+     * Sets the device orientation to landscape.
+     * @returns this instance for method chaining
+     */
+    landscape(): this;
+    /**
+     * Sets the device orientation to portrait.
+     * @returns this instance for method chaining
+     */
+    portrait(): this;
+    /**
+     * Gets the configured orientation for this device target.
+     * @returns the screen orientation, or undefined if not set
+     */
+    getOrientation(): ScreenOrientation | undefined;
+    /**
+     * Gets the device name.
+     * @returns the device name string
+     */
+    getDeviceName(): string;
+    /**
+     * String representation of this device target.
+     * @returns the device name
+     */
+    toString(): string;
+}

package/types/input/RenderInfo.d.ts

@@ -3,7 +3,8 @@ import { DeviceName } from '../enums/DeviceName';
 import { IosDeviceName } from '../enums/IosDeviceName';
 import { IosVersion } from '../enums/IosVersion';
 import { ScreenOrientation } from '../enums/ScreenOrientation';
-import { IosMultiDeviceTarget } from '../enums/IosMultiDeviceTarget';
+import type { IosDeviceTargetNames } from '../enums/IosMultiDeviceTarget';
+import type { AndroidDeviceTargetNames } from '../enums/AndroidMultiDeviceTarget';
 type RenderInfoBase = {
     /** @internal */
     hostOS?: string;
@@ -39,9 +40,16 @@ export type IOSDeviceInfo = {
 };
 export type IOSMultiDeviceInfo = {
     iosDeviceInfo: {
-        deviceName: IosMultiDeviceTarget;
+        deviceName: IosDeviceTargetNames;
+        screenOrientation?: ScreenOrientation;
+    };
+};
+export type AndroidMultiDeviceInfo = {
+    androidDeviceInfo: {
+        deviceName: AndroidDeviceTargetNames;
+        screenOrientation?: ScreenOrientation;
     };
 };
 export type RenderInfoLegacy = RenderInfoBase & (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | ChromeEmulationInfoLegacy);
-export type RenderInfo = RenderInfoBase & (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | IOSMultiDeviceInfo);
+export type RenderInfo = RenderInfoBase & (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | IOSMultiDeviceInfo | AndroidMultiDeviceInfo);
 export {};