@applitools/eyes-webdriverio 5.35.1 → 5.35.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 (4) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/README.md +29 -2
  3. package/package.json +11 -7
  4. package/types/index.d.ts +14 -12
package/CHANGELOG.md CHANGED
@@ -8,6 +8,36 @@
8
8
 
9
9
 
10
10
 
11
+
12
+
13
+ ## 5.35.4 - 2022/6/17
14
+
15
+ ### Features
16
+ ### Bug fixes
17
+ - Fixed scrolling on some android devices
18
+
19
+ ## 5.35.3 - 2022/6/14
20
+
21
+ ### Features
22
+ - Add special attribute for pseudo elements
23
+ - Add the ability for the SDK to lazy load the page prior to performing a check window
24
+ ### Bug fixes
25
+ - Fix calling `waitBeforeCapture` when failed to set required viewport size
26
+ - Fix rendering issues with Salesforce Lightning design system
27
+ - Fix issue that prevented self-signed certificates from working when connecting through a proxy server
28
+ - Fixed native screenshots of the elements under large collapsing areas
29
+
30
+ ## 5.35.2 - 2022/6/8
31
+
32
+ ### Features
33
+ - Added support for taking full screenshots of elements that are scroll by pages only
34
+ - Allowed `` values in custom properties
35
+ ### Bug fixes
36
+ - Fixed the "Maximum Call Stack Size Exceeded" error when taking screenshots on iOS Safari
37
+ - Fixed an issue with wrong cropped screenshots of elements out of viewport bounds on native devices
38
+ - Fixed broken links to enums implementation in the README.md
39
+ - Fixed `forceFullPageScreenshot` option behavior
40
+
11
41
  ## 5.35.1 - 2022/6/2
12
42
 
13
43
  ### Features
package/README.md CHANGED
@@ -348,6 +348,33 @@ eyes.check(Target.window().variationGroupId('Login button on the right'))
348
348
 
349
349
  _For more information, visit our documentation page: https://applitools.com/docs/features/baseline-variations-groups.html_
350
350
 
351
+ ##### Lazy loading (`lazyLoad`)
352
+
353
+ It's possible to have the SDK scroll the entire page (or a specific length of the page) to make sure all lazyily loaded assets are on the page before performing a check.
354
+
355
+ ```js
356
+ // lazy loads with sensible defaults
357
+ eyes.check(Target.window().lazyLoad())
358
+
359
+ // lazy loads with options specified
360
+ eyes.check(Target.window().lazyLoad({
361
+ maxAmountToScroll: 1000, // total pixels of the page to be scrolled
362
+ scrollLength: 250, // amount of pixels to use for each scroll attempt
363
+ waitingTime: 500, // milliseconds to wait in-between each scroll attempt
364
+ }))
365
+ ```
366
+
367
+ Possible input types are:
368
+
369
+ - nothing (enables sensible defaults)
370
+ - options object (`{maxAmountToScroll, waitingTime, scrollLength}`)
371
+
372
+ Other details:
373
+
374
+ - If an option is omitted, the sensible default for that value will be used
375
+ - The SDK will repeatedly scroll the page using the `scrollLength` until either the page cannot be scrolled further or the `maxAmountToScroll` has been reached (whichever happens first)
376
+ - If more time is needed for additional content to load, then increase the waitingTime to a value higher than 500 milliseconds. If better performance is desired and additional content lazily loads faster than the default waitingTime, then reduce it to a value below 500 milliseconds
377
+
351
378
  ###### Other checkSettings configuration
352
379
 
353
380
  <!-- TODO add explanation -->
