@applitools/core 4.23.1 → 4.24.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 (41) hide show
  1. package/CHANGELOG.md +34 -0
  2. package/dist/automation/utils/take-screenshot.js +2 -1
  3. package/dist/check.js +9 -6
  4. package/package.json +9 -9
  5. package/types/abort.d.ts +2 -2
  6. package/types/automation/abort.d.ts +2 -2
  7. package/types/automation/close.d.ts +2 -2
  8. package/types/automation/extract-text.d.ts +1 -1
  9. package/types/automation/get-results.d.ts +2 -2
  10. package/types/automation/get-viewport-size.d.ts +1 -1
  11. package/types/automation/locate-text.d.ts +1 -1
  12. package/types/automation/locate.d.ts +1 -1
  13. package/types/automation/set-viewport-size.d.ts +1 -1
  14. package/types/automation/types.d.ts +4 -0
  15. package/types/automation/utils/to-base-check-settings.d.ts +1 -1
  16. package/types/autonomous/take-snapshots.d.ts +1 -1
  17. package/types/check-and-close.d.ts +5 -5
  18. package/types/check.d.ts +5 -5
  19. package/types/classic/check-and-close.d.ts +11 -3
  20. package/types/classic/check.d.ts +3 -3
  21. package/types/classic/get-base-eyes.d.ts +1 -1
  22. package/types/classic/open-eyes.d.ts +3 -3
  23. package/types/close-batch.d.ts +1 -1
  24. package/types/close.d.ts +3 -3
  25. package/types/delete-test.d.ts +1 -1
  26. package/types/extract-text.d.ts +2 -2
  27. package/types/get-account-info.d.ts +1 -1
  28. package/types/get-ec-client.d.ts +2 -2
  29. package/types/get-eyes-results.d.ts +2 -2
  30. package/types/get-manager-results.d.ts +2 -2
  31. package/types/get-typed-eyes.d.ts +2 -2
  32. package/types/locate-text.d.ts +2 -2
  33. package/types/locate.d.ts +2 -2
  34. package/types/make-manager.d.ts +3 -3
  35. package/types/open-eyes.d.ts +5 -5
  36. package/types/ufg/check-and-close.d.ts +24 -3
  37. package/types/ufg/check.d.ts +3 -3
  38. package/types/ufg/get-base-eyes.d.ts +1 -1
  39. package/types/ufg/get-ufg-client.d.ts +1 -1
  40. package/types/ufg/open-eyes.d.ts +3 -3
  41. package/types/ufg/take-snapshots.d.ts +2 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,39 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.24.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.23.1...js/core@4.24.0) (2024-11-12)
