@bedrockio/yada 1.2.0 → 1.2.2

package/dist/cjs/Schema.js

@@ -7,7 +7,7 @@ exports.default = void 0;
 exports.isSchema = isSchema;
 var _errors = require("./errors");
 var _utils = require("./utils");
-const INITIAL_TYPES = ['default', 'required', 'type', 'transform'];
+const INITIAL_TYPES = ['default', 'required', 'type', 'transform', 'empty'];
 const REQUIRED_TYPES = ['default', 'required'];
 class Schema {
   constructor(meta = {}) {
@@ -147,8 +147,6 @@ class Schema {
         break;
       } else if (value === null && options.nullable) {
         break;
-      } else if (value === '' && !options.required && options.allowEmpty) {
-        break;
       }
       try {
         const result = await this.runAssertion(assertion, value, options);
@@ -159,12 +157,15 @@ class Schema {
         const {
           type
         } = assertion;
+        const {
+          message
+        } = error;
         if (type === 'type') {
-          details.push(new _errors.TypeError(error, this.meta.type));
+          details.push(new _errors.TypeError(message, this.meta.type));
         } else if (type === 'format') {
-          details.push(new _errors.FormatError(error, this.meta.format));
+          details.push(new _errors.FormatError(message, this.meta.format));
         } else if (error instanceof _errors.LocalizedError) {
-          details.push(new _errors.AssertionError(error, type));
+          details.push(new _errors.AssertionError(message, type));
         } else {
           details.push(error);
         }

package/dist/cjs/errors.js

@@ -15,8 +15,8 @@ class LocalizedError extends Error {
 exports.LocalizedError = LocalizedError;
 class ValidationError extends Error {
   static DEFAULT_MESSAGE = 'Validation failed.';
-  constructor(arg, details = []) {
-    super(getLocalizedMessage(arg) || ValidationError.DEFAULT_MESSAGE);
+  constructor(message = ValidationError.DEFAULT_MESSAGE, details = []) {
+    super(message);
     this.type = 'validation';
     this.details = details;
   }
@@ -24,12 +24,9 @@ class ValidationError extends Error {
     const {
       details
     } = this;
-    const message = this.getMessage();
     return {
       type: this.type,
-      ...(message && {
-        message
-      }),
+      message: this.getMessage(),
       ...(details.length && {
         details: details.map(error => {
           return serializeError(error);
@@ -46,7 +43,7 @@ class ValidationError extends Error {
       DEFAULT_MESSAGE
     } = this.constructor;
     if (message && message !== DEFAULT_MESSAGE) {
-      return message;
+      return getLocalizedMessage(message);
     }
   }
   getFullMessage(options) {
@@ -96,7 +93,8 @@ class FormatError extends ValidationError {
 }
 exports.FormatError = FormatError;
 class FieldError extends ValidationError {
-  constructor(message, field, details) {
+  static DEFAULT_MESSAGE = 'Field failed validation.';
+  constructor(message = FieldError.DEFAULT_MESSAGE, field, details) {
     super(message, details);
     this.type = 'field';
     this.field = field;
@@ -110,7 +108,8 @@ class FieldError extends ValidationError {
 }
 exports.FieldError = FieldError;
 class ElementError extends ValidationError {
-  constructor(message, index, details) {
+  static DEFAULT_MESSAGE = 'Element failed validation.';
+  constructor(message = ElementError.DEFAULT_MESSAGE, index, details) {
     super(message, details);
     this.type = 'element';
     this.index = index;

package/dist/cjs/messages.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.getErrorMessage = getErrorMessage;
 exports.getFullMessage = getFullMessage;
 var _localization = require("./localization");
 function getFullMessage(error, options) {
@@ -20,14 +21,15 @@ function getFullMessage(error, options) {
     }).join(delimiter);
   }
 }
-function hasMessage(error) {
-  let message;
+function getErrorMessage(error) {
   if (error.getMessage) {
-    message = error.getMessage();
+    return error.getMessage();
   } else {
-    message = error.message;
+    return error.message;
   }
-  return !!message;
+}
+function hasMessage(error) {
+  return !!getErrorMessage(error);
 }
 function getInnerPath(error, options) {
   const {

package/dist/cjs/string.js

@@ -14,21 +14,25 @@ const PHONE_REG = /^\+\d{1,3}\d{3,14}$/;
 const PHONE_DESCRIPTION = 'A phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.';
 class StringSchema extends _TypeSchema.default {
   constructor() {
-    super(String, {
-      allowEmpty: true
-    });
+    super(String);
     this.assert('type', (val, options) => {
       const {
-        cast,
-        required,
-        allowEmpty
+        cast
       } = options;
       if (cast && typeof val !== 'string') {
         val = String(val);
       }
       if (typeof val !== 'string') {
         throw new _errors.LocalizedError('Must be a string.');
-      } else if ((required || !allowEmpty) && val === '') {
+      }
+      return val;
+    });
+    this.assert('empty', (val, options) => {
+      const {
+        required,
+        allowEmpty
+      } = options;
+      if (val === '' && (required || allowEmpty === false)) {
         throw new _errors.LocalizedError('String may not be empty.');
       }
       return val;
@@ -377,6 +381,19 @@ class StringSchema extends _TypeSchema.default {
       }
     });
   }
+  format(name, fn) {
+    return this.clone({
+      format: name
+    }).assert('format', function (val, options) {
+      const {
+        allowEmpty
+      } = options;
+      if (val === '' && allowEmpty !== false) {
+        return;
+      }
+      fn(val, options);
+    });
+  }
   toOpenApi(extra) {
     const {
       min,

package/package.json

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

package/src/Schema.js

@@ -8,7 +8,7 @@ import {
 } from './errors';
 import { omit } from './utils';
 
-const INITIAL_TYPES = ['default', 'required', 'type', 'transform'];
+const INITIAL_TYPES = ['default', 'required', 'type', 'transform', 'empty'];
 const REQUIRED_TYPES = ['default', 'required'];
 
 export default class Schema {
@@ -140,8 +140,6 @@ export default class Schema {
         break;
       } else if (value === null && options.nullable) {
         break;
-      } else if (value === '' && !options.required && options.allowEmpty) {
-        break;
       }
 
       try {
@@ -151,13 +149,14 @@ export default class Schema {
         }
       } catch (error) {
         const { type } = assertion;
+        const { message } = error;
 
         if (type === 'type') {
-          details.push(new TypeError(error, this.meta.type));
+          details.push(new TypeError(message, this.meta.type));
         } else if (type === 'format') {
-          details.push(new FormatError(error, this.meta.format));
+          details.push(new FormatError(message, this.meta.format));
         } else if (error instanceof LocalizedError) {
-          details.push(new AssertionError(error, type));
+          details.push(new AssertionError(message, type));
         } else {
           details.push(error);
         }

package/src/errors.js

@@ -10,20 +10,17 @@ export class LocalizedError extends Error {
 export class ValidationError extends Error {
   static DEFAULT_MESSAGE = 'Validation failed.';
 
-  constructor(arg, details = []) {
-    super(getLocalizedMessage(arg) || ValidationError.DEFAULT_MESSAGE);
+  constructor(message = ValidationError.DEFAULT_MESSAGE, details = []) {
+    super(message);
     this.type = 'validation';
     this.details = details;
   }
 
   toJSON() {
     const { details } = this;
-    const message = this.getMessage();
     return {
       type: this.type,
-      ...(message && {
-        message,
-      }),
+      message: this.getMessage(),
       ...(details.length && {
         details: details.map((error) => {
           return serializeError(error);
@@ -37,7 +34,7 @@ export class ValidationError extends Error {
     // @ts-ignore
     const { DEFAULT_MESSAGE } = this.constructor;
     if (message && message !== DEFAULT_MESSAGE) {
-      return message;
+      return getLocalizedMessage(message);
     }
   }
 
@@ -91,7 +88,9 @@ export class FormatError extends ValidationError {
 }
 
 export class FieldError extends ValidationError {
-  constructor(message, field, details) {
+  static DEFAULT_MESSAGE = 'Field failed validation.';
+
+  constructor(message = FieldError.DEFAULT_MESSAGE, field, details) {
     super(message, details);
     this.type = 'field';
     this.field = field;
@@ -106,7 +105,9 @@ export class FieldError extends ValidationError {
 }
 
 export class ElementError extends ValidationError {
-  constructor(message, index, details) {
+  static DEFAULT_MESSAGE = 'Element failed validation.';
+
+  constructor(message = ElementError.DEFAULT_MESSAGE, index, details) {
     super(message, details);
     this.type = 'element';
     this.index = index;

package/src/messages.js

@@ -16,14 +16,16 @@ export function getFullMessage(error, options) {
   }
 }
 
-function hasMessage(error) {
-  let message;
+export function getErrorMessage(error) {
   if (error.getMessage) {
-    message = error.getMessage();
+    return error.getMessage();
   } else {
-    message = error.message;
+    return error.message;
   }
-  return !!message;
+}
+
+function hasMessage(error) {
+  return !!getErrorMessage(error);
 }
 
 function getInnerPath(error, options) {

package/src/string.js

@@ -18,15 +18,21 @@ const PHONE_DESCRIPTION =
 
 class StringSchema extends TypeSchema {
   constructor() {
-    super(String, { allowEmpty: true });
+    super(String);
     this.assert('type', (val, options) => {
-      const { cast, required, allowEmpty } = options;
+      const { cast } = options;
+
       if (cast && typeof val !== 'string') {
         val = String(val);
       }
       if (typeof val !== 'string') {
         throw new LocalizedError('Must be a string.');
-      } else if ((required || !allowEmpty) && val === '') {
+      }
+      return val;
+    });
+    this.assert('empty', (val, options) => {
+      const { required, allowEmpty } = options;
+      if (val === '' && (required || allowEmpty === false)) {
         throw new LocalizedError('String may not be empty.');
       }
       return val;
@@ -390,6 +396,19 @@ class StringSchema extends TypeSchema {
     });
   }
 
+  format(name, fn) {
+    return this.clone({ format: name }).assert(
+      'format',
+      function (val, options) {
+        const { allowEmpty } = options;
+        if (val === '' && allowEmpty !== false) {
+          return;
+        }
+        fn(val, options);
+      }
+    );
+  }
+
   toOpenApi(extra) {
     const { min, max } = this.meta;
     return {

package/types/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AAoYA,4CAEC;AAzXD;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,iDA+CC;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;;;;;;;;MAsCC;CACF"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AAmYA,4CAEC;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;;;;;;;;MAsCC;CACF"}

package/types/errors.d.ts

@@ -4,15 +4,15 @@ export class LocalizedError extends Error {
 }
 export class ValidationError extends Error {
     static DEFAULT_MESSAGE: string;
-    constructor(arg: any, details?: any[]);
+    constructor(message?: string, details?: any[]);
     type: string;
     details: any[];
     toJSON(): {
         details: any[];
-        message: string;
         type: string;
+        message: any;
     };
-    getMessage(): string;
+    getMessage(): any;
     getFullMessage(options: any): any;
 }
 export class AssertionError extends ValidationError {
@@ -25,8 +25,8 @@ export class TypeError extends ValidationError {
     toJSON(): {
         kind: any;
         details: any[];
-        message: string;
         type: string;
+        message: any;
     };
 }
 export class FormatError extends ValidationError {
@@ -35,28 +35,28 @@ export class FormatError extends ValidationError {
     toJSON(): {
         format: any;
         details: any[];
-        message: string;
         type: string;
+        message: any;
     };
 }
 export class FieldError extends ValidationError {
-    constructor(message: any, field: any, details: any);
+    constructor(message: string, field: any, details: any);
     field: any;
     toJSON(): {
         field: any;
         details: any[];
-        message: string;
         type: string;
+        message: any;
     };
 }
 export class ElementError extends ValidationError {
-    constructor(message: any, index: any, details: any);
+    constructor(message: string, index: any, details: any);
     index: any;
     toJSON(): {
         index: any;
         details: any[];
-        message: string;
         type: string;
+        message: any;
     };
 }
 export class ArrayError extends ValidationError {

package/types/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.js"],"names":[],"mappings":"AAwIA,iDAEC;AAvID;IACE,uCAEC;CACF;AAED;IACE,+BAA8C;IAE9C,uCAIC;IAFC,aAAwB;IACxB,eAAsB;IAGxB;;;;MAcC;IAED,qBAOC;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"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.js"],"names":[],"mappings":"AAyIA,iDAEC;AAxID;IACE,uCAEC;CACF;AAED;IACE,+BAA8C;IAE9C,+CAIC;IAFC,aAAwB;IACxB,eAAsB;IAGxB;;;;MAWC;IAED,kBAOC;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;IAGE,uDAIC;IADC,WAAkB;IAGpB;;;;;MAKC;CACF;AAED;IAGE,uDAIC;IADC,WAAkB;IAGpB;;;;;MAKC;CACF;AAED;IACE,wCAGC;CACF;AAED;IACE,wCAGC;CACF"}

package/types/messages.d.ts

@@ -1,2 +1,3 @@
 export function getFullMessage(error: any, options: any): any;
+export function getErrorMessage(error: any): any;
 //# sourceMappingURL=messages.d.ts.map

package/types/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.js"],"names":[],"mappings":"AAEA,8DAcC"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.js"],"names":[],"mappings":"AAEA,8DAcC;AAED,iDAMC"}

package/types/string.d.ts

@@ -121,6 +121,7 @@ declare class StringSchema extends TypeSchema {
     eth(): StringSchema;
     swift(): StringSchema;
     mongo(): StringSchema;
+    format(name: any, fn: any): StringSchema;
 }
 import TypeSchema from "./TypeSchema";
 export {};

package/types/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.js"],"names":[],"mappings":"AAsZA;;GAEG;AACH,iDAEC;AAzYD;IACE,cAcC;IAED;;OAEG;IACH,YAFa,IAAI,CAQhB;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"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.js"],"names":[],"mappings":"AAyaA;;GAEG;AACH,iDAEC;AA5ZD;IACE,cAoBC;IAED;;OAEG;IACH,YAFa,IAAI,CAQhB;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;IAED,yCAWC;CAcF"}