@applitools/core 2.5.2 → 2.5.3-legacy

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 (190) hide show
  1. package/dist/abort.js +40 -0
  2. package/dist/automation/abort.js +47 -0
  3. package/dist/automation/close.js +52 -0
  4. package/dist/automation/extract-text.js +3 -2
  5. package/dist/automation/get-nml-client.js +36 -0
  6. package/dist/automation/get-results.js +21 -0
  7. package/dist/automation/get-viewport-size.js +3 -2
  8. package/dist/automation/locate-text.js +3 -2
  9. package/dist/automation/locate.js +3 -2
  10. package/dist/automation/set-viewport-size.js +3 -2
  11. package/dist/automation/types.js +0 -15
  12. package/dist/automation/utils/report-kobiton.js +21 -0
  13. package/dist/automation/utils/take-screenshot.js +4 -2
  14. package/dist/automation/utils/to-base-check-settings.js +69 -7
  15. package/dist/automation/utils/to-environment-key.js +31 -0
  16. package/dist/automation/utils/uniquify-environments.js +27 -0
  17. package/dist/automation/utils/wait-for-lazy-load.js +9 -8
  18. package/dist/autonomous/core.js +25 -0
  19. package/dist/autonomous/create-render-results.js +49 -0
  20. package/dist/autonomous/create-render-target.js +19 -0
  21. package/dist/autonomous/get-render-results.js +55 -0
  22. package/dist/autonomous/open-eyes.js +13 -0
  23. package/dist/autonomous/start-renders.js +67 -0
  24. package/dist/autonomous/take-snapshots.js +16 -0
  25. package/dist/autonomous/types.js +17 -0
  26. package/dist/check-and-close.js +32 -15
  27. package/dist/check.js +33 -30
  28. package/dist/classic/check-and-close.js +189 -46
  29. package/dist/classic/check.js +319 -60
  30. package/dist/classic/core.js +6 -5
  31. package/dist/classic/get-base-eyes.js +27 -7
  32. package/dist/classic/open-eyes.js +47 -57
  33. package/dist/classic/utils/extract-default-environments.js +73 -0
  34. package/dist/classic/utils/take-dom-capture.js +2 -1
  35. package/dist/classic/utils/take-screenshots.js +63 -0
  36. package/dist/cli/cli.js +99 -3
  37. package/dist/close-batch.js +8 -7
  38. package/dist/close.js +32 -4
  39. package/dist/core.js +43 -9
  40. package/dist/delete-test.js +9 -7
  41. package/dist/extract-text.js +9 -5
  42. package/dist/get-account-info.js +36 -0
  43. package/dist/get-ec-client.js +3 -2
  44. package/dist/get-eyes-results.js +29 -3
  45. package/dist/get-manager-results.js +52 -18
  46. package/dist/get-typed-eyes.js +5 -6
  47. package/dist/index.js +3 -3
  48. package/dist/lang.js +31 -0
  49. package/dist/locate-text.js +7 -5
  50. package/dist/locate.js +7 -5
  51. package/dist/make-manager.js +34 -11
  52. package/dist/offline/merge-configs.js +42 -0
  53. package/dist/offline/run-offline-snapshots.js +341 -0
  54. package/dist/open-eyes.js +192 -48
  55. package/dist/run-offline-snapshots.js +336 -0
  56. package/dist/troubleshoot/check-network.js +5 -1
  57. package/dist/troubleshoot/eyes.js +3 -3
  58. package/dist/troubleshoot/logs.js +76 -0
  59. package/dist/troubleshoot/ufg.js +23 -16
  60. package/dist/ufg/check-and-close.js +109 -174
  61. package/dist/ufg/check.js +111 -178
  62. package/dist/ufg/core.js +10 -8
  63. package/dist/ufg/create-render-target-from-snapshot.js +21 -0
  64. package/dist/ufg/get-base-eyes.js +40 -12
  65. package/dist/ufg/get-ufg-client.js +13 -4
  66. package/dist/ufg/open-eyes.js +33 -57
  67. package/dist/ufg/take-snapshots.js +92 -0
  68. package/dist/ufg/utils/extract-default-environment.js +22 -0
  69. package/dist/ufg/utils/generate-safe-selectors.js +9 -32
  70. package/dist/ufg/utils/take-dom-snapshot.js +61 -26
  71. package/dist/ufg/utils/take-dom-snapshots.js +99 -68
  72. package/dist/ufg/utils/to-generated-selectors.js +67 -0
  73. package/dist/ufg/utils/to-safe-check-settings.js +69 -0
  74. package/dist/universal/core-server.js +53 -22
  75. package/dist/universal/core.js +23 -6
  76. package/dist/universal/history.js +9 -0
  77. package/dist/universal/spec-driver.js +46 -50
  78. package/dist/{ufg/get-nml-client.js → utils/ensure-offline-folder.js} +14 -13
  79. package/dist/utils/extract-branching-timestamp.js +56 -0
  80. package/dist/utils/extract-current-commit.js +72 -0
  81. package/dist/utils/extract-git-info.js +168 -0
  82. package/dist/utils/extract-start-info.js +100 -0
  83. package/dist/utils/extract-test-environment.js +70 -0
  84. package/dist/utils/memory-usage-logging.js +46 -0
  85. package/dist/utils/populate-eyes-server-settings.js +41 -0
  86. package/dist/utils/validate-sdk-version.js +89 -0
  87. package/package.json +3 -3
  88. package/types/abort.d.ts +13 -0
  89. package/types/automation/abort.d.ts +16 -0
  90. package/types/automation/close.d.ts +14 -0
  91. package/types/automation/extract-text.d.ts +1 -1
  92. package/types/automation/get-nml-client.d.ts +16 -0
  93. package/types/automation/get-results.d.ts +11 -0
  94. package/types/automation/get-viewport-size.d.ts +1 -1
  95. package/types/automation/locate-text.d.ts +1 -1
  96. package/types/automation/locate.d.ts +1 -1
  97. package/types/automation/set-viewport-size.d.ts +1 -1
  98. package/types/automation/types.d.ts +107 -16
  99. package/types/automation/utils/report-kobiton.d.ts +12 -0
  100. package/types/automation/utils/take-screenshot.d.ts +5 -2
  101. package/types/automation/utils/to-base-check-settings.d.ts +13 -3
  102. package/types/automation/utils/to-environment-key.d.ts +2 -0
  103. package/types/automation/utils/uniquify-environments.d.ts +2 -0
  104. package/types/automation/utils/wait-for-lazy-load.d.ts +4 -8
  105. package/types/autonomous/core.d.ts +19 -0
  106. package/types/autonomous/create-render-results.d.ts +10 -0
  107. package/types/autonomous/create-render-target.d.ts +12 -0
  108. package/types/autonomous/get-render-results.d.ts +12 -0
  109. package/types/autonomous/open-eyes.d.ts +13 -0
  110. package/types/autonomous/start-renders.d.ts +12 -0
  111. package/types/autonomous/take-snapshots.d.ts +15 -0
  112. package/types/autonomous/types.d.ts +57 -0
  113. package/types/check-and-close.d.ts +3 -3
  114. package/types/check.d.ts +3 -3
  115. package/types/classic/check-and-close.d.ts +12 -5
  116. package/types/classic/check.d.ts +6 -3
  117. package/types/classic/core.d.ts +8 -2
  118. package/types/classic/get-base-eyes.d.ts +4 -8
  119. package/types/classic/open-eyes.d.ts +3 -4
  120. package/types/classic/types.d.ts +4 -5
  121. package/types/classic/utils/extract-default-environments.d.ts +9 -0
  122. package/types/classic/utils/take-dom-capture.d.ts +8 -0
  123. package/types/classic/utils/take-screenshots.d.ts +18 -0
  124. package/types/close-batch.d.ts +1 -1
  125. package/types/close.d.ts +3 -2
  126. package/types/core.d.ts +11 -2
  127. package/types/delete-test.d.ts +1 -1
  128. package/types/extract-text.d.ts +1 -1
  129. package/types/get-account-info.d.ts +11 -0
  130. package/types/get-ec-client.d.ts +1 -1
  131. package/types/get-eyes-results.d.ts +1 -1
  132. package/types/get-manager-results.d.ts +1 -1
  133. package/types/get-typed-eyes.d.ts +2 -4
  134. package/types/index.d.ts +2 -1
  135. package/types/lang.d.ts +32 -0
  136. package/types/locate-text.d.ts +1 -1
  137. package/types/locate.d.ts +1 -1
  138. package/types/make-manager.d.ts +11 -2
  139. package/types/offline/merge-configs.d.ts +1 -0
  140. package/types/offline/run-offline-snapshots.d.ts +11 -0
  141. package/types/open-eyes.d.ts +11 -2
  142. package/types/run-offline-snapshots.d.ts +6 -0
  143. package/types/troubleshoot/logs.d.ts +25 -0
  144. package/types/types.d.ts +19 -11
  145. package/types/ufg/check-and-close.d.ts +18 -10
  146. package/types/ufg/check.d.ts +5 -4
  147. package/types/ufg/core.d.ts +8 -5
  148. package/types/ufg/create-render-target-from-snapshot.d.ts +8 -0
  149. package/types/ufg/get-base-eyes.d.ts +4 -9
  150. package/types/ufg/get-ufg-client.d.ts +6 -3
  151. package/types/ufg/open-eyes.d.ts +3 -4
  152. package/types/ufg/take-snapshots.d.ts +17 -0
  153. package/types/ufg/types.d.ts +39 -39
  154. package/types/ufg/utils/extract-default-environment.d.ts +5 -0
  155. package/types/ufg/utils/generate-safe-selectors.d.ts +3 -12
  156. package/types/ufg/utils/take-dom-snapshot.d.ts +16 -21
  157. package/types/ufg/utils/take-dom-snapshots.d.ts +14 -10
  158. package/types/ufg/utils/to-generated-selectors.d.ts +34 -0
  159. package/types/ufg/utils/to-safe-check-settings.d.ts +22 -0
  160. package/types/universal/core-server.d.ts +6 -2
  161. package/types/universal/core.d.ts +6 -2
  162. package/types/universal/spec-driver.d.ts +6 -5
  163. package/types/universal/types.d.ts +59 -51
  164. package/types/utils/ensure-offline-folder.d.ts +1 -0
  165. package/types/utils/extract-branching-timestamp.d.ts +16 -0
  166. package/types/utils/extract-current-commit.d.ts +24 -0
  167. package/types/utils/extract-git-info.d.ts +59 -0
  168. package/types/utils/extract-start-info.d.ts +29 -0
  169. package/types/utils/extract-test-environment.d.ts +2 -0
  170. package/types/utils/memory-usage-logging.d.ts +7 -0
  171. package/types/utils/populate-eyes-server-settings.d.ts +2 -0
  172. package/types/utils/validate-sdk-version.d.ts +42 -0
  173. package/CHANGELOG.md +0 -222
  174. package/dist/classic/abort.js +0 -22
  175. package/dist/classic/close.js +0 -22
  176. package/dist/ufg/abort.js +0 -32
  177. package/dist/ufg/close.js +0 -37
  178. package/dist/ufg/get-results.js +0 -27
  179. package/dist/ufg/utils/take-vhses.js +0 -153
  180. package/dist/ufg/utils/uniquify-renderers.js +0 -27
  181. package/dist/utils/extract-ci-provider.js +0 -31
  182. package/types/classic/abort.d.ts +0 -16
  183. package/types/classic/close.d.ts +0 -16
  184. package/types/ufg/abort.d.ts +0 -21
  185. package/types/ufg/close.d.ts +0 -19
  186. package/types/ufg/get-nml-client.d.ts +0 -17
  187. package/types/ufg/get-results.d.ts +0 -16
  188. package/types/ufg/utils/take-vhses.d.ts +0 -17
  189. package/types/ufg/utils/uniquify-renderers.d.ts +0 -2
  190. package/types/utils/extract-ci-provider.d.ts +0 -1
