@applitools/eyes-puppeteer 1.15.1 → 1.16.1

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 +13 -0
  2. package/dist/api.js +4 -4
  3. package/package.json +6 -6
  4. package/types/index.d.ts +329 -53
package/CHANGELOG.md CHANGED
@@ -11,6 +11,19 @@
11
11
 
12
12
 
13
13
 
14
+ ## 1.16.1 - 2023/5/3
15
+
16
+ ### Features
17
+ ### Bug fixes
18
+ - Fixed detection of emulated mobile drivers
19
+ - Fixed issue when on certain browser versions test didn't target a previously created baseline
20
+
21
+ ## 1.16.0 - 2023/4/26
22
+
23
+ ### Features
24
+ - Make `locate` to return coordinates that could be directly used with the driver
25
+ ### Bug fixes
26
+
14
27
  ## 1.15.1 - 2023/4/6
15
28
 
16
29
  ### Features
package/dist/api.js CHANGED
@@ -33,12 +33,12 @@ __exportStar(require("@applitools/eyes"), exports);
33
33
  const sdk = { agentId: `eyes.puppeteer/${require('../package.json').version}`, spec };
34
34
  class Eyes extends eyes.Eyes {
35
35
  }
36
- exports.Eyes = Eyes;
37
36
  Eyes._sdk = sdk;
37
+ exports.Eyes = Eyes;
38
38
  class CheckSettingsAutomation extends eyes.CheckSettingsAutomation {
39
39
  }
40
- exports.CheckSettingsAutomation = CheckSettingsAutomation;
41
40
  CheckSettingsAutomation._spec = spec;
41
+ exports.CheckSettingsAutomation = CheckSettingsAutomation;
42
42
  class CheckSettings extends CheckSettingsAutomation {
43
43
  }
44
44
  exports.CheckSettings = CheckSettings;
@@ -46,10 +46,10 @@ exports.TargetAutomation = { ...eyes.TargetAutomation, spec };
46
46
  exports.Target = { ...eyes.Target, spec };
47
47
  class Configuration extends eyes.Configuration {
48
48
  }
49
- exports.Configuration = Configuration;
50
49
  Configuration._spec = spec;
50
+ exports.Configuration = Configuration;
51
51
  class BatchClose extends eyes.BatchClose {
52
52
  }
53
- exports.BatchClose = BatchClose;
54
53
  BatchClose._sdk = sdk;
54
+ exports.BatchClose = BatchClose;
55
55
  exports.closeBatch = eyes.closeBatch(sdk);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-puppeteer",
3
- "version": "1.15.1",
3
+ "version": "1.16.1",
4
4
  "description": "Applitools Eyes SDK for Puppeteer",
5
5
  "keywords": [
6
6
  "eyes-puppeteer",
@@ -39,7 +39,7 @@
39
39
  ],
40
40
  "scripts": {
41
41
  "lint": "node ../../node_modules/.bin/eslint '**/*.ts'",
42
- "build": "node ../../node_modules/.bin/ttsc --project ./tsconfig.build.json",
42
+ "build": "node ../../node_modules/.bin/tspc --project ./tsconfig.build.json",
43
43
  "generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes-puppeteer'",
44
44
  "test": "yarn test:coverage",
45
45
  "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-puppeteer' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage node ../../node_modules/.bin/mocha './test/generic/*.spec.js' --parallel --jobs ${MOCHA_JOBS:-15} --exit",
@@ -55,13 +55,13 @@
55
55
  "postpublish": "bongo send-release-notification --name 'puppeteer'"
56
56
  },
57
57
  "dependencies": {
58
- "@applitools/eyes": "1.1.3",
59
- "@applitools/spec-driver-puppeteer": "1.1.52"
58
+ "@applitools/eyes": "1.2.7",
59
+ "@applitools/spec-driver-puppeteer": "1.1.59"
60
60
  },
