@applitools/driver 1.20.5 → 1.21.1

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## [1.21.1](https://github.com/Applitools-Dev/sdk/compare/js/driver@1.21.0...js/driver@1.21.1) (2025-04-17)
+
+
+### Bug Fixes
+
+* executePoll error logging FLD-2870 ([#2890](https://github.com/Applitools-Dev/sdk/issues/2890)) ([a8ff720](https://github.com/Applitools-Dev/sdk/commit/a8ff720efafacabe2023282748a6d8a0f1b3ff73))
+
+
+### Dependencies
+
+* @applitools/snippets bumped to 2.6.5
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+## [1.21.0](https://github.com/Applitools-Dev/sdk/compare/js/driver@1.20.5...js/driver@1.21.0) (2025-03-30)
+
+
+### Features
+
+* allow sending callback functions to waitBeforeCapture ([#2780](https://github.com/Applitools-Dev/sdk/issues/2780)) ([4caa2e8](https://github.com/Applitools-Dev/sdk/commit/4caa2e8ae055d3dd48164eeceaa4c691eeadcdd4))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.8.0
+  #### Features
+
+  * allow sending callback functions to waitBeforeCapture ([#2780](https://github.com/Applitools-Dev/sdk/issues/2780)) ([4caa2e8](https://github.com/Applitools-Dev/sdk/commit/4caa2e8ae055d3dd48164eeceaa4c691eeadcdd4))
+* @applitools/logger bumped to 2.1.2
+
+
 ## [1.20.5](https://github.com/Applitools-Dev/sdk/compare/js/driver@1.20.4...js/driver@1.20.5) (2025-02-26)
 
 

package/dist/context.js

@@ -362,7 +362,15 @@ class Context {
             let chunks = '';
             while (!isExecutionTimedOut) {
                 if (response.status === 'ERROR') {
-                    throw new Error(`Error during execute poll script: '${response.error}'`);
+                    let errorMessage = response.error;
+                    try {
+                        errorMessage = JSON.stringify(errorMessage);
+                    }
+                    catch (err) {
+                        errorMessage = `Error during execute poll script: '${errorMessage}'. Addtionaly, the error is not serializable - ${err}`;
+                    }
+                    this.logger.error(`Error during execute poll script: '${errorMessage}'`);
+                    throw new Error(`Error during execute poll script: '${errorMessage}'`);
                 }
                 else if (response.status === 'SUCCESS') {
                     return response.value;
@@ -570,8 +578,5 @@ class Context {
         this._state.region = await this.getRegion();
         this._state.clientRegion = await this.getClientRegion();
     }
-    async preserveScrollingRegion() {
-        this._state.scrollingRegion = await this.getScrollingRegion();
-    }
 }
 exports.Context = Context;

package/dist/driver.js

@@ -884,6 +884,18 @@ class Driver {
     async execute(script, arg) {
         return this.currentContext.execute(script, arg);
     }
+    async executeUserFunction(func) {
+        var _a, _b;
+        if (await ((_b = (_a = this._spec).isUserFunction) === null || _b === void 0 ? void 0 : _b.call(_a, func))) {
+            return this._spec.executeUserFunction(func);
+        }
+        else if (typeof func === 'function') {
+            return func();
+        }
+        else {
+            throw new Error(`User function is not supported (${JSON.stringify(func)})`);
+        }
+    }
     async visit(url) {
         var _a, _b;
         await ((_b = (_a = this._spec).visit) === null || _b === void 0 ? void 0 : _b.call(_a, this.target, url));

package/dist/fake/mock-driver.js

@@ -280,6 +280,18 @@ class MockDriver {
         let result = this._scripts.get(String(script));
         if (!result) {
             const name = Object.keys(WELL_KNOWN_SCRIPTS).find(name => WELL_KNOWN_SCRIPTS[name](script));
+            if (utils.types.isFunction(script)) {
+                try {
+                    return JSON.stringify(await script(...args));
+                }
+                catch (e) {
+                    if (script.throwing) {
+                        throw e;
+                    }
+                    else
+                        return null;
+                }
+            }
             if (!name)
                 return null;
             result = this._scripts.get(name);

package/dist/fake/spec-driver.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCapabilities = exports.performAction = exports.getElementAttribute = exports.getElementRegion = exports.getCurrentWorld = exports.visit = exports.getTitle = exports.getUrl = exports.getOrientation = exports.setWindowSize = exports.getWindowSize = exports.getDriverInfo = exports.takeScreenshot = exports.childContext = exports.parentContext = exports.mainContext = exports.getElementText = exports.findElements = exports.findElement = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.extractSelector = exports.toSimpleCommonSelector = exports.toSelector = exports.isSelector = exports.isElement = exports.isDriver = void 0;
+exports.executeUserFunction = exports.isUserFunction = exports.getCapabilities = exports.performAction = exports.getElementAttribute = exports.getElementRegion = exports.getCurrentWorld = exports.visit = exports.getTitle = exports.getUrl = exports.getOrientation = exports.setWindowSize = exports.getWindowSize = exports.getDriverInfo = exports.takeScreenshot = exports.childContext = exports.parentContext = exports.mainContext = exports.getElementText = exports.findElements = exports.findElement = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.extractSelector = exports.toSimpleCommonSelector = exports.toSelector = exports.isSelector = exports.isElement = exports.isDriver = void 0;
 const utils = __importStar(require("@applitools/utils"));
 function isDriver(driver) {
     return driver && driver.constructor.name === 'MockDriver';
@@ -157,3 +157,11 @@ async function getCapabilities(driver) {
     return driver.capabilities;
 }
 exports.getCapabilities = getCapabilities;
+async function isUserFunction(_ref) {
+    return false;
+}
+exports.isUserFunction = isUserFunction;
+async function executeUserFunction(_userFunction) {
+    throw new Error(`executeUserFunction is not supported in FakeDriver. userFunction: ${_userFunction}`);
+}
+exports.executeUserFunction = executeUserFunction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.20.5",
+  "version": "1.21.1",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -73,9 +73,9 @@
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/logger": "2.1.1",
-    "@applitools/snippets": "2.6.4",
-    "@applitools/utils": "1.7.8",
+    "@applitools/logger": "2.1.2",
+    "@applitools/snippets": "2.6.5",
+    "@applitools/utils": "1.8.0",
     "semver": "7.6.2"
   },
   "devDependencies": {

package/types/context.d.ts

@@ -81,6 +81,5 @@ export declare class Context<T extends SpecType> {
     getCookies(): Promise<Cookie[]>;
     private preserveInnerOffset;
     private preserveContextRegions;
-    private preserveScrollingRegion;
 }
 export {};

package/types/driver.d.ts

@@ -102,6 +102,7 @@ export declare class Driver<T extends SpecType> {
     elements(selector: Selector<T>): Promise<Element<T>[]>;
     waitFor(selector: Selector<T>, options?: WaitOptions): Promise<Element<T> | null>;
     execute(script: ((arg: any) => any) | string, arg?: any): Promise<any>;
+    executeUserFunction<T>(func: SpecType['userFunction'] | (() => T)): Promise<any>;
     visit(url: string): Promise<void>;
 }
 export declare function isDriverInstance<T extends SpecType>(driver: any): driver is Driver<T>;

package/types/fake/spec-driver.d.ts

@@ -40,4 +40,6 @@ export declare function getElementRegion(_driver: Driver, element: Element): Pro
 export declare function getElementAttribute(_driver: Driver, element: Element, attr: string): Promise<string>;
 export declare function performAction(_driver: Driver, _steps: any[]): Promise<void>;
 export declare function getCapabilities(driver: Driver): Promise<Record<string, any>>;
+export declare function isUserFunction(_ref: any): Promise<boolean>;
+export declare function executeUserFunction(_userFunction: any): Promise<void>;
 export {};

package/types/spec-driver.d.ts

@@ -1,12 +1,13 @@
 import type { Size, Region } from '@applitools/utils';
 import type { DriverInfo, Capabilities, ScreenOrientation, Cookie } from './types';
 import { type CommonSelector } from './selector';
-export type SpecType<TDriver = unknown, TContext = unknown, TElement = unknown, TSelector = unknown, TSecondary extends SpecType = SpecType<unknown, unknown, unknown, unknown, never>> = {
+export type SpecType<TDriver = unknown, TContext = unknown, TElement = unknown, TSelector = unknown, TSecondary extends SpecType = SpecType<unknown, unknown, unknown, unknown, never>, UserFunction = unknown> = {
     driver: TDriver;
     context: TContext;
     element: TElement;
     selector: TSelector;
     secondary: TSecondary;
+    userFunction: UserFunction;
 };
 export interface SpecDriver<T extends SpecType> {
     /**
@@ -82,6 +83,8 @@ export interface SpecDriver<T extends SpecType> {
      * Executes given script in the given contexts with given argument.
      */
     executeScript(context: T['context'], script: ((arg?: any) => any) | string, arg?: any): Promise<any>;
+    isUserFunction?(ref: any): Promise<boolean>;
+    executeUserFunction?(userFunction: T['userFunction']): Promise<any>;
     findElement(context: T['context'], selector: T['selector'], parent?: T['element']): Promise<T['element'] | null>;
     findElements(context: T['context'], selector: T['selector'], parent?: T['element']): Promise<T['element'][]>;
     waitForSelector?(context: T['context'], selector: T['selector'], parent?: T['element'], options?: WaitOptions): Promise<T['element'] | null>;