@applitools/core 4.23.0 → 4.23.1

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 (40) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/dist/ufg/utils/take-dom-snapshot.js +9 -10
  3. package/package.json +2 -2
  4. package/types/abort.d.ts +2 -2
  5. package/types/automation/abort.d.ts +2 -2
  6. package/types/automation/close.d.ts +2 -2
  7. package/types/automation/extract-text.d.ts +1 -1
  8. package/types/automation/get-results.d.ts +2 -2
  9. package/types/automation/get-viewport-size.d.ts +1 -1
  10. package/types/automation/locate-text.d.ts +1 -1
  11. package/types/automation/locate.d.ts +1 -1
  12. package/types/automation/set-viewport-size.d.ts +1 -1
  13. package/types/automation/utils/to-base-check-settings.d.ts +1 -1
  14. package/types/autonomous/take-snapshots.d.ts +1 -1
  15. package/types/check-and-close.d.ts +5 -5
  16. package/types/check.d.ts +5 -5
  17. package/types/classic/check-and-close.d.ts +3 -11
  18. package/types/classic/check.d.ts +3 -3
  19. package/types/classic/get-base-eyes.d.ts +1 -1
  20. package/types/classic/open-eyes.d.ts +3 -3
  21. package/types/close-batch.d.ts +1 -1
  22. package/types/close.d.ts +3 -3
  23. package/types/delete-test.d.ts +1 -1
  24. package/types/extract-text.d.ts +2 -2
  25. package/types/get-account-info.d.ts +1 -1
  26. package/types/get-ec-client.d.ts +2 -2
  27. package/types/get-eyes-results.d.ts +2 -2
  28. package/types/get-manager-results.d.ts +2 -2
  29. package/types/get-typed-eyes.d.ts +2 -2
  30. package/types/locate-text.d.ts +2 -2
  31. package/types/locate.d.ts +2 -2
  32. package/types/make-manager.d.ts +3 -3
  33. package/types/open-eyes.d.ts +5 -5
  34. package/types/ufg/check-and-close.d.ts +3 -24
  35. package/types/ufg/check.d.ts +3 -3
  36. package/types/ufg/get-base-eyes.d.ts +1 -1
  37. package/types/ufg/get-ufg-client.d.ts +1 -1
  38. package/types/ufg/open-eyes.d.ts +3 -3
  39. package/types/ufg/take-snapshots.d.ts +2 -2
  40. package/types/ufg/utils/take-dom-snapshot.d.ts +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,20 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.23.1](https://github.com/Applitools-Dev/sdk/compare/js/core@4.23.0...js/core@4.23.1) (2024-11-09)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * overcome dom snapshot's failure to download resource from browser ([#2610](https://github.com/Applitools-Dev/sdk/issues/2610)) ([47d46fb](https://github.com/Applitools-Dev/sdk/commit/47d46fbe3baab12d5153f6617ab60142a8a215cf))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * @applitools/dom-snapshot bumped to 4.11.8
14
+ #### Bug Fixes
15
+
16
+ * overcome dom snapshot's failure to download resource from browser ([#2610](https://github.com/Applitools-Dev/sdk/issues/2610)) ([47d46fb](https://github.com/Applitools-Dev/sdk/commit/47d46fbe3baab12d5153f6617ab60142a8a215cf))
17
+
3
18
  ## [4.23.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.22.1...js/core@4.23.0) (2024-11-07)
4
19
 
5
20
 
@@ -146,27 +146,26 @@ function extractCrossFrames({ snapshot, parent = null, logger, }) {
146
146
  });
147
147
  logger.log(...(snapshot.crossFrames
148
148
  ? [
149
- `frames paths for ${JSON.stringify(snapshot.crossFrames)}:`,
149
+ `dom snapshot - frames paths for ${JSON.stringify(snapshot.crossFrames)}:`,
150
150
  crossFrames.map(selector => ({
151
151
  // we don't want `selector.parentSnapshot` to be logged - the size of it can be huge
152
152
  cdtNode: selector.cdtNode,
153
153
  reference: selector.reference,
154
154
  })),
155
155
  ]
156
- : ['no cross frames found']));
156
+ : ['dom snapshot - no cross frames found']));
157
157
  return crossFrames;
158
158
  }
