Merge pull request #413 from chantouchsek/feat/access-deep-array-nest

feat: add deep array access for first()

Author: chantouchsek

package.json

@@ -52,6 +52,8 @@
     "@commitlint/config-conventional": "^17.0.0",
     "@nuxt/types": "^2.15.8",
     "@types/jest": "^27.4.0",
+    "@types/lodash.get": "^4.4.7",
+    "@types/lodash.has": "^4.5.7",
     "@types/node": "^18.0.0",
     "@types/qs": "^6.9.7",
     "@typescript-eslint/eslint-plugin": "^5.9.0",
@@ -81,6 +83,8 @@
   ],
   "dependencies": {
     "axios": "^0.27.2",
+    "lodash.get": "^4.4.2",
+    "lodash.has": "^4.5.2",
     "qs": "^6.10.2"
   },
   "lint-staged": {

src/__tests__/validator.test.ts

@@ -58,7 +58,7 @@ describe('Validator', () => {
   test('Get all errors by keys', () => {
     validator.add('email', 'The email field is required.')
     validator.add('form.email', 'The form.name field is required.')
-    expect(validator.first(['name', 'form.email']).length).toBeGreaterThan(0)
+    expect(validator.first(['name', 'form.email'])).toBeDefined()
   })
   test('Get all errors message', () => {
     validator.add('email', 'The email field is required.')
@@ -213,4 +213,20 @@ describe('Validator', () => {
       'This fist name field is required',
     )
   })
+
+  it('get first array by nested array', () => {
+    const errors = { name: [{ kh: ['This fist name field is required'] }] }
+    validator.fill(errors)
+
+    expect(validator.first(['name[0]'])).toEqual(errors.name[0])
+  })
+
+  it('get first by nested array', () => {
+    const errors = { name: [{ kh: ['This fist name field is required'] }] }
+    validator.fill(errors)
+
+    expect(validator.first(['name[0].kh'])).toEqual(
+      'This fist name field is required',
+    )
+  })
 })

src/core/Validator.ts

@@ -1,4 +1,6 @@
 import { hasOwnProperty, is, isArray } from '../util'
+import get from 'lodash.get'
+import has from 'lodash.has'
 
 class Validator {
   public errors: Record<string, any>
@@ -20,11 +22,11 @@ class Validator {
     }
   }
 
-  has(field: any | any[]) {
+  has(field: string | string[]) {
     if (isArray(field)) {
       return is(Object.keys(this.errors), field)
     }
-    let hasError = hasOwnProperty(this.errors, field)
+    let hasError = has(this.errors, field)
     if (!hasError) {
       const errors = Object.keys(this.errors).filter(
         (e: string) => e.startsWith(`${field}.`) || e.startsWith(`${field}[`),
@@ -34,16 +36,18 @@ class Validator {
     return hasError
   }
 
-  first(field: any | any[]): string {
-    if (field instanceof Array) {
+  first(field: string | string[]): string | object {
+    if (Array.isArray(field)) {
       for (let i = 0; i < field.length; i++) {
-        if (!hasOwnProperty(this.errors, field[i])) {
+        if (!has(this.errors, field[i])) {
           continue
         }
         return this.first(field[i])
       }
     }
-    return this.get(field)[0]
+    const value = this.get(field as string)
+    if (Array.isArray(value)) return value[0]
+    return value // return it if object like
   }
 
   firstBy(obj: Record<string, any>, field?: string): string {
@@ -53,17 +57,15 @@ class Validator {
     } else {
       value = obj[field]
     }
-    if (isArray(value)) {
-      value = value[0]
-    }
+    if (isArray(value)) value = value[0]
     return value
   }
 
-  missed(field?: string | string[]): boolean {
+  missed(field: string | string[]): boolean {
     return !this.has(field)
   }
 
-  nullState(field?: string | string[]): boolean | null {
+  nullState(field: string | string[]): boolean | null {
     return this.has(field) ? this.missed(field) : null
   }
 
@@ -85,7 +87,7 @@ class Validator {
   }
 
   get(field: string): string | string[] {
-    return this.errors[field] || []
+    return get(this.errors, field) || []
   }
 
   all() {

tsconfig.json

@@ -23,7 +23,9 @@
       "@types/jest",
       "axios",
       "axios-mock-adapter",
-      "@types/qs"
+      "@types/qs",
+      "@types/lodash.get",
+      "@types/lodash.has"
     ]
   },
   "include": ["src"],

yarn.lock

@@ -2405,6 +2405,25 @@
   resolved "https://registry.yarnpkg.com/@types/less/-/less-3.0.2.tgz#2761d477678c8374cb9897666871662eb1d1115e"
   integrity sha512-62vfe65cMSzYaWmpmhqCMMNl0khen89w57mByPi1OseGfcV/LV03fO8YVrNj7rFQsRWNJo650WWyh6m7p8vZmA==
 
+"@types/lodash.get@^4.4.7":
+  version "4.4.7"
+  resolved "https://registry.yarnpkg.com/@types/lodash.get/-/lodash.get-4.4.7.tgz#1ea63d8b94709f6bc9e231f252b31440abe312cf"
+  integrity sha512-af34Mj+KdDeuzsJBxc/XeTtOx0SZHZNLd+hdrn+PcKGQs0EG2TJTzQAOTCZTgDJCArahlCzLWSy8c2w59JRz7Q==
+  dependencies:
+    "@types/lodash" "*"
+
+"@types/lodash.has@^4.5.7":
+  version "4.5.7"
+  resolved "https://registry.yarnpkg.com/@types/lodash.has/-/lodash.has-4.5.7.tgz#9e1c3da3ee67f68fadc3d168ffdf8e11a3f3ccd3"
+  integrity sha512-nfbAzRbsZBdzSAkL9iiLy4SQk89uuFcXBFwZ7pf6oZhBgPvNys8BY5Twp/w8XvZKGt1o6cAa85wX4QhqO3uQ7A==
+  dependencies:
+    "@types/lodash" "*"
+
+"@types/lodash@*":
+  version "4.14.182"
+  resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.182.tgz#05301a4d5e62963227eaafe0ce04dd77c54ea5c2"
+  integrity sha512-/THyiqyQAP9AfARo4pF+aCGcyiQ94tX/Is2I7HofNRqoYLgN1PBoOWu2/zTA5zMxzP5EFutMtWtGAFRKUe961Q==
+
 "@types/mime@^1":
   version "1.3.2"
   resolved "https://registry.yarnpkg.com/@types/mime/-/mime-1.3.2.tgz#93e25bf9ee75fe0fd80b594bc4feb0e862111b5a"
@@ -7975,6 +7994,16 @@ lodash.debounce@^4.0.8:
   resolved "https://registry.yarnpkg.com/lodash.debounce/-/lodash.debounce-4.0.8.tgz#82d79bff30a67c4005ffd5e2515300ad9ca4d7af"
   integrity sha1-gteb/zCmfEAF/9XiUVMArZyk168=
 
+lodash.get@^4.4.2:
+  version "4.4.2"
+  resolved "https://registry.yarnpkg.com/lodash.get/-/lodash.get-4.4.2.tgz#2d177f652fa31e939b4438d5341499dfa3825e99"
+  integrity sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==
+
+lodash.has@^4.5.2:
+  version "4.5.2"
+  resolved "https://registry.yarnpkg.com/lodash.has/-/lodash.has-4.5.2.tgz#d19f4dc1095058cccbe2b0cdf4ee0fe4aa37c862"
+  integrity sha512-rnYUdIo6xRCJnQmbVFEwcxF144erlD+M3YcJUVesflU9paQaE8p+fJDcIQrlMYbxoANFL+AB9hZrzSBBk5PL+g==
+
 lodash.ismatch@^4.4.0:
   version "4.4.0"
   resolved "https://registry.yarnpkg.com/lodash.ismatch/-/lodash.ismatch-4.4.0.tgz#756cb5150ca3ba6f11085a78849645f188f85f37"