vest 4.0.0-dev-7acb76 → 4.0.0-next-03ba92

package/CHANGELOG.md

@@ -4,73 +4,85 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## 4.0.0 - 2021-10-25
+## 4.0.0 - 2021-11-20
 ### Changed or removed
-- f5ba507  major(context): used named export in context (ealush)
-- eaed68f  breaking(vest, enforce): prepare next major (ealush)
+- 7c43eab  major(context): used named export in context (ealush)
+- e8652bc  breaking(vest, enforce): prepare next major (ealush)
+- dab8e00  breaking(vest, enforce): prepare next major (ealush)
 
 ### Added
-- e0f0f91  feat(vest): support custom optional logic (ealush)
-- d4fecee  feat(vest): Add a parser export (ealush)
-- e72498d  feat(vest): isValid with field name (ealush)
-- f60d952  feat(vest): handle execution order state refill with memoized tests (ealush)
-- a2b60c4  feat(vest): Make the state rely on execution order. Make skipWhen set skipped context. (undefined)
-- ae5eb02  added(n4s): partial rule modifier (undefined)
-- 990c68f  feat(n4s): context propagation within enforce (undefined)
+- d3e7613  feat(vest): support custom optional logic (ealush)
+- be1cbf6  feat(vest): Add a parser export (ealush)
+- 2553748  feat(vest): isValid with field name (ealush)
+- ec5ceb9  feat(vest): handle execution order state refill with memoized tests (ealush)
+- 4032bd8  feat(vest): Make the state rely on execution order. Make skipWhen set skipped context. (undefined)
+- 220127b  added(n4s): partial rule modifier (undefined)
+- b5ce72d  feat(n4s): context propagation within enforce (undefined)
 
 ### Fixed and improved
-- 7acb76f  fix(vest): prevent pending tests from being marked as skipped (ealush)
-- 8851ff5  patch(vest): Add isolate module for containing re-orders (ealush)
-- 0593c0f  patch(vest): refresh tests after cancel (ealush)
-- e915b53  patch: add cursor util (ealush)
-- f54ae8b  patch(vest): move cursor into context (ealush)
-- fc7627e  patch(vest): automatically purge not-found test results (ealush)
-- d68d990  vx: correctly pass cli options to build script (ealush)
-- 7c47b9a  patch(vest): Throw error when tests are called in the wrong order (ealush)
-- 01be84e  vx: add types to exports (ealush)
-- 7201170  organize vest state hooks (ealush)
-- e39bfd8  patch(vest): infer omitted optional fields (ealush)
-- 93014e3  vx: add dev bundle to exports (ealush)
-- 91df42e  fix(vest): prevent changing test status once it was finalized (ealush)
-- 797df3e  patch(vest): add cache invalidation for canceled tests (ealush)
-- 14ba6d9  types(vest): add safeguard around shouldUseErrorAsMessage (ealush)
-- 477ca00  patch(vest): some cleanups (ealush)
-- 58d5ed3  patch(vest): remove duplicate code handling perv test registration (ealush)
-- 6a98443  vx: use context directly from published package (ealush)
-- a79e479  patch: run done callbacks via event (ealush)
-- 01d32b7  patch(vest): removed state subscription (ealush)
+- 03ba92c  vx: support namespaced exports (ealush)
+- 38a54ae  vx: support installing of local packages (ealush)
+- 7baedf2  n4s: use named export in entry (ealush)
+- 366001b  patch(vest): better handling of skipped async tests (ealush)
+- 2380679  types(vest): allow unprovided suite name in tests (ealush)
+- f721b2d  patch(vest): replace warns boolean flag with enum (ealush)
+- 0acb24d  patch(vest): Pass draft result to skipWhen conditional (ealush)
+- e84cd9d  patch(vest): add back optional suite name argument (ealush)
+- 8b30b66  patch(vest): make compose an external export (ealush)
+- ddfa9fd  patch(vest): move creation functions to event bus (ealush)
+- fe83e88  patch: Some cleanups (ealush)
+- 9275707  fix(vest): prevent pending tests from being marked as skipped (ealush)
+- 94e00a8  patch(vest): Add isolate module for containing re-orders (ealush)
+- 5bcc14a  patch(vest): refresh tests after cancel (ealush)
+- fd049e8  patch: add cursor util (ealush)
+- 9380c09  patch(vest): move cursor into context (ealush)
+- 49b72f4  patch(vest): automatically purge not-found test results (ealush)
+- 2dfedaf  vx: correctly pass cli options to build script (ealush)
+- aae250a  patch(vest): Throw error when tests are called in the wrong order (ealush)
+- a87824b  vx: add types to exports (ealush)
+- cc9b4b0  organize vest state hooks (ealush)
+- df84261  patch(vest): infer omitted optional fields (ealush)
+- 2534cf6  vx: add dev bundle to exports (ealush)
+- 4d450aa  fix(vest): prevent changing test status once it was finalized (ealush)
+- 8730e25  patch(vest): add cache invalidation for canceled tests (ealush)
+- 4cb2c6c  types(vest): add safeguard around shouldUseErrorAsMessage (ealush)
+- c214a12  patch(vest): some cleanups (ealush)
+- 858458d  patch(vest): remove duplicate code handling perv test registration (ealush)
+- ec69173  vx: use context directly from published package (ealush)
+- 962bc06  patch: run done callbacks via event (ealush)
+- d96f428  patch(vest): removed state subscription (ealush)
 - package.json
 - packages/anyone/package.json
 - packages/anyone/package.json
 - packages/vast/types/vast.d.ts
