@bedrockio/yada 1.8.1 → 1.8.3

package/CHANGELOG.md

@@ -1,7 +1,15 @@
+## 1.8.2
+
+- Fixed array schemas not passing through `requireAllWithin`.
+
 ## 1.8.1
 
 - Fixed bug with tagging in `toOpenApi`.
 
+## 1.8.1
+
+- Fixed issue with incorrect JSON schema when nested.
+
 ## 1.8.0
 
 - Removed undefined `format` field.

package/README.md

@@ -905,14 +905,14 @@ integration. Any schema can describe itself in JSON Schema format including
 complex nested schemas.
 
 ```js
-yd.string().allow('foo', 'bar').toJSON();
+yd.string().allow('foo', 'bar').toJsonSchema();
 // {
 //   type: 'string',
 //   enum: ['foo', 'bar'],
 // }
 ```
 
-This also means schemas work with JSON helpers:
+This also means schemas work with JSON serializers:
 
 ```js
 const schema = yd.string().allow('foo', 'bar');
@@ -929,7 +929,7 @@ The `tag` method allows tagging custom fields:
 yd.string().tag({
   description: 'my description!',
   x-field: 'my custom field!',
-}).toJSON();
+}).toJsonSchema();
 // {
 //   type: 'string',
 //   description: 'my description!',
@@ -940,7 +940,7 @@ yd.string().tag({
 The `description` method is a shortcut:
 
 ```js
-yd.string().description('my description!').toJSON();
+yd.string().description('my description!').toJsonSchema();
 // {
 //   type: 'string',
 //   description: 'my description!',

package/dist/cjs/Schema.js