159
159
  function logSnapshot(logger, snapshot) {
160
160
  try {
161
- logger.log(`dom snapshot cdt length: ${snapshot.cdt.length}`);
162
- logger.log(`blobs urls (${snapshot.blobs.length}):`, JSON.stringify(snapshot.blobs.map(({ url }) => url)));
163
- logger.log(`resource urls (${snapshot.resourceUrls.length}):`, JSON.stringify(snapshot.resourceUrls));
164
- logger.log(`cdt nodes with data-applitools-selector: ${JSON.stringify(snapshot.cdt.filter(node => { var _a; return (_a = node.attributes) === null || _a === void 0 ? void 0 : _a.some(attr => attr.name === 'data-applitools-selector'); }))}`);
165
- logger.log('safeSelectors:', snapshot.safeSelectors);
161
+ logger.log(`dom snapshot - cdt length: ${snapshot.cdt.length}`);
162
+ logger.log(`dom snapshot - blobs urls (${snapshot.blobs.length}):`, JSON.stringify(snapshot.blobs.map(({ url }) => url)));
163
+ logger.log(`dom snapshot - resource urls (${snapshot.resourceUrls.length}):`, JSON.stringify(snapshot.resourceUrls));
164
+ logger.log(`dom snapshot - cdt nodes with data-applitools-selector: ${JSON.stringify(snapshot.cdt.filter(node => { var _a; return (_a = node.attributes) === null || _a === void 0 ? void 0 : _a.some(attr => attr.name === 'data-applitools-selector'); }))}`);
165
+ logger.log('dom snapshot - safeSelectors:', snapshot.safeSelectors);
166
+ logger.log('dom snapshot - warnings:', snapshot.warnings);
166
167
  }
167
168
  catch (err) {
168
- logger.error(`error while logging cdt`, err);
169
+ logger.error(`error while logging dom snapshot`, err);
169
170
  }
170
- if (snapshot.error)
171
- logger.error('snapshot error:', snapshot.error);
172
171
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/core",
3
- "version": "4.23.0",
3
+ "version": "4.23.1",
4
4
  "homepage": "https://applitools.com",
5
5
  "bugs": {
6
6
  "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -76,7 +76,7 @@
76
76
  "dependencies": {
77
77
  "@applitools/core-base": "1.19.2",
78
78
  "@applitools/dom-capture": "11.5.1",
79
- "@applitools/dom-snapshot": "4.11.7",
79
+ "@applitools/dom-snapshot": "4.11.8",
80
80
  "@applitools/driver": "1.19.7",
81
81
  "@applitools/ec-client": "1.9.13",
82
82
  "@applitools/logger": "2.0.19",
package/types/abort.d.ts CHANGED
@@ -7,7 +7,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
7
7
  logger: Logger;
8
8
  };
9
9
  export declare function makeAbort<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ eyes, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec, TType>): ({ settings, logger, }?: {
10
- settings?: AbortSettings<TType> | undefined;
11
- logger?: Logger | undefined;
10
+ settings?: AbortSettings<TType>;
11
+ logger?: Logger;
12
12
  }) => Promise<void>;
13
13
  export {};
@@ -10,7 +10,7 @@ type Options<TSpec extends SpecType> = {
10
10
  logger: Logger;
11
11
  };
12
12
  export declare function makeAbort<TSpec extends SpecType>({ eyes, driver, controller, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }?: {
13
- settings?: AbortSettings | undefined;
14
- logger?: Logger | undefined;
13
+ settings?: AbortSettings;
14
+ logger?: Logger;
15
15
  }) => Promise<void>;
16
16
  export {};
@@ -8,7 +8,7 @@ type Options<TSpec extends SpecType> = {
8
8
  logger: Logger;
9
9
  };
10
10
  export declare function makeClose<TSpec extends SpecType>({ eyes, driver, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }?: {
11
- settings?: CloseSettings | undefined;
12
- logger?: Logger | undefined;
11
+ settings?: CloseSettings;
12
+ logger?: Logger;
13
13
  }) => Promise<void>;
14
14
  export {};
@@ -10,6 +10,6 @@ type Options<TSpec extends SpecType> = {
10
10
  export declare function makeExtractText<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): ({ target, settings, logger, }: {
11
11
  target: Target<TSpec>;
12
12
  settings: MaybeArray<ExtractTextSettings<TSpec>>;
13
- logger?: Logger | undefined;
13
+ logger?: Logger;
14
14
  }) => Promise<string[]>;
15
15
  export {};
@@ -5,7 +5,7 @@ type Options = {
5
5
  logger: Logger;
6
6
  };
7
7
  export declare function makeGetResults({ eyes, logger: mainLogger }: Options): ({ settings, logger, }?: {
8
- settings?: GetResultsSettings | undefined;
9
- logger?: Logger | undefined;
8
+ settings?: GetResultsSettings;
9
+ logger?: Logger;
10
10
  }) => Promise<TestResult[]>;
11
11
  export {};
@@ -7,6 +7,6 @@ type Options<TSpec extends SpecType> = {
7
7
  };
8
8
  export declare function makeGetViewportSize<TSpec extends SpecType>({ spec, logger: mainLogger }: Options<TSpec>): ({ target, logger }: {
9
9
  target: DriverTarget<TSpec>;
10
- logger?: Logger | undefined;
10
+ logger?: Logger;
11
11
  }) => Promise<import("@applitools/utils").Size>;
12
12
  export {};
@@ -9,6 +9,6 @@ type Options<TSpec extends SpecType> = {
9
9
  export declare function makeLocateText<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): <TPattern extends string>({ target, settings, logger, }: {
10
10
  target: Target<TSpec>;
11
11
  settings: LocateTextSettings<TPattern, TSpec>;
12
- logger?: Logger | undefined;
12
+ logger?: Logger;
13
13
  }) => Promise<LocateTextResult<TPattern>>;
14
14
  export {};
@@ -9,6 +9,6 @@ type Options<TSpec extends SpecType> = {
9
9
  export declare function makeLocate<TSpec extends SpecType>({ spec, core, logger: mainLogger }: Options<TSpec>): <TLocator extends string>({ settings, target, logger, }: {
10
10
  target: Target<TSpec>;
11
11
  settings: LocateSettings<TLocator, TSpec>;
12
- logger?: Logger | undefined;
12
+ logger?: Logger;
13
13
  }) => Promise<LocateResult<TLocator>>;
14
14
  export {};
@@ -9,6 +9,6 @@ type Options<TSpec extends SpecType> = {
9
9
  export declare function makeSetViewportSize<TSpec extends SpecType>({ spec, logger: mainLogger }: Options<TSpec>): ({ target, size, logger, }: {
10
10
  target: DriverTarget<TSpec>;
11
11
  size: Size;
12
- logger?: Logger | undefined;
12
+ logger?: Logger;
13
13
  }) => Promise<void>;
14
14
  export {};
@@ -22,6 +22,6 @@ export declare function toBaseCheckSettings<TSpec extends SpecType>({ settings }
22
22
  selector?: Selector;
23
23
  regions: Region[];
24
24
  }[];
25
- preserveTransformation?: boolean | undefined;
25
+ preserveTransformation?: boolean;
26
26
  }) => BaseCheckSettings;
27
27
  };
