@bedrockio/yada 1.1.3 → 1.2.0

package/dist/cjs/Schema.js

@@ -147,6 +147,8 @@ 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);
@@ -391,7 +393,9 @@ class Schema {
               };
               oneOf.push(forType);
             }
-            forType.enum.push(entry);
+            if (forType.enum) {
+              forType.enum.push(entry);
+            }
           }
         }
         return {

package/dist/cjs/errors.js

@@ -14,16 +14,17 @@ class LocalizedError extends Error {
 }
 exports.LocalizedError = LocalizedError;
 class ValidationError extends Error {
+  static DEFAULT_MESSAGE = 'Validation failed.';
   constructor(arg, details = []) {
-    super(getLocalizedMessage(arg));
+    super(getLocalizedMessage(arg) || ValidationError.DEFAULT_MESSAGE);
     this.type = 'validation';
     this.details = details;
   }
   toJSON() {
     const {
-      message,
       details
     } = this;
+    const message = this.getMessage();
     return {
       type: this.type,
       ...(message && {
@@ -36,6 +37,18 @@ class ValidationError extends Error {
       })
     };
   }
+  getMessage() {
+    const {
+      message
+    } = this;
+    // @ts-ignore
+    const {
+      DEFAULT_MESSAGE
+    } = this.constructor;
+    if (message && message !== DEFAULT_MESSAGE) {
+      return message;
+    }
+  }
   getFullMessage(options) {
     return (0, _messages.getFullMessage)(this, {
       delimiter: ' ',

package/dist/cjs/messages.js

@@ -9,7 +9,7 @@ function getFullMessage(error, options) {
   const {
     delimiter = '\n'
   } = options;
-  if (error.message) {
+  if (hasMessage(error)) {
     return getLabeledMessage(error, options);
   } else if (error.details?.length) {
     return error.details.map(error => {
@@ -20,6 +20,15 @@ function getFullMessage(error, options) {
     }).join(delimiter);
   }
 }
+function hasMessage(error) {
+  let message;
+  if (error.getMessage) {
+    message = error.getMessage();
+  } else {
+    message = error.message;
+  }
+  return !!message;
+}
 function getInnerPath(error, options) {
   const {
     path = []

package/dist/cjs/object.js

@@ -39,6 +39,7 @@ class ObjectSchema extends _TypeSchema.default {
       const {
         fields,
         stripUnknown,
+        stripEmpty,
         expandDotSyntax
       } = options;
       if (obj) {
@@ -47,13 +48,17 @@ class ObjectSchema extends _TypeSchema.default {
           obj = expandDotProperties(obj);
         }
         for (let key of Object.keys(obj)) {
-          if (!fields || key in fields) {
-            result[key] = obj[key];
-          } else if (!stripUnknown) {
+          const value = obj[key];
+          const isUnknown = !!fields && !(key in fields);
+          if (value === '' && stripEmpty || isUnknown && stripUnknown) {
+            continue;
+          } else if (isUnknown) {
             throw new _errors.LocalizedError('Unknown field "{key}".', {
               key,
               type: 'field'
             });
+          } else {
+            result[key] = obj[key];
           }
         }
         return result;
@@ -69,11 +74,13 @@ class ObjectSchema extends _TypeSchema.default {
             path = []
           } = options;
           const {
-            strip
+            strip,
+            required
           } = schema.meta;
           const val = obj[key];
           options = {
             ...options,
+            required,
             path: [...path, key]
           };
           if (strip && strip(val, options)) {

package/dist/cjs/string.js

@@ -14,10 +14,13 @@ 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);
+    super(String, {
+      allowEmpty: true
+    });
     this.assert('type', (val, options) => {
       const {
         cast,
+        required,
         allowEmpty
       } = options;
       if (cast && typeof val !== 'string') {
@@ -25,7 +28,7 @@ class StringSchema extends _TypeSchema.default {
       }
       if (typeof val !== 'string') {
         throw new _errors.LocalizedError('Must be a string.');
-      } else if (!allowEmpty && val === '') {
+      } else if ((required || !allowEmpty) && val === '') {
         throw new _errors.LocalizedError('String may not be empty.');
       }
       return val;
@@ -45,15 +48,6 @@ class StringSchema extends _TypeSchema.default {
     });
   }
 
-  /**
-   * @returns {this}
-   */
-  allowEmpty() {
-    return this.options({
-      allowEmpty: true
-    });
-  }
-
   /**
    * @param {number} length
    */
@@ -390,10 +384,10 @@ class StringSchema extends _TypeSchema.default {
     } = this.meta;
     return {
       ...super.toOpenApi(extra),
-      ...(min != null && {
+      ...(min && {
         minLength: min
       }),
-      ...(max != null && {
+      ...(max && {
         maxLength: max
       })
     };

package/package.json

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

package/src/Schema.js

@@ -140,6 +140,8 @@ export default class Schema {
         break;
       } else if (value === null && options.nullable) {
         break;
+      } else if (value === '' && !options.required && options.allowEmpty) {
+        break;
       }
 
       try {
@@ -373,7 +375,9 @@ export default class Schema {
               };
               oneOf.push(forType);
             }
-            forType.enum.push(entry);
+            if (forType.enum) {
+              forType.enum.push(entry);
+            }
           }
         }
         return { oneOf };

package/src/errors.js

@@ -8,14 +8,17 @@ export class LocalizedError extends Error {
 }
 
 export class ValidationError extends Error {
+  static DEFAULT_MESSAGE = 'Validation failed.';
+
   constructor(arg, details = []) {
-    super(getLocalizedMessage(arg));
+    super(getLocalizedMessage(arg) || ValidationError.DEFAULT_MESSAGE);
     this.type = 'validation';
     this.details = details;
   }
 
   toJSON() {
-    const { message, details } = this;
+    const { details } = this;
+    const message = this.getMessage();
     return {
       type: this.type,
       ...(message && {
@@ -29,6 +32,15 @@ export class ValidationError extends Error {
     };
   }
 
+  getMessage() {
+    const { message } = this;
+    // @ts-ignore
+    const { DEFAULT_MESSAGE } = this.constructor;
+    if (message && message !== DEFAULT_MESSAGE) {
+      return message;
+    }
+  }
+
   getFullMessage(options) {
     return getFullMessage(this, {
       delimiter: ' ',

package/src/messages.js

@@ -2,7 +2,7 @@ import { localize } from './localization';
 
 export function getFullMessage(error, options) {
   const { delimiter = '\n' } = options;
-  if (error.message) {
+  if (hasMessage(error)) {
     return getLabeledMessage(error, options);
   } else if (error.details?.length) {
     return error.details
@@ -16,6 +16,16 @@ export function getFullMessage(error, options) {
   }
 }
 
+function hasMessage(error) {
+  let message;
+  if (error.getMessage) {
+    message = error.getMessage();
+  } else {
+    message = error.message;
+  }
+  return !!message;
+}
+
 function getInnerPath(error, options) {
   const { path = [] } = options;
   if (error.field) {

package/src/object.js

@@ -25,20 +25,25 @@ class ObjectSchema extends TypeSchema {
       }
     });
     this.transform((obj, options) => {
-      const { fields, stripUnknown, expandDotSyntax } = options;
+      const { fields, stripUnknown, stripEmpty, expandDotSyntax } = options;
       if (obj) {
         const result = {};
         if (expandDotSyntax) {
           obj = expandDotProperties(obj);
         }
         for (let key of Object.keys(obj)) {
-          if (!fields || key in fields) {
-            result[key] = obj[key];
-          } else if (!stripUnknown) {
+          const value = obj[key];
+          const isUnknown = !!fields && !(key in fields);
+
+          if ((value === '' && stripEmpty) || (isUnknown && stripUnknown)) {
+            continue;
+          } else if (isUnknown) {
             throw new LocalizedError('Unknown field "{key}".', {
               key,
               type: 'field',
             });
+          } else {
+            result[key] = obj[key];
           }
         }
         return result;
@@ -51,11 +56,12 @@ class ObjectSchema extends TypeSchema {
       this.assert('field', async (obj, options) => {
         if (obj) {
           const { path = [] } = options;
-          const { strip } = schema.meta;
+          const { strip, required } = schema.meta;
           const val = obj[key];
 
           options = {
             ...options,
+            required,
             path: [...path, key],
           };
 

package/src/string.js

@@ -18,15 +18,15 @@ const PHONE_DESCRIPTION =
 
 class StringSchema extends TypeSchema {
   constructor() {
-    super(String);
+    super(String, { allowEmpty: true });
     this.assert('type', (val, options) => {
-      const { cast, allowEmpty } = options;
+      const { cast, required, 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 === '') {
+      } else if ((required || !allowEmpty) && val === '') {
         throw new LocalizedError('String may not be empty.');
       }
       return val;
@@ -44,13 +44,6 @@ class StringSchema extends TypeSchema {
     });
   }
 
-  /**
-   * @returns {this}
-   */
-  allowEmpty() {
-    return this.options({ allowEmpty: true });
-  }
-
   /**
    * @param {number} length
    */
@@ -401,10 +394,10 @@ class StringSchema extends TypeSchema {
     const { min, max } = this.meta;
     return {
       ...super.toOpenApi(extra),
-      ...(min != null && {
+      ...(min && {
         minLength: min,
       }),
-      ...(max != null && {
+      ...(max && {
         maxLength: max,
       }),
     };

package/types/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AAgYA,4CAEC;AArXD;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,iDA6CC;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;;;;;;;;MAoCC;CACF"}
+{"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"}

package/types/errors.d.ts

@@ -3,6 +3,7 @@ export class LocalizedError extends Error {
     constructor(message: any, values?: {});
 }
 export class ValidationError extends Error {
+    static DEFAULT_MESSAGE: string;
     constructor(arg: any, details?: any[]);
     type: string;
     details: any[];
@@ -11,6 +12,7 @@ export class ValidationError extends Error {
         message: string;
         type: string;
     };
+    getMessage(): string;
     getFullMessage(options: any): any;
 }
 export class AssertionError extends ValidationError {

package/types/errors.d.ts.map

@@ -1 +1 @@
-{"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"}
+{"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"}

package/types/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AAiMA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAMnB;;;;AAnMD;;GAEG;AAEH;IAME;;OAEG;IACH,cA+DC;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":"AAuMA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAMnB;;;;AAzMD;;GAEG;AAEH;IAME;;OAEG;IACH,cAqEC;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,10 +8,6 @@ declare class StringSchema extends TypeSchema {
      * @returns {this}
      */
     required(): this;
-    /**
-     * @returns {this}
-     */
-    allowEmpty(): this;
     /**
      * @param {number} length
      */

package/types/string.d.ts.map

@@ -1 +1 @@
-{"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"}
+{"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"}