@bedrockio/yada 1.2.8 → 1.3.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.3.0
+
+- Added object schema "get".
+
+## 1.2.9
+
+- Fixed field missing on empty strings.
+
 ## 1.2.8
 
 - Added "missing" which runs a custom validator on undefined.

package/dist/cjs/Schema.js

@@ -274,6 +274,12 @@ class Schema {
   inspect() {
     return JSON.stringify(this.toOpenApi(), null, 2);
   }
+  get() {
+    const {
+      name
+    } = this.constructor;
+    throw new Error(`"get" not implemented by ${name}.`);
+  }
 
   // Private
 

package/dist/cjs/object.js

@@ -149,6 +149,32 @@ class ObjectSchema extends _TypeSchema.default {
   }
 
   /**
+   * Gets the schema for the given field. Accepts either a string
+   * separated by "." or an array of path names.
+   * @param {string|Array<string>} [path] The path of the field.
+   */
+  get(path) {
+    const {
+      fields
+    } = this.meta;
+    if (!fields) {
+      throw new Error('Cannot select field on an open object schema.');
+    }
+    path = Array.isArray(path) ? path : path.split('.');
+    const [name, ...rest] = path;
+    const schema = fields[name];
+    if (!schema) {
+      throw new Error(`Cannot find field "${name}".`);
+    }
+    if (rest.length) {
+      return schema.get(rest);
+    } else {
+      return schema;
+    }
+  }
+
+  /**
+   * Returns a new schema that only validates the selected fields.
    * @param {...string} [names] Names to include.
    */
   pick(...names) {
@@ -162,6 +188,7 @@ class ObjectSchema extends _TypeSchema.default {
   }
 
   /**
+   * Returns a new schema that omits fields.
    * @param {...string} [names] Names to exclude.
    */
   omit(...names) {

package/dist/cjs/string.js

@@ -35,7 +35,7 @@ class StringSchema extends _TypeSchema.default {
         allowEmpty
       } = options;
       if (val === '' && (required || allowEmpty === false)) {
-        throw new _errors.LocalizedError('String may not be empty.');
+        throw new _errors.LocalizedError('Value is required.');
       }
       return val;
     });

package/package.json

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

package/src/Schema.js

@@ -257,6 +257,11 @@ export default class Schema {
     return JSON.stringify(this.toOpenApi(), null, 2);
   }
 
+  get() {
+    const { name } = this.constructor;
+    throw new Error(`"get" not implemented by ${name}.`);
+  }
+
   // Private
 
   /**

package/src/object.js

@@ -133,6 +133,34 @@ class ObjectSchema extends TypeSchema {
   }
 
   /**
+   * Gets the schema for the given field. Accepts either a string
+   * separated by "." or an array of path names.
+   * @param {string|Array<string>} [path] The path of the field.
+   */
+  get(path) {
+    const { fields } = this.meta;
+    if (!fields) {
+      throw new Error('Cannot select field on an open object schema.');
+    }
+
+    path = Array.isArray(path) ? path : path.split('.');
+
+    const [name, ...rest] = path;
+    const schema = fields[name];
+
+    if (!schema) {
+      throw new Error(`Cannot find field "${name}".`);
+    }
+
+    if (rest.length) {
+      return schema.get(rest);
+    } else {
+      return schema;
+    }
+  }
+
+  /**
+   * Returns a new schema that only validates the selected fields.
    * @param {...string} [names] Names to include.
    */
   pick(...names) {
@@ -147,6 +175,7 @@ class ObjectSchema extends TypeSchema {
   }
 
   /**
+   * Returns a new schema that omits fields.
    * @param {...string} [names] Names to exclude.
    */
   omit(...names) {

package/src/string.js

@@ -37,7 +37,7 @@ class StringSchema extends TypeSchema {
     this.assert('empty', (val, options) => {
       const { required, allowEmpty } = options;
       if (val === '' && (required || allowEmpty === false)) {
-        throw new LocalizedError('String may not be empty.');
+        throw new LocalizedError('Value is required.');
       }
       return val;
     });

package/types/Schema.d.ts

@@ -85,6 +85,7 @@ export default class Schema {
     };
     expandExtra(extra?: {}): {};
     inspect(): string;
+    get(): void;
     /**
      * @returns {this}
      */

package/types/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AA+ZA,kDAEC;AApZD;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,uBAFa,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,iDAyCC;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,gEAQC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAYC;IAED,qBAsCC;CACF"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AAoaA,kDAEC;AAzZD;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,uBAFa,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,iDAyCC;IAED;;OAEG;IACH,kBAFa,IAAI,CAOhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAMhB;IAED,2BAYC;IAED;;MAOC;IAED;;;;MASC;IAED;;MAOC;IAED,4BAMC;IAED,kBAEC;IAED,YAGC;IAID;;OAEG;IACH,kCAFa,IAAI,CAiDhB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED,gEAQC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAYC;IAED,qBAsCC;CACF"}

package/types/object.d.ts

@@ -20,10 +20,18 @@ declare class ObjectSchema extends TypeSchema {
      */
     append(arg: SchemaMap | Schema): ObjectSchema;
     /**
+     * Gets the schema for the given field. Accepts either a string
+     * separated by "." or an array of path names.
+     * @param {string|Array<string>} [path] The path of the field.
+     */
+    get(path?: string | Array<string>): any;
+    /**
+     * Returns a new schema that only validates the selected fields.
      * @param {...string} [names] Names to include.
      */
     pick(...names?: string[]): ObjectSchema;
     /**
+     * Returns a new schema that omits fields.
      * @param {...string} [names] Names to exclude.
      */
     omit(...names?: string[]): ObjectSchema;

package/types/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AAsMA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAMnB;wBAvMY;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG,EAAE;AAD3C;;GAEG;AAEH;IAME,cA0EC;IAED,iBAEC;IAED;;OAEG;IAEH,YAHW,SAAS,GAAC,MAAM,gBAkC1B;IAED;;OAEG;IACH,gBAFc,MAAM,EAAA,gBAWnB;IAED;;OAEG;IACH,gBAFc,MAAM,EAAA,gBAWnB;CAcF;mBA3KgC,UAAU;uBAHpB,cAAc"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AAmOA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAMnB;wBApOY;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG,EAAE;AAD3C;;GAEG;AAEH;IAME,cA0EC;IAED,iBAEC;IAED;;OAEG;IAEH,YAHW,SAAS,GAAC,MAAM,gBAkC1B;IAED;;;;OAIG;IACH,WAFW,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC,OAsB9B;IAED;;;OAGG;IACH,gBAFc,MAAM,EAAA,gBAWnB;IAED;;;OAGG;IACH,gBAFc,MAAM,EAAA,gBAWnB;CAcF;mBAxMgC,UAAU;uBAHpB,cAAc"}