@applitools/core 1.4.9 → 1.4.10

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.
Files changed (80) hide show
  1. package/dist/automation/get-viewport-size.js +1 -1
  2. package/dist/automation/locate.js +1 -1
  3. package/dist/automation/set-viewport-size.js +1 -1
  4. package/dist/check.js +4 -1
  5. package/dist/classic/abort.js +3 -3
  6. package/dist/classic/close.js +2 -2
  7. package/dist/classic/core.js +0 -4
  8. package/dist/{automation → classic}/extract-text.js +9 -6
  9. package/dist/{automation → classic}/locate-text.js +8 -5
  10. package/dist/classic/open-eyes.js +5 -1
  11. package/dist/{get-manager-results.js → close-manager.js} +9 -7
  12. package/dist/close.js +25 -1
  13. package/dist/core.js +0 -4
  14. package/dist/errors/abort-error.js +1 -5
  15. package/dist/extract-text.js +17 -13
  16. package/dist/get-typed-eyes.js +2 -4
  17. package/dist/index.js +3 -3
  18. package/dist/locate-text.js +7 -33
  19. package/dist/locate.js +1 -1
  20. package/dist/make-manager.js +28 -5
  21. package/dist/open-eyes.js +5 -3
  22. package/dist/types.js +1 -0
  23. package/dist/ufg/abort.js +19 -11
  24. package/dist/ufg/check-and-close.js +4 -4
  25. package/dist/ufg/check.js +9 -11
  26. package/dist/ufg/close.js +18 -17
  27. package/dist/ufg/core.js +0 -4
  28. package/dist/ufg/open-eyes.js +25 -13
  29. package/package.json +9 -11
  30. package/types/automation/get-viewport-size.d.ts +5 -5
  31. package/types/automation/locate.d.ts +6 -6
  32. package/types/automation/set-viewport-size.d.ts +5 -5
  33. package/types/automation/types.d.ts +40 -36
  34. package/types/automation/utils/take-screenshot.d.ts +9 -9
  35. package/types/automation/utils/to-base-check-settings.d.ts +13 -6
  36. package/types/automation/utils/wait-for-lazy-load.d.ts +3 -3
  37. package/types/check-and-close.d.ts +11 -9
  38. package/types/check.d.ts +9 -9
  39. package/types/classic/abort.d.ts +8 -8
  40. package/types/classic/check-and-close.d.ts +9 -9
  41. package/types/classic/check.d.ts +9 -9
  42. package/types/classic/close.d.ts +8 -8
  43. package/types/classic/core.d.ts +4 -4
  44. package/types/classic/extract-text.d.ts +16 -0
  45. package/types/classic/locate-text.d.ts +15 -0
  46. package/types/classic/open-eyes.d.ts +6 -6
  47. package/types/classic/types.d.ts +7 -7
  48. package/types/classic/utils/take-dom-capture.d.ts +3 -3
  49. package/types/close-manager.d.ts +18 -0
  50. package/types/close.d.ts +6 -7
  51. package/types/core.d.ts +4 -4
  52. package/types/errors/abort-error.d.ts +1 -3
  53. package/types/extract-text.d.ts +8 -10
  54. package/types/get-typed-eyes.d.ts +5 -6
  55. package/types/index.d.ts +3 -3
  56. package/types/locate-text.d.ts +8 -10
  57. package/types/locate.d.ts +8 -8
  58. package/types/make-manager.d.ts +5 -5
  59. package/types/open-eyes.d.ts +9 -9
  60. package/types/types.d.ts +84 -62
  61. package/types/ufg/abort.d.ts +16 -8
  62. package/types/ufg/check-and-close.d.ts +9 -9
  63. package/types/ufg/check.d.ts +9 -9
  64. package/types/ufg/close.d.ts +17 -8
  65. package/types/ufg/core.d.ts +4 -4
  66. package/types/ufg/open-eyes.d.ts +6 -6
  67. package/types/ufg/types.d.ts +17 -13
  68. package/types/ufg/utils/extract-broker-url.d.ts +3 -3
  69. package/types/ufg/utils/generate-safe-selectors.d.ts +8 -8
  70. package/types/ufg/utils/take-dom-snapshot.d.ts +3 -3
  71. package/types/ufg/utils/take-dom-snapshots.d.ts +3 -3
  72. package/types/ufg/utils/take-snapshots.d.ts +3 -3
  73. package/types/ufg/utils/take-vhses.d.ts +3 -3
  74. package/dist/get-eyes-results.js +0 -18
  75. package/dist/ufg/get-results.js +0 -27
  76. package/types/automation/extract-text.d.ts +0 -16
  77. package/types/automation/locate-text.d.ts +0 -15
  78. package/types/get-eyes-results.d.ts +0 -12
  79. package/types/get-manager-results.d.ts +0 -14
  80. package/types/ufg/get-results.d.ts +0 -11
