@applitools/nml-client 1.3.3 → 1.3.4

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/nml-client",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "Client to integrate the SDKs to the Native Mobile Library (NML)",
   "homepage": "https://applitools.com",
   "bugs": {
@@ -46,16 +46,15 @@
     "postversion": "bongo postversion --skip-release-notification"
   },
   "dependencies": {
-    "@applitools/logger": "1.1.26",
-    "@applitools/req": "1.1.10",
-    "@applitools/types": "1.5.19",
-    "@applitools/utils": "1.3.12"
+    "@applitools/logger": "1.1.27",
+    "@applitools/req": "1.1.11",
+    "@applitools/utils": "1.3.13"
   },
   "devDependencies": {
     "@applitools/bongo": "^2.2.0",
     "@applitools/scripts": "^1.2.0",
-    "@applitools/spec-driver-selenium": "^1.5.0",
-    "@applitools/test-server": "^1.1.5",
+    "@applitools/spec-driver-selenium": "^1.5.2",
+    "@applitools/test-server": "^1.1.6",
     "@applitools/test-utils": "^1.5.2",
     "@types/mocha": "^9.1.1",
     "@types/node": "12",

package/types/client.d.ts

@@ -1,25 +1,13 @@
-import type { Selector, Renderer } from '@applitools/types';
-import type { Screenshot, ScreenshotSettings as ClassicScreenshotSettings } from '@applitools/types/classic';
-import type { AndroidVHS, IOSVHS } from '@applitools/types/ufg';
+import type { ScreenshotSettings, Screenshot, SnapshotSettings, AndroidSnapshot, IOSSnapshot } from './types';
 import { type Logger } from '@applitools/logger';
 import { type ReqBrokerConfig } from './req-broker';
-export declare type ScreenshotSettings = ReqBrokerConfig & ClassicScreenshotSettings<never, never> & {
-    name?: string;
-    selectorsToFindRegionsFor?: Selector[];
-};
-export declare type SnapshotSettings = ReqBrokerConfig & {
-    name?: string;
-    renderers: Renderer[];
-    resourceSeparation?: boolean;
-    waitBeforeCapture?: number;
-};
 export declare function takeScreenshot({ url, settings, logger, }: {
     url: string;
-    settings: ScreenshotSettings;
+    settings: ReqBrokerConfig & ScreenshotSettings;
     logger?: Logger;
 }): Promise<Screenshot>;
 export declare function takeSnapshots({ url, settings, logger, }: {
     url: string;
-    settings: SnapshotSettings;
+    settings: ReqBrokerConfig & SnapshotSettings;
     logger?: Logger;
-}): Promise<IOSVHS[] | AndroidVHS[]>;
+}): Promise<IOSSnapshot[] | AndroidSnapshot[]>;

package/types/req-broker.d.ts

@@ -1,6 +1,5 @@
-import type { Proxy } from '@applitools/types';
 import { type Logger } from '@applitools/logger';
-import { type Req, type Options } from '@applitools/req';
+import { type Req, type Options, type Proxy } from '@applitools/req';
 export declare type ReqBrokerConfig = {
     proxy?: Proxy;
     agentId?: string;

package/types/types.d.ts

@@ -0,0 +1,73 @@
+/// <reference types="node" />
+import type { Size, Location, Region } from '@applitools/utils';
+export declare type Selector = string | {
+    selector: string;
+    type?: string;
+    shadow?: Selector;
+    frame?: Selector;
+};
+export declare type ScreenshotSettings = {
+    region?: Region | Selector;
+    debugImages?: {
+        path: string;
+        prefix?: string;
+    };
+    fully?: boolean;
+    scrollRootElement?: Selector;
+    hideScrollbars?: boolean;
+    hideCaret?: boolean;
+    overlap?: {
+        top?: number;
+        bottom?: number;
+    };
+    waitBeforeCapture?: number;
+    waitBetweenStitches?: number;
+    lazyLoad?: boolean | {
+        scrollLength?: number;
+        waitingTime?: number;
+        maxAmountToScroll?: number;
+    };
+    webview?: boolean | string;
+    name?: string;
+    selectorsToFindRegionsFor?: Selector[];
+};
+export declare type Screenshot = {
+    image: Buffer | string;
+    size?: Size;
+    name?: string;
+    source?: string;
+    dom?: string;
+    locationInViewport?: Location;
+    locationInView?: Location;
+    fullViewSize?: Size;
+};
+export declare type SnapshotSettings = {
+    name?: string;
+    renderers: any[];
+    resourceSeparation?: boolean;
+    waitBeforeCapture?: number;
+};
+export declare type AndroidSnapshot = {
+    platformName: 'android';
+    vhsType: string;
+    vhsHash: {
+        hashFormat: string;
+        hash: string;
+        contentType: string;
+    };
+};
+export declare type IOSSnapshot = {
+    platformName: 'ios';
+    vhsCompatibilityParams: Record<string, any>;
+} & ({
+    resourceContents: Record<string, {
+        type: string;
+        value: Buffer;
+    }>;
+} | {
+    vhsHash: {
+        hashFormat: string;
+        hash: string;
+        contentType: string;
+    };
+});