@@ -10,6 +10,6 @@ type Options<TSpec extends SpecType> = {
10
10
  export declare function makeTakeSnapshots<TSpec extends SpecType>({ core, spec, logger: defaultLogger }: Options<TSpec>): ({ target, settings, logger, }: {
11
11
  target: DriverTarget<TSpec>;
12
12
  settings: SnapshotSettings<TSpec>;
13
- logger?: Logger | undefined;
13
+ logger?: Logger;
14
14
  }) => Promise<Snapshot[]>;
15
15
  export {};
@@ -9,10 +9,10 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
9
9
  logger: Logger;
10
10
  };
11
11
  export declare function makeCheckAndClose<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, eyes, target: defaultTarget, spec, logger: mainLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, target, settings, config, logger, }?: {
12
- type?: TType | undefined;
13
- target?: Target<TSpec, TType> | undefined;
14
- settings?: (CheckSettings<TSpec, TDefaultType> & CloseSettings<TDefaultType> & CheckSettings<TSpec, TType> & CloseSettings<TType>) | undefined;
15
- config?: (Config<TSpec, TDefaultType> & Config<TSpec, TType>) | undefined;
16
- logger?: Logger | undefined;
12
+ type?: TType;
13
+ target?: Target<TSpec, TType>;
14
+ settings?: CheckSettings<TSpec, TDefaultType> & CloseSettings<TDefaultType> & CheckSettings<TSpec, TType> & CloseSettings<TType>;
15
+ config?: Config<TSpec, TDefaultType> & Config<TSpec, TType>;
16
+ logger?: Logger;
17
17
  }) => Promise<void>;