-- b10b98b  patch(vest): remove pending and lagging state (ealush)
-- dfd2cc3  patch(vest): convert boolean flags to a single status key (ealush)
-- 1c9da6c  patch: simplify fieldname comparison (ealush)
-- 43c75a4  patch(vest): add useAllIncomplete hook (ealush)
-- 2dfdc97  patch(vest): invalid accounts for warning tests as well (ealush)
-- 4033cca  patch(vest): isValid counts all required tests per field (ealush)
-- 02b28a6  chore: cleanups (ealush)
+- e4e1746  patch(vest): remove pending and lagging state (ealush)
+- 9d8fd21  patch(vest): convert boolean flags to a single status key (ealush)
+- dbb836e  patch: simplify fieldname comparison (ealush)
+- 5a78179  patch(vest): add useAllIncomplete hook (ealush)
+- b5ae658  patch(vest): invalid accounts for warning tests as well (ealush)
+- 4563b8d  patch(vest): isValid counts all required tests per field (ealush)
+- 3fe2f21  chore: cleanups (ealush)
 - .eslintrc.js
-- afa16e9  add(n4s): enforce.condition (ealush)
+- 149aab3  add(n4s): enforce.condition (ealush)
 - package.json
 - packages/anyone/package.json
-- d452e26  chore: cleanup residue (undefined)
-- 5982183  chore: remove duplicate types (undefined)
+- 40ef071  chore: cleanup residue (undefined)
+- eeac20e  chore: remove duplicate types (undefined)
 - packages/anyone/package.json
-- 52ac8e0  patch: add nodejs exports (undefined)
-- f9c4b3e  patch: remove unused exports (undefined)
+- 4d88c04  patch: add nodejs exports (undefined)
+- 6e57aa1  patch: remove unused exports (undefined)
 - packages/anyone/package.json
-- db0253b  chore: reduce complexity, remove all lint errors (undefined)
+- 26af06b  chore: reduce complexity, remove all lint errors (undefined)
 - packages/anyone/.npmignore
 - .github/PULL_REQUEST_TEMPLATE.md
-- be9c776  chore: cleanup unused code (ealush)
-- c5eb2de  lint: handling lint of all packages (ealush)
+- 5be986d  chore: cleanup unused code (ealush)
+- ba68539  lint: handling lint of all packages (ealush)
 - .gitignore
-- d388fdc  patch(n4s): add ruleReturn default values (ealush)
-- be91b7e  fix(n4s): make enforce compound runners fall back to correct response (ealush)
-- 7e8f25c  fix(n4s): make enforce chaining work (ealush)
-- e60ce3b  chore: some lint fixes (ealush)
-- fc8e2d8  add cli options support (ealush)
+- cca5130  patch(n4s): add ruleReturn default values (ealush)
+- 75306ff  fix(n4s): make enforce compound runners fall back to correct response (ealush)
+- 4751584  fix(n4s): make enforce chaining work (ealush)
+- 73b28a1  chore: some lint fixes (ealush)
+- 4135ce3  add cli options support (ealush)
 
 ## 3.2.7 - 2021-07-17
 

package/README.md