4
+
5
+
6
+ ### Features
7
+
8
+ * add an option to keep the navigation bar for android devices ([#2608](https://github.com/Applitools-Dev/sdk/issues/2608)) ([e7647e0](https://github.com/Applitools-Dev/sdk/commit/e7647e0105a7aa47e6bf3b20ab033f1e389ca849))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * @applitools/driver bumped to 1.20.0
14
+ #### Features
15
+
16
+ * add an option to keep the navigation bar for android devices ([#2608](https://github.com/Applitools-Dev/sdk/issues/2608)) ([e7647e0](https://github.com/Applitools-Dev/sdk/commit/e7647e0105a7aa47e6bf3b20ab033f1e389ca849))
17
+ * @applitools/screenshoter bumped to 3.10.0
18
+ #### Features
19
+
20
+ * add an option to keep the navigation bar for android devices ([#2608](https://github.com/Applitools-Dev/sdk/issues/2608)) ([e7647e0](https://github.com/Applitools-Dev/sdk/commit/e7647e0105a7aa47e6bf3b20ab033f1e389ca849))
21
+
22
+
23
+
24
+ * @applitools/dom-snapshot bumped to 4.11.9
25
+
26
+ * @applitools/spec-driver-webdriver bumped to 1.1.20
27
+
28
+ * @applitools/spec-driver-selenium bumped to 1.5.91
29
+
30
+ * @applitools/spec-driver-puppeteer bumped to 1.4.20
31
+
32
+ * @applitools/nml-client bumped to 1.8.18
33
+
34
+ * @applitools/ec-client bumped to 1.9.14
35
+
36
+
3
37
  ## [4.23.1](https://github.com/Applitools-Dev/sdk/compare/js/core@4.23.0...js/core@4.23.1) (2024-11-09)
4
38
 
5
39
 
@@ -27,7 +27,7 @@ exports.takeScreenshot = void 0;
27
27
  const utils = __importStar(require("@applitools/utils"));
28
28
  const { takeScreenshot: legacyTakeScreenshot } = require('@applitools/screenshoter');
29
29
  async function takeScreenshot({ driver, settings, logger, }) {
30
- var _a, _b, _c;
30
+ var _a, _b, _c, _d;
31
31
  const environment = await driver.getEnvironment();
32
32
  return legacyTakeScreenshot({
33
33
  driver,
@@ -55,6 +55,7 @@ async function takeScreenshot({ driver, settings, logger, }) {
55
55
  logger,
56
56
  regionsToCalculate: settings.regionsToCalculate,
57
57
  captureStatusBar: settings.captureStatusBar,
58
+ keepNavigationBar: (_d = settings.mobileOptions) === null || _d === void 0 ? void 0 : _d.keepNavigationBar,
58
59
  });
59
60
  }
60
61
  exports.takeScreenshot = takeScreenshot;
package/dist/check.js CHANGED
@@ -34,8 +34,8 @@ const chalk_1 = __importDefault(require("chalk"));
34
34
  function makeCheck({ type: defaultType = 'classic', eyes, target: defaultTarget, spec, logger: mainLogger, }) {
35
35
  let stepIndex = 0;
36
36
  return async function check({ type = defaultType, target = defaultTarget, settings, config, logger = mainLogger, } = {}) {
37
- var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
38
- var _q, _r, _s, _t;
37
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
38
+ var _r, _s, _t, _u, _v;
39
39
  logger = logger.extend(mainLogger, { tags: [`check-${type}-${utils.general.shortid()}`] });
40
40
  settings = { ...config === null || config === void 0 ? void 0 : config.screenshot, ...config === null || config === void 0 ? void 0 : config.check, ...settings };
41
41
  (_a = settings.fully) !== null && _a !== void 0 ? _a : (settings.fully = !settings.region && (!settings.frames || settings.frames.length === 0));
@@ -54,15 +54,18 @@ function makeCheck({ type: defaultType = 'classic', eyes, target: defaultTarget,
54
54
  !utils.types.isEmpty(settings.layoutRegions));
55
55
  (_h = settings.autProxy) !== null && _h !== void 0 ? _h : (settings.autProxy = eyes.test.eyesServer.proxy);
56
56
  (_j = settings.useDom) !== null && _j !== void 0 ? _j : (settings.useDom = false);
57
- (_k = (_q = settings).retryTimeout) !== null && _k !== void 0 ? _k : (_q.retryTimeout = 0);
57
+ (_k = (_r = settings).retryTimeout) !== null && _k !== void 0 ? _k : (_r.retryTimeout = 0);
58
58
  settings.lazyLoad = settings.lazyLoad === true ? {} : settings.lazyLoad;
59
59
  if (settings.lazyLoad) {
60
- (_l = (_r = settings.lazyLoad).scrollLength) !== null && _l !== void 0 ? _l : (_r.scrollLength = 300);
61
- (_m = (_s = settings.lazyLoad).waitingTime) !== null && _m !== void 0 ? _m : (_s.waitingTime = 2000);
62
- (_o = (_t = settings.lazyLoad).maxAmountToScroll) !== null && _o !== void 0 ? _o : (_t.maxAmountToScroll = 15000);
60
+ (_l = (_s = settings.lazyLoad).scrollLength) !== null && _l !== void 0 ? _l : (_s.scrollLength = 300);
61
+ (_m = (_t = settings.lazyLoad).waitingTime) !== null && _m !== void 0 ? _m : (_t.waitingTime = 2000);
62
+ (_o = (_u = settings.lazyLoad).maxAmountToScroll) !== null && _o !== void 0 ? _o : (_u.maxAmountToScroll = 15000);
63
63
  }
64
64
  settings.stepIndex = stepIndex++;
65
65
  (_p = settings.waitBetweenStitches) !== null && _p !== void 0 ? _p : (settings.waitBetweenStitches = utils.types.isObject(settings.lazyLoad) ? settings.lazyLoad.waitingTime : 100);
66
+ if (settings.mobileOptions) {
67
+ (_q = (_v = settings.mobileOptions).keepNavigationBar) !== null && _q !== void 0 ? _q : (_v.keepNavigationBar = false);
68
+ }
66
69
  if (settings.matchLevel === 'Content') {
67
70
  logger.console.log(chalk_1.default.yellow(lang.matchLevelContentDeprecatedWarning));
68
71
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/core",
3
- "version": "4.23.1",
3
+ "version": "4.24.0",
4
4
  "homepage": "https://applitools.com",
5
5
  "bugs": {
6
6
  "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -76,16 +76,16 @@
76
76
  "dependencies": {
77
77
  "@applitools/core-base": "1.19.2",
78
78
  "@applitools/dom-capture": "11.5.1",
79
- "@applitools/dom-snapshot": "4.11.8",
80
- "@applitools/driver": "1.19.7",
81
- "@applitools/ec-client": "1.9.13",
79
+ "@applitools/dom-snapshot": "4.11.9",
80
+ "@applitools/driver": "1.20.0",
81
+ "@applitools/ec-client": "1.9.14",
82
82
  "@applitools/logger": "2.0.19",
83
- "@applitools/nml-client": "1.8.17",
83
+ "@applitools/nml-client": "1.8.18",
84
84
  "@applitools/req": "1.7.3",
85
- "@applitools/screenshoter": "3.9.5",
85
+ "@applitools/screenshoter": "3.10.0",
86
86
  "@applitools/snippets": "2.6.2",
87
87
  "@applitools/socket": "1.1.19",
88
- "@applitools/spec-driver-webdriver": "1.1.19",
88
+ "@applitools/spec-driver-webdriver": "1.1.20",
89
89
  "@applitools/ufg-client": "1.14.0",
90
90
  "@applitools/utils": "1.7.5",
91
91
  "@types/ws": "8.5.5",
@@ -100,8 +100,8 @@
100
100
  "devDependencies": {
101
101
  "@applitools/bongo": "^5.10.0",
102
102
  "@applitools/sea": "^1.0.0",
103
- "@applitools/spec-driver-puppeteer": "^1.4.19",
104
- "@applitools/spec-driver-selenium": "^1.5.90",
103
+ "@applitools/spec-driver-puppeteer": "^1.4.20",
104
+ "@applitools/spec-driver-selenium": "^1.5.91",
105
105
  "@applitools/test-server": "^1.2.2",
106
106
  "@applitools/test-utils": "^1.5.17",
107
107
  "@applitools/tunnel-client": "^1.5.9",
package/types/abort.d.ts CHANGED
@@ -7,7 +7,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
7
7
  logger: Logger;
8
8
  };
9
9
  export declare function makeAbort<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ eyes, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec, TType>): ({ settings, logger, }?: {
10
- settings?: AbortSettings<TType>;
11
- logger?: Logger;
10
+ settings?: AbortSettings<TType> | undefined;
11
+ logger?: Logger | undefined;
12
12
  }) => Promise<void>;
13
13
  export {};
@@ -10,7 +10,7 @@ type Options<TSpec extends SpecType> = {
10
10
  logger: Logger;
11
11
  };
12
12
  export declare function makeAbort<TSpec extends SpecType>({ eyes, driver, controller, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }?: {
13
- settings?: AbortSettings;
14
- logger?: Logger;
13
+ settings?: AbortSettings | undefined;
14
+ logger?: Logger | undefined;
15
15
  }) => Promise<void>;
16
16
  export {};
@@ -8,7 +8,7 @@ type Options<TSpec extends SpecType> = {
8
8
  logger: Logger;
9
9
  };
10
10
  export declare function makeClose<TSpec extends SpecType>({ eyes, driver, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }?: {
11
- settings?: CloseSettings;
12
- logger?: Logger;
11
+ settings?: CloseSettings | undefined;
12
+ logger?: Logger | undefined;
13
13
  }) => Promise<void>;
14
14
  export {};
@@ -10,6 +10,6 @@ type Options<TSpec extends SpecType> = {
10
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
- logger?: Logger;
13
+ logger?: Logger | undefined;
14
14
  }) => Promise<string[]>;
15
15
  export {};
@@ -5,7 +5,7 @@ type Options = {
5
5
  logger: Logger;
6
6
  };
7
7
  export declare function makeGetResults({ eyes, logger: mainLogger }: Options): ({ settings, logger, }?: {
8
- settings?: GetResultsSettings;
9
- logger?: Logger;
8
+ settings?: GetResultsSettings | undefined;
9
+ logger?: Logger | undefined;
10
10
  }) => Promise<TestResult[]>;
11
11
  export {};
@@ -7,6 +7,6 @@ type Options<TSpec extends SpecType> = {
7
7
  };
8
8
  export declare function makeGetViewportSize<TSpec extends SpecType>({ spec, logger: mainLogger }: Options<TSpec>): ({ target, logger }: {
9
9
  target: DriverTarget<TSpec>;
10
- logger?: Logger;
10
+ logger?: Logger | undefined;
11
11
  }) => Promise<import("@applitools/utils").Size>;
12
12
  export {};
@@ -9,6 +9,6 @@ type Options<TSpec extends SpecType> = {
9
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
- logger?: Logger;
12
+ logger?: Logger | undefined;
13
13
  }) => Promise<LocateTextResult<TPattern>>;
14
14
  export {};
@@ -9,6 +9,6 @@ type Options<TSpec extends SpecType> = {
9
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
- logger?: Logger;
12
+ logger?: Logger | undefined;
13
13
  }) => Promise<LocateResult<TLocator>>;
14
14
  export {};
@@ -9,6 +9,6 @@ type Options<TSpec extends SpecType> = {
9
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
- logger?: Logger;
12
+ logger?: Logger | undefined;
13
13
  }) => Promise<void>;
14
14
  export {};
@@ -128,6 +128,9 @@ export type LazyLoadOptions = {
128
128
  waitingTime?: number;
129
129
  maxAmountToScroll?: number;
130
130
  };
131
+ export type MobileOptions = {
132
+ keepNavigationBar?: boolean;
133
+ };
131
134
  export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.ImageSettings<Region | ElementReference<TSpec>> {
132
135
  webview?: boolean | string;
133
136
  frames?: (ContextReference<TSpec> | {
@@ -149,6 +152,7 @@ export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.Ima
149
152
  lazyLoad?: boolean | LazyLoadOptions;
150
153
  sendDom?: boolean;
151
154
  captureStatusBar?: boolean;
155
+ mobileOptions?: MobileOptions;
152
156
  }
153
157
  export type LocateSettings<TLocator extends string, TSpec extends SpecType> = BaseCore.LocateSettings<TLocator, Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;
154
158
  export type LocateTextSettings<TPattern extends string, TSpec extends SpecType> = BaseCore.LocateTextSettings<TPattern, Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;
@@ -22,6 +22,6 @@ export declare function toBaseCheckSettings<TSpec extends SpecType>({ settings }
22
22
  selector?: Selector;
23
23
  regions: Region[];
24
24
  }[];
25
- preserveTransformation?: boolean;
25
+ preserveTransformation?: boolean | undefined;
26
26
  }) => BaseCheckSettings;
27
27
  };
@@ -10,6 +10,6 @@ type Options<TSpec extends SpecType> = {
10
10
  export declare function makeTakeSnapshots<TSpec extends SpecType>({ core, spec, logger: defaultLogger }: Options<TSpec>): ({ target, settings, logger, }: {
11
11
  target: DriverTarget<TSpec>;
12
12
  settings: SnapshotSettings<TSpec>;
13
- logger?: Logger;
13
+ logger?: Logger | undefined;
14
14
  }) => Promise<Snapshot[]>;
15
15
  export {};
@@ -9,10 +9,10 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
9
9
  logger: Logger;
10
10
  };
11
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;
13
- target?: Target<TSpec, TType>;
14
- settings?: CheckSettings<TSpec, TDefaultType> & CloseSettings<TDefaultType> & CheckSettings<TSpec, TType> & CloseSettings<TType>;
15
- config?: Config<TSpec, TDefaultType> & Config<TSpec, TType>;
16
- logger?: 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
17
  }) => Promise<void>;
18
18
  export {};
package/types/check.d.ts CHANGED
@@ -9,10 +9,10 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
9
9
  logger: Logger;
10
10
  };
11
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;
13
- target?: Target<TSpec, TType>;
14
- settings?: CheckSettings<TSpec, TType>;
15
- config?: Config<TSpec, TType>;
16
- logger?: 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
17
  }) => Promise<void>;
18
18
  export {};
@@ -1,7 +1,9 @@
1
1
  import type { Target, DriverTarget, Eyes, CheckSettings, CloseSettings, Environment } from './types';
2
+ import type { CheckSettings as BaseCheckSettings, CloseSettings as BaseCloseSettings } from '@applitools/core-base';
2
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';
6
+ import * as utils from '@applitools/utils';
5
7
  type Options<TSpec extends SpecType> = {
6
8
  eyes: Eyes<TSpec>;
7
9
  target?: DriverTarget<TSpec>;
@@ -11,8 +13,14 @@ type Options<TSpec extends SpecType> = {
11
13
  logger: Logger;
12
14
  };
13
15
  export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
14
- target?: Target<TSpec>;
15
- settings?: CheckSettings<TSpec> & CloseSettings;
16
- logger?: Logger;
16
+ target?: Target<TSpec> | undefined;
17
+ settings?: (BaseCheckSettings<utils.Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
18
+ environments?: Environment[] | undefined;
19
+ } & {
20
+ retryTimeout?: number | undefined;
21
+ } & BaseCloseSettings & {
22
+ environments?: Environment[] | undefined;
23
+ }) | undefined;
24
+ logger?: Logger | undefined;
17
25
  }) => Promise<void>;
