@applitools/core 1.2.17 → 1.3.1

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 (69) hide show
  1. package/dist/automation/get-viewport-size.js +3 -3
  2. package/dist/automation/locate.js +5 -5
  3. package/dist/automation/set-viewport-size.js +3 -3
  4. package/dist/check-and-close.js +11 -6
  5. package/dist/check.js +28 -17
  6. package/dist/classic/check-and-close.js +12 -8
  7. package/dist/classic/check.js +15 -11
  8. package/dist/classic/extract-text.js +5 -9
  9. package/dist/classic/get-base-eyes.js +4 -4
  10. package/dist/classic/locate-text.js +5 -5
  11. package/dist/classic/open-eyes.js +7 -7
  12. package/dist/close.js +2 -1
  13. package/dist/extract-text.js +2 -1
  14. package/dist/get-typed-eyes.js +27 -0
  15. package/dist/index.js +3 -1
  16. package/dist/locate-text.js +2 -1
  17. package/dist/make-manager.js +9 -2
  18. package/dist/open-eyes.js +37 -39
  19. package/dist/types.js +1 -0
  20. package/dist/ufg/abort.js +1 -1
  21. package/dist/ufg/check-and-close.js +220 -2
  22. package/dist/ufg/check.js +14 -9
  23. package/dist/ufg/core.js +2 -0
  24. package/dist/ufg/get-base-eyes.js +1 -17
  25. package/dist/ufg/open-eyes.js +5 -11
  26. package/dist/ufg/utils/take-dom-snapshots.js +11 -3
  27. package/dist/utils/wait-for-lazy-load.js +10 -8
  28. package/package.json +18 -16
  29. package/types/automation/get-viewport-size.d.ts +6 -3
  30. package/types/automation/locate.d.ts +7 -4
  31. package/types/automation/set-viewport-size.d.ts +8 -3
  32. package/types/automation/types.d.ts +18 -69
  33. package/types/automation/utils/take-screenshot.d.ts +1 -1
  34. package/types/check-and-close.d.ts +13 -13
  35. package/types/check.d.ts +9 -11
  36. package/types/classic/check-and-close.d.ts +9 -5
  37. package/types/classic/check.d.ts +9 -5
  38. package/types/classic/core.d.ts +1 -1
  39. package/types/classic/extract-text.d.ts +10 -5
  40. package/types/classic/get-base-eyes.d.ts +3 -3
  41. package/types/classic/locate-text.d.ts +9 -5
  42. package/types/classic/open-eyes.d.ts +9 -4
  43. package/types/classic/types.d.ts +8 -35
  44. package/types/classic/utils/take-dom-capture.d.ts +1 -1
  45. package/types/close-batch.d.ts +1 -1
  46. package/types/close-manager.d.ts +1 -1
  47. package/types/close.d.ts +4 -6
  48. package/types/core.d.ts +1 -1
  49. package/types/delete-test.d.ts +1 -1
  50. package/types/extract-text.d.ts +7 -9
  51. package/types/get-typed-eyes.d.ts +21 -0
  52. package/types/index.d.ts +1 -0
  53. package/types/locate-text.d.ts +7 -9
  54. package/types/locate.d.ts +3 -4
  55. package/types/make-manager.d.ts +2 -1
  56. package/types/open-eyes.d.ts +13 -9
  57. package/types/types.d.ts +38 -23
  58. package/types/ufg/abort.d.ts +5 -3
  59. package/types/ufg/check-and-close.d.ts +11 -5
  60. package/types/ufg/check.d.ts +9 -5
  61. package/types/ufg/close.d.ts +6 -3
  62. package/types/ufg/core.d.ts +1 -1
  63. package/types/ufg/get-base-eyes.d.ts +3 -3
  64. package/types/ufg/open-eyes.d.ts +6 -7
  65. package/types/ufg/types.d.ts +12 -37
  66. package/types/ufg/utils/take-dom-snapshot.d.ts +1 -1
  67. package/types/ufg/utils/take-dom-snapshots.d.ts +2 -2
  68. package/types/ufg/utils/take-vhses.d.ts +1 -1
  69. package/types/utils/wait-for-lazy-load.d.ts +4 -4
@@ -3,116 +3,65 @@ import type * as BaseCore from '@applitools/core-base/types';
3
3
  import { type Driver, type Selector } from '@applitools/driver';
4
4
  import { type Logger } from '@applitools/logger';
5
5
  export * from '@applitools/core-base/types';
