@percy/client 1.22.0-alpha.0 → 1.23.0

package/README.md

@@ -164,4 +164,4 @@ await client.waitForBuild({
 - `commit` — Commit SHA (**required** when missing `build`)
 - `project` — Project slug (**required** when using `commit`)
 - `timeout` — Timeout in milliseconds to wait with no updates (**default** `10 * 60 * 1000`)
-- `interval` — Interval in miliseconds to check for updates (**default** `1000`)
+- `interval` — Interval in miliseconds to check for updates (**default** `10000`)

package/dist/client.js

@@ -9,6 +9,8 @@ const {
   PERCY_CLIENT_API_URL = 'https://percy.io/api/v1'
 } = process.env;
 const pkg = getPackageJSON(import.meta.url);
+// minimum polling interval milliseconds
+const MIN_POLLING_INTERVAL = 1_000;
 
 // Validate ID arguments
 function validateId(type, id) {
@@ -186,8 +188,12 @@ export class PercyClient {
     project,
     commit,
     timeout = 10 * 60 * 1000,
-    interval = 1000
+    interval = 10_000
   }, onProgress) {
+    if (interval < MIN_POLLING_INTERVAL) {
+      this.log.warn(`Ignoring interval since it cannot be less than ${MIN_POLLING_INTERVAL}ms.`);
+      interval = MIN_POLLING_INTERVAL;
+    }
     if (!project && commit) {
       throw new Error('Missing project path for commit');
     } else if (!project && !build) {
@@ -357,7 +363,8 @@ export class PercyClient {
   async createComparison(snapshotId, {
     tag,
     tiles = [],
-    externalDebugUrl
+    externalDebugUrl,
+    ignoredElementsData
   } = {}) {
     validateId('snapshot', snapshotId);
     this.log.debug(`Creating comparision: ${tag.name}...`);
@@ -374,7 +381,8 @@ export class PercyClient {
       data: {
         type: 'comparisons',
         attributes: {
-          'external-debug-url': externalDebugUrl || null
+          'external-debug-url': externalDebugUrl || null,
+          'ignore-elements-data': ignoredElementsData || null
         },
         relationships: {
           tag: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/client",
-  "version": "1.22.0-alpha.0",
+  "version": "1.23.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -31,8 +31,8 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/env": "1.22.0-alpha.0",
-    "@percy/logger": "1.22.0-alpha.0"
+    "@percy/env": "1.23.0",
+    "@percy/logger": "1.23.0"
   },
-  "gitHead": "5928e586c401ac10840d1ec6219875526e45d100"
+  "gitHead": "cd9a0de3f51233e414cd2657997ce02e8faa19e2"
 }