@@ -1,17 +1,17 @@
1
- import type { Target, DriverTarget, Eyes, CheckSettings, CloseSettings, TestResult } from './types';
1
+ import type { ClassicTarget, DriverTarget, Eyes, CheckSettings, CloseSettings, TestResult } from './types';
2
2
  import type { CheckSettings as BaseCheckSettings } from '@applitools/core-base';
3
3
  import { type Logger } from '@applitools/logger';
4
- import { type SpecType, type SpecDriver } from '@applitools/driver';
4
+ import { type SpecDriver } from '@applitools/driver';
5
5
  import * as utils from '@applitools/utils';
6
- type Options<TSpec extends SpecType> = {
7
- eyes: Eyes<TSpec>;
8
- target?: DriverTarget<TSpec>;
9
- spec?: SpecDriver<TSpec>;
6
+ type Options<TDriver, TContext, TElement, TSelector> = {
7
+ eyes: Eyes<TDriver, TContext, TElement, TSelector>;
8
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
9
+ spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
10
10
  logger: Logger;
11
11
  };
12
- export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
13
- target?: Target<TSpec> | undefined;
14
- settings?: (BaseCheckSettings<utils.Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
12
+ export declare function makeCheckAndClose<TDriver, TContext, TElement, TSelector>({ eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, }?: {
13
+ target?: ClassicTarget<TDriver, TContext, TElement, TSelector> | undefined;
14
+ settings?: (BaseCheckSettings<utils.Region | (TElement | import("@applitools/driver").Selector<TSelector>)> & import("./types").ScreenshotSettings<TElement, TSelector> & {
15
15
  retryTimeout?: number | undefined;
16
16
  } & CloseSettings) | undefined;
17
17
  logger?: Logger | undefined;
@@ -1,15 +1,15 @@
1
- import type { Target, DriverTarget, Eyes, CheckSettings, CheckResult } from './types';
1
+ import type { ClassicTarget, DriverTarget, Eyes, CheckSettings, CheckResult } from './types';
2
2
  import { type Logger } from '@applitools/logger';
3
- import { type SpecType, type SpecDriver } from '@applitools/driver';
4
- type Options<TSpec extends SpecType> = {
5
- eyes: Eyes<TSpec>;
6
- target?: DriverTarget<TSpec>;
7
- spec?: SpecDriver<TSpec>;
3
+ import { type SpecDriver } from '@applitools/driver';
4
+ type Options<TDriver, TContext, TElement, TSelector> = {
5
+ eyes: Eyes<TDriver, TContext, TElement, TSelector>;
6
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
7
+ spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
8
8
  logger: Logger;
9
9
  };
10
- export declare function makeCheck<TSpec extends SpecType>({ eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
11
- target?: Target<TSpec> | undefined;
12
- settings?: CheckSettings<TSpec> | undefined;
10
+ export declare function makeCheck<TDriver, TContext, TElement, TSelector>({ eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, }?: {
11
+ target?: ClassicTarget<TDriver, TContext, TElement, TSelector> | undefined;
12
+ settings?: CheckSettings<TElement, TSelector> | undefined;
13
13
  logger?: Logger | undefined;
14
14
  }) => Promise<CheckResult[]>;
15
15
  export {};
@@ -1,16 +1,16 @@
1
- import type { CloseSettings } from './types';
1
+ import type { CloseSettings, TestResult } from './types';
2
2
  import type { Eyes } from './types';
3
3
  import { type Logger } from '@applitools/logger';
4
4
  import type { DriverTarget } from './types';
5
- import { type SpecType, type SpecDriver } from '@applitools/driver';
6
- type Options<TSpec extends SpecType> = {
7
- eyes: Eyes<TSpec>;
8
- target?: DriverTarget<TSpec>;
9
- spec?: SpecDriver<TSpec>;
5
+ import { type SpecDriver } from '@applitools/driver';
6
+ type Options<TDriver, TContext, TElement, TSelector> = {
7
+ eyes: Eyes<TDriver, TContext, TElement, TSelector>;
8
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
9
+ spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
10
10
  logger: Logger;
11
11
  };
12
- export declare function makeClose<TSpec extends SpecType>({ eyes, target, spec, logger: defaultLogger }: Options<TSpec>): ({ settings, logger, }?: {
12
+ export declare function makeClose<TDriver, TContext, TElement, TSelector>({ eyes, target, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ settings, logger, }?: {
13
13
  settings?: CloseSettings | undefined;
14
14
  logger?: Logger | undefined;
15
- }) => Promise<void>;
15
+ }) => Promise<TestResult[]>;
16
16
  export {};
@@ -1,13 +1,13 @@
1
1
  import type { Core } from './types';
2
- import { type SpecType, type SpecDriver } from '@applitools/driver';
2
+ import { type SpecDriver } from '@applitools/driver';
3
3
  import { type Logger } from '@applitools/logger';
4
4
  import { type Core as BaseCore } from '@applitools/core-base';
5
- type Options<TSpec extends SpecType> = {
6
- spec?: SpecDriver<TSpec>;
5
+ type Options<TDriver, TContext, TElement, TSelector> = {
6
+ spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
7
7
  core?: BaseCore;
8
8
  agentId?: string;
9
9
  cwd?: string;
10
10
  logger?: Logger;
11
11
  };
12
- export declare function makeCore<TSpec extends SpecType>({ spec, core, agentId, cwd, logger: defaultLogger, }: Options<TSpec>): Core<TSpec>;
12
+ export declare function makeCore<TDriver, TContext, TElement, TSelector>({ spec, core, agentId, cwd, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): Core<TDriver, TContext, TElement, TSelector>;
13
13
  export {};
@@ -0,0 +1,16 @@
1
+ import type { MaybeArray } from '@applitools/utils';
2
+ import type { ClassicTarget, DriverTarget, Eyes, ExtractTextSettings } from './types';
3
+ import { type Logger } from '@applitools/logger';
4
+ import { type SpecDriver } from '@applitools/driver';
5
+ type Options<TDriver, TContext, TElement, TSelector> = {
6
+ eyes: Eyes<TDriver, TContext, TElement, TSelector>;
7
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
8
+ spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
9
+ logger: Logger;
10
+ };
11
+ export declare function makeExtractText<TDriver, TContext, TElement, TSelector>({ eyes, target: defaultTarget, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, }: {
12
+ target?: ClassicTarget<TDriver, TContext, TElement, TSelector> | undefined;
13
+ settings: MaybeArray<ExtractTextSettings<TElement, TSelector>>;
14
+ logger?: Logger | undefined;
15
+ }) => Promise<string[]>;
16
+ export {};
@@ -0,0 +1,15 @@
1
+ import type { ClassicTarget, DriverTarget, Eyes, LocateTextSettings, LocateTextResult } from './types';
2
+ import { type Logger } from '@applitools/logger';
3
+ import { type SpecDriver } from '@applitools/driver';
4
+ type Options<TDriver, TContext, TElement, TSelector> = {
5
+ eyes: Eyes<TDriver, TContext, TElement, TSelector>;
6
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
7
+ spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
8
+ logger: Logger;
9
+ };
10
+ 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, }: {
11
+ target?: ClassicTarget<TDriver, TContext, TElement, TSelector> | undefined;
12
+ settings: LocateTextSettings<TPattern, TElement, TSelector>;
13
+ logger?: Logger | undefined;
14
+ }) => Promise<LocateTextResult<TPattern>>;
15
+ export {};
@@ -1,16 +1,16 @@
1
1
  import type { DriverTarget, Eyes, OpenSettings } from './types';
2
2
  import type { Core as BaseCore, Eyes as BaseEyes } from '@applitools/core-base';
3
3
  import { type Logger } from '@applitools/logger';
4
- import { type SpecType, type SpecDriver } from '@applitools/driver';
5
- type Options<TSpec extends SpecType> = {
4
+ import { type SpecDriver } from '@applitools/driver';
5
+ type Options<TDriver, TContext, TElement, TSelector> = {
6
6
  core: BaseCore;
7
- spec?: SpecDriver<TSpec>;
7
+ spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
8
8
  logger: Logger;
9
9
  };
10
- export declare function makeOpenEyes<TSpec extends SpecType>({ core, spec, logger: defaultLogger }: Options<TSpec>): ({ target, settings, eyes, logger, }: {
11
- target?: DriverTarget<TSpec> | undefined;
10
+ export declare function makeOpenEyes<TDriver, TContext, TElement, TSelector>({ core, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, eyes, logger, }: {
11
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector> | undefined;
12
12
  settings: OpenSettings;
13
13
  eyes?: BaseEyes<import("@applitools/core-base").ImageTarget>[] | undefined;
14
14
  logger?: Logger | undefined;
15
- }) => Promise<Eyes<TSpec>>;
15
+ }) => Promise<Eyes<TDriver, TContext, TElement, TSelector>>;
16
16
  export {};
@@ -1,27 +1,27 @@
1
1
  import type * as BaseCore from '@applitools/core-base/types';
2
2
  import type * as AutomationCore from '../automation/types';
3
- import { type SpecType } from '@applitools/driver';
4
3
  import { type Logger } from '@applitools/logger';
5
4
  export * from '../automation/types';
6
- export interface Core<TSpec extends SpecType, TTarget = AutomationCore.Target<TSpec>, TEyes extends Eyes<TSpec, TTarget> = Eyes<TSpec, TTarget>> extends AutomationCore.Core<TSpec, TTarget, TEyes> {
5
+ export type ClassicTarget<TDriver, TContext, TElement, TSelector> = AutomationCore.DriverTarget<TDriver, TContext, TElement, TSelector> | AutomationCore.ImageTarget;
6
+ export interface Core<TDriver, TContext, TElement, TSelector, TEyes = Eyes<TDriver, TContext, TElement, TSelector>> extends AutomationCore.Core<TDriver, TContext, TElement, TSelector, TEyes> {
7
7
  readonly type: 'classic';
8
8
  openEyes(options: {
9
- target?: AutomationCore.DriverTarget<TSpec>;
9
+ target?: AutomationCore.DriverTarget<TDriver, TContext, TElement, TSelector>;
10
10
  settings: OpenSettings;
11
11
  eyes?: BaseCore.Eyes[];
12
12
  logger?: Logger;
13
13
  }): Promise<TEyes>;
14
14
  }
15
- export interface Eyes<TSpec extends SpecType, TTarget = AutomationCore.Target<TSpec>> extends AutomationCore.Eyes<TSpec, TTarget> {
15
+ export interface Eyes<TDriver, TContext, TElement, TSelector, TTarget = ClassicTarget<TDriver, TContext, TElement, TSelector>> extends AutomationCore.Eyes<TDriver, TContext, TElement, TSelector, TTarget> {
16
16
  readonly type: 'classic';
17
17
  check(options?: {
18
18
  target?: TTarget;
19
- settings?: CheckSettings<TSpec>;
19
+ settings?: CheckSettings<TElement, TSelector>;
20
20
  logger?: Logger;
21
21
  }): Promise<AutomationCore.CheckResult[]>;
22
22
  checkAndClose(options?: {
23
23
  target?: TTarget;
24
- settings?: CheckSettings<TSpec> & AutomationCore.CloseSettings;
24
+ settings?: CheckSettings<TElement, TSelector> & AutomationCore.CloseSettings;
25
25
  logger?: Logger;
26
26
  }): Promise<AutomationCore.TestResult[]>;
27
27
  }
@@ -29,6 +29,6 @@ export type OpenSettings = AutomationCore.OpenSettings & {
29
29
  keepPlatformNameAsIs?: boolean;
30
30
  useCeilForViewportSize?: boolean;
31
31
  };
32
- export type CheckSettings<TSpec extends SpecType> = AutomationCore.CheckSettings<TSpec> & {
32
+ export type CheckSettings<TElement, TSelector> = AutomationCore.CheckSettings<TElement, TSelector> & {
33
33
  retryTimeout?: number;
34
34
  };
@@ -1,4 +1,4 @@
1
- import { type SpecType, type Driver } from '@applitools/driver';
1
+ import { type Driver } from '@applitools/driver';
2
2
  import { type Logger } from '@applitools/logger';
3
3
  import { type Fetch } from '@applitools/req';
4
4
  export type DomCaptureSettings = {
@@ -7,8 +7,8 @@ export type DomCaptureSettings = {
7
7
  pollTimeout?: number;
8
8
  chunkByteLength?: number;
9
9
  };
10
- export declare function takeDomCapture<TSpec extends SpecType>({ driver, settings, logger, }: {
11
- driver: Driver<TSpec>;
10
+ export declare function takeDomCapture({ driver, settings, logger, }: {
11
+ driver: Driver<unknown, unknown, unknown, unknown>;
12
12
  settings?: DomCaptureSettings;
13
13
  logger: Logger;
14
14
  }): Promise<string>;
@@ -0,0 +1,18 @@
1
+ import type { Eyes, TestResult, TestResultSummary } from './types';
2
+ import type { Core as BaseCore } from '@applitools/core-base';
3
+ import { type Logger } from '@applitools/logger';
4
+ type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
5
+ core: BaseCore<unknown>;
6
+ storage: {
7
+ eyes: Eyes<TDriver, TContext, TElement, TSelector, TType>;
8
+ promise?: Promise<TestResult<TType>[]>;
9
+ }[];
10
+ logger: Logger;
11
+ };
12
+ 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, }?: {
13
+ settings?: {
14
+ throwErr?: boolean | undefined;
15
+ } | undefined;
16
+ logger?: Logger | undefined;
17
+ }) => Promise<TestResultSummary<TType>>;
18
+ export {};
package/types/close.d.ts CHANGED
@@ -1,13 +1,12 @@
1
- import type { Eyes, Config, CloseSettings } from './types';
2
- import { type SpecType } from '@applitools/driver';
1
+ import type { Eyes, Config, CloseSettings, TestResult } from './types';
3
2
  import { type Logger } from '@applitools/logger';
4
- type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
5
- eyes: Eyes<TSpec, TType>;
3
+ type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
4
+ eyes: Eyes<TDriver, TContext, TElement, TSelector, TType>;
6
5
  logger: Logger;
7
6
  };
8
- export declare function makeClose<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ eyes, logger: defaultLogger, }: Options<TSpec, TType>): ({ settings, config, logger, }?: {
7
+ export declare function makeClose<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'>({ eyes, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TType>): ({ settings, config, logger, }?: {
9
8
  settings?: CloseSettings<TType> | undefined;
10
- config?: Config<TSpec, TType> | undefined;
9
+ config?: Config<TElement, TSelector, TType> | undefined;
11
10
  logger?: Logger | undefined;
12
- }) => Promise<void>;
11
+ }) => Promise<TestResult<TType>[]>;
13
12
  export {};
package/types/core.d.ts CHANGED
@@ -1,14 +1,14 @@
1
1
  import type { Core } from './types';
2
2
  import type { Core as BaseCore } from '@applitools/core-base';
3
- import { type SpecType, type SpecDriver } from '@applitools/driver';
3
+ import { type SpecDriver } from '@applitools/driver';
4
4
  import { type Logger } from '@applitools/logger';
5
- type Options<TSpec extends SpecType> = {
6
- spec?: SpecDriver<TSpec>;
5
+ type Options<TDriver, TContext, TElement, TSelector> = {
6
+ spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
7
7
  concurrency?: number;
8
8
  core?: BaseCore;
9
9
  agentId?: string;
10
10
  cwd?: string;
11
11
  logger?: Logger;
12
12
  };
13
- export declare function makeCore<TSpec extends SpecType>({ spec, concurrency, core, agentId, cwd, logger, }?: Options<TSpec>): Core<TSpec, 'classic' | 'ufg'>;
13
+ export declare function makeCore<TDriver, TContext, TElement, TSelector>({ spec, concurrency, core, agentId, cwd, logger, }?: Options<TDriver, TContext, TElement, TSelector>): Core<TDriver, TContext, TElement, TSelector>;
14
14
  export {};
@@ -1,4 +1,2 @@
1
- import { CoreError } from '@applitools/core-base';
2
- export declare class AbortError extends CoreError {
3
- constructor(message: string, info?: Record<string, any>);
1
+ export declare class AbortError extends Error {
4
2
  }
@@ -1,17 +1,15 @@
1
1
  import type { MaybeArray } from '@applitools/utils';
2
- import type { Target, Config, ExtractTextSettings } from './types';
3
- import type { Core as BaseCore } from '@applitools/core-base';
2
+ import type { Target, DriverTarget, Eyes, Config, ExtractTextSettings } from './types';
4
3
  import { type Logger } from '@applitools/logger';
5
- import { type SpecType, type SpecDriver } from '@applitools/driver';
6
- type Options<TSpec extends SpecType> = {
7
- spec?: SpecDriver<TSpec>;
8
- core: BaseCore;
4
+ type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
5
+ eyes: Eyes<TDriver, TContext, TElement, TSelector, TType>;
6
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
9
7
  logger: Logger;
10
8
  };
11
- export declare function makeExtractText<TSpec extends SpecType>({ spec, core, logger: defaultLogger }: Options<TSpec>): ({ target, settings, config, logger, }: {
12
- target: Target<TSpec, 'classic'>;
13
- settings: MaybeArray<ExtractTextSettings<TSpec>>;
14
- config?: Config<TSpec, "classic"> | undefined;
9
+ export declare function makeExtractText<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg' = 'classic'>({ eyes, target: defaultTarget, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TType>): ({ target, settings, config, logger, }: {
10
+ target?: import("./classic/types").ClassicTarget<TDriver, TContext, TElement, TSelector> | undefined;
11
+ settings: MaybeArray<ExtractTextSettings<TElement, TSelector, 'classic'>>;
12
+ config?: Config<TElement, TSelector, "classic"> | undefined;
15
13
  logger?: Logger | undefined;
16
14
  }) => Promise<string[]>;
17
15
  export {};
@@ -1,22 +1,21 @@
1
1
  import type { DriverTarget, TypedCore, TypedEyes, OpenSettings } from './types';
2
- import { type SpecType } from '@applitools/driver';
3
2
  import { type Renderer } from '@applitools/ufg-client';
4
3
  import { type Logger } from '@applitools/logger';
5
- type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
4
+ type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
6
5
  type: TType;
7
6
  settings: OpenSettings<TType>;
8
- target?: DriverTarget<TSpec>;
7
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
9
8
  cores: {
10
- [TKey in 'classic' | 'ufg']: TypedCore<TSpec, TKey>;
9
+ [TKey in 'classic' | 'ufg']: TypedCore<TDriver, TContext, TElement, TSelector, TKey>;
11
10
  };
12
11
  logger?: Logger;
13
12
  };
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, }?: {
13
+ export declare function makeGetTypedEyes<TDriver, TContext, TElement, TSelector, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, settings: defaultSettings, target, cores, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings, logger, }?: {
15
14
  type?: TType | undefined;
16
15
  settings?: {
17
16
  type: 'web' | 'native';
18
17
  renderers: Renderer[];
19
18
  } | undefined;
20
19
  logger?: Logger | undefined;
21
- }) => Promise<TypedEyes<TSpec, TType, import("./types").Target<TSpec, TType>>>;
20
+ }) => Promise<TypedEyes<TDriver, TContext, TElement, TSelector, TType, import("./types").Target<TDriver, TContext, TElement, TSelector, TType>>>;
22
21
  export {};
package/types/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  export * from './types';
2
- export * from './core';
3
2
  export { type Selector } from '@applitools/driver';
4
- export * from '@applitools/driver/dist/debug';
5
- export * as formatters from './utils/format-results';
3
+ export * from './core';
6
4
  export { takeDomSnapshots } from './ufg/utils/take-dom-snapshots';
5
+ export * as formatters from './utils/format-results';
6
+ export * from '@applitools/driver/dist/debug';
@@ -1,16 +1,14 @@
1
- import type { Target, Config, LocateTextSettings, LocateTextResult } from './types';
2
- import type { Core as BaseCore } from '@applitools/core-base';
1
+ import type { DriverTarget, Target, Eyes, Config, LocateTextSettings, LocateTextResult } from './types';
3
2
  import { type Logger } from '@applitools/logger';
4
- import { type SpecType, type SpecDriver } from '@applitools/driver';
5
- type Options<TSpec extends SpecType> = {
6
- spec?: SpecDriver<TSpec>;
7
- core: BaseCore;
3
+ type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
4
+ eyes: Eyes<TDriver, TContext, TElement, TSelector, TType>;
5
+ target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
8
6
  logger: Logger;
9
7
  };
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;
8
+ export declare function makeLocateText<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg' = 'classic'>({ eyes, target: defaultTarget, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TType>): <TPattern extends string>({ target, settings, config, logger, }: {
9
+ target?: import("./classic/types").ClassicTarget<TDriver, TContext, TElement, TSelector> | undefined;
10
+ settings: import("./automation/types").LocateTextSettings<TPattern, TElement, TSelector>;
11
+ config?: Config<TElement, TSelector, "classic"> | undefined;
14
12
  logger?: Logger | undefined;
15
13
  }) => Promise<LocateTextResult<TPattern>>;
16
14
  export {};
package/types/locate.d.ts CHANGED
@@ -1,17 +1,17 @@
1
1
  import type { Region } from '@applitools/utils';
2
- import type { Target, Config, LocateSettings } from './types';
2
+ import type { DriverTarget, ImageTarget, 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 SpecType, type SpecDriver } from '@applitools/driver';
6
- type Options<TSpec extends SpecType> = {
7
- spec?: SpecDriver<TSpec>;
5
+ import { type SpecDriver } from '@applitools/driver';
6
+ type Options<TDriver, TContext, TElement, TSelector> = {
7
+ spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
8
8
  core: BaseCore;
9
9
  logger: Logger;
10
10
  };
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;
11
+ export declare function makeLocate<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'>({ spec, core, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): <TLocator extends string>({ target, settings, config, logger, }: {
12
+ target: DriverTarget<TDriver, TContext, TElement, TSelector> | ImageTarget;
13
+ settings: LocateSettings<TLocator, TElement, TSelector>;
14
+ config?: Config<TElement, TSelector, TType> | undefined;
15
15
  logger?: Logger | undefined;
16
16
  }) => Promise<Record<TLocator, Region[]>>;
17
17
  export {};
@@ -1,16 +1,16 @@
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 SpecType, type SpecDriver } from '@applitools/driver';
5
- type Options<TSpec extends SpecType> = {
6
- spec?: SpecDriver<TSpec>;
4
+ import { type SpecDriver } from '@applitools/driver';
5
+ type Options<TDriver, TContext, TElement, TSelector> = {
6
+ spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
7
7
  core?: BaseCore;
8
8
  concurrency?: number;
9
9
  agentId?: string;
10
10
  cwd?: string;
11
11
  logger: Logger;
12
12
  };
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, }?: {
13
+ export declare function makeMakeManager<TDriver, TContext, TElement, TSelector>({ spec, core, concurrency: defaultConcurrency, agentId: defaultAgentId, cwd, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): <TType extends "classic" | "ufg" = "classic">({ type, concurrency, legacyConcurrency, batch, agentId, logger, }?: {
14
14
  type?: TType | undefined;
15
15
  concurrency?: number | undefined;
16
16
  /** @deprecated */
@@ -18,5 +18,5 @@ export declare function makeMakeManager<TSpec extends SpecType>({ spec, core, co
18
18
  batch?: Batch | undefined;
19
19
  agentId?: string | undefined;
20
20
  logger?: Logger | undefined;
21
- }) => Promise<EyesManager<TSpec, TType>>;
21
+ }) => Promise<EyesManager<TDriver, TContext, TElement, TSelector, TType>>;
22
22
  export {};
@@ -1,23 +1,23 @@
1
- import type { TypedCore, Batch, Eyes, Config, OpenSettings, DriverTarget } from './types';
1
+ import type { TypedCore, Batch, Eyes, Config, OpenSettings } from './types';
2
2
  import type { Core as BaseCore } from '@applitools/core-base';
3
3
  import { type Logger } from '@applitools/logger';
4
- import { type SpecType, type SpecDriver } from '@applitools/driver';
5
- type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
4
+ import { type SpecDriver } from '@applitools/driver';
5
+ type Options<TDriver, TContext, TElement, TSelector, 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<TSpec, TKey>;
11
+ [TKey in 'classic' | 'ufg']: TypedCore<TDriver, TContext, TElement, TSelector, TKey>;
12
12
  };
13
- spec?: SpecDriver<TSpec>;
13
+ spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
14
14
  logger: Logger;
15
15
  };
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, }: {
16
+ export declare function makeOpenEyes<TDriver, TContext, TElement, TSelector, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, concurrency, batch, core, cores, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings, config, target, logger, }: {
17
17
  type?: TType | undefined;
18
18
  settings?: Partial<OpenSettings<TDefaultType> & OpenSettings<TType>> | undefined;
19
- config?: (Config<TSpec, TDefaultType> & Config<TSpec, TType>) | undefined;
20
- target?: DriverTarget<TSpec> | undefined;
19
+ config?: (Config<TElement, TSelector, TDefaultType> & Config<TElement, TSelector, TType>) | undefined;
20
+ target?: TDriver | undefined;
21
21
  logger?: Logger | undefined;
22
- }) => Promise<Eyes<TSpec, TType, import("./types").Target<TSpec, TType>>>;
22
+ }) => Promise<Eyes<TDriver, TContext, TElement, TSelector, TType, import("./types").Target<TDriver, TContext, TElement, TSelector, TType>>>;
23
23
  export {};