@bedrockio/yada 1.8.3 → 1.9.0

package/CHANGELOG.md

@@ -6,7 +6,11 @@
 
 - Fixed bug with tagging in `toOpenApi`.
 
-## 1.8.1
+## 1.9.0
+
+- Added ISO-8601 `time` format on a string.
+
+## 1.8.3
 
 - Fixed issue with incorrect JSON schema when nested.
 

package/dist/cjs/string.js

@@ -14,6 +14,8 @@ 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 LOCALE_REG = /^[a-z]{2,3}(-[A-Z][a-z]{3})?(-[A-Z]{2})?$/;
+const TIME_REG = /^(?:[0-2][0-9])(?::[0-5][0-9])?(?::[0-5][0-9])?(?:\.\d{3})?(?:Z|(?:[+-]0[0-9]|-1[0-2]|\+1[0-4]):[0-5][0-9])?$/;
 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 {
@@ -227,7 +229,9 @@ class StringSchema extends _TypeSchema.default {
   }
   locale() {
     return this.format('locale', str => {
-      if (!_validator.default.isLocale(str)) {
+      // Switch to simple regex while this bug is being fixed:
+      // https://github.com/validatorjs/validator.js/issues/2342
+      if (!LOCALE_REG.test(str)) {
         throw new _errors.LocalizedError('Must be a valid locale code.');
       }
     });
@@ -404,6 +408,17 @@ class StringSchema extends _TypeSchema.default {
       }
     });
   }
+
+  /**
+   * Validates times in ISO-8601 format.
+   */
+  time() {
+    return this.format('time', str => {
+      if (!TIME_REG.test(str)) {
+        throw new _errors.LocalizedError('Must be an ISO-8601 time.');
+      }
+    });
+  }
   format(name, fn) {
     return this.clone({
       format: name

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/yada",
-  "version": "1.8.3",
+  "version": "1.9.0",
   "description": "Validation library inspired by Joi.",
   "scripts": {
     "test": "jest",
@@ -18,7 +18,7 @@
   "license": "MIT",
   "dependencies": {
     "lodash": "^4.17.21",
-    "validator": "^13.9.0"
+    "validator": "^13.15.20"
   },
   "devDependencies": {
     "@babel/cli": "^7.20.7",

package/src/string.js

@@ -18,6 +18,9 @@ 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 LOCALE_REG = /^[a-z]{2,3}(-[A-Z][a-z]{3})?(-[A-Z]{2})?$/;
+const TIME_REG =
+  /^(?:[0-2][0-9])(?::[0-5][0-9])?(?::[0-5][0-9])?(?:\.\d{3})?(?:Z|(?:[+-]0[0-9]|-1[0-2]|\+1[0-4]):[0-5][0-9])?$/;
 
 const E164_DESCRIPTION =
   'A phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.';
@@ -238,7 +241,9 @@ class StringSchema extends TypeSchema {
 
   locale() {
     return this.format('locale', (str) => {
-      if (!validator.isLocale(str)) {
+      // Switch to simple regex while this bug is being fixed:
+      // https://github.com/validatorjs/validator.js/issues/2342
+      if (!LOCALE_REG.test(str)) {
         throw new LocalizedError('Must be a valid locale code.');
       }
     });
@@ -427,6 +432,17 @@ class StringSchema extends TypeSchema {
     });
   }
 
+  /**
+   * Validates times in ISO-8601 format.
+   */
+  time() {
+    return this.format('time', (str) => {
+      if (!TIME_REG.test(str)) {
+        throw new LocalizedError('Must be an ISO-8601 time.');
+      }
+    });
+  }
+
   format(name, fn) {
     return this.clone({ format: name }).assert(
       'format',

package/types/string.d.ts

@@ -134,6 +134,10 @@ declare class StringSchema extends TypeSchema {
      *
      */
     calendar(): this;
+    /**
+     * Validates times in ISO-8601 format.
+     */
+    time(): 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":"AAycA;;GAEG;AACH,iDAEC;AAnbD;IACE,cAmBC;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,iCAUC;CAgBF;uBArcsB,cAAc"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.js"],"names":[],"mappings":"AAydA;;GAEG;AACH,iDAEC;AAhcD;IACE,cAmBC;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,eAQC;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;;OAEG;IACH,aAMC;IAED,iCAUC;CAgBF;uBArdsB,cAAc"}