@percy/client 1.27.7 → 1.28.0-beta.0

package/dist/client.js

@@ -11,6 +11,7 @@ const {
 const pkg = getPackageJSON(import.meta.url);
 // minimum polling interval milliseconds
 const MIN_POLLING_INTERVAL = 1_000;
+const INVALID_TOKEN_ERROR_MESSAGE = 'Unable to retrieve snapshot details with write access token. Kindly use a full access token for retrieving snapshot details with Synchronous CLI.';
 
 // Validate ID arguments
 function validateId(type, id) {
@@ -179,6 +180,35 @@ export class PercyClient {
     this.log.debug(`Get build ${buildId}`);
     return this.get(`builds/${buildId}`);
   }
+  async getComparisonDetails(comparisonId) {
+    validateId('comparison', comparisonId);
+    try {
+      return await this.get(`comparisons/${comparisonId}?sync=true&response_format=sync-cli`);
+    } catch (error) {
+      if (error.response.statusCode === 403) {
+        throw new Error(INVALID_TOKEN_ERROR_MESSAGE);
+      }
+      throw error;
+    }
+  }
+  async getSnapshotDetails(snapshotId) {
+    validateId('snapshot', snapshotId);
+    try {
+      return await this.get(`snapshots/${snapshotId}?sync=true&response_format=sync-cli`);
+    } catch (error) {
+      if (error.response.statusCode === 403) {
+        throw new Error(INVALID_TOKEN_ERROR_MESSAGE);
+      }
+      throw error;
+    }
+  }
+
+  // Retrieves snapshot/comparison data by id. Requires a read access token.
+  async getStatus(type, ids) {
+    if (!['snapshot', 'comparison'].includes(type)) throw new Error('Invalid type passed');
+    this.log.debug(`Getting ${type} status for ids ${ids}`);
+    return this.get(`job_status?sync=true&type=${type}&id=${ids.join()}`);
+  }
 
   // Retrieves project builds optionally filtered. Requires a read access token.
   async getBuilds(project, filters = {}) {
@@ -306,6 +336,7 @@ export class PercyClient {
     enableLayout,
     clientInfo,
     environmentInfo,
+    sync,
     resources = []
   } = {}) {
     validateId('build', buildId);
@@ -326,6 +357,7 @@ export class PercyClient {
           name: name || null,
           widths: widths || null,
           scope: scope || null,
+          sync: !!sync,
           'scope-options': scopeOptions || {},
           'minimum-height': minHeight || null,
           'enable-javascript': enableJavaScript || null,
@@ -380,7 +412,8 @@ export class PercyClient {
     ignoredElementsData,
     domInfoSha,
     consideredElementsData,
-    metadata
+    metadata,
+    sync
   } = {}) {
     validateId('snapshot', snapshotId);
     // Remove post percy api deploy
@@ -402,6 +435,7 @@ export class PercyClient {
           'ignore-elements-data': ignoredElementsData || null,
           'consider-elements-data': consideredElementsData || null,
           'dom-info-sha': domInfoSha || null,
+          sync: !!sync,
           metadata: metadata || null
         },
         relationships: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/client",
-  "version": "1.27.7",
+  "version": "1.28.0-beta.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "latest"
+    "tag": "beta"
   },
   "engines": {
     "node": ">=14"
@@ -32,8 +32,8 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/env": "1.27.7",
-    "@percy/logger": "1.27.7"
+    "@percy/env": "1.28.0-beta.0",
+    "@percy/logger": "1.28.0-beta.0"
   },
-  "gitHead": "eba048142b27b317491f15364b34764371fc0670"
+  "gitHead": "d188893f1b45f6e4a1b3196b326a47174340c6ce"
 }

package/test/helpers.js

@@ -128,6 +128,17 @@ export const api = {
         attributes: body.attributes,
         relationships: body.relationships
       }
+    }],
+    '/job_status?sync=true&type=snapshot&id=4567': () => [201, {
+      4567: {
+        status: true,
+        nextPoll: 8,
+        error: null
+      }
+    }],
+    '/snapshots/4567?sync=true&response_format=sync-cli': () => [201, {
+      name: 'test snapshot',
+      diff_ratio: 0
     }]
   },