@applitools/core 1.3.8 → 1.4.0

package/dist/classic/abort.js

@@ -0,0 +1,13 @@
+"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 ({ settings, logger = defaultLogger, } = {}) {
+        const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
+        const testMetadata = await (driver === null || driver === void 0 ? void 0 : driver.getSessionMetadata());
+        const [baseEyes] = await eyes.getBaseEyes();
+        return await baseEyes.abort({ settings: { ...settings, testMetadata }, logger });
+    };
+}
+exports.makeAbort = makeAbort;

package/dist/classic/close.js

@@ -0,0 +1,13 @@
+"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 ({ settings, logger = defaultLogger, } = {}) {
+        const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
+        const testMetadata = await (driver === null || driver === void 0 ? void 0 : driver.getSessionMetadata());
+        const baseEyes = await eyes.getBaseEyes();
+        return (await Promise.all(baseEyes.map(baseEyes => baseEyes.close({ settings: { ...settings, testMetadata }, logger })))).flat();
+    };
+}
+exports.makeClose = makeClose;

package/dist/classic/open-eyes.js

@@ -30,6 +30,8 @@ const check_1 = require("./check");
 const check_and_close_1 = require("./check-and-close");
 const locate_text_1 = require("./locate-text");
 const extract_text_1 = require("./extract-text");
+const close_1 = require("./close");
+const abort_1 = require("./abort");
 const utils = __importStar(require("@applitools/utils"));
 function makeOpenEyes({ core, spec, logger: defaultLogger, }) {
     return async function openEyes({ target, settings, eyes, logger = defaultLogger, }) {
@@ -40,6 +42,7 @@ function makeOpenEyes({ core, spec, logger: defaultLogger, }) {
         if (driver && !eyes) {
             const currentContext = driver.currentContext;
             (_a = settings.environment) !== null && _a !== void 0 ? _a : (settings.environment = {});
+            settings.environment.egSessionId = (driver === null || driver === void 0 ? void 0 : driver.isExecutionGrid) ? driver.sessionId : null;
             if (!settings.environment.viewportSize || driver.isMobile) {
                 const size = await driver.getViewportSize();
                 settings.environment.viewportSize = utils.geometry.scale(size, driver.viewportScale);
@@ -83,6 +86,8 @@ function makeOpenEyes({ core, spec, logger: defaultLogger, }) {
             checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ eyes, target: driver, spec, logger }),
             locateText: (0, locate_text_1.makeLocateText)({ eyes, target: driver, spec, logger }),
             extractText: (0, extract_text_1.makeExtractText)({ eyes, target: driver, spec, logger }),
+            close: (0, close_1.makeClose)({ eyes, target: driver, spec, logger }),
+            abort: (0, abort_1.makeAbort)({ eyes, target: driver, spec, logger }),
         }));
     };
 }

package/dist/core.js

@@ -33,6 +33,7 @@ const open_eyes_1 = require("./open-eyes");
 const make_manager_1 = require("./make-manager");
 const close_batch_1 = require("./close-batch");
 const delete_test_1 = require("./delete-test");
+const make_eg_client_1 = require("./make-eg-client");
 const utils = __importStar(require("@applitools/utils"));
 function makeCore({ spec, concurrency, core, agentId = 'core', cwd = process.cwd(), logger, } = {}) {
     var _a;
@@ -50,6 +51,7 @@ function makeCore({ spec, concurrency, core, agentId = 'core', cwd = process.cwd
         makeManager: (0, make_manager_1.makeMakeManager)({ spec, concurrency, agentId, logger }),
         closeBatch: (0, close_batch_1.makeCloseBatch)({ core, logger }),
         deleteTest: (0, delete_test_1.makeDeleteTest)({ core, logger }),
+        makeEGClient: (0, make_eg_client_1.makeMakeEGClient)({ core, logger }),
     });
 }
 exports.makeCore = makeCore;

package/dist/make-eg-client.js

