@bedrockio/yada 1.0.7 → 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

@@ -46,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/object.js

@@ -48,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 {
@@ -62,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/yada",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Validation library inspired by Joi.",
   "scripts": {
     "test": "jest",

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/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();