@@ -7,7 +7,7 @@ type Options<TSpec extends SpecType> = {
7
7
  spec?: SpecDriver<TSpec>;
8
8
  logger: Logger;
9
9
  };
10
- export declare function makeExtractText<TSpec extends SpecType>({ core, spec, logger: defaultLogger }: Options<TSpec>): ({ target, settings, logger, }: {
10
+ export declare function makeExtractText<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): ({ target, settings, logger, }: {
11
11
  target: Target<TSpec>;
12
12
  settings: MaybeArray<ExtractTextSettings<TSpec>>;
13
13
  logger?: Logger | undefined;
@@ -0,0 +1,16 @@
1
+ import { type SpecType, type Driver } from '@applitools/driver';
2
+ import { type Logger } from '@applitools/logger';
3
+ import { type NMLClient, type NMLClientSettings } from '@applitools/nml-client';
4
+ type Options = {
5
+ client?: NMLClient;
6
+ logger: Logger;
7
+ };
8
+ export declare function makeGetNMLClient({ client, logger: mainLogger }: Options): {
9
+ getNMLClient: ({ driver, settings, logger, }: {
10
+ driver: Driver<SpecType>;
11
+ settings: Omit<NMLClientSettings, 'brokerUrl'>;
12
+ logger: Logger;
13
+ }) => Promise<NMLClient>;
14
+ clearNMLClientCache: (driver: Driver<SpecType>) => Promise<void>;
15
+ };
16
+ export {};
@@ -0,0 +1,11 @@
1
+ import type { Eyes, GetResultsSettings, TestResult } from '../ufg/types';
2
+ import { type Logger } from '@applitools/logger';
3
+ type Options = {
4
+ eyes: Eyes<any>;
5
+ logger: Logger;
6
+ };
7
+ export declare function makeGetResults({ eyes, logger: mainLogger }: Options): ({ settings, logger, }?: {
8
+ settings?: GetResultsSettings | undefined;
9
+ logger?: Logger | undefined;
10
+ }) => Promise<TestResult[]>;
11
+ export {};
@@ -5,7 +5,7 @@ type Options<TSpec extends SpecType> = {
5
5
  spec: SpecDriver<TSpec>;
6
6
  logger: Logger;
7
7
  };
8
- export declare function makeGetViewportSize<TSpec extends SpecType>({ spec, logger: defaultLogger }: Options<TSpec>): ({ target, logger, }: {
8
+ export declare function makeGetViewportSize<TSpec extends SpecType>({ spec, logger: mainLogger }: Options<TSpec>): ({ target, logger }: {
9
9
  target: DriverTarget<TSpec>;
10
10
  logger?: Logger | undefined;
11
11
  }) => Promise<import("@applitools/utils").Size>;
@@ -6,7 +6,7 @@ type Options<TSpec extends SpecType> = {
6
6
  spec?: SpecDriver<TSpec>;
7
7
  logger: Logger;
8
8
  };
9
- export declare function makeLocateText<TSpec extends SpecType>({ core, spec, logger: defaultLogger }: Options<TSpec>): <TPattern extends string>({ target, settings, logger, }: {
9
+ export declare function makeLocateText<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): <TPattern extends string>({ target, settings, logger, }: {
10
10
  target: Target<TSpec>;
11
11
  settings: LocateTextSettings<TPattern, TSpec>;
12
12
  logger?: Logger | undefined;
@@ -6,7 +6,7 @@ type Options<TSpec extends SpecType> = {
6
6
  spec?: SpecDriver<TSpec>;
7
7
  logger: Logger;
8
8
  };
9
- export declare function makeLocate<TSpec extends SpecType>({ spec, core, logger: defaultLogger }: Options<TSpec>): <TLocator extends string>({ settings, target, logger, }: {
9
+ export declare function makeLocate<TSpec extends SpecType>({ spec, core, logger: mainLogger }: Options<TSpec>): <TLocator extends string>({ settings, target, logger, }: {
10
10
  target: Target<TSpec>;
11
11
  settings: LocateSettings<TLocator, TSpec>;
12
12
  logger?: Logger | undefined;
@@ -6,7 +6,7 @@ type Options<TSpec extends SpecType> = {
6
6
  spec: SpecDriver<TSpec>;
7
7
  logger: Logger;
8
8
  };
9
- export declare function makeSetViewportSize<TSpec extends SpecType>({ spec, logger: defaultLogger }: Options<TSpec>): ({ target, size, logger, }: {
9
+ export declare function makeSetViewportSize<TSpec extends SpecType>({ spec, logger: mainLogger }: Options<TSpec>): ({ target, size, logger, }: {
10
10
  target: DriverTarget<TSpec>;
11
11
  size: Size;
12
12
  logger?: Logger | undefined;
@@ -1,11 +1,52 @@
1
- import type { MaybeArray, Size, Region } from '@applitools/utils';
1
+ import type { MaybeArray, Size, Region, ControlledPromise } from '@applitools/utils';
2
2
  import type * as BaseCore from '@applitools/core-base/types';
3
3
  import { type SpecType, type Driver, type ElementReference, type ContextReference } from '@applitools/driver';
4
+ import { type NMLClient, type NMLClientSettings } from '@applitools/nml-client';
4
5
  import { type Logger } from '@applitools/logger';
5
- export * from '@applitools/core-base/types';
6
+ export type * from '@applitools/core-base/types';
6
7
  export type DriverTarget<TSpec extends SpecType> = TSpec['driver'] | Driver<TSpec>;
7
8
  export type Target<TSpec extends SpecType> = DriverTarget<TSpec> | BaseCore.Target;
8
- export interface Core<TSpec extends SpecType> extends BaseCore.Core {
9
+ export interface DesktopBrowserEnvironment {
10
+ name?: string;
11
+ width: number;
12
+ height: number;
13
+ }
14
+ export interface ChromeEmulationDeviceEnvironment {
15
+ chromeEmulationInfo: {
16
+ deviceName: string;
17
+ screenOrientation?: string;
18
+ };
19
+ }
20
+ export interface IOSDeviceEnvironment {
21
+ iosDeviceInfo: {
22
+ deviceName: string;
23
+ version?: string;
24
+ screenOrientation?: string;
25
+ };
26
+ }
27
+ export interface AndroidDeviceEnvironment {
28
+ androidDeviceInfo: {
29
+ deviceName: string;
30
+ version?: string;
31
+ screenOrientation?: string;
32
+ };
33
+ }
34
+ export type RenderEnvironment = (DesktopBrowserEnvironment | ChromeEmulationDeviceEnvironment | IOSDeviceEnvironment | AndroidDeviceEnvironment) & {
35
+ environmentId?: string;
36
+ os?: string;
37
+ displayOs?: string;
38
+ hostingApp?: string;
39
+ displayHostingApp?: string;
40
+ properties?: BaseCore.CustomProperty[];
41
+ fallbackBaselineId?: string;
42
+ };
43
+ export type ExactEnvironment = BaseCore.Environment & {
44
+ environmentId?: string;
45
+ requested?: RenderEnvironment;
46
+ fallbackBaselineId?: string;
47
+ };
48
+ export type Environment = RenderEnvironment | ExactEnvironment;
49
+ export interface Core<TSpec extends SpecType> extends Omit<BaseCore.Core, 'openEyes'> {
9
50
  readonly base: BaseCore.Core;
10
51
  getViewportSize?(options: {
11
52
  target: DriverTarget<TSpec>;
@@ -16,10 +57,16 @@ export interface Core<TSpec extends SpecType> extends BaseCore.Core {
16
57
  size: Size;
17
58
  logger?: Logger;
18
59
  }): Promise<void>;
60
+ getNMLClient(options: {
61
+ settings: Omit<NMLClientSettings, 'brokerUrl'>;
62
+ driver: Driver<TSpec>;
63
+ logger: Logger;
64
+ }): Promise<NMLClient>;
65
+ clearNMLClientCache(driver: Driver<TSpec>): Promise<void>;
19
66
  openEyes(options: {
20
67
  target?: DriverTarget<TSpec>;
21
68
  settings: BaseCore.OpenSettings;
22
- base?: BaseCore.Eyes[];
69
+ storage?: EyesStorage;
23
70
  logger?: Logger;
24
71
  }): Promise<Eyes<TSpec>>;
25
72
  locate<TLocator extends string>(options: {
@@ -38,23 +85,54 @@ export interface Core<TSpec extends SpecType> extends BaseCore.Core {
38
85
  logger?: Logger;
39
86
  }): Promise<string[]>;
40
87
  }
41
- export interface Eyes<TSpec extends SpecType> extends BaseCore.Eyes {
88
+ export interface Eyes<TSpec extends SpecType> extends Omit<BaseCore.Eyes, 'core' | 'check' | 'checkAndClose'> {
42
89
  readonly core: Core<TSpec>;
43
- getBaseEyes(options?: {
90
+ readonly storage: EyesStorage;
91
+ getBaseEyes(options: {
92
+ settings: GetBaseEyesSettings<TSpec>;
44
93
  logger?: Logger;
45
- }): Promise<BaseCore.Eyes[]>;
94
+ }): Promise<BaseCore.Eyes>;
46
95
  check(options?: {
47
96
  target?: Target<TSpec>;
48
97
  settings?: CheckSettings<TSpec>;
49
98
  logger?: Logger;
50
- }): Promise<BaseCore.CheckResult[]>;
99
+ }): Promise<void>;
51
100
  checkAndClose(options?: {
52
101
  target?: Target<TSpec>;
53
102
  settings?: CheckSettings<TSpec> & BaseCore.CloseSettings;
54
103
  logger?: Logger;
55
- }): Promise<BaseCore.TestResult[]>;
104
+ }): Promise<void>;
105
+ close(options?: {
106
+ settings?: CloseSettings;
107
+ logger?: Logger;
108
+ }): Promise<void>;
109
+ abort(options?: {
110
+ settings?: AbortSettings;
111
+ logger?: Logger;
112
+ }): Promise<void>;
113
+ getResults(options?: {
114
+ settings?: BaseCore.GetResultsSettings;
115
+ logger?: Logger;
116
+ }): Promise<TestResult[]>;
56
117
  }
118
+ export type EyesStorage = Map<string, {
119
+ eyes: ControlledPromise<BaseCore.Eyes>;
120
+ jobs: Promise<void>[];
121
+ }>;
122
+ export interface GetBaseEyesSettings<TSpec extends SpecType> {
123
+ environment: Environment;
124
+ driver?: Driver<TSpec>;
125
+ }
126
+ export type LazyLoadOptions = {
127
+ scrollLength?: number;
128
+ waitingTime?: number;
129
+ maxAmountToScroll?: number;
130
+ };
131
+ export type MobileOptions = {
132
+ keepNavigationBar?: boolean;
133
+ };
57
134
  export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.ImageSettings<Region | ElementReference<TSpec>> {
135
+ webview?: boolean | string;
58
136
  frames?: (ContextReference<TSpec> | {
59
137
  frame: ContextReference<TSpec>;
60
138
  scrollRootElement?: ElementReference<TSpec>;
@@ -62,6 +140,7 @@ export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.Ima
62
140
  fully?: boolean;
63
141
  scrollRootElement?: ElementReference<TSpec>;
64
142
  stitchMode?: 'Scroll' | 'CSS' | 'Resize';
143
+ screenshotMode?: 'default' | 'applitools-lib';
65
144
  hideScrollbars?: boolean;
66
145
  hideCaret?: boolean;
67
146
  overlap?: {
@@ -70,14 +149,26 @@ export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.Ima
70
149
  };
71
150
  waitBeforeCapture?: number;
72
151
  waitBetweenStitches?: number;
73
- lazyLoad?: boolean | {
74
- scrollLength?: number;
75
- waitingTime?: number;
76
- maxAmountToScroll?: number;
77
- };
78
- webview?: boolean | string;
152
+ lazyLoad?: boolean | LazyLoadOptions;
153
+ sendDom?: boolean;
154
+ captureStatusBar?: boolean;
155
+ mobileOptions?: MobileOptions;
79
156
  }
80
157
  export type LocateSettings<TLocator extends string, TSpec extends SpecType> = BaseCore.LocateSettings<TLocator, Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;
81
158
  export type LocateTextSettings<TPattern extends string, TSpec extends SpecType> = BaseCore.LocateTextSettings<TPattern, Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;
82
159
  export type ExtractTextSettings<TSpec extends SpecType> = BaseCore.ExtractTextSettings<Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;
83
- export type CheckSettings<TSpec extends SpecType> = BaseCore.CheckSettings<Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;
160
+ export type CheckSettings<TSpec extends SpecType> = BaseCore.CheckSettings<Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec> & {
161
+ environments?: Environment[];
162
+ };
163
+ export type CloseSettings = BaseCore.CloseSettings & {
164
+ environments?: Environment[];
165
+ };
166
+ export type AbortSettings = BaseCore.AbortSettings & {
167
+ environments?: Environment[];
168
+ };
169
+ export type TestResult = BaseCore.TestResult & {
170
+ readonly environment: ExactEnvironment;
171
+ };
172
+ export type OpenSettings = BaseCore.OpenSettings & {
173
+ disableBrokerUrlCache?: boolean;
174
+ };
@@ -0,0 +1,12 @@
1
+ import type { Driver, SpecType } from '@applitools/driver';
2
+ import type { Logger } from '@applitools/logger';
3
+ type Options<TSpec extends SpecType> = {
4
+ driver?: Driver<TSpec>;
5
+ settings: {
6
+ batchId: string;
7
+ resultsUrl: string;
8
+ };
9
+ logger: Logger;
10
+ };
11
+ export declare function reportKobiton<TSpec extends SpecType>({ driver, settings, logger }: Options<TSpec>): Promise<void>;
12
+ export {};
@@ -1,14 +1,17 @@
1
1
  import type { Region } from '@applitools/utils';
2
2
  import type { ScreenshotSettings } from '../../classic/types';
3
3
  import { type Logger } from '@applitools/logger';
4
- import { type Driver, type Element, type ElementReference, type SpecType } from '@applitools/driver';
4
+ import { type Driver, type Element, type ElementReference, type Selector, type SpecType } from '@applitools/driver';
5
5
  export type Screenshot<TSpec extends SpecType> = {
6
6
  image: any;
7
7
  region: Region;
8
8
  element: Element<TSpec>;
9
9
  scrollingElement: Element<TSpec>;
10
10
  restoreState(): Promise<void>;
11
- calculatedRegions: [];
11
+ calculatedRegions: {
12
+ selector?: Selector;
13
+ regions: Region[];
14
+ }[];
12
15
  };
13
16
  export declare function takeScreenshot<TSpec extends SpecType>({ driver, settings, logger, }: {
14
17
  driver: Driver<TSpec>;
@@ -1,12 +1,22 @@
1
1
  import type { Region } from '@applitools/utils';
2
2
  import type { CheckSettings } from '../types';
3
3
  import type { CheckSettings as BaseCheckSettings } from '@applitools/core-base';
4
- import { type SpecType, type ElementReference, type Selector } from '@applitools/driver';
4
+ import type { SpecType, ElementReference, Selector, Driver } from '@applitools/driver';
5
+ import { Logger } from '@applitools/logger';
6
+ export declare function hasCodedRegions<TSpec extends SpecType>(settings: CheckSettings<TSpec>): boolean;
7
+ export declare function extractMobileElementsIntoCheckSettings<TSpec extends SpecType>({ settings, driver, logger, }: {
8
+ settings: CheckSettings<TSpec>;
9
+ driver: Driver<TSpec>;
10
+ logger: Logger;
11
+ }): Promise<any>;
5
12
  export declare function toBaseCheckSettings<TSpec extends SpecType>({ settings }: {
6
13
  settings: CheckSettings<TSpec>;
7
14
  }): {
8
- elementReferencesToCalculate: ElementReference<TSpec>[];
9
- elementReferenceToTarget: ElementReference<TSpec> | undefined;
15
+ elementReferences: {
16
+ target: ElementReference<TSpec> | undefined;
17
+ scrolling: ElementReference<TSpec> | undefined;
18
+ calculate: ElementReference<TSpec>[];
19
+ };
10
20
  getBaseCheckSettings: ({ calculatedRegions, preserveTransformation, }: {
11
21
  calculatedRegions: {
12
22
  selector?: Selector;
@@ -0,0 +1,2 @@
1
+ import type { Environment } from '../types';
2
+ export declare function toEnvironmentKey(environment: Environment): string;
@@ -0,0 +1,2 @@
1
+ import type { Environment } from '../types';
2
+ export declare function uniquifyEnvironments<TEnvironment extends Environment>(environments: TEnvironment[]): TEnvironment[];
@@ -1,14 +1,10 @@
1
1
  import { type Logger } from '@applitools/logger';
2
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
- };
3
+ import { type LazyLoadOptions } from '../types';
10
4
  export declare function waitForLazyLoad<TSpec extends SpecType>({ context, settings, logger, }: {
11
5
  context: Context<TSpec>;
12
- settings: LazyLoadSettings;
6
+ settings?: LazyLoadOptions & {
7
+ pollTimeout?: number;
8
+ };
13
9
  logger: Logger;
14
10
  }): Promise<void>;
@@ -0,0 +1,19 @@
1
+ import type { AutonomousCore } from './types';
2
+ import { type AsyncCache, type UFGClient } from '@applitools/ufg-client';
3
+ import { type NMLClient } from '@applitools/nml-client';
4
+ import { type SpecType, type SpecDriver } from '@applitools/driver';
5
+ import { type Logger } from '@applitools/logger';
6
+ import { type Core as BaseCore } from '@applitools/core-base';
7
+ type Options<TSpec extends SpecType> = {
8
+ spec?: SpecDriver<TSpec>;
9
+ clients?: {
10
+ ufg?: UFGClient;
11
+ nml?: NMLClient;
12
+ };
13
+ base?: BaseCore;
14
+ asyncCache?: AsyncCache;
15
+ agentId?: string;
16
+ logger?: Logger;
17
+ };
18
+ export declare function makeAutonomousCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, asyncCache, agentId, logger: defaultLogger, }?: Options<TSpec>): AutonomousCore<TSpec>;
19
+ export {};
@@ -0,0 +1,10 @@
1
+ import type { StartedRender, RenderResult } from './types';
2
+ import { type Logger } from '@applitools/logger';
3
+ type Options = {
4
+ logger: Logger;
5
+ };
6
+ export declare function makeCreateRenderResults({ logger }: Options): ({ renders, rawResults, }: {
7
+ renders: StartedRender[];
8
+ rawResults: any[];
9
+ }) => Promise<RenderResult[]>;
10
+ export {};
@@ -0,0 +1,12 @@
1
+ import type { Core as UFGCore } from '../ufg/types';
2
+ import type { Snapshot, RenderTargetWithSettings } from './types';
3
+ import { type Logger } from '@applitools/logger';
4
+ type Options = {
5
+ core: UFGCore<any>;
6
+ logger: Logger;
7
+ };
8
+ export declare function makeCreateRenderTarget({ core, logger: defaultLogger }: Options): ({ snapshot, logger, }: {
9
+ snapshot: Snapshot;
10
+ logger: Logger;
11
+ }) => Promise<RenderTargetWithSettings>;
12
+ export {};
@@ -0,0 +1,12 @@
1
+ import type { Core as UFGCore } from '../ufg/types';
2
+ import type { StartedRender, RenderResult } from './types';
3
+ import { type Logger } from '@applitools/logger';
4
+ type Options = {
5
+ core: UFGCore<any>;
6
+ logger: Logger;
7
+ };
8
+ export declare function makeGetRenderResults({ core, logger: defaultLogger }: Options): ({ renders, logger, }: {
9
+ renders: StartedRender[];
10
+ logger: Logger;
11
+ }) => Promise<RenderResult[]>;
12
+ export {};
@@ -0,0 +1,13 @@
1
+ import type { Core as UFGCore } from '../ufg/types';
2
+ import type { OpenSettings } from './types';
3
+ import type { Eyes as BaseEyes } from '@applitools/core-base/types';
4
+ import { type Logger } from '@applitools/logger';
5
+ type Options = {
6
+ core: UFGCore<any>;
7
+ logger: Logger;
8
+ };
9
+ export declare function makeOpenEyes({ core, logger: defaultLogger }: Options): ({ settings, logger, }: {
10
+ settings: OpenSettings;
11
+ logger: Logger;
12
+ }) => Promise<BaseEyes>;
13
+ export {};
@@ -0,0 +1,12 @@
1
+ import type { Core as UFGCore } from '../ufg/types';
2
+ import type { RenderTargetWithSettings, StartedRender } from './types';
3
+ import { type Logger } from '@applitools/logger';
4
+ type Options = {
5
+ core: UFGCore<any>;
6
+ logger: Logger;
7
+ };
8
+ export declare function makeStartRenders({ core, logger: defaultLogger }: Options): ({ targets, logger, }: {
9
+ targets: RenderTargetWithSettings[];
10
+ logger: Logger;
11
+ }) => Promise<StartedRender[]>;
12
+ export {};
@@ -0,0 +1,15 @@
1
+ import type { Core as UFGCore } from '../ufg/types';
2
+ import type { DriverTarget, SnapshotSettings, Snapshot } from './types';
3
+ import { type Logger } from '@applitools/logger';
4
+ import { type SpecDriver, type SpecType } from '@applitools/driver';
5
+ type Options<TSpec extends SpecType> = {
6
+ core: UFGCore<TSpec>;
7
+ spec: SpecDriver<TSpec>;
8
+ logger: Logger;
9
+ };
10
+ export declare function makeTakeSnapshots<TSpec extends SpecType>({ core, spec, logger: defaultLogger }: Options<TSpec>): ({ target, settings, logger, }: {
11
+ target: DriverTarget<TSpec>;
12
+ settings: SnapshotSettings<TSpec>;
13
+ logger?: Logger | undefined;
14
+ }) => Promise<Snapshot[]>;
15
+ export {};
@@ -0,0 +1,57 @@
1
+ import type { Eyes as BaseEyes, ImageTarget as BaseImageTarget, OpenSettings as BaseOpenSettings, CheckSettings as BaseCheckSettings } from '@applitools/core-base/types';
2
+ import type * as UFGCore from '../ufg/types';
3
+ import { type Logger } from '@applitools/logger';
4
+ import { type SpecType } from '@applitools/driver';
5
+ import { type RenderTarget, type StartedRender as UFGStartedRender } from '@applitools/ufg-client';
6
+ export * from '../ufg/types';
7
+ export interface AutonomousCore<TSpec extends SpecType> {
8
+ readonly type: 'autonomous';
9
+ takeSnapshots?(options: {
10
+ target: UFGCore.DriverTarget<TSpec>;
11
+ settings?: Partial<SnapshotSettings<TSpec>>;
12
+ logger?: Logger;
13
+ }): Promise<UFGCore.Snapshot[]>;
14
+ createRenderTarget(options: {
15
+ snapshot: UFGCore.Snapshot;
16
+ logger?: Logger;
17
+ }): Promise<RenderTargetWithSettings>;
18
+ startRenders(options: {
19
+ targets: RenderTargetWithSettings[];
20
+ logger?: Logger;
21
+ }): Promise<StartedRender[]>;
22
+ getRenderResults(options: {
23
+ renders: StartedRender[];
24
+ logger?: Logger;
25
+ }): Promise<RenderResult[]>;
26
+ createRenderResults(options: {
27
+ renders: StartedRender[];
28
+ rawResults: any[];
29
+ logger?: Logger;
30
+ }): Promise<RenderResult[]>;
31
+ openEyes(options: {
32
+ settings: Partial<OpenSettings>;
33
+ logger?: Logger;
34
+ }): Promise<BaseEyes>;
35
+ }
36
+ export type SnapshotSettings<TSpec extends SpecType> = UFGCore.SnapshotSettings<TSpec> & UFGCore.EyesServerSettings;
37
+ export type RenderTargetWithSettings = {
38
+ target: RenderTarget;
39
+ settings: UFGCore.SafeCheckSettings;
40
+ environment: UFGCore.RenderEnvironment;
41
+ account: UFGCore.Account;
42
+ };
43
+ export type StartedRender = {
44
+ render: UFGStartedRender;
45
+ settings: UFGCore.SafeCheckSettings;
46
+ environment: UFGCore.ExactEnvironment;
47
+ account: UFGCore.Account;
48
+ };
49
+ export type RenderResult = {
50
+ status: 'rendering' | 'rendered' | 'error';
51
+ error: string;
52
+ target: BaseImageTarget;
53
+ settings: BaseCheckSettings;
54
+ environment: UFGCore.ExactEnvironment;
55
+ account: UFGCore.Account;
56
+ };
57
+ export type OpenSettings = BaseOpenSettings;
@@ -1,4 +1,4 @@
1
- import type { Target, DriverTarget, Eyes, Config, CheckSettings, CloseSettings, TestResult } from './types';
1
+ import type { Target, DriverTarget, Eyes, Config, CheckSettings, CloseSettings } from './types';
2
2
  import { type Logger } from '@applitools/logger';
3
3
  import { type SpecType, type SpecDriver } from '@applitools/driver';
4
4
  type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
@@ -8,11 +8,11 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
8
8
  spec?: SpecDriver<TSpec>;
9
9
  logger: Logger;
10
10
  };
11
- export declare function makeCheckAndClose<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, target, settings, config, logger, }?: {
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
12
  type?: TType | undefined;
13
13
  target?: Target<TSpec, TType> | undefined;
14
14
  settings?: (CheckSettings<TSpec, TDefaultType> & CloseSettings<TDefaultType> & CheckSettings<TSpec, TType> & CloseSettings<TType>) | undefined;
15
15
  config?: (Config<TSpec, TDefaultType> & Config<TSpec, TType>) | undefined;
16
16
  logger?: Logger | undefined;
17
- }) => Promise<TestResult<TType>[]>;
17
+ }) => Promise<void>;
18
18
  export {};
package/types/check.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import type { Target, DriverTarget, Eyes, Config, CheckSettings, CheckResult } from './types';
1
+ import type { Target, DriverTarget, Eyes, Config, CheckSettings } from './types';
2
2
  import { type Logger } from '@applitools/logger';
3
3
  import { type SpecType, type SpecDriver } from '@applitools/driver';
4
4
  type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
@@ -8,11 +8,11 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
8
8
  spec?: SpecDriver<TSpec>;
9
9
  logger: Logger;
10
10
  };
11
- export declare function makeCheck<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, target, settings, config, logger, }?: {
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
12
  type?: TType | undefined;
13
13
  target?: Target<TSpec, TType> | undefined;
14
14
  settings?: CheckSettings<TSpec, TType> | undefined;
15
15
  config?: Config<TSpec, TType> | undefined;
16
16
  logger?: Logger | undefined;
17
- }) => Promise<CheckResult<TType>[]>;
17
+ }) => Promise<void>;
18
18
  export {};
@@ -1,19 +1,26 @@
1
- import type { Target, DriverTarget, Eyes, CheckSettings, CloseSettings, TestResult } from './types';
2
- import type { CheckSettings as BaseCheckSettings } from '@applitools/core-base';
1
+ import type { Target, DriverTarget, Eyes, CheckSettings, CloseSettings, Environment } from './types';
2
+ import type { CheckSettings as BaseCheckSettings, CloseSettings as BaseCloseSettings } from '@applitools/core-base';
3
+ import { type AbortSignal } from 'abort-controller';
3
4
  import { type Logger } from '@applitools/logger';
4
5
  import { type SpecType, type SpecDriver } from '@applitools/driver';
5
6
  import * as utils from '@applitools/utils';
6
7
  type Options<TSpec extends SpecType> = {
7
8
  eyes: Eyes<TSpec>;
8
9
  target?: DriverTarget<TSpec>;
10
+ environments?: Environment[];
9
11
  spec?: SpecDriver<TSpec>;
12
+ signal?: AbortSignal;
10
13
  logger: Logger;
11
14
  };
12
- export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
15
+ export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
13
16
  target?: Target<TSpec> | undefined;
14
17
  settings?: (BaseCheckSettings<utils.Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
18
+ environments?: Environment[] | undefined;
19
+ } & {
15
20
  retryTimeout?: number | undefined;
16
- } & CloseSettings) | undefined;
21
+ } & BaseCloseSettings & {
22
+ environments?: Environment[] | undefined;
23
+ }) | undefined;
17
24
  logger?: Logger | undefined;
18
- }) => Promise<TestResult[]>;
25
+ }) => Promise<void>;
19
26
  export {};
@@ -1,15 +1,18 @@
1
- import type { Target, DriverTarget, Eyes, CheckSettings, CheckResult } from './types';
1
+ import type { Target, DriverTarget, Eyes, CheckSettings, Environment } from './types';
2
+ import { type AbortSignal } from 'abort-controller';
2
3
  import { type Logger } from '@applitools/logger';
3
4
  import { type SpecType, type SpecDriver } from '@applitools/driver';
4
5
  type Options<TSpec extends SpecType> = {
5
6
  eyes: Eyes<TSpec>;
6
7
  target?: DriverTarget<TSpec>;
8
+ environments?: Environment[];
7
9
  spec?: SpecDriver<TSpec>;
10
+ signal?: AbortSignal;
8
11
  logger: Logger;
9
12
  };
10
- export declare function makeCheck<TSpec extends SpecType>({ eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
13
+ export declare function makeCheck<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
11
14
  target?: Target<TSpec> | undefined;
12
15
  settings?: CheckSettings<TSpec> | undefined;
13
16
  logger?: Logger | undefined;
14
- }) => Promise<CheckResult[]>;
17
+ }) => Promise<void>;
15
18
  export {};
@@ -1,13 +1,19 @@
1
1
  import type { Core } from './types';
2
+ import { type NMLClient } from '@applitools/nml-client';
2
3
  import { type SpecType, type SpecDriver } from '@applitools/driver';
3
4
  import { type Logger } from '@applitools/logger';
4
5
  import { type Core as BaseCore } from '@applitools/core-base';
5
6
  type Options<TSpec extends SpecType> = {
6
7
  spec?: SpecDriver<TSpec>;
8
+ clients?: {
9
+ nml?: NMLClient;
10
+ };
7
11
  base?: BaseCore;
12
+ concurrency?: number;
8
13
  agentId?: string;
9
- cwd?: string;
10
14
  logger?: Logger;
15
+ offlineLocationPath?: string;
16
+ maskLog?: boolean;
11
17
  };
12
- export declare function makeCore<TSpec extends SpecType>({ spec, base, agentId, cwd, logger: defaultLogger, }: Options<TSpec>): Core<TSpec>;
18
+ export declare function makeCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, concurrency, agentId, logger: defaultLogger, maskLog, offlineLocationPath, }: Options<TSpec>): Core<TSpec>;
13
19
  export {};