@@ -1,5 +1,17 @@
 ![Vest](https://cdn.jsdelivr.net/gh/ealush/vest@assets/vest-logo.png 'Vest')
 
+# Version 4 of Vest is coming soon!
+
+If you want to try it out, you can already install it with the `next` tag.
+
+```npm install vest@next```
+
+This version brings many enhancements to Vest. This version is well tested, and can be used safely. If you do, however encounter any issues or have any thoughts on the next version, please report them on the issues page.
+
+For the version 4 docs, you can reach out to: https://vest.vercel.app/ or specifically to the [migration guide](https://vest.vercel.app/docs/migration_guide).
+
+A note on Typescript support: Version four uses Typescript 4 specific features, so for now only version 4 is supported.
+
 # Vest 🦺 Declarative Validation Testing
 
 ![Github Stars](https://githubbadges.com/star.svg?user=ealush&repo=vest&style=flat)

package/dist/cjs/classnames.development.js

@@ -56,10 +56,10 @@ function parse(res) {
 /**
  * Creates a function that returns class names that match the validation result
  */
-function classNames(res, classes) {
+function classnames(res, classes) {
     if (classes === void 0) { classes = {}; }
     if (!res || !isFunction(res.hasErrors)) {
-        throwError("[vest/classNames]: Expected first argument to be Vest's result object.");
+        throwError("classnames: Expected first argument to be Vest's result object.");
     }
     var selectors = parse(res);
     return function (key) {
@@ -74,4 +74,4 @@ function classNames(res, classes) {
     };
 }
 
-module.exports = classNames;
+module.exports = classnames;

package/dist/cjs/classnames.production.js

@@ -1 +1 @@
-"use strict";function t(t){return"function"==typeof t}function r(r,n){var e;return null!==(e=function(r){for(var n=[],e=1;e<arguments.length;e++)n[e-1]=arguments[e];return t(r)?r.apply(void 0,n):r}(r))&&void 0!==e?e:n}function n(t){var r=Number(t);return!(isNaN(parseFloat(String(t)))||isNaN(Number(t))||!isFinite(r))}function e(t,r){return n(t)&&n(r)&&Number(t)>Number(r)}function u(t,r){return Object.prototype.hasOwnProperty.call(t,r)}module.exports=function(n,o){void 0===o&&(o={}),n&&t(n.hasErrors)||function(t,n){throw Error(r(n,t))}("[vest/classNames]: Expected first argument to be Vest's result object.");var s=function(t){var r={},n={invalid:t.hasErrors,tested:function(o){return o?u(r,o)?r[o]:(r[o]=u(t.tests,o)&&e(t.tests[o].testCount,0),n.tested(o)):e(t.testCount,0)},untested:function(r){return 0===t.testCount||!n.tested(r)},valid:t.isValid,warning:t.hasWarnings};return n}(n);return function(r){var n,e=[];for(n in o){var u=n;t(s[u])&&s[u](r)&&e.push(o[u])}return e.join(" ")}};
+"use strict";function t(t){return"function"==typeof t}function r(r,n){var e;return null!==(e=function(r){for(var n=[],e=1;e<arguments.length;e++)n[e-1]=arguments[e];return t(r)?r.apply(void 0,n):r}(r))&&void 0!==e?e:n}function n(t){var r=Number(t);return!(isNaN(parseFloat(String(t)))||isNaN(Number(t))||!isFinite(r))}function e(t,r){return n(t)&&n(r)&&Number(t)>Number(r)}function u(t,r){return Object.prototype.hasOwnProperty.call(t,r)}module.exports=function(n,o){void 0===o&&(o={}),n&&t(n.hasErrors)||function(t,n){throw Error(r(n,t))}("classnames: Expected first argument to be Vest's result object.");var s=function(t){var r={},n={invalid:t.hasErrors,tested:function(o){return o?u(r,o)?r[o]:(r[o]=u(t.tests,o)&&e(t.tests[o].testCount,0),n.tested(o)):e(t.testCount,0)},untested:function(r){return 0===t.testCount||!n.tested(r)},valid:t.isValid,warning:t.hasWarnings};return n}(n);return function(r){var n,e=[];for(n in o){var u=n;t(s[u])&&s[u](r)&&e.push(o[u])}return e.join(" ")}};

package/dist/cjs/compose.js

@@ -0,0 +1,7 @@
+'use strict'
+
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./compose.production.js');
+} else {
+  module.exports = require('./compose.development.js');
+}

package/dist/cjs/enforce/compose.development.js

@@ -0,0 +1,222 @@
+'use strict';
+
+function mapFirst(array, callback) {
+    var broke = false;
+    var breakoutValue = null;
+    for (var i = 0; i < array.length; i++) {
+        callback(array[i], breakout, i);
+        if (broke) {
+            return breakoutValue;
+        }
+    }
+    function breakout(value) {
+        broke = true;
+        breakoutValue = value;
+    }
+}
+
+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 );
+}
+
+var assign = Object.assign;
+
+// eslint-disable-next-line max-lines-per-function
+function createContext(init) {
+    var storage = { ancestry: [] };
+    return {
+        bind: bind,
+        run: run,
+        use: use,
+        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')));
+    }
+    function run(ctxRef, fn) {
+        var _a;
+        var parentContext = use();
+        var out = assign({}, parentContext ? parentContext : {}, (_a = optionalFunctionValue(init, ctxRef, parentContext)) !== null && _a !== void 0 ? _a : ctxRef);
+        var ctx = set(Object.freeze(out));
+        storage.ancestry.unshift(ctx);
+        var res = fn(ctx);
+        clear();
+        return res;
+    }
+    function bind(ctxRef, fn) {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore - this one's pretty hard to get right
+        var returnedFn = function () {
+            var runTimeArgs = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                runTimeArgs[_i] = arguments[_i];
+            }
+            return run(ctxRef, function () {
+                return fn.apply(void 0, runTimeArgs);
+            });
+        };
+        return returnedFn;
+    }
+    function use() {
+        return storage.ctx;
+    }
+    function set(value) {
+        return (storage.ctx = value);
+    }
+    function clear() {
+        var _a;
+        storage.ancestry.shift();
+        set((_a = storage.ancestry[0]) !== null && _a !== void 0 ? _a : null);
+    }
+}
+
+var ctx = createContext(function (ctxRef, parentContext) {
+    var base = {
+        value: ctxRef.value,
+        meta: ctxRef.meta || {}
+    };
+    if (!parentContext) {
+        return assign(base, {
+            parent: emptyParent
+        });
+    }
+    else if (ctxRef.set) {
+        return assign(base, {
+            parent: function () { return stripContext(parentContext); }
+        });
+    }
+    return parentContext;
+});
+function stripContext(ctx) {
+    if (!ctx) {
+        return ctx;
+    }
+    return {
+        value: ctx.value,
+        meta: ctx.meta,
+        parent: ctx.parent
+    };
+}
+function emptyParent() {
+    return null;
+}
+
+/**
+ * A safe hasOwnProperty access
+ */
+function hasOwnProperty(obj, key) {
+    return Object.prototype.hasOwnProperty.call(obj, key);
+}
+
+function isNumber(value) {
+    return Boolean(typeof value === 'number');
+}
+
+function lengthEquals(value, arg1) {
+    return value.length === Number(arg1);
+}
+
+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;
+}
+
+function ruleReturn(pass, message) {
+    var output = { pass: pass };
+    if (message) {
+        output.message = message;
+    }
+    return output;
+}
+function failing() {
+    return ruleReturn(false);
+}
+function passing() {
+    return ruleReturn(true);
+}
+function defaultToPassing(callback) {
+    return defaultTo(callback, passing());
+}
+
+function runLazyRule(lazyRule, currentValue) {
+    try {
+        return lazyRule.run(currentValue);
+    }
+    catch (_a) {
+        return failing();
+    }
+}
+
+/* eslint-disable max-lines-per-function */
+// TODO: This gives me a headache. Instead of `any` we should use `TLazy`
+// but it fails when using compose. The type is very complex. Feel free to help.
+function compose() {
+    var composites = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        composites[_i] = arguments[_i];
+    }
+    return Object.assign(function (value) {
+        var res = run(value);
+        if (!res.pass) {
+            if (isEmpty(res.message)) {
+                throwError();
+            }
+            else {
+                // Explicitly throw a string so that vest.test can pick it up as the validation error message
+                throw res.message;
+            }
+        }
+    }, {
+        run: run,
+        test: function (value) { return run(value).pass; }
+    });
+    function run(value) {
+        return ctx.run({ value: value }, function () {
+            return defaultToPassing(mapFirst(composites, function (composite, breakout) {
+                /* HACK: Just a small white lie. ~~HELP WANTED~~.
+                   The ideal is that instead of `TLazyRuleRunners` We would simply use `TLazy` to begin with.
+                   The problem is that lazy rules can't really be passed to this function due to some generic hell
+                   so we're limiting it to a small set of functions.
+                */
+                var res = runLazyRule(composite, value);
+                if (!res.pass) {
+                    breakout(res);
+                }
+            }));
+        });
+    }
+}
+
+module.exports = compose;

