@lambdatest/smartui-cli 4.1.29 → 4.1.31

package/dist/index.cjs

@@ -779,6 +779,14 @@ var ConfigSchema = {
     useLambdaInternal: {
       type: "boolean",
       errorMessage: "Invalid config; useLambdaInternal must be true/false"
+    },
+    useExtendedViewport: {
+      type: "boolean",
+      errorMessage: "Invalid config; useExtendedViewport must be true/false"
+    },
+    loadDomContent: {
+      type: "boolean",
+      errorMessage: "Invalid config; loadDomContent must be true/false"
     }
   },
   anyOf: [
@@ -904,6 +912,12 @@ var SnapshotSchema = {
               items: { type: "string", minLength: 1 },
               uniqueItems: true,
               errorMessage: "Invalid snapshot options; ignoreDOM xpath array must have unique and non-empty items"
+            },
+            coordinates: {
+              type: "array",
+              items: { type: "string", minLength: 1 },
+              uniqueItems: true,
+              errorMessage: "Invalid snapshot options; ignoreDOM coordinates array must have unique and non-empty items"
             }
           }
         },
@@ -933,6 +947,12 @@ var SnapshotSchema = {
               items: { type: "string", minLength: 1 },
               uniqueItems: true,
               errorMessage: "Invalid snapshot options; selectDOM xpath array must have unique and non-empty items"
+            },
+            coordinates: {
+              type: "array",
+              items: { type: "string", minLength: 1 },
+              uniqueItems: true,
+              errorMessage: "Invalid snapshot options; selectDOM coordinates array must have unique and non-empty items"
             }
           }
         },
@@ -1024,6 +1044,10 @@ var SnapshotSchema = {
         timeout: {
           type: "number",
           errorMessage: "Invalid snapshot options; timeout must be a number"
+        },
+        useExtendedViewport: {
+          type: "boolean",
+          errorMessage: "Invalid snapshot options; useExtendedViewport must be a boolean"
         }
       },
       additionalProperties: false
@@ -1840,6 +1864,56 @@ function getPageNumber(screenshotName) {
   const parts = screenshotName.split("#");
   return parts.length > 1 ? parts[1] : "1";
 }
+function validateCoordinates(coordString, pageHeight, pageWidth, snapshotName) {
+  const coords = coordString.split(",").map(Number);
+  if (coords.length !== 4) {
+    return {
+      valid: false,
+      error: `for snapshot ${snapshotName}, invalid coordinates format: ${coordString}. Expected: top,bottom,left,right`
+    };
+  }
+  const [top, bottom, left, right] = coords;
+  if (coords.some(isNaN)) {
+    return {
+      valid: false,
+      error: `for snapshot ${snapshotName}, invalid coordinate values: ${coordString}. All values must be numbers`
+    };
+  }
+  if (top < 0 || left < 0 || bottom < 0 || right < 0) {
+    return {
+      valid: false,
+      error: `for snapshot ${snapshotName}, invalid coordinate bounds: ${coordString}. top,left,bottom,right must be >= 0`
+    };
+  }
+  if (top >= bottom) {
+    return {
+      valid: false,
+      error: `for snapshot ${snapshotName}, invalid coordinate bounds: ${coordString}. top must be < bottom`
+    };
+  }
+  if (left >= right) {
+    return {
+      valid: false,
+      error: `for snapshot ${snapshotName}, invalid coordinate bounds: ${coordString}. left must be < right`
+    };
+  }
+  if (bottom > pageHeight) {
+    return {
+      valid: false,
+      error: `for snapshot ${snapshotName}, coordinates exceed viewport bounds: ${coordString}. bottom (${bottom}) exceeds viewport height (${pageHeight})`
+    };
+  }
+  if (right > pageWidth) {
+    return {
+      valid: false,
+      error: `for snapshot ${snapshotName}, coordinates exceed viewport bounds: ${coordString}. right (${right}) exceeds viewport width (${pageWidth})`
+    };
+  }
+  return {
+    valid: true,
+    coords: { top, bottom, left, right }
+  };
+}
 
 // src/lib/server.ts
 var uploadDomToS3ViaEnv = process.env.USE_LAMBDA_INTERNAL || false;
@@ -2221,7 +2295,7 @@ var authExec_default = (ctx) => {
 };
 
 // package.json
