@percy/sdk-utils 1.12.0 → 1.13.0

package/dist/bundle.js

@@ -12,15 +12,15 @@
       info: 1,
       warn: 2,
       error: 3
-    }; // Create a small logger util using the specified namespace
+    };
 
+    // Create a small logger util using the specified namespace
     function logger(namespace) {
       return Object.keys(LOG_LEVELS).reduce((ns, lvl) => Object.assign(ns, {
         [lvl]: function () {
           for (var _len = arguments.length, a = new Array(_len), _key = 0; _key < _len; _key++) {
             a[_key] = arguments[_key];
           }
-
           return logger.log(namespace, lvl, ...a);
         }
       }), {});
@@ -33,15 +33,16 @@
       },
       // Track and send/write logs for the specified namespace and log level
       log: (ns, lvl, msg, meta) => {
-        let err = typeof msg !== 'string' && (lvl === 'error' || lvl === 'debug'); // check if the specific level is within the local loglevel range
+        let err = typeof msg !== 'string' && (lvl === 'error' || lvl === 'debug');
 
+        // check if the specific level is within the local loglevel range
         if (LOG_LEVELS[lvl] != null && LOG_LEVELS[lvl] >= LOG_LEVELS[logger.loglevel()]) {
           let debug = logger.loglevel() === 'debug';
-          let label = debug ? `percy:${ns}` : 'percy'; // colorize the label when possible for consistency with the CLI logger
+          let label = debug ? `percy:${ns}` : 'percy';
 
+          // colorize the label when possible for consistency with the CLI logger
           if (!process.env.__PERCY_BROWSERIFIED__) label = `\u001b[95m${label}\u001b[39m`;
           msg = `[${label}] ${err && debug && msg.stack || msg}`;
-
           if (process.env.__PERCY_BROWSERIFIED__) {
             // use console[warn|error|log] in browsers
             console[['warn', 'error'].includes(lvl) ? lvl : 'log'](msg);
@@ -64,89 +65,78 @@
         get major() {
           return this[0] || 0;
         },
-
         get minor() {
           return this[1] || 0;
         },
-
         get patch() {
           return this[2] || 0;
         },
-
         get prerelease() {
           return this[3];
         },
-
         get build() {
           return this[4];
         },
-
         toString() {
           return str;
         }
-
       });
-    } // private version cache
-
+    }
 
-    let version = toVersion(); // contains local percy info
+    // private version cache
+    let version = toVersion();
 
+    // contains local percy info
     const info = {
       // get or set the CLI API address via the environment
       get address() {
         return process.env.PERCY_SERVER_ADDRESS || 'http://localhost:5338';
       },
-
       set address(addr) {
         return process.env.PERCY_SERVER_ADDRESS = addr;
       },
-
       // version information
       get version() {
         return version;
       },
-
       set version(v) {
         return version = toVersion(v);
       }
-
     };
 
+    // Helper to send a request to the local CLI API
     async function request(path) {
       let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-      let response = await request.fetch(`${info.address}${path}`, options); // maybe parse response body as json
+      let response = await request.fetch(`${info.address}${path}`, options);
 
+      // maybe parse response body as json
       if (typeof response.body === 'string' && response.headers['content-type'] === 'application/json') {
         try {
           response.body = JSON.parse(response.body);
         } catch (e) {}
-      } // throw an error if status is not ok
-
+      }
 
+      // throw an error if status is not ok
       if (!(response.status >= 200 && response.status < 300)) {
         throw Object.assign(new Error(), {
-          message: response.body.error ||
-          /* istanbul ignore next: in tests, there's always an error message */
+          message: response.body.error || /* istanbul ignore next: in tests, there's always an error message */
           `${response.status} ${response.statusText}`,
           response
         });
       }
-
       return response;
     }
-
     request.post = function post(url, json) {
       return request(url, {
         method: 'POST',
         body: JSON.stringify(json)
       });
-    }; // environment specific implementation
-
+    };
 
