@applitools/core 3.9.1 → 3.10.1

package/types/types.d.ts

@@ -4,9 +4,8 @@ import type * as ClassicCore from './classic/types';
 import type * as UFGCore from './ufg/types';
 import { type SpecType } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
-import { type Renderer } from '@applitools/ufg-client';
 import { type ECClient, type ECClientSettings } from '@applitools/ec-client';
-export { ECClient, Renderer };
+export { ECClient };
 export * from './automation/types';
 export type TypedCore<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.Core<TSpec> : ClassicCore.Core<TSpec>;
 export type TypedEyes<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.Eyes<TSpec> : ClassicCore.Eyes<TSpec>;
@@ -64,7 +63,6 @@ export interface Eyes<TSpec extends SpecType, TDefaultType extends 'classic' | '
     readonly core: Core<TSpec, TDefaultType>;
     getTypedEyes<TType extends 'classic' | 'ufg' = TDefaultType>(options?: {
         type?: TType;
-        settings?: any;
         logger?: Logger;
     }): Promise<TypedEyes<TSpec, TType>>;
     check<TType extends 'classic' | 'ufg' = TDefaultType>(options?: {
@@ -73,7 +71,7 @@ export interface Eyes<TSpec extends SpecType, TDefaultType extends 'classic' | '
         settings?: Partial<CheckSettings<TSpec, TDefaultType> & CheckSettings<TSpec, TType>>;
         config?: Config<TSpec, TDefaultType> & Config<TSpec, TType>;
         logger?: Logger;
-    }): Promise<CheckResult<TType>[]>;
+    }): Promise<void>;
     checkAndClose<TType extends 'classic' | 'ufg' = TDefaultType>(options?: {
         type?: TType;
         target?: Target<TSpec, TType>;
@@ -107,8 +105,8 @@ export interface ManagerSettings {
 }
 export type Config<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     open: Partial<Omit<OpenSettings<TType>, 'userCommandId'>>;
-    screenshot: Partial<Omit<ClassicCore.ScreenshotSettings<TSpec>, 'userCommandId'>>;
-    check: Partial<Omit<CheckSettings<TSpec, TType>, keyof ClassicCore.ScreenshotSettings<TSpec> | 'userCommandId'>>;
+    screenshot: Partial<Omit<AutomationCore.ScreenshotSettings<TSpec>, 'userCommandId'>>;
+    check: Partial<Omit<CheckSettings<TSpec, TType>, 'userCommandId'>>;
     close: Partial<Omit<CloseSettings<TType>, 'userCommandId'>>;
 };
 export type OpenSettings<TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.OpenSettings : ClassicCore.OpenSettings;
@@ -122,12 +120,11 @@ export type GetEyesResultsSettings<TType extends 'classic' | 'ufg'> = GetResults
 export type GetManagerResultsSettings<TType extends 'classic' | 'ufg'> = GetEyesResultsSettings<TType> & {
     removeDuplicateTests?: boolean;
 };
-export type CheckResult<TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.CheckResult : ClassicCore.CheckResult;
 export type TestResult<TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.TestResult : ClassicCore.TestResult;
 export interface TestResultContainer<TType extends 'classic' | 'ufg'> {
     readonly error?: Error;
     readonly result?: TestResult<TType>;
-    readonly renderer?: TType extends 'ufg' ? Renderer : never;
+    readonly renderer?: TType extends 'ufg' ? AutomationCore.Renderer : never;
     readonly userTestId?: string;
 }
 export interface TestResultSummary<TType extends 'classic' | 'ufg'> {

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

@@ -1,27 +1,21 @@
 import type { Region } from '@applitools/utils';
-import type { DriverTarget, Target, Eyes, CheckSettings, CloseSettings } from './types';
-import type { Eyes as BaseEyes } from '@applitools/core-base';
-import { type Renderer } from '@applitools/ufg-client';
+import type { DriverTarget, Target, Eyes, CheckSettings, CloseSettings, Renderer } from './types';
 import { type AbortSignal } from 'abort-controller';
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
 type Options<TSpec extends SpecType> = {
     eyes: Eyes<TSpec>;
-    storage: Map<string, Promise<{
-        renderer: Renderer;
-        eyes: BaseEyes;
-    }>[]>;
     target?: DriverTarget<TSpec>;
+    renderers?: Renderer[];
     spec?: SpecDriver<TSpec>;
     signal?: AbortSignal;
     logger: Logger;
 };
-export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, storage, target: defaultTarget, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
+export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target: defaultTarget, renderers: defaultRenderers, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
     target?: Target<TSpec> | undefined;
     settings?: (import("@applitools/core-base").CheckSettings<Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
-        renderers?: (Renderer & {
-            properties?: import("@applitools/core-base").CustomProperty[] | undefined;
-        })[] | undefined;
+        renderers?: Renderer[] | undefined;
+    } & {
         hooks?: {
             beforeCaptureScreenshot: string;
         } | undefined;
@@ -36,7 +30,9 @@ export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, storag
             domains?: string[] | undefined;
         }) | undefined;
         headers?: Record<string, string> | undefined;
-    } & CloseSettings) | undefined;
+    } & import("@applitools/core-base").CloseSettings & {
+        renderers?: Renderer[] | undefined;
+    }) | undefined;
     logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/ufg/check.d.ts