18
18
  export {};
package/types/check.d.ts CHANGED
@@ -9,10 +9,10 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
9
9
  logger: Logger;
10
10
  };
11
11
  export declare function makeCheck<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, eyes, target: defaultTarget, spec, logger: mainLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, target, settings, config, logger, }?: {
12
- type?: TType | undefined;
13
- target?: Target<TSpec, TType> | undefined;
14
- settings?: CheckSettings<TSpec, TType> | undefined;
15
- config?: Config<TSpec, TType> | undefined;
16
- logger?: Logger | undefined;
12
+ type?: TType;
13
+ target?: Target<TSpec, TType>;
14
+ settings?: CheckSettings<TSpec, TType>;
15
+ config?: Config<TSpec, TType>;
16
+ logger?: Logger;
17
17
  }) => Promise<void>;
18
18
  export {};
@@ -1,9 +1,7 @@
1
1
  import type { Target, DriverTarget, Eyes, CheckSettings, CloseSettings, Environment } from './types';
2
- import type { CheckSettings as BaseCheckSettings, CloseSettings as BaseCloseSettings } from '@applitools/core-base';
3
2
  import { type AbortSignal } from 'abort-controller';
4
3
  import { type Logger } from '@applitools/logger';
5
4
  import { type SpecType, type SpecDriver } from '@applitools/driver';
6
- import * as utils from '@applitools/utils';
7
5
  type Options<TSpec extends SpecType> = {
8
6
  eyes: Eyes<TSpec>;
9
7
  target?: DriverTarget<TSpec>;
@@ -13,14 +11,8 @@ type Options<TSpec extends SpecType> = {
13
11
  logger: Logger;
14
12
  };
15
13
  export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
16
- target?: Target<TSpec> | undefined;
17
- settings?: (BaseCheckSettings<utils.Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
18
- environments?: Environment[] | undefined;
19
- } & {
20
- retryTimeout?: number | undefined;
21
- } & BaseCloseSettings & {
22
- environments?: Environment[] | undefined;
23
- }) | undefined;
24
- logger?: Logger | undefined;
14
+ target?: Target<TSpec>;
15
+ settings?: CheckSettings<TSpec> & CloseSettings;
16
+ logger?: Logger;
25
17
  }) => Promise<void>;
26
18
  export {};
@@ -11,8 +11,8 @@ type Options<TSpec extends SpecType> = {
11
11
  logger: Logger;
12
12
  };
13
13
  export declare function makeCheck<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
14
- target?: Target<TSpec> | undefined;
15
- settings?: CheckSettings<TSpec> | undefined;
16
- logger?: Logger | undefined;
14
+ target?: Target<TSpec>;
15
+ settings?: CheckSettings<TSpec>;
16
+ logger?: Logger;
17
17
  }) => Promise<void>;
18
18
  export {};
@@ -9,6 +9,6 @@ type Options<TSpec extends SpecType> = {
9
9
  };
10
10
  export declare function makeGetBaseEyes<TSpec extends SpecType>({ settings: defaultSettings, eyes, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }: {
11
11
  settings: GetBaseEyesSettings<TSpec>;
12
- logger?: Logger | undefined;
12
+ logger?: Logger;
13
13
  }) => Promise<BaseEyes>;
14
14
  export {};
@@ -7,9 +7,9 @@ type Options<TSpec extends SpecType> = {
7
7
  logger: Logger;
8
8
  };
9
9
  export declare function makeOpenEyes<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): ({ target, settings, storage, logger, }: {
10
- target?: DriverTarget<TSpec> | undefined;
10
+ target?: DriverTarget<TSpec>;
11
11
  settings: OpenSettings;
12
- storage?: EyesStorage | undefined;
13
- logger?: Logger | undefined;
12
+ storage?: EyesStorage;
13
+ logger?: Logger;
14
14
  }) => Promise<Eyes<TSpec>>;
15
15
  export {};
@@ -7,6 +7,6 @@ type Options = {
7
7
  };
