@applitools/core 3.6.6 → 3.8.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.
Files changed (146) hide show
  1. package/CHANGELOG.md +21 -1
  2. package/package.json +3 -3
  3. package/dist/automation/extract-text.js +0 -79
  4. package/dist/automation/get-nml-client.js +0 -42
  5. package/dist/automation/get-viewport-size.js +0 -13
  6. package/dist/automation/locate-text.js +0 -58
  7. package/dist/automation/locate.js +0 -60
  8. package/dist/automation/set-viewport-size.js +0 -13
  9. package/dist/automation/types.js +0 -2
  10. package/dist/automation/utils/take-screenshot.js +0 -59
  11. package/dist/automation/utils/to-base-check-settings.js +0 -70
  12. package/dist/automation/utils/wait-for-lazy-load.js +0 -22
  13. package/dist/check-and-close.js +0 -49
  14. package/dist/check.js +0 -78
  15. package/dist/classic/abort.js +0 -23
  16. package/dist/classic/check-and-close.js +0 -104
  17. package/dist/classic/check.js +0 -117
  18. package/dist/classic/close.js +0 -23
  19. package/dist/classic/core.js +0 -55
  20. package/dist/classic/get-base-eyes.js +0 -40
  21. package/dist/classic/open-eyes.js +0 -98
  22. package/dist/classic/types.js +0 -17
  23. package/dist/classic/utils/take-dom-capture.js +0 -121
  24. package/dist/cli/cli.js +0 -139
  25. package/dist/close-batch.js +0 -39
  26. package/dist/close.js +0 -38
  27. package/dist/core.js +0 -64
  28. package/dist/delete-test.js +0 -39
  29. package/dist/errors/abort-error.js +0 -10
  30. package/dist/errors/internal-error.js +0 -11
  31. package/dist/errors/test-error.js +0 -32
  32. package/dist/extract-text.js +0 -46
  33. package/dist/get-account-info.js +0 -37
  34. package/dist/get-ec-client.js +0 -37
  35. package/dist/get-eyes-results.js +0 -43
  36. package/dist/get-manager-results.js +0 -112
  37. package/dist/get-typed-eyes.js +0 -27
  38. package/dist/index.js +0 -38
  39. package/dist/locate-text.js +0 -41
  40. package/dist/locate.js +0 -41
  41. package/dist/log-event.js +0 -39
  42. package/dist/make-manager.js +0 -60
  43. package/dist/open-eyes.js +0 -98
  44. package/dist/troubleshoot/check-network.js +0 -114
  45. package/dist/troubleshoot/eyes.js +0 -85
  46. package/dist/troubleshoot/logs.js +0 -41
  47. package/dist/troubleshoot/ufg.js +0 -131
  48. package/dist/troubleshoot/utils.js +0 -44
  49. package/dist/types.js +0 -17
  50. package/dist/ufg/abort.js +0 -33
  51. package/dist/ufg/check-and-close.js +0 -267
  52. package/dist/ufg/check.js +0 -274
  53. package/dist/ufg/close.js +0 -38
  54. package/dist/ufg/core.js +0 -57
  55. package/dist/ufg/get-base-eyes.js +0 -56
  56. package/dist/ufg/get-results.js +0 -28
  57. package/dist/ufg/get-ufg-client.js +0 -47
  58. package/dist/ufg/open-eyes.js +0 -97
  59. package/dist/ufg/types.js +0 -17
  60. package/dist/ufg/utils/generate-safe-selectors.js +0 -63
  61. package/dist/ufg/utils/take-dom-snapshot.js +0 -134
  62. package/dist/ufg/utils/take-dom-snapshots.js +0 -153
  63. package/dist/ufg/utils/uniquify-renderers.js +0 -27
  64. package/dist/universal/core-server-process.js +0 -31
  65. package/dist/universal/core-server.js +0 -190
  66. package/dist/universal/core.js +0 -158
  67. package/dist/universal/history.js +0 -86
  68. package/dist/universal/refer.js +0 -67
  69. package/dist/universal/spec-driver.js +0 -163
  70. package/dist/universal/types.js +0 -2
  71. package/dist/universal/ws-server.js +0 -59
  72. package/dist/utils/extract-ci-provider.js +0 -31
  73. package/dist/utils/format-results.js +0 -185
  74. package/dist/utils/separate-duplicate-results.js +0 -34
  75. package/types/automation/extract-text.d.ts +0 -15
  76. package/types/automation/get-nml-client.d.ts +0 -17
  77. package/types/automation/get-viewport-size.d.ts +0 -12
  78. package/types/automation/locate-text.d.ts +0 -14
  79. package/types/automation/locate.d.ts +0 -14
  80. package/types/automation/set-viewport-size.d.ts +0 -14
  81. package/types/automation/types.d.ts +0 -90
  82. package/types/automation/utils/take-screenshot.d.ts +0 -22
  83. package/types/automation/utils/to-base-check-settings.d.ts +0 -17
  84. package/types/automation/utils/wait-for-lazy-load.d.ts +0 -14
  85. package/types/check-and-close.d.ts +0 -18
  86. package/types/check.d.ts +0 -18
  87. package/types/classic/abort.d.ts +0 -16
  88. package/types/classic/check-and-close.d.ts +0 -19
  89. package/types/classic/check.d.ts +0 -15
  90. package/types/classic/close.d.ts +0 -16
  91. package/types/classic/core.d.ts +0 -17
  92. package/types/classic/get-base-eyes.d.ts +0 -18
  93. package/types/classic/open-eyes.d.ts +0 -16
  94. package/types/classic/types.d.ts +0 -35
  95. package/types/classic/utils/take-dom-capture.d.ts +0 -16
  96. package/types/cli/cli.d.ts +0 -2
  97. package/types/close-batch.d.ts +0 -12
  98. package/types/close.d.ts +0 -13
  99. package/types/core.d.ts +0 -14
  100. package/types/delete-test.d.ts +0 -12
  101. package/types/errors/abort-error.d.ts +0 -4
  102. package/types/errors/internal-error.d.ts +0 -6
  103. package/types/errors/test-error.d.ts +0 -5
  104. package/types/extract-text.d.ts +0 -16
  105. package/types/get-account-info.d.ts +0 -11
  106. package/types/get-ec-client.d.ts +0 -14
  107. package/types/get-eyes-results.d.ts +0 -12
  108. package/types/get-manager-results.d.ts +0 -13
  109. package/types/get-typed-eyes.d.ts +0 -19
  110. package/types/index.d.ts +0 -9
  111. package/types/locate-text.d.ts +0 -15
  112. package/types/locate.d.ts +0 -16
  113. package/types/log-event.d.ts +0 -12
  114. package/types/make-manager.d.ts +0 -19
  115. package/types/open-eyes.d.ts +0 -22
  116. package/types/troubleshoot/check-network.d.ts +0 -21
  117. package/types/troubleshoot/eyes.d.ts +0 -11
  118. package/types/troubleshoot/logs.d.ts +0 -10
  119. package/types/troubleshoot/ufg.d.ts +0 -10
  120. package/types/troubleshoot/utils.d.ts +0 -2
  121. package/types/types.d.ts +0 -142
  122. package/types/ufg/abort.d.ts +0 -21
  123. package/types/ufg/check-and-close.d.ts +0 -41
  124. package/types/ufg/check.d.ts +0 -23
  125. package/types/ufg/close.d.ts +0 -19
  126. package/types/ufg/core.d.ts +0 -21
  127. package/types/ufg/get-base-eyes.d.ts +0 -19
  128. package/types/ufg/get-results.d.ts +0 -16
  129. package/types/ufg/get-ufg-client.d.ts +0 -16
  130. package/types/ufg/open-eyes.d.ts +0 -16
  131. package/types/ufg/types.d.ts +0 -72
  132. package/types/ufg/utils/generate-safe-selectors.d.ts +0 -16
  133. package/types/ufg/utils/take-dom-snapshot.d.ts +0 -47
  134. package/types/ufg/utils/take-dom-snapshots.d.ts +0 -27
  135. package/types/ufg/utils/uniquify-renderers.d.ts +0 -2
  136. package/types/universal/core-server-process.d.ts +0 -9
  137. package/types/universal/core-server.d.ts +0 -13
  138. package/types/universal/core.d.ts +0 -23
  139. package/types/universal/history.d.ts +0 -2
  140. package/types/universal/refer.d.ts +0 -8
  141. package/types/universal/spec-driver.d.ts +0 -11
  142. package/types/universal/types.d.ts +0 -188
  143. package/types/universal/ws-server.d.ts +0 -14
  144. package/types/utils/extract-ci-provider.d.ts +0 -1
  145. package/types/utils/format-results.d.ts +0 -16
  146. package/types/utils/separate-duplicate-results.d.ts +0 -2