package/dist/cjs/enforce/compose.production.js

@@ -0,0 +1 @@
+"use strict";function n(n,t){function r(n){e=!0,u=n}for(var e=!1,u=null,o=0;o<n.length;o++)if(t(n[o],r,o),e)return u}function t(n){return"function"==typeof n}function r(n){for(var r=[],e=1;e<arguments.length;e++)r[e-1]=arguments[e];return t(n)?n.apply(void 0,r):n}function e(n,t){var e;return null!==(e=r(n))&&void 0!==e?e:t}function u(n,t){throw Error(e(t,n))}var o=Object.assign;var i=function(n){function t(t,e){var u,f,a=i();return t=o({},a||{},null!==(u=r(n,t,a))&&void 0!==u?u:t),u=c.ctx=Object.freeze(t),c.ancestry.unshift(u),e=e(u),c.ancestry.shift(),c.ctx=null!==(f=c.ancestry[0])&&void 0!==f?f:null,e}function i(){return c.ctx}var c={ancestry:[]};return{bind:function(n,r){return function(){for(var e=[],u=0;u<arguments.length;u++)e[u]=arguments[u];return t(n,(function(){return r.apply(void 0,e)}))}},run:t,use:i,useX:function(n){var t;return null!==(t=c.ctx)&&void 0!==t?t:u(e(n,"Context was used after it was closed"))}}}((function(n,t){var r={value:n.value,meta:n.meta||{}};return t?n.set?o(r,{parent:function(){return function(n){return n?{value:n.value,meta:n.meta,parent:n.parent}:n}(t)}}):t:o(r,{parent:c})}));function c(){return null}function f(n,t){return n.length===Number(t)}function a(n){if(n){if(function(n){return"number"==typeof n}(n))return 0===n;if(function(n,t){return Object.prototype.hasOwnProperty.call(n,t)}(n,"length"))return f(n,0);if("object"==typeof n)return f(Object.keys(n),0)}return!0}function s(n,t){return n={pass:n},t&&(n.message=t),n}function l(n){return e(n,s(!0))}function v(n,t){try{return n.run(t)}catch(n){return s(!1)}}module.exports=function(){function t(t){return i.run({value:t},(function(){return l(n(r,(function(n,r){(n=v(n,t)).pass||r(n)})))}))}for(var r=[],e=0;e<arguments.length;e++)r[e]=arguments[e];return Object.assign((function(n){if(!(n=t(n)).pass){if(!a(n.message))throw n.message;u()}}),{run:t,test:function(n){return t(n).pass}})};