8
8
  export declare function makeCloseBatch({ core, logger: mainLogger }: Options): ({ settings, logger, }: {
9
9
  settings: MaybeArray<CloseBatchSettings>;
10
- logger?: Logger | undefined;
10
+ logger?: Logger;
11
11
  }) => Promise<void>;
12
12
  export {};
package/types/close.d.ts CHANGED
@@ -7,8 +7,8 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
7
7
  logger: Logger;
8
8
  };
9
9
  export declare function makeClose<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ eyes, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec, TType>): ({ settings, config, logger, }?: {
10
- settings?: CloseSettings<TType> | undefined;
11
- config?: Config<TSpec, TType> | undefined;
12
- logger?: Logger | undefined;
10
+ settings?: CloseSettings<TType>;
11
+ config?: Config<TSpec, TType>;
12
+ logger?: Logger;
13
13
  }) => Promise<void>;
14
14
  export {};
@@ -7,6 +7,6 @@ type Options = {
7
7
  };
8
8
  export declare function makeDeleteTest({ core, logger: mainLogger }: Options): ({ settings, logger, }: {
9
9
  settings: MaybeArray<DeleteTestSettings>;
10
- logger?: Logger | undefined;
10
+ logger?: Logger;
11
11
  }) => Promise<void>;
12
12
  export {};
@@ -10,7 +10,7 @@ type Options<TSpec extends SpecType> = {
10
10
  export declare function makeExtractText<TSpec extends SpecType>({ spec, core, logger: mainLogger }: Options<TSpec>): ({ target, settings, config, logger, }: {
11
11
  target: Target<TSpec, 'classic'>;
12
12
  settings: MaybeArray<ExtractTextSettings<TSpec>>;
13
- config?: Config<TSpec, "classic"> | undefined;
14
- logger?: Logger | undefined;
13
+ config?: Config<TSpec, 'classic'>;
14
+ logger?: Logger;
15
15
  }) => Promise<string[]>;
16
16
  export {};
@@ -6,6 +6,6 @@ type Options = {
6
6
  };
7
7
  export declare function makeGetAccountInfo({ core, logger: mainLogger }: Options): ({ settings, logger, }: {
8
8
  settings: EyesServerSettings;
9
- logger?: Logger | undefined;
9
+ logger?: Logger;
10
10
  }) => Promise<Account>;
11
11
  export {};
@@ -4,8 +4,8 @@ type Options = {
4
4
  logger: Logger;
5
5
  };
6
6
  export declare function makeGetECClient({ logger: mainLogger }: Options): (({ settings, logger, }?: {
7
- settings?: Partial<ECClientSettings> | undefined;
8
- logger?: Logger | undefined;
7
+ settings?: Partial<ECClientSettings>;
8
+ logger?: Logger;
9
9
  }) => Promise<ECClient>) & {
10
10
  getCachedValues(): Promise<ECClient>[];
11
11
  setCachedValue(key: any, value: Promise<ECClient>): void;
@@ -6,7 +6,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
6
6
  logger: Logger;
7
7
  };
8
8
  export declare function makeGetEyesResults<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ eyes, logger: mainLogger, }: Options<TSpec, TType>): ({ settings, logger, }?: {
9
- settings?: GetEyesResultsSettings<TType> | undefined;
10
- logger?: Logger | undefined;
9
+ settings?: GetEyesResultsSettings<TType>;
10
+ logger?: Logger;
11
11
  }) => Promise<TestResult<TType>[]>;
12
12
  export {};
@@ -7,7 +7,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
7
7
  logger: Logger;
8
8
  };
9
9
  export declare function makeGetManagerResults<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ core, storage, logger: mainLogger, }: Options<TSpec, TType>): ({ settings, logger, }?: {
10
- settings?: GetManagerResultsSettings<TType> | undefined;
11
- logger?: Logger | undefined;
10
+ settings?: GetManagerResultsSettings<TType>;
11
+ logger?: Logger;
12
12
  }) => Promise<TestResultSummary<TType>>;
13
13
  export {};
@@ -11,7 +11,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
11
11
  logger: Logger;
12
12
  };
13
13
  export declare function makeGetTypedEyes<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, settings: defaultSettings, target, cores, logger: mainLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, logger, }?: {
14
- type?: TType | undefined;
15
- logger?: Logger | undefined;
14
+ type?: TType;
15
+ logger?: Logger;
16
16
  }) => Promise<TypedEyes<TSpec, TType>>;
