@bedrockio/yada 1.0.6 → 1.0.8

package/README.md

@@ -22,6 +22,7 @@ Concepts
   - [Reject](#reject)
   - [Custom](#custom)
   - [Default](#default)
+  - [Strip](#strip)
 - [Validation Options](#validation-options)
 - [Error Messages](#error-messages)
 - [Localization](#localization)
@@ -467,6 +468,24 @@ console.log(await schema.validate()); // "hi!"
 console.log(await schema.validate('hello!')); // "hello!"
 ```
 
+### Strip
+
+The `strip` method serves as a way to conditionally exclude fields when the
+schema is used inside an object schema:
+
+```js
+const schema = yd.object({
+  name: yd.string(),
+  age: yd.number().strip((val, { self }) => {
+    // That's private!
+    return !self;
+  }),
+});
+```
+
+Arguments are identical to those passed to [custom](#custom). The field will be
+stripped out if the function returns a truthy value.
+
 ## Validation Options
 
 Validation options in Yada can be passed at runtime on validation or baked into

package/dist/cjs/Schema.js

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 exports.isSchema = isSchema;
 var _errors = require("./errors");
@@ -44,6 +46,11 @@ class Schema {
       return await fn(val, options);
     });
   }
+  strip(strip) {
+    return this.clone({
+      strip
+    });
+  }
   allow(...set) {
     return this.assertEnum(set, true);
   }

package/dist/cjs/TypeSchema.js

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _Schema = _interopRequireDefault(require("./Schema"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/cjs/array.js

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _Schema = _interopRequireDefault(require("./Schema"));
 var _errors = require("./errors");
@@ -60,6 +62,17 @@ class ArraySchema extends _Schema.default {
       });
     }
   }
+  length(length) {
+    return this.clone().assert('length', arr => {
+      if (arr.length !== length) {
+        const s = length === 1 ? '' : 's';
+        throw new _errors.LocalizedError('Must contain exactly {length} element{s}.', {
+          length,
+          s
+        });
+      }
+    });
+  }
   min(length) {
     return this.clone().assert('length', arr => {
       if (arr.length < length) {

package/dist/cjs/boolean.js

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _TypeSchema = _interopRequireDefault(require("./TypeSchema"));
 var _errors = require("./errors");

package/dist/cjs/date.js

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _validator = _interopRequireDefault(require("validator"));
 var _utils = require("./utils");

package/dist/cjs/errors.js

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.ValidationError = exports.LocalizedError = exports.FieldError = exports.ElementError = exports.AssertionError = exports.ArrayError = void 0;
 exports.isSchemaError = isSchemaError;
 var _messages = require("./messages");

package/dist/cjs/index.js

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _array = _interopRequireDefault(require("./array"));
 var _boolean = _interopRequireDefault(require("./boolean"));

package/dist/cjs/localization.js

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.getLocalized = getLocalized;
 exports.getLocalizerTemplates = getLocalizerTemplates;
 exports.localize = localize;

package/dist/cjs/messages.js

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.getFullMessage = getFullMessage;
 var _errors = require("./errors");
 var _localization = require("./localization");

package/dist/cjs/number.js

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _TypeSchema = _interopRequireDefault(require("./TypeSchema"));
 var _errors = require("./errors");

package/dist/cjs/object.js

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _TypeSchema = _interopRequireDefault(require("./TypeSchema"));
 var _errors = require("./errors");
@@ -46,9 +48,22 @@ class ObjectSchema extends _TypeSchema.default {
     for (let [key, schema] of Object.entries(this.meta.fields)) {
       this.assert('field', async (obj, options) => {
         if (obj) {
-          let val;
+          const val = obj[key];
+          const {
+            strip
+          } = schema.meta;
+          if (strip && strip(val, options)) {
+            delete obj[key];
+            return;
+          }
           try {
-            val = await schema.validate(obj[key], options);
+            const result = await schema.validate(val, options);
+            if (result !== undefined) {
+              return {
+                ...obj,
+                [key]: result
+              };
+            }
           } catch (error) {
             if (error.details?.length === 1) {
               const {
@@ -60,12 +75,6 @@ class ObjectSchema extends _TypeSchema.default {
               throw new _errors.FieldError('Field failed validation.', key, error.original, error.details);
             }
           }
-          return {
-            ...obj,
-            ...(val !== undefined && {
-              [key]: val
-            })
-          };
         }
       });
     }

package/dist/cjs/password.js

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.PASSWORD_DEFAULTS = void 0;
 exports.validateLength = validateLength;
 exports.validateUppercase = exports.validateSymbols = exports.validateNumbers = exports.validateLowercase = void 0;

package/dist/cjs/string.js

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _validator = _interopRequireDefault(require("validator"));
 var _TypeSchema = _interopRequireDefault(require("./TypeSchema"));

package/dist/cjs/utils.js

@@ -1,14 +1,25 @@
 "use strict";
 
-exports.__esModule = true;
-exports.isSchemaError = exports.isSchema = void 0;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "isSchema", {
+  enumerable: true,
+  get: function () {
+    return _Schema.isSchema;
+  }
+});
+Object.defineProperty(exports, "isSchemaError", {
+  enumerable: true,
+  get: function () {
+    return _errors.isSchemaError;
+  }
+});
 exports.wrapAny = wrapAny;
 exports.wrapArgs = wrapArgs;
 exports.wrapSchema = wrapSchema;
 var _Schema = _interopRequireWildcard(require("./Schema"));
-exports.isSchema = _Schema.isSchema;
 var _errors = require("./errors");
-exports.isSchemaError = _errors.isSchemaError;
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function wrapSchema(Class) {

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@bedrockio/yada",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Validation library inspired by Joi.",
   "scripts": {
-    "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest",
+    "test": "jest",
     "lint": "eslint",
     "build": "scripts/build",
     "prepublishOnly": "npm run build"

package/src/Schema.js

@@ -46,6 +46,10 @@ export default class Schema {
     });
   }
 
+  strip(strip) {
+    return this.clone({ strip });
+  }
+
   allow(...set) {
     return this.assertEnum(set, true);
   }

package/src/array.js

@@ -59,6 +59,18 @@ class ArraySchema extends Schema {
     }
   }
 
+  length(length) {
+    return this.clone().assert('length', (arr) => {
+      if (arr.length !== length) {
+        const s = length === 1 ? '' : 's';
+        throw new LocalizedError('Must contain exactly {length} element{s}.', {
+          length,
+          s,
+        });
+      }
+    });
+  }
+
   min(length) {
     return this.clone().assert('length', (arr) => {
       if (arr.length < length) {

package/src/object.js

@@ -38,9 +38,22 @@ class ObjectSchema extends TypeSchema {
     for (let [key, schema] of Object.entries(this.meta.fields)) {
       this.assert('field', async (obj, options) => {
         if (obj) {
-          let val;
+          const val = obj[key];
+          const { strip } = schema.meta;
+
+          if (strip && strip(val, options)) {
+            delete obj[key];
+            return;
+          }
+
           try {
-            val = await schema.validate(obj[key], options);
+            const result = await schema.validate(val, options);
+            if (result !== undefined) {
+              return {
+                ...obj,
+                [key]: result,
+              };
+            }
           } catch (error) {
             if (error.details?.length === 1) {
               const { message, original } = error.details[0];
@@ -54,12 +67,6 @@ class ObjectSchema extends TypeSchema {
               );
             }
           }
-          return {
-            ...obj,
-            ...(val !== undefined && {
-              [key]: val,
-            }),
-          };
         }
       });
     }

package/test/all.test.js

@@ -693,6 +693,29 @@ describe('custom', () => {
   });
 });
 
+describe('strip', () => {
+  it('should conditionally strip out fields', async () => {
+    const schema = yd.object({
+      name: yd.string(),
+      age: yd.number().strip((val, { self }) => {
+        return !self;
+      }),
+    });
+    const result = await schema.validate(
+      {
+        name: 'Brett',
+        age: 25,
+      },
+      {
+        isPrivate: true,
+      }
+    );
+    expect(result).toEqual({
+      name: 'Brett',
+    });
+  });
+});
+
 describe('array', () => {
   it('should validate an optional array', async () => {
     const schema = yd.array();
@@ -770,6 +793,13 @@ describe('array', () => {
     await assertFail(schema, [{ bar: 'hi' }], ['Unknown field "bar".']);
   });
 
+  it('should validate a fixed length', async () => {
+    const schema = yd.array().length(2);
+    await assertFail(schema, [1], ['Must contain exactly 2 elements.']);
+    await assertPass(schema, [1, 2]);
+    await assertFail(schema, [1, 2, 3], ['Must contain exactly 2 elements.']);
+  });
+
   it('should validate a minimum length', async () => {
     const schema = yd.array().min(1);
     await assertPass(schema, ['one']);