vest 4.2.1 → 4.3.0

package/dist/umd/vest.development.js

@@ -61,8 +61,13 @@
       return isNumeric(value) && isNumeric(gt) && Number(value) > Number(gt);
   }
 
+  function numberEquals(value, eq) {
+      return isNumeric(value) && isNumeric(eq) && Number(value) === Number(eq);
+  }
+  var numberNotEquals = bindNot(numberEquals);
+
   function greaterThanOrEquals(value, gte) {
-      return isNumeric(value) && isNumeric(gte) && Number(value) >= Number(gte);
+      return numberEquals(value, gte) || greaterThan(value, gte);
   }
 
   // The module is named "isArrayValue" since it
@@ -85,8 +90,12 @@
   }
   var notInside = bindNot(inside);
 
+  function lessThan(value, lt) {
+      return isNumeric(value) && isNumeric(lt) && Number(value) < Number(lt);
+  }
+
   function lessThanOrEquals(value, lte) {
-      return isNumeric(value) && isNumeric(lte) && Number(value) <= Number(lte);
+      return numberEquals(value, lte) || lessThan(value, lte);
   }
 
   function isBetween(value, min, max) {
@@ -160,12 +169,8 @@
   var isNotNaN = bindNot(isNaN$1);
 
   function isNegative(value) {
-      if (isNumeric(value)) {
-          return Number(value) < 0;
-      }
-      return false;
+      return lessThan(value, 0);
   }
-  var isPositive = bindNot(isNegative);
 
   /**
    * Validates that a given value is an odd number
@@ -177,6 +182,10 @@
       return false;
   };
 
+  function isPositive(value) {
+      return greaterThan(value, 0);
+  }
+
   var isNotString = bindNot(isStringValue);
 
   function isTruthy(value) {
@@ -197,10 +206,6 @@
   }
   var isNotValueOf = bindNot(isValueOf);
 
-  function lessThan(value, lt) {
-      return isNumeric(value) && isNumeric(lt) && Number(value) < Number(lt);
-  }
-
   function longerThan(value, arg1) {
       return value.length > Number(arg1);
   }
@@ -222,11 +227,6 @@
   }
   var notMatches = bindNot(matches);
 
-  function numberEquals(value, eq) {
-      return isNumeric(value) && isNumeric(eq) && Number(value) === Number(eq);
-  }
-  var numberNotEquals = bindNot(numberEquals);
-
   function condition(value, callback) {
       try {
           return callback(value);
@@ -343,16 +343,18 @@
       return (_a = optionalFunctionValue(callback)) !== null && _a !== void 0 ? _a : defaultValue;
   }
 
-  /**
-   * Throws a timed out error.
-   */
-  function throwError(devMessage, productionMessage) {
-      throw new Error(devMessage );
-  }
-  function throwErrorDeferred(devMessage, productionMessage) {
-      setTimeout(function () {
-          throwError(devMessage);
-      }, 0);
+  function invariant(condition, 
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  message) {
+      if (condition) {
+          return;
+      }
+      // If message is a string object (rather than string literal)
+      // Throw the value directly as a string
+      // Alternatively, throw an error with the message
+      throw message instanceof String
+          ? message.valueOf()
+          : new Error(message ? optionalFunctionValue(message) : message);
   }
 
   // eslint-disable-next-line max-lines-per-function
@@ -365,8 +367,8 @@
           useX: useX
       };
       function useX(errorMessage) {
-          var _a;
-          return ((_a = storage.ctx) !== null && _a !== void 0 ? _a : throwError(defaultTo(errorMessage, 'Context was used after it was closed')));
+          invariant(storage.ctx, defaultTo(errorMessage, 'Context was used after it was closed'));
+          return storage.ctx;
       }
       function run(ctxRef, fn) {
           var _a;
@@ -514,10 +516,7 @@
   }
   function validateResult(result) {
       // if result is boolean, or if result.pass is boolean
-      if (isBoolean(result) || (result && isBoolean(result.pass))) {
-          return;
-      }
-      throwError('Incorrect return value for rule: ' + JSON.stringify(result));
+      invariant(isBoolean(result) || (result && isBoolean(result.pass)), 'Incorrect return value for rule: ' + JSON.stringify(result));
   }
 
   function enforceEager(value) {
@@ -546,15 +545,9 @@
               var transformedResult = transformResult.apply(void 0, __spreadArray([ctx.run({ value: value }, function () { return rule.apply(void 0, __spreadArray([value], args, false)); }),
                   ruleName,
                   value], args, false));
-              if (!transformedResult.pass) {
-                  if (isEmpty(transformedResult.message)) {
-                      throwError("enforce/".concat(ruleName, " failed with ").concat(JSON.stringify(value)));
-                  }
-                  else {
-                      // Explicitly throw a string so that vest.test can pick it up as the validation error message
-                      throw transformedResult.message;
-                  }
-              }
+              invariant(transformedResult.pass, isEmpty(transformedResult.message)
+                  ? "enforce/".concat(ruleName, " failed with ").concat(JSON.stringify(value))
+                  : new String(transformedResult.message));
               return target;
           };
       }