17
17
  export {};
@@ -9,7 +9,7 @@ type Options<TSpec extends SpecType> = {
9
9
  export declare function makeLocateText<TSpec extends SpecType>({ spec, core, logger: mainLogger }: Options<TSpec>): <TPattern extends string>({ target, settings, config, logger, }: {
10
10
  target: Target<TSpec, 'classic'>;
11
11
  settings: LocateTextSettings<TPattern, TSpec>;
12
- config?: Config<TSpec, "classic"> | undefined;
13
- logger?: Logger | undefined;
12
+ config?: Config<TSpec, 'classic'>;
13
+ logger?: Logger;
14
14
  }) => Promise<LocateTextResult<TPattern>>;
15
15
  export {};
package/types/locate.d.ts CHANGED
@@ -10,7 +10,7 @@ type Options<TSpec extends SpecType> = {
10
10
  export declare function makeLocate<TSpec extends SpecType>({ spec, core, logger: mainLogger }: Options<TSpec>): <TLocator extends string>({ target, settings, config, logger, }: {
11
11
  target: Target<TSpec, 'classic'>;
12
12
  settings: LocateSettings<TLocator, TSpec>;
13
- config?: Config<TSpec, "classic"> | undefined;
14
- logger?: Logger | undefined;
13
+ config?: Config<TSpec, 'classic'>;
14
+ logger?: Logger;
15
15
  }) => Promise<Record<TLocator, Region[]>>;
16
16
  export {};
@@ -20,8 +20,8 @@ type Options<TSpec extends SpecType> = {
20
20
  offlineLocationPath?: string;
21
21
  };
22
22
  export declare function makeMakeManager<TSpec extends SpecType>({ spec, clients, core, base: defaultBase, agentId: defaultAgentId, environment, cwd, logger: mainLogger, asyncCache, offlineLocationPath, }: Options<TSpec>): <TType extends "classic" | "ufg" = "classic">({ type, settings, logger, }?: {
23
- type?: TType | undefined;
24
- settings?: ManagerSettings | undefined;
25
- logger?: Logger | undefined;
23
+ type?: TType;
24
+ settings?: ManagerSettings;
25
+ logger?: Logger;
26
26
  }) => Promise<EyesManager<TSpec, TType>>;
27
27
  export {};
@@ -22,10 +22,10 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
22
22
  cwd?: string;
23
23
  };
24
24
  export declare function makeOpenEyes<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, clients, batch, removeDuplicateTests, core, cores, spec, environment, logger: mainLogger, asyncCache, cwd, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings: openSettings, config, target, logger, }: {
25
- type?: TType | undefined;
26
- settings?: Partial<OpenSettings<TDefaultType> & OpenSettings<TType>> | undefined;
27
- config?: (Config<TSpec, TDefaultType> & Config<TSpec, TType>) | undefined;
28
- target?: DriverTarget<TSpec> | undefined;
29
- logger?: Logger | undefined;
25
+ type?: TType;
26
+ settings?: Partial<OpenSettings<TDefaultType> & OpenSettings<TType>>;
27
+ config?: Config<TSpec, TDefaultType> & Config<TSpec, TType>;
28
+ target?: DriverTarget<TSpec>;
29
+ logger?: Logger;
30
30
  }) => Promise<Eyes<TSpec, TType>>;
31
31
  export {};
@@ -2,7 +2,6 @@ import type { DriverTarget, Target, Eyes, CheckSettings, CloseSettings, Environm
2
2
  import { type AbortSignal } from 'abort-controller';
3
3
  import { type Logger } from '@applitools/logger';
4
4
  import { type SpecType, type SpecDriver } from '@applitools/driver';
5
- import * as utils from '@applitools/utils';
6
5
  type Options<TSpec extends SpecType> = {
7
6
  eyes: Eyes<TSpec>;
8
7
  target?: DriverTarget<TSpec>;
@@ -12,28 +11,8 @@ type Options<TSpec extends SpecType> = {
12
11
  logger: Logger;
13
12
  };
14
13
  export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
15
- target?: Target<TSpec> | undefined;
16
- settings?: (import("@applitools/core-base").CheckSettings<utils.Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
17
- environments?: Environment[] | undefined;
18
- } & {
19
- disableBrowserFetching?: boolean | undefined;
20
- layoutBreakpoints?: {
21
- breakpoints: boolean | number[];
22
- reload?: boolean | undefined;
23
- } | undefined;
24
- hooks?: {
25
- beforeCaptureScreenshot: string;
26
- } | undefined;
27
- ufgOptions?: Record<string, any> | undefined;
28
- prefixRenderId?: string | undefined;
29
- autProxy?: (import("@applitools/req").Proxy & {
30
- mode?: "Allow" | "Block" | undefined;
31
- domains?: string[] | undefined;
32
- }) | undefined;
33
- headers?: Record<string, string> | undefined;
34
- } & import("@applitools/core-base").CloseSettings & {
35
- environments?: Environment[] | undefined;
36
- }) | undefined;
37
- logger?: Logger | undefined;
14
+ target?: Target<TSpec>;
15
+ settings?: CheckSettings<TSpec> & CloseSettings;
16
+ logger?: Logger;
38
17
  }) => Promise<void>;
