@applitools/driver 1.21.3 → 1.22.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## [1.22.0](https://github.com/Applitools-Dev/sdk/compare/js/driver@1.21.4...js/driver@1.22.0) (2025-07-07)
+
+
+### Features
+
+* canvas webgl without preserveDrawingBuffer=1 | FLD-3144 ([#3040](https://github.com/Applitools-Dev/sdk/issues/3040)) ([f82d8f1](https://github.com/Applitools-Dev/sdk/commit/f82d8f148f913098752ec7bef8635a46b453d6fa))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.9.0
+  #### Features
+
+  * support https_proxy and http_proxy env variables | FLD-2702 ([#3046](https://github.com/Applitools-Dev/sdk/issues/3046)) ([0633809](https://github.com/Applitools-Dev/sdk/commit/06338099f44bfb149a5829f62c2f9b19e2392850))
+* @applitools/logger bumped to 2.1.5
+
+
+## [1.21.4](https://github.com/Applitools-Dev/sdk/compare/js/driver@1.21.3...js/driver@1.21.4) (2025-05-11)
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.8.2
+  #### Bug Fixes
+
+  * remove redundant file readings and added rendering concurrency limit ([#2956](https://github.com/Applitools-Dev/sdk/issues/2956)) ([b970180](https://github.com/Applitools-Dev/sdk/commit/b97018010fdf12cb0d202192b22f643c16c569d5))
+* @applitools/logger bumped to 2.1.4
+
+
 ## [1.21.3](https://github.com/Applitools-Dev/sdk/compare/js/driver@1.21.2...js/driver@1.21.3) (2025-05-07)
 
 

package/dist/browser-command.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/context.js

@@ -323,6 +323,9 @@ class Context {
         });
         return element ? (0, element_1.makeElement)({ spec: this._spec, context: this, element, selector }) : null;
     }
+    async executeBrowserCommands(driver, commands, _logger) {
+        return this._spec.executeBrowserCommands(driver, commands, this.logger);
+    }
     async execute(script, arg) {
         await this.focus();
         try {

package/dist/driver.js

@@ -896,6 +896,15 @@ class Driver {
             throw new Error(`User function is not supported (${JSON.stringify(func)})`);
         }
     }
+    async addScriptToEvaluateOnNewDocument(script) {
+        const enableCommand = { command: 'Page.enable', params: null };
+        const addScriptToEvaluateOnNewDocumentCommand = {
+            command: 'Page.addScriptToEvaluateOnNewDocument',
+            params: { source: script, runImmediately: true },
+        };
+        const commands = [enableCommand, addScriptToEvaluateOnNewDocumentCommand];
+        return this._spec.executeBrowserCommands(this.target, commands, this._logger);
+    }
     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/spec-driver.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.executeBrowserCommands = 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';
@@ -165,3 +165,7 @@ async function executeUserFunction(_userFunction) {
     throw new Error(`executeUserFunction is not supported in FakeDriver. userFunction: ${_userFunction}`);
 }
 exports.executeUserFunction = executeUserFunction;
+async function executeBrowserCommands(_driver, commands, _logger) {
+    throw new Error(`executeBrowserCommands is not supported in FakeDriver. script: ${commands}`);
+}
+exports.executeBrowserCommands = executeBrowserCommands;

package/dist/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./context"), exports);
 __exportStar(require("./element"), exports);
 __exportStar(require("./selector"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./browser-command"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.21.3",
+  "version": "1.22.0",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -73,9 +73,9 @@
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/logger": "2.1.3",
+    "@applitools/logger": "2.1.5",
     "@applitools/snippets": "2.6.5",
-    "@applitools/utils": "1.8.1",
+    "@applitools/utils": "1.9.0",
     "semver": "7.6.2"
   },
   "devDependencies": {

package/types/browser-command.d.ts

@@ -0,0 +1,21 @@
+interface BrowserBaseCommand {
+    'Page.enable': null;
+    'Page.addScriptToEvaluateOnNewDocument': {
+        source: string;
+        runImmediately?: boolean;
+    };
+    'Network.getCookies': Record<string, never>;
+    'Emulation.setDeviceMetricsOverride': {
+        width: number;
+        height: number;
+        deviceScaleFactor?: number;
+        mobile?: boolean;
+    };
+}
+export type BrowserCommand = {
+    [K in keyof BrowserBaseCommand]: {
+        command: K;
+        params: BrowserBaseCommand[K];
+    };
+}[keyof BrowserBaseCommand];
+export {};

package/types/context.d.ts

@@ -4,6 +4,7 @@ import { type SpecType, type SpecDriver, type WaitOptions } from './spec-driver'
 import { type Driver } from './driver';
 import { type Selector } from './selector';
 import { type ElementReference, type Element } from './element';
+import { BrowserCommand } from './browser-command';
 export type ContextReference<T extends SpecType> = Element<T> | ElementReference<T> | string | number;
 export type NestedContextReference<T extends SpecType> = {
     reference: ContextReference<T>;
@@ -55,6 +56,7 @@ export declare class Context<T extends SpecType> {
     element(elementOrSelector: ElementReference<T>): Promise<Element<T> | null>;
     elements(selectorOrElement: ElementReference<T>): Promise<Element<T>[]>;
     waitFor(selector: Selector<T>, options?: WaitOptions): Promise<Element<T> | null>;
+    executeBrowserCommands(driver: any, commands: BrowserCommand[], _logger?: any): Promise<any>;
     execute(script: ((args: any) => any) | string, arg?: any): Promise<any>;
     executePoll(script: ((arg: any) => any) | string | {
         main: ((arg: any) => any) | string;

package/types/driver.d.ts

@@ -103,6 +103,7 @@ export declare class Driver<T extends SpecType> {
     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>;
+    addScriptToEvaluateOnNewDocument(script: string): 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

@@ -1,5 +1,7 @@
 import type { Region, Size } from '@applitools/utils';
 import type { DriverInfo } from '../types';
+import { BrowserCommand } from '../browser-command';
+import { Logger } from '@applitools/logger';
 export type Driver = any;
 export type Element = any;
 export type Selector = string | {
@@ -42,4 +44,5 @@ export declare function performAction(_driver: Driver, _steps: any[]): Promise<v
 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 declare function executeBrowserCommands(_driver: Driver, commands: BrowserCommand[], _logger?: Logger): Promise<any>;
 export {};

package/types/index.d.ts

@@ -4,3 +4,4 @@ export * from './context';
 export * from './element';
 export * from './selector';
 export * from './types';
+export * from './browser-command';

package/types/spec-driver.d.ts

@@ -1,6 +1,8 @@
 import type { Size, Region } from '@applitools/utils';
 import type { DriverInfo, Capabilities, ScreenOrientation, Cookie } from './types';
 import { type CommonSelector } from './selector';
+import type { Logger } from '@applitools/logger';
+import { BrowserCommand } from './browser-command';
 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;
@@ -85,6 +87,7 @@ export interface SpecDriver<T extends SpecType> {
     executeScript(context: T['context'], script: ((arg?: any) => any) | string, arg?: any): Promise<any>;
     isUserFunction?(ref: any): Promise<boolean>;
     executeUserFunction?(userFunction: T['userFunction']): Promise<any>;
+    executeBrowserCommands(driver: T['driver'], commands: BrowserCommand[], logger?: Logger): 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>;