@applitools/eyes-browser 1.0.3 → 1.0.4

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 (7) hide show
  1. package/CHANGELOG.md +45 -0
  2. package/dist/index.js +452 -410
  3. package/package.json +2 -2
  4. package/types/Eyes.d.ts +9 -5
  5. package/types/enums/AndroidDeviceName.d.ts +22 -15
  6. package/types/enums/DeviceName.d.ts +56 -50
  7. package/types/enums/IosDeviceName.d.ts +39 -34
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-browser",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "keywords": [
5
5
  "applitools",
6
6
  "browser",
@@ -48,7 +48,7 @@
48
48
  "test": "run --top-level mocha './test/**/*.spec.ts'"
49
49
  },
50
50
  "dependencies": {
51
- "@applitools/eyes": "1.13.3"
51
+ "@applitools/eyes": "1.13.4"
52
52
  },
53
53
  "devDependencies": {
54
54
  "@types/node": "^12.20.55",
package/types/Eyes.d.ts CHANGED
@@ -121,18 +121,22 @@ export declare class Eyes<TSpec extends Core.SpecType = Core.SpecType> {
121
121
  checkRegionInFrame(frame: TSpec['element'] | EyesSelector<TSpec['selector']> | string | number, selector: EyesSelector<TSpec['selector']>, timeout?: number, name?: string, fully?: boolean): Promise<MatchResultData>;
122
122
  /** @deprecated */
123
123
  checkImage(image: Buffer | URL | string, name?: string, ignoreMismatch?: boolean): Promise<MatchResultData>;
124
- locate<TLocator extends string>(target: Core.ImageTarget, settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Region[]>>;
124
+ locate<TLocator extends string>(target: Image, settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Region[]>>;
125
+ /** @deprecated */
126
+ locate<TLocator extends string>(settingsWithImage: VisualLocatorSettings<TLocator> & {
127
+ image: Image['image'];
128
+ }): Promise<Record<TLocator, Region[]>>;
125
129
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Region[]>>;
126
- extractTextRegions<TPattern extends string>(target: Core.ImageTarget, settings: OCRSettings<TPattern>): Promise<Record<TPattern, TextRegion[]>>;
130
+ extractTextRegions<TPattern extends string>(target: Image, settings: OCRSettings<TPattern>): Promise<Record<TPattern, TextRegion[]>>;
127
131
  /** @deprecated */
128
132
  extractTextRegions<TPattern extends string>(settingsWithImage: OCRSettings<TPattern> & {
129
- image: Core.ImageTarget['image'];
133
+ image: Image['image'];
130
134
  }): Promise<Record<TPattern, TextRegion[]>>;
131
135
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, TextRegion[]>>;
132
- extractText(target: Core.ImageTarget, settings: OCRRegion<TSpec>[]): Promise<string[]>;
136
+ extractText(target: Image, settings: OCRRegion<TSpec>[]): Promise<string[]>;
133
137
  /** @deprecated */
134
138
  extractText(settingsWithImage: (OCRRegion<never> & {
135
- image: Core.ImageTarget['image'];
139
+ image: Image['image'];
136
140
  })[]): Promise<string[]>;
137
141
  extractText(settings: OCRRegion<TSpec>[]): Promise<string[]>;
138
142
  close(throwErr?: boolean): Promise<TestResultsData>;
package/types/enums/AndroidDeviceName.d.ts CHANGED
@@ -1,27 +1,34 @@
1
1
  export declare enum AndroidDeviceNameEnum {
2
- Pixel_3_XL = "Pixel 3 XL",
3
- Pixel_4 = "Pixel 4",
4
- Pixel_4_XL = "Pixel 4 XL",
5
- Pixel_5 = "Pixel 5",
6
- Pixel_6 = "Pixel 6",
7
- Galaxy_S10 = "Galaxy S10",
8
- Galaxy_S10_Plus = "Galaxy S10 Plus",
9
- Galaxy_Note_10 = "Galaxy Note 10",
10
- Galaxy_Note_10_Plus = "Galaxy Note 10 Plus",
11
2
  Galaxy_S20 = "Galaxy S20",
12
3
  Galaxy_S20_Plus = "Galaxy S20 Plus",
4
+ /** @deprecated use {@link Galaxy_S20_Plus } instead */
5
+ Galaxy_S20_PLUS = "Galaxy S20 Plus",
6
+ Galaxy_S21_Ultra = "Galaxy S21 Ultra",
7
+ /** @deprecated use {@link Galaxy_S21_Ultra } instead */
8
+ Galaxy_S21_ULTRA = "Galaxy S21 Ultra",
9
+ Galaxy_Note_10_Plus = "Galaxy Note 10 Plus",
10
+ Galaxy_S9 = "Galaxy S9",
11
+ Galaxy_S10 = "Galaxy S10",
12
+ Galaxy_S10_Plus = "Galaxy S10 Plus",
13
+ Pixel_4_XL = "Pixel 4 XL",
14
+ Pixel_3_XL = "Pixel 3 XL",
13
15
  Galaxy_S21 = "Galaxy S21",
14
16
  Galaxy_S21_Plus = "Galaxy S21 Plus",
15
- Galaxy_S21_Ultra = "Galaxy S21 Ultra",
17
+ /** @deprecated use {@link Galaxy_S21_Plus } instead */
18
+ Galaxy_S21_PLUS = "Galaxy S21 Plus",
19
+ Xiaomi_Redmi_Note_11_Pro = "Xiaomi Redmi Note 11 Pro",
20
+ Xiaomi_Redmi_Note_11 = "Xiaomi Redmi Note 11",
21
+ Xiaomi_Redmi_Note_10_JE = "Xiaomi Redmi Note 10 JE",
22
+ Pixel_6 = "Pixel 6",
23
+ Galaxy_Note_10 = "Galaxy Note 10",
24
+ Pixel_4 = "Pixel 4",
25
+ Pixel_5 = "Pixel 5",
16
26
  Galaxy_S22 = "Galaxy S22",
17
27
  Galaxy_S22_Plus = "Galaxy S22 Plus",
18
- Galaxy_Tab_S7 = "Galaxy Tab S7",
19
28
  Galaxy_Tab_S8 = "Galaxy Tab S8",
20
- Xiaomi_Redmi_Note_10_JE = "Xiaomi Redmi Note 10 JE",
21
- Xiaomi_Redmi_Note_11 = "Xiaomi Redmi Note 11",
22
- Xiaomi_Redmi_Note_11_Pro = "Xiaomi Redmi Note 11 Pro",
23
- Sony_Xperia_1_II = "Sony Xperia 1 II",
29
+ Galaxy_Tab_S7 = "Galaxy Tab S7",
24
30
  Sony_Xperia_10_II = "Sony Xperia 10 II",
31
+ Sony_Xperia_1_II = "Sony Xperia 1 II",
25
32
  Sony_Xperia_Ace_II = "Sony Xperia Ace II",
26
33
  Huawei_P30_Lite = "Huawei P30 Lite"
27
34
  }
package/types/enums/DeviceName.d.ts CHANGED
@@ -1,71 +1,77 @@
1
1
  export declare enum DeviceNameEnum {
2
- Blackberry_PlayBook = "Blackberry PlayBook",
3
- BlackBerry_Z30 = "BlackBerry Z30",
4
- Galaxy_A5 = "Galaxy A5",
5
- Galaxy_Note_10 = "Galaxy Note 10",
6
- Galaxy_Note_10_Plus = "Galaxy Note 10 Plus",
7
- Galaxy_Note_2 = "Galaxy Note 2",
8
- Galaxy_Note_3 = "Galaxy Note 3",
9
- Galaxy_Note_4 = "Galaxy Note 4",
10
- Galaxy_Note_8 = "Galaxy Note 8",
11
- Galaxy_Note_9 = "Galaxy Note 9",
12
- Galaxy_S3 = "Galaxy S3",
13
- Galaxy_S5 = "Galaxy S5",
14
- Galaxy_S8 = "Galaxy S8",
15
- Galaxy_S8_Plus = "Galaxy S8 Plus",
16
- Galaxy_S9 = "Galaxy S9",
17
- Galaxy_S9_Plus = "Galaxy S9 Plus",
18
- Galaxy_S10 = "Galaxy S10",
19
- Galaxy_S10_Plus = "Galaxy S10 Plus",
20
- Galaxy_S20 = "Galaxy S20",
21
- Galaxy_S21 = "Galaxy S21",
22
- Galaxy_S21_Ultra = "Galaxy S21 Ultra",
23
- Galaxy_S22 = "Galaxy S22",
24
- Galaxy_S22_Ultra = "Galaxy S22 Ultra",
25
- Galaxy_Tab_S7 = "Galaxy Tab S7",
26
- iPad = "iPad",
27
- iPad_6th_Gen = "iPad 6th Gen",
28
- iPad_7th_Gen = "iPad 7th Gen",
29
- iPad_Air_2 = "iPad Air 2",
30
- iPad_Mini = "iPad Mini",
31
- iPad_Pro = "iPad Pro",
32
- iPhone_11 = "iPhone 11",
33
- iPhone_11_Pro = "iPhone 11 Pro",
34
- iPhone_11_Pro_Max = "iPhone 11 Pro Max",
35
2
  iPhone_4 = "iPhone 4",
36
3
  iPhone_5SE = "iPhone 5/SE",
4
+ /** @deprecated use {@link iPhone_5SE } instead */
5
+ iPhone_5S_E = "iPhone 5/SE",
37
6
  iPhone_6_7_8 = "iPhone 6/7/8",
38
7
  iPhone_6_7_8_Plus = "iPhone 6/7/8 Plus",
39
8
  iPhone_X = "iPhone X",
40
- iPhone_XR = "iPhone XR",
41
- iPhone_XS = "iPhone XS",
42
- iPhone_XS_Max = "iPhone XS Max",
43
- Kindle_Fire_HDX = "Kindle Fire HDX",
44
- Laptop_with_HiDPI_screen = "Laptop with HiDPI screen",
45
- Laptop_with_MDPI_screen = "Laptop with MDPI screen",
46
- Laptop_with_touch = "Laptop with touch",
47
- LG_G6 = "LG G6",
48
- LG_Optimus_L70 = "LG Optimus L70",
49
- Microsoft_Lumia_550 = "Microsoft Lumia 550",
50
- Microsoft_Lumia_950 = "Microsoft Lumia 950",
51
- Nexus_10 = "Nexus 10",
9
+ BlackBerry_Z30 = "BlackBerry Z30",
52
10
  Nexus_4 = "Nexus 4",
53
11
  Nexus_5 = "Nexus 5",
54
12
  Nexus_5X = "Nexus 5X",
55
13
  Nexus_6 = "Nexus 6",
56
14
  Nexus_6P = "Nexus 6P",
57
- Nexus_7 = "Nexus 7",
58
- Nokia_Lumia_520 = "Nokia Lumia 520",
59
- Nokia_N9 = "Nokia N9",
60
- OnePlus_7T = "OnePlus 7T",
61
- OnePlus_7T_Pro = "OnePlus 7T Pro",
62
15
  Pixel_2 = "Pixel 2",
63
16
  Pixel_2_XL = "Pixel 2 XL",
17
+ LG_Optimus_L70 = "LG Optimus L70",
18
+ Nokia_N9 = "Nokia N9",
19
+ Nokia_Lumia_520 = "Nokia Lumia 520",
20
+ Microsoft_Lumia_550 = "Microsoft Lumia 550",
21
+ Microsoft_Lumia_950 = "Microsoft Lumia 950",
22
+ Galaxy_S3 = "Galaxy S3",
23
+ Galaxy_S_III = "Galaxy S III",
24
+ Galaxy_S5 = "Galaxy S5",
25
+ Kindle_Fire_HDX = "Kindle Fire HDX",
26
+ iPad_Mini = "iPad Mini",
27
+ iPad = "iPad",
28
+ iPad_Pro = "iPad Pro",
29
+ Blackberry_PlayBook = "Blackberry PlayBook",
30
+ Nexus_10 = "Nexus 10",
31
+ Nexus_7 = "Nexus 7",
32
+ Galaxy_Note_3 = "Galaxy Note 3",
33
+ Galaxy_Note_II = "Galaxy Note II",
34
+ Galaxy_Note_2 = "Galaxy Note 2",
35
+ Galaxy_S20 = "Galaxy S20",
36
+ Galaxy_S22 = "Galaxy S22",
37
+ Galaxy_S21 = "Galaxy S21",
38
+ Galaxy_S21_Ultra = "Galaxy S21 Ultra",
39
+ Galaxy_S22_Ultra = "Galaxy S22 Ultra",
40
+ Laptop_with_touch = "Laptop with touch",
41
+ Laptop_with_HiDPI_screen = "Laptop with HiDPI screen",
42
+ Laptop_with_MDPI_screen = "Laptop with MDPI screen",
43
+ iPhone_XR = "iPhone XR",
44
+ iPhone_XS_Max = "iPhone XS Max",
45
+ iPhone_XS = "iPhone XS",
46
+ Samsung_Galaxy_A5 = "Samsung Galaxy A5",
47
+ Galaxy_A5 = "Galaxy A5",
48
+ Samsung_Galaxy_S8 = "Samsung Galaxy S8",
49
+ Galaxy_S8 = "Galaxy S8",
50
+ LG_G6 = "LG G6",
51
+ iPad_Air_2 = "iPad Air 2",
52
+ iPad_6th_Gen = "iPad 6th Gen",
53
+ iPhone_11 = "iPhone 11",
54
+ iPhone_11_Pro_Max = "iPhone 11 Pro Max",
55
+ iPhone_11_Pro = "iPhone 11 Pro",
56
+ Galaxy_S10 = "Galaxy S10",
57
+ Galaxy_S9_Plus = "Galaxy S9 Plus",
58
+ Galaxy_S9 = "Galaxy S9",
59
+ Galaxy_S10_Plus = "Galaxy S10 Plus",
60
+ Galaxy_S8_Plus = "Galaxy S8 Plus",
61
+ Galaxy_Note_10 = "Galaxy Note 10",
62
+ Galaxy_Note_10_Plus = "Galaxy Note 10 Plus",
63
+ Galaxy_Note_9 = "Galaxy Note 9",
64
+ Galaxy_Note_8 = "Galaxy Note 8",
65
+ Galaxy_Note_4 = "Galaxy Note 4",
64
66
  Pixel_3 = "Pixel 3",
65
67
  Pixel_3_XL = "Pixel 3 XL",
66
68
  Pixel_4 = "Pixel 4",
67
69
  Pixel_4_XL = "Pixel 4 XL",
68
70
  Pixel_5 = "Pixel 5",
71
+ iPad_7th_Gen = "iPad 7th Gen",
72
+ OnePlus_7T = "OnePlus 7T",
73
+ OnePlus_7T_Pro = "OnePlus 7T Pro",
74
+ Galaxy_Tab_S7 = "Galaxy Tab S7",
69
75
  Sony_Xperia_10_II = "Sony Xperia 10 II",
70
76
  Huawei_Mate_50_Pro = "Huawei Mate 50 Pro",
71
77
  Huawei_Matepad_11 = "Huawei Matepad 11"
package/types/enums/IosDeviceName.d.ts CHANGED
@@ -1,4 +1,33 @@
1
1
  export declare enum IosDeviceNameEnum {
2
+ iPad_5 = "iPad (5th generation)",
3
+ iPad_6 = "iPad (6th generation)",
4
+ iPad_7 = "iPad (7th generation)",
5
+ iPad_8 = "iPad (8th generation)",
6
+ iPad_9 = "iPad (9th generation)",
7
+ iPad_10 = "iPad (10th generation)",
8
+ iPad_Air_2 = "iPad Air 2",
9
+ iPad_Air_3 = "iPad Air (3rd generation)",
10
+ iPad_Air_4 = "iPad Air (4th generation)",
11
+ iPad_Air_5 = "iPad Air (5th generation)",
12
+ iPad_mini_4 = "iPad mini 4",
13
+ iPad_mini_5 = "iPad mini (5th generation)",
14
+ iPad_mini_6 = "iPad mini (6th generation)",
15
+ iPad_Pro_9_7_inch_1 = "iPad Pro (9.7-inch)",
16
+ iPad_Pro_10_5_inch_1 = "iPad Pro (10.5-inch)",
17
+ iPad_Pro_11_inch_1 = "iPad Pro (11-inch) (1st generation)",
18
+ iPad_Pro_12_9_inch_1 = "iPad Pro (12.9-inch) (1st generation)",
19
+ iPad_Pro_11_inch_2 = "iPad Pro (11-inch) (2nd generation)",
20
+ iPad_Pro_12_9_inch_2 = "iPad Pro (12.9-inch) (2nd generation)",
21
+ iPad_Pro_11_inch_3 = "iPad Pro (11-inch) (3rd generation)",
22
+ /** @deprecated use {@link iPad_Pro_12_9_inch_3 } instead */
23
+ iPad_Pro_3 = "iPad Pro (12.9-inch) (3rd generation)",
24
+ iPad_Pro_12_9_inch_3 = "iPad Pro (12.9-inch) (3rd generation)",
25
+ /** @deprecated use {@link iPad_Pro_11_inch_4 } instead */
26
+ iPad_Pro_4 = "iPad Pro (11-inch) (4th generation)",
27
+ iPad_Pro_11_inch_4 = "iPad Pro (11-inch) (4th generation)",
28
+ iPad_Pro_12_9_inch_4 = "iPad Pro (12.9-inch) (4th generation)",
29
+ iPad_Pro_12_9_inch_5 = "iPad Pro (12.9-inch) (5th generation)",
30
+ iPad_Pro_12_9_inch_6 = "iPad Pro (12.9-inch) (6th generation)",
2
31
  iPhone_6s = "iPhone 6s",
3
32
  iPhone_6s_Plus = "iPhone 6s Plus",
4
33
  iPhone_7 = "iPhone 7",
@@ -7,58 +36,34 @@ export declare enum IosDeviceNameEnum {
7
36
  iPhone_8_Plus = "iPhone 8 Plus",
8
37
  iPhone_X = "iPhone X",
9
38
  iPhone_XR = "iPhone XR",
10
- iPhone_Xs = "iPhone Xs",
11
- /** @deprecated use {@link iPhone_Xs} instead */
39
+ /** @deprecated use {@link iPhone_Xs } instead */
12
40
  iPhone_XS = "iPhone Xs",
41
+ iPhone_Xs = "iPhone Xs",
13
42
  iPhone_Xs_Max = "iPhone Xs Max",
14
43
  iPhone_11 = "iPhone 11",
15
- iPhone_11_Pro = "iPhone 11 Pro",
16
44
  iPhone_11_Pro_Max = "iPhone 11 Pro Max",
45
+ iPhone_11_Pro = "iPhone 11 Pro",
17
46
  iPhone_12 = "iPhone 12",
18
47
  iPhone_12_mini = "iPhone 12 mini",
19
- iPhone_12_Pro = "iPhone 12 Pro",
20
48
  iPhone_12_Pro_Max = "iPhone 12 Pro Max",
49
+ iPhone_12_Pro = "iPhone 12 Pro",
21
50
  iPhone_13 = "iPhone 13",
22
51
  iPhone_13_mini = "iPhone 13 mini",
23
- iPhone_13_Pro = "iPhone 13 Pro",
24
52
  iPhone_13_Pro_Max = "iPhone 13 Pro Max",
53
+ iPhone_13_Pro = "iPhone 13 Pro",
25
54
  iPhone_14 = "iPhone 14",
26
55
  iPhone_14_Plus = "iPhone 14 Plus",
27
56
  iPhone_14_Pro = "iPhone 14 Pro",
28
57
  iPhone_14_Pro_Max = "iPhone 14 Pro Max",
58
+ iPhone_15 = "iPhone 15",
59
+ iPhone_15_Plus = "iPhone 15 Plus",
60
+ iPhone_15_Pro = "iPhone 15 Pro",
61
+ iPhone_15_Pro_Max = "iPhone 15 Pro Max",
62
+ /** @deprecated use {@link iPhone_SE_1 } instead */
29
63
  iPhone_SE = "iPhone SE (1st generation)",
30
64
  iPhone_SE_1 = "iPhone SE (1st generation)",
31
65
  iPhone_SE_2 = "iPhone SE (2nd generation)",
32
66
  iPhone_SE_3 = "iPhone SE (3rd generation)",
33
- iPad_5 = "iPad (5th generation)",
34
- iPad_6 = "iPad (6th generation)",
35
- iPad_7 = "iPad (7th generation)",
36
- iPad_8 = "iPad (8th generation)",
37
- iPad_9 = "iPad (9th generation)",
38
- iPad_10 = "iPad (10th generation)",
39
- iPad_Air_2 = "iPad Air 2",
40
- iPad_Air_3 = "iPad Air (3rd generation)",
41
- iPad_Air_4 = "iPad Air (4th generation)",
42
- iPad_Air_5 = "iPad Air (5th generation)",
43
- iPad_mini_4 = "iPad mini 4",
44
- iPad_mini_5 = "iPad mini (5th generation)",
45
- iPad_mini_6 = "iPad mini (6th generation)",
46
- iPad_Pro_9_7_inch_1 = "iPad Pro (9.7-inch)",
47
- iPad_Pro_10_5_inch_1 = "iPad Pro (10.5-inch)",
48
- iPad_Pro_11_inch_1 = "iPad Pro (11-inch) (1st generation)",
49
- iPad_Pro_12_9_inch_1 = "iPad Pro (12.9-inch) (1st generation)",
50
- iPad_Pro_11_inch_2 = "iPad Pro (11-inch) (2nd generation)",
51
- iPad_Pro_12_9_inch_2 = "iPad Pro (12.9-inch) (2nd generation)",
52
- iPad_Pro_11_inch_3 = "iPad Pro (11-inch) (3rd generation)",
53
- iPad_Pro_12_9_inch_3 = "iPad Pro (12.9-inch) (3rd generation)",
54
- /** @deprecated use {@link iPad_Pro_12_9_inch_3} instead */
55
- iPad_Pro_3 = "iPad Pro (12.9-inch) (3rd generation)",
56
- iPad_Pro_11_inch_4 = "iPad Pro (11-inch) (4th generation)",
57
- /** @deprecated use {@link iPad_Pro_11_inch_4} instead */
58
- iPad_Pro_4 = "iPad Pro (11-inch) (4th generation)",
59
- iPad_Pro_12_9_inch_4 = "iPad Pro (12.9-inch) (4th generation)",
60
- iPad_Pro_12_9_inch_5 = "iPad Pro (12.9-inch) (5th generation)",
61
- iPad_Pro_12_9_inch_6 = "iPad Pro (12.9-inch) (6th generation)",
62
67
  iPod_touch_7 = "iPod touch (7th generation)"
63
68
  }
64
69
  export type IosDeviceName = `${IosDeviceNameEnum}`;