@applitools/driver 1.7.2 → 1.8.2

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) {
@@ -381,11 +381,11 @@ class Driver {
         }
         return this.currentContext;
     }
-    async normalizeRegion(region, shouldIgnoreSafeRegion) {
+    async normalizeRegion(region) {
         if (this.isWeb || !utils.types.has(this._driverInfo, ['viewportSize', 'statusBarHeight']))
             return region;
         const scaledRegion = this.isAndroid ? utils.geometry.scale(region, 1 / this.pixelRatio) : region;
-        const safeRegion = this.isIOS && !shouldIgnoreSafeRegion
+        const safeRegion = this.isIOS && utils.geometry.isIntersected(scaledRegion, this._driverInfo.safeArea)
             ? utils.geometry.intersect(scaledRegion, this._driverInfo.safeArea)
             : scaledRegion;
         const offsetRegion = utils.geometry.offsetNegative(safeRegion, {

package/dist/element.js

@@ -106,7 +106,7 @@ class Element {
             return this;
         }
     }
-    async getRegion(shouldIgnoreSafeRegion) {
+    async getRegion() {
         const region = await this.withRefresh(async () => {
             if (this.driver.isWeb) {
                 this._logger.log('Extracting region of web element with selector', this.selector);
@@ -116,7 +116,7 @@ class Element {
                 this._logger.log('Extracting region of native element with selector', this.selector);
                 const region = await this._spec.getElementRegion(this.driver.target, this.target);
                 this._logger.log('Extracted native region', region);
-                return this.driver.normalizeRegion(region, shouldIgnoreSafeRegion);
+                return this.driver.normalizeRegion(region);
             }
         });
         this._logger.log('Extracted region', region);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.7.2",
+  "version": "1.8.2",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -74,12 +74,12 @@
   },
   "dependencies": {
     "@applitools/snippets": "2.2.3",
-    "@applitools/types": "1.3.2",
-    "@applitools/utils": "1.2.14"
+    "@applitools/types": "1.4.2",
+    "@applitools/utils": "1.3.0"
   },
   "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>;
@@ -52,7 +52,7 @@ export declare class Driver<TDriver, TContext, TElement, TSelector> {
     switchToMainContext(): Promise<Context<TDriver, TContext, TElement, TSelector>>;
     switchToParentContext(elevation?: number): Promise<Context<TDriver, TContext, TElement, TSelector>>;
     switchToChildContext(...references: ContextReference<TDriver, TContext, TElement, TSelector>[]): Promise<Context<TDriver, TContext, TElement, TSelector>>;
-    normalizeRegion(region: types.Region, shouldIgnoreSafeRegion?: boolean): Promise<types.Region>;
+    normalizeRegion(region: types.Region): Promise<types.Region>;
     getRegionInViewport(context: Context<TDriver, TContext, TElement, TSelector>, region: types.Region): Promise<types.Region>;
     element(selector: types.Selector<TSelector>): Promise<Element<TDriver, TContext, TElement, TSelector>>;
     elements(selector: types.Selector<TSelector>): Promise<Element<TDriver, TContext, TElement, TSelector>[]>;

package/types/element.d.ts

@@ -31,7 +31,7 @@ export declare class Element<TDriver, TContext, TElement, TSelector> {
     get isRef(): boolean;
     equals(element: Element<TDriver, TContext, TElement, TSelector> | TElement): Promise<boolean>;
     init(context: Context<TDriver, TContext, TElement, TSelector>): Promise<this>;
-    getRegion(shouldIgnoreSafeRegion?: boolean): Promise<types.Region>;
+    getRegion(): Promise<types.Region>;
     getClientRegion(): Promise<types.Region>;
     getContentSize(): Promise<types.Size>;
     isScrollable(): Promise<boolean>;