@applitools/driver 1.2.5 → 1.3.1

package/types/driver.d.ts

@@ -0,0 +1,62 @@
+/// <reference types="node" />
+import type * as types from '@applitools/types';
+import { Context, ContextReference } from './context';
+import { Element } from './element';
+export declare class Driver<TDriver, TContext, TElement, TSelector> {
+    private _target;
+    private _mainContext;
+    private _currentContext;
+    private _driverInfo;
+    private _logger;
+    private _utils;
+    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;
+    });
+    get target(): TDriver;
+    get currentContext(): Context<TDriver, TContext, TElement, TSelector>;
+    get mainContext(): Context<TDriver, TContext, TElement, TSelector>;
+    get features(): {
+        shadowSelector?: boolean;
+        allCookies?: boolean;
+    };
+    get deviceName(): string;
+    get platformName(): string;
+    get platformVersion(): string | number;
+    get browserName(): string;
+    get browserVersion(): string | number;
+    get userAgent(): string;
+    get pixelRatio(): number;
+    get statusBarHeight(): number;
+    get navigationBarHeight(): number;
+    get isNative(): boolean;
+    get isWeb(): boolean;
+    get isMobile(): boolean;
+    get isIOS(): boolean;
+    get isAndroid(): boolean;
+    get isIE(): boolean;
+    get isEdgeLegacy(): boolean;
+    updateCurrentContext(context: Context<TDriver, TContext, TElement, TSelector>): void;
+    init(): Promise<this>;
+    refreshContexts(): Promise<Context<TDriver, TContext, TElement, TSelector>>;
+    switchTo(context: Context<TDriver, TContext, TElement, TSelector>): Promise<Context<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): 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>[]>;
+    execute(script: ((arg: any) => any) | string, arg?: any): Promise<any>;
+    takeScreenshot(): Promise<Buffer | string>;
+    getViewportSize(): Promise<types.Size>;
+    setViewportSize(size: types.Size): Promise<void>;
+    getDisplaySize(): Promise<types.Size>;
+    getOrientation(): Promise<'portrait' | 'landscape'>;
+    getCookies(): Promise<types.Cookie[]>;
+    getTitle(): Promise<string>;
+    getUrl(): Promise<string>;
+    visit(url: string): Promise<void>;
+}

package/types/element.d.ts

@@ -0,0 +1,55 @@
+import type * as types from '@applitools/types';
+import type { Context } from './context';
+export declare type ElementState = {
+    contentSize?: types.Size;
+    scrollOffset?: types.Location;
+    transforms?: any;
+};
+export declare class Element<TDriver, TContext, TElement, TSelector> {
+    private _target;
+    private _context;
+    private _selector;
+    private _index;
+    private _state;
+    private _originalOverflow;
+    private _touchPadding;
+    private _logger;
+    private _utils;
+    protected readonly _spec: types.SpecDriver<TDriver, TContext, TElement, TSelector>;
+    constructor(options: {
+        spec: types.SpecDriver<TDriver, TContext, TElement, TSelector>;
+        element?: TElement | Element<TDriver, TContext, TElement, TSelector>;
+        context?: Context<TDriver, TContext, TElement, TSelector>;
+        selector?: types.Selector<TSelector>;
+        index?: number;
+        logger?: any;
+    });
+    get target(): TElement;
+    get selector(): types.Selector<TSelector>;
+    get context(): Context<TDriver, TContext, TElement, TSelector>;
+    get driver(): import("./driver").Driver<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(): Promise<types.Region>;
+    getClientRegion(): Promise<types.Region>;
+    getContentSize(): Promise<types.Size>;
+    isScrollable(): Promise<boolean>;
+    isRoot(): Promise<boolean>;
+    getTouchPadding(): Promise<number>;
+    getAttribute(name: string): Promise<string>;
+    setAttribute(name: string, value: string): Promise<void>;
+    scrollTo(offset: types.Location): Promise<types.Location>;
+    translateTo(offset: types.Location): Promise<types.Location>;
+    getScrollOffset(): Promise<types.Location>;
+    getTranslateOffset(): Promise<types.Location>;
+    getInnerOffset(): Promise<types.Location>;
+    click(): Promise<void>;
+    preserveState(): Promise<ElementState>;
+    restoreState(state?: ElementState): Promise<void>;
+    hideScrollbars(): Promise<void>;
+    restoreScrollbars(): Promise<void>;
+    refresh(freshElement?: TElement): Promise<boolean>;
+    withRefresh<TResult>(operation: (...args: any[]) => TResult): Promise<TResult>;
+    toJSON(): TElement;
+}