+    // environment specific implementation
     if (process.env.__PERCY_BROWSERIFIED__) {
       // use window.fetch in browsers
       const winFetch = window.fetch;
-
       request.fetch = async function fetch(url, options) {
         let response = await winFetch(url, options);
         return {
@@ -177,11 +167,11 @@
       };
     }
 
+    // Check if Percy is enabled using the healthcheck endpoint
     async function isPercyEnabled() {
       if (info.enabled == null) {
         let log = logger('utils');
         let error;
-
         try {
           let response = await request('/percy/healthcheck');
           info.version = response.headers['x-percy-core-version'];
@@ -191,7 +181,6 @@
           info.enabled = false;
           error = e;
         }
-
         if (info.enabled && info.version.major !== 1) {
           log.info('Unsupported Percy CLI version, disabling snapshots');
           log.debug(`Found version: ${info.version}`);
@@ -201,7 +190,6 @@
           log.debug(error);
         }
       }
-
       return info.enabled;
     }
 
@@ -214,22 +202,21 @@
       }
     }
 
+    // Fetch and cache the @percy/dom script
     async function fetchPercyDOM() {
       if (info.domScript == null) {
         let response = await request('/percy/dom.js');
         info.domScript = response.body;
       }
-
       return info.domScript;
     }
 
+    // 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.post(`/percy/snapshot${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 {
@@ -238,13 +225,12 @@
       });
     }
 
+    // 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.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 {
@@ -253,8 +239,8 @@
       });
     }
 
+    // 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 (info.enabled) {
         // accept one or more snapshot names

package/dist/flush-snapshots.js

@@ -5,13 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 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) {
@@ -23,6 +19,5 @@ async function flushSnapshots(options) {
     await _request.default.post('/percy/flush', options);
   }
 }
-
 var _default = flushSnapshots;
 exports.default = _default;

package/dist/index.js

@@ -58,31 +58,17 @@ Object.defineProperty(exports, "waitForPercyIdle", {
     return _percyIdle.default;
   }
 });
-
 var _logger = _interopRequireDefault(require("./logger.js"));
-
 var _percyInfo = _interopRequireDefault(require("./percy-info.js"));
-
 var _request = _interopRequireDefault(require("./request.js"));
-
 var _percyEnabled = _interopRequireDefault(require("./percy-enabled.js"));
-
 var _percyIdle = _interopRequireDefault(require("./percy-idle.js"));
-
 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;
-
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/logger.js

@@ -11,14 +11,14 @@ const LOG_LEVELS = {
   info: 1,
   warn: 2,
   error: 3
-}; // Create a small logger util using the specified namespace
+};
 
+// Create a small logger util using the specified namespace
 function logger(namespace) {
   return Object.keys(LOG_LEVELS).reduce((ns, lvl) => Object.assign(ns, {
     [lvl]: (...a) => logger.log(namespace, lvl, ...a)
   }), {});
 }
