@applitools/nml-client 1.3.37 → 1.3.39

package/dist/client.js

@@ -1,91 +1,17 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.takeSnapshots = exports.takeScreenshot = void 0;
+exports.makeNMLClient = void 0;
 const logger_1 = require("@applitools/logger");
-const req_broker_1 = require("./req-broker");
-const utils = __importStar(require("@applitools/utils"));
-async function takeScreenshot({ url, settings, logger, }) {
+const requests_1 = require("./server/requests");
+const take_snapshots_1 = require("./take-snapshots");
+const take_screenshot_1 = require("./take-screenshot");
+function makeNMLClient({ config, logger }) {
     var _a;
     logger = (_a = logger === null || logger === void 0 ? void 0 : logger.extend({ label: 'nml client' })) !== null && _a !== void 0 ? _a : (0, logger_1.makeLogger)({ label: 'nml client' });
-    const req = (0, req_broker_1.makeReqBroker)({ config: settings, logger });
-    const payload = {
-        name: settings.name,
-        screenshotMode: settings.fully ? 'FULL_RESIZE' : 'VIEWPORT',
-        scrollRootElement: settings.scrollRootElement,
-        hideCaret: settings.hideCaret,
-        waitBeforeCapture: settings.waitBeforeCapture,
-        overlap: settings.overlap,
-        selectorsToFindRegionsFor: [],
+    const requests = (0, requests_1.makeNMLRequests)({ config, logger });
+    return {
+        takeScreenshot: (0, take_screenshot_1.makeTakeScreenshot)({ requests, logger }),
+        takeSnapshots: (0, take_snapshots_1.makeTakeSnapshots)({ requests, logger }),
     };
-    const response = await req(url, {
-        name: 'TAKE_SCREENSHOT',
-        body: {
-            protocolVersion: '1.0',
-            name: 'TAKE_SCREENSHOT',
-            key: utils.general.guid(),
-            payload,
-        },
-        logger,
-    });
-    const result = await response.json();
-    return result.payload;
 }
-exports.takeScreenshot = takeScreenshot;
-async function takeSnapshots({ url, settings, logger, }) {
-    var _a;
-    logger = (_a = logger === null || logger === void 0 ? void 0 : logger.extend({ label: 'nml client' })) !== null && _a !== void 0 ? _a : (0, logger_1.makeLogger)({ label: 'nml client' });
-    const req = (0, req_broker_1.makeReqBroker)({ config: settings, logger });
-    const payload = {
-        waitBeforeCapture: settings.waitBeforeCapture,
-    };
-    const response = await req(url, {
-        name: 'TAKE_SNAPSHOT',
-        body: {
-            protocolVersion: '1.0',
-            name: 'TAKE_SNAPSHOT',
-            key: utils.general.guid(),
-            payload,
-        },
-    });
-    const snapshot = await response.json().then(({ payload }) => {
-        const platformName = payload.result.resourceMap.metadata.platformName;
-        const snapshot = { platformName, vhsHash: payload.result.resourceMap.vhs };
-        if (platformName === 'ios') {
-            ;
-            snapshot.vhsCompatibilityParams = {
-                UIKitLinkTimeVersionNumber: payload.result.metadata.UIKitLinkTimeVersionNumber,
-                UIKitRunTimeVersionNumber: payload.result.metadata.UIKitRunTimeVersionNumber,
-            };
-        }
-        else if (platformName === 'android') {
-            ;
-            snapshot.vhsType = 'android-x';
-        }
-        return snapshot;
-    });
-    return Array(settings.renderers.length).fill(snapshot);
-}
-exports.takeSnapshots = takeSnapshots;
+exports.makeNMLClient = makeNMLClient;

package/dist/index.js

@@ -15,3 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./client"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./server/requests"), exports);

package/dist/server/requests.js

