@bedrockio/yada 1.2.2 → 1.2.4

package/dist/cjs/messages.js

@@ -44,9 +44,6 @@ function getInnerPath(error, options) {
   }
 }
 function getLabeledMessage(error, options) {
-  const {
-    type
-  } = error;
   const {
     path = []
   } = options;
@@ -54,8 +51,10 @@ function getLabeledMessage(error, options) {
   let template;
   if (base.includes('{field}')) {
     template = base;
-  } else if (canAutoAddField(type, path)) {
+  } else if (canAutoAddField(path, base)) {
     template = `{field} ${downcase(base)}`;
+  } else {
+    template = error.message;
   }
   if (template) {
     return (0, _localization.localize)(template, {
@@ -65,13 +64,14 @@ function getLabeledMessage(error, options) {
     return (0, _localization.localize)(base);
   }
 }
-const DISALLOWED_TYPES = ['field', 'element', 'array', 'custom'];
+const GENERIC_MESSAGE_REG = /^Must|is required\.?$/;
 
-// Error types that have custom messages should not add the field
-// names automatically. Instead the custom messages can include
-// the {field} token to allow it to be interpolated if required.
-function canAutoAddField(type, path) {
-  return type && path.length && !DISALLOWED_TYPES.includes(type);
+// Only "generic" error messages should automatically add the field.
+// A custom error message may be "Please verify you are human" which
+// is intended to be understood in context and does not benefit from
+// the inclusion of the field name.
+function canAutoAddField(path, base) {
+  return path.length && GENERIC_MESSAGE_REG.test(base);
 }
 function getFieldLabel(options) {
   const {

package/dist/cjs/string.js

@@ -11,7 +11,9 @@ var _password = require("./password");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const SLUG_REG = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
 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.';
+const NANP_REG = /^\+1[2-9]\d{2}[2-9]\d{6}$/;
+const E164_DESCRIPTION = 'A phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.';
+const NANP_DESCRIPTION = 'A phone number in [NANP](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) format.';
 class StringSchema extends _TypeSchema.default {
   constructor() {
     super(String);
@@ -154,12 +156,15 @@ class StringSchema extends _TypeSchema.default {
       }
     });
   }
-  phone() {
+  phone(code) {
+    const isNANP = code === 'US' || code === 'NANP';
+    const reg = isNANP ? NANP_REG : PHONE_REG;
+    const description = isNANP ? NANP_DESCRIPTION : E164_DESCRIPTION;
     return this.format('phone', str => {
-      if (!PHONE_REG.test(str)) {
+      if (!reg.test(str)) {
         throw new _errors.LocalizedError('Must be a valid phone number.');
       }
-    }).description(PHONE_DESCRIPTION);
+    }).description(description);
   }
   hex() {
     return this.format('hex', str => {

package/package.json

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

package/src/messages.js

@@ -40,15 +40,16 @@ function getInnerPath(error, options) {
 }
 
 function getLabeledMessage(error, options) {
-  const { type } = error;
   const { path = [] } = options;
   const base = getBase(error.message);
 
   let template;
   if (base.includes('{field}')) {
     template = base;
-  } else if (canAutoAddField(type, path)) {
+  } else if (canAutoAddField(path, base)) {
     template = `{field} ${downcase(base)}`;
+  } else {
+    template = error.message;
   }
 
   if (template) {
@@ -60,13 +61,14 @@ function getLabeledMessage(error, options) {
   }
 }
 
-const DISALLOWED_TYPES = ['field', 'element', 'array', 'custom'];
+const GENERIC_MESSAGE_REG = /^Must|is required\.?$/;
 
-// Error types that have custom messages should not add the field
-// names automatically. Instead the custom messages can include
-// the {field} token to allow it to be interpolated if required.
-function canAutoAddField(type, path) {
-  return type && path.length && !DISALLOWED_TYPES.includes(type);
+// Only "generic" error messages should automatically add the field.
+// A custom error message may be "Please verify you are human" which
+// is intended to be understood in context and does not benefit from
+// the inclusion of the field name.
+function canAutoAddField(path, base) {
+  return path.length && GENERIC_MESSAGE_REG.test(base);
 }
 
 function getFieldLabel(options) {

package/src/string.js

@@ -12,10 +12,14 @@ import {
 
 const SLUG_REG = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
 const PHONE_REG = /^\+\d{1,3}\d{3,14}$/;
+const NANP_REG = /^\+1[2-9]\d{2}[2-9]\d{6}$/;
 
-const PHONE_DESCRIPTION =
+const E164_DESCRIPTION =
   'A phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.';
 
+const NANP_DESCRIPTION =
+  'A phone number in [NANP](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) format.';
+
 class StringSchema extends TypeSchema {
   constructor() {
     super(String);
@@ -149,12 +153,15 @@ class StringSchema extends TypeSchema {
     });
   }
 
-  phone() {
+  phone(code) {
+    const isNANP = code === 'US' || code === 'NANP';
+    const reg = isNANP ? NANP_REG : PHONE_REG;
+    const description = isNANP ? NANP_DESCRIPTION : E164_DESCRIPTION;
     return this.format('phone', (str) => {
-      if (!PHONE_REG.test(str)) {
+      if (!reg.test(str)) {
         throw new LocalizedError('Must be a valid phone number.');
       }
-    }).description(PHONE_DESCRIPTION);
+    }).description(description);
   }
 
   hex() {

package/types/string.d.ts

@@ -34,7 +34,7 @@ declare class StringSchema extends TypeSchema {
      */
     match(reg: RegExp): StringSchema;
     email(): StringSchema;
-    phone(): StringSchema;
+    phone(code: any): StringSchema;
     hex(): StringSchema;
     md5(): StringSchema;
     sha1(): StringSchema;

package/types/string.d.ts.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.js"],"names":[],"mappings":"AAgbA;;GAEG;AACH,iDAEC;AA/ZD;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,+BASC;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"}