@applitools/core 2.5.1 → 2.5.3-legacy

package/types/universal/types.d.ts

@@ -27,9 +27,10 @@ export type ClientSocket<TSpec extends SpecType, TType extends 'classic' | 'ufg'
 export type ServerSocket<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = unknown & Listener<Universalize<UniversalCore<TSpec, TType>, 'Core'>> & Emitter<Universalize<UniversalLogger, 'Logger'>> & Server<Universalize<MainCore.Core<TSpec, TType>, 'Core'>> & Server<Universalize<MainCore.EyesManager<TSpec, TType>, 'EyesManager', 'manager'>> & Server<Universalize<MainCore.Eyes<TSpec, TType>, 'Eyes', 'eyes'>> & Server<Universalize<UniversalDebug<TSpec>, 'Debug'>> & Client<Universalize<UniversalSpecDriver<TSpec>, 'Driver'>>;
 export interface UniversalCore<TSpec extends SpecType, TType extends 'classic' | 'ufg'> {
     makeCore(options: {
+        spec: 'webdriver' | (keyof UniversalSpecDriver<TSpec>)[];
         agentId: string;
+        environment?: Record<string, any>;
         cwd: string;
-        spec: 'webdriver' | (keyof UniversalSpecDriver<TSpec>)[];
     }): Promise<MainCore.Core<TSpec, TType>>;
 }
 export interface UniversalLogger {
@@ -55,16 +56,6 @@ export interface UniversalSpecDriver<T extends SpecType> {
         element1: T['element'];
         element2: T['element'];
     }): Promise<boolean>;