6
- export declare type Screenshot = BaseCore.Target;
7
- export declare type Target<TDriver> = TDriver;
6
+ export type DriverTarget<TDriver, TContext, TElement, TSelector> = TDriver | Driver<TDriver, TContext, TElement, TSelector>;
8
7
  export interface Core<TDriver, TContext, TElement, TSelector, TEyes = Eyes<TDriver, TContext, TElement, TSelector>> extends BaseCore.Core<TEyes> {
9
8
  isDriver(driver: any): driver is TDriver;
10
9
  isElement(element: any): element is TElement;
11
10
  isSelector(selector: any): selector is TSelector;
12
11
  getViewportSize(options: {
13
- driver: Driver<TDriver, TContext, TElement, TSelector>;
14
- logger?: Logger;
15
- }): Promise<Size>;
16
- getViewportSize(options: {
17
- target: TDriver;
12
+ target: DriverTarget<TDriver, TContext, TElement, TSelector>;
18
13
  logger?: Logger;
19
14
  }): Promise<Size>;
20
15
  setViewportSize(options: {
21
- driver: Driver<TDriver, TContext, TElement, TSelector>;
22
- size: Size;
23
- logger?: Logger;
24
- }): Promise<void>;
25
- setViewportSize(options: {
26
- target: TDriver;
16
+ target: DriverTarget<TDriver, TContext, TElement, TSelector>;
27
17
  size: Size;
28
18
  logger?: Logger;
29
19
  }): Promise<void>;
30
20
  openEyes(options: {
31
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
21
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
32
22
  settings: BaseCore.OpenSettings;
23
+ eyes?: BaseCore.Eyes[];
33
24
  logger?: Logger;
34
25
  }): Promise<TEyes>;
35
- openEyes(options: {
36
- target?: TDriver;
37
- settings?: BaseCore.OpenSettings;
38
- logger?: Logger;
39
- }): Promise<TEyes>;
40
- /** @internal */
41
- openEyes(options: {
42
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
43
- eyes: BaseCore.Eyes[];
44
- logger?: Logger;
45
- }): Promise<TEyes>;
46
- /** @internal */
47
- openEyes(options: {
48
- target?: TDriver;
49
- eyes: BaseCore.Eyes[];
50
- logger?: Logger;
51
- }): Promise<TEyes>;
52
- locate<TLocator extends string>(options: {
53
- driver: Driver<TDriver, TContext, TElement, TSelector>;
54
- settings: LocateSettings<TLocator, TElement, TSelector>;
55
- logger?: Logger;
56
- }): Promise<BaseCore.LocateResult<TLocator>>;
57
26
  locate<TLocator extends string>(options: {
58
- target: Target<TDriver> | Screenshot;
27
+ target: DriverTarget<TDriver, TContext, TElement, TSelector> | BaseCore.ImageTarget;
59
28
  settings: LocateSettings<TLocator, TElement, TSelector>;
60
29
  logger?: Logger;
61
30
  }): Promise<BaseCore.LocateResult<TLocator>>;
62
31
  }