18
26
  export {};
@@ -11,8 +11,8 @@ type Options<TSpec extends SpecType> = {
11
11
  logger: Logger;
12
12
  };
13
13
  export declare function makeCheck<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
14
- target?: Target<TSpec>;
15
- settings?: CheckSettings<TSpec>;
16
- logger?: Logger;
14
+ target?: Target<TSpec> | undefined;
15
+ settings?: CheckSettings<TSpec> | undefined;
16
+ logger?: Logger | undefined;
17
17
  }) => Promise<void>;
18
18
  export {};
@@ -9,6 +9,6 @@ type Options<TSpec extends SpecType> = {
9
9
  };
10
10
  export declare function makeGetBaseEyes<TSpec extends SpecType>({ settings: defaultSettings, eyes, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }: {
11
11
  settings: GetBaseEyesSettings<TSpec>;
12
- logger?: Logger;
12
+ logger?: Logger | undefined;
13
13
  }) => Promise<BaseEyes>;
14
14
  export {};
@@ -7,9 +7,9 @@ type Options<TSpec extends SpecType> = {
7
7
  logger: Logger;
8
8
  };
9
9
  export declare function makeOpenEyes<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): ({ target, settings, storage, logger, }: {
10
- target?: DriverTarget<TSpec>;
10
+ target?: DriverTarget<TSpec> | undefined;
11
11
  settings: OpenSettings;
12
- storage?: EyesStorage;
13
- logger?: Logger;
12
+ storage?: EyesStorage | undefined;
13
+ logger?: Logger | undefined;
14
14
  }) => Promise<Eyes<TSpec>>;
