@kravc/schema 2.5.1 → 2.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kravc/schema",
-  "version": "2.5.1",
+  "version": "2.7.0",
   "description": "Advanced JSON schema manipulation and validation library.",
   "keywords": [
     "JSON",
@@ -29,6 +29,7 @@
     "credentials-context": "^2.0.0",
     "lodash.clonedeep": "^4.5.0",
     "lodash.groupby": "^4.6.0",
+    "lodash.isobject": "^3.0.2",
     "lodash.isundefined": "^3.0.1",
     "lodash.keyby": "^4.6.0",
     "lodash.pick": "^4.4.0",

package/src/Validator.js

@@ -3,6 +3,7 @@
 const keyBy               = require('lodash.keyby')
 const groupBy             = require('lodash.groupby')
 const ZSchema             = require('z-schema')
+const cleanupNulls        = require('./helpers/cleanupNulls')
 const getReferenceIds     = require('./helpers/getReferenceIds')
 const ValidationError     = require('./ValidationError')
 const cleanupAttributes   = require('./helpers/cleanupAttributes')
@@ -27,7 +28,7 @@ class Validator {
     }
 
     this._engine = new ZSchema({
-      reportPathAsArray: true,
+      reportPathAsArray: false,
       ignoreUnknownFormats: true,
     })
 
@@ -43,7 +44,7 @@ class Validator {
     this._jsonSchemasMap = keyBy(jsonSchemas, 'id')
   }
 
-  validate(object, schemaId, shouldNullifyEmptyValues = false) {
+  validate(object, schemaId, shouldNullifyEmptyValues = false, shouldCleanupNulls = false) {
     const jsonSchema = this._jsonSchemasMap[schemaId]
 
     if (!jsonSchema) {
@@ -51,7 +52,11 @@ class Validator {
     }
 
     const objectJson = JSON.stringify(object)
-    const result = JSON.parse(objectJson)
+    let result = JSON.parse(objectJson)
+
+    if (shouldCleanupNulls) {
+      result = cleanupNulls(result)
+    }
 
     try {
       // NOTE: Drop attributes from objects that are not defined in schema.

package/src/Validator.spec.js

@@ -40,7 +40,7 @@ describe('Validator', () => {
     })
   })
 
-  describe('.validate(object, schemaId, shouldNullifyEmptyValues = false)', () => {
+  describe('.validate(object, schemaId, shouldNullifyEmptyValues = false, shouldCleanupNulls = true)', () => {
     it('returns validated, cleaned and normalized object', () => {
       const validator = new Validator(SCHEMAS)
 
@@ -48,15 +48,20 @@ describe('Validator', () => {
 
       const input = {
         name: 'Oleksandr',
+        toBeRemoved: null,
         contactDetails: {
-          email: 'a@kra.vc'
+          email: 'a@kra.vc',
+          toBeRemoved: null,
         },
-        favoriteItems: [{
-          id:         '1',
-          name:       'Student Book',
-          categories: [ 'Education' ],
-          _createdAt
-        }],
+        favoriteItems: [
+          {
+            id:         '1',
+            name:       'Student Book',
+            categories: [ 'Education' ],
+            toBeRemoved: null,
+            _createdAt
+          },
+        ],
         locations: [{
           name: 'Home',
           address: {
@@ -77,7 +82,11 @@ describe('Validator', () => {
         _createdAt
       }
 
-      const validInput = validator.validate(input, 'Profile')
+      const validInput = validator.validate(input, 'Profile', false, true)
+
+      expect(validInput.toBeRemoved).to.not.exist
+      expect(validInput.contactDetails.toBeRemoved).to.not.exist
+      expect(validInput.favoriteItems[0].toBeRemoved).to.not.exist
 
       expect(validInput._createdAt).to.not.exist
       expect(validInput.preferences._createdAt).to.not.exist
@@ -291,6 +300,7 @@ describe('Validator', () => {
         const error = validationError.toJSON()
 
         expect(error.message).to.eql('"Profile" validation failed')
+
         expect(error.validationErrors).to.have.lengthOf(4)
 
         expect(error.validationErrors[0].code).to.eql('INVALID_TYPE')

package/src/helpers/cleanupNulls.js

@@ -0,0 +1,43 @@
+'use strict'
+
+const isObject    = require('lodash.isobject')
+const cloneDeep   = require('lodash.clonedeep')
+const { isArray } = Array
+
+const cleanupNulls = object => {
+  if (!isObject(object)) {
+    return
+  }
+
+  for (const key in object) {
+    const value = object[key]
+
+    if (isArray(value)) {
+      for (const item of value) {
+        cleanupNulls(item)
+      }
+
+      continue
+    }
+
+    if (isObject(value)) {
+      cleanupNulls(value)
+
+      continue
+    }
+
+    const isNull = value === null
+
+    if (isNull) {
+      delete object[key]
+    }
+  }
+}
+
+module.exports = input => {
+  const object = cloneDeep(input)
+
+  cleanupNulls(object)
+
+  return object
+}

package/src/helpers/nullifyEmptyValues.js

@@ -21,7 +21,7 @@ const nullifyEmptyValues = (object, validationErrors) => {
   const otherValidationErrors = []
 
   for (const error of validationErrors) {
-    const { code, path } = error
+    const { code } = error
 
     const isAttributeRequired = error[schemaSymbol]['x-required'] === true
     const isFormatError = FORMAT_ERROR_CODES.includes(code)
@@ -36,6 +36,9 @@ const nullifyEmptyValues = (object, validationErrors) => {
       continue
     }
 
+    const { path: pathString } = error
+    const path = pathString.replace('#/', '').split('/')
+
     const json = error[jsonSymbol]
     const value = get(json, path)