@@ -1,185 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.toJsonOutput = exports.toXmlOutput = exports.toFlattenedTAPString = exports.toHierarchicTAPString = exports.toFormatterString = void 0;
4
- const OK = 'ok';
5
- const NOT_OK = 'not ok';
6
- function toFormatterString(results, { includeSubTests = true, markNewAsPassed = false } = {}) {
7
- var _a;
8
- if (results.length === 0)
9
- return 'No results found.';
10
- let formattedString = '[EYES: TEST RESULTS]:\n';
11
- results.forEach(currentResult => {
12
- var _a, _b, _c, _d;
13
- const testTitle = `${currentResult.name} [${(_a = currentResult.hostDisplaySize) === null || _a === void 0 ? void 0 : _a.width}x${(_b = currentResult.hostDisplaySize) === null || _b === void 0 ? void 0 : _b.height}]`;
14
- let testResult = '';
15
- if (currentResult.isNew) {
16
- testResult = markNewAsPassed ? 'Passed' : 'New';
17
- }
18
- else if (!currentResult.isDifferent) {
19
- testResult = 'Passed';
20
- }
21
- else {
22
- const stepsFailed = ((_c = currentResult.mismatches) !== null && _c !== void 0 ? _c : 0) + ((_d = currentResult.missing) !== null && _d !== void 0 ? _d : 0);
23
- testResult = `Failed ${stepsFailed} of ${currentResult.steps}`;
24
- }
25
- formattedString += `${testTitle} - ${testResult}\n`;
26
- if (includeSubTests) {
27
- if (currentResult.stepsInfo && currentResult.stepsInfo.length > 0) {
28
- currentResult.stepsInfo.forEach(currentStep => {
29
- const subTestTitle = currentStep.name;
30
- const subTestResult = currentStep.isDifferent ? 'Passed' : 'Failed';
31
- formattedString += `\t> ${subTestTitle} - ${subTestResult}\n`;
32
- });
33
- }
34
- else {
35
- formattedString += '\tNo steps exist for this test.\n';
36
- }
37
- }
38
- });
39
- formattedString += `See details at ${(_a = results[0].appUrls) === null || _a === void 0 ? void 0 : _a.batch}`;
40
- return formattedString;
41
- }
42
- exports.toFormatterString = toFormatterString;
43
- function toHierarchicTAPString(results, { includeSubTests = true, markNewAsPassed = false } = {}) {
44
- if (results.length === 0)
45
- return '';
46
- let tapString = `1..${results.length}\n`;
47
- results.forEach((currentResult, index) => {
48
- if (index > 0)
49
- tapString += '#\n';
50
- const tapIndex = index + 1;
51
- const name = `Test: '${currentResult.name}', Application: '${currentResult.appName}'`;
52
- if (!currentResult.isDifferent) {
53
- tapString += `${OK} ${tapIndex} - [PASSED TEST] ${name}\n`;
54
- }
55
- else if (currentResult.isNew) {
56
- // Test did not pass (might also be a new test).
57
- // New test
58
- const newResult = markNewAsPassed ? OK : NOT_OK;
59
- tapString += `${newResult} ${tapIndex} - [NEW TEST] ${name}\n`;
60
- }
61
- else {
62
- // Failed / Aborted test.
63
- tapString += `${NOT_OK} ${tapIndex} - `;
64
- if (currentResult.isAborted) {
65
- tapString += `[ABORTED TEST] ${name}\n`;
66
- }
67
- else {
68
- tapString += `[FAILED TEST] ${name}\n`;
69
- }
70
- tapString += `#\tMismatches: ${currentResult.mismatches}\n`;
71
- }
72
- const url = currentResult.appUrls && currentResult.appUrls.session
73
- ? currentResult.appUrls.session
74
- : "No URL (session didn't start).";
75
- tapString += `#\tTest url: ${url}\n`;
76
- tapString += `#\tBrowser: ${currentResult.hostApp}, Viewport: ${currentResult.hostDisplaySize.width}X${currentResult.hostDisplaySize.width}\n`;
77
- if (includeSubTests) {
78
- if (currentResult.stepsInfo && currentResult.stepsInfo.length > 0) {
79
- tapString += `\t1..${currentResult.stepsInfo.length}\n`;
80
- currentResult.stepsInfo.forEach(currentStep => {
81
- var _a;
82
- tapString += '\t';
83
- tapString += currentStep.isDifferent ? NOT_OK : OK;
84
- tapString += ` '${currentStep.name}', URL: ${(_a = currentStep.appUrls) === null || _a === void 0 ? void 0 : _a.step}\n`;
85
- });
86
- }
87
- else {
88
- tapString += '\tNo steps exist for this test.\n';
89
- }
90
- }
91
- });
92
- return tapString;
93
- }
94
- exports.toHierarchicTAPString = toHierarchicTAPString;
95
- function toFlattenedTAPString(results, { markNewAsPassed = false } = {}) {
96
- let tapString = '';
97
- let stepsCounter = 0;
98
- // We'll add the TAP plan at the beginning, after we calculate the total number of steps.
99
- results.forEach((currentResult, index) => {
100
- tapString += '#\n';
101
- const tapIndex = index + 1;
102
- const name = `Test: '${currentResult.name}', Application: '${currentResult.appName}'`;
103
- if (!currentResult.isDifferent) {
104
- tapString += `# ${OK} ${tapIndex} - [PASSED TEST] ${name}\n`;
105
- }
106
- else if (currentResult.isNew) {
107
- // Test did not pass (might also be a new test).
108
- // New test
109
- const newResult = markNewAsPassed ? OK : NOT_OK;
110
- tapString += `# ${newResult} ${tapIndex} - [NEW TEST] ${name}\n`;
111
- }
112
- else {
113
- // Failed / Aborted test.
114
- tapString += `# ${NOT_OK} ${tapIndex} - `;
115
- if (currentResult.isAborted) {
116
- tapString += `[ABORTED TEST] ${name}\n`;
117
- }
118
- else {
119
- tapString += `[FAILED TEST] ${name}\n`;
120
- }
121
- tapString += `#\tMismatches: ${currentResult.mismatches}\n`;
122
- }
123
- const url = currentResult.appUrls && currentResult.appUrls.session
124
- ? currentResult.appUrls.session
125
- : "No URL (session didn't start).";
126
- tapString += `#\tTest url: ${url}\n`;
127
- if (currentResult.stepsInfo && currentResult.stepsInfo.length > 0) {
128
- currentResult.stepsInfo.forEach(currentStep => {
129
- var _a;
130
- stepsCounter += 1;
131
- tapString += currentStep.isDifferent ? NOT_OK : OK;
132
- tapString += ` ${stepsCounter} '${currentStep.name}', URL: ${(_a = currentStep.appUrls) === null || _a === void 0 ? void 0 : _a.step}\n`;
133
- });
134
- }
135
- else {
136
- tapString += '#\tNo steps exist for this test.\n';
137
- }
138
- });
139
- if (stepsCounter > 0) {
140
- tapString = `1..${stepsCounter}\n${tapString}`;
141
- }
142
- return tapString;
143
- }
144
- exports.toFlattenedTAPString = toFlattenedTAPString;
145
- function toXmlOutput(results, { totalTime } = {}) {
146
- const suiteName = 'Eyes Test Suite';
147
- let output = `<?xml version="1.0" encoding="UTF-8" ?>`;
148
- output += `\n<testsuite name="${suiteName}" tests="${results.length}" time="${totalTime}">`;
149
- results.forEach(result => {
150
- var _a;
151
- output += `\n<testcase name="${result.name}"${result.duration ? ` time="${result.duration}"` : ''}>`;
152
- const properties = {};
153
- if (result.hostOS)
154
- properties.hostOS = result.hostOS;
155
- if (result.hostApp)
156
- properties.hostApp = result.hostApp;
157
- if (result.hostDisplaySize)
158
- properties.viewportSize = `${result.hostDisplaySize.width}x${result.hostDisplaySize.height}`;
159
- if (properties.hostOS || properties.hostApp || properties.viewportSize) {
160
- output += `\n<properties>`;
161
- for (const [name, value] of Object.entries(properties)) {
162
- output += `\n<property name="${name}" value="${value}"/>`;
163
- }
164
- output += `\n</properties>`;
165
- }
166
- if (result.isDifferent) {
167
- output += `\n<failure>`;
168
- output += `\nDifference found. See ${(_a = result.appUrls) === null || _a === void 0 ? void 0 : _a.batch} for details.`;
169
- output += `\n</failure>`;
170
- }
171
- else if (result.isAborted) {
172
- output += `\n<failure>`;
173
- output += `\nTest aborted.`;
174
- output += `\n</failure>`;
175
- }
176
- output += `\n</testcase>`;
177
- });
178
- output += `\n</testsuite>`;
179
- return output;
180
- }
181
- exports.toXmlOutput = toXmlOutput;
182
- function toJsonOutput(results, space) {
183
- return JSON.stringify(results, null, space);
184
- }
185
- exports.toJsonOutput = toJsonOutput;
@@ -1,34 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.separateDuplicateResults = void 0;
4
- function separateDuplicateResults(containers) {
5
- const containerByBaselineId = new Map();
6
- const duplicates = [];
7
- const possibleDuplicateContainers = containers.filter(container => { var _a; return !((_a = container.result) === null || _a === void 0 ? void 0 : _a.keepIfDuplicate); });
8
- for (const container of possibleDuplicateContainers) {
9
- if (container.result) {
10
- const containerForThisBaseline = containerByBaselineId.get(container.result.baselineId);
11
- if (containerForThisBaseline === null || containerForThisBaseline === void 0 ? void 0 : containerForThisBaseline.result) {
12
- const initializedAt1 = Date.parse(containerForThisBaseline.result.initializedAt);
13
- const initializedAt2 = Date.parse(container.result.initializedAt);
14
- if (initializedAt2 > initializedAt1) {
15
- duplicates.push(containerForThisBaseline);
16
- containerByBaselineId.set(container.result.baselineId, container);
17
- }
18
- else {
19
- duplicates.push(container);
20
- }
21
- }
22
- else {
23
- containerByBaselineId.set(container.result.baselineId, container);
24
- }
25
- }
26
- }
27
- return [
28
- // tests to keep
29
- !duplicates.length ? containers : containers.filter(container => !duplicates.includes(container)),
30
- // tests to delete
31
- duplicates,
32
- ];
33
- }
34
- exports.separateDuplicateResults = separateDuplicateResults;
@@ -1,15 +0,0 @@
1
- import type { MaybeArray } from '@applitools/utils';
2
- import type { Target, Core, ExtractTextSettings } from '../classic/types';
3
- import { type Logger } from '@applitools/logger';
4
- import { type SpecType, type SpecDriver } from '@applitools/driver';
5
- type Options<TSpec extends SpecType> = {
6
- core: Core<TSpec>;
7
- spec?: SpecDriver<TSpec>;
8
- logger: Logger;
9
- };
10
- export declare function makeExtractText<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): ({ target, settings, logger, }: {
11
- target: Target<TSpec>;
12
- settings: MaybeArray<ExtractTextSettings<TSpec>>;
13
- logger?: Logger | undefined;
14
- }) => Promise<string[]>;
15
- export {};
@@ -1,17 +0,0 @@
1
- import { type SpecType, type Driver } from '@applitools/driver';
2
- import { type Logger } from '@applitools/logger';
3
- import { type NMLClient, type NMLRequestsConfig } from '@applitools/nml-client';
4
- type Options = {
5
- client?: NMLClient;
6
- logger: Logger;
7
- };
8
- export declare function makeGetNMLClient({ client, logger: mainLogger }: Options): (({ driver, config, logger, }: {
9
- driver: Driver<SpecType>;
10
- config: Omit<NMLRequestsConfig, 'brokerUrl'>;
11
- logger?: Logger | undefined;
12
- }) => Promise<NMLClient>) & {
13
- getCachedValues(): Promise<NMLClient>[];
14
- setCachedValue(key: any, value: Promise<NMLClient>): void;
15
- clearCache(): void;
16
- };
17
- export {};
@@ -1,12 +0,0 @@
1
- import type { DriverTarget } from './types';
2
- import { type Logger } from '@applitools/logger';
3
- import { type SpecType, type SpecDriver } from '@applitools/driver';
4
- type Options<TSpec extends SpecType> = {
5
- spec: SpecDriver<TSpec>;
6
- logger: Logger;
7
- };
8
- export declare function makeGetViewportSize<TSpec extends SpecType>({ spec, logger: mainLogger }: Options<TSpec>): ({ target, logger }: {
9
- target: DriverTarget<TSpec>;
10
- logger?: Logger | undefined;
11
- }) => Promise<import("@applitools/utils").Size>;
12
- export {};
@@ -1,14 +0,0 @@
1
- import type { Target, Core, LocateTextSettings, LocateTextResult } from './types';
2
- import { type Logger } from '@applitools/logger';
3
- import { type SpecType, type SpecDriver } from '@applitools/driver';
4
- type Options<TSpec extends SpecType> = {
5
- core: Core<TSpec>;
6
- spec?: SpecDriver<TSpec>;
7
- logger: Logger;
8
- };
9
- export declare function makeLocateText<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): <TPattern extends string>({ target, settings, logger, }: {
10
- target: Target<TSpec>;
11
- settings: LocateTextSettings<TPattern, TSpec>;
12
- logger?: Logger | undefined;
13
- }) => Promise<LocateTextResult<TPattern>>;
14
- export {};
@@ -1,14 +0,0 @@
1
- import type { Target, Core, LocateSettings, LocateResult } from './types';
2
- import { type Logger } from '@applitools/logger';
3
- import { type SpecType, type SpecDriver } from '@applitools/driver';
4
- type Options<TSpec extends SpecType> = {
5
- core: Core<TSpec>;
6
- spec?: SpecDriver<TSpec>;
7
- logger: Logger;
8
- };
9
- export declare function makeLocate<TSpec extends SpecType>({ spec, core, logger: mainLogger }: Options<TSpec>): <TLocator extends string>({ settings, target, logger, }: {
10
- target: Target<TSpec>;
11
- settings: LocateSettings<TLocator, TSpec>;
12
- logger?: Logger | undefined;
13
- }) => Promise<LocateResult<TLocator>>;
14
- export {};
@@ -1,14 +0,0 @@
1
- import type { Size } from '@applitools/utils';
2
- import type { DriverTarget } from './types';
3
- import { type Logger } from '@applitools/logger';
4
- import { type SpecType, type SpecDriver } from '@applitools/driver';
5
- type Options<TSpec extends SpecType> = {
6
- spec: SpecDriver<TSpec>;
7
- logger: Logger;
8
- };
9
- export declare function makeSetViewportSize<TSpec extends SpecType>({ spec, logger: mainLogger }: Options<TSpec>): ({ target, size, logger, }: {
10
- target: DriverTarget<TSpec>;
11
- size: Size;
12
- logger?: Logger | undefined;
13
- }) => Promise<void>;
14
- export {};
@@ -1,90 +0,0 @@
1
- import type { MaybeArray, Size, Region } from '@applitools/utils';
2
- import type * as BaseCore from '@applitools/core-base/types';
3
- import { type SpecType, type Driver, type ElementReference, type ContextReference } from '@applitools/driver';
4
- import { type Logger } from '@applitools/logger';
5
- import { type NMLClient, type NMLRequestsConfig } from '@applitools/nml-client';
6
- export type * from '@applitools/core-base/types';
7
- export type DriverTarget<TSpec extends SpecType> = TSpec['driver'] | Driver<TSpec>;
8
- export type Target<TSpec extends SpecType> = DriverTarget<TSpec> | BaseCore.Target;
9
- export interface Core<TSpec extends SpecType> extends BaseCore.Core {
10
- readonly base: BaseCore.Core;
11
- getViewportSize?(options: {
12
- target: DriverTarget<TSpec>;
13
- logger?: Logger;
14
- }): Promise<Size>;
15
- setViewportSize?(options: {
16
- target: DriverTarget<TSpec>;
17
- size: Size;
18
- logger?: Logger;
19
- }): Promise<void>;
20
- getNMLClient(options: {
21
- config: Omit<NMLRequestsConfig, 'brokerUrl'>;
22
- driver: Driver<TSpec>;
23
- logger?: Logger;
24
- }): Promise<NMLClient>;
25
- openEyes(options: {
26
- target?: DriverTarget<TSpec>;
27
- settings: BaseCore.OpenSettings;
28
- base?: BaseCore.Eyes[];
29
- logger?: Logger;
30
- }): Promise<Eyes<TSpec>>;
31
- locate<TLocator extends string>(options: {
32
- target: Target<TSpec>;
33
- settings: LocateSettings<TLocator, TSpec>;
34
- logger?: Logger;
35
- }): Promise<BaseCore.LocateResult<TLocator>>;
36
- locateText<TPattern extends string>(options: {
37
- target: Target<TSpec>;
38
- settings: LocateTextSettings<TPattern, TSpec>;
39
- logger?: Logger;
40
- }): Promise<BaseCore.LocateTextResult<TPattern>>;
41
- extractText(options: {
42
- target: Target<TSpec>;
43
- settings: MaybeArray<ExtractTextSettings<TSpec>>;
44
- logger?: Logger;
45
- }): Promise<string[]>;
46
- }
47
- export interface Eyes<TSpec extends SpecType> extends BaseCore.Eyes {
48
- readonly core: Core<TSpec>;
49
- getBaseEyes(options?: {
50
- logger?: Logger;
51
- }): Promise<BaseCore.Eyes[]>;
52
- check(options?: {
53
- target?: Target<TSpec>;
54
- settings?: CheckSettings<TSpec>;
55
- logger?: Logger;
56
- }): Promise<BaseCore.CheckResult[]>;
57
- checkAndClose(options?: {
58
- target?: Target<TSpec>;
59
- settings?: CheckSettings<TSpec> & BaseCore.CloseSettings;
60
- logger?: Logger;
61
- }): Promise<void>;
62
- }
63
- export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.ImageSettings<Region | ElementReference<TSpec>> {
64
- webview?: boolean | string;
65
- frames?: (ContextReference<TSpec> | {
66
- frame: ContextReference<TSpec>;
67
- scrollRootElement?: ElementReference<TSpec>;
68
- })[];
69
- fully?: boolean;
70
- scrollRootElement?: ElementReference<TSpec>;
71
- stitchMode?: 'Scroll' | 'CSS' | 'Resize';
72
- screenshotMode?: 'default' | 'applitools-lib';
73
- hideScrollbars?: boolean;
74
- hideCaret?: boolean;
75
- overlap?: {
76
- top?: number;
77
- bottom?: number;
78
- };
79
- waitBeforeCapture?: number;
80
- waitBetweenStitches?: number;
81
- lazyLoad?: boolean | {
82
- scrollLength?: number;
83
- waitingTime?: number;
84
- maxAmountToScroll?: number;
85
- };
86
- }
87
- export type LocateSettings<TLocator extends string, TSpec extends SpecType> = BaseCore.LocateSettings<TLocator, Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;
88
- export type LocateTextSettings<TPattern extends string, TSpec extends SpecType> = BaseCore.LocateTextSettings<TPattern, Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;
89
- export type ExtractTextSettings<TSpec extends SpecType> = BaseCore.ExtractTextSettings<Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;
90
- export type CheckSettings<TSpec extends SpecType> = BaseCore.CheckSettings<Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;
@@ -1,22 +0,0 @@
1
- import type { Region } from '@applitools/utils';
2
- import type { ScreenshotSettings } from '../../classic/types';
3
- import { type Logger } from '@applitools/logger';
4
- import { type Driver, type Element, type ElementReference, type Selector, type SpecType } from '@applitools/driver';
5
- export type Screenshot<TSpec extends SpecType> = {
6
- image: any;
7
- region: Region;
8
- element: Element<TSpec>;
9
- scrollingElement: Element<TSpec>;
10
- restoreState(): Promise<void>;
11
- calculatedRegions: {
12
- selector?: Selector;
13
- regions: Region[];
14
- }[];
15
- };
16
- export declare function takeScreenshot<TSpec extends SpecType>({ driver, settings, logger, }: {
17
- driver: Driver<TSpec>;
18
- settings: ScreenshotSettings<TSpec> & {
19
- regionsToCalculate?: ElementReference<TSpec>[];
20
- };
21
- logger: Logger;
22
- }): Promise<Screenshot<TSpec>>;
@@ -1,17 +0,0 @@
1
- import type { Region } from '@applitools/utils';
2
- import type { CheckSettings } from '../types';
3
- import type { CheckSettings as BaseCheckSettings } from '@applitools/core-base';
4
- import { type SpecType, type ElementReference, type Selector } from '@applitools/driver';
5
- export declare function toBaseCheckSettings<TSpec extends SpecType>({ settings }: {
6
- settings: CheckSettings<TSpec>;
7
- }): {
8
- elementReferencesToCalculate: ElementReference<TSpec>[];
9
- elementReferenceToTarget: ElementReference<TSpec> | undefined;
10
- getBaseCheckSettings: ({ calculatedRegions, preserveTransformation, }: {
11
- calculatedRegions: {
12
- selector?: Selector;
13
- regions: Region[];
14
- }[];
15
- preserveTransformation?: boolean | undefined;
16
- }) => BaseCheckSettings;
17
- };
@@ -1,14 +0,0 @@
1
- import { type Logger } from '@applitools/logger';
2
- import { type SpecType, type Context } from '@applitools/driver';
3
- export type LazyLoadSettings = {
4
- scrollLength?: number;
5
- waitingTime?: number;
6
- maxAmountToScroll?: number;
7
- executionTimeout?: number;
8
- pollTimeout?: number;
9
- };
10
- export declare function waitForLazyLoad<TSpec extends SpecType>({ context, settings, logger, }: {
11
- context: Context<TSpec>;
12
- settings: LazyLoadSettings;
13
- logger: Logger;
14
- }): Promise<void>;
@@ -1,18 +0,0 @@
1
- import type { Target, DriverTarget, Eyes, Config, CheckSettings, CloseSettings } from './types';
2
- import { type Logger } from '@applitools/logger';
3
- import { type SpecType, type SpecDriver } from '@applitools/driver';
4
- type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
5
- type?: TType;
6
- eyes: Eyes<TSpec, TType>;
7
- target?: DriverTarget<TSpec>;
8
- spec?: SpecDriver<TSpec>;
9
- logger: Logger;
10
- };
11
- export declare function makeCheckAndClose<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, eyes, target: defaultTarget, spec, logger: mainLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, target, settings, config, logger, }?: {
12
- type?: TType | undefined;
13
- target?: Target<TSpec, TType> | undefined;
14
- settings?: (CheckSettings<TSpec, TDefaultType> & CloseSettings<TDefaultType> & CheckSettings<TSpec, TType> & CloseSettings<TType>) | undefined;
15
- config?: (Config<TSpec, TDefaultType> & Config<TSpec, TType>) | undefined;
16
- logger?: Logger | undefined;
17
- }) => Promise<void>;
18
- export {};
package/types/check.d.ts DELETED
@@ -1,18 +0,0 @@
1
- import type { Target, DriverTarget, Eyes, Config, CheckSettings, CheckResult } from './types';
2
- import { type Logger } from '@applitools/logger';
3
- import { type SpecType, type SpecDriver } from '@applitools/driver';
4
- type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
5
- type?: TType;
6
- eyes: Eyes<TSpec, TType>;
7
- target?: DriverTarget<TSpec>;
8
- spec?: SpecDriver<TSpec>;
9
- logger: Logger;
10
- };
11
- export declare function makeCheck<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, eyes, target: defaultTarget, spec, logger: mainLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, target, settings, config, logger, }?: {
12
- type?: TType | undefined;
13
- target?: Target<TSpec, TType> | undefined;
14
- settings?: CheckSettings<TSpec, TType> | undefined;
15
- config?: Config<TSpec, TType> | undefined;
16
- logger?: Logger | undefined;
17
- }) => Promise<CheckResult<TType>[]>;
18
- export {};
@@ -1,16 +0,0 @@
1
- import type { AbortSettings } from './types';
2
- import type { Eyes } from './types';
3
- import { type Logger } from '@applitools/logger';
4
- import type { DriverTarget } from './types';
5
- import { type SpecType, type SpecDriver } from '@applitools/driver';
6
- type Options<TSpec extends SpecType> = {
7
- eyes: Eyes<TSpec>;
8
- target?: DriverTarget<TSpec>;
9
- spec?: SpecDriver<TSpec>;
10
- logger: Logger;
11
- };
12
- export declare function makeAbort<TSpec extends SpecType>({ eyes, target, spec, logger: mainLogger }: Options<TSpec>): ({ settings, logger, }?: {
13
- settings?: AbortSettings | undefined;
14
- logger?: Logger | undefined;
15
- }) => Promise<void>;
16
- export {};
@@ -1,19 +0,0 @@
1
- import type { Target, DriverTarget, Eyes, CheckSettings, CloseSettings } from './types';
2
- import type { CheckSettings as BaseCheckSettings } from '@applitools/core-base';
3
- import { type Logger } from '@applitools/logger';
4
- import { type SpecType, type SpecDriver } from '@applitools/driver';
5
- import * as utils from '@applitools/utils';
6
- type Options<TSpec extends SpecType> = {
7
- eyes: Eyes<TSpec>;
8
- target?: DriverTarget<TSpec>;
9
- spec?: SpecDriver<TSpec>;
10
- logger: Logger;
11
- };
12
- export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target: defaultTarget, spec, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
13
- target?: Target<TSpec> | undefined;
14
- settings?: (BaseCheckSettings<utils.Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
15
- retryTimeout?: number | undefined;
16
- } & CloseSettings) | undefined;
17
- logger?: Logger | undefined;
18
- }) => Promise<void>;
19
- export {};
@@ -1,15 +0,0 @@
1
- import type { Target, DriverTarget, Eyes, CheckSettings, CheckResult } from './types';
2
- import { type Logger } from '@applitools/logger';
3
- import { type SpecType, type SpecDriver } from '@applitools/driver';
4
- type Options<TSpec extends SpecType> = {
5
- eyes: Eyes<TSpec>;
6
- target?: DriverTarget<TSpec>;
7
- spec?: SpecDriver<TSpec>;
8
- logger: Logger;
9
- };
10
- export declare function makeCheck<TSpec extends SpecType>({ eyes, target: defaultTarget, spec, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
11
- target?: Target<TSpec> | undefined;
12
- settings?: CheckSettings<TSpec> | undefined;
13
- logger?: Logger | undefined;
14
- }) => Promise<CheckResult[]>;
15
- export {};
@@ -1,16 +0,0 @@
1
- import type { CloseSettings } from './types';
2
- import type { Eyes } from './types';
3
- import { type Logger } from '@applitools/logger';
4
- import type { DriverTarget } from './types';
5
- import { type SpecType, type SpecDriver } from '@applitools/driver';
6
- type Options<TSpec extends SpecType> = {
7
- eyes: Eyes<TSpec>;
8
- target?: DriverTarget<TSpec>;
9
- spec?: SpecDriver<TSpec>;
10
- logger: Logger;
11
- };
12
- export declare function makeClose<TSpec extends SpecType>({ eyes, target, spec, logger: mainLogger }: Options<TSpec>): ({ settings, logger, }?: {
13
- settings?: CloseSettings | undefined;
14
- logger?: Logger | undefined;
15
- }) => Promise<void>;
16
- export {};
@@ -1,17 +0,0 @@
1
- import type { Core } from './types';
2
- import { type NMLClient } from '@applitools/nml-client';
3
- import { type SpecType, type SpecDriver } from '@applitools/driver';
4
- import { type Logger } from '@applitools/logger';
5
- import { type Core as BaseCore } from '@applitools/core-base';
6
- type Options<TSpec extends SpecType> = {
7
- spec?: SpecDriver<TSpec>;
8
- clients?: {
9
- nml?: NMLClient;
10
- };
11
- base?: BaseCore;
12
- agentId?: string;
13
- cwd?: string;
14
- logger?: Logger;
15
- };
16
- export declare function makeCore<TSpec extends SpecType>({ spec, clients, base, agentId, cwd, logger: defaultLogger, }: Options<TSpec>): Core<TSpec>;
17
- export {};
@@ -1,18 +0,0 @@
1
- import type { Eyes, OpenSettings } from './types';
2
- import type { Eyes as BaseEyes } from '@applitools/core-base';
3
- import { type SpecType } from '@applitools/driver';
4
- import { type Logger } from '@applitools/logger';
5
- type Options<TSpec extends SpecType> = {
6
- settings: OpenSettings;
7
- eyes: Eyes<TSpec>;
8
- base?: BaseEyes[];
9
- logger: Logger;
10
- };
11
- export declare function makeGetBaseEyes<TSpec extends SpecType>({ settings, eyes, base, logger: mainLogger }: Options<TSpec>): (({ logger }?: {
12
- logger?: Logger | undefined;
13
- }) => Promise<BaseEyes[]>) & {
14
- getCachedValues(): Promise<BaseEyes[]>[];
15
- setCachedValue(key: any, value: Promise<BaseEyes[]>): void;
16
- clearCache(): void;
17
- };
18
- export {};
@@ -1,16 +0,0 @@
1
- import type { Core, DriverTarget, Eyes, OpenSettings } from './types';
2
- import type { Eyes as BaseEyes } from '@applitools/core-base';
3
- import { type Logger } from '@applitools/logger';
4
- import { type SpecType, type SpecDriver } from '@applitools/driver';
5
- type Options<TSpec extends SpecType> = {
6
- core: Core<TSpec>;
7
- spec?: SpecDriver<TSpec>;
8
- logger: Logger;
9
- };
10
- export declare function makeOpenEyes<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): ({ target, settings, base, logger, }: {
11
- target?: DriverTarget<TSpec> | undefined;
12
- settings: OpenSettings;
13
- base?: BaseEyes[] | undefined;
14
- logger?: Logger | undefined;
15
- }) => Promise<Eyes<TSpec>>;
16
- export {};