@visual-regression-tracker/sdk-js 5.5.0 → 5.7.0

package/dist/helpers/config.helper.js

@@ -12,6 +12,9 @@ const readConfigFromFile = (config) => {
         if (fileConfig.branchName) {
             config.branchName = fileConfig.branchName;
         }
+        if (fileConfig.baselineBranchName) {
+            config.baselineBranchName = fileConfig.baselineBranchName;
+        }
         if (fileConfig.project) {
             config.project = fileConfig.project;
         }
@@ -35,6 +38,9 @@ const readConfigFromEnv = (config) => {
     if (process.env["VRT_BRANCHNAME"]) {
         config.branchName = process.env["VRT_BRANCHNAME"];
     }
+    if (process.env["VRT_BASELINEBRANCHNAME"]) {
+        config.baselineBranchName = process.env["VRT_BASELINEBRANCHNAME"];
+    }
     if (process.env["VRT_PROJECT"]) {
         config.project = process.env["VRT_PROJECT"];
     }

package/dist/helpers/dto.helper.js

@@ -11,6 +11,7 @@ const multipartDtoToFormData = (dto) => {
     data.append("buildId", dto.buildId);
     data.append("projectId", dto.projectId);
     data.append("branchName", dto.branchName);
+    dto.baselineBranchName && data.append("baselineBranchName", dto.baselineBranchName);
     data.append("name", dto.name);
     data.append("image", fs_1.default.createReadStream(dto.imagePath), {
         knownLength: fs_1.default.statSync(dto.imagePath).size,
@@ -33,6 +34,7 @@ const bufferDtoToFormData = (dto) => {
     data.append("buildId", dto.buildId);
     data.append("projectId", dto.projectId);
     data.append("branchName", dto.branchName);
+    dto.baselineBranchName && data.append("baselineBranchName", dto.baselineBranchName);
     data.append("name", dto.name);
     data.append("image", dto.imageBuffer, { filename: "image.png" });
     dto.os && data.append("os", dto.os);

package/dist/helpers/track.helper.d.ts

@@ -1,4 +1,4 @@
 import { TestRunResponse } from "../types";
-export declare const processTestRun: (testRunResponse: TestRunResponse, enableSoftAssert?: boolean | undefined) => void;
+export declare const processTestRun: (testRunResponse: TestRunResponse, enableSoftAssert?: boolean) => void;
 export declare const shouldStopRetry: (result: TestRunResponse) => boolean;
-export declare const trackWithRetry: (trackFn: () => Promise<TestRunResponse>, retryLimit: number, enableSoftAssert?: boolean | undefined) => Promise<TestRunResponse>;
+export declare const trackWithRetry: (trackFn: () => Promise<TestRunResponse>, retryLimit?: number, enableSoftAssert?: boolean) => Promise<TestRunResponse>;

package/dist/helpers/track.helper.js

@@ -36,7 +36,7 @@ const processTestRun = (testRunResponse, enableSoftAssert) => {
 exports.processTestRun = processTestRun;
 const shouldStopRetry = (result) => result.status !== types_1.TestStatus.unresolved;
 exports.shouldStopRetry = shouldStopRetry;
-const trackWithRetry = (trackFn, retryLimit, enableSoftAssert) => __awaiter(void 0, void 0, void 0, function* () {
+const trackWithRetry = (trackFn, retryLimit = 2, enableSoftAssert) => __awaiter(void 0, void 0, void 0, function* () {
     const result = yield trackFn();
     if (retryLimit <= 0 || (0, exports.shouldStopRetry)(result)) {
         (0, exports.processTestRun)(result, enableSoftAssert);

package/dist/helpers/type.helper.d.ts

@@ -1,3 +1,4 @@
-import { TestRunBase64, TestRunBuffer } from "../types";
+import { TestRunBase64, TestRunBuffer, TestRunMultipart } from "../types";
 export declare function instanceOfTestRunBase64(object: any): object is TestRunBase64;
 export declare function instanceOfTestRunBuffer(object: any): object is TestRunBuffer;
+export declare function instanceOfTestRunMultipart(object: any): object is TestRunMultipart;

package/dist/helpers/type.helper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.instanceOfTestRunBuffer = exports.instanceOfTestRunBase64 = void 0;
+exports.instanceOfTestRunMultipart = exports.instanceOfTestRunBuffer = exports.instanceOfTestRunBase64 = void 0;
 function instanceOfTestRunBase64(object) {
     return "imageBase64" in object;
 }
@@ -9,3 +9,7 @@ function instanceOfTestRunBuffer(object) {
     return "imageBuffer" in object;
 }
 exports.instanceOfTestRunBuffer = instanceOfTestRunBuffer;
+function instanceOfTestRunMultipart(object) {
+    return "imagePath" in object;
+}
+exports.instanceOfTestRunMultipart = instanceOfTestRunMultipart;

package/dist/types/config.d.ts

@@ -1,6 +1,7 @@
 export interface Config extends Record<string, any> {
     apiUrl: string;
     branchName: string;
+    baselineBranchName?: string;
     project: string;
     apiKey: string;
     enableSoftAssert?: boolean;

package/dist/types/request/testRun.dto.d.ts

@@ -7,6 +7,7 @@ export interface TestRunDto {
     device?: string;
     customTags?: string;
     branchName: string;
+    baselineBranchName?: string;
     buildId: string;
     projectId: string;
     diffTollerancePercent?: number;

package/dist/types/testStatus.js

@@ -7,4 +7,4 @@ var TestStatus;
     TestStatus["ok"] = "ok";
     TestStatus["unresolved"] = "unresolved";
     TestStatus["autoApproved"] = "autoApproved";
-})(TestStatus = exports.TestStatus || (exports.TestStatus = {}));
+})(TestStatus || (exports.TestStatus = TestStatus = {}));

package/dist/visualRegressionTracker.d.ts

@@ -13,6 +13,7 @@ export declare class VisualRegressionTracker {
     private submitTestRunMultipart;
     private handleResponse;
     private handleException;
+    private getFormData;
     /**
      * Submit test data to external VRT service
      *

package/dist/visualRegressionTracker.js

@@ -48,6 +48,7 @@ class VisualRegressionTracker {
         return __awaiter(this, void 0, void 0, function* () {
             const data = {
                 branchName: this.config.branchName,
+                baselineBranchName: this.config.baselineBranchName,
                 project: this.config.project,
                 ciBuildId: this.config.ciBuildId,
             };
@@ -75,7 +76,7 @@ class VisualRegressionTracker {
     }
     submitTestRunBase64(test) {
         return __awaiter(this, void 0, void 0, function* () {
-            const data = Object.assign({ buildId: this.buildId, projectId: this.projectId, branchName: this.config.branchName }, test);
+            const data = Object.assign({ buildId: this.buildId, projectId: this.projectId, branchName: this.config.branchName, baselineBranchName: this.config.baselineBranchName }, test);
             return axios_1.default
                 .post(`${this.config.apiUrl}/test-runs`, data, this.axiosConfig)
                 .then(this.handleResponse)
@@ -84,10 +85,11 @@ class VisualRegressionTracker {
     }
     submitTestRunMultipart(data) {
         return __awaiter(this, void 0, void 0, function* () {
-            return axios_1.default
-                .post(`${this.config.apiUrl}/test-runs/multipart`, data, {
+            const config = {
                 headers: Object.assign(Object.assign(Object.assign({}, data.getHeaders()), { "Content-Length": data.getLengthSync() }), this.axiosConfig.headers),
-            })
+            };
+            return axios_1.default
+                .post(`${this.config.apiUrl}/test-runs/multipart`, data, config)
                 .then(this.handleResponse)
                 .catch(this.handleException);
         });
@@ -115,6 +117,15 @@ class VisualRegressionTracker {
             }
         });
     }
+    getFormData(test) {
+        if ((0, helpers_1.instanceOfTestRunBuffer)(test)) {
+            return (0, helpers_1.bufferDtoToFormData)(Object.assign({ buildId: this.buildId, projectId: this.projectId, branchName: this.config.branchName, baselineBranchName: this.config.baselineBranchName }, test));
+        }
+        else if ((0, helpers_1.instanceOfTestRunMultipart)(test)) {
+            return (0, helpers_1.multipartDtoToFormData)(Object.assign({ buildId: this.buildId, projectId: this.projectId, branchName: this.config.branchName, baselineBranchName: this.config.baselineBranchName }, test));
+        }
+        throw new Error("Invalid test run data");
+    }
     /**
      * Submit test data to external VRT service
      *
@@ -132,14 +143,7 @@ class VisualRegressionTracker {
                 testRunResponse = yield (0, helpers_1.trackWithRetry)(() => this.submitTestRunBase64(test), retryCount, this.config.enableSoftAssert);
             }
             else {
-                let formData;
-                if ((0, helpers_1.instanceOfTestRunBuffer)(test)) {
-                    formData = (0, helpers_1.bufferDtoToFormData)(Object.assign({ buildId: this.buildId, projectId: this.projectId, branchName: this.config.branchName }, test));
-                }
-                else {
-                    formData = (0, helpers_1.multipartDtoToFormData)(Object.assign({ buildId: this.buildId, projectId: this.projectId, branchName: this.config.branchName }, test));
-                }
-                testRunResponse = yield (0, helpers_1.trackWithRetry)(() => this.submitTestRunMultipart(formData), retryCount, this.config.enableSoftAssert);
+                testRunResponse = yield (0, helpers_1.trackWithRetry)(() => this.submitTestRunMultipart(this.getFormData(test)), retryCount, this.config.enableSoftAssert);
             }
             return new testRunResult_1.default(testRunResponse, this.config.apiUrl);
         });

package/package.json

@@ -1,35 +1,38 @@
 {
   "name": "@visual-regression-tracker/sdk-js",
-  "version": "5.5.0",
+  "version": "5.7.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "test": "jest",
     "test:cov": "jest --collectCoverage",
-    "build": "./node_modules/.bin/tsc"
+    "build": "tsc"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Visual-Regression-Tracker/vrt-sdk-js.git"
+    "url": "git+https://github.com/Visual-Regression-Tracker/sdk-js.git"
+  },
+  "engines": {
+    "node": ">=18"
   },
   "author": "",
-  "license": "ISC",
+  "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/Visual-Regression-Tracker/vrt-sdk-js/issues"
+    "url": "https://github.com/Visual-Regression-Tracker/sdk-js/issues"
   },
   "homepage": "https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker",
   "dependencies": {
-    "axios": "^0.26.1",
+    "axios": "^1.4.0",
     "form-data": "^4.0.0"
   },
   "devDependencies": {
-    "@types/jest": "^27.4.1",
-    "@types/node": "^17.0.23",
-    "jest": "^27.5.1",
-    "semantic-release": "^19.0.2",
-    "ts-jest": "^27.1.4",
-    "typescript": "^4.6.3"
+    "@types/jest": "^29.5.3",
+    "@types/node": "^16.18.38",
+    "jest": "^29.6.1",
+    "semantic-release": "^21.0.7",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.1.6"
   },
   "publishConfig": {
     "access": "public"