vest 4.2.0 → 4.2.1-dev-ee64be

package/dist/es/vest.development.js

@@ -1,8 +1,6 @@
 export { enforce } from 'n4s';
 import { createContext } from 'context';
 
-var assign = Object.assign;
-
 /**
  * @returns a unique numeric id.
  */
@@ -10,206 +8,76 @@ var genId = (function (n) { return function () {
     return "".concat(n++);
 }; })(0);
 
-function isFunction(value) {
-    return typeof value === 'function';
-}
-
-function optionalFunctionValue(value) {
-    var args = [];
-    for (var _i = 1; _i < arguments.length; _i++) {
-        args[_i - 1] = arguments[_i];
-    }
-    return isFunction(value) ? value.apply(void 0, args) : value;
-}
-
-function defaultTo(callback, defaultValue) {
-    var _a;
-    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 isStringValue(v) {
+    return String(v) === v;
 }
 
-// eslint-disable-next-line max-lines-per-function
-function createState(onStateChange) {
-    var state = {
-        references: []
-    };
-    var registrations = [];
-    return {
-        registerStateKey: registerStateKey,
-        reset: reset
-    };
-    /**
-     * Registers a new key in the state, takes the initial value (may be a function that returns the initial value), returns a function.
-     *
-     * @example
-     *
-     * const useColor = state.registerStateKey("blue");
-     *
-     * let [color, setColor] = useColor(); // -> ["blue", Function]
-     *
-     * setColor("green");
-     *
-     * useColor()[0]; -> "green"
-     */
-    function registerStateKey(initialState, onUpdate) {
-        var key = registrations.length;
-        registrations.push([initialState, onUpdate]);
-        return initKey(key, initialState);
-    }
-    function reset() {
-        var prev = current();
-        state.references = [];
-        registrations.forEach(function (_a, index) {
-            var initialValue = _a[0];
-            return initKey(index, initialValue, prev[index]);
-        });
-    }
-    function initKey(key, initialState, prevState) {
-        current().push();
-        set(key, optionalFunctionValue(initialState, prevState));
-        return function useStateKey() {
-            return [
-                current()[key],
-                function (nextState) {
-                    return set(key, optionalFunctionValue(nextState, current()[key]));
-                },
-            ];
-        };
-    }
-    function current() {
-        return state.references;
-    }
-    function set(index, value) {
-        var prevValue = state.references[index];
-        state.references[index] = value;
-        var _a = registrations[index], onUpdate = _a[1];
-        if (isFunction(onUpdate)) {
-            onUpdate(value, prevValue);
-        }
-        if (isFunction(onStateChange)) {
-            onStateChange();
+function bindNot(fn) {
+    return function () {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
         }
-    }
+        return !fn.apply(void 0, args);
+    };
 }
 
-var IsolateTypes;
-(function (IsolateTypes) {
-    IsolateTypes[IsolateTypes["DEFAULT"] = 0] = "DEFAULT";
-    IsolateTypes[IsolateTypes["SUITE"] = 1] = "SUITE";
-    IsolateTypes[IsolateTypes["EACH"] = 2] = "EACH";
-    IsolateTypes[IsolateTypes["SKIP_WHEN"] = 3] = "SKIP_WHEN";
-    IsolateTypes[IsolateTypes["OMIT_WHEN"] = 4] = "OMIT_WHEN";
-    IsolateTypes[IsolateTypes["GROUP"] = 5] = "GROUP";
-})(IsolateTypes || (IsolateTypes = {}));
+function isUndefined(value) {
+    return value === undefined;
+}
 
-function createStateRef(state, _a) {
-    var suiteId = _a.suiteId, suiteName = _a.suiteName;
-    return {
-        optionalFields: state.registerStateKey(function () { return ({}); }),
-        suiteId: state.registerStateKey(suiteId),
-        suiteName: state.registerStateKey(suiteName),
-        testCallbacks: state.registerStateKey(function () { return ({
-            fieldCallbacks: {},
-            doneCallbacks: []
-        }); }),
-        testObjects: state.registerStateKey(function (prev) {
-            return {
-                prev: prev ? prev.current : [],
-                current: []
-            };
-        })
-    };
+function shouldUseErrorAsMessage(message, error) {
+    // kind of cheating with this safe guard, but it does the job
+    return isUndefined(message) && isStringValue(error);
 }
 
 function asArray(possibleArg) {
     return [].concat(possibleArg);
 }
 
-function last(values) {
-    var valuesArray = asArray(values);
-    return valuesArray[valuesArray.length - 1];
+function lengthEquals(value, arg1) {
+    return value.length === Number(arg1);
 }
 
-function createCursor() {
-    var storage = {
-        cursor: []
-    };
-    function addLevel() {
-        storage.cursor.push(0);
-    }
-    function removeLevel() {
-        storage.cursor.pop();
-    }
-    function cursorAt() {
-        return last(storage.cursor);
-    }
-    function getCursor() {
-        return asArray(storage.cursor);
-    }
-    function next() {
-        storage.cursor[storage.cursor.length - 1]++;
-        return last(storage.cursor);
-    }
-    function reset() {
-        storage.cursor = [0];
-    }
-    reset();
-    return {
-        addLevel: addLevel,
-        cursorAt: cursorAt,
-        getCursor: getCursor,
-        next: next,
-        removeLevel: removeLevel,
-        reset: reset
-    };
+function longerThan(value, arg1) {
+    return value.length > Number(arg1);
 }
 
-var Modes;
-(function (Modes) {
-    Modes[Modes["ALL"] = 0] = "ALL";
-    Modes[Modes["EAGER"] = 1] = "EAGER";
-})(Modes || (Modes = {}));
-
-var context = createContext(function (ctxRef, parentContext) {
-    return parentContext
-        ? null
-        : assign({}, {
-            exclusion: {
-                tests: {},
-                groups: {}
-            },
-            inclusion: {},
-            isolate: {
-                type: IsolateTypes.DEFAULT,
-                keys: {
-                    current: {},
-                    prev: {}
-                }
-            },
-            mode: [Modes.ALL],
-            testCursor: createCursor()
-        }, ctxRef);
-});
-
-function bindNot(fn) {
-    return function () {
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments[_i];
-        }
-        return !fn.apply(void 0, args);
+/**
+ * Creates a cache function
+ */
+function createCache(maxSize) {
+    if (maxSize === void 0) { maxSize = 1; }
+    var cacheStorage = [];
+    var cache = function (deps, cacheAction) {
+        var cacheHit = cache.get(deps);
+        // cache hit is not null
+        if (cacheHit)
+            return cacheHit[1];
+        var result = cacheAction();
+        cacheStorage.unshift([deps.concat(), result]);
+        if (longerThan(cacheStorage, maxSize))
+            cacheStorage.length = maxSize;
+        return result;
+    };
+    // invalidate an item in the cache by its dependencies
+    cache.invalidate = function (deps) {
+        var index = findIndex(deps);
+        if (index > -1)
+            cacheStorage.splice(index, 1);
     };
+    // Retrieves an item from the cache.
+    cache.get = function (deps) {
+        return cacheStorage[findIndex(deps)] || null;
+    };
+    return cache;
+    function findIndex(deps) {
+        return cacheStorage.findIndex(function (_a) {
+            var cachedDeps = _a[0];
+            return lengthEquals(deps, cachedDeps.length) &&
+                deps.every(function (dep, i) { return dep === cachedDeps[i]; });
+        });
+    }
 }
 
 // The module is named "isArrayValue" since it
@@ -224,6 +92,28 @@ function isNull(value) {
 }
 var isNotNull = bindNot(isNull);
 
+function isFunction(value) {
+    return typeof value === 'function';
+}
+
+function optionalFunctionValue(value) {
+    var args = [];
+    for (var _i = 1; _i < arguments.length; _i++) {
+        args[_i - 1] = arguments[_i];
+    }
+    return isFunction(value) ? value.apply(void 0, args) : value;
+}
+
+function defaultTo(callback, defaultValue) {
+    var _a;
+    return (_a = optionalFunctionValue(callback)) !== null && _a !== void 0 ? _a : defaultValue;
+}
+
+function last(values) {
+    var valuesArray = asArray(values);
+    return valuesArray[valuesArray.length - 1];
+}
+
 // This is kind of a map/filter in one function.
 // Normally, behaves like a nested-array map,
 // but returning `null` will drop the element from the array
@@ -269,68 +159,79 @@ function getCurrent(array, path) {
     return current;
 }
 
-function isUndefined(value) {
-    return value === undefined;
-}
-
-function isNullish(value) {
-    return isNull(value) || isUndefined(value);
-}
-
-function isStringValue(v) {
-    return String(v) === v;
-}
-
-function shouldUseErrorAsMessage(message, error) {
-    // kind of cheating with this safe guard, but it does the job
-    return isUndefined(message) && isStringValue(error);
-}
-
-function lengthEquals(value, arg1) {
-    return value.length === Number(arg1);
-}
-
-function longerThan(value, arg1) {
-    return value.length > Number(arg1);
-}
+var assign = Object.assign;
 
-/**
- * Creates a cache function
- */
-function createCache(maxSize) {
-    if (maxSize === void 0) { maxSize = 1; }
-    var cacheStorage = [];
-    var cache = function (deps, cacheAction) {
-        var cacheHit = cache.get(deps);
-        // cache hit is not null
-        if (cacheHit)
-            return cacheHit[1];
-        var result = cacheAction();
-        cacheStorage.unshift([deps.concat(), result]);
-        if (longerThan(cacheStorage, maxSize))
-            cacheStorage.length = maxSize;
-        return result;
-    };
-    // invalidate an item in the cache by its dependencies
-    cache.invalidate = function (deps) {
-        var index = findIndex(deps);
-        if (index > -1)
-            cacheStorage.splice(index, 1);
-    };
-    // Retrieves an item from the cache.
-    cache.get = function (deps) {
-        return cacheStorage[findIndex(deps)] || null;
+function createCursor() {
+    var storage = {
+        cursor: []
     };
-    return cache;
-    function findIndex(deps) {
-        return cacheStorage.findIndex(function (_a) {
-            var cachedDeps = _a[0];
-            return lengthEquals(deps, cachedDeps.length) &&
-                deps.every(function (dep, i) { return dep === cachedDeps[i]; });
-        });
+    function addLevel() {
+        storage.cursor.push(0);
+    }
+    function removeLevel() {
+        storage.cursor.pop();
+    }
+    function cursorAt() {
+        return last(storage.cursor);
+    }
+    function getCursor() {
+        return asArray(storage.cursor);
+    }
+    function next() {
+        storage.cursor[storage.cursor.length - 1]++;
+        return last(storage.cursor);
+    }
+    function reset() {
+        storage.cursor = [0];
     }
+    reset();
+    return {
+        addLevel: addLevel,
+        cursorAt: cursorAt,
+        getCursor: getCursor,
+        next: next,
+        removeLevel: removeLevel,
+        reset: reset
+    };
 }
 
+var IsolateTypes;
+(function (IsolateTypes) {
+    IsolateTypes[IsolateTypes["DEFAULT"] = 0] = "DEFAULT";
+    IsolateTypes[IsolateTypes["SUITE"] = 1] = "SUITE";
+    IsolateTypes[IsolateTypes["EACH"] = 2] = "EACH";
+    IsolateTypes[IsolateTypes["SKIP_WHEN"] = 3] = "SKIP_WHEN";
+    IsolateTypes[IsolateTypes["OMIT_WHEN"] = 4] = "OMIT_WHEN";
+    IsolateTypes[IsolateTypes["GROUP"] = 5] = "GROUP";
+})(IsolateTypes || (IsolateTypes = {}));
+
+var Modes;
+(function (Modes) {
+    Modes[Modes["ALL"] = 0] = "ALL";
+    Modes[Modes["EAGER"] = 1] = "EAGER";
+})(Modes || (Modes = {}));
+
+var context = createContext(function (ctxRef, parentContext) {
+    return parentContext
+        ? null
+        : assign({}, {
+            exclusion: {
+                tests: {},
+                groups: {}
+            },
+            inclusion: {},
+            isolate: {
+                type: IsolateTypes.DEFAULT,
+                keys: {
+                    current: {},
+                    prev: {}
+                }
+            },
+            mode: [Modes.ALL],
+            testCursor: createCursor()
+        }, ctxRef);
+});
+
 // STATE REF
 function useStateRef() {
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -546,6 +447,105 @@ var STATUS_PENDING = 'PENDING';
 var STATUS_CANCELED = 'CANCELED';
 var STATUS_OMITTED = 'OMITTED';
 
+/**
+ * Throws a timed out error.
+ */
+function throwError(devMessage, productionMessage) {
+    throw new Error(devMessage );
+}
+function throwErrorDeferred(devMessage, productionMessage) {
+    setTimeout(function () {
+        throwError(devMessage);
+    }, 0);
+}
+
+// eslint-disable-next-line max-lines-per-function
+function createState(onStateChange) {
+    var state = {
+        references: []
+    };
+    var registrations = [];
+    return {
+        registerStateKey: registerStateKey,
+        reset: reset
+    };
+    /**
+     * Registers a new key in the state, takes the initial value (may be a function that returns the initial value), returns a function.
+     *
+     * @example
+     *
+     * const useColor = state.registerStateKey("blue");
+     *
+     * let [color, setColor] = useColor(); // -> ["blue", Function]
+     *
+     * setColor("green");
+     *
+     * useColor()[0]; -> "green"
+     */
+    function registerStateKey(initialState, onUpdate) {
+        var key = registrations.length;
+        registrations.push([initialState, onUpdate]);
+        return initKey(key, initialState);
+    }
+    function reset() {
+        var prev = current();
+        state.references = [];
+        registrations.forEach(function (_a, index) {
+            var initialValue = _a[0];
+            return initKey(index, initialValue, prev[index]);
+        });
+    }
+    function initKey(key, initialState, prevState) {
+        current().push();
+        set(key, optionalFunctionValue(initialState, prevState));
+        return function useStateKey() {
+            return [
+                current()[key],
+                function (nextState) {
+                    return set(key, optionalFunctionValue(nextState, current()[key]));
+                },
+            ];
+        };
+    }
+    function current() {
+        return state.references;
+    }
+    function set(index, value) {
+        var prevValue = state.references[index];
+        state.references[index] = value;
+        var _a = registrations[index], onUpdate = _a[1];
+        if (isFunction(onUpdate)) {
+            onUpdate(value, prevValue);
+        }
+        if (isFunction(onStateChange)) {
+            onStateChange();
+        }
+    }
+}
+
+function createStateRef(state, _a) {
+    var suiteId = _a.suiteId, suiteName = _a.suiteName;
+    return {
+        optionalFields: state.registerStateKey(function () { return ({}); }),
+        suiteId: state.registerStateKey(suiteId),
+        suiteName: state.registerStateKey(suiteName),
+        testCallbacks: state.registerStateKey(function () { return ({
+            fieldCallbacks: {},
+            doneCallbacks: []
+        }); }),
+        testObjects: state.registerStateKey(function (prev) {
+            return {
+                prev: prev ? prev.current : [],
+                current: []
+            };
+        })
+    };
+}
+
+function isNullish(value) {
+    return isNull(value) || isUndefined(value);
+}
+
 function usePath() {
     var context$1 = context.useX();
     return context$1.testCursor.getCursor();
@@ -619,57 +619,6 @@ function shouldAllowReorder() {
     return context.useX().isolate.type === IsolateTypes.EACH;
 }
 
-/**
- * A safe hasOwnProperty access
- */
-function hasOwnProperty(obj, key) {
-    return Object.prototype.hasOwnProperty.call(obj, key);
-}
-
-function isNumber(value) {
-    return Boolean(typeof value === 'number');
-}
-
-function isEmpty(value) {
-    if (!value) {
-        return true;
-    }
-    else if (isNumber(value)) {
-        return value === 0;
-    }
-    else if (hasOwnProperty(value, 'length')) {
-        return lengthEquals(value, 0);
-    }
-    else if (typeof value === 'object') {
-        return lengthEquals(Object.keys(value), 0);
-    }
-    return true;
-}
-var isNotEmpty = bindNot(isEmpty);
-
-function nonMatchingFieldName(testObject, fieldName) {
-    return !!fieldName && !matchingFieldName(testObject, fieldName);
-}
-function matchingFieldName(testObject, fieldName) {
-    return !!(fieldName && testObject.fieldName === fieldName);
-}
-
-/**
- * Checks if a given field, or the suite as a whole still have remaining tests.
- */
-function hasRemainingTests(fieldName) {
-    var allIncomplete = useAllIncomplete();
-    if (isEmpty(allIncomplete)) {
-        return false;
-    }
-    if (fieldName) {
-        return allIncomplete.some(function (testObject) {
-            return matchingFieldName(testObject, fieldName);
-        });
-    }
-    return isNotEmpty(allIncomplete);
-}
-
 var Severity;
 (function (Severity) {
     Severity["WARNINGS"] = "warnings";
@@ -777,6 +726,13 @@ function __spreadArray(to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 }
 
+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;
 }
@@ -912,6 +868,34 @@ function hasByGroup(severityKey, group, fieldName) {
     });
 }
 
+/**
+ * A safe hasOwnProperty access
+ */
+function hasOwnProperty(obj, key) {
+    return Object.prototype.hasOwnProperty.call(obj, key);
+}
+
+function isNumber(value) {
+    return Boolean(typeof value === 'number');
+}
+
+function isEmpty(value) {
+    if (!value) {
+        return true;
+    }
+    else if (isNumber(value)) {
+        return value === 0;
+    }
+    else if (hasOwnProperty(value, 'length')) {
+        return lengthEquals(value, 0);
+    }
+    else if (typeof value === 'object') {
+        return lengthEquals(Object.keys(value), 0);
+    }
+    return true;
+}
+var isNotEmpty = bindNot(isEmpty);
+
 // eslint-disable-next-line max-statements, complexity
 function isValid(result, fieldName) {
     if (fieldIsOmitted(fieldName)) {
@@ -965,7 +949,7 @@ function noMissingTests(fieldName) {
 }
 
 var cache$1 = createCache(20);
-function produceDraft() {
+function produceBase() {
     var testObjects = useTestsFlat();
     var ctxRef = { stateRef: useStateRef() };
     return cache$1([testObjects], context.bind(ctxRef, function () {
@@ -980,19 +964,35 @@ function produceDraft() {
             hasWarnings: context.bind(ctxRef, hasWarnings),
             hasWarningsByGroup: context.bind(ctxRef, hasWarningsByGroup),
             isValid: context.bind(ctxRef, function (fieldName) {
-                return isValid(produceDraft(), fieldName);
+                return isValid(produceBase(), fieldName);
             }),
             suiteName: suiteName
         });
     }));
 }
 
+/**
+ * Checks if a given field, or the suite as a whole still have remaining tests.
+ */
+function hasRemainingTests(fieldName) {
+    var allIncomplete = useAllIncomplete();
+    if (isEmpty(allIncomplete)) {
+        return false;
+    }
+    if (fieldName) {
+        return allIncomplete.some(function (testObject) {
+            return matchingFieldName(testObject, fieldName);
+        });
+    }
+    return isNotEmpty(allIncomplete);
+}
+
 var cache = createCache(20);
 function produceFullResult() {
     var testObjects = useTestsFlat();
     var ctxRef = { stateRef: useStateRef() };
     return cache([testObjects], context.bind(ctxRef, function () {
-        return assign({}, produceDraft(), {
+        return assign({}, produceBase(), {
             done: context.bind(ctxRef, done)
         });
     }));
@@ -1025,7 +1025,7 @@ var done = function done() {
     if (shouldSkipDoneRegistration(callback, fieldName, output)) {
         return output;
     }
-    var doneCallback = function () { return callback(produceDraft()); };
+    var doneCallback = function () { return callback(produceBase()); };
     if (shouldRunDoneCallback(fieldName)) {
         doneCallback();
         return output;
@@ -1226,7 +1226,7 @@ function create() {
         // Return the result
         return produceFullResult();
     }), {
-        get: context.bind(ctxRef, produceDraft),
+        get: context.bind(ctxRef, produceBase),
         remove: context.bind(ctxRef, function (fieldName) {
             bus.emit(Events.REMOVE_FIELD, fieldName);
         }),
@@ -1284,7 +1284,7 @@ function skipWhen(conditional, callback) {
             // we should skip the test if the parent conditional is true.
             isExcludedIndividually() ||
                 // Otherwise, we should skip the test if the conditional is true.
-                optionalFunctionValue(conditional, optionalFunctionValue(produceDraft))
+                optionalFunctionValue(conditional, optionalFunctionValue(produceBase))
         }, function () { return callback(); });
     });
 }
@@ -1484,7 +1484,7 @@ function include(fieldName) {
             if (isStringValue(condition)) {
                 return Boolean(exclusion.tests[condition]);
             }
-            return optionalFunctionValue(condition, optionalFunctionValue(produceDraft));
+            return optionalFunctionValue(condition, optionalFunctionValue(produceBase));
         };
     }
 }
@@ -1541,7 +1541,7 @@ function omitWhen(conditional, callback) {
     isolate({ type: IsolateTypes.OMIT_WHEN }, function () {
         context.run({
             omitted: isOmitted() ||
-                optionalFunctionValue(conditional, optionalFunctionValue(produceDraft))
+                optionalFunctionValue(conditional, optionalFunctionValue(produceBase))
         }, function () { return callback(); });
     });
 }
@@ -1674,7 +1674,7 @@ function registerTest(testObject) {
         }
     }
     catch (e) {
-        throwError("Unexpected error encountered during test registration.\n      Test Object: ".concat(testObject, ".\n      Error: ").concat(e, "."));
+        throwError("Unexpected error encountered during test registration.\n      Test Object: ".concat(JSON.stringify(testObject), ".\n      Error: ").concat(e, "."));
     }
 }
 
@@ -1873,6 +1873,6 @@ function warn() {
     ctx.currentTest.warn();
 }
 
-var VERSION = "4.2.0";
+var VERSION = "4.2.1-dev-ee64be";
 
 export { VERSION, context, create, each, eager, group, include, omitWhen, only, optional, skip, skipWhen, test, warn };