@bedrockio/yada 1.0.24 → 1.0.26

package/README.md

@@ -21,6 +21,7 @@ Concepts
 - [Common Methods](#common-methods)
   - [Allow](#allow)
   - [Reject](#reject)
+  - [Append](#append)
   - [Custom](#custom)
   - [Default](#default)
   - [Strip](#strip)
@@ -318,6 +319,25 @@ const schema = yd
   .required();
 ```
 
+### Choosing Fields
+
+Object schemas also have a `pick` and `omit` method that allows custom field
+selection. These methods accept an array of field names or enumerated arguments:
+
+```js
+const schema = yd.object({
+  firstName: yd.string().required(),
+  lastName: yd.string().required(),
+  dob: yd.date(),
+});
+
+// Includes "firstName" and "lastName" but omits "dob".
+schema.pick(['firstName', 'lastName']);
+
+// Excludes "firstName" and "lastName" but keeps "dob".
+schema.omit('firstName', 'lastName');
+```
+
 ## Date
 
 Dates are similar to the basic types with the exception that in addition to date

package/dist/cjs/Schema.js

@@ -212,6 +212,9 @@ class Schema {
       ...this.expandExtra(extra)
     };
   }
+  inspect() {
+    return JSON.stringify(this.toOpenApi(), null, 2);
+  }
   expandExtra(extra = {}) {
     const {
       tag,
@@ -246,8 +249,7 @@ class Schema {
         for (let el of set) {
           if (isSchema(el)) {
             try {
-              await el.validate(val, options);
-              return;
+              return await el.validate(val, options);
             } catch (error) {
               continue;
             }

package/dist/cjs/object.js

@@ -140,6 +140,32 @@ class ObjectSchema extends _TypeSchema.default {
     }
     return merged;
   }
+
+  /**
+   * @param {...string} [names] Names to include.
+   */
+  pick(...names) {
+    if (Array.isArray(names[0])) {
+      names = names[0];
+    }
+    const fields = pick(this.meta.fields, names);
+    return new ObjectSchema(fields, {
+      ...this.meta
+    });
+  }
+
+  /**
+   * @param {...string} [names] Names to exclude.
+   */
+  omit(...names) {
+    if (Array.isArray(names[0])) {
+      names = names[0];
+    }
+    const fields = omit(this.meta.fields, names);
+    return new ObjectSchema(fields, {
+      ...this.meta
+    });
+  }
   toOpenApi(extra) {
     const properties = {};
     for (let [key, schema] of Object.entries(this.getFields())) {
@@ -174,6 +200,22 @@ function expandDotProperties(obj) {
   }
   return result;
 }
+function pick(obj, keys) {
+  const result = {};
+  for (let key of keys) {
+    result[key] = obj[key];
+  }
+  return result;
+}
+function omit(obj, keys) {
+  const result = {};
+  for (let key of Object.keys(obj || {})) {
+    if (!keys.includes(key)) {
+      result[key] = obj[key];
+    }
+  }
+  return result;
+}
 
 /**
  * Creates an [object schema](https://github.com/bedrockio/yada#object).

package/package.json

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

package/src/Schema.js

@@ -199,6 +199,10 @@ export default class Schema {
     };
   }
 
+  inspect() {
+    return JSON.stringify(this.toOpenApi(), null, 2);
+  }
+
   expandExtra(extra = {}) {
     const { tag, ...rest } = extra;
     if (typeof extra?.tag === 'function') {
@@ -228,8 +232,7 @@ export default class Schema {
         for (let el of set) {
           if (isSchema(el)) {
             try {
-              await el.validate(val, options);
-              return;
+              return await el.validate(val, options);
             } catch (error) {
               continue;
             }

package/src/object.js

@@ -133,6 +133,34 @@ class ObjectSchema extends TypeSchema {
     return merged;
   }
 
+  /**
+   * @param {...string} [names] Names to include.
+   */
+  pick(...names) {
+    if (Array.isArray(names[0])) {
+      names = names[0];
+    }
+    const fields = pick(this.meta.fields, names);
+
+    return new ObjectSchema(fields, {
+      ...this.meta,
+    });
+  }
+
+  /**
+   * @param {...string} [names] Names to exclude.
+   */
+  omit(...names) {
+    if (Array.isArray(names[0])) {
+      names = names[0];
+    }
+    const fields = omit(this.meta.fields, names);
+
+    return new ObjectSchema(fields, {
+      ...this.meta,
+    });
+  }
+
   toOpenApi(extra) {
     const properties = {};
     for (let [key, schema] of Object.entries(this.getFields())) {
@@ -169,6 +197,24 @@ function expandDotProperties(obj) {
   return result;
 }
 
+function pick(obj, keys) {
+  const result = {};
+  for (let key of keys) {
+    result[key] = obj[key];
+  }
+  return result;
+}
+
+function omit(obj, keys) {
+  const result = {};
+  for (let key of Object.keys(obj || {})) {
+    if (!keys.includes(key)) {
+      result[key] = obj[key];
+    }
+  }
+  return result;
+}
+
 /**
  * Creates an [object schema](https://github.com/bedrockio/yada#object).
  *

package/types/Schema.d.ts

@@ -64,6 +64,7 @@ export default class Schema {
      */
     append(schema: any): this;
     toOpenApi(extra: any): any;
+    inspect(): string;
     expandExtra(extra?: {}): {};
     /**
      * @returns {this}

package/types/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AA8UA,4CAEC;AArUD;;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;IAED,4BAMC;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;8BAhUY,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":"AAiVA,4CAEC;AAxUD;;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;IAED,kBAEC;IAED,4BAMC;IAID;;OAEG;IACH,kCAFa,IAAI,CA+BhB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAUC;IAED;;;;;;;;MAoCC;CACF;8BAnUY,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC"}

package/types/object.d.ts

@@ -25,6 +25,14 @@ declare class ObjectSchema extends TypeSchema {
      * @param {SchemaMap|Schema} arg Object or schema to append.
      */
     append(arg: SchemaMap | Schema): ObjectSchema;
+    /**
+     * @param {...string} [names] Names to include.
+     */
+    pick(...names?: string[]): ObjectSchema;
+    /**
+     * @param {...string} [names] Names to exclude.
+     */
+    omit(...names?: string[]): ObjectSchema;
 }
 import Schema from "./Schema";
 import TypeSchema from "./TypeSchema";

package/types/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AA2KA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAMnB;;;;AA9KD;;GAEG;AAEH;IAUE;;OAEG;IACH,cAkEC;IAED;;OAEG;IACH,kBAEC;IAED;;OAEG;IAEH,YAHW,SAAS,GAAC,MAAM,gBAkC1B;CAcF"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AAyNA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAMnB;;;;AA5ND;;GAEG;AAEH;IAUE;;OAEG;IACH,cAkEC;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/foo.d.ts

@@ -1,5 +0,0 @@
-/**
- * @param {...number} [bar] wut
- */
-declare function foo(...bar?: number[]): void;
-//# sourceMappingURL=foo.d.ts.map

package/types/foo.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"foo.d.ts","sourceRoot":"","sources":["../src/foo.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,8BAFc,MAAM,UAInB"}