@pdtf/schemas 0.6.11 → 0.6.12

package/index.js

@@ -119,6 +119,38 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
   }
 };
 
+const validateVerifiedClaims = (verifiedClaimsArray) => {
+
+const validatorVClaims = ajv.compile(verifiedClaimsSchema);
+
+  const validationErrorsArr = [];
+  const vClaimSchValidation = validatorVClaims({
+    verified_claims: verifiedClaimsArray,
+  });
+
+  if (!vClaimSchValidation) {
+    validationErrorsArr.push(validatorVClaims.errors);
+  }
+
+  verifiedClaimsArray.forEach((claim) => {
+    const [path] = Object.keys(claim.claims);
+
+    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 +159,5 @@ module.exports = {
   getSubschemaValidator,
   getTitleAtPath,
   verifiedClaimsSchema,
+  validateVerifiedClaims
 };

package/package.json

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

package/src/tests/transactionSchema.test.js

@@ -7,6 +7,7 @@ const {
   isPathValid,
   getSubschemaValidator,
   getTitleAtPath,
+  validateVerifiedClaims
 } = require("../../index.js");
 const exampleTransaction = require("../examples/exampleTransaction.json");
 
@@ -182,3 +183,209 @@ test("correctly gets titles across schemas, arrays and non-existient title prope
     )
   ).toBe("Current energy rating");
 });
+
+test("returns an array with an error stating if path is incorrect", () => {
+  const vClaims = [
+    {
+      verification: {
+        trust_framework: "uk_pdtf",
+        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: {
+                  alg: "md5",
+                  value: "randomHashValue",
+                },
+                url: "https://fakeFileStore.com/some/kind/of/file",
+                desc: "proofOfAddress.pdf",
+              },
+            ],
+          },
+        ],
+      },
+      claims: {
+        "/propertyPack/INVALID/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",
+          },
+        },
+      },
+    },
+  ];
+  expect(validateVerifiedClaims(vClaims)).toEqual([
+    "Path /propertyPack/INVALID/materialFacts/councilTax is not a valid PDTF schema path",
+  ]);
+});
+
+test("returns an empty array if path is correct", () => {
+  const vClaims = [
+    {
+      verification: {
+        trust_framework: "uk_pdtf",
+        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: {
+                  alg: "md5",
+                  value: "randomHashValue",
+                },
+                url: "https://fakeFileStore.com/some/kind/of/file",
+                desc: "proofOfAddress.pdf",
+              },
+            ],
+          },
+        ],
+      },
+      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",
+          },
+        },
+      },
+    },
+  ];
+  expect(validateVerifiedClaims(vClaims)).toEqual([]);
+});
+
+test("returns an array of errors if data in the path is in invalid format", () => {
+  const vClaims = [
+    {
+      verification: {
+        trust_framework: "uk_pdtf",
+        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: {
+                  alg: "md5",
+                  value: "randomHashValue",
+                },
+                url: "https://fakeFileStore.com/some/kind/of/file",
+                desc: "proofOfAddress.pdf",
+              },
+            ],
+          },
+        ],
+      },
+      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(vClaims)).toEqual([
+    {
+      instancePath: "",
+      schemaPath: "#/required",
+      keyword: "required",
+      params: { missingProperty: "councilTaxAffectingAlterations" },
+      message: "must have required property 'councilTaxAffectingAlterations'",
+    },
+  ]);
+});
+
+test("returns an empty array of errors if data in the path is in valid format", () => {
+  const vClaims = [
+    {
+      verification: {
+        trust_framework: "uk_pdtf",
+        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: {
+                  alg: "md5",
+                  value: "randomHashValue",
+                },
+                url: "https://fakeFileStore.com/some/kind/of/file",
+                desc: "proofOfAddress.pdf",
+              },
+            ],
+          },
+        ],
+      },
+      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",
+          },
+        },
+      },
+    },
+  ];
+  expect(validateVerifiedClaims(vClaims)).toEqual([]);
+});