{"id":21406333,"url":"https://github.com/visual-regression-tracker/sdk-js","last_synced_at":"2025-07-14T00:32:26.252Z","repository":{"id":37824496,"uuid":"257648584","full_name":"Visual-Regression-Tracker/sdk-js","owner":"Visual-Regression-Tracker","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-29T08:03:46.000Z","size":1361,"stargazers_count":4,"open_issues_count":2,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-29T10:30:03.660Z","etag":null,"topics":["javascript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Visual-Regression-Tracker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-21T16:23:15.000Z","updated_at":"2024-09-05T06:16:41.000Z","dependencies_parsed_at":"2023-02-13T00:31:25.437Z","dependency_job_id":"231e0346-20e8-4e4d-ad43-77b6c6c091e8","html_url":"https://github.com/Visual-Regression-Tracker/sdk-js","commit_stats":{"total_commits":119,"total_committers":8,"mean_commits":14.875,"dds":"0.31092436974789917","last_synced_commit":"a8ca48b7a7a6ab723a5d9b5be85072aaa71e09f6"},"previous_names":["visual-regression-tracker/vrt-sdk-js"],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Visual-Regression-Tracker%2Fsdk-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Visual-Regression-Tracker%2Fsdk-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Visual-Regression-Tracker%2Fsdk-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Visual-Regression-Tracker%2Fsdk-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Visual-Regression-Tracker","download_url":"https://codeload.github.com/Visual-Regression-Tracker/sdk-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225933135,"owners_count":17547707,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript"],"created_at":"2024-11-22T16:38:56.458Z","updated_at":"2024-11-22T16:38:57.068Z","avatar_url":"https://github.com/Visual-Regression-Tracker.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JS SDK for [Visual Regression Tracker](https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker)\n\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Visual-Regression-Tracker_sdk-js\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=Visual-Regression-Tracker_sdk-js)\n[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=Visual-Regression-Tracker_sdk-js\u0026metric=code_smells)](https://sonarcloud.io/summary/new_code?id=Visual-Regression-Tracker_sdk-js)\n\n## Npm\n\nhttps://www.npmjs.com/package/@visual-regression-tracker/sdk-js\n\n## Install\n\n`npm install @visual-regression-tracker/sdk-js`\n\n## Usage\n\n### Import\n\n```js\nimport {\n  VisualRegressionTracker,\n  Config,\n} from \"@visual-regression-tracker/sdk-js\";\n```\n\n### Configure\n\n#### Explicit config from code\n\n```js\nconst config: Config = {\n  // URL where backend is running\n  // Required\n  apiUrl: \"http://localhost:4200\",\n\n  // Project name or ID\n  // Required\n  project: \"Default project\",\n\n  // User apiKey\n  // Required\n  apiKey: \"tXZVHX0EA4YQM1MGDD\",\n\n  // Current git branch\n  // Required\n  branchName: \"develop\",\n\n  // Log errors instead of throwing exceptions\n  // Optional - default false\n  enableSoftAssert: true,\n\n  // Unique ID related to one CI build\n  // Optional - default null\n  ciBuildId: \"SOME_UNIQUE_ID\",\n};\n```\n\n#### Or, as JSON config file `vrt.json`\n\n_Used only if not explicit config provided_\n_Is overriden if ENV variables are present_\n\n```json\n{\n  \"apiUrl\": \"http://localhost:4200\",\n  \"project\": \"Default project\",\n  \"apiKey\": \"tXZVHX0EA4YQM1MGDD\",\n  \"ciBuildId\": \"commit_sha\",\n  \"branchName\": \"develop\",\n  \"enableSoftAssert\": false\n}\n```\n\n#### Or, as environment variables\n\n_Used only if not explicit config provided_\n\n```\nVRT_APIURL=\"http://localhost:4200\"\nVRT_PROJECT=\"Default project\"\nVRT_APIKEY=\"tXZVHX0EA4YQM1MGDD\"\nVRT_CIBUILDID=\"commit_sha\"\nVRT_BRANCHNAME=\"develop\"\nVRT_ENABLESOFTASSERT=true\n```\n\n### Setup\n\n```js\nvrt.start();\n```\n\n### Teardown\n\n```js\nvrt.stop();\n```\n\n### Assert\n\n```js\nawait vrt.track({\n  // Name to be displayed\n  // Required\n  name: \"Image name\",\n\n  // Base64 encoded string\n  // Required or use imagePath\n  imageBase64: image,\n\n  // Path to image (service version api:4.14.0 or higher is required)\n  // Required or use imageBase64\n  imagePath: image,\n\n  // Allowed mismatch % (mismatched pixels to overal pixels count)\n  // Optional\n  diffTollerancePercent: 0,\n\n  // Optional\n  os: \"Mac\",\n\n  // Optional\n  browser: \"Chrome\",\n\n  // Optional\n  viewport: \"800x600\",\n\n  // Optional\n  device: \"PC\",\n\n  // Optional\n  customTags: \"Cloud, DarkTheme, Auth\",\n\n  // Array of areas to be ignored\n  // Optional\n  ignoreAreas: [\n    {\n      // X-coordinate relative of left upper corner\n      // Required\n      x: 10;\n\n      // Y-coordinate relative of left upper corner\n      // Required\n      y: 20;\n\n      // Area width in px\n      // Required\n      width: 300;\n\n      // Height width in px\n      // Required\n      height: 400;\n    }\n  ]\n\n  // Allow additional details\n  // Optional\n  comment: 'Ignoring region because of animation'\n});\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvisual-regression-tracker%2Fsdk-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvisual-regression-tracker%2Fsdk-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvisual-regression-tracker%2Fsdk-js/lists"}