@@ -1,23 +1,18 @@
-import type { DriverTarget, Target, Eyes, CheckSettings, CheckResult } from './types';
-import type { Eyes as BaseEyes } from '@applitools/core-base';
-import { type Renderer } from '@applitools/ufg-client';
+import type { DriverTarget, Target, Eyes, CheckSettings, Renderer } from './types';
 import { type AbortSignal } from 'abort-controller';
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
 type Options<TSpec extends SpecType> = {
     eyes: Eyes<TSpec>;
-    storage: Map<string, Promise<{
-        renderer: Renderer;
-        eyes: BaseEyes;
-    }>[]>;
     target?: DriverTarget<TSpec>;
+    renderers?: Renderer[];
     spec?: SpecDriver<TSpec>;
     signal?: AbortSignal;
     logger: Logger;
 };
-export declare function makeCheck<TSpec extends SpecType>({ eyes, storage, target: defaultTarget, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
+export declare function makeCheck<TSpec extends SpecType>({ eyes, target: defaultTarget, renderers: defaultRenderers, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
     settings?: CheckSettings<TSpec> | undefined;
     target?: Target<TSpec> | undefined;
     logger?: Logger | undefined;
-}) => Promise<CheckResult[]>;
+}) => Promise<void>;
 export {};

package/types/ufg/core.d.ts

@@ -1,9 +1,9 @@
 import type { Core } from './types';
-import type { Core as BaseCore } from '@applitools/core-base';
 import { type UFGClient } from '@applitools/ufg-client';
 import { type NMLClient } from '@applitools/nml-client';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
+import { type Core as BaseCore } from '@applitools/core-base';
 type Options<TSpec extends SpecType> = {
     spec?: SpecDriver<TSpec>;
     clients?: {
@@ -11,11 +11,11 @@ type Options<TSpec extends SpecType> = {
         nml?: NMLClient;
     };
     base?: BaseCore;
-    agentId?: string;
     concurrency?: number;
     fetchConcurrency?: number;
+    agentId?: string;
     cwd?: string;
     logger?: Logger;
 };
-export declare function makeCore<TSpec extends SpecType>({ concurrency, spec, clients, base, fetchConcurrency, agentId, cwd, logger: defaultLogger, }: Options<TSpec>): Core<TSpec>;
+export declare function makeCore<TSpec extends SpecType = never>({ spec, clients, base, concurrency, fetchConcurrency, agentId, cwd, logger: defaultLogger, }: Options<TSpec>): Core<TSpec>;
 export {};

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

@@ -8,12 +8,8 @@ type Options<TSpec extends SpecType> = {
     base?: BaseEyes[];
     logger: Logger;
 };
-export declare function makeGetBaseEyes<TSpec extends SpecType>({ settings: defaultSettings, eyes, base, logger: mainLogger, }: Options<TSpec>): (({ settings, logger, }?: {
-    settings?: GetBaseEyesSettings | undefined;
+export declare function makeGetBaseEyes<TSpec extends SpecType>({ settings: defaultSettings, eyes, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }: {
+    settings: GetBaseEyesSettings;
     logger?: Logger | undefined;
-}) => Promise<BaseEyes[]>) & {
-    getCachedValues(): Promise<BaseEyes[]>[];
-    setCachedValue(key: any, value: Promise<BaseEyes[]>): void;
-    clearCache(): void;
-};
+}) => Promise<BaseEyes>;
 export {};

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

@@ -1,5 +1,4 @@
-import type { DriverTarget, Core, Eyes, OpenSettings } from './types';
-import type { Eyes as BaseEyes } from '@applitools/core-base';
+import type { DriverTarget, Core, Eyes, EyesStorage, OpenSettings } from './types';
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
 type Options<TSpec extends SpecType> = {
@@ -7,10 +6,10 @@ type Options<TSpec extends SpecType> = {
     spec?: SpecDriver<TSpec>;
     logger: Logger;
 };
-export declare function makeOpenEyes<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): ({ target, settings, base, logger, }: {
+export declare function makeOpenEyes<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): ({ target, settings, storage, logger, }: {
     target?: DriverTarget<TSpec> | undefined;
     settings: OpenSettings;
-    base?: BaseEyes[] | undefined;
+    storage?: EyesStorage | undefined;
     logger?: Logger | undefined;
 }) => Promise<Eyes<TSpec>>;
 export {};

package/types/ufg/types.d.ts

@@ -1,10 +1,9 @@
 import type { MaybeArray } from '@applitools/utils';
-import type * as BaseCore from '@applitools/core-base/types';
 import type * as AutomationCore from '../automation/types';
 import { type SpecType } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
 import { type Proxy } from '@applitools/req';
-import { type UFGClient, type UFGClientSettings, type RenderEnvironmentSettings, type Renderer, type DomSnapshot, type AndroidSnapshot, type IOSSnapshot } from '@applitools/ufg-client';
+import { type UFGClient, type UFGClientSettings, type DomSnapshot, type AndroidSnapshot, type IOSSnapshot } from '@applitools/ufg-client';
 export * from '../automation/types';
 export type SnapshotTarget = MaybeArray<DomSnapshot> | MaybeArray<AndroidSnapshot> | MaybeArray<IOSSnapshot>;
 export type Target<TSpec extends SpecType> = SnapshotTarget | AutomationCore.Target<TSpec>;
@@ -17,39 +16,25 @@ export interface Core<TSpec extends SpecType> extends AutomationCore.Core<TSpec>
     openEyes(options: {
         target?: AutomationCore.DriverTarget<TSpec>;
         settings: AutomationCore.OpenSettings;
-        base?: BaseCore.Eyes[];
+        storage?: AutomationCore.EyesStorage;
         logger?: Logger;
     }): Promise<Eyes<TSpec>>;
 }
 export interface Eyes<TSpec extends SpecType> extends AutomationCore.Eyes<TSpec> {
     readonly type: 'ufg';
     readonly core: Core<TSpec>;
-    getBaseEyes(options?: {
-        settings?: GetBaseEyesSettings;
-        logger?: Logger;
-    }): Promise<BaseCore.Eyes[]>;
     check(options?: {
         target?: Target<TSpec>;
         settings?: CheckSettings<TSpec>;
         logger?: Logger;
-    }): Promise<CheckResult[]>;
+    }): Promise<void>;
     checkAndClose(options?: {
         target?: Target<TSpec>;
         settings?: CheckSettings<TSpec> & AutomationCore.CloseSettings;
         logger?: Logger;
     }): Promise<void>;
