@bedrockio/yada 1.1.0 → 1.1.2

package/dist/cjs/Schema.js

@@ -9,10 +9,6 @@ var _errors = require("./errors");
 var _utils = require("./utils");
 const INITIAL_TYPES = ['default', 'required', 'type', 'transform'];
 const REQUIRED_TYPES = ['default', 'required'];
-
-/**
- * @typedef {[fn: Function] | [type: string, fn: Function]} CustomSignature
- */
 class Schema {
   constructor(meta = {}) {
     this.assertions = [];
@@ -51,24 +47,14 @@ class Schema {
 
   /**
    * Validate by a custom function. [Link](https://github.com/bedrockio/yada#custom)
-   * @param {CustomSignature} args
+   * @param {Function} fn
    * @returns {this}
    */
-  custom(...args) {
-    let type, fn;
-    if (typeof args[0] === 'function') {
-      type = 'custom';
-      fn = args[0];
-    } else {
-      type = args[0];
-      fn = args[1];
-    }
-    if (!type) {
-      throw new Error('Assertion type required.');
-    } else if (!fn) {
+  custom(fn) {
+    if (!fn) {
       throw new Error('Assertion function required.');
     }
-    return this.clone().assert(type, async (val, options) => {
+    return this.clone().assert('custom', async (val, options) => {
       return await fn(val, options);
     });
   }
@@ -163,7 +149,7 @@ class Schema {
           details.push(new _errors.TypeError(error, this.meta.type));
         } else if (type === 'format') {
           details.push(new _errors.FormatError(error, this.meta.format));
-        } else if (!error.type) {
+        } else if (error instanceof _errors.LocalizedError) {
           details.push(new _errors.AssertionError(error, type));
         } else {
           details.push(error);
@@ -274,6 +260,7 @@ class Schema {
       enum: set
     }).assert('enum', async (val, options) => {
       if (val !== undefined) {
+        const captured = [];
         for (let el of set) {
           if (isSchema(el)) {
             try {
@@ -284,23 +271,27 @@ class Schema {
               return await el.validate(val, options);
             } catch (err) {
               const [first] = err.details;
-              if (first instanceof _errors.TypeError) {
-                // If the error is a simple type error then continue
-                // to show more meaningful messages for simple enums.
+              if (first instanceof _errors.TypeError && first.isPrimitiveKind()) {
+                // If the error is a simple primitive type error then
+                // continue to show more meaningful messages for simple enums.
                 continue;
               } else {
-                // Otherwise throw the error to surface messages on
+                // Otherwise capture the error to surface messages on
                 // more complex schemas.
-                throw err;
+                captured.push(err);
               }
             }
           } else if (el === val === allow) {
             return;
           }
         }
-        throw new _errors.LocalizedError(message, {
-          types: types.join(', ')
-        });
+        if (captured.length) {
+          throw new _errors.AllowedError(this.meta.message, captured);
+        } else {
+          throw new _errors.LocalizedError(message, {
+            types: types.join(', ')
+          });
+        }
       }
     });
   }

package/dist/cjs/errors.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ValidationError = exports.TypeError = exports.LocalizedError = exports.FormatError = exports.FieldError = exports.ElementError = exports.AssertionError = exports.ArrayError = void 0;
+exports.ValidationError = exports.TypeError = exports.LocalizedError = exports.FormatError = exports.FieldError = exports.ElementError = exports.AssertionError = exports.ArrayError = exports.AllowedError = void 0;
 exports.isSchemaError = isSchemaError;
 var _messages = require("./messages");
 var _localization = require("./localization");
@@ -31,7 +31,7 @@ class ValidationError extends Error {
       }),
       ...(details.length && {
         details: details.map(error => {
-          return error.toJSON();
+          return serializeError(error);
         })
       })
     };
@@ -57,6 +57,9 @@ class TypeError extends ValidationError {
     this.type = 'type';
     this.kind = kind;
   }
+  isPrimitiveKind() {
+    return this.kind !== 'array' && this.kind !== 'object';
+  }
   toJSON() {
     return {
       ...super.toJSON(),
@@ -109,12 +112,18 @@ class ElementError extends ValidationError {
 exports.ElementError = ElementError;
 class ArrayError extends ValidationError {
   constructor(message, details) {
-    super(message);
+    super(message, details);
     this.type = 'array';
-    this.details = details;
   }
 }
 exports.ArrayError = ArrayError;
+class AllowedError extends ValidationError {
+  constructor(message, details) {
+    super(message, details);
+    this.type = 'allowed';
+  }
+}
+exports.AllowedError = AllowedError;
 function isSchemaError(arg) {
   return arg instanceof ValidationError;
 }
@@ -126,4 +135,14 @@ function getLocalizedMessage(arg) {
   } else {
     return (0, _localization.localize)(arg);
   }
+}
+function serializeError(error) {
+  if (error.toJSON) {
+    return error.toJSON();
+  } else {
+    return {
+      ...error,
+      message: error.message
+    };
+  }
 }

package/dist/cjs/index.js

@@ -115,10 +115,10 @@ function reject(...args) {
 
 /**
  * Validate by a custom function. [Link](https://github.com/bedrockio/yada#custom)
- * @param {import("./Schema").CustomSignature} args
+ * @param {Function} fn
  */
-function custom(...args) {
-  return new _Schema.default().custom(...args);
+function custom(fn) {
+  return new _Schema.default().custom(fn);
 }
 var _default = {
   array: _array.default,

package/dist/cjs/messages.js

@@ -60,7 +60,7 @@ const DISALLOWED_TYPES = ['field', 'element', 'array', 'custom'];
 // names automatically. Instead the custom messages can include
 // the {field} token to allow it to be interpolated if required.
 function canAutoAddField(type, path) {
-  return path.length && !DISALLOWED_TYPES.includes(type);
+  return type && path.length && !DISALLOWED_TYPES.includes(type);
 }
 function getFieldLabel(options) {
   const {

package/package.json

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

package/src/Schema.js

@@ -1,6 +1,7 @@
 import {
   TypeError,
   FormatError,
+  AllowedError,
   AssertionError,
   LocalizedError,
   ValidationError,
@@ -10,9 +11,6 @@ import { omit } from './utils';
 const INITIAL_TYPES = ['default', 'required', 'type', 'transform'];
 const REQUIRED_TYPES = ['default', 'required'];
 
-/**
- * @typedef {[fn: Function] | [type: string, fn: Function]} CustomSignature
- */
 export default class Schema {
   constructor(meta = {}) {
     this.assertions = [];
@@ -47,24 +45,14 @@ export default class Schema {
 
   /**
    * Validate by a custom function. [Link](https://github.com/bedrockio/yada#custom)
-   * @param {CustomSignature} args
+   * @param {Function} fn
    * @returns {this}
    */
-  custom(...args) {
-    let type, fn;
-    if (typeof args[0] === 'function') {
-      type = 'custom';
-      fn = args[0];
-    } else {
-      type = args[0];
-      fn = args[1];
-    }
-    if (!type) {
-      throw new Error('Assertion type required.');
-    } else if (!fn) {
+  custom(fn) {
+    if (!fn) {
       throw new Error('Assertion function required.');
     }
-    return this.clone().assert(type, async (val, options) => {
+    return this.clone().assert('custom', async (val, options) => {
       return await fn(val, options);
     });
   }
@@ -155,7 +143,7 @@ export default class Schema {
           details.push(new TypeError(error, this.meta.type));
         } else if (type === 'format') {
           details.push(new FormatError(error, this.meta.format));
-        } else if (!error.type) {
+        } else if (error instanceof LocalizedError) {
           details.push(new AssertionError(error, type));
         } else {
           details.push(error);
@@ -256,6 +244,7 @@ export default class Schema {
     const message = `${allow ? 'Must' : 'Must not'} be one of [{types}].`;
     return this.clone({ enum: set }).assert('enum', async (val, options) => {
       if (val !== undefined) {
+        const captured = [];
         for (let el of set) {
           if (isSchema(el)) {
             try {
@@ -266,23 +255,27 @@ export default class Schema {
               return await el.validate(val, options);
             } catch (err) {
               const [first] = err.details;
-              if (first instanceof TypeError) {
-                // If the error is a simple type error then continue
-                // to show more meaningful messages for simple enums.
+              if (first instanceof TypeError && first.isPrimitiveKind()) {
+                // If the error is a simple primitive type error then
+                // continue to show more meaningful messages for simple enums.
                 continue;
               } else {
-                // Otherwise throw the error to surface messages on
+                // Otherwise capture the error to surface messages on
                 // more complex schemas.
-                throw err;
+                captured.push(err);
               }
             }
           } else if ((el === val) === allow) {
             return;
           }
         }
-        throw new LocalizedError(message, {
-          types: types.join(', '),
-        });
+        if (captured.length) {
+          throw new AllowedError(this.meta.message, captured);
+        } else {
+          throw new LocalizedError(message, {
+            types: types.join(', '),
+          });
+        }
       }
     });
   }

package/src/errors.js

@@ -23,7 +23,7 @@ export class ValidationError extends Error {
       }),
       ...(details.length && {
         details: details.map((error) => {
-          return error.toJSON();
+          return serializeError(error);
         }),
       }),
     };
@@ -51,6 +51,10 @@ export class TypeError extends ValidationError {
     this.kind = kind;
   }
 
+  isPrimitiveKind() {
+    return this.kind !== 'array' && this.kind !== 'object';
+  }
+
   toJSON() {
     return {
       ...super.toJSON(),
@@ -106,9 +110,15 @@ export class ElementError extends ValidationError {
 
 export class ArrayError extends ValidationError {
   constructor(message, details) {
-    super(message);
+    super(message, details);
     this.type = 'array';
-    this.details = details;
+  }
+}
+
+export class AllowedError extends ValidationError {
+  constructor(message, details) {
+    super(message, details);
+    this.type = 'allowed';
   }
 }
 
@@ -125,3 +135,14 @@ function getLocalizedMessage(arg) {
     return localize(arg);
   }
 }
+
+function serializeError(error) {
+  if (error.toJSON) {
+    return error.toJSON();
+  } else {
+    return {
+      ...error,
+      message: error.message,
+    };
+  }
+}

package/src/index.js

@@ -34,10 +34,10 @@ function reject(...args) {
 
 /**
  * Validate by a custom function. [Link](https://github.com/bedrockio/yada#custom)
- * @param {import("./Schema").CustomSignature} args
+ * @param {Function} fn
  */
-function custom(...args) {
-  return new Schema().custom(...args);
+function custom(fn) {
+  return new Schema().custom(fn);
 }
 
 export {

package/src/messages.js

@@ -54,7 +54,7 @@ const DISALLOWED_TYPES = ['field', 'element', 'array', 'custom'];
 // names automatically. Instead the custom messages can include
 // the {field} token to allow it to be interpolated if required.
 function canAutoAddField(type, path) {
-  return path.length && !DISALLOWED_TYPES.includes(type);
+  return type && path.length && !DISALLOWED_TYPES.includes(type);
 }
 
 function getFieldLabel(options) {

package/types/Schema.d.ts

@@ -1,7 +1,4 @@
 export function isSchema(arg: any): boolean;
-/**
- * @typedef {[fn: Function] | [type: string, fn: Function]} CustomSignature
- */
 export default class Schema {
     constructor(meta?: {});
     assertions: any[];
@@ -17,10 +14,10 @@ export default class Schema {
     default(arg: any): this;
     /**
      * Validate by a custom function. [Link](https://github.com/bedrockio/yada#custom)
-     * @param {CustomSignature} args
+     * @param {Function} fn
      * @returns {this}
      */
-    custom(...args: CustomSignature): this;
+    custom(fn: Function): this;
     /**
      * Conditionally exclude fields inside an object schema.
      * [Link](https://github.com/bedrockio/yada#strip)
@@ -99,5 +96,4 @@ export default class Schema {
         enum?: undefined;
     };
 }
-export type CustomSignature = [fn: Function] | [type: string, fn: Function];
 //# 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":"AAkXA,4CAEC;AAxWD;;GAEG;AACH;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,iDA0CC;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,CA4ChB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAGC;IAED;;;;;;;;MAoCC;CACF;8BAnWY,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":"AA2WA,4CAEC;AAhWD;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;;OAEG;IACH,uBAFa,IAAI,CAIhB;IAED;;OAEG;IACH,gBAFa,IAAI,CAShB;IAED;;OAEG;IACH,+BAFa,IAAI,CAMhB;IAED;;OAEG;IACH,uBAFa,IAAI,CAIhB;IAED,iDA0CC;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,CAiDhB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAGC;IAED;;;;;;;;MAoCC;CACF"}

package/types/errors.d.ts

@@ -19,6 +19,7 @@ export class AssertionError extends ValidationError {
 export class TypeError extends ValidationError {
     constructor(message: any, kind: any);
     kind: any;
+    isPrimitiveKind(): boolean;
     toJSON(): {
         kind: any;
         details: any[];
@@ -58,6 +59,8 @@ export class ElementError extends ValidationError {
 }
 export class ArrayError extends ValidationError {
     constructor(message: any, details: any);
-    details: any;
+}
+export class AllowedError extends ValidationError {
+    constructor(message: any, details: any);
 }
 //# sourceMappingURL=errors.d.ts.map

package/types/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.js"],"names":[],"mappings":"AAkHA,iDAEC;AAjHD;IACE,uCAEC;CACF;AAED;IACE,uCAIC;IAFC,aAAwB;IACxB,eAAsB;IAGxB;;;;MAaC;IAED,kCAKC;CACF;AAED;IACE,yCAGC;CACF;AAED;IACE,qCAIC;IADC,UAAgB;IAGlB;;;;;MAKC;CACF;AAED;IACE,uCAIC;IADC,YAAoB;IAGtB;;;;;MAKC;CACF;AAED;IACE,oDAIC;IADC,WAAkB;IAGpB;;;;;MAKC;CACF;AAED;IACE,oDAIC;IADC,WAAkB;IAGpB;;;;;MAKC;CACF;AAED;IACE,wCAIC;IADC,aAAsB;CAEzB"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.js"],"names":[],"mappings":"AA4HA,iDAEC;AA3HD;IACE,uCAEC;CACF;AAED;IACE,uCAIC;IAFC,aAAwB;IACxB,eAAsB;IAGxB;;;;MAaC;IAED,kCAKC;CACF;AAED;IACE,yCAGC;CACF;AAED;IACE,qCAIC;IADC,UAAgB;IAGlB,2BAEC;IAED;;;;;MAKC;CACF;AAED;IACE,uCAIC;IADC,YAAoB;IAGtB;;;;;MAKC;CACF;AAED;IACE,oDAIC;IADC,WAAkB;IAGpB;;;;;MAKC;CACF;AAED;IACE,oDAIC;IADC,WAAkB;IAGpB;;;;;MAKC;CACF;AAED;IACE,wCAGC;CACF;AAED;IACE,wCAGC;CACF"}

package/types/index.d.ts

@@ -38,9 +38,9 @@ export function allow(...args: any[]): Schema;
 export function reject(...args: any[]): Schema;
 /**
  * Validate by a custom function. [Link](https://github.com/bedrockio/yada#custom)
- * @param {import("./Schema").CustomSignature} args
+ * @param {Function} fn
  */
-export function custom(...args: import("./Schema").CustomSignature): Schema;
+export function custom(fn: Function): Schema;
 import { isSchema } from "./utils";
 import { isSchemaError } from "./utils";
 import { useLocalizer } from "./localization";

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAaA;;GAEG;AACH,8BAEC;AAED;;GAEG;AACH,8CAEC;AAED;;GAEG;AACH,+CAEC;AAED;;;GAGG;AACH,gCAFW,OAAO,UAAU,EAAE,eAAe,UAI5C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAaA;;GAEG;AACH,8BAEC;AAED;;GAEG;AACH,8CAEC;AAED;;GAEG;AACH,+CAEC;AAED;;;GAGG;AACH,6CAEC"}