@applitools/eyes-browser 1.4.21 → 1.4.23
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 +25 -0
- package/dist/index.js +715 -259
- package/package.json +2 -2
- package/types/SDK.d.ts +1 -0
- package/types/input/CheckSettings.d.ts +5 -2
- package/types/input/Configuration.d.ts +11 -5
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@applitools/eyes-browser",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.23",
|
|
4
4
|
"keywords": [
|
|
5
5
|
"applitools",
|
|
6
6
|
"browser",
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
"test": "run --top-level mocha './test/**/*.spec.ts'"
|
|
49
49
|
},
|
|
50
50
|
"dependencies": {
|
|
51
|
-
"@applitools/eyes": "1.
|
|
51
|
+
"@applitools/eyes": "1.33.2"
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
54
|
"@types/node": "^12.20.55",
|
package/types/SDK.d.ts
CHANGED
|
@@ -4,6 +4,7 @@ export interface SDK<TSpec extends SpecType = SpecType> {
|
|
|
4
4
|
agentId?: string;
|
|
5
5
|
environment?: Record<string, any>;
|
|
6
6
|
maskLog?: boolean;
|
|
7
|
+
offlineLocationPath?: string;
|
|
7
8
|
makeCore?: typeof makeDefaultCore;
|
|
8
9
|
}
|
|
9
10
|
export declare function initSDK<TSpec extends SpecType = SpecType>(options?: SDK<TSpec>, maskLog?: boolean): {
|
|
@@ -10,6 +10,7 @@ import { LazyLoadOptions } from './LazyLoadOptions';
|
|
|
10
10
|
import { DensityMetrics } from './DensityMetrics';
|
|
11
11
|
import * as utils from '@applitools/utils';
|
|
12
12
|
import { DynamicTextType } from '../enums/DynamicTextType';
|
|
13
|
+
import { type StitchMode } from '../enums/StitchMode';
|
|
13
14
|
type RegionReference<TSpec extends Core.SpecType> = Region | LegacyRegion | ElementReference<TSpec>;
|
|
14
15
|
type ElementReference<TSpec extends Core.SpecType> = TSpec['element'] | SelectorReference<TSpec>;
|
|
15
16
|
type SelectorReference<TSpec extends Core.SpecType> = EyesSelector<TSpec['selector']>;
|
|
@@ -70,6 +71,7 @@ export type CheckSettingsBase<TRegion = never> = {
|
|
|
70
71
|
pageId?: string;
|
|
71
72
|
variationGroupId?: string;
|
|
72
73
|
densityMetrics?: DensityMetrics;
|
|
74
|
+
stitchMode?: StitchMode;
|
|
73
75
|
};
|
|
74
76
|
export type CheckSettingsImage = CheckSettingsBase;
|
|
75
77
|
export type CheckSettingsAutomation<TSpec extends Core.SpecType> = CheckSettingsBase<RegionReference<TSpec>> & {
|
|
@@ -98,7 +100,7 @@ export type CheckSettingsAutomation<TSpec extends Core.SpecType> = CheckSettings
|
|
|
98
100
|
beforeCaptureScreenshot: string;
|
|
99
101
|
};
|
|
100
102
|
timeout?: number;
|
|
101
|
-
waitBeforeCapture?: number;
|
|
103
|
+
waitBeforeCapture?: number | (() => Promise<void>);
|
|
102
104
|
lazyLoad?: boolean | LazyLoadOptions;
|
|
103
105
|
};
|
|
104
106
|
export declare class CheckSettingsBaseFluent<TRegion = never> {
|
|
@@ -230,9 +232,10 @@ export declare class CheckSettingsAutomationFluent<TSpec extends Core.SpecType =
|
|
|
230
232
|
}): this;
|
|
231
233
|
useSystemScreenshot(useSystemScreenshot?: boolean): this;
|
|
232
234
|
timeout(timeout: number): typeof this;
|
|
233
|
-
waitBeforeCapture(waitBeforeCapture: number): typeof this;
|
|
235
|
+
waitBeforeCapture(waitBeforeCapture: number | (() => Promise<void>)): typeof this;
|
|
234
236
|
lazyLoad(options?: LazyLoadOptions | boolean): typeof this;
|
|
235
237
|
densityMetrics(options: DensityMetrics): typeof this;
|
|
238
|
+
stitchMode(stitchMode: StitchMode): typeof this;
|
|
236
239
|
/** @internal */
|
|
237
240
|
toJSON(): {
|
|
238
241
|
target: undefined;
|
|
@@ -48,7 +48,9 @@ export type Configuration<TSpec extends Core.SpecType = Core.SpecType> = {
|
|
|
48
48
|
dontCloseBatches?: boolean;
|
|
49
49
|
enablePatterns?: boolean;
|
|
50
50
|
environmentName?: string;
|
|
51
|
+
/** @deprecated use fully instead */
|
|
51
52
|
forceFullPageScreenshot?: boolean;
|
|
53
|
+
fully?: boolean;
|
|
52
54
|
gitMergeBaseTimestamp?: string;
|
|
53
55
|
latestCommitInfo?: LatestCommitInfo;
|
|
54
56
|
hideCaret?: boolean;
|
|
@@ -91,7 +93,7 @@ export type Configuration<TSpec extends Core.SpecType = Core.SpecType> = {
|
|
|
91
93
|
useDom?: boolean;
|
|
92
94
|
viewportSize?: RectangleSize;
|
|
93
95
|
visualGridOptions?: Record<string, any>;
|
|
94
|
-
waitBeforeCapture?: number;
|
|
96
|
+
waitBeforeCapture?: number | (() => Promise<void>);
|
|
95
97
|
waitBeforeScreenshots?: number;
|
|
96
98
|
};
|
|
97
99
|
export declare class ConfigurationData<TSpec extends Core.SpecType = Core.SpecType> implements Required<Configuration<TSpec>> {
|
|
@@ -414,14 +416,18 @@ export declare class ConfigurationData<TSpec extends Core.SpecType = Core.SpecTy
|
|
|
414
416
|
[key: string]: any;
|
|
415
417
|
}): this;
|
|
416
418
|
setVisualGridOption(key: string, value: any): this;
|
|
417
|
-
get waitBeforeCapture(): number;
|
|
418
|
-
set waitBeforeCapture(waitBeforeCapture: number);
|
|
419
|
-
getWaitBeforeCapture(): number;
|
|
420
|
-
setWaitBeforeCapture(waitBeforeCapture: number): this;
|
|
419
|
+
get waitBeforeCapture(): number | (() => Promise<void>);
|
|
420
|
+
set waitBeforeCapture(waitBeforeCapture: number | (() => Promise<void>));
|
|
421
|
+
getWaitBeforeCapture(): number | (() => Promise<void>);
|
|
422
|
+
setWaitBeforeCapture(waitBeforeCapture: number | (() => Promise<void>)): this;
|
|
421
423
|
get waitBeforeScreenshots(): number;
|
|
422
424
|
set waitBeforeScreenshots(waitBeforeScreenshots: number);
|
|
423
425
|
getWaitBeforeScreenshots(): number;
|
|
424
426
|
setWaitBeforeScreenshots(waitBeforeScreenshots: number): this;
|
|
427
|
+
get fully(): boolean;
|
|
428
|
+
set fully(fully: boolean);
|
|
429
|
+
getFully(): boolean;
|
|
430
|
+
setFully(fully: boolean): this;
|
|
425
431
|
/** @internal */
|
|
426
432
|
toObject(): Configuration<TSpec>;
|
|
427
433
|
/** @internal */
|