@applitools/core 4.23.1 → 4.24.1

package/CHANGELOG.md

@@ -1,5 +1,75 @@
 # Changelog
 
+## [4.24.1](https://github.com/Applitools-Dev/sdk/compare/js/core@4.24.0...js/core@4.24.1) (2024-11-14)
+
+
+### Bug Fixes
+
+* don't throw error on stale/missing non-target regions ([#2598](https://github.com/Applitools-Dev/sdk/issues/2598)) ([ae39ad9](https://github.com/Applitools-Dev/sdk/commit/ae39ad9fdb129a3f987ee5076660071b66dc1342))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.10
+  #### Bug Fixes
+
+  * don't throw error on stale/missing non-target regions ([#2598](https://github.com/Applitools-Dev/sdk/issues/2598)) ([ae39ad9](https://github.com/Applitools-Dev/sdk/commit/ae39ad9fdb129a3f987ee5076660071b66dc1342))
+
+
+
+* @applitools/snippets bumped to 2.6.3
+  #### Bug Fixes
+
+  * don't throw error on stale/missing non-target regions ([#2598](https://github.com/Applitools-Dev/sdk/issues/2598)) ([ae39ad9](https://github.com/Applitools-Dev/sdk/commit/ae39ad9fdb129a3f987ee5076660071b66dc1342))
+* @applitools/driver bumped to 1.20.1
+
+* @applitools/spec-driver-webdriver bumped to 1.1.21
+
+* @applitools/spec-driver-selenium bumped to 1.5.92
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.21
+
+* @applitools/screenshoter bumped to 3.10.1
+
+* @applitools/nml-client bumped to 1.8.19
+
+* @applitools/ec-client bumped to 1.9.15
+
+
+## [4.24.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.23.1...js/core@4.24.0) (2024-11-12)
+
+
+### Features
+
+* 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))
+
+
+### Dependencies
+
+* @applitools/driver bumped to 1.20.0
+  #### Features
+
+  * 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))
+* @applitools/screenshoter bumped to 3.10.0
+  #### Features
+
+  * 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))
+
+
+
+* @applitools/dom-snapshot bumped to 4.11.9
+
+* @applitools/spec-driver-webdriver bumped to 1.1.20
+
+* @applitools/spec-driver-selenium bumped to 1.5.91
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.20
+
+* @applitools/nml-client bumped to 1.8.18
+
+* @applitools/ec-client bumped to 1.9.14
+
+
 ## [4.23.1](https://github.com/Applitools-Dev/sdk/compare/js/core@4.23.0...js/core@4.23.1) (2024-11-09)
 
 

package/dist/automation/utils/take-screenshot.js

@@ -27,7 +27,7 @@ exports.takeScreenshot = void 0;
 const utils = __importStar(require("@applitools/utils"));
 const { takeScreenshot: legacyTakeScreenshot } = require('@applitools/screenshoter');
 async function takeScreenshot({ driver, settings, logger, }) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     const environment = await driver.getEnvironment();
     return legacyTakeScreenshot({
         driver,
@@ -55,6 +55,7 @@ async function takeScreenshot({ driver, settings, logger, }) {
         logger,
         regionsToCalculate: settings.regionsToCalculate,
         captureStatusBar: settings.captureStatusBar,
+        keepNavigationBar: (_d = settings.mobileOptions) === null || _d === void 0 ? void 0 : _d.keepNavigationBar,
     });
 }
 exports.takeScreenshot = takeScreenshot;

package/dist/check.js