39
18
  export {};
@@ -11,8 +11,8 @@ type Options<TSpec extends SpecType> = {
11
11
  logger: Logger;
12
12
  };
13
13
  export declare function makeCheck<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
14
- target?: Target<TSpec> | undefined;
15
- settings?: CheckSettings<TSpec> | undefined;
16
- logger?: Logger | undefined;
14
+ target?: Target<TSpec>;
15
+ settings?: CheckSettings<TSpec>;
16
+ logger?: Logger;
17
17
  }) => Promise<void>;
18
18
  export {};
@@ -10,6 +10,6 @@ type Options<TSpec extends SpecType> = {
10
10
  };
11
11
  export declare function makeGetBaseEyes<TSpec extends SpecType>({ settings: defaultSettings, eyes, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }: {
12
12
  settings: GetBaseEyesSettings<TSpec>;
13
- logger?: Logger | undefined;
13
+ logger?: Logger;
14
14
  }) => Promise<BaseEyes>;
15
15
  export {};
@@ -9,7 +9,7 @@ type Options = {
9
9
  };
10
10
  export declare function makeGetUFGClient({ client, fetchConcurrency, offlineLocationPath, logger: mainLogger, asyncCache, }: Options): (({ settings, logger }: {
11
11
  settings: UFGClientSettings;
12
- logger?: Logger | undefined;
12
+ logger?: Logger;
13
13
  }) => Promise<UFGClient>) & {
14
14
  getCachedValues(): Promise<UFGClient>[];
15
15
  setCachedValue(key: any, value: Promise<UFGClient>): void;
@@ -7,9 +7,9 @@ type Options<TSpec extends SpecType> = {
7
7
  logger: Logger;
8
8
  };
9
9
  export declare function makeOpenEyes<TSpec extends SpecType>({ core, spec, logger: mainLogger }: Options<TSpec>): ({ target, settings, storage, logger, }: {
10
- target?: DriverTarget<TSpec> | undefined;
10
+ target?: DriverTarget<TSpec>;
11
11
  settings: OpenSettings;
12
- storage?: EyesStorage | undefined;
13
- logger?: Logger | undefined;
12
+ storage?: EyesStorage;
13
+ logger?: Logger;
14
14
  }) => Promise<Eyes<TSpec>>;
15
15
  export {};
@@ -10,8 +10,8 @@ type Options<TSpec extends SpecType> = {
10
10
  };
11
11
  export declare function makeTakeSnapshots<TSpec extends SpecType>({ core, spec, signal, logger: mainLogger }: Options<TSpec>): ({ driver, settings, account, logger, }: {
12
12
  driver: Driver<TSpec>;
13
- settings?: SnapshotSettings<TSpec> | undefined;
13
+ settings?: SnapshotSettings<TSpec>;
14
14
  account: Account;
15
- logger?: Logger | undefined;
15
+ logger?: Logger;
16
16
  }) => Promise<Snapshot[]>;
17
17
  export {};
@@ -23,7 +23,7 @@ export type RawDomSnapshot = {
23
23
  srcAttr: string | null;
24
24
  scriptVersion: string;
25
25
  safeSelectors?: (CommonSelector | null)[];
26
- error?: string;
26
+ warnings?: string[];
27
27
  };
28
28
  export type DomSnapshotSettings<TSpec extends SpecType> = {
29
29
  disableBrowserFetching?: boolean;