@pdtf/schemas 0.6.11 → 0.6.14

package/index.js

@@ -119,6 +119,44 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
   }
 };
 
+const validateVerifiedClaims = (verifiedClaims) => {
+  const validatorVClaims = ajv.compile(verifiedClaimsSchema);
+
+  const validationErrorsArr = [];
+  const vClaimSchValidation = validatorVClaims({
+    verified_claims: verifiedClaims,
+  });
+
+  if (!vClaimSchValidation) {
+    validationErrorsArr.push(validatorVClaims.errors);
+  }
+
+  const verifiedClaimsArray = Array.isArray(verifiedClaims)
+    ? verifiedClaims
+    : [verifiedClaims];
+
+  verifiedClaimsArray.forEach((claim) => {
+    const paths = Object.keys(claim.claims);
+
+    for (const path of paths) {
+      const validPath = isPathValid(path);
+      if (validPath) {
+        const subValidator = getSubschemaValidator(path);
+        const isValid = subValidator(claim.claims[path]);
+        if (!isValid) {
+          validationErrorsArr.push(...subValidator.errors);
+        }
+      } else {
+        validationErrorsArr.push(
+          `Path ${path} is not a valid PDTF schema path`
+        );
+      }
+    }
+  });
+
+  return validationErrorsArr;
+};
+
 module.exports = {
   transactionSchema,
   validator,
@@ -127,4 +165,5 @@ module.exports = {
   getSubschemaValidator,
   getTitleAtPath,
   verifiedClaimsSchema,
+  validateVerifiedClaims,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdtf/schemas",
-  "version": "0.6.11",
+  "version": "0.6.14",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "directories": {

package/src/examples/exampleDocumentedVouch.json

@@ -4,19 +4,7 @@
     "time": "2022-01-25T13:16:44.527Z",
     "evidence": [
       {
-        "verification_method": {
-          "type": "auth"
-        },
         "type": "vouch",
-        "attestation": {
-          "voucher": {
-            "name": "Maria Harris"
-          },
-          "type": "digital_attestation"
-        }
-      },
-      {
-        "type": "document",
         "attachments": [
           {
             "digest": {
@@ -26,7 +14,16 @@
             "url": "https://fakeFileStore.com/some/kind/of/file",
             "desc": "proofOfAddress.pdf"
           }
-        ]
+        ],
+        "verification_method": {
+          "type": "auth"
+        },
+        "attestation": {
+          "voucher": {
+            "name": "Maria Harris"
+          },
+          "type": "digital_attestation"
+        }
       }
     ]
   },

package/src/tests/verifiedClaimsValidator.test.js

@@ -0,0 +1,96 @@
+const { validateVerifiedClaims } = require("../../index.js");
+
+const exampleVouch = require("../examples/exampleVouch.json");
+const exampleDocumentedVouch = require("../examples/exampleDocumentedVouch.json");
+
+test("returns an empty array for a valid claim", () => {
+  expect(validateVerifiedClaims(exampleVouch)).toEqual([]);
+});
+
+test("returns an empty array for a valid array of claims", () => {
+  const claimsArray = [exampleVouch, exampleDocumentedVouch];
+  expect(validateVerifiedClaims(claimsArray)).toEqual([]);
+});
+
+test("returns an array with an error stating if path is incorrect", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  const originalPath = Object.keys(clonedVouch.claims)[0];
+  const data = clonedVouch.claims[originalPath];
+  clonedVouch.claims = {
+    "/propertyPack/INVALID/materialFacts/councilTax": data,
+  };
+  expect(validateVerifiedClaims(clonedVouch)).toEqual([
+    "Path /propertyPack/INVALID/materialFacts/councilTax is not a valid PDTF schema path",
+  ]);
+});
+
+test("returns an array of errors if data in the path is in invalid format", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.claims = {
+    "/propertyPack/materialFacts/councilTax": {
+      councilTaxBand: "D",
+      councilTaxAffectingAlterationsINVALID: {
+        yesNo: "Yes",
+        details:
+          "Extension added in 2005 to add bedroom with ensuite shower room. Certificate of Compliance issued 17th Feb 2006 and council tax updated",
+      },
+    },
+  };
+  expect(validateVerifiedClaims(clonedVouch)).toEqual([
+    {
+      instancePath: "",
+      schemaPath: "#/required",
+      keyword: "required",
+      params: { missingProperty: "councilTaxAffectingAlterations" },
+      message: "must have required property 'councilTaxAffectingAlterations'",
+    },
+  ]);
+});
+
+test("returns an array of errors for verified claim with multiple paths", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.claims = {
+    "/propertyPack/materialFacts/cousncilTaxBad": {
+      councilTaxBand: "D",
+      councilTaxAffectingAlterations: {
+        yesNo: "Yes",
+        details:
+          "Extension added in 2005 to add bedroom with ensuite shower room. Certificate of Compliance issued 17th Feb 2006 and council tax updated",
+      },
+    },
+    "/propertyPack/materialFacts/councilTaxBadTwo": {
+      councilTaxBand: "D",
+      councilTaxAffectingAlterations: {
+        yesNo: "Yes",
+        details:
+          "Extension added in 2005 to add bedroom with ensuite shower room. Certificate of Compliance issued 17th Feb 2006 and council tax updated",
+      },
+    },
+  };
+  expect(validateVerifiedClaims(clonedVouch)).toEqual([
+    "Path /propertyPack/materialFacts/cousncilTaxBad is not a valid PDTF schema path",
+    "Path /propertyPack/materialFacts/councilTaxBadTwo is not a valid PDTF schema path",
+  ]);
+});
+
+test("returns an empty array of errors for verified claim with multiple valid paths", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.claims = {
+    "/propertyPack/materialFacts/councilTax": {
+      councilTaxBand: "D",
+      councilTaxAffectingAlterations: {
+        yesNo: "Yes",
+        details:
+          "Extension added in 2005 to add bedroom with ensuite shower room. Certificate of Compliance issued 17th Feb 2006 and council tax updated",
+      },
+    },
+    "/propertyPack/materialFacts/address": {
+      line1: "property.line1",
+      line2: "property.line2",
+      town: "property.city",
+      county: "property.province",
+      postcode: "property.postcode",
+    },
+  };
+  expect(validateVerifiedClaims(clonedVouch)).toEqual([]);
+});