@@ -34,8 +34,8 @@ const chalk_1 = __importDefault(require("chalk"));
 function makeCheck({ type: defaultType = 'classic', eyes, target: defaultTarget, spec, logger: mainLogger, }) {
     let stepIndex = 0;
     return async function check({ type = defaultType, target = defaultTarget, settings, config, logger = mainLogger, } = {}) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
-        var _q, _r, _s, _t;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+        var _r, _s, _t, _u, _v;
         logger = logger.extend(mainLogger, { tags: [`check-${type}-${utils.general.shortid()}`] });
         settings = { ...config === null || config === void 0 ? void 0 : config.screenshot, ...config === null || config === void 0 ? void 0 : config.check, ...settings };
         (_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,
             !utils.types.isEmpty(settings.layoutRegions));
         (_h = settings.autProxy) !== null && _h !== void 0 ? _h : (settings.autProxy = eyes.test.eyesServer.proxy);
         (_j = settings.useDom) !== null && _j !== void 0 ? _j : (settings.useDom = false);
-        (_k = (_q = settings).retryTimeout) !== null && _k !== void 0 ? _k : (_q.retryTimeout = 0);
+        (_k = (_r = settings).retryTimeout) !== null && _k !== void 0 ? _k : (_r.retryTimeout = 0);
         settings.lazyLoad = settings.lazyLoad === true ? {} : settings.lazyLoad;
         if (settings.lazyLoad) {
-            (_l = (_r = settings.lazyLoad).scrollLength) !== null && _l !== void 0 ? _l : (_r.scrollLength = 300);
-            (_m = (_s = settings.lazyLoad).waitingTime) !== null && _m !== void 0 ? _m : (_s.waitingTime = 2000);
-            (_o = (_t = settings.lazyLoad).maxAmountToScroll) !== null && _o !== void 0 ? _o : (_t.maxAmountToScroll = 15000);
+            (_l = (_s = settings.lazyLoad).scrollLength) !== null && _l !== void 0 ? _l : (_s.scrollLength = 300);
+            (_m = (_t = settings.lazyLoad).waitingTime) !== null && _m !== void 0 ? _m : (_t.waitingTime = 2000);
+            (_o = (_u = settings.lazyLoad).maxAmountToScroll) !== null && _o !== void 0 ? _o : (_u.maxAmountToScroll = 15000);
         }
         settings.stepIndex = stepIndex++;
         (_p = settings.waitBetweenStitches) !== null && _p !== void 0 ? _p : (settings.waitBetweenStitches = utils.types.isObject(settings.lazyLoad) ? settings.lazyLoad.waitingTime : 100);
+        if (settings.mobileOptions) {
+            (_q = (_v = settings.mobileOptions).keepNavigationBar) !== null && _q !== void 0 ? _q : (_v.keepNavigationBar = false);
+        }
         if (settings.matchLevel === 'Content') {
             logger.console.log(chalk_1.default.yellow(lang.matchLevelContentDeprecatedWarning));
         }

package/dist/ufg/take-snapshots.js

@@ -24,6 +24,7 @@ function makeTakeSnapshots({ core, spec, signal, logger: mainLogger }) {
         const { elementReferences, getSafeCheckSettings } = (0, to_safe_check_settings_1.toSafeCheckSettings)({ settings });
         const { elementReferencesToMark, getGeneratedSelectors } = (0, to_generated_selectors_1.toGeneratedSelectors)({
             elementReferences,
+            logger,
             // dead code - `transformElementReference` was used for NMG but it's not longer used anywhere
             transformElementReference: elementReference => { var _a; return ((0, driver_1.isSelector)(elementReference) && ((_a = spec === null || spec === void 0 ? void 0 : spec.toSimpleCommonSelector) === null || _a === void 0 ? void 0 : _a.call(spec, elementReference))) || undefined; },
         });

package/dist/ufg/utils/to-generated-selectors.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toGeneratedSelectors = void 0;
-function toGeneratedSelectors({ elementReferences, transformElementReference, }) {
+function toGeneratedSelectors({ elementReferences, logger, transformElementReference, }) {
     var _a, _b, _c;
     const elementReferencesToMark = [
         (_a = elementReferences.target) !== null && _a !== void 0 ? _a : [],
@@ -17,14 +17,39 @@ function toGeneratedSelectors({ elementReferences, transformElementReference, })
         if (generatedSelectors) {
             let offset = 0;
             if (elementReferences.target) {
-                target = (_a = generatedSelectors[offset++].safeSelector) !== null && _a !== void 0 ? _a : undefined;
-                if (!target)
+                const targetOrError = (_a = generatedSelectors[offset++].safeSelector) !== null && _a !== void 0 ? _a : undefined;
+                if (!targetOrError)
                     throw new Error('Target element not found');
+                if (typeof targetOrError !== 'string' && 'error' in targetOrError)
+                    throw new Error(`Target element is stale - please make sure the element is not detached from the DOM tree. ${targetOrError.error}`);
+                target = targetOrError;
             }
             if (elementReferences.scrolling) {
-                scrolling = (_b = generatedSelectors[offset++].safeSelector) !== null && _b !== void 0 ? _b : undefined;
+                const scrollingOrError = (_b = generatedSelectors[offset++].safeSelector) !== null && _b !== void 0 ? _b : undefined;
+                const isError = typeof scrollingOrError === 'object' && 'error' in scrollingOrError;
+                scrolling = isError ? undefined : scrollingOrError;
+                if (isError) {
+                    logger.log('Error in scrolling element:', scrollingOrError);
+                }
+                else if (!scrolling) {
+                    logger.log('Scrolling element not found');
+                }
             }
-            calculate = generatedSelectors.slice(offset);
+            calculate = generatedSelectors.slice(offset).map(generatedSelector => {
+                var _a;
+                const safeSelector = generatedSelector.safeSelector;
+                const isError = safeSelector && typeof safeSelector === 'object' && 'error' in safeSelector;
+                if (isError) {
+                    logger.log('Error in calculate element:', safeSelector);
+                }
+                else if (!safeSelector) {
+                    logger.log('Calculate element not found', (_a = generatedSelector.originalSelector) !== null && _a !== void 0 ? _a : '');
+                }
+                return {
+                    ...generatedSelector,
+                    safeSelector: isError ? null : safeSelector,
+                };
+            });
         }
         else {
             // the entire else statement should be a dead code that was used for NMG, will be removed later
@@ -36,7 +61,7 @@ function toGeneratedSelectors({ elementReferences, transformElementReference, })
                 return { originalSelector: selector, safeSelector: selector };
             });
         }
-        return { target, scrolling, calculate };
+        return { target: target, scrolling, calculate };
     }
 }
 exports.toGeneratedSelectors = toGeneratedSelectors;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.23.1",
+  "version": "4.24.1",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -76,16 +76,16 @@
   "dependencies": {
     "@applitools/core-base": "1.19.2",
     "@applitools/dom-capture": "11.5.1",
-    "@applitools/dom-snapshot": "4.11.8",
-    "@applitools/driver": "1.19.7",
-    "@applitools/ec-client": "1.9.13",
+    "@applitools/dom-snapshot": "4.11.10",
+    "@applitools/driver": "1.20.0",
+    "@applitools/ec-client": "1.9.14",
     "@applitools/logger": "2.0.19",
-    "@applitools/nml-client": "1.8.17",
+    "@applitools/nml-client": "1.8.18",
     "@applitools/req": "1.7.3",
-    "@applitools/screenshoter": "3.9.5",
-    "@applitools/snippets": "2.6.2",
+    "@applitools/screenshoter": "3.10.0",
+    "@applitools/snippets": "2.6.3",
     "@applitools/socket": "1.1.19",
-    "@applitools/spec-driver-webdriver": "1.1.19",
+    "@applitools/spec-driver-webdriver": "1.1.20",
     "@applitools/ufg-client": "1.14.0",
     "@applitools/utils": "1.7.5",
     "@types/ws": "8.5.5",
@@ -100,8 +100,8 @@
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.4.19",
-    "@applitools/spec-driver-selenium": "^1.5.90",
+    "@applitools/spec-driver-puppeteer": "^1.4.20",
+    "@applitools/spec-driver-selenium": "^1.5.91",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
     "@applitools/tunnel-client": "^1.5.9",

package/types/abort.d.ts

@@ -7,7 +7,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     logger: Logger;
 };
 export declare function makeAbort<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ eyes, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec, TType>): ({ settings, logger, }?: {
-    settings?: AbortSettings<TType>;
-    logger?: Logger;
+    settings?: AbortSettings<TType> | undefined;
+    logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/automation/abort.d.ts

@@ -10,7 +10,7 @@ type Options<TSpec extends SpecType> = {
     logger: Logger;
 };
 export declare function makeAbort<TSpec extends SpecType>({ eyes, driver, controller, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }?: {
-    settings?: AbortSettings;
-    logger?: Logger;
+    settings?: AbortSettings | undefined;
+    logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/automation/close.d.ts

@@ -8,7 +8,7 @@ type Options<TSpec extends SpecType> = {
     logger: Logger;
 };
 export declare function makeClose<TSpec extends SpecType>({ eyes, driver, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }?: {
-    settings?: CloseSettings;
-    logger?: Logger;
+    settings?: CloseSettings | undefined;
+    logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/automation/extract-text.d.ts

@@ -10,6 +10,6 @@ type Options<TSpec extends SpecType> = {
 export declare function makeExtractText<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): ({ target, settings, logger, }: {
     target: Target<TSpec>;
     settings: MaybeArray<ExtractTextSettings<TSpec>>;
-    logger?: Logger;
+    logger?: Logger | undefined;
 }) => Promise<string[]>;
 export {};

package/types/automation/get-results.d.ts

@@ -5,7 +5,7 @@ type Options = {
     logger: Logger;
 };
 export declare function makeGetResults({ eyes, logger: mainLogger }: Options): ({ settings, logger, }?: {
-    settings?: GetResultsSettings;
-    logger?: Logger;
+    settings?: GetResultsSettings | undefined;
+    logger?: Logger | undefined;
 }) => Promise<TestResult[]>;
 export {};

package/types/automation/get-viewport-size.d.ts

@@ -7,6 +7,6 @@ type Options<TSpec extends SpecType> = {
 };
 export declare function makeGetViewportSize<TSpec extends SpecType>({ spec, logger: mainLogger }: Options<TSpec>): ({ target, logger }: {
     target: DriverTarget<TSpec>;
-    logger?: Logger;
+    logger?: Logger | undefined;
 }) => Promise<import("@applitools/utils").Size>;
 export {};

package/types/automation/locate-text.d.ts

@@ -9,6 +9,6 @@ type Options<TSpec extends SpecType> = {
 export declare function makeLocateText<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): <TPattern extends string>({ target, settings, logger, }: {
     target: Target<TSpec>;
     settings: LocateTextSettings<TPattern, TSpec>;
-    logger?: Logger;
+    logger?: Logger | undefined;
 }) => Promise<LocateTextResult<TPattern>>;
 export {};

package/types/automation/locate.d.ts

@@ -9,6 +9,6 @@ type Options<TSpec extends SpecType> = {
 export declare function makeLocate<TSpec extends SpecType>({ spec, core, logger: mainLogger }: Options<TSpec>): <TLocator extends string>({ settings, target, logger, }: {
     target: Target<TSpec>;
     settings: LocateSettings<TLocator, TSpec>;
-    logger?: Logger;
+    logger?: Logger | undefined;
 }) => Promise<LocateResult<TLocator>>;
 export {};

package/types/automation/set-viewport-size.d.ts

@@ -9,6 +9,6 @@ type Options<TSpec extends SpecType> = {
 export declare function makeSetViewportSize<TSpec extends SpecType>({ spec, logger: mainLogger }: Options<TSpec>): ({ target, size, logger, }: {
     target: DriverTarget<TSpec>;
     size: Size;
-    logger?: Logger;
+    logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/automation/types.d.ts

@@ -128,6 +128,9 @@ export type LazyLoadOptions = {
     waitingTime?: number;
     maxAmountToScroll?: number;
 };
+export type MobileOptions = {
+    keepNavigationBar?: boolean;
+};
 export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.ImageSettings<Region | ElementReference<TSpec>> {
     webview?: boolean | string;
     frames?: (ContextReference<TSpec> | {
@@ -149,6 +152,7 @@ export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.Ima
     lazyLoad?: boolean | LazyLoadOptions;
     sendDom?: boolean;
     captureStatusBar?: boolean;
+    mobileOptions?: MobileOptions;
 }
 export type LocateSettings<TLocator extends string, TSpec extends SpecType> = BaseCore.LocateSettings<TLocator, Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;
 export type LocateTextSettings<TPattern extends string, TSpec extends SpecType> = BaseCore.LocateTextSettings<TPattern, Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;

package/types/automation/utils/to-base-check-settings.d.ts

@@ -22,6 +22,6 @@ export declare function toBaseCheckSettings<TSpec extends SpecType>({ settings }
             selector?: Selector;
             regions: Region[];
         }[];
-        preserveTransformation?: boolean;
+        preserveTransformation?: boolean | undefined;
     }) => BaseCheckSettings;
 };

package/types/autonomous/take-snapshots.d.ts

@@ -10,6 +10,6 @@ type Options<TSpec extends SpecType> = {
 export declare function makeTakeSnapshots<TSpec extends SpecType>({ core, spec, logger: defaultLogger }: Options<TSpec>): ({ target, settings, logger, }: {
     target: DriverTarget<TSpec>;
     settings: SnapshotSettings<TSpec>;
-    logger?: Logger;
+    logger?: Logger | undefined;
 }) => Promise<Snapshot[]>;
 export {};

package/types/check-and-close.d.ts

@@ -9,10 +9,10 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     logger: Logger;
 };
 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, }?: {
-    type?: TType;
-    target?: Target<TSpec, TType>;
-    settings?: CheckSettings<TSpec, TDefaultType> & CloseSettings<TDefaultType> & CheckSettings<TSpec, TType> & CloseSettings<TType>;
-    config?: Config<TSpec, TDefaultType> & Config<TSpec, TType>;
-    logger?: Logger;
+    type?: TType | undefined;
+    target?: Target<TSpec, TType> | undefined;
+    settings?: (CheckSettings<TSpec, TDefaultType> & CloseSettings<TDefaultType> & CheckSettings<TSpec, TType> & CloseSettings<TType>) | undefined;
+    config?: (Config<TSpec, TDefaultType> & Config<TSpec, TType>) | undefined;
+    logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/check.d.ts

@@ -9,10 +9,10 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     logger: Logger;
 };
 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, }?: {
-    type?: TType;
-    target?: Target<TSpec, TType>;
-    settings?: CheckSettings<TSpec, TType>;
-    config?: Config<TSpec, TType>;
-    logger?: Logger;
+    type?: TType | undefined;
+    target?: Target<TSpec, TType> | undefined;
+    settings?: CheckSettings<TSpec, TType> | undefined;
+    config?: Config<TSpec, TType> | undefined;
+    logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/classic/check-and-close.d.ts

@@ -1,7 +1,9 @@
 import type { Target, DriverTarget, Eyes, CheckSettings, CloseSettings, Environment } from './types';
+import type { CheckSettings as BaseCheckSettings, CloseSettings as BaseCloseSettings } from '@applitools/core-base';
 import { type AbortSignal } from 'abort-controller';
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
+import * as utils from '@applitools/utils';
 type Options<TSpec extends SpecType> = {
     eyes: Eyes<TSpec>;
     target?: DriverTarget<TSpec>;
@@ -11,8 +13,14 @@ type Options<TSpec extends SpecType> = {
     logger: Logger;
 };
 export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
-    target?: Target<TSpec>;
-    settings?: CheckSettings<TSpec> & CloseSettings;
-    logger?: Logger;
+    target?: Target<TSpec> | undefined;
+    settings?: (BaseCheckSettings<utils.Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
+        environments?: Environment[] | undefined;
+    } & {
+        retryTimeout?: number | undefined;
+    } & BaseCloseSettings & {
+        environments?: Environment[] | undefined;
+    }) | undefined;
+    logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/classic/check.d.ts

@@ -11,8 +11,8 @@ type Options<TSpec extends SpecType> = {
     logger: Logger;
 };
 export declare function makeCheck<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
-    target?: Target<TSpec>;
-    settings?: CheckSettings<TSpec>;
-    logger?: Logger;
+    target?: Target<TSpec> | undefined;
+    settings?: CheckSettings<TSpec> | undefined;
+    logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/classic/get-base-eyes.d.ts

@@ -9,6 +9,6 @@ type Options<TSpec extends SpecType> = {
 };
 export declare function makeGetBaseEyes<TSpec extends SpecType>({ settings: defaultSettings, eyes, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }: {
     settings: GetBaseEyesSettings<TSpec>;
-    logger?: Logger;
+    logger?: Logger | undefined;
 }) => Promise<BaseEyes>;
 export {};

package/types/classic/open-eyes.d.ts

@@ -7,9 +7,9 @@ type Options<TSpec extends SpecType> = {
     logger: Logger;
 };
 export declare function makeOpenEyes<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): ({ target, settings, storage, logger, }: {
-    target?: DriverTarget<TSpec>;
+    target?: DriverTarget<TSpec> | undefined;
     settings: OpenSettings;
-    storage?: EyesStorage;
-    logger?: Logger;
+    storage?: EyesStorage | undefined;
+    logger?: Logger | undefined;
 }) => Promise<Eyes<TSpec>>;
 export {};

package/types/close-batch.d.ts

@@ -7,6 +7,6 @@ type Options = {
 };
 export declare function makeCloseBatch({ core, logger: mainLogger }: Options): ({ settings, logger, }: {
     settings: MaybeArray<CloseBatchSettings>;
-    logger?: Logger;
+    logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/close.d.ts

@@ -7,8 +7,8 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     logger: Logger;
 };
 export declare function makeClose<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ eyes, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec, TType>): ({ settings, config, logger, }?: {
-    settings?: CloseSettings<TType>;
-    config?: Config<TSpec, TType>;
-    logger?: Logger;
+    settings?: CloseSettings<TType> | undefined;
+    config?: Config<TSpec, TType> | undefined;
+    logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/delete-test.d.ts

@@ -7,6 +7,6 @@ type Options = {
 };
 export declare function makeDeleteTest({ core, logger: mainLogger }: Options): ({ settings, logger, }: {
     settings: MaybeArray<DeleteTestSettings>;
-    logger?: Logger;
+    logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/extract-text.d.ts

@@ -10,7 +10,7 @@ type Options<TSpec extends SpecType> = {
 export declare function makeExtractText<TSpec extends SpecType>({ spec, core, logger: mainLogger }: Options<TSpec>): ({ target, settings, config, logger, }: {
     target: Target<TSpec, 'classic'>;
     settings: MaybeArray<ExtractTextSettings<TSpec>>;
-    config?: Config<TSpec, 'classic'>;
-    logger?: Logger;
+    config?: Config<TSpec, "classic"> | undefined;
+    logger?: Logger | undefined;
 }) => Promise<string[]>;
 export {};

package/types/get-account-info.d.ts

@@ -6,6 +6,6 @@ type Options = {
 };
 export declare function makeGetAccountInfo({ core, logger: mainLogger }: Options): ({ settings, logger, }: {
     settings: EyesServerSettings;
-    logger?: Logger;
+    logger?: Logger | undefined;
 }) => Promise<Account>;
 export {};

package/types/get-ec-client.d.ts

@@ -4,8 +4,8 @@ type Options = {
     logger: Logger;
 };
 export declare function makeGetECClient({ logger: mainLogger }: Options): (({ settings, logger, }?: {
-    settings?: Partial<ECClientSettings>;
-    logger?: Logger;
+    settings?: Partial<ECClientSettings> | undefined;
+    logger?: Logger | undefined;
 }) => Promise<ECClient>) & {
     getCachedValues(): Promise<ECClient>[];
     setCachedValue(key: any, value: Promise<ECClient>): void;

package/types/get-eyes-results.d.ts

@@ -6,7 +6,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     logger: Logger;
 };
 export declare function makeGetEyesResults<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ eyes, logger: mainLogger, }: Options<TSpec, TType>): ({ settings, logger, }?: {
-    settings?: GetEyesResultsSettings<TType>;
-    logger?: Logger;
+    settings?: GetEyesResultsSettings<TType> | undefined;
+    logger?: Logger | undefined;
 }) => Promise<TestResult<TType>[]>;
 export {};

package/types/get-manager-results.d.ts

@@ -7,7 +7,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     logger: Logger;
 };
 export declare function makeGetManagerResults<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ core, storage, logger: mainLogger, }: Options<TSpec, TType>): ({ settings, logger, }?: {
-    settings?: GetManagerResultsSettings<TType>;
-    logger?: Logger;
+    settings?: GetManagerResultsSettings<TType> | undefined;
+    logger?: Logger | undefined;
 }) => Promise<TestResultSummary<TType>>;
 export {};

package/types/get-typed-eyes.d.ts

@@ -11,7 +11,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     logger: Logger;
 };
 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, }?: {
-    type?: TType;
-    logger?: Logger;
+    type?: TType | undefined;
+    logger?: Logger | undefined;
 }) => Promise<TypedEyes<TSpec, TType>>;
 export {};

package/types/locate-text.d.ts

@@ -9,7 +9,7 @@ type Options<TSpec extends SpecType> = {
 export declare function makeLocateText<TSpec extends SpecType>({ spec, core, logger: mainLogger }: Options<TSpec>): <TPattern extends string>({ target, settings, config, logger, }: {
     target: Target<TSpec, 'classic'>;
     settings: LocateTextSettings<TPattern, TSpec>;
-    config?: Config<TSpec, 'classic'>;
-    logger?: Logger;
+    config?: Config<TSpec, "classic"> | undefined;
+    logger?: Logger | undefined;
 }) => Promise<LocateTextResult<TPattern>>;
 export {};

package/types/locate.d.ts

@@ -10,7 +10,7 @@ type Options<TSpec extends SpecType> = {
 export declare function makeLocate<TSpec extends SpecType>({ spec, core, logger: mainLogger }: Options<TSpec>): <TLocator extends string>({ target, settings, config, logger, }: {
     target: Target<TSpec, 'classic'>;
     settings: LocateSettings<TLocator, TSpec>;
-    config?: Config<TSpec, 'classic'>;
-    logger?: Logger;
+    config?: Config<TSpec, "classic"> | undefined;
+    logger?: Logger | undefined;
 }) => Promise<Record<TLocator, Region[]>>;
 export {};

package/types/make-manager.d.ts

@@ -20,8 +20,8 @@ type Options<TSpec extends SpecType> = {
     offlineLocationPath?: string;
 };
 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, }?: {
-    type?: TType;
-    settings?: ManagerSettings;
-    logger?: Logger;
+    type?: TType | undefined;
+    settings?: ManagerSettings | undefined;
+    logger?: Logger | undefined;
 }) => Promise<EyesManager<TSpec, TType>>;
 export {};

package/types/open-eyes.d.ts

@@ -22,10 +22,10 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     cwd?: string;
 };
 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, }: {
-    type?: TType;
-    settings?: Partial<OpenSettings<TDefaultType> & OpenSettings<TType>>;
-    config?: Config<TSpec, TDefaultType> & Config<TSpec, TType>;
-    target?: DriverTarget<TSpec>;
-    logger?: Logger;
+    type?: TType | undefined;
+    settings?: Partial<OpenSettings<TDefaultType> & OpenSettings<TType>> | undefined;
+    config?: (Config<TSpec, TDefaultType> & Config<TSpec, TType>) | undefined;
+    target?: DriverTarget<TSpec> | undefined;
+    logger?: Logger | undefined;
 }) => Promise<Eyes<TSpec, TType>>;
 export {};

package/types/ufg/check-and-close.d.ts

@@ -2,6 +2,7 @@ import type { DriverTarget, Target, Eyes, CheckSettings, CloseSettings, Environm
 import { type AbortSignal } from 'abort-controller';
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
+import * as utils from '@applitools/utils';
 type Options<TSpec extends SpecType> = {
     eyes: Eyes<TSpec>;
     target?: DriverTarget<TSpec>;
@@ -11,8 +12,28 @@ type Options<TSpec extends SpecType> = {
     logger: Logger;
 };
 export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
-    target?: Target<TSpec>;
-    settings?: CheckSettings<TSpec> & CloseSettings;
-    logger?: Logger;
+    target?: Target<TSpec> | undefined;
+    settings?: (import("@applitools/core-base").CheckSettings<utils.Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
+        environments?: Environment[] | undefined;
+    } & {
+        disableBrowserFetching?: boolean | undefined;
+        layoutBreakpoints?: {
+            breakpoints: boolean | number[];
+            reload?: boolean | undefined;
+        } | undefined;
+        hooks?: {
+            beforeCaptureScreenshot: string;
+        } | undefined;
+        ufgOptions?: Record<string, any> | undefined;
+        prefixRenderId?: string | undefined;
+        autProxy?: (import("@applitools/req").Proxy & {
+            mode?: "Allow" | "Block" | undefined;
+            domains?: string[] | undefined;
+        }) | undefined;
+        headers?: Record<string, string> | undefined;
+    } & import("@applitools/core-base").CloseSettings & {
+        environments?: Environment[] | undefined;
+    }) | undefined;
+    logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/ufg/check.d.ts

@@ -11,8 +11,8 @@ type Options<TSpec extends SpecType> = {
     logger: Logger;
 };
 export declare function makeCheck<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
-    target?: Target<TSpec>;
-    settings?: CheckSettings<TSpec>;
-    logger?: Logger;
+    target?: Target<TSpec> | undefined;
+    settings?: CheckSettings<TSpec> | undefined;
+    logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/ufg/get-base-eyes.d.ts

@@ -10,6 +10,6 @@ type Options<TSpec extends SpecType> = {
 };
 export declare function makeGetBaseEyes<TSpec extends SpecType>({ settings: defaultSettings, eyes, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }: {
     settings: GetBaseEyesSettings<TSpec>;
-    logger?: Logger;
+    logger?: Logger | undefined;
 }) => Promise<BaseEyes>;
 export {};

package/types/ufg/get-ufg-client.d.ts

@@ -9,7 +9,7 @@ type Options = {
 };
 export declare function makeGetUFGClient({ client, fetchConcurrency, offlineLocationPath, logger: mainLogger, asyncCache, }: Options): (({ settings, logger }: {
     settings: UFGClientSettings;
-    logger?: Logger;
+    logger?: Logger | undefined;
 }) => Promise<UFGClient>) & {
     getCachedValues(): Promise<UFGClient>[];
     setCachedValue(key: any, value: Promise<UFGClient>): void;

package/types/ufg/open-eyes.d.ts

@@ -7,9 +7,9 @@ type Options<TSpec extends SpecType> = {
     logger: Logger;
 };
 export declare function makeOpenEyes<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): ({ target, settings, storage, logger, }: {
-    target?: DriverTarget<TSpec>;
+    target?: DriverTarget<TSpec> | undefined;
     settings: OpenSettings;
-    storage?: EyesStorage;
-    logger?: Logger;
+    storage?: EyesStorage | undefined;
+    logger?: Logger | undefined;
 }) => Promise<Eyes<TSpec>>;
 export {};

package/types/ufg/take-snapshots.d.ts

@@ -10,8 +10,8 @@ type Options<TSpec extends SpecType> = {
 };
 export declare function makeTakeSnapshots<TSpec extends SpecType>({ core, spec, signal, logger: mainLogger }: Options<TSpec>): ({ driver, settings, account, logger, }: {
     driver: Driver<TSpec>;
-    settings?: SnapshotSettings<TSpec>;
+    settings?: SnapshotSettings<TSpec> | undefined;
     account: Account;
-    logger?: Logger;
+    logger?: Logger | undefined;
 }) => Promise<Snapshot[]>;
 export {};

package/types/ufg/types.d.ts

@@ -8,7 +8,9 @@ export * from '../automation/types';
 export type DomSnapshot = UFGDomSnapshot & {
     generatedSelectors?: {
         originalSelector: CommonSelector | null;
-        safeSelector: CommonSelector | null;
+        safeSelector: CommonSelector | {
+            error: string;
+        } | null;
     }[];
 };
 export type AndroidSnapshot = UFGAndroidSnapshot;

package/types/ufg/utils/take-dom-snapshot.d.ts

@@ -22,7 +22,9 @@ export type RawDomSnapshot = {
     }[];
     srcAttr: string | null;
     scriptVersion: string;
-    safeSelectors?: (CommonSelector | null)[];
+    safeSelectors?: (CommonSelector | {
+        error: string;
+    } | null)[];
     warnings?: string[];
 };
 export type DomSnapshotSettings<TSpec extends SpecType> = {

package/types/ufg/utils/to-generated-selectors.d.ts

@@ -1,12 +1,14 @@
 import { type SpecType, type ElementReference } from '@applitools/driver';
+import type { Logger } from '@applitools/logger';
 import { type Selector as UFGSelector } from '@applitools/ufg-client';
-export declare function toGeneratedSelectors<TSpec extends SpecType>({ elementReferences, transformElementReference, }: {
+export declare function toGeneratedSelectors<TSpec extends SpecType>({ elementReferences, logger, transformElementReference, }: {
     elementReferences: {
         target?: ElementReference<TSpec>;
         scrolling?: ElementReference<TSpec>;
         calculate?: ElementReference<TSpec>[];
     };
     transformElementReference: (elementReference: ElementReference<TSpec>) => UFGSelector | undefined;
+    logger: Logger;
 }): {
     elementReferencesToMark: (string | TSpec["element"] | TSpec["secondary"]["element"] | TSpec["selector"] | TSpec["secondary"]["selector"] | {
         selector: string | TSpec["selector"] | TSpec["secondary"]["selector"];
@@ -18,7 +20,9 @@ export declare function toGeneratedSelectors<TSpec extends SpecType>({ elementRe
     } | (NonNullable<TSpec["element"]> extends infer T ? T extends NonNullable<TSpec["element"]> ? T extends readonly (infer InnerArr)[] ? InnerArr : T : never : never) | (NonNullable<TSpec["secondary"]["element"]> extends infer T_1 ? T_1 extends NonNullable<TSpec["secondary"]["element"]> ? T_1 extends readonly (infer InnerArr)[] ? InnerArr : T_1 : never : never) | (NonNullable<TSpec["selector"]> extends infer T_2 ? T_2 extends NonNullable<TSpec["selector"]> ? T_2 extends readonly (infer InnerArr)[] ? InnerArr : T_2 : never : never) | (NonNullable<TSpec["secondary"]["selector"]> extends infer T_3 ? T_3 extends NonNullable<TSpec["secondary"]["selector"]> ? T_3 extends readonly (infer InnerArr)[] ? InnerArr : T_3 : never : never))[];
     getGeneratedSelectors: (generatedSelectors?: {
         originalSelector: UFGSelector | null;
-        safeSelector: UFGSelector | null;
+        safeSelector: UFGSelector | {
+            error: string;
+        } | null;
     }[]) => {
         target: UFGSelector | undefined;
         scrolling: UFGSelector | undefined;