@applitools/eyes-webdriverio 5.42.1 → 5.42.3
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 +14 -0
- package/dist/api.js +18 -22
- package/dist/service.js +4 -31
- package/package.json +15 -18
- package/types/index.d.ts +132 -129
package/CHANGELOG.md
CHANGED
|
@@ -10,6 +10,20 @@
|
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
|
|
13
|
+
## 5.42.3 - 2023/3/17
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
- Improved extraction of nml element
|
|
17
|
+
### Bug fixes
|
|
18
|
+
- Avoid handing process when using execution cloud
|
|
19
|
+
- Fixed slowness during ufg tests
|
|
20
|
+
|
|
21
|
+
## 5.42.2 - 2023/3/7
|
|
22
|
+
|
|
23
|
+
### Features
|
|
24
|
+
- Added `Resize` value to `StitchMode` enum
|
|
25
|
+
### Bug fixes
|
|
26
|
+
|
|
13
27
|
## 5.42.1 - 2023/3/7
|
|
14
28
|
|
|
15
29
|
### Features
|
package/dist/api.js
CHANGED
|
@@ -26,35 +26,31 @@ 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.
|
|
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-webdriverio"));
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
__exportStar(require("@applitools/eyes-api"), exports);
|
|
38
|
-
var legacy_1 = require("./legacy");
|
|
39
|
-
Object.defineProperty(exports, "By", { enumerable: true, get: function () { return legacy_1.By; } });
|
|
40
|
-
class Eyes extends api.Eyes {
|
|
32
|
+
__exportStar(require("@applitools/eyes"), exports);
|
|
33
|
+
__exportStar(require("./legacy"), exports);
|
|
34
|
+
const sdk = { agentId: `eyes-webdriverio/${require('../package.json').version}`, spec };
|
|
35
|
+
class Eyes extends eyes.Eyes {
|
|
41
36
|
}
|
|
42
37
|
exports.Eyes = Eyes;
|
|
43
|
-
Eyes.
|
|
44
|
-
class
|
|
45
|
-
}
|
|
46
|
-
exports.Configuration = Configuration;
|
|
47
|
-
Configuration._spec = sdk;
|
|
48
|
-
class CheckSettingsAutomation extends api.CheckSettingsAutomation {
|
|
38
|
+
Eyes._sdk = sdk;
|
|
39
|
+
class CheckSettingsAutomation extends eyes.CheckSettingsAutomation {
|
|
49
40
|
}
|
|
50
41
|
exports.CheckSettingsAutomation = CheckSettingsAutomation;
|
|
51
|
-
CheckSettingsAutomation._spec =
|
|
42
|
+
CheckSettingsAutomation._spec = spec;
|
|
52
43
|
class CheckSettings extends CheckSettingsAutomation {
|
|
53
44
|
}
|
|
54
45
|
exports.CheckSettings = CheckSettings;
|
|
55
|
-
exports.
|
|
56
|
-
|
|
46
|
+
exports.TargetAutomation = { ...eyes.TargetAutomation, spec };
|
|
47
|
+
exports.Target = { ...eyes.Target, spec };
|
|
48
|
+
class Configuration extends eyes.Configuration {
|
|
49
|
+
}
|
|
50
|
+
exports.Configuration = Configuration;
|
|
51
|
+
Configuration._spec = spec;
|
|
52
|
+
class BatchClose extends eyes.BatchClose {
|
|
57
53
|
}
|
|
58
54
|
exports.BatchClose = BatchClose;
|
|
59
|
-
BatchClose.
|
|
60
|
-
exports.closeBatch =
|
|
55
|
+
BatchClose._sdk = sdk;
|
|
56
|
+
exports.closeBatch = eyes.closeBatch(sdk);
|
package/dist/service.js
CHANGED
|
@@ -1,30 +1,5 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
-
}) : function(o, v) {
|
|
16
|
-
o["default"] = v;
|
|
17
|
-
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
-
if (mod && mod.__esModule) return mod;
|
|
20
|
-
var result = {};
|
|
21
|
-
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
-
__setModuleDefault(result, mod);
|
|
23
|
-
return result;
|
|
24
|
-
};
|
|
25
2
|
var _a;
|
|
26
|
-
const core_1 = require("@applitools/core");
|
|
27
|
-
const spec = __importStar(require("./spec-driver"));
|
|
28
3
|
const api_1 = require("./api");
|
|
29
4
|
if (!process.env.APPLITOOLS_WEBDRIVERIO_MAJOR_VERSION) {
|
|
30
5
|
try {
|
|
@@ -36,14 +11,12 @@ if (!process.env.APPLITOOLS_WEBDRIVERIO_MAJOR_VERSION) {
|
|
|
36
11
|
// NOTE: ignore error
|
|
37
12
|
}
|
|
38
13
|
}
|
|
39
|
-
// TODO have to be removed
|
|
40
|
-
const sdk = (0, core_1.makeCore)({
|
|
41
|
-
agentId: `eyes-webdriverio-service/${require('../package.json').version}`,
|
|
42
|
-
spec,
|
|
43
|
-
});
|
|
44
14
|
class EyesOverride extends api_1.Eyes {
|
|
45
15
|
}
|
|
46
|
-
EyesOverride.
|
|
16
|
+
EyesOverride._sdk = {
|
|
17
|
+
...api_1.Eyes._sdk,
|
|
18
|
+
agentId: `eyes-webdriverio-service/${require('../package.json').version}`,
|
|
19
|
+
};
|
|
47
20
|
class EyesService {
|
|
48
21
|
constructor({ useVisualGrid, concurrency, eyes, ...config }) {
|
|
49
22
|
const wdioMajorVersion = Number(process.env.APPLITOOLS_WEBDRIVERIO_MAJOR_VERSION);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@applitools/eyes-webdriverio",
|
|
3
|
-
"version": "5.42.
|
|
3
|
+
"version": "5.42.3",
|
|
4
4
|
"description": "Applitools Eyes SDK for WebdriverIO",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"eyes-webdriverio",
|
|
@@ -92,36 +92,35 @@
|
|
|
92
92
|
"build": "node ../../node_modules/.bin/ttsc --project tsconfig.build.v$([ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ] && echo ${APPLITOOLS_WEBDRIVERIO_VERSION%%.*} || echo 8).json",
|
|
93
93
|
"generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes.webdriverio.javascript5'",
|
|
94
94
|
"test": "yarn test:service && yarn test:coverage",
|
|
95
|
-
"test:
|
|
96
|
-
"test:
|
|
97
|
-
"test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-webdriverio-5' APPLITOOLS_BATCH_ID=$(uuidgen) mocha --config .mocharc.cvg.js",
|
|
95
|
+
"test:service": "MOCHA_GROUP=service node ../../node_modules/.bin/mocha './test/service/unit/*.spec.js' && wdio run ./test/service/wdio.conf.js && wdio run ./test/service/no-config/wdio.no-config.conf.js && wdio run ./test/service/vg/wdio.vg.conf.js",
|
|
96
|
+
"test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-webdriverio' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage node ../../node_modules/.bin/mocha './test/generic/*.spec.js' --parallel --jobs ${MOCHA_JOBS:-15} --exit",
|
|
98
97
|
"test:coverage:wd": "APPLITOOLS_WEBDRIVERIO_PROTOCOL=wd yarn test:coverage",
|
|
99
98
|
"test:coverage:cdp": "APPLITOOLS_WEBDRIVERIO_PROTOCOL=cdp yarn test:coverage",
|
|
100
|
-
"report": "
|
|
99
|
+
"report": "bongo report --name 'js_wdio_5'",
|
|
100
|
+
"test:sanity": "echo 'create sanity suite'",
|
|
101
101
|
"setup": "yarn docker:setup",
|
|
102
102
|
"docker:setup": "node ../../scripts/generate-docker-compose-config.js && docker-compose up -d",
|
|
103
103
|
"docker:teardown": "docker-compose down",
|
|
104
104
|
"upgrade:framework": "if [ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ]; then packagejson=`cat package.json`; NODE_VERSION=${NODE_VERSION:-$(node -v)} yarn upgrade --no-lockfile webdriverio@$APPLITOOLS_WEBDRIVERIO_VERSION @types/node@${NODE_VERSION%%.*}; echo \"$packagejson\" > package.json; fi",
|
|
105
105
|
"deps": "bongo deps",
|
|
106
106
|
"gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio(node:14) wdio(node:12) wdio(protocol:cdp) wdio(framework:6) wdio(framework:5)'",
|
|
107
|
-
"gh:test:links": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio+cdp wdio@6 wdio@5' -f links='types test-utils eyes-sdk-core visual-grid-client eyes
|
|
107
|
+
"gh:test:links": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio+cdp wdio@6 wdio@5' -f links='types test-utils eyes-sdk-core visual-grid-client eyes spec-driver-webdriverio utils driver snippets screenshoter'",
|
|
108
108
|
"gh:publish": "gh workflow run publish-webdriverio.yml --ref $(git rev-parse --abbrev-ref HEAD)",
|
|
109
109
|
"preversion": "bongo preversion --verifyPendingChanges",
|
|
110
110
|
"version": "bongo version --withPendingChanges",
|
|
111
|
-
"postversion": "bongo postversion"
|
|
111
|
+
"postversion": "bongo postversion",
|
|
112
|
+
"postpublish": "bongo send-release-notification --name 'js_wdio_5'"
|
|
112
113
|
},
|
|
113
114
|
"dependencies": {
|
|
114
|
-
"@applitools/
|
|
115
|
-
"@applitools/
|
|
116
|
-
"@applitools/spec-driver-webdriverio": "1.4.30"
|
|
115
|
+
"@applitools/eyes": "1.0.1",
|
|
116
|
+
"@applitools/spec-driver-webdriverio": "1.4.32"
|
|
117
117
|
},
|
|
118
118
|
"devDependencies": {
|
|
119
|
-
"@applitools/api-extractor": "1.2.
|
|
120
|
-
"@applitools/bongo": "^
|
|
121
|
-
"@applitools/sdk-coverage-tests": "^
|
|
122
|
-
"@applitools/test-utils": "1.5.
|
|
123
|
-
"@types/
|
|
124
|
-
"@types/node": "16",
|
|
119
|
+
"@applitools/api-extractor": "1.2.12",
|
|
120
|
+
"@applitools/bongo": "^3.0.1",
|
|
121
|
+
"@applitools/sdk-coverage-tests": "^3.0.0",
|
|
122
|
+
"@applitools/test-utils": "1.5.14",
|
|
123
|
+
"@types/node": "^16.18.14",
|
|
125
124
|
"@wdio/cli": "^8.3.9",
|
|
126
125
|
"@wdio/dot-reporter": "^8.3.0",
|
|
127
126
|
"@wdio/globals": "^8.3.9",
|
|
@@ -130,8 +129,6 @@
|
|
|
130
129
|
"chromedriver": "^109.0.0",
|
|
131
130
|
"expect-webdriverio": "^4.0.1",
|
|
132
131
|
"geckodriver": "^1.20.0",
|
|
133
|
-
"mocha": "^9.2.2",
|
|
134
|
-
"mocha-multi": "^1.1.7",
|
|
135
132
|
"webdriverio": "^8.3.9"
|
|
136
133
|
},
|
|
137
134
|
"peerDependencies": {
|
package/types/index.d.ts
CHANGED
|
@@ -1,18 +1,3 @@
|
|
|
1
|
-
export class By {
|
|
2
|
-
static css(css: string): By;
|
|
3
|
-
static cssSelector(css: string): By;
|
|
4
|
-
static id(id: string): By;
|
|
5
|
-
static className(className: string): By;
|
|
6
|
-
static attributeValue(attr: string, value: string): By;
|
|
7
|
-
static name(name: string): By;
|
|
8
|
-
static tagName(tagName: string): By;
|
|
9
|
-
static xpath(xpath: string): By;
|
|
10
|
-
static xPath(xpath: string): By;
|
|
11
|
-
constructor(value: string, using: string);
|
|
12
|
-
readonly value: string;
|
|
13
|
-
readonly using: string;
|
|
14
|
-
toString(): string;
|
|
15
|
-
}
|
|
16
1
|
export type Driver = Applitools.WebdriverIO.Browser & { __applitoolsBrand?: undefined; };
|
|
17
2
|
export type Element = (Applitools.WebdriverIO.Element | { ELEMENT: string; } | { 'element-6066-11e4-a52e-4f735466cecf': string; }) & { __applitoolsBrand?: undefined; };
|
|
18
3
|
export type Selector = (Applitools.WebdriverIO.Selector | { using: string; value: string; }) & { __applitoolsBrand?: undefined; };
|
|
@@ -157,6 +142,115 @@ export class Eyes {
|
|
|
157
142
|
getStitchOverlap(): number;
|
|
158
143
|
setStitchOverlap(stitchOverlap: number): void;
|
|
159
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: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
|
|
208
|
+
floatingRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
|
|
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<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain>): 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: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsAutomation;
|
|
222
|
+
accessibilityRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
|
|
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<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain>): 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: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain): 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: Element | RegionPlain | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
|
|
160
254
|
export type ConfigurationPlain = {
|
|
161
255
|
agentId?: undefined | string;
|
|
162
256
|
apiKey?: undefined | string;
|
|
@@ -192,7 +286,7 @@ export type ConfigurationPlain = {
|
|
|
192
286
|
matchTimeout?: undefined | number;
|
|
193
287
|
forceFullPageScreenshot?: undefined | boolean;
|
|
194
288
|
waitBeforeScreenshots?: undefined | number;
|
|
195
|
-
stitchMode?: undefined | "Scroll" | "CSS";
|
|
289
|
+
stitchMode?: undefined | "Scroll" | "CSS" | "Resize";
|
|
196
290
|
hideScrollbars?: undefined | boolean;
|
|
197
291
|
hideCaret?: undefined | boolean;
|
|
198
292
|
stitchOverlap?: undefined | number;
|
|
@@ -200,14 +294,14 @@ export type ConfigurationPlain = {
|
|
|
200
294
|
cut?: undefined | CutProviderPlain;
|
|
201
295
|
rotation?: undefined | ImageRotationPlain;
|
|
202
296
|
scaleRatio?: undefined | number;
|
|
203
|
-
waitBeforeCapture?: undefined | number;
|
|
204
297
|
browsersInfo?: undefined | Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
205
298
|
visualGridOptions?: undefined | Record<string, any>;
|
|
206
299
|
layoutBreakpoints?: undefined | boolean | Array<number>;
|
|
207
300
|
disableBrowserFetching?: undefined | boolean;
|
|
301
|
+
waitBeforeCapture?: undefined | number;
|
|
208
302
|
};
|
|
209
303
|
export class Configuration implements Required<ConfigurationPlain> {
|
|
210
|
-
constructor(config?: undefined | ConfigurationPlain
|
|
304
|
+
constructor(config?: undefined | ConfigurationPlain);
|
|
211
305
|
get appName(): string;
|
|
212
306
|
set appName(appName: string);
|
|
213
307
|
getAppName(): string;
|
|
@@ -421,107 +515,6 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
421
515
|
getDisableBrowserFetching(): boolean;
|
|
422
516
|
setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
|
|
423
517
|
}
|
|
424
|
-
export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
|
|
425
|
-
export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
|
|
426
|
-
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>; })))>;
|
|
427
|
-
webview?: undefined | string | boolean;
|
|
428
|
-
scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
429
|
-
fully?: undefined | boolean;
|
|
430
|
-
disableBrowserFetching?: undefined | boolean;
|
|
431
|
-
layoutBreakpoints?: undefined | boolean | Array<number>;
|
|
432
|
-
visualGridOptions?: undefined | { [key: string]: any; };
|
|
433
|
-
nmgOptions?: undefined | { [key: string]: any; };
|
|
434
|
-
hooks?: undefined | { beforeCaptureScreenshot: string; };
|
|
435
|
-
renderId?: undefined | string;
|
|
436
|
-
timeout?: undefined | number;
|
|
437
|
-
waitBeforeCapture?: undefined | number;
|
|
438
|
-
lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
|
|
439
|
-
};
|
|
440
|
-
export class CheckSettingsAutomation {
|
|
441
|
-
constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: undefined | {});
|
|
442
|
-
region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
|
|
443
|
-
shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
|
|
444
|
-
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;
|
|
445
|
-
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;
|
|
446
|
-
webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
|
|
447
|
-
scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
|
|
448
|
-
fully(fully?: undefined | boolean): CheckSettingsAutomation;
|
|
449
|
-
disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
|
|
450
|
-
layoutBreakpoints(layoutBreakpoints?: undefined | boolean | Array<number>): CheckSettingsAutomation;
|
|
451
|
-
hook(name: string, script: string): CheckSettingsAutomation;
|
|
452
|
-
beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
|
|
453
|
-
ufgOption(key: string, value: any): CheckSettingsAutomation;
|
|
454
|
-
ufgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
|
|
455
|
-
nmgOption(key: string, value: any): CheckSettingsAutomation;
|
|
456
|
-
nmgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
|
|
457
|
-
renderId(renderId: string): CheckSettingsAutomation;
|
|
458
|
-
timeout(timeout: number): CheckSettingsAutomation;
|
|
459
|
-
waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
|
|
460
|
-
lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
|
|
461
|
-
densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
|
|
462
|
-
name(name: string): CheckSettingsAutomation;
|
|
463
|
-
withName(name: string): CheckSettingsAutomation;
|
|
464
|
-
ignoreRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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;
|
|
465
|
-
ignoreRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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;
|
|
466
|
-
layoutRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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;
|
|
467
|
-
layoutRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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;
|
|
468
|
-
strictRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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;
|
|
469
|
-
strictRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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;
|
|
470
|
-
contentRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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;
|
|
471
|
-
contentRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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;
|
|
472
|
-
floatingRegion(region: {
|
|
473
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
474
|
-
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
475
|
-
regionId?: undefined | string;
|
|
476
|
-
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
477
|
-
}): CheckSettingsAutomation;
|
|
478
|
-
floatingRegion(region: {
|
|
479
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
480
|
-
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
481
|
-
regionId?: undefined | string;
|
|
482
|
-
maxUpOffset?: undefined | number;
|
|
483
|
-
maxDownOffset?: undefined | number;
|
|
484
|
-
maxLeftOffset?: undefined | number;
|
|
485
|
-
maxRightOffset?: undefined | number;
|
|
486
|
-
}): CheckSettingsAutomation;
|
|
487
|
-
floatingRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
|
|
488
|
-
floatingRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
|
|
489
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
490
|
-
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
491
|
-
regionId?: undefined | string;
|
|
492
|
-
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
493
|
-
}>): CheckSettingsAutomation;
|
|
494
|
-
floatingRegions(maxOffset: number, ...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain>): CheckSettingsAutomation;
|
|
495
|
-
accessibilityRegion(region: {
|
|
496
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
497
|
-
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
498
|
-
regionId?: undefined | string;
|
|
499
|
-
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
500
|
-
}): CheckSettingsAutomation;
|
|
501
|
-
accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsAutomation;
|
|
502
|
-
accessibilityRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
|
|
503
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
504
|
-
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
505
|
-
regionId?: undefined | string;
|
|
506
|
-
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
507
|
-
}>): CheckSettingsAutomation;
|
|
508
|
-
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain>): CheckSettingsAutomation;
|
|
509
|
-
matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
|
|
510
|
-
layout(): CheckSettingsAutomation;
|
|
511
|
-
exact(): CheckSettingsAutomation;
|
|
512
|
-
strict(): CheckSettingsAutomation;
|
|
513
|
-
ignoreColors(): CheckSettingsAutomation;
|
|
514
|
-
enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsAutomation;
|
|
515
|
-
ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsAutomation;
|
|
516
|
-
ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsAutomation;
|
|
517
|
-
useDom(useDom?: undefined | boolean): CheckSettingsAutomation;
|
|
518
|
-
sendDom(sendDom?: undefined | boolean): CheckSettingsAutomation;
|
|
519
|
-
pageId(pageId: string): CheckSettingsAutomation;
|
|
520
|
-
variationGroupId(variationGroupId: string): CheckSettingsAutomation;
|
|
521
|
-
}
|
|
522
|
-
export class CheckSettings extends CheckSettingsAutomation {
|
|
523
|
-
}
|
|
524
|
-
export const Target: TargetImage & TargetAutomation<SpecType>;
|
|
525
518
|
export class BatchClose {
|
|
526
519
|
static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
|
|
527
520
|
constructor(options?: undefined | { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; });
|
|
@@ -744,10 +737,13 @@ export enum SessionType {
|
|
|
744
737
|
SEQUENTIAL = 'SEQUENTIAL',
|
|
745
738
|
PROGRESSION = 'PROGRESSION'
|
|
746
739
|
}
|
|
747
|
-
export type StitchModePlain = "Scroll" | "CSS";
|
|
740
|
+
export type StitchModePlain = "Scroll" | "CSS" | "Resize";
|
|
748
741
|
export enum StitchMode {
|
|
749
742
|
SCROLL = 'Scroll',
|
|
750
|
-
|
|
743
|
+
Scroll = 'Scroll',
|
|
744
|
+
CSS = 'CSS',
|
|
745
|
+
RESIZE = 'Resize',
|
|
746
|
+
Resize = 'Resize'
|
|
751
747
|
}
|
|
752
748
|
export type TestResultsStatusPlain = "Passed" | "Failed" | "Unresolved";
|
|
753
749
|
export enum TestResultsStatus {
|
|
@@ -955,14 +951,6 @@ export type TargetImage = {
|
|
|
955
951
|
path(imagePath: string): CheckSettingsImage;
|
|
956
952
|
url(imageUrl: string | URL): CheckSettingsImage;
|
|
957
953
|
};
|
|
958
|
-
export type TargetAutomation<TSpec extends SpecType = SpecType> = {
|
|
959
|
-
window(): CheckSettingsAutomation;
|
|
960
|
-
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;
|
|
961
|
-
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;
|
|
962
|
-
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;
|
|
963
|
-
shadow(selector: string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }): CheckSettingsAutomation;
|
|
964
|
-
webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
|
|
965
|
-
};
|
|
966
954
|
export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
|
|
967
955
|
export class CutProvider implements Required<{
|
|
968
956
|
x: number;
|
|
@@ -1536,3 +1524,18 @@ export class RemoteSessionEventHandler extends SessionEventHandler {
|
|
|
1536
1524
|
validationWillStart(): void;
|
|
1537
1525
|
validationEnded(): void;
|
|
1538
1526
|
}
|
|
1527
|
+
export class By {
|
|
1528
|
+
static css(css: string): By;
|
|
1529
|
+
static cssSelector(css: string): By;
|
|
1530
|
+
static id(id: string): By;
|
|
1531
|
+
static className(className: string): By;
|
|
1532
|
+
static attributeValue(attr: string, value: string): By;
|
|
1533
|
+
static name(name: string): By;
|
|
1534
|
+
static tagName(tagName: string): By;
|
|
1535
|
+
static xpath(xpath: string): By;
|
|
1536
|
+
static xPath(xpath: string): By;
|
|
1537
|
+
constructor(value: string, using: string);
|
|
1538
|
+
readonly value: string;
|
|
1539
|
+
readonly using: string;
|
|
1540
|
+
toString(): string;
|
|
1541
|
+
}
|