@pdtf/schemas 0.6.13 → 0.6.14

package/index.js

@@ -119,18 +119,22 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
   }
 };
 
-const validateVerifiedClaims = (verifiedClaimsArray) => {
+const validateVerifiedClaims = (verifiedClaims) => {
   const validatorVClaims = ajv.compile(verifiedClaimsSchema);
 
   const validationErrorsArr = [];
   const vClaimSchValidation = validatorVClaims({
-    verified_claims: verifiedClaimsArray,
+    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);
 
@@ -153,8 +157,6 @@ const validateVerifiedClaims = (verifiedClaimsArray) => {
   return validationErrorsArr;
 };
 
-
-
 module.exports = {
   transactionSchema,
   validator,
@@ -163,5 +165,5 @@ module.exports = {
   getSubschemaValidator,
   getTitleAtPath,
   verifiedClaimsSchema,
-  validateVerifiedClaims
+  validateVerifiedClaims,
 };

package/package.json

@@ -1,36 +1,36 @@
 {
-	"name": "@pdtf/schemas",
-	"version": "0.6.13",
-	"description": "Property Data Trust Framework Schemas and Utilities",
-	"main": "index.js",
-	"directories": {
-		"doc": "docs"
-	},
-	"scripts": {
-		"test": "jest",
-		"test:watch": "jest --watch"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/Property-Data-Trust-Framework/schemas.git"
-	},
-	"keywords": [
-		"PDTF",
-		"Schemas"
-	],
-	"author": "",
-	"license": "MIT",
-	"bugs": {
-		"url": "https://github.com/Property-Data-Trust-Framework/schemas/issues"
-	},
-	"homepage": "https://github.com/Property-Data-Trust-Framework/schemas#readme",
-	"dependencies": {
-		"@jdw/jst": "^2.0.0-beta.15",
-		"ajv": "^8.10.0",
-		"ajv-formats": "^2.1.1",
-		"jsonpointer": "^5.0.0"
-	},
-	"devDependencies": {
-		"jest": "^27.5.1"
-	}
-}
+  "name": "@pdtf/schemas",
+  "version": "0.6.14",
+  "description": "Property Data Trust Framework Schemas and Utilities",
+  "main": "index.js",
+  "directories": {
+    "doc": "docs"
+  },
+  "scripts": {
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Property-Data-Trust-Framework/schemas.git"
+  },
+  "keywords": [
+    "PDTF",
+    "Schemas"
+  ],
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Property-Data-Trust-Framework/schemas/issues"
+  },
+  "homepage": "https://github.com/Property-Data-Trust-Framework/schemas#readme",
+  "dependencies": {
+    "@jdw/jst": "^2.0.0-beta.15",
+    "ajv": "^8.10.0",
+    "ajv-formats": "^2.1.1",
+    "jsonpointer": "^5.0.0"
+  },
+  "devDependencies": {
+    "jest": "^27.5.1"
+  }
+}

package/src/tests/transactionSchema.test.js

@@ -7,7 +7,6 @@ const {
   isPathValid,
   getSubschemaValidator,
   getTitleAtPath,
-  validateVerifiedClaims
 } = require("../../index.js");
 const exampleTransaction = require("../examples/exampleTransaction.json");
 
@@ -183,274 +182,3 @@ 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 array of errors for verified claim with multiple paths", () => {
-  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/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(vClaims)).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 paths", () => {
-  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",
-          },
-        },
-	    "/propertyPack/materialFacts/address": {
-              line1: "property.line1",
-              line2: "property.line2",
-              town: "property.city",
-              county: "property.province",
-              postcode: "property.postcode",
-            },
-      },
-    },
-  ];
-  expect(validateVerifiedClaims(vClaims)).toEqual([]);
-});

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([]);
+});