package/dist/cjs/enforce/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/dist/cjs/promisify.development.js

@@ -18,7 +18,7 @@ var promisify = function (validatorFn) {
             args[_i] = arguments[_i];
         }
         if (!isFunction(validatorFn)) {
-            throwError('[vest/promisify]: Expected validatorFn to be a function.');
+            throwError('promisify: Expected validatorFn to be a function.');
         }
         return new Promise(function (resolve) { return validatorFn.apply(void 0, args).done(resolve); });
     };

package/dist/cjs/promisify.production.js

@@ -1 +1 @@
-"use strict";function n(n){return"function"==typeof n}function r(r,t){var o;return null!==(o=function(r){for(var t=[],o=1;o<arguments.length;o++)t[o-1]=arguments[o];return n(r)?r.apply(void 0,t):r}(r))&&void 0!==o?o:t}function t(n,t){throw Error(r(t,n))}module.exports=function(r){return function(){for(var o=[],e=0;e<arguments.length;e++)o[e]=arguments[e];return n(r)||t("[vest/promisify]: Expected validatorFn to be a function."),new Promise((function(n){return r.apply(void 0,o).done(n)}))}};
+"use strict";function n(n){return"function"==typeof n}function r(r,t){var o;return null!==(o=function(r){for(var t=[],o=1;o<arguments.length;o++)t[o-1]=arguments[o];return n(r)?r.apply(void 0,t):r}(r))&&void 0!==o?o:t}function t(n,t){throw Error(r(t,n))}module.exports=function(r){return function(){for(var o=[],e=0;e<arguments.length;e++)o[e]=arguments[e];return n(r)||t("promisify: Expected validatorFn to be a function."),new Promise((function(n){return r.apply(void 0,o).done(n)}))}};