@@ -1158,6 +1151,12 @@
       };
   }
 
+  function deferThrow(message) {
+      setTimeout(function () {
+          throw new Error(message);
+      }, 0);
+  }
+
   function usePath() {
       var context$1 = context.useX();
       return context$1.testCursor.getCursor();
@@ -1203,7 +1202,7 @@
           current[key] = testObject;
       }
       else {
-          throwErrorDeferred("Encountered the same test key \"".concat(key, "\" twice. This may lead to tests overriding each other's results, or to tests being unexpectedly omitted."));
+          deferThrow("Encountered the same test key \"".concat(key, "\" twice. This may lead to tests overriding each other's results, or to tests being unexpectedly omitted."));
       }
   }
 
@@ -1236,6 +1235,112 @@
       Severity["WARNINGS"] = "warnings";
       Severity["ERRORS"] = "errors";
   })(Severity || (Severity = {}));
+  var SeverityCount;
+  (function (SeverityCount) {
+      SeverityCount["ERROR_COUNT"] = "errorCount";
+      SeverityCount["WARN_COUNT"] = "warnCount";
+  })(SeverityCount || (SeverityCount = {}));
+
+  function nonMatchingFieldName(testObject, fieldName) {
+      return !!fieldName && !matchingFieldName(testObject, fieldName);
+  }
+  function matchingFieldName(testObject, fieldName) {
+      return !!(fieldName && testObject.fieldName === fieldName);
+  }
+
+  function either(a, b) {
+      return !!a !== !!b;
+  }
+
+  /**
+   * Checks that a given test object matches the currently specified severity level
+   */
+  function nonMatchingSeverityProfile(severity, testObject) {
+      return either(severity === Severity.WARNINGS, testObject.warns());
+  }
+
+  /**
+   * Determines whether a certain test profile has failures.
+   */
+  function hasFailuresLogic(testObject, severityKey, fieldName) {
+      if (!testObject.hasFailures()) {
+          return false;
+      }
+      if (nonMatchingFieldName(testObject, fieldName)) {
+          return false;
+      }
+      if (nonMatchingSeverityProfile(severityKey, testObject)) {
+          return false;
+      }
+      return true;
+  }
+
+  function hasErrors(fieldName) {
+      return has(Severity.ERRORS, fieldName);
+  }
+  function hasWarnings(fieldName) {
+      return has(Severity.WARNINGS, fieldName);
+  }
+  function has(severityKey, fieldName) {
+      var testObjects = useTestsFlat();
+      return testObjects.some(function (testObject) {
+          return hasFailuresLogic(testObject, severityKey, fieldName);
+      });
+  }
+
+  // eslint-disable-next-line max-statements, complexity
+  function isValid(fieldName) {
+      if (fieldIsOmitted(fieldName)) {
+          return true;
+      }
+      if (hasErrors(fieldName)) {
+          return false;
+      }
+      var testObjects = useTestsFlat();
+      if (isEmpty(testObjects)) {
+          return false;
+      }
+      if (fieldDoesNotExist(fieldName)) {
+          return false;
+      }
+      if (hasNonOptionalIncomplete(fieldName)) {
+          return false;
+      }
+      return noMissingTests(fieldName);
+  }
+  function fieldIsOmitted(fieldName) {
+      var omittedFields = useOmittedFields();
+      if (!fieldName) {
+          return false;
+      }
+      return !!omittedFields[fieldName];
+  }
+  function hasNonOptionalIncomplete(fieldName) {
+      var optionalFields = useOptionalFields()[0];
+      return isNotEmpty(useAllIncomplete().filter(function (testObject) {
+          if (nonMatchingFieldName(testObject, fieldName)) {
+              return false;
+          }
+          return optionalFields[testObject.fieldName] !== true;
+      }));
+  }
+  function fieldDoesNotExist(fieldName) {
+      var testObjects = useTestsFlat();
+      return (!!fieldName &&
+          !testObjects.find(function (testObject) { return testObject.fieldName === fieldName; }));
+  }
+  function noMissingTests(fieldName) {
+      var testObjects = useTestsFlat();
+      var optionalFields = useOptionalFields()[0];
+      return testObjects.every(function (testObject) {
+          if (nonMatchingFieldName(testObject, fieldName)) {
+              return true;
+          }
+          return (optionalFields[testObject.fieldName] === true ||
+              testObject.isTested() ||
+              testObject.isOmitted());
+      });
+  }
 
   /**
    * Reads the testObjects list and gets full validation result from it.
@@ -1244,20 +1349,35 @@
       var testObjects = useTestsFlat();
       var summary = assign(baseStats(), {
           groups: {},
-          tests: {}
+          tests: {},
+          valid: false
       });
-      appendSummary(testObjects);
+      testObjects.reduce(function (summary, testObject) {
+          appendToTest(summary.tests, testObject);
+          appendToGroup(summary.groups, testObject);
+          return summary;
+      }, summary);
+      summary.valid = isValid();
       return countFailures(summary);
-      function appendSummary(testObjects) {
-          testObjects.forEach(function (testObject) {
-              var fieldName = testObject.fieldName, groupName = testObject.groupName;
-              summary.tests[fieldName] = genTestObject(summary.tests, testObject);
-              if (groupName) {
-                  summary.groups[groupName] = summary.groups[groupName] || {};
-                  summary.groups[groupName][fieldName] = genTestObject(summary.groups[groupName], testObject);
-              }
-          });
+  }
+  function appendToTest(tests, testObject) {
+      tests[testObject.fieldName] = appendTestObject(tests, testObject);
+      // If `valid` is false to begin with, keep it that way. Otherwise, assess.
+      tests[testObject.fieldName].valid =
+          tests[testObject.fieldName].valid === false
+              ? false
+              : isValid(testObject.fieldName);
+  }
+  /**
+   * Appends to a group object if within a group
+   */
+  function appendToGroup(groups, testObject) {
+      var groupName = testObject.groupName;
+      if (!groupName) {
+          return;
       }
+      groups[groupName] = groups[groupName] || {};
+      groups[groupName][testObject.fieldName] = appendTestObject(groups[groupName], testObject);
   }
   /**
    * Counts the failed tests and adds global counters
@@ -1270,29 +1390,36 @@
       }
       return summary;
   }
+  /**
+   * Appends the test to a results object
+   */
   // eslint-disable-next-line max-statements
