@visual-regression-tracker/sdk-js 5.3.0 → 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.
Files changed (5) hide show
  1. package/README.md +4 -0
  2. package/dist/helpers/dto.helper.js +2 -0
  3. package/dist/types/request/testRun.dto.d.ts +1 -0
  4. package/dist/types/testRun.d.ts +1 -0
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -151,5 +151,9 @@ await vrt.track({
151
151
  height: 400;
152
152
  }
153
153
  ]
154
+
155
+ // Allow additional details
156
+ // Optional
157
+ comment: 'Ignoring region because of animation'
154
158
  });
155
159
  ```
package/dist/helpers/dto.helper.js CHANGED
@@ -24,6 +24,7 @@ const multipartDtoToFormData = (dto) => {
24
24
  data.append("ignoreAreas", JSON.stringify(dto.ignoreAreas));
25
25
  dto.diffTollerancePercent &&
26
26
  data.append("diffTollerancePercent", dto.diffTollerancePercent);
27
+ dto.comment && data.append("comment", dto.comment);
27
28
  return data;
28
29
  };
29
30
  exports.multipartDtoToFormData = multipartDtoToFormData;
@@ -43,6 +44,7 @@ const bufferDtoToFormData = (dto) => {
43
44
  data.append("ignoreAreas", JSON.stringify(dto.ignoreAreas));
44
45
  dto.diffTollerancePercent &&
45
46
  data.append("diffTollerancePercent", dto.diffTollerancePercent);
47
+ dto.comment && data.append("comment", dto.comment);
46
48
  return data;
47
49
  };
48
50
  exports.bufferDtoToFormData = bufferDtoToFormData;
package/dist/types/request/testRun.dto.d.ts CHANGED
@@ -12,4 +12,5 @@ export interface TestRunDto {
12
12
  diffTollerancePercent?: number;
13
13
  merge?: boolean;
14
14
  ignoreAreas?: IgnoreArea[];
15
+ comment?: string;
15
16
  }
package/dist/types/testRun.d.ts CHANGED
@@ -9,6 +9,7 @@ interface TestRun {
9
9
  customTags?: string;
10
10
  diffTollerancePercent?: number;
11
11
  ignoreAreas?: IgnoreArea[];
12
+ comment?: string;
12
13
  }
13
14
  export interface TestRunBase64 extends TestRun {
14
15
  imageBase64: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@visual-regression-tracker/sdk-js",
3
- "version": "5.3.0",
3
+ "version": "5.4.0",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",