@percy/client 1.31.1-beta.0 → 1.31.1-beta.2

package/dist/client.js

@@ -119,9 +119,9 @@ export class PercyClient {
   // Returns common headers used for each request with additional
   // headers. Throws an error when the token is missing, which is a required
   // authorization header.
-  headers(headers) {
+  headers(headers, raiseIfMissing = true) {
     return Object.assign({
-      Authorization: `Token token=${this.getToken()}`,
+      Authorization: `Token token=${this.getToken(raiseIfMissing)}`,
       'User-Agent': this.userAgent()
     }, headers);
   }
@@ -144,12 +144,13 @@ export class PercyClient {
   // Performs a POST request to a JSON API endpoint with appropriate headers.
   post(path, body = {}, {
     ...meta
-  } = {}) {
+  } = {}, customHeaders = {}, raiseIfMissing = true) {
     return logger.measure('client:post', meta.identifier || 'Unknown', meta, () => {
       return request(`${this.apiUrl}/${path}`, {
         headers: this.headers({
-          'Content-Type': 'application/vnd.api+json'
-        }),
+          'Content-Type': 'application/vnd.api+json',
+          ...customHeaders
+        }, raiseIfMissing),
         method: 'POST',
         body,
         meta
@@ -735,6 +736,58 @@ export class PercyClient {
       ...meta
     });
   }
+
+  // Performs a review action (approve, unapprove, reject) on a specific build.
+  // This function handles the common logic for sending review requests.
+  async reviewBuild(buildId, action, username, accessKey) {
+    validateId('build', buildId);
+    this.log.debug(`Sending ${action} action for build ${buildId}...`);
+    const requestBody = {
+      data: {
+        attributes: {
+          action: action
+        },
+        relationships: {
+          build: {
+            data: {
+              type: 'builds',
+              id: buildId
+            }
+          }
+        },
+        type: 'reviews'
+      }
+    };
+
+    // For the review action, we use accessKey and username in custom headers
+    // and do not require a project token.
+    return this.post('reviews', requestBody, {
+      identifier: `build.${action}`
+    }, {
+      Authorization: `Basic ${base64encode(`${username}:${accessKey}`)}`
+    }, false);
+  }
+  async approveBuild(buildId, username, accessKey) {
+    return this.reviewBuild(buildId, 'approve', username, accessKey);
+  }
+  async unapproveBuild(buildId, username, accessKey) {
+    return this.reviewBuild(buildId, 'unapprove', username, accessKey);
+  }
+  async rejectBuild(buildId, username, accessKey) {
+    return this.reviewBuild(buildId, 'reject', username, accessKey);
+  }
+  async deleteBuild(buildId, username, accessKey) {
+    validateId('build', buildId);
+    this.log.debug(`Sending Delete action for build ${buildId}...`);
+
+    // For the delete action, we use accessKey and username in custom headers
+    // and do not require a project token.
+    return this.post(`builds/${buildId}/delete`, {}, {
+      identifier: 'build.delete'
+    }, {
+      Authorization: `Basic ${base64encode(`${username}:${accessKey}`)}`
+    }, false);
+  }
   mayBeLogUploadSize(contentSize, meta = {}) {
     if (contentSize >= 25 * 1024 * 1024) {
       this.log.error('Uploading resource above 25MB might fail the build...', meta);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/client",
-  "version": "1.31.1-beta.0",
+  "version": "1.31.1-beta.2",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -33,10 +33,10 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/env": "1.31.1-beta.0",
-    "@percy/logger": "1.31.1-beta.0",
+    "@percy/env": "1.31.1-beta.2",
+    "@percy/logger": "1.31.1-beta.2",
     "pac-proxy-agent": "^7.0.2",
     "pako": "^2.1.0"
   },
-  "gitHead": "0bd4ee85db05f5adb8376d1ef09627c04cff5fb1"
+  "gitHead": "809b770761a7a5ad0044e462218452e920a4d1f0"
 }