@applitools/core 1.4.6 → 1.4.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{classic → automation}/extract-text.js +14 -11
- package/dist/automation/get-viewport-size.js +2 -2
- package/dist/{classic → automation}/locate-text.js +5 -6
- package/dist/automation/locate.js +2 -2
- package/dist/automation/set-viewport-size.js +2 -2
- package/dist/automation/utils/take-screenshot.js +2 -2
- package/dist/{utils → automation/utils}/to-base-check-settings.js +3 -2
- package/dist/{utils → automation/utils}/wait-for-lazy-load.js +2 -2
- package/dist/check-and-close.js +7 -5
- package/dist/check.js +4 -5
- package/dist/classic/abort.js +15 -6
- package/dist/classic/check-and-close.js +9 -5
- package/dist/classic/check.js +12 -8
- package/dist/classic/close.js +14 -5
- package/dist/classic/core.js +9 -5
- package/dist/classic/open-eyes.js +17 -19
- package/dist/classic/utils/take-dom-capture.js +35 -54
- package/dist/close.js +1 -25
- package/dist/core.js +9 -5
- package/dist/errors/abort-error.js +5 -1
- package/dist/extract-text.js +13 -17
- package/dist/get-eyes-results.js +18 -0
- package/dist/{close-manager.js → get-manager-results.js} +11 -12
- package/dist/get-typed-eyes.js +5 -6
- package/dist/index.js +3 -3
- package/dist/locate-text.js +33 -7
- package/dist/locate.js +1 -1
- package/dist/make-ec-client.js +1 -9
- package/dist/make-manager.js +8 -33
- package/dist/open-eyes.js +3 -5
- package/dist/troubleshoot/check-network.js +41 -34
- package/dist/troubleshoot/eyes.js +2 -2
- package/dist/troubleshoot/ufg.js +3 -2
- package/dist/troubleshoot/utils.js +1 -25
- package/dist/types.js +0 -1
- package/dist/ufg/abort.js +19 -24
- package/dist/ufg/check-and-close.js +55 -55
- package/dist/ufg/check.js +33 -24
- package/dist/ufg/close.js +25 -18
- package/dist/ufg/core.js +9 -5
- package/dist/ufg/get-base-eyes.js +2 -0
- package/dist/ufg/get-results.js +27 -0
- package/dist/ufg/open-eyes.js +30 -25
- package/dist/ufg/utils/extract-broker-url.js +52 -0
- package/dist/ufg/utils/generate-safe-selectors.js +10 -5
- package/dist/ufg/utils/take-dom-snapshot.js +37 -36
- package/dist/ufg/utils/take-dom-snapshots.js +13 -17
- package/dist/ufg/utils/take-snapshots.js +3 -3
- package/dist/ufg/utils/take-vhses.js +60 -166
- package/dist/utils/format-results.js +37 -37
- package/package.json +19 -36
- package/types/automation/extract-text.d.ts +16 -0
- package/types/automation/get-viewport-size.d.ts +7 -7
- package/types/automation/locate-text.d.ts +15 -0
- package/types/automation/locate.d.ts +8 -8
- package/types/automation/set-viewport-size.d.ts +7 -7
- package/types/automation/types.d.ts +38 -42
- package/types/automation/utils/take-screenshot.d.ts +9 -9
- package/types/automation/utils/to-base-check-settings.d.ts +17 -0
- package/types/{utils → automation/utils}/wait-for-lazy-load.d.ts +3 -3
- package/types/check-and-close.d.ts +11 -13
- package/types/check.d.ts +12 -12
- package/types/classic/abort.d.ts +10 -10
- package/types/classic/check-and-close.d.ts +15 -11
- package/types/classic/check.d.ts +11 -11
- package/types/classic/close.d.ts +10 -10
- package/types/classic/core.d.ts +4 -4
- package/types/classic/get-base-eyes.d.ts +4 -4
- package/types/classic/open-eyes.d.ts +9 -9
- package/types/classic/types.d.ts +7 -7
- package/types/classic/utils/take-dom-capture.d.ts +4 -4
- package/types/close-batch.d.ts +1 -1
- package/types/close.d.ts +9 -8
- package/types/core.d.ts +4 -4
- package/types/delete-test.d.ts +1 -1
- package/types/errors/abort-error.d.ts +3 -2
- package/types/extract-text.d.ts +11 -9
- package/types/get-eyes-results.d.ts +12 -0
- package/types/get-manager-results.d.ts +14 -0
- package/types/get-typed-eyes.d.ts +9 -8
- package/types/index.d.ts +3 -3
- package/types/locate-text.d.ts +11 -9
- package/types/locate.d.ts +9 -9
- package/types/make-ec-client.d.ts +3 -3
- package/types/make-manager.d.ts +12 -12
- package/types/open-eyes.d.ts +13 -13
- package/types/troubleshoot/check-network.d.ts +3 -3
- package/types/troubleshoot/utils.d.ts +0 -2
- package/types/types.d.ts +65 -85
- package/types/ufg/abort.d.ts +14 -18
- package/types/ufg/check-and-close.d.ts +25 -13
- package/types/ufg/check.d.ts +11 -11
- package/types/ufg/close.d.ts +14 -18
- package/types/ufg/core.d.ts +4 -4
- package/types/ufg/get-base-eyes.d.ts +6 -6
- package/types/ufg/get-results.d.ts +16 -0
- package/types/ufg/open-eyes.d.ts +9 -9
- package/types/ufg/types.d.ts +15 -17
- package/types/ufg/utils/extract-broker-url.d.ts +6 -0
- package/types/ufg/utils/generate-safe-selectors.d.ts +14 -10
- package/types/ufg/utils/take-dom-snapshot.d.ts +34 -9
- package/types/ufg/utils/take-dom-snapshots.d.ts +3 -3
- package/types/ufg/utils/take-snapshots.d.ts +4 -4
- package/types/ufg/utils/take-vhses.d.ts +4 -4
- package/types/utils/format-results.d.ts +1 -1
- package/dist/utils/extract-broker-url.js +0 -24
- package/types/classic/extract-text.d.ts +0 -16
- package/types/classic/locate-text.d.ts +0 -15
- package/types/close-manager.d.ts +0 -18
- package/types/utils/extract-broker-url.d.ts +0 -2
- package/types/utils/to-base-check-settings.d.ts +0 -18
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { Eyes, GetResultsSettings, TestResultSummary } from './types';
|
|
2
|
+
import type { Core as BaseCore } from '@applitools/core-base';
|
|
3
|
+
import { type SpecType } from '@applitools/driver';
|
|
4
|
+
import { type Logger } from '@applitools/logger';
|
|
5
|
+
type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
|
|
6
|
+
core: BaseCore<unknown>;
|
|
7
|
+
storage: Eyes<TSpec, TType>[];
|
|
8
|
+
logger: Logger;
|
|
9
|
+
};
|
|
10
|
+
export declare function makeGetManagerResults<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ core, storage, logger: defaultLogger, }: Options<TSpec, TType>): ({ settings, logger, }?: {
|
|
11
|
+
settings?: GetResultsSettings<TType> | undefined;
|
|
12
|
+
logger?: Logger | undefined;
|
|
13
|
+
}) => Promise<TestResultSummary<TType>>;
|
|
14
|
+
export {};
|
|
@@ -1,21 +1,22 @@
|
|
|
1
1
|
import type { DriverTarget, TypedCore, TypedEyes, OpenSettings } from './types';
|
|
2
|
+
import { type SpecType } from '@applitools/driver';
|
|
2
3
|
import { type Renderer } from '@applitools/ufg-client';
|
|
3
4
|
import { type Logger } from '@applitools/logger';
|
|
4
|
-
type Options<
|
|
5
|
+
type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
|
|
5
6
|
type: TType;
|
|
6
7
|
settings: OpenSettings<TType>;
|
|
7
|
-
target?: DriverTarget<
|
|
8
|
+
target?: DriverTarget<TSpec>;
|
|
8
9
|
cores: {
|
|
9
|
-
[TKey in 'classic' | 'ufg']: TypedCore<
|
|
10
|
+
[TKey in 'classic' | 'ufg']: TypedCore<TSpec, TKey>;
|
|
10
11
|
};
|
|
11
12
|
logger?: Logger;
|
|
12
13
|
};
|
|
13
|
-
export declare function makeGetTypedEyes<
|
|
14
|
-
type?: TType;
|
|
14
|
+
export declare function makeGetTypedEyes<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, settings: defaultSettings, target, cores, logger: defaultLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings, logger, }?: {
|
|
15
|
+
type?: TType | undefined;
|
|
15
16
|
settings?: {
|
|
16
17
|
type: 'web' | 'native';
|
|
17
18
|
renderers: Renderer[];
|
|
18
|
-
};
|
|
19
|
-
logger?: Logger;
|
|
20
|
-
}) => Promise<TypedEyes<
|
|
19
|
+
} | undefined;
|
|
20
|
+
logger?: Logger | undefined;
|
|
21
|
+
}) => Promise<TypedEyes<TSpec, TType, import("./types").Target<TSpec, TType>>>;
|
|
21
22
|
export {};
|
package/types/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export * from './types';
|
|
2
|
-
export { type Selector } from '@applitools/driver';
|
|
3
2
|
export * from './core';
|
|
4
|
-
export {
|
|
5
|
-
export * as formatters from './utils/format-results';
|
|
3
|
+
export { type Selector } from '@applitools/driver';
|
|
6
4
|
export * from '@applitools/driver/dist/debug';
|
|
5
|
+
export * as formatters from './utils/format-results';
|
|
6
|
+
export { takeDomSnapshots } from './ufg/utils/take-dom-snapshots';
|
package/types/locate-text.d.ts
CHANGED
|
@@ -1,14 +1,16 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { Target, Config, LocateTextSettings, LocateTextResult } from './types';
|
|
2
|
+
import type { Core as BaseCore } from '@applitools/core-base';
|
|
2
3
|
import { type Logger } from '@applitools/logger';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
4
|
+
import { type SpecType, type SpecDriver } from '@applitools/driver';
|
|
5
|
+
type Options<TSpec extends SpecType> = {
|
|
6
|
+
spec?: SpecDriver<TSpec>;
|
|
7
|
+
core: BaseCore;
|
|
6
8
|
logger: Logger;
|
|
7
9
|
};
|
|
8
|
-
export declare function makeLocateText<
|
|
9
|
-
target
|
|
10
|
-
settings:
|
|
11
|
-
config?: Config<
|
|
12
|
-
logger?: Logger;
|
|
10
|
+
export declare function makeLocateText<TSpec extends SpecType>({ spec, core, logger: defaultLogger }: Options<TSpec>): <TPattern extends string>({ target, settings, config, logger, }: {
|
|
11
|
+
target: Target<TSpec, 'classic'>;
|
|
12
|
+
settings: LocateTextSettings<TPattern, TSpec>;
|
|
13
|
+
config?: Config<TSpec, "classic"> | undefined;
|
|
14
|
+
logger?: Logger | undefined;
|
|
13
15
|
}) => Promise<LocateTextResult<TPattern>>;
|
|
14
16
|
export {};
|
package/types/locate.d.ts
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
import type { Region } from '@applitools/utils';
|
|
2
|
-
import type {
|
|
2
|
+
import type { Target, Config, LocateSettings } from './types';
|
|
3
3
|
import type { Core as BaseCore } from '@applitools/core-base';
|
|
4
4
|
import { type Logger } from '@applitools/logger';
|
|
5
|
-
import { type SpecDriver } from '@applitools/driver';
|
|
6
|
-
type Options<
|
|
7
|
-
spec
|
|
5
|
+
import { type SpecType, type SpecDriver } from '@applitools/driver';
|
|
6
|
+
type Options<TSpec extends SpecType> = {
|
|
7
|
+
spec?: SpecDriver<TSpec>;
|
|
8
8
|
core: BaseCore;
|
|
9
9
|
logger: Logger;
|
|
10
10
|
};
|
|
11
|
-
export declare function makeLocate<
|
|
12
|
-
target
|
|
13
|
-
settings: LocateSettings<TLocator,
|
|
14
|
-
config?: Config<
|
|
15
|
-
logger?: Logger;
|
|
11
|
+
export declare function makeLocate<TSpec extends SpecType>({ spec, core, logger: defaultLogger }: Options<TSpec>): <TLocator extends string>({ target, settings, config, logger, }: {
|
|
12
|
+
target: Target<TSpec, 'classic'>;
|
|
13
|
+
settings: LocateSettings<TLocator, TSpec>;
|
|
14
|
+
config?: Config<TSpec, "classic"> | undefined;
|
|
15
|
+
logger?: Logger | undefined;
|
|
16
16
|
}) => Promise<Record<TLocator, Region[]>>;
|
|
17
17
|
export {};
|
|
@@ -5,9 +5,9 @@ type Options = {
|
|
|
5
5
|
core: BaseCore;
|
|
6
6
|
logger: Logger;
|
|
7
7
|
};
|
|
8
|
-
export declare function makeMakeECClient({
|
|
9
|
-
settings?: ECClientSettings;
|
|
10
|
-
logger?: Logger;
|
|
8
|
+
export declare function makeMakeECClient({ logger: defaultLogger }: Options): (({ settings, logger, }?: {
|
|
9
|
+
settings?: Partial<ECClientSettings> | undefined;
|
|
10
|
+
logger?: Logger | undefined;
|
|
11
11
|
}) => Promise<ECClient>) & {
|
|
12
12
|
getCachedValues(): Promise<ECClient>[];
|
|
13
13
|
setCachedValue(key: any, value: Promise<ECClient>): void;
|
package/types/make-manager.d.ts
CHANGED
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
import type { Batch, EyesManager } from './types';
|
|
2
2
|
import type { Core as BaseCore } from '@applitools/core-base';
|
|
3
3
|
import { type Logger } from '@applitools/logger';
|
|
4
|
-
import { type SpecDriver } from '@applitools/driver';
|
|
5
|
-
type Options<
|
|
6
|
-
spec
|
|
4
|
+
import { type SpecType, type SpecDriver } from '@applitools/driver';
|
|
5
|
+
type Options<TSpec extends SpecType> = {
|
|
6
|
+
spec?: SpecDriver<TSpec>;
|
|
7
7
|
core?: BaseCore;
|
|
8
8
|
concurrency?: number;
|
|
9
9
|
agentId?: string;
|
|
10
10
|
cwd?: string;
|
|
11
|
-
logger
|
|
11
|
+
logger: Logger;
|
|
12
12
|
};
|
|
13
|
-
export declare function makeMakeManager<
|
|
14
|
-
type?: TType;
|
|
15
|
-
concurrency?: number;
|
|
13
|
+
export declare function makeMakeManager<TSpec extends SpecType>({ spec, core, concurrency: defaultConcurrency, agentId: defaultAgentId, cwd, logger: defaultLogger, }: Options<TSpec>): <TType extends "classic" | "ufg" = "classic">({ type, concurrency, legacyConcurrency, batch, agentId, logger, }?: {
|
|
14
|
+
type?: TType | undefined;
|
|
15
|
+
concurrency?: number | undefined;
|
|
16
16
|
/** @deprecated */
|
|
17
|
-
legacyConcurrency?: number;
|
|
18
|
-
batch?: Batch;
|
|
19
|
-
agentId?: string;
|
|
20
|
-
logger?: Logger;
|
|
21
|
-
}) => Promise<EyesManager<
|
|
17
|
+
legacyConcurrency?: number | undefined;
|
|
18
|
+
batch?: Batch | undefined;
|
|
19
|
+
agentId?: string | undefined;
|
|
20
|
+
logger?: Logger | undefined;
|
|
21
|
+
}) => Promise<EyesManager<TSpec, TType>>;
|
|
22
22
|
export {};
|
package/types/open-eyes.d.ts
CHANGED
|
@@ -1,23 +1,23 @@
|
|
|
1
|
-
import type { TypedCore, Batch, Eyes, Config, OpenSettings } from './types';
|
|
1
|
+
import type { TypedCore, Batch, Eyes, Config, OpenSettings, DriverTarget } from './types';
|
|
2
2
|
import type { Core as BaseCore } from '@applitools/core-base';
|
|
3
3
|
import { type Logger } from '@applitools/logger';
|
|
4
|
-
import { type SpecDriver } from '@applitools/driver';
|
|
5
|
-
type Options<
|
|
4
|
+
import { type SpecType, type SpecDriver } from '@applitools/driver';
|
|
5
|
+
type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
|
|
6
6
|
type?: TType;
|
|
7
7
|
concurrency?: number;
|
|
8
8
|
batch?: Batch;
|
|
9
9
|
core: BaseCore;
|
|
10
10
|
cores?: {
|
|
11
|
-
[TKey in 'classic' | 'ufg']: TypedCore<
|
|
11
|
+
[TKey in 'classic' | 'ufg']: TypedCore<TSpec, TKey>;
|
|
12
12
|
};
|
|
13
|
-
spec?: SpecDriver<
|
|
14
|
-
logger
|
|
13
|
+
spec?: SpecDriver<TSpec>;
|
|
14
|
+
logger: Logger;
|
|
15
15
|
};
|
|
16
|
-
export declare function makeOpenEyes<
|
|
17
|
-
type?: TType;
|
|
18
|
-
settings?: Partial<OpenSettings<TDefaultType> & OpenSettings<TType
|
|
19
|
-
config?: Config<
|
|
20
|
-
target?:
|
|
21
|
-
logger?: Logger;
|
|
22
|
-
}) => Promise<Eyes<
|
|
16
|
+
export declare function makeOpenEyes<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, concurrency, batch, core, cores, spec, logger: defaultLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings, config, target, logger, }: {
|
|
17
|
+
type?: TType | undefined;
|
|
18
|
+
settings?: Partial<OpenSettings<TDefaultType> & OpenSettings<TType>> | undefined;
|
|
19
|
+
config?: (Config<TSpec, TDefaultType> & Config<TSpec, TType>) | undefined;
|
|
20
|
+
target?: DriverTarget<TSpec> | undefined;
|
|
21
|
+
logger?: Logger | undefined;
|
|
22
|
+
}) => Promise<Eyes<TSpec, TType, import("./types").Target<TSpec, TType>>>;
|
|
23
23
|
export {};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
/// <reference types="node" />
|
|
3
3
|
export declare function checkNetwork({ stream, eyes, ufg }?: {
|
|
4
|
-
stream?: NodeJS.WriteStream;
|
|
4
|
+
stream?: NodeJS.WriteStream | undefined;
|
|
5
5
|
eyes?: {
|
|
6
6
|
testFetch(): Promise<void>;
|
|
7
7
|
testCurl(): Promise<void>;
|
|
@@ -9,7 +9,7 @@ export declare function checkNetwork({ stream, eyes, ufg }?: {
|
|
|
9
9
|
testHttps: () => Promise<void>;
|
|
10
10
|
url: URL;
|
|
11
11
|
cmd: string;
|
|
12
|
-
};
|
|
12
|
+
} | undefined;
|
|
13
13
|
ufg?: {
|
|
14
14
|
testFetch(): Promise<void>;
|
|
15
15
|
testCurl(): Promise<void>;
|
|
@@ -17,5 +17,5 @@ export declare function checkNetwork({ stream, eyes, ufg }?: {
|
|
|
17
17
|
testHttps(): Promise<void>;
|
|
18
18
|
url: URL;
|
|
19
19
|
getCmd: () => Promise<string>;
|
|
20
|
-
};
|
|
20
|
+
} | undefined;
|
|
21
21
|
}): Promise<void>;
|
package/types/types.d.ts
CHANGED
|
@@ -3,131 +3,111 @@ import type { ECClient } from '@applitools/ec-client';
|
|
|
3
3
|
import type * as AutomationCore from './automation/types';
|
|
4
4
|
import type * as ClassicCore from './classic/types';
|
|
5
5
|
import type * as UFGCore from './ufg/types';
|
|
6
|
+
import { type SpecType } from '@applitools/driver';
|
|
6
7
|
import { type Logger } from '@applitools/logger';
|
|
7
8
|
import { type Renderer } from '@applitools/ufg-client';
|
|
8
|
-
export
|
|
9
|
+
export { ECClient };
|
|
9
10
|
export * from './automation/types';
|
|
10
|
-
export type TypedCore<
|
|
11
|
-
export type TypedEyes<
|
|
12
|
-
export type Target<
|
|
13
|
-
export interface Core<
|
|
11
|
+
export type TypedCore<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.Core<TSpec> : ClassicCore.Core<TSpec>;
|
|
12
|
+
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>;
|
|
13
|
+
export type Target<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.Target<TSpec> : ClassicCore.Target<TSpec>;
|
|
14
|
+
export interface Core<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'> extends AutomationCore.Core<TSpec> {
|
|
14
15
|
makeECClient(options?: {
|
|
15
16
|
settings?: any;
|
|
16
17
|
logger?: Logger;
|
|
17
18
|
}): Promise<ECClient>;
|
|
18
|
-
makeManager<TType extends 'classic' | 'ufg' =
|
|
19
|
+
makeManager<TType extends 'classic' | 'ufg' = TDefaultType>(options?: {
|
|
19
20
|
type: TType;
|
|
20
21
|
concurrency?: TType extends 'ufg' ? number : never;
|
|
21
22
|
agentId?: string;
|
|
22
23
|
logger?: Logger;
|
|
23
|
-
}): Promise<EyesManager<
|
|
24
|
-
openEyes<TType extends 'classic' | 'ufg' =
|
|
24
|
+
}): Promise<EyesManager<TSpec, TType>>;
|
|
25
|
+
openEyes<TType extends 'classic' | 'ufg' = TDefaultType>(options: {
|
|
25
26
|
type?: TType;
|
|
26
|
-
target?: AutomationCore.DriverTarget<
|
|
27
|
+
target?: AutomationCore.DriverTarget<TSpec>;
|
|
27
28
|
settings?: Partial<OpenSettings<TType>>;
|
|
28
|
-
config?: Config<
|
|
29
|
+
config?: Config<TSpec, TType>;
|
|
29
30
|
logger?: Logger;
|
|
30
|
-
}): Promise<Eyes<
|
|
31
|
+
}): Promise<Eyes<TSpec, TType>>;
|
|
31
32
|
locate<TLocator extends string>(options: {
|
|
32
|
-
target?: AutomationCore.
|
|
33
|
-
settings?: Partial<LocateSettings<TLocator,
|
|
34
|
-
config?: Config<
|
|
33
|
+
target?: AutomationCore.Target<TSpec>;
|
|
34
|
+
settings?: Partial<AutomationCore.LocateSettings<TLocator, TSpec>>;
|
|
35
|
+
config?: Config<TSpec, TDefaultType>;
|
|
35
36
|
logger?: Logger;
|
|
36
37
|
}): Promise<AutomationCore.LocateResult<TLocator>>;
|
|
37
|
-
}
|
|
38
|
-
export interface EyesManager<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> {
|
|
39
|
-
openEyes(options: {
|
|
40
|
-
target?: TDriver;
|
|
41
|
-
settings?: Partial<OpenSettings<TType>>;
|
|
42
|
-
config?: Config<TElement, TSelector, TType>;
|
|
43
|
-
logger?: Logger;
|
|
44
|
-
}): Promise<Eyes<TDriver, TContext, TElement, TSelector, TType>>;
|
|
45
|
-
closeManager: (options?: {
|
|
46
|
-
settings?: {
|
|
47
|
-
throwErr?: boolean;
|
|
48
|
-
};
|
|
49
|
-
logger?: Logger;
|
|
50
|
-
}) => Promise<TestResultSummary<TType>>;
|
|
51
|
-
}
|
|
52
|
-
export interface ClassicEyes<TDriver, TContext, TElement, TSelector, TTarget = Target<TDriver, TContext, TElement, TSelector, 'classic'>> extends ClassicCore.Eyes<TDriver, TContext, TElement, TSelector, TTarget> {
|
|
53
|
-
getTypedEyes<TType extends 'classic' | 'ufg' = 'classic'>(options?: {
|
|
54
|
-
type?: TType;
|
|
55
|
-
logger?: Logger;
|
|
56
|
-
}): Promise<TypedEyes<TDriver, TContext, TElement, TSelector, TType>>;
|
|
57
|
-
check<TType extends 'classic' | 'ufg' = 'classic'>(options?: {
|
|
58
|
-
type?: TType;
|
|
59
|
-
target?: TTarget;
|
|
60
|
-
settings?: Partial<CheckSettings<TElement, TSelector, 'classic'> & CheckSettings<TElement, TSelector, TType>>;
|
|
61
|
-
config?: Config<TElement, TSelector, 'classic'> & Config<TElement, TSelector, TType>;
|
|
62
|
-
logger?: Logger;
|
|
63
|
-
}): Promise<CheckResult<TType>[]>;
|
|
64
|
-
checkAndClose<TType extends 'classic' | 'ufg' = 'classic'>(options?: {
|
|
65
|
-
type?: TType;
|
|
66
|
-
target?: TTarget;
|
|
67
|
-
settings?: Partial<CheckSettings<TElement, TSelector, 'classic'> & CloseSettings<'classic'> & CheckSettings<TElement, TSelector, TType> & CloseSettings<TType>>;
|
|
68
|
-
config?: Config<TElement, TSelector, 'classic'> & Config<TElement, TSelector, TType>;
|
|
69
|
-
logger?: Logger;
|
|
70
|
-
}): Promise<TestResult<TType>[]>;
|
|
71
38
|
locateText<TPattern extends string>(options: {
|
|
72
|
-
target?:
|
|
73
|
-
settings: Partial<LocateTextSettings<TPattern,
|
|
74
|
-
config?: Config<
|
|
39
|
+
target?: AutomationCore.Target<TSpec>;
|
|
40
|
+
settings: Partial<AutomationCore.LocateTextSettings<TPattern, TSpec>>;
|
|
41
|
+
config?: Config<TSpec, TDefaultType>;
|
|
75
42
|
logger?: Logger;
|
|
76
43
|
}): Promise<AutomationCore.LocateTextResult<TPattern>>;
|
|
77
44
|
extractText(options: {
|
|
78
|
-
target?:
|
|
79
|
-
settings: MaybeArray<Partial<ExtractTextSettings<
|
|
80
|
-
config?: Config<
|
|
45
|
+
target?: AutomationCore.Target<TSpec>;
|
|
46
|
+
settings: MaybeArray<Partial<AutomationCore.ExtractTextSettings<TSpec>>>;
|
|
47
|
+
config?: Config<TSpec, TDefaultType>;
|
|
81
48
|
logger?: Logger;
|
|
82
49
|
}): Promise<string[]>;
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
50
|
+
}
|
|
51
|
+
export interface EyesManager<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'> {
|
|
52
|
+
openEyes<TType extends 'classic' | 'ufg' = TDefaultType>(options: {
|
|
53
|
+
type?: TType;
|
|
54
|
+
target?: AutomationCore.DriverTarget<TSpec>;
|
|
55
|
+
settings?: Partial<OpenSettings<TType>>;
|
|
56
|
+
config?: Config<TSpec, TType>;
|
|
57
|
+
logger?: Logger;
|
|
58
|
+
}): Promise<Eyes<TSpec, TType>>;
|
|
59
|
+
getResults: (options?: {
|
|
60
|
+
settings?: GetResultsSettings<TDefaultType>;
|
|
86
61
|
logger?: Logger;
|
|
87
|
-
})
|
|
62
|
+
}) => Promise<TestResultSummary<'classic' | 'ufg'>>;
|
|
88
63
|
}
|
|
89
|
-
export interface
|
|
90
|
-
getTypedEyes<TType extends 'classic' | 'ufg' =
|
|
64
|
+
export interface Eyes<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg', TTarget = Target<TSpec, TDefaultType>> extends AutomationCore.Eyes<TSpec> {
|
|
65
|
+
getTypedEyes<TType extends 'classic' | 'ufg' = TDefaultType>(options?: {
|
|
91
66
|
type?: TType;
|
|
92
|
-
settings?:
|
|
93
|
-
type: 'web' | 'native';
|
|
94
|
-
renderers: Renderer[];
|
|
95
|
-
};
|
|
67
|
+
settings?: any;
|
|
96
68
|
logger?: Logger;
|
|
97
|
-
}): Promise<TypedEyes<
|
|
98
|
-
check<TType extends 'classic' | 'ufg' =
|
|
69
|
+
}): Promise<TypedEyes<TSpec, TType>>;
|
|
70
|
+
check<TType extends 'classic' | 'ufg' = TDefaultType>(options?: {
|
|
99
71
|
type?: TType;
|
|
100
72
|
target?: TTarget;
|
|
101
|
-
settings?: Partial<CheckSettings<
|
|
102
|
-
config?: Config<
|
|
73
|
+
settings?: Partial<CheckSettings<TSpec, TDefaultType> & CheckSettings<TSpec, TType>>;
|
|
74
|
+
config?: Config<TSpec, TDefaultType> & Config<TSpec, TType>;
|
|
103
75
|
logger?: Logger;
|
|
104
76
|
}): Promise<CheckResult<TType>[]>;
|
|
105
|
-
checkAndClose<TType extends 'classic' | 'ufg' =
|
|
77
|
+
checkAndClose<TType extends 'classic' | 'ufg' = TDefaultType>(options?: {
|
|
106
78
|
type?: TType;
|
|
107
79
|
target?: TTarget;
|
|
108
|
-
settings?: Partial<CheckSettings<
|
|
109
|
-
config?: Config<
|
|
80
|
+
settings?: Partial<CheckSettings<TSpec, TDefaultType> & CloseSettings<TDefaultType> & CheckSettings<TSpec, TType> & CloseSettings<TType>>;
|
|
81
|
+
config?: Config<TSpec, TDefaultType> & Config<TSpec, TType>;
|
|
110
82
|
logger?: Logger;
|
|
111
83
|
}): Promise<TestResult<TType>[]>;
|
|
112
84
|
close(options?: {
|
|
113
|
-
settings?: Partial<CloseSettings<
|
|
114
|
-
config?: Config<
|
|
85
|
+
settings?: Partial<CloseSettings<TDefaultType>>;
|
|
86
|
+
config?: Config<TSpec, TDefaultType>;
|
|
87
|
+
logger?: Logger;
|
|
88
|
+
}): Promise<void>;
|
|
89
|
+
abort(options?: {
|
|
90
|
+
settings?: Partial<AbortSettings<TDefaultType>>;
|
|
91
|
+
config?: Config<TSpec, TDefaultType>;
|
|
92
|
+
logger?: Logger;
|
|
93
|
+
}): Promise<void>;
|
|
94
|
+
getResults(options?: {
|
|
95
|
+
settings?: Partial<GetResultsSettings<TDefaultType>>;
|
|
96
|
+
config?: Config<TSpec, TDefaultType>;
|
|
115
97
|
logger?: Logger;
|
|
116
|
-
}): Promise<TestResult<
|
|
98
|
+
}): Promise<TestResult<TDefaultType>[]>;
|
|
117
99
|
}
|
|
118
|
-
export type
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
close: Partial<CloseSettings<TType>>;
|
|
100
|
+
export type Config<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
|
|
101
|
+
open: Partial<Omit<OpenSettings<TType>, 'userCommandId'>>;
|
|
102
|
+
screenshot: Partial<Omit<ClassicCore.ScreenshotSettings<TSpec>, 'userCommandId'>>;
|
|
103
|
+
check: Partial<Omit<CheckSettings<TSpec, TType>, keyof ClassicCore.ScreenshotSettings<TSpec> | 'userCommandId'>>;
|
|
104
|
+
close: Partial<Omit<CloseSettings<TType>, 'userCommandId'>>;
|
|
124
105
|
};
|
|
125
|
-
export type LocateSettings<TLocator extends string, TElement, TSelector> = AutomationCore.LocateSettings<TLocator, TElement, TSelector>;
|
|
126
106
|
export type OpenSettings<TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.OpenSettings : ClassicCore.OpenSettings;
|
|
127
|
-
export type CheckSettings<
|
|
128
|
-
export type
|
|
129
|
-
export type
|
|
130
|
-
export type
|
|
107
|
+
export type CheckSettings<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.CheckSettings<TSpec> : ClassicCore.CheckSettings<TSpec>;
|
|
108
|
+
export type CloseSettings<TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.CloseSettings : ClassicCore.CloseSettings;
|
|
109
|
+
export type AbortSettings<TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.AbortSettings : ClassicCore.AbortSettings;
|
|
110
|
+
export type GetResultsSettings<TType extends 'classic' | 'ufg'> = (TType extends 'ufg' ? UFGCore.GetResultsSettings : ClassicCore.GetResultsSettings) & {
|
|
131
111
|
throwErr?: boolean;
|
|
132
112
|
};
|
|
133
113
|
export type CheckResult<TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.CheckResult : ClassicCore.CheckResult;
|
package/types/ufg/abort.d.ts
CHANGED
|
@@ -1,25 +1,21 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type { Eyes as BaseEyes } from '@applitools/core-base';
|
|
1
|
+
import type { DriverTarget, AbortSettings } from './types';
|
|
3
2
|
import { type Logger } from '@applitools/logger';
|
|
4
|
-
import { type Renderer } from '@applitools/ufg-client';
|
|
5
3
|
import { type AbortController } from 'abort-controller';
|
|
6
|
-
import type
|
|
7
|
-
import {
|
|
8
|
-
|
|
9
|
-
|
|
4
|
+
import { type SpecType, type SpecDriver } from '@applitools/driver';
|
|
5
|
+
import { Renderer } from '@applitools/ufg-client';
|
|
6
|
+
import { Eyes as baseEyes } from '@applitools/core-base';
|
|
7
|
+
type Options<TSpec extends SpecType> = {
|
|
8
|
+
storage: Map<string, Promise<{
|
|
10
9
|
renderer: Renderer;
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
renderer: Renderer;
|
|
14
|
-
}>;
|
|
15
|
-
}[];
|
|
10
|
+
eyes: baseEyes;
|
|
11
|
+
}>[]>;
|
|
16
12
|
controller: AbortController;
|
|
17
|
-
target?: DriverTarget<
|
|
18
|
-
spec?: SpecDriver<
|
|
13
|
+
target?: DriverTarget<TSpec>;
|
|
14
|
+
spec?: SpecDriver<TSpec>;
|
|
19
15
|
logger: Logger;
|
|
20
16
|
};
|
|
21
|
-
export declare function makeAbort<
|
|
22
|
-
settings?: AbortSettings;
|
|
23
|
-
logger?: Logger;
|
|
24
|
-
}) => Promise<
|
|
17
|
+
export declare function makeAbort<TSpec extends SpecType>({ storage, target, spec, controller, logger: defaultLogger, }: Options<TSpec>): ({ settings, logger, }?: {
|
|
18
|
+
settings?: AbortSettings | undefined;
|
|
19
|
+
logger?: Logger | undefined;
|
|
20
|
+
}) => Promise<void>;
|
|
25
21
|
export {};
|
|
@@ -1,21 +1,33 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import {
|
|
1
|
+
import type { Region } from '@applitools/utils';
|
|
2
|
+
import type { DriverTarget, Target, Eyes, CheckSettings, TestResult, CloseSettings } from './types';
|
|
3
3
|
import { type AbortSignal } from 'abort-controller';
|
|
4
4
|
import { type Logger } from '@applitools/logger';
|
|
5
5
|
import { type UFGClient } from '@applitools/ufg-client';
|
|
6
|
-
import { type SpecDriver } from '@applitools/driver';
|
|
7
|
-
type Options<
|
|
8
|
-
eyes: Eyes<
|
|
6
|
+
import { type SpecType, type SpecDriver } from '@applitools/driver';
|
|
7
|
+
type Options<TSpec extends SpecType> = {
|
|
8
|
+
eyes: Eyes<TSpec>;
|
|
9
9
|
client: UFGClient;
|
|
10
|
-
target?: DriverTarget<
|
|
11
|
-
spec?: SpecDriver<
|
|
10
|
+
target?: DriverTarget<TSpec>;
|
|
11
|
+
spec?: SpecDriver<TSpec>;
|
|
12
12
|
signal?: AbortSignal;
|
|
13
|
-
logger
|
|
13
|
+
logger: Logger;
|
|
14
14
|
};
|
|
15
|
-
export declare function makeCheckAndClose<
|
|
16
|
-
target?:
|
|
17
|
-
settings?: CheckSettings<
|
|
18
|
-
|
|
19
|
-
|
|
15
|
+
export declare function makeCheckAndClose<TSpec extends SpecType>({ spec, eyes, client, signal, target: defaultTarget, logger: defaultLogger, }: Options<TSpec>): ({ target, settings, logger, }: {
|
|
16
|
+
target?: Target<TSpec> | undefined;
|
|
17
|
+
settings?: (import("@applitools/core-base").CheckSettings<Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
|
|
18
|
+
renderers?: import("@applitools/ufg-client").Renderer[] | undefined;
|
|
19
|
+
hooks?: {
|
|
20
|
+
beforeCaptureScreenshot: string;
|
|
21
|
+
} | undefined;
|
|
22
|
+
disableBrowserFetching?: boolean | undefined;
|
|
23
|
+
layoutBreakpoints?: boolean | number[] | undefined;
|
|
24
|
+
ufgOptions?: Record<string, any> | undefined;
|
|
25
|
+
nmgOptions?: Record<string, any> | undefined;
|
|
26
|
+
autProxy?: (import("@applitools/req").Proxy & {
|
|
27
|
+
mode?: "Allow" | "Block" | undefined;
|
|
28
|
+
domains?: string[] | undefined;
|
|
29
|
+
}) | undefined;
|
|
30
|
+
} & CloseSettings) | undefined;
|
|
31
|
+
logger?: Logger | undefined;
|
|
20
32
|
}) => Promise<TestResult[]>;
|
|
21
33
|
export {};
|
package/types/ufg/check.d.ts
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
import type { DriverTarget,
|
|
1
|
+
import type { DriverTarget, Target, Eyes, CheckSettings, CheckResult } from './types';
|
|
2
2
|
import { type AbortSignal } from 'abort-controller';
|
|
3
3
|
import { type Logger } from '@applitools/logger';
|
|
4
4
|
import { type UFGClient } from '@applitools/ufg-client';
|
|
5
|
-
import { type SpecDriver } from '@applitools/driver';
|
|
6
|
-
type Options<
|
|
7
|
-
eyes: Eyes<
|
|
5
|
+
import { type SpecType, type SpecDriver } from '@applitools/driver';
|
|
6
|
+
type Options<TSpec extends SpecType> = {
|
|
7
|
+
eyes: Eyes<TSpec>;
|
|
8
8
|
client: UFGClient;
|
|
9
|
-
target?: DriverTarget<
|
|
10
|
-
spec?: SpecDriver<
|
|
9
|
+
target?: DriverTarget<TSpec>;
|
|
10
|
+
spec?: SpecDriver<TSpec>;
|
|
11
11
|
signal?: AbortSignal;
|
|
12
|
-
logger
|
|
12
|
+
logger: Logger;
|
|
13
13
|
};
|
|
14
|
-
export declare function makeCheck<
|
|
15
|
-
settings?: CheckSettings<
|
|
16
|
-
target?:
|
|
17
|
-
logger?: Logger;
|
|
14
|
+
export declare function makeCheck<TSpec extends SpecType>({ eyes, client, target: defaultTarget, spec, signal, logger: defaultLogger, }: Options<TSpec>): ({ target, settings, logger, }: {
|
|
15
|
+
settings?: CheckSettings<TSpec> | undefined;
|
|
16
|
+
target?: Target<TSpec> | undefined;
|
|
17
|
+
logger?: Logger | undefined;
|
|
18
18
|
}) => Promise<CheckResult[]>;
|
|
19
19
|
export {};
|
package/types/ufg/close.d.ts
CHANGED
|
@@ -1,23 +1,19 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type { Eyes as BaseEyes } from '@applitools/core-base';
|
|
1
|
+
import type { DriverTarget, CloseSettings } from './types';
|
|
3
2
|
import { type Logger } from '@applitools/logger';
|
|
4
|
-
import { type
|
|
5
|
-
import
|
|
6
|
-
import {
|
|
7
|
-
type Options<
|
|
8
|
-
storage: {
|
|
3
|
+
import { type SpecType, type SpecDriver } from '@applitools/driver';
|
|
4
|
+
import { Renderer } from '@applitools/ufg-client';
|
|
5
|
+
import { Eyes as baseEyes } from '@applitools/core-base';
|
|
6
|
+
type Options<TSpec extends SpecType> = {
|
|
7
|
+
storage: Map<string, Promise<{
|
|
9
8
|
renderer: Renderer;
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
}[];
|
|
15
|
-
target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
|
|
16
|
-
spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
|
|
9
|
+
eyes: baseEyes;
|
|
10
|
+
}>[]>;
|
|
11
|
+
target?: DriverTarget<TSpec>;
|
|
12
|
+
spec?: SpecDriver<TSpec>;
|
|
17
13
|
logger: Logger;
|
|
18
14
|
};
|
|
19
|
-
export declare function makeClose<
|
|
20
|
-
settings?: CloseSettings;
|
|
21
|
-
logger?: Logger;
|
|
22
|
-
}) => Promise<
|
|
15
|
+
export declare function makeClose<TSpec extends SpecType>({ storage, target, spec, logger: defaultLogger }: Options<TSpec>): ({ settings, logger, }?: {
|
|
16
|
+
settings?: CloseSettings | undefined;
|
|
17
|
+
logger?: Logger | undefined;
|
|
18
|
+
}) => Promise<void>;
|
|
23
19
|
export {};
|