@applitools/eyes-playwright 1.32.0 → 1.33.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +75 -0
  2. package/dist/fixture/cli.js +1 -1
  3. package/package.json +2 -2
  4. package/types/index.d.ts +12 -52
package/CHANGELOG.md CHANGED
@@ -1,5 +1,80 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.33.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.32.1...js/eyes-playwright@1.33.0) (2024-11-29)
4
+
5
+
6
+ ### Features
7
+
8
+ * offline cli with config ([#2646](https://github.com/Applitools-Dev/sdk/issues/2646)) ([0589dc4](https://github.com/Applitools-Dev/sdk/commit/0589dc429a0c94451e957932106f258dadfd88cc))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * @applitools/core bumped to 4.25.0
14
+ #### Features
15
+
16
+ * offline cli with config ([#2646](https://github.com/Applitools-Dev/sdk/issues/2646)) ([0589dc4](https://github.com/Applitools-Dev/sdk/commit/0589dc429a0c94451e957932106f258dadfd88cc))
17
+ * @applitools/eyes bumped to 1.29.0
18
+ #### Features
19
+
20
+ * offline cli with config ([#2646](https://github.com/Applitools-Dev/sdk/issues/2646)) ([0589dc4](https://github.com/Applitools-Dev/sdk/commit/0589dc429a0c94451e957932106f258dadfd88cc))
21
+
22
+
23
+
24
+
25
+ ## [1.32.1](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.32.0...js/eyes-playwright@1.32.1) (2024-11-27)
26
+
27
+
28
+ ### Bug Fixes
29
+
30
+ * api reference url in playwright config ([c20e2a8](https://github.com/Applitools-Dev/sdk/commit/c20e2a872176e915411784698f1684375de0409a))
31
+
32
+
33
+ ### Dependencies
34
+
35
+ * @applitools/dom-shared bumped to 1.0.16
36
+ #### Bug Fixes
37
+
38
+ * enhance error logging in takeScreenshots and pollify functions ([#2644](https://github.com/Applitools-Dev/sdk/issues/2644)) ([2428fa5](https://github.com/Applitools-Dev/sdk/commit/2428fa500a9fd47a803aa5aca9f79e5c5b3584f9))
39
+ * @applitools/dom-snapshot bumped to 4.11.11
40
+
41
+ * @applitools/req bumped to 1.7.4
42
+ #### Bug Fixes
43
+
44
+ * set heartbeat request timeout as the request interval ([#2587](https://github.com/Applitools-Dev/sdk/issues/2587)) ([0251d27](https://github.com/Applitools-Dev/sdk/commit/0251d27d9ed44ec247732f66904ae3d4fa4123f1))
45
+ * @applitools/core bumped to 4.24.2
46
+ #### Bug Fixes
47
+
48
+ * don't populate branchName and parentBranchName when scm integration exists ([#2634](https://github.com/Applitools-Dev/sdk/issues/2634)) ([e45d671](https://github.com/Applitools-Dev/sdk/commit/e45d671e11ed40a82de1bd5ab22e757aff00b63f))
49
+ * enhance error logging in takeScreenshots and pollify functions ([#2644](https://github.com/Applitools-Dev/sdk/issues/2644)) ([2428fa5](https://github.com/Applitools-Dev/sdk/commit/2428fa500a9fd47a803aa5aca9f79e5c5b3584f9))
50
+
51
+
52
+
53
+ * @applitools/dom-capture bumped to 11.5.2
54
+
55
+ * @applitools/nml-client bumped to 1.8.19
56
+
57
+ * @applitools/tunnel-client bumped to 1.5.10
58
+
59
+ * @applitools/ufg-client bumped to 1.14.1
60
+
61
+ * @applitools/core-base bumped to 1.19.3
62
+ #### Bug Fixes
63
+
64
+ * set heartbeat request timeout as the request interval ([#2587](https://github.com/Applitools-Dev/sdk/issues/2587)) ([0251d27](https://github.com/Applitools-Dev/sdk/commit/0251d27d9ed44ec247732f66904ae3d4fa4123f1))
65
+
66
+
67
+
68
+ * @applitools/ec-client bumped to 1.9.15
69
+
70
+ * @applitools/eyes bumped to 1.28.0
71
+ #### Features
72
+
73
+ * remove Android NMG API ([#2566](https://github.com/Applitools-Dev/sdk/issues/2566)) ([750c0f0](https://github.com/Applitools-Dev/sdk/commit/750c0f0263e5ff06f86055e7ba0c3fb47cadb620))
74
+
75
+
76
+
77
+
3
78
  ## [1.32.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.31.0...js/eyes-playwright@1.32.0) (2024-11-12)
4
79
 
5
80
 
package/dist/fixture/cli.js CHANGED
@@ -89,7 +89,7 @@ async function init(args) {
89
89
  .replace(/(use: {)/, `$1
90
90
  /* Configuration for Eyes VisualAI */
91
91
  eyesConfig: {
92
- /* The following and other configuration parameters are documented at: <url> */
92
+ /* The following and other configuration parameters are documented at: https://applitools.com/tutorials/playwright/api/overview */
93
93
  ${apiKeyStr}, // alternatively, set this via environment variable APPLITOOLS_API_KEY
94
94
  ${serverUrlStr},
95
95
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-playwright",
3
- "version": "1.32.0",
3
+ "version": "1.33.0",
4
4
  "description": "Applitools Eyes SDK for Playwright",
5
5
  "keywords": [
6
6
  "eyes-playwright",
@@ -59,7 +59,7 @@
59
59
  "up:framework": "echo \"$(jq '.devDependencies.playwright = $ENV.APPLITOOLS_FRAMEWORK_VERSION' ./package.json)\" > ./package.json"
60
60
  },
61
61
  "dependencies": {
62
- "@applitools/eyes": "1.27.0",
62
+ "@applitools/eyes": "1.29.0",
63
63
  "@applitools/spec-driver-playwright": "1.5.3",
64
64
  "@applitools/utils": "1.7.5",
65
65
  "@inquirer/prompts": "7.0.1",
package/types/index.d.ts CHANGED
@@ -464,7 +464,7 @@ export type ConfigurationPlain = {
464
464
  baselineEnvName?: undefined | string;
465
465
  batch?: undefined | BatchInfoPlain;
466
466
  branchName?: undefined | string;
467
- browsersInfo?: undefined | Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
467
+ browsersInfo?: undefined | Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
468
468
  captureStatusBar?: undefined | boolean;
469
469
  compareWithParentBranch?: undefined | boolean;
470
470
  concurrentSessions?: undefined | number;
@@ -556,16 +556,14 @@ export class Configuration implements Required<ConfigurationPlain> {
556
556
  set branchName(branchName: string);
557
557
  getBranchName(): string;
558
558
  setBranchName(branchName: string): Configuration;
559
- get browsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
560
- set browsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>);
561
- getBrowsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
562
- setBrowsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
563
- addBrowsers(...browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
564
- addBrowser(browserInfo: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })): Configuration;
559
+ get browsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
560
+ set browsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>);
561
+ getBrowsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
562
+ setBrowsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
563
+ addBrowsers(...browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
564
+ addBrowser(browserInfo: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })): Configuration;
565
565
  addBrowser(width: number, height: number, name?: undefined | BrowserTypePlain): Configuration;
566
566
  addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | ScreenOrientationPlain): Configuration;
567
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
568
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
569
567
  addMultiDeviceTarget(deviceName: "iPhone X"): Configuration;
570
568
  addMultiDeviceTarget(deviceName: "iPhone 14 Plus"): Configuration;
571
569
  addMultiDeviceTarget(deviceName: "iPhone 14 Pro"): Configuration;
@@ -994,49 +992,12 @@ export enum IosDeviceName {
994
992
  iPhone_16_Pro = 'iPhone 16 Pro',
995
993
  iPhone_16_Plus = 'iPhone 16 Plus'
996
994
  }
997
- export type IosVersionPlain = AndroidVersionPlain;
995
+ export type IosVersionPlain = "latest" | "latest-1";
998
996
  export enum IosVersion {
999
997
  LATEST = 'latest',
1000
998
  ONE_VERSION_BACK = 'latest-1',
1001
999
  LATEST_ONE_VERSION_BACK = 'latest-1'
1002
1000
  }
1003
- export type AndroidDeviceNamePlain = "Galaxy S20" | "Galaxy S22" | "Galaxy S21" | "Galaxy S21 Ultra" | "Galaxy S10" | "Galaxy S9" | "Galaxy S10 Plus" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Tab S8" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Galaxy Tab S7" | "Sony Xperia 10 II" | "Galaxy S20 Plus" | "Galaxy S21 Plus" | "Xiaomi Redmi Note 11 Pro" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 10 JE" | "Pixel 6" | "Galaxy S22 Plus" | "Sony Xperia 1 II" | "Sony Xperia Ace II" | "Huawei P30 Lite";
1004
- export enum AndroidDeviceName {
1005
- Galaxy_S20 = 'Galaxy S20',
1006
- Galaxy_S20_Plus = 'Galaxy S20 Plus',
1007
- Galaxy_S20_PLUS = 'Galaxy S20 Plus',
1008
- Galaxy_S21_Ultra = 'Galaxy S21 Ultra',
1009
- Galaxy_S21_ULTRA = 'Galaxy S21 Ultra',
1010
- Galaxy_Note_10_Plus = 'Galaxy Note 10 Plus',
1011
- Galaxy_S9 = 'Galaxy S9',
1012
- Galaxy_S10 = 'Galaxy S10',
1013
- Galaxy_S10_Plus = 'Galaxy S10 Plus',
1014
- Pixel_4_XL = 'Pixel 4 XL',
1015
- Pixel_3_XL = 'Pixel 3 XL',
1016
- Galaxy_S21 = 'Galaxy S21',
1017
- Galaxy_S21_Plus = 'Galaxy S21 Plus',
1018
- Galaxy_S21_PLUS = 'Galaxy S21 Plus',
1019
- Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro',
1020
- Xiaomi_Redmi_Note_11 = 'Xiaomi Redmi Note 11',
1021
- Xiaomi_Redmi_Note_10_JE = 'Xiaomi Redmi Note 10 JE',
1022
- Pixel_6 = 'Pixel 6',
1023
- Galaxy_Note_10 = 'Galaxy Note 10',
1024
- Pixel_4 = 'Pixel 4',
1025
- Pixel_5 = 'Pixel 5',
1026
- Galaxy_S22 = 'Galaxy S22',
1027
- Galaxy_S22_Plus = 'Galaxy S22 Plus',
1028
- Galaxy_Tab_S8 = 'Galaxy Tab S8',
1029
- Galaxy_Tab_S7 = 'Galaxy Tab S7',
1030
- Sony_Xperia_10_II = 'Sony Xperia 10 II',
1031
- Sony_Xperia_1_II = 'Sony Xperia 1 II',
1032
- Sony_Xperia_Ace_II = 'Sony Xperia Ace II',
1033
- Huawei_P30_Lite = 'Huawei P30 Lite'
1034
- }
1035
- export type AndroidVersionPlain = "latest" | "latest-1";
1036
- export enum AndroidVersion {
1037
- LATEST = 'latest',
1038
- ONE_VERSION_BACK = 'latest-1'
1039
- }
1040
1001
  export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Dynamic" | "Exact";
1041
1002
  export enum MatchLevel {
1042
1003
  None = 'None',
@@ -1638,8 +1599,7 @@ export class Region implements Required<RegionPlain> {
1638
1599
  }
1639
1600
  export type DesktopBrowserInfo = { name?: undefined | BrowserTypePlain; width: number; height: number; };
1640
1601
  export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1641
- export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | AndroidVersionPlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1642
- export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | AndroidVersionPlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1602
+ export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | IosVersionPlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1643
1603
  export type RunnerOptionsPlain = { testConcurrency?: undefined | number; fetchConcurrency?: undefined | number; removeDuplicateTests?: undefined | boolean; };
1644
1604
  export class RunnerOptionsFluent {
1645
1605
  testConcurrency(concurrency: number): RunnerOptionsFluent;
@@ -1871,14 +1831,14 @@ export class TestResults implements Required<TestResultsPlain> {
1871
1831
  delete(): Promise<void>;
1872
1832
  deleteSession(): Promise<void>;
1873
1833
  }
1874
- export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }); };
1834
+ export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }); };
1875
1835
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1876
1836
  get testResults(): TestResultsPlain;
1877
1837
  getTestResults(): TestResults;
1878
1838
  get exception(): Error;
1879
1839
  getException(): Error;
1880
- get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1881
- getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1840
+ get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1841
+ getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1882
1842
  }
1883
1843
  export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
1884
1844
  export class TestResultsSummary implements Iterable<TestResultContainer> {