@applitools/core 1.4.6 → 2.0.0

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

@@ -1,6 +1,6 @@
 import type { Size } from '@applitools/utils';
 import { type Logger } from '@applitools/logger';
-import { type Driver } from '@applitools/driver';
+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';
@@ -9,8 +9,8 @@ export type DomSnapshotsSettings = DomSnapshotSettings & {
     waitBeforeCapture?: number | (() => void);
     layoutBreakpoints?: number[] | boolean;
 };
-export declare function takeDomSnapshots<TDriver extends Driver<unknown, unknown, unknown, unknown>>({ driver, settings, hooks, provides, logger, }: {
-    driver: TDriver;
+export declare function takeDomSnapshots<TSpec extends SpecType>({ driver, settings, hooks, provides, logger, }: {
+    driver: Driver<TSpec>;
     settings: DomSnapshotsSettings;
     hooks?: {
         beforeSnapshots?(): void | Promise<void>;

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

@@ -1,13 +1,13 @@
 import type { Size } from '@applitools/utils';
 import { type Logger } from '@applitools/logger';
-import { type Driver } from '@applitools/driver';
+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<TDriver extends Driver<unknown, unknown, unknown, unknown>>({ driver, settings, hooks, provides, logger, }: {
-    driver: TDriver;
+export declare function takeSnapshots<TSpec extends SpecType>({ driver, settings, hooks, provides, logger, }: {
+    driver: Driver<TSpec>;
     settings: DomSnapshotsSettings & VHSesSettings;
     hooks: {
         beforeSnapshots?(): void | Promise<void>;
@@ -17,5 +17,5 @@ export declare function takeSnapshots<TDriver extends Driver<unknown, unknown, u
         getChromeEmulationDevices(): Promise<Record<ChromeEmulationDevice, Record<ScreenOrientation, Size>>>;
         getIOSDevices(): Promise<Record<IOSDevice, Record<ScreenOrientation, Size>>>;
     };
-    logger?: Logger;
+    logger: Logger;
 }): Promise<DomSnapshot[] | AndroidSnapshot[] | IOSSnapshot[]>;

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

@@ -1,14 +1,14 @@
 import type { ServerSettings } from '../types';
 import { type Logger } from '@applitools/logger';
-import { type Driver } from '@applitools/driver';
+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<TDriver extends Driver<unknown, unknown, unknown, unknown>>({ driver, settings, hooks, logger, }: {
-    driver: TDriver;
-    settings?: VHSesSettings;
+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>;

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

@@ -13,4 +13,4 @@ export declare function toFlattenedTAPString(results: TestResult[], { markNewAsP
 export declare function toXmlOutput(results: TestResult[], { totalTime }?: {
     totalTime?: number;
 }): string;
-export declare function toJsonOutput(results: any, space: any): string;
+export declare function toJsonOutput(results: TestResult[], space?: number | string): string;

package/dist/utils/extract-broker-url.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractBrokerUrl = void 0;
-async function extractBrokerUrl(driver) {
-    try {
-        const selector = driver.isIOS
-            ? '//XCUIElementTypeOther[@name="Applitools_View"]'
-            : driver.isAndroid
-                ? '//android.widget.TextView[@content-desc="Applitools_View"]'
-                : null;
-        if (!selector)
-            return null;
-        const element = await driver.element({
-            type: 'xpath',
-            selector,
-        });
-        const result = JSON.parse(await element.getText());
-        return result.nextPath;
-    }
-    catch (error) {
-        return null;
-    }
-}
-exports.extractBrokerUrl = extractBrokerUrl;

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

@@ -1,16 +0,0 @@
-import type { MaybeArray } from '@applitools/utils';
-import type { ClassicTarget, DriverTarget, Eyes, ExtractTextSettings } from './types';
-import { type Logger } from '@applitools/logger';
-import { type SpecDriver } from '@applitools/driver';
-type Options<TDriver, TContext, TElement, TSelector> = {
-    eyes: Eyes<TDriver, TContext, TElement, TSelector>;
-    target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
-    spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
-    logger?: Logger;
-};
-export declare function makeExtractText<TDriver, TContext, TElement, TSelector>({ eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, }: {
-    target?: ClassicTarget<TDriver, TContext, TElement, TSelector>;
-    settings: MaybeArray<ExtractTextSettings<TElement, TSelector>>;
-    logger?: Logger;
-}) => Promise<string[]>;
-export {};

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

@@ -1,15 +0,0 @@
-import type { ClassicTarget, DriverTarget, Eyes, LocateTextSettings, LocateTextResult } from './types';
-import { type Logger } from '@applitools/logger';
-import { type SpecDriver } from '@applitools/driver';
-type Options<TDriver, TContext, TElement, TSelector> = {
-    eyes: Eyes<TDriver, TContext, TElement, TSelector>;
-    target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
-    spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
-    logger?: Logger;
-};
-export declare function makeLocateText<TDriver, TContext, TElement, TSelector>({ eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): <TPattern extends string>({ target, settings, logger, }: {
-    target?: ClassicTarget<TDriver, TContext, TElement, TSelector>;
-    settings: LocateTextSettings<TPattern, TElement, TSelector>;
-    logger?: Logger;
-}) => Promise<LocateTextResult<TPattern>>;
-export {};

package/types/close-manager.d.ts

@@ -1,18 +0,0 @@
-import type { Eyes, TestResult, TestResultSummary } from './types';
-import type { Core as BaseCore } from '@applitools/core-base';
-import { type Logger } from '@applitools/logger';
-type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
-    core: BaseCore<unknown>;
-    storage: {
-        eyes: Eyes<TDriver, TContext, TElement, TSelector, TType>;
-        promise?: Promise<TestResult<TType>[]>;
-    }[];
-    logger?: Logger;
-};
-export declare function makeCloseManager<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg' = 'classic'>({ core, storage, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TType>): ({ settings, logger, }?: {
-    settings?: {
-        throwErr?: boolean;
-    };
-    logger?: Logger;
-}) => Promise<TestResultSummary<TType>>;
-export {};

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

@@ -1,2 +0,0 @@
-import { type Driver } from '@applitools/driver';
-export declare function extractBrokerUrl(driver: Driver<unknown, unknown, unknown, unknown>): Promise<string>;

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

@@ -1,18 +0,0 @@
-import type { Region } from '@applitools/utils';
-import type { CheckSettings as BaseCheckSettings } from '@applitools/core-base';
-import type { CheckSettings as UFGCheckSettings } from '../ufg/types';
-import type { CheckSettings as ClassicCheckSettings } from '../ufg/types';
-import { type Selector } from '@applitools/driver';
-export declare function toBaseCheckSettings<TElement, TSelector>({ settings, }: {
-    settings: ClassicCheckSettings<TElement, TSelector> | UFGCheckSettings<TElement, TSelector>;
-}): {
-    elementReferencesToCalculate: (TElement | Selector<TSelector>)[];
-    elementReferenceToTarget: TElement | Selector<TSelector>;
-    getBaseCheckSettings: ({ calculatedRegions, preserveTransformation, }: {
-        calculatedRegions: {
-            selector: Selector;
-            regions: Region[];
-        }[];
-        preserveTransformation?: boolean;
-    }) => BaseCheckSettings;
-};