@@ -0,0 +1,43 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeMakeEGClient = void 0;
+const execution_grid_client_1 = require("@applitools/execution-grid-client");
+const utils = __importStar(require("@applitools/utils"));
+function makeMakeEGClient({ core, logger: defaultLogger }) {
+    return async function _makeEGClient({ settings, logger = defaultLogger, } = {}) {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        var _j, _k;
+        const serverUrl = (_c = (_b = (_a = settings.capabilities.eyesServerUrl) !== null && _a !== void 0 ? _a : utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('SERVER_URL')) !== null && _c !== void 0 ? _c : 'https://eyesapi.applitools.com';
+        const apiKey = ((_d = (_j = settings.capabilities).apiKey) !== null && _d !== void 0 ? _d : (_j.apiKey = utils.general.getEnvValue('API_KEY')));
+        const proxy = (_e = settings.proxy) !== null && _e !== void 0 ? _e : (utils.general.getEnvValue('PROXY_URL') && { url: utils.general.getEnvValue('PROXY_URL') });
+        const _account = await core.getAccountInfo({ settings: { serverUrl, apiKey, proxy }, logger });
+        (_f = settings.capabilities) !== null && _f !== void 0 ? _f : (settings.capabilities = {});
+        (_g = (_k = settings.capabilities).useSelfHealing) !== null && _g !== void 0 ? _g : (_k.useSelfHealing = (_h = utils.general.getEnvValue('USE_SELF_HEALING', 'boolean')) !== null && _h !== void 0 ? _h : false); // TODO replace with account.selfHealingEnabled
+        const client = await (0, execution_grid_client_1.makeEGClient)({ settings, logger });
+        return client;
+    };
+}
+exports.makeMakeEGClient = makeMakeEGClient;

package/dist/ufg/abort.js

@@ -2,8 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeAbort = void 0;
 const abort_error_1 = require("../errors/abort-error");
-function makeAbort({ storage, controller, logger: defaultLogger }) {
-    return async function ({ logger = defaultLogger, } = {}) {
+const driver_1 = require("@applitools/driver");
+function makeAbort({ storage, target, spec, controller, logger: defaultLogger, }) {
+    return async function ({ settings, logger = defaultLogger, } = {}) {
         controller.abort();
         const tests = storage.reduce((tests, { renderer, promise }) => {
             const key = JSON.stringify(renderer);
@@ -26,7 +27,9 @@ function makeAbort({ storage, controller, logger: defaultLogger }) {
                         throw error;
                 }
             }
-            const [result] = await eyes.abort({ logger });
+            const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
+            const testMetadata = await (driver === null || driver === void 0 ? void 0 : driver.getSessionMetadata());
+            const [result] = await eyes.abort({ settings: { ...settings, testMetadata }, logger });
             return { ...result, renderer };
         }));
     };

package/dist/ufg/check.js

@@ -195,7 +195,9 @@ function makeCheck({ eyes, client, target: defaultTarget, spec, signal, logger:
                     return { ...result, eyes: baseEyes, renderer };
                 }
                 catch (error) {
-                    await baseEyes.abort();
+                    const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
+                    const testMetadata = await (driver === null || driver === void 0 ? void 0 : driver.getSessionMetadata());
+                    await baseEyes.abort({ settings: { testMetadata } });
                     error.info = { eyes: baseEyes };
                     throw error;
                 }

package/dist/ufg/close.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeClose = void 0;
-function makeClose({ storage, logger: defaultLogger }) {
+const driver_1 = require("@applitools/driver");
+function makeClose({ storage, target, spec, logger: defaultLogger, }) {
     return async function ({ settings, logger = defaultLogger, } = {}) {
         const tests = storage.reduce((tests, { renderer, promise }) => {
             var _a;
@@ -14,7 +15,9 @@ function makeClose({ storage, logger: defaultLogger }) {
             var _a, _b;
             try {
                 const [{ eyes, renderer }] = await Promise.all(promises);
-                const [result] = await eyes.close({ settings, logger });
+                const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
+                const testMetadata = await (driver === null || driver === void 0 ? void 0 : driver.getSessionMetadata());
+                const [result] = await eyes.close({ settings: { ...settings, testMetadata }, logger });
                 return { ...result, renderer };
             }
             catch (error) {

package/dist/ufg/open-eyes.js

@@ -35,12 +35,14 @@ const abort_controller_1 = require("abort-controller");
 const utils = __importStar(require("@applitools/utils"));
 function makeOpenEyes({ core, client, spec, logger: defaultLogger, }) {
     return async function openEyes({ target, settings, eyes, logger = defaultLogger, }) {
-        var _a, _b;
+        var _a, _b, _c;
         logger.log(`Command "openEyes" is called with ${target ? 'default driver and' : ''}`, ...(settings ? ['settings', settings] : []), eyes ? 'predefined eyes' : '');
         const driver = target && (await (0, driver_1.makeDriver)({ spec, driver: target, logger, customConfig: { disableHelper: true } }));
+        (_a = settings.environment) !== null && _a !== void 0 ? _a : (settings.environment = {});
+        settings.environment.egSessionId = (driver === null || driver === void 0 ? void 0 : driver.isExecutionGrid) ? driver.sessionId : null;
         if (driver && !eyes) {
             const currentContext = driver.currentContext;
-            if ((_a = settings.environment) === null || _a === void 0 ? void 0 : _a.viewportSize) {
+            if ((_b = settings.environment) === null || _b === void 0 ? void 0 : _b.viewportSize) {
                 await driver.setViewportSize(settings.environment.viewportSize);
             }
             await currentContext.focus();
@@ -49,7 +51,7 @@ function makeOpenEyes({ core, client, spec, logger: defaultLogger, }) {
         const account = await core.getAccountInfo({ settings, logger });
         client !== null && client !== void 0 ? client : (client = (0, ufg_client_1.makeUFGClient)({
             config: { ...account.ufg, ...account, proxy: settings.proxy },
-            concurrency: (_b = settings.renderConcurrency) !== null && _b !== void 0 ? _b : 5,
+            concurrency: (_c = settings.renderConcurrency) !== null && _c !== void 0 ? _c : 5,
             logger,
         }));
         const getBaseEyes = (0, get_base_eyes_1.makeGetBaseEyes)({ settings, eyes, core, client, logger });
@@ -88,14 +90,14 @@ function makeOpenEyes({ core, client, spec, logger: defaultLogger, }) {
                 }),
                 checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ eyes, client, target: driver, spec, signal: controller.signal, logger }),
                 // close only once
-                close: utils.general.wrap((0, close_1.makeClose)({ storage, logger }), async (close, options) => {
+                close: utils.general.wrap((0, close_1.makeClose)({ storage, target: driver, logger }), async (close, options) => {
                     if (closed || aborted)
                         return [];
                     closed = true;
                     return close(options);
                 }),
                 // abort only once
-                abort: utils.general.wrap((0, abort_1.makeAbort)({ storage, controller, logger }), async (abort, options) => {
+                abort: utils.general.wrap((0, abort_1.makeAbort)({ storage, target: driver, spec, controller, logger }), async (abort, options) => {
                     if (aborted || closed)
                         return [];
                     aborted = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "1.3.8",
+  "version": "1.4.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -61,30 +61,32 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.1.25",
+    "@applitools/core-base": "1.1.29",
     "@applitools/dom-capture": "11.2.0",
     "@applitools/dom-snapshot": "4.7.3",
-    "@applitools/driver": "1.11.21",
-    "@applitools/logger": "1.1.36",
-    "@applitools/nml-client": "1.3.22",
-    "@applitools/req": "1.1.23",
-    "@applitools/screenshoter": "3.7.20",
-    "@applitools/snippets": "2.4.12",
-    "@applitools/ufg-client": "1.1.14",
-    "@applitools/utils": "1.3.22",
+    "@applitools/driver": "1.11.25",
+    "@applitools/execution-grid-client": "1.2.2",
+    "@applitools/logger": "1.1.40",
+    "@applitools/nml-client": "1.3.26",
+    "@applitools/req": "1.1.27",
+    "@applitools/screenshoter": "3.7.22",
+    "@applitools/snippets": "2.4.13",
+    "@applitools/ufg-client": "1.1.18",
+    "@applitools/utils": "1.3.26",
     "abort-controller": "3.0.0",
     "chalk": "4.1.2",
     "node-fetch": "2.6.7",
     "throat": "6.0.1"
   },
   "devDependencies": {
-    "@applitools/bongo": "^2.2.0",
+    "@applitools/bongo": "^2.2.2",
+    "@applitools/execution-grid-client": "^1.1.39",
     "@applitools/sdk-fake-eyes-server": "^2.1.3",
-    "@applitools/spec-driver-puppeteer": "^1.1.32",
-    "@applitools/spec-driver-selenium": "^1.5.19",
-    "@applitools/spec-driver-webdriverio": "^1.4.18",
-    "@applitools/test-server": "^1.1.16",
-    "@applitools/test-utils": "^1.5.6",
+    "@applitools/spec-driver-puppeteer": "^1.1.36",
+    "@applitools/spec-driver-selenium": "^1.5.23",
+    "@applitools/spec-driver-webdriverio": "^1.4.20",
+    "@applitools/test-server": "^1.1.20",
+    "@applitools/test-utils": "^1.5.8",
     "@types/mocha": "^9.1.1",
     "@types/node": "12",
     "@types/selenium-webdriver": "^4.1.2",

package/types/classic/abort.d.ts

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

package/types/classic/close.d.ts

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

package/types/make-eg-client.d.ts

@@ -0,0 +1,12 @@
+import type { Core as BaseCore } from '@applitools/core-base';
+import { type Logger } from '@applitools/logger';
+import { type EGClient, type EGClientSettings } from '@applitools/execution-grid-client';
+type Options = {
+    core: BaseCore;
+    logger: Logger;
+};
+export declare function makeMakeEGClient({ core, logger: defaultLogger }: Options): ({ settings, logger, }?: {
+    settings?: EGClientSettings;
+    logger?: Logger;
+}) => Promise<EGClient>;
+export {};

package/types/types.d.ts

@@ -1,4 +1,5 @@
 import type { MaybeArray } from '@applitools/utils';
+import type { EGClient } from '@applitools/execution-grid-client';
 import type * as AutomationCore from './automation/types';
 import type * as ClassicCore from './classic/types';
 import type * as UFGCore from './ufg/types';
@@ -10,6 +11,10 @@ export type TypedCore<TDriver, TContext, TElement, TSelector, TType extends 'cla
 export type TypedEyes<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg', TTarget = Target<TDriver, TContext, TElement, TSelector, TType>> = TType extends 'ufg' ? UFGCore.Eyes<TDriver, TContext, TElement, TSelector, TTarget> : ClassicCore.Eyes<TDriver, TContext, TElement, TSelector, TTarget>;
 export type Target<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.UFGTarget<TDriver, TContext, TElement, TSelector> : ClassicCore.ClassicTarget<TDriver, TContext, TElement, TSelector>;
 export interface Core<TDriver, TContext, TElement, TSelector> extends AutomationCore.Core<TDriver, TContext, TElement, TSelector> {
+    makeEGClient(options?: {
+        settings?: any;
+        logger?: Logger;
+    }): Promise<EGClient>;
     makeManager<TType extends 'classic' | 'ufg' = 'classic'>(options?: {
         type: TType;
         concurrency?: TType extends 'ufg' ? number : never;

package/types/ufg/abort.d.ts

@@ -1,9 +1,11 @@
-import type { TestResult } from './types';
+import type { AbortSettings, TestResult } from './types';
 import type { Eyes as BaseEyes } from '@applitools/core-base';
 import { type Logger } from '@applitools/logger';
 import { type Renderer } from '@applitools/ufg-client';
 import { type AbortController } from 'abort-controller';
-type Options = {
+import type { DriverTarget } from './types';
+import { type SpecDriver } from '@applitools/driver';
+type Options<TDriver, TContext, TElement, TSelector> = {
     storage: {
         renderer: Renderer;
         promise: Promise<{
@@ -12,9 +14,12 @@ type Options = {
         }>;
     }[];
     controller: AbortController;
+    target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
+    spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
     logger: Logger;
 };
-export declare function makeAbort({ storage, controller, logger: defaultLogger }: Options): ({ logger, }?: {
+export declare function makeAbort<TDriver, TContext, TElement, TSelector>({ storage, target, spec, controller, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ settings, logger, }?: {
+    settings?: AbortSettings;
     logger?: Logger;
 }) => Promise<TestResult[]>;
 export {};

package/types/ufg/close.d.ts

@@ -2,7 +2,9 @@ import type { CloseSettings, TestResult } from './types';
 import type { Eyes as BaseEyes } from '@applitools/core-base';
 import { type Logger } from '@applitools/logger';
 import { type Renderer } from '@applitools/ufg-client';
-type Options = {
+import type { DriverTarget } from './types';
+import { type SpecDriver } from '@applitools/driver';
+type Options<TDriver, TContext, TElement, TSelector> = {
     storage: {
         renderer: Renderer;
         promise: Promise<{
@@ -10,9 +12,11 @@ type Options = {
             renderer: Renderer;
         }>;
     }[];
+    target?: DriverTarget<TDriver, TContext, TElement, TSelector>;
+    spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
     logger: Logger;
 };
-export declare function makeClose({ storage, logger: defaultLogger }: Options): ({ settings, logger, }?: {
+export declare function makeClose<TDriver, TContext, TElement, TSelector>({ storage, target, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ settings, logger, }?: {
     settings?: CloseSettings;
     logger?: Logger;
 }) => Promise<TestResult[]>;