-  function genTestObject(summaryKey, testObject) {
+  function appendTestObject(summaryKey, testObject) {
       var fieldName = testObject.fieldName, message = testObject.message;
       summaryKey[fieldName] = summaryKey[fieldName] || baseStats();
       var testKey = summaryKey[fieldName];
       if (testObject.isNonActionable())
           return testKey;
       summaryKey[fieldName].testCount++;
-      // Adds to severity group
-      function addTo(severity) {
-          var countKey = severity === Severity.ERRORS ? 'errorCount' : 'warnCount';
-          testKey[countKey]++;
-          if (message) {
-              testKey[severity] = (testKey[severity] || []).concat(message);
-          }
-      }
       if (testObject.isFailing()) {
-          addTo(Severity.ERRORS);
+          incrementFailures(Severity.ERRORS);
       }
       else if (testObject.isWarning()) {
-          addTo(Severity.WARNINGS);
+          incrementFailures(Severity.WARNINGS);
       }
       return testKey;
+      function incrementFailures(severity) {
+          var countKey = getCountKey(severity);
+          testKey[countKey]++;
+          if (message) {
+              testKey[severity] = (testKey[severity] || []).concat(message);
+          }
+      }
+  }
+  function getCountKey(severity) {
+      return severity === Severity.ERRORS
+          ? SeverityCount.ERROR_COUNT
+          : SeverityCount.WARN_COUNT;
   }
   function baseStats() {
       return {
@@ -1302,24 +1429,6 @@
       };
   }
 
-  function nonMatchingFieldName(testObject, fieldName) {
-      return !!fieldName && !matchingFieldName(testObject, fieldName);
-  }
-  function matchingFieldName(testObject, fieldName) {
-      return !!(fieldName && testObject.fieldName === fieldName);
-  }
-
-  function either(a, b) {
-      return !!a !== !!b;
-  }
-
-  /**
-   * Checks that a given test object matches the currently specified severity level
-   */
-  function nonMatchingSeverityProfile(severity, testObject) {
-      return either(severity === Severity.WARNINGS, testObject.warns());
-  }
-
   function collectFailureMessages(severity, testObjects, options) {
       var _a;
       if (options === void 0) { options = {}; }
@@ -1387,9 +1496,7 @@
    * Gets failure messages by group.
    */
   function getByGroup(severityKey, group, fieldName) {
-      if (!group) {
-          throwError("get".concat(severityKey[0].toUpperCase()).concat(severityKey.slice(1), "ByGroup requires a group name. Received `").concat(group, "` instead."));
-      }
+      invariant(group, "get".concat(severityKey[0].toUpperCase()).concat(severityKey.slice(1), "ByGroup requires a group name. Received `").concat(group, "` instead."));
       var testObjects = useTestsFlat();
       return collectFailureMessages(severityKey, testObjects, {
           group: group,
@@ -1397,35 +1504,6 @@
       });
   }
 
-  /**
-   * Determines whether a certain test profile has failures.
-   */
-  function hasFailuresLogic(testObject, severityKey, fieldName) {
-      if (!testObject.hasFailures()) {
-          return false;
-      }
-      if (nonMatchingFieldName(testObject, fieldName)) {
-          return false;
-      }
-      if (nonMatchingSeverityProfile(severityKey, testObject)) {
-          return false;
-      }
-      return true;
-  }
-
-  function hasErrors(fieldName) {
-      return has(Severity.ERRORS, fieldName);
-  }
-  function hasWarnings(fieldName) {
-      return has(Severity.WARNINGS, fieldName);
-  }
-  function has(severityKey, fieldName) {
-      var testObjects = useTestsFlat();
-      return testObjects.some(function (testObject) {
-          return hasFailuresLogic(testObject, severityKey, fieldName);
-      });
-  }
-
   function hasErrorsByGroup(groupName, fieldName) {
       return hasByGroup(Severity.ERRORS, groupName, fieldName);
   }
@@ -1444,58 +1522,6 @@
       });
   }
 