package/types/fake/index.d.ts

@@ -0,0 +1,3 @@
+export { MockDriver } from './mock-driver';
+export { Driver, Element, Selector } from './spec-driver';
+export * as spec from './spec-driver';

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

@@ -0,0 +1,35 @@
+export declare class MockDriver {
+    constructor(options?: {});
+    mockScript(scriptMatcher: any, resultGenerator: any): void;
+    mockElement(selector: any, state: any): any;
+    mockElements(nodes: any, { parentId, parentContextId, parentRootId }?: {
+        parentId?: any;
+        parentContextId?: any;
+        parentRootId?: any;
+    }): void;
+    mockSelector(selector: any, element: any): void;
+    wrapMethod(name: any, wrapper: any): void;
+    unwrapMethod(name: any): void;
+    get info(): {
+        isMobile: boolean;
+        isNative: boolean;
+        deviceName: any;
+        platformName: any;
+        platformVersion: any;
+        browserName: any;
+        browserVersion: any;
+    };
+    executeScript(script: any, args?: any[]): Promise<any>;
+    findElement(selector: any, rootElement: any): Promise<any>;
+    findElements(selector: any, rootElement: any): Promise<any>;
+    switchToFrame(reference: any): Promise<this>;
+    switchToParentFrame(): Promise<this>;
+    getWindowRect(): Promise<any>;
+    setWindowRect(rect: any): Promise<void>;
+    getUrl(): Promise<any>;
+    getTitle(): Promise<any>;
+    visit(url: any): Promise<void>;
+    takeScreenshot(): Promise<void>;
+    toString(): string;
+    toJSON(): string;
+}

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

@@ -0,0 +1,29 @@
+/// <reference types="node" />
+import type { Size, DriverInfo } from '@applitools/types';
+export declare type Driver = any;
+export declare type Element = any;
+export declare type Selector = string | {
+    using: string;
+    value: string;
+};
+export declare function isDriver(driver: any): driver is Driver;
+export declare function isElement(element: any): element is Element;
+export declare function isSelector(selector: any): selector is Selector;
+export declare function transformSelector(selector: Selector | {
+    selector: Selector;
+}): Selector;
+export declare function isStaleElementError(): boolean;
+export declare function isEqualElements(_driver: Driver, element1: Element, element2: Element): Promise<boolean>;
+export declare function executeScript(driver: Driver, script: ((arg: any) => any) | string, arg: any): Promise<any>;
+export declare function findElement(driver: Driver, selector: Selector, parent?: Element): Promise<Element>;
+export declare function findElements(driver: Driver, selector: Selector, parent?: Element): Promise<Element[]>;
+export declare function mainContext(driver: Driver): Promise<Driver>;
+export declare function parentContext(driver: Driver): Promise<Driver>;
+export declare function childContext(driver: Driver, element: Element): Promise<Driver>;
+export declare function takeScreenshot(driver: Driver): Promise<Buffer | string>;
+export declare function getDriverInfo(driver: Driver): Promise<DriverInfo>;
+export declare function getWindowSize(driver: Driver): Promise<Size>;
+export declare function setWindowSize(driver: Driver, size: Size): Promise<void>;
+export declare function getUrl(driver: Driver): Promise<string>;
+export declare function getTitle(driver: Driver): Promise<string>;
+export declare function visit(driver: Driver, url: string): Promise<void>;

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './driver';
+export * from './context';
+export * from './element';

package/types/user-agent.d.ts

