@wmfs/json-to-vuelidate 1.24.0 → 1.26.0

package/CHANGELOG.md

@@ -1,3 +1,38 @@
+# [1.26.0](https://github.com/wmfs/json-to-vuelidate/compare/v1.25.0...v1.26.0) (2022-07-06)
+
+
+### 🛠 Builds
+
+* **deps:** update dependency [@vuelidate](https://github.com/vuelidate)/validators to v2.0.0-alpha.30 ([f73d52d](https://github.com/wmfs/json-to-vuelidate/commit/f73d52d907825c2311437c1d865b36a836d2a9a0))
+* **deps:** update dependency vue to v3.2.37 ([00584fa](https://github.com/wmfs/json-to-vuelidate/commit/00584fa5583f799c022577cc18ef0f01b36a7b84))
+
+# [1.25.0](https://github.com/wmfs/json-to-vuelidate/compare/v1.24.1...v1.25.0) (2022-06-16)
+
+
+### 🛠 Builds
+
+* **deps:** change [@vue](https://github.com/vue)/composition-api to vue ([65984c7](https://github.com/wmfs/json-to-vuelidate/commit/65984c7b05d176f6702a4da55700de46a019688e))
+
+## [1.24.1](https://github.com/wmfs/json-to-vuelidate/compare/v1.24.0...v1.24.1) (2022-06-16)
+
+
+### 🐛 Bug Fixes
+
+* convert instance from Proxy object to regular object for parsing template ([23607c4](https://github.com/wmfs/json-to-vuelidate/commit/23607c4c5447681dc2134f59e829494a47d9b727))
+* ensure all validators are same format using the vuelidate helper function ([8e680e0](https://github.com/wmfs/json-to-vuelidate/commit/8e680e078c670216d8dc15a576863f80027afac7))
+* use latest vuelidate validators for Vue 3 ([c9e86b4](https://github.com/wmfs/json-to-vuelidate/commit/c9e86b40fd2800310cf1ca89c8540261f3be00c6))
+
+
+### 🛠 Builds
+
+* **deps-dev:** update dependency chai to v4.3.5 ([6fc9656](https://github.com/wmfs/json-to-vuelidate/commit/6fc9656888e1bbb59743b3acea5024fd2ed4011a))
+* **deps-dev:** update dependency chai to v4.3.6 ([cd80d93](https://github.com/wmfs/json-to-vuelidate/commit/cd80d9350c434b13b6bebd6bee792790914e4aad))
+* **deps-dev:** update dependency mocha to v10 ([a2e7b1a](https://github.com/wmfs/json-to-vuelidate/commit/a2e7b1a579ecbecd943e6eaacd558b507530a180))
+* **deps-dev:** update dependency mocha to v9.2.1 ([0439260](https://github.com/wmfs/json-to-vuelidate/commit/04392606932397356737bf8d2e3f6468de9d21c9))
+* **deps-dev:** update dependency mocha to v9.2.2 ([8be430b](https://github.com/wmfs/json-to-vuelidate/commit/8be430b62495df2e140d77247ffbef762de1d661))
+* **deps-dev:** update dependency semantic-release to v19.0.3 ([255ed3b](https://github.com/wmfs/json-to-vuelidate/commit/255ed3b9263e2d39173831f9ee80d8c7288ab3ba))
+* **deps-dev:** update dependency standard to v17 ([d962379](https://github.com/wmfs/json-to-vuelidate/commit/d9623792a31c905aaab5bc3f2a4c3285340dbb50))
+
 # [1.24.0](https://github.com/wmfs/json-to-vuelidate/compare/v1.23.0...v1.24.0) (2022-01-25)
 
 

package/lib/index.js

@@ -1,9 +1,11 @@
-const validators = require('vuelidate/lib/validators')
+// const validators = require('vuelidate/lib/validators')
+const validators = require('@vuelidate/validators')
 const template = require('lodash.template')
 const phoneUtil = require('google-libphonenumber').PhoneNumberUtil.getInstance()
 const moment = require('moment')
 const isNotDefined = value => value === undefined || value === null || value === ''
-const parseTemplate = (_template, data) => template(_template)(data)
+const cloneJson = obj => JSON.parse(JSON.stringify(obj))
+const parseTemplate = (_template, instance) => template(_template)(instance)
 
 module.exports = function (json) {
   const result = {}
@@ -39,46 +41,55 @@ function parse (val, key) {
         if (attributeValue) result.email = validators.email
         break
       case 'regex':
-        result.regex = value => {
-          // validators.helpers.regex
-          if (value !== null && value !== undefined) {
-            const regex = new RegExp(attributeValue)
-            return regex.test(value)
-          } else {
-            return true
+        result.regex = validators.helpers.withParams(
+          { type: 'regex' },
+          function (value) {
+            // validators.helpers.regex
+            if (value !== null && value !== undefined) {
+              const regex = new RegExp(attributeValue)
+              return regex.test(value)
+            } else {
+              return true
+            }
           }
-        }
+        )
         break
       case 'postcode':
         if (attributeValue) {
-          result.postcode = value => {
-            if (value && value.trim().length > 0) {
-              const v = value.replace(/\s/g, '')
-              const regex = /^[A-Z]{1,2}[0-9]{1,2} ?[0-9][A-Z]{2}$/i
-              // const regex = /^([A-Z]){1}([0-9][0-9]|[0-9]|[A-Z][0-9][A-Z]|[A-Z][0-9][0-9]|[A-Z][0-9]|[0-9][A-Z]){1}([ ])?([0-9][A-z][A-z]){1}$/i
-              return regex.test(v)
-            } else {
-              return true
+          result.postcode = validators.helpers.withParams(
+            { type: 'postcode' },
+            function (value) {
+              if (value && value.trim().length > 0) {
+                const v = value.replace(/\s/g, '')
+                const regex = /^[A-Z]{1,2}[0-9]{1,2} ?[0-9][A-Z]{2}$/i
+                // const regex = /^([A-Z]){1}([0-9][0-9]|[0-9]|[A-Z][0-9][A-Z]|[A-Z][0-9][0-9]|[A-Z][0-9]|[0-9][A-Z]){1}([ ])?([0-9][A-z][A-z]){1}$/i
+                return regex.test(v)
+              } else {
+                return true
+              }
             }
-          }
+          )
         }
         break
       case 'telephoneNumber':
         if (attributeValue) {
-          result.telephoneNumber = value => {
-            // todo: differ between landline and mobile?
-            if (value && value.trim().length > 0) {
-              try {
-                const parsed = phoneUtil.parse(value, 'GB') // todo: define country code in cardscript?
-                return phoneUtil.isValidNumber(parsed)
-              } catch (err) {
-                console.warn(`Failed to parse telephone number on element '${key}'. Error: ${err}`)
-                return false
+          result.telephoneNumber = validators.helpers.withParams(
+            { type: 'telephoneNumber' },
+            function (value) {
+              // todo: differ between landline and mobile?
+              if (value && value.trim().length > 0) {
+                try {
+                  const parsed = phoneUtil.parse(value, 'GB') // todo: define country code in cardscript?
+                  return phoneUtil.isValidNumber(parsed)
+                } catch (err) {
+                  console.warn(`Failed to parse telephone number on element '${key}'. Error: ${err}`)
+                  return false
+                }
+              } else {
+                return true
               }
-            } else {
-              return true
             }
-          }
+          )
         }
         break
       case 'required':
@@ -86,7 +97,7 @@ function parse (val, key) {
         break
       case 'requiredIf':
         result.requiredIf = validators.requiredIf(function () {
-          const result = parseTemplate('${' + attributeValue + '}', this)
+          const result = parseTemplate('${' + attributeValue + '}', cloneJson({ data: this.data }))
           return result === 'true'
         })
         break
@@ -97,42 +108,52 @@ function parse (val, key) {
         result.maxValue = validators.maxValue(attributeValue)
         break
       case 'maximum.$':
-        result.maximum = function (value) {
-          if (isNotDefined(value)) return true
-
-          const result = parseTemplate('${' + attributeValue + '}', this)
+        result.minimumDate = validators.helpers.withParams(
+          { type: 'minimumDate' },
+          function (value) {
+            if (isNotDefined(value)) return true
+            const result = parseTemplate('${' + attributeValue + '}', cloneJson({ data: this.data }))
+            return value <= +result
+          }
+        )
 
-          return value <= +result
-        }
         break
       case 'minimumDate': {
-        result.minimumDate = function (value) {
-          if (isNotDefined(value)) return true
+        result.minimumDate = validators.helpers.withParams(
+          { type: 'minimumDate' },
+          function (value) {
+            if (isNotDefined(value)) return true
+
+            const mValue = moment(value)
+            const mMin = moment(attributeValue)
 
-          const mValue = moment(value)
-          const mMin = moment(attributeValue)
+            if (!mValue || !mValue.isValid() || !mMin || !mMin.isValid()) {
+              return false
+            }
 
-          if (!mValue || !mValue.isValid() || !mMin || !mMin.isValid()) {
-            return false
+            return mMin.isBefore(mValue, 'day') || mMin.isSame(mValue, 'day')
           }
+        )
 
-          return mMin.isBefore(mValue, 'day') || mMin.isSame(mValue, 'day')
-        }
         break
       }
       case 'maximumDate': {
-        result.maximumDate = function (value) {
-          if (isNotDefined(value)) return true
+        result.maximumDate = validators.helpers.withParams(
+          { type: 'maximumDate' },
+          function (value) {
+            if (isNotDefined(value)) return true
 
-          const mValue = moment(value)
-          const mMax = moment(attributeValue)
+            const mValue = moment(value)
+            const mMax = moment(attributeValue)
 
-          if (!mValue || !mValue.isValid() || !mMax || !mMax.isValid()) {
-            return false
+            if (!mValue || !mValue.isValid() || !mMax || !mMax.isValid()) {
+              return false
+            }
+
+            return mValue.isBefore(mMax, 'day') || mValue.isSame(mMax, 'day')
           }
+        )
 
-          return mValue.isBefore(mMax, 'day') || mValue.isSame(mMax, 'day')
-        }
         break
       }
       case 'minLength':

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@wmfs/json-to-vuelidate",
   "description": "Takes in a JSON object and products an object of vuelidate expressions.",
-  "version": "1.24.0",
+  "version": "1.26.0",
   "author": "West Midlands Fire Service",
   "keywords": [
     "tymly",
@@ -9,24 +9,25 @@
   ],
   "main": "./lib/index.js",
   "dependencies": {
-    "vuelidate": "0.7.7",
-    "lodash.template": "4.5.0",
+    "vue": "3.2.37",
+    "@vuelidate/validators": "2.0.0-alpha.30",
     "google-libphonenumber": "3.2.26",
+    "lodash.template": "4.5.0",
     "moment": "2.29.1"
   },
   "devDependencies": {
-    "babel-register": "6.26.0",
+    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/git": "10.0.1",
     "babel-preset-env": "1.7.0",
-    "chai": "4.3.4",
+    "babel-register": "6.26.0",
+    "chai": "4.3.6",
     "codecov": "3.8.3",
     "conventional-changelog-metahub": "4.0.1",
     "cz-conventional-changelog": "3.3.0",
-    "mocha": "9.2.0",
+    "mocha": "10.0.0",
     "nyc": "15.1.0",
-    "semantic-release": "19.0.2",
-    "standard": "16.0.4",
-    "@semantic-release/changelog": "6.0.1",
-    "@semantic-release/git": "10.0.1"
+    "semantic-release": "19.0.3",
+    "standard": "17.0.0"
   },
   "scripts": {
     "lint": "standard",

package/test/test.js

@@ -4,7 +4,7 @@ const converter = require('./../lib/')
 const expect = require('chai').expect
 const moment = require('moment')
 
-const JSON = {
+const input = {
   numberBetween5And10: {
     between: [5, 10]
   },
@@ -43,6 +43,9 @@ const JSON = {
   },
   min3DaysAgo: {
     minimumDate: moment().subtract(3, 'days').format('YYYY/MM/DD')
+  },
+  telNum: {
+    telephoneNumber: true
   }
 }
 
@@ -50,30 +53,34 @@ describe('Test the vuelidate converter', function () {
   let vuelidate
 
   it('Convert some JSON', () => {
-    vuelidate = converter(JSON)
+    vuelidate = converter(input)
+
+    console.log('------')
+    console.log(JSON.stringify(vuelidate, null, 2))
+    console.log('------')
 
-    console.log('\n------\n', vuelidate)
-    expect(vuelidate.numberBetween5And10.between).to.be.a('function')
+    expect(vuelidate.numberBetween5And10.between.$validator).to.be.a('function')
 
-    expect(vuelidate.numberMin10Max50.minValue).to.be.a('function')
-    expect(vuelidate.numberMin10Max50.maxValue).to.be.a('function')
+    expect(vuelidate.numberMin10Max50.minValue.$validator).to.be.a('function')
+    expect(vuelidate.numberMin10Max50.maxValue.$validator).to.be.a('function')
 
-    expect(vuelidate.textMinLen5MaxLen50.minLength).to.be.a('function')
-    expect(vuelidate.textMinLen5MaxLen50.maxLength).to.be.a('function')
+    expect(vuelidate.textMinLen5MaxLen50.minLength.$validator).to.be.a('function')
+    expect(vuelidate.textMinLen5MaxLen50.maxLength.$validator).to.be.a('function')
 
-    expect(vuelidate.textRequired.required).to.be.a('function')
+    expect(vuelidate.textRequired.required.$validator).to.be.a('function')
 
-    expect(vuelidate.textRequiredIf.requiredIf).to.be.a('function')
+    expect(vuelidate.textRequiredIf.requiredIf.$validator).to.be.a('function')
 
-    expect(vuelidate.textEmail.email).to.be.a('function')
-    expect(vuelidate.inputEmail.email).to.be.a('function')
+    expect(vuelidate.textEmail.email.$validator).to.be.a('function')
+    expect(vuelidate.inputEmail.email.$validator).to.be.a('function')
 
-    expect(vuelidate.list.required).to.be.a('function')
-    expect(vuelidate.apiLookup.params.apiLookupList.required).to.be.a('function')
+    expect(vuelidate.list.required.$validator).to.be.a('function')
+    expect(vuelidate.apiLookup.params.apiLookupList.required.$validator).to.be.a('function')
 
-    expect(vuelidate.dateOfBirth.maximumDate).to.be.a('function')
+    expect(vuelidate.dateOfBirth.maximumDate.$validator).to.be.a('function')
+    expect(vuelidate.min3DaysAgo.minimumDate.$validator).to.be.a('function')
 
-    expect(vuelidate.min3DaysAgo.minimumDate).to.be.a('function')
+    expect(vuelidate.telNum.telephoneNumber.$validator).to.be.a('function')
   })
 
   const dates = [
@@ -92,13 +99,46 @@ describe('Test the vuelidate converter', function () {
 
   describe('Test the validation function for minimum date', () => {
     for (const [label, date, minResult] of dates) {
-      it(`${label}, should${minResult ? '' : ' not'} be after 3 days ago`, () => expect(vuelidate.min3DaysAgo.minimumDate(date)).to.eql(minResult))
+      it(`${label}, should${minResult ? '' : ' not'} be after 3 days ago`, () => expect(vuelidate.min3DaysAgo.minimumDate.$validator(date)).to.eql(minResult))
     }
   })
 
   describe('Test the validation function for maximum date', () => {
     for (const [label, date, , maxResult] of dates) {
-      it(`${label}, should${maxResult ? '' : ' not'} be before today`, () => expect(vuelidate.dateOfBirth.maximumDate(date)).to.eql(maxResult))
+      it(`${label}, should${maxResult ? '' : ' not'} be before today`, () => expect(vuelidate.dateOfBirth.maximumDate.$validator(date)).to.eql(maxResult))
+    }
+  })
+
+  describe('Test the validation function for between', () => {
+    for (let i = 0; i < 30; i++) {
+      it(`Is ${i} between 5 and 10?`, () => {
+        const expected = i >= 5 && i <= 10
+
+        expect(
+          vuelidate.numberBetween5And10.between.$validator(i)
+        ).to.eql(
+          expected
+        )
+      })
+    }
+  })
+
+  describe('Test the validation function for telephone number', () => {
+    const telephoneNumbers = [
+      ['07123456789', true],
+      ['01211234567', true],
+      ['0121133', false],
+      ['fjahsf', false]
+    ]
+
+    for (const [telephoneNumber, expected] of telephoneNumbers) {
+      it(`Is ${telephoneNumber} a telephone number?`, () => {
+        expect(
+          vuelidate.telNum.telephoneNumber.$validator(telephoneNumber)
+        ).to.eql(
+          expected
+        )
+      })
     }
   })
 })