-  // eslint-disable-next-line max-statements, complexity
-  function isValid(result, fieldName) {
-      if (fieldIsOmitted(fieldName)) {
-          return true;
-      }
-      if (result.hasErrors(fieldName)) {
-          return false;
-      }
-      var testObjects = useTestsFlat();
-      if (isEmpty(testObjects)) {
-          return false;
-      }
-      if (fieldDoesNotExist(result, fieldName)) {
-          return false;
-      }
-      if (hasNonOptionalIncomplete(fieldName)) {
-          return false;
-      }
-      return noMissingTests(fieldName);
-  }
-  function fieldIsOmitted(fieldName) {
-      var omittedFields = useOmittedFields();
-      if (!fieldName) {
-          return false;
-      }
-      return !!omittedFields[fieldName];
-  }
-  function hasNonOptionalIncomplete(fieldName) {
-      var optionalFields = useOptionalFields()[0];
-      return isNotEmpty(useAllIncomplete().filter(function (testObject) {
-          if (nonMatchingFieldName(testObject, fieldName)) {
-              return false;
-          }
-          return optionalFields[testObject.fieldName] !== true;
-      }));
-  }
-  function fieldDoesNotExist(result, fieldName) {
-      return !!fieldName && isEmpty(result.tests[fieldName]);
-  }
-  function noMissingTests(fieldName) {
-      var testObjects = useTestsFlat();
-      var optionalFields = useOptionalFields()[0];
-      return testObjects.every(function (testObject) {
-          if (nonMatchingFieldName(testObject, fieldName)) {
-              return true;
-          }
-          return (optionalFields[testObject.fieldName] === true ||
-              testObject.isTested() ||
-              testObject.isOmitted());
-      });
-  }
-
   var cache$1 = createCache(20);
   function produceSuiteResult() {
       var testObjects = useTestsFlat();
@@ -1511,9 +1537,7 @@
               hasErrorsByGroup: context.bind(ctxRef, hasErrorsByGroup),
               hasWarnings: context.bind(ctxRef, hasWarnings),
               hasWarningsByGroup: context.bind(ctxRef, hasWarningsByGroup),
-              isValid: context.bind(ctxRef, function (fieldName) {
-                  return isValid(produceSuiteResult(), fieldName);
-              }),
+              isValid: context.bind(ctxRef, isValid),
               suiteName: suiteName
           });
       }));