-    mainContext(options: {
-        context: T['context'];
-    }): Promise<T['context']>;
-    parentContext(options: {
-        context: T['context'];
-    }): Promise<T['context']>;
-    childContext(options: {
-        context: T['context'];
-        element: T['element'];
-    }): Promise<T['context']>;
     executeScript(options: {
         context: T['context'];
         script: string;
@@ -86,6 +77,15 @@ export interface UniversalSpecDriver<T extends SpecType> {
         parent?: T['element'];
         options?: WaitOptions;
     }): Promise<T['element'] | null>;
+    getElementRegion(options: {
+        context: T['context'];
+        element: T['element'];
+    }): Promise<Region>;
+    getElementAttribute(options: {
+        context: T['context'];
+        element: T['element'];
+        attr: string;
+    }): Promise<string>;
     setElementText(options: {
         context: T['context'];
         element: T['element'];
@@ -95,6 +95,30 @@ export interface UniversalSpecDriver<T extends SpecType> {
         context: T['context'];
         element: T['element'];
     }): Promise<string>;
+    hover(options: {
+        context: T['context'];
+        element: T['element'];
+    }): Promise<void>;
+    click(options: {
+        context: T['context'];
+        element: T['element'];
+    }): Promise<void>;
+    mainContext(options: {
+        context: T['context'];
+    }): Promise<T['context']>;
+    parentContext(options: {
+        context: T['context'];
+    }): Promise<T['context']>;
+    childContext(options: {
+        context: T['context'];
+        element: T['element'];
+    }): Promise<T['context']>;
+    getDriverInfo(options: {
+        driver: T['driver'];
+    }): Promise<DriverInfo>;
+    getCapabilities(options: {
+        driver: T['driver'];
+    }): Promise<Record<string, any>>;
     setWindowSize(options: {
         driver: T['driver'];
         size: Size;
@@ -109,40 +133,6 @@ export interface UniversalSpecDriver<T extends SpecType> {
     getViewportSize(options: {
         driver: T['driver'];
     }): Promise<Size>;
-    getCookies(options: {
-        driver: T['driver'] | T['context'];
-        context?: boolean;
-    }): Promise<Cookie[]>;
-    getDriverInfo(options: {
-        driver: T['driver'];
-    }): Promise<DriverInfo>;
-    getCapabilities(options: {
-        driver: T['driver'];
-    }): Promise<Record<string, any>>;
-    getTitle(options: {
-        driver: T['driver'];
-    }): Promise<string>;
-    getUrl(options: {
-        driver: T['driver'];
-    }): Promise<string>;
-    takeScreenshot(options: {
-        driver: T['driver'];
-    }): Promise<string>;
-    click(options: {
-        context: T['context'];
-        element: T['element'] | T['selector'];
-    }): Promise<void>;
-    visit(options: {
-        driver: T['driver'];
-        url: string;
-    }): Promise<void>;
-    getOrientation(options: {
-        driver: T['driver'];
-    }): Promise<'portrait' | 'landscape' | 'portrait-secondary' | 'landscape-secondary'>;
-    setOrientation(options: {
-        driver: T['driver'];
-        orientation: 'portrait' | 'landscape' | 'portrait-secondary' | 'landscape-secondary';
-    }): Promise<void>;
     getSystemBars(options: {
         driver: T['driver'];
     }): Promise<{
@@ -161,19 +151,34 @@ export interface UniversalSpecDriver<T extends SpecType> {
             width: number;
         };
     }>;
-    getElementRegion(options: {
+    getOrientation(options: {
         driver: T['driver'];
-        element: T['element'];
-    }): Promise<Region>;
-    getElementAttribute(options: {
+    }): Promise<'portrait' | 'landscape' | 'portrait-secondary' | 'landscape-secondary'>;
+    setOrientation(options: {
+        driver: T['driver'];
+        orientation: 'portrait' | 'landscape' | 'portrait-secondary' | 'landscape-secondary';
+    }): Promise<void>;
+    getCookies(options: {
+        driver: T['driver'] | T['context'];
+        context?: boolean;
+    }): Promise<Cookie[]>;
+    getTitle(options: {
+        driver: T['driver'];
+    }): Promise<string>;
+    getUrl(options: {
+        driver: T['driver'];
+    }): Promise<string>;
+    takeScreenshot(options: {
         driver: T['driver'];
-        element: T['element'];
-        attr: string;
     }): Promise<string>;
     performAction(options: {
         driver: T['driver'];
         steps: any[];
     }): Promise<void>;
+    visit(options: {
+        driver: T['driver'];
+        url: string;
+    }): Promise<void>;
     getCurrentWorld(options: {
         driver: T['driver'];
     }): Promise<string>;
@@ -184,5 +189,8 @@ export interface UniversalSpecDriver<T extends SpecType> {
         driver: T['driver'];
         name: string;
     }): Promise<void>;
+    reload(options: {
+        driver: T['driver'];
+    }): Promise<void>;
 }
 export {};

package/types/utils/ensure-offline-folder.d.ts

@@ -0,0 +1 @@
+export declare function ensureOfflineFolder(): string | undefined;

package/types/utils/extract-branching-timestamp.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" />
+import type { ExecOptions } from 'child_process';
+import { type Logger } from '@applitools/logger';
+export declare const extractBranchingTimestamp: typeof extractGitBranchingTimestamp & {
+    getCachedValues(): Promise<string>[];
+    setCachedValue(key: any, value: Promise<string>): void;
+    clearCache(): void;
+};
+type ExtractGitBranchingTimestampOptions = {
+    branchName: string;
+    execOptions?: ExecOptions;
+    logger?: Logger;
+    parentBranchName: string;
+};
+declare function extractGitBranchingTimestamp({ branchName, parentBranchName, execOptions, logger, }: ExtractGitBranchingTimestampOptions): Promise<string>;
+export {};

package/types/utils/extract-current-commit.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+import type { ExecOptions } from 'child_process';
+import { type Logger } from '@applitools/logger';
+export declare const cacheKey = "extract-current-commit";
+export declare const extractLatestCommitInfo: typeof extractCommitInfo & {
+    getCachedValues(): Promise<{
+        timestamp: string;
+        sha: string;
+    } | undefined>[];
+    setCachedValue(key: any, value: Promise<{
+        timestamp: string;
+        sha: string;
+    } | undefined>): void;
+    clearCache(): void;
+};
+type ExtractCurrentCommitTimestampOptions = {
+    execOptions?: ExecOptions;
+    logger?: Logger;
+};
+declare function extractCommitInfo({ execOptions, logger, }: ExtractCurrentCommitTimestampOptions): Promise<{
+    timestamp: string;
+    sha: string;
+} | undefined>;
+export {};

package/types/utils/extract-git-info.d.ts

@@ -0,0 +1,59 @@
+/// <reference types="node" />
+import type { ExecOptions } from 'child_process';
+import { type Logger } from '@applitools/logger';
+type Options = {
+    execOptions?: ExecOptions;
+    logger: Logger;
+};
+type ExtractGitBranchingTimestampOptions = {
+    branchName: string;
+    execOptions?: ExecOptions;
+    logger?: Logger;
+    parentBranchName: string;
+};
+type ExtractCurrentCommitTimestampOptions = {
+    execOptions?: ExecOptions;
+    logger?: Logger;
+};
+export declare const cacheKey = "default";
+export declare const extractLatestCommitInfo: (({ execOptions, logger, }: ExtractCurrentCommitTimestampOptions) => Promise<{
+    timestamp: string;
+    sha: string;
+} | undefined>) & {
+    getCachedValues(): Promise<{
+        timestamp: string;
+        sha: string;
+    } | undefined>[];
+    setCachedValue(key: any, value: Promise<{
+        timestamp: string;
+        sha: string;
+    } | undefined>): void;
+    clearCache(): void;
+};
+export declare const extractGitBranch: (({ execOptions, logger }: Options) => Promise<string | undefined>) & {
+    getCachedValues(): Promise<string | undefined>[];
+    setCachedValue(key: any, value: Promise<string | undefined>): void;
+    clearCache(): void;
+};
+export declare const extractGitRepo: (({ execOptions, logger }: Options) => Promise<{
+    name?: string;
+    owner?: string;
+}>) & {
+    getCachedValues(): Promise<{
+        name?: string | undefined;
+        owner?: string | undefined;
+    }>[];
+    setCachedValue(key: any, value: Promise<{
+        name?: string | undefined;
+        owner?: string | undefined;
+    }>): void;
+    clearCache(): void;
+};
+export declare function extractBuildIdFromCI(): Promise<string | undefined>;
+export declare const extractBranchingTimestamp: (({ branchName, parentBranchName, execOptions, logger, }: ExtractGitBranchingTimestampOptions) => Promise<string | undefined>) & {
+    getCachedValues(): Promise<string | undefined>[];
+    setCachedValue(key: any, value: Promise<string | undefined>): void;
+    clearCache(): void;
+};
+export declare function isISODate(str: string): boolean;
+export {};

package/types/utils/extract-start-info.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="node" />
+import type { ExecOptions } from 'child_process';
+import { type Logger } from '@applitools/logger';
+type Options = {
+    execOptions?: ExecOptions;
+    logger: Logger;
+};
+export declare const cacheKey = "default";
+export declare const extractGitBranch: (({ execOptions, logger }: Options) => Promise<string | undefined>) & {
+    getCachedValues(): Promise<string | undefined>[];
+    setCachedValue(key: any, value: Promise<string | undefined>): void;
+    clearCache(): void;
+};
+export declare const extractGitRepo: (({ execOptions, logger }: Options) => Promise<{
+    name?: string;
+    owner?: string;
+}>) & {
+    getCachedValues(): Promise<{
+        name?: string | undefined;
+        owner?: string | undefined;
+    }>[];
+    setCachedValue(key: any, value: Promise<{
+        name?: string | undefined;
+        owner?: string | undefined;
+    }>): void;
+    clearCache(): void;
+};
+export declare function extractBuildIdFromCI(): Promise<string | undefined>;
+export {};

package/types/utils/extract-test-environment.d.ts

@@ -0,0 +1,2 @@
+export declare function extractTestEnvironment(baseEnvironment?: Record<string, any>): Record<string, any>;
+export declare function extractCIProvider(): string | null;

package/types/utils/memory-usage-logging.d.ts

@@ -0,0 +1,7 @@
+import { type Logger } from '@applitools/logger';
+export declare function startMemoryUsageLogging({ timeout, logger }: {
+    timeout?: number;
+    logger: Logger;
+}): {
+    stop(): void;
+};

package/types/utils/populate-eyes-server-settings.d.ts

@@ -0,0 +1,2 @@
+import type { EyesServerSettings } from '../types';
+export declare function populateEyesServerSettings(settings: Partial<EyesServerSettings>): EyesServerSettings;

package/types/utils/validate-sdk-version.d.ts

@@ -0,0 +1,42 @@
+import { type Logger } from '@applitools/logger';
+declare const extractors: {
+    js: typeof extractLatestJsPackageVersion & {
+        getCachedValues(): Promise<string>[];
+        setCachedValue(key: any, value: Promise<string>): void;
+        clearCache(): void;
+    };
+    java: typeof extractLatestJavaPackageVersion & {
+        getCachedValues(): Promise<string>[];
+        setCachedValue(key: any, value: Promise<string>): void;
+        clearCache(): void;
+    };
+    dotnet: typeof extractLatestDotNetPackageVersion & {
+        getCachedValues(): Promise<string>[];
+        setCachedValue(key: any, value: Promise<string>): void;
+        clearCache(): void;
+    };
+    python: typeof extractLatestPythonPackageVersion & {
+        getCachedValues(): Promise<string>[];
+        setCachedValue(key: any, value: Promise<string>): void;
+        clearCache(): void;
+    };
+    ruby: typeof extractLatestRubyPackageVersion & {
+        getCachedValues(): Promise<string>[];
+        setCachedValue(key: any, value: Promise<string>): void;
+        clearCache(): void;
+    };
+};
+export declare function validateSdkVersion(sdk: {
+    lang: keyof typeof extractors;
+    name: string;
+    currentVersion: string;
+    latestVersion?: string;
+}, { logger }: {
+    logger: Logger;
+}): Promise<void>;
+export declare function extractLatestJsPackageVersion(name: string): Promise<string>;
+export declare function extractLatestJavaPackageVersion(name: string): Promise<string>;
+export declare function extractLatestDotNetPackageVersion(name: string): Promise<string>;
+export declare function extractLatestPythonPackageVersion(name: string): Promise<string>;
+export declare function extractLatestRubyPackageVersion(name: string): Promise<string>;
+export {};

package/CHANGELOG.md

@@ -1,216 +0,0 @@
-# Change Log
-
-## Unreleased
-
-## 2.5.1 - 2023/4/18
-
-### Features
-### Bug fixes
-- Fixed the issue with session metadata extraction
-
-## 2.5.0 - 2023/4/18
-
-### Features
-- Added functional session feature
-### Bug fixes
-- Fixed issue with when webview were wasn't recognized as web compatible world
-
-## 2.4.13 - 2023/4/16
-
-### Features
-### Bug fixes
-- format result `hostDisplaySize`
-
-## 2.4.12 - 2023/4/12
-
-### Features
-### Bug fixes
-- Expose types for eyes-cypress
-
-## 2.4.11 - 2023/4/11
-
-### Features
-- Make `locate` to return coordinates that could be directly used with the driver
-### Bug fixes
-- Fix issue when `locate` return wrong type of the region, with `left` and `top` properties instead of `x` and `y`
-
-## 2.4.10 - 2023/4/10
-
-### Features
-### Bug fixes
-- Improved appium prefixed capabilities parsing
-
-## 2.4.9 - 2023/4/7
-
-### Features
-### Bug fixes
-- Fixed issue in dom snapshot that prevented urls that start with a whitespace to be mapped
-
-## 2.4.8 - 2023/4/5
-
-### Features
-### Bug fixes
-- Fixed screenshot framing
-- Fixed issue with css fetching for dom capture
-
-## 2.4.7 - 2023/4/4
-
-### Features
-### Bug fixes
-- Fixed issue with emulation driver detection
-
-## 2.4.6 - 2023/4/4
-
-### Features
-### Bug fixes
-- Fixed relative url resolution in css files
-- Added timeout to css fetching during preparing dom capture
-
-## 2.4.5 - 2023/3/31
-
-### Features
-- Added `removeDuplicateTests` property to the `GetManagerResultsSettings`
-### Bug fixes
-
-## 2.4.4 - 2023/3/30
-
-### Features
-### Bug fixes
-- Improve performance in DOM snapshot
-
-## 2.4.3 - 2023/3/22
-
-### Features
-- Changed `makeManager` api to accept `settings`
-### Bug fixes
-- Fixed retry interval during poll requests to eyes back-end
-
-## 2.4.2 - 2023/3/17
-
-### Features
-### Bug fixes
-- Fixed issue with concurrency of the renders in ufg mode
-
-## 2.4.1 - 2023/3/17
-
-### Features
-- Improved extraction of nml element
-### Bug fixes
-- Fixed issue with concurrency of the renders in ufg mode
-
-## 2.4.0 - 2023/3/12
-
-### Features
-### Bug fixes
-- Fixed ufg concurrency regression
-
-## 2.3.14 - 2023/3/7
-
-### Features
-### Bug fixes
-- Upgrade tunnel version
-
-## 2.3.13 - 2023/3/7
-
-### Features
-### Bug fixes
-- Fixed selector transformation for scroll root elements for ufg
-
-## 2.3.12 - 2023/3/7
-
-### Features
-- Update broker url using last response instead of using driver
-### Bug fixes
-- Replaced broker url cache with nml element cache
-
-## 2.3.11 - 2023/3/6
-
-### Features
-### Bug fixes
-- setting the universal cli for javascript right
-
-## 2.3.10 - 2023/3/3
-
-### Features
-- Added `Resize` stitch mode value
-### Bug fixes
-- Fixed issue when `.visualgrid` was not added to agent id
-- Fixed issue with aborting ufg tests
-
-## 2.3.9 - 2023/3/2
-
-### Features
-### Bug fixes
-- Update `@applitools/execution-grid-tunnel` dependency
-
-## 2.3.8 - 2023/3/2
-
-### Features
-### Bug fixes
-- upgrade dom-snapshot with a fix to CSP
-
-## 2.3.7 - 2023/2/23
-
-### Features
-- Added caching for broker url to avoid looking for the nml element multiple times
-- Passing density metric for PPI support in the sdk
-### Bug fixes
-- Fixed issue with universal protocol when manager ref was deleted once `EyesManager.getResults` was called
-- Fixed vulnerabilities of EC client
-
-## 2.3.6 - 2023/2/17
-
-### Features
-### Bug fixes
-- Update some type declarations
-
-## 2.3.5 - 2023/2/17
-
-### Features
-- Improve logging in core server
-### Bug fixes
-- Fixed issue when core server was hanging if any command was called immediately after `Core.makeCore` command
-- Fixed issue when `StaticDriver` and `StaticElement` were not recognized as a valid driver or element objects
-
-## 2.3.4 - 2023/2/16
-
-### Features
-### Bug fixes
-- Fixed ws types
-
-## 2.3.3 - 2023/2/16
-
-### Features
-### Bug fixes
-- Fixed debug mode
-- Fixed logs
-
-## 2.3.2 - 2023/2/16
-
-### Features
-- Added arm64 binary
-### Bug fixes
-
-## 2.3.1 - 2023/2/15
-
-### Features
-- Avoid helper initialization on native devices before it required
-### Bug fixes
-
-## 2.3.0 - 2023/2/15
-
-### Features
-- Integrate universal protocol to run core via transport
-### Bug fixes
-
-## 2.2.0 - 2023/2/15
-
-### Features
-- Integrate universal protocol to run core via transport
-### Bug fixes
-
-## 2.0.2 - 2022/12/27
-
-### Features
-- Created
-### Bug fixes

package/dist/classic/abort.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeAbort = void 0;
-const driver_1 = require("@applitools/driver");
-function makeAbort({ eyes, target, spec, logger: defaultLogger }) {
-    return async function abort({ settings, logger = defaultLogger, } = {}) {
-        logger.log('Command "abort" is called with settings', settings);
-        settings !== null && settings !== void 0 ? settings : (settings = {});
-        if (!settings.testMetadata) {
-            try {
-                const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
-                settings.testMetadata = await (driver === null || driver === void 0 ? void 0 : driver.getSessionMetadata());
-            }
-            catch (error) {
-                logger.warn('Command "abort" received an error during extracting driver metadata', error);
-            }
-        }
-        const baseEyes = await eyes.getBaseEyes();
-        await Promise.all(baseEyes.map(baseEyes => baseEyes.abort({ settings, logger })));
-    };
-}
-exports.makeAbort = makeAbort;

package/dist/classic/close.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeClose = void 0;
-const driver_1 = require("@applitools/driver");
-function makeClose({ eyes, target, spec, logger: defaultLogger }) {
-    return async function close({ settings, logger = defaultLogger, } = {}) {
-        logger.log('Command "close" is called with settings', settings);
-        settings !== null && settings !== void 0 ? settings : (settings = {});
-        if (!settings.testMetadata) {
-            try {
-                const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
-                settings.testMetadata = await (driver === null || driver === void 0 ? void 0 : driver.getSessionMetadata());
-            }
-            catch (error) {
-                logger.warn('Command "close" received an error during extracting driver metadata', error);
-            }
-        }
-        const baseEyes = await eyes.getBaseEyes();
-        await Promise.all(baseEyes.map(baseEyes => baseEyes.close({ settings, logger })));
-    };
-}
-exports.makeClose = makeClose;

package/dist/ufg/abort.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeAbort = void 0;
-const driver_1 = require("@applitools/driver");
-function makeAbort({ storage, target, spec, controller, logger: defaultLogger, }) {
-    return async function abort({ settings, logger = defaultLogger, } = {}) {
-        logger.log('Command "abort" is called with settings', settings);
-        controller.abort();
-        settings !== null && settings !== void 0 ? settings : (settings = {});
-        if (!settings.testMetadata) {
-            try {
-                const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
-                settings.testMetadata = await (driver === null || driver === void 0 ? void 0 : driver.getSessionMetadata());
-            }
-            catch (error) {
-                logger.warn('Command "abort" received an error during extracting driver metadata', error);
-            }
-        }
-        storage.forEach(async (promises) => {
-            var _a, _b;
-            try {
-                const { eyes } = await Promise.race(promises);
-                await eyes.abort({ settings, logger });
-            }
-            catch (error) {
-                logger.warn('Command "abort" received an error during waiting for eyes instances in background', error);
-                await ((_b = (_a = error === null || error === void 0 ? void 0 : error.info) === null || _a === void 0 ? void 0 : _a.eyes) === null || _b === void 0 ? void 0 : _b.abort({ settings, logger }));
-            }
-        });
-    };
-}
-exports.makeAbort = makeAbort;