@applitools/driver 1.9.26 → 1.9.28

package/dist/capabilities.js

@@ -1,41 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseCapabilities = void 0;
-function parseCapabilities(capabilities, customConfig) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
+function parseCapabilities(capabilities) {
+    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
-            ? ((_c = capabilities.browserName) !== null && _c !== void 0 ? _c : (_d = capabilities.desired) === null || _d === void 0 ? void 0 : _d.browserName) || undefined
+            ? ((_a = capabilities.browserName) !== null && _a !== void 0 ? _a : (_b = capabilities.desired) === null || _b === void 0 ? void 0 : _b.browserName) || undefined
             : 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,
+        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,
         platformVersion: capabilities.platformVersion || undefined,
         isW3C: isW3C(capabilities),
         isMobile: isMobile(capabilities),
     };
     if (info.isMobile) {
-        info.deviceName = ((_k = (_j = capabilities.desired) === null || _j === void 0 ? void 0 : _j.deviceName) !== null && _k !== void 0 ? _k : capabilities.deviceName) || undefined;
+        info.deviceName = ((_h = (_g = capabilities.desired) === null || _g === void 0 ? void 0 : _g.deviceName) !== null && _h !== void 0 ? _h : capabilities.deviceName) || undefined;
         info.isNative = info.isMobile && !info.browserName;
         info.isIOS = isIOS(capabilities);
         info.isAndroid = isAndroid(capabilities);
-        info.orientation = (_m = ((_l = capabilities.deviceOrientation) !== null && _l !== void 0 ? _l : capabilities.orientation)) === null || _m === void 0 ? void 0 : _m.toLowerCase();
+        info.orientation = (_k = ((_j = capabilities.deviceOrientation) !== null && _j !== void 0 ? _j : capabilities.orientation)) === null || _k === void 0 ? void 0 : _k.toLowerCase();
     }
     if (info.isNative) {
         info.displaySize = extractDisplaySize(capabilities);
         info.pixelRatio = capabilities.pixelRatio;
-        info.statusBarSize = (_o = capabilities.statBarHeight) !== null && _o !== void 0 ? _o : (_p = capabilities.viewportRect) === null || _p === void 0 ? void 0 : _p.top;
+        info.statusBarSize = (_l = capabilities.statBarHeight) !== null && _l !== void 0 ? _l : (_m = capabilities.viewportRect) === null || _m === void 0 ? void 0 : _m.top;
         if (info.displaySize && info.orientation && capabilities.viewportRect) {
             info.navigationBarSize =
                 info.orientation === 'landscape'

package/dist/driver.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Driver = void 0;
+exports.makeDriver = exports.Driver = void 0;
 const logger_1 = require("@applitools/logger");
 const utils = __importStar(require("@applitools/utils"));
 const specUtils = __importStar(require("./spec-utils"));
@@ -148,7 +148,7 @@ class Driver {
         var _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15;
         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 ? (0, capabilities_1.parseCapabilities)(capabilities, this._customConfig) : undefined;
+        const capabilitiesInfo = capabilities ? (0, capabilities_1.parseCapabilities)(capabilities) : undefined;
         const driverInfo = await ((_d = (_c = this._spec).getDriverInfo) === null || _d === void 0 ? void 0 : _d.call(_c, this.target));
         this._driverInfo = { ...capabilitiesInfo, ...driverInfo };
         if (this.isMobile) {
@@ -619,3 +619,10 @@ class Driver {
     }
 }
 exports.Driver = Driver;
+async function makeDriver(options) {
+    const driver = new Driver(options);
+    await driver.init();
+    await driver.refreshContexts();
+    return driver;
+}
+exports.makeDriver = makeDriver;

package/dist/spec-utils.js

@@ -34,6 +34,7 @@ exports.isSimpleCommonSelector = isSimpleCommonSelector;
 function isCommonSelector(spec, selector) {
     return (utils.types.isPlainObject(selector) &&
         utils.types.has(selector, 'selector') &&
+        Object.keys(selector).every(key => ['selector', 'type', 'frame', 'shadow'].includes(key)) &&
         (utils.types.isString(selector.selector) || spec.isSelector(selector.selector)));
 }
 exports.isCommonSelector = isCommonSelector;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.9.26",
+  "version": "1.9.28",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -40,9 +40,18 @@
       "types": "./types/debug/index.d.ts",
       "default": "./dist/debug/index.js"
     },
-    "./dist/*": "./dist/*.js",
-    "./dist/fake": "./dist/fake/index.js",
-    "./dist/debug": "./dist/debug/index.js",
+    "./dist/*": {
+      "types": "./types/*.d.ts",
+      "default": "./dist/*.js"
+    },
+    "./dist/fake": {
+      "types": "./types/fake/index.d.ts",
+      "default": "./dist/fake/index.js"
+    },
+    "./dist/debug": {
+      "types": "./types/debug/index.d.ts",
+      "default": "./dist/debug/index.js"
+    },
     "./package.json": "./package.json"
   },
   "main": "./dist/index.js",
@@ -78,10 +87,10 @@
     }
   },
   "dependencies": {
-    "@applitools/logger": "1.1.16",
+    "@applitools/logger": "1.1.20",
     "@applitools/snippets": "2.4.5",
-    "@applitools/types": "1.5.9",
-    "@applitools/utils": "1.3.10",
+    "@applitools/types": "1.5.13",
+    "@applitools/utils": "1.3.12",
     "semver": "7.3.7"
   },
   "devDependencies": {

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, customConfig?: types.CustomCapabilitiesConfig): types.DriverInfo;
+export declare function parseCapabilities(capabilities: Capabilities): types.DriverInfo;
 export {};

