@percy/sdk-utils 1.10.4 → 1.12.0

package/dist/bundle.js

@@ -223,7 +223,7 @@
       return info.domScript;
     }
 
-    // error message, signal that Percy has been disabled.
+    // indicate that Percy has been disabled.
 
     async function postSnapshot(options, params) {
       let query = params ? `?${new URLSearchParams(params)}` : '';
@@ -238,6 +238,33 @@
       });
     }
 
+    // indicate that Percy has been disabled.
+
+    async function postComparison(options, params) {
+      let query = params ? `?${new URLSearchParams(params)}` : '';
+      await request.post(`/percy/comparison${query}`, options).catch(err => {
+        var _err$response, _err$response$body, _err$response$body$bu;
+
+        if ((_err$response = err.response) !== null && _err$response !== void 0 && (_err$response$body = _err$response.body) !== null && _err$response$body !== void 0 && (_err$response$body$bu = _err$response$body.build) !== null && _err$response$body$bu !== void 0 && _err$response$body$bu.error) {
+          info.enabled = false;
+        } else {
+          throw err;
+        }
+      });
+    }
+
+    // will be flushed. Does nothing when Percy is not enabled.
+
+    async function flushSnapshots(options) {
+      if (info.enabled) {
+        // accept one or more snapshot names
+        options && (options = [].concat(options).map(o => typeof o === 'string' ? {
+          name: o
+        } : o));
+        await request.post('/percy/flush', options);
+      }
+    }
+
     var index = /*#__PURE__*/Object.freeze({
       __proto__: null,
       logger: logger,
@@ -247,14 +274,18 @@
       waitForPercyIdle: waitForPercyIdle,
       fetchPercyDOM: fetchPercyDOM,
       postSnapshot: postSnapshot,
+      postComparison: postComparison,
+      flushSnapshots: flushSnapshots,
       'default': index
     });
 
     exports["default"] = index;
     exports.fetchPercyDOM = fetchPercyDOM;
+    exports.flushSnapshots = flushSnapshots;
     exports.isPercyEnabled = isPercyEnabled;
     exports.logger = logger;
     exports.percy = info;
+    exports.postComparison = postComparison;
     exports.postSnapshot = postSnapshot;
     exports.request = request;
     exports.waitForPercyIdle = waitForPercyIdle;

package/dist/flush-snapshots.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.flushSnapshots = flushSnapshots;
+
+var _percyInfo = _interopRequireDefault(require("./percy-info.js"));
+
+var _request = _interopRequireDefault(require("./request.js"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Posts to the local Percy server one or more snapshots to flush. Given no arguments, all snapshots
+// will be flushed. Does nothing when Percy is not enabled.
+async function flushSnapshots(options) {
+  if (_percyInfo.default.enabled) {
+    // accept one or more snapshot names
+    options && (options = [].concat(options).map(o => typeof o === 'string' ? {
+      name: o
+    } : o));
+    await _request.default.post('/percy/flush', options);
+  }
+}
+
+var _default = flushSnapshots;
+exports.default = _default;

package/dist/index.js

@@ -10,6 +10,12 @@ Object.defineProperty(exports, "fetchPercyDOM", {
     return _percyDom.default;
   }
 });
+Object.defineProperty(exports, "flushSnapshots", {
+  enumerable: true,
+  get: function () {
+    return _flushSnapshots.default;
+  }
+});
 Object.defineProperty(exports, "isPercyEnabled", {
   enumerable: true,
   get: function () {
@@ -28,6 +34,12 @@ Object.defineProperty(exports, "percy", {
     return _percyInfo.default;
   }
 });
+Object.defineProperty(exports, "postComparison", {
+  enumerable: true,
+  get: function () {
+    return _postComparison.default;
+  }
+});
 Object.defineProperty(exports, "postSnapshot", {
   enumerable: true,
   get: function () {
@@ -61,6 +73,10 @@ var _percyDom = _interopRequireDefault(require("./percy-dom.js"));
 
 var _postSnapshot = _interopRequireDefault(require("./post-snapshot.js"));
 
+var _postComparison = _interopRequireDefault(require("./post-comparison.js"));
+
+var _flushSnapshots = _interopRequireDefault(require("./flush-snapshots.js"));
+
 var _default = _interopRequireWildcard(require("./index.js"));
 
 exports.default = _default;

package/dist/post-comparison.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.postComparison = postComparison;
+
+var _percyInfo = _interopRequireDefault(require("./percy-info.js"));
+
+var _request = _interopRequireDefault(require("./request.js"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Post snapshot data to the CLI snapshot endpoint. If the endpoint responds with a build error,
+// indicate that Percy has been disabled.
+async function postComparison(options, params) {
+  let query = params ? `?${new URLSearchParams(params)}` : '';
+  await _request.default.post(`/percy/comparison${query}`, options).catch(err => {
+    var _err$response, _err$response$body, _err$response$body$bu;
+
+    if ((_err$response = err.response) !== null && _err$response !== void 0 && (_err$response$body = _err$response.body) !== null && _err$response$body !== void 0 && (_err$response$body$bu = _err$response$body.build) !== null && _err$response$body$bu !== void 0 && _err$response$body$bu.error) {
+      _percyInfo.default.enabled = false;
+    } else {
+      throw err;
+    }
+  });
+}
+
+var _default = postComparison;
+exports.default = _default;

package/dist/post-snapshot.js

@@ -12,8 +12,8 @@ var _request = _interopRequireDefault(require("./request.js"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-// Post snapshot data to the snapshot endpoint. If the snapshot endpoint responds with a closed
-// error message, signal that Percy has been disabled.
+// Post snapshot data to the CLI snapshot endpoint. If the endpoint responds with a build error,
+// indicate that Percy has been disabled.
 async function postSnapshot(options, params) {
   let query = params ? `?${new URLSearchParams(params)}` : '';
   await _request.default.post(`/percy/snapshot${query}`, options).catch(err => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/sdk-utils",
-  "version": "1.10.4",
+  "version": "1.12.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -50,5 +50,5 @@
       ]
     }
   },
-  "gitHead": "16a9a410bfcb8eab51b86a08cff12d8d35e4747e"
+  "gitHead": "4303b74df91f60e36065141289d2ef2277d1d6fc"
 }