feat(312): support adding comment (#183)

Author: dimitriharding

README.md

@@ -151,5 +151,9 @@ await vrt.track({
       height: 400;
     }
   ]
+
+  // Allow additional details
+  // Optional
+  comment: 'Ignoring region because of animation'
 });
 ```

lib/helpers/dto.helper.ts

@@ -20,6 +20,7 @@ export const multipartDtoToFormData = (dto: TestRunMultipartDto): FormData => {
     data.append("ignoreAreas", JSON.stringify(dto.ignoreAreas));
   dto.diffTollerancePercent &&
     data.append("diffTollerancePercent", dto.diffTollerancePercent);
+  dto.comment && data.append("comment", dto.comment);
 
   return data;
 };
@@ -40,6 +41,7 @@ export const bufferDtoToFormData = (dto: TestRunBufferDto): FormData => {
     data.append("ignoreAreas", JSON.stringify(dto.ignoreAreas));
   dto.diffTollerancePercent &&
     data.append("diffTollerancePercent", dto.diffTollerancePercent);
+  dto.comment && data.append("comment", dto.comment);
 
   return data;
 };

lib/types/request/testRun.dto.ts

@@ -24,4 +24,6 @@ export interface TestRunDto {
   merge?: boolean;
 
   ignoreAreas?: IgnoreArea[];
+
+  comment?: string;
 }

lib/types/testRun.ts

@@ -9,6 +9,7 @@ interface TestRun {
   customTags?: string;
   diffTollerancePercent?: number;
   ignoreAreas?: IgnoreArea[];
+  comment?: string;
 }
 
 export interface TestRunBase64 extends TestRun {

lib/visualRegressionTracker.spec.ts

@@ -142,6 +142,7 @@ const testRunMultipart: TestRunMultipart = {
       width: 400,
     },
   ],
+  comment: "comment",
 };
 
 const testRunBuffer: TestRunBuffer = {
@@ -160,6 +161,7 @@ const testRunBuffer: TestRunBuffer = {
       width: 400,
     },
   ],
+  comment: "comment",
 };
 
 const testRunResponse: TestRunResponse = {