-var version = "4.1.29";
+var version = "4.1.31";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -2949,6 +3023,8 @@ var ctx_default = (options) => {
   let buildNameObj;
   let allowDuplicateSnapshotNames = false;
   let useLambdaInternal = false;
+  let useExtendedViewport = false;
+  let loadDomContent = false;
   try {
     if (options.config) {
       config = JSON.parse(fs5__default.default.readFileSync(options.config, "utf-8"));
@@ -3016,6 +3092,12 @@ var ctx_default = (options) => {
   if (config.useLambdaInternal) {
     useLambdaInternal = true;
   }
+  if (config.useExtendedViewport) {
+    useExtendedViewport = true;
+  }
+  if (config.loadDomContent) {
+    loadDomContent = true;
+  }
   if (config.waitForPageRender && config.waitForPageRender < 3e4) {
     config.waitForPageRender = 3e4;
   }
@@ -3044,7 +3126,9 @@ var ctx_default = (options) => {
       userAgent: config.userAgent || "",
       requestHeaders: config.requestHeaders || {},
       allowDuplicateSnapshotNames,
-      useLambdaInternal
+      useLambdaInternal,
+      useExtendedViewport,
+      loadDomContent
     },
     uploadFilePath: "",
     webStaticConfig: [],
@@ -3510,6 +3594,9 @@ function prepareSnapshot(snapshot, ctx) {
       if (options.loadDomContent) {
         processedOptions.loadDomContent = true;
       }
+      if (options.useExtendedViewport) {
+        processedOptions.useExtendedViewport = true;
+      }
       if (options.sessionId) {
         const sessionId = options.sessionId;
         processedOptions.sessionId = sessionId;
@@ -3578,6 +3665,9 @@ function prepareSnapshot(snapshot, ctx) {
             case "cssSelector":
               selectors.push(...value);
               break;
+            case "coordinates":
+              selectors.push(...value.map((e) => `coordinates=${e}`));
+              break;
           }
         }
       }
@@ -3592,6 +3682,12 @@ function prepareSnapshot(snapshot, ctx) {
         ctx.log.debug(`Tunnel address added to processedOptions: ${tunnelAddress}`);
       }
     }
+    if (ctx.config.loadDomContent) {
+      processedOptions.loadDomContent = true;
+    }
+    if (ctx.config.useExtendedViewport) {
+      processedOptions.useExtendedViewport = true;
+    }
     processedOptions.allowedAssets = ctx.config.allowedAssets;
     processedOptions.selectors = selectors;
     processedOptions.ignoreDOM = options == null ? void 0 : options.ignoreDOM;
@@ -3920,6 +4016,9 @@ function processSnapshot(snapshot, ctx) {
             case "cssSelector":
               selectors.push(...value);
               break;
+            case "coordinates":
+              selectors.push(...value.map((e) => `coordinates=${e}`));
+              break;
           }
         }
       }
@@ -3934,6 +4033,12 @@ function processSnapshot(snapshot, ctx) {
         ctx.log.debug(`Tunnel address added to processedOptions: ${tunnelAddress}`);
       }
     }
+    if (ctx.config.loadDomContent) {
+      processedOptions.loadDomContent = true;
+    }
+    if (ctx.config.useExtendedViewport) {
+      processedOptions.useExtendedViewport = true;
+    }
     let navigated = false;
     let previousDeviceType = null;
     let renderViewports;
@@ -4057,6 +4162,31 @@ function processSnapshot(snapshot, ctx) {
         if (!Array.isArray(processedOptions[ignoreOrSelectBoxes][viewportString]))
           processedOptions[ignoreOrSelectBoxes][viewportString] = [];
         for (const selector of selectors) {
+          if (selector.startsWith("coordinates=")) {
+            const coordString = selector.replace("coordinates=", "");
+            let pageHeight = height;
+            if (viewport.height) {
+              pageHeight = viewport.height;
+            }
+            const validation = validateCoordinates(
+              coordString,
+              pageHeight,
+              viewport.width,
+              snapshot.name
+            );
+            if (!validation.valid) {
+              optionWarnings.add(validation.error);
+              continue;
+            }
+            if (renderViewports.length > 1) {
+              optionWarnings.add(`for snapshot ${snapshot.name} viewport ${viewportString}, coordinates may not be accurate for multiple viewports`);
+            }
+            const coordinateElement = __spreadValues({
+              type: "coordinates"
+            }, validation.coords);
+            locators.push(coordinateElement);
+            continue;
+          }
           let l = yield page.locator(selector).all();
           if (l.length === 0) {
             optionWarnings.add(`for snapshot ${snapshot.name} viewport ${viewportString}, no element found for selector ${selector}`);
@@ -4065,6 +4195,17 @@ function processSnapshot(snapshot, ctx) {
           locators.push(...l);
         }
         for (const locator of locators) {
+          if (locator && typeof locator === "object" && locator.hasOwnProperty("type") && locator.type === "coordinates") {
+            const coordLocator = locator;
+            const { top, bottom, left, right } = coordLocator;
+            processedOptions[ignoreOrSelectBoxes][viewportString].push({
+              left,
+              top,
+              right,
+              bottom
+            });
+            continue;
+          }
           let bb = yield locator.boundingBox();
           if (bb) {
             const top = bb.y;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lambdatest/smartui-cli",
-  "version": "4.1.29",
+  "version": "4.1.31",
   "description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",
   "files": [
     "dist/**/*"