breaking: [N4S] Remove ensure export as it is now replaced by the laz…

…y enforce interface (#497)

jsconfig.json

@@ -35,18 +35,9 @@
       "enforceRunner": [
         "./packages/n4s/src/enforce/enforceRunner.js"
       ],
-      "ensure": [
-        "./packages/n4s/src/ensure/ensure.js"
-      ],
-      "ensureRunner": [
-        "./packages/n4s/src/ensure/ensureRunner.js"
-      ],
       "enforceExtended": [
         "./packages/n4s/src/extended/enforceExtended.js"
       ],
-      "ensureExtended": [
-        "./packages/n4s/src/extended/ensureExtended.js"
-      ],
       "rulesExtended": [
         "./packages/n4s/src/extended/rulesExtended.js"
       ],

packages/n4s/README.md

@@ -26,12 +26,21 @@ enforce(4)
 npm i n4s
 ```
 
-## Using enforce without a testing framework
+## Non throwing validations
 
-If you wish to use enforce's functionality without it throwing errors, you can use its [ensure](https://ealush.github.io/n4s/#/ensure) interface.
+> This functionality replaces the no-longer supported ensure export, as it performs the same functionality with better performance.
+
+If you wish to use enforce's functionality safely with a boolean return interface, you can use its lazy validation interface:
+
+```js
+enforce
+  .isArray()
+  .longerThan(3)
+  .test([1,2,3])
+```
 
 [Read the docs](https://ealush.github.io/n4s)
 
 - [List of enforce rules](https://ealush.github.io/n4s/#/rules)
+- [Schema validation](https://ealush.github.io/n4s/#/shape)
 - [Custom enforce rules](https://ealush.github.io/n4s/#/custom)
-- [Non throwing validations](https://ealush.github.io/n4s/#/ensure)

packages/n4s/config/rollup/rollup.config.js

@@ -1,5 +1,4 @@
 import enforce from './enforce';
 import enforceExtended from './enforceExtended';
-import ensure from './ensure';
 
-export default [].concat(enforce, ensure, enforceExtended);
+export default [].concat(enforce, enforceExtended);

packages/n4s/docs/README.md

@@ -26,13 +26,22 @@ enforce(4)
 npm i n4s
 ```
 
-## Using enforce without a testing framework
+## Non throwing validations
 
-If you wish to use enforce's functionality without it throwing errors, you can use its [ensure](./ensure) interface.
+> This functionality replaces the no-longer supported ensure export, as it performs the same functionality with better performance.
+
+If you wish to use enforce's functionality safely with a boolean return interface instead, you can use its lazy validation interface:
+
+```js
+enforce
+  .isArray()
+  .longerThan(3)
+  .test([1,2,3])
+```
 
 ## Content
 
 - [List of Enforce rules](./rules)
 - [Business reated rules](./business_rules)
+- [Schema validation](./shape)
 - [Custom Enforce Rules](./custom)
-- [Non throwing validations (ensure)](./ensure)

packages/n4s/docs/_sidebar.md

@@ -3,4 +3,3 @@
 - [Business reated rules](./business_rules)
 - [Schema validations](./shape)
 - [Custom Enforce Rules](./custom)
-- [Non throwing validations (ensure)](./ensure)

packages/n4s/package.json

@@ -14,19 +14,9 @@
     "./enforceExtended.umd.development.js": "./enforceExtended.umd.development.js",
     "./enforceExtended.umd.production.js": "./enforceExtended.umd.production.js",
     "./enforceExtended.umd.production.min.js": "./enforceExtended.umd.production.min.js",
-    "./ensure.cjs.development.js": "./ensure.cjs.development.js",
-    "./ensure.cjs.production.js": "./ensure.cjs.production.js",
-    "./ensure.cjs.production.min.js": "./ensure.cjs.production.min.js",
-    "./ensure.js": "./ensure.js",
-    "./ensure.umd.development.js": "./ensure.umd.development.js",
-    "./ensure.umd.production.js": "./ensure.umd.production.js",
-    "./ensure.umd.production.min.js": "./ensure.umd.production.min.js",
     "./esm/enforceExtended.mjs.development.js": "./esm/enforceExtended.mjs.development.js",
     "./esm/enforceExtended.mjs.production.js": "./esm/enforceExtended.mjs.production.js",
     "./esm/enforceExtended.mjs.production.min.js": "./esm/enforceExtended.mjs.production.min.js",
-    "./esm/ensure.mjs.development.js": "./esm/ensure.mjs.development.js",
-    "./esm/ensure.mjs.production.js": "./esm/ensure.mjs.production.js",
-    "./esm/ensure.mjs.production.min.js": "./esm/ensure.mjs.production.min.js",
     "./esm/n4s.mjs.development.js": "./esm/n4s.mjs.development.js",
     "./esm/n4s.mjs.production.js": "./esm/n4s.mjs.production.js",
     "./esm/n4s.mjs.production.min.js": "./esm/n4s.mjs.production.min.js",

packages/vest/docs/enforce.md

@@ -1291,9 +1291,9 @@ enforce.extend({
 
 ## Shape validations
 
-Enforce (only, not ensure) comes with a built-in lean schema validator rule called `shape`. It allows you to use all the existing and custom rules of enforce to validate the shape of an object.
+Enforce comes with a built-in lean schema validator rule called `shape`. It allows you to use all the existing and custom rules of enforce to validate the shape of an object.
 
-When using enforce rules inside your shape, use the rules that exist as properties on enforce itself (`enforce.isString()`). For rules used like this, rule chaining is not possible.
+When using enforce rules inside your shape, use the rules that exist as properties on enforce itself (`enforce.isString()`).
 
 ### Example
 

packages/vest/src/typings/vest.d.ts

@@ -204,7 +204,7 @@ type LazyInside = (
 
 type TEnforceLazy = {
   [key: string]: (...args: any[]) => TEnforceLazy | boolean;
-  run: (...args: any[]) => boolean;
+  test: (...args: any[]) => boolean;
   equals: LazyAny;
   notEquals: LazyAny;
   numberEquals: LazyNumeral;