@applitools/core 2.0.2 → 2.3.0

package/types/ufg/close.d.ts

@@ -1,19 +0,0 @@
-import type { DriverTarget, CloseSettings } from './types';
-import { type Logger } from '@applitools/logger';
-import { type SpecType, type SpecDriver } from '@applitools/driver';
-import { Renderer } from '@applitools/ufg-client';
-import { Eyes as baseEyes } from '@applitools/core-base';
-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: defaultLogger }: Options<TSpec>): ({ settings, logger, }?: {
-    settings?: CloseSettings | undefined;
-    logger?: Logger | undefined;
-}) => Promise<void>;
-export {};

package/types/ufg/core.d.ts

@@ -1,16 +0,0 @@
-import type { Core } from './types';
-import type { Core as BaseCore } from '@applitools/core-base';
-import { type UFGClient } from '@applitools/ufg-client';
-import { type SpecType, type SpecDriver } from '@applitools/driver';
-import { type Logger } from '@applitools/logger';
-type Options<TSpec extends SpecType> = {
-    concurrency: number;
-    spec?: SpecDriver<TSpec>;
-    client?: UFGClient;
-    core?: BaseCore;
-    agentId?: string;
-    cwd?: string;
-    logger?: Logger;
-};
-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

@@ -1,23 +0,0 @@
-import type { OpenSettings } from './types';
-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;
-    eyes?: EyesBase[];
-    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;
-    } | 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;
-    clearCache(): void;
-};
-export {};

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

@@ -1,16 +0,0 @@
-import type { GetResultsSettings, TestResult } from './types';
-import { type Logger } from '@applitools/logger';
-import { Renderer } from '@applitools/ufg-client';
-import { Eyes as baseEyes } from '@applitools/core-base';
-type Options = {
-    storage: Map<string, Promise<{
-        renderer: Renderer;
-        eyes: baseEyes;
-    }>[]>;
-    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 +0,0 @@
-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 SpecType, type SpecDriver } from '@applitools/driver';
-import { type UFGClient } from '@applitools/ufg-client';
-type Options<TSpec extends SpecType> = {
-    core: BaseCore;
-    client?: UFGClient;
-    spec?: SpecDriver<TSpec>;
-    logger: Logger;
-};
-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<import("@applitools/core-base").ImageTarget>[] | undefined;
-    logger?: Logger | undefined;
-}) => Promise<Eyes<TSpec>>;
-export {};

package/types/ufg/types.d.ts

@@ -1,71 +0,0 @@
-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 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<TSpec>;
-        settings: OpenSettings;
-        eyes?: BaseCore.Eyes[];
-        logger?: Logger;
-    }): Promise<TEyes>;
-}
-export interface Eyes<TSpec extends SpecType, TTarget = Target<TSpec>> extends AutomationCore.Eyes<TSpec, TTarget> {
-    readonly type: 'ufg';
-    getBaseEyes(options?: {
-        settings?: {
-            type: 'web' | 'native';
-            renderer: Renderer;
-        };
-        logger?: Logger;
-    }): Promise<BaseCore.Eyes[]>;
-    check(options?: {
-        target?: TTarget;
-        settings?: CheckSettings<TSpec>;
-        logger?: Logger;
-    }): Promise<CheckResult[]>;
-    checkAndClose(options?: {
-        target?: TTarget;
-        settings?: CheckSettings<TSpec> & AutomationCore.CloseSettings;
-        logger?: Logger;
-    }): Promise<TestResult[]>;
-    getResults(options?: {
-        settings?: AutomationCore.GetResultsSettings;
-        logger?: Logger;
-    }): Promise<TestResult[]>;
-}
-export type OpenSettings = AutomationCore.OpenSettings & {
-    renderConcurrency?: number;
-};
-export type CheckSettings<TSpec extends SpecType> = AutomationCore.CheckSettings<TSpec> & {
-    renderers?: Renderer[];
-    hooks?: {
-        beforeCaptureScreenshot: string;
-    };
-    disableBrowserFetching?: boolean;
-    layoutBreakpoints?: boolean | number[];
-    ufgOptions?: Record<string, any>;
-    nmgOptions?: Record<string, any>;
-    autProxy?: Proxy & {
-        mode?: 'Allow' | 'Block';
-        domains?: string[];
-    };
-};
-export type CheckResult = AutomationCore.CheckResult & {
-    readonly renderer: Renderer;
-    readonly promise: Promise<Omit<CheckResult, 'promise'> & {
-        eyes: BaseCore.Eyes;
-    }>;
-};
-export type TestResult = AutomationCore.TestResult & {
-    readonly renderer: Renderer;
-} & {
-    eyes: BaseCore.Eyes;
-};

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