@@ -0,0 +1,87 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeNMLRequests = void 0;
+const req_broker_1 = require("./req-broker");
+const utils = __importStar(require("@applitools/utils"));
+function makeNMLRequests({ config, logger: defaultLogger, }) {
+    let brokerUrl = config.brokerUrl;
+    const req = (0, req_broker_1.makeReqBroker)({ config, logger: defaultLogger });
+    return { takeScreenshot, takeSnapshots };
+    async function takeScreenshot({ settings, logger = defaultLogger, }) {
+        const response = await req(brokerUrl, {
+            name: 'TAKE_SCREENSHOT',
+            body: {
+                protocolVersion: '1.0',
+                name: 'TAKE_SCREENSHOT',
+                key: utils.general.guid(),
+                payload: {
+                    name: settings.name,
+                    screenshotMode: settings.fully ? 'FULL_RESIZE' : 'VIEWPORT',
+                    scrollRootElement: settings.scrollRootElement,
+                    hideCaret: settings.hideCaret,
+                    waitBeforeCapture: settings.waitBeforeCapture,
+                    overlap: settings.overlap,
+                    selectorsToFindRegionsFor: [],
+                },
+            },
+            logger,
+        });
+        const result = await response.json();
+        brokerUrl = result.nextPath;
+        return result.payload;
+    }
+    async function takeSnapshots({ settings, logger = defaultLogger, }) {
+        const response = await req(brokerUrl, {
+            name: 'TAKE_SNAPSHOT',
+            body: {
+                protocolVersion: '1.0',
+                name: 'TAKE_SNAPSHOT',
+                key: utils.general.guid(),
+                payload: {
+                    waitBeforeCapture: settings.waitBeforeCapture,
+                },
+            },
+            logger,
+        });
+        const result = await response.json();
+        brokerUrl = result.nextPath;
+        const platformName = result.payload.result.resourceMap.metadata.platformName;
+        const snapshot = { platformName, vhsHash: result.payload.result.resourceMap.vhs };
+        if (platformName === 'ios') {
+            ;
+            snapshot.vhsCompatibilityParams = {
+                UIKitLinkTimeVersionNumber: result.payload.result.metadata.UIKitLinkTimeVersionNumber,
+                UIKitRunTimeVersionNumber: result.payload.result.metadata.UIKitRunTimeVersionNumber,
+            };
+        }
+        else if (platformName === 'android') {
+            ;
+            snapshot.vhsType = 'android-x';
+        }
+        return Array(settings.renderers.length).fill(snapshot);
+    }
+}
+exports.makeNMLRequests = makeNMLRequests;

package/dist/take-screenshot.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeTakeScreenshot = void 0;
+function makeTakeScreenshot({ requests, logger: defaultLogger }) {
+    return async function takeScreenshot({ settings, logger = defaultLogger, }) {
+        return requests.takeScreenshot({ settings, logger });
+    };
+}
+exports.makeTakeScreenshot = makeTakeScreenshot;

