@applitools/driver 1.11.37 → 1.11.38

package/types/driver.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type { Size, Region } from '@applitools/utils';
-import type { ScreenOrientation, Cookie } from './types';
+import type { DriverInfo, Capabilities, UserAgent, Environment, Viewport, Features, ScreenOrientation, Cookie } from './types';
 import { type Selector } from './selector';
 import { type SpecType, type SpecDriver, type WaitOptions } from './spec-driver';
 import { type Element } from './element';
@@ -18,92 +18,76 @@ type DriverOptions<T extends SpecType> = {
 };
 export declare class Driver<T extends SpecType> {
     private _target;
+    private _guid;
     private _mainContext;
     private _currentContext;
-    private _driverInfo;
+    private _driverInfo?;
+    private _environment?;
+    private _viewport?;
+    private _features?;
     private _helper?;
     private _state;
-    private _logger;
     private _customConfig;
+    private _logger;
     protected readonly _spec: SpecDriver<T>;
     constructor(options: DriverOptions<T>);
     get target(): T['driver'];
+    get guid(): string;
     get currentContext(): Context<T>;
     get mainContext(): Context<T>;
-    get features(): {
-        shadowSelector?: boolean | undefined;
-        allCookies?: boolean | undefined;
-        canExecuteOnlyFunctionScripts?: boolean | undefined;
-    } | undefined;
-    get deviceName(): string | undefined;
-    get platformName(): string | undefined;
-    get platformVersion(): string | number | undefined;
-    get browserName(): string | undefined;
-    get browserVersion(): string | number | undefined;
-    get userAgent(): string | undefined;
-    get orientation(): ScreenOrientation | undefined;
-    get pixelRatio(): number;
-    get viewportScale(): number;
-    get statusBarSize(): number | undefined;
-    get navigationBarSize(): number | undefined;
-    get isNative(): boolean;
-    get isWebView(): boolean;
-    get isWeb(): boolean;
-    get isEmulation(): boolean;
-    get isMobile(): boolean;
-    get isIOS(): boolean;
-    get isAndroid(): boolean;
-    get isMac(): boolean;
-    get isWindows(): boolean;
-    get isChromium(): boolean;
-    get isIE(): boolean;
-    get isEdgeLegacy(): boolean;
-    get isECClient(): boolean;
-    get isEC(): boolean;
-    get sessionId(): string | undefined;
-    get remoteHostname(): string | undefined;
     updateCurrentContext(context: Context<T>): void;
-    init(): Promise<this>;
+    refresh(): Promise<this>;
+    getDriverInfo({ force }?: {
+        force?: boolean;
+    }): Promise<DriverInfo>;
+    getCapabilities({ force }?: {
+        force?: boolean;
+    }): Promise<Capabilities | null>;
+    getUserAgent({ force }?: {
+        force?: boolean;
+    }): Promise<UserAgent | null>;
+    getUserAgentLegacy({ force }?: {
+        force?: boolean;
+    }): Promise<string | null>;
+    getEnvironment(): Promise<Environment>;
+    getViewport(): Promise<Viewport>;
+    getFeatures(): Promise<Features>;
+    getSessionId(): Promise<string | null>;
+    getDriverUrl(): Promise<string | null>;
     getHelper(): Promise<HelperAndroid<T> | HelperIOS<T> | null>;
     extractBrokerUrl(): Promise<string | null>;
-    switchWorld(options?: {
-        id?: string;
-        restoreState?: boolean;
-        goHome?: boolean;
-    }): Promise<void>;
+    getSessionMetadata(): Promise<any | undefined>;
     getWorlds(): Promise<string[] | null>;
     getCurrentWorld(): Promise<string | null>;
-    getSessionMetadata(): Promise<any>;
-    refreshContexts(): Promise<Context<T>>;
+    switchWorld(name?: string): Promise<void>;
     switchTo(context: Context<T>): Promise<Context<T>>;
     switchToMainContext(): Promise<Context<T>>;
     switchToParentContext(elevation?: number): Promise<Context<T>>;
     switchToChildContext(...references: ContextReference<T>[]): Promise<Context<T>>;
     normalizeRegion(region: Region): Promise<Region>;
     getRegionInViewport(context: Context<T>, region: Region): Promise<Region>;
-    element(selector: Selector<T>): Promise<Element<T> | null>;
-    elements(selector: Selector<T>): Promise<Element<T>[]>;
-    waitFor(selector: Selector<T>, options?: WaitOptions): Promise<Element<T> | null>;
-    execute(script: ((arg: any) => any) | string, arg?: any): Promise<any>;
     takeScreenshot(): Promise<Buffer>;
-    getViewportRegion(): Promise<Region>;
     getViewportSize(): Promise<Size>;
     setViewportSize(size: Size): Promise<void>;
-    getDisplaySize(): Promise<Size>;
-    getOrientation(): Promise<ScreenOrientation>;
+    getDisplaySize(): Promise<Size | undefined>;
+    getOrientation(): Promise<ScreenOrientation | undefined>;
     setOrientation(orientation: 'portrait' | 'landscape'): Promise<void>;
     getCookies(): Promise<Cookie[]>;
     getTitle(): Promise<string>;
     getUrl(): Promise<string>;
+    element(selector: Selector<T>): Promise<Element<T> | null>;
+    elements(selector: Selector<T>): Promise<Element<T>[]>;
+    waitFor(selector: Selector<T>, options?: WaitOptions): Promise<Element<T> | null>;
+    execute(script: ((arg: any) => any) | string, arg?: any): Promise<any>;
     visit(url: string): Promise<void>;
 }
 export declare function isDriver<T extends SpecType>(driver: any, spec?: SpecDriver<T>): driver is Driver<T> | T['driver'];
 export declare function makeDriver<T extends SpecType>(options: {
     driver: Driver<T> | T['driver'];
     spec?: SpecDriver<T>;
-    logger?: Logger;
     customConfig?: {
         useCeilForViewportSize?: boolean;
     };
+    logger?: Logger;
 }): Promise<Driver<T>>;
 export {};

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

