@bedrockio/yada 1.7.0 → 1.8.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.8.0
+
+- Removed undefined `format` field.
+- Changed JSON schema `oneOf` to `anyOf`.
+- Added `requireAll` and `requireAllWithin`.
+
 ## 1.7.0
 
 - Partial revert of 1.6.0. Dot syntax expanding no longer default but enabled.

package/dist/cjs/Schema.js

@@ -223,15 +223,14 @@ class Schema {
    */
   toJSON(extra) {
     const {
-      format,
       tags
     } = this.meta;
     return {
-      format,
       ...tags,
       ...this.getAnyType(),
       ...this.getDefault(),
       ...this.getNullable(),
+      ...this.getFormat(),
       ...this.getEnum(),
       ...this.expandExtra(extra)
     };
@@ -255,6 +254,16 @@ class Schema {
       };
     }
   }
+  getFormat() {
+    const {
+      format
+    } = this.meta;
+    if (format) {
+      return {
+        format
+      };
+    }
+  }
   getDefault() {
     const {
       default: defaultValue
@@ -293,13 +302,23 @@ class Schema {
           enum: allowed
         };
       } else {
-        const oneOf = [];
+        // Note that "oneOf" is subtly different to "anyOf" in that ONLY one branch
+        // can pass. Currently yada allows any successful branch to allow the schema
+        // to pass validation. In addition to being more semantically correct, "oneOf":
+        //
+        // 1. Is computationally expensive (must test multiple times).
+        // 2. Is disallowed by OpenAI: https://tinyurl.com/33cr388a
+        const anyOf = [];
         for (let entry of allowed) {
           if (isSchema(entry)) {
-            oneOf.push(entry.toJSON());
+            anyOf.push(entry.toJSON());
+          } else if (entry === null) {
+            anyOf.push({
+              type: 'null'
+            });
           } else {
             const type = typeof entry;
-            let forType = oneOf.find(el => {
+            let forType = anyOf.find(el => {
               return el.type === type;
             });
             if (!forType) {
@@ -307,7 +326,7 @@ class Schema {
                 type,
                 enum: []
               };
-              oneOf.push(forType);
+              anyOf.push(forType);
             }
             if (forType.enum) {
               forType.enum.push(entry);
@@ -315,11 +334,36 @@ class Schema {
           }
         }
         return {
-          oneOf
+          anyOf
         };
       }
     }
   }
+
+  /**
+   * Augments the schema to make all fields required
+   * including fields in all nested schemas.
+   * @returns {this}
+   */
+  requireAllWithin() {
+    let {
+      enum: allowed
+    } = this.meta;
+    if (allowed) {
+      allowed = allowed.map(el => {
+        if (el?.requireAllWithin) {
+          return el.requireAllWithin();
+        } else {
+          return el;
+        }
+      });
+      return this.clone({
+        enum: allowed
+      }).required();
+    } else {
+      return this.required();
+    }
+  }
   expandExtra(extra = {}) {
     const {
       tag,

package/dist/cjs/array.js

@@ -118,7 +118,7 @@ class ArraySchema extends _TypeSchema.default {
     } = this.meta;
     if (schemas.length > 1) {
       other = {
-        oneOf: schemas.map(schema => {
+        anyOf: schemas.map(schema => {
           return schema.toJSON();
         })
       };

package/dist/cjs/object.js

@@ -207,6 +207,32 @@ class ObjectSchema extends _TypeSchema.default {
     return this.append(update);
   }
 
+  /**
+   * Augments the object schema to make all fields required.
+   */
+  requireAll() {
+    const update = {};
+    for (let field of Object.keys(this.meta.fields)) {
+      (0, _lodash.set)(update, field, this.get(field).required());
+    }
+    return this.append(update);
+  }
+
+  /**
+   * Augments the object schema to make all fields required
+   * including fields in all nested schemas.
+   * @returns {this}
+   */
+  requireAllWithin() {
+    const update = {};
+    for (let field of Object.keys(this.meta.fields)) {
+      (0, _lodash.set)(update, field, this.get(field).requireAllWithin());
+    }
+
+    // @ts-ignore
+    return this.append(update).required();
+  }
+
   /**
    * Returns the schema's fields as an object allowing them
    * to be "spread" to create new schemas. Note that doing

package/package.json

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

package/src/Schema.js

@@ -215,13 +215,13 @@ export default class Schema {
    * @param {Object} [extra]
    */
   toJSON(extra) {
-    const { format, tags } = this.meta;
+    const { tags } = this.meta;
     return {
-      format,
       ...tags,
       ...this.getAnyType(),
       ...this.getDefault(),
       ...this.getNullable(),
+      ...this.getFormat(),
       ...this.getEnum(),
       ...this.expandExtra(extra),
     };
@@ -244,6 +244,13 @@ export default class Schema {
     }
   }
 
+  getFormat() {
+    const { format } = this.meta;
+    if (format) {
+      return { format };
+    }
+  }
+
   getDefault() {
     const { default: defaultValue } = this.meta;
     if (typeof defaultValue === 'function') {
@@ -278,13 +285,23 @@ export default class Schema {
           enum: allowed,
         };
       } else {
-        const oneOf = [];
+        // Note that "oneOf" is subtly different to "anyOf" in that ONLY one branch
+        // can pass. Currently yada allows any successful branch to allow the schema
+        // to pass validation. In addition to being more semantically correct, "oneOf":
+        //
+        // 1. Is computationally expensive (must test multiple times).
+        // 2. Is disallowed by OpenAI: https://tinyurl.com/33cr388a
+        const anyOf = [];
         for (let entry of allowed) {
           if (isSchema(entry)) {
-            oneOf.push(entry.toJSON());
+            anyOf.push(entry.toJSON());
+          } else if (entry === null) {
+            anyOf.push({
+              type: 'null',
+            });
           } else {
             const type = typeof entry;
-            let forType = oneOf.find((el) => {
+            let forType = anyOf.find((el) => {
               return el.type === type;
             });
             if (!forType) {
@@ -292,18 +309,39 @@ export default class Schema {
                 type,
                 enum: [],
               };
-              oneOf.push(forType);
+              anyOf.push(forType);
             }
             if (forType.enum) {
               forType.enum.push(entry);
             }
           }
         }
-        return { oneOf };
+        return { anyOf };
       }
     }
   }
 
+  /**
+   * Augments the schema to make all fields required
+   * including fields in all nested schemas.
+   * @returns {this}
+   */
+  requireAllWithin() {
+    let { enum: allowed } = this.meta;
+    if (allowed) {
+      allowed = allowed.map((el) => {
+        if (el?.requireAllWithin) {
+          return el.requireAllWithin();
+        } else {
+          return el;
+        }
+      });
+      return this.clone({ enum: allowed }).required();
+    } else {
+      return this.required();
+    }
+  }
+
   expandExtra(extra = {}) {
     const { tag, ...rest } = extra;
     if (typeof extra?.tag === 'function') {

package/src/array.js

@@ -115,7 +115,7 @@ class ArraySchema extends TypeSchema {
     const { schemas } = this.meta;
     if (schemas.length > 1) {
       other = {
-        oneOf: schemas.map((schema) => {
+        anyOf: schemas.map((schema) => {
           return schema.toJSON();
         }),
       };

package/src/object.js

@@ -69,6 +69,7 @@ class ObjectSchema extends TypeSchema {
             delete obj[key];
             return;
           }
+
           try {
             // Do not pass down message into validators
             // to allow custom messages to take precedence.
@@ -200,6 +201,35 @@ class ObjectSchema extends TypeSchema {
     return this.append(update);
   }
 
+  /**
+   * Augments the object schema to make all fields required.
+   */
+  requireAll() {
+    const update = {};
+
+    for (let field of Object.keys(this.meta.fields)) {
+      set(update, field, this.get(field).required());
+    }
+
+    return this.append(update);
+  }
+
+  /**
+   * Augments the object schema to make all fields required
+   * including fields in all nested schemas.
+   * @returns {this}
+   */
+  requireAllWithin() {
+    const update = {};
+
+    for (let field of Object.keys(this.meta.fields)) {
+      set(update, field, this.get(field).requireAllWithin());
+    }
+
+    // @ts-ignore
+    return this.append(update).required();
+  }
+
   /**
    * Returns the schema's fields as an object allowing them
    * to be "spread" to create new schemas. Note that doing

package/types/Schema.d.ts

@@ -86,6 +86,9 @@ export default class Schema {
     getAnyType(): {
         type: string[];
     };
+    getFormat(): {
+        format: any;
+    };
     getDefault(): {
         default?: undefined;
     } | {
@@ -95,6 +98,12 @@ export default class Schema {
         nullable: boolean;
     };
     getEnum(): any;
+    /**
+     * Augments the schema to make all fields required
+     * including fields in all nested schemas.
+     * @returns {this}
+     */
+    requireAllWithin(): this;
     expandExtra(extra?: {}): {};
     inspect(): string;
     get(): void;

package/types/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AAgBA,kDAEC;AAED;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,iDAwCC;IAED;;OAEG;IACH,kBAFa,IAAI,CAOhB;IAED;;;OAGG;IACH,qBAFa,MAAM,CAMlB;IAED;;;;;OAKG;IACH,yBAWC;IAED;;;OAGG;IACH,gCAEC;IAED;;MAOC;IAED;;;;MASC;IAED;;MAOC;IAED,eAsCC;IAED,4BAMC;IAED,kBAEC;IAED,YAGC;IAID;;OAEG;IACH,kCAFa,IAAI,CAsDhB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED,gEAQC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAYC;CACF"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AAgBA,kDAEC;AAED;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,iDAwCC;IAED;;OAEG;IACH,kBAFa,IAAI,CAOhB;IAED;;;OAGG;IACH,qBAFa,MAAM,CAMlB;IAED;;;;;OAKG;IACH,yBAWC;IAED;;;OAGG;IACH,gCAEC;IAED;;MAOC;IAED;;MAKC;IAED;;;;MASC;IAED;;MAOC;IAED,eAgDC;IAED;;;;OAIG;IACH,oBAFa,IAAI,CAgBhB;IAED,4BAMC;IAED,kBAEC;IAED,YAGC;IAID;;OAEG;IACH,kCAFa,IAAI,CAsDhB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED,gEAQC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAYC;CACF"}

package/types/object.d.ts

@@ -52,6 +52,16 @@ declare class ObjectSchema extends TypeSchema {
      * @param {Array<string>} fields
      */
     require(...fields: string[]): ObjectSchema;
+    /**
+     * Augments the object schema to make all fields required.
+     */
+    requireAll(): ObjectSchema;
+    /**
+     * Augments the object schema to make all fields required
+     * including fields in all nested schemas.
+     * @returns {this}
+     */
+    requireAllWithin(): this;
     /**
      * Returns the schema's fields as an object allowing them
      * to be "spread" to create new schemas. Note that doing

package/types/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AAkYA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAQnB;wBAlYY;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG,EAAE;AAD3C;;GAEG;AAEH;IACE,uBAGC;IAED,cA8EC;IAED;;;;;;OAMG;IACH,WAFW,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC,OAsB9B;IAED;;;;;;OAMG;IACH,cAFW,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC,OAY9B;IAED;;;;OAIG;IACH,gBAFc,MAAM,EAAA,gBASnB;IAED;;;;OAIG;IACH,gBAFc,MAAM,EAAA,gBASnB;IAED;;;;;;;OAOG;IACH,mBAHc,MAAM,EAAA,gBAmBnB;IAED;;;;;;OAMG;IACH,cAEC;IAED;;;;;;;;;OASG;IACH,YAFW,SAAS,GAAC,MAAM,gBA+B1B;IAED;;;;;;;;;;;OAWG;IACH,kBALG;QAA0B,UAAU,GAA5B,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,aAAa,GAA/B,OAAO;QACW,cAAc,GAAhC,OAAO;KAA0B,QAI3C;CAwBF;mBAlSgC,UAAU;uBACpB,cAAc"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AAgaA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAQnB;wBAhaY;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG,EAAE;AAD3C;;GAEG;AAEH;IACE,uBAGC;IAED,cA+EC;IAED;;;;;;OAMG;IACH,WAFW,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC,OAsB9B;IAED;;;;;;OAMG;IACH,cAFW,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC,OAY9B;IAED;;;;OAIG;IACH,gBAFc,MAAM,EAAA,gBASnB;IAED;;;;OAIG;IACH,gBAFc,MAAM,EAAA,gBASnB;IAED;;;;;;;OAOG;IACH,mBAHc,MAAM,EAAA,gBAmBnB;IAED;;OAEG;IACH,2BAQC;IAED;;;;OAIG;IACH,oBAFa,IAAI,CAWhB;IAED;;;;;;OAMG;IACH,cAEC;IAED;;;;;;;;;OASG;IACH,YAFW,SAAS,GAAC,MAAM,gBA+B1B;IAED;;;;;;;;;;;OAWG;IACH,kBALG;QAA0B,UAAU,GAA5B,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,aAAa,GAA/B,OAAO;QACW,cAAc,GAAhC,OAAO;KAA0B,QAI3C;CAwBF;mBAhUgC,UAAU;uBACpB,cAAc"}