package/types/driver.d.ts

@@ -5,6 +5,12 @@ import { Context, ContextReference } from './context';
 import { Element } from './element';
 import { HelperIOS } from './helper-ios';
 import { HelperAndroid } from './helper-android';
+declare type DriverOptions<TDriver, TContext, TElement, TSelector> = {
+    spec: types.SpecDriver<TDriver, TContext, TElement, TSelector>;
+    driver: Driver<TDriver, TContext, TElement, TSelector> | TDriver;
+    logger?: Logger;
+    customConfig?: types.CustomDriverConfig;
+};
 export declare class Driver<TDriver, TContext, TElement, TSelector> {
     private _target;
     private _mainContext;
@@ -14,12 +20,7 @@ export declare class Driver<TDriver, TContext, TElement, TSelector> {
     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?: Logger;
-        customConfig?: types.CustomDriverConfig;
-    });
+    constructor(options: DriverOptions<TDriver, TContext, TElement, TSelector>);
     get target(): TDriver;
     get currentContext(): Context<TDriver, TContext, TElement, TSelector>;
     get mainContext(): Context<TDriver, TContext, TElement, TSelector>;
@@ -70,3 +71,5 @@ export declare class Driver<TDriver, TContext, TElement, TSelector> {
     getUrl(): Promise<string>;
     visit(url: string): Promise<void>;
 }
+export declare function makeDriver<TDriver, TContext, TElement, TSelector>(options: DriverOptions<TDriver, TContext, TElement, TSelector>): Promise<Driver<TDriver, TContext, TElement, TSelector>>;
+export {};

package/types/element.d.ts

@@ -40,7 +40,11 @@ export declare class Element<TDriver, TContext, TElement, TSelector> {
     getRegion(): Promise<types.Region>;
     getClientRegion(): Promise<types.Region>;
     getContentSize(options?: {
-        lazyLoad?: types.LazyLoadOptions;
+        lazyLoad?: {
+            scrollLength?: number;
+            waitingTime?: number;
+            maxAmountToScroll?: number;
+        };
     }): Promise<types.Size>;
     isPager(): Promise<boolean>;
     isScrollable(): Promise<boolean>;

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

@@ -21,7 +21,7 @@ export declare class MockDriver {
     };
     executeScript(script: any, args?: any[]): Promise<any>;
     findElement(selector: any, rootElement?: any): Promise<any>;
-    findElements(selector: any, rootElement: any): Promise<any>;
+    findElements(selector: any, rootElement?: any): Promise<any>;
     switchToFrame(reference: any): Promise<this>;
     switchToParentFrame(): Promise<this>;
     getWindowRect(): Promise<any>;

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

@@ -7,7 +7,7 @@ export declare type Selector = string | {
     value: string;
 };
 declare type CommonSelector = string | {
-    selector: Selector | string;
+    selector: string;
     type?: string;
 };
 export declare function isDriver(driver: any): driver is Driver;

package/types/helper-android.d.ts

@@ -26,7 +26,11 @@ export declare class HelperAndroid<TDriver, TContext, TElement, TSelector> {
     private _getElementId;
     private _command;
     getContentRegion(element: Element<TDriver, TContext, TElement, TSelector>, options?: {
-        lazyLoad?: types.LazyLoadOptions;
+        lazyLoad?: {
+            scrollLength?: number;
+            waitingTime?: number;
+            maxAmountToScroll?: number;
+        };
     }): Promise<types.Region>;
     getTouchPadding(): Promise<number>;
     getRegion(element: Element<TDriver, TContext, TElement, TSelector>): Promise<types.Region>;