n4s 4.1.9-dev-c786f7 → 4.1.9-dev-9b46fb

package/dist/cjs/compose.development.js

@@ -1,7 +1,7 @@
 'use strict';
 
-var n4s = require('n4s');
 var vestUtils = require('vest-utils');
+var n4s = require('n4s');
 
 function ruleReturn(pass, message) {
     var output = { pass: pass };

package/dist/cjs/compose.production.js

@@ -1 +1 @@
-"use strict";var n=require("n4s"),t=require("vest-utils");function r(n,t){return n={pass:n},t&&(n.message=t),n}function u(n){return t.defaultTo(n,r(!0))}function e(n,t){try{return n.run(t)}catch(n){return r(!1)}}module.exports=function(){function r(r){return n.ctx.run({value:r},(function(){return u(t.mapFirst(s,(function(n,t){t(!(n=e(n,r)).pass,n)})))}))}for(var s=[],i=0;i<arguments.length;i++)s[i]=arguments[i];return t.assign((function(n){n=r(n),t.invariant(n.pass,t.StringObject(n.message))}),{run:r,test:function(n){return r(n).pass}})};
+"use strict";var n=require("vest-utils"),t=require("n4s");function r(n,t){return n={pass:n},t&&(n.message=t),n}function u(t){return n.defaultTo(t,r(!0))}function e(n,t){try{return n.run(t)}catch(n){return r(!1)}}module.exports=function(){function r(r){return t.ctx.run({value:r},(function(){return u(n.mapFirst(s,(function(n,t){t(!(n=e(n,r)).pass,n)})))}))}for(var s=[],i=0;i<arguments.length;i++)s[i]=arguments[i];return n.assign((function(t){t=r(t),n.invariant(t.pass,n.StringObject(t.message))}),{run:r,test:function(n){return r(n).pass}})};

package/dist/cjs/compounds.development.js

@@ -1,7 +1,7 @@
 'use strict';
 
-var n4s = require('n4s');
 var vestUtils = require('vest-utils');
+var n4s = require('n4s');
 
 function ruleReturn(pass, message) {
     var output = { pass: pass };

package/dist/cjs/compounds.production.js

@@ -1 +1 @@
-"use strict";var n=require("n4s"),r=require("vest-utils");function t(n,r){return n={pass:n},r&&(n.message=r),n}function e(){return t(!1)}function u(n){return r.defaultTo(n,e())}function f(n){return r.defaultTo(n,t(!0))}function o(n,r){try{return n.run(r)}catch(n){return e()}}function i(n,r){return n===r}r.bindNot(i);n.enforce.extend({allOf:function(n){for(var t=[],e=1;e<arguments.length;e++)t[e-1]=arguments[e];return f(r.mapFirst(t,(function(r,t){t(!(r=o(r,n)).pass,r)})))},anyOf:function(n){for(var t=[],e=1;e<arguments.length;e++)t[e-1]=arguments[e];return u(r.mapFirst(t,(function(r,t){t((r=o(r,n)).pass,r)})))},noneOf:function(n){for(var t=[],u=1;u<arguments.length;u++)t[u-1]=arguments[u];return f(r.mapFirst(t,(function(r,t){t((r=o(r,n)).pass,e())})))},oneOf:function(n){for(var e=[],u=1;u<arguments.length;u++)e[u-1]=arguments[u];var f=0;return e.some((function(t){if(o(t,n).pass&&f++,r.greaterThan(f,1))return!1})),t(i(f,1))}});
+"use strict";var n=require("vest-utils"),r=require("n4s");function t(n,r){return n={pass:n},r&&(n.message=r),n}function e(){return t(!1)}function u(r){return n.defaultTo(r,e())}function f(r){return n.defaultTo(r,t(!0))}function o(n,r){try{return n.run(r)}catch(n){return e()}}function i(n,r){return n===r}n.bindNot(i);r.enforce.extend({allOf:function(r){for(var t=[],e=1;e<arguments.length;e++)t[e-1]=arguments[e];return f(n.mapFirst(t,(function(n,t){t(!(n=o(n,r)).pass,n)})))},anyOf:function(r){for(var t=[],e=1;e<arguments.length;e++)t[e-1]=arguments[e];return u(n.mapFirst(t,(function(n,t){t((n=o(n,r)).pass,n)})))},noneOf:function(r){for(var t=[],u=1;u<arguments.length;u++)t[u-1]=arguments[u];return f(n.mapFirst(t,(function(n,t){t((n=o(n,r)).pass,e())})))},oneOf:function(r){for(var e=[],u=1;u<arguments.length;u++)e[u-1]=arguments[u];var f=0;return e.some((function(t){if(o(t,r).pass&&f++,n.greaterThan(f,1))return!1})),t(i(f,1))}});

package/dist/cjs/n4s.development.js

@@ -333,30 +333,47 @@ function validateResult(result) {
 
 function enforceEager(value) {
     var target = {};
+    // This condition is for when we don't have proxy support (ES5).
+    // In this case, we need to manually assign the rules to the target object on runtime.
+    // The follow up proxy block is used in case we do have proxy support, and we can assign each rule upon invocation.
     if (!isProxySupported()) {
+        // We iterate over each of the rules, and add them to the target object being return by enforce
         eachEnforceRule(function (ruleName, ruleFn) {
+            // We then wrap the rule with `genRuleCall` that adds the base enforce behavior
             target[ruleName] = genRuleCall(target, ruleFn, ruleName);
         });
         return target;
     }
+    // We create a proxy intercepting access to the target object (which is empty).
     var proxy = new Proxy(target, {
         get: function (_, ruleName) {
+            // On property access, we identify if it is a rule or not.
             var rule = getRule(ruleName);
+            // If it is a rule, we wrap it with `genRuleCall` that adds the base enforce behavior
             if (rule) {
                 return genRuleCall(proxy, rule, ruleName);
             }
         }
     });
     return proxy;
+    // This function is used to wrap a rule with the base enforce behavior
+    // It takes the target object, the rule function, and the rule name
+    // It then returns the rule, in a manner that can be used by enforce
     function genRuleCall(target, rule, ruleName) {
         return function ruleCall() {
             var args = [];
             for (var _i = 0; _i < arguments.length; _i++) {
                 args[_i] = arguments[_i];
             }
+            // Order of operation:
+            // 1. Create a context with the value being enforced
+            // 2. Call the rule within the context, and pass over the arguments passed to it
+            // 3. Transform the result to the correct output format
             var transformedResult = ctx.run({ value: value }, function () {
                 return transformResult.apply(void 0, __spreadArray([rule.apply(void 0, __spreadArray([value], args, false)), ruleName, value], args, false));
             });
+            // On rule failure (the result is false), we either throw an error
+            // or throw a string value if the rule has a message defined in it.
             vestUtils.invariant(transformedResult.pass, vestUtils.isNullish(transformedResult.message)
                 ? "enforce/".concat(ruleName, " failed with ").concat(JSON.stringify(value))
                 : vestUtils.StringObject(transformedResult.message));

package/dist/cjs/schema.development.js

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var n4s = require('n4s');
 var vestUtils = require('vest-utils');
+var n4s = require('n4s');
 
 function ruleReturn(pass, message) {
     var output = { pass: pass };

package/dist/cjs/schema.production.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var r=require("n4s"),n=require("vest-utils");function e(r,n){return r={pass:r},n&&(r.message=n),r}function t(){return e(!1)}function u(){return e(!0)}function i(r,n){try{return r.run(n)}catch(r){return t()}}function o(n,e){var t,o=function(t){var u=n[t],o=e[t];if(!(t=r.ctx.run({value:u,set:!0,meta:{key:t}},(function(){return i(o,u)}))).pass)return{value:t}};for(t in e){var a=o(t);if("object"==typeof a)return a.value}return u()}r.enforce.extend({isArrayOf:function(e,t){return function(r){return n.defaultTo(r,u())}(n.mapFirst(e,(function(n,e,u){e(!(u=r.ctx.run({value:n,set:!0,meta:{index:u}},(function(){return i(t,n)}))).pass,u)})))},loose:o,optional:function(r,e){return n.isNullish(r)?u():i(e,r)},shape:function(r,e){var i=o(r,e);if(!i.pass)return i;for(var a in r)if(!n.hasOwnProperty(e,a))return t();return u()}}),exports.partial=function(n){var e,t={};for(e in n)t[e]=r.enforce.optional(n[e]);return t};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var r=require("vest-utils"),n=require("n4s");function e(r,n){return r={pass:r},n&&(r.message=n),r}function t(){return e(!1)}function u(){return e(!0)}function i(r,n){try{return r.run(n)}catch(r){return t()}}function o(r,e){var t,o=function(t){var u=r[t],o=e[t];if(!(t=n.ctx.run({value:u,set:!0,meta:{key:t}},(function(){return i(o,u)}))).pass)return{value:t}};for(t in e){var a=o(t);if("object"==typeof a)return a.value}return u()}n.enforce.extend({isArrayOf:function(e,t){return function(n){return r.defaultTo(n,u())}(r.mapFirst(e,(function(r,e,u){e(!(u=n.ctx.run({value:r,set:!0,meta:{index:u}},(function(){return i(t,r)}))).pass,u)})))},loose:o,optional:function(n,e){return r.isNullish(n)?u():i(e,n)},shape:function(n,e){var i=o(n,e);if(!i.pass)return i;for(var a in n)if(!r.hasOwnProperty(e,a))return t();return u()}}),exports.partial=function(r){var e,t={};for(e in r)t[e]=n.enforce.optional(r[e]);return t};

package/dist/es/compose.development.js

@@ -1,5 +1,5 @@
-import { ctx } from 'n4s';
 import { defaultTo, assign, mapFirst, invariant, StringObject } from 'vest-utils';
+import { ctx } from 'n4s';
 
 function ruleReturn(pass, message) {
     var output = { pass: pass };

package/dist/es/compose.production.js

@@ -1 +1 @@
-import{defaultTo as n,assign as t,mapFirst as r,invariant as u,StringObject as s}from"vest-utils";import{ctx as e}from"n4s";function o(n,t){return n={pass:n},t&&(n.message=t),n}export default function(){function a(t){return e.run({value:t},(function(){return n(r(f,(function(n,r){try{var u=n.run(t)}catch(n){u=o(!1)}r(!u.pass,u)})),o(!0))}))}for(var f=[],i=0;i<arguments.length;i++)f[i]=arguments[i];return t((function(n){n=a(n),u(n.pass,s(n.message))}),{run:a,test:function(n){return a(n).pass}})}
+import{ctx as n}from"n4s";import{defaultTo as t,assign as r,mapFirst as u,invariant as s,StringObject as e}from"vest-utils";function o(n,t){return n={pass:n},t&&(n.message=t),n}export default function(){function a(r){return n.run({value:r},(function(){return t(u(f,(function(n,t){try{var u=n.run(r)}catch(n){u=o(!1)}t(!u.pass,u)})),o(!0))}))}for(var f=[],i=0;i<arguments.length;i++)f[i]=arguments[i];return r((function(n){n=a(n),s(n.pass,e(n.message))}),{run:a,test:function(n){return a(n).pass}})}

package/dist/es/compounds.development.js

@@ -1,5 +1,5 @@
-import { enforce } from 'n4s';
 import { defaultTo, mapFirst, bindNot, greaterThan } from 'vest-utils';
+import { enforce } from 'n4s';
 
 function ruleReturn(pass, message) {
     var output = { pass: pass };

package/dist/es/compounds.production.js

@@ -1 +1 @@
-import{defaultTo as n,mapFirst as r,bindNot as t,greaterThan as f}from"vest-utils";import{enforce as o}from"n4s";function u(n,r){return n={pass:n},r&&(n.message=r),n}function e(n,r){try{return n.run(r)}catch(n){return u(!1)}}t((function(n,r){return n===r})),o.extend({allOf:function(t){for(var f=[],o=1;o<arguments.length;o++)f[o-1]=arguments[o];return n(r(f,(function(n,r){r(!(n=e(n,t)).pass,n)})),u(!0))},anyOf:function(t){for(var f=[],o=1;o<arguments.length;o++)f[o-1]=arguments[o];return n(r(f,(function(n,r){r((n=e(n,t)).pass,n)})),u(!1))},noneOf:function(t){for(var f=[],o=1;o<arguments.length;o++)f[o-1]=arguments[o];return n(r(f,(function(n,r){r((n=e(n,t)).pass,u(!1))})),u(!0))},oneOf:function(n){for(var r=[],t=1;t<arguments.length;t++)r[t-1]=arguments[t];var o=0;return r.some((function(r){if(e(r,n).pass&&o++,f(o,1))return!1})),u(1===o)}});
+import{enforce as n}from"n4s";import{defaultTo as r,mapFirst as t,bindNot as f,greaterThan as o}from"vest-utils";function u(n,r){return n={pass:n},r&&(n.message=r),n}function e(n,r){try{return n.run(r)}catch(n){return u(!1)}}f((function(n,r){return n===r})),n.extend({allOf:function(n){for(var f=[],o=1;o<arguments.length;o++)f[o-1]=arguments[o];return r(t(f,(function(r,t){t(!(r=e(r,n)).pass,r)})),u(!0))},anyOf:function(n){for(var f=[],o=1;o<arguments.length;o++)f[o-1]=arguments[o];return r(t(f,(function(r,t){t((r=e(r,n)).pass,r)})),u(!1))},noneOf:function(n){for(var f=[],o=1;o<arguments.length;o++)f[o-1]=arguments[o];return r(t(f,(function(r,t){t((r=e(r,n)).pass,u(!1))})),u(!0))},oneOf:function(n){for(var r=[],t=1;t<arguments.length;t++)r[t-1]=arguments[t];var f=0;return r.some((function(r){if(e(r,n).pass&&f++,o(f,1))return!1})),u(1===f)}});

package/dist/es/n4s.development.js

@@ -329,30 +329,47 @@ function validateResult(result) {
 
 function enforceEager(value) {
     var target = {};
+    // This condition is for when we don't have proxy support (ES5).
+    // In this case, we need to manually assign the rules to the target object on runtime.
+    // The follow up proxy block is used in case we do have proxy support, and we can assign each rule upon invocation.
     if (!isProxySupported()) {
+        // We iterate over each of the rules, and add them to the target object being return by enforce
         eachEnforceRule(function (ruleName, ruleFn) {
+            // We then wrap the rule with `genRuleCall` that adds the base enforce behavior
             target[ruleName] = genRuleCall(target, ruleFn, ruleName);
         });
         return target;
     }
+    // We create a proxy intercepting access to the target object (which is empty).
     var proxy = new Proxy(target, {
         get: function (_, ruleName) {
+            // On property access, we identify if it is a rule or not.
             var rule = getRule(ruleName);
+            // If it is a rule, we wrap it with `genRuleCall` that adds the base enforce behavior
             if (rule) {
                 return genRuleCall(proxy, rule, ruleName);
             }
         }
     });
     return proxy;
+    // This function is used to wrap a rule with the base enforce behavior
+    // It takes the target object, the rule function, and the rule name
+    // It then returns the rule, in a manner that can be used by enforce
     function genRuleCall(target, rule, ruleName) {
         return function ruleCall() {
             var args = [];
             for (var _i = 0; _i < arguments.length; _i++) {
                 args[_i] = arguments[_i];
             }
+            // Order of operation:
+            // 1. Create a context with the value being enforced
+            // 2. Call the rule within the context, and pass over the arguments passed to it
+            // 3. Transform the result to the correct output format
             var transformedResult = ctx.run({ value: value }, function () {
                 return transformResult.apply(void 0, __spreadArray([rule.apply(void 0, __spreadArray([value], args, false)), ruleName, value], args, false));
             });
+            // On rule failure (the result is false), we either throw an error
+            // or throw a string value if the rule has a message defined in it.
             invariant(transformedResult.pass, isNullish(transformedResult.message)
                 ? "enforce/".concat(ruleName, " failed with ").concat(JSON.stringify(value))
                 : StringObject(transformedResult.message));

package/dist/es/schema.development.js

@@ -1,5 +1,5 @@
-import { ctx, enforce } from 'n4s';
 import { defaultTo, mapFirst, isNullish, hasOwnProperty } from 'vest-utils';
+import { ctx, enforce } from 'n4s';
 
 function ruleReturn(pass, message) {
     var output = { pass: pass };

package/dist/es/schema.production.js

@@ -1 +1 @@
-import{defaultTo as r,mapFirst as n,isNullish as t,hasOwnProperty as e}from"vest-utils";import{ctx as u,enforce as o}from"n4s";function i(r,n){return r={pass:r},n&&(r.message=n),r}function a(r,n){try{return r.run(n)}catch(r){return i(!1)}}function f(r,n){function t(t){var e=r[t],o=n[t];if(!(t=u.run({value:e,set:!0,meta:{key:t}},(function(){return a(o,e)}))).pass)return{value:t}}for(var e in n){var o=t(e);if("object"==typeof o)return o.value}return i(!0)}o.extend({isArrayOf:function(t,e){return r(n(t,(function(r,n,t){n(!(t=u.run({value:r,set:!0,meta:{index:t}},(function(){return a(e,r)}))).pass,t)})),i(!0))},loose:f,optional:function(r,n){return t(r)?i(!0):a(n,r)},shape:function(r,n){var t=f(r,n);if(!t.pass)return t;for(var u in r)if(!e(n,u))return i(!1);return i(!0)}});export function partial(r){var n,t={};for(n in r)t[n]=o.optional(r[n]);return t}
+import{ctx as r,enforce as n}from"n4s";import{defaultTo as t,mapFirst as e,isNullish as u,hasOwnProperty as o}from"vest-utils";function i(r,n){return r={pass:r},n&&(r.message=n),r}function a(r,n){try{return r.run(n)}catch(r){return i(!1)}}function f(n,t){function e(e){var u=n[e],o=t[e];if(!(e=r.run({value:u,set:!0,meta:{key:e}},(function(){return a(o,u)}))).pass)return{value:e}}for(var u in t){var o=e(u);if("object"==typeof o)return o.value}return i(!0)}n.extend({isArrayOf:function(n,u){return t(e(n,(function(n,t,e){t(!(e=r.run({value:n,set:!0,meta:{index:e}},(function(){return a(u,n)}))).pass,e)})),i(!0))},loose:f,optional:function(r,n){return u(r)?i(!0):a(n,r)},shape:function(r,n){var t=f(r,n);if(!t.pass)return t;for(var e in r)if(!o(n,e))return i(!1);return i(!0)}});export function partial(r){var t,e={};for(t in r)e[t]=n.optional(r[t]);return e}

package/dist/umd/n4s.development.js

@@ -529,30 +529,47 @@
 
   function enforceEager(value) {
       var target = {};
+      // This condition is for when we don't have proxy support (ES5).
+      // In this case, we need to manually assign the rules to the target object on runtime.
+      // The follow up proxy block is used in case we do have proxy support, and we can assign each rule upon invocation.
       if (!isProxySupported()) {
+          // We iterate over each of the rules, and add them to the target object being return by enforce
           eachEnforceRule(function (ruleName, ruleFn) {
+              // We then wrap the rule with `genRuleCall` that adds the base enforce behavior
               target[ruleName] = genRuleCall(target, ruleFn, ruleName);
           });
           return target;
       }
+      // We create a proxy intercepting access to the target object (which is empty).
       var proxy = new Proxy(target, {
           get: function (_, ruleName) {
+              // On property access, we identify if it is a rule or not.
               var rule = getRule(ruleName);
+              // If it is a rule, we wrap it with `genRuleCall` that adds the base enforce behavior
               if (rule) {
                   return genRuleCall(proxy, rule, ruleName);
               }
           }
       });
       return proxy;
+      // This function is used to wrap a rule with the base enforce behavior
+      // It takes the target object, the rule function, and the rule name
+      // It then returns the rule, in a manner that can be used by enforce
       function genRuleCall(target, rule, ruleName) {
           return function ruleCall() {
               var args = [];
               for (var _i = 0; _i < arguments.length; _i++) {
                   args[_i] = arguments[_i];
               }
+              // Order of operation:
+              // 1. Create a context with the value being enforced
+              // 2. Call the rule within the context, and pass over the arguments passed to it
+              // 3. Transform the result to the correct output format
               var transformedResult = ctx.run({ value: value }, function () {
                   return transformResult.apply(void 0, __spreadArray([rule.apply(void 0, __spreadArray([value], args, false)), ruleName, value], args, false));
               });
+              // On rule failure (the result is false), we either throw an error
+              // or throw a string value if the rule has a message defined in it.
               invariant(transformedResult.pass, isNullish(transformedResult.message)
                   ? "enforce/".concat(ruleName, " failed with ").concat(JSON.stringify(value))
                   : StringObject(transformedResult.message));

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.1.9-dev-c786f7",
+  "version": "4.1.9-dev-9b46fb",
   "license": "MIT",
   "main": "./dist/cjs/n4s.js",
   "types": "./types/n4s.d.ts",
@@ -10,8 +10,8 @@
     "release": "vx release"
   },
   "dependencies": {
-    "context": "^2.0.8-dev-c786f7",
-    "vest-utils": "^0.0.4-dev-c786f7"
+    "context": "^2.0.8-dev-9b46fb",
+    "vest-utils": "^0.0.2-dev-9b46fb"
   },
   "module": "./dist/es/n4s.production.js",
   "exports": {

package/types/compose.d.ts

@@ -3,6 +3,7 @@ type DropFirst<T extends unknown[]> = T extends [
     ...infer U
 ] ? U : never;
 type Stringable = string | ((...args: any[]) => string);
+type CB = (...args: any[]) => any;
 type RuleReturn = boolean | {
     pass: boolean;
     message?: Stringable;
@@ -111,7 +112,7 @@ type LazyRules = n4s.IRules<LazyRuleMethods>;
 type Lazy = LazyRules & LazyRuleMethods & 
 // This is a "catch all" hack to make TS happy while not
 // losing type hints
-Record<string, (...args: any[]) => any>;
+Record<string, CB>;
 type LazyRuleMethods = LazyRuleRunners & {
     message: (message: LazyMessage) => Lazy;
 };

package/types/compounds.d.ts

@@ -3,6 +3,7 @@ type DropFirst<T extends unknown[]> = T extends [
     ...infer U
 ] ? U : never;
 type Stringable = string | ((...args: any[]) => string);
+type CB = (...args: any[]) => any;
 type RuleReturn = boolean | {
     pass: boolean;
     message?: Stringable;
@@ -111,7 +112,7 @@ type LazyRules = n4s.IRules<LazyRuleMethods>;
 type Lazy = LazyRules & LazyRuleMethods & 
 // This is a "catch all" hack to make TS happy while not
 // losing type hints
-Record<string, (...args: any[]) => any>;
+Record<string, CB>;
 type LazyRuleMethods = LazyRuleRunners & {
     message: (message: LazyMessage) => Lazy;
 };

package/types/n4s.d.ts

@@ -20,6 +20,7 @@ type DropFirst<T extends unknown[]> = T extends [
     ...infer U
 ] ? U : never;
 type Stringable = string | ((...args: any[]) => string);
+type CB = (...args: any[]) => any;
 type RuleReturn = boolean | {
     pass: boolean;
     message?: Stringable;
@@ -134,7 +135,7 @@ type LazyRules = n4s.IRules<LazyRuleMethods>;
 type Lazy = LazyRules & LazyRuleMethods & 
 // This is a "catch all" hack to make TS happy while not
 // losing type hints
-Record<string, (...args: any[]) => any>;
+Record<string, CB>;
 type LazyRuleMethods = LazyRuleRunners & {
     message: (message: LazyMessage) => Lazy;
 };

package/types/schema.d.ts

@@ -3,6 +3,7 @@ type DropFirst<T extends unknown[]> = T extends [
     ...infer U
 ] ? U : never;
 type Stringable = string | ((...args: any[]) => string);
+type CB = (...args: any[]) => any;
 type RuleReturn = boolean | {
     pass: boolean;
     message?: Stringable;
@@ -111,7 +112,7 @@ type LazyRules = n4s.IRules<LazyRuleMethods>;
 type Lazy = LazyRules & LazyRuleMethods & 
 // This is a "catch all" hack to make TS happy while not
 // losing type hints
-Record<string, (...args: any[]) => any>;
+Record<string, CB>;
 type LazyRuleMethods = LazyRuleRunners & {
     message: (message: LazyMessage) => Lazy;
 };