63
- export interface Eyes<TDriver, TContext, TElement, TSelector, TTarget = Target<TDriver>> extends BaseCore.Eyes<TTarget> {
32
+ export interface Eyes<TDriver, TContext, TElement, TSelector, TTarget = DriverTarget<TDriver, TContext, TElement, TSelector>> extends BaseCore.Eyes<TTarget> {
64
33
  getBaseEyes(options?: {
65
34
  logger?: Logger;
66
35
  }): Promise<BaseCore.Eyes[]>;
67
- check(options: {
68
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
69
- settings?: CheckSettings<TElement, TSelector>;
70
- logger?: Logger;
71
- }): Promise<BaseCore.CheckResult[]>;
72
- check(options: {
36
+ check(options?: {
73
37
  target?: TTarget;
74
38
  settings?: CheckSettings<TElement, TSelector>;
75
39
  logger?: Logger;
76
40
  }): Promise<BaseCore.CheckResult[]>;
77
- checkAndClose(options: {
78
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
79
- settings?: CheckSettings<TElement, TSelector> & BaseCore.CloseSettings;
80
- logger?: Logger;
81
- }): Promise<BaseCore.TestResult[]>;
82
- checkAndClose(options: {
41
+ checkAndClose(options?: {
83
42
  target?: TTarget;
84
43
  settings?: CheckSettings<TElement, TSelector> & BaseCore.CloseSettings;
85
44
  logger?: Logger;
86
45
  }): Promise<BaseCore.TestResult[]>;
87
- locateText?<TPattern extends string>(options: {
88
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
89
- settings: LocateTextSettings<TPattern, TElement, TSelector>;
90
- logger?: Logger;
91
- }): Promise<BaseCore.LocateTextResult<TPattern>>;
92
46
  locateText?<TPattern extends string>(options: {
93
47
  target?: TTarget;
94
48
  settings: LocateTextSettings<TPattern, TElement, TSelector>;
95
49
  logger?: Logger;
96
50
  }): Promise<BaseCore.LocateTextResult<TPattern>>;
97
- extractText?(options: {
98
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
99
- settings: MaybeArray<ExtractTextSettings<TElement, TSelector>>;
100
- logger?: Logger;
101
- }): Promise<string[]>;
102
51
  extractText?(options: {
103
52
  target?: TTarget;
104
53
  settings: MaybeArray<ExtractTextSettings<TElement, TSelector>>;
105
54
  logger?: Logger;
106
55
  }): Promise<string[]>;
107
56
  }
108
- declare type RegionReference<TElement, TSelector> = Region | ElementReference<TElement, TSelector>;
109
- declare type ElementReference<TElement, TSelector> = TElement | Selector<TSelector>;
110
- declare type FrameReference<TElement, TSelector> = ElementReference<TElement, TSelector> | string | number;
111
- declare type ContextReference<TElement, TSelector> = {
57
+ type RegionReference<TElement, TSelector> = Region | ElementReference<TElement, TSelector>;
58
+ type ElementReference<TElement, TSelector> = TElement | Selector<TSelector>;
59
+ type FrameReference<TElement, TSelector> = ElementReference<TElement, TSelector> | string | number;
60
+ type ContextReference<TElement, TSelector> = {
112
61
  frame: FrameReference<TElement, TSelector>;
113
62
  scrollRootElement?: ElementReference<TElement, TSelector>;
114
63
  };
115
- declare type StitchMode = 'Scroll' | 'CSS';
64
+ type StitchMode = 'Scroll' | 'CSS';
116
65
  export interface ScreenshotSettings<TElement, TSelector> extends BaseCore.ImageSettings<RegionReference<TElement, TSelector>> {
117
66
  frames?: (ContextReference<TElement, TSelector> | FrameReference<TElement, TSelector>)[];
118
67
  fully?: boolean;
@@ -133,7 +82,7 @@ export interface ScreenshotSettings<TElement, TSelector> extends BaseCore.ImageS
133
82
  };
134
83
  webview?: boolean | string;
135
84
  }
136
- export declare type LocateSettings<TLocator extends string, TElement, TSelector> = BaseCore.LocateSettings<TLocator, RegionReference<TElement, TSelector>> & ScreenshotSettings<TElement, TSelector>;
137
- export declare type CheckSettings<TElement, TSelector> = BaseCore.CheckSettings<RegionReference<TElement, TSelector>> & ScreenshotSettings<TElement, TSelector>;
138
- export declare type LocateTextSettings<TPattern extends string, TElement, TSelector> = BaseCore.LocateTextSettings<TPattern, RegionReference<TElement, TSelector>> & ScreenshotSettings<TElement, TSelector>;
139
- export declare type ExtractTextSettings<TElement, TSelector> = BaseCore.ExtractTextSettings<RegionReference<TElement, TSelector>> & ScreenshotSettings<TElement, TSelector>;
85
+ export type LocateSettings<TLocator extends string, TElement, TSelector> = BaseCore.LocateSettings<TLocator, RegionReference<TElement, TSelector>> & ScreenshotSettings<TElement, TSelector>;
86
+ export type CheckSettings<TElement, TSelector> = BaseCore.CheckSettings<RegionReference<TElement, TSelector>> & ScreenshotSettings<TElement, TSelector>;
87
+ export type LocateTextSettings<TPattern extends string, TElement, TSelector> = BaseCore.LocateTextSettings<TPattern, RegionReference<TElement, TSelector>> & ScreenshotSettings<TElement, TSelector>;
88
+ export type ExtractTextSettings<TElement, TSelector> = BaseCore.ExtractTextSettings<RegionReference<TElement, TSelector>> & ScreenshotSettings<TElement, TSelector>;
@@ -2,7 +2,7 @@ import type { Region } from '@applitools/utils';
2
2
  import type { ScreenshotSettings } from '../../classic/types';
3
3
  import { type Logger } from '@applitools/logger';
4
4
  import { type Driver, type Element } from '@applitools/driver';
5
- export declare type Screenshot = {
5
+ export type Screenshot = {
6
6
  image: any;
7
7
  region: Region;
8
8
  element: Element<unknown, unknown, unknown, unknown>;
@@ -1,20 +1,20 @@
1
- import type { Target, Config, CheckSettings, CloseSettings, TestResult } from './types';
2
- import type { Eyes as ClassicEyes } from './classic/types';
3
- import type { Eyes as UFGEyes } from './ufg/types';
1
+ import type { Target, Eyes, Config, CheckSettings, CloseSettings, TestResult } from './types';
4
2
  import { type Logger } from '@applitools/logger';
5
- declare type Options<TDriver, TContext, TElement, TSelector> = {
6
- type?: 'classic' | 'ufg';
7
- getTypedEyes<TType extends 'classic' | 'ufg'>(options: {
8
- type: TType;
9
- renderers: any[];
10
- }): Promise<TType extends 'ufg' ? UFGEyes<TDriver, TContext, TElement, TSelector> : ClassicEyes<TDriver, TContext, TElement, TSelector>>;
3
+ import { type SpecDriver } from '@applitools/driver';
4
+ type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
5
+ type?: TType;
6
+ eyes: Eyes<TDriver, TContext, TElement, TSelector, TType>;
7
+ target?: Target<TDriver, TContext, TElement, TSelector, TType>;
8
+ spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
11
9
  logger: Logger;
12
10
  };
13
- export declare function makeCheckAndClose<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg' = 'classic' | 'ufg'>({ type: defaultType, getTypedEyes, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ type, target, settings, config, logger, }?: {
11
+ export declare function makeCheckAndClose<TDriver, TContext, TElement, TSelector, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, target, settings, config, logger, }?: {
14
12
  type?: TType;
15
- target?: Target<TDriver, TType>;
16
- settings?: CheckSettings<TElement, TSelector, TType> & CloseSettings<TType>;
17
- config?: Config<TElement, TSelector, TType>;
13
+ target?: Target<TDriver, TContext, TElement, TSelector, TType>;
14
+ settings?: CheckSettings<TElement, TSelector, TDefaultType> & (TDefaultType extends "ufg" ? import("@applitools/core-base").CloseSettings : import("@applitools/core-base").CloseSettings) & {
15
+ throwErr?: boolean;
16
+ } & CheckSettings<TElement, TSelector, TType> & (TType extends "ufg" ? import("@applitools/core-base").CloseSettings : import("@applitools/core-base").CloseSettings);
17
+ config?: Config<TElement, TSelector, TDefaultType> & Config<TElement, TSelector, TType>;
18
18
  logger?: Logger;
19
19
  }) => Promise<TestResult<TType>[]>;
20
20
  export {};
package/types/check.d.ts CHANGED
@@ -1,18 +1,16 @@
1
- import type { Target, Config, CheckSettings, CheckResult } from './types';
2
- import type { Eyes as ClassicEyes } from './classic/types';
3
- import type { Eyes as UFGEyes } from './ufg/types';
1
+ import type { Target, Eyes, Config, CheckSettings, CheckResult } from './types';
4
2
  import { type Logger } from '@applitools/logger';
5
- declare type Options<TDriver, TContext, TElement, TSelector> = {
6
- type?: 'classic' | 'ufg';
7
- getTypedEyes<TType extends 'classic' | 'ufg'>(options: {
8
- type: TType;
9
- renderers: any[];
10
- }): Promise<TType extends 'ufg' ? UFGEyes<TDriver, TContext, TElement, TSelector> : ClassicEyes<TDriver, TContext, TElement, TSelector>>;
3
+ import { type SpecDriver } from '@applitools/driver';
4
+ type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
5
+ type?: TType;
6
+ eyes: Eyes<TDriver, TContext, TElement, TSelector, TType>;
7
+ target?: Target<TDriver, TContext, TElement, TSelector, TType>;
8
+ spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
11
9
  logger?: Logger;
12
10
  };
13
- export declare function makeCheck<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'>({ type: defaultType, getTypedEyes, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ type, target, settings, config, logger, }?: {
11
+ export declare function makeCheck<TDriver, TContext, TElement, TSelector, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, target, settings, config, logger, }?: {
14
12
  type?: TType;
15
- target?: Target<TDriver, TType>;
13
+ target?: Target<TDriver, TContext, TElement, TSelector, TType>;
16
14
  settings?: CheckSettings<TElement, TSelector, TType>;
17
15
  config?: Config<TElement, TSelector, TType>;
18
16
  logger?: Logger;
@@ -1,11 +1,15 @@
1
- import type { Eyes } from './types';
1
+ import type { ClassicTarget, DriverTarget, Eyes, CheckSettings, CloseSettings, TestResult } from './types';
2
2
  import { type Logger } from '@applitools/logger';
3
- import { type Driver, type SpecDriver } from '@applitools/driver';
4
- declare type Options<TDriver, TContext, TElement, TSelector> = {
3
+ import { type SpecDriver } from '@applitools/driver';
4
+ type Options<TDriver, TContext, TElement, TSelector> = {
5
5
  eyes: Eyes<TDriver, TContext, TElement, TSelector>;
6
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
6
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
7
7
  spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
8
8
  logger?: Logger;
9
9
  };
10
- export declare function makeCheckAndClose<TDriver, TContext, TElement, TSelector>({ eyes, driver: defaultDriver, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): Eyes<TDriver, TContext, TElement, TSelector>['checkAndClose'];
10
+ export declare function makeCheckAndClose<TDriver, TContext, TElement, TSelector>({ eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, }?: {
11
+ target?: ClassicTarget<TDriver, TContext, TElement, TSelector>;
12
+ settings?: CheckSettings<TElement, TSelector> & CloseSettings;
13
+ logger?: Logger;
14
+ }) => Promise<TestResult[]>;
11
15
  export {};
@@ -1,11 +1,15 @@
1
- import type { Eyes } from './types';
1
+ import type { ClassicTarget, DriverTarget, Eyes, CheckSettings, CheckResult } from './types';
2
2
  import { type Logger } from '@applitools/logger';
3
- import { type Driver, type SpecDriver } from '@applitools/driver';
4
- declare type Options<TDriver, TContext, TElement, TSelector> = {
3
+ import { type SpecDriver } from '@applitools/driver';
4
+ type Options<TDriver, TContext, TElement, TSelector> = {
5
5
  eyes: Eyes<TDriver, TContext, TElement, TSelector>;
6
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
6
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
7
7
  spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
8
8
  logger?: Logger;
9
9
  };
10
- export declare function makeCheck<TDriver, TContext, TElement, TSelector>({ eyes, driver: defaultDriver, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): Eyes<TDriver, TContext, TElement, TSelector>['check'];
10
+ export declare function makeCheck<TDriver, TContext, TElement, TSelector>({ eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, }?: {
11
+ target?: ClassicTarget<TDriver, TContext, TElement, TSelector>;
12
+ settings?: CheckSettings<TElement, TSelector>;
13
+ logger?: Logger;
14
+ }) => Promise<CheckResult[]>;
11
15
  export {};
@@ -2,7 +2,7 @@ import type { Core } from './types';
2
2
  import { type SpecDriver } from '@applitools/driver';
3
3
  import { type Logger } from '@applitools/logger';
4
4
  import { type Core as BaseCore } from '@applitools/core-base';
5
- declare type Options<TDriver, TContext, TElement, TSelector> = {
5
+ type Options<TDriver, TContext, TElement, TSelector> = {
6
6
  spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
7
7
  core?: BaseCore;
8
8
  agentId?: string;
@@ -1,11 +1,16 @@
1
- import type { Eyes } from './types';
1
+ import type { MaybeArray } from '@applitools/utils';
2
+ import type { ClassicTarget, DriverTarget, Eyes, ExtractTextSettings } from './types';
2
3
  import { type Logger } from '@applitools/logger';
3
- import { type Driver, type SpecDriver } from '@applitools/driver';
4
- declare type Options<TDriver, TContext, TElement, TSelector> = {
4
+ import { type SpecDriver } from '@applitools/driver';
5
+ type Options<TDriver, TContext, TElement, TSelector> = {
5
6
  eyes: Eyes<TDriver, TContext, TElement, TSelector>;
6
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
7
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
7
8
  spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
8
9
  logger?: Logger;
9
10
  };
10
- export declare function makeExtractText<TDriver, TContext, TElement, TSelector>({ eyes, driver: defaultDriver, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): Eyes<TDriver, TContext, TElement, TSelector>['extractText'];
11
+ export declare function makeExtractText<TDriver, TContext, TElement, TSelector>({ eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, }: {
12
+ target?: ClassicTarget<TDriver, TContext, TElement, TSelector>;
13
+ settings: MaybeArray<ExtractTextSettings<TElement, TSelector>>;
14
+ logger?: Logger;
15
+ }) => Promise<string[]>;
11
16
  export {};
@@ -1,7 +1,7 @@
1
1
  import type { OpenSettings } from './types';
2
2
  import type { Core as BaseCore, Eyes as BaseEyes } from '@applitools/core-base';
3
3
  import { type Logger } from '@applitools/logger';
4
- declare type Options = {
4
+ type Options = {
5
5
  settings?: OpenSettings;
6
6
  eyes?: BaseEyes[];
7
7
  core?: BaseCore;
@@ -10,8 +10,8 @@ declare type Options = {
10
10
  export declare function makeGetBaseEyes({ settings, core, eyes, logger: defaultLogger }: Options): (({ logger }?: {
11
11
  logger?: Logger;
12
12
  }) => Promise<BaseEyes[]>) & {
13
- getCachedValues(): Promise<BaseEyes<import("@applitools/core-base").Target>[]>[];
14
- setCachedValue(key: any, value: Promise<BaseEyes<import("@applitools/core-base").Target>[]>): void;
13
+ getCachedValues(): Promise<BaseEyes<import("@applitools/core-base").ImageTarget>[]>[];
14
+ setCachedValue(key: any, value: Promise<BaseEyes<import("@applitools/core-base").ImageTarget>[]>): void;
15
15
  clearCache(): void;
16
16
  };
17
17
  export {};
@@ -1,11 +1,15 @@
1
- import type { Eyes } from './types';
1
+ import type { ClassicTarget, DriverTarget, Eyes, LocateTextSettings, LocateTextResult } from './types';
2
2
  import { type Logger } from '@applitools/logger';
3
- import { type Driver, type SpecDriver } from '@applitools/driver';
4
- declare type Options<TDriver, TContext, TElement, TSelector> = {
3
+ import { type SpecDriver } from '@applitools/driver';
4
+ type Options<TDriver, TContext, TElement, TSelector> = {
5
5
  eyes: Eyes<TDriver, TContext, TElement, TSelector>;
6
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
6
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
7
7
  spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
8
8
  logger?: Logger;
9
9
  };
10
- export declare function makeLocateText<TDriver, TContext, TElement, TSelector>({ spec, driver: defaultDriver, eyes, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): Eyes<TDriver, TContext, TElement, TSelector>['locateText'];
10
+ export declare function makeLocateText<TDriver, TContext, TElement, TSelector>({ eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): <TPattern extends string>({ target, settings, logger, }: {
11
+ target?: ClassicTarget<TDriver, TContext, TElement, TSelector>;
12
+ settings: LocateTextSettings<TPattern, TElement, TSelector>;
13
+ logger?: Logger;
14
+ }) => Promise<LocateTextResult<TPattern>>;
11
15
  export {};
@@ -1,11 +1,16 @@
1
- import type { Core } from './types';
2
- import type { Core as BaseCore } from '@applitools/core-base';
1
+ import type { DriverTarget, Eyes, OpenSettings } from './types';
2
+ import type { Core as BaseCore, Eyes as BaseEyes } from '@applitools/core-base';
3
3
  import { type Logger } from '@applitools/logger';
4
4
  import { type SpecDriver } from '@applitools/driver';
5
- declare type Options<TDriver, TContext, TElement, TSelector> = {
5
+ type Options<TDriver, TContext, TElement, TSelector> = {
6
6
  core: BaseCore;
7
7
  spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
8
8
  logger?: Logger;
9
9
  };
10
- export declare function makeOpenEyes<TDriver, TContext, TElement, TSelector>({ core, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): Core<TDriver, TContext, TElement, TSelector>['openEyes'];
10
+ export declare function makeOpenEyes<TDriver, TContext, TElement, TSelector>({ core, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, eyes, logger, }: {
11
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
12
+ settings: OpenSettings;
13
+ eyes?: BaseEyes[];
14
+ logger?: Logger;
15
+ }) => Promise<Eyes<TDriver, TContext, TElement, TSelector>>;
11
16
  export {};
@@ -1,61 +1,34 @@
1
1
  import type * as BaseCore from '@applitools/core-base/types';
2
2
  import type * as AutomationCore from '../automation/types';
3
3
  import { type Logger } from '@applitools/logger';
4
- import { type Driver } from '@applitools/driver';
5
4
  export * from '../automation/types';
6
- export declare type Target<TDriver> = AutomationCore.Target<TDriver> | AutomationCore.Screenshot;
7
- export interface Core<TDriver, TContext, TElement, TSelector> extends AutomationCore.Core<TDriver, TContext, TElement, TSelector, Eyes<TDriver, TContext, TElement, TSelector>> {
5
+ export type ClassicTarget<TDriver, TContext, TElement, TSelector> = AutomationCore.DriverTarget<TDriver, TContext, TElement, TSelector> | AutomationCore.ImageTarget;
6
+ export interface Core<TDriver, TContext, TElement, TSelector, TEyes = Eyes<TDriver, TContext, TElement, TSelector>> extends AutomationCore.Core<TDriver, TContext, TElement, TSelector, TEyes> {
8
7
  readonly type: 'classic';
9
8
  openEyes(options: {
10
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
9
+ target?: AutomationCore.DriverTarget<TDriver, TContext, TElement, TSelector>;
11
10
  settings: OpenSettings;
11
+ eyes?: BaseCore.Eyes[];
12
12
  logger?: Logger;
13
- }): Promise<Eyes<TDriver, TContext, TElement, TSelector>>;
14
- openEyes(options: {
15
- target?: TDriver;
16
- settings: OpenSettings;
17
- logger?: Logger;
18
- }): Promise<Eyes<TDriver, TContext, TElement, TSelector>>;
19
- /** @internal */
20
- openEyes(options: {
21
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
22
- eyes: BaseCore.Eyes[];
23
- logger?: Logger;
24
- }): Promise<Eyes<TDriver, TContext, TElement, TSelector>>;
25
- /** @internal */
26
- openEyes(options: {
27
- target?: TDriver;
28
- eyes: BaseCore.Eyes[];
29
- logger?: Logger;
30
- }): Promise<Eyes<TDriver, TContext, TElement, TSelector>>;
13
+ }): Promise<TEyes>;
31
14
  }
32
- export interface Eyes<TDriver, TContext, TElement, TSelector, TTarget = Target<TDriver>> extends AutomationCore.Eyes<TDriver, TContext, TElement, TSelector, TTarget> {
15
+ export interface Eyes<TDriver, TContext, TElement, TSelector, TTarget = ClassicTarget<TDriver, TContext, TElement, TSelector>> extends AutomationCore.Eyes<TDriver, TContext, TElement, TSelector, TTarget> {
33
16
  readonly type: 'classic';
34
- check(options?: {
35
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
36
- settings?: CheckSettings<TElement, TSelector>;
37
- logger?: Logger;
38
- }): Promise<AutomationCore.CheckResult[]>;
39
17
  check(options?: {
40
18
  target?: TTarget;
41
19
  settings?: CheckSettings<TElement, TSelector>;
42
20
  logger?: Logger;
43
21
  }): Promise<AutomationCore.CheckResult[]>;
44
- checkAndClose(options?: {
45
- driver?: Driver<TDriver, TContext, TElement, TSelector>;
46
- settings?: CheckSettings<TElement, TSelector> & AutomationCore.CloseSettings;
47
- logger?: Logger;
48
- }): Promise<AutomationCore.TestResult[]>;
49
22
  checkAndClose(options?: {
50
23
  target?: TTarget;
51
24
  settings?: CheckSettings<TElement, TSelector> & AutomationCore.CloseSettings;
52
25
  logger?: Logger;
53
26
  }): Promise<AutomationCore.TestResult[]>;
54
27
  }
55
- export declare type OpenSettings = AutomationCore.OpenSettings & {
28
+ export type OpenSettings = AutomationCore.OpenSettings & {
56
29
  keepPlatformNameAsIs?: boolean;
57
30
  useCeilForViewportSize?: boolean;
58
31
  };
59
- export declare type CheckSettings<TElement, TSelector> = AutomationCore.CheckSettings<TElement, TSelector> & {
32
+ export type CheckSettings<TElement, TSelector> = AutomationCore.CheckSettings<TElement, TSelector> & {
60
33
  retryTimeout?: number;
61
34
  };
@@ -1,7 +1,7 @@
1
1
  import { type Driver } from '@applitools/driver';
2
2
  import { type Logger } from '@applitools/logger';
3
3
  import { type Fetch } from '@applitools/req';
4
- export declare type DomCaptureSettings = {
4
+ export type DomCaptureSettings = {
5
5
  fetch?: Fetch;
6
6
  executionTimeout?: number;
7
7
  pollTimeout?: number;
@@ -2,7 +2,7 @@ import type { MaybeArray } from '@applitools/utils';
2
2
  import type { CloseBatchSettings } from './types';
3
3
  import type { Core as BaseCore } from '@applitools/core-base';
4
4
  import { type Logger } from '@applitools/logger';
5
- declare type Options = {
5
+ type Options = {
6
6
  core: BaseCore;
7
7
  logger: Logger;
8
8
  };
@@ -1,7 +1,7 @@
1
1
  import type { Eyes, TestResult, TestResultSummary } from './types';
2
2
  import type { Core as BaseCore } from '@applitools/core-base';
3
3
  import { type Logger } from '@applitools/logger';
4
- declare type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
4
+ type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
5
5
  core: BaseCore<unknown>;
6
6
  storage: {
7
7
  eyes: Eyes<TDriver, TContext, TElement, TSelector, TType>;
package/types/close.d.ts CHANGED
@@ -1,12 +1,10 @@
1
- import type { Config, CloseSettings, TestResult } from './types';
2
- import type { Eyes as ClassicEyes } from './classic/types';
3
- import type { Eyes as UFGEyes } from './ufg/types';
1
+ import type { Eyes, Config, CloseSettings, TestResult } from './types';
4
2
  import { type Logger } from '@applitools/logger';
5
- declare type Options<TDriver, TContext, TElement, TSelector> = {
6
- eyes: ClassicEyes<TDriver, TContext, TElement, TSelector> | UFGEyes<TDriver, TContext, TElement, TSelector>;
3
+ type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
4
+ eyes: Eyes<TDriver, TContext, TElement, TSelector, TType>;
7
5
  logger: Logger;
8
6
  };
9
- export declare function makeClose<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'>({ eyes, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ settings, config, logger, }?: {
7
+ export declare function makeClose<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'>({ eyes, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TType>): ({ settings, config, logger, }?: {
10
8
  settings?: CloseSettings<TType>;
11
9
  config?: Config<TElement, TSelector, TType>;
12
10
  logger?: Logger;
package/types/core.d.ts CHANGED
@@ -2,7 +2,7 @@ import type { Core } from './types';
2
2
  import type { Core as BaseCore } from '@applitools/core-base';
3
3
  import { type SpecDriver } from '@applitools/driver';
4
4
  import { type Logger } from '@applitools/logger';
5
- declare type Options<TDriver, TContext, TElement, TSelector> = {
5
+ type Options<TDriver, TContext, TElement, TSelector> = {
6
6
  spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
7
7
  concurrency?: number;
8
8
  core?: BaseCore;
@@ -2,7 +2,7 @@ import type { MaybeArray } from '@applitools/utils';
2
2
  import type { DeleteTestSettings } from './types';
3
3
  import type { Core as BaseCore } from '@applitools/core-base';
4
4
  import { type Logger } from '@applitools/logger';
5
- declare type Options = {
5
+ type Options = {
6
6
  core: BaseCore;
7
7
  logger: Logger;
8
8
  };
@@ -1,16 +1,14 @@
1
1
  import type { MaybeArray } from '@applitools/utils';
2
- import type { Target, Config, ExtractTextSettings } from './types';
3
- import type { Eyes as ClassicEyes } from './classic/types';
4
- import type { Eyes as UFGEyes } from './ufg/types';
2
+ import type { Target, Eyes, Config, ExtractTextSettings } from './types';
5
3
  import { type Logger } from '@applitools/logger';
6
- declare type Options<TDriver, TContext, TElement, TSelector> = {
7
- eyes: ClassicEyes<TDriver, TContext, TElement, TSelector> | UFGEyes<TDriver, TContext, TElement, TSelector>;
4
+ type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
5
+ eyes: Eyes<TDriver, TContext, TElement, TSelector, TType>;
8
6
  logger: Logger;
9
7
  };
10
- export declare function makeExtractText<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'>({ eyes, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, config, logger, }: {
11
- target?: Target<TDriver, TType>;
12
- settings: MaybeArray<ExtractTextSettings<TElement, TSelector, TType>>;
13
- config?: Config<TElement, TSelector, TType>;
8
+ export declare function makeExtractText<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg' = 'classic'>({ eyes, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TType>): ({ target, settings, config, logger, }: {
9
+ target?: Target<TDriver, TContext, TElement, TSelector, 'classic'>;
10
+ settings: MaybeArray<ExtractTextSettings<TElement, TSelector, 'classic'>>;
11
+ config?: Config<TElement, TSelector, 'classic'>;
14
12
  logger?: Logger;
15
13
  }) => Promise<string[]>;
16
14
  export {};
@@ -0,0 +1,21 @@
1
+ import type { TypedCore, TypedEyes, OpenSettings } from './types';
2
+ import { type Renderer } from '@applitools/ufg-client';
3
+ import { type Logger } from '@applitools/logger';
4
+ type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
5
+ type: TType;
6
+ settings: OpenSettings<TType>;
7
+ target?: TDriver;
8
+ cores: {
9
+ [TKey in 'classic' | 'ufg']: TypedCore<TDriver, TContext, TElement, TSelector, TKey>;
10
+ };
11
+ logger?: Logger;
12
+ };
13
+ export declare function makeGetTypedEyes<TDriver, TContext, TElement, TSelector, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, settings: defaultSettings, target, cores, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings, logger, }?: {
14
+ type?: TType;
15
+ settings?: {
16
+ type: 'web' | 'native';
17
+ renderers: Renderer[];
18
+ };
19
+ logger?: Logger;
20
+ }) => Promise<TypedEyes<TDriver, TContext, TElement, TSelector, TType, import("./types").Target<TDriver, TContext, TElement, TSelector, TType>>>;
21
+ export {};
package/types/index.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  export * from './types';
2
2
  export { type Selector } from '@applitools/driver';
3
3
  export * from './core';
4
+ export { takeDomSnapshots } from './ufg/utils/take-dom-snapshots';
4
5
  export * as formatters from './utils/format-results';
5
6
  export * from '@applitools/driver/dist/debug';
@@ -1,15 +1,13 @@
1
- import type { Target, Config, LocateTextSettings, LocateTextResult } from './types';
2
- import type { Eyes as ClassicEyes } from './classic/types';
3
- import type { Eyes as UFGEyes } from './ufg/types';
1
+ import type { Target, Eyes, Config, LocateTextSettings, LocateTextResult } from './types';
4
2
  import { type Logger } from '@applitools/logger';
5
- declare type Options<TDriver, TContext, TElement, TSelector> = {
6
- eyes: ClassicEyes<TDriver, TContext, TElement, TSelector> | UFGEyes<TDriver, TContext, TElement, TSelector>;
3
+ type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
4
+ eyes: Eyes<TDriver, TContext, TElement, TSelector, TType>;
7
5
  logger: Logger;
8
6
  };
9
- export declare function makeLocateText<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg' = 'classic' | 'ufg'>({ eyes, logger: defaultLogger, }: Options<TDriver, TContext, 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>;
7
+ export declare function makeLocateText<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg' = 'classic'>({ eyes, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TType>): <TPattern extends string>({ target, settings, config, logger, }: {
8
+ target?: Target<TDriver, TContext, TElement, TSelector, 'classic'>;
9
+ settings: import("./automation/types").LocateTextSettings<TPattern, TElement, TSelector>;
10
+ config?: Config<TElement, TSelector, 'classic'>;
13
11
  logger?: Logger;
14
12
  }) => Promise<LocateTextResult<TPattern>>;
15
13
  export {};
package/types/locate.d.ts CHANGED
@@ -1,16 +1,15 @@
1
1
  import type { Region } from '@applitools/utils';
2
- import type { Config, LocateSettings } from './types';
2
+ import type { DriverTarget, ImageTarget, Config, LocateSettings } from './types';
3
3
  import type { Core as BaseCore } from '@applitools/core-base';
4
- import type { Screenshot } from './classic/types';
5
4
  import { type Logger } from '@applitools/logger';
6
5
  import { type SpecDriver } from '@applitools/driver';
7
- declare type Options<TDriver, TContext, TElement, TSelector> = {
6
+ type Options<TDriver, TContext, TElement, TSelector> = {
8
7
  spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
9
8
  core: BaseCore;
10
9
  logger: Logger;
11
10
  };
12
11
  export declare function makeLocate<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'>({ spec, core, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): <TLocator extends string>({ target, settings, config, logger, }: {
13
- target?: TDriver | Screenshot;
12
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector> | ImageTarget;
14
13
  settings: LocateSettings<TLocator, TElement, TSelector>;
15
14
  config?: Config<TElement, TSelector, TType>;
16
15
  logger?: Logger;
@@ -2,7 +2,7 @@ import type { EyesManager } from './types';
2
2
  import type { Core as BaseCore } from '@applitools/core-base';
3
3
  import { type Logger } from '@applitools/logger';
4
4
  import { type SpecDriver } from '@applitools/driver';
5
- declare type Options<TDriver, TContext, TElement, TSelector> = {
5
+ type Options<TDriver, TContext, TElement, TSelector> = {
6
6
  spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
7
7
  core?: BaseCore;
8
8
  concurrency?: number;
@@ -13,6 +13,7 @@ declare type Options<TDriver, TContext, TElement, TSelector> = {
13
13
  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, }?: {
14
14
  type?: TType;
15
15
  concurrency?: number;
16
+ /** @deprecated */
16
17
  legacyConcurrency?: number;
17
18
  agentId?: string;
18
19
  logger?: Logger;