-    getResults(options?: {
-        settings?: AutomationCore.GetResultsSettings;
-        logger?: Logger;
-    }): Promise<TestResult[]>;
 }
-export type GetBaseEyesSettings = RenderEnvironmentSettings & {
-    properties?: BaseCore.CustomProperty[];
-};
 export type CheckSettings<TSpec extends SpecType> = AutomationCore.CheckSettings<TSpec> & {
-    renderers?: (Renderer & {
-        properties?: BaseCore.CustomProperty[];
-    })[];
     hooks?: {
         beforeCaptureScreenshot: string;
     };
@@ -65,9 +50,3 @@ export type CheckSettings<TSpec extends SpecType> = AutomationCore.CheckSettings
     };
     headers?: Record<string, string>;
 };
-export type CheckResult = AutomationCore.CheckResult & {
-    readonly renderer: Renderer;
-};
-export type TestResult = AutomationCore.TestResult & {
-    readonly renderer: Renderer;
-};

package/types/ufg/utils/extract-default-renderers.d.ts

@@ -0,0 +1,5 @@
+import type { Renderer } from '../types';
+import { type SpecType, type Driver } from '@applitools/driver';
+export declare function extractDefaultRenderers<TSpec extends SpecType>({ driver, }: {
+    driver?: Driver<TSpec>;
+}): Promise<Renderer[]>;

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

@@ -1,7 +1,7 @@
 import type { Size } from '@applitools/utils';
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type Driver } from '@applitools/driver';
-import { type DomSnapshot, type Renderer, type ChromeEmulationDevice, type IOSDevice, type ScreenOrientation } from '@applitools/ufg-client';
+import { type DomSnapshot, type Renderer } from '@applitools/ufg-client';
 import { type DomSnapshotSettings } from './take-dom-snapshot';
 export * from './take-dom-snapshot';
 export type DomSnapshotsSettings = DomSnapshotSettings & {
@@ -20,8 +20,8 @@ export declare function takeDomSnapshots<TSpec extends SpecType>({ driver, setti
         beforeEachSnapshot?(): void | Promise<void>;
     };
     provides?: {
-        getChromeEmulationDevices(): Promise<Record<ChromeEmulationDevice, Record<ScreenOrientation, Size>>>;
-        getIOSDevices(): Promise<Record<IOSDevice, Record<ScreenOrientation, Size>>>;
+        getChromeEmulationDevices(): Promise<Record<string, Record<string, Size>>>;
+        getIOSDevices(): Promise<Record<string, Record<string, Size>>>;
     };
     logger: Logger;
 }): Promise<DomSnapshot[]>;

