@bedrockio/yada 1.4.3 → 1.5.1

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.5.1
+
+- Require more strict adherence to JSON Schema.
+
+## 1.5.0
+
+- Calendar date validator moved to string as it cannot work when coerced to a
+  date object.
+
 ## 1.4.3
 
 - Fixed date not allowing calendar date format without time.

package/dist/cjs/date.js

@@ -95,17 +95,10 @@ class DateSchema extends _Schema.default {
       }
     });
   }
-
-  /**
-   * @param {"date" | "date-time"} format
-   */
-  iso(format = 'date-time') {
-    if (format !== 'date' && format !== 'date-time') {
-      throw new Error(`Invalid format ${JSON.stringify(format)}.`);
-    }
+  iso() {
     return this.clone({
-      format
-    }).assert('format', (val, options) => {
+      format: 'date-time'
+    }).assert('format', (date, options) => {
       const {
         original
       } = options;
@@ -113,9 +106,7 @@ class DateSchema extends _Schema.default {
         if (!options.default) {
           throw new _errors.LocalizedError('Must be a string.');
         }
-      } else if (format === 'date' && !_validator.default.isDate(original)) {
-        throw new _errors.LocalizedError('Must be an ISO-8601 calendar date.');
-      } else if (format === 'date-time' && !_validator.default.isISO8601(original)) {
+      } else if (!_validator.default.isISO8601(original)) {
         throw new _errors.LocalizedError('Must be in ISO-8601 format.');
       }
     });

package/dist/cjs/object.js

@@ -213,9 +213,9 @@ class ObjectSchema extends _TypeSchema.default {
   /**
    * Returns the schema's fields as an object allowing them
    * to be "spread" to create new schemas. Note that doing
-   * this will mean that custom and required assertions will
-   * not be preserved. Compare to {@link append} which
-   * preserves all assertions on the base schema.
+   * this will mean that custom and required assertions on
+   * the object itself will not be preserved. Compare to
+   * {@link append} which preserves all assertions.
    */
   export() {
     return this.meta.fields || {};
@@ -262,14 +262,23 @@ class ObjectSchema extends _TypeSchema.default {
   // Private
 
   toOpenApi(extra) {
+    const {
+      stripUnknown = false
+    } = this.meta;
+    const required = [];
     const properties = {};
     for (let [key, schema] of Object.entries(this.export())) {
       properties[key] = schema.toOpenApi(extra);
+      if (schema.meta.required) {
+        required.push(key);
+      }
     }
     return {
       ...super.toOpenApi(extra),
       ...(Object.keys(properties).length > 0 && {
-        properties
+        properties,
+        required,
+        additionalProperties: stripUnknown
       })
     };
   }

package/dist/cjs/string.js

@@ -12,6 +12,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 const SLUG_REG = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
 const PHONE_REG = /^\+\d{1,3}\d{3,14}$/;
 const NANP_REG = /^\+1[2-9]\d{2}[2-9]\d{6}$/;
+const DATE_REG = /^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[01])$/;
 const E164_DESCRIPTION = 'A phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.';
 const NANP_DESCRIPTION = 'A phone number in [NANP](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) format.';
 class StringSchema extends _TypeSchema.default {
@@ -386,6 +387,26 @@ class StringSchema extends _TypeSchema.default {
       }
     });
   }
+
+  /**
+   * Validates a calendar date in extended ISO-8601 format:
+   *
+   * 1. Must exactly match `YYYY-MM-DD`.
+   * 2. Year may not be negative.
+   * 3. Month must be 1-12.
+   * 4. Date must be 1-31.
+   *
+   * Note that only individual components are validated so impossible
+   * dates like "2020-02-30" are still considered valid.
+   *
+   */
+  calendar() {
+    return this.format('date', str => {
+      if (!DATE_REG.test(str)) {
+        throw new _errors.LocalizedError('Must be an ISO-8601 calendar date.');
+      }
+    });
+  }
   format(name, fn) {
     return this.clone({
       format: name

package/package.json

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

package/src/date.js

@@ -90,25 +90,20 @@ class DateSchema extends Schema {
     });
   }
 
-  /**
-   * @param {"date" | "date-time"} format
-   */
-  iso(format = 'date-time') {
-    if (format !== 'date' && format !== 'date-time') {
-      throw new Error(`Invalid format ${JSON.stringify(format)}.`);
-    }
-    return this.clone({ format }).assert('format', (val, options) => {
-      const { original } = options;
-      if (typeof original !== 'string') {
-        if (!options.default) {
-          throw new LocalizedError('Must be a string.');
+  iso() {
+    return this.clone({ format: 'date-time' }).assert(
+      'format',
+      (date, options) => {
+        const { original } = options;
+        if (typeof original !== 'string') {
+          if (!options.default) {
+            throw new LocalizedError('Must be a string.');
+          }
+        } else if (!validator.isISO8601(original)) {
+          throw new LocalizedError('Must be in ISO-8601 format.');
         }
-      } else if (format === 'date' && !validator.isDate(original)) {
-        throw new LocalizedError('Must be an ISO-8601 calendar date.');
-      } else if (format === 'date-time' && !validator.isISO8601(original)) {
-        throw new LocalizedError('Must be in ISO-8601 format.');
-      }
-    });
+      },
+    );
   }
 
   timestamp() {

package/src/object.js

@@ -200,9 +200,9 @@ class ObjectSchema extends TypeSchema {
   /**
    * Returns the schema's fields as an object allowing them
    * to be "spread" to create new schemas. Note that doing
-   * this will mean that custom and required assertions will
-   * not be preserved. Compare to {@link append} which
-   * preserves all assertions on the base schema.
+   * this will mean that custom and required assertions on
+   * the object itself will not be preserved. Compare to
+   * {@link append} which preserves all assertions.
    */
   export() {
     return this.meta.fields || {};
@@ -252,14 +252,22 @@ class ObjectSchema extends TypeSchema {
   // Private
 
   toOpenApi(extra) {
+    const { stripUnknown = false } = this.meta;
+
+    const required = [];
     const properties = {};
     for (let [key, schema] of Object.entries(this.export())) {
       properties[key] = schema.toOpenApi(extra);
+      if (schema.meta.required) {
+        required.push(key);
+      }
     }
     return {
       ...super.toOpenApi(extra),
       ...(Object.keys(properties).length > 0 && {
         properties,
+        required,
+        additionalProperties: stripUnknown,
       }),
     };
   }

package/src/string.js

@@ -14,6 +14,7 @@ import {
 const SLUG_REG = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
 const PHONE_REG = /^\+\d{1,3}\d{3,14}$/;
 const NANP_REG = /^\+1[2-9]\d{2}[2-9]\d{6}$/;
+const DATE_REG = /^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[01])$/;
 
 const E164_DESCRIPTION =
   'A phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.';
@@ -404,6 +405,26 @@ class StringSchema extends TypeSchema {
     });
   }
 
+  /**
+   * Validates a calendar date in extended ISO-8601 format:
+   *
+   * 1. Must exactly match `YYYY-MM-DD`.
+   * 2. Year may not be negative.
+   * 3. Month must be 1-12.
+   * 4. Date must be 1-31.
+   *
+   * Note that only individual components are validated so impossible
+   * dates like "2020-02-30" are still considered valid.
+   *
+   */
+  calendar() {
+    return this.format('date', (str) => {
+      if (!DATE_REG.test(str)) {
+        throw new LocalizedError('Must be an ISO-8601 calendar date.');
+      }
+    });
+  }
+
   format(name, fn) {
     return this.clone({ format: name }).assert(
       'format',

package/types/date.d.ts

@@ -22,10 +22,7 @@ declare class DateSchema extends Schema {
     after(min: string | number | Date): this;
     past(): this;
     future(): this;
-    /**
-     * @param {"date" | "date-time"} format
-     */
-    iso(format?: "date" | "date-time"): this;
+    iso(): this;
     timestamp(): this;
     unix(): this;
 }

package/types/date.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../src/date.js"],"names":[],"mappings":"AAqKA;;GAEG;AACH,+CAEC;AArKD;IACE,cAUC;IAED;;OAEG;IACH,SAFW,MAAM,GAAC,MAAM,GAAC,IAAI,QAW5B;IAED;;OAEG;IACH,SAFW,MAAM,GAAC,MAAM,GAAC,IAAI,QAW5B;IAED;;OAEG;IACH,YAFW,MAAM,GAAC,MAAM,GAAC,IAAI,QAW5B;IAED;;OAEG;IACH,WAFW,MAAM,GAAC,MAAM,GAAC,IAAI,QAW5B;IAED,aAOC;IAED,eAOC;IAED;;OAEG;IACH,aAFW,MAAM,GAAG,WAAW,QAkB9B;IAED,kBAUC;IAED,aAcC;CAwBF;mBAjKkB,UAAU"}
+{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../src/date.js"],"names":[],"mappings":"AAgKA;;GAEG;AACH,+CAEC;AAhKD;IACE,cAUC;IAED;;OAEG;IACH,SAFW,MAAM,GAAC,MAAM,GAAC,IAAI,QAW5B;IAED;;OAEG;IACH,SAFW,MAAM,GAAC,MAAM,GAAC,IAAI,QAW5B;IAED;;OAEG;IACH,YAFW,MAAM,GAAC,MAAM,GAAC,IAAI,QAW5B;IAED;;OAEG;IACH,WAFW,MAAM,GAAC,MAAM,GAAC,IAAI,QAW5B;IAED,aAOC;IAED,eAOC;IAED,YAcC;IAED,kBAUC;IAED,aAcC;CAwBF;mBA5JkB,UAAU"}

package/types/object.d.ts

@@ -55,9 +55,9 @@ declare class ObjectSchema extends TypeSchema {
     /**
      * Returns the schema's fields as an object allowing them
      * to be "spread" to create new schemas. Note that doing
-     * this will mean that custom and required assertions will
-     * not be preserved. Compare to {@link append} which
-     * preserves all assertions on the base schema.
+     * this will mean that custom and required assertions on
+     * the object itself will not be preserved. Compare to
+     * {@link append} which preserves all assertions.
      */
     export(): any;
     /**

package/types/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AAmTA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAQnB;wBArTY;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,gBAkBnB;IAED;;;;;;OAMG;IACH,cAEC;IAED;;;;;;;;;OASG;IACH,YAFW,SAAS,GAAC,MAAM,gBA+B1B;CAgBF;mBArQgC,UAAU;uBAFpB,cAAc"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AA2TA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAQnB;wBA7TY;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,gBAkBnB;IAED;;;;;;OAMG;IACH,cAEC;IAED;;;;;;;;;OASG;IACH,YAFW,SAAS,GAAC,MAAM,gBA+B1B;CAwBF;mBA7QgC,UAAU;uBAFpB,cAAc"}

package/types/string.d.ts

@@ -121,6 +121,19 @@ declare class StringSchema extends TypeSchema {
     eth(): this;
     swift(): this;
     mongo(): this;
+    /**
+     * Validates a calendar date in extended ISO-8601 format:
+     *
+     * 1. Must exactly match `YYYY-MM-DD`.
+     * 2. Year may not be negative.
+     * 3. Month must be 1-12.
+     * 4. Date must be 1-31.
+     *
+     * Note that only individual components are validated so impossible
+     * dates like "2020-02-30" are still considered valid.
+     *
+     */
+    calendar(): this;
     format(name: any, fn: any): this;
 }
 import TypeSchema from './TypeSchema';

package/types/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.js"],"names":[],"mappings":"AAmbA;;GAEG;AACH,iDAEC;AAjaD;IACE,cAoBC;IAED;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;OAEG;IACH,eAFW,MAAM,QAUhB;IAED;;OAEG;IACH,YAFW,MAAM,QAUhB;IAED;;OAEG;IACH,YAFW,MAAM,QAUhB;IAED,aAIC;IAED;;OAEG;IACH,mBAFW,OAAO,QAYjB;IAED;;OAEG;IACH,mBAFW,OAAO,QAYjB;IAED;;OAEG;IACH,WAFW,MAAM,QAahB;IAED,cAMC;IAED,uBASC;IAED,YAMC;IAED,YAMC;IAED,aAMC;IAED,cAMC;IAED;;;OAGG;IACH,iBAFG;QAA0B,OAAO,GAAzB,OAAO;KAAmB,QAQpC;IAED,mBAMC;IAED,WAMC;IAED,gBAMC;IAED,eAMC;IAED,YAMC;IAED,aAOC;IAED,eAMC;IAED;;OAEG;IACH,oBAFW,MAAM,QAQhB;IAED,gBAMC;IAED;;;;;;;OAOG;IACH,mBANG;QAAyB,SAAS,GAA1B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,YAAY,GAA7B,MAAM;QACW,YAAY,GAA7B,MAAM;KAAwB,QA+BxC;IAED;;;;;;;;;;;OAWG;IACH,cAVG;QAA0B,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;KAAqB,QAQvC;IAED;;;;;;;;OAQG;IACH,iBAPG;QAA0B,WAAW,GAA7B,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,kBAAkB,GAApC,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,cAAc,GAAhC,OAAO;QACW,iBAAiB,GAAnC,OAAO;KAAmC,QAQpD;IAED;;OAEG;IACH,eAFW,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,QAQ3B;IAED,YAMC;IAED,YAMC;IAED,cAMC;IAED,cAMC;IAED,iCAWC;CAgBF;uBA/asB,cAAc"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.js"],"names":[],"mappings":"AAwcA;;GAEG;AACH,iDAEC;AArbD;IACE,cAoBC;IAED;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;OAEG;IACH,eAFW,MAAM,QAUhB;IAED;;OAEG;IACH,YAFW,MAAM,QAUhB;IAED;;OAEG;IACH,YAFW,MAAM,QAUhB;IAED,aAIC;IAED;;OAEG;IACH,mBAFW,OAAO,QAYjB;IAED;;OAEG;IACH,mBAFW,OAAO,QAYjB;IAED;;OAEG;IACH,WAFW,MAAM,QAahB;IAED,cAMC;IAED,uBASC;IAED,YAMC;IAED,YAMC;IAED,aAMC;IAED,cAMC;IAED;;;OAGG;IACH,iBAFG;QAA0B,OAAO,GAAzB,OAAO;KAAmB,QAQpC;IAED,mBAMC;IAED,WAMC;IAED,gBAMC;IAED,eAMC;IAED,YAMC;IAED,aAOC;IAED,eAMC;IAED;;OAEG;IACH,oBAFW,MAAM,QAQhB;IAED,gBAMC;IAED;;;;;;;OAOG;IACH,mBANG;QAAyB,SAAS,GAA1B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,YAAY,GAA7B,MAAM;QACW,YAAY,GAA7B,MAAM;KAAwB,QA+BxC;IAED;;;;;;;;;;;OAWG;IACH,cAVG;QAA0B,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;KAAqB,QAQvC;IAED;;;;;;;;OAQG;IACH,iBAPG;QAA0B,WAAW,GAA7B,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,kBAAkB,GAApC,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,cAAc,GAAhC,OAAO;QACW,iBAAiB,GAAnC,OAAO;KAAmC,QAQpD;IAED;;OAEG;IACH,eAFW,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,QAQ3B;IAED,YAMC;IAED,YAMC;IAED,cAMC;IAED,cAMC;IAED;;;;;;;;;;;OAWG;IACH,iBAMC;IAED,iCAWC;CAgBF;uBApcsB,cAAc"}