@lambdatest/smartui-cli 3.0.12 → 4.0.0

package/dist/index.cjs

@@ -16,6 +16,7 @@ var axios = require('axios');
 var child_process = require('child_process');
 var spawn = require('cross-spawn');
 var test = require('@playwright/test');
+var sharp = require('sharp');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
@@ -29,6 +30,7 @@ var addErrors__default = /*#__PURE__*/_interopDefault(addErrors);
 var FormData__default = /*#__PURE__*/_interopDefault(FormData);
 var axios__default = /*#__PURE__*/_interopDefault(axios);
 var spawn__default = /*#__PURE__*/_interopDefault(spawn);
+var sharp__default = /*#__PURE__*/_interopDefault(sharp);
 
 var __defProp = Object.defineProperty;
 var __getOwnPropSymbols = Object.getOwnPropertySymbols;
@@ -128,6 +130,18 @@ var constants_default = {
   MOBILE_ORIENTATION_LANDSCAPE: "landscape",
   // CI
   GITHUB_API_HOST: "https://api.github.com",
+  // log file path
+  LOG_FILE_PATH: ".smartui.log",
+  // Disallowed file extension
+  FILE_EXTENSION_ZIP: ".zip",
+  FILE_EXTENSION_GIFS: "gif",
+  // Magic Numbers 
+  MAGIC_NUMBERS: [
+    { ext: "jpg", magic: Buffer.from([255, 216, 255]) },
+    { ext: "jpeg", magic: Buffer.from([255, 216, 255]) },
+    { ext: "png", magic: Buffer.from([137, 80, 78, 71, 13, 10, 26, 10]) },
+    { ext: "gif", magic: Buffer.from([71, 73, 70, 56]) }
+  ],
   SUPPORTED_MOBILE_DEVICES: {
     "Blackberry KEY2 LE": { os: "android", viewport: { width: 412, height: 618 } },
     "Galaxy A12": { os: "android", viewport: { width: 360, height: 800 } },
@@ -632,7 +646,15 @@ var validateFigmaDesignConfig = ajv.compile(FigmaDesignConfigSchema);
 
 // src/lib/server.ts
 var server_default = (ctx) => __async(void 0, null, function* () {
-  const server = fastify__default.default({ logger: ctx.env.LT_SDK_DEBUG ? true : false, bodyLimit: 3e7 });
+  const server = fastify__default.default({
+    logger: {
+      level: "debug",
+      stream: { write: (message) => {
+        ctx.log.debug(message);
+      } }
+    },
+    bodyLimit: 3e7
+  });
   const opts = {};
   const SMARTUI_DOM = fs5.readFileSync(path2__default.default.resolve(__dirname, "dom-serializer.js"), "utf-8");
   server.get("/healthcheck", opts, (_, reply) => {
@@ -672,7 +694,6 @@ var env_default = () => {
   const {
     PROJECT_TOKEN = "",
     SMARTUI_CLIENT_API_URL = "https://api.lambdatest.com/visualui/1.0",
-    LT_SDK_LOG_LEVEL,
     LT_SDK_DEBUG,
     SMARTUI_GIT_INFO_FILEPATH,
     HTTP_PROXY,
@@ -687,7 +708,6 @@ var env_default = () => {
   return {
     PROJECT_TOKEN,
     SMARTUI_CLIENT_API_URL,
-    LT_SDK_LOG_LEVEL,
     LT_SDK_DEBUG,
     SMARTUI_GIT_INFO_FILEPATH,
     HTTP_PROXY,
@@ -700,37 +720,37 @@ var env_default = () => {
     CURRENT_BRANCH
   };
 };
-var logContext = { task: "smartui-cli" };
+var logContext = {};
 function updateLogContext(newContext) {
   logContext = __spreadValues(__spreadValues({}, logContext), newContext);
 }
 var logLevel = () => {
   let env = env_default();
-  let debug = env.LT_SDK_DEBUG === "true" ? "debug" : void 0;
-  return debug || env.LT_SDK_LOG_LEVEL || "info";
+  return env.LT_SDK_DEBUG === "true" ? "debug" : "info";
 };
 var logger = winston.createLogger({
-  level: logLevel(),
   format: winston.format.combine(
     winston.format.timestamp(),
     winston.format.printf((info) => {
       let contextString = Object.values(logContext).join(" | ");
-      let message = typeof info.message === "object" ? JSON.stringify(info.message) : info.message;
+      let message = typeof info.message === "object" ? JSON.stringify(info.message).trim() : info.message.trim();
       switch (info.level) {
-        case "debug":
-          message = chalk7__default.default.blue(message);
-          break;
         case "warn":
           message = chalk7__default.default.yellow(message);
           break;
-        case "error":
-          message = chalk7__default.default.red(message);
-          break;
       }
       return info.level === "info" ? message : `[${contextString}:${info.level}] ` + message;
     })
   ),
-  transports: [new winston.transports.Console(), new winston.transports.File({ filename: ".smartui.log" })]
+  transports: [
+    new winston.transports.Console({
+      level: logLevel()
+    }),
+    new winston.transports.File({
+      level: "debug",
+      filename: constants_default.LOG_FILE_PATH
+    })
+  ]
 });
 var logger_default = logger;
 
@@ -774,7 +794,7 @@ var auth_default = (ctx) => {
 };
 
 // package.json
-var version = "3.0.12";
+var version = "4.0.0";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -814,6 +834,7 @@ var package_default = {
     fastify: "^4.24.3",
     "form-data": "^4.0.0",
     listr2: "^7.0.1",
+    sharp: "^0.33.4",
     tsup: "^7.2.0",
     which: "^4.0.0",
     winston: "^3.10.0"
@@ -829,11 +850,11 @@ var httpClient = class {
       headers: { "projectToken": PROJECT_TOKEN }
     });
   }
-  request(config, log) {
+  request(config, log2) {
     return __async(this, null, function* () {
-      log.debug(`http request: ${config.method} ${config.url}`);
+      log2.debug(`http request: ${config.method} ${config.url}`);
       return this.axiosInstance.request(config).then((resp) => {
-        log.debug(`http response: ${JSON.stringify({
+        log2.debug(`http response: ${JSON.stringify({
           status: resp.status,
           headers: resp.headers,
           body: resp.data
@@ -842,7 +863,7 @@ var httpClient = class {
       }).catch((error) => {
         var _a;
         if (error.response) {
-          log.debug(`http response: ${JSON.stringify({
+          log2.debug(`http response: ${JSON.stringify({
             status: error.response.status,
             headers: error.response.headers,
             body: error.response.data
@@ -850,21 +871,21 @@ var httpClient = class {
           throw new Error(((_a = error.response.data.error) == null ? void 0 : _a.message) || error.response.data.message);
         }
         if (error.request) {
-          log.debug(`http request failed: ${error.toJSON()}`);
+          log2.debug(`http request failed: ${error.toJSON()}`);
           throw new Error(error.toJSON().message);
         }
-        log.debug(`http request failed: ${error.message}`);
+        log2.debug(`http request failed: ${error.message}`);
         throw new Error(error.message);
       });
     });
   }
-  auth(log) {
+  auth(log2) {
     return this.request({
       url: "/token/verify",
       method: "GET"
-    }, log);
+    }, log2);
   }
-  createBuild(git, config, log) {
+  createBuild(git, config, log2) {
     return this.request({
       url: "/build",
       method: "POST",
@@ -872,9 +893,9 @@ var httpClient = class {
         git,
         config
       }
-    }, log);
+    }, log2);
   }
-  finalizeBuild(buildId, totalSnapshots, log) {
+  finalizeBuild(buildId, totalSnapshots, log2) {
     let params = { buildId };
     if (totalSnapshots > -1)
       params.totalSnapshots = totalSnapshots;
@@ -882,7 +903,7 @@ var httpClient = class {
       url: "/build",
       method: "DELETE",
       params
-    }, log);
+    }, log2);
   }
   uploadSnapshot(ctx, snapshot) {
     return this.request({
@@ -898,7 +919,7 @@ var httpClient = class {
       }
     }, ctx.log);
   }
-  uploadScreenshot({ id: buildId, name: buildName, baseline }, ssPath, ssName, browserName, viewport, log) {
+  uploadScreenshot({ id: buildId, name: buildName, baseline }, ssPath, ssName, browserName, viewport, log2) {
     browserName = browserName === constants_default.SAFARI ? constants_default.WEBKIT : browserName;
     const file = fs5__default.default.readFileSync(ssPath);
     const form = new FormData__default.default();
@@ -915,7 +936,7 @@ var httpClient = class {
       headers: form.getHeaders(),
       data: form
     }).then(() => {
-      log.debug(`${ssName} for ${browserName} ${viewport} uploaded successfully`);
+      log2.debug(`${ssName} for ${browserName} ${viewport} uploaded successfully`);
     }).catch((error) => {
       if (error.response) {
         throw new Error(error.response.data.error.message);
@@ -926,7 +947,7 @@ var httpClient = class {
       throw new Error(error.message);
     });
   }
-  checkUpdate(log) {
+  checkUpdate(log2) {
     return this.request({
       url: `/packageinfo`,
       method: "GET",
@@ -935,9 +956,9 @@ var httpClient = class {
         packageName: package_default.name,
         packageVersion: package_default.version
       }
-    }, log);
+    }, log2);
   }
-  getFigmaFilesAndImages(figmaFileToken, figmaToken, queryParams, authToken, depth, markBaseline, buildName, log) {
+  getFigmaFilesAndImages(figmaFileToken, figmaToken, queryParams, authToken, depth, markBaseline, buildName, log2) {
     const requestBody = {
       figma_file_token: figmaFileToken,
       figma_token: figmaToken,
@@ -954,7 +975,34 @@ var httpClient = class {
         "Content-Type": "application/json"
       },
       data: JSON.stringify(requestBody)
-    }, log);
+    }, log2);
+  }
+  getS3PreSignedURL(ctx) {
+    return this.request({
+      url: `/loguploadurl`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: {
+        buildId: ctx.build.id
+      }
+    }, ctx.log);
+  }
+  uploadLogs(ctx, uploadURL) {
+    const fileStream = fs5__default.default.createReadStream(constants_default.LOG_FILE_PATH);
+    const { size } = fs5__default.default.statSync(constants_default.LOG_FILE_PATH);
+    return this.request({
+      url: uploadURL,
+      method: "PUT",
+      headers: {
+        "Content-Type": "text/plain",
+        "Content-Length": size
+      },
+      data: fileStream,
+      maxBodyLength: Infinity,
+      // prevent axios from limiting the body size
+      maxContentLength: Infinity
+      // prevent axios from limiting the content size
+    }, ctx.log);
   }
 };
 var ctx_default = (options) => {
@@ -964,6 +1012,10 @@ var ctx_default = (options) => {
   let mobileConfig;
   let config = constants_default.DEFAULT_CONFIG;
   let port;
+  let resolutionOff;
+  let extensionFiles;
+  let ignoreStripExtension;
+  let ignoreFilePattern;
   try {
     if (options.config) {
       config = JSON.parse(fs5__default.default.readFileSync(options.config, "utf-8"));
@@ -979,6 +1031,10 @@ var ctx_default = (options) => {
     if (isNaN(port) || port < 1 || port > 65535) {
       throw new Error("Invalid port number. Port number must be an integer between 1 and 65535.");
     }
+    resolutionOff = options.ignoreResolutions || false;
+    extensionFiles = options.files || ["png", "jpeg", "jpg"];
+    ignoreStripExtension = options.removeExtensions || false;
+    ignoreFilePattern = options.ignoreDir || [];
   } catch (error) {
     console.log(`[smartui] Error: ${error.message}`);
     process.exit();
@@ -1007,6 +1063,7 @@ var ctx_default = (options) => {
       enableJavaScript: config.enableJavaScript || false,
       allowedHostnames: config.allowedHostnames || []
     },
+    uploadFilePath: "",
     webStaticConfig: [],
     git: {
       branch: "",
@@ -1026,16 +1083,20 @@ var ctx_default = (options) => {
       parallel: options.parallel ? true : false,
       markBaseline: options.markBaseline ? true : false,
       buildName: options.buildName || "",
-      port
+      port,
+      ignoreResolutions: resolutionOff,
+      fileExtension: extensionFiles,
+      stripExtension: ignoreStripExtension,
+      ignorePattern: ignoreFilePattern
     },
     cliVersion: version,
     totalSnapshots: -1
   };
 };
-function executeCommand(command4) {
+function executeCommand(command5) {
   let dst = process.cwd();
   try {
-    return child_process.execSync(command4, {
+    return child_process.execSync(command5, {
       cwd: dst,
       stdio: ["ignore"],
       encoding: "utf-8"
@@ -1066,8 +1127,8 @@ var git_default = (ctx) => {
   } else {
     const splitCharacter = "<##>";
     const prettyFormat = ["%h", "%H", "%s", "%f", "%b", "%at", "%ct", "%an", "%ae", "%cn", "%ce", "%N", ""];
-    const command4 = 'git log -1 --pretty=format:"' + prettyFormat.join(splitCharacter) + '" && git rev-parse --abbrev-ref HEAD && git tag --contains HEAD';
-    let res = executeCommand(command4).split(splitCharacter);
+    const command5 = 'git log -1 --pretty=format:"' + prettyFormat.join(splitCharacter) + '" && git rev-parse --abbrev-ref HEAD && git tag --contains HEAD';
+    let res = executeCommand(command5).split(splitCharacter);
     var branchAndTags = res[res.length - 1].split("\n").filter((n) => n);
     var branch = ctx.env.CURRENT_BRANCH || branchAndTags[0];
     branchAndTags.slice(1);
@@ -1208,9 +1269,9 @@ var finalizeBuild_default = (ctx) => {
   return {
     title: `Finalizing build`,
     task: (ctx2, task) => __async(void 0, null, function* () {
+      var _a, _b;
       updateLogContext({ task: "finalizeBuild" });
       try {
-        yield new Promise((resolve) => setTimeout(resolve, 2e3));
         yield ctx2.client.finalizeBuild(ctx2.build.id, ctx2.totalSnapshots, ctx2.log);
         task.output = chalk7__default.default.gray(`build url: ${ctx2.build.url}`);
         task.title = "Finalized build";
@@ -1219,6 +1280,17 @@ var finalizeBuild_default = (ctx) => {
         task.output = chalk7__default.default.gray(error.message);
         throw new Error("Finalize build failed");
       }
+      try {
+        yield (_a = ctx2.browser) == null ? void 0 : _a.close();
+        ctx2.log.debug(`Closed browser`);
+        yield (_b = ctx2.server) == null ? void 0 : _b.close();
+        ctx2.log.debug(`Closed server`);
+        let resp = yield ctx2.client.getS3PreSignedURL(ctx2);
+        yield ctx2.client.uploadLogs(ctx2, resp.data.url);
+        fs5.unlinkSync(constants_default.LOG_FILE_PATH);
+      } catch (error) {
+        ctx2.log.debug(error);
+      }
     }),
     rendererOptions: { persistentOutput: true }
   };
@@ -1403,6 +1475,7 @@ var Queue = class {
 function processSnapshot(snapshot, ctx) {
   return __async(this, null, function* () {
     var _a;
+    updateLogContext({ task: "discovery" });
     ctx.log.debug(`Processing snapshot ${snapshot.name}`);
     let launchOptions = { headless: true };
     let contextOptions = {
@@ -1412,8 +1485,8 @@ function processSnapshot(snapshot, ctx) {
     if (!((_a = ctx.browser) == null ? void 0 : _a.isConnected())) {
       if (ctx.env.HTTP_PROXY || ctx.env.HTTPS_PROXY)
         launchOptions.proxy = { server: ctx.env.HTTP_PROXY || ctx.env.HTTPS_PROXY };
-      ctx.browser = yield test.chromium.launch(launchOptions);
-      ctx.log.debug(`Chromium launched with options ${JSON.stringify(launchOptions)}`);
+      ctx.browser = yield test.firefox.launch(launchOptions);
+      ctx.log.debug(`Firefox launched with options ${JSON.stringify(launchOptions)}`);
     }
     const context = yield ctx.browser.newContext(contextOptions);
     ctx.log.debug(`Browser context created with options ${JSON.stringify(contextOptions)}`);
@@ -1606,10 +1679,9 @@ function processSnapshot(snapshot, ctx) {
 
 // src/commander/exec.ts
 var command = new commander.Command();
-command.name("exec").description("Run test commands around SmartUI").argument("<command...>", "Command supplied for running tests").option("-P, --port <number>", "Port number for the server").action(function(execCommand, _, command4) {
+command.name("exec").description("Run test commands around SmartUI").argument("<command...>", "Command supplied for running tests").option("-P, --port <number>", "Port number for the server").action(function(execCommand, _, command5) {
   return __async(this, null, function* () {
-    var _a, _b;
-    let ctx = ctx_default(command4.optsWithGlobals());
+    let ctx = ctx_default(command5.optsWithGlobals());
     if (!which__default.default.sync(execCommand[0], { nothrow: true })) {
       ctx.log.error(`Error: Command not found "${execCommand[0]}"`);
       return;
@@ -1642,11 +1714,6 @@ command.name("exec").description("Run test commands around SmartUI").argument("<
       yield tasks.run(ctx);
     } catch (error) {
       ctx.log.info("\nRefer docs: https://www.lambdatest.com/support/docs/smart-visual-regression-testing/");
-    } finally {
-      yield (_a = ctx.browser) == null ? void 0 : _a.close();
-      ctx.log.debug(`Closed browser`);
-      yield (_b = ctx.server) == null ? void 0 : _b.close();
-      ctx.log.debug(`Closed server`);
     }
   });
 });
@@ -1832,6 +1899,108 @@ function captureScreenshots(ctx) {
     return { capturedScreenshots, output };
   });
 }
+function getImageDimensions(filePath) {
+  const buffer = fs5__default.default.readFileSync(filePath);
+  let width, height;
+  if (buffer.toString("hex", 0, 2) === "ffd8") {
+    let offset = 2;
+    while (offset < buffer.length) {
+      const marker = buffer.toString("hex", offset, offset + 2);
+      offset += 2;
+      const length = buffer.readUInt16BE(offset);
+      if (marker === "ffc0" || marker === "ffc2") {
+        height = buffer.readUInt16BE(offset + 3);
+        width = buffer.readUInt16BE(offset + 5);
+        return { width, height };
+      }
+      offset += length;
+    }
+  } else if (buffer.toString("hex", 1, 4) === "504e47") {
+    width = buffer.readUInt32BE(16);
+    height = buffer.readUInt32BE(20);
+    return { width, height };
+  }
+  return null;
+}
+function isAllowedImage(filePath) {
+  return __async(this, null, function* () {
+    try {
+      const fileBuffer = fs5__default.default.readFileSync(filePath);
+      const isMagicValid = constants_default.MAGIC_NUMBERS.some((magic) => fileBuffer.slice(0, magic.magic.length).equals(magic.magic));
+      const metadata = yield sharp__default.default(filePath).metadata();
+      if (metadata.format === constants_default.FILE_EXTENSION_GIFS) {
+        return false;
+      }
+      if (metadata.width > 0 && metadata.height > 0) {
+        return true;
+      }
+      if (isMagicValid && metadata.format !== constants_default.FILE_EXTENSION_GIFS) {
+        return true;
+      }
+      return false;
+    } catch (error) {
+      return false;
+    }
+  });
+}
+function uploadScreenshots(ctx) {
+  return __async(this, null, function* () {
+    const allowedExtensions = ctx.options.fileExtension.map((ext) => `.${ext.trim().toLowerCase()}`);
+    let noOfScreenshots = 0;
+    function processDirectory(directory, relativePath = "") {
+      return __async(this, null, function* () {
+        const files = fs5__default.default.readdirSync(directory);
+        for (let file of files) {
+          const filePath = path2__default.default.join(directory, file);
+          const stat = fs5__default.default.statSync(filePath);
+          const relativeFilePath = path2__default.default.join(relativePath, file);
+          if (stat.isDirectory() && ctx.options.ignorePattern.includes(relativeFilePath)) {
+            ctx.log.info(`Ignoring Directory ${relativeFilePath}`);
+            continue;
+          }
+          if (stat.isDirectory()) {
+            yield processDirectory(filePath, relativeFilePath);
+          } else {
+            let fileExtension = path2__default.default.extname(file).toLowerCase();
+            if (allowedExtensions.includes(fileExtension)) {
+              const isValid = yield isAllowedImage(filePath);
+              if (!isValid) {
+                ctx.log.info(`File ${filePath} is not a valid ${fileExtension} image or is corrupted. Skipping.`);
+                continue;
+              }
+              let ssId = relativeFilePath;
+              if (ctx.options.stripExtension) {
+                ssId = path2__default.default.join(relativePath, path2__default.default.basename(file, fileExtension));
+              }
+              let viewport = "default";
+              if (!ctx.options.ignoreResolutions) {
+                const dimensions = getImageDimensions(filePath);
+                if (!dimensions) {
+                  ctx.log.info(`Unable to determine dimensions for image: ${filePath}`);
+                } else {
+                  const width = dimensions.width;
+                  const height = dimensions.height;
+                  viewport = `${width}x${height}`;
+                }
+              }
+              yield ctx.client.uploadScreenshot(ctx.build, filePath, ssId, "default", viewport, ctx.log);
+              ctx.log.info(`${filePath} : uploaded successfully`);
+              noOfScreenshots++;
+            } else {
+              ctx.log.info(`File ${filePath} has invalid file extension: ${fileExtension}. Skipping`);
+            }
+          }
+        }
+      });
+    }
+    yield processDirectory(ctx.uploadFilePath);
+    if (noOfScreenshots == 0) {
+      ctx.log.info(`No screenshots uploaded.`);
+    } else {
+      ctx.log.info(`${noOfScreenshots} screenshots uploaded successfully.`);
+    }
+  });
+}
 var captureScreenshots_default = (ctx) => {
   return {
     title: "Capturing screenshots",
@@ -1857,9 +2026,9 @@ var captureScreenshots_default = (ctx) => {
 
 // src/commander/capture.ts
 var command2 = new commander.Command();
-command2.name("capture").description("Capture screenshots of static sites").argument("<file>", "Web static config file").option("--parallel", "Capture parallely on all browsers").action(function(file, _, command4) {
+command2.name("capture").description("Capture screenshots of static sites").argument("<file>", "Web static config file").option("--parallel", "Capture parallely on all browsers").action(function(file, _, command5) {
   return __async(this, null, function* () {
-    let ctx = ctx_default(command4.optsWithGlobals());
+    let ctx = ctx_default(command5.optsWithGlobals());
     if (!fs5__default.default.existsSync(file)) {
       console.log(`Error: Web Static Config file ${file} not found.`);
       return;
@@ -1899,6 +2068,71 @@ command2.name("capture").description("Capture screenshots of static sites").argu
   });
 });
 var capture_default = command2;
+var uploadScreenshots_default = (ctx) => {
+  return {
+    title: "Uploading screenshots",
+    task: (ctx2, task) => __async(void 0, null, function* () {
+      try {
+        ctx2.task = task;
+        updateLogContext({ task: "upload" });
+        yield uploadScreenshots(ctx2);
+        task.title = "Screenshots uploaded successfully";
+      } catch (error) {
+        ctx2.log.debug(error);
+        task.output = chalk7__default.default.gray(`${error.message}`);
+        throw new Error("Uploading screenshots failed");
+      }
+    }),
+    rendererOptions: { persistentOutput: true },
+    exitOnError: false
+  };
+};
+
+// src/commander/upload.ts
+var command3 = new commander.Command();
+command3.name("upload").description("Upload screenshots from given directory").argument("<directory>", "Path of the directory").option("-R, --ignoreResolutions", "Ignore resolution").option("-F, --files <extensions>", "Comma-separated list of allowed file extensions", (val) => {
+  return val.split(",").map((ext) => ext.trim().toLowerCase());
+}).option("-E, --removeExtensions", "Strips file extensions from snapshot names").option("-i, --ignoreDir <patterns>", "Comma-separated list of directories to ignore", (val) => {
+  return val.split(",").map((pattern) => pattern.trim());
+}).action(function(directory, _, command5) {
+  return __async(this, null, function* () {
+    let ctx = ctx_default(command5.optsWithGlobals());
+    if (!fs5__default.default.existsSync(directory)) {
+      console.log(`Error: The provided directory ${directory} not found.`);
+      return;
+    }
+    if (path2__default.default.extname(directory).toLowerCase() === constants_default.FILE_EXTENSION_ZIP) {
+      ctx.log.debug(`Error: The provided directory ${directory} is a zip file. Zips are not accepted.`);
+      return;
+    }
+    ctx.uploadFilePath = directory;
+    let tasks = new listr2.Listr(
+      [
+        auth_default(),
+        getGitInfo_default(),
+        createBuild_default(),
+        uploadScreenshots_default(),
+        finalizeBuild_default()
+      ],
+      {
+        rendererOptions: {
+          icon: {
+            [listr2.ListrDefaultRendererLogLevels.OUTPUT]: `\u2192`
+          },
+          color: {
+            [listr2.ListrDefaultRendererLogLevels.OUTPUT]: listr2.color.gray
+          }
+        }
+      }
+    );
+    try {
+      yield tasks.run(ctx);
+    } catch (error) {
+      console.log("\nRefer docs: https://www.lambdatest.com/support/docs/smart-visual-regression-testing/");
+    }
+  });
+});
+var upload_default = command3;
 
 // src/lib/uploadFigmaDesigns.ts
 var uploadFigmaDesigns_default = (ctx) => __async(void 0, null, function* () {
@@ -1950,11 +2184,11 @@ var uploadFigmaDesigns_default2 = (ctx) => {
 };
 
 // src/commander/uploadFigma.ts
-var command3 = new commander.Command();
-command3.name("upload-figma").description("Capture screenshots of static sites").argument("<file>", "figma design config file").option("--markBaseline", "Mark the uploaded images as baseline").option("--buildName <buildName>", "Name of the build").action(function(file, _, command4) {
+var command4 = new commander.Command();
+command4.name("upload-figma").description("Capture screenshots of static sites").argument("<file>", "figma design config file").option("--markBaseline", "Mark the uploaded images as baseline").option("--buildName <buildName>", "Name of the build").action(function(file, _, command5) {
   return __async(this, null, function* () {
     var _a, _b;
-    let ctx = ctx_default(command4.optsWithGlobals());
+    let ctx = ctx_default(command5.optsWithGlobals());
     if (!fs5__default.default.existsSync(file)) {
       console.log(`Error: Figma Config file ${file} not found.`);
       return;
@@ -1992,31 +2226,34 @@ command3.name("upload-figma").description("Capture screenshots of static sites")
     }
   });
 });
-var uploadFigma_default = command3;
+var uploadFigma_default = command4;
 
 // src/commander/commander.ts
 var program = new commander.Command();
-program.name("smartui").description("CLI to help you run your SmartUI tests on LambdaTest platform").version(`v${version}`).option("-c --config <filepath>", "Config file path").addCommand(exec_default2).addCommand(capture_default).addCommand(configWeb).addCommand(configStatic).addCommand(configFigma).addCommand(uploadFigma_default);
+program.name("smartui").description("CLI to help you run your SmartUI tests on LambdaTest platform").version(`v${version}`).option("-c --config <filepath>", "Config file path").addCommand(exec_default2).addCommand(capture_default).addCommand(configWeb).addCommand(configStatic).addCommand(upload_default).addCommand(configFigma).addCommand(uploadFigma_default);
 var commander_default = program;
 (function() {
   return __async(this, null, function* () {
     let client = new httpClient(env_default());
-    let log = logger_default;
+    let log2 = logger_default;
     try {
-      log.info(`
+      let { data: { latestVersion, deprecated, additionalDescription, additionalDescriptionLatestVersion } } = yield client.checkUpdate(log2);
+      log2.info(`
 LambdaTest SmartUI CLI v${package_default.version}`);
-      let { data: { latestVersion, deprecated } } = yield client.checkUpdate(log);
-      if (deprecated)
-        log.warn(`This version is deprecated. A new version ${latestVersion} is available!
+      log2.info(chalk7__default.default.yellow(`${additionalDescription}`));
+      if (deprecated) {
+        log2.warn(`This version is deprecated. A new version ${latestVersion} is available!`);
+        log2.warn(`${additionalDescriptionLatestVersion}
 `);
-      else if (package_default.version !== latestVersion)
-        log.info(chalk7__default.default.gray(`A new version ${latestVersion} is available!
+      } else if (package_default.version !== latestVersion) {
+        log2.info(chalk7__default.default.green(`A new version ${latestVersion} is available!`));
+        log2.info(chalk7__default.default.red(`${additionalDescriptionLatestVersion}
 `));
-      else
-        log.info(chalk7__default.default.gray("https://www.npmjs.com/package/@lambdatest/smartui-cli\n"));
+      } else
+        log2.info(chalk7__default.default.gray("https://www.npmjs.com/package/@lambdatest/smartui-cli\n"));
     } catch (error) {
-      log.debug(error);
-      log.info(chalk7__default.default.gray("https://www.npmjs.com/package/@lambdatest/smartui-cli\n"));
+      log2.debug(error);
+      log2.info(chalk7__default.default.gray("https://www.npmjs.com/package/@lambdatest/smartui-cli\n"));
     }
     commander_default.parse();
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lambdatest/smartui-cli",
-  "version": "3.0.12",
+  "version": "4.0.0",
   "description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",
   "files": [
     "dist/**/*"
@@ -33,6 +33,7 @@
     "fastify": "^4.24.3",
     "form-data": "^4.0.0",
     "listr2": "^7.0.1",
+    "sharp": "^0.33.4",
     "tsup": "^7.2.0",
     "which": "^4.0.0",
     "winston": "^3.10.0"