@bedrockio/yada 1.2.6 → 1.2.8

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 1.2.8
+
+- Added "missing" which runs a custom validator on undefined.
+
+## 1.2.7
+
+- Removed private fields due to typescript bug
+
+## 1.2.6
+
+- Changed types config
+
+## 1.2.5 bumped node version

package/README.md

@@ -27,6 +27,7 @@ Concepts
   - [strip](#strip)
   - [nullable](#nullable)
   - [message](#message)
+  - [missing](#missing)
 - [Validation Options](#validation-options)
 - [Error Messages](#error-messages)
 - [Localization](#localization)
@@ -60,9 +61,9 @@ The schema will now validate input with `validate`:
 ```js
 await schema.validate({
   name: 'Jules',
-  email: 'jules@gmail.com
+  email: 'jules@gmail.com',
   age: 25,
-})
+});
 ```
 
 Note that the `validate` method is asynchronous so must be awaited with `await`
@@ -220,6 +221,15 @@ There are also transform methods that will transform input:
 - `uppercase` - Transforms input into upper case. Passing `true` as the first
   argument will instead error if input is not upper case.
 
+Note that empty strings are allowed by default unless `required`. If you need an
+optional string field that may not be empty, then use `options`:
+
+```js
+const schema = yd.string().options({
+  allowEmpty: false,
+});
+```
+
 ### Number
 
 Numbers have a handful of useful valiadtions:
@@ -444,6 +454,10 @@ The `custom` schema allows for custom validations expressed in code. A custom
 schema may either throw an error or transform the input by returning a value
 that is not `undefined`.
 
+> [!WARNING] Note that `custom` will only be run if a value is passed other than
+> `undefined`. To run more complex validations on optional fields, use the
+> [`missing`](#missing) method.
+
 ```js
 const schema = yd.custom((val) => {
   if (val === 'foo') {
@@ -636,6 +650,29 @@ try {
 }
 ```
 
+### Missing
+
+Allows custom validations when no value is passed:
+
+```js
+const schema = yd.object({
+  type: yd.string().allow('email', 'phone'),
+  email: yd.string.email(),
+  phone: yd
+    .string()
+    .phone()
+    .missing(({ root }) => {
+      // Run this assertion when "phone" is undefined.
+      // Contrast this with "custom" which will never be run
+      // here as it is part of the valiation chain and bails
+      // after the string validation cannot be fulfilled.
+      if (root.type === 'phone') {
+        throw new Error('"phone" must be passed when "type" is "phone"');
+      }
+    }),
+});
+```
+
 ## Validation Options
 
 Validation options in Yada can be passed at runtime on validation or baked into

package/dist/cjs/Schema.js

@@ -8,7 +8,7 @@ exports.isSchema = isSchema;
 var _errors = require("./errors");
 var _utils = require("./utils");
 const INITIAL_TYPES = ['default', 'required', 'type', 'transform', 'empty'];
-const REQUIRED_TYPES = ['default', 'required'];
+const REQUIRED_TYPES = ['default', 'required', 'missing'];
 class Schema {
   constructor(meta = {}) {
     this.assertions = [];
@@ -59,6 +59,20 @@ class Schema {
     });
   }
 
+  /**
+   * Validate by a custom function when no value passed. [Link](https://github.com/bedrockio/yada#missing)
+   * @param {Function} fn
+   * @returns {this}
+   */
+  missing(fn) {
+    if (!fn) {
+      throw new Error('Assertion function required.');
+    }
+    return this.clone().assert('missing', async (val, options) => {
+      return await fn(val, options);
+    });
+  }
+
   /**
    * Conditionally exclude fields inside an object schema.
    * [Link](https://github.com/bedrockio/yada#strip)
@@ -143,16 +157,11 @@ class Schema {
       original: value
     };
     for (let assertion of this.assertions) {
-      if (value === undefined && !assertion.required) {
-        break;
-      } else if (value === null && options.nullable) {
-        break;
+      if (this.canSkipAssertion(value, assertion, options)) {
+        continue;
       }
       try {
-        const result = await this.runAssertion(assertion, value, options);
-        if (result !== undefined) {
-          value = result;
-        }
+        value = await this.runAssertion(value, assertion, options);
       } catch (error) {
         const {
           type
@@ -340,6 +349,15 @@ class Schema {
       return this.getSortIndex(a.type) - this.getSortIndex(b.type);
     });
   }
+  canSkipAssertion(value, assertion, options) {
+    if (value === undefined) {
+      return !assertion.required;
+    } else if (value === null) {
+      return options.nullable;
+    } else {
+      return assertion.type === 'missing';
+    }
+  }
 
   /**
    * @returns {this}
@@ -356,11 +374,21 @@ class Schema {
     const index = INITIAL_TYPES.indexOf(type);
     return index === -1 ? INITIAL_TYPES.length : index;
   }
-  async runAssertion(assertion, value, options = {}) {
+  async runAssertion(value, assertion, options = {}) {
     const {
+      type,
       fn
     } = assertion;
-    return await fn(value, options);
+    let result;
+    if (type === 'missing') {
+      result = await fn(options);
+    } else {
+      result = await fn(value, options);
+    }
+    if (result !== undefined) {
+      return result;
+    }
+    return value;
   }
   enumToOpenApi() {
     const {

package/dist/cjs/array.js

@@ -16,10 +16,6 @@ class ArraySchema extends _TypeSchema.default {
     });
     this.setup();
   }
-
-  /**
-   * @private
-   */
   setup() {
     const {
       schemas

package/dist/cjs/messages.js

@@ -44,15 +44,21 @@ function getInnerPath(error, options) {
   }
 }
 function getLabeledMessage(error, options) {
+  const {
+    message
+  } = error;
   const {
     path = []
   } = options;
-  const base = getBase(error.message);
   let template;
-  if (base.includes('{field}')) {
-    template = base;
-  } else if (canAutoAddField(path, base)) {
-    template = `{field} ${downcase(base)}`;
+  if (message.includes('{field}')) {
+    template = message;
+  } else if (canAutoAddField(path, message)) {
+    if (message === 'Value is required.') {
+      template = '{field} is required.';
+    } else {
+      template = `{field} ${downcase(message)}`;
+    }
   } else {
     template = error.message;
   }
@@ -61,10 +67,10 @@ function getLabeledMessage(error, options) {
       field: getFieldLabel(options)
     });
   } else {
-    return (0, _localization.localize)(base);
+    return (0, _localization.localize)(message);
   }
 }
-const GENERIC_MESSAGE_REG = /^Must|is required\.?$/;
+const GENERIC_MESSAGE_REG = /^(Must|Value is required\.)/;
 
 // Only "generic" error messages should automatically add the field.
 // A custom error message may be "Please verify you are human" which
@@ -84,13 +90,6 @@ function getFieldLabel(options) {
     return `"${path.join('.')}"`;
   }
 }
-function getBase(str) {
-  if (str === 'Value is required.') {
-    return 'is required.';
-  } else {
-    return str;
-  }
-}
 function naturalize(str) {
   const first = str.slice(0, 1).toUpperCase();
   let rest = str.slice(1);

package/dist/cjs/object.js

@@ -25,10 +25,6 @@ class ObjectSchema extends _TypeSchema.default {
     });
     this.setup();
   }
-
-  /**
-   * @private
-   */
   setup() {
     this.assert('type', val => {
       if (val === null || typeof val !== 'object') {
@@ -91,7 +87,12 @@ class ObjectSchema extends _TypeSchema.default {
             // Do not pass down message into validators
             // to allow custom messages to take precedence.
             options = (0, _utils.omit)(options, 'message');
-            const result = await schema.validate(val, options);
+            const result = await schema.validate(val, {
+              ...options,
+              // Re-pass the object as root here as its fields
+              // may have been transformed by defaults.
+              root: obj
+            });
             if (result !== undefined) {
               return {
                 ...obj,
@@ -108,10 +109,6 @@ class ObjectSchema extends _TypeSchema.default {
       });
     }
   }
-
-  /**
-   * @private
-   */
   getFields() {
     return this.meta.fields || {};
   }

package/dist/cjs/tuple.js

@@ -14,14 +14,9 @@ class TupleSchema extends _Schema.default {
     });
     this.setup();
   }
-
-  /**
-   * @private
-   */
   setup() {
     const {
-      schemas,
-      message
+      schemas
     } = this.meta;
     this.assert('type', (val, options) => {
       if (typeof val === 'string' && options.cast) {

package/package.json

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

package/src/Schema.js

@@ -9,7 +9,7 @@ import {
 import { omit } from './utils';
 
 const INITIAL_TYPES = ['default', 'required', 'type', 'transform', 'empty'];
-const REQUIRED_TYPES = ['default', 'required'];
+const REQUIRED_TYPES = ['default', 'required', 'missing'];
 
 export default class Schema {
   constructor(meta = {}) {
@@ -57,6 +57,20 @@ export default class Schema {
     });
   }
 
+  /**
+   * Validate by a custom function when no value passed. [Link](https://github.com/bedrockio/yada#missing)
+   * @param {Function} fn
+   * @returns {this}
+   */
+  missing(fn) {
+    if (!fn) {
+      throw new Error('Assertion function required.');
+    }
+    return this.clone().assert('missing', async (val, options) => {
+      return await fn(val, options);
+    });
+  }
+
   /**
    * Conditionally exclude fields inside an object schema.
    * [Link](https://github.com/bedrockio/yada#strip)
@@ -136,17 +150,12 @@ export default class Schema {
     };
 
     for (let assertion of this.assertions) {
-      if (value === undefined && !assertion.required) {
-        break;
-      } else if (value === null && options.nullable) {
-        break;
+      if (this.canSkipAssertion(value, assertion, options)) {
+        continue;
       }
 
       try {
-        const result = await this.runAssertion(assertion, value, options);
-        if (result !== undefined) {
-          value = result;
-        }
+        value = await this.runAssertion(value, assertion, options);
       } catch (error) {
         const { type } = assertion;
         const { message } = error;
@@ -322,6 +331,16 @@ export default class Schema {
     });
   }
 
+  canSkipAssertion(value, assertion, options) {
+    if (value === undefined) {
+      return !assertion.required;
+    } else if (value === null) {
+      return options.nullable;
+    } else {
+      return assertion.type === 'missing';
+    }
+  }
+
   /**
    * @returns {this}
    */
@@ -339,9 +358,18 @@ export default class Schema {
     return index === -1 ? INITIAL_TYPES.length : index;
   }
 
-  async runAssertion(assertion, value, options = {}) {
-    const { fn } = assertion;
-    return await fn(value, options);
+  async runAssertion(value, assertion, options = {}) {
+    const { type, fn } = assertion;
+    let result;
+    if (type === 'missing') {
+      result = await fn(options);
+    } else {
+      result = await fn(value, options);
+    }
+    if (result !== undefined) {
+      return result;
+    }
+    return value;
   }
 
   enumToOpenApi() {

package/src/array.js

@@ -9,9 +9,6 @@ class ArraySchema extends TypeSchema {
     this.setup();
   }
 
-  /**
-   * @private
-   */
   setup() {
     const { schemas } = this.meta;
     const schema =

package/src/messages.js

@@ -40,14 +40,18 @@ function getInnerPath(error, options) {
 }
 
 function getLabeledMessage(error, options) {
+  const { message } = error;
   const { path = [] } = options;
-  const base = getBase(error.message);
 
   let template;
-  if (base.includes('{field}')) {
-    template = base;
-  } else if (canAutoAddField(path, base)) {
-    template = `{field} ${downcase(base)}`;
+  if (message.includes('{field}')) {
+    template = message;
+  } else if (canAutoAddField(path, message)) {
+    if (message === 'Value is required.') {
+      template = '{field} is required.';
+    } else {
+      template = `{field} ${downcase(message)}`;
+    }
   } else {
     template = error.message;
   }
@@ -57,11 +61,11 @@ function getLabeledMessage(error, options) {
       field: getFieldLabel(options),
     });
   } else {
-    return localize(base);
+    return localize(message);
   }
 }
 
-const GENERIC_MESSAGE_REG = /^Must|is required\.?$/;
+const GENERIC_MESSAGE_REG = /^(Must|Value is required\.)/;
 
 // Only "generic" error messages should automatically add the field.
 // A custom error message may be "Please verify you are human" which
@@ -80,14 +84,6 @@ function getFieldLabel(options) {
   }
 }
 
-function getBase(str) {
-  if (str === 'Value is required.') {
-    return 'is required.';
-  } else {
-    return str;
-  }
-}
-
 function naturalize(str) {
   const first = str.slice(0, 1).toUpperCase();
   let rest = str.slice(1);

package/src/object.js

@@ -15,9 +15,6 @@ class ObjectSchema extends TypeSchema {
     this.setup();
   }
 
-  /**
-   * @private
-   */
   setup() {
     this.assert('type', (val) => {
       if (val === null || typeof val !== 'object') {
@@ -73,7 +70,12 @@ class ObjectSchema extends TypeSchema {
             // Do not pass down message into validators
             // to allow custom messages to take precedence.
             options = omit(options, 'message');
-            const result = await schema.validate(val, options);
+            const result = await schema.validate(val, {
+              ...options,
+              // Re-pass the object as root here as its fields
+              // may have been transformed by defaults.
+              root: obj,
+            });
             if (result !== undefined) {
               return {
                 ...obj,
@@ -89,9 +91,6 @@ class ObjectSchema extends TypeSchema {
     }
   }
 
-  /**
-   * @private
-   */
   getFields() {
     return this.meta.fields || {};
   }

package/src/tuple.js

@@ -7,11 +7,8 @@ class TupleSchema extends Schema {
     this.setup();
   }
 
-  /**
-   * @private
-   */
   setup() {
-    const { schemas, message } = this.meta;
+    const { schemas } = this.meta;
 
     this.assert('type', (val, options) => {
       if (typeof val === 'string' && options.cast) {

package/types/Schema.d.ts

@@ -18,6 +18,12 @@ export default class Schema {
      * @returns {this}
      */
     custom(fn: Function): this;
+    /**
+     * Validate by a custom function when no value passed. [Link](https://github.com/bedrockio/yada#missing)
+     * @param {Function} fn
+     * @returns {this}
+     */
+    missing(fn: Function): this;
     /**
      * Conditionally exclude fields inside an object schema.
      * [Link](https://github.com/bedrockio/yada#strip)
@@ -88,12 +94,13 @@ export default class Schema {
      */
     assert(type: any, fn: any): this;
     pushAssertion(assertion: any): void;
+    canSkipAssertion(value: any, assertion: any, options: any): any;
     /**
      * @returns {this}
      */
     transform(fn: any): this;
     getSortIndex(type: any): number;
-    runAssertion(assertion: any, value: any, options?: {}): Promise<any>;
+    runAssertion(value: any, assertion: any, options?: {}): Promise<any>;
     enumToOpenApi(): any;
 }
 //# sourceMappingURL=Schema.d.ts.map

package/types/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AAmYA,kDAEC;AAxXD;IACE,uBAGC;IAFC,kBAAoB;IACpB,SAAgB;IAKlB;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;;OAGG;IACH,mBAFa,IAAI,CAShB;IAED;;;;OAIG;IACH,sBAFa,IAAI,CAShB;IAED;;;;OAIG;IACH,mBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,sBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,uBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,YAFa,IAAI,CAIhB;IAED;;OAEG;IACH,uBAFa,IAAI,CAIhB;IAED;;OAEG;IACH,gBAFa,IAAI,CAShB;IAED;;OAEG;IACH,+BAFa,IAAI,CAMhB;IAED;;OAEG;IACH,uBAFa,IAAI,CAIhB;IAED,iDA8CC;IAED;;OAEG;IACH,kBAFa,IAAI,CAOhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAMhB;IAED,2BAYC;IAED;;MAOC;IAED;;;;MASC;IAED;;MAOC;IAED,4BAMC;IAED,kBAEC;IAID;;OAEG;IACH,kCAFa,IAAI,CAiDhB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAGC;IAED,qBAsCC;CACF"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AA+ZA,kDAEC;AApZD;IACE,uBAGC;IAFC,kBAAoB;IACpB,SAAgB;IAKlB;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;;OAGG;IACH,mBAFa,IAAI,CAShB;IAED;;;;OAIG;IACH,sBAFa,IAAI,CAShB;IAED;;;;OAIG;IACH,uBAFa,IAAI,CAShB;IAED;;;;OAIG;IACH,mBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,sBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,uBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,YAFa,IAAI,CAIhB;IAED;;OAEG;IACH,uBAFa,IAAI,CAIhB;IAED;;OAEG;IACH,gBAFa,IAAI,CAShB;IAED;;OAEG;IACH,+BAFa,IAAI,CAMhB;IAED;;OAEG;IACH,uBAFa,IAAI,CAIhB;IAED,iDAyCC;IAED;;OAEG;IACH,kBAFa,IAAI,CAOhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAMhB;IAED,2BAYC;IAED;;MAOC;IAED;;;;MASC;IAED;;MAOC;IAED,4BAMC;IAED,kBAEC;IAID;;OAEG;IACH,kCAFa,IAAI,CAiDhB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED,gEAQC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAYC;IAED,qBAsCC;CACF"}

package/types/array.d.ts

@@ -10,10 +10,7 @@ export default function _default(...schemas?: Schema[]): ArraySchema;
 import Schema from './Schema';
 declare class ArraySchema extends TypeSchema {
     constructor(schemas: any);
-    /**
-     * @private
-     */
-    private setup;
+    setup(): void;
     length(length: any): this;
     min(length: any): this;
     max(length: any): this;

package/types/array.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../src/array.js"],"names":[],"mappings":"AAuIA;;;;;;;GAOG;AACH,8CALc,MAAM,EAAA,eAUnB;mBApJkB,UAAU;AAK7B;IACE,0BAGC;IAED;;OAEG;IACH,cAsCC;IAED,0BAUC;IAED,uBAUC;IAED,uBAaC;IAED,eAaC;IAED,mBAEC;CAuBF;uBApIsB,cAAc"}
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../src/array.js"],"names":[],"mappings":"AAoIA;;;;;;;GAOG;AACH,8CALc,MAAM,EAAA,eAUnB;mBAjJkB,UAAU;AAK7B;IACE,0BAGC;IAED,cAsCC;IAED,0BAUC;IAED,uBAUC;IAED,uBAaC;IAED,eAaC;IAED,mBAEC;CAuBF;uBAjIsB,cAAc"}

package/types/object.d.ts

@@ -13,14 +13,8 @@ export type SchemaMap = {
  * @typedef {{ [key: string]: Schema } | {}} SchemaMap
  */
 declare class ObjectSchema extends TypeSchema {
-    /**
-     * @private
-     */
-    private setup;
-    /**
-     * @private
-     */
-    private getFields;
+    setup(): void;
+    getFields(): any;
     /**
      * @param {SchemaMap|Schema} arg Object or schema to append.
      */

package/types/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AAuMA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAMnB;wBAxMY;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG,EAAE;AAD3C;;GAEG;AAEH;IAME;;OAEG;IACH,cAqEC;IAED;;OAEG;IACH,kBAEC;IAED;;OAEG;IAEH,YAHW,SAAS,GAAC,MAAM,gBAkC1B;IAED;;OAEG;IACH,gBAFc,MAAM,EAAA,gBAWnB;IAED;;OAEG;IACH,gBAFc,MAAM,EAAA,gBAWnB;CAcF;mBA5KgC,UAAU;uBAHpB,cAAc"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AAsMA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAMnB;wBAvMY;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG,EAAE;AAD3C;;GAEG;AAEH;IAME,cA0EC;IAED,iBAEC;IAED;;OAEG;IAEH,YAHW,SAAS,GAAC,MAAM,gBAkC1B;IAED;;OAEG;IACH,gBAFc,MAAM,EAAA,gBAWnB;IAED;;OAEG;IACH,gBAFc,MAAM,EAAA,gBAWnB;CAcF;mBA3KgC,UAAU;uBAHpB,cAAc"}

package/types/tuple.d.ts

@@ -9,10 +9,7 @@ export default function _default(...schemas?: Schema[]): TupleSchema;
 import Schema from './Schema';
 declare class TupleSchema extends Schema {
     constructor(schemas: any);
-    /**
-     * @private
-     */
-    private setup;
+    setup(): void;
     loose(): this;
 }
 export {};

package/types/tuple.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tuple.d.ts","sourceRoot":"","sources":["../src/tuple.js"],"names":[],"mappings":"AAsFA;;;;;;GAMG;AACH,8CAJc,MAAM,EAAA,eASnB;mBAlGkB,UAAU;AAG7B;IACE,0BAGC;IAED;;OAEG;IACH,cAoDC;IAED,cAEC;CAgBF"}
+{"version":3,"file":"tuple.d.ts","sourceRoot":"","sources":["../src/tuple.js"],"names":[],"mappings":"AAmFA;;;;;;GAMG;AACH,8CAJc,MAAM,EAAA,eASnB;mBA/FkB,UAAU;AAG7B;IACE,0BAGC;IAED,cAoDC;IAED,cAEC;CAgBF"}