@lambdatest/smartui-cli 3.0.6 → 3.0.7

package/dist/index.cjs

@@ -299,6 +299,19 @@ var constants_default = {
     "iPhone XR": { os: "ios", viewport: { width: 414, height: 896 } },
     "iPhone XS": { os: "ios", viewport: { width: 375, height: 812 } },
     "iPhone XS Max": { os: "ios", viewport: { width: 414, height: 896 } }
+  },
+  FIGMA_API: "https://api.figma.com/v1/",
+  DEFAULT_FIGMA_CONFIG: {
+    "depth": 2,
+    "figma_config": [
+      {
+        "figma_file_token": "token_for_first_figma_file",
+        "figma_ids": [
+          "id1",
+          "id2"
+        ]
+      }
+    ]
   }
 };
 
@@ -417,7 +430,7 @@ function getRenderViewports(ctx) {
     ...mobileRenderViewports[constants_default.MOBILE_OS_ANDROID]
   ];
 }
-var MAX_RESOURCE_SIZE = 10 * 1024 ** 2;
+var MAX_RESOURCE_SIZE = 15 * 1024 ** 2;
 var ALLOWED_RESOURCES = ["document", "stylesheet", "image", "media", "font", "other"];
 var ALLOWED_STATUSES = [200, 201];
 var REQUEST_TIMEOUT = 1e4;
@@ -463,7 +476,7 @@ var processSnapshot_default = (snapshot, ctx) => __async(void 0, null, function*
  - skipping already cached resource`);
       } else if (body.length > MAX_RESOURCE_SIZE) {
         ctx.log.debug(`Handling request ${requestUrl}
- - skipping resource larger than 5MB`);
+ - skipping resource larger than 15MB`);
       } else if (!ALLOWED_STATUSES.includes(response.status())) {
         ctx.log.debug(`Handling request ${requestUrl}
  - skipping disallowed status [${response.status()}]`);
@@ -877,9 +890,56 @@ var SnapshotSchema = {
   additionalProperties: false,
   errorMessage: "Invalid snapshot"
 };
+var FigmaDesignConfigSchema = {
+  type: "object",
+  properties: {
+    depth: {
+      type: "integer",
+      minimum: 2,
+      errorMessage: "Depth must be an integer and greater than 1"
+    },
+    figma_config: {
+      type: "array",
+      items: {
+        type: "object",
+        properties: {
+          figma_file_token: {
+            type: "string",
+            minLength: 1,
+            errorMessage: "figma_file_token is mandatory and cannot be empty"
+          },
+          figma_ids: {
+            type: "array",
+            items: {
+              type: "string",
+              minLength: 1,
+              errorMessage: "Each ID in figma_ids must be a non-empty string"
+            },
+            minItems: 1,
+            uniqueItems: true,
+            errorMessage: {
+              type: "figma_ids must be an array of strings",
+              minItems: "figma_ids cannot be empty",
+              uniqueItems: "figma_ids must contain unique values"
+            }
+          }
+        },
+        required: ["figma_file_token"],
+        additionalProperties: false
+      },
+      uniqueItems: true,
+      errorMessage: {
+        uniqueItems: "Each entry in the Figma design configuration must be unique"
+      }
+    }
+  },
+  required: ["figma_config"],
+  additionalProperties: false
+};
 var validateConfig = ajv.compile(ConfigSchema);
 var validateWebStaticConfig = ajv.compile(WebStaticConfigSchema);
 var validateSnapshot = ajv.compile(SnapshotSchema);
+var validateFigmaDesignConfig = ajv.compile(FigmaDesignConfigSchema);
 
 // src/lib/server.ts
 var server_default = (ctx) => __async(void 0, null, function* () {
@@ -922,7 +982,10 @@ var env_default = () => {
     SMARTUI_GIT_INFO_FILEPATH,
     HTTP_PROXY,
     HTTPS_PROXY,
-    GITHUB_ACTIONS
+    GITHUB_ACTIONS,
+    FIGMA_TOKEN,
+    LT_USERNAME,
+    LT_ACCESS_KEY
   } = process.env;
   return {
     PROJECT_TOKEN,
@@ -932,7 +995,10 @@ var env_default = () => {
     SMARTUI_GIT_INFO_FILEPATH,
     HTTP_PROXY,
     HTTPS_PROXY,
-    GITHUB_ACTIONS
+    GITHUB_ACTIONS,
+    FIGMA_TOKEN,
+    LT_USERNAME,
+    LT_ACCESS_KEY
   };
 };
 var logContext = { task: "smartui-cli" };
@@ -1009,7 +1075,7 @@ var auth_default = (ctx) => {
 };
 
 // package.json
-var version = "3.0.6";
+var version = "3.0.7";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -1172,6 +1238,25 @@ var httpClient = class {
       }
     }, log);
   }