15
15
  export {};
@@ -7,6 +7,6 @@ type Options = {
7
7
  };
8
8
  export declare function makeCloseBatch({ core, logger: mainLogger }: Options): ({ settings, logger, }: {
9
9
  settings: MaybeArray<CloseBatchSettings>;
10
- logger?: Logger;
10
+ logger?: Logger | undefined;
11
11
  }) => Promise<void>;
12
12
  export {};
package/types/close.d.ts CHANGED
@@ -7,8 +7,8 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
7
7
  logger: Logger;
8
8
  };
9
9
  export declare function makeClose<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ eyes, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec, TType>): ({ settings, config, logger, }?: {
10
- settings?: CloseSettings<TType>;
11
- config?: Config<TSpec, TType>;
12
- logger?: Logger;
10
+ settings?: CloseSettings<TType> | undefined;
11
+ config?: Config<TSpec, TType> | undefined;
12
+ logger?: Logger | undefined;
13
13
  }) => Promise<void>;
14
14
  export {};
@@ -7,6 +7,6 @@ type Options = {
7
7
  };
8
8
  export declare function makeDeleteTest({ core, logger: mainLogger }: Options): ({ settings, logger, }: {
9
9
  settings: MaybeArray<DeleteTestSettings>;
10
- logger?: Logger;
10
+ logger?: Logger | undefined;
11
11
  }) => Promise<void>;
