@applitools/core 1.4.6 → 2.0.0

package/types/types.d.ts

@@ -3,131 +3,111 @@ import type { ECClient } from '@applitools/ec-client';
 import type * as AutomationCore from './automation/types';
 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';
-export * from '@applitools/core-base/types';
+export { ECClient };
 export * from './automation/types';
-export type TypedCore<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.Core<TDriver, TContext, TElement, TSelector> : ClassicCore.Core<TDriver, TContext, TElement, TSelector>;
-export type TypedEyes<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg', TTarget = Target<TDriver, TContext, TElement, TSelector, TType>> = TType extends 'ufg' ? UFGCore.Eyes<TDriver, TContext, TElement, TSelector, TTarget> : ClassicCore.Eyes<TDriver, TContext, TElement, TSelector, TTarget>;
-export type Target<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.UFGTarget<TDriver, TContext, TElement, TSelector> : ClassicCore.ClassicTarget<TDriver, TContext, TElement, TSelector>;
-export interface Core<TDriver, TContext, TElement, TSelector> extends AutomationCore.Core<TDriver, TContext, TElement, TSelector> {
+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', TTarget = Target<TSpec, TType>> = TType extends 'ufg' ? UFGCore.Eyes<TSpec, TTarget> : ClassicCore.Eyes<TSpec, TTarget>;
+export type Target<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.Target<TSpec> : ClassicCore.Target<TSpec>;
+export interface Core<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'> extends AutomationCore.Core<TSpec> {
     makeECClient(options?: {
         settings?: any;
         logger?: Logger;
     }): Promise<ECClient>;
-    makeManager<TType extends 'classic' | 'ufg' = 'classic'>(options?: {
+    makeManager<TType extends 'classic' | 'ufg' = TDefaultType>(options?: {
         type: TType;
         concurrency?: TType extends 'ufg' ? number : never;
         agentId?: string;
         logger?: Logger;
-    }): Promise<EyesManager<TDriver, TContext, TElement, TSelector, TType>>;
-    openEyes<TType extends 'classic' | 'ufg' = 'classic'>(options: {
+    }): Promise<EyesManager<TSpec, TType>>;
+    openEyes<TType extends 'classic' | 'ufg' = TDefaultType>(options: {
         type?: TType;
-        target?: AutomationCore.DriverTarget<TDriver, TContext, TElement, TSelector>;
+        target?: AutomationCore.DriverTarget<TSpec>;
         settings?: Partial<OpenSettings<TType>>;
-        config?: Config<TElement, TSelector, TType>;
+        config?: Config<TSpec, TType>;
         logger?: Logger;
-    }): Promise<Eyes<TDriver, TContext, TElement, TSelector, TType>>;
+    }): Promise<Eyes<TSpec, TType>>;
     locate<TLocator extends string>(options: {
-        target?: AutomationCore.DriverTarget<TDriver, TContext, TElement, TSelector> | AutomationCore.ImageTarget;
-        settings?: Partial<LocateSettings<TLocator, TElement, TSelector>>;
-        config?: Config<TElement, TSelector, 'classic'>;
+        target?: AutomationCore.Target<TSpec>;
+        settings?: Partial<AutomationCore.LocateSettings<TLocator, TSpec>>;
+        config?: Config<TSpec, TDefaultType>;
         logger?: Logger;
     }): Promise<AutomationCore.LocateResult<TLocator>>;
-}
-export interface EyesManager<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> {
-    openEyes(options: {
-        target?: TDriver;
-        settings?: Partial<OpenSettings<TType>>;
-        config?: Config<TElement, TSelector, TType>;
-        logger?: Logger;
-    }): Promise<Eyes<TDriver, TContext, TElement, TSelector, TType>>;
-    closeManager: (options?: {
-        settings?: {
-            throwErr?: boolean;
-        };
-        logger?: Logger;
-    }) => Promise<TestResultSummary<TType>>;
-}
-export interface ClassicEyes<TDriver, TContext, TElement, TSelector, TTarget = Target<TDriver, TContext, TElement, TSelector, 'classic'>> extends ClassicCore.Eyes<TDriver, TContext, TElement, TSelector, TTarget> {
-    getTypedEyes<TType extends 'classic' | 'ufg' = 'classic'>(options?: {
-        type?: TType;
-        logger?: Logger;
-    }): Promise<TypedEyes<TDriver, TContext, TElement, TSelector, TType>>;
-    check<TType extends 'classic' | 'ufg' = 'classic'>(options?: {
-        type?: TType;
-        target?: TTarget;
-        settings?: Partial<CheckSettings<TElement, TSelector, 'classic'> & CheckSettings<TElement, TSelector, TType>>;
-        config?: Config<TElement, TSelector, 'classic'> & Config<TElement, TSelector, TType>;
-        logger?: Logger;
-    }): Promise<CheckResult<TType>[]>;
-    checkAndClose<TType extends 'classic' | 'ufg' = 'classic'>(options?: {
-        type?: TType;
-        target?: TTarget;
-        settings?: Partial<CheckSettings<TElement, TSelector, 'classic'> & CloseSettings<'classic'> & CheckSettings<TElement, TSelector, TType> & CloseSettings<TType>>;
-        config?: Config<TElement, TSelector, 'classic'> & Config<TElement, TSelector, TType>;
-        logger?: Logger;
-    }): Promise<TestResult<TType>[]>;
     locateText<TPattern extends string>(options: {
-        target?: TTarget;
-        settings: Partial<LocateTextSettings<TPattern, TElement, TSelector, 'classic'>>;
-        config?: Config<TElement, TSelector, 'classic'>;
+        target?: AutomationCore.Target<TSpec>;
+        settings: Partial<AutomationCore.LocateTextSettings<TPattern, TSpec>>;
+        config?: Config<TSpec, TDefaultType>;
         logger?: Logger;
     }): Promise<AutomationCore.LocateTextResult<TPattern>>;
     extractText(options: {
-        target?: TTarget;
-        settings: MaybeArray<Partial<ExtractTextSettings<TElement, TSelector, 'classic'>>>;
-        config?: Config<TElement, TSelector, 'classic'>;
+        target?: AutomationCore.Target<TSpec>;
+        settings: MaybeArray<Partial<AutomationCore.ExtractTextSettings<TSpec>>>;
+        config?: Config<TSpec, TDefaultType>;
         logger?: Logger;
     }): Promise<string[]>;
-    close(options?: {
-        settings?: Partial<CloseSettings<'classic'>>;
-        config?: Config<TElement, TSelector, 'classic'>;
+}
+export interface EyesManager<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'> {
+    openEyes<TType extends 'classic' | 'ufg' = TDefaultType>(options: {
+        type?: TType;
+        target?: AutomationCore.DriverTarget<TSpec>;
+        settings?: Partial<OpenSettings<TType>>;
+        config?: Config<TSpec, TType>;
+        logger?: Logger;
+    }): Promise<Eyes<TSpec, TType>>;
+    getResults: (options?: {
+        settings?: GetResultsSettings<TDefaultType>;
         logger?: Logger;
-    }): Promise<TestResult<'classic'>[]>;
+    }) => Promise<TestResultSummary<'classic' | 'ufg'>>;
 }