@@ -1116,10 +1143,10 @@ configuration.addBrowser({
1116
1143
  eyes.setConfiguration(configuration)
1117
1144
  ```
1118
1145
 
1119
- The list of devices is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-sdk-core/lib/config/IosDeviceName.js
1146
+ The list of devices is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-api/src/enums/IosDeviceName.ts
1120
1147
 
1121
1148
  Possible values for `iosVersion` are:
1122
1149
 
1123
1150
  - `IosVersion.LATEST` - the latest iOS version that's supported by the UFG
1124
1151
  - `IosVersion.LATEST_ONE_VERSION_BACK'` - one version prior to the latest version
1125
- - `undefined` - the UFG's default
1152
+ - `undefined` - the UFG's default
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-webdriverio",
3
- "version": "5.35.1",
3
+ "version": "5.35.4",
4
4
  "description": "Applitools Eyes SDK for WebdriverIO",
5
5
  "keywords": [
6
6
  "eyes-webdriverio",
@@ -27,6 +27,10 @@
27
27
  "name": "Applitools Team",
28
28
  "email": "team@applitools.com"
29
29
  },
30
+ "aliases": [
31
+ "webdriverio",
32
+ "wdio"
33
+ ],
30
34
  "main": "./dist/index.js",
31
35
  "types": "./types/index.d.ts",
32
36
  "exports": {
@@ -111,18 +115,18 @@
111
115
  }
112
116
  },
113
117
  "dependencies": {
114
- "@applitools/eyes-api": "1.5.1",
115
- "@applitools/eyes-sdk-core": "13.6.28",
116
- "@applitools/spec-driver-webdriverio": "1.2.10",
117
- "@applitools/visual-grid-client": "15.12.37"
118
+ "@applitools/eyes-api": "1.7.0",
119
+ "@applitools/eyes-sdk-core": "13.8.2",
120
+ "@applitools/spec-driver-webdriverio": "1.2.12",
121
+ "@applitools/visual-grid-client": "15.12.45"
118
122
  },
119
123
  "devDependencies": {
120
124
  "@applitools/api-extractor": "1.2.8",
121
- "@applitools/bongo": "^2.1.1",
125
+ "@applitools/bongo": "^2.1.5",
122
126
  "@applitools/scripts": "1.1.0",
123
127
  "@applitools/sdk-coverage-tests": "^2.3.18",
124
128
  "@applitools/sdk-shared": "0.9.11",
125
- "@applitools/test-utils": "1.3.2",
129
+ "@applitools/test-utils": "1.3.3",
126
130
  "@types/mocha": "^9.1.1",
127
131
  "@types/node": "12",
128
132
  "@typescript-eslint/eslint-plugin": "^5.27.0",
package/types/index.d.ts CHANGED
@@ -466,10 +466,10 @@ export type CheckSettingsPlain = {
466
466
  enablePatterns?: boolean;
467
467
  ignoreDisplacements?: boolean;
468
468
  ignoreCaret?: boolean;
469
- ignoreRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
470
- layoutRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
471
- strictRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
472
- contentRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
469
+ ignoreRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; }>;
470
+ layoutRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; }>;
471
+ strictRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; }>;
472
+ contentRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; }>;
473
473
  floatingRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
474
474
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
475
475
  maxUpOffset?: number;
@@ -487,6 +487,7 @@ export type CheckSettingsPlain = {
487
487
  variationGroupId?: string;
488
488
  timeout?: number;
489
489
  waitBeforeCapture?: number;
490
+ lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
490
491
  };
491
492
  export class CheckSettings {
492
493
  constructor(settings?: CheckSettingsPlain);
@@ -496,16 +497,16 @@ export class CheckSettings {
496
497
  shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
497
498
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); }): CheckSettings;
498
499
  frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })), scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
499
- ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
500
- ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
500
+ ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; }): CheckSettings;
501
+ ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; }>): CheckSettings;
501
502
  ignore(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
502
503
  ignores(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
503
- layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
504
- layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
505
- strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
506
- strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
507
- contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
508
- contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
504
+ layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; }): CheckSettings;
505
+ layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; }>): CheckSettings;
506
+ strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; }): CheckSettings;
507
+ strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; }>): CheckSettings;
508
+ contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; }): CheckSettings;
509
+ contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; }>): CheckSettings;
509
510
  floatingRegion(region: {
510
511
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
511
512
  maxUpOffset?: number;
@@ -567,6 +568,7 @@ export class CheckSettings {
567
568
  variationGroupId(variationGroupId: string): CheckSettings;
568
569
  timeout(timeout: number): CheckSettings;
569
570
  waitBeforeCapture(waitBeforeCapture: number): CheckSettings;
571
+ lazyLoad(options: { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettings;
570
572
  }
571
573
  export const Target: {
572
574
  window(): CheckSettings;