@@ -221,7 +221,7 @@ class Schema {
    * custom (code-based) assertions will not be output.
    * @param {Object} [extra]
    */
-  toJSON(extra) {
+  toJsonSchema(extra) {
     const {
       tags
     } = this.meta;
@@ -238,10 +238,17 @@ class Schema {
 
   /**
    * Exports the schema in [JSON Schema](https://json-schema.org/) format.
-   * @alias toJSON.
+   * @alias toJsonSchema.
    */
   toOpenApi(...extra) {
-    return this.toJSON(...extra);
+    return this.toJsonSchema(...extra);
+  }
+
+  /**
+   * Export JSON schema when invoked by JSON serializer.
+   */
+  toJSON() {
+    return this.toJsonSchema();
   }
   getAnyType() {
     const {
@@ -311,7 +318,7 @@ class Schema {
         const anyOf = [];
         for (let entry of allowed) {
           if (isSchema(entry)) {
-            anyOf.push(entry.toJSON());
+            anyOf.push(entry.toJsonSchema());
           } else if (entry === null) {
             anyOf.push({
               type: 'null'
@@ -375,7 +382,7 @@ class Schema {
     return rest;
   }
   inspect() {
-    return JSON.stringify(this.toJSON(), null, 2);
+    return JSON.stringify(this, null, 2);
   }
   get() {
     const {

package/dist/cjs/TypeSchema.js

@@ -22,9 +22,9 @@ class TypeSchema extends _Schema.default {
   toString() {
     return this.meta.type;
   }
-  toJSON(extra) {
+  toJsonSchema(extra) {
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       type: this.meta.type
     };
   }

package/dist/cjs/array.js

@@ -10,8 +10,9 @@ var _TypeSchema = _interopRequireDefault(require("./TypeSchema"));
 var _errors = require("./errors");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 class ArraySchema extends _TypeSchema.default {
-  constructor(schemas) {
+  constructor(schemas, meta) {
     super(Array, {
+      ...meta,
       schemas
     });
     this.setup();
@@ -106,12 +107,29 @@ class ArraySchema extends _TypeSchema.default {
     });
   }
 
+  /**
+   * Augments the array schema to make all nested fields required.
+   * @returns {this}
+   */
+  requireAllWithin() {
+    const {
+      schemas,
+      ...rest
+    } = this.meta;
+    const newSchemas = schemas.map(schema => {
+      return schema.requireAllWithin();
+    });
+
+    // @ts-ignore
+    return new ArraySchema(newSchemas, rest).required();
+  }
+
   // Private
 
   toString() {
     return 'array';
   }
-  toJSON(extra) {
+  toJsonSchema(extra) {
     let other;
     const {
       schemas
@@ -119,16 +137,16 @@ class ArraySchema extends _TypeSchema.default {
     if (schemas.length > 1) {
       other = {
         anyOf: schemas.map(schema => {
-          return schema.toJSON();
+          return schema.toJsonSchema();
         })
       };
     } else if (schemas.length === 1) {
       other = {
-        items: schemas[0].toJSON()
+        items: schemas[0].toJsonSchema()
       };
     }
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       ...other,
       type: 'array'
     };

package/dist/cjs/date.js

@@ -142,12 +142,12 @@ class DateSchema extends _Schema.default {
   toString() {
     return 'date';
   }
-  toJSON(extra) {
+  toJsonSchema(extra) {
     const {
       format
     } = this.meta;
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       type: format.includes('timestamp') ? 'number' : 'string'
     };
   }

package/dist/cjs/number.js

@@ -79,14 +79,14 @@ class NumberSchema extends _TypeSchema.default {
 
   // Private
 
-  toJSON(extra) {
+  toJsonSchema(extra) {
     const {
       min,
       max,
       multiple
     } = this.meta;
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       ...(min != null && {
         minimum: min
       }),

package/dist/cjs/object.js

@@ -300,20 +300,20 @@ class ObjectSchema extends _TypeSchema.default {
 
   // Private
 
-  toJSON(extra) {
+  toJsonSchema(extra) {
     const {
       stripUnknown = false
     } = this.meta;
     const required = [];
     const properties = {};
     for (let [key, schema] of Object.entries(this.export())) {
-      properties[key] = schema.toJSON(extra);
+      properties[key] = schema.toJsonSchema(extra);
       if (schema.meta.required) {
         required.push(key);
       }
     }
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       ...(Object.keys(properties).length > 0 && {
         properties,
         required,

package/dist/cjs/string.js

@@ -417,13 +417,13 @@ class StringSchema extends _TypeSchema.default {
 
   // Private
 
-  toJSON(extra) {
+  toJsonSchema(extra) {
     const {
       min,
       max
     } = this.meta;
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       ...(min && {
         minLength: min
       }),

package/dist/cjs/tuple.js

@@ -79,15 +79,15 @@ class TupleSchema extends _Schema.default {
   toString() {
     return 'tuple';
   }
-  toJSON(extra) {
+  toJsonSchema(extra) {
     const {
       schemas
     } = this.meta;
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       type: 'array',
       prefixItems: schemas.map(schema => {
-        return schema.toJSON();
+        return schema.toJsonSchema();
       })
     };
   }

package/package.json

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

package/src/Schema.js

@@ -214,7 +214,7 @@ export default class Schema {
    * custom (code-based) assertions will not be output.
    * @param {Object} [extra]
    */
-  toJSON(extra) {
+  toJsonSchema(extra) {
     const { tags } = this.meta;
     return {
       ...tags,
@@ -229,10 +229,17 @@ export default class Schema {
 
   /**
    * Exports the schema in [JSON Schema](https://json-schema.org/) format.
-   * @alias toJSON.
+   * @alias toJsonSchema.
    */
   toOpenApi(...extra) {
-    return this.toJSON(...extra);
+    return this.toJsonSchema(...extra);
+  }
+
+  /**
+   * Export JSON schema when invoked by JSON serializer.
+   */
+  toJSON() {
+    return this.toJsonSchema();
   }
 
   getAnyType() {
@@ -294,7 +301,7 @@ export default class Schema {
         const anyOf = [];
         for (let entry of allowed) {
           if (isSchema(entry)) {
-            anyOf.push(entry.toJSON());
+            anyOf.push(entry.toJsonSchema());
           } else if (entry === null) {
             anyOf.push({
               type: 'null',
@@ -351,7 +358,7 @@ export default class Schema {
   }
 
   inspect() {
-    return JSON.stringify(this.toJSON(), null, 2);
+    return JSON.stringify(this, null, 2);
   }
 
   get() {

package/src/TypeSchema.js

@@ -14,9 +14,9 @@ export default class TypeSchema extends Schema {
     return this.meta.type;
   }
 
-  toJSON(extra) {
+  toJsonSchema(extra) {
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       type: this.meta.type,
     };
   }

package/src/array.js

@@ -5,8 +5,8 @@ import TypeSchema from './TypeSchema';
 import { ArrayError, ElementError, LocalizedError } from './errors';
 
 class ArraySchema extends TypeSchema {
-  constructor(schemas) {
-    super(Array, { schemas });
+  constructor(schemas, meta) {
+    super(Array, { ...meta, schemas });
     this.setup();
   }
 
@@ -104,29 +104,44 @@ class ArraySchema extends TypeSchema {
     });
   }
 
+  /**
+   * Augments the array schema to make all nested fields required.
+   * @returns {this}
+   */
+  requireAllWithin() {
+    const { schemas, ...rest } = this.meta;
+
+    const newSchemas = schemas.map((schema) => {
+      return schema.requireAllWithin();
+    });
+
+    // @ts-ignore
+    return new ArraySchema(newSchemas, rest).required();
+  }
+
   // Private
 
   toString() {
     return 'array';
   }
 
-  toJSON(extra) {
+  toJsonSchema(extra) {
     let other;
     const { schemas } = this.meta;
     if (schemas.length > 1) {
       other = {
         anyOf: schemas.map((schema) => {
-          return schema.toJSON();
+          return schema.toJsonSchema();
         }),
       };
     } else if (schemas.length === 1) {
       other = {
-        items: schemas[0].toJSON(),
+        items: schemas[0].toJsonSchema(),
       };
     }
 
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       ...other,
       type: 'array',
     };

package/src/date.js

@@ -138,10 +138,10 @@ class DateSchema extends Schema {
     return 'date';
   }
 
-  toJSON(extra) {
+  toJsonSchema(extra) {
     const { format } = this.meta;
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       type: format.includes('timestamp') ? 'number' : 'string',
     };
   }

package/src/number.js

@@ -71,10 +71,10 @@ class NumberSchema extends TypeSchema {
 
   // Private
 
-  toJSON(extra) {
+  toJsonSchema(extra) {
     const { min, max, multiple } = this.meta;
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       ...(min != null && {
         minimum: min,
       }),

package/src/object.js

@@ -300,19 +300,19 @@ class ObjectSchema extends TypeSchema {
 
   // Private
 
-  toJSON(extra) {
+  toJsonSchema(extra) {
     const { stripUnknown = false } = this.meta;
 
     const required = [];
     const properties = {};
     for (let [key, schema] of Object.entries(this.export())) {
-      properties[key] = schema.toJSON(extra);
+      properties[key] = schema.toJsonSchema(extra);
       if (schema.meta.required) {
         required.push(key);
       }
     }
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       ...(Object.keys(properties).length > 0 && {
         properties,
         required,

package/src/string.js

@@ -441,10 +441,10 @@ class StringSchema extends TypeSchema {
 
   // Private
 
-  toJSON(extra) {
+  toJsonSchema(extra) {
     const { min, max } = this.meta;
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       ...(min && {
         minLength: min,
       }),

package/src/tuple.js

@@ -69,13 +69,13 @@ class TupleSchema extends Schema {
     return 'tuple';
   }
 
-  toJSON(extra) {
+  toJsonSchema(extra) {
     const { schemas } = this.meta;
     return {
-      ...super.toJSON(extra),
+      ...super.toJsonSchema(extra),
       type: 'array',
       prefixItems: schemas.map((schema) => {
-        return schema.toJSON();
+        return schema.toJsonSchema();
       }),
     };
   }

package/types/Schema.d.ts

@@ -77,12 +77,16 @@ export default class Schema {
      * custom (code-based) assertions will not be output.
      * @param {Object} [extra]
      */
-    toJSON(extra?: any): any;
+    toJsonSchema(extra?: any): any;
     /**
      * Exports the schema in [JSON Schema](https://json-schema.org/) format.
-     * @alias toJSON.
+     * @alias toJsonSchema.
      */
     toOpenApi(...extra: any[]): any;
+    /**
+     * Export JSON schema when invoked by JSON serializer.
+     */
+    toJSON(): any;
     getAnyType(): {
         type: string[];
     };

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;;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"}
+{"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,+BAWC;IAED;;;OAGG;IACH,gCAEC;IAED;;OAEG;IACH,cAEC;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/array.d.ts

@@ -9,12 +9,16 @@
 export default function _default(...schemas?: Schema[]): ArraySchema;
 import Schema from './Schema';
 declare class ArraySchema extends TypeSchema {
-    constructor(schemas: any);
     setup(): void;
     length(length: any): this;
     min(length: any): this;
     max(length: any): this;
     latlng(): this;
+    /**
+     * Augments the array schema to make all nested fields required.
+     * @returns {this}
+     */
+    requireAllWithin(): this;
     toString(): string;
 }
 import TypeSchema from './TypeSchema';

package/types/array.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../src/array.js"],"names":[],"mappings":"AAuIA;;;;;;;GAOG;AACH,8CALc,MAAM,EAAA,eAUnB;mBAlJkB,UAAU;AAI7B;IACE,0BAGC;IAED,cAsCC;IAED,0BAUC;IAED,uBAUC;IAED,uBAaC;IAED,eAaC;IAID,mBAEC;CAuBF;uBAlIsB,cAAc"}
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../src/array.js"],"names":[],"mappings":"AAsJA;;;;;;;GAOG;AACH,8CALc,MAAM,EAAA,eAUnB;mBAjKkB,UAAU;AAI7B;IAME,cAsCC;IAED,0BAUC;IAED,uBAUC;IAED,uBAaC;IAED,eAaC;IAED;;;OAGG;IACH,oBAFa,IAAI,CAWhB;IAID,mBAEC;CAuBF;uBAjJsB,cAAc"}