12
12
  export {};
@@ -10,7 +10,7 @@ type Options<TSpec extends SpecType> = {
10
10
  export declare function makeExtractText<TSpec extends SpecType>({ spec, core, logger: mainLogger }: Options<TSpec>): ({ target, settings, config, logger, }: {
11
11
  target: Target<TSpec, 'classic'>;
12
12
  settings: MaybeArray<ExtractTextSettings<TSpec>>;
13
- config?: Config<TSpec, 'classic'>;
14
- logger?: Logger;
13
+ config?: Config<TSpec, "classic"> | undefined;
14
+ logger?: Logger | undefined;
15
15
  }) => Promise<string[]>;
16
16
  export {};
@@ -6,6 +6,6 @@ type Options = {
6
6
  };
7
7
  export declare function makeGetAccountInfo({ core, logger: mainLogger }: Options): ({ settings, logger, }: {
8
8
  settings: EyesServerSettings;
9
- logger?: Logger;
9
+ logger?: Logger | undefined;
10
10
  }) => Promise<Account>;
11
11
  export {};
@@ -4,8 +4,8 @@ type Options = {
4
4
  logger: Logger;
5
5
  };
6
6
  export declare function makeGetECClient({ logger: mainLogger }: Options): (({ settings, logger, }?: {
7
- settings?: Partial<ECClientSettings>;
8
- logger?: Logger;
7
+ settings?: Partial<ECClientSettings> | undefined;
8
+ logger?: Logger | undefined;
9
9
  }) => Promise<ECClient>) & {
10
10
  getCachedValues(): Promise<ECClient>[];
11
11
  setCachedValue(key: any, value: Promise<ECClient>): void;
@@ -6,7 +6,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
6
6
  logger: Logger;
7
7
  };
8
8
  export declare function makeGetEyesResults<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ eyes, logger: mainLogger, }: Options<TSpec, TType>): ({ settings, logger, }?: {
9
- settings?: GetEyesResultsSettings<TType>;
10
- logger?: Logger;
9
+ settings?: GetEyesResultsSettings<TType> | undefined;
10
+ logger?: Logger | undefined;
11
11
  }) => Promise<TestResult<TType>[]>;