+  getFigmaFilesAndImages(figmaFileToken, figmaToken, queryParams, authToken, depth, markBaseline, buildName, log) {
+    const requestBody = {
+      figma_file_token: figmaFileToken,
+      figma_token: figmaToken,
+      query_params: queryParams,
+      auth: authToken,
+      depth,
+      mark_base_line: markBaseline,
+      build_name: buildName
+    };
+    return this.request({
+      url: "/uploadfigma",
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json"
+      },
+      data: JSON.stringify(requestBody)
+    }, log);
+  }
 };
 var ctx_default = (options) => {
   var _a, _b;
@@ -1234,16 +1319,18 @@ var ctx_default = (options) => {
     },
     args: {},
     options: {
-      parallel: options.parallel ? true : false
+      parallel: options.parallel ? true : false,
+      markBaseline: options.markBaseline ? true : false,
+      buildName: options.buildName || ""
     },
     cliVersion: version,
     totalSnapshots: -1
   };
 };
-function executeCommand(command3) {
+function executeCommand(command4) {
   let dst = process.cwd();
   try {
-    return child_process.execSync(command3, {
+    return child_process.execSync(command4, {
       cwd: dst,
       stdio: ["ignore"],
       encoding: "utf-8"
@@ -1273,8 +1360,8 @@ var git_default = (ctx) => {
   } else {
     const splitCharacter = "<##>";
     const prettyFormat = ["%h", "%H", "%s", "%f", "%b", "%at", "%ct", "%an", "%ae", "%cn", "%ce", "%N", ""];
-    const command3 = 'git log -1 --pretty=format:"' + prettyFormat.join(splitCharacter) + '" && git rev-parse --abbrev-ref HEAD && git tag --contains HEAD';
-    let res = executeCommand(command3).split(splitCharacter);
+    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);
     var branchAndTags = res[res.length - 1].split("\n").filter((n) => n);
     var branch = branchAndTags[0];
     branchAndTags.slice(1);
@@ -1389,10 +1476,10 @@ var finalizeBuild_default = (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").action(function(execCommand, _, command3) {
+command.name("exec").description("Run test commands around SmartUI").argument("<command...>", "Command supplied for running tests").action(function(execCommand, _, command4) {
   return __async(this, null, function* () {
     var _a, _b;
-    let ctx = ctx_default(command3.optsWithGlobals());
+    let ctx = ctx_default(command4.optsWithGlobals());
     if (!which__default.default.sync(execCommand[0], { nothrow: true })) {
       ctx.log.error(`Error: Command not found "${execCommand[0]}"`);
       return;
@@ -1462,10 +1549,27 @@ function createWebStaticConfig(filepath) {
   fs5__default.default.writeFileSync(filepath, JSON.stringify(constants_default.DEFAULT_WEB_STATIC_CONFIG, null, 2) + "\n");
   console.log(`Created web-static config: ${filepath}`);
 }
+function createFigmaConfig(filepath) {
+  filepath = filepath || "designs.json";
+  let filetype = path2__default.default.extname(filepath);
+  if (filetype != ".json") {
+    console.log("Error: designs config file must have .json extension");
+    return;
+  }
+  if (fs5__default.default.existsSync(filepath)) {
+    console.log(`Error: designs config already exists: ${filepath}`);
+    console.log(`To create a new file, please specify the file name like: 'smartui config:figma-config designs.json'`);
+    return;
+  }
+  fs5__default.default.mkdirSync(path2__default.default.dirname(filepath), { recursive: true });
+  fs5__default.default.writeFileSync(filepath, JSON.stringify(constants_default.DEFAULT_FIGMA_CONFIG, null, 2) + "\n");
+  console.log(`Created designs config: ${filepath}`);
+}
 
 // src/commander/config.ts
 var configWeb = new commander.Command();
 var configStatic = new commander.Command();
+var configFigma = new commander.Command();
 configWeb.name("config:create").description("Create SmartUI config file").argument("[filepath]", "Optional config filepath").action(function(filepath, options) {
   return __async(this, null, function* () {
     createConfig(filepath);
@@ -1476,6 +1580,11 @@ configStatic.name("config:create-web-static").description("Create Web Static con
     createWebStaticConfig(filepath);
   });
 });
+configFigma.name("config:create-figma").description("Create figma designs config file").argument("[filepath]", "Optional config filepath").action(function(filepath, options) {
+  return __async(this, null, function* () {
+    createFigmaConfig(filepath);
+  });
+});
 function captureScreenshotsForConfig(_0, _1, _2, _3, _4) {
   return __async(this, arguments, function* (ctx, browsers, { name, url, waitForTimeout }, browserName, renderViewports) {
     let pageOptions = { waitUntil: process.env.SMARTUI_PAGE_WAIT_UNTIL_EVENT || "load" };
@@ -1614,9 +1723,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, _, command3) {
+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) {
   return __async(this, null, function* () {
-    let ctx = ctx_default(command3.optsWithGlobals());
+    let ctx = ctx_default(command4.optsWithGlobals());
     if (!fs5__default.default.existsSync(file)) {
       console.log(`Error: Web Static Config file ${file} not found.`);
       return;
@@ -1657,9 +1766,103 @@ command2.name("capture").description("Capture screenshots of static sites").argu
 });
 var capture_default = command2;
 
+// src/lib/uploadFigmaDesigns.ts
+var uploadFigmaDesigns_default = (ctx) => __async(void 0, null, function* () {
+  const depth = ctx.figmaDesignConfig.depth;
+  const figmaConfigs = ctx.figmaDesignConfig.figma_config;
+  let results = "";
+  let figmaFileToken = "";
+  const markBaseline = ctx.options.markBaseline;
+  const buildName = ctx.options.buildName;
+  for (const config of figmaConfigs) {
+    figmaFileToken = config.figma_file_token;
+    let queryParams = "";
+    if (config.figma_ids && config.figma_ids.length > 0) {
+      const fileIds = config.figma_ids.join(",");
+      queryParams += `?ids=${fileIds}`;
+    }
+    const authToken = `Basic ${Buffer.from(`${ctx.env.LT_USERNAME}:${ctx.env.LT_ACCESS_KEY}`).toString("base64")}`;
+    const responseData = yield ctx.client.getFigmaFilesAndImages(figmaFileToken, ctx.env.FIGMA_TOKEN, queryParams, authToken, depth, markBaseline, buildName, ctx.log);
+    if (responseData.data.message == "success") {
+      results = responseData.data.message;
+    }
+  }
+  return results;
+});
+
+// src/tasks/uploadFigmaDesigns.ts
+var uploadFigmaDesigns_default2 = (ctx) => {
+  return {
+    title: "Uploading Figma Designs",
+    task: (ctx2, task) => __async(void 0, null, function* () {
+      try {
+        ctx2.task = task;
+        updateLogContext({ task: "upload-figma" });
+        let results = yield uploadFigmaDesigns_default(ctx2);
+        if (results != "success") {
+          throw new Error("Uploading Figma designs failed");
+        }
+        task.title = "Figma designs images uploaded successfully to SmartUI";
+        ctx2.log.debug(`Figma designs processed: ${results}`);
+      } catch (error) {
+        ctx2.log.debug(error);
+        task.output = chalk8__default.default.gray(`${error.message}`);
+        throw new Error("Uploading Figma designs failed");
+      }
+    }),
+    rendererOptions: { persistentOutput: true },
+    exitOnError: false
+  };
+};
+
+// 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) {
+  return __async(this, null, function* () {
+    var _a, _b;
+    let ctx = ctx_default(command4.optsWithGlobals());
+    if (!fs5__default.default.existsSync(file)) {
+      console.log(`Error: Figma Config file ${file} not found.`);
+      return;
+    }
+    try {
+      ctx.figmaDesignConfig = JSON.parse(fs5__default.default.readFileSync(file, "utf8"));
+      if (!validateFigmaDesignConfig(ctx.figmaDesignConfig)) {
+        const validationError = (_b = (_a = validateFigmaDesignConfig.errors) == null ? void 0 : _a[0]) == null ? void 0 : _b.message;
+        throw new Error(validationError || "Invalid figma design Config");
+      }
+    } catch (error) {
+      console.log(`[smartui] Error: Invalid figma design Config; ${error.message}`);
+      return;
+    }
+    let tasks = new listr2.Listr(
+      [
+        auth_default(),
+        uploadFigmaDesigns_default2()
+      ],
+      {
+        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 uploadFigma_default = command3;
+
 // 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);
+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);
 var commander_default = program;
 (function() {
   return __async(this, null, function* () {

package/package.json

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