@applitools/driver 1.6.1 → 1.7.2

package/README.md

@@ -46,7 +46,7 @@ The API and abstractions of the interface provides an extra functionality which
     - [spec.type(context, element, value)](#spectypecontext-element-value)
     - [spec.visit(driver, url)](#specvisitdriver-url)
     - [spec.getOrientation(driver)](#specgetorientationdriver)
-    - [spec.getBarsHeight(driver)](#specgetbarsheightdriver)
+    - [spec.getBarsSize(driver)](#specgetbarsSizedriver)
     - [spec.getElementRegion(driver, element)](#specgetelementregiondriver-element)
     - [spec.getElementAttribute(driver, element, attribute)](#specgetelementattributedriver-element-attribute)
     - [spec.getElementText(driver, element)](#specgetelementtextdriver-element)
@@ -433,7 +433,7 @@ This command is optional.
 ### spec.getOrientation(driver)
 TBD
 
-### spec.getBarsHeight(driver)
+### spec.getBarsSize(driver)
 TBD
 
 ### spec.getElementRegion(driver, element)

package/dist/driver.js

@@ -35,6 +35,7 @@ class Driver {
         if (options.driver instanceof Driver)
             return options.driver;
         this._spec = options.spec;
+        this._customConfig = options.customConfig || {};
         if (options.logger)
             this._logger = options.logger;
         if (this._spec.isDriver(options.driver)) {
@@ -167,15 +168,17 @@ class Driver {
             (_q = (_2 = this._driverInfo.features).allCookies) !== null && _q !== void 0 ? _q : (_2.allCookies = /chrome/i.test(this._driverInfo.browserName) && !this._driverInfo.isMobile);
         }
         else {
-            const barsHeight = await ((_s = (_r = this._spec).getBarsHeight) === null || _s === void 0 ? void 0 : _s.call(_r, this.target).catch(() => undefined));
+            const barsHeight = await ((_s = (_r = this._spec).getBarsSize) === null || _s === void 0 ? void 0 : _s.call(_r, this.target).catch(() => undefined));
             const displaySize = await this.getDisplaySize();
             // calculate status and navigation bars sizes
             if (barsHeight) {
+                const orientation = await this.getOrientation();
                 // when status bar is overlapping content on android it returns status bar height equal to viewport height
                 if (this.isAndroid && barsHeight.statusBarHeight / this.pixelRatio < displaySize.height) {
                     this._driverInfo.statusBarHeight = Math.max((_t = this._driverInfo.statusBarHeight) !== null && _t !== void 0 ? _t : 0, barsHeight.statusBarHeight);
                 }
-                this._driverInfo.navigationBarHeight = Math.max((_u = this._driverInfo.navigationBarHeight) !== null && _u !== void 0 ? _u : 0, barsHeight.navigationBarHeight);
+                // android witches the width and height only for the navigationBar in landscape mode.
+                this._driverInfo.navigationBarHeight = Math.max((_u = this._driverInfo.navigationBarHeight) !== null && _u !== void 0 ? _u : 0, orientation === 'landscape' ? barsHeight.navigationBarWidth : barsHeight.navigationBarHeight);
             }
             if (this.isAndroid) {
                 this._driverInfo.statusBarHeight /= this.pixelRatio;
@@ -419,7 +422,6 @@ class Driver {
         var _a;
         let size;
         if (this.isNative) {
-            this._logger.log('Extracting viewport size from native driver');
             if ((_a = this._driverInfo) === null || _a === void 0 ? void 0 : _a.viewportSize) {
                 size = this._driverInfo.viewportSize;
             }
@@ -432,7 +434,13 @@ class Driver {
                     }
                 }
             }
-            size = utils.geometry.round(size);
+            if (this._customConfig.useCeilForViewportSize) {
+                size = utils.geometry.ceil(size);
+            }
+            else {
+                size = utils.geometry.round(size);
+            }
+            this._logger.log(`Extracting viewport size from native driver using '${this._customConfig.useCeilForViewportSize ? 'ceil' : 'round'}' method`);
         }
         else if (this._spec.getViewportSize) {
             this._logger.log('Extracting viewport size from web driver using spec method');
@@ -493,6 +501,12 @@ class Driver {
         this._logger.log('Extracted device orientation:', orientation);
         return orientation;
     }
+    async setOrientation(orientation) {
+        if (this.isWeb && !this.isMobile)
+            return;
+        await this._spec.setOrientation(this.target, orientation);
+        this._logger.log('set device orientation:', orientation);
+    }
     async getCookies() {
         var _a, _b, _c;
         if (this.isNative || !this.features.allCookies)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.6.1",
+  "version": "1.7.2",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -73,12 +73,12 @@
     }
   },
   "dependencies": {
-    "@applitools/snippets": "2.2.2",
-    "@applitools/types": "1.3.0",
-    "@applitools/utils": "1.2.13"
+    "@applitools/snippets": "2.2.3",
+    "@applitools/types": "1.3.2",
+    "@applitools/utils": "1.2.14"
   },
   "devDependencies": {
-    "@applitools/bongo": "^2.0.1",
+    "@applitools/bongo": "^2.0.3",
     "@types/mocha": "^9.0.0",
     "@types/node": "^16.3.3",
     "@typescript-eslint/eslint-plugin": "^4.28.3",

package/types/driver.d.ts

@@ -10,12 +10,14 @@ export declare class Driver<TDriver, TContext, TElement, TSelector> {
     private _currentContext;
     private _driverInfo;
     private _logger;
+    private _customConfig;
     private _helper?;
     protected readonly _spec: types.SpecDriver<TDriver, TContext, TElement, TSelector>;
     constructor(options: {
         spec: types.SpecDriver<TDriver, TContext, TElement, TSelector>;
         driver: Driver<TDriver, TContext, TElement, TSelector> | TDriver;
         logger?: any;
+        customConfig?: any;
     });
     get target(): TDriver;
     get currentContext(): Context<TDriver, TContext, TElement, TSelector>;
@@ -60,6 +62,7 @@ export declare class Driver<TDriver, TContext, TElement, TSelector> {
     setViewportSize(size: types.Size): Promise<void>;
     getDisplaySize(): Promise<types.Size>;
     getOrientation(): Promise<'portrait' | 'landscape'>;
+    setOrientation(orientation: types.ScreenOrientation): Promise<void>;
     getCookies(): Promise<types.Cookie[]>;
     getTitle(): Promise<string>;
     getUrl(): Promise<string>;