-export interface UFGEyes<TDriver, TContext, TElement, TSelector, TTarget = Target<TDriver, TContext, TElement, TSelector, 'ufg'>> extends UFGCore.Eyes<TDriver, TContext, TElement, TSelector, TTarget> {
-    getTypedEyes<TType extends 'classic' | 'ufg' = 'classic'>(options?: {
+export interface Eyes<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg', TTarget = Target<TSpec, TDefaultType>> extends AutomationCore.Eyes<TSpec> {
+    getTypedEyes<TType extends 'classic' | 'ufg' = TDefaultType>(options?: {
         type?: TType;
-        settings?: {
-            type: 'web' | 'native';
-            renderers: Renderer[];
-        };
+        settings?: any;
         logger?: Logger;
-    }): Promise<TypedEyes<TDriver, TContext, TElement, TSelector, TType>>;
-    check<TType extends 'classic' | 'ufg' = 'ufg'>(options?: {
+    }): Promise<TypedEyes<TSpec, TType>>;
+    check<TType extends 'classic' | 'ufg' = TDefaultType>(options?: {
         type?: TType;
         target?: TTarget;
-        settings?: Partial<CheckSettings<TElement, TSelector, 'ufg'> & CheckSettings<TElement, TSelector, TType>>;
-        config?: Config<TElement, TSelector, 'ufg'> & Config<TElement, TSelector, TType>;
+        settings?: Partial<CheckSettings<TSpec, TDefaultType> & CheckSettings<TSpec, TType>>;
+        config?: Config<TSpec, TDefaultType> & Config<TSpec, TType>;
         logger?: Logger;
     }): Promise<CheckResult<TType>[]>;
-    checkAndClose<TType extends 'classic' | 'ufg' = 'ufg'>(options?: {
+    checkAndClose<TType extends 'classic' | 'ufg' = TDefaultType>(options?: {
         type?: TType;
         target?: TTarget;
-        settings?: Partial<CheckSettings<TElement, TSelector, 'ufg'> & CloseSettings<'ufg'> & CheckSettings<TElement, TSelector, TType> & CloseSettings<TType>>;
-        config?: Config<TElement, TSelector, 'ufg'> & Config<TElement, TSelector, TType>;
+        settings?: Partial<CheckSettings<TSpec, TDefaultType> & CloseSettings<TDefaultType> & CheckSettings<TSpec, TType> & CloseSettings<TType>>;
+        config?: Config<TSpec, TDefaultType> & Config<TSpec, TType>;
         logger?: Logger;
     }): Promise<TestResult<TType>[]>;
     close(options?: {
-        settings?: Partial<CloseSettings<'ufg'>>;
-        config?: Config<TElement, TSelector, 'ufg'>;
+        settings?: Partial<CloseSettings<TDefaultType>>;
+        config?: Config<TSpec, TDefaultType>;
+        logger?: Logger;
+    }): Promise<void>;
+    abort(options?: {
+        settings?: Partial<AbortSettings<TDefaultType>>;
+        config?: Config<TSpec, TDefaultType>;
+        logger?: Logger;
+    }): Promise<void>;
+    getResults(options?: {
+        settings?: Partial<GetResultsSettings<TDefaultType>>;
+        config?: Config<TSpec, TDefaultType>;
         logger?: Logger;
-    }): Promise<TestResult<'ufg'>[]>;
+    }): Promise<TestResult<TDefaultType>[]>;
 }
-export type Eyes<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg', TTarget = Target<TDriver, TContext, TElement, TSelector, TType>> = TType extends 'ufg' ? UFGEyes<TDriver, TContext, TElement, TSelector, TTarget> : ClassicEyes<TDriver, TContext, TElement, TSelector, TTarget>;
-export type Config<TElement, TSelector, TType extends 'classic' | 'ufg'> = {
-    open: Partial<OpenSettings<TType>>;
-    screenshot: Partial<ClassicCore.ScreenshotSettings<TElement, TSelector>>;
-    check: Partial<Omit<CheckSettings<TElement, TSelector, TType>, keyof ClassicCore.ScreenshotSettings<TElement, TSelector>>>;
-    close: Partial<CloseSettings<TType>>;
+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'>>;
+    close: Partial<Omit<CloseSettings<TType>, 'userCommandId'>>;
 };
-export type LocateSettings<TLocator extends string, TElement, TSelector> = AutomationCore.LocateSettings<TLocator, TElement, TSelector>;
 export type OpenSettings<TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.OpenSettings : ClassicCore.OpenSettings;
-export type CheckSettings<TElement, TSelector, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.CheckSettings<TElement, TSelector> : ClassicCore.CheckSettings<TElement, TSelector>;
-export type LocateTextSettings<TPattern extends string, TElement, TSelector, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.LocateTextSettings<TPattern, TElement, TSelector> : ClassicCore.LocateTextSettings<TPattern, TElement, TSelector>;
-export type ExtractTextSettings<TElement, TSelector, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.ExtractTextSettings<TElement, TSelector> : ClassicCore.ExtractTextSettings<TElement, TSelector>;
-export type CloseSettings<TType extends 'classic' | 'ufg'> = (TType extends 'ufg' ? UFGCore.CloseSettings : ClassicCore.CloseSettings) & {
+export type CheckSettings<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.CheckSettings<TSpec> : ClassicCore.CheckSettings<TSpec>;
+export type CloseSettings<TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.CloseSettings : ClassicCore.CloseSettings;
+export type AbortSettings<TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.AbortSettings : ClassicCore.AbortSettings;
+export type GetResultsSettings<TType extends 'classic' | 'ufg'> = (TType extends 'ufg' ? UFGCore.GetResultsSettings : ClassicCore.GetResultsSettings) & {
     throwErr?: boolean;
 };
 export type CheckResult<TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.CheckResult : ClassicCore.CheckResult;

package/types/ufg/abort.d.ts

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

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

@@ -1,21 +1,33 @@
-import type { DriverTarget, UFGTarget, Eyes, CheckSettings, TestResult, CloseSettings } from './types';
-import { type DomSnapshot, type AndroidSnapshot, type IOSSnapshot } from '@applitools/ufg-client';
+import type { Region } from '@applitools/utils';
+import type { DriverTarget, Target, Eyes, CheckSettings, TestResult, CloseSettings } from './types';
 import { type AbortSignal } from 'abort-controller';
 import { type Logger } from '@applitools/logger';
 import { type UFGClient } from '@applitools/ufg-client';
-import { type SpecDriver } from '@applitools/driver';
-type Options<TDriver, TContext, TElement, TSelector> = {
-    eyes: Eyes<TDriver, TContext, TElement, TSelector>;
+import { type SpecType, type SpecDriver } from '@applitools/driver';
+type Options<TSpec extends SpecType> = {
+    eyes: Eyes<TSpec>;
     client: UFGClient;
-    target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
-    spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
+    target?: DriverTarget<TSpec>;
+    spec?: SpecDriver<TSpec>;
     signal?: AbortSignal;
-    logger?: Logger;
+    logger: Logger;
 };
-export declare function makeCheckAndClose<TDriver, TContext, TElement, TSelector>({ spec, eyes, client, signal, target: defaultTarget, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, snapshots, }: {
-    target?: UFGTarget<TDriver, TContext, TElement, TSelector>;
-    settings?: CheckSettings<TElement, TSelector> & CloseSettings;
-    logger?: Logger;
-    snapshots?: DomSnapshot[] | AndroidSnapshot[] | IOSSnapshot[];
+export declare function makeCheckAndClose<TSpec extends SpecType>({ spec, eyes, client, signal, target: defaultTarget, logger: defaultLogger, }: 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?: import("@applitools/ufg-client").Renderer[] | undefined;
+        hooks?: {
+            beforeCaptureScreenshot: string;
+        } | undefined;
+        disableBrowserFetching?: boolean | undefined;
+        layoutBreakpoints?: boolean | number[] | undefined;
+        ufgOptions?: Record<string, any> | undefined;
+        nmgOptions?: Record<string, any> | undefined;
+        autProxy?: (import("@applitools/req").Proxy & {
+            mode?: "Allow" | "Block" | undefined;
+            domains?: string[] | undefined;
+        }) | undefined;
+    } & CloseSettings) | undefined;
+    logger?: Logger | undefined;
 }) => Promise<TestResult[]>;
 export {};

package/types/ufg/check.d.ts

@@ -1,19 +1,19 @@
-import type { DriverTarget, UFGTarget, Eyes, CheckSettings, CheckResult } from './types';
+import type { DriverTarget, Target, Eyes, CheckSettings, CheckResult } from './types';
 import { type AbortSignal } from 'abort-controller';
 import { type Logger } from '@applitools/logger';
 import { type UFGClient } from '@applitools/ufg-client';
-import { type SpecDriver } from '@applitools/driver';
-type Options<TDriver, TContext, TElement, TSelector> = {
-    eyes: Eyes<TDriver, TContext, TElement, TSelector>;
+import { type SpecType, type SpecDriver } from '@applitools/driver';
+type Options<TSpec extends SpecType> = {
+    eyes: Eyes<TSpec>;
     client: UFGClient;
-    target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
-    spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
+    target?: DriverTarget<TSpec>;
+    spec?: SpecDriver<TSpec>;
     signal?: AbortSignal;
-    logger?: Logger;
+    logger: Logger;
 };
-export declare function makeCheck<TDriver, TContext, TElement, TSelector>({ eyes, client, target: defaultTarget, spec, signal, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, }: {
-    settings?: CheckSettings<TElement, TSelector>;
-    target?: UFGTarget<TDriver, TContext, TElement, TSelector>;
-    logger?: Logger;
+export declare function makeCheck<TSpec extends SpecType>({ eyes, client, target: defaultTarget, spec, signal, logger: defaultLogger, }: Options<TSpec>): ({ target, settings, logger, }: {
+    settings?: CheckSettings<TSpec> | undefined;
+    target?: Target<TSpec> | undefined;
+    logger?: Logger | undefined;
 }) => Promise<CheckResult[]>;
 export {};

package/types/ufg/close.d.ts

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

package/types/ufg/core.d.ts

@@ -1,16 +1,16 @@
 import type { Core } from './types';
 import type { Core as BaseCore } from '@applitools/core-base';
 import { type UFGClient } from '@applitools/ufg-client';
-import { type SpecDriver } from '@applitools/driver';
+import { type SpecType, type SpecDriver } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
-type Options<TDriver, TContext, TElement, TSelector> = {
+type Options<TSpec extends SpecType> = {
     concurrency: number;
-    spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
+    spec?: SpecDriver<TSpec>;
     client?: UFGClient;
     core?: BaseCore;
     agentId?: string;
     cwd?: string;
     logger?: Logger;
 };
-export declare function makeCore<TDriver, TContext, TElement, TSelector>({ concurrency, spec, client, core, agentId, cwd, logger, }: Options<TDriver, TContext, TElement, TSelector>): Core<TDriver, TContext, TElement, TSelector>;
+export declare function makeCore<TSpec extends SpecType>({ concurrency, spec, client, core, agentId, cwd, logger, }: Options<TSpec>): Core<TSpec>;
 export {};

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

@@ -3,18 +3,18 @@ import type { Core as CoreBase, Eyes as EyesBase } from '@applitools/core-base';
 import { type Logger } from '@applitools/logger';
 import { type UFGClient, type Renderer } from '@applitools/ufg-client';
 type Options = {
-    settings?: OpenSettings;
+    settings: OpenSettings;
     eyes?: EyesBase[];
-    core?: CoreBase;
-    client?: UFGClient;
-    logger?: Logger;
+    core: CoreBase;
+    client: UFGClient;
+    logger: Logger;
 };
 export declare function makeGetBaseEyes({ settings: defaultSettings, core, client, eyes, logger: defaultLogger }: Options): (({ settings, logger, }?: {
     settings?: {
         type: 'web' | 'native';
         renderer: Renderer;
-    };
-    logger?: Logger;
+    } | undefined;
+    logger?: Logger | undefined;
 }) => Promise<EyesBase[]>) & {
     getCachedValues(): Promise<EyesBase<import("@applitools/core-base").ImageTarget>[]>[];
     setCachedValue(key: any, value: Promise<EyesBase<import("@applitools/core-base").ImageTarget>[]>): void;

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

@@ -0,0 +1,11 @@
+import type { GetResultsSettings, CheckResult, TestResult } from './types';
+import { type Logger } from '@applitools/logger';
+type Options = {
+    storage: Map<string, CheckResult['promise'][]>;
+    logger: Logger;
+};
+export declare function makeGetResults({ storage, logger: defaultLogger }: Options): ({ settings, logger, }?: {
+    settings?: GetResultsSettings | undefined;
+    logger?: Logger | undefined;
+}) => Promise<TestResult[]>;
+export {};

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

@@ -1,18 +1,18 @@
 import type { DriverTarget, Eyes, OpenSettings } from './types';
 import type { Core as BaseCore, Eyes as BaseEyes } from '@applitools/core-base';
 import { type Logger } from '@applitools/logger';
-import { type SpecDriver } from '@applitools/driver';
+import { type SpecType, type SpecDriver } from '@applitools/driver';
 import { type UFGClient } from '@applitools/ufg-client';
-type Options<TDriver, TContext, TElement, TSelector> = {
+type Options<TSpec extends SpecType> = {
     core: BaseCore;
     client?: UFGClient;
-    spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
-    logger?: Logger;
+    spec?: SpecDriver<TSpec>;
+    logger: Logger;
 };
-export declare function makeOpenEyes<TDriver, TContext, TElement, TSelector>({ core, client, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, eyes, logger, }: {
-    target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
+export declare function makeOpenEyes<TSpec extends SpecType>({ core, client, spec, logger: defaultLogger }: Options<TSpec>): ({ target, settings, eyes, logger, }: {
+    target?: DriverTarget<TSpec> | undefined;
     settings: OpenSettings;
-    eyes?: BaseEyes[];
-    logger?: Logger;
-}) => Promise<Eyes<TDriver, TContext, TElement, TSelector>>;
+    eyes?: BaseEyes<import("@applitools/core-base").ImageTarget>[] | undefined;
+    logger?: Logger | undefined;
+}) => Promise<Eyes<TSpec>>;
 export {};

package/types/ufg/types.d.ts

@@ -1,22 +1,23 @@
 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 Renderer, 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 UFGTarget<TDriver, TContext, TElement, TSelector> = AutomationCore.DriverTarget<TDriver, TContext, TElement, TSelector> | SnapshotTarget;
-export interface Core<TDriver, TContext, TElement, TSelector, TEyes = Eyes<TDriver, TContext, TElement, TSelector>> extends AutomationCore.Core<TDriver, TContext, TElement, TSelector, TEyes> {
+export type Target<TSpec extends SpecType> = SnapshotTarget | AutomationCore.Target<TSpec>;
+export interface Core<TSpec extends SpecType, TTarget = AutomationCore.Target<TSpec>, TEyes extends Eyes<TSpec, TTarget | SnapshotTarget> = Eyes<TSpec, TTarget | SnapshotTarget>> extends AutomationCore.Core<TSpec, TTarget, TEyes> {
     readonly type: 'ufg';
     openEyes(options: {
-        target?: AutomationCore.DriverTarget<TDriver, TContext, TElement, TSelector>;
+        target?: AutomationCore.DriverTarget<TSpec>;
         settings: OpenSettings;
         eyes?: BaseCore.Eyes[];
         logger?: Logger;
     }): Promise<TEyes>;
 }
-export interface Eyes<TDriver, TContext, TElement, TSelector, TTarget = UFGTarget<TDriver, TContext, TElement, TSelector>> extends AutomationCore.Eyes<TDriver, TContext, TElement, TSelector, TTarget> {
+export interface Eyes<TSpec extends SpecType, TTarget = Target<TSpec>> extends AutomationCore.Eyes<TSpec, TTarget> {
     readonly type: 'ufg';
     getBaseEyes(options?: {
         settings?: {
@@ -27,28 +28,23 @@ export interface Eyes<TDriver, TContext, TElement, TSelector, TTarget = UFGTarge
     }): Promise<BaseCore.Eyes[]>;
     check(options?: {
         target?: TTarget;
-        settings?: CheckSettings<TElement, TSelector>;
+        settings?: CheckSettings<TSpec>;
         logger?: Logger;
     }): Promise<CheckResult[]>;
     checkAndClose(options?: {
         target?: TTarget;
-        settings?: CheckSettings<TElement, TSelector> & AutomationCore.CloseSettings;
+        settings?: CheckSettings<TSpec> & AutomationCore.CloseSettings;
         logger?: Logger;
     }): Promise<TestResult[]>;
-    locateText?: never;
-    extractText?: never;
-    close(options?: {
-        settings?: AutomationCore.CloseSettings;
-        logger?: Logger;
-    }): Promise<TestResult[]>;
-    abort(options?: {
+    getResults(options?: {
+        settings?: AutomationCore.GetResultsSettings;
         logger?: Logger;
     }): Promise<TestResult[]>;
 }
 export type OpenSettings = AutomationCore.OpenSettings & {
     renderConcurrency?: number;
 };
-export type CheckSettings<TElement, TSelector> = AutomationCore.CheckSettings<TElement, TSelector> & {
+export type CheckSettings<TSpec extends SpecType> = AutomationCore.CheckSettings<TSpec> & {
     renderers?: Renderer[];
     hooks?: {
         beforeCaptureScreenshot: string;
@@ -63,11 +59,11 @@ export type CheckSettings<TElement, TSelector> = AutomationCore.CheckSettings<TE
     };
 };
 export type CheckResult = AutomationCore.CheckResult & {
-    readonly renderer?: Renderer;
-    readonly promise?: Promise<Omit<CheckResult, 'promise'> & {
+    readonly renderer: Renderer;
+    readonly promise: Promise<Omit<CheckResult, 'promise'> & {
         eyes: BaseCore.Eyes;
     }>;
 };
 export type TestResult = AutomationCore.TestResult & {
-    readonly renderer?: Renderer;
+    readonly renderer: Renderer;
 };

package/types/ufg/utils/extract-broker-url.d.ts

@@ -0,0 +1,6 @@
+import { type SpecType, type Driver } from '@applitools/driver';
+import { type Logger } from '@applitools/logger';
+export declare function extractBrokerUrl<TSpec extends SpecType>({ driver, logger, }: {
+    driver: Driver<TSpec>;
+    logger: Logger;
+}): Promise<string | null>;

package/types/ufg/utils/generate-safe-selectors.d.ts

@@ -1,12 +1,16 @@
-import { type Context, type Selector } from '@applitools/driver';
-export declare function generateSafeSelectors<TElement, TSelector>({ context, elementReferences, }: {
-    context: Context<unknown, unknown, TElement, TSelector>;
-    elementReferences: (TElement | Selector<TSelector>)[];
+import { type SpecType, type Context, type ElementReference, type CommonSelector } from '@applitools/driver';
+export declare function generateSafeSelectors<TSpec extends SpecType>({ context, elementReferences, }: {
+    context: Context<TSpec>;
+    elementReferences: ElementReference<TSpec>[];
 }): Promise<{
-    selectors: {
-        safeSelector: Selector;
-        originalSelector: Selector;
-        elementReference: TElement | Selector<TSelector>;
-    }[];
-    cleanupGeneratedSelectors(): Promise<void>;
+    selectors: ({
+        safeSelector: null;
+        originalSelector: null;
+        elementReference: ElementReference<TSpec>;
+    } | {
+        safeSelector: CommonSelector<never>;
+        originalSelector: import("@applitools/driver").Selector<never> | null;
+        elementReference: ElementReference<TSpec>;
+    })[];
+    cleanupGeneratedSelectors: () => Promise<void>;
 }>;

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

@@ -1,6 +1,26 @@
 import { type Logger } from '@applitools/logger';
-import { type Context } from '@applitools/driver';
+import { type SpecType, type Context } from '@applitools/driver';
 import { type DomSnapshot } from '@applitools/ufg-client';
+type RawDomSnapshot = {
+    url: string;
+    selector: string;
+    cdt: {
+        attributes: {
+            name: string;
+            value: string;
+        }[];
+    }[];
+    crossFrames: {
+        selector: string;
+        index: number;
+    }[];
+    frames: RawDomSnapshot[];
+    resourceUrls: string[];
+    blobs: {
+        url: string;
+        value: string;
+    }[];
+};
 export type DomSnapshotSettings = {
     disableBrowserFetching?: boolean;
     skipResources?: string[];
@@ -9,16 +29,21 @@ export type DomSnapshotSettings = {
     pollTimeout?: number;
     showLogs?: boolean;
 };
-export declare function takeDomSnapshot<TContext extends Context<unknown, unknown, unknown, unknown>>({ context, settings, logger, }: {
-    context: TContext;
+export declare function takeDomSnapshot<TSpec extends SpecType>({ context, settings, logger, }: {
+    context: Context<TSpec>;
     settings?: DomSnapshotSettings;
     logger: Logger;
 }): Promise<DomSnapshot>;
 export declare function deserializeDomSnapshot({ snapshot }: {
-    snapshot: any;
-}): any;
-export declare function extractCrossFrames({ snapshot, parent, logger }: {
-    snapshot: any;
+    snapshot: RawDomSnapshot;
+}): DomSnapshot;
+export declare function extractCrossFrames({ snapshot, parent, logger, }: {
+    snapshot: RawDomSnapshot;
     parent?: any;
-    logger: any;
-}): any[];
+    logger: Logger;
+}): {
+    cdtNode: RawDomSnapshot['cdt'][number];
+    reference: any;
+    parentSnapshot: RawDomSnapshot;
+}[];
+export {};