package/dist/take-snapshots.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeTakeSnapshots = void 0;
+function makeTakeSnapshots({ requests, logger: defaultLogger }) {
+    return async function takeSnapshots({ settings, logger = defaultLogger, }) {
+        return requests.takeSnapshots({ settings, logger });
+    };
+}
+exports.makeTakeSnapshots = makeTakeSnapshots;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/nml-client",
-  "version": "1.3.37",
+  "version": "1.3.39",
   "description": "Client to integrate the SDKs to the Native Mobile Library (NML)",
   "homepage": "https://applitools.com",
   "bugs": {
@@ -37,28 +37,25 @@
   "scripts": {
     "lint": "node ../../node_modules/.bin/eslint '**/*.ts'",
     "build": "node ../../node_modules/.bin/tsc --project ./tsconfig.build.json",
-    "test": "mocha --no-timeouts -r ts-node/register 'test/**/*.spec.ts'",
+    "test": "node ../../node_modules/.bin/mocha './test/**/*.spec.ts' --parallel --jobs ${MOCHA_JOBS:-15}",
     "test:sanity": "yarn test",
-    "test:watch": "yarn test --watch --extension ts",
     "deps": "bongo deps",
     "preversion": "bongo preversion",
     "version": "bongo version",
     "postversion": "bongo postversion --skip-release-notification"
   },
   "dependencies": {
-    "@applitools/logger": "1.1.46",
-    "@applitools/req": "1.1.30",
-    "@applitools/utils": "1.3.30"
+    "@applitools/logger": "1.1.47",
+    "@applitools/req": "1.1.31",
+    "@applitools/utils": "1.3.31"
   },
   "devDependencies": {
     "@applitools/bongo": "^2.2.5",
-    "@applitools/spec-driver-webdriverio": "^1.4.29",
-    "@applitools/test-server": "^1.1.26",
-    "@applitools/test-utils": "^1.5.12",
-    "@types/mocha": "^9.1.1",
-    "@types/node": "12",
+    "@applitools/spec-driver-webdriverio": "^1.4.31",
+    "@applitools/test-server": "^1.1.27",
+    "@applitools/test-utils": "^1.5.13",
+    "@types/node": "^12.20.55",
     "chromedriver": "^109.0.0",
-    "mocha": "^10.0.0",
     "nock": "^13.2.9",
     "webdriverio": "^8.3.2"
   },

package/types/client.d.ts

@@ -1,13 +1,7 @@
-import type { ScreenshotSettings, Screenshot, SnapshotSettings, AndroidSnapshot, IOSSnapshot } from './types';
+import type { NMLClient } from './types';
 import { type Logger } from '@applitools/logger';
-import { type ReqBrokerConfig } from './req-broker';
-export declare function takeScreenshot({ url, settings, logger, }: {
-    url: string;
-    settings: ReqBrokerConfig & ScreenshotSettings;
+import { type NMLRequestsConfig } from './server/requests';
+export declare function makeNMLClient({ config, logger }: {
+    config: NMLRequestsConfig;
     logger?: Logger;
-}): Promise<Screenshot>;
-export declare function takeSnapshots<TSnapshot extends IOSSnapshot | AndroidSnapshot = IOSSnapshot | AndroidSnapshot>({ url, settings, logger, }: {
-    url: string;
-    settings: ReqBrokerConfig & SnapshotSettings;
-    logger?: Logger;
-}): Promise<TSnapshot[]>;
+}): NMLClient;

package/types/index.d.ts

@@ -1 +1,3 @@
 export * from './client';
+export * from './types';
+export * from './server/requests';

package/types/server/requests.d.ts

@@ -0,0 +1,20 @@
+import type { ScreenshotSettings, Screenshot, SnapshotSettings, IOSSnapshot, AndroidSnapshot } from '../types';
+import { type Logger } from '@applitools/logger';
+import { type ReqBrokerConfig } from './req-broker';
+export interface NMLRequests {
+    takeScreenshot(options: {
+        settings: ScreenshotSettings;
+        logger?: Logger;
+    }): Promise<Screenshot>;
+    takeSnapshots<TSnapshot extends IOSSnapshot | AndroidSnapshot = IOSSnapshot | AndroidSnapshot>(options: {
+        settings: SnapshotSettings;
+        logger?: Logger;
+    }): Promise<TSnapshot[]>;
+}
+export type NMLRequestsConfig = ReqBrokerConfig & {
+    brokerUrl: string;
+};
+export declare function makeNMLRequests({ config, logger: defaultLogger, }: {
+    config: NMLRequestsConfig;
+    logger: Logger;
+}): NMLRequests;

package/types/take-screenshot.d.ts

@@ -0,0 +1,12 @@
+import type { ScreenshotSettings, Screenshot } from './types';
+import { type Logger } from '@applitools/logger';
+import { type NMLRequests } from './server/requests';
+type Options = {
+    requests: NMLRequests;
+    logger: Logger;
+};
+export declare function makeTakeScreenshot({ requests, logger: defaultLogger }: Options): ({ settings, logger, }: {
+    settings: ScreenshotSettings;
+    logger?: Logger | undefined;
+}) => Promise<Screenshot>;
+export {};

package/types/take-snapshots.d.ts

@@ -0,0 +1,12 @@
+import type { SnapshotSettings, AndroidSnapshot, IOSSnapshot } from './types';
+import { type Logger } from '@applitools/logger';
+import { type NMLRequests } from './server/requests';
+type Options = {
+    requests: NMLRequests;
+    logger: Logger;
+};
+export declare function makeTakeSnapshots({ requests, logger: defaultLogger }: Options): <TSnapshot extends AndroidSnapshot | IOSSnapshot = AndroidSnapshot | IOSSnapshot>({ settings, logger, }: {
+    settings: SnapshotSettings;
+    logger?: Logger | undefined;
+}) => Promise<TSnapshot[]>;
+export {};

package/types/types.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import type { Size, Location, Region } from '@applitools/utils';
+import { type Logger } from '@applitools/logger';
 export type Selector = string | {
     selector: string;
     type?: string;
@@ -65,3 +66,13 @@ export type IOSSnapshot = {
         contentType: string;
     };
 };
+export interface NMLClient {
+    takeScreenshot(options: {
+        settings: ScreenshotSettings;
+        logger?: Logger;
+    }): Promise<Screenshot>;
+    takeSnapshots<TSnapshot extends IOSSnapshot | AndroidSnapshot = IOSSnapshot | AndroidSnapshot>(options: {
+        settings: SnapshotSettings;
+        logger?: Logger;
+    }): Promise<TSnapshot[]>;
+}