12
12
  export {};
@@ -7,7 +7,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
7
7
  logger: Logger;
8
8
  };
9
9
  export declare function makeGetManagerResults<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ core, storage, logger: mainLogger, }: Options<TSpec, TType>): ({ settings, logger, }?: {
10
- settings?: GetManagerResultsSettings<TType>;
11
- logger?: Logger;
10
+ settings?: GetManagerResultsSettings<TType> | undefined;
11
+ logger?: Logger | undefined;
12
12
  }) => Promise<TestResultSummary<TType>>;
13
13
  export {};
@@ -11,7 +11,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
11
11
  logger: Logger;
12
12
  };
13
13
  export declare function makeGetTypedEyes<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, settings: defaultSettings, target, cores, logger: mainLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, logger, }?: {
14
- type?: TType;
15
- logger?: Logger;
14
+ type?: TType | undefined;
15
+ logger?: Logger | undefined;
16
16
  }) => Promise<TypedEyes<TSpec, TType>>;
17
17
  export {};
@@ -9,7 +9,7 @@ type Options<TSpec extends SpecType> = {
9
9
  export declare function makeLocateText<TSpec extends SpecType>({ spec, core, logger: mainLogger }: Options<TSpec>): <TPattern extends string>({ target, settings, config, logger, }: {
10
10
  target: Target<TSpec, 'classic'>;
11
11
  settings: LocateTextSettings<TPattern, TSpec>;
12
- config?: Config<TSpec, 'classic'>;
13
- logger?: Logger;
12
+ config?: Config<TSpec, "classic"> | undefined;
13
+ logger?: Logger | undefined;
14
14
  }) => Promise<LocateTextResult<TPattern>>;
15
15
  export {};
package/types/locate.d.ts CHANGED
@@ -10,7 +10,7 @@ type Options<TSpec extends SpecType> = {
10
10
  export declare function makeLocate<TSpec extends SpecType>({ spec, core, logger: mainLogger }: Options<TSpec>): <TLocator extends string>({ target, settings, config, logger, }: {
11
11
  target: Target<TSpec, 'classic'>;
12
12
  settings: LocateSettings<TLocator, TSpec>;
13
- config?: Config<TSpec, 'classic'>;
14
- logger?: Logger;
13
+ config?: Config<TSpec, "classic"> | undefined;
14
+ logger?: Logger | undefined;
15
15
  }) => Promise<Record<TLocator, Region[]>>;
16
16
  export {};
@@ -20,8 +20,8 @@ type Options<TSpec extends SpecType> = {
20
20
  offlineLocationPath?: string;
21
21
  };
22
22
  export declare function makeMakeManager<TSpec extends SpecType>({ spec, clients, core, base: defaultBase, agentId: defaultAgentId, environment, cwd, logger: mainLogger, asyncCache, offlineLocationPath, }: Options<TSpec>): <TType extends "classic" | "ufg" = "classic">({ type, settings, logger, }?: {
23
- type?: TType;
24
- settings?: ManagerSettings;
25
- logger?: Logger;
23
+ type?: TType | undefined;
24
+ settings?: ManagerSettings | undefined;
25
+ logger?: Logger | undefined;
26
26
  }) => Promise<EyesManager<TSpec, TType>>;
27
27
  export {};
@@ -22,10 +22,10 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
22
22
  cwd?: string;
23
23
  };
24
24
  export declare function makeOpenEyes<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, clients, batch, removeDuplicateTests, core, cores, spec, environment, logger: mainLogger, asyncCache, cwd, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings: openSettings, config, target, logger, }: {
25
- type?: TType;
26
- settings?: Partial<OpenSettings<TDefaultType> & OpenSettings<TType>>;
27
- config?: Config<TSpec, TDefaultType> & Config<TSpec, TType>;
28
- target?: DriverTarget<TSpec>;
29
- logger?: Logger;
25
+ type?: TType | undefined;
26
+ settings?: Partial<OpenSettings<TDefaultType> & OpenSettings<TType>> | undefined;
27
+ config?: (Config<TSpec, TDefaultType> & Config<TSpec, TType>) | undefined;
28
+ target?: DriverTarget<TSpec> | undefined;
29
+ logger?: Logger | undefined;
30
30
  }) => Promise<Eyes<TSpec, TType>>;
