@visual-regression-tracker/sdk-js 5.1.0 → 5.3.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 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: [
@@ -1,4 +1,4 @@
1
- import { Config } from "types";
1
+ import { Config } from "../types";
2
2
  declare const readConfigFromFile: (config: Config) => Config;
3
3
  declare const readConfigFromEnv: (config: Config) => Config;
4
4
  declare const validateConfig: (config: Config) => void;
@@ -1,4 +1,4 @@
1
1
  import FormData from "form-data";
2
- import { TestRunMultipartDto, TestRunBufferDto } from "types/request";
2
+ import { TestRunMultipartDto, TestRunBufferDto } from "../types";
3
3
  export declare const multipartDtoToFormData: (dto: TestRunMultipartDto) => FormData;
4
4
  export declare const bufferDtoToFormData: (dto: TestRunBufferDto) => FormData;
@@ -19,6 +19,7 @@ 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 &&
@@ -37,6 +38,7 @@ const bufferDtoToFormData = (dto) => {
37
38
  dto.browser && data.append("browser", dto.browser);
38
39
  dto.viewport && data.append("viewport", dto.viewport);
39
40
  dto.device && data.append("device", dto.device);
41
+ dto.customTags && data.append("customTags", dto.customTags);
40
42
  dto.ignoreAreas &&
41
43
  data.append("ignoreAreas", JSON.stringify(dto.ignoreAreas));
42
44
  dto.diffTollerancePercent &&
@@ -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.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
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,3 +1,3 @@
1
- import { TestRunBase64, TestRunBuffer } from "types";
1
+ import { TestRunBase64, TestRunBuffer } from "../types";
2
2
  export declare function instanceOfTestRunBase64(object: any): object is TestRunBase64;
3
3
  export declare function instanceOfTestRunBuffer(object: any): object is TestRunBuffer;
package/dist/index.d.ts CHANGED
@@ -1,3 +1,4 @@
1
1
  export * from "./visualRegressionTracker";
2
2
  export * from "./testRunResult";
3
3
  export * from "./types";
4
+ export * from "./helpers";
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.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
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];
@@ -13,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
13
17
  __exportStar(require("./visualRegressionTracker"), exports);
14
18
  __exportStar(require("./testRunResult"), exports);
15
19
  __exportStar(require("./types"), exports);
20
+ __exportStar(require("./helpers"), exports);
@@ -1,5 +1,6 @@
1
1
  export * from "./config";
2
2
  export * from "./testRun";
3
+ export * from "./request";
3
4
  export * from "./response/buildResponse";
4
5
  export * from "./response/testRunResponse";
5
6
  export * from "./testStatus";
@@ -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.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
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];
@@ -12,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
12
16
  Object.defineProperty(exports, "__esModule", { value: true });
13
17
  __exportStar(require("./config"), exports);
14
18
  __exportStar(require("./testRun"), exports);
19
+ __exportStar(require("./request"), exports);
15
20
  __exportStar(require("./response/buildResponse"), exports);
16
21
  __exportStar(require("./response/testRunResponse"), exports);
17
22
  __exportStar(require("./testStatus"), exports);
@@ -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.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
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,10 +1,11 @@
1
- import { IgnoreArea } from "types/ignoreArea";
1
+ import { IgnoreArea } from "../../types/ignoreArea";
2
2
  export interface TestRunDto {
3
3
  name: string;
4
4
  os?: string;
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;
@@ -6,6 +6,7 @@ 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[];
11
12
  }
@@ -13,9 +13,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
13
13
  };
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
15
  exports.VisualRegressionTracker = void 0;
16
+ const axios_1 = __importDefault(require("axios"));
16
17
  const types_1 = require("./types");
17
18
  const testRunResult_1 = __importDefault(require("./testRunResult"));
18
- const axios_1 = __importDefault(require("axios"));
19
19
  const helpers_1 = require("./helpers");
20
20
  class VisualRegressionTracker {
21
21
  constructor(explicitConfig) {
@@ -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(), apiKey: this.config.apiKey }),
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.1.0",
3
+ "version": "5.3.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.21.0",
23
+ "axios": "^0.26.1",
24
24
  "form-data": "^4.0.0"
25
25
  },
26
26
  "devDependencies": {
27
- "@types/jest": "^26.0.24",
28
- "@types/node": "^15.14.9",
29
- "jest": "^26.6.3",
30
- "semantic-release": "^17.4.7",
31
- "ts-jest": "^26.5.6",
32
- "typescript": "^4.4.2"
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"