@@ -14,7 +14,7 @@ export declare class MockDriver {
         [K in keyof MockDriver]: MockDriver[K] extends (...args: any[]) => any ? K : never;
     }[keyof MockDriver]>(name: TName, wrapper: (method: this[TName], thisArg: this, args: Parameters<this[TName]>) => ReturnType<this[TName]>): void;
     unwrapMethod(name: any): void;
-    get info(): {
+    get environment(): {
         isMobile: boolean;
         isNative: boolean;
         deviceName: any;

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

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type { Size } from '@applitools/utils';
-import { type DriverInfo } from '../spec-driver';
+import type { DriverInfo } from '../types';
 export type Driver = any;
 export type Element = any;
 export type Selector = string | {

package/types/spec-driver.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
-import type { Location, Size, Region } from '@applitools/utils';
-import type { ScreenOrientation, Cookie } from './types';
+import type { Size, Region } from '@applitools/utils';
+import type { DriverInfo, Capabilities, ScreenOrientation, Cookie } from './types';
 import { type CommonSelector } from './selector';
 export type SpecType<TDriver = unknown, TContext = unknown, TElement = unknown, TSelector = unknown> = {
     driver: TDriver;
@@ -37,7 +37,7 @@ export interface SpecDriver<T extends SpecType> {
     getViewportSize?(driver: T['driver']): Promise<Size>;
     getCookies?(driver: T['driver'] | T['context'], context?: boolean): Promise<Cookie[]>;
     getDriverInfo?(driver: T['driver']): Promise<DriverInfo>;
-    getCapabilities?(driver: T['driver']): Promise<Record<string, any>>;
+    getCapabilities?(driver: T['driver']): Promise<Capabilities>;
     getTitle(driver: T['driver']): Promise<string>;
     getUrl(driver: T['driver']): Promise<string>;
     takeScreenshot(driver: T['driver']): Promise<Buffer | string>;
@@ -69,42 +69,6 @@ export interface SpecDriver<T extends SpecType> {
     switchWorld?(driver: T['driver'], id: string): Promise<void>;
     getSessionMetadata?(driver: T['driver']): Promise<any>;
 }
-export type DriverInfo = {
-    sessionId?: string;
-    remoteHostname?: string;
-    browserName?: string;
-    browserVersion?: string;
-    platformName?: string;
-    platformVersion?: string;
-    deviceName?: string;
-    userAgent?: string;
-    viewportLocation?: Location;
-    viewportSize?: Size;
-    displaySize?: Size;
-    orientation?: ScreenOrientation;
-    pixelRatio?: number;
-    viewportScale?: number;
-    safeArea?: Region;
-    statusBarSize?: number;
-    navigationBarSize?: number;
-    isW3C?: boolean;
-    isChrome?: boolean;
-    isChromium?: boolean;
-    isEmulation?: boolean;
-    isMobile?: boolean;
-    isNative?: boolean;
-    isAndroid?: boolean;
-    isIOS?: boolean;
-    isMac?: boolean;
-    isWindows?: boolean;
-    isWebView?: boolean;
-    isECClient?: boolean;
-    features?: {
-        shadowSelector?: boolean;
-        allCookies?: boolean;
-        canExecuteOnlyFunctionScripts?: boolean;
-    };
-};
 export type WaitOptions = {
     state?: 'exist' | 'visible';
     interval?: number;

package/types/types.d.ts

@@ -1,3 +1,4 @@
+import type { Location, Size, Region } from '@applitools/utils';
 export type ScreenOrientation = 'portrait' | 'landscape' | 'portrait-secondary' | 'landscape-secondary';
 export type Cookie = {
     name: string;
@@ -9,3 +10,63 @@ export type Cookie = {
     secure?: boolean;
     sameSite?: 'Strict' | 'Lax' | 'None';
 };
+export type Capabilities = Record<string, any>;
+export type UserAgent = string | {
+    legacy: string;
+    brands: {
+        brand: string;
+        version: string;
+    }[];
+    platform: string;
+    platformVersion?: string;
+    model?: string;
+    mobile?: boolean;
+};
+export type Environment = {
+    browserName?: string;
+    browserVersion?: string;
+    platformName?: string;
+    platformVersion?: string;
+    deviceName?: string;
+    isW3C?: boolean;
+    isEC?: boolean;
+    isECClient?: boolean;
+    isWeb?: boolean;
+    isNative?: boolean;
+    isMobile?: boolean;
+    isEmulation?: boolean;
+    isIE?: boolean;
+    isEdge?: boolean;
+    isEdgeLegacy?: boolean;
+    isChrome?: boolean;
+    isChromium?: boolean;
+    isAndroid?: boolean;
+    isIOS?: boolean;
+    isMac?: boolean;
+    isWindows?: boolean;
+};
+export type Viewport = {
+    displaySize?: Size;
+    viewportSize: Size;
+    viewportLocation?: Location;
+    orientation?: ScreenOrientation;
+    pixelRatio: number;
+    viewportScale: number;
+    statusBarSize?: number;
+    navigationBarSize?: number;
+    safeArea?: Region;
+};
+export type Features = {
+    shadowSelector?: boolean;
+    allCookies?: boolean;
+    canExecuteOnlyFunctionScripts?: boolean;
+};
+export type DriverInfo = {
+    sessionId?: string;
+    remoteHostname?: string;
+    userAgent?: UserAgent | null;
+    capabilities?: Capabilities | null;
+    viewport?: Partial<Viewport>;
+    environment?: Partial<Environment>;
+    features?: Features;
+};

package/types/user-agent.d.ts

@@ -1,12 +1,2 @@
-type PlatformInfo = {
-    platformName: string;
-    platformVersion?: string;
-};
-type BrowserInfo = {
-    browserName: string;
-    browserVersion?: string;
-};
-export declare function parseUserAgent(userAgent: string): PlatformInfo & BrowserInfo;
-export declare function parsePlatform(userAgent: string): PlatformInfo;
-export declare function parseBrowser(userAgent: string): BrowserInfo;
-export {};
+import type { UserAgent, Environment } from './types';
+export declare function extractUserAgentEnvironment(userAgent: UserAgent): Environment;

package/dist/user-agent-data.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseUserAgentData = void 0;
-const WINDOWS_VERSIONS = {
-    '0.1.0': '7',
-    '0.2.0': '8',
-    '0.3.0': '8.1',
-    '10.0.0': '10',
-    '15.0.0': '11',
-};
-function parseUserAgentData(userAgentData) {
-    var _a, _b, _c, _d;
-    const chromiumBrand = (_a = userAgentData.brands) === null || _a === void 0 ? void 0 : _a.find(brand => /Chromium/i.test(brand.brand));
-    const browserBrand = (_c = (_b = userAgentData.brands) === null || _b === void 0 ? void 0 : _b.find(brand => brand !== chromiumBrand && !/Not.?A.?Brand/i.test(brand.brand))) !== null && _c !== void 0 ? _c : chromiumBrand;
-    const info = {
-        browserName: browserBrand === null || browserBrand === void 0 ? void 0 : browserBrand.brand,
-        browserVersion: browserBrand === null || browserBrand === void 0 ? void 0 : browserBrand.version,
-        platformName: userAgentData.platform || undefined,
-        platformVersion: userAgentData.platformVersion || undefined,
-        deviceName: userAgentData.model || undefined,
-        isMobile: userAgentData.mobile,
-        isChromium: Boolean(chromiumBrand),
-    };
-    if (info.platformName === 'Windows') {
-        info.platformVersion = WINDOWS_VERSIONS[info.platformVersion];
-    }
-    else if (info.platformName === 'macOS') {
-        info.platformName = 'Mac OS X';
-        info.platformVersion = (_d = info.platformVersion) === null || _d === void 0 ? void 0 : _d.split(/[._]/, 2).join('.');
-    }
-    return info;
-}
-exports.parseUserAgentData = parseUserAgentData;

package/types/user-agent-data.d.ts

@@ -1,13 +0,0 @@
-import { type DriverInfo } from './spec-driver';
-type UserAgentData = {
-    brands: {
-        brand: string;
-        version: string;
-    }[];
-    platform: string;
-    platformVersion?: string;
-    model?: string;
-    mobile?: boolean;
-};
-export declare function parseUserAgentData(userAgentData: UserAgentData): DriverInfo;
-export {};