31
31
  export {};
@@ -2,6 +2,7 @@ import type { DriverTarget, Target, Eyes, CheckSettings, CloseSettings, Environm
2
2
  import { type AbortSignal } from 'abort-controller';
3
3
  import { type Logger } from '@applitools/logger';
4
4
  import { type SpecType, type SpecDriver } from '@applitools/driver';
5
+ import * as utils from '@applitools/utils';
5
6
  type Options<TSpec extends SpecType> = {
6
7
  eyes: Eyes<TSpec>;
7
8
  target?: DriverTarget<TSpec>;
@@ -11,8 +12,28 @@ type Options<TSpec extends SpecType> = {
11
12
  logger: Logger;
12
13
  };
13
14
  export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
14
- target?: Target<TSpec>;
15
- settings?: CheckSettings<TSpec> & CloseSettings;
16
- logger?: Logger;
15
+ target?: Target<TSpec> | undefined;
16
+ settings?: (import("@applitools/core-base").CheckSettings<utils.Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
17
+ environments?: Environment[] | undefined;
18
+ } & {
19
+ disableBrowserFetching?: boolean | undefined;
20
+ layoutBreakpoints?: {
21
+ breakpoints: boolean | number[];
22
+ reload?: boolean | undefined;
23
+ } | undefined;
24
+ hooks?: {
25
+ beforeCaptureScreenshot: string;
26
+ } | undefined;
27
+ ufgOptions?: Record<string, any> | undefined;
28
+ prefixRenderId?: string | undefined;
29
+ autProxy?: (import("@applitools/req").Proxy & {
30
+ mode?: "Allow" | "Block" | undefined;
31
+ domains?: string[] | undefined;
32
+ }) | undefined;
33
+ headers?: Record<string, string> | undefined;
34
+ } & import("@applitools/core-base").CloseSettings & {
35
+ environments?: Environment[] | undefined;
36
+ }) | undefined;
37
+ logger?: Logger | undefined;
17
38
  }) => Promise<void>;