-
 Object.assign(logger, {
   // Set and/or return the local loglevel
   loglevel: (lvl = logger.loglevel.lvl) => {
@@ -26,15 +26,16 @@ Object.assign(logger, {
   },
   // Track and send/write logs for the specified namespace and log level
   log: (ns, lvl, msg, meta) => {
-    let err = typeof msg !== 'string' && (lvl === 'error' || lvl === 'debug'); // check if the specific level is within the local loglevel range
+    let err = typeof msg !== 'string' && (lvl === 'error' || lvl === 'debug');
 
+    // check if the specific level is within the local loglevel range
     if (LOG_LEVELS[lvl] != null && LOG_LEVELS[lvl] >= LOG_LEVELS[logger.loglevel()]) {
       let debug = logger.loglevel() === 'debug';
-      let label = debug ? `percy:${ns}` : 'percy'; // colorize the label when possible for consistency with the CLI logger
+      let label = debug ? `percy:${ns}` : 'percy';
 
+      // colorize the label when possible for consistency with the CLI logger
       if (!process.env.__PERCY_BROWSERIFIED__) label = `\u001b[95m${label}\u001b[39m`;
       msg = `[${label}] ${err && debug && msg.stack || msg}`;
-
       if (process.env.__PERCY_BROWSERIFIED__) {
         // use console[warn|error|log] in browsers
         console[['warn', 'error'].includes(lvl) ? lvl : 'log'](msg);

package/dist/percy-dom.js

@@ -5,22 +5,16 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 exports.fetchPercyDOM = fetchPercyDOM;
-
 var _percyInfo = _interopRequireDefault(require("./percy-info.js"));
-
 var _request = _interopRequireDefault(require("./request.js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 // Fetch and cache the @percy/dom script
 async function fetchPercyDOM() {
   if (_percyInfo.default.domScript == null) {
     let response = await (0, _request.default)('/percy/dom.js');
     _percyInfo.default.domScript = response.body;
   }
-
   return _percyInfo.default.domScript;
 }
-
 var _default = fetchPercyDOM;
 exports.default = _default;

package/dist/percy-enabled.js

@@ -5,21 +5,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 exports.isPercyEnabled = isPercyEnabled;
-
 var _percyInfo = _interopRequireDefault(require("./percy-info.js"));
-
 var _request = _interopRequireDefault(require("./request.js"));
-
 var _logger = _interopRequireDefault(require("./logger.js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 // Check if Percy is enabled using the healthcheck endpoint
 async function isPercyEnabled() {
   if (_percyInfo.default.enabled == null) {
     let log = (0, _logger.default)('utils');
     let error;
-
     try {
       let response = await (0, _request.default)('/percy/healthcheck');
       _percyInfo.default.version = response.headers['x-percy-core-version'];
@@ -29,7 +23,6 @@ async function isPercyEnabled() {
       _percyInfo.default.enabled = false;
       error = e;
     }
-
     if (_percyInfo.default.enabled && _percyInfo.default.version.major !== 1) {
       log.info('Unsupported Percy CLI version, disabling snapshots');
       log.debug(`Found version: ${_percyInfo.default.version}`);
@@ -39,9 +32,7 @@ async function isPercyEnabled() {
       log.debug(error);
     }
   }
-
   return _percyInfo.default.enabled;
 }
-
 var _default = isPercyEnabled;
 exports.default = _default;

package/dist/percy-idle.js

@@ -5,13 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 exports.waitForPercyIdle = waitForPercyIdle;
-
 var _request = _interopRequireDefault(require("./request.js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const RETRY_ERROR_CODES = ['ECONNRESET', 'ETIMEDOUT'];
-
 async function waitForPercyIdle() {
   try {
     return !!(await (0, _request.default)('/percy/idle'));
@@ -19,6 +15,5 @@ async function waitForPercyIdle() {
     return RETRY_ERROR_CODES.includes(e.code) && waitForPercyIdle();
   }
 }
-
 var _default = waitForPercyIdle;
 exports.default = _default;

package/dist/percy-info.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 // helper to create a version object from a string
 function toVersion(str) {
   str || (str = '0.0.0');
@@ -16,52 +15,43 @@ function toVersion(str) {
     get major() {
       return this[0] || 0;
     },
-
     get minor() {
       return this[1] || 0;
     },
-
     get patch() {
       return this[2] || 0;
     },
-
     get prerelease() {
       return this[3];
     },
-
     get build() {
       return this[4];
     },
-
     toString() {
       return str;
     }
-
   });
-} // private version cache
-
+}
 
-let version = toVersion(); // contains local percy info
+// private version cache
+let version = toVersion();
 
+// contains local percy info
 const info = {
   // get or set the CLI API address via the environment
   get address() {
     return process.env.PERCY_SERVER_ADDRESS || 'http://localhost:5338';
   },
-
   set address(addr) {
     return process.env.PERCY_SERVER_ADDRESS = addr;
   },
-
   // version information
   get version() {
     return version;
   },
-
   set version(v) {
     return version = toVersion(v);
   }
-
 };
 var _default = info;
 exports.default = _default;

package/dist/post-comparison.js

@@ -5,20 +5,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 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 {
@@ -26,6 +21,5 @@ async function postComparison(options, params) {
     }
   });
 }
-
 var _default = postComparison;
 exports.default = _default;

package/dist/post-snapshot.js

@@ -5,20 +5,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 exports.postSnapshot = postSnapshot;
-
 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 postSnapshot(options, params) {
   let query = params ? `?${new URLSearchParams(params)}` : '';
   await _request.default.post(`/percy/snapshot${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 {
@@ -26,6 +21,5 @@ async function postSnapshot(options, params) {
     }
   });
 }
-
 var _default = postSnapshot;
 exports.default = _default;

package/dist/request.js

@@ -5,50 +5,42 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 exports.request = request;
-
 var _percyInfo = _interopRequireDefault(require("./percy-info.js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
 // Helper to send a request to the local CLI API
 async function request(path, options = {}) {
-  let response = await request.fetch(`${_percyInfo.default.address}${path}`, options); // maybe parse response body as json
+  let response = await request.fetch(`${_percyInfo.default.address}${path}`, options);
 
+  // maybe parse response body as json
   if (typeof response.body === 'string' && response.headers['content-type'] === 'application/json') {
     try {
       response.body = JSON.parse(response.body);
     } catch (e) {}
-  } // throw an error if status is not ok
-
+  }
 
+  // throw an error if status is not ok
   if (!(response.status >= 200 && response.status < 300)) {
     throw Object.assign(new Error(), {
-      message: response.body.error ||
-      /* istanbul ignore next: in tests, there's always an error message */
+      message: response.body.error || /* istanbul ignore next: in tests, there's always an error message */
       `${response.status} ${response.statusText}`,
       response
     });
   }
-
   return response;
 }
-
 request.post = function post(url, json) {
   return request(url, {
     method: 'POST',
     body: JSON.stringify(json)
   });
-}; // environment specific implementation
-
+};
 
+// environment specific implementation
 if (process.env.__PERCY_BROWSERIFIED__) {
   // use window.fetch in browsers
   const winFetch = window.fetch;
-
   request.fetch = async function fetch(url, options) {
     let response = await winFetch(url, options);
     return {
@@ -78,6 +70,5 @@ if (process.env.__PERCY_BROWSERIFIED__) {
     });
   };
 }
-
 var _default = request;
 exports.default = _default;

package/package.json

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

package/test/client.js

@@ -31,31 +31,25 @@
         if (logger) helpers.logger.mock();
         await helpers.test('reset');
       },
-
       async test(cmd, arg) {
         let res = await utils.request.post(`/test/api/${cmd}`, arg);
         return res.body;
       },
-
       async get(what, map) {
         let res = await utils.request(`/test/${what}`);
         if (!map) map = what === 'logs' ? l => l.message : i => i;
         return Array.isArray(res.body[what]) ? res.body[what].map(map) : map(res.body);
       },
-
       get testSnapshotURL() {
         return `${utils.percy.address}/test/snapshot`;
       },
-
       logger: {
         __log__: utils.logger.log,
         loglevel: utils.logger.loglevel,
         stdout: [],
         stderr: [],
-
         mock() {
           helpers.logger.reset();
-
           utils.logger.log = (ns, lvl, msg) => {
             if (lvl === 'debug' && helpers.logger.loglevel.lvl !== 'debug') return;
             msg = `[percy${lvl === 'debug' ? `:${ns}` : ''}] ${msg}`;
@@ -63,13 +57,11 @@
             helpers.logger[io].push(msg);
           };
         },
-
         reset() {
           helpers.logger.stdout = [];
           helpers.logger.stderr = [];
           helpers.logger.loglevel('info');
         }
-
       }
     };
     var helpers_1 = helpers;