@@ -1722,9 +1746,7 @@
   }
   function useBus() {
       var context$1 = context.useX();
-      if (!context$1.bus) {
-          throwError();
-      }
+      invariant(context$1.bus);
       return context$1.bus;
   }
   var Events;
@@ -1743,9 +1765,7 @@
           args[_i] = arguments[_i];
       }
       var _a = args.reverse(), suiteCallback = _a[0], suiteName = _a[1];
-      if (!isFunction(suiteCallback)) {
-          throwError('vest.create: Expected callback to be a function.');
-      }
+      invariant(isFunction(suiteCallback), 'vest.create: Expected callback to be a function.');
       // Event bus initialization
       var bus = initBus();
       // State initialization
@@ -1800,9 +1820,7 @@
    * })
    */
   function each(list, callback) {
-      if (!isFunction(callback)) {
-          throwError('each callback must be a function');
-      }
+      invariant(isFunction(callback), 'each callback must be a function');
       isolate({ type: IsolateTypes.EACH }, function () {
           list.forEach(function (arg, index) {
               callback(arg, index);
@@ -1999,19 +2017,15 @@
    * });
    */
   function group(groupName, tests) {
-      if (!isStringValue(groupName)) {
-          throwGroupError('name must be a string');
-      }
-      if (!isFunction(tests)) {
-          throwGroupError('callback must be a function');
-      }
+      invariant(isStringValue(groupName), groupErrorMsg('name must be a string'));
+      invariant(isFunction(tests), groupErrorMsg('callback must be a function'));
       // Running with the context applied
       isolate({ type: IsolateTypes.GROUP }, function () {
           context.run({ groupName: groupName }, tests);
       });
   }
-  function throwGroupError(error) {
-      throwError("Wrong arguments passed to group. Group ".concat(error, "."));
+  function groupErrorMsg(error) {
+      return "Wrong arguments passed to group. Group ".concat(error, ".");
   }
 
   function include(fieldName) {
@@ -2220,7 +2234,7 @@
           }
       }
       catch (e) {
-          throwError("Unexpected error encountered during test registration.\n      Test Object: ".concat(JSON.stringify(testObject), ".\n      Error: ").concat(e, "."));
+          throw new Error("Unexpected error encountered during test registration.\n      Test Object: ".concat(JSON.stringify(testObject), ".\n      Error: ").concat(e, "."));
       }
   }
 
@@ -2247,7 +2261,7 @@
           useSetTestAtCursor(nextTest_1);
           return nextTest_1;
       }
-      if (shouldPurgePrevTest(prevTest, newTestObject)) {
+      if (testReorderDetected(prevTest, newTestObject)) {
           throwTestOrderError(prevTest, newTestObject);
           removeAllNextTestsInIsolate();
           // Need to see if this has any effect at all.
@@ -2284,14 +2298,14 @@
       var cursorPath = usePath();
       return valueAtPath(tests, cursorPath);
   }
-  function shouldPurgePrevTest(prevTest, newTest) {
+  function testReorderDetected(prevTest, newTest) {
       return isNotEmpty(prevTest) && !isSameProfileTest(prevTest, newTest);
   }
   function throwTestOrderError(prevTest, newTestObject) {
       if (shouldAllowReorder()) {
           return;
       }
-      throwErrorDeferred("Vest Critical Error: Tests called in different order than previous run.\n    expected: ".concat(prevTest.fieldName, "\n    received: ").concat(newTestObject.fieldName, "\n    This can happen on one of two reasons:\n    1. You're using if/else statements to conditionally select tests. Instead, use \"skipWhen\".\n    2. You are iterating over a list of tests, and their order changed. Use \"each\" and a custom key prop so that Vest retains their state."));
+      deferThrow("Vest Critical Error: Tests called in different order than previous run.\n    expected: ".concat(prevTest.fieldName, "\n    received: ").concat(newTestObject.fieldName, "\n    This can happen on one of two reasons:\n    1. You're using if/else statements to conditionally select tests. Instead, use \"skipWhen\".\n    2. You are iterating over a list of tests, and their order changed. Use \"each\" and a custom key prop so that Vest retains their state."));
   }
   function handleKeyTest(key, newTestObject) {
       var prevTestByKey = usePrevTestByKey(key);
@@ -2305,12 +2319,13 @@
 
   // eslint-disable-next-line max-statements
   function registerPrevRunTest(testObject) {
-      var prevRunTest = useTestAtCursor(testObject);
       if (shouldSkipBasedOnMode(testObject)) {
-          moveForward();
           testObject.skip();
+          useTestAtCursor(testObject);
+          moveForward();
           return testObject;
       }
+      var prevRunTest = useTestAtCursor(testObject);
       if (isOmitted()) {
           prevRunTest.omit();
           moveForward();
@@ -2376,12 +2391,8 @@
           args[_i - 1] = arguments[_i];
       }
       var _a = (isFunction(args[1]) ? args : __spreadArray([undefined], args, true)), message = _a[0], testFn = _a[1], key = _a[2];
-      if (isNotString(fieldName)) {
-          throwIncompatibleParamsError('fieldName', 'string');
-      }
-      if (!isFunction(testFn)) {
-          throwIncompatibleParamsError('Test callback', 'function');
-      }
+      invariant(isStringValue(fieldName), incompatibleParamsError('fieldName', 'string'));
+      invariant(isFunction(testFn), incompatibleParamsError('Test callback', 'function'));
       var context$1 = context.useX();
       var testObject = new VestTest(fieldName, testFn, {
           message: message,
@@ -2402,8 +2413,8 @@
   var test = assign(testBase, {
       memo: bindTestMemo(testBase)
   });
-  function throwIncompatibleParamsError(name, expected) {
-      throwError("Incompatible params passed to test function. ".concat(name, " must be a ").concat(expected));
+  function incompatibleParamsError(name, expected) {
+      return "Incompatible params passed to test function. ".concat(name, " must be a ").concat(expected);
   }
 
   var ERROR_OUTSIDE_OF_TEST = "warn hook called outside of a test callback. It won't have an effect."
@@ -2413,13 +2424,11 @@
    */
   function warn() {
       var ctx = context.useX('warn ' + ERROR_HOOK_CALLED_OUTSIDE);
-      if (!ctx.currentTest) {
-          throwError(ERROR_OUTSIDE_OF_TEST);
-      }
+      invariant(ctx.currentTest, ERROR_OUTSIDE_OF_TEST);
       ctx.currentTest.warn();
   }
 
-  var VERSION = "4.2.1";
+  var VERSION = "4.3.0";
 
   exports.VERSION = VERSION;
   exports.context = context;