@@ -0,0 +1,12 @@
+declare type PlatformInfo = {
+    platformName: string;
+    platformVersion?: string;
+};
+declare 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 {};

package/types/utils.d.ts

@@ -0,0 +1,11 @@
+import type * as types from '@applitools/types';
+export declare type SpecUtils<_TDriver, TContext, TElement, TSelector> = {
+    isSelector(selector: any): selector is types.Selector<TSelector>;
+    transformSelector(selector: types.Selector<TSelector>): TSelector;
+    splitSelector(selector: types.Selector<TSelector>): types.Selector<TSelector>[];
+    findRootElement(context: TContext, selector: types.Selector<TSelector>): Promise<{
+        root: TElement;
+        selector: types.Selector<TSelector>;
+    }>;
+};
+export declare function makeSpecUtils<TDriver, TContext, TElement, TSelector>(spec: types.SpecDriver<TDriver, TContext, TElement, TSelector>): SpecUtils<TDriver, TContext, TElement, TSelector>;

package/.bongo/dry-run/package-lock.json

@@ -1,30 +0,0 @@
-{
-  "requires": true,
-  "lockfileVersion": 1,
-  "dependencies": {
-    "@applitools/driver": {
-      "version": "file:../dry-run.tgz",
-      "integrity": "sha512-JKhrl6Y6SNt1ar1BnCiFsgPsXQwXQeYx3Dig8043bpNXUJsGaWMMsLwVuYkUz335/rrsRyKZ/lir1w8TvtXrJA==",
-      "requires": {
-        "@applitools/snippets": "2.1.7",
-        "@applitools/types": "1.0.14",
-        "@applitools/utils": "1.2.3"
-      }
-    },
-    "@applitools/snippets": {
-      "version": "2.1.7",
-      "resolved": "https://registry.npmjs.org/@applitools/snippets/-/snippets-2.1.7.tgz",
-      "integrity": "sha512-Tr4Gj7Qov/oPy+8WI4oVmmubxqpOzr8P3Wjzpl6rA57xKLg6/TiIg5oZNb4+jEmO2ShjNYLaEwRWHl7kPgb4fw=="
-    },
-    "@applitools/types": {
-      "version": "1.0.14",
-      "resolved": "https://registry.npmjs.org/@applitools/types/-/types-1.0.14.tgz",
-      "integrity": "sha512-Exfi8EOGGBwpRpaLizXmsUXInXGXNU26qup7AjLJSJLYETwn3Q3W+0aLHBUbdFA87w9fPCQjXJuZxJgqsNpVig=="
-    },
-    "@applitools/utils": {
-      "version": "1.2.3",
-      "resolved": "https://registry.npmjs.org/@applitools/utils/-/utils-1.2.3.tgz",
-      "integrity": "sha512-MZXsrzeHTvjFLzpfyKRDUmZWzNxH3gWd3reqYf+1kYimALKB3CO82VDNmkaGJykrRbxEP03Yqha7fHJj9eKslQ=="
-    }
-  }
-}

package/.eslintrc

@@ -1,36 +0,0 @@
-{
-  "root": true,
-  "ignorePatterns": [
-    "node_modules/",
-    "dist/",
-    "logs",
-    "tmp/",
-    "types/",
-    "test/generic/",
-    "*.d.ts"
-  ],
-  "env": {
-    "node": true
-  },
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 2020,
-    "sourceType": "module"
-  },
-  "plugins": ["@typescript-eslint", "prettier", "node"],
-  "extends": ["plugin:@typescript-eslint/recommended", "prettier"],
-  "rules": {
-    "prettier/prettier": ["error", {
-      "arrowParens": "avoid",
-      "printWidth": 120
-    }],
-    "@typescript-eslint/no-unused-vars": [
-      "error",
-      {"varsIgnorePattern": "^_", "args": "all", "argsIgnorePattern": "^_"}
-    ],
-    "@typescript-eslint/explicit-module-boundary-types": "off",
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/ban-ts-comment": "off",
-    "@typescript-eslint/no-var-requires": "off"
-  }
-}