@kravc/schema 2.3.2 → 2.3.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kravc/schema",
-  "version": "2.3.2",
+  "version": "2.3.4",
   "description": "Advanced JSON schema manipulation and validation library.",
   "keywords": [
     "JSON",
@@ -26,7 +26,7 @@
   "author": "Alexander Kravets <a@kra.vc>",
   "license": "ISC",
   "dependencies": {
-    "credentials-context": "^1.0.0",
+    "credentials-context": "^2.0.0",
     "lodash.clonedeep": "^4.5.0",
     "lodash.groupby": "^4.6.0",
     "lodash.isundefined": "^3.0.1",
@@ -34,16 +34,16 @@
     "lodash.pick": "^4.4.0",
     "lodash.uniq": "^4.5.0",
     "security-context": "^4.0.0",
-    "validator": "^13.7.0",
-    "z-schema": "^5.0.2"
+    "validator": "^13.9.0",
+    "z-schema": "^5.0.5"
   },
   "devDependencies": {
-    "chai": "^4.3.4",
-    "eslint": "^8.6.0",
+    "chai": "^4.3.7",
+    "eslint": "^8.35.0",
     "js-yaml": "^4.1.0",
     "jsonld": "^5.2.0",
-    "mocha": "^9.1.3",
-    "nyc": "^15.0.1"
+    "mocha": "^10.2.0",
+    "nyc": "^15.1.0"
   },
   "nyc": {
     "include": "src",

package/src/Validator.js

@@ -46,9 +46,29 @@ class Validator {
       throw new Error(`Schema "${schemaId}" not found`)
     }
 
-    const result = JSON.parse(JSON.stringify(object))
-    cleanupAttributes(result, jsonSchema, this._jsonSchemasMap)
-    normalizeAttributes(result, jsonSchema, this._jsonSchemasMap)
+    const objectJson = JSON.stringify(object)
+    const result = JSON.parse(objectJson)
+
+    try {
+      // NOTE: Drop attributes from objects that are not defined in schema.
+      //       This is bad for FE developers, as they continue to send some
+      //       trash to endpoints, but good for integrations with third party
+      //       services, e.g. Telegram, when you do not want to define schema
+      //       for the full payload. This method currently fails for cases when
+      //       attribute is defined as object or array in schema, but value is
+      //       a string. In this case validation method below would catch that.
+      cleanupAttributes(result, jsonSchema, this._jsonSchemasMap)
+
+      // NOTE: Normalize method helps to integrate objects built from URLs,
+      //       where types are not defined, e.g. booleans are '1', 'yes' string
+      //       or numbers are '1', '2'... strings.
+      normalizeAttributes(result, jsonSchema, this._jsonSchemasMap)
+
+    } catch (error) {
+      // NOTE: Skip errors in cleanup and normalize attributes methods,
+      //       validation fails for objects with invalid value types.
+
+    }
 
     const isValid = this._engine.validate(result, jsonSchema)
 

package/src/Validator.spec.js

@@ -150,6 +150,37 @@ describe('Validator', () => {
       }).to.throw('"Profile" validation failed')
     })
 
+    it('throws validation error if cleanup or normalize method failed', () => {
+      const validator = new Validator(SCHEMAS)
+
+      const input = {
+        name: 'Oleksandr',
+        contactDetails: {
+          email: 'a@kra.vc'
+        },
+        favoriteItems: 'NOT_ARRAY_BUT_STRING'
+      }
+
+      try {
+        validator.validate(input, 'Profile')
+
+      } catch (validationError) {
+        const error = validationError.toJSON()
+
+        expect(error.object).to.exist
+        expect(error.code).to.eql('ValidationError')
+        expect(error.message).to.eql('"Profile" validation failed')
+        expect(error.schemaId).to.eql('Profile')
+
+        const errorMessage = error.validationErrors[0].message
+        expect(errorMessage).to.eql('Expected type array but found type string')
+
+        return
+      }
+
+      throw new Error('Validation error is not thrown')
+    })
+
     it('throws error if validation failed', () => {
       const validator = new Validator(SCHEMAS)