@applitools/nml-client 1.8.27 → 1.9.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.9.0](https://github.com/Applitools-Dev/sdk/compare/js/nml-client@1.8.27...js/nml-client@1.9.0) (2025-03-31)
+
+
+### Features
+
+* add accessibility field to screenshot ([#2815](https://github.com/Applitools-Dev/sdk/issues/2815)) ([3d111f3](https://github.com/Applitools-Dev/sdk/commit/3d111f354c5eedeb8914f18318ccecce5fd13002))
+
 ## [1.8.27](https://github.com/Applitools-Dev/sdk/compare/js/nml-client@1.8.26...js/nml-client@1.8.27) (2025-03-30)
 
 

package/dist/server/requests.js

@@ -59,7 +59,7 @@ function makeNMLRequests({ settings, logger: mainLogger, }) {
         brokerUrl = result.nextPath;
     }
     async function takeScreenshots({ settings, logger = mainLogger, }) {
-        var _a, _b;
+        var _a;
         logger = logger.extend(mainLogger, { tags: [`nml-request-${utils.general.shortid()}`] });
         logger.log('Request "takeScreenshots" called with settings', settings);
         const { localEnvironment, renderEnvironments, environmentSettings } = await (0, get_environments_info_1.getNMLEnvironmentsInfo)({
@@ -81,6 +81,7 @@ function makeNMLRequests({ settings, logger: mainLogger, }) {
                         deviceList: !localEnvironment ? environmentSettings : undefined,
                         scrollRootElement: fallbackId(settings.scrollRootElement),
                         region: fallbackId(settings.region),
+                        sendDom: settings.sendDom,
                         selectorsToFindRegionsFor: (_a = settings.selectorsToFindRegionsFor) === null || _a === void 0 ? void 0 : _a.map(selector => fallbackId(selector)),
                     },
                 },
@@ -96,26 +97,37 @@ function makeNMLRequests({ settings, logger: mainLogger, }) {
                         {
                             image: result.payload.result[0].result.screenshotUrl,
                             environment: localEnvironment,
-                            calculateRegions: (_b = result.payload.result[0].result) === null || _b === void 0 ? void 0 : _b.selectorRegions,
+                            calculateRegions: result.payload.result[0].result.selectorRegions,
+                            dom: result.payload.result[0].result.dom,
                         },
                     ]
                     : renderEnvironments.map((environment, index) => {
-                        var _a;
                         if (result.payload.result[index].error) {
                             throw new Error(`There was a problem in taking screenshot for environment ${JSON.stringify(environment)}. The provided error message was "${result.payload.result[index].error.message}" and had a stack trace of "${result.payload.result[index].error.stack}"`);
                         }
                         return {
                             image: result.payload.result[index].result.screenshotUrl,
-                            calculateRegions: (_a = result.payload.result[index].result) === null || _a === void 0 ? void 0 : _a.selectorRegions,
+                            calculateRegions: result.payload.result[index].result.selectorRegions,
+                            dom: result.payload.result[index].result.dom,
                             environment,
                         };
                     });
             }
             else {
                 screenshots = localEnvironment
-                    ? [{ image: result.payload.result.screenshotUrl, environment: localEnvironment }]
+                    ? [
+                        {
+                            image: result.payload.result.screenshotUrl,
+                            environment: localEnvironment,
+                            dom: result.payload.result.dom,
+                        },
+                    ]
                     : renderEnvironments.map((environment, index) => {
-                        return { image: result.payload[index].result.screenshotUrl, environment };
+                        return {
+                            image: result.payload[index].result.screenshotUrl,
+                            dom: result.payload[index].result.dom,
+                            environment,
+                        };
                     });
             }
             logger.log('Request "takeScreenshots" finished successfully with body', screenshots);

package/dist/types.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/nml-client",
-  "version": "1.8.27",
+  "version": "1.9.0",
   "description": "Client to integrate the SDKs to the Native Mobile Library (NML)",
   "homepage": "https://applitools.com",
   "bugs": {

package/types/types.d.ts

@@ -1,4 +1,5 @@
 import type { Size, Location, Region } from '@applitools/utils';
+import { TestError } from '@applitools/core-base';
 import { type Logger } from '@applitools/logger';
 import { type Proxy } from '@applitools/req';
 export interface NMLClient {
@@ -74,13 +75,18 @@ export type ScreenshotSettings = {
     };
     selectorsToFindRegionsFor?: Selector[];
     name?: string;
+    sendDom?: boolean;
 };
+export declare class DomResult {
+    url?: string;
+    error?: TestError;
+}
 export type Screenshot = {
     image: string;
     size?: Size;
     name?: string;
     source?: string;
-    dom?: string;
+    dom?: DomResult;
     locationInViewport?: Location;
     locationInView?: Location;
     fullViewSize?: Size;