@bedrockio/yada 1.0.38 → 1.0.40

package/dist/cjs/Schema.js

@@ -271,6 +271,7 @@ class Schema {
       enum: set
     }).assert('enum', async (val, options) => {
       if (val !== undefined) {
+        let error;
         for (let el of set) {
           if (isSchema(el)) {
             try {
@@ -279,16 +280,30 @@ class Schema {
               // example allowing a string or array of strings.
               options = (0, _utils.omit)(options, 'cast');
               return await el.validate(val, options);
-            } catch (error) {
+            } catch (err) {
+              const [first] = err.details;
+              const isTypeError = first?.type === 'type';
+              if (!isTypeError) {
+                // Capture the first error object only if it is not
+                // a simple type error to surface error messages on
+                // more complex schemas. Otherwise allow this to fall
+                // through to show more meaningful messages for simple
+                // enums.
+                error ||= err;
+              }
               continue;
             }
           } else if (el === val === allow) {
             return;
           }
         }
-        throw new _errors.LocalizedError(options.message || msg, {
-          types: types.join(', ')
-        });
+        if (error) {
+          throw new _errors.ValidationError(options.message || error.message, error.details);
+        } else {
+          throw new _errors.LocalizedError(options.message || msg, {
+            types: types.join(', ')
+          });
+        }
       }
     });
   }

package/dist/cjs/errors.js