18
39
  export {};
@@ -11,8 +11,8 @@ type Options<TSpec extends SpecType> = {
11
11
  logger: Logger;
12
12
  };
13
13
  export declare function makeCheck<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
14
- target?: Target<TSpec>;
15
- settings?: CheckSettings<TSpec>;
16
- logger?: Logger;
14
+ target?: Target<TSpec> | undefined;
15
+ settings?: CheckSettings<TSpec> | undefined;
16
+ logger?: Logger | undefined;
17
17
  }) => Promise<void>;
18
18
  export {};
@@ -10,6 +10,6 @@ type Options<TSpec extends SpecType> = {
10
10
  };
11
11
  export declare function makeGetBaseEyes<TSpec extends SpecType>({ settings: defaultSettings, eyes, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }: {
12
12
  settings: GetBaseEyesSettings<TSpec>;
13
- logger?: Logger;
13
+ logger?: Logger | undefined;
14
14
  }) => Promise<BaseEyes>;
15
15
  export {};
@@ -9,7 +9,7 @@ type Options = {
9
9
  };
10
10
  export declare function makeGetUFGClient({ client, fetchConcurrency, offlineLocationPath, logger: mainLogger, asyncCache, }: Options): (({ settings, logger }: {
11
11
  settings: UFGClientSettings;
12
- logger?: Logger;
12
+ logger?: Logger | undefined;
13
13
  }) => Promise<UFGClient>) & {
14
14
  getCachedValues(): Promise<UFGClient>[];
15
15
  setCachedValue(key: any, value: Promise<UFGClient>): void;
@@ -7,9 +7,9 @@ type Options<TSpec extends SpecType> = {
7
7
  logger: Logger;
8
8
  };
9
9
  export declare function makeOpenEyes<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): ({ target, settings, storage, logger, }: {
10
- target?: DriverTarget<TSpec>;
10
+ target?: DriverTarget<TSpec> | undefined;
11
11
  settings: OpenSettings;
12
- storage?: EyesStorage;
13
- logger?: Logger;
12
+ storage?: EyesStorage | undefined;
13
+ logger?: Logger | undefined;
14
14
  }) => Promise<Eyes<TSpec>>;
15
15
  export {};
@@ -10,8 +10,8 @@ type Options<TSpec extends SpecType> = {
10
10
  };
11
11
  export declare function makeTakeSnapshots<TSpec extends SpecType>({ core, spec, signal, logger: mainLogger }: Options<TSpec>): ({ driver, settings, account, logger, }: {
12
12
  driver: Driver<TSpec>;
13
- settings?: SnapshotSettings<TSpec>;
13
+ settings?: SnapshotSettings<TSpec> | undefined;
14
14
  account: Account;
15
- logger?: Logger;
15
+ logger?: Logger | undefined;
16
16
  }) => Promise<Snapshot[]>;
17
17
  export {};