@applitools/core 1.0.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/LICENSE +26 -0
- package/dist/automation/get-viewport-size.js +12 -0
- package/dist/automation/locate.js +22 -0
- package/dist/automation/set-viewport-size.js +12 -0
- package/dist/automation/utils/take-screenshot.js +55 -0
- package/dist/check-and-close.js +11 -0
- package/dist/check.js +55 -0
- package/dist/classic/check-and-close.js +67 -0
- package/dist/classic/check.js +78 -0
- package/dist/classic/core.js +50 -0
- package/dist/classic/extract-text.js +71 -0
- package/dist/classic/locate-text.js +53 -0
- package/dist/classic/open-eyes.js +78 -0
- package/dist/classic/utils/take-dom-capture.js +135 -0
- package/dist/classic/utils/transform-check-settings.js +68 -0
- package/dist/close-manager.js +62 -0
- package/dist/close.js +20 -0
- package/dist/core.js +51 -0
- package/dist/errors/test-error.js +29 -0
- package/dist/extract-text.js +37 -0
- package/dist/index.js +32 -0
- package/dist/locate-text.js +11 -0
- package/dist/locate.js +11 -0
- package/dist/make-manager.js +65 -0
- package/dist/open-eyes.js +84 -0
- package/dist/troubleshoot/check-network.js +106 -0
- package/dist/troubleshoot/eyes.js +85 -0
- package/dist/troubleshoot/ufg.js +130 -0
- package/dist/troubleshoot/utils.js +68 -0
- package/dist/ufg/abort.js +18 -0
- package/dist/ufg/check-and-close.js +7 -0
- package/dist/ufg/check.js +192 -0
- package/dist/ufg/close.js +31 -0
- package/dist/ufg/core.js +78 -0
- package/dist/ufg/open-eyes.js +123 -0
- package/dist/ufg/utils/generate-safe-selectors.js +60 -0
- package/dist/ufg/utils/take-dom-snapshot.js +132 -0
- package/dist/ufg/utils/take-dom-snapshots.js +141 -0
- package/dist/ufg/utils/take-snapshots.js +38 -0
- package/dist/ufg/utils/take-vhses.js +258 -0
- package/dist/utils/execute-poll-script.js +75 -0
- package/dist/utils/extract-broker-url.js +19 -0
- package/dist/utils/format-results.js +185 -0
- package/dist/utils/to-base-check-settings.js +69 -0
- package/dist/utils/wait-for-lazy-load.js +25 -0
- package/package.json +105 -0
- package/types/automation/get-viewport-size.d.ts +11 -0
- package/types/automation/locate.d.ts +16 -0
- package/types/automation/set-viewport-size.d.ts +12 -0
- package/types/automation/utils/take-screenshot.d.ts +15 -0
- package/types/check-and-close.d.ts +15 -0
- package/types/check.d.ts +15 -0
- package/types/classic/check-and-close.d.ts +16 -0
- package/types/classic/check.d.ts +16 -0
- package/types/classic/core.d.ts +13 -0
- package/types/classic/extract-text.d.ts +16 -0
- package/types/classic/locate-text.d.ts +16 -0
- package/types/classic/open-eyes.d.ts +15 -0
- package/types/classic/utils/take-dom-capture.d.ts +13 -0
- package/types/classic/utils/transform-check-settings.d.ts +11 -0
- package/types/close-manager.d.ts +18 -0
- package/types/close.d.ts +14 -0
- package/types/core.d.ts +14 -0
- package/types/errors/test-error.d.ts +5 -0
- package/types/extract-text.d.ts +15 -0
- package/types/index.d.ts +3 -0
- package/types/locate-text.d.ts +15 -0
- package/types/locate.d.ts +15 -0
- package/types/make-manager.d.ts +19 -0
- package/types/open-eyes.d.ts +19 -0
- package/types/troubleshoot/check-network.d.ts +20 -0
- package/types/troubleshoot/eyes.d.ts +11 -0
- package/types/troubleshoot/ufg.d.ts +10 -0
- package/types/troubleshoot/utils.d.ts +4 -0
- package/types/ufg/abort.d.ts +17 -0
- package/types/ufg/check-and-close.d.ts +17 -0
- package/types/ufg/check.d.ts +27 -0
- package/types/ufg/close.d.ts +16 -0
- package/types/ufg/core.d.ts +16 -0
- package/types/ufg/open-eyes.d.ts +18 -0
- package/types/ufg/utils/generate-safe-selectors.d.ts +12 -0
- package/types/ufg/utils/take-dom-snapshot.d.ts +23 -0
- package/types/ufg/utils/take-dom-snapshots.d.ts +24 -0
- package/types/ufg/utils/take-snapshots.d.ts +21 -0
- package/types/ufg/utils/take-vhses.d.ts +17 -0
- package/types/utils/execute-poll-script.d.ts +20 -0
- package/types/utils/extract-broker-url.d.ts +2 -0
- package/types/utils/format-results.d.ts +16 -0
- package/types/utils/to-base-check-settings.d.ts +17 -0
- package/types/utils/wait-for-lazy-load.d.ts +13 -0
package/package.json
ADDED
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@applitools/core",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"homepage": "https://applitools.com",
|
|
5
|
+
"bugs": {
|
|
6
|
+
"url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
|
|
7
|
+
},
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git://github.com/applitools/eyes.sdk.javascript1.git",
|
|
11
|
+
"directory": "js/packages/core-base"
|
|
12
|
+
},
|
|
13
|
+
"license": "SEE LICENSE IN LICENSE",
|
|
14
|
+
"author": {
|
|
15
|
+
"name": "Applitools Team",
|
|
16
|
+
"email": "team@applitools.com"
|
|
17
|
+
},
|
|
18
|
+
"aliases": [
|
|
19
|
+
"core"
|
|
20
|
+
],
|
|
21
|
+
"exports": {
|
|
22
|
+
".": {
|
|
23
|
+
"types": "./types/index.d.ts",
|
|
24
|
+
"default": "./dist/index.js"
|
|
25
|
+
},
|
|
26
|
+
"./dist/*": "./dist/*.js",
|
|
27
|
+
"./package.json": "./package.json"
|
|
28
|
+
},
|
|
29
|
+
"bin": {
|
|
30
|
+
"eyes-check-network": "./dist/troubleshoot/check-network.js"
|
|
31
|
+
},
|
|
32
|
+
"main": "./dist/index.js",
|
|
33
|
+
"types": "./types/index.d.ts",
|
|
34
|
+
"files": [
|
|
35
|
+
"dist",
|
|
36
|
+
"types"
|
|
37
|
+
],
|
|
38
|
+
"scripts": {
|
|
39
|
+
"lint": "eslint '**/*.ts'",
|
|
40
|
+
"build": "tsc --project ./tsconfig.build.json",
|
|
41
|
+
"test": "mocha --no-timeouts -r ts-node/register --parallel --jobs 15 './test/**/*.spec.ts'",
|
|
42
|
+
"test:sanity": "yarn test:unit",
|
|
43
|
+
"test:e2e": "mocha --no-timeouts -r ts-node/register --parallel --jobs 15 './test/e2e/**/*.spec.ts'",
|
|
44
|
+
"test:it": "mocha --no-timeouts -r ts-node/register './test/it/**/*.spec.ts'",
|
|
45
|
+
"test:unit": "mocha --no-timeouts -r ts-node/register './test/unit/**/*.spec.ts'",
|
|
46
|
+
"setup": "yarn docker:setup",
|
|
47
|
+
"docker:setup": "node ../scripts/scripts/generate-docker-compose-config.js && docker-compose up -d",
|
|
48
|
+
"docker:teardown": "docker-compose down",
|
|
49
|
+
"deps": "bongo deps",
|
|
50
|
+
"preversion": "bongo preversion",
|
|
51
|
+
"version": "bongo version",
|
|
52
|
+
"postversion": "bongo postversion --skip-release-notification"
|
|
53
|
+
},
|
|
54
|
+
"husky": {
|
|
55
|
+
"hooks": {
|
|
56
|
+
"pre-push": "yarn bongo lint"
|
|
57
|
+
}
|
|
58
|
+
},
|
|
59
|
+
"dependencies": {
|
|
60
|
+
"@applitools/core-base": "1.0.1",
|
|
61
|
+
"@applitools/dom-capture": "11.1.2",
|
|
62
|
+
"@applitools/dom-snapshot": "4.6.2",
|
|
63
|
+
"@applitools/driver": "1.9.28",
|
|
64
|
+
"@applitools/logger": "1.1.20",
|
|
65
|
+
"@applitools/nml-client": "1.2.1",
|
|
66
|
+
"@applitools/req": "1.1.4",
|
|
67
|
+
"@applitools/screenshoter": "3.5.2",
|
|
68
|
+
"@applitools/snippets": "2.4.5",
|
|
69
|
+
"@applitools/types": "1.5.13",
|
|
70
|
+
"@applitools/ufg-client": "1.0.1",
|
|
71
|
+
"@applitools/utils": "1.3.12",
|
|
72
|
+
"abort-controller": "3.0.0",
|
|
73
|
+
"throat": "6.0.1"
|
|
74
|
+
},
|
|
75
|
+
"devDependencies": {
|
|
76
|
+
"@applitools/bongo": "^2.2.0",
|
|
77
|
+
"@applitools/sdk-fake-eyes-server": "^2.1.3",
|
|
78
|
+
"@applitools/spec-driver-puppeteer": "^1.1.10",
|
|
79
|
+
"@applitools/spec-driver-selenium": "^1.3.22",
|
|
80
|
+
"@applitools/test-server": "^1.1.5",
|
|
81
|
+
"@applitools/test-utils": "^1.5.1",
|
|
82
|
+
"@types/mocha": "^9.1.1",
|
|
83
|
+
"@types/node": "12",
|
|
84
|
+
"@types/selenium-webdriver": "^4.1.2",
|
|
85
|
+
"@typescript-eslint/eslint-plugin": "^5.38.0",
|
|
86
|
+
"@typescript-eslint/parser": "^5.38.0",
|
|
87
|
+
"eslint": "^8.23.1",
|
|
88
|
+
"eslint-config-prettier": "^8.5.0",
|
|
89
|
+
"eslint-plugin-mocha-no-only": "^1.1.1",
|
|
90
|
+
"eslint-plugin-node": "^11.1.0",
|
|
91
|
+
"eslint-plugin-prettier": "^4.0.0",
|
|
92
|
+
"husky": "^4.3.7",
|
|
93
|
+
"mocha": "^10.0.0",
|
|
94
|
+
"nock": "^13.2.8",
|
|
95
|
+
"png-async": "^0.9.4",
|
|
96
|
+
"prettier": "^2.6.2",
|
|
97
|
+
"puppeteer": "^16.2.0",
|
|
98
|
+
"selenium-webdriver": "^4.4.0",
|
|
99
|
+
"ts-node": "^10.7.0",
|
|
100
|
+
"typescript": "^4.8.3"
|
|
101
|
+
},
|
|
102
|
+
"engines": {
|
|
103
|
+
"node": ">=12.13.0"
|
|
104
|
+
}
|
|
105
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { SpecDriver } from '@applitools/types';
|
|
2
|
+
import { type Logger } from '@applitools/logger';
|
|
3
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
4
|
+
spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
5
|
+
logger?: Logger;
|
|
6
|
+
};
|
|
7
|
+
export declare function makeGetViewportSize<TDriver, TContext, TElement, TSelector>({ spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, logger }: {
|
|
8
|
+
target: TDriver;
|
|
9
|
+
logger?: Logger;
|
|
10
|
+
}) => Promise<import("@applitools/types").Size>;
|
|
11
|
+
export {};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { SpecDriver, Region } from '@applitools/types';
|
|
2
|
+
import type { Core as BaseCore } from '@applitools/types/base';
|
|
3
|
+
import type { Target, LocateSettings } from '@applitools/types/classic';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
6
|
+
spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
7
|
+
core: BaseCore;
|
|
8
|
+
target?: Target<TDriver>;
|
|
9
|
+
logger?: Logger;
|
|
10
|
+
};
|
|
11
|
+
export declare function makeLocate<TDriver, TContext, TElement, TSelector>({ spec, core, target: defaultTarget, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): <TLocator extends string>({ target, settings, logger, }?: {
|
|
12
|
+
target?: Target<TDriver>;
|
|
13
|
+
settings?: LocateSettings<TLocator, TElement, TSelector>;
|
|
14
|
+
logger?: Logger;
|
|
15
|
+
}) => Promise<Record<TLocator, Region[]>>;
|
|
16
|
+
export {};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { SpecDriver, Size } from '@applitools/types';
|
|
2
|
+
import { type Logger } from '@applitools/logger';
|
|
3
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
4
|
+
spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
5
|
+
logger?: Logger;
|
|
6
|
+
};
|
|
7
|
+
export declare function makeSetViewportSize<TDriver, TContext, TElement, TSelector>({ spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, size, logger }: {
|
|
8
|
+
target: TDriver;
|
|
9
|
+
size: Size;
|
|
10
|
+
logger?: Logger;
|
|
11
|
+
}) => Promise<void>;
|
|
12
|
+
export {};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { Region } from '@applitools/types';
|
|
2
|
+
import { ScreenshotSettings } from '@applitools/types/classic';
|
|
3
|
+
import { type Logger } from '@applitools/logger';
|
|
4
|
+
import { type Driver, type Element } from '@applitools/driver';
|
|
5
|
+
export declare type Screenshot = {
|
|
6
|
+
image: any;
|
|
7
|
+
region: Region;
|
|
8
|
+
scrollingElement: Element<unknown, unknown, unknown, unknown>;
|
|
9
|
+
restoreState(): Promise<void>;
|
|
10
|
+
};
|
|
11
|
+
export declare function takeScreenshot<TDriver, TContext, TElement, TSelector>({ driver, settings, logger, }: {
|
|
12
|
+
driver: Driver<TDriver, TContext, TElement, TSelector>;
|
|
13
|
+
settings: ScreenshotSettings<TElement, TSelector>;
|
|
14
|
+
logger: Logger;
|
|
15
|
+
}): Promise<Screenshot>;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { Target, Config, CheckSettings, CloseSettings, TestResult } from '@applitools/types';
|
|
2
|
+
import type { Eyes as ClassicEyes } from '@applitools/types/classic';
|
|
3
|
+
import type { Eyes as UFGEyes } from '@applitools/types/ufg';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TElement, TSelector> = {
|
|
6
|
+
eyes: ClassicEyes<TDriver, TElement, TSelector> | UFGEyes<TDriver, TElement, TSelector>;
|
|
7
|
+
logger: Logger;
|
|
8
|
+
};
|
|
9
|
+
export declare function makeCheckAndClose<TDriver, TElement, TSelector, TType extends 'classic' | 'ufg' = 'classic' | 'ufg'>({ eyes, logger: defaultLogger, }: Options<TDriver, TElement, TSelector>): ({ target, settings, config, logger, }?: {
|
|
10
|
+
target?: Target<TDriver, TType>;
|
|
11
|
+
settings?: CheckSettings<TElement, TSelector, TType> & CloseSettings<TType>;
|
|
12
|
+
config?: Config<TElement, TSelector, TType>;
|
|
13
|
+
logger?: Logger;
|
|
14
|
+
}) => Promise<TestResult<TType>[]>;
|
|
15
|
+
export {};
|
package/types/check.d.ts
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { Target, Config, CheckSettings, CheckResult } from '@applitools/types';
|
|
2
|
+
import type { Eyes as ClassicEyes } from '@applitools/types/classic';
|
|
3
|
+
import type { Eyes as UFGEyes } from '@applitools/types/ufg';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TElement, TSelector> = {
|
|
6
|
+
eyes: ClassicEyes<TDriver, TElement, TSelector> | UFGEyes<TDriver, TElement, TSelector>;
|
|
7
|
+
logger: Logger;
|
|
8
|
+
};
|
|
9
|
+
export declare function makeCheck<TDriver, TElement, TSelector, TType extends 'classic' | 'ufg'>({ eyes, logger: defaultLogger, }: Options<TDriver, TElement, TSelector>): ({ target, settings, config, logger, }?: {
|
|
10
|
+
target?: Target<TDriver, TType>;
|
|
11
|
+
settings?: CheckSettings<TElement, TSelector, TType>;
|
|
12
|
+
config?: Config<TElement, TSelector, TType>;
|
|
13
|
+
logger?: Logger;
|
|
14
|
+
}) => Promise<CheckResult<TType>[]>;
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { SpecDriver } from '@applitools/types';
|
|
2
|
+
import type { Eyes as BaseEyes } from '@applitools/types/base';
|
|
3
|
+
import type { Target, CheckSettings, CloseSettings, TestResult } from '@applitools/types/classic';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
6
|
+
spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
7
|
+
eyes: BaseEyes;
|
|
8
|
+
target?: Target<TDriver>;
|
|
9
|
+
logger?: Logger;
|
|
10
|
+
};
|
|
11
|
+
export declare function makeCheckAndClose<TDriver, TContext, TElement, TSelector>({ spec, eyes, target: defaultTarget, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, }?: {
|
|
12
|
+
target?: Target<TDriver>;
|
|
13
|
+
settings?: CheckSettings<TElement, TSelector> & CloseSettings;
|
|
14
|
+
logger?: Logger;
|
|
15
|
+
}) => Promise<TestResult[]>;
|
|
16
|
+
export {};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { SpecDriver } from '@applitools/types';
|
|
2
|
+
import type { Eyes as BaseEyes } from '@applitools/types/base';
|
|
3
|
+
import type { Target, CheckSettings, CheckResult } from '@applitools/types/classic';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
6
|
+
spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
7
|
+
eyes: BaseEyes;
|
|
8
|
+
target?: Target<TDriver>;
|
|
9
|
+
logger?: Logger;
|
|
10
|
+
};
|
|
11
|
+
export declare function makeCheck<TDriver, TContext, TElement, TSelector>({ spec, eyes, target: defaultTarget, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, }?: {
|
|
12
|
+
target?: Target<TDriver>;
|
|
13
|
+
settings?: CheckSettings<TElement, TSelector>;
|
|
14
|
+
logger?: Logger;
|
|
15
|
+
}) => Promise<CheckResult[]>;
|
|
16
|
+
export {};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { SpecDriver } from '@applitools/types';
|
|
2
|
+
import type { Core as BaseCore } from '@applitools/types/base';
|
|
3
|
+
import type { Core } from '@applitools/types/classic';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
6
|
+
spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
7
|
+
core?: BaseCore;
|
|
8
|
+
agentId?: string;
|
|
9
|
+
cwd?: string;
|
|
10
|
+
logger?: Logger;
|
|
11
|
+
};
|
|
12
|
+
export declare function makeCore<TDriver, TContext, TElement, TSelector>({ spec, core, agentId, cwd, logger, }: Options<TDriver, TContext, TElement, TSelector>): Core<TDriver, TElement, TSelector>;
|
|
13
|
+
export {};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { MaybeArray, SpecDriver } from '@applitools/types';
|
|
2
|
+
import type { Eyes as BaseEyes } from '@applitools/types/base';
|
|
3
|
+
import type { Target, ExtractTextSettings } from '@applitools/types/classic';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
6
|
+
spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
7
|
+
eyes: BaseEyes;
|
|
8
|
+
target?: Target<TDriver>;
|
|
9
|
+
logger?: Logger;
|
|
10
|
+
};
|
|
11
|
+
export declare function makeExtractText<TDriver, TContext, TElement, TSelector>({ spec, eyes, target: defaultTarget, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, }?: {
|
|
12
|
+
target?: Target<TDriver>;
|
|
13
|
+
settings?: MaybeArray<ExtractTextSettings<TElement, TSelector>>;
|
|
14
|
+
logger?: Logger;
|
|
15
|
+
}) => Promise<string[]>;
|
|
16
|
+
export {};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { SpecDriver, TextRegion } from '@applitools/types';
|
|
2
|
+
import type { Eyes as BaseEyes } from '@applitools/types/base';
|
|
3
|
+
import type { Target, LocateTextSettings } from '@applitools/types/classic';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
6
|
+
spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
7
|
+
eyes: BaseEyes;
|
|
8
|
+
target?: Target<TDriver>;
|
|
9
|
+
logger?: Logger;
|
|
10
|
+
};
|
|
11
|
+
export declare function makeLocateText<TDriver, TContext, TElement, TSelector>({ spec, eyes, target: defaultTarget, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): <TPattern extends string>({ target, settings, logger, }?: {
|
|
12
|
+
target?: Target<TDriver>;
|
|
13
|
+
settings?: LocateTextSettings<TPattern, TElement, TSelector>;
|
|
14
|
+
logger?: Logger;
|
|
15
|
+
}) => Promise<Record<TPattern, TextRegion[]>>;
|
|
16
|
+
export {};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { SpecDriver } from '@applitools/types';
|
|
2
|
+
import type { Core as BaseCore } from '@applitools/types/base';
|
|
3
|
+
import type { Eyes, Target, OpenSettings } from '@applitools/types/classic';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
6
|
+
spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
7
|
+
core: BaseCore;
|
|
8
|
+
logger?: Logger;
|
|
9
|
+
};
|
|
10
|
+
export declare function makeOpenEyes<TDriver, TContext, TElement, TSelector>({ spec, core, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, }: {
|
|
11
|
+
target?: Target<TDriver>;
|
|
12
|
+
settings: OpenSettings;
|
|
13
|
+
logger?: Logger;
|
|
14
|
+
}) => Promise<Eyes<TDriver, TElement, TSelector>>;
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { type Driver } from '@applitools/driver';
|
|
2
|
+
import { type Logger } from '@applitools/logger';
|
|
3
|
+
import { type PollScriptSettings } from '../../utils/execute-poll-script';
|
|
4
|
+
import { type Fetch } from '@applitools/req';
|
|
5
|
+
export declare type DomCaptureSettings = Partial<PollScriptSettings> & {
|
|
6
|
+
fetch?: Fetch;
|
|
7
|
+
chunkByteLength?: number;
|
|
8
|
+
};
|
|
9
|
+
export declare function takeDomCapture<TDriver extends Driver<unknown, unknown, unknown, unknown>>({ driver, settings, logger, }: {
|
|
10
|
+
driver: TDriver;
|
|
11
|
+
settings?: DomCaptureSettings;
|
|
12
|
+
logger: Logger;
|
|
13
|
+
}): Promise<any>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { CheckSettings as BaseCheckSettings } from '@applitools/types/base';
|
|
2
|
+
import type { CheckSettings } from '@applitools/types/classic';
|
|
3
|
+
import { type Logger } from '@applitools/logger';
|
|
4
|
+
import { type Driver } from '@applitools/driver';
|
|
5
|
+
import { type Screenshot } from '../../automation/utils/take-screenshot';
|
|
6
|
+
export declare function transformCheckSettings<TDriver, TContext, TElement, TSelector>({ driver, settings, screenshot, logger, }: {
|
|
7
|
+
driver: Driver<TDriver, TContext, TElement, TSelector>;
|
|
8
|
+
settings: CheckSettings<TElement, TSelector>;
|
|
9
|
+
screenshot: Screenshot;
|
|
10
|
+
logger: Logger;
|
|
11
|
+
}): Promise<BaseCheckSettings>;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { Eyes, TestResult, TestResultSummary } from '@applitools/types';
|
|
2
|
+
import type { Core as BaseCore } from '@applitools/types/base';
|
|
3
|
+
import { type Logger } from '@applitools/logger';
|
|
4
|
+
declare type Options<TDriver, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
|
|
5
|
+
core: BaseCore<unknown>;
|
|
6
|
+
storage: {
|
|
7
|
+
eyes: Eyes<TDriver, TElement, TSelector, TType>;
|
|
8
|
+
promise?: Promise<TestResult<TType>[]>;
|
|
9
|
+
}[];
|
|
10
|
+
logger?: Logger;
|
|
11
|
+
};
|
|
12
|
+
export declare function makeCloseManager<TDriver, TElement, TSelector, TType extends 'classic' | 'ufg' = 'classic'>({ core, storage, logger: defaultLogger, }: Options<TDriver, TElement, TSelector, TType>): ({ settings, logger, }?: {
|
|
13
|
+
settings?: {
|
|
14
|
+
throwErr?: boolean;
|
|
15
|
+
};
|
|
16
|
+
logger?: Logger;
|
|
17
|
+
}) => Promise<TestResultSummary<TType>>;
|
|
18
|
+
export {};
|
package/types/close.d.ts
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { Config, CloseSettings, TestResult } from '@applitools/types';
|
|
2
|
+
import type { Eyes as ClassicEyes } from '@applitools/types/classic';
|
|
3
|
+
import type { Eyes as UFGEyes } from '@applitools/types/ufg';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TElement, TSelector> = {
|
|
6
|
+
eyes: ClassicEyes<TDriver, TElement, TSelector> | UFGEyes<TDriver, TElement, TSelector>;
|
|
7
|
+
logger: Logger;
|
|
8
|
+
};
|
|
9
|
+
export declare function makeClose<TDriver, TElement, TSelector, TType extends 'classic' | 'ufg'>({ eyes, logger: defaultLogger, }: Options<TDriver, TElement, TSelector>): ({ settings, config, logger, }?: {
|
|
10
|
+
settings?: CloseSettings<TType>;
|
|
11
|
+
config?: Config<TElement, TSelector, TType>;
|
|
12
|
+
logger?: Logger;
|
|
13
|
+
}) => Promise<TestResult<TType>[]>;
|
|
14
|
+
export {};
|
package/types/core.d.ts
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { SpecDriver } from '@applitools/types';
|
|
2
|
+
import type { Core as BaseCore } from '@applitools/types/base';
|
|
3
|
+
import type { Core } from '@applitools/types';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
6
|
+
spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
7
|
+
concurrency?: number;
|
|
8
|
+
core?: BaseCore;
|
|
9
|
+
agentId?: string;
|
|
10
|
+
cwd?: string;
|
|
11
|
+
logger?: Logger;
|
|
12
|
+
};
|
|
13
|
+
export declare function makeCore<TDriver, TContext, TElement, TSelector>({ spec, concurrency, core, agentId, cwd, logger, }: Options<TDriver, TContext, TElement, TSelector>): Core<TDriver, TElement, TSelector>;
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { MaybeArray, Target, Config, ExtractTextSettings } from '@applitools/types';
|
|
2
|
+
import type { Eyes as ClassicEyes } from '@applitools/types/classic';
|
|
3
|
+
import type { Eyes as UFGEyes } from '@applitools/types/ufg';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TElement, TSelector> = {
|
|
6
|
+
eyes: ClassicEyes<TDriver, TElement, TSelector> | UFGEyes<TDriver, TElement, TSelector>;
|
|
7
|
+
logger: Logger;
|
|
8
|
+
};
|
|
9
|
+
export declare function makeExtractText<TDriver, TElement, TSelector, TType extends 'classic' | 'ufg'>({ eyes, logger: defaultLogger, }: Options<TDriver, TElement, TSelector>): ({ target, settings, config, logger, }: {
|
|
10
|
+
target?: Target<TDriver, TType>;
|
|
11
|
+
settings: MaybeArray<ExtractTextSettings<TElement, TSelector, TType>>;
|
|
12
|
+
config?: Config<TElement, TSelector, TType>;
|
|
13
|
+
logger?: Logger;
|
|
14
|
+
}) => Promise<string[]>;
|
|
15
|
+
export {};
|
package/types/index.d.ts
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { TextRegion, Target, Config, LocateTextSettings } from '@applitools/types';
|
|
2
|
+
import type { Eyes as ClassicEyes } from '@applitools/types/classic';
|
|
3
|
+
import type { Eyes as UFGEyes } from '@applitools/types/ufg';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TElement, TSelector> = {
|
|
6
|
+
eyes: ClassicEyes<TDriver, TElement, TSelector> | UFGEyes<TDriver, TElement, TSelector>;
|
|
7
|
+
logger: Logger;
|
|
8
|
+
};
|
|
9
|
+
export declare function makeLocateText<TDriver, TElement, TSelector, TType extends 'classic' | 'ufg' = 'classic' | 'ufg'>({ eyes, logger: defaultLogger, }: Options<TDriver, TElement, TSelector>): <TPattern extends string>({ target, settings, config, logger, }: {
|
|
10
|
+
target?: Target<TDriver, TType>;
|
|
11
|
+
settings: LocateTextSettings<TPattern, TElement, TSelector, TType>;
|
|
12
|
+
config?: Config<TElement, TSelector, TType>;
|
|
13
|
+
logger?: Logger;
|
|
14
|
+
}) => Promise<Record<TPattern, TextRegion[]>>;
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { Region, Target, Config, LocateSettings } from '@applitools/types';
|
|
2
|
+
import type { Core as ClassicCore } from '@applitools/types/classic';
|
|
3
|
+
import type { Core as UFGCore } from '@applitools/types/ufg';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options<TDriver, TElement, TSelector> = {
|
|
6
|
+
core: ClassicCore<TDriver, TElement, TSelector> | UFGCore<TDriver, TElement, TSelector>;
|
|
7
|
+
logger: Logger;
|
|
8
|
+
};
|
|
9
|
+
export declare function makeLocate<TDriver, TElement, TSelector, TType extends 'classic' | 'ufg'>({ core, logger: defaultLogger, }: Options<TDriver, TElement, TSelector>): <TLocator extends string>({ target, settings, config, logger, }: {
|
|
10
|
+
target?: Target<TDriver, TType>;
|
|
11
|
+
settings: LocateSettings<TLocator, TElement, TSelector>;
|
|
12
|
+
config?: Config<TElement, TSelector, TType>;
|
|
13
|
+
logger?: Logger;
|
|
14
|
+
}) => Promise<Record<TLocator, Region[]>>;
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { EyesManager, SpecDriver } from '@applitools/types';
|
|
2
|
+
import type { Core as BaseCore } from '@applitools/types/base';
|
|
3
|
+
import { type Logger } from '@applitools/logger';
|
|
4
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
5
|
+
spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
6
|
+
core?: BaseCore;
|
|
7
|
+
concurrency?: number;
|
|
8
|
+
agentId?: string;
|
|
9
|
+
cwd?: string;
|
|
10
|
+
logger?: Logger;
|
|
11
|
+
};
|
|
12
|
+
export declare function makeMakeManager<TDriver, TContext, TElement, TSelector>({ spec, core, concurrency: defaultConcurrency, agentId: defaultAgentId, cwd, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): <TType extends "classic" | "ufg" = "classic">({ type, concurrency, legacyConcurrency, agentId, logger, }?: {
|
|
13
|
+
type?: TType;
|
|
14
|
+
concurrency?: number;
|
|
15
|
+
legacyConcurrency?: number;
|
|
16
|
+
agentId?: string;
|
|
17
|
+
logger?: Logger;
|
|
18
|
+
}) => Promise<EyesManager<TDriver, TElement, TSelector, TType>>;
|
|
19
|
+
export {};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { Eyes, Config, OpenSettings, SpecDriver } from '@applitools/types';
|
|
2
|
+
import type { Core as ClassicCore } from '@applitools/types/classic';
|
|
3
|
+
import type { Core as UFGCore } from '@applitools/types/ufg';
|
|
4
|
+
import type { Core as BaseCore } from '@applitools/types/base';
|
|
5
|
+
import { type Logger } from '@applitools/logger';
|
|
6
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
7
|
+
spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
8
|
+
core?: BaseCore | ClassicCore<TDriver, TElement, TSelector> | UFGCore<TDriver, TElement, TSelector>;
|
|
9
|
+
concurrency?: number;
|
|
10
|
+
logger?: Logger;
|
|
11
|
+
};
|
|
12
|
+
export declare function makeOpenEyes<TDriver, TContext, TElement, TSelector>({ spec, core, concurrency, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): <TType extends "classic" | "ufg" = "classic">({ type, target, settings, config, logger, }: {
|
|
13
|
+
type?: TType;
|
|
14
|
+
target?: TDriver;
|
|
15
|
+
settings?: Partial<OpenSettings<TType>>;
|
|
16
|
+
config?: Config<TElement, TSelector, TType>;
|
|
17
|
+
logger?: Logger;
|
|
18
|
+
}) => Promise<Eyes<TDriver, TElement, TSelector, TType, import("@applitools/types").Target<TDriver, TType>>>;
|
|
19
|
+
export {};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
export declare function checkNetwork({ stream, eyes, ufg }?: {
|
|
3
|
+
stream?: NodeJS.WriteStream;
|
|
4
|
+
eyes?: {
|
|
5
|
+
testFetch(): Promise<void>;
|
|
6
|
+
testCurl(): Promise<void>;
|
|
7
|
+
testServer(): Promise<void>;
|
|
8
|
+
testHttps: () => Promise<void>;
|
|
9
|
+
url: URL;
|
|
10
|
+
cmd: string;
|
|
11
|
+
};
|
|
12
|
+
ufg?: {
|
|
13
|
+
testFetch(): Promise<void>;
|
|
14
|
+
testCurl(): Promise<void>;
|
|
15
|
+
testServer: () => Promise<void>;
|
|
16
|
+
testHttps(): Promise<void>;
|
|
17
|
+
url: URL;
|
|
18
|
+
getCmd: () => Promise<string>;
|
|
19
|
+
};
|
|
20
|
+
}): Promise<void>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export declare const RENDER_INFO_URL: string;
|
|
2
|
+
export declare const CURL_CMD: string;
|
|
3
|
+
declare const _default: {
|
|
4
|
+
testFetch(): Promise<void>;
|
|
5
|
+
testCurl(): Promise<void>;
|
|
6
|
+
testServer(): Promise<void>;
|
|
7
|
+
testHttps: () => Promise<void>;
|
|
8
|
+
url: URL;
|
|
9
|
+
cmd: string;
|
|
10
|
+
};
|
|
11
|
+
export default _default;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export declare const getCmd: () => Promise<string>;
|
|
2
|
+
declare const _default: {
|
|
3
|
+
testFetch(): Promise<void>;
|
|
4
|
+
testCurl(): Promise<void>;
|
|
5
|
+
testServer: () => Promise<void>;
|
|
6
|
+
testHttps(): Promise<void>;
|
|
7
|
+
url: URL;
|
|
8
|
+
getCmd: () => Promise<string>;
|
|
9
|
+
};
|
|
10
|
+
export default _default;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { Renderer } from '@applitools/types';
|
|
2
|
+
import type { Eyes as BaseEyes } from '@applitools/types/base';
|
|
3
|
+
import type { TestResult } from '@applitools/types/ufg';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
import { type AbortController } from 'abort-controller';
|
|
6
|
+
declare type Options = {
|
|
7
|
+
storage: Promise<{
|
|
8
|
+
eyes: BaseEyes;
|
|
9
|
+
renderer: Renderer;
|
|
10
|
+
}>[];
|
|
11
|
+
controller: AbortController;
|
|
12
|
+
logger: Logger;
|
|
13
|
+
};
|
|
14
|
+
export declare function makeAbort({ storage, controller, logger: defaultLogger }: Options): ({ logger, }?: {
|
|
15
|
+
logger?: Logger;
|
|
16
|
+
}) => Promise<TestResult[]>;
|
|
17
|
+
export {};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { SpecDriver } from '@applitools/types';
|
|
2
|
+
import type { Eyes as BaseEyes } from '@applitools/types/base';
|
|
3
|
+
import type { Target, TestInfo } from '@applitools/types/ufg';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
import { type UFGClient } from '@applitools/ufg-client';
|
|
6
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
7
|
+
getEyes: (options: {
|
|
8
|
+
rawEnvironment: any;
|
|
9
|
+
}) => Promise<BaseEyes>;
|
|
10
|
+
client: UFGClient;
|
|
11
|
+
test: TestInfo;
|
|
12
|
+
spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
13
|
+
target?: Target<TDriver>;
|
|
14
|
+
logger?: Logger;
|
|
15
|
+
};
|
|
16
|
+
export declare function makeCheckAndClose<TDriver, TContext, TElement, TSelector>(_options: Options<TDriver, TContext, TElement, TSelector>): any;
|
|
17
|
+
export {};
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { SpecDriver } from '@applitools/types';
|
|
2
|
+
import type { Eyes as BaseEyes } from '@applitools/types/base';
|
|
3
|
+
import type { Target, TestInfo, CheckSettings, CheckResult } from '@applitools/types/ufg';
|
|
4
|
+
import { type AbortSignal } from 'abort-controller';
|
|
5
|
+
import { type Logger } from '@applitools/logger';
|
|
6
|
+
import { type UFGClient } from '@applitools/ufg-client';
|
|
7
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
8
|
+
getEyes: (options: {
|
|
9
|
+
rawEnvironment: any;
|
|
10
|
+
}) => Promise<BaseEyes>;
|
|
11
|
+
client: UFGClient;
|
|
12
|
+
test: TestInfo;
|
|
13
|
+
spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
14
|
+
signal?: AbortSignal;
|
|
15
|
+
target?: Target<TDriver>;
|
|
16
|
+
logger?: Logger;
|
|
17
|
+
};
|
|
18
|
+
export declare function makeCheck<TDriver, TContext, TElement, TSelector>({ spec, getEyes, client, test, signal, target: defaultTarget, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, }: {
|
|
19
|
+
target?: Target<TDriver>;
|
|
20
|
+
settings?: CheckSettings<TElement, TSelector>;
|
|
21
|
+
logger?: Logger;
|
|
22
|
+
}) => Promise<(CheckResult & {
|
|
23
|
+
promise: Promise<CheckResult & {
|
|
24
|
+
eyes: BaseEyes;
|
|
25
|
+
}>;
|
|
26
|
+
})[]>;
|
|
27
|
+
export {};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { Renderer } from '@applitools/types';
|
|
2
|
+
import type { Eyes as BaseEyes } from '@applitools/types/base';
|
|
3
|
+
import type { CloseSettings, TestResult } from '@applitools/types/ufg';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
declare type Options = {
|
|
6
|
+
storage: Promise<{
|
|
7
|
+
eyes: BaseEyes;
|
|
8
|
+
renderer: Renderer;
|
|
9
|
+
}>[];
|
|
10
|
+
logger: Logger;
|
|
11
|
+
};
|
|
12
|
+
export declare function makeClose({ storage, logger: defaultLogger }: Options): ({ settings, logger, }?: {
|
|
13
|
+
settings?: CloseSettings;
|
|
14
|
+
logger?: Logger;
|
|
15
|
+
}) => Promise<TestResult[]>;
|
|
16
|
+
export {};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { SpecDriver } from '@applitools/types';
|
|
2
|
+
import type { Core as BaseCore } from '@applitools/types/base';
|
|
3
|
+
import type { Core } from '@applitools/types/ufg';
|
|
4
|
+
import { type UFGClient } from '@applitools/ufg-client';
|
|
5
|
+
import { type Logger } from '@applitools/logger';
|
|
6
|
+
declare type Options<TDriver, TContext, TElement, TSelector> = {
|
|
7
|
+
concurrency: number;
|
|
8
|
+
spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
9
|
+
client?: UFGClient;
|
|
10
|
+
core?: BaseCore;
|
|
11
|
+
agentId?: string;
|
|
12
|
+
cwd?: string;
|
|
13
|
+
logger?: Logger;
|
|
14
|
+
};
|
|
15
|
+
export declare function makeCore<TDriver, TContext, TElement, TSelector>({ concurrency, spec, client, core, agentId, cwd, logger, }: Options<TDriver, TContext, TElement, TSelector>): Core<TDriver, TElement, TSelector>;
|
|
16
|
+
export {};
|