@@ -27,8 +27,8 @@ class ValidationError extends Error {
     if (this.canRollup()) {
       const [first] = this.details;
       return {
-        type: this.type,
-        message: first.message
+        ...first.toJSON(),
+        type: this.type
       };
     } else {
       return {
@@ -44,11 +44,14 @@ class ValidationError extends Error {
     const {
       details
     } = this;
-    if (this.isFieldType() && details.length === 1) {
-      return !details[0].isFieldType?.();
-    } else {
+    if (details.length !== 1) {
       return false;
     }
+    const [first] = details;
+
+    // Roll up field types as long as they are not
+    // referencing nested fields.
+    return this.isFieldType() && !first.isFieldType?.();
   }
   isFieldType() {
     return this.type === 'field' || this.type === 'element';

package/dist/cjs/object.js

@@ -82,6 +82,9 @@ class ObjectSchema extends _TypeSchema.default {
             return;
           }
           try {
+            // 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);
             if (result !== undefined) {
               return {

package/dist/cjs/string.js

@@ -16,11 +16,17 @@ class StringSchema extends _TypeSchema.default {
   constructor() {
     super(String);
     this.assert('type', (val, options) => {
-      if (typeof val !== 'string' && options.cast) {
+      const {
+        cast,
+        allowEmpty
+      } = options;
+      if (cast && typeof val !== 'string') {
         val = String(val);
       }
       if (typeof val !== 'string') {
         throw new _errors.LocalizedError('Must be a string.');
+      } else if (!allowEmpty && val === '') {
+        throw new _errors.LocalizedError('String may not be empty.');
       }
       return val;
     });
@@ -35,12 +41,19 @@ class StringSchema extends _TypeSchema.default {
     }).assert('required', val => {
       if (val == null) {
         throw new _errors.LocalizedError('Value is required.');
-      } else if (val === '') {
-        throw new _errors.LocalizedError('String may not be empty.');
       }
     });
   }
 
+  /**
+   * @returns {this}
+   */
+  allowEmpty() {
+    return this.options({
+      allowEmpty: true
+    });
+  }
+
   /**
    * @param {number} length
    */
@@ -247,11 +260,14 @@ class StringSchema extends _TypeSchema.default {
   postalCode(locale = 'any') {
     return this.format('postal-code', str => {
       if (!_validator.default.isPostalCode(str, locale)) {
-        if (locale === 'US') {
-          throw new _errors.LocalizedError('Must be a valid zipcode.');
-        } else {
-          throw new _errors.LocalizedError('Must be a valid postal code.');
-        }
+        throw new _errors.LocalizedError('Must be a valid postal code.');
+      }
+    });
+  }
+  zipcode() {
+    return this.format('zipcode', str => {
+      if (!_validator.default.isPostalCode(str, 'US')) {
+        throw new _errors.LocalizedError('Must be a valid zipcode.');
       }
     });
   }

package/package.json

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

package/src/Schema.js

@@ -252,6 +252,7 @@ export default class Schema {
     const msg = `${allow ? 'Must' : 'Must not'} be one of [{types}].`;
     return this.clone({ enum: set }).assert('enum', async (val, options) => {
       if (val !== undefined) {
+        let error;
         for (let el of set) {
           if (isSchema(el)) {
             try {
@@ -260,16 +261,33 @@ export default class Schema {
               // example allowing a string or array of strings.
               options = omit(options, 'cast');
               return await el.validate(val, options);
-            } catch (error) {
+            } catch (err) {
+              const [first] = err.details;
+              const isTypeError = first?.type === 'type';
+              if (!isTypeError) {
+                // Capture the first error object only if it is not
+                // a simple type error to surface error messages on
+                // more complex schemas. Otherwise allow this to fall
+                // through to show more meaningful messages for simple
+                // enums.
+                error ||= err;
+              }
               continue;
             }
           } else if ((el === val) === allow) {
             return;
           }
         }
-        throw new LocalizedError(options.message || msg, {
-          types: types.join(', '),
-        });
+        if (error) {
+          throw new ValidationError(
+            options.message || error.message,
+            error.details
+          );
+        } else {
+          throw new LocalizedError(options.message || msg, {
+            types: types.join(', '),
+          });
+        }
       }
     });
   }

package/src/errors.js

@@ -23,8 +23,8 @@ export class ValidationError extends Error {
     if (this.canRollup()) {
       const [first] = this.details;
       return {
+        ...first.toJSON(),
         type: this.type,
-        message: first.message,
       };
     } else {
       return {
@@ -39,11 +39,14 @@ export class ValidationError extends Error {
 
   canRollup() {
     const { details } = this;
-    if (this.isFieldType() && details.length === 1) {
-      return !details[0].isFieldType?.();
-    } else {
+    if (details.length !== 1) {
       return false;
     }
+    const [first] = details;
+
+    // Roll up field types as long as they are not
+    // referencing nested fields.
+    return this.isFieldType() && !first.isFieldType?.();
   }
 
   isFieldType() {

package/src/object.js

@@ -68,6 +68,9 @@ class ObjectSchema extends TypeSchema {
             return;
           }
           try {
+            // 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);
             if (result !== undefined) {
               return {

package/src/string.js

@@ -20,11 +20,14 @@ class StringSchema extends TypeSchema {
   constructor() {
     super(String);
     this.assert('type', (val, options) => {
-      if (typeof val !== 'string' && options.cast) {
+      const { cast, allowEmpty } = options;
+      if (cast && typeof val !== 'string') {
         val = String(val);
       }
       if (typeof val !== 'string') {
         throw new LocalizedError('Must be a string.');
+      } else if (!allowEmpty && val === '') {
+        throw new LocalizedError('String may not be empty.');
       }
       return val;
     });
@@ -37,12 +40,17 @@ class StringSchema extends TypeSchema {
     return this.clone({ required: true }).assert('required', (val) => {
       if (val == null) {
         throw new LocalizedError('Value is required.');
-      } else if (val === '') {
-        throw new LocalizedError('String may not be empty.');
       }
     });
   }
 
+  /**
+   * @returns {this}
+   */
+  allowEmpty() {
+    return this.options({ allowEmpty: true });
+  }
+
   /**
    * @param {number} length
    */
@@ -257,11 +265,15 @@ class StringSchema extends TypeSchema {
   postalCode(locale = 'any') {
     return this.format('postal-code', (str) => {
       if (!validator.isPostalCode(str, locale)) {
-        if (locale === 'US') {
-          throw new LocalizedError('Must be a valid zipcode.');
-        } else {
-          throw new LocalizedError('Must be a valid postal code.');
-        }
+        throw new LocalizedError('Must be a valid postal code.');
+      }
+    });
+  }
+
+  zipcode() {
+    return this.format('zipcode', (str) => {
+      if (!validator.isPostalCode(str, 'US')) {
+        throw new LocalizedError('Must be a valid zipcode.');
       }
     });
   }

package/types/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AA4WA,4CAEC;AAlWD;;GAEG;AAEH;IACE,uBAGC;IAFC,kBAAoB;IACpB,SAAgB;IAKlB;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;;OAGG;IACH,mBAFa,IAAI,CAShB;IAED;;;;OAIG;IACH,gBAHW,eAAe,GACb,IAAI,CAmBhB;IAED;;;;OAIG;IACH,mBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,sBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,uBAFa,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,iDAqCC;IAED;;OAEG;IACH,kBAFa,IAAI,CAOhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAMhB;IAED,2BAWC;IAED;;MAOC;IAED;;;;MASC;IAED,kBAEC;IAED,4BAMC;IAID;;OAEG;IACH,kCAFa,IAAI,CAmChB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAUC;IAED;;;;;;;;MAoCC;CACF;8BA7VY,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AA8XA,4CAEC;AApXD;;GAEG;AAEH;IACE,uBAGC;IAFC,kBAAoB;IACpB,SAAgB;IAKlB;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;;OAGG;IACH,mBAFa,IAAI,CAShB;IAED;;;;OAIG;IACH,gBAHW,eAAe,GACb,IAAI,CAmBhB;IAED;;;;OAIG;IACH,mBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,sBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,uBAFa,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,iDAqCC;IAED;;OAEG;IACH,kBAFa,IAAI,CAOhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAMhB;IAED,2BAWC;IAED;;MAOC;IAED;;;;MASC;IAED,kBAEC;IAED,4BAMC;IAID;;OAEG;IACH,kCAFa,IAAI,CAqDhB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAUC;IAED;;;;;;;;MAoCC;CACF;8BA/WY,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC"}

package/types/errors.d.ts

@@ -8,15 +8,7 @@ export class ValidationError extends Error {
     constructor(message: any, details?: any[], type?: string);
     details: any[];
     type: string;
-    toJSON(): {
-        type: string;
-        message: any;
-        details?: undefined;
-    } | {
-        type: string;
-        message: string;
-        details: any[];
-    };
+    toJSON(): any;
     canRollup(): boolean;
     isFieldType(): boolean;
     getFullMessage(options: any): any;
@@ -26,34 +18,12 @@ export class FieldError extends ValidationError {
     field: any;
     original: any;
     details: any;
-    toJSON(): {
-        field: any;
-        type: string;
-        message: any;
-        details?: undefined;
-    } | {
-        field: any;
-        type: string;
-        message: string;
-        details: any[];
-    };
 }
 export class ElementError extends ValidationError {
     constructor(message: any, index: any, original: any, details: any);
     index: any;
     original: any;
     details: any;
-    toJSON(): {
-        index: any;
-        type: string;
-        message: any;
-        details?: undefined;
-    } | {
-        index: any;
-        type: string;
-        message: string;
-        details: any[];
-    };
 }
 export class AssertionError extends Error {
     constructor(message: any, type: any, original: any);

package/types/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.js"],"names":[],"mappings":"AAkHA,iDAMC;AArHD;IACE,uCAGC;IADC,YAAoB;IAGtB,gBAEC;CACF;AAED;IACE,0DAIC;IAFC,eAAsB;IACtB,aAAgB;IAGlB;;;;;;;;MAgBC;IAED,qBAOC;IAED,uBAEC;IAED,kCAKC;CACF;AAED;IACE,mEAKC;IAHC,WAAkB;IAClB,cAAwB;IACxB,aAAsB;IAGxB;;;;;;;;;;MAKC;CACF;AAED;IACE,mEAKC;IAHC,WAAkB;IAClB,cAAwB;IACxB,aAAsB;IAGxB;;;;;;;;;;MAKC;CACF;AAED;IACE,oDAIC;IAFC,UAAgB;IAChB,cAAwB;IAG1B;;;MAKC;CACF;AAED;IACE,wCAGC;IADC,aAAsB;CAEzB"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.js"],"names":[],"mappings":"AAqHA,iDAMC;AAxHD;IACE,uCAGC;IADC,YAAoB;IAGtB,gBAEC;CACF;AAED;IACE,0DAIC;IAFC,eAAsB;IACtB,aAAgB;IAGlB,cAgBC;IAED,qBAUC;IAED,uBAEC;IAED,kCAKC;CACF;AAED;IACE,mEAKC;IAHC,WAAkB;IAClB,cAAwB;IACxB,aAAsB;CASzB;AAED;IACE,mEAKC;IAHC,WAAkB;IAClB,cAAwB;IACxB,aAAsB;CASzB;AAED;IACE,oDAIC;IAFC,UAAgB;IAChB,cAAwB;IAG1B;;;MAKC;CACF;AAED;IACE,wCAGC;IADC,aAAsB;CAEzB"}

package/types/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AAsMA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAMnB;;;;AAxMD;;GAEG;AAEH;IAUE;;OAEG;IACH,cAgEC;IAED;;OAEG;IACH,kBAEC;IAED;;OAEG;IAEH,YAHW,SAAS,GAAC,MAAM,gBAkC1B;IAED;;OAEG;IACH,gBAFc,MAAM,kBAWnB;IAED;;OAEG;IACH,gBAFc,MAAM,kBAWnB;CAcF"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AAyMA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAMnB;;;;AA3MD;;GAEG;AAEH;IAUE;;OAEG;IACH,cAmEC;IAED;;OAEG;IACH,kBAEC;IAED;;OAEG;IAEH,YAHW,SAAS,GAAC,MAAM,gBAkC1B;IAED;;OAEG;IACH,gBAFc,MAAM,kBAWnB;IAED;;OAEG;IACH,gBAFc,MAAM,kBAWnB;CAcF"}

package/types/string.d.ts

@@ -8,6 +8,10 @@ declare class StringSchema extends TypeSchema {
      * @returns {this}
      */
     required(): this;
+    /**
+     * @returns {this}
+     */
+    allowEmpty(): this;
     /**
      * @param {number} length
      */
@@ -57,6 +61,7 @@ declare class StringSchema extends TypeSchema {
      * @param {string} locale
      */
     postalCode(locale?: string): StringSchema;
+    zipcode(): StringSchema;
     /**
      * @param {object} [options]
      * @param {number} [options.minLength]

package/types/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.js"],"names":[],"mappings":"AAiZA;;GAEG;AACH,iDAEC;AApYD;IACE,cAWC;IAED;;OAEG;IACH,YAFa,IAAI,CAUhB;IAED;;OAEG;IACH,eAFW,MAAM,gBAUhB;IAED;;OAEG;IACH,YAFW,MAAM,gBAUhB;IAED;;OAEG;IACH,YAFW,MAAM,gBAUhB;IAED,qBAIC;IAED;;OAEG;IACH,mBAFW,OAAO,gBAYjB;IAED;;OAEG;IACH,mBAFW,OAAO,gBAYjB;IAED;;OAEG;IACH,WAFW,MAAM,gBAahB;IAED,sBAMC;IAED,sBAMC;IAED,oBAMC;IAED,oBAMC;IAED,qBAMC;IAED,sBAMC;IAED;;;OAGG;IACH;QAF6B,OAAO,GAAzB,OAAO;qBAQjB;IAED,2BAMC;IAED,mBAMC;IAED,wBAMC;IAED,uBAMC;IAED,oBAMC;IAED,qBAOC;IAED,uBAMC;IAED;;OAEG;IACH,oBAFW,MAAM,gBAYhB;IAED;;;;;;;OAOG;IACH;QAN4B,SAAS,GAA1B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,YAAY,GAA7B,MAAM;QACW,YAAY,GAA7B,MAAM;qBA+BhB;IAED;;;;;;;;;;;OAWG;IACH;QAV6B,gBAAgB,GAAlC,OAAO;QACW,sBAAsB,GAAxC,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,4BAA4B,GAA9C,OAAO;QACW,eAAe,GAAjC,OAAO;QACW,sBAAsB,GAAxC,OAAO;QACW,eAAe,GAAjC,OAAO;QACY,SAAS,GAA5B,MAAM,EAAE;qBAQlB;IAED;;;;;;;;OAQG;IACH;QAP6B,WAAW,GAA7B,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,kBAAkB,GAApC,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,cAAc,GAAhC,OAAO;QACW,iBAAiB,GAAnC,OAAO;qBAQjB;IAED;;OAEG;IACH,eAFW,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,gBAQ3B;IAED,oBAMC;IAED,oBAMC;IAED,sBAMC;IAED,sBAMC;CAcF"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.js"],"names":[],"mappings":"AA6ZA;;GAEG;AACH,iDAEC;AAhZD;IACE,cAcC;IAED;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;OAEG;IACH,cAFa,IAAI,CAIhB;IAED;;OAEG;IACH,eAFW,MAAM,gBAUhB;IAED;;OAEG;IACH,YAFW,MAAM,gBAUhB;IAED;;OAEG;IACH,YAFW,MAAM,gBAUhB;IAED,qBAIC;IAED;;OAEG;IACH,mBAFW,OAAO,gBAYjB;IAED;;OAEG;IACH,mBAFW,OAAO,gBAYjB;IAED;;OAEG;IACH,WAFW,MAAM,gBAahB;IAED,sBAMC;IAED,sBAMC;IAED,oBAMC;IAED,oBAMC;IAED,qBAMC;IAED,sBAMC;IAED;;;OAGG;IACH;QAF6B,OAAO,GAAzB,OAAO;qBAQjB;IAED,2BAMC;IAED,mBAMC;IAED,wBAMC;IAED,uBAMC;IAED,oBAMC;IAED,qBAOC;IAED,uBAMC;IAED;;OAEG;IACH,oBAFW,MAAM,gBAQhB;IAED,wBAMC;IAED;;;;;;;OAOG;IACH;QAN4B,SAAS,GAA1B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,YAAY,GAA7B,MAAM;QACW,YAAY,GAA7B,MAAM;qBA+BhB;IAED;;;;;;;;;;;OAWG;IACH;QAV6B,gBAAgB,GAAlC,OAAO;QACW,sBAAsB,GAAxC,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,4BAA4B,GAA9C,OAAO;QACW,eAAe,GAAjC,OAAO;QACW,sBAAsB,GAAxC,OAAO;QACW,eAAe,GAAjC,OAAO;QACY,SAAS,GAA5B,MAAM,EAAE;qBAQlB;IAED;;;;;;;;OAQG;IACH;QAP6B,WAAW,GAA7B,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,kBAAkB,GAApC,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,cAAc,GAAhC,OAAO;QACW,iBAAiB,GAAnC,OAAO;qBAQjB;IAED;;OAEG;IACH,eAFW,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,gBAQ3B;IAED,oBAMC;IAED,oBAMC;IAED,sBAMC;IAED,sBAMC;CAcF"}