@applitools/eyes-selenium 4.64.0 → 4.65.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/dist/api.js +17 -20
- package/package.json +13 -15
- package/types/index.d.ts +145 -136
package/CHANGELOG.md
CHANGED
|
@@ -8,6 +8,22 @@
|
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
|
|
11
|
+
## 4.65.0 - 2023/4/5
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
- Added `removeDuplicateTests` property to the `RunnerOptions` to remove duplicated tests in the runner at the end of execution
|
|
15
|
+
### Bug fixes
|
|
16
|
+
|
|
17
|
+
## 4.64.1 - 2023/3/22
|
|
18
|
+
|
|
19
|
+
### Features
|
|
20
|
+
- Added `Resize` value to `StitchMode` enum
|
|
21
|
+
- Improved extraction of nml element
|
|
22
|
+
### Bug fixes
|
|
23
|
+
- Avoid handing process when using execution cloud
|
|
24
|
+
- Fixed slowness during ufg tests
|
|
25
|
+
- Optimized number of requests during polling
|
|
26
|
+
|
|
11
27
|
## 4.64.0 - 2023/2/23
|
|
12
28
|
|
|
13
29
|
### Features
|
package/dist/api.js
CHANGED
|
@@ -26,33 +26,30 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
26
26
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
27
27
|
};
|
|
28
28
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
-
exports.closeBatch = exports.BatchClose = exports.Target = exports.
|
|
30
|
-
const
|
|
31
|
-
const api = __importStar(require("@applitools/eyes-api"));
|
|
29
|
+
exports.closeBatch = exports.BatchClose = exports.Configuration = exports.Target = exports.TargetAutomation = exports.CheckSettings = exports.CheckSettingsAutomation = exports.Eyes = void 0;
|
|
30
|
+
const eyes = __importStar(require("@applitools/eyes"));
|
|
32
31
|
const spec = __importStar(require("@applitools/spec-driver-selenium"));
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
});
|
|
37
|
-
__exportStar(require("@applitools/eyes-api"), exports);
|
|
38
|
-
class Eyes extends api.Eyes {
|
|
32
|
+
__exportStar(require("@applitools/eyes"), exports);
|
|
33
|
+
const sdk = { agentId: `eyes.selenium/${require('../package.json').version}`, spec };
|
|
34
|
+
class Eyes extends eyes.Eyes {
|
|
39
35
|
}
|
|
40
36
|
exports.Eyes = Eyes;
|
|
41
|
-
Eyes.
|
|
42
|
-
class
|
|
43
|
-
}
|
|
44
|
-
exports.Configuration = Configuration;
|
|
45
|
-
Configuration._spec = sdk;
|
|
46
|
-
class CheckSettingsAutomation extends api.CheckSettingsAutomation {
|
|
37
|
+
Eyes._sdk = sdk;
|
|
38
|
+
class CheckSettingsAutomation extends eyes.CheckSettingsAutomation {
|
|
47
39
|
}
|
|
48
40
|
exports.CheckSettingsAutomation = CheckSettingsAutomation;
|
|
49
|
-
CheckSettingsAutomation._spec =
|
|
41
|
+
CheckSettingsAutomation._spec = spec;
|
|
50
42
|
class CheckSettings extends CheckSettingsAutomation {
|
|
51
43
|
}
|
|
52
44
|
exports.CheckSettings = CheckSettings;
|
|
53
|
-
exports.
|
|
54
|
-
|
|
45
|
+
exports.TargetAutomation = { ...eyes.TargetAutomation, spec };
|
|
46
|
+
exports.Target = { ...eyes.Target, spec };
|
|
47
|
+
class Configuration extends eyes.Configuration {
|
|
48
|
+
}
|
|
49
|
+
exports.Configuration = Configuration;
|
|
50
|
+
Configuration._spec = spec;
|
|
51
|
+
class BatchClose extends eyes.BatchClose {
|
|
55
52
|
}
|
|
56
53
|
exports.BatchClose = BatchClose;
|
|
57
|
-
BatchClose.
|
|
58
|
-
exports.closeBatch =
|
|
54
|
+
BatchClose._sdk = sdk;
|
|
55
|
+
exports.closeBatch = eyes.closeBatch(sdk);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@applitools/eyes-selenium",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.65.0",
|
|
4
4
|
"description": "Applitools Eyes SDK for Selenium WebDriver",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"eyes-selenium",
|
|
@@ -45,35 +45,33 @@
|
|
|
45
45
|
"build": "node ../../node_modules/.bin/ttsc --project ./tsconfig.build.json",
|
|
46
46
|
"generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes-selenium'",
|
|
47
47
|
"test": "yarn test:coverage",
|
|
48
|
+
"test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-selenium' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage node ../../node_modules/.bin/mocha './test/generic/*.spec.js' -r @applitools/test-utils/mocha-hooks/docker --parallel --jobs ${MOCHA_JOBS:-15} --exit",
|
|
48
49
|
"test:sanity": "echo 'create sanity suite'",
|
|
49
|
-
"
|
|
50
|
-
"report": "coverage-tests report https://raw.githubusercontent.com/applitools/sdk.coverage.tests/master/js/config.js --name 'eyes-selenium'",
|
|
50
|
+
"report": "bongo report --name 'js_selenium_4'",
|
|
51
51
|
"setup": "yarn docker:setup",
|
|
52
52
|
"docker:setup": "node ../../scripts/generate-docker-compose-config.js && docker-compose up -d",
|
|
53
53
|
"docker:teardown": "docker-compose down",
|
|
54
54
|
"upgrade:framework": "if [ ! -z $APPLITOOLS_SELENIUM_MAJOR_VERSION ]; then packagejson=`cat package.json`; yarn upgrade --no-lockfile selenium-webdriver@$APPLITOOLS_SELENIUM_MAJOR_VERSION; echo \"$packagejson\" > package.json; fi",
|
|
55
55
|
"deps": "bongo deps",
|
|
56
|
-
"gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='selenium selenium@3' -f links='types test-utils eyes-sdk-core visual-grid-client eyes
|
|
56
|
+
"gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='selenium selenium@3' -f links='types test-utils eyes-sdk-core visual-grid-client eyes spec-driver-selenium utils driver snippets screenshoter'",
|
|
57
57
|
"gh:publish": "gh workflow run publish-selenium.yml --ref $(git rev-parse --abbrev-ref HEAD)",
|
|
58
58
|
"preversion": "bongo preversion --verifyPendingChanges",
|
|
59
59
|
"version": "bongo version --withPendingChanges",
|
|
60
|
-
"postversion": "bongo postversion"
|
|
60
|
+
"postversion": "bongo postversion",
|
|
61
|
+
"postpublish": "bongo send-release-notification --name 'js_selenium_4'"
|
|
61
62
|
},
|
|
62
63
|
"dependencies": {
|
|
63
|
-
"@applitools/
|
|
64
|
-
"@applitools/
|
|
65
|
-
"@applitools/spec-driver-selenium": "1.5.31"
|
|
64
|
+
"@applitools/eyes": "1.1.2",
|
|
65
|
+
"@applitools/spec-driver-selenium": "1.5.37"
|
|
66
66
|
},
|
|
67
67
|
"devDependencies": {
|
|
68
|
-
"@applitools/api-extractor": "1.2.
|
|
69
|
-
"@applitools/bongo": "^
|
|
70
|
-
"@applitools/sdk-coverage-tests": "
|
|
71
|
-
"@applitools/test-utils": "1.5.
|
|
72
|
-
"@types/node": "12",
|
|
68
|
+
"@applitools/api-extractor": "1.2.12",
|
|
69
|
+
"@applitools/bongo": "^3.0.3",
|
|
70
|
+
"@applitools/sdk-coverage-tests": "3.0.0",
|
|
71
|
+
"@applitools/test-utils": "1.5.16",
|
|
72
|
+
"@types/node": "^12.20.55",
|
|
73
73
|
"@types/selenium-webdriver": "^4.1.1",
|
|
74
74
|
"chromedriver": "105.0.1",
|
|
75
|
-
"mocha": "^9.2.2",
|
|
76
|
-
"mocha-multi": "^1.1.7",
|
|
77
75
|
"selenium-webdriver": "4.4.0"
|
|
78
76
|
},
|
|
79
77
|
"peerDependencies": {
|
package/types/index.d.ts
CHANGED
|
@@ -142,6 +142,115 @@ export class Eyes {
|
|
|
142
142
|
getStitchOverlap(): number;
|
|
143
143
|
setStitchOverlap(stitchOverlap: number): void;
|
|
144
144
|
}
|
|
145
|
+
export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
|
|
146
|
+
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>; })))>;
|
|
147
|
+
webview?: undefined | string | boolean;
|
|
148
|
+
scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
149
|
+
fully?: undefined | boolean;
|
|
150
|
+
disableBrowserFetching?: undefined | boolean;
|
|
151
|
+
layoutBreakpoints?: undefined | boolean | Array<number>;
|
|
152
|
+
visualGridOptions?: undefined | { [key: string]: any; };
|
|
153
|
+
nmgOptions?: undefined | { [key: string]: any; };
|
|
154
|
+
hooks?: undefined | { beforeCaptureScreenshot: string; };
|
|
155
|
+
renderId?: undefined | string;
|
|
156
|
+
timeout?: undefined | number;
|
|
157
|
+
waitBeforeCapture?: undefined | number;
|
|
158
|
+
lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
|
|
159
|
+
};
|
|
160
|
+
export class CheckSettingsAutomation {
|
|
161
|
+
constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain);
|
|
162
|
+
region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
|
|
163
|
+
shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
|
|
164
|
+
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;
|
|
165
|
+
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;
|
|
166
|
+
webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
|
|
167
|
+
scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
|
|
168
|
+
fully(fully?: undefined | boolean): CheckSettingsAutomation;
|
|
169
|
+
disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
|
|
170
|
+
layoutBreakpoints(layoutBreakpoints?: undefined | boolean | Array<number>): CheckSettingsAutomation;
|
|
171
|
+
hook(name: string, script: string): CheckSettingsAutomation;
|
|
172
|
+
beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
|
|
173
|
+
ufgOption(key: string, value: any): CheckSettingsAutomation;
|
|
174
|
+
ufgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
|
|
175
|
+
nmgOption(key: string, value: any): CheckSettingsAutomation;
|
|
176
|
+
nmgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
|
|
177
|
+
renderId(renderId: string): CheckSettingsAutomation;
|
|
178
|
+
timeout(timeout: number): CheckSettingsAutomation;
|
|
179
|
+
waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
|
|
180
|
+
lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
|
|
181
|
+
densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
|
|
182
|
+
name(name: string): CheckSettingsAutomation;
|
|
183
|
+
withName(name: string): CheckSettingsAutomation;
|
|
184
|
+
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;
|
|
185
|
+
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;
|
|
186
|
+
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;
|
|
187
|
+
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;
|
|
188
|
+
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;
|
|
189
|
+
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;
|
|
190
|
+
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;
|
|
191
|
+
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;
|
|
192
|
+
floatingRegion(region: {
|
|
193
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
194
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
195
|
+
regionId?: undefined | string;
|
|
196
|
+
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
197
|
+
}): CheckSettingsAutomation;
|
|
198
|
+
floatingRegion(region: {
|
|
199
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
200
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
201
|
+
regionId?: undefined | string;
|
|
202
|
+
maxUpOffset?: undefined | number;
|
|
203
|
+
maxDownOffset?: undefined | number;
|
|
204
|
+
maxLeftOffset?: undefined | number;
|
|
205
|
+
maxRightOffset?: undefined | number;
|
|
206
|
+
}): CheckSettingsAutomation;
|
|
207
|
+
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;
|
|
208
|
+
floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
209
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
210
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
211
|
+
regionId?: undefined | string;
|
|
212
|
+
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
213
|
+
}>): CheckSettingsAutomation;
|
|
214
|
+
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;
|
|
215
|
+
accessibilityRegion(region: {
|
|
216
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
217
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
218
|
+
regionId?: undefined | string;
|
|
219
|
+
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
220
|
+
}): CheckSettingsAutomation;
|
|
221
|
+
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;
|
|
222
|
+
accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
223
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
224
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
225
|
+
regionId?: undefined | string;
|
|
226
|
+
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
227
|
+
}>): CheckSettingsAutomation;
|
|
228
|
+
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
|
|
229
|
+
matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
|
|
230
|
+
layout(): CheckSettingsAutomation;
|
|
231
|
+
exact(): CheckSettingsAutomation;
|
|
232
|
+
strict(): CheckSettingsAutomation;
|
|
233
|
+
ignoreColors(): CheckSettingsAutomation;
|
|
234
|
+
enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsAutomation;
|
|
235
|
+
ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsAutomation;
|
|
236
|
+
ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsAutomation;
|
|
237
|
+
useDom(useDom?: undefined | boolean): CheckSettingsAutomation;
|
|
238
|
+
sendDom(sendDom?: undefined | boolean): CheckSettingsAutomation;
|
|
239
|
+
pageId(pageId: string): CheckSettingsAutomation;
|
|
240
|
+
variationGroupId(variationGroupId: string): CheckSettingsAutomation;
|
|
241
|
+
}
|
|
242
|
+
export class CheckSettings extends CheckSettingsAutomation {
|
|
243
|
+
}
|
|
244
|
+
export type TargetAutomation = {
|
|
245
|
+
window(): CheckSettingsAutomation;
|
|
246
|
+
region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
|
|
247
|
+
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;
|
|
248
|
+
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;
|
|
249
|
+
shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
|
|
250
|
+
webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
|
|
251
|
+
};
|
|
252
|
+
export const Target: TargetImage & TargetAutomation;
|
|
253
|
+
export type OCRRegion = { target: RegionPlain | Element | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
|
|
145
254
|
export type ConfigurationPlain = {
|
|
146
255
|
agentId?: undefined | string;
|
|
147
256
|
apiKey?: undefined | string;
|
|
@@ -177,7 +286,7 @@ export type ConfigurationPlain = {
|
|
|
177
286
|
matchTimeout?: undefined | number;
|
|
178
287
|
forceFullPageScreenshot?: undefined | boolean;
|
|
179
288
|
waitBeforeScreenshots?: undefined | number;
|
|
180
|
-
stitchMode?: undefined | "Scroll" | "CSS";
|
|
289
|
+
stitchMode?: undefined | "Scroll" | "CSS" | "Resize";
|
|
181
290
|
hideScrollbars?: undefined | boolean;
|
|
182
291
|
hideCaret?: undefined | boolean;
|
|
183
292
|
stitchOverlap?: undefined | number;
|
|
@@ -185,14 +294,14 @@ export type ConfigurationPlain = {
|
|
|
185
294
|
cut?: undefined | CutProviderPlain;
|
|
186
295
|
rotation?: undefined | ImageRotationPlain;
|
|
187
296
|
scaleRatio?: undefined | number;
|
|
188
|
-
waitBeforeCapture?: undefined | number;
|
|
189
297
|
browsersInfo?: undefined | Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
190
298
|
visualGridOptions?: undefined | Record<string, any>;
|
|
191
299
|
layoutBreakpoints?: undefined | boolean | Array<number>;
|
|
192
300
|
disableBrowserFetching?: undefined | boolean;
|
|
301
|
+
waitBeforeCapture?: undefined | number;
|
|
193
302
|
};
|
|
194
303
|
export class Configuration implements Required<ConfigurationPlain> {
|
|
195
|
-
constructor(config?: undefined | ConfigurationPlain
|
|
304
|
+
constructor(config?: undefined | ConfigurationPlain);
|
|
196
305
|
get appName(): string;
|
|
197
306
|
set appName(appName: string);
|
|
198
307
|
getAppName(): string;
|
|
@@ -406,107 +515,6 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
406
515
|
getDisableBrowserFetching(): boolean;
|
|
407
516
|
setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
|
|
408
517
|
}
|
|
409
|
-
export type OCRRegion = { target: RegionPlain | Element | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
|
|
410
|
-
export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
|
|
411
|
-
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>; })))>;
|
|
412
|
-
webview?: undefined | string | boolean;
|
|
413
|
-
scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
414
|
-
fully?: undefined | boolean;
|
|
415
|
-
disableBrowserFetching?: undefined | boolean;
|
|
416
|
-
layoutBreakpoints?: undefined | boolean | Array<number>;
|
|
417
|
-
visualGridOptions?: undefined | { [key: string]: any; };
|
|
418
|
-
nmgOptions?: undefined | { [key: string]: any; };
|
|
419
|
-
hooks?: undefined | { beforeCaptureScreenshot: string; };
|
|
420
|
-
renderId?: undefined | string;
|
|
421
|
-
timeout?: undefined | number;
|
|
422
|
-
waitBeforeCapture?: undefined | number;
|
|
423
|
-
lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
|
|
424
|
-
};
|
|
425
|
-
export class CheckSettingsAutomation {
|
|
426
|
-
constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: undefined | {});
|
|
427
|
-
region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
|
|
428
|
-
shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
|
|
429
|
-
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;
|
|
430
|
-
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;
|
|
431
|
-
webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
|
|
432
|
-
scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
|
|
433
|
-
fully(fully?: undefined | boolean): CheckSettingsAutomation;
|
|
434
|
-
disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
|
|
435
|
-
layoutBreakpoints(layoutBreakpoints?: undefined | boolean | Array<number>): CheckSettingsAutomation;
|
|
436
|
-
hook(name: string, script: string): CheckSettingsAutomation;
|
|
437
|
-
beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
|
|
438
|
-
ufgOption(key: string, value: any): CheckSettingsAutomation;
|
|
439
|
-
ufgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
|
|
440
|
-
nmgOption(key: string, value: any): CheckSettingsAutomation;
|
|
441
|
-
nmgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
|
|
442
|
-
renderId(renderId: string): CheckSettingsAutomation;
|
|
443
|
-
timeout(timeout: number): CheckSettingsAutomation;
|
|
444
|
-
waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
|
|
445
|
-
lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
|
|
446
|
-
densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
|
|
447
|
-
name(name: string): CheckSettingsAutomation;
|
|
448
|
-
withName(name: string): CheckSettingsAutomation;
|
|
449
|
-
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;
|
|
450
|
-
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;
|
|
451
|
-
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;
|
|
452
|
-
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;
|
|
453
|
-
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;
|
|
454
|
-
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;
|
|
455
|
-
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;
|
|
456
|
-
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;
|
|
457
|
-
floatingRegion(region: {
|
|
458
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
459
|
-
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
460
|
-
regionId?: undefined | string;
|
|
461
|
-
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
462
|
-
}): CheckSettingsAutomation;
|
|
463
|
-
floatingRegion(region: {
|
|
464
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
465
|
-
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
466
|
-
regionId?: undefined | string;
|
|
467
|
-
maxUpOffset?: undefined | number;
|
|
468
|
-
maxDownOffset?: undefined | number;
|
|
469
|
-
maxLeftOffset?: undefined | number;
|
|
470
|
-
maxRightOffset?: undefined | number;
|
|
471
|
-
}): CheckSettingsAutomation;
|
|
472
|
-
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;
|
|
473
|
-
floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
474
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
475
|
-
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
476
|
-
regionId?: undefined | string;
|
|
477
|
-
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
478
|
-
}>): CheckSettingsAutomation;
|
|
479
|
-
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;
|
|
480
|
-
accessibilityRegion(region: {
|
|
481
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
482
|
-
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
483
|
-
regionId?: undefined | string;
|
|
484
|
-
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
485
|
-
}): CheckSettingsAutomation;
|
|
486
|
-
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;
|
|
487
|
-
accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
488
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
489
|
-
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
490
|
-
regionId?: undefined | string;
|
|
491
|
-
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
492
|
-
}>): CheckSettingsAutomation;
|
|
493
|
-
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
|
|
494
|
-
matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
|
|
495
|
-
layout(): CheckSettingsAutomation;
|
|
496
|
-
exact(): CheckSettingsAutomation;
|
|
497
|
-
strict(): CheckSettingsAutomation;
|
|
498
|
-
ignoreColors(): CheckSettingsAutomation;
|
|
499
|
-
enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsAutomation;
|
|
500
|
-
ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsAutomation;
|
|
501
|
-
ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsAutomation;
|
|
502
|
-
useDom(useDom?: undefined | boolean): CheckSettingsAutomation;
|
|
503
|
-
sendDom(sendDom?: undefined | boolean): CheckSettingsAutomation;
|
|
504
|
-
pageId(pageId: string): CheckSettingsAutomation;
|
|
505
|
-
variationGroupId(variationGroupId: string): CheckSettingsAutomation;
|
|
506
|
-
}
|
|
507
|
-
export class CheckSettings extends CheckSettingsAutomation {
|
|
508
|
-
}
|
|
509
|
-
export const Target: TargetImage & TargetAutomation<SpecType>;
|
|
510
518
|
export class BatchClose {
|
|
511
519
|
static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
|
|
512
520
|
constructor(options?: undefined | { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; });
|
|
@@ -708,7 +716,7 @@ export enum AndroidVersion {
|
|
|
708
716
|
LATEST = 'latest',
|
|
709
717
|
ONE_VERSION_BACK = 'latest-1'
|
|
710
718
|
}
|
|
711
|
-
export type MatchLevelPlain = "None" | "
|
|
719
|
+
export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
712
720
|
export enum MatchLevel {
|
|
713
721
|
None = 'None',
|
|
714
722
|
LegacyLayout = 'Layout1',
|
|
@@ -729,12 +737,15 @@ export enum SessionType {
|
|
|
729
737
|
SEQUENTIAL = 'SEQUENTIAL',
|
|
730
738
|
PROGRESSION = 'PROGRESSION'
|
|
731
739
|
}
|
|
732
|
-
export type StitchModePlain = "Scroll" | "CSS";
|
|
740
|
+
export type StitchModePlain = "Scroll" | "CSS" | "Resize";
|
|
733
741
|
export enum StitchMode {
|
|
734
742
|
SCROLL = 'Scroll',
|
|
735
|
-
|
|
743
|
+
Scroll = 'Scroll',
|
|
744
|
+
CSS = 'CSS',
|
|
745
|
+
RESIZE = 'Resize',
|
|
746
|
+
Resize = 'Resize'
|
|
736
747
|
}
|
|
737
|
-
export type TestResultsStatusPlain = "Passed" | "
|
|
748
|
+
export type TestResultsStatusPlain = "Passed" | "Failed" | "Unresolved";
|
|
738
749
|
export enum TestResultsStatus {
|
|
739
750
|
Passed = 'Passed',
|
|
740
751
|
Unresolved = 'Unresolved',
|
|
@@ -821,7 +832,7 @@ export class BatchInfo implements Required<BatchInfoPlain> {
|
|
|
821
832
|
export type CheckSettingsImagePlain = {
|
|
822
833
|
name?: undefined | string;
|
|
823
834
|
region?: undefined | RegionPlain;
|
|
824
|
-
matchLevel?: undefined | "None" | "
|
|
835
|
+
matchLevel?: undefined | "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
825
836
|
useDom?: undefined | boolean;
|
|
826
837
|
sendDom?: undefined | boolean;
|
|
827
838
|
enablePatterns?: undefined | boolean;
|
|
@@ -940,14 +951,6 @@ export type TargetImage = {
|
|
|
940
951
|
path(imagePath: string): CheckSettingsImage;
|
|
941
952
|
url(imageUrl: string | URL): CheckSettingsImage;
|
|
942
953
|
};
|
|
943
|
-
export type TargetAutomation<TSpec extends SpecType = SpecType> = {
|
|
944
|
-
window(): CheckSettingsAutomation;
|
|
945
|
-
region(region: LegacyRegionPlain | (RegionPlain | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })))): CheckSettingsAutomation;
|
|
946
|
-
frame(context: { frame: number | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })); scrollRootElement?: undefined | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })); }): CheckSettingsAutomation;
|
|
947
|
-
frame(frame: number | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })), scrollRootElement?: undefined | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))): CheckSettingsAutomation;
|
|
948
|
-
shadow(selector: string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }): CheckSettingsAutomation;
|
|
949
|
-
webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
|
|
950
|
-
};
|
|
951
954
|
export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
|
|
952
955
|
export class CutProvider implements Required<{
|
|
953
956
|
x: number;
|
|
@@ -1038,7 +1041,7 @@ export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlai
|
|
|
1038
1041
|
}
|
|
1039
1042
|
export type ImageMatchSettingsPlain = {
|
|
1040
1043
|
exact?: undefined | ExactMatchSettingsPlain;
|
|
1041
|
-
matchLevel?: undefined | "None" | "
|
|
1044
|
+
matchLevel?: undefined | "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
1042
1045
|
ignoreCaret?: undefined | boolean;
|
|
1043
1046
|
useDom?: undefined | boolean;
|
|
1044
1047
|
enablePatterns?: undefined | boolean;
|
|
@@ -1248,18 +1251,18 @@ export type DesktopBrowserInfo = { name?: undefined | "chrome" | "chrome-one-ver
|
|
|
1248
1251
|
export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }; };
|
|
1249
1252
|
export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
|
|
1250
1253
|
export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
|
|
1251
|
-
export type RunnerOptionsPlain = { testConcurrency?: undefined | number; };
|
|
1254
|
+
export type RunnerOptionsPlain = { testConcurrency?: undefined | number; removeDuplicateTests?: undefined | boolean; };
|
|
1252
1255
|
export class RunnerOptionsFluent {
|
|
1253
1256
|
testConcurrency(concurrency: number): RunnerOptionsFluent;
|
|
1254
1257
|
}
|
|
1255
1258
|
export function RunnerOptions(): RunnerOptionsFluent;
|
|
1256
1259
|
export type VisualLocatorSettings<TLocator extends string = string> = { locatorNames: Array<TLocator>; firstOnly: boolean; };
|
|
1257
1260
|
export type ApiUrlsPlain = {
|
|
1258
|
-
readonly baselineImage
|
|
1259
|
-
readonly currentImage
|
|
1260
|
-
readonly checkpointImage
|
|
1261
|
-
readonly checkpointImageThumbnail
|
|
1262
|
-
readonly diffImage
|
|
1261
|
+
readonly baselineImage: string;
|
|
1262
|
+
readonly currentImage: string;
|
|
1263
|
+
readonly checkpointImage: string;
|
|
1264
|
+
readonly checkpointImageThumbnail: string;
|
|
1265
|
+
readonly diffImage: string;
|
|
1263
1266
|
};
|
|
1264
1267
|
export class ApiUrls implements Required<ApiUrlsPlain> {
|
|
1265
1268
|
get baselineImage(): string;
|
|
@@ -1273,7 +1276,7 @@ export class ApiUrls implements Required<ApiUrlsPlain> {
|
|
|
1273
1276
|
get diffImage(): string;
|
|
1274
1277
|
getDiffImage(): string;
|
|
1275
1278
|
}
|
|
1276
|
-
export type AppUrlsPlain = { readonly step
|
|
1279
|
+
export type AppUrlsPlain = { readonly step: string; readonly stepEditor: string; };
|
|
1277
1280
|
export class AppUrls implements Required<AppUrlsPlain> {
|
|
1278
1281
|
get step(): string;
|
|
1279
1282
|
getStep(): string;
|
|
@@ -1287,7 +1290,7 @@ export class MatchResult implements Required<MatchResultPlain> {
|
|
|
1287
1290
|
get windowId(): number;
|
|
1288
1291
|
getWindowId(): number;
|
|
1289
1292
|
}
|
|
1290
|
-
export type SessionUrlsPlain = { readonly batch
|
|
1293
|
+
export type SessionUrlsPlain = { readonly batch: string; readonly session: string; };
|
|
1291
1294
|
export class SessionUrls implements Required<SessionUrlsPlain> {
|
|
1292
1295
|
get batch(): string;
|
|
1293
1296
|
getBatch(): string;
|
|
@@ -1295,13 +1298,13 @@ export class SessionUrls implements Required<SessionUrlsPlain> {
|
|
|
1295
1298
|
getSession(): string;
|
|
1296
1299
|
}
|
|
1297
1300
|
export type StepInfoPlain = {
|
|
1298
|
-
readonly name
|
|
1299
|
-
readonly isDifferent
|
|
1300
|
-
readonly hasBaselineImage
|
|
1301
|
-
readonly hasCurrentImage
|
|
1302
|
-
readonly appUrls
|
|
1303
|
-
readonly apiUrls
|
|
1304
|
-
readonly renderId
|
|
1301
|
+
readonly name: string;
|
|
1302
|
+
readonly isDifferent: boolean;
|
|
1303
|
+
readonly hasBaselineImage: boolean;
|
|
1304
|
+
readonly hasCurrentImage: boolean;
|
|
1305
|
+
readonly appUrls: AppUrlsPlain;
|
|
1306
|
+
readonly apiUrls: ApiUrlsPlain;
|
|
1307
|
+
readonly renderId: Array<string>;
|
|
1305
1308
|
};
|
|
1306
1309
|
export class StepInfo implements Required<StepInfoPlain> {
|
|
1307
1310
|
get name(): string;
|
|
@@ -1324,7 +1327,7 @@ export type TestResultsPlain = {
|
|
|
1324
1327
|
readonly id?: undefined | string;
|
|
1325
1328
|
readonly name?: undefined | string;
|
|
1326
1329
|
readonly secretToken?: undefined | string;
|
|
1327
|
-
readonly status?: undefined | "Passed" | "
|
|
1330
|
+
readonly status?: undefined | "Passed" | "Failed" | "Unresolved";
|
|
1328
1331
|
readonly appName?: undefined | string;
|
|
1329
1332
|
readonly batchId?: undefined | string;
|
|
1330
1333
|
readonly batchName?: undefined | string;
|
|
@@ -1333,7 +1336,7 @@ export type TestResultsPlain = {
|
|
|
1333
1336
|
readonly hostApp?: undefined | string;
|
|
1334
1337
|
readonly hostDisplaySize?: undefined | RectangleSizePlain;
|
|
1335
1338
|
readonly accessibilityStatus?: undefined | TestAccessibilityStatus;
|
|
1336
|
-
readonly startedAt?: undefined | string
|
|
1339
|
+
readonly startedAt?: undefined | string;
|
|
1337
1340
|
readonly duration?: undefined | number;
|
|
1338
1341
|
readonly isNew?: undefined | boolean;
|
|
1339
1342
|
readonly isDifferent?: undefined | boolean;
|
|
@@ -1351,6 +1354,8 @@ export type TestResultsPlain = {
|
|
|
1351
1354
|
readonly layoutMatches?: undefined | number;
|
|
1352
1355
|
readonly noneMatches?: undefined | number;
|
|
1353
1356
|
readonly url?: undefined | string;
|
|
1357
|
+
readonly server: { serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; };
|
|
1358
|
+
readonly keepIfDuplicate: boolean;
|
|
1354
1359
|
};
|
|
1355
1360
|
export class TestResults implements Required<TestResultsPlain> {
|
|
1356
1361
|
get id(): string;
|
|
@@ -1377,7 +1382,7 @@ export class TestResults implements Required<TestResultsPlain> {
|
|
|
1377
1382
|
getHostDisplaySize(): RectangleSize;
|
|
1378
1383
|
get accessibilityStatus(): TestAccessibilityStatus;
|
|
1379
1384
|
getAccessibilityStatus(): TestAccessibilityStatus;
|
|
1380
|
-
get startedAt(): string
|
|
1385
|
+
get startedAt(): string;
|
|
1381
1386
|
getStartedAt(): Date;
|
|
1382
1387
|
get duration(): number;
|
|
1383
1388
|
getDuration(): number;
|
|
@@ -1413,6 +1418,8 @@ export class TestResults implements Required<TestResultsPlain> {
|
|
|
1413
1418
|
getNoneMatches(): number;
|
|
1414
1419
|
get url(): string;
|
|
1415
1420
|
getUrl(): string;
|
|
1421
|
+
get server(): { serverUrl: string; apiKey: string; proxy?: undefined | { url: string; username?: undefined | string; password?: undefined | string; }; agentId?: undefined | string; };
|
|
1422
|
+
get keepIfDuplicate(): boolean;
|
|
1416
1423
|
isPassed(): boolean;
|
|
1417
1424
|
delete(): Promise<void>;
|
|
1418
1425
|
}
|
|
@@ -1466,9 +1473,11 @@ export class Logger {
|
|
|
1466
1473
|
extend(label?: undefined | string): Logger;
|
|
1467
1474
|
}
|
|
1468
1475
|
export abstract class EyesRunner {
|
|
1476
|
+
abstract readonly type: "classic" | "ufg";
|
|
1469
1477
|
getAllTestResults(throwErr?: undefined | boolean): Promise<TestResultsSummary>;
|
|
1470
1478
|
}
|
|
1471
1479
|
export class ClassicRunner extends EyesRunner {
|
|
1480
|
+
constructor(options?: undefined | RunnerOptionsPlain);
|
|
1472
1481
|
}
|
|
1473
1482
|
export class VisualGridRunner extends EyesRunner {
|
|
1474
1483
|
constructor(options?: undefined | RunnerOptionsPlain);
|