@bedrockio/yada 1.0.20 → 1.0.22

package/dist/cjs/Schema.js

@@ -204,15 +204,9 @@ class Schema {
       default: defaultValue
     } = this.meta;
     return {
-      ...(required && {
-        required: true
-      }),
-      ...(defaultValue && {
-        default: defaultValue
-      }),
-      ...(format && {
-        format
-      }),
+      required,
+      default: defaultValue,
+      format,
       ...this.enumToOpenApi(),
       ...tags,
       ...extra

package/dist/cjs/password.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.PASSWORD_DEFAULTS = void 0;
+exports.getPasswordOptions = getPasswordOptions;
 exports.validateLength = validateLength;
 exports.validateUppercase = exports.validateSymbols = exports.validateNumbers = exports.validateLowercase = void 0;
 var _errors = require("./errors");
@@ -18,7 +18,16 @@ const PASSWORD_DEFAULTS = {
   minNumbers: 0,
   minSymbols: 0
 };
-exports.PASSWORD_DEFAULTS = PASSWORD_DEFAULTS;
+function getPasswordOptions(options) {
+  options = {
+    ...PASSWORD_DEFAULTS,
+    ...options
+  };
+  return {
+    ...options,
+    description: generatePasswordDescription(options)
+  };
+}
 function validateLength(expected) {
   return (str = '') => {
     if (str.length < expected) {
@@ -51,4 +60,55 @@ function validateRegex(reg, message) {
       }
     };
   };
+}
+function generatePasswordDescription(options) {
+  const {
+    minLength
+  } = options;
+  const contains = generatePasswordContains(options);
+  if (minLength) {
+    const plural = pluralize(minLength, 'character');
+    return `A password of at least ${plural}${contains}.`;
+  } else {
+    return `A password${contains}.`;
+  }
+}
+function generatePasswordContains(options) {
+  const {
+    minLowercase,
+    minUppercase,
+    minNumbers,
+    minSymbols
+  } = options;
+  const arr = [];
+  if (minLowercase) {
+    arr.push(`${minLowercase} lowercase`);
+  }
+  if (minUppercase) {
+    arr.push(`${minUppercase} uppercase`);
+  }
+  if (minNumbers) {
+    arr.push(`${pluralize(minNumbers, 'number')}`);
+  }
+  if (minSymbols) {
+    arr.push(`${pluralize(minSymbols, 'symbol')}`);
+  }
+  if (arr.length) {
+    return ` containing ${and(arr)}`;
+  } else {
+    return '';
+  }
+}
+function pluralize(n, str) {
+  const s = n === 1 ? '' : 's';
+  return `${n} ${str}${s}`;
+}
+function and(arr) {
+  if (arr.length <= 2) {
+    return arr.join(' and ');
+  } else {
+    const last = arr.pop();
+    const joined = arr.join(', ');
+    return `${joined}, and ${last}`;
+  }
 }

package/dist/cjs/string.js

@@ -11,6 +11,7 @@ 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 = /^\+?[1-9]\d{1,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);
@@ -132,7 +133,7 @@ class StringSchema extends _TypeSchema.default {
       if (!PHONE_REG.test(str)) {
         throw new _errors.LocalizedError('Must be a valid phone number.');
       }
-    });
+    }).description(PHONE_DESCRIPTION);
   }
   hex() {
     return this.format('hex', str => {
@@ -246,16 +247,14 @@ class StringSchema extends _TypeSchema.default {
    */
   password(options = {}) {
     const {
+      description,
       minLength,
       minNumbers,
       minSymbols,
       minLowercase,
       minUppercase
-    } = {
-      ..._password.PASSWORD_DEFAULTS,
-      ...options
-    };
-    const schema = this.clone();
+    } = (0, _password.getPasswordOptions)(options);
+    const schema = this.clone().description(description);
     if (minLength) {
       schema.assert('password', (0, _password.validateLength)(minLength));
     }

package/package.json

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

package/src/Schema.js

@@ -190,15 +190,9 @@ export default class Schema {
   toOpenApi(extra) {
     const { required, format, tags, default: defaultValue } = this.meta;
     return {
-      ...(required && {
-        required: true,
-      }),
-      ...(defaultValue && {
-        default: defaultValue,
-      }),
-      ...(format && {
-        format,
-      }),
+      required,
+      default: defaultValue,
+      format,
       ...this.enumToOpenApi(),
       ...tags,
       ...extra,

package/src/password.js

@@ -5,7 +5,7 @@ const UPPER_REG = /[A-Z]/g;
 const NUMBER_REG = /[0-9]/g;
 const SYMBOL_REG = /[!@#$%^&*]/g;
 
-export const PASSWORD_DEFAULTS = {
+const PASSWORD_DEFAULTS = {
   minLength: 12,
   minLowercase: 0,
   minUppercase: 0,
@@ -13,6 +13,17 @@ export const PASSWORD_DEFAULTS = {
   minSymbols: 0,
 };
 
+export function getPasswordOptions(options) {
+  options = {
+    ...PASSWORD_DEFAULTS,
+    ...options,
+  };
+  return {
+    ...options,
+    description: generatePasswordDescription(options),
+  };
+}
+
 export function validateLength(expected) {
   return (str = '') => {
     if (str.length < expected) {
@@ -59,3 +70,51 @@ function validateRegex(reg, message) {
     };
   };
 }
+
+function generatePasswordDescription(options) {
+  const { minLength } = options;
+  const contains = generatePasswordContains(options);
+  if (minLength) {
+    const plural = pluralize(minLength, 'character');
+    return `A password of at least ${plural}${contains}.`;
+  } else {
+    return `A password${contains}.`;
+  }
+}
+
+function generatePasswordContains(options) {
+  const { minLowercase, minUppercase, minNumbers, minSymbols } = options;
+  const arr = [];
+  if (minLowercase) {
+    arr.push(`${minLowercase} lowercase`);
+  }
+  if (minUppercase) {
+    arr.push(`${minUppercase} uppercase`);
+  }
+  if (minNumbers) {
+    arr.push(`${pluralize(minNumbers, 'number')}`);
+  }
+  if (minSymbols) {
+    arr.push(`${pluralize(minSymbols, 'symbol')}`);
+  }
+  if (arr.length) {
+    return ` containing ${and(arr)}`;
+  } else {
+    return '';
+  }
+}
+
+function pluralize(n, str) {
+  const s = n === 1 ? '' : 's';
+  return `${n} ${str}${s}`;
+}
+
+function and(arr) {
+  if (arr.length <= 2) {
+    return arr.join(' and ');
+  } else {
+    const last = arr.pop();
+    const joined = arr.join(', ');
+    return `${joined}, and ${last}`;
+  }
+}

package/src/string.js

@@ -2,17 +2,20 @@ import validator from 'validator';
 import TypeSchema from './TypeSchema';
 import { LocalizedError } from './errors';
 import {
-  PASSWORD_DEFAULTS,
   validateLength,
   validateLowercase,
   validateUppercase,
   validateNumbers,
   validateSymbols,
+  getPasswordOptions,
 } from './password';
 
 const SLUG_REG = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
 const PHONE_REG = /^\+?[1-9]\d{1,14}$/;
 
+const PHONE_DESCRIPTION =
+  'A phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.';
+
 class StringSchema extends TypeSchema {
   constructor() {
     super(String);
@@ -131,7 +134,7 @@ class StringSchema extends TypeSchema {
       if (!PHONE_REG.test(str)) {
         throw new LocalizedError('Must be a valid phone number.');
       }
-    });
+    }).description(PHONE_DESCRIPTION);
   }
 
   hex() {
@@ -255,12 +258,16 @@ class StringSchema extends TypeSchema {
    * @param {number} [options.minUppercase]
    */
   password(options = {}) {
-    const { minLength, minNumbers, minSymbols, minLowercase, minUppercase } = {
-      ...PASSWORD_DEFAULTS,
-      ...options,
-    };
-
-    const schema = this.clone();
+    const {
+      description,
+      minLength,
+      minNumbers,
+      minSymbols,
+      minLowercase,
+      minUppercase,
+    } = getPasswordOptions(options);
+
+    const schema = this.clone().description(description);
 
     if (minLength) {
       schema.assert('password', validateLength(minLength));

package/types/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AA4UA,4CAEC;AAnUD;;GAEG;AAEH;IACE,uBAGC;IAFC,kBAAoB;IACpB,SAAgB;IAKlB;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAQhB;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,2BAgBC;IAID;;OAEG;IACH,kCAFa,IAAI,CAgChB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAUC;IAED;;;;;;;;MAoCC;CACF;8BA9TY,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":"AAsUA,4CAEC;AA7TD;;GAEG;AAEH;IACE,uBAGC;IAFC,kBAAoB;IACpB,SAAgB;IAKlB;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAQhB;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,2BAUC;IAID;;OAEG;IACH,kCAFa,IAAI,CAgChB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAUC;IAED;;;;;;;;MAoCC;CACF;8BAxTY,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC"}

package/types/password.d.ts

@@ -1,11 +1,5 @@
+export function getPasswordOptions(options: any): any;
 export function validateLength(expected: any): (str?: string) => void;
-export namespace PASSWORD_DEFAULTS {
-    const minLength: number;
-    const minLowercase: number;
-    const minUppercase: number;
-    const minNumbers: number;
-    const minSymbols: number;
-}
 export function validateLowercase(expected: any): (str?: string) => void;
 export function validateUppercase(expected: any): (str?: string) => void;
 export function validateNumbers(expected: any): (str?: string) => void;

package/types/password.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"password.d.ts","sourceRoot":"","sources":["../src/password.js"],"names":[],"mappings":"AAeA,sEAUC;;;;;;;;AAuBQ,yEAWN;AAXM,yEAWN;AAXM,uEAWN;AAXM,uEAWN"}
+{"version":3,"file":"password.d.ts","sourceRoot":"","sources":["../src/password.js"],"names":[],"mappings":"AAeA,sDASC;AAED,sEAUC;AAuBQ,yEAWN;AAXM,yEAWN;AAXM,uEAWN;AAXM,uEAWN"}

package/types/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.js"],"names":[],"mappings":"AAyXA;;GAEG;AACH,iDAEC;AA/WD;IACE,cAWC;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;;;;;;;OAOG;IACH;QAN4B,SAAS,GAA1B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,YAAY,GAA7B,MAAM;QACW,YAAY,GAA7B,MAAM;qBA2BhB;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":"AAgYA;;GAEG;AACH,iDAEC;AAnXD;IACE,cAWC;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;;;;;;;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"}