added _match schema_ validation (#8)

Author: AlexGalichenko

CHANGELOG.md

@@ -1,2 +1,5 @@
+## 0.0.5
+- :rocket: added _match schema_ validation
+
 ## 0.0.4
 - :rocket: added _have property_ validation

README.md

@@ -16,6 +16,7 @@ Lib supports following validations
 * have members - validation if array/object have exact members
 * include members - validation if array/object includes members
 * have property - have property validation
+* match schema - match [ajv](https://www.npmjs.com/package/ajv) schema
 
 All validations can be negated adding _not_ word.
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/validation",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Lib that transform plain english definition to validation functions",
   "main": "index.js",
   "scripts": {
@@ -28,10 +28,11 @@
   "devDependencies": {
     "@types/chai": "^4.3.4",
     "jest": "^29.5.0",
-    "typescript": "^5.0.2",
-    "ts-jest": "^29.0.5"
+    "ts-jest": "^29.0.5",
+    "typescript": "^5.0.2"
   },
   "dependencies": {
+    "ajv": "^8.12.0",
     "chai": "^4.3.7"
   }
 }

package.json

@@ -1,4 +1,5 @@
 import { expect, Assertion } from 'chai';
+import Ajv from 'ajv'
 
 Assertion.addMethod('notStrictEqual', function (ER) {
   const obj = this._obj;
@@ -12,6 +13,25 @@ Assertion.addMethod('notStrictEqual', function (ER) {
  );
 });
 
+Assertion.addMethod('matchSchema', function (schema) {
+  const obj = this._obj;
+  const ajv = new Ajv();
+  const validate = ajv.compile(schema);
+  const isValid = validate(obj);
+  const messages = validate.errors ? validate.errors?.map(err => err.message) : [];
+  const errors = [
+    'expected #{this} to match schema #{exp}',
+    ...messages
+  ].join('\n');
+  this.assert(
+      isValid,
+      errors,
+      'expected #{this} to not match schema #{exp}',
+      schema,
+      obj
+  );
+});
+
 export const validations = {
   EQUAL: 'equal',
   DEEPLY_EQUAL: 'deeply equal',
@@ -25,7 +45,8 @@ export const validations = {
   LESS: 'less than',
   HAVE_TYPE: 'have type',
   INCLUDE_MEMBERS: 'include member',
-  HAVE_PROPERTY: 'have property'
+  HAVE_PROPERTY: 'have property',
+  MATCH_SCHEMA: 'match schema'
 };
 
 const isClause = '(?:is |do |does |to )?';
@@ -59,6 +80,7 @@ const validationFns = {
   [validations.HAVE_TYPE]: (expectClause: any, ER: string) => expectClause.a(ER),
   [validations.INCLUDE_MEMBERS]: (expectClause: any, ER: string) => expectClause.include.members(ER),
   [validations.HAVE_PROPERTY]: (expectClause: any, ER: string) => expectClause.have.property(ER),
+  [validations.MATCH_SCHEMA]: (expectClause: any, ER: string) => expectClause.matchSchema(ER),
 };
 
 /**

src/verify.ts

@@ -323,6 +323,48 @@ const tests: Array<TestParams> = [
     negativeArgs: [{ prop: 42 }, 'prop'],
     expectedError: 'expected { prop: 42 } to not have property \'prop\'',
   },
+  {
+    testName: 'to match schema',
+    validation: 'to match schema',
+    positiveArgs: [{ prop: 42 }, {
+      type: 'object',
+      properties: {
+        prop: {type: 'integer'},
+      },
+      required: ['prop'],
+      additionalProperties: false,
+    }],
+    negativeArgs: [{ prop2: 42 }, {
+      type: 'object',
+      properties: {
+        prop: {type: 'integer'},
+      },
+      required: ['prop'],
+      additionalProperties: false,
+    }],
+    expectedError: 'expected { prop2: 42 } to match schema { type: \'object\', …(3) }\nmust have required property \'prop\'',
+  },
+  {
+    testName: 'not to match schema',
+    validation: 'not to match schema',
+    positiveArgs: [{ prop: 42 }, {
+      type: 'object',
+      properties: {
+        prop: {type: 'string'},
+      },
+      required: ['prop'],
+      additionalProperties: false,
+    }],
+    negativeArgs: [{ prop: 42 }, {
+      type: 'object',
+      properties: {
+        prop: {type: 'integer'},
+      },
+      required: ['prop'],
+      additionalProperties: false,
+    }],
+    expectedError: 'expected { prop: 42 } to not match schema { type: \'object\', …(3) }',
+  },
 ];
 
 test.each(tests)('$testName', ({ validation, positiveArgs, negativeArgs, expectedError }: TestParams) => {