61
61
  "devDependencies": {
62
- "@applitools/api-extractor": "1.2.12",
62
+ "@applitools/api-extractor": "1.2.21",
63
63
  "@applitools/bongo": "^3.0.3",
64
- "@applitools/sdk-coverage-tests": "3.0.1",
64
+ "@applitools/sdk-coverage-tests": "3.0.2",
65
65
  "@applitools/test-utils": "1.5.16",
66
66
  "@types/node": "^12.20.55",
67
67
  "puppeteer": "^18.0.5"
package/types/index.d.ts CHANGED
@@ -20,12 +20,26 @@ export class Eyes {
20
20
  setConfiguration(config: ConfigurationPlain): void;
21
21
  get isOpen(): boolean;
22
22
  getIsOpen(): boolean;
23
+ on(handler: (event: string, data?: undefined | Record<string, any>) => any): () => void;
24
+ on(event: "setSizeWillStart", handler: (data: { viewportSize: RectangleSizePlain; }) => any): () => void;
25
+ on(event: "setSizeEnded", handler: () => any): () => void;
26
+ on(event: "initStarted", handler: () => any): () => void;
27
+ on(event: "initEnded", handler: () => any): () => void;
28
+ on(event: "testStarted", handler: (data: { sessionId: string; }) => any): () => void;
29
+ on(event: "validationWillStart", handler: (data: { sessionId: string; validationInfo: ValidationInfoPlain; }) => any): () => void;
30
+ on(event: "validationEnded", handler: (data: { sessionId: string; validationId: number; validationResult: ValidationResultPlain; }) => any): () => void;
31
+ on(event: "testEnded", handler: (data: { sessionId: string; testResults: TestResultsPlain; }) => any): () => void;
32
+ off(event: string): void;
33
+ off(handler: (...args: Array<any>) => any): void;
23
34
  getExecutionCloudUrl(): Promise<string>;
24
35
  open(driver: Driver, config?: undefined | ConfigurationPlain): Promise<Driver>;
25
- open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<Driver>;
36
+ open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL"): Promise<Driver>;
37
+ open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "PROGRESSION"): Promise<Driver>;
26
38
  open(config?: undefined | ConfigurationPlain): Promise<void>;
27
- open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<void>;
28
- check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<MatchResult>;
39
+ open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL"): Promise<void>;
40
+ open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "PROGRESSION"): Promise<void>;
41
+ check(name: string, checkSettings: CheckSettingsImage): Promise<MatchResult>;
42
+ check(name: string, checkSettings: CheckSettingsAutomation): Promise<MatchResult>;
29
43
  check(target: {
30
44
  image: string | URL | Buffer;
31
45
  name?: undefined | string;
@@ -35,6 +49,24 @@ export class Eyes {
35
49
  fullViewSize?: undefined | RectangleSizePlain;
36
50
  }, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
37
51
  check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
52
+ checkWindow(name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
53
+ checkFrame(element: number, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
54
+ checkFrame(element: Element, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
55
+ checkFrame(element: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
56
+ checkElement(element: Element, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
57
+ checkElementBy(selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
58
+ checkRegion(region: RegionPlain, name?: undefined | string, timeout?: undefined | number): Promise<MatchResult>;
59
+ checkRegion(image: string, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
60
+ checkRegion(image: URL, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
61
+ checkRegion(image: Buffer, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
62
+ checkRegionByElement(element: Element, name?: undefined | string, timeout?: undefined | number): Promise<MatchResult>;
63
+ checkRegionBy(selector: EyesSelector<Selector>, name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
64
+ checkRegionInFrame(frame: number, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
65
+ checkRegionInFrame(frame: Element, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
66
+ checkRegionInFrame(frame: EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
67
+ checkImage(image: string, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
68
+ checkImage(image: URL, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
69
+ checkImage(image: Buffer, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
38
70
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
39
71
  extractTextRegions<TPattern extends string>(target: {
40
72
  image: string | URL | Buffer;
@@ -46,6 +78,7 @@ export class Eyes {
46
78
  locationInView?: undefined | { x: number; y: number; };
47
79
  fullViewSize?: undefined | { width: number; height: number; };
48
80
  }, settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
81
+ extractTextRegions<TPattern extends string>(settingsWithImage: OCRSettings<TPattern> & { image: string | URL | Buffer; }): Promise<Record<TPattern, Array<TextRegion>>>;
49
82
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
50
83
  extractText(target: {
51
84
  image: string | URL | Buffer;
@@ -57,22 +90,27 @@ export class Eyes {
57
90
  locationInView?: undefined | { x: number; y: number; };
58
91
  fullViewSize?: undefined | { width: number; height: number; };
59
92
  }, settings: Array<OCRRegion>): Promise<Array<string>>;
93
+ extractText(settingsWithImage: Array<OCRRegion & { image: string | URL | Buffer; }>): Promise<Array<string>>;
60
94
  extractText(settings: Array<OCRRegion>): Promise<Array<string>>;
61
95
  close(throwErr?: undefined | boolean): Promise<TestResults>;
62
96
  closeAsync(): Promise<void>;
63
97
  abort(): Promise<TestResults>;
64
98
  abortAsync(): Promise<void>;
99
+ abortIfNotClosed(): Promise<TestResultsPlain>;
65
100
  getViewportSize(): Promise<RectangleSize>;
66
101
  setViewportSize(size: RectangleSizePlain): Promise<void>;
67
102
  getScrollRootElement(): Element | EyesSelector<Selector>;
68
- setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): void;
69
- setLogHandler(handler: LogHandlerPlain | LogHandler): void;
103
+ setScrollRootElement(scrollRootElement: Element): void;
104
+ setScrollRootElement(scrollRootElement: EyesSelector<Selector>): void;
105
+ setLogHandler(handler: LogHandlerPlain): void;
106
+ setLogHandler(handler: LogHandler): void;
70
107
  getLogHandler(): LogHandler;
71
108
  setCutProvider(cutProvider: CutProvider): void;
72
109
  setImageCut(cutProvider: CutProvider): void;
73
110
  getIsCutProviderExplicitlySet(): boolean;
74
111
  getRotation(): ImageRotation;
75
- setRotation(rotation: ImageRotationPlain | ImageRotation): void;
112
+ setRotation(rotation: ImageRotationPlain): void;
113
+ setRotation(rotation: ImageRotation): void;
76
114
  getScaleRatio(): number;
77
115
  setScaleRatio(scaleRatio: number): void;
78
116
  getSaveDebugScreenshots(): boolean;
@@ -85,7 +123,8 @@ export class Eyes {
85
123
  clearProperties(): Configuration;
86
124
  getBatch(): BatchInfo;
87
125
  setBatch(batch: BatchInfoPlain): void;
88
- setBatch(name: string, id?: undefined | string, startedAt?: undefined | string | Date): void;
126
+ setBatch(name: string, id?: undefined | string, startedAt?: undefined | string): void;
127
+ setBatch(name: string, id?: undefined | string, startedAt?: undefined | Date): void;
89
128
  getApiKey(): string;
90
129
  setApiKey(apiKey: string): void;
91
130
  getTestName(): string;
@@ -94,6 +133,8 @@ export class Eyes {
94
133
  setAppName(appName: string): void;
95
134
  getBaselineBranchName(): string;
96
135
  setBaselineBranchName(baselineBranchName: string): void;
136
+ getBaselineName(): string;
137
+ setBaselineName(baselineName: string): void;
97
138
  getBaselineEnvName(): string;
98
139
  setBaselineEnvName(baselineEnvName: string): void;
99
140
  getBranchName(): string;
@@ -142,6 +183,10 @@ export class Eyes {
142
183
  setStitchMode(stitchMode: StitchModePlain): void;
143
184
  getStitchOverlap(): number;
144
185
  setStitchOverlap(stitchOverlap: number): void;
186
+ getSessionEventHandlers(): SessionEventHandlers;
187
+ addSessionEventHandler(handler: SessionEventHandler): void;
188
+ removeSessionEventHandler(handler: SessionEventHandler): void;
189
+ clearSessionEventHandlers(): void;
145
190
  }
146
191
  export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
147
192
  frames?: undefined | Array<{ frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); } | (number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>;
@@ -159,36 +204,60 @@ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
159
204
  lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
160
205
  };
161
206
  export class CheckSettingsAutomation {
162
- constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain);
163
- region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
164
- shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
207
+ constructor(settings?: undefined | CheckSettingsAutomation);
208
+ constructor(settings?: undefined | CheckSettingsAutomationPlain);
209
+ region(region: RegionPlain): CheckSettingsAutomation;
210
+ region(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
211
+ shadow(selector: string): CheckSettingsAutomation;
212
+ shadow(selector: Selector): CheckSettingsAutomation;
213
+ shadow(selector: { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
165
214
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
166
- frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
167
- webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
168
- scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
215
+ frame(frame: number, scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
216
+ frame(frame: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
217
+ webview(webview?: undefined | string): CheckSettingsAutomation;
218
+ webview(webview?: undefined | boolean): CheckSettingsAutomation;
219
+ scrollRootElement(scrollRootElement: Element): CheckSettingsAutomation;
220
+ scrollRootElement(scrollRootElement: (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
169
221
  fully(fully?: undefined | boolean): CheckSettingsAutomation;
222
+ stitchContent(stitchContent?: undefined | boolean): CheckSettingsAutomation;
170
223
  disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
171
- layoutBreakpoints(layoutBreakpoints?: undefined | boolean | Array<number>): CheckSettingsAutomation;
224
+ layoutBreakpoints(layoutBreakpoints?: undefined | boolean): CheckSettingsAutomation;
225
+ layoutBreakpoints(layoutBreakpoints?: undefined | Array<number>): CheckSettingsAutomation;
172
226
  hook(name: string, script: string): CheckSettingsAutomation;
173
227
  beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
228
+ webHook(script: string): CheckSettingsAutomation;
174
229
  ufgOption(key: string, value: any): CheckSettingsAutomation;
175
230
  ufgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
231
+ visualGridOption(key: string, value: any): CheckSettingsAutomation;
232
+ visualGridOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
176
233
  nmgOption(key: string, value: any): CheckSettingsAutomation;
177
234
  nmgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
178
235
  renderId(renderId: string): CheckSettingsAutomation;
179
236
  timeout(timeout: number): CheckSettingsAutomation;
180
237
  waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
181
- lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
238
+ lazyLoad(options?: undefined | boolean): CheckSettingsAutomation;
239
+ lazyLoad(options?: undefined | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
182
240
  densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
183
241
  name(name: string): CheckSettingsAutomation;
184
242
  withName(name: string): CheckSettingsAutomation;
185
- ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
243
+ ignoreRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
244
+ ignoreRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
245
+ ignoreRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
186
246
  ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
187
- layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
247
+ ignore(region: LegacyRegionPlain): CheckSettingsAutomation;
248
+ ignore(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
249
+ ignores(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
250
+ layoutRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
251
+ layoutRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
252
+ layoutRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
188
253
  layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
189
- strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
254
+ strictRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
255
+ strictRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
256
+ strictRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
190
257
  strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
191
- contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
258
+ contentRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
259
+ contentRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
260
+ contentRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
192
261
  contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
193
262
  floatingRegion(region: {
194
263
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
@@ -205,7 +274,8 @@ export class CheckSettingsAutomation {
205
274
  maxLeftOffset?: undefined | number;
206
275
  maxRightOffset?: undefined | number;
207
276
  }): CheckSettingsAutomation;
208
- floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
277
+ floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
278
+ floatingRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
209
279
  floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
210
280
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
211
281
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -213,13 +283,37 @@ export class CheckSettingsAutomation {
213
283
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
214
284
  }>): CheckSettingsAutomation;
215
285
  floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
286
+ floating(region: {
287
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
288
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
289
+ regionId?: undefined | string;
290
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
291
+ }): CheckSettingsAutomation;
292
+ floating(region: LegacyRegionPlain): CheckSettingsAutomation;
293
+ floating(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
294
+ floatings(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
295
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
296
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
297
+ regionId?: undefined | string;
298
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
299
+ }>): CheckSettingsAutomation;
300
+ floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
216
301
  accessibilityRegion(region: {
217
302
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
218
303
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
219
304
  regionId?: undefined | string;
220
305
  type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
221
306
  }): CheckSettingsAutomation;
222
- accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsAutomation;
307
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsAutomation;
308
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "IgnoreContrast"): CheckSettingsAutomation;
309
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "RegularText"): CheckSettingsAutomation;
310
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "RegularText"): CheckSettingsAutomation;
311
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "LargeText"): CheckSettingsAutomation;
312
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "LargeText"): CheckSettingsAutomation;
313
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "BoldText"): CheckSettingsAutomation;
314
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "BoldText"): CheckSettingsAutomation;
315
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsAutomation;
316
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "GraphicalObject"): CheckSettingsAutomation;
223
317
  accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
224
318
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
225
319
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -232,6 +326,7 @@ export class CheckSettingsAutomation {
232
326
  exact(): CheckSettingsAutomation;
233
327
  strict(): CheckSettingsAutomation;
234
328
  ignoreColors(): CheckSettingsAutomation;
329
+ content(): CheckSettingsAutomation;
235
330
  enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsAutomation;
236
331
  ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsAutomation;
237
332
  ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsAutomation;
@@ -244,21 +339,29 @@ export class CheckSettings extends CheckSettingsAutomation {
244
339
  }
245
340
  export type TargetAutomation = {
246
341
  window(): CheckSettingsAutomation;
247
- region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
342
+ region(region: LegacyRegionPlain): CheckSettingsAutomation;
343
+ region(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
248
344
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
249
- frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
250
- shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
251
- webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
345
+ frame(frame: number, scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
346
+ frame(frame: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
347
+ shadow(selector: string): CheckSettingsAutomation;
348
+ shadow(selector: Selector): CheckSettingsAutomation;
349
+ shadow(selector: { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
350
+ webview(webview?: undefined | string): CheckSettingsAutomation;
351
+ webview(webview?: undefined | boolean): CheckSettingsAutomation;
252
352
  };
253
353
  export const Target: TargetImage & TargetAutomation;
254
354
  export type OCRRegion = { target: RegionPlain | Element | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
255
355
  export type ConfigurationPlain = {
356
+ debugScreenshots?: undefined | { save: boolean; path?: undefined | string; prefix?: undefined | string; };
256
357
  agentId?: undefined | string;
257
358
  apiKey?: undefined | string;
258
359
  serverUrl?: undefined | string;
259
360
  proxy?: undefined | ProxySettingsPlain;
260
361
  autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
261
362
  isDisabled?: undefined | boolean;
363
+ connectionTimeout?: undefined | number;
364
+ removeSession?: undefined | boolean;
262
365
  appName?: undefined | string;
263
366
  testName?: undefined | string;
264
367
  displayName?: undefined | string;
@@ -283,6 +386,7 @@ export type ConfigurationPlain = {
283
386
  saveFailedTests?: undefined | boolean;
284
387
  saveNewTests?: undefined | boolean;
285
388
  saveDiffs?: undefined | boolean;
389
+ dontCloseBatches?: undefined | boolean;
286
390
  sendDom?: undefined | boolean;
287
391
  matchTimeout?: undefined | number;
288
392
  forceFullPageScreenshot?: undefined | boolean;
@@ -295,6 +399,7 @@ export type ConfigurationPlain = {
295
399
  cut?: undefined | CutProviderPlain;
296
400
  rotation?: undefined | ImageRotationPlain;
297
401
  scaleRatio?: undefined | number;
402
+ concurrentSessions?: undefined | number;
298
403
  browsersInfo?: undefined | Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
299
404
  visualGridOptions?: undefined | Record<string, any>;
300
405
  layoutBreakpoints?: undefined | boolean | Array<number>;
@@ -303,6 +408,14 @@ export type ConfigurationPlain = {
303
408
  };
304
409
  export class Configuration implements Required<ConfigurationPlain> {
305
410
  constructor(config?: undefined | ConfigurationPlain);
411
+ get debugScreenshots(): { save: boolean; path?: undefined | string; prefix?: undefined | string; };
412
+ set debugScreenshots(debugScreenshots: { save: boolean; path?: undefined | string; prefix?: undefined | string; });
413
+ getSaveDebugScreenshots(): boolean;
414
+ setSaveDebugScreenshots(save: boolean): Configuration;
415
+ getDebugScreenshotsPath(): string;
416
+ setDebugScreenshotsPath(path: string): Configuration;
417
+ getDebugScreenshotsPrefix(): string;
418
+ setDebugScreenshotsPrefix(prefix: string): Configuration;
306
419
  get appName(): string;
307
420
  set appName(appName: string);
308
421
  getAppName(): string;
@@ -353,6 +466,14 @@ export class Configuration implements Required<ConfigurationPlain> {
353
466
  set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
354
467
  getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
355
468
  setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
469
+ get connectionTimeout(): number;
470
+ set connectionTimeout(connectionTimeout: number);
471
+ getConnectionTimeout(): number;
472
+ setConnectionTimeout(connectionTimeout: number): Configuration;
473
+ get removeSession(): boolean;
474
+ set removeSession(removeSession: boolean);
475
+ getRemoveSession(): boolean;
476
+ setRemoveSession(removeSession: boolean): Configuration;
356
477
  get batch(): BatchInfoPlain;
357
478
  set batch(batch: BatchInfoPlain);
358
479
  getBatch(): BatchInfo;
@@ -479,7 +600,8 @@ export class Configuration implements Required<ConfigurationPlain> {
479
600
  get scrollRootElement(): Element | EyesSelector<Selector>;
480
601
  set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
481
602
  getScrollRootElement(): Element | EyesSelector<Selector>;
482
- setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): Configuration;
603
+ setScrollRootElement(scrollRootElement: Element): Configuration;
604
+ setScrollRootElement(scrollRootElement: EyesSelector<Selector>): Configuration;
483
605
  get cut(): CutProviderPlain;
484
606
  set cut(cut: CutProviderPlain);
485
607
  getCut(): CutProviderPlain;
@@ -487,21 +609,49 @@ export class Configuration implements Required<ConfigurationPlain> {
487
609
  get rotation(): ImageRotationPlain;
488
610
  set rotation(rotation: ImageRotationPlain);
489
611
  getRotation(): ImageRotation;
490
- setRotation(rotation: ImageRotationPlain | ImageRotation): Configuration;
612
+ setRotation(rotation: ImageRotationPlain): Configuration;
613
+ setRotation(rotation: ImageRotation): Configuration;
491
614
  get scaleRatio(): number;
492
615
  set scaleRatio(scaleRatio: number);
493
616
  getScaleRatio(): number;
494
617
  setScaleRatio(scaleRatio: number): Configuration;
618
+ get concurrentSessions(): number;
619
+ set concurrentSessions(concurrentSessions: number);
620
+ getConcurrentSessions(): number;
621
+ setConcurrentSessions(concurrentSessions: number): Configuration;
495
622
  get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
496
623
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
497
624
  getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>;
498
625
  setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
499
626
  addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
500
- addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
501
- addBrowser(width: number, height: number, name?: undefined | "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back"): Configuration;
502
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape" | "portrait"): Configuration;
503
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
504
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
627
+ addBrowser(browserInfo: DesktopBrowserInfo): Configuration;
628
+ addBrowser(browserInfo: ChromeEmulationInfo): Configuration;
629
+ addBrowser(browserInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }): Configuration;
630
+ addBrowser(browserInfo: IOSDeviceInfo): Configuration;
631
+ addBrowser(browserInfo: AndroidDeviceInfo): Configuration;
632
+ addBrowser(width: number, height: number, name?: undefined | "chrome"): Configuration;
633
+ addBrowser(width: number, height: number, name?: undefined | "chrome-one-version-back"): Configuration;
634
+ addBrowser(width: number, height: number, name?: undefined | "chrome-two-versions-back"): Configuration;
635
+ addBrowser(width: number, height: number, name?: undefined | "firefox"): Configuration;
636
+ addBrowser(width: number, height: number, name?: undefined | "firefox-one-version-back"): Configuration;
637
+ addBrowser(width: number, height: number, name?: undefined | "firefox-two-versions-back"): Configuration;
638
+ addBrowser(width: number, height: number, name?: undefined | "ie"): Configuration;
639
+ addBrowser(width: number, height: number, name?: undefined | "ie10"): Configuration;
640
+ addBrowser(width: number, height: number, name?: undefined | "edge"): Configuration;
641
+ addBrowser(width: number, height: number, name?: undefined | "edgechromium"): Configuration;
642
+ addBrowser(width: number, height: number, name?: undefined | "edgelegacy"): Configuration;
643
+ addBrowser(width: number, height: number, name?: undefined | "edgechromium-one-version-back"): Configuration;
644
+ addBrowser(width: number, height: number, name?: undefined | "edgechromium-two-versions-back"): Configuration;
645
+ addBrowser(width: number, height: number, name?: undefined | "safari"): Configuration;
646
+ addBrowser(width: number, height: number, name?: undefined | "safari-earlyaccess"): Configuration;
647
+ addBrowser(width: number, height: number, name?: undefined | "safari-one-version-back"): Configuration;
648
+ addBrowser(width: number, height: number, name?: undefined | "safari-two-versions-back"): Configuration;
649
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape"): Configuration;
650
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "portrait"): Configuration;
651
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest"): Configuration;
652
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest-1"): Configuration;
653
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest"): Configuration;
654
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest-1"): Configuration;
505
655
  get visualGridOptions(): { [key: string]: any; };
506
656
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
507
657
  getVisualGridOptions(): { [key: string]: any; };
@@ -510,11 +660,16 @@ export class Configuration implements Required<ConfigurationPlain> {
510
660
  get layoutBreakpoints(): boolean | Array<number>;
511
661
  set layoutBreakpoints(layoutBreakpoints: boolean | Array<number>);
512
662
  getLayoutBreakpoints(): boolean | Array<number>;
513
- setLayoutBreakpoints(layoutBreakpoints: boolean | Array<number>): Configuration;
663
+ setLayoutBreakpoints(layoutBreakpoints: boolean): Configuration;
664
+ setLayoutBreakpoints(layoutBreakpoints: Array<number>): Configuration;
514
665
  get disableBrowserFetching(): boolean;
515
666
  set disableBrowserFetching(disableBrowserFetching: boolean);
516
667
  getDisableBrowserFetching(): boolean;
517
668
  setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
669
+ get dontCloseBatches(): boolean;
670
+ set dontCloseBatches(dontCloseBatches: boolean);
671
+ getDontCloseBatches(): boolean;
672
+ setDontCloseBatches(dontCloseBatches: boolean): Configuration;
518
673
  }
519
674
  export class BatchClose {
520
675
  static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
@@ -772,7 +927,11 @@ export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: unde
772
927
  export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
773
928
  constructor(settings: AccessibilityMatchSettingsPlain);
774
929
  constructor(region: RegionPlain);
775
- constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject");
930
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast");
931
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "RegularText");
932
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "LargeText");
933
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "BoldText");
934
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "GraphicalObject");
776
935
  get region(): RegionPlain;
777
936
  set region(region: RegionPlain);
778
937
  getRegion(): Region;
@@ -802,7 +961,8 @@ export type BatchInfoPlain = {
802
961
  export class BatchInfo implements Required<BatchInfoPlain> {
803
962
  constructor();
804
963
  constructor(batch?: undefined | BatchInfoPlain);
805
- constructor(name?: undefined | string, startedAt?: undefined | string | Date, id?: undefined | string);
964
+ constructor(name?: undefined | string, startedAt?: undefined | string, id?: undefined | string);
965
+ constructor(name?: undefined | string, startedAt?: undefined | Date, id?: undefined | string);
806
966
  get id(): string;
807
967
  set id(id: string);
808
968
  getId(): string;
@@ -818,7 +978,8 @@ export class BatchInfo implements Required<BatchInfoPlain> {
818
978
  get startedAt(): string | Date;
819
979
  set startedAt(startedAt: string | Date);
820
980
  getStartedAt(): string | Date;
821
- setStartedAt(startedAt: string | Date): BatchInfo;
981
+ setStartedAt(startedAt: string): BatchInfo;
982
+ setStartedAt(startedAt: Date): BatchInfo;
822
983
  get notifyOnCompletion(): boolean;
823
984
  set notifyOnCompletion(notifyOnCompletion: boolean);
824
985
  getNotifyOnCompletion(): boolean;
@@ -869,7 +1030,7 @@ export type CheckSettingsImagePlain = {
869
1030
  densityMetrics?: undefined | { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; };
870
1031
  };
871
1032
  export class CheckSettingsImage {
872
- constructor(settings?: undefined | CheckSettingsImagePlain | CheckSettingsImage, target?: undefined | {
1033
+ constructor(settings?: undefined | CheckSettingsImagePlain, target?: undefined | {
873
1034
  image: string | URL | Buffer;
874
1035
  name?: undefined | string;
875
1036
  dom?: undefined | string;
@@ -877,23 +1038,46 @@ export class CheckSettingsImage {
877
1038
  locationInView?: undefined | LocationPlain;
878
1039
  fullViewSize?: undefined | RectangleSizePlain;
879
1040
  });
880
- image(image: string | URL | Buffer): CheckSettingsImage;
1041
+ constructor(settings?: undefined | CheckSettingsImage, target?: undefined | {
1042
+ image: string | URL | Buffer;
1043
+ name?: undefined | string;
1044
+ dom?: undefined | string;
1045
+ locationInViewport?: undefined | LocationPlain;
1046
+ locationInView?: undefined | LocationPlain;
1047
+ fullViewSize?: undefined | RectangleSizePlain;
1048
+ });
1049
+ image(image: string): CheckSettingsImage;
1050
+ image(image: URL): CheckSettingsImage;
1051
+ image(image: Buffer): CheckSettingsImage;
881
1052
  buffer(imageBuffer: Buffer): CheckSettingsImage;
882
1053
  base64(imageBase64: Buffer): CheckSettingsImage;
883
1054
  path(imagePath: string): CheckSettingsImage;
884
- url(imageUrl: string | URL): CheckSettingsImage;
1055
+ url(imageUrl: string): CheckSettingsImage;
1056
+ url(imageUrl: URL): CheckSettingsImage;
885
1057
  name(name: string): CheckSettingsImage;
886
1058
  withDom(dom: string): CheckSettingsImage;
887
1059
  withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
888
- region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
1060
+ region(region: LegacyRegionPlain): CheckSettingsImage;
1061
+ region(region: RegionPlain): CheckSettingsImage;
889
1062
  withName(name: string): CheckSettingsImage;
890
- ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1063
+ ignoreRegion(region: LegacyRegionPlain): CheckSettingsImage;
1064
+ ignoreRegion(region: RegionPlain): CheckSettingsImage;
1065
+ ignoreRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
891
1066
  ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
892
- layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1067
+ ignore(region: LegacyRegionPlain): CheckSettingsImage;
1068
+ ignore(region: RegionPlain): CheckSettingsImage;
1069
+ ignores(...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
1070
+ layoutRegion(region: LegacyRegionPlain): CheckSettingsImage;
1071
+ layoutRegion(region: RegionPlain): CheckSettingsImage;
1072
+ layoutRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
893
1073
  layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
894
- strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1074
+ strictRegion(region: LegacyRegionPlain): CheckSettingsImage;
1075
+ strictRegion(region: RegionPlain): CheckSettingsImage;
1076
+ strictRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
895
1077
  strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
896
- contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1078
+ contentRegion(region: LegacyRegionPlain): CheckSettingsImage;
1079
+ contentRegion(region: RegionPlain): CheckSettingsImage;
1080
+ contentRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
897
1081
  contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
898
1082
  floatingRegion(region: {
899
1083
  region: RegionPlain;
@@ -910,7 +1094,8 @@ export class CheckSettingsImage {
910
1094
  maxLeftOffset?: undefined | number;
911
1095
  maxRightOffset?: undefined | number;
912
1096
  }): CheckSettingsImage;
913
- floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
1097
+ floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
1098
+ floatingRegion(region: RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
914
1099
  floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
915
1100
  region: RegionPlain;
916
1101
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -918,13 +1103,37 @@ export class CheckSettingsImage {
918
1103
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
919
1104
  }>): CheckSettingsImage;
920
1105
  floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
1106
+ floating(region: {
1107
+ region: RegionPlain;
1108
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1109
+ regionId?: undefined | string;
1110
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1111
+ }): CheckSettingsImage;
1112
+ floating(region: LegacyRegionPlain): CheckSettingsImage;
1113
+ floating(region: RegionPlain): CheckSettingsImage;
1114
+ floatings(...regions: Array<LegacyRegionPlain | RegionPlain | {
1115
+ region: RegionPlain;
1116
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1117
+ regionId?: undefined | string;
1118
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1119
+ }>): CheckSettingsImage;
1120
+ floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
921
1121
  accessibilityRegion(region: {
922
1122
  region: RegionPlain;
923
1123
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
924
1124
  regionId?: undefined | string;
925
1125
  type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
926
1126
  }): CheckSettingsImage;
927
- accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
1127
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsImage;
1128
+ accessibilityRegion(region: RegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsImage;
1129
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "RegularText"): CheckSettingsImage;
1130
+ accessibilityRegion(region: RegionPlain, type?: undefined | "RegularText"): CheckSettingsImage;
1131
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "LargeText"): CheckSettingsImage;
1132
+ accessibilityRegion(region: RegionPlain, type?: undefined | "LargeText"): CheckSettingsImage;
1133
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "BoldText"): CheckSettingsImage;
1134
+ accessibilityRegion(region: RegionPlain, type?: undefined | "BoldText"): CheckSettingsImage;
1135
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsImage;
1136
+ accessibilityRegion(region: RegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsImage;
928
1137
  accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
929
1138
  region: RegionPlain;
930
1139
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -937,6 +1146,7 @@ export class CheckSettingsImage {
937
1146
  exact(): CheckSettingsImage;
938
1147
  strict(): CheckSettingsImage;
939
1148
  ignoreColors(): CheckSettingsImage;
1149
+ content(): CheckSettingsImage;
940
1150
  enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsImage;
941
1151
  ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsImage;
942
1152
  ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsImage;
@@ -946,11 +1156,14 @@ export class CheckSettingsImage {
946
1156
  variationGroupId(variationGroupId: string): CheckSettingsImage;
947
1157
  }
948
1158
  export type TargetImage = {
949
- image(image: string | URL | Buffer): CheckSettingsImage;
1159
+ image(image: string): CheckSettingsImage;
1160
+ image(image: URL): CheckSettingsImage;
1161
+ image(image: Buffer): CheckSettingsImage;
950
1162
  buffer(imageBuffer: Buffer): CheckSettingsImage;
951
1163
  base64(imageBase64: string): CheckSettingsImage;
952
1164
  path(imagePath: string): CheckSettingsImage;
953
- url(imageUrl: string | URL): CheckSettingsImage;
1165
+ url(imageUrl: string): CheckSettingsImage;
1166
+ url(imageUrl: URL): CheckSettingsImage;
954
1167
  };
955
1168
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
956
1169
  export class CutProvider implements Required<{
@@ -1142,7 +1355,14 @@ export class Location implements Required<LocationPlain> {
1142
1355
  setY(y: number): void;
1143
1356
  }
1144
1357
  export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
1145
- export type CustomLogHandlerPlain = { log(message: any): void; };
1358
+ export type CustomLogHandlerPlain = {
1359
+ log(message: any): void;
1360
+ warn?(message: any): void;
1361
+ error?(message: any): void;
1362
+ fatal?(message: any): void;
1363
+ open?(): void;
1364
+ close?(): void;
1365
+ };
1146
1366
  export type FileLogHandlerPlain = { type: "file"; filename?: undefined | string; append?: undefined | boolean; };
1147
1367
  export type ConsoleLogHandlerPlain = { type: "console"; };
1148
1368
  export abstract class LogHandler implements CustomLogHandlerPlain {
@@ -1252,7 +1472,7 @@ export type DesktopBrowserInfo = { name?: undefined | "chrome" | "chrome-one-ver
1252
1472
  export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1253
1473
  export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1254
1474
  export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1255
- export type RunnerOptionsPlain = { testConcurrency?: undefined | number; removeDuplicateTests?: undefined | boolean; };
1475
+ export type RunnerOptionsPlain = { testConcurrency?: undefined | number; fetchConcurrency?: undefined | number; removeDuplicateTests?: undefined | boolean; };
1256
1476
  export class RunnerOptionsFluent {
1257
1477
  testConcurrency(concurrency: number): RunnerOptionsFluent;
1258
1478
  }
@@ -1268,35 +1488,46 @@ export type ApiUrlsPlain = {
1268
1488
  export class ApiUrls implements Required<ApiUrlsPlain> {
1269
1489
  get baselineImage(): string;
1270
1490
  getBaselineImage(): string;
1491
+ setBaselineImage(setBaselineImage: string): void;
1271
1492
  get currentImage(): string;
1272
1493
  getCurrentImage(): string;
1494
+ setCurrentImage(currentImage: string): void;
1273
1495
  get checkpointImage(): string;
1274
1496
  getCheckpointImage(): string;
1497
+ setCheckpointImage(checkpointImage: string): void;
1275
1498
  get checkpointImageThumbnail(): string;
1276
1499
  getCheckpointImageThumbnail(): string;
1500
+ setCheckpointImageThumbnail(checkpointImageThumbnail: string): void;
1277
1501
  get diffImage(): string;
1278
1502
  getDiffImage(): string;
1503
+ setDiffImage(diffImage: string): void;
1279
1504
  }
1280
1505
  export type AppUrlsPlain = { readonly step: string; readonly stepEditor: string; };
1281
1506
  export class AppUrls implements Required<AppUrlsPlain> {
1282
1507
  get step(): string;
1283
1508
  getStep(): string;
1509
+ setStep(step: string): void;
1284
1510
  get stepEditor(): string;
1285
1511
  getStepEditor(): string;
1512
+ setStepEditor(stepEditor: string): void;
1286
1513
  }
1287
1514
  export type MatchResultPlain = { readonly asExpected?: undefined | boolean; readonly windowId?: undefined | number; };
1288
1515
  export class MatchResult implements Required<MatchResultPlain> {
1289
1516
  get asExpected(): boolean;
1290
1517
  getAsExpected(): boolean;
1518
+ setAsExpected(asExpected: boolean): void;
1291
1519
  get windowId(): number;
1292
1520
  getWindowId(): number;
1521
+ setWindowId(windowId: number): void;
1293
1522
  }
1294
1523
  export type SessionUrlsPlain = { readonly batch: string; readonly session: string; };
1295
1524
  export class SessionUrls implements Required<SessionUrlsPlain> {
1296
1525
  get batch(): string;
1297
1526
  getBatch(): string;
1527
+ setBatch(batch: string): void;
1298
1528
  get session(): string;
1299
1529
  getSession(): string;
1530
+ setSession(session: string): void;
1300
1531
  }
1301
1532
  export type StepInfoPlain = {
1302
1533
  readonly name: string;
@@ -1310,18 +1541,25 @@ export type StepInfoPlain = {
1310
1541
  export class StepInfo implements Required<StepInfoPlain> {
1311
1542
  get name(): string;
1312
1543
  getName(): string;
1544
+ setName(value: string): void;
1313
1545
  get isDifferent(): boolean;
1314
1546
  getIsDifferent(): boolean;
1547
+ setIsDifferent(value: boolean): void;
1315
1548
  get hasBaselineImage(): boolean;
1316
1549
  getHasBaselineImage(): boolean;
1550
+ setHasBaselineImage(value: boolean): void;
1317
1551
  get hasCurrentImage(): boolean;
1318
1552
  getHasCurrentImage(): boolean;
1553
+ setHasCurrentImage(hasCurrentImage: boolean): void;
1319
1554
  get appUrls(): AppUrlsPlain;
1320
1555
  getAppUrls(): AppUrls;
1556
+ setAppUrls(appUrls: AppUrlsPlain): void;
1321
1557
  get apiUrls(): ApiUrlsPlain;
1322
1558
  getApiUrls(): ApiUrls;
1559
+ setApiUrls(apiUrls: ApiUrlsPlain): void;
1323
1560
  get renderId(): Array<string>;
1324
1561
  getRenderId(): Array<string>;
1562
+ setRenderId(renderId: Array<string>): void;
1325
1563
  }
1326
1564
  export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
1327
1565
  export type TestResultsPlain = {
@@ -1355,74 +1593,106 @@ export type TestResultsPlain = {
1355
1593
  readonly layoutMatches?: undefined | number;
1356
1594
  readonly noneMatches?: undefined | number;
1357
1595
  readonly url?: undefined | string;
1358
- readonly server: { serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; };
1359
- readonly keepIfDuplicate: boolean;
1596
+ readonly server?: undefined | { serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; };
1597
+ readonly keepIfDuplicate?: undefined | boolean;
1360
1598
  };
1361
1599
  export class TestResults implements Required<TestResultsPlain> {
1362
1600
  get id(): string;
1363
1601
  getId(): string;
1602
+ setId(_id: string): void;
1364
1603
  get name(): string;
1365
1604
  getName(): string;
1605
+ setName(_name: string): void;
1366
1606
  get secretToken(): string;
1367
1607
  getSecretToken(): string;
1608
+ setSecretToken(_secretToken: string): void;
1368
1609
  get status(): TestResultsStatusPlain;
1369
1610
  getStatus(): TestResultsStatus;
1611
+ setStatus(_status: TestResultsStatus): void;
1370
1612
  get appName(): string;
1371
1613
  getAppName(): string;
1614
+ setAppName(_appName: string): void;
1372
1615
  get batchName(): string;
1373
1616
  getBatchName(): string;
1617
+ setBatchName(_batchName: string): void;
1374
1618
  get batchId(): string;
1375
1619
  getBatchId(): string;
1620
+ setBatchId(_batchId: string): void;
1376
1621
  get branchName(): string;
1377
1622
  getBranchName(): string;
1623
+ setBranchName(_branchName: string): void;
1378
1624
  get hostOS(): string;
1379
1625
  getHostOS(): string;
1626
+ setHostOS(_hostOS: string): void;
1380
1627
  get hostApp(): string;
1381
1628
  getHostApp(): string;
1629
+ setHostApp(_hostApp: string): void;
1382
1630
  get hostDisplaySize(): RectangleSizePlain;
1383
1631
  getHostDisplaySize(): RectangleSize;
1632
+ setHostDisplaySize(_hostDisplaySize: RectangleSizePlain): void;
1384
1633
  get accessibilityStatus(): TestAccessibilityStatus;
1385
1634
  getAccessibilityStatus(): TestAccessibilityStatus;
1635
+ setAccessibilityStatus(_accessibilityStatus: TestAccessibilityStatus): void;
1386
1636
  get startedAt(): string;
1387
1637
  getStartedAt(): Date;
1638
+ setStartedAt(_startedAt: string): void;
1639
+ setStartedAt(_startedAt: Date): void;
1388
1640
  get duration(): number;
1389
1641
  getDuration(): number;
1642
+ setDuration(_duration: number): void;
1390
1643
  get isNew(): boolean;
1391
1644
  getIsNew(): boolean;
1645
+ setIsNew(_isNew: boolean): void;
1392
1646
  get isDifferent(): boolean;
1393
1647
  getIsDifferent(): boolean;
1648
+ setIsDifferent(_isDifferent: boolean): void;
1394
1649
  get isAborted(): boolean;
1395
1650
  getIsAborted(): boolean;
1651
+ setIsAborted(_isAborted: boolean): void;
1396
1652
  get appUrls(): SessionUrlsPlain;
1397
1653
  getAppUrls(): SessionUrls;
1654
+ setAppUrls(_appUrls: SessionUrlsPlain): void;
1398
1655
  get apiUrls(): SessionUrlsPlain;
1399
1656
  getApiUrls(): SessionUrls;
1657
+ setApiUrls(_apiUrls: SessionUrlsPlain): void;
1400
1658
  get stepsInfo(): Array<StepInfoPlain>;
1401
1659
  getStepsInfo(): Array<StepInfo>;
1660
+ setStepsInfo(_stepInfo: Array<StepInfoPlain>): void;
1402
1661
  get steps(): number;
1403
1662
  getSteps(): number;
1663
+ setSteps(_steps: number): void;
1404
1664
  get matches(): number;
1405
1665
  getMatches(): number;
1666
+ setMatches(_matches: number): void;
1406
1667
  get mismatches(): number;
1407
1668
  getMismatches(): number;
1669
+ setMismatches(_mismatches: number): void;
1408
1670
  get missing(): number;
1409
1671
  getMissing(): number;
1672
+ setMissing(_missing: number): void;
1410
1673
  get exactMatches(): number;
1411
1674
  getExactMatches(): number;
1675
+ setExactMatches(_exactMatches: number): void;
1412
1676
  get strictMatches(): number;
1413
1677
  getStrictMatches(): number;
1678
+ setStrictMatches(_strictMatches: number): void;
1414
1679
  get contentMatches(): number;
1415
1680
  getContentMatches(): number;
1681
+ setContentMatches(_contentMatches: number): void;
1416
1682
  get layoutMatches(): number;
1417
1683
  getLayoutMatches(): number;
1684
+ setLayoutMatches(_layoutMatches: number): void;
1418
1685
  get noneMatches(): number;
1419
1686
  getNoneMatches(): number;
1687
+ setNoneMatches(_noneMatches: number): void;
1420
1688
  get url(): string;
1421
1689
  getUrl(): string;
1690
+ setUrl(_url: string): void;
1422
1691
  get server(): { serverUrl: string; apiKey: string; agentId?: undefined | string; proxy?: undefined | { url: string; username?: undefined | string; password?: undefined | string; }; };
1423
1692
  get keepIfDuplicate(): boolean;
1424
1693
  isPassed(): boolean;
1425
1694
  delete(): Promise<void>;
1695
+ deleteSession(): Promise<void>;
1426
1696
  }
1427
1697
  export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo); };
1428
1698
  export class TestResultContainer implements Required<TestResultContainerPlain> {
@@ -1474,15 +1744,21 @@ export class Logger {
1474
1744
  extend(label?: undefined | string): Logger;
1475
1745
  }
1476
1746
  export abstract class EyesRunner {
1747
+ constructor(options?: undefined | RunnerOptionsPlain);
1477
1748
  abstract readonly type: "classic" | "ufg";
1478
1749
  getAllTestResults(throwErr?: undefined | boolean): Promise<TestResultsSummary>;
1479
1750
  }
1480
1751
  export class ClassicRunner extends EyesRunner {
1481
- constructor(options?: undefined | RunnerOptionsPlain);
1752
+ readonly type: "classic";
1482
1753
  }
1483
1754
  export class VisualGridRunner extends EyesRunner {
1484
1755
  constructor(options?: undefined | RunnerOptionsPlain);
1756
+ constructor(options?: undefined | RunnerOptionsFluent);
1757
+ constructor(legacyConcurrency?: undefined | number);
1758
+ readonly type: "ufg";
1485
1759
  get testConcurrency(): undefined | number;
1760
+ get legacyConcurrency(): undefined | number;
1761
+ getConcurrentSessions(): undefined | number;
1486
1762
  }
1487
1763
  export abstract class SessionEventHandler {
1488
1764
  abstract initStarted(): any;