@visual-regression-tracker/sdk-js 5.1.1 → 5.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -0
- package/dist/helpers/dto.helper.js +4 -0
- package/dist/helpers/index.js +5 -1
- package/dist/index.js +5 -1
- package/dist/types/index.js +5 -1
- package/dist/types/request/index.js +5 -1
- package/dist/types/request/testRun.dto.d.ts +2 -0
- package/dist/types/testRun.d.ts +2 -0
- package/dist/visualRegressionTracker.js +2 -1
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -127,6 +127,9 @@ await vrt.track({
|
|
|
127
127
|
// Optional
|
|
128
128
|
device: "PC",
|
|
129
129
|
|
|
130
|
+
// Optional
|
|
131
|
+
customTags: "Cloud, DarkTheme, Auth",
|
|
132
|
+
|
|
130
133
|
// Array of areas to be ignored
|
|
131
134
|
// Optional
|
|
132
135
|
ignoreAreas: [
|
|
@@ -148,5 +151,9 @@ await vrt.track({
|
|
|
148
151
|
height: 400;
|
|
149
152
|
}
|
|
150
153
|
]
|
|
154
|
+
|
|
155
|
+
// Allow additional details
|
|
156
|
+
// Optional
|
|
157
|
+
comment: 'Ignoring region because of animation'
|
|
151
158
|
});
|
|
152
159
|
```
|
|
@@ -19,10 +19,12 @@ const multipartDtoToFormData = (dto) => {
|
|
|
19
19
|
dto.browser && data.append("browser", dto.browser);
|
|
20
20
|
dto.viewport && data.append("viewport", dto.viewport);
|
|
21
21
|
dto.device && data.append("device", dto.device);
|
|
22
|
+
dto.customTags && data.append("customTags", dto.customTags);
|
|
22
23
|
dto.ignoreAreas &&
|
|
23
24
|
data.append("ignoreAreas", JSON.stringify(dto.ignoreAreas));
|
|
24
25
|
dto.diffTollerancePercent &&
|
|
25
26
|
data.append("diffTollerancePercent", dto.diffTollerancePercent);
|
|
27
|
+
dto.comment && data.append("comment", dto.comment);
|
|
26
28
|
return data;
|
|
27
29
|
};
|
|
28
30
|
exports.multipartDtoToFormData = multipartDtoToFormData;
|
|
@@ -37,10 +39,12 @@ const bufferDtoToFormData = (dto) => {
|
|
|
37
39
|
dto.browser && data.append("browser", dto.browser);
|
|
38
40
|
dto.viewport && data.append("viewport", dto.viewport);
|
|
39
41
|
dto.device && data.append("device", dto.device);
|
|
42
|
+
dto.customTags && data.append("customTags", dto.customTags);
|
|
40
43
|
dto.ignoreAreas &&
|
|
41
44
|
data.append("ignoreAreas", JSON.stringify(dto.ignoreAreas));
|
|
42
45
|
dto.diffTollerancePercent &&
|
|
43
46
|
data.append("diffTollerancePercent", dto.diffTollerancePercent);
|
|
47
|
+
dto.comment && data.append("comment", dto.comment);
|
|
44
48
|
return data;
|
|
45
49
|
};
|
|
46
50
|
exports.bufferDtoToFormData = bufferDtoToFormData;
|
package/dist/helpers/index.js
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
3
|
if (k2 === undefined) k2 = k;
|
|
4
|
-
Object.
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
5
9
|
}) : (function(o, m, k, k2) {
|
|
6
10
|
if (k2 === undefined) k2 = k;
|
|
7
11
|
o[k2] = m[k];
|
package/dist/index.js
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
3
|
if (k2 === undefined) k2 = k;
|
|
4
|
-
Object.
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
5
9
|
}) : (function(o, m, k, k2) {
|
|
6
10
|
if (k2 === undefined) k2 = k;
|
|
7
11
|
o[k2] = m[k];
|
package/dist/types/index.js
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
3
|
if (k2 === undefined) k2 = k;
|
|
4
|
-
Object.
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
5
9
|
}) : (function(o, m, k, k2) {
|
|
6
10
|
if (k2 === undefined) k2 = k;
|
|
7
11
|
o[k2] = m[k];
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
3
|
if (k2 === undefined) k2 = k;
|
|
4
|
-
Object.
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
5
9
|
}) : (function(o, m, k, k2) {
|
|
6
10
|
if (k2 === undefined) k2 = k;
|
|
7
11
|
o[k2] = m[k];
|
|
@@ -5,10 +5,12 @@ export interface TestRunDto {
|
|
|
5
5
|
browser?: string;
|
|
6
6
|
viewport?: string;
|
|
7
7
|
device?: string;
|
|
8
|
+
customTags?: string;
|
|
8
9
|
branchName: string;
|
|
9
10
|
buildId: string;
|
|
10
11
|
projectId: string;
|
|
11
12
|
diffTollerancePercent?: number;
|
|
12
13
|
merge?: boolean;
|
|
13
14
|
ignoreAreas?: IgnoreArea[];
|
|
15
|
+
comment?: string;
|
|
14
16
|
}
|
package/dist/types/testRun.d.ts
CHANGED
|
@@ -6,8 +6,10 @@ interface TestRun {
|
|
|
6
6
|
browser?: string;
|
|
7
7
|
viewport?: string;
|
|
8
8
|
device?: string;
|
|
9
|
+
customTags?: string;
|
|
9
10
|
diffTollerancePercent?: number;
|
|
10
11
|
ignoreAreas?: IgnoreArea[];
|
|
12
|
+
comment?: string;
|
|
11
13
|
}
|
|
12
14
|
export interface TestRunBase64 extends TestRun {
|
|
13
15
|
imageBase64: string;
|
|
@@ -38,6 +38,7 @@ class VisualRegressionTracker {
|
|
|
38
38
|
this.axiosConfig = {
|
|
39
39
|
headers: {
|
|
40
40
|
apiKey: this.config.apiKey,
|
|
41
|
+
project: this.config.project,
|
|
41
42
|
},
|
|
42
43
|
};
|
|
43
44
|
}
|
|
@@ -86,7 +87,7 @@ class VisualRegressionTracker {
|
|
|
86
87
|
return __awaiter(this, void 0, void 0, function* () {
|
|
87
88
|
return axios_1.default
|
|
88
89
|
.post(`${this.config.apiUrl}/test-runs/multipart`, data, {
|
|
89
|
-
headers: Object.assign(Object.assign({}, data.getHeaders()), { "Content-Length": data.getLengthSync(),
|
|
90
|
+
headers: Object.assign(Object.assign(Object.assign({}, data.getHeaders()), { "Content-Length": data.getLengthSync() }), this.axiosConfig.headers),
|
|
90
91
|
})
|
|
91
92
|
.then(this.handleResponse)
|
|
92
93
|
.catch(this.handleException);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@visual-regression-tracker/sdk-js",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.4.0",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -20,16 +20,16 @@
|
|
|
20
20
|
},
|
|
21
21
|
"homepage": "https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker",
|
|
22
22
|
"dependencies": {
|
|
23
|
-
"axios": "^0.
|
|
23
|
+
"axios": "^0.26.1",
|
|
24
24
|
"form-data": "^4.0.0"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
27
|
-
"@types/jest": "^
|
|
28
|
-
"@types/node": "^
|
|
29
|
-
"jest": "^
|
|
30
|
-
"semantic-release": "^
|
|
31
|
-
"ts-jest": "^
|
|
32
|
-
"typescript": "^4.
|
|
27
|
+
"@types/jest": "^27.4.1",
|
|
28
|
+
"@types/node": "^17.0.23",
|
|
29
|
+
"jest": "^27.5.1",
|
|
30
|
+
"semantic-release": "^19.0.2",
|
|
31
|
+
"ts-jest": "^27.1.4",
|
|
32
|
+
"typescript": "^4.6.3"
|
|
33
33
|
},
|
|
34
34
|
"publishConfig": {
|
|
35
35
|
"access": "public"
|