package/dist/classic/abort.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeAbort = void 0;
-const driver_1 = require("@applitools/driver");
-function makeAbort({ eyes, target, spec, logger: mainLogger }) {
-    return async function abort({ settings, logger = mainLogger, } = {}) {
-        logger = logger.extend(mainLogger);
-        logger.log('Command "abort" is called with settings', settings);
-        settings !== null && settings !== void 0 ? settings : (settings = {});
-        if (!settings.testMetadata && (0, driver_1.isDriver)(target, spec)) {
-            try {
-                const driver = await (0, driver_1.makeDriver)({ spec, driver: target, relaxed: true, logger });
-                settings.testMetadata = await driver.getSessionMetadata();
-            }
-            catch (error) {
-                logger.warn('Command "abort" received an error during extracting driver metadata', error);
-            }
-        }
-        const baseEyes = await eyes.getBaseEyes();
-        await Promise.all(baseEyes.map(baseEyes => baseEyes.abort({ settings, logger })));
-    };
-}
-exports.makeAbort = makeAbort;

package/dist/classic/close.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeClose = void 0;
-const driver_1 = require("@applitools/driver");
-function makeClose({ eyes, target, spec, logger: mainLogger }) {
-    return async function close({ settings, logger = mainLogger, } = {}) {
-        logger = logger.extend(mainLogger);
-        logger.log('Command "close" is called with settings', settings);
-        settings !== null && settings !== void 0 ? settings : (settings = {});
-        if (!settings.testMetadata && (0, driver_1.isDriver)(target, spec)) {
-            try {
-                const driver = await (0, driver_1.makeDriver)({ spec, driver: target, relaxed: true, logger });
-                settings.testMetadata = await driver.getSessionMetadata();
-            }
-            catch (error) {
-                logger.warn('Command "close" received an error during extracting driver metadata', error);
-            }
-        }
-        const baseEyes = await eyes.getBaseEyes();
-        await Promise.all(baseEyes.map(baseEyes => baseEyes.close({ settings, logger })));
-    };
-}
-exports.makeClose = makeClose;

package/types/ufg/abort.d.ts

@@ -1,21 +0,0 @@
-import type { DriverTarget, AbortSettings } from './types';
-import { type Eyes as BaseEyes } from '@applitools/core-base';
-import { type Logger } from '@applitools/logger';
-import { type AbortController } from 'abort-controller';
-import { type SpecType, type SpecDriver } from '@applitools/driver';
-import { Renderer } from '@applitools/ufg-client';
-type Options<TSpec extends SpecType> = {
-    storage: Map<string, Promise<{
-        renderer: Renderer;
-        eyes: BaseEyes;
-    }>[]>;
-    controller: AbortController;
-    target?: DriverTarget<TSpec>;
-    spec?: SpecDriver<TSpec>;
-    logger: Logger;
-};
-export declare function makeAbort<TSpec extends SpecType>({ storage, target, spec, controller, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }?: {
-    settings?: AbortSettings | undefined;
-    logger?: Logger | undefined;
-}) => Promise<void>;
-export {};

package/types/ufg/close.d.ts

@@ -1,19 +0,0 @@
-import type { DriverTarget, CloseSettings } from './types';
-import { type Eyes as BaseEyes } from '@applitools/core-base';
-import { type Logger } from '@applitools/logger';
-import { type SpecType, type SpecDriver } from '@applitools/driver';
-import { Renderer } from '@applitools/ufg-client';
-type Options<TSpec extends SpecType> = {
-    storage: Map<string, Promise<{
-        renderer: Renderer;
-        eyes: BaseEyes;
-    }>[]>;
-    target?: DriverTarget<TSpec>;
-    spec?: SpecDriver<TSpec>;
-    logger: Logger;
-};
-export declare function makeClose<TSpec extends SpecType>({ storage, target, spec, logger: mainLogger }: Options<TSpec>): ({ settings, logger, }?: {
-    settings?: CloseSettings | undefined;
-    logger?: Logger | undefined;
-}) => Promise<void>;
-export {};

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

@@ -1,16 +0,0 @@
-import type { GetResultsSettings, TestResult } from './types';
-import { type Eyes as BaseEyes } from '@applitools/core-base';
-import { type Logger } from '@applitools/logger';
-import { Renderer } from '@applitools/ufg-client';
-type Options = {
-    storage: Map<string, Promise<{
-        renderer: Renderer;
-        eyes: BaseEyes;
-    }>[]>;
-    logger: Logger;
-};
-export declare function makeGetResults({ storage, logger: mainLogger }: Options): ({ settings, logger, }?: {
-    settings?: GetResultsSettings | undefined;
-    logger?: Logger | undefined;
-}) => Promise<TestResult[]>;
-export {};