@applitools/driver 1.7.1 → 1.8.1

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/capabilities.js

@@ -1,26 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseCapabilities = void 0;
-function parseCapabilities(capabilities) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+function parseCapabilities(capabilities, customConfig) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
     if (capabilities.capabilities)
         capabilities = capabilities.capabilities;
+    if (!(customConfig === null || customConfig === void 0 ? void 0 : customConfig.keepPlatformNameAsIs)) {
+        // We use `startsWith` for just a theorerical reason. It's not based on any concrete case that we knew of at the time of writing this code.
+        if ((_a = capabilities.platformName) === null || _a === void 0 ? void 0 : _a.startsWith('android')) {
+            capabilities.platformName = capabilities.platformName.charAt(0).toUpperCase() + capabilities.platformName.slice(1);
+        }
+        // We use `startsWith` for just a theorerical reason. It's not based on any concrete case that we knew of at the time of writing this code.
+        if ((_b = capabilities.platformName) === null || _b === void 0 ? void 0 : _b.startsWith('ios')) {
+            capabilities.platformName = 'iOS' + capabilities.platformName.slice(3);
+        }
+    }
     const info = {
         browserName: !capabilities.app && !capabilities.bundleId
-            ? ((_a = capabilities.browserName) !== null && _a !== void 0 ? _a : (_b = capabilities.desired) === null || _b === void 0 ? void 0 : _b.browserName) || undefined
+            ? ((_c = capabilities.browserName) !== null && _c !== void 0 ? _c : (_d = capabilities.desired) === null || _d === void 0 ? void 0 : _d.browserName) || undefined
             : undefined,
-        browserVersion: ((_c = capabilities.browserVersion) !== null && _c !== void 0 ? _c : capabilities.version) || undefined,
-        platformName: ((_e = (_d = capabilities.platformName) !== null && _d !== void 0 ? _d : capabilities.platform) !== null && _e !== void 0 ? _e : (_f = capabilities.desired) === null || _f === void 0 ? void 0 : _f.platformName) || undefined,
+        browserVersion: ((_e = capabilities.browserVersion) !== null && _e !== void 0 ? _e : capabilities.version) || undefined,
+        platformName: ((_g = (_f = capabilities.platformName) !== null && _f !== void 0 ? _f : capabilities.platform) !== null && _g !== void 0 ? _g : (_h = capabilities.desired) === null || _h === void 0 ? void 0 : _h.platformName) || undefined,
         platformVersion: capabilities.platformVersion || undefined,
         isW3C: isW3C(capabilities),
         isMobile: isMobile(capabilities),
     };
     if (info.isMobile) {
-        info.deviceName = ((_h = (_g = capabilities.desired) === null || _g === void 0 ? void 0 : _g.deviceName) !== null && _h !== void 0 ? _h : capabilities.deviceName) || undefined;
+        info.deviceName = ((_k = (_j = capabilities.desired) === null || _j === void 0 ? void 0 : _j.deviceName) !== null && _k !== void 0 ? _k : capabilities.deviceName) || undefined;
         info.isNative = info.isMobile && !info.browserName;
         info.isIOS = isIOS(capabilities);
         info.isAndroid = isAndroid(capabilities);
-        info.orientation = (_k = ((_j = capabilities.deviceOrientation) !== null && _j !== void 0 ? _j : capabilities.orientation)) === null || _k === void 0 ? void 0 : _k.toLowerCase();
+        info.orientation = (_m = ((_l = capabilities.deviceOrientation) !== null && _l !== void 0 ? _l : capabilities.orientation)) === null || _m === void 0 ? void 0 : _m.toLowerCase();
     }
     if (info.isNative) {
         info.pixelRatio = capabilities.pixelRatio;

package/dist/driver.js

@@ -144,7 +144,7 @@ class Driver {
         var _w, _x, _y, _z, _0, _1, _2, _3;
         const capabilities = await ((_b = (_a = this._spec).getCapabilities) === null || _b === void 0 ? void 0 : _b.call(_a, this.target));
         this._logger.log('Driver capabilities', capabilities);
-        const capabilitiesInfo = capabilities ? capabilities_1.parseCapabilities(capabilities) : undefined;
+        const capabilitiesInfo = capabilities ? capabilities_1.parseCapabilities(capabilities, this._customConfig) : undefined;
         const driverInfo = await ((_d = (_c = this._spec).getDriverInfo) === null || _d === void 0 ? void 0 : _d.call(_c, this.target));
         this._driverInfo = Object.assign(Object.assign({}, capabilitiesInfo), driverInfo);
         if (this.isWeb) {
@@ -168,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;
@@ -499,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.7.1",
+  "version": "1.8.1",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -74,12 +74,12 @@
   },
   "dependencies": {
     "@applitools/snippets": "2.2.3",
-    "@applitools/types": "1.3.1",
+    "@applitools/types": "1.4.0",
     "@applitools/utils": "1.2.14"
   },
   "devDependencies": {
     "@applitools/bongo": "^2.0.3",
-    "@types/mocha": "^9.0.0",
+    "@types/mocha": "^9.1.1",
     "@types/node": "^16.3.3",
     "@typescript-eslint/eslint-plugin": "^4.28.3",
     "@typescript-eslint/parser": "^4.28.3",

package/types/capabilities.d.ts

@@ -1,4 +1,4 @@
 import type * as types from '@applitools/types';
 declare type Capabilities = Record<string, any>;
-export declare function parseCapabilities(capabilities: Capabilities): types.DriverInfo;
+export declare function parseCapabilities(capabilities: Capabilities, customConfig?: types.CustomCapabilitiesConfig): types.DriverInfo;
 export {};

package/types/driver.d.ts

@@ -17,7 +17,7 @@ export declare class Driver<TDriver, TContext, TElement, TSelector> {
         spec: types.SpecDriver<TDriver, TContext, TElement, TSelector>;
         driver: Driver<TDriver, TContext, TElement, TSelector> | TDriver;
         logger?: any;
-        customConfig?: any;
+        customConfig?: types.CustomDriverConfig;
     });
     get target(): TDriver;
     get currentContext(): Context<TDriver, TContext, TElement, TSelector>;
@@ -62,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>;