@@ -1,6 +0,0 @@
-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,16 +0,0 @@
-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: 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,49 +0,0 @@
-import { type Logger } from '@applitools/logger';
-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[];
-    chunkByteLength?: number;
-    executionTimeout?: number;
-    pollTimeout?: number;
-    showLogs?: boolean;
-};
-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: RawDomSnapshot;
-}): DomSnapshot;
-export declare function extractCrossFrames({ snapshot, parent, logger, }: {
-    snapshot: RawDomSnapshot;
-    parent?: any;
-    logger: Logger;
-}): {
-    cdtNode: RawDomSnapshot['cdt'][number];
-    reference: any;
-    parentSnapshot: RawDomSnapshot;
-}[];
-export {};

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

@@ -1,24 +0,0 @@
-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 DomSnapshotSettings } from './take-dom-snapshot';
-export * from './take-dom-snapshot';
-export type DomSnapshotsSettings = DomSnapshotSettings & {
-    renderers: Renderer[];
-    waitBeforeCapture?: number | (() => void);
-    layoutBreakpoints?: number[] | boolean;
-};
-export declare function takeDomSnapshots<TSpec extends SpecType>({ driver, settings, hooks, provides, logger, }: {
-    driver: Driver<TSpec>;
-    settings: DomSnapshotsSettings;
-    hooks?: {
-        beforeSnapshots?(): void | Promise<void>;
-        beforeEachSnapshot?(): void | Promise<void>;
-    };
-    provides?: {
-        getChromeEmulationDevices(): Promise<Record<ChromeEmulationDevice, Record<ScreenOrientation, Size>>>;
-        getIOSDevices(): Promise<Record<IOSDevice, Record<ScreenOrientation, Size>>>;
-    };
-    logger: Logger;
-}): Promise<DomSnapshot[]>;

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

@@ -1,21 +0,0 @@
-import type { Size } from '@applitools/utils';
-import { type Logger } from '@applitools/logger';
-import { type SpecType, type Driver } from '@applitools/driver';
-import { type DomSnapshot, type AndroidSnapshot, type IOSSnapshot, type ChromeEmulationDevice, type IOSDevice, type ScreenOrientation } from '@applitools/ufg-client';
-import { type DomSnapshotsSettings } from './take-dom-snapshots';
-import { type VHSesSettings } from './take-vhses';
-export * from './take-dom-snapshots';
-export * from './take-vhses';
-export declare function takeSnapshots<TSpec extends SpecType>({ driver, settings, hooks, provides, logger, }: {
-    driver: Driver<TSpec>;
-    settings: DomSnapshotsSettings & VHSesSettings;
-    hooks: {
-        beforeSnapshots?(): void | Promise<void>;
-        beforeEachSnapshot?(): void | Promise<void>;
-    };
-    provides: {
-        getChromeEmulationDevices(): Promise<Record<ChromeEmulationDevice, Record<ScreenOrientation, Size>>>;
-        getIOSDevices(): Promise<Record<IOSDevice, Record<ScreenOrientation, Size>>>;
-    };
-    logger: Logger;
-}): Promise<DomSnapshot[] | AndroidSnapshot[] | IOSSnapshot[]>;

package/types/ufg/utils/take-vhses.d.ts

@@ -1,17 +0,0 @@
-import type { ServerSettings } from '../types';
-import { type Logger } from '@applitools/logger';
-import { type SpecType, type Driver } from '@applitools/driver';
-import { type Renderer, type AndroidSnapshot, type IOSSnapshot } from '@applitools/ufg-client';
-export type VHSesSettings = ServerSettings & {
-    renderers: Renderer[];
-    waitBeforeCapture?: number;
-};
-export declare function takeVHSes<TSpec extends SpecType>({ driver, settings, hooks, logger, }: {
-    driver: Driver<TSpec>;
-    settings: VHSesSettings;
-    hooks?: {
-        beforeSnapshots?(): void | Promise<void>;
-        beforeEachSnapshot?(): void | Promise<void>;
-    };
-    logger: Logger;
-}): Promise<AndroidSnapshot[] | IOSSnapshot[]>;

package/types/ufg/utils/uniquify-renderers.d.ts

@@ -1,2 +0,0 @@
-import { type Renderer } from '@applitools/ufg-client';
-export declare function uniquifyRenderers(renderers: Renderer[]): Renderer[];

package/types/utils/extract-ci-provider.d.ts

@@ -1 +0,0 @@
-export declare function extractCIProvider(): string | null;

package/types/utils/format-results.d.ts

@@ -1,16 +0,0 @@
-import type { TestResult } from '@applitools/core-base';
-export declare function toFormatterString(results: TestResult[], { includeSubTests, markNewAsPassed }?: {
-    includeSubTests?: boolean;
-    markNewAsPassed?: boolean;
-}): string;
-export declare function toHierarchicTAPString(results: TestResult[], { includeSubTests, markNewAsPassed }?: {
-    includeSubTests?: boolean;
-    markNewAsPassed?: boolean;
-}): string;
-export declare function toFlattenedTAPString(results: TestResult[], { markNewAsPassed }?: {
-    markNewAsPassed?: boolean;
-}): string;
-export declare function toXmlOutput(results: TestResult[], { totalTime }?: {
-    totalTime?: number;
-}): string;
-export declare function toJsonOutput(results: TestResult[], space?: number | string): string;